shaka-player 4.3.10 → 4.4.0

package/externs/isoboxer.js

@@ -0,0 +1,217 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for codem-isoboxer library.
+ * @externs
+ */
+
+
+/**
+ * @typedef {{
+ *   Utils: !ISOBoxerUtils,
+ *   parseBuffer: function(!(ArrayBuffer|ArrayBufferView)):!ISOBoxer,
+ *   createBox: function(string, !ISOBoxer, boolean=):!ISOBoxer,
+ *   createFullBox: function(string, !ISOBoxer, ?ISOBoxer=):!ISOBoxer,
+ *   addBoxProcessor: function(string, function()):!ISOBoxer,
+ *   createFile: function():!ISOBoxer,
+ *   write: function():!ArrayBuffer,
+ *   fetch: function(!ArrayBuffer):!ISOBoxer
+ * }}
+ * @property {!ISOBoxerUtils} Utils
+ * @property {function(!(ArrayBuffer|ArrayBufferView)):!ISOBoxer} parseBuffer
+ * @property {function(string, !ISOBoxer, boolean=):!ISOBoxer} createBox
+ * @property {function(string, !ISOBoxer, ?ISOBoxer=):!ISOBoxer} createFullBox
+ * @property {function(string, function()):!ISOBoxer} addBoxProcessor
+ * @property {function():!ISOBoxer} createFile
+ * @property {function():!ArrayBuffer} write
+ * @property {function(!ArrayBuffer):!ISOBoxer} fetch
+ * @const
+ */
+var ISOBoxer;
+
+
+/**
+ * @typedef {{
+ *   appendBox: function(!ISOBoxer, !ISOBoxer):!ISOBox
+ * }}
+ * @const
+ */
+var ISOBoxerUtils;
+
+
+/**
+ * @typedef {{
+ *   _parsing: boolean,
+ *   type: string,
+ *   size: number,
+ *   _parent: ISOBox,
+ *   boxes: !Array.<!ISOBox>,
+ *   entry: !Array.<!Object>,
+ *   version: !number,
+ *   flags: !number,
+ *   sample_count: !number,
+ *   default_sample_info_size: !number,
+ *   entry_count: !number,
+ *   getLength: function():number,
+ *   _procFullBox: function(),
+ *   _procField: function(!string, !string, !number),
+ *   _procFieldArray: function(!string, !number, !string, !number),
+ *   _procEntries: function(!string, !number, !function(!ISOEntry)),
+ *   _procEntryField: function(!ISOBox, !string, !string, !number),
+ *   _procSubEntries: function(!ISOBox, !string, !number, !function(!ISOEntry)),
+ *   major_brand: string,
+ *   minor_version: number,
+ *   compatible_brands: Array.<string>,
+ *   _data: Array.<number>,
+ *   creation_time: number,
+ *   modification_time: number,
+ *   timescale: number,
+ *   duration: number,
+ *   rate: number,
+ *   volume: number,
+ *   reserved1: number,
+ *   reserved2: (Array.<number>|number),
+ *   matrix: Array.<number>,
+ *   pre_defined: (Array.<number>|number),
+ *   next_track_ID: number,
+ *   track_ID: number,
+ *   layer: number,
+ *   alternate_group: number,
+ *   reserved3: number,
+ *   width: number,
+ *   height: number,
+ *   language: string,
+ *   handler_type: string,
+ *   name: string,
+ *   reserved: Array.<number>,
+ *   graphicsmode: number,
+ *   opcolor: Array.<number>,
+ *   balance: number,
+ *   entries: Array.<!ISOBox>,
+ *   location: string,
+ *   data_reference_index: number,
+ *   pre_defined1: number,
+ *   pre_defined2: Array.<number>,
+ *   pre_defined3: number,
+ *   horizresolution: number,
+ *   vertresolution: number,
+ *   frame_count: number,
+ *   compressorname: Array.<number>,
+ *   depth: number,
+ *   config: Uint8Array,
+ *   channelcount: number,
+ *   samplesize: number,
+ *   reserved_3: number,
+ *   samplerate: number,
+ *   esds: Uint8Array,
+ *   data_format: number,
+ *   scheme_type: number,
+ *   scheme_version: number,
+ *   default_IsEncrypted: number,
+ *   default_IV_size: number,
+ *   default_KID: Array.<number>,
+ *   default_sample_description_index: number,
+ *   default_sample_duration: number,
+ *   default_sample_size: number,
+ *   default_sample_flags: number,
+ *   baseMediaDecodeTime: number,
+ *   usertype: ?string,
+ *   offset: Array.<number>,
+ *   sample_info_size: Array.<number>,
+ *   data_offset: number
+ * }}
+ * @property {boolean} _parsing
+ * @property {string} type
+ * @property {number} size
+ * @property {ISOBox} _parent
+ * @property {!Array.<!ISOBox>} boxes
+ * @property {!Array.<!ISOEntry>} entry
+ * @property {!number} version
+ * @property {!number} flags
+ * @property {!number} sample_count
+ * @property {!number} default_sample_info_size
+ * @property {!number} entry_count
+ * @property {function()} _procFullBox
+ * @property {function(!string, !string, !number)} _procField
+ * @property {function(!string, !number, !string, !number)} _procFieldArray
+ * @property {function(!string, !number, !function(!ISOEntry))} _procEntries
+ * @property {function(!ISOBox, !string, !string, !number)} _procEntryField
+ * @property {function(!ISOBox, !string, !number, !function(!ISOEntry))}
+ *    _procSubEntries
+ * @property {string} major_brand
+ * @property {number} minor_version
+ * @property {Array.<string>} compatible_brands
+ * @property {Array.<number>} _data
+ * @property {number} creation_time
+ * @property {number} modification_time
+ * @property {number} timescale
+ * @property {number} duration
+ * @property {number} rate
+ * @property {number} volume
+ * @property {number} reserved1
+ * @property {Array.<number>|number} reserved2
+ * @property {Array.<number>} matrix
+ * @property {Array.<number>|number} pre_defined
+ * @property {number} next_track_ID
+ * @property {number} track_ID
+ * @property {number} layer
+ * @property {number} alternate_group
+ * @property {number} reserved3
+ * @property {number} width
+ * @property {number} height
+ * @property {string} language
+ * @property {string} handler_type
+ * @property {string} name
+ * @property {Array.<number>} reserved
+ * @property {number} graphicsmode
+ * @property {Array.<number>} opcolor
+ * @property {number} balance
+ * @property {Array.<!ISOBox} entries
+ * @property {string} location
+ * @property {number} data_reference_index
+ * @property {number} pre_defined1
+ * @property {Array.<number>} pre_defined2
+ * @property {number} pre_defined3
+ * @property {number} horizresolution
+ * @property {number} vertresolution
+ * @property {number} frame_count
+ * @property {number} compressorname
+ * @property {number} depth
+ * @property {Uint8Array} config
+ * @property {number} channelcount
+ * @property {number} samplesize
+ * @property {number} reserved_3
+ * @property {number} samplerate
+ * @property {Uint8Array} esds
+ * @property {number} data_format
+ * @property {number} scheme_type
+ * @property {number} scheme_version
+ * @property {number} default_IsEncrypted
+ * @property {number} default_IV_size
+ * @property {Array.<number>} default_KID
+ * @property {number} default_sample_description_index
+ * @property {number} default_sample_duration
+ * @property {number} default_sample_size
+ * @property {number} default_sample_flags
+ * @property {number} baseMediaDecodeTime
+ * @property {?string} usertype
+ * @property {Array.<number} offset
+ * @property {Array.<number} sample_info_size
+ * @property {number} data_offset
+ * @const
+ */
+var ISOBox;
+
+
+/**
+ * @typedef {{
+ *   NumberOfEntries: number
+ * }}
+ * @property {number} NumberOfEntries
+ * @const
+ */
+var ISOEntry;

