shaka-player 4.0.0 → 4.1.0

package/lib/text/cue.js

@@ -144,6 +144,12 @@ shaka.text.Cue = class {
      */
     this.border = '';
 
+    /**
+     * @override
+     * @exportInterface
+     */
+    this.textShadow = '';
+
     /**
      * @override
      * @exportInterface

package/lib/text/ui_text_displayer.js

@@ -411,6 +411,7 @@ shaka.text.UITextDisplayer = class {
     style.paddingRight =
         shaka.text.UITextDisplayer.convertLengthValue_(
             cue.linePadding, cue, this.videoContainer_);
+    style.textShadow = cue.textShadow;
 
     if (cue.backgroundImage) {
       style.backgroundImage = 'url(\'' + cue.backgroundImage + '\')';

package/lib/text/vtt_text_parser.js

@@ -68,13 +68,15 @@ shaka.text.VttTextParser = class {
     // to the beginning of each segment.
     // NOTE: "periodStart" is the timestamp offset applied via TextEngine.
     // It is no longer closely tied to periods, but the name stuck around.
+    // NOTE: This offset and the flag choosing its meaning have no effect on
+    // HLS content, which should use X-TIMESTAMP-MAP and periodStart instead.
     let offset = time.vttOffset;
 
-    // Do not honor the 'X-TIMESTAMP-MAP' value when in sequence mode.
-    // That is because it is used mainly (solely?) to account for the timestamp
-    // offset of the video/audio; when in sequence mode, we normalize that
-    // timestamp offset to 0, so we should not account for it.
-    if (blocks[0].includes('X-TIMESTAMP-MAP') && !this.sequenceMode_) {
+    // Only use 'X-TIMESTAMP-MAP' in sequence mode, as that is currently
+    // shorthand for HLS.  Note that an offset based on the first video
+    // timestamp has already been extracted, and appears in periodStart.
+    // The relative offset from X-TIMESTAMP-MAP will be added to that for HLS.
+    if (blocks[0].includes('X-TIMESTAMP-MAP') && this.sequenceMode_) {
       // https://bit.ly/2K92l7y
       // The 'X-TIMESTAMP-MAP' header is used in HLS to align text with
       // the rest of the media.
@@ -109,8 +111,6 @@ shaka.text.VttTextParser = class {
           mpegTime += shaka.text.VttTextParser.TS_ROLLOVER_;
         }
 
-        // Apple-encoded HLS content uses absolute timestamps, so assume the
-        // presence of the map tag means the content uses absolute timestamps.
         offset = time.periodStart + mpegTime / mpegTimescale - cueTime;
       }
     }
@@ -293,6 +293,10 @@ shaka.text.VttTextParser = class {
             validStyle = true;
             cue.opacity = parseFloat(value);
             break;
+          case 'text-shadow':
+            validStyle = true;
+            cue.textShadow = value;
+            break;
           case 'white-space':
             validStyle = true;
             cue.wrapLine = value != 'noWrap';

package/lib/util/config_utils.js

@@ -127,4 +127,29 @@ shaka.util.ConfigUtils = class {
     last[fieldName.substring(nameStart).replace(/\\\./g, '.')] = value;
     return configObject;
   }
+
+  /**
+   * Reference the input parameters so the compiler doesn't remove them from
+   * the calling function.  Return whatever value is specified.
+   *
+   * This allows an empty or default implementation of a config callback that
+   * still bears the complete function signature even in compiled mode.
+   *
+   * The caller should look something like this:
+   *
+   *   const callback = (a, b, c, d) => {
+   *     return referenceParametersAndReturn(
+             [a, b, c, d],
+             a);  // Can be anything, doesn't need to be one of the parameters
+   *   };
+   *
+   * @param {!Array.<?>} parameters
+   * @param {T} returnValue
+   * @return {T}
+   * @template T
+   * @noinline
+   */
+  static referenceParametersAndReturn(parameters, returnValue) {
+    return parameters && returnValue;
+  }
 };

package/lib/util/error.js

