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>
35 #include <Main/fg_props.hxx>
37 #include "fg_sound.hxx"
40 // static double _fg_lin(double v) { return v; }
41 static double _fg_inv(double v) { return (v == 0) ? 1e99 : 1/v; }
42 static double _fg_abs(double v) { return (v >= 0) ? v : -v; }
43 static double _fg_sqrt(double v) { return (v < 0) ? sqrt(-v) : sqrt(v); }
44 static double _fg_log10(double v) { return (v < 1) ? 0 : log10(v); }
45 static double _fg_log(double v) { return (v < 1) ? 0 : log(v); }
46 // static double _fg_sqr(double v) { return pow(v, 2); }
47 // static double _fg_pow3(double v) { return pow(v, 3); }
60 // {"pow3", _fg_pow3},
80 _mgr->get_scheduler()->stopSample(_sample->get_sample());
94 FGSound::init(SGPropertyNode *node)
98 // set global sound properties
101 _name = node->getStringValue("name", "");
102 SG_LOG(SG_GENERAL, SG_INFO, "Loading sound information for: " << _name );
104 const char *mode_str = node->getStringValue("mode", "");
105 if ( !strcmp(mode_str, "looped") ) {
106 _mode = FGSound::LOOPED;
108 } else if ( !strcmp(mode_str, "in-transit") ) {
109 _mode = FGSound::IN_TRANSIT;
112 _mode = FGSound::ONCE;
114 if ( strcmp(mode_str, "") )
115 SG_LOG(SG_GENERAL,SG_INFO, " Unknown sound mode, default to 'once'");
118 _property = fgGetNode(node->getStringValue("property", ""), true);
119 SGPropertyNode *condition = node->getChild("condition");
120 if (condition != NULL)
121 _condition = fgReadCondition(condition);
123 if (!_property && !_condition)
124 SG_LOG(SG_GENERAL, SG_WARN,
125 " Neither a condition nor a property specified");
128 // set volume properties
132 vector<SGPropertyNode_ptr> kids = node->getChildren("volume");
133 for (i = 0; (i < kids.size()) && (i < FGSound::MAXPROP); i++) {
134 _snd_prop volume = {NULL, NULL, NULL, 1.0, 0.0, 0.0, 0.0, false};
136 if (strcmp(kids[i]->getStringValue("property"), ""))
137 volume.prop = fgGetNode(kids[i]->getStringValue("property", ""), true);
139 const char *intern_str = kids[i]->getStringValue("internal", "");
140 if (!strcmp(intern_str, "dt_play"))
141 volume.intern = &_dt_play;
142 else if (!strcmp(intern_str, "dt_stop"))
143 volume.intern = &_dt_stop;
145 if ((volume.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
146 if (volume.factor < 0.0) {
147 volume.factor = -volume.factor;
148 volume.subtract = true;
151 const char *type_str = kids[i]->getStringValue("type", "");
152 if ( strcmp(type_str, "") ) {
154 for (int j=0; __fg_snd_fn[j].fn; j++)
155 if ( !strcmp(type_str, __fg_snd_fn[j].name) ) {
156 volume.fn = __fg_snd_fn[j].fn;
161 SG_LOG(SG_GENERAL,SG_INFO,
162 " Unknown volume type, default to 'lin'");
165 volume.offset = kids[i]->getDoubleValue("offset", 0.0);
167 if ((volume.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
168 SG_LOG( SG_GENERAL, SG_WARN,
169 "Volume minimum value below 0. Forced to 0.");
171 volume.max = kids[i]->getDoubleValue("max", 0.0);
172 if (volume.max && (volume.max < volume.min) )
173 SG_LOG(SG_GENERAL,SG_ALERT,
174 " Volume maximum below minimum. Neglected.");
176 _volume.push_back(volume);
183 // set pitch properties
186 kids = node->getChildren("pitch");
187 for (i = 0; (i < kids.size()) && (i < FGSound::MAXPROP); i++) {
188 _snd_prop pitch = {NULL, NULL, NULL, 1.0, 1.0, 0.0, 0.0, false};
190 if (strcmp(kids[i]->getStringValue("property", ""), ""))
191 pitch.prop = fgGetNode(kids[i]->getStringValue("property", ""), true);
193 const char *intern_str = kids[i]->getStringValue("internal", "");
194 if (!strcmp(intern_str, "dt_play"))
195 pitch.intern = &_dt_play;
196 else if (!strcmp(intern_str, "dt_stop"))
197 pitch.intern = &_dt_stop;
199 if ((pitch.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
200 if (pitch.factor < 0.0) {
201 pitch.factor = -pitch.factor;
202 pitch.subtract = true;
205 const char *type_str = kids[i]->getStringValue("type", "");
206 if ( strcmp(type_str, "") ) {
208 for (int j=0; __fg_snd_fn[j].fn; j++)
209 if ( !strcmp(type_str, __fg_snd_fn[j].name) ) {
210 pitch.fn = __fg_snd_fn[j].fn;
215 SG_LOG(SG_GENERAL,SG_INFO,
216 " Unknown pitch type, default to 'lin'");
219 pitch.offset = kids[i]->getDoubleValue("offset", 1.0);
221 if ((pitch.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
222 SG_LOG(SG_GENERAL,SG_WARN,
223 " Pitch minimum value below 0. Forced to 0.");
225 pitch.max = kids[i]->getDoubleValue("max", 0.0);
226 if (pitch.max && (pitch.max < pitch.min) )
227 SG_LOG(SG_GENERAL,SG_ALERT,
228 " Pitch maximum below minimum. Neglected");
230 _pitch.push_back(pitch);
235 // Initialize the sample
237 _mgr = globals->get_soundmgr();
238 if ((_sample = _mgr->find(_name)) == NULL)
239 _sample = _mgr->add(_name, node->getStringValue("path", ""));
241 _sample->set_volume(v);
242 _sample->set_pitch(p);
256 FGSound::update (double dt)
258 double curr_value = 0.0;
261 // If the state changes to false, stop playing.
264 curr_value = _property->getDoubleValue();
266 if ( // Lisp, anyone?
267 (_condition && !_condition->test()) ||
268 (!_condition && _property &&
271 ( (_mode == FGSound::IN_TRANSIT) && (curr_value == _prev_value) )
277 if ((_mode != FGSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME)) {
279 if (_sample->is_playing()) {
280 SG_LOG(SG_GENERAL, SG_INFO, "Stopping audio after " << _dt_play
281 << " sec: " << _name );
283 _sample->stop( _mgr->get_scheduler() );
299 // If the mode is ONCE and the sound is still playing,
300 // we have nothing to do anymore.
302 if (_active && (_mode == FGSound::ONCE)) {
304 if (!_sample->is_playing()) {
315 // Update the playing time, cache the current value and
316 // clear the delay timer.
319 _prev_value = curr_value;
326 int max = _volume.size();
328 double volume_offset = 0.0;
330 for(i = 0; i < max; i++) {
334 v = _volume[i].prop->getDoubleValue();
336 else if (_volume[i].intern)
337 v = *_volume[i].intern;
340 v = _volume[i].fn(v);
342 v *= _volume[i].factor;
344 if (_volume[i].max && (v > _volume[i].max))
347 else if (v < _volume[i].min)
350 if (_volume[i].subtract) // Hack!
351 volume = _volume[i].offset - v;
354 volume_offset += _volume[i].offset;
364 double pitch_offset = 0.0;
366 for(i = 0; i < max; i++) {
370 p = _pitch[i].prop->getDoubleValue();
372 else if (_pitch[i].intern)
373 p = *_pitch[i].intern;
378 p *= _pitch[i].factor;
380 if (_pitch[i].max && (p > _pitch[i].max))
383 else if (p < _pitch[i].min)
386 if (_pitch[i].subtract) // Hack!
387 pitch = _pitch[i].offset - p;
390 pitch_offset += _pitch[i].offset;
396 // Change sample state
398 _sample->set_pitch( pitch_offset + pitch );
399 _sample->set_volume( volume_offset + volume );
403 // Do we need to start playing the sample?
407 if (_mode == FGSound::ONCE)
408 _sample->play(_mgr->get_scheduler(), false);
411 _sample->play(_mgr->get_scheduler(), true);
413 SG_LOG(SG_GENERAL, SG_INFO, "Playing audio after " << _dt_stop
414 << " sec: " << _name);
415 SG_LOG(SG_GENERAL, SG_BULK,
416 "Playing " << ((_mode == ONCE) ? "once" : "looped"));