shaka-player 4.4.1 → 4.4.3

package/lib/text/cue.js

@@ -26,7 +26,7 @@ shaka.text.Cue = class {
      * The start time of the cue in seconds, relative to the start of the
      * presentation.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.startTime = startTime;
 
@@ -34,7 +34,7 @@ shaka.text.Cue = class {
      * The end time of the cue in seconds, relative to the start of the
      * presentation.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.endTime = endTime;
 
@@ -42,7 +42,7 @@ shaka.text.Cue = class {
      * The text payload of the cue.  If nestedCues is non-empty, this should be
      * empty.  Top-level block containers should have no payload of their own.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.payload = payload;
 
@@ -50,7 +50,7 @@ shaka.text.Cue = class {
      * The region to render the cue into.  Only supported on top-level cues,
      * because nested cues are inline elements.
      * @type {shaka.text.CueRegion}
-     * @exportDoc
+     * @export
      */
     this.region = new shaka.text.CueRegion();
 
@@ -58,42 +58,42 @@ shaka.text.Cue = class {
      * The indent (in percent) of the cue box in the direction defined by the
      * writing direction.
      * @type {?number}
-     * @exportDoc
+     * @export
      */
     this.position = null;
 
     /**
      * Position alignment of the cue.
      * @type {shaka.text.Cue.positionAlign}
-     * @exportDoc
+     * @export
      */
     this.positionAlign = Cue.positionAlign.AUTO;
 
     /**
      * Size of the cue box (in percents), where 0 means "auto".
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.size = 0;
 
     /**
      * Alignment of the text inside the cue box.
      * @type {shaka.text.Cue.textAlign}
-     * @exportDoc
+     * @export
      */
     this.textAlign = Cue.textAlign.CENTER;
 
     /**
      * Text direction of the cue.
      * @type {shaka.text.Cue.direction}
-     * @exportDoc
+     * @export
      */
     this.direction = Cue.direction.HORIZONTAL_LEFT_TO_RIGHT;
 
     /**
      * Text writing mode of the cue.
      * @type {shaka.text.Cue.writingMode}
-     * @exportDoc
+     * @export
      */
     this.writingMode = Cue.writingMode.HORIZONTAL_TOP_TO_BOTTOM;
 
@@ -101,7 +101,7 @@ shaka.text.Cue = class {
      * The way to interpret line field. (Either as an integer line number or
      * percentage from the display box).
      * @type {shaka.text.Cue.lineInterpretation}
-     * @exportDoc
+     * @export
      */
     this.lineInterpretation = Cue.lineInterpretation.LINE_NUMBER;
 
@@ -109,7 +109,7 @@ shaka.text.Cue = class {
      * The offset from the display box in either number of lines or
      * percentage depending on the value of lineInterpretation.
      * @type {?number}
-     * @exportDoc
+     * @export
      */
     this.line = null;
 
@@ -118,7 +118,7 @@ shaka.text.Cue = class {
      * (e.g. '100px'/'100em'). If not specified, this should be no less than
      * the largest font size applied to the text in the cue.
      * @type {string}.
-     * @exportDoc
+     * @export
      */
     this.lineHeight = '';
 
@@ -132,7 +132,7 @@ shaka.text.Cue = class {
      * (for vertical growing right), or left side (for vertical growing left) is
      * aligned at the line.
      * @type {shaka.text.Cue.lineAlign}
-     * @exportDoc
+     * @export
      */
     this.lineAlign = Cue.lineAlign.START;
 
@@ -141,84 +141,84 @@ shaka.text.Cue = class {
      * 'BEFORE' means displaying the captions at the top of the text display
      * container box, 'CENTER' means in the middle, 'AFTER' means at the bottom.
      * @type {shaka.text.Cue.displayAlign}
-     * @exportDoc
+     * @export
      */
     this.displayAlign = Cue.displayAlign.AFTER;
 
     /**
      * Text color as a CSS color, e.g. "#FFFFFF" or "white".
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.color = '';
 
     /**
      * Text background color as a CSS color, e.g. "#FFFFFF" or "white".
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.backgroundColor = '';
 
     /**
      * The URL of the background image, e.g. "data:[mime type];base64,[data]".
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.backgroundImage = '';
 
     /**
      * The border around this cue as a CSS border.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.border = '';
 
     /**
      * Text font size in px or em (e.g. '100px'/'100em').
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.fontSize = '';
 
     /**
      * Text font weight. Either normal or bold.
      * @type {shaka.text.Cue.fontWeight}
-     * @exportDoc
+     * @export
      */
     this.fontWeight = Cue.fontWeight.NORMAL;
 
     /**
      * Text font style. Normal, italic or oblique.
      * @type {shaka.text.Cue.fontStyle}
-     * @exportDoc
+     * @export
      */
     this.fontStyle = Cue.fontStyle.NORMAL;
 
     /**
      * Text font family.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.fontFamily = '';
 
     /**
      * Text letter spacing as a CSS letter-spacing value.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.letterSpacing = '';
 
     /**
      * Text line padding as a CSS line-padding value.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.linePadding = '';
 
     /**
      * Opacity of the cue element, from 0-1.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.opacity = 1;
 
@@ -226,42 +226,42 @@ shaka.text.Cue = class {
      * Text decoration. A combination of underline, overline
      * and line through. Empty array means no decoration.
      * @type {!Array.<!shaka.text.Cue.textDecoration>}
-     * @exportDoc
+     * @export
      */
     this.textDecoration = [];
 
     /**
      * Text shadow color as a CSS text-shadow value.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.textShadow = '';
 
     /**
      * Text stroke color as a CSS color, e.g. "#FFFFFF" or "white".
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.textStrokeColor = '';
 
     /**
      * Text stroke width as a CSS stroke-width value.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.textStrokeWidth = '';
 
     /**
      * Whether or not line wrapping should be applied to the cue.
      * @type {boolean}
-     * @exportDoc
+     * @export
      */
     this.wrapLine = true;
 
     /**
      * Id of the cue.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.id = '';
 
@@ -270,7 +270,7 @@ shaka.text.Cue = class {
      * Top-level cues are blocks, and nested cues are inline elements.
      * Cues can be nested arbitrarily deeply.
      * @type {!Array.<!shaka.text.Cue>}
-     * @exportDoc
+     * @export
      */
     this.nestedCues = [];
 
@@ -280,7 +280,7 @@ shaka.text.Cue = class {
      * in a TTML file. This controls the flow of the final cues; any nested cues
      * within an "isContainer" cue will be laid out as separate lines.
      * @type {boolean}
-     * @exportDoc
+     * @export
      */
     this.isContainer = false;
 
@@ -288,7 +288,7 @@ shaka.text.Cue = class {
      * Whether or not the cue only acts as a line break between two nested cues.
      * Should only appear in nested cues.
      * @type {boolean}
-     * @exportDoc
+     * @export
      */
     this.lineBreak = false;
 
@@ -297,7 +297,7 @@ shaka.text.Cue = class {
      * Region area is divided.
      *
      * @type {{ columns: number, rows: number }}
-     * @exportDoc
+     * @export
      */
     this.cellResolution = {
       columns: 32,
@@ -551,7 +551,7 @@ shaka.text.CueRegion = class {
     /**
      * Region identifier.
      * @type {string}
-     * @exportDoc
+     * @export
      */
     this.id = '';
 
@@ -559,7 +559,7 @@ shaka.text.CueRegion = class {
      * The X offset to start the rendering area in viewportAnchorUnits of the
      * video width.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.viewportAnchorX = 0;
 
@@ -567,7 +567,7 @@ shaka.text.CueRegion = class {
      * The X offset to start the rendering area in viewportAnchorUnits of the
      * video height.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.viewportAnchorY = 0;
 
@@ -575,7 +575,7 @@ shaka.text.CueRegion = class {
      * The X offset to start the rendering area in percentage (0-100) of this
      * region width.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.regionAnchorX = 0;
 
@@ -583,42 +583,42 @@ shaka.text.CueRegion = class {
      * The Y offset to start the rendering area in percentage (0-100) of the
      * region height.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.regionAnchorY = 0;
 
     /**
      * The width of the rendering area in widthUnits.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.width = 100;
 
     /**
      * The width of the rendering area in heightUnits.
      * @type {number}
-     * @exportDoc
+     * @export
      */
     this.height = 100;
 
     /**
      * The units (percentage, pixels or lines) the region height is in.
      * @type {shaka.text.CueRegion.units}
-     * @exportDoc
+     * @export
      */
     this.heightUnits = CueRegion.units.PERCENTAGE;
 
     /**
      * The units (percentage or pixels) the region width is in.
      * @type {shaka.text.CueRegion.units}
-     * @exportDoc
+     * @export
      */
     this.widthUnits = CueRegion.units.PERCENTAGE;
 
     /**
      * The units (percentage or pixels) the region viewportAnchors are in.
      * @type {shaka.text.CueRegion.units}
-     * @exportDoc
+     * @export
      */
     this.viewportAnchorUnits = CueRegion.units.PERCENTAGE;
 
@@ -628,7 +628,7 @@ shaka.text.CueRegion = class {
      * region up.  Otherwise (scroll=NONE) cues will stay fixed at the location
      * they were first painted in.
      * @type {shaka.text.CueRegion.scrollMode}
-     * @exportDoc
+     * @export
      */
     this.scroll = CueRegion.scrollMode.NONE;
   }

package/lib/text/lrc_text_parser.js

@@ -36,6 +36,14 @@ shaka.text.LrcTextParser = class {
     // Unused.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/mp4_ttml_parser.js

@@ -63,6 +63,14 @@ shaka.text.Mp4TtmlParser = class {
     // Unused.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/mp4_vtt_parser.js

@@ -92,6 +92,14 @@ shaka.text.Mp4VttParser = class {
     // Unused.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/sbv_text_parser.js

@@ -35,6 +35,14 @@ shaka.text.SbvTextParser = class {
     // Unused.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/srt_text_parser.js

@@ -43,6 +43,14 @@ shaka.text.SrtTextParser = class {
     // Unused.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/ssa_text_parser.js

@@ -36,6 +36,14 @@ shaka.text.SsaTextParser = class {
     // Unused.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/text_engine.js

@@ -132,8 +132,9 @@ shaka.text.TextEngine = class {
    * @param {string} mimeType
    * @param {boolean} sequenceMode
    * @param {boolean} segmentRelativeVttTiming
+   * @param {string} manifestType
    */
-  initParser(mimeType, sequenceMode, segmentRelativeVttTiming) {
+  initParser(mimeType, sequenceMode, segmentRelativeVttTiming, manifestType) {
     // No parser for CEA, which is extracted from video and side-loaded
     // into TextEngine and TextDisplayer.
     if (mimeType == shaka.util.MimeUtils.CEA608_CLOSED_CAPTION_MIMETYPE ||
@@ -152,6 +153,12 @@ shaka.text.TextEngine = class {
       shaka.log.alwaysWarn(
           'Text parsers should have a "setSequenceMode" method!');
     }
+    if (this.parser_.setManifestType) {
+      this.parser_.setManifestType(manifestType);
+    } else {
+      shaka.log.alwaysWarn(
+          'Text parsers should have a "setManifestType" method!');
+    }
     this.segmentRelativeVttTiming_ = segmentRelativeVttTiming;
   }
 

package/lib/text/ttml_text_parser.js

@@ -38,6 +38,14 @@ shaka.text.TtmlTextParser = class {
     // Unused.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export
@@ -214,11 +222,12 @@ shaka.text.TtmlTextParser = class {
       }
     }
 
-    const parentIsContent = isContent;
     if (cueNode.nodeName == 'p' || imageElement) {
       isContent = true;
     }
 
+    const parentIsContent = isContent;
+
     const spaceStyle = cueElement.getAttribute('xml:space') ||
         (whitespaceTrim ? 'default' : 'preserve');
 

package/lib/text/ui_text_displayer.js

@@ -481,6 +481,43 @@ shaka.text.UITextDisplayer = class {
     this.currentCuesMap_.set(cue, {cueElement, wrapper, regionElement});
   }
 
+  /**
+   * Compute cue position alignment
+   * See https://www.w3.org/TR/webvtt1/#webvtt-cue-position-alignment
+   *
+   * @param {!shaka.text.Cue} cue
+   * @private
+   */
+  computeCuePositionAlignment_(cue) {
+    const Cue = shaka.text.Cue;
+    const {direction, positionAlign, textAlign} = cue;
+
+    if (positionAlign !== Cue.positionAlign.AUTO) {
+      // Position align is not AUTO: use it
+      return positionAlign;
+    }
+
+    // Position align is AUTO: use text align to compute its value
+
+    if (textAlign === Cue.textAlign.LEFT ||
+      (textAlign === Cue.textAlign.START &&
+        direction === Cue.direction.HORIZONTAL_LEFT_TO_RIGHT) ||
+      (textAlign === Cue.textAlign.END &&
+        direction === Cue.direction.HORIZONTAL_RIGHT_TO_LEFT)) {
+      return Cue.positionAlign.LEFT;
+    }
+
+    if (textAlign === Cue.textAlign.RIGHT ||
+      (textAlign === Cue.textAlign.START &&
+        direction === Cue.direction.HORIZONTAL_RIGHT_TO_LEFT) ||
+      (textAlign === Cue.textAlign.END &&
+        direction === Cue.direction.HORIZONTAL_LEFT_TO_RIGHT)) {
+      return Cue.positionAlign.RIGHT;
+    }
+
+    return Cue.positionAlign.CENTER;
+  }
+
   /**
    * @param {!HTMLElement} cueElement
    * @param {!shaka.text.Cue} cue
@@ -617,7 +654,15 @@ shaka.text.UITextDisplayer = class {
     // TODO: Implement line alignment with line number.
     // TODO: Implement lineAlignment of 'CENTER'.
     if (cue.line != null) {
-      if (cue.lineInterpretation == Cue.lineInterpretation.PERCENTAGE) {
+      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) {
+        lineInterpretation = Cue.lineInterpretation.PERCENTAGE;
+      }
+      if (lineInterpretation == Cue.lineInterpretation.PERCENTAGE) {
         style.position = 'absolute';
         if (cue.writingMode == Cue.writingMode.HORIZONTAL_TOP_TO_BOTTOM) {
           style.width = '100%';
@@ -658,9 +703,10 @@ shaka.text.UITextDisplayer = class {
 
     // The positionAlign attribute is an alignment for the text container in
     // the dimension of the writing direction.
-    if (cue.positionAlign == Cue.positionAlign.LEFT) {
+    const computedPositionAlign = this.computeCuePositionAlignment_(cue);
+    if (computedPositionAlign == Cue.positionAlign.LEFT) {
       style.cssFloat = 'left';
-    } else if (cue.positionAlign == Cue.positionAlign.RIGHT) {
+    } else if (computedPositionAlign == Cue.positionAlign.RIGHT) {
       style.cssFloat = 'right';
     }
 

package/lib/text/vtt_text_parser.js

@@ -8,6 +8,7 @@ goog.provide('shaka.text.VttTextParser');
 
 goog.require('goog.asserts');
 goog.require('shaka.log');
+goog.require('shaka.media.ManifestParser');
 goog.require('shaka.text.Cue');
 goog.require('shaka.text.CueRegion');
 goog.require('shaka.text.TextEngine');
@@ -26,6 +27,9 @@ shaka.text.VttTextParser = class {
   constructor() {
     /** @private {boolean} */
     this.sequenceMode_ = false;
+
+    /** @private {string} */
+    this.manifestType_ = shaka.media.ManifestParser.UNKNOWN;
   }
 
   /**
@@ -44,6 +48,14 @@ shaka.text.VttTextParser = class {
     this.sequenceMode_ = sequenceMode;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setManifestType(manifestType) {
+    this.manifestType_ = manifestType;
+  }
+
   /**
    * @override
    * @export
@@ -72,10 +84,9 @@ shaka.text.VttTextParser = class {
     // HLS content, which should use X-TIMESTAMP-MAP and periodStart instead.
     let offset = time.vttOffset;
 
-    // Only use 'X-TIMESTAMP-MAP' in sequence mode, as that is currently
-    // shorthand for HLS.  Note that an offset based on the first video
+    // Only use 'X-TIMESTAMP-MAP' in sequence mode.
+    // Note that an offset based on the first video
     // timestamp has already been extracted, and appears in periodStart.
-    // The relative offset from X-TIMESTAMP-MAP will be added to that for HLS.
     if (blocks[0].includes('X-TIMESTAMP-MAP') && this.sequenceMode_) {
       // https://bit.ly/2K92l7y
       // The 'X-TIMESTAMP-MAP' header is used in HLS to align text with
@@ -113,6 +124,11 @@ shaka.text.VttTextParser = class {
 
         offset = time.periodStart + mpegTime / mpegTimescale - cueTime;
       }
+    } else if (blocks[0].includes('X-TIMESTAMP-MAP') &&
+        this.manifestType_ == shaka.media.ManifestParser.HLS) {
+      // In we use HLS segments mode, with the presence of this tag we need
+      // calculate the offset from the segment startTime.
+      offset = time.segmentStart;
     }
 
     // Parse VTT regions.