shaka-player 3.3.0 → 3.3.3

package/lib/player.js

@@ -787,6 +787,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       await this.networkingEngine_.destroy();
       this.networkingEngine_ = null;
     }
+
+    // FakeEventTarget implements IReleasable
+    super.release();
   }
 
   /**
@@ -1691,17 +1694,26 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     // initialize it now even through it appears a little out-of-place.
     this.regionTimeline_ =
         new shaka.media.RegionTimeline(() => this.seekRange());
-    this.regionTimeline_.setListeners(/* onRegionAdded= */ (region) => {
+    this.regionTimeline_.addEventListener('regionadd', (event) => {
+      /** @type {shaka.extern.TimelineRegionInfo} */
+      const region = event['region'];
       this.onRegionEvent_(shaka.Player.EventName.TimelineRegionAdded, region);
+
       if (this.adManager_) {
         this.adManager_.onDashTimedMetadata(region);
       }
     });
+
     this.qualityObserver_ = null;
     if (this.config_.streaming.observeQualityChanges) {
       this.qualityObserver_ = new shaka.media.QualityObserver(
           () => this.getBufferedInfo());
-      this.qualityObserver_.setListeners((mediaQualityInfo, position) => {
+
+      this.qualityObserver_.addEventListener('qualitychange', (event) => {
+        /** @type {shaka.extern.MediaQualityInfo} */
+        const mediaQualityInfo = event['quality'];
+        /** @type {number} */
+        const position = event['position'];
         this.onMediaQualityChange_(mediaQualityInfo, position);
       });
     }
@@ -2205,6 +2217,14 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
 
     this.playhead_ = new shaka.media.SrcEqualsPlayhead(has.mediaElement);
 
+    // This flag is used below in the language preference setup and
+    // track-management to check if this load was canceled before the necessary
+    // events fired.
+    let unloaded = false;
+    this.cleanupOnUnload_.push(() => {
+      unloaded = true;
+    });
+
     if (has.startTime != null) {
       this.playhead_.setStartTime(has.startTime);
     }
@@ -2232,7 +2252,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
 
     // Wait for the 'loadedmetadata' event to measure load() latency, but only
     // if preload is set in a way that would result in this event firing
-    // automatically.  See https://github.com/google/shaka-player/issues/2483
+    // automatically.
+    // See https://github.com/shaka-project/shaka-player/issues/2483
     if (this.video_.preload != 'none') {
       this.eventManager_.listenOnce(this.video_, 'loadedmetadata', () => {
         const now = Date.now() / 1000;
@@ -2255,6 +2276,12 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     }
     if (this.video_.textTracks) {
       this.eventManager_.listen(this.video_.textTracks, 'addtrack', (e) => {
+        // If we have moved on to another piece of content while waiting for
+        // the above event, we should not process tracks here.
+        if (unloaded) {
+          return;
+        }
+
         const trackEvent = /** @type {!TrackEvent} */(e);
         if (trackEvent.track) {
           const track = trackEvent.track;
@@ -2314,13 +2341,6 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           fullyLoaded.resolve();
         });
 
-    // This flag is used below in the language preference setup to check if this
-    // load was canceled before the necessary events fire.
-    let unloaded = false;
-    this.cleanupOnUnload_.push(() => {
-      unloaded = true;
-    });
-
     // We can't switch to preferred languages, though, until the data is loaded.
     shaka.util.MediaReadyState.waitForReadyState(this.video_,
         HTMLMediaElement.HAVE_CURRENT_DATA,
@@ -2475,12 +2495,16 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     // In Safari the initial assignment does not always work, so we schedule
     // this process to be repeated several times to ensure that it has been put
     // in the correct mode.
-    new shaka.util.Timer(() => {
+    const timer = new shaka.util.Timer(() => {
       const textTracks = this.getMetadataTracks_();
       for (const textTrack of textTracks) {
         textTrack.mode = 'hidden';
       }
-    }).tickNow().tickAfter(/* seconds= */ 0.5);
+    }).tickNow().tickAfter(0.5);
+
+    this.cleanupOnUnload_.push(() => {
+      timer.stop();
+    });
   }
 
 
@@ -2548,12 +2572,16 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     // In Safari the initial assignment does not always work, so we schedule
     // this process to be repeated several times to ensure that it has been put
     // in the correct mode.
-    new shaka.util.Timer(() => {
+    const timer = new shaka.util.Timer(() => {
       const chaptersTracks = this.getChaptersTracks_();
       for (const chaptersTrack of chaptersTracks) {
         chaptersTrack.mode = 'hidden';
       }
-    }).tickNow().tickAfter(/* seconds= */ 0.5);
+    }).tickNow().tickAfter(0.5);
+
+    this.cleanupOnUnload_.push(() => {
+      timer.stop();
+    });
   }
 
   /**
@@ -2674,21 +2702,31 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     // Create the region observer. This will allow us to notify the app when we
     // move in and out of timeline regions.
     const regionObserver = new shaka.media.RegionObserver(this.regionTimeline_);
-    const onEnterRegion = (region, seeking) => {
+
+    regionObserver.addEventListener('enter', (event) => {
+      /** @type {shaka.extern.TimelineRegionInfo} */
+      const region = event['region'];
       this.onRegionEvent_(shaka.Player.EventName.TimelineRegionEnter, region);
-    };
-    const onExitRegion = (region, seeking) => {
+    });
+
+    regionObserver.addEventListener('exit', (event) => {
+      /** @type {shaka.extern.TimelineRegionInfo} */
+      const region = event['region'];
       this.onRegionEvent_(shaka.Player.EventName.TimelineRegionExit, region);
-    };
-    const onSkipRegion = (region, seeking) => {
+    });
+
+    regionObserver.addEventListener('skip', (event) => {
+      /** @type {shaka.extern.TimelineRegionInfo} */
+      const region = event['region'];
+      /** @type {boolean} */
+      const seeking = event['seeking'];
       // If we are seeking, we don't want to surface the enter/exit events since
       // they didn't play through them.
       if (!seeking) {
         this.onRegionEvent_(shaka.Player.EventName.TimelineRegionEnter, region);
         this.onRegionEvent_(shaka.Player.EventName.TimelineRegionExit, region);
       }
-    };
-    regionObserver.setListeners(onEnterRegion, onExitRegion, onSkipRegion);
+    });
 
     // Now that we have all our observers, create a manager for them.
     const manager = new shaka.media.PlayheadObserverManager(this.video_);
@@ -2817,14 +2855,13 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @private
    */
   createCmcd_() {
-    const abr = this.abrManager_;
-
     /** @type {shaka.util.CmcdManager.PlayerInterface} */
     const playerInterface = {
-      getBandwidthEstimate: () => abr ? abr.getBandwidthEstimate() : NaN,
+      getBandwidthEstimate: () => this.abrManager_ ?
+        this.abrManager_.getBandwidthEstimate() : NaN,
       getBufferedInfo: () => this.getBufferedInfo(),
       getCurrentTime: () => this.video_ ? this.video_.currentTime : 0,
-      getManifest: () => this.manifest_,
+      getVariantTracks: () => this.getVariantTracks(),
       getPlaybackRate: () => this.getPlaybackRate(),
       isLive: () => this.isLive(),
     };
@@ -3613,7 +3650,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       const height = fullImageHeight / rows;
       const totalImages = columns * rows;
       const segmentDuration = reference.trueEndTime - reference.startTime;
-      const thumbnailDuration = segmentDuration / totalImages;
+      const thumbnailDuration =
+          reference.getTileDuration() || (segmentDuration / totalImages);
       let thumbnailTime = reference.startTime;
       let positionX = 0;
       let positionY = 0;
@@ -3636,6 +3674,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         positionY = Math.floor(thumbnailPosition / columns) * height;
       }
       return {
+        imageHeight: fullImageHeight,
+        imageWidth: fullImageWidth,
         height: height,
         positionX: positionX,
         positionY: positionY,
@@ -3680,7 +3720,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       this.streamingEngine_.switchTextStream(stream);
       this.onTextChanged_();
 
-      // Workaround for https://github.com/google/shaka-player/issues/1299
+      // Workaround for
+      // https://github.com/shaka-project/shaka-player/issues/1299
       // When track is selected, back-propagate the language to
       // currentTextLanguage_.
       this.currentTextLanguage_ = stream.language;
@@ -3756,7 +3797,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       this.switchVariant_(variant, /* fromAdaptation= */ false, clearBuffer,
           safeMargin);
 
-      // Workaround for https://github.com/google/shaka-player/issues/1299
+      // Workaround for
+      // https://github.com/shaka-project/shaka-player/issues/1299
       // When track is selected, back-propagate the language to
       // currentAudioLanguage_.
       this.currentAdaptationSetCriteria_ = new shaka.media.ExampleBasedCriteria(
@@ -4037,20 +4079,24 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     const LanguageUtils = shaka.util.LanguageUtils;
     const inputlanguage = LanguageUtils.normalize(language);
     const chaptersTracks = this.getChaptersTracks_();
-    const chaptersTrack = chaptersTracks
-        .find((t) => LanguageUtils.normalize(t.language) == inputlanguage);
-    if (!chaptersTrack || !chaptersTrack.cues) {
+    const chaptersTracksWithLanguage = chaptersTracks
+        .filter((t) => LanguageUtils.normalize(t.language) == inputlanguage);
+    if (!chaptersTracksWithLanguage || !chaptersTracksWithLanguage.length) {
       return [];
     }
     const chapters = [];
-    for (const cue of chaptersTrack.cues) {
-      /** @type {shaka.extern.Chapter} */
-      const chapter = {
-        title: cue.text,
-        startTime: cue.startTime,
-        endTime: cue.endTime,
-      };
-      chapters.push(chapter);
+    for (const chaptersTrack of chaptersTracksWithLanguage) {
+      if (chaptersTrack && chaptersTrack.cues) {
+        for (const cue of chaptersTrack.cues) {
+          /** @type {shaka.extern.Chapter} */
+          const chapter = {
+            title: cue.text,
+            startTime: cue.startTime,
+            endTime: cue.endTime,
+          };
+          chapters.push(chapter);
+        }
+      }
     }
     return chapters;
   }
@@ -5224,7 +5270,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     // If the playback rate changes while seeking, Edge will cache the playback
     // rate and use it after seeking.
     //
-    // https://github.com/google/shaka-player/issues/951
+    // https://github.com/shaka-project/shaka-player/issues/951
     if (newRate == 0) {
       return;
     }
@@ -6530,7 +6576,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v3.3.0-uncompiled';
+shaka.Player.version = 'v3.3.3-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/polyfill/all.js

@@ -7,7 +7,6 @@
 goog.provide('shaka.polyfill');
 
 goog.require('shaka.log');
-goog.require('shaka.util.Iterables');
 
 
 /**
@@ -40,8 +39,8 @@ shaka.polyfill = class {
    */
   static register(polyfill, priority) {
     const newItem = {priority: priority || 0, callback: polyfill};
-    const enumerate = (it) => shaka.util.Iterables.enumerate(it);
-    for (const {i, item} of enumerate(shaka.polyfill.polyfills_)) {
+    for (let i = 0; i < shaka.polyfill.polyfills_.length; i++) {
+      const item = shaka.polyfill.polyfills_[i];
       if (item.priority < newItem.priority) {
         shaka.polyfill.polyfills_.splice(i, 0, newItem);
         return;

package/lib/polyfill/encryption_scheme.js

@@ -12,7 +12,7 @@ goog.require('shaka.polyfill');
  * @summary A polyfill to add support for EncryptionScheme queries in EME.
  * @see https://wicg.github.io/encrypted-media-encryption-scheme/
  * @see https://github.com/w3c/encrypted-media/pull/457
- * @see https://github.com/google/eme-encryption-scheme-polyfill
+ * @see https://github.com/shaka-project/eme-encryption-scheme-polyfill
  * @export
  */
 shaka.polyfill.EncryptionScheme = class {

package/lib/polyfill/media_capabilities.js

@@ -24,37 +24,42 @@ shaka.polyfill.MediaCapabilities = class {
    * @export
    */
   static install() {
-    shaka.log.debug('MediaCapabilities: install');
-
     // Since MediaCapabilities is not fully supported on Chromecast yet, we
     // should always install polyfill for Chromecast.
     // TODO: re-evaluate MediaCapabilities in the future versions of Chromecast.
     // Since MediaCapabilities implementation is buggy in Apple browsers, we
     // should always install polyfill for Apple browsers.
-    // See: https://github.com/google/shaka-player/issues/3530
+    // See: https://github.com/shaka-project/shaka-player/issues/3530
     // TODO: re-evaluate MediaCapabilities in the future versions of Apple
     // Browsers.
     // Since MediaCapabilities implementation is buggy in PS5 browsers, we
     // should always install polyfill for PS5 browsers.
-    // See: https://github.com/google/shaka-player/issues/3582
+    // See: https://github.com/shaka-project/shaka-player/issues/3582
     // TODO: re-evaluate MediaCapabilities in the future versions of PS5
     // Browsers.
     if (!shaka.util.Platform.isChromecast() &&
-      !shaka.util.Platform.isApple() &&
-      !shaka.util.Platform.isPS5() &&
-      navigator.mediaCapabilities) {
-      shaka.log.debug(
+        !shaka.util.Platform.isApple() &&
+        !shaka.util.Platform.isPS5() &&
+        navigator.mediaCapabilities) {
+      shaka.log.info(
           'MediaCapabilities: Native mediaCapabilities support found.');
-    } else {
-      if (!navigator.mediaCapabilities) {
-        navigator.mediaCapabilities = /** @type {!MediaCapabilities} */ ({});
-      }
-      navigator.mediaCapabilities.decodingInfo =
-          shaka.polyfill.MediaCapabilities.decodingInfo_;
+      return;
+    }
+
+    shaka.log.info('MediaCapabilities: install');
+
+    if (!navigator.mediaCapabilities) {
+      navigator.mediaCapabilities = /** @type {!MediaCapabilities} */ ({});
     }
-    // Workaround because in Apple browsers there is no way to overwrite
-    // MediaCapabilities.
-    window.shakaMediaCapabilities = navigator.mediaCapabilities;
+
+    // Keep the patched MediaCapabilities object from being garbage-collected in
+    // Safari.
+    // See https://github.com/shaka-project/shaka-player/issues/3696#issuecomment-1009472718
+    shaka.polyfill.MediaCapabilities.originalMcap =
+        navigator.mediaCapabilities;
+
+    navigator.mediaCapabilities.decodingInfo =
+        shaka.polyfill.MediaCapabilities.decodingInfo_;
   }
 
   /**
@@ -182,6 +187,16 @@ shaka.polyfill.MediaCapabilities = class {
   }
 };
 
+/**
+ * A copy of the MediaCapabilities instance, to prevent Safari from
+ * garbage-collecting the polyfilled method on it.  We make it public and export
+ * it to ensure that it is not stripped out by the compiler.
+ *
+ * @type {MediaCapabilities}
+ * @export
+ */
+shaka.polyfill.MediaCapabilities.originalMcap = null;
+
 // Install at a lower priority than MediaSource polyfill, so that we have
 // MediaSource available first.
 shaka.polyfill.register(shaka.polyfill.MediaCapabilities.install, -1);

package/lib/polyfill/mediasource.js

@@ -39,7 +39,7 @@ shaka.polyfill.MediaSource = class {
       shaka.polyfill.MediaSource.patchCastIsTypeSupported_();
     } else if (safariVersion) {
       // TS content is broken on Safari in general.
-      // See https://github.com/google/shaka-player/issues/743
+      // See https://github.com/shaka-project/shaka-player/issues/743
       // and https://bugs.webkit.org/show_bug.cgi?id=165342
       shaka.polyfill.MediaSource.rejectTsContent_();
 

package/lib/polyfill/symbol.js

@@ -0,0 +1,46 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+goog.provide('shaka.polyfill.Symbol');
+
+goog.require('shaka.log');
+goog.require('shaka.polyfill');
+
+/**
+ * @summary A polyfill to provide Symbol.prototype.description in all browsers.
+ * See: https://caniuse.com/mdn-javascript_builtins_symbol_description
+ * @export
+ */
+shaka.polyfill.Symbol = class {
+  /**
+   * Install the polyfill if needed.
+   * @export
+   */
+  static install() {
+    shaka.log.debug('Symbol.install');
+
+    // eslint-disable-next-line no-restricted-syntax
+    const proto = Symbol.prototype;
+
+    if (!('description' in proto)) {
+      Object.defineProperty(proto, 'description', {
+        get: shaka.polyfill.Symbol.getSymbolDescription_,
+      });
+    }
+  }
+
+  /**
+   * @this {Symbol}
+   * @return {(string|undefined)}
+   * @private
+   */
+  static getSymbolDescription_() {
+    const m = /\((.*)\)/.exec(this.toString());
+    return m ? m[1] : undefined;
+  }
+};
+
+
+shaka.polyfill.register(shaka.polyfill.Symbol.install);

package/lib/text/cue.js

@@ -222,6 +222,12 @@ shaka.text.Cue = class {
      */
     this.nestedCues = [];
 
+    /**
+     * @override
+     * @exportInterface
+     */
+    this.isContainer = false;
+
     /**
      * @override
      * @exportInterface
@@ -288,7 +294,7 @@ shaka.text.Cue = class {
     // Compare the start time, end time and payload of the cues first for
     // performance optimization.  We can avoid the more expensive recursive
     // checks if the top-level properties don't match.
-    // See: https://github.com/google/shaka-player/issues/3018
+    // See: https://github.com/shaka-project/shaka-player/issues/3018
     if (cue1.startTime != cue2.startTime || cue1.endTime != cue2.endTime ||
       cue1.payload != cue2.payload) {
       return false;

package/lib/text/simple_text_displayer.js

@@ -178,7 +178,8 @@ shaka.text.SimpleTextDisplayer = class {
         // The browser will display cues with identical time ranges from the
         // bottom up.  Reversing the order of equal cues means the first one
         // parsed will be at the top, as you would expect.
-        // See https://github.com/google/shaka-player/issues/848 for more info.
+        // See https://github.com/shaka-project/shaka-player/issues/848 for
+        // more info.
         // However, this ordering behavior is part of VTTCue's "line" field.
         // Some platforms don't have a real VTTCue and use a polyfill instead.
         // When VTTCue is polyfilled or does not support "line", we should _not_