Merge remote-tracking branch 'origin/development' into feature/multiB…

…uild

index.d.ts

@@ -1024,6 +1024,14 @@ declare namespace dashjs {
         value: string;
     }
 
+    export interface ThroughputDictValue {
+        downloadTimeInMs: number,
+        downloadedBytes: number,
+        latencyInMs: number
+        serviceLocation: string,
+        value: number,
+    }
+
     /**
      * Dash
      **/
@@ -1630,7 +1638,6 @@ declare namespace dashjs {
             applyServiceDescription?: boolean,
             applyProducerReferenceTime?: boolean,
             applyContentSteering?: boolean,
-            eventControllerRefreshDelay?: number,
             enableManifestDurationMismatchFix?: boolean,
             parseInbandPrft?: boolean,
             enableManifestTimescaleMismatchFix?: boolean,
@@ -1643,6 +1650,10 @@ declare namespace dashjs {
                 filterHDRMetadataFormatEssentialProperties?: boolean,
                 filterVideoColometryEssentialProperties?: boolean
             },
+            events?: {
+                eventControllerRefreshDelay?: number,
+                deleteEventMessageDataAfterEventStarted?: boolean
+            }
             timeShiftBuffer?: {
                 calcFromSegmentTimeline?: boolean
                 fallbackToSegmentTimeline?: boolean
@@ -2049,6 +2060,8 @@ declare namespace dashjs {
 
         getAvailableLocations(): MpdLocation[];
 
+        getAverageLatency(type: MediaType, calculationMode?: string | null, sampleSize?: number): number;
+
         getAverageThroughput(type: MediaType, calculationMode?: string | null, sampleSize?: number): number;
 
         getBufferLength(type: MediaType): number;
@@ -2085,8 +2098,12 @@ declare namespace dashjs {
 
         getProtectionController(): ProtectionController;
 
+        getRawThroughputData(type: MediaType): ThroughputDictValue[];
+
         getRepresentationsByType(type: MediaType, streamId?: string | null): Representation[];
 
+        getSafeAverageThroughput(type: MediaType, calculationMode?: string | null, sampleSize?: number): number;
+
         getSettings(): MediaPlayerSettingClass;
 
         getSource(): string | object;
@@ -5499,11 +5516,21 @@ declare namespace dashjs {
     }
 
     export class IsoBoxSearchInfo {
-        constructor(lastCompletedOffset: number, found: boolean, size: number);
+        constructor(found: boolean,
+                    sizeOfLastCompletedBox: number,
+                    sizeOfLastFoundTargetBox: number,
+                    startOffsetOfLastCompletedBox: number,
+                    startOffsetOfLastFoundTargetBox: number,
+                    typeOfLastCompletedBox: string,
+                    typeOfLastTargetBox: string);
 
         found: boolean;
-        lastCompletedOffset: number;
-        size: number;
+        sizeOfLastCompletedBox: number;
+        sizeOfLastFoundTargetBox: number;
+        startOffsetOfLastCompletedBox: number;
+        startOffsetOfLastFoundTargetBox: number;
+        typeOfLastCompletedBox: string | null;
+        typeOfLastTargetBox: string | null;
     }
 
     export class MetricsList {

samples/advanced/ext-url-query-info.html

@@ -153,7 +153,7 @@ <h3>Flexible Insertion of URL Parameters Sample</h3>
             <div class="row mt-2">
                 <div class="col-md-6">
                     <label for="manifestSelect">Manifest:</label>
-                    <input id="manifestSelect" type="text" class="form-control">
+                    <input id="manifestSelect" value="https://livesim.dashif.org/livesim2/annexI_dashjs=rocks/testpic_6s/Manifest.mpd?dashjs=rocks" type="text" class="form-control">
                     <label for="queryParamsInput" class="mt-2">Add Query Parameters to Manifest Request:</label>
                     <input id="queryParamsInput" type="text" class="form-control" value="token=1234">
                     <button id="loadButton" class="btn btn-primary mt-2">Load</button>

samples/dash-if-reference-player/app/sources.json

@@ -280,6 +280,11 @@
                     "name": "SCTE35 events",
                     "provider": "dashif"
                 },
+                {
+                    "url": "https://livesim.dashif.org/livesim2/annexI_dashjs=rocks/testpic_6s/Manifest.mpd?dashjs=rocks",
+                    "name": "Annex I query parameters in the Video AdaptationSet",
+                    "provider": "dashif"
+                },
                 {
                     "url": "https://demo.unified-streaming.com/k8s/live/scte35.isml/.mpd",
                     "name": "Unified Streaming reference stream with scte35 markers",

src/core/Settings.js

@@ -67,7 +67,6 @@ import Events from './events/Events.js';
  *            applyServiceDescription: true,
  *            applyProducerReferenceTime: true,
  *            applyContentSteering: true,
- *            eventControllerRefreshDelay: 100,
  *            enableManifestDurationMismatchFix: true,
  *            parseInbandPrft: false,
  *            enableManifestTimescaleMismatchFix: false,
@@ -86,6 +85,10 @@ import Events from './events/Events.js';
  *               filterVideoColorimetryEssentialProperties: false,
  *               filterHDRMetadataFormatEssentialProperties: false
  *            },
+ *            events: {
+ *              eventControllerRefreshDelay: 100,
+ *              deleteEventMessageDataAfterEventStarted: true
+ *            }
  *            timeShiftBuffer: {
  *                calcFromSegmentTimeline: false,
  *                fallbackToSegmentTimeline: true
@@ -264,7 +267,7 @@ import Events from './events/Events.js';
  *                     useResourceTimingApi: true,
  *                     useNetworkInformationApi: {
  *                         xhr: false,
- *                         fetch: true
+ *                         fetch: false
  *                     },
  *                     useDeadTimeLatency: true,
  *                     bandwidthSafetyFactor: 0.9,
@@ -281,7 +284,8 @@ import Events from './events/Events.js';
  *                         throughputSlowHalfLifeSeconds: 8,
  *                         throughputFastHalfLifeSeconds: 3,
  *                         latencySlowHalfLifeCount: 2,
- *                         latencyFastHalfLifeCount: 1
+ *                         latencyFastHalfLifeCount: 1,
+ *                         weightDownloadTimeMultiplicationFactor: 0.0015
  *                     }
  *                 },
  *                 maxBitrate: {
@@ -342,6 +346,16 @@ import Events from './events/Events.js';
  * In case the MPD uses \<SegmentTimeline\ and no segment is found within the DVR window the DVR window is calculated based on the entries in \<SegmentTimeline\>.
  */
 
+/**
+ * @typedef {Object} EventSettings
+ * @property {number} [eventControllerRefreshDelay=100]
+ * Interval timer used by the EventController to check if events need to be triggered or removed.
+ * @property {boolean} [deleteEventMessageDataAfterEventStarted=true]
+ * If this flag is enabled the EventController will delete the message data of events after they have been started. This is to save memory in case events have a long duration and need to be persisted in the EventController.
+ * Note: Applications will receive a copy of the original event data when they subscribe to an event. This copy contains the original message data and is not affected by this setting.
+ * Only if an event is dispatched for the second time (e.g. when the user seeks back) the message data will not be included in the dispatched event.
+ */
+
 /**
  * @typedef {Object} LiveDelay
  * @property {number} [liveDelayFragmentCount=NaN]
@@ -827,7 +841,7 @@ import Events from './events/Events.js';
  * @property {boolean} [useResourceTimingApi=true]
  * If set to true the ResourceTimingApi is used to derive the download time and the number of downloaded bytes.
  * This option has no effect for low latency streaming as the download time equals the segment duration in most of the cases and therefor does not provide reliable values
- * @property {object} [useNetworkInformationApi = { xhr=false, fetch=true}]
+ * @property {object} [useNetworkInformationApi = { xhr=false, fetch=false}]
  * If set to true the NetworkInformationApi is used to derive the current throughput. Browser support is limited, only available in Chrome and Edge.
  * Applies to standard (XHR requests) and/or low latency streaming (Fetch API requests).
  * @property {boolean} [useDeadTimeLatency=true]
@@ -847,12 +861,13 @@ import Events from './events/Events.js';
  * - `increaseScale`: Increase sample size by one if the ratio of current and previous sample is higher or equal this value
  * - `maxMeasurementsToKeep`: Number of samples to keep before sliding samples out of the window
  * - `averageLatencySampleAmount`: Number of latency samples to use (sample size)
- * @property {object} [ewma={throughputSlowHalfLifeSeconds=8,throughputFastHalfLifeSeconds=3,latencySlowHalfLifeCount=2,latencyFastHalfLifeCount=1}]
+ * @property {object} [ewma={throughputSlowHalfLifeSeconds=8,throughputFastHalfLifeSeconds=3,latencySlowHalfLifeCount=2,latencyFastHalfLifeCount=1, weightDownloadTimeMultiplicationFactor=0.0015}]
  * When deriving the throughput based on the exponential weighted moving average these settings define:
  * - `throughputSlowHalfLifeSeconds`: Number by which the weight of the current throughput measurement is divided, see ThroughputModel._updateEwmaValues
  * - `throughputFastHalfLifeSeconds`: Number by which the weight of the current throughput measurement is divided, see ThroughputModel._updateEwmaValues
  * - `latencySlowHalfLifeCount`: Number by which the weight of the current latency is divided, see ThroughputModel._updateEwmaValues
  * - `latencyFastHalfLifeCount`: Number by which the weight of the current latency is divided, see ThroughputModel._updateEwmaValues
+ * - `weightDownloadTimeMultiplicationFactor`: This value is multiplied with the download time in milliseconds to derive the weight for the EWMA calculation.
  */
 
 /**
@@ -937,8 +952,6 @@ 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 {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]
  * Overwrite the manifest segments base information timescale attributes with the timescale set in initialization segments
  * @property {boolean} [enableManifestTimescaleMismatchFix=false]
@@ -947,6 +960,7 @@ import Events from './events/Events.js';
  * Set to true if dash.js should parse inband prft boxes (ProducerReferenceTime) and trigger events.
  * @property {module:Settings~Metrics} metrics Metric settings
  * @property {module:Settings~LiveDelay} delay Live Delay settings
+ * @property {module:Settings~EventSettings} events Event settings
  * @property {module:Settings~TimeShiftBuffer} timeShiftBuffer TimeShiftBuffer settings
  * @property {module:Settings~Protection} protection DRM related settings
  * @property {module:Settings~Capabilities} capabilities Capability related settings
@@ -1078,7 +1092,6 @@ function Settings() {
             applyServiceDescription: true,
             applyProducerReferenceTime: true,
             applyContentSteering: true,
-            eventControllerRefreshDelay: 100,
             enableManifestDurationMismatchFix: true,
             parseInbandPrft: false,
             enableManifestTimescaleMismatchFix: false,
@@ -1099,6 +1112,10 @@ function Settings() {
                 filterVideoColorimetryEssentialProperties: false,
                 filterHDRMetadataFormatEssentialProperties: false
             },
+            events: {
+                eventControllerRefreshDelay: 100,
+                deleteEventMessageDataAfterEventStarted: true
+            },
             timeShiftBuffer: {
                 calcFromSegmentTimeline: false,
                 fallbackToSegmentTimeline: true
@@ -1290,7 +1307,7 @@ function Settings() {
                     useResourceTimingApi: true,
                     useNetworkInformationApi: {
                         xhr: false,
-                        fetch: true
+                        fetch: false
                     },
                     useDeadTimeLatency: true,
                     bandwidthSafetyFactor: 0.9,

src/streaming/MediaPlayer.js

@@ -1232,6 +1232,20 @@ function MediaPlayer() {
         customParametersModel.restoreDefaultUTCTimingSources();
     }
 
+    /**
+     * Returns the average latency computed in the ThroughputController in milliseconds
+     *
+     * @param {MediaType} type
+     * @param {string} calculationMode
+     * @param {number} sampleSize
+     * @return {number} value
+     * @memberof module:MediaPlayer
+     * @instance
+     */
+    function getAverageLatency(type, calculationMode = null, sampleSize = NaN) {
+        return throughputController ? throughputController.getAverageLatency(type, calculationMode, sampleSize) : 0;
+    }
+
     /**
      * Returns the average throughput computed in the ThroughputController in kbit/s
      *
@@ -1246,6 +1260,32 @@ function MediaPlayer() {
         return throughputController ? throughputController.getAverageThroughput(type, calculationMode, sampleSize) : 0;
     }
 
+    /**
+     * Returns the safe average throughput computed in the ThroughputController in kbit/s. The safe average throughput is the average throughput multiplied by bandwidthSafetyFactor
+     *
+     * @param {MediaType} type
+     * @param {string} calculationMode
+     * @param {number} sampleSize
+     * @return {number} value
+     * @memberof module:MediaPlayer
+     * @instance
+     */
+    function getSafeAverageThroughput(type, calculationMode = null, sampleSize = NaN) {
+        return throughputController ? throughputController.getSafeAverageThroughput(type, calculationMode, sampleSize) : 0;
+    }
+
+    /**
+     *  Returns the raw throughput data without calculating the average. This can be used to calculate the current throughput yourself.
+     *
+     * @param {MediaType} type
+     * @return {Array} value
+     * @memberof module:MediaPlayer
+     * @instance
+     */
+    function getRawThroughputData(type) {
+        return throughputController ? throughputController.getRawThroughputData(type) : [];
+    }
+
     /**
      * Sets whether withCredentials on XHR requests for a particular request
      * type is true or false
@@ -2759,6 +2799,7 @@ function MediaPlayer() {
         getAutoPlay,
         getAvailableBaseUrls,
         getAvailableLocations,
+        getAverageLatency,
         getAverageThroughput,
         getBufferLength,
         getCurrentLiveLatency,
@@ -2777,7 +2818,9 @@ function MediaPlayer() {
         getOfflineController,
         getPlaybackRate,
         getProtectionController,
+        getRawThroughputData,
         getRepresentationsByType,
+        getSafeAverageThroughput,
         getSettings,
         getSource,
         getStreamsFromManifest,

src/streaming/Stream.js

@@ -552,6 +552,10 @@ function Stream(config) {
         if (textController) {
             textController.deactivateStream(streamInfo);
         }
+        if (thumbnailController) {
+            thumbnailController.reset();
+            thumbnailController = null;
+        }
         streamProcessors = [];
         isActive = false;
         hasFinishedBuffering = false;
@@ -624,6 +628,10 @@ function Stream(config) {
             segmentBlacklistController = null;
         }
 
+        if (textController && streamInfo) {
+            textController.clearDataForStream(streamInfo.id);
+        }
+
         resetInitialSettings(keepBuffers);
 
         streamInfo = null;

src/streaming/controllers/BlacklistController.js

@@ -78,6 +78,9 @@ function BlackListController(config) {
     }
 
     function reset() {
+        if (addBlacklistEventName) {
+            eventBus.off(addBlacklistEventName, onAddBlackList, instance);
+        }
         blacklist = [];
     }
 

src/streaming/controllers/EventController.js

@@ -118,7 +118,7 @@ function EventController() {
         try {
             checkConfig();
             logger.debug('Start Event Controller');
-            const refreshDelay = settings.get().streaming.eventControllerRefreshDelay;
+            const refreshDelay = settings.get().streaming.events.eventControllerRefreshDelay;
             if (!isStarted && !isNaN(refreshDelay)) {
                 isStarted = true;
                 eventInterval = setInterval(_onEventTimer, refreshDelay);
@@ -474,7 +474,7 @@ function EventController() {
             if (mode === MediaPlayerEvents.EVENT_MODE_ON_RECEIVE && !event.triggeredReceivedEvent) {
                 logger.debug(`Received event ${eventId}`);
                 event.triggeredReceivedEvent = true;
-                eventBus.trigger(event.eventStream.schemeIdUri, { event: event }, { mode });
+                eventBus.trigger(event.eventStream.schemeIdUri, { event: JSON.parse(JSON.stringify(event)) }, { mode });
                 return;
             }
 
@@ -490,7 +490,11 @@ function EventController() {
                     _sendCallbackRequest(event.messageData);
                 } else {
                     logger.debug(`Starting event ${eventId} from period ${event.eventStream.period.id} at ${currentVideoTime}`);
-                    eventBus.trigger(event.eventStream.schemeIdUri, { event: event }, { mode });
+                    eventBus.trigger(event.eventStream.schemeIdUri, { event: JSON.parse(JSON.stringify(event)) }, { mode });
+                    if (settings.get().streaming.events.deleteEventMessageDataAfterEventStarted) {
+                        delete event.messageData;
+                        delete event.parsedMessageData;
+                    }
                 }
                 event.triggeredStartEvent = true;
             }