[WebKitLegacy] Media playback pauses on scroll
[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 "Timer.h"
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     virtual bool hasActiveNowPlayingSession() const { return false; }
60     virtual String lastUpdatedNowPlayingTitle() const { return emptyString(); }
61     virtual double lastUpdatedNowPlayingDuration() const { return NAN; }
62     virtual double lastUpdatedNowPlayingElapsedTime() const { return NAN; }
63     virtual uint64_t lastUpdatedNowPlayingInfoUniqueIdentifier() const { return 0; }
64     virtual bool registeredAsNowPlayingApplication() const { return false; }
65
66     bool willIgnoreSystemInterruptions() const { return m_willIgnoreSystemInterruptions; }
67     void setWillIgnoreSystemInterruptions(bool ignore) { m_willIgnoreSystemInterruptions = ignore; }
68
69     WEBCORE_EXPORT virtual void beginInterruption(PlatformMediaSession::InterruptionType);
70     WEBCORE_EXPORT void endInterruption(PlatformMediaSession::EndInterruptionFlags);
71
72     WEBCORE_EXPORT void applicationWillBecomeInactive() const;
73     WEBCORE_EXPORT void applicationDidBecomeActive() const;
74     WEBCORE_EXPORT void applicationWillEnterForeground(bool suspendedUnderLock) const;
75     WEBCORE_EXPORT void applicationDidEnterBackground(bool suspendedUnderLock) const;
76
77     void stopAllMediaPlaybackForDocument(const Document*);
78     WEBCORE_EXPORT void stopAllMediaPlaybackForProcess();
79
80     void suspendAllMediaPlaybackForDocument(const Document&);
81     void resumeAllMediaPlaybackForDocument(const Document&);
82
83     enum SessionRestrictionFlags {
84         NoRestrictions = 0,
85         ConcurrentPlaybackNotPermitted = 1 << 0,
86         BackgroundProcessPlaybackRestricted = 1 << 1,
87         BackgroundTabPlaybackRestricted = 1 << 2,
88         InterruptedPlaybackNotPermitted = 1 << 3,
89         InactiveProcessPlaybackRestricted = 1 << 4,
90         SuspendedUnderLockPlaybackRestricted = 1 << 5,
91     };
92     typedef unsigned SessionRestrictions;
93
94     WEBCORE_EXPORT void addRestriction(PlatformMediaSession::MediaType, SessionRestrictions);
95     WEBCORE_EXPORT void removeRestriction(PlatformMediaSession::MediaType, SessionRestrictions);
96     WEBCORE_EXPORT SessionRestrictions restrictions(PlatformMediaSession::MediaType);
97     virtual void resetRestrictions();
98
99     virtual bool sessionWillBeginPlayback(PlatformMediaSession&);
100     virtual void sessionWillEndPlayback(PlatformMediaSession&);
101     virtual void sessionStateChanged(PlatformMediaSession&);
102     virtual void sessionDidEndRemoteScrubbing(const PlatformMediaSession&) { };
103     virtual void clientCharacteristicsChanged(PlatformMediaSession&) { }
104     virtual void sessionCanProduceAudioChanged(PlatformMediaSession&);
105
106 #if PLATFORM(IOS_FAMILY)
107     virtual void configureWireLessTargetMonitoring() { }
108     virtual bool hasWirelessTargetsAvailable() { return false; }
109 #endif
110
111     void setCurrentSession(PlatformMediaSession&);
112     PlatformMediaSession* currentSession() const;
113
114     Vector<PlatformMediaSession*> currentSessionsMatching(const WTF::Function<bool(const PlatformMediaSession&)>&);
115
116     void sessionIsPlayingToWirelessPlaybackTargetChanged(PlatformMediaSession&);
117
118 protected:
119     friend class PlatformMediaSession;
120     explicit PlatformMediaSessionManager();
121
122     void addSession(PlatformMediaSession&);
123     virtual void removeSession(PlatformMediaSession&);
124
125     void forEachSession(const Function<void(PlatformMediaSession&, size_t)>&) const;
126     PlatformMediaSession* findSession(const Function<bool(PlatformMediaSession&, size_t)>&) const;
127     bool anyOfSessions(const Function<bool(PlatformMediaSession&, size_t)>& predicate) const { return findSession(predicate); }
128
129     AudioHardwareListener* audioHardwareListener() { return m_audioHardwareListener.get(); }
130
131 private:
132     friend class Internals;
133
134     virtual void updateSessionState() { }
135
136     // RemoteCommandListenerClient
137     WEBCORE_EXPORT void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument*) override;
138     WEBCORE_EXPORT bool supportsSeeking() const override;
139
140     // AudioHardwareListenerClient
141     void audioHardwareDidBecomeActive() override { }
142     void audioHardwareDidBecomeInactive() override { }
143     void audioOutputDeviceChanged() override;
144
145     // PAL::SystemSleepListener
146     void systemWillSleep() override;
147     void systemDidWake() override;
148
149     SessionRestrictions m_restrictions[PlatformMediaSession::MediaStreamCapturingAudio + 1];
150     mutable Vector<PlatformMediaSession*> m_sessions;
151     std::unique_ptr<RemoteCommandListener> m_remoteCommandListener;
152     std::unique_ptr<PAL::SystemSleepListener> m_systemSleepListener;
153     RefPtr<AudioHardwareListener> m_audioHardwareListener;
154
155 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS_FAMILY)
156     RefPtr<MediaPlaybackTarget> m_playbackTarget;
157     bool m_canPlayToTarget { false };
158 #endif
159
160     bool m_interrupted { false };
161     mutable bool m_isApplicationInBackground { false };
162     bool m_willIgnoreSystemInterruptions { false };
163     mutable int m_iteratingOverSessions { 0 };
164 };
165
166 }
167
168 #endif // PlatformMediaSessionManager_h