shaka-player 4.8.8 → 4.9.0

package/externs/shaka/manifest.js

@@ -21,7 +21,8 @@
  *   sequenceMode: boolean,
  *   ignoreManifestTimestampsInSegmentsMode: boolean,
  *   type: string,
- *   serviceDescription: ?shaka.extern.ServiceDescription
+ *   serviceDescription: ?shaka.extern.ServiceDescription,
+ *   nextUrl: ?string
  * }}
  *
  * @description
@@ -93,6 +94,8 @@
  * @property {?shaka.extern.ServiceDescription} serviceDescription
  *   The service description for the manifest. Used to adapt playbackRate to
  *   decrease latency.
+ * @property {?string} nextUrl
+ *   The next url to play.
  *
  * @exportDoc
  */
@@ -151,6 +154,7 @@ shaka.extern.InitDataOverride;
 
 /**
  * @typedef {{
+ *   targetLatency:?number,
  *   maxLatency: ?number,
  *   maxPlaybackRate: ?number,
  *   minLatency: ?number,
@@ -164,6 +168,8 @@ shaka.extern.InitDataOverride;
  * minPlaybackRate to increase  latency.
  * More information {@link https://dashif.org/docs/CR-Low-Latency-Live-r8.pdf here}.
  *
+ * @property {?number} targetLatency
+ *  The target latency to aim for.
  * @property {?number} maxLatency
  *  Maximum latency in seconds.
  * @property {?number} maxPlaybackRate
@@ -424,6 +430,7 @@ shaka.extern.SegmentIndex = class {
  *   frameRate: (number|undefined),
  *   pixelAspectRatio: (string|undefined),
  *   hdr: (string|undefined),
+ *   colorGamut: (string|undefined),
  *   videoLayout: (string|undefined),
  *   bandwidth: (number|undefined),
  *   width: (number|undefined),
@@ -501,6 +508,9 @@ shaka.extern.SegmentIndex = class {
  * @property {(string|undefined)} hdr
  *   <i>Video streams only.</i> <br>
  *   The Stream's HDR info
+ * @property {(string|undefined)} colorGamut
+ *   <i>Video streams only.</i> <br>
+ *   The Stream's color gamut info
  * @property {(string|undefined)} videoLayout
  *   <i>Video streams only.</i> <br>
  *   The Stream's video layout info.

package/externs/shaka/offline.js

@@ -122,6 +122,7 @@ shaka.extern.ManifestDB;
  *   frameRate: (number|undefined),
  *   pixelAspectRatio: (string|undefined),
  *   hdr: (string|undefined),
+ *   colorGamut: (string|undefined),
  *   videoLayout: (string|undefined),
  *   kind: (string|undefined),
  *   language: string,
@@ -166,6 +167,8 @@ shaka.extern.ManifestDB;
  *   The Stream's pixel aspect ratio
  * @property {(string|undefined)} hdr
  *   The Stream's HDR info
+ * @property {(string|undefined)} colorGamut
+ *   The Stream's color gamut info
  * @property {(string|undefined)} videoLayout
  *   The Stream's video layout info.
  * @property {(string|undefined)} kind

package/externs/shaka/player.js

@@ -234,6 +234,7 @@ shaka.extern.BufferedInfo;
  *   frameRate: ?number,
  *   pixelAspectRatio: ?string,
  *   hdr: ?string,
+ *   colorGamut: ?string,
  *   videoLayout: ?string,
  *   mimeType: ?string,
  *   audioMimeType: ?string,
@@ -299,6 +300,8 @@ shaka.extern.BufferedInfo;
  *   The video pixel aspect ratio provided in the manifest, if present.
  * @property {?string} hdr
  *   The video HDR provided in the manifest, if present.
+ * @property {?string} colorGamut
+ *   The video color gamut provided in the manifest, if present.
  * @property {?string} videoLayout
  *   The video layout provided in the manifest, if present.
  * @property {?string} mimeType
@@ -392,7 +395,10 @@ shaka.extern.TrackList;
  *   maxFrameRate: number,
  *
  *   minBandwidth: number,
- *   maxBandwidth: number
+ *   maxBandwidth: number,
+ *
+ *   minChannelsCount: number,
+ *   maxChannelsCount: number
  * }}
  *
  * @description
@@ -429,6 +435,11 @@ shaka.extern.TrackList;
  *   The minimum bandwidth of a variant track, in bit/sec.
  * @property {number} maxBandwidth
  *   The maximum bandwidth of a variant track, in bit/sec.
+ *
+ * @property {number} minChannelsCount
+ *   The minimum channels count of a variant track.
+ * @property {number} maxChannelsCount
+ *   The maximum channels count of a variant track.
  * @exportDoc
  */
 shaka.extern.Restrictions;
