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

package/src/public_types.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { IPreferredEmeApiType } from "./compat/eme";
 import {
   IPersistentSessionInfoV0,
   IPersistentSessionInfoV1,
@@ -34,6 +35,8 @@ import { IMetaPlaylist } from "./parsers/manifest/metaplaylist/metaplaylist_pars
 
 export { IMediaErrorTrackContext };
 
+export { IPreferredEmeApiType };
+
 /**
  * This file defines and exports types we want to expose to library users.
  * Those types are considered as part of the API.
@@ -142,9 +145,6 @@ export interface ILoadVideoOptions {
   /** Custom implementation for performing Manifest requests. */
   manifestLoader? : IManifestLoader;
 
-  /** Possible custom URL pointing to a shorter form of the Manifest. */
-  manifestUpdateUrl? : string;
-
   /** Minimum bound for Manifest updates, in milliseconds. */
   minimumManifestUpdateInterval? : number;
 
@@ -165,10 +165,7 @@ export interface ILoadVideoOptions {
 export interface IServerSyncInfos {
   /** The server timestamp at a given time. */
   serverTimestamp : number;
-  /**
-   * The client monotonic clock (performance.now) at which `serverTimestamp`
-   * was valid.
-   */
+  /** The client's monotonic clock at which `serverTimestamp` was valid. */
   clientTime : number;
 }
 
@@ -696,8 +693,9 @@ export interface IAudioRepresentation {
   id : string|number;
   bitrate? : number | undefined;
   codec? : string | undefined;
+  isSpatialAudio? : boolean | undefined;
   isCodecSupported? : boolean | undefined;
-  seemsDecipherable? : boolean | undefined;
+  decipherable? : boolean | undefined;
 }
 
 /** Audio track returned by the RxPlayer. */
@@ -744,7 +742,7 @@ export interface IVideoRepresentation {
   frameRate? : number | undefined;
   hdrInfo?: IHDRInformation | undefined;
   isCodecSupported? : boolean | undefined;
-  seemsDecipherable? : boolean | undefined;
+  decipherable? : boolean | undefined;
 }
 
 /** Video track returned by the RxPlayer. */
@@ -919,19 +917,23 @@ export interface IBrokenRepresentationsLockContext {
 export interface ITrackUpdateEventPayload {
   period : IPeriod;
   trackType : ITrackType;
+  /* eslint-disable @typescript-eslint/no-redundant-type-constituents */
   reason : "missing" | // Missing from Manifest update
            "manual" | // Manually and explicitely updated
            "trickmode-enabled" | // Video trickmode tracks being enabled
            "trickmode-disabled" | // Video trickmode tracks being disabled
            "no-playable-representation" | // Previous track had no playable Representation
            string;
+  /* eslint-enable @typescript-eslint/no-redundant-type-constituents */
 }
 
 export interface IRepresentationListUpdateContext {
   period : IPeriod;
   trackType : ITrackType;
+  /* eslint-disable @typescript-eslint/no-redundant-type-constituents */
   reason : "decipherability-update" |
            string;
+  /* eslint-enable @typescript-eslint/no-redundant-type-constituents */
 }
 
 export interface ILockedVideoRepresentationsSettings {

package/src/transports/dash/manifest_parser.ts

@@ -23,6 +23,7 @@ import {
   IDashParserResponse,
   ILoadedResource,
 } from "../../parsers/manifest/dash/parsers_types";
+import { IPlayerError } from "../../public_types";
 import objectAssign from "../../utils/object_assign";
 import request from "../../utils/request";
 import {
@@ -114,7 +115,8 @@ export default function generateManifestParser(
      * If it is not defined, throws.
      * @returns {Object|Promise.<Object>}
      */
-    function runDefaultJsParser() {
+    function runDefaultJsParser(
+    ) : IManifestParserResult | Promise<IManifestParserResult> {
       if (parsers.js === null) {
         throw new Error("No MPD parser is imported");
       }
@@ -139,8 +141,9 @@ export default function generateManifestParser(
         if (cancelSignal.isCancelled()) {
           return Promise.reject(cancelSignal.cancellationError);
         }
-        const manifest = new Manifest(parserResponse.value.parsed, options);
-        return { manifest, url };
+        const warnings : IPlayerError[] = [];
+        const manifest = new Manifest(parserResponse.value.parsed, options, warnings);
+        return { manifest, url, warnings };
       }
 
       const { value } = parserResponse;
@@ -216,7 +219,7 @@ export default function generateManifestParser(
 function assertLoadedResourcesFormatString(
   loadedResources : Array<ILoadedResource<string | ArrayBuffer>>
 ) : asserts loadedResources is Array<ILoadedResource<string>> {
-  if (__ENVIRONMENT__.CURRENT_ENV === __ENVIRONMENT__.PRODUCTION as number) {
+  if (__ENVIRONMENT__.CURRENT_ENV as number === __ENVIRONMENT__.PRODUCTION as number) {
     return;
   }
   loadedResources.forEach((loadedResource) => {
@@ -241,7 +244,7 @@ function assertLoadedResourcesFormatString(
 function assertLoadedResourcesFormatArrayBuffer(
   loadedResources : Array<ILoadedResource<string | ArrayBuffer>>
 ) : asserts loadedResources is Array<ILoadedResource<ArrayBuffer>> {
-  if (__ENVIRONMENT__.CURRENT_ENV === __ENVIRONMENT__.PRODUCTION as number) {
+  if (__ENVIRONMENT__.CURRENT_ENV as number === __ENVIRONMENT__.PRODUCTION as number) {
     return;
   }
 

package/src/transports/local/pipelines.ts

@@ -23,7 +23,7 @@ import Manifest from "../../manifest";
 import parseLocalManifest, {
   ILocalManifest,
 } from "../../parsers/manifest/local";
-import { ILoadedManifestFormat } from "../../public_types";
+import { ILoadedManifestFormat, IPlayerError } from "../../public_types";
 import isNullOrUndefined from "../../utils/is_null_or_undefined";
 import { CancellationSignal } from "../../utils/task_canceller";
 import {
@@ -73,8 +73,9 @@ export default function getLocalManifestPipelines(
         throw new Error("Wrong format for the manifest data");
       }
       const parsed = parseLocalManifest(loadedManifest as ILocalManifest);
-      const manifest = new Manifest(parsed, transportOptions);
-      return { manifest, url: undefined };
+      const warnings : IPlayerError[] = [];
+      const manifest = new Manifest(parsed, transportOptions, warnings);
+      return { manifest, url: undefined, warnings };
     },
   };
 

package/src/transports/metaplaylist/pipelines.ts

@@ -27,6 +27,7 @@ import {
   ICdnMetadata,
   IParsedManifest,
 } from "../../parsers/manifest/types";
+import { IPlayerError } from "../../public_types";
 import isNullOrUndefined from "../../utils/is_null_or_undefined";
 import objectAssign from "../../utils/object_assign";
 import { CancellationSignal } from "../../utils/task_canceller";
@@ -54,7 +55,7 @@ import generateManifestLoader from "./manifest_loader";
 
 /**
  * Get base - real - content from an offseted metaplaylist content.
- * @param {Object} segment
+ * @param {Object} mplContext
  * @returns {Object}
  */
 function getOriginalContext(
@@ -153,8 +154,9 @@ export default function(options : ITransportOptions): ITransportPipelines {
         parsedResult : IMPLParserResponse<IParsedManifest>
       ) : Promise<IManifestParserResult> {
         if (parsedResult.type === "done") {
-          const manifest = new Manifest(parsedResult.value, options);
-          return Promise.resolve({ manifest });
+          const warnings : IPlayerError[] = [];
+          const manifest = new Manifest(parsedResult.value, options, warnings);
+          return Promise.resolve({ manifest, warnings });
         }
 
         const parsedValue = parsedResult.value;

package/src/transports/smooth/pipelines.ts

@@ -19,6 +19,7 @@ import Manifest from "../../manifest";
 import { getMDAT } from "../../parsers/containers/isobmff";
 import { ICdnMetadata } from "../../parsers/manifest";
 import createSmoothManifestParser from "../../parsers/manifest/smooth";
+import { IPlayerError } from "../../public_types";
 import request from "../../utils/request";
 import {
   strToUtf8,
@@ -77,10 +78,11 @@ export default function(transportOptions : ITransportOptions) : ITransportPipeli
                                                 url,
                                                 manifestReceivedTime);
 
+      const warnings : IPlayerError[] = [];
       const manifest = new Manifest(parserResult, {
         representationFilter: transportOptions.representationFilter,
-      });
-      return { manifest, url };
+      }, warnings);
+      return { manifest, url, warnings };
     },
   };
 

package/src/transports/smooth/segment_loader.ts

@@ -142,7 +142,7 @@ const generateSegmentLoader = ({
         break;
       }
       default:
-        if (__ENVIRONMENT__.CURRENT_ENV === __ENVIRONMENT__.DEV as number) {
+        if (__ENVIRONMENT__.CURRENT_ENV as number === __ENVIRONMENT__.DEV as number) {
           assert(false, "responseData should have been set");
         }
         responseData = new Uint8Array(0);

package/src/transports/types.ts

@@ -26,6 +26,7 @@ import {
   IRepresentationFilter,
   ISegmentLoader as ICustomSegmentLoader,
   IServerSyncInfos,
+  IPlayerError,
 } from "../public_types";
 import TaskCanceller, {
   CancellationSignal,
@@ -269,8 +270,8 @@ export type ISegmentParser<
 
 export interface IManifestParserOptions {
   /**
-   * If set, offset to add to `performance.now()` to obtain the current
-   * server's time.
+   * If set, offset to add to the used monotonically-raising timestamp (common
+   * to the RxPlayer's code), to obtain the current server's time.
    */
   externalClockOffset : number | undefined;
   /** Original URL used for the full version of the Manifest. */
@@ -352,6 +353,11 @@ export type IManifestParserRequestScheduler =
 export interface IManifestParserResult {
   /** The parsed Manifest Object itself. */
   manifest : Manifest;
+  /**
+   * Minor issues seen while constructing the Manifest object.
+   * Empty if no issue was seen.
+   */
+  warnings : IPlayerError[];
   /**
    * "Real" URL (post-redirection) at which the Manifest can be refreshed.
    *
@@ -572,13 +578,15 @@ export interface IChunkCompleteInformation {
    */
   url? : string | undefined;
   /**
-   * Time at which the request began in terms of `performance.now`.
+   * Time at which the request began in terms of the monotonically-raising
+   * timestamp used by the RxPlayer.
    * If fetching the corresponding data necessitated to perform multiple
    * requests, this time corresponds to the first request made.
    */
   sendingTime? : number | undefined;
   /**
-   * Time at which the request ended in terms of `performance.now`.
+   * Time at which the request ended in terms of the monotonically-raising
+   * timestamp used by the RxPlayer.
    * If fetching the corresponding data necessitated to perform multiple
    * requests, this time corresponds to the last request to end.
    */
@@ -770,13 +778,15 @@ export interface IRequestedData<T> {
    */
   url? : string | undefined;
   /**
-   * Time at which the request began in terms of `performance.now`.
+   * Time at which the request began in terms of the monotonically-raising
+   * timestamp used by the RxPlayer.
    * If fetching the corresponding data necessitated to perform multiple
    * requests, this time corresponds to the first request made.
    */
   sendingTime? : number | undefined;
   /**
-   * Time at which the request ended in terms of `performance.now`.
+   * Time at which the request ended in terms of the monotonically-raising
+   * timestamp used by the RxPlayer.
    * If fetching the corresponding data necessitated to perform multiple
    * requests, this time corresponds to the last request to end.
    */
@@ -789,10 +799,10 @@ export interface ITransportOptions {
   checkMediaSegmentIntegrity? : boolean | undefined;
   lowLatencyMode : boolean;
   manifestLoader?: IManifestLoader | undefined;
-  manifestUpdateUrl? : string | undefined;
   referenceDateTime? : number | undefined;
   representationFilter? : IRepresentationFilter | undefined;
   segmentLoader? : ICustomSegmentLoader | undefined;
   serverSyncInfos? : IServerSyncInfos | undefined;
+  __priv_manifestUpdateUrl? : string | undefined;
   __priv_patchLastSegmentInSidx? : boolean | undefined;
 }

package/src/transports/utils/__tests__/check_isobmff_integrity.test.ts

@@ -61,7 +61,7 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     const checkISOBMFFIntegrity =
       jest.requireActual("../check_isobmff_integrity").default;
     const myUint8Array = new Uint8Array([0, 1, 2]);
-    let error : unknown | null = null;
+    let error : unknown = null;
     try {
       checkISOBMFFIntegrity(myUint8Array, true);
     } catch (e : unknown) {
@@ -72,7 +72,7 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     expect((error as typeof OtherError).type).toEqual("OTHER_ERROR");
     expect((error as typeof OtherError).code).toEqual("INTEGRITY_ERROR");
     expect((error as typeof OtherError).message)
-      .toEqual("OtherError (INTEGRITY_ERROR) Incomplete `ftyp` box");
+      .toEqual("INTEGRITY_ERROR: Incomplete `ftyp` box");
   });
 
   it("should throw an other error if an init segment is missing a complete moov", () => {
@@ -84,7 +84,7 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     const checkISOBMFFIntegrity =
       jest.requireActual("../check_isobmff_integrity").default;
     const myUint8Array = new Uint8Array([0, 1, 2]);
-    let error : unknown | null = null;
+    let error : unknown = null;
     try {
       checkISOBMFFIntegrity(myUint8Array, true);
     } catch (e : unknown) {
@@ -95,7 +95,7 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     expect((error as typeof OtherError).type).toEqual("OTHER_ERROR");
     expect((error as typeof OtherError).code).toEqual("INTEGRITY_ERROR");
     expect((error as typeof OtherError).message)
-      .toEqual("OtherError (INTEGRITY_ERROR) Incomplete `moov` box");
+      .toEqual("INTEGRITY_ERROR: Incomplete `moov` box");
   });
 
   /* eslint-disable max-len */
@@ -108,7 +108,7 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     const checkISOBMFFIntegrity =
       jest.requireActual("../check_isobmff_integrity").default;
     const myUint8Array = new Uint8Array([0, 1, 2]);
-    let error : unknown | null = null;
+    let error : unknown = null;
     try {
       checkISOBMFFIntegrity(myUint8Array, false);
     } catch (e : unknown) {
@@ -119,7 +119,7 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     expect((error as typeof OtherError).type).toEqual("OTHER_ERROR");
     expect((error as typeof OtherError).code).toEqual("INTEGRITY_ERROR");
     expect((error as typeof OtherError).message)
-      .toEqual("OtherError (INTEGRITY_ERROR) Incomplete `moof` box");
+      .toEqual("INTEGRITY_ERROR: Incomplete `moof` box");
   });
 
   /* eslint-disable max-len */
@@ -132,7 +132,7 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     const checkISOBMFFIntegrity =
       jest.requireActual("../check_isobmff_integrity").default;
     const myUint8Array = new Uint8Array([0, 1, 2]);
-    let error : unknown | null = null;
+    let error : unknown = null;
     try {
       checkISOBMFFIntegrity(myUint8Array, false);
     } catch (e : unknown) {
@@ -143,6 +143,6 @@ describe("transports utils - checkISOBMFFIntegrity", () => {
     expect((error as typeof OtherError).type).toEqual("OTHER_ERROR");
     expect((error as typeof OtherError).code).toEqual("INTEGRITY_ERROR");
     expect((error as typeof OtherError).message)
-      .toEqual("OtherError (INTEGRITY_ERROR) Incomplete `mdat` box");
+      .toEqual("INTEGRITY_ERROR: Incomplete `mdat` box");
   });
 });

package/src/transports/utils/call_custom_manifest_loader.ts

@@ -19,6 +19,7 @@ import {
   IManifestLoader,
   ILoadedManifestFormat,
 } from "../../public_types";
+import getMonotonicTimeStamp from "../../utils/monotonic_timestamp";
 import {
   CancellationError,
   CancellationSignal,
@@ -47,7 +48,7 @@ export default function callCustomManifestLoader(
     cancelSignal : CancellationSignal
   ) : Promise< IRequestedData<ILoadedManifestFormat> > => {
     return new Promise((res, rej) => {
-      const timeAPIsDelta = Date.now() - performance.now();
+      const timeAPIsDelta = Date.now() - getMonotonicTimeStamp();
       /** `true` when the custom segmentLoader should not be active anymore. */
       let hasFinished = false;
 

package/src/transports/utils/get_isobmff_timing_infos.ts

@@ -30,9 +30,6 @@ import { IChunkTimeInfo } from "../types";
  * multiple parts and buffer is one of them. If false, buffer is the whole
  * segment.
  * @param {Object} segment
- * @param {Array.<Object>|undefined} sidxSegments - Segments from sidx. Here
- * pre-parsed for performance reasons as it is usually available when
- * this function is called.
  * @param {number|undefined} initTimescale
  * @returns {Object}
  */

package/src/typings/globals.d.ts

@@ -19,48 +19,6 @@
 
 /* eslint-disable @typescript-eslint/naming-convention */
 
-declare const __FEATURES__ : {
-  IS_DISABLED : 0;
-  IS_ENABLED : 1;
-
-  DASH : 0 | 1;
-  DIRECTFILE : 0 | 1;
-  EME : 0 | 1;
-  HTML_SAMI : 0 | 1;
-  HTML_SRT : 0 | 1;
-  HTML_TTML : 0 | 1;
-  HTML_VTT : 0 | 1;
-  LOCAL_MANIFEST : 0 | 1;
-  METAPLAYLIST : 0 | 1;
-  DEBUG_ELEMENT : 0 | 1;
-  NATIVE_SAMI : 0 | 1;
-  NATIVE_SRT : 0 | 1;
-  NATIVE_TTML : 0 | 1;
-  NATIVE_VTT : 0 | 1;
-  SMOOTH : 0 | 1;
-} | typeof FEATURES_ENUM;
-
-declare const enum FEATURES_ENUM {
-  IS_DISABLED,
-  IS_ENABLED,
-
-  DASH,
-  DIRECTFILE,
-  EME,
-  HTML_SAMI,
-  HTML_SRT,
-  HTML_TTML,
-  HTML_VTT,
-  LOCAL_MANIFEST,
-  METAPLAYLIST,
-  DEBUG_ELEMENT,
-  NATIVE_SAMI,
-  NATIVE_SRT,
-  NATIVE_TTML,
-  NATIVE_VTT,
-  SMOOTH,
-}
-
 declare const __ENVIRONMENT__ : {
   CURRENT_ENV : 0 | 1;
   DEV : 0;
@@ -76,5 +34,3 @@ declare const enum ENVIRONMENT_ENUM {
 declare const __LOGGER_LEVEL__ : {
   CURRENT_LEVEL : string;
 };
-
-declare const __RX_PLAYER_DEBUG_MODE__ : boolean | undefined;

package/src/utils/__tests__/base64.test.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import globalScope from "../../compat/global_scope";
+
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-var-requires */
@@ -67,7 +69,7 @@ describe("base64ToBytes", () => {
       .toEqual(new Uint8Array([ 36, 101, 120, 112, 101, 99, 116, 40, 98, 97,
                                 115, 101, 54, 52, 84, 111, 85, 105, 110, 116,
                                 56, 65, 114, 114, 97, 121, 40, 34, 34, 41 ]));
-    expect(base64ToBytes(window.btoa("toto")))
+    expect(base64ToBytes(globalScope.btoa("toto")))
       .toEqual(new Uint8Array([ 116, 111, 116, 111 ]));
     expect(logWarn).not.toHaveBeenCalled();
 
@@ -141,7 +143,7 @@ describe("bytesToBase64", () => {
                                           56, 65, 114, 114, 97, 121, 40, 34, 34, 41 ])))
       .toEqual("JGV4cGVjdChiYXNlNjRUb1VpbnQ4QXJyYXkoIiIp");
     expect(bytesToBase64(new Uint8Array([ 116, 111, 116, 111 ])))
-      .toEqual(window.btoa("toto"));
+      .toEqual(globalScope.btoa("toto"));
     expect(logWarn).not.toHaveBeenCalled();
   });
 });

package/src/utils/__tests__/id_generator.test.ts

@@ -16,14 +16,15 @@
 
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 
+import globalScope from "../../compat/global_scope";
 import idGenerator from "../id_generator";
 
-const oldNumberDef = window.Number;
+const oldNumberDef = globalScope.Number;
 
 describe("utils - idGenerator", () => {
   afterEach(() => {
     // There's an ugly test in here that changes the Number object
-    window.Number = oldNumberDef;
+    globalScope.Number = oldNumberDef;
   });
 
   it("should increment an ID", () => {
@@ -54,8 +55,10 @@ describe("utils - idGenerator", () => {
   });
   it ("should preprend a 0 after A LOT of ID generation", () => {
     // Ugly but I don't care
-    window.Number = { MAX_SAFE_INTEGER: 3,
-                      isSafeInteger: (x : number) => x <= 3 } as typeof window.Number;
+    globalScope.Number = {
+      MAX_SAFE_INTEGER: 3,
+      isSafeInteger: (x : number) => x <= 3,
+    } as typeof globalScope.Number;
     const generateNewID1 = idGenerator();
     const generateNewID2 = idGenerator();
     const generateNewID3 = idGenerator();