shaka-player 3.2.0 → 3.2.4

package/docs/tutorials/fairplay.md

@@ -31,7 +31,7 @@ player.configure('drm.initDataTransform', (initData, initDataType) => {
 
   // 'initData' is a buffer containing an 'skd://' URL as a UTF-8 string.
   const skdUri = shaka.util.StringUtils.fromBytesAutoDetect(initData);
-  const contentId = getMyContentId(sdkUri);
+  const contentId = getMyContentId(skdUri);
   const cert = player.drmInfo().serverCertificate;
   return shaka.util.FairPlayUtils.initDataTransform(initData, contentId, cert);
 });

package/docs/tutorials/faq.md

@@ -260,6 +260,20 @@ the {@link shaka.extern.ManifestConfiguration|`.manifest.disableVideo`} or
 configurations to signal that your content does not have a video or audio 
 stream.
 
+<hr>
+
+**Q:** How can I make Shaka Player work with Vue?
+
+**A:** Currently, Shaka Player does not support being made into a Vue reactive
+object. When Vue wraps an object in a reactive Proxy, it
+{@link https://v3.vuejs.org/guide/reactivity.html#proxied-objects|also wraps
+nested objects}. This results in Vue converting some of our internal values into
+Proxy objects, which causes failures at load-time.
+If you want to use Shaka Player in Vue, avoid making it into a reactive object;
+so don't declare it using a ref(), and if you put your player instance into a
+data() object, you can prefix the property name with "$" or "_" to make Vue not
+proxy them.
+
 [386]: https://github.com/google/shaka-player/issues/386#issuecomment-227898001
 [489]: https://github.com/google/shaka-player/issues/489#issuecomment-240466224
 [743]: https://github.com/google/shaka-player/issues/743

package/docs/tutorials/ui.md

@@ -30,7 +30,7 @@ Set up controls with HTML data attributes:
          The data-shaka-player-cast-receiver-id tag allows you to provide a Cast Application ID that
            the cast button will cast to; the value provided here is the sample cast receiver. -->
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="E7271BEC">
        <!-- The data-shaka-player tag will make the UI library use this video element.
             If no video is provided, the UI will automatically make one inside the container div. -->
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%"></video>
@@ -111,7 +111,7 @@ set up a listener for the 'caststatuschanged' events.
 <!-- Add a data-shaka-player-cast-receiver-id tag to provide a Cast Application ID that
            the cast button will cast to; the value provided here is the sample cast receiver. -->
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="E7271BEC">
     </div>
 ```
 
@@ -137,7 +137,7 @@ or a `<source>` tag inside it to enable auto loading of the specified content.
 
 ```html
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="E7271BEC">
       <!-- The manifest url in the src attribute will be automatically loaded -->
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%"
        src="https://storage.googleapis.com/shaka-demo-assets/angel-one/dash.mpd"></video>
@@ -148,7 +148,7 @@ or
 
 ```html
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="E7271BEC">
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%">
         <!-- The manifest url in the src attribute will be auto loaded -->
        <source src="https://storage.googleapis.com/shaka-demo-assets/angel-one/dash.mpd"/>
@@ -161,7 +161,7 @@ call to the first one fails.
 
 ```html
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="E7271BEC">
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%">
         <!-- Try this first -->
         <source src="https://storage.googleapis.com/shaka-demo-assets/angel-one/dash.mpd"/>

package/externs/ima.js

@@ -43,6 +43,8 @@ google.ima.AdsLoader = class {
 
   /** @override */
   dispatchEvent() {}
+
+  destroy() {}
 };
 
 
