shaka-player 4.4.3 → 4.5.0

package/lib/player.js

@@ -56,7 +56,7 @@ goog.require('shaka.util.PublicPromise');
 goog.require('shaka.util.Stats');
 goog.require('shaka.util.StreamUtils');
 goog.require('shaka.util.Timer');
-goog.require('shaka.lcevc.Dil');
+goog.require('shaka.lcevc.Dec');
 goog.requireType('shaka.media.PresentationTimeline');
 goog.requireType('shaka.routing.Node');
 goog.requireType('shaka.routing.Payload');
@@ -314,6 +314,18 @@ goog.requireType('shaka.routing.Payload');
  */
 
 
+/**
+ * @event shaka.Player.ManifestUpdatedEvent
+ * @description Fired after the manifest has been updated (live streams).
+ * @property {string} type
+ *   'manifestupdated'
+ * @property {boolean} isLive
+ *   True when the playlist is live. Useful to detect transition from live
+ *   to static playlist..
+ * @exportDoc
+ */
+
+
 /**
  * @event shaka.Player.MetadataEvent
  * @description Triggers after metadata associated with the stream is found.
@@ -423,6 +435,26 @@ goog.requireType('shaka.routing.Payload');
  */
 
 
+/**
+ * @event shaka.Player.KeyStatusChanged
+ * @description Fired when the key status changed.
+ * @property {string} type
+ *   'keystatuschanged'
+ * @exportDoc
+ */
+
+
+/**
+ * @event shaka.Player.StateChanged
+ * @description Fired when player state is changed.
+ * @property {string} type
+ *   'statechanged'
+ * @property {string} newstate
+ *   The new state.
+ * @exportDoc
+ */
+
+
 /**
  * @summary The main player object for Shaka Player.
  *
@@ -528,9 +560,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     /** @private {?HTMLCanvasElement} */
     this.lcevcCanvas_ = null;
 
-    // This is the LCEVC Dil object to decode LCEVC.
-    /** @private {?shaka.lcevc.Dil} */
-    this.lcevcDil_ = null;
+    // This is the LCEVC Decoder object to decode LCEVC.
+    /** @private {?shaka.lcevc.Dec} */
+    this.lcevcDec_ = null;
 
     /** @private {shaka.media.QualityObserver} */
     this.qualityObserver_ = null;
@@ -591,7 +623,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
             this.config_.preferredAudioLanguage,
             this.config_.preferredVariantRole,
             this.config_.preferredAudioChannelCount,
-            this.config_.preferredVideoHdrLevel);
+            this.config_.preferredVideoHdrLevel,
+            this.config_.mediaSource.codecSwitchingStrategy);
 
     /** @private {string} */
     this.currentTextLanguage_ = this.config_.preferredTextLanguage;
@@ -763,36 +796,37 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
   }
 
   /**
-   * Create a shaka.lcevc.Dil object
+   * Create a shaka.lcevc.Dec object
    * @param {shaka.extern.LcevcConfiguration} config
    * @private
    */
-  createLcevcDil_(config) {
-    if (this.lcevcDil_ == null) {
-      this.lcevcDil_ = new shaka.lcevc.Dil(
+  createLcevcDec_(config) {
+    if (this.lcevcDec_ == null) {
+      this.lcevcDec_ = new shaka.lcevc.Dec(
           /** @type {HTMLVideoElement} */ (this.video_),
           this.lcevcCanvas_,
           config,
       );
       if (this.mediaSourceEngine_) {
-        this.mediaSourceEngine_.updateLcevcDil(this.lcevcDil_);
+        this.mediaSourceEngine_.updateLcevcDec(this.lcevcDec_);
       }
     }
   }
 
   /**
-   * Close a shaka.lcevc.Dil object if present and hide the canvas.
+   * Close a shaka.lcevc.Dec object if present and hide the canvas.
    * @private
    */
-  closeLcevcDil_() {
-    if (this.lcevcDil_ != null) {
-      this.lcevcDil_.release();
-      this.lcevcDil_ = null;
+  closeLcevcDec_() {
+    if (this.lcevcDec_ != null) {
+      this.lcevcDec_.hideCanvas();
+      this.lcevcDec_.release();
+      this.lcevcDec_ = null;
     }
   }
 
   /**
-   * Setup shaka.lcevc.Dil object
+   * Setup shaka.lcevc.Dec object
    * @param {?shaka.extern.PlayerConfiguration} config
    * @private
    */
@@ -815,10 +849,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           }
         }
       }
-      this.closeLcevcDil_();
-      this.createLcevcDil_(config.lcevc);
+      this.closeLcevcDec_();
+      this.createLcevcDec_(config.lcevc);
     } else {
-      this.closeLcevcDil_();
+      this.closeLcevcDec_();
     }
   }
 
