Merging with trunk up to r38631.
[blender.git] / intern / audaspace / intern / AUD_BufferReader.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/intern/AUD_BufferReader.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_BUFFERREADER
33 #define AUD_BUFFERREADER
34
35 #include "AUD_IReader.h"
36 #include "AUD_Reference.h"
37 class AUD_Buffer;
38
39 /**
40  * This class represents a simple reader from a buffer that exists in memory.
41  * \warning Notice that the buffer used for creating the reader must exist as
42  *          long as the reader exists.
43  */
44 class AUD_BufferReader : public AUD_IReader
45 {
46 private:
47         /**
48          * The current position in the buffer.
49          */
50         int m_position;
51
52         /**
53          * The buffer that is read.
54          */
55         AUD_Reference<AUD_Buffer> m_buffer;
56
57         /**
58          * The specification of the sample data in the buffer.
59          */
60         AUD_Specs m_specs;
61
62         // hide copy constructor and operator=
63         AUD_BufferReader(const AUD_BufferReader&);
64         AUD_BufferReader& operator=(const AUD_BufferReader&);
65
66 public:
67         /**
68          * Creates a new buffer reader.
69          * \param buffer The buffer to read from.
70          * \param specs The specification of the sample data in the buffer.
71          */
72         AUD_BufferReader(AUD_Reference<AUD_Buffer> buffer, AUD_Specs specs);
73
74         virtual bool isSeekable() const;
75         virtual void seek(int position);
76         virtual int getLength() const;
77         virtual int getPosition() const;
78         virtual AUD_Specs getSpecs() const;
79         virtual void read(int& length, bool& eos, sample_t* buffer);
80 };
81
82 #endif //AUD_BUFFERREADER