Add WebKitAdditions extension point in HTMLMediaElement.
[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     enum RemoteControlCommandType {
118         NoCommand,
119         PlayCommand,
120         PauseCommand,
121         StopCommand,
122         TogglePlayPauseCommand,
123         BeginSeekingBackwardCommand,
124         EndSeekingBackwardCommand,
125         BeginSeekingForwardCommand,
126         EndSeekingForwardCommand,
127     };
128     bool canReceiveRemoteControlCommands() const;
129     void didReceiveRemoteControlCommand(RemoteControlCommandType);
130
131     enum DisplayType {
132         Normal,
133         Fullscreen,
134         Optimized,
135     };
136     DisplayType displayType() const;
137
138     bool isHidden() const;
139
140     bool shouldOverrideBackgroundLoadingRestriction() const;
141
142     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
143     virtual bool isPlayingToWirelessPlaybackTarget() const { return m_isPlayingToWirelessPlaybackTarget; }
144     void isPlayingToWirelessPlaybackTargetChanged(bool);
145
146 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
147     // MediaPlaybackTargetClient
148     void setPlaybackTarget(Ref<MediaPlaybackTarget>&&) override { }
149     void externalOutputDeviceAvailableDidChange(bool) override { }
150     void setShouldPlayToPlaybackTarget(bool) override { }
151 #endif
152
153 #if PLATFORM(IOS)
154     virtual bool requiresPlaybackTargetRouteMonitoring() const { return false; }
155 #endif
156
157     bool activeAudioSessionRequired();
158     bool canProduceAudio() const { return m_canProduceAudio; }
159     void setCanProduceAudio(bool);
160
161     void scheduleClientDataBufferingCheck();
162
163 protected:
164     PlatformMediaSessionClient& client() const { return m_client; }
165
166 private:
167     void clientDataBufferingTimerFired();
168     void updateClientDataBuffering();
169
170     PlatformMediaSessionClient& m_client;
171     Timer m_clientDataBufferingTimer;
172     State m_state;
173     State m_stateToRestore;
174     InterruptionType m_interruptionType { NoInterruption };
175     int m_interruptionCount { 0 };
176     bool m_notifyingClient;
177     bool m_isPlayingToWirelessPlaybackTarget { false };
178     bool m_canProduceAudio { false };
179
180     friend class PlatformMediaSessionManager;
181 };
182
183 class PlatformMediaSessionClient {
184     WTF_MAKE_NONCOPYABLE(PlatformMediaSessionClient);
185 public:
186     PlatformMediaSessionClient() { }
187     
188     virtual PlatformMediaSession::MediaType mediaType() const = 0;
189     virtual PlatformMediaSession::MediaType presentationType() const = 0;
190     virtual PlatformMediaSession::DisplayType displayType() const { return PlatformMediaSession::Normal; }
191     virtual PlatformMediaSession::CharacteristicsFlags characteristics() const = 0;
192
193     virtual void resumeAutoplaying() { }
194     virtual void mayResumePlayback(bool shouldResume) = 0;
195     virtual void suspendPlayback() = 0;
196
197 #if ENABLE(VIDEO)
198     virtual String mediaSessionTitle() const;
199     virtual double mediaSessionDuration() const;
200     virtual double mediaSessionCurrentTime() const;
201 #endif
202     
203     virtual bool canReceiveRemoteControlCommands() const = 0;
204     virtual void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType) = 0;
205
206     virtual void setShouldBufferData(bool) { }
207     virtual bool elementIsHidden() const { return false; }
208
209     virtual bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const = 0;
210     virtual bool shouldOverrideBackgroundLoadingRestriction() const { return false; }
211
212     virtual void wirelessRoutesAvailableDidChange() { }
213     virtual void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) { }
214     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
215     virtual bool isPlayingToWirelessPlaybackTarget() const { return false; }
216     virtual void setShouldPlayToPlaybackTarget(bool) { }
217
218     virtual const Document* hostingDocument() const = 0;
219
220 protected:
221     virtual ~PlatformMediaSessionClient() { }
222 };
223
224 }
225
226 #endif // PlatformMediaSession_h