1 // soundmgr.hxx -- 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 #ifndef _SG_SOUNDMGR_HXX
28 #define _SG_SOUNDMGR_HXX 1
31 # error This library requires C++
34 #include <simgear/compiler.h>
35 #include <simgear/timing/timestamp.hxx>
47 // manages everything we need to know for an individual sound sample
53 slEnvelope *pitch_envelope;
54 slEnvelope *volume_envelope;
60 SGSimpleSound( const char *path, const char *file = NULL );
61 SGSimpleSound( unsigned char *buffer, int len );
64 void play( slScheduler *sched, bool looped );
65 void stop( slScheduler *sched, bool quick = true );
67 inline void play_once( slScheduler *sched ) { play( sched, false); }
68 inline void play_looped( slScheduler *sched ) { play( sched, true); }
69 inline bool is_playing( ) {
70 return ( sample->getPlayCount() > 0 );
73 inline double get_pitch() const { return pitch; }
74 inline void set_pitch( double p ) {
76 pitch_envelope->setStep( 0, 0.01, pitch );
78 inline double get_volume() const { return volume; }
79 inline void set_volume( double v ) {
81 volume_envelope->setStep( 0, 0.01, volume );
84 inline slSample *get_sample() { return sample; }
85 inline slEnvelope *get_pitch_envelope() { return pitch_envelope; }
86 inline slEnvelope *get_volume_envelope() { return volume_envelope; }
95 typedef map < string, sample_ref * > sample_map;
96 typedef sample_map::iterator sample_map_iterator;
97 typedef sample_map::const_iterator const_sample_map_iterator;
99 typedef map < string, SGSimpleSound * > sound_map;
100 typedef sound_map::iterator sound_map_iterator;
101 typedef sound_map::const_iterator const_sound_map_iterator;
107 slScheduler *audio_sched;
108 smMixer *audio_mixer;
122 * (re) initialize the sound manager.
128 * Bind properties for the sound manager.
134 * Unbind properties for the sound manager.
140 * Run the audio scheduler.
142 void update(double dt);
158 inline bool is_working() const { return !audio_sched->notWorking(); }
160 // reinitialize the sound manager
161 inline void reinit() { init(); }
163 // add a sound effect, return true if successful
164 bool add( SGSimpleSound *sound, const string& refname);
166 // add a sound file, return the sample if successful, else return NULL
167 SGSimpleSound *add( const string& refname,
168 const char *path, const char *file = NULL );
170 // remove a sound effect, return true if successful
171 bool remove( const string& refname );
173 // return true of the specified sound exists in the sound manager system
174 bool exists( const string& refname );
176 // return a pointer to the SGSimpleSound if the specified sound
177 // exists in the sound manager system, otherwise return NULL
178 SGSimpleSound *find( const string& refname );
180 // tell the scheduler to play the indexed sample in a continuous
182 bool play_looped( const string& refname );
184 // tell the scheduler to play the indexed sample once
185 bool play_once( const string& refname );
187 // return true of the specified sound is currently being played
188 bool is_playing( const string& refname );
190 // immediate stop playing the sound
191 bool stop( const string& refname );
193 // return the audio scheduler
194 inline slScheduler *get_scheduler( ) { return audio_sched; };
198 #endif // _SG_SOUNDMGR_HXX