Audaspace:
[blender-staging.git] / intern / audaspace / intern / AUD_SoftwareDevice.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_SoftwareDevice.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_SOFTWAREDEVICE_H__
31 #define __AUD_SOFTWAREDEVICE_H__
32
33 #include "AUD_IDevice.h"
34 #include "AUD_IHandle.h"
35 #include "AUD_I3DDevice.h"
36 #include "AUD_I3DHandle.h"
37 #include "AUD_Mixer.h"
38 #include "AUD_Buffer.h"
39 #include "AUD_PitchReader.h"
40 #include "AUD_ResampleReader.h"
41 #include "AUD_ChannelMapperReader.h"
42
43 #include <list>
44 #include <pthread.h>
45
46 /**
47  * This device plays is a generic device with software mixing.
48  * Classes implementing this have to:
49  *  - Implement the playing function.
50  *  - Prepare the m_specs, m_mixer variables.
51  *  - Call the create and destroy functions.
52  *  - Call the mix function to retrieve their audio data.
53  */
54 class AUD_SoftwareDevice : public AUD_IDevice, public AUD_I3DDevice
55 {
56 protected:
57         /// Saves the data for playback.
58         class AUD_SoftwareHandle : public AUD_IHandle, public AUD_I3DHandle
59         {
60         public:
61                 /// The reader source.
62                 boost::shared_ptr<AUD_IReader> m_reader;
63
64                 /// The pitch reader in between.
65                 boost::shared_ptr<AUD_PitchReader> m_pitch;
66
67                 /// The resample reader in between.
68                 boost::shared_ptr<AUD_ResampleReader> m_resampler;
69
70                 /// The channel mapper reader in between.
71                 boost::shared_ptr<AUD_ChannelMapperReader> m_mapper;
72
73                 /// Whether to keep the source if end of it is reached.
74                 bool m_keep;
75
76                 /// The user set pitch of the source.
77                 float m_user_pitch;
78
79                 /// The user set volume of the source.
80                 float m_user_volume;
81
82                 /// The user set panning for non-3D sources
83                 float m_user_pan;
84
85                 /// The calculated final volume of the source.
86                 float m_volume;
87
88                 /// The loop count of the source.
89                 int m_loopcount;
90
91                 /// Location in 3D Space.
92                 AUD_Vector3 m_location;
93
94                 /// Velocity in 3D Space.
95                 AUD_Vector3 m_velocity;
96
97                 /// Orientation in 3D Space.
98                 AUD_Quaternion m_orientation;
99
100                 /// Whether the position to the listener is relative or absolute
101                 bool m_relative;
102
103                 /// Maximum volume.
104                 float m_volume_max;
105
106                 /// Minimum volume.
107                 float m_volume_min;
108
109                 /// Maximum distance.
110                 float m_distance_max;
111
112                 /// Reference distance;
113                 float m_distance_reference;
114
115                 /// Attenuation
116                 float m_attenuation;
117
118                 /// Cone outer angle.
119                 float m_cone_angle_outer;
120
121                 /// Cone inner angle.
122                 float m_cone_angle_inner;
123
124                 /// Cone outer volume.
125                 float m_cone_volume_outer;
126
127                 /// Rendering flags
128                 int m_flags;
129
130                 /// The stop callback.
131                 stopCallback m_stop;
132
133                 /// Stop callback data.
134                 void* m_stop_data;
135
136                 /// Current status of the handle
137                 AUD_Status m_status;
138
139                 /// Own device.
140                 AUD_SoftwareDevice* m_device;
141
142         public:
143
144                 /**
145                  * Creates a new software handle.
146                  * \param device The device this handle is from.
147                  * \param reader The reader to play.
148                  * \param pitch The pitch reader.
149                  * \param resampler The resampling reader.
150                  * \param mapper The channel mapping reader.
151                  * \param keep Whether to keep the handle when the sound ends.
152                  */
153                 AUD_SoftwareHandle(AUD_SoftwareDevice* device, boost::shared_ptr<AUD_IReader> reader, boost::shared_ptr<AUD_PitchReader> pitch, boost::shared_ptr<AUD_ResampleReader> resampler, boost::shared_ptr<AUD_ChannelMapperReader> mapper, bool keep);
154
155                 /**
156                  * Updates the handle's playback parameters.
157                  */
158                 void update();
159
160                 /**
161                  * Sets the audio output specification of the readers.
162                  * \param sepcs The output specification.
163                  */
164                 void setSpecs(AUD_Specs specs);
165
166                 virtual ~AUD_SoftwareHandle() {}
167                 virtual bool pause();
168                 virtual bool resume();
169                 virtual bool stop();
170                 virtual bool getKeep();
171                 virtual bool setKeep(bool keep);
172                 virtual bool seek(float position);
173                 virtual float getPosition();
174                 virtual AUD_Status getStatus();
175                 virtual float getVolume();
176                 virtual bool setVolume(float volume);
177                 virtual float getPitch();
178                 virtual bool setPitch(float pitch);
179                 virtual int getLoopCount();
180                 virtual bool setLoopCount(int count);
181                 virtual bool setStopCallback(stopCallback callback = 0, void* data = 0);
182
183                 virtual AUD_Vector3 getSourceLocation();
184                 virtual bool setSourceLocation(const AUD_Vector3& location);
185                 virtual AUD_Vector3 getSourceVelocity();
186                 virtual bool setSourceVelocity(const AUD_Vector3& velocity);
187                 virtual AUD_Quaternion getSourceOrientation();
188                 virtual bool setSourceOrientation(const AUD_Quaternion& orientation);
189                 virtual bool isRelative();
190                 virtual bool setRelative(bool relative);
191                 virtual float getVolumeMaximum();
192                 virtual bool setVolumeMaximum(float volume);
193                 virtual float getVolumeMinimum();
194                 virtual bool setVolumeMinimum(float volume);
195                 virtual float getDistanceMaximum();
196                 virtual bool setDistanceMaximum(float distance);
197                 virtual float getDistanceReference();
198                 virtual bool setDistanceReference(float distance);
199                 virtual float getAttenuation();
200                 virtual bool setAttenuation(float factor);
201                 virtual float getConeAngleOuter();
202                 virtual bool setConeAngleOuter(float angle);
203                 virtual float getConeAngleInner();
204                 virtual bool setConeAngleInner(float angle);
205                 virtual float getConeVolumeOuter();
206                 virtual bool setConeVolumeOuter(float volume);
207         };
208
209         typedef std::list<boost::shared_ptr<AUD_SoftwareHandle> >::iterator AUD_HandleIterator;
210
211         /**
212          * The specification of the device.
213          */
214         AUD_DeviceSpecs m_specs;
215
216         /**
217          * The mixer.
218          */
219         boost::shared_ptr<AUD_Mixer> m_mixer;
220
221         /**
222          * Whether to do high or low quality resampling.
223          */
224         bool m_quality;
225
226         /**
227          * Initializes member variables.
228          */
229         void create();
230
231         /**
232          * Uninitializes member variables.
233          */
234         void destroy();
235
236         /**
237          * Mixes the next samples into the buffer.
238          * \param buffer The target buffer.
239          * \param length The length in samples to be filled.
240          */
241         void mix(data_t* buffer, int length);
242
243         /**
244          * This function tells the device, to start or pause playback.
245          * \param playing True if device should playback.
246          */
247         virtual void playing(bool playing)=0;
248
249         /**
250          * Sets the audio output specification of the device.
251          * \param sepcs The output specification.
252          */
253         void setSpecs(AUD_Specs specs);
254
255 private:
256         /**
257          * The reading buffer.
258          */
259         AUD_Buffer m_buffer;
260
261         /**
262          * The list of sounds that are currently playing.
263          */
264         std::list<boost::shared_ptr<AUD_SoftwareHandle> > m_playingSounds;
265
266         /**
267          * The list of sounds that are currently paused.
268          */
269         std::list<boost::shared_ptr<AUD_SoftwareHandle> > m_pausedSounds;
270
271         /**
272          * Whether there is currently playback.
273          */
274         bool m_playback;
275
276         /**
277          * The mutex for locking.
278          */
279         pthread_mutex_t m_mutex;
280
281         /**
282          * The overall volume of the device.
283          */
284         float m_volume;
285
286         /// Listener location.
287         AUD_Vector3 m_location;
288
289         /// Listener velocity.
290         AUD_Vector3 m_velocity;
291
292         /// Listener orientation.
293         AUD_Quaternion m_orientation;
294
295         /// Speed of Sound.
296         float m_speed_of_sound;
297
298         /// Doppler factor.
299         float m_doppler_factor;
300
301         /// Distance model.
302         AUD_DistanceModel m_distance_model;
303
304         /// Rendering flags
305         int m_flags;
306
307 public:
308
309         /**
310          * Sets the panning of a specific handle.
311          * \param handle The handle to set the panning from.
312          * \param pan The new panning value, should be in the range [-2, 2].
313          */
314         static void setPanning(AUD_IHandle* handle, float pan);
315
316         /**
317          * Sets the resampling quality.
318          * \param quality Low (false) or high (true) quality.
319          */
320         void setQuality(bool quality);
321
322         virtual AUD_DeviceSpecs getSpecs() const;
323         virtual boost::shared_ptr<AUD_IHandle> play(boost::shared_ptr<AUD_IReader> reader, bool keep = false);
324         virtual boost::shared_ptr<AUD_IHandle> play(boost::shared_ptr<AUD_IFactory> factory, bool keep = false);
325         virtual void stopAll();
326         virtual void lock();
327         virtual void unlock();
328         virtual float getVolume() const;
329         virtual void setVolume(float volume);
330
331         virtual AUD_Vector3 getListenerLocation() const;
332         virtual void setListenerLocation(const AUD_Vector3& location);
333         virtual AUD_Vector3 getListenerVelocity() const;
334         virtual void setListenerVelocity(const AUD_Vector3& velocity);
335         virtual AUD_Quaternion getListenerOrientation() const;
336         virtual void setListenerOrientation(const AUD_Quaternion& orientation);
337         virtual float getSpeedOfSound() const;
338         virtual void setSpeedOfSound(float speed);
339         virtual float getDopplerFactor() const;
340         virtual void setDopplerFactor(float factor);
341         virtual AUD_DistanceModel getDistanceModel() const;
342         virtual void setDistanceModel(AUD_DistanceModel model);
343 };
344
345 #endif //__AUD_SOFTWAREDEVICE_H__