rx-player 4.4.1-dev.2025101500 → 4.4.1

package/src/core/{entry → main}/README.md

@@ -6,7 +6,7 @@
 | Multithread environment | Should be runnable in a WebWorker entirely |
 
 [1] In a Multithreading mode, no file from that directory should ever be imported by
-external code but the `CoreEntry` to generate the worker bundle. In a monothreading mode,
+external code but the `WorkerMain` to generate the worker bundle. In a monothreading mode,
 any file may be directly imported.
 
 ## Overview

package/src/core/{entry → main/common}/FreezeResolver.ts

@@ -1,14 +1,14 @@
-import { config } from "../../experimental";
-import log from "../../log";
-import type { IAdaptation, IPeriod, IRepresentation } from "../../manifest";
+import { config } from "../../../experimental";
+import log from "../../../log";
+import type { IAdaptation, IPeriod, IRepresentation } from "../../../manifest";
 import type {
   IFreezingStatus,
   IRebufferingStatus,
   ObservationPosition,
-} from "../../playback_observer";
-import getMonotonicTimeStamp from "../../utils/monotonic_timestamp";
-import type SegmentSinksStore from "../segment_sinks";
-import type { IBufferedChunk } from "../segment_sinks";
+} from "../../../playback_observer";
+import getMonotonicTimeStamp from "../../../utils/monotonic_timestamp";
+import type SegmentSinksStore from "../../segment_sinks";
+import type { IBufferedChunk } from "../../segment_sinks";
 
 /**
  * "Freezing" is a complex situation indicating that playback is not advancing

package/src/core/{entry → main/common}/content_time_boundaries_observer.ts

@@ -17,21 +17,21 @@
 import type {
   IStreamOrchestratorPlaybackObservation,
   IBufferType,
-} from "../../core/types";
-import { MediaError } from "../../errors";
+} from "../../../core/types";
+import { MediaError } from "../../../errors";
 import type {
   IManifest,
   IAdaptation,
   IRepresentationIndex,
   IPeriod,
-} from "../../manifest";
-import type { IReadOnlyPlaybackObserver } from "../../playback_observer";
-import type { IPlayerError } from "../../public_types";
-import EventEmitter from "../../utils/event_emitter";
-import isNullOrUndefined from "../../utils/is_null_or_undefined";
-import queueMicrotask from "../../utils/queue_microtask";
-import SortedList from "../../utils/sorted_list";
-import TaskCanceller from "../../utils/task_canceller";
+} from "../../../manifest";
+import type { IReadOnlyPlaybackObserver } from "../../../playback_observer";
+import type { IPlayerError } from "../../../public_types";
+import EventEmitter from "../../../utils/event_emitter";
+import isNullOrUndefined from "../../../utils/is_null_or_undefined";
+import queueMicrotask from "../../../utils/queue_microtask";
+import SortedList from "../../../utils/sorted_list";
+import TaskCanceller from "../../../utils/task_canceller";
 
 /**
  * Observes what's being played and take care of media events relating to time

package/src/core/{entry → main/common}/create_content_time_boundaries_observer.ts

@@ -1,13 +1,13 @@
 import type {
   ISegmentSinksStore,
   IStreamOrchestratorPlaybackObservation,
-} from "../../core/types";
-import log from "../../log";
-import type { IManifest, IPeriod } from "../../manifest";
-import type { IMediaSourceInterface } from "../../mse";
-import type { IReadOnlyPlaybackObserver } from "../../playback_observer";
-import type { IPlayerError } from "../../public_types";
-import type { CancellationSignal } from "../../utils/task_canceller";
+} from "../../../core/types";
+import log from "../../../log";
+import type { IManifest, IPeriod } from "../../../manifest";
+import type { IMediaSourceInterface } from "../../../mse";
+import type { IReadOnlyPlaybackObserver } from "../../../playback_observer";
+import type { IPlayerError } from "../../../public_types";
+import type { CancellationSignal } from "../../../utils/task_canceller";
 import ContentTimeBoundariesObserver from "./content_time_boundaries_observer";
 
 export interface IContentTimeBoundariesObserverCallbacks {

package/src/core/{entry → main/common}/get_buffered_data_per_media_buffer.ts

@@ -1,9 +1,9 @@
-import type { ITextDisplayer } from "../../main_thread/types";
-import type { IMediaSourceInterface } from "../../mse";
-import { SourceBufferType } from "../../mse";
-import type { ITrackType } from "../../public_types";
-import arrayFind from "../../utils/array_find";
-import type { IRange } from "../../utils/ranges";
+import type { ITextDisplayer } from "../../../main_thread/types";
+import type { IMediaSourceInterface } from "../../../mse";
+import { SourceBufferType } from "../../../mse";
+import type { ITrackType } from "../../../public_types";
+import arrayFind from "../../../utils/array_find";
+import type { IRange } from "../../../utils/ranges";
 
 /**
  * Returns a JS object where keys are the type of buffers (e.g. "audio",

package/src/core/{entry → main/common}/get_thumbnail_data.ts

@@ -1,8 +1,8 @@
-import type { IManifest } from "../../manifest";
-import type { IThumbnailResponse } from "../../transports";
-import arrayFind from "../../utils/array_find";
-import TaskCanceller from "../../utils/task_canceller";
-import type { IThumbnailFetcher } from "../fetchers";
+import type { IManifest } from "../../../manifest";
+import type { IThumbnailResponse } from "../../../transports";
+import arrayFind from "../../../utils/array_find";
+import TaskCanceller from "../../../utils/task_canceller";
+import type { IThumbnailFetcher } from "../../fetchers";
 
 /**
  * @param {function} fetchThumbnails

package/src/core/{entry → main/common}/synchronize_sinks_on_observation.ts

@@ -1,5 +1,5 @@
-import type { ICorePlaybackObservation } from "../../main_thread/init/utils/create_core_playback_observer";
-import type SegmentSinksStore from "../segment_sinks";
+import type { ICorePlaybackObservation } from "../../../main_thread/init/utils/create_core_playback_observer";
+import type SegmentSinksStore from "../../segment_sinks";
 
 /**
  * Synchronize SegmentSinks with what has been buffered.

package/src/core/{entry → main/worker}/content_preparer.ts

@@ -1,34 +1,41 @@
-import { MediaSource_ } from "../../compat/browser_compatibility_types";
-import features from "../../features";
-import log from "../../log";
-import type { IContentInitializationData } from "../../main_thread/types";
-import type { IManifest } from "../../manifest";
-import { createRepresentationFilterFromFnString } from "../../manifest";
-import type Manifest from "../../manifest/classes";
-import type { IMediaSourceInterface } from "../../mse";
-import MainMediaSourceInterface from "../../mse/main_media_source_interface";
-import WorkerMediaSourceInterface from "../../mse/worker_media_source_interface";
-import type { IPlayerError } from "../../public_types";
-import idGenerator from "../../utils/id_generator";
-import isNullOrUndefined from "../../utils/is_null_or_undefined";
-import type { CancellationError, CancellationSignal } from "../../utils/task_canceller";
-import TaskCanceller from "../../utils/task_canceller";
-import type { IRepresentationEstimator } from "../adaptive";
-import createAdaptiveRepresentationSelector from "../adaptive";
-import type { IRepresentationEstimatorThrottlers } from "../adaptive/adaptive_representation_selector";
-import CmcdDataBuilder from "../cmcd";
-import type { IManifestRefreshSettings } from "../fetchers";
-import { ManifestFetcher, SegmentQueueCreator } from "../fetchers";
-import CdnPrioritizer from "../fetchers/cdn_prioritizer";
-import createThumbnailFetcher from "../fetchers/thumbnails/thumbnail_fetcher";
-import type { IThumbnailFetcher } from "../fetchers/thumbnails/thumbnail_fetcher";
-import SegmentSinksStore from "../segment_sinks";
-import type { IAttachMediaSourceCoreMessagePayload, ICoreMessage } from "../types";
-import { CoreMessageType } from "../types";
-import CoreTextDisplayerInterface from "./core_text_displayer_interface";
-import FreezeResolver from "./FreezeResolver";
+import { MediaSource_ } from "../../../compat/browser_compatibility_types";
+import features from "../../../features";
+import log from "../../../log";
+import type { IManifest, IManifestMetadata } from "../../../manifest";
+import { createRepresentationFilterFromFnString } from "../../../manifest";
+import type Manifest from "../../../manifest/classes";
+import type { IMediaSourceInterface } from "../../../mse";
+import MainMediaSourceInterface from "../../../mse/main_media_source_interface";
+import WorkerMediaSourceInterface from "../../../mse/worker_media_source_interface";
+import type {
+  IAttachMediaSourceWorkerMessagePayload,
+  IContentInitializationData,
+} from "../../../multithread_types";
+import { WorkerMessageType } from "../../../multithread_types";
+import type { IPlayerError } from "../../../public_types";
+import assert from "../../../utils/assert";
+import idGenerator from "../../../utils/id_generator";
+import isNullOrUndefined from "../../../utils/is_null_or_undefined";
+import objectAssign from "../../../utils/object_assign";
+import type {
+  CancellationError,
+  CancellationSignal,
+} from "../../../utils/task_canceller";
+import TaskCanceller from "../../../utils/task_canceller";
+import type { IRepresentationEstimator } from "../../adaptive";
+import createAdaptiveRepresentationSelector from "../../adaptive";
+import CmcdDataBuilder from "../../cmcd";
+import type { IManifestRefreshSettings } from "../../fetchers";
+import { ManifestFetcher, SegmentQueueCreator } from "../../fetchers";
+import CdnPrioritizer from "../../fetchers/cdn_prioritizer";
+import createThumbnailFetcher from "../../fetchers/thumbnails/thumbnail_fetcher";
+import type { IThumbnailFetcher } from "../../fetchers/thumbnails/thumbnail_fetcher";
+import SegmentSinksStore from "../../segment_sinks";
+import FreezeResolver from "../common/FreezeResolver";
+import { limitVideoResolution, throttleVideoBitrate } from "./globals";
+import sendMessage, { formatErrorForSender } from "./send_message";
 import TrackChoiceSetter from "./track_choice_setter";
-import { formatErrorForSender } from "./utils";
+import WorkerTextDisplayerInterface from "./worker_text_displayer_interface";
 
 /** Function allowing to associate a unique identifier to all created `MediaSource` */
 const generateMediaSourceId = idGenerator();
