shaka-player 3.3.2 → 4.0.0

package/lib/text/mp4_vtt_parser.js

@@ -84,6 +84,14 @@ shaka.text.Mp4VttParser = class {
     }
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setSequenceMode(sequenceMode) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/sbv_text_parser.js

@@ -27,6 +27,14 @@ shaka.text.SbvTextParser = class {
     goog.asserts.assert(false, 'SubViewer does not have init segments');
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setSequenceMode(sequenceMode) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/simple_text_displayer.js

@@ -12,7 +12,6 @@
 goog.provide('shaka.text.SimpleTextDisplayer');
 
 goog.require('goog.asserts');
-goog.require('shaka.Deprecate');
 goog.require('shaka.log');
 goog.require('shaka.text.Cue');
 
@@ -108,12 +107,7 @@ shaka.text.SimpleTextDisplayer = class {
         return `${acc}</${tag}>`;
       }, '');
 
-      if (cue.lineBreak || cue.spacer) {
-        if (cue.spacer) {
-          shaka.Deprecate.deprecateFeature(4,
-              'shaka.extern.Cue',
-              'Please use lineBreak instead of spacer.');
-        }
+      if (cue.lineBreak) {
         // This is a vertical lineBreak, so insert a newline.
         return '\n';
       } else if (cue.nestedCues.length) {
@@ -178,7 +172,8 @@ shaka.text.SimpleTextDisplayer = class {
         // The browser will display cues with identical time ranges from the
         // bottom up.  Reversing the order of equal cues means the first one
         // parsed will be at the top, as you would expect.
-        // See https://github.com/google/shaka-player/issues/848 for more info.
+        // See https://github.com/shaka-project/shaka-player/issues/848 for
+        // more info.
         // However, this ordering behavior is part of VTTCue's "line" field.
         // Some platforms don't have a real VTTCue and use a polyfill instead.
         // When VTTCue is polyfilled or does not support "line", we should _not_

package/lib/text/srt_text_parser.js

@@ -35,6 +35,14 @@ shaka.text.SrtTextParser = class {
     goog.asserts.assert(false, 'SRT does not have init segments');
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setSequenceMode(sequenceMode) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/ssa_text_parser.js

@@ -28,6 +28,14 @@ shaka.text.SsaTextParser = class {
     goog.asserts.assert(false, 'SSA does not have init segments');
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setSequenceMode(sequenceMode) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export

package/lib/text/text_engine.js

@@ -7,9 +7,9 @@
 goog.provide('shaka.text.TextEngine');
 
 goog.require('goog.asserts');
+goog.require('shaka.log');
 goog.require('shaka.text.Cue');
 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');
@@ -30,6 +30,9 @@ shaka.text.TextEngine = class {
     /** @private {shaka.extern.TextDisplayer} */
     this.displayer_ = displayer;
 
+    /** @private {boolean} */
+    this.segmentRelativeVttTiming_ = false;
+
     /** @private {number} */
     this.timestampOffset_ = 0;
 
@@ -128,8 +131,10 @@ shaka.text.TextEngine = class {
    * called at least once before appendBuffer.
    *
    * @param {string} mimeType
+   * @param {boolean} sequenceMode
+   * @param {boolean} segmentRelativeVttTiming
    */
-  initParser(mimeType) {
+  initParser(mimeType, sequenceMode, segmentRelativeVttTiming) {
     // 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 ||
@@ -140,7 +145,14 @@ shaka.text.TextEngine = class {
     const factory = shaka.text.TextEngine.parserMap_[mimeType];
     goog.asserts.assert(
         factory, 'Text type negotiation should have happened already');
-    this.parser_ = shaka.util.Functional.callFactory(factory);
+    this.parser_ = factory();
+    if (this.parser_.setSequenceMode) {
+      this.parser_.setSequenceMode(sequenceMode);
+    } else {
+      shaka.log.alwaysWarn(
+          'Text parsers should have a "setSequenceMode" method!');
+    }
+    this.segmentRelativeVttTiming_ = segmentRelativeVttTiming;
   }
 
   /**
@@ -166,11 +178,15 @@ shaka.text.TextEngine = class {
       return;
     }
 
+    const vttOffset = this.segmentRelativeVttTiming_ ?
+        startTime : this.timestampOffset_;
+
     /** @type {shaka.extern.TextParser.TimeContext} **/
     const time = {
       periodStart: this.timestampOffset_,
       segmentStart: startTime,
       segmentEnd: endTime,
+      vttOffset: vttOffset,
     };
 
     // Parse the buffer and add the new cues.

package/lib/text/ttml_text_parser.js

@@ -30,6 +30,14 @@ shaka.text.TtmlTextParser = class {
     goog.asserts.assert(false, 'TTML does not have init segments');
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setSequenceMode(sequenceMode) {
+    // Unused.
+  }
+
   /**
    * @override
    * @export
@@ -536,8 +544,10 @@ shaka.text.TtmlTextParser = class {
 
       cue.textAlign = Cue.textAlign[align.toUpperCase()];
     } else {
-      // Default value is START: https://bit.ly/32OGmvo
-      cue.textAlign = Cue.textAlign.START;
+      // Default value is START in the TTML spec: https://bit.ly/32OGmvo
+      // But to make the subtitle render consitent with other players and the
+      // shaka.text.Cue we use CENTER
+      cue.textAlign = Cue.textAlign.CENTER;
     }
 
     const displayAlign = TtmlTextParser.getStyleAttribute_(
@@ -558,7 +568,7 @@ shaka.text.TtmlTextParser = class {
     // Background color should not be set on a container.  If this is a nested
     // cue, you can set the background.  If it's a top-level that happens to
     // also be a leaf, you can set the background.
-    // See https://github.com/google/shaka-player/issues/2623
+    // See https://github.com/shaka-project/shaka-player/issues/2623
     // This used to be handled in the displayer, but that is confusing.  The Cue
     // structure should reflect what you want to happen in the displayer, and
     // the displayer shouldn't have to know about TTML.
@@ -942,8 +952,9 @@ shaka.text.TtmlTextParser = class {
     let ret = null;
     const XmlUtils = shaka.util.XmlUtils;
     while (element) {
-      ret = nsName ? XmlUtils.getAttributeNS(element, nsName, attributeName)
-                   : element.getAttribute(attributeName);
+      ret = nsName ?
+          XmlUtils.getAttributeNS(element, nsName, attributeName) :
+          element.getAttribute(attributeName);
       if (ret) {
         break;
       }

package/lib/text/ui_text_displayer.js

@@ -8,7 +8,6 @@
 goog.provide('shaka.text.UITextDisplayer');
 
 goog.require('goog.asserts');
-goog.require('shaka.Deprecate');
 goog.require('shaka.text.Cue');
 goog.require('shaka.text.CueRegion');
 goog.require('shaka.util.Dom');
@@ -108,7 +107,7 @@ shaka.text.UITextDisplayer = class {
   append(cues) {
     // Clone the cues list for performace optimization. We can avoid the cues
     // list growing during the comparisons for duplicate cues.
-    // See: https://github.com/google/shaka-player/issues/3018
+    // See: https://github.com/shaka-project/shaka-player/issues/3018
     const cuesList = [...this.cues_];
     for (const cue of cues) {
       // When a VTT cue spans a segment boundary, the cue will be duplicated
@@ -343,12 +342,7 @@ shaka.text.UITextDisplayer = class {
   createCue_(cue, parents) {
     const isNested = parents.length > 1;
     let type = isNested ? 'span' : 'div';
-    if (cue.lineBreak || cue.spacer) {
-      if (cue.spacer) {
-        shaka.Deprecate.deprecateFeature(4,
-            'shaka.extern.Cue',
-            'Please use lineBreak instead of spacer.');
-      }
+    if (cue.lineBreak) {
       type = 'br';
     }
 

package/lib/text/vtt_text_parser.js

@@ -22,6 +22,12 @@ goog.require('shaka.util.XmlUtils');
  * @export
  */
 shaka.text.VttTextParser = class {
+  /** Constructs a VTT parser. */
+  constructor() {
+    /** @private {boolean} */
+    this.sequenceMode_ = false;
+  }
+
   /**
    * @override
    * @export
@@ -30,6 +36,14 @@ shaka.text.VttTextParser = class {
     goog.asserts.assert(false, 'VTT does not have init segments');
   }
 
+  /**
+   * @override
+   * @export
+   */
+  setSequenceMode(sequenceMode) {
+    this.sequenceMode_ = sequenceMode;
+  }
+
   /**
    * @override
    * @export
@@ -48,11 +62,19 @@ shaka.text.VttTextParser = class {
           shaka.util.Error.Code.INVALID_TEXT_HEADER);
     }
 
+    // Depending on "segmentRelativeVttTiming" configuration,
+    // "vttOffset" will correspond to either "periodStart" (default)
+    // or "segmentStart", for segmented VTT where timings are relative
+    // to the beginning of each segment.
     // NOTE: "periodStart" is the timestamp offset applied via TextEngine.
     // It is no longer closely tied to periods, but the name stuck around.
-    let offset = time.periodStart;
+    let offset = time.vttOffset;
 
-    if (blocks[0].includes('X-TIMESTAMP-MAP')) {
+    // Do not honor the 'X-TIMESTAMP-MAP' value when in sequence mode.
+    // That is because it is used mainly (solely?) to account for the timestamp
+    // offset of the video/audio; when in sequence mode, we normalize that
+    // timestamp offset to 0, so we should not account for it.
+    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
       // the rest of the media.

package/lib/text/web_vtt_generator.js

@@ -6,7 +6,6 @@
 
 goog.provide('shaka.text.WebVttGenerator');
 
-goog.require('shaka.Deprecate');
 goog.require('shaka.text.Cue');
 
 
@@ -49,12 +48,7 @@ shaka.text.WebVttGenerator = class {
         return `${acc}</${tag}>`;
       }, '');
 
-      if (cue.lineBreak || cue.spacer) {
-        if (cue.spacer) {
-          shaka.Deprecate.deprecateFeature(4,
-              'shaka.text.Cue',
-              'Please use lineBreak instead of spacer.');
-        }
+      if (cue.lineBreak) {
         // This is a vertical lineBreak, so insert a newline.
         return '\n';
       } else if (cue.nestedCues.length) {

package/lib/util/buffer_utils.js

@@ -6,8 +6,6 @@
 
 goog.provide('shaka.util.BufferUtils');
 
-goog.require('shaka.util.Iterables');
-
 
 /**
  * @summary A set of BufferSource utility functions.
@@ -45,7 +43,7 @@ shaka.util.BufferUtils = class {
 
     const uint8A = shaka.util.BufferUtils.toUint8(arr1);
     const uint8B = shaka.util.BufferUtils.toUint8(arr2);
-    for (const i of shaka.util.Iterables.range(arr1.byteLength)) {
+    for (let i = 0; i < arr1.byteLength; i++) {
       if (uint8A[i] != uint8B[i]) {
         return false;
       }

package/lib/util/ebml_parser.js

@@ -11,7 +11,6 @@ goog.require('goog.asserts');
 goog.require('shaka.util.BufferUtils');
 goog.require('shaka.util.DataViewReader');
 goog.require('shaka.util.Error');
-goog.require('shaka.util.Iterables');
 
 
 /**
@@ -157,7 +156,8 @@ shaka.util.EbmlParser = class {
     }
 
     let value = 0;
-    for (const {item, i} of shaka.util.Iterables.enumerate(vint)) {
+    for (let i = 0; i < vint.length; i++) {
+      const item = vint[i];
       if (i == 0) {
         // Mask out the first few bits of |vint|'s first byte to get the most
         // significant bits of |vint|'s value. If |vint| is 8 bytes wide then
@@ -267,7 +267,7 @@ shaka.util.EbmlElement = class {
 
     let value = 0;
 
-    for (const i of shaka.util.Iterables.range(this.dataView_.byteLength)) {
+    for (let i = 0; i < this.dataView_.byteLength; i++) {
       const chunk = this.dataView_.getUint8(i);
       value = (256 * value) + chunk;
     }

package/lib/util/error.js

@@ -467,7 +467,7 @@ shaka.util.Error.Code = {
    * Content transformations required by the platform could not be performed for
    * some reason (unsupported container, etc.)
    *
-   * @see https://github.com/google/shaka-player/issues/2759
+   * @see https://github.com/shaka-project/shaka-player/issues/2759
    */
   'CONTENT_TRANSFORMATION_FAILED': 3019,
 
@@ -581,13 +581,7 @@ shaka.util.Error.Code = {
 
   // RETIRED: 'HLS_COULD_NOT_GUESS_MIME_TYPE': 4021,
 
-  /**
-   * No Master Playlist has been provided. Master playlist provides
-   * vital information about the streams (like codecs) that is
-   * required for MediaSource. We don't support directly providing
-   * a Media Playlist.
-   */
-  'HLS_MASTER_PLAYLIST_NOT_PROVIDED': 4022,
+  // RETIRED: 'HLS_MASTER_PLAYLIST_NOT_PROVIDED': 4022,
 
   /**
    * One of the required attributes was not provided, so the
@@ -627,12 +621,7 @@ shaka.util.Error.Code = {
 
   // RETIRED: 'HLS_LIVE_CONTENT_NOT_SUPPORTED': 4029,
 
-  /**
-   * The HLS parser was unable to parse segment start time from the media.
-   * <br> error.data[0] is the failed media playlist URI.
-   * <br> error.data[1] is the failed media segment URI (if any).
-   */
-  'HLS_COULD_NOT_PARSE_SEGMENT_START_TIME': 4030,
+  // RETIRED: 'HLS_COULD_NOT_PARSE_SEGMENT_START_TIME': 4030,
 
   // RETIRED: 'HLS_MEDIA_SEQUENCE_REQUIRED_IN_LIVE_STREAMS': 4031,
 
@@ -686,6 +675,13 @@ shaka.util.Error.Code = {
    */
   'HLS_VARIABLE_NOT_FOUND': 4039,
 
+  /**
+   * We do not support playing encrypted mp2t with MSE
+   */
+  'HLS_MSE_ENCRYPTED_MP2T_NOT_SUPPORTED': 4040,
+
+  // RETIRED: 'HLS_MSE_ENCRYPTED_LEGACY_APPLE_MEDIA_KEYS_NOT_SUPPORTED': 4041,
+
 
   // RETIRED: 'INCONSISTENT_BUFFER_STATE': 5000,
   // RETIRED: 'INVALID_SEGMENT_INDEX': 5001,

package/lib/util/fairplay_utils.js

@@ -8,9 +8,11 @@ goog.provide('shaka.util.FairPlayUtils');
 
 goog.require('goog.Uri');
 goog.require('goog.asserts');
+goog.require('shaka.net.NetworkingEngine');
 goog.require('shaka.util.BufferUtils');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.StringUtils');
+goog.require('shaka.util.Uint8ArrayUtils');
 
 
 /**
@@ -18,6 +20,29 @@ goog.require('shaka.util.StringUtils');
  * @export
  */
 shaka.util.FairPlayUtils = class {
+  /**
+   * Check if FairPlay is supported.
+   *
+   * @return {!Promise.<boolean>}
+   * @export
+   */
+  static async isFairPlaySupported() {
+    const config = {
+      initDataTypes: ['cenc', 'sinf', 'skd'],
+      videoCapabilities: [
+        {
+          contentType: 'video/mp4; codecs="avc1.42E01E"',
+        },
+      ],
+    };
+    try {
+      await navigator.requestMediaKeySystemAccess('com.apple.fps', [config]);
+      return true;
+    } catch (err) {
+      return false;
+    }
+  }
+
   /**
    * Using the default method, extract a content ID from the init data.  This is
    * based on the FairPlay example documentation.
@@ -106,4 +131,88 @@ shaka.util.FairPlayUtils = class {
         offset == rebuiltInitData.length, 'Inconsistent init data length');
     return rebuiltInitData;
   }
+
+  /**
+   * SPC FairPlay request.
+   *
+   * @param {shaka.net.NetworkingEngine.RequestType} type
+   * @param {shaka.extern.Request} request
+   * @export
+   */
+  static spcFairPlayRequest(type, request) {
+    if (type !== shaka.net.NetworkingEngine.RequestType.LICENSE) {
+      return;
+    }
+    const body = /** @type {!(ArrayBuffer|ArrayBufferView)} */(request.body);
+    const originalPayload = shaka.util.BufferUtils.toUint8(body);
+    const base64Payload = shaka.util.Uint8ArrayUtils.toBase64(originalPayload);
+    request.headers['Content-Type'] = 'application/x-www-form-urlencoded';
+    request.body = shaka.util.StringUtils.toUTF8('spc=' + base64Payload);
+  }
+
+  /**
+   * Common FairPlay response transform for some DRMs providers.
+   *
+   * @param {shaka.net.NetworkingEngine.RequestType} type
+   * @param {shaka.extern.Response} response
+   * @export
+   */
+  static commonFairPlayResponse(type, response) {
+    if (type !== shaka.net.NetworkingEngine.RequestType.LICENSE) {
+      return;
+    }
+
+    // In Apple's docs, responses can be of the form:
+    //   '\n<ckc>base64encoded</ckc>\n' or 'base64encoded'
+    // We have also seen responses in JSON format from some of our partners.
+    // In all of these text-based formats, the CKC data is base64-encoded.
+
+    let responseText;
+    try {
+      // Convert it to text for further processing.
+      responseText = shaka.util.StringUtils.fromUTF8(response.data);
+    } catch (error) {
+      // Assume it's not a text format of any kind and leave it alone.
+      return;
+    }
+
+    let licenseProcessing = false;
+
+    // Trim whitespace.
+    responseText = responseText.trim();
+
+    // Look for <ckc> wrapper and remove it.
+    if (responseText.substr(0, 5) === '<ckc>' &&
+        responseText.substr(-6) === '</ckc>') {
+      responseText = responseText.slice(5, -6);
+      licenseProcessing = true;
+    }
+
+    // Look for a JSON wrapper and remove it.
+    try {
+      const responseObject = /** @type {!Object} */(JSON.parse(responseText));
+      if (responseObject['ckc']) {
+        responseText = responseObject['ckc'];
+        licenseProcessing = true;
+      }
+      if (responseObject['CkcMessage']) {
+        responseText = responseObject['CkcMessage'];
+        licenseProcessing = true;
+      }
+      if (responseObject['License']) {
+        responseText = responseObject['License'];
+        licenseProcessing = true;
+      }
+    } catch (err) {
+      // It wasn't JSON.  Fall through with other transformations.
+    }
+
+    if (licenseProcessing) {
+      // Decode the base64-encoded data into the format the browser expects.
+      // It's not clear why FairPlay license servers don't just serve this
+      // directly.
+      response.data = shaka.util.BufferUtils.toArrayBuffer(
+          shaka.util.Uint8ArrayUtils.fromBase64(responseText));
+    }
+  }
 };

package/lib/util/functional.js

@@ -6,9 +6,6 @@
 
 goog.provide('shaka.util.Functional');
 
-goog.require('shaka.Deprecate');
-
-
 /**
  * @summary A set of functional utility functions.
  */
@@ -70,43 +67,4 @@ shaka.util.Functional = class {
   static isNotNull(value) {
     return value != null;
   }
-
-  /**
-   * Calls a factory function while allowing it to be a constructor for
-   * reverse-compatibility.
-   *
-   * @param {function():!T} factory
-   * @return {!T}
-   * @template T
-   */
-  static callFactory(factory) {
-    // See https://stackoverflow.com/q/10428603/1208502
-    // eslint-disable-next-line no-restricted-syntax
-    const obj = Object.create(factory.prototype || Object.prototype);
-    // If this is a constructor, call it with our newly created object to
-    // initialize it; if this isn't a constructor, the "this" shouldn't be used
-    // since it should be "undefined".
-    let ret;
-    try {
-      ret = factory.call(obj);  // eslint-disable-line no-restricted-syntax
-
-      // If it didn't return anything, assume it is a constructor and return our
-      // "this" value instead.
-      if (!ret) {
-        shaka.Deprecate.deprecateFeature(4,
-            'Factories requiring new',
-            'Factories should be plain functions');
-        ret = obj;
-      }
-    } catch (e) {
-      // This was an ES6 class, so it threw a TypeError because we didn't use
-      // "new".  Fall back to actually using "new".
-      shaka.Deprecate.deprecateFeature(4,
-          'Factories requiring new',
-          'Factories should be plain functions');
-      const FactoryAsClass = /** @type {function(new: T)} */(factory);
-      ret = new FactoryAsClass();
-    }
-    return ret;
-  }
 };

package/lib/util/iterables.js

@@ -75,50 +75,4 @@ shaka.util.Iterables = class {
     }
     return out;
   }
-
-  /**
-   * Returns an iterable that contains numbers in the range [0, end).
-   *
-   * @param {number} end The exclusive end of the list.
-   * @return {!Iterable.<number>}
-   */
-  static* range(end) {
-    for (let i = 0; i < end; i++) {
-      yield i;
-    }
-  }
-
-  /**
-   * Iterates over an iterable object and includes additional info about each
-   * item:
-   * - The zero-based index of the element.
-   * - The next item in the list, if it exists.
-   * - The previous item in the list, if it exists.
-   *
-   * @param {!Iterable.<T>} iterable
-   * @return {!Iterable.<
-   *     {i: number, item: T, prev: (T|undefined), next: (T|undefined)}>}
-   * @template T
-   */
-  static* enumerate(iterable) {
-    // Since we want the "next" item, we need to skip the first item and return
-    // elements one in the past.  So as we iterate, we are getting the "next"
-    // element and yielding the one from the previous iteration.
-    let i = -1;
-    let prev = undefined;
-    let item = undefined;
-    for (const next of iterable) {
-      if (i >= 0) {
-        yield {i, item, prev, next};
-      }
-      i++;
-      prev = item;
-      item = next;
-    }
-    if (i != -1) {
-      // If it's still -1, there were no items.  Otherwise we need to yield
-      // the last item.
-      yield {i, prev, item, next: undefined};
-    }
-  }
 };

package/lib/util/mime_utils.js

@@ -11,6 +11,7 @@ goog.require('shaka.media.Transmuxer');
 
 /**
  * @summary A set of utility functions for dealing with MIME types.
+ * @export
  */
 shaka.util.MimeUtils = class {
   /**
@@ -20,6 +21,7 @@ shaka.util.MimeUtils = class {
    * @param {string} mimeType
    * @param {string=} codecs
    * @return {string}
+   * @export
    */
   static getFullType(mimeType, codecs) {
     let fullMimeType = mimeType;

package/lib/util/mp4_box_parsers.js

@@ -7,8 +7,6 @@
 goog.provide('shaka.util.Mp4BoxParsers');
 
 goog.require('shaka.util.DataViewReader');
-goog.require('shaka.util.Functional');
-goog.require('shaka.util.Iterables');
 
 shaka.util.Mp4BoxParsers = class {
   /**
@@ -125,8 +123,7 @@ shaka.util.Mp4BoxParsers = class {
       reader.skip(4);
     }
 
-    for (const _ of shaka.util.Iterables.range(sampleCount)) {
-      shaka.util.Functional.ignored(_);
+    for (let i = 0; i < sampleCount; i++) {
       /** @type {shaka.util.ParsedTRUNSample} */
       const sample = {
         sampleDuration: null,