shaka-player 3.1.4 → 3.3.0

package/externs/shaka/player.js

@@ -468,6 +468,48 @@ shaka.extern.ID3Metadata;
  */
 shaka.extern.TimelineRegionInfo;
 
+/**
+ * @typedef {{
+ *   audioSamplingRate: ?number,
+ *   bandwidth: number,
+ *   codecs: string,
+ *   contentType: string,
+ *   frameRate: ?number,
+ *   height: ?number,
+ *   mimeType: ?string,
+ *   channelsCount: ?number,
+ *   pixelAspectRatio: ?string,
+ *   width: ?number
+ * }}
+ *
+ * @description
+ * Contains information about the quality of an audio or video media stream.
+ *
+ * @property {?number} audioSamplingRate
+ *   Specifies the maximum sampling rate of the content.
+ * @property {number} bandwidth
+ *   The bandwidth in bits per second.
+ * @property {string} codecs
+ *   The Stream's codecs, e.g., 'avc1.4d4015' or 'vp9', which must be
+ * compatible with the Stream's MIME type.
+ * @property {string} contentType
+ *   The type of content, which may be "video" or "audio".
+ * @property {?number} frameRate
+ *   The video frame rate.
+ * @property {?number} height
+ *   The video height in pixels.
+ * @property {string} mimeType
+ *   The MIME type.
+ * @property {?number} channelsCount
+ *   The number of audio channels, or null if unknown.
+ * @property {?string} pixelAspectRatio
+ *   The pixel aspect ratio value; e.g "1:1".
+ * @property {?number} width
+ *   The video width in pixels.
+ * @exportDoc
+ */
+shaka.extern.MediaQualityInfo;
+
 
 /**
  * @typedef {{
@@ -516,6 +558,7 @@ shaka.extern.EmsgInfo;
  *   videoRobustness: string,
  *   audioRobustness: string,
  *   serverCertificate: Uint8Array,
+ *   serverCertificateUri: string,
  *   individualizationServer: string,
  *   sessionType: string
  * }}
@@ -545,6 +588,10 @@ shaka.extern.EmsgInfo;
  *   A key-system-specific server certificate used to encrypt license requests.
  *   Its use is optional and is meant as an optimization to avoid a round-trip
  *   to request a certificate.
+ * @property {string} serverCertificateUri
+ *   <i>Defaults to <code>''</code>.</i><br>
+ *   If given, will make a request to the given URI to get the server
+ *   certificate. This is ignored if <code>serverCertificate</code> is set.
  * @property {string} individualizationServer
  *   The server that handles an <code>'individualiation-request'</code>.  If the
  *   server isn't given, it will default to the license server.
@@ -569,7 +616,8 @@ shaka.extern.AdvancedDrmConfiguration;
  *       ((function(!Uint8Array, string, ?shaka.extern.DrmInfo):!Uint8Array)|
  *         undefined),
  *   logLicenseExchange: boolean,
- *   updateExpirationTime: number
+ *   updateExpirationTime: number,
+ *   preferredKeySystems: !Array.<string>
  * }}
  *
  * @property {shaka.extern.RetryParameters} retryParameters
@@ -607,6 +655,9 @@ shaka.extern.AdvancedDrmConfiguration;
  * @property {number} updateExpirationTime
  *   <i>Defaults to 1.</i> <br>
  *   The frequency in seconds with which to check the expiration of a session.
+ * @property {!Array.<string>} preferredKeySystems
+ *   <i>Defaults to an empty array. </i> <br>
+ *   Specifies the priorties of available DRM key systems.
  *
  * @exportDoc
  */
@@ -625,7 +676,8 @@ shaka.extern.DrmConfiguration;
  *   ignoreSuggestedPresentationDelay: boolean,
  *   ignoreEmptyAdaptationSet: boolean,
  *   ignoreMaxSegmentDuration: boolean,
