svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / intern / audaspace / FX / AUD_LimiterFactory.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_LimiterFactory.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_LIMITERFACTORY
33 #define AUD_LIMITERFACTORY
34
35 #include "AUD_EffectFactory.h"
36
37 /**
38  * This factory limits another factory in start and end time.
39  */
40 class AUD_LimiterFactory : public AUD_EffectFactory
41 {
42 private:
43         /**
44          * The start time.
45          */
46         const float m_start;
47
48         /**
49          * The end time.
50          */
51         const float m_end;
52
53         // hide copy constructor and operator=
54         AUD_LimiterFactory(const AUD_LimiterFactory&);
55         AUD_LimiterFactory& operator=(const AUD_LimiterFactory&);
56
57 public:
58         /**
59          * Creates a new limiter factory.
60          * \param factory The input factory.
61          * \param start The desired start time.
62          * \param end The desired end time, a negative value signals that it should
63          *            play to the end.
64          */
65         AUD_LimiterFactory(AUD_Reference<AUD_IFactory> factory,
66                                            float start = 0, float end = -1);
67
68         /**
69          * Returns the start time.
70          */
71         float getStart() const;
72
73         /**
74          * Returns the end time.
75          */
76         float getEnd() const;
77
78         virtual AUD_Reference<AUD_IReader> createReader();
79 };
80
81 #endif //AUD_LIMITERFACTORY