shaka-player 4.2.12 → 4.2.14

package/docs/tutorials/selenium-grid-config.md

@@ -47,17 +47,20 @@ vars:
 FirefoxMac:
   browser: firefox
   os: Mac
-  extra_config: *firefox_config
+  extra_configs:
+    - *firefox_config
 
 FirefoxWindows:
   browser: firefox
   os: Windows
-  extra_config: *firefox_config
+  extra_configs:
+    - *firefox_config
 
 FirefoxLinux:
   browser: firefox
   os: Linux
-  extra_config: *firefox_config
+  extra_configs:
+    - *firefox_config
 ```
 
 ### Browsers
@@ -75,8 +78,8 @@ browser made available to Karma.  Within each of those keys are the following:
        and must match the string and case used in the Selenium node config.
  - `disabled` (optional): If true, this browser is disabled and will not be
        used unless explicitly requested.
- - `extra_config` (optional): A dictionary of extra configs which will be
-       merged with the WebDriver launcher config in Karma.
+ - `extra_configs` (optional): An array of dictionaries of extra configs which
+       will be merged with the WebDriver launcher config in Karma.
 
 Examples of basic desktop browsers definitions:
 
@@ -96,9 +99,9 @@ Safari:
 SafariTP:
   browser: safari
   os: Mac
-  extra_config:
-    safari.options:
-      technologyPreview: true
+  extra_configs:
+    - safari.options:
+        technologyPreview: true
 
 ChromeWindows:
   browser: chrome
@@ -120,3 +123,52 @@ FirefoxLinux:
   browser: firefox
   os: Linux
 ```
+
+### Composing configs
+
+You can define variables for browser configs that can be composed together in
+`extra_configs`.  For example, below you will see some basic definitions for
+Chrome arguments and parameters, and then an additional config with an argument
+that is only needed for some platforms.  `karma.conf.js` will merge those
+argument lists intelligently when it loads the YAML config.
+
+```yaml
+vars:
+  basic_chrome_config: &basic_chrome_config
+    goog:chromeOptions:
+      args:
+        # Normally, Chrome disallows autoplaying videos in many cases.  Enable
+        # it for testing.
+        - "--autoplay-policy=no-user-gesture-required"
+
+      # Instruct chromedriver not to disable component updater.
+      excludeSwitches:
+        - "disable-component-update"
+
+  headless_chrome_config: &headless_chrome_config
+    goog:chromeOptions:
+      args:
+        # Run in headless mode.
+        - "--headless"
+
+ChromeLinux:
+  browser: chrome
+  os: Mac
+  extra_configs:
+    - *basic_chrome_config
+
+ChromeWindows:
+  browser: chrome
+  os: Mac
+  extra_configs:
+    - *basic_chrome_config
+
+ChromeMac:
+  browser: chrome
+  os: Mac
+  # Take the parameters and arguments for basic_chrome_config, then append the
+  # arguments for headless_chrome_config.
+  extra_configs:
+    - *basic_chrome_config
+    - *headless_chrome_config
+```

package/externs/shaka/manifest.js

@@ -321,7 +321,8 @@ shaka.extern.FetchCryptoKeysFunction;
  *   tilesLayout: (string|undefined),
  *   matchedStreams:
  *      (!Array.<shaka.extern.Stream>|!Array.<shaka.extern.StreamDB>|
- *      undefined)
+ *      undefined),
+ *   external: boolean
  * }}
  *
  * @description
@@ -434,6 +435,9 @@ shaka.extern.FetchCryptoKeysFunction;
  * @property {(!Array.<shaka.extern.Stream>|!Array.<shaka.extern.StreamDB>|
  *   undefined)} matchedStreams
  *   The streams in all periods which match the stream. Used for Dash.
+ * @property {boolean} external
+ *   Indicate if the stream was added externally.
+ *   Eg: external text tracks.
  *
  * @exportDoc
  */

package/externs/shaka/offline.js

