feat(DASH): update period as part of configuration (#6419)

Closes #6418
shaka-project · Apr 9, 2024 · bdabddc · bdabddc
1 parent 07a3241
commit bdabddc
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 5 deletions.
diff --git a/demo/config.js b/demo/config.js
@@ -232,7 +232,9 @@ shakaDemo.Config = class {
         .addBoolInput_('Enable DASH sequence mode',
             'manifest.dash.sequenceMode')
         .addBoolInput_('Use stream once in period flattening',
-            'manifest.dash.useStreamOnceInPeriodFlattening');
+            'manifest.dash.useStreamOnceInPeriodFlattening')
+        .addNumberInput_('override the Update period of dash manifest',
+            'manifest.dash.updatePeriod');
   }
 
   /** @private */

diff --git a/externs/shaka/player.js b/externs/shaka/player.js
@@ -892,7 +892,8 @@ shaka.extern.xml.Node;
  *   sequenceMode: boolean,
  *   enableAudioGroups: boolean,
  *   multiTypeVariantsAllowed: boolean,
- *   useStreamOnceInPeriodFlattening: boolean
+ *   useStreamOnceInPeriodFlattening: boolean,
+ *   updatePeriod: number
  * }}
  *
  * @property {string} clockSyncUri
@@ -970,6 +971,12 @@ shaka.extern.xml.Node;
  *   but may raise issues if manifest does not have stream consistency
  *   between periods.
  *   Defaults to <code>false</code>.
+ * @property {number} updatePeriod
+ *   Override the minimumUpdatePeriod of the manifest. The value is in second
+ *   if the value is greater than the minimumUpdatePeriod, it will update the
+ *   manifest less frequently. if you update the value during for a dynamic
+ *   manifest, it will directly trigger a new download of the manifest
+ *   Defaults to <code>-1</code>.
  * @exportDoc
  */
 shaka.extern.DashManifestConfiguration;

diff --git a/lib/dash/dash_parser.js b/lib/dash/dash_parser.js
@@ -129,9 +129,14 @@ shaka.dash.DashParser = class {
   configure(config) {
     goog.asserts.assert(config.dash != null,
         'DashManifestConfiguration should not be null!');
-
+    const needFireUpdate = this.playerInterface_ &&
+      config.dash.updatePeriod != this.config_.dash.updatePeriod &&
+      config.dash.updatePeriod >= 0;
     this.config_ = config;
-
+    if (needFireUpdate && this.manifest_ &&
+      this.manifest_.presentationTimeline.isLive()) {
+      this.updateNow_();
+    }
     if (this.contentSteeringManager_) {
       this.contentSteeringManager_.configure(this.config_);
     }
@@ -1689,6 +1694,15 @@ shaka.dash.DashParser = class {
     this.setUpdateTimer_(updateDelay);
   }
 
+  /**
+   * Update now the manifest
+   *
+   * @private
+   */
+  updateNow_() {
+    this.updateTimer_.tickNow();
+  }
+
   /**
    * Sets the update timer.  Does nothing if the manifest does not specify an
    * update period.
@@ -1705,9 +1719,13 @@ shaka.dash.DashParser = class {
     if (this.updatePeriod_ < 0) {
       return;
     }
+    let updateTime = this.updatePeriod_;
+    if (this.config_.dash.updatePeriod >= 0) {
+      updateTime = this.config_.dash.updatePeriod;
+    }
 
     const finalDelay = Math.max(
-        this.updatePeriod_ - offset,
+        updateTime - offset,
         this.averageUpdateDuration_.getEstimate());
 
     // We do not run the timer as repeating because part of update is async and

diff --git a/lib/util/player_configuration.js b/lib/util/player_configuration.js
@@ -143,6 +143,7 @@ shaka.util.PlayerConfiguration = class {
         enableAudioGroups: false,
         multiTypeVariantsAllowed,
         useStreamOnceInPeriodFlattening: false,
+        updatePeriod: -1,
       },
       hls: {
         ignoreTextStreamFailures: false,