Add support for scte214:supplementalCodecs (Dash-Industry-Forum#4585)

* Add support for supplementalCodecs.

* Add scte214:supplementalCodecs to DashConstants.js

* Create configurations for early capabilities detection.

* Change logic so that either the base codec or the supplementalCodec with ensure the representation is accepted.

* Keep track of array of supplemental codecs and display warning when only the first is selected.

* Fix tests; add stub for getSupplementalCodecs()

Author: gmcgarry

src/dash/DashAdapter.js

@@ -413,6 +413,19 @@ function DashAdapter() {
         }
     }
 
+    /**
+     * Return supplementalCodecs of a Representation
+     * @param {object} representation
+     * @returns {array}
+     */
+    function getSupplementalCodecs(representation) {
+        const supplementalCodecs = representation[DashConstants.SUPPLEMENTAL_CODECS];
+        if (!supplementalCodecs) {
+            return [];
+        }
+        return supplementalCodecs.split(' ').map((codec) => representation.mimeType + ';codecs="' + codec + '"');
+    }
+
     /**
      * Returns the period as defined in the DashManifestModel for a given index
      * @param {number} index
@@ -1233,6 +1246,7 @@ function DashAdapter() {
         getRepresentationSortFunction,
         getStreamsInfo,
         getSuggestedPresentationDelay,
+        getSupplementalCodecs,
         getUTCTimingSources,
         getVoRepresentations,
         isPatchValid,

src/dash/constants/DashConstants.js

@@ -183,6 +183,7 @@ export default {
     SUB_SEGMENT_ALIGNMENT: 'subsegmentAlignment',
     SUGGESTED_PRESENTATION_DELAY: 'suggestedPresentationDelay',
     SUPPLEMENTAL_PROPERTY: 'SupplementalProperty',
+    SUPPLEMENTAL_CODECS: 'scte214:supplementalCodecs',
     TIMESCALE: 'timescale',
     TIMESHIFT_BUFFER_DEPTH: 'timeShiftBufferDepth',
     TTL: 'ttl',

src/streaming/utils/CapabilitiesFilter.js

@@ -128,13 +128,31 @@ function CapabilitiesFilter() {
         as.Representation = as.Representation.filter((rep, i) => {
             const codec = adapter.getCodec(as, i, false);
             const config = _createConfiguration(type, rep, codec);
-
             configurations.push(config);
-            const supported = capabilities.isCodecSupportedBasedOnTestedConfigurations(config, type);
-            if (!supported) {
-                logger.debug(`[CapabilitiesFilter] Codec ${configurations[i].codec} not supported. Removing Representation with ID ${rep.id}`);
+            const isCodecSupported = capabilities.isCodecSupportedBasedOnTestedConfigurations(config, type);
+
+            let isSupplementalCodecSupported = false;
+            const supplementalCodecs = adapter.getSupplementalCodecs(rep);
+            if (supplementalCodecs.length > 0) {
+                if (supplementalCodecs.length > 1) {
+                    logger.warn(`[CapabilitiesFilter] Multiple supplemental codecs not supported; using first in list`);
+                }
+                const supplementalCodec = supplementalCodecs[0];
+                const supplementalCodecConfig = _createConfiguration(type, rep, supplementalCodec);
+                configurations.push(supplementalCodecConfig);
+                isSupplementalCodecSupported = capabilities.isCodecSupportedBasedOnTestedConfigurations(supplementalCodecConfig, type);
+                if (isSupplementalCodecSupported) {
+                    logger.debug(`[CapabilitiesFilter] Codec ${supplementalCodec} supported. Upgrading Representation with ID ${rep.id}`);
+                    // overriding default codec
+                    rep.codecs = rep[DashConstants.SUPPLEMENTAL_CODECS]
+                }
             }
-            return supported
+
+            if (!isCodecSupported && !isSupplementalCodecSupported) {
+                logger.debug(`[CapabilitiesFilter] Codec ${codec} not supported. Removing Representation with ID ${rep.id}`);
+            }
+
+            return isCodecSupported || isSupplementalCodecSupported;
         });
     }
 
@@ -158,6 +176,16 @@ function CapabilitiesFilter() {
                             configurationsSet.add(configString);
                             configurations.push(config);
                         }
+
+                        const supplementalCodecs = adapter.getSupplementalCodecs(rep)
+                        if (supplementalCodecs.length > 0) {
+                            const config = _createConfiguration(type, rep, supplementalCodecs[0]);
+                            const configString = JSON.stringify(config);
+                            if (!configurationsSet.has(configString)) {
+                                configurationsSet.add(configString);
+                                configurations.push(config);
+                            }
+                        }
                     });
                 }
             });

test/unit/mocks/AdapterMock.js

@@ -161,6 +161,10 @@ function AdapterMock() {
         return codec;
     };
 
+    this.getSupplementalCodecs = function () {
+        return [];
+    }
+
     this.getEssentialPropertiesForRepresentation = function (realRepresentation) {
         if (!realRepresentation || !realRepresentation.EssentialProperty || !realRepresentation.EssentialProperty.length) {
             return null;