shaka-player 4.6.3 → 4.7.0

package/lib/player.js

@@ -39,6 +39,7 @@ goog.require('shaka.text.UITextDisplayer');
 goog.require('shaka.text.WebVttGenerator');
 goog.require('shaka.util.BufferUtils');
 goog.require('shaka.util.CmcdManager');
+goog.require('shaka.util.CmsdManager');
 goog.require('shaka.util.ConfigUtils');
 goog.require('shaka.util.Dom');
 goog.require('shaka.util.Error');
@@ -598,6 +599,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     /** @private {shaka.util.CmcdManager} */
     this.cmcdManager_ = null;
 
+    /** @private {shaka.util.CmsdManager} */
+    this.cmsdManager_ = null;
+
     // This is the canvas element that will be used for rendering LCEVC
     // enhanced frames.
     /** @private {?HTMLCanvasElement} */
@@ -676,8 +680,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
             this.config_.preferredVariantRole,
             this.config_.preferredAudioChannelCount,
             this.config_.preferredVideoHdrLevel,
+            this.config_.preferSpatialAudio,
             this.config_.preferredVideoLayout,
             this.config_.preferredAudioLabel,
+            this.config_.preferredVideoLabel,
             this.config_.mediaSource.codecSwitchingStrategy,
             this.config_.manifest.dash.enableAudioGroups);
 
@@ -701,6 +707,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     // Create the CMCD manager so client data can be attached to all requests
     this.cmcdManager_ = this.createCmcd_();
 
+    this.cmsdManager_ = this.createCmsd_();
+
     this.networkingEngine_ = this.createNetworkingEngine();
     this.networkingEngine_.setForceHTTPS(this.config_.streaming.forceHTTPS);
 
@@ -846,6 +854,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     this.stats_ = null;
     this.videoContainer_ = null;
     this.cmcdManager_ = null;
+    this.cmsdManager_ = null;
 
     if (this.networkingEngine_) {
       await this.networkingEngine_.destroy();
@@ -1217,6 +1226,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         this.adManager_.onAssetUnload();
       }
 
+      if (this.cmsdManager_) {
+        this.cmsdManager_.reset();
+      }
+
       if (this.video_) {
         // Remove all track nodes
         shaka.util.Dom.removeAllChildren(this.video_);
@@ -1576,6 +1589,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     goog.asserts.assert(
         this.cmcdManager_,
         'Need CMCD manager to populate manifest request data.');
+    goog.asserts.assert(
+        this.cmsdManager_,
+        'Need CMSD manager to process response headers.');
     goog.asserts.assert(
         this.config_,
         'Need player config when initializing the parser.');
@@ -1825,6 +1841,12 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
             'Please use an AbrManager with setMediaElement function.');
         this.abrManager_.setMediaElement = () => {};
       }
+      if (typeof this.abrManager_.setCmsdManager != 'function') {
+        shaka.Deprecate.deprecateFeature(5,
+            'AbrManager',
+            'Please use an AbrManager with setCmsdManager function.');
+        this.abrManager_.setCmsdManager = () => {};
+      }
       this.abrManager_.configure(this.config_.abr);
     }
 
@@ -1836,8 +1858,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
             this.config_.preferredVariantRole,
             this.config_.preferredAudioChannelCount,
             this.config_.preferredVideoHdrLevel,
+            this.config_.preferSpatialAudio,
             this.config_.preferredVideoLayout,
             this.config_.preferredAudioLabel,
+            this.config_.preferredVideoLabel,
             this.config_.mediaSource.codecSwitchingStrategy,
             this.config_.manifest.dash.enableAudioGroups);
 
@@ -1853,6 +1877,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       return this.switch_(variant, clearBuffer, safeMargin);
     });
     this.abrManager_.setMediaElement(mediaElement);
+    this.abrManager_.setCmsdManager(this.cmsdManager_);
 
     // If the content is multi-codec and the browser can play more than one of
     // them, choose codecs now before we initialize streaming.
