ac73c5aa6aec8966420154d771f8c97d74e3eceb
[blender.git] / intern / audaspace / FX / AUD_AccumulatorFactory.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_AccumulatorFactory.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_ACCUMULATORFACTORY_H__
31 #define __AUD_ACCUMULATORFACTORY_H__
32
33 #include "AUD_EffectFactory.h"
34 class AUD_CallbackIIRFilterReader;
35
36 /**
37  * This factory creates an accumulator reader.
38  *
39  * The accumulator adds the difference at the input to the last output in case
40  * it's positive. In additive mode it additionaly adds the difference always.
41  * So in case the difference is positive, it's added twice.
42  */
43 class AUD_AccumulatorFactory : public AUD_EffectFactory
44 {
45 private:
46         /**
47          * Whether the accumulator is additive.
48          */
49         const bool m_additive;
50
51         // hide copy constructor and operator=
52         AUD_AccumulatorFactory(const AUD_AccumulatorFactory&);
53         AUD_AccumulatorFactory& operator=(const AUD_AccumulatorFactory&);
54
55 public:
56         /**
57          * Creates a new accumulator factory.
58          * \param factory The input factory.
59          * \param additive Whether the accumulator is additive.
60          */
61         AUD_AccumulatorFactory(AUD_Reference<AUD_IFactory> factory, bool additive = false);
62
63         virtual AUD_Reference<AUD_IReader> createReader();
64
65         static sample_t accumulatorFilterAdditive(AUD_CallbackIIRFilterReader* reader, void* useless);
66         static sample_t accumulatorFilter(AUD_CallbackIIRFilterReader* reader, void* useless);
67 };
68
69 #endif //__AUD_ACCUMULATORFACTORY_H__