@@ -267,6 +267,12 @@ shaka.util.Error.Code = {
    */
   'ATTEMPTS_EXHAUSTED': 1010,
 
+  /**
+   * The segment is missing.
+   * <br> error.data[0] is the URI.
+   */
+  'SEGMENT_MISSING': 1011,
+
 
   /** The text parser failed to parse a text stream due to an invalid header. */
   'INVALID_TEXT_HEADER': 2000,
@@ -345,6 +351,13 @@ shaka.util.Error.Code = {
    */
   'MISSING_TEXT_PLUGIN': 2014,
 
+  /**
+   * The chapters track failed to load.  The browser does not provide any
+   * information in this case to identify why it failed, but there may be
+   * details in the JavaScript console.
+   */
+  'CHAPTERS_TRACK_FAILED': 2015,
+
   /**
    * Some component tried to read past the end of a buffer.  The segment index,
    * init segment, or PSSH may be malformed.

package/lib/util/fake_event.js

@@ -144,3 +144,42 @@ shaka.util.FakeEvent = class {
    */
   stopPropagation() {}
 };
+
+
+/**
+ * An internal enum that contains the string values of all of the player events.
+ * This exists primarily to act as an implicit list of events, for tests.
+ *
+ * @enum {string}
+ */
+shaka.util.FakeEvent.EventName = {
+  AbrStatusChanged: 'abrstatuschanged',
+  Adaptation: 'adaptation',
+  Buffering: 'buffering',
+  DownloadFailed: 'downloadfailed',
+  DownloadHeadersReceived: 'downloadheadersreceived',
+  DrmSessionUpdate: 'drmsessionupdate',
+  Emsg: 'emsg',
+  Error: 'error',
+  ExpirationUpdated: 'expirationupdated',
+  GapJumped: 'gapjumped',
+  Loaded: 'loaded',
+  Loading: 'loading',
+  ManifestParsed: 'manifestparsed',
+  MediaQualityChanged: 'mediaqualitychanged',
+  Metadata: 'metadata',
+  OnStateChange: 'onstatechange',
+  OnStateIdle: 'onstateidle',
+  RateChange: 'ratechange',
+  SessionDataEvent: 'sessiondata',
+  StallDetected: 'stalldetected',
+  Streaming: 'streaming',
+  TextChanged: 'textchanged',
+  TextTrackVisibility: 'texttrackvisibility',
+  TimelineRegionAdded: 'timelineregionadded',
+  TimelineRegionEnter: 'timelineregionenter',
+  TimelineRegionExit: 'timelineregionexit',
+  TracksChanged: 'trackschanged',
+  Unloading: 'unloading',
+  VariantChanged: 'variantchanged',
+};

package/lib/util/manifest_parser_utils.js

@@ -167,7 +167,7 @@ shaka.util.ManifestParserUtils.VIDEO_CODEC_REGEXPS_ = [
   /^hev/,
   /^hvc/,
   /^vp0?[89]/,
-  /^av1$/,
+  /^av01/,
 ];
 
 

package/lib/util/mime_utils.js

@@ -8,6 +8,7 @@ goog.provide('shaka.util.MimeUtils');
 
 goog.require('shaka.dependencies');
 goog.require('shaka.media.Transmuxer');
+goog.require('shaka.util.ManifestParserUtils');
 
 /**
  * @summary A set of utility functions for dealing with MIME types.
@@ -34,6 +35,8 @@ shaka.util.MimeUtils = class {
   /**
    * Takes a MIME type and a codecs string and produces the full MIME
    * type. If it's a transport stream, convert its codecs to MP4 codecs.
+   * Otherwise for multiplexed content, convert the video MIME types to
+   * their audio equivalents if the content type is audio.
    *
    * @param {string} mimeType
    * @param {string} codecs
@@ -42,13 +45,19 @@ shaka.util.MimeUtils = class {
    */
   static getFullOrConvertedType(mimeType, codecs, contentType) {
     const fullMimeType = shaka.util.MimeUtils.getFullType(mimeType, codecs);
+    const ContentType = shaka.util.ManifestParserUtils.ContentType;
 
-    if (!shaka.dependencies.muxjs() ||
-        !shaka.media.Transmuxer.isTsContainer(fullMimeType)) {
-      return fullMimeType;
+    if (shaka.media.Transmuxer.isTsContainer(fullMimeType)) {
+      if (shaka.dependencies.muxjs()) {
+        return shaka.media.Transmuxer.convertTsCodecs(
+            contentType, fullMimeType);
+      }
+    } else if (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');
     }
-
-    return shaka.media.Transmuxer.convertTsCodecs(contentType, fullMimeType);
+    return fullMimeType;
   }
 
 
@@ -96,6 +105,53 @@ shaka.util.MimeUtils = class {
     return codecs.split(',');
   }
 
+  /**
+   * Get the normalized codec from a codec string,
+   * independently of their container.
+   *
+   * @param {string} codecString
+   * @return {string}
+   */
+  static getNormalizedCodec(codecString) {
+    const parts =
+      shaka.util.MimeUtils.getCodecParts_(codecString);
+    const base = parts[0];
+    const profile = parts[1].toLowerCase();
+    switch (true) {
+      case base === 'mp4a' && profile === '69':
+      case base === 'mp4a' && profile === '6b':
+        return 'mp3';
+      case base === 'mp4a' && profile === '66':
+      case base === 'mp4a' && profile === '67':
+      case base === 'mp4a' && profile === '68':
+      case base === 'mp4a' && profile === '40.2':
+      case base === 'mp4a' && profile === '40.02':
+      case base === 'mp4a' && profile === '40.5':
+      case base === 'mp4a' && profile === '40.05':
+      case base === 'mp4a' && profile === '40.29':
+      case base === 'mp4a' && profile === '40.42': // Extended HE-AAC
+        return 'aac';
+      case base === 'mp4a' && profile === 'a5':
+        return 'ac-3'; // Dolby Digital
+      case base === 'mp4a' && profile === 'a6':
+        return 'ec-3'; // Dolby Digital Plus
+      case base === 'mp4a' && profile === 'b2':
+        return 'dtsx'; // DTS:X
+      case base === 'mp4a' && profile === 'a9':
+        return 'dtsc'; // DTS Digital Surround
+      case base === 'avc1':
+      case base === 'avc3':
+        return 'avc'; // H264
+      case base === 'hvc1':
+      case base === 'hev1':
+        return 'hevc'; // H265
+      case base === 'dvh1':
+      case base === 'dvhe':
+        return 'dovi'; // Dolby Vision
+    }
+    return base;
+  }
+
   /**
    * Get the base codec from a codec string.
    *
@@ -152,7 +208,7 @@ shaka.util.MimeUtils = class {
 
     const base = parts[0];
 
-    parts.pop();
+    parts.shift();
     const profile = parts.join('.');
 
     // Make sure that we always return a "base" and "profile".

package/lib/util/periods.js

@@ -573,8 +573,8 @@ shaka.util.PeriodCombiner = class {
         // TODO(#1528): Consider changing this when we support codec switching.
         const hasCodec = outputStreams.some((s) => {
           return s.mimeType == stream.mimeType &&
-                shaka.util.MimeUtils.getCodecBase(s.codecs) ==
-                    shaka.util.MimeUtils.getCodecBase(stream.codecs);
+                shaka.util.MimeUtils.getNormalizedCodec(s.codecs) ==
+                    shaka.util.MimeUtils.getNormalizedCodec(stream.codecs);
         });
         if (!hasCodec) {
           continue;
@@ -1050,10 +1050,11 @@ shaka.util.PeriodCombiner = class {
    * @private
    */
   static areAVStreamsCompatible_(outputStream, candidate) {
-    const getCodecBase = (codecs) => shaka.util.MimeUtils.getCodecBase(codecs);
+    const getCodec = (codecs) =>
+      shaka.util.MimeUtils.getNormalizedCodec(codecs);
     // Check MIME type and codecs, which should always be the same.
     if (candidate.mimeType != outputStream.mimeType ||
-        getCodecBase(candidate.codecs) != getCodecBase(outputStream.codecs)) {
+        getCodec(candidate.codecs) != getCodec(outputStream.codecs)) {
       return false;
     }
 

package/lib/util/player_configuration.js

@@ -16,14 +16,6 @@ goog.require('shaka.util.ManifestParserUtils');
 goog.require('shaka.util.Platform');
 
 
-// TODO(vaage): Many times in our configs, we need to create an empty
-//  implementation of a method, but to avoid closure from removing unused
-//  parameters (and breaking our merge config code) we need to use each
-//  parameter. Is there a better solution to this problem than what we are
-//  doing now?
-//
-//  NOTE: Chrome App Content Security Policy prohibits usage of new Function()
-
 /**
  * @final
  * @export
@@ -74,9 +66,15 @@ shaka.util.PlayerConfiguration = class {
       clearKeys: {},  // key is arbitrary key system ID, value must be string
       advanced: {},    // key is arbitrary key system ID, value is a record type
       delayLicenseRequestUntilPlayed: false,
+      initDataTransform: (initData, initDataType, drmInfo) => {
+        return shaka.util.ConfigUtils.referenceParametersAndReturn(
+            [initData, initDataType, drmInfo],
+            initData);
+      },
       logLicenseExchange: false,
       updateExpirationTime: 1,
       preferredKeySystems: [],
+      keySystemsMapping: {},
     };
 
     const manifest = {
@@ -113,11 +111,10 @@ shaka.util.PlayerConfiguration = class {
           'urn:uuid:f239e769-efa3-4850-9c16-a903c6932efb':
             'com.adobe.primetime',
         },
-        // Need some operation in the callback or else closure may remove calls
-        // to the function as it would be a no-op.  The operation can't just be
-        // a log message, because those are stripped in the compiled build.
         manifestPreprocessor: (element) => {
-          return element;
+          return shaka.util.ConfigUtils.referenceParametersAndReturn(
+              [element],
+              element);
         },
       },
       hls: {
@@ -138,7 +135,9 @@ shaka.util.PlayerConfiguration = class {
       // log message, because those are stripped in the compiled build.
       failureCallback: (error) => {
         shaka.log.error('Unhandled streaming error', error);
-        return [error];
+        return shaka.util.ConfigUtils.referenceParametersAndReturn(
+            [error],
+            undefined);
       },
       // When low latency streaming is enabled, rebufferingGoal will default to
       // 0.01 if not specified.
@@ -171,6 +170,7 @@ shaka.util.PlayerConfiguration = class {
       updateIntervalSeconds: 1,
       dispatchAllEmsgBoxes: false,
       observeQualityChanges: false,
+      maxDisabledTime: 30,
     };
 
     // Some browsers will stop earlier than others before a gap (e.g., Edge
@@ -214,7 +214,9 @@ shaka.util.PlayerConfiguration = class {
       // to the function as it would be a no-op.  The operation can't just be a
       // log message, because those are stripped in the compiled build.
       progressCallback: (content, progress) => {
-        return [content, progress];
+        return shaka.util.ConfigUtils.referenceParametersAndReturn(
+            [content, progress],
+            undefined);
       },
 
       // By default we use persistent licenses as forces errors to surface if

package/lib/util/stats.js

@@ -31,6 +31,11 @@ shaka.util.Stats = class {
     /** @private {number} */
     this.totalCorruptedFrames_ = NaN;
 
+    /** @private {number} */
+    this.totalStallsDetected_ = NaN;
+    /** @private {number} */
+    this.totalGapsJumped_ = NaN;
+
     /** @private {number} */
     this.completionPercent_ = NaN;
 
@@ -76,7 +81,6 @@ shaka.util.Stats = class {
     this.totalDecodedFrames_ = decoded;
   }
 
-
   /**
    * Update corrupted frames. This will replace the previous values.
    *
@@ -86,6 +90,25 @@ shaka.util.Stats = class {
     this.totalCorruptedFrames_ = corrupted;
   }
 
+  /**
+   * Update number of stalls detected. This will replace the previous value.
+   *
+   * @param {number} stallsDetected
+   */
+  setStallsDetected(stallsDetected) {
+    this.totalStallsDetected_ = stallsDetected;
+  }
+
+  /**
+   * Update number of playback gaps jumped over. This will replace the previous
+   * value.
+   *
+   * @param {number} gapsJumped
+   */
+  setGapsJumped(gapsJumped) {
+    this.totalGapsJumped_ = gapsJumped;
+  }
+
   /**
    * Set the width and height of the video we are currently playing.
    *
@@ -208,6 +231,8 @@ shaka.util.Stats = class {
       decodedFrames: this.totalDecodedFrames_,
       droppedFrames: this.totalDroppedFrames_,
       corruptedFrames: this.totalCorruptedFrames_,
+      stallsDetected: this.totalStallsDetected_,
+      gapsJumped: this.totalGapsJumped_,
       estimatedBandwidth: this.bandwidthEstimate_,
       completionPercent: this.completionPercent_,
       loadLatency: this.loadLatencySeconds_,
@@ -238,6 +263,8 @@ shaka.util.Stats = class {
       decodedFrames: NaN,
       droppedFrames: NaN,
       corruptedFrames: NaN,
+      stallsDetected: NaN,
+      gapsJumped: NaN,
       estimatedBandwidth: NaN,
       completionPercent: NaN,
       loadLatency: NaN,

package/lib/util/stream_utils.js

@@ -283,12 +283,14 @@ shaka.util.StreamUtils = class {
     // both be considered the same codec: avc1.42c01e, avc1.4d401f
     let baseVideoCodec = '';
     if (variant.video) {
-      baseVideoCodec = shaka.util.MimeUtils.getCodecBase(variant.video.codecs);
+      baseVideoCodec =
+        shaka.util.MimeUtils.getNormalizedCodec(variant.video.codecs);
     }
 
     let baseAudioCodec = '';
     if (variant.audio) {
-      baseAudioCodec = shaka.util.MimeUtils.getCodecBase(variant.audio.codecs);
+      baseAudioCodec =
+        shaka.util.MimeUtils.getNormalizedCodec(variant.audio.codecs);
     }
 
     return baseVideoCodec + '-' + baseAudioCodec;
@@ -327,6 +329,13 @@ shaka.util.StreamUtils = class {
 
     const video = variant.video;
 
+    if (variant.disabledUntilTime != 0) {
+      if (variant.disabledUntilTime > Date.now() / 1000) {
+        return false;
+      }
+      variant.disabledUntilTime = 0;
+    }
+
     // |video.width| and |video.height| can be undefined, which breaks
     // the math, so make sure they are there first.
     if (video && video.width && video.height) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [
@@ -50,7 +50,7 @@
     "less": "https://gitpkg.now.sh/joeyparrish/less.js/packages/less?28c63a43",
     "less-plugin-clean-css": "github:austingardner/less-plugin-clean-css#4e9e77bf",
     "material-design-lite": "^1.3.0",
-    "mux.js": "^5.14.1",
+    "mux.js": "^6.1.0",
     "open-sans-fonts": "^1.6.2",
     "postcss-less": "^6.0.0",
     "pwacompat": "^2.0.17",
@@ -97,5 +97,8 @@
   },
   "dependencies": {
     "eme-encryption-scheme-polyfill": "^2.0.3"
+  },
+  "engines": {
+    "node": ">=14"
   }
 }

package/test/cast/cast_proxy_unit.js

@@ -11,6 +11,7 @@ describe('CastProxy', () => {
 
   const originalCastSender = shaka.cast.CastSender;
   const fakeAppId = 'fake app ID';
+  const fakeAndroidReceiverCompatible = false;
 
   let mockPlayer;
   let mockSender;
@@ -31,7 +32,8 @@ describe('CastProxy', () => {
     mockPlayer = createMockPlayer();
     mockSender = null;
 
-    proxy = new CastProxy(mockVideo, mockPlayer, fakeAppId);
+    proxy = new CastProxy(mockVideo, mockPlayer, fakeAppId,
+        fakeAndroidReceiverCompatible);
   });
 
   afterEach(async () => {

package/test/cast/cast_sender_unit.js

@@ -13,6 +13,7 @@ describe('CastSender', () => {
   const originalStatusDelay = shaka.cast.CastSender.STATUS_DELAY;
 
   const fakeAppId = 'asdf';
+  const fakeAndroidReceiverCompatible = false;
   const fakeInitState = {
     manifest: null,
     player: null,
@@ -52,7 +53,8 @@ describe('CastSender', () => {
     sender = new CastSender(
         fakeAppId, Util.spyFunc(onStatusChanged),
         Util.spyFunc(onFirstCastStateUpdate), Util.spyFunc(onRemoteEvent),
-        Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired));
+        Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired),
+        fakeAndroidReceiverCompatible);
   });
 
   afterEach(async () => {
@@ -87,7 +89,12 @@ describe('CastSender', () => {
       expect(sender.apiReady()).toBe(true);
       expect(sender.hasReceivers()).toBe(false);
       expect(onStatusChanged).toHaveBeenCalled();
-      expect(mockCastApi.SessionRequest).toHaveBeenCalledWith(fakeAppId);
+      expect(mockCastApi.SessionRequest).toHaveBeenCalledWith(
+          fakeAppId,
+          /* capabilities= */ [],
+          /* timeout= */ null,
+          fakeAndroidReceiverCompatible,
+          /* credentialsData= */ null);
       expect(mockCastApi.initialize).toHaveBeenCalled();
     });
 
