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>
36 #include <boost/foreach.hpp>
38 #include "soundmgr_openal.hxx"
39 #include "readwav.hxx"
40 #include "soundmgr_openal_private.hxx"
41 #include "sample_group.hxx"
43 #include <simgear/sg_inlines.h>
44 #include <simgear/structure/exception.hxx>
45 #include <simgear/debug/logstream.hxx>
46 #include <simgear/misc/sg_path.hxx>
52 #define MAX_SOURCES 128
55 #ifndef ALC_ALL_DEVICES_SPECIFIER
56 # define ALC_ALL_DEVICES_SPECIFIER 0x1013
59 class SGSoundMgr::SoundManagerPrivate
62 SoundManagerPrivate() :
65 _absolute_pos(SGVec3d::zeros()),
66 _base_pos(SGVec3d::zeros()),
67 _orientation(SGQuatd::zeros())
75 _at_up_vec[0] = 0.0; _at_up_vec[1] = 0.0; _at_up_vec[2] = -1.0;
76 _at_up_vec[3] = 0.0; _at_up_vec[4] = 1.0; _at_up_vec[5] = 0.0;
79 void update_pos_and_orientation()
82 * Description: ORIENTATION is a pair of 3-tuples representing the
83 * 'at' direction vector and 'up' direction of the Object in
84 * Cartesian space. AL expects two vectors that are orthogonal to
85 * each other. These vectors are not expected to be normalized. If
86 * one or more vectors have zero length, implementation behavior
87 * is undefined. If the two vectors are linearly dependent,
88 * behavior is undefined.
90 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
92 SGVec3d sgv_at = _orientation.backTransform(-SGVec3d::e3());
93 SGVec3d sgv_up = _orientation.backTransform(SGVec3d::e2());
94 _at_up_vec[0] = sgv_at[0];
95 _at_up_vec[1] = sgv_at[1];
96 _at_up_vec[2] = sgv_at[2];
97 _at_up_vec[3] = sgv_up[0];
98 _at_up_vec[4] = sgv_up[1];
99 _at_up_vec[5] = sgv_up[2];
101 _absolute_pos = _base_pos;
105 ALCcontext *_context;
107 std::vector<ALuint> _free_sources;
108 std::vector<ALuint> _sources_in_use;
110 SGVec3d _absolute_pos;
112 SGQuatd _orientation;
113 // Orientation of the listener.
114 // first 3 elements are "at" vector, second 3 are "up" vector
115 ALfloat _at_up_vec[6];
117 sample_group_map _sample_groups;
127 SGSoundMgr::SGSoundMgr() :
131 _offset_pos(SGVec3d::zeros()),
132 _geod_pos(SGGeod::fromCart(SGVec3d::zeros())),
133 _velocity(SGVec3d::zeros()),
135 _renderer("unknown"),
138 d.reset(new SoundManagerPrivate);
143 SGSoundMgr::~SGSoundMgr() {
147 d->_sample_groups.clear();
150 // initialize the sound manager
151 void SGSoundMgr::init() {
155 SG_LOG( SG_SOUND, SG_ALERT, "Oops, OpenAL sound manager is already initialized." );
159 SG_LOG( SG_SOUND, SG_INFO, "Initializing OpenAL sound manager" );
161 d->_free_sources.clear();
162 d->_free_sources.reserve( MAX_SOURCES );
163 d->_sources_in_use.clear();
164 d->_sources_in_use.reserve( MAX_SOURCES );
166 ALCdevice *device = NULL;
167 const char* devname = _device_name.c_str();
168 if (_device_name == "")
169 devname = NULL; // use default device
172 // try non-default device
173 device = alcOpenDevice(devname);
176 if ((!devname)||(testForError(device, "Audio device not available, trying default.")) ) {
177 device = alcOpenDevice(NULL);
178 if (testForError(device, "Default audio device not available.") ) {
183 ALCcontext *context = alcCreateContext(device, NULL);
184 testForALCError("context creation.");
185 if ( testForError(context, "Unable to create a valid context.") ) {
186 alcCloseDevice (device);
190 if ( !alcMakeContextCurrent(context) ) {
191 testForALCError("context initialization");
192 alcDestroyContext (context);
193 alcCloseDevice (device);
197 if (d->_context != NULL)
199 SG_LOG(SG_SOUND, SG_ALERT, "context is already assigned");
202 d->_context = context;
206 alListenerf( AL_GAIN, 0.0f );
207 alListenerfv( AL_ORIENTATION, d->_at_up_vec );
208 alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
209 alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
211 alDopplerFactor(1.0);
212 alDopplerVelocity(340.3); // speed of sound in meters per second.
214 // gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE +
215 // AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE));
216 alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED);
218 testForALError("listener initialization");
220 // get a free source one at a time
221 // if an error is returned no more (hardware) sources are available
222 for (unsigned int i=0; i<MAX_SOURCES; i++) {
227 alGenSources(1, &source);
228 error = alGetError();
229 if ( error == AL_NO_ERROR ) {
230 d->_free_sources.push_back( source );
232 SG_LOG(SG_SOUND, SG_INFO, "allocating source failed:" << i);
237 _vendor = (const char *)alGetString(AL_VENDOR);
238 _renderer = (const char *)alGetString(AL_RENDERER);
240 if (_vendor == "Creative Labs Inc.") {
243 } else if (_vendor == "OpenAL Community" && _renderer == "OpenAL Soft") {
247 if (d->_free_sources.empty()) {
248 SG_LOG(SG_SOUND, SG_ALERT, "Unable to grab any OpenAL sources!");
252 void SGSoundMgr::reinit()
254 bool was_active = _active;
268 void SGSoundMgr::activate() {
269 if ( is_working() ) {
272 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
273 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
274 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
275 SGSampleGroup *sgrp = sample_grp_current->second;
281 // stop the sound manager
282 void SGSoundMgr::stop() {
284 // first stop all sample groups
285 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
286 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
287 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
288 SGSampleGroup *sgrp = sample_grp_current->second;
292 // clear all OpenAL sources
293 BOOST_FOREACH(ALuint source, d->_free_sources) {
294 alDeleteSources( 1 , &source );
295 testForALError("SGSoundMgr::stop: delete sources");
297 d->_free_sources.clear();
299 // clear any OpenAL buffers before shutting down
300 buffer_map_iterator buffers_current = d->_buffers.begin();
301 buffer_map_iterator buffers_end = d->_buffers.end();
302 for ( ; buffers_current != buffers_end; ++buffers_current ) {
303 refUint ref = buffers_current->second;
304 ALuint buffer = ref.id;
305 alDeleteBuffers(1, &buffer);
306 testForALError("SGSoundMgr::stop: delete buffers");
310 d->_sources_in_use.clear();
314 alcDestroyContext(d->_context);
315 alcCloseDevice(d->_device);
319 _renderer = "unknown";
324 void SGSoundMgr::suspend() {
326 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
327 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
328 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
329 SGSampleGroup *sgrp = sample_grp_current->second;
336 void SGSoundMgr::resume() {
338 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
339 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
340 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
341 SGSampleGroup *sgrp = sample_grp_current->second;
348 // run the audio scheduler
349 void SGSoundMgr::update( double dt ) {
351 alcSuspendContext(d->_context);
354 d->update_pos_and_orientation();
357 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
358 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
359 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
360 SGSampleGroup *sgrp = sample_grp_current->second;
366 if (isNaN(_at_up_vec)) printf("NaN in listener orientation\n");
367 if (isNaN(toVec3f(_absolute_pos).data())) printf("NaN in listener position\n");
368 if (isNaN(_velocity.data())) printf("NaN in listener velocity\n");
370 alListenerf( AL_GAIN, _volume );
371 alListenerfv( AL_ORIENTATION, d->_at_up_vec );
372 // alListenerfv( AL_POSITION, toVec3f(_absolute_pos).data() );
374 SGQuatd hlOr = SGQuatd::fromLonLat( _geod_pos );
375 SGVec3d velocity = SGVec3d::zeros();
376 if ( _velocity[0] || _velocity[1] || _velocity[2] ) {
377 velocity = hlOr.backTransform(_velocity*SG_FEET_TO_METER);
380 if ( _bad_doppler ) {
384 alListenerfv( AL_VELOCITY, toVec3f(velocity).data() );
385 // alDopplerVelocity(340.3); // TODO: altitude dependent
386 testForALError("update");
390 alcProcessContext(d->_context);
394 // add a sample group, return true if successful
395 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
397 sample_group_map_iterator sample_grp_it = d->_sample_groups.find( refname );
398 if ( sample_grp_it != d->_sample_groups.end() ) {
399 // sample group already exists
403 if (_active) sgrp->activate();
404 d->_sample_groups[refname] = sgrp;
410 // remove a sound effect, return true if successful
411 bool SGSoundMgr::remove( const string &refname )
413 sample_group_map_iterator sample_grp_it = d->_sample_groups.find( refname );
414 if ( sample_grp_it == d->_sample_groups.end() ) {
415 // sample group was not found.
419 d->_sample_groups.erase( sample_grp_it );
425 // return true of the specified sound exists in the sound manager system
426 bool SGSoundMgr::exists( const string &refname ) {
427 sample_group_map_iterator sample_grp_it = d->_sample_groups.find( refname );
428 return ( sample_grp_it != d->_sample_groups.end() );
432 // return a pointer to the SGSampleGroup if the specified sound exists
433 // in the sound manager system, otherwise return NULL
434 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
435 sample_group_map_iterator sample_grp_it = d->_sample_groups.find( refname );
436 if ( sample_grp_it == d->_sample_groups.end() ) {
437 // sample group was not found.
439 SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
440 add( sgrp, refname );
447 return sample_grp_it->second;
451 void SGSoundMgr::set_volume( float v )
454 SG_CLAMP_RANGE(_volume, 0.0f, 1.0f);
458 // Get an unused source id
460 // The Sound Manager should keep track of the sources in use, the distance
461 // of these sources to the listener and the volume (also based on audio cone
462 // and hence orientation) of the sources.
464 // The Sound Manager is (and should be) the only one knowing about source
465 // management. Sources further away should be suspended to free resources for
466 // newly added sounds close by.
467 unsigned int SGSoundMgr::request_source()
469 unsigned int source = NO_SOURCE;
471 if (!d->_free_sources.empty()) {
472 source = d->_free_sources.back();
473 d->_free_sources.pop_back();
474 d->_sources_in_use.push_back(source);
477 SG_LOG( SG_SOUND, SG_BULK, "Sound manager: No more free sources available!\n");
482 // Free up a source id for further use
483 void SGSoundMgr::release_source( unsigned int source )
485 vector<ALuint>::iterator it;
487 it = std::find(d->_sources_in_use.begin(), d->_sources_in_use.end(), source);
488 if ( it != d->_sources_in_use.end() ) {
491 alGetSourcei( source, AL_SOURCE_STATE, &result );
492 if ( result == AL_PLAYING || result == AL_PAUSED ) {
493 alSourceStop( source );
496 alSourcei( source, AL_BUFFER, 0 ); // detach the associated buffer
497 testForALError("release_source");
498 d->_free_sources.push_back( source );
499 d->_sources_in_use.erase( it );
503 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
505 ALuint buffer = NO_BUFFER;
507 if ( !sample->is_valid_buffer() ) {
508 // sample was not yet loaded or removed again
509 string sample_name = sample->get_sample_name();
510 void *sample_data = NULL;
512 // see if the sample name is already cached
513 buffer_map_iterator buffer_it = d->_buffers.find( sample_name );
514 if ( buffer_it != d->_buffers.end() ) {
515 buffer_it->second.refctr++;
516 buffer = buffer_it->second.id;
517 sample->set_buffer( buffer );
521 // sample name was not found in the buffer cache.
522 if ( sample->is_file() ) {
527 bool res = load(sample_name, &sample_data, &format, &size, &freq);
528 if (res == false) return NO_BUFFER;
529 } catch (sg_exception& e) {
530 SG_LOG(SG_SOUND, SG_ALERT,
531 "failed to load sound buffer: " << e.getFormattedMessage());
532 sample->set_buffer( SGSoundMgr::FAILED_BUFFER );
533 return FAILED_BUFFER;
536 sample->set_frequency( freq );
537 sample->set_format( format );
538 sample->set_size( size );
541 sample_data = sample->get_data();
544 // create an OpenAL buffer handle
545 alGenBuffers(1, &buffer);
546 if ( !testForALError("generate buffer") ) {
547 // Copy data to the internal OpenAL buffer
549 ALenum format = sample->get_format();
550 ALsizei size = sample->get_size();
551 ALsizei freq = sample->get_frequency();
552 alBufferData( buffer, format, sample_data, size, freq );
554 if ( !testForALError("buffer add data") ) {
555 sample->set_buffer(buffer);
556 d->_buffers[sample_name] = refUint(buffer);
560 if ( sample->is_file() ) free(sample_data);
563 buffer = sample->get_buffer();
569 void SGSoundMgr::release_buffer(SGSoundSample *sample)
571 if ( !sample->is_queue() )
573 string sample_name = sample->get_sample_name();
574 buffer_map_iterator buffer_it = d->_buffers.find( sample_name );
575 if ( buffer_it == d->_buffers.end() ) {
576 // buffer was not found
580 sample->no_valid_buffer();
581 buffer_it->second.refctr--;
582 if (buffer_it->second.refctr == 0) {
583 ALuint buffer = buffer_it->second.id;
584 alDeleteBuffers(1, &buffer);
585 d->_buffers.erase( buffer_it );
586 testForALError("release buffer");
591 bool SGSoundMgr::load(const string &samplepath, void **dbuf, int *fmt,
592 size_t *sz, int *frq )
604 data = simgear::loadWAVFromFile(samplepath, format, size, freqf );
605 freq = (ALsizei)freqf;
607 throw sg_io_exception("Failed to load wav file", sg_location(samplepath));
610 if (format == AL_FORMAT_STEREO8 || format == AL_FORMAT_STEREO16) {
612 throw sg_io_exception("Warning: STEREO files are not supported for 3D audio effects: " + samplepath);
615 *dbuf = (void *)data;
623 vector<const char*> SGSoundMgr::get_available_devices()
625 vector<const char*> devices;
628 if (alcIsExtensionPresent(NULL, "ALC_enumerate_all_EXT") == AL_TRUE) {
629 s = alcGetString(NULL, ALC_ALL_DEVICES_SPECIFIER);
631 s = alcGetString(NULL, ALC_DEVICE_SPECIFIER);
635 ALCchar *nptr, *ptr = (ALCchar *)s;
638 while (*(nptr += strlen(ptr)+1) != 0)
640 devices.push_back(ptr);
643 devices.push_back(ptr);
650 bool SGSoundMgr::testForError(void *p, string s)
653 SG_LOG( SG_SOUND, SG_ALERT, "Error: " << s);
660 bool SGSoundMgr::testForALError(string s)
662 ALenum error = alGetError();
663 if (error != AL_NO_ERROR) {
664 SG_LOG( SG_SOUND, SG_ALERT, "AL Error (sound manager): "
665 << alGetString(error) << " at " << s);
671 bool SGSoundMgr::testForALCError(string s)
674 error = alcGetError(d->_device);
675 if (error != ALC_NO_ERROR) {
676 SG_LOG( SG_SOUND, SG_ALERT, "ALC Error (sound manager): "
677 << alcGetString(d->_device, error) << " at "
684 bool SGSoundMgr::is_working() const
686 return (d->_device != NULL);
689 const SGQuatd& SGSoundMgr::get_orientation() const
691 return d->_orientation;
694 void SGSoundMgr::set_orientation( const SGQuatd& ori )
696 d->_orientation = ori;
700 const SGVec3d& SGSoundMgr::get_position() const
702 return d->_absolute_pos;
705 void SGSoundMgr::set_position( const SGVec3d& pos, const SGGeod& pos_geod )
707 d->_base_pos = pos; _geod_pos = pos_geod; _changed = true;
710 SGVec3f SGSoundMgr::get_direction() const
712 return SGVec3f(d->_at_up_vec[0], d->_at_up_vec[1], d->_at_up_vec[2]);