Add interfaces and stubs for audio and video tracks
[WebKit-https.git] / Source / WebCore / html / track / LoadableTextTrack.cpp
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27
28 #if ENABLE(VIDEO_TRACK)
29
30 #include "LoadableTextTrack.h"
31
32 #include "Event.h"
33 #include "HTMLTrackElement.h"
34 #include "ScriptEventListener.h"
35 #include "ScriptExecutionContext.h"
36 #include "TextTrackCueList.h"
37 #include "TextTrackRegionList.h"
38
39 namespace WebCore {
40
41 LoadableTextTrack::LoadableTextTrack(HTMLTrackElement* track, const String& kind, const String& label, const String& language)
42     : TextTrack(track->document(), track, kind, label, language, TrackElement)
43     , m_trackElement(track)
44     , m_loadTimer(this, &LoadableTextTrack::loadTimerFired)
45     , m_isDefault(false)
46 {
47 }
48
49 LoadableTextTrack::~LoadableTextTrack()
50 {
51 }
52
53 void LoadableTextTrack::clearClient()
54 {
55     m_trackElement = 0;
56     TextTrack::clearClient();
57 }
58
59 void LoadableTextTrack::scheduleLoad(const KURL& url)
60 {
61     if (url == m_url)
62         return;
63
64     // 4.8.10.12.3 Sourcing out-of-band text tracks (continued)
65
66     // 2. Let URL be the track URL of the track element.
67     m_url = url;
68     
69     // 3. Asynchronously run the remaining steps, while continuing with whatever task 
70     // was responsible for creating the text track or changing the text track mode.
71     if (!m_loadTimer.isActive())
72         m_loadTimer.startOneShot(0);
73 }
74
75 Element* LoadableTextTrack::element()
76 {
77     return m_trackElement;
78 }
79
80 void LoadableTextTrack::loadTimerFired(Timer<LoadableTextTrack>*)
81 {
82     if (m_loader)
83         m_loader->cancelLoad();
84
85     if (!m_trackElement)
86         return;
87
88     // 4.8.10.12.3 Sourcing out-of-band text tracks (continued)
89
90     // 4. Download: If URL is not the empty string, perform a potentially CORS-enabled fetch of URL, with the
91     // mode being the state of the media element's crossorigin content attribute, the origin being the
92     // origin of the media element's Document, and the default origin behaviour set to fail.
93     m_loader = TextTrackLoader::create(this, static_cast<ScriptExecutionContext*>(m_trackElement->document()));
94     if (!m_loader->load(m_url, m_trackElement->mediaElementCrossOriginAttribute()))
95         m_trackElement->didCompleteLoad(this, HTMLTrackElement::Failure);
96 }
97
98 void LoadableTextTrack::newCuesAvailable(TextTrackLoader* loader)
99 {
100     ASSERT_UNUSED(loader, m_loader == loader);
101
102     Vector<RefPtr<TextTrackCue> > newCues;
103     m_loader->getNewCues(newCues);
104
105     if (!m_cues)
106         m_cues = TextTrackCueList::create();    
107
108     for (size_t i = 0; i < newCues.size(); ++i) {
109         newCues[i]->setTrack(this);
110         m_cues->add(newCues[i]);
111     }
112
113     if (client())
114         client()->textTrackAddCues(this, m_cues.get());
115 }
116
117 void LoadableTextTrack::cueLoadingStarted(TextTrackLoader* loader)
118 {
119     ASSERT_UNUSED(loader, m_loader == loader);
120 }
121
122 void LoadableTextTrack::cueLoadingCompleted(TextTrackLoader* loader, bool loadingFailed)
123 {
124     ASSERT_UNUSED(loader, m_loader == loader);
125
126     if (!m_trackElement)
127         return;
128
129     m_trackElement->didCompleteLoad(this, loadingFailed ? HTMLTrackElement::Failure : HTMLTrackElement::Success);
130 }
131
132 #if ENABLE(WEBVTT_REGIONS)
133 void LoadableTextTrack::newRegionsAvailable(TextTrackLoader* loader)
134 {
135     ASSERT_UNUSED(loader, m_loader == loader);
136
137     Vector<RefPtr<TextTrackRegion> > newRegions;
138     m_loader->getNewRegions(newRegions);
139
140     for (size_t i = 0; i < newRegions.size(); ++i) {
141         newRegions[i]->setTrack(this);
142         regionList()->add(newRegions[i]);
143     }
144 }
145 #endif
146
147 size_t LoadableTextTrack::trackElementIndex()
148 {
149     ASSERT(m_trackElement);
150     ASSERT(m_trackElement->parentNode());
151
152     size_t index = 0;
153     for (Node* node = m_trackElement->parentNode()->firstChild(); node; node = node->nextSibling()) {
154         if (!node->hasTagName(trackTag) || !node->parentNode())
155             continue;
156         if (node == m_trackElement)
157             return index;
158         ++index;
159     }
160     ASSERT_NOT_REACHED();
161
162     return 0;
163 }
164
165 } // namespace WebCore
166
167 #endif