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.
8 // Copyright (C) 2001 Curtis L. Olson - http://www.flightgear.org/~curt
10 // This program is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU General Public License as
12 // published by the Free Software Foundation; either version 2 of the
13 // License, or (at your option) any later version.
15 // This program is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // General Public License for more details.
20 // You should have received a copy of the GNU General Public License
21 // along with this program; if not, write to the Free Software Foundation,
22 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 # include <simgear_config.h>
30 #if defined( __APPLE__ )
31 # include <OpenAL/alut.h>
39 #include "soundmgr_openal.hxx"
41 #include <simgear/structure/exception.hxx>
42 #include <simgear/debug/logstream.hxx>
43 #include <simgear/misc/sg_path.hxx>
44 #include <simgear/math/SGMath.hxx>
47 #define MAX_SOURCES 128
53 int SGSoundMgr::_alut_init = 0;
56 SGSoundMgr::SGSoundMgr() :
62 _position(SGVec3d::zeros()),
63 _velocity(SGVec3d::zeros()),
64 _orientation(SGQuatd::zeros()),
67 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
68 if (_alut_init == 0) {
69 if ( !alutInitWithoutContext(NULL, NULL) ) {
70 testForALUTError("alut initialization");
80 SGSoundMgr::~SGSoundMgr() {
83 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
85 if (_alut_init == 0) {
91 // initialize the sound manager
92 void SGSoundMgr::init() {
94 SG_LOG( SG_GENERAL, SG_INFO, "Initializing OpenAL sound manager" );
96 ALCdevice *device = alcOpenDevice(_devname);
97 if ( testForError(device, "No default audio device available.") ) {
101 ALCcontext *context = alcCreateContext(device, NULL);
102 if ( testForError(context, "Unable to create a valid context.") ) {
103 alcCloseDevice (device);
107 if ( !alcMakeContextCurrent(context) ) {
108 testForALCError("context initialization");
109 alcDestroyContext (context);
110 alcCloseDevice (device);
117 _at_up_vec[0] = 0.0; _at_up_vec[1] = 0.0; _at_up_vec[2] = -1.0;
118 _at_up_vec[3] = 0.0; _at_up_vec[4] = 1.0; _at_up_vec[5] = 0.0;
120 alListenerf( AL_GAIN, 0.2f );
121 alListenerfv( AL_ORIENTATION, _at_up_vec );
122 alListenerfv( AL_POSITION, SGVec3f::zeros().data() );
123 alListenerfv( AL_VELOCITY, SGVec3f::zeros().data() );
125 alDopplerFactor(1.0);
126 alDopplerVelocity(340.3); // speed of sound in meters per second.
128 if ( alIsExtensionPresent((const ALchar*)"EXT_exponent_distance") ) {
129 alDistanceModel(AL_EXPONENT_DISTANCE);
131 alDistanceModel(AL_INVERSE_DISTANCE);
134 testForALError("listener initialization");
136 // get a free source one at a time
137 // if an error is returned no more (hardware) sources are available
138 for (unsigned int i=0; i<MAX_SOURCES; i++) {
143 alGenSources(1, &source);
144 error = alGetError();
145 if ( error == AL_NO_ERROR ) {
146 _free_sources.push_back( source );
151 if (_free_sources.size() == 0) {
152 SG_LOG(SG_GENERAL, SG_ALERT, "Unable to grab any OpenAL sources!");
155 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
156 sample_group_map_iterator sample_grp_end = _sample_groups.end();
157 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
158 SGSampleGroup *sgrp = sample_grp_current->second;
163 // suspend the sound manager
164 void SGSoundMgr::stop() {
168 // clear any OpenAL buffers before shutting down
169 buffer_map_iterator buffers_current;
170 while(_buffers.size()){
171 buffers_current = _buffers.begin();
172 refUint ref = buffers_current->second;
173 ALuint buffer = ref.id;
174 alDeleteBuffers(1, &buffer);
175 _buffers.erase( buffers_current );
178 _context = alcGetCurrentContext();
179 _device = alcGetContextsDevice(_context);
180 alcMakeContextCurrent(NULL);
181 alcDestroyContext(_context);
182 alcCloseDevice(_device);
186 void SGSoundMgr::suspend() {
188 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
189 sample_group_map_iterator sample_grp_end = _sample_groups.end();
190 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
191 SGSampleGroup *sgrp = sample_grp_current->second;
198 void SGSoundMgr::bind ()
200 _free_sources.clear();
201 _free_sources.reserve( MAX_SOURCES );
202 _sources_in_use.clear();
203 _sources_in_use.reserve( MAX_SOURCES );
207 void SGSoundMgr::unbind ()
209 _sample_groups.clear();
211 // delete free sources
212 for (unsigned int i=0; i<_free_sources.size(); i++) {
213 ALuint source = _free_sources.at( i );
214 alDeleteSources( 1 , &source );
217 _free_sources.clear();
218 _sources_in_use.clear();
221 void SGSoundMgr::update( double dt )
223 // nothing to do in the regular update, everything is done on the following
228 // run the audio scheduler
229 void SGSoundMgr::update_late( double dt ) {
231 alcSuspendContext(_context);
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;
241 alListenerf( AL_GAIN, _volume );
242 alListenerfv( AL_ORIENTATION, _at_up_vec );
243 alListenerfv( AL_POSITION, toVec3f(_position).data() );
244 alListenerfv( AL_VELOCITY, toVec3f(_velocity).data() );
245 // alDopplerVelocity(340.3); // TODO: altitude dependent
246 testForALError("update");
249 alcProcessContext(_context);
255 SGSoundMgr::resume ()
258 sample_group_map_iterator sample_grp_current = _sample_groups.begin();
259 sample_group_map_iterator sample_grp_end = _sample_groups.end();
260 for ( ; sample_grp_current != sample_grp_end; ++sample_grp_current ) {
261 SGSampleGroup *sgrp = sample_grp_current->second;
268 // add a sampel group, return true if successful
269 bool SGSoundMgr::add( SGSampleGroup *sgrp, const string& refname )
271 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
272 if ( sample_grp_it != _sample_groups.end() ) {
273 // sample group already exists
277 if (_working) sgrp->activate();
278 _sample_groups[refname] = sgrp;
284 // remove a sound effect, return true if successful
285 bool SGSoundMgr::remove( const string &refname )
287 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
288 if ( sample_grp_it == _sample_groups.end() ) {
289 // sample group was not found.
293 _sample_groups.erase( refname );
299 // return true of the specified sound exists in the sound manager system
300 bool SGSoundMgr::exists( const string &refname ) {
301 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
302 if ( sample_grp_it == _sample_groups.end() ) {
303 // sample group was not found.
311 // return a pointer to the SGSampleGroup if the specified sound exists
312 // in the sound manager system, otherwise return NULL
313 SGSampleGroup *SGSoundMgr::find( const string &refname, bool create ) {
314 sample_group_map_iterator sample_grp_it = _sample_groups.find( refname );
315 if ( sample_grp_it == _sample_groups.end() ) {
316 // sample group was not found.
318 SGSampleGroup* sgrp = new SGSampleGroup(this, refname);
325 return sample_grp_it->second;
329 void SGSoundMgr::set_volume( float v )
332 if (_volume > 1.0) _volume = 1.0;
333 if (_volume < 0.0) _volume = 0.0;
338 * set the orientation of the listener (in opengl coordinates)
340 * Description: ORIENTATION is a pair of 3-tuples representing the
341 * 'at' direction vector and 'up' direction of the Object in
342 * Cartesian space. AL expects two vectors that are orthogonal to
343 * each other. These vectors are not expected to be normalized. If
344 * one or more vectors have zero length, implementation behavior
345 * is undefined. If the two vectors are linearly dependent,
346 * behavior is undefined.
348 void SGSoundMgr::set_orientation( SGQuatd ori )
352 SGVec3d sgv_up = ori.rotate(SGVec3d::e2());
353 SGVec3d sgv_at = ori.rotate(SGVec3d::e3());
354 _at_up_vec[0] = sgv_at[0];
355 _at_up_vec[1] = sgv_at[1];
356 _at_up_vec[2] = sgv_at[2];
357 _at_up_vec[3] = sgv_up[0];
358 _at_up_vec[4] = sgv_up[1];
359 _at_up_vec[5] = sgv_up[2];
363 // Get an unused source id
365 // The Sound Manager should keep track of the sources in use, the distance
366 // of these sources to the listener and the volume (also based on audio cone
367 // and hence orientation) of the sources.
369 // The Sound Manager is (and should be) the only one knowing about source
370 // management. Sources further away should be suspendped to free resources for
371 // newly added sounds close by.
372 unsigned int SGSoundMgr::request_source()
374 unsigned int source = NO_SOURCE;
376 if (_free_sources.size() > 0) {
377 source = _free_sources.back();
378 _free_sources.pop_back();
379 _sources_in_use.push_back(source);
385 // Free up a source id for further use
386 void SGSoundMgr::release_source( unsigned int source )
388 vector<ALuint>::iterator it;
390 it = std::find(_sources_in_use.begin(), _sources_in_use.end(), source);
391 if ( it != _sources_in_use.end() ) {
394 alGetSourcei( source, AL_SOURCE_STATE, &result );
395 if ( result == AL_PLAYING )
396 alSourceStop( source );
397 testForALError("release source");
399 _free_sources.push_back(source);
400 _sources_in_use.erase(it, it+1);
404 unsigned int SGSoundMgr::request_buffer(SGSoundSample *sample)
406 ALuint buffer = NO_BUFFER;
408 if ( !sample->is_valid_buffer() ) {
409 // sample was not yet loaded or removed again
410 string sample_name = sample->get_sample_name();
412 // see if the sample name is already cached
413 buffer_map_iterator buffer_it = _buffers.find( sample_name );
414 if ( buffer_it != _buffers.end() ) {
415 buffer_it->second.refctr++;
416 buffer = buffer_it->second.id;
417 sample->set_buffer( buffer );
421 // sample name was not found in the buffer cache.
422 if ( sample->is_file() ) {
427 load(sample_name, &data, &format, &size, &freq);
428 sample->set_data( (unsigned char *)data );
429 sample->set_frequency( freq );
430 sample->set_format( format );
431 sample->set_size( size );
434 // create an OpenAL buffer handle
435 alGenBuffers(1, &buffer);
436 if ( !testForALError("generate buffer") ) {
437 // Copy data to the internal OpenAL buffer
439 const ALvoid *data = sample->get_data();
440 ALenum format = sample->get_format();
441 ALsizei size = sample->get_size();
442 ALsizei freq = sample->get_frequency();
443 alBufferData( buffer, format, data, size, freq );
446 if ( !testForALError("buffer add data") ) {
447 sample->set_buffer(buffer);
448 _buffers[sample_name] = refUint(buffer);
453 buffer = sample->get_buffer();
458 void SGSoundMgr::release_buffer(SGSoundSample *sample)
460 string sample_name = sample->get_sample_name();
462 buffer_map_iterator buffer_it = _buffers.find( sample_name );
463 if ( buffer_it == _buffers.end() ) {
464 // buffer was not found
468 sample->no_valid_buffer();
469 buffer_it->second.refctr--;
470 if (buffer_it->second.refctr == 0) {
471 ALuint buffer = buffer_it->second.id;
472 _buffers.erase( buffer_it );
473 alDeleteBuffers(1, &buffer);
474 testForALError("release buffer");
478 bool SGSoundMgr::load(string &samplepath, void **dbuf, int *fmt,
479 unsigned int *sz, int *frq )
486 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
488 data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
489 freq = (ALsizei)freqf;
491 int error = alutGetError();
492 string msg = "Failed to load wav file: ";
493 msg.append(alutGetErrorString(error));
494 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
499 ALbyte *fname = (ALbyte *)samplepath.c_str();
500 # if defined (__APPLE__)
501 alutLoadWAVFile( fname, &format, &data, &size, &freq );
504 alutLoadWAVFile( fname, &format, &data, &size, &freq, &loop );
506 ALenum error = alGetError();
507 if ( error != AL_NO_ERROR ) {
508 string msg = "Failed to load wav file: ";
509 msg.append(alutGetErrorString(error));
510 throw sg_io_exception(msg.c_str(), sg_location(samplepath));
515 *dbuf = (void *)data;
517 *sz = (unsigned int)size;
524 bool SGSoundMgr::testForError(void *p, string s)
527 SG_LOG( SG_GENERAL, SG_ALERT, "Error: " << s);
534 bool SGSoundMgr::testForALError(string s)
536 ALenum error = alGetError();
537 if (error != AL_NO_ERROR) {
538 SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (sound manager): "
539 << alGetString(error) << " at " << s);
545 bool SGSoundMgr::testForALCError(string s)
548 error = alcGetError(_device);
549 if (error != ALC_NO_ERROR) {
550 SG_LOG( SG_GENERAL, SG_ALERT, "ALC Error (sound manager): "
551 << alcGetString(_device, error) << " at "
558 bool SGSoundMgr::testForALUTError(string s)
560 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
562 error = alutGetError ();
563 if (error != ALUT_ERROR_NO_ERROR) {
564 SG_LOG( SG_GENERAL, SG_ALERT, "ALUT Error (sound manager): "
565 << alutGetErrorString(error) << " at "