Add config option for using segment relative timestamps for VTT #542

sanbornhilland · 2016-10-06T19:53:58Z

Fix for #480

This should be reviewed closely. Specifically I'm not thrilled that I had to modify all the other text parsers to receiver an argument that none of them are going to use. That seems confusing to me but I wasn't sure how to avoid that.

Fix for shaka-project#480

ismena · 2016-10-07T21:00:25Z

lib/media/media_source_engine.js

 *
 * @throws InvalidAccessError if blank MIME types are given
 * @throws NotSupportedError if unsupported MIME types are given
 * @throws QuotaExceededError if the browser can't support that many buffers
 *
 * @suppress {unnecessaryCasts}
 */
-shaka.media.MediaSourceEngine.prototype.init = function(typeConfig) {
+shaka.media.MediaSourceEngine.prototype.init = function(typeConfig, config) {


Let's just pass a useRelativeCueTimestamps boolean down instead of the whole config structure. This means we won't be able to update it, but given the nature of the setting this should be fine.

ismena · 2016-10-07T21:03:59Z

lib/media/mp4_ttml_parser.js

@@ -31,10 +31,12 @@ goog.require('shaka.util.Mp4Parser');
 * @param {number} offset
 * @param {?number} segmentStartTime
 * @param {?number} segmentEndTime
+ * @param {?boolean} useRelativeCueTimestamps


"?" in front of the type means "nullable". E. g. segmentEndTime could be a number, or it could be null. Notice, how the offset is just {number}, meaning we always expect it to be a number, passing null won't compile.

In case of useRelativeCueTimestamps, it always should be either true or false, which means we don't need the "?" before "boolean". Same stands for all the other places where it is declared.

ismena · 2016-10-07T21:07:56Z

lib/media/mp4_ttml_parser.js

@@ -45,7 +47,7 @@ shaka.media.Mp4TtmlParser =
    // mdat box found, use TtmlTextParser to parse the content
    return shaka.media.TtmlTextParser(
        reader.readBytes(boxSize - 8).buffer, offset,
-        segmentStartTime, segmentEndTime);
+        segmentStartTime, segmentEndTime, null);


It's less confusing if you pass the value of useRelativeCueTimestamps, the other parsers can ignore it.

ismena · 2016-10-07T21:08:58Z

lib/media/mp4_vtt_parser.js

@@ -34,10 +34,12 @@ goog.require('shaka.util.TextParser');
 * @param {number} offset
 * @param {?number} segmentStartTime
 * @param {?number} segmentEndTime
+ * @param {?boolean} useRelativeCueTimestamps


Drop "?" and add a comment that useRelativeCueTimestamps is only used by the VTT parser.

ismena · 2016-10-07T21:10:46Z

lib/media/text_engine.js

 * @implements {shaka.util.IDestroyable}
 */
-shaka.media.TextEngine = function(track, mimeType) {
+shaka.media.TextEngine = function(track, mimeType, config) {


Use bool useRelativeCueTimestamps

ismena · 2016-10-07T21:11:12Z

lib/media/ttml_text_parser.js

@@ -30,11 +30,14 @@ goog.require('shaka.util.StringUtils');
 * @param {number} offset
 * @param {?number} segmentStartTime
 * @param {?number} segmentEndTime
+ * @param {?boolean} useRelativeCueTimestamps


Drop "?" and add a comment that useRelativeCueTimestamps is only used by the VTT parser.

ismena · 2016-10-07T21:11:39Z

lib/media/ttml_text_parser.js

@@ -49,7 +52,7 @@ shaka.media.TtmlTextParser =
  }

  if (xml) {
-    // Try to get the framerate, subRameRate and frameRateMultiplier


Nice catch :)

ismena · 2016-10-07T21:17:16Z

test/media/cue_integration.js

@@ -65,6 +65,6 @@ describe('Cue', function() {
   */
  function parseVtt(text, opt_offset) {
    var data = shaka.util.StringUtils.toUTF8(text);
-    return shaka.media.VttTextParser(data, opt_offset || 0, null, null);
+    return shaka.media.VttTextParser(data, opt_offset || 0, null, null, null);


use false, here and in the other tests

ismena · 2016-10-07T21:22:18Z

test/media/vtt_text_parser_unit.js

@@ -368,7 +368,8 @@ describe('VttTextParser', function() {
  function verifyHelper(cues, text, opt_offset) {
    var data = shaka.util.StringUtils.toUTF8(text);
    // Last two parameters are only used by mp4 vtt parser.
-    var result = shaka.media.VttTextParser(data, opt_offset || 0, null, null);
+    var result =
+        shaka.media.VttTextParser(data, opt_offset || 0, null, null, null);


Let's also add a new test "uses relative time stamps if configured to" which will pass "true" to the vtt parser and check that the start/end time of the cues is now relative.

shaka-bot · 2016-10-17T17:39:08Z

Testing in progress...

shaka-bot · 2016-10-17T17:47:50Z

Failure:

Chrome 54.0.2840 (Linux 0.0.0).Player configure checks the number of arguments to functions FAILED
  Expected spy shaka.log.warning not to have been called.
      at Object.<anonymous> (test/player_unit.js:544:30)

Chrome 54.0.2840 (Linux 0.0.0).Player configure checks the number of arguments to functions FAILED
  Expected spy shaka.log.warning not to have been called.
      at Object.<anonymous> (test/player_unit.js:576:30)


Failed 2 tests, passed 897, skipped 37

joeyparrish · 2016-10-17T17:49:25Z

It might be better to log the warning specifically from the VTTParser, and specifically when the start offset is non-zero. That way, if the VTT parser is not being used, or if the WebVTT tracks are not segmented, the warning will not be seen. This should also fix the test failures.

sanbornhilland · 2016-10-17T20:46:06Z

Okay, thanks, will do. I was confused about those test failures. Thanks for the explanation.

ismena · 2016-10-17T20:49:59Z

The CL looks good otherwise :)

joeyparrish · 2016-10-18T15:58:35Z

test/media/vtt_text_parser_unit.js

@@ -365,7 +365,7 @@ describe('VttTextParser', function() {
  });

  it('ignores and logs invalid settings', function() {
-    expect(logWarningSpy.calls.count()).toBe(0);
+    expect(logWarningSpy.calls.count()).toBe(1); // From test above


If this test is run in isolation, it would still fail. The right fix is to add a beforeEach() function, in which you call logWarningSpy.calls.reset(). That way, each test gets a clean slate. This is something that we should caught long ago.

joeyparrish · 2016-10-18T16:01:51Z

lib/media/vtt_text_parser.js

@@ -39,6 +39,12 @@ shaka.media.VttTextParser =
    function(data, offset, segmentStartTime,
             segmentEndTime, useRelativeCueTimestamps) {

+  if (segmentStartTime > 0) {


&& !useRelativeCueTimestamps ?

I was unsure about this and wanted feedback. I thought it might be desirable for all users to get this warning since deprecating this will affect users whether they are using the default setting or not. But if that seems like overkill than I can put that second condition back in.

If the flag is set to true, then somebody is using it explicitly to get the new behavior, so they don't really need a warning. At least, that's my take on it.

shaka-bot · 2016-10-24T17:19:12Z

Testing in progress...

shaka-bot · 2016-10-24T17:27:54Z

All tests passed!

* Add config option for using segment relative timestamps for VTT Fix for #480 * Make useRelativeCueTimestamps a non-nullable param * Update tests for the new useRelativeCueTimestamps param * Move period relative timestamp deprecation warning to vtt parser * Log warning only if using absolute timestamps in text cue * Fix vtt text parser test

Add config option for using segment relative timestamps for VTT

f882c38

Fix for shaka-project#480

ismena reviewed Oct 7, 2016

View reviewed changes

Sanborn Hilland added 3 commits October 12, 2016 11:46

Make useRelativeCueTimestamps a non-nullable param

60d0e78

Update tests for the new useRelativeCueTimestamps param

4958cf7

Merge branch 'master' into bugFix/live_vtt

b69a698

Move period relative timestamp deprecation warning to vtt parser

db96af8

joeyparrish reviewed Oct 18, 2016

View reviewed changes

Sanborn Hilland added 2 commits October 24, 2016 10:41

Log warning only if using absolute timestamps in text cue

129cb8b

Fix vtt text parser test

7c4df56

ismena merged commit fff9892 into shaka-project:master Oct 24, 2016

OrenMe mentioned this pull request Mar 17, 2021

VTT cues relative segment start time is not getting applied #3242

Closed

github-actions bot added the status: archived Archived and locked; will not be updated label Jul 25, 2023

github-actions bot locked as resolved and limited conversation to collaborators Jul 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add config option for using segment relative timestamps for VTT #542

Add config option for using segment relative timestamps for VTT #542

sanbornhilland commented Oct 6, 2016

ismena Oct 7, 2016

ismena Oct 7, 2016 •

edited

Loading

ismena Oct 7, 2016

ismena Oct 7, 2016

ismena Oct 7, 2016

ismena Oct 7, 2016

ismena Oct 7, 2016

ismena Oct 7, 2016 •

edited

Loading

ismena Oct 7, 2016

shaka-bot commented Oct 17, 2016

shaka-bot commented Oct 17, 2016

joeyparrish commented Oct 17, 2016

sanbornhilland commented Oct 17, 2016

ismena commented Oct 17, 2016

joeyparrish Oct 18, 2016

joeyparrish Oct 18, 2016

sanbornhilland Oct 18, 2016

joeyparrish Oct 18, 2016

shaka-bot commented Oct 24, 2016

shaka-bot commented Oct 24, 2016

Add config option for using segment relative timestamps for VTT #542

Add config option for using segment relative timestamps for VTT #542

Conversation

sanbornhilland commented Oct 6, 2016

Choose a reason for hiding this comment

ismena Oct 7, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ismena Oct 7, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaka-bot commented Oct 17, 2016

shaka-bot commented Oct 17, 2016

joeyparrish commented Oct 17, 2016

sanbornhilland commented Oct 17, 2016

ismena commented Oct 17, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaka-bot commented Oct 24, 2016

shaka-bot commented Oct 24, 2016

ismena Oct 7, 2016 •

edited

Loading

ismena Oct 7, 2016 •

edited

Loading