User hooks for hls parser

AUTHORS

@@ -24,6 +24,7 @@ Google Inc. <*@google.com>
 Edgeware AB <*@edgeware.tv>
 Gil Gonen <gil.gonen@gmail.com>
 Giuseppe Samela <giuseppe.samela@gmail.com>
+Hotstar <*@hotstar.com>
 Itay Kinnrot <Itay.Kinnrot@Kaltura.com>
 Jason Palmer <jason@jason-palmer.com>
 Jesper Haug Karsrud <jesper.karsrud@gmail.com>

CONTRIBUTORS

@@ -25,6 +25,7 @@
 Aaron Vaage <vaage@google.com>
 Alvaro Velad Galvan <alvaro.velad@mirada.tv>
 Andy Hochhaus <ahochhaus@samegoal.com>
+Anurag Kalia <anurag.kalia@hotstar.com>
 Benjamin Wallberg <benjamin.wallberg@bonnierbroadcasting.com>
 Boris Cupac <borisrt2309@gmail.com>
 Bryan Huh <bhh1988@gmail.com>

externs/shaka/manifest_parser.js

@@ -59,6 +59,7 @@ shaka.extern.ManifestParser = function() {};
  *   filterNewPeriod: function(shaka.extern.Period),
  *   filterAllPeriods: function(!Array.<!shaka.extern.Period>),
  *   onTimelineRegionAdded: function(shaka.extern.TimelineRegionInfo),
+ *   onSegmentParsed: function(string, number, *),
  *   onEvent: function(!Event),
  *   onError: function(!shaka.util.Error)
  * }}
@@ -77,6 +78,8 @@ shaka.extern.ManifestParser = function() {};
  *   Should be called on all Periods so that they can be filtered.
  * @property {function(shaka.extern.TimelineRegionInfo)} onTimelineRegionAdded
  *   Should be called when a new timeline region is added.
+ * @property {function(string, number, *)} onSegmentParsed
+ *   Should be called with segment metadata when a new segment is parsed.
  * @property {function(!Event)} onEvent
  *   Should be called to raise events.
  * @property {function(!shaka.util.Error)} onError

lib/hls/hls_parser.js

@@ -287,7 +287,9 @@ shaka.hls.HlsParser = class {
         playlist,
         startPosition,
         stream.mimeType,
-        stream.codecs);
+        stream.codecs,
+        stream.id,
+        streamInfo.segmentIndex.getAll());
 
     streamInfo.segmentIndex.replace(segments);
 
@@ -1167,8 +1169,11 @@ shaka.hls.HlsParser = class {
 
     const startPosition = mediaSequenceTag ? Number(mediaSequenceTag.value) : 0;
 
+    const nextStreamId = this.globalId_++;
+
     const segments = await this.createSegments_(
-        verbatimMediaPlaylistUri, playlist, startPosition, mimeType, codecs);
+        verbatimMediaPlaylistUri, playlist, startPosition, mimeType, codecs,
+        nextStreamId, []);
 
     const minTimestamp = segments[0].startTime;
     const lastEndTime = segments[segments.length - 1].endTime;
