3D Audio GSoC:
[blender.git] / intern / audaspace / OpenAL / AUD_OpenALDevice.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/OpenAL/AUD_OpenALDevice.h
28  *  \ingroup audopenal
29  */
30
31
32 #ifndef AUD_OPENALDEVICE
33 #define AUD_OPENALDEVICE
34
35 #include "AUD_IDevice.h"
36 #include "AUD_IHandle.h"
37 #include "AUD_I3DDevice.h"
38 #include "AUD_I3DHandle.h"
39 #include "AUD_Buffer.h"
40 //struct AUD_OpenALBufferedFactory;
41
42 #include <AL/al.h>
43 #include <AL/alc.h>
44 #include <list>
45 #include <pthread.h>
46
47 /**
48  * This device plays through OpenAL.
49  */
50 class AUD_OpenALDevice : public AUD_IDevice, public AUD_I3DDevice
51 {
52 private:
53         /// Saves the data for playback.
54         class AUD_OpenALHandle : public AUD_IHandle, public AUD_I3DHandle
55         {
56         public:
57                 static const int CYCLE_BUFFERS = 3;
58
59                 /// Whether it's a buffered or a streamed source.
60                 bool m_isBuffered;
61
62                 /// The reader source.
63                 AUD_Reference<AUD_IReader> m_reader;
64
65                 /// Whether to keep the source if end of it is reached.
66                 bool m_keep;
67
68                 /// OpenAL sample format.
69                 ALenum m_format;
70
71                 /// OpenAL source.
72                 ALuint m_source;
73
74                 /// OpenAL buffers.
75                 ALuint m_buffers[CYCLE_BUFFERS];
76
77                 /// The first buffer to be read next.
78                 int m_current;
79
80                 /// Whether the stream doesn't return any more data.
81                 bool m_eos;
82
83                 /// The loop count of the source.
84                 int m_loopcount;
85
86                 /// The stop callback.
87                 stopCallback m_stop;
88
89                 /// Stop callback data.
90                 void* m_stop_data;
91
92                 /// Current status of the handle
93                 AUD_Status m_status;
94
95                 /// Own device.
96                 AUD_OpenALDevice* m_device;
97
98         public:
99
100                 AUD_OpenALHandle(AUD_OpenALDevice* device, ALenum format, AUD_Reference<AUD_IReader> reader, bool keep);
101
102                 virtual ~AUD_OpenALHandle() {}
103                 virtual bool pause();
104                 virtual bool resume();
105                 virtual bool stop();
106                 virtual bool getKeep();
107                 virtual bool setKeep(bool keep);
108                 virtual bool seek(float position);
109                 virtual float getPosition();
110                 virtual AUD_Status getStatus();
111                 virtual float getVolume();
112                 virtual bool setVolume(float volume);
113                 virtual float getPitch();
114                 virtual bool setPitch(float pitch);
115                 virtual int getLoopCount();
116                 virtual bool setLoopCount(int count);
117                 virtual bool setStopCallback(stopCallback callback = 0, void* data = 0);
118
119                 virtual AUD_Vector3 getSourceLocation();
120                 virtual bool setSourceLocation(const AUD_Vector3& location);
121                 virtual AUD_Vector3 getSourceVelocity();
122                 virtual bool setSourceVelocity(const AUD_Vector3& velocity);
123                 virtual AUD_Quaternion getSourceOrientation();
124                 virtual bool setSourceOrientation(const AUD_Quaternion& orientation);
125                 virtual bool isRelative();
126                 virtual bool setRelative(bool relative);
127                 virtual float getVolumeMaximum();
128                 virtual bool setVolumeMaximum(float volume);
129                 virtual float getVolumeMinimum();
130                 virtual bool setVolumeMinimum(float volume);
131                 virtual float getDistanceMaximum();
132                 virtual bool setDistanceMaximum(float distance);
133                 virtual float getDistanceReference();
134                 virtual bool setDistanceReference(float distance);
135                 virtual float getAttenuation();
136                 virtual bool setAttenuation(float factor);
137                 virtual float getConeAngleOuter();
138                 virtual bool setConeAngleOuter(float angle);
139                 virtual float getConeAngleInner();
140                 virtual bool setConeAngleInner(float angle);
141                 virtual float getConeVolumeOuter();
142                 virtual bool setConeVolumeOuter(float volume);
143         };
144
145         typedef std::list<AUD_Reference<AUD_OpenALHandle> >::iterator AUD_HandleIterator;
146
147         /**
148          * The OpenAL device handle.
149          */
150         ALCdevice* m_device;
151
152         /**
153          * The OpenAL context.
154          */
155         ALCcontext* m_context;
156
157         /**
158          * The specification of the device.
159          */
160         AUD_DeviceSpecs m_specs;
161
162         /**
163          * Whether the device has the AL_EXT_MCFORMATS extension.
164          */
165         bool m_useMC;
166
167         /**
168          * The list of sounds that are currently playing.
169          */
170         std::list<AUD_Reference<AUD_OpenALHandle> > m_playingSounds;
171
172         /**
173          * The list of sounds that are currently paused.
174          */
175         std::list<AUD_Reference<AUD_OpenALHandle> > m_pausedSounds;
176
177         /**
178          * The list of buffered factories.
179          */
180         //std::list<AUD_OpenALBufferedFactory*>* m_bufferedFactories;
181
182         /**
183          * The mutex for locking.
184          */
185         pthread_mutex_t m_mutex;
186
187         /**
188          * The streaming thread.
189          */
190         pthread_t m_thread;
191
192         /**
193          * The condition for streaming thread wakeup.
194          */
195         bool m_playing;
196
197         /**
198          * Buffer size.
199          */
200         int m_buffersize;
201
202         /**
203          * Device buffer.
204          */
205         AUD_Buffer m_buffer;
206
207         /**
208          * Starts the streaming thread.
209          */
210         void start();
211
212         /**
213          * Gets the format according to the specs.
214          * \param format The variable to put the format into.
215          * \param specs The specs to read the channel count from.
216          * \return Whether the format is valid or not.
217          */
218         bool getFormat(ALenum &format, AUD_Specs specs);
219
220         // hide copy constructor and operator=
221         AUD_OpenALDevice(const AUD_OpenALDevice&);
222         AUD_OpenALDevice& operator=(const AUD_OpenALDevice&);
223
224 public:
225         /**
226          * Opens the OpenAL audio device for playback.
227          * \param specs The wanted audio specification.
228          * \param buffersize The size of the internal buffer.
229          * \note The specification really used for opening the device may differ.
230          * \note The buffersize will be multiplicated by three for this device.
231          * \exception AUD_Exception Thrown if the audio device cannot be opened.
232          */
233         AUD_OpenALDevice(AUD_DeviceSpecs specs,
234                                          int buffersize = AUD_DEFAULT_BUFFER_SIZE);
235
236         /**
237          * Streaming thread main function.
238          */
239         void updateStreams();
240
241         virtual ~AUD_OpenALDevice();
242
243         virtual AUD_DeviceSpecs getSpecs() const;
244         virtual AUD_Reference<AUD_IHandle> play(AUD_Reference<AUD_IReader> reader, bool keep = false);
245         virtual AUD_Reference<AUD_IHandle> play(AUD_Reference<AUD_IFactory> factory, bool keep = false);
246         virtual void lock();
247         virtual void unlock();
248         virtual float getVolume() const;
249         virtual void setVolume(float volume);
250
251         virtual AUD_Vector3 getListenerLocation() const;
252         virtual void setListenerLocation(const AUD_Vector3& location);
253         virtual AUD_Vector3 getListenerVelocity() const;
254         virtual void setListenerVelocity(const AUD_Vector3& velocity);
255         virtual AUD_Quaternion getListenerOrientation() const;
256         virtual void setListenerOrientation(const AUD_Quaternion& orientation);
257         virtual float getSpeedOfSound() const;
258         virtual void setSpeedOfSound(float speed);
259         virtual float getDopplerFactor() const;
260         virtual void setDopplerFactor(float factor);
261         virtual AUD_DistanceModel getDistanceModel() const;
262         virtual void setDistanceModel(AUD_DistanceModel model);
263 };
264
265 #endif //AUD_OPENALDEVICE