svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / intern / audaspace / FX / AUD_SquareFactory.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_SquareFactory.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_SQUAREFACTORY
33 #define AUD_SQUAREFACTORY
34
35 #include "AUD_EffectFactory.h"
36 class AUD_CallbackIIRFilterReader;
37
38 /**
39  * This factory Transforms any signal to a square signal.
40  */
41 class AUD_SquareFactory : public AUD_EffectFactory
42 {
43 private:
44         /**
45          * The threshold.
46          */
47         const float m_threshold;
48
49         // hide copy constructor and operator=
50         AUD_SquareFactory(const AUD_SquareFactory&);
51         AUD_SquareFactory& operator=(const AUD_SquareFactory&);
52
53 public:
54         /**
55          * Creates a new square factory.
56          * \param factory The input factory.
57          * \param threshold The threshold.
58          */
59         AUD_SquareFactory(AUD_Reference<AUD_IFactory> factory, float threshold = 0.0f);
60
61         /**
62          * Returns the threshold.
63          */
64         float getThreshold() const;
65
66         virtual AUD_Reference<AUD_IReader> createReader();
67
68         static sample_t squareFilter(AUD_CallbackIIRFilterReader* reader, float* threshold);
69         static void endSquareFilter(float* threshold);
70 };
71
72 #endif //AUD_SQUAREFACTORY