shaka-player 3.2.2 → 3.2.5

package/karma.conf.js

@@ -9,10 +9,13 @@
 
 const Jimp = require('jimp');
 const fs = require('fs');
+const glob = require('glob');
 const path = require('path');
 const rimraf = require('rimraf');
+const {ssim} = require('ssim.js');
 const util = require('karma/common/util');
 const which = require('which');
+const yaml = require('js-yaml');
 
 /**
  * @param {Object} config
@@ -42,6 +45,58 @@ module.exports = (config) => {
   const settings =
       settingsIndex >= 0 ? JSON.parse(args[settingsIndex + 1]) : {};
 
+  if (settings.grid_config) {
+    const gridBrowserMetadata =
+        yaml.load(fs.readFileSync(settings.grid_config, 'utf8'));
+    const customLaunchers = {};
+    const [gridHostname, gridPort] = settings.grid_address.split(':');
+    console.log(`Using Selenium grid at ${gridHostname}:${gridPort}`);
+
+    // By default, run on all grid browsers instead of the platform-specific
+    // default.  This does not disable local browsers, though.  Users can still
+    // specify a mix of grid and local browsers explicitly.
+    settings.default_browsers = [];
+
+    for (const name in gridBrowserMetadata) {
+      if (name == 'vars') {
+        // Skip variable defs in the YAML file
+        continue;
+      }
+
+      const metadata = gridBrowserMetadata[name];
+
+      const launcher = {};
+      customLaunchers[name] = launcher;
+
+      // Disabled-by-default browsers are still defined, but not put in the
+      // default list.  A user can ask for one explicitly.  This allows us to
+      // disable a browser that is down for some reason in the lab, but still
+      // ask for it manually if we want to test it before re-enabling it for
+      // everyone.
+      if (!metadata.disabled) {
+        settings.default_browsers.push(name);
+      }
+
+      // Add standard WebDriver configs.
+      Object.assign(launcher, {
+        base: 'WebDriver',
+        config: {hostname: gridHostname, port: gridPort},
+        pseudoActivityInterval: 20000,
+        browserName: metadata.browser,
+        platform: metadata.os,
+        version: metadata.version,
+      });
+
+      if (metadata.extra_config) {
+        Object.assign(launcher, metadata.extra_config);
+      }
+    }
+
+    config.set({
+      customLaunchers: customLaunchers,
+    });
+  }
+
   if (settings.browsers && settings.browsers.length == 1 &&
       settings.browsers[0] == 'help') {
     console.log('Available browsers:');
@@ -52,6 +107,24 @@ module.exports = (config) => {
     process.exit(1);
   }
 
+  // Resolve the set of browsers we will use.
+  const browserSet = new Set(settings.browsers && settings.browsers.length ?
+      settings.browsers : settings.default_browsers);
+  if (settings.exclude_browsers) {
+    for (const excluded of settings.exclude_browsers) {
+      browserSet.delete(excluded);
+    }
+  }
+
+  let browsers = Array.from(browserSet).sort();
+  if (settings.no_browsers) {
+    console.warn(
+        '--no-browsers: In this mode, you must connect browsers to Karma.');
+    browsers = null;
+  } else {
+    console.warn('Running tests on: ' + browsers.join(', '));
+  }
+
   config.set({
     // base path that will be used to resolve all patterns (eg. files, exclude)
     basePath: '.',
@@ -86,7 +159,7 @@ module.exports = (config) => {
       //   Promise polyfill, required since we test uncompiled code on IE11
       'node_modules/es6-promise-polyfill/promise.js',
       //   Babel polyfill, required for async/await
-      'node_modules/babel-polyfill/dist/polyfill.js',
+      'node_modules/@babel/polyfill/dist/polyfill.js',
       //   TextDecoder polyfill, required for TextDecoder/TextEncoder on IE and
       //   legacy Edge
       //   eslint-disable-next-line max-len
@@ -106,46 +179,46 @@ module.exports = (config) => {
       'dist/deps.js',
       'shaka-player.uncompiled.js',
 
+      // the demo's config tab will register with shakaDemoMain, and will be
+      // tested in test/demo/demo_unit.js
+      'demo/config.js',
+
       // cajon module (an AMD variant of requirejs) next
       'node_modules/cajon/cajon.js',
 
-      // bootstrapping for the test suite
-      'test/test/boot.js',
+      // define the test namespace next (shaka.test)
+      'test/test/namespace.js',
 
-      // test utils next
+      // test utilities next, which fill in that namespace
       'test/test/util/*.js',
 
-      // list of test assets next
-      'demo/common/message_ids.js',
-      'demo/common/asset.js',
-      'demo/common/assets.js',
+      // bootstrapping for the test suite last; this will load the actual tests
+      'test/test/boot.js',
 
       // if --test-custom-asset *is not* present, we will add unit tests.
       // if --quick *is not* present, we will add integration tests.
       // if --external *is* present, we will add external asset tests.
 
-      // load relevant demo files
-      {
-        pattern: 'demo/!(main|load|demo_uncompiled|service_worker).js',
-        included: true,
-      },
-
-      // source files - these are only watched and served
+      // source files - these are only watched and served.
+      // anything not listed here can't be dynamically loaded by other scripts.
       {pattern: 'lib/**/*.js', included: false},
       {pattern: 'ui/**/*.js', included: false},
       {pattern: 'ui/**/*.less', included: false},
       {pattern: 'third_party/**/*.js', included: false},
