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