shaka-player 3.1.3 → 3.2.2

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);
 
@@ -414,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_) {
@@ -439,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_) {
@@ -529,11 +532,35 @@ 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,
       textStreams,
-      imageStreams: [],
+      imageStreams,
       offlineSessionIds: [],
       minBufferTime: 0,
     };
@@ -666,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
@@ -1151,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;
@@ -1184,6 +1239,51 @@ 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);
+    }
+    this.uriToStreamInfosMap_.set(verbatimImagePlaylistUri, streamInfo);
+    return streamInfo;
+  }
+
   /**
    * Parse an EXT-X-STREAM-INF media tag into a Stream object.
    *
@@ -1256,7 +1356,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,
@@ -1538,12 +1639,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!');
   }
 
   /**
@@ -1619,11 +1714,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);
@@ -1714,6 +1810,17 @@ shaka.hls.HlsParser = class {
       endByte = partialSegmentRefs[partialSegmentRefs.length - 1].endByte;
     }
 
+    let tilesLayout = '';
+    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');
+      }
+    }
+
     return new shaka.media.SegmentReference(
         startTime,
         endTime,
@@ -1725,6 +1832,7 @@ shaka.hls.HlsParser = class {
         /* appendWindowStart= */ 0,
         /* appendWindowEnd= */ Infinity,
         partialSegmentRefs,
+        tilesLayout,
     );
   }
 
@@ -1820,12 +1928,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_;
     }
@@ -1878,7 +1987,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
@@ -1903,7 +2012,8 @@ shaka.hls.HlsParser = class {
             startTime,
             timestampOffset,
             variables,
-            playlist.absoluteUri);
+            playlist.absoluteUri,
+            type);
 
         references.push(reference);
       } else if (!this.lowLatencyMode_) {
@@ -1915,9 +2025,6 @@ shaka.hls.HlsParser = class {
       }
     }
 
-    this.segmentsToNotifyByStream_.push(references);
-    this.notifySegments_();
-
     return references;
   }
 
@@ -1933,13 +2040,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 =
@@ -1948,7 +2056,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(
@@ -2035,12 +2143,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,
@@ -2048,7 +2157,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,
@@ -2424,6 +2534,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(
@@ -2794,6 +2910,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
@@ -2802,6 +2931,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');