@@ -2607,6 +2632,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           .set('request', request)
           .set('requestType', requestType);
       this.dispatchEvent(this.makeEvent_(name, data));
+      if (this.cmsdManager_) {
+        this.cmsdManager_.processHeaders(headers);
+      }
     };
     /** @type {shaka.net.NetworkingEngine.OnDownloadFailed} */
     const onDownloadFailed_ = (request, error, httpResponseCode, aborted) => {
@@ -2847,6 +2875,15 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     return new shaka.util.CmcdManager(playerInterface, this.config_.cmcd);
   }
 
+  /**
+   * Create a new CMSD manager.
+   *
+   * @private
+   */
+  createCmsd_() {
+    return new shaka.util.CmsdManager(this.config_.cmsd);
+  }
+
   /**
    * Creates a new instance of StreamingEngine.  This can be replaced by tests
    * to create fake instances instead.
@@ -2947,9 +2984,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     }
 
     // If lowLatencyMode is enabled, and inaccurateManifestTolerance and
-    // rebufferingGoal and segmentPrefetchLimit are not specified, set
-    // inaccurateManifestTolerance to 0 and rebufferingGoal to 0.01 and
-    // segmentPrefetchLimit to 2 by default for low latency streaming.
+    // rebufferingGoal and segmentPrefetchLimit and baseDelay are not
+    // specified, set inaccurateManifestTolerance to 0 and rebufferingGoal
+    // to 0.01 and segmentPrefetchLimit to 2 and baseDelay to 100 by default
+    // for low latency streaming.
     if (config['streaming'] && config['streaming']['lowLatencyMode']) {
       if (config['streaming']['inaccurateManifestTolerance'] == undefined) {
         config['streaming']['inaccurateManifestTolerance'] = 0;
@@ -2960,6 +2998,30 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       if (config['streaming']['segmentPrefetchLimit'] == undefined) {
         config['streaming']['segmentPrefetchLimit'] = 2;
       }
+      if (config['streaming']['retryParameters'] == undefined) {
+        config['streaming']['retryParameters'] = {};
+      }
+      if (config['streaming']['retryParameters']['baseDelay'] == undefined) {
+        config['streaming']['retryParameters']['baseDelay'] = 100;
+      }
+      if (config['manifest'] == undefined) {
+        config['manifest'] = {};
+      }
+      if (config['manifest']['retryParameters'] == undefined) {
+        config['manifest']['retryParameters'] = {};
+      }
+      if (config['manifest']['retryParameters']['baseDelay'] == undefined) {
+        config['manifest']['retryParameters']['baseDelay'] = 100;
+      }
+      if (config['drm'] == undefined) {
+        config['drm'] = {};
+      }
+      if (config['drm']['retryParameters'] == undefined) {
+        config['drm']['retryParameters'] = {};
+      }
+      if (config['drm']['retryParameters']['baseDelay'] == undefined) {
+        config['drm']['retryParameters']['baseDelay'] = 100;
+      }
     }
     const ret = shaka.util.PlayerConfiguration.mergeConfigObjects(
         this.config_, config, this.defaultConfig_());
@@ -3065,6 +3127,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     if (this.cmcdManager_) {
       this.cmcdManager_.configure(this.config_.cmcd);
     }
+    if (this.cmsdManager_) {
+      this.cmsdManager_.configure(this.config_.cmsd);
+    }
   }
 
   /**
@@ -4001,8 +4066,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
               role || '',
               channelsCount,
               /* hdrLevel= */ '',
+              /* spatialAudio= */ false,
               /* videoLayout= */ '',
-              /* label= */ '',
+              /* audioLabel= */ '',
+              /* videoLabel= */ '',
               this.config_.mediaSource.codecSwitchingStrategy,
               this.config_.manifest.dash.enableAudioGroups);
 
@@ -4125,8 +4192,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
               /* role= */ '',
               /* channelCount= */ 0,
               /* hdrLevel= */ '',
+              /* spatialAudio= */ false,
               /* videoLayout= */ '',
               label,
