rx-player 4.5.0-dev.2026012301 → 4.5.0-dev.2026012302

package/dist/commonjs/main_thread/decrypt/content_decryptor.d.ts

@@ -0,0 +1,240 @@
+/**
+ * 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 type { IMediaElement } from "../../compat/browser_compatibility_types";
+import type { IEmeApiImplementation } from "../../compat/eme";
+import type { IKeySystemOption } from "../../public_types";
+import EventEmitter from "../../utils/event_emitter";
+import type { IProtectionData, IProcessedProtectionData, IContentDecryptorEvent } from "./types";
+import { ContentDecryptorState } from "./types";
+import type KeySessionRecord from "./utils/key_session_record";
+/**
+ * Module communicating with the Content Decryption Module (or CDM) to be able
+ * to decrypt contents.
+ *
+ * The `ContentDecryptor` starts communicating with the CDM, to initialize the
+ * key system, as soon as it is created.
+ *
+ * You can be notified of various events, such as fatal errors, by registering
+ * to one of its multiple events (@see IContentDecryptorEvent).
+ *
+ * @class ContentDecryptor
+ */
+export default class ContentDecryptor extends EventEmitter<IContentDecryptorEvent> {
+    /**
+     * Hexadecimal id identifying the currently-chosen key system.
+     * `undefined` if not known or if the key system hasn't been initialized yet.
+     *
+     * When providing protection initialization data to the ContentDecryptor, you
+     * may only provide those linked to that system id. You can also provide all
+     * available protection initialization data, in which case it will be
+     * automatically filtered.
+     *
+     * This `systemId` may only be known once the `ReadyForContent` state (@see
+     * ContentDecryptorState) is reached, and even then, it may still be unknown,
+     * in which case it will stay to `undefined`.
+     */
+    systemId: string | undefined;
+    /**
+     * Set only if the `ContentDecryptor` failed on an error.
+     * The corresponding Error.
+     */
+    error: Error | null;
+    /**
+     * State of the ContentDecryptor (@see ContentDecryptorState) and associated
+     * data.
+     *
+     * The ContentDecryptor goes into a series of steps as it is initializing.
+     * This private property stores the current state and the potentially linked
+     * data.
+     */
+    private _stateData;
+    /**
+     * Currently-chosen EME API implementation.
+     */
+    private _eme;
+    /**
+     * Contains information about all key sessions loaded for this current
+     * content.
+     * This object is most notably used to check which keys are already obtained,
+     * thus avoiding to perform new unnecessary license requests and CDM interactions.
+     */
+    private _currentSessions;
+    /**
+     * Allows to dispose the resources taken by the current instance of the
+     * ContentDecryptor.
+     */
+    private _canceller;
+    /**
+     * This queue stores initialization data which hasn't been processed yet,
+     * probably because the "queue is locked" for now. (@see _stateData private
+     * property).
+     *
+     * For example, this queue stores initialization data communicated while
+     * initializing so it can be processed when the initialization is done.
+     */
+    private _initDataQueue;
+    /**
+     * Store the list of supported codecs with the current key system configuration.
+     */
+    private _supportedCodecWhenEncrypted;
+    /**
+     * Create a new `ContentDecryptor`, and initialize its decryption capabilities
+     * right away.
+     * Goes into the `WaitingForAttachment` state once that initialization is
+     * done, after which you should call the `attach` method when you're ready for
+     * those decryption capabilities to be attached to the HTMLMediaElement.
+     *
+     * @param {Object} eme - current EME implementation
+     * @param {HTMLMediaElement} mediaElement - The MediaElement which will be
+     * associated to a MediaKeys object
+     * @param {Array.<Object>} ksOptions - key system configuration.
+     * The `ContentDecryptor` can be given one or multiple key system
+     * configurations. It will choose the appropriate one depending on user
+     * settings and browser support.
+     */
+    constructor(eme: IEmeApiImplementation, mediaElement: IMediaElement, ksOptions: IKeySystemOption[]);
+    /**
+     * Returns the current state of the ContentDecryptor.
+     * @see ContentDecryptorState
+     * @returns {Object}
+     */
+    getState(): ContentDecryptorState;
+    /**
+     * Attach the current decryption capabilities to the HTMLMediaElement.
+     * This method should only be called once the `ContentDecryptor` is in the
+     * `WaitingForAttachment` state.
+     *
+     * You might want to first set the HTMLMediaElement's `src` attribute before
+     * calling this method, and only push data to it once the `ReadyForContent`
+     * state is reached, for compatibility reasons.
+     */
+    attach(): void;
+    /**
+     * Stop this `ContentDecryptor` instance:
+     *   - stop listening and reacting to the various event listeners
+     *   - abort all operations.
+     *
+     * Once disposed, a `ContentDecryptor` cannot be used anymore.
+     * @param {string | undefined} reason - Human-inspectable reason behind the
+     * dispose. Used for debugging matters, especially for debug log
+     * inspection.
+     */
+    dispose(reason: string | undefined): void;
+    /**
+     * Returns `true` if the given mimeType and codec couple should be supported
+     * by the current key system.
+     * Returns `false` if it isn't.
+     *
+     * Returns `undefined` if we cannot determine if it is supported.
+     *
+     * @param {string} mimeType
+     * @param {string} codec
+     * @returns {boolean}
+     */
+    isCodecSupported(mimeType: string, codec: string): boolean | undefined;
+    /**
+     * Method to call when new protection initialization data is encounted on the
+     * content.
+     *
+     * When called, the `ContentDecryptor` will try to obtain the decryption key
+     * if not already obtained.
+     *
+     * @param {Object} initializationData
+     */
+    onInitializationData(initializationData: IProtectionData): void;
+    /**
+     * Async logic run each time new initialization data has to be processed.
+     * The promise return may reject, in which case a fatal error should be linked
+     * the current `ContentDecryptor`.
+     *
+     * The Promise's resolution however provides no semantic value.
+     * @param {Object} initializationData
+     * @returns {Promise.<void>}
+     */
+    private _processInitializationData;
+    private _tryToUseAlreadyCreatedSession;
+    /**
+     * Remove the session corresponding to the initData provided, and close it.
+     * It does nothing if no session was found for this initData.
+     * @param {Object} initData : The initialization data corresponding to the session
+     * that need to be removed
+     * @param {Object} mediaKeysData : The media keys data
+     */
+    private removeSessionForInitData;
+    /**
+     * Callback that should be called if an error that made the current
+     * `ContentDecryptor` instance unusable arised.
+     * This callbacks takes care of resetting state and sending the right events.
+     *
+     * Once called, no further actions should be taken.
+     *
+     * @param {*} err - The error object which describes the issue. Will be
+     * formatted and sent in an "error" event.
+     */
+    private _onFatalError;
+    /**
+     * Return `true` if the `ContentDecryptor` has either been disposed or
+     * encountered a fatal error which made it stop.
+     * @returns {boolean}
+     */
+    private _isStopped;
+    /**
+     * Start processing the next initialization data of the `_initDataQueue` if it
+     * isn't lock.
+     */
+    private _processCurrentInitDataQueue;
+    /**
+     * Lock new initialization data (from the `_initDataQueue`) from being
+     * processed until `_unlockInitDataQueue` is called.
+     *
+     * You may want to call this method when performing operations which may have
+     * an impact on the handling of other initialization data.
+     */
+    private _lockInitDataQueue;
+    /**
+     * Unlock `_initDataQueue` and start processing the first element.
+     *
+     * Should have no effect if the `_initDataQueue` was not locked.
+     */
+    private _unlockInitDataQueue;
+}
+/**
+ * Return the list of key IDs present in the `expectedKeyIds` array
+ * but that are not present in `actualKeyIds`.
+ * @param {Uint8Array[]} expectedKeyIds - Array of key IDs expected to be found.
+ * @param {Uint8Array[]} actualKeyIds - Array of key IDs to test.
+ * @returns {Uint8Array[]} An array of key IDs that are missing from `actualKeyIds`.
+ */
+export declare function getMissingKeyIds(expectedKeyIds: Uint8Array[], actualKeyIds: Uint8Array[]): Uint8Array[];
+/**
+ * Returns an array of all key IDs that are known by the `KeySessionRecord`
+ * but are missing in the provided array of key IDs `newKeyIds`.
+ * @param {KeySessionRecord} keySessionRecord - The KeySessionRecord containing known key IDs.
+ * @param {Uint8Array[]} newKeyIds - Array of key IDs.
+ * @returns {Uint8Array[]} An array of key IDs that are known by the `keySessionRecord`
+ *                          but are missing in the license.
+ */
+export declare function getMissingKnownKeyIds(keySessionRecord: KeySessionRecord, newKeyIds: Uint8Array[]): Uint8Array[];
+/**
+ * Returns an array of all key IDs that are present in InitData
+ * but are missing in the provided array of key IDs `newKeyIds`.
+ * @param {IProcessedProtectionData} initializationData - The initialization data containing key IDs.
+ * @param {Uint8Array[]} newKeyIds - Array of key IDs.
+ * @returns {Uint8Array[]} An array of key IDs that are present in initializationData
+ *                          but are missing in the license.
+ */
+export declare function getMissingInitDataKeyIds(initializationData: IProcessedProtectionData, newKeyIds: Uint8Array[]): Uint8Array[];
+//# sourceMappingURL=content_decryptor.d.ts.map

