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);
117 if (_context != NULL)
118 SG_LOG(SG_GENERAL, SG_ALERT, "context is already assigned");
122 _at_up_vec[0] = 0.0; _at_up_vec[1] = 0.0; _at_up_vec[2] = -1.0;
123 _at_up_vec[3] = 0.0; _at_up_vec[4] = 1.0; _at_up_vec[5] = 0.0;
125 alListenerf( AL_GAIN, 0.0f );
126 alListenerfv( AL_ORIENTATION, _at_up_vec );
127 alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
128 alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
130 alDopplerFactor(1.0);
131 alDopplerVelocity(340.3); // speed of sound in meters per second.
133 if ( alIsExtensionPresent((const ALchar*)"EXT_exponent_distance") ) {
134 alDistanceModel(AL_EXPONENT_DISTANCE);
136 alDistanceModel(AL_INVERSE_DISTANCE);
139 testForALError("listener initialization");
141 // get a free source one at a time
142 // if an error is returned no more (hardware) sources are available
143 for (unsigned int i=0; i<MAX_SOURCES; i++) {
148 alGenSources(1, &source);
149 error = alGetError();
150 if ( error == AL_NO_ERROR ) {
151 _free_sources.push_back( source );
156 if (_free_sources.size() == 0) {
157 SG_LOG(SG_GENERAL, SG_ALERT, "Unable to grab any OpenAL sources!");
161 void SGSoundMgr::activate() {
164 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
165 sample_group_map_iterator sample_grp_end = _sample_groups.end();
166 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
167 SGSampleGroup *sgrp = sample_grp_current->second;
173 // stop the sound manager
174 void SGSoundMgr::stop() {
179 // clear any OpenAL buffers before shutting down
180 buffer_map_iterator buffers_current = _buffers.begin();
181 buffer_map_iterator buffers_end = _buffers.end();
182 for ( ; buffers_current != buffers_end; ++buffers_current ) {
183 refUint ref = buffers_current->second;
184 ALuint buffer = ref.id;
185 alDeleteBuffers(1, &buffer);
189 _context = alcGetCurrentContext();
190 _device = alcGetContextsDevice(_context);
191 alcDestroyContext(_context);
192 alcCloseDevice(_device);
196 void SGSoundMgr::suspend() {
198 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
199 sample_group_map_iterator sample_grp_end = _sample_groups.end();
200 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
201 SGSampleGroup *sgrp = sample_grp_current->second;
208 void SGSoundMgr::resume() {
210 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
211 sample_group_map_iterator sample_grp_end = _sample_groups.end();
212 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
213 SGSampleGroup *sgrp = sample_grp_current->second;
220 void SGSoundMgr::bind ()
222 _free_sources.clear();
223 _free_sources.reserve( MAX_SOURCES );
224 _sources_in_use.clear();
225 _sources_in_use.reserve( MAX_SOURCES );
229 void SGSoundMgr::unbind ()
231 _sample_groups.clear();
233 // delete free sources
234 for (unsigned int i=0; i<_free_sources.size(); i++) {
235 ALuint source = _free_sources[i];
236 alDeleteSources( 1 , &source );
239 _free_sources.clear();
240 _sources_in_use.clear();
243 // run the audio scheduler
244 void SGSoundMgr::update_late( double dt ) {
246 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
247 sample_group_map_iterator sample_grp_end = _sample_groups.end();
248 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
249 SGSampleGroup *sgrp = sample_grp_current->second;
254 alListenerf( AL_GAIN, _volume );
256 alListenerfv( AL_ORIENTATION, _at_up_vec );
257 alListenerfv( AL_POSITION, toVec3f(_position).data() );
258 alListenerfv( AL_VELOCITY, toVec3f(_velocity).data() );
260 // alDopplerVelocity(340.3); // TODO: altitude dependent
261 testForALError("update");
267 // add a sample group, return true if successful
268 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
270 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
271 if ( sample_grp_it != _sample_groups.end() ) {
272 // sample group already exists
276 if (_active) sgrp->activate();
277 _sample_groups[refname] = sgrp;
283 // remove a sound effect, return true if successful
284 bool SGSoundMgr::remove( const string &refname )
286 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
287 if ( sample_grp_it == _sample_groups.end() ) {
288 // sample group was not found.
292 _sample_groups.erase( sample_grp_it );
298 // return true of the specified sound exists in the sound manager system
299 bool SGSoundMgr::exists( const string &refname ) {
300 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
301 if ( sample_grp_it == _sample_groups.end() ) {
302 // sample group was not found.
310 // return a pointer to the SGSampleGroup if the specified sound exists
311 // in the sound manager system, otherwise return NULL
312 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
313 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
314 if ( sample_grp_it == _sample_groups.end() ) {
315 // sample group was not found.
317 SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
324 return sample_grp_it->second;
328 void SGSoundMgr::set_volume( float v )
331 if (_volume > 1.0) _volume = 1.0;
332 if (_volume < 0.0) _volume = 0.0;
337 * set the orientation of the listener (in opengl coordinates)
339 * Description: ORIENTATION is a pair of 3-tuples representing the
340 * 'at' direction vector and 'up' direction of the Object in
341 * Cartesian space. AL expects two vectors that are orthogonal to
342 * each other. These vectors are not expected to be normalized. If
343 * one or more vectors have zero length, implementation behavior
344 * is undefined. If the two vectors are linearly dependent,
345 * behavior is undefined.
347 void SGSoundMgr::set_orientation( SGQuatd ori )
351 SGVec3d sgv_up = ori.rotate(SGVec3d::e2());
352 SGVec3d sgv_at = ori.rotate(SGVec3d::e3());
353 _at_up_vec[0] = sgv_at[0];
354 _at_up_vec[1] = sgv_at[1];
355 _at_up_vec[2] = sgv_at[2];
356 _at_up_vec[3] = sgv_up[0];
357 _at_up_vec[4] = sgv_up[1];
358 _at_up_vec[5] = sgv_up[2];
362 // Get an unused source id
364 // The Sound Manager should keep track of the sources in use, the distance
365 // of these sources to the listener and the volume (also based on audio cone
366 // and hence orientation) of the sources.
368 // The Sound Manager is (and should be) the only one knowing about source
369 // management. Sources further away should be suspendped to free resources for
370 // newly added sounds close by.
371 unsigned int SGSoundMgr::request_source()
373 unsigned int source = NO_SOURCE;
375 if (_free_sources.size() > 0) {
376 source = _free_sources.back();
377 _free_sources.pop_back();
378 _sources_in_use.push_back(source);
381 SG_LOG( SG_GENERAL, SG_INFO, "No more free sources available\n");
386 // Free up a source id for further use
387 void SGSoundMgr::release_source( unsigned int source )
389 vector<ALuint>::iterator it;
391 it = std::find(_sources_in_use.begin(), _sources_in_use.end(), source);
392 if ( it != _sources_in_use.end() ) {
395 alGetSourcei( source, AL_SOURCE_STATE, &result );
396 if ( result == AL_PLAYING )
397 alSourceStop( source );
398 testForALError("release source");
400 alSourcei( source, AL_BUFFER, 0 );
401 _free_sources.push_back( source );
402 _sources_in_use.erase( it );
406 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
408 ALuint buffer = NO_BUFFER;
410 if ( !sample->is_valid_buffer() ) {
411 // sample was not yet loaded or removed again
412 string sample_name = sample->get_sample_name();
414 // see if the sample name is already cached
415 buffer_map_iterator buffer_it = _buffers.find( sample_name );
416 if ( buffer_it != _buffers.end() ) {
417 buffer_it->second.refctr++;
418 buffer = buffer_it->second.id;
419 sample->set_buffer( buffer );
423 // sample name was not found in the buffer cache.
424 if ( sample->is_file() ) {
429 load(sample_name, &data, &format, &size, &freq);
430 sample->set_data( &data );
431 sample->set_frequency( freq );
432 sample->set_format( format );
433 sample->set_size( size );
436 // create an OpenAL buffer handle
437 alGenBuffers(1, &buffer);
438 if ( !testForALError("generate buffer") ) {
439 // Copy data to the internal OpenAL buffer
441 const ALvoid *data = sample->get_data();
442 ALenum format = sample->get_format();
443 ALsizei size = sample->get_size();
444 ALsizei freq = sample->get_frequency();
445 alBufferData( buffer, format, data, size, freq );
447 // If this sample was read from a file we have all the information
448 // needed to read it again. For data buffers provided by the
449 // program we don't; so don't delete it's data.
450 if ( sample->is_file() ) sample->free_data();
452 if ( !testForALError("buffer add data") ) {
453 sample->set_buffer(buffer);
454 _buffers[sample_name] = refUint(buffer);
459 buffer = sample->get_buffer();
465 void SGSoundMgr::release_buffer(SGSoundSample *sample)
467 string sample_name = sample->get_sample_name();
468 buffer_map_iterator buffer_it = _buffers.find( sample_name );
469 if ( buffer_it == _buffers.end() ) {
470 // buffer was not found
474 sample->no_valid_buffer();
475 buffer_it->second.refctr--;
476 if (buffer_it->second.refctr == 0) {
477 ALuint buffer = buffer_it->second.id;
478 alDeleteBuffers(1, &buffer);
479 _buffers.erase( buffer_it );
480 testForALError("release buffer");
484 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
485 size_t *sz, int *frq )
487 if ( !_working ) return false;
494 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
496 data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
497 freq = (ALsizei)freqf;
499 int error = alutGetError();
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 ALbyte *fname = (ALbyte *)samplepath.c_str();
508 # if defined (__APPLE__)
509 alutLoadWAVFile( fname, &format, &data, &size, &freq );
512 alutLoadWAVFile( fname, &format, &data, &size, &freq, &loop );
514 ALenum error = alGetError();
515 if ( error != AL_NO_ERROR ) {
516 string msg = "Failed to load wav file: ";
517 msg.append(alGetString(error));
518 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
523 *dbuf = (void *)data;
532 bool SGSoundMgr::testForError(void *p, string s)
535 SG_LOG( SG_GENERAL, SG_ALERT, "Error: " << s);
542 bool SGSoundMgr::testForALError(string s)
544 ALenum error = alGetError();
545 if (error != AL_NO_ERROR) {
546 SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (sound manager): "
547 << alGetString(error) << " at " << s);
553 bool SGSoundMgr::testForALCError(string s)
556 error = alcGetError(_device);
557 if (error != ALC_NO_ERROR) {
558 SG_LOG( SG_GENERAL, SG_ALERT, "ALC Error (sound manager): "
559 << alcGetString(_device, error) << " at "
566 bool SGSoundMgr::testForALUTError(string s)
568 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
570 error = alutGetError ();
571 if (error != ALUT_ERROR_NO_ERROR) {
572 SG_LOG( SG_GENERAL, SG_ALERT, "ALUT Error (sound manager): "
573 << alutGetErrorString(error) << " at "