shaka-player 4.4.3 → 4.5.0

package/externs/mediatailor.js

@@ -0,0 +1,193 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for Media Tailor.
+ * @externs
+ */
+
+
+/** @const */
+var mediaTailor = {};
+
+
+/**
+ * @typedef {{
+ *   manifestUrl: ?string,
+ *   trackingUrl: ?string
+ * }}
+ *
+ * @property {?string} manifestUrl
+ * @property {?string} trackingUrl
+ * @exportDoc
+ */
+mediaTailor.SessionResponse;
+
+
+/**
+ * @typedef {{
+ *   avails: !Array.<mediaTailor.AdBreak>
+ * }}
+ *
+ * @property {!Array.<mediaTailor.AdBreak>} avails
+ * @exportDoc
+ */
+mediaTailor.TrackingResponse;
+
+
+/**
+ * @typedef {{
+ *   adBreakTrackingEvents: !Array.<mediaTailor.TrackingEvent>,
+ *   ads: !Array.<mediaTailor.Ad>,
+ *   durationInSeconds: number,
+ *   nonLinearAdsList: !Array.<mediaTailor.Ad>,
+ *   startTimeInSeconds: number
+ * }}
+ *
+ * @property {!Array.<mediaTailor.TrackingEvent>} adBreakTrackingEvents
+ * @property {!Array.<mediaTailor.Ad>} ads
+ * @property {number} durationInSeconds
+ * @property {!Array.<mediaTailor.Ad>} nonLinearAdsList
+ * @property {number} startTimeInSeconds
+ * @exportDoc
+ */
+mediaTailor.AdBreak;
+
+
+/**
+ * @typedef {{
+ *   adId: string,
+ *   adParameters: string,
+ *   adSystem: string,
+ *   adTitle: string,
+ *   creativeId: string,
+ *   creativeSequence: string,
+ *   durationInSeconds: number,
+ *   skipOffset: ?number,
+ *   startTimeInSeconds: number,
+ *   nonLinearAdList: !Array.<mediaTailor.NonLinearAd>,
+ *   trackingEvents: !Array.<mediaTailor.TrackingEvent>
+ * }}
+ *
+ * @property {string} adId
+ * @property {string} adParameters
+ * @property {string} adSystem
+ * @property {string} adTitle
+ * @property {string} creativeId
+ * @property {string} creativeSequence
+ * @property {number} durationInSeconds
+ * @property {?number} skipOffset
+ * @property {number} startTimeInSeconds
+ * @property {!Array.<mediaTailor.NonLinearAd>} nonLinearAdList
+ * @property {!Array.<mediaTailor.TrackingEvent>} trackingEvents
+ * @exportDoc
+ */
+mediaTailor.Ad;
+
+
+/**
+ * @typedef {{
+ *   adId: string,
+ *   adParameters: string,
+ *   adSystem: string,
+ *   adTitle: string,
+ *   creativeAdId: string,
+ *   creativeId: string,
+ *   creativeSequence: string,
+ *   height: ?number,
+ *   width: ?number,
+ *   staticResource: string
+ * }}
+ *
+ * @property {string} adId
+ * @property {string} adParameters
+ * @property {string} adSystem
+ * @property {string} adTitle
+ * @property {string} creativeAdId
+ * @property {string} creativeId
+ * @property {string} creativeSequence
+ * @property {?number} height
+ * @property {?number} width
+ * @property {string} staticResource
+ * @exportDoc
+ */
+mediaTailor.NonLinearAd;
+
+
+/**
+ * @typedef {{
+ *   beaconUrls: !Array.<string>,
+ *   eventType: string
+ * }}
+ *
+ * @property {!Array.<string>} beaconUrls
+ * @property {string} eventType
+ * @exportDoc
+ */
+mediaTailor.TrackingEvent;
+
+
+/** @const */
+var mediaTailorExternalResource = {};
+
+
+/**
+ * @typedef {{
+ *   apps: !Array.<mediaTailorExternalResource.App>
+ * }}
+ *
+ * @property {!Array.<mediaTailorExternalResource.App>} apps
+ * @exportDoc
+ */
+mediaTailorExternalResource.Response;
+
+
+/**
+ * @typedef {{
+ *   placeholder: mediaTailorExternalResource.AppPlaceholder,
+ *   data: mediaTailorExternalResource.AppData
+ * }}
+ *
+ * @property {mediaTailorExternalResource.AppPlaceholder} placeholder
+ * @property {mediaTailorExternalResource.AppData} data
+ * @exportDoc
+ */
+mediaTailorExternalResource.App;
+
+
+/**
+ * @typedef {{
+ *   left: number,
+ *   top: number
+ * }}
+ *
+ * @property {number} left
+ * @property {number} top
+ * @exportDoc
+ */
+mediaTailorExternalResource.AppPlaceholder;
+
+
+/**
+ * @typedef {{
+ *   source: !Array.<mediaTailorExternalResource.AppDataSource>
+ * }}
+ *
+ * @property {!Array.<mediaTailorExternalResource.AppDataSource>} source
+ * @exportDoc
+ */
+mediaTailorExternalResource.AppData;
+
+
+/**
+ * @typedef {{
+ *   url: string
+ * }}
+ *
+ * @property {string} url
+ * @exportDoc
+ */
+mediaTailorExternalResource.AppDataSource;

