Feature/filter message (Dash-Industry-Forum#4961)

* Add warning when AdaptationSet is filtered because of unsupported EssentialProperty

* Allow COLOUR_PRIMARIES_SCHEME_ID_URI and MATRIX_COEFFICIENTS_SCHEME_ID_URI with value 9

* Enable filterVideoColorimetryEssentialProperties and filterHDRMetadataFormatEssentialProperties by default

* Adjust unit tests according to new config

* Remove console.log

Author: dsilhavy

src/core/Settings.js

@@ -84,8 +84,8 @@ import SwitchRequest from '../streaming/rules/SwitchRequest.js';
  *                   ...Constants.THUMBNAILS_SCHEME_ID_URIS.map(ep => { return { 'schemeIdUri': ep }; })
  *               ],
  *               useMediaCapabilitiesApi: true,
- *               filterVideoColorimetryEssentialProperties: false,
- *               filterHDRMetadataFormatEssentialProperties: false,
+ *               filterVideoColorimetryEssentialProperties: true,
+ *               filterHDRMetadataFormatEssentialProperties: true,
  *               filterAudioChannelConfiguration: false
  *            },
  *            events: {
@@ -734,10 +734,10 @@ import SwitchRequest from '../streaming/rules/SwitchRequest.js';
  * List of supported \<EssentialProperty\> elements
  * @property {boolean} [useMediaCapabilitiesApi=true]
  * Enable to use the MediaCapabilities API to check whether codecs are supported. If disabled MSE.isTypeSupported will be used instead.
- * @property {boolean} [filterVideoColorimetryEssentialProperties=false]
+ * @property {boolean} [filterVideoColorimetryEssentialProperties=true]
  * Enable dash.js to query MediaCapabilities API for signalled Colorimetry EssentialProperties (per schemeIdUris: 'urn:mpeg:mpegB:cicp:ColourPrimaries', 'urn:mpeg:mpegB:cicp:TransferCharacteristics').
  * If disabled, registered properties per supportedEssentialProperties will be allowed without any further checking (including 'urn:mpeg:mpegB:cicp:MatrixCoefficients').
- * @property {boolean} [filterHDRMetadataFormatEssentialProperties=false]
+ * @property {boolean} [filterHDRMetadataFormatEssentialProperties=true]
  * Enable dash.js to query MediaCapabilities API for signalled HDR-MetadataFormat EssentialProperty (per schemeIdUri:'urn:dvb:dash:hdr-dmi').
  * @property {boolean} [filterAudioChannelConfiguration=false]
  * Enable dash.js to query MediaCapabilities API for signalled AudioChannelConfiguration.
@@ -1174,8 +1174,8 @@ function Settings() {
                     })
                 ],
                 useMediaCapabilitiesApi: true,
