shaka-player 4.3.4 → 4.3.6

package/docs/tutorials/a11y.md

@@ -56,10 +56,6 @@ this.eventManager.listen(this.button_, 'click', () => {
 });
 ```
 
-#### Continue the Tutorials
-
-Next, check out {@tutorial ad_monetization}.
-
 
 
 [Web Accessibility Standards]: https://www.w3.org/WAI/standards-guidelines/wcag/

package/docs/tutorials/ad_monetization.md

@@ -222,7 +222,3 @@ before instantiating the player.
 // myapp.CustomAdManager is a placeholder name for your ad manager implementation.
 shaka.Player.setAdManagerFactory(() => new myapp.CustomAdManager());
 ```
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial plugins}.

package/docs/tutorials/basic-usage.md

@@ -86,8 +86,3 @@ document.addEventListener('DOMContentLoaded', initApp);
 ```
 
 That's it!
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial debugging}.

package/docs/tutorials/config.md

@@ -142,8 +142,3 @@ player.configure({
 
 For more detail on individual configuration options, please see the API docs for
 {@link shaka.extern.PlayerConfiguration} and {@link shaka.Player#configure}.
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial network-and-buffering-config}.

package/docs/tutorials/debugging.md

@@ -187,8 +187,3 @@ To sum up, remember these points when debugging your application:
  - Use the debug version of Shaka Player for debugging and integration work
  - Refer to the docs for error codes
  - Increase the log level when you need more detail
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial config}.

package/docs/tutorials/drm-config.md

@@ -208,8 +208,3 @@ you should provide an empty string as robustness
 ##### Other key-systems
 
 Values for other key systems are not known to us at this time.
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial license-server-auth}.
-Or check out {@tutorial fairplay}.

package/docs/tutorials/errors.md

@@ -0,0 +1,94 @@
+# Error Handling
+
+The basics for handling native Error and {@link shaka.util.Error} thrown by Shaka.
+
+## Listening To and Handling Errors
+
+```javascript
+const handleError = (error) => {
+  if (error instanceof Error) {
+    // shaka crashed with an unhandled native error
+  }
+
+  if (error.severity === shaka.util.Error.Severity.CRITICAL) {
+    // handle fatal error, playback can not continue
+  } else {
+    // handle non-fatal error, playback can continue
+  }
+};
+
+const player = new shaka.Player(video);
+
+// handle errors that occur after load
+player.addEventListener('error', handleError);
+
+// there are two options for catching errors that occur during load
+
+// it's possible to listen directly on the promise
+player.load(url).catch(handleError);
+
+// or to use async/await with a try/catch
+try {
+  await player.load(url);
+} catch (e) {
+  handleError(e);
+}
+```
+
+## Custom Handling of Streaming Errors
+
+The `streaming.failureCallback` property of {@link shaka.extern.PlayerConfiguration} can be used to add custom handling or error conversion of errors that occur during streaming.
+
+```javascript
+player.configure('streaming.failureCallback', (error) => {
+  if (error.severity === shaka.util.Error.Severity.CRITICAL) {
+    // custom handling of critical error
+    // e.g. player.retryStreaming();
+  } else {
+    // custom handling of recoverable error
+  }
+});
+```
+
+## Custom Handling of Retries
+
+When configuring retry parameters in Shaka there may be known error codes that should not be retried, or the need to break out of an infinite retry loop in a live context. Retries for failed network requests are not reported as `RECOVERABLE` errors.
+
+For example, if a VOD manifest is missing, unlike when a LIVE manifest is missing, it can be expected to not show up and there is no need to retry.
+
+This is how to convert a retry into a critical error, see {@link shaka.net.NetworkingEngine.RetryEvent} and {@link shaka.util.Error} to decipher how the event can be parsed:
+
+```javascript
+const nwEngine = player.getNetworkingEngine();
+
+const vodManifestNotFoundHandler = (event /* shaka.net.NetworkingEngine.RetryEvent */) => {
+  const code = event.error.code;
+  const data = event.error.data;
+
+  if (code === shaka.util.Error.Code.BAD_HTTP_STATUS) {
+    if (
+      // each type of error has its own data structure (or none at all), tread with care
+      Array.isArray(data) &&
+      data[1] === 404 &&
+      data[4] === shaka.net.NetworkingEngine.RequestType.MANIFEST
+    ) {
+      // Throwing inside a retry callback will immediately stop retries
+      throw error;
+
+      // A proprietary error code can also be thrown
+      // throw new shaka.util.Error(
+      //   shaka.util.Error.Severity.CRITICAL,
+      //   shaka.util.Error.Category.NETWORK,
+      //   'RECOGNIZABLE_ERROR_MESSAGE'
+      // );
+    }
+  }
+};
+
+nwEngine.addEventListener('retry', vodManifestNotFoundHandler);
+
+player.addEventListener('load'() => {
+  nwEngine.removeEventListener('retry', vodManifestNotFoundHandler);
+});
+
+```

package/docs/tutorials/fairplay.md

@@ -53,12 +53,12 @@ you.
 const req = await fetch('https://example.com/cert.der');
 const cert = await req.arrayBuffer();
 
-player.configure('drm.advanced.com\\.apple\\.fps\\.serverCertificate',
+player.configure('drm.advanced.com\\.apple\\.fps.serverCertificate',
                  new Uint8Array(cert));
 ```
 
 ```js
-player.configure('drm.advanced.com\\.apple\\.fps\\.serverCertificateUri',
+player.configure('drm.advanced.com\\.apple\\.fps.serverCertificateUri',
                  'https://example.com/cert.der');
 ```
 
