Allow ports specific text track menu
[WebKit-https.git] / Source / WebCore / html / track / TextTrack.cpp
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  * Copyright (C) 2011, 2012, 2013 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_hasBeenConfigured(false)
110 {
111     setKind(kind);
112 }
113
114 TextTrack::~TextTrack()
115 {
116     if (m_cues) {
117         if (m_client)
118             m_client->textTrackRemoveCues(this, m_cues.get());
119
120         for (size_t i = 0; i < m_cues->length(); ++i)
121             m_cues->item(i)->setTrack(0);
122     }
123     clearClient();
124 }
125
126 bool TextTrack::isValidKindKeyword(const AtomicString& value)
127 {
128     if (value == subtitlesKeyword())
129         return true;
130     if (value == captionsKeyword())
131         return true;
132     if (value == descriptionsKeyword())
133         return true;
134     if (value == chaptersKeyword())
135         return true;
136     if (value == metadataKeyword())
137         return true;
138
139     return false;
140 }
141
142 void TextTrack::setKind(const AtomicString& kind)
143 {
144     String oldKind = m_kind;
145
146     if (isValidKindKeyword(kind))
147         m_kind = kind;
148     else
149         m_kind = subtitlesKeyword();
150
151     if (m_client && oldKind != m_kind)
152         m_client->textTrackKindChanged(this);
153 }
154
155 void TextTrack::setMode(const AtomicString& mode)
156 {
157     // On setting, if the new value isn't equal to what the attribute would currently
158     // return, the new value must be processed as follows ...
159     if (mode != disabledKeyword() && mode != hiddenKeyword() && mode != showingKeyword())
160         return;
161
162     if (m_mode == mode)
163         return;
164
165     // If mode changes to disabled, remove this track's cues from the client
166     // because they will no longer be accessible from the cues() function.
167     if (mode == disabledKeyword() && m_client && m_cues)
168         m_client->textTrackRemoveCues(this, m_cues.get());
169          
170     if (mode != showingKeyword() && m_cues)
171         for (size_t i = 0; i < m_cues->length(); ++i)
172             m_cues->item(i)->removeDisplayTree();
173
174     m_mode = mode;
175
176     if (m_client)
177         m_client->textTrackModeChanged(this);
178 }
179
180 TextTrackCueList* TextTrack::cues()
181 {
182     // 4.8.10.12.5 If the text track mode ... is not the text track disabled mode,
183     // then the cues attribute must return a live TextTrackCueList object ...
184     // Otherwise, it must return null. When an object is returned, the
185     // same object must be returned each time.
186     // http://www.whatwg.org/specs/web-apps/current-work/#dom-texttrack-cues
187     if (m_mode != disabledKeyword())
188         return ensureTextTrackCueList();
189     return 0;
190 }
191
192 void TextTrack::removeAllCues()
193 {
194     if (!m_cues)
195         return;
196
197     if (m_client)
198         m_client->textTrackRemoveCues(this, m_cues.get());
199     
200     for (size_t i = 0; i < m_cues->length(); ++i)
201         m_cues->item(i)->setTrack(0);
202     
203     m_cues = 0;
204 }
205
206 TextTrackCueList* TextTrack::activeCues() const
207 {
208     // 4.8.10.12.5 If the text track mode ... is not the text track disabled mode,
209     // then the activeCues attribute must return a live TextTrackCueList object ...
210     // ... whose active flag was set when the script started, in text track cue
211     // order. Otherwise, it must return null. When an object is returned, the
212     // same object must be returned each time.
213     // http://www.whatwg.org/specs/web-apps/current-work/#dom-texttrack-activecues
214     if (m_cues && m_mode != disabledKeyword())
215         return m_cues->activeCues();
216     return 0;
217 }
218
219 void TextTrack::addCue(PassRefPtr<TextTrackCue> prpCue)
220 {
221     if (!prpCue)
222         return;
223
224     RefPtr<TextTrackCue> cue = prpCue;
225
226     // TODO(93143): Add spec-compliant behavior for negative time values.
227     if (std::isnan(cue->startTime()) || std::isnan(cue->endTime()) || cue->startTime() < 0 || cue->endTime() < 0)
228         return;
229
230     // 4.8.10.12.5 Text track API
231
232     // The addCue(cue) method of TextTrack objects, when invoked, must run the following steps:
233
234     // 1. If the given cue is in a text track list of cues, then remove cue from that text track
235     // list of cues.
236     TextTrack* cueTrack = cue->track();
237     if (cueTrack && cueTrack != this)
238         cueTrack->removeCue(cue.get(), ASSERT_NO_EXCEPTION);
239
240     // 2. Add cue to the method's TextTrack object's text track's text track list of cues.
241     cue->setTrack(this);
242     ensureTextTrackCueList()->add(cue);
243     
244     if (m_client)
245         m_client->textTrackAddCue(this, cue.get());
246 }
247
248 void TextTrack::removeCue(TextTrackCue* cue, ExceptionCode& ec)
249 {
250     if (!cue)
251         return;
252
253     // 4.8.10.12.5 Text track API
254
255     // The removeCue(cue) method of TextTrack objects, when invoked, must run the following steps:
256
257     // 1. If the given cue is not currently listed in the method's TextTrack 
258     // object's text track's text track list of cues, then throw a NotFoundError exception.
259     if (cue->track() != this) {
260         ec = NOT_FOUND_ERR;
261         return;
262     }
263
264     // 2. Remove cue from the method's TextTrack object's text track's text track list of cues.
265     if (!m_cues || !m_cues->remove(cue)) {
266         ec = INVALID_STATE_ERR;
267         return;
268     }
269
270     cue->setTrack(0);
271     if (m_client)
272         m_client->textTrackRemoveCue(this, cue);
273 }
274
275 void TextTrack::cueWillChange(TextTrackCue* cue)
276 {
277     if (!m_client)
278         return;
279
280     // The cue may need to be repositioned in the media element's interval tree, may need to
281     // be re-rendered, etc, so remove it before the modification...
282     m_client->textTrackRemoveCue(this, cue);
283 }
284
285 void TextTrack::cueDidChange(TextTrackCue* cue)
286 {
287     if (!m_client)
288         return;
289
290     // Make sure the TextTrackCueList order is up-to-date.
291     ensureTextTrackCueList()->updateCueIndex(cue);
292
293     // ... and add it back again.
294     m_client->textTrackAddCue(this, cue);
295 }
296
297 int TextTrack::trackIndex()
298 {
299     ASSERT(m_mediaElement);
300
301     if (m_trackIndex == invalidTrackIndex)
302         m_trackIndex = m_mediaElement->textTracks()->getTrackIndex(this);
303
304     return m_trackIndex;
305 }
306
307 void TextTrack::invalidateTrackIndex()
308 {
309     m_trackIndex = invalidTrackIndex;
310     m_renderedTrackIndex = invalidTrackIndex;
311 }
312
313 bool TextTrack::isRendered()
314 {
315     if (m_kind != captionsKeyword() && m_kind != subtitlesKeyword())
316         return false;
317
318     if (m_mode != showingKeyword())
319         return false;
320
321     return true;
322 }
323
324 TextTrackCueList* TextTrack::ensureTextTrackCueList()
325 {
326     if (!m_cues)
327         m_cues = TextTrackCueList::create();
328
329     return m_cues.get();
330 }
331
332 int TextTrack::trackIndexRelativeToRenderedTracks()
333 {
334     ASSERT(m_mediaElement);
335     
336     if (m_renderedTrackIndex == invalidTrackIndex)
337         m_renderedTrackIndex = m_mediaElement->textTracks()->getTrackIndexRelativeToRenderedTracks(this);
338     
339     return m_renderedTrackIndex;
340 }
341
342 bool TextTrack::hasCue(TextTrackCue* cue)
343 {
344     if (cue->startTime() < 0 || cue->endTime() < 0)
345         return false;
346     
347     if (!m_cues || !m_cues->length())
348         return false;
349     
350     size_t searchStart = 0;
351     size_t searchEnd = m_cues->length();
352     
353     while (1) {
354         ASSERT(searchStart <= m_cues->length());
355         ASSERT(searchEnd <= m_cues->length());
356         
357         TextTrackCue* existingCue;
358         
359         // Cues in the TextTrackCueList are maintained in start time order.
360         if (searchStart == searchEnd) {
361             if (!searchStart)
362                 return false;
363
364             // If there is more than one cue with the same start time, back up to first one so we
365             // consider all of them.
366             while (searchStart >= 2 && cue->startTime() == m_cues->item(searchStart - 2)->startTime())
367                 --searchStart;
368             
369             bool firstCompare = true;
370             while (1) {
371                 if (!firstCompare)
372                     ++searchStart;
373                 firstCompare = false;
374                 if (searchStart > m_cues->length())
375                     return false;
376
377                 existingCue = m_cues->item(searchStart - 1);
378                 if (!existingCue || cue->startTime() > existingCue->startTime())
379                     return false;
380
381                 if (*existingCue != *cue)
382                     continue;
383                 
384                 return true;
385             }
386         }
387         
388         size_t index = (searchStart + searchEnd) / 2;
389         existingCue = m_cues->item(index);
390         if (cue->startTime() < existingCue->startTime() || (cue->startTime() == existingCue->startTime() && cue->endTime() > existingCue->endTime()))
391             searchEnd = index;
392         else
393             searchStart = index + 1;
394     }
395     
396     ASSERT_NOT_REACHED();
397     return false;
398 }
399
400 #if USE(PLATFORM_TEXT_TRACK_MENU)
401 PassRefPtr<PlatformTextTrack> TextTrack::platformTextTrack()
402 {
403     if (m_platformTextTrack)
404         return m_platformTextTrack;
405
406     PlatformTextTrack::TrackKind kind = PlatformTextTrack::Caption;
407     if (m_kind == subtitlesKeyword())
408         kind = PlatformTextTrack::Subtitle;
409     else if (m_kind == captionsKeyword())
410         kind = PlatformTextTrack::Caption;
411     else if (m_kind == descriptionsKeyword())
412         kind = PlatformTextTrack::Description;
413     else if (m_kind == chaptersKeyword())
414         kind = PlatformTextTrack::Chapter;
415     else if (m_kind == metadataKeyword())
416         kind = PlatformTextTrack::MetaData;
417
418     PlatformTextTrack::TrackType type = PlatformTextTrack::OutOfBand;
419     if (m_trackType == TrackElement)
420         type = PlatformTextTrack::OutOfBand;
421     else if (m_trackType == AddTrack)
422         type = PlatformTextTrack::Script;
423     else if (m_trackType == InBand)
424         type = PlatformTextTrack::InBand;
425
426     m_platformTextTrack = PlatformTextTrack::create(this, m_label, m_language, kind, type);
427
428     return m_platformTextTrack;
429 }
430 #endif
431
432 bool TextTrack::isMainProgramContent() const
433 {
434     // "Main program" content is intrinsic to the presentation of the media file, regardless of locale. Content such as
435     // directors commentary is not "main program" because it is not essential for the presentation. HTML5 doesn't have
436     // a way to express this in a machine-reable form, it is typically done with the track label, so we assume that caption
437     // tracks are main content and all other track types are not.
438     return m_kind == captionsKeyword();
439 }
440
441 } // namespace WebCore
442
443 #endif