feat: Add PDT to each segment (#168)

videojs · Jul 7, 2023 · e7c683f · e7c683f
1 parent 4adaa2c
commit e7c683f
Show file tree

Hide file tree

Showing 63 changed files with 168 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,7 @@ var manifest = [
   '0.ts',
   '#EXTINF:6,',
   '1.ts',
+  '#EXT-X-PROGRAM-DATE-TIME:2019-02-14T02:14:00.106Z'
   '#EXTINF:6,',
   '2.ts',
   '#EXT-X-ENDLIST'
@@ -79,6 +80,7 @@ Manifest {
   allowCache: boolean,
   endList: boolean,
   mediaSequence: number,
+  dateRanges: [],
   discontinuitySequence: number,
   playlistType: string,
   custom: {},
@@ -106,8 +108,6 @@ Manifest {
     'CLOSED-CAPTIONS': {},
     SUBTITLES: {}
   },
-  dateTimeString: string,
-  dateTimeObject: Date,
   targetDuration: number,
   totalDuration: number,
   discontinuityStarts: [number],
@@ -119,6 +119,7 @@ Manifest {
         offset: number
       },
       duration: number,
+      programDateTime:  number,
       attributes: {},
       discontinuity: number,
       uri: string,

diff --git a/src/parse-stream.js b/src/parse-stream.js
@@ -356,7 +356,6 @@ export default class ParseStream extends Stream {
         };
         if (match[1]) {
           event.dateTimeString = match[1];
-          event.dateTimeObject = new Date(match[1]);
         }
         this.trigger('data', event);
         return;

diff --git a/src/parser.js b/src/parser.js
@@ -97,6 +97,8 @@ export default class Parser extends Stream {
     this.parseStream = new ParseStream();
     this.lineStream.pipe(this.parseStream);
 
+    this.lastProgramDateTime = null;
+
     /* eslint-disable consistent-this */
     const self = this;
     /* eslint-enable consistent-this */
@@ -124,6 +126,7 @@ export default class Parser extends Stream {
     this.manifest = {
       allowCache: true,
       discontinuityStarts: [],
+      dateRanges: [],
       segments: []
     };
     // keep track of the last seen segment's byte range end, as segments are not required
@@ -456,17 +459,21 @@ export default class Parser extends Stream {
               this.manifest.discontinuityStarts.push(uris.length);
             },
             'program-date-time'() {
-              if (typeof this.manifest.dateTimeString === 'undefined') {
-                // PROGRAM-DATE-TIME is a media-segment tag, but for backwards
-                // compatibility, we add the first occurence of the PROGRAM-DATE-TIME tag
-                // to the manifest object
-                // TODO: Consider removing this in future major version
-                this.manifest.dateTimeString = entry.dateTimeString;
-                this.manifest.dateTimeObject = entry.dateTimeObject;
-              }
+              const { lastProgramDateTime } = this;
+
+              this.lastProgramDateTime = new Date(entry.dateTimeString).getTime();
 
-              currentUri.dateTimeString = entry.dateTimeString;
-              currentUri.dateTimeObject = entry.dateTimeObject;
+              // We should extrapolate Program Date Time backward only during first program date time occurrence.
+              // Once we have at least one program date time point, we can always extrapolate it forward using lastProgramDateTime reference.
+              if (lastProgramDateTime === null) {
+                // Extrapolate Program Date Time backward
+                // Since it is first program date time occurrence we're assuming that
+                // all this.manifest.segments have no program date time info
+                this.manifest.segments.reduceRight((programDateTime, segment) => {
+                  segment.programDateTime = programDateTime - (segment.duration * 1000);
+                  return segment.programDateTime;
+                }, this.lastProgramDateTime);
+              }
             },
             targetduration() {
               if (!isFinite(entry.duration) || entry.duration < 0) {
@@ -639,7 +646,6 @@ export default class Parser extends Stream {
               setHoldBack.call(this, this.manifest);
             },
             'daterange'() {
-              this.manifest.dateRanges = this.manifest.dateRanges || [];
               this.manifest.dateRanges.push(camelCaseKeys(entry.attributes));
               const index = this.manifest.dateRanges.length - 1;
 
@@ -683,11 +689,6 @@ export default class Parser extends Stream {
 
                 this.manifest.dateRanges[index].endDate = new Date(newDateInSeconds);
               }
-              if (dateRange && !this.manifest.dateTimeString) {
-                this.trigger('warn', {
-                  message: 'A playlist with EXT-X-DATERANGE tag must contain atleast one EXT-X-PROGRAM-DATE-TIME tag'
-                });
-              }
               if (!dateRangeTags[dateRange.id]) {
                 dateRangeTags[dateRange.id] = dateRange;
               } else {
@@ -730,6 +731,12 @@ export default class Parser extends Stream {
           // reset the last byterange end as it needs to be 0 between parts
           lastPartByterangeEnd = 0;
 
+          // Once we have at least one program date time we can always extrapolate it forward
+          if (this.lastProgramDateTime !== null) {
+            currentUri.programDateTime = this.lastProgramDateTime;
+            this.lastProgramDateTime += currentUri.duration * 1000;
+          }
+
           // prepare for the next URI
           currentUri = {};
         },
@@ -782,7 +789,13 @@ export default class Parser extends Stream {
   end() {
     // flush any buffered input
     this.lineStream.push('\n');
+    if (this.manifest.dateRanges.length && this.lastProgramDateTime === null) {
+      this.trigger('warn', {
+        message: 'A playlist with EXT-X-DATERANGE tag must contain atleast one EXT-X-PROGRAM-DATE-TIME tag'
+      });
+    }
 
+    this.lastProgramDateTime = null;
     this.trigger('end');
   }
   /**

diff --git a/test/fixtures/integration/absoluteUris.js b/test/fixtures/integration/absoluteUris.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/allowCache.js b/test/fixtures/integration/allowCache.js
@@ -1,6 +1,7 @@
 module.exports = {
   allowCache: true,
   mediaSequence: 0,
+  dateRanges: [],
   playlistType: 'VOD',
   segments: [
     {

diff --git a/test/fixtures/integration/allowCacheInvalid.js b/test/fixtures/integration/allowCacheInvalid.js
@@ -1,6 +1,7 @@
 module.exports = {
   allowCache: true,
   mediaSequence: 0,
+  dateRanges: [],
   playlistType: 'VOD',
   segments: [
     {

diff --git a/test/fixtures/integration/alternateAudio.js b/test/fixtures/integration/alternateAudio.js
@@ -1,6 +1,7 @@
 module.exports = {
   allowCache: true,
   discontinuityStarts: [],
+  dateRanges: [],
   mediaGroups: {
     // TYPE
     'AUDIO': {

diff --git a/test/fixtures/integration/alternateVideo.js b/test/fixtures/integration/alternateVideo.js
@@ -1,6 +1,7 @@
 module.exports = {
   allowCache: true,
   discontinuityStarts: [],
+  dateRanges: [],
   mediaGroups: {
     'AUDIO': {
       aac: {

diff --git a/test/fixtures/integration/brightcove.js b/test/fixtures/integration/brightcove.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   playlists: [
     {
       attributes: {

diff --git a/test/fixtures/integration/byteRange.js b/test/fixtures/integration/byteRange.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/dateTime.js b/test/fixtures/integration/dateTime.js
@@ -1,27 +1,24 @@
 module.exports = {
   allowCache: false,
   mediaSequence: 0,
+  dateRanges: [],
   playlistType: 'VOD',
   segments: [
     {
-      dateTimeString: '2016-06-22T09:20:16.166-04:00',
-      dateTimeObject: new Date('2016-06-22T09:20:16.166-04:00'),
+      programDateTime: 1466601616166,
       duration: 10,
       timeline: 0,
       uri: 'hls_450k_video.ts'
     },
     {
-      dateTimeString: '2016-06-22T09:20:26.166-04:00',
-      dateTimeObject: new Date('2016-06-22T09:20:26.166-04:00'),
+      programDateTime: 1466601626166,
       duration: 10,
       timeline: 0,
       uri: 'hls_450k_video.ts'
     }
   ],
   targetDuration: 10,
   endList: true,
-  dateTimeString: '2016-06-22T09:20:16.166-04:00',
-  dateTimeObject: new Date('2016-06-22T09:20:16.166-04:00'),
   discontinuitySequence: 0,
   discontinuityStarts: []
 };
diff --git a/test/fixtures/integration/diff-init-key.js b/test/fixtures/integration/diff-init-key.js
@@ -2,6 +2,7 @@ module.exports = {
   allowCache: true,
   discontinuitySequence: 0,
   discontinuityStarts: [],
+  dateRanges: [],
   mediaSequence: 7794,
   segments: [
     {

diff --git a/test/fixtures/integration/disallowCache.js b/test/fixtures/integration/disallowCache.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: false,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/disc-sequence.js b/test/fixtures/integration/disc-sequence.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   discontinuitySequence: 3,
   segments: [

diff --git a/test/fixtures/integration/discontinuity.js b/test/fixtures/integration/discontinuity.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   discontinuitySequence: 0,
   segments: [

diff --git a/test/fixtures/integration/domainUris.js b/test/fixtures/integration/domainUris.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/empty.js b/test/fixtures/integration/empty.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   discontinuityStarts: [],
   segments: []
 };
diff --git a/test/fixtures/integration/emptyAllowCache.js b/test/fixtures/integration/emptyAllowCache.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/emptyMediaSequence.js b/test/fixtures/integration/emptyMediaSequence.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/emptyPlaylistType.js b/test/fixtures/integration/emptyPlaylistType.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   segments: [
     {

diff --git a/test/fixtures/integration/emptyTargetDuration.js b/test/fixtures/integration/emptyTargetDuration.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   playlists: [
     {
       attributes: {

diff --git a/test/fixtures/integration/encrypted.js b/test/fixtures/integration/encrypted.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 7794,
   discontinuitySequence: 0,
   discontinuityStarts: [],

diff --git a/test/fixtures/integration/event.js b/test/fixtures/integration/event.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'EVENT',
   segments: [

diff --git a/test/fixtures/integration/extXPlaylistTypeInvalidPlaylist.js b/test/fixtures/integration/extXPlaylistTypeInvalidPlaylist.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 1,
   segments: [
     {

diff --git a/test/fixtures/integration/extinf.js b/test/fixtures/integration/extinf.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/fmp4.js b/test/fixtures/integration/fmp4.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 1,
   playlistType: 'VOD',
   targetDuration: 6,

diff --git a/test/fixtures/integration/headerOnly.js b/test/fixtures/integration/headerOnly.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   discontinuityStarts: [],
   segments: []
 };
diff --git a/test/fixtures/integration/invalidAllowCache.js b/test/fixtures/integration/invalidAllowCache.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/invalidMediaSequence.js b/test/fixtures/integration/invalidMediaSequence.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/invalidPlaylistType.js b/test/fixtures/integration/invalidPlaylistType.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   segments: [
     {

diff --git a/test/fixtures/integration/invalidTargetDuration.js b/test/fixtures/integration/invalidTargetDuration.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/liveMissingSegmentDuration.js b/test/fixtures/integration/liveMissingSegmentDuration.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   playlistType: 'VOD',
   segments: [

diff --git a/test/fixtures/integration/liveStart30sBefore.js b/test/fixtures/integration/liveStart30sBefore.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   mediaSequence: 0,
   segments: [
     {

diff --git a/test/fixtures/integration/llhls-byte-range.js b/test/fixtures/integration/llhls-byte-range.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   discontinuitySequence: 0,
   discontinuityStarts: [],
   mediaSequence: 0,

diff --git a/test/fixtures/integration/llhls-delta-byte-range.js b/test/fixtures/integration/llhls-delta-byte-range.js
@@ -1,5 +1,6 @@
 module.exports = {
   allowCache: true,
+  dateRanges: [],
   discontinuitySequence: 0,
   discontinuityStarts: [],
   mediaSequence: 0,