@@ -844,20 +878,23 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       return;
     }
 
-    // If LCEVC Dil exists close it.
-    this.closeLcevcDil_();
+    // If LCEVC Decoder exists close it.
+    this.closeLcevcDec_();
 
     // Mark as "dead". This should stop external-facing calls from changing our
     // internal state any more. This will stop calls to |attach|, |detach|, etc.
     // from interrupting our final move to the detached state.
     this.loadMode_ = shaka.Player.LoadMode.DESTROYED;
 
+    const payload = shaka.Player.createEmptyPayload_();
+    payload.keepAdManager = false;
+
     // Because we have set |loadMode_| to |DESTROYED| we can't call |detach|. We
     // must talk to |this.walker_| directly.
     const events = this.walker_.startNewRoute((currentPayload) => {
       return {
         node: this.detachNode_,
-        payload: shaka.Player.createEmptyPayload_(),
+        payload: payload,
         interruptible: false,
       };
     });
@@ -1156,10 +1193,11 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * <code>detach</code>, or <code>unload</code>.
    *
    * @param {boolean=} initializeMediaSource
+   * @param {boolean=} keepAdManager
    * @return {!Promise}
    * @export
    */
-  unload(initializeMediaSource = true) {
+  unload(initializeMediaSource = true, keepAdManager = false) {
     // Do not allow the player to be used after |destroy| is called.
     if (this.loadMode_ == shaka.Player.LoadMode.DESTROYED) {
       return Promise.reject(this.createAbortLoadError_());
@@ -1173,8 +1211,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       initializeMediaSource = false;
     }
 
-    // If LCEVC Dil exists close it.
-    this.closeLcevcDil_();
+    // If LCEVC Decoder exists close it.
+    this.closeLcevcDec_();
 
     // Since we are going either to attached or detached (through unloaded), we
     // can't allow it to be interrupted or else we could lose track of what
@@ -1184,6 +1222,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     // If we have a media element, we want to go back to attached. If we have no
     // media element, we want to go back to detached.
     const payload = shaka.Player.createEmptyPayload_();
+    payload.keepAdManager = keepAdManager;
 
     const events = this.walker_.startNewRoute((currentPayload) => {
       // When someone calls |unload| we can either be before attached or
@@ -1496,7 +1535,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       has.mediaElement = null;
     }
 
-    if (this.adManager_) {
+    if (this.adManager_ && !wants.keepAdManager) {
       // The ad manager is specific to the video, so detach it too.
       this.adManager_.release();
     }
@@ -1618,7 +1657,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       this.mediaSourceEngine_ = null;
     }
 
-    if (this.adManager_) {
+    if (this.adManager_ && !wants.keepAdManager) {
       this.adManager_.onAssetUnload();
     }
 
@@ -1719,7 +1758,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         (metadata, offset, endTime) => {
           this.processTimedMetadataMediaSrc_(metadata, offset, endTime);
         },
-        this.lcevcDil_);
+        this.lcevcDec_);
     mediaSourceEngine.configure(this.config_.mediaSource);
     const {segmentRelativeVttTiming} = this.config_.manifest;
     mediaSourceEngine.setSegmentRelativeVttTiming(segmentRelativeVttTiming);
@@ -1904,6 +1943,15 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           this.processDrmInfos_(currentDrmInfo.keySystem, stream);
         }
       },
+      onManifestUpdated: () => {
+        const eventName = shaka.util.FakeEvent.EventName.ManifestUpdated;
+        const data = (new Map()).set('isLive', this.isLive());
+        this.dispatchEvent(this.makeEvent_(eventName, data));
+        if (this.adManager_) {
+          this.adManager_.onManifestUpdated(this.isLive());
+        }
+      },
+      getBandwidthEstimate: () => this.abrManager_.getBandwidthEstimate(),
     };
 
     const startTime = Date.now() / 1000;
@@ -2000,8 +2048,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           // the enhancement. In DRM contexts where the browser CDM restricts
           // access from our decoder, the enhancement cannot be applied and
           // therefore the LCEVC output canvas is hidden accordingly.
