shaka-player 3.2.2 → 3.3.2

package/externs/shaka/net.js

@@ -101,6 +101,7 @@ shaka.extern.Request;
  * @typedef {{
  *   uri: string,
  *   data: BufferSource,
+ *   status: (number|undefined),
  *   headers: !Object.<string, string>,
  *   timeMs: (number|undefined),
  *   fromCache: (boolean|undefined)
@@ -119,6 +120,8 @@ shaka.extern.Request;
  *   redirects, but after request filters are executed.
  * @property {BufferSource} data
  *   The body of the response.
+ * @property {(number|undefined)} status
+ *   The response HTTP status code.
  * @property {!Object.<string, string>} headers
  *   A map of response headers, if supported by the underlying protocol.
  *   All keys should be lowercased.
@@ -139,15 +142,17 @@ shaka.extern.Response;
  * @typedef {!function(string,
  *                     shaka.extern.Request,
  *                     shaka.net.NetworkingEngine.RequestType,
- *                     shaka.extern.ProgressUpdated):
+ *                     shaka.extern.ProgressUpdated,
+ *                     shaka.extern.HeadersReceived):
  *     !shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  * @description
  * Defines a plugin that handles a specific scheme.
  *
  * The functions accepts four parameters, uri string, request, request type,
- * and a progressUpdated function.  The progressUpdated function can be ignored
- * by plugins that do not have this information, but it will always be provided
- * by NetworkingEngine.
+ * a progressUpdated function, and a headersReceived function.  The
+ * progressUpdated and headersReceived functions can be ignored by plugins that
+ * do not have this information, but it will always be provided by
+ * NetworkingEngine.
  *
  * @exportDoc
  */
@@ -171,6 +176,17 @@ shaka.extern.SchemePlugin;
 shaka.extern.ProgressUpdated;
 
 
+/**
+ * @typedef {function(!Object.<string, string>)}
+ *
+ * @description
+ * A callback function to handle headers received events through networking
+ * engine in player.
+ * The first argument is the headers object of the response.
+ */
+shaka.extern.HeadersReceived;
+
+
 /**
  * Defines a filter for requests.  This filter takes the request and modifies
  * it before it is sent to the scheme plugin.

package/externs/shaka/offline.js

@@ -33,7 +33,8 @@ shaka.extern.OfflineSupport;
  *   size: number,
  *   expiration: number,
  *   tracks: !Array.<shaka.extern.Track>,
- *   appMetadata: Object
+ *   appMetadata: Object,
+ *   isIncomplete: boolean
  * }}
  *
  * @property {?string} offlineUri
@@ -53,6 +54,9 @@ shaka.extern.OfflineSupport;
  *   The tracks that are stored.
  * @property {Object} appMetadata
  *   The metadata passed to store().
+ * @property {boolean} isIncomplete
+ *   If true, the content is still downloading.  Manifests with this set cannot
+ *   be played yet.
  * @exportDoc
  */
 shaka.extern.StoredContent;
@@ -68,7 +72,8 @@ shaka.extern.StoredContent;
  *   streams: !Array.<shaka.extern.StreamDB>,
  *   sessionIds: !Array.<string>,
  *   drmInfo: ?shaka.extern.DrmInfo,
- *   appMetadata: Object
+ *   appMetadata: Object,
+ *   isIncomplete: (boolean|undefined)
  * }}
  *
  * @property {number} creationTime
@@ -91,6 +96,8 @@ shaka.extern.StoredContent;
  *   The DRM info used to initialize EME.
  * @property {Object} appMetadata
  *   A metadata object passed from the application.
+ * @property {(boolean|undefined)} isIncomplete
+ *   If true, the content is still downloading.
  */
 shaka.extern.ManifestDB;
 
@@ -195,6 +202,8 @@ shaka.extern.StreamDB;
  *   appendWindowEnd: number,
  *   timestampOffset: number,
  *   tilesLayout: ?string,
+ *   pendingSegmentRefId: (string|undefined),
+ *   pendingInitSegmentRefId: (string|undefined),
  *   dataKey: number
  * }}
  *