@@ -97,7 +104,12 @@ describe('CastSender', () => {
       expect(sender.apiReady()).toBe(true);
       expect(sender.hasReceivers()).toBe(false);
       expect(onStatusChanged).toHaveBeenCalled();
-      expect(mockCastApi.SessionRequest).toHaveBeenCalledWith(fakeAppId);
+      expect(mockCastApi.SessionRequest).toHaveBeenCalledWith(
+          fakeAppId,
+          /* capabilities= */ [],
+          /* timeout= */ null,
+          fakeAndroidReceiverCompatible,
+          /* credentialsData= */ null);
       expect(mockCastApi.initialize).toHaveBeenCalled();
     });
   });
@@ -122,7 +134,8 @@ describe('CastSender', () => {
       sender = new CastSender(
           fakeAppId, Util.spyFunc(onStatusChanged),
           Util.spyFunc(onFirstCastStateUpdate), Util.spyFunc(onRemoteEvent),
-          Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired));
+          Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired),
+          /* androidReceiverCompatible= */ false);
       sender.init();
       // You get an initial call to onStatusChanged when it initializes.
       expect(onStatusChanged).toHaveBeenCalledTimes(3);
@@ -256,7 +269,8 @@ describe('CastSender', () => {
     sender = new CastSender(
         fakeAppId, Util.spyFunc(onStatusChanged),
         Util.spyFunc(onFirstCastStateUpdate), Util.spyFunc(onRemoteEvent),
-        Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired));
+        Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired),
+        /* androidReceiverCompatible= */ false);
     sender.init();
 
     // The sender should automatically rejoin the session, without needing
@@ -288,7 +302,8 @@ describe('CastSender', () => {
     sender = new CastSender(
         fakeAppId, Util.spyFunc(onStatusChanged),
         Util.spyFunc(onFirstCastStateUpdate), Util.spyFunc(onRemoteEvent),
-        Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired));
+        Util.spyFunc(onResumeLocal), Util.spyFunc(onInitStateRequired),
+        /* androidReceiverCompatible= */ false);
     sender.init();
 
     expect(sender.isCasting()).toBe(false);

package/test/demo/demo_unit.js

@@ -94,7 +94,8 @@ describe('Demo', () => {
           .add('playRangeStart')
           .add('playRangeEnd')
           .add('manifest.dash.keySystemsByURI')
-          .add('manifest.hls.mediaPlaylistFullMimeType');
+          .add('manifest.hls.mediaPlaylistFullMimeType')
+          .add('drm.keySystemsMapping');
 
       /**
        * @param {!Object} section