Sound:
[blender-staging.git] / intern / audaspace / fftw / AUD_BandPassFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 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 Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_BANDPASSFACTORY
27 #define AUD_BANDPASSFACTORY
28
29 #include "AUD_EffectFactory.h"
30
31 /**
32  * This factory creates a band pass filter for a sound wave.
33  */
34 class AUD_BandPassFactory : public AUD_EffectFactory
35 {
36 private:
37         /**
38          * The lowest frequency to be passed.
39          */
40         float m_low;
41
42         /**
43          * The highest frequency to be passed.
44          */
45         float m_high;
46
47 public:
48         /**
49          * Creates a new band pass factory.
50          * \param factory The input factory.
51          * \param low The lowest passed frequency.
52          * \param high The highest passed frequency.
53          */
54         AUD_BandPassFactory(AUD_IFactory* factory, float low, float high);
55
56         /**
57          * Creates a new band pass factory.
58          * \param low The lowest passed frequency.
59          * \param high The highest passed frequency.
60          */
61         AUD_BandPassFactory(float low, float high);
62
63         /**
64          * Returns the lowest passed frequency.
65          */
66         float getLow();
67
68         /**
69          * Returns the highest passed frequency.
70          */
71         float getHigh();
72
73         /**
74          * Sets the lowest passed frequency.
75          * \param low The lowest passed frequency.
76          */
77         void setLow(float low);
78
79         /**
80          * Sets the highest passed frequency.
81          * \param high The highest passed frequency.
82          */
83         void setHigh(float hight);
84
85         virtual AUD_IReader* createReader();
86 };
87
88 #endif //AUD_BANDPASSFACTORY