rx-player 3.32.2-dev.2023102600 → 3.32.2-dev.2023110700

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rx-player",
   "author": "Canal+",
-  "version": "3.32.2-dev.2023102600",
+  "version": "3.32.2-dev.2023110700",
   "description": "Canal+ HTML5 Video Player",
   "main": "./dist/rx-player.js",
   "keywords": [

package/sonar-project.properties

@@ -1,7 +1,7 @@
 sonar.projectKey=rx-player
 sonar.organization=rx-player
 sonar.projectName=rx-player
-sonar.projectVersion=3.32.2-dev.2023102600
+sonar.projectVersion=3.32.2-dev.2023110700
 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/compat/README.md

@@ -1,23 +1,29 @@
 # Compatibility files ##########################################################
 
-Those are "Compat" files, which concentrates any compatibility-related logic.
+Those are "Compat" files, which regroups any compatibility-related logic.
 
 All those files try to make the RxPlayer work the exact same way on different
-browsers and environments (desktop, set-top boxes, ChromeCast, smart TVs...)
-as those may have some differences between one another.
-
-The files exported here are mostly organized as one file per function and are
-all exported through the `index.ts` file.
+browsers and environments (desktop, set-top boxes, ChromeCast, smart TVs, game
+consoles...) as those may have some differences between one another, most often
+due to platform-specific issues.
 
 Any logic which is just about implementing work-arounds for specific browsers
-or environments (because the do not follow the specifications nor the most
-popular implementation of a feature) should be put there.
-This way, those can be easily checked and updated (for example when a new
-browser version fixing the issue come, or when another browser is found to have
-the same one) at any time.
+or environments (because they do not follow the specifications or the most
+popular implementation of a feature) should be put there. This logic can be
+either the implementation itself or just be the conditions to trigger those
+work-arounds, on a case-by-case basis depending on what's more maintainable.
+
+By having a single directory for compatibility work-arounds, we make those
+specific issues more visible and easily updatable if a new target shares an
+issue with an old one or if a platform issue is fixed.
+
+The files exported here are mostly organized as one file per function. The rest
+of the RxPlayer logic can then import those files when platform-specific
+work-arounds and implementations are needed.
 
 It is important that those files do not import any code from the RxPlayer,
-outside of utils (in `src/utils`).
+outside of utils (in `src/utils`) to prevent both circular dependencies and
+having a difficult-to-follow (a.k.a. "spaghetti") code architecture.
 
 Any EME-related (Encrypted Media Extensions, specific APIs linked to DRM) are
 implemented in the `eme` subdirectory.

package/src/core/adaptive/adaptive_representation_selector.ts

@@ -27,7 +27,6 @@ import { getLeftSizeOfRange } from "../../utils/ranges";
 import SharedReference, {
   IReadOnlySharedReference,
 } from "../../utils/reference";
-import takeFirstSet from "../../utils/take_first_set";
 import TaskCanceller, {
   CancellationSignal,
 } from "../../utils/task_canceller";
@@ -114,24 +113,15 @@ export default function createAdaptiveRepresentationSelector(
   ) : IRepresentationEstimatorResponse {
     const { type } = context.adaptation;
     const bandwidthEstimator = _getBandwidthEstimator(type);
-    const manualBitrate = takeFirstSet<IReadOnlySharedReference<number>>(
-      manualBitrates[type],
-      manualBitrateDefaultRef);
-    const minAutoBitrate = takeFirstSet<IReadOnlySharedReference<number>>(
-      minAutoBitrates[type],
-      minAutoBitrateDefaultRef);
-    const maxAutoBitrate = takeFirstSet<IReadOnlySharedReference<number>>(
-      maxAutoBitrates[type],
-      maxAutoBitrateDefaultRef);
-    const initialBitrate = takeFirstSet<number>(initialBitrates[type], 0);
+    const manualBitrate = manualBitrates[type] ?? manualBitrateDefaultRef;
+    const minAutoBitrate = minAutoBitrates[type] ?? minAutoBitrateDefaultRef;
+    const maxAutoBitrate = maxAutoBitrates[type] ?? maxAutoBitrateDefaultRef;
+    const initialBitrate = initialBitrates[type] ?? 0;
     const filters = {
-      limitWidth: takeFirstSet<IReadOnlySharedReference<number | undefined>>(
-        throttlers.limitWidth[type],
-        limitWidthDefaultRef),
-      throttleBitrate: takeFirstSet<IReadOnlySharedReference<number>>(
-        throttlers.throttleBitrate[type],
-        throttlers.throttle[type],
-        throttleBitrateDefaultRef),
+      limitWidth: throttlers.limitWidth[type] ?? limitWidthDefaultRef,
+      throttleBitrate: throttlers.throttleBitrate[type] ??
+                       throttlers.throttle[type] ??
+                       throttleBitrateDefaultRef,
     };
     return getEstimateReference({ bandwidthEstimator,
                                   context,

package/src/core/adaptive/utils/filter_by_width.ts

@@ -16,7 +16,6 @@
 
 import { Representation } from "../../../manifest";
 import arrayFind from "../../../utils/array_find";
-import takeFirstSet from "../../../utils/take_first_set";
 
 /**
  * Filter representations based on their width:
@@ -32,8 +31,7 @@ export default function filterByWidth(
 ) : Representation[] {
   const sortedRepsByWidth = representations
     .slice() // clone
-    .sort((a, b) => takeFirstSet<number>(a.width, 0) -
-                    takeFirstSet<number>(b.width, 0));
+    .sort((a, b) => (a.width ?? 0) - (b.width ?? 0));
 
   const repWithMaxWidth = arrayFind(sortedRepsByWidth, (representation) =>
     typeof representation.width === "number" &&

package/src/core/api/public_api.ts

@@ -379,7 +379,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     // See: https://bugzilla.mozilla.org/show_bug.cgi?id=1194624
     videoElement.preload = "auto";
 
-    this.version = /* PLAYER_VERSION */"3.32.2-dev.2023102600";
+    this.version = /* PLAYER_VERSION */"3.32.2-dev.2023110700";
     this.log = log;
     this.state = "STOPPED";
     this.videoElement = videoElement;
@@ -3103,7 +3103,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
     return mediaElementTrackChoiceManager;
   }
 }
-Player.version = /* PLAYER_VERSION */"3.32.2-dev.2023102600";
+Player.version = /* PLAYER_VERSION */"3.32.2-dev.2023110700";
 
 /** Every events sent by the RxPlayer's public API. */
 interface IPublicAPIEvent {

package/src/core/api/tracks_management/track_choice_manager.ts

@@ -43,7 +43,6 @@ import normalizeLanguage from "../../../utils/languages";
 import objectAssign from "../../../utils/object_assign";
 import SharedReference from "../../../utils/reference";
 import SortedList from "../../../utils/sorted_list";
-import takeFirstSet from "../../../utils/take_first_set";
 
 /** Audio information stored for a single Period. */
 interface ITMPeriodAudioInfos {
@@ -1092,8 +1091,7 @@ function createTextPreferenceMatcher(
    * @returns {boolean}
    */
   return function matchTextPreference(textAdaptation : Adaptation) : boolean {
-    return takeFirstSet<string>(textAdaptation.normalizedLanguage,
-                                "") === preferredTextTrack.normalized &&
+    return (textAdaptation.normalizedLanguage ?? "") === preferredTextTrack.normalized &&
     (preferredTextTrack.closedCaption ? textAdaptation.isClosedCaption === true :
                                         textAdaptation.isClosedCaption !== true) &&
     (preferredTextTrack.forced === true ? textAdaptation.isForcedSubtitles === true :

package/src/core/segment_buffers/inventory/segment_inventory.ts

@@ -23,7 +23,6 @@ import {
   Period,
   Representation,
 } from "../../../manifest";
-import takeFirstSet from "../../../utils/take_first_set";
 import BufferedHistory, {
   IBufferedHistoryEntry,
 } from "./buffered_history";
@@ -219,7 +218,7 @@ export default class SegmentInventory {
       // skip until first segment with at least `MINIMUM_SEGMENT_SIZE` past the
       // start of that range.
       while (thisSegment !== undefined &&
-             (takeFirstSet<number>(thisSegment.bufferedEnd, thisSegment.end)
+             ((thisSegment.bufferedEnd ?? thisSegment.end)
                - rangeStart) < MINIMUM_SEGMENT_SIZE)
       {
         thisSegment = inventory[++inventoryIndex];
@@ -239,8 +238,7 @@ export default class SegmentInventory {
           inventory[indexBefore + numberOfSegmentToDelete - 1];
 
         lastDeletedSegmentInfos = {
-          end: takeFirstSet<number>(lastDeletedSegment.bufferedEnd,
-                                    lastDeletedSegment.end),
+          end: lastDeletedSegment.bufferedEnd ?? lastDeletedSegment.end,
           precizeEnd: lastDeletedSegment.precizeEnd,
         };
         log.debug(`SI: ${numberOfSegmentToDelete} segments GCed.`, bufferType);
@@ -259,8 +257,7 @@ export default class SegmentInventory {
 
       // If the current segment is actually completely outside that range (it
       // is contained in one of the next one), skip that part.
-      if (rangeEnd -
-          takeFirstSet<number>(thisSegment.bufferedStart, thisSegment.start)
+      if (rangeEnd - (thisSegment.bufferedStart ?? thisSegment.start)
             >= MINIMUM_SEGMENT_SIZE
       ) {
         guessBufferedStartFromRangeStart(thisSegment,
@@ -278,10 +275,8 @@ export default class SegmentInventory {
         thisSegment = inventory[++inventoryIndex];
 
         // Make contiguous until first segment outside that range
-        let thisSegmentStart = takeFirstSet<number>(thisSegment.bufferedStart,
-                                                    thisSegment.start);
-        let thisSegmentEnd =  takeFirstSet<number>(thisSegment.bufferedEnd,
-                                                   thisSegment.end);
+        let thisSegmentStart = thisSegment.bufferedStart ?? thisSegment.start;
+        let thisSegmentEnd = thisSegment.bufferedEnd ?? thisSegment.end;
         const nextRangeStart = i < rangesLength - 1 ? buffered.start(i + 1) :
                                                       undefined;
         while (thisSegment !== undefined &&
@@ -303,10 +298,8 @@ export default class SegmentInventory {
           thisSegment.bufferedStart = prevSegment.bufferedEnd;
           thisSegment = inventory[++inventoryIndex];
           if (thisSegment !== undefined) {
-            thisSegmentStart = takeFirstSet<number>(thisSegment.bufferedStart,
-                                                    thisSegment.start);
-            thisSegmentEnd =  takeFirstSet<number>(thisSegment.bufferedEnd,
-                                                   thisSegment.end);
+            thisSegmentStart = thisSegment.bufferedStart ?? thisSegment.start;
+            thisSegmentEnd =  thisSegment.bufferedEnd ?? thisSegment.end;
           }
         }
       }

package/src/parsers/manifest/smooth/create_parser.ts

@@ -26,7 +26,6 @@ import isNonEmptyString from "../../../utils/is_non_empty_string";
 import objectAssign from "../../../utils/object_assign";
 import { getFilenameIndexInUrl } from "../../../utils/resolve_url";
 import { hexToBytes } from "../../../utils/string_parsing";
-import takeFirstSet from "../../../utils/take_first_set";
 import { createBox } from "../../containers/isobmff";
 import {
   IContentProtectionKID,
@@ -258,7 +257,7 @@ function createSmoothStreamingParser(
                  customAttributes,
                  mimeType: fourCC !== undefined ? MIME_TYPES[fourCC] :
                                                   fourCC,
-                 codecPrivateData: takeFirstSet<string>(codecPrivateData, "") };
+                 codecPrivateData: codecPrivateData ?? "" };
       }
 
       default:

package/src/transports/dash/image_pipelines.ts

@@ -17,7 +17,6 @@
 import features from "../../features";
 import { ICdnMetadata } from "../../parsers/manifest";
 import request from "../../utils/request";
-import takeFirstSet from "../../utils/take_first_set";
 import { CancellationSignal } from "../../utils/task_canceller";
 import {
   IImageTrackSegmentData,
@@ -92,7 +91,7 @@ export function imageParser(
     throw new Error("Image data should not be downloaded in chunks");
   }
 
-  const chunkOffset = takeFirstSet<number>(segment.timestampOffset, 0);
+  const chunkOffset = segment.timestampOffset ?? 0;
 
   // TODO image Parsing should be more on the buffer side, no?
   if (data === null || features.imageParser === null) {

package/src/transports/dash/segment_parser.ts

@@ -29,7 +29,6 @@ import {
 } from "../../parsers/containers/matroska";
 import { BaseRepresentationIndex } from "../../parsers/manifest/dash";
 import isNullOrUndefined from "../../utils/is_null_or_undefined";
-import takeFirstSet from "../../utils/take_first_set";
 import {
   ISegmentContext,
   ISegmentParser,
@@ -106,7 +105,7 @@ export default function generateAudioVideoSegmentParser(
                                                               segment,
                                                               initTimescale) :
                                         null; // TODO extract time info from webm
-      const chunkOffset = takeFirstSet<number>(segment.timestampOffset, 0);
+      const chunkOffset = segment.timestampOffset ?? 0;
 
       if (seemsToBeMP4) {
         const parsedEMSGs = parseEmsgBoxes(chunkData);

package/src/transports/dash/text_parser.ts

@@ -23,7 +23,6 @@ import {
   strToUtf8,
   utf8ToStr,
 } from "../../utils/string_parsing";
-import takeFirstSet from "../../utils/take_first_set";
 import {
   ISegmentContext,
   ISegmentParser,
@@ -114,7 +113,7 @@ function parseISOBMFFEmbeddedTextTrack(
                                                     chunkBytes,
                                                     chunkInfos,
                                                     isChunked);
-  const chunkOffset = takeFirstSet<number>(segment.timestampOffset, 0);
+  const chunkOffset = segment.timestampOffset ?? 0;
   return { segmentType: "media",
            chunkData,
            chunkSize: chunkBytes.length,

package/src/transports/local/segment_parser.ts

@@ -20,7 +20,6 @@ import {
 } from "../../parsers/containers/isobmff";
 import { getKeyIdFromInitSegment } from "../../parsers/containers/isobmff/utils";
 import { getTimeCodeScale } from "../../parsers/containers/matroska";
-import takeFirstSet from "../../utils/take_first_set";
 import {
   ISegmentContext,
   ISegmentParserParsedInitChunk,
@@ -91,7 +90,7 @@ export default function segmentParser(
                                                           segment,
                                                           initTimescale) :
                                     null; // TODO extract time info from webm
-  const chunkOffset = takeFirstSet<number>(segment.timestampOffset, 0);
+  const chunkOffset = segment.timestampOffset ?? 0;
   return { segmentType: "media",
            chunkData,
            chunkSize: chunkData.length,

package/src/transports/local/text_parser.ts

@@ -19,7 +19,6 @@ import {
   strToUtf8,
   utf8ToStr,
 } from "../../utils/string_parsing";
-import takeFirstSet from "../../utils/take_first_set";
 import {
   ILoadedTextSegmentFormat,
   ISegmentContext,
@@ -78,7 +77,7 @@ function parseISOBMFFEmbeddedTextTrack(
                                                     chunkBytes,
                                                     chunkInfos,
                                                     isChunked);
-  const chunkOffset = takeFirstSet<number>(segment.timestampOffset, 0);
+  const chunkOffset = segment.timestampOffset ?? 0;
   return { segmentType: "media",
            chunkData,
            chunkSize: chunkBytes.length,
@@ -125,7 +124,7 @@ function parsePlainTextTrack(
     textTrackData = data;
   }
   const chunkData = getPlainTextTrackData(content, textTrackData, isChunked);
-  const chunkOffset = takeFirstSet<number>(segment.timestampOffset, 0);
+  const chunkOffset = segment.timestampOffset ?? 0;
   return { segmentType: "media",
            chunkData,
            chunkSize,

package/dist/_esm5.processed/utils/take_first_set.d.ts

@@ -1,25 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Returns the first argument given different from undefined or null.
- * @param {...*} args
- * @returns {*}
- */
-export default function takeFirstSet<T>(a: T, b?: undefined | null | T): T;
-export default function takeFirstSet<T>(a: T | undefined | null, b: T): T;
-export default function takeFirstSet(a?: undefined | null, b?: undefined | null): undefined;
-export default function takeFirstSet<T>(a: undefined | null | T, b: undefined | null | T, c: T): T;
-export default function takeFirstSet<T>(...args: Array<T | null | undefined>): T | undefined;

package/dist/_esm5.processed/utils/take_first_set.js

@@ -1,32 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import isNullOrUndefined from "./is_null_or_undefined";
-export default function takeFirstSet() {
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
-    }
-    var i = 0;
-    var len = args.length;
-    while (i < len) {
-        var arg = args[i];
-        if (!isNullOrUndefined(arg)) {
-            return arg;
-        }
-        i++;
-    }
-    return undefined;
-}

package/src/utils/__tests__/take_first_set.test.ts

@@ -1,38 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import takeFirstSet from "../take_first_set";
-
-describe("utils - takeFirstSet", () => {
-  it("should return undefined with no argument", () => {
-    expect(takeFirstSet()).toEqual(undefined);
-  });
-
-  it("should return undefined with only undefined or null arguments", () => {
-    expect(takeFirstSet(undefined, undefined, undefined)).toEqual(undefined);
-    expect(takeFirstSet(null, null, null, null)).toEqual(undefined);
-    expect(takeFirstSet(undefined, null, null, undefined)).toEqual(undefined);
-    expect(takeFirstSet(null, null, null, undefined)).toEqual(undefined);
-  });
-
-  it("should return the first set argument", () => {
-    const obj1 = { a: 4 };
-    const obj2 = { b: 12 };
-
-    expect(takeFirstSet<unknown>(undefined, null, obj1, obj2))
-      .toEqual(obj1);
-  });
-});

package/src/utils/take_first_set.ts

@@ -1,53 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import isNullOrUndefined from "./is_null_or_undefined";
-
-/**
- * Returns the first argument given different from undefined or null.
- * @param {...*} args
- * @returns {*}
- */
-export default function takeFirstSet<T>(
-  a : T,
-  b? : undefined | null | T
-) : T;
-export default function takeFirstSet<T>(a : T | undefined | null, b : T) : T;
-export default function takeFirstSet(
-  a? : undefined|null,
-  b? : undefined|null
-) : undefined;
-export default function takeFirstSet<T>(
-  a : undefined|null|T,
-  b : undefined|null|T,
-  c : T
-) : T;
-export default function takeFirstSet<T>(...args : Array<T|null|undefined>) : T |
-                                                                             undefined;
-export default function takeFirstSet<T>(
-  ...args : Array<T|null|undefined>
-) : T | undefined {
-  let i = 0;
-  const len = args.length;
-  while (i < len) {
-    const arg = args[i];
-    if (!isNullOrUndefined(arg)) {
-      return arg;
-    }
-    i++;
-  }
-  return undefined;
-}