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