rx-player 3.26.3-dev.2022021400 → 3.27.0-dev.2022032100

package/src/core/README.md

@@ -16,7 +16,7 @@ Those modules are:
     Initialize playback and connects different modules between one another.
 
 
-  - __the `EMEManager` (./eme)__
+  - __the `ContentDecryptor` (./decrypt)__
 
     Negotiate content decryption.
     Only used for contents with DRM (Digital Right Management).

package/src/core/abr/bandwidth_estimator.ts

@@ -17,10 +17,6 @@
 import config from "../../config";
 import EWMA from "./utils/ewma";
 
-const { ABR_MINIMUM_TOTAL_BYTES,
-        ABR_MINIMUM_CHUNK_SIZE,
-        ABR_FAST_EMA,
-        ABR_SLOW_EMA } = config;
 
 /**
  * Calculate a mean bandwidth based on the bytes downloaded and the amount
@@ -35,6 +31,7 @@ export default class BandwidthEstimator {
   private _bytesSampled : number;
 
   constructor() {
+    const { ABR_FAST_EMA, ABR_SLOW_EMA } = config.getCurrent();
     /**
      * A fast-moving average.
      * @private
@@ -63,6 +60,7 @@ export default class BandwidthEstimator {
    *   request.
    */
   public addSample(durationInMs : number, numberOfBytes : number) : void {
+    const { ABR_MINIMUM_CHUNK_SIZE } = config.getCurrent();
     if (numberOfBytes < ABR_MINIMUM_CHUNK_SIZE) {
       return;
     }
@@ -80,6 +78,7 @@ export default class BandwidthEstimator {
    * @returns {Number|undefined}
    */
   public getEstimate() : number|undefined {
+    const { ABR_MINIMUM_TOTAL_BYTES } = config.getCurrent();
     if (this._bytesSampled < ABR_MINIMUM_TOTAL_BYTES) {
       return undefined;
     }
@@ -94,6 +93,7 @@ export default class BandwidthEstimator {
    * Reset the bandwidth estimation.
    */
   public reset() : void {
+    const { ABR_FAST_EMA, ABR_SLOW_EMA } = config.getCurrent();
     this._fastEWMA = new EWMA(ABR_FAST_EMA);
     this._slowEWMA = new EWMA(ABR_SLOW_EMA);
     this._bytesSampled = 0;

package/src/core/abr/network_analyzer.ts

@@ -25,11 +25,6 @@ import {
 } from "./pending_requests_store";
 import EWMA from "./utils/ewma";
 
-const { ABR_REGULAR_FACTOR,
-        ABR_STARVATION_DURATION_DELTA,
-        ABR_STARVATION_FACTOR,
-        ABR_STARVATION_GAP,
-        OUT_OF_STARVATION_GAP } = config;
 
 /** Object describing the current playback conditions. */
 interface IPlaybackConditionsInfo {
@@ -289,6 +284,10 @@ export default class NetworkAnalyzer {
                       regularBitrateFactor : number; };
 
   constructor(initialBitrate: number, lowLatencyMode: boolean) {
+    const { ABR_STARVATION_GAP,
+            OUT_OF_STARVATION_GAP,
+            ABR_STARVATION_FACTOR,
+            ABR_REGULAR_FACTOR } = config.getCurrent();
     this._initialBitrate = initialBitrate;
     this._inStarvationMode = false;
     this._lowLatencyMode = lowLatencyMode;
@@ -334,7 +333,7 @@ export default class NetworkAnalyzer {
     const { bufferGap, position, duration } = playbackInfo;
     const realBufferGap = isFinite(bufferGap) ? bufferGap :
                                                 0;
-
+    const { ABR_STARVATION_DURATION_DELTA } = config.getCurrent();
     // check if should get in/out of starvation mode
     if (isNaN(duration) ||
         realBufferGap + position < duration - ABR_STARVATION_DURATION_DELTA)

package/src/core/api/__tests__/get_player_state.test.ts

@@ -128,7 +128,7 @@ describe("API - getLoadedContentState", () => {
     const fakeProps = {
       ended: false,
       duration: 10,
-      currentTime: 10 - config.FORCED_ENDED_THRESHOLD,
+      currentTime: 10 - config.getCurrent().FORCED_ENDED_THRESHOLD,
     };
     const mediaElement = fakeProps as HTMLMediaElement;
     expect(getLoadedContentState(mediaElement, true, "seeking")).toBe("ENDED");
@@ -144,7 +144,7 @@ describe("API - getLoadedContentState", () => {
     const fakeProps1 = {
       ended: false,
       duration: 10,
-      currentTime: 10 - config.FORCED_ENDED_THRESHOLD,
+      currentTime: 10 - config.getCurrent().FORCED_ENDED_THRESHOLD,
     };
     const mediaElement1 = fakeProps1 as HTMLMediaElement;
     expect(getLoadedContentState(mediaElement1, true, "seeking")).toBe("ENDED");
@@ -159,7 +159,7 @@ describe("API - getLoadedContentState", () => {
     const fakeProps2 = {
       ended: false,
       duration: 10,
-      currentTime: config.FORCED_ENDED_THRESHOLD + 10,
+      currentTime: config.getCurrent().FORCED_ENDED_THRESHOLD + 10,
     };
     const mediaElement2 = fakeProps2 as HTMLMediaElement;
     expect(getLoadedContentState(mediaElement2, true, "seeking")).toBe("ENDED");

package/src/core/api/__tests__/option_utils.test.ts

@@ -46,22 +46,6 @@ const normalizeTextTrackMock = normalizeTextTrack as
   jest.Mock<ReturnType<typeof normalizeTextTrack>>;
 const logWarnMock = log.warn as jest.Mock<ReturnType<typeof log.warn>>;
 
-const {
-  // DEFAULT_AUTO_PLAY,
-  DEFAULT_INITIAL_BITRATES,
-  DEFAULT_LIMIT_VIDEO_WIDTH,
-  // DEFAULT_MANUAL_BITRATE_SWITCHING_MODE,
-  DEFAULT_MIN_BITRATES,
-  DEFAULT_MAX_BITRATES,
-  DEFAULT_MAX_BUFFER_AHEAD,
-  DEFAULT_MAX_BUFFER_BEHIND,
-  // DEFAULT_SHOW_NATIVE_SUBTITLE,
-  // DEFAULT_TEXT_TRACK_MODE,
-  DEFAULT_THROTTLE_WHEN_HIDDEN,
-  DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN,
-  DEFAULT_WANTED_BUFFER_AHEAD,
-} = config;
-
 describe("API - parseConstructorOptions", () => {
   beforeEach(() => {
     jest.resetModules();
@@ -75,8 +59,24 @@ describe("API - parseConstructorOptions", () => {
   });
 
   const videoElement = document.createElement("video");
-
+  const {
+    // DEFAULT_AUTO_PLAY,
+    DEFAULT_INITIAL_BITRATES,
+    DEFAULT_LIMIT_VIDEO_WIDTH,
+    // DEFAULT_MANUAL_BITRATE_SWITCHING_MODE,
+    DEFAULT_MIN_BITRATES,
+    DEFAULT_MAX_BITRATES,
+    DEFAULT_MAX_BUFFER_AHEAD,
+    DEFAULT_MAX_BUFFER_BEHIND,
+    DEFAULT_MAX_VIDEO_BUFFER_SIZE,
+    // DEFAULT_SHOW_NATIVE_SUBTITLE,
+    // DEFAULT_TEXT_TRACK_MODE,
+    DEFAULT_THROTTLE_WHEN_HIDDEN,
+    DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN,
+    DEFAULT_WANTED_BUFFER_AHEAD,
+  } = config.getCurrent();
   const defaultConstructorOptions = {
+    maxVideoBufferSize: DEFAULT_MAX_VIDEO_BUFFER_SIZE,
     maxBufferAhead: DEFAULT_MAX_BUFFER_AHEAD,
     maxBufferBehind: DEFAULT_MAX_BUFFER_BEHIND,
     wantedBufferAhead: DEFAULT_WANTED_BUFFER_AHEAD,
@@ -953,6 +953,17 @@ describe("API - parseLoadVideoOptions", () => {
       audioTrackSwitchingMode: "direct",
     });
 
+    expect(parseLoadVideoOptions({
+      audioTrackSwitchingMode: "reload",
+      url: "foo",
+      transport: "bar",
+    })).toEqual({
+      ...defaultLoadVideoOptions,
+      url: "foo",
+      transport: "bar",
+      audioTrackSwitchingMode: "reload",
+    });
+
     expect(parseLoadVideoOptions({
       audioTrackSwitchingMode: "seamless",
       url: "foo",
@@ -985,6 +996,7 @@ describe("API - parseLoadVideoOptions", () => {
         `the following strategy name:
 - \`seamless\`
 - \`direct\`
+- \`reload\`
 If badly set, seamless strategy will be used as default`);
     logWarnMock.mockReset();
     logWarnMock.mockReturnValue(undefined);

package/src/core/api/get_player_state.ts

@@ -17,7 +17,6 @@
 import config from "../../config";
 import { IStallingSituation } from "../init";
 
-const { FORCED_ENDED_THRESHOLD } = config;
 
 export type IPlayerState = "STOPPED" |
                            "LOADED" |
@@ -56,6 +55,7 @@ export default function getLoadedContentState(
   stalledStatus : IStallingSituation |
                   null
 ) : IPlayerState {
+  const { FORCED_ENDED_THRESHOLD } = config.getCurrent();
   if (mediaElement.ended) {
     return PLAYER_STATES.ENDED;
   }

package/src/core/api/index.ts

@@ -17,10 +17,13 @@
 import PlaybackObserver from "./playback_observer";
 import Player from "./public_api";
 export {
+  IBitrateEstimate,
+  IPositionUpdateItem,
   IStreamEvent,
   IStreamEventData,
 } from "./public_api";
 export { PlaybackObserver };
+export { IPlayerState } from "./get_player_state";
 export {
   IPlaybackObservation,
   IPlaybackObserverEventType,

package/src/core/api/option_utils.ts

@@ -36,31 +36,14 @@ import {
 } from "../../utils/languages";
 import objectAssign from "../../utils/object_assign";
 import warnOnce from "../../utils/warn_once";
-import { IKeySystemOption } from "../eme";
+import { IKeySystemOption } from "../decrypt";
+import { IAudioTrackSwitchingMode } from "../stream";
 import {
   IAudioTrackPreference,
   ITextTrackPreference,
   IVideoTrackPreference,
 } from "./track_choice_manager";
 
-const { DEFAULT_AUDIO_TRACK_SWITCHING_MODE,
-        DEFAULT_AUTO_PLAY,
-        DEFAULT_CODEC_SWITCHING_BEHAVIOR,
-        DEFAULT_ENABLE_FAST_SWITCHING,
-        DEFAULT_INITIAL_BITRATES,
-        DEFAULT_LIMIT_VIDEO_WIDTH,
-        DEFAULT_MANUAL_BITRATE_SWITCHING_MODE,
-        DEFAULT_MIN_BITRATES,
-        DEFAULT_MAX_BITRATES,
-        DEFAULT_MAX_BUFFER_AHEAD,
-        DEFAULT_MAX_BUFFER_BEHIND,
-        DEFAULT_SHOW_NATIVE_SUBTITLE,
-        DEFAULT_STOP_AT_END,
-        DEFAULT_TEXT_TRACK_MODE,
-        DEFAULT_THROTTLE_WHEN_HIDDEN,
-        DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN,
-        DEFAULT_WANTED_BUFFER_AHEAD } = config;
-
 export { IKeySystemOption };
 
 /** Value of the `serverSyncInfos` transport option. */
@@ -195,6 +178,7 @@ type IParsedStartAtOption = { position : number } |
 export interface IConstructorOptions { maxBufferAhead? : number;
                                        maxBufferBehind? : number;
                                        wantedBufferAhead? : number;
+                                       maxVideoBufferSize?: number;
 
                                        limitVideoWidth? : boolean;
                                        throttleWhenHidden? : boolean;
@@ -218,7 +202,7 @@ export interface IParsedConstructorOptions {
   maxBufferAhead : number;
   maxBufferBehind : number;
   wantedBufferAhead : number;
-
+  maxVideoBufferSize : number;
   limitVideoWidth : boolean;
   throttleWhenHidden : boolean;
   throttleVideoBitrateWhenHidden : boolean;
@@ -253,7 +237,7 @@ export interface ILoadVideoOptions {
   textTrackElement? : HTMLElement;
   manualBitrateSwitchingMode? : "seamless"|"direct";
   enableFastSwitching? : boolean;
-  audioTrackSwitchingMode? : "seamless"|"direct";
+  audioTrackSwitchingMode? : IAudioTrackSwitchingMode;
   onCodecSwitch? : "continue"|"reload";
 
   /* eslint-disable import/no-deprecated */
@@ -283,7 +267,7 @@ interface IParsedLoadVideoOptionsBase {
   startAt : IParsedStartAtOption|undefined;
   manualBitrateSwitchingMode : "seamless"|"direct";
   enableFastSwitching : boolean;
-  audioTrackSwitchingMode : "seamless"|"direct";
+  audioTrackSwitchingMode : IAudioTrackSwitchingMode;
   onCodecSwitch : "continue"|"reload";
 }
 
@@ -328,6 +312,7 @@ function parseConstructorOptions(
   let maxBufferAhead : number;
   let maxBufferBehind : number;
   let wantedBufferAhead : number;
+  let maxVideoBufferSize : number;
 
   let throttleWhenHidden : boolean;
   let throttleVideoBitrateWhenHidden : boolean;
@@ -344,6 +329,18 @@ function parseConstructorOptions(
   let maxAudioBitrate : number;
   let maxVideoBitrate : number;
 
+  const { DEFAULT_INITIAL_BITRATES,
+          DEFAULT_LIMIT_VIDEO_WIDTH,
+          DEFAULT_MIN_BITRATES,
+          DEFAULT_MAX_BITRATES,
+          DEFAULT_MAX_BUFFER_AHEAD,
+          DEFAULT_MAX_BUFFER_BEHIND,
+          DEFAULT_MAX_VIDEO_BUFFER_SIZE,
+          DEFAULT_STOP_AT_END,
+          DEFAULT_THROTTLE_WHEN_HIDDEN,
+          DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN,
+          DEFAULT_WANTED_BUFFER_AHEAD } = config.getCurrent();
+
   if (isNullOrUndefined(options.maxBufferAhead)) {
     maxBufferAhead = DEFAULT_MAX_BUFFER_AHEAD;
   } else {
@@ -373,6 +370,18 @@ function parseConstructorOptions(
     }
   }
 
+  if (isNullOrUndefined(options.maxVideoBufferSize)) {
+    maxVideoBufferSize = DEFAULT_MAX_VIDEO_BUFFER_SIZE;
+  } else {
+    maxVideoBufferSize = Number(options.maxVideoBufferSize);
+    if (isNaN(maxVideoBufferSize)) {
+      /* eslint-disable max-len */
+      throw new Error("Invalid maxVideoBufferSize parameter. Should be a number.");
+      /* eslint-enable max-len */
+    }
+  }
+
+
   const limitVideoWidth = isNullOrUndefined(options.limitVideoWidth) ?
     DEFAULT_LIMIT_VIDEO_WIDTH :
     !!options.limitVideoWidth;
@@ -514,6 +523,7 @@ function parseConstructorOptions(
            limitVideoWidth,
            videoElement,
            wantedBufferAhead,
+           maxVideoBufferSize,
            throttleWhenHidden,
            throttleVideoBitrateWhenHidden,
            preferredAudioTracks,
@@ -576,6 +586,14 @@ function parseLoadVideoOptions(
   let textTrackElement : HTMLElement|undefined;
   let startAt : IParsedStartAtOption|undefined;
 
+  const { DEFAULT_AUDIO_TRACK_SWITCHING_MODE,
+          DEFAULT_AUTO_PLAY,
+          DEFAULT_CODEC_SWITCHING_BEHAVIOR,
+          DEFAULT_ENABLE_FAST_SWITCHING,
+          DEFAULT_MANUAL_BITRATE_SWITCHING_MODE,
+          DEFAULT_SHOW_NATIVE_SUBTITLE,
+          DEFAULT_TEXT_TRACK_MODE } = config.getCurrent();
+
   if (isNullOrUndefined(options)) {
     throw new Error("No option set on loadVideo");
   }
@@ -632,11 +650,12 @@ function parseLoadVideoOptions(
   let audioTrackSwitchingMode = isNullOrUndefined(options.audioTrackSwitchingMode)
                                   ? DEFAULT_AUDIO_TRACK_SWITCHING_MODE
                                   : options.audioTrackSwitchingMode;
-  if (!arrayIncludes(["seamless", "direct"], audioTrackSwitchingMode)) {
+  if (!arrayIncludes(["seamless", "direct", "reload"], audioTrackSwitchingMode)) {
     log.warn("The `audioTrackSwitchingMode` loadVideo option must match one of " +
              "the following strategy name:\n" +
              "- `seamless`\n" +
              "- `direct`\n" +
+             "- `reload`\n" +
              "If badly set, " + DEFAULT_AUDIO_TRACK_SWITCHING_MODE +
              " strategy will be used as default");
     audioTrackSwitchingMode = DEFAULT_AUDIO_TRACK_SWITCHING_MODE;

package/src/core/api/playback_observer.ts

@@ -31,14 +31,6 @@ import log from "../../log";
 import objectAssign from "../../utils/object_assign";
 import { getRange } from "../../utils/ranges";
 
-const { SAMPLING_INTERVAL_MEDIASOURCE,
-        SAMPLING_INTERVAL_LOW_LATENCY,
-        SAMPLING_INTERVAL_NO_MEDIASOURCE,
-        RESUME_GAP_AFTER_SEEKING,
-        RESUME_GAP_AFTER_NOT_ENOUGH_DATA,
-        RESUME_GAP_AFTER_BUFFERING,
-        REBUFFERING_GAP,
-        MINIMUM_BUFFER_AMOUNT_BEFORE_FREEZING } = config;
 
 /**
  * HTMLMediaElement Events for which playback observations are calculated and
@@ -207,7 +199,12 @@ export default class PlaybackObserver {
    * @returns {Observable}
    */
   private _createInnerObservable() : Observable<IPlaybackObservation> {
+
+
     return observableDefer(() : Observable<IPlaybackObservation> => {
+      const { SAMPLING_INTERVAL_MEDIASOURCE,
+              SAMPLING_INTERVAL_LOW_LATENCY,
+              SAMPLING_INTERVAL_NO_MEDIASOURCE } = config.getCurrent();
       const getCurrentObservation = (
         event : IPlaybackObserverEventType
       ) : IPlaybackObservation => {
@@ -452,6 +449,9 @@ function getRebufferingEndGap(
   }
   const suffix : "LOW_LATENCY" | "DEFAULT" = lowLatencyMode ? "LOW_LATENCY" :
                                                               "DEFAULT";
+  const { RESUME_GAP_AFTER_SEEKING,
+          RESUME_GAP_AFTER_NOT_ENOUGH_DATA,
+          RESUME_GAP_AFTER_BUFFERING } = config.getCurrent();
 
   switch (rebufferingStatus.reason) {
     case "seeking":
@@ -474,6 +474,7 @@ function hasLoadedUntilTheEnd(
   duration : number,
   lowLatencyMode : boolean
 ) : boolean {
+  const { REBUFFERING_GAP } = config.getCurrent();
   const suffix : "LOW_LATENCY" | "DEFAULT" = lowLatencyMode ? "LOW_LATENCY" :
                                                               "DEFAULT";
   return currentRange !== null &&
@@ -533,6 +534,8 @@ function getRebufferingStatus(
   currentInfo : IMediaInfos,
   { withMediaSource, lowLatencyMode } : IPlaybackObserverOptions
 ) : IRebufferingStatus | null {
+
+  const { REBUFFERING_GAP } = config.getCurrent();
   const { event: currentEvt,
           position: currentTime,
           bufferGap,
@@ -643,6 +646,7 @@ function getFreezingStatus(
   prevObservation : IPlaybackObservation,
   currentInfo : IMediaInfos
 ) : IFreezingStatus | null {
+  const { MINIMUM_BUFFER_AMOUNT_BEFORE_FREEZING } = config.getCurrent();
   if (prevObservation.freezing) {
     if (currentInfo.ended ||
         currentInfo.paused ||