@@ -72,13 +72,13 @@ is used by the browser to generate the license request.  If you don't use the
 default content ID derivation, you need to specify a custom init data transform:
 
 ```js
-player.configure('drm.initDataTransform', (initData, initDataType) => {
+player.configure('drm.initDataTransform', (initData, initDataType, drmInfo) => {
   if (initDataType != 'skd')
     return initData;
   // 'initData' is a buffer containing an 'skd://' URL as a UTF-8 string.
   const skdUri = shaka.util.StringUtils.fromBytesAutoDetect(initData);
   const contentId = getMyContentId(skdUri);
-  const cert = player.drmInfo().serverCertificate;
+  const cert = drmInfo.serverCertificate;
   return shaka.util.FairPlayUtils.initDataTransform(initData, contentId, cert);
 });
 ```

package/docs/tutorials/index.json

@@ -9,6 +9,7 @@
   { "license-wrapping": { "title": "License Wrapping" } },
   { "ui": { "title": "UI Library" } },
   { "ui-customization": { "title": "Configuring the UI" } },
+  { "errors": { "title": "Error Handling" } },
   { "a11y": { "title": "Creating accessible buttons" } },
   { "ad_monetization": { "title": "Serving ads with our IMA SDK integration" } },
   { "plugins": { "title": "Plugins and Customizing the Build" } },
@@ -16,6 +17,7 @@
   { "architecture": { "title": "Architecture Diagrams" } },
   { "service-worker": { "title": "Service Worker Caching" } },
   { "offline": { "title": "Offline Storage and Playback" } },
+  { "widevine-service-certs": { "title": "Widevine Service Certificates" } },
   { "fairplay": { "title": "FairPlay support" } },
   { "application-level-redirects": { "title": "Application-Level Redirects" } },
   { "blob-url": { "title": "Blob URL" } },

package/docs/tutorials/license-server-auth.md

@@ -246,8 +246,3 @@ License request can now continue.
 
 If you need them, you can also create asynchronous response filters in the same
 way.
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial license-wrapping}.

package/docs/tutorials/license-wrapping.md

@@ -166,8 +166,3 @@ using a request filter:
 
 Load the page again, and the license response will be accepted by the Widevine
 CDM.  Open the JavaScript console to see what the server sent back.
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial ui}.

package/docs/tutorials/network-and-buffering-config.md

