1 // soundmgr.hxx -- Sound effect management class
3 // Sound manager initially written by David Findlay
4 // <david_j_findlay@yahoo.com.au> 2001
6 // C++-ified by Curtis Olson, started March 2001.
7 // Modified for the new SoundSystem by Erik Hofman, October 2009
9 // Copyright (C) 2001 Curtis L. Olson - http://www.flightgear.org/~curt
10 // Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
12 // This program is free software; you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of the
15 // License, or (at your option) any later version.
17 // This program is distributed in the hope that it will be useful, but
18 // WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 // General Public License for more details.
22 // You should have received a copy of the GNU General Public License
23 // along with this program; if not, write to the Free Software Foundation,
24 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 * Provides a sound manager class to keep track of
31 * multiple sounds and manage playing them with different effects and
35 #ifndef _SG_SOUNDMGR_OPENAL_HXX
36 #define _SG_SOUNDMGR_OPENAL_HXX 1
39 # error This library requires C++
46 #if defined(__APPLE__)
47 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
48 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
49 # include <OpenAL/al.h>
50 # include <OpenAL/alc.h>
51 # include <OpenAL/alut.h>
52 #elif defined(OPENALSDK)
62 #ifndef ALC_ALL_DEVICES_SPECIFIER
63 # define ALC_ALL_DEVICES_SPECIFIER 0x1013
66 #include <simgear/compiler.h>
67 #include <simgear/structure/subsystem_mgr.hxx>
68 #include <simgear/math/SGMathFwd.hxx>
70 #include "sample_group.hxx"
71 #include "sample_openal.hxx"
79 refUint() { refctr = 0; id = (ALuint)-1; };
80 refUint(ALuint i) { refctr = 1; id = i; };
84 typedef std::map < string, refUint > buffer_map;
85 typedef buffer_map::iterator buffer_map_iterator;
86 typedef buffer_map::const_iterator const_buffer_map_iterator;
88 typedef std::map < string, SGSharedPtr<SGSampleGroup> > sample_group_map;
89 typedef sample_group_map::iterator sample_group_map_iterator;
90 typedef sample_group_map::const_iterator const_sample_group_map_iterator;
93 * Manage a collection of SGSampleGroup instances
95 class SGSoundMgr : public SGSubsystem
102 void init(const char *devname = NULL);
105 void update(double dt);
111 inline void reinit() { stop(); init(); }
114 * Test is the sound manager is in a working condition.
115 * @return true is the sound manager is working
117 inline bool is_working() const { return _working; }
120 * Set the sound manager to a working condition.
125 * Test is the sound manager is in an active and working condition.
126 * @return true is the sound manager is active
128 inline bool is_active() const { return _active; }
131 * Register a sample group to the sound manager.
132 * @para sgrp Pointer to a sample group to add
133 * @param refname Reference name of the sample group
134 * @return true if successful, false otherwise
136 bool add( SGSampleGroup *sgrp, const string& refname );
139 * Remove a sample group from the sound manager.
140 * @param refname Reference name of the sample group to remove
141 * @return true if successful, false otherwise
143 bool remove( const string& refname );
146 * Test if a specified sample group is registered at the sound manager
147 * @param refname Reference name of the sample group test for
148 * @return true if the specified sample group exists
150 bool exists( const string& refname );
153 * Find a specified sample group in the sound manager
154 * @param refname Reference name of the sample group to find
155 * @return A pointer to the SGSampleGroup
157 SGSampleGroup *find( const string& refname, bool create = false );
160 * Set the Cartesian position of the sound manager.
161 * @param pos OpenAL listener position
163 void set_position( const SGVec3d& pos, const SGGeod& pos_geod ) {
164 _base_pos = pos; _geod_pos = pos_geod; _changed = true;
167 void set_position_offset( const SGVec3d& pos ) {
168 _offset_pos = pos; _changed = true;
172 * Get the position of the sound manager.
173 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
174 * @return OpenAL listener position
176 SGVec3d& get_position() { return _absolute_pos; }
179 * Set the velocity vector (in meters per second) of the sound manager
180 * This is the horizontal local frame; x=north, y=east, z=down
181 * @param Velocity vector
183 void set_velocity( const SGVec3d& vel ) {
184 _velocity = vel; _changed = true;
188 * Get the velocity vector of the sound manager
189 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
190 * @return Velocity vector of the OpenAL listener
192 inline SGVec3f get_velocity() { return toVec3f(_velocity); }
195 * Set the orientation of the sound manager
196 * @param ori Quaternation containing the orientation information
198 void set_orientation( const SGQuatd& ori ) {
199 _orientation = ori; _changed = true;
203 * Get the orientation of the sound manager
204 * @return Quaternation containing the orientation information
206 inline const SGQuatd& get_orientation() { return _orientation; }
209 * Get the direction vector of the sound manager
210 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
211 * @return Look-at direction of the OpenAL listener
213 SGVec3f get_direction() {
214 return SGVec3f(_at_up_vec[0], _at_up_vec[1], _at_up_vec[2]);
218 NO_SOURCE = (unsigned int)-1,
219 NO_BUFFER = (unsigned int)-1
223 * Set the master volume.
224 * @param vol Volume (must be between 0.0 and 1.0)
226 void set_volume( float vol );
229 * Get the master volume.
230 * @return Volume (must be between 0.0 and 1.0)
232 inline float get_volume() { return _volume; }
235 * Get a free OpenAL source-id
236 * @return NO_SOURCE if no source is available
238 unsigned int request_source();
241 * Free an OpenAL source-id for future use
242 * @param source OpenAL source-id to free
244 void release_source( unsigned int source );
247 * Get a free OpenAL buffer-id
248 * The buffer-id will be asigned to the sample by calling this function.
249 * @param sample Pointer to an audio sample to assign the buffer-id to
250 * @return NO_BUFFER if loading of the buffer failed.
252 unsigned int request_buffer(SGSoundSample *sample);
255 * Free an OpenAL buffer-id for this sample
256 * @param sample Pointer to an audio sample for which to free the buffer
258 void release_buffer( SGSoundSample *sample );
261 * Test if the position of the sound manager has changed.
262 * The value will be set to false upon the next call to update_late()
263 * @return true if the position has changed
265 inline bool has_changed() { return _changed; }
268 * Some implementations seem to need the velocity miltyplied by a
269 * factor of 100 to make them distinct. I've not found if this is
270 * a problem in the implementation or in out code. Until then
271 * this function is used to detect the problematic implementations.
273 inline bool bad_doppler_effect() { return _bad_doppler; }
276 * Load a sample file and return it's configuration and data.
277 * @param samplepath Path to the file to load
278 * @param data Pointer to a variable that points to the allocated data
279 * @param format Pointer to a vairable that gets the OpenAL format
280 * @param size Pointer to a vairable that gets the sample size in bytes
281 * @param freq Pointer to a vairable that gets the sample frequency in Herz
282 * @return true if succesful, false on error
284 bool load(string &samplepath, void **data, int *format,
285 size_t *size, int *freq );
288 * Get a list of available playback devices.
290 vector<const char*> get_available_devices();
293 static int _alut_init;
301 ALCcontext *_context;
303 // Position of the listener.
304 SGVec3d _absolute_pos;
309 // Velocity of the listener.
312 // Orientation of the listener.
313 // first 3 elements are "at" vector, second 3 are "up" vector
314 SGQuatd _orientation;
315 ALfloat _at_up_vec[6];
317 sample_group_map _sample_groups;
320 vector<ALuint> _free_sources;
321 vector<ALuint> _sources_in_use;
325 bool testForALError(string s);
326 bool testForALCError(string s);
327 bool testForALUTError(string s);
328 bool testForError(void *p, string s);
330 void update_pos_and_orientation();
331 void update_sample_config( SGSampleGroup *sound );
335 #endif // _SG_SOUNDMGR_OPENAL_HXX