rx-player 4.2.0-dev.2024091600 → 4.2.0-dev.2024100200

package/src/compat/patch_webkit_source_buffer.ts

@@ -85,10 +85,8 @@ export default function patchWebkitSourceBuffer(): void {
       val: unknown,
     ) {
       queueMicrotask(() => {
-        // @ts-expect-error: trigger is normally protected
         this.trigger(eventName, val as Event);
         this.updating = false;
-        // @ts-expect-error: trigger is normally protected
         this.trigger("updateend", new Event("updateend"));
       });
     };
@@ -97,7 +95,6 @@ export default function patchWebkitSourceBuffer(): void {
       if (this.updating) {
         throw new Error("updating");
       }
-      // @ts-expect-error: trigger is normally protected
       this.trigger("updatestart", new Event("updatestart"));
       this.updating = true;
       try {

package/src/config.ts

@@ -9,13 +9,21 @@
 import type { IDefaultConfig } from "./default_config";
 import DEFAULT_CONFIG from "./default_config";
 import deepMerge from "./utils/deep_merge";
+import EventEmitter from "./utils/event_emitter";
 
-class ConfigHandler {
-  _config = DEFAULT_CONFIG;
+interface IConfigHandlerEvents {
+  update: Partial<IDefaultConfig>;
+}
+
+class ConfigHandler extends EventEmitter<IConfigHandlerEvents> {
+  public updated = false;
+  private _config = DEFAULT_CONFIG;
 
   update(config: Partial<IDefaultConfig>) {
     const newConfig = deepMerge(this._config, config);
     this._config = newConfig;
+    this.updated = true;
+    this.trigger("update", config);
   }
 
   getCurrent(): IDefaultConfig {

package/src/core/main/worker/worker_main.ts

@@ -80,6 +80,9 @@ export default function initializeWorkerMain() {
    */
   let playbackObservationRef: SharedReference<IWorkerPlaybackObservation> | null = null;
 
+  onmessageerror = (_msg: MessageEvent) => {
+    log.error("MTCI: Error when receiving message from main thread.");
+  };
   onmessage = function (e: MessageEvent<IMainThreadMessage>) {
     log.debug("Worker: received message", e.data.type);
 
@@ -401,6 +404,11 @@ export default function initializeWorkerMain() {
         break;
       }
 
+      case MainThreadMessageType.ConfigUpdate: {
+        config.update(msg.value);
+        break;
+      }
+
       default:
         assertUnreachable(msg);
     }

package/src/core/stream/adaptation/adaptation_stream.ts

@@ -376,15 +376,21 @@ export default function AdaptationStream(
     representationStreamCallbacks: IRepresentationStreamCallbacks,
     fnCancelSignal: CancellationSignal,
   ): void {
+    /** Set to `true` if we've encountered an error with this `RepresentationStream` */
+    let hasEncounteredError = false;
+
     const bufferGoalCanceller = new TaskCanceller();
     bufferGoalCanceller.linkToSignal(fnCancelSignal);
+
+    /** Actually built buffer size, in seconds. */
     const bufferGoal = createMappedReference(
       wantedBufferAhead,
       (prev) => {
-        return prev * getBufferGoalRatio(representation);
+        return getBufferGoal(representation, prev);
       },
       bufferGoalCanceller.signal,
     );
+
     const maxBufferSize =
       adaptation.type === "video" ? maxVideoBufferSize : new SharedReference(Infinity);
     log.info(
@@ -394,7 +400,18 @@ export default function AdaptationStream(
       representation.bitrate,
     );
     const updatedCallbacks = objectAssign({}, representationStreamCallbacks, {
-      error(err: unknown) {
+      error(err: Error) {
+        if (hasEncounteredError) {
+          // A RepresentationStream might trigger multiple Errors (for example
+          // multiple segments it tried to push at once led to errors).
+          // In that case, we'll only consider the first Error.
+          //
+          // That could mean that we're hiding legitimate issues but handling
+          // multiple of those errors at once is too hard a task for now.
+          log.warn("Stream: Ignoring RepresentationStream error", err);
+          return;
+        }
+        hasEncounteredError = true;
         const formattedError = formatError(err, {
           defaultCode: "NONE",
           defaultReason: "Unknown `RepresentationStream` error",
@@ -402,14 +419,20 @@ export default function AdaptationStream(
         if (formattedError.code !== "BUFFER_FULL_ERROR") {
           representationStreamCallbacks.error(err);
         } else {
+          log.warn(
+            "Stream: received BUFFER_FULL_ERROR",
+            adaptation.type,
+            representation.bitrate,
+          );
           const wba = wantedBufferAhead.getValue();
           const lastBufferGoalRatio = bufferGoalRatioMap.get(representation.id) ?? 1;
           // 70%, 49%, 34.3%, 24%, 16.81%, 11.76%, 8.24% and 5.76%
           const newBufferGoalRatio = lastBufferGoalRatio * 0.7;
-          if (newBufferGoalRatio <= 0.05 || wba * newBufferGoalRatio <= 2) {
-            throw formattedError;
-          }
           bufferGoalRatioMap.set(representation.id, newBufferGoalRatio);
+          if (newBufferGoalRatio <= 0.05 || getBufferGoal(representation, wba) <= 2) {
+            representationStreamCallbacks.error(formattedError);
+            return;
+          }
 
           // We wait 4 seconds to let the situation evolve by itself before
           // retrying loading segments with a lower buffer goal
@@ -481,15 +504,25 @@ export default function AdaptationStream(
   }
 
   /**
-   * @param {Object} representation
+   * Returns how much media data should be pre-buffered for this
+   * `Representation`, according to the `wantedBufferAhead` setting and previous
+   * issues encountered with that `Representation`.
+   * @param {Object} representation - The `Representation` you want to buffer.
+   * @param {number} wba - The value of `wantedBufferAhead` set by the user.
    * @returns {number}
    */
-  function getBufferGoalRatio(representation: IRepresentation): number {
+  function getBufferGoal(representation: IRepresentation, wba: number): number {
     const oldBufferGoalRatio = bufferGoalRatioMap.get(representation.id);
     const bufferGoalRatio = oldBufferGoalRatio !== undefined ? oldBufferGoalRatio : 1;
     if (oldBufferGoalRatio === undefined) {
       bufferGoalRatioMap.set(representation.id, bufferGoalRatio);
     }
-    return bufferGoalRatio;
+    if (bufferGoalRatio < 1 && wba === Infinity) {
+      // When `wba` is equal to `Infinity`, dividing it will still make it equal
+      // to `Infinity`. To make the `bufferGoalRatio` still have an effect, we
+      // just starts from a `wba` set to the high value of 5 minutes.
+      return 5 * 60 * 1000 * bufferGoalRatio;
+    }
+    return wba * bufferGoalRatio;
   }
 }

package/src/core/stream/adaptation/index.ts

@@ -15,6 +15,6 @@
  */
 
 import AdaptationStream from "./adaptation_stream";
-export * from "./types";
+export type * from "./types";
 
 export default AdaptationStream;

package/src/core/stream/period/index.ts

@@ -15,6 +15,6 @@
  */
 
 import PeriodStream from "./period_stream";
-export * from "./types";
+export type * from "./types";
 
 export default PeriodStream;

package/src/core/stream/representation/index.ts

@@ -15,6 +15,6 @@
  */
 
 import RepresentationStream from "./representation_stream";
-export * from "./types";
+export type * from "./types";
 
 export default RepresentationStream;

package/src/core/stream/representation/representation_stream.ts

@@ -90,6 +90,11 @@ export default function RepresentationStream<TSegmentDataType>(
   callbacks: IRepresentationStreamCallbacks,
   parentCancelSignal: CancellationSignal,
 ): void {
+  log.debug(
+    "Stream: Creating RepresentationStream",
+    content.adaptation.type,
+    content.representation.bitrate,
+  );
   const { period, adaptation, representation } = content;
   const { bufferGoal, maxBufferSize, drmSystemId, fastSwitchThreshold } = options;
   const bufferType = adaptation.type;
@@ -488,6 +493,12 @@ export default function RepresentationStream<TSegmentDataType>(
       // We can thus ignore it, it is very unlikely to lead to true buffer issues.
       return;
     }
+    log.warn(
+      "Stream: Received fatal buffer error",
+      adaptation.type,
+      representation.bitrate,
+      err instanceof Error ? err : null,
+    );
     globalCanceller.cancel();
     callbacks.error(err);
   }

package/src/core/stream/representation/utils/append_segment_to_buffer.ts

@@ -72,8 +72,12 @@ export default async function appendSegmentToBuffer<T>(
       log.warn("Stream: Running garbage collector");
       const start = Math.max(currentPos - 5, 0);
       const end = currentPos + bufferGoal.getValue() + 12;
-      await segmentSink.removeBuffer(0, start);
-      await segmentSink.removeBuffer(end, Number.MAX_VALUE);
+      if (start > 0) {
+        await segmentSink.removeBuffer(0, start);
+      }
+      if (end < Number.MAX_VALUE) {
+        await segmentSink.removeBuffer(end, Number.MAX_VALUE);
+      }
       await sleep(200);
       if (cancellationSignal.cancellationError !== null) {
         throw cancellationSignal.cancellationError;

package/src/default_config.ts

@@ -1187,3 +1187,24 @@ const DEFAULT_CONFIG = {
 
 export type IDefaultConfig = typeof DEFAULT_CONFIG;
 export default DEFAULT_CONFIG;
+
+// NOTE Because the config may have to be serialized and shared between several
+// environments, we check here that some strict type is respected:
+//   - only a subset of types are authorized for now, just make it easier to
+//     reason about.
+//   - Needs to make sense in JSON: no `function`, no `Date`, no `undefined`...
+interface IGenericConfigData {
+  [key: string]:
+    | string
+    | number
+    | boolean
+    | number[]
+    | string[]
+    | Partial<Record<string, string[]>>
+    | IGenericConfigData;
+}
+
+function checkIsSerializable(_conf: IGenericConfigData): void {
+  // noop
+}
+checkIsSerializable(DEFAULT_CONFIG);

package/src/main_thread/api/public_api.ts

@@ -32,6 +32,7 @@ import getStartDate from "../../compat/get_start_date";
 import hasMseInWorker from "../../compat/has_mse_in_worker";
 import hasWorkerApi from "../../compat/has_worker_api";
 import isDebugModeEnabled from "../../compat/is_debug_mode_enabled";
+import config from "../../config";
 import type { ISegmentSinkMetrics } from "../../core/segment_sinks/segment_buffers_store";
 import type {
   IAdaptationChoice,
@@ -39,6 +40,7 @@ import type {
   IABRThrottlers,
   IBufferType,
 } from "../../core/types";
+import type { IDefaultConfig } from "../../default_config";
 import type { IErrorCode, IErrorType } from "../../errors";
 import { ErrorCodes, ErrorTypes, formatError, MediaError } from "../../errors";
 import WorkerInitializationError from "../../errors/worker_initialization_error";
@@ -409,7 +411,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     // See: https://bugzilla.mozilla.org/show_bug.cgi?id=1194624
     videoElement.preload = "auto";
 
-    this.version = /* PLAYER_VERSION */ "4.2.0-dev.2024091600";
+    this.version = /* PLAYER_VERSION */ "4.2.0-dev.2024100200";
     this.log = log;
     this.state = "STOPPED";
     this.videoElement = videoElement;
@@ -573,6 +575,21 @@ class Player extends EventEmitter<IPublicAPIEvent> {
         },
         this._destroyCanceller.signal,
       );
+
+      const sendConfigUpdates = (updates: Partial<IDefaultConfig>) => {
+        if (this._priv_worker === null) {
+          return;
+        }
+        log.debug("---> Sending To Worker:", MainThreadMessageType.ConfigUpdate);
+        this._priv_worker.postMessage({
+          type: MainThreadMessageType.ConfigUpdate,
+          value: updates,
+        });
+      };
+      if (config.updated) {
+        sendConfigUpdates(config.getCurrent());
+      }
+      config.addEventListener("update", sendConfigUpdates, this._destroyCanceller.signal);
     });
   }
 
@@ -3313,7 +3330,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     }
   }
 }
-Player.version = /* PLAYER_VERSION */ "4.2.0-dev.2024091600";
+Player.version = /* PLAYER_VERSION */ "4.2.0-dev.2024100200";
 
 /** Every events sent by the RxPlayer's public API. */
 interface IPublicAPIEvent {

package/src/main_thread/decrypt/content_decryptor.ts

@@ -208,6 +208,7 @@ export default class ContentDecryptor extends EventEmitter<IContentDecryptorEven
 
         this.systemId = systemId;
         if (this._stateData.state === ContentDecryptorState.Initializing) {
+          log.debug("DRM: Waiting for attachment.");
           this._stateData = {
             state: ContentDecryptorState.WaitingForAttachment,
             isInitDataQueueLocked: true,
@@ -260,6 +261,7 @@ export default class ContentDecryptor extends EventEmitter<IContentDecryptorEven
     const shouldDisableLock = options.disableMediaKeysAttachmentLock === true;
 
     if (shouldDisableLock) {
+      log.debug("DRM: disabling MediaKeys attachment lock. Ready for content");
       this._stateData = {
         state: ContentDecryptorState.ReadyForContent,
         isInitDataQueueLocked: true,

package/src/main_thread/decrypt/get_media_keys.ts

@@ -102,6 +102,7 @@ export default async function getMediaKeysInfos(
     currentState !== null &&
     evt.type === "reuse-media-key-system-access"
   ) {
+    log.debug("DRM: Reusing already created MediaKeys");
     const { mediaKeys, loadedSessionsStore } = currentState;
 
     // We might just rely on the currently attached MediaKeys instance.

package/src/main_thread/init/directfile_content_initializer.ts

@@ -254,7 +254,7 @@ export default class DirectFileContentInitializer extends ContentInitializer {
 function getDirectFileInitialTime(
   mediaElement: IMediaElement,
   startAt?: IInitialTimeOptions,
-): number {
+): number | undefined {
   if (isNullOrUndefined(startAt)) {
     return 0;
   }
@@ -268,28 +268,38 @@ function getDirectFileInitialTime(
   }
 
   const duration = mediaElement.duration;
-
   if (typeof startAt.fromLastPosition === "number") {
-    if (isNullOrUndefined(duration) || !isFinite(duration)) {
-      log.warn(
-        "startAt.fromLastPosition set but no known duration, " + "beginning at 0.",
-      );
-      return 0;
+    if (!isNullOrUndefined(duration) && isFinite(duration)) {
+      return Math.max(0, duration + startAt.fromLastPosition);
     }
-    return Math.max(0, duration + startAt.fromLastPosition);
+
+    if (mediaElement.seekable.length > 0) {
+      const lastSegmentEnd = mediaElement.seekable.end(mediaElement.seekable.length - 1);
+      if (isFinite(lastSegmentEnd)) {
+        return Math.max(0, lastSegmentEnd + startAt.fromLastPosition);
+      }
+    }
+    log.warn(
+      "Init: startAt.fromLastPosition set but no known duration, " +
+        "it may be too soon to seek",
+    );
+    return undefined;
   } else if (typeof startAt.fromLivePosition === "number") {
     const livePosition =
       mediaElement.seekable.length > 0 ? mediaElement.seekable.end(0) : duration;
     if (isNullOrUndefined(livePosition)) {
       log.warn(
-        "startAt.fromLivePosition set but no known live position, " + "beginning at 0.",
+        "Init: startAt.fromLivePosition set but no known live position, " +
+          "beginning at 0.",
       );
       return 0;
     }
     return Math.max(0, livePosition + startAt.fromLivePosition);
   } else if (!isNullOrUndefined(startAt.percentage)) {
     if (isNullOrUndefined(duration) || !isFinite(duration)) {
-      log.warn("startAt.percentage set but no known duration, " + "beginning at 0.");
+      log.warn(
+        "Init: startAt.percentage set but no known duration, " + "beginning at 0.",
+      );
       return 0;
     }
     const { percentage } = startAt;

package/src/main_thread/init/multi_thread_content_initializer.ts

@@ -78,6 +78,20 @@ export default class MultiThreadContentInitializer extends ContentInitializer {
   /** Constructor settings associated to this `MultiThreadContentInitializer`. */
   private _settings: IInitializeArguments;
 
+  /**
+   * The WebWorker may be sending messages as soon as we're preparing the
+   * content but the `MultiThreadContentInitializer` is only able to handle all of
+   * them only once `start`ed.
+   *
+   * As such `_queuedWorkerMessages` is set to an Array  when `prepare` has been
+   * called but not `start` yet, and contains all worker messages that have to
+   * be processed when `start` is called.
+   *
+   * It is set to `null` when there's no need to rely on that queue (either not
+   * yet `prepare`d or already `start`ed).
+   */
+  private _queuedWorkerMessages: MessageEvent[] | null;
+
   /**
    * Information relative to the current loaded content.
    *
@@ -123,6 +137,7 @@ export default class MultiThreadContentInitializer extends ContentInitializer {
       lastMessageId: 0,
       resolvers: {},
     };
+    this._queuedWorkerMessages = null;
   }
 
   /**
@@ -176,6 +191,66 @@ export default class MultiThreadContentInitializer extends ContentInitializer {
     if (this._initCanceller.isUsed()) {
       return;
     }
+    this._queuedWorkerMessages = [];
+    log.debug("MTCI: addEventListener prepare buffering worker messages");
+    const onmessage = (evt: MessageEvent): void => {
+      const msgData = evt.data as unknown as IWorkerMessage;
+      const type = msgData.type;
+      switch (type) {
+        case WorkerMessageType.LogMessage: {
+          const formatted = msgData.value.logs.map((l) => {
+            switch (typeof l) {
+              case "string":
+              case "number":
+              case "boolean":
+              case "undefined":
+                return l;
+              case "object":
+                if (l === null) {
+                  return null;
+                }
+                return formatWorkerError(l);
+              default:
+                assertUnreachable(l);
+            }
+          });
+          switch (msgData.value.logLevel) {
+            case "NONE":
+              break;
+            case "ERROR":
+              log.error(...formatted);
+              break;
+            case "WARNING":
+              log.warn(...formatted);
+              break;
+            case "INFO":
+              log.info(...formatted);
+              break;
+            case "DEBUG":
+              log.debug(...formatted);
+              break;
+            default:
+              assertUnreachable(msgData.value.logLevel);
+          }
+          break;
+        }
+        default:
+          if (this._queuedWorkerMessages !== null) {
+            this._queuedWorkerMessages.push(evt);
+          }
+          break;
+      }
+    };
+    this._settings.worker.addEventListener("message", onmessage);
+    const onmessageerror = (_msg: MessageEvent) => {
+      log.error("MTCI: Error when receiving message from worker.");
+    };
+    this._settings.worker.addEventListener("messageerror", onmessageerror);
+    this._initCanceller.signal.register(() => {
+      log.debug("MTCI: removeEventListener prepare for worker message");
+      this._settings.worker.removeEventListener("message", onmessage);
+      this._settings.worker.removeEventListener("messageerror", onmessageerror);
+    });
 
     // Also bind all `SharedReference` objects:
 
@@ -1042,49 +1117,6 @@ export default class MultiThreadContentInitializer extends ContentInitializer {
           }
           break;
 
-        case WorkerMessageType.LogMessage: {
-          const formatted = msgData.value.logs.map((l) => {
-            switch (typeof l) {
-              case "string":
-              case "number":
-              case "boolean":
-              case "undefined":
-                return l;
-              case "object":
-                if (l === null) {
-                  return null;
-                }
-                return formatWorkerError(l);
-              default:
-                assertUnreachable(l);
-            }
-          });
-          switch (msgData.value.logLevel) {
-            case "NONE":
-              break;
-            case "ERROR":
-              log.error(...formatted);
-              break;
-            case "WARNING":
-              log.warn(...formatted);
-              break;
-            case "INFO":
-              log.info(...formatted);
-              break;
-            case "DEBUG":
-              log.debug(...formatted);
-              break;
-            default:
-              assertUnreachable(msgData.value.logLevel);
-          }
-          break;
-        }
-
-        case WorkerMessageType.InitSuccess:
-        case WorkerMessageType.InitError:
-          // Should already be handled by the API
-          break;
-
         case WorkerMessageType.SegmentSinkStoreUpdate: {
           if (this._currentContentInfo?.contentId !== msgData.contentId) {
             return;
@@ -1098,13 +1130,32 @@ export default class MultiThreadContentInitializer extends ContentInitializer {
           }
           break;
         }
+
+        case WorkerMessageType.InitSuccess:
+        case WorkerMessageType.InitError:
+          // Should already be handled by the API
+          break;
+
+        case WorkerMessageType.LogMessage:
+          // Already handled by prepare's handler
+          break;
         default:
           assertUnreachable(msgData);
       }
     };
 
+    log.debug("MTCI: addEventListener for worker message");
+    if (this._queuedWorkerMessages !== null) {
+      const bufferedMessages = this._queuedWorkerMessages.slice();
+      log.debug("MTCI: Processing buffered messages", bufferedMessages.length);
+      for (const message of bufferedMessages) {
+        onmessage(message);
+      }
+      this._queuedWorkerMessages = null;
+    }
     this._settings.worker.addEventListener("message", onmessage);
     this._initCanceller.signal.register(() => {
+      log.debug("MTCI: removeEventListener for worker message");
       this._settings.worker.removeEventListener("message", onmessage);
     });
   }
@@ -2006,24 +2057,6 @@ type IDecryptionInitializationState =
    * `HTMLMediaElement` (such as linking a content / `MediaSource` to it).
    */
   | { type: "uninitialized"; value: null }
-  /**
-   * The `MediaSource` or media url has to be linked to the `HTMLMediaElement`
-   * before continuing.
-   * Once it has been linked with success (e.g. the `MediaSource` has "opened"),
-   * the `isMediaLinked` `SharedReference` should be set to `true`.
-   *
-   * In the `MediaSource` case, you should wait until the `"initialized"`
-   * state before pushing segment.
-   *
-   * Note that the `"awaiting-media-link"` is an optional state. It can be
-   * skipped to directly `"initialized"` instead.
-   */
-  | {
-      type: "awaiting-media-link";
-      value: {
-        isMediaLinked: SharedReference<boolean>;
-      };
-    }
   /**
    * The `MediaSource` or media url can be linked AND segments can be pushed to
    * the `HTMLMediaElement` on which decryption capabilities were wanted.

package/src/main_thread/init/utils/initial_seek_and_play.ts

@@ -71,7 +71,7 @@ export default function performInitialSeekAndPlay(
   }: {
     mediaElement: IMediaElement;
     playbackObserver: IMediaElementPlaybackObserver;
-    startTime: number | (() => number);
+    startTime: number | (() => number | undefined);
     mustAutoPlay: boolean;
     isDirectfile: boolean;
     onWarning: (err: IPlayerError) => void;
@@ -107,18 +107,37 @@ export default function performInitialSeekAndPlay(
       if (!isDirectfile || typeof startTime === "number") {
         const initiallySeekedTime =
           typeof startTime === "number" ? startTime : startTime();
-        if (initiallySeekedTime !== 0) {
+        if (initiallySeekedTime !== 0 && initiallySeekedTime !== undefined) {
           performInitialSeek(initiallySeekedTime);
         }
         waitForSeekable();
       } else {
         playbackObserver.listen(
           (obs, stopListening) => {
+            const initiallySeekedTime =
+              typeof startTime === "number" ? startTime : startTime();
+            if (
+              initiallySeekedTime === undefined &&
+              obs.readyState < HTMLMediaElement.HAVE_CURRENT_DATA
+            ) {
+              /**
+               * On browser, such as Safari, the HTMLMediaElement.duration
+               * and HTMLMediaElement.buffered may not be initialized at readyState 1, leading
+               * to cases where it can be equal to `Infinity`.
+               * If so, the range in which it is possible to seek is not yet known.
+               * To solve this, the seek should be done after readyState HAVE_CURRENT_DATA (2),
+               * at that time the previously mentioned attributes are correctly initialized and
+               * the range in which it is possible to seek is correctly known.
+               * If the initiallySeekedTime is still `undefined` when the readyState is >= 2,
+               * let assume that the initiallySeekedTime will never be known and continue
+               * the logic without seeking.
+               */
+              return;
+            }
             if (obs.readyState >= 1) {
               stopListening();
-              const initiallySeekedTime =
-                typeof startTime === "number" ? startTime : startTime();
-              if (initiallySeekedTime !== 0) {
+
+              if (initiallySeekedTime !== 0 && initiallySeekedTime !== undefined) {
                 if (canSeekDirectlyAfterLoadedMetadata) {
                   performInitialSeek(initiallySeekedTime);
                 } else {