feat(Cast): Transfer side-loaded text/thumbnail/chapter tracks (#8553)

Author: avelad

lib/cast/cast_proxy.js

@@ -77,6 +77,15 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
     /** @private {boolean} */
     this.androidReceiverCompatible_ = androidReceiverCompatible;
 
+    /** @private {!Array<?>} */
+    this.addThumbnailsTrackCalls_ = [];
+
+    /** @private {!Array<?>} */
+    this.addTextTrackAsyncCalls_ = [];
+
+    /** @private {!Array<?>} */
+    this.addChaptersTrackCalls_ = [];
+
     /** @private {!Map} */
     this.compiledToExternNames_ = new Map();
 
@@ -205,7 +214,6 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
       return;
     }
     // TODO: transfer manually-selected tracks?
-    // TODO: transfer side-loaded text tracks?
 
     await this.sender_.cast();
     if (!this.localPlayer_) {
@@ -450,6 +458,9 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
       'playerAfterLoad': {},
       'manifest': this.localPlayer_.getAssetUri(),
       'startTime': null,
+      'addThumbnailsTrackCalls': this.addThumbnailsTrackCalls_,
+      'addTextTrackAsyncCalls': this.addTextTrackAsyncCalls_,
+      'addChaptersTrackCalls': this.addChaptersTrackCalls_,
     };
 
     // Pause local playback before capturing state.
@@ -517,6 +528,12 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
       /** @type {Object} */(this.localPlayer_)[setter](value);
     }
 
+    const addThumbnailsTrackCalls = this.addThumbnailsTrackCalls_;
+    const addTextTrackAsyncCalls = this.addTextTrackAsyncCalls_;
+    const addChaptersTrackCalls = this.addChaptersTrackCalls_;
+
+    this.resetExternalTracks();
+
     // Get the most recent manifest URI and ended state.
     const assetUri = this.sender_.get('player', 'getAssetUri')();
     const ended = this.sender_.get('video', 'ended');
@@ -562,6 +579,16 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
         return;
       }
 
+      for (const args of addThumbnailsTrackCalls) {
+        this.localPlayer_.addThumbnailsTrack(...args);
+      }
+      for (const args of addTextTrackAsyncCalls) {
+        this.localPlayer_.addTextTrackAsync(...args);
+      }
+      for (const args of addChaptersTrackCalls) {
+        this.localPlayer_.addChaptersTrack(...args);
+      }
+
       for (const name of shaka.cast.CastUtils.VideoInitStateAttributes) {
         this.localVideo_[name] = videoState[name];
       }
@@ -672,10 +699,11 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
 
   /**
    * @param {string} name
+   * @param {boolean} dontRecordCalls
    * @return {?}
    * @private
    */
-  playerProxyGet_(name) {
+  playerProxyGet_(name, dontRecordCalls = false) {
     // If name is a shortened compiled name, get the original version
     // from our map.
     if (this.compiledToExternNames_.has(name)) {
@@ -739,6 +767,27 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
       return (container) => this.localPlayer_.setVideoContainer(container);
     }
 
+    if (!dontRecordCalls) {
+      if (name == 'addThumbnailsTrack') {
+        return (...args) => {
+          this.addThumbnailsTrackCalls_.push(args);
+          return this.playerProxyGet_(name, /* dontRecordCalls= */ true)(args);
+        };
+      }
+      if (name == 'addTextTrackAsync') {
+        return (...args) => {
+          this.addTextTrackAsyncCalls_.push(args);
+          return this.playerProxyGet_(name, /* dontRecordCalls= */ true)(args);
+        };
+      }
+      if (name == 'addChaptersTrack') {
+        return (...args) => {
+          this.addChaptersTrackCalls_.push(args);
+          return this.playerProxyGet_(name, /* dontRecordCalls= */ true)(args);
+        };
+      }
+    }
+
     if (this.sender_.isCasting()) {
       // These methods are unavailable or otherwise stubbed during casting.
       if (name == 'getManifest' || name == 'drmInfo') {
@@ -820,7 +869,19 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
     if (targetName == 'video') {
       this.videoEventTarget_.dispatchEvent(event);
     } else if (targetName == 'player') {
+      if (event.type == shaka.util.FakeEvent.EventName.Unloading) {
+        this.resetExternalTracks();
+      }
       this.playerEventTarget_.dispatchEvent(event);
     }
   }
+
+  /**
+   * Reset external tracks
+   */
+  resetExternalTracks() {
+    this.addThumbnailsTrackCalls_ = [];
+    this.addTextTrackAsyncCalls_ = [];
+    this.addChaptersTrackCalls_ = [];
+  }
 };

lib/cast/cast_receiver.js

@@ -393,6 +393,21 @@ shaka.cast.CastReceiver = class extends shaka.util.FakeEventTarget {
       this.video_.autoplay = false;
       try {
         await this.player_.load(initState['manifest'], initState['startTime']);
+        if (initState['addThumbnailsTrackCalls']) {
+          for (const args of initState['addThumbnailsTrackCalls']) {
+            this.player_.addThumbnailsTrack(...args);
+          }
+        }
+        if (initState['addTextTrackAsyncCalls']) {
+          for (const args of initState['addTextTrackAsyncCalls']) {
+            this.player_.addTextTrackAsync(...args);
+          }
+        }
+        if (initState['addChaptersTrackCalls']) {
+          for (const args of initState['addChaptersTrackCalls']) {
+            this.player_.addChaptersTrack(...args);
+          }
+        }
       } catch (error) {
         // Pass any errors through to the app.
         goog.asserts.assert(error instanceof shaka.util.Error,

lib/cast/cast_utils.js

@@ -438,7 +438,10 @@ shaka.cast.CastUtils.PlayerPromiseMethods = [
  *   video: Object,
  *   player: Object,
  *   manifest: ?string,
- *   startTime: ?number
+ *   startTime: ?number,
+ *   addThumbnailsTrackCalls: !Array<?>,
+ *   addTextTrackAsyncCalls: !Array<?>,
+ *   addChaptersTrackCalls: !Array<?>
  * }}
  * @property {Object} video
  *   Dictionary of video properties to be set.
@@ -448,6 +451,12 @@ shaka.cast.CastUtils.PlayerPromiseMethods = [
  *   The currently-selected manifest, if present.
  * @property {?number} startTime
  *   The playback start time, if currently playing.
+ * @property {!Array<?>} addThumbnailsTrackCalls
+ *   List of parameters with which addThumbnailsTrack was called.
+ * @property {!Array<?>} addTextTrackAsyncCalls
+ *   List of parameters with which addTextTrackAsync was called.
+ * @property {!Array<?>} addChaptersTrackCalls
+ *   List of parameters with which addChaptersTrack was called.
  */
 shaka.cast.CastUtils.InitStateType;