Feature/cmcd settings from mpd and steering report

AUTHORS.md

@@ -49,3 +49,6 @@
 * @adripanico [Adrian Caballero, Epic Labs]
 * @ahfarmer [Andrew Farmer, Rhombus Systems]
 * @matvp91 [Matthias Van Parijs]
+* @matiasrb97 [Matías Rodriguez, Qualabs]
+* @santimintegui [Santiago Mintegui, Qualabs]
+* @N1Knight [Nicolás Caballero, Qualabs]

index.d.ts

@@ -1258,6 +1258,7 @@ declare namespace dashjs {
                 }
             },
             cmcd?: {
+                applyParametersFromMpd?:boolean,
                 enabled?: boolean,
                 sid?: string | null,
                 cid?: string | null,

src/core/Settings.js

@@ -851,6 +851,10 @@ import Events from './events/Events.js';
  * If not specified this value defaults to 'query'.
  * @property {Array.<string>} [enabledKeys]
  * This value is used to specify the desired CMCD parameters. Parameters not included in this list are not reported.
+ * @property {Array.<string>} [includeInRequests]
+ * Specifies which HTTP GET requests shall carry parameters.
+ * 
+ * If not specified this value defaults to ['mpd', 'segment', 'other'].
  */
 
 /**
@@ -895,6 +899,8 @@ import Events from './events/Events.js';
  * Set to true if dash.js should use the parameters defined in ProducerReferenceTime elements in combination with ServiceDescription elements.
  * @property {boolean} [applyContentSteering=true]
  * Set to true if dash.js should apply content steering during playback.
+ * @property {boolean} [applyParametersFromMpd=true]
+ * Set to true if dash.js should use the cmcd parameters defined in MDP or js elements.
  * @property {number} [eventControllerRefreshDelay=100]
  * For multi-period streams, overwrite the manifest mediaPresentationDuration attribute with the sum of period durations if the manifest mediaPresentationDuration is greater than the sum of period durations
  * @property {boolean} [enableManifestDurationMismatchFix=true]
@@ -1272,13 +1278,15 @@ function Settings() {
                 }
             },
             cmcd: {
+                applyParametersFromMpd: true,
                 enabled: false,
                 sid: null,
                 cid: null,
                 rtp: null,
                 rtpSafetyFactor: 5,
                 mode: Constants.CMCD_MODE_QUERY,
-                enabledKeys: ['br', 'd', 'ot', 'tb', 'bl', 'dl', 'mtp', 'nor', 'nrr', 'su', 'bs', 'rtp', 'cid', 'pr', 'sf', 'sid', 'st', 'v']
+                enabledKeys: Constants.CMCD_AVAILABLE_KEYS,
+                includeInRequests: ['mpd', 'segment', 'other']
             },
             cmsd: {
                 enabled: false,

src/dash/constants/DashConstants.js

@@ -36,6 +36,7 @@
 export default {
     ACCESSIBILITY: 'Accessibility',
     ADAPTATION_SET: 'AdaptationSet',
+    ADAPTATION_SETS: 'adaptationSets',
     ADAPTATION_SET_SWITCHING_SCHEME_ID_URI: 'urn:mpeg:dash:adaptation-set-switching:2016',
     ADD: 'add',
     ASSET_IDENTIFIER: 'AssetIdentifier',
@@ -51,7 +52,9 @@ export default {
     BITSTREAM_SWITCHING_MINUS: 'bitstreamSwitching',
     BYTE_RANGE: 'byteRange',
     CENC_DEFAULT_KID: 'cenc:default_KID',
+    CLIENT_DATA_REPORTING: 'ClientDataReporting',
     CLIENT_REQUIREMENT: 'clientRequirement',
+    CMCD_PARAMETERS: 'CMCDParameters',
     CODECS: 'codecs',
     CODEC_PRIVATE_DATA: 'codecPrivateData',
     CODING_DEPENDENCY: 'codingDependency',
@@ -160,6 +163,7 @@ export default {
     SERVICE_DESCRIPTION_PLAYBACK_RATE: 'PlaybackRate',
     SERVICE_DESCRIPTION_SCOPE: 'Scope',
     SERVICE_LOCATION: 'serviceLocation',
+    SERVICE_LOCATIONS: 'serviceLocations',
     SOURCE_URL: 'sourceURL',
     START: 'start',
     START_NUMBER: 'startNumber',

src/dash/controllers/ServiceDescriptionController.js

@@ -80,7 +80,8 @@ function ServiceDescriptionController() {
             minBitrate: {},
             maxBitrate: {},
             initialBitrate: {},
-            contentSteering: null
+            contentSteering: null,
+            clientDataReporting: null,
         };
         prftOffsets = [];
     }
@@ -128,6 +129,10 @@ function ServiceDescriptionController() {
         if (sd.contentSteering) {
             _applyServiceDescriptionContentSteering(sd);
         }
+
+        if (sd.clientDataReporting) {
+            _applyServiceDescriptionClientDataReporting(sd);
+        }
     }
 
     /**
@@ -293,6 +298,15 @@ function ServiceDescriptionController() {
         serviceDescriptionSettings.contentSteering = sd.contentSteering;
     }
 
+    /**
+     * Add information about client data reporting element. Handling is up to the CMCDModel
+     *  @param {object} sd
+     *  @private
+     */
+    function _applyServiceDescriptionClientDataReporting(sd) {
+        serviceDescriptionSettings.clientDataReporting = sd.clientDataReporting;
+    }
+
     /**
      * Returns the current calculated time offsets based on ProducerReferenceTime elements
      * @returns {array}

src/dash/models/DashManifestModel.js

@@ -50,6 +50,8 @@ import Errors from '../../core/errors/Errors.js';
 import MpdLocation from '../vo/MpdLocation.js';
 import PatchLocation from '../vo/PatchLocation.js';
 import ContentProtection from '../vo/ContentProtection.js';
+import ClientDataReporting from '../vo/ClientDataReporting.js';
+import CMCDParameters from '../vo/CMCDParameters.js';
 
 function DashManifestModel() {
     let instance,
@@ -1255,6 +1257,27 @@ function DashManifestModel() {
         return entry;
     }
 
+    function _createClientDataReportingInstance(element){
+        const entry = new ClientDataReporting();
+
+        if (element.hasOwnProperty(DashConstants.CMCD_PARAMETERS)) {
+            entry.cmcdParameters = new CMCDParameters();
+            entry.cmcdParameters.init(element[DashConstants.CMCD_PARAMETERS]);
+        }
+
+        if (element.hasOwnProperty(DashConstants.SERVICE_LOCATIONS) && element[DashConstants.SERVICE_LOCATIONS] !== ''){
+            entry.serviceLocations = element[DashConstants.SERVICE_LOCATIONS];
+            entry.serviceLocationsArray = entry.serviceLocations.toString().split(' ');
+        }
+
+        if (element.hasOwnProperty(DashConstants.ADAPTATION_SETS) && element[DashConstants.ADAPTATION_SETS] !== ''){
+            entry.adaptationSets = element[DashConstants.ADAPTATION_SETS];
+            entry.adaptationSetsArray = entry.adaptationSets.toString().split(' ');
+        }
+
+        return entry;
+    }
+
     function getLocation(manifest) {
         if (manifest && manifest.hasOwnProperty(DashConstants.LOCATION)) {
             return manifest[DashConstants.LOCATION].map((entry) => {
@@ -1301,7 +1324,8 @@ function DashManifestModel() {
                     playbackRate = null,
                     operatingQuality = null,
                     operatingBandwidth = null,
-                    contentSteering = null;
+                    contentSteering = null,
+                    clientDataReporting = null;
 
                 for (const prop in sd) {
                     if (sd.hasOwnProperty(prop)) {
@@ -1338,7 +1362,11 @@ function DashManifestModel() {
                                 target: parseInt(sd[prop].target)
                             }
                         } else if (prop === DashConstants.CONTENT_STEERING) {
-                            contentSteering = _createContentSteeringInstance(sd[prop])
+                            let element = sd[prop];
+                            element = Array.isArray(element) ? element.at(element.length - 1) : element;
+                            contentSteering = _createContentSteeringInstance(element);
+                        } else if (prop === DashConstants.CLIENT_DATA_REPORTING) {
+                            clientDataReporting = _createClientDataReportingInstance(sd[prop]);
                         }
                     }
                 }
@@ -1350,7 +1378,8 @@ function DashManifestModel() {
                     playbackRate,
                     operatingQuality,
                     operatingBandwidth,
-                    contentSteering
+                    contentSteering,
+                    clientDataReporting
                 });
             }
         }

src/dash/vo/CMCDParameters.js

@@ -0,0 +1,63 @@
+/**
+ * The copyright in this software is being made available under the BSD License,
+ * included below. This software may be subject to other third party and contributor
+ * rights, including patent rights, and no such rights are granted under this license.
+ *
+ * Copyright (c) 2024, Dash Industry Forum.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *  * Redistributions of source code must retain the above copyright notice, this
+ *  list of conditions and the following disclaimer.
+ *  * Redistributions in binary form must reproduce the above copyright notice,
+ *  this list of conditions and the following disclaimer in the documentation and/or
+ *  other materials provided with the distribution.
+ *  * Neither the name of Dash Industry Forum nor the names of its
+ *  contributors may be used to endorse or promote products derived from this software
+ *  without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
+ *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import DescriptorType from './DescriptorType.js';
+
+/**
+ * @class
+ * @ignore
+ */
+class CMCDParameters extends DescriptorType {
+    constructor() {
+        super();
+        this.version = null;
+        this.sessionID = null;
+        this.contentID = null;
+        this.mode = null;
+        this.keys = null;
+        this.includeInRequests = null;
+    }
+
+    init(data) {
+        super.init(data);
+
+        if (data) {
+            this.version = data.version;
+            this.sessionID = data.sessionID;
+            this.contentID = data.contentID;
+            this.mode = data.mode;
+            this.keys = data.keys ? data.keys.split(' ') : null;
+            this.includeInRequests = data.includeInRequests ? data.includeInRequests.split(' ') : null;
+        }
+    }
+}
+
+export default CMCDParameters;

src/dash/vo/ClientDataReporting.js

@@ -0,0 +1,45 @@
+/**
+ * The copyright in this software is being made available under the BSD License,
+ * included below. This software may be subject to other third party and contributor
+ * rights, including patent rights, and no such rights are granted under this license.
+ *
+ * Copyright (c) 2024, Dash Industry Forum.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *  * Redistributions of source code must retain the above copyright notice, this
+ *  list of conditions and the following disclaimer.
+ *  * Redistributions in binary form must reproduce the above copyright notice,
+ *  this list of conditions and the following disclaimer in the documentation and/or
+ *  other materials provided with the distribution.
+ *  * Neither the name of Dash Industry Forum nor the names of its
+ *  contributors may be used to endorse or promote products derived from this software
+ *  without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
+ *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ */
+/**
+ * @class
+ * @ignore
+ */
+class ClientDataReporting {
+    constructor() {
+        this.cmcdParameters = null;
+        this.serviceLocations = null;
+        this.serviceLocationsArray = [];
+        this.adaptationSets = null;
+        this.adaptationSetsArray = [];
+    }
+}
+
+export default ClientDataReporting;

src/streaming/MediaPlayer.js

@@ -52,6 +52,7 @@ import SchemeLoaderFactory from './net/SchemeLoaderFactory.js';
 import VideoModel from './models/VideoModel.js';
 import CmcdModel from './models/CmcdModel.js';
 import CmsdModel from './models/CmsdModel.js';
+import ClientDataReportingModel from './models/ClientDataReportingModel.js';
 import DOMStorage from './utils/DOMStorage.js';
 import Debug from './../core/Debug.js';
 import Errors from './../core/errors/Errors.js';
@@ -165,6 +166,7 @@ function MediaPlayer() {
         manifestModel,
         cmcdModel,
         cmsdModel,
+        clientDataReportingModel,
         videoModel,
         uriFragmentModel,
         domStorage,
@@ -350,6 +352,8 @@ function MediaPlayer() {
 
             cmsdModel = CmsdModel(context).getInstance();
 
+            clientDataReportingModel = ClientDataReportingModel(context).getInstance();
+
             dashMetrics = DashMetrics(context).getInstance({
                 settings: settings
             });
@@ -2340,9 +2344,14 @@ function MediaPlayer() {
             abrController,
             dashMetrics,
             playbackController,
-            throughputController
+            serviceDescriptionController,
+            throughputController,
         });
 
+        clientDataReportingModel.setConfig({
+            serviceDescriptionController
+        })
+
         cmsdModel.setConfig({});
 
         // initializes controller

src/streaming/constants/Constants.js

@@ -214,6 +214,22 @@ export default {
      *  @static
      */
     CMCD_MODE_HEADER: 'header',
+
+    /**
+     *  @constant {string} CMCD_AVAILABLE_KEYS specifies all the availables keys for CMCD metrics.
+     *  @memberof Constants#
+     *  @static
+     */
+    CMCD_AVAILABLE_KEYS: ['br', 'd', 'ot', 'tb', 'bl', 'dl', 'mtp', 'nor', 'nrr', 'su', 'bs', 'rtp', 'cid', 'pr', 'sf', 'sid', 'st', 'v'],
+
+    /**
+     *  @constant {string} CMCD_AVAILABLE_REQUESTS specifies all the availables requests type for CMCD metrics.
+     *  @memberof Constants#
+     *  @static
+     */
+    CMCD_AVAILABLE_REQUESTS: ['segment', 'mpd', 'xlink', 'steering', 'other'],
+
+
     INITIALIZE: 'initialize',
     TEXT_SHOWING: 'showing',
     TEXT_HIDDEN: 'hidden',
@@ -292,4 +308,3 @@ export default {
     ID3_SCHEME_ID_URI: 'https://aomedia.org/emsg/ID3',
     COMMON_ACCESS_TOKEN_HEADER: 'common-access-token'
 }
-