shaka-player 4.2.2 → 4.2.4

package/docs/tutorials/welcome.md

@@ -66,8 +66,8 @@ python build/all.py
 
 Alternatively you can use a docker container:
 ```sh
-cd build/docker
-docker-compose run --rm shaka-compiler
+docker build -t shaka-player-build build/docker
+docker run -v $(pwd):/usr/src --user $(id -u):$(id -g) shaka-player-build
 ```
 
 The output is:

package/externs/mux.js

@@ -74,6 +74,9 @@ muxjs.mp4.Transmuxer = class {
 
   /** Remove all handlers and clean up. */
   dispose() {}
+
+  /** Reset captions. */
+  resetCaptions() {}
 };
 
 

package/lib/ads/client_side_ad_manager.js

@@ -15,7 +15,6 @@ goog.require('goog.asserts');
 goog.require('shaka.ads.ClientSideAd');
 goog.require('shaka.util.IReleasable');
 
-
 /**
  * A class responsible for client-side ad interactions.
  * @implements {shaka.util.IReleasable}
@@ -218,7 +217,11 @@ shaka.ads.ClientSideAdManager = class {
       // TODO (ismena): Need a better inderstanding 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.
-      this.imaAdsManager_.start();
+      // Note: We listen for a play event to avoid autoplay issues that might
+      // crash IMA.
+      this.video_.addEventListener('play', () => {
+        this.imaAdsManager_.start();
+      }, {once: true});
     } 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/cast/cast_proxy.js

@@ -705,7 +705,8 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
     // If we are casting, but the first update has not come in yet, use local
     // getters, but not local methods.
     if (this.sender_.isCasting() && !this.sender_.hasRemoteProperties()) {
-      if (shaka.cast.CastUtils.PlayerGetterMethods[name]) {
+      if (shaka.cast.CastUtils.PlayerGetterMethods[name] ||
+          shaka.cast.CastUtils.LargePlayerGetterMethods[name]) {
         const value = /** @type {Object} */(this.localPlayer_)[name];
         goog.asserts.assert(typeof value == 'function',
             'only methods on Player');

package/lib/cast/cast_receiver.js

@@ -518,6 +518,25 @@ shaka.cast.CastReceiver = class extends shaka.util.FakeEventTarget {
       update['video']['muted'] = systemVolume.muted;
     }
 
+    this.sendMessage_({
+      'type': 'update',
+      'update': update,
+    }, this.shakaBus_);
+
+    // Getters with large outputs each get sent in their own update message.
+    for (const name in shaka.cast.CastUtils.LargePlayerGetterMethods) {
+      const frequency = shaka.cast.CastUtils.LargePlayerGetterMethods[name];
+      if (this.updateNumber_ % frequency == 0) {
+        const update = {'player': {}};
+        update['player'][name] = /** @type {Object} */ (this.player_)[name]();
+
+        this.sendMessage_({
+          'type': 'update',
+          'update': update,
+        }, this.shakaBus_);
+      }
+    }
+
     // Only start progressing the update number once data is loaded,
     // just in case any of the "rarely changing" properties with less frequent
     // update messages changes significantly during the loading process.
@@ -525,11 +544,6 @@ shaka.cast.CastReceiver = class extends shaka.util.FakeEventTarget {
       this.updateNumber_ += 1;
     }
 
-    this.sendMessage_({
-      'type': 'update',
-      'update': update,
-    }, this.shakaBus_);
-
     this.maybeSendMediaInfoMessage_();
   }
 

package/lib/cast/cast_sender.js

@@ -370,7 +370,8 @@ shaka.cast.CastSender = class {
         return (...args) =>
           this.remoteAsyncCall_(targetName, property, ...args);
       }
-      if (CastUtils.PlayerGetterMethods[property]) {
+      if (CastUtils.PlayerGetterMethods[property] ||
+          CastUtils.LargePlayerGetterMethods[property]) {
         return () => this.propertyGetter_(targetName, property);
       }
     }

package/lib/cast/cast_utils.js