@@ -117,8 +117,3 @@ URLs in your manifests always use `https:`, or by having it not include the
 scheme (e.g., `//example.com/file.mp4`).
 
 [CORS]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial drm-config}.

package/docs/tutorials/ui-customization.md

@@ -265,8 +265,3 @@ PR contributions to [the gallery repo][] are welcome.
 [@lucksy]: https://github.com/lucksy
 [pre-packaged Shaka UI themes]: https://lucksy.github.io/shaka-player-themes/
 [the gallery repo]: https://github.com/lucksy/shaka-player-themes
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial a11y} to make your custom buttons accessible to screen readers.

package/docs/tutorials/ui.md

@@ -227,10 +227,3 @@ ui.configure({
   'castAndroidReceiverCompatible': true,
 });
 ```
-
-
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial ui-customization}.

package/docs/tutorials/welcome.md

@@ -106,8 +106,3 @@ To subscribe to new releases on GitHub, you can follow
 To receive infrequent announcements and surveys from us, you can join our
 [mailing list](https://groups.google.com/forum/#!forum/shaka-player-users).
 The list is very low volume, and can only be written to by us.
-
-
-#### Continue the Tutorials
-
-Next, check out {@tutorial basic-usage}.

package/docs/tutorials/widevine-service-certs.md

@@ -0,0 +1,45 @@
+# Widevine Service Certificates
+
+With Widevine, you can eliminate one round-trip to your license server or proxy
+per session by preloading a Widevine service certificate. You can either provide
+it directly or set a URI and let Shaka fetch it for you. Do this before calling
+`player.load()`. The values will persist across multiple calls to `load()` on
+the same `shaka.Player` instance.
+
+```js
+// This is an example of loading the certificate from your site at runtime.
+// You could also choose to bundle it into your JavaScript as a Uint8Array.
+const req = await fetch('https://example.com/service.cert');
+const cert = new Uint8Array(await req.arrayBuffer());
+
+// This is the short form for configuration of a certificate:
+player.configure('drm.advanced.com\\.widevine\\.alpha.serverCertificate',
+                 cert);
+
+// This is the long form:
+player.configure({
+  drm: {
+    advanced: {
+      'com.widevine.alpha': {
+        'serverCertificate': cert,
+      },
+    },
+  },
+});
+
+
+// This is the short form for configuration of a certificate URI:
+player.configure('drm.advanced.com\\.widevine\\.alpha.serverCertificateUri',
+                 'https://example.com/service.cert');
+
+// This is the long form:
+player.configure({
+  drm: {
+    advanced: {
+      'com.widevine.alpha': {
+        'serverCertificateUri': 'https://example.com/service.cert',
+      },
+    },
+  },
+});
+```

package/externs/ima.js

@@ -513,6 +513,15 @@ google.ima.dai.api.StreamRequest.prototype.streamActivityMonitorId;
 google.ima.dai.api.StreamRequest.prototype.format;
 
 
+/**
+ * @enum {string}
+ */
+google.ima.dai.api.StreamRequest.StreamFormat = {
+  DASH: 'dash',
+  HLS: 'hls',
+};
+
+
 /** @const */
 google.ima.dai.api.VODStreamRequest =
     class extends google.ima.dai.api.StreamRequest {};

package/externs/network_information.js

@@ -19,5 +19,10 @@ NetworkInformation.prototype.saveData;
  * @param {string} type
  * @param {Function} listener
  */
-NetworkInformation.prototype.addEventListener =
-    function(type, listener) {};
+NetworkInformation.prototype.addEventListener = function(type, listener) {};
+
+/**
+ * @param {string} type
+ * @param {Function} listener
+ */
+NetworkInformation.prototype.removeEventListener = function(type, listener) {};

package/externs/shaka/abr_manager.js

@@ -44,6 +44,12 @@ shaka.extern.AbrManager = class {
    */
   stop() {}
 
+  /**
+   * Request that this object release all internal references.
+   * @exportDoc
+   */
+  release() {}
+
   /**
    * Updates manager's variants collection.
    *

package/externs/shaka/net.js

@@ -112,6 +112,7 @@ shaka.extern.Request;
 /**
  * @typedef {{
  *   uri: string,
+ *   originalUri: string,
  *   data: BufferSource,
  *   status: (number|undefined),
  *   headers: !Object.<string, string>,

package/externs/shaka/player.js

@@ -688,9 +688,7 @@ shaka.extern.AdvancedDrmConfiguration;
  *   clearKeys: !Object.<string, string>,
  *   delayLicenseRequestUntilPlayed: boolean,
  *   advanced: Object.<string, shaka.extern.AdvancedDrmConfiguration>,
- *   initDataTransform:
- *       ((function(!Uint8Array, string, ?shaka.extern.DrmInfo):!Uint8Array)|
- *         undefined),
+ *   initDataTransform:(shaka.extern.InitDataTransform|undefined),
  *   logLicenseExchange: boolean,
  *   updateExpirationTime: number,
  *   preferredKeySystems: !Array.<string>,
@@ -716,10 +714,7 @@ shaka.extern.AdvancedDrmConfiguration;
  *   <i>Optional.</i> <br>
  *   A dictionary which maps key system IDs to advanced DRM configuration for
  *   those key systems.
- * @property
- *     {((function(!Uint8Array, string, ?shaka.extern.DrmInfo):!Uint8Array)|
- *        undefined)}
- *   initDataTransform
+ * @property {shaka.extern.InitDataTransform|undefined} initDataTransform
  *   <i>Optional.</i><br>
  *   If given, this function is called with the init data from the
  *   manifest/media and should return the (possibly transformed) init data to
@@ -748,6 +743,17 @@ shaka.extern.AdvancedDrmConfiguration;
  */
 shaka.extern.DrmConfiguration;
 
+/**
+ * @typedef {function(!Uint8Array, string, ?shaka.extern.DrmInfo):!Uint8Array}
+ *
+ * @description
+ * A callback function to handle custom content ID signaling for FairPlay
+ * content.
+ *
+ * @exportDoc
+ */
+shaka.extern.InitDataTransform;
+
 
 /**
  * @typedef {{

package/lib/abr/simple_abr_manager.js

@@ -6,6 +6,7 @@
 
 goog.provide('shaka.abr.SimpleAbrManager');
 
+goog.require('shaka.util.IReleasable');
 goog.require('goog.asserts');
 goog.require('shaka.abr.EwmaBandwidthEstimator');
 goog.require('shaka.log');
@@ -32,6 +33,7 @@ goog.require('shaka.util.Timer');
  * </p>
  *
  * @implements {shaka.extern.AbrManager}
+ * @implements {shaka.util.IReleasable}
  * @export
  */
 shaka.abr.SimpleAbrManager = class {
@@ -50,8 +52,8 @@ shaka.abr.SimpleAbrManager = class {
     // retrieving information about a user's network connection. We listen
     // to the change event to be able to make quick changes in case the type
     // of connectivity changes.
-    if (navigator.connection) {
-      navigator.connection.addEventListener('change', () => {
+    if (navigator.connection && navigator.connection.addEventListener) {
+      this.onNetworkInformationChange_ = () => {
         if (this.config_.useNetworkInformation && this.enabled_) {
           this.bandwidthEstimator_ = new shaka.abr.EwmaBandwidthEstimator();
           if (this.config_) {
@@ -62,7 +64,10 @@ shaka.abr.SimpleAbrManager = class {
             this.switch_(chosenVariant);
           }
         }
-      });
+      };
+
+      navigator.connection.addEventListener(
+          'change', this.onNetworkInformationChange_);
     }
 
     /**
@@ -93,6 +98,9 @@ shaka.abr.SimpleAbrManager = class {
     /** @private {ResizeObserver} */
     this.resizeObserver_ = null;
 
+    /** @private {?function():void} */
+    this.onNetworkInformationChange_ = null;
+
     /** @private {shaka.util.Timer} */
     this.resizeObserverTimer_ = new shaka.util.Timer(() => {
       if (this.config_.restrictToElementSize) {
@@ -128,6 +136,22 @@ shaka.abr.SimpleAbrManager = class {
     // can start using bandwidth estimates right away after init() is called.
   }
 
+  /**
+   * @override
+   * @export
+   */
+  release() {
+    // stop() should already have been called for unload
+
+    if (navigator.connection && navigator.connection.removeEventListener) {
+      navigator.connection.removeEventListener(
+          'change', this.onNetworkInformationChange_);
+      this.onNetworkInformationChange_ = null;
+    }
+
+    this.resizeObserverTimer_ = null;
+  }
+
 
   /**
    * @override

package/lib/ads/client_side_ad_manager.js

@@ -79,9 +79,9 @@ shaka.ads.ClientSideAdManager = class {
         });
 
     // Notify the SDK when the video has ended, so it can play post-roll ads.
-    this.video_.onended = () => {
+    this.eventManager_.listen(this.video_, 'ended', () => {
       this.adsLoader_.contentComplete();
-    };
+    });
   }
 
   /**
@@ -219,9 +219,9 @@ shaka.ads.ClientSideAdManager = class {
       // seen the ads actually play until requestAds() is called.
       // Note: We listen for a play event to avoid autoplay issues that might
       // crash IMA.
-      this.video_.addEventListener('play', () => {
+      this.eventManager_.listenOnce(this.video_, 'play', () => {
         this.imaAdsManager_.start();
-      }, {once: true});
+      });
     } catch (adError) {
       // If there was a problem with the VAST response,
       // we we won't be getting an ad. Hide ad UI if we showed it already
@@ -440,6 +440,10 @@ shaka.ads.ClientSideAdManager = class {
     if (this.ad_.isLinear()) {
       this.adContainer_.setAttribute('ad-active', 'true');
       this.video_.pause();
+      this.ad_.setVolume(this.video_.volume);
+      if (this.video_.muted) {
+        this.ad_.setMuted(true);
+      }
     }
   }
 
@@ -452,7 +456,9 @@ shaka.ads.ClientSideAdManager = class {
         (new Map()).set('originalEvent', e)));
     if (this.ad_ && this.ad_.isLinear()) {
       this.adContainer_.removeAttribute('ad-active');
-      this.video_.play();
+      if (!this.video_.ended) {
+        this.video_.play();
+      }
     }
   }
 };

package/lib/dash/dash_parser.js

@@ -1279,55 +1279,56 @@ shaka.dash.DashParser = class {
         context.period.id + ',' + context.representation.id : '';
 
     /** @type {shaka.extern.Stream} */
-    const stream = {
-      id: this.globalId_++,
-      originalId: context.representation.id,
-      createSegmentIndex: async () => {
-        // If we have a stream with the same context id stored in the map
-        // that has no segmentIndex, we should set the segmentIndex for it.
-        const storedInMap = contextId && context.dynamic &&
-              this.streamMap_[contextId];
-
-        const currentStream = storedInMap ? this.streamMap_[contextId] : stream;
-        if (!currentStream.segmentIndex) {
-          currentStream.segmentIndex = await streamInfo.generateSegmentIndex();
-        }
-      },
+    let stream;
 
-      closeSegmentIndex: () => {
-        if (stream.segmentIndex) {
-          stream.segmentIndex.release();
-          stream.segmentIndex = null;
-        }
-      },
-      segmentIndex: null,
-      mimeType: context.representation.mimeType,
-      codecs: context.representation.codecs,
-      frameRate: context.representation.frameRate,
-      pixelAspectRatio: context.representation.pixelAspectRatio,
-      bandwidth: context.bandwidth,
-      width: context.representation.width,
-      height: context.representation.height,
-      kind,
-      encrypted: contentProtection.drmInfos.length > 0,
-      drmInfos: contentProtection.drmInfos,
-      keyIds,
-      language,
-      label,
-      type: context.adaptationSet.contentType,
-      primary: isPrimary,
-      trickModeVideo: null,
-      emsgSchemeIdUris:
-          context.representation.emsgSchemeIdUris,
-      roles,
-      forced: forced,
-      channelsCount: context.representation.numChannels,
-      audioSamplingRate: context.representation.audioSamplingRate,
-      spatialAudio: spatialAudio,
-      closedCaptions,
-      hdr,
-      tilesLayout,
-      matchedStreams: [],
+    if (contextId && this.streamMap_[contextId]) {
+      stream = this.streamMap_[contextId];
+    } else {
+      stream = {
+        id: this.globalId_++,
+        originalId: context.representation.id,
+        createSegmentIndex: () => Promise.resolve(),
+        closeSegmentIndex: () => {
+          if (stream.segmentIndex) {
+            stream.segmentIndex.release();
+            stream.segmentIndex = null;
+          }
+        },
+        segmentIndex: null,
+        mimeType: context.representation.mimeType,
+        codecs: context.representation.codecs,
+        frameRate: context.representation.frameRate,
+        pixelAspectRatio: context.representation.pixelAspectRatio,
+        bandwidth: context.bandwidth,
+        width: context.representation.width,
+        height: context.representation.height,
+        kind,
+        encrypted: contentProtection.drmInfos.length > 0,
+        drmInfos: contentProtection.drmInfos,
+        keyIds,
+        language,
+        label,
+        type: context.adaptationSet.contentType,
+        primary: isPrimary,
+        trickModeVideo: null,
+        emsgSchemeIdUris:
+            context.representation.emsgSchemeIdUris,
+        roles,
+        forced,
+        channelsCount: context.representation.numChannels,
+        audioSamplingRate: context.representation.audioSamplingRate,
+        spatialAudio,
+        closedCaptions,
+        hdr,
+        tilesLayout,
+        matchedStreams: [],
+      };
+    }
+
+    stream.createSegmentIndex = async () => {
+      if (!stream.segmentIndex) {
+        stream.segmentIndex = await streamInfo.generateSegmentIndex();
+      }
     };
 
     if (contextId && context.dynamic && !this.streamMap_[contextId]) {

package/lib/debug/log.js

@@ -134,23 +134,19 @@ shaka.log.MAX_LOG_LEVEL = 3;
 shaka.log.oneTimeWarningIssued_ = new Set();
 
 
-// IE8 has no console unless it is opened in advance.
-// IE9 console methods are not Functions and have no bind.
-if (window.console && window.console.log.bind) {
+if (window.console) {
   /** @private {!Object.<shaka.log.Level, function(...*)>} */
   shaka.log.logMap_ = {
-    /* eslint-disable no-restricted-syntax */
-    [shaka.log.Level.ERROR]: console.error.bind(console),
-    [shaka.log.Level.WARNING]: console.warn.bind(console),
-    [shaka.log.Level.INFO]: console.info.bind(console),
-    [shaka.log.Level.DEBUG]: console.log.bind(console),
-    [shaka.log.Level.V1]: console.debug.bind(console),
-    [shaka.log.Level.V2]: console.debug.bind(console),
-    /* eslint-enable no-restricted-syntax */
+    [shaka.log.Level.ERROR]: (...args) => console.error(...args),
+    [shaka.log.Level.WARNING]: (...args) => console.warn(...args),
+    [shaka.log.Level.INFO]: (...args) => console.info(...args),
+    [shaka.log.Level.DEBUG]: (...args) => console.log(...args),
+    [shaka.log.Level.V1]: (...args) => console.debug(...args),
+    [shaka.log.Level.V2]: (...args) => console.debug(...args),
   };
 
-  shaka.log.alwaysWarn = shaka.log.logMap_[shaka.log.Level.WARNING];
-  shaka.log.alwaysError = shaka.log.logMap_[shaka.log.Level.ERROR];
+  shaka.log.alwaysWarn = (...args) => console.warn(...args);
+  shaka.log.alwaysError = (...args) => console.error(...args);
 
   if (goog.DEBUG) {
     // Since we don't want to export shaka.log in production builds, we don't