-                filterVideoColorimetryEssentialProperties: false,
-                filterHDRMetadataFormatEssentialProperties: false,
+                filterVideoColorimetryEssentialProperties: true,
+                filterHDRMetadataFormatEssentialProperties: true,
                 filterAudioChannelConfiguration: false
             },
             events: {

src/streaming/utils/CapabilitiesFilter.js

@@ -79,7 +79,7 @@ function CapabilitiesFilter() {
 
                     _removeMultiRepresentationPreselections(manifest);
                     _removePreselectionWithNoAdaptationSet(manifest);
-                    
+
                     return _applyCustomFilters(manifest);
                 })
                 .then(() => {
@@ -245,6 +245,7 @@ function CapabilitiesFilter() {
     }
 
     /* Build the configuration object for capability requests based on primary element (Representation or Preselection) */
+
     /* In case Preselection elements are present, attributes of this element override their counterparts from the Representation element */
     function _createConfiguration(type, primaryElement, codec, prslCommonRepresentation) {
         let config = null;
@@ -305,12 +306,12 @@ function CapabilitiesFilter() {
 
             if (primaryElement.tagName === DashConstants.PRESELECTION && prslCommonRep) {
                 let prslCommonRepresentationHDRColorimetryConfig = _convertHDRColorimetryToConfig(prslCommonRep);
-                
+
                 // if either the properties of the Preselection or the CommonRepresentation is not supported, we can't mark the config as supported.
                 let isCommonRepCfgSupported = prslCommonRepresentationHDRColorimetryConfig.isSupported;
                 delete prslCommonRepresentationHDRColorimetryConfig.isSupported;
                 config.isSupported = config.isSupported && isCommonRepCfgSupported;
-                
+
                 // asign only those attributes that are not present in config
                 _assignMissing(config, prslCommonRepresentationHDRColorimetryConfig);
             }
@@ -322,7 +323,7 @@ function CapabilitiesFilter() {
 
             if (primaryElement.tagName === DashConstants.PRESELECTION && prslCommonRep) {
                 let prslCommonRepresentationHDRMetadataFormatConfig = _convertHDRMetadataFormatToConfig(prslCommonRep);
-                
+
                 // if either the properties of the Preselection or the CommonRepresentation is not supported, we can't mark the config as supported.
                 let isCommonRepCfgSupported = prslCommonRepresentationHDRMetadataFormatConfig.isSupported;
                 delete prslCommonRepresentationHDRMetadataFormatConfig.isSupported;
@@ -473,6 +474,7 @@ function CapabilitiesFilter() {
                 const doesSupportEssentialProperties = _doesSupportEssentialProperties(adaptationSetEssentialProperties);
 
                 if (!doesSupportEssentialProperties) {
+                    logger.warn(`[CapabilitiesFilter] removed AdaptationSet (id: ${as.id}) with unsupported EssentialProperty`);
                     return false;
                 }
 
@@ -481,7 +483,11 @@ function CapabilitiesFilter() {
                     return _doesSupportEssentialProperties(essentialProperties);
                 });
 
-                return as.Representation && as.Representation.length > 0;
+                const isSupported = as.Representation && as.Representation.length > 0;
+                if (!isSupported) {
+                    logger.warn(`[CapabilitiesFilter] removed AdaptationSet (id: ${as.id}) with unsupported EssentialProperty on all Representations`);
+                }
+                return isSupported;
             });
 
             if (period.Preselection && period.Preselection.length) {
@@ -544,8 +550,12 @@ function CapabilitiesFilter() {
             if (period.Preselection) {
                 period.Preselection = period.Preselection.filter((prsl) => {
                     const prslComponents = String(prsl.preselectionComponents).split(' ');
-                    const adaptationSetIds = period.AdaptationSet.map(as => {return as.id});
-                    return prslComponents.every(c => {return adaptationSetIds.includes(c)});
+                    const adaptationSetIds = period.AdaptationSet.map(as => {
+                        return as.id
+                    });
+                    return prslComponents.every(c => {
+                        return adaptationSetIds.includes(c)
+                    });
                 });
             }
         });

test/unit/test/streaming/streaming.utils.Capabilities.js

@@ -83,15 +83,25 @@ EssentialPropertyPrivateTransferFunction.init({
 describe('Capabilities', function () {
     beforeEach(function () {
         settings = Settings({}).getInstance();
+        settings.reset();
         capabilities = Capabilities({}).getInstance();
 
         capabilities.setConfig({
             settings: settings
         });
-        settings.reset();
     });
 
     describe('supports EssentialProperty', function () {
+        beforeEach(function () {
+            settings.update({
+                streaming: {
+                    capabilities: {
+                        filterVideoColorimetryEssentialProperties: false,
+                        filterHDRMetadataFormatEssentialProperties: false,
+                    }
+                }
+            })
+        });
         it('should return true if EssentialProperty value is known', function () {
             let res = capabilities.supportsEssentialProperty(EssentialPropertyThumbNail);
             expect(res).to.be.true;