shaka-player 3.1.5 → 3.2.3

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

@@ -301,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>} */

package/lib/hls/hls_parser.js

@@ -92,7 +92,8 @@ shaka.hls.HlsParser = class {
      * timestamps, offsets, and to handle TS rollover.
      *
      * During parsing, used to avoid duplicates in the async methods
-     * createStreamInfoFromMediaTag_ and createStreamInfoFromVariantTag_.
+     * createStreamInfoFromMediaTag_, createStreamInfoFromImageTag_ and
+     * createStreamInfoFromVariantTag_.
      *
      * During parsing of updates, used by getStartTime_ to determine the start
      * time of the first segment from existing segment references.
@@ -403,6 +404,9 @@ shaka.hls.HlsParser = class {
     /** @type {!Array.<!shaka.hls.Tag>} */
     const variantTags = Utils.filterTagsByName(
         playlist.tags, 'EXT-X-STREAM-INF');
+    /** @type {!Array.<!shaka.hls.Tag>} */
+    const imageTags = Utils.filterTagsByName(
+        playlist.tags, 'EXT-X-IMAGE-STREAM-INF');
 
     this.parseCodecs_(variantTags);
 
@@ -437,6 +441,7 @@ shaka.hls.HlsParser = class {
     this.parseClosedCaptions_(mediaTags);
     const variants = await this.createVariantsForTags_(variantTags);
     const textStreams = await this.parseTexts_(mediaTags);
+    const imageStreams = await this.parseImages_(imageTags);
 
     // Make sure that the parser has not been destroyed.
     if (!this.playerInterface_) {
@@ -555,7 +560,7 @@ shaka.hls.HlsParser = class {
       presentationTimeline: this.presentationTimeline_,
       variants,
       textStreams,
-      imageStreams: [],
+      imageStreams,
       offlineSessionIds: [],
       minBufferTime: 0,
     };
@@ -688,6 +693,34 @@ shaka.hls.HlsParser = class {
     return textStreams.filter((s) => s);
   }
 
+  /**
+   * @param {!Array.<!shaka.hls.Tag>} imageTags from the playlist.
+   * @return {!Promise.<!Array.<!shaka.extern.Stream>>}
+   * @private
+   */
+  async parseImages_(imageTags) {
+    // Create image stream for each image tag.
+    const imageStreamPromises = imageTags.map(async (tag) => {
+      const disableThumbnails = this.config_.disableThumbnails;
+      if (disableThumbnails) {
+        return null;
+      }
+      try {
+        const streamInfo = await this.createStreamInfoFromImageTag_(tag);
+        goog.asserts.assert(
+            streamInfo, 'Should always have a streamInfo for image');
+        return streamInfo.stream;
+      } catch (e) {
+        if (this.config_.hls.ignoreImageStreamFailures) {
+          return null;
+        }
+        throw e;
+      }
+    });
+    const imageStreams = await Promise.all(imageStreamPromises);
+    return imageStreams.filter((s) => s);
+  }
+
   /**
    * @param {!Array.<!shaka.hls.Tag>} mediaTags Media tags from the playlist.
    * @private
@@ -1206,6 +1239,75 @@ shaka.hls.HlsParser = class {
     return streamInfo;
   }
 
+  /**
+   * Parse EXT-X-MEDIA media tag into a Stream object.
+   *
+   * @param {shaka.hls.Tag} tag
+   * @return {!Promise.<?shaka.hls.HlsParser.StreamInfo>}
+   * @private
+   */
+  async createStreamInfoFromImageTag_(tag) {
+    goog.asserts.assert(tag.name == 'EXT-X-IMAGE-STREAM-INF',
+        'Should only be called on image tags!');
+    /** @type {string} */
+    const type = shaka.util.ManifestParserUtils.ContentType.IMAGE;
+
+    const verbatimImagePlaylistUri = this.variableSubstitution_(
+        tag.getRequiredAttrValue('URI'), this.globalVariables_);
+    const codecs = tag.getAttributeValue('CODECS', 'jpeg') || '';
+
+    // Check if the stream has already been created as part of another Variant
+    // and return it if it has.
+    if (this.uriToStreamInfosMap_.has(verbatimImagePlaylistUri)) {
+      return this.uriToStreamInfosMap_.get(verbatimImagePlaylistUri);
+    }
+
+    const language = this.getLanguage_(tag);
+    const name = tag.getAttributeValue('NAME');
+
+    const characteristics = tag.getAttributeValue('CHARACTERISTICS');
+
+    const streamInfo = await this.createStreamInfo_(
+        verbatimImagePlaylistUri, codecs, type, language, /* primary= */ false,
+        name, /* channelsCount= */ null, /* closedCaptions= */ null,
+        characteristics, /* forced= */ false, /* spatialAudio= */ false);
+    if (streamInfo == null) {
+      return null;
+    }
+
+    // TODO: This check is necessary because of the possibility of multiple
+    // calls to createStreamInfoFromImageTag_ before either has resolved.
+    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;
+  }
+
   /**
    * Parse an EXT-X-STREAM-INF media tag into a Stream object.
    *
@@ -1278,7 +1380,8 @@ shaka.hls.HlsParser = class {
         response.data, absoluteMediaPlaylistUri);
 
     if (playlist.type != shaka.hls.PlaylistType.MEDIA) {
-      // EXT-X-MEDIA tags should point to media playlists.
+      // EXT-X-MEDIA and EXT-X-IMAGE-STREAM-INF tags should point to media
+      // playlists.
       throw new shaka.util.Error(
           shaka.util.Error.Severity.CRITICAL,
           shaka.util.Error.Category.MANIFEST,
@@ -1635,11 +1738,12 @@ shaka.hls.HlsParser = class {
    * @param {!Map.<string, string>} variables
    * @param {string} absoluteMediaPlaylistUri
    * @return {!shaka.media.SegmentReference}
+   * @param {string} type
    * @private
    */
   createSegmentReference_(
       initSegmentReference, previousReference, hlsSegment, startTime,
-      timestampOffset, variables, absoluteMediaPlaylistUri) {
+      timestampOffset, variables, absoluteMediaPlaylistUri, type) {
     const tags = hlsSegment.tags;
     const absoluteSegmentUri = this.variableSubstitution_(
         hlsSegment.absoluteUri, variables);
@@ -1730,6 +1834,22 @@ shaka.hls.HlsParser = class {
       endByte = partialSegmentRefs[partialSegmentRefs.length - 1].endByte;
     }
 
+    let tilesLayout = '';
+    let tileDuration = null;
+    if (type == shaka.util.ManifestParserUtils.ContentType.IMAGE) {
+      // By default in HLS the tilesLayout is 1x1
+      tilesLayout = '1x1';
+      const tilesTag =
+          shaka.hls.Utils.getFirstTagWithName(tags, 'EXT-X-TILES');
+      if (tilesTag) {
+        tilesLayout = tilesTag.getRequiredAttrValue('LAYOUT');
+        const duration = tilesTag.getAttributeValue('DURATION');
+        if (duration) {
+          tileDuration = Number(duration);
+        }
+      }
+    }
+
     return new shaka.media.SegmentReference(
         startTime,
         endTime,
@@ -1741,6 +1861,8 @@ shaka.hls.HlsParser = class {
         /* appendWindowStart= */ 0,
         /* appendWindowEnd= */ Infinity,
         partialSegmentRefs,
+        tilesLayout,
+        tileDuration,
     );
   }
 
@@ -1836,12 +1958,13 @@ shaka.hls.HlsParser = class {
         initSegmentRef = this.getInitSegmentReference_(
             playlist.absoluteUri, hlsSegments[0].tags, variables);
         goog.asserts.assert(
-            type != shaka.util.ManifestParserUtils.ContentType.TEXT,
+            type != shaka.util.ManifestParserUtils.ContentType.TEXT &&
+            type != shaka.util.ManifestParserUtils.ContentType.IMAGE,
             'Should only get start time from audio or video streams');
         this.playlistStartTime_ = await this.getStartTime_(
             verbatimMediaPlaylistUri, initSegmentRef, mimeType,
             position, /* isDiscontinuity= */ false,
-            hlsSegments[0], variables);
+            hlsSegments[0], variables, type);
       }
       firstStartTime = this.playlistStartTime_;
     }
@@ -1894,7 +2017,7 @@ shaka.hls.HlsParser = class {
         // eslint-disable-next-line no-await-in-loop
         timestampOffset = await this.getTimestampOffset_(
             discontintuitySequenceNum, verbatimMediaPlaylistUri, initSegmentRef,
-            mimeType, position, item, variables, startTime);
+            mimeType, position, item, variables, startTime, type);
       }
 
       // If the stream is low latency and the user has not configured the
@@ -1919,7 +2042,8 @@ shaka.hls.HlsParser = class {
             startTime,
             timestampOffset,
             variables,
-            playlist.absoluteUri);
+            playlist.absoluteUri,
+            type);
 
         references.push(reference);
       } else if (!this.lowLatencyMode_) {
@@ -1946,13 +2070,14 @@ shaka.hls.HlsParser = class {
    * @param {!shaka.hls.Segment} segment
    * @param {!Map.<string, string>} variables
    * @param {number} startTime
+   * @param {string} type
    * @return {!Promise.<number>}
    * @throws {shaka.util.Error}
    * @private
    */
   async getTimestampOffset_(discontintuitySequenceNum,
       verbatimMediaPlaylistUri, initSegmentRef,
-      mimeType, mediaSequenceNumber, segment, variables, startTime) {
+      mimeType, mediaSequenceNumber, segment, variables, startTime, type) {
     let timestampOffset = 0;
     if (this.discontinuityToTso_.has(discontintuitySequenceNum)) {
       timestampOffset =
@@ -1961,7 +2086,7 @@ shaka.hls.HlsParser = class {
       const mediaStartTime = await this.getStartTime_(
           verbatimMediaPlaylistUri, initSegmentRef, mimeType,
           mediaSequenceNumber, /* isDiscontinuity= */ true, segment,
-          variables);
+          variables, type);
       timestampOffset = startTime - mediaStartTime;
       shaka.log.v1('Segment timestampOffset =', timestampOffset);
       this.discontinuityToTso_.set(
@@ -2048,12 +2173,13 @@ shaka.hls.HlsParser = class {
    * @param {boolean} isDiscontinuity
    * @param {!shaka.hls.Segment} segment
    * @param {!Map.<string, string>} variables
+   * @param {string} type
    * @return {!Promise.<number>}
    * @private
    */
   async getStartTime_(
       verbatimMediaPlaylistUri, initSegmentRef, mimeType, mediaSequenceNumber,
-      isDiscontinuity, segment, variables) {
+      isDiscontinuity, segment, variables, type) {
     const segmentRef = this.createSegmentReference_(
         initSegmentRef,
         /* previousReference= */ null,
@@ -2061,7 +2187,8 @@ shaka.hls.HlsParser = class {
         /* startTime= */ 0,
         /* timestampOffset= */ 0,
         variables,
-        /* absoluteMediaPlaylistUri= */ '');
+        /* absoluteMediaPlaylistUri= */ '',
+        type);
     // If we are updating the manifest, we can usually skip fetching the segment
     // by examining the references we already have.  This won't be possible if
     // there was some kind of lag or delay updating the manifest on the server,
@@ -2437,6 +2564,12 @@ shaka.hls.HlsParser = class {
       }
     }
 
+    if (contentType == ContentType.IMAGE) {
+      if (!codecs || codecs == 'jpeg') {
+        return 'image/jpeg';
+      }
+    }
+
     // If unable to guess mime type, request a segment and try getting it
     // from the response.
     const headRequest = shaka.net.NetworkingEngine.makeRequest(
@@ -2807,6 +2940,19 @@ shaka.hls.HlsParser.TEXT_EXTENSIONS_TO_MIME_TYPES_ = {
 };
 
 
+/**
+ * @const {!Object.<string, string>}
+ * @private
+ */
+shaka.hls.HlsParser.IMAGE_EXTENSIONS_TO_MIME_TYPES_ = {
+  'jpg': 'image/jpeg',
+  'png': 'image/png',
+  'svg': 'image/svg+xml',
+  'webp': 'image/webp',
+  'avif': 'image/avif',
+};
+
+
 /**
  * @const {!Object.<string, !Object.<string, string>>}
  * @private
@@ -2815,6 +2961,7 @@ shaka.hls.HlsParser.EXTENSION_MAP_BY_CONTENT_TYPE_ = {
   'audio': shaka.hls.HlsParser.AUDIO_EXTENSIONS_TO_MIME_TYPES_,
   'video': shaka.hls.HlsParser.VIDEO_EXTENSIONS_TO_MIME_TYPES_,
   'text': shaka.hls.HlsParser.TEXT_EXTENSIONS_TO_MIME_TYPES_,
+  'image': shaka.hls.HlsParser.IMAGE_EXTENSIONS_TO_MIME_TYPES_,
 };
 
 

package/lib/media/closed_caption_parser.js

@@ -4,14 +4,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.provide('shaka.media.IClosedCaptionParser');
 goog.provide('shaka.media.ClosedCaptionParser');
+goog.provide('shaka.media.IClosedCaptionParser');
 
 goog.require('shaka.cea.CeaDecoder');
 goog.require('shaka.cea.Mp4CeaParser');
 goog.require('shaka.util.BufferUtils');
 goog.requireType('shaka.cea.ICaptionDecoder');
-goog.requireType('shaka.cea.ICaptionDecoder.ClosedCaption');
 goog.requireType('shaka.cea.ICeaParser');