Now playing media sessions are always cleared for the active foreground tab
[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 "MediaProducer.h"
30 #include "Timer.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 {
49 public:
50     static std::unique_ptr<PlatformMediaSession> create(PlatformMediaSessionClient&);
51
52     PlatformMediaSession(PlatformMediaSessionClient&);
53     virtual ~PlatformMediaSession();
54
55     enum MediaType {
56         None = 0,
57         Video,
58         Audio,
59         WebAudio,
60     };
61     MediaType mediaType() const;
62     MediaType presentationType() const;
63
64     enum State {
65         Idle,
66         Autoplaying,
67         Playing,
68         Paused,
69         Interrupted,
70     };
71     State state() const { return m_state; }
72     void setState(State);
73
74     enum InterruptionType {
75         NoInterruption,
76         SystemSleep,
77         EnteringBackground,
78         SystemInterruption,
79         SuspendedUnderLock,
80         InvisibleAutoplay,
81     };
82     InterruptionType interruptionType() const { return m_interruptionType; }
83
84     enum EndInterruptionFlags {
85         NoFlags = 0,
86         MayResumePlaying = 1 << 0,
87     };
88
89     enum Characteristics {
90         HasNothing = 0,
91         HasAudio = 1 << 0,
92         HasVideo = 1 << 1,
93     };
94     typedef unsigned CharacteristicsFlags;
95
96     CharacteristicsFlags characteristics() const;
97     void clientCharacteristicsChanged();
98
99     void beginInterruption(InterruptionType);
100     void endInterruption(EndInterruptionFlags);
101
102     void clientWillBeginAutoplaying();
103     bool clientWillBeginPlayback();
104     bool clientWillPausePlayback();
105
106     void pauseSession();
107     void stopSession();
108     
109     void visibilityChanged();
110
111 #if ENABLE(VIDEO)
112     String title() const;
113     double duration() const;
114     double currentTime() const;
115 #endif
116
117     typedef union {
118         double asDouble;
119     } RemoteCommandArgument;
120
121     enum RemoteControlCommandType {
122         NoCommand,
123         PlayCommand,
124         PauseCommand,
125         StopCommand,
126         TogglePlayPauseCommand,
127         BeginSeekingBackwardCommand,
128         EndSeekingBackwardCommand,
129         BeginSeekingForwardCommand,
130         EndSeekingForwardCommand,
131         SeekToPlaybackPositionCommand,
132     };
133     bool canReceiveRemoteControlCommands() const;
134     void didReceiveRemoteControlCommand(RemoteControlCommandType, const RemoteCommandArgument* argument = nullptr);
135     bool supportsSeeking() const;
136
137     enum DisplayType {
138         Normal,
139         Fullscreen,
140         Optimized,
141     };
142     DisplayType displayType() const;
143
144     bool isHidden() const;
145
146     bool shouldOverrideBackgroundLoadingRestriction() const;
147
148     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
149     virtual bool isPlayingToWirelessPlaybackTarget() const { return m_isPlayingToWirelessPlaybackTarget; }
150     void isPlayingToWirelessPlaybackTargetChanged(bool);
151
152 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
153     // MediaPlaybackTargetClient
154     void setPlaybackTarget(Ref<MediaPlaybackTarget>&&) override { }
155     void externalOutputDeviceAvailableDidChange(bool) override { }
156     void setShouldPlayToPlaybackTarget(bool) override { }
157 #endif
158
159 #if PLATFORM(IOS)
160     virtual bool requiresPlaybackTargetRouteMonitoring() const { return false; }
161 #endif
162
163     bool activeAudioSessionRequired();
164     bool canProduceAudio() const { return m_canProduceAudio; }
165     void setCanProduceAudio(bool);
166
167     void scheduleClientDataBufferingCheck();
168     virtual void resetPlaybackSessionState() { }
169     String sourceApplicationIdentifier() const;
170
171     virtual bool allowsNowPlayingControlsVisibility() const { return false; }
172
173 protected:
174     PlatformMediaSessionClient& client() const { return m_client; }
175
176 private:
177     void clientDataBufferingTimerFired();
178     void updateClientDataBuffering();
179
180     PlatformMediaSessionClient& m_client;
181     Timer m_clientDataBufferingTimer;
182     State m_state;
183     State m_stateToRestore;
184     InterruptionType m_interruptionType { NoInterruption };
185     int m_interruptionCount { 0 };
186     bool m_notifyingClient;
187     bool m_isPlayingToWirelessPlaybackTarget { false };
188     bool m_canProduceAudio { false };
189
190     friend class PlatformMediaSessionManager;
191 };
192
193 class PlatformMediaSessionClient {
194     WTF_MAKE_NONCOPYABLE(PlatformMediaSessionClient);
195 public:
196     PlatformMediaSessionClient() { }
197     
198     virtual PlatformMediaSession::MediaType mediaType() const = 0;
199     virtual PlatformMediaSession::MediaType presentationType() const = 0;
200     virtual PlatformMediaSession::DisplayType displayType() const { return PlatformMediaSession::Normal; }
201     virtual PlatformMediaSession::CharacteristicsFlags characteristics() const = 0;
202
203     virtual void resumeAutoplaying() { }
204     virtual void mayResumePlayback(bool shouldResume) = 0;
205     virtual void suspendPlayback() = 0;
206
207 #if ENABLE(VIDEO)
208     virtual String mediaSessionTitle() const;
209     virtual double mediaSessionDuration() const;
210     virtual double mediaSessionCurrentTime() const;
211 #endif
212     
213     virtual bool canReceiveRemoteControlCommands() const = 0;
214     virtual void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument*) = 0;
215     virtual bool supportsSeeking() const = 0;
216
217     virtual void setShouldBufferData(bool) { }
218     virtual bool elementIsHidden() const { return false; }
219
220     virtual bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const = 0;
221     virtual bool shouldOverrideBackgroundLoadingRestriction() const { return false; }
222
223     virtual void wirelessRoutesAvailableDidChange() { }
224     virtual void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) { }
225     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
226     virtual bool isPlayingToWirelessPlaybackTarget() const { return false; }
227     virtual void setShouldPlayToPlaybackTarget(bool) { }
228
229     virtual const Document* hostingDocument() const = 0;
230     virtual String sourceApplicationIdentifier() const = 0;
231
232 protected:
233     virtual ~PlatformMediaSessionClient() { }
234 };
235
236 }
237
238 #endif // PlatformMediaSession_h