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 _context = alcGetCurrentContext();
183 _device = alcGetContextsDevice(_context);
184 alcDestroyContext(_context);
185 alcCloseDevice(_device);
189 void SGSoundMgr::suspend() {
191 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
192 sample_group_map_iterator sample_grp_end = _sample_groups.end();
193 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
194 SGSampleGroup *sgrp = sample_grp_current->second;
201 void SGSoundMgr::resume() {
203 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
204 sample_group_map_iterator sample_grp_end = _sample_groups.end();
205 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
206 SGSampleGroup *sgrp = sample_grp_current->second;
213 void SGSoundMgr::bind ()
215 _free_sources.clear();
216 _free_sources.reserve( MAX_SOURCES );
217 _sources_in_use.clear();
218 _sources_in_use.reserve( MAX_SOURCES );
222 void SGSoundMgr::unbind ()
224 _sample_groups.clear();
226 // delete free sources
227 for (unsigned int i=0; i<_free_sources.size(); i++) {
228 ALuint source = _free_sources.at( i );
229 alDeleteSources( 1 , &source );
232 _free_sources.clear();
233 _sources_in_use.clear();
236 // run the audio scheduler
237 void SGSoundMgr::update_late( double dt ) {
239 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
240 sample_group_map_iterator sample_grp_end = _sample_groups.end();
241 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
242 SGSampleGroup *sgrp = sample_grp_current->second;
247 alListenerf( AL_GAIN, _volume );
248 alListenerfv( AL_ORIENTATION, _at_up_vec );
249 alListenerfv( AL_POSITION, toVec3f(_position).data() );
250 alListenerfv( AL_VELOCITY, toVec3f(_velocity).data() );
251 // alDopplerVelocity(340.3); // TODO: altitude dependent
252 testForALError("update");
258 // add a sample group, return true if successful
259 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
261 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
262 if ( sample_grp_it != _sample_groups.end() ) {
263 // sample group already exists
267 if (_working) sgrp->activate();
268 _sample_groups[refname] = sgrp;
274 // remove a sound effect, return true if successful
275 bool SGSoundMgr::remove( const string &refname )
277 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
278 if ( sample_grp_it == _sample_groups.end() ) {
279 // sample group was not found.
283 _sample_groups.erase( refname );
289 // return true of the specified sound exists in the sound manager system
290 bool SGSoundMgr::exists( const string &refname ) {
291 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
292 if ( sample_grp_it == _sample_groups.end() ) {
293 // sample group was not found.
301 // return a pointer to the SGSampleGroup if the specified sound exists
302 // in the sound manager system, otherwise return NULL
303 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
304 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
305 if ( sample_grp_it == _sample_groups.end() ) {
306 // sample group was not found.
308 SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
315 return sample_grp_it->second;
319 void SGSoundMgr::set_volume( float v )
322 if (_volume > 1.0) _volume = 1.0;
323 if (_volume < 0.0) _volume = 0.0;
328 * set the orientation of the listener (in opengl coordinates)
330 * Description: ORIENTATION is a pair of 3-tuples representing the
331 * 'at' direction vector and 'up' direction of the Object in
332 * Cartesian space. AL expects two vectors that are orthogonal to
333 * each other. These vectors are not expected to be normalized. If
334 * one or more vectors have zero length, implementation behavior
335 * is undefined. If the two vectors are linearly dependent,
336 * behavior is undefined.
338 void SGSoundMgr::set_orientation( SGQuatd ori )
342 SGVec3d sgv_up = ori.rotate(SGVec3d::e2());
343 SGVec3d sgv_at = ori.rotate(SGVec3d::e3());
344 _at_up_vec[0] = sgv_at[0];
345 _at_up_vec[1] = sgv_at[1];
346 _at_up_vec[2] = sgv_at[2];
347 _at_up_vec[3] = sgv_up[0];
348 _at_up_vec[4] = sgv_up[1];
349 _at_up_vec[5] = sgv_up[2];
353 // Get an unused source id
355 // The Sound Manager should keep track of the sources in use, the distance
356 // of these sources to the listener and the volume (also based on audio cone
357 // and hence orientation) of the sources.
359 // The Sound Manager is (and should be) the only one knowing about source
360 // management. Sources further away should be suspendped to free resources for
361 // newly added sounds close by.
362 unsigned int SGSoundMgr::request_source()
364 unsigned int source = NO_SOURCE;
366 if (_free_sources.size() > 0) {
367 source = _free_sources.back();
368 _free_sources.pop_back();
369 _sources_in_use.push_back(source);
375 // Free up a source id for further use
376 void SGSoundMgr::release_source( unsigned int source )
378 vector<ALuint>::iterator it;
380 it = std::find(_sources_in_use.begin(), _sources_in_use.end(), source);
381 if ( it != _sources_in_use.end() ) {
384 alGetSourcei( source, AL_SOURCE_STATE, &result );
385 if ( result == AL_PLAYING )
386 alSourceStop( source );
387 testForALError("release source");
389 _free_sources.push_back(source);
390 _sources_in_use.erase(it, it+1);
394 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
396 ALuint buffer = NO_BUFFER;
398 if ( !sample->is_valid_buffer() ) {
399 // sample was not yet loaded or removed again
400 string sample_name = sample->get_sample_name();
402 // see if the sample name is already cached
403 buffer_map_iterator buffer_it = _buffers.find( sample_name );
404 if ( buffer_it != _buffers.end() ) {
405 buffer_it->second.refctr++;
406 buffer = buffer_it->second.id;
407 sample->set_buffer( buffer );
411 // sample name was not found in the buffer cache.
412 if ( sample->is_file() ) {
417 load(sample_name, &data, &format, &size, &freq);
418 sample->set_data( (unsigned char *)data );
419 sample->set_frequency( freq );
420 sample->set_format( format );
421 sample->set_size( size );
424 // create an OpenAL buffer handle
425 alGenBuffers(1, &buffer);
426 if ( !testForALError("generate buffer") ) {
427 // Copy data to the internal OpenAL buffer
429 const ALvoid *data = sample->get_data();
430 ALenum format = sample->get_format();
431 ALsizei size = sample->get_size();
432 ALsizei freq = sample->get_frequency();
433 alBufferData( buffer, format, data, size, freq );
435 // If this sample was read from a file we have all the information
436 // needed to read it again. For data buffers provided by the
437 // program we don't; so don't delete it's data.
438 if (sample->is_file()) sample->free_data();
440 if ( !testForALError("buffer add data") ) {
441 sample->set_buffer(buffer);
442 _buffers[sample_name] = refUint(buffer);
447 buffer = sample->get_buffer();
452 void SGSoundMgr::release_buffer(SGSoundSample *sample)
454 string sample_name = sample->get_sample_name();
456 buffer_map_iterator buffer_it = _buffers.find( sample_name );
457 if ( buffer_it == _buffers.end() ) {
458 // buffer was not found
462 sample->no_valid_buffer();
463 buffer_it->second.refctr--;
464 if (buffer_it->second.refctr == 0) {
465 ALuint buffer = buffer_it->second.id;
466 _buffers.erase( buffer_it );
467 alDeleteBuffers(1, &buffer);
468 testForALError("release buffer");
472 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
473 size_t *sz, int *frq )
480 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
482 data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
483 freq = (ALsizei)freqf;
485 int error = alutGetError();
486 string msg = "Failed to load wav file: ";
487 msg.append(alutGetErrorString(error));
488 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
493 ALbyte *fname = (ALbyte *)samplepath.c_str();
494 # if defined (__APPLE__)
495 alutLoadWAVFile( fname, &format, &data, &size, &freq );
498 alutLoadWAVFile( fname, &format, &data, &size, &freq, &loop );
500 ALenum error = alGetError();
501 if ( error != AL_NO_ERROR ) {
502 string msg = "Failed to load wav file: ";
503 msg.append(alutGetErrorString(error));
504 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
509 *dbuf = (void *)data;
518 bool SGSoundMgr::testForError(void *p, string s)
521 SG_LOG( SG_GENERAL, SG_ALERT, "Error: " << s);
528 bool SGSoundMgr::testForALError(string s)
530 ALenum error = alGetError();
531 if (error != AL_NO_ERROR) {
532 SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (sound manager): "
533 << alGetString(error) << " at " << s);
539 bool SGSoundMgr::testForALCError(string s)
542 error = alcGetError(_device);
543 if (error != ALC_NO_ERROR) {
544 SG_LOG( SG_GENERAL, SG_ALERT, "ALC Error (sound manager): "
545 << alcGetString(_device, error) << " at "
552 bool SGSoundMgr::testForALUTError(string s)
554 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
556 error = alutGetError ();
557 if (error != ALUT_ERROR_NO_ERROR) {
558 SG_LOG( SG_GENERAL, SG_ALERT, "ALUT Error (sound manager): "
559 << alutGetErrorString(error) << " at "