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