8dcfd11106620fc9976685319fe83c84cfeb03fb
[WebKit-https.git] / Source / WebCore / platform / audio / PlatformMediaSessionManager.h
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 #ifndef PlatformMediaSessionManager_h
27 #define PlatformMediaSessionManager_h
28
29 #include "AudioHardwareListener.h"
30 #include "PlatformMediaSession.h"
31 #include "RemoteCommandListener.h"
32 #include <pal/system/SystemSleepListener.h>
33 #include <wtf/Vector.h>
34
35 namespace WebCore {
36
37 class Document;
38 class HTMLMediaElement;
39 class PlatformMediaSession;
40 class RemoteCommandListener;
41
42 class PlatformMediaSessionManager : private RemoteCommandListenerClient, private PAL::SystemSleepListener::Client, private AudioHardwareListener::Client {
43     WTF_MAKE_FAST_ALLOCATED;
44 public:
45     WEBCORE_EXPORT static PlatformMediaSessionManager* sharedManagerIfExists();
46     WEBCORE_EXPORT static PlatformMediaSessionManager& sharedManager();
47
48     static void updateNowPlayingInfoIfNecessary();
49
50     virtual ~PlatformMediaSessionManager() = default;
51
52     virtual void scheduleUpdateNowPlayingInfo() { }
53     bool has(PlatformMediaSession::MediaType) const;
54     int count(PlatformMediaSession::MediaType) const;
55     bool activeAudioSessionRequired() const;
56     bool canProduceAudio() const;
57
58     virtual bool hasActiveNowPlayingSession() const { return false; }
59     virtual String lastUpdatedNowPlayingTitle() const { return emptyString(); }
60     virtual double lastUpdatedNowPlayingDuration() const { return NAN; }
61     virtual double lastUpdatedNowPlayingElapsedTime() const { return NAN; }
62     virtual uint64_t lastUpdatedNowPlayingInfoUniqueIdentifier() const { return 0; }
63     virtual bool registeredAsNowPlayingApplication() const { return false; }
64
65     bool willIgnoreSystemInterruptions() const { return m_willIgnoreSystemInterruptions; }
66     void setWillIgnoreSystemInterruptions(bool ignore) { m_willIgnoreSystemInterruptions = ignore; }
67
68     WEBCORE_EXPORT void beginInterruption(PlatformMediaSession::InterruptionType);
69     WEBCORE_EXPORT void endInterruption(PlatformMediaSession::EndInterruptionFlags);
70
71     WEBCORE_EXPORT void applicationWillBecomeInactive() const;
72     WEBCORE_EXPORT void applicationDidBecomeActive() const;
73     WEBCORE_EXPORT void applicationWillEnterForeground(bool suspendedUnderLock) const;
74     WEBCORE_EXPORT void applicationDidEnterBackground(bool suspendedUnderLock) const;
75
76     void stopAllMediaPlaybackForDocument(const Document*);
77     WEBCORE_EXPORT void stopAllMediaPlaybackForProcess();
78
79     enum SessionRestrictionFlags {
80         NoRestrictions = 0,
81         ConcurrentPlaybackNotPermitted = 1 << 0,
82         BackgroundProcessPlaybackRestricted = 1 << 1,
83         BackgroundTabPlaybackRestricted = 1 << 2,
84         InterruptedPlaybackNotPermitted = 1 << 3,
85         InactiveProcessPlaybackRestricted = 1 << 4,
86         SuspendedUnderLockPlaybackRestricted = 1 << 5,
87     };
88     typedef unsigned SessionRestrictions;
89
90     WEBCORE_EXPORT void addRestriction(PlatformMediaSession::MediaType, SessionRestrictions);
91     WEBCORE_EXPORT void removeRestriction(PlatformMediaSession::MediaType, SessionRestrictions);
92     WEBCORE_EXPORT SessionRestrictions restrictions(PlatformMediaSession::MediaType);
93     virtual void resetRestrictions();
94
95     virtual bool sessionWillBeginPlayback(PlatformMediaSession&);
96     virtual void sessionWillEndPlayback(PlatformMediaSession&);
97     virtual void sessionStateChanged(PlatformMediaSession&);
98     virtual void sessionDidEndRemoteScrubbing(const PlatformMediaSession&) { };
99     virtual void clientCharacteristicsChanged(PlatformMediaSession&) { }
100
101 #if PLATFORM(IOS)
102     virtual void configureWireLessTargetMonitoring() { }
103     virtual bool hasWirelessTargetsAvailable() { return false; }
104 #endif
105
106     void setCurrentSession(PlatformMediaSession&);
107     PlatformMediaSession* currentSession() const;
108
109     Vector<PlatformMediaSession*> currentSessionsMatching(const WTF::Function<bool(const PlatformMediaSession&)>&);
110
111     void sessionIsPlayingToWirelessPlaybackTargetChanged(PlatformMediaSession&);
112     void sessionCanProduceAudioChanged(PlatformMediaSession&);
113
114 protected:
115     friend class PlatformMediaSession;
116     explicit PlatformMediaSessionManager();
117
118     void addSession(PlatformMediaSession&);
119     virtual void removeSession(PlatformMediaSession&);
120
121     void forEachSession(const Function<void(PlatformMediaSession&, size_t)>&) const;
122     PlatformMediaSession* findSession(const Function<bool(PlatformMediaSession&, size_t)>&) const;
123     bool anyOfSessions(const Function<bool(PlatformMediaSession&, size_t)>& predicate) const { return findSession(predicate); }
124
125 private:
126     friend class Internals;
127
128     void updateSessionState();
129
130     // RemoteCommandListenerClient
131     WEBCORE_EXPORT void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument*) override;
132     WEBCORE_EXPORT bool supportsSeeking() const override;
133
134     // AudioHardwareListenerClient
135     void audioHardwareDidBecomeActive() override { }
136     void audioHardwareDidBecomeInactive() override { }
137     void audioOutputDeviceChanged() override;
138
139     // PAL::SystemSleepListener
140     void systemWillSleep() override;
141     void systemDidWake() override;
142
143     SessionRestrictions m_restrictions[PlatformMediaSession::MediaStreamCapturingAudio + 1];
144     mutable Vector<PlatformMediaSession*> m_sessions;
145     std::unique_ptr<RemoteCommandListener> m_remoteCommandListener;
146     std::unique_ptr<PAL::SystemSleepListener> m_systemSleepListener;
147     RefPtr<AudioHardwareListener> m_audioHardwareListener;
148
149 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS)
150     RefPtr<MediaPlaybackTarget> m_playbackTarget;
151     bool m_canPlayToTarget { false };
152 #endif
153
154     bool m_interrupted { false };
155     mutable bool m_isApplicationInBackground { false };
156     bool m_willIgnoreSystemInterruptions { false };
157     mutable int m_iteratingOverSessions { 0 };
158 };
159
160 }
161
162 #endif // PlatformMediaSessionManager_h