3D Audio GSoC:
[blender.git] / intern / audaspace / FX / AUD_DynamicIIRFilterFactory.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_DynamicIIRFilterFactory.h
28  *  \ingroup audfx
29  */
30
31 #ifndef AUD_DYNAMICIIRFILTERFACTORY
32 #define AUD_DYNAMICIIRFILTERFACTORY
33
34 #include "AUD_EffectFactory.h"
35 #include <vector>
36
37 /**
38  * This factory creates a IIR filter reader.
39  *
40  * This means that on sample rate change the filter recalculates its
41  * coefficients.
42  */
43 class AUD_DynamicIIRFilterFactory : public AUD_EffectFactory
44 {
45 public:
46         /**
47          * Creates a new Dynmic IIR filter factory.
48          * \param factory The input factory.
49          */
50         AUD_DynamicIIRFilterFactory(AUD_Reference<AUD_IFactory> factory);
51
52         virtual AUD_Reference<AUD_IReader> createReader();
53
54         /**
55          * Recalculates the filter coefficients.
56          * \param rate The sample rate of the audio data.
57          * \param[out] b The input filter coefficients.
58          * \param[out] a The output filter coefficients.
59          */
60         virtual void recalculateCoefficients(AUD_SampleRate rate,
61                                                                                  std::vector<float>& b,
62                                                                                  std::vector<float>& a)=0;
63 };
64
65 #endif // AUD_DYNAMICIIRFILTERFACTORY