c8f3dc37cd26c2717f974c14f2b9e15c2c00f1ab
[blender-staging.git] / intern / audaspace / FX / AUD_EnvelopeFactory.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_EnvelopeFactory.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_ENVELOPEFACTORY_H__
31 #define __AUD_ENVELOPEFACTORY_H__
32
33 #include "AUD_EffectFactory.h"
34 class AUD_CallbackIIRFilterReader;
35 struct EnvelopeParameters;
36
37 /**
38  * This factory creates an envelope follower reader.
39  */
40 class AUD_EnvelopeFactory : public AUD_EffectFactory
41 {
42 private:
43         /**
44          * The attack value in seconds.
45          */
46         const float m_attack;
47
48         /**
49          * The release value in seconds.
50          */
51         const float m_release;
52
53         /**
54          * The threshold value.
55          */
56         const float m_threshold;
57
58         /**
59          * The attack/release threshold value.
60          */
61         const float m_arthreshold;
62
63         // hide copy constructor and operator=
64         AUD_EnvelopeFactory(const AUD_EnvelopeFactory&);
65         AUD_EnvelopeFactory& operator=(const AUD_EnvelopeFactory&);
66
67 public:
68         /**
69          * Creates a new envelope factory.
70          * \param factory The input factory.
71          * \param attack The attack value in seconds.
72          * \param release The release value in seconds.
73          * \param threshold The threshold value.
74          * \param arthreshold The attack/release threshold value.
75          */
76         AUD_EnvelopeFactory(AUD_Reference<AUD_IFactory> factory, float attack, float release,
77                                                 float threshold, float arthreshold);
78
79         virtual AUD_Reference<AUD_IReader> createReader();
80
81         static sample_t envelopeFilter(AUD_CallbackIIRFilterReader* reader, EnvelopeParameters* param);
82         static void endEnvelopeFilter(EnvelopeParameters* param);
83 };
84
85 #endif //__AUD_ENVELOPEFACTORY_H__