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.
28 * Provides a sound manager class to keep track of
29 * multiple sounds and manage playing them with different effects and
33 #ifndef _SG_SOUNDMGR_HXX
34 #define _SG_SOUNDMGR_HXX 1
37 # error This library requires C++
40 #include <simgear/compiler.h>
41 #include <simgear/timing/timestamp.hxx>
54 * manages everything we need to know for an individual sound sample
61 slEnvelope *pitch_envelope;
62 slEnvelope *volume_envelope;
68 SGSimpleSound( const char *path, const char *file = NULL );
69 SGSimpleSound( unsigned char *buffer, int len );
73 * Start playing this sample.
75 * @param sched A pointer to the appropriate scheduler.
76 * @param looped Define wether the sound should be played in a loop.
78 void play( slScheduler *sched, bool looped );
81 * Stop playing this sample.
83 * @param sched A pointer to the appropriate scheduler.
85 void stop( slScheduler *sched );
88 * Play this sample once.
91 inline void play_once( slScheduler *sched ) { play( sched, false); }
94 * Play this sample looped.
97 inline void play_looped( slScheduler *sched ) { play( sched, true); }
100 * Test if a sample is curretnly playing.
101 * @return true if is is playing, false otherwise.
103 inline bool is_playing( ) {
104 return ( sample->getPlayCount() > 0 );
108 * Get the current pitch setting of this sample.
110 inline double get_pitch() const { return pitch; }
113 * Set the pitch of this sample.
115 inline void set_pitch( double p ) {
117 pitch_envelope->setStep( 0, 0.01, pitch );
121 * Get the current volume setting of this sample.
123 inline double get_volume() const { return volume; }
126 * Set the volume of this sample.
128 inline void set_volume( double v ) {
130 volume_envelope->setStep( 0, 0.01, volume );
134 * Get a refference to the raw sample.
136 inline slSample *get_sample() { return sample; }
139 * Get the pitch envelope setting of this sample.
141 inline slEnvelope *get_pitch_envelope() { return pitch_envelope; }
144 * Get the volume envelope setting of this sample.
146 inline slEnvelope *get_volume_envelope() { return volume_envelope; }
155 typedef map < string, sample_ref * > sample_map;
156 typedef sample_map::iterator sample_map_iterator;
157 typedef sample_map::const_iterator const_sample_map_iterator;
159 typedef map < string, SGSimpleSound * > sound_map;
160 typedef sound_map::iterator sound_map_iterator;
161 typedef sound_map::const_iterator const_sound_map_iterator;
165 * Manage a collection of SGSimpleSound instances
170 slScheduler *audio_sched;
171 smMixer *audio_mixer;
185 * (re) initialize the sound manager.
191 * Bind properties for the sound manager.
197 * Unbind properties for the sound manager.
203 * Run the audio scheduler.
205 void update(double dt);
223 inline bool is_working() const { return !audio_sched->notWorking(); }
226 * reinitialize the sound manager
228 inline void reinit() { init(); }
231 * add a sound effect, return true if successful
233 bool add( SGSimpleSound *sound, const string& refname);
236 * Add a sound file to the sound manager.
238 * The advantage of using this function over the previous one is that
239 * it doesn't load a sample if it already is in memory, but instead it
240 * uses the already loaded sample data.
242 * @param refname A refference name to make a distincion between samples.
243 * @param path The path or full filename of the sample to load.
244 * @param file An optional filename which will be appended to the path.
245 * @return An instance of the sound for further manipulation.
247 SGSimpleSound *add( const string& refname,
248 const char *path, const char *file = NULL );
251 * remove a sound effect, return true if successful
253 bool remove( const string& refname );
256 * return true of the specified sound exists in the sound manager system
258 bool exists( const string& refname );
261 * return a pointer to the SGSimpleSound if the specified sound
262 * exists in the sound manager system, otherwise return NULL
264 SGSimpleSound *find( const string& refname );
267 * tell the scheduler to play the indexed sample in a continuous
270 bool play_looped( const string& refname );
273 * tell the scheduler to play the indexed sample once
275 bool play_once( const string& refname );
278 * return true of the specified sound is currently being played
280 bool is_playing( const string& refname );
283 * immediate stop playing the sound
285 bool stop( const string& refname );
288 * return the audio scheduler
290 inline slScheduler *get_scheduler( ) { return audio_sched; };
294 #endif // _SG_SOUNDMGR_HXX