@@ -215,6 +224,17 @@ shaka.extern.StreamDB;
  *   The value is a grid-item-dimension consisting of two positive decimal
  *   integers in the format: column-x-row ('4x3'). It describes the
  *   arrangement of Images in a Grid. The minimum valid LAYOUT is '1x1'.
+ * @property {(string|undefined)} pendingSegmentRefId
+ *   Contains an id that identifies what the segment was, originally. Used to
+ *   coordinate where segments are stored, during the downloading process.
+ *   If this field is non-null, it's assumed that the segment is not fully
+ *   downloaded.
+ * @property {(string|undefined)} pendingInitSegmentRefId
+ *   Contains an id that identifies what the init segment was, originally.
+ *   Used to coordinate where init segments are stored, during the downloading
+ *   process.
+ *   If this field is non-null, it's assumed that the init segment is not fully
+ *   downloaded.
  * @property {number} dataKey
  *   The key to the data in storage.
  */
@@ -333,6 +353,15 @@ shaka.extern.StorageCell = class {
    */
   addManifests(manifests) {}
 
+  /**
+   * Updates the given manifest, stored at the given key.
+   *
+   * @param {number} key
+   * @param {!shaka.extern.ManifestDB} manifest
+   * @return {!Promise}
+   */
+  updateManifest(key, manifest) {}
+
   /**
    * Replace the expiration time of the manifest stored under |key| with
    * |newExpiration|. If no manifest is found under |key| then this should

package/externs/shaka/player.js

@@ -468,6 +468,48 @@ shaka.extern.ID3Metadata;
  */
 shaka.extern.TimelineRegionInfo;
 
+/**
+ * @typedef {{
+ *   audioSamplingRate: ?number,
+ *   bandwidth: number,
+ *   codecs: string,
+ *   contentType: string,
+ *   frameRate: ?number,
+ *   height: ?number,
+ *   mimeType: ?string,
+ *   channelsCount: ?number,
+ *   pixelAspectRatio: ?string,
+ *   width: ?number
+ * }}
+ *
+ * @description
+ * Contains information about the quality of an audio or video media stream.
+ *
+ * @property {?number} audioSamplingRate
+ *   Specifies the maximum sampling rate of the content.
+ * @property {number} bandwidth
+ *   The bandwidth in bits per second.
+ * @property {string} codecs
+ *   The Stream's codecs, e.g., 'avc1.4d4015' or 'vp9', which must be
+ * compatible with the Stream's MIME type.
+ * @property {string} contentType
+ *   The type of content, which may be "video" or "audio".
+ * @property {?number} frameRate
+ *   The video frame rate.
+ * @property {?number} height
+ *   The video height in pixels.
+ * @property {string} mimeType
+ *   The MIME type.
+ * @property {?number} channelsCount
+ *   The number of audio channels, or null if unknown.
+ * @property {?string} pixelAspectRatio
+ *   The pixel aspect ratio value; e.g "1:1".
+ * @property {?number} width
+ *   The video width in pixels.
+ * @exportDoc
+ */
+shaka.extern.MediaQualityInfo;
+
 
 /**
  * @typedef {{
@@ -698,7 +740,9 @@ shaka.extern.DashManifestConfiguration;
  * @typedef {{
  *   ignoreTextStreamFailures: boolean,
  *   ignoreImageStreamFailures: boolean,
- *   useFullSegmentsForStartTime: boolean
+ *   useFullSegmentsForStartTime: boolean,
+ *   defaultAudioCodec: string,
+ *   defaultVideoCodec: string
  * }}
  *
  * @property {boolean} ignoreTextStreamFailures
@@ -710,6 +754,12 @@ shaka.extern.DashManifestConfiguration;
  * @property {boolean} useFullSegmentsForStartTime
  *   If <code>true</code>, force HlsParser to use a full segment request for
  *   determining start time in case the server does not support partial requests
+ * @property {string} defaultAudioCodec
+ *   The default audio codec if it is not specified in the HLS playlist.
+ *   <i>Defaults to <code>'mp4a.40.2'</code>.</i>
+ * @property {string} defaultVideoCodec
+ *   The default video codec if it is not specified in the HLS playlist.
+ *   <i>Defaults to <code>'avc1.42E01E'</code>.</i>
  * @exportDoc
  */
 shaka.extern.HlsManifestConfiguration;
@@ -790,7 +840,9 @@ shaka.extern.ManifestConfiguration;
  *   autoLowLatencyMode: boolean,
  *   forceHTTPS: boolean,
  *   preferNativeHls: boolean,
- *   updateIntervalSeconds: number
+ *   updateIntervalSeconds: number,
+ *   dispatchAllEmsgBoxes: boolean,
+ *   observeQualityChanges: boolean
  * }}
  *
  * @description
