Enable key status handling for streams that do not provide DRM information the manifest but rely on the pssh boxes (Dash-Industry-Forum#4734)

Author: dsilhavy

index.d.ts

@@ -4127,7 +4127,7 @@ declare namespace dashjs {
 
         getSupportedKeySystemMetadataFromContentProtection(cps: object[], protDataSet: ProtectionDataSet, sessionType: string): object[];
 
-        getSupportedKeySystemsFromSegmentPssh(initData: ArrayBuffer, protDataSet: ProtectionDataSet, sessionType: string): object[];
+        getSupportedKeySystemMetadataFromSegmentPssh(initData: ArrayBuffer, protDataSet: ProtectionDataSet, sessionType: string): object[];
 
         initDataEquals(initData1: ArrayBuffer, initData2: ArrayBuffer): boolean;
 

src/streaming/protection/controllers/ProtectionController.js

@@ -1053,54 +1053,56 @@ function ProtectionController(config) {
      * @private
      */
     function _onNeedKey(event, retry) {
-        if (!settings.get().streaming.protection.ignoreEmeEncryptedEvent) {
-            logger.debug('DRM: onNeedKey');
+        if (settings.get().streaming.protection.ignoreEmeEncryptedEvent) {
+            return
+        }
 
-            // Ignore non-cenc initData
-            if (event.key.initDataType !== ProtectionConstants.INITIALIZATION_DATA_TYPE_CENC) {
-                logger.warn('DRM:  Only \'cenc\' initData is supported!  Ignoring initData of type: ' + event.key.initDataType);
-                return;
-            }
+        logger.debug('DRM: onNeedKey');
 
-            if (mediaInfoArr.length === 0) {
-                logger.warn('DRM: onNeedKey called before initializeForMedia, wait until initialized');
-                retry = typeof retry === 'undefined' ? 1 : retry + 1;
-                if (retry < NEEDKEY_BEFORE_INITIALIZE_RETRIES) {
-                    needkeyRetries.push(setTimeout(() => {
-                        _onNeedKey(event, retry);
-                    }, NEEDKEY_BEFORE_INITIALIZE_TIMEOUT));
-                    return;
-                }
-            }
+        // Ignore non-cenc initData
+        if (event.key.initDataType !== ProtectionConstants.INITIALIZATION_DATA_TYPE_CENC) {
+            logger.warn('DRM:  Only \'cenc\' initData is supported!  Ignoring initData of type: ' + event.key.initDataType);
+            return;
+        }
 
-            // Some browsers return initData as Uint8Array (IE), some as ArrayBuffer (Chrome).
-            // Convert to ArrayBuffer
-            let abInitData = event.key.initData;
-            if (ArrayBuffer.isView(abInitData)) {
-                abInitData = abInitData.buffer;
+        if (mediaInfoArr.length === 0) {
+            logger.warn('DRM: onNeedKey called before initializeForMedia, wait until initialized');
+            retry = typeof retry === 'undefined' ? 1 : retry + 1;
+            if (retry < NEEDKEY_BEFORE_INITIALIZE_RETRIES) {
+                needkeyRetries.push(setTimeout(() => {
+                    _onNeedKey(event, retry);
+                }, NEEDKEY_BEFORE_INITIALIZE_TIMEOUT));
+                return;
             }
+        }
 
-            // If key system has already been selected and initData already seen, then do nothing
-            if (selectedKeySystem) {
-                const initDataForKS = CommonEncryption.getPSSHForKeySystem(selectedKeySystem, abInitData);
-                if (initDataForKS) {
-                    // Check for duplicate initData
-                    if (_isInitDataDuplicate(initDataForKS)) {
-                        return;
-                    }
+        // Some browsers return initData as Uint8Array (IE), some as ArrayBuffer (Chrome).
+        // Convert to ArrayBuffer
+        let abInitData = event.key.initData;
+        if (ArrayBuffer.isView(abInitData)) {
+            abInitData = abInitData.buffer;
+        }
+
+        // If key system has already been selected and initData already seen, then do nothing
+        if (selectedKeySystem) {
+            const initDataForKS = CommonEncryption.getPSSHForKeySystem(selectedKeySystem, abInitData);
+            if (initDataForKS) {
+                // Check for duplicate initData
+                if (_isInitDataDuplicate(initDataForKS)) {
+                    return;
                 }
             }
+        }
 
-            logger.debug('DRM: initData:', String.fromCharCode.apply(null, new Uint8Array(abInitData)));
+        logger.debug('DRM: initData:', String.fromCharCode.apply(null, new Uint8Array(abInitData)));
 
-            const supportedKs = protectionKeyController.getSupportedKeySystemsFromSegmentPssh(abInitData, applicationProvidedProtectionData, sessionType);
-            if (supportedKs.length === 0) {
-                logger.debug('DRM: Received needkey event with initData, but we don\'t support any of the key systems!');
-                return;
-            }
-
-            _handleKeySystemFromPssh(supportedKs);
+        const supportedKeySystemsMetadata = protectionKeyController.getSupportedKeySystemMetadataFromSegmentPssh(abInitData, applicationProvidedProtectionData, sessionType);
+        if (supportedKeySystemsMetadata.length === 0) {
+            logger.debug('DRM: Received needkey event with initData, but we don\'t support any of the key systems!');
+            return;
         }
+
+        _handleKeySystemFromPssh(supportedKeySystemsMetadata);
     }
 
     /**
@@ -1162,7 +1164,7 @@ function ProtectionController(config) {
 
     function areKeyIdsUsable(normalizedKeyIds) {
         try {
-            if (!_shouldCheckKeyStatusMap(normalizedKeyIds)) {
+            if (!_shouldCheckKeyStatusMap(normalizedKeyIds, keyStatusMap)) {
                 return true;
             }
 
@@ -1178,7 +1180,7 @@ function ProtectionController(config) {
 
     function areKeyIdsExpired(normalizedKeyIds) {
         try {
-            if (!_shouldCheckKeyStatusMap(normalizedKeyIds)) {
+            if (!_shouldCheckKeyStatusMap(normalizedKeyIds, keyStatusMap)) {
                 return false;
             }
 
@@ -1192,7 +1194,17 @@ function ProtectionController(config) {
         }
     }
 
-    function _shouldCheckKeyStatusMap(normalizedKeyIds) {
+    function _shouldCheckKeyStatusMap(normalizedKeyIds, keyStatusMap) {
+
+        const allHaveStatus = keyStatusMap.size > 0 && [...normalizedKeyIds].every((normalizedKeyId) => {
+            const keyStatus = keyStatusMap.get(normalizedKeyId);
+            return typeof keyStatus !== 'undefined' && keyStatus !== '';
+        });
+
+        if (allHaveStatus) {
+            return true
+        }
+
         const sessionTokens = protectionModel.getSessionTokens();
 
         if (sessionTokens && sessionTokens.length > 0) {

src/streaming/protection/controllers/ProtectionKeyController.js

@@ -266,7 +266,7 @@ function ProtectionKeyController() {
      * @memberof module:ProtectionKeyController
      * @instance
      */
-    function getSupportedKeySystemsFromSegmentPssh(initData, protDataSet, sessionType) {
+    function getSupportedKeySystemMetadataFromSegmentPssh(initData, protDataSet, sessionType) {
         let supportedKS = [];
         let pssh = CommonEncryption.parsePSSHList(initData);
         let ks, keySystemString;
@@ -395,7 +395,7 @@ function ProtectionKeyController() {
         getKeySystems,
         getLicenseServerModelInstance,
         getSupportedKeySystemMetadataFromContentProtection,
-        getSupportedKeySystemsFromSegmentPssh,
+        getSupportedKeySystemMetadataFromSegmentPssh,
         initDataEquals,
         initialize,
         isClearKey,