[Mac] Update AirPlay handling
[WebKit-https.git] / Source / WebCore / platform / audio / MediaSessionManager.cpp
1 /*
2  * Copyright (C) 2013-2015 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "MediaSessionManager.h"
28
29 #if ENABLE(VIDEO)
30
31 #include "Logging.h"
32 #include "NotImplemented.h"
33 #include "MediaSession.h"
34
35 namespace WebCore {
36
37 #if !PLATFORM(IOS)
38 MediaSessionManager& MediaSessionManager::sharedManager()
39 {
40     DEPRECATED_DEFINE_STATIC_LOCAL(MediaSessionManager, manager, ());
41     return manager;
42 }
43 #endif
44
45 MediaSessionManager::MediaSessionManager()
46     : m_systemSleepListener(SystemSleepListener::create(*this))
47     , m_interrupted(false)
48 {
49     resetRestrictions();
50 }
51
52 void MediaSessionManager::resetRestrictions()
53 {
54     m_restrictions[MediaSession::Video] = NoRestrictions;
55     m_restrictions[MediaSession::Audio] = NoRestrictions;
56     m_restrictions[MediaSession::WebAudio] = NoRestrictions;
57 }
58
59 bool MediaSessionManager::has(MediaSession::MediaType type) const
60 {
61     ASSERT(type >= MediaSession::None && type <= MediaSession::WebAudio);
62
63     for (auto* session : m_sessions) {
64         if (session->mediaType() == type)
65             return true;
66     }
67
68     return false;
69 }
70
71 bool MediaSessionManager::activeAudioSessionRequired() const
72 {
73     for (auto* session : m_sessions) {
74         if (session->mediaType() != MediaSession::None && session->state() == MediaSession::State::Playing)
75             return true;
76     }
77     
78     return false;
79 }
80
81 int MediaSessionManager::count(MediaSession::MediaType type) const
82 {
83     ASSERT(type >= MediaSession::None && type <= MediaSession::WebAudio);
84
85     int count = 0;
86     for (auto* session : m_sessions) {
87         if (session->mediaType() == type)
88             ++count;
89     }
90
91     return count;
92 }
93
94 void MediaSessionManager::beginInterruption(MediaSession::InterruptionType type)
95 {
96     LOG(Media, "MediaSessionManager::beginInterruption");
97
98     m_interrupted = true;
99     Vector<MediaSession*> sessions = m_sessions;
100     for (auto* session : sessions)
101         session->beginInterruption(type);
102     updateSessionState();
103 }
104
105 void MediaSessionManager::endInterruption(MediaSession::EndInterruptionFlags flags)
106 {
107     LOG(Media, "MediaSessionManager::endInterruption");
108
109     m_interrupted = false;
110     Vector<MediaSession*> sessions = m_sessions;
111     for (auto* session : sessions)
112         session->endInterruption(flags);
113 }
114
115 void MediaSessionManager::addSession(MediaSession& session)
116 {
117     LOG(Media, "MediaSessionManager::addSession - %p", &session);
118     
119     m_sessions.append(&session);
120     if (m_interrupted)
121         session.setState(MediaSession::Interrupted);
122
123     if (!m_remoteCommandListener)
124         m_remoteCommandListener = RemoteCommandListener::create(*this);
125
126     if (!m_audioHardwareListener)
127         m_audioHardwareListener = AudioHardwareListener::create(*this);
128
129     updateSessionState();
130 }
131
132 void MediaSessionManager::removeSession(MediaSession& session)
133 {
134     LOG(Media, "MediaSessionManager::removeSession - %p", &session);
135     
136     size_t index = m_sessions.find(&session);
137     ASSERT(index != notFound);
138     if (index == notFound)
139         return;
140     
141     m_sessions.remove(index);
142
143     if (m_sessions.isEmpty()) {
144         m_remoteCommandListener = nullptr;
145         m_audioHardwareListener = nullptr;
146     }
147
148     updateSessionState();
149 }
150
151 void MediaSessionManager::addRestriction(MediaSession::MediaType type, SessionRestrictions restriction)
152 {
153     ASSERT(type > MediaSession::None && type <= MediaSession::WebAudio);
154     m_restrictions[type] |= restriction;
155 }
156
157 void MediaSessionManager::removeRestriction(MediaSession::MediaType type, SessionRestrictions restriction)
158 {
159     ASSERT(type > MediaSession::None && type <= MediaSession::WebAudio);
160     m_restrictions[type] &= ~restriction;
161 }
162
163 MediaSessionManager::SessionRestrictions MediaSessionManager::restrictions(MediaSession::MediaType type)
164 {
165     ASSERT(type > MediaSession::None && type <= MediaSession::WebAudio);
166     return m_restrictions[type];
167 }
168
169 void MediaSessionManager::sessionWillBeginPlayback(MediaSession& session)
170 {
171     LOG(Media, "MediaSessionManager::sessionWillBeginPlayback - %p", &session);
172     
173     setCurrentSession(session);
174
175     MediaSession::MediaType sessionType = session.mediaType();
176     SessionRestrictions restrictions = m_restrictions[sessionType];
177     if (!restrictions & ConcurrentPlaybackNotPermitted)
178         return;
179
180     Vector<MediaSession*> sessions = m_sessions;
181     for (auto* oneSession : sessions) {
182         if (oneSession == &session)
183             continue;
184         if (oneSession->mediaType() != sessionType)
185             continue;
186         if (restrictions & ConcurrentPlaybackNotPermitted)
187             oneSession->pauseSession();
188     }
189     
190     updateSessionState();
191 }
192     
193 void MediaSessionManager::sessionWillEndPlayback(MediaSession& session)
194 {
195     LOG(Media, "MediaSessionManager::sessionWillEndPlayback - %p", &session);
196     
197     if (m_sessions.size() < 2)
198         return;
199     
200     size_t pausingSessionIndex = notFound;
201     size_t lastPlayingSessionIndex = notFound;
202     for (size_t i = 0; i < m_sessions.size(); ++i) {
203         MediaSession* oneSession = m_sessions[i];
204         
205         if (oneSession == &session) {
206             pausingSessionIndex = i;
207             continue;
208         }
209         if (oneSession->state() == MediaSession::Playing) {
210             lastPlayingSessionIndex = i;
211             continue;
212         }
213         if (oneSession->state() != MediaSession::Playing)
214             break;
215     }
216     if (lastPlayingSessionIndex == notFound || pausingSessionIndex == notFound)
217         return;
218     
219     if (pausingSessionIndex > lastPlayingSessionIndex)
220         return;
221     
222     m_sessions.remove(pausingSessionIndex);
223     m_sessions.insert(lastPlayingSessionIndex, &session);
224     
225     LOG(Media, "MediaSessionManager::sessionWillEndPlayback - session moved from index %zu to %zu", pausingSessionIndex, lastPlayingSessionIndex);
226 }
227
228 void MediaSessionManager::setCurrentSession(MediaSession& session)
229 {
230     LOG(Media, "MediaSessionManager::setCurrentSession - %p", &session);
231     
232     if (m_sessions.size() < 2)
233         return;
234     
235     size_t index = m_sessions.find(&session);
236     ASSERT(index != notFound);
237     if (!index || index == notFound)
238         return;
239
240     m_sessions.remove(index);
241     m_sessions.insert(0, &session);
242     
243     LOG(Media, "MediaSessionManager::setCurrentSession - session moved from index %zu to 0", index);
244 }
245     
246 MediaSession* MediaSessionManager::currentSession()
247 {
248     if (!m_sessions.size())
249         return nullptr;
250
251     return m_sessions[0];
252 }
253     
254 bool MediaSessionManager::sessionRestrictsInlineVideoPlayback(const MediaSession& session) const
255 {
256     MediaSession::MediaType sessionType = session.presentationType();
257     if (sessionType != MediaSession::Video)
258         return false;
259
260     return m_restrictions[sessionType] & InlineVideoPlaybackRestricted;
261 }
262
263 bool MediaSessionManager::sessionCanLoadMedia(const MediaSession& session) const
264 {
265     return session.state() == MediaSession::Playing || !session.isHidden();
266 }
267
268 void MediaSessionManager::applicationWillEnterBackground() const
269 {
270     LOG(Media, "MediaSessionManager::applicationWillEnterBackground");
271     Vector<MediaSession*> sessions = m_sessions;
272     for (auto* session : sessions) {
273         if (m_restrictions[session->mediaType()] & BackgroundProcessPlaybackRestricted)
274             session->beginInterruption(MediaSession::EnteringBackground);
275     }
276 }
277
278 void MediaSessionManager::applicationWillEnterForeground() const
279 {
280     LOG(Media, "MediaSessionManager::applicationWillEnterForeground");
281     Vector<MediaSession*> sessions = m_sessions;
282     for (auto* session : sessions) {
283         if (m_restrictions[session->mediaType()] & BackgroundProcessPlaybackRestricted)
284             session->endInterruption(MediaSession::MayResumePlaying);
285     }
286 }
287
288 #if !PLATFORM(COCOA)
289 void MediaSessionManager::updateSessionState()
290 {
291 }
292 #endif
293
294 void MediaSessionManager::didReceiveRemoteControlCommand(MediaSession::RemoteControlCommandType command)
295 {
296     MediaSession* activeSession = currentSession();
297     if (!activeSession || !activeSession->canReceiveRemoteControlCommands())
298         return;
299     activeSession->didReceiveRemoteControlCommand(command);
300 }
301
302 void MediaSessionManager::systemWillSleep()
303 {
304     if (m_interrupted)
305         return;
306
307     for (auto session : m_sessions)
308         session->beginInterruption(MediaSession::SystemSleep);
309 }
310
311 void MediaSessionManager::systemDidWake()
312 {
313     if (m_interrupted)
314         return;
315
316     for (auto session : m_sessions)
317         session->endInterruption(MediaSession::MayResumePlaying);
318 }
319
320 void MediaSessionManager::audioOutputDeviceChanged()
321 {
322     updateSessionState();
323 }
324
325 }
326
327 #endif