shaka-player 3.1.4 → 3.3.0

package/lib/cea/cea_utils.js

@@ -15,10 +15,10 @@ shaka.cea.CeaUtils = class {
   /**
    * Emits a closed caption based on the state of the buffer.
    * @param {!shaka.text.Cue} topLevelCue
-   * @param {!string} stream
+   * @param {string} stream
    * @param {!Array<!Array<?shaka.cea.CeaUtils.StyledChar>>} memory
-   * @param {!number} startTime Start time of the cue.
-   * @param {!number} endTime End time of the cue.
+   * @param {number} startTime Start time of the cue.
+   * @param {number} endTime End time of the cue.
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    */
   static getParsedCaption(topLevelCue, stream, memory, startTime, endTime) {
@@ -153,12 +153,12 @@ shaka.cea.CeaUtils = class {
   }
 
   /**
-   * @param {!number} startTime
-   * @param {!number} endTime
-   * @param {!boolean} underline
-   * @param {!boolean} italics
-   * @param {!string} txtColor
-   * @param {!string} bgColor
+   * @param {number} startTime
+   * @param {number} endTime
+   * @param {boolean} underline
+   * @param {boolean} italics
+   * @param {string} txtColor
+   * @param {string} bgColor
    * @return {!shaka.text.Cue}
    */
   static createStyledCue(startTime, endTime, underline,
@@ -176,8 +176,8 @@ shaka.cea.CeaUtils = class {
   }
 
   /**
-   * @param {!number} startTime
-   * @param {!number} endTime
+   * @param {number} startTime
+   * @param {number} endTime
    * @return {!shaka.text.Cue}
    */
   static createLineBreakCue(startTime, endTime) {
@@ -198,61 +198,61 @@ shaka.cea.CeaUtils.StyledChar = class {
    */
   constructor(character, underline, italics, backgroundColor, textColor) {
     /**
-     * @private {!string}
+     * @private {string}
      */
     this.character_ = character;
 
     /**
-     * @private {!boolean}
+     * @private {boolean}
      */
     this.underline_ = underline;
 
     /**
-     * @private {!boolean}
+     * @private {boolean}
      */
     this.italics_ = italics;
 
     /**
-     * @private {!string}
+     * @private {string}
      */
     this.backgroundColor_ = backgroundColor;
 
     /**
-     * @private {!string}
+     * @private {string}
      */
     this.textColor_ = textColor;
   }
 
   /**
-   * @return {!string}
+   * @return {string}
    */
   getChar() {
     return this.character_;
   }
 
   /**
-   * @return {!boolean}
+   * @return {boolean}
    */
   isUnderlined() {
     return this.underline_;
   }
 
   /**
-   * @return {!boolean}
+   * @return {boolean}
    */
   isItalicized() {
     return this.italics_;
   }
 
   /**
-   * @return {!string}
+   * @return {string}
    */
   getBackgroundColor() {
     return this.backgroundColor_;
   }
 
   /**
-   * @return {!string}
+   * @return {string}
    */
   getTextColor() {
     return this.textColor_;
@@ -261,12 +261,12 @@ shaka.cea.CeaUtils.StyledChar = class {
 
 /**
  * Default background color for text.
- * @const {!string}
+ * @const {string}
  */
 shaka.cea.CeaUtils.DEFAULT_BG_COLOR = 'black';
 
 /**
  * Default text color.
- * @const {!string}
+ * @const {string}
  */
 shaka.cea.CeaUtils.DEFAULT_TXT_COLOR = 'white';

package/lib/cea/dtvcc_packet_builder.js

@@ -35,7 +35,7 @@ shaka.cea.DtvccPacketBuilder = class {
 
     /**
      * Keeps track of the number of bytes left to add in the current packet.
-     * @private {!number}
+     * @private {number}
      */
     this.bytesLeftToAddInCurrentPacket_ = 0;
   }
@@ -107,7 +107,7 @@ shaka.cea.DtvccPacket = class {
   constructor(packetData) {
     /**
      * Keeps track of the position to read the next byte from in the packet.
-     * @private {!number}
+     * @private {number}
      */
     this.pos_ = 0;
 
@@ -119,14 +119,14 @@ shaka.cea.DtvccPacket = class {
   }
 
   /**
-   * @return {!boolean}
+   * @return {boolean}
    */
   hasMoreData() {
     return this.pos_ < this.packetData_.length;
   }
 
   /**
-   * @return {!number}
+   * @return {number}
    */
   getPosition() {
     return this.pos_;
@@ -149,7 +149,7 @@ shaka.cea.DtvccPacket = class {
 
   /**
    * Skips the provided number of blocks in the buffer.
-   * @param {!number} numBlocks
+   * @param {number} numBlocks
    * @throws {!shaka.util.Error}
    */
   skip(numBlocks) {
@@ -164,11 +164,11 @@ shaka.cea.DtvccPacket = class {
 };
 
 /**
- * @const {!number}
+ * @const {number}
  */
 shaka.cea.DtvccPacketBuilder.DTVCC_PACKET_DATA = 2;
 
 /**
- * @const {!number}
+ * @const {number}
  */
 shaka.cea.DtvccPacketBuilder.DTVCC_PACKET_START = 3;

package/lib/cea/i_caption_decoder.js

@@ -5,7 +5,6 @@
  */
 
 goog.provide('shaka.cea.ICaptionDecoder');
-goog.provide('shaka.cea.ICaptionDecoder.ClosedCaption');
 
 goog.require('shaka.text.Cue');
 
@@ -23,7 +22,7 @@ shaka.cea.ICaptionDecoder = class {
    * @param {!Uint8Array} userDataSeiMessage
    * This is a User Data registered by Rec.ITU-T T.35 SEI message.
    * It is described in sections D.1.6 and D.2.6 of Rec. ITU-T H.264 (06/2019).
-   * @param {!number} pts PTS when this packet was received, in seconds.
+   * @param {number} pts PTS when this packet was received, in seconds.
    */
   extract(userDataSeiMessage, pts) {}
 
@@ -46,7 +45,7 @@ shaka.cea.ICaptionDecoder = class {
  * Parsed Cue.
  * @typedef {{
  *   cue: !shaka.text.Cue,
- *   stream: !string
+ *   stream: string
  * }}
  */
 shaka.cea.ICaptionDecoder.ClosedCaption;

package/lib/cea/i_cea_parser.js

@@ -39,7 +39,7 @@ shaka.cea.ICeaParser.DEFAULT_TIMESCALE_VALUE = 90000;
 /**
  * @typedef {{
  *   packet: !Uint8Array,
- *   pts: !number
+ *   pts: number
  * }}
  *
  * @description Parsed Caption Packet.
@@ -47,7 +47,7 @@ shaka.cea.ICeaParser.DEFAULT_TIMESCALE_VALUE = 90000;
  * Caption packet. More specifically, it contains a "User data
  * registered by Recommendation ITU-T T.35 SEI message", from section D.1.6
  * and section D.2.6 of Rec. ITU-T H.264 (06/2019).
- * @property {!number} pts
+ * @property {number} pts
  * The presentation timestamp (pts) at which the ITU-T T.35 data shows up.
  * in seconds.
  * @exportDoc

package/lib/cea/mp4_cea_parser.js

@@ -36,13 +36,13 @@ shaka.cea.Mp4CeaParser = class {
 
     /**
      * Default sample duration, as specified by the TREX box.
-     * @private {!number}
+     * @private {number}
      */
     this.defaultSampleDuration_ = 0;
 
     /**
      * Default sample size, as specified by the TREX box.
-     * @private {!number}
+     * @private {number}
      */
     this.defaultSampleSize_ = 0;
   }
@@ -195,10 +195,10 @@ shaka.cea.Mp4CeaParser = class {
   /**
    * Parse MDAT box.
    * @param {!shaka.util.DataViewReader} reader
-   * @param {!number} time
-   * @param {!number} timescale
-   * @param {!number} defaultSampleDuration
-   * @param {!number} defaultSampleSize
+   * @param {number} time
+   * @param {number} timescale
+   * @param {number} defaultSampleDuration
+   * @param {number} defaultSampleSize
    * @param {!Array<shaka.util.ParsedTRUNSample>} sampleData
    * @param {!Array<!shaka.cea.ICeaParser.CaptionPacket>} captionPackets
    * @private

package/lib/dash/dash_parser.js

@@ -19,6 +19,7 @@ goog.require('shaka.media.PresentationTimeline');
 goog.require('shaka.media.SegmentIndex');
 goog.require('shaka.net.NetworkingEngine');
 goog.require('shaka.text.TextEngine');
+goog.require('shaka.util.CmcdManager');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.Functional');
 goog.require('shaka.util.Iterables');
@@ -58,12 +59,12 @@ shaka.dash.DashParser = class {
     this.globalId_ = 1;
 
     /**
-     * A map of IDs to SegmentIndex objects.
+     * A map of IDs to Stream objects.
      * ID: Period@id,AdaptationSet@id,@Representation@id
      * e.g.: '1,5,23'
-     * @private {!Object.<string, !shaka.media.SegmentIndex>}
+     * @private {!Object.<string, !shaka.extern.Stream>}
      */
-    this.segmentIndexMap_ = {};
+    this.streamMap_ = {};
 
     /**
      * A map of period ids to their durations
@@ -164,8 +165,10 @@ shaka.dash.DashParser = class {
   stop() {
     // When the parser stops, release all segment indexes, which stops their
     // timers, as well.
-    for (const segmentIndex of Object.values(this.segmentIndexMap_)) {
-      segmentIndex.release();
+    for (const stream of Object.values(this.streamMap_)) {
+      if (stream.segmentIndex) {
+        stream.segmentIndex.release();
+      }
     }
 
     if (this.periodCombiner_) {
@@ -176,7 +179,7 @@ shaka.dash.DashParser = class {
     this.config_ = null;
     this.manifestUris_ = [];
     this.manifest_ = null;
-    this.segmentIndexMap_ = {};
+    this.streamMap_ = {};
     this.periodCombiner_ = null;
 
     if (this.updateTimer_ != null) {
@@ -224,6 +227,9 @@ shaka.dash.DashParser = class {
         this.manifestUris_, this.config_.retryParameters);
     const networkingEngine = this.playerInterface_.networkingEngine;
 
+    const format = shaka.util.CmcdManager.StreamingFormat.DASH;
+    this.playerInterface_.modifyManifestRequest(request, {format: format});
+
     const startTime = Date.now();
     const operation = networkingEngine.request(requestType, request);
     this.operationManager_.manage(operation);
@@ -301,6 +307,11 @@ shaka.dash.DashParser = class {
     const Functional = shaka.util.Functional;
     const XmlUtils = shaka.util.XmlUtils;
 
+    const manifestPreprocessor = this.config_.dash.manifestPreprocessor;
+    if (manifestPreprocessor) {
+      manifestPreprocessor(mpd);
+    }
+
     // Get any Location elements.  This will update the manifest location and
     // the base URI.
     /** @type {!Array.<string>} */
@@ -373,8 +384,11 @@ shaka.dash.DashParser = class {
       // that the complex logic of multi-Period eviction and period-flattening
       // is correct.  See also:
       // https://github.com/google/shaka-player/issues/3169#issuecomment-823580634
-      for (const segmentIndex of Object.values(this.segmentIndexMap_)) {
-        segmentIndex.evict(presentationTimeline.getSegmentAvailabilityStart());
+      for (const stream of Object.values(this.streamMap_)) {
+        if (stream.segmentIndex) {
+          stream.segmentIndex.evict(
+              presentationTimeline.getSegmentAvailabilityStart());
+        }
       }
     } else {
       // DASH IOP v3.0 suggests using a default delay between minBufferTime
@@ -1158,11 +1172,12 @@ shaka.dash.DashParser = class {
             context, requestInitSegment);
       } else if (context.representation.segmentList) {
         streamInfo = shaka.dash.SegmentList.createStreamInfo(
-            context, this.segmentIndexMap_);
+            context, this.streamMap_);
       } else if (context.representation.segmentTemplate) {
         const hasManifest = !!this.manifest_;
+
         streamInfo = shaka.dash.SegmentTemplate.createStreamInfo(
-            context, requestInitSegment, this.segmentIndexMap_, hasManifest,
+            context, requestInitSegment, this.streamMap_, hasManifest,
             this.config_.dash.initialSegmentLimit, this.periodDurations_);
       } else {
         goog.asserts.assert(isText,
@@ -1215,8 +1230,10 @@ shaka.dash.DashParser = class {
 
     let forced = false;
     if (isText) {
-      // See: https://github.com/google/shaka-player/issues/2122
-      forced = roles.includes('forced_subtitle');
+      // See: https://github.com/google/shaka-player/issues/2122 and
+      // https://github.com/Dash-Industry-Forum/DASH-IF-IOP/issues/165
+      forced = roles.includes('forced_subtitle') ||
+          roles.includes('forced-subtitle');
     }
 
     let tilesLayout;
@@ -1249,13 +1266,29 @@ shaka.dash.DashParser = class {
       hdr = 'PQ';
     }
 
+    const contextId = context.representation.id ?
+        context.period.id + ',' + context.representation.id : '';
+
     /** @type {shaka.extern.Stream} */
     const stream = {
       id: this.globalId_++,
       originalId: context.representation.id,
       createSegmentIndex: async () => {
-        if (!stream.segmentIndex) {
-          stream.segmentIndex = await streamInfo.generateSegmentIndex();
+        // If we have a stream with the same context id stored in the map
+        // that has no segmentIndex, we should set the segmentIndex for it.
+        const storedInMap = contextId && context.dynamic &&
+              this.streamMap_[contextId];
+
+        const currentStream = storedInMap ? this.streamMap_[contextId] : stream;
+        if (!currentStream.segmentIndex) {
+          currentStream.segmentIndex = await streamInfo.generateSegmentIndex();
+        }
+      },
+
+      closeSegmentIndex: () => {
+        if (stream.segmentIndex) {
+          stream.segmentIndex.release();
+          stream.segmentIndex = null;
         }
       },
       segmentIndex: null,
@@ -1285,7 +1318,13 @@ shaka.dash.DashParser = class {
       closedCaptions,
       hdr,
       tilesLayout,
+      matchedStreams: [],
     };
+
+    if (contextId && context.dynamic && !this.streamMap_[contextId]) {
+      this.streamMap_[contextId] = stream;
+    }
+
     return stream;
   }
 

package/lib/dash/segment_base.js

@@ -61,7 +61,9 @@ shaka.dash.SegmentBase = class {
     }
 
     const getUris = () => resolvedUris;
-    return new shaka.media.InitSegmentReference(getUris, startByte, endByte);
+    const qualityInfo = shaka.dash.SegmentBase.createQualityInfo(context);
+    return new shaka.media.InitSegmentReference(
+        getUris, startByte, endByte, qualityInfo);
   }
 
   /**
@@ -346,4 +348,26 @@ shaka.dash.SegmentBase = class {
         indexRange.start, indexRange.end,
         scaledPresentationTimeOffset);
   }
+
+  /**
+   * Create a MediaQualityInfo object from a Context object.
+   *
+   * @param {!shaka.dash.DashParser.Context} context
+   * @return {!shaka.extern.MediaQualityInfo}
+   */
+  static createQualityInfo(context) {
+    const representation = context.representation;
+    return {
+      bandwidth: context.bandwidth,
+      audioSamplingRate: representation.audioSamplingRate,
+      codecs: representation.codecs,
+      contentType: representation.contentType,
+      frameRate: representation.frameRate || null,
+      height: representation.height || null,
+      mimeType: representation.mimeType,
+      channelsCount: representation.numChannels,
+      pixelAspectRatio: representation.pixelAspectRatio || null,
+      width: representation.width || null,
+    };
+  }
 };

package/lib/dash/segment_list.js

@@ -30,10 +30,10 @@ shaka.dash.SegmentList = class {
    * Updates the existing SegmentIndex, if any.
    *
    * @param {shaka.dash.DashParser.Context} context
-   * @param {!Object.<string, !shaka.media.SegmentIndex>} segmentIndexMap
+   * @param {!Object.<string, !shaka.extern.Stream>} streamMap
    * @return {shaka.dash.DashParser.StreamInfo}
    */
-  static createStreamInfo(context, segmentIndexMap) {
+  static createStreamInfo(context, streamMap) {
     goog.asserts.assert(context.representation.segmentList,
         'Should only be called with SegmentList');
     const SegmentList = shaka.dash.SegmentList;
@@ -46,11 +46,14 @@ shaka.dash.SegmentList = class {
 
     /** @type {shaka.media.SegmentIndex} */
     let segmentIndex = null;
-    let id = null;
+    let stream = null;
     if (context.period.id && context.representation.id) {
       // Only check/store the index if period and representation IDs are set.
-      id = context.period.id + ',' + context.representation.id;
-      segmentIndex = segmentIndexMap[id];
+      const id = context.period.id + ',' + context.representation.id;
+      stream = streamMap[id];
+      if (stream) {
+        segmentIndex = stream.segmentIndex;
+      }
     }
 
     const references = SegmentList.createSegmentReferences_(
@@ -64,9 +67,6 @@ shaka.dash.SegmentList = class {
       segmentIndex.mergeAndEvict(references, start);
     } else {
       segmentIndex = new shaka.media.SegmentIndex(references);
-      if (id && context.dynamic) {
-        segmentIndexMap[id] = segmentIndex;
-      }
     }
     context.presentationTimeline.notifySegments(references);
 
@@ -77,8 +77,17 @@ shaka.dash.SegmentList = class {
       segmentIndex.fit(periodStart, periodEnd, isNew);
     }
 
+    if (stream) {
+      stream.segmentIndex = segmentIndex;
+    }
+
     return {
-      generateSegmentIndex: () => Promise.resolve(segmentIndex),
+      generateSegmentIndex: () => {
+        if (!segmentIndex || segmentIndex.isEmpty()) {
+          segmentIndex.merge(references);
+        }
+        return Promise.resolve(segmentIndex);
+      },
     };
   }
 

package/lib/dash/segment_template.js

@@ -31,7 +31,7 @@ shaka.dash.SegmentTemplate = class {
    * @param {shaka.dash.DashParser.Context} context
    * @param {shaka.dash.DashParser.RequestInitSegmentCallback}
    *   requestInitSegment
-   * @param {!Object.<string, !shaka.media.SegmentIndex>} segmentIndexMap
+   * @param {!Object.<string, !shaka.extern.Stream>} streamMap
    * @param {boolean} isUpdate True if the manifest is being updated.
    * @param {number} segmentLimit The maximum number of segments to generate for
    *   a SegmentTemplate with fixed duration.
@@ -39,8 +39,8 @@ shaka.dash.SegmentTemplate = class {
    * @return {shaka.dash.DashParser.StreamInfo}
    */
   static createStreamInfo(
-      context, requestInitSegment, segmentIndexMap, isUpdate,
-      segmentLimit, periodDurationMap) {
+      context, requestInitSegment, streamMap, isUpdate, segmentLimit,
+      periodDurationMap) {
     goog.asserts.assert(context.representation.segmentTemplate,
         'Should only be called with SegmentTemplate');
     const SegmentTemplate = shaka.dash.SegmentTemplate;
@@ -86,10 +86,14 @@ shaka.dash.SegmentTemplate = class {
       /** @type {shaka.media.SegmentIndex} */
       let segmentIndex = null;
       let id = null;
+      let stream = null;
       if (context.period.id && context.representation.id) {
         // Only check/store the index if period and representation IDs are set.
         id = context.period.id + ',' + context.representation.id;
-        segmentIndex = segmentIndexMap[id];
+        stream = streamMap[id];
+        if (stream) {
+          segmentIndex = stream.segmentIndex;
+        }
       }
 
       const references = SegmentTemplate.createFromTimeline_(
@@ -117,9 +121,6 @@ shaka.dash.SegmentTemplate = class {
             context.presentationTimeline.getSegmentAvailabilityStart());
       } else {
         segmentIndex = new shaka.media.SegmentIndex(references);
-        if (id && context.dynamic) {
-          segmentIndexMap[id] = segmentIndex;
-        }
       }
       context.presentationTimeline.notifySegments(references);
 
@@ -127,8 +128,20 @@ shaka.dash.SegmentTemplate = class {
         segmentIndex.fit(periodStart, periodEnd);
       }
 
+      if (stream && context.dynamic) {
+        stream.segmentIndex = segmentIndex;
+      }
+
       return {
-        generateSegmentIndex: () => Promise.resolve(segmentIndex),
+        generateSegmentIndex: () => {
+          // If segmentIndex is deleted, or segmentIndex's references are
+          // released by closeSegmentIndex(), we should set the value of
+          // segmentIndex again.
+          if (!segmentIndex || segmentIndex.isEmpty()) {
+            segmentIndex.merge(references);
+          }
+          return Promise.resolve(segmentIndex);
+        },
       };
     }
   }
@@ -569,8 +582,8 @@ shaka.dash.SegmentTemplate = class {
           baseUris, [filledTemplate]);
       return resolvedUris;
     };
-
-    return new shaka.media.InitSegmentReference(getUris, 0, null);
+    const qualityInfo = shaka.dash.SegmentBase.createQualityInfo(context);
+    return new shaka.media.InitSegmentReference(getUris, 0, null, qualityInfo);
   }
 };