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