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 )
38 FGSimpleSound::FGSimpleSound( string file ) {
39 SGPath slfile( globals->get_fg_root() );
40 slfile.append( file );
41 sample = new slSample ( (char *)slfile.c_str() );
42 pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
43 volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
44 pitch_envelope->setStep ( 0, 0.01, 1.0 );
45 volume_envelope->setStep ( 0, 0.01, 1.0 );
48 FGSimpleSound::FGSimpleSound( unsigned char *buffer, int len ) {
49 sample = new slSample ( buffer, len );
50 pitch_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
51 volume_envelope = new slEnvelope( 1, SL_SAMPLE_ONE_SHOT );
52 pitch_envelope->setStep ( 0, 0.01, 1.0 );
53 volume_envelope->setStep ( 0, 0.01, 1.0 );
57 FGSimpleSound::~FGSimpleSound() {
58 delete pitch_envelope;
59 delete volume_envelope;
65 FGSoundMgr::FGSoundMgr() {
66 audio_sched = new slScheduler( 8000 );
67 audio_sched -> setMaxConcurrent ( 6 );
69 audio_mixer = new smMixer;
71 SG_LOG( SG_GENERAL, SG_INFO,
72 "Rate = " << audio_sched->getRate()
73 << " Bps = " << audio_sched->getBps()
74 << " Stereo = " << audio_sched->getStereo() );
78 FGSoundMgr::~FGSoundMgr() {
79 sound_map_iterator current = sounds.begin();
80 sound_map_iterator end = sounds.end();
81 for ( ; current != end; ++current ) {
82 FGSimpleSound *s = current->second;
83 delete s->get_sample();
92 // initialize the sound manager
93 bool FGSoundMgr::init() {
95 safety = FG_MAX_SOUND_SAFETY;
97 audio_mixer -> setMasterVolume ( 80 ) ; /* 80% of max volume. */
98 audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
100 sound_map_iterator current = sounds.begin();
101 sound_map_iterator end = sounds.end();
102 for ( ; current != end; ++current ) {
103 FGSimpleSound *s = current->second;
104 delete s->get_sample();
109 if ( audio_sched->not_working() ) {
117 // run the audio scheduler
118 bool FGSoundMgr::update() {
122 double elapsed = (double)(current - last) / 1000000.0;
125 if ( elapsed > safety ) {
128 safety = safety * 0.99 + elapsed * 0.01;
130 if ( safety > FG_MAX_SOUND_SAFETY ) {
131 safety = FG_MAX_SOUND_SAFETY;
133 // cout << "safety = " << safety << endl;
134 audio_sched -> setSafetyMargin ( FG_SOUND_SAFETY_MULT * safety ) ;
136 if ( !audio_sched->not_working() ) {
137 audio_sched -> update();
145 // add a sound effect, return true if successful
146 bool FGSoundMgr::add( FGSimpleSound *sound, const string& refname ) {
147 sounds[refname] = sound;
153 // remove a sound effect, return true if successful
154 bool FGSoundMgr::remove( const string& refname ) {
156 sound_map_iterator it = sounds.find( refname );
157 if ( it != sounds.end() ) {
158 // first stop the sound from playing (so we don't bomb the
160 FGSimpleSound *sample = it->second;
162 // cout << "Playing " << sample->get_sample()->getPlayCount()
163 // << " instances!" << endl;
165 audio_sched->stopSample( sample->get_sample() );
166 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
169 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
171 SL_VOLUME_ENVELOPE );
173 #if defined ( PLIB_1_2_X )
174 // if PLIB_1_2_X, we can't reliably remove sounds
175 // that are currently being played. :-( So, let's just not
176 // remove them and return false. The effects of this are that
177 // the sound sample will continue to finish playing (or
178 // continue to loop forever.) And the sound sample will
179 // remain registered in the plib audio system. This is a
180 // memory leak, and eventually this could cause us to max out
181 // the total number of allowed sound samples in plib, but what
182 // are you going to do? Hopefully the plib team will do a new
183 // stable relase with these problems fixed.
185 // cout << "plib broken audio, skipping actual remove" << endl;
189 // must call audio_sched->update() after stopping the sound
190 // but before deleting it.
191 audio_sched -> update();
192 // cout << "Still playing " << sample->get_sample()->getPlayCount()
193 // << " instances!" << endl;
206 // return true of the specified sound exists in the sound manager system
207 bool FGSoundMgr::exists( const string& refname ) {
208 sound_map_iterator it = sounds.find( refname );
209 if ( it != sounds.end() ) {
217 // return a pointer to the FGSimpleSound if the specified sound exists
218 // in the sound manager system, otherwise return NULL
219 FGSimpleSound *FGSoundMgr::find( const string& refname ) {
220 sound_map_iterator it = sounds.find( refname );
221 if ( it != sounds.end() ) {
229 // tell the scheduler to play the indexed sample in a continuous
231 bool FGSoundMgr::play_looped( const string& refname ) {
232 sound_map_iterator it = sounds.find( refname );
233 if ( it != sounds.end() ) {
234 FGSimpleSound *sample = it->second;
235 audio_sched->loopSample( sample->get_sample() );
236 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
237 sample->get_pitch_envelope(),
239 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
240 sample->get_volume_envelope(),
241 SL_VOLUME_ENVELOPE );
250 // tell the scheduler to play the indexed sample once
251 bool FGSoundMgr::play_once( const string& refname ) {
252 sound_map_iterator it = sounds.find( refname );
253 if ( it != sounds.end() ) {
254 FGSimpleSound *sample = it->second;
255 audio_sched->stopSample( sample->get_sample() );
256 audio_sched->playSample( sample->get_sample() );
257 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 0,
258 sample->get_pitch_envelope(),
260 audio_sched->addSampleEnvelope( sample->get_sample(), 0, 1,
261 sample->get_volume_envelope(),
262 SL_VOLUME_ENVELOPE );
271 // return true of the specified sound is currently being played
272 bool FGSoundMgr::is_playing( const string& refname ) {
273 sound_map_iterator it = sounds.find( refname );
274 if ( it != sounds.end() ) {
275 FGSimpleSound *sample = it->second;
276 return (sample->get_sample()->getPlayCount() > 0 );
284 // immediate stop playing the sound
285 bool FGSoundMgr::stop( const string& refname ) {
286 sound_map_iterator it = sounds.find( refname );
287 if ( it != sounds.end() ) {
288 FGSimpleSound *sample = it->second;
289 audio_sched->stopSample( sample->get_sample() );