feat(HLS): Deprecate useSafariBehaviorForLive config (#6978)

Author: avelad

demo/config.js

@@ -257,8 +257,6 @@ shakaDemo.Config = class {
             'manifest.hls.mediaPlaylistFullMimeType')
         .addBoolInput_('Ignore Program Date Time from manifest',
             'manifest.hls.ignoreManifestProgramDateTime')
-        .addBoolInput_('Use Safari behavior for live',
-            'manifest.hls.useSafariBehaviorForLive')
         .addNumberInput_('Live segments delay',
             'manifest.hls.liveSegmentsDelay')
         .addBoolInput_('Enable HLS sequence mode', 'manifest.hls.sequenceMode')

docs/tutorials/upgrade.md

@@ -114,6 +114,7 @@ application:
       with the relevant options: `enabled`, `targetLatency`,
       `targetLatencyTolerance`, `maxPlaybackRate`, `minPlaybackRate`, `panicMode`
       `panicThreshold`. (deprecated in v4.10.0)
+    - `useSafariBehaviorForLive` has been removed.
 
   - Plugin changes:
     - `TextDisplayer` plugins must implement the `configure()` method.

externs/shaka/player.js

@@ -1092,7 +1092,6 @@ shaka.extern.DashManifestConfiguration;
  *   ignoreManifestProgramDateTime: boolean,
  *   ignoreManifestProgramDateTimeForTypes: !Array<string>,
  *   mediaPlaylistFullMimeType: string,
- *   useSafariBehaviorForLive: boolean,
  *   liveSegmentsDelay: number,
  *   sequenceMode: boolean,
  *   ignoreManifestTimestampsInSegmentsMode: boolean,
@@ -1137,12 +1136,6 @@ shaka.extern.DashManifestConfiguration;
  *   format this value.
  *   <i>Defaults to
  *   <code>'video/mp2t; codecs="avc1.42E01E, mp4a.40.2"'</code>.</i>
- * @property {boolean} useSafariBehaviorForLive
- *   If this is true, playback will set the availability window to the
- *   presentation delay. The player will be able to buffer ahead three
- *   segments, but the seek window will be zero-sized, to be consistent with
- *   Safari. If this is false, the seek window will be the entire duration.
- *   <i>Defaults to <code>true</code>.</i>
  * @property {number} liveSegmentsDelay
  *   The default presentation delay will be calculated as a number of segments.
  *   This is the number of segments for this calculation..

lib/hls/hls_parser.js

@@ -1131,14 +1131,7 @@ shaka.hls.HlsParser = class {
       const PresentationType = shaka.hls.HlsParser.PresentationType_;
 
       if (this.presentationType_ == PresentationType.LIVE) {
-        let segmentAvailabilityDuration = this.getLiveDuration_();
-
-        // This defaults to the presentation delay, which has the effect of
-        // making the live stream unseekable.  This is consistent with Apple's
-        // HLS implementation.
-        if (this.config_.hls.useSafariBehaviorForLive) {
-          segmentAvailabilityDuration = this.presentationTimeline_.getDelay();
-        }
+        let segmentAvailabilityDuration = this.getLiveDuration_() || 0;
 
         // The app can override that with a longer duration, to allow seeking.
         if (!isNaN(this.config_.availabilityWindowOverride)) {

lib/player.js

@@ -3837,6 +3837,15 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       delete config['mediaSource']['sourceBufferExtraFeatures'];
     }
 
+    // Deprecate 'manifest.hls.useSafariBehaviorForLive' configuration.
+    if (config['manifest'] && config['manifest']['hls'] &&
+        'useSafariBehaviorForLive' in config['manifest']['hls']) {
+      shaka.Deprecate.deprecateFeature(5,
+          'manifest.hls.useSafariBehaviorForLive configuration',
+          'Please Use liveSync config to keep on live Edge instead.');
+      delete config['manifest']['hls']['useSafariBehaviorForLive'];
+    }
+
     // If lowLatencyMode is enabled, and inaccurateManifestTolerance and
     // rebufferingGoal and segmentPrefetchLimit and baseDelay and
     // autoCorrectDrift and maxDisabledTime are not specified, set

lib/util/player_configuration.js

@@ -162,7 +162,6 @@ shaka.util.PlayerConfiguration = class {
         ignoreManifestProgramDateTimeForTypes: [],
         mediaPlaylistFullMimeType:
             'video/mp2t; codecs="avc1.42E01E, mp4a.40.2"',
-        useSafariBehaviorForLive: true,
         liveSegmentsDelay: 3,
         sequenceMode: shaka.util.Platform.supportsSequenceMode(),
         ignoreManifestTimestampsInSegmentsMode: false,

test/ads_integration.js

@@ -48,8 +48,6 @@ describe('Ads', () => {
     adManager = player.getAdManager();
     await player.attach(video);
 
-    player.configure('manifest.hls.useSafariBehaviorForLive', false);
-
     // Disable stall detection, which can interfere with playback tests.
     player.configure('streaming.stallEnabled', false);
 

test/hls/hls_live_unit.js

@@ -663,8 +663,7 @@ describe('HlsParser live', () => {
       }
 
       it('does not affect seek range if unset', async () => {
-        // 15 seconds is three segment durations.
-        await testWindowOverride(15);
+        await testWindowOverride(2000);
       });
 
       it('overrides default seek range if set', async () => {