feat(HLS): Allow disable streams when the media playlist fails (#6807)

externs/shaka/manifest_parser.js

@@ -130,7 +130,8 @@ shaka.extern.ManifestParser = class {
  *   onManifestUpdated: function(),
  *   getBandwidthEstimate: function():number,
  *   onMetadata: function(string, number, ?number,
- *                        !Array.<shaka.extern.MetadataFrame>)
+ *                        !Array.<shaka.extern.MetadataFrame>),
+ *   disableStream: function(!shaka.extern.Stream)
  * }}
  *
  * @description
@@ -172,6 +173,9 @@ shaka.extern.ManifestParser = class {
  * @property {function(string, number, ?number,
  *                     !Array.<shaka.extern.MetadataFrame>)} onMetadata
  *   Called when an metadata is found in the manifest.
+ * @property {function(!shaka.extern.Stream)} disableStream
+ *   Called to temporarily disable a stream i.e. disabling all variant
+ *   containing said stream.
  * @exportDoc
  */
 shaka.extern.ManifestParser.PlayerInterface;

lib/hls/hls_parser.js

@@ -422,8 +422,16 @@ shaka.hls.HlsParser = class {
       }
       manifestUris.push(uriObj.toString());
     }
-    const response =
-        await this.requestManifest_(manifestUris, /* isPlaylist= */ true);
+    let response;
+    try {
+      response =
+          await this.requestManifest_(manifestUris, /* isPlaylist= */ true);
+    } catch (e) {
+      if (this.playerInterface_) {
+        this.playerInterface_.disableStream(streamInfo.stream);
+      }
+      throw e;
+    }
     if (!streamInfo.stream.segmentIndex) {
       // The stream was closed since the update was first requested.
       return;

lib/media/streaming_engine.js

@@ -1144,7 +1144,12 @@ shaka.media.StreamingEngine = class {
     if (!mediaState.stream.segmentIndex) {
       const thisStream = mediaState.stream;
 
-      await mediaState.stream.createSegmentIndex();
+      try {
+        await mediaState.stream.createSegmentIndex();
+      } catch (error) {
+        await this.handleStreamingError_(mediaState, error);
+        return;
+      }
 
       if (thisStream != mediaState.stream) {
         // We switched streams while in the middle of this async call to

lib/offline/storage.js

@@ -1179,6 +1179,7 @@ shaka.offline.Storage = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => config.abr.defaultBandwidthEstimate,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
 
     parser.configure(config.manifest);

lib/player.js

@@ -2074,6 +2074,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           });
         }
       },
+      disableStream: (stream) => {
+        this.disableStream(stream, this.config_.streaming.maxDisabledTime);
+      },
     };
     const regionTimeline =
         new shaka.media.RegionTimeline(() => this.seekRange());

test/dash/dash_parser_content_protection_unit.js

@@ -47,6 +47,7 @@ describe('DashParser ContentProtection', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
 
     const actual = await dashParser.start(

test/dash/dash_parser_live_unit.js

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

test/dash/dash_parser_manifest_unit.js

@@ -57,6 +57,7 @@ describe('DashParser Manifest', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
   });
 

test/dash/dash_parser_patch_unit.js

@@ -50,6 +50,7 @@ describe('DashParser Patch', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
     Date.now = () => publishTime.getTime() + 10;
 

test/dash/dash_parser_segment_base_unit.js

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

test/dash/dash_parser_segment_list_unit.js

@@ -353,6 +353,7 @@ describe('DashParser SegmentList', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
     try {
       const manifest = await dashParser.start('dummy://foo', playerInterface);

test/dash/dash_parser_segment_template_unit.js

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

test/hls/hls_live_unit.js

@@ -82,6 +82,7 @@ describe('HlsParser live', () => {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
 
     parser = new shaka.hls.HlsParser();

test/hls/hls_parser_unit.js

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

test/mss/mss_parser_unit.js

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

test/test/util/dash_parser_util.js

@@ -48,6 +48,7 @@ shaka.test.Dash = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
     try {
       const manifest = await dashParser.start('dummy://foo', playerInterface);
@@ -91,6 +92,7 @@ shaka.test.Dash = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
 
     try {

test/test/util/mss_parser_util.js

@@ -48,6 +48,7 @@ shaka.test.Mss = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
     const manifest = await mssParser.start('dummy://foo', playerInterface);
     const stream = manifest.variants[0].audio;
@@ -87,6 +88,7 @@ shaka.test.Mss = class {
       onManifestUpdated: () => {},
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
     const p = mssParser.start('dummy://foo', playerInterface);
     await expectAsync(p).toBeRejectedWith(

test/util/content_steering_manager_unit.js

@@ -30,6 +30,7 @@ describe('ContentSteeringManager', () => {
       onManifestUpdated: fail,
       getBandwidthEstimate: () => 1e6,
       onMetadata: () => {},
+      disableStream: (stream) => {},
     };
     const config = shaka.util.PlayerConfiguration.createDefault().manifest;
     manager = new shaka.util.ContentSteeringManager(playerInterface);