package/externs/pictureinpicture.js

@@ -97,3 +97,14 @@ DocumentPictureInPicture.prototype.dispatchEvent = function(event) {};
  * @type {!DocumentPictureInPicture}
  */
 Window.prototype.documentPictureInPicture;
+
+
+/**
+ * @constructor
+ * @extends {Event}
+ */
+function DocumentPictureInPictureEvent() {}
+
+
+/** @type {Window} */
+DocumentPictureInPictureEvent.prototype.window;

package/externs/shaka/ads.js

@@ -94,6 +94,21 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   updateClientSideAdsRenderingSettings(adsRenderingSettings) {}
 
+  /**
+   * @param {!HTMLElement} adContainer
+   * @param {!shaka.net.NetworkingEngine} networkingEngine
+   * @param {!HTMLMediaElement} video
+   */
+  initMediaTailor(adContainer, networkingEngine, video) {}
+
+  /**
+   * @param {string} url
+   * @param {Object} adsParams
+   * @param {string=} backupUrl
+   * @return {!Promise.<string>}
+   */
+  requestMediaTailorStream(url, adsParams, backupUrl) {}
+
   /**
    * @param {!HTMLElement} adContainer
    * @param {!HTMLMediaElement} video
@@ -117,6 +132,11 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   getServerSideCuePoints() {}
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   */
+  getCuePoints() {}
+
   /**
    * Get statistics for the current playback session. If the player is not
    * playing content, this will return an empty stats object.
@@ -128,6 +148,13 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   onDashTimedMetadata(region) {}
 
+  /**
+   * Fired when the manifest is updated.
+   *
+   * @param {boolean} isLive
+   */
+  onManifestUpdated(isLive) {}
+
   /**
    * @param {shaka.extern.ID3Metadata} metadata
    * @param {number} timestampOffset

package/externs/shaka/manifest.js

@@ -318,10 +318,10 @@ shaka.extern.CreateSegmentIndexFunction;
  * }}
  *
  * @description
- * AES-128 key and iv info from the HLS manifest.
+ * AES-128 key and iv info from the manifest.
  *
  * @property {string} method
- *   The key method defined in the HLS manifest.
+ *   The key method defined in the manifest.
  * @property {webCrypto.CryptoKey|undefined} cryptoKey
  *   Web crypto key object of the AES-128 CBC key. If unset, the "fetchKey"
  *   property should be provided.
@@ -330,15 +330,15 @@ shaka.extern.CreateSegmentIndexFunction;
  *   Should be provided if the "cryptoKey" property is unset.
  *   Should update this object in-place, to set "cryptoKey".
  * @property {(!Uint8Array|undefined)} iv
- *   The IV in the HLS manifest, if defined. See HLS RFC 8216 Section 5.2 for
- *   handling undefined IV.
+ *   The IV in the manifest, if defined. For HLS see HLS RFC 8216 Section 5.2
+ *   for handling undefined IV.
  * @property {number} firstMediaSequenceNumber
  *   The starting Media Sequence Number of the playlist, used when IV is
  *   undefined.
  *
  * @exportDoc
  */
