Fix "sinf" type argumet in request generated from "encrypted" event

Author: robwalch

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

@@ -3452,6 +3452,8 @@ export class LevelKey implements DecryptData {
     // (undocumented)
     pssh: Uint8Array<ArrayBuffer> | null;
     // (undocumented)
+    scheme?: string;
+    // (undocumented)
     static setKeyIdForUri(uri: string, keyId: Uint8Array<ArrayBuffer>): void;
     // (undocumented)
     readonly uri: string;
@@ -4091,6 +4093,11 @@ export type MediaKeySessionContext = {
     keyRequests: KeyRequests;
     keyStatuses: KeyStatuses;
     keyStatusTimeouts?: KeyTimeouts;
+    createdFor: {
+        levelKey: LevelKey;
+        reason: LicenseRequestReason;
+    };
+    initialized: boolean;
 };
 
 // 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/controller/eme-controller.ts

@@ -94,6 +94,8 @@ export type MediaKeySessionContext = {
   keyRequests: KeyRequests;
   keyStatuses: KeyStatuses;
   keyStatusTimeouts?: KeyTimeouts;
+  createdFor: { levelKey: LevelKey; reason: LicenseRequestReason };
+  initialized: boolean;
 };
 
 export class EMEKeyError extends Error {
@@ -340,20 +342,32 @@ class EMEController extends Logger implements ComponentAPI {
     levelKey: LevelKey,
     reason: LicenseRequestReason,
   ): MediaKeySessionContext {
-    this.log(
-      `Creating key-system session "${keySystem}" keyId: ${arrayToHex(
-        levelKey.keyId || ([] as number[]),
-      )} keyUri: ${levelKey.uri} for "${reason}"`,
-    );
+    const { mediaKeySessions } = this;
+    const message = ` key-system session "${keySystem}" keyId: ${arrayToHex(
+      levelKey.keyId || ([] as number[]),
+    )} keyUri: ${levelKey.uri} for "${reason}"`;
+    for (let i = 0; i < mediaKeySessions.length; i++) {
+      const context = mediaKeySessions[i];
+      if (
+        !context.initialized &&
+        context.createdFor.levelKey.uri === levelKey.uri
+      ) {
+        this.log(`Retrieved${message}`);
+        return context;
+      }
+    }
+    this.log(`Creating${message}`);
     const mediaKeysSession = mediaKeys.createSession();
     const mediaKeySessionContext: MediaKeySessionContext = {
       keySystem,
       mediaKeys,
       mediaKeysSession,
       keyRequests: {},
       keyStatuses: {},
+      createdFor: { levelKey, reason },
+      initialized: false,
     };
-    this.mediaKeySessions.push(mediaKeySessionContext);
+    mediaKeySessions.push(mediaKeySessionContext);
     return mediaKeySessionContext;
   }
 
@@ -600,7 +614,7 @@ class EMEController extends Logger implements ComponentAPI {
           .then((keySessionContext) => {
             this.throwIfDestroyed();
             // Create key-request, session message event listener, key-status listeners
-            const scheme = 'cenc';
+            const scheme = levelKey.scheme || 'cenc';
             const initData = levelKey.pssh ? levelKey.pssh.buffer : null;
             return this.generateRequestWithPreferredKeySession(
               keySessionContext,
@@ -757,6 +771,7 @@ class EMEController extends Logger implements ComponentAPI {
                 decryptdata.uri.replace(/-/g, '').indexOf(keyIdHex) !== -1)
             ) {
               if (!decryptdata.pssh) {
+                decryptdata.scheme = initDataType;
                 decryptdata.pssh = new Uint8Array(initData);
                 decryptdata.keyId = keyId;
                 LevelKey.setKeyIdForUri(decryptdata.uri, keyId);
@@ -771,6 +786,7 @@ class EMEController extends Logger implements ComponentAPI {
         }
         if (!keySessionContextPromise) {
           if (levelKeys.length) {
+            levelKeys[0].scheme ||= initDataType;
             levelKeys[0].pssh ||= new Uint8Array(initData);
             return this.getSessionForKey(
               levelKeys[0],
@@ -863,6 +879,9 @@ class EMEController extends Logger implements ComponentAPI {
             'Invalid response from configured generateRequest filter',
           );
         }
+        levelKey.scheme = mappedInitData.initDataType
+          ? mappedInitData.initDataType
+          : 'cenc';
         const pssh = mappedInitData.initData ? mappedInitData.initData : null;
         levelKey.pssh = pssh ? new Uint8Array(pssh) : null;
         return mappedInitData;
@@ -894,6 +913,12 @@ class EMEController extends Logger implements ComponentAPI {
       initDataType = mappedInitData.initDataType;
     }
 
+    if (!reason.startsWith('encrypted-event')) {
+      this.log(`Skipping key-session request for "${reason}" (no initData)`);
+      // resolve key so that media is appended and initData is received in "encrypted" event
+      return Promise.resolve(context);
+    }
+
     if (initData === null) {
       if (reason.startsWith('encrypted-event')) {
         return Promise.reject(
@@ -1099,6 +1124,7 @@ class EMEController extends Logger implements ComponentAPI {
     );
 
     requestEmitter.status = 'started';
+    context.initialized = true;
     return context.mediaKeysSession
       .generateRequest(initDataType, initData)
       .then(() => {

src/loader/level-key.ts

@@ -33,6 +33,7 @@ export class LevelKey implements DecryptData {
   public key: Uint8Array<ArrayBuffer> | null = null;
   public keyId: Uint8Array<ArrayBuffer> | null = null;
   public pssh: Uint8Array<ArrayBuffer> | null = null;
+  public scheme?: string;
 
   static clearKeyUriToKeyIdMap() {
     keyUriToKeyIdMap = {};
@@ -221,9 +222,8 @@ export class LevelKey implements DecryptData {
       if (keyId) {
         this.keyId = keyId;
         LevelKey.setKeyIdForUri(this.uri, keyId);
-      } else {
-        this.keyId = LevelKey.addKeyIdForUri(this.uri);
       }
+      // else if the key id could not be identified from the playlist, wait for the init segment
     }
 
     return this;

tests/unit/controller/eme-controller.ts

@@ -387,12 +387,15 @@ describe('EMEController', function () {
     });
 
     const keySession = new MediaKeySessionMock2();
+    const levelKey = getParsedLevelKey();
     const mockMediaKeySessionContext: MediaKeySessionContext = {
       keySystem: KeySystems.FAIRPLAY,
       mediaKeys: new MediaKeysMock(),
       mediaKeysSession: keySession,
       keyRequests: {},
       keyStatuses: {},
+      createdFor: { levelKey, reason: 'playlist-key' },
+      initialized: false,
     };
 
     const keyStatuses = emeController.getKeyStatuses(
@@ -610,12 +613,15 @@ describe('EMEController', function () {
     });
 
     const keySession = new MediaKeySessionMock();
+    const levelKey = getParsedLevelKey();
     const mockMediaKeySessionContext: MediaKeySessionContext = {
       keySystem: KeySystems.FAIRPLAY,
       mediaKeys: new MediaKeysMock(),
       mediaKeysSession: keySession,
       keyRequests: {},
       keyStatuses: {},
+      createdFor: { levelKey, reason: 'playlist-key' },
+      initialized: false,
     };
 
     emeController.mediaKeySessions = [mockMediaKeySessionContext];
@@ -655,12 +661,15 @@ describe('EMEController', function () {
     });
 
     const keySession = new MediaKeySessionMock();
+    const levelKey = getParsedLevelKey();
     const mockMediaKeySessionContext: MediaKeySessionContext = {
       keySystem: KeySystems.FAIRPLAY,
       mediaKeys: new MediaKeysMock(),
       mediaKeysSession: keySession,
       keyRequests: {},
       keyStatuses: {},
+      createdFor: { levelKey, reason: 'playlist-key' },
+      initialized: false,
     };
     const keySessionCloseSpy = sinon.spy(keySession, 'close');
 
@@ -712,12 +721,15 @@ describe('EMEController', function () {
     });
 
     const keySession = new MediaKeySessionMock();
+    const levelKey = getParsedLevelKey();
     const mockMediaKeySessionContext: MediaKeySessionContext = {
       keySystem: KeySystems.FAIRPLAY,
       mediaKeys: new MediaKeysMock(),
       mediaKeysSession: keySession,
       keyRequests: {},
       keyStatuses: {},
+      createdFor: { levelKey, reason: 'playlist-key' },
+      initialized: false,
     };
     const keySessionCloseSpy = sinon.spy(keySession, 'close');