8021c4bdd870ccef4bfc6de7bd002b697d616272
[WebKit-https.git] / Source / WebCore / platform / audio / MediaSession.cpp
1 /*
2  * Copyright (C) 2014 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", this, stateName(m_state));
85
86     if (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", this, (int)flags, stateName(m_stateToRestore));
99
100     State stateToRestore = m_stateToRestore;
101     m_stateToRestore = Idle;
102     setState(Paused);
103
104     if (flags & MayResumePlaying && stateToRestore == Playing) {
105         LOG(Media, "MediaSession::endInterruption - resuming playback");
106         client().resumePlayback();
107     }
108 }
109
110 bool MediaSession::clientWillBeginPlayback()
111 {
112     setState(Playing);
113     MediaSessionManager::sharedManager().sessionWillBeginPlayback(*this);
114     updateClientDataBuffering();
115     return true;
116 }
117
118 bool MediaSession::clientWillPausePlayback()
119 {
120     LOG(Media, "MediaSession::clientWillPausePlayback(%p)- state = %s", this, stateName(m_state));
121     if (state() == Interrupted) {
122         if (!m_notifyingClient) {
123             m_stateToRestore = Paused;
124             LOG(Media, "      setting stateToRestore to \"Paused\"");
125         }
126         return false;
127     }
128     
129     setState(Paused);
130     MediaSessionManager::sharedManager().sessionWillEndPlayback(*this);
131     if (!m_clientDataBufferingTimer.isActive())
132         m_clientDataBufferingTimer.startOneShot(kClientDataBufferingTimerThrottleDelay);
133     return true;
134 }
135
136 void MediaSession::pauseSession()
137 {
138     LOG(Media, "MediaSession::pauseSession(%p)", this);
139     m_client.pausePlayback();
140 }
141
142 MediaSession::MediaType MediaSession::mediaType() const
143 {
144     return m_client.mediaType();
145 }
146
147 MediaSession::MediaType MediaSession::presentationType() const
148 {
149     return m_client.presentationType();
150 }
151
152 String MediaSession::title() const
153 {
154     return m_client.mediaSessionTitle();
155 }
156
157 double MediaSession::duration() const
158 {
159     return m_client.mediaSessionDuration();
160 }
161
162 double MediaSession::currentTime() const
163 {
164     return m_client.mediaSessionCurrentTime();
165 }
166     
167 bool MediaSession::canReceiveRemoteControlCommands() const
168 {
169     return m_client.canReceiveRemoteControlCommands();
170 }
171
172 void MediaSession::didReceiveRemoteControlCommand(RemoteControlCommandType command)
173 {
174     m_client.didReceiveRemoteControlCommand(command);
175 }
176
177 void MediaSession::visibilityChanged()
178 {
179     if (!m_clientDataBufferingTimer.isActive())
180         m_clientDataBufferingTimer.startOneShot(kClientDataBufferingTimerThrottleDelay);
181 }
182
183 void MediaSession::clientDataBufferingTimerFired(Timer &)
184 {
185     updateClientDataBuffering();
186 }
187
188 void MediaSession::updateClientDataBuffering()
189 {
190     if (m_clientDataBufferingTimer.isActive())
191         m_clientDataBufferingTimer.stop();
192
193     m_client.setShouldBufferData(MediaSessionManager::sharedManager().sessionCanLoadMedia(*this));
194 }
195
196 bool MediaSession::isHidden() const
197 {
198     return m_client.elementIsHidden();
199 }
200
201 MediaSession::DisplayType MediaSession::displayType() const
202 {
203     return m_client.displayType();
204 }
205
206 void MediaSession::wirelessRoutesAvailableDidChange() const
207 {
208     m_client.wirelessRoutesAvailableDidChange();
209 }
210
211 String MediaSessionClient::mediaSessionTitle() const
212 {
213     return String();
214 }
215
216 double MediaSessionClient::mediaSessionDuration() const
217 {
218     return MediaPlayer::invalidTime();
219 }
220
221 double MediaSessionClient::mediaSessionCurrentTime() const
222 {
223     return MediaPlayer::invalidTime();
224 }
225
226 }
227 #endif