shaka-player 4.4.3 → 4.6.0

package/lib/polyfill/mediasource.js

@@ -40,7 +40,18 @@ shaka.polyfill.MediaSource = class {
     } else if (safariVersion) {
       // NOTE:  shaka.Player.isBrowserSupported() has its own restrictions on
       // Safari version.
-      if (safariVersion <= 12) {
+      if (safariVersion <= 10) {
+        // Safari 8 does not implement appendWindowEnd.
+        // Safari 9 & 10 do not correctly implement abort() on SourceBuffer.
+        // Bug filed: https://bugs.webkit.org/show_bug.cgi?id=160316
+        // Blacklist these very outdated versions.
+        // Bug filed: https://bugs.webkit.org/show_bug.cgi?id=165342
+        // Safari 10 fires spurious 'updateend' events after endOfStream().
+        // Bug filed: https://bugs.webkit.org/show_bug.cgi?id=165336
+
+        shaka.log.info('Blacklisting MSE on Safari <= 10.');
+        shaka.polyfill.MediaSource.blacklist_();
+      } else if (safariVersion <= 12) {
         shaka.log.info('Patching Safari 11 & 12 MSE bugs.');
         // Safari 11 & 12 do not correctly implement abort() on SourceBuffer.
         // Calling abort() before appending a segment causes that segment to be
@@ -89,6 +100,16 @@ shaka.polyfill.MediaSource = class {
     }
   }
 
+  /**
+   * Blacklist the current browser by making
+   * MediaSourceEngine.isBrowserSupported fail later.
+   *
+   * @private
+   */
+  static blacklist_() {
+    window['MediaSource'] = null;
+  }
+
   /**
    * Stub out abort().  On some buggy MSE implementations, calling abort()
    * causes various problems.

package/lib/text/cue.js

@@ -222,6 +222,13 @@ shaka.text.Cue = class {
      */
     this.opacity = 1;
 
+    /**
+     * Text combine upright as a CSS text-combine-upright value.
+     * @type {string}
+     * @export
+     */
+    this.textCombineUpright = '';
+
     /**
      * Text decoration. A combination of underline, overline
      * and line through. Empty array means no decoration.
@@ -292,6 +299,14 @@ shaka.text.Cue = class {
      */
     this.lineBreak = false;
 
+    /**
+     * Used to indicate the type of ruby tag that should be used when rendering
+     * the cue. Valid values: ruby, rp, rt.
+     * @type {?string}
+     * @export
+     */
+    this.rubyTag = null;
+
     /**
      * The number of horizontal and vertical cells into which the Root Container
      * Region area is divided.

package/lib/text/mp4_ttml_parser.js

@@ -75,7 +75,7 @@ shaka.text.Mp4TtmlParser = class {
    * @override
    * @export
    */
-  parseMedia(data, time) {
+  parseMedia(data, time, uri) {
     const Mp4Parser = shaka.util.Mp4Parser;
 
     let sawMDAT = false;
@@ -86,7 +86,7 @@ shaka.text.Mp4TtmlParser = class {
           sawMDAT = true;
           // Join this to any previous payload, in case the mp4 has multiple
           // mdats.
-          payload = payload.concat(this.parser_.parseMedia(data, time));
+          payload = payload.concat(this.parser_.parseMedia(data, time, uri));
         }));
     parser.parse(data, /* partialOkay= */ false);
 

package/lib/text/srt_text_parser.js

@@ -55,7 +55,7 @@ shaka.text.SrtTextParser = class {
    * @override
    * @export
    */
-  parseMedia(data, time) {
+  parseMedia(data, time, uri) {
     const SrtTextParser = shaka.text.SrtTextParser;
     const BufferUtils = shaka.util.BufferUtils;
     const StringUtils = shaka.util.StringUtils;
@@ -67,7 +67,7 @@ shaka.text.SrtTextParser = class {
 
     const newData = BufferUtils.toUint8(StringUtils.toUTF8(vvtText));
 
-    return this.parser_.parseMedia(newData, time);
+    return this.parser_.parseMedia(newData, time, uri);
   }
 
   /**

package/lib/text/stub_text_displayer.js

@@ -0,0 +1,51 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+goog.provide('shaka.text.StubTextDisplayer');
+
+/**
+* A stub text displayer plugin that does nothing
+*
+* @implements {shaka.extern.TextDisplayer}
+* @export
+*/
+shaka.text.StubTextDisplayer = class {
+  /**
+   * @override
+   * @export
+   */
+  remove(start, end) {
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  append(cues) {
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  destroy() {
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  isTextVisible() {
+    return false;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  setTextVisibility(on) {
+  }
+};

package/lib/text/text_engine.js

@@ -166,9 +166,10 @@ shaka.text.TextEngine = class {
    * @param {BufferSource} buffer
    * @param {?number} startTime relative to the start of the presentation
    * @param {?number} endTime relative to the start of the presentation
+   * @param {?string=} uri
    * @return {!Promise}
    */
-  async appendBuffer(buffer, startTime, endTime) {
+  async appendBuffer(buffer, startTime, endTime, uri) {
     goog.asserts.assert(
         this.parser_, 'The parser should already be initialized');
 
@@ -198,7 +199,7 @@ shaka.text.TextEngine = class {
 
     // Parse the buffer and add the new cues.
     const allCues = this.parser_.parseMedia(
-        shaka.util.BufferUtils.toUint8(buffer), time);
+        shaka.util.BufferUtils.toUint8(buffer), time, uri);
     const cuesToAppend = allCues.filter((cue) => {
       return cue.startTime >= this.appendWindowStart_ &&
           cue.startTime < this.appendWindowEnd_;

package/lib/text/ttml_text_parser.js

@@ -7,6 +7,7 @@
 goog.provide('shaka.text.TtmlTextParser');
 
 goog.require('goog.asserts');
+goog.require('goog.Uri');
 goog.require('shaka.log');
 goog.require('shaka.text.Cue');
 goog.require('shaka.text.CueRegion');
@@ -50,7 +51,7 @@ shaka.text.TtmlTextParser = class {
    * @override
    * @export
    */
-  parseMedia(data, time) {
+  parseMedia(data, time, uri) {
     const TtmlTextParser = shaka.text.TtmlTextParser;
     const XmlUtils = shaka.util.XmlUtils;
     const ttpNs = TtmlTextParser.parameterNs_;
@@ -147,7 +148,7 @@ shaka.text.TtmlTextParser = class {
         body, time, rateInfo, metadataElements, styles,
         regionElements, cueRegions, whitespaceTrim,
         cellResolutionInfo, /* parentCueElement= */ null,
-        /* isContent= */ false);
+        /* isContent= */ false, uri);
     if (cue) {
       // According to the TTML spec, backgrounds default to transparent.
       // So default the background of the top-level element to transparent.
@@ -175,12 +176,14 @@ shaka.text.TtmlTextParser = class {
    * @param {?{columns: number, rows: number}} cellResolution
    * @param {?Element} parentCueElement
    * @param {boolean} isContent
+   * @param {?(string|undefined)} uri
    * @return {shaka.text.Cue}
    * @private
    */
   static parseCue_(
       cueNode, timeContext, rateInfo, metadataElements, styles, regionElements,
-      cueRegions, whitespaceTrim, cellResolution, parentCueElement, isContent) {
+      cueRegions, whitespaceTrim, cellResolution, parentCueElement, isContent,
+      uri) {
     /** @type {Element} */
     let cueElement;
     /** @type {Element} */
@@ -222,7 +225,21 @@ shaka.text.TtmlTextParser = class {
       }
     }
 
-    if (cueNode.nodeName == 'p' || imageElement) {
+    let imageUri = null;
+    const backgroundImage = shaka.util.XmlUtils.getAttributeNSList(
+        cueElement,
+        shaka.text.TtmlTextParser.smpteNsList_,
+        'backgroundImage');
+    if (uri && backgroundImage && !backgroundImage.startsWith('#')) {
+      const baseUri = new goog.Uri(uri);
+      const relativeUri = new goog.Uri(backgroundImage);
+      const newUri = baseUri.resolve(relativeUri).toString();
+      if (newUri) {
+        imageUri = newUri;
+      }
+    }
+
+    if (cueNode.nodeName == 'p' || imageElement || imageUri) {
       isContent = true;
     }
 
@@ -255,6 +272,7 @@ shaka.text.TtmlTextParser = class {
             cellResolution,
             cueElement,
             isContent,
+            uri,
         );
 
         // This node may or may not generate a nested cue.
@@ -388,6 +406,7 @@ shaka.text.TtmlTextParser = class {
         cueElement,
         regionElementForStyle,
         imageElement,
+        imageUri,
         styles,
         /** isNested= */ parentIsContent, // "nested in a <div>" doesn't count.
         /** isLeaf= */ (nestedCues.length == 0));
@@ -490,13 +509,15 @@ shaka.text.TtmlTextParser = class {
    * @param {!Element} cueElement
    * @param {Element} region
    * @param {Element} imageElement
+   * @param {?string} imageUri
    * @param {!Array.<!Element>} styles
    * @param {boolean} isNested
    * @param {boolean} isLeaf
    * @private
    */
   static addStyle_(
-      cue, cueElement, region, imageElement, styles, isNested, isLeaf) {
+      cue, cueElement, region, imageElement, imageUri, styles,
+      isNested, isLeaf) {
     const TtmlTextParser = shaka.text.TtmlTextParser;
     const Cue = shaka.text.Cue;
 
@@ -664,6 +685,8 @@ shaka.text.TtmlTextParser = class {
           backgroundImageData) {
         cue.backgroundImage = 'data:image/png;base64,' + backgroundImageData;
       }
+    } else if (imageUri) {
+      cue.backgroundImage = imageUri;
     }
 
     const textOutline = TtmlTextParser.getStyleAttribute_(
@@ -724,6 +747,23 @@ shaka.text.TtmlTextParser = class {
     if (textDecorationElement) {
       TtmlTextParser.addTextDecoration_(cue, textDecorationElement);
     }
+
+    const textCombine = TtmlTextParser.getStyleAttribute_(
+        cueElement, region, styles, 'textCombine', shouldInheritRegionStyles);
+    if (textCombine) {
+      cue.textCombineUpright = textCombine;
+    }
+
+    const ruby = TtmlTextParser.getStyleAttribute_(
+        cueElement, region, styles, 'ruby', shouldInheritRegionStyles);
+    switch (ruby) {
+      case 'container':
+        cue.rubyTag = 'ruby';
+        break;
+      case 'text':
+        cue.rubyTag = 'rt';
+        break;
+    }
   }
 
   /**

package/lib/text/ui_text_displayer.js

@@ -452,6 +452,9 @@ shaka.text.UITextDisplayer = class {
     if (cue.lineBreak) {
       type = 'br';
     }
+    if (cue.rubyTag) {
+      type = cue.rubyTag;
+    }
 
     const needWrapper = !isNested && cue.nestedCues.length > 0;
 
@@ -561,6 +564,7 @@ shaka.text.UITextDisplayer = class {
     style.paddingRight =
         shaka.text.UITextDisplayer.convertLengthValue_(
             cue.linePadding, cue, this.videoContainer_);
+    style.textCombineUpright = cue.textCombineUpright;
     style.textShadow = cue.textShadow;
 
     if (cue.backgroundImage) {
@@ -600,6 +604,10 @@ shaka.text.UITextDisplayer = class {
           // Only do this for the text itself.
           elem.style.backgroundColor = 'rgba(0, 0, 0, 0.8)';
         }
+        const fontFamily = inherit((c) => c.fontFamily);
+        if (fontFamily) {
+          elem.style.fontFamily = fontFamily;
+        }
       }
       if (text) {
         elem.textContent = text;

package/lib/text/vtt_text_parser.js

@@ -333,6 +333,10 @@ shaka.text.VttTextParser = class {
               validStyle = true;
               cue.opacity = parseFloat(value);
               break;
+            case 'text-combine-upright':
+              validStyle = true;
+              cue.textCombineUpright = value;
+              break;
             case 'text-shadow':
               validStyle = true;
               cue.textShadow = value;
@@ -417,8 +421,6 @@ shaka.text.VttTextParser = class {
       cue = new shaka.text.Cue(start, end, '');
     }
 
-    VttTextParser.parseCueStyles(payload, cue, styles);
-
     // Parse optional settings.
     parser.skipWhitespace();
     let word = parser.readWord();
@@ -432,6 +434,8 @@ shaka.text.VttTextParser = class {
       word = parser.readWord();
     }
 
+    VttTextParser.parseCueStyles(payload, cue, styles);
+
     if (id != null) {
       cue.id = id;
     }
@@ -456,8 +460,6 @@ shaka.text.VttTextParser = class {
     const xmlPayload = '<span>' + payload + '</span>';
     const element = shaka.util.XmlUtils.parseXmlString(xmlPayload, 'span');
     if (element) {
-      /** @type {!Array.<!shaka.text.Cue>} */
-      const cues = [];
       const childNodes = element.childNodes;
       if (childNodes.length == 1) {
         const childNode = childNodes[0];
@@ -468,10 +470,8 @@ shaka.text.VttTextParser = class {
         }
       }
       for (const childNode of childNodes) {
-        VttTextParser.generateCueFromElement_(
-            childNode, rootCue, cues, styles);
+        VttTextParser.generateCueFromElement_(childNode, rootCue, styles);
       }
-      rootCue.nestedCues = cues;
     } else {
       shaka.log.warning('The cue\'s markup could not be parsed: ', payload);
       rootCue.payload = VttTextParser.htmlUnescape_(payload);
@@ -688,6 +688,8 @@ shaka.text.VttTextParser = class {
     cue.fontWeight = refCue.fontWeight;
     cue.fontStyle = refCue.fontStyle;
     cue.opacity = refCue.opacity;
+    cue.rubyTag = refCue.rubyTag;
+    cue.textCombineUpright = refCue.textCombineUpright;
     cue.textShadow = refCue.textShadow;
     cue.wrapLine = refCue.wrapLine;
   }
@@ -695,13 +697,21 @@ shaka.text.VttTextParser = class {
   /**
    * @param {!Node} element
    * @param {!shaka.text.Cue} rootCue
-   * @param {Array.<!shaka.text.Cue>} cues
    * @param {!Map.<string, shaka.text.Cue>} styles
    * @private
    */
-  static generateCueFromElement_(element, rootCue, cues, styles) {
+  static generateCueFromElement_(element, rootCue, styles) {
     const VttTextParser = shaka.text.VttTextParser;
     const nestedCue = rootCue.clone();
+    // We don't want propagate some properties.
+    nestedCue.nestedCues = [];
+    nestedCue.payload = '';
+    nestedCue.rubyTag = '';
+    // We don't want propagate some position settings
+    nestedCue.line = null;
+    nestedCue.region = new shaka.text.CueRegion();
+    nestedCue.position = null;
+    nestedCue.size = 0;
     if (element.nodeType === Node.ELEMENT_NODE && element.nodeName) {
       const bold = shaka.text.Cue.fontWeight.BOLD;
       const italic = shaka.text.Cue.fontStyle.ITALIC;
@@ -724,10 +734,10 @@ shaka.text.VttTextParser = class {
         }
         switch (tag) {
           case 'br': {
-            const lineBreakCue = rootCue.clone();
-            lineBreakCue.lineBreak = true;
-            cues.push(lineBreakCue);
-            break;
+            const lineBreakCue = shaka.text.Cue.lineBreak(
+                nestedCue.startTime, nestedCue.endTime);
+            rootCue.nestedCues.push(lineBreakCue);
+            return;
           }
           case 'b':
             nestedCue.fontWeight = bold;
@@ -758,34 +768,42 @@ shaka.text.VttTextParser = class {
             }
             break;
           }
+          case 'ruby':
+          case 'rp':
+          case 'rt':
+            nestedCue.rubyTag = tag;
+            break;
           default:
             break;
         }
       }
     }
-    const isTextNode = shaka.util.XmlUtils.isText(element);
-    if (isTextNode) {
+
+    const isTextNode = (item) => shaka.util.XmlUtils.isText(item);
+    const childNodes = element.childNodes;
+    if (isTextNode(element) ||
+        (childNodes.length == 1 && isTextNode(childNodes[0]))) {
       // Trailing line breaks may lost when convert cue to HTML tag
       // Need to insert line break cue to preserve line breaks
       const textArr = element.textContent.split('\n');
       let isFirst = true;
       for (const text of textArr) {
         if (!isFirst) {
-          const lineBreakCue = rootCue.clone();
-          lineBreakCue.lineBreak = true;
-          cues.push(lineBreakCue);
+          const lineBreakCue = shaka.text.Cue.lineBreak(
+              nestedCue.startTime, nestedCue.endTime);
+          rootCue.nestedCues.push(lineBreakCue);
         }
         if (text.length > 0) {
           const textCue = nestedCue.clone();
           textCue.payload = VttTextParser.htmlUnescape_(text);
-          cues.push(textCue);
+          rootCue.nestedCues.push(textCue);
         }
         isFirst = false;
       }
     } else {
-      for (const childNode of element.childNodes) {
-        VttTextParser.generateCueFromElement_(
-            childNode, nestedCue, cues, styles);
+      rootCue.nestedCues.push(nestedCue);
+      for (const childNode of childNodes) {
+        VttTextParser.generateCueFromElement_(childNode, nestedCue, styles);
       }
     }
   }

package/lib/transmuxer/aac_transmuxer.js

@@ -95,7 +95,7 @@ shaka.transmuxer.AacTransmuxer = class {
    * @override
    * @export
    */
-  getOrginalMimeType() {
+  getOriginalMimeType() {
     return this.originalMimeType_;
   }
 

package/lib/transmuxer/ac3_transmuxer.js

@@ -93,7 +93,7 @@ shaka.transmuxer.Ac3Transmuxer = class {
    * @override
    * @export
    */
-  getOrginalMimeType() {
+  getOriginalMimeType() {
     return this.originalMimeType_;
   }
 

package/lib/transmuxer/ec3_transmuxer.js

@@ -93,7 +93,7 @@ shaka.transmuxer.Ec3Transmuxer = class {
    * @override
    * @export
    */
-  getOrginalMimeType() {
+  getOriginalMimeType() {
     return this.originalMimeType_;
   }
 

package/lib/transmuxer/h264.js

@@ -175,7 +175,7 @@ shaka.transmuxer.H264 = class {
   static parseFrame(nalus) {
     const H264 = shaka.transmuxer.H264;
     let isKeyframe = false;
-    let data = new Uint8Array([]);
+    const nalusData = [];
     const spsNalu = nalus.find((nalu) => {
       return nalu.type == H264.NALU_TYPE_SPS_;
     });
@@ -240,13 +240,14 @@ shaka.transmuxer.H264 = class {
         naluLength[1] = (size >> 16) & 0xff;
         naluLength[2] = (size >> 8) & 0xff;
         naluLength[3] = size & 0xff;
-        data = shaka.util.Uint8ArrayUtils.concat(
-            data, naluLength, nalu.fullData);
+        nalusData.push(shaka.util.Uint8ArrayUtils.concat(
+            naluLength, nalu.fullData));
       }
     }
-    if (!data.byteLength) {
+    if (!nalusData.length) {
       return null;
     }
+    const data = shaka.util.Uint8ArrayUtils.concat(...nalusData);
     return {
       data,
       isKeyframe,