[Mac] Update AirPlay handling
[WebKit-https.git] / Source / WebCore / platform / audio / MediaSession.cpp
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 #include "config.h"
27 #include "MediaSession.h"
28
29 #if ENABLE(VIDEO)
30 #include "HTMLMediaElement.h"
31 #include "Logging.h"
32 #include "MediaPlayer.h"
33 #include "MediaSessionManager.h"
34
35 namespace WebCore {
36
37 const double kClientDataBufferingTimerThrottleDelay = 0.1;
38
39 #if !LOG_DISABLED
40 static const char* stateName(MediaSession::State state)
41 {
42 #define CASE(state) case MediaSession::state: return #state
43     switch (state) {
44     CASE(Idle);
45     CASE(Playing);
46     CASE(Paused);
47     CASE(Interrupted);
48     }
49
50     ASSERT_NOT_REACHED();
51     return "";
52 }
53 #endif
54
55 std::unique_ptr<MediaSession> MediaSession::create(MediaSessionClient& client)
56 {
57     return std::make_unique<MediaSession>(client);
58 }
59
60 MediaSession::MediaSession(MediaSessionClient& client)
61     : m_client(client)
62     , m_clientDataBufferingTimer(*this, &MediaSession::clientDataBufferingTimerFired)
63     , m_state(Idle)
64     , m_stateToRestore(Idle)
65     , m_notifyingClient(false)
66 {
67     ASSERT(m_client.mediaType() >= None && m_client.mediaType() <= WebAudio);
68     MediaSessionManager::sharedManager().addSession(*this);
69 }
70
71 MediaSession::~MediaSession()
72 {
73     MediaSessionManager::sharedManager().removeSession(*this);
74 }
75
76 void MediaSession::setState(State state)
77 {
78     LOG(Media, "MediaSession::setState(%p) - %s", this, stateName(state));
79     m_state = state;
80 }
81
82 void MediaSession::beginInterruption(InterruptionType type)
83 {
84     LOG(Media, "MediaSession::beginInterruption(%p), state = %s, interruption count = %i", this, stateName(m_state), m_interruptionCount);
85
86     if (++m_interruptionCount > 1 || (type == EnteringBackground && client().overrideBackgroundPlaybackRestriction()))
87         return;
88
89     m_stateToRestore = state();
90     m_notifyingClient = true;
91     client().pausePlayback();
92     setState(Interrupted);
93     m_notifyingClient = false;
94 }
95
96 void MediaSession::endInterruption(EndInterruptionFlags flags)
97 {
98     LOG(Media, "MediaSession::endInterruption(%p) - flags = %i, stateToRestore = %s, interruption count = %i", this, (int)flags, stateName(m_stateToRestore), m_interruptionCount);
99
100     if (!m_interruptionCount) {
101         LOG(Media, "MediaSession::endInterruption(%p) - !! ignoring spurious interruption end !!", this);
102         return;
103     }
104
105     if (--m_interruptionCount)
106         return;
107
108     State stateToRestore = m_stateToRestore;
109     m_stateToRestore = Idle;
110     setState(Paused);
111
112     if (flags & MayResumePlaying && stateToRestore == Playing) {
113         LOG(Media, "MediaSession::endInterruption - resuming playback");
114         client().resumePlayback();
115     }
116 }
117
118 bool MediaSession::clientWillBeginPlayback()
119 {
120     setState(Playing);
121     MediaSessionManager::sharedManager().sessionWillBeginPlayback(*this);
122     updateClientDataBuffering();
123     return true;
124 }
125
126 bool MediaSession::clientWillPausePlayback()
127 {
128     LOG(Media, "MediaSession::clientWillPausePlayback(%p)- state = %s", this, stateName(m_state));
129     if (state() == Interrupted) {
130         if (!m_notifyingClient) {
131             m_stateToRestore = Paused;
132             LOG(Media, "      setting stateToRestore to \"Paused\"");
133         }
134         return false;
135     }
136     
137     setState(Paused);
138     MediaSessionManager::sharedManager().sessionWillEndPlayback(*this);
139     if (!m_clientDataBufferingTimer.isActive())
140         m_clientDataBufferingTimer.startOneShot(kClientDataBufferingTimerThrottleDelay);
141     return true;
142 }
143
144 void MediaSession::pauseSession()
145 {
146     LOG(Media, "MediaSession::pauseSession(%p)", this);
147     m_client.pausePlayback();
148 }
149
150 MediaSession::MediaType MediaSession::mediaType() const
151 {
152     return m_client.mediaType();
153 }
154
155 MediaSession::MediaType MediaSession::presentationType() const
156 {
157     return m_client.presentationType();
158 }
159
160 String MediaSession::title() const
161 {
162     return m_client.mediaSessionTitle();
163 }
164
165 double MediaSession::duration() const
166 {
167     return m_client.mediaSessionDuration();
168 }
169
170 double MediaSession::currentTime() const
171 {
172     return m_client.mediaSessionCurrentTime();
173 }
174     
175 bool MediaSession::canReceiveRemoteControlCommands() const
176 {
177     return m_client.canReceiveRemoteControlCommands();
178 }
179
180 void MediaSession::didReceiveRemoteControlCommand(RemoteControlCommandType command)
181 {
182     m_client.didReceiveRemoteControlCommand(command);
183 }
184
185 void MediaSession::visibilityChanged()
186 {
187     if (!m_clientDataBufferingTimer.isActive())
188         m_clientDataBufferingTimer.startOneShot(kClientDataBufferingTimerThrottleDelay);
189 }
190
191 void MediaSession::clientDataBufferingTimerFired()
192 {
193     LOG(Media, "MediaSession::clientDataBufferingTimerFired(%p)- visible = %s", this, m_client.elementIsHidden() ? "false" : "true");
194
195     updateClientDataBuffering();
196
197     if (m_state != Playing || !m_client.elementIsHidden())
198         return;
199
200     MediaSessionManager::SessionRestrictions restrictions = MediaSessionManager::sharedManager().restrictions(mediaType());
201     if ((restrictions & MediaSessionManager::BackgroundTabPlaybackRestricted) == MediaSessionManager::BackgroundTabPlaybackRestricted)
202         pauseSession();
203 }
204
205 void MediaSession::updateClientDataBuffering()
206 {
207     if (m_clientDataBufferingTimer.isActive())
208         m_clientDataBufferingTimer.stop();
209
210     m_client.setShouldBufferData(MediaSessionManager::sharedManager().sessionCanLoadMedia(*this));
211 }
212
213 bool MediaSession::isHidden() const
214 {
215     return m_client.elementIsHidden();
216 }
217
218 MediaSession::DisplayType MediaSession::displayType() const
219 {
220     return m_client.displayType();
221 }
222
223 String MediaSessionClient::mediaSessionTitle() const
224 {
225     return String();
226 }
227
228 double MediaSessionClient::mediaSessionDuration() const
229 {
230     return MediaPlayer::invalidTime();
231 }
232
233 double MediaSessionClient::mediaSessionCurrentTime() const
234 {
235     return MediaPlayer::invalidTime();
236 }
237
238 }
239 #endif