1bba6cc7bbbc7a3b37891f56fb2ad1f691d0bcda
[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     void beginInterruption(InterruptionType);
90     void endInterruption(EndInterruptionFlags);
91
92     void clientWillBeginAutoplaying();
93     bool clientWillBeginPlayback();
94     bool clientWillPausePlayback();
95
96     void pauseSession();
97     
98     void visibilityChanged();
99
100 #if ENABLE(VIDEO)
101     String title() const;
102     double duration() const;
103     double currentTime() const;
104 #endif
105
106     enum RemoteControlCommandType {
107         NoCommand,
108         PlayCommand,
109         PauseCommand,
110         StopCommand,
111         TogglePlayPauseCommand,
112         BeginSeekingBackwardCommand,
113         EndSeekingBackwardCommand,
114         BeginSeekingForwardCommand,
115         EndSeekingForwardCommand,
116     };
117     bool canReceiveRemoteControlCommands() const;
118     void didReceiveRemoteControlCommand(RemoteControlCommandType);
119
120     enum DisplayType {
121         Normal,
122         Fullscreen,
123         Optimized,
124     };
125     DisplayType displayType() const;
126
127     bool isHidden() const;
128
129     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
130     virtual bool isPlayingToWirelessPlaybackTarget() const { return m_isPlayingToWirelessPlaybackTarget; }
131     void isPlayingToWirelessPlaybackTargetChanged(bool);
132
133 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
134     // MediaPlaybackTargetClient
135     virtual void setPlaybackTarget(Ref<MediaPlaybackTarget>&&) override { }
136     virtual void externalOutputDeviceAvailableDidChange(bool) override { }
137     virtual void setShouldPlayToPlaybackTarget(bool) override { }
138 #endif
139
140 #if PLATFORM(IOS)
141     virtual bool requiresPlaybackTargetRouteMonitoring() const { return false; }
142 #endif
143
144     bool activeAudioSessionRequired();
145     bool canProduceAudio() const { return m_canProduceAudio; }
146     void setCanProduceAudio(bool);
147
148 protected:
149     PlatformMediaSessionClient& client() const { return m_client; }
150
151 private:
152     void clientDataBufferingTimerFired();
153     void updateClientDataBuffering();
154
155     PlatformMediaSessionClient& m_client;
156     Timer m_clientDataBufferingTimer;
157     State m_state;
158     State m_stateToRestore;
159     InterruptionType m_interruptionType { NoInterruption };
160     int m_interruptionCount { 0 };
161     bool m_notifyingClient;
162     bool m_isPlayingToWirelessPlaybackTarget { false };
163     bool m_canProduceAudio { false };
164
165     friend class PlatformMediaSessionManager;
166 };
167
168 class PlatformMediaSessionClient {
169     WTF_MAKE_NONCOPYABLE(PlatformMediaSessionClient);
170 public:
171     PlatformMediaSessionClient() { }
172     
173     virtual PlatformMediaSession::MediaType mediaType() const = 0;
174     virtual PlatformMediaSession::MediaType presentationType() const = 0;
175     virtual PlatformMediaSession::DisplayType displayType() const { return PlatformMediaSession::Normal; }
176
177     virtual void resumeAutoplaying() { }
178     virtual void mayResumePlayback(bool shouldResume) = 0;
179     virtual void suspendPlayback() = 0;
180
181 #if ENABLE(VIDEO)
182     virtual String mediaSessionTitle() const;
183     virtual double mediaSessionDuration() const;
184     virtual double mediaSessionCurrentTime() const;
185 #endif
186     
187     virtual bool canReceiveRemoteControlCommands() const = 0;
188     virtual void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType) = 0;
189
190     virtual void setShouldBufferData(bool) { }
191     virtual bool elementIsHidden() const { return false; }
192
193     virtual bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const = 0;
194
195     virtual void wirelessRoutesAvailableDidChange() { }
196     virtual void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) { }
197     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
198     virtual bool isPlayingToWirelessPlaybackTarget() const { return false; }
199     virtual void setShouldPlayToPlaybackTarget(bool) { }
200
201     virtual const Document* hostingDocument() const = 0;
202
203 protected:
204     virtual ~PlatformMediaSessionClient() { }
205 };
206
207 }
208
209 #endif // PlatformMediaSession_h