package/externs/mediakeys.js

@@ -0,0 +1,18 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for MediaKeys which were missing in the
+ * Closure compiler.
+ *
+ * @externs
+ */
+
+/**
+ * @param {Object} policy
+ * @return {!Promise.<string>}
+ */
+MediaKeys.prototype.getStatusForPolicy = function(policy) {};

package/externs/mux.js

@@ -23,29 +23,6 @@ var muxjs = {};
 muxjs.mp4 = {};
 
 
-/** @const */
-muxjs.mp4.probe = class {
-  /**
-   * Parses an MP4 initialization segment and extracts the timescale
-   * values for any declared tracks.
-   *
-   * @param {Uint8Array} init The bytes of the init segment
-   * @return {!Object.<number, number>} a hash of track ids to timescale
-   * values or null if the init segment is malformed.
-   */
-  static timescale(init) {}
-
-  /**
-    * Find the trackIds of the video tracks in this source.
-    * Found by parsing the Handler Reference and Track Header Boxes:
-    *
-    * @param {Uint8Array} init The bytes of the init segment for this source
-    * @return {!Array.<number>} A list of trackIds
-   **/
-  static videoTrackIds(init) {}
-};
-
-
 muxjs.mp4.Transmuxer = class {
   /** @param {Object=} options */
   constructor(options) {}
@@ -74,100 +51,19 @@ muxjs.mp4.Transmuxer = class {
 
   /** Remove all handlers and clean up. */
   dispose() {}
-
-  /** Reset captions. */
-  resetCaptions() {}
 };
 
 
 /**
  * @typedef {{
  *   initSegment: !Uint8Array,
- *   data: !Uint8Array,
- *   captions: !Array
+ *   data: !Uint8Array
  * }}
  *
  * @description Transmuxed data from mux.js.
  * @property {!Uint8Array} initSegment
  * @property {!Uint8Array} data
- * @property {!Array} captions
  * @exportDoc
  */
 muxjs.mp4.Transmuxer.Segment;
 
-
-muxjs.mp4.CaptionParser = class {
-  /**
-   * Parser for CEA closed captions embedded in video streams for Dash.
-   * @constructor
-   * @struct
-   */
-  constructor() {}
-
-  /** Initializes the closed caption parser. */
-  init() {}
-
-  /**
-   * Return true if a new video track is selected or if the timescale is
-   * changed.
-   * @param {!Array.<number>} videoTrackIds A list of video tracks found in the
-   *    init segment.
-   * @param {!Object.<number, number>} timescales The map of track Ids and the
-   *    tracks' timescales in the init segment.
-   * @return {boolean}
-   */
-  isNewInit(videoTrackIds, timescales) {}
-
-  /**
-   * Parses embedded CEA closed captions and interacts with the underlying
-   * CaptionStream, and return the parsed captions.
-   * @param {!Uint8Array} segment The fmp4 segment containing embedded captions
-   * @param {!Array.<number>} videoTrackIds A list of video tracks found in the
-   *    init segment.
-   * @param {!Object.<number, number>} timescales The timescales found in the
-   *    init segment.
-   * @return {muxjs.mp4.ParsedClosedCaptions}
-   */
-  parse(segment, videoTrackIds, timescales) {}
-
-  /** Clear the parsed closed captions data for new data. */
-  clearParsedCaptions() {}
-
-  /** Reset the captions stream. */
-  resetCaptionStream() {}
-};
-
-
-/**
- * @typedef {{
- *   captionStreams: Object.<string, boolean>,
- *   captions: !Array.<muxjs.mp4.ClosedCaption>
- * }}
- *
- * @description closed captions data parsed from mux.js caption parser.
- * @property {Object.<string, boolean>} captionStreams
- * @property {Array.<muxjs.mp4.ClosedCaption>} captions
- */
-muxjs.mp4.ParsedClosedCaptions;
-
-
-/**
- * @typedef {{
- *   startPts: number,
- *   endPts: number,
- *   startTime: number,
- *   endTime: number,
- *   stream: string,
- *   text: string
- * }}
- *
- * @description closed caption parsed from mux.js caption parser.
- * @property {number} startPts
- * @property {number} endPts
- * @property {number} startTime
- * @property {number} endTime
- * @property {string} stream The channel id of the closed caption.
- * @property {string} text The content of the closed caption.
- */
-muxjs.mp4.ClosedCaption;
-

package/externs/pictureinpicture.js

@@ -49,3 +49,51 @@ HTMLMediaElement.prototype.webkitSupportsPresentationMode = function(mode) {};
 
 /** @type {string} */
 HTMLMediaElement.prototype.webkitPresentationMode;
+
+
+/**
+ * @typedef {{
+ *   width: (number|undefined),
+ *   height: (number|undefined),
+ * }}
+ */
+var DocumentPictureInPictureOptions;
+
+
+/**
+ * @constructor
+ * @implements {EventTarget}
+ */
+function DocumentPictureInPicture() {}
+
+
+/**
+ * @param {DocumentPictureInPictureOptions} options
+ * @return {!Promise.<Window>}
+ */
+DocumentPictureInPicture.prototype.requestWindow = function(options) {};
+
+
+/** @type {Window} */
+DocumentPictureInPicture.prototype.window;
+
+
+/** @override */
+DocumentPictureInPicture.prototype.addEventListener =
+    function(type, listener, options) {};
+
+
+/** @override */
+DocumentPictureInPicture.prototype.removeEventListener =
+    function(type, listener, options) {};
+
+
+/** @override */
+DocumentPictureInPicture.prototype.dispatchEvent = function(event) {};
+
+
+/**
+ * @see https://wicg.github.io/document-picture-in-picture/#api
+ * @type {!DocumentPictureInPicture}
+ */
+Window.prototype.documentPictureInPicture;

package/externs/shaka/ads.js

@@ -64,6 +64,15 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   setLocale(locale) {}
 
+  /**
+   * Called by the Player to provide an updated configuration any time it
+   * changes.
+   * Must be called at least once before init*().
+   *
+   * @param {shaka.extern.AdsConfiguration} config
+   */
+  configure(config) {}
+
   release() {}
 
   onAssetUnload() {}
@@ -71,14 +80,20 @@ shaka.extern.IAdManager = class extends EventTarget {
   /**
    * @param {!HTMLElement} adContainer
    * @param {!HTMLMediaElement} video
+   * @param {?google.ima.AdsRenderingSettings} adsRenderingSettings
    */
-  initClientSide(adContainer, video) {}
+  initClientSide(adContainer, video, adsRenderingSettings) {}
 
   /**
    * @param {!google.ima.AdsRequest} imaRequest
    */
   requestClientSideAds(imaRequest) {}
 
+  /**
+   * @param {!google.ima.AdsRenderingSettings} adsRenderingSettings
+   */
+  updateClientSideAdsRenderingSettings(adsRenderingSettings) {}
+
   /**
    * @param {!HTMLElement} adContainer
    * @param {!HTMLMediaElement} video
@@ -237,4 +252,49 @@ shaka.extern.IAd = class {
    * @return {string}
    */
   getDescription() {}
+
+  /**
+   * @return {number}
+   */
+  getVastMediaBitrate() {}
+
+  /**
+   * @return {number}
+   */
+  getVastMediaHeight() {}
+
+  /**
+   * @return {number}
+   */
+  getVastMediaWidth() {}
+
+  /**
+   * @return {string}
+   */
+  getAdId() {}
+
+  /**
+   * @return {string}
+   */
+  getCreativeAdId() {}
+
+  /**
+   * @return {string}
+   */
+  getAdvertiserName() {}
+
+  /**
+   * @return {?string}
+   */
+  getMediaUrl() {}
+
+  /**
+   * @return {number}
+   */
+  getTimeOffset() {}
+
+  /**
+   * @return {number}
+   */
+  getPodIndex() {}
 };

package/externs/shaka/cea.js

@@ -0,0 +1,110 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+/**
+ * @externs
+ */
+
+/**
+ * Interface for parsing inband closed caption data from MP4 streams.
+ * @interface
+ * @exportDoc
+ */
+shaka.extern.ICeaParser = class {
+  /**
+   * Initializes the parser with init segment data.
+   * @param {!BufferSource} initSegment init segment to parse.
+   * @exportDoc
+   */
+  init(initSegment) {}
+
+  /**
+   * Parses the stream and extracts closed captions packets.
+   * @param {!BufferSource} mediaSegment media segment to parse.
+   * @return {!Array<!shaka.extern.ICeaParser.CaptionPacket>}
+   * @exportDoc
+   */
+  parse(mediaSegment) {}
+};
+
+/**
+ * @typedef {{
+ *   packet: !Uint8Array,
+ *   pts: number
+ * }}
+ *
+ * @description Parsed Caption Packet.
+ * @property {!Uint8Array} packet
+ * Caption packet. More specifically, it contains a "User data
+ * registered by Recommendation ITU-T T.35 SEI message", from section D.1.6
+ * and section D.2.6 of Rec. ITU-T H.264 (06/2019).
+ * @property {number} pts
+ * The presentation timestamp (pts) at which the ITU-T T.35 data shows up.
+ * in seconds.
+ * @exportDoc
+ */
+shaka.extern.ICeaParser.CaptionPacket;
+
+
+/**
+ * Interface for decoding inband closed captions from packets.
+ * @interface
+ * @exportDoc
+ */
+shaka.extern.ICaptionDecoder = class {
+  /**
+   * Extracts packets and prepares them for decoding. In a given media fragment,
+   * all the caption packets found in its SEI messages should be extracted by
+   * successive calls to extract(), followed by a single call to decode().
+   *
+   * @param {!Uint8Array} userDataSeiMessage
+   * This is a User Data registered by Rec.ITU-T T.35 SEI message.
+   * It is described in sections D.1.6 and D.2.6 of Rec. ITU-T H.264 (06/2019).
+   * @param {number} pts PTS when this packet was received, in seconds.
+   * @exportDoc
+   */
+  extract(userDataSeiMessage, pts) {}
+
+  /**
+   * Decodes all currently extracted packets and then clears them.
+   * This should be called once for a set of extracts (see comment on extract).
+   * @return {!Array.<!shaka.extern.ICaptionDecoder.ClosedCaption>}
+   * @exportDoc
+   */
+  decode() {}
+
+  /**
+   * Clears the decoder state completely.
+   * Should be used when an action renders the decoder state invalid,
+   * e.g. unbuffered seeks.
+   * @exportDoc
+   */
+  clear() {}
+};
+
+/**
+ * Parsed Cue.
+ * @typedef {{
+ *   cue: !shaka.text.Cue,
+ *   stream: string
+ * }}
+ *
+ * @exportDoc
+ */
+shaka.extern.ICaptionDecoder.ClosedCaption;
+
+/**
+ * @typedef {function():!shaka.extern.ICeaParser}
+ * @exportDoc
+ */
+shaka.extern.CeaParserPlugin;
+
+/**
+ * @typedef {function():!shaka.extern.ICaptionDecoder}
+ * @exportDoc
+ */
+shaka.extern.CaptionDecoderPlugin;

package/externs/shaka/codecs.js

@@ -0,0 +1,32 @@
+/**
+ * @typedef {{
+ *   data: Uint8Array,
+ *   packetLength: number,
+ *   pts: ?number,
+ *   dts: ?number
+ * }}
+ *
+ * @summary MPEG_PES.
+ * @property {Uint8Array} data
+ * @property {number} packetLength
+ * @property {?number} pts
+ * @property {?number} dts
+ */
+shaka.extern.MPEG_PES;
+
+
+/**
+ * @typedef {{
+ *   data: !Uint8Array,
+ *   fullData: !Uint8Array,
+ *   type: number,
+ *   time: ?number
+ * }}
+ *
+ * @summary VideoNalu.
+ * @property {!Uint8Array} data
+ * @property {!Uint8Array} fullData
+ * @property {number} type
+ * @property {?number} time
+ */
+shaka.extern.VideoNalu;