- *   keySystemsByURI: !Object.<string, string>
+ *   keySystemsByURI: !Object.<string, string>,
+ *   manifestPreprocessor: function(!Element)
  * }}
  *
  * @property {string} clockSyncUri
@@ -675,6 +727,10 @@ shaka.extern.DrmConfiguration;
  * @property {Object.<string, string>} keySystemsByURI
  *   A map of scheme URI to key system name. Defaults to default key systems
  *   mapping handled by Shaka.
+ * @property {function(!Element)} manifestPreprocessor
+ *   Called immediately after the DASH manifest has been parsed into an
+ *   XMLDocument. Provides a way for applications to perform efficient
+ *   preprocessing of the manifest.
  * @exportDoc
  */
 shaka.extern.DashManifestConfiguration;
@@ -683,15 +739,27 @@ shaka.extern.DashManifestConfiguration;
 /**
  * @typedef {{
  *   ignoreTextStreamFailures: boolean,
- *   useFullSegmentsForStartTime: boolean
+ *   ignoreImageStreamFailures: boolean,
+ *   useFullSegmentsForStartTime: boolean,
+ *   defaultAudioCodec: string,
+ *   defaultVideoCodec: string
  * }}
  *
  * @property {boolean} ignoreTextStreamFailures
  *   If <code>true</code>, ignore any errors in a text stream and filter out
  *   those streams.
+ * @property {boolean} ignoreImageStreamFailures
+ *   If <code>true</code>, ignore any errors in a image stream and filter out
+ *   those streams.
  * @property {boolean} useFullSegmentsForStartTime
  *   If <code>true</code>, force HlsParser to use a full segment request for
  *   determining start time in case the server does not support partial requests
+ * @property {string} defaultAudioCodec
+ *   The default audio codec if it is not specified in the HLS playlist.
+ *   <i>Defaults to <code>'mp4a.40.2'</code>.</i>
+ * @property {string} defaultVideoCodec
+ *   The default video codec if it is not specified in the HLS playlist.
+ *   <i>Defaults to <code>'avc1.42E01E'</code>.</i>
  * @exportDoc
  */
 shaka.extern.HlsManifestConfiguration;
@@ -771,7 +839,10 @@ shaka.extern.ManifestConfiguration;
  *   lowLatencyMode: boolean,
  *   autoLowLatencyMode: boolean,
  *   forceHTTPS: boolean,
- *   preferNativeHls: boolean
+ *   preferNativeHls: boolean,
+ *   updateIntervalSeconds: number,
+ *   dispatchAllEmsgBoxes: boolean,
+ *   observeQualityChanges: boolean
  * }}
  *
  * @description
@@ -878,7 +949,13 @@ shaka.extern.ManifestConfiguration;
  *   If true, if the protocol is HTTP change it to HTTPs.
  * @property {boolean} preferNativeHls
  *   If true, prefer native HLS playback when possible, regardless of platform.
- *
+ * @property {number} updateIntervalSeconds
+ *   The minimum number of seconds to see if the manifest has changes.
+ * @property {boolean} dispatchAllEmsgBoxes
+ *   If true, all emsg boxes are parsed and dispatched.
+ * @property {boolean} observeQualityChanges
+ *   If true, monitor media quality changes and emit
+ *   <code.shaka.Player.MediaQualityChangedEvent</code>.
  * @exportDoc
  */
 shaka.extern.StreamingConfiguration;
@@ -892,7 +969,8 @@ shaka.extern.StreamingConfiguration;
  *   restrictions: shaka.extern.Restrictions,
  *   switchInterval: number,
  *   bandwidthUpgradeTarget: number,
- *   bandwidthDowngradeTarget: number
+ *   bandwidthDowngradeTarget: number,
+ *   advanced: shaka.extern.AdvancedAbrConfiguration
  * }}
  *
  * @property {boolean} enabled
