EME key-status cleanup (Multi-key handling #7517)

Get KEYID from init segment 'tenc' when not found elsewhere Fixes #7541
Remove key-loader promise caching for EME keys
Add MediaKeySessionClosedReason result to eme-controller removeSession (fixes close spy on MediaKeysSessionMock)

Author: robwalch

api-extractor/report/hls.js.api.md

@@ -4,6 +4,8 @@
 
 ```ts
 
+import { EventEmitter } from 'eventemitter3';
+
 // Warning: (ae-missing-release-tag) "AbrComponentAPI" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -1138,10 +1140,9 @@ export const enum DecrypterAesMode {
 export type DRMSystemConfiguration = {
     licenseUrl: string;
     serverCertificateUrl?: string;
-    generateRequest?: (this: Hls, initDataType: string, initData: ArrayBuffer | null, keyContext: MediaKeySessionContextAndLevelKey) => {
-        initDataType: string;
-        initData: ArrayBuffer | null;
-    } | undefined | never;
+    generateRequest?: (this: Hls, initDataType: string, initData: ArrayBuffer | null, keyContext: MediaKeySessionContext & {
+        decryptdata: LevelKey;
+    }) => GenerateRequestFilterResult;
 };
 
 // Warning: (ae-missing-release-tag) "DRMSystemOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -1206,15 +1207,13 @@ export class EMEController extends Logger implements ComponentAPI {
     // (undocumented)
     destroy(): void;
     // (undocumented)
-    getKeyStatus(decryptdata: LevelKey): MediaKeyStatus | undefined;
-    // (undocumented)
-    getKeySystemAccess(keySystemsToAttempt: KeySystems[]): Promise<void>;
-    // (undocumented)
-    getSelectedKeySystemFormats(): KeySystemFormats[];
+    loadClear(loadingFrag: Fragment, encryptedFragments: Fragment[], startFragRequested: boolean): Promise<void> | null;
+    // Warning: (ae-forgotten-export) The symbol "EncryptedFragment" needs to be exported by the entry point hls.d.ts
+    //
     // (undocumented)
-    loadKey(data: KeyLoadedData): Promise<MediaKeySessionContext>;
+    loadKey(frag: EncryptedFragment): Promise<LevelKey>;
     // (undocumented)
-    selectKeySystem(keySystemsToAttempt: KeySystems[]): Promise<KeySystemFormats>;
+    renewKeySession(levelKey: LevelKey): void;
     // (undocumented)
     selectKeySystemFormat(frag: Fragment): Promise<KeySystemFormats>;
 }
@@ -1223,8 +1222,12 @@ export class EMEController extends Logger implements ComponentAPI {
 //
 // @public (undocumented)
 export type EMEControllerConfig = {
-    licenseXhrSetup?: (this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContextAndLevelKey, licenseChallenge: Uint8Array) => void | Uint8Array | Promise<Uint8Array | void>;
-    licenseResponseCallback?: (this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContextAndLevelKey) => ArrayBuffer;
+    licenseXhrSetup?: (this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContext & {
+        decryptdata: LevelKey;
+    }, licenseChallenge: Uint8Array) => void | Uint8Array | Promise<Uint8Array | void>;
+    licenseResponseCallback?: (this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContext & {
+        decryptdata: LevelKey;
+    }) => ArrayBuffer;
     emeEnabled: boolean;
     widevineLicenseUrl?: string;
     drmSystems: DRMSystemsConfiguration | undefined;
@@ -2054,6 +2057,14 @@ export type GapControllerConfig = {
     skipBufferHolePadding: number;
 };
 
+// Warning: (ae-missing-release-tag) "GenerateRequestFilterResult" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type GenerateRequestFilterResult = {
+    initDataType: string;
+    initData: ArrayBuffer | null;
+} | undefined | never;
+
 // Warning: (ae-missing-release-tag) "HdcpLevel" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -3038,28 +3049,13 @@ export class KeyLoader extends Logger implements ComponentAPI {
     // (undocumented)
     abort(type?: PlaylistLevelType): void;
     // (undocumented)
-    createKeyLoadError(frag: Fragment, details: ErrorDetails | undefined, error: Error, networkDetails?: NullableNetworkDetails, response?: {
-        url: string;
-        data: undefined;
-        code: number;
-        text: string;
-    }): LoadError;
-    // (undocumented)
     destroy(): void;
     // (undocumented)
-    detach(): void;
-    // (undocumented)
     emeController: EMEController | null;
     // (undocumented)
     load(frag: Fragment): Promise<KeyLoadedData>;
     // (undocumented)
-    loadClear(loadingFrag: Fragment, encryptedFragments: Fragment[], startFragRequested: boolean): null | Promise<void>;
-    // (undocumented)
-    loadInternal(frag: Fragment, keySystemFormat?: KeySystemFormats): Promise<KeyLoadedData>;
-    // (undocumented)
-    loadKeyEME(keyInfo: KeyLoaderInfo, frag: Fragment): Promise<KeyLoadedData>;
-    // (undocumented)
-    loadKeyHTTP(keyInfo: KeyLoaderInfo, frag: Fragment): Promise<KeyLoadedData>;
+    loadClear(loadingFrag: Fragment, encryptedFragments: Fragment[], startFragRequested: boolean): Promise<void> | null;
 }
 
 // Warning: (ae-missing-release-tag) "KeyLoaderContext" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -3079,11 +3075,9 @@ export interface KeyLoaderInfo {
     // (undocumented)
     decryptdata: LevelKey;
     // (undocumented)
-    keyLoadPromise: Promise<KeyLoadedData> | null;
+    keyLoadPromise?: Promise<KeyLoadedData> | null;
     // (undocumented)
-    loader: Loader<KeyLoaderContext> | null;
-    // (undocumented)
-    mediaKeySessionContext: MediaKeySessionContext | null;
+    loader?: Loader<KeyLoaderContext> | null;
 }
 
 // Warning: (ae-missing-release-tag) "KeyLoadingData" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -3094,6 +3088,20 @@ export interface KeyLoadingData {
     frag: Fragment;
 }
 
+// Warning: (ae-missing-release-tag) "KeyRequests" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type KeyRequests = {
+    [uri: string]: LicenseAndKeysRequest | undefined;
+};
+
+// Warning: (ae-missing-release-tag) "KeyStatuses" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type KeyStatuses = {
+    [keyId: string]: MediaKeyStatus;
+};
+
 // Warning: (ae-missing-release-tag) "KeySystemFormats" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -3122,6 +3130,13 @@ export const enum KeySystems {
     WIDEVINE = "com.widevine.alpha"
 }
 
+// Warning: (ae-missing-release-tag) "KeyTimeouts" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type KeyTimeouts = {
+    [keyId: string]: number;
+};
+
 // Warning: (ae-missing-release-tag) "LatencyControllerConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -3605,6 +3620,20 @@ export interface LevelUpdatedData {
     level: number;
 }
 
+// Warning: (ae-missing-release-tag) "LicenseAndKeysRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type LicenseAndKeysRequest = EventEmitter & {
+    status: 'initialized' | 'started' | 'generated' | MediaKeyMessageType;
+    licenseXhr?: XMLHttpRequest;
+    requestErrors: {
+        status: number;
+        message: string;
+    }[];
+    onmessage?: (this: MediaKeySession, ev: MediaKeyMessageEvent) => any;
+    onkeystatuseschange?: (this: MediaKeySession, ev: Event) => any;
+};
+
 // Warning: (ae-missing-release-tag) "LiveBackBufferData" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public @deprecated (undocumented)
@@ -4044,47 +4073,13 @@ export type MediaKeyFunc = (keySystem: KeySystems, supportedConfigurations: Medi
 // Warning: (ae-missing-release-tag) "MediaKeySessionContext" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export interface MediaKeySessionContext {
-    // (undocumented)
-    keyStatuses: {
-        [keyId: string]: MediaKeyStatus;
-    };
-    // (undocumented)
-    keyStatusTimeouts?: {
-        [keyId: string]: number;
-    };
-    // (undocumented)
-    keySystem: KeySystems;
-    // (undocumented)
-    levelKeys: LevelKey[];
-    // (undocumented)
-    licenseXhr?: XMLHttpRequest;
-    // (undocumented)
-    mediaKeys: MediaKeys;
-    // (undocumented)
-    mediaKeysSession: MediaKeySession;
-    // (undocumented)
-    _onkeystatuseschange?: (this: MediaKeySession, ev: Event) => any;
-    // (undocumented)
-    _onmessage?: (this: MediaKeySession, ev: MediaKeyMessageEvent) => any;
-}
-
-// Warning: (ae-missing-release-tag) "MediaKeySessionContextAndLevelKey" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
-export type MediaKeySessionContextAndLevelKey = {
-    decryptdata: LevelKey;
+export type MediaKeySessionContext = {
     keySystem: KeySystems;
-    levelKeys: LevelKey[];
     mediaKeys: MediaKeys;
     mediaKeysSession: MediaKeySession;
-    keyStatuses: {
-        [keyId: string]: MediaKeyStatus;
-    };
-    keyStatusTimeouts?: {
-        [keyId: string]: number;
-    };
-    licenseXhr?: XMLHttpRequest;
+    keyRequests: KeyRequests;
+    keyStatuses: KeyStatuses;
+    keyStatusTimeouts?: KeyTimeouts;
 };
 
 // Warning: (ae-missing-release-tag) "MediaOverrides" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)

src/config.ts

@@ -18,8 +18,12 @@ import { requestMediaKeySystemAccess } from './utils/mediakeys-helper';
 import { clamp } from './utils/number';
 import { stringify } from './utils/safe-json-stringify';
 import XhrLoader from './utils/xhr-loader';
-import type { MediaKeySessionContextAndLevelKey } from './controller/eme-controller';
+import type {
+  GenerateRequestFilterResult,
+  MediaKeySessionContext,
+} from './controller/eme-controller';
 import type Hls from './hls';
+import type { LevelKey } from './loader/level-key';
 import type {
   FragmentLoaderContext,
   Loader,
@@ -95,11 +99,8 @@ export type DRMSystemConfiguration = {
     this: Hls,
     initDataType: string,
     initData: ArrayBuffer | null,
-    keyContext: MediaKeySessionContextAndLevelKey,
-  ) =>
-    | { initDataType: string; initData: ArrayBuffer | null }
-    | undefined
-    | never;
+    keyContext: MediaKeySessionContext & { decryptdata: LevelKey },
+  ) => GenerateRequestFilterResult;
 };
 
 export type DRMSystemsConfiguration = Partial<
@@ -111,14 +112,14 @@ export type EMEControllerConfig = {
     this: Hls,
     xhr: XMLHttpRequest,
     url: string,
-    keyContext: MediaKeySessionContextAndLevelKey,
+    keyContext: MediaKeySessionContext & { decryptdata: LevelKey },
     licenseChallenge: Uint8Array,
   ) => void | Uint8Array | Promise<Uint8Array | void>;
   licenseResponseCallback?: (
     this: Hls,
     xhr: XMLHttpRequest,
     url: string,
-    keyContext: MediaKeySessionContextAndLevelKey,
+    keyContext: MediaKeySessionContext & { decryptdata: LevelKey },
   ) => ArrayBuffer;
   emeEnabled: boolean;
   widevineLicenseUrl?: string;

src/controller/base-stream-controller.ts

@@ -349,9 +349,6 @@ export default class BaseStreamController
     removeEventListener(media, 'seeking', this.onMediaSeeking);
     removeEventListener(media, 'ended', this.onMediaEnded);
 
-    if (this.keyLoader && !transferringMedia) {
-      this.keyLoader.detach();
-    }
     this.media = this.mediaBuffer = null;
     this.loopSn = undefined;
     if (transferringMedia) {