shaka-player 4.4.3 → 4.5.0

package/docs/design/lcevc-integration.md

@@ -8,51 +8,51 @@ This article describes the V-Nova LCEVC Shaka Player integration.
 # LCEVC Integration
 
 ## Adding V-Nova required files
-### Importing DIL - Decoder Integration Layer
+### Importing LCEVC Decoder
 
-V-Nova LCEVC DIL Libraries are included using the same approach that the other external libraries are currently using. The necessary V-Nova LCEVC DIL files need to be imported in the HTML page that is going to be used by Shaka Player to decode LCEVC. Checks are inplace that make sure the necessary objects are available.
+V-Nova LCEVC Decoder Libraries are included using the same approach that the other external libraries are currently using. The necessary V-Nova LCEVC Decoder files need to be imported in the HTML page that is going to be used by Shaka Player to decode LCEVC. Checks are inplace that make sure the necessary objects are available.
 
-Npm package : <https://www.npmjs.com/package/lcevc_dil.js>
+NPM package : <https://www.npmjs.com/package/lcevc_dec.js>
 
 ```javascript
   <!-- MPEG-5 Part2 LCEVC support is enabled by including this: -->
-  <script defer src="../node_modules/lcevc_dil.js/dist/lcevc_dil.min.js"></script>
+  <script defer src="../node_modules/lcevc_dec.js/dist/lcevc_dec.min.js"></script>
 ```
 
-To allow the Closure compiler to use the objects and methods that are exported by the DIL.js a new `extern` is created.
+To allow the Closure compiler to use the objects and methods that are exported by the LCEVCdec.js a new `extern` is created.
 
 ### Defining an Extern for LCEVC
 
-`externs/lcevc.js` exposes the functions from the LCEVC DIL library required for LCEVC Decoding.
+`externs/lcevc.js` exposes the functions from the LCEVC Decoder library required for LCEVC Decoding.
 
 ## Integration point
 
-### The shaka.lcevc.Dil class - (DIL : Decoder Integration Layer)
+### The shaka.lcevc.Dec class - (DEC : Decoder)
 
-The main logic of the LCEVC integration is located in the `lib/lcevc_dil.min.js` file. In this file the shaka.lcevc.Dil is exported to be used in the project. This class is in charge of creating the Dil object using the mentioned externs, checking if LCEVC DIL library is available, etc.
+The main logic of the LCEVC integration is located in the `lib/lcevc_dec.min.js` file. In this file the shaka.lcevc.Dec is exported to be used in the project. This class is in charge of creating the Dec object using the mentioned externs, checking if LCEVC Decoder library is available, etc.
 
 ### Modifications in the player
 
 The shaka.Player class, defined in the `lib/player.js` file, is the main player object for Shaka Player. There is a setter function for setting up a `canvas` element that is received from the user.
 If shaka.ui is used the `canvas` is created in line with the video element in the same container overlaying the video element. If user provides a custom canvas using the setter function, The user is responsible for placing the canvas element in the desired position and resizing it.
 
-`shaka.externs.LcevcConfiguration` is added to the `playerConfiguration` that is used as configuration for the LCEVC DIL Library.
+`shaka.externs.LcevcConfiguration` is added to the `playerConfiguration` that is used as configuration for the LCEVC Decoder Library.
 
-The Dil object is created in the `onLoad_()` event that is triggered when a new video is loaded in Shaka Player. Attaching to a media element is defined as:
+The Dec object is created in the `onLoad_()` event that is triggered when a new video is loaded in Shaka Player. Attaching to a media element is defined as:
 
 -   Registering error listeners to the media element.
 -   Catching the video element for use outside of the load graph.
 
-The Dil object is created only if LCEVC is supported (LCEVC libs are loaded on the page) and also when it was not already created in another `onLoad_()` event execution.
+The LCEVC Decoder object is created only if LCEVC is supported (LCEVC libs are loaded on the page) and also when it was not already created in another `onLoad_()` event execution.
 
 
-### Feeding the Dil
+### Feeding the Dec
 
 The logic that Shaka Player uses to communicate with the Media Source Extensions (MSE) is located in the `media/media_source_engine.js` file.
 
 ![image.png](lcevc-architecture.png)
 
- `append_()` function that is used to feed the MSE Source Buffer is intercepted and modified to pass the video buffers to the LCEVC DIL Libraries before appending to the MSE Source Buffers. 
+ `append_()` function that is used to feed the MSE Source Buffer is intercepted and modified to pass the video buffers and related time offsets to the LCEVC Decoder Libraries before appending to the MSE Source Buffers. 
 
 ## Demo page
 
