shaka-player 3.3.4 → 4.0.1

package/test/text/mp4_vtt_parser_unit.js

@@ -65,7 +65,7 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegment, time);
     verifyHelper(cues, result);
   });
@@ -93,7 +93,7 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegmentMultiPayload, time);
     verifyHelper(cues, result);
   });
@@ -121,7 +121,7 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegSettings, time);
     verifyHelper(cues, result);
   });
@@ -143,7 +143,7 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0};
+    const time = {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0};
     const result = parser.parseMedia(vttSegNoDuration, time);
     verifyHelper(cues, result);
   });
@@ -165,7 +165,8 @@ describe('Mp4VttParser', () => {
 
     const parser = new shaka.text.Mp4VttParser();
     parser.parseInit(vttInitSegment);
-    const time = {periodStart: 10, segmentStart: 0, segmentEnd: 0};
+    const time =
+        {periodStart: 10, segmentStart: 0, segmentEnd: 0, vttOffset: 10};
     const result = parser.parseMedia(vttSegment, time);
     verifyHelper(cues, result);
   });

package/test/text/sbv_text_parser_unit.js

@@ -8,7 +8,7 @@ describe('SbvTextParser', () => {
   it('supports no cues', () => {
     verifyHelper([],
         '',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the end of the file', () => {
@@ -18,7 +18,7 @@ describe('SbvTextParser', () => {
         ],
         '0:00:20.000,0:00:40.000\n' +
         'Test\n\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no blank line at the end of the file', () => {
@@ -28,8 +28,7 @@ describe('SbvTextParser', () => {
         ],
         '0:00:20.000,0:00:40.000\n' +
         'Test\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no newline after the final text payload', () => {
@@ -39,7 +38,7 @@ describe('SbvTextParser', () => {
         ],
         '0:00:20.000,0:00:40.000\n' +
         'Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports multiple cues', () => {
@@ -52,7 +51,7 @@ describe('SbvTextParser', () => {
         'Test\n\n' +
         '0:00:40.000,0:00:50.000\n' +
         'Test2',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   /**

package/test/text/srt_text_parser_unit.js

@@ -8,7 +8,7 @@ describe('SrtTextParser', () => {
   it('supports no cues', () => {
     verifyHelper([],
         '',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the end of the file', () => {
@@ -19,7 +19,7 @@ describe('SrtTextParser', () => {
         '1\n' +
         '00:00:20,000 --> 00:00:40,000\n' +
         'Test\n\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no blank line at the end of the file', () => {
@@ -30,8 +30,7 @@ describe('SrtTextParser', () => {
         '1\n' +
         '00:00:20,000 --> 00:00:40,000\n' +
         'Test\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no newline after the final text payload', () => {
@@ -42,7 +41,7 @@ describe('SrtTextParser', () => {
         '1\n' +
         '00:00:20,000 --> 00:00:40,000\n' +
         'Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports multiple cues', () => {
@@ -57,7 +56,7 @@ describe('SrtTextParser', () => {
         '2\n' +
         '00:00:40,000 --> 00:00:50,000\n' +
         'Test2',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   /**

package/test/text/ssa_text_parser_unit.js

@@ -10,7 +10,7 @@ describe('SsaTextParser', () => {
   it('supports no cues', () => {
     verifyHelper([],
         '',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the start of the file', () => {
@@ -33,7 +33,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles a blank line at the end of the file', () => {
@@ -56,7 +56,7 @@ describe('SsaTextParser', () => {
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test' +
         '\n\n',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('handles no blank line at the end of the file', () => {
@@ -78,8 +78,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports no styles', () => {
@@ -94,8 +93,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('support no script info', () => {
@@ -115,8 +113,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports only events', () => {
@@ -129,8 +126,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports text with commas', () => {
@@ -143,8 +139,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test,1,Test2',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports different time formats', () => {
@@ -163,7 +158,7 @@ describe('SsaTextParser', () => {
         ',,{\\pos(400,570)}Test2\n' +
         'Dialogue: 0,0:00:08.01,0:00:10.001,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test3',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports multiple cues', () => {
@@ -182,7 +177,7 @@ describe('SsaTextParser', () => {
         ',,{\\pos(400,570)}Test2\n' +
         'Dialogue: 0,0:00:08.01,0:00:10.10,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test3',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0});
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports fontFamily style', () => {
@@ -207,8 +202,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports color & backgroundColor style', () => {
@@ -234,8 +228,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports bold style', () => {
@@ -260,8 +253,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports italic style', () => {
@@ -286,8 +278,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports underline style', () => {
@@ -312,8 +303,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports letterSpacing style', () => {
@@ -338,8 +328,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   it('supports V4 style', () => {
@@ -364,8 +353,7 @@ describe('SsaTextParser', () => {
         'Effect, Text\n' +
         'Dialogue: 0,0:00:00.00,0:00:02.00,DefaultVCD, NTP,0000,0000,0000' +
         ',,{\\pos(400,570)}Test',
-        {periodStart: 0, segmentStart: 0, segmentEnd: 0,
-        });
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
   /**

package/test/text/text_engine_unit.js

@@ -19,6 +19,9 @@ describe('TextEngine', () => {
   /** @type {!jasmine.Spy} */
   let mockParseInit;
 
+  /** @type {!jasmine.Spy} */
+  let mockSetSequenceMode;
+
   /** @type {!jasmine.Spy} */
   let mockParseMedia;
 
@@ -27,11 +30,13 @@ describe('TextEngine', () => {
 
   beforeEach(() => {
     mockParseInit = jasmine.createSpy('mockParseInit');
+    mockSetSequenceMode = jasmine.createSpy('mockSetSequenceMode');
     mockParseMedia = jasmine.createSpy('mockParseMedia');
     // eslint-disable-next-line no-restricted-syntax
     mockParserPlugIn = function() {
       return {
         parseInit: mockParseInit,
+        setSequenceMode: mockSetSequenceMode,
         parseMedia: mockParseMedia,
       };
     };
@@ -41,7 +46,10 @@ describe('TextEngine', () => {
 
     TextEngine.registerParser(dummyMimeType, mockParserPlugIn);
     textEngine = new TextEngine(mockDisplayer);
-    textEngine.initParser(dummyMimeType);
+    textEngine.initParser(
+        dummyMimeType,
+        /* sequenceMode= */ false,
+        /* segmentRelativeVttTiming= */ false);
   });
 
   afterEach(() => {
@@ -86,7 +94,7 @@ describe('TextEngine', () => {
       await textEngine.appendBuffer(dummyData, 0, 3);
       expect(mockParseMedia).toHaveBeenCalledOnceMoreWith([
         dummyData,
-        {periodStart: 0, segmentStart: 0, segmentEnd: 3},
+        {periodStart: 0, segmentStart: 0, segmentEnd: 3, vttOffset: 0},
       ]);
 
       expect(mockDisplayer.appendSpy).toHaveBeenCalledOnceMoreWith([
@@ -101,7 +109,7 @@ describe('TextEngine', () => {
 
       expect(mockParseMedia).toHaveBeenCalledOnceMoreWith([
         dummyData,
-        {periodStart: 0, segmentStart: 3, segmentEnd: 5},
+        {periodStart: 0, segmentStart: 3, segmentEnd: 5, vttOffset: 0},
       ]);
 
       expect(mockDisplayer.appendSpy).toHaveBeenCalledOnceMoreWith([
@@ -253,7 +261,7 @@ describe('TextEngine', () => {
 
       expect(mockParseMedia).toHaveBeenCalledOnceMoreWith([
         dummyData,
-        {periodStart: 0, segmentStart: 0, segmentEnd: 3},
+        {periodStart: 0, segmentStart: 0, segmentEnd: 3, vttOffset: 0},
       ]);
       expect(mockDisplayer.appendSpy).toHaveBeenCalledOnceMoreWith([
         [
@@ -267,7 +275,7 @@ describe('TextEngine', () => {
 
       expect(mockParseMedia).toHaveBeenCalledOnceMoreWith([
         dummyData,
-        {periodStart: 4, segmentStart: 4, segmentEnd: 7},
+        {periodStart: 4, segmentStart: 4, segmentEnd: 7, vttOffset: 4},
       ]);
       expect(mockDisplayer.appendSpy).toHaveBeenCalledOnceMoreWith([
         [
@@ -276,6 +284,38 @@ describe('TextEngine', () => {
         ],
       ]);
     });
+
+    it('vttOffset when segmentRelativeVttTiming is set', async () => {
+      textEngine.initParser(
+          dummyMimeType,
+          /* sequenceMode= */ false,
+          /* segmentRelativeVttTiming= */ true);
+
+      mockParseMedia.and.callFake((data, time) => {
+        return [
+          createFakeCue(time.periodStart + 0,
+              time.periodStart + 1),
+          createFakeCue(time.periodStart + 2,
+              time.periodStart + 3),
+        ];
+      });
+
+      await textEngine.appendBuffer(dummyData, 0, 3);
+
+      expect(mockParseMedia).toHaveBeenCalledOnceMoreWith([
+        dummyData,
+        {periodStart: 0, segmentStart: 0, segmentEnd: 3, vttOffset: 0},
+      ]);
+
+      textEngine.setTimestampOffset(8);
+      await textEngine.appendBuffer(dummyData, 4, 7);
+
+      // vttOffset should equal segmentStart instead of periodStart
+      expect(mockParseMedia).toHaveBeenCalledOnceMoreWith([
+        dummyData,
+        {periodStart: 8, segmentStart: 4, segmentEnd: 7, vttOffset: 4},
+      ]);
+    });
   });
 
   describe('bufferStart/bufferEnd', () => {