@@ -436,11 +447,26 @@ shaka.extern.Restrictions;
 
 /**
  * @typedef {{
- *   persistentState: boolean
+ *   persistentState: boolean,
+ *   encryptionSchemes: !Array<string|null>,
+ *   videoRobustnessLevels: !Array<string>,
+ *   audioRobustnessLevels: !Array<string>
  * }}
  *
  * @property {boolean} persistentState
  *   Whether this key system supports persistent state.
+ * @property {!Array<string|null>} encryptionSchemes
+ *   An array of encryption schemes that are reported to work, through either
+ *   EME or MCap APIs. An empty array indicates that encryptionScheme queries
+ *   are not supported. This should not happen if our polyfills are installed.
+ * @property {!Array<string>} videoRobustnessLevels
+ *   An array of video robustness levels that are reported to work. An empty
+ *   array indicates that none were tested. Not all key systems have a list of
+ *   known robustness levels built into probeSupport().
+ * @property {!Array<string>} audioRobustnessLevels
+ *   An array of audio robustness levels that are reported to work. An empty
+ *   array indicates that none were tested. Not all key systems have a list of
+ *   known robustness levels built into probeSupport().
  * @exportDoc
  */
 shaka.extern.DrmSupportType;
@@ -450,7 +476,8 @@ shaka.extern.DrmSupportType;
  * @typedef {{
  *   manifest: !Object.<string, boolean>,
  *   media: !Object.<string, boolean>,
- *   drm: !Object.<string, ?shaka.extern.DrmSupportType>
+ *   drm: !Object.<string, ?shaka.extern.DrmSupportType>,
+ *   hardwareResolution: shaka.extern.Resolution
  * }}
  *
  * @description
@@ -466,6 +493,10 @@ shaka.extern.DrmSupportType;
  *   A map of supported key systems.
  *   The keys are the key system names.  The value is <code>null</code> if it is
  *   not supported.  Key systems not probed will not be in this dictionary.
+ * @property {shaka.extern.Resolution} hardwareResolution
+ *   The maximum detected hardware resolution, which may have
+ *   height==width==Infinity for devices without a maximum resolution or
+ *   without a way to detect the maximum.
  *
  * @exportDoc
  */
@@ -677,7 +708,8 @@ shaka.extern.ProducerReferenceTime;
  *   serverCertificate: Uint8Array,
  *   serverCertificateUri: string,
  *   individualizationServer: string,
- *   sessionType: string
+ *   sessionType: string,
+ *   headers: !Object.<string, string>
  * }}
  *
  * @property {boolean} distinctiveIdentifierRequired
@@ -716,6 +748,8 @@ shaka.extern.ProducerReferenceTime;
  *   <i>Defaults to <code>'temporary'</code> for streaming.</i> <br>
  *   The MediaKey session type to create streaming licenses with.  This doesn't
  *   affect offline storage.
+ * @property {!Object.<string, string>} headers
+ *   The headers to use in the license request.
  *
  * @exportDoc
  */
@@ -906,7 +940,8 @@ shaka.extern.xml.Node;
  *   enableAudioGroups: boolean,
  *   multiTypeVariantsAllowed: boolean,
  *   useStreamOnceInPeriodFlattening: boolean,