-shaka.extern.HlsAes128Key;
+shaka.extern.aes128Key;
 
 
 /**
@@ -355,6 +355,7 @@ shaka.extern.FetchCryptoKeysFunction;
  * @typedef {{
  *   id: number,
  *   originalId: ?string,
+ *   groupId: ?string,
  *   createSegmentIndex: shaka.extern.CreateSegmentIndexFunction,
  *   closeSegmentIndex: (function()|undefined),
  *   segmentIndex: shaka.media.SegmentIndex,
@@ -403,6 +404,10 @@ shaka.extern.FetchCryptoKeysFunction;
  *   The original ID, if any, that appeared in the manifest.  For example, in
  *   DASH, this is the "id" attribute of the Representation element.  In HLS,
  *   this is the "NAME" attribute.
+ * @property {?string} groupId
+ *   <i>Optional.</i> <br>
+ *   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 {shaka.extern.CreateSegmentIndexFunction} createSegmentIndex
  *   <i>Required.</i> <br>
  *   Creates the Stream's segmentIndex (asynchronously).

package/externs/shaka/manifest_parser.js

@@ -109,7 +109,9 @@ shaka.extern.ManifestParser = class {
  *   isAutoLowLatencyMode: function():boolean,
  *   enableLowLatencyMode: function(),
  *   updateDuration: function(),
- *   newDrmInfo: function(shaka.extern.Stream)
+ *   newDrmInfo: function(shaka.extern.Stream),
+ *   onManifestUpdated: function(),
+ *   getBandwidthEstimate: function():number
  * }}
  *
  * @description
@@ -144,6 +146,10 @@ shaka.extern.ManifestParser = class {
  * @property {function(shaka.extern.Stream)} newDrmInfo
  *   Inform the player of new DRM info that needs to be processed for the given
  *   stream.
+ * @property {function()} onManifestUpdated
+ *   Should be called when the manifest is updated.
+ * @property {function():number} getBandwidthEstimate
+ *   Get the estimated bandwidth in bits per second.
  * @exportDoc
  */
 shaka.extern.ManifestParser.PlayerInterface;

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,
@@ -146,6 +147,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

package/externs/shaka/player.js

@@ -841,7 +841,8 @@ shaka.extern.InitDataTransform;
  *   ignoreMaxSegmentDuration: boolean,
  *   keySystemsByURI: !Object.<string, string>,
  *   manifestPreprocessor: function(!Element),
- *   sequenceMode: boolean
+ *   sequenceMode: boolean,
+ *   enableAudioGroups: boolean
  * }}
  *
  * @property {string} clockSyncUri
@@ -899,6 +900,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;
@@ -1225,6 +1230,7 @@ shaka.extern.StreamingConfiguration;
 
 /**
  * @typedef {{
+ *   codecSwitchingStrategy: shaka.config.CodecSwitchingStrategy,
  *   sourceBufferExtraFeatures: string,
  *   forceTransmux: boolean,
 *    insertFakeEncryptionInInit: boolean
@@ -1233,6 +1239,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.

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

@@ -184,13 +184,30 @@ 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);
     }
 
     // Get sorted Variants.
     let sortedVariants = SimpleAbrManager.filterAndSortVariants_(
-        this.config_.restrictions, this.variants_, maxHeight, maxWidth);
+        this.config_.restrictions, this.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, this.variants_, maxHeight, maxWidth);
+    }
 
     const defaultBandwidthEstimate = this.getDefaultBandwidth_();
     const currentBandwidth = this.bandwidthEstimator_.getBandwidthEstimate(
@@ -435,6 +452,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;
+    });
+  }
 };