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

package/src/core/api/public_api.ts

@@ -34,7 +34,10 @@ import {
   IErrorType,
   MediaError,
 } from "../../errors";
-import features from "../../features";
+import features, {
+  addFeatures,
+  IFeature,
+} from "../../features";
 import log from "../../log";
 import Manifest, {
   Adaptation,
@@ -85,11 +88,10 @@ import idGenerator from "../../utils/id_generator";
 import isNullOrUndefined from "../../utils/is_null_or_undefined";
 import Logger from "../../utils/logger";
 import objectAssign from "../../utils/object_assign";
-import { getLeftSizeOfRange } from "../../utils/ranges";
-import createSharedReference, {
+import { getLeftSizeOfBufferedTimeRange } from "../../utils/ranges";
+import SharedReference, {
   createMappedReference,
   IReadOnlySharedReference,
-  ISharedReference,
 } from "../../utils/reference";
 import TaskCanceller, {
   CancellationSignal,
@@ -101,7 +103,6 @@ import {
   getKeySystemConfiguration,
 } from "../decrypt";
 import { ContentInitializer } from "../init";
-import MediaSourceContentInitializer from "../init/media_source_content_initializer";
 import SegmentBuffersStore, {
   IBufferedChunk,
   IBufferType,
@@ -123,7 +124,7 @@ import PlaybackObserver, {
 /* eslint-disable-next-line max-len */
 import MediaElementTracksStore from "./track_management/media_element_tracks_store";
 import TracksStore, {
-  ITMPeriodObject,
+  ITSPeriodObject,
 } from "./track_management/tracks_store";
 import {
   constructPlayerStateReference,
@@ -181,24 +182,24 @@ class Player extends EventEmitter<IPublicAPIEvent> {
    * done.
    * A new content cannot be launched until it stores `false`.
    */
-  private readonly _priv_contentLock : ISharedReference<boolean>;
+  private readonly _priv_contentLock : SharedReference<boolean>;
 
   /**
    * The speed that should be applied to playback.
    * Used instead of videoElement.playbackRate to allow more flexibility.
    */
-  private readonly _priv_speed : ISharedReference<number>;
+  private readonly _priv_speed : SharedReference<number>;
 
   /** Store buffer-related options used needed when initializing a content. */
   private readonly _priv_bufferOptions : {
     /** Last wanted buffer goal. */
-    wantedBufferAhead : ISharedReference<number>;
+    wantedBufferAhead : SharedReference<number>;
     /** Maximum kept buffer ahead in the current position, in seconds. */
-    maxBufferAhead : ISharedReference<number>;
+    maxBufferAhead : SharedReference<number>;
     /** Maximum kept buffer behind in the current position, in seconds. */
-    maxBufferBehind : ISharedReference<number>;
+    maxBufferBehind : SharedReference<number>;
     /** Maximum size of video buffer , in kiloBytes */
-    maxVideoBufferSize : ISharedReference<number>;
+    maxVideoBufferSize : SharedReference<number>;
   };
 
   /** Information on the current bitrate settings. */
@@ -317,6 +318,14 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     log.setLevel(logLevel);
   }
 
+  /**
+   * Add feature(s) to the RxPlayer.
+   * @param {Array.<Object>} featureList - Features wanted.
+   */
+  static addFeatures(featureList : IFeature[]) : void {
+    addFeatures(featureList);
+  }
+
   /**
    * @constructor
    * @param {Object} options
@@ -336,7 +345,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     // See: https://bugzilla.mozilla.org/show_bug.cgi?id=1194624
     videoElement.preload = "auto";
 
-    this.version = /* PLAYER_VERSION */"4.0.0-beta.2";
+    this.version = /* PLAYER_VERSION */"4.0.0-beta.3";
     this.log = log;
     this.state = "STOPPED";
     this.videoElement = videoElement;
@@ -346,22 +355,22 @@ class Player extends EventEmitter<IPublicAPIEvent> {
 
     this._priv_pictureInPictureRef = getPictureOnPictureStateRef(videoElement,
                                                                  destroyCanceller.signal);
-    this._priv_speed = createSharedReference(videoElement.playbackRate,
-                                             this._destroyCanceller.signal);
+    this._priv_speed = new SharedReference(videoElement.playbackRate,
+                                           this._destroyCanceller.signal);
     this._priv_preferTrickModeTracks = false;
-    this._priv_contentLock = createSharedReference<boolean>(
+    this._priv_contentLock = new SharedReference<boolean>(
       false,
       this._destroyCanceller.signal);
 
     this._priv_bufferOptions = {
-      wantedBufferAhead: createSharedReference(wantedBufferAhead,
-                                               this._destroyCanceller.signal),
-      maxBufferAhead: createSharedReference(maxBufferAhead,
-                                            this._destroyCanceller.signal),
-      maxBufferBehind: createSharedReference(maxBufferBehind,
+      wantedBufferAhead: new SharedReference(wantedBufferAhead,
                                              this._destroyCanceller.signal),
-      maxVideoBufferSize: createSharedReference(maxVideoBufferSize,
-                                                this._destroyCanceller.signal),
+      maxBufferAhead: new SharedReference(maxBufferAhead,
+                                          this._destroyCanceller.signal),
+      maxBufferBehind: new SharedReference(maxBufferBehind,
+                                           this._destroyCanceller.signal),
+      maxVideoBufferSize: new SharedReference(maxVideoBufferSize,
+                                              this._destroyCanceller.signal),
     };
 
     this._priv_bitrateInfos = {
@@ -538,11 +547,11 @@ class Player extends EventEmitter<IPublicAPIEvent> {
             transport,
             checkMediaSegmentIntegrity,
             manifestLoader,
-            manifestUpdateUrl,
             referenceDateTime,
             representationFilter,
             segmentLoader,
             serverSyncInfos,
+            __priv_manifestUpdateUrl,
             __priv_patchLastSegmentInSidx,
             url } = options;
 
@@ -571,14 +580,18 @@ class Player extends EventEmitter<IPublicAPIEvent> {
         throw new Error(`transport "${transport}" not supported`);
       }
 
+      if (features.mediaSourceInit === null) {
+        throw new Error("MediaSource streaming not supported");
+      }
+
       const transportPipelines = transportFn({ lowLatencyMode,
                                                checkMediaSegmentIntegrity,
                                                manifestLoader,
-                                               manifestUpdateUrl,
                                                referenceDateTime,
                                                representationFilter,
                                                segmentLoader,
                                                serverSyncInfos,
+                                               __priv_manifestUpdateUrl,
                                                __priv_patchLastSegmentInSidx });
 
       /** Interface used to load and refresh the Manifest. */
@@ -644,7 +657,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
                                       maxRetry: requestConfig.segment?.maxRetry,
                                       requestTimeout: requestConfig.segment?.timeout };
 
-      initializer = new MediaSourceContentInitializer({
+      initializer = new features.mediaSourceInit({
         adaptiveOptions,
         autoPlay,
         bufferOptions,
@@ -663,6 +676,8 @@ class Player extends EventEmitter<IPublicAPIEvent> {
         this.stop();
         this._priv_currentError = null;
         throw new Error("DirectFile feature not activated in your build.");
+      } else if (isNullOrUndefined(url)) {
+        throw new Error("No URL for a DirectFile content");
       }
       mediaElementTracksStore =
         this._priv_initializeMediaElementTracksStore(currentContentCanceller.signal);
@@ -1051,7 +1066,8 @@ class Player extends EventEmitter<IPublicAPIEvent> {
       throw new Error("Disposed player");
     }
     const videoElement = this.videoElement;
-    const bufferGap = getLeftSizeOfRange(videoElement.buffered, videoElement.currentTime);
+    const bufferGap = getLeftSizeOfBufferedTimeRange(videoElement.buffered,
+                                                     videoElement.currentTime);
     if (bufferGap === Infinity) {
       return 0;
     }
@@ -2287,7 +2303,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
       type : IBufferType;
       manifest : Manifest;
       period : Period;
-      adaptationRef : ISharedReference<IAdaptationChoice|null|undefined>;
+      adaptationRef : SharedReference<IAdaptationChoice|null|undefined>;
     }
   ) : void {
     if (contentInfos.contentId !== this._priv_contentInfos?.contentId) {
@@ -2647,7 +2663,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
   private _priv_callTracksStoreGetterSetter<T, U>(
     periodId : string | undefined,
     defaultValue : U,
-    cb : (tcm : TracksStore, periodRef : ITMPeriodObject) => T
+    cb : (tcm : TracksStore, periodRef : ITSPeriodObject) => T
   ) : T | U {
     if (this._priv_contentInfos === null ||
         this._priv_contentInfos.tracksStore === null)
@@ -2683,7 +2699,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
    */
   private _priv_onAvailableTracksMayHaveChanged(
     trackType : IBufferType,
-    oPeriodRef? : ITMPeriodObject
+    oPeriodRef? : ITSPeriodObject
   ): void {
     const contentInfos = this._priv_contentInfos;
     if (contentInfos === null) {
@@ -2756,7 +2772,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     }
   }
 }
-Player.version = /* PLAYER_VERSION */"4.0.0-beta.2";
+Player.version = /* PLAYER_VERSION */"4.0.0-beta.3";
 
 /** Every events sent by the RxPlayer's public API. */
 interface IPublicAPIEvent {

package/src/core/api/track_management/track_dispatcher.ts

@@ -7,8 +7,8 @@ import {
   IVideoRepresentationsSwitchingMode,
 } from "../../../public_types";
 import EventEmitter from "../../../utils/event_emitter";
-import createSharedReference, {
-  IReadOnlySharedReference, ISharedReference,
+import SharedReference, {
+  IReadOnlySharedReference,
 } from "../../../utils/reference";
 import TaskCanceller from "../../../utils/task_canceller";
 import {
@@ -34,7 +34,7 @@ export default class TrackDispatcher extends EventEmitter<ITrackDispatcherEvent>
    * Reference through which the wanted track will be emitted.
    * `null` is emitted if no track for that type is wanted.
    */
-  private readonly _adaptationRef : ISharedReference<{
+  private readonly _adaptationRef : SharedReference<{
     /** Wanted track chosen by the user. */
     adaptation : Adaptation;
     /** "Switching mode" in which the track switch should happen. */
@@ -81,7 +81,7 @@ export default class TrackDispatcher extends EventEmitter<ITrackDispatcherEvent>
    */
   constructor(
     manifest : Manifest,
-    adaptationRef : ISharedReference<IAdaptationChoice | null | undefined>
+    adaptationRef : SharedReference<IAdaptationChoice | null | undefined>
   ) {
     super();
     this._canceller = new TaskCanceller();
@@ -160,7 +160,7 @@ export default class TrackDispatcher extends EventEmitter<ITrackDispatcherEvent>
     const manifest = this._manifest;
 
     /* Initialize it. Will be at its true value at the end of the function. */
-    const reference = createSharedReference<IRepresentationsChoice>({
+    const reference = new SharedReference<IRepresentationsChoice>({
       representations: [],
       switchingMode: "lazy",
     });
@@ -180,8 +180,10 @@ export default class TrackDispatcher extends EventEmitter<ITrackDispatcherEvent>
 
     function updateReferenceIfNeeded() : void {
       const repSettings = trackInfo.lockedRepresentations.getValue();
+      /* eslint-disable @typescript-eslint/no-duplicate-type-constituents */
       let switchingMode : IAudioRepresentationsSwitchingMode |
                           IVideoRepresentationsSwitchingMode;
+      /* eslint-enable @typescript-eslint/no-duplicate-type-constituents */
 
       /** Representations for which a `RepresentationStream` can be created. */
       let playableRepresentations;
@@ -207,7 +209,8 @@ export default class TrackDispatcher extends EventEmitter<ITrackDispatcherEvent>
 
       // Check if Locked Representations have changed
       const oldRef = reference.getValue();
-      const sortedReps = playableRepresentations.slice().sort();
+      const sortedReps = playableRepresentations.slice()
+        .sort((ra, rb) => ra.bitrate - rb.bitrate);
       if (sortedReps.length !== oldRef.representations.length) {
         reference.setValue({ representations: sortedReps, switchingMode });
         return;