@@ -899,7 +951,11 @@ shaka.extern.ManifestConfiguration;
  *   If true, prefer native HLS playback when possible, regardless of platform.
  * @property {number} updateIntervalSeconds
  *   The minimum number of seconds to see if the manifest has changes.
- *
+ * @property {boolean} dispatchAllEmsgBoxes
+ *   If true, all emsg boxes are parsed and dispatched.
+ * @property {boolean} observeQualityChanges
+ *   If true, monitor media quality changes and emit
+ *   <code.shaka.Player.MediaQualityChangedEvent</code>.
  * @exportDoc
  */
 shaka.extern.StreamingConfiguration;
@@ -913,7 +969,8 @@ shaka.extern.StreamingConfiguration;
  *   restrictions: shaka.extern.Restrictions,
  *   switchInterval: number,
  *   bandwidthUpgradeTarget: number,
- *   bandwidthDowngradeTarget: number
+ *   bandwidthDowngradeTarget: number,
+ *   advanced: shaka.extern.AdvancedAbrConfiguration
  * }}
  *
  * @property {boolean} enabled
@@ -930,7 +987,7 @@ shaka.extern.StreamingConfiguration;
  *   automatically, but will still appear in the track list and can still be
  *   selected via <code>selectVariantTrack()</code>.  If no tracks meet these
  *   restrictions, AbrManager should not fail, but choose a low-res or
- *   low-bandwidth variant instead.  It is the responsibiliy of AbrManager
+ *   low-bandwidth variant instead.  It is the responsibility of AbrManager
  *   implementations to follow these rules and implement this behavior.
  * @property {number} switchInterval
  *   The minimum amount of time that must pass between switches, in
@@ -941,11 +998,76 @@ shaka.extern.StreamingConfiguration;
  * @property {number} bandwidthDowngradeTarget
  *   The largest fraction of the estimated bandwidth we should use. We should
  *   downgrade to avoid this.
+ * @property {shaka.extern.AdvancedAbrConfiguration} advanced
+ *   Advanced ABR configuration.
  * @exportDoc
  */
 shaka.extern.AbrConfiguration;
 
 
