Property mapping while MPD parsing (Dash-Industry-Forum#4901)

stschr · web-flow · commit d4afee579955 · 2026-03-25T17:50:31.000+01:00
* enable RegEx for Exceptions

* move local RegEx into Constants

* fixing regression issue with MapNode exceptions

* move code into sub-function

* rename some variables

* remove merge flag form MapNode

* enable RegEx for Exceptions

* move code into sub-function

* rename some variables

* remove merge flag form MapNode

* - reestablish new file lost
- remove duplicated code
while merging

* Revert changes to clean history

* add one unit test for an example of a DASH XML element that can be present only once

* rename variables to improve intelligibility of their semantics

* implement merging of attributes for non-array Nodes per DASH spec

* add type check prior to merging values
diff --git a/src/dash/models/DashManifestModel.js b/src/dash/models/DashManifestModel.js
@@ -676,7 +676,7 @@ function DashManifestModel() {
         }
 
         // now, only return properties present on all Representations
-        // repr.legth is always >= 2
+        // repr.length is always >= 2
         return propertiesOfFirstRepresentation.filter(prop => {
             return repr.slice(1).every(currRep => {
                 return currRep.hasOwnProperty(propertyType) && currRep[propertyType].some(e => {
@@ -692,10 +692,18 @@ function DashManifestModel() {
         }
 
         let allProperties = _getPropertiesCommonToAllRepresentations(propertyType, adaptation[DashConstants.REPRESENTATION]);
+
+        // now, only take those Properties from AdaptationSet which we didn't already get from Representations
         if (adaptation.hasOwnProperty(propertyType) && adaptation[propertyType].length) {
-            allProperties.push(...adaptation[propertyType])
+            adaptation[propertyType].forEach( adaptationProp => {
+                const alreadyPresent = allProperties.some(d => { 
+                    return d.schemeIdUri === adaptationProp.schemeIdUri && d.value === adaptationProp.value
+                });
+                if (!alreadyPresent) {
+                    allProperties.push(adaptationProp);
+                }
+            })
         }
-        // we don't check whether there are duplicates on AdaptationSets and Representations
 
         return allProperties.map(essentialProperty => {
             const s = new DescriptorType();
diff --git a/src/dash/parser/maps/CommonProperty.js b/src/dash/parser/maps/CommonProperty.js
diff --git a/src/dash/parser/maps/MapNode.js b/src/dash/parser/maps/MapNode.js
@@ -31,19 +31,13 @@
 /**
  * @classdesc a node at some level in a ValueMap
  */
-import CommonProperty from './CommonProperty.js';
 
 class MapNode {
-    constructor(name, properties, children) {
+    constructor(name, properties, exceptions, children) {
         this._name = name || '';
-        this._properties = [];
+        this._properties = properties || [];
+        this._exceptions = exceptions || {};
         this._children = children || [];
-
-        if (Array.isArray(properties)) {
-            properties.forEach(p => {
-                this._properties.push(new CommonProperty(p));
-            });
-        }
     }
 
     get name() {
@@ -57,6 +51,10 @@ class MapNode {
     get properties() {
         return this._properties;
     }
+
+    get exceptions() {
+        return this._exceptions;
+    }
 }
 
 export default MapNode;
diff --git a/src/dash/parser/maps/RepresentationBaseValuesMap.js b/src/dash/parser/maps/RepresentationBaseValuesMap.js
@@ -33,6 +33,7 @@
  */
 import MapNode from './MapNode.js';
 import DashConstants from '../../constants/DashConstants.js';
+import Constants from '../../../streaming/constants/Constants.js';
 
 class RepresentationBaseValuesMap extends MapNode {
     constructor() {
@@ -42,6 +43,7 @@ class RepresentationBaseValuesMap extends MapNode {
             DashConstants.CODECS,
             DashConstants.CODING_DEPENDENCY,
             DashConstants.CONTENT_PROTECTION,
+            DashConstants.ESSENTIAL_PROPERTY,
             DashConstants.FRAMERATE,
             DashConstants.FRAME_PACKING,
             DashConstants.HEIGHT,
@@ -55,12 +57,34 @@ class RepresentationBaseValuesMap extends MapNode {
             DashConstants.SEGMENT_PROFILES,
             DashConstants.SEGMENT_SEQUENCE_PROPERTIES,
             DashConstants.START_WITH_SAP,
+            DashConstants.SUPPLEMENTAL_CODECS,
+            DashConstants.SUPPLEMENTAL_PROPERTY,
             DashConstants.WIDTH,
         ];
 
-        super(DashConstants.ADAPTATION_SET, commonProperties, [
-            new MapNode(DashConstants.REPRESENTATION, commonProperties, [
-                new MapNode(DashConstants.SUB_REPRESENTATION, commonProperties)
+        // RegEx are supported
+        const exceptions = {
+            [DashConstants.SUPPLEMENTAL_PROPERTY]: {
+                schemeIdUri: [
+                    Constants.URL_QUERY_INFO_SCHEME,
+                    Constants.EXT_URL_QUERY_INFO_SCHEME,
+                    Constants.ADV_URL_QUERY_INFO_SCHEME,
+                    Constants.URL_QUERY_STATE_PREFIX
+                ]
+            },
+            [DashConstants.ESSENTIAL_PROPERTY]: {
+                schemeIdUri: [
+                    Constants.URL_QUERY_INFO_SCHEME,
+                    Constants.EXT_URL_QUERY_INFO_SCHEME,
+                    Constants.ADV_URL_QUERY_INFO_SCHEME,
+                    Constants.URL_QUERY_STATE_PREFIX
+                ]
+            }
+        };
+
+        super(DashConstants.ADAPTATION_SET, commonProperties, exceptions, [
+            new MapNode(DashConstants.REPRESENTATION, commonProperties, exceptions, [
+                new MapNode(DashConstants.SUB_REPRESENTATION, commonProperties, exceptions)
             ])
         ]);
     }
diff --git a/src/dash/parser/maps/SegmentValuesMap.js b/src/dash/parser/maps/SegmentValuesMap.js
@@ -40,9 +40,11 @@ class SegmentValuesMap extends MapNode {
             DashConstants.SEGMENT_BASE, DashConstants.SEGMENT_TEMPLATE, DashConstants.SEGMENT_LIST
         ];
 
-        super(DashConstants.PERIOD, commonProperties, [
-            new MapNode(DashConstants.ADAPTATION_SET, commonProperties, [
-                new MapNode(DashConstants.REPRESENTATION, commonProperties)
+        const exceptions = {};
+
+        super(DashConstants.PERIOD, commonProperties, exceptions, [
+            new MapNode(DashConstants.ADAPTATION_SET, commonProperties, exceptions, [
+                new MapNode(DashConstants.REPRESENTATION, commonProperties, exceptions)
             ])
         ]);
     }
diff --git a/src/dash/parser/objectiron.js b/src/dash/parser/objectiron.js
@@ -32,37 +32,66 @@ import FactoryMaker from '../../core/FactoryMaker.js';
 
 function ObjectIron(mappers) {
 
-    function mergeValues(parentItem, childItem) {
-        for (let name in parentItem) {
-            if (!childItem.hasOwnProperty(name)) {
-                childItem[name] = parentItem[name];
+    function _mergeValues(parentItem, childItem) {
+        if (typeof parentItem === 'object') {
+            for (let name in parentItem) {
+                if (!childItem.hasOwnProperty(name)) {
+                    childItem[name] = parentItem[name];
+                }
+            }
+        }
+    }
+    
+    function _mappingAllowed (element, exception) {
+        let allowMapping = true;
+        if (exception) {
+            for (const [key, values] of Object.entries(exception)) {
+                let attr = element[key];
+                if (values.some(v => attr.match(v))) {
+                    allowMapping = false;
+                }
+            }
+        }
+
+        return allowMapping;
+    }
+    
+    function _conditionallyMapProperty(exception, propertyName, propertyIsArray, propertyElementFromParent, childNode) {
+        if (_mappingAllowed(propertyElementFromParent, exception)) {
+            if (childNode[propertyName]) {
+                // property already exists
+                if (propertyIsArray) {
+                    childNode[propertyName].push(propertyElementFromParent);
+                } else {
+                    // non-Array Properties can be:
+                    // - certain elements (e.g. SegmentList, see ISO 23009-1 (6th ed), clause 5.3.9.1) or 
+                    // - attributes (e.g. codecs)
+                    _mergeValues(propertyElementFromParent, childNode[propertyName]);
+                }
+            } else {
+                // just add the property
+                if (propertyIsArray) {
+                    childNode[propertyName] = [propertyElementFromParent];
+                } else {
+                    childNode[propertyName] = propertyElementFromParent;
+                }
             }
         }
     }
 
-    function mapProperties(properties, parent, child) {
+    function mapProperties(properties, exceptions, parentNode, childNode) {
         for (let i = 0, len = properties.length; i < len; ++i) {
-            const property = properties[i];
-
-            if (parent[property.name]) {
-                if (child[property.name]) {
-                    // check to see if we should merge
-                    if (property.merge) {
-                        const parentValue = parent[property.name];
-                        const childValue = child[property.name];
-
-                        // complex objects; merge properties
-                        if (typeof parentValue === 'object' && typeof childValue === 'object') {
-                            mergeValues(parentValue, childValue);
-                        }
-                        // simple objects; merge them together
-                        else {
-                            child[property.name] = parentValue + childValue;
-                        }
-                    }
+            const propertyName = properties[i];
+
+            if (parentNode[propertyName]) {
+                const propertyFromParentElement = parentNode[propertyName];
+
+                if (Array.isArray(propertyFromParentElement)) {
+                    propertyFromParentElement.forEach(propParentEl => {
+                        _conditionallyMapProperty(exceptions[propertyName], propertyName, true, propParentEl, childNode);
+                    });
                 } else {
-                    // just add the property
-                    child[property.name] = parent[property.name];
+                    _conditionallyMapProperty(exceptions[propertyName], propertyName, false, propertyFromParentElement, childNode);
                 }
             }
         }
@@ -76,7 +105,7 @@ function ObjectIron(mappers) {
             if (array) {
                 for (let v = 0, len2 = array.length; v < len2; ++v) {
                     const childNode = array[v];
-                    mapProperties(item.properties, node, childNode);
+                    mapProperties(item.properties, item.exceptions, node, childNode);
                     mapItem(childItem, childNode);
                 }
             }
diff --git a/src/streaming/constants/Constants.js b/src/streaming/constants/Constants.js
@@ -275,6 +275,8 @@ export default {
     COLOUR_PRIMARIES_SCHEME_ID_URI: 'urn:mpeg:mpegB:cicp:ColourPrimaries',
     URL_QUERY_INFO_SCHEME: 'urn:mpeg:dash:urlparam:2014',
     EXT_URL_QUERY_INFO_SCHEME: 'urn:mpeg:dash:urlparam:2016',
+    ADV_URL_QUERY_INFO_SCHEME: 'urn:mpeg:dash:urlparam:2025',
+    URL_QUERY_STATE_PREFIX: /urn:mpeg:dash:state:/,
     MATRIX_COEFFICIENTS_SCHEME_ID_URI: 'urn:mpeg:mpegB:cicp:MatrixCoefficients',
     TRANSFER_CHARACTERISTICS_SCHEME_ID_URI: 'urn:mpeg:mpegB:cicp:TransferCharacteristics',
     SEGMENT_SEQUENCE_REPRESENTATION_SCHEME_ID_URI: 'urn:mpeg:dash:ssr:2023',
diff --git a/test/unit/data/dash/manifest_properties.xml b/test/unit/data/dash/manifest_properties.xml
@@ -0,0 +1,22 @@
+<MPD mediaPresentationDuration="PT634.566S" minBufferTime="PT2.00S" profiles="urn:hbbtv:dash:profile:isoff-live:2012,urn:mpeg:dash:profile:isoff-live:2011" type="static" xmlns="urn:mpeg:dash:schema:mpd:2011" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:mpeg:DASH:schema:MPD:2011 DASH-MPD.xsd">
+    <BaseURL>./</BaseURL>
+    <Period>
+        <AdaptationSet id="as_1" codecs="mp4a.40.2" mimeType="audio/mp4" contentType="audio" subsegmentAlignment="true" subsegmentStartsWithSAP="1" lang="es">
+            <Label lang="en">English Label</Label>
+            <Label lang="fre">French Label</Label>
+            <AudioChannelConfiguration schemeIdUri="urn:mpeg:mpegB:cicp:ChannelConfiguration" value="6"/>
+            <Accessibility schemeIdUri="urn:tva:metadata:cs:AudioPurposeCS:2007" value="6"/>
+            <SupplementalProperty schemeIdUri="urn:ABC" value="Instance1" />
+            <SupplementalProperty schemeIdUri="urn:XYZ" value="OK" />
+            <SupplementalProperty schemeIdUri="urn:mpeg:dash:state:lang#audio" />
+            <Role schemeIdUri="urn:mpeg:dash:role:2011" value="main"/>
+            <SegmentTemplate duration="200000" timescale="48000" initialization="$RepresentationID$.m4a"/>
+            <Representation id="bbb_a64k" codecs="mp4a.40.5" bandwidth="67071" audioSamplingRate="48000">
+                <AudioChannelConfiguration schemeIdUri="urn:mpeg:dash:23003:3:audio_channel_configuration:2011" value="2"/>
+                <SegmentTemplate duration="300000" timescale="48000" media="$Number$.m4a" startNumber="1"/>
+                <SupplementalProperty schemeIdUri="urn:ABC" value="Instance2" />
+                <SupplementalProperty schemeIdUri="urn:ABC" value="Instance3" />
+            </Representation>
+        </AdaptationSet>
+    </Period>
+</MPD>
diff --git a/test/unit/test/dash/dash.DashParser.js b/test/unit/test/dash/dash.DashParser.js
@@ -60,6 +60,61 @@ describe('DashParser', function () {
             expect(labelArray[1].lang).to.equal('fr');
         });
     });
+
+    describe('DashParser - ObjectIron', async () => {
+        beforeEach(function () {
+            dashManifestModel.setConfig({
+                errHandler: errorHandlerMock
+            });
+        });
+
+        let manifest_prop = await FileLoader.loadTextFile('/data/dash/manifest_properties.xml');
+
+        it('should map AudioChannelConfig even if another instance is present on Representation', async () => {
+            let parsedMpd = dashParser.parse(manifest_prop);
+            let audioAdaptationsArray = dashManifestModel.getAdaptationsForType(parsedMpd, 0, 'audio');
+            let audiorepresentation = dashManifestModel.getRepresentationFor(0, audioAdaptationsArray[0]);
+
+            let acc = dashManifestModel.getAudioChannelConfigurationForRepresentation(audiorepresentation);
+
+            expect(acc).to.be.instanceOf(Array);
+            expect(acc.length).to.equal(2);
+        });
+
+        it('should map allowed SupplementalProperties from AdaptationSet to Representation', async () => {
+            let parsedMpd = dashParser.parse(manifest_prop);
+            let rawAdaptationSet = parsedMpd.Period[0].AdaptationSet[0];
+
+            expect(rawAdaptationSet.SupplementalProperty).to.be.instanceOf(Array);
+            expect(rawAdaptationSet.SupplementalProperty.length).to.equal(3);
+
+            let rawRepresentation = rawAdaptationSet.Representation[0];
+            
+            expect(rawRepresentation.SupplementalProperty).to.be.instanceOf(Array);
+            expect(rawRepresentation.SupplementalProperty.length).to.equal(4);
+        });
+
+        it('should map only allowed non-Array attributes from AdaptationSet to Representation', async () => {
+            let parsedMpd = dashParser.parse(manifest_prop);
+            let rawAdaptationSet = parsedMpd.Period[0].AdaptationSet[0];
+            let rawRepresentation = rawAdaptationSet.Representation[0];
+
+            expect(rawRepresentation.SegmentTemplate).to.be.instanceOf(Object);
+
+            expect(rawRepresentation.SegmentTemplate.initialization).to.equal('$RepresentationID$.m4a');
+            expect(rawRepresentation.SegmentTemplate.media).to.equal('$Number$.m4a');
+            expect(rawRepresentation.SegmentTemplate.duration).to.equal(300000);
+        });
+
+        it('should not map attributes', async () => {
+            let parsedMpd = dashParser.parse(manifest_prop);
+            let rawAdaptationSet = parsedMpd.Period[0].AdaptationSet[0];
+            let rawRepresentation = rawAdaptationSet.Representation[0];
+
+            expect(rawRepresentation.codecs).to.equal('mp4a.40.5');
+        });
+
+    });
 })
 
 
diff --git a/test/unit/test/dash/dash.models.DashManifestModel.js b/test/unit/test/dash/dash.models.DashManifestModel.js
diff --git a/test/unit/test/dash/dash.parser.maps.CommonProperty.js b/test/unit/test/dash/dash.parser.maps.CommonProperty.js
diff --git a/test/unit/test/dash/dash.parser.maps.MapNode.js b/test/unit/test/dash/dash.parser.maps.MapNode.js
