shaka-player 4.6.4 → 4.7.0

package/test/media/region_observer_unit.js

@@ -1,374 +0,0 @@
-/*! @license
- * Shaka Player
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-describe('RegionObserver', () => {
-  /** @type {!shaka.media.RegionTimeline} */
-  let timeline;
-  /** @type {!shaka.media.RegionObserver} */
-  let observer;
-
-  /** @type {!jasmine.Spy} */
-  let onSeekRange;
-
-  /** @type {!jasmine.Spy} */
-  let onEnterRegion;
-  /** @type {!jasmine.Spy} */
-  let onExitRegion;
-  /** @type {!jasmine.Spy} */
-  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(
-        shaka.test.Util.spyFunc(onSeekRange));
-
-    observer = new shaka.media.RegionObserver(
-        timeline, /* startsPastZero= */ false);
-    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', () => {
-    // Position us so that we will be in the middle of the region that we are
-    // about to add.
-    poll(observer,
-        /* timeInSeconds= */ 5,
-        /* seeking= */ false);
-
-    const region = createRegion('my-region', 4, 6);
-    timeline.addRegion(region);
-
-    expect(onEnterRegion).not.toHaveBeenCalled();
-
-    // Move to the same place, we should see the event fire even though we did
-    // not have the region in the timeline previously.
-    poll(observer,
-        /* timeInSeconds= */ 5,
-        /* seeking= */ false);
-
-    expect(onEnterRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-  });
-
-  it('fires enter event when entering region', () => {
-    const region = createRegion('my-region', 5, 10);
-    timeline.addRegion(region);
-
-    // Make sure we call |onEnter| when we enter the region.
-    poll(observer,
-        /* timeInSeconds= */ 7,
-        /* seeking= */ false);
-    expect(onEnterRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-  });
-
-  it('does not fire events while in a region', () => {
-    const region = createRegion('my-region', 5, 10);
-    timeline.addRegion(region);
-
-    // Make sure we call |onEnter| when we enter the region.
-    poll(observer,
-        /* timeInSeconds= */ 7,
-        /* seeking= */ false);
-    expect(onEnterRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-
-    poll(observer,
-        /* timeInSeconds= */ 8,
-        /* seeking= */ false);
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).not.toHaveBeenCalled();
-    expect(onSkipRegion).not.toHaveBeenCalled();
-  });
-
-  it('fires exit event when leaving region', () => {
-    const region = createRegion('my-region', 5, 10);
-    timeline.addRegion(region);
-
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).not.toHaveBeenCalled();
-
-    // Move into the region (we must be in the region to leave it).
-    poll(observer,
-        /* timeInSeconds= */ 7,
-        /* seeking= */ false);
-
-    // Make sure we call |onExit| when we exit the region.
-    poll(observer,
-        /* timeInSeconds= */ 15,
-        /* seeking= */ false);
-    expect(onExitRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-  });
-
-  it('fires skip event when we enter and leave region in one move', () => {
-    const region = createRegion('my-region', 5, 10);
-    timeline.addRegion(region);
-
-    // Make sure we are before the region starts.
-    poll(observer,
-        /* timeInSeconds= */ 4,
-        /* seeking= */ false);
-    expect(onSkipRegion).not.toHaveBeenCalled();
-
-    // Make sure we call |onSkip| when we move so far that we skip over the
-    // region.
-    poll(observer,
-        /* timeInSeconds= */ 15,
-        /* seeking= */ false);
-    expect(onSkipRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-  });
-
-  it('fires skip events for zero-duration regions', () => {
-    // Make a region with no duration.
-    const region = createRegion('my-region', 5, 5);
-    timeline.addRegion(region);
-
-    // Make sure we are before the region starts.
-    poll(observer,
-        /* timeInSeconds= */ 4,
-        /* seeking= */ false);
-    expect(onSkipRegion).not.toHaveBeenCalled();
-
-    // Make sure we call |onSkip| when we move so far that we skip over the
-    // region.
-    poll(observer,
-        /* timeInSeconds= */ 10,
-        /* seeking= */ false);
-    expect(onSkipRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-  });
-
-  // We want to simulate a "normal" case of overlapping regions. For this we
-  // will step up our timeline and then step through it in small steps so that
-  // we will pass each boundary.
-  it('fires correctly for overlapping regions', () => {
-    // |---------|---------|---------|
-    // |         |---1-----|         |
-    // |           |-2-|             |
-    // |                 |-3--|      |
-    // |---------|---------|---------|
-    //           10        20        30
-    // 1: region
-    // 2: nested
-    // 3: overlap
-
-    const region = createRegion('region', 10, 20);
-    const nested = createRegion('nested', 12, 16);
-    const overlap = createRegion('overlap', 18, 23);
-
-    timeline.addRegion(region);
-    timeline.addRegion(nested);
-    timeline.addRegion(overlap);
-
-    // Slowly move from time=0 to time=9. We should see nothing change.
-    for (let time = 1; time <= 9; time++) {
-      poll(observer,
-          /* timeInSeconds= */ time,
-          /* seeking= */ false);
-      expect(onEnterRegion).not.toHaveBeenCalled();
-      expect(onExitRegion).not.toHaveBeenCalled();
-    }
-
-    // Move forward one more (to time=10) and we should enter |region|.
-    poll(observer,
-        /* timeInSeconds= */ 10,
-        /* seeking= */ false);
-    expect(onEnterRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-    expect(onExitRegion).not.toHaveBeenCalled();
-
-    // Nothing should change.
-    poll(observer,
-        /* timeInSeconds= */ 11,
-        /* seeking= */ false);
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).not.toHaveBeenCalled();
-
-    // Moving to time=12, we should enter |nested|.
-    poll(observer,
-        /* timeInSeconds= */ 12,
-        /* seeking= */ false);
-    expect(onEnterRegion).toHaveBeenCalledOnceMoreWith([nested, false]);
-    expect(onExitRegion).not.toHaveBeenCalled();
-
-    // Slowly move from time=12 to time=16. We should see nothing change.
-    for (let time = 13; time <= 16; time++) {
-      poll(observer,
-          /* timeInSeconds= */ time,
-          /* seeking= */ false);
-      expect(onEnterRegion).not.toHaveBeenCalled();
-      expect(onExitRegion).not.toHaveBeenCalled();
-    }
-
-    // Moving to time=17, we should exit |nested|.
-    poll(observer,
-        /* timeInSeconds= */ 17,
-        /* seeking= */ false);
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).toHaveBeenCalledOnceMoreWith([nested, false]);
-
-    // Moving to time=18, we should enter |overlap|.
-    poll(observer,
-        /* timeInSeconds= */ 18,
-        /* seeking= */ false);
-    expect(onEnterRegion).toHaveBeenCalledOnceMoreWith([overlap, false]);
-    expect(onExitRegion).not.toHaveBeenCalled();
-
-    // Slowly move from time=19 to time=20. We should see nothing change.
-    for (let time = 19; time <= 20; time++) {
-      poll(observer,
-          /* timeInSeconds= */ time,
-          /* seeking= */ false);
-      expect(onEnterRegion).not.toHaveBeenCalled();
-      expect(onExitRegion).not.toHaveBeenCalled();
-    }
-
-    // Moving to time=21, we should exit |region|.
-    poll(observer,
-        /* timeInSeconds= */ 21,
-        /* seeking= */ false);
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).toHaveBeenCalledOnceMoreWith([region, false]);
-
-    // Nothing should change.
-    // Slowly move from time=19 to time=20. We should see nothing change.
-    for (let time = 22; time <= 23; time++) {
-      poll(observer,
-          /* timeInSeconds= */ time,
-          /* seeking= */ false);
-      expect(onEnterRegion).not.toHaveBeenCalled();
-      expect(onExitRegion).not.toHaveBeenCalled();
-    }
-
-    // Moving to time=24, we should exit |overlap|.
-    poll(observer,
-        /* timeInSeconds= */ 24,
-        /* seeking= */ false);
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).toHaveBeenCalledOnceMoreWith([overlap, false]);
-
-    // We should never have called the skip-region callback.
-    expect(onSkipRegion).not.toHaveBeenCalled();
-  });
-
-  // When we move the playhead, we say whether the move is from a seek or from
-  // normal playback. This flag should always be passed to the event. In our
-  // tests we always pass "normal playback". This test should make sure that
-  // the "seeking" flag is passed to each event.
-  it('passes the seeking flag for each event', () => {
-    const region = createRegion('my-region', 1, 3);
-    timeline.addRegion(region);
-
-    // Start before the region, move into the region, move out of the region,
-    // and then skip over the region. All three events should have been fired.
-    poll(observer,
-        /* timeInSeconds= */ 0,
-        /* seeking= */ true);
-
-    poll(observer,
-        /* timeInSeconds= */ 2,
-        /* seeking= */ true);
-    expect(onEnterRegion).toHaveBeenCalledWith(region, /* seeking= */ true);
-
-    poll(observer,
-        /* timeInSeconds= */ 4,
-        /* seeking= */ true);
-    expect(onExitRegion).toHaveBeenCalledWith(region, /* seeking= */ true);
-
-    poll(observer,
-        /* timeInSeconds= */ 0,
-        /* seeking= */ true);
-    expect(onSkipRegion).toHaveBeenCalledWith(region, /* seeking= */ true);
-  });
-
-  // The first call to |poll| sets the initial position of the playhead. If we
-  // start the playhead after a region ends, we should not fire events for that
-  // region.
-  it('ignores regions the initial poll position when not seeking', () => {
-    const region = createRegion('early-region', 0, 1);
-    timeline.addRegion(region);
-
-    // Start the playhead after the region ends.
-    poll(observer, /* timeInSeconds= */ 2, /* seeking= */ false);
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).not.toHaveBeenCalled();
-    expect(onSkipRegion).not.toHaveBeenCalled();
-  });
-
-  // Just like the non-seeking version (see above), we should not see an event.
-  // In practice, our initial poll will not be seeking, but it is worth
-  // documenting this expectation.
-  it('ignores regions the initial poll position when seeking', () => {
-    const region = createRegion('early-region', 0, 1);
-    timeline.addRegion(region);
-
-    // Start the playhead after the region ends.
-    poll(observer, /* timeInSeconds= */ 2, /* seeking= */ true);
-    expect(onEnterRegion).not.toHaveBeenCalled();
-    expect(onExitRegion).not.toHaveBeenCalled();
-    expect(onSkipRegion).not.toHaveBeenCalled();
-  });
-
-  // See https://github.com/shaka-project/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
-   * @param {number} endTimeSeconds
-   * @return {shaka.extern.TimelineRegionInfo}
-   */
-  function createRegion(id, startTimeSeconds, endTimeSeconds) {
-    return {
-      schemeIdUri: 'urn:foo',
-      id: id,
-      value: '',
-      startTime: startTimeSeconds,
-      endTime: endTimeSeconds,
-      eventElement: null,
-    };
-  }
-
-  /**
-   * @param {!shaka.media.IPlayheadObserver} observer
-   * @param {number} timeInSeconds
-   * @param {boolean} wasSeeking
-   */
-  function poll(observer, timeInSeconds, wasSeeking) {
-    observer.poll(
-        /* position= */ timeInSeconds,
-        /* seeking= */ wasSeeking);
-  }
-});

