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 _velocity(SGVec3d::zeros()),
134 _renderer("unknown"),
137 d.reset(new SoundManagerPrivate);
138 d->_base_pos = SGVec3d::fromGeod(_geod_pos);
143 SGSoundMgr::~SGSoundMgr() {
147 d->_sample_groups.clear();
150 // initialize the sound manager
151 void SGSoundMgr::init()
156 SG_LOG( SG_SOUND, SG_ALERT, "Oops, OpenAL sound manager is already initialized." );
160 SG_LOG( SG_SOUND, SG_INFO, "Initializing OpenAL sound manager" );
162 d->_free_sources.clear();
163 d->_free_sources.reserve( MAX_SOURCES );
164 d->_sources_in_use.clear();
165 d->_sources_in_use.reserve( MAX_SOURCES );
167 ALCdevice *device = NULL;
168 const char* devname = _device_name.c_str();
169 if (_device_name == "")
170 devname = NULL; // use default device
173 // try non-default device
174 device = alcOpenDevice(devname);
177 if ((!devname)||(testForError(device, "Audio device not available, trying default.")) ) {
178 device = alcOpenDevice(NULL);
179 if (testForError(device, "Default audio device not available.") ) {
184 ALCcontext *context = alcCreateContext(device, NULL);
185 testForALCError("context creation.");
186 if ( testForError(context, "Unable to create a valid context.") ) {
187 alcCloseDevice (device);
191 if ( !alcMakeContextCurrent(context) ) {
192 testForALCError("context initialization");
193 alcDestroyContext (context);
194 alcCloseDevice (device);
198 if (d->_context != NULL)
200 SG_LOG(SG_SOUND, SG_ALERT, "context is already assigned");
203 d->_context = context;
207 alListenerf( AL_GAIN, 0.0f );
208 alListenerfv( AL_ORIENTATION, d->_at_up_vec );
209 alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
210 alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
212 alDopplerFactor(1.0);
213 alDopplerVelocity(340.3); // speed of sound in meters per second.
215 // gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE +
216 // AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE));
217 alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED);
219 testForALError("listener initialization");
221 // get a free source one at a time
222 // if an error is returned no more (hardware) sources are available
223 for (unsigned int i=0; i<MAX_SOURCES; i++) {
228 alGenSources(1, &source);
229 error = alGetError();
230 if ( error == AL_NO_ERROR ) {
231 d->_free_sources.push_back( source );
233 SG_LOG(SG_SOUND, SG_INFO, "allocating source failed:" << i);
238 _vendor = (const char *)alGetString(AL_VENDOR);
239 _renderer = (const char *)alGetString(AL_RENDERER);
241 if (_vendor == "Creative Labs Inc.") {
244 } else if (_vendor == "OpenAL Community" && _renderer == "OpenAL Soft") {
248 if (d->_free_sources.empty()) {
249 SG_LOG(SG_SOUND, SG_ALERT, "Unable to grab any OpenAL sources!");
254 void SGSoundMgr::reinit()
256 bool was_active = _active;
270 void SGSoundMgr::activate()
273 if ( is_working() ) {
276 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
277 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
278 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
279 SGSampleGroup *sgrp = sample_grp_current->second;
286 // stop the sound manager
287 void SGSoundMgr::stop()
290 // first stop all sample groups
291 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
292 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
293 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
294 SGSampleGroup *sgrp = sample_grp_current->second;
298 // clear all OpenAL sources
299 BOOST_FOREACH(ALuint source, d->_free_sources) {
300 alDeleteSources( 1 , &source );
301 testForALError("SGSoundMgr::stop: delete sources");
303 d->_free_sources.clear();
305 // clear any OpenAL buffers before shutting down
306 buffer_map_iterator buffers_current = d->_buffers.begin();
307 buffer_map_iterator buffers_end = d->_buffers.end();
308 for ( ; buffers_current != buffers_end; ++buffers_current ) {
309 refUint ref = buffers_current->second;
310 ALuint buffer = ref.id;
311 alDeleteBuffers(1, &buffer);
312 testForALError("SGSoundMgr::stop: delete buffers");
316 d->_sources_in_use.clear();
320 alcDestroyContext(d->_context);
321 alcCloseDevice(d->_device);
325 _renderer = "unknown";
331 void SGSoundMgr::suspend()
335 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
336 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
337 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
338 SGSampleGroup *sgrp = sample_grp_current->second;
346 void SGSoundMgr::resume()
350 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
351 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
352 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
353 SGSampleGroup *sgrp = sample_grp_current->second;
361 // run the audio scheduler
362 void SGSoundMgr::update( double dt )
366 alcSuspendContext(d->_context);
369 d->update_pos_and_orientation();
372 sample_group_map_iterator sample_grp_current = d->_sample_groups.begin();
373 sample_group_map_iterator sample_grp_end = d->_sample_groups.end();
374 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
375 SGSampleGroup *sgrp = sample_grp_current->second;
381 if (isNaN(_at_up_vec)) printf("NaN in listener orientation\n");
382 if (isNaN(toVec3f(_absolute_pos).data())) printf("NaN in listener position\n");
383 if (isNaN(_velocity.data())) printf("NaN in listener velocity\n");
385 alListenerf( AL_GAIN, _volume );
386 alListenerfv( AL_ORIENTATION, d->_at_up_vec );
387 // alListenerfv( AL_POSITION, toVec3f(_absolute_pos).data() );
389 SGQuatd hlOr = SGQuatd::fromLonLat( _geod_pos );
390 SGVec3d velocity = SGVec3d::zeros();
391 if ( _velocity[0] || _velocity[1] || _velocity[2] ) {
392 velocity = hlOr.backTransform(_velocity*SG_FEET_TO_METER);
395 if ( _bad_doppler ) {
399 alListenerfv( AL_VELOCITY, toVec3f(velocity).data() );
400 // alDopplerVelocity(340.3); // TODO: altitude dependent
401 testForALError("update");
405 alcProcessContext(d->_context);
410 // add a sample group, return true if successful
411 bool SGSoundMgr::add( SGSampleGroup *sgrp, 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 already exists
419 if (_active) sgrp->activate();
420 d->_sample_groups[refname] = sgrp;
426 // remove a sound effect, return true if successful
427 bool SGSoundMgr::remove( const string &refname )
429 sample_group_map_iterator sample_grp_it = d->_sample_groups.find( refname );
430 if ( sample_grp_it == d->_sample_groups.end() ) {
431 // sample group was not found.
435 d->_sample_groups.erase( sample_grp_it );
441 // return true of the specified sound exists in the sound manager system
442 bool SGSoundMgr::exists( const string &refname ) {
443 sample_group_map_iterator sample_grp_it = d->_sample_groups.find( refname );
444 return ( sample_grp_it != d->_sample_groups.end() );
448 // return a pointer to the SGSampleGroup if the specified sound exists
449 // in the sound manager system, otherwise return NULL
450 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
451 sample_group_map_iterator sample_grp_it = d->_sample_groups.find( refname );
452 if ( sample_grp_it == d->_sample_groups.end() ) {
453 // sample group was not found.
455 SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
456 add( sgrp, refname );
463 return sample_grp_it->second;
467 void SGSoundMgr::set_volume( float v )
470 SG_CLAMP_RANGE(_volume, 0.0f, 1.0f);
474 // Get an unused source id
476 // The Sound Manager should keep track of the sources in use, the distance
477 // of these sources to the listener and the volume (also based on audio cone
478 // and hence orientation) of the sources.
480 // The Sound Manager is (and should be) the only one knowing about source
481 // management. Sources further away should be suspended to free resources for
482 // newly added sounds close by.
483 unsigned int SGSoundMgr::request_source()
485 unsigned int source = NO_SOURCE;
487 if (!d->_free_sources.empty()) {
488 source = d->_free_sources.back();
489 d->_free_sources.pop_back();
490 d->_sources_in_use.push_back(source);
493 SG_LOG( SG_SOUND, SG_BULK, "Sound manager: No more free sources available!\n");
498 // Free up a source id for further use
499 void SGSoundMgr::release_source( unsigned int source )
501 vector<ALuint>::iterator it;
503 it = std::find(d->_sources_in_use.begin(), d->_sources_in_use.end(), source);
504 if ( it != d->_sources_in_use.end() ) {
508 alGetSourcei( source, AL_SOURCE_STATE, &result );
509 if ( result == AL_PLAYING || result == AL_PAUSED ) {
510 alSourceStop( source );
513 alSourcei( source, AL_BUFFER, 0 ); // detach the associated buffer
514 testForALError("release_source");
516 d->_free_sources.push_back( source );
517 d->_sources_in_use.erase( it );
521 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
523 ALuint buffer = NO_BUFFER;
525 if ( !sample->is_valid_buffer() ) {
526 // sample was not yet loaded or removed again
527 string sample_name = sample->get_sample_name();
528 void *sample_data = NULL;
530 // see if the sample name is already cached
531 buffer_map_iterator buffer_it = d->_buffers.find( sample_name );
532 if ( buffer_it != d->_buffers.end() ) {
533 buffer_it->second.refctr++;
534 buffer = buffer_it->second.id;
535 sample->set_buffer( buffer );
539 // sample name was not found in the buffer cache.
540 if ( sample->is_file() ) {
545 bool res = load(sample_name, &sample_data, &format, &size, &freq);
546 if (res == false) return NO_BUFFER;
547 } catch (sg_exception& e) {
548 SG_LOG(SG_SOUND, SG_ALERT,
549 "failed to load sound buffer: " << e.getFormattedMessage());
550 sample->set_buffer( SGSoundMgr::FAILED_BUFFER );
551 return FAILED_BUFFER;
554 sample->set_frequency( freq );
555 sample->set_format( format );
556 sample->set_size( size );
559 sample_data = sample->get_data();
562 // create an OpenAL buffer handle
563 alGenBuffers(1, &buffer);
564 if ( !testForALError("generate buffer") ) {
565 // Copy data to the internal OpenAL buffer
567 ALenum format = sample->get_format();
568 ALsizei size = sample->get_size();
569 ALsizei freq = sample->get_frequency();
570 alBufferData( buffer, format, sample_data, size, freq );
572 if ( !testForALError("buffer add data") ) {
573 sample->set_buffer(buffer);
574 d->_buffers[sample_name] = refUint(buffer);
578 if ( sample->is_file() ) free(sample_data);
581 buffer = sample->get_buffer();
587 void SGSoundMgr::release_buffer(SGSoundSample *sample)
589 if ( !sample->is_queue() )
591 string sample_name = sample->get_sample_name();
592 buffer_map_iterator buffer_it = d->_buffers.find( sample_name );
593 if ( buffer_it == d->_buffers.end() ) {
594 // buffer was not found
598 sample->no_valid_buffer();
599 buffer_it->second.refctr--;
600 if (buffer_it->second.refctr == 0) {
602 ALuint buffer = buffer_it->second.id;
603 alDeleteBuffers(1, &buffer);
605 d->_buffers.erase( buffer_it );
606 testForALError("release buffer");
611 bool SGSoundMgr::load(const string &samplepath, void **dbuf, int *fmt,
612 size_t *sz, int *frq )
624 data = simgear::loadWAVFromFile(samplepath, format, size, freqf );
625 freq = (ALsizei)freqf;
627 throw sg_io_exception("Failed to load wav file", sg_location(samplepath));
630 if (format == AL_FORMAT_STEREO8 || format == AL_FORMAT_STEREO16) {
632 throw sg_io_exception("Warning: STEREO files are not supported for 3D audio effects: " + samplepath);
635 *dbuf = (void *)data;
643 vector<const char*> SGSoundMgr::get_available_devices()
645 vector<const char*> devices;
649 if (alcIsExtensionPresent(NULL, "ALC_enumerate_all_EXT") == AL_TRUE) {
650 s = alcGetString(NULL, ALC_ALL_DEVICES_SPECIFIER);
652 s = alcGetString(NULL, ALC_DEVICE_SPECIFIER);
656 ALCchar *nptr, *ptr = (ALCchar *)s;
659 while (*(nptr += strlen(ptr)+1) != 0)
661 devices.push_back(ptr);
664 devices.push_back(ptr);
671 bool SGSoundMgr::testForError(void *p, string s)
674 SG_LOG( SG_SOUND, SG_ALERT, "Error: " << s);
681 bool SGSoundMgr::testForALError(string s)
684 ALenum error = alGetError();
685 if (error != AL_NO_ERROR) {
686 SG_LOG( SG_SOUND, SG_ALERT, "AL Error (sound manager): "
687 << alGetString(error) << " at " << s);
694 bool SGSoundMgr::testForALCError(string s)
698 error = alcGetError(d->_device);
699 if (error != ALC_NO_ERROR) {
700 SG_LOG( SG_SOUND, SG_ALERT, "ALC Error (sound manager): "
701 << alcGetString(d->_device, error) << " at "
709 bool SGSoundMgr::is_working() const
711 return (d->_device != NULL);
714 const SGQuatd& SGSoundMgr::get_orientation() const
716 return d->_orientation;
719 void SGSoundMgr::set_orientation( const SGQuatd& ori )
721 d->_orientation = ori;
725 const SGVec3d& SGSoundMgr::get_position() const
727 return d->_absolute_pos;
730 void SGSoundMgr::set_position( const SGVec3d& pos, const SGGeod& pos_geod )
732 d->_base_pos = pos; _geod_pos = pos_geod; _changed = true;
735 SGVec3f SGSoundMgr::get_direction() const
737 return SGVec3f(d->_at_up_vec[0], d->_at_up_vec[1], d->_at_up_vec[2]);