@@ -132,7 +132,8 @@ shaka.extern.ManifestDB;
  *   audioSamplingRate: ?number,
  *   spatialAudio: boolean,
  *   closedCaptions: Map.<string, string>,
- *   tilesLayout: (string|undefined)
+ *   tilesLayout: (string|undefined),
+ *   external: boolean
  * }}
  *
  * @property {number} id
@@ -193,6 +194,9 @@ shaka.extern.ManifestDB;
  *   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 {boolean} external
+ *   Indicate if the stream was added externally.
+ *   Eg: external text tracks.
  */
 shaka.extern.StreamDB;
 

package/karma.conf.js

@@ -7,9 +7,11 @@
 // Karma configuration
 // Install required modules by running "npm install"
 
-const Jimp = require('jimp');
+// lodash is an indirect dependency, depended on by Karma
+const _ = require('lodash');
 const fs = require('fs');
 const glob = require('glob');
+const Jimp = require('jimp');
 const path = require('path');
 const rimraf = require('rimraf');
 const {ssim} = require('ssim.js');
@@ -17,6 +19,32 @@ const util = require('karma/common/util');
 const which = require('which');
 const yaml = require('js-yaml');
 
+/**
+ * Like Object.assign, but recursive and doesn't clobber objects and arrays.
+ * If two arrays are merged, they are concatenated.
+ * Ex:
+ *   mergeConfigs({ foo: 'bar', args: [1, 2, 3] },
+ *                { baz: 'blah', args: [4, 5, 6] })
+ *       => { foo: 'bar', baz: 'blah', args: [1, 2, 3, 4, 5, 6] }
+ *
+ * @param {Object} first
+ * @param {Object} second
+ * @return {Object}
+ */
+function mergeConfigs(first, second) {
+  return _.mergeWith(
+      first,
+      second,
+      (firstValue, secondValue) => {
+        // Merge arrays by concatenation.
+        if (Array.isArray(firstValue)) {
+          return firstValue.concat(secondValue);
+        }
+        // Use lodash's default merge behavior for everything else.
+        return undefined;
+      });
+}
+
 /**
  * @param {Object} config
  */
@@ -78,7 +106,7 @@ module.exports = (config) => {
       }
 
       // Add standard WebDriver configs.
