shaka-player 4.4.3 → 4.6.0

package/externs/shaka/net.js

@@ -226,7 +226,7 @@ shaka.extern.RequestContext;
  * it before it is sent to the scheme plugin.
  * The RequestType describes the basic type of the request (manifest, segment,
  * etc). The optional RequestContext will be provided where applicable to
- * provide additional infomation about the request. A request filter can run
+ * provide additional information about the request. A request filter can run
  * asynchronously by returning a promise; in this case, the request will not be
  * sent until the promise is resolved.
  *
@@ -244,7 +244,7 @@ shaka.extern.RequestFilter;
  * it before it is returned.
  * The RequestType describes the basic type of the request (manifest, segment,
  * etc). The optional RequestContext will be provided where applicable to
- * provide additional infomation about the request. A response filter can run
+ * provide additional information about the request. A response filter can run
  * asynchronously by returning a promise.
  *
  * @typedef {!function(shaka.net.NetworkingEngine.RequestType,

package/externs/shaka/offline.js

@@ -114,6 +114,7 @@ shaka.extern.ManifestDB;
  * @typedef {{
  *   id: number,
  *   originalId: ?string,
+ *   groupId: ?string,
  *   primary: boolean,
  *   type: string,
  *   mimeType: string,
@@ -121,6 +122,7 @@ shaka.extern.ManifestDB;
  *   frameRate: (number|undefined),
  *   pixelAspectRatio: (string|undefined),
  *   hdr: (string|undefined),
+ *   videoLayout: (string|undefined),
  *   kind: (string|undefined),
  *   language: string,
  *   originalLanguage: (?string|undefined),
@@ -138,7 +140,8 @@ shaka.extern.ManifestDB;
  *   spatialAudio: boolean,
  *   closedCaptions: Map.<string, string>,
  *   tilesLayout: (string|undefined),
- *   external: boolean
+ *   external: boolean,
+ *   fastSwitching: boolean
  * }}
  *
  * @property {number} id
@@ -146,6 +149,9 @@ shaka.extern.ManifestDB;
  * @property {?string} originalId
  *   The original ID, if any, that appeared in the manifest.  For example, in
  *   DASH, this is the "id" attribute of the Representation element.
+ * @property {?string} groupId
+ *   The ID of the stream's parent element. In DASH, this will be a unique
+ *   ID that represents the representation's parent adaptation element
  * @property {boolean} primary
  *   Whether the stream set was primary.
  * @property {string} type
@@ -160,6 +166,8 @@ shaka.extern.ManifestDB;
  *   The Stream's pixel aspect ratio
  * @property {(string|undefined)} hdr
  *   The Stream's HDR info
+ * @property {(string|undefined)} videoLayout
+ *   The Stream's video layout info.
  * @property {(string|undefined)} kind
  *   The kind of text stream; undefined for audio/video.
  * @property {string} language
@@ -195,7 +203,8 @@ shaka.extern.ManifestDB;
  *   A map containing the description of closed captions, with the caption
  *   channel number (CC1 | CC2 | CC3 | CC4) as the key and the language code
  *   as the value. If the channel number is not provided by the description,
- *   we'll set an 0-based index as the key.
+ *   we'll set a 0-based index as the key. If the language code is not
+ *   provided by the description we'll set the same value as channel number.
  *   Example: {'CC1': 'eng'; 'CC3': 'swe'}, or {'1', 'eng'; '2': 'swe'}, etc.
  * @property {(string|undefined)} tilesLayout
  *   The value is a grid-item-dimension consisting of two positive decimal
@@ -204,6 +213,8 @@ shaka.extern.ManifestDB;
  * @property {boolean} external
  *   Indicate if the stream was added externally.
  *   Eg: external text tracks.
+ * @property {boolean} fastSwitching
+ *   Indicate if the stream should be used for fast switching.
  */
 shaka.extern.StreamDB;
 

package/externs/shaka/player.js

@@ -216,6 +216,7 @@ shaka.extern.BufferedInfo;
  *   frameRate: ?number,
  *   pixelAspectRatio: ?string,
  *   hdr: ?string,
+ *   videoLayout: ?string,
  *   mimeType: ?string,
  *   audioMimeType: ?string,
  *   videoMimeType: ?string,
@@ -280,6 +281,8 @@ shaka.extern.BufferedInfo;
  *   The video pixel aspect ratio provided in the manifest, if present.
  * @property {?string} hdr
  *   The video HDR provided in the manifest, if present.
+ * @property {?string} videoLayout
+ *   The video layout provided in the manifest, if present.
  * @property {?string} mimeType
  *   The MIME type of the content provided in the manifest.
  * @property {?string} audioMimeType
@@ -495,13 +498,17 @@ shaka.extern.MetadataRawFrame;
  * @typedef {{
  *   key: string,
  *   data: (ArrayBuffer|string|number),
- *   description: string
+ *   description: string,
+ *   mimeType: ?string,
+ *   pictureType: ?number
  * }}
  *
  * @description metadata frame parsed.
  * @property {string} key
  * @property {ArrayBuffer|string|number} data
  * @property {string} description
+ * @property {?string} mimeType
+ * @property {?number} pictureType
  * @exportDoc
  */
 shaka.extern.MetadataFrame;
@@ -573,7 +580,7 @@ shaka.extern.TimelineRegionInfo;
  * @property {?number} channelsCount
  *   The number of audio channels, or null if unknown.
  * @property {?string} pixelAspectRatio
- *   The pixel aspect ratio value; e.g "1:1".
+ *   The pixel aspect ratio value; e.g. "1:1".
  * @property {?number} width
  *   The video width in pixels.
  * @exportDoc
@@ -754,7 +761,8 @@ shaka.extern.PersistentSessionMetadata;
  *   preferredKeySystems: !Array.<string>,
  *   keySystemsMapping: !Object.<string, string>,
  *   parseInbandPsshEnabled: boolean,
- *   minHdcpVersion: string
+ *   minHdcpVersion: string,
+ *   ignoreDuplicateInitData: boolean
  * }}
  *
  * @property {shaka.extern.RetryParameters} retryParameters
