shaka-player 4.12.8 → 4.13.0

package/lib/hls/hls_utils.js

@@ -15,9 +15,9 @@ goog.requireType('shaka.hls.Tag');
 shaka.hls.Utils = class {
   /**
    *
-   * @param {!Array.<!shaka.hls.Tag>} tags
+   * @param {!Array<!shaka.hls.Tag>} tags
    * @param {string} name
-   * @return {!Array.<!shaka.hls.Tag>}
+   * @return {!Array<!shaka.hls.Tag>}
    */
   static filterTagsByName(tags, name) {
     return tags.filter((tag) => {
@@ -28,9 +28,9 @@ shaka.hls.Utils = class {
 
   /**
    *
-   * @param {!Array.<!shaka.hls.Tag>} tags
+   * @param {!Array<!shaka.hls.Tag>} tags
    * @param {string} type
-   * @return {!Array.<!shaka.hls.Tag>}
+   * @return {!Array<!shaka.hls.Tag>}
    */
   static filterTagsByType(tags, type) {
     return tags.filter((tag) => {
@@ -42,7 +42,7 @@ shaka.hls.Utils = class {
 
   /**
    *
-   * @param {!Array.<!shaka.hls.Tag>} tags
+   * @param {!Array<!shaka.hls.Tag>} tags
    * @param {string} name
    * @return {?shaka.hls.Tag}
    */
@@ -59,7 +59,7 @@ shaka.hls.Utils = class {
    * Get the numerical value of the first tag with given name if available.
    * Return the default value if the tag is not present.
    *
-   * @param {!Array.<!shaka.hls.Tag>} tags
+   * @param {!Array<!shaka.hls.Tag>} tags
    * @param {string} name
    * @param {number=} defaultValue
    * @return {number}
@@ -71,10 +71,10 @@ shaka.hls.Utils = class {
   }
 
   /**
-   * @param {!Array.<string>} baseUris
+   * @param {!Array<string>} baseUris
    * @param {?string} relativeUri
-   * @param {?Map.<string, string>=} variables
-   * @return {!Array.<string>}
+   * @param {?Map<string, string>=} variables
+   * @return {!Array<string>}
    */
   static constructSegmentUris(baseUris, relativeUri, variables) {
     if (!relativeUri) {
@@ -85,10 +85,10 @@ shaka.hls.Utils = class {
 
 
   /**
-   * @param {!Array.<string>} baseUris
-   * @param {!Array.<string>} relativeUris
-   * @param {?Map.<string, string>=} variables
-   * @return {!Array.<string>}
+   * @param {!Array<string>} baseUris
+   * @param {!Array<string>} relativeUris
+   * @param {?Map<string, string>=} variables
+   * @return {!Array<string>}
    */
   static constructUris(baseUris, relativeUris, variables) {
     if (!relativeUris.length) {
@@ -109,7 +109,7 @@ shaka.hls.Utils = class {
    * Replaces the variables of a given URI.
    *
    * @param {string} uri
-   * @param {?Map.<string, string>=} variables
+   * @param {?Map<string, string>=} variables
    * @return {string}
    */
   static variableSubstitution(uri, variables) {

package/lib/hls/manifest_text_parser.js

@@ -76,7 +76,7 @@ shaka.hls.ManifestTextParser = class {
       }
     }
 
-    /** {Array.<shaka.hls.Tag>} */
+    /** {Array<shaka.hls.Tag>} */
     const tags = [];
     // Initialize to "true" to skip the first element.
     skip = true;
@@ -121,18 +121,18 @@ shaka.hls.ManifestTextParser = class {
   /**
    * Parses an array of strings into an array of HLS Segment objects.
    *
-   * @param {!Array.<string>} lines
-   * @param {!Array.<!shaka.hls.Tag>} playlistTags
-   * @return {!Array.<shaka.hls.Segment>}
+   * @param {!Array<string>} lines
+   * @param {!Array<!shaka.hls.Tag>} playlistTags
+   * @return {!Array<shaka.hls.Segment>}
    * @private
    */
   parseSegments_(lines, playlistTags) {
-    /** @type {!Array.<shaka.hls.Segment>} */
+    /** @type {!Array<shaka.hls.Segment>} */
     const segments = [];
-    /** @type {!Array.<shaka.hls.Tag>} */
+    /** @type {!Array<shaka.hls.Tag>} */
     let segmentTags = [];
 
-    /** @type {!Array.<shaka.hls.Tag>} */
+    /** @type {!Array<shaka.hls.Tag>} */
     let partialSegmentTags = [];
 
     // The last parsed EXT-X-MAP tag.
@@ -221,7 +221,7 @@ shaka.hls.ManifestTextParser = class {
       An attribute's format is 'AttributeName=AttributeValue'.
       The parsing logic goes like this:
        1. Everything before ':' is a name (we ignore '#').
-       2. Everything after ':' is a list of comma-seprated items,
+       2. Everything after ':' is a list of comma-separated items,
             2a. The first item might be a value, if it does not contain '='.
             2b. Otherwise, items are attributes.
        3. If there is no ":", it's a simple tag with no attributes and no value.
@@ -283,7 +283,7 @@ shaka.hls.ManifestTextParser = class {
  * HLS tags that only appear on Media Playlists.
  * Used to determine a playlist type.
  *
- * @const {!Array.<string>}
+ * @const {!Array<string>}
  */
 shaka.hls.ManifestTextParser.MEDIA_PLAYLIST_TAGS = [
   'EXT-X-TARGETDURATION',
@@ -303,7 +303,7 @@ shaka.hls.ManifestTextParser.MEDIA_PLAYLIST_TAGS = [
  * HLS tags that only appear on Segments in a Media Playlists.
  * Used to determine the start of the segments info.
  *
- * @const {!Array.<string>}
+ * @const {!Array<string>}
  */
 shaka.hls.ManifestTextParser.SEGMENT_TAGS = [
   'EXTINF',

package/lib/media/adaptation_set.js

@@ -15,6 +15,7 @@ goog.require('shaka.util.MimeUtils');
  * A set of variants that we want to adapt between.
  *
  * @final
+ * @export
  */
 shaka.media.AdaptationSet = class {
   /**
@@ -22,7 +23,7 @@ shaka.media.AdaptationSet = class {
    *    The variant that all other variants will be tested against when being
    *    added to the adaptation set. If a variant is not compatible with the
    *    root, it will not be added.
-   * @param {!Iterable.<shaka.extern.Variant>=} candidates
+   * @param {!Iterable<shaka.extern.Variant>=} candidates
    *    Variants that may be compatible with the root and should be added if
    *    compatible. If a candidate is not compatible, it will not end up in the
    *    adaptation set.
@@ -31,7 +32,7 @@ shaka.media.AdaptationSet = class {
   constructor(root, candidates, compareCodecs = true) {
     /** @private {shaka.extern.Variant} */
     this.root_ = root;
-    /** @private {!Set.<shaka.extern.Variant>} */
+    /** @private {!Set<shaka.extern.Variant>} */
     this.variants_ = new Set([root]);
 
     // Try to add all the candidates. If they cannot be added (because they
@@ -116,7 +117,7 @@ shaka.media.AdaptationSet = class {
   }
 
   /**
-   * @return {!Iterable.<shaka.extern.Variant>}
+   * @return {!Iterable<shaka.extern.Variant>}
    */
   values() {
     return this.variants_.values();
@@ -245,8 +246,8 @@ shaka.media.AdaptationSet = class {
    * Check if two role lists are the equal. This will take into account all
    * unique behaviours when comparing roles.
    *
-   * @param {!Iterable.<string>} a
-   * @param {!Iterable.<string>} b
+   * @param {!Iterable<string>} a
+   * @param {!Iterable<string>} b
    * @return {boolean}
    * @private
    */

package/lib/media/adaptation_set_criteria.js

@@ -5,14 +5,9 @@
  */
 
 goog.provide('shaka.media.AdaptationSetCriteria');
-goog.provide('shaka.media.ExampleBasedCriteria');
-goog.provide('shaka.media.PreferenceBasedCriteria');
 
-goog.require('shaka.config.CodecSwitchingStrategy');
-goog.require('shaka.log');
 goog.require('shaka.media.AdaptationSet');
-goog.require('shaka.media.Capabilities');
-goog.require('shaka.util.LanguageUtils');
+goog.require('shaka.config.CodecSwitchingStrategy');
 
 
 /**
@@ -21,393 +16,70 @@ goog.require('shaka.util.LanguageUtils');
  * adapted between.
  *
  * @interface
+ * @export
  */
 shaka.media.AdaptationSetCriteria = class {
   /**
    * Take a set of variants, and return a subset of variants that can be
    * adapted between.
    *
-   * @param {!Array.<shaka.extern.Variant>} variants
+   * @param {!Array<shaka.extern.Variant>} variants
    * @return {!shaka.media.AdaptationSet}
+   * @exportInterface
    */
   create(variants) {}
-};
-
 
-/**
- * @implements {shaka.media.AdaptationSetCriteria}
- * @final
- */
-shaka.media.ExampleBasedCriteria = class {
   /**
-   * @param {shaka.extern.Variant} example
-   * @param {shaka.config.CodecSwitchingStrategy} codecSwitchingStrategy
+   * Sets the AdaptationSetCriteria configuration.
+   *
+   * @param {shaka.media.AdaptationSetCriteria.Configuration} config
+   * @exportInterface
    */
-  constructor(example, codecSwitchingStrategy) {
-    // We can't know if role and label are really important, so we don't use
-    // role and label for this.
-    const role = '';
-    const audioLabel = '';
-    const videoLabel = '';
-    const hdrLevel = example.video && example.video.hdr ?
-        example.video.hdr : '';
-    const spatialAudio = example.audio && example.audio.spatialAudio ?
-        example.audio.spatialAudio : false;
-    const videoLayout = example.video && example.video.videoLayout ?
-        example.video.videoLayout : '';
-    const channelCount = example.audio && example.audio.channelsCount ?
-        example.audio.channelsCount : 0;
-    const audioCodec = example.audio && example.audio.codecs ?
-        example.audio.codecs : '';
-
-    /** @private {!shaka.media.AdaptationSetCriteria} */
-    this.preferenceBasedCriteria_ = new shaka.media.PreferenceBasedCriteria(
-        example.language, role, channelCount, hdrLevel, spatialAudio,
-        videoLayout, audioLabel, videoLabel,
-        codecSwitchingStrategy, audioCodec);
-  }
-
-  /** @override */
-  create(variants) {
-    return this.preferenceBasedCriteria_.create(variants);
-  }
+  configure(config) {}
 };
 
-
 /**
- * @implements {shaka.media.AdaptationSetCriteria}
- * @final
+ * A factory for creating the AdaptationSetCriteria.
+ *
+ * @typedef {function():!shaka.media.AdaptationSetCriteria}
+ * @export
  */
-shaka.media.PreferenceBasedCriteria = class {
-  /**
-   * @param {string} language
-   * @param {string} role
-   * @param {number} channelCount
-   * @param {string} hdrLevel
-   * @param {boolean} spatialAudio
-   * @param {string} videoLayout
-   * @param {string} audioLabel
-   * @param {string} videoLabel
-   * @param {shaka.config.CodecSwitchingStrategy} codecSwitchingStrategy
-   * @param {string} audioCodec
-   */
-  constructor(language, role, channelCount, hdrLevel, spatialAudio,
-      videoLayout, audioLabel, videoLabel, codecSwitchingStrategy, audioCodec) {
-    /** @private {string} */
-    this.language_ = language;
-    /** @private {string} */
-    this.role_ = role;
-    /** @private {number} */
-    this.channelCount_ = channelCount;
-    /** @private {string} */
-    this.hdrLevel_ = hdrLevel;
-    /** @private {boolean} */
-    this.spatialAudio_ = spatialAudio;
-    /** @private {string} */
-    this.videoLayout_ = videoLayout;
-    /** @private {string} */
-    this.audioLabel_ = audioLabel;
-    /** @private {string} */
-    this.videoLabel_ = videoLabel;
-    /** @private {shaka.config.CodecSwitchingStrategy} */
-    this.codecSwitchingStrategy_ = codecSwitchingStrategy;
-    /** @private {string} */
-    this.audioCodec_ = audioCodec;
-  }
-
-  /** @override */
-  create(variants) {
-    const Class = shaka.media.PreferenceBasedCriteria;
-
-    let current = [];
-
-    const byLanguage = Class.filterByLanguage_(variants, this.language_);
-    const byPrimary = variants.filter((variant) => variant.primary);
-
-    if (byLanguage.length) {
-      current = byLanguage;
-    } else if (byPrimary.length) {
-      current = byPrimary;
-    } else {
-      current = variants;
-    }
-
-    // Now refine the choice based on role preference.  Even the empty string
-    // works here, and will match variants without any roles.
-    const byRole = Class.filterVariantsByRole_(current, this.role_);
-    if (byRole.length) {
-      current = byRole;
-    } else {
-      shaka.log.warning('No exact match for variant role could be found.');
-    }
-
-    if (this.videoLayout_) {
-      const byVideoLayout = Class.filterVariantsByVideoLayout_(
-          current, this.videoLayout_);
-      if (byVideoLayout.length) {
-        current = byVideoLayout;
-      } else {
-        shaka.log.warning(
-            'No exact match for the video layout could be found.');
-      }
-    }
-
-    if (this.hdrLevel_) {
-      const byHdrLevel = Class.filterVariantsByHDRLevel_(
-          current, this.hdrLevel_);
-      if (byHdrLevel.length) {
-        current = byHdrLevel;
-      } else {
-        shaka.log.warning(
-            'No exact match for the hdr level could be found.');
-      }
-    }
-
-    if (this.channelCount_) {
-      const byChannel = Class.filterVariantsByAudioChannelCount_(
-          current, this.channelCount_);
-      if (byChannel.length) {
-        current = byChannel;
-      } else {
-        shaka.log.warning(
-            'No exact match for the channel count could be found.');
-      }
-    }
-
-    if (this.audioLabel_) {
-      const byLabel = Class.filterVariantsByAudioLabel_(
-          current, this.audioLabel_);
-      if (byLabel.length) {
-        current = byLabel;
-      } else {
-        shaka.log.warning('No exact match for audio label could be found.');
-      }
-    }
-
-    if (this.videoLabel_) {
-      const byLabel = Class.filterVariantsByVideoLabel_(
-          current, this.videoLabel_);
-      if (byLabel.length) {
-        current = byLabel;
-      } else {
-        shaka.log.warning('No exact match for video label could be found.');
-      }
-    }
-
-    const bySpatialAudio = Class.filterVariantsBySpatialAudio_(
-        current, this.spatialAudio_);
-    if (bySpatialAudio.length) {
-      current = bySpatialAudio;
-    } else {
-      shaka.log.warning('No exact match for spatial audio could be found.');
-    }
-
-    if (this.audioCodec_) {
-      const byAudioCodec = Class.filterVariantsByAudioCodec_(
-          current, this.audioCodec_);
-      if (byAudioCodec.length) {
-        current = byAudioCodec;
-      } else {
-        shaka.log.warning('No exact match for audio codec could be found.');
-      }
-    }
-
-    const supportsSmoothCodecTransitions = this.codecSwitchingStrategy_ ==
-      shaka.config.CodecSwitchingStrategy.SMOOTH &&
-        shaka.media.Capabilities.isChangeTypeSupported();
-
-    return new shaka.media.AdaptationSet(current[0], current,
-        !supportsSmoothCodecTransitions);
-  }
-
-  /**
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {string} preferredLanguage
-   * @return {!Array.<shaka.extern.Variant>}
-   * @private
-   */
-  static filterByLanguage_(variants, preferredLanguage) {
-    const LanguageUtils = shaka.util.LanguageUtils;
-
-    /** @type {string} */
-    const preferredLocale = LanguageUtils.normalize(preferredLanguage);
-
-    /** @type {?string} */
-    const closestLocale = LanguageUtils.findClosestLocale(
-        preferredLocale,
-        variants.map((variant) => LanguageUtils.getLocaleForVariant(variant)));
-
-    // There were no locales close to what we preferred.
-    if (!closestLocale) {
-      return [];
-    }
-
-    // Find the variants that use the closest variant.
-    return variants.filter((variant) => {
-      return closestLocale == LanguageUtils.getLocaleForVariant(variant);
-    });
-  }
-
-  /**
-   * Filter Variants by role.
-   *
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {string} preferredRole
-   * @return {!Array.<shaka.extern.Variant>}
-   * @private
-   */
-  static filterVariantsByRole_(variants, preferredRole) {
-    return variants.filter((variant) => {
-      if (!variant.audio) {
-        return false;
-      }
+shaka.media.AdaptationSetCriteria.Factory;
 
-      if (preferredRole) {
-        return variant.audio.roles.includes(preferredRole);
-      } else {
-        return variant.audio.roles.length == 0;
-      }
-    });
-  }
-
-  /**
-   * Filter Variants by audio label.
-   *
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {string} preferredLabel
-   * @return {!Array.<shaka.extern.Variant>}
-   * @private
-   */
-  static filterVariantsByAudioLabel_(variants, preferredLabel) {
-    return variants.filter((variant) => {
-      if (!variant.audio || !variant.audio.label) {
-        return false;
-      }
-
-      const label1 = variant.audio.label.toLowerCase();
-      const label2 = preferredLabel.toLowerCase();
-      return label1 == label2;
-    });
-  }
-
-  /**
-   * Filter Variants by video label.
-   *
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {string} preferredLabel
-   * @return {!Array.<shaka.extern.Variant>}
-   * @private
-   */
-  static filterVariantsByVideoLabel_(variants, preferredLabel) {
-    return variants.filter((variant) => {
-      if (!variant.video || !variant.video.label) {
-        return false;
-      }
-
-      const label1 = variant.video.label.toLowerCase();
-      const label2 = preferredLabel.toLowerCase();
-      return label1 == label2;
-    });
-  }
-
-  /**
-   * Filter Variants by channelCount.
-   *
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {number} channelCount
-   * @return {!Array.<shaka.extern.Variant>}
-   * @private
-   */
-  static filterVariantsByAudioChannelCount_(variants, channelCount) {
-    return variants.filter((variant) => {
-      if (variant.audio && variant.audio.channelsCount &&
-          variant.audio.channelsCount != channelCount) {
-        return false;
-      }
-      return true;
-    });
-  }
-
-  /**
-   * Filters variants according to the given hdr level config.
-   *
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {string} hdrLevel
-   * @private
-   */
-  static filterVariantsByHDRLevel_(variants, hdrLevel) {
-    if (hdrLevel == 'AUTO') {
-      // Auto detect the ideal HDR level.
-      if (window.matchMedia('(color-gamut: p3)').matches) {
-        const someHLG = variants.some((variant) => {
-          if (variant.video && variant.video.hdr &&
-              variant.video.hdr == 'HLG') {
-            return true;
-          }
-          return false;
-        });
-        hdrLevel = someHLG ? 'HLG' : 'PQ';
-      } else {
-        hdrLevel = 'SDR';
-      }
-    }
-    return variants.filter((variant) => {
-      if (variant.video && variant.video.hdr && variant.video.hdr != hdrLevel) {
-        return false;
-      }
-      return true;
-    });
-  }
-
-
-  /**
-   * Filters variants according to the given video layout config.
-   *
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {string} videoLayout
-   * @private
-   */
-  static filterVariantsByVideoLayout_(variants, videoLayout) {
-    return variants.filter((variant) => {
-      if (variant.video && variant.video.videoLayout &&
-          variant.video.videoLayout != videoLayout) {
-        return false;
-      }
-      return true;
-    });
-  }
-
-
-  /**
-   * Filters variants according to the given spatial audio config.
-   *
-   * @param {!Array.<shaka.extern.Variant>} variants
-   * @param {boolean} spatialAudio
-   * @private
-   */
-  static filterVariantsBySpatialAudio_(variants, spatialAudio) {
-    return variants.filter((variant) => {
-      if (variant.audio && variant.audio.spatialAudio != spatialAudio) {
-        return false;
-      }
-      return true;
-    });
-  }
-
-
-  /**
-   * Filters variants according to the given audio codec.
-   *
-   * @param {!Array<shaka.extern.Variant>} variants
-   * @param {string} audioCodec
-   * @private
-   */
-  static filterVariantsByAudioCodec_(variants, audioCodec) {
-    return variants.filter((variant) => {
-      if (variant.audio && variant.audio.codecs != audioCodec) {
-        return false;
-      }
-      return true;
-    });
-  }
-};
+/**
+ * @typedef {{
+ *   language: string,
+ *   role: string,
+ *   channelCount: number,
+ *   hdrLevel: string,
+ *   spatialAudio: boolean,
+ *   videoLayout: string,
+ *   audioLabel: string,
+ *   videoLabel: string,
+ *   codecSwitchingStrategy: shaka.config.CodecSwitchingStrategy,
+ *   audioCodec: string
+ * }}
+ *
+ * @property {string} language
+ *   The language used to filter variants.
+ * @property {string} role
+ *   The adaptation role used to filter variants.
+ * @property {string} channelCount
+ *   The audio channel count used to filter variants.
+ * @property {string} hdrLevel
+ *   The HDR level used to filter variants.
+ * @property {boolean} spatialAudio
+ *   Whether should prefer audio tracks with spatial audio.
+ * @property {string} videoLayout
+ *   The video layout used to filter variants.
+ * @property {string} audioLabel
+ *   The audio label used to filter variants.
+ * @property {string} videoLabel
+ *   The video label used to filter variants.
+ * @property {shaka.config.CodecSwitchingStrategy} codecSwitchingStrategy
+ *   The codec switching strategy used to filter variants.
+ * @property {string} audioCodec
+ *   The audio codec used to filter variants.
+ * @export
+ */
+shaka.media.AdaptationSetCriteria.Configuration;

package/lib/media/buffering_observer.js

@@ -24,7 +24,7 @@ shaka.media.BufferingObserver = class {
     /** @private {shaka.media.BufferingObserver.State} */
     this.previousState_ = State.SATISFIED;
 
-    /** @private {!Map.<shaka.media.BufferingObserver.State, number>} */
+    /** @private {!Map<shaka.media.BufferingObserver.State, number>} */
     this.thresholds_ = new Map()
         .set(State.SATISFIED, thresholdWhenSatisfied)
         .set(State.STARVING, thresholdWhenStarving);
@@ -67,9 +67,10 @@ shaka.media.BufferingObserver = class {
     const threshold = this.thresholds_.get(this.previousState_);
 
     const oldState = this.previousState_;
-    const newState = (bufferedToEnd || bufferLead >= threshold) ?
-                     (State.SATISFIED) :
-                     (State.STARVING);
+    const newState =
+        (bufferedToEnd || (bufferLead >= threshold && bufferLead > 0)) ?
+        (State.SATISFIED) :
+        (State.STARVING);
 
     // Save the new state now so that calls to |getState| from any callbacks
     // will be accurate.

package/lib/media/closed_caption_parser.js

@@ -17,7 +17,7 @@ goog.require('shaka.util.BufferUtils');
  * The IClosedCaptionParser defines the interface to provide all operations for
  * parsing the closed captions embedded in Dash videos streams.
  * TODO: Remove this interface and move method definitions
- * directly to ClosedCaptonParser.
+ * directly to ClosedCaptionParser.
  * @interface
  * @export
  */
@@ -49,7 +49,7 @@ shaka.media.IClosedCaptionParser = class {
 
   /**
    * Returns the streams that the CEA decoder found.
-   * @return {!Array.<string>}
+   * @return {!Array<string>}
    */
   getStreams() {}
 };