- *   updatePeriod: number
+ *   updatePeriod: number,
+ *   enableFastSwitching: boolean
  * }}
  *
  * @property {string} clockSyncUri
@@ -995,6 +1030,9 @@ shaka.extern.xml.Node;
  *   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>.
+ * @property {boolean} enableFastSwitching
+ *   If false, disables fast switching track recognition.
+ *   Defaults to <code>true</code>.
  * @exportDoc
  */
 shaka.extern.DashManifestConfiguration;
@@ -1014,6 +1052,7 @@ shaka.extern.DashManifestConfiguration;
  *   sequenceMode: boolean,
  *   ignoreManifestTimestampsInSegmentsMode: boolean,
  *   disableCodecGuessing: boolean,
+ *   disableClosedCaptionsDetection: boolean,
  *   allowLowLatencyByteRangeOptimization: boolean
  * }}
  *
@@ -1082,6 +1121,11 @@ shaka.extern.DashManifestConfiguration;
  *   As a consequence, lazy-loading media playlists won't be possible for this
  *   use case, which may result in longer video startup times.
  *   <i>Defaults to <code>false</code>.</i>
+ * @property {boolean} disableClosedCaptionsDetection
+ *   If true, disables the automatic detection of closed captions.
+ *   Otherwise, in the absence of a EXT-X-MEDIA tag with TYPE="CLOSED-CAPTIONS",
+ *   Shaka Player will attempt to detect captions based on the media data.
+ *   <i>Defaults to <code>false</code>.</i>
  * @property {boolean} allowLowLatencyByteRangeOptimization
  *   If set to true, the HLS parser will optimize operation with LL and partial
  *   byte range segments. More info in
@@ -1206,6 +1250,7 @@ shaka.extern.ManifestConfiguration;
  *   inaccurateManifestTolerance: number,
  *   lowLatencyMode: boolean,
  *   autoLowLatencyMode: boolean,
+ *   forceHTTP: boolean,
  *   forceHTTPS: boolean,
  *   preferNativeHls: boolean,
  *   updateIntervalSeconds: number,
@@ -1219,6 +1264,7 @@ shaka.extern.ManifestConfiguration;
  *   disableTextPrefetch: boolean,
  *   disableVideoPrefetch: boolean,
  *   liveSync: boolean,
+ *   liveSyncTargetLatencyTolerance: number,
  *   liveSyncMaxLatency: number,
  *   liveSyncPlaybackRate: number,
  *   liveSyncMinLatency: number,
@@ -1231,7 +1277,9 @@ shaka.extern.ManifestConfiguration;
  *   vodDynamicPlaybackRateLowBufferRate: number,
  *   vodDynamicPlaybackRateBufferRatio: number,
  *   infiniteLiveStreamDuration: boolean,
- *   loadTimeout: number
+ *   preloadNextUrlWindow: number,
+ *   loadTimeout: number,
+ *   clearDecodingCache: boolean
  * }}
  *
  * @description
@@ -1323,16 +1371,19 @@ shaka.extern.ManifestConfiguration;
  *   extra segment requests necessary to compensate for drift.
  * @property {boolean} lowLatencyMode
  *   If <code>true</code>, low latency streaming mode is enabled. If
- *   lowLatencyMode is set to true, inaccurateManifestTolerance is set to 0
- *   unless specified, and rebufferingGoal to 0.01 unless specified at the same
- *   time.
+ *   lowLatencyMode is set to true, it changes the default config values for
+ *   other things, see: docs/tutorials/config.md
  * @property {boolean} autoLowLatencyMode
  *   If the stream is low latency and the user has not configured the
  *   lowLatencyMode, but if it has been configured to activate the
  *   lowLatencyMode if a stream of this type is detected, we automatically
  *   activate the lowLatencyMode. Defaults to false.
+ * @property {boolean} forceHTTP
+ *   If true, if the protocol is HTTPs change it to HTTP.
+ *   If both forceHTTP and forceHTTPS are set, forceHTTPS wins.
  * @property {boolean} forceHTTPS
  *   If true, if the protocol is HTTP change it to HTTPs.
