shaka-player 3.1.4 → 3.3.0

package/lib/polyfill/aria.js

@@ -0,0 +1,82 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+goog.provide('shaka.polyfill.Aria');
+
+goog.require('shaka.log');
+goog.require('shaka.polyfill');
+
+/**
+ * @summary A polyfill to add support for the ARIAMixin interface mixin, for
+ * browsers that do not implement it (e.g. Firefox).
+ * Note that IE also does not support ARIAMixin, but this polyfill does not work
+ * for that platform, as it relies on getters and setters.
+ * @see https://w3c.github.io/aria/#ARIAMixin
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Element
+ * @export
+ */
+shaka.polyfill.Aria = class {
+  /**
+   * Install the polyfill if needed.
+   * @export
+   */
+  static install() {
+    // eslint-disable-next-line no-restricted-syntax
+    if (Object.getOwnPropertyDescriptor(Element.prototype, 'ariaHidden')) {
+      shaka.log.info('Using native ARIAMixin interface.');
+      return;
+    }
+    shaka.log.info('ARIAMixin interface not detected. Installing polyfill.');
+
+    // Define a list of all of the ARIAMixin properties that we have externs
+    // for.
+    const attributes = [
+      'ariaHidden',
+      'ariaLabel',
+      'ariaPressed',
+      'ariaSelected',
+    ];
+
+    // Add each attribute, one by one.
+    for (const attribute of attributes) {
+      shaka.polyfill.Aria.addARIAMixinAttribute_(attribute);
+    }
+  }
+
+  /**
+   * Adds an attribute with the given name.
+   * @param {string} name The name of the attribute, in camelCase.
+   * @private
+   */
+  static addARIAMixinAttribute_(name) {
+    const baseName = name.toLowerCase().replace(/^aria/, '');
+    // NOTE: All the attributes listed in the method above begin with "aria".
+    // However, to add extra protection against the possibility of XSS attacks
+    // through this method, this enforces "aria-" at the beginning of the
+    // snake-case name, even if somehow "aria" were missing from the input.
+    const snakeCaseName = `aria-${baseName}`;
+
+    /* eslint-disable no-restricted-syntax */
+    Object.defineProperty(Element.prototype, name, {
+      get() {
+        const element = /** @type {!Element} */ (this);
+        return element.getAttribute(snakeCaseName);
+      },
+      set(value) {
+        const element = /** @type {!Element} */ (this);
+        if (value == null || value == undefined) {
+          element.removeAttribute(snakeCaseName);
+        } else {
+          element.setAttribute(snakeCaseName, value);
+        }
+      },
+    });
+    /* eslint-enable no-restricted-syntax */
+  }
+};
+
+
+shaka.polyfill.register(shaka.polyfill.Aria.install);

package/lib/polyfill/random_uuid.js

@@ -0,0 +1,52 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+goog.provide('shaka.polyfill.RandomUUID');
+
+goog.require('shaka.log');
+goog.require('shaka.polyfill');
+
+/**
+ * @summary A polyfill to provide window.crypto.randomUUID in all browsers.
+ * @export
+ */
+shaka.polyfill.RandomUUID = class {
+  /**
+   * Install the polyfill if needed.
+   * @export
+   */
+  static install() {
+    shaka.log.debug('randomUUID.install');
+
+    if (!window.crypto) {
+      // See: https://caniuse.com/cryptography
+      shaka.log.debug(
+          'window.crypto must be available to install randomUUID polyfill.');
+      return;
+    }
+
+    if ('randomUUID' in window.crypto) {
+      shaka.log.debug(
+          'RandomUUID: Native window.crypto.randomUUID() support found.');
+      return;
+    }
+
+    window.crypto.randomUUID = shaka.polyfill.RandomUUID.randomUUID_;
+  }
+
+  /**
+   * @return {string}
+   * @private
+   */
+  static randomUUID_() {
+    const url = URL.createObjectURL(new Blob());
+    const uuid = url.toString();
+    URL.revokeObjectURL(url);
+    return uuid.substr(uuid.lastIndexOf('/') + 1);
+  }
+};
+
+
+shaka.polyfill.register(shaka.polyfill.RandomUUID.install);

package/lib/routing/walker.js

@@ -5,7 +5,6 @@
  */
 
 goog.provide('shaka.routing.Walker');
-goog.provide('shaka.routing.Walker.Implementation');
 
 goog.require('goog.asserts');
 goog.require('shaka.routing.Node');
