2011-06-08 Chris Rogers <crogers@google.com>
[WebKit-https.git] / Source / WebCore / platform / audio / Biquad.h
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 #ifndef Biquad_h
30 #define Biquad_h
31
32 #include "AudioArray.h"
33 #include <sys/types.h>
34 #include <wtf/Complex.h>
35 #include <wtf/Platform.h>
36  
37 namespace WebCore {
38
39 // A basic biquad (two-zero / two-pole digital filter)
40 //
41 // It can be configured to a number of common and very useful filters:
42 //    lowpass, highpass, shelving, parameteric, notch, allpass, ...
43
44 class Biquad {
45 public:   
46     Biquad();
47     virtual ~Biquad() { }
48
49     void process(const float* sourceP, float* destP, size_t framesToProcess);
50
51     // frequency is 0 - 1 normalized, resonance and dbGain are in decibels.
52     // Q is a unitless quality factor.
53     void setLowpassParams(double frequency, double resonance);
54     void setHighpassParams(double frequency, double resonance);
55     void setBandpassParams(double frequency, double Q);
56     void setLowShelfParams(double frequency, double dbGain);
57     void setHighShelfParams(double frequency, double dbGain);
58     void setPeakingParams(double frequency, double Q, double dbGain);
59     void setAllpassParams(double frequency, double Q);
60     void setNotchParams(double frequency, double Q);
61
62     // Set the biquad coefficients given a single zero (other zero will be conjugate)
63     // and a single pole (other pole will be conjugate)
64     void setZeroPolePairs(const Complex& zero, const Complex& pole);
65
66     // Set the biquad coefficients given a single pole (other pole will be conjugate)
67     // (The zeroes will be the inverse of the poles)
68     void setAllpassPole(const Complex& pole);
69
70     // Resets filter state
71     void reset();
72
73 private:
74     void setNormalizedCoefficients(double b0, double b1, double b2, double a0, double a1, double a2);
75
76     // Filter coefficients
77     double m_b0;
78     double m_b1;
79     double m_b2;
80     double m_a1;
81     double m_a2;
82
83     // Filter memory
84     double m_x1; // input delayed by 1 sample
85     double m_x2; // input delayed by 2 samples
86     double m_y1; // output delayed by 1 sample
87     double m_y2; // output delayed by 2 samples
88
89 #if OS(DARWIN)
90     void processFast(const float* sourceP, float* destP, size_t framesToProcess);
91     void processSliceFast(double* sourceP, double* destP, double* coefficientsP, size_t framesToProcess);
92
93     AudioDoubleArray m_inputBuffer;
94     AudioDoubleArray m_outputBuffer;
95 #endif
96 };
97
98 } // namespace WebCore
99
100 #endif // Biquad_h