From e1f2344231800cf3852be212b590dc0542047e43 Mon Sep 17 00:00:00 2001
From: Fritz Heiden <fritz.heiden@fokus.fraunhofer.de>
Date: Mon, 11 Jan 2021 16:17:55 +0100
Subject: [PATCH 01/13] Implemented further CMCD parameters

- Implemented CMCD object type 'tt'
- Implemented metrics nor and nrr
- Implemented unit tests for CMCD parameters nor and nrr
- Added CMCD query parameters to license requests
---
 samples/advanced/cmcd.html                    | 23 +++++++
 src/dash/DashHandler.js                       | 16 ++++-
 src/streaming/StreamProcessor.js              | 15 +++++
 src/streaming/models/CmcdModel.js             | 67 ++++++++++++++++++-
 .../controllers/ProtectionController.js       | 21 +++++-
 src/streaming/vo/metrics/HTTPRequest.js       |  1 +
 test/unit/mocks/PlaybackControllerMock.js     |  1 +
 test/unit/mocks/StreamControllerMock.js       |  7 ++
 test/unit/mocks/StreamMock.js                 | 14 ++++
 test/unit/mocks/StreamProcessorMock.js        |  4 ++
 test/unit/streaming.models.CmcdModel.js       |  6 ++
 11 files changed, 172 insertions(+), 3 deletions(-)

diff --git a/samples/advanced/cmcd.html b/samples/advanced/cmcd.html
index 3454b5f797..8cf93cdb20 100644
--- a/samples/advanced/cmcd.html
+++ b/samples/advanced/cmcd.html
@@ -20,6 +20,7 @@
             player = dashjs.MediaPlayer().create();
             video = document.querySelector("video");
             player.initialize(); 
+            player.setTextDefaultEnabled(true);
             version = player.getVersion();
 
             player.on(CMCD_DATA_GENERATED, handleCmcdDataGeneratedEvent);
@@ -37,6 +38,27 @@
             player.attachView(video);
             player.attachSource(url);
 
