Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / platform / audio / ReverbConvolverStage.cpp
1 /*
2  * Copyright (C) 2010 Google 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  *
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  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30
31 #if ENABLE(WEB_AUDIO)
32
33 #include "ReverbConvolverStage.h"
34
35 #include "DirectConvolver.h"
36 #include "FFTConvolver.h"
37 #include "FFTFrame.h"
38 #include "VectorMath.h"
39 #include "ReverbAccumulationBuffer.h"
40 #include "ReverbConvolver.h"
41 #include "ReverbInputBuffer.h"
42
43 namespace WebCore {
44
45 using namespace VectorMath;
46
47 ReverbConvolverStage::ReverbConvolverStage(const float* impulseResponse, size_t, size_t reverbTotalLatency, size_t stageOffset, size_t stageLength,
48                                            size_t fftSize, size_t renderPhase, size_t renderSliceSize, ReverbAccumulationBuffer* accumulationBuffer, bool directMode)
49     : m_accumulationBuffer(accumulationBuffer)
50     , m_accumulationReadIndex(0)
51     , m_inputReadIndex(0)
52     , m_directMode(directMode)
53 {
54     ASSERT(impulseResponse);
55     ASSERT(accumulationBuffer);
56
57     if (!m_directMode) {
58         m_fftKernel = std::make_unique<FFTFrame>(fftSize);
59         m_fftKernel->doPaddedFFT(impulseResponse + stageOffset, stageLength);
60         m_fftConvolver = std::make_unique<FFTConvolver>(fftSize);
61     } else {
62         ASSERT(!stageOffset);
63         ASSERT(stageLength <= fftSize / 2);
64
65         m_directKernel = std::make_unique<AudioFloatArray>(fftSize / 2);
66         m_directKernel->copyToRange(impulseResponse, 0, stageLength);
67         m_directConvolver = std::make_unique<DirectConvolver>(renderSliceSize);
68     }
69     m_temporaryBuffer.allocate(renderSliceSize);
70
71     // The convolution stage at offset stageOffset needs to have a corresponding delay to cancel out the offset.
72     size_t totalDelay = stageOffset + reverbTotalLatency;
73
74     // But, the FFT convolution itself incurs fftSize / 2 latency, so subtract this out...
75     size_t halfSize = fftSize / 2;
76     if (!m_directMode) {
77         ASSERT(totalDelay >= halfSize);
78         if (totalDelay >= halfSize)
79             totalDelay -= halfSize;
80     }
81
82     // We divide up the total delay, into pre and post delay sections so that we can schedule at exactly the moment when the FFT will happen.
83     // This is coordinated with the other stages, so they don't all do their FFTs at the same time...
84     int maxPreDelayLength = std::min(halfSize, totalDelay);
85     m_preDelayLength = totalDelay > 0 ? renderPhase % maxPreDelayLength : 0;
86     if (m_preDelayLength > totalDelay)
87         m_preDelayLength = 0;
88
89     m_postDelayLength = totalDelay - m_preDelayLength;
90     m_preReadWriteIndex = 0;
91     m_framesProcessed = 0; // total frames processed so far
92
93     size_t delayBufferSize = m_preDelayLength < fftSize ? fftSize : m_preDelayLength;
94     delayBufferSize = delayBufferSize < renderSliceSize ? renderSliceSize : delayBufferSize;
95     m_preDelayBuffer.allocate(delayBufferSize);
96 }
97
98 ReverbConvolverStage::~ReverbConvolverStage() = default;
99
100 void ReverbConvolverStage::processInBackground(ReverbConvolver* convolver, size_t framesToProcess)
101 {
102     ReverbInputBuffer* inputBuffer = convolver->inputBuffer();
103     float* source = inputBuffer->directReadFrom(&m_inputReadIndex, framesToProcess);
104     process(source, framesToProcess);
105 }
106
107 void ReverbConvolverStage::process(const float* source, size_t framesToProcess)
108 {
109     ASSERT(source);
110     if (!source)
111         return;
112     
113     // Deal with pre-delay stream : note special handling of zero delay.
114
115     const float* preDelayedSource;
116     float* preDelayedDestination;
117     float* temporaryBuffer;
118     bool isTemporaryBufferSafe = false;
119     if (m_preDelayLength > 0) {
120         // Handles both the read case (call to process() ) and the write case (memcpy() )
121         bool isPreDelaySafe = m_preReadWriteIndex + framesToProcess <= m_preDelayBuffer.size();
122         ASSERT(isPreDelaySafe);
123         if (!isPreDelaySafe)
124             return;
125
126         isTemporaryBufferSafe = framesToProcess <= m_temporaryBuffer.size();
127
128         preDelayedDestination = m_preDelayBuffer.data() + m_preReadWriteIndex;
129         preDelayedSource = preDelayedDestination;
130         temporaryBuffer = m_temporaryBuffer.data();        
131     } else {
132         // Zero delay
133         preDelayedDestination = 0;
134         preDelayedSource = source;
135         temporaryBuffer = m_preDelayBuffer.data();
136         
137         isTemporaryBufferSafe = framesToProcess <= m_preDelayBuffer.size();
138     }
139     
140     ASSERT(isTemporaryBufferSafe);
141     if (!isTemporaryBufferSafe)
142         return;
143
144     if (m_framesProcessed < m_preDelayLength) {
145         // For the first m_preDelayLength frames don't process the convolver, instead simply buffer in the pre-delay.
146         // But while buffering the pre-delay, we still need to update our index.
147         m_accumulationBuffer->updateReadIndex(&m_accumulationReadIndex, framesToProcess);
148     } else {
149         // Now, run the convolution (into the delay buffer).
150         // An expensive FFT will happen every fftSize / 2 frames.
151         // We process in-place here...
152         if (!m_directMode)
153             m_fftConvolver->process(m_fftKernel.get(), preDelayedSource, temporaryBuffer, framesToProcess);
154         else
155             m_directConvolver->process(m_directKernel.get(), preDelayedSource, temporaryBuffer, framesToProcess);
156
157         // Now accumulate into reverb's accumulation buffer.
158         m_accumulationBuffer->accumulate(temporaryBuffer, framesToProcess, &m_accumulationReadIndex, m_postDelayLength);
159     }
160
161     // Finally copy input to pre-delay.
162     if (m_preDelayLength > 0) {
163         memcpy(preDelayedDestination, source, sizeof(float) * framesToProcess);
164         m_preReadWriteIndex += framesToProcess;
165
166         ASSERT(m_preReadWriteIndex <= m_preDelayLength);
167         if (m_preReadWriteIndex >= m_preDelayLength)
168             m_preReadWriteIndex = 0;
169     }
170
171     m_framesProcessed += framesToProcess;
172 }
173
174 void ReverbConvolverStage::reset()
175 {
176     if (!m_directMode)
177         m_fftConvolver->reset();
178     else
179         m_directConvolver->reset();
180     m_preDelayBuffer.zero();
181     m_accumulationReadIndex = 0;
182     m_inputReadIndex = 0;
183     m_framesProcessed = 0;
184 }
185
186 } // namespace WebCore
187
188 #endif // ENABLE(WEB_AUDIO)