Move more logic from AudioDestinationNode to its subclasses
[WebKit-https.git] / Source / WebCore / Modules / webaudio / DefaultAudioDestinationNode.cpp
1 /*
2  * Copyright (C) 2011, Google Inc. All rights reserved.
3  * Copyright (C) 2020-2021, Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1.  Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27
28 #if ENABLE(WEB_AUDIO)
29
30 #include "DefaultAudioDestinationNode.h"
31
32 #include "AudioContext.h"
33 #include "AudioDestination.h"
34 #include "AudioWorklet.h"
35 #include "AudioWorkletMessagingProxy.h"
36 #include "Logging.h"
37 #include "MediaStrategy.h"
38 #include "PlatformStrategies.h"
39 #include "ScriptExecutionContext.h"
40 #include "WorkerRunLoop.h"
41 #include <wtf/IsoMallocInlines.h>
42 #include <wtf/MainThread.h>
43
44 constexpr unsigned EnabledInputChannels = 2;
45
46 namespace WebCore {
47
48 WTF_MAKE_ISO_ALLOCATED_IMPL(DefaultAudioDestinationNode);
49
50 DefaultAudioDestinationNode::DefaultAudioDestinationNode(AudioContext& context, Optional<float> sampleRate)
51     : AudioDestinationNode(context, sampleRate.valueOr(AudioDestination::hardwareSampleRate()))
52 {
53     ASSERT(BaseAudioContext::isSupportedSampleRate(AudioDestination::hardwareSampleRate()));
54     initializeDefaultNodeOptions(2, ChannelCountMode::Explicit, ChannelInterpretation::Speakers);
55 }
56
57 DefaultAudioDestinationNode::~DefaultAudioDestinationNode()
58 {
59     uninitialize();
60 }
61
62 AudioContext& DefaultAudioDestinationNode::context()
63 {
64     return downcast<AudioContext>(AudioDestinationNode::context());
65 }
66
67 const AudioContext& DefaultAudioDestinationNode::context() const
68 {
69     return downcast<AudioContext>(AudioDestinationNode::context());
70 }
71
72 void DefaultAudioDestinationNode::initialize()
73 {
74     ASSERT(isMainThread()); 
75     if (isInitialized())
76         return;
77     ALWAYS_LOG(LOGIDENTIFIER);
78
79     createDestination();
80     AudioNode::initialize();
81 }
82
83 void DefaultAudioDestinationNode::uninitialize()
84 {
85     ASSERT(isMainThread()); 
86     if (!isInitialized())
87         return;
88
89     ALWAYS_LOG(LOGIDENTIFIER);
90     clearDestination();
91     m_numberOfInputChannels = 0;
92
93     AudioNode::uninitialize();
94 }
95
96 void DefaultAudioDestinationNode::clearDestination()
97 {
98     ASSERT(m_destination);
99     if (m_wasDestinationStarted) {
100         m_destination->stop();
101         m_wasDestinationStarted = false;
102     }
103     m_destination->clearCallback();
104     m_destination = nullptr;
105 }
106
107 void DefaultAudioDestinationNode::createDestination()
108 {
109     ALWAYS_LOG(LOGIDENTIFIER, "contextSampleRate = ", sampleRate(), ", hardwareSampleRate = ", AudioDestination::hardwareSampleRate());
110     ASSERT(!m_destination);
111     m_destination = platformStrategies()->mediaStrategy().createAudioDestination(*this, m_inputDeviceId, m_numberOfInputChannels, channelCount(), sampleRate());
112 }
113
114 void DefaultAudioDestinationNode::recreateDestination()
115 {
116     bool wasDestinationStarted = m_wasDestinationStarted;
117     clearDestination();
118     createDestination();
119     if (wasDestinationStarted) {
120         m_wasDestinationStarted = true;
121         m_destination->start(dispatchToRenderThreadFunction());
122     }
123 }
124
125 void DefaultAudioDestinationNode::enableInput(const String& inputDeviceId)
126 {
127     ALWAYS_LOG(LOGIDENTIFIER);
128
129     ASSERT(isMainThread());
130     if (m_numberOfInputChannels != EnabledInputChannels) {
131         m_numberOfInputChannels = EnabledInputChannels;
132         m_inputDeviceId = inputDeviceId;
133
134         if (isInitialized())
135             recreateDestination();
136     }
137 }
138
139 Function<void(Function<void()>&&)> DefaultAudioDestinationNode::dispatchToRenderThreadFunction()
140 {
141     if (auto* workletProxy = context().audioWorklet().proxy()) {
142         return [workletProxy = makeRef(*workletProxy)](Function<void()>&& function) {
143             workletProxy->postTaskForModeToWorkletGlobalScope([function = WTFMove(function)](ScriptExecutionContext&) mutable {
144                 function();
145             }, WorkerRunLoop::defaultMode());
146         };
147     }
148     return nullptr;
149 }
150
151 void DefaultAudioDestinationNode::startRendering(CompletionHandler<void(Optional<Exception>&&)>&& completionHandler)
152 {
153     ASSERT(isInitialized());
154     if (!isInitialized())
155         return completionHandler(Exception { InvalidStateError, "AudioDestinationNode is not initialized"_s });
156
157     auto innerCompletionHandler = [completionHandler = WTFMove(completionHandler)](bool success) mutable {
158         completionHandler(success ? WTF::nullopt : makeOptional(Exception { InvalidStateError, "Failed to start the audio device"_s }));
159     };
160
161     m_wasDestinationStarted = true;
162     m_destination->start(dispatchToRenderThreadFunction(), WTFMove(innerCompletionHandler));
163 }
164
165 void DefaultAudioDestinationNode::resume(CompletionHandler<void(Optional<Exception>&&)>&& completionHandler)
166 {
167     ASSERT(isInitialized());
168     if (!isInitialized()) {
169         context().postTask([completionHandler = WTFMove(completionHandler)]() mutable {
170             completionHandler(Exception { InvalidStateError, "AudioDestinationNode is not initialized"_s });
171         });
172         return;
173     }
174     m_wasDestinationStarted = true;
175     m_destination->start(dispatchToRenderThreadFunction(), [completionHandler = WTFMove(completionHandler)](bool success) mutable {
176         completionHandler(success ? WTF::nullopt : makeOptional(Exception { InvalidStateError, "Failed to start the audio device"_s }));
177     });
178 }
179
180 void DefaultAudioDestinationNode::suspend(CompletionHandler<void(Optional<Exception>&&)>&& completionHandler)
181 {
182     ASSERT(isInitialized());
183     if (!isInitialized()) {
184         context().postTask([completionHandler = WTFMove(completionHandler)]() mutable {
185             completionHandler(Exception { InvalidStateError, "AudioDestinationNode is not initialized"_s });
186         });
187         return;
188     }
189
190     m_wasDestinationStarted = false;
191     m_destination->stop([completionHandler = WTFMove(completionHandler)](bool success) mutable {
192         completionHandler(success ? WTF::nullopt : makeOptional(Exception { InvalidStateError, "Failed to stop the audio device"_s }));
193     });
194 }
195
196 void DefaultAudioDestinationNode::restartRendering()
197 {
198     if (!m_wasDestinationStarted)
199         return;
200
201     m_destination->stop();
202     m_destination->start(dispatchToRenderThreadFunction());
203 }
204
205 void DefaultAudioDestinationNode::close(CompletionHandler<void()>&& completionHandler)
206 {
207     ASSERT(isInitialized());
208     uninitialize();
209     context().postTask(WTFMove(completionHandler));
210 }
211
212 unsigned DefaultAudioDestinationNode::maxChannelCount() const
213 {
214     return AudioDestination::maxChannelCount();
215 }
216
217 ExceptionOr<void> DefaultAudioDestinationNode::setChannelCount(unsigned channelCount)
218 {
219     // The channelCount for the input to this node controls the actual number of channels we
220     // send to the audio hardware. It can only be set depending on the maximum number of
221     // channels supported by the hardware.
222
223     ASSERT(isMainThread());
224     ALWAYS_LOG(LOGIDENTIFIER, channelCount);
225
226     if (channelCount > maxChannelCount())
227         return Exception { IndexSizeError, "Channel count exceeds maximum limit"_s };
228
229     auto oldChannelCount = this->channelCount();
230     auto result = AudioNode::setChannelCount(channelCount);
231     if (result.hasException())
232         return result;
233
234     if (this->channelCount() != oldChannelCount && isInitialized())
235         recreateDestination();
236
237     return { };
238 }
239
240 unsigned DefaultAudioDestinationNode::framesPerBuffer() const
241 {
242     return m_destination ? m_destination->framesPerBuffer() : 0;
243 }
244
245 void DefaultAudioDestinationNode::render(AudioBus*, AudioBus* destinationBus, size_t numberOfFrames, const AudioIOPosition& outputPosition)
246 {
247     renderQuantum(destinationBus, numberOfFrames, outputPosition);
248
249     setIsSilent(destinationBus->isSilent());
250
251     // The reason we are handling mute after the call to setIsSilent() is because the muted state does
252     // not affect the audio destination node's effective playing state.
253     if (m_muted)
254         destinationBus->zero();
255 }
256
257 void DefaultAudioDestinationNode::setIsSilent(bool isSilent)
258 {
259     if (m_isSilent == isSilent)
260         return;
261
262     m_isSilent = isSilent;
263     updateIsEffectivelyPlayingAudio();
264 }
265
266 void DefaultAudioDestinationNode::isPlayingDidChange()
267 {
268     updateIsEffectivelyPlayingAudio();
269 }
270
271 void DefaultAudioDestinationNode::updateIsEffectivelyPlayingAudio()
272 {
273     bool isEffectivelyPlayingAudio = m_destination && m_destination->isPlaying() && !m_isSilent;
274     if (m_isEffectivelyPlayingAudio == isEffectivelyPlayingAudio)
275         return;
276
277     m_isEffectivelyPlayingAudio = isEffectivelyPlayingAudio;
278     context().isPlayingAudioDidChange();
279 }
280
281 } // namespace WebCore
282
283 #endif // ENABLE(WEB_AUDIO)