shaka-player 3.1.5 → 3.2.3

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/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/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/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;

package/lib/util/error.js

@@ -814,6 +814,12 @@ shaka.util.Error.Code = {
    */
   'INIT_DATA_TRANSFORM_ERROR': 6016,
 
+  /**
+   * The server certificate request failed.
+   * <br> error.data[0] is a shaka.util.Error from the networking engine.
+   */
+  'SERVER_CERTIFICATE_REQUEST_FAILED': 6017,
+
 
   /**
    * The call to Player.load() was interrupted by a call to Player.unload()

package/lib/util/manifest_parser_utils.js

@@ -55,6 +55,7 @@ shaka.util.ManifestParserUtils = class {
       audioRobustness: '',
       videoRobustness: '',
       serverCertificate: null,
+      serverCertificateUri: '',
       sessionType: '',
       initData: initData || [],
       keyIds: new Set(),

package/lib/util/mp4_box_parsers.js

@@ -14,7 +14,7 @@ shaka.util.Mp4BoxParsers = class {
   /**
    * Parses a TFHD Box.
    * @param {!shaka.util.DataViewReader} reader
-   * @param {!number} flags
+   * @param {number} flags
    * @return {!shaka.util.ParsedTFHDBox}
    */
   static parseTFHD(reader, flags) {
@@ -53,7 +53,7 @@ shaka.util.Mp4BoxParsers = class {
   /**
    * Parses a TFDT Box.
    * @param {!shaka.util.DataViewReader} reader
-   * @param {!number} version
+   * @param {number} version
    * @return {!shaka.util.ParsedTFDTBox}
    */
   static parseTFDT(reader, version) {
@@ -68,7 +68,7 @@ shaka.util.Mp4BoxParsers = class {
   /**
    * Parses a MDHD Box.
    * @param {!shaka.util.DataViewReader} reader
-   * @param {!number} version
+   * @param {number} version
    * @return {!shaka.util.ParsedMDHDBox}
    */
   static parseMDHD(reader, version) {
@@ -107,8 +107,8 @@ shaka.util.Mp4BoxParsers = class {
   /**
    * Parses a TRUN Box.
    * @param {!shaka.util.DataViewReader} reader
-   * @param {!number} version
-   * @param {!number} flags
+   * @param {number} version
+   * @param {number} flags
    * @return {!shaka.util.ParsedTRUNBox}
    */
   static parseTRUN(reader, version, flags) {
@@ -168,7 +168,7 @@ shaka.util.Mp4BoxParsers = class {
   /**
    * Parses a TKHD Box.
    * @param {!shaka.util.DataViewReader} reader
-   * @param {!number} version
+   * @param {number} version
    * @return {!shaka.util.ParsedTKHDBox}
    */
   static parseTKHD(reader, version) {
@@ -192,12 +192,12 @@ shaka.util.Mp4BoxParsers = class {
 
 /**
  * @typedef {{
- *    trackId: !number,
+ *    trackId: number,
  *    defaultSampleDuration: ?number,
  *    defaultSampleSize: ?number
  * }}
  *
- * @property {!number} trackId
+ * @property {number} trackId
  *   As per the spec: an integer that uniquely identifies this
  *   track over the entire life‐time of this presentation
  * @property {?number} defaultSampleDuration
@@ -213,10 +213,10 @@ shaka.util.ParsedTFHDBox;
 
 /**
  * @typedef {{
- *    baseMediaDecodeTime: !number
+ *    baseMediaDecodeTime: number
  * }}
  *
- * @property {!number} baseMediaDecodeTime
+ * @property {number} baseMediaDecodeTime
  *   As per the spec: the absolute decode time, measured on the media
  *   timeline, of the first sample in decode order in the track fragment
  *
@@ -226,10 +226,10 @@ shaka.util.ParsedTFDTBox;
 
 /**
  * @typedef {{
- *    timescale: !number
+ *    timescale: number
  * }}
  *
- * @property {!number} timescale
+ * @property {number} timescale
  *   As per the spec: an integer that specifies the time‐scale for this media;
  *   this is the number of time units that pass in one second
  *
@@ -239,13 +239,13 @@ shaka.util.ParsedMDHDBox;
 
 /**
  * @typedef {{
- *    defaultSampleDuration: !number,
- *    defaultSampleSize: !number
+ *    defaultSampleDuration: number,
+ *    defaultSampleSize: number
  * }}
  *
- * @property {!number} defaultSampleDuration
+ * @property {number} defaultSampleDuration
  *   The default sample duration to be used in track fragments
- * @property {!number} defaultSampleSize
+ * @property {number} defaultSampleSize
  *   The default sample size to be used in track fragments
  *
  * @exportDoc
@@ -254,11 +254,11 @@ shaka.util.ParsedTREXBox;
 
 /**
  * @typedef {{
- *    sampleCount: !number,
+ *    sampleCount: number,
  *    sampleData: !Array.<shaka.util.ParsedTRUNSample>
  * }}
  *
- * @property {!number} sampleCount
+ * @property {number} sampleCount
  *   As per the spec: the number of samples being added in this run;
  * @property {!Array.<shaka.util.ParsedTRUNSample>} sampleData
  *   An array of size <sampleCount> containing data for each sample
@@ -290,10 +290,10 @@ shaka.util.ParsedTRUNSample;
 
 /**
  * @typedef {{
- *    trackId: !number
+ *    trackId: number
  *  }}
  *
- * @property {!number} trackId
+ * @property {number} trackId
  *   Unique ID indicative of this track
  *
  * @exportDoc

package/lib/util/multi_map.js

@@ -102,4 +102,12 @@ shaka.util.MultiMap = class {
   size() {
     return Object.keys(this.map_).length;
   }
+
+  /**
+   * Get a list of all the keys.
+   * @return {!Array.<string>}
+   */
+  keys() {
+    return Object.keys(this.map_);
+  }
 };

package/lib/util/player_configuration.js

@@ -75,6 +75,7 @@ shaka.util.PlayerConfiguration = class {
       initDataTransform: shaka.media.DrmEngine.defaultInitDataTransform,
       logLicenseExchange: false,
       updateExpirationTime: 1,
+      preferredKeySystems: [],
     };
 
     const manifest = {
@@ -108,9 +109,16 @@ shaka.util.PlayerConfiguration = class {
           'urn:uuid:f239e769-efa3-4850-9c16-a903c6932efb':
             'com.adobe.primetime',
         },
+        // Need some operation in the callback or else closure may remove calls
+        // to the function as it would be a no-op.  The operation can't just be
+        // a log message, because those are stripped in the compiled build.
+        manifestPreprocessor: (element) => {
+          return element;
+        },
       },
       hls: {
         ignoreTextStreamFailures: false,
+        ignoreImageStreamFailures: false,
         useFullSegmentsForStartTime: false,
       },
     };
@@ -154,6 +162,7 @@ shaka.util.PlayerConfiguration = class {
       autoLowLatencyMode: false,
       forceHTTPS: false,
       preferNativeHls: false,
+      updateIntervalSeconds: 1,
     };
 
     // Some browsers will stop earlier than others before a gap (e.g., Edge
@@ -241,7 +250,10 @@ shaka.util.PlayerConfiguration = class {
       preferredVariantRole: '',
       preferredTextRole: '',
       preferredAudioChannelCount: 2,
+      preferredVideoCodecs: [],
+      preferredAudioCodecs: [],
       preferForcedSubs: false,
+      preferredDecodingAttributes: [],
       restrictions: {
         minWidth: 0,
         maxWidth: Infinity,
@@ -256,7 +268,6 @@ shaka.util.PlayerConfiguration = class {
       },
       playRangeStart: 0,
       playRangeEnd: Infinity,
-      useMediaCapabilities: false,
       textDisplayFactory: () => null,
     };
 
@@ -293,6 +304,7 @@ shaka.util.PlayerConfiguration = class {
         audioRobustness: '',
         sessionType: '',
         serverCertificate: new Uint8Array(0),
+        serverCertificateUri: '',
         individualizationServer: '',
       },
     };