shaka-player 4.3.11 → 4.4.1

package/lib/util/periods.js

@@ -24,6 +24,7 @@ goog.require('shaka.util.MimeUtils');
  *
  * @implements {shaka.util.IReleasable}
  * @final
+ * @export
  */
 shaka.util.PeriodCombiner = class {
   /** */
@@ -72,12 +73,20 @@ shaka.util.PeriodCombiner = class {
     this.variants_ = [];
   }
 
-  /** @return {!Array.<shaka.extern.Variant>} */
+  /**
+   * @return {!Array.<shaka.extern.Variant>}
+   *
+   * @export
+   */
   getVariants() {
     return this.variants_;
   }
 
-  /** @return {!Array.<shaka.extern.Stream>} */
+  /**
+   * @return {!Array.<shaka.extern.Stream>}
+   *
+   * @export
+  */
   getTextStreams() {
     // Return a copy of the array because makeTextStreamsForClosedCaptions
     // may make changes to the contents of the array. Those changes should not
@@ -85,15 +94,21 @@ shaka.util.PeriodCombiner = class {
     return this.textStreams_.slice();
   }
 
-  /** @return {!Array.<shaka.extern.Stream>} */
+  /**
+   * @return {!Array.<shaka.extern.Stream>}
+   *
+   * @export
+   */
   getImageStreams() {
     return this.imageStreams_;
   }
 
   /**
-   * @param {!Array.<shaka.util.PeriodCombiner.Period>} periods
+   * @param {!Array.<shaka.extern.Period>} periods
    * @param {boolean} isDynamic
    * @return {!Promise}
+   *
+   * @export
    */
   async combinePeriods(periods, isDynamic) {
     const ContentType = shaka.util.ManifestParserUtils.ContentType;
@@ -200,6 +215,7 @@ shaka.util.PeriodCombiner = class {
         variants.push({
           id,
           language: stream.language,
+          disabledUntilTime: 0,
           primary: stream.primary,
           audio: stream.type == ContentType.AUDIO ? stream : null,
           video: stream.type == ContentType.VIDEO ? stream : null,
@@ -228,6 +244,7 @@ shaka.util.PeriodCombiner = class {
           variants.push({
             id,
             language: audio.language,
+            disabledUntilTime: 0,
             primary: audio.primary,
             audio,
             video,
@@ -245,7 +262,7 @@ shaka.util.PeriodCombiner = class {
   }
 
   /**
-   * @param {!Array.<shaka.util.PeriodCombiner.Period>} periods
+   * @param {!Array.<shaka.extern.Period>} periods
    * @private
    */
   static filterOutAudioStreamDuplicates_(periods) {
@@ -282,7 +299,7 @@ shaka.util.PeriodCombiner = class {
   }
 
   /**
-   * @param {!Array.<shaka.util.PeriodCombiner.Period>} periods
+   * @param {!Array.<shaka.extern.Period>} periods
    * @private
    */
   static filterOutTextStreamDuplicates_(periods) {
@@ -316,7 +333,7 @@ shaka.util.PeriodCombiner = class {
   }
 
   /**
-   * @param {!Array.<shaka.util.PeriodCombiner.Period>} periods
+   * @param {!Array.<shaka.extern.Period>} periods
    * @private
    */
   static filterOutVideoStreamDuplicates_(periods) {
@@ -353,7 +370,7 @@ shaka.util.PeriodCombiner = class {
   }
 
   /**
-   * @param {!Array.<shaka.util.PeriodCombiner.Period>} periods
+   * @param {!Array.<shaka.extern.Period>} periods
    * @private
    */
   static filterOutImageStreamDuplicates_(periods) {
@@ -1050,8 +1067,13 @@ shaka.util.PeriodCombiner = class {
    * @private
    */
   static areAVStreamsCompatible_(outputStream, candidate) {
-    const getCodec = (codecs) =>
-      shaka.util.MimeUtils.getNormalizedCodec(codecs);
+    const getCodec = (codecs) => {
+      if (!shaka.util.PeriodCombiner.memoizedCodecs.has(codecs)) {
+        const normalizedCodec = shaka.util.MimeUtils.getNormalizedCodec(codecs);
+        shaka.util.PeriodCombiner.memoizedCodecs.set(codecs, normalizedCodec);
+      }
+      return shaka.util.PeriodCombiner.memoizedCodecs.get(codecs);
+    };
     // Check MIME type and codecs, which should always be the same.
     if (candidate.mimeType != outputStream.mimeType ||
         getCodec(candidate.codecs) != getCodec(outputStream.codecs)) {
@@ -1478,6 +1500,7 @@ shaka.util.PeriodCombiner = class {
       mimeType: '',
       codecs: '',
       language: '',
+      originalLanguage: null,
       label: null,
       width: null,
       height: null,
@@ -1517,6 +1540,7 @@ shaka.util.PeriodCombiner = class {
       drmInfos: [],
       keyIds: new Set(),
       language: '',
+      originalLanguage: null,
       label: null,
       type,
       primary: false,
@@ -1528,6 +1552,7 @@ shaka.util.PeriodCombiner = class {
       audioSamplingRate: null,
       spatialAudio: false,
       closedCaptions: null,
+      accessibilityPurpose: null,
       external: false,
     };
   }
@@ -1616,30 +1641,6 @@ shaka.util.PeriodCombiner = class {
   }
 };
 
-/**
- * @typedef {{
- *   id: string,
- *   audioStreams: !Array.<shaka.extern.Stream>,
- *   videoStreams: !Array.<shaka.extern.Stream>,
- *   textStreams: !Array.<shaka.extern.Stream>,
- *   imageStreams: !Array.<shaka.extern.Stream>
- * }}
- *
- * @description Contains the streams from one DASH period.
- *
- * @property {string} id
- *   The Period ID.
- * @property {!Array.<shaka.extern.Stream>} audioStreams
- *   The audio streams from one Period.
- * @property {!Array.<shaka.extern.Stream>} videoStreams
- *   The video streams from one Period.
- * @property {!Array.<shaka.extern.Stream>} textStreams
- *   The text streams from one Period.
- * @property {!Array.<shaka.extern.Stream>} imageStreams
- *   The image streams from one Period.
- */
-shaka.util.PeriodCombiner.Period;
-
 /**
  * @enum {number}
  */
@@ -1648,3 +1649,8 @@ shaka.util.PeriodCombiner.BetterOrWorse = {
   EQUAL: 0,
   WORSE: -1,
 };
+
+/**
+ * @private {Map<string, string>}
+ */
+shaka.util.PeriodCombiner.memoizedCodecs = new Map();

package/lib/util/platform.js

@@ -193,10 +193,10 @@ shaka.util.Platform = class {
    * @return {boolean}
    */
   static isChrome() {
-    // The Edge user agent will also contain the "Chrome" keyword, so we need
-    // to make sure this is not Edge.
+    // The Edge Legacy user agent will also contain the "Chrome" keyword, so we
+    // need to make sure this is not Edge Legacy.
     return shaka.util.Platform.userAgentContains_('Chrome') &&
-           !shaka.util.Platform.isEdge();
+           !shaka.util.Platform.isLegacyEdge();
   }
 
   /**
@@ -432,6 +432,20 @@ shaka.util.Platform = class {
     return Platform.isTizen() || Platform.isXboxOne();
   }
 
+  /**
+   * Returns true if the platform supports SourceBuffer "sequence mode".
+   *
+   * @return {boolean}
+   */
+  static supportsSequenceMode() {
+    const Platform = shaka.util.Platform;
+    if (Platform.isTizen3() || Platform.isTizen2() ||
+        Platform.isWebOS3() || Platform.isPS4()) {
+      return false;
+    }
+    return true;
+  }
+
   /**
    * Returns true if MediaKeys is polyfilled
    *

package/lib/util/player_configuration.js

@@ -68,6 +68,8 @@ 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,
+      persistentSessionOnlinePlayback: false,
+      persistentSessionsMetadata: [],
       initDataTransform: (initData, initDataType, drmInfo) => {
         const keySystem = drmInfo.keySystem;
         if (keySystem == 'com.apple.fps.1_0' && initDataType == 'skd') {
@@ -87,6 +89,7 @@ shaka.util.PlayerConfiguration = class {
       // change in the PSSH in media segments. We need to parse PSSH from media
       // segments to detect key changes.
       parseInbandPsshEnabled: shaka.util.Platform.isXboxOne(),
+      minHdcpVersion: '',
     };
 
     const manifest = {
@@ -98,6 +101,7 @@ shaka.util.PlayerConfiguration = class {
       disableThumbnails: false,
       defaultPresentationDelay: 0,
       segmentRelativeVttTiming: false,
+      raiseFatalErrorOnManifestUpdateRequestFailure: false,
       dash: {
         clockSyncUri: '',
         ignoreDrmInfo: false,
@@ -140,6 +144,22 @@ shaka.util.PlayerConfiguration = class {
             'video/mp2t; codecs="avc1.42E01E, mp4a.40.2"',
         useSafariBehaviorForLive: true,
         liveSegmentsDelay: 3,
+        sequenceMode: shaka.util.Platform.supportsSequenceMode(),
+        ignoreManifestTimestampsInSegmentsMode: false,
+      },
+      mss: {
+        manifestPreprocessor: (element) => {
+          return shaka.util.ConfigUtils.referenceParametersAndReturn(
+              [element],
+              element);
+        },
+        sequenceMode: false,
+        keySystemsBySystemId: {
+          '9a04f079-9840-4286-ab92-e65be0885f95':
+            'com.microsoft.playready',
+          '79f0049a-4098-8642-ab92-e65be0885f95':
+            'com.microsoft.playready',
+        },
       },
     };
 
@@ -163,8 +183,8 @@ shaka.util.PlayerConfiguration = class {
       alwaysStreamText: false,
       startAtSegmentBoundary: false,
       gapDetectionThreshold: 0.5,
+      gapJumpTimerTime: 0.25 /* seconds */,
       durationBackoff: 1,
-      forceTransmux: false,
       // Offset by 5 seconds since Chromecast takes a few seconds to start
       // playing after a seek, even when buffered.
       safeSeekOffset: 5,
@@ -187,6 +207,12 @@ shaka.util.PlayerConfiguration = class {
       observeQualityChanges: false,
       maxDisabledTime: 30,
       parsePrftBox: false,
+      // When low latency streaming is enabled, segmentPrefetchLimit will
+      // default to 2 if not specified.
+      segmentPrefetchLimit: 0,
+      liveSync: false,
+      liveSyncMaxLatency: 1,
+      liveSyncPlaybackRate: 1.1,
     };
 
     // WebOS, Tizen, and Chromecast have long hardware pipelines that respond
@@ -263,6 +289,8 @@ shaka.util.PlayerConfiguration = class {
       restrictToElementSize: false,
       restrictToScreenSize: false,
       ignoreDevicePixelRatio: false,
+      clearBufferSwitch: false,
+      safeMarginSwitch: 0,
     };
 
     const cmcd = {
@@ -281,6 +309,12 @@ shaka.util.PlayerConfiguration = class {
 
     const mediaSource = {
       sourceBufferExtraFeatures: '',
+      forceTransmux: false,
+      insertFakeEncryptionInInit: true,
+    };
+
+    const ads = {
+      customPlayheadTracker: false,
     };
 
     const AutoShowText = shaka.config.AutoShowText;
@@ -296,10 +330,12 @@ shaka.util.PlayerConfiguration = class {
       abr: abr,
       autoShowText: AutoShowText.IF_SUBTITLES_MAY_BE_NEEDED,
       preferredAudioLanguage: '',
+      preferredAudioLabel: '',
       preferredTextLanguage: '',
       preferredVariantRole: '',
       preferredTextRole: '',
       preferredAudioChannelCount: 2,
+      preferredVideoHdrLevel: 'AUTO',
       preferredVideoCodecs: [],
       preferredAudioCodecs: [],
       preferForcedSubs: false,
@@ -321,6 +357,7 @@ shaka.util.PlayerConfiguration = class {
       textDisplayFactory: () => null,
       cmcd: cmcd,
       lcevc: lcevc,
+      ads: ads,
     };
 
     // Add this callback so that we can reference the preferred audio language

package/lib/util/stream_utils.js

@@ -21,6 +21,7 @@ goog.requireType('shaka.media.DrmEngine');
 
 /**
  * @summary A set of utility functions for dealing with Streams and Manifests.
+ * @export
  */
 shaka.util.StreamUtils = class {
   /**
@@ -39,6 +40,7 @@ shaka.util.StreamUtils = class {
     const StreamUtils = shaka.util.StreamUtils;
 
     let variants = manifest.variants;
+
     // To start, choose the codecs based on configured preferences if available.
     if (preferredVideoCodecs.length || preferredAudioCodecs.length) {
       variants = StreamUtils.choosePreferredCodecs(variants,
@@ -321,6 +323,7 @@ shaka.util.StreamUtils = class {
    *   This is applied separately from user restrictions because the setting
    *   should not be easily replaced by the user's configuration.
    * @return {boolean}
+   * @export
    */
   static meetsRestrictions(variant, restrictions, maxHwRes) {
     /** @type {function(number, number, number):boolean} */
@@ -330,13 +333,6 @@ 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) {
@@ -409,8 +405,7 @@ shaka.util.StreamUtils = class {
    * @param {?shaka.extern.Variant} currentVariant
    * @param {shaka.extern.Manifest} manifest
    */
-  static async filterManifest(
-      drmEngine, currentVariant, manifest) {
+  static async filterManifest(drmEngine, currentVariant, manifest) {
     await shaka.util.StreamUtils.filterManifestByMediaCapabilities(manifest,
         manifest.offlineSessionIds.length > 0);
     shaka.util.StreamUtils.filterManifestByCurrentVariant(
@@ -433,7 +428,8 @@ shaka.util.StreamUtils = class {
         'MediaCapabilities should be valid.');
 
     await shaka.util.StreamUtils.getDecodingInfosForVariants(
-        manifest.variants, usePersistentLicenses, /* srcEquals= */ false);
+        manifest.variants, usePersistentLicenses, /* srcEquals= */ false,
+        /** preferredKeySystems= */ []);
     manifest.variants = manifest.variants.filter((variant) => {
       // See: https://github.com/shaka-project/shaka-player/issues/3860
       const video = variant.video;
@@ -521,6 +517,71 @@ shaka.util.StreamUtils = class {
   }
 
 
+  /**
+   * Constructs a string out of an object, similar to the JSON.stringify method.
+   * Unlike that method, this guarantees that the order of the keys is
+   * alphabetical, so it can be used as a way to reliably compare two objects.
+   *
+   * @param {!Object} obj
+   * @return {string}
+   * @private
+   */
+  static alphabeticalKeyOrderStringify_(obj) {
+    const keys = [];
+    for (const key in obj) {
+      keys.push(key);
+    }
+    // Alphabetically sort the keys, so they will be in a reliable order.
+    keys.sort();
+
+    const terms = [];
+    for (const key of keys) {
+      const escapedKey = JSON.stringify(key);
+      const value = obj[key];
+      if (value instanceof Object) {
+        const stringifiedValue =
+            shaka.util.StreamUtils.alphabeticalKeyOrderStringify_(value);
+        terms.push(escapedKey + ':' + stringifiedValue);
+      } else {
+        const escapedValue = JSON.stringify(value);
+        terms.push(escapedKey + ':' + escapedValue);
+      }
+    }
+    return '{' + terms.join(',') + '}';
+  }
+
+
+  /**
+   * Queries mediaCapabilities for the decoding info for that decoding config,
+   * and assigns it to the given variant.
+   * If that query has been done before, instead return a cached result.
+   * @param {!shaka.extern.Variant} variant
+   * @param {!MediaDecodingConfiguration} decodingConfig
+   * @private
+   */
+  static async getDecodingInfosForVariant_(variant, decodingConfig) {
+    const cacheKey =
+        shaka.util.StreamUtils.alphabeticalKeyOrderStringify_(decodingConfig);
+
+    try {
+      const cache = shaka.util.StreamUtils.decodingConfigCache_;
+      if (cache[cacheKey]) {
+        shaka.log.v2('Using cached results of mediaCapabilities.decodingInfo',
+            'for key', cacheKey);
+        variant.decodingInfos.push(cache[cacheKey]);
+      } else {
+        const result =
+            await navigator.mediaCapabilities.decodingInfo(decodingConfig);
+        cache[cacheKey] = result;
+        variant.decodingInfos.push(result);
+      }
+    } catch (e) {
+      shaka.log.info('MediaCapabilities.decodingInfo() failed.',
+          JSON.stringify(decodingConfig), e);
+    }
+  }
+
+
   /**
    * Get the decodingInfo results of the variants via MediaCapabilities.
    * This should be called after the DrmEngine is created and configured, and
@@ -529,10 +590,11 @@ shaka.util.StreamUtils = class {
    * @param {!Array.<shaka.extern.Variant>} variants
    * @param {boolean} usePersistentLicenses
    * @param {boolean} srcEquals
+   * @param {!Array<string>} preferredKeySystems
    * @exportDoc
    */
   static async getDecodingInfosForVariants(variants, usePersistentLicenses,
-      srcEquals) {
+      srcEquals, preferredKeySystems) {
     const gotDecodingInfo = variants.some((variant) =>
       variant.decodingInfos.length);
     if (gotDecodingInfo) {
@@ -540,29 +602,57 @@ shaka.util.StreamUtils = class {
       return;
     }
 
-    const mediaCapabilities = navigator.mediaCapabilities;
-
-    const operations = [];
-    const getVariantDecodingInfos = (async (variant, decodingConfig) => {
-      try {
-        const result = await mediaCapabilities.decodingInfo(decodingConfig);
-        variant.decodingInfos.push(result);
-      } catch (e) {
-        shaka.log.info('MediaCapabilities.decodingInfo() failed.',
-            JSON.stringify(decodingConfig), e);
+    // Try to get preferred key systems first to avoid unneeded calls to CDM.
+    for (const preferredKeySystem of preferredKeySystems) {
+      let keySystemSatisfied = false;
+      for (const variant of variants) {
+        /** @type {!Array.<!MediaDecodingConfiguration>} */
+        const decodingConfigs = shaka.util.StreamUtils.getDecodingConfigs_(
+            variant, usePersistentLicenses, srcEquals)
+            .filter((config) => {
+              const keySystem = config.keySystemConfiguration &&
+                config.keySystemConfiguration.keySystem;
+              return keySystem === preferredKeySystem;
+            });
+
+        // The reason we are performing this await in a loop rather than
+        // batching into a `promise.all` is performance related.
+        // https://github.com/shaka-project/shaka-player/pull/4708#discussion_r1022581178
+        for (const config of decodingConfigs) {
+          // eslint-disable-next-line no-await-in-loop
+          await shaka.util.StreamUtils.getDecodingInfosForVariant_(
+              variant, config);
+        }
+        if (variant.decodingInfos.length) {
+          keySystemSatisfied = true;
+        }
+      } // for (const variant of variants)
+      if (keySystemSatisfied) {
+        // Return if any preferred key system is already satisfied.
+        return;
       }
-    });
+    } // for (const preferredKeySystem of preferredKeySystems)
 
     for (const variant of variants) {
       /** @type {!Array.<!MediaDecodingConfiguration>} */
       const decodingConfigs = shaka.util.StreamUtils.getDecodingConfigs_(
-          variant, usePersistentLicenses, srcEquals);
-
+          variant, usePersistentLicenses, srcEquals)
+          .filter((config) => {
+            const keySystem = config.keySystemConfiguration &&
+              config.keySystemConfiguration.keySystem;
+            // Avoid checking preferred systems twice.
+            return !keySystem || !preferredKeySystems.includes(keySystem);
+          });
+
+      // The reason we are performing this await in a loop rather than
+      // batching into a `promise.all` is performance related.
+      // https://github.com/shaka-project/shaka-player/pull/4708#discussion_r1022581178
       for (const config of decodingConfigs) {
-        operations.push(getVariantDecodingInfos(variant, config));
+        // eslint-disable-next-line no-await-in-loop
+        await shaka.util.StreamUtils.getDecodingInfosForVariant_(
+            variant, config);
       }
     }
-    await Promise.all(operations);
   }
 
 
@@ -1095,6 +1185,8 @@ shaka.util.StreamUtils = class {
       originalAudioId: null,
       originalTextId: null,
       originalImageId: null,
+      accessibilityPurpose: null,
+      originalLanguage: null,
     };
 
     if (video) {
@@ -1117,6 +1209,8 @@ shaka.util.StreamUtils = class {
       track.spatialAudio = audio.spatialAudio;
       track.label = audio.label;
       track.audioRoles = audio.roles;
+      track.accessibilityPurpose = audio.accessibilityPurpose;
+      track.originalLanguage = audio.originalLanguage;
     }
 
     return track;
@@ -1166,6 +1260,8 @@ shaka.util.StreamUtils = class {
       originalAudioId: null,
       originalTextId: stream.originalId,
       originalImageId: null,
+      accessibilityPurpose: stream.accessibilityPurpose,
+      originalLanguage: stream.originalLanguage,
     };
 
     return track;
@@ -1240,6 +1336,8 @@ shaka.util.StreamUtils = class {
       originalAudioId: null,
       originalTextId: null,
       originalImageId: stream.originalId,
+      accessibilityPurpose: null,
+      originalLanguage: null,
     };
 
     return track;
@@ -1365,6 +1463,7 @@ shaka.util.StreamUtils = class {
       originalAudioId: null,
       originalTextId: null,
       originalImageId: null,
+      accessibilityPurpose: null,
       originalLanguage: language,
     };
 
@@ -1378,7 +1477,9 @@ shaka.util.StreamUtils = class {
    * @return {boolean}
    */
   static isPlayable(variant) {
-    return variant.allowedByApplication && variant.allowedByKeySystem;
+    return variant.allowedByApplication &&
+        variant.allowedByKeySystem &&
+        variant.disabledUntilTime == 0;
   }
 
 
@@ -1640,6 +1741,16 @@ shaka.util.StreamUtils = class {
 };
 
 
+/**
+ * A cache of results from mediaCapabilities.decodingInfo, indexed by the
+ * (stringified) decodingConfig.
+ *
+ * @type {Object.<(!string), (!MediaCapabilitiesDecodingInfo)>}
+ * @private
+ */
+shaka.util.StreamUtils.decodingConfigCache_ = {};
+
+
 /** @private {number} */
 shaka.util.StreamUtils.nextTrackId_ = 0;
 

package/lib/util/text_parser.js

@@ -21,7 +21,7 @@ shaka.util.TextParser = class {
      * @const
      * @private {string}
      */
-    this.data_ = data;
+    this.data_ = data || '';
 
     /** @private {number} */
     this.position_ = 0;