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