shaka-player 3.2.14 → 3.2.15

package/lib/cast/cast_proxy.js

@@ -694,7 +694,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

@@ -360,7 +360,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

@@ -2969,6 +2969,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/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.
@@ -76,6 +84,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|.
@@ -88,6 +104,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_);
@@ -211,7 +228,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 */

package/lib/media/streaming_engine.js

@@ -1355,16 +1355,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);
@@ -1379,9 +1369,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;
@@ -1398,7 +1389,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/player.js

@@ -1933,6 +1933,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)
@@ -2263,6 +2265,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         HTMLMediaElement.HAVE_METADATA,
         this.loadEventManager_,
         () => {
+          this.playhead_.ready();
           fullyLoaded.resolve();
         });
 
@@ -4792,12 +4795,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;
   }
 
@@ -4893,17 +4897,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);
     }
   }
 
@@ -6431,7 +6444,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v3.2.14-uncompiled';
+shaka.Player.version = 'v3.2.15-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/util/manifest_parser_utils.js

@@ -168,6 +168,7 @@ shaka.util.ManifestParserUtils.VIDEO_CODEC_REGEXPS_ = [
   /^hvc/,
   /^vp0?[89]/,
   /^av01/,
+  /^dvhe/,
 ];
 
 
@@ -183,6 +184,9 @@ shaka.util.ManifestParserUtils.AUDIO_CODEC_REGEXPS_ = [
   /^flac$/,
   /^mp4a/,
   /^[ae]c-3$/,
+  /^ac-4$/,
+  /^dts[cx]$/, // DTS Surround Sound
+  /^[du]dts$/, // DTS Surround Sound
 ];
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.2.14",
+  "version": "3.2.15",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [

package/test/cast/cast_receiver_integration.js

@@ -34,6 +34,8 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
 
   /** @type {shaka.util.PublicPromise} */
   let messageWaitPromise;
+  /** @type {Array.<string>} */
+  let pendingMessages = null;
 
   /** @type {!Array.<function()>} */
   let toRestore;
@@ -91,6 +93,9 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
     toRestore = [];
     pendingWaitWrapperCalls = 0;
 
+    messageWaitPromise = null;
+    pendingMessages = null;
+
     fakeInitState = {
       player: {
         configure: {},
@@ -118,6 +123,12 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
     player = null;
     video = null;
     receiver = null;
+
+    if (messageWaitPromise) {
+      messageWaitPromise.resolve([]);
+    }
+    messageWaitPromise = null;
+    pendingMessages = null;
   });
 
   afterAll(() => {
@@ -128,6 +139,66 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
     }
   });
 
+  describe('without drm', () => {
+    it('sends reasonably-sized updates', async () => {
+      // Use an unencrypted asset.
+      fakeInitState.manifest = 'test:sintel';
+
+      const p = waitForLoadedData();
+
+      // Start the process of loading by sending a fake init message.
+      fakeConnectedSenders(1);
+      fakeIncomingMessage({
+        type: 'init',
+        initState: fakeInitState,
+        appData: {},
+      }, mockShakaMessageBus);
+
+      await p;
+      // Wait for an update message.
+      const messages = await waitForUpdateMessages();
+      for (const message of messages) {
+        // Check that the update message is of a reasonable size. From previous
+        // testing we found that the socket would silently reject data that got
+        // too big. 6KB is safely below the limit.
+        expect(message.length).toBeLessThan(6000);
+      }
+    });
+
+    it('has reasonable average message size', async () => {
+      // Use an unencrypted asset.
+      fakeInitState.manifest = 'test:sintel';
+
+      const p = waitForLoadedData();
+
+      // Start the process of loading by sending a fake init message.
+      fakeConnectedSenders(1);
+      fakeIncomingMessage({
+        type: 'init',
+        initState: fakeInitState,
+        appData: {},
+      }, mockShakaMessageBus);
+
+      await p;
+
+      // Collect messages over 50 update cycles, and average their length.
+      // Not all properties are passed along on every update message, so
+      // the average length is expected to be lower than the length of the first
+      // update message.
+      let totalLength = 0;
+      let totalMessages = 0;
+      for (let i = 0; i < 50; i++) {
+        // eslint-disable-next-line no-await-in-loop
+        const messages = await waitForUpdateMessages();
+        for (const message of messages) {
+          totalLength += message.length;
+          totalMessages += 1;
+        }
+      }
+      expect(totalLength / totalMessages).toBeLessThan(2000);
+    });
+  });
+
   filterDescribe('with drm', () => support['com.widevine.alpha'], () => {
     drmIt('sends reasonably-sized updates', async () => {
       // Use an encrypted asset, to make sure DRM info doesn't balloon the size.
@@ -150,11 +221,13 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
 
       await p;
       // Wait for an update message.
-      const message = await waitForUpdateMessage();
-      // Check that the update message is of a reasonable size. From previous
-      // testing we found that the socket would silently reject data that got
-      // too big. 6KB is safely below the limit.
-      expect(message.length).toBeLessThan(7 * 1024);
+      const messages = await waitForUpdateMessages();
+      for (const message of messages) {
+        // Check that the update message is of a reasonable size. From previous
+        // testing we found that the socket would silently reject data that got
+        // too big. 6KB is safely below the limit.
+        expect(message.length).toBeLessThan(6000);
+      }
     });
 
     drmIt('has reasonable average message size', async () => {
@@ -177,17 +250,22 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
       }, mockShakaMessageBus);
 
       await p;
-      // Collect 50 update messages, and average their length.
+
+      // Collect messages over 50 update cycles, and average their length.
       // Not all properties are passed along on every update message, so
       // the average length is expected to be lower than the length of the first
       // update message.
       let totalLength = 0;
+      let totalMessages = 0;
       for (let i = 0; i < 50; i++) {
         // eslint-disable-next-line no-await-in-loop
-        const message = await waitForUpdateMessage();
-        totalLength += message.length;
+        const messages = await waitForUpdateMessages();
+        for (const message of messages) {
+          totalLength += message.length;
+          totalMessages += 1;
+        }
       }
-      expect(totalLength / 50).toBeLessThan(3000);
+      expect(totalLength / totalMessages).toBeLessThan(2000);
     });
   });
 
