Audaspace:
[blender.git] / intern / audaspace / intern / AUD_IReader.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/intern/AUD_IReader.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_IREADER_H__
31 #define __AUD_IREADER_H__
32
33 #include "AUD_Space.h"
34
35 /**
36  * This class represents a sound source as stream or as buffer which can be read
37  * for example by another reader, a device or whatever.
38  */
39 class AUD_IReader
40 {
41 public:
42         /**
43          * Destroys the reader.
44          */
45         virtual ~AUD_IReader() {}
46
47         /**
48          * Tells whether the source provides seeking functionality or not.
49          * \warning This doesn't mean that the seeking always has to succeed.
50          * \return Always returns true for readers of buffering types.
51          */
52         virtual bool isSeekable() const=0;
53
54         /**
55          * Seeks to a specific position in the source.
56          * \param position The position to seek for measured in samples. To get
57          *        from a given time to the samples you simply have to multiply the
58          *        time value in seconds with the sample rate of the reader.
59          * \warning This may work or not, depending on the actual reader.
60          */
61         virtual void seek(int position)=0;
62
63         /**
64          * Returns an approximated length of the source in samples.
65          * \return The length as sample count. May be negative if unknown.
66          */
67         virtual int getLength() const=0;
68
69         /**
70          * Returns the position of the source as a sample count value.
71          * \return The current position in the source. A negative value indicates
72          *         that the position is unknown.
73          * \warning The value returned doesn't always have to be correct for readers,
74          *          especially after seeking.
75          */
76         virtual int getPosition() const=0;
77
78         /**
79          * Returns the specification of the reader.
80          * \return The AUD_Specs structure.
81          */
82         virtual AUD_Specs getSpecs() const=0;
83
84         /**
85          * Request to read the next length samples out of the source.
86          * The buffer supplied has the needed size.
87          * \param[in,out] length The count of samples that should be read. Shall
88          *                contain the real count of samples after reading, in case
89          *                there were only fewer samples available.
90          *                A smaller value also indicates the end of the reader.
91          * \param[out] eos End of stream, whether the end is reached or not.
92          * \param[in] buffer The pointer to the buffer to read into.
93          */
94         virtual void read(int& length, bool& eos, sample_t* buffer)=0;
95 };
96
97 #endif //__AUD_IREADER_H__