@@ -810,7 +818,12 @@ shaka.extern.PersistentSessionMetadata;
  *   <i>By default (''), do not check the HDCP version.</i><br>
  *   Indicates the minimum version of HDCP to start the playback of encrypted
  *   streams. <b>May be ignored if not supported by the device.</b>
- *
+ * @property {boolean} ignoreDuplicateInitData
+ *   <i>Defaults to false on Tizen 2, and true for all other browsers.</i><br>
+ *   When true indicate that the player doesn't ignore duplicate init data.
+ *   Note: Tizen 2015 and 2016 models will send multiple webkitneedkey events
+ *   with the same init data. If the duplicates are supressed, playback
+ *   will stall without errors.
  * @exportDoc
  */
 shaka.extern.DrmConfiguration;
@@ -841,7 +854,8 @@ shaka.extern.InitDataTransform;
  *   ignoreMaxSegmentDuration: boolean,
  *   keySystemsByURI: !Object.<string, string>,
  *   manifestPreprocessor: function(!Element),
- *   sequenceMode: boolean
+ *   sequenceMode: boolean,
+ *   enableAudioGroups: boolean
  * }}
  *
  * @property {string} clockSyncUri
@@ -899,6 +913,10 @@ shaka.extern.InitDataTransform;
  *   If true, the media segments are appended to the SourceBuffer in
  *   "sequence mode" (ignoring their internal timestamps).
  *   <i>Defaults to <code>false</code>.</i>
+ * @property {boolean} enableAudioGroups
+ *   If set, audio streams will be grouped and filtered by their parent
+ *   adaptation set ID.
+ *   <i>Defaults to <code>false</code>.</i>
  * @exportDoc
  */
 shaka.extern.DashManifestConfiguration;
@@ -915,7 +933,9 @@ shaka.extern.DashManifestConfiguration;
  *   useSafariBehaviorForLive: boolean,
  *   liveSegmentsDelay: number,
  *   sequenceMode: boolean,
- *   ignoreManifestTimestampsInSegmentsMode: boolean
+ *   ignoreManifestTimestampsInSegmentsMode: boolean,
+ *   disableCodecGuessing: boolean,
+ *   allowLowLatencyByteRangeOptimization: boolean
  * }}
  *
  * @property {boolean} ignoreTextStreamFailures
@@ -968,6 +988,18 @@ shaka.extern.DashManifestConfiguration;
  *   to the SourceBuffer, even if the manifest and segment times disagree.
  *   Only applies when sequenceMode is <code>false</code>.
  *   <i>Defaults to <code>false</code>.</i>
