1 // soundmgr.cxx -- 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.
29 # include <simgear_config.h>
32 #if defined( __APPLE__ )
33 # include <OpenAL/alut.h>
41 #include "soundmgr_openal.hxx"
43 #include <simgear/structure/exception.hxx>
44 #include <simgear/debug/logstream.hxx>
45 #include <simgear/misc/sg_path.hxx>
46 #include <simgear/math/SGMath.hxx>
49 #define MAX_SOURCES 128
55 int SGSoundMgr::_alut_init = 0;
58 SGSoundMgr::SGSoundMgr() :
65 _position(SGVec3d::zeros()),
66 _velocity(SGVec3d::zeros()),
67 _orientation(SGQuatd::zeros()),
70 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
71 if (_alut_init == 0) {
72 if ( !alutInitWithoutContext(NULL, NULL) ) {
73 testForALUTError("alut initialization");
83 SGSoundMgr::~SGSoundMgr() {
86 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
88 if (_alut_init == 0) {
94 // initialize the sound manager
95 void SGSoundMgr::init() {
97 SG_LOG( SG_GENERAL, SG_INFO, "Initializing OpenAL sound manager" );
99 ALCdevice *device = alcOpenDevice(_devname);
100 if ( testForError(device, "No default audio device available.") ) {
104 ALCcontext *context = alcCreateContext(device, NULL);
105 if ( testForError(context, "Unable to create a valid context.") ) {
106 alcCloseDevice (device);
110 if ( !alcMakeContextCurrent(context) ) {
111 testForALCError("context initialization");
112 alcDestroyContext (context);
113 alcCloseDevice (device);
120 _at_up_vec[0] = 0.0; _at_up_vec[1] = 0.0; _at_up_vec[2] = -1.0;
121 _at_up_vec[3] = 0.0; _at_up_vec[4] = 1.0; _at_up_vec[5] = 0.0;
123 alListenerf( AL_GAIN, 0.2f );
124 alListenerfv( AL_ORIENTATION, _at_up_vec );
125 alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
126 alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
128 alDopplerFactor(1.0);
129 alDopplerVelocity(340.3); // speed of sound in meters per second.
131 if ( alIsExtensionPresent((const ALchar*)"EXT_exponent_distance") ) {
132 alDistanceModel(AL_EXPONENT_DISTANCE);
134 alDistanceModel(AL_INVERSE_DISTANCE);
137 testForALError("listener initialization");
139 // get a free source one at a time
140 // if an error is returned no more (hardware) sources are available
141 for (unsigned int i=0; i<MAX_SOURCES; i++) {
146 alGenSources(1, &source);
147 error = alGetError();
148 if ( error == AL_NO_ERROR ) {
149 _free_sources.push_back( source );
154 if (_free_sources.size() == 0) {
155 SG_LOG(SG_GENERAL, SG_ALERT, "Unable to grab any OpenAL sources!");
158 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
159 sample_group_map_iterator sample_grp_end = _sample_groups.end();
160 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
161 SGSampleGroup *sgrp = sample_grp_current->second;
166 // stop the sound manager
167 void SGSoundMgr::stop() {
172 // clear any OpenAL buffers before shutting down
173 buffer_map_iterator buffers_current;
174 while(_buffers.size()){
175 buffers_current = _buffers.begin();
176 refUint ref = buffers_current->second;
177 ALuint buffer = ref.id;
178 alDeleteBuffers(1, &buffer);
179 _buffers.erase( buffers_current );
182 alcDestroyContext(_context);
183 alcCloseDevice(_device);
187 void SGSoundMgr::suspend() {
189 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
190 sample_group_map_iterator sample_grp_end = _sample_groups.end();
191 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
192 SGSampleGroup *sgrp = sample_grp_current->second;
199 void SGSoundMgr::resume() {
201 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
202 sample_group_map_iterator sample_grp_end = _sample_groups.end();
203 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
204 SGSampleGroup *sgrp = sample_grp_current->second;
211 void SGSoundMgr::bind ()
213 _free_sources.clear();
214 _free_sources.reserve( MAX_SOURCES );
215 _sources_in_use.clear();
216 _sources_in_use.reserve( MAX_SOURCES );
220 void SGSoundMgr::unbind ()
222 _sample_groups.clear();
224 // delete free sources
225 for (unsigned int i=0; i<_free_sources.size(); i++) {
226 ALuint source = _free_sources.at( i );
227 alDeleteSources( 1 , &source );
230 _free_sources.clear();
231 _sources_in_use.clear();
234 // run the audio scheduler
235 void SGSoundMgr::update_late( double dt ) {
237 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
238 sample_group_map_iterator sample_grp_end = _sample_groups.end();
239 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
240 SGSampleGroup *sgrp = sample_grp_current->second;
245 alListenerf( AL_GAIN, _volume );
246 alListenerfv( AL_ORIENTATION, _at_up_vec );
247 alListenerfv( AL_POSITION, toVec3f(_position).data() );
248 alListenerfv( AL_VELOCITY, toVec3f(_velocity).data() );
249 // alDopplerVelocity(340.3); // TODO: altitude dependent
250 testForALError("update");
256 // add a sample group, return true if successful
257 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
259 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
260 if ( sample_grp_it != _sample_groups.end() ) {
261 // sample group already exists
265 if (_working) sgrp->activate();
266 _sample_groups[refname] = sgrp;
272 // remove a sound effect, return true if successful
273 bool SGSoundMgr::remove( const string &refname )
275 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
276 if ( sample_grp_it == _sample_groups.end() ) {
277 // sample group was not found.
281 _sample_groups.erase( refname );
287 // return true of the specified sound exists in the sound manager system
288 bool SGSoundMgr::exists( const string &refname ) {
289 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
290 if ( sample_grp_it == _sample_groups.end() ) {
291 // sample group was not found.
299 // return a pointer to the SGSampleGroup if the specified sound exists
300 // in the sound manager system, otherwise return NULL
301 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
302 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
303 if ( sample_grp_it == _sample_groups.end() ) {
304 // sample group was not found.
306 SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
313 return sample_grp_it->second;
317 void SGSoundMgr::set_volume( float v )
320 if (_volume > 1.0) _volume = 1.0;
321 if (_volume < 0.0) _volume = 0.0;
326 * set the orientation of the listener (in opengl coordinates)
328 * Description: ORIENTATION is a pair of 3-tuples representing the
329 * 'at' direction vector and 'up' direction of the Object in
330 * Cartesian space. AL expects two vectors that are orthogonal to
331 * each other. These vectors are not expected to be normalized. If
332 * one or more vectors have zero length, implementation behavior
333 * is undefined. If the two vectors are linearly dependent,
334 * behavior is undefined.
336 void SGSoundMgr::set_orientation( SGQuatd ori )
340 SGVec3d sgv_up = ori.rotate(SGVec3d::e2());
341 SGVec3d sgv_at = ori.rotate(SGVec3d::e3());
342 _at_up_vec[0] = sgv_at[0];
343 _at_up_vec[1] = sgv_at[1];
344 _at_up_vec[2] = sgv_at[2];
345 _at_up_vec[3] = sgv_up[0];
346 _at_up_vec[4] = sgv_up[1];
347 _at_up_vec[5] = sgv_up[2];
351 // Get an unused source id
353 // The Sound Manager should keep track of the sources in use, the distance
354 // of these sources to the listener and the volume (also based on audio cone
355 // and hence orientation) of the sources.
357 // The Sound Manager is (and should be) the only one knowing about source
358 // management. Sources further away should be suspendped to free resources for
359 // newly added sounds close by.
360 unsigned int SGSoundMgr::request_source()
362 unsigned int source = NO_SOURCE;
364 if (_free_sources.size() > 0) {
365 source = _free_sources.back();
366 _free_sources.pop_back();
367 _sources_in_use.push_back(source);
373 // Free up a source id for further use
374 void SGSoundMgr::release_source( unsigned int source )
376 vector<ALuint>::iterator it;
378 it = std::find(_sources_in_use.begin(), _sources_in_use.end(), source);
379 if ( it != _sources_in_use.end() ) {
382 alGetSourcei( source, AL_SOURCE_STATE, &result );
383 if ( result == AL_PLAYING )
384 alSourceStop( source );
385 testForALError("release source");
387 _free_sources.push_back(source);
388 _sources_in_use.erase(it, it+1);
392 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
394 ALuint buffer = NO_BUFFER;
396 if ( !sample->is_valid_buffer() ) {
397 // sample was not yet loaded or removed again
398 string sample_name = sample->get_sample_name();
400 // see if the sample name is already cached
401 buffer_map_iterator buffer_it = _buffers.find( sample_name );
402 if ( buffer_it != _buffers.end() ) {
403 buffer_it->second.refctr++;
404 buffer = buffer_it->second.id;
405 sample->set_buffer( buffer );
409 // sample name was not found in the buffer cache.
410 if ( sample->is_file() ) {
415 load(sample_name, &data, &format, &size, &freq);
416 sample->set_data( (unsigned char *)data );
417 sample->set_frequency( freq );
418 sample->set_format( format );
419 sample->set_size( size );
422 // create an OpenAL buffer handle
423 alGenBuffers(1, &buffer);
424 if ( !testForALError("generate buffer") ) {
425 // Copy data to the internal OpenAL buffer
427 const ALvoid *data = sample->get_data();
428 ALenum format = sample->get_format();
429 ALsizei size = sample->get_size();
430 ALsizei freq = sample->get_frequency();
431 alBufferData( buffer, format, data, size, freq );
433 // If this sample was read from a file we have all the information
434 // needed to read it again. For data buffers provided by the
435 // program we don't; so don't delete it's data.
436 if (sample->is_file()) sample->free_data();
438 if ( !testForALError("buffer add data") ) {
439 sample->set_buffer(buffer);
440 _buffers[sample_name] = refUint(buffer);
445 buffer = sample->get_buffer();
450 void SGSoundMgr::release_buffer(SGSoundSample *sample)
452 string sample_name = sample->get_sample_name();
454 buffer_map_iterator buffer_it = _buffers.find( sample_name );
455 if ( buffer_it == _buffers.end() ) {
456 // buffer was not found
460 sample->no_valid_buffer();
461 buffer_it->second.refctr--;
462 if (buffer_it->second.refctr == 0) {
463 ALuint buffer = buffer_it->second.id;
464 _buffers.erase( buffer_it );
465 alDeleteBuffers(1, &buffer);
466 testForALError("release buffer");
470 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
471 size_t *sz, int *frq )
478 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
480 data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
481 freq = (ALsizei)freqf;
483 int error = alutGetError();
484 string msg = "Failed to load wav file: ";
485 msg.append(alutGetErrorString(error));
486 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
491 ALbyte *fname = (ALbyte *)samplepath.c_str();
492 # if defined (__APPLE__)
493 alutLoadWAVFile( fname, &format, &data, &size, &freq );
496 alutLoadWAVFile( fname, &format, &data, &size, &freq, &loop );
498 ALenum error = alGetError();
499 if ( error != AL_NO_ERROR ) {
500 string msg = "Failed to load wav file: ";
501 msg.append(alutGetErrorString(error));
502 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
507 *dbuf = (void *)data;
516 bool SGSoundMgr::testForError(void *p, string s)
519 SG_LOG( SG_GENERAL, SG_ALERT, "Error: " << s);
526 bool SGSoundMgr::testForALError(string s)
528 ALenum error = alGetError();
529 if (error != AL_NO_ERROR) {
530 SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (sound manager): "
531 << alGetString(error) << " at " << s);
537 bool SGSoundMgr::testForALCError(string s)
540 error = alcGetError(_device);
541 if (error != ALC_NO_ERROR) {
542 SG_LOG( SG_GENERAL, SG_ALERT, "ALC Error (sound manager): "
543 << alcGetString(_device, error) << " at "
550 bool SGSoundMgr::testForALUTError(string s)
552 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
554 error = alutGetError ();
555 if (error != ALUT_ERROR_NO_ERROR) {
556 SG_LOG( SG_GENERAL, SG_ALERT, "ALUT Error (sound manager): "
557 << alutGetErrorString(error) << " at "