974e497877573d2e97e7f4d3d6cb4d8c69d07ea1
[WebKit-https.git] / Source / WebCore / html / track / VideoTrack.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 "VideoTrack.h"
37
38 #include "Event.h"
39 #include "HTMLMediaElement.h"
40 #include "VideoTrackList.h"
41
42 #if ENABLE(MEDIA_SOURCE)
43 #include "SourceBuffer.h"
44 #endif
45
46 namespace WebCore {
47
48 const AtomicString& VideoTrack::alternativeKeyword()
49 {
50     DEPRECATED_DEFINE_STATIC_LOCAL(const AtomicString, alternative, ("alternative", AtomicString::ConstructFromLiteral));
51     return alternative;
52 }
53
54 const AtomicString& VideoTrack::captionsKeyword()
55 {
56     DEPRECATED_DEFINE_STATIC_LOCAL(const AtomicString, captions, ("captions", AtomicString::ConstructFromLiteral));
57     return captions;
58 }
59
60 const AtomicString& VideoTrack::mainKeyword()
61 {
62     DEPRECATED_DEFINE_STATIC_LOCAL(const AtomicString, captions, ("main", AtomicString::ConstructFromLiteral));
63     return captions;
64 }
65
66 const AtomicString& VideoTrack::signKeyword()
67 {
68     DEPRECATED_DEFINE_STATIC_LOCAL(const AtomicString, sign, ("sign", AtomicString::ConstructFromLiteral));
69     return sign;
70 }
71
72 const AtomicString& VideoTrack::subtitlesKeyword()
73 {
74     DEPRECATED_DEFINE_STATIC_LOCAL(const AtomicString, subtitles, ("subtitles", AtomicString::ConstructFromLiteral));
75     return subtitles;
76 }
77
78 const AtomicString& VideoTrack::commentaryKeyword()
79 {
80     DEPRECATED_DEFINE_STATIC_LOCAL(const AtomicString, commentary, ("commentary", AtomicString::ConstructFromLiteral));
81     return commentary;
82 }
83
84 VideoTrack::VideoTrack(VideoTrackClient* client, PassRefPtr<VideoTrackPrivate> trackPrivate)
85     : TrackBase(TrackBase::VideoTrack, trackPrivate->id(), trackPrivate->label(), trackPrivate->language())
86     , m_selected(trackPrivate->selected())
87     , m_client(client)
88     , m_private(trackPrivate)
89 {
90     m_private->setClient(this);
91     updateKindFromPrivate();
92 }
93
94 VideoTrack::~VideoTrack()
95 {
96     m_private->setClient(0);
97 }
98
99 void VideoTrack::setPrivate(PassRefPtr<VideoTrackPrivate> trackPrivate)
100 {
101     ASSERT(m_private);
102     ASSERT(trackPrivate);
103
104     if (m_private == trackPrivate)
105         return;
106
107     m_private->setClient(nullptr);
108     m_private = trackPrivate;
109     m_private->setClient(this);
110
111     m_private->setSelected(m_selected);
112     updateKindFromPrivate();
113 }
114
115 bool VideoTrack::isValidKind(const AtomicString& value) const
116 {
117     if (value == alternativeKeyword())
118         return true;
119     if (value == captionsKeyword())
120         return true;
121     if (value == mainKeyword())
122         return true;
123     if (value == signKeyword())
124         return true;
125     if (value == subtitlesKeyword())
126         return true;
127     if (value == commentaryKeyword())
128         return true;
129
130     return false;
131 }
132
133 void VideoTrack::setSelected(const bool selected)
134 {
135     if (m_selected == selected)
136         return;
137
138     m_selected = selected;
139     m_private->setSelected(selected);
140
141     if (m_client)
142         m_client->videoTrackSelectedChanged(this);
143 }
144
145 size_t VideoTrack::inbandTrackIndex()
146 {
147     ASSERT(m_private);
148     return m_private->trackIndex();
149 }
150
151 void VideoTrack::selectedChanged(VideoTrackPrivate* trackPrivate, bool selected)
152 {
153     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
154     setSelected(selected);
155 }
156
157 void VideoTrack::idChanged(TrackPrivateBase* trackPrivate, const AtomicString& id)
158 {
159     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
160     setId(id);
161 }
162
163 void VideoTrack::labelChanged(TrackPrivateBase* trackPrivate, const AtomicString& label)
164 {
165     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
166     setLabel(label);
167 }
168
169 void VideoTrack::languageChanged(TrackPrivateBase* trackPrivate, const AtomicString& language)
170 {
171     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
172     setLanguage(language);
173 }
174
175 void VideoTrack::willRemove(TrackPrivateBase* trackPrivate)
176 {
177     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
178     mediaElement()->removeVideoTrack(this);
179 }
180
181 #if ENABLE(MEDIA_SOURCE)
182 void VideoTrack::setKind(const AtomicString& kind)
183 {
184     // 10.1 kind, on setting:
185     // 1. If the value being assigned to this attribute does not match one of the video track kinds,
186     // then abort these steps.
187     if (!isValidKind(kind))
188         return;
189
190     // 2. Update this attribute to the new value.
191     setKindInternal(kind);
192
193     // 3. If the sourceBuffer attribute on this track is not null, then queue a task to fire a simple
194     // event named change at sourceBuffer.videoTracks.
195     if (m_sourceBuffer)
196         m_sourceBuffer->videoTracks()->scheduleChangeEvent();
197
198     // 4. Queue a task to fire a simple event named change at the VideoTrackList object referenced by
199     // the videoTracks attribute on the HTMLMediaElement.
200     mediaElement()->videoTracks()->scheduleChangeEvent();
201 }
202
203 void VideoTrack::setLanguage(const AtomicString& language)
204 {
205     // 10.1 language, on setting:
206     // 1. If the value being assigned to this attribute is not an empty string or a BCP 47 language
207     // tag[BCP47], then abort these steps.
208     // FIXME(123926): Validate the BCP47-ness of langague.
209
210     // 2. Update this attribute to the new value.
211     TrackBase::setLanguage(language);
212
213     // 3. If the sourceBuffer attribute on this track is not null, then queue a task to fire a simple
214     // event named change at sourceBuffer.videoTracks.
215     if (m_sourceBuffer)
216         m_sourceBuffer->videoTracks()->scheduleChangeEvent();
217
218     // 4. Queue a task to fire a simple event named change at the VideoTrackList object referenced by
219     // the videoTracks attribute on the HTMLMediaElement.
220     if (mediaElement()->videoTracks())
221         mediaElement()->videoTracks()->scheduleChangeEvent();
222 }
223 #endif
224
225 void VideoTrack::updateKindFromPrivate()
226 {
227     switch (m_private->kind()) {
228     case VideoTrackPrivate::Alternative:
229         setKindInternal(VideoTrack::alternativeKeyword());
230         break;
231     case VideoTrackPrivate::Captions:
232         setKindInternal(VideoTrack::captionsKeyword());
233         break;
234     case VideoTrackPrivate::Main:
235         setKindInternal(VideoTrack::mainKeyword());
236         break;
237     case VideoTrackPrivate::Sign:
238         setKindInternal(VideoTrack::signKeyword());
239         break;
240     case VideoTrackPrivate::Subtitles:
241         setKindInternal(VideoTrack::subtitlesKeyword());
242         break;
243     case VideoTrackPrivate::Commentary:
244         setKindInternal(VideoTrack::commentaryKeyword());
245         break;
246     case VideoTrackPrivate::None:
247         setKindInternal(emptyString());
248         break;
249     default:
250         ASSERT_NOT_REACHED();
251         break;
252     }
253 }
254
255 } // namespace WebCore
256
257 #endif