@@ -60,7 +60,7 @@ The relevant libraries are added in the Demo Page like so:
 
 ```javascript
   <!-- MPEG-5 Part2 LCEVC support is enabled by including this: -->
-  <script defer src="../node_modules/lcevc_dil.js/dist/lcevc_dil.min.js"></script>
+  <script defer src="../node_modules/lcevc_dec.js/dist/lcevc_dec.min.js"></script>
 ```
 
 And a new video sample with enhancement data is added to the `demo/common/assets.js` file under a new source `MPEG-5 Part 2 LCEVC`.

package/docs/tutorials/faq.md

@@ -95,31 +95,6 @@ you see JSON, you will need to [unwrap the response][wrapping].
 
 <hr>
 
-**Q:** Why doesn't getStats() work in Safari?
-
-**A:** To play HLS content on Safari, we default to using Apple's native src=
-playback.  Since the browser handles playback, we don't get much information.
-
-If you want to disable native playback and use MediaSource playback instead,
-configure {@link shaka.extern.StreamingConfiguration|
-`.streaming.useNativeHlsOnSafari`} to false.
-
-<hr>
-
-**Q:** Why doesn't my HLS content work?
-
-**A:** If your HLS content uses MPEG2-TS, you may need to enable transmuxing.
-The only browsers capable of playing TS natively are Edge and Chromecast.  You
-will get a `CONTENT_UNSUPPORTED_BY_BROWSER` error on other browsers due to
-their lack of TS support.
-
-You can enable transmuxing by [including mux.js][] v5.6.3+ in your application.
-If Shaka Player detects that mux.js has been loaded, we will use it to transmux
-TS content into MP4 on-the-fly, so that the content can be played by the
-browser.
-
-<hr>
-
 **Q:** Why does it take so long to switch to HD?
 
 **A:** When Shaka Player's `AbrManager` makes a decision to adapt, we don't
@@ -158,26 +133,18 @@ shaka.net.NetworkingEngine.registerScheme('file', shaka.net.HttpXHRPlugin.parse)
 
 <hr>
 
-**Q:** Why are my CEA-708 captions not showing on Edge or Chromecast?
-
-**A:** Our support for CEA-708 captions requires transmuxing the TS files that
-contain said captions.  Edge and Chromecast, however, have native TS support and
-thus are not required to transmux.
-In order to force those platforms to transmux, set the
-{@link shaka.extern.StreamingConfiguration|`.streaming.forceTransmux`}
-configuration to true.
-
-<hr>
-
 **Q:** Why do I get 404 errors with very large timescales?
 
-**A:** We can't handle content that creates timestamps too large to be
-represented as Numbers in JavaScript (2^53).  Very large timescales require very
-large timestamps (in timescale units), which means we are unable to substitute
-the correct values for `$Time$` in a `<SegmentTemplate>`.  [BigInteger.js][] is
-too large to become a required dependency for Shaka Player.
+**A:** Some content creates timestamps too large to be represented as Numbers
+in JavaScript (2^53).  Very large timescales require very large timestamps (in
+timescale units), which means we are unable to substitute the correct values
+for `$Time$` in a `<SegmentTemplate>`.
+
+We can work around this for platforms that support [`BigInt`][], or in cases
+where we can live with a rounding error (not `$Time$` in `<SegmentTemplate>`).
 