@@ -307,9 +307,6 @@ shaka.cast.CastUtils.PlayerGetterMethods = {
   'getAudioLanguagesAndRoles': 4,
   'getBufferFullness': 1,
   'getBufferedInfo': 2,
-  // NOTE: The 'getSharedConfiguration' property is not proxied as it would
-  //       not be possible to share a reference.
-  'getConfiguration': 4,
   'getExpiration': 2,
   'getKeyStatuses': 2,
   // NOTE: The 'getManifest' property is not proxied, as it is very large.
@@ -318,9 +315,6 @@ shaka.cast.CastUtils.PlayerGetterMethods = {
   'getPlaybackRate': 2,
   'getTextLanguages': 4,
   'getTextLanguagesAndRoles': 4,
-  'getTextTracks': 2,
-  'getStats': 5,
-  'getVariantTracks': 2,
   'getImageTracks': 2,
   'getThumbnails': 2,
   'isAudioOnly': 10,
@@ -334,6 +328,22 @@ shaka.cast.CastUtils.PlayerGetterMethods = {
 };
 
 
+/**
+ * Player getter methods with data large enough to be sent in their own update
+ * messages, to reduce the size of each message.  The format of this is
+ * identical to PlayerGetterMethods.
+ * @const {!Object.<string, number>}
+ */
+shaka.cast.CastUtils.LargePlayerGetterMethods = {
+  // NOTE: The 'getSharedConfiguration' property is not proxied as it would
+  //       not be possible to share a reference.
+  'getConfiguration': 4,
+  'getStats': 5,
+  'getTextTracks': 2,
+  'getVariantTracks': 2,
+};
+
+
 /**
  * Player getter methods that are proxied while casting, but only when casting
  * a livestream.

package/lib/hls/hls_parser.js

@@ -831,13 +831,19 @@ shaka.hls.HlsParser = class {
         shaka.util.ArrayUtils.remove(allCodecs, textCodecs);
       }
       if (audioGroupId) {
-        const codecs = shaka.util.ManifestParserUtils.guessCodecs(
+        let codecs = shaka.util.ManifestParserUtils.guessCodecsSafe(
             ContentType.AUDIO, allCodecs);
+        if (!codecs) {
+          codecs = this.config_.hls.defaultAudioCodec;
+        }
         this.groupIdToCodecsMap_.set(audioGroupId, codecs);
       }
       if (videoGroupId) {
-        const codecs = shaka.util.ManifestParserUtils.guessCodecs(
+        let codecs = shaka.util.ManifestParserUtils.guessCodecsSafe(
             ContentType.VIDEO, allCodecs);
+        if (!codecs) {
+          codecs = this.config_.hls.defaultVideoCodec;
+        }
         this.groupIdToCodecsMap_.set(videoGroupId, codecs);
       }
     }
@@ -2442,7 +2448,12 @@ shaka.hls.HlsParser = class {
     const extension = parsedUri.getPath().split('.').pop();
     const map = HlsParser.EXTENSION_MAP_BY_CONTENT_TYPE_[contentType];
 
-    const mimeType = map[extension];
+    let mimeType = map[extension];
+    if (mimeType) {
+      return mimeType;
+    }
+
+    mimeType = HlsParser.RAW_FORMATS_TO_MIME_TYPES_[extension];
     if (mimeType) {
       return mimeType;
     }
@@ -2811,6 +2822,18 @@ shaka.hls.HlsParser.StreamInfo;
 shaka.hls.HlsParser.StreamInfos;
 
 
+/**
+ * @const {!Object.<string, string>}
+ * @private
+ */
+shaka.hls.HlsParser.RAW_FORMATS_TO_MIME_TYPES_ = {
+  'aac': 'audio/aac',
+  'ac3': 'audio/ac3',
+  'ec3': 'audio/ec3',
+  'mp3': 'audio/mpeg',
+};
+
+
 /**
  * @const {!Object.<string, string>}
  * @private
@@ -2825,12 +2848,6 @@ shaka.hls.HlsParser.AUDIO_EXTENSIONS_TO_MIME_TYPES_ = {
   'cmfa': 'audio/mp4',
   // MPEG2-TS also uses video/ for audio: https://bit.ly/TsMse
   'ts': 'video/mp2t',
-
-  // Raw formats:
-  'aac': 'audio/aac',
-  'ac3': 'audio/ac3',
-  'ec3': 'audio/ec3',
-  'mp3': 'audio/mpeg',
 };
 
 
@@ -2861,6 +2878,7 @@ shaka.hls.HlsParser.TEXT_EXTENSIONS_TO_MIME_TYPES_ = {
   'm4f': 'application/mp4',
   'cmft': 'application/mp4',
   'vtt': 'text/vtt',
+  'webvtt': 'txt/vtt',
   'ttml': 'application/ttml+xml',
 };
 

package/lib/media/drm_engine.js

@@ -28,6 +28,7 @@ goog.require('shaka.util.StreamUtils');
 goog.require('shaka.util.StringUtils');
 goog.require('shaka.util.Timer');
 goog.require('shaka.util.Uint8ArrayUtils');
+goog.require('shaka.util.XmlUtils');
 
 
 /** @implements {shaka.util.IDestroyable} */
@@ -406,6 +407,7 @@ shaka.media.DrmEngine = class {
     if (this.mediaKeysAttached_) {
       await this.mediaKeysAttached_;
 
+      this.destroyer_.ensureNotDestroyed();
       return;
     }
 
@@ -483,14 +485,12 @@ shaka.media.DrmEngine = class {
 
     /**
      * We can attach media keys before the playback actually begins when:
-     *  - Using legacy implementations requires MediaKeys to be set before
-     *    having webkitneedkey / msneedkey event, which will be translated as
-     *    an encrypted event by the polyfills
+     *  - If we are not using FairPlay Modern EME
      *  - Some initData already has been generated (through the manifest)
      *  - In case of an offline session
      */
     if (manifestInitData ||
-        shaka.util.Platform.isMediaKeysPolyfilled() ||
+        this.currentDrmInfo_.keySystem !== 'com.apple.fps' ||
         this.offlineSessionIds_.length) {
       await this.attachMediaKeys_();
     }
@@ -1506,7 +1506,8 @@ shaka.media.DrmEngine = class {
       return;
     }
     shaka.log.debug('Unwrapping PlayReady request.');
-    const dom = new DOMParser().parseFromString(xml, 'application/xml');
+    const dom = shaka.util.XmlUtils.parseXmlString(xml, 'PlayReadyKeyMessage');
+    goog.asserts.assert(dom, 'Failed to parse PlayReady XML!');
 
     // Set request headers.
     const headers = dom.getElementsByTagName('HttpHeader');
@@ -1590,7 +1591,7 @@ shaka.media.DrmEngine = class {
         hasExpiredKeys = true;
       }
 
-      const keyIdHex = shaka.util.Uint8ArrayUtils.toHex(keyId);
+      const keyIdHex = shaka.util.Uint8ArrayUtils.toHex(keyId).slice(0, 32);
 
       this.keyStatusByKeyId_.set(keyIdHex, status);
     });

package/lib/media/media_source_engine.js

@@ -545,6 +545,12 @@ shaka.media.MediaSourceEngine = class {
     }
 
     if (this.transmuxers_[contentType]) {
+      // When seeked we should reset the transmuxer captionstreams
+      // so it does not ignores the captions from previous segments
+      if (seeked) {
+        this.transmuxers_[contentType].resetCaptions();
+      }
+
       const transmuxedData =
           await this.transmuxers_[contentType].transmux(data);
       // For HLS CEA-608/708 CLOSED-CAPTIONS, text data is embedded in

package/lib/media/playhead.js

@@ -33,6 +33,14 @@ goog.requireType('shaka.media.PresentationTimeline');
  * @interface
  */
 shaka.media.Playhead = class {
+  /**
+   * Called when the Player is ready to begin playback. Anything that depends
+   * on setStartTime() should be done here, not in the constructor.
+   *
+   * @see https://github.com/shaka-project/shaka-player/issues/4244
+   */
+  ready() {}
+
   /**
    * Set the start time. If the content has already started playback, this will
    * be ignored.
@@ -90,6 +98,14 @@ shaka.media.SrcEqualsPlayhead = class {
 
     /** @private {shaka.util.EventManager} */
     this.eventManager_ = new shaka.util.EventManager();
+  }
+
+  /** @override */
+  ready() {
+    goog.asserts.assert(
+        this.mediaElement_ != null,
+        'Playhead should not be released before calling ready()',
+    );
 
     // We listen for the loaded-data-event so that we know when we can
     // interact with |currentTime|.
@@ -102,6 +118,7 @@ shaka.media.SrcEqualsPlayhead = class {
         this.eventManager_.listenOnce(this.mediaElement_, 'seeking', () => {
           this.started_ = true;
         });
+
         const currentTime = this.mediaElement_.currentTime;
         // Using the currentTime allows using a negative number in Live HLS
         const newTime = Math.max(0, currentTime + this.startTime_);
@@ -239,7 +256,12 @@ shaka.media.MediaSourcePlayhead = class {
     /** @type {shaka.util.Timer} */
     this.checkWindowTimer_ = new shaka.util.Timer(() => {
       this.onPollWindow_();
-    }).tickEvery(/* seconds= */ 0.25);
+    });
+  }
+
+  /** @override */
+  ready() {
+    this.checkWindowTimer_.tickEvery(/* seconds= */ 0.25);
   }
 
   /** @override */
@@ -294,7 +316,7 @@ shaka.media.MediaSourcePlayhead = class {
 
   /** @override */
   getStallsDetected() {
-    return this.stallDetector_.getStallsDetected();
+    return this.stallDetector_ ? this.stallDetector_.getStallsDetected() : 0;
   }
 
   /** @override */

package/lib/media/streaming_engine.js

@@ -1403,16 +1403,6 @@ shaka.media.StreamingEngine = class {
         this.mediaStates_.delete(ContentType.TEXT);
       } else if (error.code == shaka.util.Error.Code.QUOTA_EXCEEDED_ERROR) {
         this.handleQuotaExceeded_(mediaState, error);
-      } else if (error.code == shaka.util.Error.Code.BAD_HTTP_STATUS &&
-          error.data && error.data[1] == 404) {
-        // The segment could not be found, does not exist, or is not available.
-        // In any case just try again.
-        // The current segment is not available. Schedule another update to
-        // fetch the segment again.
-        shaka.log.v2(logPrefix, 'segment not available.');
-        mediaState.performingUpdate = false;
-        mediaState.updateTimer = null;
-        this.scheduleUpdate_(mediaState, 1);
       } else {
         shaka.log.error(logPrefix, 'failed fetch and append: code=' +
             error.code);
@@ -1455,9 +1445,10 @@ shaka.media.StreamingEngine = class {
 
   /**
    * Clear per-stream error states and retry any failed streams.
+   * @param {number} delaySeconds
    * @return {boolean} False if unable to retry.
    */
-  retry() {
+  retry(delaySeconds) {
     if (this.destroyer_.destroyed()) {
       shaka.log.error('Unable to retry after StreamingEngine is destroyed!');
       return false;
@@ -1474,7 +1465,7 @@ shaka.media.StreamingEngine = class {
       if (mediaState.hasError) {
         shaka.log.info(logPrefix, 'Retrying after failure...');
         mediaState.hasError = false;
-        this.scheduleUpdate_(mediaState, 0.1);
+        this.scheduleUpdate_(mediaState, delaySeconds);
       }
     }
 

package/lib/media/transmuxer.js

@@ -182,6 +182,12 @@ shaka.media.Transmuxer = class {
     return this.transmuxPromise_;
   }
 
+  /**
+   * Reset captions from Transport stream to MP4, using the mux.js library.
+  */
+  resetCaptions() {
+    this.muxTransmuxer_.resetCaptions();
+  }
 
   /**
    * Handles the 'data' event of the transmuxer.

package/lib/offline/indexeddb/storage_mechanism.js

@@ -16,6 +16,7 @@ goog.require('shaka.offline.indexeddb.V5StorageCell');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.PublicPromise');
 goog.require('shaka.util.Platform');
+goog.require('shaka.util.Timer');
 
 
 /**
@@ -55,8 +56,25 @@ shaka.offline.indexeddb.StorageMechanism = class {
     const version = shaka.offline.indexeddb.StorageMechanism.VERSION;
 
     const p = new shaka.util.PublicPromise();
+
+    // Add a timeout mechanism, for the (rare?) case where no callbacks are
+    // called at all, so that this method doesn't hang forever.
+    let timedOut = false;
+    const timeOutTimer = new shaka.util.Timer(() => {
+      timedOut = true;
+      p.reject(new shaka.util.Error(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Category.STORAGE,
+          shaka.util.Error.Code.INDEXED_DB_INIT_TIMED_OUT));
+    });
+    timeOutTimer.tickAfter(2);
+
     const open = window.indexedDB.open(name, version);
     open.onsuccess = (event) => {
+      if (timedOut) {
+        // Too late, we have already given up on opening the storage mechanism.
+        return;
+      }
       const db = open.result;
       this.db_ = db;
       this.v1_ = shaka.offline.indexeddb.StorageMechanism.createV1_(db);
@@ -68,6 +86,7 @@ shaka.offline.indexeddb.StorageMechanism = class {
       this.v5_ = shaka.offline.indexeddb.StorageMechanism.createV5_(db);
       this.sessions_ =
           shaka.offline.indexeddb.StorageMechanism.createEmeSessionCell_(db);
+      timeOutTimer.stop();
       p.resolve();
     };
     open.onupgradeneeded = (event) => {
@@ -75,11 +94,16 @@ shaka.offline.indexeddb.StorageMechanism = class {
       this.createStores_(open.result);
     };
     open.onerror = (event) => {
+      if (timedOut) {
+        // Too late, we have already given up on opening the storage mechanism.
+        return;
+      }
       p.reject(new shaka.util.Error(
           shaka.util.Error.Severity.CRITICAL,
           shaka.util.Error.Category.STORAGE,
           shaka.util.Error.Code.INDEXED_DB_ERROR,
           open.error));
+      timeOutTimer.stop();
 
       // Firefox will raise an error on the main thread unless we stop it here.
       event.preventDefault();

package/lib/player.js

@@ -2062,6 +2062,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           shaka.util.StreamUtils.variantToTrack(initialVariant));
     }
 
+    this.playhead_.ready();
+
     // Decide if text should be shown automatically.
     // similar to video/audio track, we would skip switch initial text track
     // if user already pick text track (via selectTextTrack api)
@@ -2399,6 +2401,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         HTMLMediaElement.HAVE_METADATA,
         this.loadEventManager_,
         () => {
+          this.playhead_.ready();
           fullyLoaded.resolve();
         });
 
@@ -4841,12 +4844,13 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * If the player has loaded content, and streaming seen an error, but the
    * could not resume streaming, this will return <code>false</code>.
    *
+   * @param {number=} retryDelaySeconds
    * @return {boolean}
    * @export
    */
-  retryStreaming() {
+  retryStreaming(retryDelaySeconds = 0.1) {
     return this.loadMode_ == shaka.Player.LoadMode.MEDIA_SOURCE ?
-           this.streamingEngine_.retry() :
+           this.streamingEngine_.retry(retryDelaySeconds) :
            false;
   }
 
@@ -4942,17 +4946,26 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @private
    */
   defaultStreamingFailureCallback_(error) {
-    const retryErrorCodes = [
-      shaka.util.Error.Code.BAD_HTTP_STATUS,
-      shaka.util.Error.Code.HTTP_ERROR,
-      shaka.util.Error.Code.TIMEOUT,
-    ];
+    // For live streams, we retry streaming automatically for certain errors.
+    // For VOD streams, all streaming failures are fatal.
+    if (!this.isLive()) {
+      return;
+    }
 
-    if (this.isLive() && retryErrorCodes.includes(error.code)) {
-      error.severity = shaka.util.Error.Severity.RECOVERABLE;
+    let retryDelaySeconds = null;
+    if (error.code == shaka.util.Error.Code.BAD_HTTP_STATUS ||
+        error.code == shaka.util.Error.Code.HTTP_ERROR) {
+      // These errors can be near-instant, so delay a bit before retrying.
+      retryDelaySeconds = 1;
+    } else if (error.code == shaka.util.Error.Code.TIMEOUT) {
+      // We already waited for a timeout, so retry quickly.
+      retryDelaySeconds = 0.1;
+    }
 
+    if (retryDelaySeconds != null) {
+      error.severity = shaka.util.Error.Severity.RECOVERABLE;
       shaka.log.warning('Live streaming error.  Retrying automatically...');
-      this.retryStreaming();
+      this.retryStreaming(retryDelaySeconds);
     }
   }
 
@@ -6582,7 +6595,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v4.2.2-uncompiled';
+shaka.Player.version = 'v4.2.4-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/polyfill/media_capabilities.js

@@ -24,8 +24,9 @@ shaka.polyfill.MediaCapabilities = class {
    * @export
    */
   static install() {
-    // Since MediaCapabilities is not fully supported on some Chromecast yet,
-    // we should always install polyfill for all Chromecast not Android-based.
+    // Since MediaCapabilities implementation is buggy on the Chromecast
+    // platform (see https://github.com/shaka-project/shaka-player/issues/4569),
+    // we should always install polyfills on all Chromecast models.
     // 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.
@@ -43,18 +44,18 @@ shaka.polyfill.MediaCapabilities = class {
     // should always install polyfill for Tizen browsers.
     // Since MediaCapabilities implementation is buggy in WebOS browsers, we
     // should always install polyfill for WebOS browsers.
+    // Since MediaCapabilities implementation is buggy in EOS browsers, we
+    // should always install polyfill for EOS browsers.
     let canUseNativeMCap = true;
     if (shaka.util.Platform.isApple() ||
         shaka.util.Platform.isPS5() ||
         shaka.util.Platform.isPS4() ||
         shaka.util.Platform.isWebOS() ||
         shaka.util.Platform.isTizen() ||
-        shaka.util.Platform.isChromecast()) {
+        shaka.util.Platform.isChromecast() ||
+        shaka.util.Platform.isEOS()) {
       canUseNativeMCap = false;
     }
-    if (shaka.util.Platform.isAndroidCastDevice()) {
-      canUseNativeMCap = true;
-    }
     if (canUseNativeMCap && navigator.mediaCapabilities) {
       shaka.log.info(
           'MediaCapabilities: Native mediaCapabilities support found.');