shaka-player 3.2.19 → 3.2.20

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/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" } },
   { "selenium-grid-config": { "title": "Selenium Grid Config" } },

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

@@ -498,6 +498,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/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();
-    };
+    });
   }
 
   /**
@@ -401,6 +401,7 @@ shaka.ads.ClientSideAdManager = class {
         shaka.ads.AdManager.AD_STARTED, data));
     this.adContainer_.setAttribute('ad-active', 'true');
     this.video_.pause();
+    this.ad_.setVolume(this.video_.muted ? 0 : this.video_.volume);
   }
 
   /**
@@ -411,6 +412,8 @@ shaka.ads.ClientSideAdManager = class {
     this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED,
         (new Map()).set('originalEvent', e)));
     this.adContainer_.removeAttribute('ad-active');
-    this.video_.play();
+    if (!this.video_.ended) {
+      this.video_.play();
+    }
   }
 };

package/lib/hls/hls_parser.js

@@ -2925,6 +2925,7 @@ shaka.hls.HlsParser.AUDIO_EXTENSIONS_TO_MIME_TYPES_ = {
   'cmfa': 'audio/mp4',
   // MPEG2-TS also uses video/ for audio: https://bit.ly/TsMse
   'ts': 'video/mp2t',
+  'tsa': 'video/mp2t',
 
   // Raw formats:
   'aac': 'audio/aac',
@@ -2962,6 +2963,7 @@ shaka.hls.HlsParser.VIDEO_EXTENSIONS_TO_MIME_TYPES_ = {
   'm4f': 'video/mp4',
   'cmfv': 'video/mp4',
   'ts': 'video/mp2t',
+  'tsv': 'video/mp2t',
 };
 
 

package/lib/media/transmuxer.js

@@ -29,9 +29,7 @@ shaka.media.Transmuxer = class {
     this.muxjs_ = shaka.dependencies.muxjs();
 
     /** @private {muxjs.mp4.Transmuxer} */
-    this.muxTransmuxer_ = new this.muxjs_.mp4.Transmuxer({
-      'keepOriginalTimestamps': true,
-    });
+    this.muxTransmuxer_ = null;
 
     /** @private {shaka.util.PublicPromise} */
     this.transmuxPromise_ = null;
@@ -48,16 +46,22 @@ shaka.media.Transmuxer = class {
     /** @private {boolean} */
     this.isTransmuxing_ = false;
 
-    this.muxTransmuxer_.on('data', (segment) => this.onTransmuxed_(segment));
-
-    this.muxTransmuxer_.on('done', () => this.onTransmuxDone_());
+    if (this.muxjs_) {
+      this.muxTransmuxer_ = new this.muxjs_.mp4.Transmuxer({
+        'keepOriginalTimestamps': true,
+      });
+      this.muxTransmuxer_.on('data', (segment) => this.onTransmuxed_(segment));
+      this.muxTransmuxer_.on('done', () => this.onTransmuxDone_());
+    }
   }
 
   /**
    * @override
    */
   destroy() {
-    this.muxTransmuxer_.dispose();
+    if (this.muxTransmuxer_) {
+      this.muxTransmuxer_.dispose();
+    }
     this.muxTransmuxer_ = null;
     return Promise.resolve();
   }
@@ -156,6 +160,8 @@ shaka.media.Transmuxer = class {
    *                     metadata: !Array.<!Object>}>}
    */
   transmux(data) {
+    goog.asserts.assert(this.muxTransmuxer_,
+        'mux.js should be available.');
     goog.asserts.assert(!this.isTransmuxing_,
         'No transmuxing should be in progress.');
     this.isTransmuxing_ = true;

package/lib/media/video_wrapper.js

@@ -135,15 +135,15 @@ shaka.media.VideoWrapper = class {
     // calling |Player.load|, meaning that |currentTime| is more meaningful than
     // |startTime|.
     //
-    // Seeking to the current time is a work around for Issue 1298. If we don't
-    // do this, the video may get stuck and not play.
+    // Seeking to the current time is a work around for Issue 1298 and 4888.
+    // If we don't do this, the video may get stuck and not play.
     //
     // TODO: Need further investigation why it happens. Before and after
     // setting the current time, video.readyState is 1, video.paused is true,
     // and video.buffered's TimeRanges length is 0.
     // See: https://github.com/shaka-project/shaka-player/issues/1298
     this.mover_.moveTo(
-        this.video_.currentTime == 0 ?
+        (!this.video_.currentTime || this.video_.currentTime == 0) ?
         startTime :
         this.video_.currentTime);
   }

package/lib/offline/indexeddb/storage_mechanism.js

@@ -67,7 +67,7 @@ shaka.offline.indexeddb.StorageMechanism = class {
           shaka.util.Error.Category.STORAGE,
           shaka.util.Error.Code.INDEXED_DB_INIT_TIMED_OUT));
     });
