shaka-player 3.3.14 → 3.3.16

package/lib/ads/ad_manager.js

@@ -19,8 +19,8 @@ goog.require('shaka.util.IReleasable');
 
 
 /**
- * @event shaka.ads.AdManager.ADS_LOADED
- * @description Fired when an ad has started playing.
+ * @event shaka.ads.AdManager.AdsLoadedEvent
+ * @description Fired when a sequence of ads has been loaded.
  * @property {string} type
  *   'ads-loaded'
  * @property {number} loadTime

package/lib/media/streaming_engine.js

@@ -603,6 +603,11 @@ shaka.media.StreamingEngine = class {
    * within the presentation timeline.
    */
   seeked() {
+    if (!this.playerInterface_) {
+      // Already destroyed.
+      return;
+    }
+
     const presentationTime = this.playerInterface_.getPresentationTime();
     const smallGapLimit = this.config_.smallGapLimit;
     const ContentType = shaka.util.ManifestParserUtils.ContentType;
@@ -657,7 +662,7 @@ shaka.media.StreamingEngine = class {
 
   /**
    * Clear the buffer for a given stream.  Unlike clearBuffer_, this will handle
-   * cases where a MediaState is performing an update.  After this runs, every
+   * cases where a MediaState is performing an update.  After this runs, the
    * MediaState will have a pending update.
    * @param {!shaka.media.StreamingEngine.MediaState_} mediaState
    * @private
@@ -772,9 +777,9 @@ shaka.media.StreamingEngine = class {
     for (const type of streamsByType.keys()) {
       const stream = streamsByType.get(type);
       if (!this.mediaStates_.has(type)) {
-        const state = this.createMediaState_(stream);
-        this.mediaStates_.set(type, state);
-        this.scheduleUpdate_(state, 0);
+        const mediaState = this.createMediaState_(stream);
+        this.mediaStates_.set(type, mediaState);
+        this.scheduleUpdate_(mediaState, 0);
       }
     }
   }
@@ -884,7 +889,7 @@ shaka.media.StreamingEngine = class {
               'mediastate.stream should not have segmentIndex yet.');
           thisStream.closeSegmentIndex();
         }
-        if (mediaState.updateTimer == null) {
+        if (!mediaState.performingUpdate && !mediaState.updateTimer) {
           this.scheduleUpdate_(mediaState, 0);
         }
         return;
@@ -1352,7 +1357,7 @@ shaka.media.StreamingEngine = class {
         // If the network slows down, abort the current fetch request and start
         // a new one, and ignore the error message.
         mediaState.performingUpdate = false;
-        mediaState.updateTimer = null;
+        this.cancelUpdate_(mediaState);
         this.scheduleUpdate_(mediaState, 0);
       } else if (mediaState.type == ContentType.TEXT &&
           this.config_.ignoreTextStreamFailures) {
@@ -1397,7 +1402,10 @@ shaka.media.StreamingEngine = class {
 
     for (const mediaState of this.mediaStates_.values()) {
       const logPrefix = shaka.media.StreamingEngine.logPrefix_(mediaState);
-      if (mediaState.hasError) {
+      // Only schedule an update if it has an error, but it's not mid-update
+      // and there is not already an update scheduled.
+      if (mediaState.hasError && !mediaState.performingUpdate &&
+          !mediaState.updateTimer) {
         shaka.log.info(logPrefix, 'Retrying after failure...');
         mediaState.hasError = false;
         this.scheduleUpdate_(mediaState, delaySeconds);
@@ -1880,7 +1888,11 @@ shaka.media.StreamingEngine = class {
     shaka.log.debug(logPrefix, 'cleared buffer');
     mediaState.clearingBuffer = false;
     mediaState.endOfStream = false;
-    this.scheduleUpdate_(mediaState, 0);
+    // Since the clear operation was async, check to make sure we're not doing
+    // another update and we don't have one scheduled yet.
+    if (!mediaState.performingUpdate && !mediaState.updateTimer) {
+      this.scheduleUpdate_(mediaState, 0);
+    }
   }
 
 

package/lib/player.js

@@ -1419,6 +1419,12 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     has.startTime = null;
     has.uri = null;
 
+    // Release the region timeline, which is created when parsing the manifest.
+    if (this.regionTimeline_) {
+      this.regionTimeline_.release();
+      this.regionTimeline_ = null;
+    }
+
     // In most cases we should have a media element. The one exception would
     // be if there was an error and we, by chance, did not have a media element.
     if (has.mediaElement) {
@@ -4116,16 +4122,25 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       return [];
     }
     const chapters = [];
+    const uniqueChapters = new Set();
     for (const chaptersTrack of chaptersTracksWithLanguage) {
       if (chaptersTrack && chaptersTrack.cues) {
         for (const cue of chaptersTrack.cues) {
+          let id = cue.id;
+          if (!id || id == '') {
+            id = cue.startTime + '-' + cue.endTime + '-' + cue.text;
+          }
           /** @type {shaka.extern.Chapter} */
           const chapter = {
+            id: id,
             title: cue.text,
             startTime: cue.startTime,
             endTime: cue.endTime,
           };
-          chapters.push(chapter);
+          if (!uniqueChapters.has(id)) {
+            chapters.push(chapter);
+            uniqueChapters.add(id);
+          }
         }
       }
     }