@@ -79,6 +81,8 @@ google.ima.AdsManager = class {
 
   stop() {}
 
+  destroy() {}
+
   /**
    * @param {number} volume
    */

package/externs/shaka/ads.js

@@ -33,6 +33,24 @@
 shaka.extern.AdsStats;
 
 
+/**
+ * @typedef {{
+ *   start: number,
+ *   end: ?number
+ * }}
+ *
+ * @description
+ * Contains the times of a range of an Ad.
+ *
+ * @property {number} start
+ *   The start time of the range, in milliseconds.
+ * @property {number} end
+ *   The end time of the range, in milliseconds.
+ * @exportDoc
+ */
+shaka.extern.AdCuePoint;
+
+
 /**
  * An object that's responsible for all the ad-related logic
  * in the player.
@@ -46,6 +64,8 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   setLocale(locale) {}
 
+  release() {}
+
   onAssetUnload() {}
 
   /**
@@ -77,6 +97,11 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   replaceServerSideAdTagParameters(adTagParameters) {}
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   */
+  getServerSideCuePoints() {}
+
   /**
    * Get statistics for the current playback session. If the player is not
    * playing content, this will return an empty stats object.

package/externs/shaka/player.js

@@ -1082,6 +1082,8 @@ shaka.extern.LanguageRole;
 
 /**
  * @typedef {{
+ *   imageHeight: number,
+ *   imageWidth: number,
  *   height: number,
  *   positionX: number,
  *   positionY: number,
@@ -1091,6 +1093,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

@@ -349,6 +349,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/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');
 
@@ -140,6 +141,7 @@ module.exports = (config) => {
         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/locales/en.json', included: false},
@@ -335,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.
@@ -517,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);
@@ -603,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/ads/ad_manager.js

@@ -6,7 +6,6 @@
 
 
 goog.provide('shaka.ads.AdManager');
-goog.provide('shaka.ads.CuePoint');
 
 goog.require('shaka.Player');
 goog.require('shaka.ads.AdsStats');
@@ -16,6 +15,7 @@ goog.require('shaka.log');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.FakeEvent');
 goog.require('shaka.util.FakeEventTarget');
+goog.require('shaka.util.IReleasable');
 
 
 /**
@@ -359,6 +359,7 @@ goog.require('shaka.util.FakeEventTarget');
 /**
  * A class responsible for ad-related interactions.
  * @implements {shaka.extern.IAdManager}
+ * @implements {shaka.util.IReleasable}
  * @export
  */
 shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
@@ -403,6 +404,10 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
           shaka.util.Error.Code.CS_IMA_SDK_MISSING);
     }
 
+    if (this.csAdManager_) {
+      this.csAdManager_.release();
+    }
+
     this.csAdManager_ = new shaka.ads.ClientSideAdManager(
         adContainer, video, this.locale_,
         (e) => {
@@ -430,6 +435,23 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 
 
+  /**
+   * @override
+   * @export
+   */
+  release() {
+    if (this.csAdManager_) {
+      this.csAdManager_.release();
+      this.csAdManager_ = null;
+    }
+    if (this.ssAdManager_) {
+      this.ssAdManager_.release();
+      this.ssAdManager_ = null;
+    }
+    super.release();
+  }
+
+
   /**
   * @override
   * @export
@@ -438,21 +460,13 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     if (this.csAdManager_) {
       this.csAdManager_.stop();
     }
+    if (this.ssAdManager_) {
+      this.ssAdManager_.stop();
+    }
 
     this.dispatchEvent(
         new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED));
 
-    // TODO:
-    // For SS DAI streams, if a different asset gets unloaded as
-    // part of the process
-    // of loading a DAI asset, stream manager state gets reset and we
-    // don't get any ad events.
-    // We need to figure out if it makes sense to stop the SS
-    // manager on unload, and, if it does, find
-    // a way to do it safely.
-    // if (this.ssAdManager_) {
-    //   this.ssAdManager_.stop();
-    // }
     this.stats_ = new shaka.ads.AdsStats();
   }
 
@@ -491,6 +505,10 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
           shaka.util.Error.Code.SS_IMA_SDK_MISSING);
     }
 
+    if (this.ssAdManager_) {
+      this.ssAdManager_.release();
+    }
+
     this.ssAdManager_ = new shaka.ads.ServerSideAdManager(
         adContainer, video, this.locale_,
         (e) => {
@@ -576,6 +594,22 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   * @override
+   * @export
+   */
+  getServerSideCuePoints() {
+    if (!this.ssAdManager_) {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.RECOVERABLE,
+          shaka.util.Error.Category.ADS,
+          shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
+    }
+    return this.ssAdManager_.getCuePoints();
+  }
+
+
   /**
    * @return {shaka.extern.AdsStats}
    * @override
@@ -628,20 +662,6 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 };
 
-
-shaka.ads.CuePoint = class {
-  /**
-   * @param {number} start
-   * @param {?number=} end
-   */
-  constructor(start, end = null) {
-    /** @public {number} */
-    this.start = start;
-    /** @public {?number} */
-    this.end = end;
-  }
-};
-
 /**
  * The event name for when a sequence of ads has been loaded.
  *