shaka-player 4.6.4 → 4.7.0

package/maintained-branches.md

@@ -1,15 +0,0 @@
-# Maintained Shaka Player Branches
-
-We are currently maintaining the following branches of Shaka Player:
-
- - v4.6 (latest)
- - v4.5 (previous)
- - v4.3 (in use by the Cast Application Framework)
- - No active LTS branches at this time
-
-Other branches are no longer receiving bug fixes, and we recommend you upgrade
-to a maintained branch.  For details on upgrading, please see our
-[upgrade guide](https://shaka-player-demo.appspot.com/docs/api/tutorial-upgrade.html).
-
-For more information on how these branches are chosen, please refer to our
-[Branch Maintenance Policy](https://shaka-project.github.io/maintenance/shaka-player.html#branch-maintenance-policy).

package/roadmap.md

@@ -1,186 +0,0 @@
-# Shaka Player Roadmap
-
-This doc shows all past and planned future milestones for Shaka Player, with
-brief details about the goals and rough dates of each milestone.  This is not a
-comprehensive list of features or fixes for each release.  For that, see
-CHANGELOG.md.
-
-The goals of future milestones are fluid until we begin that development cycle,
-so the exact milestone for future features is not pre-determined.
-
-Candidate features for future release cycles:
- - Official TypeScript defs, generated from source
-   https://github.com/shaka-project/shaka-player/issues/1030
- - Background fetch for offline storage
-   https://github.com/shaka-project/shaka-player/issues/879
- - A method to stitch together clips
-   https://github.com/shaka-project/shaka-player/issues/764
- - Predict next segment in DASH SegmentTimeline
-   https://github.com/shaka-project/shaka-player/issues/898
- - Smaller, more modular binary
-
-v5.0 - 2024 Q1
- - Preload API
-   https://github.com/shaka-project/shaka-player/issues/880
- - Common Media Server Data (CMSD)
-   https://github.com/shaka-project/shaka-player/issues/5890
-
-=====
-
-v4.6 - 2023 Q4
- - Content Steering
-   https://github.com/shaka-project/shaka-player/issues/5704
- - New DASH protocol for Low Latency.
- - ManagedMediaSource
-   https://github.com/shaka-project/shaka-player/issues/5271
- - Add thumbnails support in src=
- - Remove state engine
-
-v4.5 - 2023 Q4
- - Built-in transmuxer support for muxed content streams (audio+video)
- - Built-in transmuxer support for H265 streams
- - Remove optional mux.js dependency
- - Codec switching
-   https://github.com/shaka-project/shaka-player/issues/1528
- - AES-128 in DASH.
-   https://github.com/shaka-project/shaka-player/issues/5622
- - AWS Elemental MediaTailor
-
-v4.4 - 2023 Q3
- - Built-in transmuxer for common cases, no mux.js required:
-   - Raw AAC, AC3, or EC3 to MP4 container
-   - AAC, AC3, EC3, MP3, or H264 in TS to MP4 container
-   - MP3-in-TS to raw MP3
- - Ads API improvements
- - CEA parser for TS
- - HLS support for non-sequence mode (as we had in v3)
- - Partial support for large timestamps
- - UI support for thumbnails on seek
- - Microsoft SmoothStreaming support
- - Segment prefetch
- - Low latency improvements
-
-v4.3 - 2022 Q4
- - Support ID3 tags in mp4
-   https://github.com/shaka-project/shaka-player/issues/3351
- - Lazy-load HLS playlists on adaptation
-   https://github.com/shaka-project/shaka-player/issues/1936
- - HLS key rotation
-   https://github.com/shaka-project/shaka-player/issues/741
-
-v4.2 - 2022 Q3
- - Automatic ABR quality restrictions based on size
-   https://github.com/shaka-project/shaka-player/issues/2333
- - HLS support for AES-128 encryption
-   https://github.com/shaka-project/shaka-player/issues/850
-
-v4.1 - 2022 Q2
- - HLS support for EXT-X-GAP
-   https://github.com/shaka-project/shaka-player/issues/1308
- - Temporarily disable the active variant after `HTTP_ERROR`
-   https://github.com/shaka-project/shaka-player/issues/1542
-
-v4.0 - 2022 Q2
- - MSE support for FairPlay
-   https://github.com/shaka-project/shaka-player/issues/3346
- - Support containerless formats
-   https://github.com/shaka-project/shaka-player/issues/2337
-
-v3.3 - 2022 Q1
- - Common Media Client Data (CMCD) logging support
-   https://github.com/shaka-project/shaka-player/issues/3619
- - Non-linear IMA CS ads
-   https://github.com/shaka-project/shaka-player/pull/3639
-
-v3.2 - 2021 Q3
- - MediaCapabilities to make performance-based decisions
-   https://github.com/shaka-project/shaka-player/issues/1391
- - Configurable key-system priority
-   https://github.com/shaka-project/shaka-player/issues/3002
- - Codec order preferences
-   https://github.com/shaka-project/shaka-player/issues/2179
-
-v3.1 - 2021 Q2
- - Low-latency live (LL-HLS, LL-DASH)
-   https://github.com/shaka-project/shaka-player/issues/1525
- - Own CEA parser, use mux.js only for TS
-   https://github.com/shaka-project/shaka-player/issues/2648
- - Thumbnail tracks
-   DASH: https://github.com/shaka-project/shaka-player/issues/559
-   HLS: https://github.com/shaka-project/shaka-player/issues/2429
-
-v3.0 - 2020 Q2
- - Code health improvements
- - Conversion to ES6
- - Isolate DASH periods to the DASH parser
- - HLS discontinuity support
- - IMA ad SDK integration
- - Ad controls in the UI
- - Concurrent Storage operations
-
-v2.5 - 2019 Q2
- - Video controls UI API
- - FairPlay & iOS support
- - CEA captions in HLS/CMAF and DASH w/ mux.js
- - Single-file playback
- - DASH drift tolerance
-
-v2.4 - 2018 Q2
- - TTML and VTT regions
- - CEA captions in HLS/TS
- - Attach/detach API
-
-v2.3 - 2017 Q4
- - HLS live
- - Transmux TS w/ mux.js
- - NetworkInformation API to improve bandwidth estimates
- - ES6 transition begins
-
-v2.2 - 2017 Q3
- - HLS event-type playlists
- - TextDisplayer interface
- - DASH xlink support
-
-v2.1 - 2017 Q2
- - HLS VOD, clear & Widevine only, no CEA
- - DASH trick mode tracks
- - Async network filters
-
-v2.0 - 2016 Q3
- - Multi-period DASH
- - Chromecast API
- - TTML, VTT-in-MP4, and TTML-in-MP4
- - Safari, Firefox, & Opera support
- - Plugin system (manifest parsers, network filters, text parsers)
- - DASH emsg box support
- - DASH IPR support
-
-v1.6 - 2015 Q4
- - IE11, Edge, & PlayReady support
- - Chromecast added to demo app
-
-v1.5 - 2015 Q3
- - Unified configuration system
- - Multiple DASH BaseURL elements for failover
- - Side-loaded text streams
-
-v1.4 - 2015 Q3
- - Code health release
- - DASH Location element support
- - Buffering config API
- - License preprocessing API
-
-v1.3 - 2015 Q2
- - DASH live
- - Offline playback
-
-v1.2 - 2015 Q1
- - DASH Role element support
-
-v1.1 - 2015 Q1
- - EME API updates
-
-v1.0 - 2014 Q4
- - DASH VOD (MP4 & WebM)
- - VTT subtitles, rendered by the browser
- - Widevine support

package/test/abr/simple_abr_manager_unit.js

@@ -1,398 +0,0 @@
-/*! @license
- * Shaka Player
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-describe('SimpleAbrManager', () => {
-  const sufficientBWMultiplier = 1.06;
-  const defaultBandwidthEstimate = 500e3; // 500kbps
-  const oldDateNow = Date.now;
-
-  /** @type {shaka.extern.AbrConfiguration} */
-  let config;
-  /** @type {!jasmine.Spy} */
-  let switchCallback;
-  /** @type {!shaka.abr.SimpleAbrManager} */
-  let abrManager;
-  /** @type {shaka.extern.Manifest} */
-  let manifest;
-  /** @type {!Array.<shaka.extern.Variant>} */
-  let variants;
-
-  beforeEach(() => {
-    Date.now = () => 0;
-    switchCallback = jasmine.createSpy('switchCallback');
-
-    // Keep unsorted.
-    manifest = shaka.test.ManifestGenerator.generate((manifest) => {
-      manifest.addVariant(100, (variant) => {
-        variant.bandwidth = 4e5;  // 400 kbps
-        variant.addAudio(0);
-        variant.addVideo(1);
-      });
-      manifest.addVariant(101, (variant) => {
-        variant.bandwidth = 1e6;  // 1000 kbps
-        variant.addAudio(2);
-        variant.addVideo(3);
-      });
-      manifest.addVariant(102, (variant) => {
-        variant.bandwidth = 5e5;  // 500 kbps
-        variant.addAudio(4);
-        variant.addVideo(5);
-      });
-      manifest.addVariant(103, (variant) => {
-        variant.bandwidth = 2e6;
-        variant.addAudio(6);
-        variant.addVideo(7);
-      });
-      manifest.addVariant(104, (variant) => {
-        variant.bandwidth = 2e6;  // Identical on purpose.
-        variant.addAudio(8);
-        variant.addVideo(9);
-      });
-      manifest.addVariant(105, (variant) => {
-        variant.bandwidth = 6e5;
-        variant.addAudio(10);
-        variant.addVideo(11);
-      });
-      manifest.addTextStream(20);
-      manifest.addTextStream(21);
-    });
-
-    config = shaka.util.PlayerConfiguration.createDefault().abr;
-    config.defaultBandwidthEstimate = defaultBandwidthEstimate;
-    config.useNetworkInformation = false;
-
-    variants = manifest.variants;
-
-    abrManager = new shaka.abr.SimpleAbrManager();
-    abrManager.init(shaka.test.Util.spyFunc(switchCallback));
-    abrManager.configure(config);
-    abrManager.setVariants(variants);
-  });
-
-  afterEach(() => {
-    abrManager.stop();
-    Date.now = oldDateNow;
-  });
-
-  it('can choose audio and video Streams right away', () => {
-    const chosen = abrManager.chooseVariant();
-    expect(chosen).not.toBe(null);
-  });
-
-  it('uses custom default estimate', () => {
-    config.defaultBandwidthEstimate = 3e6;
-    abrManager.configure(config);
-    const chosen = abrManager.chooseVariant();
-    expect(chosen.id).toBe(103);
-  });
-
-  it('can handle empty variants', () => {
-    abrManager.setVariants([]);
-    const chosen = abrManager.chooseVariant();
-    expect(chosen).toBe(null);
-  });
-
-  it('can choose from audio only variants', () => {
-    manifest = shaka.test.ManifestGenerator.generate((manifest) => {
-      manifest.addVariant(0, (variant) => {
-        variant.bandwidth = 4e5;
-        variant.addAudio(0);
-      });
-      manifest.addVariant(1, (variant) => {
-        variant.bandwidth = 1e6;
-        variant.addAudio(2);
-      });
-    });
-
-    abrManager.setVariants(manifest.variants);
-    const chosen = abrManager.chooseVariant();
-    expect(chosen).not.toBe(null);
-    expect(chosen.audio).not.toBe(null);
-    expect(chosen.video).toBe(null);
-  });
-
-  it('can choose from video only variants', () => {
-    manifest = shaka.test.ManifestGenerator.generate((manifest) => {
-      manifest.addVariant(0, (variant) => {
-        variant.bandwidth = 4e5;
-        variant.addVideo(0);
-      });
-      manifest.addVariant(1, (variant) => {
-        variant.bandwidth = 1e6;
-        variant.addVideo(2);
-      });
-    });
-
-    abrManager.setVariants(manifest.variants);
-    const chosen = abrManager.chooseVariant();
-    expect(chosen).not.toBe(null);
-    expect(chosen.audio).toBe(null);
-    expect(chosen.video).not.toBe(null);
-  });
-
-  for (const bandwidth of [5e5, 6e5]) {
-    // Simulate some segments being downloaded just above the desired
-    // bandwidth.
-    const bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    const bandwidthKbps = bandwidth / 1000.0;
-    const description = 'picks correct Variant at ' + bandwidthKbps + ' kbps';
-
-    it(description, () => {
-      abrManager.setVariants(variants);
-      abrManager.chooseVariant();
-
-      abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-      abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-      abrManager.enable();
-
-      // Make another call to segmentDownloaded() so switchCallback() is
-      // called.
-      abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-      // Expect variants 2 to be chosen for bandwidth = 5e5
-      // and variant 5 - for bandwidth = 6e5
-      const expectedVariant = (bandwidth == 6e5) ? variants[5] : variants[2];
-
-      expect(switchCallback).toHaveBeenCalledWith(expectedVariant, false, 0);
-    });
-  }
-
-  it('can handle 0 duration segments', () => {
-    // Makes sure bandwidth estimate doesn't get set to NaN
-    // when a 0 duration segment is encountered.
-    // https://github.com/shaka-project/shaka-player/issues/582
-    const bandwidth = 5e5;
-    const bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    abrManager.setVariants(variants);
-    abrManager.chooseVariant();
-
-    // 0 duration segment shouldn't cause us to get stuck on the lowest variant
-    abrManager.segmentDownloaded(0, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    abrManager.enable();
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    expect(abrManager.getBandwidthEstimate()).toBeTruthy();
-  });
-
-  it('picks lowest variant when there is insufficient bandwidth', () => {
-    const bandwidth = 2e6;
-
-    abrManager.setVariants(variants);
-    abrManager.chooseVariant();
-
-    // Simulate some segments being downloaded just above the desired
-    // bandwidth.
-    const bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    abrManager.enable();
-
-    // Make another call to segmentDownloaded() so switchCallback() is
-    // called.
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    // Expect variants 4 to be chosen
-    const expectedVariant = variants[3];
-
-    expect(switchCallback).toHaveBeenCalledWith(expectedVariant, false, 0);
-  });
-
-  it('does not call switchCallback() if not enabled', () => {
-    const bandwidth = 5e5;
-    const bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    abrManager.setVariants(variants);
-    abrManager.chooseVariant();
-
-    // Don't enable AbrManager.
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    expect(switchCallback).not.toHaveBeenCalled();
-  });
-
-  it('does not call switchCallback() in switch interval', () => {
-    let bandwidth = 5e5;
-    let bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    abrManager.setVariants(variants);
-    abrManager.chooseVariant();
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    abrManager.enable();
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    expect(switchCallback).toHaveBeenCalled();
-    switchCallback.calls.reset();
-
-    // Simulate drop in bandwidth.
-    bandwidth = 2e6;
-    bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    // Stay inside switch interval.
-    Date.now = () => (config.switchInterval - 2) * 1e3;
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    expect(switchCallback).not.toHaveBeenCalled();
-
-    // Move outside switch interval.
-    Date.now = () => (config.switchInterval + 2) * 1e3;
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    expect(switchCallback).toHaveBeenCalled();
-  });
-
-  it('does not clear the buffer on upgrade', () => {
-    // Simulate some segments being downloaded at a high rate, to trigger an
-    // upgrade.
-    const bandwidth = 5e5;
-    const bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    abrManager.setVariants(variants);
-    abrManager.chooseVariant();
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    abrManager.enable();
-
-    // Make another call to segmentDownloaded(). switchCallback() will be
-    // called to upgrade.
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    // The second parameter is missing to indicate that the buffer should not be
-    // cleared.
-    expect(switchCallback).toHaveBeenCalledWith(jasmine.any(Object), false, 0);
-  });
-
-  it('does clear the buffer on upgrade with safemargin to 4', () => {
-    // Simulate some segments being downloaded at a high rate, to trigger an
-    // upgrade.
-    const bandwidth = 5e5;
-    const bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    // Set the clear buffer to true and the safe margin to 4.
-    config.clearBufferSwitch = true;
-    config.safeMarginSwitch = 4;
-    abrManager.configure(config);
-
-    abrManager.setVariants(variants);
-    abrManager.chooseVariant();
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    abrManager.enable();
-
-    // Make another call to segmentDownloaded(). switchCallback() will be
-    // called to upgrade.
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    // The second parameter is missing to indicate that the buffer should not be
-    // cleared.
-    expect(switchCallback).toHaveBeenCalledWith(jasmine.any(Object), true, 4);
-  });
-
-  it('does not clear the buffer on downgrade', () => {
-    // Simulate some segments being downloaded at a low rate, to trigger a
-    // downgrade.
-    const bandwidth = 5e5;
-    const bytesPerSecond = sufficientBWMultiplier * bandwidth / 8.0;
-
-    // Set the default high so that the initial choice will be high-quality.
-    config.defaultBandwidthEstimate = 4e6;
-    abrManager.configure(config);
-
-    abrManager.setVariants(variants);
-    abrManager.chooseVariant();
-
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    abrManager.enable();
-
-    // Make another call to segmentDownloaded(). switchCallback() will be
-    // called to downgrade.
-    abrManager.segmentDownloaded(1000, bytesPerSecond, true);
-
-    // The second parameter is missing to indicate that the buffer should not be
-    // cleared.
-    expect(switchCallback).toHaveBeenCalledWith(jasmine.any(Object), false, 0);
-  });
-
-  it('will respect restrictions', () => {
-    manifest = shaka.test.ManifestGenerator.generate((manifest) => {
-      manifest.addVariant(10, (variant) => {
-        variant.bandwidth = 1e5;
-        variant.addVideo(0, (stream) => {
-          stream.size(50, 50);
-        });
-      });
-      manifest.addVariant(11, (variant) => {
-        variant.bandwidth = 2e5;
-        variant.addVideo(1, (stream) => {
-          stream.size(200, 200);
-        });
-      });
-    });
-
-    abrManager.setVariants(manifest.variants);
-    let chosen = abrManager.chooseVariant();
-    expect(chosen.id).toBe(11);
-
-    config.restrictions.maxWidth = 100;
-    abrManager.configure(config);
-
-    chosen = abrManager.chooseVariant();
-    expect(chosen.id).toBe(10);
-  });
-
-  it('uses lowest-bandwidth variant when restrictions cannot be met', () => {
-    manifest = shaka.test.ManifestGenerator.generate((manifest) => {
-      manifest.addVariant(10, (variant) => {
-        variant.bandwidth = 1e5;
-        variant.addVideo(0, (stream) => {
-          stream.size(50, 50);
-        });
-      });
-      manifest.addVariant(11, (variant) => {
-        variant.bandwidth = 2e5;
-        variant.addVideo(1, (stream) => {
-          stream.size(200, 200);
-        });
-      });
-    });
-
-    abrManager.setVariants(manifest.variants);
-    let chosen = abrManager.chooseVariant();
-    expect(chosen.id).toBe(11);
-
-    // This restriction cannot be met, but we shouldn't fail.
-    config.restrictions.maxWidth = 1;
-    abrManager.configure(config);
-
-    chosen = abrManager.chooseVariant();
-    expect(chosen.id).toBe(10);
-  });
-});