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 - curt@flightgear.org
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
22 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include <simgear/debug/logstream.hxx>
28 #include <simgear/misc/sg_path.hxx>
30 #include <Main/globals.hxx>
32 #include "soundmgr.hxx"
34 #define FG_SOUND_SAFETY_MULT 3
35 #define FG_MAX_SOUND_SAFETY ( 1.0 / FG_SOUND_SAFETY_MULT )
42 FGSimpleSound::FGSimpleSound( string file )
46 SGPath slfile( globals->get_fg_root() );
47 slfile.append( file );
48 sample = new slSample ( (char *)slfile.c_str() );
49 pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
50 volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
51 pitch_envelope->setStep ( 0, 0.01, 1.0 );
52 volume_envelope->setStep ( 0, 0.01, 1.0 );
55 FGSimpleSound::FGSimpleSound( unsigned char *buffer, int len )
59 sample = new slSample ( buffer, len );
60 pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
61 volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
62 pitch_envelope->setStep ( 0, 0.01, 1.0 );
63 volume_envelope->setStep ( 0, 0.01, 1.0 );
67 FGSimpleSound::~FGSimpleSound() {
68 delete pitch_envelope;
69 delete volume_envelope;
73 void FGSimpleSound::play( slScheduler *sched, bool looped ) {
75 // make sure sound isn't already playing
76 if ( sample->getPlayCount() > 0 ) {
77 sched->stopSample(sample);
82 sched->loopSample(sample);
84 sched->playSample(sample);
87 sched->addSampleEnvelope(sample, 0, 0, pitch_envelope, SL_PITCH_ENVELOPE);
88 sched->addSampleEnvelope(sample, 0, 1, volume_envelope, SL_VOLUME_ENVELOPE);
91 void FGSimpleSound::stop( slScheduler *sched, bool quick ) {
93 sched->stopSample( sample );
101 FGSoundMgr::FGSoundMgr() {
102 audio_sched = new slScheduler( 8000 );
103 if ( audio_sched->notWorking() ) {
104 SG_LOG( SG_GENERAL, SG_ALERT, "Audio initialization failed!" );
106 audio_sched -> setMaxConcurrent ( 6 );
108 audio_mixer = new smMixer;
110 SG_LOG( SG_GENERAL, SG_INFO,
111 "Rate = " << audio_sched->getRate()
112 << " Bps = " << audio_sched->getBps()
113 << " Stereo = " << audio_sched->getStereo() );
119 FGSoundMgr::~FGSoundMgr() {
122 // Remove the samples from the sample manager.
124 sample_map_iterator sample_current = samples.begin();
125 sample_map_iterator sample_end = samples.end();
126 for ( ; sample_current != sample_end; ++sample_current ) {
127 sample_ref *sr = sample_current->second;
129 audio_sched->stopSample(sr->sample);
135 // Remove the sounds from the sound manager.
137 sound_map_iterator sound_current = sounds.begin();
138 sound_map_iterator sound_end = sounds.end();
139 for ( ; sound_current != sound_end; ++sound_current ) {
140 FGSimpleSound *s = sound_current->second;
142 audio_sched->stopSample(s->get_sample());
143 delete s->get_sample();
152 // initialize the sound manager
153 void FGSoundMgr::init() {
154 safety = FG_MAX_SOUND_SAFETY;
156 // audio_mixer -> setMasterVolume ( 80 ) ; /* 80% of max volume. */
157 audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
161 // Remove the samples from the sample manager.
163 sample_map_iterator sample_current = samples.begin();
164 sample_map_iterator sample_end = samples.end();
165 for ( ; sample_current != sample_end; ++sample_current ) {
166 sample_ref *sr = sample_current->second;
168 audio_sched->stopSample(sr->sample);
175 // Remove the sounds from the sound manager.
177 sound_map_iterator sound_current = sounds.begin();
178 sound_map_iterator sound_end = sounds.end();
179 for ( ; sound_current != sound_end; ++sound_current ) {
180 FGSimpleSound *s = sound_current->second;
182 audio_sched->stopSample(s->get_sample());
183 delete s->get_sample();
191 void FGSoundMgr::bind ()
197 void FGSoundMgr::unbind ()
203 // run the audio scheduler
204 void FGSoundMgr::update( double dt ) {
208 safety = safety * 0.99 + dt * 0.01;
210 if ( safety > FG_MAX_SOUND_SAFETY ) {
211 safety = FG_MAX_SOUND_SAFETY;
213 // cout << "safety = " << safety << endl;
214 audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
216 if ( !audio_sched->not_working() )
217 audio_sched -> update();
224 audio_sched->pauseSample(0, 0);
229 FGSoundMgr::resume ()
231 audio_sched->resumeSample(0, 0);
235 // add a sound effect, return true if successful
236 bool FGSoundMgr::add( FGSimpleSound *sound, const string& refname ) {
238 sound_map_iterator sound_it = sounds.find( refname );
239 if ( sound_it != sounds.end() ) {
240 // sound already exists
244 sample_map_iterator sample_it = samples.find( refname );
245 if ( sample_it != samples.end() ) {
246 // this sound has existed in the past and it's sample is still
247 // here, delete the sample so we can replace it.
248 samples.erase( sample_it );
251 sample_ref *sr = new sample_ref;
254 sr->sample = sound->get_sample();
255 samples[refname] = sr;
257 sounds[refname] = sound;
263 // add a sound from a file, return the sample if successful, else return NULL
264 FGSimpleSound *FGSoundMgr::add( const string& refname, const string &file ) {
265 FGSimpleSound *sound;
270 sample_map_iterator it = samples.find(file);
271 if (it == samples.end()) {
272 sound = new FGSimpleSound(file);
273 sounds[refname] = sound;
275 sample_ref *sr = new sample_ref;
278 sr->sample = sound->get_sample();
282 sample_ref *sr = it->second;
286 new FGSimpleSound(sr->sample->getBuffer(), sr->sample->getLength());
287 sounds[refname] = sound;
295 // remove a sound effect, return true if successful
296 bool FGSoundMgr::remove( const string& refname ) {
298 sound_map_iterator it = sounds.find( refname );
299 if ( it != sounds.end() ) {
300 // first stop the sound from playing (so we don't bomb the
302 FGSimpleSound *sample = it->second;
304 // cout << "Playing " << sample->get_sample()->getPlayCount()
305 // << " instances!" << endl;
307 audio_sched->stopSample( sample->get_sample() );
308 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
311 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
313 SL_VOLUME_ENVELOPE );
315 // must call audio_sched->update() after stopping the sound
316 // but before deleting it.
317 audio_sched -> update();
318 // cout << "Still playing " << sample->get_sample()->getPlayCount()
319 // << " instances!" << endl;
323 // Due to the change in the sound manager, samples live
324 // until the sound manager gets removed.
329 // cout << "sndmgr: removed -> " << refname << endl;
332 // cout << "sndmgr: failed remove -> " << refname << endl;
338 // return true of the specified sound exists in the sound manager system
339 bool FGSoundMgr::exists( const string& refname ) {
340 sound_map_iterator it = sounds.find( refname );
341 if ( it != sounds.end() ) {
349 // return a pointer to the FGSimpleSound if the specified sound exists
350 // in the sound manager system, otherwise return NULL
351 FGSimpleSound *FGSoundMgr::find( const string& refname ) {
352 sound_map_iterator it = sounds.find( refname );
353 if ( it != sounds.end() ) {
361 // tell the scheduler to play the indexed sample in a continuous
363 bool FGSoundMgr::play_looped( const string& refname ) {
364 FGSimpleSound *sample;
366 if ((sample = find( refname )) == NULL)
369 sample->play(audio_sched, true);
374 // tell the scheduler to play the indexed sample once
375 bool FGSoundMgr::play_once( const string& refname ) {
376 FGSimpleSound *sample;
378 if ((sample = find( refname )) == NULL)
381 sample->play(audio_sched, false);
386 // return true of the specified sound is currently being played
387 bool FGSoundMgr::is_playing( const string& refname ) {
388 FGSimpleSound *sample;
390 if ((sample = find( refname )) == NULL)
393 return (sample->get_sample()->getPlayCount() > 0 );
397 // immediate stop playing the sound
398 bool FGSoundMgr::stop( const string& refname ) {
399 FGSimpleSound *sample;
401 if ((sample = find( refname )) == NULL)
404 audio_sched->stopSample( sample->get_sample() );