@@ -227,12 +305,12 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
     expect(pendingWaitWrapperCalls).toBe(0);
 
     // Wait for a final update message before proceeding.
-    await waitForUpdateMessage();
+    await waitForUpdateMessages();
   });
 
   /**
    * Creates a wrapper around a method on a given prototype, which makes it
-   * wait on waitForUpdateMessage before returning, and registers that wrapper
+   * wait on waitForUpdateMessages before returning, and registers that wrapper
    * to be uninstalled afterwards.
    * The replaced method is expected to be a method that returns a promise.
    * @param {!Object} prototype
@@ -249,7 +327,7 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
           'Waiting for update message before calling ' +
           name + '.' + methodName + '...');
       const originalArguments = Array.from(arguments);
-      await waitForUpdateMessage();
+      await waitForUpdateMessages();
       // eslint-disable-next-line no-restricted-syntax
       return original.apply(this, originalArguments);
     };
@@ -265,7 +343,8 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
     });
   }
 
-  function waitForUpdateMessage() {
+  function waitForUpdateMessages() {
+    pendingMessages = [];
     messageWaitPromise = new shaka.util.PublicPromise();
     return messageWaitPromise;
   }
@@ -316,10 +395,12 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
       bus.messages.push(CastUtils.deserialize(message));
       // Check to see if it's an update message.
       const parsed = CastUtils.deserialize(message);
-      if (parsed.type == 'update' && messageWaitPromise) {
+      if (parsed.type == 'update' && pendingMessages) {
         shaka.log.debug('Received update message. Proceeding...');
-        messageWaitPromise.resolve(message);
-        messageWaitPromise = null;
+        // The code waiting on this Promise will get an array of all of the
+        // messages processed within this tick.
+        pendingMessages.push(message);
+        messageWaitPromise.resolve(pendingMessages);
       }
     });
     const channel = {

package/test/cast/cast_receiver_unit.js

@@ -245,18 +245,20 @@ filterDescribe('CastReceiver', castReceiverSupport, () => {
       const fakeEvent = {type: 'timeupdate'};
       mockVideo.on['timeupdate'](fakeEvent);
 
-      // There are now "update" and "event" messages, in that order.
-      expect(mockShakaMessageBus.messages).toEqual([
-        {
-          type: 'update',
-          update: jasmine.any(Object),
-        },
-        {
-          type: 'event',
-          targetName: 'video',
-          event: jasmine.objectContaining(fakeEvent),
-        },
-      ]);
+      // There are now some number of "update" and "event" messages, in that
+      // order.
+      expect(mockShakaMessageBus.messages).toContain({
+        type: 'update',
+        update: jasmine.any(Object),
+      });
+      expect(mockShakaMessageBus.messages).toContain({
+        type: 'event',
+        targetName: 'video',
+        event: jasmine.objectContaining(fakeEvent),
+      });
+      const eventIndex = mockShakaMessageBus.messages.findIndex(
+          (message) => message.type == 'event');
+      expect(eventIndex).toBe(mockShakaMessageBus.messages.length - 1);
     });
   });
 
@@ -1105,6 +1107,9 @@ filterDescribe('CastReceiver', castReceiverSupport, () => {
     for (const name in CastUtils.PlayerGetterMethods) {
       player[name] = jasmine.createSpy(name);
     }
+    for (const name in CastUtils.LargePlayerGetterMethods) {
+      player[name] = jasmine.createSpy(name);
+    }
     for (const name in CastUtils.PlayerGetterMethodsThatRequireLive) {
       player[name] = jasmine.createSpy(name);
     }

package/test/cast/cast_utils_unit.js

@@ -34,6 +34,7 @@ describe('CastUtils', () => {
     const castMembers = CastUtils.PlayerVoidMethods
         .concat(CastUtils.PlayerPromiseMethods)
         .concat(Object.keys(CastUtils.PlayerGetterMethods))
+        .concat(Object.keys(CastUtils.LargePlayerGetterMethods))
         .concat(Object.keys(CastUtils.PlayerGetterMethodsThatRequireLive));
     // eslint-disable-next-line no-restricted-syntax
     const allPlayerMembers = Object.getOwnPropertyNames(shaka.Player.prototype);