+/**
+ * @typedef {{
+ *   minTotalBytes: number,
+ *   minBytes: number,
+ *   fastHalfLife: number,
+ *   slowHalfLife: number
+ * }}
+ *
+ * @property {number} minTotalBytes
+ *   Minimum number of bytes sampled before we trust the estimate.  If we have
+ *   not sampled much data, our estimate may not be accurate enough to trust.
+ * @property {number} minBytes
+ *   Minimum number of bytes, under which samples are discarded.  Our models
+ *   do not include latency information, so connection startup time (time to
+ *   first byte) is considered part of the download time.  Because of this, we
+ *   should ignore very small downloads which would cause our estimate to be
+ *   too low.
+ * @property {number} fastHalfLife
+ *   The quantity of prior samples (by weight) used when creating a new
+ *   estimate, in seconds.  Those prior samples make up half of the
+ *   new estimate.
+ * @property {number} slowHalfLife
+ *   The quantity of prior samples (by weight) used when creating a new
+ *   estimate, in seconds.  Those prior samples make up half of the
+ *   new estimate.
+ * @exportDoc
+ */
+shaka.extern.AdvancedAbrConfiguration;
+
+
+/**
+ * @typedef {{
+ *   enabled: boolean,
+ *   useHeaders: boolean,
+ *   sessionId: string,
+ *   contentId: string
+ * }}
+ *
+ * @description
+ *   Common Media Client Data (CMCD) configuration.
+ *
+ * @property {boolean} enabled
+ *   If <code>true</code>, enable CMCD data to be sent with media requests.
+ *   Defaults to <code>false</code>.
+ * @property {boolean} useHeaders
+ *   If <code>true</code>, send CMCD data using the header transmission mode
+ *   instead of query args.  Defaults to <code>false</code>.
+ * @property {string} sessionId
+ *   A GUID identifying the current playback session. A playback session
+ *   typically ties together segments belonging to a single media asset.
+ *   Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID
+ *   specification. By default the sessionId is automatically generated on each
+ *   <code>load()</code> call.
+ * @property {string} contentId
+ *   A unique string identifying the current content. Maximum length is 64
+ *   characters. This value is consistent across multiple different sessions and
+ *   devices and is defined and updated at the discretion of the service
+ *   provider.
+ * @exportDoc
+ */
+shaka.extern.CmcdConfiguration;
+
+
 /**
  * @typedef {{
  *   trackSelectionCallback:
@@ -987,6 +1109,7 @@ shaka.extern.OfflineConfiguration;
  *   streaming: shaka.extern.StreamingConfiguration,
  *   abrFactory: shaka.extern.AbrManager.Factory,
  *   abr: shaka.extern.AbrConfiguration,
+ *   cmcd: shaka.extern.CmcdConfiguration,
  *   offline: shaka.extern.OfflineConfiguration,
  *   preferredAudioLanguage: string,
  *   preferredTextLanguage: string,
@@ -1013,6 +1136,8 @@ shaka.extern.OfflineConfiguration;
  *   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.OfflineConfiguration} offline
  *   Offline configuration and settings.
  * @property {string} preferredAudioLanguage
@@ -1082,6 +1207,8 @@ shaka.extern.LanguageRole;
 
 /**
  * @typedef {{
+ *   imageHeight: number,
+ *   imageWidth: number,
  *   height: number,
  *   positionX: number,
  *   positionY: number,
@@ -1091,6 +1218,12 @@ shaka.extern.LanguageRole;
  *   width: number
  * }}
  *
+ * @property {number} imageHeight
+ *    The image height in px. The image height could be different to height if
+ *    the layout is different to 1x1.
+ * @property {number} imageWidth
+ *    The image width in px. The image width could be different to width if
+ *    the layout is different to 1x1.
  * @property {number} height
  *    The thumbnail height in px.
  * @property {number} positionX

package/externs/shaka/text.js

@@ -297,6 +297,20 @@ shaka.extern.Cue = class {
      */
     this.fontFamily;
 
+    /**
+     * Text stroke color as a CSS color, e.g. "#FFFFFF" or "white".
+     * @type {string}
+     * @exportDoc
+     */
+    this.textStrokeColor;
+
+    /**
+     * Text stroke width as a CSS stroke-width value.
+     * @type {string}
+     * @exportDoc
+     */
+    this.textStrokeWidth;
+
     /**
      * Text letter spacing as a CSS letter-spacing value.
      * @type {string}
@@ -349,6 +363,16 @@ shaka.extern.Cue = class {
      */
     this.nestedCues;
 
+    /**
+     * If true, this represents a container element that is "above" the main
+     * cues. For example, the <body> and <div> tags that contain the <p> tags
+     * in a TTML file. This controls the flow of the final cues; any nested cues
+     * within an "isContainer" cue will be laid out as separate lines.
+     * @type {boolean}
+     * @exportDoc
+     */
+    this.isContainer;
+
     /**
      * Whether or not the cue only acts as a line break between two nested cues.
      * Should only appear in nested cues.

package/externs/webcrypto.js

@@ -0,0 +1,18 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+/**
+ * @fileoverview Externs for crypto properties not in the Closure compiler.
+ *
+ * @externs
+ */
+
+
+/**
+ * @return {string}
+ */
+webCrypto.Crypto.prototype.randomUUID = function() {};

package/karma.conf.js

@@ -11,6 +11,7 @@ const Jimp = require('jimp');
 const fs = require('fs');
 const path = require('path');
 const rimraf = require('rimraf');
