3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_ReadDevice.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_ReadDevice.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_READDEVICE
33 #define AUD_READDEVICE
34
35 #include "AUD_SoftwareDevice.h"
36
37 /**
38  * This device enables to let the user read raw data out of it.
39  */
40 class AUD_ReadDevice : public AUD_SoftwareDevice
41 {
42 private:
43         /**
44          * Whether the device currently.
45          */
46         bool m_playing;
47
48         // hide copy constructor and operator=
49         AUD_ReadDevice(const AUD_ReadDevice&);
50         AUD_ReadDevice& operator=(const AUD_ReadDevice&);
51
52 protected:
53         virtual void playing(bool playing);
54
55 public:
56         /**
57          * Creates a new read device.
58          * \param specs The wanted audio specification.
59          */
60         AUD_ReadDevice(AUD_DeviceSpecs specs);
61
62         /**
63          * Closes the device.
64          */
65         virtual ~AUD_ReadDevice();
66
67         /**
68          * Reads the next bytes into the supplied buffer.
69          * \param buffer The target buffer.
70          * \param length The length in samples to be filled.
71          * \return True if the reading succeeded, false if there are no sounds
72          *         played back currently, in that case the buffer is filled with
73          *         silence.
74          */
75         bool read(data_t* buffer, int length);
76 };
77
78 #endif //AUD_READDEVICE