@@ -909,7 +987,7 @@ shaka.extern.StreamingConfiguration;
  *   automatically, but will still appear in the track list and can still be
  *   selected via <code>selectVariantTrack()</code>.  If no tracks meet these
  *   restrictions, AbrManager should not fail, but choose a low-res or
- *   low-bandwidth variant instead.  It is the responsibiliy of AbrManager
+ *   low-bandwidth variant instead.  It is the responsibility of AbrManager
  *   implementations to follow these rules and implement this behavior.
  * @property {number} switchInterval
  *   The minimum amount of time that must pass between switches, in
@@ -920,11 +998,76 @@ shaka.extern.StreamingConfiguration;
  * @property {number} bandwidthDowngradeTarget
  *   The largest fraction of the estimated bandwidth we should use. We should
  *   downgrade to avoid this.
+ * @property {shaka.extern.AdvancedAbrConfiguration} advanced
+ *   Advanced ABR configuration.
  * @exportDoc
  */
 shaka.extern.AbrConfiguration;
 
 
+/**
+ * @typedef {{
+ *   minTotalBytes: number,
+ *   minBytes: number,
+ *   fastHalfLife: number,
+ *   slowHalfLife: number
+ * }}
+ *
+ * @property {number} minTotalBytes
+ *   Minimum number of bytes sampled before we trust the estimate.  If we have
+ *   not sampled much data, our estimate may not be accurate enough to trust.
+ * @property {number} minBytes
+ *   Minimum number of bytes, under which samples are discarded.  Our models
+ *   do not include latency information, so connection startup time (time to
+ *   first byte) is considered part of the download time.  Because of this, we
+ *   should ignore very small downloads which would cause our estimate to be
+ *   too low.
+ * @property {number} fastHalfLife
+ *   The quantity of prior samples (by weight) used when creating a new
+ *   estimate, in seconds.  Those prior samples make up half of the
+ *   new estimate.
+ * @property {number} slowHalfLife
+ *   The quantity of prior samples (by weight) used when creating a new
+ *   estimate, in seconds.  Those prior samples make up half of the
+ *   new estimate.
+ * @exportDoc
+ */
+shaka.extern.AdvancedAbrConfiguration;
+
+
+/**
+ * @typedef {{
+ *   enabled: boolean,
+ *   useHeaders: boolean,
+ *   sessionId: string,
+ *   contentId: string
+ * }}
+ *
+ * @description
+ *   Common Media Client Data (CMCD) configuration.
+ *
+ * @property {boolean} enabled
+ *   If <code>true</code>, enable CMCD data to be sent with media requests.
+ *   Defaults to <code>false</code>.
+ * @property {boolean} useHeaders
+ *   If <code>true</code>, send CMCD data using the header transmission mode
+ *   instead of query args.  Defaults to <code>false</code>.
+ * @property {string} sessionId
+ *   A GUID identifying the current playback session. A playback session
+ *   typically ties together segments belonging to a single media asset.
+ *   Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID
+ *   specification. By default the sessionId is automatically generated on each
+ *   <code>load()</code> call.
+ * @property {string} contentId
+ *   A unique string identifying the current content. Maximum length is 64
+ *   characters. This value is consistent across multiple different sessions and
+ *   devices and is defined and updated at the discretion of the service
+ *   provider.
+ * @exportDoc
+ */
+shaka.extern.CmcdConfiguration;
+
+
 /**
  * @typedef {{
  *   trackSelectionCallback:
@@ -966,18 +1109,21 @@ shaka.extern.OfflineConfiguration;
  *   streaming: shaka.extern.StreamingConfiguration,
  *   abrFactory: shaka.extern.AbrManager.Factory,
  *   abr: shaka.extern.AbrConfiguration,
+ *   cmcd: shaka.extern.CmcdConfiguration,
  *   offline: shaka.extern.OfflineConfiguration,
  *   preferredAudioLanguage: string,
  *   preferredTextLanguage: string,
  *   preferredVariantRole: string,
  *   preferredTextRole: string,
+ *   preferredVideoCodecs: !Array.<string>,
+ *   preferredAudioCodecs: !Array.<string>,
  *   preferredAudioChannelCount: number,
+ *   preferredDecodingAttributes: !Array.<string>,
  *   preferForcedSubs: boolean,
  *   restrictions: shaka.extern.Restrictions,
  *   playRangeStart: number,
  *   playRangeEnd: number,
- *   textDisplayFactory: shaka.extern.TextDisplayer.Factory,
- *   useMediaCapabilities: boolean
+ *   textDisplayFactory: shaka.extern.TextDisplayer.Factory
  * }}
  *
  * @property {shaka.extern.DrmConfiguration} drm
@@ -990,6 +1136,8 @@ shaka.extern.OfflineConfiguration;
  *   A factory to construct an abr manager.
  * @property {shaka.extern.AbrConfiguration} abr
  *   ABR configuration and settings.
+ * @property {shaka.extern.CmcdConfiguration} cmcd
+ *   CMCD configuration and settings. (Common Media Client Data)
  * @property {shaka.extern.OfflineConfiguration} offline
  *   Offline configuration and settings.
  * @property {string} preferredAudioLanguage
@@ -1005,8 +1153,15 @@ shaka.extern.OfflineConfiguration;
  *   The preferred role to use for variants.
  * @property {string} preferredTextRole
  *   The preferred role to use for text tracks.
+ * @property {!Array.<string>} preferredVideoCodecs
+ *   The list of preferred video codecs, in order of highest to lowest priority.
+ * @property {!Array.<string>} preferredAudioCodecs
+ *   The list of preferred audio codecs, in order of highest to lowest priority.
  * @property {number} preferredAudioChannelCount
  *   The preferred number of audio channels.
+ * @property {!Array.<string>} preferredDecodingAttributes
+ *   The list of preferred attributes of decodingInfo, in the order of their
+ *   priorities.
  * @property {boolean} preferForcedSubs
  *   If true, a forced text track is preferred.  Defaults to false.
  *   If the content has no forced captions and the value is true,
@@ -1026,10 +1181,6 @@ shaka.extern.OfflineConfiguration;
  * @property {shaka.extern.TextDisplayer.Factory} textDisplayFactory
  *   A factory to construct a text displayer. Note that, if this is changed
  *   during playback, it will cause the text tracks to be reloaded.
- * @property {boolean} useMediaCapabilities
- *   If true, use MediaCapabilities.decodingInfo() to filter the manifest, and
- *   get MediaKeys information for encrypted content. Default to false.
- *   Shaka Player's integration with MediaCapabilities is now in BETA.
  * @exportDoc
  */
 shaka.extern.PlayerConfiguration;
