shaka-player 4.2.5 → 4.3.1

package/externs/shaka/player.js

@@ -438,20 +438,63 @@ shaka.extern.DrmSupportType;
  */
 shaka.extern.SupportType;
 
-
 /**
- * @typedef {!Object.<string, ?>}
+ * @typedef {{
+ *   cueTime: ?number,
+ *   data: !Uint8Array,
+ *   frames: !Array.<shaka.extern.MetadataFrame>,
+ *   dts: ?number,
+ *   pts: ?number
+ * }}
  *
  * @description
  * ID3 metadata in format defined by
  * https://id3.org/id3v2.3.0#Declared_ID3v2_frames
  * The content of the field.
  *
+ * @property {?number} cueTime
+ * @property {!Uint8Array} data
+ * @property {!Array.<shaka.extern.MetadataFrame>} frames
+ * @property {?number} dts
+ * @property {?number} pts
+ *
  * @exportDoc
  */
 shaka.extern.ID3Metadata;
 
 
+/**
+ * @typedef {{
+ *   type: string,
+ *   size: number,
+ *   data: Uint8Array
+ * }}
+ *
+ * @description metadata raw frame.
+ * @property {string} type
+ * @property {number} size
+ * @property {Uint8Array} data
+ * @exportDoc
+ */
+shaka.extern.MetadataRawFrame;
+
+
+/**
+ * @typedef {{
+ *   key: string,
+ *   data: (ArrayBuffer|string),
+ *   description: string
+ * }}
+ *
+ * @description metadata frame parsed.
+ * @property {string} key
+ * @property {ArrayBuffer|string} data
+ * @property {string} description
+ * @exportDoc
+ */
+shaka.extern.MetadataFrame;
+
+
 /**
  * @typedef {{
  *   schemeIdUri: string,
@@ -566,6 +609,24 @@ shaka.extern.MediaQualityInfo;
 shaka.extern.EmsgInfo;
 
 
+/**
+ * @typedef {{
+ *   wallClockTime: number,
+ *   programStartDate: Date
+ * }}
+ *
+ * @description
+ * Contains information about an PRFT MP4 box.
+ *
+ * @property {number} wallClockTime
+ *   A UTC timestamp corresponding to decoding time in milliseconds.
+ * @property {Date} programStartDate
+ *   The derived start date of the program.
+ * @exportDoc
+ */
+shaka.extern.ProducerReferenceTime;
+
+
 /**
  * @typedef {{
  *   distinctiveIdentifierRequired: boolean,
@@ -646,7 +707,7 @@ shaka.extern.AdvancedDrmConfiguration;
  *   <code>{'com.widevine.alpha': 'https://example.com/drm'}</code>.
  * @property {!Object.<string, string>} clearKeys
  *   <i>Forces the use of the Clear Key CDM.</i>
- *   A map of key IDs (hex) to keys (hex).
+ *   A map of key IDs (hex or base64) to keys (hex or base64).
  * @property {boolean} delayLicenseRequestUntilPlayed
  *   <i>Defaults to false.</i> <br>
  *   True to configure drm to delay sending a license request until a user
@@ -701,7 +762,8 @@ shaka.extern.DrmConfiguration;
  *   ignoreEmptyAdaptationSet: boolean,
  *   ignoreMaxSegmentDuration: boolean,
  *   keySystemsByURI: !Object.<string, string>,
- *   manifestPreprocessor: function(!Element)
+ *   manifestPreprocessor: function(!Element),
+ *   sequenceMode: boolean
  * }}
  *
  * @property {string} clockSyncUri
@@ -755,6 +817,10 @@ shaka.extern.DrmConfiguration;
  *   Called immediately after the DASH manifest has been parsed into an
  *   XMLDocument. Provides a way for applications to perform efficient
  *   preprocessing of the manifest.
+ * @property {boolean} sequenceMode
+ *   If true, the media segments are appended to the SourceBuffer in
+ *   "sequence mode" (ignoring their internal timestamps).
+ *   <i>Defaults to <code>false</code>.</i>
  * @exportDoc
  */
 shaka.extern.DashManifestConfiguration;
@@ -767,7 +833,9 @@ shaka.extern.DashManifestConfiguration;
  *   defaultAudioCodec: string,
  *   defaultVideoCodec: string,
  *   ignoreManifestProgramDateTime: boolean,
