shaka-player 3.2.0 → 3.2.4

package/lib/polyfill/orientation.js

@@ -15,10 +15,12 @@ goog.require('shaka.polyfill');
  * @summary A polyfill for systems that do not implement screen.orientation.
  * For now, this only handles systems that implement the deprecated
  * window.orientation feature... e.g. iPad.
+ * @export
  */
 shaka.polyfill.Orientation = class {
   /**
    * Install the polyfill if needed.
+   * @export
    */
   static install() {
     if (screen.orientation) {
@@ -90,7 +92,7 @@ class extends shaka.util.FakeEventTarget {
 
   /** Dispatch a 'change' event. */
   dispatchChangeEvent() {
-    const event = new shaka.util.FakeEvent('change', {});
+    const event = new shaka.util.FakeEvent('change');
     this.dispatchEvent(event);
   }
 

package/lib/polyfill/patchedmediakeys_apple.js

@@ -22,10 +22,12 @@ goog.require('shaka.util.StringUtils');
 /**
  * @summary A polyfill to implement modern, standardized EME on top of Apple's
  * prefixed EME in Safari.
+ * @export
  */
 shaka.polyfill.PatchedMediaKeysApple = class {
   /**
    * Installs the polyfill if needed.
+   * @export
    */
   static install() {
     if (!window.HTMLVideoElement || !window.WebKitMediaKeys) {
@@ -565,10 +567,10 @@ class extends shaka.util.FakeEventTarget {
 
     const isNew = this.keyStatuses.getStatus() == undefined;
 
-    const event2 = new shaka.util.FakeEvent('message', {
-      messageType: isNew ? 'license-request' : 'license-renewal',
-      message: shaka.util.BufferUtils.toArrayBuffer(event.message),
-    });
+    const data = new Map()
+        .set('messageType', isNew ? 'license-request' : 'license-renewal')
+        .set('message', shaka.util.BufferUtils.toArrayBuffer(event.message));
+    const event2 = new shaka.util.FakeEvent('message', data);
 
     this.dispatchEvent(event2);
   }

package/lib/polyfill/patchedmediakeys_ms.js

@@ -24,10 +24,12 @@ goog.require('shaka.util.PublicPromise');
  * {@link https://bit.ly/EmeMar15 EME draft 12 March 2015}
  * on top of ms-prefixed
  * {@link https://www.w3.org/TR/2014/WD-encrypted-media-20140218/ EME v20140218}
+ * @export
  */
 shaka.polyfill.PatchedMediaKeysMs = class {
   /**
    * Installs the polyfill if needed.
+   * @export
    */
   static install() {
     if (!window.HTMLVideoElement || !window.MSMediaKeys ||
@@ -510,10 +512,10 @@ class extends shaka.util.FakeEventTarget {
 
     const isNew = this.keyStatuses.getStatus() == undefined;
 
-    const event2 = new shaka.util.FakeEvent('message', {
-      messageType: isNew ? 'license-request' : 'license-renewal',
-      message: shaka.util.BufferUtils.toArrayBuffer(event.message),
-    });
+    const data = new Map()
+        .set('messageType', isNew ? 'license-request' : 'license-renewal')
+        .set('message', shaka.util.BufferUtils.toArrayBuffer(event.message));
+    const event2 = new shaka.util.FakeEvent('message', data);
 
     this.dispatchEvent(event2);
   }

package/lib/polyfill/patchedmediakeys_nop.js

@@ -16,10 +16,12 @@ goog.require('shaka.polyfill');
  * {@link https://bit.ly/EmeMar15 EME draft 12 March 2015} on browsers without
  * EME.
  * All methods will fail.
+ * @export
  */
 shaka.polyfill.PatchedMediaKeysNop = class {
   /**
    * Installs the polyfill if needed.
+   * @export
    */
   static install() {
     if (!window.HTMLVideoElement ||

package/lib/polyfill/patchedmediakeys_webkit.js

@@ -24,10 +24,12 @@ goog.require('shaka.util.Uint8ArrayUtils');
  * @summary A polyfill to implement
  * {@link https://bit.ly/EmeMar15 EME draft 12 March 2015} on top of
  * webkit-prefixed {@link https://bit.ly/Eme01b EME v0.1b}.
+ * @export
  */
 shaka.polyfill.PatchedMediaKeysWebkit = class {
   /**
    * Installs the polyfill if needed.
+   * @export
    */
   static install() {
     // Alias.
@@ -449,10 +451,10 @@ shaka.polyfill.PatchedMediaKeysWebkit.MediaKeys = class {
 
     const isNew = session.keyStatuses.getStatus() == undefined;
 
-    const event2 = new shaka.util.FakeEvent('message', {
-      messageType: isNew ? 'licenserequest' : 'licenserenewal',
-      message: event.message,
-    });
+    const data = new Map()
+        .set('messageType', isNew ? 'licenserequest' : 'licenserenewal')
+        .set('message', event.message);
+    const event2 = new shaka.util.FakeEvent('message', data);
 
     session.generated();
     session.dispatchEvent(event2);

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

@@ -210,6 +210,12 @@ shaka.text.Cue = class {
      */
     this.nestedCues = [];
 
+    /**
+     * @override
+     * @exportInterface
+     */
+    this.isContainer = false;
+
     /**
      * @override
      * @exportInterface

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

@@ -86,16 +86,17 @@ shaka.text.TtmlTextParser = class {
       }
 
       // Get the framerate, subFrameRate and frameRateMultiplier if applicable.
-      const frameRate = XmlUtils.getAttributeNS(tt, ttpNs, 'frameRate');
-      const subFrameRate = XmlUtils.getAttributeNS(tt, ttpNs, 'subFrameRate');
+      const frameRate = XmlUtils.getAttributeNSList(tt, ttpNs, 'frameRate');
+      const subFrameRate = XmlUtils.getAttributeNSList(
+          tt, ttpNs, 'subFrameRate');
       const frameRateMultiplier =
-          XmlUtils.getAttributeNS(tt, ttpNs, 'frameRateMultiplier');
-      const tickRate = XmlUtils.getAttributeNS(tt, ttpNs, 'tickRate');
+          XmlUtils.getAttributeNSList(tt, ttpNs, 'frameRateMultiplier');
+      const tickRate = XmlUtils.getAttributeNSList(tt, ttpNs, 'tickRate');
 
-      const cellResolution = XmlUtils.getAttributeNS(
+      const cellResolution = XmlUtils.getAttributeNSList(
           tt, ttpNs, 'cellResolution');
       const spaceStyle = tt.getAttribute('xml:space') || 'default';
-      const extent = XmlUtils.getAttributeNS(tt, ttsNs, 'extent');
+      const extent = XmlUtils.getAttributeNSList(tt, ttsNs, 'extent');
 
       if (spaceStyle != 'default' && spaceStyle != 'preserve') {
         throw new shaka.util.Error(
@@ -147,28 +148,15 @@ shaka.text.TtmlTextParser = class {
               shaka.util.Error.Code.INVALID_TEXT_CUE,
               '<span> can only be inside <p> in TTML');
         }
+      }
 
-        const pChildren = XmlUtils.findChildren(div, 'p');
-        if (pChildren && pChildren.length) {
-          for (const p of pChildren) {
-            const cue = TtmlTextParser.parseCue_(
-                p, time.periodStart, rateInfo, metadataElements, styles,
-                regionElements, cueRegions, whitespaceTrim,
-                /* isNested= */ false, cellResolutionInfo);
-            if (cue) {
-              cues.push(cue);
-            }
-          }
-        } else {
-          // Only used for parsing the background image
-          const cue = TtmlTextParser.parseCue_(
-              div, time.periodStart, rateInfo, metadataElements, styles,
-              regionElements, cueRegions, whitespaceTrim,
-              /* isNested= */ false, cellResolutionInfo);
-          if (cue) {
-            cues.push(cue);
-          }
-        }
+      const cue = TtmlTextParser.parseCue_(
+          body, time.periodStart, rateInfo, metadataElements, styles,
+          regionElements, cueRegions, whitespaceTrim,
+          cellResolutionInfo, /* parentCueElement= */ null,
+          /* isContent= */ false);
+      if (cue) {
+        cues.push(cue);
       }
     }
 
@@ -186,20 +174,32 @@ shaka.text.TtmlTextParser = class {
    * @param {!Array.<!Element>} regionElements
    * @param {!Array.<!shaka.text.CueRegion>} cueRegions
    * @param {boolean} whitespaceTrim
-   * @param {boolean} isNested
    * @param {?{columns: number, rows: number}} cellResolution
+   * @param {?Element} parentCueElement
+   * @param {boolean} isContent
    * @return {shaka.text.Cue}
    * @private
    */
   static parseCue_(
       cueNode, offset, rateInfo, metadataElements, styles, regionElements,
-      cueRegions, whitespaceTrim, isNested, cellResolution) {
+      cueRegions, whitespaceTrim, cellResolution, parentCueElement, isContent) {
     /** @type {Element} */
     let cueElement;
     /** @type {Element} */
-    let parentElement = /** @type {Element} */(cueNode.parentNode);
+    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) {
+      if (!isContent) {
+        // Ignore text elements outside the content. For example, whitespace
+        // on the same lexical level as the <p> elements, in a document with
+        // xml:space="preserve", should not be renderer.
+        return null;
+      }
       // This should generate an "anonymous span" according to the TTML spec.
       // So pretend the element was a <span>.  parentElement was set above, so
       // we should still be able to correctly traverse up for timing
@@ -214,11 +214,59 @@ shaka.text.TtmlTextParser = class {
     }
     goog.asserts.assert(cueElement, 'cueElement should be non-null!');
 
+    let imageElement = null;
+    for (const nameSpace of shaka.text.TtmlTextParser.smpteNsList_) {
+      imageElement = shaka.text.TtmlTextParser.getElementsFromCollection_(
+          cueElement, 'backgroundImage', metadataElements, '#',
+          nameSpace)[0];
+      if (imageElement) {
+        break;
+      }
+    }
+
+    const parentIsContent = isContent;
+    if (cueNode.nodeName == 'p' || imageElement) {
+      isContent = true;
+    }
+
     const spaceStyle = cueElement.getAttribute('xml:space') ||
         (whitespaceTrim ? 'default' : 'preserve');
 
     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,
+            cellResolution,
+            cueElement,
+            isContent,
+        );
+
+        // This node may or may not generate a nested cue.
+        if (nestedCue) {
+          nestedCues.push(nestedCue);
+        }
+      }
+    }
+
+    const isNested = /** @type {boolean} */ (parentCueElement != null);
+
     // In this regex, "\S" means "non-whitespace character".
     const hasTextContent = /\S/.test(cueElement.textContent);
     const hasTimeAttributes =
@@ -226,7 +274,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 +312,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 +333,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,33 +342,18 @@ 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);
     cue.nestedCues = nestedCues;
 
+    if (!isContent) {
+      // If this is not a <p> element or a <div> with images, and it has no
+      // parent that was a <p> element, then it's part of the outer containers
+      // (e.g. the <body> or a normal <div> element within it).
+      cue.isContainer = true;
+    }
+
     if (cellResolution) {
       cue.cellResolution = cellResolution;
     }
@@ -319,31 +361,32 @@ shaka.text.TtmlTextParser = class {
     // Get other properties if available.
     const regionElement = shaka.text.TtmlTextParser.getElementsFromCollection_(
         cueElement, 'region', regionElements, /* prefix= */ '')[0];
-    if (regionElement && regionElement.getAttribute('xml:id')) {
-      const regionId = regionElement.getAttribute('xml:id');
-      cue.region = cueRegions.filter((region) => region.id == regionId)[0];
-    }
-
-    let imageElement = null;
-    for (const nameSpace of shaka.text.TtmlTextParser.smpteNsList_) {
-      imageElement = shaka.text.TtmlTextParser.getElementsFromCollection_(
-          cueElement, 'backgroundImage', metadataElements, '#',
-          nameSpace)[0];
-      if (imageElement) {
-        break;
+    // Do not actually apply that region unless it is non-inherited, though.
+    // This makes it so that, if a parent element has a region, the children
+    // don't also all independently apply the positioning of that region.
+    if (cueElement.hasAttribute('region')) {
+      if (regionElement && regionElement.getAttribute('xml:id')) {
+        const regionId = regionElement.getAttribute('xml:id');
+        cue.region = cueRegions.filter((region) => region.id == regionId)[0];
       }
     }
 
-    const isLeaf = nestedCues.length == 0;
+    let regionElementForStyle = regionElement;
+    if (parentCueElement && isNested && !cueElement.getAttribute('region') &&
+      !cueElement.getAttribute('style')) {
+      regionElementForStyle =
+          shaka.text.TtmlTextParser.getElementsFromCollection_(
+              parentCueElement, 'region', regionElements, /* prefix= */ '')[0];
+    }
 
     shaka.text.TtmlTextParser.addStyle_(
         cue,
         cueElement,
-        regionElement,
+        regionElementForStyle,
         imageElement,
         styles,
-        isNested,
-        isLeaf);
+        /** isNested= */ parentIsContent, // "nested in a <div>" doesn't count.
+        /** isLeaf= */ (nestedCues.length == 0));
 
     return cue;
   }
@@ -483,14 +526,13 @@ shaka.text.TtmlTextParser = class {
     }
 
     const align = TtmlTextParser.getStyleAttribute_(
-        cueElement, region, styles, 'textAlign', shouldInheritRegionStyles);
+        cueElement, region, styles, 'textAlign', true);
     if (align) {
       cue.positionAlign = TtmlTextParser.textAlignToPositionAlign_[align];
       cue.lineAlign = TtmlTextParser.textAlignToLineAlign_[align];
 
       goog.asserts.assert(align.toUpperCase() in Cue.textAlign,
-          align.toUpperCase() +
-                          ' Should be in Cue.textAlign values!');
+          align.toUpperCase() + ' Should be in Cue.textAlign values!');
 
       cue.textAlign = Cue.textAlign[align.toUpperCase()];
     } else {
@@ -499,7 +541,7 @@ shaka.text.TtmlTextParser = class {
     }
 
     const displayAlign = TtmlTextParser.getStyleAttribute_(
-        cueElement, region, styles, 'displayAlign', shouldInheritRegionStyles);
+        cueElement, region, styles, 'displayAlign', true);
     if (displayAlign) {
       goog.asserts.assert(displayAlign.toUpperCase() in Cue.displayAlign,
           displayAlign.toUpperCase() +
@@ -731,7 +773,7 @@ shaka.text.TtmlTextParser = class {
       return null;
     }
 
-    const attr = XmlUtils.getAttributeNS(region, ttsNs, attribute);
+    const attr = XmlUtils.getAttributeNSList(region, ttsNs, attribute);
     if (attr) {
       return attr;
     }
@@ -756,7 +798,7 @@ shaka.text.TtmlTextParser = class {
 
     // Styling on elements should take precedence
     // over the main styling attributes
-    const elementAttribute = XmlUtils.getAttributeNS(
+    const elementAttribute = XmlUtils.getAttributeNSList(
         cueElement,
         ttsNs,
         attribute);
@@ -799,7 +841,7 @@ shaka.text.TtmlTextParser = class {
 
       if (!styleAttributeValue) {
         // Fall back to tts namespace.
-        styleAttributeValue = XmlUtils.getAttributeNS(
+        styleAttributeValue = XmlUtils.getAttributeNSList(
             inheritedStyles[i],
             ttsNs,
             attribute);
@@ -1254,20 +1296,26 @@ shaka.text.TtmlTextParser.textAlignToPositionAlign_ = {
  * document, not just "ttp:", so we use this with getAttributeNS() to ensure
  * that we support arbitrary namespace names.
  *
- * @const {string}
+ * @const {!Array.<string>}
  * @private
  */
-shaka.text.TtmlTextParser.parameterNs_ = 'http://www.w3.org/ns/ttml#parameter';
+shaka.text.TtmlTextParser.parameterNs_ = [
+  'http://www.w3.org/ns/ttml#parameter',
+  'http://www.w3.org/2006/10/ttaf1#parameter',
+];
 
 /**
  * The namespace URL for TTML styles.  Can be assigned any name in the TTML
  * document, not just "tts:", so we use this with getAttributeNS() to ensure
  * that we support arbitrary namespace names.
  *
- * @const {string}
+ * @const {!Array.<string>}
  * @private
  */
-shaka.text.TtmlTextParser.styleNs_ = 'http://www.w3.org/ns/ttml#styling';
+shaka.text.TtmlTextParser.styleNs_ = [
+  'http://www.w3.org/ns/ttml#styling',
+  'http://www.w3.org/2006/10/ttaf1#styling',
+];
 
 /**
  * The namespace URL for EBU TTML styles.  Can be assigned any name in the TTML