Add methods to compute magnitude and phase response for biquads
[WebKit-https.git] / Source / WebCore / platform / audio / Biquad.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 Computer, 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 "Biquad.h"
34
35 #include "DenormalDisabler.h"
36 #include <algorithm>
37 #include <stdio.h>
38 #include <wtf/MathExtras.h>
39
40 #if OS(DARWIN)
41 #include <Accelerate/Accelerate.h>
42 #endif
43
44 namespace WebCore {
45
46 const int kBufferSize = 1024;
47
48 Biquad::Biquad()
49 {
50 #if OS(DARWIN)
51     // Allocate two samples more for filter history
52     m_inputBuffer.allocate(kBufferSize + 2);
53     m_outputBuffer.allocate(kBufferSize + 2);
54 #endif
55
56     // Initialize as pass-thru (straight-wire, no filter effect)
57     m_b0 = 1;
58     m_b1 = 0;
59     m_b2 = 0;
60     m_a1 = 0;
61     m_a2 = 0;
62
63     reset(); // clear filter memory
64 }
65
66 void Biquad::process(const float* sourceP, float* destP, size_t framesToProcess)
67 {
68 #if OS(DARWIN)
69     // Use vecLib if available
70     processFast(sourceP, destP, framesToProcess);
71 #else
72     int n = framesToProcess;
73
74     // Create local copies of member variables
75     double x1 = m_x1;
76     double x2 = m_x2;
77     double y1 = m_y1;
78     double y2 = m_y2;
79
80     double b0 = m_b0;
81     double b1 = m_b1;
82     double b2 = m_b2;
83     double a1 = m_a1;
84     double a2 = m_a2;
85
86     while (n--) {
87         // FIXME: this can be optimized by pipelining the multiply adds...
88         float x = *sourceP++;
89         float y = b0*x + b1*x1 + b2*x2 - a1*y1 - a2*y2;
90
91         *destP++ = y;
92
93         // Update state variables
94         x2 = x1;
95         x1 = x;
96         y2 = y1;
97         y1 = y;
98     }
99
100     // Local variables back to member. Flush denormals here so we
101     // don't slow down the inner loop above.
102     m_x1 = DenormalDisabler::flushDenormalFloatToZero(x1);
103     m_x2 = DenormalDisabler::flushDenormalFloatToZero(x2);
104     m_y1 = DenormalDisabler::flushDenormalFloatToZero(y1);
105     m_y2 = DenormalDisabler::flushDenormalFloatToZero(y2);
106
107     m_b0 = b0;
108     m_b1 = b1;
109     m_b2 = b2;
110     m_a1 = a1;
111     m_a2 = a2;
112 #endif
113 }
114
115 #if OS(DARWIN)
116
117 // Here we have optimized version using Accelerate.framework
118
119 void Biquad::processFast(const float* sourceP, float* destP, size_t framesToProcess)
120 {
121     double filterCoefficients[5];
122     filterCoefficients[0] = m_b0;
123     filterCoefficients[1] = m_b1;
124     filterCoefficients[2] = m_b2;
125     filterCoefficients[3] = m_a1;
126     filterCoefficients[4] = m_a2;
127
128     double* inputP = m_inputBuffer.data();
129     double* outputP = m_outputBuffer.data();
130
131     double* input2P = inputP + 2;
132     double* output2P = outputP + 2;
133
134     // Break up processing into smaller slices (kBufferSize) if necessary.
135
136     int n = framesToProcess;
137
138     while (n > 0) {
139         int framesThisTime = n < kBufferSize ? n : kBufferSize;
140
141         // Copy input to input buffer
142         for (int i = 0; i < framesThisTime; ++i)
143             input2P[i] = *sourceP++;
144
145         processSliceFast(inputP, outputP, filterCoefficients, framesThisTime);
146
147         // Copy output buffer to output (converts float -> double).
148         for (int i = 0; i < framesThisTime; ++i)
149             *destP++ = static_cast<float>(output2P[i]);
150
151         n -= framesThisTime;
152     }
153 }
154
155 void Biquad::processSliceFast(double* sourceP, double* destP, double* coefficientsP, size_t framesToProcess)
156 {
157     // Use double-precision for filter stability
158     vDSP_deq22D(sourceP, 1, coefficientsP, destP, 1, framesToProcess);
159
160     // Save history.  Note that sourceP and destP reference m_inputBuffer and m_outputBuffer respectively.
161     // These buffers are allocated (in the constructor) with space for two extra samples so it's OK to access
162     // array values two beyond framesToProcess.
163     sourceP[0] = sourceP[framesToProcess - 2 + 2];
164     sourceP[1] = sourceP[framesToProcess - 1 + 2];
165     destP[0] = destP[framesToProcess - 2 + 2];
166     destP[1] = destP[framesToProcess - 1 + 2];
167 }
168
169 #endif // OS(DARWIN)
170
171
172 void Biquad::reset()
173 {
174     m_x1 = m_x2 = m_y1 = m_y2 = 0;
175
176 #if OS(DARWIN)
177     // Two extra samples for filter history
178     double* inputP = m_inputBuffer.data();
179     inputP[0] = 0;
180     inputP[1] = 0;
181
182     double* outputP = m_outputBuffer.data();
183     outputP[0] = 0;
184     outputP[1] = 0;
185 #endif
186 }
187
188 void Biquad::setLowpassParams(double cutoff, double resonance)
189 {
190     resonance = std::max(0.0, resonance); // can't go negative
191
192     double g = pow(10.0, 0.05 * resonance);
193     double d = sqrt((4 - sqrt(16 - 16 / (g * g))) / 2);
194
195     // Compute biquad coefficients for lopass filter
196     double theta = piDouble * cutoff;
197     double sn = 0.5 * d * sin(theta);
198     double beta = 0.5 * (1 - sn) / (1 + sn);
199     double gamma = (0.5 + beta) * cos(theta);
200     double alpha = 0.25 * (0.5 + beta - gamma);
201
202     m_b0 = 2 * alpha;
203     m_b1 = 2 * 2 * alpha;
204     m_b2 = 2 * alpha;
205     m_a1 = 2 * -gamma;
206     m_a2 = 2 * beta;
207 }
208
209 void Biquad::setHighpassParams(double cutoff, double resonance)
210 {
211     resonance = std::max(0.0, resonance); // can't go negative
212
213     double g = pow(10.0, 0.05 * resonance);
214     double d = sqrt((4 - sqrt(16 - 16 / (g * g))) / 2);
215
216     // Compute biquad coefficients for highpass filter
217     double theta = piDouble * cutoff;
218     double sn = 0.5 * d * sin(theta);
219     double beta = 0.5 * (1 - sn) / (1 + sn);
220     double gamma = (0.5 + beta) * cos(theta);
221     double alpha = 0.25 * (0.5 + beta + gamma);
222
223     m_b0 = 2 * alpha;
224     m_b1 = 2 * -2 * alpha;
225     m_b2 = 2 * alpha;
226     m_a1 = 2 * -gamma;
227     m_a2 = 2 * beta;
228 }
229
230 void Biquad::setNormalizedCoefficients(double b0, double b1, double b2, double a0, double a1, double a2)
231 {
232     double a0Inverse = 1 / a0;
233     
234     m_b0 = b0 * a0Inverse;
235     m_b1 = b1 * a0Inverse;
236     m_b2 = b2 * a0Inverse;
237     m_a1 = a1 * a0Inverse;
238     m_a2 = a2 * a0Inverse;
239 }
240
241 void Biquad::setLowShelfParams(double frequency, double dbGain)
242 {
243     double w0 = piDouble * frequency;
244
245     double A = pow(10.0, dbGain / 40);
246     double S = 1; // filter slope (1 is max value)
247     double alpha = 0.5 * sin(w0) * sqrt((A + 1 / A) * (1 / S - 1) + 2);
248
249     double k = cos(w0);
250     double k2 = 2 * sqrt(A) * alpha;
251
252     double aPlusOne = A + 1;
253     double aMinusOne = A - 1;
254     
255     double b0 = A * (aPlusOne - aMinusOne * k + k2);
256     double b1 = 2 * A * (aMinusOne - aPlusOne * k);
257     double b2 = A * (aPlusOne - aMinusOne * k - k2);
258     double a0 = aPlusOne + aMinusOne * k + k2;
259     double a1 = -2 * (aMinusOne + aPlusOne * k);
260     double a2 = aPlusOne + aMinusOne * k - k2;
261
262     setNormalizedCoefficients(b0, b1, b2, a0, a1, a2);
263 }
264
265 void Biquad::setHighShelfParams(double frequency, double dbGain)
266 {
267     double w0 = piDouble * frequency;
268
269     double A = pow(10.0, dbGain / 40);
270     double S = 1; // filter slope (1 is max value)
271     double alpha = 0.5 * sin(w0) * sqrt((A + 1 / A) * (1 / S - 1) + 2);
272
273     double k = cos(w0);
274     double k2 = 2 * sqrt(A) * alpha;
275
276     double aPlusOne = A + 1;
277     double aMinusOne = A - 1;
278     
279     double b0 = A * (aPlusOne + aMinusOne * k + k2);
280     double b1 = -2 * A * (aMinusOne + aPlusOne * k);
281     double b2 = A * (aPlusOne + aMinusOne * k - k2);
282     double a0 = aPlusOne - aMinusOne * k + k2;
283     double a1 = 2 * (aMinusOne - aPlusOne * k);
284     double a2 = aPlusOne - aMinusOne * k - k2;
285
286     setNormalizedCoefficients(b0, b1, b2, a0, a1, a2);
287 }
288
289 void Biquad::setPeakingParams(double frequency, double Q, double dbGain)
290 {
291     double w0 = piDouble * frequency;
292     double alpha = sin(w0) / (2 * Q);
293     double A = pow(10.0, dbGain / 40);
294
295     double k = cos(w0);
296
297     double b0 = 1 + alpha * A;
298     double b1 = -2 * k;
299     double b2 = 1 - alpha * A;
300     double a0 = 1 + alpha / A;
301     double a1 = -2 * k;
302     double a2 = 1 - alpha / A;
303
304     setNormalizedCoefficients(b0, b1, b2, a0, a1, a2);
305 }
306
307 void Biquad::setAllpassParams(double frequency, double Q)
308 {
309     double w0 = piDouble * frequency;
310     double alpha = sin(w0) / (2 * Q);
311
312     double k = cos(w0);
313
314     double b0 = 1 - alpha;
315     double b1 = -2 * k;
316     double b2 = 1 + alpha;
317     double a0 = 1 + alpha;
318     double a1 = -2 * k;
319     double a2 = 1 - alpha;
320
321     setNormalizedCoefficients(b0, b1, b2, a0, a1, a2);
322 }
323
324 void Biquad::setNotchParams(double frequency, double Q)
325 {
326     double w0 = piDouble * frequency;
327     double alpha = sin(w0) / (2 * Q);
328
329     double k = cos(w0);
330
331     double b0 = 1;
332     double b1 = -2 * k;
333     double b2 = 1;
334     double a0 = 1 + alpha;
335     double a1 = -2 * k;
336     double a2 = 1 - alpha;
337
338     setNormalizedCoefficients(b0, b1, b2, a0, a1, a2);
339 }
340
341 void Biquad::setBandpassParams(double frequency, double Q)
342 {
343     double w0 = piDouble * frequency;
344     double alpha = sin(w0) / (2 * Q);
345
346     double k = cos(w0);
347     
348     double b0 = alpha;
349     double b1 = 0;
350     double b2 = -alpha;
351     double a0 = 1 + alpha;
352     double a1 = -2 * k;
353     double a2 = 1 - alpha;
354
355     setNormalizedCoefficients(b0, b1, b2, a0, a1, a2);
356 }
357
358 void Biquad::setZeroPolePairs(const Complex &zero, const Complex &pole)
359 {
360     m_b0 = 1;
361     m_b1 = -2 * zero.real();
362
363     double zeroMag = abs(zero);
364     m_b2 = zeroMag * zeroMag;
365
366     m_a1 = -2 * pole.real();
367
368     double poleMag = abs(pole);
369     m_a2 = poleMag * poleMag;
370 }
371
372 void Biquad::setAllpassPole(const Complex &pole)
373 {
374     Complex zero = Complex(1, 0) / pole;
375     setZeroPolePairs(zero, pole);
376 }
377
378 void Biquad::getFrequencyResponse(int nFrequencies,
379                                   const float* frequency,
380                                   float* magResponse,
381                                   float* phaseResponse)
382 {
383     // Evaluate the Z-transform of the filter at given normalized
384     // frequency from 0 to 1.  (1 corresponds to the Nyquist
385     // frequency.)
386     //
387     // The z-transform of the filter is
388     //
389     // H(z) = (b0 + b1*z^(-1) + b2*z^(-2))/(1 + a1*z^(-1) + a2*z^(-2))
390     //
391     // Evaluate as
392     //
393     // b0 + (b1 + b2*z1)*z1
394     // --------------------
395     // 1 + (a1 + a2*z1)*z1
396     //
397     // with z1 = 1/z and z = exp(j*pi*frequency). Hence z1 = exp(-j*pi*frequency)
398
399     // Make local copies of the coefficients as a micro-optimization.
400     double b0 = m_b0;
401     double b1 = m_b1;
402     double b2 = m_b2;
403     double a1 = m_a1;
404     double a2 = m_a2;
405     
406     for (int k = 0; k < nFrequencies; ++k) {
407         double omega = -piDouble * frequency[k];
408         Complex z = Complex(cos(omega), sin(omega));
409         Complex numerator = b0 + (b1 + b2 * z) * z;
410         Complex denominator = Complex(1, 0) + (a1 + a2 * z) * z;
411         Complex response = numerator / denominator;
412         magResponse[k] = static_cast<float>(abs(response));
413         phaseResponse[k] = static_cast<float>(atan2(imag(response), real(response)));
414     }
415 }
416
417 } // namespace WebCore
418
419 #endif // ENABLE(WEB_AUDIO)