- *   mediaPlaylistFullMimeType: string
+ *   mediaPlaylistFullMimeType: string,
+ *   useSafariBehaviorForLive: boolean,
+ *   liveSegmentsDelay: number
  * }}
  *
  * @property {boolean} ignoreTextStreamFailures
@@ -798,6 +866,16 @@ shaka.extern.DashManifestConfiguration;
  *   format this value.
  *   <i>Defaults to
  *   <code>'video/mp2t; codecs="avc1.42E01E, mp4a.40.2"'</code>.</i>
+ * @property {boolean} useSafariBehaviorForLive
+ *   If this is true, playback will set the availability window to the
+ *   presentation delay. The player will be able to buffer ahead three
+ *   segments, but the seek window will be zero-sized, to be consistent with
+ *   Safari. If this is false, the seek window will be the entire duration.
+ *   <i>Defaults to <code>true</code>.</i>
+ * @property {number} liveSegmentsDelay
+ *   The default presentation delay will be calculated as a number of segments.
+ *   This is the number of segments for this calculation..
+ *   <i>Defaults to <code>3</code>.</i>
  * @exportDoc
  */
 shaka.extern.HlsManifestConfiguration;
@@ -870,7 +948,7 @@ shaka.extern.ManifestConfiguration;
  *   startAtSegmentBoundary: boolean,
  *   gapDetectionThreshold: number,
  *   durationBackoff: number,
- *   forceTransmuxTS: boolean,
+ *   forceTransmux: boolean,
  *   safeSeekOffset: number,
  *   stallEnabled: boolean,
  *   stallThreshold: number,
@@ -884,7 +962,8 @@ shaka.extern.ManifestConfiguration;
  *   updateIntervalSeconds: number,
  *   dispatchAllEmsgBoxes: boolean,
  *   observeQualityChanges: boolean,
- *   maxDisabledTime: number
+ *   maxDisabledTime: number,
+ *   parsePrftBox: boolean
  * }}
  *
  * @description
@@ -932,12 +1011,12 @@ shaka.extern.ManifestConfiguration;
  *   seek to when the user tries to seek to or start playback at the duration.
  *   To disable this behavior, the config can be set to 0.  We recommend using
  *   the default value unless you have a good reason not to.
- * @property {boolean} forceTransmuxTS
- *   If this is <code>true</code>, we will transmux TS content even if not
- *   strictly necessary for the assets to be played.  Shaka Player currently
- *   only supports CEA 708 captions by transmuxing, so this value is necessary
- *   for enabling them on platforms with native TS support like Edge or
- *   Chromecast. This value defaults to <code>false</code>.
+ * @property {boolean} forceTransmux
+ *   If this is <code>true</code>, we will transmux AAC and TS content even if
+ *   not strictly necessary for the assets to be played.  Shaka Player
+ *   currently only supports CEA 708 captions by transmuxing, so this value is
+ *   necessary for enabling them on platforms with native TS support like Edge
+ *   or Chromecast. This value defaults to <code>false</code>.
  * @property {number} safeSeekOffset
  *   The amount of seconds that should be added when repositioning the playhead
  *   after falling out of the availability window or seek. This gives the player
@@ -993,11 +1072,35 @@ shaka.extern.ManifestConfiguration;
  *   The maximum time a variant can be disabled when NETWORK HTTP_ERROR
  *   is reached, in seconds.
  *   If all variants are disabled this way, NETWORK HTTP_ERROR will be thrown.
+ * @property {boolean} parsePrftBox
+ *   If <code>true</code>, will raise a shaka.extern.ProducerReferenceTime
+ *   player event (event name 'prft').
+ *   The event will be raised only once per playback session as program
+ *   start date will not change, and would save parsing the segment multiple
+ *   times needlessly.
+ *   Defaults to <code>false</code>.
  * @exportDoc
  */
 shaka.extern.StreamingConfiguration;
 
 