@@ -81,7 +80,7 @@ shaka.routing.Walker = class {
      * new work is added (and this is not null) it can be resolved. The only
      * time when this should be non-null is when we are waiting for more work.
      *
-     * @private {shaka.util.PublicPromise}
+     * @private {?shaka.util.PublicPromise}
      */
     this.waitForWork_ = null;
 
@@ -91,7 +90,7 @@ shaka.routing.Walker = class {
     /** @private {?shaka.routing.Walker.ActiveRoute_} */
     this.currentRoute_ = null;
 
-    /** @private {shaka.util.AbortableOperation} */
+    /** @private {?shaka.util.AbortableOperation} */
     this.currentStep_ = null;
 
     /**

package/lib/text/cue.js

@@ -144,6 +144,18 @@ shaka.text.Cue = class {
      */
     this.border = '';
 
+    /**
+     * @override
+     * @exportInterface
+     */
+    this.textStrokeColor = '';
+
+    /**
+     * @override
+     * @exportInterface
+     */
+    this.textStrokeWidth = '';
+
     /**
      * @override
      * @exportInterface

package/lib/text/srt_text_parser.js

@@ -57,8 +57,8 @@ shaka.text.SrtTextParser = class {
   /**
    * Convert a SRT format to WebVTT
    *
-   * @param {!string} data
-   * @return {!string}
+   * @param {string} data
+   * @return {string}
    * @export
    */
   static srt2webvtt(data) {
@@ -87,8 +87,8 @@ shaka.text.SrtTextParser = class {
   /**
    * Convert a SRT cue into WebVTT cue
    *
-   * @param {!string} caption
-   * @return {!string}
+   * @param {string} caption
+   * @return {string}
    * @private
    */
   static convertSrtCue_(caption) {

package/lib/text/text_engine.js

@@ -12,7 +12,7 @@ goog.require('shaka.util.BufferUtils');
 goog.require('shaka.util.Functional');
 goog.require('shaka.util.IDestroyable');
 goog.require('shaka.util.MimeUtils');
-goog.requireType('shaka.cea.ICaptionDecoder.ClosedCaption');
+goog.requireType('shaka.cea.ICaptionDecoder');
 
 
 // TODO: revisit this when Closure Compiler supports partially-exported classes.
@@ -24,7 +24,7 @@ goog.requireType('shaka.cea.ICaptionDecoder.ClosedCaption');
 shaka.text.TextEngine = class {
   /** @param {shaka.extern.TextDisplayer} displayer */
   constructor(displayer) {
-    /** @private {shaka.extern.TextParser} */
+    /** @private {?shaka.extern.TextParser} */
     this.parser_ = null;
 
     /** @private {shaka.extern.TextDisplayer} */

package/lib/text/ttml_text_parser.js

@@ -531,7 +531,6 @@ shaka.text.TtmlTextParser = class {
 
     const color = TtmlTextParser.getStyleAttribute_(
         cueElement, region, styles, 'color', shouldInheritRegionStyles);
-
     if (color) {
       cue.color = color;
     }
@@ -584,7 +583,6 @@ shaka.text.TtmlTextParser = class {
 
     const fontSize = TtmlTextParser.getStyleAttribute_(
         cueElement, region, styles, 'fontSize', shouldInheritRegionStyles);
-
     if (fontSize) {
       const isValidFontSizeUnit =
           fontSize.match(TtmlTextParser.unitValues_) ||
@@ -622,6 +620,31 @@ shaka.text.TtmlTextParser = class {
       }
     }
 
+    const textOutline = TtmlTextParser.getStyleAttribute_(
+        cueElement, region, styles, 'textOutline', shouldInheritRegionStyles);
+    if (textOutline) {
+      // tts:textOutline isn't natively supported by browsers, but it can be
+      // mostly replicated using the non-standard -webkit-text-stroke-width and
+      // -webkit-text-stroke-color properties.
+      const split = textOutline.split(' ');
+      if (split[0].match(TtmlTextParser.unitValues_)) {
+        // There is no defined color, so default to the text color.
+        cue.textStrokeColor = cue.color;
+      } else {
+        cue.textStrokeColor = split[0];
+        split.shift();
+      }
+      if (split[0] && split[0].match(TtmlTextParser.unitValues_)) {
+        cue.textStrokeWidth = split[0];
+      } else {
+        // If there is no width, or the width is not a number, don't draw a
+        // border.
+        cue.textStrokeColor = '';
+      }
+      // There is an optional blur radius also, but we have no way of
+      // replicating that, so ignore it.
+    }
+
     const letterSpacing = TtmlTextParser.getStyleAttribute_(
         cueElement, region, styles, 'letterSpacing', shouldInheritRegionStyles);
     if (letterSpacing && letterSpacing.match(TtmlTextParser.unitValues_)) {

package/lib/text/ui_text_displayer.js

@@ -403,8 +403,8 @@ shaka.text.UITextDisplayer = class {
       return nonBreakingSpace.repeat(match.length);
     });
 
-    style.backgroundColor = cue.backgroundColor;
-    style.border = cue.border;
+    style.webkitTextStrokeColor = cue.textStrokeColor;
+    style.webkitTextStrokeWidth = cue.textStrokeWidth;
     style.color = cue.color;
     style.direction = cue.direction;
     style.opacity = cue.opacity;

package/lib/text/vtt_text_parser.js

@@ -464,8 +464,8 @@ shaka.text.VttTextParser = class {
   }
 
   /**
-   * @param {!string} value
-   * @param {!string} defaultValue
+   * @param {string} value
+   * @param {string} defaultValue
    * @private
    */
   static getOrDefault_(value, defaultValue) {

package/lib/text/web_vtt_generator.js

@@ -17,9 +17,10 @@ goog.require('shaka.text.Cue');
 shaka.text.WebVttGenerator = class {
   /**
    * @param {!Array.<!shaka.text.Cue>} cues
+   * @param {!Array.<!shaka.extern.AdCuePoint>} adCuePoints
    * @return {string}
    */
-  static convert(cues) {
+  static convert(cues, adCuePoints) {
     // Flatten nested cue payloads recursively.  If a cue has nested cues,
     // their contents should be combined and replace the payload of the parent.
     const flattenPayload = (cue) => {
@@ -64,6 +65,25 @@ shaka.text.WebVttGenerator = class {
       }
     };
 
+    const webvttTimeString = (time) => {
+      let newTime = time;
+      for (const adCuePoint of adCuePoints) {
+        if (adCuePoint.end && adCuePoint.start < time) {
+          const offset = adCuePoint.end - adCuePoint.start;
+          newTime += offset;
+        }
+      }
+      const hours = Math.floor(newTime / 3600);
+      const minutes = Math.floor(newTime / 60 % 60);
+      const seconds = Math.floor(newTime % 60);
+      const milliseconds = Math.floor(newTime * 1000 % 1000);
+      return (hours < 10 ? '0' : '') + hours + ':' +
+          (minutes < 10 ? '0' : '') + minutes + ':' +
+          (seconds < 10 ? '0' : '') + seconds + '.' +
+          (milliseconds < 100 ? (milliseconds < 10 ? '00' : '0') : '') +
+          milliseconds;
+    };
+
     // We don't want to modify the array or objects passed in, since we don't
     // technically own them.  So we build a new array and replace certain items
     // in it if they need to be flattened.
@@ -80,19 +100,42 @@ shaka.text.WebVttGenerator = class {
 
     let webvttString = 'WEBVTT\n\n';
     for (const cue of flattenedCues) {
-      const webvttTimeString = (time) => {
-        const hours = Math.floor(time / 3600);
-        const minutes = Math.floor(time / 60 % 60);
-        const seconds = Math.floor(time % 60);
-        const milliseconds = Math.floor(time * 1000 % 1000);
-        return (hours < 10 ? '0' : '') + hours + ':' +
-            (minutes < 10 ? '0' : '') + minutes + ':' +
-            (seconds < 10 ? '0' : '') + seconds + '.' +
-            (milliseconds < 100 ? (milliseconds < 10 ? '00' : '0') : '') +
-            milliseconds;
+      const webvttSettings = (cue) => {
+        const settings = [];
+        const Cue = shaka.text.Cue;
+        switch (cue.textAlign) {
+          case Cue.textAlign.LEFT:
+            settings.push('align:left');
+            break;
+          case Cue.textAlign.RIGHT:
+            settings.push('align:right');
+            break;
+          case Cue.textAlign.CENTER:
+            settings.push('align:middle');
+            break;
+          case Cue.textAlign.START:
+            settings.push('align:start');
+            break;
+          case Cue.textAlign.END:
+            settings.push('align:end');
+            break;
+        }
+        switch (cue.writingMode) {
+          case Cue.writingMode.VERTICAL_LEFT_TO_RIGHT:
+            settings.push('vertical:lr');
+            break;
+          case Cue.writingMode.VERTICAL_RIGHT_TO_LEFT:
+            settings.push('vertical:rl');
+            break;
+        }
+
+        if (settings.length) {
+          return ' ' + settings.join(' ');
+        }
+        return '';
       };
       webvttString += webvttTimeString(cue.startTime) + ' --> ' +
-          webvttTimeString(cue.endTime) + '\n';
+          webvttTimeString(cue.endTime) + webvttSettings(cue) + '\n';
       webvttString += cue.payload + '\n\n';
     }
     return webvttString;