@@ -6648,7 +6663,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v3.3.14-uncompiled';
+shaka.Player.version = 'v3.3.16-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/text/ui_text_displayer.js

@@ -372,6 +372,25 @@ shaka.text.UITextDisplayer = class {
     }
   }
 
+  /**
+   * Compute a unique internal id:
+   * Regions can reuse the id but have different dimensions, we need to
+   * consider those differences
+   * @param {shaka.extern.CueRegion} region
+   * @private
+   */
+  generateRegionId_(region) {
+    const percentageUnit = shaka.text.CueRegion.units.PERCENTAGE;
+    const heightUnit = region.heightUnits == percentageUnit ? '%' : 'px';
+    const viewportAnchorUnit =
+        region.viewportAnchorUnits == percentageUnit ? '%' : 'px';
+    const uniqueRegionId = `${region.id}_${
+      region.width}x${region.height}${heightUnit}-${
+      region.viewportAnchorX}x${region.viewportAnchorY}${viewportAnchorUnit}`;
+
+    return uniqueRegionId;
+  }
+
   /**
    * Get or create a region element corresponding to the cue region.  These are
    * cached by ID.
@@ -383,8 +402,9 @@ shaka.text.UITextDisplayer = class {
   getRegionElement_(cue) {
     const region = cue.region;
 
-    if (this.regionElements_.has(region.id)) {
-      return this.regionElements_.get(region.id);
+    const regionId = this.generateRegionId_(region);
+    if (this.regionElements_.has(regionId)) {
+      return this.regionElements_.get(regionId);
     }
 
     const regionElement = shaka.util.Dom.createHTMLElement('span');
@@ -395,7 +415,7 @@ shaka.text.UITextDisplayer = class {
     const viewportAnchorUnit =
         region.viewportAnchorUnits == percentageUnit ? '%' : 'px';
 
-    regionElement.id = 'shaka-text-region---' + region.id;
+    regionElement.id = 'shaka-text-region---' + regionId;
     regionElement.classList.add('shaka-text-region');
 
     regionElement.style.height = region.height + heightUnit;
@@ -416,7 +436,7 @@ shaka.text.UITextDisplayer = class {
       regionElement.style.justifyContent = 'flex-end';
     }
 
-    this.regionElements_.set(region.id, regionElement);
+    this.regionElements_.set(regionId, regionElement);
     return regionElement;
   }
 

package/lib/text/web_vtt_generator.js

@@ -87,16 +87,28 @@ shaka.text.WebVttGenerator = 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, []);
 
     let webvttString = 'WEBVTT\n\n';
     for (const cue of flattenedCues) {

package/lib/util/dom_utils.js

@@ -36,7 +36,9 @@ shaka.util.Dom = class {
    * @return {!HTMLButtonElement}
    */
   static createButton() {
-    return /** @type {!HTMLButtonElement} */(document.createElement('button'));
+    const button = document.createElement('button');
+    button.setAttribute('type', 'button');
+    return /** @type {!HTMLButtonElement} */ (button);
   }
 
 

