shaka-player 4.3.9 → 4.4.0

package/lib/ads/client_side_ad.js

@@ -252,6 +252,92 @@ shaka.ads.ClientSideAd = class {
     return this.ad_.getDescription();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaBitrate() {
+    return this.ad_.getVastMediaBitrate();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaHeight() {
+    return this.ad_.getVastMediaHeight();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaWidth() {
+    return this.ad_.getVastMediaWidth();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getAdId() {
+    return this.ad_.getAdId();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getCreativeAdId() {
+    return this.ad_.getCreativeAdId();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getAdvertiserName() {
+    return this.ad_.getAdvertiserName();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getMediaUrl() {
+    return this.ad_.getMediaUrl();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getTimeOffset() {
+    const podInfo = this.ad_.getAdPodInfo();
+    if (podInfo == null) {
+      // Defaults to 0 if this ad is not part of a pod, or the pod is not part
+      // of an ad playlist.
+      return 0;
+    }
+
+    return podInfo.getTimeOffset();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getPodIndex() {
+    const podInfo = this.ad_.getAdPodInfo();
+    if (podInfo == null) {
+      // Defaults to 0 if this ad is not part of a pod, or the pod is not part
+      // of an ad playlist.
+      return 0;
+    }
+
+    return podInfo.getPodIndex();
+  }
+
   /**
    * @override
    * @export

package/lib/ads/client_side_ad_manager.js

@@ -24,15 +24,22 @@ shaka.ads.ClientSideAdManager = class {
    * @param {HTMLElement} adContainer
    * @param {HTMLMediaElement} video
    * @param {string} locale
+   * @param {?google.ima.AdsRenderingSettings} adsRenderingSettings
    * @param {function(!shaka.util.FakeEvent)} onEvent
    */
-  constructor(adContainer, video, locale, onEvent) {
+  constructor(adContainer, video, locale, adsRenderingSettings, onEvent) {
     /** @private {HTMLElement} */
     this.adContainer_ = adContainer;
 
     /** @private {HTMLMediaElement} */
     this.video_ = video;
 
+    /** @private {boolean} */
+    this.videoPlayed_ = false;
+
+    /** @private {?shaka.extern.AdsConfiguration} */
+    this.config_ = null;
+
     /** @private {ResizeObserver} */
     this.resizeObserver_ = null;
 
@@ -50,6 +57,8 @@ shaka.ads.ClientSideAdManager = class {
 
     google.ima.settings.setLocale(locale);
 
+    google.ima.settings.setDisableCustomPlaybackForIOS10Plus(true);
+
     const adDisplayContainer = new google.ima.AdDisplayContainer(
         this.adContainer_,
         this.video_);
@@ -67,7 +76,11 @@ shaka.ads.ClientSideAdManager = class {
     /** @private {google.ima.AdsManager} */
     this.imaAdsManager_ = null;
 
-    this.eventManager_.listenOnce(this.adsLoader_,
+    /** @private {!google.ima.AdsRenderingSettings} */
+    this.adsRenderingSettings_ =
+        adsRenderingSettings || new google.ima.AdsRenderingSettings();
+
+    this.eventManager_.listen(this.adsLoader_,
         google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED, (e) => {
           this.onAdsManagerLoaded_(
               /** @type {!google.ima.AdsManagerLoadedEvent} */ (e));
@@ -82,6 +95,20 @@ shaka.ads.ClientSideAdManager = class {
     this.eventManager_.listen(this.video_, 'ended', () => {
       this.adsLoader_.contentComplete();
     });
+
+    this.eventManager_.listenOnce(this.video_, 'play', () => {
+      this.videoPlayed_ = true;
+    });
+  }
+
+  /**
+   * Called by the AdManager to provide an updated configuration any time it
+   * changes.
+   *
+   * @param {shaka.extern.AdsConfiguration} config
+   */
+  configure(config) {
+    this.config_ = config;
   }
 
   /**
@@ -92,10 +119,32 @@ shaka.ads.ClientSideAdManager = class {
         imaRequest.adTagUrl || imaRequest.adsResponse,
         'The ad tag needs to be set up before requesting ads, ' +
           'or adsResponse must be filled.');
+    // Destroy the current AdsManager, in case the tag you requested previously
+    // contains post-rolls (don't play those now).
+    if (this.imaAdsManager_) {
+      this.imaAdsManager_.destroy();
+    }
+    // Your AdsLoader will be set up on page-load. You should re-use the same
+    // AdsLoader for every request.
+    if (this.adsLoader_) {
+      // Reset the IMA SDK.
+      this.adsLoader_.contentComplete();
+    }
     this.requestAdsStartTime_ = Date.now() / 1000;
     this.adsLoader_.requestAds(imaRequest);
   }
 
+  /**
+   * @param {!google.ima.AdsRenderingSettings} adsRenderingSettings
+   */
+  updateAdsRenderingSettings(adsRenderingSettings) {
+    this.adsRenderingSettings_ = adsRenderingSettings;
+    if (this.imaAdsManager_) {
+      this.imaAdsManager_.updateAdsRenderingSettings(
+          this.adsRenderingSettings_);
+    }
+  }
+
   /**
    * Stop all currently playing ads.
    */
@@ -133,6 +182,10 @@ shaka.ads.ClientSideAdManager = class {
     shaka.log.warning(
         'There was an ad error from the IMA SDK: ' + e.getError());
     shaka.log.warning('Resuming playback.');
+
+    const data = (new Map()).set('originalEvent', e);
+    this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.AD_ERROR, data));
+
     this.onAdComplete_(/* adEvent= */ null);
     // Remove ad breaks from the timeline
     this.onEvent_(
@@ -153,7 +206,37 @@ shaka.ads.ClientSideAdManager = class {
     this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.ADS_LOADED,
         (new Map()).set('loadTime', loadTime)));
 
-    this.imaAdsManager_ = e.getAdsManager(this.video_);
+    if (!this.config_.customPlayheadTracker) {
+      this.imaAdsManager_ = e.getAdsManager(this.video_,
+          this.adsRenderingSettings_);
+    } else {
+      const videoPlayHead = {
+        currentTime: this.video_.currentTime,
+      };
+
+      this.imaAdsManager_ = e.getAdsManager(videoPlayHead,
+          this.adsRenderingSettings_);
+
+      if (this.video_.muted) {
+        this.imaAdsManager_.setVolume(0);
+      } else {
+        this.imaAdsManager_.setVolume(this.video_.volume);
+      }
+
+      this.eventManager_.listen(this.video_, 'timeupdate', () => {
+        if (!this.video_.duration) {
+          return;
+        }
+        videoPlayHead.currentTime = this.video_.currentTime;
+      });
+      this.eventManager_.listen(this.video_, 'volumechange', () => {
+        if (this.video_.muted) {
+          this.imaAdsManager_.setVolume(0);
+        } else {
+          this.imaAdsManager_.setVolume(this.video_.volume);
+        }
+      });
+    }
 
     this.onEvent_(new shaka.util.FakeEvent(
         shaka.ads.AdManager.IMA_AD_MANAGER_LOADED,
@@ -219,9 +302,14 @@ shaka.ads.ClientSideAdManager = class {
       // seen the ads actually play until requestAds() is called.
       // Note: We listen for a play event to avoid autoplay issues that might
       // crash IMA.
-      this.eventManager_.listenOnce(this.video_, 'play', () => {
+      if (this.videoPlayed_) {
         this.imaAdsManager_.start();
-      });
+      } else {
+        this.eventManager_.listenOnce(this.video_, 'play', () => {
+          this.videoPlayed_ = true;
+          this.imaAdsManager_.start();
+        });
+      }
     } catch (adError) {
       // If there was a problem with the VAST response,
       // we we won't be getting an ad. Hide ad UI if we showed it already

package/lib/ads/server_side_ad.js

@@ -221,6 +221,92 @@ shaka.ads.ServerSideAd = class {
     return this.ad_.getDescription();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaBitrate() {
+    return 0;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaHeight() {
+    return this.ad_.getVastMediaHeight();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaWidth() {
+    return this.ad_.getVastMediaWidth();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getAdId() {
+    return this.ad_.getAdId();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getCreativeAdId() {
+    return this.ad_.getCreativeAdId();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getAdvertiserName() {
+    return this.ad_.getAdvertiserName();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getMediaUrl() {
+    return null;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getTimeOffset() {
+    const podInfo = this.ad_.getAdPodInfo();
+    if (podInfo == null) {
+      // Defaults to 0 if this ad is not part of a pod, or the pod is not part
+      // of an ad playlist.
+      return 0;
+    }
+
+    return podInfo.getTimeOffset();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getPodIndex() {
+    const podInfo = this.ad_.getAdPodInfo();
+    if (podInfo == null) {
+      // Defaults to 0 if this ad is not part of a pod, or the pod is not part
+      // of an ad playlist.
+      return 0;
+    }
+
+    return podInfo.getPodIndex();
+  }
+
   /**
    * @override
    * @export

package/lib/ads/server_side_ad_manager.js

@@ -35,6 +35,9 @@ shaka.ads.ServerSideAdManager = class {
     /** @private {HTMLMediaElement} */
     this.video_ = video;
 
+    /** @private {?shaka.extern.AdsConfiguration} */
+    this.config_ = null;
+
     /** @private
         {?shaka.util.PublicPromise.<string>} */
     this.streamPromise_ = null;
@@ -168,6 +171,16 @@ shaka.ads.ServerSideAdManager = class {
         });
   }
 
+  /**
+   * Called by the AdManager to provide an updated configuration any time it
+   * changes.
+   *
+   * @param {shaka.extern.AdsConfiguration} config
+   */
+  configure(config) {
+    this.config_ = config;
+  }
+
   /**
    * @param {!google.ima.dai.api.StreamRequest} streamRequest
    * @param {string=} backupUrl

package/lib/cast/cast_utils.js

@@ -325,6 +325,7 @@ shaka.cast.CastUtils.PlayerGetterMethods = {
   'keySystem': 10,
   'seekRange': 1,
   'getLoadMode': 10,
+  'getManifestType': 10,
 };
 
 

package/lib/cea/cea608_data_channel.js

@@ -9,7 +9,6 @@ goog.provide('shaka.cea.Cea608DataChannel');
 goog.require('shaka.cea.Cea608Memory');
 goog.require('shaka.cea.CeaUtils');
 goog.require('shaka.log');
-goog.requireType('shaka.cea.ICaptionDecoder');
 
 
 /**
@@ -54,7 +53,7 @@ shaka.cea.Cea608DataChannel = class {
      * Points to current buffer.
      * @private {!shaka.cea.Cea608Memory}
      */
-    this.curbuf_ = this.displayedMemory_;
+    this.curbuf_ = this.nonDisplayedMemory_;
 
     /**
      * End time of the previous caption, serves as start time of next caption.
@@ -73,14 +72,25 @@ shaka.cea.Cea608DataChannel = class {
    * Resets channel state.
    */
   reset() {
-    this.type_ = shaka.cea.Cea608DataChannel.CaptionType.PAINTON;
-    this.curbuf_ = this.displayedMemory_;
+    this.type_ = shaka.cea.Cea608DataChannel.CaptionType.NONE;
+    this.curbuf_ = this.nonDisplayedMemory_;
     this.lastcp_ = null;
     this.displayedMemory_.reset();
     this.nonDisplayedMemory_.reset();
     this.text_.reset();
   }
 
+  /**
+   * Set the initial PTS, which may not be 0 if we start decoding at a later
+   * point in the stream.  Without this, the first cue's startTime can be way
+   * off.
+   *
+   * @param {number} pts
+   */
+  firstPts(pts) {
+    this.prevEndTime_ = pts;
+  }
+
   /**
    * Gets the row index from a Preamble Address Code byte pair.
    * @param {number} b1 Byte 1.
@@ -155,12 +165,12 @@ shaka.cea.Cea608DataChannel = class {
     }
     buf.setRow(row);
 
-    this.curbuf_.setUnderline(underline);
-    this.curbuf_.setItalics(italics);
-    this.curbuf_.setTextColor(textColor);
+    buf.setUnderline(underline);
+    buf.setItalics(italics);
+    buf.setTextColor(textColor);
 
     // Clear the background color, since new row (PAC) should reset ALL styles.
-    this.curbuf_.setBackgroundColor(shaka.cea.CeaUtils.DEFAULT_BG_COLOR);
+    buf.setBackgroundColor(shaka.cea.CeaUtils.DEFAULT_BG_COLOR);
   }
 
   /**
@@ -214,7 +224,7 @@ shaka.cea.Cea608DataChannel = class {
   /**
    * The Cea608DataChannel control methods implement all CC control operations.
    * @param {!shaka.cea.Cea608DataChannel.Cea608Packet} ccPacket
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   controlMiscellaneous_(ccPacket) {
@@ -280,7 +290,7 @@ shaka.cea.Cea608DataChannel = class {
    * Any currently buffered line needs to be emitted, along
    * with a window scroll action.
    * @param {number} pts in seconds.
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   controlCr_(pts) {
@@ -313,7 +323,7 @@ shaka.cea.Cea608DataChannel = class {
    *    This means must force emit entire display buffer.
    * @param {number} scrollSize New scroll window size.
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   controlRu_(scrollSize, pts) {
@@ -357,7 +367,7 @@ shaka.cea.Cea608DataChannel = class {
    * Mode check:
    * EDM affects all captioning modes (but not Text mode);
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   controlEdm_(pts) {
@@ -404,7 +414,7 @@ shaka.cea.Cea608DataChannel = class {
    * This forces Pop-On mode, and swaps the displayed and nondisplayed memories.
    * @private
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    */
   controlEoc_(pts) {
     let parsedClosedCaption = null;
@@ -502,7 +512,7 @@ shaka.cea.Cea608DataChannel = class {
    * Three types of control codes:
    * Preamble Address Codes, Mid-Row Codes, and Miscellaneous Control Codes.
    * @param {!shaka.cea.Cea608DataChannel.Cea608Packet} ccPacket
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    */
   handleControlCode(ccPacket) {
     const b1 = ccPacket.ccData1;

package/lib/cea/cea608_memory.js

@@ -8,7 +8,6 @@ goog.provide('shaka.cea.Cea608Memory');
 
 goog.require('shaka.cea.CeaUtils');
 goog.require('shaka.text.Cue');
-goog.requireType('shaka.cea.ICaptionDecoder');
 
 
 /**
@@ -77,12 +76,16 @@ shaka.cea.Cea608Memory = class {
    * Emits a closed caption based on the state of the buffer.
    * @param {number} startTime Start time of the cue.
    * @param {number} endTime End time of the cue.
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    */
   forceEmit(startTime, endTime) {
     const stream = `CC${(this.fieldNum_<< 1) | this.channelNum_ +1}`;
     const topLevelCue = new shaka.text.Cue(
         startTime, endTime, /* payload= */ '');
+    topLevelCue.lineInterpretation =
+        shaka.text.Cue.lineInterpretation.PERCENTAGE;
+    const maxRows = shaka.cea.Cea608Memory.CC_ROWS + 1;
+    topLevelCue.line = this.row_ / maxRows * 100;
     return shaka.cea.CeaUtils.getParsedCaption(
         topLevelCue, stream, this.rows_, startTime, endTime);
   }

package/lib/cea/cea708_service.js

@@ -8,7 +8,6 @@ goog.provide('shaka.cea.Cea708Service');
 
 goog.require('shaka.cea.Cea708Window');
 goog.require('shaka.cea.DtvccPacket');
-goog.require('shaka.cea.ICaptionDecoder');
 
 
 /**
@@ -44,7 +43,7 @@ shaka.cea.Cea708Service = class {
   /**
    * Processes a CEA-708 control code.
    * @param {!shaka.cea.DtvccPacket} dtvccPacket
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @throws {!shaka.util.Error}
    */
   handleCea708ControlCode(dtvccPacket) {
@@ -156,7 +155,7 @@ shaka.cea.Cea708Service = class {
    * Handles C0 group data.
    * @param {number} controlCode
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   handleC0_(controlCode, pts) {
@@ -207,7 +206,7 @@ shaka.cea.Cea708Service = class {
    * @param {!shaka.cea.DtvccPacket} dtvccPacket
    * @param {number} captionCommand
    * @param {number} pts in seconds
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @throws {!shaka.util.Error} a possible out-of-range buffer read.
    * @private
    */
@@ -318,7 +317,7 @@ shaka.cea.Cea708Service = class {
   /**
    * @param {number} windowsBitmap
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   clearWindows_(windowsBitmap, pts) {
@@ -356,7 +355,7 @@ shaka.cea.Cea708Service = class {
   /**
    * @param {number} windowsBitmap
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   hideWindows_(windowsBitmap, pts) {
@@ -377,7 +376,7 @@ shaka.cea.Cea708Service = class {
   /**
    * @param {number} windowsBitmap
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   toggleWindows_(windowsBitmap, pts) {
@@ -402,7 +401,7 @@ shaka.cea.Cea708Service = class {
   /**
    * @param {number} windowsBitmap
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   deleteWindows_(windowsBitmap, pts) {
@@ -424,7 +423,7 @@ shaka.cea.Cea708Service = class {
    * Emits anything currently present in any of the windows, and then
    * deletes all windows, cancels all delays, reinitializes the service.
    * @param {number} pts
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    * @private
    */
   reset_(pts) {

package/lib/cea/cea708_window.js

@@ -8,7 +8,6 @@ goog.provide('shaka.cea.Cea708Window');
 
 goog.require('shaka.cea.CeaUtils');
 goog.require('shaka.cea.CeaUtils.StyledChar');
-goog.require('shaka.cea.ICaptionDecoder');
 goog.require('shaka.text.Cue');
 goog.require('shaka.util.Functional');
 
@@ -288,7 +287,7 @@ shaka.cea.Cea708Window = class {
   /**
    * @param {number} endTime
    * @param {number} serviceNumber Number of the service emitting this caption.
-   * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
+   * @return {?shaka.extern.ICaptionDecoder.ClosedCaption}
    */
   forceEmit(endTime, serviceNumber) {
     const stream = `svc${serviceNumber}`;