3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_IWriter.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_IWriter.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_IWRITER
33 #define AUD_IWRITER
34
35 #include "AUD_Space.h"
36
37 /**
38  * This class represents a sound sink where audio data can be written to.
39  */
40 class AUD_IWriter
41 {
42 public:
43         /**
44          * Destroys the writer.
45          */
46         virtual ~AUD_IWriter(){}
47
48         /**
49          * Returns how many samples have been written so far.
50          * \return The writing position as sample count. May be negative if unknown.
51          */
52         virtual int getPosition() const=0;
53
54         /**
55          * Returns the specification of the audio data being written into the sink.
56          * \return The AUD_DeviceSpecs structure.
57          * \note Regardless of the format the input still has to be float!
58          */
59         virtual AUD_DeviceSpecs getSpecs() const=0;
60
61         /**
62          * Request to write the next length samples out into the sink.
63          * \param length The count of samples to write.
64          * \param buffer The pointer to the buffer containing the data.
65          */
66         virtual void write(unsigned int length, sample_t* buffer)=0;
67 };
68
69 #endif //AUD_IWRITER