unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / audaspace / fftw / AUD_BandPassFactory.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/fftw/AUD_BandPassFactory.h
26  *  \ingroup audfftw
27  */
28
29
30 #ifndef __AUD_BANDPASSFACTORY_H__
31 #define __AUD_BANDPASSFACTORY_H__
32
33 #include "AUD_EffectFactory.h"
34
35 /**
36  * This factory creates a band pass filter for a sound wave.
37  */
38 class AUD_BandPassFactory : public AUD_EffectFactory
39 {
40 private:
41         /**
42          * The lowest frequency to be passed.
43          */
44         float m_low;
45
46         /**
47          * The highest frequency to be passed.
48          */
49         float m_high;
50
51 public:
52         /**
53          * Creates a new band pass factory.
54          * \param factory The input factory.
55          * \param low The lowest passed frequency.
56          * \param high The highest passed frequency.
57          */
58         AUD_BandPassFactory(AUD_IFactory* factory, float low, float high);
59
60         /**
61          * Creates a new band pass factory.
62          * \param low The lowest passed frequency.
63          * \param high The highest passed frequency.
64          */
65         AUD_BandPassFactory(float low, float high);
66
67         /**
68          * Returns the lowest passed frequency.
69          */
70         float getLow();
71
72         /**
73          * Returns the highest passed frequency.
74          */
75         float getHigh();
76
77         /**
78          * Sets the lowest passed frequency.
79          * \param low The lowest passed frequency.
80          */
81         void setLow(float low);
82
83         /**
84          * Sets the highest passed frequency.
85          * \param high The highest passed frequency.
86          */
87         void setHigh(float hight);
88
89         virtual AUD_IReader* createReader();
90 };
91
92 #endif //__AUD_BANDPASSFACTORY_H__