+// sample_group.cxx -- Manage a group of samples relative to a base position
+//
+// Written for the new SoundSystem by Erik Hofman, October 2009
+//
+// Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as
+// published by the Free Software Foundation; either version 2 of the
+// License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software Foundation,
+// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+//
+// $Id$
+
#ifdef HAVE_CONFIG_H
# include <simgear_config.h>
#endif
#include <simgear/compiler.h>
-#if defined (__APPLE__)
-# ifdef __GNUC__
-# if ( __GNUC__ >= 3 ) && ( __GNUC_MINOR__ >= 3 )
-// # include <math.h>
-inline int (isnan)(double r) { return !(r <= 0 || r >= 0); }
-# else
- // any C++ header file undefines isinf and isnan
- // so this should be included before <iostream>
- // the functions are STILL in libm (libSystem on mac os x)
-extern "C" int isnan (double);
-extern "C" int isinf (double);
-# endif
-# else
-// inline int (isinf)(double r) { return isinf(r); }
-// inline int (isnan)(double r) { return isnan(r); }
-# endif
-#endif
-
-#if defined (__FreeBSD__)
-# if __FreeBSD_version < 500000
- extern "C" {
- inline int isnan(double r) { return !(r <= 0 || r >= 0); }
- }
-# endif
-#endif
-
-#if defined (__CYGWIN__)
-# include <ieeefp.h>
-#endif
-
-#if defined(__MINGW32__)
-# define isnan(x) _isnan(x)
-#endif
-
#include "soundmgr_openal.hxx"
#include "sample_group.hxx"
+bool isNaN(float *v) {
+ return (isnan(v[0]) || isnan(v[1]) || isnan(v[2]));
+}
+
SGSampleGroup::SGSampleGroup () :
_smgr(NULL),
+ _refname(""),
_active(false),
- _changed(true),
- _position_changed(true),
- _position(SGVec3d::zeros().data()),
- _orientation(SGVec3f::zeros().data())
+ _changed(false),
+ _pause(false),
+ _volume(1.0),
+ _tied_to_listener(false),
+ _velocity(SGVec3d::zeros()),
+ _orientation(SGQuatd::zeros())
{
_samples.clear();
}
SGSampleGroup::SGSampleGroup ( SGSoundMgr *smgr, const string &refname ) :
_smgr(smgr),
+ _refname(refname),
_active(false),
- _changed(true),
- _position_changed(true),
- _position(SGVec3d::zeros().data()),
- _orientation(SGVec3f::zeros().data())
+ _changed(false),
+ _pause(false),
+ _volume(1.0),
+ _tied_to_listener(false),
+ _velocity(SGVec3d::zeros()),
+ _orientation(SGQuatd::zeros())
{
_smgr->add(this, refname);
- _active = _smgr->is_working();
- _refname = refname;
_samples.clear();
}
if ( sample->is_valid_source() && sample->is_playing() ) {
sample->no_valid_source();
_smgr->release_source( sample->get_source() );
+ _smgr->release_buffer( sample );
}
}
void SGSampleGroup::update( double dt ) {
- if ( !_active ) return;
+ if ( !_active || _pause ) return;
- // testForALError("start of update!!\n");
+ testForALError("start of update!!\n");
+
+ // Delete any OpenAL buffers that might still be in use.
+ unsigned int size = _removed_samples.size();
+ for (unsigned int i=0; i<size; ) {
+ SGSoundSample *sample = _removed_samples[i];
+ ALint result = AL_STOPPED;
+
+ if ( sample->is_valid_source() ) {
+ if ( sample->is_looping() ) {
+ sample->no_valid_source();
+ _smgr->release_source( sample->get_source() );
+ }
+ else
+ alGetSourcei( sample->get_source(), AL_SOURCE_STATE, &result );
+ }
+
+ if ( result == AL_STOPPED ) {
+ sample->stop();
+ if ( !sample->is_queue() ) {
+ ALuint buffer = sample->get_buffer();
+ alDeleteBuffers( 1, &buffer );
+ testForALError("buffer remove");
+ }
+ _removed_samples.erase( _removed_samples.begin()+i );
+ size--;
+ continue;
+ }
+ i++;
+ }
+
+ // Update the position and orientation information for all samples.
+ if ( _changed || _smgr->has_changed() ) {
+ update_pos_and_orientation();
+ _changed = false;
+ }
sample_map_iterator sample_current = _samples.begin();
sample_map_iterator sample_end = _samples.end();
//
// a request to start playing a sound has been filed.
//
- ALboolean looping = sample->get_looping() ? AL_TRUE : AL_FALSE;
-
- if ( !sample->is_valid_buffer() ) {
- // sample was not yet loaded or removed again
-
-// TODO: Create a buffer cache that checks whether a file is already present
-// as an OpenAL buffer since buffers can be shared among sources.
- load_file(sample);
- if ( testForALError("load sample") ) {
- throw sg_exception("Failed to load sound sample.");
- continue;
- }
-
- // create an OpenAL buffer handle
- ALuint buffer;
- alGenBuffers(1, &buffer);
- if ( testForALError("generate buffer") ) {
- throw sg_exception("Failed to generate OpenAL buffer.");
- continue;
- }
-
- // Copy data to the internal OpenAL buffer
- const ALvoid *data = sample->get_data();
- ALenum format = sample->get_format();
- ALsizei size = sample->get_size();
- ALsizei freq = sample->get_frequency();
- alBufferData( buffer, format, data, size, freq );
- sample->free_data();
- if ( testForALError("buffer add data") ) {
- continue;
- }
-
- sample->set_buffer(buffer);
- }
-
- // start playing the sample
- ALuint buffer = sample->get_buffer();
ALuint source = _smgr->request_source();
- if (alIsSource(source) == AL_TRUE && alIsBuffer(buffer) == AL_TRUE)
+ if (alIsSource(source) == AL_TRUE )
{
- sample->set_source( source );
-
- alSourcei( source, AL_BUFFER, buffer );
- testForALError("assign buffer to source");
-
- sample->set_source( source );
- update_sample_config( sample );
-
- alSourcei( source, AL_SOURCE_RELATIVE, AL_FALSE );
- alSourcei( source, AL_LOOPING, looping );
- alSourcePlay( source );
- testForALError("sample play");
- } else {
- if (alIsBuffer(buffer) == AL_FALSE)
- SG_LOG( SG_GENERAL, SG_ALERT, "No such buffer!\n");
- // sample->no_valid_source();
- // sadly, no free source available at this time
- }
-
- } else if ( sample->is_valid_source() && sample->has_changed() ) {
- if ( !sample->is_playing() ) {
- // a request to stop playing the sound has been filed.
-
- sample->no_valid_source();
- sample->stop();
- _smgr->release_source( sample->get_source() );
- } else {
- update_sample_config( sample );
+ ALboolean looping = sample->is_looping() ? AL_TRUE : AL_FALSE;
+ if ( sample->is_queue() )
+ {
+ sample->set_source( source );
+ update_sample_config( sample );
+
+ alSourcef( source, AL_ROLLOFF_FACTOR, 0.3 );
+ alSourcei( source, AL_LOOPING, looping );
+ alSourcei( source, AL_SOURCE_RELATIVE, AL_FALSE );
+ alSourcePlay( source );
+ testForALError("sample play");
+ }
+ else
+ {
+ if (_smgr->request_buffer(sample) == SGSoundMgr::NO_BUFFER)
+ continue;
+
+ // start playing the sample
+ ALuint buffer = sample->get_buffer();
+ if ( alIsBuffer(buffer) == AL_TRUE )
+ {
+ alSourcei( source, AL_BUFFER, buffer );
+ testForALError("assign buffer to source");
+
+ sample->set_source( source );
+ update_sample_config( sample );
+
+ alSourcei( source, AL_LOOPING, looping );
+ alSourcef( source, AL_ROLLOFF_FACTOR, 0.3 );
+ alSourcei( source, AL_SOURCE_RELATIVE, AL_FALSE );
+ alSourcePlay( source );
+ testForALError("sample play");
+ } else
+ SG_LOG( SG_GENERAL, SG_ALERT, "No such buffer!\n");
+ }
}
} else if ( sample->is_valid_source() ) {
alGetSourcei( source, AL_SOURCE_STATE, &result );
if ( result == AL_STOPPED ) {
// sample is stoped because it wasn't looping
- sample->no_valid_source();
sample->stop();
+ sample->no_valid_source();
_smgr->release_source( source );
-
+ _smgr->release_buffer( sample );
+ remove( sample->get_sample_name() );
}
+ else
+ if ( sample->has_changed() ) {
+ if ( !sample->is_playing() ) {
+ // a request to stop playing the sound has been filed.
+ sample->stop();
+ sample->no_valid_source();
+ _smgr->release_source( sample->get_source() );
+ } else if ( _smgr->has_changed() ) {
+ update_sample_config( sample );
+ }
+ }
+
}
testForALError("update");
}
}
// add a sound effect, return true if successful
-bool SGSampleGroup::add( SGSoundSample *sound, const string& refname ) {
+bool SGSampleGroup::add( SGSharedPtr<SGSoundSample> sound, const string& refname ) {
sample_map_iterator sample_it = _samples.find( refname );
if ( sample_it != _samples.end() ) {
return false;
}
+ if ( sample_it->second->is_valid_buffer() )
+ _removed_samples.push_back( sample_it->second );
+
_samples.erase( sample_it );
+
return true;
}
}
-// stop playing all associated samples
void
-SGSampleGroup::suspend ()
+SGSampleGroup::stop ()
{
- _active = false;
+ _pause = true;
sample_map_iterator sample_current = _samples.begin();
sample_map_iterator sample_end = _samples.end();
for ( ; sample_current != sample_end; ++sample_current ) {
SGSoundSample *sample = sample_current->second;
- if ( sample->is_valid_source() && sample->is_playing() ) {
- unsigned int source = sample->get_source();
- alSourcePause( source );
+ if ( sample->is_valid_source() ) {
+ ALint source = sample->get_source();
+ if ( sample->is_playing() ) {
+ alSourceStop( source );
+ }
+ _smgr->release_source( source );
+ sample->no_valid_source();
+ }
+
+ if ( sample->is_valid_buffer() ) {
+ _smgr->release_buffer( sample );
+ sample->no_valid_buffer();
+ }
+ }
+ testForALError("stop");
+}
+
+// stop playing all associated samples
+void
+SGSampleGroup::suspend ()
+{
+ if (_active && _pause == false) {
+ _pause = true;
+ sample_map_iterator sample_current = _samples.begin();
+ sample_map_iterator sample_end = _samples.end();
+ for ( ; sample_current != sample_end; ++sample_current ) {
+ SGSoundSample *sample = sample_current->second;
+
+ if ( sample->is_valid_source() && sample->is_playing() ) {
+ alSourcePause( sample->get_source() );
+ }
}
+ testForALError("suspend");
}
- testForALError("suspend");
}
// resume playing all associated samples
void
SGSampleGroup::resume ()
{
- sample_map_iterator sample_current = _samples.begin();
- sample_map_iterator sample_end = _samples.end();
- for ( ; sample_current != sample_end; ++sample_current ) {
- SGSoundSample *sample = sample_current->second;
-
- if ( sample->is_valid_source() && sample->is_playing() ) {
- unsigned int source = sample->get_source();
- alSourcePlay( source );
+ if (_active && _pause == true) {
+ sample_map_iterator sample_current = _samples.begin();
+ sample_map_iterator sample_end = _samples.end();
+ for ( ; sample_current != sample_end; ++sample_current ) {
+ SGSoundSample *sample = sample_current->second;
+
+ if ( sample->is_valid_source() && sample->is_playing() ) {
+ alSourcePlay( sample->get_source() );
+ }
}
+ testForALError("resume");
+ _pause = false;
}
- testForALError("resume");
- _active = true;
}
return true;
}
-
-// set source position of all managed sounds
-void SGSampleGroup::set_position( SGVec3d pos ) {
- if ( isnan(pos.data()[0]) || isnan(pos.data()[1]) || isnan(pos.data()[2]) )
- {
- SG_LOG( SG_GENERAL, SG_ALERT, "NAN's found in SampleGroup postion");
- return;
- }
-
- sample_map_iterator sample_current = _samples.begin();
- sample_map_iterator sample_end = _samples.end();
- for ( ; sample_current != sample_end; ++sample_current ) {
- SGSoundSample *sample = sample_current->second;
- sample->set_base_position( pos );
+void SGSampleGroup::set_volume( float vol )
+{
+ if (vol > _volume*1.01 || vol < _volume*0.99) {
+ _volume = vol;
+ if (_volume < 0.0) _volume = 0.0;
+ if (_volume > 1.0) _volume = 1.0;
+ _changed = true;
}
}
-// set source velocity of all managed sounds
-void SGSampleGroup::set_velocity( SGVec3f vel ) {
- if ( isnan(vel.data()[0]) || isnan(vel.data()[1]) || isnan(vel.data()[2]) )
- {
- SG_LOG( SG_GENERAL, SG_ALERT, "NAN's found in SampleGroup velocity");
- return;
- }
+// set the source position and orientation of all managed sounds
+void SGSampleGroup::update_pos_and_orientation() {
+
+ SGVec3d position = SGVec3d::fromGeod(_base_pos) - _smgr->get_position();
+ SGQuatd hlOr = SGQuatd::fromLonLat(_base_pos);
+ SGQuatd ec2body = hlOr*_orientation;
- sample_map_iterator sample_current = _samples.begin();
- sample_map_iterator sample_end = _samples.end();
- for ( ; sample_current != sample_end; ++sample_current ) {
- SGSoundSample *sample = sample_current->second;
- sample->set_velocity( vel );
- }
-}
-
-// ste the source orientation of all managed sounds
-void SGSampleGroup::set_orientation( SGVec3f ori ) {
- if ( isnan(ori.data()[0]) || isnan(ori.data()[1]) || isnan(ori.data()[2]) )
- {
- SG_LOG( SG_GENERAL, SG_ALERT, "NAN's found in SampleGroup orientation");
- return;
+ SGVec3f velocity = SGVec3f::zeros();
+ if ( _velocity[0] || _velocity[1] || _velocity[2] ) {
+ velocity = toVec3f( hlOr.backTransform(_velocity*SG_FEET_TO_METER) );
}
sample_map_iterator sample_current = _samples.begin();
sample_map_iterator sample_end = _samples.end();
for ( ; sample_current != sample_end; ++sample_current ) {
SGSoundSample *sample = sample_current->second;
- sample->set_orientation( ori );
+ sample->set_master_volume( _volume );
+ sample->set_orientation( _orientation );
+ sample->set_rotation( ec2body );
+ sample->set_position( position );
+ sample->set_velocity( velocity );
}
}
void SGSampleGroup::update_sample_config( SGSoundSample *sample ) {
- if ( sample->is_valid_source() ) {
- unsigned int source = sample->get_source();
-
- alSourcefv( source, AL_POSITION, sample->get_position());
- alSourcefv( source, AL_DIRECTION, sample->get_direction() );
- alSourcefv( source, AL_VELOCITY, sample->get_velocity() );
- testForALError("position and orientation");
-
- alSourcef( source, AL_PITCH, sample->get_pitch() );
- alSourcef( source, AL_GAIN, sample->get_volume() );
- testForALError("pitch and gain");
-
- if ( sample->has_static_data_changed() ) {
- alSourcef( source, AL_CONE_INNER_ANGLE, sample->get_innerangle() );
- alSourcef( source, AL_CONE_OUTER_ANGLE, sample->get_outerangle() );
- alSourcef( source, AL_CONE_OUTER_GAIN, sample->get_outergain() );
- testForALError("audio cone");
-
- alSourcef( source, AL_ROLLOFF_FACTOR, 1.0 );
- alSourcef( source, AL_MAX_DISTANCE, sample->get_max_dist() );
- alSourcef( source, AL_REFERENCE_DISTANCE,
- sample->get_reference_dist() );
- testForALError("distance rolloff");
- }
+ SGVec3f orientation, velocity;
+ SGVec3d position;
+
+ if ( _tied_to_listener ) {
+ orientation = _smgr->get_direction();
+ position = SGVec3d::zeros();
+ velocity = _smgr->get_velocity();
+ } else {
+ sample->update_pos_and_orientation();
+ orientation = sample->get_orientation();
+ position = sample->get_position();
+ velocity = sample->get_velocity();
}
-}
-
-ALvoid
-SGSampleGroup::load_file(SGSoundSample *sample) {
- if (sample->is_file()) {
- unsigned int size;
- int freq, format;
- void *data;
-
- string sample_name = sample->get_sample_name();
- _smgr->load(sample_name, &data, &format, &size, &freq);
- sample->set_data( (unsigned char *)data );
- sample->set_frequency( freq );
- sample->set_format( format );
- sample->set_size( size );
+ if (_smgr->bad_doppler_effect()) {
+ velocity *= 100.0f;
}
-}
-void SGSampleGroup::set_volume( float vol )
-{
- _volume = vol;
- if (_volume < 0.0) _volume = 0.0;
- if (_volume > 1.0) _volume = 1.0;
+#if 0
+ if (length(position) > 20000)
+ printf("%s source and listener distance greater than 20km!\n",
+ _refname.c_str());
+ if (isNaN(toVec3f(position).data())) printf("NaN in source position\n");
+ if (isNaN(orientation.data())) printf("NaN in source orientation\n");
+ if (isNaN(velocity.data())) printf("NaN in source velocity\n");
+#endif
- sample_map_iterator sample_current = _samples.begin();
- sample_map_iterator sample_end = _samples.end();
- for ( ; sample_current != sample_end; ++sample_current ) {
- SGSoundSample *sample = sample_current->second;
- sample->set_master_volume( _volume );
+ unsigned int source = sample->get_source();
+ alSourcefv( source, AL_POSITION, toVec3f(position).data() );
+ alSourcefv( source, AL_VELOCITY, velocity.data() );
+ alSourcefv( source, AL_DIRECTION, orientation.data() );
+ testForALError("position and orientation");
+
+ alSourcef( source, AL_PITCH, sample->get_pitch() );
+ alSourcef( source, AL_GAIN, sample->get_volume() );
+ testForALError("pitch and gain");
+
+ if ( sample->has_static_data_changed() ) {
+ alSourcef( source, AL_CONE_INNER_ANGLE, sample->get_innerangle() );
+ alSourcef( source, AL_CONE_OUTER_ANGLE, sample->get_outerangle() );
+ alSourcef( source, AL_CONE_OUTER_GAIN, sample->get_outergain() );
+ testForALError("audio cone");
+
+ alSourcef( source, AL_MAX_DISTANCE, sample->get_max_dist() );
+ alSourcef( source, AL_REFERENCE_DISTANCE,
+ sample->get_reference_dist() );
+ testForALError("distance rolloff");
}
}