+ *   If both forceHTTP and forceHTTPS are set, forceHTTPS wins.
  * @property {boolean} preferNativeHls
  *   If true, prefer native HLS playback when possible, regardless of platform.
  * @property {number} updateIntervalSeconds
@@ -1378,6 +1429,9 @@ shaka.extern.ManifestConfiguration;
  *   rate. Defaults to <code>false</code>.
  *   Note: on some SmartTVs, if this is activated, it may not work or the sound
  *   may be lost when activated.
+ * @property {number} liveSyncTargetLatencyTolerance
+ *   Latency tolerance for target latency, in seconds. Effective only if
+ *   liveSync is true. Defaults to <code>0.5</code>.
  * @property {number} liveSyncMaxLatency
  *   Maximum acceptable latency, in seconds. Effective only if liveSync is
  *   true. Defaults to <code>1</code>.
@@ -1422,10 +1476,22 @@ shaka.extern.ManifestConfiguration;
  *   If <code>true</code>, the media source live duration
  *   set as a<code>Infinity</code>
  *   Defaults to <code> false </code>.
+ * @property {number} preloadNextUrlWindow
+ *   The window of time at the end of the presentation to begin preloading the
+ *   next URL, such as one specified by a urn:mpeg:dash:chaining:2016 element
+ *   in DASH. Measured in seconds. If the value is 0, the next URL will not
+ *   be preloaded at all.
+ *   Defaults to <code> 30 </code>.
  * @property {number} loadTimeout
  *   The maximum timeout to reject the load when using src= in case the content
  *   does not work correctly.  Measured in seconds.
  *   Defaults to <code> 30 </code>.
+ * @property {boolean} clearDecodingCache
+ *   Clears decodingInfo and MediaKeySystemAccess cache during player unload
+ *   as these objects may become corrupt and cause issues during subsequent
+ *   playbacks on some platforms.
+ *   Defaults to <code>true</code> on PlayStation devices and to
+ *   <code>false</code> on other devices.
  * @exportDoc
  */
 shaka.extern.StreamingConfiguration;
@@ -1481,7 +1547,8 @@ shaka.extern.MediaSourceConfiguration;
 /**
  * @typedef {{
  *   customPlayheadTracker: boolean,
- *   skipPlayDetection: boolean
+ *   skipPlayDetection: boolean,
+ *   supportsMultipleMediaElements: boolean
  * }}
  *
  * @description
@@ -1491,13 +1558,20 @@ shaka.extern.MediaSourceConfiguration;
  *   If this is <code>true</code>, we create a custom playhead tracker for
  *   Client Side. This is useful because it allows you to implement the use of
  *   IMA on platforms that do not support multiple video elements.
- *   This value defaults to <code>false</code>.
+ *   Defaults to <code>false</code> except on Tizen, WebOS, Chromecast,
+ *   Hisense, PlayStation 4, PlayStation5, Xbox whose default value is
+ *   <code>true</code>.
  * @property {boolean} skipPlayDetection
  *   If this is true, we will load Client Side ads without waiting for a play
  *   event.
  *   Defaults to <code>false</code> except on Tizen, WebOS, Chromecast,
  *   Hisense, PlayStation 4, PlayStation5, Xbox whose default value is
  *   <code>true</code>.
+ * @property {boolean} supportsMultipleMediaElements
+ *   If this is true, the browser supports multiple media elements.
+ *   Defaults to <code>true</code> except on Tizen, WebOS, Chromecast,
+ *   Hisense, PlayStation 4, PlayStation5, Xbox whose default value is
+ *   <code>false</code>.
  *
  * @exportDoc
  */
@@ -1518,7 +1592,8 @@ shaka.extern.AdsConfiguration;
  *   restrictToScreenSize: boolean,
  *   ignoreDevicePixelRatio: boolean,
  *   clearBufferSwitch: boolean,
