shaka-player 3.1.5 → 3.1.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "homepage": "https://github.com/google/shaka-player",
   "author": "Google",
   "maintainers": [
@@ -11,8 +11,6 @@
     }
   ],
   "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",
@@ -37,13 +35,11 @@
     "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-sourcemap-loader": "^0.3.7",
     "karma-spec-reporter": "0.0.32",
@@ -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/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 () => {

package/test/dash/dash_parser_manifest_unit.js

@@ -983,7 +983,8 @@ describe('DashParser Manifest', () => {
 
     it('duplicate Representation ids with live', async () => {
       const source = [
-        '<MPD minBufferTime="PT75S" type="dynamic">',
+        '<MPD minBufferTime="PT75S" type="dynamic"',
+        '     availabilityStartTime="1970-01-01T00:00:00Z">',
         '  <Period id="1" duration="PT30S">',
         '    <AdaptationSet mimeType="video/mp4">',
         '      <Representation id="1" bandwidth="1">',

package/test/hls/hls_parser_unit.js

@@ -209,6 +209,80 @@ describe('HlsParser', () => {
     expect(actual).toEqual(manifest);
   });
 
+  it('parses manifest attributes with space', async () => {
+    const master = [
+      '#EXTM3U\n',
+      '#EXT-X-MEDIA:TYPE=AUDIO, GROUP-ID="aud1", LANGUAGE="eng", ',
+      'CHANNELS="16/JOC", URI="audio"\n',
+      '#EXT-X-MEDIA:TYPE=SUBTITLES, GROUP-ID="sub1", LANGUAGE="eng", ',
+      'URI="text"\n',
+      '#EXT-X-MEDIA:TYPE=SUBTITLES, GROUP-ID="sub2", LANGUAGE="es", ',
+      'URI="text2"\n',
+      '#EXT-X-STREAM-INF:BANDWIDTH=200, CODECS="avc1,mp4a", ',
+      'RESOLUTION=960x540, FRAME-RATE=60, AUDIO="aud1"\n',
+      'video\n',
+    ].join('');
+
+    const media = [
+      '#EXTM3U\n',
+      '#EXT-X-PLAYLIST-TYPE:VOD\n',
+      '#EXT-X-MAP:URI="init.mp4",BYTERANGE="616@0"\n',
+      '#EXTINF:5,\n',
+      '#EXT-X-BYTERANGE:121090@616\n',
+      'main.mp4',
+    ].join('');
+
+    const textMedia = [
+      '#EXTM3U\n',
+      '#EXT-X-PLAYLIST-TYPE:VOD\n',
+      '#EXTINF:5,\n',
+      '#EXT-X-BYTERANGE:121090@616\n',
+      'main.vtt',
+    ].join('');
+
+    const manifest = shaka.test.ManifestGenerator.generate((manifest) => {
+      manifest.anyTimeline();
+      manifest.addPartialVariant((variant) => {
+        variant.language = 'en';
+        variant.bandwidth = 200;
+        variant.addPartialStream(ContentType.VIDEO, (stream) => {
+          stream.frameRate = 60;
+          stream.mime('video/mp4', 'avc1');
+          stream.size(960, 540);
+        });
+        variant.addPartialStream(ContentType.AUDIO, (stream) => {
+          stream.language = 'en';
+          stream.channelsCount = 16;
+          stream.spatialAudio = true;
+          stream.mime('audio/mp4', 'mp4a');
+        });
+      });
+      manifest.addPartialTextStream((stream) => {
+        stream.language = 'en';
+        stream.kind = TextStreamKind.SUBTITLE;
+        stream.mime('text/vtt', '');
+      });
+      manifest.addPartialTextStream((stream) => {
+        stream.language = 'es';
+        stream.kind = TextStreamKind.SUBTITLE;
+        stream.mime('text/vtt', '');
+      });
+    });
+
+    fakeNetEngine
+        .setResponseText('test:/master', master)
+        .setResponseText('test:/audio', media)
+        .setResponseText('test:/video', media)
+        .setResponseText('test:/text', textMedia)
+        .setResponseText('test:/text2', textMedia)
+        .setResponseText('test:/main.vtt', vttText)
+        .setResponseValue('test:/init.mp4', initSegmentData)
+        .setResponseValue('test:/main.mp4', segmentData);
+
+    const actual = await parser.start('test:/master', playerInterface);
+    expect(actual).toEqual(manifest);
+  });
+
   it('prioritize AVERAGE-BANDWIDTH to BANDWIDTH', async () => {
     const master = [
       '#EXTM3U\n',

package/test/media/region_observer_unit.js

@@ -15,6 +15,9 @@ describe('RegionObserver', () => {
   /** @type {!shaka.media.RegionObserver} */
   let observer;
 
+  /** @type {!jasmine.Spy} */
+  let onSeekRange;
+
   /** @type {!jasmine.Spy} */
   let onEnterRegion;
   /** @type {!jasmine.Spy} */
@@ -23,18 +26,26 @@ describe('RegionObserver', () => {
   let onSkipRegion;
 
   beforeEach(() => {
+    onSeekRange = jasmine.createSpy('onSeekRange');
+    onSeekRange.and.returnValue({start: 0, end: 100});
+
     onEnterRegion = jasmine.createSpy('onEnterRegion');
     onExitRegion = jasmine.createSpy('onExitRegion');
     onSkipRegion = jasmine.createSpy('onSkipRegion');
 
     timeline = new shaka.media.RegionTimeline(
-        () => { return {start: 0, end: 100}; });
+        shaka.test.Util.spyFunc(onSeekRange));
 
     observer = new shaka.media.RegionObserver(timeline);
-    observer.setListeners(
-        /* onEnter= */ shaka.test.Util.spyFunc(onEnterRegion),
-        /* onExit= */ shaka.test.Util.spyFunc(onExitRegion),
-        /* onSkip= */ shaka.test.Util.spyFunc(onSkipRegion));
+    observer.addEventListener('enter', (event) => {
+      shaka.test.Util.spyFunc(onEnterRegion)(event['region'], event['seeking']);
+    });
+    observer.addEventListener('exit', (event) => {
+      shaka.test.Util.spyFunc(onExitRegion)(event['region'], event['seeking']);
+    });
+    observer.addEventListener('skip', (event) => {
+      shaka.test.Util.spyFunc(onSkipRegion)(event['region'], event['seeking']);
+    });
   });
 
   it('fires enter event when adding a region the playhead is in', () => {
@@ -313,6 +324,30 @@ describe('RegionObserver', () => {
     expect(onSkipRegion).not.toHaveBeenCalled();
   });
 
+  // See https://github.com/google/shaka-player/issues/3949
+  it('cleans up references to regions', async () => {
+    const region = createRegion('my-region', 0, 10);
+    timeline.addRegion(region);
+
+    // Poll so that RegionObserver will store regions.
+    poll(observer,
+        /* timeInSeconds= */ 5,
+        /* seeking= */ false);
+
+    // Hack to get a private member without the compiler complaining:
+    /** @type {Map} */
+    const regionMap = (/** @type {?} */(observer))['oldPosition_'];
+    expect(regionMap.size).not.toBe(0);
+
+    // Move the seek range so that the region will be removed.
+    onSeekRange.and.returnValue({start: 20, end: 100});
+    // Give the timeline time to filter regions
+    await shaka.test.Util.delay(
+        shaka.media.RegionTimeline.REGION_FILTER_INTERVAL * 2);
+
+    expect(regionMap.size).toBe(0);
+  });
+
   /**
    * @param {string} id
    * @param {number} startTimeSeconds

package/test/media/region_timeline_unit.js

@@ -14,18 +14,27 @@ describe('RegionTimeline', () => {
   /** @type {!jasmine.Spy} */
   let onNewRegion;
 
+  /** @type {!jasmine.Spy} */
+  let onRemoveRegion;
+
   /** @type {!jasmine.Spy} */
   let onSeekRange;
 
   beforeEach(() => {
-    onNewRegion = jasmine.createSpy('onNewRegion');
-
     onSeekRange = jasmine.createSpy('onSeekRange');
     onSeekRange.and.returnValue({start: 0, end: 100});
-
     timeline = new shaka.media.RegionTimeline(
         shaka.test.Util.spyFunc(onSeekRange));
-    timeline.setListeners(shaka.test.Util.spyFunc(onNewRegion));
+
+    onNewRegion = jasmine.createSpy('onNewRegion');
+    timeline.addEventListener('regionadd', (event) => {
+      shaka.test.Util.spyFunc(onNewRegion)(event['region']);
+    });
+
+    onRemoveRegion = jasmine.createSpy('onRemoveRegion');
+    timeline.addEventListener('regionremove', (event) => {
+      shaka.test.Util.spyFunc(onRemoveRegion)(event['region']);
+    });
   });
 
   afterEach(() => {
@@ -85,24 +94,33 @@ describe('RegionTimeline', () => {
     ]);
   });
 
-  it('filters out regions that end before the start of the seek range',
-      async () => {
-        onSeekRange.and.returnValue({start: 5, end: 100});
-        const region1 = createRegion('urn:foo', 'my-region', 0, 3);
-        const region2 = createRegion('urn:foo', 'my-region', 3, 10);
-        const region3 = createRegion('urn:foo', 'my-region', 5, 10);
-        timeline.addRegion(region1);
-        timeline.addRegion(region2);
-        timeline.addRegion(region3);
-        expect(onNewRegion).toHaveBeenCalledTimes(3);
-        let regions = Array.from(timeline.regions());
-        expect(regions.length).toBe(3);
-        // Give the timeline time to filter regions
-        await shaka.test.Util.delay(
-            shaka.media.RegionTimeline.REGION_FILTER_INTERVAL * 2);
-        regions = Array.from(timeline.regions());
-        expect(regions).toEqual([region2, region3]);
-      });
+  it('filters regions that end before the seek range', async () => {
+    onSeekRange.and.returnValue({start: 5, end: 100});
+
+    const region1 = createRegion('urn:foo', 'my-region', 0, 3);
+    const region2 = createRegion('urn:foo', 'my-region', 3, 10);
+    const region3 = createRegion('urn:foo', 'my-region', 5, 10);
+
+    timeline.addRegion(region1);
+    timeline.addRegion(region2);
+    timeline.addRegion(region3);
+    expect(onNewRegion).toHaveBeenCalledTimes(3);
+    expect(onNewRegion).toHaveBeenCalledWith(region1);
+    expect(onNewRegion).toHaveBeenCalledWith(region2);
+    expect(onNewRegion).toHaveBeenCalledWith(region3);
+
+    let regions = Array.from(timeline.regions());
+    expect(regions.length).toBe(3);
+
+    // Give the timeline time to filter regions
+    await shaka.test.Util.delay(
+        shaka.media.RegionTimeline.REGION_FILTER_INTERVAL * 2);
+
+    regions = Array.from(timeline.regions());
+    expect(regions).toEqual([region2, region3]);
+
+    expect(onRemoveRegion).toHaveBeenCalledWith(region1);
+  });
 
   /**
    * @param {string} schemeIdUri

package/test/test/util/util.js

@@ -401,10 +401,10 @@ shaka.test.Util = class {
    *   within the bounds of the viewport.
    * @param {string} name An identifier for the screenshot.  Use alphanumeric
    *   plus dash and underscore only.
-   * @param {number} threshold A change threshold in pixels.
+   * @param {number} minSimilarity A minimum similarity score between 0 and 1.
    * @return {!Promise}
    */
-  static async checkScreenshot(element, name, threshold=0) {
+  static async checkScreenshot(element, name, minSimilarity=1) {
     // Make sure the DOM is up-to-date and layout has settled before continuing.
     // Without this delay, or with a shorter delay, we sometimes get missing
     // elements in our UITextDisplayer tests on some platforms.
@@ -448,13 +448,16 @@ shaka.test.Util = class {
     const buffer = await shaka.test.Util.fetch(
         '/screenshot/diff' + parentUrlParams + paramsString);
     const json = shaka.util.StringUtils.fromUTF8(buffer);
-    const pixelsChanged = /** @type {number} */(JSON.parse(json));
+    const similarity = /** @type {number} */(JSON.parse(json));
 
-    // If the change threshold is exceeded, you can review the new screenshot
+    // If the minimum similarity is not met, you can review the new screenshot
     // and the diff image in the screenshots folder.  Look for images that end
-    // with "-new" and "-diff".  If cropping doesn't work right, you can view
-    // the full-page screenshot in the image that ends with "-full".
-    expect(pixelsChanged).withContext(name).not.toBeGreaterThan(threshold);
+    // with "-new" and "-diff".  (NOTE: The diff is a pixel-wise diff for human
+    // review, and is not produced with the same structural similarity
+    // algorithm used to detect changes in the test.)  If cropping doesn't work
+    // right, you can view the full-page screenshot in the image that ends with
+    // "-full".
+    expect(similarity).withContext(name).not.toBeLessThan(minSimilarity);
   }
 };
 

package/test/ui/text_displayer_layout_unit.js

@@ -34,11 +34,8 @@ filterDescribe('TextDisplayer layout', supportsScreenshots, () => {
    */
   let beforeScreenshot;
 
-  // Legacy Edge seems to have inconsistent font kerning.  A one-pixel offset in
-  // the position of one character appears about 60% of the time, requiring us
-  // to have this change tolerance in our tests.  So far, all past bugs in our
-  // implementation that we have tests for would exceed this threshold by a lot.
-  const threshold = 160;  // px
+  // A minimum similarity score for screenshots, between 0 and 1.
+  const minSimilarity = 0.95;
 
   const originalCast = window.chrome && window.chrome.cast;
 
@@ -196,6 +193,7 @@ filterDescribe('TextDisplayer layout', supportsScreenshots, () => {
 
         // The video must be played a little now, after the cues were appended,
         // but before the screenshot.
+        video.playbackRate = 1;
         video.play();
         await waiter.failOnTimeout(false).timeoutAfter(5)
             .waitForMovement(video);
@@ -203,10 +201,13 @@ filterDescribe('TextDisplayer layout', supportsScreenshots, () => {
 
         // Seek to a time when cues should be showing.
         video.currentTime = time;
+        // Get into a playing state, but without movement.
+        video.playbackRate = 0;
+        video.play();
 
         // Add a short delay to ensure that the system has caught up and that
         // native text displayers have been updated by the browser.
-        await Util.shortDelay();
+        await Util.delay(0.1);
       };
     });
 
@@ -475,6 +476,6 @@ filterDescribe('TextDisplayer layout', supportsScreenshots, () => {
     return Util.checkScreenshot(
         /* element= */ videoContainer,
         prefix + '-' + baseName,
-        threshold);
+        minSimilarity);
   }
 });

package/ui/controls.js

@@ -253,6 +253,9 @@ shaka.ui.Controls = class extends shaka.util.FakeEventTarget {
 
     this.localization_ = null;
     this.pressedKeys_.clear();
+
+    // FakeEventTarget implements IReleasable
+    super.release();
   }
 
 

package/ui/localization.js

@@ -23,17 +23,18 @@ goog.require('shaka.util.LanguageUtils');
  * If a string is not available, it will return the localized
  * form in the closest related locale.
  *
- * @implements {EventTarget}
  * @final
  * @export
  */
-shaka.ui.Localization = class {
+shaka.ui.Localization = class extends shaka.util.FakeEventTarget {
   /**
    * @param {string} fallbackLocale
    *    The fallback locale that should be used. It will be assumed that this
    *    locale should have entries for just about every request.
    */
   constructor(fallbackLocale) {
+    super();
+
     /** @private {string} */
     this.fallbackLocale_ = shaka.util.LanguageUtils.normalize(fallbackLocale);
 
@@ -62,41 +63,16 @@ shaka.ui.Localization = class {
      * @private {!Map.<string, !Map.<string, string>>}
      */
     this.localizations_ = new Map();
-
-    /**
-     * The event target that we will wrap so that we can fire events
-     * without having to manage the listeners directly.
-     *
-     * @private {!EventTarget}
-     */
-    this.events_ = new shaka.util.FakeEventTarget();
-  }
-
-  /**
-   * @override
-   * @export
-   */
-  addEventListener(type, listener, options) {
-    this.events_.addEventListener(type, listener, options);
-  }
-
-  /**
-   * @override
-   * @export
-   */
-  removeEventListener(type, listener, options) {
-    // Apparently Closure says we can be passed a null |option|, but we can't
-    // pass a null option, so if we get have a null-like |option|, force it to
-    // be undefined.
-    this.events_.removeEventListener(type, listener, options || undefined);
   }
 
   /**
    * @override
    * @export
    */
-  dispatchEvent(event) {
-    return this.events_.dispatchEvent(event);
+  release() {
+    // Placeholder so that readers know this implements IReleasable (via
+    // FakeEventTarget)
+    super.release();
   }
 
   /**
@@ -130,7 +106,7 @@ shaka.ui.Localization = class {
         (locale) => !this.localizations_.has(locale));
 
     if (missing.length) {
-      this.events_.dispatchEvent(new shaka.util.FakeEvent(
+      this.dispatchEvent(new shaka.util.FakeEvent(
           Class.UNKNOWN_LOCALES,
           (new Map()).set('locales', missing)));
     }
@@ -141,7 +117,7 @@ shaka.ui.Localization = class {
 
     const data = (new Map()).set(
         'locales', found.length ? found : [this.fallbackLocale_]);
-    this.events_.dispatchEvent(new shaka.util.FakeEvent(
+    this.dispatchEvent(new shaka.util.FakeEvent(
         Class.LOCALE_CHANGED,
         data));
   }
@@ -193,7 +169,7 @@ shaka.ui.Localization = class {
     // data from.
     this.updateCurrentMap_();
 
-    this.events_.dispatchEvent(new FakeEvent(Class.LOCALE_UPDATED));
+    this.dispatchEvent(new FakeEvent(Class.LOCALE_UPDATED));
 
     return this;
   }
@@ -249,7 +225,7 @@ shaka.ui.Localization = class {
         // Make a copy to avoid leaking references.
         .set('locales', Array.from(this.currentLocales_))
         .set('missing', id);
-    this.events_.dispatchEvent(new FakeEvent(Class.UNKNOWN_LOCALIZATION, data));
+    this.dispatchEvent(new FakeEvent(Class.UNKNOWN_LOCALIZATION, data));
 
     return '';
   }
@@ -377,7 +353,7 @@ shaka.ui.Localization = class {
           // an array.
           .set('missing', Array.from(missing));
 
-      this.events_.dispatchEvent(new shaka.util.FakeEvent(
+      this.dispatchEvent(new shaka.util.FakeEvent(
           shaka.ui.Localization.MISSING_LOCALIZATIONS,
           data));
     }