+/**
+ * @typedef {{
+ *   sourceBufferExtraFeatures: string
+ * }}
+ *
+ * @description
+ *   Media source configuration.
+ *
+ * @property {string} sourceBufferExtraFeatures
+ *   Some platforms may need to pass features when initializing the
+ *   sourceBuffer.
+ *   This string is ultimately appended to MIME types in addSourceBuffer().
+ * @exportDoc
+ */
+shaka.extern.MediaSourceConfiguration;
+
+
 /**
  * @typedef {{
  *   enabled: boolean,
@@ -1009,6 +1112,7 @@ shaka.extern.StreamingConfiguration;
  *   bandwidthDowngradeTarget: number,
  *   advanced: shaka.extern.AdvancedAbrConfiguration,
  *   restrictToElementSize: boolean,
+ *   restrictToScreenSize: boolean,
  *   ignoreDevicePixelRatio: boolean
  * }}
  *
@@ -1044,9 +1148,12 @@ shaka.extern.StreamingConfiguration;
  *   Note: The use of ResizeObserver is required for it to work properly. If
  *   true without ResizeObserver, it behaves as false.
  *   Defaults false.
+ * @property {boolean} restrictToScreenSize
+ *   If true, restrict the quality to screen size.
+ *   Defaults false.
  * @property {boolean} ignoreDevicePixelRatio
  *   If true,device pixel ratio is ignored when restricting the quality to
- *   media element size.
+ *   media element size or screen size.
  *   Defaults false.
  * @exportDoc
  */
@@ -1115,6 +1222,49 @@ shaka.extern.AdvancedAbrConfiguration;
  */
 shaka.extern.CmcdConfiguration;
 
+/**
+ * @typedef {{
+ *   enabled: boolean,
+ *   dynamicPerformanceScaling: boolean,
+ *   logLevel: number,
+ *   drawLogo: boolean
+ * }}
+ *
+ * @description
+ *   Decoding for MPEG-5 Part2 LCEVC.
+ *
+ * @property {boolean} enabled
+ *   If <code>true</code>, enable LCEVC.
+ *   Defaults to <code>false</code>.
+ * @property {boolean} dynamicPerformanceScaling
+ *   If <code>true</code>, LCEVC Dynamic Performance Scaling or dps is enabled
+ *   to be triggered, when the system is not able to decode frames within a
+ *   specific tolerance of the fps of the video and disables LCEVC decoding
+ *   for some time. The base video will be shown upscaled to target resolution.
+ *   If it is triggered again within a short period of time, the disabled
+ *   time will be higher and if it is triggered three times in a row the LCEVC
+ *   decoding will be disabled for that playback session.
+ *   If dynamicPerformanceScaling is false, LCEVC decode will be forced
+ *   and will drop frames appropriately if performance is sub optimal.
+ *   Defaults to <code>true</code>.
+ * @property {number} logLevel
+ *   Loglevel 0-5 for logging.
+ *   NONE = 0
+ *   ERROR = 1
+ *   WARNING = 2
+ *   INFO = 3
+ *   DEBUG = 4
+ *   VERBOSE = 5
+ *   Defaults to <code>0</code>.
+ * @property {boolean} drawLogo
+ *   If <code>true</code>, LCEVC Logo is placed on the top left hand corner
+ *   which only appears when the LCEVC enhanced frames are being rendered.
+ *   Defaults to true for the lib but is forced to false in this integration
+ *   unless explicitly set to true through config.
+ *   Defaults to <code>false</code>.
+ * @exportDoc
+ */
+shaka.extern.LcevcConfiguration;
 
 /**
  * @typedef {{
@@ -1158,12 +1308,15 @@ shaka.extern.OfflineConfiguration;
 
 /**
  * @typedef {{
+ *   autoShowText: shaka.config.AutoShowText,
  *   drm: shaka.extern.DrmConfiguration,
  *   manifest: shaka.extern.ManifestConfiguration,
  *   streaming: shaka.extern.StreamingConfiguration,
+ *   mediaSource: shaka.extern.MediaSourceConfiguration,
  *   abrFactory: shaka.extern.AbrManager.Factory,
  *   abr: shaka.extern.AbrConfiguration,
  *   cmcd: shaka.extern.CmcdConfiguration,
+ *   lcevc: shaka.extern.LcevcConfiguration,
  *   offline: shaka.extern.OfflineConfiguration,
  *   preferredAudioLanguage: string,
  *   preferredTextLanguage: string,
@@ -1180,18 +1333,25 @@ shaka.extern.OfflineConfiguration;
  *   textDisplayFactory: shaka.extern.TextDisplayer.Factory
  * }}
  *
+ * @property {shaka.config.AutoShowText} autoShowText
+ *   Controls behavior of auto-showing text tracks on load().
  * @property {shaka.extern.DrmConfiguration} drm
  *   DRM configuration and settings.
  * @property {shaka.extern.ManifestConfiguration} manifest
  *   Manifest configuration and settings.
  * @property {shaka.extern.StreamingConfiguration} streaming
  *   Streaming configuration and settings.
+ * @property {shaka.extern.MediaSourceConfiguration} mediaSource
+ *   Media source configuration and settings.
  * @property {shaka.extern.AbrManager.Factory} abrFactory
  *   A factory to construct an abr manager.
  * @property {shaka.extern.AbrConfiguration} abr
  *   ABR configuration and settings.
  * @property {shaka.extern.CmcdConfiguration} cmcd
  *   CMCD configuration and settings. (Common Media Client Data)
+ * @property {shaka.extern.LcevcConfiguration} lcevc
+ *   MPEG-5 LCEVC configuration and settings.
+ *   (Low Complexity Enhancement Video Codec)
  * @property {shaka.extern.OfflineConfiguration} offline
  *   Offline configuration and settings.
  * @property {string} preferredAudioLanguage
@@ -1269,7 +1429,8 @@ shaka.extern.LanguageRole;
  *   startTime: number,
  *   duration: number,
  *   uris: !Array.<string>,
- *   width: number
+ *   width: number,
+ *   sprite: boolean
  * }}
  *
  * @property {number} imageHeight
@@ -1293,6 +1454,8 @@ shaka.extern.LanguageRole;
  *   given.
  * @property {number} width
  *    The thumbnail width in px.
+ * @property {boolean} sprite
+ *    Indicate if the thumbnail is a sprite.
  * @exportDoc
  */
 shaka.extern.Thumbnail;

