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

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

@@ -72,7 +72,7 @@ describe("Manifest - Manifest", () => {
     expect(manifest.suggestedPresentationDelay).toEqual(undefined);
     expect(manifest.uris).toEqual([]);
 
-    expect(fakeIdGenerator).toHaveBeenCalledTimes(1);
+    expect(fakeIdGenerator).toHaveBeenCalled();
     expect(fakeGenerateNewId).toHaveBeenCalledTimes(1);
     expect(fakeLogger.info).not.toHaveBeenCalled();
     expect(fakeLogger.warn).not.toHaveBeenCalled();
@@ -114,7 +114,7 @@ describe("Manifest - Manifest", () => {
                                          contentWarnings: [] } ]);
     expect(manifest.adaptations).toEqual({});
 
-    expect(fakeIdGenerator).toHaveBeenCalledTimes(1);
+    expect(fakeIdGenerator).toHaveBeenCalled();
     expect(fakeGenerateNewId).toHaveBeenCalledTimes(1);
     expect(fakeLogger.info).not.toHaveBeenCalled();
     expect(fakeLogger.warn).not.toHaveBeenCalled();
@@ -152,7 +152,7 @@ describe("Manifest - Manifest", () => {
     expect(fakePeriod).toHaveBeenCalledTimes(2);
     expect(fakePeriod).toHaveBeenCalledWith(period1, representationFilter);
     expect(fakePeriod).toHaveBeenCalledWith(period2, representationFilter);
-    expect(fakeIdGenerator).toHaveBeenCalledTimes(1);
+    expect(fakeIdGenerator).toHaveBeenCalled();
     expect(fakeGenerateNewId).toHaveBeenCalledTimes(1);
     expect(fakeLogger.info).not.toHaveBeenCalled();
     expect(fakeLogger.warn).not.toHaveBeenCalled();
@@ -194,7 +194,7 @@ describe("Manifest - Manifest", () => {
     ]);
     expect(manifest.adaptations).toBe(adapP1);
 
-    expect(fakeIdGenerator).toHaveBeenCalledTimes(1);
+    expect(fakeIdGenerator).toHaveBeenCalled();
     expect(fakeGenerateNewId).toHaveBeenCalledTimes(1);
     expect(fakeLogger.info).not.toHaveBeenCalled();
     expect(fakeLogger.warn).not.toHaveBeenCalled();
@@ -234,7 +234,7 @@ describe("Manifest - Manifest", () => {
     expect(manifest.contentWarnings).toContainEqual(new Error("0"));
     expect(manifest.contentWarnings).toContainEqual(new Error("1"));
 
-    expect(fakeIdGenerator).toHaveBeenCalledTimes(1);
+    expect(fakeIdGenerator).toHaveBeenCalled();
     expect(fakeGenerateNewId).toHaveBeenCalledTimes(1);
     expect(fakeLogger.info).not.toHaveBeenCalled();
     expect(fakeLogger.warn).not.toHaveBeenCalled();
@@ -285,7 +285,7 @@ describe("Manifest - Manifest", () => {
     ]);
     expect(manifest.suggestedPresentationDelay).toEqual(99);
     expect(manifest.uris).toEqual(["url1", "url2"]);
-    expect(fakeIdGenerator).toHaveBeenCalledTimes(1);
+    expect(fakeIdGenerator).toHaveBeenCalled();
     expect(fakeGenerateNewId).toHaveBeenCalledTimes(1);
     expect(fakeLogger.info).not.toHaveBeenCalled();
     expect(fakeLogger.warn).not.toHaveBeenCalled();
@@ -419,7 +419,7 @@ describe("Manifest - Manifest", () => {
       .toHaveBeenCalledWith(manifest.periods, newManifest.periods);
     expect(mockTrigger).toHaveBeenCalledTimes(1);
     expect(mockTrigger).toHaveBeenCalledWith("manifestUpdate", fakeReplacePeriodsRes);
-    expect(fakeIdGenerator).toHaveBeenCalledTimes(1);
+    expect(fakeIdGenerator).toHaveBeenCalled();
     expect(fakeGenerateNewId).toHaveBeenCalledTimes(1);
     expect(fakeLogger.info).not.toHaveBeenCalled();
     expect(fakeLogger.warn).not.toHaveBeenCalled();

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

@@ -14,10 +14,14 @@
  * limitations under the License.
  */
 
+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";
@@ -30,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`.
@@ -181,6 +185,12 @@ export default class Adaptation {
         if (!isSupported && representation.isSupported) {
           isSupported = true;
         }
+      } else {
+        log.debug("Filtering Representation due to representationFilter",
+                  this.type,
+                  `Adaptation: ${this.id}`,
+                  `Representation: ${representation.id}`,
+                  `(${representation.bitrate})`);
       }
     }
     representations.sort((a, b) => a.bitrate - b.bitrate);
@@ -209,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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import log from "../log";
 import { IParsedManifest } from "../parsers/manifest";
 import {
   ITrackType,
@@ -626,6 +627,9 @@ function updateDeciperability(
         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));
         }
       }
     }

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) {