@@ -1083,3 +1234,21 @@ shaka.extern.LanguageRole;
  * @exportDoc
  */
 shaka.extern.Thumbnail;
+
+
+/**
+ * @typedef {{
+ *   title: string,
+ *   startTime: number,
+ *   endTime: number
+ * }}
+ *
+ * @property {string} title
+ *    The title of the chapter.
+ * @property {number} startTime
+ *    The time that describes the beginning of the range of the chapter.
+ * @property {number} endTime
+ *    The time that describes the end of the range of chapter.
+ * @exportDoc
+ */
+shaka.extern.Chapter;

package/externs/shaka/text.js

@@ -128,7 +128,7 @@ shaka.extern.Cue = class {
     /**
      * The text payload of the cue.  If nestedCues is non-empty, this should be
      * empty.  Top-level block containers should have no payload of their own.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.payload;
@@ -234,14 +234,14 @@ shaka.extern.Cue = class {
 
     /**
      * Text color as a CSS color, e.g. "#FFFFFF" or "white".
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.color;
 
     /**
      * Text background color as a CSS color, e.g. "#FFFFFF" or "white".
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.backgroundColor;
@@ -257,14 +257,14 @@ shaka.extern.Cue = class {
 
     /**
      * The URL of the background image, e.g. "data:[mime type];base64,[data]".
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.backgroundImage;
 
     /**
      * The border around this cue as a CSS border.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.border;
@@ -292,28 +292,42 @@ shaka.extern.Cue = class {
 
     /**
      * Text font family.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.fontFamily;
 
+    /**
+     * Text stroke color as a CSS color, e.g. "#FFFFFF" or "white".
+     * @type {string}
+     * @exportDoc
+     */
+    this.textStrokeColor;
+
+    /**
+     * Text stroke width as a CSS stroke-width value.
+     * @type {string}
+     * @exportDoc
+     */
+    this.textStrokeWidth;
+
     /**
      * Text letter spacing as a CSS letter-spacing value.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.letterSpacing;
 
     /**
      * Text line padding as a CSS line-padding value.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.linePadding;
 
     /**
      * Opacity of the cue element, from 0-1.
-     * @type {!number}
+     * @type {number}
      * @exportDoc
      */
     this.opacity;
@@ -335,7 +349,7 @@ shaka.extern.Cue = class {
 
     /**
      * Id of the cue.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.id;

package/externs/texttrack.js

@@ -20,3 +20,6 @@ TextTrack.prototype.kind;
 
 /** @type {string} */
 TextTrack.prototype.label;
+
+/** @type {string} */
+TextTrack.prototype.language;

package/externs/webcrypto.js

@@ -0,0 +1,18 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+/**
+ * @fileoverview Externs for crypto properties not in the Closure compiler.
+ *
+ * @externs
+ */
+
+
+/**
+ * @return {string}
+ */
+webCrypto.Crypto.prototype.randomUUID = function() {};

package/lib/abr/ewma.js

@@ -35,6 +35,20 @@ shaka.abr.Ewma = class {
     this.totalWeight_ = 0;
   }
 
+
+  /**
+   * Update the alpha with a new halfLife value.
+   *
+   * @param {number} halfLife The quantity of prior samples (by weight) used
+   *   when creating a new estimate.  Those prior samples make up half of the
+   *   new estimate.
+   */
+  updateAlpha(halfLife) {
+    goog.asserts.assert(halfLife > 0, 'expected halfLife to be positive');
+    this.alpha_ = Math.exp(Math.log(0.5) / halfLife);
+  }
+
+
   /**
    * Takes a sample.
    *

package/lib/abr/ewma_bandwidth_estimator.js

@@ -47,7 +47,6 @@ shaka.abr.EwmaBandwidthEstimator = class {
      * This specific value is based on experimentation.
      *
      * @private {number}
-     * @const
      */
     this.minTotalBytes_ = 128e3;  // 128kB
 
@@ -60,11 +59,26 @@ shaka.abr.EwmaBandwidthEstimator = class {
      * This specific value is based on experimentation.
      *
      * @private {number}
-     * @const
      */
     this.minBytes_ = 16e3;  // 16kB
   }
 
+
+  /**
+   * Called by the Player to provide an updated configuration any time it
+   * changes.
+   * Must be called at least once before init().
+   *
+   * @param {shaka.extern.AdvancedAbrConfiguration} config
+   */
+  configure(config) {
+    this.minTotalBytes_ = config.minTotalBytes;
+    this.minBytes_ = config.minBytes;
+    this.fast_.updateAlpha(config.fastHalfLife);
+    this.slow_.updateAlpha(config.slowHalfLife);
+  }
+
+
   /**
    * Takes a bandwidth sample.
    *

package/lib/abr/simple_abr_manager.js

@@ -54,6 +54,9 @@ shaka.abr.SimpleAbrManager = class {
       navigator.connection.addEventListener('change', () => {
         if (this.config_.useNetworkInformation && this.enabled_) {
           this.bandwidthEstimator_ = new shaka.abr.EwmaBandwidthEstimator();
+          if (this.config_) {
+            this.bandwidthEstimator_.configure(this.config_.advanced);
+          }
           const chosenVariant = this.chooseVariant();
           if (chosenVariant) {
             this.switch_(chosenVariant);
@@ -239,6 +242,9 @@ shaka.abr.SimpleAbrManager = class {
    */
   configure(config) {
     this.config_ = config;
+    if (this.bandwidthEstimator_ && this.config_) {
+      this.bandwidthEstimator_.configure(this.config_.advanced);
+    }
   }
 
 

package/lib/ads/ad_manager.js

@@ -6,7 +6,6 @@
 
 
 goog.provide('shaka.ads.AdManager');
-goog.provide('shaka.ads.CuePoint');
 
 goog.require('shaka.Player');
 goog.require('shaka.ads.AdsStats');
@@ -594,6 +593,22 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   * @override
+   * @export
+   */
+  getServerSideCuePoints() {
+    if (!this.ssAdManager_) {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.RECOVERABLE,
+          shaka.util.Error.Category.ADS,
+          shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
+    }
+    return this.ssAdManager_.getCuePoints();
+  }
+
+
   /**
    * @return {shaka.extern.AdsStats}
    * @override
@@ -646,20 +661,6 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 };
 
-
-shaka.ads.CuePoint = class {
-  /**
-   * @param {number} start
-   * @param {?number=} end
-   */
-  constructor(start, end = null) {
-    /** @public {number} */
-    this.start = start;
-    /** @public {?number} */
-    this.end = end;
-  }
-};
-
 /**
  * The event name for when a sequence of ads has been loaded.
  *

package/lib/ads/client_side_ad.js

@@ -162,6 +162,14 @@ shaka.ads.ClientSideAd = class {
     return this.manager_.getVolume() == 0;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  isLinear() {
+    return this.ad_.isLinear();
+  }
+
 
   /**
    * @override

package/lib/ads/client_side_ad_manager.js

@@ -162,10 +162,14 @@ shaka.ads.ClientSideAdManager = class {
 
     const cuePointStarts = this.imaAdsManager_.getCuePoints();
     if (cuePointStarts.length) {
-      /** @type {!Array.<!shaka.ads.CuePoint>} */
+      /** @type {!Array.<!shaka.extern.AdCuePoint>} */
       const cuePoints = [];
       for (const start of cuePointStarts) {
-        const shakaCuePoint = new shaka.ads.CuePoint(start);
+        /** @type {shaka.extern.AdCuePoint} */
+        const shakaCuePoint = {
+          start: start,
+          end: null,
+        };
         cuePoints.push(shakaCuePoint);
       }
 
@@ -392,8 +396,10 @@ shaka.ads.ClientSideAdManager = class {
         .set('originalEvent', e);
     this.onEvent_(new shaka.util.FakeEvent(
         shaka.ads.AdManager.AD_STARTED, data));
-    this.adContainer_.setAttribute('ad-active', 'true');
-    this.video_.pause();
+    if (this.ad_.isLinear()) {
+      this.adContainer_.setAttribute('ad-active', 'true');
+      this.video_.pause();
+    }
   }
 
   /**
@@ -403,7 +409,9 @@ shaka.ads.ClientSideAdManager = class {
   onAdComplete_(e) {
     this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED,
         (new Map()).set('originalEvent', e)));
-    this.adContainer_.removeAttribute('ad-active');
-    this.video_.play();
+    if (this.ad_.isLinear()) {
+      this.adContainer_.removeAttribute('ad-active');
+      this.video_.play();
+    }
   }
 };

package/lib/ads/server_side_ad.js

@@ -152,6 +152,13 @@ shaka.ads.ServerSideAd = class {
     return this.video_.muted;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  isLinear() {
+    return true;
+  }
 
   /**
    * @override