1 // fg_sound.cxx -- Sound class implementation
3 // Started by Erik Hofman, February 2002
4 // (Reuses some code from fg_fx.cxx created by David Megginson)
6 // Copyright (C) 2002 Curtis L. Olson - curt@flightgear.org
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <simgear/compiler.h>
26 #ifdef SG_HAVE_STD_INCLUDES
33 #include <simgear/debug/logstream.hxx>
34 #include <simgear/math/sg_random.h>
36 #include <Main/fg_props.hxx>
38 #include "fg_sound.hxx"
41 // static double _fg_lin(double v) { return v; }
42 static double _fg_inv(double v) { return (v == 0) ? 1e99 : 1/v; }
43 static double _fg_abs(double v) { return (v >= 0) ? v : -v; }
44 static double _fg_sqrt(double v) { return (v < 0) ? sqrt(-v) : sqrt(v); }
45 static double _fg_log10(double v) { return (v < 1) ? 0 : log10(v); }
46 static double _fg_log(double v) { return (v < 1) ? 0 : log(v); }
47 // static double _fg_sqr(double v) { return pow(v, 2); }
48 // static double _fg_pow3(double v) { return pow(v, 3); }
61 // {"pow3", _fg_pow3},
90 FGSound::init(SGPropertyNode *node)
94 // set global sound properties
97 _name = node->getStringValue("name", "");
98 SG_LOG(SG_GENERAL, SG_INFO, "Loading sound information for: " << _name );
100 const char *mode_str = node->getStringValue("mode", "");
101 if ( !strcmp(mode_str, "looped") ) {
102 _mode = FGSound::LOOPED;
104 } else if ( !strcmp(mode_str, "in-transit") ) {
105 _mode = FGSound::IN_TRANSIT;
108 _mode = FGSound::ONCE;
110 if ( strcmp(mode_str, "") )
111 SG_LOG(SG_GENERAL,SG_INFO, " Unknown sound mode, default to 'once'");
114 _property = fgGetNode(node->getStringValue("property", ""), true);
115 SGPropertyNode *condition = node->getChild("condition");
116 if (condition != NULL)
117 _condition = fgReadCondition(condition);
119 if (!_property && !_condition)
120 SG_LOG(SG_GENERAL, SG_WARN,
121 " Neither a condition nor a property specified");
124 // set volume properties
128 vector<SGPropertyNode_ptr> kids = node->getChildren("volume");
129 for (i = 0; (i < kids.size()) && (i < FGSound::MAXPROP); i++) {
130 _snd_prop volume = {NULL, NULL, NULL, 1.0, 0.0, 0.0, 0.0, false};
132 if (strcmp(kids[i]->getStringValue("property"), ""))
133 volume.prop = fgGetNode(kids[i]->getStringValue("property", ""), true);
135 const char *intern_str = kids[i]->getStringValue("internal", "");
136 if (!strcmp(intern_str, "dt_play"))
137 volume.intern = &_dt_play;
138 else if (!strcmp(intern_str, "dt_stop"))
139 volume.intern = &_dt_stop;
140 else if (!strcmp(intern_str, "random"))
141 volume.intern = &_random;
143 if ((volume.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
144 if (volume.factor < 0.0) {
145 volume.factor = -volume.factor;
146 volume.subtract = true;
149 const char *type_str = kids[i]->getStringValue("type", "");
150 if ( strcmp(type_str, "") ) {
152 for (int j=0; __fg_snd_fn[j].fn; j++)
153 if ( !strcmp(type_str, __fg_snd_fn[j].name) ) {
154 volume.fn = __fg_snd_fn[j].fn;
159 SG_LOG(SG_GENERAL,SG_INFO,
160 " Unknown volume type, default to 'lin'");
163 volume.offset = kids[i]->getDoubleValue("offset", 0.0);
165 if ((volume.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
166 SG_LOG( SG_GENERAL, SG_WARN,
167 "Volume minimum value below 0. Forced to 0.");
169 volume.max = kids[i]->getDoubleValue("max", 0.0);
170 if (volume.max && (volume.max < volume.min) )
171 SG_LOG(SG_GENERAL,SG_ALERT,
172 " Volume maximum below minimum. Neglected.");
174 _volume.push_back(volume);
181 // set pitch properties
184 kids = node->getChildren("pitch");
185 for (i = 0; (i < kids.size()) && (i < FGSound::MAXPROP); i++) {
186 _snd_prop pitch = {NULL, NULL, NULL, 1.0, 1.0, 0.0, 0.0, false};
188 if (strcmp(kids[i]->getStringValue("property", ""), ""))
189 pitch.prop = fgGetNode(kids[i]->getStringValue("property", ""), true);
191 const char *intern_str = kids[i]->getStringValue("internal", "");
192 if (!strcmp(intern_str, "dt_play"))
193 pitch.intern = &_dt_play;
194 else if (!strcmp(intern_str, "dt_stop"))
195 pitch.intern = &_dt_stop;
197 if ((pitch.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
198 if (pitch.factor < 0.0) {
199 pitch.factor = -pitch.factor;
200 pitch.subtract = true;
203 const char *type_str = kids[i]->getStringValue("type", "");
204 if ( strcmp(type_str, "") ) {
206 for (int j=0; __fg_snd_fn[j].fn; j++)
207 if ( !strcmp(type_str, __fg_snd_fn[j].name) ) {
208 pitch.fn = __fg_snd_fn[j].fn;
213 SG_LOG(SG_GENERAL,SG_INFO,
214 " Unknown pitch type, default to 'lin'");
217 pitch.offset = kids[i]->getDoubleValue("offset", 1.0);
219 if ((pitch.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
220 SG_LOG(SG_GENERAL,SG_WARN,
221 " Pitch minimum value below 0. Forced to 0.");
223 pitch.max = kids[i]->getDoubleValue("max", 0.0);
224 if (pitch.max && (pitch.max < pitch.min) )
225 SG_LOG(SG_GENERAL,SG_ALERT,
226 " Pitch maximum below minimum. Neglected");
228 _pitch.push_back(pitch);
233 // Initialize the sample
235 _mgr = globals->get_soundmgr();
236 if ((_sample = _mgr->find(_name)) == NULL)
237 _sample = _mgr->add(_name, node->getStringValue("path", ""));
239 _sample->set_volume(v);
240 _sample->set_pitch(p);
254 FGSound::update (double dt)
256 double curr_value = 0.0;
259 // If the state changes to false, stop playing.
262 curr_value = _property->getDoubleValue();
264 if ( // Lisp, anyone?
265 (_condition && !_condition->test()) ||
266 (!_condition && _property &&
269 ( (_mode == FGSound::IN_TRANSIT) && (curr_value == _prev_value) )
279 if (_sample->is_playing()) {
280 SG_LOG(SG_GENERAL, SG_INFO, "Stopping audio after " << _dt_play
281 << " sec: " << _name );
282 _sample->stop( _mgr->get_scheduler() );
290 // If the mode is ONCE and the sound is still playing,
291 // we have nothing to do anymore.
293 if (_active && (_mode == FGSound::ONCE)) {
295 if (!_sample->is_playing()) {
306 // Update playtime, cache the current value and feed the random number
309 _prev_value = curr_value;
310 _random = sg_random();
316 int max = _volume.size();
318 double volume_offset = 0.0;
320 for(i = 0; i < max; i++) {
324 v = _volume[i].prop->getDoubleValue();
326 else if (_volume[i].intern)
327 v = *_volume[i].intern;
330 v = _volume[i].fn(v);
332 v *= _volume[i].factor;
334 if (_volume[i].max && (v > _volume[i].max))
337 else if (v < _volume[i].min)
340 if (_volume[i].subtract) // Hack!
341 volume = _volume[i].offset - v;
344 volume_offset += _volume[i].offset;
354 double pitch_offset = 0.0;
356 for(i = 0; i < max; i++) {
360 p = _pitch[i].prop->getDoubleValue();
362 else if (_pitch[i].intern)
363 p = *_pitch[i].intern;
368 p *= _pitch[i].factor;
370 if (_pitch[i].max && (p > _pitch[i].max))
373 else if (p < _pitch[i].min)
376 if (_pitch[i].subtract) // Hack!
377 pitch = _pitch[i].offset - p;
380 pitch_offset += _pitch[i].offset;
386 // Change sample state
388 _sample->set_pitch( pitch_offset + pitch );
389 _sample->set_volume( volume_offset + volume );
393 // Do we need to start playing the sample?
397 if (_mode == FGSound::ONCE)
398 _sample->play(_mgr->get_scheduler(), false);
401 _sample->play(_mgr->get_scheduler(), true);
403 SG_LOG(SG_GENERAL, SG_INFO, "Playing audio after " << _dt_stop
404 << " sec: " << _name);
405 SG_LOG(SG_GENERAL, SG_BULK,
406 "Playing " << ((_mode == ONCE) ? "once" : "looped"));