-          if (this.lcevcDil_) {
-            this.lcevcDil_.hideCanvas();
+          if (this.lcevcDec_) {
+            this.lcevcDec_.hideCanvas();
           }
         }
       },
@@ -2087,7 +2135,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     this.loadEventManager_.listen(mediaElement, 'ended', updateStateHistory);
     this.loadEventManager_.listen(mediaElement, 'ratechange', onRateChange);
 
-    // Check status of the LCEVC DIL Object and reset or
+    // Check status of the LCEVC Dec Object and reset or
     // create or close based on config
     this.setupLcevc_(this.config_);
 
@@ -2112,7 +2160,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
             this.config_.preferredVariantRole,
             this.config_.preferredAudioChannelCount,
             this.config_.preferredVideoHdrLevel,
-            this.config_.preferredAudioLabel);
+            this.config_.preferredAudioLabel,
+            this.config_.mediaSource.codecSwitchingStrategy);
 
     this.currentTextLanguage_ = this.config_.preferredTextLanguage;
     this.currentTextRole_ = this.config_.preferredTextRole;
@@ -2260,8 +2309,6 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       this.onAbrStatusChanged_();
     }
 
-    // Re-filter the manifest after streams have been chosen.
-    this.filterManifestByCurrentVariant_();
     // Dispatch a 'trackschanged' event now that all initial filtering is done.
     this.onTracksChanged_();
 
@@ -2280,12 +2327,18 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
                         'arbitrary language initially');
     }
 
-    if (this.isLive() && (this.config_.streaming.liveSync ||
+    const isLive = this.isLive();
+
+    if (isLive && (this.config_.streaming.liveSync ||
         this.manifest_.serviceDescription)) {
       const onTimeUpdate = () => this.onTimeUpdate_();
       this.loadEventManager_.listen(mediaElement, 'timeupdate', onTimeUpdate);
     }
 
+    if (this.adManager_) {
+      this.adManager_.onManifestUpdated(isLive);
+    }
+
     this.fullyLoaded_ = true;
 
     // Wait for the 'loadedmetadata' event to measure load() latency.
@@ -2374,6 +2427,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       video: {
         id: 0,
         originalId: null,
+        groupId: null,
         createSegmentIndex: () => Promise.resolve(),
         segmentIndex: null,
         mimeType: wants.mimeType ?
@@ -2645,6 +2699,23 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         this.loadEventManager_.listen(mediaElement, 'timeupdate', onTimeUpdate);
       }
 
+      if (this.adManager_) {
+        const isLive = this.isLive();
+        this.adManager_.onManifestUpdated(isLive);
+        // There is no good way to detect when the manifest has been updated,
+        // so we use seekRange().end so we can tell when it has been updated.
+        if (isLive) {
+          let prevSeekRangeEnd = this.seekRange().end;
+          this.loadEventManager_.listen(mediaElement, 'progress', () => {
+            const newSeekRangeEnd = this.seekRange().end;
+            if (prevSeekRangeEnd != newSeekRangeEnd) {
+              this.adManager_.onManifestUpdated(this.isLive());
+              prevSeekRangeEnd = newSeekRangeEnd;
+            }
+          });
+        }
+      }
+
       this.fullyLoaded_ = true;
     });
   }
@@ -3077,16 +3148,16 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @param {!shaka.extern.TextDisplayer} textDisplayer
    * @param {!function(!Array.<shaka.extern.ID3Metadata>, number, ?number)}
    *  onMetadata
-   * @param {shaka.lcevc.Dil} lcevcDil
+   * @param {shaka.lcevc.Dec} lcevcDec
    *
    * @return {!shaka.media.MediaSourceEngine}
    */