package/dist/commonjs/main_thread/decrypt/content_decryptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content_decryptor.d.ts","sourceRoot":"","sources":["../../../../src/main_thread/decrypt/content_decryptor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EACV,aAAa,EAGd,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAM9D,OAAO,KAAK,EAAE,gBAAgB,EAAgB,MAAM,oBAAoB,CAAC;AAIzE,OAAO,YAAY,MAAM,2BAA2B,CAAC;AAcrD,OAAO,KAAK,EACV,eAAe,EAEf,wBAAwB,EACxB,sBAAsB,EACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EAA8B,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAU5E,OAAO,KAAK,gBAAgB,MAAM,4BAA4B,CAAC;AAG/D;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,YAAY,CAAC,sBAAsB,CAAC;IAChF;;;;;;;;;;;;OAYG;IACI,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC;;;OAGG;IACI,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE3B;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,CAA6B;IAE/C;;OAEG;IACH,OAAO,CAAC,IAAI,CAAwB;IAEpC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB,CAAuB;IAE/C;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAgB;IAElC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc,CAAoB;IAE1C;;OAEG;IACH,OAAO,CAAC,4BAA4B,CAAoB;IAExD;;;;;;;;;;;;;;OAcG;gBAED,GAAG,EAAE,qBAAqB,EAC1B,YAAY,EAAE,aAAa,EAC3B,SAAS,EAAE,gBAAgB,EAAE;IAwE/B;;;;OAIG;IACI,QAAQ,IAAI,qBAAqB;IAIxC;;;;;;;;OAQG;IACI,MAAM,IAAI,IAAI;IAyFrB;;;;;;;;;OASG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAYzC;;;;;;;;;;OAUG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAiB7E;;;;;;;;OAQG;IACI,oBAAoB,CAAC,kBAAkB,EAAE,eAAe,GAAG,IAAI;IAqBtE;;;;;;;;OAQG;YACW,0BAA0B;IA0TxC,OAAO,CAAC,8BAA8B;IA6ItC;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAoChC;;;;;;;;;OASG;IACH,OAAO,CAAC,aAAa;IAuBrB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAOlB;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAUpC;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;CAQ7B;AA0BD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,cAAc,EAAE,UAAU,EAAE,EAC5B,YAAY,EAAE,UAAU,EAAE,GACzB,UAAU,EAAE,CAId;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,gBAAgB,EAAE,gBAAgB,EAClC,SAAS,EAAE,UAAU,EAAE,GACtB,UAAU,EAAE,CAWd;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,wBAAwB,EAC5C,SAAS,EAAE,UAAU,EAAE,GACtB,UAAU,EAAE,CAed"}