1548731 - [webvtt] support `cuechange` event

Status: RESOLVED FIXED

(Core :: Audio/Video, enhancement, P2)

Description

[Alastor Wu [:alwu]]

According to spec [1], oncuechange is one of the GlobalEventHandler. This event could be fired on Track element or TextTrack [2].

We would dispatch this event when we run the TimeMarchesOn algorithm. [3]

[1] https://html.spec.whatwg.org/multipage/webappapis.html#handler-oncuechange
[2] https://html.spec.whatwg.org/multipage/media.html#event-media-cuechange
[3] https://html.spec.whatwg.org/multipage/media.html#playing-the-media-resource:event-media-cuechange

Comment 1

[Alastor Wu [:alwu]]

Attachment: Bug 1548731 - part1 : support 'cuechange' event.

According to the spec [1], oncuechange is one of the GlobalEventHandler. This event could be fired on Track element or TextTrack [2].

We would dispatch this event when we run the TimeMarchesOn algorithm.

[1] https://html.spec.whatwg.org/multipage/webappapis.html#handler-oncuechange
[2] https://html.spec.whatwg.org/multipage/media.html#event-media-cuechange
[3] https://html.spec.whatwg.org/multipage/media.html#playing-the-media-resource:event-media-cuechange

Comment 2

[Alastor Wu [:alwu]]

Attachment: Bug 1548731 - part2 : enable failed wpt items.

Comment 3

[Alastor Wu [:alwu]]

Now I'm investigating why track-mode.html and track-cues-cuechange.html will fail intermittently, will start a review after figuring out the reason.

Comment 4

[Alastor Wu [:alwu]]

Attachment: Bug 1548731 - part3 : modify wpt 'track-mode.html'.

This patch does two changes in order to test the correct behavior.

(1) Not to use time out function
Waiting for 0.4s by using timeout function doesn't mean the code will exactly be executed after 0.4s.
If we would like to specify the time when we should change track's mode, we should listen for video's timeupdate to get the correct result.

(2) Modify ending condition
As this test is going to turn the track to showing/hidden after video is playing after 0.4s, the second and the third cue would be showed correctly.

The second cue is from 0.3 to 0.7, so when we changed track mode in 0.4s, it would be regard as a active cue, and dispatch enter. When the cue is going to become inactive, the event exit would be dispatched.

Therefore, there would be total 4 times of the accumulation of enter and exit events, which means oncuechange would also be dispatched 4 times.

Comment 5

[Alastor Wu [:alwu]]

The track-cues-cuechange.html would only fail on the Win32 on try, I guess there might be some playback issue on Windows which causes the failure. I'm going to disable that test on Win32, but enable it on other platforms.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/073a5c5c2262
part1 : support 'cuechange' event. r=smaug
https://hg.mozilla.org/integration/autoland/rev/cea220a6b7dd
part2 : enable failed wpt items. r=smaug
https://hg.mozilla.org/integration/autoland/rev/304294b29dae
part3 : modify wpt 'track-mode.html'. r=smaug

Comment 7

[Oana Pop-Rus]

https://hg.mozilla.org/mozilla-central/rev/073a5c5c2262
https://hg.mozilla.org/mozilla-central/rev/cea220a6b7dd
https://hg.mozilla.org/mozilla-central/rev/304294b29dae

Comment 8

[Web Platform Test Sync Bot [:wpt-sync] (Matrix: #interop:mozilla.org)]

Created web-platform-tests PR https://github.com/web-platform-tests/wpt/pull/16879 for changes under testing/web-platform/tests

Comment 9

[Web Platform Test Sync Bot [:wpt-sync] (Matrix: #interop:mozilla.org)]

Upstream PR merged

Comment 10

[Eric Shepherd [:sheppy]]

We previously had this documenting as being implemented already in Firefox 31. I'm not sure why...

Comment 11

[Alastor Wu [:alwu]]

(In reply to Eric Shepherd [:sheppy] from comment #10)

We previously had this documenting as being implemented already in Firefox 31. I'm not sure why...

The MDN document is the cuechange event [1] for text track, but in this bug, what we implemented is the cuechange event for track element [2].

[1] https://developer.mozilla.org/en-US/docs/Web/API/TextTrack/cuechange_event
[2] https://developer.mozilla.org/en-US/docs/Web/HTML/Element/track

Comment 12

[Eric Shepherd [:sheppy]]

Oh! Gotcha! I missed that bit when doing a quick once-over of the bug. I'm on it then. :)

Comment 13

[Eric Shepherd [:sheppy]]

Documentation updates:

• Updated TextTrack cuechange event
• Added cuechange event to HTMLTrackElement
• Created page for HTMLTrackElement's cuechange event which simply embeds the contents of the article on TextTrack's cuechange event
• Added cuechange event to <track> and HTMLTrackElement in BCD
• Submitted BCD PR 4400 with cuechange updates
• Added an entry on Firefox 68 for developers