Cherry pick merge: /branches/soc-2011-pepper/intern/audaspace/OpenAL:r38630
[blender.git] / intern / audaspace / FX / AUD_BaseIIRFilterReader.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/FX/AUD_BaseIIRFilterReader.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_BASEIIRFILTERREADER
33 #define AUD_BASEIIRFILTERREADER
34
35 #include "AUD_EffectReader.h"
36 #include "AUD_Buffer.h"
37
38 /**
39  * This class is a base class for infinite impulse response filters.
40  */
41 class AUD_BaseIIRFilterReader : public AUD_EffectReader
42 {
43 private:
44         /**
45          * Channel count.
46          */
47         const int m_channels;
48
49         /**
50          * Length of input samples needed.
51          */
52         const int m_xlen;
53
54         /**
55          * Length of output samples needed.
56          */
57         const int m_ylen;
58
59         /**
60          * The playback buffer.
61          */
62         AUD_Buffer m_buffer;
63
64         /**
65          * The last in samples array.
66          */
67         sample_t* m_x;
68
69         /**
70          * The last out samples array.
71          */
72         sample_t* m_y;
73
74         /**
75          * Position of the current input sample in the input array.
76          */
77         int m_xpos;
78
79         /**
80          * Position of the current output sample in the output array.
81          */
82         int m_ypos;
83
84         /**
85          * Current channel.
86          */
87         int m_channel;
88
89         // hide copy constructor and operator=
90         AUD_BaseIIRFilterReader(const AUD_BaseIIRFilterReader&);
91         AUD_BaseIIRFilterReader& operator=(const AUD_BaseIIRFilterReader&);
92
93 protected:
94         /**
95          * Creates a new base IIR filter reader.
96          * \param reader The reader to read from.
97          * \param in The count of past input samples needed.
98          * \param out The count of past output samples needed.
99          */
100         AUD_BaseIIRFilterReader(AUD_IReader* reader, int in, int out);
101
102 public:
103         inline sample_t x(int pos)
104         {
105                 return m_x[(m_xpos + pos + m_xlen) % m_xlen * m_channels + m_channel];
106         }
107
108         inline sample_t y(int pos)
109         {
110                 return m_y[(m_ypos + pos + m_ylen) % m_ylen * m_channels + m_channel];
111         }
112
113         virtual ~AUD_BaseIIRFilterReader();
114
115         virtual void read(int & length, sample_t* & buffer);
116
117         virtual sample_t filter()=0;
118 };
119
120 #endif //AUD_BASEIIRFILTERREADER