@@ -1186,7 +1191,7 @@ shaka.hls.HlsParser = class {
 
     /** @type {shaka.extern.Stream} */
     const stream = {
-      id: this.globalId_++,
+      id: nextStreamId,
       originalId: name,
       createSegmentIndex: () => Promise.resolve(),
       findSegmentPosition: (i) => segmentIndex.find(i),
@@ -1435,16 +1440,28 @@ shaka.hls.HlsParser = class {
    * @param {number} startPosition
    * @param {string} mimeType
    * @param {string} codecs
+   * @param {number} streamId
+   * @param {Array.<!shaka.media.SegmentReference>} existingSegmentRefs
    * @return {!Promise<!Array.<!shaka.media.SegmentReference>>}
    * @private
    */
   async createSegments_(
-      verbatimMediaPlaylistUri, playlist, startPosition, mimeType, codecs) {
+      verbatimMediaPlaylistUri, playlist, startPosition, mimeType, codecs,
+      streamId, existingSegmentRefs) {
     /** @type {Array.<!shaka.hls.Segment>} */
     const hlsSegments = playlist.segments;
-    /** @type {!Array.<!shaka.media.SegmentReference>} */
+    /** @type {Array.<!shaka.media.SegmentReference>} */
     const references = [];
+    // number of segment references in both the last and the current playlist
+    let reappearingRefsCount = 0;
 
+    if (existingSegmentRefs.length > 0) {
+      const earlierStartPosition = existingSegmentRefs[0].getPosition();
+      // number of segment references in the last but not the current playlist
+      // (in HLS, segments are dropped only from the beginning of the playlist)
+      const droppedRefsCount = startPosition - earlierStartPosition;
+      reappearingRefsCount = existingSegmentRefs.length - droppedRefsCount;
+    }
     goog.asserts.assert(hlsSegments.length, 'Playlist should have segments!');
     // We may need to look at the media itself to determine a segment start
     // time.
@@ -1463,12 +1480,23 @@ shaka.hls.HlsParser = class {
         initSegmentRef, firstSegmentRef, mimeType, codecs);
     shaka.log.debug('First segment', firstSegmentUri.split('/').pop(),
         'starts at', firstStartTime);
+
+    // Append brand-new segments
     for (let i = 0; i < hlsSegments.length; ++i) {
       const hlsSegment = hlsSegments[i];
       const previousReference = references[references.length - 1];
       const startTime = (i == 0) ? firstStartTime : previousReference.endTime;
       const position = startPosition + i;
 
+      if (i >= reappearingRefsCount) {
+        // Segment references which appeared only in the current playlist:
+        // Fire 'segmentparsed' event for them.
+        this.playerInterface_.onSegmentParsed(
+            'application/vnd.apple.mpegurl',
+            streamId,
+            hlsSegment);
+      }
+
       const reference = this.createSegmentReference_(
           playlist,
           previousReference,

lib/media/segment_index.js

@@ -107,6 +107,16 @@ shaka.media.SegmentIndex = class {
     return this.references_[index];
   }
 
+  /**
+   * Get all the SegmentReferences
+   *
+   * @return {Array.<!shaka.media.SegmentReference>} existing segment references
+   * @export
+   */
+  getAll() {
+    return this.references_;
+  }
+
 
   /**
    * Offset all segment references by a fixed amount.

lib/offline/storage.js

@@ -797,6 +797,7 @@ shaka.offline.Storage = class {
       filterNewPeriod: () => {},
 
       onTimelineRegionAdded: () => {},
+      onSegmentParsed: () => {},
       onEvent: () => {},
 
       // Used to capture an error from the manifest parser. We will check the

lib/player.js

@@ -266,6 +266,17 @@ goog.require('shaka.util.StreamUtils');
  * @exportDoc
  */
 
+/**
+ * @event shaka.Player.SegmentParsedEvent
+ * @description Optionally fired from inside a manifest parser plugin if a newly
+ *   parsed segment has some extra metadata. It emits mime type of the parser,
+ *   id of the stream that segment belonged to, and segment data (format may
+ *   differ according to manifest parser).
+ * @property {string} type
+ *   'segmentparsed'
+ * @exportDoc
+ */
+
 
 /**
  * @event shaka.Player.StreamingEvent
@@ -1451,6 +1462,11 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       // manifest).
       onTimelineRegionAdded: (region) => this.regionTimeline_.addRegion(region),
 
+      // Called to signal new segment metadata upon parsing in the manifest
+      // segment metadata can vary depending on mimeType and streamId
+      onSegmentParsed: (mimeType, streamId, segment) => this.onSegmentParsed_(
+          mimeType, streamId, segment),
+
       onEvent: (event) => this.dispatchEvent(event),
       onError: (error) => this.onError_(error),
     };
@@ -4249,6 +4265,29 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     }
   }
 
+  /**
+   * Callback from player
+   *
+   * @param {string} mimeType of the manifest-parser
+   * @param {number} streamId to which the segment belongs
+   * @param {*} segment segment metadata (format depends on mimeType+segment)
+   * @private
+   */
+
+  onSegmentParsed_(mimeType, streamId, segment) {
+    const eventData = {
+      detail: {
+        mimeType,
+        streamId,
+        segment,
+      },
+    };
+
+    this.dispatchEvent(
+        new shaka.util.FakeEvent('segmentparsed', eventData)
+    );
+  }
+
   /**
    * Callback from AbrManager.
    *

test/dash/dash_parser_content_protection_unit.js

@@ -47,6 +47,7 @@ describe('DashParser ContentProtection', () => {
       filterNewPeriod: () => {},
       filterAllPeriods: () => {},
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
+      onSegmentParsed: fail,
       onEvent: fail,
       onError: fail,
     };

test/dash/dash_parser_live_unit.js

@@ -47,6 +47,7 @@ describe('DashParser Live', () => {
       filterNewPeriod: () => {},
       filterAllPeriods: () => {},
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
+      onSegmentParsed: fail,
       onEvent: fail,
       onError: fail,
     };

test/dash/dash_parser_manifest_unit.js

@@ -38,6 +38,7 @@ describe('DashParser Manifest', () => {
       filterNewPeriod: () => {},
       filterAllPeriods: () => {},
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
+      onSegmentParsed: fail,
       onEvent: shaka.test.Util.spyFunc(onEventSpy),
       onError: fail,
     };

test/dash/dash_parser_segment_base_unit.js

@@ -42,6 +42,7 @@ describe('DashParser SegmentBase', () => {
       filterNewPeriod: () => {},
       filterAllPeriods: () => {},
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
+      onSegmentParsed: fail,
       onEvent: fail,
       onError: fail,
     };

test/dash/dash_parser_segment_template_unit.js

@@ -36,6 +36,7 @@ describe('DashParser SegmentTemplate', () => {
       filterNewPeriod: () => {},
       filterAllPeriods: () => {},
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
+      onSegmentParsed: fail,
       onEvent: fail,
       onError: fail,
     };

test/hls/hls_live_unit.js

@@ -124,12 +124,22 @@ describe('HlsParser live', () => {
       onError: fail,
       onEvent: fail,
       onTimelineRegionAdded: fail,
+      onSegmentParsed: fail,
     };
 
     parser = new shaka.hls.HlsParser();
     parser.configure(config);
   });
 
+  /** @type {!jasmine.Spy} */
+  let onSegmentParsedSpy;
+
+  beforeEach(() => {
+    onSegmentParsedSpy = jasmine.createSpy('onSegmentParsed');
+    playerInterface.onSegmentParsed =
+        shaka.test.Util.spyFunc(onSegmentParsedSpy);
+  });
+
   afterEach(() => {
     // HLS parser stop is synchronous.
     parser.stop();
@@ -555,6 +565,67 @@ describe('HlsParser live', () => {
             master, media, [ref1], mediaWithAdditionalSegment, [ref1, ref2]);
       });
 
+      it('triggers segment parsed callbacks as segments appear', () => {
+        const mediaWithAdditionalSegment = [
+          '#EXTM3U\n',
+          '#EXT-X-PLAYLIST-TYPE:EVENT\n',
+          '#EXT-X-TARGETDURATION:5\n',
+          '#EXT-X-MAP:URI="init.mp4",BYTERANGE="616@0"\n',
+          '#EXTINF:2,\n',
+          'main.mp4\n',
+          '#EXT-X-CUE:DURATION="201.467",ID="0",TYPE="SpliceOut",',
+          'TIME="414.171"\n',
+          '#EXTINF:2,\n',
+          'main2.mp4\n',
+        ].join('');
+
+        fakeNetEngine
+            .setResponseText('test:/master', master)
+            .setResponseText('test:/video', media)
+            .setResponseValue('test:/init.mp4', initSegmentData)
+            .setResponseValue('test:/main.mp4', segmentData);
+
+        const spy = jasmine.createSpy('start');
+        parser.start('test:/master', playerInterface)
+            .then(Util.spyFunc(spy), fail);
+        PromiseMock.flush();
+
+        expect(onSegmentParsedSpy).toHaveBeenCalledTimes(1);
+        expect(onSegmentParsedSpy).toHaveBeenCalledWith(
+            'application/vnd.apple.mpegurl',
+            1,
+            new shaka.hls.Segment(
+                'test:/main.mp4',
+                [
+                  new shaka.hls.Tag(/* id */ 1, 'EXTINF', [], '2'),
+                ])
+        );
+
+        // Replace the entries with the updated values.
+        fakeNetEngine
+            .setResponseText('test:/video', mediaWithAdditionalSegment);
+
+        delayForUpdatePeriod();
+
+        expect(onSegmentParsedSpy).toHaveBeenCalledTimes(2);
+        expect(onSegmentParsedSpy).toHaveBeenCalledWith(
+            'application/vnd.apple.mpegurl',
+            1,
+            new shaka.hls.Segment(
+                'test:/main2.mp4',
+                [
+                  new shaka.hls.Tag(/* id */ 1, 'EXTINF', [], '2'),
+                  new shaka.hls.Tag(/* id */ 2, 'EXT-X-CUE', [
+                    new shaka.hls.Attribute('DURATION', '201.467'),
+                    new shaka.hls.Attribute('ID', '0'),
+                    new shaka.hls.Attribute('TYPE', 'SpliceOut'),
+                    new shaka.hls.Attribute('TIME', '414.171'),
+                  ]),
+                ]
+            )
+        );
+      });
+
       it('evicts removed segments', () => {
         const ref1 = ManifestParser.makeReference('test:/main.mp4',
             0, 2, 4);

test/hls/hls_parser_unit.js

@@ -91,12 +91,23 @@ describe('HlsParser', () => {
       onError: fail,
       onEvent: fail,
       onTimelineRegionAdded: fail,
+      onSegmentParsed: fail,
     };
 
     parser = new shaka.hls.HlsParser();
     parser.configure(config);
   });
 
+  /** @type {!jasmine.Spy} */
+  let onSegmentParsedSpy;
+
+  beforeEach(() => {
+    onSegmentParsedSpy = jasmine.createSpy('onSegmentParsed');
+    playerInterface.onSegmentParsed =
+        shaka.test.Util.spyFunc(onSegmentParsedSpy);
+  });
+
+
   /**
    * @param {string} master
    * @param {string} media

test/test/util/dash_parser_util.js

@@ -50,6 +50,7 @@ shaka.test.Dash = class {
       filterNewPeriod: () => {},
       filterAllPeriods: () => {},
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
+      onSegmentParsed: fail,
       onEvent: fail,
       onError: fail,
     };
@@ -77,6 +78,7 @@ shaka.test.Dash = class {
       filterNewPeriod: () => {},
       filterAllPeriods: () => {},
       onTimelineRegionAdded: fail,  // Should not have any EventStream elements.
+      onSegmentParsed: fail,
       onEvent: fail,
       onError: fail,
     };