shaka-player 4.2.1 → 4.2.2

package/lib/media/streaming_engine.js

@@ -320,8 +320,14 @@ shaka.media.StreamingEngine = class {
    * @param {number=} safeMargin
    * @param {boolean=} force
    *   If true, reload the variant even if it did not change.
+   * @param {boolean=} adaptation
+   *   If true, update the media state to indicate MediaSourceEngine should
+   *   reset the timestamp offset to ensure the new track segments are correctly
+   *   placed on the timeline.
    */
-  switchVariant(variant, clearBuffer = false, safeMargin = 0, force = false) {
+  switchVariant(
+      variant, clearBuffer = false, safeMargin = 0, force = false,
+      adaptation = false) {
     this.currentVariant_ = variant;
 
     if (!this.startupComplete_) {
@@ -332,12 +338,14 @@ shaka.media.StreamingEngine = class {
     if (variant.video) {
       this.switchInternal_(
           variant.video, /* clearBuffer= */ clearBuffer,
-          /* safeMargin= */ safeMargin, /* force= */ force);
+          /* safeMargin= */ safeMargin, /* force= */ force,
+          /* adaptation= */ adaptation);
     }
     if (variant.audio) {
       this.switchInternal_(
           variant.audio, /* clearBuffer= */ clearBuffer,
-          /* safeMargin= */ safeMargin, /* force= */ force);
+          /* safeMargin= */ safeMargin, /* force= */ force,
+          /* adaptation= */ adaptation);
     }
   }
 
@@ -383,9 +391,13 @@ shaka.media.StreamingEngine = class {
    * @param {number} safeMargin
    * @param {boolean} force
    *   If true, reload the text stream even if it did not change.
+   * @param {boolean=} adaptation
+   *   If true, update the media state to indicate MediaSourceEngine should
+   *   reset the timestamp offset to ensure the new track segments are correctly
+   *   placed on the timeline.
    * @private
    */
-  switchInternal_(stream, clearBuffer, safeMargin, force) {
+  switchInternal_(stream, clearBuffer, safeMargin, force, adaptation) {
     const ContentType = shaka.util.ManifestParserUtils.ContentType;
     const type = /** @type {!ContentType} */(stream.type);
     const mediaState = this.mediaStates_.get(type);
@@ -440,6 +452,7 @@ shaka.media.StreamingEngine = class {
 
     mediaState.stream = stream;
     mediaState.segmentIterator = null;
+    mediaState.adaptation = !!adaptation;
 
     const streamTag = shaka.media.StreamingEngine.logPrefix_(mediaState);
     shaka.log.debug('switch: switching to Stream ' + streamTag);
@@ -769,12 +782,11 @@ shaka.media.StreamingEngine = class {
     const mediaSourceEngine = this.playerInterface_.mediaSourceEngine;
     const forceTransmuxTS = this.config_.forceTransmuxTS;
 
-
     await mediaSourceEngine.init(streamsByType, forceTransmuxTS,
         this.manifest_.sequenceMode);
     this.destroyer_.ensureNotDestroyed();
 
-    this.setDuration_();
+    this.updateDuration();
 
     for (const type of streamsByType.keys()) {
       const stream = streamsByType.get(type);
@@ -824,9 +836,8 @@ shaka.media.StreamingEngine = class {
 
   /**
    * Sets the MediaSource's duration.
-   * @private
    */
-  setDuration_() {
+  updateDuration() {
     const duration = this.manifest_.presentationTimeline.getDuration();
     if (duration < Infinity) {
       this.playerInterface_.mediaSourceEngine.setDuration(duration);
@@ -1001,7 +1012,11 @@ shaka.media.StreamingEngine = class {
     const timeUntilEnd =
         this.manifest_.presentationTimeline.getDuration() - timeNeeded;
     const oneMicrosecond = 1e-6;
-    if (timeUntilEnd < oneMicrosecond) {
+
+    const bufferEnd =
+      this.playerInterface_.mediaSourceEngine.bufferEnd(mediaState.type);
+
+    if (timeUntilEnd < oneMicrosecond && !!bufferEnd) {
       // We shouldn't rebuffer if the playhead is close to the end of the
       // presentation.
       shaka.log.debug(logPrefix, 'buffered to end of presentation');
@@ -1031,8 +1046,6 @@ shaka.media.StreamingEngine = class {
       return this.config_.updateIntervalSeconds / 2;
     }
 
-    const bufferEnd =
-        this.playerInterface_.mediaSourceEngine.bufferEnd(mediaState.type);
     const reference = this.getSegmentReferenceNeeded_(
         mediaState, presentationTime, bufferEnd);
     if (!reference) {
@@ -1238,7 +1251,16 @@ shaka.media.StreamingEngine = class {
       if (this.config_.lowLatencyMode && isReadableStreamSupported && isMP4 &&
           !reference.hlsAes128Key) {
         let remaining = new Uint8Array(0);
+        let processingResult = false;
+        let callbackCalled = false;
         const streamDataCallback = async (data) => {
+          if (processingResult) {
+            // If the fallback result processing was triggered, don't also
+            // append the buffer here.  In theory this should never happen,
+            // but it does on some older TVs.
+            return;
+          }
+          callbackCalled = true;
           this.destroyer_.ensureNotDestroyed();
           if (this.fatalError_) {
             return;
@@ -1269,7 +1291,33 @@ shaka.media.StreamingEngine = class {
           }
         };
 
-        await this.fetch_(mediaState, reference, streamDataCallback);
+        const result =
+            await this.fetch_(mediaState, reference, streamDataCallback);
+        if (!callbackCalled) {
+          // In some environments, we might be forced to use network plugins
+          // that don't support streamDataCallback. In those cases, as a
+          // fallback, append the buffer here.
+          processingResult = true;
+          this.destroyer_.ensureNotDestroyed();
+          if (this.fatalError_) {
+            return;
+          }
+
+          // If the text stream gets switched between fetch_() and append_(),
+          // the new text parser is initialized, but the new init segment is
+          // not fetched yet.  That would cause an error in
+          // TextParser.parseMedia().
+          // See http://b/168253400
+          if (mediaState.waitingToClearBuffer) {
+            shaka.log.info(logPrefix, 'waitingToClearBuffer, skip append');
+            mediaState.performingUpdate = false;
+            this.scheduleUpdate_(mediaState, 0);
+            return;
+          }
+
+          await this.append_(
+              mediaState, presentationTime, stream, reference, result);
+        }
       } else {
         if (this.config_.lowLatencyMode && !isReadableStreamSupported) {
           shaka.log.warning('Low latency streaming mode is enabled, but ' +
@@ -1590,6 +1638,8 @@ shaka.media.StreamingEngine = class {
             shaka.log.v1(logPrefix, 'appending init segment');
             const hasClosedCaptions = mediaState.stream.closedCaptions &&
                 mediaState.stream.closedCaptions.size > 0;
+            await this.playerInterface_.beforeAppendSegment(
+                mediaState.type, initSegment);
             await this.playerInterface_.mediaSourceEngine.appendBuffer(
                 mediaState.type, initSegment, /* reference= */ null,
                 hasClosedCaptions);
@@ -1640,14 +1690,21 @@ shaka.media.StreamingEngine = class {
     shaka.log.v1(logPrefix, 'appending media segment at',
         (reference.syncTime == null ? 'unknown' : reference.syncTime));
 
+    // 'seeked' or 'adaptation' triggered logic applies only to this
+    // appendBuffer() call.
     const seeked = mediaState.seeked;
     mediaState.seeked = false;
+    const adaptation = mediaState.adaptation;
+    mediaState.adaptation = false;
+
+    await this.playerInterface_.beforeAppendSegment(mediaState.type, segment);
     await this.playerInterface_.mediaSourceEngine.appendBuffer(
         mediaState.type,
         segment,
         reference,
         hasClosedCaptions,
-        seeked);
+        seeked,
+        adaptation);
     this.destroyer_.ensureNotDestroyed();
     shaka.log.v2(logPrefix, 'appended media segment');
   }
@@ -2024,7 +2081,9 @@ shaka.media.StreamingEngine = class {
  *   onEvent: function(!Event),
  *   onManifestUpdate: function(),
  *   onSegmentAppended: function(),
- *   onInitSegmentAppended: function(!number,!shaka.media.InitSegmentReference)
+ *   onInitSegmentAppended: function(!number,!shaka.media.InitSegmentReference),
+ *   beforeAppendSegment: function(
+ *     shaka.util.ManifestParserUtils.ContentType,!BufferSource):Promise
  * }}
  *
  * @property {function():number} getPresentationTime
@@ -2052,6 +2111,9 @@ shaka.media.StreamingEngine = class {
  * @property
  *  {function(!number, !shaka.media.InitSegmentReference)} onInitSegmentAppended
  *   Called when an init segment is appended to a MediaSource.
+ * @property {!function(shaka.util.ManifestParserUtils.ContentType,
+ *   !BufferSource):Promise} beforeAppendSegment
+ *   A function called just before appending to the source buffer.
  */
 shaka.media.StreamingEngine.PlayerInterface;
 
@@ -2075,6 +2137,7 @@ shaka.media.StreamingEngine.PlayerInterface;
  *   clearBufferSafeMargin: number,
  *   clearingBuffer: boolean,
  *   seeked: boolean,
+ *   adaptation: boolean,
  *   recovering: boolean,
  *   hasError: boolean,
  *   operation: shaka.net.NetworkingEngine.PendingRequest
@@ -2121,6 +2184,8 @@ shaka.media.StreamingEngine.PlayerInterface;
  *   True indicates that the buffer is being cleared.
   * @property {boolean} seeked
  *   True indicates that the presentation just seeked.
+  * @property {boolean} adaptation
+ *   True indicates that the presentation just automatically switched variants.
  * @property {boolean} recovering
  *   True indicates that the last segment was not appended because it could not
  *   fit in the buffer.

package/lib/offline/storage.js

@@ -1169,6 +1169,7 @@ shaka.offline.Storage = class {
       isLowLatencyMode: () => false,
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
+      updateDuration: () => {},
     };
 
     parser.configure(config.manifest);

package/lib/player.js

@@ -1770,6 +1770,11 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       enableLowLatencyMode: () => {
         this.configure('streaming.lowLatencyMode', true);
       },
+      updateDuration: () => {
+        if (this.streamingEngine_) {
+          this.streamingEngine_.updateDuration();
+        }
+      },
     };
 
     const startTime = Date.now() / 1000;
@@ -2952,6 +2957,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
           this.qualityObserver_.addMediaQualityChange(mediaQuality, position);
         }
       },
+      beforeAppendSegment: (contentType, segment) => {
+        return this.drmEngine_.parseInbandPssh(contentType, segment);
+      },
     };
 
     return new shaka.media.StreamingEngine(this.manifest_, playerInterface);
@@ -3838,8 +3846,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         return;
       }
 
-      this.switchVariant_(variant, /* fromAdaptation= */ false, clearBuffer,
-          safeMargin);
+      this.switchVariant_(
+          variant, /* fromAdaptation= */ false, clearBuffer, safeMargin);
 
       // Workaround for
       // https://github.com/shaka-project/shaka-player/issues/1299
@@ -5376,7 +5384,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     const currentVariant = this.streamingEngine_.getCurrentVariant();
     if (variant == currentVariant) {
       shaka.log.debug('Variant already selected.');
-      // If you want to clear the buffer, we force to reselect the same variant
+      // If you want to clear the buffer, we force to reselect the same variant.
+      // We don't need to reset the timestampOffset since it's the same variant,
+      // so 'adaptation' isn't passed here.
       if (clearBuffer) {
         this.streamingEngine_.switchVariant(variant, clearBuffer, safeMargin,
             /* force= */ true);
@@ -5386,7 +5396,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
 
     // Add entries to the history.
     this.addVariantToSwitchHistory_(variant, fromAdaptation);
-    this.streamingEngine_.switchVariant(variant, clearBuffer, safeMargin);
+    this.streamingEngine_.switchVariant(
+        variant, clearBuffer, safeMargin, /* force= */ undefined,
+        /* adaptation= */ fromAdaptation);
     let oldTrack = null;
     if (currentVariant) {
       oldTrack = shaka.util.StreamUtils.variantToTrack(currentVariant);
@@ -6570,7 +6582,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.1-uncompiled';
+shaka.Player.version = 'v4.2.2-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/text/ttml_text_parser.js

@@ -164,6 +164,12 @@ shaka.text.TtmlTextParser = class {
           cellResolutionInfo, /* parentCueElement= */ null,
           /* isContent= */ false);
       if (cue) {
+        // According to the TTML spec, backgrounds default to transparent.
+        // So default the background of the top-level element to transparent.
+        // Nested elements may override that background color already.
+        if (!cue.backgroundColor) {
+          cue.backgroundColor = 'transparent';
+        }
         cues.push(cue);
       }
     }

package/lib/util/platform.js

@@ -173,6 +173,30 @@ shaka.util.Platform = class {
         shaka.util.Platform.userAgentContains_('Android');
   }
 
+  /**
+   * Returns a major version number for Chrome, or Chromium-based browsers.
+   *
+   * For example:
+   *   - Chrome 106.0.5249.61 returns 106.
+   *   - Edge 106.0.1370.34 returns 106 (since this is based on Chromium).
+   *   - Safari returns null (since this is independent of Chromium).
+   *
+   * @return {?number} A major version number or null if not Chromium-based.
+   */
+  static chromeVersion() {
+    if (!shaka.util.Platform.userAgentContains_('Chrome')) {
+      return null;
+    }
+
+    // Looking for something like "Chrome/106.0.0.0".
+    const match = navigator.userAgent.match(/Chrome\/(\d+)/);
+    if (match) {
+      return parseInt(match[1], /* base= */ 10);
+    }
+
+    return null;
+  }
+
   /**
    * Check if the current platform is Google Chrome.
    *

package/lib/util/player_configuration.js

@@ -75,6 +75,10 @@ shaka.util.PlayerConfiguration = class {
       updateExpirationTime: 1,
       preferredKeySystems: [],
       keySystemsMapping: {},
+      // The Xbox One browser does not detect DRM key changes signalled by a
+      // change in the PSSH in media segments. We need to parse PSSH from media
+      // segments to detect key changes.
+      parseInbandPsshEnabled: shaka.util.Platform.isXboxOne(),
     };
 
     const manifest = {

package/lib/util/pssh.js

@@ -42,11 +42,12 @@ shaka.util.Pssh = class {
 
     new shaka.util.Mp4Parser()
         .box('moov', shaka.util.Mp4Parser.children)
+        .box('moof', shaka.util.Mp4Parser.children)
         .fullBox('pssh', (box) => this.parsePsshBox_(box))
         .parse(psshBox);
 
     if (this.data.length == 0) {
-      shaka.log.warning('No pssh box found!');
+      shaka.log.v2('No pssh box found!');
     }
   }
 

package/lib/util/stream_utils.js

@@ -474,7 +474,8 @@ shaka.util.StreamUtils = class {
       if (shaka.util.Platform.isXboxOne() && video &&
           ((video.width && video.width > 1920) ||
           (video.height && video.height > 1080)) &&
-          video.codecs.includes('avc1.')) {
+          (video.codecs.includes('avc1.') ||
+          video.codecs.includes('avc3.'))) {
         shaka.log.debug('Dropping variant - not compatible with platform',
             shaka.util.StreamUtils.getVariantSummaryString_(variant));
         return false;

package/package.json

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

package/test/cea/cea608_memory_unit.js

@@ -295,5 +295,93 @@ describe('Cea608Memory', () => {
       const caption = memory.forceEmit(startTime, endTime);
       expect(caption).toEqual(expectedCaption);
     });
+
+    it('does not move rows if source row index is negative', () => {
+      const startTime = 1;
+      const endTime = 2;
+      const text = 'test';
+
+      // Add the text to the buffer, each character on separate rows.
+      // At this point, the memory looks like:
+      // [1]: t
+      // [2]: e
+      // [3]: s
+      // [4]: t
+      for (const c of text) {
+        memory.addChar(CharSet.BASIC_NORTH_AMERICAN,
+            c.charCodeAt(0));
+        memory.setRow(memory.getRow() + 1); // increment row
+      }
+
+      const srcRowIdx = -1;
+      const dstRowIdx = 2;
+      const rowsToMove = 3;
+      memory.moveRows(dstRowIdx, srcRowIdx, rowsToMove);
+
+      // Expected text is 't\ne\ns\nt'
+      const topLevelCue = new shaka.text.Cue(startTime, endTime, '');
+      topLevelCue.nestedCues = [
+        CeaUtils.createDefaultCue(startTime, endTime, 't'),
+        CeaUtils.createLineBreakCue(startTime, endTime),
+        CeaUtils.createDefaultCue(startTime, endTime, 'e'),
+        CeaUtils.createLineBreakCue(startTime, endTime),
+        CeaUtils.createDefaultCue(startTime, endTime, 's'),
+        CeaUtils.createLineBreakCue(startTime, endTime),
+        CeaUtils.createDefaultCue(startTime, endTime, 't'),
+      ];
+
+      const expectedCaption = {
+        stream,
+        cue: topLevelCue,
+      };
+
+      // Force out the new memory.
+      const caption = memory.forceEmit(startTime, endTime);
+      expect(caption).toEqual(expectedCaption);
+    });
+
+    it('does not move rows if destination row index is negative', () => {
+      const startTime = 1;
+      const endTime = 2;
+      const text = 'test';
+
+      // Add the text to the buffer, each character on separate rows.
+      // At this point, the memory looks like:
+      // [1]: t
+      // [2]: e
+      // [3]: s
+      // [4]: t
+      for (const c of text) {
+        memory.addChar(CharSet.BASIC_NORTH_AMERICAN,
+            c.charCodeAt(0));
+        memory.setRow(memory.getRow() + 1); // increment row
+      }
+
+      const srcRowIdx = 1;
+      const dstRowIdx = -2;
+      const rowsToMove = 3;
+      memory.moveRows(dstRowIdx, srcRowIdx, rowsToMove);
+
+      // Expected text is 't\ne\ns\nt'
+      const topLevelCue = new shaka.text.Cue(startTime, endTime, '');
+      topLevelCue.nestedCues = [
+        CeaUtils.createDefaultCue(startTime, endTime, 't'),
+        CeaUtils.createLineBreakCue(startTime, endTime),
+        CeaUtils.createDefaultCue(startTime, endTime, 'e'),
+        CeaUtils.createLineBreakCue(startTime, endTime),
+        CeaUtils.createDefaultCue(startTime, endTime, 's'),
+        CeaUtils.createLineBreakCue(startTime, endTime),
+        CeaUtils.createDefaultCue(startTime, endTime, 't'),
+      ];
+
+      const expectedCaption = {
+        stream,
+        cue: topLevelCue,
+      };
+
+      // Force out the new memory.
+      const caption = memory.forceEmit(startTime, endTime);
+      expect(caption).toEqual(expectedCaption);
+    });
   });
 });

package/test/dash/dash_parser_content_protection_unit.js

@@ -43,6 +43,7 @@ describe('DashParser ContentProtection', () => {
       isLowLatencyMode: () => false,
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
+      updateDuration: () => {},
     };
 
     const actual = await dashParser.start(

package/test/dash/dash_parser_live_unit.js

@@ -36,6 +36,7 @@ describe('DashParser Live', () => {
       isLowLatencyMode: () => false,
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
+      updateDuration: () => {},
     };
   });
 

package/test/dash/dash_parser_manifest_unit.js

@@ -52,6 +52,7 @@ describe('DashParser Manifest', () => {
       isLowLatencyMode: () => false,
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
+      updateDuration: () => {},
     };
   });
 

package/test/dash/dash_parser_segment_base_unit.js

@@ -38,6 +38,7 @@ describe('DashParser SegmentBase', () => {
       isLowLatencyMode: () => false,
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
+      updateDuration: () => {},
     };
   });
 

package/test/dash/dash_parser_segment_list_unit.js

@@ -348,6 +348,7 @@ describe('DashParser SegmentList', () => {
       isLowLatencyMode: () => false,
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
+      updateDuration: () => {},
     };
     const manifest = await dashParser.start('dummy://foo', playerInterface);
     const stream = manifest.variants[0].video;

package/test/dash/dash_parser_segment_template_unit.js

@@ -47,6 +47,7 @@ describe('DashParser SegmentTemplate', () => {
       isLowLatencyMode: () => false,
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
+      updateDuration: () => {},
     };
   });