rx-player 4.4.0 → 4.4.1-dev.2025101500

package/src/core/{main/common → entry}/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/{main → entry}/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 `WorkerMain` to generate the worker bundle. In a monothreading mode,
+external code but the `CoreEntry` to generate the worker bundle. In a monothreading mode,
 any file may be directly imported.
 
 ## Overview

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

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

package/src/core/{main/common → entry}/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