shaka-player 3.2.0 → 3.2.4

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.
@@ -389,6 +401,24 @@ shaka.dash.DashParser = class {
           this.config_.dash.autoCorrectDrift);
     }
 
+    presentationTimeline.setStatic(mpdType == 'static');
+
+    const isLive = presentationTimeline.isLive();
+
+    // If it's live, we check for an override.
+    if (isLive && !isNaN(this.config_.availabilityWindowOverride)) {
+      segmentAvailabilityDuration = this.config_.availabilityWindowOverride;
+    }
+
+    // If it's null, that means segments are always available.  This is always
+    // the case for VOD, and sometimes the case for live.
+    if (segmentAvailabilityDuration == null) {
+      segmentAvailabilityDuration = Infinity;
+    }
+
+    presentationTimeline.setSegmentAvailabilityDuration(
+        segmentAvailabilityDuration);
+
     const profiles = mpd.getAttribute('profiles') || '';
 
     /** @type {shaka.dash.DashParser.Context} */
@@ -411,7 +441,6 @@ shaka.dash.DashParser = class {
     const duration = periodsAndDuration.duration;
     const periods = periodsAndDuration.periods;
 
-    presentationTimeline.setStatic(mpdType == 'static');
     if (mpdType == 'static' ||
         !periodsAndDuration.durationDerivedFromPeriods) {
       // Ignore duration calculated from Period lengths if this is dynamic.
@@ -430,6 +459,7 @@ shaka.dash.DashParser = class {
         this.lowLatencyMode_ = this.playerInterface_.isLowLatencyMode();
       }
     }
+
     if (this.lowLatencyMode_) {
       presentationTimeline.setAvailabilityTimeOffset(
           this.minTotalAvailabilityTimeOffset_);
@@ -443,22 +473,6 @@ shaka.dash.DashParser = class {
         'https://bit.ly/3clctcj for details.');
     }
 
-    const isLive = presentationTimeline.isLive();
-
-    // If it's live, we check for an override.
-    if (isLive && !isNaN(this.config_.availabilityWindowOverride)) {
-      segmentAvailabilityDuration = this.config_.availabilityWindowOverride;
-    }
-
-    // If it's null, that means segments are always available.  This is always
-    // the case for VOD, and sometimes the case for live.
-    if (segmentAvailabilityDuration == null) {
-      segmentAvailabilityDuration = Infinity;
-    }
-
-    presentationTimeline.setSegmentAvailabilityDuration(
-        segmentAvailabilityDuration);
-
     // Use @maxSegmentDuration to override smaller, derived values.
     presentationTimeline.notifyMaxSegmentDuration(maxSegmentDuration || 1);
     if (goog.DEBUG) {
@@ -538,6 +552,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);
 
@@ -571,6 +586,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,
@@ -602,6 +653,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(
@@ -653,8 +707,12 @@ shaka.dash.DashParser = class {
 
     const eventStreamNodes =
         XmlUtils.findChildren(periodInfo.node, 'EventStream');
+    const availabilityStart =
+        context.presentationTimeline.getSegmentAvailabilityStart();
+
     for (const node of eventStreamNodes) {
-      this.parseEventStream_(periodInfo.start, periodInfo.duration, node);
+      this.parseEventStream_(
+          periodInfo.start, periodInfo.duration, node, availabilityStart);
     }
 
     const adaptationSetNodes =
@@ -813,6 +871,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:
@@ -822,11 +899,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();
@@ -863,7 +955,9 @@ shaka.dash.DashParser = class {
               channel = channelAndLanguage[0].startsWith('CC') ?
                   channelAndLanguage[0] : `CC${channelAndLanguage[0]}`;
 
-              language = channelAndLanguage[1]; // 3 letters (ISO 639-2)
+              // 3 letters (ISO 639-2).  In b/187442669, we saw a blank string
+              // (CC2=;CC3=), so default to "und" (the code for "undetermined").
+              language = channelAndLanguage[1] || 'und';
             }
             closedCaptions.set(channel, LanguageUtils.normalize(language));
           }
@@ -950,8 +1044,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) {
@@ -1127,8 +1226,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;
@@ -1642,9 +1743,10 @@ shaka.dash.DashParser = class {
    * @param {number} periodStart
    * @param {?number} periodDuration
    * @param {!Element} elem
+   * @param {number} availabilityStart
    * @private
    */
-  parseEventStream_(periodStart, periodDuration, elem) {
+  parseEventStream_(periodStart, periodDuration, elem, availabilityStart) {
     const XmlUtils = shaka.util.XmlUtils;
     const parseNumber = XmlUtils.parseNonNegativeInt;
 
@@ -1667,6 +1769,11 @@ shaka.dash.DashParser = class {
         endTime = Math.min(endTime, periodStart + periodDuration);
       }
 
+      // Don't add unavailable regions to the timeline.
+      if (endTime < availabilityStart) {
+        continue;
+      }
+
       /** @type {shaka.extern.TimelineRegionInfo} */
       const region = {
         schemeIdUri: schemeIdUri,

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);

package/lib/hls/hls_parser.js

@@ -418,18 +418,16 @@ shaka.hls.HlsParser = class {
       const uri = tag.getAttributeValue('URI');
       const language = tag.getAttributeValue('LANGUAGE');
       const value = tag.getAttributeValue('VALUE');
-      const data = {
-        'id': id,
-      };
+      const data = (new Map()).set('id', id);
       if (uri) {
-        data.uri =
-            shaka.hls.Utils.constructAbsoluteUri(this.masterPlaylistUri_, uri);
+        data.set('uri',
+            shaka.hls.Utils.constructAbsoluteUri(this.masterPlaylistUri_, uri));
       }
       if (language) {
-        data.language = language;
+        data.set('language', language);
       }
       if (value) {
-        data.value = value;
+        data.set('value', value);
       }
       const event = new shaka.util.FakeEvent('sessiondata', data);
       if (this.playerInterface_) {
@@ -534,6 +532,30 @@ shaka.hls.HlsParser = class {
       }
     }
 
+    // Now that the content has been fit, notify segments.
+    this.segmentsToNotifyByStream_ = [];
+    const streamsToNotify = [];
+    for (const variant of variants) {
+      for (const stream of [variant.video, variant.audio]) {
+        if (stream) {
+          streamsToNotify.push(stream);
+        }
+      }
+    }
+    await Promise.all(streamsToNotify.map(async (stream) => {
+      await stream.createSegmentIndex();
+    }));
+    for (const stream of streamsToNotify) {
+      this.segmentsToNotifyByStream_.push(stream.segmentIndex.references);
+    }
+    this.notifySegments_();
+
+    // 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(
+        !this.presentationTimeline_.usingPresentationStartTime(),
+        'We should not be using the presentation start time in HLS!');
+
     this.manifest_ = {
       presentationTimeline: this.presentationTimeline_,
       variants,
@@ -1184,7 +1206,7 @@ shaka.hls.HlsParser = class {
     // "AUTOSELECT=YES".  A value of "AUTOSELECT=NO" would imply that it may
     // only be selected explicitly by the user, and we don't have a way to
     // represent that in our model.
-    const defaultAttrValue = tag.getAttribute('DEFAULT');
+    const defaultAttrValue = tag.getAttributeValue('DEFAULT');
     const primary = defaultAttrValue == 'YES';
 
     const channelsCount = type == 'audio' ? this.getChannelsCount_(tag) : null;
@@ -1258,6 +1280,30 @@ shaka.hls.HlsParser = class {
     if (this.uriToStreamInfosMap_.has(verbatimImagePlaylistUri)) {
       return this.uriToStreamInfosMap_.get(verbatimImagePlaylistUri);
     }
+
+    // Parse misc attributes.
+    const resolution = tag.getAttributeValue('RESOLUTION');
+    if (resolution) {
+      // The RESOLUTION tag represents the resolution of a single thumbnail, not
+      // of the entire sheet at once (like we expect in the output).
+      // So multiply by the layout size.
+
+      const reference = streamInfo.stream.segmentIndex.get(0);
+      const layout = reference.getTilesLayout();
+      if (layout) {
+        streamInfo.stream.width =
+            Number(resolution.split('x')[0]) * Number(layout.split('x')[0]);
+        streamInfo.stream.height =
+            Number(resolution.split('x')[1]) * Number(layout.split('x')[1]);
+        // TODO: What happens if there are multiple grids, with different
+        // layout sizes, inside this image stream?
+      }
+    }
+    const bandwidth = tag.getAttributeValue('BANDWIDTH');
+    if (bandwidth) {
+      streamInfo.stream.bandwidth = Number(bandwidth);
+    }
+
     this.uriToStreamInfosMap_.set(verbatimImagePlaylistUri, streamInfo);
     return streamInfo;
   }
@@ -1617,12 +1663,6 @@ shaka.hls.HlsParser = class {
     }
 
     this.notifySegments_();
-
-    // 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(
-        !this.presentationTimeline_.usingPresentationStartTime(),
-        'We should not be using the presentation start time in HLS!');
   }
 
   /**
@@ -1795,6 +1835,7 @@ shaka.hls.HlsParser = class {
     }
 
     let tilesLayout = '';
+    let tileDuration = null;
     if (type == shaka.util.ManifestParserUtils.ContentType.IMAGE) {
       // By default in HLS the tilesLayout is 1x1
       tilesLayout = '1x1';
@@ -1802,6 +1843,10 @@ shaka.hls.HlsParser = class {
           shaka.hls.Utils.getFirstTagWithName(tags, 'EXT-X-TILES');
       if (tilesTag) {
         tilesLayout = tilesTag.getRequiredAttrValue('LAYOUT');
+        const duration = tilesTag.getAttributeValue('DURATION');
+        if (duration) {
+          tileDuration = Number(duration);
+        }
       }
     }
 
@@ -1817,6 +1862,7 @@ shaka.hls.HlsParser = class {
         /* appendWindowEnd= */ Infinity,
         partialSegmentRefs,
         tilesLayout,
+        tileDuration,
     );
   }
 
@@ -2009,9 +2055,6 @@ shaka.hls.HlsParser = class {
       }
     }
 
-    this.segmentsToNotifyByStream_.push(references);
-    this.notifySegments_();
-
     return references;
   }
 
@@ -2350,6 +2393,12 @@ shaka.hls.HlsParser = class {
       reader.rewind(1);
     };
 
+    // We will look a few packet-lengths forward to find the first sync byte.
+    // Note that we are using this method on what is already a subset of the
+    // file (the first |shaka.hls.HlsParser.START_OF_SEGMENT_SIZE_| bytes), so
+    // we can't look too far ahead to begin with.
+    let syncByteScanLength = Math.min(reader.getLength() - 188, 5 * 188);
+
     // TODO: refactor this while loop for better readability.
     // eslint-disable-next-line no-constant-condition
     while (true) {
@@ -2358,8 +2407,16 @@ shaka.hls.HlsParser = class {
 
       syncByte = reader.readUint8();
       if (syncByte != 0x47) {
+        if (syncByteScanLength > 0) {
+          // This file could have started with a cut-off TS packet. Scan forward
+          // until we find a sync byte.
+          syncByteScanLength -= 1;
+          continue;
+        }
         fail();
       }
+      // If we've found a sync byte, stop scanning forward for future packets.
+      syncByteScanLength = 0;
 
       const flagsAndPacketId = reader.readUint16();
       const packetId = flagsAndPacketId & 0x1fff;

package/lib/hls/manifest_text_parser.js

@@ -277,6 +277,7 @@ shaka.hls.ManifestTextParser = class {
         const attrValue = blockAttrs[2] || blockAttrs[3];
         const attribute = new shaka.hls.Attribute(attrName, attrValue);
         attributes.push(attribute);
+        parser.skipWhitespace();
       }
     }
 

package/lib/media/closed_caption_parser.js

@@ -86,7 +86,9 @@ shaka.media.ClosedCaptionParser = class {
     for (const captionPacket of captionPackets) {
       const uint8ArrayData =
           shaka.util.BufferUtils.toUint8(captionPacket.packet);
-      this.ceaDecoder_.extract(uint8ArrayData, captionPacket.pts);
+      if (uint8ArrayData.length > 0) {
+        this.ceaDecoder_.extract(uint8ArrayData, captionPacket.pts);
+      }
     }
 
     // Decode and return the parsed captions.

package/lib/media/content_workarounds.js

@@ -75,6 +75,18 @@ shaka.media.ContentWorkarounds = class {
             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
           });
         })
