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),
78 SGXmlSound::~SGXmlSound()
90 SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
95 // set global sound properties
98 _name = node->getStringValue("name", "");
99 SG_LOG(SG_GENERAL, SG_INFO, "Loading sound information for: " << _name );
101 const char *mode_str = node->getStringValue("mode", "");
102 if ( !strcmp(mode_str, "looped") ) {
103 _mode = SGXmlSound::LOOPED;
105 } else if ( !strcmp(mode_str, "in-transit") ) {
106 _mode = SGXmlSound::IN_TRANSIT;
109 _mode = SGXmlSound::ONCE;
111 if ( strcmp(mode_str, "") )
112 SG_LOG(SG_GENERAL,SG_INFO, " Unknown sound mode, default to 'once'");
115 _property = root->getNode(node->getStringValue("property", ""), true);
116 SGPropertyNode *condition = node->getChild("condition");
117 if (condition != NULL)
118 _condition = sgReadCondition(root, condition);
120 if (!_property && !_condition)
121 SG_LOG(SG_GENERAL, SG_WARN,
122 " Neither a condition nor a property specified");
124 _delay = node->getDoubleValue("delay-sec", 0.0);
127 // set volume properties
131 std::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);
266 // Initialize the sample
269 if ( (_sample = _mgr->find(_name)) == NULL ) {
270 // FIXME: Does it make sense to overwrite a previous entry's
271 // configuration just because a new entry has the same name?
272 // Note that we can't match on identical "path" because we the
273 // new entry could be at a different location with different
274 // configuration so we need a new sample which creates a new
275 // "alSource". The semantics of what is going on here seems
276 // confused and needs to be thought through more carefully.
277 _sample = new SGSoundSample( path.c_str(),
278 node->getStringValue("path", ""),
281 _mgr->add( _sample, _name );
284 _sample->set_offset_pos( offset_pos );
285 _sample->set_orientation(dir, inner, outer, outer_gain);
286 _sample->set_volume(v);
287 _sample->set_reference_dist( reference_dist );
288 _sample->set_max_dist( max_dist );
289 _sample->set_pitch(p);
293 SGXmlSound::update (double dt)
295 double curr_value = 0.0;
298 // If the state changes to false, stop playing.
301 curr_value = _property->getDoubleValue();
303 if ( // Lisp, anyone?
304 (_condition && !_condition->test()) ||
305 (!_condition && _property &&
308 ( (_mode == SGXmlSound::IN_TRANSIT) && (curr_value == _prev_value) )
313 if ((_mode != SGXmlSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME)) {
314 if (_sample->is_playing()) {
315 SG_LOG(SG_GENERAL, SG_INFO, "Stopping audio after " << _dt_play
316 << " sec: " << _name );
332 // mode is ONCE and the sound is still playing?
334 if (_active && (_mode == SGXmlSound::ONCE)) {
336 if (!_sample->is_playing()) {
346 // Update the playing time, cache the current value and
347 // clear the delay timer.
350 _prev_value = curr_value;
354 if (_dt_play < _delay)
361 int max = _volume.size();
363 double volume_offset = 0.0;
365 for(i = 0; i < max; i++) {
369 v = _volume[i].prop->getDoubleValue();
371 else if (_volume[i].intern)
372 v = *_volume[i].intern;
375 v = _volume[i].fn(v);
377 v *= _volume[i].factor;
379 if (_volume[i].max && (v > _volume[i].max))
382 else if (v < _volume[i].min)
385 if (_volume[i].subtract) // Hack!
386 volume = _volume[i].offset - v;
389 volume_offset += _volume[i].offset;
399 double pitch_offset = 0.0;
401 for(i = 0; i < max; i++) {
405 p = _pitch[i].prop->getDoubleValue();
407 else if (_pitch[i].intern)
408 p = *_pitch[i].intern;
413 p *= _pitch[i].factor;
415 if (_pitch[i].max && (p > _pitch[i].max))
418 else if (p < _pitch[i].min)
421 if (_pitch[i].subtract) // Hack!
422 pitch = _pitch[i].offset - p;
425 pitch_offset += _pitch[i].offset;
431 // Change sample state
434 double vol = volume_offset + volume;
436 SG_LOG(SG_GENERAL, SG_WARN, "Sound volume too large for '"
437 << _name << "': " << vol << " -> clipping to 1.0");
440 _sample->set_volume(vol);
441 _sample->set_pitch( pitch_offset + pitch );
445 // Do we need to start playing the sample?
449 if (_mode == SGXmlSound::ONCE)
450 _sample->play(false);
455 SG_LOG(SG_GENERAL, SG_INFO, "Playing audio after " << _dt_stop
456 << " sec: " << _name);
457 SG_LOG(SG_GENERAL, SG_BULK,
458 "Playing " << ((_mode == ONCE) ? "once" : "looped"));