+            var TTMLRenderingDiv = document.querySelector("#ttml-rendering-div");
+            player.attachTTMLRenderingDiv(TTMLRenderingDiv);
+        }
+
+        function handleCmcdDataGeneratedEvent(event) {
+            log("type: " +  event.mediaType);
+            log("file: " + event.url.split("/").pop())
+            var keys = Object.keys(event.cmcdData);
+            keys = keys.sort();
+            for (var key of keys) {
+                log(key.padEnd(4) + ": " + event.cmcdData[key]);
+            }
+            log("");
+        }
+
+        function log(msg) {
+            msg = msg.length > 200 ? msg.substring(0, 200) + "..." : msg; /* to avoid repeated wrapping with large objects */
+            var tracePanel = document.getElementById("trace");
+            tracePanel.innerHTML += msg + "\n";
+            tracePanel.scrollTop = tracePanel.scrollHeight;
+            console.log(msg);
         }
 
         function handleCmcdDataGeneratedEvent(event) {
@@ -76,6 +98,7 @@
         <div>
             <video controls="true">
             </video>
+            <div id="ttml-rendering-div"></div>
             <textarea id="trace" placeholder="Sent CMCD data will be displayed here"></textarea>
         </div>
         <script>
diff --git a/src/dash/DashHandler.js b/src/dash/DashHandler.js
index 418114b99e..584747d089 100644
--- a/src/dash/DashHandler.js
+++ b/src/dash/DashHandler.js
@@ -308,6 +308,19 @@ function DashHandler(config) {
         return request;
     }
 
+    function getNextSegmentRequestIdempotent(mediaInfo, representation) {
+        let request = null;
+        let indexToRequest = segmentIndex + 1;
+        const segment = segmentsController.getSegmentByIndex(
+            representation,
+            indexToRequest,
+            lastSegment ? lastSegment.mediaStartTime : -1
+        );
+        if (!segment) return null;
+        request = getRequestForSegment(mediaInfo, segment);
+        return request;
+    }
+
     function getNextSegmentRequest(mediaInfo, representation) {
         let request = null;
 
@@ -448,7 +461,8 @@ function DashHandler(config) {
         isMediaFinished: isMediaFinished,
         reset: reset,
         resetIndex: resetIndex,
-        setMimeType: setMimeType
+        setMimeType: setMimeType,
+        getNextSegmentRequestIdempotent
     };
 
     setup();
diff --git a/src/streaming/StreamProcessor.js b/src/streaming/StreamProcessor.js
index 54ff3f2dd1..13bca98e30 100644
--- a/src/streaming/StreamProcessor.js
+++ b/src/streaming/StreamProcessor.js
@@ -458,6 +458,20 @@ function StreamProcessor(config) {
         scheduleController.processMediaRequest(request);
     }
 
+    function probeNextRequest() {
+        const representationInfo = getRepresentationInfo();
+
+        const representation = representationController && representationInfo ?
+            representationController.getRepresentationForQuality(representationInfo.quality) : null;
+
+        let request = indexHandler.getNextSegmentRequestIdempotent(
+            getMediaInfo(),
+            representation
+        );
+
+        return request;
+    }
+
     function findNextRequest(seekTarget, requestToReplace) {
         const representationInfo = getRepresentationInfo();
         const hasSeekTarget = !isNaN(seekTarget);
@@ -765,6 +779,7 @@ function StreamProcessor(config) {
         getInitRequest: getInitRequest,
         getFragmentRequest: getFragmentRequest,
         finalisePlayList: finalisePlayList,
+        probeNextRequest: probeNextRequest,
         reset: reset
     };
 
diff --git a/src/streaming/models/CmcdModel.js b/src/streaming/models/CmcdModel.js
index 14791cb49c..19377f4f42 100644
--- a/src/streaming/models/CmcdModel.js
+++ b/src/streaming/models/CmcdModel.js
@@ -68,6 +68,7 @@ function CmcdModel() {
         abrController,
         dashMetrics,
         playbackController,
+        streamProcessors,
         _isStartup,
         _bufferLevelStarved,
         _initialMediaRequestsDone;
@@ -88,6 +89,7 @@ function CmcdModel() {
         eventBus.on(MediaPlayerEvents.MANIFEST_LOADED, _onManifestLoaded, instance);
         eventBus.on(MediaPlayerEvents.BUFFER_LEVEL_STATE_CHANGED, _onBufferLevelStateChanged, instance);
         eventBus.on(MediaPlayerEvents.PLAYBACK_SEEKED, _onPlaybackSeeked, instance);
+        eventBus.on(MediaPlayerEvents.PERIOD_SWITCH_COMPLETED, _onPeriodSwitchComplete, instance);
     }
 
     function setConfig(config) {
@@ -118,6 +120,21 @@ function CmcdModel() {
         _bufferLevelStarved = {};
         _isStartup = {};
         _initialMediaRequestsDone = {};
+        updateStreamProcessors();
+    }
+
+    function _onPeriodSwitchComplete() {
+        updateStreamProcessors();
+    }
+
+    function updateStreamProcessors() {
+        if (!playbackController) return;
+        const streamController = playbackController.getStreamController();
+        if (!streamController) return;
+        if (typeof streamController.getActiveStream !== 'function') return;
+        const activeStream = streamController.getActiveStream();
+        if (!activeStream) return;
+        streamProcessors = activeStream.getProcessors();
     }
 
     function getQueryParameter(request) {
@@ -157,6 +174,8 @@ function CmcdModel() {
                 return _getCmcdDataForInitSegment(request);
             } else if (request.type === HTTPRequest.OTHER_TYPE || request.type === HTTPRequest.XLINK_EXPANSION_TYPE) {
                 return _getCmcdDataForOther(request);
+            } else if (request.type === HTTPRequest.LICENSE) {
+                return _getCmcdDataForLicense(request);
             }
 
             return cmcdData;
@@ -165,6 +184,14 @@ function CmcdModel() {
         }
     }
 
+    function _getCmcdDataForLicense(request) {
+        const data = _getGenericCmcdData(request);
+
+        data.ot = OBJECT_TYPES.ENCRYPTION_KEY;
+
+        return data;
+    }
+
     function _getCmcdDataForMpd() {
         const data = _getGenericCmcdData();
 
@@ -177,13 +204,38 @@ function CmcdModel() {
         const data = _getGenericCmcdData();
         const encodedBitrate = _getBitrateByRequest(request);
         const d = _getObjectDurationByRequest(request);
-        const ot = request.mediaType === 'video' ? `${OBJECT_TYPES.VIDEO}` : request.mediaType === 'audio' ? `${OBJECT_TYPES.AUDIO}` : request.mediaType === 'fragmentedText' ? `${OBJECT_TYPES.CAPTION}` : null;
         const mtp = _getMeasuredThroughputByType(request.mediaType);
         const dl = _getDeadlineByType(request.mediaType);
         const bl = _getBufferLevelByType(request.mediaType);
         const tb = _getTopBitrateByType(request.mediaType);
         const pr = internalData.pr;
 
+        const nextRequest = _probeNextRequest(request.mediaType);
+
+        let ot;
+        if (request.mediaType === 'video') ot = OBJECT_TYPES.VIDEO;
+        if (request.mediaType === 'audio') ot = OBJECT_TYPES.AUDIO;
+        if (request.mediaType === 'fragmentedText') {
+            if (request.mediaInfo.mimeType === 'application/mp4') {
+                ot = OBJECT_TYPES.ISOBMFF_TEXT_TRACK;
+            } else {
+                ot = OBJECT_TYPES.CAPTION;
+            }
+        }
+
+        let nrr = request.range;
+
+        if (nextRequest) {
+            data.nor = nextRequest.url;
+            if (nextRequest.range) {
+                nrr = nextRequest.range;
+            }
+        }
+
+        if (nrr) {
+            data.nrr = nrr;
+        }
+
         if (encodedBitrate) {
             data.br = encodedBitrate;
         }
@@ -216,6 +268,11 @@ function CmcdModel() {
             data.pr = pr;
         }
 
+        // Assuming nor field is never set: If the ‘nor’ field is not set, then the object is assumed to match the object currently being requested.
+        if (request.range) {
+            data.nrr = request.range;
+        }
+
         if (_bufferLevelStarved[request.mediaType]) {
             data.bs = true;
             _bufferLevelStarved[request.mediaType] = false;
@@ -440,6 +497,14 @@ function CmcdModel() {
         }
     }
 
+    function _probeNextRequest(mediaType) {
+        if (!streamProcessors || streamProcessors.length === 0) return;
+        for (let streamProcessor of streamProcessors) {
+            if (streamProcessor.getType() !== mediaType) continue;
+            return streamProcessor.probeNextRequest();
+        }
+    }
+
     function reset() {
         eventBus.off(MediaPlayerEvents.PLAYBACK_RATE_CHANGED, _onPlaybackRateChanged, this);
         eventBus.off(MediaPlayerEvents.MANIFEST_LOADED, _onManifestLoaded, this);
diff --git a/src/streaming/protection/controllers/ProtectionController.js b/src/streaming/protection/controllers/ProtectionController.js
index 708f8bdc73..a1745fad22 100644
--- a/src/streaming/protection/controllers/ProtectionController.js
+++ b/src/streaming/protection/controllers/ProtectionController.js
@@ -34,6 +34,8 @@ import MediaCapability from '../vo/MediaCapability';
 import KeySystemConfiguration from '../vo/KeySystemConfiguration';
 import ProtectionErrors from '../errors/ProtectionErrors';
 import DashJSError from '../../vo/DashJSError';
+import CmcdModel from '../../models/CmcdModel';
+import { HTTPRequest } from '../../vo/metrics/HTTPRequest';
 
 const NEEDKEY_BEFORE_INITIALIZE_RETRIES = 5;
 const NEEDKEY_BEFORE_INITIALIZE_TIMEOUT = 500;
@@ -67,6 +69,7 @@ function ProtectionController(config) {
     const BASE64 = config.BASE64;
     const constants = config.constants;
     let needkeyRetries = [];
+    const context = this.context;
 
     let instance,
         logger,
@@ -75,7 +78,8 @@ function ProtectionController(config) {
         protDataSet,
         sessionType,
         robustnessLevel,
-        keySystem;
+        keySystem,
+        cmcdModel;
 
     function setup() {
         logger = debug.getLogger(instance);
@@ -83,6 +87,7 @@ function ProtectionController(config) {
         mediaInfoArr = [];
         sessionType = 'temporary';
         robustnessLevel = '';
+        cmcdModel = CmcdModel(context).getInstance();
     }
 
     function checkConfig() {
@@ -773,6 +778,20 @@ function ProtectionController(config) {
     function doLicenseRequest(url, headers, method, responseType, withCredentials, payload, retriesCount, timeout, onLoad, onAbort, onError, sessionId) {
         const xhr = new XMLHttpRequest();
 
+        const cmcdParams = cmcdModel.getQueryParameter({
+            url,
+            type: HTTPRequest.LICENSE
+        });
+
+        if (cmcdParams) {
+            let queryPrefix = '?';
+            if (url.indexOf('?') !== -1) {
+                queryPrefix = '&';
+            }
+            const query = queryPrefix + cmcdParams.key + '=' + cmcdParams.value;
+            url = url + query;
+        }
+
         xhr.open(method, url, true);
         xhr.responseType = responseType;
         xhr.withCredentials = withCredentials;
diff --git a/src/streaming/vo/metrics/HTTPRequest.js b/src/streaming/vo/metrics/HTTPRequest.js
index 3ef1a5f48e..9bd73214a8 100644
--- a/src/streaming/vo/metrics/HTTPRequest.js
+++ b/src/streaming/vo/metrics/HTTPRequest.js
@@ -166,6 +166,7 @@ HTTPRequest.INIT_SEGMENT_TYPE = 'InitializationSegment';
 HTTPRequest.INDEX_SEGMENT_TYPE = 'IndexSegment';
 HTTPRequest.MEDIA_SEGMENT_TYPE = 'MediaSegment';
 HTTPRequest.BITSTREAM_SWITCHING_SEGMENT_TYPE = 'BitstreamSwitchingSegment';
+HTTPRequest.LICENSE = 'license';
 HTTPRequest.OTHER_TYPE = 'other';
 
 export { HTTPRequest, HTTPRequestTrace };
diff --git a/test/unit/mocks/PlaybackControllerMock.js b/test/unit/mocks/PlaybackControllerMock.js
index 8911f9669a..3f64f29e7c 100644
--- a/test/unit/mocks/PlaybackControllerMock.js
+++ b/test/unit/mocks/PlaybackControllerMock.js
@@ -13,6 +13,7 @@ class PlaybackControllerMock {
         this.isDynamic = false;
         this.time = 0;
         this.streamController = new StreamControllerMock();
+        this.streamController.setup();
     }
 
     initialize() {
diff --git a/test/unit/mocks/StreamControllerMock.js b/test/unit/mocks/StreamControllerMock.js
index 3b9b04c422..586d25591f 100644
--- a/test/unit/mocks/StreamControllerMock.js
+++ b/test/unit/mocks/StreamControllerMock.js
@@ -1,3 +1,5 @@
+import StreamMock from './StreamMock';
+
 class StreamControllerMock {
 
     constructor() {
@@ -5,6 +7,7 @@ class StreamControllerMock {
 
     setup() {
         this.streamId = 'streamId';
+        this.activeStream = new StreamMock();
     }
 
     initialize(streams) {
@@ -81,6 +84,10 @@ class StreamControllerMock {
     getActiveStreamProcessors() {
         return [];
     }
+
+    getActiveStream() {
+        return this.activeStream;
+    }
 }
 
 export default StreamControllerMock;
diff --git a/test/unit/mocks/StreamMock.js b/test/unit/mocks/StreamMock.js
index e80fe77e5d..fb9f575888 100644
--- a/test/unit/mocks/StreamMock.js
+++ b/test/unit/mocks/StreamMock.js
@@ -1,9 +1,19 @@
+import StreamProcessorMock from './StreamProcessorMock';
+
+const TYPE_AUDIO = 'audio';
+const TYPE_VIDEO = 'video';
+
 function StreamMock () {
 
     this.initialize = function (streamInfo) {
         this.streamInfo = streamInfo;
     };
 
+    this.streamProcessors = [
+        new StreamProcessorMock(TYPE_VIDEO),
+        new StreamProcessorMock(TYPE_AUDIO)
+    ];
+
     this.getStreamInfo = function () {
         return this.streamInfo ? this.streamInfo : {};
     };
@@ -13,6 +23,10 @@ function StreamMock () {
             return { setStreamProcessor: () => {} };
         } };
     };
+
+    this.getProcessors = function () {
+        return this.streamProcessors;
+    };
 }
 
 export default StreamMock;
diff --git a/test/unit/mocks/StreamProcessorMock.js b/test/unit/mocks/StreamProcessorMock.js
index c5f44a0d6d..9fa899fea5 100644
--- a/test/unit/mocks/StreamProcessorMock.js
+++ b/test/unit/mocks/StreamProcessorMock.js
@@ -116,6 +116,10 @@ function StreamProcessorMock (testType, streamInfo) {
     this.appendInitSegment = function () {};
 
     this.reset = function () {};
+
+    this.probeNextRequest = function () {
+        return { url: 'http://test.url/next_object', range: '100-500' };
+    };
 }
 
 export default StreamProcessorMock;
diff --git a/test/unit/streaming.models.CmcdModel.js b/test/unit/streaming.models.CmcdModel.js
index dfc76ba4c5..c624ac0f79 100644
--- a/test/unit/streaming.models.CmcdModel.js
+++ b/test/unit/streaming.models.CmcdModel.js
@@ -102,6 +102,8 @@ describe('CmcdModel', function () {
             const MEASURED_THROUGHPUT = 8327641;
             const BUFFER_LEVEL = parseInt(dashMetricsMock.getCurrentBufferLevel() * 10) * 100;
             const VIDEO_OBJECT_TYPE = 'v';
+            const NEXT_OBJECT_URL = 'http://test.url/next_object';
+            const NEXT_OBJECT_RANGE = '100-500';
 
             abrControllerMock.setTopBitrateInfo({bitrate: TOP_BITRATE});
             abrControllerMock.setThroughputHistory({
@@ -140,6 +142,10 @@ describe('CmcdModel', function () {
             expect(metrics.bl).to.equal(BUFFER_LEVEL);
             expect(metrics).to.have.property('tb');
             expect(metrics.tb).to.equal(parseInt(TOP_BITRATE / 1000));
+            expect(metrics).to.have.property('nor');
+            expect(metrics.nor).to.equal(NEXT_OBJECT_URL);
+            expect(metrics).to.have.property('nrr');
+            expect(metrics.nrr).to.equal(NEXT_OBJECT_RANGE);
         });
 
         it('getQueryParameter() returns correct metrics for other type', function () {

From c2a592d95e4332d496c20e250f20feb7e4b2070b Mon Sep 17 00:00:00 2001
From: Fritz Heiden <fritz.heiden@fokus.fraunhofer.de>
Date: Mon, 25 Jan 2021 13:55:44 +0100
Subject: [PATCH 02/13] Implemented cmcd parameter rtp

---
 samples/dash-if-reference-player/app/main.js |  1 +
 samples/dash-if-reference-player/index.html  |  2 ++
 src/core/Settings.js                         |  6 +++--
 src/streaming/models/CmcdModel.js            | 24 ++++++++++++++++++++
 4 files changed, 31 insertions(+), 2 deletions(-)

diff --git a/samples/dash-if-reference-player/app/main.js b/samples/dash-if-reference-player/app/main.js
index 8c4fa64b7d..85c2e5be25 100644
--- a/samples/dash-if-reference-player/app/main.js
+++ b/samples/dash-if-reference-player/app/main.js
@@ -695,6 +695,7 @@ app.controller('DashController', ['$scope', '$window', 'sources', 'contributors'
 
         config.streaming.cmcd.sid = $scope.cmcdSessionId ? $scope.cmcdSessionId : null;
         config.streaming.cmcd.cid = $scope.cmcdContentId ? $scope.cmcdContentId : null;
+        config.streaming.cmcd.rtp = $scope.cmcdRtp ? $scope.cmcdRtp : null;
 
         $scope.player.updateSettings(config);
 
diff --git a/samples/dash-if-reference-player/index.html b/samples/dash-if-reference-player/index.html
index 096f9cbb38..af29456031 100644
--- a/samples/dash-if-reference-player/index.html
+++ b/samples/dash-if-reference-player/index.html
@@ -455,6 +455,8 @@
                 <input type="text" class="form-control" placeholder="mandatory session id" ng-model="cmcdSessionId">
                 <label class="options-label">Content ID:</label>
                 <input type="text" class="form-control" placeholder="content id" ng-model="cmcdContentId">
+                <label class="options-label">Requested maximum throughput (rtp):</label>
+                <input type="text" class="form-control" placeholder="rtp in kbps" ng-model="cmcdRtp">
             </div>
         </div>
 
diff --git a/src/core/Settings.js b/src/core/Settings.js
index e60aa3cba2..5c9db1e953 100644
--- a/src/core/Settings.js
+++ b/src/core/Settings.js
@@ -139,7 +139,8 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  *          cmcd: {
  *              enabled: false,
  *              sid: null,
- *              cid: null
+ *              cid: null,
+ *              rtp: null
  *          }
  *      }
  * }
@@ -627,7 +628,8 @@ function Settings() {
             cmcd: {
                 enabled: false,
                 sid: null,
-                cid: null
+                cid: null,
+                rtp: null
             }
         }
     };
diff --git a/src/streaming/models/CmcdModel.js b/src/streaming/models/CmcdModel.js
index 19377f4f42..10f6bb7a50 100644
--- a/src/streaming/models/CmcdModel.js
+++ b/src/streaming/models/CmcdModel.js
@@ -223,6 +223,12 @@ function CmcdModel() {
             }
         }
 
+        let rtp = settings.get().streaming.cmcd.rtp;
+        if (!rtp) {
+            rtp = _calculateRtp(request);
+        }
+        data.rtp = rtp;
+
         let nrr = request.range;
 
         if (nextRequest) {
@@ -505,6 +511,24 @@ function CmcdModel() {
         }
     }
 
+    function _calculateRtp(request) {
+        // Get the values we need
+        let playbackRate = playbackController.getPlaybackRate();
+        let { quality, mediaType, mediaInfo, duration } = request;
+        let currentBufferTime = _getBufferLevelByType(mediaType);
+        let bitrate = mediaInfo.bitrateList[quality].bandwidth;
+
+        // Calculate RTP
+        let segmentSize = bitrate * duration / 1000; // Calculate file size in kilobits
+        let timeToLoad = currentBufferTime * playbackRate / 1000; // Calculate time available to load file in seconds
+        let minBandwidth = segmentSize / timeToLoad; // Calculate the exact bandwidth required
+        let maxBandwidth = minBandwidth * 4; // Include a safety buffer
+
+        let rtp = (parseInt(maxBandwidth / 100) + 1) * 100; // Round to the next multiple of 100
+
+        return rtp;
+    }
+
     function reset() {
         eventBus.off(MediaPlayerEvents.PLAYBACK_RATE_CHANGED, _onPlaybackRateChanged, this);
         eventBus.off(MediaPlayerEvents.MANIFEST_LOADED, _onManifestLoaded, this);

From 66308e78aca101ba2899f928fb7bdb7037de11e8 Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Tue, 19 Jan 2021 13:44:59 +0100
Subject: [PATCH 03/13] Add JSDoc

---
 src/dash/DashHandler.js          | 12 ++++++++++++
 src/streaming/StreamProcessor.js |  4 ++++
 2 files changed, 16 insertions(+)

diff --git a/src/dash/DashHandler.js b/src/dash/DashHandler.js
index 584747d089..17750a2d53 100644
--- a/src/dash/DashHandler.js
+++ b/src/dash/DashHandler.js
@@ -308,6 +308,12 @@ function DashHandler(config) {
         return request;
     }
 
+    /**
+     * This function returns the next segment request without modifying any internal variables. Any class (e.g CMCD Model) that needs information about the upcoming request should use this method.
+     * @param {object} mediaInfo
+     * @param {object} representation
+     * @return {FragmentRequest|null}
+     */
     function getNextSegmentRequestIdempotent(mediaInfo, representation) {
         let request = null;
         let indexToRequest = segmentIndex + 1;
@@ -321,6 +327,12 @@ function DashHandler(config) {
         return request;
     }
 
+    /**
+     * Main function to get the next segment request.
+     * @param {object} mediaInfo
+     * @param {object} representation
+     * @return {FragmentRequest|null}
+     */
     function getNextSegmentRequest(mediaInfo, representation) {
         let request = null;
 
diff --git a/src/streaming/StreamProcessor.js b/src/streaming/StreamProcessor.js
index 13bca98e30..4b4086cced 100644
--- a/src/streaming/StreamProcessor.js
+++ b/src/streaming/StreamProcessor.js
@@ -458,6 +458,10 @@ function StreamProcessor(config) {
         scheduleController.processMediaRequest(request);
     }
 
+    /**
+     * Probe the next request. This is used in the CMCD model to get information about the upcoming request. Note: No actual request is performed here.
+     * @return {FragmentRequest|null}
+     */
     function probeNextRequest() {
         const representationInfo = getRepresentationInfo();
 

From 3ac587373971f2e714a49079c1a1e6d0c0857f62 Mon Sep 17 00:00:00 2001
From: Fritz Heiden <fritz.heiden@fokus.fraunhofer.de>
Date: Mon, 25 Jan 2021 14:56:55 +0100
Subject: [PATCH 04/13] Implemented requested changes

---
 src/streaming/MediaPlayer.js                  |  3 ++-
 src/streaming/models/CmcdModel.js             | 19 ++++++++-----------
 src/streaming/protection/Protection.js        |  3 ++-
 .../controllers/ProtectionController.js       | 15 ++++-----------
 4 files changed, 16 insertions(+), 24 deletions(-)

diff --git a/src/streaming/MediaPlayer.js b/src/streaming/MediaPlayer.js
index 6f41422032..ae4bf5eca2 100644
--- a/src/streaming/MediaPlayer.js
+++ b/src/streaming/MediaPlayer.js
@@ -2085,7 +2085,8 @@ function MediaPlayer() {
                 eventBus: eventBus,
                 events: Events,
                 BASE64: BASE64,
-                constants: Constants
+                constants: Constants,
+                cmcdModel: cmcdModel
             });
             return protectionController;
         }
diff --git a/src/streaming/models/CmcdModel.js b/src/streaming/models/CmcdModel.js
index 10f6bb7a50..ae09318a05 100644
--- a/src/streaming/models/CmcdModel.js
+++ b/src/streaming/models/CmcdModel.js
@@ -229,12 +229,13 @@ function CmcdModel() {
         }
         data.rtp = rtp;
 
-        let nrr = request.range;
+        let nrr;
 
         if (nextRequest) {
-            data.nor = nextRequest.url;
-            if (nextRequest.range) {
-                nrr = nextRequest.range;
+            let url = new URL(nextRequest.url);
+            data.nor = url.pathname;
+            if (request.url === nextRequest.url && nextRequest.range) {
+                nrr = nextRequest.nrr;
             }
         }
 
@@ -274,11 +275,6 @@ function CmcdModel() {
             data.pr = pr;
         }
 
-        // Assuming nor field is never set: If the ‘nor’ field is not set, then the object is assumed to match the object currently being requested.
-        if (request.range) {
-            data.nrr = request.range;
-        }
-
         if (_bufferLevelStarved[request.mediaType]) {
             data.bs = true;
             _bufferLevelStarved[request.mediaType] = false;
@@ -506,8 +502,9 @@ function CmcdModel() {
     function _probeNextRequest(mediaType) {
         if (!streamProcessors || streamProcessors.length === 0) return;
         for (let streamProcessor of streamProcessors) {
-            if (streamProcessor.getType() !== mediaType) continue;
-            return streamProcessor.probeNextRequest();
+            if (streamProcessor.getType() === mediaType) {
+                return streamProcessor.probeNextRequest();
+            }
         }
     }
 
diff --git a/src/streaming/protection/Protection.js b/src/streaming/protection/Protection.js
index 995f2050b5..c0c15a294e 100644
--- a/src/streaming/protection/Protection.js
+++ b/src/streaming/protection/Protection.js
@@ -129,7 +129,8 @@ function Protection() {
                 debug: config.debug,
                 events: config.events,
                 BASE64: config.BASE64,
-                constants: config.constants
+                constants: config.constants,
+                cmcdModel: config.cmcdModel
             });
             config.capabilities.setEncryptedMediaSupported(true);
         }
diff --git a/src/streaming/protection/controllers/ProtectionController.js b/src/streaming/protection/controllers/ProtectionController.js
index a1745fad22..a2f50421ee 100644
--- a/src/streaming/protection/controllers/ProtectionController.js
+++ b/src/streaming/protection/controllers/ProtectionController.js
@@ -34,8 +34,8 @@ import MediaCapability from '../vo/MediaCapability';
 import KeySystemConfiguration from '../vo/KeySystemConfiguration';
 import ProtectionErrors from '../errors/ProtectionErrors';
 import DashJSError from '../../vo/DashJSError';
-import CmcdModel from '../../models/CmcdModel';
 import { HTTPRequest } from '../../vo/metrics/HTTPRequest';
+import Utils from '../../../core/Utils';
 
 const NEEDKEY_BEFORE_INITIALIZE_RETRIES = 5;
 const NEEDKEY_BEFORE_INITIALIZE_TIMEOUT = 500;
@@ -69,7 +69,7 @@ function ProtectionController(config) {
     const BASE64 = config.BASE64;
     const constants = config.constants;
     let needkeyRetries = [];
-    const context = this.context;
+    const cmcdModel = config.cmcdModel;
 
     let instance,
         logger,
@@ -78,8 +78,7 @@ function ProtectionController(config) {
         protDataSet,
         sessionType,
         robustnessLevel,
-        keySystem,
-        cmcdModel;
+        keySystem;
 
     function setup() {
         logger = debug.getLogger(instance);
@@ -87,7 +86,6 @@ function ProtectionController(config) {
         mediaInfoArr = [];
         sessionType = 'temporary';
         robustnessLevel = '';
-        cmcdModel = CmcdModel(context).getInstance();
     }
 
     function checkConfig() {
@@ -784,12 +782,7 @@ function ProtectionController(config) {
         });
 
         if (cmcdParams) {
-            let queryPrefix = '?';
-            if (url.indexOf('?') !== -1) {
-                queryPrefix = '&';
-            }
-            const query = queryPrefix + cmcdParams.key + '=' + cmcdParams.value;
-            url = url + query;
+            Utils.addAditionalQueryParameterToUrl(url, cmcdParams);
         }
 
         xhr.open(method, url, true);

From 1039b2e416408a216242a71aea41f81e0f127947 Mon Sep 17 00:00:00 2001
From: Fritz Heiden <fritz.heiden@fokus.fraunhofer.de>
Date: Tue, 26 Jan 2021 14:36:40 +0100
Subject: [PATCH 05/13] Updated CMCD unit tests

- updated tests for nrr and nor
- added test for rtp
- updated logic for nrr and nor
---
 src/streaming/models/CmcdModel.js       | 17 +++++++----------
 test/unit/streaming.models.CmcdModel.js |  9 ++++++++-
 2 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/src/streaming/models/CmcdModel.js b/src/streaming/models/CmcdModel.js
index ae09318a05..237c20c9bb 100644
--- a/src/streaming/models/CmcdModel.js
+++ b/src/streaming/models/CmcdModel.js
@@ -229,20 +229,15 @@ function CmcdModel() {
         }
         data.rtp = rtp;
 
-        let nrr;
-
         if (nextRequest) {
-            let url = new URL(nextRequest.url);
-            data.nor = url.pathname;
-            if (request.url === nextRequest.url && nextRequest.range) {
-                nrr = nextRequest.nrr;
+            if (request.url !== nextRequest.url) {
+                let url = new URL(nextRequest.url);
+                data.nor = url.pathname;
+            } else if (nextRequest.range) {
+                data.nrr = nextRequest.range;
             }
         }
 
-        if (nrr) {
-            data.nrr = nrr;
-        }
-
         if (encodedBitrate) {
             data.br = encodedBitrate;
         }
@@ -511,8 +506,10 @@ function CmcdModel() {
     function _calculateRtp(request) {
         // Get the values we need
         let playbackRate = playbackController.getPlaybackRate();
+        if (!playbackRate) playbackRate = 1;
         let { quality, mediaType, mediaInfo, duration } = request;
         let currentBufferTime = _getBufferLevelByType(mediaType);
+        if (currentBufferTime === 0) currentBufferTime = 500;
         let bitrate = mediaInfo.bitrateList[quality].bandwidth;
 
         // Calculate RTP
diff --git a/test/unit/streaming.models.CmcdModel.js b/test/unit/streaming.models.CmcdModel.js
index c624ac0f79..8bf4b65cc9 100644
--- a/test/unit/streaming.models.CmcdModel.js
+++ b/test/unit/streaming.models.CmcdModel.js
@@ -102,7 +102,7 @@ describe('CmcdModel', function () {
             const MEASURED_THROUGHPUT = 8327641;
             const BUFFER_LEVEL = parseInt(dashMetricsMock.getCurrentBufferLevel() * 10) * 100;
             const VIDEO_OBJECT_TYPE = 'v';
-            const NEXT_OBJECT_URL = 'http://test.url/next_object';
+            const NEXT_OBJECT_URL = '/next_object';
             const NEXT_OBJECT_RANGE = '100-500';
 
             abrControllerMock.setTopBitrateInfo({bitrate: TOP_BITRATE});
@@ -144,6 +144,13 @@ describe('CmcdModel', function () {
             expect(metrics.tb).to.equal(parseInt(TOP_BITRATE / 1000));
             expect(metrics).to.have.property('nor');
             expect(metrics.nor).to.equal(NEXT_OBJECT_URL);
+            expect(metrics).to.have.property('rtp');
+            expect(typeof metrics.rtp).to.equal('number');
+            expect(metrics.rtp % 100).to.equal(0);
+
+            request.url = 'http://test.url/next_object';
+            parameters = cmcdModel.getQueryParameter(request);
+            metrics = parseQuery(parameters.value);
             expect(metrics).to.have.property('nrr');
             expect(metrics.nrr).to.equal(NEXT_OBJECT_RANGE);
         });

From 6f8d35e4ca05813417a08cd9570ca354539b58b3 Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 09:27:15 +0100
Subject: [PATCH 06/13] Add RTP value to JSdoc and index.d.ts

---
 index.d.ts           | 3 ++-
 src/core/Settings.js | 4 ++++
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/index.d.ts b/index.d.ts
index de32529272..5c65bc1a4c 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -217,7 +217,8 @@ declare namespace dashjs {
             cmcd?: {
                 enabled?: boolean,
                 sid?: string,
-                cid?: string
+                cid?: string,
+                rtp?: number
             }
         }
     }
diff --git a/src/core/Settings.js b/src/core/Settings.js
index 5c9db1e953..8110a10f0d 100644
--- a/src/core/Settings.js
+++ b/src/core/Settings.js
@@ -467,6 +467,10 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  * A unique string to identify the current content.
  *
  * If not specified it will be a hash of the MPD url.
+ * @property {number} [rtp]
+ * The requested maximum throughput that the client considers sufficient for delivery of the asset.
+ *
+ * If not specified this value will be dynamically calculated in the CMCDModel based on the current buffer level.
  */
 
 /**

From 9afb81b34b1ffd9b93ea2d1e148318d9c874d54f Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 09:40:31 +0100
Subject: [PATCH 07/13] Use underscore notation for private function in
 CmcdModel.js

---
 src/streaming/models/CmcdModel.js | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/streaming/models/CmcdModel.js b/src/streaming/models/CmcdModel.js
index 237c20c9bb..799f4f0493 100644
--- a/src/streaming/models/CmcdModel.js
+++ b/src/streaming/models/CmcdModel.js
@@ -120,14 +120,14 @@ function CmcdModel() {
         _bufferLevelStarved = {};
         _isStartup = {};
         _initialMediaRequestsDone = {};
-        updateStreamProcessors();
+        _updateStreamProcessors();
     }
 
     function _onPeriodSwitchComplete() {
-        updateStreamProcessors();
+        _updateStreamProcessors();
     }
 
-    function updateStreamProcessors() {
+    function _updateStreamProcessors() {
         if (!playbackController) return;
         const streamController = playbackController.getStreamController();
         if (!streamController) return;

From ccfbaca889ff56a34cd2545846d8c21abc5c7176 Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 11:20:16 +0100
Subject: [PATCH 08/13] Add rtpSafetyFactor to settings

---
 index.d.ts                                   |  3 ++-
 samples/dash-if-reference-player/app/main.js |  1 +
 samples/dash-if-reference-player/index.html  |  2 ++
 src/core/Settings.js                         | 10 ++++++++--
 src/streaming/models/CmcdModel.js            | 19 +++++++++++--------
 5 files changed, 24 insertions(+), 11 deletions(-)

diff --git a/index.d.ts b/index.d.ts
index 5c65bc1a4c..8b9066e724 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -218,7 +218,8 @@ declare namespace dashjs {
                 enabled?: boolean,
                 sid?: string,
                 cid?: string,
-                rtp?: number
+                rtp?: number,
+                rtpSafetyFactor?: number
             }
         }
     }
diff --git a/samples/dash-if-reference-player/app/main.js b/samples/dash-if-reference-player/app/main.js
index 85c2e5be25..b73ff82533 100644
--- a/samples/dash-if-reference-player/app/main.js
+++ b/samples/dash-if-reference-player/app/main.js
@@ -696,6 +696,7 @@ app.controller('DashController', ['$scope', '$window', 'sources', 'contributors'
         config.streaming.cmcd.sid = $scope.cmcdSessionId ? $scope.cmcdSessionId : null;
         config.streaming.cmcd.cid = $scope.cmcdContentId ? $scope.cmcdContentId : null;
         config.streaming.cmcd.rtp = $scope.cmcdRtp ? $scope.cmcdRtp : null;
+        config.streaming.cmcd.rtpSafetyFactor = $scope.cmcdRtpSafetyFactor ? $scope.cmcdRtpSafetyFactor : null;
 
         $scope.player.updateSettings(config);
 
diff --git a/samples/dash-if-reference-player/index.html b/samples/dash-if-reference-player/index.html
index af29456031..7e716d1f76 100644
--- a/samples/dash-if-reference-player/index.html
+++ b/samples/dash-if-reference-player/index.html
@@ -457,6 +457,8 @@
                 <input type="text" class="form-control" placeholder="content id" ng-model="cmcdContentId">
                 <label class="options-label">Requested maximum throughput (rtp):</label>
                 <input type="text" class="form-control" placeholder="rtp in kbps" ng-model="cmcdRtp">
+                <label class="options-label">RTP safety factor:</label>
+                <input type="text" class="form-control" placeholder="Default 5" ng-model="cmcdRtpSafetyFactor">
             </div>
         </div>
 
diff --git a/src/core/Settings.js b/src/core/Settings.js
index 8110a10f0d..6109087de9 100644
--- a/src/core/Settings.js
+++ b/src/core/Settings.js
@@ -140,7 +140,8 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  *              enabled: false,
  *              sid: null,
  *              cid: null,
- *              rtp: null
+ *              rtp: null,
+ *              rtpSafetyFactor: 5
  *          }
  *      }
  * }
@@ -471,6 +472,10 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  * The requested maximum throughput that the client considers sufficient for delivery of the asset.
  *
  * If not specified this value will be dynamically calculated in the CMCDModel based on the current buffer level.
+ * @property {number} [rtpSafetyFactor]
+ * This value is used as a factor for the rtp value calculation: rtp = minBandwidth * rtpSafetyFactor
+ *
+ * If not specified this value defaults to 5. Note that this value is only used no static rtp value is defined.
  */
 
 /**
@@ -633,7 +638,8 @@ function Settings() {
                 enabled: false,
                 sid: null,
                 cid: null,
-                rtp: null
+                rtp: null,
+                rtpSafetyFactor: 5
             }
         }
     };
diff --git a/src/streaming/models/CmcdModel.js b/src/streaming/models/CmcdModel.js
index 799f4f0493..1ba52de077 100644
--- a/src/streaming/models/CmcdModel.js
+++ b/src/streaming/models/CmcdModel.js
@@ -34,6 +34,7 @@ import MetricsReportingEvents from '../metrics/MetricsReportingEvents';
 import FactoryMaker from '../../core/FactoryMaker';
 import Debug from '../../core/Debug';
 import Settings from '../../core/Settings';
+import Constants from '../../streaming/constants/Constants';
 import {HTTPRequest} from '../vo/metrics/HTTPRequest';
 import DashManifestModel from '../../dash/models/DashManifestModel';
 import Utils from '../../core/Utils';
@@ -58,6 +59,7 @@ const STREAM_TYPES = {
     VOD: 'v',
     LIVE: 'l'
 };
+const RTP_SAFETY_FACTOR = 5;
 
 function CmcdModel() {
 
@@ -213,9 +215,9 @@ function CmcdModel() {
         const nextRequest = _probeNextRequest(request.mediaType);
 
         let ot;
-        if (request.mediaType === 'video') ot = OBJECT_TYPES.VIDEO;
-        if (request.mediaType === 'audio') ot = OBJECT_TYPES.AUDIO;
-        if (request.mediaType === 'fragmentedText') {
+        if (request.mediaType === Constants.VIDEO) ot = OBJECT_TYPES.VIDEO;
+        if (request.mediaType === Constants.AUDIO) ot = OBJECT_TYPES.AUDIO;
+        if (request.mediaType === Constants.FRAGMENTED_TEXT) {
             if (request.mediaInfo.mimeType === 'application/mp4') {
                 ot = OBJECT_TYPES.ISOBMFF_TEXT_TRACK;
             } else {
@@ -468,7 +470,7 @@ function CmcdModel() {
             if (!cmcdData) {
                 return null;
             }
-            const keys = Object.keys(cmcdData).sort((a, b) =>a.localeCompare(b));
+            const keys = Object.keys(cmcdData).sort((a, b) => a.localeCompare(b));
             const length = keys.length;
 
             let cmcdString = keys.reduce((acc, key, index) => {
@@ -508,15 +510,16 @@ function CmcdModel() {
         let playbackRate = playbackController.getPlaybackRate();
         if (!playbackRate) playbackRate = 1;
         let { quality, mediaType, mediaInfo, duration } = request;
-        let currentBufferTime = _getBufferLevelByType(mediaType);
-        if (currentBufferTime === 0) currentBufferTime = 500;
+        let currentBufferLevel = _getBufferLevelByType(mediaType);
+        if (currentBufferLevel === 0) currentBufferLevel = 500;
         let bitrate = mediaInfo.bitrateList[quality].bandwidth;
 
         // Calculate RTP
         let segmentSize = bitrate * duration / 1000; // Calculate file size in kilobits
-        let timeToLoad = currentBufferTime * playbackRate / 1000; // Calculate time available to load file in seconds
+        let timeToLoad = currentBufferLevel * playbackRate / 1000; // Calculate time available to load file in seconds
         let minBandwidth = segmentSize / timeToLoad; // Calculate the exact bandwidth required
-        let maxBandwidth = minBandwidth * 4; // Include a safety buffer
+        let rtpSafetyFactor = !isNaN(settings.get().streaming.cmcd.rtpSafetyFactor) ? settings.get().streaming.cmcd.rtpSafetyFactor : RTP_SAFETY_FACTOR;
+        let maxBandwidth = minBandwidth * rtpSafetyFactor; // Include a safety buffer
 
         let rtp = (parseInt(maxBandwidth / 100) + 1) * 100; // Round to the next multiple of 100
 

From 739cd9286a3d15d0ecb2953b3216ff3606d282a3 Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 11:23:29 +0100
Subject: [PATCH 09/13] Fix typo

---
 src/core/Settings.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/core/Settings.js b/src/core/Settings.js
index 6109087de9..76b498c8e0 100644
--- a/src/core/Settings.js
+++ b/src/core/Settings.js
@@ -475,7 +475,7 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  * @property {number} [rtpSafetyFactor]
  * This value is used as a factor for the rtp value calculation: rtp = minBandwidth * rtpSafetyFactor
  *
- * If not specified this value defaults to 5. Note that this value is only used no static rtp value is defined.
+ * If not specified this value defaults to 5. Note that this value is only used when no static rtp value is defined.
  */
 
 /**

From ab15fac962191835c5dffa3945d839479fcbea4f Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 11:35:48 +0100
Subject: [PATCH 10/13] Fix rtpSafetyFactor

---
 src/streaming/models/CmcdModel.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/streaming/models/CmcdModel.js b/src/streaming/models/CmcdModel.js
index 1ba52de077..5df9a3e470 100644
--- a/src/streaming/models/CmcdModel.js
+++ b/src/streaming/models/CmcdModel.js
@@ -518,7 +518,7 @@ function CmcdModel() {
         let segmentSize = bitrate * duration / 1000; // Calculate file size in kilobits
         let timeToLoad = currentBufferLevel * playbackRate / 1000; // Calculate time available to load file in seconds
         let minBandwidth = segmentSize / timeToLoad; // Calculate the exact bandwidth required
-        let rtpSafetyFactor = !isNaN(settings.get().streaming.cmcd.rtpSafetyFactor) ? settings.get().streaming.cmcd.rtpSafetyFactor : RTP_SAFETY_FACTOR;
+        let rtpSafetyFactor = settings.get().streaming.cmcd.rtpSafetyFactor && !isNaN(settings.get().streaming.cmcd.rtpSafetyFactor) ? settings.get().streaming.cmcd.rtpSafetyFactor : RTP_SAFETY_FACTOR;
         let maxBandwidth = minBandwidth * rtpSafetyFactor; // Include a safety buffer
 
         let rtp = (parseInt(maxBandwidth / 100) + 1) * 100; // Round to the next multiple of 100

From ba426acc58d233bad8eb4dce07de6dc9787bd706 Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 11:42:20 +0100
Subject: [PATCH 11/13] Fix CMCD reporting for DRM content

---
 src/streaming/protection/controllers/ProtectionController.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/streaming/protection/controllers/ProtectionController.js b/src/streaming/protection/controllers/ProtectionController.js
index a2f50421ee..97253f6b00 100644
--- a/src/streaming/protection/controllers/ProtectionController.js
+++ b/src/streaming/protection/controllers/ProtectionController.js
@@ -782,7 +782,7 @@ function ProtectionController(config) {
         });
 
         if (cmcdParams) {
-            Utils.addAditionalQueryParameterToUrl(url, cmcdParams);
+            url = Utils.addAditionalQueryParameterToUrl(url, [cmcdParams]);
         }
 
         xhr.open(method, url, true);

From ab88bc7a3b7415fccdc44fe88d6fc50dc998e3d1 Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 11:51:46 +0100
Subject: [PATCH 12/13] Add CMCD tooltips in reference UI

---
 samples/dash-if-reference-player/index.html | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/samples/dash-if-reference-player/index.html b/samples/dash-if-reference-player/index.html
index 7e716d1f76..8d505f44a3 100644
--- a/samples/dash-if-reference-player/index.html
+++ b/samples/dash-if-reference-player/index.html
@@ -455,9 +455,12 @@
                 <input type="text" class="form-control" placeholder="mandatory session id" ng-model="cmcdSessionId">
                 <label class="options-label">Content ID:</label>
                 <input type="text" class="form-control" placeholder="content id" ng-model="cmcdContentId">
-                <label class="options-label">Requested maximum throughput (rtp):</label>
+                <label class="options-label" data-toggle="tooltip" data-placement="right"
+                       title="A static value to be used as RTP parameter">Requested maximum throughput (rtp):</label>
                 <input type="text" class="form-control" placeholder="rtp in kbps" ng-model="cmcdRtp">
-                <label class="options-label">RTP safety factor:</label>
+                <label class="options-label" data-toggle="tooltip" data-placement="right"
+                       title="This value is used as a factor for the rtp value calculation: rtp = minBandwidth * rtpSafetyFactor. If not specified this value defaults to 5. Note that this value is only used when no static rtp value is defined.">RTP
+                    safety factor:</label>
                 <input type="text" class="form-control" placeholder="Default 5" ng-model="cmcdRtpSafetyFactor">
             </div>
         </div>
@@ -702,9 +705,9 @@
                 </div>
             </div>
         </div>
-        
+
     </div>
-    
+
     <!-- ERROR MODAL -->
     <div class="modal fade" id="errorModal" tabindex="-1" role="dialog" aria-labelledby="errorModalLabel"
          aria-hidden="true">
@@ -749,7 +752,9 @@ <h5 class="modal-title" id="errorModalLabel">Error {{errorType}}</h5>
             <div id="conformance-violations">
                 <h4>Conformance Violations </h4>
                 <ul class="list-unstyled" ng-repeat="conformanceViolation in conformanceViolations">
-                    <li><span class="label label-{{conformanceViolation.level}}">{{conformanceViolation.level}}</span> : {{conformanceViolation.event.message}} </li>
+                    <li><span class="label label-{{conformanceViolation.level}}">{{conformanceViolation.level}}</span> :
+                        {{conformanceViolation.event.message}}
+                    </li>
                 </ul>
             </div>
         </div>

From 396bce9c8822f970db8ce73c60744032d2f0b702 Mon Sep 17 00:00:00 2001
From: dsilhavy <daniel.silhavy@fokus.fraunhofer.de>
Date: Wed, 27 Jan 2021 12:02:46 +0100
Subject: [PATCH 13/13] Add unit tests for static rtp value

---
 test/unit/streaming.models.CmcdModel.js | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/test/unit/streaming.models.CmcdModel.js b/test/unit/streaming.models.CmcdModel.js
index 8bf4b65cc9..69c109f307 100644
--- a/test/unit/streaming.models.CmcdModel.js
+++ b/test/unit/streaming.models.CmcdModel.js
@@ -315,6 +315,28 @@ describe('CmcdModel', function () {
             expect(metrics).to.have.property('cid');
             expect(metrics.cid).to.equal(CID);
         });
+
+        it('getQueryParameter() returns correct RTP value if set to static ', function () {
+            const REQUEST_TYPE = HTTPRequest.MEDIA_SEGMENT_TYPE;
+            const MEDIA_TYPE = 'video';
+
+            let request = {
+                type: REQUEST_TYPE,
+                mediaType: MEDIA_TYPE
+            };
+
+            settings.update({streaming: {cmcd: {enabled: true, rtp: 10000}}});
+
+            let parameters = cmcdModel.getQueryParameter(request);
+            expect(parameters).to.have.property('key');
+            expect(parameters.key).to.equal('CMCD');
+            expect(parameters).to.have.property('value');
+            expect(typeof parameters.value).to.equal('string');
+
+            let metrics = parseQuery(parameters.value);
+            expect(metrics).to.have.property('rtp');
+            expect(metrics.rtp).to.equal(10000);
+        });
     });
 });