+ * @property {boolean} disableCodecGuessing
+ *   If set to true, the HLS parser won't automatically guess or assume default
+ *   codec for playlists with no "CODECS" attribute. Instead, it will attempt to
+ *   extract the missing information from the media segment.
+ *   As a consequence, lazy-loading media playlists won't be possible for this
+ *   use case, which may result in longer video startup times.
+ *   <i>Defaults to <code>false</code>.</i>
+ * @property {boolean} allowLowLatencyByteRangeOptimization
+ *   If set to true, the HLS parser will optimize operation with LL and partial
+ *   byte range segments. More info in
+ *   https://www.akamai.com/blog/performance/-using-ll-hls-with-byte-range-addressing-to-achieve-interoperabi
+ *   <i>Defaults to <code>true</code>.</i>
  * @exportDoc
  */
 shaka.extern.HlsManifestConfiguration;
@@ -1050,7 +1082,7 @@ shaka.extern.MssManifestConfiguration;
  * @property {shaka.extern.MssManifestConfiguration} mss
  *   Advanced parameters used by the MSS manifest parser.
  * @property {boolean} raiseFatalErrorOnManifestUpdateRequestFailure
- *   If true, manifest update request failures will cause a fatal errror.
+ *   If true, manifest update request failures will cause a fatal error.
  *   Defaults to <code>false</code> if not provided.
  *
  * @exportDoc
@@ -1089,7 +1121,9 @@ shaka.extern.ManifestConfiguration;
  *   segmentPrefetchLimit: number,
  *   liveSync: boolean,
  *   liveSyncMaxLatency: number,
- *   liveSyncPlaybackRate: number
+ *   liveSyncPlaybackRate: number,
+ *   liveSyncMinLatency: number,
+ *   liveSyncMinPlaybackRate: number
  * }}
  *
  * @description
@@ -1218,6 +1252,13 @@ shaka.extern.ManifestConfiguration;
  *   Playback rate used for latency chasing. It is recommended to use a value
  *   between 1 and 2. Effective only if liveSync is true. Defaults to
  *   <code>1.1</code>.
+ * @property {number} liveSyncMinLatency
+ *   Minimun acceptable latency, in seconds. Effective only if liveSync is
+ *   true. Defaults to <code>0</code>.
+ * @property {number} liveSyncMinPlaybackRate
+ *   Minimun playback rate used for latency chasing. It is recommended to use a
+ *   value between 0 and 1. Effective only if liveSync is true. Defaults to
+ *   <code>1</code>.
  * @exportDoc
  */
 shaka.extern.StreamingConfiguration;
@@ -1225,6 +1266,7 @@ shaka.extern.StreamingConfiguration;
 
 /**
  * @typedef {{
+ *   codecSwitchingStrategy: shaka.config.CodecSwitchingStrategy,
  *   sourceBufferExtraFeatures: string,
  *   forceTransmux: boolean,
 *    insertFakeEncryptionInInit: boolean
@@ -1233,6 +1275,11 @@ shaka.extern.StreamingConfiguration;
  * @description
  *   Media source configuration.
  *
+ * @property {shaka.config.CodecSwitchingStrategy} codecSwitchingStrategy
+ *   Allow codec switching strategy. SMOOTH loading uses
+ *   SourceBuffer.changeType. RELOAD uses cycling of MediaSource.
+ *   Defaults to SMOOTH if SMOOTH codec switching is supported, RELOAD
+ *   overwise.
  * @property {string} sourceBufferExtraFeatures
  *   Some platforms may need to pass features when initializing the
  *   sourceBuffer.
@@ -1518,6 +1565,7 @@ shaka.extern.OfflineConfiguration;
  *   preferredAudioCodecs: !Array.<string>,
  *   preferredAudioChannelCount: number,
  *   preferredVideoHdrLevel: string,
+ *   preferredVideoLayout: string,
  *   preferredDecodingAttributes: !Array.<string>,
  *   preferForcedSubs: boolean,
  *   restrictions: shaka.extern.Restrictions,
@@ -1578,6 +1626,12 @@ shaka.extern.OfflineConfiguration;
  *   Defaults to 'AUTO'.
  *   Note that one some platforms, such as Chrome, attempting to play PQ content
  *   may cause problems.
+ * @property {string} preferredVideoLayout
+ *   The preferred video layout of the video.
+ *   Can be 'CH-STEREO', 'CH-MONO', or '' for no preference.
+ *   If the content is predominantly stereoscopic you should use 'CH-STEREO'.
+ *   If the content is predominantly monoscopic you should use 'CH-MONO'.
+ *   Defaults to ''.
  * @property {!Array.<string>} preferredDecodingAttributes
  *   The list of preferred attributes of decodingInfo, in the order of their
  *   priorities.
@@ -1626,6 +1680,7 @@ shaka.extern.LanguageRole;
 
 /**
  * @typedef {{
+ *   segment: shaka.media.SegmentReference,
  *   imageHeight: number,
  *   imageWidth: number,
  *   height: number,
@@ -1638,6 +1693,8 @@ shaka.extern.LanguageRole;
  *   sprite: boolean
  * }}
  *
+ * @property {shaka.media.SegmentReference} segment
+ *    The segment of this thumbnail.
  * @property {number} imageHeight
  *    The image height in px. The image height could be different to height if
  *    the layout is different to 1x1.

package/externs/shaka/text.js

@@ -36,11 +36,13 @@ shaka.extern.TextParser = class {
    * @param {shaka.extern.TextParser.TimeContext} timeContext
    *    The time information that should be used to adjust the times values
    *    for each cue.
+   * @param {?(string|undefined)} uri
+   *    The media uri.
    * @return {!Array.<!shaka.text.Cue>}
    *
    * @exportDoc
    */
