rx-player 3.31.0-dev.2023052200 → 3.31.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rx-player",
   "author": "Canal+",
-  "version": "3.31.0-dev.2023052200",
+  "version": "3.31.0",
   "description": "Canal+ HTML5 Video Player",
   "main": "./dist/rx-player.js",
   "keywords": [
@@ -80,39 +80,39 @@
     "next-tick": "1.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.21.4",
-    "@babel/plugin-transform-runtime": "7.21.4",
-    "@babel/preset-env": "7.21.4",
-    "@babel/preset-react": "7.18.6",
-    "@types/chai": "4.3.4",
-    "@types/jest": "29.5.0",
+    "@babel/core": "7.22.5",
+    "@babel/plugin-transform-runtime": "7.22.5",
+    "@babel/preset-env": "7.22.5",
+    "@babel/preset-react": "7.22.5",
+    "@types/chai": "4.3.5",
+    "@types/jest": "29.5.2",
     "@types/mocha": "10.0.1",
-    "@types/node": "18.15.11",
-    "@types/react": "18.0.33",
-    "@types/react-dom": "18.0.11",
-    "@types/sinon": "10.0.13",
-    "@typescript-eslint/eslint-plugin": "5.57.1",
-    "@typescript-eslint/eslint-plugin-tslint": "5.57.1",
-    "@typescript-eslint/parser": "5.57.1",
+    "@types/node": "20.3.1",
+    "@types/react": "18.2.12",
+    "@types/react-dom": "18.2.5",
+    "@types/sinon": "10.0.15",
+    "@typescript-eslint/eslint-plugin": "5.59.11",
+    "@typescript-eslint/eslint-plugin-tslint": "5.59.11",
+    "@typescript-eslint/parser": "5.59.11",
     "arraybuffer-loader": "1.0.8",
     "babel-loader": "9.1.2",
     "chai": "4.3.7",
-    "core-js": "3.30.0",
-    "docgen.ico": "^0.2.2",
-    "esbuild": "0.17.15",
-    "eslint": "8.37.0",
+    "core-js": "3.31.0",
+    "docgen.ico": "^0.2.3",
+    "esbuild": "0.18.2",
+    "eslint": "8.42.0",
     "eslint-plugin-ban": "1.6.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-jsdoc": "40.1.1",
+    "eslint-plugin-jsdoc": "46.2.6",
     "eslint-plugin-react": "7.32.2",
     "esm": "3.2.25",
     "express": "4.18.2",
     "github-buttons": "2.27.0",
-    "html-entities": "2.3.3",
+    "html-entities": "2.3.6",
     "jest": "29.5.0",
     "jest-environment-jsdom": "29.5.0",
-    "karma": "6.4.1",
-    "karma-chrome-launcher": "3.1.1",
+    "karma": "6.4.2",
+    "karma-chrome-launcher": "3.2.0",
     "karma-firefox-launcher": "2.1.2",
     "karma-mocha": "2.0.1",
     "karma-webpack": "5.0.0",
@@ -122,17 +122,17 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "regenerator-runtime": "0.13.11",
-    "rimraf": "4.4.1",
-    "semver": "7.3.8",
-    "sinon": "15.0.3",
-    "terser-webpack-plugin": "5.3.7",
+    "rimraf": "5.0.1",
+    "semver": "7.5.1",
+    "sinon": "15.1.2",
+    "terser-webpack-plugin": "5.3.9",
     "ts-jest": "29.1.0",
-    "ts-loader": "9.4.2",
+    "ts-loader": "9.4.3",
     "tslint": "6.1.3",
-    "typescript": "5.0.3",
-    "webpack": "5.77.0",
-    "webpack-bundle-analyzer": "4.8.0",
-    "webpack-cli": "5.0.1"
+    "typescript": "5.1.3",
+    "webpack": "5.86.0",
+    "webpack-bundle-analyzer": "4.9.0",
+    "webpack-cli": "5.1.4"
   },
   "scripts-list": {
     "Build a demo page (e.g. to test a code change)": {

package/scripts/build/generate_build.js

@@ -22,7 +22,7 @@ const { spawn } = require("child_process");
 const fs = require("fs/promises");
 const os = require("os");
 const path = require("path");
-const rimraf = require("rimraf");
+const { rimraf } = require("rimraf");
 
 const BUILD_DIR_FROM_ROOT = "dist/_esm5.processed";
 

package/scripts/fast_demo_build.js

@@ -66,8 +66,8 @@ function fastDemoBuild(options) {
           const { errors, warnings } = result;
           console.log(`\x1b[33m[${getHumanReadableHours()}]\x1b[0m ` +
             `Demo re-built with ${errors.length} error(s) and ` +
-            ` ${warnings.length} warning(s) ` +
-            `(in ${stats.endTime - stats.startTime} ms).`);
+            ` ${warnings.length} warning(s) `);
+          return;
         }
         console.log(`\x1b[32m[${getHumanReadableHours()}]\x1b[0m ` +
           "Demo built!");
@@ -79,6 +79,7 @@ function fastDemoBuild(options) {
   esbuild.context({
     entryPoints: [path.join(__dirname, "../demo/full/scripts/index.tsx")],
     bundle: true,
+    target: "es2017",
     minify,
     outfile: path.join(__dirname, "../demo/full/bundle.js"),
     plugins: [consolePlugin],

package/sonar-project.properties

@@ -1,7 +1,7 @@
 sonar.projectKey=rx-player
 sonar.organization=rx-player
 sonar.projectName=rx-player
-sonar.projectVersion=3.31.0-dev.2023052200
+sonar.projectVersion=3.31.0
 sonar.sources=./src,./demo,./tests
 sonar.exclusions=demo/full/bundle.js,demo/standalone/lib.js,demo/bundle.js
 sonar.host.url=https://sonarcloud.io

package/src/core/api/public_api.ts

@@ -69,6 +69,7 @@ import {
   IVideoTrackPreference,
 } from "../../public_types";
 import areArraysOfNumbersEqual from "../../utils/are_arrays_of_numbers_equal";
+import arrayIncludes from "../../utils/array_includes";
 import assert from "../../utils/assert";
 import EventEmitter, {
   IEventPayload,
@@ -121,9 +122,9 @@ import MediaElementTrackChoiceManager from "./tracks_management/media_element_tr
 import TrackChoiceManager from "./tracks_management/track_choice_manager";
 import {
   constructPlayerStateReference,
+  emitPlayPauseEvents,
   emitSeekEvents,
   isLoadedState,
-  // emitSeekEvents,
   PLAYER_STATES,
 } from "./utils";
 
@@ -307,6 +308,11 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     reloadPosition?: number;
   };
 
+  /**
+   * Store last value of autoPlay, from the last load or reload.
+   */
+  private _priv_lastAutoPlay: boolean;
+
   /** All possible Error types emitted by the RxPlayer. */
   static get ErrorTypes() : Record<IErrorType, IErrorType> {
     return ErrorTypes;
@@ -364,7 +370,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     // See: https://bugzilla.mozilla.org/show_bug.cgi?id=1194624
     videoElement.preload = "auto";
 
-    this.version = /* PLAYER_VERSION */"3.31.0-dev.2023052200";
+    this.version = /* PLAYER_VERSION */"3.31.0";
     this.log = log;
     this.state = "STOPPED";
     this.videoElement = videoElement;
@@ -481,6 +487,8 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     this._priv_preferredVideoTracks = preferredVideoTracks;
 
     this._priv_reloadingMetadata = {};
+
+    this._priv_lastAutoPlay = false;
   }
 
   /**
@@ -551,6 +559,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     log.info("API: Calling loadvideo", options.url, options.transport);
     this._priv_reloadingMetadata = { options };
     this._priv_initializeContentPlayback(options);
+    this._priv_lastAutoPlay = options.autoPlay;
   }
 
   /**
@@ -839,11 +848,12 @@ class Player extends EventEmitter<IPublicAPIEvent> {
       log.warn("API: Sending warning:", formattedError);
       this.trigger("warning", formattedError);
     });
-    initializer.addEventListener("reloadingMediaSource", () => {
+    initializer.addEventListener("reloadingMediaSource", (payload) => {
       contentInfos.segmentBuffersStore = null;
       if (contentInfos.trackChoiceManager !== null) {
         contentInfos.trackChoiceManager.resetPeriods();
       }
+      this._priv_lastAutoPlay = payload.autoPlay;
     });
     initializer.addEventListener("inbandEvents", (inbandEvents) =>
       this.trigger("inbandEvents", inbandEvents));
@@ -946,6 +956,53 @@ class Player extends EventEmitter<IPublicAPIEvent> {
       }
     };
 
+    /**
+     * `TaskCanceller` allowing to stop emitting `"play"` and `"pause"`
+     * events.
+     * `null` when such events are not emitted currently.
+     */
+    let playPauseEventsCanceller : TaskCanceller | null = null;
+
+    /**
+     * Callback emitting `"play"` and `"pause`" events once the content is
+     * loaded, starting from the state indicated in argument.
+     * @param {boolean} willAutoPlay - If `false`, we're currently paused.
+     */
+    const triggerPlayPauseEventsWhenReady = (willAutoPlay: boolean) => {
+      if (playPauseEventsCanceller !== null) {
+        playPauseEventsCanceller.cancel(); // cancel previous logic
+        playPauseEventsCanceller = null;
+      }
+      playerStateRef.onUpdate((val, stopListeningToStateUpdates) => {
+        if (!isLoadedState(val)) {
+          return; // content not loaded yet: no event
+        }
+        stopListeningToStateUpdates();
+        if (playPauseEventsCanceller !== null) {
+          playPauseEventsCanceller.cancel();
+        }
+        playPauseEventsCanceller = new TaskCanceller();
+        playPauseEventsCanceller.linkToSignal(currentContentCanceller.signal);
+        if (willAutoPlay !== !videoElement.paused) {
+          // paused status is not at the expected value on load: emit event
+          if (videoElement.paused) {
+            this.trigger("pause", null);
+          } else {
+            this.trigger("play", null);
+          }
+        }
+        emitPlayPauseEvents(videoElement,
+                            () => this.trigger("play", null),
+                            () => this.trigger("pause", null),
+                            currentContentCanceller.signal);
+      }, { emitCurrentValue: false, clearSignal: currentContentCanceller.signal });
+    };
+
+    triggerPlayPauseEventsWhenReady(autoPlay);
+    initializer.addEventListener("reloadingMediaSource", (payload) => {
+      triggerPlayPauseEventsWhenReady(payload.autoPlay);
+    });
+
     /**
      * `TaskCanceller` allowing to stop emitting `"seeking"` and `"seeked"`
      * events.
@@ -1109,6 +1166,42 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     return this.state;
   }
 
+  /**
+   * Returns true if a content is loaded.
+   * @returns {Boolean} - `true` if a content is loaded, `false` otherwise.
+   */
+  isContentLoaded() : boolean {
+    return !arrayIncludes(["LOADING", "RELOADING", "STOPPED"], this.state);
+  }
+
+  /**
+   * Returns true if the player is buffering.
+   * @returns {Boolean} - `true` if the player is buffering, `false` otherwise.
+   */
+  isBuffering() : boolean {
+    return arrayIncludes(["BUFFERING", "SEEKING", "LOADING", "RELOADING"], this.state);
+  }
+
+  /**
+   * Returns the play/pause status of the player :
+   *   - when `LOADING` or `RELOADING`, returns the scheduled play/pause condition
+   *     for when loading is over,
+   *   - in other states, returns the `<video>` element .paused value,
+   *   - if the player is disposed, returns `true`.
+   * @returns {Boolean} - `true` if the player is paused or will be after loading,
+   * `false` otherwise.
+   */
+  isPaused() : boolean {
+    if (this.videoElement) {
+      if (arrayIncludes(["LOADING", "RELOADING"], this.state)) {
+        return !this._priv_lastAutoPlay;
+      } else {
+        return this.videoElement.paused;
+      }
+    }
+    return true;
+  }
+
   /**
    * Returns true if both:
    *   - a content is loaded
@@ -1288,6 +1381,15 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     return this.videoElement.currentTime;
   }
 
+  /**
+   * Returns the last stored content position, in seconds.
+   *
+   * @returns {number|undefined}
+   */
+  getLastStoredContentPosition() : number|undefined {
+    return this._priv_reloadingMetadata.reloadPosition;
+  }
+
   /**
    * Returns the current playback rate at which the video plays.
    * @returns {Number}
@@ -2986,7 +3088,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     return mediaElementTrackChoiceManager;
   }
 }
-Player.version = /* PLAYER_VERSION */"3.31.0-dev.2023052200";
+Player.version = /* PLAYER_VERSION */"3.31.0";
 
 /** Every events sent by the RxPlayer's public API. */
 interface IPublicAPIEvent {
@@ -3011,6 +3113,8 @@ interface IPublicAPIEvent {
   availableTextTracksChange : IAvailableTextTrack[];
   availableVideoTracksChange : IAvailableVideoTrack[];
   decipherabilityUpdate : IDecipherabilityUpdateContent[];
+  play: null;
+  pause: null;
   seeking : null;
   seeked : null;
   streamEvent : IStreamEvent;

package/src/core/api/utils.ts

@@ -70,6 +70,32 @@ export function emitSeekEvents(
   }, { includeLastObservation: true, clearSignal: cancelSignal });
 }
 
+/**
+ * @param {HTMLMediaElement} mediaElement
+ * @param {function} onPlay - Callback called when a play operation has started
+ * on `mediaElement`.
+ * @param {function} onPause - Callback called when a pause operation has
+ * started on `mediaElement`.
+ * @param {Object} cancelSignal - When triggered, stop calling callbacks and
+ * remove all listeners this function has registered.
+ */
+export function emitPlayPauseEvents(
+  mediaElement : HTMLMediaElement | null,
+  onPlay: () => void,
+  onPause: () => void,
+  cancelSignal : CancellationSignal
+) : void {
+  if (cancelSignal.isCancelled() || mediaElement === null) {
+    return ;
+  }
+  mediaElement.addEventListener("play", onPlay);
+  mediaElement.addEventListener("pause", onPause);
+  cancelSignal.register(() => {
+    mediaElement.removeEventListener("play", onPlay);
+    mediaElement.removeEventListener("pause", onPause);
+  });
+}
+
 /** Player state dictionnary. */
 export const enum PLAYER_STATES {
   STOPPED = "STOPPED",

package/src/core/decrypt/session_events_listener.ts

@@ -111,7 +111,12 @@ export default function SessionEventsListener(
         if (isNullOrUndefined(licenseObject)) {
           log.info("DRM: No license given, skipping session.update");
         } else {
-          return updateSessionWithMessage(session, licenseObject);
+          try {
+            return updateSessionWithMessage(session, licenseObject);
+          } catch (err) {
+            manualCanceller.cancel();
+            callbacks.onError(err);
+          }
         }
       })
       .catch((err : unknown) => {

package/src/core/init/media_source_content_initializer.ts

@@ -356,7 +356,7 @@ export default class MediaSourceContentInitializer extends ContentInitializer {
         if (initCanceller.isUsed()) {
           return;
         }
-        triggerEvent("reloadingMediaSource", null);
+        triggerEvent("reloadingMediaSource", reloadOrder);
         if (initCanceller.isUsed()) {
           return;
         }

package/src/core/init/types.ts

@@ -117,7 +117,15 @@ export interface IContentInitializerEvents {
    * Event sent when we're starting attach a new MediaSource to the media element
    * (after removing the previous one).
    */
-  reloadingMediaSource: null;
+  reloadingMediaSource: {
+    /** The position we're reloading at, in seconds. */
+    position: number;
+    /**
+     * If `true`, we'll play directly after finishing the reloading operation.
+     * If `false`, we'll be paused after it.
+     */
+    autoPlay: boolean;
+  };
   /** Event sent after the player stalled. */
   stalled : IStallingSituation;
   /** Event sent when the player goes out of a stalling situation. */