Audaspace:
[blender.git] / intern / audaspace / FX / AUD_CallbackIIRFilterReader.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/FX/AUD_CallbackIIRFilterReader.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_CALLBACKIIRFILTERREADER_H__
31 #define __AUD_CALLBACKIIRFILTERREADER_H__
32
33 #include "AUD_BaseIIRFilterReader.h"
34 #include "AUD_Buffer.h"
35
36 class AUD_CallbackIIRFilterReader;
37
38 typedef sample_t (*doFilterIIR)(AUD_CallbackIIRFilterReader*, void*);
39 typedef void (*endFilterIIR)(void*);
40
41 /**
42  * This class provides an interface for infinite impulse response filters via a
43  * callback filter function.
44  */
45 class AUD_CallbackIIRFilterReader : public AUD_BaseIIRFilterReader
46 {
47 private:
48         /**
49          * Filter function.
50          */
51         const doFilterIIR m_filter;
52
53         /**
54          * End filter function.
55          */
56         const endFilterIIR m_endFilter;
57
58         /**
59          * Data pointer.
60          */
61         void* m_data;
62
63         // hide copy constructor and operator=
64         AUD_CallbackIIRFilterReader(const AUD_CallbackIIRFilterReader&);
65         AUD_CallbackIIRFilterReader& operator=(const AUD_CallbackIIRFilterReader&);
66
67 public:
68         /**
69          * Creates a new callback IIR filter reader.
70          * \param reader The reader to read from.
71          * \param in The count of past input samples needed.
72          * \param out The count of past output samples needed.
73          * \param doFilter The filter callback.
74          * \param endFilter The finishing callback.
75          * \param data Data pointer for the callbacks.
76          */
77         AUD_CallbackIIRFilterReader(boost::shared_ptr<AUD_IReader> reader, int in, int out,
78                                                                 doFilterIIR doFilter,
79                                                                 endFilterIIR endFilter = 0,
80                                                                 void* data = 0);
81
82         virtual ~AUD_CallbackIIRFilterReader();
83
84         virtual sample_t filter();
85 };
86
87 #endif //__AUD_CALLBACKIIRFILTERREADER_H__