d1e5179b8ecd2f669c6b7d0d00d6a5080d5c56fd
[blender.git] / intern / audaspace / FX / AUD_ReverseReader.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_ReverseReader.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_REVERSEREADER_H__
31 #define __AUD_REVERSEREADER_H__
32
33 #include "AUD_EffectReader.h"
34 #include "AUD_Buffer.h"
35
36 /**
37  * This class reads another reader from back to front.
38  * \note The underlying reader must be seekable.
39  */
40 class AUD_ReverseReader : public AUD_EffectReader
41 {
42 private:
43         /**
44          * The sample count.
45          */
46         const int m_length;
47
48         /**
49          * The current position.
50          */
51         int m_position;
52
53         // hide copy constructor and operator=
54         AUD_ReverseReader(const AUD_ReverseReader&);
55         AUD_ReverseReader& operator=(const AUD_ReverseReader&);
56
57 public:
58         /**
59          * Creates a new reverse reader.
60          * \param reader The reader to read from.
61          * \exception AUD_Exception Thrown if the reader specified has an
62          *            undeterminable/infinite length or is not seekable.
63          */
64         AUD_ReverseReader(AUD_Reference<AUD_IReader> reader);
65
66         virtual void seek(int position);
67         virtual int getLength() const;
68         virtual int getPosition() const;
69         virtual void read(int& length, bool& eos, sample_t* buffer);
70 };
71
72 #endif //__AUD_REVERSEREADER_H__