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; }
61 SGXmlSound::SGXmlSound()
65 _mode(SGXmlSound::ONCE),
74 SGXmlSound::~SGXmlSound()
84 SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node,
85 SGSampleGroup *sgrp, const string &path)
89 // set global sound properties
92 _name = node->getStringValue("name", "");
93 SG_LOG(SG_GENERAL, SG_DEBUG, "Loading sound information for: " << _name );
95 const char *mode_str = node->getStringValue("mode", "");
96 if ( !strcmp(mode_str, "looped") ) {
97 _mode = SGXmlSound::LOOPED;
99 } else if ( !strcmp(mode_str, "in-transit") ) {
100 _mode = SGXmlSound::IN_TRANSIT;
103 _mode = SGXmlSound::ONCE;
105 if ( strcmp(mode_str, "") )
106 SG_LOG(SG_GENERAL,SG_INFO, "Unknown sound mode for '" << _name << "', default to 'once'");
109 _property = root->getNode(node->getStringValue("property", ""), true);
110 SGPropertyNode *condition = node->getChild("condition");
111 if (condition != NULL)
112 _condition = sgReadCondition(root, condition);
114 if (!_property && !_condition)
115 SG_LOG(SG_GENERAL, SG_WARN,
116 " Neither a condition nor a property specified");
118 _delay = node->getDoubleValue("delay-sec", 0.0);
121 // set volume properties
125 std::vector<SGPropertyNode_ptr> kids = node->getChildren("volume");
126 for (i = 0; (i < kids.size()) && (i < SGXmlSound::MAXPROP); i++) {
127 _snd_prop volume = {NULL, NULL, NULL, 1.0, 0.0, 0.0, 0.0, false};
129 if (strcmp(kids[i]->getStringValue("property"), ""))
130 volume.prop = root->getNode(kids[i]->getStringValue("property", ""), true);
132 const char *intern_str = kids[i]->getStringValue("internal", "");
133 if (!strcmp(intern_str, "dt_play"))
134 volume.intern = &_dt_play;
135 else if (!strcmp(intern_str, "dt_stop"))
136 volume.intern = &_dt_stop;
138 if ((volume.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
139 if (volume.factor < 0.0) {
140 volume.factor = -volume.factor;
141 volume.subtract = true;
144 const char *type_str = kids[i]->getStringValue("type", "");
145 if ( strcmp(type_str, "") ) {
147 for (int j=0; __sound_fn[j].fn; j++)
148 if ( !strcmp(type_str, __sound_fn[j].name) ) {
149 volume.fn = __sound_fn[j].fn;
154 SG_LOG(SG_GENERAL,SG_INFO,
155 " Unknown volume type, default to 'lin'");
158 volume.offset = kids[i]->getDoubleValue("offset", 0.0);
160 if ((volume.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
161 SG_LOG( SG_GENERAL, SG_WARN,
162 "Volume minimum value below 0. Forced to 0.");
164 volume.max = kids[i]->getDoubleValue("max", 0.0);
165 if (volume.max && (volume.max < volume.min) )
166 SG_LOG(SG_GENERAL,SG_ALERT,
167 " Volume maximum below minimum. Neglected.");
169 _volume.push_back(volume);
174 float reference_dist = node->getDoubleValue("reference-dist", 500.0);
175 float max_dist = node->getDoubleValue("max-dist", 3000.0);
178 // set pitch properties
181 kids = node->getChildren("pitch");
182 for (i = 0; (i < kids.size()) && (i < SGXmlSound::MAXPROP); i++) {
183 _snd_prop pitch = {NULL, NULL, NULL, 1.0, 1.0, 0.0, 0.0, false};
185 if (strcmp(kids[i]->getStringValue("property", ""), ""))
186 pitch.prop = root->getNode(kids[i]->getStringValue("property", ""), true);
188 const char *intern_str = kids[i]->getStringValue("internal", "");
189 if (!strcmp(intern_str, "dt_play"))
190 pitch.intern = &_dt_play;
191 else if (!strcmp(intern_str, "dt_stop"))
192 pitch.intern = &_dt_stop;
194 if ((pitch.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
195 if (pitch.factor < 0.0) {
196 pitch.factor = -pitch.factor;
197 pitch.subtract = true;
200 const char *type_str = kids[i]->getStringValue("type", "");
201 if ( strcmp(type_str, "") ) {
203 for (int j=0; __sound_fn[j].fn; j++)
204 if ( !strcmp(type_str, __sound_fn[j].name) ) {
205 pitch.fn = __sound_fn[j].fn;
210 SG_LOG(SG_GENERAL,SG_INFO,
211 " Unknown pitch type, default to 'lin'");
214 pitch.offset = kids[i]->getDoubleValue("offset", 1.0);
216 if ((pitch.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
217 SG_LOG(SG_GENERAL,SG_WARN,
218 " Pitch minimum value below 0. Forced to 0.");
220 pitch.max = kids[i]->getDoubleValue("max", 0.0);
221 if (pitch.max && (pitch.max < pitch.min) )
222 SG_LOG(SG_GENERAL,SG_ALERT,
223 " Pitch maximum below minimum. Neglected");
225 _pitch.push_back(pitch);
232 SGVec3f offset_pos = SGVec3f::zeros();
233 SGPropertyNode_ptr pos = node->getChild("position");
235 offset_pos[0] = pos->getDoubleValue("x", 0.0);
236 offset_pos[1] = -pos->getDoubleValue("y", 0.0);
237 offset_pos[2] = pos->getDoubleValue("z", 0.0);
243 SGVec3f dir = SGVec3f::zeros();
244 float inner, outer, outer_gain;
245 inner = outer = 360.0;
247 pos = node->getChild("orientation");
249 dir[0] = pos->getDoubleValue("x", 0.0);
250 dir[1] = -pos->getDoubleValue("y", 0.0);
251 dir[2] = pos->getDoubleValue("z", 0.0);
252 inner = pos->getDoubleValue("inner-angle", 360.0);
253 outer = pos->getDoubleValue("outer-angle", 360.0);
254 outer_gain = pos->getDoubleValue("outer-gain", 0.0);
258 // Initialize the sample
261 if ( (_sample = _sgrp->find(_name)) == NULL ) {
262 // FIXME: Does it make sense to overwrite a previous entry's
263 // configuration just because a new entry has the same name?
264 // Note that we can't match on identical "path" because we the
265 // new entry could be at a different location with different
266 // configuration so we need a new sample which creates a new
267 // "alSource". The semantics of what is going on here seems
268 // confused and needs to be thought through more carefully.
269 _sample = new SGSoundSample( path.c_str(),
270 node->getStringValue("path", "") );
271 _sgrp->add( _sample, _name );
274 _sample->set_relative_position( offset_pos );
275 _sample->set_orientation( dir );
276 _sample->set_audio_cone(inner, outer, outer_gain);
277 _sample->set_reference_dist( reference_dist );
278 _sample->set_max_dist( max_dist );
279 _sample->set_volume(v);
280 _sample->set_pitch(p);
284 SGXmlSound::update (double dt)
286 double curr_value = 0.0;
289 // If the state changes to false, stop playing.
292 curr_value = _property->getDoubleValue();
294 // If a condition is defined, test whether it is FALSE,
296 // if a property is defined then test if it's value is FALSE
297 // or if the mode is IN_TRANSIT then
298 // test whether the current value matches the previous value.
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))
311 if (_sample->is_playing()) {
312 SG_LOG(SG_GENERAL, SG_DEBUG, "Stopping audio after " << _dt_play
313 << " sec: " << _name );
329 // mode is ONCE and the sound is still playing?
331 if (_active && (_mode == SGXmlSound::ONCE)) {
333 if (!_sample->is_playing()) {
343 // Update the playing time, cache the current value and
344 // clear the delay timer.
347 _prev_value = curr_value;
351 if (_dt_play < _delay)
358 int max = _volume.size();
360 double volume_offset = 0.0;
362 for(i = 0; i < max; i++) {
366 v = _volume[i].prop->getDoubleValue();
368 else if (_volume[i].intern)
369 v = *_volume[i].intern;
372 v = _volume[i].fn(v);
374 v *= _volume[i].factor;
376 if (_volume[i].max && (v > _volume[i].max))
379 else if (v < _volume[i].min)
382 if (_volume[i].subtract) // Hack!
383 volume = _volume[i].offset - v;
386 volume_offset += _volume[i].offset;
396 double pitch_offset = 0.0;
398 for(i = 0; i < max; i++) {
402 p = _pitch[i].prop->getDoubleValue();
404 else if (_pitch[i].intern)
405 p = *_pitch[i].intern;
410 p *= _pitch[i].factor;
412 if (_pitch[i].max && (p > _pitch[i].max))
415 else if (p < _pitch[i].min)
418 if (_pitch[i].subtract) // Hack!
419 pitch = _pitch[i].offset - p;
422 pitch_offset += _pitch[i].offset;
428 // Change sample state
431 double vol = volume_offset + volume;
433 SG_LOG(SG_GENERAL, SG_DEBUG, "Sound volume too large for '"
434 << _name << "': " << vol << " -> clipping to 1.0");
437 _sample->set_volume(vol);
438 _sample->set_pitch( pitch_offset + pitch );
442 // Do we need to start playing the sample?
446 if (_mode == SGXmlSound::ONCE)
447 _sample->play(false);
452 SG_LOG(SG_GENERAL, SG_DEBUG, "Playing audio after " << _dt_stop
453 << " sec: " << _name);
454 SG_LOG(SG_GENERAL, SG_DEBUG,
455 "Playing " << ((_mode == ONCE) ? "once" : "looped"));