shaka-player 4.12.8 → 4.13.0

package/lib/mss/content_protection.js

@@ -6,11 +6,9 @@
 
 goog.provide('shaka.mss.ContentProtection');
 
-goog.require('shaka.log');
-goog.require('shaka.util.BufferUtils');
+goog.require('shaka.drm.PlayReady');
 goog.require('shaka.util.ManifestParserUtils');
 goog.require('shaka.util.Pssh');
-goog.require('shaka.util.StringUtils');
 goog.require('shaka.util.TXml');
 goog.require('shaka.util.Uint8ArrayUtils');
 
@@ -23,19 +21,19 @@ shaka.mss.ContentProtection = class {
   /**
    * Parses info from the Protection elements.
    *
-   * @param {!Array.<!shaka.extern.xml.Node>} elems
-   * @param {!Object.<string, string>} keySystemsBySystemId
-   * @return {!Array.<shaka.extern.DrmInfo>}
+   * @param {!Array<!shaka.extern.xml.Node>} elements
+   * @param {!Object<string, string>} keySystemsBySystemId
+   * @return {!Array<shaka.extern.DrmInfo>}
    */
-  static parseFromProtection(elems, keySystemsBySystemId) {
+  static parseFromProtection(elements, keySystemsBySystemId) {
     const ContentProtection = shaka.mss.ContentProtection;
     const TXml = shaka.util.TXml;
 
-    /** @type {!Array.<!shaka.extern.xml.Node>} */
+    /** @type {!Array<!shaka.extern.xml.Node>} */
     let protectionHeader = [];
-    for (const elem of elems) {
+    for (const element of elements) {
       protectionHeader = protectionHeader.concat(
-          TXml.findChildren(elem, 'ProtectionHeader'));
+          TXml.findChildren(element, 'ProtectionHeader'));
     }
     if (!protectionHeader.length) {
       return [];
@@ -44,107 +42,6 @@ shaka.mss.ContentProtection = class {
         protectionHeader, keySystemsBySystemId);
   }
 
-  /**
-   * Parses an Array buffer starting at byteOffset for PlayReady Object Records.
-   * Each PRO Record is preceded by its PlayReady Record type and length in
-   * bytes.
-   *
-   * PlayReady Object Record format: https://goo.gl/FTcu46
-   *
-   * @param {!DataView} view
-   * @param {number} byteOffset
-   * @return {!Array.<shaka.mss.ContentProtection.PlayReadyRecord>}
-   * @private
-   */
-  static parseMsProRecords_(view, byteOffset) {
-    const records = [];
-
-    while (byteOffset < view.byteLength - 1) {
-      const type = view.getUint16(byteOffset, true);
-      byteOffset += 2;
-
-      const byteLength = view.getUint16(byteOffset, true);
-      byteOffset += 2;
-
-      if ((byteLength & 1) != 0 || byteLength + byteOffset > view.byteLength) {
-        shaka.log.warning('Malformed MS PRO object');
-        return [];
-      }
-
-      const recordValue = shaka.util.BufferUtils.toUint8(
-          view, byteOffset, byteLength);
-      records.push({
-        type: type,
-        value: recordValue,
-      });
-
-      byteOffset += byteLength;
-    }
-
-    return records;
-  }
-
-  /**
-   * Parses a buffer for PlayReady Objects.  The data
-   * should contain a 32-bit integer indicating the length of
-   * the PRO in bytes.  Following that, a 16-bit integer for
-   * the number of PlayReady Object Records in the PRO.  Lastly,
-   * a byte array of the PRO Records themselves.
-   *
-   * PlayReady Object format: https://goo.gl/W8yAN4
-   *
-   * @param {BufferSource} data
-   * @return {!Array.<shaka.mss.ContentProtection.PlayReadyRecord>}
-   * @private
-   */
-  static parseMsPro_(data) {
-    let byteOffset = 0;
-    const view = shaka.util.BufferUtils.toDataView(data);
-
-    // First 4 bytes is the PRO length (DWORD)
-    const byteLength = view.getUint32(byteOffset, /* littleEndian= */ true);
-    byteOffset += 4;
-
-    if (byteLength != data.byteLength) {
-      // Malformed PRO
-      shaka.log.warning('PlayReady Object with invalid length encountered.');
-      return [];
-    }
-
-    // Skip PRO Record count (WORD)
-    byteOffset += 2;
-
-    // Rest of the data contains the PRO Records
-    const ContentProtection = shaka.mss.ContentProtection;
-    return ContentProtection.parseMsProRecords_(view, byteOffset);
-  }
-
-  /**
-   * Parse a PlayReady Header format: https://goo.gl/dBzxNA
-   * a try to find the LA_URL value.
-   *
-   * @param {!shaka.extern.xml.Node} xml
-   * @return {string}
-   * @private
-   */
-  static getLaurl_(xml) {
-    const TXml = shaka.util.TXml;
-    // LA_URL element is optional and no more than one is
-    // allowed inside the DATA element. Only absolute URLs are allowed.
-    // If the LA_URL element exists, it must not be empty.
-    for (const elem of TXml.getElementsByTagName(xml, 'DATA')) {
-      const laUrl = TXml.findChild(elem, 'LA_URL');
-      if (laUrl) {
-        return /** @type {string} */ (shaka.util.TXml.getTextContents(laUrl));
-      }
-    }
-
-    // Not found
-    // We return a empty string instead null because is the default value for
-    // a License in our model.
-    return '';
-  }
-
   /**
    * Gets a PlayReady license URL from a protection element
    * containing a PlayReady Header Object
@@ -153,47 +50,7 @@ shaka.mss.ContentProtection = class {
    * @return {string}
    */
   static getPlayReadyLicenseUrl(element) {
-    const ContentProtection = shaka.mss.ContentProtection;
-    const rootElement = ContentProtection.getPlayReadyHeaderObject_(element);
-    if (!rootElement) {
-      return '';
-    }
-
-    return ContentProtection.getLaurl_(rootElement);
-  }
-
-  /**
-   * Parse a PlayReady Header format: https://goo.gl/dBzxNA
-   * a try to find the KID value.
-   *
-   * @param {!shaka.extern.xml.Node} xml
-   * @return {?string}
-   * @private
-   */
-  static getKID_(xml) {
-    const TXml = shaka.util.TXml;
-    // KID element is optional and no more than one is
-    // allowed inside the DATA element.
-    for (const elem of TXml.getElementsByTagName(xml, 'DATA')) {
-      const kid = TXml.findChild(elem, 'KID');
-      if (kid) {
-        // GUID: [DWORD, WORD, WORD, 8-BYTE]
-        const guidBytes =
-            shaka.util.Uint8ArrayUtils.fromBase64(
-                /** @type{string} */ (shaka.util.TXml.getTextContents(kid)));
-        // Reverse byte order from little-endian to big-endian
-        const kidBytes = new Uint8Array([
-          guidBytes[3], guidBytes[2], guidBytes[1], guidBytes[0],
-          guidBytes[5], guidBytes[4],
-          guidBytes[7], guidBytes[6],
-          ...guidBytes.slice(8),
-        ]);
-        return shaka.util.Uint8ArrayUtils.toHex(kidBytes);
-      }
-    }
-
-    // Not found
-    return null;
+    return shaka.drm.PlayReady.getLicenseUrl(element);
   }
 
   /**
@@ -205,43 +62,7 @@ shaka.mss.ContentProtection = class {
    * @private
    */
   static getPlayReadyKID_(element) {
-    const ContentProtection = shaka.mss.ContentProtection;
-    const rootElement = ContentProtection.getPlayReadyHeaderObject_(element);
-    if (!rootElement) {
-      return null;
-    }
-
-    return ContentProtection.getKID_(rootElement);
-  }
-
-  /**
-   * Gets a PlayReady Header Object from a protection element
-   *
-   * @param {!shaka.extern.xml.Node} element
-   * @return {?shaka.extern.xml.Node}
-   * @private
-   */
-  static getPlayReadyHeaderObject_(element) {
-    const ContentProtection = shaka.mss.ContentProtection;
-    const PLAYREADY_RECORD_TYPES = ContentProtection.PLAYREADY_RECORD_TYPES;
-
-    const bytes = shaka.util.Uint8ArrayUtils.fromBase64(
-        /** @type{string} */ (shaka.util.TXml.getTextContents(element)));
-    const records = ContentProtection.parseMsPro_(bytes);
-    const record = records.filter((record) => {
-      return record.type === PLAYREADY_RECORD_TYPES.RIGHTS_MANAGEMENT;
-    })[0];
-
-    if (!record) {
-      return null;
-    }
-
-    const xml = shaka.util.StringUtils.fromUTF16(record.value, true);
-    const rootElement = shaka.util.TXml.parseXmlString(xml, 'WRMHEADER');
-    if (!rootElement) {
-      return null;
-    }
-    return rootElement;
+    return shaka.drm.PlayReady.getPlayReadyKID(element);
   }
 
   /**
@@ -250,13 +71,13 @@ shaka.mss.ContentProtection = class {
    * @param {!shaka.extern.xml.Node} element
    * @param {string} systemID
    * @param {?string} keyId
-   * @return {?Array.<shaka.extern.InitDataOverride>}
+   * @return {?Array<shaka.extern.InitDataOverride>}
    * @private
    */
   static getInitDataFromPro_(element, systemID, keyId) {
     const Uint8ArrayUtils = shaka.util.Uint8ArrayUtils;
     const data = Uint8ArrayUtils.fromBase64(
-        /** @type{string} */ (shaka.util.TXml.getTextContents(element)));
+        /** @type {string} */ (shaka.util.TXml.getTextContents(element)));
     const systemId = Uint8ArrayUtils.fromHex(systemID.replace(/-/g, ''));
     const keyIds = new Set();
     const psshVersion = 0;
@@ -274,9 +95,9 @@ shaka.mss.ContentProtection = class {
   /**
    * Creates DrmInfo objects from an array of elements.
    *
-   * @param {!Array.<!shaka.extern.xml.Node>} elements
-   * @param {!Object.<string, string>} keySystemsBySystemId
-   * @return {!Array.<shaka.extern.DrmInfo>}
+   * @param {!Array<!shaka.extern.xml.Node>} elements
+   * @param {!Object<string, string>} keySystemsBySystemId
+   * @return {!Array<shaka.extern.DrmInfo>}
    * @private
    */
   static convertElements_(elements, keySystemsBySystemId) {
@@ -284,7 +105,7 @@ shaka.mss.ContentProtection = class {
     const ManifestParserUtils = shaka.util.ManifestParserUtils;
     const licenseUrlParsers = ContentProtection.licenseUrlParsers_;
 
-    /** @type {!Array.<shaka.extern.DrmInfo>} */
+    /** @type {!Array<shaka.extern.DrmInfo>} */
     const out = [];
 
     for (let i = 0; i < elements.length; i++) {
@@ -315,36 +136,10 @@ shaka.mss.ContentProtection = class {
   }
 };
 
-/**
- * @typedef {{
- *   type: number,
- *   value: !Uint8Array
- * }}
- *
- * @description
- * The parsed result of a PlayReady object record.
- *
- * @property {number} type
- *   Type of data stored in the record.
- * @property {!Uint8Array} value
- *   Record content.
- */
-shaka.mss.ContentProtection.PlayReadyRecord;
-
-/**
- * Enum for PlayReady record types.
- * @enum {number}
- */
-shaka.mss.ContentProtection.PLAYREADY_RECORD_TYPES = {
-  RIGHTS_MANAGEMENT: 0x001,
-  RESERVED: 0x002,
-  EMBEDDED_LICENSE: 0x003,
-};
-
 /**
  * A map of key system name to license server url parser.
  *
- * @const {!Map.<string, function(!shaka.extern.xml.Node)>}
+ * @const {!Map<string, function(!shaka.extern.xml.Node)>}
  * @private
  */
 shaka.mss.ContentProtection.licenseUrlParsers_ = new Map()

package/lib/mss/mss_parser.js

@@ -45,7 +45,7 @@ shaka.mss.MssParser = class {
     /** @private {?shaka.extern.ManifestParser.PlayerInterface} */
     this.playerInterface_ = null;
 
-    /** @private {!Array.<string>} */
+    /** @private {!Array<string>} */
     this.manifestUris_ = [];
 
     /** @private {?shaka.extern.Manifest} */
@@ -79,7 +79,7 @@ shaka.mss.MssParser = class {
     this.operationManager_ = new shaka.util.OperationManager();
 
     /**
-     * @private {!Map.<number, !BufferSource>}
+     * @private {!Map<number, !BufferSource>}
      */
     this.initSegmentDataByStreamId_ = new Map();
 
@@ -431,7 +431,6 @@ shaka.mss.MssParser = class {
         textStreams: context.textStreams,
         imageStreams: [],
         offlineSessionIds: [],
-        minBufferTime: 0,
         sequenceMode: this.config_.mss.sequenceMode,
         ignoreManifestTimestampsInSegmentsMode: false,
         type: shaka.media.ManifestParser.MSS,
@@ -469,9 +468,9 @@ shaka.mss.MssParser = class {
     const TXml = shaka.util.TXml;
     const ContentType = shaka.util.ManifestParserUtils.ContentType;
 
-    const protectionElems = TXml.findChildren(mss, 'Protection');
+    const protectionElements = TXml.findChildren(mss, 'Protection');
     const drmInfos = ContentProtection.parseFromProtection(
-        protectionElems, this.config_.mss.keySystemsBySystemId);
+        protectionElements, this.config_.mss.keySystemsBySystemId);
 
     const audioStreams = [];
     const videoStreams = [];
@@ -515,8 +514,8 @@ shaka.mss.MssParser = class {
   /**
    * @param {!shaka.extern.xml.Node} streamIndex
    * @param {!shaka.extern.xml.Node} qualityLevel
-   * @param {!Array.<shaka.mss.MssParser.TimeRange>} timeline
-   * @param {!Array.<shaka.extern.DrmInfo>} drmInfos
+   * @param {!Array<shaka.mss.MssParser.TimeRange>} timeline
+   * @param {!Array<shaka.extern.DrmInfo>} drmInfos
    * @param {!shaka.mss.MssParser.Context} context
    * @return {?shaka.extern.Stream}
    * @private
@@ -715,7 +714,7 @@ shaka.mss.MssParser = class {
           videoConfig: new Uint8Array([]),
           hSpacing: 0,
           vSpacing: 0,
-          data: null, // Data is not necessary for init segement.
+          data: null, // Data is not necessary for init segment.
           stream: stream,
         };
         const mp4Generator = new shaka.util.Mp4Generator([streamInfo]);
@@ -793,7 +792,7 @@ shaka.mss.MssParser = class {
       const objectType = 0x05;
       // 4 bytes :
       // XXXXX        XXXX         XXXX             XXXX
-      // 'ObjectType' 'Freq Index' 'Channels value' 'Extens Sampl Freq'
+      // 'ObjectType' 'Freq Index' 'Channels value' 'Extension Sampling Freq'
       // XXXXX        XXX   XXXXXXX
       // 'ObjectType' 'GAS' 'alignment = 0'
       const data = new Uint8Array(4);
@@ -808,7 +807,7 @@ shaka.mss.MssParser = class {
           (extensionSamplingFrequencyIndex >> 1);
       // Origin object type equals to 2 => AAC Main Low Complexity
       data[2] = (extensionSamplingFrequencyIndex << 7) | (0x02 << 2);
-      // Slignment bits
+      // Alignment bits
       data[3] = 0x0;
       // Put the 4 bytes in an 16 bits array
       const arr16 = new Uint16Array(2);
@@ -882,18 +881,18 @@ shaka.mss.MssParser = class {
       return '';
     }
     // => Find the 6 characters after the SPS nalHeader (if it exists)
-    const avcoti = codecPrivateData.substr(
+    const avcOti = codecPrivateData.substr(
         codecPrivateData.indexOf(nalHeader[0]) + 10, 6);
 
-    return 'avc1.' + avcoti;
+    return 'avc1.' + avcOti;
   }
 
   /**
    * @param {!shaka.media.InitSegmentReference} initSegmentRef
    * @param {!shaka.extern.Stream} stream
    * @param {!shaka.extern.xml.Node} streamIndex
-   * @param {!Array.<shaka.mss.MssParser.TimeRange>} timeline
-   * @return {!Array.<!shaka.media.SegmentReference>}
+   * @param {!Array<shaka.mss.MssParser.TimeRange>} timeline
+   * @return {!Array<!shaka.media.SegmentReference>}
    * @private
    */
   createSegments_(initSegmentRef, stream, streamIndex, timeline) {
@@ -930,7 +929,7 @@ shaka.mss.MssParser = class {
    * @param {!shaka.extern.xml.Node} streamIndex
    * @param {number} timescale
    * @param {number} duration The duration in seconds.
-   * @return {!Array.<shaka.mss.MssParser.TimeRange>}
+   * @return {!Array<shaka.mss.MssParser.TimeRange>}
    * @private
    */
   createTimeline_(streamIndex, timescale, duration) {
@@ -944,7 +943,7 @@ shaka.mss.MssParser = class {
 
     const timePoints = TXml.findChildren(streamIndex, 'c');
 
-    /** @type {!Array.<shaka.mss.MssParser.TimeRange>} */
+    /** @type {!Array<shaka.mss.MssParser.TimeRange>} */
     const timeline = [];
     let lastEndTime = 0;
 
@@ -985,7 +984,7 @@ shaka.mss.MssParser = class {
             return timeline;
           } else if (startTime >= nextStartTime) {
             shaka.log.warning(
-                'An "c" element cannot have a negative repeatif its start ',
+                'An "c" element cannot have a negative repeat if its start ',
                 'time exceeds the next "c" element\'s start time:',
                 'ignoring the remaining "c" elements.', timePoint);
             return timeline;
@@ -1006,7 +1005,7 @@ shaka.mss.MssParser = class {
             shaka.log.warning(
                 'The last "c" element cannot have a negative repeat',
                 'if its start time exceeds the duration:',
-                'igoring the last "c" element.', timePoint);
+                'ignoring the last "c" element.', timePoint);
             return timeline;
           }
           repeat = Math.ceil((duration * timescale - startTime) / d) - 1;
@@ -1090,7 +1089,7 @@ shaka.mss.MssParser.DEFAULT_TIME_SCALE_ = 1e7;
  * MSS supported codecs.
  *
  * @private
- * @const {!Array.<string>}
+ * @const {!Array<string>}
  */
 shaka.mss.MssParser.SUPPORTED_CODECS_ = [
   'AAC',
@@ -1108,7 +1107,7 @@ shaka.mss.MssParser.SUPPORTED_CODECS_ = [
  * MPEG-DASH Role and accessibility mapping for text tracks according to
  * ETSI TS 103 285 v1.1.1 (section 7.1.2)
  *
- * @const {!Object.<string, string>}
+ * @const {!Object<string, string>}
  * @private
  */
 shaka.mss.MssParser.ROLE_MAPPING_ = {
@@ -1120,15 +1119,15 @@ shaka.mss.MssParser.ROLE_MAPPING_ = {
 
 /**
  * @typedef {{
- *   variants: !Array.<shaka.extern.Variant>,
- *   textStreams: !Array.<shaka.extern.Stream>,
+ *   variants: !Array<shaka.extern.Variant>,
+ *   textStreams: !Array<shaka.extern.Stream>,
  *   timescale: number,
  *   duration: number
  * }}
  *
- * @property {!Array.<shaka.extern.Variant>} variants
+ * @property {!Array<shaka.extern.Variant>} variants
  *   The presentation's Variants.
- * @property {!Array.<shaka.extern.Stream>} textStreams
+ * @property {!Array<shaka.extern.Stream>} textStreams
  *   The presentation's text streams.
  * @property {number} timescale
  *   The presentation's timescale.

package/lib/net/data_uri_plugin.js

@@ -41,6 +41,7 @@ shaka.net.DataUriPlugin = class {
         headers: {
           'content-type': parsed.contentType,
         },
+        originalRequest: request,
       };
 
       return shaka.util.AbortableOperation.completed(response);

package/lib/net/http_fetch_plugin.js

@@ -61,8 +61,8 @@ shaka.net.HttpFetchPlugin = class {
     const minBytes = config.minBytesForProgressEvents || 0;
 
     const pendingRequest = shaka.net.HttpFetchPlugin.request_(
-        uri, requestType, init, abortStatus, progressUpdated, headersReceived,
-        request.streamDataCallback, minBytes);
+        uri, request, requestType, init, abortStatus, progressUpdated,
+        headersReceived, request.streamDataCallback, minBytes);
 
     /** @type {!shaka.util.AbortableOperation} */
     const op = new shaka.util.AbortableOperation(pendingRequest, () => {
@@ -94,6 +94,7 @@ shaka.net.HttpFetchPlugin = class {
 
   /**
    * @param {string} uri
+   * @param {shaka.extern.Request} request
    * @param {shaka.net.NetworkingEngine.RequestType} requestType
    * @param {!RequestInit} init
    * @param {shaka.net.HttpFetchPlugin.AbortStatus} abortStatus
@@ -104,8 +105,8 @@ shaka.net.HttpFetchPlugin = class {
    * @return {!Promise<!shaka.extern.Response>}
    * @private
    */
-  static async request_(uri, requestType, init, abortStatus, progressUpdated,
-      headersReceived, streamDataCallback, minBytes) {
+  static async request_(uri, request, requestType, init, abortStatus,
+      progressUpdated, headersReceived, streamDataCallback, minBytes) {
     const fetch = shaka.net.HttpFetchPlugin.fetch_;
     const ReadableStream = shaka.net.HttpFetchPlugin.ReadableStream_;
     let response;
@@ -225,13 +226,13 @@ shaka.net.HttpFetchPlugin = class {
     const headers = shaka.net.HttpFetchPlugin.headersToGenericObject_(
         response.headers);
 
-    return shaka.net.HttpPluginUtils.makeResponse(
-        headers, arrayBuffer, response.status, uri, response.url, requestType);
+    return shaka.net.HttpPluginUtils.makeResponse(headers, arrayBuffer,
+        response.status, uri, response.url, request, requestType);
   }
 
   /**
    * @param {!Headers} headers
-   * @return {!Object.<string, string>}
+   * @return {!Object<string, string>}
    * @private
    */
   static headersToGenericObject_(headers) {

package/lib/net/http_plugin_utils.js

@@ -19,15 +19,17 @@ goog.requireType('shaka.net.NetworkingEngine');
  */
 shaka.net.HttpPluginUtils = class {
   /**
-   * @param {!Object.<string,string>} headers
+   * @param {!Object<string, string>} headers
    * @param {BufferSource} data
    * @param {number} status
    * @param {string} uri
    * @param {string} responseURL
+   * @param {shaka.extern.Request} request
    * @param {shaka.net.NetworkingEngine.RequestType} requestType
    * @return {!shaka.extern.Response}
    */
-  static makeResponse(headers, data, status, uri, responseURL, requestType) {
+  static makeResponse(headers, data, status, uri, responseURL, request,
+      requestType) {
     goog.asserts.assert(data, 'Data should be non-null!');
 
     if (status >= 200 && status <= 299 && status != 202) {
@@ -40,6 +42,7 @@ shaka.net.HttpPluginUtils = class {
         status: status,
         headers: headers,
         fromCache: !!headers['x-shaka-from-cache'],
+        originalRequest: request,
       };
       return response;
     } else {

package/lib/net/http_xhr_plugin.js

@@ -74,7 +74,8 @@ shaka.net.HttpXHRPlugin = class {
           progressUpdated(currentTime - lastTime, event.loaded - lastLoaded,
               /* numBytesRemaining= */ 0);
           const response = shaka.net.HttpPluginUtils.makeResponse(headers,
-              xhrResponse, xhr.status, uri, xhr.responseURL, requestType);
+              xhrResponse, xhr.status, uri, xhr.responseURL, request,
+              requestType);
           resolve(response);
         } catch (error) {
           goog.asserts.assert(error instanceof shaka.util.Error,
@@ -133,7 +134,7 @@ shaka.net.HttpXHRPlugin = class {
 
   /**
    * @param {!XMLHttpRequest} xhr
-   * @return {!Object.<string, string>}
+   * @return {!Object<string, string>}
    * @private
    */
   static headersToGenericObject_(xhr) {
@@ -142,7 +143,7 @@ shaka.net.HttpXHRPlugin = class {
     const headerLines = xhr.getAllResponseHeaders().trim().split('\r\n');
     const headers = {};
     for (const header of headerLines) {
-      /** @type {!Array.<string>} */
+      /** @type {!Array<string>} */
       const parts = header.split(': ');
       headers[parts[0].toLowerCase()] = parts.slice(1).join(': ');
     }