Add text.imsc settings for rollUp and displayForcedOnly (#4336)

* Add text.imsc settings for rollUp and displayForcedOnly * Add settings to index.d.ts Also change `displayForcedOnly` to `displayForcedOnlyMode` throughout, so it's consistent, because that was a vector for hard-to-spot coding errors. * Address feedback - remove unnecessary player settings
Dash-Industry-Forum · Jan 11, 2024 · 427b2e7 · 427b2e7
1 parent 81baa66
commit 427b2e7
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 3 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1024,6 +1024,10 @@ declare namespace dashjs {
             text?: {
                 defaultEnabled?: boolean,
                 extendSegmentedCues?: boolean,
+                imsc?: {
+                    displayForcedOnlyMode?: boolean,
+                    enableRollUp?: boolean
+                },
                 webvtt?: {
                     customRenderingEnabled?: number
                 }

diff --git a/samples/dash-if-reference-player/app/main.js b/samples/dash-if-reference-player/app/main.js
@@ -233,6 +233,9 @@ app.controller('DashController', ['$scope', '$window', 'sources', 'contributors'
 
     $scope.drmToday = false;
 
+    $scope.imscEnableRollUp = true;
+    $scope.imscdisplayForcedOnlyMode = false;
+
     $scope.isDynamic = false;
 
     $scope.conformanceViolations = [];
@@ -821,6 +824,14 @@ app.controller('DashController', ['$scope', '$window', 'sources', 'contributors'
         $scope.player.enableForcedTextStreaming($scope.initialSettings.forceTextStreaming);
     }
 
+    $scope.toggleImscEnableRollUp = function() {
+        $scope.player.updateSettings({ streaming: { text: { imsc: { enableRollUp: $scope.imscEnableRollUp }}}});
+    }
+
+    $scope.toggleImscdisplayForcedOnlyMode = function() {
+        $scope.player.updateSettings({ streaming: { text: { imsc: { displayForcedOnlyMode: $scope.imscdisplayForcedOnlyMode }}}});
+    }
+
     $scope.updateCmcdSessionId = function () {
         $scope.player.updateSettings({
             streaming: {
@@ -2180,6 +2191,12 @@ app.controller('DashController', ['$scope', '$window', 'sources', 'contributors'
         $scope.drmClearkey.priority = $scope.drmClearkey.priority.toString();
     }
 
+    function setTextOptions() {
+        var currentConfig = $scope.player.getSettings();
+        $scope.imscEnableRollUp = currentConfig.streaming.text.imsc.enableRollUp;
+        $scope.imscdisplayForcedOnlyMode = currentConfig.streaming.text.imsc.displayForcedOnlyMode;
+    }
+
     function setLiveDelayOptions() {
         var currentConfig = $scope.player.getSettings();
         $scope.initialLiveDelay = currentConfig.streaming.delay.liveDelay;
@@ -2335,6 +2352,7 @@ app.controller('DashController', ['$scope', '$window', 'sources', 'contributors'
             setAdditionalPlaybackOptions();
             setAdditionalAbrOptions();
             setDrmOptions();
+            setTextOptions();
             setLiveDelayOptions();
             setInitialSettings();
             setTrackSwitchModeSettings();

diff --git a/samples/dash-if-reference-player/index.html b/samples/dash-if-reference-player/index.html
@@ -698,6 +698,30 @@
                 </label>
             </div>
         </div>
+        <div class="options-item">
+            <div class="options-item-title">Text</div>
+            <div class="options-item-body">
+                <div class="sub-options-item">
+                    <div class="sub-options-item-title">IMSC</div>
+                    <div class="sub-options-item-body">
+                        <label data-toggle="tooltip" data-placement="right"
+                               title="Enable Roll-up mode">
+                            <input type="checkbox" id="imscEnableRollUp" ng-model="imscEnableRollUp" autocomplete="off" ng-checked="imscEnableRollUp"
+                                   ng-change="toggleImscEnableRollUp()" name="inputMode">
+                            Enable Roll-up
+                        </label>
+                    </div>
+                    <div class="sub-options-item-body">
+                        <label data-toggle="tooltip" data-placement="right"
+                               title="Forced Only Mode">
+                            <input type="checkbox" id="imscdisplayForcedOnlyMode" ng-model="imscdisplayForcedOnlyMode" ng-checked="imscdisplayForcedOnlyMode" autocomplete="off"
+                                   ng-change="toggleImscdisplayForcedOnlyMode()" name="inputMode">
+                            Forced Only
+                        </label>
+                    </div>
+                </div>
+            </div>
+        </div>
         <div class="options-item">
             <div class="options-item-title">Initial Settings</div>
             <div class="options-item-body">

diff --git a/src/core/Settings.js b/src/core/Settings.js
@@ -143,6 +143,10 @@ import Events from './events/Events';
  *            text: {
  *                defaultEnabled: true,
  *                extendSegmentedCues: true,
+ *                imsc: {
+ *                    displayForcedOnlyMode: false,
+ *                    enableRollUp: true
+ *                },
  *                webvtt: {
  *                    customRenderingEnabled: false
  *                }
@@ -480,7 +484,12 @@ import Events from './events/Events';
  * Enable/disable subtitle rendering by default.
  * @property {boolean} [extendSegmentedCues=true]
  * Enable/disable patching of segmented cues in order to merge as a single cue by extending cue end time.
- * @property {object} [webvtt={customRenderingEnabled=false}]
+ * @property {boolean} [imsc.displayForcedOnlyMode=false]
+ * Enable/disable forced only mode in IMSC captions.
+ * When true, only those captions where itts:forcedDisplay="true" will be displayed.
+ * @property {boolean} [imsc.enableRollUp=true]
+ * Enable/disable rollUp style display of IMSC captions.
+ * @property {object} [webvtt.customRenderingEnabled=false]
  * Enables the custom rendering for WebVTT captions. For details refer to the "Subtitles and Captions" sample section of dash.js.
  * Custom WebVTT rendering requires the external library vtt.js that can be found in the contrib folder.
  */
@@ -943,6 +952,10 @@ function Settings() {
             text: {
                 defaultEnabled: true,
                 extendSegmentedCues: true,
+                imsc: {
+                    displayForcedOnlyMode: false,
+                    enableRollUp: true
+                },
                 webvtt: {
                     customRenderingEnabled: false
                 }

diff --git a/src/streaming/text/TextTracks.js b/src/streaming/text/TextTracks.js
@@ -413,10 +413,10 @@ function TextTracks(config) {
             captionContainer.appendChild(finalCue);
             previousISDState = renderHTML(cue.isd, finalCue, function (src) {
                 return _resolveImageSrc(cue, src);
-            }, captionContainer.clientHeight, captionContainer.clientWidth, false/*displayForcedOnlyMode*/, function (err) {
+            }, captionContainer.clientHeight, captionContainer.clientWidth, settings.get().streaming.text.imsc.displayForcedOnlyMode, function (err) {
                 logger.info('renderCaption :', err);
                 //TODO add ErrorHandler management
-            }, previousISDState, true /*enableRollUp*/);
+            }, previousISDState, settings.get().streaming.text.imsc.enableRollUp);
             finalCue.id = cue.cueID;
             eventBus.trigger(MediaPlayerEvents.CAPTION_RENDERED, { captionDiv: finalCue, currentTrackIdx });
         }