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},
93 FGSound::init(SGPropertyNode *node)
97 // set global sound properties
100 _name = node->getStringValue("name", "");
101 SG_LOG(SG_GENERAL, SG_INFO, "Loading sound information for: " << _name );
103 const char *mode_str = node->getStringValue("mode", "");
104 if ( !strcmp(mode_str, "looped") ) {
105 _mode = FGSound::LOOPED;
107 } else if ( !strcmp(mode_str, "in-transit") ) {
108 _mode = FGSound::IN_TRANSIT;
111 _mode = FGSound::ONCE;
113 if ( strcmp(mode_str, "") )
114 SG_LOG(SG_GENERAL,SG_INFO, " Unknown sound mode, default to 'once'");
117 _property = fgGetNode(node->getStringValue("property", ""), true);
118 SGPropertyNode *condition = node->getChild("condition");
119 if (condition != NULL)
120 _condition = fgReadCondition(condition);
122 if (!_property && !_condition)
123 SG_LOG(SG_GENERAL, SG_WARN,
124 " Neither a condition nor a property specified");
127 // set volume properties
131 vector<SGPropertyNode_ptr> kids = node->getChildren("volume");
132 for (i = 0; (i < kids.size()) && (i < FGSound::MAXPROP); i++) {
133 _snd_prop volume = {NULL, NULL, NULL, 1.0, 0.0, 0.0, 0.0, false};
135 if (strcmp(kids[i]->getStringValue("property"), ""))
136 volume.prop = fgGetNode(kids[i]->getStringValue("property", ""), true);
138 const char *intern_str = kids[i]->getStringValue("internal", "");
139 if (!strcmp(intern_str, "dt_play"))
140 volume.intern = &_dt_play;
141 else if (!strcmp(intern_str, "dt_stop"))
142 volume.intern = &_dt_stop;
144 if ((volume.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
145 if (volume.factor < 0.0) {
146 volume.factor = -volume.factor;
147 volume.subtract = true;
150 const char *type_str = kids[i]->getStringValue("type", "");
151 if ( strcmp(type_str, "") ) {
153 for (int j=0; __fg_snd_fn[j].fn; j++)
154 if ( !strcmp(type_str, __fg_snd_fn[j].name) ) {
155 volume.fn = __fg_snd_fn[j].fn;
160 SG_LOG(SG_GENERAL,SG_INFO,
161 " Unknown volume type, default to 'lin'");
164 volume.offset = kids[i]->getDoubleValue("offset", 0.0);
166 if ((volume.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
167 SG_LOG( SG_GENERAL, SG_WARN,
168 "Volume minimum value below 0. Forced to 0.");
170 volume.max = kids[i]->getDoubleValue("max", 0.0);
171 if (volume.max && (volume.max < volume.min) )
172 SG_LOG(SG_GENERAL,SG_ALERT,
173 " Volume maximum below minimum. Neglected.");
175 _volume.push_back(volume);
182 // set pitch properties
185 kids = node->getChildren("pitch");
186 for (i = 0; (i < kids.size()) && (i < FGSound::MAXPROP); i++) {
187 _snd_prop pitch = {NULL, NULL, NULL, 1.0, 1.0, 0.0, 0.0, false};
189 if (strcmp(kids[i]->getStringValue("property", ""), ""))
190 pitch.prop = fgGetNode(kids[i]->getStringValue("property", ""), true);
192 const char *intern_str = kids[i]->getStringValue("internal", "");
193 if (!strcmp(intern_str, "dt_play"))
194 pitch.intern = &_dt_play;
195 else if (!strcmp(intern_str, "dt_stop"))
196 pitch.intern = &_dt_stop;
198 if ((pitch.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
199 if (pitch.factor < 0.0) {
200 pitch.factor = -pitch.factor;
201 pitch.subtract = true;
204 const char *type_str = kids[i]->getStringValue("type", "");
205 if ( strcmp(type_str, "") ) {
207 for (int j=0; __fg_snd_fn[j].fn; j++)
208 if ( !strcmp(type_str, __fg_snd_fn[j].name) ) {
209 pitch.fn = __fg_snd_fn[j].fn;
214 SG_LOG(SG_GENERAL,SG_INFO,
215 " Unknown pitch type, default to 'lin'");
218 pitch.offset = kids[i]->getDoubleValue("offset", 1.0);
220 if ((pitch.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
221 SG_LOG(SG_GENERAL,SG_WARN,
222 " Pitch minimum value below 0. Forced to 0.");
224 pitch.max = kids[i]->getDoubleValue("max", 0.0);
225 if (pitch.max && (pitch.max < pitch.min) )
226 SG_LOG(SG_GENERAL,SG_ALERT,
227 " Pitch maximum below minimum. Neglected");
229 _pitch.push_back(pitch);
234 // Initialize the sample
236 _mgr = globals->get_soundmgr();
237 if ((_sample = _mgr->find(_name)) == NULL)
238 _sample = _mgr->add(_name, node->getStringValue("path", ""));
240 _sample->set_volume(v);
241 _sample->set_pitch(p);
255 FGSound::update (double dt)
257 double curr_value = 0.0;
260 // If the state changes to false, stop playing.
263 curr_value = _property->getDoubleValue();
265 if ( // Lisp, anyone?
266 (_condition && !_condition->test()) ||
267 (!_condition && _property &&
270 ( (_mode == FGSound::IN_TRANSIT) && (curr_value == _prev_value) )
276 if ((_mode != FGSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME)) {
278 if (_sample->is_playing()) {
279 SG_LOG(SG_GENERAL, SG_INFO, "Stopping audio after " << _dt_play
280 << " sec: " << _name );
282 _sample->stop( _mgr->get_scheduler() );
298 // If the mode is ONCE and the sound is still playing,
299 // we have nothing to do anymore.
301 if (_active && (_mode == FGSound::ONCE)) {
303 if (!_sample->is_playing()) {
314 // Update the playing time, cache the current value and
315 // clear the delay timer.
318 _prev_value = curr_value;
325 int max = _volume.size();
327 double volume_offset = 0.0;
329 for(i = 0; i < max; i++) {
333 v = _volume[i].prop->getDoubleValue();
335 else if (_volume[i].intern)
336 v = *_volume[i].intern;
339 v = _volume[i].fn(v);
341 v *= _volume[i].factor;
343 if (_volume[i].max && (v > _volume[i].max))
346 else if (v < _volume[i].min)
349 if (_volume[i].subtract) // Hack!
350 volume = _volume[i].offset - v;
353 volume_offset += _volume[i].offset;
363 double pitch_offset = 0.0;
365 for(i = 0; i < max; i++) {
369 p = _pitch[i].prop->getDoubleValue();
371 else if (_pitch[i].intern)
372 p = *_pitch[i].intern;
377 p *= _pitch[i].factor;
379 if (_pitch[i].max && (p > _pitch[i].max))
382 else if (p < _pitch[i].min)
385 if (_pitch[i].subtract) // Hack!
386 pitch = _pitch[i].offset - p;
389 pitch_offset += _pitch[i].offset;
395 // Change sample state
397 _sample->set_pitch( pitch_offset + pitch );
398 _sample->set_volume( volume_offset + volume );
402 // Do we need to start playing the sample?
406 if (_mode == FGSound::ONCE)
407 _sample->play(_mgr->get_scheduler(), false);
410 _sample->play(_mgr->get_scheduler(), true);
412 SG_LOG(SG_GENERAL, SG_INFO, "Playing audio after " << _dt_stop
413 << " sec: " << _name);
414 SG_LOG(SG_GENERAL, SG_BULK,
415 "Playing " << ((_mode == ONCE) ? "once" : "looped"));