-We recommend reducing your timescale or avoiding `$Time` in `<SegmentTemplate>`.
+If you must use `$Time` in `<SegmentTemplate>` and you must play on devices
+that do not support [`BigInt`][], we recommend reducing your timescale.
 See discussion in [#1667][1667] for details.
 
 <hr>
@@ -202,20 +169,23 @@ you can use the same top-level APIs; but we are dependent on the browser
 handling the streaming.  So we won't support DASH on iOS since the browser
 doesn't support it.
 
-We have another project called [Shaka Player Embedded][] that offers the same
-features and similar APIs for native apps on iOS.  This project uses its own
-media stack, which allows it to play content that would otherwise not be
-supported.  This supports both DASH and HLS manifests.
+In a future version, we plan to support `ManagedMediaSource` on iOS to achieve
+control over both DASH and HLS playback on iOS.  See [#5271][] and the
+[`ManagedMediaSource` W3C spec proposal][]
 
 <hr>
 
 **Q:** The Nightly Demo isn't loading for me!
 
 **A:** Are you looking at the uncompiled build with an AdBlocker enabled?
-We're rolling out ad support which is triggering some ad blockers to block
-requests for some of our source files. This only affects the uncompiled build.
+
+Some ad blockers decide to block requests for some of our source files simply
+because they have `ad` in the file name. This only affects the uncompiled
+build.
+
 Switch to the compiled build (add "build=compiled" to the url) or temporarily
-disable your ad blocker to see the nightly uncompiled mode.
+disable your ad blocker to see the nightly in uncompiled mode.
+
 Please note that if you want to test our ad logic, you might have to disable
 the ad blocker in compiled mode as well.
 
@@ -243,11 +213,11 @@ an HLS manifest, we do our best to guess what the codecs might be, but those
 guesses might not always be accurate.  If an HLS manifest has no codec
 information provided, we default to guessing that the video codec is
 `avc1.42E01E` and the audio codec is `mp4a.40.2`, which can cause problems if
-the stream is actually video-only or audio-only.  In this case, you can enable
-the {@link shaka.extern.ManifestConfiguration|`.manifest.disableVideo`} or 
-{@link shaka.extern.ManifestConfiguration|`.manifest.disableAudio`} 
-configurations to signal that your content does not have a video or audio 
-stream.
+the stream is actually video-only or audio-only.
+
+To change our default assumptions about codecs in HLS, please see
+{@link shaka.extern.HlsManifestConfiguration|`.manifest.hls`} in the player
+config.
 
 <hr>
 
@@ -269,8 +239,10 @@ proxy them.
 [887]: https://github.com/shaka-project/shaka-player/issues/887
 [999]: https://github.com/shaka-project/shaka-player/issues/999
 [1667]: https://github.com/shaka-project/shaka-player/issues/1667
-[BigInteger.js]: https://github.com/peterolson/BigInteger.js
+[#5271]: https://github.com/shaka-project/shaka-player/issues/5271
+[BigInt]: https://caniuse.com/bigint
 [CORS]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS
+[`ManagedMediaSource` W3C spec proposal]: https://github.com/w3c/media-source/issues/320
 [Shaka Player Embedded]: https://github.com/shaka-project/shaka-player-embedded
 [auth]: https://shaka-player-demo.appspot.com/docs/api/tutorial-license-server-auth.html
 [buffering]: https://shaka-player-demo.appspot.com/docs/api/tutorial-network-and-buffering-config.html

package/docs/tutorials/index.json

@@ -24,5 +24,6 @@
   { "selenium-grid-config": { "title": "Selenium Grid Config" } },
   { "faq": { "title": "Frequently Asked Questions" } },
   { "upgrade": { "title": "Upgrade Guide" } },
-  { "upgrade-manifest": { "title": "ManifestParser Upgrade Guide" } }
+  { "upgrade-manifest": { "title": "ManifestParser Upgrade Guide" } },
+  { "lcevc": { "title": "LCEVC Quick Start" } }
 ]

package/docs/tutorials/lcevc.md

@@ -0,0 +1,118 @@
+# LCEVC Quick Start 
+ 
+#### Requirements 
+ 
+ - Only supported on browsers with Media Source Extensions SourceBuffer support 
+ 
+ - MPEG-5 Part2 LCEVC decoding support (decoding provided by [lcevc_dec.js][], 
+ must be separately included) 
+ 
+##### Integration documentation : [docs](../design/lcevc-integration.md) 
+ 
+##### More on [MPEG-5 Part2 LCEVC][] 
+ 
+[lcevc_dec.js]: https://www.npmjs.com/package/lcevc_dec.js?activeTab=readme
+[MPEG-5 Part2 LCEVC]: https://www.lcevc.org 
+ 
+#### Configure LCEVC 
+ 
+LCEVC Decoder library needs to be included in the HTML page: 
+ 
+- Local `npm install lcevc_dec.js` 
+```html 
+<script src="../node_modules/lcevc_dec.js/dist/lcevc_dec.min.js"></script> 
+``` 
+- Or use `unpkg.com` for latest LCEVC Decoder libraries.
+```html 
+<script src="https://unpkg.com/lcevc_dec.js@1.0.0/dist/lcevc_dec.min.js"></script> 
+``` 
+ 
+Configuration to enable LCEVC enhancement: 
+```js 
+player.configure('lcevc.enabled', true); 
+``` 
+ 
+#### LCEVC setup via UI library 
+ 
+Sample setup using the Shaka Player UI library:  
+ 
+```html 
+<!DOCTYPE html> 
+<html> 
+  <head> 
+    <!-- Shaka Player UI compiled library and default CSS for player controls: --> 
+    <script src="dist/shaka-player.ui.js"></script> 
+    <link rel="stylesheet" href="dist/controls.css" /> 
+ 
+    <!-- LCEVC decoder compiled library --> 
+    <script src="https://unpkg.com/lcevc_dec.js@1.0.0/dist/lcevc_dec.min.js"></script> 
+ 
+    <!-- Application source: --> 
+    <script src="app.js"></script> 
+  </head> 
+ 
+  <body> 
+    <!-- The data-shaka-player-container tag will make the UI library place the controls in this div. --> 
+    <div data-shaka-player-container style="max-width:40em"> 
+      <!-- The data-shaka-player tag will make the UI library use this video element. --> 
+      <video data-shaka-player id="video" style="width:100%;height:100%"></video> 
+    </div> 
+  </body> 
+</html> 
+``` 
+ 
+```js 
+// app.js 
+ 
+const manifestUri = 'https://dyctis843rxh5.cloudfront.net/vnIAZIaowG1K7qOt/master.m3u8'; 
+ 
+// Initialise Shaka Player with LCEVC enhancement. 
+async function init() { 
+  // When using the UI, the player is made automatically by the UI object. 
+  const video = document.getElementById('video'); 
+  const ui = video['ui']; 
+  const controls = ui.getControls(); 
+  const player = controls.getPlayer(); 
+ 
+  // Enable the LCEVC enhancement. 
+  player.configure('lcevc.enabled', true); 
+ 
+  // Listen for error events. 
+  player.addEventListener('error', onError); 
+  controls.addEventListener('error', onError); 
+ 
+  // Try to load a manifest. 
+  // This is an asynchronous process. 
+  try { 
+    await player.load(manifestUri); 
+    // This runs if the asynchronous load is successful. 
+    console.log('The video has now been loaded!'); 
+  } catch (error) { 
+    onError(error); 
+  } 
+} 
+ 
+// Handle errors. 
+function onError(error) { 
+  console.error('Error', error); 
+} 
+ 
+// Listen to the custom shaka-ui-loaded event, to wait until the UI is loaded. 
+document.addEventListener('shaka-ui-loaded', init); 
+// Listen to the custom shaka-ui-load-failed event, in case Shaka Player fails 
+// to load (e.g. due to lack of browser support). 
+document.addEventListener('shaka-ui-load-failed', onError); 
+ 
+``` 
+ 
+#### User provided canvas 
+ 
+User can also provide a canvas to the player though `attachCanvas` function: 
+ 
+```js 
+player.attachCanvas(canvas); 
+``` 
+ 
+Note: If external canvas is used, user is responsible for managing 
+the canvas. If no canvas is provided for Shaka UI library, the player 
+will generate and manage the canvas. 

package/docs/tutorials/ui-customization.md

@@ -68,6 +68,8 @@ The following elements can be added to the UI bar using this configuration value
   supports AirPlay.
 * cast: adds a button that opens a Chromecast dialog. The button is visible only if there is
   at least one Chromecast device on the same network available for casting.
+* remote: adds a button that opens a Remote Playback dialog. The button is visible only if the
+  browser supports Remote Playback API.
 * quality: adds a button that controls enabling/disabling of abr and video resolution selection.
 * language: adds a button that controls audio language selection.
 * playback_rate: adds a button that controls the playback rate selection.
@@ -91,6 +93,8 @@ The following buttons can be added to the overflow menu:
 * playback_rate: adds a button that controls the playback rate selection.
 * airplay: adds a button that opens a AirPlay dialog. The button is visible only if the browser
   supports AirPlay.
+* remote: adds a button that opens a Remote Playback dialog. The button is visible only if the
+  browser supports Remote Playback API.
 * Statistics: adds a button that displays statistics of the video.
 <!-- TODO: If we add more buttons that can be put in the order this way, list them here. -->
 

package/externs/css_style_declaration.js

@@ -0,0 +1,19 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+/**
+ * @fileoverview Externs for CSSStyleDeclaration properties not in the
+ * Closure compiler.
+ *
+ * @externs
+ */
+
+
+/**
+ * @type {string}
+ */
+CSSStyleDeclaration.prototype.textCombineUpright;

package/externs/lcevc.js

@@ -1,25 +1,27 @@
 /**
-* @fileoverview Externs for LcevcDil
+* @fileoverview Externs for LcevcDec
 * compiler.
 *
 * @externs
 */
 
-// This empty namespace is declared to check if LcevcDil libraries are loaded.
+// This empty namespace is declared to check if LcevcDec libraries are loaded.
+/** @const */
 var libDPIModule = {};
-var LcevcDil = {};
+/** @const */
+var LCEVCdec = {};
 
 /**
-* LCEVC DIL constructor
+* LCEVC Dec constructor
 * @constructor
 */
-LcevcDil.LcevcDIL = class {
+LCEVCdec.LCEVCdec = class {
   /**
    * @param {HTMLVideoElement} media
    * @param {HTMLCanvasElement} canvas
-   * @param {shaka.extern.LcevcConfiguration} dilConfig
+   * @param {shaka.extern.LcevcConfiguration} lcevcConfig
    */
-  constructor(media, canvas, dilConfig) {
+  constructor(media, canvas, lcevcConfig) {
   }
 
   /**
@@ -30,13 +32,14 @@ LcevcDil.LcevcDIL = class {
    * @param {!BufferSource} data Video Buffer Data.
    * @param {string} type Type of Video Buffer Data.
    * @param {number} variantId Variant that the fragment belongs to.
+   * @param {number} timestampOffset Timestamp offset for appended segments
    */
-  appendBuffer(data, type, variantId) {}
+  appendBuffer(data, type, variantId, timestampOffset) {}
 
   /**
    * Set current variant as variantId to the LCEVC decoder
    * @param {!number} variantId
-   * @param {!boolean} autoBufferSwitch is lcevcDil mode that switches variant
+   * @param {!boolean} autoBufferSwitch is lcevcDec mode that switches variant
    * when the downloaded buffer from last variant has finished playing and
    * buffers from the new variant starts to play.
    */
@@ -49,15 +52,28 @@ LcevcDil.LcevcDIL = class {
   setContainerFormat(containerFormat) {}
 
   /**
-   * Close LCEVC DIL
+   * Set streaming Format for LCEVC Data Parsing.
+   * @param {!number} streamingFormat container type of the stream.
+   */
+  setStreamingFormat(streamingFormat) {}
+
+  /**
+   * Close LCEVC DEC
    */
   close() {}
 };
 
+/**
+ * The older module interface, for backward compatibility.
+ * Typed to the same interface, but under a different name.
+ * @type {typeof LCEVCdec.LCEVCdec}
+ */
+LCEVCdec.LcevcDil;
+
 /**
  * LCEVC Support Check
  */
-LcevcDil.SupportObject = {
+LCEVCdec.SupportObject = {
 
   /**
    * Check if canvas has WebGL support
@@ -72,10 +88,18 @@ LcevcDil.SupportObject = {
  * LCEVC Support Checklist Result
  * @type {boolean}
  */
-LcevcDil.SupportObject.SupportStatus;
+LCEVCdec.SupportObject.SupportStatus;
 
 /**
  * LCEVC Support CheckList Error if any.
  * @type {string}
  */
-LcevcDil.SupportObject.SupportError;
+LCEVCdec.SupportObject.SupportError;
+
+/**
+ * Typedef for the module interface.  Both LCEVCdec (new module) and LcevcDil
+ * (old module) implement roughly the same interface.
+ *
+ * @typedef {typeof LCEVCdec}
+ */
+var LCEVCmodule;

package/externs/media_remote.js

@@ -0,0 +1,68 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for HTMLMediaElement which were missing in the
+ * Closure compiler.
+ *
+ * @externs
+ */
+
+
+/**
+ * @constructor
+ * @implements {EventTarget}
+ */
+function RemotePlayback() {}
+
+
+/**
+ * Represents the RemotePlayback connection's state.
+ * @type {string}
+ */
+RemotePlayback.prototype.state;
+
+
+/**
+ * The watchAvailability() method of the RemotePlayback interface watches
+ * the list of available remote playback devices and returns a Promise that
+ * resolves with the callbackId of a remote playback device.
+ *
+ * @param {!function(boolean)} callback
+ * @return {!Promise}
+ */
+RemotePlayback.prototype.watchAvailability = function(callback) {};
+
+
+/**
+ * The cancelWatchAvailability() method of the RemotePlayback interface
+ * cancels the request to watch for one or all available devices.
+ *
+ * @param {number} id
+ * @return {!Promise}
+ */
+RemotePlayback.prototype.cancelWatchAvailability = function(id) {};
+
+
+/**
+ * The prompt() method of the RemotePlayback interface prompts the user
+ * to select an available remote playback device and give permission
+ * for the current media to be played using that device.
+ *
+ * If the user gives permission, the state will be set to connecting and
+ * the user agent will connect to the device to initiate playback.
+ *
+ * If the user chooses to instead disconnect from the device, the state will
+ * be set to disconnected and user agent will disconnect from this device.
+ *
+ * @return {!Promise}
+ */
+RemotePlayback.prototype.prompt = function() {};
+
+
+/** @type {RemotePlayback} */
+HTMLMediaElement.prototype.remote;
+