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