-      Object.assign(launcher, {
+      mergeConfigs(launcher, {
         base: 'WebDriver',
         config: {hostname: gridHostname, port: gridPort},
         pseudoActivityInterval: 20000,
@@ -87,8 +115,10 @@ module.exports = (config) => {
         version: metadata.version,
       });
 
-      if (metadata.extra_config) {
-        Object.assign(launcher, metadata.extra_config);
+      if (metadata.extra_configs) {
+        for (const config of metadata.extra_configs) {
+          mergeConfigs(launcher, config);
+        }
       }
     }
 
@@ -321,6 +351,8 @@ module.exports = (config) => {
       },
 
       babelPreprocessor: {
+        // Cache results in .babel-cache
+        cachePath: '.babel-cache',
         options: {
           presets: ['@babel/preset-env'],
           // Add source maps so that backtraces refer to the original code.
@@ -603,15 +635,27 @@ function WebDriverScreenshotMiddlewareFactory(launcher) {
   }
 
   /**
+   * @param {karma.Launcher.Browser.spec} spec
    * @param {wd.remote} webDriverClient A WebDriver client, an object from the
    *   "wd" package, created by "wd.remote()".
    * @return {!Promise.<!Buffer>} A Buffer containing a PNG screenshot
    */
-  function getScreenshot(webDriverClient) {
+  function getScreenshot(spec, webDriverClient) {
     return new Promise((resolve, reject) => {
       webDriverClient.takeScreenshot((error, pngBase64) => {
         if (error) {
           reject(error);
+        } else if (pngBase64.error) {
+          // In some failure cases, pngBase64 is an object with "error",
+          // "message", and "stacktrace" fields.  This happens, for example,
+          // with a timeout from the screenshot command.  This is not an
+          // expected situation, so log it.  The extra newlines keep this from
+          // being overwritten on the terminal when running tests against many
+          // browsers at once.
+          console.log('\n\nUnexpected screenshot failure:\n' +
+              `  Error: ${JSON.stringify(pngBase64)}\n` +
+              `  WebDriver spec: ${JSON.stringify(spec)}\n\n\n`);
+          reject(pngBase64);
         } else {
           // Convert the screenshot to a binary buffer.
           resolve(Buffer.from(pngBase64, 'base64'));
@@ -635,7 +679,8 @@ function WebDriverScreenshotMiddlewareFactory(launcher) {
     }
 
     /** @type {!Buffer} */
-    const fullPageScreenshotData = await getScreenshot(webDriverClient);
+    const fullPageScreenshotData =
+        await getScreenshot(browser.spec, webDriverClient);
 
     // Crop the screenshot to the dimensions specified in the test.
     // Jimp is picky about types, so convert these strings to numbers.
@@ -754,7 +799,7 @@ function WebDriverScreenshotMiddlewareFactory(launcher) {
         // The result is cached for the sake of performance.
         if (webDriverClient.canTakeScreenshot === undefined) {
           try {
-            await getScreenshot(webDriverClient);
+            await getScreenshot(browser.spec, webDriverClient);
             webDriverClient.canTakeScreenshot = true;
           } catch (error) {
             webDriverClient.canTakeScreenshot = false;

package/lib/abr/simple_abr_manager.js

@@ -48,6 +48,9 @@ shaka.abr.SimpleAbrManager = class {
     /** @private {shaka.abr.EwmaBandwidthEstimator} */
     this.bandwidthEstimator_ = new shaka.abr.EwmaBandwidthEstimator();
 
+    /** @private {?function():void} */
+    this.onNetworkInformationChange_ = null;
+
     // Some browsers implement the Network Information API, which allows
     // retrieving information about a user's network connection. We listen
     // to the change event to be able to make quick changes in case the type
@@ -98,9 +101,6 @@ shaka.abr.SimpleAbrManager = class {
     /** @private {ResizeObserver} */
     this.resizeObserver_ = null;
 
-    /** @private {?function():void} */
-    this.onNetworkInformationChange_ = null;
-
     /** @private {shaka.util.Timer} */
     this.resizeObserverTimer_ = new shaka.util.Timer(() => {
       if (this.config_.restrictToElementSize) {
@@ -175,8 +175,8 @@ shaka.abr.SimpleAbrManager = class {
     if (this.resizeObserver_ && this.config_.restrictToElementSize) {
       const devicePixelRatio =
           this.config_.ignoreDevicePixelRatio ? 1 : window.devicePixelRatio;
-      maxHeight = this.mediaElement_.clientWidth * devicePixelRatio;
-      maxWidth = this.mediaElement_.clientHeight * devicePixelRatio;
+      maxHeight = this.mediaElement_.clientHeight * devicePixelRatio;
+      maxWidth = this.mediaElement_.clientWidth * devicePixelRatio;
     }
 
     // Get sorted Variants.

package/lib/ads/client_side_ad_manager.js

@@ -33,6 +33,9 @@ shaka.ads.ClientSideAdManager = class {
     /** @private {HTMLMediaElement} */
     this.video_ = video;
 
+    /** @private {boolean} */
+    this.videoPlayed_ = false;
+
     /** @private {ResizeObserver} */
     this.resizeObserver_ = null;
 
@@ -82,6 +85,10 @@ shaka.ads.ClientSideAdManager = class {
     this.eventManager_.listen(this.video_, 'ended', () => {
       this.adsLoader_.contentComplete();
     });
+
+    this.eventManager_.listenOnce(this.video_, 'play', () => {
+      this.videoPlayed_ = true;
+    });
   }
 
   /**
@@ -219,9 +226,14 @@ shaka.ads.ClientSideAdManager = class {
       // seen the ads actually play until requestAds() is called.
       // Note: We listen for a play event to avoid autoplay issues that might
       // crash IMA.
-      this.eventManager_.listenOnce(this.video_, 'play', () => {
+      if (this.videoPlayed_) {
         this.imaAdsManager_.start();
-      });
+      } else {
+        this.eventManager_.listenOnce(this.video_, 'play', () => {
+          this.videoPlayed_ = true;
+          this.imaAdsManager_.start();
+        });
+      }
     } catch (adError) {
       // If there was a problem with the VAST response,
       // we we won't be getting an ad. Hide ad UI if we showed it already

package/lib/dash/dash_parser.js

@@ -1337,6 +1337,7 @@ shaka.dash.DashParser = class {
         hdr,
         tilesLayout,
         matchedStreams: [],
+        external: false,
       };
     }
 

package/lib/hls/hls_parser.js

@@ -1757,6 +1757,7 @@ shaka.hls.HlsParser = class {
       closedCaptions,
       hdr: undefined,
       tilesLayout: undefined,
+      external: false,
     };
 
     return {

package/lib/media/media_source_engine.js

@@ -354,7 +354,7 @@ shaka.media.MediaSourceEngine = class {
       let mimeType = shaka.util.MimeUtils.getFullType(
           stream.mimeType, stream.codecs);
       if (contentType == ContentType.TEXT) {
-        this.reinitText(mimeType, sequenceMode);
+        this.reinitText(mimeType, sequenceMode, stream.external);
       } else {
         if ((forceTransmuxTS || !MediaSource.isTypeSupported(mimeType)) &&
             shaka.media.Transmuxer.isSupported(mimeType, contentType)) {
@@ -383,13 +383,14 @@ shaka.media.MediaSourceEngine = class {
    * Reinitialize the TextEngine for a new text type.
    * @param {string} mimeType
    * @param {boolean} sequenceMode
+   * @param {boolean} external
    */
-  reinitText(mimeType, sequenceMode) {
+  reinitText(mimeType, sequenceMode, external) {
     if (!this.textEngine_) {
       this.textEngine_ = new shaka.text.TextEngine(this.textDisplayer_);
     }
     this.textEngine_.initParser(mimeType, sequenceMode,
-        this.segmentRelativeVttTiming_);
+        external || this.segmentRelativeVttTiming_);
   }
 
   /**
@@ -564,7 +565,7 @@ shaka.media.MediaSourceEngine = class {
       // the video stream, so textEngine may not have been initialized.
       if (!this.textEngine_) {
         this.reinitText(shaka.util.MimeUtils.CEA608_CLOSED_CAPTION_MIMETYPE,
-            this.sequenceMode_);
+            this.sequenceMode_, /* external= */ false);
       }
 
       if (transmuxedData.metadata) {
@@ -593,7 +594,7 @@ shaka.media.MediaSourceEngine = class {
     } else if (hasClosedCaptions) {
       if (!this.textEngine_) {
         this.reinitText(shaka.util.MimeUtils.CEA608_CLOSED_CAPTION_MIMETYPE,
-            this.sequenceMode_);
+            this.sequenceMode_, /* external= */ false);
       }
       // If it is the init segment for closed captions, initialize the closed
       // caption parser.

package/lib/media/streaming_engine.js

@@ -240,7 +240,7 @@ shaka.media.StreamingEngine = class {
     const mimeType = shaka.util.MimeUtils.getFullType(
         stream.mimeType, stream.codecs);
     this.playerInterface_.mediaSourceEngine.reinitText(
-        mimeType, this.manifest_.sequenceMode);
+        mimeType, this.manifest_.sequenceMode, stream.external);
 
     const textDisplayer =
         this.playerInterface_.mediaSourceEngine.getTextDisplayer();
@@ -447,7 +447,7 @@ shaka.media.StreamingEngine = class {
       const fullMimeType = shaka.util.MimeUtils.getFullType(
           stream.mimeType, stream.codecs);
       this.playerInterface_.mediaSourceEngine.reinitText(
-          fullMimeType, this.manifest_.sequenceMode);
+          fullMimeType, this.manifest_.sequenceMode, stream.external);
     }
 
     // Releases the segmentIndex of the old stream.

package/lib/offline/indexeddb/v1_storage_cell.js

@@ -176,6 +176,7 @@ shaka.offline.indexeddb.V1StorageCell = class
       spatialAudio: false,
       closedCaptions: null,
       tilesLayout: undefined,
+      external: false,
     };
   }
 

package/lib/offline/indexeddb/v2_storage_cell.js

@@ -125,6 +125,7 @@ shaka.offline.indexeddb.V2StorageCell = class
       spatialAudio: false,
       closedCaptions: null,
       tilesLayout: undefined,
+      external: false,
     };
   }
 

package/lib/offline/manifest_converter.js

@@ -202,6 +202,7 @@ shaka.offline.ManifestConverter = class {
       spatialAudio: streamDB.spatialAudio,
       closedCaptions: streamDB.closedCaptions,
       tilesLayout: streamDB.tilesLayout,
+      external: streamDB.external,
     };
 
     return stream;

package/lib/offline/storage.js

@@ -1324,6 +1324,7 @@ shaka.offline.Storage = class {
       spatialAudio: stream.spatialAudio,
       closedCaptions: stream.closedCaptions,
       tilesLayout: stream.tilesLayout,
+      external: stream.external,
     };
 
     const startTime =

package/lib/player.js

@@ -2069,10 +2069,6 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
 
         this.playhead_.setStartTime(adjustedTime);
       }
-
-      // Since the first streams just became active, send an adaptation event.
-      this.onAdaptation_(null,
-          shaka.util.StreamUtils.variantToTrack(initialVariant));
     }
 
     this.playhead_.ready();
@@ -2237,6 +2233,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         audioSamplingRate: null,
         spatialAudio: false,
         closedCaptions: null,
+        external: false,
       },
       bandwidth: 100,
       allowedByApplication: true,
@@ -4631,6 +4628,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       audioSamplingRate: null,
       spatialAudio: false,
       closedCaptions: null,
+      external: true,
     };
 
     const fullMimeType = shaka.util.MimeUtils.getFullType(
@@ -5061,6 +5059,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
               audioSamplingRate: null,
               spatialAudio: false,
               closedCaptions: null,
+              external: false,
             };
             manifest.textStreams.push(textStream);
             closedCaptionsSet.add(id);
@@ -6635,7 +6634,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v4.2.12-uncompiled';
+shaka.Player.version = 'v4.2.14-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/polyfill/orientation.js

@@ -6,6 +6,7 @@
 
 goog.provide('shaka.polyfill.Orientation');
 
+goog.require('shaka.log');
 goog.require('shaka.util.FakeEvent');
 goog.require('shaka.util.FakeEventTarget');
 goog.require('shaka.polyfill');
@@ -23,21 +24,47 @@ shaka.polyfill.Orientation = class {
    * @export
    */
   static install() {
-    if (screen.orientation) {
+    if (screen.orientation && screen.orientation.unlock) {
       // Not needed.
+      shaka.log.info('Using native screen.orientation');
       return;
     }
 
-    // There is no way to check to see if the 'orientationchange' event exists
-    // on window, which could theoretically lead to this making a
-    // screen.orientation object that doesn't actually work.
-    // However, it looks like all platforms that support the deprecated
-    // window.orientation feature also support that event.
-    if (window.orientation != undefined) {
+    if (screen.orientation != undefined) {
+      // There are some platforms where screen.orientation is defined but
+      // incomplete (e.g. Safari).
+      // Install a very simple polyfill in that case.
+      shaka.polyfill.Orientation.installBasedOnScreenMethods_();
+    } else if (window.orientation != undefined) {
+      // There is no way to check to see if the 'orientationchange' event exists
+      // on window, which could theoretically lead to this making a
+      // screen.orientation object that doesn't actually work.
+      // However, it looks like all platforms that support the deprecated
+      // window.orientation feature also support that event.
       shaka.polyfill.Orientation.installBasedOnWindowMethods_();
     }
   }
 
+  /**
+   * Modifies screen.orientation to add no-ops for missing methods.
+   * Meant for cases where screen.orientation is defined, but has missing
+   * methods that cannot be properly polyfilled.
+   * @private
+   */
+  static installBasedOnScreenMethods_() {
+    if (screen.orientation.lock === undefined) {
+      screen.orientation.lock = (orientation) => {
+        shaka.log.info('screen.orientation.lock is a no-op');
+        return Promise.resolve();
+      };
+    }
+    if (screen.orientation.unlock === undefined) {
+      screen.orientation.unlock = () => {
+        shaka.log.info('screen.orientation.unlock is a no-op');
+      };
+    }
+  }
+
   /**
    * Makes a polyfill for orientation, based on window methods.
    * Note that some of the features this is based on are deprecated, so this

package/lib/text/vtt_text_parser.js

@@ -674,6 +674,7 @@ shaka.text.VttTextParser = class {
     cue.fontWeight = refCue.fontWeight;
     cue.fontStyle = refCue.fontStyle;
     cue.opacity = refCue.opacity;
+    cue.textShadow = refCue.textShadow;
     cue.wrapLine = refCue.wrapLine;
   }
 

package/lib/util/manifest_parser_utils.js

@@ -180,8 +180,10 @@ shaka.util.ManifestParserUtils.VIDEO_CODEC_REGEXPS_ = [
  */
 shaka.util.ManifestParserUtils.AUDIO_CODEC_REGEXPS_ = [
   /^vorbis$/,
-  /^opus$/,
-  /^flac$/,
+  /^Opus$/, // correct codec string according to RFC 6381 section 3.3
+  /^opus$/, // some manifests wrongfully use this
+  /^fLaC$/, // correct codec string according to RFC 6381 section 3.3
+  /^flac$/, // some manifests wrongfully use this
   /^mp4a/,
   /^[ae]c-3$/,
   /^ac-4$/,

package/lib/util/periods.js

@@ -1491,6 +1491,7 @@ shaka.util.PeriodCombiner = class {
       audioSamplingRate: null,
       spatialAudio: false,
       closedCaptions: null,
+      external: false,
     };
   }
 
@@ -1527,6 +1528,7 @@ shaka.util.PeriodCombiner = class {
       audioSamplingRate: null,
       spatialAudio: false,
       closedCaptions: null,
+      external: false,
     };
   }
 

package/lib/util/platform.js

@@ -214,6 +214,7 @@ shaka.util.Platform = class {
         !shaka.util.Platform.isTizen() &&
         !shaka.util.Platform.isEOS() &&
         !shaka.util.Platform.isVirginMedia() &&
+        !shaka.util.Platform.isOrange() &&
         !shaka.util.Platform.isPS4() &&
         !shaka.util.Platform.isAmazonFireTV();
   }
@@ -253,6 +254,13 @@ shaka.util.Platform = class {
     return shaka.util.Platform.userAgentContains_('VirginMedia');
   }
 
+  /**
+   * Check if the current platform is Orange.
+   */
+  static isOrange() {
+    return shaka.util.Platform.userAgentContains_('SOPOpenBrowser');
+  }
+
   /**
    * Check if the current platform is Amazon Fire TV.
    * https://developer.amazon.com/docs/fire-tv/identify-amazon-fire-tv-devices.html
@@ -346,6 +354,20 @@ shaka.util.Platform = class {
     return shaka.util.Platform.isApple() && navigator.maxTouchPoints > 1;
   }
 
+  /**
+   * Return true if the platform is a Mac, regardless of the browser.
+   *
+   * @return {boolean}
+   */
+  static isMac() {
+    // Try the newer standard first.
+    if (navigator.userAgentData && navigator.userAgentData.platform) {
+      return navigator.userAgentData.platform.toLowerCase() == 'macos';
+    }
+    // Fall back to the old API, with less strict matching.
+    return navigator.platform.toLowerCase().includes('mac');
+  }
+
   /**
    * Check if the user agent contains a key. This is the best way we know of
    * right now to detect platforms. If there is a better way, please send a