Unreviewed, rolling out r245890, 245887.
[WebKit-https.git] / Source / WebCore / platform / audio / PlatformMediaSessionManager.cpp
1 /*
2  * Copyright (C) 2013-2019 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 "PlatformMediaSessionManager.h"
28
29 #include "AudioSession.h"
30 #include "Document.h"
31 #include "Logging.h"
32 #include "PlatformMediaSession.h"
33
34 namespace WebCore {
35
36 #if ENABLE(VIDEO) || ENABLE(WEB_AUDIO)
37
38 #if !PLATFORM(COCOA)
39 static PlatformMediaSessionManager* platformMediaSessionManager = nullptr;
40
41 PlatformMediaSessionManager& PlatformMediaSessionManager::sharedManager()
42 {
43     if (!platformMediaSessionManager)
44         platformMediaSessionManager = new PlatformMediaSessionManager;
45     return *platformMediaSessionManager;
46 }
47
48 PlatformMediaSessionManager* PlatformMediaSessionManager::sharedManagerIfExists()
49 {
50     return platformMediaSessionManager;
51 }
52 #endif // !PLATFORM(COCOA)
53
54 void PlatformMediaSessionManager::updateNowPlayingInfoIfNecessary()
55 {
56     if (auto existingManager = PlatformMediaSessionManager::sharedManagerIfExists())
57         existingManager->scheduleUpdateNowPlayingInfo();
58 }
59
60 PlatformMediaSessionManager::PlatformMediaSessionManager()
61     : m_systemSleepListener(PAL::SystemSleepListener::create(*this))
62 #if !RELEASE_LOG_DISABLED
63     , m_logger(AggregateLogger::create(this))
64 #endif
65 {
66     resetRestrictions();
67 }
68
69 void PlatformMediaSessionManager::resetRestrictions()
70 {
71     m_restrictions[PlatformMediaSession::Video] = NoRestrictions;
72     m_restrictions[PlatformMediaSession::Audio] = NoRestrictions;
73     m_restrictions[PlatformMediaSession::VideoAudio] = NoRestrictions;
74     m_restrictions[PlatformMediaSession::WebAudio] = NoRestrictions;
75     m_restrictions[PlatformMediaSession::MediaStreamCapturingAudio] = NoRestrictions;
76 }
77
78 bool PlatformMediaSessionManager::has(PlatformMediaSession::MediaType type) const
79 {
80     ASSERT(type >= PlatformMediaSession::None && type <= PlatformMediaSession::MediaStreamCapturingAudio);
81
82     return anyOfSessions([type] (auto& session) {
83         return session.mediaType() == type;
84     });
85 }
86
87 bool PlatformMediaSessionManager::activeAudioSessionRequired() const
88 {
89     return anyOfSessions([] (auto& session) {
90         return session.activeAudioSessionRequired();
91     });
92 }
93
94 bool PlatformMediaSessionManager::canProduceAudio() const
95 {
96     return anyOfSessions([] (auto& session) {
97         return session.canProduceAudio();
98     });
99 }
100
101 int PlatformMediaSessionManager::count(PlatformMediaSession::MediaType type) const
102 {
103     ASSERT(type >= PlatformMediaSession::None && type <= PlatformMediaSession::MediaStreamCapturingAudio);
104
105     int count = 0;
106     for (const auto& session : m_sessions) {
107         if (session->mediaType() == type)
108             ++count;
109     }
110
111     return count;
112 }
113
114 void PlatformMediaSessionManager::beginInterruption(PlatformMediaSession::InterruptionType type)
115 {
116     ALWAYS_LOG(LOGIDENTIFIER);
117
118     m_interrupted = true;
119     forEachSession([type] (auto& session) {
120         session.beginInterruption(type);
121     });
122     updateSessionState();
123 }
124
125 void PlatformMediaSessionManager::endInterruption(PlatformMediaSession::EndInterruptionFlags flags)
126 {
127     ALWAYS_LOG(LOGIDENTIFIER);
128
129     m_interrupted = false;
130     forEachSession([flags] (auto& session) {
131         session.endInterruption(flags);
132     });
133 }
134
135 void PlatformMediaSessionManager::addSession(PlatformMediaSession& session)
136 {
137     ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier());
138     m_sessions.append(makeWeakPtr(session));
139     if (m_interrupted)
140         session.setState(PlatformMediaSession::Interrupted);
141
142     if (!m_remoteCommandListener)
143         m_remoteCommandListener = RemoteCommandListener::create(*this);
144
145     if (!m_audioHardwareListener)
146         m_audioHardwareListener = AudioHardwareListener::create(*this);
147
148 #if !RELEASE_LOG_DISABLED
149     m_logger->addLogger(session.logger());
150 #endif
151
152     updateSessionState();
153 }
154
155 void PlatformMediaSessionManager::removeSession(PlatformMediaSession& session)
156 {
157     ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier());
158
159     size_t index = m_sessions.find(&session);
160     if (index == notFound)
161         return;
162
163     m_sessions.remove(index);
164
165     if (m_sessions.isEmpty() || std::all_of(m_sessions.begin(), m_sessions.end(), std::logical_not<void>())) {
166         m_remoteCommandListener = nullptr;
167         m_audioHardwareListener = nullptr;
168 #if USE(AUDIO_SESSION)
169         if (m_becameActive && shouldDeactivateAudioSession()) {
170             AudioSession::sharedSession().tryToSetActive(false);
171             m_becameActive = false;
172         }
173 #endif
174     }
175
176 #if !RELEASE_LOG_DISABLED
177     m_logger->removeLogger(session.logger());
178 #endif
179
180     updateSessionState();
181 }
182
183 void PlatformMediaSessionManager::addRestriction(PlatformMediaSession::MediaType type, SessionRestrictions restriction)
184 {
185     ASSERT(type > PlatformMediaSession::None && type <= PlatformMediaSession::MediaStreamCapturingAudio);
186     m_restrictions[type] |= restriction;
187 }
188
189 void PlatformMediaSessionManager::removeRestriction(PlatformMediaSession::MediaType type, SessionRestrictions restriction)
190 {
191     ASSERT(type > PlatformMediaSession::None && type <= PlatformMediaSession::MediaStreamCapturingAudio);
192     m_restrictions[type] &= ~restriction;
193 }
194
195 PlatformMediaSessionManager::SessionRestrictions PlatformMediaSessionManager::restrictions(PlatformMediaSession::MediaType type)
196 {
197     ASSERT(type > PlatformMediaSession::None && type <= PlatformMediaSession::MediaStreamCapturingAudio);
198     return m_restrictions[type];
199 }
200
201 bool PlatformMediaSessionManager::sessionWillBeginPlayback(PlatformMediaSession& session)
202 {
203     setCurrentSession(session);
204
205     PlatformMediaSession::MediaType sessionType = session.mediaType();
206     SessionRestrictions restrictions = m_restrictions[sessionType];
207     if (session.state() == PlatformMediaSession::Interrupted && restrictions & InterruptedPlaybackNotPermitted) {
208         ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier(), " returning false because session.state() is Interrupted, and InterruptedPlaybackNotPermitted");
209         return false;
210     }
211
212     if (m_processIsSuspended) {
213         ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier(), " returning false because process is suspended");
214         return false;
215     }
216
217 #if USE(AUDIO_SESSION)
218     if (activeAudioSessionRequired()) {
219         if (!AudioSession::sharedSession().tryToSetActive(true)) {
220             ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier(), " returning false failed to set active AudioSession");
221             return false;
222         }
223
224         ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier(), " sucessfully activated AudioSession");
225         m_becameActive = true;
226     }
227 #endif
228
229     if (m_interrupted)
230         endInterruption(PlatformMediaSession::NoFlags);
231
232     if (restrictions & ConcurrentPlaybackNotPermitted) {
233         forEachMatchingSession([&session, sessionType](auto& oneSession) {
234             return &oneSession != &session
235                 && oneSession.mediaType() == sessionType
236                 && oneSession.state() == PlatformMediaSession::Playing
237                 && !oneSession.canPlayConcurrently(session);
238         }, [](auto& oneSession) {
239             oneSession.pauseSession();
240         });
241     }
242     ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier(), " returning true");
243     return true;
244 }
245     
246 void PlatformMediaSessionManager::sessionWillEndPlayback(PlatformMediaSession& session)
247 {
248     ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier());
249
250     if (m_sessions.size() < 2)
251         return;
252     
253     size_t pausingSessionIndex = notFound;
254     size_t lastPlayingSessionIndex = notFound;
255     for (size_t i = 0, size = m_sessions.size(); i < size; ++i) {
256         const auto& oneSession = *m_sessions[i];
257         if (&oneSession == &session)
258             pausingSessionIndex = i;
259         else if (oneSession.state() == PlatformMediaSession::Playing)
260             lastPlayingSessionIndex = i;
261         else
262             break;
263     }
264
265     if (lastPlayingSessionIndex == notFound || pausingSessionIndex == notFound)
266         return;
267
268     if (pausingSessionIndex > lastPlayingSessionIndex)
269         return;
270
271     m_sessions.remove(pausingSessionIndex);
272     m_sessions.append(makeWeakPtr(session));
273
274     ALWAYS_LOG(LOGIDENTIFIER, "session moved from index ", pausingSessionIndex, " to ", lastPlayingSessionIndex);
275 }
276
277 void PlatformMediaSessionManager::sessionStateChanged(PlatformMediaSession&)
278 {
279     updateSessionState();
280 }
281
282 void PlatformMediaSessionManager::setCurrentSession(PlatformMediaSession& session)
283 {
284     ALWAYS_LOG(LOGIDENTIFIER, session.logIdentifier());
285     
286     if (m_sessions.size() < 2)
287         return;
288     
289     size_t index = m_sessions.find(&session);
290     ASSERT(index != notFound);
291     if (!index || index == notFound)
292         return;
293
294     m_sessions.remove(index);
295     m_sessions.insert(0, makeWeakPtr(session));
296     if (m_remoteCommandListener)
297         m_remoteCommandListener->updateSupportedCommands();
298     
299     ALWAYS_LOG(LOGIDENTIFIER, "session moved from index ", index, " to 0");
300 }
301     
302 PlatformMediaSession* PlatformMediaSessionManager::currentSession() const
303 {
304     if (!m_sessions.size())
305         return nullptr;
306
307     return m_sessions[0].get();
308 }
309
310 void PlatformMediaSessionManager::applicationWillBecomeInactive()
311 {
312     ALWAYS_LOG(LOGIDENTIFIER);
313
314     forEachMatchingSession([&](auto& session) {
315         return m_restrictions[session.mediaType()] & InactiveProcessPlaybackRestricted;
316     }, [](auto& session) {
317         session.beginInterruption(PlatformMediaSession::ProcessInactive);
318     });
319 }
320
321 void PlatformMediaSessionManager::applicationDidBecomeActive()
322 {
323     ALWAYS_LOG(LOGIDENTIFIER);
324
325     forEachMatchingSession([&](auto& session) {
326         return m_restrictions[session.mediaType()] & InactiveProcessPlaybackRestricted;
327     }, [](auto& session) {
328         session.endInterruption(PlatformMediaSession::MayResumePlaying);
329     });
330 }
331
332 void PlatformMediaSessionManager::applicationDidEnterBackground(bool suspendedUnderLock)
333 {
334     ALWAYS_LOG(LOGIDENTIFIER, "suspendedUnderLock: ", suspendedUnderLock);
335
336     if (m_isApplicationInBackground)
337         return;
338
339     m_isApplicationInBackground = true;
340
341     forEachSession([&] (auto& session) {
342         if (suspendedUnderLock && m_restrictions[session.mediaType()] & SuspendedUnderLockPlaybackRestricted)
343             session.beginInterruption(PlatformMediaSession::SuspendedUnderLock);
344         else if (m_restrictions[session.mediaType()] & BackgroundProcessPlaybackRestricted)
345             session.beginInterruption(PlatformMediaSession::EnteringBackground);
346     });
347 }
348
349 void PlatformMediaSessionManager::applicationWillEnterForeground(bool suspendedUnderLock)
350 {
351     ALWAYS_LOG(LOGIDENTIFIER, "suspendedUnderLock: ", suspendedUnderLock);
352
353     if (!m_isApplicationInBackground)
354         return;
355
356     m_isApplicationInBackground = false;
357
358     forEachMatchingSession([&](auto& session) {
359         return (suspendedUnderLock && m_restrictions[session.mediaType()] & SuspendedUnderLockPlaybackRestricted) || m_restrictions[session.mediaType()] & BackgroundProcessPlaybackRestricted;
360     }, [](auto& session) {
361         session.endInterruption(PlatformMediaSession::MayResumePlaying);
362     });
363 }
364
365 void PlatformMediaSessionManager::processWillSuspend()
366 {
367     if (m_processIsSuspended)
368         return;
369     m_processIsSuspended = true;
370
371 #if USE(AUDIO_SESSION)
372     if (m_becameActive && shouldDeactivateAudioSession()) {
373         AudioSession::sharedSession().tryToSetActive(false);
374         ALWAYS_LOG(LOGIDENTIFIER, "tried to set inactive AudioSession");
375         m_becameActive = false;
376     }
377 #endif
378 }
379
380 void PlatformMediaSessionManager::processDidResume()
381 {
382     if (!m_processIsSuspended)
383         return;
384     m_processIsSuspended = false;
385
386 #if USE(AUDIO_SESSION)
387     if (!m_becameActive && activeAudioSessionRequired()) {
388         m_becameActive = AudioSession::sharedSession().tryToSetActive(true);
389         ALWAYS_LOG(LOGIDENTIFIER, "tried to set active AudioSession, ", m_becameActive ? "succeeded" : "failed");
390     }
391 #endif
392 }
393
394
395 void PlatformMediaSessionManager::sessionIsPlayingToWirelessPlaybackTargetChanged(PlatformMediaSession& session)
396 {
397     if (!m_isApplicationInBackground || !(m_restrictions[session.mediaType()] & BackgroundProcessPlaybackRestricted))
398         return;
399
400     if (session.state() != PlatformMediaSession::Interrupted)
401         session.beginInterruption(PlatformMediaSession::EnteringBackground);
402 }
403
404 void PlatformMediaSessionManager::sessionCanProduceAudioChanged(PlatformMediaSession&)
405 {
406     updateSessionState();
407 }
408
409 void PlatformMediaSessionManager::didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType command, const PlatformMediaSession::RemoteCommandArgument* argument)
410 {
411     PlatformMediaSession* activeSession = currentSession();
412     if (!activeSession || !activeSession->canReceiveRemoteControlCommands())
413         return;
414     activeSession->didReceiveRemoteControlCommand(command, argument);
415 }
416
417 bool PlatformMediaSessionManager::supportsSeeking() const
418 {
419     PlatformMediaSession* activeSession = currentSession();
420     if (!activeSession)
421         return false;
422     return activeSession->supportsSeeking();
423 }
424
425 void PlatformMediaSessionManager::systemWillSleep()
426 {
427     if (m_interrupted)
428         return;
429
430     forEachSession([] (auto& session) {
431         session.beginInterruption(PlatformMediaSession::SystemSleep);
432     });
433 }
434
435 void PlatformMediaSessionManager::systemDidWake()
436 {
437     if (m_interrupted)
438         return;
439
440     forEachSession([] (auto& session) {
441         session.endInterruption(PlatformMediaSession::MayResumePlaying);
442     });
443 }
444
445 void PlatformMediaSessionManager::audioOutputDeviceChanged()
446 {
447     updateSessionState();
448 }
449
450 void PlatformMediaSessionManager::stopAllMediaPlaybackForDocument(const Document& document)
451 {
452     forEachDocumentSession(document, [](auto& session) {
453         session.pauseSession();
454     });
455 }
456
457 void PlatformMediaSessionManager::stopAllMediaPlaybackForProcess()
458 {
459     forEachSession([] (auto& session) {
460         session.stopSession();
461     });
462 }
463
464 void PlatformMediaSessionManager::suspendAllMediaPlaybackForDocument(const Document& document)
465 {
466     forEachDocumentSession(document, [](auto& session) {
467         session.beginInterruption(PlatformMediaSession::PlaybackSuspended);
468     });
469 }
470
471 void PlatformMediaSessionManager::resumeAllMediaPlaybackForDocument(const Document& document)
472 {
473     forEachDocumentSession(document, [](auto& session) {
474         session.endInterruption(PlatformMediaSession::MayResumePlaying);
475     });
476 }
477
478 void PlatformMediaSessionManager::suspendAllMediaBufferingForDocument(const Document& document)
479 {
480     forEachDocumentSession(document, [](auto& session) {
481         session.suspendBuffering();
482     });
483 }
484
485 void PlatformMediaSessionManager::resumeAllMediaBufferingForDocument(const Document& document)
486 {
487     forEachDocumentSession(document, [](auto& session) {
488         session.resumeBuffering();
489     });
490 }
491
492 Vector<WeakPtr<PlatformMediaSession>> PlatformMediaSessionManager::sessionsMatching(const WTF::Function<bool(const PlatformMediaSession&)>& filter) const
493 {
494     Vector<WeakPtr<PlatformMediaSession>> matchingSessions;
495     for (auto& session : m_sessions) {
496         if (filter(*session))
497             matchingSessions.append(session);
498     }
499     return matchingSessions;
500 }
501
502 void PlatformMediaSessionManager::forEachMatchingSession(const Function<bool(const PlatformMediaSession&)>& predicate, const Function<void(PlatformMediaSession&)>& callback)
503 {
504     for (auto& session : sessionsMatching(predicate)) {
505         ASSERT(session);
506         if (session)
507             callback(*session);
508     }
509 }
510
511 void PlatformMediaSessionManager::forEachDocumentSession(const Document& document, const Function<void(PlatformMediaSession&)>& callback)
512 {
513     forEachMatchingSession([&document](auto& session) {
514         return session.client().hostingDocument() == &document;
515     }, [&callback](auto& session) {
516         callback(session);
517     });
518 }
519
520 void PlatformMediaSessionManager::forEachSession(const Function<void(PlatformMediaSession&)>& callback)
521 {
522     auto sessions = m_sessions;
523     for (auto& session : sessions) {
524         ASSERT(session);
525         if (session)
526             callback(*session);
527     }
528 }
529
530 bool PlatformMediaSessionManager::anyOfSessions(const Function<bool(const PlatformMediaSession&)>& predicate) const
531 {
532     return WTF::anyOf(m_sessions, [&predicate](const auto& session) {
533         return predicate(*session);
534     });
535 }
536
537 static bool& deactivateAudioSession()
538 {
539     static bool deactivate;
540     return deactivate;
541 }
542
543 bool PlatformMediaSessionManager::shouldDeactivateAudioSession()
544 {
545     return deactivateAudioSession();
546 }
547
548 void PlatformMediaSessionManager::setShouldDeactivateAudioSession(bool deactivate)
549 {
550     deactivateAudioSession() = deactivate;
551 }
552
553 #else // ENABLE(VIDEO) || ENABLE(WEB_AUDIO)
554
555 void PlatformMediaSessionManager::updateNowPlayingInfoIfNecessary()
556 {
557
558 }
559
560 #endif // ENABLE(VIDEO) || ENABLE(WEB_AUDIO)
561
562 #if !RELEASE_LOG_DISABLED
563 WTFLogChannel& PlatformMediaSessionManager::logChannel() const
564 {
565     return LogMedia;
566 }
567 #endif
568
569 } // namespace WebCore