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