shaka-player 3.3.0 → 3.3.1

package/lib/util/cmcd_manager.js

@@ -6,6 +6,7 @@
 
 goog.provide('shaka.util.CmcdManager');
 
+goog.require('goog.Uri');
 goog.require('shaka.log');
 
 
@@ -31,7 +32,7 @@ shaka.util.CmcdManager = class {
      *
      * @private {string}
      */
-    this.sid_ = config.sessionId || window.crypto.randomUUID();
+    this.sid_ = '';
 
     /**
      * Streaming format
@@ -118,10 +119,11 @@ shaka.util.CmcdManager = class {
 
       data.ot = this.getObjectType_(segmentInfo);
 
-      const isMedia = data.ot === shaka.util.CmcdManager.ObjectType.VIDEO ||
-                      data.ot === shaka.util.CmcdManager.ObjectType.AUDIO ||
-                      data.ot === shaka.util.CmcdManager.ObjectType.MUXED ||
-                      data.ot === shaka.util.CmcdManager.ObjectType.TIMED_TEXT;
+      const ObjectType = shaka.util.CmcdManager.ObjectType;
+      const isMedia = data.ot === ObjectType.VIDEO ||
+                      data.ot === ObjectType.AUDIO ||
+                      data.ot === ObjectType.MUXED ||
+                      data.ot === ObjectType.TIMED_TEXT;
 
       if (isMedia) {
         data.bl = this.getBufferLength_(segmentInfo.type);
@@ -131,7 +133,9 @@ shaka.util.CmcdManager = class {
         data.br = segmentInfo.bandwidth / 1000;
       }
 
-      data.tb = this.getTopBandwidth_(segmentInfo.type) / 1000;
+      if (isMedia && data.ot !== ObjectType.TIMED_TEXT) {
+        data.tb = this.getTopBandwidth_(data.ot) / 1000;
+      }
 
       this.apply_(request, data);
     } catch (error) {
@@ -147,6 +151,10 @@ shaka.util.CmcdManager = class {
    */
   applyTextData(request) {
     try {
+      if (!this.config_.enabled) {
+        return;
+      }
+
       this.apply_(request, {
         ot: shaka.util.CmcdManager.ObjectType.CAPTION,
         su: true,
@@ -213,10 +221,13 @@ shaka.util.CmcdManager = class {
   /**
    * Create baseline CMCD data
    *
-   * @return {shaka.util.CmcdManager.Data}
+   * @return {CmcdData}
    * @private
    */
   createData_() {
+    if (!this.sid_) {
+      this.sid_ = this.config_.sessionId || window.crypto.randomUUID();
+    }
     return {
       v: shaka.util.CmcdManager.Version,
       sf: this.sf_,
@@ -230,7 +241,7 @@ shaka.util.CmcdManager = class {
    * Apply CMCD data to a request.
    *
    * @param {!shaka.extern.Request} request The request to apply CMCD data to
-   * @param {!shaka.util.CmcdManager.Data} data The data object
+   * @param {!CmcdData} data The data object
    * @param {boolean} useHeaders Send data via request headers
    * @private
    */
@@ -380,23 +391,31 @@ shaka.util.CmcdManager = class {
    * @private
    */
   getTopBandwidth_(type) {
-    const manifest = this.playerInterface_.getManifest();
-    if (!manifest) {
+    const variants = this.playerInterface_.getVariantTracks();
+    if (!variants.length) {
       return NaN;
     }
 
-    const variants = (type === 'text') ?
-      manifest.textStreams : manifest.variants;
-    let top = variants[0][type] || variants[0];
+    let top = variants[0];
 
     for (const variant of variants) {
-      const stream = variant[type] || variant;
-      if (stream.bandwidth > top.bandwidth) {
-        top = stream;
+      if (variant.type === 'variant' && variant.bandwidth > top.bandwidth) {
+        top = variant;
       }
     }
 
-    return top.bandwidth;
+    const ObjectType = shaka.util.CmcdManager.ObjectType;
+
+    switch (type) {
+      case ObjectType.VIDEO:
+        return top.videoBandwidth || NaN;
+
+      case ObjectType.AUDIO:
+        return top.audioBandwidth || NaN;
+
+      default:
+        return top.bandwidth;
+    }
   }
 
   /**
@@ -404,7 +423,7 @@ shaka.util.CmcdManager = class {
    * section 3.2 of
    * [CTA-5004](https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf).
    *
-   * @param {shaka.util.CmcdManager.Data} data The CMCD data object
+   * @param {CmcdData} data The CMCD data object
    * @return {string}
    */
   static serialize(data) {
@@ -456,7 +475,7 @@ shaka.util.CmcdManager = class {
       let result;
 
       if (type === 'string' && key !== 'ot' && key !== 'sf' && key !== 'st') {
-        result = `${key}="${value.replace(/"/g, '"')}"`;
+        result = `${key}=${JSON.stringify(value)}`;
       } else if (type === 'boolean') {
         result = key;
       } else if (type === 'symbol') {
@@ -476,7 +495,7 @@ shaka.util.CmcdManager = class {
    * defined in the section 2.1 and 3.2 of
    * [CTA-5004](https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf).
    *
-   * @param {shaka.util.CmcdManager.Data} data The CMCD data object
+   * @param {CmcdData} data The CMCD data object
    * @return {!Object}
    */
   static toHeaders(data) {
@@ -512,11 +531,11 @@ shaka.util.CmcdManager = class {
    * defined in the section 2.2 and 3.2 of
    * [CTA-5004](https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf).
    *
-   * @param {shaka.util.CmcdManager.Data} data The CMCD data object
+   * @param {CmcdData} data The CMCD data object
    * @return {string}
    */
   static toQuery(data) {
-    return `CMCD=${encodeURIComponent(shaka.util.CmcdManager.serialize(data))}`;
+    return shaka.util.CmcdManager.serialize(data);
   }
 
   /**
@@ -535,8 +554,9 @@ shaka.util.CmcdManager = class {
       return uri;
     }
 
-    const separator = uri.includes('?') ? '&' : '?';
-    return `${uri}${separator}${query}`;
+    const url = new goog.Uri(uri);
+    url.getQueryData().set('CMCD', query);
+    return url.toString();
   }
 };
 
@@ -546,7 +566,7 @@ shaka.util.CmcdManager = class {
  *   getBandwidthEstimate: function():number,
  *   getBufferedInfo: function():shaka.extern.BufferedInfo,
  *   getCurrentTime: function():number,
- *   getManifest: function():shaka.extern.Manifest,
+ *   getVariantTracks: function():Array.<shaka.extern.Track>,
  *   getPlaybackRate: function():number,
  *   isLive: function():boolean
  * }}
@@ -557,8 +577,8 @@ shaka.util.CmcdManager = class {
  *   Get information about what the player has buffered.
  * @property {function():number} getCurrentTime
  *   Get the current time
- * @property {function():shaka.extern.Manifest} getManifest
- *   Get the manifest
+ * @property {function():Array.<shaka.extern.Track>} getVariantTracks
+ *   Get the variant tracks
  * @property {function():number} getPlaybackRate
  *   Get the playback rate
  * @property {function():boolean} isLive
@@ -608,180 +628,6 @@ shaka.util.CmcdManager.SegmentInfo;
 shaka.util.CmcdManager.ManifestInfo;
 
 
-/**
- * @typedef {{
- *   br: (number|undefined),
- *   d: (number|undefined),
- *   ot: (shaka.util.CmcdManager.ObjectType|undefined),
- *   tb: (number|undefined),
- *   bl: (number|undefined),
- *   dl: (number|undefined),
- *   mtp: (number|undefined),
- *   nor: (string|undefined),
- *   nrr: (string|undefined),
- *   su: (boolean|undefined),
- *   cid: (string|undefined),
- *   pr: (number|undefined),
- *   sf: (shaka.util.CmcdManager.StreamingFormat|undefined),
- *   sid: (string|undefined),
- *   st: (shaka.util.CmcdManager.StreamType|undefined),
- *   v: (number|undefined),
- *   bs: (boolean|undefined),
- *   rtp: (number|undefined)
- * }}
- *
- * @description
- *   Client Media Common Data (CMCD) data.
- *
- * @property {number} br
- *   The encoded bitrate of the audio or video object being requested. This may
- *   not be known precisely by the player; however, it MAY be estimated based
- *   upon playlist/manifest declarations. If the playlist declares both peak and
- *   average bitrate values, the peak value should be transmitted.
- *
- * @property {number} d
- *   The playback duration in milliseconds of the object being requested. If a
- *   partial segment is being requested, then this value MUST indicate the
- *   playback duration of that part and not that of its parent segment. This
- *   value can be an approximation of the estimated duration if the explicit
- *   value is not known.
- *
- * @property {shaka.util.CmcdManager.ObjectType} ot
- *   The media type of the current object being requested:
- *   - `m` = text file, such as a manifest or playlist
- *   - `a` = audio only
- *   - `v` = video only
- *   - `av` = muxed audio and video
- *   - `i` = init segment
- *   - `c` = caption or subtitle
- *   - `tt` = ISOBMFF timed text track
- *   - `k` = cryptographic key, license or certificate.
- *   - `o` = other
- *
- *   If the object type being requested is unknown, then this key MUST NOT be
- *   used.
- *
- * @property {number} tb
- *   The highest bitrate rendition in the manifest or playlist that the client
- *   is allowed to play, given current codec, licensing and sizing constraints.
- *
- * @property {number} bl
- *   The buffer length associated with the media object being requested. This
- *   value MUST be rounded to the nearest 100 ms. This key SHOULD only be sent
- *   with an object type of ‘a’, ‘v’ or ‘av’.
- *
- * @property {number} dl
- *   Deadline from the request time until the first sample of this
- *   Segment/Object needs to be available in order to not create a buffer
- *   underrun or any other playback problems. This value MUST be rounded to the
- *   nearest 100ms. For a playback rate of 1, this may be equivalent to the
- *   player’s remaining buffer length.
- *
- * @property {number} mtp
- *   The throughput between client and server, as measured by the client and
- *   MUST be rounded to the nearest 100 kbps. This value, however derived,
- *   SHOULD be the value that the client is using to make its next Adaptive
- *   Bitrate switching decision. If the client is connected to multiple
- *   servers concurrently, it must take care to report only the throughput
- *   measured against the receiving server. If the client has multiple
- *   concurrent connections to the server, then the intent is that this value
- *   communicates the aggregate throughput the client sees across all those
- *   connections.
- *
- * @property {string} nor
- *   Relative path of the next object to be requested. This can be used to
- *   trigger pre-fetching by the CDN. This MUST be a path relative to the
- *   current request. This string MUST be URLEncoded. The client SHOULD NOT
- *   depend upon any pre-fetch action being taken - it is merely a request for
- *   such a pre-fetch to take place.
- *
- * @property {string} nrr
- *   If the next request will be a partial object request, then this string
- *   denotes the byte range to be requested. If the ‘nor’ field is not set, then
- *   the object is assumed to match the object currently being requested. The
- *   client SHOULD NOT depend upon any pre-fetch action being taken – it is
- *   merely a request for such a pre-fetch to take place. Formatting is similar
- *   to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’
- *   prefix is NOT required and specifying multiple ranges is NOT allowed. Valid
- *   combinations are:
- *
- *   - `"\<range-start\>-"`
- *   - `"\<range-start\>-\<range-end\>"`
- *   - `"-\<suffix-length\>"`
- *
- * @property {boolean} su
- *   Key is included without a value if the object is needed urgently due to
- *   startup, seeking or recovery after a buffer-empty event. The media SHOULD
- *   not be rendering when this request is made. This key MUST not be sent if it
- *   is FALSE.
- *
- * @property {string} cid
- *   A unique string identifying the current content. Maximum length is 64
- *   characters. This value is consistent across multiple different sessions and
- *   devices and is defined and updated at the discretion of the service
- *   provider.
- *
- * @property {number} pr
- *   The playback rate. `1` if real-time, `2` if double speed, `0` if not
- *   playing. SHOULD only be sent if not equal to `1`.
- *
- * @property {shaka.util.CmcdManager.StreamingFormat} sf
- *   The streaming format that defines the current request.
- *
- *   - `d` = MPEG DASH
- *   - `h` = HTTP Live Streaming (HLS)
- *   - `s` = Smooth Streaming
- *   - `o` = other
- *
- *   If the streaming format being requested is unknown, then this key MUST NOT
- *   be used.
- *
- * @property {string} sid
- *   A GUID identifying the current playback session. A playback session
- *   typically ties together segments belonging to a single media asset. Maximum
- *   length is 64 characters. It is RECOMMENDED to conform to the UUID
- *   specification.
- *
- * @property {shaka.util.CmcdManager.StreamType} st
- *   Stream type
- *   - `v` = all segments are available – e.g., VOD
- *   - `l` = segments become available over time – e.g., LIVE
- *
- * @property {number} v
- *   The version of this specification used for interpreting the defined key
- *   names and values. If this key is omitted, the client and server MUST
- *   interpret the values as being defined by version 1. Client SHOULD omit this
- *   field if the version is 1.
- *
- * @property {boolean} bs
- *   Buffer starvation key is included without a value if the buffer was starved
- *   at some point between the prior request and this object request, resulting
- *   in the player being in a rebuffering state and the video or audio playback
- *   being stalled. This key MUST NOT be sent if the buffer was not starved
- *   since the prior request.
- *
- *   If the object type `ot` key is sent along with this key, then the `bs` key
- *   refers to the buffer associated with the particular object type. If no
- *   object type is communicated, then the buffer state applies to the current
- *   session.
- *
- * @property {number} rtp
- *   Requested maximum throughput
- *
- *   The requested maximum throughput that the client considers sufficient for
- *   delivery of the asset. Values MUST be rounded to the nearest 100kbps. For
- *   example, a client would indicate that the current segment, encoded at
- *   2Mbps, is to be delivered at no more than 10Mbps, by using rtp=10000.
- *
- *   Note: This can benefit clients by preventing buffer saturation through
- *   over-delivery and can also deliver a community benefit through fair-share
- *   delivery. The concept is that each client receives the throughput necessary
- *   for great performance, but no more. The CDN may not support the rtp
- *   feature.
- */
-shaka.util.CmcdManager.Data;
-
-
 /**
  * @enum {string}
  */

package/lib/util/stream_utils.js

@@ -419,13 +419,48 @@ shaka.util.StreamUtils = class {
    */
   static async filterManifestByMediaCapabilities(
       manifest, usePersistentLicenses) {
-    goog.asserts.assert(window.shakaMediaCapabilities,
+    goog.asserts.assert(navigator.mediaCapabilities,
         'MediaCapabilities should be valid.');
 
     await shaka.util.StreamUtils.getDecodingInfosForVariants(
         manifest.variants, usePersistentLicenses, /* srcEquals= */ false);
     manifest.variants = manifest.variants.filter((variant) => {
+      // See: https://github.com/google/shaka-player/issues/3860
       const video = variant.video;
+      const ContentType = shaka.util.ManifestParserUtils.ContentType;
+      if (video) {
+        let videoCodecs = shaka.util.StreamUtils.patchVp9(video.codecs);
+        // For multiplexed streams. Here we must check the audio of the
+        // stream to see if it is compatible.
+        if (video.codecs.includes(',')) {
+          const allCodecs = video.codecs.split(',');
+          videoCodecs = shaka.util.ManifestParserUtils.guessCodecs(
+              ContentType.VIDEO, allCodecs);
+          const audioCodecs = shaka.util.ManifestParserUtils.guessCodecs(
+              ContentType.AUDIO, allCodecs);
+          const audioFullType = shaka.util.MimeUtils.getFullOrConvertedType(
+              video.mimeType, audioCodecs, ContentType.AUDIO);
+          if (!MediaSource.isTypeSupported(audioFullType)) {
+            return false;
+          }
+        }
+        const fullType = shaka.util.MimeUtils.getFullOrConvertedType(
+            video.mimeType, videoCodecs, ContentType.VIDEO);
+        if (!MediaSource.isTypeSupported(fullType)) {
+          return false;
+        }
+      }
+      const audio = variant.audio;
+      if (audio) {
+        const codecs =
+            shaka.util.StreamUtils.getCorrectAudioCodecs_(audio.codecs);
+        const fullType = shaka.util.MimeUtils.getFullOrConvertedType(
+            audio.mimeType, codecs, ContentType.AUDIO);
+        if (!MediaSource.isTypeSupported(fullType)) {
+          return false;
+        }
+      }
+
       // See: https://github.com/google/shaka-player/issues/3380
       if (shaka.util.Platform.isXboxOne() && video &&
           ((video.width && video.width > 1920) ||
@@ -468,7 +503,7 @@ shaka.util.StreamUtils = class {
       return;
     }
 
-    const mediaCapabilities = window.shakaMediaCapabilities;
+    const mediaCapabilities = navigator.mediaCapabilities;
 
     const operations = [];
     const getVariantDecodingInfos = (async (variant, decodingConfig) => {
@@ -562,12 +597,8 @@ shaka.util.StreamUtils = class {
       }
     }
     if (audio) {
-      // Some Tizen devices seem to misreport AC-3 support, but correctly
-      // report EC-3 support.  So query EC-3 as a fallback for AC-3.
-      // See https://github.com/google/shaka-player/issues/2989 for details.
       const codecs =
-          (audio.codecs.toLowerCase() == 'ac-3' &&
-          shaka.util.Platform.isTizen()) ? 'ec-3' : audio.codecs;
+          shaka.util.StreamUtils.getCorrectAudioCodecs_(audio.codecs);
       const fullType = shaka.util.MimeUtils.getFullOrConvertedType(
           audio.mimeType, codecs, ContentType.AUDIO);
 
@@ -678,6 +709,26 @@ shaka.util.StreamUtils = class {
     return configs;
   }
 
+
+  /**
+   * Generates the correct audio codec for MediaDecodingConfiguration and
+   * for MediaSource.isTypeSupported.
+   * @param {string} codecs
+   * @return {string}
+   * @private
+   */
+  static getCorrectAudioCodecs_(codecs) {
+    // Some Tizen devices seem to misreport AC-3 support, but correctly
+    // report EC-3 support.  So query EC-3 as a fallback for AC-3.
+    // See https://github.com/google/shaka-player/issues/2989 for details.
+    if (shaka.util.Platform.isTizen()) {
+      return codecs.toLowerCase() == 'ac-3' ? 'ec-3' : codecs;
+    } else {
+      return codecs;
+    }
+  }
+
+
   /**
    * MediaCapabilities supports 'vp09...' codecs, but not 'vp9'. Translate vp9
    * codec strings into 'vp09...', to allow such content to play with
@@ -989,6 +1040,31 @@ shaka.util.StreamUtils = class {
   static imageStreamToTrack(stream) {
     const ContentType = shaka.util.ManifestParserUtils.ContentType;
 
+    let width = stream.width || null;
+    let height = stream.height || null;
+
+    // The stream width and height represent the size of the entire thumbnail
+    // sheet, so divide by the layout.
+    let reference = null;
+    // Note: segmentIndex is built by default for HLS, but not for DASH, but
+    // in DASH this information comes at the stream level and not at the
+    // segment level.
+    if (stream.segmentIndex) {
+      reference = stream.segmentIndex.get(0);
+    }
+    let layout = stream.tilesLayout;
+    if (reference) {
+      layout = reference.getTilesLayout() || layout;
+    }
+    if (layout && width != null) {
+      width /= Number(layout.split('x')[0]);
+    }
+    if (layout && height != null) {
+      height /= Number(layout.split('x')[1]);
+    }
+    // TODO: What happens if there are multiple grids, with different
+    // layout sizes, inside this image stream?
+
     /** @type {shaka.extern.Track} */
     const track = {
       id: stream.id,
@@ -998,8 +1074,8 @@ shaka.util.StreamUtils = class {
       language: '',
       label: null,
       kind: null,
-      width: stream.width || null,
-      height: stream.height || null,
+      width,
+      height,
       frameRate: null,
       pixelAspectRatio: null,
       hdr: null,
@@ -1016,7 +1092,7 @@ shaka.util.StreamUtils = class {
       channelsCount: null,
       audioSamplingRate: null,
       spatialAudio: false,
-      tilesLayout: stream.tilesLayout || null,
+      tilesLayout: layout || null,
       audioBandwidth: null,
       videoBandwidth: null,
       originalVideoId: null,

package/lib/util/xml_utils.js

@@ -103,6 +103,25 @@ shaka.util.XmlUtils = class {
   }
 
 
+  /**
+   * Gets a namespace-qualified attribute.
+   * @param {!Element} elem The element to get from.
+   * @param {!Array.<string>} nsList The lis of namespace URIs.
+   * @param {string} name The local name of the attribute.
+   * @return {?string} The attribute's value, or null if not present.
+   */
+  static getAttributeNSList(elem, nsList, name) {
+    // Some browsers return the empty string when the attribute is missing,
+    // so check if it exists first.  See: https://mzl.la/2L7F0UK
+    for (const ns of nsList) {
+      if (elem.hasAttributeNS(ns, name)) {
+        return elem.getAttributeNS(ns, name);
+      }
+    }
+    return null;
+  }
+
+
   /**
    * Gets the text contents of a node.
    * @param {!Node} elem The XML element.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "homepage": "https://github.com/google/shaka-player",
   "author": "Google",
   "maintainers": [
@@ -12,6 +12,7 @@
   ],
   "devDependencies": {
     "@chiragrupani/karma-chromium-edge-launcher": "^2.1.0",
+    "@onslip/karma-safari-launcher": "^1.0.1",
     "@teppeis/clutz": "^1.0.29-4c95e12.v20190929",
     "awesomplete": "^1.1.4",
     "babel-core": "^6.26.3",
@@ -44,7 +45,6 @@
     "karma-jasmine": "^3.3.1",
     "karma-jasmine-ajax": "^0.1.13",
     "karma-opera-launcher": "^1.0.0",
-    "karma-safari-launcher": "^1.0.0",
     "karma-sourcemap-loader": "^0.3.7",
     "karma-spec-reporter": "0.0.32",
     "karma-webdriver-launcher": "^1.0.8",

package/test/media/drm_engine_unit.js

@@ -31,7 +31,7 @@ describe('DrmEngine', () => {
       navigator.requestMediaKeySystemAccess;
   const originalLogError = shaka.log.error;
   const originalBatchTime = shaka.media.DrmEngine.KEY_STATUS_BATCH_TIME;
-  const originalDecodingInfo = window.shakaMediaCapabilities.decodingInfo;
+  const originalDecodingInfo = navigator.mediaCapabilities.decodingInfo;
 
   /** @type {!jasmine.Spy} */
   let decodingInfoSpy;
@@ -76,7 +76,7 @@ describe('DrmEngine', () => {
 
   beforeEach(() => {
     decodingInfoSpy = jasmine.createSpy('decodingInfo');
-    window.shakaMediaCapabilities.decodingInfo =
+    navigator.mediaCapabilities.decodingInfo =
         shaka.test.Util.spyFunc(decodingInfoSpy);
 
     logErrorSpy = jasmine.createSpy('shaka.log.error');
@@ -153,7 +153,7 @@ describe('DrmEngine', () => {
 
     navigator.requestMediaKeySystemAccess =
         originalRequestMediaKeySystemAccess;
-    window.shakaMediaCapabilities.decodingInfo = originalDecodingInfo;
+    navigator.mediaCapabilities.decodingInfo = originalDecodingInfo;
     shaka.log.error = originalLogError;
   });
 

package/test/media/streaming_engine_integration.js

@@ -420,8 +420,9 @@ describe('StreamingEngine', () => {
       //   3. Playhead seeks to force us back inside the window
       //   4. (maybe) seek if there is a gap at the period boundary
       //   5. (maybe) seek to flush a pipeline stall
+      //   6. (maybe) on slower platforms (e.g. GitHub actions)
       expect(seekCount).toBeGreaterThan(2);
-      expect(seekCount).toBeLessThan(6);
+      expect(seekCount).toBeLessThan(7);
     });
   });