shaka-player 3.3.4 → 4.0.1

package/lib/polyfill/media_capabilities.js

@@ -24,8 +24,8 @@ shaka.polyfill.MediaCapabilities = class {
    * @export
    */
   static install() {
-    // Since MediaCapabilities is not fully supported on Chromecast yet, we
-    // should always install polyfill for Chromecast.
+    // Since MediaCapabilities is not fully supported on some Chromecast yet,
+    // we should always install polyfill for all Chromecast not Android-based.
     // TODO: re-evaluate MediaCapabilities in the future versions of Chromecast.
     // Since MediaCapabilities implementation is buggy in Apple browsers, we
     // should always install polyfill for Apple browsers.
@@ -37,10 +37,16 @@ shaka.polyfill.MediaCapabilities = class {
     // See: https://github.com/shaka-project/shaka-player/issues/3582
     // TODO: re-evaluate MediaCapabilities in the future versions of PS5
     // Browsers.
-    if (!shaka.util.Platform.isChromecast() &&
-        !shaka.util.Platform.isApple() &&
-        !shaka.util.Platform.isPS5() &&
-        navigator.mediaCapabilities) {
+    let canUseNativeMCap = true;
+    if (shaka.util.Platform.isApple() ||
+        shaka.util.Platform.isPS5() ||
+        shaka.util.Platform.isChromecast()) {
+      canUseNativeMCap = false;
+    }
+    if (shaka.util.Platform.isAndroidCastDevice()) {
+      canUseNativeMCap = true;
+    }
+    if (canUseNativeMCap && navigator.mediaCapabilities) {
       shaka.log.info(
           'MediaCapabilities: Native mediaCapabilities support found.');
       return;

package/lib/polyfill/mediasource.js

@@ -38,11 +38,6 @@ shaka.polyfill.MediaSource = class {
       // Chromecast cannot make accurate determinations via isTypeSupported.
       shaka.polyfill.MediaSource.patchCastIsTypeSupported_();
     } else if (safariVersion) {
-      // TS content is broken on Safari in general.
-      // See https://github.com/shaka-project/shaka-player/issues/743
-      // and https://bugs.webkit.org/show_bug.cgi?id=165342
-      shaka.polyfill.MediaSource.rejectTsContent_();
-
       // NOTE:  shaka.Player.isBrowserSupported() has its own restrictions on
       // Safari version.
       if (safariVersion <= 12) {
@@ -127,29 +122,6 @@ shaka.polyfill.MediaSource = class {
     };
   }
 
-  /**
-   * Patch isTypeSupported() to reject TS content.  Used to avoid TS-related MSE
-   * bugs on Safari.
-   *
-   * @private
-   */
-  static rejectTsContent_() {
-    const originalIsTypeSupported = MediaSource.isTypeSupported;
-
-    MediaSource.isTypeSupported = (mimeType) => {
-      // Parse the basic MIME type from its parameters.
-      const pieces = mimeType.split(/ *; */);
-      const basicMimeType = pieces[0];
-      const container = basicMimeType.split('/')[1];
-
-      if (container.toLowerCase() == 'mp2t') {
-        return false;
-      }
-
-      return originalIsTypeSupported(mimeType);
-    };
-  }
-
   /**
    * Patch |MediaSource.isTypeSupported| to always reject |codec|. This is used
    * when we know that we are on a platform that does not work well with a given

package/lib/polyfill/patchedmediakeys_nop.js

@@ -49,6 +49,8 @@ shaka.polyfill.PatchedMediaKeysNop = class {
     // These are not usable, but allow Player.isBrowserSupported to pass.
     window.MediaKeys = PatchedMediaKeysNop.MediaKeys;
     window.MediaKeySystemAccess = PatchedMediaKeysNop.MediaKeySystemAccess;
+
+    window.shakaMediaKeysPolyfill = true;
   }
 
   /**

package/lib/polyfill/patchedmediakeys_webkit.js

@@ -72,6 +72,8 @@ shaka.polyfill.PatchedMediaKeysWebkit = class {
         PatchedMediaKeysWebkit.setMediaKeys;
     window.MediaKeys = PatchedMediaKeysWebkit.MediaKeys;
     window.MediaKeySystemAccess = PatchedMediaKeysWebkit.MediaKeySystemAccess;
+
+    window.shakaMediaKeysPolyfill = true;
   }
 
   /**

package/lib/text/cue.js

@@ -234,12 +234,6 @@ shaka.text.Cue = class {
      */
     this.lineBreak = false;
 
-    /**
-     * @override
-     * @exportInterface
-     */
-    this.spacer = false;
-
     /**
      * @override
      * @exportInterface

package/lib/text/lrc_text_parser.js

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

package/lib/text/mp4_ttml_parser.js

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

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) {

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

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');
@@ -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,21 @@ 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;
-
-    if (blocks[0].includes('X-TIMESTAMP-MAP')) {
+    // NOTE: This offset and the flag choosing its meaning have no effect on
+    // 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
+    // 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
       // the rest of the media.
@@ -87,8 +111,6 @@ shaka.text.VttTextParser = class {
           mpegTime += shaka.text.VttTextParser.TS_ROLLOVER_;
         }
 
-        // Apple-encoded HLS content uses absolute timestamps, so assume the
-        // presence of the map tag means the content uses absolute timestamps.
         offset = time.periodStart + mpegTime / mpegTimescale - cueTime;
       }
     }

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/config_utils.js

@@ -127,4 +127,29 @@ shaka.util.ConfigUtils = class {
     last[fieldName.substring(nameStart).replace(/\\\./g, '.')] = value;
     return configObject;
   }
+
+  /**
+   * Reference the input parameters so the compiler doesn't remove them from
+   * the calling function.  Return whatever value is specified.
+   *
+   * This allows an empty or default implementation of a config callback that
+   * still bears the complete function signature even in compiled mode.
+   *
+   * The caller should look something like this:
+   *
+   *   const callback = (a, b, c, d) => {
+   *     return referenceParametersAndReturn(
+             [a, b, c, d],
+             a);  // Can be anything, doesn't need to be one of the parameters
+   *   };
+   *
+   * @param {!Array.<?>} parameters
+   * @param {T} returnValue
+   * @return {T}
+   * @template T
+   * @noinline
+   */
+  static referenceParametersAndReturn(parameters, returnValue) {
+    return parameters && returnValue;
+  }
 };

package/lib/util/error.js

@@ -345,6 +345,13 @@ shaka.util.Error.Code = {
    */
   'MISSING_TEXT_PLUGIN': 2014,
 
+  /**
+   * The chapters track failed to load.  The browser does not provide any
+   * information in this case to identify why it failed, but there may be
+   * details in the JavaScript console.
+   */
+  'CHAPTERS_TRACK_FAILED': 2015,
+
   /**
    * Some component tried to read past the end of a buffer.  The segment index,
    * init segment, or PSSH may be malformed.
@@ -581,13 +588,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 +628,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 +682,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;
-  }
 };