1 // 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 - http://www.flightgear.org/~curt
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 # include <simgear_config.h>
28 #include <simgear/compiler.h>
32 #include <simgear/debug/logstream.hxx>
33 #include <simgear/props/condition.hxx>
34 #include <simgear/math/SGMath.hxx>
37 #include "xmlsound.hxx"
40 // static double _snd_lin(double v) { return v; }
41 static double _snd_inv(double v) { return (v == 0) ? 1e99 : 1/v; }
42 static double _snd_abs(double v) { return (v >= 0) ? v : -v; }
43 static double _snd_sqrt(double v) { return sqrt(fabs(v)); }
44 static double _snd_log10(double v) { return log10(fabs(v)); }
45 static double _snd_log(double v) { return log(fabs(v)); }
46 // static double _snd_sqr(double v) { return v*v; }
47 // static double _snd_pow3(double v) { return v*v*v; }
60 // {"pow3", _snd_pow3},
64 SGXmlSound::SGXmlSound()
69 _mode(SGXmlSound::ONCE),
77 SGXmlSound::~SGXmlSound()
89 SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
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 = SGXmlSound::LOOPED;
104 } else if ( !strcmp(mode_str, "in-transit") ) {
105 _mode = SGXmlSound::IN_TRANSIT;
108 _mode = SGXmlSound::ONCE;
110 if ( strcmp(mode_str, "") )
111 SG_LOG(SG_GENERAL,SG_INFO, " Unknown sound mode, default to 'once'");
114 _property = root->getNode(node->getStringValue("property", ""), true);
115 SGPropertyNode *condition = node->getChild("condition");
116 if (condition != NULL)
117 _condition = sgReadCondition(root, 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 < SGXmlSound::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 = root->getNode(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;
141 if ((volume.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
142 if (volume.factor < 0.0) {
143 volume.factor = -volume.factor;
144 volume.subtract = true;
147 const char *type_str = kids[i]->getStringValue("type", "");
148 if ( strcmp(type_str, "") ) {
150 for (int j=0; __sound_fn[j].fn; j++)
151 if ( !strcmp(type_str, __sound_fn[j].name) ) {
152 volume.fn = __sound_fn[j].fn;
157 SG_LOG(SG_GENERAL,SG_INFO,
158 " Unknown volume type, default to 'lin'");
161 volume.offset = kids[i]->getDoubleValue("offset", 0.0);
163 if ((volume.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
164 SG_LOG( SG_GENERAL, SG_WARN,
165 "Volume minimum value below 0. Forced to 0.");
167 volume.max = kids[i]->getDoubleValue("max", 0.0);
168 if (volume.max && (volume.max < volume.min) )
169 SG_LOG(SG_GENERAL,SG_ALERT,
170 " Volume maximum below minimum. Neglected.");
172 _volume.push_back(volume);
177 float reference_dist = node->getDoubleValue("reference-dist", 500.0);
178 float max_dist = node->getDoubleValue("max-dist", 3000.0);
181 // set pitch properties
184 kids = node->getChildren("pitch");
185 for (i = 0; (i < kids.size()) && (i < SGXmlSound::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 = root->getNode(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; __sound_fn[j].fn; j++)
207 if ( !strcmp(type_str, __sound_fn[j].name) ) {
208 pitch.fn = __sound_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);
236 sgSetVec3( offset_pos, 0.0, 0.0, 0.0 );
237 SGPropertyNode_ptr pos = node->getChild("position");
239 offset_pos[0] = pos->getDoubleValue("x", 0.0);
240 offset_pos[1] = pos->getDoubleValue("y", 0.0);
241 offset_pos[2] = pos->getDoubleValue("z", 0.0);
248 float inner, outer, outer_gain;
249 sgSetVec3( dir, 0.0, 0.0, 0.0 );
250 inner = outer = 360.0;
252 pos = node->getChild("orientation");
254 dir[0] = pos->getDoubleValue("x", 0.0);
255 dir[1] = pos->getDoubleValue("y", 0.0);
256 dir[2] = pos->getDoubleValue("z", 0.0);
257 inner = pos->getDoubleValue("inner-angle", 360.0);
258 outer = pos->getDoubleValue("outer-angle", 360.0);
259 outer_gain = pos->getDoubleValue("outer-gain", 0.0);
263 // Initialize the sample
266 if ( (_sample = _mgr->find(_name)) == NULL ) {
267 // FIXME: Does it make sense to overwrite a previous entry's
268 // configuration just because a new entry has the same name?
269 // Note that we can't match on identical "path" because we the
270 // new entry could be at a different location with different
271 // configuration so we need a new sample which creates a new
272 // "alSource". The semantics of what is going on here seems
273 // confused and needs to be thought through more carefully.
274 _sample = new SGSoundSample( path.c_str(),
275 node->getStringValue("path", "") );
277 _mgr->add( _sample, _name );
280 _sample->set_offset_pos( offset_pos );
281 _sample->set_orientation(dir, inner, outer, outer_gain);
282 _sample->set_volume(v);
283 _sample->set_reference_dist( reference_dist );
284 _sample->set_max_dist( max_dist );
285 _sample->set_pitch(p);
289 SGXmlSound::update (double dt)
291 double curr_value = 0.0;
294 // If the state changes to false, stop playing.
297 curr_value = _property->getDoubleValue();
299 if ( // Lisp, anyone?
300 (_condition && !_condition->test()) ||
301 (!_condition && _property &&
304 ( (_mode == SGXmlSound::IN_TRANSIT) && (curr_value == _prev_value) )
309 if ((_mode != SGXmlSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME)) {
310 if (_sample->is_playing()) {
311 SG_LOG(SG_GENERAL, SG_INFO, "Stopping audio after " << _dt_play
312 << " sec: " << _name );
328 // If the mode is ONCE and the sound is still playing,
329 // we have nothing to do anymore.
331 if (_active && (_mode == SGXmlSound::ONCE)) {
333 if (!_sample->is_playing()) {
344 // Update the playing time, cache the current value and
345 // clear the delay timer.
348 _prev_value = curr_value;
355 int max = _volume.size();
357 double volume_offset = 0.0;
359 for(i = 0; i < max; i++) {
363 v = _volume[i].prop->getDoubleValue();
365 else if (_volume[i].intern)
366 v = *_volume[i].intern;
369 v = _volume[i].fn(v);
371 v *= _volume[i].factor;
373 if (_volume[i].max && (v > _volume[i].max))
376 else if (v < _volume[i].min)
379 if (_volume[i].subtract) // Hack!
380 volume = _volume[i].offset - v;
383 volume_offset += _volume[i].offset;
393 double pitch_offset = 0.0;
395 for(i = 0; i < max; i++) {
399 p = _pitch[i].prop->getDoubleValue();
401 else if (_pitch[i].intern)
402 p = *_pitch[i].intern;
407 p *= _pitch[i].factor;
409 if (_pitch[i].max && (p > _pitch[i].max))
412 else if (p < _pitch[i].min)
415 if (_pitch[i].subtract) // Hack!
416 pitch = _pitch[i].offset - p;
419 pitch_offset += _pitch[i].offset;
425 // Change sample state
427 _sample->set_pitch( pitch_offset + pitch );
428 if ((volume_offset + volume ) > 1.0)
430 _sample->set_volume( 1.0 );
431 SG_LOG(SG_GENERAL, SG_WARN,
432 "Volume larger than 1.0 in configuration for '" << _name
435 _sample->set_volume( volume_offset + volume );
439 // Do we need to start playing the sample?
443 if (_mode == SGXmlSound::ONCE)
444 _sample->play(false);
449 SG_LOG(SG_GENERAL, SG_INFO, "Playing audio after " << _dt_stop
450 << " sec: " << _name);
451 SG_LOG(SG_GENERAL, SG_BULK,
452 "Playing " << ((_mode == ONCE) ? "once" : "looped"));