shaka-player 3.3.2 → 4.0.0

package/test/text/ssa_text_parser_unit.js

@@ -4,18 +4,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.text.Cue');
-goog.require('shaka.text.SsaTextParser');
-goog.require('shaka.util.BufferUtils');
-goog.require('shaka.util.StringUtils');
-
 describe('SsaTextParser', () => {
   const Cue = shaka.text.Cue;
 
   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', () => {
@@ -38,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', () => {
@@ -61,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', () => {
@@ -83,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', () => {
@@ -99,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', () => {
@@ -120,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', () => {
@@ -134,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', () => {
@@ -148,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', () => {
@@ -168,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', () => {
@@ -187,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', () => {
@@ -212,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', () => {
@@ -239,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', () => {
@@ -265,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', () => {
@@ -291,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', () => {
@@ -317,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', () => {
@@ -343,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', () => {
@@ -369,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

@@ -4,11 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.test.FakeTextDisplayer');
-goog.require('shaka.text.Cue');
-goog.require('shaka.text.TextEngine');
-goog.require('shaka.util.MimeUtils');
-
 describe('TextEngine', () => {
   const TextEngine = shaka.text.TextEngine;
 
@@ -24,6 +19,9 @@ describe('TextEngine', () => {
   /** @type {!jasmine.Spy} */
   let mockParseInit;
 
+  /** @type {!jasmine.Spy} */
+  let mockSetSequenceMode;
+
   /** @type {!jasmine.Spy} */
   let mockParseMedia;
 
@@ -32,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,
       };
     };
@@ -46,7 +46,10 @@ describe('TextEngine', () => {
 
     TextEngine.registerParser(dummyMimeType, mockParserPlugIn);
     textEngine = new TextEngine(mockDisplayer);
-    textEngine.initParser(dummyMimeType);
+    textEngine.initParser(
+        dummyMimeType,
+        /* sequenceMode= */ false,
+        /* segmentRelativeVttTiming= */ false);
   });
 
   afterEach(() => {
@@ -91,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([
@@ -106,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([
@@ -258,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([
         [
@@ -272,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([
         [
@@ -281,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', () => {
@@ -336,7 +371,7 @@ describe('TextEngine', () => {
     it('does not use timestamp offset', async () => {
       // The start and end times passed to appendBuffer are now absolute, so
       // they already account for timestampOffset and period offset.
-      // See https://github.com/google/shaka-player/issues/1562
+      // See https://github.com/shaka-project/shaka-player/issues/1562
       textEngine.setTimestampOffset(60);
       await textEngine.appendBuffer(dummyData, 0, 3);
       expect(textEngine.bufferStart()).toBe(0);
@@ -379,7 +414,7 @@ describe('TextEngine', () => {
     it('does not use timestamp offset', async () => {
       // The start and end times passed to appendBuffer are now absolute, so
       // they already account for timestampOffset and period offset.
-      // See https://github.com/google/shaka-player/issues/1562
+      // See https://github.com/shaka-project/shaka-player/issues/1562
       textEngine.setTimestampOffset(60);
       await textEngine.appendBuffer(dummyData, 3, 6);
       expect(textEngine.bufferedAheadOf(4)).toBe(2);

package/test/text/text_track_integration.js

@@ -4,8 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-goog.require('shaka.test.UiUtils');
-
 // This tests three assumptions we make about text tracks in Shaka Player:
 //   1. If a non-null value for cues is stored, it will always be the
 //      non-null value for cues when cues returns a non-null value.