+        .fullBox('avc3', (box) => {
+          boxesToModify.push({
+            box,
+            newType: ContentWorkarounds.BOX_TYPE_ENCV_,
+          });
+        })
+        .fullBox('ac-3', (box) => {
+          boxesToModify.push({
+            box,
+            newType: ContentWorkarounds.BOX_TYPE_ENCA_,
+          });
+        })
         .fullBox('ec-3', (box) => {
           boxesToModify.push({
             box,

package/lib/media/drm_engine.js

@@ -125,6 +125,9 @@ shaka.media.DrmEngine = class {
 
     /** @const {!shaka.util.Destroyer} */
     this.destroyer_ = new shaka.util.Destroyer(() => this.destroyNow_());
+
+    /** @private {boolean} */
+    this.srcEquals_ = false;
   }
 
   /** @override */
@@ -180,6 +183,7 @@ shaka.media.DrmEngine = class {
     this.config_ = null;
     this.onError_ = () => {};
     this.playerInterface_ = null;
+    this.srcEquals_ = false;
   }
 
   /**
@@ -193,6 +197,13 @@ shaka.media.DrmEngine = class {
     this.config_ = config;
   }
 
+  /**
+   * @param {!boolean} value
+   */
+  setSrcEquals(value) {
+    this.srcEquals_ = value;
+  }
+
   /**
    * Initialize the drm engine for storing and deleting stored content.
    *
@@ -351,7 +362,7 @@ shaka.media.DrmEngine = class {
     // We should get the decodingInfo results for the variants after we filling
     // in the drm infos, and before queryMediaKeys_().
     await shaka.util.StreamUtils.getDecodingInfosForVariants(variants,
-        this.usePersistentLicenses_);
+        this.usePersistentLicenses_, this.srcEquals_);
 
     const hasDrmInfo = hadDrmInfo || Object.keys(this.config_.servers).length;
     // An unencrypted content is initialized.
@@ -539,6 +550,7 @@ shaka.media.DrmEngine = class {
     tasks.push(session.remove());
 
     await Promise.all(tasks);
+    this.activeSessions_.delete(session);
   }
 
   /**
@@ -1813,9 +1825,16 @@ shaka.media.DrmEngine = class {
         // audio adaptations, so we shouldn't have to worry about checking
         // robustness.
         if (drm1.keySystem == drm2.keySystem) {
+          /** @type {Array<shaka.extern.InitDataOverride>} */
           let initData = [];
           initData = initData.concat(drm1.initData || []);
           initData = initData.concat(drm2.initData || []);
+          initData = initData.filter((d, i) => {
+            return d.keyId === undefined || i === initData.findIndex((d2) => {
+              return d2.keyId === d.keyId;
+            });
+          });
+
           const keyIds = drm1.keyIds && drm2.keyIds ?
               new Set([...drm1.keyIds, ...drm2.keyIds]) :
               drm1.keyIds || drm2.keyIds;

package/lib/media/gap_jumping_controller.js

@@ -154,8 +154,10 @@ shaka.media.GapJumpingController = class {
     }
     // Don't gap jump while paused, so that you don't constantly jump ahead
     // while paused on a livestream.  We make an exception for time 0, since we
-    // may be _required_ to seek on startup before play can begin.
-    if (this.video_.paused && this.video_.currentTime != 0) {
+    // may be _required_ to seek on startup before play can begin, but only if
+    // autoplay is enabled.
+    if (this.video_.paused && (this.video_.currentTime != 0 ||
+      (!this.video_.autoplay && this.video_.currentTime == 0))) {
       return;
     }
 
@@ -215,8 +217,10 @@ shaka.media.GapJumpingController = class {
       this.didFireLargeGap_ = true;
 
       // Event firing is synchronous.
-      const event = new shaka.util.FakeEvent(
-          'largegap', {'currentTime': currentTime, 'gapSize': jumpSize});
+      const data = new Map()
+          .set('currentTime', currentTime)
+          .set('gapSize', jumpSize);
+      const event = new shaka.util.FakeEvent('largegap', data);
       event.cancelable = true;
       this.onEvent_(event);
 

package/lib/media/media_source_engine.js

@@ -48,8 +48,7 @@ shaka.media.MediaSourceEngine = class {
    * @param {!function(!Array.<shaka.extern.ID3Metadata>, number, ?number)=}
    *    onMetadata
    */
-  constructor(video, closedCaptionParser, textDisplayer,
-      onMetadata) {
+  constructor(video, closedCaptionParser, textDisplayer, onMetadata) {
     /** @private {HTMLMediaElement} */
     this.video_ = video;
 

package/lib/media/playhead.js

@@ -80,7 +80,7 @@ shaka.media.SrcEqualsPlayhead = class {
     // We listen for the loaded-data-event so that we know when we can
     // interact with |currentTime|.
     const onLoaded = () => {
-      if (this.startTime_ == null) {
+      if (this.startTime_ == null || this.startTime_ == 0) {
         this.started_ = true;
       } else {
         // Startup is complete only when the video element acknowledges the