shaka-player 3.2.9 → 3.2.12

package/docs/tutorials/welcome.md

@@ -98,11 +98,14 @@ You can find a full list of available browsers with `--browsers help`, and you
 can find a complete list of testing options with `--help`.
 
 
-#### Join the announcement list
+#### Announcements
 
-If you want to receive release or survey announcements, you should join our
+To subscribe to new releases on GitHub, you can follow
+[instructions from this blog](https://www.jessesquires.com/blog/2020/07/30/github-tip-watching-releases/).
+
+To receive infrequent announcements and surveys from us, you can join our
 [mailing list](https://groups.google.com/forum/#!forum/shaka-player-users).
-The list is very low volume.
+The list is very low volume, and can only be written to by us.
 
 
 #### Continue the Tutorials

package/karma.conf.js

@@ -160,10 +160,6 @@ module.exports = (config) => {
       'node_modules/es6-promise-polyfill/promise.js',
       //   Babel polyfill, required for async/await
       'node_modules/@babel/polyfill/dist/polyfill.js',
-      //   TextDecoder polyfill, required for TextDecoder/TextEncoder on IE and
-      //   legacy Edge
-      //   eslint-disable-next-line max-len
-      'node_modules/fastestsmallesttextencoderdecoder/EncoderDecoderTogether.min.js',
 
       // muxjs module next
       'node_modules/mux.js/dist/mux.min.js',
@@ -306,13 +302,6 @@ module.exports = (config) => {
     // Force failure when running empty test-suites.
     failOnEmptyTestSuite: true,
 
-    coverageReporter: {
-      includeAllSources: true,
-      reporters: [
-        {type: 'text'},
-      ],
-    },
-
     specReporter: {
       suppressSkipped: true,
       showBrowser: true,
@@ -405,9 +394,12 @@ module.exports = (config) => {
 
     config.set({
       coverageReporter: {
+        includeAllSources: true,
         reporters: [
           {type: 'html', dir: 'coverage'},
           {type: 'cobertura', dir: 'coverage', file: 'coverage.xml'},
+          {type: 'json-summary', dir: 'coverage', file: 'coverage.json'},
+          {type: 'json', dir: 'coverage', file: 'coverage-details.json'},
         ],
       },
     });

package/lib/dash/dash_parser.js

@@ -503,6 +503,11 @@ shaka.dash.DashParser = class {
         }
         presentationTimeline.setClockOffset(offset);
       }
+
+      // This is the first point where we have a meaningful presentation start
+      // time, and we need to tell PresentationTimeline that so that it can
+      // maintain consistency from here on.
+      presentationTimeline.lockStartTime();
     } else {
       // Just update the variants and text streams, which may change as periods
       // are added or removed.

package/lib/hls/hls_parser.js

@@ -547,8 +547,14 @@ shaka.hls.HlsParser = class {
     for (const stream of streamsToNotify) {
       this.segmentsToNotifyByStream_.push(stream.segmentIndex.references);
     }
+
     this.notifySegments_();
 
+    // This is the first point where we have a meaningful presentation start
+    // time, and we need to tell PresentationTimeline that so that it can
+    // maintain consistency from here on.
+    this.presentationTimeline_.lockStartTime();
+
     // This asserts that the live edge is being calculated from segment times.
     // For VOD and event streams, this check should still pass.
     goog.asserts.assert(
@@ -1660,8 +1666,6 @@ shaka.hls.HlsParser = class {
       /* presentationStartTime= */ null, /* delay= */ 0);
       this.presentationTimeline_.setStatic(true);
     }
-
-    this.notifySegments_();
   }
 
   /**

package/lib/media/drm_engine.js

@@ -1495,7 +1495,7 @@ shaka.media.DrmEngine = class {
       if (shaka.media.DrmEngine.isPlayReadyKeySystem(
           this.currentDrmInfo_.keySystem) &&
           keyId.byteLength == 16 &&
-          shaka.util.Platform.isEdge()) {
+          (shaka.util.Platform.isEdge() || shaka.util.Platform.isPS4())) {
         // Read out some fields in little-endian:
         const dataView = shaka.util.BufferUtils.toDataView(keyId);
         const part0 = dataView.getUint32(0, /* LE= */ true);

package/lib/media/presentation_timeline.js

@@ -93,6 +93,9 @@ shaka.media.PresentationTimeline = class {
      * @private {number}
      */
     this.availabilityTimeOffset_ = 0;
+
+    /** @private {boolean} */
+    this.startTimeLocked_ = false;
   }
 
 
@@ -229,7 +232,8 @@ shaka.media.PresentationTimeline = class {
     this.maxSegmentEndTime_ =
         Math.max(this.maxSegmentEndTime_, lastReferenceEndTime);
 
-    if (this.presentationStartTime_ != null && this.autoCorrectDrift_) {
+    if (this.presentationStartTime_ != null && this.autoCorrectDrift_ &&
+        !this.startTimeLocked_) {
       // Since we have explicit segment end times, calculate a presentation
       // start based on them.  This start time accounts for drift.
       // Date.now() is in milliseconds, from which we compute "now" in seconds.
@@ -243,6 +247,25 @@ shaka.media.PresentationTimeline = class {
   }
 
 
+  /**
+   * Lock the presentation timeline's start time.  After this is called, no
+   * further adjustments to presentationStartTime_ will be permitted.
+   *
+   * This should be called after all Periods have been parsed, and all calls to
+   * notifySegments() from the initial manifest parse have been made.
+   *
+   * Without this, we can get assertion failures in SegmentIndex for certain
+   * DAI content.  If DAI adds ad segments to the manifest faster than
+   * real-time, adjustments to presentationStartTime_ can cause availability
+   * windows to jump around on updates.
+   *
+   * @export
+   */
+  lockStartTime() {
+    this.startTimeLocked_ = true;
+  }
+
+
   /**
    * Gives PresentationTimeline a Stream's minimum segment start time.
    *

package/lib/media/streaming_engine.js

@@ -1754,6 +1754,7 @@ shaka.media.StreamingEngine = class {
    *
    * @return {!Promise.<BufferSource>}
    * @private
+   * @suppress {strictMissingProperties}
    */
   async fetch_(mediaState, reference, streamDataCallback) {
     const requestType = shaka.net.NetworkingEngine.RequestType.SEGMENT;

package/lib/player.js

@@ -792,14 +792,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     if (!window.Promise) {
       shaka.log.alwaysWarn('A Promise implementation or polyfill is required');
     }
-    if (!window.TextDecoder || !window.TextEncoder) {
-      shaka.log.alwaysWarn(
-          'A TextDecoder/TextEncoder implementation or polyfill is required');
-    }
 
     // Basic features needed for the library to be usable.
     const basicSupport = !!window.Promise && !!window.Uint8Array &&
-                         !!window.TextDecoder && !!window.TextEncoder &&
                          // eslint-disable-next-line no-restricted-syntax
                          !!Array.prototype.forEach;
     if (!basicSupport) {
@@ -4274,6 +4269,12 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       this.stats_.setBandwidthEstimate(estimate);
     }
 
+    if (this.loadMode_ == shaka.Player.LoadMode.SRC_EQUALS) {
+      this.stats_.setResolution(
+          /* width= */ element.videoWidth || NaN,
+          /* height= */ element.videoHeight || NaN);
+    }
+
     return this.stats_.getBlob();
   }
 
@@ -6430,7 +6431,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v3.2.9-uncompiled';
+shaka.Player.version = 'v3.2.12-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/polyfill/media_capabilities.js

@@ -39,7 +39,10 @@ shaka.polyfill.MediaCapabilities = class {
     // Browsers.
     if (!shaka.util.Platform.isChromecast() &&
         !shaka.util.Platform.isApple() &&
+        !shaka.util.Platform.isPS4() &&
         !shaka.util.Platform.isPS5() &&
+        !shaka.util.Platform.isWebOS() &&
+        !shaka.util.Platform.isTizen() &&
         navigator.mediaCapabilities) {
       shaka.log.info(
           'MediaCapabilities: Native mediaCapabilities support found.');

package/lib/polyfill/videoplaybackquality.js

@@ -7,6 +7,7 @@
 goog.provide('shaka.polyfill.VideoPlaybackQuality');
 
 goog.require('shaka.polyfill');
+goog.require('shaka.util.Platform');
 
 
 /**
@@ -33,7 +34,8 @@ shaka.polyfill.VideoPlaybackQuality = class {
       return;
     }
 
-    if ('webkitDroppedFrameCount' in proto) {
+    if ('webkitDroppedFrameCount' in proto ||
+        shaka.util.Platform.isWebOS3()) {
       proto.getVideoPlaybackQuality =
           shaka.polyfill.VideoPlaybackQuality.webkit_;
     }

package/lib/text/cue.js

@@ -41,14 +41,9 @@ shaka.text.Cue = class {
      */
     this.endTime = endTime;
 
-    // The explicit type here is to work around an apparent compiler bug where
-    // the compiler seems to get confused about the type.  Since we are
-    // overriding the interface type, it shouldn't be necessary to do this.
-    // Compiler version 20200517.
     /**
      * @override
      * @exportInterface
-     * @type {string}
      */
     this.payload = payload;
 

package/lib/text/simple_text_displayer.js

@@ -127,16 +127,28 @@ shaka.text.SimpleTextDisplayer = class {
     // We don't want to modify the array or objects passed in, since we don't
     // technically own them.  So we build a new array and replace certain items
     // in it if they need to be flattened.
-    const flattenedCues = cues.map((cue) => {
-      if (cue.nestedCues.length) {
-        const flatCue = cue.clone();
-        flatCue.nestedCues = [];
-        flatCue.payload = flattenPayload(cue);
-        return flatCue;
-      } else {
-        return cue;
+    // We also don't want to flatten the text payloads starting at a container
+    // element; otherwise, for containers encapsulating multiple caption lines,
+    // the lines would merge into a single cue. This is undesirable when a
+    // subset of the captions are outside of the append time window. To fix
+    // this, we only call flattenPayload() starting at elements marked as
+    // isContainer = false.
+    const getCuesToFlatten = (cues, result) => {
+      for (const cue of cues) {
+        if (cue.isContainer) {
+          // Recurse to find the actual text payload cues.
+          getCuesToFlatten(cue.nestedCues, result);
+        } else {
+          // Flatten the payload.
+          const flatCue = cue.clone();
+          flatCue.nestedCues = [];
+          flatCue.payload = flattenPayload(cue);
+          result.push(flatCue);
+        }
       }
-    });
+      return result;
+    };
+    const flattenedCues = getCuesToFlatten(cues, []);
 
     // Convert cues.
     const textTrackCues = [];

package/lib/text/ui_text_displayer.js

@@ -78,6 +78,7 @@ shaka.text.UITextDisplayer = class {
      * the cue (e.g. the HTML element to put nested cues inside).
      * @private {Map.<!shaka.extern.Cue, !{
      *   cueElement: !HTMLElement,
+     *   regionElement: HTMLElement,
      *   wrapper: !HTMLElement
      * }>}
      */
@@ -98,6 +99,9 @@ shaka.text.UITextDisplayer = class {
       });
       this.resizeObserver_.observe(this.textContainer_);
     }
+
+    /** @private {Map.<string, !HTMLElement>} */
+    this.regionElements_ = new Map();
   }
 
 
@@ -235,6 +239,11 @@ shaka.text.UITextDisplayer = class {
         // even ones which are going to be planted again.
         toUproot.push(cueRegistry.cueElement);
 
+        // Also uproot all displayed region elements.
+        if (cueRegistry.regionElement) {
+          toUproot.push(cueRegistry.regionElement);
+        }
+
         // If the cue should not be displayed, remove it entirely.
         if (!shouldBeDisplayed) {
           // Since something has to be removed, we will need to update the DOM.
@@ -269,8 +278,12 @@ shaka.text.UITextDisplayer = class {
       goog.asserts.assert(topCue == cue, 'Parent cues should be kept in order');
     }
     if (updateDOM) {
-      for (const cueElement of toUproot) {
-        container.removeChild(cueElement);
+      for (const element of toUproot) {
+        // NOTE: Because we uproot shared region elements, too, we might hit an
+        // element here that has no parent because we've already processed it.
+        if (element.parentElement) {
+          element.parentElement.removeChild(element);
+        }
       }
       toPlant.sort((a, b) => {
         if (a.startTime != b.startTime) {
@@ -282,7 +295,12 @@ shaka.text.UITextDisplayer = class {
       for (const cue of toPlant) {
         const cueRegistry = this.currentCuesMap_.get(cue);
         goog.asserts.assert(cueRegistry, 'cueRegistry should exist.');
-        container.appendChild(cueRegistry.cueElement);
+        if (cueRegistry.regionElement) {
+          container.appendChild(cueRegistry.regionElement);
+          cueRegistry.regionElement.appendChild(cueRegistry.cueElement);
+        } else {
+          container.appendChild(cueRegistry.cueElement);
+        }
       }
     }
   }
@@ -299,11 +317,15 @@ shaka.text.UITextDisplayer = class {
 
     const currentTime = this.video_.currentTime;
     if (!this.isTextVisible_ || forceUpdate) {
-      if (this.currentCuesMap_.size > 0) {
-        // Clear away any existing cues.
-        shaka.util.Dom.removeAllChildren(this.textContainer_);
-        this.currentCuesMap_.clear();
+      // Remove child elements from all regions.
+      for (const regionElement of this.regionElements_.values()) {
+        shaka.util.Dom.removeAllChildren(regionElement);
       }
+      // Remove all top-level elements in the text container.
+      shaka.util.Dom.removeAllChildren(this.textContainer_);
+      // Clear the element maps.
+      this.currentCuesMap_.clear();
+      this.regionElements_.clear();
     }
     if (this.isTextVisible_) {
       // Log currently attached cue elements for verification, later.
@@ -333,6 +355,54 @@ shaka.text.UITextDisplayer = class {
     }
   }
 
+  /**
+   * Get or create a region element corresponding to the cue region.  These are
+   * cached by ID.
+   *
+   * @param {!shaka.extern.Cue} cue
+   * @return {!HTMLElement}
+   * @private
+   */
+  getRegionElement_(cue) {
+    const region = cue.region;
+
+    if (this.regionElements_.has(region.id)) {
+      return this.regionElements_.get(region.id);
+    }
+
+    const regionElement = shaka.util.Dom.createHTMLElement('span');
+
+    const percentageUnit = shaka.text.CueRegion.units.PERCENTAGE;
+    const heightUnit = region.heightUnits == percentageUnit ? '%' : 'px';
+    const widthUnit = region.widthUnits == percentageUnit ? '%' : 'px';
+    const viewportAnchorUnit =
+        region.viewportAnchorUnits == percentageUnit ? '%' : 'px';
+
+    regionElement.id = 'shaka-text-region---' + region.id;
+    regionElement.classList.add('shaka-text-region');
+
+    regionElement.style.height = region.height + heightUnit;
+    regionElement.style.width = region.width + widthUnit;
+    regionElement.style.position = 'absolute';
+    regionElement.style.top = region.viewportAnchorY + viewportAnchorUnit;
+    regionElement.style.left = region.viewportAnchorX + viewportAnchorUnit;
+
+    regionElement.style.display = 'flex';
+    regionElement.style.flexDirection = 'column';
+    regionElement.style.alignItems = 'center';
+
+    if (cue.displayAlign == shaka.text.Cue.displayAlign.BEFORE) {
+      regionElement.style.justifyContent = 'flex-start';
+    } else if (cue.displayAlign == shaka.text.Cue.displayAlign.CENTER) {
+      regionElement.style.justifyContent = 'center';
+    } else {
+      regionElement.style.justifyContent = 'flex-end';
+    }
+
+    this.regionElements_.set(region.id, regionElement);
+    return regionElement;
+  }
+
   /**
    * Creates the object for a cue.
    *
@@ -360,6 +430,11 @@ shaka.text.UITextDisplayer = class {
       this.setCaptionStyles_(cueElement, cue, parents, needWrapper);
     }
 
+    let regionElement = null;
+    if (cue.region && cue.region.id) {
+      regionElement = this.getRegionElement_(cue);
+    }
+
     let wrapper = cueElement;
     if (needWrapper) {
       // Create a wrapper element which will serve to contain all children into
@@ -371,7 +446,7 @@ shaka.text.UITextDisplayer = class {
       cueElement.appendChild(wrapper);
     }
 
-    this.currentCuesMap_.set(cue, {cueElement, wrapper});
+    this.currentCuesMap_.set(cue, {cueElement, wrapper, regionElement});
   }
 
   /**
@@ -423,6 +498,14 @@ shaka.text.UITextDisplayer = class {
       style.backgroundRepeat = 'no-repeat';
       style.backgroundSize = 'contain';
       style.backgroundPosition = 'center';
+
+      // Quoting https://www.w3.org/TR/ttml-imsc1.2/:
+      // "The width and height (in pixels) of the image resource referenced by
+      // smpte:backgroundImage SHALL be equal to the width and height expressed
+      // by the tts:extent attribute of the region in which the div element is
+      // presented".
+      style.width = '100%';
+      style.height = '100%';
     } else {
       // If we have both text and nested cues, then style everything; otherwise
       // place the text in its own <span> so the background doesn't fill the
@@ -531,17 +614,6 @@ shaka.text.UITextDisplayer = class {
           }
         }
       }
-    } else if (cue.region && cue.region.id) {
-      const percentageUnit = shaka.text.CueRegion.units.PERCENTAGE;
-      const heightUnit = cue.region.heightUnits == percentageUnit ? '%' : 'px';
-      const widthUnit = cue.region.widthUnits == percentageUnit ? '%' : 'px';
-      const viewportAnchorUnit =
-          cue.region.viewportAnchorUnits == percentageUnit ? '%' : 'px';
-      style.height = cue.region.height + heightUnit;
-      style.width = cue.region.width + widthUnit;
-      style.position = 'absolute';
-      style.top = cue.region.viewportAnchorY + viewportAnchorUnit;
-      style.left = cue.region.viewportAnchorX + viewportAnchorUnit;
     }
 
     style.lineHeight = cue.lineHeight;

package/lib/util/buffer_utils.js

@@ -20,6 +20,7 @@ shaka.util.BufferUtils = class {
    * @param {?BufferSource} arr2
    * @return {boolean}
    * @export
+   * @suppress {strictMissingProperties}
    */
   static equal(arr1, arr2) {
     const BufferUtils = shaka.util.BufferUtils;
@@ -135,8 +136,10 @@ shaka.util.BufferUtils = class {
   static view_(data, offset, length, Type) {
     const buffer = shaka.util.BufferUtils.unsafeGetArrayBuffer_(data);
     // Absolute end of the |data| view within |buffer|.
+    /** @suppress {strictMissingProperties} */
     const dataEnd = (data.byteOffset || 0) + data.byteLength;
     // Absolute start of the result within |buffer|.
+    /** @suppress {strictMissingProperties} */
     const rawStart = (data.byteOffset || 0) + offset;
     const start = Math.max(0, Math.min(rawStart, dataEnd));
     // Absolute end of the result within |buffer|.

package/lib/util/object_utils.js

@@ -22,6 +22,7 @@ shaka.util.ObjectUtils = class {
     const seenObjects = new Set();
     // This recursively clones the value |val|, using the captured variable
     // |seenObjects| to track the objects we have already cloned.
+    /** @suppress {strictMissingProperties} */
     const clone = (val) => {
       switch (typeof val) {
         case 'undefined':

package/lib/util/platform.js

@@ -142,6 +142,18 @@ shaka.util.Platform = class {
     return shaka.util.Platform.userAgentContains_('Web0S');
   }
 
+  /**
+   * Check if the current platform is a WebOS 3.
+   *
+   * @return {boolean}
+   */
+  static isWebOS3() {
+    // See: http://webostv.developer.lge.com/discover/specifications/web-engine/
+    return shaka.util.Platform.userAgentContains_('Web0S') &&
+        shaka.util.Platform.userAgentContains_(
+            'Chrome/38.0.2125.122 Safari/537.36');
+  }
+
   /**
    * Check if the current platform is a Google Chromecast.
    *
@@ -175,7 +187,9 @@ shaka.util.Platform = class {
    */
   static isApple() {
     return !!navigator.vendor && navigator.vendor.includes('Apple') &&
-        !shaka.util.Platform.isTizen();
+        !shaka.util.Platform.isTizen() &&
+        !shaka.util.Platform.isEOS() &&
+        !shaka.util.Platform.isPS4();
   }
 
   /**
@@ -191,6 +205,13 @@ shaka.util.Platform = class {
     return shaka.util.Platform.userAgentContains_('PlayStation 5');
   }
 
+  /**
+   * Check if the current platform is Playstation 4.
+   */
+  static isPS4() {
+    return shaka.util.Platform.userAgentContains_('PlayStation 4');
+  }
+
   /**
    * Returns a major version number for Safari, or Safari-based iOS browsers.
    *
@@ -228,6 +249,25 @@ shaka.util.Platform = class {
     return null;
   }
 
+  /**
+   * Check if the current platform is Apple Safari
+   * or Safari-based iOS browsers.
+   *
+   * @return {boolean}
+   */
+  static isSafari() {
+    return !!shaka.util.Platform.safariVersion();
+  }
+
+  /**
+   * Check if the current platform is an EOS set-top box.
+   *
+   * @return {boolean}
+   */
+  static isEOS() {
+    return shaka.util.Platform.userAgentContains_('PC=EOS');
+  }
+
   /**
    * Guesses if the platform is a mobile one (iOS or Android).
    *

package/lib/util/stream_utils.js

@@ -578,8 +578,16 @@ shaka.util.StreamUtils = class {
       // VideoConfiguration
       mediaDecodingConfig.video = {
         contentType: fullType,
-        width: video.width || 1,
-        height: video.height || 1,
+
+        // NOTE: Some decoders strictly check the width and height fields and
+        // won't decode smaller than 64x64.  So if we don't have this info (as
+        // is the case in some of our simpler tests), assume a 64x64 resolution
+        // to fill in this required field for MediaCapabilities.
+        //
+        // This became an issue specifically on Firefox on M1 Macs.
+        width: video.width || 64,
+        height: video.height || 64,
+
         bitrate: video.bandwidth || variant.bandwidth || 1,
         // framerate must be greater than 0, otherwise the config is invalid.
         framerate: video.frameRate || 1,
@@ -742,7 +750,19 @@ shaka.util.StreamUtils = class {
    */
   static patchVp9(codec) {
     if (codec == 'vp9') {
-      return 'vp09.00.10.08';
+      // This means profile 0, level 4.1, 8-bit color.  This supports 1080p @
+      // 60Hz.  See https://en.wikipedia.org/wiki/VP9#Levels
+      //
+      // If we don't have more detailed codec info, assume this profile and
+      // level because it's high enough to likely accommodate the parameters we
+      // do have, such as width and height.  If an implementation is checking
+      // the profile and level very strictly, we want older VP9 content to
+      // still work to some degree.  But we don't want to set a level so high
+      // that it is rejected by a hardware decoder that can't handle the
+      // maximum requirements of the level.
+      //
+      // This became an issue specifically on Firefox on M1 Macs.
+      return 'vp09.00.41.08';
     }
     return codec;
   }