rx-player 4.0.0-beta.1 → 4.0.0-beta.2

package/src/manifest/__tests__/period.test.ts

@@ -149,25 +149,30 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "56",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const videoAda3 = { type: "video",
                         id: "57",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda3; } };
     const video = [videoAda1, videoAda2, videoAda3];
 
     const audioAda1 = { type: "audio",
                         id: "58",
                         isSupported: true,
-                        representations: [] };
+                        representations: [],
+                        toAudioTrack() { return audioAda1; } };
     const audioAda2 = { type: "audio",
                         id: "59",
                         isSupported: true,
-                        representations: [] };
+                        representations: [],
+                        toAudioTrack() { return audioAda2; } };
     const audio = [audioAda1, audioAda2];
     const args = { id: "12", adaptations: { video, audio }, start: 0 };
     let period = null;
@@ -205,25 +210,30 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const videoAda3 = { type: "video",
                         id: "56",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda3; } };
     const video = [videoAda1, videoAda2, videoAda3];
 
     const audioAda1 = { type: "audio",
                         id: "57",
                         isSupported: false,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda1; } };
     const audioAda2 = { type: "audio",
                         id: "58",
                         isSupported: false,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda1; } };
     const audio = [audioAda1, audioAda2];
     const args = { id: "12", adaptations: { video, audio }, start: 0 };
     let period = null;
@@ -261,25 +271,30 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [] };
+                        representations: [],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [] };
+                        representations: [],
+                        toVideoTrack() { return videoAda2; } };
     const videoAda3 = { type: "video",
                         id: "56",
                         isSupported: true,
-                        representations: [] };
+                        representations: [],
+                        toVideoTrack() { return videoAda3; } };
     const video = [videoAda1, videoAda2, videoAda3];
 
     const audioAda1 = { type: "audio",
                         id: "58",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda1; } };
     const audioAda2 = { type: "audio",
                         id: "59",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda2; } };
     const audio = [audioAda1, audioAda2];
     const args = { id: "12", adaptations: { video, audio }, start: 0 };
     let period = null;
@@ -317,25 +332,30 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: false,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: false,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const videoAda3 = { type: "video",
                         id: "56",
                         isSupported: false,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda3; } };
     const video = [videoAda1, videoAda2, videoAda3];
 
     const audioAda1 = { type: "audio",
                         id: "58",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda1; } };
     const audioAda2 = { type: "audio",
                         id: "59",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda2; } };
     const audio = [audioAda1, audioAda2];
     const args = { id: "12", adaptations: { video, audio }, start: 0 };
     let period = null;
@@ -376,12 +396,14 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const video = [videoAda1];
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: false,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const video2 = [videoAda2];
     const args = { id: "12", adaptations: { video, video2 }, start: 0 };
     const period = new Period(args);
@@ -412,7 +434,8 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const video = [videoAda1];
     const bar = undefined;
     const args = { id: "12", adaptations: { bar, video }, start: 0 };
@@ -439,11 +462,13 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const video = [videoAda1, videoAda2];
     const args = { id: "12", adaptations: { video }, start: 0 };
     const period = new Period(args, representationFilter);
@@ -471,11 +496,13 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: false,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const fooAda1 = { type: "foo",
                       id: "12",
                       isSupported: false,
@@ -507,11 +534,13 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: false,
-                        representations: [] };
+                        representations: [],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const fooAda1 = { type: "foo",
                       id: "12",
                       isSupported: false,
@@ -536,11 +565,13 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const video = [videoAda1, videoAda2];
     const args = { id: "12", adaptations: { video }, start: 72 };
     const period = new Period(args);
@@ -561,11 +592,13 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const video = [videoAda1, videoAda2];
     const args = { id: "12", adaptations: { video }, start: 0, duration: 12 };
     const period = new Period(args);
@@ -586,11 +619,13 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const video = [videoAda1, videoAda2];
     const args = { id: "12", adaptations: { video }, start: 50, duration: 12 };
     const period = new Period(args);
@@ -611,17 +646,20 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const video = [videoAda1, videoAda2];
 
     const audioAda1 = { type: "audio",
                         id: "56",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda1; } };
     const audio = [audioAda1];
 
     const args = { id: "12", adaptations: { video, audio }, start: 50, duration: 12 };
