svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / intern / audaspace / FX / AUD_LimiterReader.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_LimiterReader.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_LIMITERREADER
33 #define AUD_LIMITERREADER
34
35 #include "AUD_EffectReader.h"
36
37 /**
38  * This reader limits another reader in start and end times.
39  */
40 class AUD_LimiterReader : public AUD_EffectReader
41 {
42 private:
43         /**
44          * The start sample: inclusive.
45          */
46         const float m_start;
47
48         /**
49          * The end sample: exlusive.
50          */
51         const float m_end;
52
53         // hide copy constructor and operator=
54         AUD_LimiterReader(const AUD_LimiterReader&);
55         AUD_LimiterReader& operator=(const AUD_LimiterReader&);
56
57 public:
58         /**
59          * Creates a new limiter reader.
60          * \param reader The reader to read from.
61          * \param start The desired start time (inclusive).
62          * \param end The desired end time (sample exklusive), a negative value
63          *            signals that it should play to the end.
64          */
65         AUD_LimiterReader(AUD_Reference<AUD_IReader> reader, float start = 0, float end = -1);
66
67         virtual void seek(int position);
68         virtual int getLength() const;
69         virtual int getPosition() const;
70         virtual void read(int& length, bool& eos, sample_t* buffer);
71 };
72
73 #endif //AUD_LIMITERREADER