shaka-player 3.3.0 → 3.3.3

package/test/test/util/ttml_utils.js

@@ -0,0 +1,79 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+shaka.test.TtmlUtils = class {
+  /**
+   * @param {!Array} expectedCues
+   * @param {!Array} actualCues
+   * @param {!Object} bodyProperties
+   * @param {Object=} divProperties
+   */
+  static verifyHelper(expectedCues, actualCues, bodyProperties, divProperties) {
+    const mapExpected = (cue) => {
+      if (cue.region) {
+        cue.region = jasmine.objectContaining(cue.region);
+      }
+
+      if (cue.nestedCues && (cue.nestedCues instanceof Array)) {
+        cue.nestedCues = cue.nestedCues.map(mapExpected);
+      }
+
+      if (cue.isContainer == undefined) {
+        // If not specified to be true, check for isContainer to be false.
+        cue.isContainer = false;
+      }
+
+      return jasmine.objectContaining(cue);
+    };
+
+    /**
+     * @param {!Object} properties
+     * @return {!shaka.extern.Cue}
+     */
+    const makeContainer = (properties) => {
+      const region = {
+        id: '',
+        viewportAnchorX: 0,
+        viewportAnchorY: 0,
+        regionAnchorX: 0,
+        regionAnchorY: 0,
+        width: 100,
+        height: 100,
+        widthUnits: shaka.text.CueRegion.units.PERCENTAGE,
+        heightUnits: shaka.text.CueRegion.units.PERCENTAGE,
+        viewportAnchorUnits: shaka.text.CueRegion.units.PERCENTAGE,
+        scroll: '',
+      };
+      const containerCue = /** @type {!shaka.extern.Cue} */ ({
+        region,
+        nestedCues: jasmine.any(Object),
+        payload: '',
+        startTime: 0,
+        endTime: Infinity,
+        isContainer: true,
+      });
+      Object.assign(containerCue, properties);
+      return mapExpected(containerCue);
+    };
+
+    if (expectedCues.length == 0 && !divProperties) {
+      expect(actualCues.length).toBe(0);
+    } else {
+      // Body.
+      expect(actualCues.length).toBe(1);
+      const body = actualCues[0];
+      expect(body).toEqual(makeContainer(bodyProperties));
+
+      // Div.
+      expect(body.nestedCues.length).toBe(1);
+      const div = body.nestedCues[0];
+      expect(div).toEqual(makeContainer(divProperties || bodyProperties));
+
+      // Cues.
+      expect(div.nestedCues).toEqual(expectedCues.map(mapExpected));
+    }
+  }
+};

package/test/test/util/ui_utils.js

