shaka-player 4.3.8 → 4.3.9

package/test/player_integration.js

@@ -34,6 +34,9 @@ describe('Player', () => {
     await shaka.test.TestScheme.createManifests(compiledShaka, '_compiled');
     player = new compiledShaka.Player(video);
 
+    // Disable stall detection, which can interfere with playback tests.
+    player.configure('streaming.stallEnabled', false);
+
     // Grab event manager from the uncompiled library:
     eventManager = new shaka.util.EventManager();
     waiter = new shaka.test.Waiter(eventManager);
@@ -81,11 +84,15 @@ describe('Player', () => {
       // Unlike the other tests in this file, this uses an uncompiled build of
       // Shaka, so that we don't need to expose shaka.util.Timer.activeTimers.
       player = new shaka.Player(video);
+
+      // Disable stall detection, which can interfere with playback tests.
+      player.configure('streaming.stallEnabled', false);
+
       waiter.setPlayer(player);
 
       // Play the video for a little while.
       await player.load('test:sintel');
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
 
       // Destroy the player.
@@ -127,7 +134,7 @@ describe('Player', () => {
             }
           });
       await player.load('test:sintel_compiled');
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 25, 30);
       expect(results).toEqual(expected);
     });
@@ -139,7 +146,7 @@ describe('Player', () => {
       // This is tested more in player_unit.js.  This is here to test the public
       // API and to check for renaming.
       await player.load('test:sintel_compiled');
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
 
       const stats = player.getStats();
@@ -210,7 +217,7 @@ describe('Player', () => {
 
     it('does not cause cues to be null', async () => {
       await player.load('test:sintel_compiled');
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
 
       // This TextTrack was created as part of load() when we set up the
@@ -249,7 +256,7 @@ describe('Player', () => {
       await player.load('test:sintel_realistic_compiled');
 
       // Play until a time at which the external cues would be on screen.
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 4, 20);
 
       expect(player.isTextTrackVisible()).toBe(true);
@@ -281,7 +288,7 @@ describe('Player', () => {
       await waiter.waitForEvent(player, 'texttrackvisibility');
 
       // Play until a time at which the external cues would be on screen.
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 4, 20);
 
       expect(player.isTextTrackVisible()).toBe(true);
@@ -352,7 +359,7 @@ describe('Player', () => {
       player.setTextTrackVisibility(true);
       player.selectTextLanguage('fr');
       video.currentTime = 5;
-      video.play();
+      await video.play();
       await waiter.waitForMovementOrFailOnTimeout(video, 10);
 
       expect(video.textTracks[0].activeCues.length).toBe(1);
@@ -544,7 +551,7 @@ describe('Player', () => {
 
     it('at higher playback rates', async () => {
       await player.load('test:sintel_compiled');
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
 
       // Enabling trick play should change our playback rate to the same rate.
@@ -560,14 +567,12 @@ describe('Player', () => {
     });
 
     it('in sequence mode', async () => {
-      const testSchemeMimeType = 'application/x-test-manifest';
-      player = new compiledShaka.Player(video);
-      await player.load('test:sintel_sequence_compiled', 0, testSchemeMimeType);
+      await player.load('test:sintel_sequence_compiled');
       expect(player.getManifest().sequenceMode).toBe(true);
 
       // Ensure the video plays.
-      video.play();
-      await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 5, 10);
+      await video.play();
+      await waiter.timeoutAfter(20).waitUntilPlayheadReaches(video, 5);
 
       // Seek the video, and see if it can continue playing from that point.
       video.currentTime = 20;
@@ -586,9 +591,8 @@ describe('Player', () => {
     // even if one is not specified in load().
     it('immediately after construction with MIME type', async () => {
       const testSchemeMimeType = 'application/x-test-manifest';
-      player = new compiledShaka.Player(video);
       await player.load('test:sintel_compiled', 0, testSchemeMimeType);
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
     });
 
@@ -627,7 +631,7 @@ describe('Player', () => {
     // Regression test for https://github.com/shaka-project/shaka-player/issues/1187
     it('does not throw on destroy', async () => {
       await player.load('test:sintel_compiled');
-      video.play();
+      await video.play();
       await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
       await player.unload();
       // Before we fixed #1187, the call to destroy() on textDisplayer was
@@ -873,7 +877,7 @@ describe('Player', () => {
       player.configure('streaming.observeQualityChanges', true);
 
       await player.load('test:sintel_compiled');
-      video.play();
+      await video.play();
 
       // Wait for the video to start playback.  If it takes longer than 10
       // seconds, fail the test.
@@ -887,7 +891,7 @@ describe('Player', () => {
       player.configure('streaming.observeQualityChanges', false);
 
       await player.load('test:sintel_compiled');
-      video.play();
+      await video.play();
 
       // Wait for the video to start playback.  If it takes longer than 10
       // seconds, fail the test.
@@ -916,7 +920,7 @@ describe('Player', () => {
 
       // Play the stream.
       await player.load('/base/test/test/assets/3675/dash_0.mpd');
-      video.play();
+      await video.play();
 
       // Wait for the stream to be over.
       eventManager.listen(player, 'error', Util.spyFunc(onErrorSpy));
@@ -1004,22 +1008,22 @@ describe('Player', () => {
 
       await player.load('test:sintel_long_compiled');
       video.pause();
-      await waitUntilBuffered(10);
+      await waiter.waitUntilBuffered(video, 10);
 
       player.configure('streaming.bufferingGoal', 30);
-      await waitUntilBuffered(30);
+      await waiter.waitUntilBuffered(video, 30);
 
       player.configure('streaming.bufferingGoal', 60);
-      await waitUntilBuffered(60);
-      await Util.delay(0.2);
+      await waiter.waitUntilBuffered(video, 60);
+      await Util.delay(1);
       expect(getBufferedAhead()).toBeLessThan(70);  // 60 + segment_size
 
       // We don't remove buffered content ahead of the playhead, so seek to
       // clear the buffer.
       player.configure('streaming.bufferingGoal', 10);
       video.currentTime = 120;
-      await waitUntilBuffered(10);
-      await Util.delay(0.2);
+      await waiter.waitUntilBuffered(video, 10);
+      await Util.delay(1);
       expect(getBufferedAhead()).toBeLessThan(20);  // 10 + segment_size
     });
 
@@ -1029,20 +1033,22 @@ describe('Player', () => {
 
       await player.load('test:sintel_long_compiled');
       video.pause();
-      await waitUntilBuffered(30);
+      await waiter.waitUntilBuffered(video, 30);
       video.currentTime = 20;
-      await waitUntilBuffered(30);
+      await waiter.waitUntilBuffered(video, 30);
 
       expect(getBufferedBehind()).toBe(20);  // Buffered to start still.
       video.currentTime = 50;
-      await waitUntilBuffered(30);
+      await waiter.waitUntilBuffered(video, 30);
+      await Util.delay(1);
       expect(getBufferedBehind()).toBeLessThan(40);  // 30 + segment_size
 
       player.configure('streaming.bufferBehind', 10);
       // We only evict content when we append a segment, so increase the
       // buffering goal so we append another segment.
       player.configure('streaming.bufferingGoal', 40);
-      await waitUntilBuffered(40);
+      await waiter.waitUntilBuffered(video, 40);
+      await Util.delay(1);
       expect(getBufferedBehind()).toBeLessThanOrEqual(10);
     });
 
@@ -1061,25 +1067,6 @@ describe('Player', () => {
       }
       return video.currentTime - start;
     }
-
-    async function waitUntilBuffered(amount) {
-      for (let i = 0; i < 50; i++) {
-        // We buffer from an internal segment, so this shouldn't take long to
-        // buffer.
-        await Util.delay(0.1);  // eslint-disable-line no-await-in-loop
-        if (getBufferedAhead() >= amount) {
-          return;
-        }
-      }
-
-      const ranges =
-          shaka.media.TimeRangesUtils.getBufferedInfo(video.buffered);
-      const currentTime = video.currentTime;
-      const target = currentTime + amount;
-
-      throw new Error('Timeout waiting to buffer! ' +
-          JSON.stringify({ranges, currentTime, target}));
-    }
   });  // describe('buffering')
 
   describe('configuration', () => {

package/test/player_src_equals_integration.js

@@ -27,6 +27,10 @@ describe('Player Src Equals', () => {
   beforeEach(() => {
     player = new shaka.Player();
     player.addEventListener('error', fail);
+
+    // Disable stall detection, which can interfere with playback tests.
+    player.configure('streaming.stallEnabled', false);
+
     eventManager = new shaka.util.EventManager();
     waiter = new shaka.test.Waiter(eventManager);
   });
@@ -101,7 +105,7 @@ describe('Player Src Equals', () => {
     expect(video.duration).not.toBeCloseTo(0);
 
     // Start playback and wait for the playhead to move.
-    video.play();
+    await video.play();
     await waiter.waitForMovementOrFailOnTimeout(video, /* timeout= */10);
 
     // Make sure the playhead is roughly where we expect it to be before
@@ -138,7 +142,7 @@ describe('Player Src Equals', () => {
     await loadWithSrcEquals(SMALL_MP4_CONTENT_URI, /* startTime= */ null);
 
     // For playback to begin so that we have some content buffered.
-    video.play();
+    await video.play();
     await waiter.waitForMovementOrFailOnTimeout(video, /* timeout= */10);
 
     const buffered = player.getBufferedInfo();
@@ -162,7 +166,7 @@ describe('Player Src Equals', () => {
     await loadWithSrcEquals(SMALL_MP4_CONTENT_URI, /* startTime= */ null);
 
     // Let playback run for a little.
-    video.play();
+    await video.play();
     await waiter.waitForMovementOrFailOnTimeout(video, /* timeout= */10);
 
     let videoRateChange = false;
@@ -279,7 +283,7 @@ describe('Player Src Equals', () => {
     expect(video.currentTime).toBeCloseTo(0);
 
     // Start playback and wait. We should see the playhead move.
-    video.play();
+    await video.play();
     await waiter.waitForMovementOrFailOnTimeout(video, /* timeout= */10);
     await shaka.test.Util.delay(1.5);
 
@@ -296,7 +300,7 @@ describe('Player Src Equals', () => {
 
     // Wait some time for playback to start so that we will have a load latency
     // value.
-    video.play();
+    await video.play();
     await waiter.waitForMovementOrFailOnTimeout(video, /* timeout= */10);
 
     // Get the stats and check that some stats have been filled in.

package/test/test/util/fake_demo_main.js

@@ -12,9 +12,13 @@
  */
 shaka.test.FakeDemoMain = class {
   constructor() {
-    this.video = /** @type {!HTMLVideoElement} */ (
-      document.createElement('video'));
-    this.player = new shaka.Player(this.video);
+    // Using the player's constructor argument to attach a video element seems
+    // to cause flaky timeouts on teardown.  If a video element is needed in
+    // the future, please explicitly call attach(video) and await the result
+    // during the test setup.
+    /** @type {!shaka.Player} */
+    this.player = new shaka.Player();
+
     this.config_ = this.player.getConfiguration();
     this.selectedAsset = null;
 

package/test/test/util/layout_tests.js

@@ -395,7 +395,7 @@ shaka.test.NativeTextLayoutTests = class extends shaka.test.TextLayoutTests {
     // The this.video must be played a little now, after the cues were appended,
     // but before the screenshot.
     this.video.playbackRate = 1;
-    this.video.play();
+    await this.video.play();
     await this.waiter.failOnTimeout(false).timeoutAfter(5)
         .waitForMovement(this.video);
     this.video.pause();
@@ -404,7 +404,7 @@ shaka.test.NativeTextLayoutTests = class extends shaka.test.TextLayoutTests {
     this.video.currentTime = time;
     // Get into a playing state, but without movement.
     this.video.playbackRate = 0;
-    this.video.play();
+    await this.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.

package/test/test/util/manifest_generator.js

@@ -541,6 +541,8 @@ shaka.test.ManifestGenerator.Stream = class {
       this.hdr = undefined;
       /** @type {(string|undefined)} */
       this.tilesLayout = undefined;
+      /** @type {boolean} */
+      this.external = false;
     }
 
     /** @type {shaka.extern.Stream} */

package/test/test/util/offline_utils.js

@@ -56,6 +56,7 @@ shaka.test.OfflineUtils = class {
       audioSamplingRate: null,
       spatialAudio: false,
       closedCaptions: null,
+      external: false,
     };
   }
 

package/test/test/util/streaming_engine_util.js

@@ -410,6 +410,7 @@ shaka.test.StreamingEngineUtil = class {
       roles: [],
       forced: false,
       spatialAudio: false,
+      external: false,
     };
   }
 
@@ -447,6 +448,7 @@ shaka.test.StreamingEngineUtil = class {
       roles: [],
       forced: false,
       spatialAudio: false,
+      external: false,
     };
   }
 
@@ -482,6 +484,7 @@ shaka.test.StreamingEngineUtil = class {
       roles: [],
       forced: false,
       spatialAudio: false,
+      external: false,
     };
   }
 };

package/test/test/util/ui_utils.js

@@ -115,11 +115,18 @@ shaka.test.UiUtils = class {
       // Destroying the UI destroys the controls and player inside.
       destroys.push(ui.destroy());
     }
-    await Promise.all(destroys);
+
+    const allDestroyed = Promise.all(destroys);
+    // 10 seconds should be more than enough to tear down the UI.
+    // Adding this silent timeout fixes several tests that inconsistently hang
+    // during teardown and cause failures in afterEach() clauses.
+    await Promise.race([allDestroyed, shaka.test.Util.delay(10)]);
 
     // Now remove all the containers from the DOM.
     for (const container of containers) {
-      container.parentElement.removeChild(container);
+      if (container.parentElement) {
+        container.parentElement.removeChild(container);
+      }
     }
   }
 

package/test/test/util/util.js

@@ -255,33 +255,12 @@ shaka.test.Util = class {
    * @param {string} uri
    * @return {!Promise.<!ArrayBuffer>}
    */
-  static fetch(uri) {
-    return new Promise(((resolve, reject) => {
-      const xhr = new XMLHttpRequest();
-      xhr.open('GET', uri, /* asynchronous= */ true);
-      xhr.responseType = 'arraybuffer';
-
-      xhr.onload = (event) => {
-        if (xhr.status >= 200 &&
-            xhr.status <= 299 &&
-            !!xhr.response) {
-          resolve(/** @type {!ArrayBuffer} */(xhr.response));
-        } else {
-          let message = '';
-          if (xhr.response) {
-            message = ': ' + shaka.util.StringUtils.fromUTF8(
-                /** @type {!ArrayBuffer} */(xhr.response));
-          }
-          reject(xhr.status + message);
-        }
-      };
-
-      xhr.onerror = (event) => {
-        reject('shaka.test.Util.fetch failed: ' + uri);
-      };
-
-      xhr.send(/* body= */ null);
-    }));
+  static async fetch(uri) {
+    const response = await fetch(uri);
+    if (!response.ok) {
+      throw new Error('shaka.test.Util.fetch failed: ' + uri);
+    }
+    return response.arrayBuffer();
   }
 
   /**

package/test/test/util/waiter.js

@@ -109,6 +109,8 @@ shaka.test.Waiter = class {
    * @return {!Promise}
    */
   waitUntilPlayheadReaches(mediaElement, timeGoal) {
+    this.macPlaybackWorkaround_(mediaElement);
+
     // The name of what we're waiting for
     const goalName = 'movement from ' + mediaElement.currentTime +
                      ' to ' + timeGoal;
@@ -153,6 +155,8 @@ shaka.test.Waiter = class {
    * @return {!Promise}
    */
   waitForEnd(mediaElement) {
+    this.macPlaybackWorkaround_(mediaElement);
+
     // The name of what we're waiting for.
     const goalName = 'end of media';
 
@@ -207,13 +211,64 @@ shaka.test.Waiter = class {
    * Wait for the video to end or for |timeout| seconds to pass, whichever
    * occurs first.  The Promise is resolved when either of these happens.
    *
-   * @param {!HTMLMediaElement} target
+   * @param {!HTMLMediaElement} mediaElement
    * @param {number} timeout in seconds, after which the Promise succeeds
    * @return {!Promise}
    */
-  waitForEndOrTimeout(target, timeout) {
+  waitForEndOrTimeout(mediaElement, timeout) {
     this.failOnTimeout(false).timeoutAfter(timeout);
-    return this.waitForEnd(target);
+    return this.waitForEnd(mediaElement);
+  }
+
+  /**
+   * Wait until a certain amount of content is buffered.
+   *
+   * @param {!HTMLMediaElement} mediaElement
+   * @param {number} bufferingGoal in seconds, after which the Promise succeeds
+   * @return {!Promise}
+   */
+  waitUntilBuffered(mediaElement, bufferingGoal) {
+    // The name of what we're waiting for.
+    const goalName = `${bufferingGoal} seconds buffered`;
+
+    // The conditions for success.
+    const bufferedEnough = () => {
+      const end = shaka.media.TimeRangesUtils.bufferEnd(mediaElement.buffered);
+      if (end == null) {
+        return false;
+      }
+      return end - mediaElement.currentTime >= bufferingGoal;
+    };
+
+    if (bufferedEnough()) {
+      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');
+    };
+
+    const p = new Promise((resolve) => {
+      const check = () => {
+        if (bufferedEnough()) {
+          cleanup();
+          resolve();
+        }
+      };
+
+      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);
   }
 
   /**
@@ -333,4 +388,19 @@ shaka.test.Waiter = class {
         `buffered: ${JSON.stringify(buffered)}\n`;
     shaka.log.error(error.message);
   }
+
+  /**
+   * @param {!HTMLMediaElement} mediaElement
+   * @private
+   */
+  macPlaybackWorkaround_(mediaElement) {
+    if (shaka.util.Platform.isMac()) {
+      // Work around bizarre playback slowdowns that only seem to occur with
+      // WebDriver and only on Mac.  Increasing the playback rate allows tests
+      // to complete without timing out.
+      if (mediaElement.playbackRate == 1) {
+        mediaElement.playbackRate = 2;
+      }
+    }
+  }
 };

package/test/ui/ad_ui_unit.js

@@ -25,15 +25,6 @@ describe('Ad UI', () => {
     shaka.Player.setAdManagerFactory(() => new shaka.test.FakeAdManager());
   });
 
-  afterEach(async () => {
-    await UiUtils.cleanupUI();
-  });
-
-  afterAll(() => {
-    document.head.removeChild(cssLink);
-    shaka.Player.setAdManagerFactory(() => new shaka.ads.AdManager());
-  });
-
   beforeEach(() => {
     container =
       /** @type {!HTMLElement} */ (document.createElement('div'));
@@ -45,6 +36,15 @@ describe('Ad UI', () => {
     adManager = video['ui'].getControls().getPlayer().getAdManager();
   });
 
+  afterEach(async () => {
+    await UiUtils.cleanupUI();
+  });
+
+  afterAll(() => {
+    document.head.removeChild(cssLink);
+    shaka.Player.setAdManagerFactory(() => new shaka.ads.AdManager());
+  });
+
   it('is invisible if no ad is playing', () => {
     const adControlsContainer =
         UiUtils.getElementByClassName(container, 'shaka-ad-controls');

package/test/util/stream_utils_unit.js

@@ -718,6 +718,52 @@ describe('StreamUtils', () => {
       expect(manifest.variants.length).toBe(1);
     });
 
+    it('supports fLaC codec', async () => {
+      if (!MediaSource.isTypeSupported('audio/mp4; codecs="flac"')) {
+        pending('Codec fLaC is not supported by the platform.');
+      }
+      manifest = shaka.test.ManifestGenerator.generate((manifest) => {
+        manifest.addVariant(0, (variant) => {
+          variant.addAudio(1, (stream) => {
+            stream.mime('audio/mp4', 'fLaC');
+          });
+        });
+        manifest.addVariant(2, (variant) => {
+          variant.addAudio(3, (stream) => {
+            stream.mime('audio/mp4', 'flac');
+          });
+        });
+      });
+
+      await shaka.util.StreamUtils.filterManifest(
+          fakeDrmEngine, /* currentVariant= */ null, manifest);
+
+      expect(manifest.variants.length).toBe(2);
+    });
+
+    it('supports Opus codec', async () => {
+      if (!MediaSource.isTypeSupported('audio/mp4; codecs="opus"')) {
+        pending('Codec Opus is not supported by the platform.');
+      }
+      manifest = shaka.test.ManifestGenerator.generate((manifest) => {
+        manifest.addVariant(0, (variant) => {
+          variant.addAudio(1, (stream) => {
+            stream.mime('audio/mp4', 'Opus');
+          });
+        });
+        manifest.addVariant(2, (variant) => {
+          variant.addAudio(3, (stream) => {
+            stream.mime('audio/mp4', 'opus');
+          });
+        });
+      });
+
+      await shaka.util.StreamUtils.filterManifest(
+          fakeDrmEngine, /* currentVariant= */ null, manifest);
+
+      expect(manifest.variants.length).toBe(2);
+    });
+
     it('supports legacy AVC1 codec', async () => {
       if (!MediaSource.isTypeSupported('video/mp4; codecs="avc1.42001e"')) {
         pending('Codec avc1.42001e is not supported by the platform.');

package/ui/range_element.js

@@ -110,6 +110,11 @@ shaka.ui.RangeElement = class extends shaka.ui.Element {
         this.onChangeEnd();
       }
     });
+
+    this.eventManager.listen(this.bar, 'contextmenu', (e) => {
+      e.preventDefault();
+      e.stopPropagation();
+    });
   }
 
   /** @override */