rx-player 4.2.0-dev.2024081301 → 4.2.0-dev.2024082600

package/src/main_thread/tracks_store/tracks_store.ts

@@ -910,10 +910,16 @@ export default class TracksStore extends EventEmitter<ITracksStoreEvents> {
    * `null` if audio tracks were disabled and `undefined` if the Period is not
    * known.
    */
-  public getChosenAudioTrack(periodObj: ITSPeriodObject): IAudioTrack | null {
+  public getChosenAudioTrack(
+    periodObj: ITSPeriodObject,
+    filterPlayableRepresentations: boolean,
+  ): IAudioTrack | null {
     return isNullOrUndefined(periodObj.audio.storedSettings)
       ? null
-      : toAudioTrack(periodObj.audio.storedSettings.adaptation, true);
+      : toAudioTrack(
+          periodObj.audio.storedSettings.adaptation,
+          filterPlayableRepresentations,
+        );
   }
 
   /**
@@ -942,12 +948,18 @@ export default class TracksStore extends EventEmitter<ITracksStoreEvents> {
    * @param {Object} periodObj - The concerned Period's object
    * @returns {Object|null} - The video track chosen for this Period
    */
-  public getChosenVideoTrack(periodObj: ITSPeriodObject): IVideoTrack | null {
+  public getChosenVideoTrack(
+    periodObj: ITSPeriodObject,
+    filterPlayableRepresentations: boolean,
+  ): IVideoTrack | null {
     if (isNullOrUndefined(periodObj.video.storedSettings)) {
       return null;
     }
 
-    return toVideoTrack(periodObj.video.storedSettings.adaptation, true);
+    return toVideoTrack(
+      periodObj.video.storedSettings.adaptation,
+      filterPlayableRepresentations,
+    );
   }
 
   /**
@@ -957,10 +969,15 @@ export default class TracksStore extends EventEmitter<ITracksStoreEvents> {
    * Returns `undefined` if the given Period's id is not known.
    *
    * @param {Object} periodObj - The concerned Period's object
+   * @param {boolean} filterPlayableRepresentations - If `true`, only
+   * representations considered to be "playable" will be included in the
+   * returned response.
+   * If `false`, the response should contain all linked representations.
    * @returns {Array.<Object>}
    */
   public getAvailableAudioTracks(
     periodObj: ITSPeriodObject,
+    filterPlayableRepresentations: boolean,
   ): IAvailableAudioTrack[] | undefined {
     const storedSettings = periodObj.audio.storedSettings;
     const currentId = !isNullOrUndefined(storedSettings)
@@ -969,7 +986,9 @@ export default class TracksStore extends EventEmitter<ITracksStoreEvents> {
     const adaptations = getSupportedAdaptations(periodObj.period, "audio");
     return adaptations.map((adaptation: IAdaptationMetadata) => {
       const active = currentId === null ? false : currentId === adaptation.id;
-      return objectAssign(toAudioTrack(adaptation, true), { active });
+      return objectAssign(toAudioTrack(adaptation, filterPlayableRepresentations), {
+        active,
+      });
     });
   }
 
@@ -1004,10 +1023,15 @@ export default class TracksStore extends EventEmitter<ITracksStoreEvents> {
    * Returns `undefined` if the given Period's id is not known.
    *
    * @param {Object} periodObj - The concerned Period's object
+   * @param {boolean} filterPlayableRepresentations - If `true`, only
+   * representations considered to be "playable" will be included in the
+   * returned response.
+   * If `false`, the response should contain all linked representations.
    * @returns {Array.<Object>}
    */
   public getAvailableVideoTracks(
     periodObj: ITSPeriodObject,
+    filterPlayableRepresentations: boolean,
   ): IAvailableVideoTrack[] | undefined {
     const storedSettings = periodObj.video.storedSettings;
     const currentId = isNullOrUndefined(storedSettings)
@@ -1017,7 +1041,7 @@ export default class TracksStore extends EventEmitter<ITracksStoreEvents> {
     const adaptations = getSupportedAdaptations(periodObj.period, "video");
     return adaptations.map((adaptation) => {
       const active = currentId === null ? false : currentId === adaptation.id;
-      const track = toVideoTrack(adaptation, true);
+      const track = toVideoTrack(adaptation, filterPlayableRepresentations);
       const trickModeTracks =
         track.trickModeTracks !== undefined
           ? track.trickModeTracks.map((trickModeAdaptation) => {

package/src/manifest/classes/adaptation.ts

@@ -180,9 +180,7 @@ export default class Adaptation implements IAdaptationMetadata {
         if (representation.contentProtections !== undefined) {
           reprObject.contentProtections = {};
           if (representation.contentProtections.keyIds !== undefined) {
-            const keyIds = representation.contentProtections.keyIds.map(
-              ({ keyId }) => keyId,
-            );
+            const keyIds = representation.contentProtections.keyIds;
             reprObject.contentProtections.keyIds = keyIds;
           }
         }

package/src/manifest/classes/representation.ts

@@ -281,7 +281,7 @@ class Representation implements IRepresentationMetadata {
       for (let j = 0; j < initData.values.length; j++) {
         if (initData.values[j].systemId.toLowerCase() === drmSystemId.toLowerCase()) {
           if (!createdObjForType) {
-            const keyIds = this.contentProtections?.keyIds?.map((val) => val.keyId);
+            const keyIds = this.contentProtections?.keyIds;
             filtered.push({
               type: initData.type,
               keyIds,
@@ -330,7 +330,7 @@ class Representation implements IRepresentationMetadata {
     ) {
       return [];
     }
-    const keyIds = this.contentProtections?.keyIds?.map((val) => val.keyId);
+    const keyIds = this.contentProtections?.keyIds;
     return this.contentProtections.initData.map((x) => {
       return { type: x.type, keyIds, values: x.values };
     });
@@ -363,7 +363,7 @@ class Representation implements IRepresentationMetadata {
     let hasUpdatedProtectionData = false;
     if (this.contentProtections === undefined) {
       this.contentProtections = {
-        keyIds: keyId !== undefined ? [{ keyId }] : [],
+        keyIds: keyId !== undefined ? [keyId] : [],
         initData: [{ type: initDataType, values: data }],
       };
       return true;
@@ -372,17 +372,17 @@ class Representation implements IRepresentationMetadata {
     if (keyId !== undefined) {
       const keyIds = this.contentProtections.keyIds;
       if (keyIds === undefined) {
-        this.contentProtections.keyIds = [{ keyId }];
+        this.contentProtections.keyIds = [keyId];
       } else {
         let foundKeyId = false;
         for (const knownKeyId of keyIds) {
-          if (areArraysOfNumbersEqual(knownKeyId.keyId, keyId)) {
+          if (areArraysOfNumbersEqual(knownKeyId, keyId)) {
             foundKeyId = true;
           }
         }
         if (!foundKeyId) {
           log.warn("Manifest: found unanounced key id.");
-          keyIds.push({ keyId });
+          keyIds.push(keyId);
         }
       }
     }

package/src/manifest/utils.ts

@@ -358,6 +358,7 @@ function toVideoRepresentation(
     hdrInfo,
     isSupported,
     decipherable,
+    contentProtections,
   } = representation;
   return {
     id,
@@ -369,6 +370,12 @@ function toVideoRepresentation(
     hdrInfo,
     isCodecSupported: isSupported,
     decipherable,
+    contentProtections:
+      contentProtections !== undefined
+        ? {
+            keyIds: contentProtections.keyIds,
+          }
+        : undefined,
   };
 }
 
@@ -407,9 +414,10 @@ export interface IDecipherabilityStatusChangedElement {
  *     decipherability updated to `undefined`.
  *
  * @param {Object} manifest
- * @param {Array.<Uint8Array>} whitelistedKeyIds
- * @param {Array.<Uint8Array>} blacklistedKeyIds
- * @param {Array.<Uint8Array>} delistedKeyIds
+ * @param {Object} updates
+ * @param {Array.<Uint8Array>} updates.whitelistedKeyIds
+ * @param {Array.<Uint8Array>} updates.blacklistedKeyIds
+ * @param {Array.<Uint8Array>} updates.delistedKeyIds
  */
 export function updateDecipherabilityFromKeyIds(
   manifest: IManifestMetadata,
@@ -428,17 +436,17 @@ export function updateDecipherabilityFromKeyIds(
     if (contentKIDs !== undefined) {
       for (const elt of contentKIDs) {
         for (const blacklistedKeyId of blacklistedKeyIds) {
-          if (areArraysOfNumbersEqual(blacklistedKeyId, elt.keyId)) {
+          if (areArraysOfNumbersEqual(blacklistedKeyId, elt)) {
             return false;
           }
         }
         for (const whitelistedKeyId of whitelistedKeyIds) {
-          if (areArraysOfNumbersEqual(whitelistedKeyId, elt.keyId)) {
+          if (areArraysOfNumbersEqual(whitelistedKeyId, elt)) {
             return true;
           }
         }
         for (const delistedKeyId of delistedKeyIds) {
-          if (areArraysOfNumbersEqual(delistedKeyId, elt.keyId)) {
+          if (areArraysOfNumbersEqual(delistedKeyId, elt)) {
             return undefined;
           }
         }

package/src/parsers/manifest/dash/common/content_protection_parser.ts

@@ -214,13 +214,13 @@ function parseContentProtection(
     contentProtectionIr.attributes.keyId !== undefined &&
     contentProtectionIr.attributes.keyId.length > 0
   ) {
-    const kidObj = { keyId: contentProtectionIr.attributes.keyId, systemId };
+    const kid = contentProtectionIr.attributes.keyId;
     if (representation.contentProtections === undefined) {
-      representation.contentProtections = { keyIds: [kidObj], initData: [] };
+      representation.contentProtections = { keyIds: [kid], initData: [] };
     } else if (representation.contentProtections.keyIds === undefined) {
-      representation.contentProtections.keyIds = [kidObj];
+      representation.contentProtections.keyIds = [kid];
     } else {
-      representation.contentProtections.keyIds.push(kidObj);
+      representation.contentProtections.keyIds.push(kid);
     }
   }
 

package/src/parsers/manifest/local/parse_local_manifest.ts

@@ -169,7 +169,7 @@ function parseRepresentation(
 function formatContentProtections(
   localContentProtections: ILocalContentProtections,
 ): IContentProtections {
-  const keyIds = localContentProtections.keyIds;
+  const keyIds = localContentProtections.keyIds.map((k) => k.keyId);
   const initData: IContentProtectionInitData[] = Object.keys(
     localContentProtections.initData,
   ).map((currType) => {

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

@@ -27,7 +27,6 @@ import { getFilenameIndexInUrl } from "../../../utils/resolve_url";
 import { hexToBytes } from "../../../utils/string_parsing";
 import { createBox } from "../../containers/isobmff";
 import type {
-  IContentProtectionKID,
   IParsedAdaptation,
   IParsedAdaptations,
   IParsedManifest,
@@ -371,15 +370,12 @@ function createSmoothStreamingParser(
         (!isNullOrUndefined(codecs) ? codecs + "-" : "") +
         String(qualityLevel.bitrate);
 
-      const keyIDs: IContentProtectionKID[] = [];
+      const keyIDs: Uint8Array[] = [];
       let firstProtection: IContentProtectionSmooth | undefined;
       if (protections.length > 0) {
         firstProtection = protections[0];
         protections.forEach((protection) => {
-          const keyId = protection.keyId;
-          protection.keySystems.forEach((keySystem) => {
-            keyIDs.push({ keyId, systemId: keySystem.systemId });
-          });
+          keyIDs.push(protection.keyId);
         });
       }
 

package/src/parsers/manifest/types.ts

@@ -39,12 +39,6 @@ export interface IParsedStreamEventData {
   };
 }
 
-/** Describes information about an encryption Key ID of a given media. */
-export interface IContentProtectionKID {
-  keyId: Uint8Array;
-  systemId?: string | undefined;
-}
-
 /**
  * Encryption initialization data.
  * This is the data used to initialize a license request.
@@ -85,7 +79,7 @@ export interface IContentProtections {
    * `undefined` if the key id(s) associated with that content may exist but are
    * not known.
    */
-  keyIds: IContentProtectionKID[] | undefined;
+  keyIds: Uint8Array[] | undefined;
   /** The different encryption initialization data associated with that content. */
   initData: IContentProtectionInitData[];
 }

package/src/public_types.ts

@@ -803,12 +803,50 @@ export interface IRepresentationContext {
  * RxPlayer.
  */
 export interface IAudioRepresentation {
+  /**
+   * Identifier for that Representation.
+   * Might e.g. be used with the `lockVideoRepresentation` API.
+   */
   id: string | number;
+  /** Optional maximum bitrate, in bits per seconds, for this Representation. */
   bitrate?: number | undefined;
+  /** Codec(s) relied on by the media segments of that Representation. */
   codec?: string | undefined;
+  /**
+   * If `true`, this Representation is linked to "spatial audio" technology, such as
+   * Dolby Atmos.
+   * If `false`, it is not linked to such technology.
+   *
+   * If `undefined`, we don't if it is linked to a spatial audio technology or not.
+   */
   isSpatialAudio?: boolean | undefined;
+  /**
+   * If `true`, the codec is known to be supported on the current device.
+   * If `false`, it is known to be unsupported.
+   *
+   * If `undefined`, we don't know yet if it is supported or not.
+   */
   isCodecSupported?: boolean | undefined;
+  /**
+   * If `true`, this Representation is known to be decipherable.
+   * If `false`, it is known to be encrypted and not decipherable.
+   *
+   * If `undefined`, we don't know yet if it is decipherable or not (or if it is
+   * encrypted or not in some cases).
+   */
   decipherable?: boolean | undefined;
+  /**
+   * Encryption information linked to this content.
+   * If set to an Object, the Representation is known to be encrypted.
+   * If unset or set to `undefined` the Representation is either unencrypted or
+   * we don't know if it is.
+   */
+  contentProtections?:
+    | {
+        /** Known key ids linked to that Representation. */
+        keyIds?: Uint8Array[] | undefined;
+      }
+    | undefined;
 }
 
 /** Audio track returned by the RxPlayer. */
@@ -847,15 +885,50 @@ export interface ITextTrack {
  * RxPlayer.
  */
 export interface IVideoRepresentation {
+  /**
+   * Identifier for that Representation.
+   * Might e.g. be used with the `lockVideoRepresentation` API.
+   */
   id: string;
+  /** Optional maximum bitrate, in bits per seconds, for this Representation. */
   bitrate?: number | undefined;
+  /** Defines the width of the Representation in pixels. */
   width?: number | undefined;
+  /** Defines the height of the Representation in pixels. */
   height?: number | undefined;
+  /** Codec(s) relied on by the media segments of that Representation. */
   codec?: string | undefined;
+  /** The frame rate for this Representation, in frame per seconds. */
   frameRate?: number | undefined;
+  /** If the track is HDR, gives the HDR characteristics of the content */
   hdrInfo?: IHDRInformation | undefined;
+  /**
+   * If `true`, the codec is known to be supported on the current device.
+   * If `false`, it is known to be unsupported.
+   *
+   * If `undefined`, we don't know yet if it is supported or not.
+   */
   isCodecSupported?: boolean | undefined;
+  /**
+   * If `true`, this Representation is known to be decipherable.
+   * If `false`, it is known to be encrypted and not decipherable.
+   *
+   * If `undefined`, we don't know yet if it is decipherable or not (or if it is
+   * encrypted or not in some cases).
+   */
   decipherable?: boolean | undefined;
+  /**
+   * Encryption information linked to this content.
+   * If set to an Object, the Representation is known to be encrypted.
+   * If unset or set to `undefined` the Representation is either unencrypted or
+   * we don't know if it is.
+   */
+  contentProtections?:
+    | {
+        /** Known key ids linked to that Representation. */
+        keyIds?: Uint8Array[] | undefined;
+      }
+    | undefined;
 }
 
 /** Video track returned by the RxPlayer. */

package/src/utils/are_codecs_compatible.ts

@@ -35,7 +35,11 @@ function areCodecsCompatible(a: string, b: string): boolean {
   if (codecsA === "" || codecsB === "") {
     return false;
   }
-  if (codecsA.split(".")[0] !== codecsB.split(".")[0]) {
+  let initialPartA = codecsA.split(".")[0];
+  initialPartA = initialPartA === "hev1" ? "hvc1" : initialPartA;
+  let initialPartB = codecsB.split(".")[0];
+  initialPartB = initialPartB === "hev1" ? "hvc1" : initialPartB;
+  if (initialPartA !== initialPartB) {
     return false;
   }
   return true;

package/vitest.config.mjs

@@ -91,6 +91,7 @@ export default defineConfig({
     globals: false,
     reporters: "dot",
     include: ["tests/**/*.[jt]s?(x)"],
+    exclude: ["tests/performance/**/*.[jt]s?(x)"],
     globalSetup: "tests/contents/server.mjs",
     browser: getBrowserConfig(process.env.BROWSER_CONFIG),
   },