package/lib/abr/simple_abr_manager.js

@@ -148,6 +148,13 @@ shaka.abr.SimpleAbrManager = class {
     let maxHeight = Infinity;
     let maxWidth = Infinity;
 
+    if (this.config_.restrictToScreenSize) {
+      const devicePixelRatio =
+          this.config_.ignoreDevicePixelRatio ? 1 : window.devicePixelRatio;
+      maxHeight = window.screen.height * devicePixelRatio;
+      maxWidth = window.screen.width * devicePixelRatio;
+    }
+
     if (this.resizeObserver_ && this.config_.restrictToElementSize) {
       const devicePixelRatio =
           this.config_.ignoreDevicePixelRatio ? 1 : window.devicePixelRatio;

package/lib/ads/ad_manager.js

@@ -640,10 +640,6 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   onHlsTimedMetadata(metadata, timestamp) {
     if (this.ssAdManager_) {
       this.ssAdManager_.onTimedMetadata('ID3', metadata['data'], timestamp);
-    } else {
-      shaka.log.warning('ID3 metadata processing was called without ' +
-        'initializing server side ad logic. Ad-related metadata will ' +
-        'not take effect');
     }
   }
 
@@ -654,10 +650,6 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   onCueMetadataChange(value) {
     if (this.ssAdManager_) {
       this.ssAdManager_.onCueMetadataChange(value);
-    } else {
-      shaka.log.warning('ID3 metadata processing was called without ' +
-        'initializing server side ad logic. Ad-related metadata will ' +
-        'not take effect');
     }
   }
 };

package/lib/ads/client_side_ad.js

@@ -236,6 +236,21 @@ shaka.ads.ClientSideAd = class {
     return podInfo.getAdPosition();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getTitle() {
+    return this.ad_.getTitle();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getDescription() {
+    return this.ad_.getDescription();
+  }
 
   /**
    * @override

package/lib/ads/client_side_ad_manager.js

@@ -323,22 +323,25 @@ shaka.ads.ClientSideAdManager = class {
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.PAUSED, (e) => {
-          goog.asserts.assert(this.ad_ != null, 'Ad should not be null!');
-          this.ad_.setPaused(true);
-          convertEventAndSend(e, shaka.ads.AdManager.AD_PAUSED);
+          if (this.ad_) {
+            this.ad_.setPaused(true);
+            convertEventAndSend(e, shaka.ads.AdManager.AD_PAUSED);
+          }
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.RESUMED, (e) => {
-          goog.asserts.assert(this.ad_ != null, 'Ad should not be null!');
-          this.ad_.setPaused(false);
-          convertEventAndSend(e, shaka.ads.AdManager.AD_RESUMED);
+          if (this.ad_) {
+            this.ad_.setPaused(false);
+            convertEventAndSend(e, shaka.ads.AdManager.AD_RESUMED);
+          }
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.SKIPPABLE_STATE_CHANGED, (e) => {
-          goog.asserts.assert(this.ad_ != null, 'Ad should not be null!');
-          convertEventAndSend(e, shaka.ads.AdManager.AD_SKIP_STATE_CHANGED);
+          if (this.ad_) {
+            convertEventAndSend(e, shaka.ads.AdManager.AD_SKIP_STATE_CHANGED);
+          }
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
@@ -416,6 +419,16 @@ shaka.ads.ClientSideAdManager = class {
         'Should have an ads manager at this point!');
 
     const imaAd = e.getAd();
+    if (!imaAd) {
+      // Sometimes the IMA SDK will fire a CONTENT_PAUSE_REQUESTED or STARTED
+      // event with no associated ad object.
+      // We can't really play an ad in that situation, so just ignore the event.
+      shaka.log.alwaysWarn(
+          'The IMA SDK fired a ' + e.type + ' event with no associated ad. ' +
+          'Unable to play ad!');
+      return;
+    }
+
     this.ad_ = new shaka.ads.ClientSideAd(imaAd,
         this.imaAdsManager_, this.video_);
     const data = new Map()

package/lib/ads/server_side_ad.js

@@ -205,6 +205,21 @@ shaka.ads.ServerSideAd = class {
     return podInfo.getAdPosition();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getTitle() {
+    return this.ad_.getTitle();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getDescription() {
+    return this.ad_.getDescription();
+  }
 
   /**
    * @override

package/lib/ads/server_side_ad_manager.js

@@ -237,7 +237,7 @@ shaka.ads.ServerSideAdManager = class {
   }
 
   /**
-   * @param {shaka.extern.ID3Metadata} value
+   * @param {shaka.extern.MetadataFrame} value
    */
   onCueMetadataChange(value) {
     // Native HLS over Safari/iOS/iPadOS
@@ -246,9 +246,9 @@ shaka.ads.ServerSideAdManager = class {
     // done through timed metadata. Timed metadata is carried as part of the
     // DAI stream content and carries ad break timing information used by the
     // SDK to track ad breaks.
-    if (value['key'] && value['data']) {
+    if (value.key && value.data) {
       const metadata = {};
-      metadata[value['key']] = value['data'];
+      metadata[value.key] = value.data;
       this.streamManager_.onTimedMetadata(metadata);
     }
   }

package/lib/cast/cast_utils.js

@@ -384,6 +384,7 @@ shaka.cast.CastUtils.PlayerInitAfterLoadState = [
 shaka.cast.CastUtils.PlayerVoidMethods = [
   'addChaptersTrack',
   'addTextTrackAsync',
+  'addThumbnailsTrack',
   'cancelTrickPlay',
   'configure',
   'getChapters',
@@ -408,6 +409,7 @@ shaka.cast.CastUtils.PlayerVoidMethods = [
  */
 shaka.cast.CastUtils.PlayerPromiseMethods = [
   'attach',
+  'attachCanvas',
   'detach',
   // The manifestFactory parameter of load is not supported.
   'load',

package/lib/cea/dummy_cea_parser.js

@@ -0,0 +1,28 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+goog.provide('shaka.cea.DummyCeaParser');
+
+goog.require('shaka.cea.ICeaParser');
+
+/**
+ * Dummy CEA parser.
+ * @implements {shaka.cea.ICeaParser}
+ */
+shaka.cea.DummyCeaParser = class {
+  /**
+   * @override
+   */
+  init(initSegment) {
+  }
+
+  /**
+   * @override
+   */
+  parse(mediaSegment) {
+    return /* captionPackets= */ [];
+  }
+};

package/lib/cea/i_cea_parser.js

@@ -26,10 +26,22 @@ shaka.cea.ICeaParser = class {
 };
 
 /**
- * NALU type for Supplemental Enhancement Information (SEI).
+ * NALU type for Supplemental Enhancement Information (SEI) for H.264.
  * @const {number}
  */
-shaka.cea.ICeaParser.NALU_TYPE_SEI = 0x06;
+shaka.cea.ICeaParser.H264_NALU_TYPE_SEI = 0x06;
+
+/**
+ * NALU type for Supplemental Enhancement Information (SEI) for H.265.
+ * @const {number}
+ */
+shaka.cea.ICeaParser.H265_PREFIX_NALU_TYPE_SEI = 0x27;
+
+/**
+ * NALU type for Supplemental Enhancement Information (SEI) for H.265.
+ * @const {number}
+ */
+shaka.cea.ICeaParser.H265_SUFFIX_NALU_TYPE_SEI = 0x28;
 
 /**
  * Default timescale value for a track.