-  parseMedia(data, timeContext) {}
+  parseMedia(data, timeContext, uri) {}
 
   /**
    * Notifies the stream if the manifest is in sequence mode or not.

package/externs/shaka/transmuxer.js

@@ -37,7 +37,7 @@ shaka.extern.Transmuxer = class {
    * Returns the original mimetype of the transmuxer.
    * @return {string}
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
 
   /**
    * Transmux a input data to MP4.

package/karma.conf.js

@@ -191,9 +191,6 @@ module.exports = (config) => {
       //   Babel polyfill, required for async/await
       'node_modules/@babel/polyfill/dist/polyfill.js',
 
-      // muxjs module next
-      'node_modules/mux.js/dist/mux.min.js',
-
       // codem-isoboxer module next
       'node_modules/codem-isoboxer/dist/iso_boxer.min.js',
 
@@ -236,7 +233,9 @@ module.exports = (config) => {
       {pattern: 'third_party/**/*.js', included: false},
       {pattern: 'test/**/*.js', included: false},
       {pattern: 'test/test/assets/*', included: false},
+      {pattern: 'test/test/assets/dash-multi-codec/*', included: false},
       {pattern: 'test/test/assets/3675/*', included: false},
+      {pattern: 'test/test/assets/dash-aes-128/*', included: false},
       {pattern: 'test/test/assets/hls-raw-aac/*', included: false},
       {pattern: 'test/test/assets/hls-raw-ac3/*', included: false},
       {pattern: 'test/test/assets/hls-raw-ec3/*', included: false},