-    timeOutTimer.tickAfter(2);
+    timeOutTimer.tickAfter(5);
 
     const open = window.indexedDB.open(name, version);
     open.onsuccess = (event) => {

package/lib/player.js

@@ -2297,6 +2297,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
               // goes wrong.
               new shaka.util.Timer(resolve).tickAfter(1);
             });
+          } else if (textTracks.length > 0) {
+            this.isTextVisible_ = true;
           }
 
           // If we have moved on to another piece of content while waiting for
@@ -6459,7 +6461,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v3.2.19-uncompiled';
+shaka.Player.version = 'v3.2.20-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/polyfill/media_capabilities.js

@@ -8,7 +8,6 @@ goog.provide('shaka.polyfill.MediaCapabilities');
 
 goog.require('shaka.log');
 goog.require('shaka.polyfill');
-goog.require('shaka.util.Error');
 goog.require('shaka.util.Platform');
 
 
@@ -212,13 +211,8 @@ shaka.polyfill.MediaCapabilities = class {
    * @private
    */
   static canCastDisplayType_(videoConfig) {
-    if (!(window.cast)) {
-      shaka.log.error('Expected cast namespace to be available!');
-      throw new shaka.util.Error(
-          shaka.util.Error.Severity.CRITICAL,
-          shaka.util.Error.Category.CAST,
-          shaka.util.Error.Code.CAST_API_UNAVAILABLE);
-    } else if (!(cast.__platform__ && cast.__platform__.canDisplayType)) {
+    if (!(window.cast &&
+        cast.__platform__ && cast.__platform__.canDisplayType)) {
       shaka.log.warning('Expected cast APIs to be available! Falling back to ' +
           'MediaSource.isTypeSupported() for type support.');
       return MediaSource.isTypeSupported(videoConfig.contentType);

package/lib/polyfill/mediasource.js

@@ -58,14 +58,19 @@ shaka.polyfill.MediaSource = class {
         // Offsetting the end of the removal range seems to help.
         // Bug filed: https://bugs.webkit.org/show_bug.cgi?id=177884
         shaka.polyfill.MediaSource.patchRemovalRange_();
-      } else {
-        shaka.log.info('Patching Safari 13 MSE bugs.');
+      } else if (safariVersion <= 15) {
+        shaka.log.info('Patching Safari 13 & 14 & 15 MSE bugs.');
         // Safari 13 does not correctly implement abort() on SourceBuffer.
         // Calling abort() before appending a segment causes that segment to be
         // incomplete in the buffer.
         // Bug filed: https://bugs.webkit.org/show_bug.cgi?id=165342
         shaka.polyfill.MediaSource.stubAbort_();
       }
+    } else if (shaka.util.Platform.isEdge()) {
+      shaka.log.info('Rejecting TS container.');
+      // TS content is broken on Edge in general.
+      // See https://github.com/shaka-project/shaka-player/issues/4955
+      shaka.polyfill.MediaSource.rejectTsContent_();
     } else if (shaka.util.Platform.isTizen2() ||
         shaka.util.Platform.isTizen3() ||
         shaka.util.Platform.isTizen4()) {

package/lib/text/ui_text_displayer.js

@@ -480,6 +480,7 @@ shaka.text.UITextDisplayer = class {
       wrapper = shaka.util.Dom.createHTMLElement('span');
       wrapper.classList.add('shaka-text-wrapper');
       wrapper.style.backgroundColor = cue.backgroundColor;
+      wrapper.style.lineHeight = 'normal';
       cueElement.appendChild(wrapper);
     }
 

package/lib/text/vtt_text_parser.js

@@ -369,8 +369,7 @@ shaka.text.VttTextParser = class {
     end += timeOffset;
 
     // Get the payload.
-    const payload = VttTextParser.htmlUnescape_(
-        text.slice(1).join('\n').trim());
+    const payload = text.slice(1).join('\n').trim();
 
     let cue = null;
     if (styles.has('global')) {
@@ -427,7 +426,7 @@ shaka.text.VttTextParser = class {
         const childNode = childNodes[0];
         if (childNode.nodeType == Node.TEXT_NODE ||
             childNode.nodeType == Node.CDATA_SECTION_NODE) {
-          rootCue.payload = payload;
+          rootCue.payload = VttTextParser.htmlUnescape_(payload);
           return;
         }
       }
@@ -438,7 +437,7 @@ shaka.text.VttTextParser = class {
       rootCue.nestedCues = cues;
     } else {
       shaka.log.warning('The cue\'s markup could not be parsed: ', payload);
-      rootCue.payload = payload;
+      rootCue.payload = VttTextParser.htmlUnescape_(payload);
     }
   }
 
@@ -682,7 +681,7 @@ shaka.text.VttTextParser = class {
         }
         if (text.length > 0) {
           const textCue = nestedCue.clone();
-          textCue.payload = text;
+          textCue.payload = VttTextParser.htmlUnescape_(text);
           cues.push(textCue);
         }
         isFirst = false;

package/lib/util/mime_utils.js

@@ -50,7 +50,7 @@ shaka.util.MimeUtils = class {
         return shaka.media.Transmuxer.convertTsCodecs(
             contentType, fullMimeType);
       }
-    } else if (contentType == ContentType.AUDIO) {
+    } else if (mimeType != 'video/mp2t' && contentType == ContentType.AUDIO) {
       // video/mp2t is the correct mime type for TS audio, so only replace the
       // word "video" with "audio" for non-TS audio content.
       return fullMimeType.replace('video', 'audio');

package/lib/util/stream_utils.js

@@ -703,26 +703,38 @@ shaka.util.StreamUtils = class {
         }
 
         if (audio) {
-          if (!keySystemConfig.audio) {
+          // See: https://github.com/shaka-project/shaka-player/issues/4659
+          if (info.audioRobustness != '') {
+            if (!keySystemConfig.audio) {
+              // KeySystemTrackConfiguration
+              keySystemConfig.audio = {
+                robustness: info.audioRobustness,
+              };
+            } else {
+              keySystemConfig.audio.robustness =
+                  keySystemConfig.audio.robustness || info.audioRobustness;
+            }
+          } else if (!keySystemConfig.audio) {
             // KeySystemTrackConfiguration
-            keySystemConfig.audio = {
-              robustness: info.audioRobustness,
-            };
-          } else {
-            keySystemConfig.audio.robustness =
-                keySystemConfig.audio.robustness || info.audioRobustness;
+            keySystemConfig.audio = {};
           }
         }
 
         if (video) {
-          if (!keySystemConfig.video) {
+          // See: https://github.com/shaka-project/shaka-player/issues/4659
+          if (info.videoRobustness != '') {
+            if (!keySystemConfig.video) {
+              // KeySystemTrackConfiguration
+              keySystemConfig.video = {
+                robustness: info.videoRobustness,
+              };
+            } else {
+              keySystemConfig.video.robustness =
+                  keySystemConfig.video.robustness || info.videoRobustness;
+            }
+          } else if (!keySystemConfig.video) {
             // KeySystemTrackConfiguration
-            keySystemConfig.video = {
-              robustness: info.videoRobustness,
-            };
-          } else {
-            keySystemConfig.video.robustness =
-                keySystemConfig.video.robustness || info.videoRobustness;
+            keySystemConfig.video = {};
           }
         }
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.2.19",
+  "version": "3.2.20",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [

package/test/polyfill/media_capabilities_unit.js

@@ -5,7 +5,6 @@
  */
 
 describe('MediaCapabilities', () => {
-  const Util = shaka.test.Util;
   const originalCast = window['cast'];
   const originalVendor = navigator.vendor;
   const originalUserAgent = navigator.userAgent;
@@ -168,30 +167,29 @@ describe('MediaCapabilities', () => {
           expect(result.keySystemAccess).toEqual(mockResult);
         });
 
-    it('throws when the cast namespace is not available', async () => {
-      // Temporarily remove window.cast to trigger error. It's restored after
-      // every test.
-      delete window['cast'];
+    it('falls back to isTypeSupported() when cast namespace is not available',
+        async () => {
+          // Temporarily remove window.cast to trigger error. It's restored
+          // after every test.
+          delete window['cast'];
 
-      const isChromecastSpy =
-          spyOn(shaka['util']['Platform'],
-              'isChromecast').and.returnValue(true);
-      const expected = Util.jasmineError(new shaka.util.Error(
-          shaka.util.Error.Severity.CRITICAL,
-          shaka.util.Error.Category.CAST,
-          shaka.util.Error.Code.CAST_API_UNAVAILABLE));
-      const isTypeSupportedSpy =
-          spyOn(window['MediaSource'], 'isTypeSupported').and.returnValue(true);
+          const isChromecastSpy =
+              spyOn(shaka['util']['Platform'],
+                  'isChromecast').and.returnValue(true);
+          const isTypeSupportedSpy =
+              spyOn(window['MediaSource'], 'isTypeSupported')
+                  .and.returnValue(true);
 
-      shaka.polyfill.MediaCapabilities.install();
-      await expectAsync(
-          navigator.mediaCapabilities.decodingInfo(mockDecodingConfig))
-          .toBeRejectedWith(expected);
+          shaka.polyfill.MediaCapabilities.install();
+          await navigator.mediaCapabilities.decodingInfo(mockDecodingConfig);
 
-      expect(isTypeSupportedSpy).not.toHaveBeenCalled();
-      // 1 (during install()) + 1 (for video config check).
-      expect(isChromecastSpy).toHaveBeenCalledTimes(2);
-    });
+          expect(mockCanDisplayType).not.toHaveBeenCalled();
+          // 1 (during install()) + 1 (for video config check).
+          expect(isChromecastSpy).toHaveBeenCalledTimes(2);
+          // 1 (fallback in canCastDisplayType()) +
+          // 1 (mockDecodingConfig.audio).
+          expect(isTypeSupportedSpy).toHaveBeenCalledTimes(2);
+        });
 
     it('falls back to isTypeSupported() when canDisplayType() missing',
         async () => {

package/test/text/vtt_text_parser_unit.js

@@ -776,11 +776,35 @@ describe('VttTextParser', () => {
   it('support escaped html payload', () => {
     verifyHelper(
         [
-          {startTime: 20.1, endTime: 40.505, payload: '"Test & 1"\u{a0}'},
+          {
+            startTime: 20.1,
+            endTime: 40.505,
+            payload: '"Test & 1"\u{a0}',
+          },
+          {
+            startTime: 41,
+            endTime: 42,
+            payload: '',
+            nestedCues: [
+              {
+                startTime: 41,
+                endTime: 42,
+                payload: 'Test',
+                fontStyle: Cue.fontStyle.ITALIC,
+              },
+              {
+                startTime: 41,
+                endTime: 42,
+                payload: '&',
+              },
+            ],
+          },
         ],
         'WEBVTT\n\n' +
         '00:00:20.100 --> 00:00:40.505\n' +
-        '"Test & 1" ',
+        '"Test & 1" \n\n' +
+        '00:00:41.000 --> 00:00:42.000\n' +
+        '<i>Test</i>&amp;',
         {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 

package/test/text/web_vtt_layout_integration.js

@@ -265,7 +265,6 @@ filterDescribe('WebVTT layout', shaka.test.TextLayoutTests.supported, () => {
       await helper.checkScreenshot('line-85-position-50-size-63');
     });
 
-    // FIXME: UI version is slightly wrong: gaps between lines when bold
     it('bold long', async () => {
       parseAndDisplay([
         'WEBVTT\n',
@@ -278,7 +277,6 @@ filterDescribe('WebVTT layout', shaka.test.TextLayoutTests.supported, () => {
       await helper.checkScreenshot('bold-long');
     });
 
-    // FIXME: UI version is slightly wrong: gaps between lines when italic
     it('italic long', async () => {
       parseAndDisplay([
         'WEBVTT\n',
@@ -291,7 +289,6 @@ filterDescribe('WebVTT layout', shaka.test.TextLayoutTests.supported, () => {
       await helper.checkScreenshot('italic-long');
     });
 
-    // FIXME: UI version is slightly wrong: gaps between lines when italic
     it('underline long', async () => {
       parseAndDisplay([
         'WEBVTT\n',