Merge branch 'Dash-Industry-Forum:development' into task/segement-template-util

Author: littlespex

index.d.ts

@@ -989,6 +989,7 @@ declare namespace dashjs {
         startNumber: number;
         timescale: number;
         width: number;
+        endNumber: number | null;
     }
 
     export interface Segment {
@@ -1656,7 +1657,7 @@ declare namespace dashjs {
             },
             events?: {
                 eventControllerRefreshDelay?: number,
-                deleteEventMessageDataAfterEventStarted?: boolean
+                deleteEventMessageDataTimeout?: number
             }
             timeShiftBuffer?: {
                 calcFromSegmentTimeline?: boolean
@@ -4127,7 +4128,7 @@ declare namespace dashjs {
 
         getSupportedKeySystemMetadataFromContentProtection(cps: object[], protDataSet: ProtectionDataSet, sessionType: string): object[];
 
-        getSupportedKeySystemsFromSegmentPssh(initData: ArrayBuffer, protDataSet: ProtectionDataSet, sessionType: string): object[];
+        getSupportedKeySystemMetadataFromSegmentPssh(initData: ArrayBuffer, protDataSet: ProtectionDataSet, sessionType: string): object[];
 
         initDataEquals(initData1: ArrayBuffer, initData2: ArrayBuffer): boolean;
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dashjs",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.",
   "author": "Dash Industry Forum",
   "license": "BSD-3-Clause",

src/core/Settings.js

@@ -87,7 +87,7 @@ import Events from './events/Events.js';
  *            },
  *            events: {
  *              eventControllerRefreshDelay: 100,
- *              deleteEventMessageDataAfterEventStarted: true
+ *              deleteEventMessageDataTimeout: 10000
  *            }
  *            timeShiftBuffer: {
  *                calcFromSegmentTimeline: false,
@@ -352,10 +352,12 @@ import Events from './events/Events.js';
  * @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.
+ * @property {number} [deleteEventMessageDataTimeout=10000]
+ * If this value is larger than -1 the EventController will delete the message data attributes of events after they have been started and dispatched to the application.
+ * This is to save memory in case events have a long duration and need to be persisted in the EventController.
+ * This parameter defines the time in milliseconds between the start of an event and when the message data is deleted.
+ * 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 if it has been deleted already.
+ * Set this value to -1 to not delete any message data.
  */
 
 /**
@@ -693,7 +695,7 @@ import Events from './events/Events.js';
  * @property {boolean} [detectPlayreadyMessageFormat=true]
  * If set to true the player will use the raw unwrapped message from the Playready CDM
  *
- * @property {boolean} [ignoreKeyStatusest=false]
+ * @property {boolean} [ignoreKeyStatuses=false]
  * If set to true the player will ignore the status of a key and try to play the corresponding track regardless whether the key is usable or not.
  */
 
@@ -1118,7 +1120,7 @@ function Settings() {
             },
             events: {
                 eventControllerRefreshDelay: 100,
-                deleteEventMessageDataAfterEventStarted: true
+                deleteEventMessageDataTimeout: 10000
             },
             timeShiftBuffer: {
                 calcFromSegmentTimeline: false,

src/core/Utils.js

@@ -108,17 +108,21 @@ class Utils {
         // Get the search parameters
         const params = new URLSearchParams(parsedUrl.search);
 
-        if (!params || params.size === 0) {
+        if (!params || params.size === 0 || !params.has(queryParameter)) {
             return url;
         }
 
-        // Remove the CMCD parameter
+        // Remove the queryParameter
         params.delete(queryParameter);
 
-        // Reconstruct the URL without the CMCD parameter
-        parsedUrl.search = params.toString();
+        // Manually reconstruct the query string without re-encoding
+        const queryString = Array.from(params.entries())
+            .map(([key, value]) => `${key}=${value}`)
+            .join('&');
 
-        return parsedUrl.toString();
+        // Reconstruct the URL
+        const baseUrl = `${parsedUrl.origin}${parsedUrl.pathname}`;
+        return queryString ? `${baseUrl}?${queryString}` : baseUrl;
     }
 
     static parseHttpHeaders(headerStr) {

src/dash/DashHandler.js

@@ -279,6 +279,10 @@ function DashHandler(config) {
         }
 
         let indexToRequest = lastSegment ? lastSegment.index + 1 : 0;
+        if (representation && lastSegment && representation.endNumber && lastSegment.replacementNumber && lastSegment.replacementNumber >= representation.endNumber) {
+            mediaHasFinished = true;
+            return null;
+        }
 
         return _getRequest(mediaInfo, representation, indexToRequest);
     }

src/dash/constants/DashConstants.js

@@ -84,6 +84,7 @@ export default {
     DVB_MIMETYPE : 'dvb:mimeType',
     DVB_FONTFAMILY : 'dvb:fontFamily',
     DYNAMIC: 'dynamic',
+    END_NUMBER: 'endNumber',
     ESSENTIAL_PROPERTY: 'EssentialProperty',
     EVENT: 'Event',
     EVENT_STREAM: 'EventStream',

src/dash/models/DashManifestModel.js

@@ -842,6 +842,9 @@ function DashManifestModel() {
                     } else if (baseUrl && baseUrl.availabilityTimeComplete !== undefined) {
                         voRepresentation.availabilityTimeComplete = baseUrl.availabilityTimeComplete;
                     }
+                    if (segmentInfo.hasOwnProperty(DashConstants.END_NUMBER)) {
+                        voRepresentation.endNumber = segmentInfo[DashConstants.END_NUMBER];
+                    }
                 }
 
                 voRepresentation.mseTimeOffset = calcMseTimeOffset(voRepresentation);

src/dash/utils/TemplateSegmentsGetter.js

@@ -74,7 +74,12 @@ function TemplateSegmentsGetter(config, isDynamic) {
         index = Math.max(index, 0);
 
         const seg = getIndexBasedSegment(timelineConverter, isDynamic, representation, index);
+
         if (seg) {
+            if (representation.endNumber && seg.replacementNumber > representation.endNumber) {
+                return null;
+            }
+
             seg.replacementTime = Math.round(index * representation.segmentDuration * representation.timescale, 10);
             seg.media = processUriTemplate(
                 template.media,

src/dash/vo/Representation.js

@@ -72,6 +72,7 @@ class Representation {
         this.startNumber = 1;
         this.timescale = 1;
         this.width = NaN;
+        this.endNumber = null;
     }
 
     hasInitialization() {

src/streaming/MediaPlayer.js

@@ -2709,6 +2709,7 @@ function MediaPlayer() {
 
         function __sanitizeDescriptorType(name, val, defaultSchemeIdUri) {
             let out = {};
+            // For an empty string, let's unset the descriptor, i.e. return null
             if (val) {
                 if (val instanceof Array) {
                     throw ARRAY_NOT_SUPPORTED_ERROR;
@@ -2725,22 +2726,25 @@ function MediaPlayer() {
             return null;
         }
 
-        if (value.lang) {
+        if (value.id !== undefined) {
+            output.id = value.id;
+        }
+        if (value.lang !== undefined) {
             output.lang = value.lang;
         }
         if (!isNaN(value.index)) {
             output.index = value.index;
         }
-        if (value.viewpoint) {
+        if (value.viewpoint !== undefined) {
             output.viewpoint = __sanitizeDescriptorType('viewpoint', value.viewpoint, defaults.viewpoint);
         }
-        if (value.audioChannelConfiguration) {
+        if (value.audioChannelConfiguration !== undefined) {
             output.audioChannelConfiguration = __sanitizeDescriptorType('audioChannelConfiguration', value.audioChannelConfiguration, defaults.audioChannelConfiguration);
         }
-        if (value.role) {
+        if (value.role !== undefined) {
             output.role = __sanitizeDescriptorType('role', value.role, defaults.role);
         }
-        if (value.accessibility) {
+        if (value.accessibility !== undefined) {
             output.accessibility = __sanitizeDescriptorType('accessibility', value.accessibility, defaults.accessibility);
         }
 

src/streaming/Stream.js

@@ -138,16 +138,18 @@ function Stream(config) {
      * Register the streaming events
      */
     function registerEvents() {
-        eventBus.on(Events.BUFFERING_COMPLETED, onBufferingCompleted, instance);
-        eventBus.on(Events.INBAND_EVENTS, onInbandEvents, instance);
+        eventBus.on(Events.BUFFERING_COMPLETED, _onBufferingCompleted, instance);
+        eventBus.on(Events.INBAND_EVENTS, _onInbandEvents, instance);
+        eventBus.on(Events.DATA_UPDATE_COMPLETED, _onDataUpdateCompleted, instance);
     }
 
     /**
      * Unregister the streaming events
      */
     function unRegisterEvents() {
-        eventBus.off(Events.BUFFERING_COMPLETED, onBufferingCompleted, instance);
-        eventBus.off(Events.INBAND_EVENTS, onInbandEvents, instance);
+        eventBus.off(Events.BUFFERING_COMPLETED, _onBufferingCompleted, instance);
+        eventBus.off(Events.INBAND_EVENTS, _onInbandEvents, instance);
+        eventBus.off(Events.DATA_UPDATE_COMPLETED, _onDataUpdateCompleted, instance);
     }
 
     /**
@@ -862,7 +864,7 @@ function Stream(config) {
         })
     }
 
-    function onBufferingCompleted() {
+    function _onBufferingCompleted() {
         let processors = getStreamProcessors();
         const ln = processors.length;
 
@@ -885,12 +887,16 @@ function Stream(config) {
         eventBus.trigger(Events.STREAM_BUFFERING_COMPLETED, { streamInfo: streamInfo }, { streamInfo });
     }
 
-    function onInbandEvents(e) {
+    function _onInbandEvents(e) {
         if (eventController) {
             eventController.addInbandEvents(e.events, streamInfo.id);
         }
     }
 
+    function _onDataUpdateCompleted() {
+        _initializationCompleted();
+    }
+
     function getProcessorForMediaInfo(mediaInfo) {
         if (!mediaInfo || !mediaInfo.type) {
             return null;

src/streaming/controllers/EventController.js

@@ -477,7 +477,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: JSON.parse(JSON.stringify(event)) }, { mode });
+                eventBus.trigger(event.eventStream.schemeIdUri, { event }, { mode });
                 return;
             }
 
@@ -494,10 +494,12 @@ function EventController() {
                     _sendCallbackRequest(url);
                 } else {
                     logger.debug(`Starting event ${eventId} from period ${event.eventStream.period.id} at ${currentVideoTime}`);
-                    eventBus.trigger(event.eventStream.schemeIdUri, { event: JSON.parse(JSON.stringify(event)) }, { mode });
-                    if (settings.get().streaming.events.deleteEventMessageDataAfterEventStarted) {
-                        delete event.messageData;
-                        delete event.parsedMessageData;
+                    eventBus.trigger(event.eventStream.schemeIdUri, { event }, { mode });
+                    if (settings.get().streaming.events.deleteEventMessageDataTimeout > -1) {
+                        setTimeout(() => {
+                            delete event.messageData;
+                            delete event.parsedMessageData;
+                        }, settings.get().streaming.events.deleteEventMessageDataTimeout);
                     }
                 }
                 event.triggeredStartEvent = true;

src/streaming/net/HTTPLoader.js

@@ -334,6 +334,9 @@ function HTTPLoader(cfg) {
         const _retriggerRequest = function () {
             if (remainingAttempts > 0) {
                 remainingAttempts--;
+                if (config && config.request) {
+                    config.request.retryAttempts += 1;
+                }
                 let retryRequest = { config: config };
                 retryRequests.push(retryRequest);
                 retryRequest.timeout = setTimeout(function () {
@@ -582,7 +585,9 @@ function HTTPLoader(cfg) {
      */
     function _updateRequestUrlAndHeaders(request) {
         _updateRequestUrlAndHeadersWithCmcd(request);
-        _addExtUrlQueryParameters(request);
+        if (request.retryAttempts === 0) {
+            _addExtUrlQueryParameters(request);
+        }
         _addPathwayCloningParameters(request);
         _addCommonAccessToken(request);
     }