820eadfba50dfdafaa1205087a541c75253ca550
[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         Playing,
67         Paused,
68         Interrupted,
69     };
70     State state() const { return m_state; }
71     void setState(State);
72
73     enum InterruptionType {
74         SystemSleep,
75         EnteringBackground,
76         SystemInterruption,
77     };
78     enum EndInterruptionFlags {
79         NoFlags = 0,
80         MayResumePlaying = 1 << 0,
81     };
82
83     void doInterruption();
84     bool shouldDoInterruption(InterruptionType);
85     void beginInterruption(InterruptionType);
86     void forceInterruption(InterruptionType);
87     void endInterruption(EndInterruptionFlags);
88
89     void applicationWillEnterForeground() const;
90     void applicationWillEnterBackground() const;
91     void applicationDidEnterBackground(bool isSuspendedUnderLock) const;
92
93     bool clientWillBeginPlayback();
94     bool clientWillPausePlayback();
95
96     void pauseSession();
97     
98     void visibilityChanged();
99
100     String title() const;
101     double duration() const;
102     double currentTime() const;
103
104     enum RemoteControlCommandType {
105         NoCommand,
106         PlayCommand,
107         PauseCommand,
108         StopCommand,
109         TogglePlayPauseCommand,
110         BeginSeekingBackwardCommand,
111         EndSeekingBackwardCommand,
112         BeginSeekingForwardCommand,
113         EndSeekingForwardCommand,
114     };
115     bool canReceiveRemoteControlCommands() const;
116     void didReceiveRemoteControlCommand(RemoteControlCommandType);
117
118     enum DisplayType {
119         Normal,
120         Fullscreen,
121         Optimized,
122     };
123     DisplayType displayType() const;
124
125     bool isHidden() const;
126
127     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
128     virtual bool isPlayingToWirelessPlaybackTarget() const { return false; }
129
130 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
131     // MediaPlaybackTargetClient
132     virtual void setPlaybackTarget(Ref<MediaPlaybackTarget>&&) override { }
133     virtual void externalOutputDeviceAvailableDidChange(bool) override { }
134     virtual void setShouldPlayToPlaybackTarget(bool) override { }
135 #endif
136
137 #if PLATFORM(IOS)
138     virtual bool requiresPlaybackTargetRouteMonitoring() const { return false; }
139 #endif
140
141 protected:
142     PlatformMediaSessionClient& client() const { return m_client; }
143
144 private:
145     void clientDataBufferingTimerFired();
146     void updateClientDataBuffering();
147
148     PlatformMediaSessionClient& m_client;
149     Timer m_clientDataBufferingTimer;
150     State m_state;
151     State m_stateToRestore;
152     int m_interruptionCount { 0 };
153     bool m_notifyingClient;
154
155     friend class PlatformMediaSessionManager;
156 };
157
158 class PlatformMediaSessionClient {
159     WTF_MAKE_NONCOPYABLE(PlatformMediaSessionClient);
160 public:
161     PlatformMediaSessionClient() { }
162     
163     virtual PlatformMediaSession::MediaType mediaType() const = 0;
164     virtual PlatformMediaSession::MediaType presentationType() const = 0;
165     virtual PlatformMediaSession::DisplayType displayType() const { return PlatformMediaSession::Normal; }
166
167     virtual void mayResumePlayback(bool shouldResume) = 0;
168     virtual void suspendPlayback() = 0;
169
170     virtual String mediaSessionTitle() const;
171     virtual double mediaSessionDuration() const;
172     virtual double mediaSessionCurrentTime() const;
173     
174     virtual bool canReceiveRemoteControlCommands() const = 0;
175     virtual void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType) = 0;
176
177     virtual void setShouldBufferData(bool) { }
178     virtual bool elementIsHidden() const { return false; }
179
180     virtual bool overrideBackgroundPlaybackRestriction() const = 0;
181
182     virtual void wirelessRoutesAvailableDidChange() { }
183     virtual void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) { }
184     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
185     virtual bool isPlayingToWirelessPlaybackTarget() const { return false; }
186     virtual void setShouldPlayToPlaybackTarget(bool) { }
187
188     virtual const Document* hostingDocument() const = 0;
189
190 protected:
191     virtual ~PlatformMediaSessionClient() { }
192 };
193
194 }
195
196 #endif // PlatformMediaSession_h