@@ -647,17 +685,20 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const video = [videoAda1, videoAda2];
 
     const audioAda1 = { type: "audio",
                         id: "56",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda1; } };
     const audio = [audioAda1];
 
     const args = { id: "12", adaptations: { video, audio }, start: 50, duration: 12 };
@@ -689,21 +730,25 @@ describe("Manifest - Period", () => {
     const videoAda1 = { type: "video",
                         id: "54",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda1; } };
     const videoAda2 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda2; } };
     const videoAda3 = { type: "video",
                         id: "55",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toVideoTrack() { return videoAda3; } };
     const video = [videoAda1, videoAda2, videoAda3];
 
     const audioAda1 = { type: "audio",
                         id: "56",
                         isSupported: true,
-                        representations: [{}] };
+                        representations: [{}],
+                        toAudioTrack() { return audioAda1; } };
     const audio = [audioAda1];
 
     const args = { id: "12", adaptations: { video, audio }, start: 50, duration: 12 };

package/src/manifest/adaptation.ts

@@ -17,8 +17,11 @@
 import log from "../log";
 import { IParsedAdaptation } from "../parsers/manifest";
 import {
+  IAudioTrack,
   ITrackType,
   IRepresentationFilter,
+  ITextTrack,
+  IVideoTrack,
   IRepresentationFilterRepresentation,
 } from "../public_types";
 import arrayFind from "../utils/array_find";
@@ -31,7 +34,7 @@ export const SUPPORTED_ADAPTATIONS_TYPE: ITrackType[] = ["audio", "video", "text
 
 /**
  * Normalized Adaptation structure.
- * An Adaptation describes a single `Track`. For example a specific audio
+ * An `Adaptation` describes a single `Track`. For example a specific audio
  * track (in a given language) or a specific video track.
  * It istelf can be represented in different qualities, which we call here
  * `Representation`.
@@ -216,4 +219,89 @@ export default class Adaptation {
   getRepresentation(wantedId : number|string) : Representation|undefined {
     return arrayFind(this.representations, ({ id }) => wantedId === id);
   }
+
+  /**
+   * Format an `Adaptation`, generally of type `"audio"`, as an `IAudioTrack`.
+   * @param {boolean} filterPlayable - If `true` only "playable" Representation
+   * will be returned.
+   * @returns {Object}
+   */
+  public toAudioTrack(filterPlayable: boolean) : IAudioTrack {
+    const formatted : IAudioTrack = {
+      language: this.language ?? "",
+      normalized: this.normalizedLanguage ?? "",
+      audioDescription: this.isAudioDescription === true,
+      id: this.id,
+      representations: (
+        filterPlayable ?
+          this.getPlayableRepresentations() :
+          this.representations
+      ).map(r => r.toAudioRepresentation()),
+      label: this.label,
+    };
+    if (this.isDub === true) {
+      formatted.dub = true;
+    }
+    return formatted;
+  }
+
+  /**
+   * Format an `Adaptation`, generally of type `"audio"`, as an `IAudioTrack`.
+   * @returns {Object}
+   */
+  public toTextTrack() : ITextTrack {
+    return {
+      language: this.language ?? "",
+      normalized: this.normalizedLanguage ?? "",
+      closedCaption: this.isClosedCaption === true,
+      id: this.id,
+      label: this.label,
+      forced: this.isForcedSubtitles,
+    };
+  }
+
+  /**
+   * Format an `Adaptation`, generally of type `"video"`, as an `IAudioTrack`.
+   * @param {boolean} filterPlayable - If `true` only "playable" Representation
+   * will be returned.
+   * @returns {Object}
+   */
+  public toVideoTrack(filterPlayable: boolean) : IVideoTrack {
+    const trickModeTracks = this.trickModeTracks !== undefined ?
+      this.trickModeTracks.map((trickModeAdaptation) => {
+        const representations = (
+          filterPlayable ?
+            trickModeAdaptation.getPlayableRepresentations() :
+            trickModeAdaptation.representations
+        ).map(r => r.toVideoRepresentation());
+        const trickMode : IVideoTrack = { id: trickModeAdaptation.id,
+                                          representations,
+                                          isTrickModeTrack: true };
+        if (trickModeAdaptation.isSignInterpreted === true) {
+          trickMode.signInterpreted = true;
+        }
+        return trickMode;
+      }) :
+      undefined;
+
+    const videoTrack: IVideoTrack = {
+      id: this.id,
+      representations: (
+        filterPlayable ?
+          this.getPlayableRepresentations() :
+          this.representations
+      ).map(r => r.toVideoRepresentation()),
+      label: this.label,
+    };
+    if (this.isSignInterpreted === true) {
+      videoTrack.signInterpreted = true;
+    }
+    if (this.isTrickModeTrack === true) {
+      videoTrack.isTrickModeTrack = true;
+    }
+    if (trickModeTracks !== undefined) {
+      videoTrack.trickModeTracks = trickModeTracks;
+    }
+    return videoTrack;
+  }
 }

