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., 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/props/condition.hxx>
35 #include <simgear/math/fastmath.hxx>
38 #include "xmlsound.hxx"
41 // static double _snd_lin(double v) { return v; }
42 static double _snd_inv(double v) { return (v == 0) ? 1e99 : 1/v; }
43 static double _snd_abs(double v) { return (v >= 0) ? v : -v; }
44 static double _snd_sqrt(double v) { return (v < 0) ? sqrt(-v) : sqrt(v); }
45 static double _snd_log10(double v) { return (v < 1) ? 0 : fast_log10(v); }
46 static double _snd_log(double v) { return (v < 1) ? 0 : fast_log(v); }
47 // static double _snd_sqr(double v) { return v*v; }
48 // static double _snd_pow3(double v) { return v*v*v; }
61 // {"pow3", _snd_pow3},
65 SGXmlSound::SGXmlSound()
71 _mode(SGXmlSound::ONCE),
79 SGXmlSound::~SGXmlSound()
92 SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
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 = SGXmlSound::LOOPED;
107 } else if ( !strcmp(mode_str, "in-transit") ) {
108 _mode = SGXmlSound::IN_TRANSIT;
111 _mode = SGXmlSound::ONCE;
113 if ( strcmp(mode_str, "") )
114 SG_LOG(SG_GENERAL,SG_INFO, " Unknown sound mode, default to 'once'");
117 _property = root->getNode(node->getStringValue("property", ""), true);
118 SGPropertyNode *condition = node->getChild("condition");
119 if (condition != NULL)
120 _condition = sgReadCondition(root, 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 < SGXmlSound::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 = root->getNode(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; __sound_fn[j].fn; j++)
154 if ( !strcmp(type_str, __sound_fn[j].name) ) {
155 volume.fn = __sound_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);
180 float reference_dist = node->getDoubleValue("reference-dist", 500.0);
181 float max_dist = node->getDoubleValue("max-dist", 3000.0);
184 // set pitch properties
187 kids = node->getChildren("pitch");
188 for (i = 0; (i < kids.size()) && (i < SGXmlSound::MAXPROP); i++) {
189 _snd_prop pitch = {NULL, NULL, NULL, 1.0, 1.0, 0.0, 0.0, false};
191 if (strcmp(kids[i]->getStringValue("property", ""), ""))
192 pitch.prop = root->getNode(kids[i]->getStringValue("property", ""), true);
194 const char *intern_str = kids[i]->getStringValue("internal", "");
195 if (!strcmp(intern_str, "dt_play"))
196 pitch.intern = &_dt_play;
197 else if (!strcmp(intern_str, "dt_stop"))
198 pitch.intern = &_dt_stop;
200 if ((pitch.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
201 if (pitch.factor < 0.0) {
202 pitch.factor = -pitch.factor;
203 pitch.subtract = true;
206 const char *type_str = kids[i]->getStringValue("type", "");
207 if ( strcmp(type_str, "") ) {
209 for (int j=0; __sound_fn[j].fn; j++)
210 if ( !strcmp(type_str, __sound_fn[j].name) ) {
211 pitch.fn = __sound_fn[j].fn;
216 SG_LOG(SG_GENERAL,SG_INFO,
217 " Unknown pitch type, default to 'lin'");
220 pitch.offset = kids[i]->getDoubleValue("offset", 1.0);
222 if ((pitch.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
223 SG_LOG(SG_GENERAL,SG_WARN,
224 " Pitch minimum value below 0. Forced to 0.");
226 pitch.max = kids[i]->getDoubleValue("max", 0.0);
227 if (pitch.max && (pitch.max < pitch.min) )
228 SG_LOG(SG_GENERAL,SG_ALERT,
229 " Pitch maximum below minimum. Neglected");
231 _pitch.push_back(pitch);
239 sgSetVec3( offset_pos, 0.0, 0.0, 0.0 );
240 SGPropertyNode_ptr pos = node->getChild("position");
242 offset_pos[0] = pos->getDoubleValue("x", 0.0);
243 offset_pos[1] = pos->getDoubleValue("y", 0.0);
244 offset_pos[2] = pos->getDoubleValue("z", 0.0);
251 float inner, outer, outer_gain;
252 sgSetVec3( dir, 0.0, 0.0, 0.0 );
253 inner = outer = 360.0;
255 pos = node->getChild("orientation");
257 dir[0] = pos->getDoubleValue("x", 0.0);
258 dir[1] = pos->getDoubleValue("y", 0.0);
259 dir[2] = pos->getDoubleValue("z", 0.0);
260 inner = pos->getDoubleValue("inner-angle", 360.0);
261 outer = pos->getDoubleValue("outer-angle", 360.0);
262 outer_gain = pos->getDoubleValue("outer-gain", 0.0);
267 // Initialize the sample
270 if ( (_sample = _mgr->find(_name)) == NULL ) {
271 _sample = new SGSoundSample( path.c_str(),
272 node->getStringValue("path", ""),
275 _mgr->add( _sample, _name );
278 _sample->set_offset_pos( offset_pos );
279 _sample->set_orientation(dir, inner, outer, outer_gain);
280 _sample->set_volume(v);
281 _sample->set_reference_dist( reference_dist );
282 _sample->set_max_dist( max_dist );
283 _sample->set_pitch(p);
287 SGXmlSound::update (double dt)
289 double curr_value = 0.0;
292 // If the state changes to false, stop playing.
295 curr_value = _property->getDoubleValue();
297 if ( // Lisp, anyone?
298 (_condition && !_condition->test()) ||
299 (!_condition && _property &&
302 ( (_mode == SGXmlSound::IN_TRANSIT) && (curr_value == _prev_value) )
307 if ((_mode != SGXmlSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME)) {
308 if (_sample->is_playing()) {
309 SG_LOG(SG_GENERAL, SG_INFO, "Stopping audio after " << _dt_play
310 << " sec: " << _name );
326 // If the mode is ONCE and the sound is still playing,
327 // we have nothing to do anymore.
329 if (_active && (_mode == SGXmlSound::ONCE)) {
331 if (!_sample->is_playing()) {
342 // Update the playing time, cache the current value and
343 // clear the delay timer.
346 _prev_value = curr_value;
353 int max = _volume.size();
355 double volume_offset = 0.0;
357 for(i = 0; i < max; i++) {
361 v = _volume[i].prop->getDoubleValue();
363 else if (_volume[i].intern)
364 v = *_volume[i].intern;
367 v = _volume[i].fn(v);
369 v *= _volume[i].factor;
371 if (_volume[i].max && (v > _volume[i].max))
374 else if (v < _volume[i].min)
377 if (_volume[i].subtract) // Hack!
378 volume = _volume[i].offset - v;
381 volume_offset += _volume[i].offset;
391 double pitch_offset = 0.0;
393 for(i = 0; i < max; i++) {
397 p = _pitch[i].prop->getDoubleValue();
399 else if (_pitch[i].intern)
400 p = *_pitch[i].intern;
405 p *= _pitch[i].factor;
407 if (_pitch[i].max && (p > _pitch[i].max))
410 else if (p < _pitch[i].min)
413 if (_pitch[i].subtract) // Hack!
414 pitch = _pitch[i].offset - p;
417 pitch_offset += _pitch[i].offset;
423 // Change sample state
425 _sample->set_pitch( pitch_offset + pitch );
426 if ((volume_offset + volume ) > 1.0)
428 _sample->set_volume( 1.0 );
429 SG_LOG(SG_GENERAL, SG_WARN,
430 "Volume larger than 1.0 in configuration for '" << _name
433 _sample->set_volume( volume_offset + volume );
437 // Do we need to start playing the sample?
441 if (_mode == SGXmlSound::ONCE)
442 _sample->play(false);
447 SG_LOG(SG_GENERAL, SG_INFO, "Playing audio after " << _dt_stop
448 << " sec: " << _name);
449 SG_LOG(SG_GENERAL, SG_BULK,
450 "Playing " << ((_mode == ONCE) ? "once" : "looped"));