svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / intern / audaspace / FX / AUD_FaderReader.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_FaderReader.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_FADERREADER
33 #define AUD_FADERREADER
34
35 #include "AUD_EffectReader.h"
36 #include "AUD_Buffer.h"
37
38 /**
39  * This class fades another reader.
40  * If the fading type is AUD_FADE_IN, everything before the fading start will be
41  * silenced, for AUD_FADE_OUT that's true for everything after fading ends.
42  */
43 class AUD_FaderReader : public AUD_EffectReader
44 {
45 private:
46         /**
47          * The fading type.
48          */
49         const AUD_FadeType m_type;
50
51         /**
52          * The fading start.
53          */
54         const float m_start;
55
56         /**
57          * The fading length.
58          */
59         const float m_length;
60
61         // hide copy constructor and operator=
62         AUD_FaderReader(const AUD_FaderReader&);
63         AUD_FaderReader& operator=(const AUD_FaderReader&);
64
65 public:
66         /**
67          * Creates a new fader reader.
68          * \param type The fading type.
69          * \param start The time where fading should start in seconds.
70          * \param length How long fading should last in seconds.
71          */
72         AUD_FaderReader(AUD_Reference<AUD_IReader> reader, AUD_FadeType type,
73                                         float start,float length);
74
75         virtual void read(int& length, bool& eos, sample_t* buffer);
76 };
77
78 #endif //AUD_FADERREADER