package/src/manifest/manifest.ts

@@ -626,10 +626,10 @@ function updateDeciperability(
         const result = isDecipherable(representation);
         if (result !== representation.decipherable) {
           updates.push({ manifest, period, adaptation, representation });
+          representation.decipherable = result;
           log.debug(`Decipherability changed for "${representation.id}"`,
                     `(${representation.bitrate})`,
                     String(representation.decipherable));
-          representation.decipherable = result;
         }
       }
     }

package/src/manifest/period.ts

@@ -89,7 +89,8 @@ export default class Period {
             if (newAdaptation.representations.length > 0 && !newAdaptation.isSupported) {
               const error =
                 new MediaError("MANIFEST_INCOMPATIBLE_CODECS_ERROR",
-                               "An Adaptation contains only incompatible codecs.");
+                               "An Adaptation contains only incompatible codecs.",
+                               { adaptation: newAdaptation });
               this.contentWarnings.push(error);
             }
             return newAdaptation;
@@ -102,7 +103,8 @@ export default class Period {
             (type === "video" || type === "audio")
         ) {
           throw new MediaError("MANIFEST_INCOMPATIBLE_CODECS_ERROR",
-                               "No supported " + type + " adaptations");
+                               "No supported " + type + " adaptations",
+                               { adaptation: undefined });
         }
 
         if (filteredAdaptations.length > 0) {

package/src/manifest/representation.ts

@@ -22,20 +22,47 @@ import {
   IParsedRepresentation,
 } from "../parsers/manifest";
 import {
+  IAudioRepresentation,
   ITrackType,
   IHDRInformation,
+  IVideoRepresentation,
 } from "../public_types";
 import areArraysOfNumbersEqual from "../utils/are_arrays_of_numbers_equal";
+import idGenerator from "../utils/id_generator";
 import { IRepresentationIndex } from "./representation_index";
 
+const generateRepresentationUniqueId = idGenerator();
+
 /**
  * Normalized Representation structure.
  * @class Representation
  */
 class Representation {
-  /** ID uniquely identifying the Representation in the Adaptation. */
+  /**
+   * ID uniquely identifying the `Representation` in its parent `Adaptation`.
+   *
+   * This identifier might be linked to an identifier present in the original
+   * Manifest file, it is thus the identifier to use to determine if a
+   * `Representation` from a refreshed `Manifest` is actually the same one than
+   * one in the previously loaded Manifest (as long as the `Adaptation` and
+   * `Period` are also the same).
+   *
+   * For a globally unique identifier regardless of the `Adaptation`, `Period`
+   * or even `Manifest`, you can rely on `uniqueId` instead.
+   */
   public readonly id : string;
 
+  /**
+   * Globally unique identifier for this `Representation` object.
+   *
+   * This identifier is guaranteed to be unique for any `Representation`s of all
+   * `Manifest` objects created in the current JS Realm.
+   * As such, it can be used as an identifier for the JS object itself, whereas
+   * `id` is the identifier for the original Manifest's Representation in the
+   * scope of its parent `Adaptation`.
+   */
+  public readonly uniqueId : string;
+
   /**
    * Interface allowing to get information about segments available for this
    * Representation.
@@ -115,6 +142,7 @@ class Representation {
    */
   constructor(args : IParsedRepresentation, opts : { type : ITrackType }) {
     this.id = args.id;
+    this.uniqueId = generateRepresentationUniqueId();
     this.bitrate = args.bitrate;
     this.codec = args.codecs;
 
@@ -335,6 +363,44 @@ class Representation {
     return true;
   }
 
+  /**
+   * Format Representation as an `IAudioRepresentation`.
+   * @returns {Object}
+   */
+  public toAudioRepresentation(): IAudioRepresentation {
+    const { id, bitrate, codec, isSupported, decipherable } = this;
+    return { id,
+             bitrate,
+             codec,
+             isCodecSupported: isSupported,
+             seemsDecipherable: decipherable };
+  }
+
+  /**
+   * Format Representation as an `IVideoRepresentation`.
+   * @returns {Object}
+   */
+  public toVideoRepresentation(): IVideoRepresentation {
+    const { id,
+            bitrate,
+            frameRate,
+            width,
+            height,
+            codec,
+            hdrInfo,
+            isSupported,
+            decipherable } = this;
+    return { id,
+             bitrate,
+             frameRate,
+             width,
+             height,
+             codec,
+             hdrInfo,
+             isCodecSupported: isSupported,
+             seemsDecipherable: decipherable };
+  }
+
   /**
    * Returns `true` if this Representation can be played (that is: not
    * undecipherable and with a supported codec).

package/src/manifest/utils.ts

@@ -37,9 +37,7 @@ export function areSameContent(
   content2: IBufferedChunkInfos
 ): boolean {
   return (content1.segment.id === content2.segment.id &&
-          content1.representation.id === content2.representation.id &&
-          content1.adaptation.id === content2.adaptation.id &&
-          content1.period.id === content2.period.id);
+          content1.representation.uniqueId === content2.representation.uniqueId);
 }
 
 /**

package/src/parsers/manifest/dash/js-parser/parse_from_document.ts

@@ -32,7 +32,7 @@ import {
 
 /**
  * Parse MPD through the JS parser, on a `Document` instance.
- * @param {Document} manifest - Original manifest as returned by the server
+ * @param {Document} document - Original manifest as returned by the server
  * @param {Object} args - Various parsing options and information.
  * @returns {Object} - Response returned by the DASH-JS parser.
  */

package/src/parsers/manifest/dash/wasm-parser/ts/dash-wasm-parser.ts

@@ -199,6 +199,7 @@ export default class DashWasmParser {
                                                "Unknown error";
         log.warn("DW: Could not create DASH-WASM parser:", message);
         this.status = "failure";
+        throw err;
       });
 
     return this._initProm;

package/src/parsers/texttracks/ttml/parse_ttml.ts

@@ -95,7 +95,7 @@ export default function parseTTMLString(
 
   if (xml !== null && xml !== undefined) {
     const tts = xml.getElementsByTagName("tt");
-    let tt = tts[0];
+    let tt: Element = tts[0];
     if (tt === undefined) {
       // EBU-TT sometimes namespaces tt, by "tt:"
       // Just catch all namespaces to play it safe