package/test/media/region_timeline_unit.js

@@ -1,139 +0,0 @@
-/*! @license
- * Shaka Player
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-describe('RegionTimeline', () => {
-  /** @type {!shaka.media.RegionTimeline} */
-  let timeline;
-
-  /** @type {!jasmine.Spy} */
-  let onNewRegion;
-
-  /** @type {!jasmine.Spy} */
-  let onRemoveRegion;
-
-  /** @type {!jasmine.Spy} */
-  let onSeekRange;
-
-  beforeEach(() => {
-    onSeekRange = jasmine.createSpy('onSeekRange');
-    onSeekRange.and.returnValue({start: 0, end: 100});
-    timeline = new shaka.media.RegionTimeline(
-        shaka.test.Util.spyFunc(onSeekRange));
-
-    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(() => {
-    timeline.release();
-  });
-
-  it('stores unique scheme id uri', () => {
-    // Add regions with unique scheme id uri
-    timeline.addRegion(createRegion('urn:foo', 'my-region', 0, 10));
-    timeline.addRegion(createRegion('urn:bar', 'my-region', 0, 10));
-    expect(onNewRegion).toHaveBeenCalledTimes(2);
-  });
-
-  it('stores unique event id', () => {
-    // Add regions with unique event id
-    timeline.addRegion(createRegion('urn:foo', 'my-region-1', 0, 10));
-    timeline.addRegion(createRegion('urn:foo', 'my-region-2', 0, 10));
-    expect(onNewRegion).toHaveBeenCalledTimes(2);
-  });
-
-  it('stores unique start time', () => {
-    // Add regions with unique start time
-    timeline.addRegion(createRegion('urn:foo', 'my-region', 0, 10));
-    timeline.addRegion(createRegion('urn:foo', 'my-region', 5, 10));
-    expect(onNewRegion).toHaveBeenCalledTimes(2);
-  });
-
-  it('stores unique end time', () => {
-    // Add regions with unique end time
-    timeline.addRegion(createRegion('urn:foo', 'my-region', 0, 10));
-    timeline.addRegion(createRegion('urn:foo', 'my-region', 0, 15));
-    expect(onNewRegion).toHaveBeenCalledTimes(2);
-  });
-
-  it('dedups identical regions', () => {
-    // Add two identical regions and verify only one is stored
-    timeline.addRegion(createRegion('urn:foo', 'my-region', 0, 10));
-    timeline.addRegion(createRegion('urn:foo', 'my-region', 0, 10));
-    expect(onNewRegion).toHaveBeenCalledTimes(1);
-  });
-
-  it('verifies region data integrity', () => {
-    // Add a few regions and verify data integrity
-    const region1 = createRegion('urn:foo', 'my-region-1', 0, 10);
-    const region2 = createRegion('urn:foo', 'my-region-2', 11, 20);
-    const region3 = createRegion('urn:foo', 'my-region-3', 21, 30);
-
-    timeline.addRegion(region1);
-    timeline.addRegion(region2);
-    timeline.addRegion(region3);
-
-    const uniqueRegions = Array.from(timeline.regions());
-    expect(uniqueRegions).toEqual([
-      region1,
-      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
-   * @param {string} id
-   * @param {number} startTimeSeconds
-   * @param {number} endTimeSeconds
-   * @return {shaka.extern.TimelineRegionInfo}
-   */
-  function createRegion(schemeIdUri, id, startTimeSeconds, endTimeSeconds) {
-    return {
-      schemeIdUri: schemeIdUri,
-      id: id,
-      value: '',
-      startTime: startTimeSeconds,
-      endTime: endTimeSeconds,
-      eventElement: null,
-    };
-  }
-});