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