shaka-player 4.12.8 → 4.13.0

package/externs/shaka/text.js

@@ -38,8 +38,8 @@ shaka.extern.TextParser = class {
    *    for each cue.
    * @param {?(string|undefined)} uri
    *    The media uri.
-   * @param {!Array.<string>} images
-   * @return {!Array.<!shaka.text.Cue>}
+   * @param {!Array<string>} images
+   * @return {!Array<!shaka.text.Cue>}
    *
    * @exportDoc
    */
@@ -143,7 +143,7 @@ shaka.extern.TextDisplayer = class {
   /**
    * Append given text cues to the list of cues to be displayed.
    *
-   * @param {!Array.<!shaka.text.Cue>} cues
+   * @param {!Array<!shaka.text.Cue>} cues
    *    Text cues to be appended.
    *
    * @exportDoc
@@ -192,6 +192,13 @@ shaka.extern.TextDisplayer = class {
    * @exportDoc
    */
   setTextLanguage(language) {}
+
+  /**
+   * Enable the current text displayer.
+   *
+   * @exportDoc
+   */
+  enableTextDisplayer() {}
 };
 
 

package/externs/shaka/transmuxer.js

@@ -53,7 +53,7 @@ shaka.extern.Transmuxer = class {
    *   null for init segments
    * @param {number} duration
    * @param {string} contentType
-   * @return {!Promise.<!Uint8Array>}
+   * @return {!Promise<!Uint8Array>}
    */
   transmux(data, stream, reference, duration, contentType) {}
 };

package/externs/videotrack.js

@@ -34,7 +34,7 @@ VideoTrack.prototype.sourceBuffer;
 
 
 /**
- * @extends {IArrayLike.<VideoTrack>}
+ * @extends {IArrayLike<VideoTrack>}
  * @extends {EventTarget}
  * @interface
  */

package/lib/abr/ewma.js

@@ -11,7 +11,7 @@ goog.require('goog.asserts');
 
 /**
  * @summary
- * This class computes an exponentionally-weighted moving average.
+ * This class computes an exponentially-weighted moving average.
  */
 shaka.abr.Ewma = class {
   /**

package/lib/abr/simple_abr_manager.js

@@ -79,7 +79,7 @@ shaka.abr.SimpleAbrManager = class {
 
     /**
      * A filtered list of Variants to choose from.
-     * @private {!Array.<!shaka.extern.Variant>}
+     * @private {!Array<!shaka.extern.Variant>}
      */
     this.variants_ = [];
 
@@ -107,7 +107,8 @@ shaka.abr.SimpleAbrManager = class {
 
     /** @private {shaka.util.Timer} */
     this.resizeObserverTimer_ = new shaka.util.Timer(() => {
-      if (this.enabled_ && this.config_.restrictToElementSize) {
+      if (this.enabled_ && (this.config_.restrictToElementSize ||
+          this.config_.restrictToScreenSize)) {
         const chosenVariant = this.chooseVariant();
         if (chosenVariant) {
           this.switch_(chosenVariant, this.config_.clearBufferSwitch,
@@ -116,6 +117,29 @@ shaka.abr.SimpleAbrManager = class {
       }
     });
 
+    /** @private {Window} */
+    this.windowToCheck_ = window;
+
+    if ('documentPictureInPicture' in window) {
+      this.eventManager_.listen(
+          window.documentPictureInPicture, 'enter', () => {
+            this.windowToCheck_ = window.documentPictureInPicture.window;
+            if (this.resizeObserverTimer_) {
+              this.resizeObserverTimer_.tickNow();
+            }
+            this.eventManager_.listenOnce(
+                this.windowToCheck_, 'pagehide', () => {
+                  this.windowToCheck_ = window;
+                  if (this.resizeObserverTimer_) {
+                    this.resizeObserverTimer_.tickNow();
+                  }
+                });
+          });
+    }
+
+    /** @private {PictureInPictureWindow} */
+    this.pictureInPictureWindow_ = null;
+
     /** @private {?shaka.util.CmsdManager} */
     this.cmsdManager_ = null;
   }
@@ -140,6 +164,8 @@ shaka.abr.SimpleAbrManager = class {
 
     this.resizeObserverTimer_.stop();
 
+    this.pictureInPictureWindow_ = null;
+
     this.cmsdManager_ = null;
 
     // Don't reset |startupComplete_|: if we've left the startup interval, we
@@ -176,19 +202,24 @@ shaka.abr.SimpleAbrManager = class {
     let maxWidth = Infinity;
 
     if (this.config_.restrictToScreenSize) {
-      const devicePixelRatio =
-          this.config_.ignoreDevicePixelRatio ? 1 : window.devicePixelRatio;
-      maxHeight = window.screen.height * devicePixelRatio;
-      maxWidth = window.screen.width * devicePixelRatio;
+      const devicePixelRatio = this.config_.ignoreDevicePixelRatio ?
+          1 : this.windowToCheck_.devicePixelRatio;
+      maxHeight = this.windowToCheck_.screen.height * devicePixelRatio;
+      maxWidth = this.windowToCheck_.screen.width * devicePixelRatio;
     }
 
     if (this.resizeObserver_ && this.config_.restrictToElementSize) {
-      const devicePixelRatio =
-          this.config_.ignoreDevicePixelRatio ? 1 : window.devicePixelRatio;
-      maxHeight = Math.min(
-          maxHeight, this.mediaElement_.clientHeight * devicePixelRatio);
-      maxWidth = Math.min(
-          maxWidth, this.mediaElement_.clientWidth * devicePixelRatio);
+      const devicePixelRatio = this.config_.ignoreDevicePixelRatio ?
+          1 : this.windowToCheck_.devicePixelRatio;
+      let height = this.mediaElement_.clientHeight;
+      let width = this.mediaElement_.clientWidth;
+      if (this.pictureInPictureWindow_ && document.pictureInPictureElement &&
+          document.pictureInPictureElement == this.mediaElement_) {
+        height = this.pictureInPictureWindow_.height;
+        width = this.pictureInPictureWindow_.width;
+      }
+      maxHeight = Math.min(maxHeight, height * devicePixelRatio);
+      maxWidth = Math.min(maxWidth, width * devicePixelRatio);
     }
 
     let normalVariants = this.variants_.filter((variant) => {
@@ -386,15 +417,32 @@ shaka.abr.SimpleAbrManager = class {
       this.resizeObserver_.disconnect();
       this.resizeObserver_ = null;
     }
+    const onResize = () => {
+      const SimpleAbrManager = shaka.abr.SimpleAbrManager;
+      // Batch up resize changes before checking them.
+      this.resizeObserverTimer_.tickAfter(
+          /* seconds= */ SimpleAbrManager.RESIZE_OBSERVER_BATCH_TIME);
+    };
     if (this.mediaElement_ && 'ResizeObserver' in window) {
-      this.resizeObserver_ = new ResizeObserver(() => {
-        const SimpleAbrManager = shaka.abr.SimpleAbrManager;
-        // Batch up resize changes before checking them.
-        this.resizeObserverTimer_.tickAfter(
-            /* seconds= */ SimpleAbrManager.RESIZE_OBSERVER_BATCH_TIME);
-      });
+      this.resizeObserver_ = new ResizeObserver(onResize);
       this.resizeObserver_.observe(this.mediaElement_);
     }
+
+    this.eventManager_.listen(mediaElement, 'enterpictureinpicture', (e) => {
+      const event = /** @type {PictureInPictureEvent} */(e);
+      if (event.pictureInPictureWindow) {
+        this.pictureInPictureWindow_ = event.pictureInPictureWindow;
+        this.eventManager_.listen(
+            this.pictureInPictureWindow_, 'resize', onResize);
+      }
+    });
+    this.eventManager_.listen(mediaElement, 'leavepictureinpicture', () => {
+      if (this.pictureInPictureWindow_) {
+        this.eventManager_.unlisten(
+            this.pictureInPictureWindow_, 'resize', onResize);
+      }
+      this.pictureInPictureWindow_ = null;
+    });
   }
 
 
@@ -485,10 +533,10 @@ shaka.abr.SimpleAbrManager = class {
 
   /**
    * @param {?shaka.extern.Restrictions} restrictions
-   * @param {!Array.<shaka.extern.Variant>} variants
+   * @param {!Array<shaka.extern.Variant>} variants
    * @param {!number} maxHeight
    * @param {!number} maxWidth
-   * @return {!Array.<shaka.extern.Variant>} variants filtered according to
+   * @return {!Array<shaka.extern.Variant>} variants filtered according to
    *   |restrictions| and sorted in ascending order of bandwidth.
    * @private
    */
@@ -523,8 +571,8 @@ shaka.abr.SimpleAbrManager = class {
   }
 
   /**
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @return {!Array.<{height: number, width: number}>}
+   * @param {!Array<shaka.extern.Variant>} variants
+   * @return {!Array<{height: number, width: number}>}
    * @private
    */
   getResolutionList_(variants) {

package/lib/ads/ad_manager.js

@@ -21,6 +21,7 @@ goog.require('shaka.util.Error');
 goog.require('shaka.util.FakeEvent');
 goog.require('shaka.util.FakeEventTarget');
 goog.require('shaka.util.IReleasable');
+goog.require('shaka.util.TXml');
 
 
 /**
@@ -177,7 +178,7 @@ goog.require('shaka.util.IReleasable');
  *  change.
  * @property {string} type
  *   'ad-cue-points-changed'
- * @property {!Array.<!shaka.extern.AdCuePoint>} cuepoints
+ * @property {!Array<!shaka.extern.AdCuePoint>} cuepoints
  *    The ad cue points, if available.
  * @exportDoc
  */
@@ -537,9 +538,9 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
 
 
   /**
-  * @override
-  * @export
-  */
+   * @override
+   * @export
+   */
   onAssetUnload() {
     if (this.interstitialAdManager_) {
       this.interstitialAdManager_.stop();
@@ -614,7 +615,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @param {string} url
    * @param {Object} adsParams
    * @param {string=} backupUrl
-   * @return {!Promise.<string>}
+   * @return {!Promise<string>}
    * @override
    * @export
    */
@@ -681,7 +682,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   /**
    * @param {!google.ima.dai.api.StreamRequest} imaRequest
    * @param {string=} backupUrl
-   * @return {!Promise.<string>}
+   * @return {!Promise<string>}
    * @override
    * @export
    */
@@ -701,7 +702,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     if (adTagParams['mpt'] || adTagParams['mpv']) {
       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
         'parameters of the ad tag. Please note that those parameters are ' +
-        'used for Shaka adoption tracking and will be overriden.');
+        'used for Shaka adoption tracking and will be overridden.');
     }
 
     // Set player and version parameters for tracking
@@ -726,7 +727,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     if (adTagParameters['mpt'] || adTagParameters['mpv']) {
       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
         'parameters of the ad tag. Please note that those parameters are ' +
-        'used for Shaka adoption tracking and will be overriden.');
+        'used for Shaka adoption tracking and will be overridden.');
     }
 
     adTagParameters['mpt'] = 'Shaka Player';
@@ -737,7 +738,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
 
 
   /**
-   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   * @return {!Array<!shaka.extern.AdCuePoint>}
    * @override
    * @export
    */
@@ -750,7 +751,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
 
 
   /**
-   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   * @return {!Array<!shaka.extern.AdCuePoint>}
    * @override
    * @export
    */
@@ -843,14 +844,24 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     if (this.config_ && this.config_.disableDASHInterstitial) {
       return;
     }
-    if (region.schemeIdUri != 'urn:mpeg:dash:event:alternativeMPD:2022') {
-      return;
-    }
-    if (!this.interstitialAdManager_) {
-      this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
-    }
-    if (this.interstitialAdManager_) {
-      this.interstitialAdManager_.addRegion(region);
+    const schemeIdUri = region.schemeIdUri;
+    if (schemeIdUri == 'urn:mpeg:dash:event:alternativeMPD:insert:2025' ||
+        schemeIdUri == 'urn:mpeg:dash:event:alternativeMPD:replace:2025') {
+      if (!this.interstitialAdManager_) {
+        this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
+      }
+      if (this.interstitialAdManager_) {
+        this.interstitialAdManager_.addRegion(region);
+      }
+    } else if (schemeIdUri == 'urn:mpeg:dash:event:2012' &&
+        region.eventNode &&
+        shaka.util.TXml.findChild(region.eventNode, 'OverlayEvent')) {
+      if (!this.interstitialAdManager_) {
+        this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
+      }
+      if (this.interstitialAdManager_) {
+        this.interstitialAdManager_.addOverlayRegion(region);
+      }
     }
   }
 
@@ -882,6 +893,20 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     return this.interstitialAdManager_.addAdUrlInterstitial(url);
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getInterstitialPlayer() {
+    if (!this.interstitialAdManager_) {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.RECOVERABLE,
+          shaka.util.Error.Category.ADS,
+          shaka.util.Error.Code.INTERSTITIAL_AD_MANAGER_NOT_INITIALIZED);
+    }
+    return this.interstitialAdManager_.getPlayer();
+  }
+
   /**
    * @param {!shaka.util.FakeEvent} event
    * @private

package/lib/ads/ad_utils.js

@@ -19,18 +19,13 @@ shaka.ads.Utils = class {
   /**
    * @param {!shaka.extern.xml.Node} vast
    * @param {?number} currentTime
-   * @return {!Array.<shaka.extern.AdInterstitial>}
+   * @return {!Array<shaka.extern.AdInterstitial>}
    */
   static parseVastToInterstitials(vast, currentTime) {
     const TXml = shaka.util.TXml;
-    /** @type {!Array.<shaka.extern.AdInterstitial>} */
+    /** @type {!Array<shaka.extern.AdInterstitial>} */
     const interstitials = [];
 
-    let startTime = 0;
-    if (currentTime != null) {
-      startTime = currentTime;
-    }
-
     for (const ad of TXml.findChildren(vast, 'Ad')) {
       const inline = TXml.findChild(ad, 'InLine');
       if (!inline) {
@@ -42,70 +37,177 @@ shaka.ads.Utils = class {
       }
       for (const creative of TXml.findChildren(creatives, 'Creative')) {
         const linear = TXml.findChild(creative, 'Linear');
-        if (!linear) {
-          continue;
-        }
-        let skipOffset = null;
-        if (linear.attributes['skipoffset']) {
-          skipOffset = shaka.util.TextParser.parseTime(
-              linear.attributes['skipoffset']);
-          if (isNaN(skipOffset)) {
-            skipOffset = null;
-          }
-        }
-        const mediaFiles = TXml.findChild(linear, 'MediaFiles');
-        if (!mediaFiles) {
-          continue;
-        }
-        const medias = TXml.findChildren(mediaFiles, 'MediaFile');
-        let checkMedias = medias;
-        const streamingMedias = medias.filter((media) => {
-          return media.attributes['delivery'] == 'streaming';
-        });
-        if (streamingMedias.length) {
-          checkMedias = streamingMedias;
+        if (linear) {
+          shaka.ads.Utils.processLinearAd_(
+              interstitials, currentTime, linear);
         }
-        const sortedMedias = checkMedias.sort((a, b) => {
-          const aHeight = parseInt(a.attributes['height'], 10) || 0;
-          const bHeight = parseInt(b.attributes['height'], 10) || 0;
-          return bHeight - aHeight;
-        });
-        for (const media of sortedMedias) {
-          const adUrl = TXml.getTextContents(media);
-          if (!adUrl) {
-            continue;
+        const nonLinearAds = TXml.findChild(creative, 'NonLinearAds');
+        if (nonLinearAds) {
+          const nonLinears = TXml.findChildren(nonLinearAds, 'NonLinear');
+          for (const nonLinear of nonLinears) {
+            shaka.ads.Utils.processNonLinearAd_(
+                interstitials, currentTime, nonLinear);
           }
-          interstitials.push({
-            id: null,
-            startTime: startTime,
-            endTime: null,
-            uri: adUrl,
-            mimeType: media.attributes['type'] || null,
-            isSkippable: skipOffset != null,
-            skipOffset,
-            skipFor: null,
-            canJump: false,
-            resumeOffset: 0,
-            playoutLimit: null,
-            once: true,
-            pre: currentTime == null,
-            post: currentTime == Infinity,
-            timelineRange: false,
-          });
-          break;
         }
       }
     }
     return interstitials;
   }
 
+  /**
+   * @param {!Array<shaka.extern.AdInterstitial>} interstitials
+   * @param {?number} currentTime
+   * @param {!shaka.extern.xml.Node} linear
+   * @private
+   */
+  static processLinearAd_(interstitials, currentTime, linear) {
+    const TXml = shaka.util.TXml;
+    let startTime = 0;
+    if (currentTime != null) {
+      startTime = currentTime;
+    }
+    let skipOffset = null;
+    if (linear.attributes['skipoffset']) {
+      skipOffset = shaka.util.TextParser.parseTime(
+          linear.attributes['skipoffset']);
+      if (isNaN(skipOffset)) {
+        skipOffset = null;
+      }
+    }
+    const mediaFiles = TXml.findChild(linear, 'MediaFiles');
+    if (!mediaFiles) {
+      return;
+    }
+    const medias = TXml.findChildren(mediaFiles, 'MediaFile');
+    let checkMedias = medias;
+    const streamingMedias = medias.filter((media) => {
+      return media.attributes['delivery'] == 'streaming';
+    });
+    if (streamingMedias.length) {
+      checkMedias = streamingMedias;
+    }
+    const sortedMedias = checkMedias.sort((a, b) => {
+      const aHeight = parseInt(a.attributes['height'], 10) || 0;
+      const bHeight = parseInt(b.attributes['height'], 10) || 0;
+      return bHeight - aHeight;
+    });
+    for (const media of sortedMedias) {
+      if (media.attributes['apiFramework']) {
+        continue;
+      }
+      const adUrl = TXml.getContents(media);
+      if (!adUrl) {
+        continue;
+      }
+      interstitials.push({
+        id: null,
+        groupId: null,
+        startTime: startTime,
+        endTime: null,
+        uri: adUrl,
+        mimeType: media.attributes['type'] || null,
+        isSkippable: skipOffset != null,
+        skipOffset,
+        skipFor: null,
+        canJump: false,
+        resumeOffset: 0,
+        playoutLimit: null,
+        once: true,
+        pre: currentTime == null,
+        post: currentTime == Infinity,
+        timelineRange: false,
+        loop: false,
+        overlay: null,
+      });
+      break;
+    }
+  }
+
+  /**
+   * @param {!Array<shaka.extern.AdInterstitial>} interstitials
+   * @param {?number} currentTime
+   * @param {!shaka.extern.xml.Node} nonLinear
+   * @private
+   */
+  static processNonLinearAd_(interstitials, currentTime, nonLinear) {
+    const TXml = shaka.util.TXml;
+    let mimeType = null;
+    let resource = TXml.findChild(nonLinear, 'StaticResource');
+    if (resource) {
+      mimeType = resource.attributes['creativeType'];
+    } else {
+      resource = TXml.findChild(nonLinear, 'HTMLResource');
+      if (!resource) {
+        return;
+      }
+      mimeType = 'text/html';
+    }
+    let adUrl = TXml.getContents(resource);
+    if (!adUrl) {
+      return;
+    }
+    if (mimeType === 'text/html') {
+      adUrl = 'data:text/html;charset=UTF-8,' + encodeURIComponent(adUrl);
+    }
+    const width = TXml.parseAttr(nonLinear, 'width', TXml.parseInt) ||
+        TXml.parseAttr(nonLinear, 'expandedWidth', TXml.parseInt);
+    const height = TXml.parseAttr(nonLinear, 'height', TXml.parseInt) ||
+        TXml.parseAttr(nonLinear, 'expandedHeight', TXml.parseInt);
+    if (!width && !height) {
+      return;
+    }
+    let playoutLimit = null;
+    const minSuggestedDuration =
+        nonLinear.attributes['minSuggestedDuration'];
+    if (minSuggestedDuration) {
+      playoutLimit = shaka.util.TextParser.parseTime(minSuggestedDuration);
+    }
+    let startTime = 0;
+    if (currentTime != null) {
+      startTime = currentTime;
+    }
+    interstitials.push({
+      id: null,
+      groupId: null,
+      startTime: startTime,
+      endTime: null,
+      uri: adUrl,
+      mimeType,
+      isSkippable: false,
+      skipOffset: null,
+      skipFor: null,
+      canJump: false,
+      resumeOffset: 0,
+      playoutLimit,
+      once: true,
+      pre: currentTime == null,
+      post: currentTime == Infinity,
+      timelineRange: false,
+      loop: false,
+      overlay: {
+        viewport: {
+          x: 0,
+          y: 0,
+        },
+        topLeft: {
+          x: 0,
+          y: 0,
+        },
+        size: {
+          x: width || 0,
+          y: height || 0,
+        },
+      },
+    });
+  }
+
   /**
    * @param {!shaka.extern.xml.Node} vmap
-   * @return {!Array.<{time: ?number, uri: string}>}
+   * @return {!Array<{time: ?number, uri: string}>}
    */
   static parseVMAP(vmap) {
     const TXml = shaka.util.TXml;
-    /** @type {!Array.<{time: ?number, uri: string}>} */
+    /** @type {!Array<{time: ?number, uri: string}>} */
     const ads = [];
     for (const adBreak of TXml.findChildren(vmap, 'vmap:AdBreak')) {
       const timeOffset = adBreak.attributes['timeOffset'];

package/lib/ads/ads_stats.js

@@ -16,7 +16,7 @@ goog.provide('shaka.ads.AdsStats');
 shaka.ads.AdsStats = class {
   /** */
   constructor() {
-    /** @private {!Array.<number>} */
+    /** @private {!Array<number>} */
     this.loadTimes_ = [];
     /** @private {number} */
     this.started_ = 0;

package/lib/ads/client_side_ad_manager.js

@@ -250,7 +250,7 @@ shaka.ads.ClientSideAdManager = class {
 
     const cuePointStarts = this.imaAdsManager_.getCuePoints();
     if (cuePointStarts.length) {
-      /** @type {!Array.<!shaka.extern.AdCuePoint>} */
+      /** @type {!Array<!shaka.extern.AdCuePoint>} */
       const cuePoints = [];
       for (const start of cuePointStarts) {
         /** @type {shaka.extern.AdCuePoint} */
@@ -303,7 +303,7 @@ shaka.ads.ClientSideAdManager = class {
       }
 
       // Single video and overlay ads will start at this time
-      // TODO (ismena): Need a better inderstanding of what this does.
+      // TODO (ismena): Need a better understanding of what this does.
       // The docs say it's called to 'start playing the ads,' but I haven't
       // seen the ads actually play until requestAds() is called.
       // Note: We listen for a play event to avoid autoplay issues that might