- *   safeMarginSwitch: number
+ *   safeMarginSwitch: number,
+ *   cacheLoadThreshold: number
  * }}
  *
  * @property {boolean} enabled
@@ -1576,6 +1651,10 @@ shaka.extern.AdsConfiguration;
  *   Can cause hiccups on some browsers if chosen too small, e.g.
  *   The amount of two segments is a fair minimum to consider as safeMargin
  *   value.
+ * @property {number} cacheLoadThreshold
+ *   Indicates the value in milliseconds from which a request is not
+ *   considered cached.
+ *   Defaults to <code>20</code>.
  * @exportDoc
  */
 shaka.extern.AbrConfiguration;
@@ -1989,3 +2068,17 @@ shaka.extern.Thumbnail;
  * @exportDoc
  */
 shaka.extern.Chapter;
+
+/**
+ * @typedef {{
+ *   width: number,
+ *   height: number
+ * }}
+ *
+ * @property {number} width
+ *   Width in pixels.
+ * @property {number} height
+ *   Height in pixels.
+ * @exportDoc
+ */
+shaka.extern.Resolution;

package/externs/tizen.js

@@ -19,7 +19,7 @@ webapis.systeminfo = {};
 
 
 /**
- * @return {{width: number, height: number}}
+ * @return {shaka.extern.Resolution}
  */
 webapis.systeminfo.getMaxVideoResolution = function() {};
 

package/lib/abr/simple_abr_manager.js

