shaka-player 3.2.0 → 3.2.4

package/lib/util/platform.js

@@ -163,7 +163,6 @@ shaka.util.Platform = class {
            !shaka.util.Platform.isEdge();
   }
 
-
   /**
    * Check if the current platform is from Apple.
    *
@@ -179,6 +178,19 @@ shaka.util.Platform = class {
             && !shaka.util.Platform.isTizen();
   }
 
+  /**
+   * Check if the current platform is Playstation 5.
+   *
+   * Returns true on Playstation 5 browsers.
+   *
+   * Returns false for Playstation 5 browsers
+   *
+   * @return {boolean}
+   */
+  static isPS5() {
+    return shaka.util.Platform.userAgentContains_('PlayStation 5');
+  }
+
   /**
    * Returns a major version number for Safari, or Safari-based iOS browsers.
    *

package/lib/util/stream_utils.js

@@ -423,9 +423,44 @@ shaka.util.StreamUtils = class {
         'MediaCapabilities should be valid.');
 
     await shaka.util.StreamUtils.getDecodingInfosForVariants(
-        manifest.variants, usePersistentLicenses);
+        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) ||
@@ -456,9 +491,11 @@ shaka.util.StreamUtils = class {
    *
    * @param {!Array.<shaka.extern.Variant>} variants
    * @param {boolean} usePersistentLicenses
+   * @param {boolean} srcEquals
    * @exportDoc
    */
