Throw exceptions for invalid number of channels for ConvolverNode
[WebKit-https.git] / Source / WebCore / Modules / webaudio / ConvolverNode.cpp
1 /*
2  * Copyright (C) 2010, Google Inc. All rights reserved.
3  * Copyright (C) 2016, 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 "ConvolverNode.h"
31
32 #include "AudioBuffer.h"
33 #include "AudioContext.h"
34 #include "AudioNodeInput.h"
35 #include "AudioNodeOutput.h"
36 #include "ExceptionCode.h"
37 #include "Reverb.h"
38 #include <wtf/MainThread.h>
39
40 // Note about empirical tuning:
41 // The maximum FFT size affects reverb performance and accuracy.
42 // If the reverb is single-threaded and processes entirely in the real-time audio thread,
43 // it's important not to make this too high.  In this case 8192 is a good value.
44 // But, the Reverb object is multi-threaded, so we want this as high as possible without losing too much accuracy.
45 // Very large FFTs will have worse phase errors. Given these constraints 32768 is a good compromise.
46 const size_t MaxFFTSize = 32768;
47
48 namespace WebCore {
49
50 ConvolverNode::ConvolverNode(AudioContext& context, float sampleRate)
51     : AudioNode(context, sampleRate)
52     , m_normalize(true)
53 {
54     addInput(std::make_unique<AudioNodeInput>(this));
55     addOutput(std::make_unique<AudioNodeOutput>(this, 2));
56
57     // Node-specific default mixing rules.
58     m_channelCount = 2;
59     m_channelCountMode = ClampedMax;
60     m_channelInterpretation = AudioBus::Speakers;
61
62     setNodeType(NodeTypeConvolver);
63     
64     initialize();
65 }
66
67 ConvolverNode::~ConvolverNode()
68 {
69     uninitialize();
70 }
71
72 void ConvolverNode::process(size_t framesToProcess)
73 {
74     AudioBus* outputBus = output(0)->bus();
75     ASSERT(outputBus);
76
77     // Synchronize with possible dynamic changes to the impulse response.
78     std::unique_lock<Lock> lock(m_processMutex, std::try_to_lock);
79     if (!lock.owns_lock()) {
80         // Too bad - the try_lock() failed. We must be in the middle of setting a new impulse response.
81         outputBus->zero();
82         return;
83     }
84
85     if (!isInitialized() || !m_reverb.get())
86         outputBus->zero();
87     else {
88         // Process using the convolution engine.
89         // Note that we can handle the case where nothing is connected to the input, in which case we'll just feed silence into the convolver.
90         // FIXME: If we wanted to get fancy we could try to factor in the 'tail time' and stop processing once the tail dies down if
91         // we keep getting fed silence.
92         m_reverb->process(input(0)->bus(), outputBus, framesToProcess);
93     }
94 }
95
96 void ConvolverNode::reset()
97 {
98     std::lock_guard<Lock> lock(m_processMutex);
99     if (m_reverb)
100         m_reverb->reset();
101 }
102
103 void ConvolverNode::initialize()
104 {
105     if (isInitialized())
106         return;
107         
108     AudioNode::initialize();
109 }
110
111 void ConvolverNode::uninitialize()
112 {
113     if (!isInitialized())
114         return;
115
116     m_reverb = nullptr;
117     AudioNode::uninitialize();
118 }
119
120 void ConvolverNode::setBuffer(AudioBuffer* buffer, ExceptionCode& ec)
121 {
122     ASSERT(isMainThread());
123     
124     if (!buffer)
125         return;
126
127     if (buffer->sampleRate() != context().sampleRate()) {
128         ec = NOT_SUPPORTED_ERR;
129         return;
130     }
131
132     unsigned numberOfChannels = buffer->numberOfChannels();
133     size_t bufferLength = buffer->length();
134
135     // The current implementation supports only 1-, 2-, or 4-channel impulse responses, with the
136     // 4-channel response being interpreted as true-stereo (see Reverb class).
137     bool isChannelCountGood = (numberOfChannels == 1 || numberOfChannels == 2 || numberOfChannels == 4) && bufferLength;
138
139     if (!isChannelCountGood) {
140         ec = NOT_SUPPORTED_ERR;
141         return;
142     }
143
144     // Wrap the AudioBuffer by an AudioBus. It's an efficient pointer set and not a memcpy().
145     // This memory is simply used in the Reverb constructor and no reference to it is kept for later use in that class.
146     RefPtr<AudioBus> bufferBus = AudioBus::create(numberOfChannels, bufferLength, false);
147     for (unsigned i = 0; i < numberOfChannels; ++i)
148         bufferBus->setChannelMemory(i, buffer->getChannelData(i)->data(), bufferLength);
149
150     bufferBus->setSampleRate(buffer->sampleRate());
151
152     // Create the reverb with the given impulse response.
153     bool useBackgroundThreads = !context().isOfflineContext();
154     auto reverb = std::make_unique<Reverb>(bufferBus.get(), AudioNode::ProcessingSizeInFrames, MaxFFTSize, 2, useBackgroundThreads, m_normalize);
155
156     {
157         // Synchronize with process().
158         std::lock_guard<Lock> lock(m_processMutex);
159         m_reverb = WTFMove(reverb);
160         m_buffer = buffer;
161     }
162 }
163
164 AudioBuffer* ConvolverNode::buffer()
165 {
166     ASSERT(isMainThread());
167     return m_buffer.get();
168 }
169
170 double ConvolverNode::tailTime() const
171 {
172     return m_reverb ? m_reverb->impulseResponseLength() / static_cast<double>(sampleRate()) : 0;
173 }
174
175 double ConvolverNode::latencyTime() const
176 {
177     return m_reverb ? m_reverb->latencyFrames() / static_cast<double>(sampleRate()) : 0;
178 }
179
180 } // namespace WebCore
181
182 #endif // ENABLE(WEB_AUDIO)