shaka-player 4.12.9 → 4.13.0

package/lib/util/cmcd_manager.js

@@ -10,6 +10,7 @@ goog.require('goog.Uri');
 goog.require('shaka.log');
 goog.require('shaka.net.NetworkingEngine');
 goog.require('shaka.util.ArrayUtils');
+goog.require('shaka.util.EventManager');
 
 goog.requireType('shaka.media.SegmentReference');
 
@@ -43,8 +44,8 @@ shaka.util.CmcdManager = class {
     this.playbackStarted_ = false;
 
     /**
-    * @private {boolean}
-    */
+     * @private {boolean}
+     */
     this.buffering_ = true;
 
     /**
@@ -56,6 +57,44 @@ shaka.util.CmcdManager = class {
      * @private {boolean}
      */
     this.lowLatency_ = false;
+
+    /**
+     * @private {number|undefined}
+     */
+    this.playbackPlayTime_ = undefined;
+
+    /**
+     * @private {number|undefined}
+     */
+    this.playbackPlayingTime_ = undefined;
+
+    /**
+     * @private {number}
+     */
+    this.startTimeOfLoad_ = 0;
+
+    /**
+     * @private {boolean}
+     */
+    this.msdSent_ = false;
+
+    /**
+     * @private {shaka.util.EventManager}
+     */
+    this.eventManager_ = new shaka.util.EventManager();
+
+    /** @private {HTMLMediaElement} */
+    this.video_ = null;
+  }
+
+
+  /**
+   * Set media element and setup event listeners
+   * @param {HTMLMediaElement} mediaElement The video element
+   */
+  setMediaElement(mediaElement) {
+    this.video_ = mediaElement;
+    this.setupMSDEventListeners_();
   }
 
   /**
@@ -77,6 +116,12 @@ shaka.util.CmcdManager = class {
     this.buffering_ = true;
     this.starved_ = false;
     this.lowLatency_ = false;
+    this.playbackPlayTime_ = 0;
+    this.playbackPlayingTime_ = 0;
+    this.startTimeOfLoad_ = 0;
+    this.msdSent_ = false;
+    this.video_ = null;
+    this.eventManager_.removeAll();
   }
 
   /**
@@ -120,6 +165,24 @@ shaka.util.CmcdManager = class {
     }
   }
 
+  /**
+   * Set start time of load if autoplay is enabled
+   *
+   * @param {number} startTimeOfLoad
+   */
+  setStartTimeOfLoad(startTimeOfLoad) {
+    if (this.video_) {
+      const playResult = this.video_.play();
+      if (playResult) {
+        playResult.then(() => {
+          this.startTimeOfLoad_ = startTimeOfLoad;
+        }).catch((e) => {
+          this.startTimeOfLoad_ = 0;
+        });
+      }
+    }
+  }
+
   /**
    * Apply CMCD data to a request.
    *
@@ -248,7 +311,7 @@ shaka.util.CmcdManager = class {
         if (stream.segmentIndex && segment) {
           const reverse = playbackRate < 0;
           const iterator = stream.segmentIndex.getIteratorForTime(
-              segment.endTime, /* allowNonIndepedent= */ true, reverse);
+              segment.endTime, /* allowNonIndependent= */ true, reverse);
           if (iterator) {
             const nextSegment = iterator.next().value;
             if (nextSegment && nextSegment != segment) {
@@ -360,6 +423,40 @@ shaka.util.CmcdManager = class {
     }
   }
 
+  /**
+   * Set playbackPlayTime_ when the play event is triggered
+   * @private
+   */
+  onPlaybackPlay_() {
+    if (!this.playbackPlayTime_) {
+      this.playbackPlayTime_ = Date.now();
+    }
+  }
+
+  /**
+   * Set playbackPlayingTime_
+   * @private
+   */
+  onPlaybackPlaying_() {
+    if (!this.playbackPlayingTime_) {
+      this.playbackPlayingTime_ = Date.now();
+    }
+  }
+
+  /**
+   * Setup event listeners for msd calculation
+   * @private
+   */
+  setupMSDEventListeners_() {
+    const onPlaybackPlay = () => this.onPlaybackPlay_();
+    this.eventManager_.listenOnce(
+        this.video_, 'play', onPlaybackPlay);
+
+    const onPlaybackPlaying = () => this.onPlaybackPlaying_();
+    this.eventManager_.listenOnce(
+        this.video_, 'playing', onPlaybackPlaying);
+  }
+
   /**
    * Create baseline CMCD data
    *
@@ -371,7 +468,7 @@ shaka.util.CmcdManager = class {
       this.config_.sessionId = window.crypto.randomUUID();
     }
     return {
-      v: shaka.util.CmcdManager.Version,
+      v: this.config_.version,
       sf: this.sf_,
       sid: this.config_.sessionId,
       cid: this.config_.contentId,
@@ -410,6 +507,18 @@ shaka.util.CmcdManager = class {
       data.su = this.buffering_;
     }
 
+    if (data.v === shaka.util.CmcdManager.Version.VERSION_2) {
+      if (this.playerInterface_.isLive()) {
+        data.ltc = this.playerInterface_.getLiveLatency();
+      }
+
+      const msd = this.calculateMSD_();
+      if (msd != undefined) {
+        data.msd = msd;
+        this.msdSent_ = true;
+      }
+    }
+
     const output = this.filterKeys_(data);
 
     if (useHeaders) {
@@ -459,6 +568,7 @@ shaka.util.CmcdManager = class {
    *
    * @param {shaka.extern.RequestContext} context
    *   The request context
+   * @return {shaka.util.CmcdManager.ObjectType|undefined}
    * @private
    */
   getObjectType_(context) {
@@ -615,7 +725,24 @@ shaka.util.CmcdManager = class {
   }
 
   /**
-   * Calculate requested maximun throughput
+   * Calculate measured start delay
+   *
+   * @return {number|undefined}
+   * @private
+   */
+  calculateMSD_() {
+    if (!this.msdSent_ &&
+        this.playbackPlayingTime_ &&
+        this.playbackPlayTime_) {
+      const startTime = this.startTimeOfLoad_ || this.playbackPlayTime_;
+      return this.playbackPlayingTime_ - startTime;
+    }
+    return undefined;
+  }
+
+
+  /**
+   * Calculate requested maximum throughput
    *
    * @param {shaka.extern.Stream} stream
    * @param {shaka.media.SegmentReference} segment
@@ -691,7 +818,7 @@ shaka.util.CmcdManager = class {
   /**
    * Get the highest bandwidth for a given type.
    *
-   * @param {string} type
+   * @param {shaka.util.CmcdManager.ObjectType|undefined} type
    * @return {number}
    * @private
    */
@@ -810,8 +937,8 @@ shaka.util.CmcdManager = class {
     const headerGroups = [{}, {}, {}, {}];
     const headerMap = {
       br: 0, d: 0, ot: 0, tb: 0,
-      bl: 1, dl: 1, mtp: 1, nor: 1, nrr: 1, su: 1,
-      cid: 2, pr: 2, sf: 2, sid: 2, st: 2, v: 2,
+      bl: 1, dl: 1, mtp: 1, nor: 1, nrr: 1, su: 1, ltc: 1,
+      cid: 2, pr: 2, sf: 2, sid: 2, st: 2, v: 2, msd: 2,
       bs: 3, rtp: 3,
     };
 
@@ -872,8 +999,9 @@ shaka.util.CmcdManager = class {
  *   getBufferedInfo: function():shaka.extern.BufferedInfo,
  *   getCurrentTime: function():number,
  *   getPlaybackRate: function():number,
- *   getVariantTracks: function():Array.<shaka.extern.Track>,
- *   isLive: function():boolean
+ *   getVariantTracks: function():Array<shaka.extern.Track>,
+ *   isLive: function():boolean,
+ *   getLiveLatency: function():number
  * }}
  *
  * @property {function():number} getBandwidthEstimate
@@ -884,10 +1012,13 @@ shaka.util.CmcdManager = class {
  *   Get the current time
  * @property {function():number} getPlaybackRate
  *   Get the playback rate
- * @property {function():Array.<shaka.extern.Track>} getVariantTracks
+ * @property {function():Array<shaka.extern.Track>} getVariantTracks
  *   Get the variant tracks
  * @property {function():boolean} isLive
  *   Get if the player is playing live content.
+ * @property {function():number} getLiveLatency
+ *   Get latency in milliseconds between the live edge and what's currently
+ *   playing.
  */
 shaka.util.CmcdManager.PlayerInterface;
 
@@ -907,6 +1038,13 @@ shaka.util.CmcdManager.ObjectType = {
   OTHER: 'o',
 };
 
+/**
+ * @enum {number}
+ */
+shaka.util.CmcdManager.Version = {
+  VERSION_1: 1,
+  VERSION_2: 2,
+};
 
 /**
  * @enum {string}
@@ -929,10 +1067,3 @@ shaka.util.CmcdManager.StreamingFormat = {
   SMOOTH: 's',
   OTHER: 'o',
 };
-
-
-/**
- * The CMCD spec version
- * @const {number}
- */
-shaka.util.CmcdManager.Version = 1;

package/lib/util/cmsd_manager.js

@@ -23,10 +23,10 @@ shaka.util.CmsdManager = class {
     /** @private {shaka.extern.CmsdConfiguration} */
     this.config_ = config;
 
-    /** @private {?Map.<string, (boolean|number|string)>} */
+    /** @private {?Map<string, (boolean | number | string)>} */
     this.staticParams_ = null;
 
-    /** @private {?Map.<string, (boolean|number|string)>} */
+    /** @private {?Map<string, (boolean | number | string)>} */
     this.dynamicParams_ = null;
   }
 
@@ -52,7 +52,7 @@ shaka.util.CmsdManager = class {
   /**
    * Called by the Player to provide the headers of the latest request.
    *
-   * @param {!Object.<string, string>} headers
+   * @param {!Object<string, string>} headers
    */
   processHeaders(headers) {
     if (!this.config_.enabled) {
@@ -161,7 +161,7 @@ shaka.util.CmsdManager = class {
 
   /**
    * @param {string} headerValue
-   * @return {?Map.<string, (boolean|number|string)>}
+   * @return {?Map<string, (boolean | number | string)>}
    * @private
    */
   parseCMSDStatic_(headerValue) {
@@ -170,9 +170,9 @@ shaka.util.CmsdManager = class {
       const items = headerValue.split(',');
       for (let i = 0; i < items.length; i++) {
         // <key>=<value>
-        const substrs = items[i].split('=');
-        const key = substrs[0];
-        const value = this.parseParameterValue_(substrs[1]);
+        const substrings = items[i].split('=');
+        const key = substrings[0];
+        const value = this.parseParameterValue_(substrings[1]);
         params.set(key, value);
       }
       return params;
@@ -185,7 +185,7 @@ shaka.util.CmsdManager = class {
 
   /**
    * @param {string} headerValue
-   * @return {?Map.<string, (boolean|number|string)>}
+   * @return {?Map<string, (boolean | number | string)>}
    * @private
    */
   parseCMSDDynamic_(headerValue) {
@@ -195,9 +195,9 @@ shaka.util.CmsdManager = class {
       // Server identifier as 1st item
       for (let i = 1; i < items.length; i++) {
         // <key>=<value>
-        const substrs = items[i].split('=');
-        const key = substrs[0];
-        const value = this.parseParameterValue_(substrs[1]);
+        const substrings = items[i].split('=');
+        const key = substrings[0];
+        const value = this.parseParameterValue_(substrings[1]);
         params.set(key, value);
       }
       return params;

package/lib/util/config_utils.js

@@ -86,7 +86,7 @@ shaka.util.ConfigUtils = class {
         isValid = isValid && subMergeValid;
       } else if (typeof source[k] != typeof subTemplate ||
                  source[k] == null ||
-                 // Function cosntructors are not informative, and differ
+                 // Function constructors are not informative, and differ
                  // between sync and async functions.  So don't look at
                  // constructor for function types.
                  (typeof source[k] != 'function' &&
@@ -125,7 +125,7 @@ shaka.util.ConfigUtils = class {
     let last = configObject;
     let searchIndex = 0;
     let nameStart = 0;
-    while (true) {  // eslint-disable-line no-constant-condition
+    while (true) {
       const idx = fieldName.indexOf('.', searchIndex);
       if (idx < 0) {
         break;
@@ -158,7 +158,7 @@ shaka.util.ConfigUtils = class {
              a);  // Can be anything, doesn't need to be one of the parameters
    *   };
    *
-   * @param {!Array.<?>} parameters
+   * @param {!Array<?>} parameters
    * @param {T} returnValue
    * @return {T}
    * @template T

package/lib/util/content_steering_manager.js

@@ -36,19 +36,19 @@ shaka.util.ContentSteeringManager = class {
     /** @private {!shaka.util.OperationManager} */
     this.operationManager_ = new shaka.util.OperationManager();
 
-    /** @private {!Array.<string>} */
+    /** @private {!Array<string>} */
     this.baseUris_ = [];
 
     /** @private {?string} */
     this.defaultPathwayId_ = null;
 
-    /** @private {!Array.<string>} */
+    /** @private {!Array<string>} */
     this.pathwayPriority_ = [];
 
     /** @private {?string} */
     this.lastPathwayUsed_ = null;
 
-    /** @private {!Array.<shaka.util.ContentSteeringManager.PathawayClone>} */
+    /** @private {!Array<shaka.util.ContentSteeringManager.PathwayClone>} */
     this.pathwayClones_ = [];
 
     /**
@@ -58,10 +58,10 @@ shaka.util.ContentSteeringManager = class {
      */
     this.lastTTL_ = 300;
 
-    /** @private {!Map.<(string|number), !Map.<string, string>>} */
+    /** @private {!Map<(string | number), !Map<string, string>>} */
     this.locations_ = new Map();
 
-    /** @private {!Map.<string, number>} */
+    /** @private {!Map<string, number>} */
     this.bannedLocations_ = new Map();
 
     /** @private {?shaka.util.Timer} */
@@ -105,7 +105,7 @@ shaka.util.ContentSteeringManager = class {
   }
 
   /**
-   * @param {!Array.<string>} baseUris
+   * @param {!Array<string>} baseUris
    */
   setBaseUris(baseUris) {
     this.baseUris_ = baseUris;
@@ -237,11 +237,11 @@ shaka.util.ContentSteeringManager = class {
    *
    * @param {string|number} streamId
    * @param {boolean=} ignoreBaseUrls
-   * @return {!Array.<string>}
+   * @return {!Array<string>}
    */
   getLocations(streamId, ignoreBaseUrls = false) {
     const streamLocations = this.locations_.get(streamId) || new Map();
-    /** @type {!Array.<!{pathwayId: string, location: string}>} */
+    /** @type {!Array<!{pathwayId: string, location: string}>} */
     let locationsPathwayIdMap = [];
     for (const pathwayId of this.pathwayPriority_) {
       const location = streamLocations.get(pathwayId);
@@ -320,8 +320,8 @@ shaka.util.ContentSteeringManager = class {
  *   VERSION: number,
  *   TTL: number,
  *   RELOAD-URI: string,
- *   PATHWAY-PRIORITY: !Array.<string>,
- *   PATHWAY-CLONES: !Array.<shaka.util.ContentSteeringManager.PathawayClone>
+ *   PATHWAY-PRIORITY: !Array<string>,
+ *   PATHWAY-CLONES: !Array<shaka.util.ContentSteeringManager.PathwayClone>
  * }}
  *
  * @description
@@ -329,10 +329,10 @@ shaka.util.ContentSteeringManager = class {
  *
  * @property {string} VERSION
  * @property {number} TTL
- * @property {string RELOAD-URI
- * @property {!Array.<string>} PATHWAY-PRIORITY
- * @property {!Array.<
- *            shaka.util.ContentSteeringManager.PathawayClone>} PATHWAY-CLONES
+ * @property {string} RELOAD-URI
+ * @property {!Array<string>} PATHWAY-PRIORITY
+ * @property {!Array<
+ *            shaka.util.ContentSteeringManager.PathwayClone>} PATHWAY-CLONES
  */
 shaka.util.ContentSteeringManager.SteeringManifest;
 
@@ -341,15 +341,15 @@ shaka.util.ContentSteeringManager.SteeringManifest;
  * @typedef {{
  *   BASE-ID: string,
  *   ID: string,
- *   URI-REPLACEMENT: !Array.<shaka.util.ContentSteeringManager.UriReplacement>
+ *   URI-REPLACEMENT: !Array<shaka.util.ContentSteeringManager.UriReplacement>
  * }}
  *
  * @property {string} BASE-ID
  * @property {string} ID
- * @property {!Array.<
+ * @property {!Array<
  *            shaka.util.ContentSteeringManager.UriReplacement>} URI-REPLACEMENT
  */
-shaka.util.ContentSteeringManager.PathawayClone;
+shaka.util.ContentSteeringManager.PathwayClone;
 
 
 /**

package/lib/util/data_view_reader.js

@@ -13,9 +13,9 @@ goog.require('shaka.util.StringUtils');
 
 
 /**
-  * @summary DataViewReader abstracts a DataView object.
-  * @export
-  */
+ * @summary DataViewReader abstracts a DataView object.
+ * @export
+ */
 shaka.util.DataViewReader = class {
   /**
    * @param {BufferSource} data

package/lib/util/ebml_parser.js

@@ -198,7 +198,7 @@ shaka.util.EbmlParser = class {
 
 /**
  * A list of EBML dynamic size constants.
- * @const {!Array.<!Array.<number>>}
+ * @const {!Array<!Array<number>>}
  */
 shaka.util.EbmlParser.DYNAMIC_SIZES = [
   [0xff],

package/lib/util/error.js

@@ -208,7 +208,7 @@ shaka.util.Error.Code = {
    * <br> error.data[0] is the URI.
    * <br> error.data[1] is the status code.
    * <br> error.data[2] is the response text, or null if the response could not
-   *   be interpretted as text.
+   *   be interpreted as text.
    * <br> error.data[3] is the map of response headers.
    * <br> error.data[4] is the NetworkingEngine.RequestType of the request,
    *   if one was provided.
@@ -509,7 +509,7 @@ shaka.util.Error.Code = {
   // RETIRED: 'MSS_TRANSMUXING_CODEC_UNKNOWN': 3021,
 
   /**
-   * MSS transmuing failed for unknown reason.
+   * MSS transmuxing failed for unknown reason.
    * <br> error.data[0] is the segment URI that triggered the error, if any.
    */
   'MSS_TRANSMUXING_FAILED': 3022,
@@ -600,7 +600,7 @@ shaka.util.Error.Code = {
   // RETIRED: 'NO_PERIODS': 4014,
 
   /**
-   * HLS playlist doesn't start with a mandory #EXTM3U tag.
+   * HLS playlist doesn't start with a mandatory #EXTM3U tag.
    */
   'HLS_PLAYLIST_HEADER_MISSING': 4015,
 
@@ -681,8 +681,8 @@ shaka.util.Error.Code = {
    * example, this could happen if the content is WebM, but your browser does
    * not support the WebM container, or if the content uses HEVC, but your
    * browser does not support the HEVC codec.  This can also occur for
-   * multicodec or multicontainer manifests if none of the codecs or containers
-   * are supported by the browser.
+   * multi codec or multi container manifests if none of the codecs
+   * or containers are supported by the browser.
    *
    * To see what your browser supports, you can check the JSON data dumped by
    * http://support.shaka-player-demo.appspot.com/
@@ -702,7 +702,7 @@ shaka.util.Error.Code = {
 
   /**
    * We failed to find matching streams across DASH Periods, and the
-   * period-flattening aglorithm introduced in v3.0 has failed.
+   * period-flattening algorithm introduced in v3.0 has failed.
    */
   'PERIOD_FLATTENING_FAILED': 4037,
 
@@ -935,6 +935,11 @@ shaka.util.Error.Code = {
    */
   'ERROR_CHECKING_HDCP_VERSION': 6019,
 
+  /**
+   * The browser does not support EME APIs, so DRM content cannot be played.
+   */
+  'MISSING_EME_SUPPORT': 6020,
+
 
   /**
    * The call to Player.load() was interrupted by a call to Player.unload()

package/lib/util/event_manager.js

@@ -24,7 +24,7 @@ shaka.util.EventManager = class {
   constructor() {
     /**
      * Maps an event type to an array of event bindings.
-     * @private {shaka.util.MultiMap.<!shaka.util.EventManager.Binding_>}
+     * @private {shaka.util.MultiMap<!shaka.util.EventManager.Binding_>}
      */
     this.bindingMap_ = new shaka.util.MultiMap();
   }

package/lib/util/exp_golomb.js

@@ -23,7 +23,7 @@ goog.require('shaka.util.DataViewReader');
 
 /**
  * @summary
- * Parser for exponential Golomb codes, a variable-bitwidth number encoding
+ * Parser for exponential Golomb codes, a variable-bit width number encoding
  * scheme used by h264.
  * Based on https://github.com/videojs/mux.js/blob/main/lib/utils/exp-golomb.js
  *

package/lib/util/fairplay_utils.js

@@ -23,7 +23,7 @@ shaka.util.FairPlayUtils = class {
   /**
    * Check if FairPlay is supported.
    *
-   * @return {!Promise.<boolean>}
+   * @return {!Promise<boolean>}
    * @export
    */
   static async isFairPlaySupported() {
@@ -138,6 +138,7 @@ shaka.util.FairPlayUtils = class {
    * @param {!Uint8Array} initData
    * @param {string} initDataType
    * @param {?shaka.extern.DrmInfo} drmInfo
+   * @return {!Uint8Array}
    * @private
    */
   static basicInitDataTransform_(initData, initDataType, drmInfo) {
@@ -158,6 +159,7 @@ shaka.util.FairPlayUtils = class {
    * @param {!Uint8Array} initData
    * @param {string} initDataType
    * @param {?shaka.extern.DrmInfo} drmInfo
+   * @return {!Uint8Array}
    * @export
    */
   static verimatrixInitDataTransform(initData, initDataType, drmInfo) {
@@ -171,6 +173,7 @@ shaka.util.FairPlayUtils = class {
    * @param {!Uint8Array} initData
    * @param {string} initDataType
    * @param {?shaka.extern.DrmInfo} drmInfo
+   * @return {!Uint8Array}
    * @export
    */
   static ezdrmInitDataTransform(initData, initDataType, drmInfo) {
@@ -191,6 +194,7 @@ shaka.util.FairPlayUtils = class {
    * @param {!Uint8Array} initData
    * @param {string} initDataType
    * @param {?shaka.extern.DrmInfo} drmInfo
+   * @return {!Uint8Array}
    * @export
    */
   static conaxInitDataTransform(initData, initDataType, drmInfo) {
@@ -221,6 +225,7 @@ shaka.util.FairPlayUtils = class {
    * @param {!Uint8Array} initData
    * @param {string} initDataType
    * @param {?shaka.extern.DrmInfo} drmInfo
+   * @return {!Uint8Array}
    * @export
    */
   static expressplayInitDataTransform(initData, initDataType, drmInfo) {

package/lib/util/fake_event.js

@@ -36,7 +36,7 @@ shaka.util.FakeEvent = class {
   /**
    * Allows us to tell the compiler that the dictionary "map" is actually a
    * generic object, for backwards compatibility.
-   * @param {!Map.<string, Object>} dict
+   * @param {!Map<string, Object>} dict
    * @return {!Object}
    * @suppress {invalidCasts}
    * @private
@@ -48,7 +48,7 @@ shaka.util.FakeEvent = class {
 
   /**
    * @param {string} type
-   * @param {Map.<string, Object>=} dict
+   * @param {Map<string, Object>=} dict
    */
   constructor(type, dict) {
     if (dict) {
@@ -158,6 +158,7 @@ shaka.util.FakeEvent.EventName = {
   AudioTrackChanged: 'audiotrackchanged',
   Buffering: 'buffering',
   Complete: 'complete',
+  DownloadCompleted: 'downloadcompleted',
   DownloadFailed: 'downloadfailed',
   DownloadHeadersReceived: 'downloadheadersreceived',
   DrmSessionUpdate: 'drmsessionupdate',

package/lib/util/fake_event_target.js

@@ -26,7 +26,7 @@ shaka.util.FakeEventTarget = class {
   /** */
   constructor() {
     /**
-     * @private {shaka.util.MultiMap.<shaka.util.FakeEventTarget.ListenerType>}
+     * @private {shaka.util.MultiMap<shaka.util.FakeEventTarget.ListenerType>}
      */
     this.listeners_ = new shaka.util.MultiMap();