shaka-player 3.3.2 → 4.0.0

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
@@ -23,7 +19,7 @@ describe('Cue', () => {
         'WEBVTT\n\n' +
         '00:00:20.000 --> 00:00:40.000\n' +
         'Test',
-        {periodStart: 7, segmentStart: 10, segmentEnd: 60});
+        {periodStart: 7, segmentStart: 10, segmentEnd: 60, vttOffset: 7});
     expect(cues.length).toBe(1);
     expect(cues[0].startTime).toBe(27);
     expect(cues[0].endTime).toBe(47);
@@ -38,7 +34,7 @@ describe('Cue', () => {
         'ID1\n' +
         '00:00:20.000 --> 00:00:40.000 align:middle size:56% vertical:lr\n' +
         'Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
     expect(cues.length).toBe(1);
   });
 

package/test/text/lrc_text_parser_unit.js

@@ -4,15 +4,11 @@
  * 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([],
         '',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the start of the file', () => {
@@ -22,7 +18,7 @@ describe('LrcTextParser', () => {
         ],
         '\n\n' +
         '[00:00.00]Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the end of the file', () => {
@@ -32,7 +28,7 @@ describe('LrcTextParser', () => {
         ],
         '[00:00.00]Test' +
         '\n\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no blank line at the end of the file', () => {
@@ -41,8 +37,7 @@ describe('LrcTextParser', () => {
           {startTime: 0, endTime: 2, payload: 'Test'},
         ],
         '[00:00.00]Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports multiple cues', () => {
@@ -55,7 +50,7 @@ describe('LrcTextParser', () => {
         '[00:00.00]Test\n' +
         '[00:10.00]Test2\n' +
         '[00:20.00]Test3',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports different time formats', () => {
@@ -74,7 +69,7 @@ describe('LrcTextParser', () => {
         '[00:30,1]Test4\n' +
         '[00:40,001]Test5\n' +
         '[00:50,02]Test6',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   /**

package/test/text/mp4_ttml_parser_unit.js

@@ -4,12 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.test.TtmlUtils');
-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';
@@ -47,7 +41,7 @@ describe('Mp4TtmlParser', () => {
   it('handles media segments with multiple mdats', () => {
     const parser = new shaka.text.Mp4TtmlParser();
     parser.parseInit(ttmlInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const ret = parser.parseMedia(ttmlSegmentMultipleMDAT, time);
     // Bodies.
     expect(ret.length).toBe(2);
@@ -60,8 +54,10 @@ describe('Mp4TtmlParser', () => {
   });
 
   it('accounts for offset', () => {
-    const time1 = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
-    const time2 = {periodStart: 7, segmentStart: 0, segmentEnd: 0};
+    const time1 =
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
+    const time2 =
+        {periodStart: 7, segmentStart: 0, segmentEnd: 0, vttOffset: 7};
 
     const parser = new shaka.text.Mp4TtmlParser();
     parser.parseInit(ttmlInitSegment);
@@ -165,7 +161,7 @@ describe('Mp4TtmlParser', () => {
     ];
     const parser = new shaka.text.Mp4TtmlParser();
     parser.parseInit(ttmlInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(ttmlSegment, time);
     shaka.test.TtmlUtils.verifyHelper(
         cues, result, {startTime: 23, endTime: 53.5});

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';
@@ -71,7 +65,7 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegment, time);
     verifyHelper(cues, result);
   });
@@ -99,7 +93,7 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegmentMultiPayload, time);
     verifyHelper(cues, result);
   });
@@ -127,13 +121,13 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegSettings, time);
     verifyHelper(cues, result);
   });
 
   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'},
@@ -149,7 +143,7 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegNoDuration, time);
     verifyHelper(cues, result);
   });
@@ -171,7 +165,8 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 10, segmentStart: 0, segmentEnd: 0};
+    const time =
+        {periodStart: 10, segmentStart: 0, segmentEnd: 0, vttOffset: 10};
     const result = parser.parseMedia(vttSegment, time);
     verifyHelper(cues, result);
   });

package/test/text/sbv_text_parser_unit.js

@@ -4,15 +4,11 @@
  * 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([],
         '',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the end of the file', () => {
@@ -22,7 +18,7 @@ describe('SbvTextParser', () => {
         ],
         '0:00:20.000,0:00:40.000\n' +
         'Test\n\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no blank line at the end of the file', () => {
@@ -32,8 +28,7 @@ describe('SbvTextParser', () => {
         ],
         '0:00:20.000,0:00:40.000\n' +
         'Test\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no newline after the final text payload', () => {
@@ -43,7 +38,7 @@ describe('SbvTextParser', () => {
         ],
         '0:00:20.000,0:00:40.000\n' +
         'Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports multiple cues', () => {
@@ -56,7 +51,7 @@ describe('SbvTextParser', () => {
         'Test\n\n' +
         '0:00:40.000,0:00:50.000\n' +
         'Test2',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   /**

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,15 +4,11 @@
  * 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([],
         '',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the end of the file', () => {
@@ -23,7 +19,7 @@ describe('SrtTextParser', () => {
         '1\n' +
         '00:00:20,000 --> 00:00:40,000\n' +
         'Test\n\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no blank line at the end of the file', () => {
@@ -34,8 +30,7 @@ describe('SrtTextParser', () => {
         '1\n' +
         '00:00:20,000 --> 00:00:40,000\n' +
         'Test\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no newline after the final text payload', () => {
@@ -46,7 +41,7 @@ describe('SrtTextParser', () => {
         '1\n' +
         '00:00:20,000 --> 00:00:40,000\n' +
         'Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports multiple cues', () => {
@@ -61,7 +56,7 @@ describe('SrtTextParser', () => {
         '2\n' +
         '00:00:40,000 --> 00:00:50,000\n' +
         'Test2',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   /**