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