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>
48 extern bool isNaN(float *v);
50 #define MAX_SOURCES 128
56 int SGSoundMgr::_alut_init = 0;
59 SGSoundMgr::SGSoundMgr() :
66 _absolute_pos(SGVec3d::zeros()),
67 _offset_pos(SGVec3d::zeros()),
68 _base_pos(SGVec3d::zeros()),
69 _geod_pos(SGGeod::fromCart(SGVec3d::zeros())),
70 _velocity(SGVec3d::zeros()),
71 _orientation(SGQuatd::zeros()),
76 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
77 if (_alut_init == 0) {
78 if ( !alutInitWithoutContext(NULL, NULL) ) {
79 testForALUTError("alut initialization");
89 SGSoundMgr::~SGSoundMgr() {
92 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
94 if (_alut_init == 0) {
100 // initialize the sound manager
101 void SGSoundMgr::init(const char *devname) {
103 SG_LOG( SG_GENERAL, SG_INFO, "Initializing OpenAL sound manager" );
105 ALCdevice *device = alcOpenDevice(devname);
106 if ( testForError(device, "Audio device not available, trying default") ) {
107 device = alcOpenDevice(NULL);
108 if (testForError(device, "Default Audio device not available.") ) {
113 ALCcontext *context = alcCreateContext(device, NULL);
114 if ( testForError(context, "Unable to create a valid context.") ) {
115 alcCloseDevice (device);
119 if ( !alcMakeContextCurrent(context) ) {
120 testForALCError("context initialization");
121 alcDestroyContext (context);
122 alcCloseDevice (device);
126 if (_context != NULL)
127 SG_LOG(SG_GENERAL, SG_ALERT, "context is already assigned");
131 _at_up_vec[0] = 0.0; _at_up_vec[1] = 0.0; _at_up_vec[2] = -1.0;
132 _at_up_vec[3] = 0.0; _at_up_vec[4] = 1.0; _at_up_vec[5] = 0.0;
134 alListenerf( AL_GAIN, 0.0f );
135 alListenerfv( AL_ORIENTATION, _at_up_vec );
136 alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
137 alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
139 alDopplerFactor(1.0);
140 alDopplerVelocity(340.3); // speed of sound in meters per second.
142 // gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE +
143 // AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE));
144 alDistanceModel(AL_INVERSE_DISTANCE_CLAMPED);
146 testForALError("listener initialization");
148 // get a free source one at a time
149 // if an error is returned no more (hardware) sources are available
150 for (unsigned int i=0; i<MAX_SOURCES; i++) {
155 alGenSources(1, &source);
156 error = alGetError();
157 if ( error == AL_NO_ERROR ) {
158 _free_sources.push_back( source );
163 _vendor = (const char *)alGetString(AL_VENDOR);
164 _renderer = (const char *)alGetString(AL_RENDERER);
165 if ( _vendor != "OpenAL Community" ||
166 (_renderer != "Software" && _renderer != "OpenAL Sample Implementation")
172 if (_free_sources.size() == 0) {
173 SG_LOG(SG_GENERAL, SG_ALERT, "Unable to grab any OpenAL sources!");
177 void SGSoundMgr::activate() {
180 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
181 sample_group_map_iterator sample_grp_end = _sample_groups.end();
182 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
183 SGSampleGroup *sgrp = sample_grp_current->second;
189 // stop the sound manager
190 void SGSoundMgr::stop() {
192 // first stop all sample groups
193 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
194 sample_group_map_iterator sample_grp_end = _sample_groups.end();
195 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
196 SGSampleGroup *sgrp = sample_grp_current->second;
200 // clear all OpenAL sources
201 for (unsigned int i=0; i<_free_sources.size(); i++) {
202 ALuint source = _free_sources[i];
203 alDeleteSources( 1 , &source );
205 _free_sources.clear();
207 // clear any OpenAL buffers before shutting down
208 buffer_map_iterator buffers_current = _buffers.begin();
209 buffer_map_iterator buffers_end = _buffers.end();
210 for ( ; buffers_current != buffers_end; ++buffers_current ) {
211 refUint ref = buffers_current->second;
212 ALuint buffer = ref.id;
213 alDeleteBuffers(1, &buffer);
220 _context = alcGetCurrentContext();
221 _device = alcGetContextsDevice(_context);
222 alcDestroyContext(_context);
223 alcCloseDevice(_device);
226 _renderer = "unknown";
231 void SGSoundMgr::suspend() {
233 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
234 sample_group_map_iterator sample_grp_end = _sample_groups.end();
235 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
236 SGSampleGroup *sgrp = sample_grp_current->second;
243 void SGSoundMgr::resume() {
245 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
246 sample_group_map_iterator sample_grp_end = _sample_groups.end();
247 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
248 SGSampleGroup *sgrp = sample_grp_current->second;
255 void SGSoundMgr::bind ()
257 _free_sources.clear();
258 _free_sources.reserve( MAX_SOURCES );
259 _sources_in_use.clear();
260 _sources_in_use.reserve( MAX_SOURCES );
264 void SGSoundMgr::unbind ()
266 _sample_groups.clear();
268 // delete free sources
269 for (unsigned int i=0; i<_free_sources.size(); i++) {
270 ALuint source = _free_sources[i];
271 alDeleteSources( 1 , &source );
274 _free_sources.clear();
275 _sources_in_use.clear();
278 // run the audio scheduler
279 void SGSoundMgr::update( double dt ) {
281 alcSuspendContext(_context);
284 update_pos_and_orientation();
287 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
288 sample_group_map_iterator sample_grp_end = _sample_groups.end();
289 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
290 SGSampleGroup *sgrp = sample_grp_current->second;
296 if (isNaN(_at_up_vec)) printf("NaN in listener orientation\n");
297 if (isNaN(toVec3f(_absolute_pos).data())) printf("NaN in listener position\n");
298 if (isNaN(_velocity.data())) printf("NaN in listener velocity\n");
300 alListenerf( AL_GAIN, _volume );
301 alListenerfv( AL_ORIENTATION, _at_up_vec );
302 // alListenerfv( AL_POSITION, toVec3f(_absolute_pos).data() );
304 SGQuatd hlOr = SGQuatd::fromLonLat( _geod_pos );
305 SGVec3d velocity = SGVec3d::zeros();
306 if ( _velocity[0] || _velocity[1] || _velocity[2] ) {
307 velocity = hlOr.backTransform(_velocity*SG_FEET_TO_METER);
310 if ( _bad_doppler ) {
314 alListenerfv( AL_VELOCITY, toVec3f(velocity).data() );
315 // alDopplerVelocity(340.3); // TODO: altitude dependent
316 testForALError("update");
320 alcProcessContext(_context);
324 // add a sample group, return true if successful
325 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
327 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
328 if ( sample_grp_it != _sample_groups.end() ) {
329 // sample group already exists
333 if (_active) sgrp->activate();
334 _sample_groups[refname] = sgrp;
340 // remove a sound effect, return true if successful
341 bool SGSoundMgr::remove( const string &refname )
343 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
344 if ( sample_grp_it == _sample_groups.end() ) {
345 // sample group was not found.
349 _sample_groups.erase( sample_grp_it );
355 // return true of the specified sound exists in the sound manager system
356 bool SGSoundMgr::exists( const string &refname ) {
357 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
358 if ( sample_grp_it == _sample_groups.end() ) {
359 // sample group was not found.
367 // return a pointer to the SGSampleGroup if the specified sound exists
368 // in the sound manager system, otherwise return NULL
369 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
370 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
371 if ( sample_grp_it == _sample_groups.end() ) {
372 // sample group was not found.
374 SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
375 add( sgrp, refname );
382 return sample_grp_it->second;
386 void SGSoundMgr::set_volume( float v )
389 if (_volume > 1.0) _volume = 1.0;
390 if (_volume < 0.0) _volume = 0.0;
394 // Get an unused source id
396 // The Sound Manager should keep track of the sources in use, the distance
397 // of these sources to the listener and the volume (also based on audio cone
398 // and hence orientation) of the sources.
400 // The Sound Manager is (and should be) the only one knowing about source
401 // management. Sources further away should be suspendped to free resources for
402 // newly added sounds close by.
403 unsigned int SGSoundMgr::request_source()
405 unsigned int source = NO_SOURCE;
407 if (_free_sources.size() > 0) {
408 source = _free_sources.back();
409 _free_sources.pop_back();
410 _sources_in_use.push_back(source);
413 SG_LOG( SG_GENERAL, SG_INFO, "No more free sources available\n");
418 // Free up a source id for further use
419 void SGSoundMgr::release_source( unsigned int source )
421 vector<ALuint>::iterator it;
423 it = std::find(_sources_in_use.begin(), _sources_in_use.end(), source);
424 if ( it != _sources_in_use.end() ) {
427 alGetSourcei( source, AL_SOURCE_STATE, &result );
428 if ( result == AL_PLAYING )
429 alSourceStop( source );
430 testForALError("release source");
432 alSourcei( source, AL_BUFFER, 0 );
433 _free_sources.push_back( source );
434 _sources_in_use.erase( it );
438 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
440 ALuint buffer = NO_BUFFER;
442 if ( !sample->is_valid_buffer() ) {
443 // sample was not yet loaded or removed again
444 string sample_name = sample->get_sample_name();
445 void *sample_data = NULL;
447 // see if the sample name is already cached
448 buffer_map_iterator buffer_it = _buffers.find( sample_name );
449 if ( buffer_it != _buffers.end() ) {
450 buffer_it->second.refctr++;
451 buffer = buffer_it->second.id;
452 sample->set_buffer( buffer );
456 // sample name was not found in the buffer cache.
457 if ( sample->is_file() ) {
462 res = load(sample_name, &sample_data, &format, &size, &freq);
463 if (res == false) return buffer;
465 sample->set_frequency( freq );
466 sample->set_format( format );
467 sample->set_size( size );
470 sample_data = sample->get_data();
472 // create an OpenAL buffer handle
473 alGenBuffers(1, &buffer);
474 if ( !testForALError("generate buffer") ) {
475 // Copy data to the internal OpenAL buffer
477 ALenum format = sample->get_format();
478 ALsizei size = sample->get_size();
479 ALsizei freq = sample->get_frequency();
480 alBufferData( buffer, format, sample_data, size, freq );
482 if ( sample->is_file() ) free(sample_data);
484 if ( !testForALError("buffer add data") ) {
485 sample->set_buffer(buffer);
486 _buffers[sample_name] = refUint(buffer);
491 buffer = sample->get_buffer();
497 void SGSoundMgr::release_buffer(SGSoundSample *sample)
499 string sample_name = sample->get_sample_name();
500 buffer_map_iterator buffer_it = _buffers.find( sample_name );
501 if ( buffer_it == _buffers.end() ) {
502 // buffer was not found
506 sample->no_valid_buffer();
507 buffer_it->second.refctr--;
508 if (buffer_it->second.refctr == 0) {
509 ALuint buffer = buffer_it->second.id;
510 alDeleteBuffers(1, &buffer);
511 _buffers.erase( buffer_it );
512 testForALError("release buffer");
516 void SGSoundMgr::update_pos_and_orientation() {
518 * Description: ORIENTATION is a pair of 3-tuples representing the
519 * 'at' direction vector and 'up' direction of the Object in
520 * Cartesian space. AL expects two vectors that are orthogonal to
521 * each other. These vectors are not expected to be normalized. If
522 * one or more vectors have zero length, implementation behavior
523 * is undefined. If the two vectors are linearly dependent,
524 * behavior is undefined.
526 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
528 SGVec3d sgv_at = _orientation.backTransform(-SGVec3d::e3());
529 SGVec3d sgv_up = _orientation.backTransform(SGVec3d::e2());
530 _at_up_vec[0] = sgv_at[0];
531 _at_up_vec[1] = sgv_at[1];
532 _at_up_vec[2] = sgv_at[2];
533 _at_up_vec[3] = sgv_up[0];
534 _at_up_vec[4] = sgv_up[1];
535 _at_up_vec[5] = sgv_up[2];
537 // static const SGQuatd q(-0.5, -0.5, 0.5, 0.5);
538 // SGQuatd hlOr = SGQuatd::fromLonLat(SGGeod::fromCart(_base_pos));
539 // SGQuatd ec2body = hlOr*_orientation;
540 _absolute_pos = _base_pos; // + ec2body.backTransform( _offset_pos );
543 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
544 size_t *sz, int *frq )
546 if ( !_working ) return false;
553 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
555 data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
556 freq = (ALsizei)freqf;
557 int error = alutGetError();
558 if (data == NULL || error != ALUT_ERROR_NO_ERROR) {
559 string msg = "Failed to load wav file: ";
560 msg.append(alutGetErrorString(error));
561 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
566 ALbyte *fname = (ALbyte *)samplepath.c_str();
567 # if defined (__APPLE__)
568 alutLoadWAVFile( fname, &format, &data, &size, &freq );
571 alutLoadWAVFile( fname, &format, &data, &size, &freq, &loop );
573 ALenum error = alGetError();
574 if ( error != AL_NO_ERROR ) {
575 string msg = "Failed to load wav file: ";
576 const ALchar *errorString = alGetString(error);
578 msg.append(errorString);
580 // alGetString returns NULL when an unexpected or OS specific error
581 // occurs: e.g. -43 on Mac when file is not found.
582 // In this case, alGetString() sets 'Invalid Enum' error, so
583 // showing with the original error number is helpful.
585 ss << alGetString(alGetError()) << "(" << error << ")";
586 msg.append(ss.str());
588 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
593 *dbuf = (void *)data;
601 vector<const char*> SGSoundMgr::get_available_devices()
603 vector<const char*> devices;
606 if (alcIsExtensionPresent(NULL, "ALC_enumerate_all_EXT") == AL_TRUE) {
607 s = alcGetString(NULL, ALC_ALL_DEVICES_SPECIFIER);
609 s = alcGetString(NULL, ALC_DEVICE_SPECIFIER);
613 ALCchar *nptr, *ptr = (ALCchar *)s;
616 while (*(nptr += strlen(ptr)+1) != 0)
618 devices.push_back(ptr);
621 devices.push_back(ptr);
628 bool SGSoundMgr::testForError(void *p, string s)
631 SG_LOG( SG_GENERAL, SG_ALERT, "Error: " << s);
638 bool SGSoundMgr::testForALError(string s)
640 ALenum error = alGetError();
641 if (error != AL_NO_ERROR) {
642 SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (sound manager): "
643 << alGetString(error) << " at " << s);
649 bool SGSoundMgr::testForALCError(string s)
652 error = alcGetError(_device);
653 if (error != ALC_NO_ERROR) {
654 SG_LOG( SG_GENERAL, SG_ALERT, "ALC Error (sound manager): "
655 << alcGetString(_device, error) << " at "
662 bool SGSoundMgr::testForALUTError(string s)
664 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
666 error = alutGetError ();
667 if (error != ALUT_ERROR_NO_ERROR) {
668 SG_LOG( SG_GENERAL, SG_ALERT, "ALUT Error (sound manager): "
669 << alutGetErrorString(error) << " at "