1f7603abdc0a2f252cfab0cfae5136dd124d3dd4
[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 "Settings.h"
33 #include "SystemSleepListener.h"
34 #include <map>
35 #include <wtf/Vector.h>
36
37 namespace WebCore {
38
39 class Document;
40 class HTMLMediaElement;
41 class PlatformMediaSession;
42 class RemoteCommandListener;
43
44 class PlatformMediaSessionManager : private RemoteCommandListenerClient, private SystemSleepListener::Client, private AudioHardwareListener::Client {
45     WTF_MAKE_FAST_ALLOCATED;
46 public:
47     WEBCORE_EXPORT static PlatformMediaSessionManager* sharedManagerIfExists();
48     WEBCORE_EXPORT static PlatformMediaSessionManager& sharedManager();
49     virtual ~PlatformMediaSessionManager() { }
50
51     bool has(PlatformMediaSession::MediaType) const;
52     int count(PlatformMediaSession::MediaType) const;
53     bool activeAudioSessionRequired() const;
54
55     WEBCORE_EXPORT void beginInterruption(PlatformMediaSession::InterruptionType);
56     WEBCORE_EXPORT void endInterruption(PlatformMediaSession::EndInterruptionFlags);
57
58     WEBCORE_EXPORT void applicationWillEnterForeground() const;
59     WEBCORE_EXPORT void applicationWillEnterBackground() const;
60     WEBCORE_EXPORT void applicationDidEnterBackground(bool isSuspendedUnderLock) const;
61
62     void stopAllMediaPlaybackForDocument(const Document*);
63     WEBCORE_EXPORT void stopAllMediaPlaybackForProcess();
64
65     enum SessionRestrictionFlags {
66         NoRestrictions = 0,
67         ConcurrentPlaybackNotPermitted = 1 << 0,
68         BackgroundProcessPlaybackRestricted = 1 << 1,
69         BackgroundTabPlaybackRestricted = 1 << 2,
70         InterruptedPlaybackNotPermitted = 1 << 3,
71     };
72     typedef unsigned SessionRestrictions;
73
74     WEBCORE_EXPORT void addRestriction(PlatformMediaSession::MediaType, SessionRestrictions);
75     WEBCORE_EXPORT void removeRestriction(PlatformMediaSession::MediaType, SessionRestrictions);
76     WEBCORE_EXPORT SessionRestrictions restrictions(PlatformMediaSession::MediaType);
77     virtual void resetRestrictions();
78
79     virtual bool sessionWillBeginPlayback(PlatformMediaSession&);
80     virtual void sessionWillEndPlayback(PlatformMediaSession&);
81     virtual bool sessionCanLoadMedia(const PlatformMediaSession&) const;
82
83 #if PLATFORM(IOS)
84     virtual void configureWireLessTargetMonitoring() { }
85     virtual bool hasWirelessTargetsAvailable() { return false; }
86 #endif
87
88     void setCurrentSession(PlatformMediaSession&);
89     PlatformMediaSession* currentSession();
90
91     void sessionIsPlayingToWirelessPlaybackTargetChanged(PlatformMediaSession&);
92
93 protected:
94     friend class PlatformMediaSession;
95     explicit PlatformMediaSessionManager();
96
97     void addSession(PlatformMediaSession&);
98     void removeSession(PlatformMediaSession&);
99
100     Vector<PlatformMediaSession*> sessions() { return m_sessions; }
101
102 private:
103     friend class Internals;
104
105     void updateSessionState();
106
107     // RemoteCommandListenerClient
108     WEBCORE_EXPORT virtual void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType) override;
109
110     // AudioHardwareListenerClient
111     virtual void audioHardwareDidBecomeActive() override { }
112     virtual void audioHardwareDidBecomeInactive() override { }
113     virtual void audioOutputDeviceChanged() override;
114
115     // SystemSleepListener
116     virtual void systemWillSleep() override;
117     virtual void systemDidWake() override;
118
119     SessionRestrictions m_restrictions[PlatformMediaSession::WebAudio + 1];
120     Vector<PlatformMediaSession*> m_sessions;
121     std::unique_ptr<RemoteCommandListener> m_remoteCommandListener;
122     std::unique_ptr<SystemSleepListener> m_systemSleepListener;
123     RefPtr<AudioHardwareListener> m_audioHardwareListener;
124
125 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS)
126     RefPtr<MediaPlaybackTarget> m_playbackTarget;
127     bool m_canPlayToTarget { false };
128 #endif
129
130     bool m_interrupted { false };
131     mutable bool m_isApplicationInBackground { false };
132 };
133
134 }
135
136 #endif // PlatformMediaSessionManager_h