29b87e57ad0a25b1ee25142656d14f918b6eef46
[blender-staging.git] / intern / audaspace / FX / AUD_IDynamicIIRFilterCalculator.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_IDynamicIIRFilterCalculator.h
26  *  \ingroup audfx
27  */
28
29 #ifndef AUD_IDYNAMICIIRFILTERCALCULATOR_H
30 #define AUD_IDYNAMICIIRFILTERCALCULATOR_H
31
32 #include "AUD_Space.h"
33
34 #include <vector>
35
36 /**
37  * This interface calculates dynamic filter coefficients which depend on the
38  * sampling rate for AUD_DynamicIIRFilterReaders.
39  */
40 class AUD_IDynamicIIRFilterCalculator
41 {
42 public:
43         /**
44          * Recalculates the filter coefficients.
45          * \param rate The sample rate of the audio data.
46          * \param[out] b The input filter coefficients.
47          * \param[out] a The output filter coefficients.
48          */
49         virtual void recalculateCoefficients(AUD_SampleRate rate,
50                                                                                  std::vector<float>& b,
51                                                                                  std::vector<float>& a)=0;
52 };
53
54 #endif // AUD_IDYNAMICIIRFILTERCALCULATOR_H