Make Remote Control commands testable
[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 #include "HTMLMediaElement.h"
30 #include "Logging.h"
31 #include "MediaPlayer.h"
32 #include "MediaSessionManager.h"
33
34 namespace WebCore {
35
36 #if !LOG_DISABLED
37 static const char* stateName(MediaSession::State state)
38 {
39 #define CASE(state) case MediaSession::state: return #state
40     switch (state) {
41     CASE(Idle);
42     CASE(Playing);
43     CASE(Paused);
44     CASE(Interrupted);
45     }
46
47     ASSERT_NOT_REACHED();
48     return "";
49 }
50 #endif
51
52 std::unique_ptr<MediaSession> MediaSession::create(MediaSessionClient& client)
53 {
54     return std::make_unique<MediaSession>(client);
55 }
56
57 MediaSession::MediaSession(MediaSessionClient& client)
58     : m_client(client)
59     , m_state(Idle)
60     , m_stateToRestore(Idle)
61     , m_notifyingClient(false)
62 {
63     ASSERT(m_client.mediaType() >= None && m_client.mediaType() <= WebAudio);
64     MediaSessionManager::sharedManager().addSession(*this);
65 }
66
67 MediaSession::~MediaSession()
68 {
69     MediaSessionManager::sharedManager().removeSession(*this);
70 }
71
72 void MediaSession::setState(State state)
73 {
74     LOG(Media, "MediaSession::setState(%p) - %s", this, stateName(state));
75     m_state = state;
76 }
77
78 void MediaSession::beginInterruption()
79 {
80     LOG(Media, "MediaSession::beginInterruption(%p), state = %s", this, stateName(m_state));
81
82     m_stateToRestore = state();
83     m_notifyingClient = true;
84     client().pausePlayback();
85     setState(Interrupted);
86     m_notifyingClient = false;
87 }
88
89 void MediaSession::endInterruption(EndInterruptionFlags flags)
90 {
91     LOG(Media, "MediaSession::endInterruption(%p) - flags = %i, stateToRestore = %s", this, (int)flags, stateName(m_stateToRestore));
92
93     State stateToRestore = m_stateToRestore;
94     m_stateToRestore = Idle;
95     setState(Paused);
96
97     if (flags & MayResumePlaying && stateToRestore == Playing) {
98         LOG(Media, "MediaSession::endInterruption - resuming playback");
99         client().resumePlayback();
100     }
101 }
102
103 bool MediaSession::clientWillBeginPlayback()
104 {
105     setState(Playing);
106     MediaSessionManager::sharedManager().sessionWillBeginPlayback(*this);
107     return true;
108 }
109
110 bool MediaSession::clientWillPausePlayback()
111 {
112     LOG(Media, "MediaSession::clientWillPausePlayback(%p)- state = %s", this, stateName(m_state));
113     if (state() == Interrupted) {
114         if (!m_notifyingClient) {
115             m_stateToRestore = Paused;
116             LOG(Media, "      setting stateToRestore to \"Paused\"");
117         }
118         return false;
119     }
120     
121     setState(Paused);
122     MediaSessionManager::sharedManager().sessionWillEndPlayback(*this);
123     return true;
124 }
125
126 void MediaSession::pauseSession()
127 {
128     LOG(Media, "MediaSession::pauseSession(%p)", this);
129     m_client.pausePlayback();
130 }
131
132 MediaSession::MediaType MediaSession::mediaType() const
133 {
134     return m_client.mediaType();
135 }
136
137 String MediaSession::title() const
138 {
139     return m_client.mediaSessionTitle();
140 }
141
142 double MediaSession::duration() const
143 {
144     return m_client.mediaSessionDuration();
145 }
146
147 double MediaSession::currentTime() const
148 {
149     return m_client.mediaSessionCurrentTime();
150 }
151     
152 bool MediaSession::canReceiveRemoteControlCommands() const
153 {
154     return m_client.canReceiveRemoteControlCommands();
155 }
156
157 void MediaSession::didReceiveRemoteControlCommand(RemoteControlCommandType command)
158 {
159     m_client.didReceiveRemoteControlCommand(command);
160 }
161     
162 String MediaSessionClient::mediaSessionTitle() const
163 {
164     return String();
165 }
166
167 double MediaSessionClient::mediaSessionDuration() const
168 {
169     return MediaPlayer::invalidTime();
170 }
171
172 double MediaSessionClient::mediaSessionCurrentTime() const
173 {
174     return MediaPlayer::invalidTime();
175 }
176
177 }