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