[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / Modules / mediacontrols / MediaControlsHost.cpp
1 /*
2  * Copyright (C) 2013, 2014 Apple 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 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 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(MEDIA_CONTROLS_SCRIPT)
29
30 #include "MediaControlsHost.h"
31
32 #include "CaptionUserPreferences.h"
33 #include "Element.h"
34 #include "HTMLMediaElement.h"
35 #include "Logging.h"
36 #include "MediaControlElements.h"
37 #include "Page.h"
38 #include "PageGroup.h"
39 #include "RenderTheme.h"
40 #include "TextTrack.h"
41 #include "TextTrackList.h"
42 #include "UUID.h"
43 #include <runtime/JSCJSValueInlines.h>
44
45 namespace WebCore {
46
47 const AtomicString& MediaControlsHost::automaticKeyword()
48 {
49     static NeverDestroyed<const AtomicString> automatic("automatic", AtomicString::ConstructFromLiteral);
50     return automatic;
51 }
52
53 const AtomicString& MediaControlsHost::forcedOnlyKeyword()
54 {
55     static NeverDestroyed<const AtomicString> forcedOn("forced-only", AtomicString::ConstructFromLiteral);
56     return forcedOn;
57 }
58
59 const AtomicString& MediaControlsHost::alwaysOnKeyword()
60 {
61     static NeverDestroyed<const AtomicString> alwaysOn("always-on", AtomicString::ConstructFromLiteral);
62     return alwaysOn;
63 }
64
65 const AtomicString& MediaControlsHost::manualKeyword()
66 {
67     static NeverDestroyed<const AtomicString> alwaysOn("manual", AtomicString::ConstructFromLiteral);
68     return alwaysOn;
69 }
70
71
72 Ref<MediaControlsHost> MediaControlsHost::create(HTMLMediaElement* mediaElement)
73 {
74     return adoptRef(*new MediaControlsHost(mediaElement));
75 }
76
77 MediaControlsHost::MediaControlsHost(HTMLMediaElement* mediaElement)
78     : m_mediaElement(mediaElement)
79 {
80     ASSERT(mediaElement);
81 }
82
83 MediaControlsHost::~MediaControlsHost()
84 {
85 }
86
87 Vector<RefPtr<TextTrack>> MediaControlsHost::sortedTrackListForMenu(TextTrackList& trackList)
88 {
89     Page* page = m_mediaElement->document().page();
90     if (!page)
91         return { };
92
93     return page->group().captionPreferences().sortedTrackListForMenu(&trackList);
94 }
95
96 Vector<RefPtr<AudioTrack>> MediaControlsHost::sortedTrackListForMenu(AudioTrackList& trackList)
97 {
98     Page* page = m_mediaElement->document().page();
99     if (!page)
100         return { };
101
102     return page->group().captionPreferences().sortedTrackListForMenu(&trackList);
103 }
104
105 String MediaControlsHost::displayNameForTrack(const std::optional<TextOrAudioTrack>& track)
106 {
107     if (!track)
108         return emptyString();
109
110     Page* page = m_mediaElement->document().page();
111     if (!page)
112         return emptyString();
113
114     return WTF::visit([&page](auto& track) {
115         return page->group().captionPreferences().displayNameForTrack(track.get());
116     }, track.value());
117 }
118
119 TextTrack* MediaControlsHost::captionMenuOffItem()
120 {
121     return TextTrack::captionMenuOffItem();
122 }
123
124 TextTrack* MediaControlsHost::captionMenuAutomaticItem()
125 {
126     return TextTrack::captionMenuAutomaticItem();
127 }
128
129 AtomicString MediaControlsHost::captionDisplayMode()
130 {
131     Page* page = m_mediaElement->document().page();
132     if (!page)
133         return emptyAtom;
134
135     switch (page->group().captionPreferences().captionDisplayMode()) {
136     case CaptionUserPreferences::Automatic:
137         return automaticKeyword();
138     case CaptionUserPreferences::ForcedOnly:
139         return forcedOnlyKeyword();
140     case CaptionUserPreferences::AlwaysOn:
141         return alwaysOnKeyword();
142     case CaptionUserPreferences::Manual:
143         return manualKeyword();
144     default:
145         ASSERT_NOT_REACHED();
146         return emptyAtom;
147     }
148 }
149
150 void MediaControlsHost::setSelectedTextTrack(TextTrack* track)
151 {
152     m_mediaElement->setSelectedTextTrack(track);
153 }
154
155 Element* MediaControlsHost::textTrackContainer()
156 {
157     if (!m_textTrackContainer) {
158         m_textTrackContainer = MediaControlTextTrackContainerElement::create(m_mediaElement->document());
159         m_textTrackContainer->setMediaController(m_mediaElement);
160     }
161     return m_textTrackContainer.get();
162 }
163
164 void MediaControlsHost::updateTextTrackContainer()
165 {
166     if (m_textTrackContainer)
167         m_textTrackContainer->updateDisplay();
168 }
169
170 void MediaControlsHost::enteredFullscreen()
171 {
172     if (m_textTrackContainer)
173         m_textTrackContainer->enteredFullscreen();
174 }
175
176 void MediaControlsHost::exitedFullscreen()
177 {
178     if (m_textTrackContainer)
179         m_textTrackContainer->exitedFullscreen();
180 }
181
182 void MediaControlsHost::updateCaptionDisplaySizes()
183 {
184     if (m_textTrackContainer)
185         m_textTrackContainer->updateSizes(true);
186 }
187     
188 bool MediaControlsHost::allowsInlineMediaPlayback() const
189 {
190     return !m_mediaElement->mediaSession().requiresFullscreenForVideoPlayback(*m_mediaElement);
191 }
192
193 bool MediaControlsHost::supportsFullscreen()
194 {
195     return m_mediaElement->supportsFullscreen(HTMLMediaElementEnums::VideoFullscreenModeStandard);
196 }
197
198 bool MediaControlsHost::isVideoLayerInline()
199 {
200     return m_mediaElement->isVideoLayerInline();
201 }
202
203 void MediaControlsHost::setPreparedToReturnVideoLayerToInline(bool value)
204 {
205     m_mediaElement->setPreparedToReturnVideoLayerToInline(value);
206 }
207
208 bool MediaControlsHost::userGestureRequired() const
209 {
210     return !m_mediaElement->mediaSession().playbackPermitted(*m_mediaElement);
211 }
212
213 String MediaControlsHost::externalDeviceDisplayName() const
214 {
215 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
216     MediaPlayer* player = m_mediaElement->player();
217     if (!player) {
218         LOG(Media, "MediaControlsHost::externalDeviceDisplayName - returning \"\" because player is NULL");
219         return emptyString();
220     }
221     
222     String name = player->wirelessPlaybackTargetName();
223     LOG(Media, "MediaControlsHost::externalDeviceDisplayName - returning \"%s\"", name.utf8().data());
224     
225     return name;
226 #else
227     return emptyString();
228 #endif
229 }
230
231 auto MediaControlsHost::externalDeviceType() const -> DeviceType
232 {
233 #if !ENABLE(WIRELESS_PLAYBACK_TARGET)
234     return DeviceType::None;
235 #else
236     MediaPlayer* player = m_mediaElement->player();
237     if (!player) {
238         LOG(Media, "MediaControlsHost::externalDeviceType - returning \"none\" because player is NULL");
239         return DeviceType::None;
240     }
241     
242     switch (player->wirelessPlaybackTargetType()) {
243     case MediaPlayer::TargetTypeNone:
244         return DeviceType::None;
245     case MediaPlayer::TargetTypeAirPlay:
246         return DeviceType::Airplay;
247     case MediaPlayer::TargetTypeTVOut:
248         return DeviceType::Tvout;
249     }
250
251     ASSERT_NOT_REACHED();
252     return DeviceType::None;
253 #endif
254 }
255
256 bool MediaControlsHost::controlsDependOnPageScaleFactor() const
257 {
258     return m_mediaElement->mediaControlsDependOnPageScaleFactor();
259 }
260
261 void MediaControlsHost::setControlsDependOnPageScaleFactor(bool value)
262 {
263     m_mediaElement->setMediaControlsDependOnPageScaleFactor(value);
264 }
265
266 String MediaControlsHost::generateUUID() const
267 {
268     return createCanonicalUUIDString();
269 }
270
271 String MediaControlsHost::shadowRootCSSText() const
272 {
273     Page* page = m_mediaElement->document().page();
274     if (!page)
275         return emptyString();
276     return RenderTheme::themeForPage(page)->mediaControlsStyleSheet();
277 }
278
279 String MediaControlsHost::base64StringForIconAndPlatform(const String& iconName, const String& platform) const
280 {
281     Page* page = m_mediaElement->document().page();
282     if (!page)
283         return emptyString();
284     return RenderTheme::themeForPage(page)->mediaControlsBase64StringForIconAndPlatform(iconName, platform);
285 }
286
287 }
288
289 #endif