shaka-player 3.1.3 → 3.2.2

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

@@ -95,6 +95,18 @@ shaka.dash.DashParser = class {
     /** @private {!shaka.util.OperationManager} */
     this.operationManager_ = new shaka.util.OperationManager();
 
+    /**
+     * Largest period start time seen.
+     * @private {?number}
+     */
+    this.largestPeriodStartTime_ = null;
+
+    /**
+     * Period IDs seen in previous manifest.
+     * @private {!Array.<number>}
+     */
+    this.lastManifestUpdatePeriodIds_ = [];
+
     /**
      * The minimum of the availabilityTimeOffset values among the adaptation
      * sets.
@@ -289,6 +301,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>} */
@@ -533,6 +550,7 @@ shaka.dash.DashParser = class {
     for (const {i, item: elem, next} of enumerate(periodNodes)) {
       const start = /** @type {number} */ (
         XmlUtils.parseAttr(elem, 'start', XmlUtils.parseDuration, prevEnd));
+      const periodId = elem.id;
       const givenDuration =
           XmlUtils.parseAttr(elem, 'duration', XmlUtils.parseDuration);
 
@@ -566,6 +584,42 @@ shaka.dash.DashParser = class {
         periodDuration = givenDuration;
       }
 
+      /**
+       * This is to improve robustness when the player observes manifest with
+       * past periods that are inconsistent to previous ones.
+       *
+       * This may happen when a CDN or proxy server switches its upstream from
+       * one encoder to another redundant encoder.
+       *
+       * Skip periods that match all of the following criteria:
+       * - Start time is earlier than latest period start time ever seen
+       * - Period ID is never seen in the previous manifest
+       * - Not the last period in the manifest
+       *
+       * Periods that meet the aforementioned criteria are considered invalid
+       * and should be safe to discard.
+       */
+
+      if (this.largestPeriodStartTime_ !== null &&
+        periodId !== null && start !== null &&
+        start < this.largestPeriodStartTime_ &&
+        !this.lastManifestUpdatePeriodIds_.includes(periodId) &&
+        i + 1 != periodNodes.length) {
+        shaka.log.debug(
+            `Skipping Period with ID ${periodId} as its start time is smaller` +
+            ' than the largest period start time that has been seen, and ID ' +
+            'is unseen before');
+        continue;
+      }
+
+
+      // Save maximum period start time if it is the last period
+      if (start !== null &&
+        (this.largestPeriodStartTime_ === null ||
+          start > this.largestPeriodStartTime_)) {
+        this.largestPeriodStartTime_ = start;
+      }
+
       // Parse child nodes.
       const info = {
         start: start,
@@ -597,6 +651,9 @@ shaka.dash.DashParser = class {
       prevEnd = start + periodDuration;
     } // end of period parsing loop
 
+    // Replace previous seen periods with the current one.
+    this.lastManifestUpdatePeriodIds_ = periods.map((el) => el.id);
+
     if (presentationDuration != null) {
       if (prevEnd != presentationDuration) {
         shaka.log.warning(
@@ -808,6 +865,25 @@ shaka.dash.DashParser = class {
       }
     }
 
+    // Parallel for HLS VIDEO-RANGE as defined in DASH-IF IOP v4.3 6.2.5.1.
+    let videoRange;
+    const videoRangeScheme = 'urn:mpeg:mpegB:cicp:TransferCharacteristics';
+    const getVideoRangeFromTransferCharacteristicCICP = (cicp) => {
+      switch (cicp) {
+        case 1:
+        case 6:
+        case 13:
+        case 14:
+        case 15:
+          return 'SDR';
+        case 16:
+          return 'PQ';
+        case 18:
+          return 'HLG';
+      }
+      return undefined;
+    };
+
     const essentialProperties =
         XmlUtils.findChildren(elem, 'EssentialProperty');
     // ID of real AdaptationSet if this is a trick mode set:
@@ -817,11 +893,26 @@ shaka.dash.DashParser = class {
       const schemeId = prop.getAttribute('schemeIdUri');
       if (schemeId == 'http://dashif.org/guidelines/trickmode') {
         trickModeFor = prop.getAttribute('value');
+      } else if (schemeId == videoRangeScheme) {
+        videoRange = getVideoRangeFromTransferCharacteristicCICP(
+            parseInt(prop.getAttribute('value'), 10),
+        );
       } else {
         unrecognizedEssentialProperty = true;
       }
     }
 
+    const supplementalProperties =
+        XmlUtils.findChildren(elem, 'SupplementalProperty');
+    for (const prop of supplementalProperties) {
+      const schemeId = prop.getAttribute('schemeIdUri');
+      if (schemeId == videoRangeScheme) {
+        videoRange = getVideoRangeFromTransferCharacteristicCICP(
+            parseInt(prop.getAttribute('value'), 10),
+        );
+      }
+    }
+
     const accessibilities = XmlUtils.findChildren(elem, 'Accessibility');
     const LanguageUtils = shaka.util.LanguageUtils;
     const closedCaptions = new Map();
@@ -947,8 +1038,13 @@ shaka.dash.DashParser = class {
     // Parse Representations into Streams.
     const representations = XmlUtils.findChildren(elem, 'Representation');
     const streams = representations.map((representation) => {
-      return this.parseRepresentation_(context, contentProtection, kind,
-          language, label, main, roleValues, closedCaptions, representation);
+      const parsedRepresentation = this.parseRepresentation_(context,
+          contentProtection, kind, language, label, main, roleValues,
+          closedCaptions, representation);
+      if (parsedRepresentation) {
+        parsedRepresentation.hdr = parsedRepresentation.hdr || videoRange;
+      }
+      return parsedRepresentation;
     }).filter((s) => !!s);
 
     if (streams.length == 0) {

package/lib/dash/segment_list.js

@@ -63,12 +63,12 @@ shaka.dash.SegmentList = class {
       const start = context.presentationTimeline.getSegmentAvailabilityStart();
       segmentIndex.mergeAndEvict(references, start);
     } else {
-      context.presentationTimeline.notifySegments(references);
       segmentIndex = new shaka.media.SegmentIndex(references);
       if (id && context.dynamic) {
         segmentIndexMap[id] = segmentIndex;
       }
     }
+    context.presentationTimeline.notifySegments(references);
 
     if (!context.dynamic || !context.periodInfo.isLastPeriod) {
       const periodStart = context.periodInfo.start;

package/lib/dash/segment_template.js

@@ -116,12 +116,12 @@ shaka.dash.SegmentTemplate = class {
         segmentIndex.mergeAndEvict(references,
             context.presentationTimeline.getSegmentAvailabilityStart());
       } else {
-        context.presentationTimeline.notifySegments(references);
         segmentIndex = new shaka.media.SegmentIndex(references);
         if (id && context.dynamic) {
           segmentIndexMap[id] = segmentIndex;
         }
       }
+      context.presentationTimeline.notifySegments(references);
 
       if (shouldFit) {
         segmentIndex.fit(periodStart, periodEnd);