@@ -245,8 +244,13 @@ module.exports = (config) => {
       {pattern: 'test/test/assets/hls-ts-ac3/*', included: false},
       {pattern: 'test/test/assets/hls-ts-ec3/*', included: false},
       {pattern: 'test/test/assets/hls-ts-h264/*', included: false},
+      {pattern: 'test/test/assets/hls-ts-h265/*', included: false},
       {pattern: 'test/test/assets/hls-ts-mp3/*', included: false},
       {pattern: 'test/test/assets/hls-ts-muxed-aac-h264/*', included: false},
+      {pattern: 'test/test/assets/hls-ts-muxed-aac-h265/*', included: false},
+      {pattern: 'test/test/assets/hls-ts-muxed-ac3-h264/*', included: false},
+      {pattern: 'test/test/assets/hls-ts-muxed-mp3-h264/*', included: false},
+      {pattern: 'test/test/assets/hls-ts-muxed-ec3-h264/*', included: false},
       {pattern: 'dist/shaka-player.ui.js', included: false},
       {pattern: 'dist/locales.js', included: false},
       {pattern: 'demo/**/*.js', included: false},

package/lib/abr/simple_abr_manager.js

@@ -63,7 +63,7 @@ shaka.abr.SimpleAbrManager = class {
             this.bandwidthEstimator_.configure(this.config_.advanced);
           }
           const chosenVariant = this.chooseVariant();
-          if (chosenVariant) {
+          if (chosenVariant && navigator.onLine) {
             this.switch_(chosenVariant, this.config_.clearBufferSwitch,
                 this.config_.safeMarginSwitch);
           }
@@ -165,10 +165,12 @@ shaka.abr.SimpleAbrManager = class {
 
 
   /**
+   * @param {boolean=} preferFastSwitching
+   * @return {shaka.extern.Variant}
    * @override
    * @export
    */
-  chooseVariant() {
+  chooseVariant(preferFastSwitching = false) {
     const SimpleAbrManager = shaka.abr.SimpleAbrManager;
 
     let maxHeight = Infinity;
@@ -184,19 +186,51 @@ shaka.abr.SimpleAbrManager = class {
     if (this.resizeObserver_ && this.config_.restrictToElementSize) {
       const devicePixelRatio =
           this.config_.ignoreDevicePixelRatio ? 1 : window.devicePixelRatio;
-      maxHeight = this.mediaElement_.clientHeight * devicePixelRatio;
-      maxWidth = this.mediaElement_.clientWidth * devicePixelRatio;
+      maxHeight = Math.min(
+          maxHeight, this.mediaElement_.clientHeight * devicePixelRatio);
+      maxWidth = Math.min(
+          maxWidth, this.mediaElement_.clientWidth * devicePixelRatio);
+    }
+
+    let normalVariants = this.variants_.filter((variant) => {
+      return !shaka.util.StreamUtils.isFastSwitching(variant);
+    });
+    if (!normalVariants.length) {
+      normalVariants = this.variants_;
+    }
+
+    let variants = normalVariants;
+    if (preferFastSwitching &&
+        normalVariants.length != this.variants_.length) {
+      variants = this.variants_.filter((variant) => {
+        return shaka.util.StreamUtils.isFastSwitching(variant);
+      });
     }
 
     // Get sorted Variants.
     let sortedVariants = SimpleAbrManager.filterAndSortVariants_(
-        this.config_.restrictions, this.variants_, maxHeight, maxWidth);
+        this.config_.restrictions, variants,
+        /* maxHeight= */ Infinity, /* maxWidth= */ Infinity);
+
+    if (maxHeight != Infinity || maxWidth != Infinity) {
+      const resolutions = SimpleAbrManager.getResolutionList_(sortedVariants);
+      for (const resolution of resolutions) {
+        if (resolution.height >= maxHeight && resolution.width >= maxWidth) {
+          maxHeight = resolution.height;
+          maxWidth = resolution.width;
+          break;
+        }
+      }
+
+      sortedVariants = SimpleAbrManager.filterAndSortVariants_(
+          this.config_.restrictions, variants, maxHeight, maxWidth);
+    }
 
     const defaultBandwidthEstimate = this.getDefaultBandwidth_();
     const currentBandwidth = this.bandwidthEstimator_.getBandwidthEstimate(
         defaultBandwidthEstimate);
 
-    if (this.variants_.length && !sortedVariants.length) {
+    if (variants.length && !sortedVariants.length) {
       // If we couldn't meet the ABR restrictions, we should still play
       // something.
       // These restrictions are not "hard" restrictions in the way that
@@ -205,7 +239,7 @@ shaka.abr.SimpleAbrManager = class {
       shaka.log.warning('No variants met the ABR restrictions. ' +
                         'Choosing a variant by lowest bandwidth.');
       sortedVariants = SimpleAbrManager.filterAndSortVariants_(
-          /* restrictions= */ null, this.variants_,
+          /* restrictions= */ null, variants,
           /* maxHeight= */ Infinity, /* maxWidth= */ Infinity);
       sortedVariants = [sortedVariants[0]];
     }
@@ -268,7 +302,7 @@ shaka.abr.SimpleAbrManager = class {
    * @override
    * @export
    */
-  segmentDownloaded(deltaTimeMs, numBytes) {
+  segmentDownloaded(deltaTimeMs, numBytes, allowSwitch) {
     shaka.log.v2('Segment downloaded:',
         'deltaTimeMs=' + deltaTimeMs,
         'numBytes=' + numBytes,
@@ -277,7 +311,7 @@ shaka.abr.SimpleAbrManager = class {
     goog.asserts.assert(deltaTimeMs >= 0, 'expected a non-negative duration');
     this.bandwidthEstimator_.sample(deltaTimeMs, numBytes);
 
-    if ((this.lastTimeChosenMs_ != null) && this.enabled_) {
+    if (allowSwitch && (this.lastTimeChosenMs_ != null) && this.enabled_) {
       this.suggestStreams_();
     }
   }
@@ -435,6 +469,29 @@ shaka.abr.SimpleAbrManager = class {
       return v1.bandwidth - v2.bandwidth;
     });
   }
+
+  /**
+   * @param {!Array.<shaka.extern.Variant>} variants
+   * @return {!Array.<{height: number, width: number}>}
+   * @private
+   */
+  static getResolutionList_(variants) {
+    const resolutions = [];
+    for (const variant of variants) {
+      const video = variant.video;
+      if (!video || !video.height || !video.width) {
+        continue;
+      }
+      resolutions.push({
+        height: video.height,
+        width: video.width,
+      });
+    }
+
+    return resolutions.sort((v1, v2) => {
+      return v1.width - v2.width;
+    });
+  }
 };