Control center controls disappear when pausing, locking device.
[WebKit-https.git] / Source / WebCore / platform / audio / PlatformMediaSession.h
1 /*
2  * Copyright (C) 2014-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 PlatformMediaSession_h
27 #define PlatformMediaSession_h
28
29 #include "Timer.h"
30 #include <wtf/LoggerHelper.h>
31 #include <wtf/Noncopyable.h>
32 #include <wtf/text/WTFString.h>
33
34 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
35 #include "MediaPlaybackTargetClient.h"
36 #endif
37
38 namespace WebCore {
39
40 class Document;
41 class MediaPlaybackTarget;
42 class PlatformMediaSessionClient;
43
44 class PlatformMediaSession
45 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
46     : public MediaPlaybackTargetClient
47 #endif
48 #if !RELEASE_LOG_DISABLED
49     , private LoggerHelper
50 #endif
51 {
52     WTF_MAKE_FAST_ALLOCATED;
53 public:
54     static std::unique_ptr<PlatformMediaSession> create(PlatformMediaSessionClient&);
55
56     PlatformMediaSession(PlatformMediaSessionClient&);
57     virtual ~PlatformMediaSession();
58
59     enum MediaType {
60         None = 0,
61         Video,
62         VideoAudio,
63         Audio,
64         WebAudio,
65         MediaStreamCapturingAudio,
66     };
67     MediaType mediaType() const;
68     MediaType presentationType() const;
69
70     enum State {
71         Idle,
72         Autoplaying,
73         Playing,
74         Paused,
75         Interrupted,
76     };
77     State state() const { return m_state; }
78     void setState(State);
79
80     enum InterruptionType {
81         NoInterruption,
82         SystemSleep,
83         EnteringBackground,
84         SystemInterruption,
85         SuspendedUnderLock,
86         InvisibleAutoplay,
87         ProcessInactive,
88     };
89     InterruptionType interruptionType() const { return m_interruptionType; }
90
91     enum EndInterruptionFlags {
92         NoFlags = 0,
93         MayResumePlaying = 1 << 0,
94     };
95
96     enum Characteristics {
97         HasNothing = 0,
98         HasAudio = 1 << 0,
99         HasVideo = 1 << 1,
100     };
101     typedef unsigned CharacteristicsFlags;
102
103     CharacteristicsFlags characteristics() const;
104     void clientCharacteristicsChanged();
105
106     void beginInterruption(InterruptionType);
107     void endInterruption(EndInterruptionFlags);
108
109     virtual void clientWillBeginAutoplaying();
110     virtual bool clientWillBeginPlayback();
111     virtual bool clientWillPausePlayback();
112
113     void pauseSession();
114     void stopSession();
115     
116 #if ENABLE(VIDEO)
117     uint64_t uniqueIdentifier() const;
118     String title() const;
119     double duration() const;
120     double currentTime() const;
121 #endif
122
123     typedef union {
124         double asDouble;
125     } RemoteCommandArgument;
126
127     enum RemoteControlCommandType {
128         NoCommand,
129         PlayCommand,
130         PauseCommand,
131         StopCommand,
132         TogglePlayPauseCommand,
133         BeginSeekingBackwardCommand,
134         EndSeekingBackwardCommand,
135         BeginSeekingForwardCommand,
136         EndSeekingForwardCommand,
137         SeekToPlaybackPositionCommand,
138     };
139     bool canReceiveRemoteControlCommands() const;
140     void didReceiveRemoteControlCommand(RemoteControlCommandType, const RemoteCommandArgument* argument = nullptr);
141     bool supportsSeeking() const;
142
143     enum DisplayType {
144         Normal,
145         Fullscreen,
146         Optimized,
147     };
148     DisplayType displayType() const;
149
150     bool isHidden() const;
151     bool isSuspended() const;
152
153     bool shouldOverrideBackgroundLoadingRestriction() const;
154
155     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
156     virtual bool isPlayingToWirelessPlaybackTarget() const { return m_isPlayingToWirelessPlaybackTarget; }
157     void isPlayingToWirelessPlaybackTargetChanged(bool);
158
159 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
160     // MediaPlaybackTargetClient
161     void setPlaybackTarget(Ref<MediaPlaybackTarget>&&) override { }
162     void externalOutputDeviceAvailableDidChange(bool) override { }
163     void setShouldPlayToPlaybackTarget(bool) override { }
164 #endif
165
166 #if PLATFORM(IOS)
167     virtual bool requiresPlaybackTargetRouteMonitoring() const { return false; }
168 #endif
169
170     bool activeAudioSessionRequired();
171     bool canProduceAudio() const;
172     void canProduceAudioChanged();
173
174     virtual void resetPlaybackSessionState() { }
175     String sourceApplicationIdentifier() const;
176
177     virtual bool allowsNowPlayingControlsVisibility() const { return false; }
178
179     bool hasPlayedSinceLastInterruption() const { return m_hasPlayedSinceLastInterruption; }
180     void clearHasPlayedSinceLastInterruption() { m_hasPlayedSinceLastInterruption = false; }
181
182 protected:
183     PlatformMediaSessionClient& client() const { return m_client; }
184
185 #if !RELEASE_LOG_DISABLED
186     const Logger& logger() const final { return m_logger.get(); }
187     const void* logIdentifier() const override { return reinterpret_cast<const void*>(m_logIdentifier); }
188     const char* logClassName() const override { return "PlatformMediaSession"; }
189     WTFLogChannel& logChannel() const final;
190 #endif
191
192 private:
193     PlatformMediaSessionClient& m_client;
194     State m_state;
195     State m_stateToRestore;
196     InterruptionType m_interruptionType { NoInterruption };
197     int m_interruptionCount { 0 };
198     bool m_notifyingClient;
199     bool m_isPlayingToWirelessPlaybackTarget { false };
200     bool m_hasPlayedSinceLastInterruption { false };
201
202 #if !RELEASE_LOG_DISABLED
203     Ref<const Logger> m_logger;
204     uint64_t m_logIdentifier;
205 #endif
206
207     friend class PlatformMediaSessionManager;
208 };
209
210 class PlatformMediaSessionClient {
211     WTF_MAKE_NONCOPYABLE(PlatformMediaSessionClient);
212 public:
213     PlatformMediaSessionClient() = default;
214     
215     virtual PlatformMediaSession::MediaType mediaType() const = 0;
216     virtual PlatformMediaSession::MediaType presentationType() const = 0;
217     virtual PlatformMediaSession::DisplayType displayType() const { return PlatformMediaSession::Normal; }
218     virtual PlatformMediaSession::CharacteristicsFlags characteristics() const = 0;
219
220     virtual void resumeAutoplaying() { }
221     virtual void mayResumePlayback(bool shouldResume) = 0;
222     virtual void suspendPlayback() = 0;
223
224 #if ENABLE(VIDEO)
225     virtual uint64_t mediaSessionUniqueIdentifier() const;
226     virtual String mediaSessionTitle() const;
227     virtual double mediaSessionDuration() const;
228     virtual double mediaSessionCurrentTime() const;
229 #endif
230     
231     virtual bool canReceiveRemoteControlCommands() const = 0;
232     virtual void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument*) = 0;
233     virtual bool supportsSeeking() const = 0;
234
235     virtual bool canProduceAudio() const { return false; }
236     virtual bool isSuspended() const { return false; };
237
238     virtual bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const = 0;
239     virtual bool shouldOverrideBackgroundLoadingRestriction() const { return false; }
240
241     virtual void wirelessRoutesAvailableDidChange() { }
242     virtual void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) { }
243     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
244     virtual bool isPlayingToWirelessPlaybackTarget() const { return false; }
245     virtual void setShouldPlayToPlaybackTarget(bool) { }
246
247     virtual Document* hostingDocument() const = 0;
248     virtual String sourceApplicationIdentifier() const = 0;
249
250     virtual bool processingUserGestureForMedia() const = 0;
251
252 protected:
253     virtual ~PlatformMediaSessionClient() = default;
254 };
255
256 String convertEnumerationToString(PlatformMediaSession::State);
257 String convertEnumerationToString(PlatformMediaSession::InterruptionType);
258
259 }
260
261 namespace WTF {
262
263 template<typename Type>
264 struct LogArgument;
265
266 template <>
267 struct LogArgument<WebCore::PlatformMediaSession::State> {
268     static String toString(const WebCore::PlatformMediaSession::State state)
269     {
270         return convertEnumerationToString(state);
271     }
272 };
273
274 template <>
275 struct LogArgument<WebCore::PlatformMediaSession::InterruptionType> {
276     static String toString(const WebCore::PlatformMediaSession::InterruptionType state)
277     {
278         return convertEnumerationToString(state);
279     }
280 };
281
282 } // namespace WTF
283
284 #endif // PlatformMediaSession_h