fix(DASH): Fix playback after DASH period eviction (shaka-project#7519)

With this change, closeSegmentIndex() of all streams of a removed period
are defered in StreamingEngine.onUpdate_()

Fixes shaka-project#7516

externs/shaka/manifest_parser.js

@@ -140,6 +140,7 @@ shaka.extern.ManifestParser = class {
  *   getBandwidthEstimate: function():number,
  *   onMetadata: function(string, number, ?number,
  *                        !Array.<shaka.extern.MetadataFrame>),
+ *   closeSegmentIndex: function(shaka.extern.Stream, function()),
  *   disableStream: function(!shaka.extern.Stream),
  *   addFont: function(string, string)
  * }}
@@ -186,6 +187,8 @@ shaka.extern.ManifestParser = class {
  * @property {function(!shaka.extern.Stream)} disableStream
  *   Called to temporarily disable a stream i.e. disabling all variant
  *   containing said stream.
+ * @property {function(!shaka.extern.Stream, function())} closeSegmentIndex
+ *   Called to close a segment index.
  * @property {function(string, string)} addFont
  *   Called when a new font needs to be added.
  * @exportDoc

lib/dash/dash_parser.js

@@ -239,6 +239,9 @@ shaka.dash.DashParser = class {
     this.lowLatencyMode_ = playerInterface.isLowLatencyMode();
     this.manifestUris_ = [uri];
     this.playerInterface_ = playerInterface;
+    if (this.periodCombiner_) {
+      this.periodCombiner_.setPlayerInterface(this.playerInterface_);
+    }
 
     const updateDelay = await this.requestManifest_();
 

lib/media/streaming_engine.js

@@ -513,6 +513,32 @@ shaka.media.StreamingEngine = class {
     }
   }
 
+  /**
+   * closeSegmentIndex if the stream is not active
+   * @param {shaka.extern.Stream} stream
+   * @param {function()} closeSegmentIndex
+   */
+  closeSegmentIndex(stream, closeSegmentIndex) {
+    const type = /** @type {!shaka.util.ManifestParserUtils.ContentType} */
+            (stream.type);
+    const mediaState = this.mediaStates_.get(type);
+    if (mediaState) {
+      /**
+       * Closes the segmentIndex only if the stream is not active.
+       * If the stream is active the eviction will be peformed
+       * by the next onUpdate_().
+      */
+      const matchedStreams = mediaState.stream.matchedStreams;
+      const found = matchedStreams.find((match) => match.id === stream.id);
+      if (!found) {
+        closeSegmentIndex();
+      }
+    } else {
+      // type of stream not active
+      closeSegmentIndex();
+    }
+  }
+
 
   /**
    * Handles deferred releases of old SegmentIndexes for the mediaState's

lib/offline/storage.js

@@ -1217,6 +1217,7 @@ shaka.offline.Storage = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => config.abr.defaultBandwidthEstimate,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

lib/player.js

@@ -2169,6 +2169,13 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           });
         }
       },
+      closeSegmentIndex: (stream, closeSegmentIndex) => {
+        if (this.streamingEngine_) {
+          this.streamingEngine_.closeSegmentIndex(stream, closeSegmentIndex);
+        } else {
+          closeSegmentIndex();
+        }
+      },
       disableStream: (stream) => this.disableStream(
           stream, this.config_.streaming.maxDisabledTime),
       addFont: (name, url) => this.addFont(name, url),

lib/util/periods.js

@@ -48,6 +48,9 @@ shaka.util.PeriodCombiner = class {
     /** @private {boolean} */
     this.useStreamOnce_ = false;
 
+    /** @private {?shaka.extern.ManifestParser.PlayerInterface} */
+    this.playerInterface_ = null;
+
     /**
      * The IDs of the periods we have already used to generate streams.
      * This helps us identify the periods which have been added when a live
@@ -80,6 +83,15 @@ shaka.util.PeriodCombiner = class {
     this.usedPeriodIds_.clear();
   }
 
+  /**
+   * @param {?shaka.extern.ManifestParser.PlayerInterface} playerInterface
+   *
+   * @export
+  */
+  setPlayerInterface(playerInterface) {
+    this.playerInterface_ = playerInterface;
+  }
+
   /**
    * @return {!Array.<shaka.extern.Variant>}
    *
@@ -155,8 +167,19 @@ shaka.util.PeriodCombiner = class {
       }
     }
     if (stream.segmentIndex) {
-      stream.closeSegmentIndex();
+      if (this.playerInterface_) {
+        const closeSegmentIndex = () => {
+          stream.closeSegmentIndex();
+        };
+
+        this.playerInterface_.closeSegmentIndex(
+            stream,
+            closeSegmentIndex);
+      } else {
+        stream.closeSegmentIndex();
+      }
     }
+
     this.usedPeriodIds_.delete(periodId);
   }
 

test/dash/dash_parser_content_protection_unit.js

@@ -47,6 +47,7 @@ describe('DashParser ContentProtection', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/dash/dash_parser_live_unit.js

@@ -39,6 +39,7 @@ describe('DashParser Live', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/dash/dash_parser_manifest_unit.js

@@ -60,6 +60,7 @@ describe('DashParser Manifest', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: shaka.test.Util.spyFunc(addFontSpy),
     };

test/dash/dash_parser_patch_unit.js

@@ -50,6 +50,7 @@ describe('DashParser Patch', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/dash/dash_parser_segment_base_unit.js

@@ -43,6 +43,7 @@ describe('DashParser SegmentBase', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/dash/dash_parser_segment_list_unit.js

@@ -353,6 +353,7 @@ describe('DashParser SegmentList', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/dash/dash_parser_segment_template_unit.js

@@ -52,6 +52,7 @@ describe('DashParser SegmentTemplate', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/hls/hls_live_unit.js

@@ -82,6 +82,7 @@ describe('HlsParser live', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/hls/hls_parser_unit.js

@@ -96,6 +96,7 @@ describe('HlsParser', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: shaka.test.Util.spyFunc(onMetadataSpy),
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/media/streaming_engine_integration.js

@@ -271,6 +271,8 @@ describe('StreamingEngine', () => {
       onSegmentAppended: () => playhead.notifyOfBufferingChange(),
       onInitSegmentAppended: () => {},
       beforeAppendSegment: () => Promise.resolve(),
+      onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream, time) => false,
     };
     streamingEngine = new shaka.media.StreamingEngine(

test/media/streaming_engine_unit.js

@@ -467,6 +467,7 @@ describe('StreamingEngine', () => {
       onSegmentAppended: Util.spyFunc(onSegmentAppended),
       onInitSegmentAppended: () => {},
       beforeAppendSegment: Util.spyFunc(beforeAppendSegment),
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: Util.spyFunc(disableStream),
     };
     streamingEngine = new shaka.media.StreamingEngine(

test/mss/mss_parser_unit.js

@@ -82,6 +82,7 @@ describe('MssParser Manifest', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/test/util/dash_parser_util.js

@@ -48,6 +48,7 @@ shaka.test.Dash = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };
@@ -98,6 +99,7 @@ shaka.test.Dash = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/test/util/mss_parser_util.js

@@ -48,6 +48,7 @@ shaka.test.Mss = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };
@@ -89,6 +90,7 @@ shaka.test.Mss = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };

test/util/content_steering_manager_unit.js

@@ -30,6 +30,7 @@ describe('ContentSteeringManager', () => {
       onManifestUpdated: fail,
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      closeSegmentIndex: (stream, closeSegmentIndex) => {},
       disableStream: (stream) => {},
       addFont: (name, url) => {},
     };