tmp
[blender.git] / extern / audaspace / include / fx / Accumulator.h
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16
17 #pragma once
18
19 /**
20  * @file Accumulator.h
21  * @ingroup fx
22  * The Accumulator class.
23  */
24
25 #include "fx/Effect.h"
26
27 AUD_NAMESPACE_BEGIN
28
29 class CallbackIIRFilterReader;
30
31 /**
32  * This sound creates an accumulator reader.
33  *
34  * The accumulator adds the difference at the input to the last output in case
35  * it's positive. In additive mode it additionaly adds the difference always.
36  * So in case the difference is positive, it's added twice.
37  */
38 class AUD_API Accumulator : public Effect
39 {
40 private:
41         /**
42          * Whether the accumulator is additive.
43          */
44         const bool m_additive;
45
46         // delete copy constructor and operator=
47         Accumulator(const Accumulator&) = delete;
48         Accumulator& operator=(const Accumulator&) = delete;
49
50 public:
51         /**
52          * Creates a new accumulator sound.
53          * \param sound The input sound.
54          * \param additive Whether the accumulator is additive.
55          */
56         Accumulator(std::shared_ptr<ISound> sound, bool additive = false);
57
58         virtual std::shared_ptr<IReader> createReader();
59
60         /**
61          * The accumulatorFilterAdditive function implements the doFilterIIR callback
62          * for the additive accumulator filter.
63          * @param reader The CallbackIIRFilterReader that executes the callback.
64          * @param useless A user defined pointer that is not needed for this filter.
65          * @return The filtered sample.
66          */
67         static sample_t AUD_LOCAL accumulatorFilterAdditive(CallbackIIRFilterReader* reader, void* useless);
68
69         /**
70          * The accumulatorFilter function implements the doFilterIIR callback
71          * for the non-additive accumulator filter.
72          * @param reader The CallbackIIRFilterReader that executes the callback.
73          * @param useless A user defined pointer that is not needed for this filter.
74          * @return The filtered sample.
75          */
76         static sample_t AUD_LOCAL accumulatorFilter(CallbackIIRFilterReader* reader, void* useless);
77 };
78
79 AUD_NAMESPACE_END