+const {ssim} = require('ssim.js');
 const util = require('karma/common/util');
 const which = require('which');
 
@@ -336,6 +337,10 @@ module.exports = (config) => {
 
   config.set({reporters: reporters});
 
+  if (reporters.includes('spec') && settings.spec_hide_passed) {
+    config.set({specReporter: {suppressPassed: true}});
+  }
+
   if (settings.random) {
     // If --seed was specified use that value, else generate a seed so that the
     // exact order can be reproduced if it catches an issue.
@@ -518,8 +523,7 @@ function WebDriverScreenshotMiddlewareFactory(launcher) {
    *
    * @param {karma.Launcher.Browser} browser
    * @param {!Object.<string, string>} params
-   * @return {!Promise.<number>} The number of pixels changed between the old
-   *   and new screenshots, after cropping and scaling.
+   * @return {!Promise.<number>} A similarity score between 0 and 1.
    */
   async function diffScreenshot(browser, params) {
     const webDriverClient = getWebDriverClient(browser);
@@ -604,22 +608,22 @@ function WebDriverScreenshotMiddlewareFactory(launcher) {
     // Compare the new screenshot to the old one and produce a diff image.
     // Initially, the image data will be raw pixels, 4 bytes per pixel.
     // The threshold parameter affects the sensitivity of individual pixel
-    // comparisons.  Setting it too low means small rendering changes in the
-    // browser can cause failures even when a human can't see the difference,
-    // and setting it too high means human-noticeable changes could go
-    // undetected by a test.
-    const diff = Jimp.diff(oldScreenshot, newScreenshot, /* threshold= */ 0.07);
+    // comparisons.  This diff is only used for visual review, not for
+    // automated similarity checks, so the threshold setting is not so critical
+    // as it used to be.
+    const threshold = 0.10;
+    const diff = Jimp.diff(oldScreenshot, newScreenshot, threshold);
 
     // Write the diff to disk.  This is used to review when there are changes.
+    const fullSizeDiff =
+        diff.image.clone().resize(width, height, Jimp.RESIZE_BICUBIC);
     fs.writeFileSync(
-        diffScreenshotPath, await diff.image.getBufferAsync('image/png'));
-
-    // "percent" is, surprisingly, a number between 0 and 1, not between 0 and
-    // 100.  Convert this to a number of pixels changed, which has been found to
-    // be a more effective and less flaky metric.
-    const pixelsChanged =
-        diff.percent * diff.image.bitmap.width * diff.image.bitmap.height;
-    return pixelsChanged;
+        diffScreenshotPath, await fullSizeDiff.getBufferAsync('image/png'));
+
+    // Compare with a structural similarity algorithm.  This produces a
+    // similarity score that we will use to pass or fail the test.
+    const ssimResult = ssim(oldScreenshot.bitmap, newScreenshot.bitmap);
+    return ssimResult.mssim;  // A score between 0 and 1.
   }
 
   /**

package/lib/abr/ewma.js

@@ -35,6 +35,20 @@ shaka.abr.Ewma = class {
     this.totalWeight_ = 0;
   }
 
+
+  /**
+   * Update the alpha with a new halfLife value.
+   *
+   * @param {number} halfLife The quantity of prior samples (by weight) used
+   *   when creating a new estimate.  Those prior samples make up half of the
+   *   new estimate.
+   */
+  updateAlpha(halfLife) {
+    goog.asserts.assert(halfLife > 0, 'expected halfLife to be positive');
+    this.alpha_ = Math.exp(Math.log(0.5) / halfLife);
+  }
+
+
   /**
    * Takes a sample.
    *

package/lib/abr/ewma_bandwidth_estimator.js

@@ -47,7 +47,6 @@ shaka.abr.EwmaBandwidthEstimator = class {
      * This specific value is based on experimentation.
      *
      * @private {number}
-     * @const
      */
     this.minTotalBytes_ = 128e3;  // 128kB
 
@@ -60,11 +59,26 @@ shaka.abr.EwmaBandwidthEstimator = class {
      * This specific value is based on experimentation.
      *
      * @private {number}
-     * @const
      */
     this.minBytes_ = 16e3;  // 16kB
   }
 
+
+  /**
+   * Called by the Player to provide an updated configuration any time it
+   * changes.
+   * Must be called at least once before init().
+   *
+   * @param {shaka.extern.AdvancedAbrConfiguration} config
+   */
+  configure(config) {
+    this.minTotalBytes_ = config.minTotalBytes;
+    this.minBytes_ = config.minBytes;
+    this.fast_.updateAlpha(config.fastHalfLife);
+    this.slow_.updateAlpha(config.slowHalfLife);
+  }
+
+
   /**
    * Takes a bandwidth sample.
    *

package/lib/abr/simple_abr_manager.js

@@ -54,6 +54,9 @@ shaka.abr.SimpleAbrManager = class {
       navigator.connection.addEventListener('change', () => {
         if (this.config_.useNetworkInformation && this.enabled_) {
           this.bandwidthEstimator_ = new shaka.abr.EwmaBandwidthEstimator();
+          if (this.config_) {
+            this.bandwidthEstimator_.configure(this.config_.advanced);
+          }
           const chosenVariant = this.chooseVariant();
           if (chosenVariant) {
             this.switch_(chosenVariant);
@@ -239,6 +242,9 @@ shaka.abr.SimpleAbrManager = class {
    */
   configure(config) {
     this.config_ = config;
+    if (this.bandwidthEstimator_ && this.config_) {
+      this.bandwidthEstimator_.configure(this.config_.advanced);
+    }
   }
 
 

package/lib/ads/ad_manager.js

@@ -448,6 +448,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
       this.ssAdManager_.release();
       this.ssAdManager_ = null;
     }
+    super.release();
   }
 
 

package/lib/ads/client_side_ad.js

@@ -162,6 +162,14 @@ shaka.ads.ClientSideAd = class {
     return this.manager_.getVolume() == 0;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  isLinear() {
+    return this.ad_.isLinear();
+  }
+
 
   /**
    * @override

package/lib/ads/client_side_ad_manager.js

@@ -396,8 +396,10 @@ shaka.ads.ClientSideAdManager = class {
         .set('originalEvent', e);
     this.onEvent_(new shaka.util.FakeEvent(
         shaka.ads.AdManager.AD_STARTED, data));
-    this.adContainer_.setAttribute('ad-active', 'true');
-    this.video_.pause();
+    if (this.ad_.isLinear()) {
+      this.adContainer_.setAttribute('ad-active', 'true');
+      this.video_.pause();
+    }
   }
 
   /**
@@ -407,7 +409,9 @@ shaka.ads.ClientSideAdManager = class {
   onAdComplete_(e) {
     this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED,
         (new Map()).set('originalEvent', e)));
-    this.adContainer_.removeAttribute('ad-active');
-    this.video_.play();
+    if (this.ad_.isLinear()) {
+      this.adContainer_.removeAttribute('ad-active');
+      this.video_.play();
+    }
   }
 };

package/lib/ads/server_side_ad.js

@@ -152,6 +152,13 @@ shaka.ads.ServerSideAd = class {
     return this.video_.muted;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  isLinear() {
+    return true;
+  }
 
   /**
    * @override

package/lib/cast/cast_proxy.js

@@ -120,6 +120,9 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
     this.videoProxy_ = null;
     this.playerProxy_ = null;
 
+    // FakeEventTarget implements IReleasable
+    super.release();
+
     return Promise.all(waitFor);
   }
 

package/lib/cast/cast_receiver.js

@@ -238,6 +238,9 @@ shaka.cast.CastReceiver = class extends shaka.util.FakeEventTarget {
     this.shakaBus_ = null;
     this.genericBus_ = null;
 
+    // FakeEventTarget implements IReleasable
+    super.release();
+
     await Promise.all(waitFor);
 
     const manager = cast.receiver.CastReceiverManager.getInstance();

package/lib/cast/cast_utils.js

@@ -388,6 +388,7 @@ shaka.cast.CastUtils.PlayerVoidMethods = [
   'selectVariantsByLabel',
   'setTextTrackVisibility',
   'trickPlay',
+  'updateStartTime',
   'goToLive',
 ];