shaka-player 3.1.0 → 3.1.4

package/lib/polyfill/pip_webkit.js

@@ -12,10 +12,12 @@ goog.require('shaka.polyfill');
 /**
  * @summary A polyfill to provide PiP support in Safari.
  * Note that Safari only supports PiP on video elements, not audio.
+ * @export
  */
 shaka.polyfill.PiPWebkit = class {
   /**
    * Install the polyfill if needed.
+   * @export
    */
   static install() {
     if (!window.HTMLVideoElement) {

package/lib/polyfill/storage_estimate.js

@@ -13,10 +13,12 @@ goog.require('shaka.polyfill');
  * @summary A polyfill to provide navigator.storage.estimate in old
  * webkit browsers.
  * See: https://developers.google.com/web/updates/2017/08/estimating-available-storage-space#the-present
+ * @export
  */
 shaka.polyfill.StorageEstimate = class {
   /**
    * Install the polyfill if needed.
+   * @export
    */
   static install() {
     if (navigator.storage && navigator.storage.estimate) {

package/lib/polyfill/video_play_promise.js

@@ -12,10 +12,12 @@ goog.require('shaka.polyfill');
 
 /**
  * @summary A polyfill to silence the play() Promise in HTML5 video.
+ * @export
  */
 shaka.polyfill.VideoPlayPromise = class {
   /**
    * Install the polyfill if needed.
+   * @export
    */
   static install() {
     shaka.log.debug('VideoPlayPromise.install');

package/lib/polyfill/videoplaybackquality.js

@@ -13,10 +13,12 @@ goog.require('shaka.polyfill');
  * @summary A polyfill to provide MSE VideoPlaybackQuality metrics.
  * Many browsers do not yet provide this API, and Chrome currently provides
  * similar data through individual prefixed attributes on HTMLVideoElement.
+ * @export
  */
 shaka.polyfill.VideoPlaybackQuality = class {
   /**
    * Install the polyfill if needed.
+   * @export
    */
   static install() {
     if (!window.HTMLVideoElement) {

package/lib/polyfill/vttcue.js

@@ -12,10 +12,12 @@ goog.require('shaka.polyfill');
 
 /**
  * @summary A polyfill to provide VTTCue.
+ * @export
  */
 shaka.polyfill.VTTCue = class {
   /**
    * Install the polyfill if needed.
+   * @export
    */
   static install() {
     if (window.VTTCue) {

package/lib/text/cue.js

@@ -232,6 +232,17 @@ shaka.text.Cue = class {
     };
   }
 
+  /**
+   * @param {number} start
+   * @param {number} end
+   * @return {!shaka.text.Cue}
+   */
+  static lineBreak(start, end) {
+    const cue = new shaka.text.Cue(start, end, '');
+    cue.lineBreak = true;
+    return cue;
+  }
+
   /**
    * Create a copy of the cue with the same properties.
    * @return {!shaka.text.Cue}

package/lib/text/mp4_ttml_parser.js

@@ -88,6 +88,9 @@ shaka.text.Mp4TtmlParser = class {
 
 shaka.text.TextEngine.registerParser(
     'application/mp4; codecs="stpp"', () => new shaka.text.Mp4TtmlParser());
+shaka.text.TextEngine.registerParser(
+    'application/mp4; codecs="stpp.ttml"',
+    () => new shaka.text.Mp4TtmlParser());
 shaka.text.TextEngine.registerParser(
     'application/mp4; codecs="stpp.ttml.im1t"',
     () => new shaka.text.Mp4TtmlParser());

package/lib/text/text_engine.js

@@ -345,6 +345,19 @@ shaka.text.TextEngine = class {
     return cues;
   }
 
+  /**
+   * @param {!shaka.text.Cue} cue the cue to apply the timestamp to recursively
+   * @param {number} videoTimestampOffset the timestamp offset of the video
+   * @private
+   */
+  applyVideoTimestampOffsetRecursive_(cue, videoTimestampOffset) {
+    cue.startTime += videoTimestampOffset;
+    cue.endTime += videoTimestampOffset;
+    for (const nested of cue.nestedCues) {
+      this.applyVideoTimestampOffsetRecursive_(nested, videoTimestampOffset);
+    }
+  }
+
   /**
    * Store the closed captions in the text engine, and append the cues to the
    * text displayer.  This is a side-channel used for embedded text only.
@@ -373,8 +386,7 @@ shaka.text.TextEngine = class {
 
       // Adjust CEA captions with respect to the timestamp offset of the video
       // stream in which they were embedded.
-      cue.startTime += videoTimestampOffset;
-      cue.endTime += videoTimestampOffset;
+      this.applyVideoTimestampOffsetRecursive_(cue, videoTimestampOffset);
 
       const keepThisCue =
           cue.startTime >= this.appendWindowStart_ &&

package/lib/text/ttml_text_parser.js

@@ -199,6 +199,11 @@ shaka.text.TtmlTextParser = class {
     /** @type {Element} */
     let parentElement = /** @type {Element} */(cueNode.parentNode);
 
+    if (cueNode.nodeType == Node.COMMENT_NODE) {
+      // The comments do not contain information that interests us here.
+      return null;
+    }
+
     if (cueNode.nodeType == Node.TEXT_NODE) {
       // This should generate an "anonymous span" according to the TTML spec.
       // So pretend the element was a <span>.  parentElement was set above, so
@@ -219,6 +224,36 @@ shaka.text.TtmlTextParser = class {
 
     const localWhitespaceTrim = spaceStyle == 'default';
 
+    // Parse any nested cues first.
+    const isTextNode = (node) => {
+      return node.nodeType == Node.TEXT_NODE;
+    };
+    const isLeafNode = Array.from(cueElement.childNodes).every(isTextNode);
+    const nestedCues = [];
+    if (!isLeafNode) {
+      // Otherwise, recurse into the children.  Text nodes will convert into
+      // anonymous spans, which will then be leaf nodes.
+      for (const childNode of cueElement.childNodes) {
+        const nestedCue = shaka.text.TtmlTextParser.parseCue_(
+            childNode,
+            offset,
+            rateInfo,
+            metadataElements,
+            styles,
+            regionElements,
+            cueRegions,
+            localWhitespaceTrim,
+            /* isNested= */ true,
+            cellResolution,
+        );
+
+        // This node may or may not generate a nested cue.
+        if (nestedCue) {
+          nestedCues.push(nestedCue);
+        }
+      }
+    }
+
     // In this regex, "\S" means "non-whitespace character".
     const hasTextContent = /\S/.test(cueElement.textContent);
     const hasTimeAttributes =
@@ -226,7 +261,8 @@ shaka.text.TtmlTextParser = class {
         cueElement.hasAttribute('end') ||
         cueElement.hasAttribute('dur');
 
-    if (!hasTimeAttributes && !hasTextContent && cueElement.tagName != 'br') {
+    if (!hasTimeAttributes && !hasTextContent && cueElement.tagName != 'br' &&
+        nestedCues.length == 0) {
       if (!isNested) {
         // Disregards empty <p> elements without time attributes nor content.
         // <p begin="..." smpte:backgroundImage="..." /> will go through,
@@ -263,6 +299,20 @@ shaka.text.TtmlTextParser = class {
       end += offset;
     }
 
+    if (!hasTimeAttributes && nestedCues.length > 0) {
+      // If no time is defined for this cue, base the timing information on
+      // the time of the nested cues. In the case of multiple nested cues with
+      // different start times, it is the text displayer's responsibility to
+      // make sure that only the appropriate nested cue is drawn at any given
+      // time.
+      start = Infinity;
+      end = 0;
+      for (const cue of nestedCues) {
+        start = Math.min(start, cue.startTime);
+        end = Math.max(end, cue.endTime);
+      }
+    }
+
     if (cueElement.tagName == 'br') {
       const cue = new shaka.text.Cue(start, end, '');
       cue.lineBreak = true;
@@ -270,13 +320,7 @@ shaka.text.TtmlTextParser = class {
     }
 
     let payload = '';
-    const nestedCues = [];
-
-    const isTextNode = (node) => {
-      return node.nodeType == Node.TEXT_NODE;
-    };
-
-    if (Array.from(cueElement.childNodes).every(isTextNode)) {
+    if (isLeafNode) {
       // If the childNodes are all text, this is a leaf node.  Get the payload.
       payload = cueElement.textContent;
       if (localWhitespaceTrim) {
@@ -285,28 +329,6 @@ shaka.text.TtmlTextParser = class {
         // Collapse multiple spaces into one.
         payload = payload.replace(/\s+/g, ' ');
       }
-    } else {
-      // Otherwise, recurse into the children.  Text nodes will convert into
-      // anonymous spans, which will then be leaf nodes.
-      for (const childNode of cueElement.childNodes) {
-        const nestedCue = shaka.text.TtmlTextParser.parseCue_(
-            childNode,
-            offset,
-            rateInfo,
-            metadataElements,
-            styles,
-            regionElements,
-            cueRegions,
-            localWhitespaceTrim,
-            /* isNested= */ true,
-            cellResolution,
-        );
-
-        // This node may or may not generate a nested cue.
-        if (nestedCue) {
-          nestedCues.push(nestedCue);
-        }
-      }
     }
 
     const cue = new shaka.text.Cue(start, end, payload);