svn merge -r 30718:30912 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender-staging.git] / intern / audaspace / intern / AUD_IReader.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 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 Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_IREADER
27 #define AUD_IREADER
28
29 #include "AUD_Space.h"
30
31 /**
32  * This class represents a sound source as stream or as buffer which can be read
33  * for example by another reader, a device or whatever.
34  */
35 class AUD_IReader
36 {
37 public:
38         /**
39          * Destroys the reader.
40          */
41         virtual ~AUD_IReader(){}
42
43         /**
44          * Tells whether the source provides seeking functionality or not.
45          * \warning This doesn't mean that the seeking always has to succeed.
46          * \return Always returns true for readers of the buffer type.
47          * \see getType
48          */
49         virtual bool isSeekable() const=0;
50
51         /**
52          * Seeks to a specific position in the source.
53          * This function must work for buffer type readers.
54          * \param position The position to seek for measured in samples. To get
55          *        from a given time to the samples you simply have to multiply the
56          *        time value in seconds with the sample rate of the reader.
57          * \warning This may work or not, depending on the actual reader.
58          * \see getType
59          */
60         virtual void seek(int position)=0;
61
62         /**
63          * Returns an approximated length of the source in samples.
64          * For readers of the type buffer this has to return a correct value!
65          * \return The length as sample count. May be negative if unknown.
66          * \see getType
67          */
68         virtual int getLength() const=0;
69
70         /**
71          * Returns the position of the source as a sample count value.
72          * \return The current position in the source. A negative value indicates
73          *         that the position is unknown.
74          * \warning The value returned doesn't always have to be correct for readers
75          *          of the stream type, especially after seeking, it must though for
76          *          the buffer ones.
77          * \see getType
78          */
79         virtual int getPosition() const=0;
80
81         /**
82          * Returns the specification of the reader.
83          * \return The AUD_Specs structure.
84          */
85         virtual AUD_Specs getSpecs() const=0;
86
87         /**
88          * Request to read the next length samples out of the source.
89          * The buffer for reading has to stay valid until the next call of this
90          * method or until the reader is deleted.
91          * \param[in,out] length The count of samples that should be read. Shall
92          *                contain the real count of samples after reading, in case
93          *                there were only fewer samples available.
94          *                A smaller value also indicates the end of the reader.
95          * \param[out] buffer The pointer to the buffer with the samples.
96          */
97         virtual void read(int & length, sample_t* & buffer)=0;
98 };
99
100 #endif //AUD_IREADER