@@ -4,15 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-
-goog.provide('shaka.test.UiUtils');
-
-goog.require('shaka.Player');
-goog.require('shaka.test.Waiter');
-goog.require('shaka.ui.Overlay');
-goog.require('shaka.util.EventManager');
-
-
 shaka.test.UiUtils = class {
   /**
    * @param {!HTMLElement} videoContainer

package/test/test/util/util.js

@@ -4,19 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.provide('shaka.test.StatusPromise');
-goog.provide('shaka.test.Util');
-
-goog.require('goog.asserts');
-goog.require('shaka.media.InitSegmentReference');
-goog.require('shaka.media.SegmentReference');
-goog.require('shaka.util.Functional');
-goog.require('shaka.util.Iterables');
-goog.require('shaka.util.StringUtils');
-goog.require('shaka.util.XmlUtils');
-goog.requireType('shaka.util.Error');
-
-
 /**
  * @extends {Promise}
  */
@@ -52,10 +39,9 @@ shaka.test.Util = class {
    */
   static async fakeEventLoop(duration, onTick) {
     // Run this synchronously:
-    for (const time of shaka.util.Iterables.range(duration)) {
+    for (let time = 0; time < duration; time++) {
       // We shouldn't need more than 6 rounds.
-      for (const _ of shaka.util.Iterables.range(6)) {
-        shaka.util.Functional.ignored(_);
+      for (let i = 0; i < 6; i++) {
         jasmine.clock().tick(0);
         await Promise.resolve();  // eslint-disable-line no-await-in-loop
       }
@@ -203,7 +189,7 @@ shaka.test.Util = class {
       if (actual.childNodes.length != expected.childNodes.length) {
         return prospectiveDiff + 'Different child node list length.';
       }
-      for (const i of shaka.util.Iterables.range(actual.childNodes.length)) {
+      for (let i = 0; i < actual.childNodes.length; i++) {
         const aNode = actual.childNodes[i];
         const eNode = expected.childNodes[i];
         const diff =
@@ -334,9 +320,9 @@ shaka.test.Util = class {
     // TODO: There should be a way to alter the externs for jasmine.Spy so that
     // this utility is not needed.
     // Why isn't there something like ICallable in Closure?
-    // https://github.com/google/closure-compiler/issues/946
+    // https://github.com/shaka-project/closure-compiler/issues/946
     // Why isn't it enough that jasmine.Spy extends Function?
-    // https://github.com/google/closure-compiler/issues/1422
+    // https://github.com/shaka-project/closure-compiler/issues/1422
     return /** @type {Function} */(spy)(...varArgs);
   }
 
@@ -401,10 +387,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 +434,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/test/util/waiter.js

@@ -4,14 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.provide('shaka.test.Waiter');
-
-goog.require('shaka.log');
-goog.require('shaka.media.TimeRangesUtils');
-goog.require('shaka.test.Util');
-goog.require('shaka.util.EventManager');
-
-
 shaka.test.Waiter = class {
   /** @param {!shaka.util.EventManager} eventManager */
   constructor(eventManager) {
@@ -23,6 +15,12 @@ shaka.test.Waiter = class {
 
     /** @private {number} */
     this.timeoutSeconds_ = 5;
+
+    /** @private {shaka.Player} */
+    this.player_ = null;
+
+    /** @private {shaka.media.MediaSourceEngine} */
+    this.mediaSourceEngine_ = null;
   }
 
   // TODO: Consider replacing this with a settings argument on the individual
@@ -51,6 +49,30 @@ shaka.test.Waiter = class {
     return this;
   }
 
+  /**
+   * For tests with access to MediaSourceEngine, this can provide better
+   * debugging for buffered ranges on failure.
+   *
+   * @param {shaka.Player} player
+   * @return {!shaka.test.Waiter}
+   */
+  setPlayer(player) {
+    this.player_ = player;
+    return this;
+  }
+
+  /**
+   * For tests with access to MediaSourceEngine, this can provide better
+   * debugging for buffered ranges on failure.
+   *
+   * @param {shaka.media.MediaSourceEngine} mediaSourceEngine
+   * @return {!shaka.test.Waiter}
+   */
+  setMediaSourceEngine(mediaSourceEngine) {
+    this.mediaSourceEngine_ = mediaSourceEngine;
+    return this;
+  }
+
   /**
    * Wait for the video playhead to move forward by some meaningful delta.  The
    * Promise is resolved when the playhead moves or the video ends.
@@ -109,7 +131,6 @@ shaka.test.Waiter = class {
     return this.waitUntilGeneric_(goalName, p, cleanup, mediaElement);
   }
 
-
   /**
    * Wait for the video playhead to reach a certain target time.
    * If the playhead reaches |timeGoal| or the video ends before |timeout|
@@ -132,40 +153,51 @@ shaka.test.Waiter = class {
    * @return {!Promise}
    */
   waitForEnd(mediaElement) {
-    // Sometimes, the ended flag is not set, or the event does not fire,
-    // (I'm looking at **you**, Safari), so also check if we've reached the
-    // duration.
-    if (mediaElement.ended ||
-        mediaElement.currentTime >= mediaElement.duration) {
-      return Promise.resolve();
-    }
-
     // The name of what we're waiting for.
     const goalName = 'end of media';
 
+    // The conditions for success.  Don't rely on either time, or the ended
+    // flag, or the ended event, specifically.  Any of these is sufficient.
+    // This flexibility cuts down on test flake on Safari (currently 14) in
+    // particular, where the flag might be set, but the ended event did not
+    // fire.  We also see flake on Firefox (currently 99), where test playbacks
+    // sometimes stop right before duration is reached.  (Duration 60.01, audio
+    // buffered to 60.01, video buffered to exactly 60.)
+    const hasEnded = () => {
+      return mediaElement.currentTime >= mediaElement.duration - 0.1 ||
+          mediaElement.ended;
+    };
+
+    if (hasEnded()) {
+      return Promise.resolve();
+    }
+
     // Cleanup on timeout.
+    let timer = null;
     const cleanup = () => {
+      if (timer) {
+        timer.stop();
+      }
       this.eventManager_.unlisten(mediaElement, 'timeupdate');
       this.eventManager_.unlisten(mediaElement, 'ended');
     };
 
-    // The conditions for success.  Don't rely on either time, or the ended
-    // flag, or the ended event, specifically.  Any of these is sufficient.
-    // This flexibility cuts down on test flake on Safari (currently 14) in
-    // particular, where the flag might be set, but the ended event did not
-    // fire.
     const p = new Promise((resolve) => {
-      this.eventManager_.listen(mediaElement, 'timeupdate', () => {
-        if (mediaElement.currentTime >= mediaElement.duration ||
-            mediaElement.ended) {
+      const check = () => {
+        if (hasEnded()) {
           cleanup();
           resolve();
         }
-      });
-      this.eventManager_.listen(mediaElement, 'ended', () => {
-        cleanup();
-        resolve();
-      });
+      };
+
+      // In Firefox 99, there appears to be some bug in the browser preventing
+      // events from being triggered at the end of the presentation.  So we
+      // check for the end once per second.  Without this, StreamingEngine
+      // integration tests were failing.
+      timer = new shaka.util.Timer(check);
+      timer.tickEvery(/* seconds= */ 1);
+      this.eventManager_.listen(mediaElement, 'timeupdate', check);
+      this.eventManager_.listen(mediaElement, 'ended', check);
     });
 
     return this.waitUntilGeneric_(goalName, p, cleanup, mediaElement);
@@ -263,7 +295,7 @@ shaka.test.Waiter = class {
 
       // Improve the error message with media-specific debug info.
       if (target instanceof HTMLMediaElement) {
-        this.logDebugInfoForMedia_(error.message, target);
+        this.logDebugInfoForMedia_(error, target);
       }
 
       // Reject or resolve based on our settings.
@@ -276,20 +308,29 @@ shaka.test.Waiter = class {
   }
 
   /**
-   * @param {string} message
+   * @param {!Error} error
    * @param {!HTMLMediaElement} mediaElement
    * @private
    */
-  logDebugInfoForMedia_(message, mediaElement) {
-    const buffered =
-        shaka.media.TimeRangesUtils.getBufferedInfo(mediaElement.buffered);
-    shaka.log.error(message,
-        'current time', mediaElement.currentTime,
-        'duration', mediaElement.duration,
-        'ready state', mediaElement.readyState,
-        'playback rate', mediaElement.playbackRate,
-        'paused', mediaElement.paused,
-        'ended', mediaElement.ended,
-        'buffered', buffered);
+  logDebugInfoForMedia_(error, mediaElement) {
+    let buffered;
+    if (this.player_) {
+      buffered = this.player_.getBufferedInfo();
+    } else if (this.mediaSourceEngine_) {
+      buffered = this.mediaSourceEngine_.getBufferedInfo();
+    } else {
+      buffered = shaka.media.TimeRangesUtils.getBufferedInfo(
+          mediaElement.buffered);
+    }
+
+    error.message += '\n' +
+        `current time: ${mediaElement.currentTime}\n` +
+        `duration: ${mediaElement.duration}\n` +
+        `ready state: ${mediaElement.readyState}\n` +
+        `playback rate: ${mediaElement.playbackRate}\n` +
+        `paused: ${mediaElement.paused}\n` +
+        `ended: ${mediaElement.ended}\n` +
+        `buffered: ${JSON.stringify(buffered)}\n`;
+    shaka.log.error(error.message);
   }
 };

package/test/text/cue_integration.js

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.text.VttTextParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.StringUtils');
-
 describe('Cue', () => {
   // This integration test checks platform support for various cue scenarios
   // that have caused platform-specific issues.  The unit tests for each parser

package/test/text/lrc_text_parser_unit.js

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.text.LrcTextParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.StringUtils');
-
 describe('LrcTextParser', () => {
   it('supports no cues', () => {
     verifyHelper([],

package/test/text/mp4_ttml_parser_unit.js

@@ -4,11 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.test.Util');
-goog.require('shaka.text.Mp4TtmlParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.Error');
-
 describe('Mp4TtmlParser', () => {
   const ttmlInitSegmentUri = '/base/test/test/assets/ttml-init.mp4';
   const ttmlSegmentUri = '/base/test/test/assets/ttml-segment.mp4';
@@ -48,7 +43,14 @@ describe('Mp4TtmlParser', () => {
     parser.parseInit(ttmlInitSegment);
     const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
     const ret = parser.parseMedia(ttmlSegmentMultipleMDAT, time);
-    expect(ret.length).toBe(20);
+    // Bodies.
+    expect(ret.length).toBe(2);
+    // Divs.
+    expect(ret[0].nestedCues.length).toBe(1);
+    expect(ret[1].nestedCues.length).toBe(1);
+    // Cues.
+    expect(ret[0].nestedCues[0].nestedCues.length).toBe(10);
+    expect(ret[1].nestedCues[0].nestedCues.length).toBe(10);
   });
 
   it('accounts for offset', () => {
@@ -159,22 +161,7 @@ describe('Mp4TtmlParser', () => {
     parser.parseInit(ttmlInitSegment);
     const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
     const result = parser.parseMedia(ttmlSegment, time);
-    verifyHelper(cues, result);
+    shaka.test.TtmlUtils.verifyHelper(
+        cues, result, {startTime: 23, endTime: 53.5});
   });
-
-  function verifyHelper(/** !Array */ expected, /** !Array */ actual) {
-    const mapExpected = (cue) => {
-      if (cue.region) {
-        cue.region = jasmine.objectContaining(cue.region);
-      }
-
-      if (cue.nestedCues) {
-        cue.nestedCues = cue.nestedCues.map(mapExpected);
-      }
-
-      return jasmine.objectContaining(cue);
-    };
-
-    expect(actual).toEqual(expected.map(mapExpected));
-  }
 });

package/test/text/mp4_vtt_parser_unit.js

@@ -4,12 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.test.Util');
-goog.require('shaka.text.Cue');
-goog.require('shaka.text.Mp4VttParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.Error');
-
 describe('Mp4VttParser', () => {
   const vttInitSegmentUri = '/base/test/test/assets/vtt-init.mp4';
   const vttSegmentUri = '/base/test/test/assets/vtt-segment.mp4';
@@ -133,7 +127,7 @@ describe('Mp4VttParser', () => {
   });
 
   it('parses media segments without a sample duration', () => {
-    // Regression test for https://github.com/google/shaka-player/issues/919
+    // Regression test for https://github.com/shaka-project/shaka-player/issues/919
     const cues = [
       {startTime: 10, endTime: 11, payload: 'cue 10'},
       {startTime: 11, endTime: 12, payload: 'cue 11'},

package/test/text/sbv_text_parser_unit.js

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.text.SbvTextParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.StringUtils');
-
 describe('SbvTextParser', () => {
   it('supports no cues', () => {
     verifyHelper([],

package/test/text/simple_text_displayer_unit.js

@@ -4,13 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-
-goog.require('shaka.test.FakeVideo');
-goog.require('shaka.text.Cue');
-goog.require('shaka.text.SimpleTextDisplayer');
-goog.require('shaka.util.Functional');
-goog.requireType('shaka.test.FakeTextTrack');
-
 describe('SimpleTextDisplayer', () => {
   const originalVTTCue = window.VTTCue;
   const Cue = shaka.text.Cue;
@@ -74,7 +67,7 @@ describe('SimpleTextDisplayer', () => {
     });
 
     it('appends equal time cues in reverse order', () => {
-      // Regression test for https://github.com/google/shaka-player/issues/848
+      // Regression test for https://github.com/shaka-project/shaka-player/issues/848
 
       // When VTTCue is seen as the real thing (because of the presence of
       // VTTCue.prototype.line), then the reverse-order behavior comes into

package/test/text/srt_text_parser_unit.js

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.text.SrtTextParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.StringUtils');
-
 describe('SrtTextParser', () => {
   it('supports no cues', () => {
     verifyHelper([],

package/test/text/ssa_text_parser_unit.js

@@ -4,11 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.text.Cue');
-goog.require('shaka.text.SsaTextParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.StringUtils');
-
 describe('SsaTextParser', () => {
   const Cue = shaka.text.Cue;
 

package/test/text/text_engine_unit.js

@@ -4,11 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.test.FakeTextDisplayer');
-goog.require('shaka.text.Cue');
-goog.require('shaka.text.TextEngine');
-goog.require('shaka.util.MimeUtils');
-
 describe('TextEngine', () => {
   const TextEngine = shaka.text.TextEngine;
 
@@ -336,7 +331,7 @@ describe('TextEngine', () => {
     it('does not use timestamp offset', async () => {
       // The start and end times passed to appendBuffer are now absolute, so
       // they already account for timestampOffset and period offset.
-      // See https://github.com/google/shaka-player/issues/1562
+      // See https://github.com/shaka-project/shaka-player/issues/1562
       textEngine.setTimestampOffset(60);
       await textEngine.appendBuffer(dummyData, 0, 3);
       expect(textEngine.bufferStart()).toBe(0);
@@ -379,7 +374,7 @@ describe('TextEngine', () => {
     it('does not use timestamp offset', async () => {
       // The start and end times passed to appendBuffer are now absolute, so
       // they already account for timestampOffset and period offset.
-      // See https://github.com/google/shaka-player/issues/1562
+      // See https://github.com/shaka-project/shaka-player/issues/1562
       textEngine.setTimestampOffset(60);
       await textEngine.appendBuffer(dummyData, 3, 6);
       expect(textEngine.bufferedAheadOf(4)).toBe(2);

package/test/text/text_track_integration.js

@@ -4,8 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.test.UiUtils');
-
 // This tests three assumptions we make about text tracks in Shaka Player:
 //   1. If a non-null value for cues is stored, it will always be the
 //      non-null value for cues when cues returns a non-null value.