+              /* videoLabel= */ '',
               this.config_.mediaSource.codecSwitchingStrategy,
               this.config_.manifest.dash.enableAudioGroups);
 
@@ -5144,7 +5213,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       } else {
         // eslint-disable-next-line no-restricted-syntax
         if (HTMLMediaElement.prototype.addTextTrack) {
-          return new shaka.text.SimpleTextDisplayer(this.video_);
+          return new shaka.text.SimpleTextDisplayer(
+              this.video_, shaka.Player.TextTrackLabel);
         } else {
           shaka.log.warning('Text tracks are not supported by the ' +
                             'browser, disabling.');
@@ -6187,7 +6257,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @param {!shaka.util.Error} error
    * @private
    */
-  onError_(error) {
+  async onError_(error) {
     goog.asserts.assert(error instanceof shaka.util.Error, 'Wrong error type!');
 
     // Errors dispatched after |destroy| is called are not meaningful and should
@@ -6196,6 +6266,23 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       return;
     }
 
+    let fireError = true;
+    if (this.fullyLoaded_ && this.manifest_ && this.streamingEngine_ &&
+        (error.code == shaka.util.Error.Code.VIDEO_ERROR ||
+        error.code == shaka.util.Error.Code.MEDIA_SOURCE_OPERATION_FAILED ||
+        error.code == shaka.util.Error.Code.MEDIA_SOURCE_OPERATION_THREW ||
+        error.code == shaka.util.Error.Code.TRANSMUXING_FAILED)) {
+      try {
+        const ret = await this.streamingEngine_.resetMediaSource();
+        fireError = !ret;
+      } catch (e) {
+        fireError = true;
+      }
+    }
+    if (!fireError) {
+      return;
+    }
+
     // Restore disabled variant if the player experienced a critical error.
     if (error.severity === shaka.util.Error.Severity.CRITICAL) {
       this.restoreDisabledVariants_(/* updateAbrManager= */ false);
@@ -6386,6 +6473,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     }  // if (keyIds.size)
 
     if (tracksChanged) {
+      this.onTracksChanged_();
       const variantsUpdated = this.updateAbrManagerVariants_();
       if (!variantsUpdated) {
         return;
@@ -6397,10 +6485,6 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       shaka.log.debug('Choosing new streams after key status changed');
       this.chooseVariantAndSwitch_();
     }
-
-    if (tracksChanged) {
-      this.onTracksChanged_();
-    }
   }
 
   /**
@@ -6781,7 +6865,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @export
  */
 // eslint-disable-next-line no-useless-concat
-shaka.Player.version = 'v4.6.3' + '-uncompiled';  // x-release-please-version
+shaka.Player.version = 'v4.7.0' + '-uncompiled';  // x-release-please-version
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/text/simple_text_displayer.js

@@ -6,7 +6,6 @@
 
 /**
  * @fileoverview
- * @suppress {missingRequire} TODO(b/152540451): this shouldn't be needed
  */
 
 goog.provide('shaka.text.SimpleTextDisplayer');
@@ -24,8 +23,11 @@ goog.require('shaka.text.Utils');
  * @export
  */
 shaka.text.SimpleTextDisplayer = class {
-  /** @param {HTMLMediaElement} video */
-  constructor(video) {
+  /**
+   * @param {HTMLMediaElement} video
+   * @param {string} label
+   */
+  constructor(video, label) {
     /** @private {TextTrack} */
     this.textTrack_ = null;
 
@@ -39,7 +41,7 @@ shaka.text.SimpleTextDisplayer = class {
       // element.
       track.mode = 'disabled';
 
-      if (track.label == shaka.Player.TextTrackLabel) {
+      if (track.label == label) {
         this.textTrack_ = track;
       }
     }
@@ -49,8 +51,7 @@ shaka.text.SimpleTextDisplayer = class {
       // kind to 'subtitles' or 'captions' when creating the TextTrack object.
       // The individual text tracks from the manifest will still have their own
       // kinds which can be displayed in the app's UI.
-      this.textTrack_ = video.addTextTrack(
-          'subtitles', shaka.Player.TextTrackLabel);
+      this.textTrack_ = video.addTextTrack('subtitles', label);
     }
     this.textTrack_.mode = 'hidden';
   }
@@ -80,7 +81,7 @@ shaka.text.SimpleTextDisplayer = class {
    * @export
    */
   append(cues) {
-    const flattenedCues = shaka.text.Utils.getCuesToFlatten(cues, []);
+    const flattenedCues = shaka.text.Utils.getCuesToFlatten(cues);
 
     // Convert cues.
     const textTrackCues = [];

package/lib/text/text_utils.js

@@ -15,16 +15,19 @@ shaka.text.Utils = class {
    * their contents should be combined and replace the payload of the parent.
    *
    * @param {!shaka.text.Cue} cue
+   * @param {?shaka.text.Cue=} parentCue
    * @return {string}
    * @private
    */
-  static flattenPayload_(cue) {
+  static flattenPayload_(cue, parentCue) {
     if (cue.lineBreak) {
       // This is a vertical lineBreak, so insert a newline.
       return '\n';
     }
     if (cue.nestedCues.length) {
-      return cue.nestedCues.map(shaka.text.Utils.flattenPayload_).join('');
+      return cue.nestedCues.map((nested) => {
+        return shaka.text.Utils.flattenPayload_(nested, cue);
+      }).join('');
     }
 
     // Handle bold, italics and underline
@@ -43,14 +46,22 @@ shaka.text.Utils = class {
       openStyleTags.push(['u']);
     }
     // Handle color classes, if the value consists of letters
+    let color = cue.color;
+    if (color == '' && parentCue) {
+      color = parentCue.color;
+    }
     let classes = '';
-    const color = shaka.text.Utils.getColorName_(cue.color);
-    if (color) {
-      classes += `.${color}`;
+    const colorName = shaka.text.Utils.getColorName_(color);
+    if (colorName) {
+      classes += `.${colorName}`;
+    }
+    let bgColor = cue.backgroundColor;
+    if (bgColor == '' && parentCue) {
+      bgColor = parentCue.backgroundColor;
     }
-    const bgColor = shaka.text.Utils.getColorName_(cue.backgroundColor);
-    if (bgColor) {
-      classes += `.bg_${bgColor}`;
+    const bgColorName = shaka.text.Utils.getColorName_(bgColor);
+    if (bgColorName) {
+      classes += `.bg_${bgColorName}`;
     }
     if (classes) {
       openStyleTags.push(['c', classes]);
@@ -69,7 +80,20 @@ shaka.text.Utils = class {
    * @private
    */
   static getColorName_(string) {
-    switch (string.toLowerCase()) {
+    let colorString = string.toLowerCase();
+    const rgb = colorString.replace(/\s/g, '')
+        .match(/^rgba?\((\d+),(\d+),(\d+),?([^,\s)]+)?/i);
+    if (rgb) {
+      colorString = '#' +
+          (parseInt(rgb[1], 10) | (1 << 8)).toString(16).slice(1) +
+          (parseInt(rgb[2], 10) | (1 << 8)).toString(16).slice(1) +
+          (parseInt(rgb[3], 10) | (1 << 8)).toString(16).slice(1);
+    } else if (colorString.startsWith('#') && colorString.length > 7) {
+      // With this we lose the alpha of the color, but it is better than having
+      // no color.
+      colorString = colorString.slice(0, 7);
+    }
+    switch (colorString) {
       case 'white':
       case '#fff':
       case '#ffffff':
@@ -92,6 +116,7 @@ shaka.text.Utils = class {
         return 'yellow';
       case 'magenta':
       case '#f0f':
+      case '#ff00ff':
         return 'magenta';
       case 'blue':
       case '#00f':
@@ -118,19 +143,20 @@ shaka.text.Utils = class {
    * isContainer = false.
    *
    * @param {!Array.<!shaka.text.Cue>} cues
-   * @param {!Array.<!shaka.text.Cue>} result
+   * @param {?shaka.text.Cue=} parentCue
    * @return {!Array.<!shaka.text.Cue>}
    */
-  static getCuesToFlatten(cues, result) {
+  static getCuesToFlatten(cues, parentCue) {
+    const result = [];
     for (const cue of cues) {
       if (cue.isContainer) {
         // Recurse to find the actual text payload cues.
-        shaka.text.Utils.getCuesToFlatten(cue.nestedCues, result);
+        result.push(...shaka.text.Utils.getCuesToFlatten(cue.nestedCues, cue));
       } else {
         // Flatten the payload.
         const flatCue = cue.clone();
         flatCue.nestedCues = [];
-        flatCue.payload = shaka.text.Utils.flattenPayload_(cue);
+        flatCue.payload = shaka.text.Utils.flattenPayload_(cue, parentCue);
         result.push(flatCue);
       }
     }

package/lib/text/ui_text_displayer.js

@@ -707,37 +707,46 @@ shaka.text.UITextDisplayer = class {
     //   (for vertical growing left) is aligned at the line.
     // TODO: Implement line alignment with line number.
     // TODO: Implement lineAlignment of 'CENTER'.
-    if (cue.line != null) {
+    let line = cue.line;
+    if (line != null) {
       let lineInterpretation = cue.lineInterpretation;
       // HACK: the current implementation of UITextDisplayer only handled
-      // PERCENTAGE, as cue.line=0 is zero, we can interpret it as percentage
-      // safely.
-      if (cue.line == 0 &&
-          lineInterpretation == Cue.lineInterpretation.LINE_NUMBER) {
+      // PERCENTAGE, so we need convert LINE_NUMBER to PERCENTAGE
+      if (lineInterpretation == Cue.lineInterpretation.LINE_NUMBER) {
         lineInterpretation = Cue.lineInterpretation.PERCENTAGE;
+        let maxLines = 16;
+        // The maximum number of lines is different if it is a vertical video.
+        if (this.aspectRatio_ && this.aspectRatio_ < 1) {
+          maxLines = 32;
+        }
+        if (line < 0) {
+          line = 100 + line / maxLines * 100;
+        } else {
+          line = line / maxLines * 100;
+        }
       }
       if (lineInterpretation == Cue.lineInterpretation.PERCENTAGE) {
         style.position = 'absolute';
         if (cue.writingMode == Cue.writingMode.HORIZONTAL_TOP_TO_BOTTOM) {
           style.width = '100%';
           if (cue.lineAlign == Cue.lineAlign.START) {
-            style.top = cue.line + '%';
+            style.top = line + '%';
           } else if (cue.lineAlign == Cue.lineAlign.END) {
-            style.bottom = (100 - cue.line) + '%';
+            style.bottom = (100 - line) + '%';
           }
         } else if (cue.writingMode == Cue.writingMode.VERTICAL_LEFT_TO_RIGHT) {
           style.height = '100%';
           if (cue.lineAlign == Cue.lineAlign.START) {
-            style.left = cue.line + '%';
+            style.left = line + '%';
           } else if (cue.lineAlign == Cue.lineAlign.END) {
-            style.right = (100 - cue.line) + '%';
+            style.right = (100 - line) + '%';
           }
         } else {
           style.height = '100%';
           if (cue.lineAlign == Cue.lineAlign.START) {
-            style.right = cue.line + '%';
+            style.right = line + '%';
           } else if (cue.lineAlign == Cue.lineAlign.END) {
-            style.left = (100 - cue.line) + '%';
+            style.left = (100 - line) + '%';
           }
         }
       }

package/lib/text/web_vtt_generator.js

@@ -40,7 +40,7 @@ shaka.text.WebVttGenerator = class {
           milliseconds;
     };
 
-    const flattenedCues = shaka.text.Utils.getCuesToFlatten(cues, []);
+    const flattenedCues = shaka.text.Utils.getCuesToFlatten(cues);
 
     let webvttString = 'WEBVTT\n\n';
     for (const cue of flattenedCues) {