@@ -104,11 +111,8 @@ export default class ContentPreparer {
    * @returns {Promise.<Object>}
    */
   public initializeNewContent(
-    sendMessage: (msg: ICoreMessage, transferables?: Transferable[]) => void,
     context: IContentInitializationData,
-    /** Allows to filter which Representations can be choosen. */
-    throttlers: IRepresentationEstimatorThrottlers,
-  ): Promise<IManifest> {
+  ): Promise<IManifestMetadata> {
     return new Promise((res, rej) => {
       this.disposeCurrentContent();
       const contentCanceller = this._contentCanceller;
@@ -124,25 +128,19 @@ export default class ContentPreparer {
         transportOptions,
         useMseInWorker,
         enableRepresentationAvoidance,
-        transport,
       } = context;
       let manifest: IManifest | null = null;
 
-      const transportFn = features.transports[transport];
-      if (typeof transportFn !== "function") {
-        rej(
-          new Error(
-            `transport "${transport}" not supported. ` +
-              "Did you add the corresponding feature?",
-          ),
-        );
-        return;
-      }
+      // TODO better way
+      assert(
+        features.transports.dash !== undefined,
+        "Multithread RxPlayer should have access to the DASH feature",
+      );
       const representationFilter =
         typeof transportOptions.representationFilter === "string"
           ? createRepresentationFilterFromFnString(transportOptions.representationFilter)
-          : transportOptions.representationFilter;
-      const transportPipelines = transportFn({
+          : undefined;
+      const dashPipelines = features.transports.dash({
         ...transportOptions,
         representationFilter,
       });
@@ -151,7 +149,7 @@ export default class ContentPreparer {
         context.cmcd === undefined ? null : new CmcdDataBuilder(context.cmcd);
       const manifestFetcher = new ManifestFetcher(
         url === undefined ? undefined : [url],
-        transportPipelines,
+        dashPipelines,
         {
           cmcdDataBuilder,
           ...context.manifestRetryOptions,
@@ -163,7 +161,10 @@ export default class ContentPreparer {
           video: context.initialVideoBitrate ?? 0,
         },
         lowLatencyMode: transportOptions.lowLatencyMode,
-        throttlers,
+        throttlers: {
+          limitResolution: { video: limitVideoResolution },
+          throttleBitrate: { video: throttleVideoBitrate },
+        },
       });
 
       const unbindRejectOnCancellation = currentMediaSourceCanceller.signal.register(
@@ -174,21 +175,20 @@ export default class ContentPreparer {
 
       const cdnPrioritizer = new CdnPrioritizer(contentCanceller.signal);
       const segmentQueueCreator = new SegmentQueueCreator(
-        transportPipelines,
+        dashPipelines,
         cdnPrioritizer,
         cmcdDataBuilder,
         context.segmentRetryOptions,
       );
       const fetchThumbnailData = createThumbnailFetcher(
-        transportPipelines.thumbnails,
+        dashPipelines.thumbnails,
         cdnPrioritizer,
       );
 
       const trackChoiceSetter = new TrackChoiceSetter();
 
-      const [mediaSource, segmentSinksStore, coreTextSender] =
+      const [mediaSource, segmentSinksStore, workerTextSender] =
         createMediaSourceInterfaceAndSegmentSinksStore(
-          sendMessage,
           contentId,
           {
             useMseInWorker,
@@ -210,7 +210,7 @@ export default class ContentPreparer {
         segmentSinksStore,
         segmentQueueCreator,
         fetchThumbnailData,
-        coreTextSender,
+        workerTextSender,
         trackChoiceSetter,
         useMseInWorker,
       };
@@ -229,7 +229,7 @@ export default class ContentPreparer {
         "warning",
         (err: IPlayerError) => {
           sendMessage({
-            type: CoreMessageType.Warning,
+            type: WorkerMessageType.Warning,
             contentId,
             value: formatErrorForSender(err),
           });
@@ -255,7 +255,7 @@ export default class ContentPreparer {
         "error",
         (err: unknown) => {
           sendMessage({
-            type: CoreMessageType.Error,
+            type: WorkerMessageType.Error,
             contentId,
             value: formatErrorForSender(err),
           });
@@ -274,6 +274,7 @@ export default class ContentPreparer {
           return;
         }
         updateCodecSupportInWorkerMode(manifest);
+        const sentManifest = manifest.getMetadataSnapshot();
         manifest.addEventListener(
           "manifestUpdate",
           (updates) => {
@@ -281,16 +282,22 @@ export default class ContentPreparer {
               // TODO log warn?
               return;
             }
+
+            // Remove `periods` key to reduce cost of an unnecessary manifest
+            // clone.
+            const snapshot = objectAssign(manifest.getMetadataSnapshot(), {
+              periods: [],
+            });
             sendMessage({
-              type: CoreMessageType.ManifestUpdate,
+              type: WorkerMessageType.ManifestUpdate,
               contentId,
-              value: { manifest, updates },
+              value: { manifest: snapshot, updates },
             });
           },
           contentCanceller.signal,
         );
         unbindRejectOnCancellation();
-        res(manifest);
+        res(sentManifest);
       }
     });
   }
@@ -317,17 +324,12 @@ export default class ContentPreparer {
   }
 
   /**
-   * Change the MediaSource attached for the current content.
-   * It is assumed that main thread is already notified that such a reload is
-   * happening.
+   * Signal the ContentPreparer that the MediaSource is "reloading".
    *
    * The returned Promise resolves when it restarts being ready.
-   * @param {Function} sendMessage
    * @returns {Promise}
    */
-  public reloadMediaSource(
-    sendMessage: (msg: ICoreMessage, transferables?: Transferable[]) => void,
-  ): Promise<void> {
+  public reloadMediaSource(): Promise<void> {
     this._currentMediaSourceCanceller.cancel();
     if (this._currentContent === null) {
       return Promise.reject(new Error("CP: No content anymore"));
@@ -335,21 +337,20 @@ export default class ContentPreparer {
     this._currentContent.trackChoiceSetter.reset();
     this._currentMediaSourceCanceller = new TaskCanceller();
 
-    const [mediaSourceInterface, segmentSinksStore, coreTextSender] =
+    const [mediaSourceInterface, segmentSinksStore, workerTextSender] =
       createMediaSourceInterfaceAndSegmentSinksStore(
-        sendMessage,
         this._currentContent.contentId,
         {
           useMseInWorker: this._currentContent.useMseInWorker,
           hasVideo: this._hasVideo,
-          hasText: this._currentContent.coreTextSender !== null,
+          hasText: this._currentContent.workerTextSender !== null,
         },
         this._currentMediaSourceCanceller.signal,
       );
     this._currentContent.mediaSource = mediaSourceInterface;
     this._currentContent.segmentSinksStore = segmentSinksStore;
     this._currentContent.freezeResolver = new FreezeResolver(segmentSinksStore);
-    this._currentContent.coreTextSender = coreTextSender;
+    this._currentContent.workerTextSender = workerTextSender;
     return new Promise((res, rej) => {
       mediaSourceInterface.addEventListener(
         "mediaSourceOpen",
@@ -432,7 +433,7 @@ export interface IPreparedContentData {
    */
   segmentSinksStore: SegmentSinksStore;
   /** Allows to send timed text media data so it can be rendered. */
-  coreTextSender: CoreTextDisplayerInterface | null;
+  workerTextSender: WorkerTextDisplayerInterface | null;
   /**
    * Allows to create `SegmentQueue` which simplifies complex media segment
    * fetching.
@@ -454,7 +455,6 @@ export interface IPreparedContentData {
 }
 
 /**
- * @param {Function} sendMessage
  * @param {string} contentId
  * @param {Object} capabilities
  * @param {boolean} capabilities.useMseInWorker
@@ -464,7 +464,6 @@ export interface IPreparedContentData {
  * @returns {Array.<Object>}
  */
 function createMediaSourceInterfaceAndSegmentSinksStore(
-  sendMessage: (msg: ICoreMessage, transferables?: Transferable[]) => void,
   contentId: string,
   capabilities: {
     useMseInWorker: boolean;
@@ -472,13 +471,13 @@ function createMediaSourceInterfaceAndSegmentSinksStore(
     hasText: boolean;
   },
   cancelSignal: CancellationSignal,
-): [IMediaSourceInterface, SegmentSinksStore, CoreTextDisplayerInterface | null] {
+): [IMediaSourceInterface, SegmentSinksStore, WorkerTextDisplayerInterface | null] {
   let mediaSourceInterface: IMediaSourceInterface;
   if (capabilities.useMseInWorker) {
     const mainMediaSource = new MainMediaSourceInterface(generateMediaSourceId());
     mediaSourceInterface = mainMediaSource;
 
-    let sentMediaSourceLink: IAttachMediaSourceCoreMessagePayload;
+    let sentMediaSourceLink: IAttachMediaSourceWorkerMessagePayload;
     const handle = mainMediaSource.handle;
     if (handle.type === "handle") {
       sentMediaSourceLink = { type: "handle" as const, value: handle.value };
@@ -492,7 +491,7 @@ function createMediaSourceInterfaceAndSegmentSinksStore(
 
     sendMessage(
       {
-        type: CoreMessageType.AttachMediaSource,
+        type: WorkerMessageType.AttachMediaSource,
         contentId,
         value: sentMediaSourceLink,
         mediaSourceId: mediaSourceInterface.id,
@@ -508,7 +507,7 @@ function createMediaSourceInterfaceAndSegmentSinksStore(
   }
 
   const textSender = capabilities.hasText
-    ? new CoreTextDisplayerInterface(contentId, sendMessage)
+    ? new WorkerTextDisplayerInterface(contentId, sendMessage)
     : null;
   const { hasVideo } = capabilities;
   const segmentSinksStore = new SegmentSinksStore(

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

@@ -0,0 +1,38 @@
+import config from "../../../config";
+import SharedReference from "../../../utils/reference";
+import type { IResolutionInfo } from "../../adaptive";
+
+const {
+  DEFAULT_WANTED_BUFFER_AHEAD,
+  DEFAULT_MAX_VIDEO_BUFFER_SIZE,
+  DEFAULT_MAX_BUFFER_AHEAD,
+  DEFAULT_MAX_BUFFER_BEHIND,
+} = config.getCurrent();
+
+/** Buffer "goal" at which we stop downloading new segments. */
+const wantedBufferAhead = new SharedReference(DEFAULT_WANTED_BUFFER_AHEAD);
+
+/** Buffer maximum size in kiloBytes at which we stop downloading */
+const maxVideoBufferSize = new SharedReference(DEFAULT_MAX_VIDEO_BUFFER_SIZE);
+
+/** Max buffer size after the current position, in seconds (we GC further up). */
+const maxBufferAhead = new SharedReference(DEFAULT_MAX_BUFFER_AHEAD);
+
+/** Max buffer size before the current position, in seconds (we GC further down). */
+const maxBufferBehind = new SharedReference(DEFAULT_MAX_BUFFER_BEHIND);
+
+const limitVideoResolution = new SharedReference<IResolutionInfo>({
+  height: undefined,
+  width: undefined,
+  pixelRatio: 1,
+});
+const throttleVideoBitrate = new SharedReference(Infinity);
+
+export {
+  wantedBufferAhead,
+  maxVideoBufferSize,
+  maxBufferBehind,
+  maxBufferAhead,
+  limitVideoResolution,
+  throttleVideoBitrate,
+};

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

@@ -0,0 +1,2 @@
+import initializeWorkerMain from "./worker_main";
+export default initializeWorkerMain;

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

@@ -0,0 +1,28 @@
+import { formatError } from "../../../errors";
+import log from "../../../log";
+import type { ISentError, IWorkerMessage } from "../../../multithread_types";
+
+export default function sendMessage(
+  msg: IWorkerMessage,
+  transferables?: Transferable[],
+): void {
+  log.debug("M<--C", "Sending message", { name: msg.type });
+  if (transferables === undefined) {
+    postMessage(msg);
+  } else {
+    // TypeScript made a mistake here, and 2busy2fix
+    (postMessage as (msg: IWorkerMessage, transferables: Transferable[]) => void)(
+      msg,
+      transferables,
+    );
+  }
+}
+
+export function formatErrorForSender(error: unknown): ISentError {
+  const formattedError = formatError(error, {
+    defaultCode: "NONE",
+    defaultReason: "An unknown error stopped content playback.",
+  });
+
+  return formattedError.serialize();
+}

package/src/core/{entry → main/worker}/track_choice_setter.ts

@@ -1,10 +1,10 @@
-import log from "../../log";
-import type { ITrackUpdateChoiceObject } from "../../main_thread/types";
-import type { ITrackType } from "../../public_types";
-import isNullOrUndefined from "../../utils/is_null_or_undefined";
-import objectAssign from "../../utils/object_assign";
-import SharedReference from "../../utils/reference";
-import type { IAdaptationChoice, IRepresentationsChoice } from "../stream";
+import log from "../../../log";
+import type { ITrackUpdateChoiceObject } from "../../../multithread_types";
+import type { ITrackType } from "../../../public_types";
+import isNullOrUndefined from "../../../utils/is_null_or_undefined";
+import objectAssign from "../../../utils/object_assign";
+import SharedReference from "../../../utils/reference";
+import type { IAdaptationChoice, IRepresentationsChoice } from "../../stream";
 
 export default class TrackChoiceSetter {
   /**