Sound:
[blender-staging.git] / intern / audaspace / fftw / AUD_BandPassReader.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_BANDPASSREADER
27 #define AUD_BANDPASSREADER
28
29 #include <fftw3.h>
30
31 #include "AUD_EffectReader.h"
32 class AUD_Buffer;
33
34 /**
35  * This class only passes a specific frequency band of another reader.
36  */
37 class AUD_BandPassReader : public AUD_EffectReader
38 {
39 private:
40         /**
41          * The playback buffer.
42          */
43         AUD_Buffer *m_buffer;
44
45         /**
46          * The input buffer for fourier transformations.
47          */
48         AUD_Buffer *m_in;
49
50         /**
51          * The output buffer for fourier transformations.
52          */
53         AUD_Buffer *m_out;
54
55         /**
56          * The lowest passed frequency.
57          */
58         float m_low;
59
60         /**
61          * The highest passed frequency.
62          */
63         float m_high;
64
65         /**
66          * The fftw plan for forward transformation.
67          */
68         fftw_plan m_forward;
69
70         /**
71          * The fftw plan for backward transformation.
72          */
73         fftw_plan m_backward;
74
75         /**
76          * The length of the plans.
77          */
78         int m_length;
79
80 public:
81         /**
82          * Creates a new band pass reader.
83          * \param reader The reader to read from.
84          * \param low The lowest passed frequency.
85          * \param high The highest passed frequency.
86          * \exception AUD_Exception Thrown if the reader specified is NULL.
87          */
88         AUD_BandPassReader(AUD_IReader* reader, float low, float high);
89
90         /**
91          * Destroys the reader.
92          */
93         virtual ~AUD_BandPassReader();
94
95         virtual AUD_ReaderType getType();
96         virtual void read(int & length, sample_t* & buffer);
97 };
98
99 #endif //AUD_BANDPASSREADER