1 // sound.hxx -- Sound class implementation
3 // Started by Erik Hofman, February 2002
5 // Copyright (C) 2002 Erik Hofman - erik@ehofman.com
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 * Provides a class to manage a single sound event including things
26 * like looping, volume and pitch changes.
30 #define _SG_SOUND_HXX 1
33 # error This library requires C++
36 #include <simgear/compiler.h>
37 #include <simgear/props/condition.hxx>
39 #include "soundmgr.hxx"
41 static const double MAX_TRANSIT_TIME = 0.1; // 100 ms.
45 * Class for handling one sound event.
47 * This class handles everything for a particular sound event, by
48 * scanning an a pre-loaded property tree structure for sound
49 * settings, setting up its internal states, and managing sound
50 * playback whenever such an event happens.
61 * Initialize the sound event.
63 * Prior to initialization of the sound event the propgrams property root
64 * has to be defined, the sound configuration XML tree has to be loaded
65 * and a sound manager class has to be defined.
67 * A sound configuration file would look like this:
70 * <name/> Define the name of the event. For refference only.
72 * looped: play this sound looped.
73 * in-transit: play looped while the event is happening.
74 * once: play this sound once.
75 * <path/> The relative path to the audio file.
76 * <property/> Take action if this property becomes true.
77 * <condition/> Take action if this condition becomes true.
78 * <volume> or <pitch> Define volume or pitch settings.
79 * <property/> Take the value of this property as a refference for the
82 * dt_start: the time elapsed since this sound is playing.
83 * dt_stop: the time elapsed since this sound has stopped.
84 * <offset/> Add this value to the result.
85 * <factor/> Multiply the result by this factor.
86 * <min/> Make sure the value is never less than this value.
87 * <max/> Make sure the value is never larger than this value.
88 * </volume> or </pitch>
95 * @param root The root node of the programs property tree.
96 * @param child A pointer to the location of the current event as defined
97 * in the configuration file.
98 * @param sndmgr A pointer to a pre-initialized sound manager class.
99 * @param path The path where the audio files remain.
101 virtual void init (SGPropertyNode *, SGPropertyNode *, SGSoundMgr *,
105 * Check wheter an event has happened and if action has to be taken.
107 virtual void update (double dt);
110 * Stop taking action on the pre-defined events.
117 enum { ONCE=0, LOOPED, IN_TRANSIT };
118 enum { LEVEL=0, INVERTED, FLIPFLOP };
120 // SGSound properties
122 SGPropertyNode * prop;
123 double (*fn)(double);
135 SGSimpleSound * _sample;
137 SGCondition * _condition;
138 SGPropertyNode * _property;
146 double _stopping; // time after the sound should have stopped.
147 // This is usefull for lost packets in in-trasit mode.
149 vector<_snd_prop> _volume;
150 vector<_snd_prop> _pitch;
154 #endif // _SG_SOUND_HXX