Merging trunk up to r39447.
[blender.git] / intern / audaspace / FX / AUD_ButterworthFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * Audaspace is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/FX/AUD_ButterworthFactory.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_BUTTERWORTHFACTORY
33 #define AUD_BUTTERWORTHFACTORY
34
35 #include "AUD_DynamicIIRFilterFactory.h"
36
37 /**
38  * This factory creates a butterworth lowpass filter reader.
39  */
40 class AUD_ButterworthFactory : public AUD_DynamicIIRFilterFactory
41 {
42 private:
43         /**
44          * The attack value in seconds.
45          */
46         const float m_frequency;
47
48         // hide copy constructor and operator=
49         AUD_ButterworthFactory(const AUD_ButterworthFactory&);
50         AUD_ButterworthFactory& operator=(const AUD_ButterworthFactory&);
51
52 public:
53         /**
54          * Creates a new butterworth factory.
55          * \param factory The input factory.
56          * \param frequency The cutoff frequency.
57          */
58         AUD_ButterworthFactory(AUD_Reference<AUD_IFactory> factory, float frequency);
59
60         virtual void recalculateCoefficients(AUD_SampleRate rate,
61                                                                                  std::vector<float>& b,
62                                                                                  std::vector<float>& a);
63 };
64
65 #endif //AUD_BUTTERWORTHFACTORY