package/lib/util/stream_utils.js

@@ -450,12 +450,16 @@ shaka.util.StreamUtils = class {
           if (!MediaSource.isTypeSupported(audioFullType)) {
             return false;
           }
+          // Update the codec string with the (possibly) converted codecs.
+          videoCodecs = [videoCodecs, audioCodecs].join(',');
         }
         const fullType = shaka.util.MimeUtils.getFullOrConvertedType(
             video.mimeType, videoCodecs, ContentType.VIDEO);
         if (!MediaSource.isTypeSupported(fullType)) {
           return false;
         }
+        // Update the codec string with the (possibly) converted codecs.
+        video.codecs = videoCodecs;
       }
       const audio = variant.audio;
       if (audio) {
@@ -466,6 +470,8 @@ shaka.util.StreamUtils = class {
         if (!MediaSource.isTypeSupported(fullType)) {
           return false;
         }
+        // Update the codec string with the (possibly) converted codecs.
+        audio.codecs = codecs;
       }
 
       // See: https://github.com/shaka-project/shaka-player/issues/3380

package/lib/util/timer.js

@@ -78,6 +78,11 @@ shaka.util.Timer = class {
   tickEvery(seconds) {
     this.stop();
 
+    if (goog.DEBUG) {
+      // Capture the stack trace by making a fake error.
+      const stackTrace = Error('Timer created').stack;
+      shaka.util.Timer.activeTimers.set(this, stackTrace);
+    }
     this.ticker_ = new shaka.util.DelayedTick(() => {
       // Schedule the timer again first. |onTick_| could cancel the timer and
       // rescheduling first simplifies the implementation.
@@ -99,5 +104,17 @@ shaka.util.Timer = class {
       this.ticker_.stop();
       this.ticker_ = null;
     }
+    if (goog.DEBUG) {
+      shaka.util.Timer.activeTimers.delete(this);
+    }
   }
 };
+
+if (goog.DEBUG) {
+  /**
+   * Tracks all active timer instances, along with the stack trace that created
+   * that timer.
+   * @type {!Map.<!shaka.util.Timer, string>}
+   */
+  shaka.util.Timer.activeTimers = new Map();
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.3.14",
+  "version": "3.3.16",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [

package/test/player_integration.js

@@ -72,6 +72,33 @@ describe('Player', () => {
     });
   });  // describe('attach')
 
+  describe('destroy', () => {
+    // Regression test for:
+    // https://github.com/shaka-project/shaka-player/issues/4850
+    it('does not leave any lingering timers', async () => {
+      shaka.util.Timer.activeTimers.clear();
+
+      // Unlike the other tests in this file, this uses an uncompiled build of
+      // Shaka, so that we don't need to expose shaka.util.Timer.activeTimers.
+      player = new shaka.Player(video);
+      waiter.setPlayer(player);
+
+      // Play the video for a little while.
+      await player.load('test:sintel');
+      video.play();
+      await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
+
+      // Destroy the player.
+      await player.destroy();
+
+      // Are there any timers left?
+      for (const timer of shaka.util.Timer.activeTimers.keys()) {
+        const stackTrace = shaka.util.Timer.activeTimers.get(timer);
+        fail('Lingering timer exists! Stack trace of creation: ' + stackTrace);
+      }
+    });
+  });
+
   describe('updateStartTime() in manifestparsed event handler', () => {
     it('does not get segments prior to startTime', async () => {
       player.addEventListener('manifestparsed', () => {
@@ -879,7 +906,7 @@ describe('Player', () => {
       expect(getBufferedBehind()).toBe(20);  // Buffered to start still.
       video.currentTime = 50;
       await waitUntilBuffered(30);
-      expect(getBufferedBehind()).toBeLessThan(30);
+      expect(getBufferedBehind()).toBeLessThan(40);  // 30 + segment_size
 
       player.configure('streaming.bufferBehind', 10);
       // We only evict content when we append a segment, so increase the
@@ -906,7 +933,7 @@ describe('Player', () => {
     }
 
     async function waitUntilBuffered(amount) {
-      for (let i = 0; i < 25; i++) {
+      for (let i = 0; i < 50; i++) {
         // We buffer from an internal segment, so this shouldn't take long to
         // buffer.
         await Util.delay(0.1);  // eslint-disable-line no-await-in-loop
@@ -914,7 +941,14 @@ describe('Player', () => {
           return;
         }
       }
-      throw new Error('Timeout waiting to buffer');
+
+      const ranges =
+          shaka.media.TimeRangesUtils.getBufferedInfo(video.buffered);
+      const currentTime = video.currentTime;
+      const target = currentTime + amount;
+
+      throw new Error('Timeout waiting to buffer! ' +
+          JSON.stringify({ranges, currentTime, target}));
     }
   });  // describe('buffering')
 

package/test/player_unit.js

@@ -3185,7 +3185,9 @@ describe('Player', () => {
           variant.addAudio(0, (stream) => {
             stream.channelsCount = 6;
             stream.audioSamplingRate = 48000;
-            stream.codecs = 'ac-3';
+            // ac-3 is rewritten as ec-3 on Tizen, so for the stability of this
+            // test case, use ec-3.
+            stream.codecs = 'ec-3';
           });
         });
 
@@ -3210,7 +3212,7 @@ describe('Player', () => {
       expect(abrManager.variants.length).toBe(1);
       // It should be the 6-channel variant, based on our preference.
       expect(abrManager.variants[0].audio.channelsCount).toBe(6);
-      expect(abrManager.variants[0].audio.codecs).toBe('ac-3');
+      expect(abrManager.variants[0].audio.codecs).toBe('ec-3');
     });
   });
 

package/test/test/boot.js

@@ -66,22 +66,40 @@ function failTestsOnNamespacedElementOrAttributeNames() {
 }
 
 /**
- * Listen for unhandled Promise rejections (which may occur after a test) and
- * convert them into test failures.
+ * Fail the current test on a given error, constructed with a given header and
+ * the full stack trace of the error.
+ *
+ * @param {string} messageHeader
+ * @param {!Error} error
  */
-function failTestsOnUnhandledRejections() {
+function failOnError(messageHeader, error) {
+  let message = `${messageHeader}: ${error}`;
+  // Shaka errors have the stack trace in their toString() already, so don't
+  // add it again.  For native errors, we need to see where it came from.
+  if (error && error.stack && !(error instanceof shaka.util.Error)) {
+    message += '\n' + error.stack;
+  }
+  fail(message);
+}
+
+/**
+ * Listen for unhandled errors and Promise rejections (which may occur after a
+ * test) and convert them into test failures.
+ */
+function failTestsOnUnhandledErrors() {
   // https://developer.mozilla.org/en-US/docs/Web/Events/unhandledrejection
   window.addEventListener('unhandledrejection', (event) => {
     /** @type {?} */
     const error = event.reason;
-    let message = 'Unhandled rejection in Promise: ' + error;
+    failOnError('Unhandled rejection in Promise', error);
+  });
 
-    // Shaka errors have the stack trace in their toString() already, so don't
-    // add it again.  For native errors, we need to see where it came from.
-    if (error && error.stack && !(error instanceof shaka.util.Error)) {
-      message += '\n' + error.stack;
-    }
-    fail(message);
+  // https://developer.mozilla.org/en-US/docs/Web/API/Window/error_event
+  // https://developer.mozilla.org/en-US/docs/Web/API/ErrorEvent
+  window.addEventListener('error', (event) => {
+    /** @type {?} */
+    const error = event['error'];
+    failOnError('Unhandled error', error);
   });
 }
 
@@ -387,7 +405,7 @@ function configureJasmineEnvironment() {
 function setupTestEnvironment() {
   failTestsOnFailedAssertions();
   failTestsOnNamespacedElementOrAttributeNames();
-  failTestsOnUnhandledRejections();
+  failTestsOnUnhandledErrors();
   disableScrollbars();
   workAroundLegacyEdgePromiseIssues();
 

package/test/test/util/test_scheme.js

@@ -402,7 +402,7 @@ const sintelAudioSegment = {
   mdhdOffset: 0x1b6,
   segmentUri: '/base/test/test/assets/sintel-audio-segment.mp4',
   tfdtOffset: 0x3c,
-  segmentDuration: 10.005,
+  segmentDuration: 10,
   mimeType: 'audio/mp4',
   codecs: 'mp4a.40.2',
 };
@@ -428,7 +428,7 @@ const sintelEncryptedAudio = {
   mdhdOffset: 0x1b6,
   segmentUri: '/base/test/test/assets/encrypted-sintel-audio-segment.mp4',
   tfdtOffset: 0x3c,
-  segmentDuration: 10.005,
+  segmentDuration: 10,
   mimeType: 'audio/mp4',
   codecs: 'mp4a.40.2',
   initData:

package/test/text/ui_text_displayer_unit.js

@@ -537,4 +537,74 @@ describe('UITextDisplayer', () => {
         '.shaka-text-region');
     expect(allRegionElements.length).toBe(1);
   });
+
+  it('creates separate regions when dimensions differ but id same', () => {
+    const identicalRegionId = 'regionId';
+
+    const cueRegion1 = new shaka.text.CueRegion();
+    const cueRegion2 = new shaka.text.CueRegion();
+    cueRegion1.id = identicalRegionId;
+    cueRegion2.id = identicalRegionId;
+
+    cueRegion1.height = 80;
+    cueRegion1.heightUnits = shaka.text.CueRegion.units.PERCENTAGE;
+    cueRegion1.width = 80;
+    cueRegion1.widthUnits = shaka.text.CueRegion.units.PERCENTAGE;
+
+    cueRegion2.height = 160; // the only difference!
+    cueRegion2.heightUnits = shaka.text.CueRegion.units.PERCENTAGE;
+    cueRegion2.width = 80;
+    cueRegion2.widthUnits = shaka.text.CueRegion.units.PERCENTAGE;
+
+    cueRegion1.viewportAnchorX = 10;
+    cueRegion1.viewportAnchorY = 10;
+    cueRegion1.viewportAnchorUnits = shaka.text.CueRegion.units.PERCENTAGE;
+
+    cueRegion2.viewportAnchorX = 10;
+    cueRegion2.viewportAnchorY = 10;
+    cueRegion2.viewportAnchorUnits = shaka.text.CueRegion.units.PERCENTAGE;
+
+    // These all attach to the same region, but only one region element should
+    // be created.
+    const firstBatchOfCues = [
+      new shaka.text.Cue(0, 100, ''),
+      new shaka.text.Cue(0, 100, ''),
+      new shaka.text.Cue(0, 100, ''),
+    ];
+    for (const cue of firstBatchOfCues) {
+      cue.displayAlign = shaka.text.Cue.displayAlign.CENTER;
+      cue.region = cueRegion1;
+    }
+
+    // Another batch for the other region
+    const secondBatchOfCues = [
+      new shaka.text.Cue(0, 100, ''),
+      new shaka.text.Cue(0, 100, ''),
+      new shaka.text.Cue(0, 100, ''),
+    ];
+    for (const cue of secondBatchOfCues) {
+      cue.displayAlign = shaka.text.Cue.displayAlign.CENTER;
+      cue.region = cueRegion2;
+    }
+
+    textDisplayer.setTextVisibility(true);
+    textDisplayer.append(firstBatchOfCues);
+    textDisplayer.append(secondBatchOfCues);
+    updateCaptions();
+
+    const textContainer = videoContainer.querySelector('.shaka-text-container');
+    const allRegionElements = textContainer.querySelectorAll(
+        '.shaka-text-region');
+
+    // Verify that the nested cues are attached to respective region element.
+    expect(allRegionElements.length).toBe(2);
+
+    const childrenOfOne = Array.from(allRegionElements[0].childNodes).filter(
+        (e) => e.nodeType == Node.ELEMENT_NODE);
+    expect(childrenOfOne.length).toBe(3);
+
+    const childrenOfTwo = Array.from(allRegionElements[1].childNodes).filter(
+        (e) => e.nodeType == Node.ELEMENT_NODE);
+    expect(childrenOfTwo.length).toBe(3);
+  });
 });