-      {
-        pattern: 'node_modules/google-closure-library/closure/goog/**/*.js',
-        included: false,
-      },
+      {pattern: 'test/**/*.js', included: false},
       {pattern: 'test/test/assets/*', included: false},
       {pattern: 'test/test/assets/3675/*', included: false},
       {pattern: 'dist/shaka-player.ui.js', included: false},
       {pattern: 'dist/locales.js', included: false},
+      {pattern: 'demo/**/*.js', included: false},
       {pattern: 'demo/locales/en.json', included: false},
       {pattern: 'demo/locales/source.json', included: false},
-      {pattern: 'node_modules/**/*.js', included: false},
+      {pattern: 'node_modules/sprintf-js/src/sprintf.js', included: false},
+      {pattern: 'node_modules/less/dist/less.js', included: false},
+      {
+        pattern: 'node_modules/fontfaceonload/dist/fontfaceonload.js',
+        included: false,
+      },
     ],
 
     // NOTE: Do not use proxies at all!  They cannot be used with the --hostname
@@ -211,7 +284,7 @@ module.exports = (config) => {
 
     // Set which browsers to run on. If this is null, then Karma will wait for
     // an incoming connection.
-    browsers: settings.browsers,
+    browsers,
 
     // Enable / disable colors in the output (reporters and logs). Defaults
     // to true.
@@ -242,6 +315,7 @@ module.exports = (config) => {
 
     specReporter: {
       suppressSkipped: true,
+      showBrowser: true,
     },
   });
 
@@ -259,7 +333,7 @@ module.exports = (config) => {
 
       babelPreprocessor: {
         options: {
-          presets: ['env'],
+          presets: ['@babel/preset-env'],
           // Add source maps so that backtraces refer to the original code.
           // Babel will output inline source maps, and the 'sourcemap'
           // preprocessor will read them and feed them to Karma.  Karma will
@@ -282,26 +356,30 @@ module.exports = (config) => {
     });
   }
 
+  const clientArgs = config.client.args[0];
+  clientArgs.testFiles = [];
+
   if (settings.test_custom_asset) {
     // If testing custom assets, we don't serve other unit or integration tests.
     // External asset tests are the basis for custom asset testing, so this file
     // is automatically included.
-    config.files.push('test/player_external.js');
+    clientArgs.testFiles.push('test/player_external.js');
   } else {
     // In a normal test run, we serve unit tests.
-    config.files.push('test/**/*_unit.js');
+    clientArgs.testFiles.push('test/**/*_unit.js');
 
     if (!settings.quick) {
       // If --quick is present, we don't serve integration tests.
-      config.files.push('test/**/*_integration.js');
+      clientArgs.testFiles.push('test/**/*_integration.js');
     }
     if (settings.external) {
       // If --external is present, we serve external asset tests.
-      config.files.push('test/**/*_external.js');
+      clientArgs.testFiles.push('test/**/*_external.js');
     }
   }
-  // We just modified the config in-place.  No need for config.set() after we
-  // push to config.files.
+
+  // These are the test files that will be dynamically loaded by boot.js.
+  clientArgs.testFiles = resolveGlobs(clientArgs.testFiles);
 
   const reporters = [];
 
@@ -336,20 +414,54 @@ 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.
     const seed = settings.seed == null ? new Date().getTime() : settings.seed;
 
     // Run tests in a random order.
-    const clientArgs = config.client.args[0];
     clientArgs.random = true;
     clientArgs.seed = seed;
 
     console.log('Using a random test order (--random) with --seed=' + seed);
   }
