rx-player 3.31.0 → 3.31.1-dev.2023062700

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v3.31.1-dev.2023062700 (2023-06-27)
+
+### Other improvements
+
+  - Do not load the last text segment if the current position goes after it as it is unnecessary [#1256]
+  - Set a better error message for when no `keySystems` option is set when playing an encrypted content
+
+
 ## v3.31.0 (2023-06-14)
 
 ### Features

package/VERSION

@@ -1 +1 @@
-3.31.0
+3.31.1-dev.2023062700

package/dist/_esm5.processed/core/api/public_api.js

@@ -90,7 +90,7 @@ var Player = /** @class */ (function (_super) {
         // Workaround to support Firefox autoplay on FF 42.
         // See: https://bugzilla.mozilla.org/show_bug.cgi?id=1194624
         videoElement.preload = "auto";
-        _this.version = /* PLAYER_VERSION */ "3.31.0";
+        _this.version = /* PLAYER_VERSION */ "3.31.1-dev.2023062700";
         _this.log = log;
         _this.state = "STOPPED";
         _this.videoElement = videoElement;
@@ -435,6 +435,9 @@ var Player = /** @class */ (function (_super) {
                 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");
+            }
             mediaElementTrackChoiceManager =
                 this._priv_initializeMediaElementTrackChoiceManager(defaultAudioTrack, defaultTextTrack, currentContentCanceller.signal);
             if (currentContentCanceller.isUsed()) {
@@ -2428,5 +2431,5 @@ var Player = /** @class */ (function (_super) {
     };
     return Player;
 }(EventEmitter));
-Player.version = /* PLAYER_VERSION */ "3.31.0";
+Player.version = /* PLAYER_VERSION */ "3.31.1-dev.2023062700";
 export default Player;

package/dist/_esm5.processed/core/init/directfile_content_initializer.d.ts

@@ -18,21 +18,80 @@ import { IReadOnlySharedReference } from "../../utils/reference";
 import { PlaybackObserver } from "../api";
 import { ContentInitializer } from "./types";
 import { IInitialTimeOptions } from "./utils/get_initial_time";
+/**
+ * `ContentIntializer` which will load contents by putting their URL in the
+ * `src` attribute of the given HTMLMediaElement.
+ *
+ * Because such contents are mainly loaded by the browser, those (called
+ * "directfile" contents in the RxPlayer) needs a simpler logic in-JS when
+ * compared to a content that relies on the MSE API.
+ *
+ * @class DirectFileContentInitializer
+ */
 export default class DirectFileContentInitializer extends ContentInitializer {
+    /**
+     * Initial options given to the `DirectFileContentInitializer`.
+     */
     private _settings;
+    /**
+     * Allows to abort and clean everything the `DirectFileContentInitializer` is
+     * doing.
+     */
     private _initCanceller;
+    /**
+     * Creates a new `DirectFileContentInitializer` linked to the given settings.
+     * @param {Object} settings
+     */
     constructor(settings: IDirectFileOptions);
+    /**
+     * "Prepare" content so it can later be played by calling `start`.
+     */
     prepare(): void;
+    /**
+     * Start playback of the content linked to this `DirectFileContentInitializer`
+     * on the given `HTMLMediaElement` and its associated `PlaybackObserver`.
+     * @param {HTMLMediaElement} mediaElement - HTMLMediaElement on which the
+     * content will be played.
+     * @param {Object} playbackObserver - Object regularly emitting playback
+     * information.
+     */
     start(mediaElement: HTMLMediaElement, playbackObserver: PlaybackObserver): void;
+    /**
+     * Update URL this `ContentIntializer` depends on.
+     * @param {Array.<string>|undefined} _urls
+     * @param {boolean} _refreshNow
+     */
     updateContentUrls(_urls: string[] | undefined, _refreshNow: boolean): void;
+    /**
+     * Stop content and free all resources linked to this `ContentIntializer`.
+     */
     dispose(): void;
+    /**
+     * Logic performed when a fatal error was triggered.
+     * @param {*} err - The fatal error in question.
+     */
     private _onFatalError;
+    /**
+     * Perform the initial seek (to begin playback at an initially-calculated
+     * position based on settings) and auto-play if needed when loaded.
+     * @param {HTMLMediaElement} mediaElement
+     * @param {Object} playbackObserver
+     */
     private _seekAndPlay;
 }
+/** Options used by the `DirectFileContentInitializer` */
 export interface IDirectFileOptions {
+    /** If `true` we will play right after the content is considered "loaded". */
     autoPlay: boolean;
+    /**
+     * Encryption-related settings. Can be left as an empty array if the content
+     * isn't encrypted.
+     */
     keySystems: IKeySystemOption[];
+    /** Communicate the playback rate wanted by the user. */
     speed: IReadOnlySharedReference<number>;
+    /** Optional initial position to start at. */
     startAt?: IInitialTimeOptions | undefined;
-    url?: string | undefined;
+    /** URL that should be played. */
+    url: string;
 }

package/dist/_esm5.processed/core/init/directfile_content_initializer.js

@@ -34,6 +34,7 @@ var __extends = (this && this.__extends) || (function () {
  */
 import { clearElementSrc } from "../../compat";
 import log from "../../log";
+import assert from "../../utils/assert";
 import createSharedReference from "../../utils/reference";
 import TaskCanceller from "../../utils/task_canceller";
 import { ContentInitializer } from "./types";
@@ -42,25 +43,51 @@ import performInitialSeekAndPlay from "./utils/initial_seek_and_play";
 import initializeContentDecryption from "./utils/initialize_content_decryption";
 import RebufferingController from "./utils/rebuffering_controller";
 import listenToMediaError from "./utils/throw_on_media_error";
+/**
+ * `ContentIntializer` which will load contents by putting their URL in the
+ * `src` attribute of the given HTMLMediaElement.
+ *
+ * Because such contents are mainly loaded by the browser, those (called
+ * "directfile" contents in the RxPlayer) needs a simpler logic in-JS when
+ * compared to a content that relies on the MSE API.
+ *
+ * @class DirectFileContentInitializer
+ */
 var DirectFileContentInitializer = /** @class */ (function (_super) {
     __extends(DirectFileContentInitializer, _super);
+    /**
+     * Creates a new `DirectFileContentInitializer` linked to the given settings.
+     * @param {Object} settings
+     */
     function DirectFileContentInitializer(settings) {
         var _this = _super.call(this) || this;
         _this._settings = settings;
         _this._initCanceller = new TaskCanceller();
         return _this;
     }
+    /**
+     * "Prepare" content so it can later be played by calling `start`.
+     */
     DirectFileContentInitializer.prototype.prepare = function () {
         return; // Directfile contents do not have any preparation
     };
+    /**
+     * Start playback of the content linked to this `DirectFileContentInitializer`
+     * on the given `HTMLMediaElement` and its associated `PlaybackObserver`.
+     * @param {HTMLMediaElement} mediaElement - HTMLMediaElement on which the
+     * content will be played.
+     * @param {Object} playbackObserver - Object regularly emitting playback
+     * information.
+     */
     DirectFileContentInitializer.prototype.start = function (mediaElement, playbackObserver) {
         var _this = this;
         var cancelSignal = this._initCanceller.signal;
         var _a = this._settings, keySystems = _a.keySystems, speed = _a.speed, url = _a.url;
         clearElementSrc(mediaElement);
-        if (url == null) {
-            throw new Error("No URL for a DirectFile content");
-        }
+        /**
+         * Create dummy encryption data emitter, as those are not sent from the
+         * RxPlayer for directfile contents.
+         */
         var decryptionRef = createSharedReference(null);
         decryptionRef.finish();
         var drmInitRef = initializeContentDecryption(mediaElement, keySystems, decryptionRef, {
@@ -89,7 +116,7 @@ var DirectFileContentInitializer = /** @class */ (function (_super) {
         rebufferingController.start();
         drmInitRef.onUpdate(function (evt, stopListeningToDrmUpdates) {
             if (evt.initializationState.type === "uninitialized") {
-                return;
+                return; // nothing done yet
             }
             stopListeningToDrmUpdates();
             // Start everything! (Just put the URL in the element's src).
@@ -104,26 +131,43 @@ var DirectFileContentInitializer = /** @class */ (function (_super) {
                     if (newDrmStatus.initializationState.type === "initialized") {
                         stopListeningToDrmUpdatesAgain();
                         _this._seekAndPlay(mediaElement, playbackObserver);
-                        return;
                     }
                 }, { emitCurrentValue: true, clearSignal: cancelSignal });
             }
             else {
+                assert(evt.initializationState.type === "initialized");
                 _this._seekAndPlay(mediaElement, playbackObserver);
-                return;
             }
         }, { emitCurrentValue: true, clearSignal: cancelSignal });
     };
+    /**
+     * Update URL this `ContentIntializer` depends on.
+     * @param {Array.<string>|undefined} _urls
+     * @param {boolean} _refreshNow
+     */
     DirectFileContentInitializer.prototype.updateContentUrls = function (_urls, _refreshNow) {
         throw new Error("Cannot update content URL of directfile contents");
     };
+    /**
+     * Stop content and free all resources linked to this `ContentIntializer`.
+     */
     DirectFileContentInitializer.prototype.dispose = function () {
         this._initCanceller.cancel();
     };
+    /**
+     * Logic performed when a fatal error was triggered.
+     * @param {*} err - The fatal error in question.
+     */
     DirectFileContentInitializer.prototype._onFatalError = function (err) {
         this._initCanceller.cancel();
         this.trigger("error", err);
     };
+    /**
+     * Perform the initial seek (to begin playback at an initially-calculated
+     * position based on settings) and auto-play if needed when loaded.
+     * @param {HTMLMediaElement} mediaElement
+     * @param {Object} playbackObserver
+     */
     DirectFileContentInitializer.prototype._seekAndPlay = function (mediaElement, playbackObserver) {
         var _this = this;
         var cancelSignal = this._initCanceller.signal;
@@ -156,7 +200,7 @@ export default DirectFileContentInitializer;
 /**
  * calculate initial time as a position in seconds.
  * @param {HTMLMediaElement} mediaElement
- * @param {Object|undefined} startAt
+ * @param {Object|undefined} [startAt]
  * @returns {number}
  */
 function getDirectFileInitialTime(mediaElement, startAt) {

package/dist/_esm5.processed/core/init/utils/initialize_content_decryption.js

@@ -34,8 +34,8 @@ export default function initializeContentDecryption(mediaElement, keySystems, pr
                 return;
             }
             stopListening();
-            log.error("Init: Encrypted event but EME feature not activated");
-            var err = new EncryptedMediaError("MEDIA_IS_ENCRYPTED_ERROR", "EME feature not activated.");
+            log.error("Init: Encrypted event but no `keySystems` given");
+            var err = new EncryptedMediaError("MEDIA_IS_ENCRYPTED_ERROR", "no `keySystems` given.");
             callbacks.onError(err);
         }, { clearSignal: cancelSignal });
         var ref = createSharedReference({

package/dist/_esm5.processed/core/stream/representation/utils/get_buffer_status.js

@@ -15,7 +15,7 @@
  */
 import config from "../../../../config";
 import isNullOrUndefined from "../../../../utils/is_null_or_undefined";
-import { SegmentBufferOperation, } from "../../../segment_buffers";
+import SegmentBuffersStore, { SegmentBufferOperation, } from "../../../segment_buffers";
 import checkForDiscontinuity from "./check_for_discontinuity";
 import getNeededSegments from "./get_needed_segments";
 import getSegmentPriority from "./get_segment_priority";
@@ -116,6 +116,7 @@ function getRangeOfNeededSegments(content, initialWantedTime, bufferGoal) {
     // avoid ending the last Period - and by extension the content - with a
     // segment which isn't the last one.
     if (!isNullOrUndefined(lastIndexPosition) &&
+        SegmentBuffersStore.isNative(content.adaptation.type) &&
         initialWantedTime >= lastIndexPosition &&
         representationIndex.isInitialized() &&
         representationIndex.isFinished() &&

package/dist/rx-player.js

@@ -9175,11 +9175,12 @@ var currentMediaState = new WeakMap();
 /* harmony import */ var _babel_runtime_helpers_inheritsLoose__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(4578);
 /* harmony import */ var _compat__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(5767);
 /* harmony import */ var _log__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(3887);
+/* harmony import */ var _utils_assert__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(811);
 /* harmony import */ var _utils_reference__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(5095);
 /* harmony import */ var _utils_task_canceller__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(288);
-/* harmony import */ var _types__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(379);
-/* harmony import */ var _utils_get_loaded_reference__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(1757);
-/* harmony import */ var _utils_initial_seek_and_play__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(8833);
+/* harmony import */ var _types__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(379);
+/* harmony import */ var _utils_get_loaded_reference__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(1757);
+/* harmony import */ var _utils_initial_seek_and_play__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(8833);
 /* harmony import */ var _utils_initialize_content_decryption__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(8799);
 /* harmony import */ var _utils_rebuffering_controller__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(6199);
 /* harmony import */ var _utils_throw_on_media_error__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(4576);
@@ -9213,8 +9214,23 @@ var currentMediaState = new WeakMap();
 
 
 
+
+/**
+ * `ContentIntializer` which will load contents by putting their URL in the
+ * `src` attribute of the given HTMLMediaElement.
+ *
+ * Because such contents are mainly loaded by the browser, those (called
+ * "directfile" contents in the RxPlayer) needs a simpler logic in-JS when
+ * compared to a content that relies on the MSE API.
+ *
+ * @class DirectFileContentInitializer
+ */
 var DirectFileContentInitializer = /*#__PURE__*/function (_ContentInitializer) {
   (0,_babel_runtime_helpers_inheritsLoose__WEBPACK_IMPORTED_MODULE_0__/* ["default"] */ .Z)(DirectFileContentInitializer, _ContentInitializer);
+  /**
+   * Creates a new `DirectFileContentInitializer` linked to the given settings.
+   * @param {Object} settings
+   */
   function DirectFileContentInitializer(settings) {
     var _this;
     _this = _ContentInitializer.call(this) || this;
@@ -9222,10 +9238,21 @@ var DirectFileContentInitializer = /*#__PURE__*/function (_ContentInitializer) {
     _this._initCanceller = new _utils_task_canceller__WEBPACK_IMPORTED_MODULE_1__/* ["default"] */ .ZP();
     return _this;
   }
+  /**
+   * "Prepare" content so it can later be played by calling `start`.
+   */
   var _proto = DirectFileContentInitializer.prototype;
   _proto.prepare = function prepare() {
     return; // Directfile contents do not have any preparation
-  };
+  }
+  /**
+   * Start playback of the content linked to this `DirectFileContentInitializer`
+   * on the given `HTMLMediaElement` and its associated `PlaybackObserver`.
+   * @param {HTMLMediaElement} mediaElement - HTMLMediaElement on which the
+   * content will be played.
+   * @param {Object} playbackObserver - Object regularly emitting playback
+   * information.
+   */;
   _proto.start = function start(mediaElement, playbackObserver) {
     var _this2 = this;
     var cancelSignal = this._initCanceller.signal;
@@ -9234,9 +9261,10 @@ var DirectFileContentInitializer = /*#__PURE__*/function (_ContentInitializer) {
       speed = _this$_settings.speed,
       url = _this$_settings.url;
     (0,_compat__WEBPACK_IMPORTED_MODULE_2__/* ["default"] */ .Z)(mediaElement);
-    if (url == null) {
-      throw new Error("No URL for a DirectFile content");
-    }
+    /**
+     * Create dummy encryption data emitter, as those are not sent from the
+     * RxPlayer for directfile contents.
+     */
     var decryptionRef = (0,_utils_reference__WEBPACK_IMPORTED_MODULE_3__/* ["default"] */ .ZP)(null);
     decryptionRef.finish();
     var drmInitRef = (0,_utils_initialize_content_decryption__WEBPACK_IMPORTED_MODULE_4__/* ["default"] */ .Z)(mediaElement, keySystems, decryptionRef, {
@@ -9271,8 +9299,9 @@ var DirectFileContentInitializer = /*#__PURE__*/function (_ContentInitializer) {
     rebufferingController.start();
     drmInitRef.onUpdate(function (evt, stopListeningToDrmUpdates) {
       if (evt.initializationState.type === "uninitialized") {
-        return;
+        return; // nothing done yet
       }
+
       stopListeningToDrmUpdates();
       // Start everything! (Just put the URL in the element's src).
       _log__WEBPACK_IMPORTED_MODULE_7__/* ["default"] */ .Z.info("Setting URL to HTMLMediaElement", url);
@@ -9286,31 +9315,48 @@ var DirectFileContentInitializer = /*#__PURE__*/function (_ContentInitializer) {
           if (newDrmStatus.initializationState.type === "initialized") {
             stopListeningToDrmUpdatesAgain();
             _this2._seekAndPlay(mediaElement, playbackObserver);
-            return;
           }
         }, {
           emitCurrentValue: true,
           clearSignal: cancelSignal
         });
       } else {
+        (0,_utils_assert__WEBPACK_IMPORTED_MODULE_8__/* ["default"] */ .Z)(evt.initializationState.type === "initialized");
         _this2._seekAndPlay(mediaElement, playbackObserver);
-        return;
       }
     }, {
       emitCurrentValue: true,
       clearSignal: cancelSignal
     });
-  };
+  }
+  /**
+   * Update URL this `ContentIntializer` depends on.
+   * @param {Array.<string>|undefined} _urls
+   * @param {boolean} _refreshNow
+   */;
   _proto.updateContentUrls = function updateContentUrls(_urls, _refreshNow) {
     throw new Error("Cannot update content URL of directfile contents");
-  };
+  }
+  /**
+   * Stop content and free all resources linked to this `ContentIntializer`.
+   */;
   _proto.dispose = function dispose() {
     this._initCanceller.cancel();
-  };
+  }
+  /**
+   * Logic performed when a fatal error was triggered.
+   * @param {*} err - The fatal error in question.
+   */;
   _proto._onFatalError = function _onFatalError(err) {
     this._initCanceller.cancel();
     this.trigger("error", err);
-  };
+  }
+  /**
+   * Perform the initial seek (to begin playback at an initially-calculated
+   * position based on settings) and auto-play if needed when loaded.
+   * @param {HTMLMediaElement} mediaElement
+   * @param {Object} playbackObserver
+   */;
   _proto._seekAndPlay = function _seekAndPlay(mediaElement, playbackObserver) {
     var _this3 = this;
     var cancelSignal = this._initCanceller.signal;
@@ -9323,10 +9369,10 @@ var DirectFileContentInitializer = /*#__PURE__*/function (_ContentInitializer) {
       _log__WEBPACK_IMPORTED_MODULE_7__/* ["default"] */ .Z.debug("Init: Initial time calculated:", initTime);
       return initTime;
     };
-    (0,_utils_initial_seek_and_play__WEBPACK_IMPORTED_MODULE_8__/* ["default"] */ .Z)(mediaElement, playbackObserver, initialTime, autoPlay, function (err) {
+    (0,_utils_initial_seek_and_play__WEBPACK_IMPORTED_MODULE_9__/* ["default"] */ .Z)(mediaElement, playbackObserver, initialTime, autoPlay, function (err) {
       return _this3.trigger("warning", err);
     }, cancelSignal).autoPlayResult.then(function () {
-      return (0,_utils_get_loaded_reference__WEBPACK_IMPORTED_MODULE_9__/* ["default"] */ .Z)(playbackObserver, mediaElement, true, cancelSignal).onUpdate(function (isLoaded, stopListening) {
+      return (0,_utils_get_loaded_reference__WEBPACK_IMPORTED_MODULE_10__/* ["default"] */ .Z)(playbackObserver, mediaElement, true, cancelSignal).onUpdate(function (isLoaded, stopListening) {
         if (isLoaded) {
           stopListening();
           _this3.trigger("loaded", {
@@ -9344,11 +9390,11 @@ var DirectFileContentInitializer = /*#__PURE__*/function (_ContentInitializer) {
     });
   };
   return DirectFileContentInitializer;
-}(_types__WEBPACK_IMPORTED_MODULE_10__/* .ContentInitializer */ .K);
+}(_types__WEBPACK_IMPORTED_MODULE_11__/* .ContentInitializer */ .K);
 /**
  * calculate initial time as a position in seconds.
  * @param {HTMLMediaElement} mediaElement
- * @param {Object|undefined} startAt
+ * @param {Object|undefined} [startAt]
  * @returns {number}
  */
 
@@ -9773,8 +9819,8 @@ function initializeContentDecryption(mediaElement, keySystems, protectionRef, ca
         return;
       }
       stopListening();
-      log/* default */.Z.error("Init: Encrypted event but EME feature not activated");
-      var err = new encrypted_media_error/* default */.Z("MEDIA_IS_ENCRYPTED_ERROR", "EME feature not activated.");
+      log/* default */.Z.error("Init: Encrypted event but no `keySystems` given");
+      var err = new encrypted_media_error/* default */.Z("MEDIA_IS_ENCRYPTED_ERROR", "no `keySystems` given.");
       callbacks.onError(err);
     }, {
       clearSignal: cancelSignal
@@ -45041,7 +45087,7 @@ function getRangeOfNeededSegments(content, initialWantedTime, bufferGoal) {
   // In that case, we want to actually request at least the last segment to
   // avoid ending the last Period - and by extension the content - with a
   // segment which isn't the last one.
-  if (!(0,is_null_or_undefined/* default */.Z)(lastIndexPosition) && initialWantedTime >= lastIndexPosition && representationIndex.isInitialized() && representationIndex.isFinished() && isPeriodTheCurrentAndLastOne(manifest, period, initialWantedTime)) {
+  if (!(0,is_null_or_undefined/* default */.Z)(lastIndexPosition) && segment_buffers.isNative(content.adaptation.type) && initialWantedTime >= lastIndexPosition && representationIndex.isInitialized() && representationIndex.isFinished() && isPeriodTheCurrentAndLastOne(manifest, period, initialWantedTime)) {
     wantedStartPosition = lastIndexPosition - 1;
   } else {
     wantedStartPosition = initialWantedTime - 0.1;
@@ -52155,7 +52201,7 @@ var Player = /*#__PURE__*/function (_EventEmitter) {
     // Workaround to support Firefox autoplay on FF 42.
     // See: https://bugzilla.mozilla.org/show_bug.cgi?id=1194624
     videoElement.preload = "auto";
-    _this.version = /* PLAYER_VERSION */"3.31.0";
+    _this.version = /* PLAYER_VERSION */"3.31.1-dev.2023062700";
     _this.log = log/* default */.Z;
     _this.state = "STOPPED";
     _this.videoElement = videoElement;
@@ -52512,6 +52558,8 @@ var Player = /*#__PURE__*/function (_EventEmitter) {
         this.stop();
         this._priv_currentError = null;
         throw new Error("DirectFile feature not activated in your build.");
+      } else if ((0,is_null_or_undefined/* default */.Z)(url)) {
+        throw new Error("No URL for a DirectFile content");
       }
       mediaElementTrackChoiceManager = this._priv_initializeMediaElementTrackChoiceManager(defaultAudioTrack, defaultTextTrack, currentContentCanceller.signal);
       if (currentContentCanceller.isUsed()) {
@@ -54564,7 +54612,7 @@ var Player = /*#__PURE__*/function (_EventEmitter) {
   }]);
   return Player;
 }(event_emitter/* default */.Z);
-Player.version = /* PLAYER_VERSION */"3.31.0";
+Player.version = /* PLAYER_VERSION */"3.31.1-dev.2023062700";
 /* harmony default export */ var public_api = (Player);
 ;// CONCATENATED MODULE: ./src/core/api/index.ts
 /**