rx-player 3.26.2 → 3.27.0-dev.20220317

package/src/manifest/representation.ts

@@ -15,7 +15,6 @@
  */
 
 import { isCodecSupported } from "../compat";
-import { IContentProtection } from "../core/eme";
 import log from "../log";
 import {
   IContentProtections,
@@ -55,7 +54,7 @@ class Representation {
    * A string describing the codec used for this Representation.
    * undefined if we do not know.
    */
-  public codec? : string;
+  public codec : string | undefined;
 
   /**
    * A string describing the mime-type for this Representation.
@@ -93,7 +92,7 @@ class Representation {
    *     Representation
    *   - if `undefined` there is no certainty on this matter
    */
-  public decipherable? : boolean;
+  public decipherable? : boolean  | undefined;
 
   /** `true` if the Representation is in a supported codec, false otherwise. */
   public isSupported : boolean;
@@ -166,7 +165,7 @@ class Representation {
    * @param {string} drmSystemId - The hexa-encoded DRM system ID
    * @returns {Array.<Object>}
    */
-  public getEncryptionData(drmSystemId : string) : IContentProtection[] {
+  public getEncryptionData(drmSystemId : string) : IRepresentationProtectionData[] {
     const allInitData = this.getAllEncryptionData();
     const filtered = [];
     for (let i = 0; i < allInitData.length; i++) {
@@ -216,7 +215,7 @@ class Representation {
    * after parsing this Representation's initialization segment, if one exists.
    * @returns {Array.<Object>}
    */
-  public getAllEncryptionData() : IContentProtection[] {
+  public getAllEncryptionData() : IRepresentationProtectionData[] {
     if (this.contentProtections === undefined ||
         this.contentProtections.initData.length === 0)
     {
@@ -297,4 +296,38 @@ class Representation {
   }
 }
 
+/** Protection data as returned by a Representation. */
+export interface IRepresentationProtectionData {
+  /**
+   * Initialization data type.
+   * String describing the format of the initialization data sent through this
+   * event.
+   * https://www.w3.org/TR/eme-initdata-registry/
+   */
+  type: string;
+  /**
+   * The key ids linked to those initialization data.
+   * This should be the key ids for the key concerned by the media which have
+   * the present initialization data.
+   *
+   * `undefined` when not known (different from an empty array - which would
+   * just mean that there's no key id involved).
+   */
+  keyIds : Uint8Array[] | undefined;
+  /** Every initialization data for that type. */
+  values: Array<{
+    /**
+     * Hex encoded system id, which identifies the key system.
+     * https://dashif.org/identifiers/content_protection/
+     */
+    systemId: string;
+    /**
+     * The initialization data itself for that type and systemId.
+     * For example, with "cenc" initialization data found in an ISOBMFF file,
+     * this will be the whole PSSH box.
+     */
+     data: Uint8Array;
+  }>;
+}
+
 export default Representation;

package/src/manifest/representation_index/types.ts

@@ -38,12 +38,12 @@ export interface ISmoothInitSegmentPrivateInfos {
    * as found in the Manifest.
    */
   timescale : number;
-  codecPrivateData? : string;
-  bitsPerSample? : number;
-  channels? : number;
-  packetSize? : number;
-  samplingRate? : number;
-  protection? : { keyId : Uint8Array };
+  codecPrivateData? : string | undefined;
+  bitsPerSample? : number | undefined;
+  channels? : number | undefined;
+  packetSize? : number | undefined;
+  samplingRate? : number | undefined;
+  protection? : { keyId : Uint8Array } | undefined;
 }
 
 /**
@@ -78,7 +78,7 @@ export interface IMetaPlaylistPrivateInfos {
   /** The segment originally created by this transport's RepresentationIndex. */
   originalSegment : ISegment;
   contentStart : number;
-  contentEnd? : number;
+  contentEnd? : number | undefined;
 }
 
 /**
@@ -112,12 +112,12 @@ export interface ILocalManifestSegmentPrivateInfos {
  * exploited by the corresponding transport logic.
  */
 export interface IPrivateInfos {
-  smoothInitSegment? : ISmoothInitSegmentPrivateInfos;
-  smoothMediaSegment? : ISmoothSegmentPrivateInfos;
-  metaplaylistInfos? : IMetaPlaylistPrivateInfos;
-  localManifestInitSegment? : ILocalManifestInitSegmentPrivateInfos;
-  localManifestSegment? : ILocalManifestSegmentPrivateInfos;
-  isEMSGWhitelisted? : (evt: IEMSG) => boolean;
+  smoothInitSegment? : ISmoothInitSegmentPrivateInfos | undefined;
+  smoothMediaSegment? : ISmoothSegmentPrivateInfos | undefined;
+  metaplaylistInfos? : IMetaPlaylistPrivateInfos | undefined;
+  localManifestInitSegment? : ILocalManifestInitSegmentPrivateInfos | undefined;
+  localManifestSegment? : ILocalManifestSegmentPrivateInfos | undefined;
+  isEMSGWhitelisted? : ((evt: IEMSG) => boolean) | undefined;
 }
 
 /** Represent a single Segment from a Representation. */
@@ -149,24 +149,24 @@ export interface ISegment {
    * contain an index describing other Segments
    * TODO put in privateInfos?
    */
-  indexRange? : [number, number];
+  indexRange? : [number, number] | undefined;
   /**
    * Optional number of the Segment
    * TODO put in privateInfos?
    */
-  number? : number;
+  number? : number | undefined;
   /**
    * Allows to store supplementary information on a segment that can be later
    * exploited by the transport logic.
    */
-  privateInfos? : IPrivateInfos;
+  privateInfos? : IPrivateInfos | undefined;
   /** Optional byte range to retrieve the Segment from its URL(s) */
-  range? : [number, number];
+  range? : [number, number] | undefined;
   /**
    * Estimated time, in seconds, at which the concerned segment should be
    * offseted when decoded.
    */
-  timestampOffset? : number;
+  timestampOffset? : number | undefined;
   /**
    * Estimated start time for the segment, in seconds.
    * Note that some rounding errors and some differences between what the

package/src/manifest/types.ts

@@ -39,7 +39,7 @@ export interface IHDRInformation {
    * It is used to ask to the user agent if the color depth is supported by the
    * output device.
    */
-  colorDepth?: number;
+  colorDepth? : number | undefined;
   /**
    * It is the HDR eotf. It is the transfer function having the video signal as
    * input and converting it into the linear light output of the display. The
@@ -47,14 +47,14 @@ export interface IHDRInformation {
    *
    * It may be used here to ask the MediaSource if it supported.
    */
-  eotf?: string;
+  eotf? : string | undefined;
   /**
    * It is the video color space used for encoding. An HDR content may not have
    * a wide color gamut.
    *
    * It may be used to ask about output device color space support.
    */
-  colorSpace?: string;
+  colorSpace? : string | undefined;
 }
 
 /** Manifest, as documented in the API documentation. */

package/src/parsers/manifest/dash/common/__tests__/manifest_bounds_calculator.test.ts

@@ -46,6 +46,7 @@ describe("DASH parsers - ManifestBoundsCalculator", () => {
   /* eslint-enable max-len */
     const manifestBoundsCalculator = new ManifestBoundsCalculator({
       isDynamic: false,
+      timeShiftBufferDepth: undefined,
     });
     expect(manifestBoundsCalculator.estimateMinimumBound()).toEqual(0);
     expect(manifestBoundsCalculator.estimateMinimumBound()).toEqual(0);

package/src/parsers/manifest/dash/common/get_hdr_information.ts

@@ -39,7 +39,7 @@ export interface IParsedWEBMHDRInformation {
    *
    * It may be used to ask about output device color space support.
    */
-  colorSpace?: "rec2020";
+  colorSpace: "rec2020" | undefined;
 }
 
 /**

package/src/parsers/manifest/dash/common/get_periods_time_infos.ts

@@ -21,9 +21,9 @@ interface IPeriodTimeInformation {
   /** Time in seconds at which the Period starts. */
   periodStart: number;
   /** Difference in seconds between the Period's end and its start. */
-  periodDuration?: number;
+  periodDuration?: number | undefined;
   /** Time in seconds at which the Period ends. */
-  periodEnd?: number;
+  periodEnd?: number | undefined;
 }
 
 /** Additionnal context needed to retrieve the period time information. */
@@ -31,7 +31,7 @@ export interface IParsedPeriodsContext {
   /** Value of MPD@availabilityStartTime. */
   availabilityStartTime : number;
   /** Value of MPD@mediaPresentationDuration. */
-  duration? : number;
+  duration? : number | undefined;
   /** `true` if MPD@type is equal to "dynamic". */
   isDynamic : boolean;
 }

package/src/parsers/manifest/dash/common/indexes/base.ts

@@ -38,7 +38,7 @@ import { createIndexURLs } from "./tokens";
  */
 export interface IBaseIndex {
   /** Byte range for a possible index of segments in the server. */
-  indexRange?: [number, number];
+  indexRange?: [number, number] | undefined;
   /**
    * Temporal offset, in the current timescale (see timescale), to add to the
    * presentation time (time a segment has at decoding time) to obtain the
@@ -57,15 +57,15 @@ export interface IBaseIndex {
     /** URLs to access the initialization segment. */
     mediaURLs: string[] | null;
     /** possible byte range to request it. */
-    range?: [number, number];
-  };
+    range?: [number, number] | undefined;
+  } | undefined;
   /**
    * Base URL(s) to access any segment. Can contain tokens to replace to convert
    * it to real URLs.
    */
   mediaURLs : string[] | null;
   /** Number from which the first segments in this index starts with. */
-  startNumber? : number;
+  startNumber? : number | undefined;
   /** Every segments defined in this index. */
   timeline : IIndexSegment[];
   /**
@@ -113,9 +113,9 @@ export interface IBaseIndexContextArgument {
   /** Base URL for the Representation concerned. */
   representationBaseURLs : IResolvedBaseUrl[];
   /** ID of the Representation concerned. */
-  representationId? : string;
+  representationId? : string | undefined;
   /** Bitrate of the Representation concerned. */
-  representationBitrate? : number;
+  representationBitrate? : number | undefined;
   /* Function that tells if an EMSG is whitelisted by the manifest */
   isEMSGWhitelisted: (inbandEvent: IEMSG) => boolean;
 }

package/src/parsers/manifest/dash/common/indexes/get_init_segment.ts

@@ -25,8 +25,10 @@ import { IEMSG } from "../../../../containers/isobmff";
  */
 export default function getInitSegment(
   index: { timescale: number;
-           initialization?: { mediaURLs: string[] | null; range?: [number, number] };
-           indexRange?: [number, number];
+           initialization?: { mediaURLs: string[] | null;
+                              range?: [number, number] | undefined; } |
+                            undefined;
+           indexRange?: [number, number] | undefined;
            indexTimeOffset : number; },
   isEMSGWhitelisted?: (inbandEvent: IEMSG) => boolean
 ) : ISegment {

package/src/parsers/manifest/dash/common/indexes/get_segments_from_timeline.ts

@@ -52,9 +52,9 @@ function getWantedRepeatIndex(
  * @returns {Array.<Object>}
  */
 export default function getSegmentsFromTimeline(
-  index : { availabilityTimeComplete? : boolean;
+  index : { availabilityTimeComplete? : boolean | undefined;
             mediaURLs : string[] | null;
-            startNumber? : number;
+            startNumber? : number | undefined;
             timeline : IIndexSegment[];
             timescale : number;
             indexTimeOffset : number; },

package/src/parsers/manifest/dash/common/indexes/is_period_fulfilled.ts

@@ -16,7 +16,6 @@
 
 import config from "../../../../../config";
 
-const { DEFAULT_MAXIMUM_TIME_ROUNDING_ERROR } = config;
 
 /**
  * In Javascript, numbers are encoded in a way that a floating number may be
@@ -36,7 +35,7 @@ export default function isPeriodFulfilled(
   periodEnd: number
 ): boolean {
   const scaledRoundingError =
-    DEFAULT_MAXIMUM_TIME_ROUNDING_ERROR * timescale;
+    config.getCurrent().DEFAULT_MAXIMUM_TIME_ROUNDING_ERROR * timescale;
   return (lastSegmentEnd + scaledRoundingError) >= periodEnd;
 }
 

package/src/parsers/manifest/dash/common/indexes/list.ts

@@ -37,7 +37,7 @@ export interface IListIndex {
    */
   duration : number;
   /** Byte range for a possible index of segments in the server. */
-  indexRange?: [number, number];
+  indexRange?: [number, number] | undefined;
   /**
    * Temporal offset, in the current timescale (see timescale), to add to the
    * presentation time (time a segment has at decoding time) to obtain the
@@ -56,14 +56,14 @@ export interface IListIndex {
     /** URLs to access the initialization segment. */
     mediaURLs: string[] | null;
     /** possible byte range to request it. */
-    range?: [number, number];
-  };
+    range?: [number, number] | undefined;
+  } | undefined;
   /** Information on the list of segments for this index. */
   list: Array<{
     /** URLs of the segment. */
     mediaURLs : string[] | null;
     /** Possible byte-range of the segment. */
-    mediaRange? : [number, number];
+    mediaRange? : [number, number] | undefined;
   }>;
   /**
    * Timescale to convert a time given here into seconds.
@@ -78,12 +78,12 @@ export interface IListIndex {
  * Most of the properties here are already defined in IListIndex.
  */
 export interface IListIndexIndexArgument {
-  duration? : number;
-  indexRange?: [number, number];
-  initialization?: { media? : string;
-                     range? : [number, number]; };
-  list: Array<{ media? : string;
-                mediaRange? : [number, number]; }>;
+  duration? : number | undefined;
+  indexRange?: [number, number] | undefined;
+  initialization?: { media? : string | undefined;
+                     range? : [number, number] | undefined; };
+  list: Array<{ media? : string | undefined;
+                mediaRange? : [number, number] | undefined; }>;
   /**
    * Offset present in the index to convert from the mediaTime (time declared in
    * the media segments and in this index) to the presentationTime (time wanted
@@ -98,8 +98,8 @@ export interface IListIndexIndexArgument {
    * The time given here is in the current
    * timescale (see timescale)
    */
-  presentationTimeOffset? : number;
-  timescale? : number;
+  presentationTimeOffset? : number | undefined;
+  timescale? : number | undefined;
 }
 
 /** Aditional context needed by a SegmentList RepresentationIndex. */
@@ -109,9 +109,9 @@ export interface IListIndexContextArgument {
   /** Base URL for the Representation concerned. */
   representationBaseURLs : IResolvedBaseUrl[];
   /** ID of the Representation concerned. */
-  representationId? : string;
+  representationId? : string | undefined;
   /** Bitrate of the Representation concerned. */
-  representationBitrate? : number;
+  representationBitrate? : number | undefined;
   /* Function that tells if an EMSG is whitelisted by the manifest */
   isEMSGWhitelisted: (inbandEvent: IEMSG) => boolean;
 }

package/src/parsers/manifest/dash/common/indexes/template.ts

@@ -29,7 +29,6 @@ import {
   createIndexURLs,
 } from "./tokens";
 
-const { MINIMUM_SEGMENT_SIZE } = config;
 
 /**
  * Index property defined for a SegmentTemplate RepresentationIndex
@@ -49,14 +48,14 @@ export interface ITemplateIndex {
    */
   timescale : number;
   /** Byte range for a possible index of segments in the server. */
-  indexRange?: [number, number];
+  indexRange?: [number, number] | undefined;
   /** Information on the initialization segment. */
   initialization? : {
     /** URLs to access the initialization segment. */
     mediaURLs: string[] | null;
     /** possible byte range to request it. */
-    range?: [number, number];
-  };
+    range?: [number, number] | undefined;
+  } | undefined;
   /**
    * URL base to access any segment.
    * Can contain token to replace to convert it to real URLs.
@@ -91,7 +90,7 @@ export interface ITemplateIndex {
    */
   presentationTimeOffset : number;
   /** Number from which the first segments in this index starts with. */
-  startNumber? : number;
+  startNumber? : number | undefined;
 }
 
 /**
@@ -99,14 +98,15 @@ export interface ITemplateIndex {
  * Most of the properties here are already defined in ITemplateIndex.
  */
 export interface ITemplateIndexIndexArgument {
-  duration? : number;
-  indexRange?: [number, number];
-  initialization?: { media? : string;
-                     range? : [number, number]; };
-  media? : string;
-  presentationTimeOffset? : number;
-  startNumber? : number;
-  timescale? : number;
+  duration? : number | undefined;
+  indexRange?: [number, number] | undefined;
+  initialization?: { media? : string | undefined;
+                     range? : [number, number] | undefined; } |
+                   undefined;
+  media? : string | undefined;
+  presentationTimeOffset? : number | undefined;
+  startNumber? : number | undefined;
+  timescale? : number | undefined;
 }
 
 /** Aditional context needed by a SegmentTemplate RepresentationIndex. */
@@ -125,9 +125,9 @@ export interface ITemplateIndexContextArgument {
   /** Base URL for the Representation concerned. */
   representationBaseURLs : IResolvedBaseUrl[];
   /** ID of the Representation concerned. */
-  representationId? : string;
+  representationId? : string | undefined;
   /** Bitrate of the Representation concerned. */
-  representationBitrate? : number;
+  representationBitrate? : number | undefined;
   /* Function that tells if an EMSG is whitelisted by the manifest */
   isEMSGWhitelisted: (inbandEvent: IEMSG) => boolean;
 }
@@ -150,9 +150,9 @@ export default class TemplateRepresentationIndex implements IRepresentationIndex
   /** Absolute start of the Period, in seconds. */
   private _periodStart : number;
   /** Difference between the end time of the Period and its start time, in timescale. */
-  private _scaledPeriodEnd? : number;
+  private _scaledPeriodEnd : number | undefined;
   /** Minimum availabilityTimeOffset concerning the segments of this Representation. */
-  private _availabilityTimeOffset? : number;
+  private _availabilityTimeOffset : number | undefined;
   /** Whether the corresponding Manifest can be updated and changed. */
   private _isDynamic : boolean;
   /* Function that tells if an EMSG is whitelisted by the manifest */
@@ -532,7 +532,7 @@ export default class TemplateRepresentationIndex implements IRepresentationIndex
       // segment that there actually is due to a very little difference between
       // the period's duration and a multiple of a segment's duration.
       // Check that we're within a good margin
-      const minimumDuration = MINIMUM_SEGMENT_SIZE * timescale;
+      const minimumDuration = config.getCurrent().MINIMUM_SEGMENT_SIZE * timescale;
       if (maximumTime - regularLastSegmentStart > minimumDuration ||
           numberIndexedToZero === 0)
       {

package/src/parsers/manifest/dash/common/indexes/timeline/construct_timeline_from_elements.ts

@@ -52,7 +52,7 @@ export default function constructTimelineFromElements(
                                                           previousItem,
                                                           nextItem,
                                                           scaledPeriodStart);
-    if (timelineElement != null) {
+    if (timelineElement !== null) {
       timeline.push(timelineElement);
     }
   }