-  createMediaSourceEngine(mediaElement, textDisplayer, onMetadata, lcevcDil) {
+  createMediaSourceEngine(mediaElement, textDisplayer, onMetadata, lcevcDec) {
     return new shaka.media.MediaSourceEngine(
         mediaElement,
         textDisplayer,
         onMetadata,
-        lcevcDil);
+        lcevcDec);
   }
 
   /**
@@ -4185,7 +4256,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     if (this.manifest_ && this.playhead_) {
       this.currentAdaptationSetCriteria_ =
           new shaka.media.PreferenceBasedCriteria(language, role || '',
-              channelsCount, /* hdrLevel= */ '', /* label= */ '');
+              channelsCount, /* hdrLevel= */ '', /* label= */ '',
+              this.config_.mediaSource.codecSwitchingStrategy);
 
       const diff = (a, b) => {
         if (!a.video && !b.video) {
@@ -4302,7 +4374,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       // label have the same language.
       this.currentAdaptationSetCriteria_ =
           new shaka.media.PreferenceBasedCriteria(
-              firstVariantWithLabel.language, '', 0, '', label);
+              firstVariantWithLabel.language, '', 0, '', label,
+              this.config_.mediaSource.codecSwitchingStrategy);
 
       this.chooseVariantAndSwitch_(clearBuffer, safeMargin);
     } else if (this.video_ && this.video_.audioTracks) {
@@ -4759,9 +4832,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
 
     let adCuePoints = [];
     if (this.adManager_) {
-      try {
-        adCuePoints = this.adManager_.getServerSideCuePoints();
-      } catch (error) {}
+      adCuePoints = this.adManager_.getCuePoints();
     }
 
     if (this.loadMode_ == shaka.Player.LoadMode.SRC_EQUALS) {
@@ -4816,6 +4887,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     const stream = {
       id: this.nextExternalStreamId_++,
       originalId: null,
+      groupId: null,
       createSegmentIndex: () => Promise.resolve(),
       segmentIndex: shaka.media.SegmentIndex.forSingleSegment(
           /* startTime= */ 0,
@@ -4972,6 +5044,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     const stream = {
       id: this.nextExternalStreamId_++,
       originalId: null,
+      groupId: null,
       createSegmentIndex: () => Promise.resolve(),
       segmentIndex: new shaka.media.SegmentIndex(references),
       mimeType: mimeType || '',
@@ -5033,9 +5106,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
 
     let adCuePoints = [];
     if (this.adManager_) {
-      try {
-        adCuePoints = this.adManager_.getServerSideCuePoints();
-      } catch (error) {}
+      adCuePoints = this.adManager_.getCuePoints();
     }
 
     /** @type {!HTMLTrackElement} */
@@ -5396,6 +5467,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
             const textStream = {
               id: this.nextExternalStreamId_++,  // A globally unique ID.
               originalId: id, // The CC ID string, like 'CC1', 'CC3', etc.
+              groupId: null,
               createSegmentIndex: () => Promise.resolve(),
               segmentIndex,
               mimeType,
@@ -5454,7 +5526,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         this.streamingEngine_.getCurrentVariant() : null;
 
     await shaka.util.StreamUtils.filterManifest(
-        this.drmEngine_, currentVariant, manifest);
+        this.drmEngine_, currentVariant, manifest,
+        this.config_.mediaSource.codecSwitchingStrategy);
     this.checkPlayableVariants_(manifest);
   }
 
@@ -5511,21 +5584,6 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     }
   }
 
-  /**
-   * @private
-   */
-  filterManifestByCurrentVariant_() {
-    goog.asserts.assert(this.manifest_, 'Manifest should be valid');
-    goog.asserts.assert(this.streamingEngine_,
-        'StreamingEngine should be valid');
-
-    const currentVariant = this.streamingEngine_ ?
-        this.streamingEngine_.getCurrentVariant() : null;
-    shaka.util.StreamUtils.filterManifestByCurrentVariant(currentVariant,
-        this.manifest_);
-    this.checkPlayableVariants_(this.manifest_);
-  }
-
   /**
    * @param {shaka.extern.Variant} initialVariant
    * @param {number} time
@@ -5661,14 +5719,20 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
 
     const history = this.stats_.getStateHistory();
 
+    let updateState = 'playing';
     if (this.bufferObserver_.getState() == State.STARVING) {
-      history.update('buffering');
+      updateState = 'buffering';
     } else if (this.video_.paused) {
-      history.update('paused');
+      updateState = 'paused';
     } else if (this.video_.ended) {
-      history.update('ended');
-    } else {
-      history.update('playing');
+      updateState = 'ended';
+    }
+    const stateChanged = history.update(updateState);
+
+    if (stateChanged) {
+      const eventName = shaka.util.FakeEvent.EventName.StateChanged;
+      const data = (new Map()).set('newstate', updateState);
+      this.dispatchEvent(this.makeEvent_(eventName, data));
     }
   }
 
@@ -6132,8 +6196,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     const data = new Map()
         .set('oldTrack', from)
         .set('newTrack', to);
-    if (this.lcevcDil_) {
-      this.lcevcDil_.updateVariant(to);
+    if (this.lcevcDec_) {
+      this.lcevcDec_.updateVariant(to, this.getManifestType());
     }
     const event =
         this.makeEvent_(shaka.util.FakeEvent.EventName.Adaptation, data);
@@ -6163,8 +6227,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     const data = new Map()
         .set('oldTrack', from)
         .set('newTrack', to);
-    if (this.lcevcDil_) {
-      this.lcevcDil_.updateVariant(to);
+    if (this.lcevcDec_) {
+      this.lcevcDec_.updateVariant(to, this.getManifestType());
     }
 
     const event =
@@ -6445,6 +6509,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       return;
     }
 
+    const event =
+        this.makeEvent_(shaka.util.FakeEvent.EventName.KeyStatusChanged);
+    this.dispatchEvent(event);
+
     const keyIds = Object.keys(keyStatusMap);
     if (keyIds.length == 0) {
       shaka.log.warning(
@@ -7112,6 +7180,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       startTime: null,
       startTimeOfLoad: NaN,
       uri: null,
+      keepAdManager: true,
     };
   }
 
@@ -7175,7 +7244,8 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v4.4.3-uncompiled';
+// eslint-disable-next-line no-useless-concat
+shaka.Player.version = 'v4.5.0' + '-uncompiled';  // x-release-please-version
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/routing/payload.js

@@ -13,7 +13,8 @@ goog.provide('shaka.routing.Payload');
  *   mimeType: ?string,
  *   startTime: ?number,
  *   startTimeOfLoad: number,
- *   uri: ?string
+ *   uri: ?string,
+ *   keepAdManager: boolean
  * }}
  *
  * @description
@@ -39,5 +40,8 @@ goog.provide('shaka.routing.Payload');
  *
  * @property  {?string} uri
  *   The address of the content that will be loaded.
+ *
+ * @property  {boolean} keepAdManager
+ *   Indicates if the adManager shouldn't destroyed.
  */
 shaka.routing.Payload;

package/lib/text/cue.js

@@ -222,6 +222,13 @@ shaka.text.Cue = class {
      */
     this.opacity = 1;
 
+    /**
+     * Text combine upright as a CSS text-combine-upright value.
+     * @type {string}
+     * @export
+     */
+    this.textCombineUpright = '';
+
     /**
      * Text decoration. A combination of underline, overline
      * and line through. Empty array means no decoration.
@@ -292,6 +299,14 @@ shaka.text.Cue = class {
      */
     this.lineBreak = false;
 
+    /**
+     * Used to indicate the type of ruby tag that should be used when rendering
+     * the cue. Valid values: ruby, rp, rt.
+     * @type {?string}
+     * @export
+     */
+    this.rubyTag = null;
+
     /**
      * The number of horizontal and vertical cells into which the Root Container
      * Region area is divided.

package/lib/text/ttml_text_parser.js

@@ -724,6 +724,23 @@ shaka.text.TtmlTextParser = class {
     if (textDecorationElement) {
       TtmlTextParser.addTextDecoration_(cue, textDecorationElement);
     }
+
+    const textCombine = TtmlTextParser.getStyleAttribute_(
+        cueElement, region, styles, 'textCombine', shouldInheritRegionStyles);
+    if (textCombine) {
+      cue.textCombineUpright = textCombine;
+    }
+
+    const ruby = TtmlTextParser.getStyleAttribute_(
+        cueElement, region, styles, 'ruby', shouldInheritRegionStyles);
+    switch (ruby) {
+      case 'container':
+        cue.rubyTag = 'ruby';
+        break;
+      case 'text':
+        cue.rubyTag = 'rt';
+        break;
+    }
   }
 
   /**

package/lib/text/ui_text_displayer.js

@@ -452,6 +452,9 @@ shaka.text.UITextDisplayer = class {
     if (cue.lineBreak) {
       type = 'br';
     }
+    if (cue.rubyTag) {
+      type = cue.rubyTag;
+    }
 
     const needWrapper = !isNested && cue.nestedCues.length > 0;
 
@@ -561,6 +564,7 @@ shaka.text.UITextDisplayer = class {
     style.paddingRight =
         shaka.text.UITextDisplayer.convertLengthValue_(
             cue.linePadding, cue, this.videoContainer_);
+    style.textCombineUpright = cue.textCombineUpright;
     style.textShadow = cue.textShadow;
 
     if (cue.backgroundImage) {