@@ -308,6 +308,11 @@ shaka.abr.SimpleAbrManager = class {
    * @export
    */
   segmentDownloaded(deltaTimeMs, numBytes, allowSwitch, request) {
+    if (deltaTimeMs < this.config_.cacheLoadThreshold) {
+      // The time indicates that it could be a cache response, so we should
+      // ignore this value.
+      return;
+    }
     shaka.log.v2('Segment downloaded:',
         'contentType=' + (request && request.contentType),
         'deltaTimeMs=' + deltaTimeMs,

package/lib/ads/media_tailor_ad.js

@@ -33,6 +33,9 @@ shaka.ads.MediaTailorAd = class {
 
     /** @private {boolean} */
     this.isLinear_ = isLinear;
+
+    /** @private {boolean} */
+    this.isSkipped_ = false;
   }
 
 
@@ -105,6 +108,7 @@ shaka.ads.MediaTailorAd = class {
    * @export
    */
   skip() {
+    this.isSkipped_ = true;
     this.video_.currentTime += this.getRemainingTime();
   }
 
@@ -294,4 +298,11 @@ shaka.ads.MediaTailorAd = class {
     this.adPosition_ = null;
     this.totalAds_ = null;
   }
+
+  /**
+   * @return {boolean}
+   */
+  isSkipped() {
+    return this.isSkipped_;
+  }
 };

package/lib/ads/media_tailor_ad_manager.js

@@ -452,6 +452,10 @@ shaka.ads.MediaTailorAdManager = class {
       this.sendInProgressEvents_(currentTime, this.mediaTailorAd_);
       const remainingTime = this.ad_.getRemainingTime();
       const duration = this.ad_.getDuration();
+      if (this.ad_.canSkipNow() && remainingTime > 0 && duration > 0) {
+        this.sendTrackingEvent_(
+            shaka.ads.MediaTailorAdManager.SKIP_STATE_CHANGED_);
+      }
       if (duration > 0 && (remainingTime <= 0 || remainingTime > duration)) {
         this.onEnded_();
       }
@@ -610,7 +614,7 @@ shaka.ads.MediaTailorAdManager = class {
       if (!this.isLive_) {
         this.playedAds_.push(this.mediaTailorAd_.adId);
       }
-      this.removeCurrentAdListeners_();
+      this.removeCurrentAdListeners_(this.ad_.isSkipped());
       const position = this.ad_.getPositionInSequence();
       const totalAdsInBreak = this.ad_.getSequenceLength();
       if (position === totalAdsInBreak) {
@@ -679,10 +683,15 @@ shaka.ads.MediaTailorAdManager = class {
   }
 
   /**
+   * @param {boolean=} skipped
    * @private
    */
-  removeCurrentAdListeners_() {
-    this.sendTrackingEvent_(shaka.ads.MediaTailorAdManager.COMPLETE_);
+  removeCurrentAdListeners_(skipped = false) {
+    if (skipped) {
+      this.sendTrackingEvent_(shaka.ads.MediaTailorAdManager.SKIPPED_);
+    } else {
+      this.sendTrackingEvent_(shaka.ads.MediaTailorAdManager.COMPLETE_);
+    }
     for (const listener of this.adListeners_) {
       this.eventManager_.unlisten(
           listener.target, listener.type, listener.listener);
@@ -759,12 +768,23 @@ shaka.ads.MediaTailorAdManager = class {
         this.onEvent_(
             new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED));
         break;
+      case shaka.ads.MediaTailorAdManager.SKIPPED_:
+        this.onEvent_(
+            new shaka.util.FakeEvent(shaka.ads.AdManager.AD_SKIPPED));
+        this.onEvent_(
+            new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED));
+        break;
       case shaka.ads.MediaTailorAdManager.BREAKSTART_:
         this.adContainer_.setAttribute('ad-active', 'true');
         break;
       case shaka.ads.MediaTailorAdManager.BREAKEND_:
         this.adContainer_.removeAttribute('ad-active');
         break;
+      case shaka.ads.MediaTailorAdManager.SKIP_STATE_CHANGED_:
+        this.onEvent_(
+            new shaka.util.FakeEvent(
+                shaka.ads.AdManager.AD_SKIP_STATE_CHANGED));
+        break;
     }
   }
 };
@@ -840,6 +860,13 @@ shaka.ads.MediaTailorAdManager.THIRDQUARTILE_ = 'thirdQuartile';
 shaka.ads.MediaTailorAdManager.COMPLETE_ = 'complete';
 
 
+/**
+ * @const {string}
+ * @private
+ */
+shaka.ads.MediaTailorAdManager.SKIPPED_ = 'skip';
+
+
 /**
  * @const {string}
  * @private
@@ -852,3 +879,10 @@ shaka.ads.MediaTailorAdManager.BREAKSTART_ = 'breakStart';
  * @private
  */
 shaka.ads.MediaTailorAdManager.BREAKEND_ = 'breakEnd';
+
+
+/**
+ * @const {string}
+ * @private
+ */
+shaka.ads.MediaTailorAdManager.SKIP_STATE_CHANGED_ = 'skipStateChanged';

package/lib/cea/cea608_data_channel.js

@@ -642,6 +642,15 @@ shaka.cea.Cea608DataChannel = class {
     // b1 -> |P|0|0|1|X|X|X|X|
     return (b1 & 0x70) === 0x10;
   }
+
+  /**
+   * Checks if the data contains a XDS control code.
+   * @param {number} b1 Byte 1.
+   * @return {boolean}
+   */
+  static isXdsControlCode(b1) {
+    return b1 >= 0x01 && b1 <= 0x0F;
+  }
 };
 
 /**

package/lib/cea/cea_decoder.js

@@ -307,16 +307,20 @@ shaka.cea.CeaDecoder = class {
     ccPacket.ccData1 &= 0x7f;
     ccPacket.ccData2 &= 0x7f;
 
+    // Ignore XDS
+    if (shaka.cea.Cea608DataChannel.isXdsControlCode(ccPacket.ccData1)) {
+      return null;
+    }
+
     // Check for empty captions and skip them.
     if (!ccPacket.ccData1 && !ccPacket.ccData2) {
       return null;
     }
 
-    this.streams_.add(selectedMode);
-
     // Process the clean CC data pair.
     let parsedClosedCaption = null;
     if (shaka.cea.Cea608DataChannel.isControlCode(ccPacket.ccData1)) {
+      this.streams_.add(selectedMode);
       parsedClosedCaption = selectedStream.handleControlCode(ccPacket);
     } else {
       // Handle as a Basic North American Character.