-  static async getDecodingInfosForVariants(variants, usePersistentLicenses) {
+  static async getDecodingInfosForVariants(variants, usePersistentLicenses,
+      srcEquals) {
     const gotDecodingInfo = variants.some((variant) =>
       variant.decodingInfos.length);
     if (gotDecodingInfo) {
@@ -482,7 +519,7 @@ shaka.util.StreamUtils = class {
     for (const variant of variants) {
       /** @type {!Array.<!MediaDecodingConfiguration>} */
       const decodingConfigs = shaka.util.StreamUtils.getDecodingConfigs_(
-          variant, usePersistentLicenses);
+          variant, usePersistentLicenses, srcEquals);
 
       for (const config of decodingConfigs) {
         operations.push(getVariantDecodingInfos(variant, config));
@@ -497,17 +534,18 @@ shaka.util.StreamUtils = class {
    * results for each variant.
    * @param {!shaka.extern.Variant} variant
    * @param {boolean} usePersistentLicenses
+   * @param {boolean} srcEquals
    * @return {!Array.<!MediaDecodingConfiguration>}
    * @private
    */
-  static getDecodingConfigs_(variant, usePersistentLicenses) {
+  static getDecodingConfigs_(variant, usePersistentLicenses, srcEquals) {
     const audio = variant.audio;
     const video = variant.video;
     const ContentType = shaka.util.ManifestParserUtils.ContentType;
 
     /** @type {!MediaDecodingConfiguration} */
     const mediaDecodingConfig = {
-      type: 'media-source',
+      type: srcEquals ? 'file' : 'media-source',
     };
 
     if (video) {
@@ -544,14 +582,23 @@ shaka.util.StreamUtils = class {
         // framerate must be greater than 0, otherwise the config is invalid.
         framerate: video.frameRate || 1,
       };
+      if (video.hdr) {
+        switch (video.hdr) {
+          case 'SDR':
+            mediaDecodingConfig.video.transferFunction = 'srgb';
+            break;
+          case 'PQ':
+            mediaDecodingConfig.video.transferFunction = 'pq';
+            break;
+          case 'HLG':
+            mediaDecodingConfig.video.transferFunction = 'hlg';
+            break;
+        }
+      }
     }
     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);
 
@@ -662,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
@@ -973,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,
@@ -982,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,
@@ -1000,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

@@ -6,6 +6,7 @@
 
 goog.provide('shaka.util.XmlUtils');
 
+goog.require('goog.asserts');
 goog.require('shaka.log');
 goog.require('shaka.util.StringUtils');
 
@@ -102,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.
@@ -312,29 +332,46 @@ shaka.util.XmlUtils = class {
 
 
   /**
-   * Parse a string and return the resulting root element if
-   * it was valid XML.
+   * Parse a string and return the resulting root element if it was valid XML.
+   *
    * @param {string} xmlString
    * @param {string} expectedRootElemName
    * @return {Element}
    */
   static parseXmlString(xmlString, expectedRootElemName) {
     const parser = new DOMParser();
-    let rootElem = null;
     let xml = null;
     try {
       xml = parser.parseFromString(xmlString, 'text/xml');
-    } catch (exception) {}
-    if (xml) {
-      // The top-level element in the loaded xml should have the
-      // same type as the element linking.
-      if (xml.documentElement.tagName == expectedRootElemName) {
-        rootElem = xml.documentElement;
-      }
+    } catch (exception) {
+      shaka.log.error('XML parsing exception:', exception);
+      return null;
     }
-    if (rootElem && rootElem.getElementsByTagName('parsererror').length > 0) {
+
+    // According to MDN, parseFromString never returns null.
+    goog.asserts.assert(xml, 'Parsed XML document cannot be null!');
+
+    // Check for empty documents.
+    const rootElem = xml.documentElement;
+    if (!rootElem) {
+      shaka.log.error('XML document was empty!');
       return null;
-    }  // It had a parser error in it.
+    }
+
+    // Check for parser errors.
+    const parserErrorElements = rootElem.getElementsByTagName('parsererror');
+    if (parserErrorElements.length) {
+      shaka.log.error('XML parser error found:', parserErrorElements[0]);
+      return null;
+    }
+
+    // The top-level element in the loaded XML should have the name we expect.
+    if (xml.documentElement.tagName != expectedRootElemName) {
+      shaka.log.error(
+          `XML tag name does not match expected "${expectedRootElemName}":`,
+          xml.documentElement.tagName);
+      return null;
+    }
 
     return rootElem;
   }
@@ -352,6 +389,7 @@ shaka.util.XmlUtils = class {
       const string = shaka.util.StringUtils.fromUTF8(data);
       return shaka.util.XmlUtils.parseXmlString(string, expectedRootElemName);
     } catch (exception) {
+      shaka.log.error('parseXmlString threw!', exception);
       return null;
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.2.0",
+  "version": "3.2.4",
   "homepage": "https://github.com/google/shaka-player",
   "author": "Google",
   "maintainers": [
@@ -11,7 +11,6 @@
     }
   ],
   "devDependencies": {
-    "@chiragrupani/karma-chromium-edge-launcher": "^2.1.0",
     "@teppeis/clutz": "^1.0.29-4c95e12.v20190929",
     "awesomplete": "^1.1.4",
     "babel-core": "^6.26.3",
@@ -36,15 +35,12 @@
     "jsdoc": "github:joeyparrish/jsdoc#45c271fa",
     "karma": "^6.2.0",
     "karma-babel-preprocessor": "^7.0.0",
-    "karma-chrome-launcher": "^2.2.0",
     "karma-coverage": "^1.1.2",
-    "karma-edge-launcher": "^0.4.2",
-    "karma-firefox-launcher": "^1.1.0",
     "karma-ie-launcher": "^1.0.0",
     "karma-jasmine": "^3.3.1",
     "karma-jasmine-ajax": "^0.1.13",
+    "karma-local-wd-launcher": "^1.4.1",
     "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",
@@ -55,6 +51,7 @@
     "pwacompat": "^2.0.10",
     "rimraf": "^2.6.3",
     "sprintf-js": "^1.1.2",
+    "ssim.js": "^3.5.0",
     "stylelint": "^13.8.0",
     "stylelint-config-standard": "^20.0.0",
     "tippy.js": "^4.3.1",

package/roadmap.md

@@ -8,49 +8,51 @@ CHANGELOG.md.
 The goals of future milestones are fluid until we begin that development cycle,
 so the exact milestone for future features is not pre-determined.
 
-Candidate features for future release cycles
- - HLS performance improvements
-   https://github.com/google/shaka-player/issues/3363
- - HLS interstitial support
-   https://github.com/google/shaka-player/issues/3364
- - Integration with Google Video ML/Cloud AI
+Priority features up next:
  - Support containerless formats
    https://github.com/google/shaka-player/issues/2337
+ - Preload API
+   https://github.com/google/shaka-player/issues/880
+ - Codec-switching and order preference
+   https://github.com/google/shaka-player/issues/1528
+   https://github.com/google/shaka-player/issues/2179
+
+Candidate features for future release cycles:
+ - HLS interstitial support
+   https://github.com/google/shaka-player/issues/3364
  - Support ID3 tags in mp4
    https://github.com/google/shaka-player/issues/3351
  - MSE support for FairPlay
    https://github.com/google/shaka-player/issues/3346
- - Codec-switching and order preference
-   https://github.com/google/shaka-player/issues/1528
-   https://github.com/google/shaka-player/issues/2179
- - Configurable key-system priority
-   https://github.com/google/shaka-player/issues/3002
- - Preload API
-   https://github.com/google/shaka-player/issues/880
- - Thumbnail tracks
-   DASH: https://github.com/google/shaka-player/issues/559
-   HLS: https://github.com/google/shaka-player/issues/2429
  - Smaller, more modular binary
  - Official TypeScript defs, generated from source
    https://github.com/google/shaka-player/issues/1030
+ - Shaka Analytics Component and an integration with BigQuery Analytics
+   https://github.com/google/shaka-player/issues/3359
+ - Integration with Google Video ML/Cloud AI
 
-v3.3 - 2021 Q3
+v3.3 - 2021 Q3 or Q4
  - Background fetch for offline storage
    https://github.com/google/shaka-player/issues/879
- - Shaka Analytics Component and an integration with BigQuery Analytics
-   https://github.com/google/shaka-player/issues/3359
+ - HLS performance improvements
+   https://github.com/google/shaka-player/issues/3363
 
-v3.2 - 2021 Q2
+=====
+
+v3.2 - 2021 Q3
  - MediaCapabilities to make performance-based decisions
    https://github.com/google/shaka-player/issues/1391
+ - Configurable key-system priority
+   https://github.com/google/shaka-player/issues/3002
 
 v3.1 - 2021 Q2
  - Low-latency live (LL-HLS, LL-DASH)
    https://github.com/google/shaka-player/issues/1525
  - Own CEA parser, use mux.js only for TS
    https://github.com/google/shaka-player/issues/2648
-
-=====
+ - Thumbnail tracks
+   DASH: https://github.com/google/shaka-player/issues/559
+   HLS: https://github.com/google/shaka-player/issues/2429
 
 v3.0 - 2020 Q2
  - Code health improvements

package/test/cast/cast_proxy_unit.js

@@ -297,7 +297,8 @@ describe('CastProxy', () => {
             'timeupdate', Util.spyFunc(proxyListener));
 
         expect(proxyListener).not.toHaveBeenCalled();
-        const fakeEvent = new FakeEvent('timeupdate', {detail: 8675309});
+        const fakeEvent = new FakeEvent(
+            'timeupdate', (new Map()).set('detail', 8675309));
         mockVideo.on['timeupdate'](fakeEvent);
         expect(proxyListener).toHaveBeenCalledWith(jasmine.objectContaining({
           type: 'timeupdate',
@@ -315,7 +316,8 @@ describe('CastProxy', () => {
         mockSender.hasRemoteProperties.and.returnValue(true);
 
         expect(proxyListener).not.toHaveBeenCalled();
-        const fakeEvent = new FakeEvent('timeupdate', {detail: 8675309});
+        const fakeEvent = new FakeEvent(
+            'timeupdate', (new Map()).set('detail', 8675309));
         mockVideo.on['timeupdate'](fakeEvent);
         expect(proxyListener).not.toHaveBeenCalled();
       });
@@ -332,7 +334,8 @@ describe('CastProxy', () => {
         mockSender.hasRemoteProperties.and.returnValue(true);
 
         expect(proxyListener).not.toHaveBeenCalled();
-        const fakeEvent = new FakeEvent('timeupdate', {detail: 8675309});
+        const fakeEvent = new FakeEvent(
+            'timeupdate', (new Map()).set('detail', 8675309));
         mockSender.onRemoteEvent('video', fakeEvent);
         expect(proxyListener).toHaveBeenCalledWith(jasmine.objectContaining({
           type: 'timeupdate',
@@ -446,7 +449,8 @@ describe('CastProxy', () => {
             'buffering', Util.spyFunc(proxyListener));
 
         expect(proxyListener).not.toHaveBeenCalled();
-        const fakeEvent = new FakeEvent('buffering', {detail: 8675309});
+        const fakeEvent = new FakeEvent(
+            'buffering', (new Map()).set('detail', 8675309));
         mockPlayer.listeners['buffering'](fakeEvent);
         expect(proxyListener).toHaveBeenCalledWith(jasmine.objectContaining({
           type: 'buffering',
@@ -464,7 +468,8 @@ describe('CastProxy', () => {
         mockSender.hasRemoteProperties.and.returnValue(true);
 
         expect(proxyListener).not.toHaveBeenCalled();
-        const fakeEvent = new FakeEvent('buffering', {detail: 8675309});
+        const fakeEvent = new FakeEvent(
+            'buffering', (new Map()).set('detail', 8675309));
         mockPlayer.listeners['buffering'](fakeEvent);
         expect(proxyListener).not.toHaveBeenCalled();
       });
@@ -481,7 +486,8 @@ describe('CastProxy', () => {
         mockSender.hasRemoteProperties.and.returnValue(true);
 
         expect(proxyListener).not.toHaveBeenCalled();
-        const fakeEvent = new FakeEvent('buffering', {detail: 8675309});
+        const fakeEvent = new FakeEvent(
+            'buffering', (new Map()).set('detail', 8675309));
         mockSender.onRemoteEvent('player', fakeEvent);
         expect(proxyListener).toHaveBeenCalledWith(jasmine.objectContaining({
           type: 'buffering',

package/test/cast/cast_receiver_integration.js

@@ -170,7 +170,7 @@ filterDescribe('CastReceiver', castReceiverIntegrationSupport, () => {
       // Check that the update message is of a reasonable size. From previous
       // testing we found that the socket would silently reject data that got
       // too big. 6KB is safely below the limit.
-      expect(message.length).toBeLessThan(6 * 1024);
+      expect(message.length).toBeLessThan(7 * 1024);
     });
 
     drmIt('has reasonable average message size', async () => {

package/test/cast/cast_utils_unit.js

@@ -123,7 +123,7 @@ describe('CastUtils', () => {
       expect(typeof deserialized).toBe('object');
 
       // The object can be used to construct a FakeEvent.
-      const fakeEvent = new FakeEvent(deserialized['type'], deserialized);
+      const fakeEvent = FakeEvent.fromRealEvent(deserialized);
 
       // The fake event has the same type and properties as the original.
       const asObj = /** @type {!Object} */ (fakeEvent);

package/test/cea/mp4_cea_parser_unit.js

@@ -27,6 +27,32 @@ describe('Mp4CeaParser', () => {
     ceaSegment = responses[1];
   });
 
+  /**
+   * Test only the functionality of removing EPB
+   * Expect removeEmu() to return the NALU with correct length
+   *
+   * Chromium VDA has a strict standard on NALU length
+   * It will complain about conformance if the array is malformed
+   *
+   * If EPB is removed by shifting bytes, it will return the original NALU
+   * length, which will fail this test
+   *
+   * Note that the CEA-608 packet in this test is incomplete
+   */
+  it('parses CEA-608 SEI data from MP4 H.264 stream', () => {
+    const seiProcessor = new shaka.cea.SeiProcessor();
+
+    const cea608Packet = new Uint8Array([
+      0x00, 0x00, 0x03, // Emulation prevention byte
+    ]);
+
+    const naluData = seiProcessor.removeEmu(cea608Packet);
+    expect(naluData).toBeDefined();
+
+    // EPB should be removed by returning new array, not by shifting bytes
+    expect(naluData.length).toBe(2);
+  });
+
   it('parses cea data from mp4 stream', () => {
     const cea708Parser = new shaka.cea.Mp4CeaParser();
 

package/test/dash/dash_parser_live_unit.js

@@ -1289,6 +1289,49 @@ describe('DashParser Live', () => {
           .toHaveBeenCalledWith(
               jasmine.objectContaining({id: '2', startTime: 10, endTime: 25}));
     });
+
+    it('will not add timeline regions outside the DVR window', async () => {
+      const manifest = [
+        '<MPD type="dynamic" minimumUpdatePeriod="PT' + updateTime + 'S"',
+        '    availabilityStartTime="1970-01-01T00:00:00Z"',
+        '    suggestedPresentationDelay="PT0S"',
+        '    timeShiftBufferDepth="PT30S">',
+        '  <Period id="1">',
+        '    <EventStream schemeIdUri="http://example.com" timescale="1">',
+        '      <Event id="0" presentationTime="0" duration="10"/>',
+        '      <Event id="1" presentationTime="10" duration="10"/>',
+        '      <Event id="2" presentationTime="20" duration="10"/>',
+        '      <Event id="3" presentationTime="30" duration="10"/>',
+        '      <Event id="4" presentationTime="40" duration="10"/>',
+        '    </EventStream>',
+        '    <AdaptationSet mimeType="video/mp4">',
+        '      <Representation bandwidth="1">',
+        '        <SegmentTemplate startNumber="1" media="s$Number$.mp4"',
+        '                         duration="2" />',
+        '      </Representation>',
+        '    </AdaptationSet>',
+        '  </Period>',
+        '</MPD>',
+      ].join('\n');
+
+      // 45 seconds after the epoch, which is also 45 seconds after the
+      // presentation started.  Only the last 30 seconds are available, from
+      // time 15 to 45.
+      Date.now = () => 45 * 1000;
+
+      fakeNetEngine.setResponseText('dummy://foo', manifest);
+      await parser.start('dummy://foo', playerInterface);
+
+      expect(onTimelineRegionAddedSpy).toHaveBeenCalledTimes(4);
+      expect(onTimelineRegionAddedSpy).toHaveBeenCalledWith(
+          jasmine.objectContaining({id: '1'}));
+      expect(onTimelineRegionAddedSpy).toHaveBeenCalledWith(
+          jasmine.objectContaining({id: '2'}));
+      expect(onTimelineRegionAddedSpy).toHaveBeenCalledWith(
+          jasmine.objectContaining({id: '3'}));
+      expect(onTimelineRegionAddedSpy).toHaveBeenCalledWith(
+          jasmine.objectContaining({id: '4'}));
+    });
   });
 
   it('honors clockSyncUri for in-progress recordings', async () => {