+
+  if (settings.tls_key && settings.tls_cert) {
+    config.set({
+      protocol: 'https',
+      httpsServerOptions: {
+        key: fs.readFileSync(settings.tls_key),
+        cert: fs.readFileSync(settings.tls_cert),
+      },
+    });
+  }
 };
 
+/**
+ * Resolves a list of paths using globs into a list of explicit paths.
+ * Paths are all relative to the source directory.
+ *
+ * @param {!Array.<string>} list
+ * @return {!Array.<string>}
+ */
+function resolveGlobs(list) {
+  const options = {
+    cwd: __dirname,
+  };
+
+  const resolved = [];
+  for (const path of list) {
+    for (const resolvedPath of glob.sync(path, options)) {
+      resolved.push(resolvedPath);
+    }
+  }
+  return resolved;
+}
+
 /**
  * Determines which launchers and customLaunchers can be used and returns an
  * array of strings.
@@ -416,7 +528,7 @@ function allUsableBrowserLaunchers(config) {
     browsers.push(...Object.keys(config.customLaunchers));
   }
 
-  return browsers;
+  return browsers.sort();
 }
 
 /**
@@ -518,8 +630,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 +715,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/simple_abr_manager.js

@@ -9,7 +9,6 @@ goog.provide('shaka.abr.SimpleAbrManager');
 goog.require('goog.asserts');
 goog.require('shaka.abr.EwmaBandwidthEstimator');
 goog.require('shaka.log');
-goog.require('shaka.util.Iterables');
 goog.require('shaka.util.StreamUtils');
 
 
@@ -142,15 +141,21 @@ shaka.abr.SimpleAbrManager = class {
     // Start by assuming that we will use the first Stream.
     let chosen = sortedVariants[0] || null;
 
-    const enumerate = (it) => shaka.util.Iterables.enumerate(it);
-    for (const {item, next} of enumerate(sortedVariants)) {
+    for (let i = 0; i < sortedVariants.length; i++) {
+      const item = sortedVariants[i];
       const playbackRate =
           !isNaN(this.playbackRate_) ? Math.abs(this.playbackRate_) : 1;
       const itemBandwidth = playbackRate * item.bandwidth;
       const minBandwidth =
           itemBandwidth / this.config_.bandwidthDowngradeTarget;
-      const nextBandwidth =
-          playbackRate * (next || {bandwidth: Infinity}).bandwidth;
+      let next = {bandwidth: Infinity};
+      for (let j = i + 1; j < sortedVariants.length; j++) {
+        if (item.bandwidth != sortedVariants[j].bandwidth) {
+          next = sortedVariants[j];
+          break;
+        }
+      }
+      const nextBandwidth = playbackRate * next.bandwidth;
       const maxBandwidth = nextBandwidth / this.config_.bandwidthUpgradeTarget;
       shaka.log.v2('Bandwidth ranges:',
           (itemBandwidth / 1e6).toFixed(3),
@@ -158,7 +163,8 @@ shaka.abr.SimpleAbrManager = class {
           (maxBandwidth / 1e6).toFixed(3));
 
       if (currentBandwidth >= minBandwidth &&
-          currentBandwidth <= maxBandwidth) {
+          currentBandwidth <= maxBandwidth &&
+          chosen.bandwidth != item.bandwidth) {
         chosen = item;
       }
     }

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/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);
   }
 
@@ -311,10 +314,9 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
    * @private
    */
   mapCompiledToUncompiledPlayerMethodNames_() {
-    // In compiled mode, UI tries to access player methods
-    // by their internal renamed names, but the proxy object doesn't know about
-    // those.
-    // See https://github.com/google/shaka-player/issues/2130 for details.
+    // In compiled mode, UI tries to access player methods by their internal
+    // renamed names, but the proxy object doesn't know about those.  See
+    // https://github.com/shaka-project/shaka-player/issues/2130 for details.
     const methodsToNames = new Map();
     this.iterateOverPlayerMethods_((name, method) => {
       if (methodsToNames.has(method)) {

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/cea/cea608_data_channel.js

@@ -140,8 +140,8 @@ shaka.cea.Cea608DataChannel = class {
     const buf = this.curbuf_;
 
     // Move entire scroll window to a new base in rollup mode.
-    if (this.type_ === shaka.cea.Cea608DataChannel.CaptionType.ROLLUP
-        && row !== buf.getRow()) {
+    if (this.type_ === shaka.cea.Cea608DataChannel.CaptionType.ROLLUP &&
+        row !== buf.getRow()) {
       const oldTopRow = 1 + buf.getRow() - buf.getScrollSize();
       const newTopRow = 1 + row - buf.getScrollSize();
 

package/lib/cea/cea708_service.js

@@ -9,7 +9,6 @@ goog.provide('shaka.cea.Cea708Service');
 goog.require('shaka.cea.Cea708Window');
 goog.require('shaka.cea.DtvccPacket');
 goog.require('shaka.cea.ICaptionDecoder');
-goog.require('shaka.util.Error');
 
 
 /**
@@ -301,17 +300,19 @@ shaka.cea.Cea708Service = class {
   /**
    * Yields each non-null window specified in the 8-bit bitmap.
    * @param {number} bitmap 8 bits corresponding to each of the 8 windows.
-   * @return {!Iterable.<number>}
+   * @return {!Array.<number>}
    * @private
    */
-  * getSpecifiedWindowIds_(bitmap) {
+  getSpecifiedWindowIds_(bitmap) {
+    const ids = [];
     for (let i = 0; i < 8; i++) {
       const windowSpecified = (bitmap & 0x01) === 0x01;
       if (windowSpecified && this.windows_[i]) {
-        yield i;
+        ids.push(i);
       }
       bitmap >>= 1;
     }
+    return ids;
   }
 
   /**

package/lib/cea/mp4_cea_parser.js

@@ -150,11 +150,11 @@ shaka.cea.Mp4CeaParser = class {
 
           // If specified, defaultSampleDuration and defaultSampleSize
           // override the ones specified in the TREX box
-          defaultSampleDuration = parsedTFHD.defaultSampleDuration
-            || this.defaultSampleDuration_;
+          defaultSampleDuration = parsedTFHD.defaultSampleDuration ||
+              this.defaultSampleDuration_;
 
-          defaultSampleSize = parsedTFHD.defaultSampleSize
-            || this.defaultSampleSize_;
+          defaultSampleSize = parsedTFHD.defaultSampleSize ||
+              this.defaultSampleSize_;
 
           const trackId = parsedTFHD.trackId;
 
@@ -236,7 +236,13 @@ shaka.cea.Mp4CeaParser = class {
           });
         }
       } else {
-        reader.skip(naluSize - 1);
+        try {
+          reader.skip(naluSize - 1);
+        } catch (e) {
+          // It is necessary to ignore this error because it can break the start
+          // of playback even if the user does not want to see the subtitles.
+          break;
+        }
       }
       sampleSize -= (naluSize + 4);
       if (sampleSize == 0) {

package/lib/cea/sei_processor.js

@@ -14,9 +14,10 @@ shaka.cea.SeiProcessor = class {
   /**
    * Processes supplemental enhancement information data.
    * @param {!Uint8Array} naluData NALU from which SEI data is to be processed.
-   * @return {!Iterable.<!Uint8Array>}
+   * @return {!Array.<!Uint8Array>}
    */
-  * process(naluData) {
+  process(naluData) {
+    const seiPayloads = [];
     const naluClone = this.removeEmu(naluData);
 
     // The following is an implementation of section 7.3.2.3.1
@@ -41,10 +42,12 @@ shaka.cea.SeiProcessor = class {
       // Payload type 4 is user_data_registered_itu_t_t35, as per the H.264
       // spec. This payload type contains caption data.
       if (payloadType == 0x04) {
-        yield naluClone.subarray(offset, offset + payloadSize);
+        seiPayloads.push(naluClone.subarray(offset, offset + payloadSize));
       }
       offset += payloadSize;
     }
+
+    return seiPayloads;
   }