Update the TextTrackCue Constructor
[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"));
52     return subtitles;
53 }
54
55 const AtomicString& TextTrack::captionsKeyword()
56 {
57     DEFINE_STATIC_LOCAL(const AtomicString, captions, ("captions"));
58     return captions;
59 }
60
61 const AtomicString& TextTrack::descriptionsKeyword()
62 {
63     DEFINE_STATIC_LOCAL(const AtomicString, descriptions, ("descriptions"));
64     return descriptions;
65 }
66
67 const AtomicString& TextTrack::chaptersKeyword()
68 {
69     DEFINE_STATIC_LOCAL(const AtomicString, chapters, ("chapters"));
70     return chapters;
71 }
72
73 const AtomicString& TextTrack::metadataKeyword()
74 {
75     DEFINE_STATIC_LOCAL(const AtomicString, metadata, ("metadata"));
76     return metadata;
77 }
78
79 TextTrack::TextTrack(ScriptExecutionContext* context, TextTrackClient* client, const String& kind, const String& label, const String& language, TextTrackType type)
80     : TrackBase(context, TrackBase::TextTrack)
81     , m_cues(0)
82     , m_mediaElement(0)
83     , m_label(label)
84     , m_language(language)
85     , m_mode(TextTrack::DISABLED)
86     , m_client(client)
87     , m_trackType(type)
88     , m_readinessState(NotLoaded)
89     , m_showingByDefault(false)
90     , m_trackIndex(invalidTrackIndex)
91 {
92     setKind(kind);
93 }
94
95 TextTrack::~TextTrack()
96 {
97     if (m_client && m_cues)
98         m_client->textTrackRemoveCues(this, m_cues.get());
99     clearClient();
100 }
101
102 bool TextTrack::isValidKindKeyword(const String& value)
103 {
104     if (equalIgnoringCase(value, subtitlesKeyword()))
105         return true;
106     if (equalIgnoringCase(value, captionsKeyword()))
107         return true;
108     if (equalIgnoringCase(value, descriptionsKeyword()))
109         return true;
110     if (equalIgnoringCase(value, chaptersKeyword()))
111         return true;
112     if (equalIgnoringCase(value, metadataKeyword()))
113         return true;
114
115     return false;
116 }
117
118 void TextTrack::setKind(const String& kind)
119 {
120     String oldKind = m_kind;
121
122     if (isValidKindKeyword(kind))
123         m_kind = kind;
124     else
125         m_kind = subtitlesKeyword();
126
127     if (m_client && oldKind != m_kind)
128         m_client->textTrackKindChanged(this);
129 }
130
131 void TextTrack::setMode(unsigned short mode, ExceptionCode& ec)
132 {
133     // 4.8.10.12.5 On setting the mode, if the new value is not either 0, 1, or 2,
134     // the user agent must throw an INVALID_ACCESS_ERR exception.
135     if (mode > TextTrack::SHOWING) {
136         ec = INVALID_ACCESS_ERR;
137         return;
138     }
139
140     if (m_mode == static_cast<Mode>(mode))
141         return;
142
143     // If mode changes to disabled, remove this track's cues from the client
144     // because they will no longer be accessible from the cues() function.
145     if (mode == TextTrack::DISABLED && m_client && m_cues)
146         m_client->textTrackRemoveCues(this, m_cues.get());
147          
148     if (mode != TextTrack::SHOWING && m_cues)
149         for (size_t i = 0; i < m_cues->length(); ++i)
150             m_cues->item(i)->removeDisplayTree();
151
152     //  ... Note: If the mode had been showing by default, this will change it to showing, 
153     // even though the value of mode would appear not to change.
154     m_mode = static_cast<Mode>(mode);
155     setShowingByDefault(false);
156
157     if (m_client)
158         m_client->textTrackModeChanged(this);
159 }
160
161 TextTrack::Mode TextTrack::mode() const
162 {
163     // The text track "showing" and "showing by default" modes return SHOWING (numeric value 2)
164     if (m_showingByDefault)
165         return SHOWING;
166     return m_mode;
167 }
168
169 TextTrackCueList* TextTrack::cues()
170 {
171     // 4.8.10.12.5 If the text track mode ... is not the text track disabled mode,
172     // then the cues attribute must return a live TextTrackCueList object ...
173     // Otherwise, it must return null. When an object is returned, the
174     // same object must be returned each time.
175     // http://www.whatwg.org/specs/web-apps/current-work/#dom-texttrack-cues
176     if (m_mode != TextTrack::DISABLED)
177         return ensureTextTrackCueList();
178     return 0;
179 }
180
181 TextTrackCueList* TextTrack::activeCues() const
182 {
183     // 4.8.10.12.5 If the text track mode ... is not the text track disabled mode,
184     // then the activeCues attribute must return a live TextTrackCueList object ...
185     // ... whose active flag was set when the script started, in text track cue
186     // order. Otherwise, it must return null. When an object is returned, the
187     // same object must be returned each time.
188     // http://www.whatwg.org/specs/web-apps/current-work/#dom-texttrack-activecues
189     if (m_cues && m_mode != TextTrack::DISABLED)
190         return m_cues->activeCues();
191     return 0;
192 }
193
194 void TextTrack::addCue(PassRefPtr<TextTrackCue> prpCue, ExceptionCode& ec)
195 {
196     if (!prpCue)
197         return;
198
199     RefPtr<TextTrackCue> cue = prpCue;
200
201     // TODO(93143): Add spec-compliant behavior for negative time values.
202     if (isnan(cue->startTime()) || isnan(cue->endTime()) || cue->startTime() < 0 || cue->endTime() < 0)
203         return;
204
205     // 4.8.10.12.4 Text track API
206
207     // The addCue(cue) method of TextTrack objects, when invoked, must run the following steps:
208
209     // 1. If the given cue is already associated with a text track other than 
210     // the method's TextTrack object's text track, then throw an InvalidStateError
211     // exception and abort these steps.
212     TextTrack* cueTrack = cue->track();
213     if (cueTrack && cueTrack != this) {
214         ec = INVALID_STATE_ERR;
215         return;
216     }
217
218     // 2. Associate cue with the method's TextTrack object's text track, if it is 
219     // not currently associated with a text track.
220     cue->setTrack(this);
221
222     // 3. If the given cue is already listed in the method's TextTrack object's text
223     // track's text track list of cues, then throw an InvalidStateError exception.
224     // 4. Add cue to the method's TextTrack object's text track's text track list of cues.
225     if (!ensureTextTrackCueList()->add(cue)) {
226         ec = INVALID_STATE_ERR;
227         return;
228     }
229     
230     if (m_client)
231         m_client->textTrackAddCue(this, cue.get());
232 }
233
234 void TextTrack::removeCue(TextTrackCue* cue, ExceptionCode& ec)
235 {
236     if (!cue)
237         return;
238
239     // 4.8.10.12.4 Text track API
240
241     // The removeCue(cue) method of TextTrack objects, when invoked, must run the following steps:
242
243     // 1. If the given cue is not associated with the method's TextTrack 
244     // object's text track, then throw an InvalidStateError exception.
245     if (cue->track() != this) {
246         ec = INVALID_STATE_ERR;
247         return;
248     }
249     
250     // 2. If the given cue is not currently listed in the method's TextTrack 
251     // object's text track's text track list of cues, then throw a NotFoundError exception.
252     // 3. Remove cue from the method's TextTrack object's text track's text track list of cues.
253     if (!m_cues || !m_cues->remove(cue)) {
254         ec = INVALID_STATE_ERR;
255         return;
256     }
257
258     cue->setTrack(0);
259     if (m_client)
260         m_client->textTrackRemoveCue(this, cue);
261 }
262
263 void TextTrack::cueWillChange(TextTrackCue* cue)
264 {
265     if (!m_client)
266         return;
267
268     // The cue may need to be repositioned in the media element's interval tree, may need to
269     // be re-rendered, etc, so remove it before the modification...
270     m_client->textTrackRemoveCue(this, cue);
271 }
272
273 void TextTrack::cueDidChange(TextTrackCue* cue)
274 {
275     if (!m_client)
276         return;
277
278     // ... and add it back again.
279     m_client->textTrackAddCue(this, cue);
280 }
281
282 int TextTrack::trackIndex()
283 {
284     ASSERT(m_mediaElement);
285
286     if (m_trackIndex == invalidTrackIndex)
287         m_trackIndex = m_mediaElement->textTracks()->getTrackIndex(this);
288
289     return m_trackIndex;
290 }
291
292 void TextTrack::invalidateTrackIndex()
293 {
294     m_trackIndex = invalidTrackIndex;
295 }
296
297 TextTrackCueList* TextTrack::ensureTextTrackCueList()
298 {
299     if (!m_cues)
300         m_cues = TextTrackCueList::create();
301
302     return m_cues.get();
303 }
304
305 } // namespace WebCore
306
307 #endif