onload callback for <track> element attached to <video> does not fire
[WebKit-https.git] / Source / WebCore / html / track / TextTrack.cpp
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  * Copyright (C) 2011 Apple Inc.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33
34 #if ENABLE(VIDEO_TRACK)
35
36 #include "TextTrack.h"
37
38 #include "Event.h"
39 #include "ExceptionCode.h"
40 #include "HTMLMediaElement.h"
41 #include "TextTrackCueList.h"
42 #include "TextTrackList.h"
43 #include "TrackBase.h"
44
45 namespace WebCore {
46
47 static const int invalidTrackIndex = -1;
48
49 const AtomicString& TextTrack::subtitlesKeyword()
50 {
51     DEFINE_STATIC_LOCAL(const AtomicString, subtitles, ("subtitles", AtomicString::ConstructFromLiteral));
52     return subtitles;
53 }
54
55 const AtomicString& TextTrack::captionsKeyword()
56 {
57     DEFINE_STATIC_LOCAL(const AtomicString, captions, ("captions", AtomicString::ConstructFromLiteral));
58     return captions;
59 }
60
61 const AtomicString& TextTrack::descriptionsKeyword()
62 {
63     DEFINE_STATIC_LOCAL(const AtomicString, descriptions, ("descriptions", AtomicString::ConstructFromLiteral));
64     return descriptions;
65 }
66
67 const AtomicString& TextTrack::chaptersKeyword()
68 {
69     DEFINE_STATIC_LOCAL(const AtomicString, chapters, ("chapters", AtomicString::ConstructFromLiteral));
70     return chapters;
71 }
72
73 const AtomicString& TextTrack::metadataKeyword()
74 {
75     DEFINE_STATIC_LOCAL(const AtomicString, metadata, ("metadata", AtomicString::ConstructFromLiteral));
76     return metadata;
77 }
78
79 const AtomicString& TextTrack::disabledKeyword()
80 {
81     DEFINE_STATIC_LOCAL(const AtomicString, open, ("disabled", AtomicString::ConstructFromLiteral));
82     return open;
83 }
84
85 const AtomicString& TextTrack::hiddenKeyword()
86 {
87     DEFINE_STATIC_LOCAL(const AtomicString, closed, ("hidden", AtomicString::ConstructFromLiteral));
88     return closed;
89 }
90
91 const AtomicString& TextTrack::showingKeyword()
92 {
93     DEFINE_STATIC_LOCAL(const AtomicString, ended, ("showing", AtomicString::ConstructFromLiteral));
94     return ended;
95 }
96
97 TextTrack::TextTrack(ScriptExecutionContext* context, TextTrackClient* client, const AtomicString& kind, const AtomicString& label, const AtomicString& language, TextTrackType type)
98     : TrackBase(context, TrackBase::TextTrack)
99     , m_cues(0)
100     , m_mediaElement(0)
101     , m_label(label)
102     , m_language(language)
103     , m_mode(disabledKeyword().string())
104     , m_client(client)
105     , m_trackType(type)
106     , m_readinessState(NotLoaded)
107     , m_trackIndex(invalidTrackIndex)
108     , m_renderedTrackIndex(invalidTrackIndex)
109     , m_showingByDefault(false)
110     , m_hasBeenConfigured(false)
111 {
112     setKind(kind);
113 }
114
115 TextTrack::~TextTrack()
116 {
117     if (m_cues) {
118         if (m_client)
119             m_client->textTrackRemoveCues(this, m_cues.get());
120
121         for (size_t i = 0; i < m_cues->length(); ++i)
122             m_cues->item(i)->setTrack(0);
123     }
124     clearClient();
125 }
126
127 bool TextTrack::isValidKindKeyword(const AtomicString& value)
128 {
129     if (value == subtitlesKeyword())
130         return true;
131     if (value == captionsKeyword())
132         return true;
133     if (value == descriptionsKeyword())
134         return true;
135     if (value == chaptersKeyword())
136         return true;
137     if (value == metadataKeyword())
138         return true;
139
140     return false;
141 }
142
143 void TextTrack::setKind(const AtomicString& kind)
144 {
145     String oldKind = m_kind;
146
147     if (isValidKindKeyword(kind))
148         m_kind = kind;
149     else
150         m_kind = subtitlesKeyword();
151
152     if (m_client && oldKind != m_kind)
153         m_client->textTrackKindChanged(this);
154 }
155
156 void TextTrack::setMode(const AtomicString& mode)
157 {
158     // On setting, if the new value isn't equal to what the attribute would currently
159     // return, the new value must be processed as follows ...
160     if (mode != disabledKeyword() && mode != hiddenKeyword() && mode != showingKeyword())
161         return;
162
163     if (m_mode == mode)
164         return;
165
166     // If mode changes to disabled, remove this track's cues from the client
167     // because they will no longer be accessible from the cues() function.
168     if (mode == disabledKeyword() && m_client && m_cues)
169         m_client->textTrackRemoveCues(this, m_cues.get());
170          
171     if (mode != showingKeyword() && m_cues)
172         for (size_t i = 0; i < m_cues->length(); ++i)
173             m_cues->item(i)->removeDisplayTree();
174
175     //  ... Note: If the mode had been showing by default, this will change it to showing, 
176     // even though the value of mode would appear not to change.
177     m_mode = mode;
178     setShowingByDefault(false);
179
180     if (m_client)
181         m_client->textTrackModeChanged(this);
182 }
183
184 AtomicString TextTrack::mode() const
185 {
186     // The text track "showing" and "showing by default" modes return the string "showing".
187     if (m_showingByDefault)
188         return showingKeyword();
189     return m_mode;
190 }
191
192 TextTrackCueList* TextTrack::cues()
193 {
194     // 4.8.10.12.5 If the text track mode ... is not the text track disabled mode,
195     // then the cues attribute must return a live TextTrackCueList object ...
196     // Otherwise, it must return null. When an object is returned, the
197     // same object must be returned each time.
198     // http://www.whatwg.org/specs/web-apps/current-work/#dom-texttrack-cues
199     if (m_mode != disabledKeyword())
200         return ensureTextTrackCueList();
201     return 0;
202 }
203
204 void TextTrack::removeAllCues()
205 {
206     if (!m_cues)
207         return;
208
209     if (m_client)
210         m_client->textTrackRemoveCues(this, m_cues.get());
211     
212     for (size_t i = 0; i < m_cues->length(); ++i)
213         m_cues->item(i)->setTrack(0);
214     
215     m_cues = 0;
216 }
217
218 TextTrackCueList* TextTrack::activeCues() const
219 {
220     // 4.8.10.12.5 If the text track mode ... is not the text track disabled mode,
221     // then the activeCues attribute must return a live TextTrackCueList object ...
222     // ... whose active flag was set when the script started, in text track cue
223     // order. Otherwise, it must return null. When an object is returned, the
224     // same object must be returned each time.
225     // http://www.whatwg.org/specs/web-apps/current-work/#dom-texttrack-activecues
226     if (m_cues && m_mode != disabledKeyword())
227         return m_cues->activeCues();
228     return 0;
229 }
230
231 void TextTrack::addCue(PassRefPtr<TextTrackCue> prpCue)
232 {
233     if (!prpCue)
234         return;
235
236     RefPtr<TextTrackCue> cue = prpCue;
237
238     // TODO(93143): Add spec-compliant behavior for negative time values.
239     if (isnan(cue->startTime()) || isnan(cue->endTime()) || cue->startTime() < 0 || cue->endTime() < 0)
240         return;
241
242     // 4.8.10.12.5 Text track API
243
244     // The addCue(cue) method of TextTrack objects, when invoked, must run the following steps:
245
246     // 1. If the given cue is in a text track list of cues, then remove cue from that text track
247     // list of cues.
248     TextTrack* cueTrack = cue->track();
249     if (cueTrack && cueTrack != this)
250         cueTrack->removeCue(cue.get(), ASSERT_NO_EXCEPTION);
251
252     // 2. Add cue to the method's TextTrack object's text track's text track list of cues.
253     cue->setTrack(this);
254     ensureTextTrackCueList()->add(cue);
255     
256     if (m_client)
257         m_client->textTrackAddCue(this, cue.get());
258 }
259
260 void TextTrack::removeCue(TextTrackCue* cue, ExceptionCode& ec)
261 {
262     if (!cue)
263         return;
264
265     // 4.8.10.12.5 Text track API
266
267     // The removeCue(cue) method of TextTrack objects, when invoked, must run the following steps:
268
269     // 1. If the given cue is not currently listed in the method's TextTrack 
270     // object's text track's text track list of cues, then throw a NotFoundError exception.
271     if (cue->track() != this) {
272         ec = NOT_FOUND_ERR;
273         return;
274     }
275
276     // 2. Remove cue from the method's TextTrack object's text track's text track list of cues.
277     if (!m_cues || !m_cues->remove(cue)) {
278         ec = INVALID_STATE_ERR;
279         return;
280     }
281
282     cue->setTrack(0);
283     if (m_client)
284         m_client->textTrackRemoveCue(this, cue);
285 }
286
287 void TextTrack::cueWillChange(TextTrackCue* cue)
288 {
289     if (!m_client)
290         return;
291
292     // The cue may need to be repositioned in the media element's interval tree, may need to
293     // be re-rendered, etc, so remove it before the modification...
294     m_client->textTrackRemoveCue(this, cue);
295 }
296
297 void TextTrack::cueDidChange(TextTrackCue* cue)
298 {
299     if (!m_client)
300         return;
301
302     // Make sure the TextTrackCueList order is up-to-date.
303     ensureTextTrackCueList()->updateCueIndex(cue);
304
305     // ... and add it back again.
306     m_client->textTrackAddCue(this, cue);
307 }
308
309 int TextTrack::trackIndex()
310 {
311     ASSERT(m_mediaElement);
312
313     if (m_trackIndex == invalidTrackIndex)
314         m_trackIndex = m_mediaElement->textTracks()->getTrackIndex(this);
315
316     return m_trackIndex;
317 }
318
319 void TextTrack::invalidateTrackIndex()
320 {
321     m_trackIndex = invalidTrackIndex;
322     m_renderedTrackIndex = invalidTrackIndex;
323 }
324
325 bool TextTrack::isRendered()
326 {
327     if (m_kind != captionsKeyword() && m_kind != subtitlesKeyword())
328         return false;
329
330     if (m_mode != showingKeyword() && !m_showingByDefault)
331         return false;
332
333     return true;
334 }
335
336 TextTrackCueList* TextTrack::ensureTextTrackCueList()
337 {
338     if (!m_cues)
339         m_cues = TextTrackCueList::create();
340
341     return m_cues.get();
342 }
343
344 int TextTrack::trackIndexRelativeToRenderedTracks()
345 {
346     ASSERT(m_mediaElement);
347     
348     if (m_renderedTrackIndex == invalidTrackIndex)
349         m_renderedTrackIndex = m_mediaElement->textTracks()->getTrackIndexRelativeToRenderedTracks(this);
350     
351     return m_renderedTrackIndex;
352 }
353
354 } // namespace WebCore
355
356 #endif