// Started by Erik Hofman, February 2002
// (Reuses some code from fg_fx.cxx created by David Megginson)
//
-// Copyright (C) 2002 Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 2002 Curtis L. Olson - http://www.flightgear.org/~curt
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// $Id$
+#ifdef HAVE_CONFIG_H
+# include <simgear_config.h>
+#endif
+
#include <simgear/compiler.h>
-#ifdef SG_HAVE_STD_INCLUDES
-# include <cmath>
-#else
-# include <math.h>
-#endif
#include <string.h>
#include <simgear/debug/logstream.hxx>
#include <simgear/props/condition.hxx>
-#include <simgear/math/fastmath.hxx>
-
+#include <simgear/math/SGMath.hxx>
+#include <simgear/structure/exception.hxx>
+#include <simgear/misc/sg_path.hxx>
#include "xmlsound.hxx"
// static double _snd_lin(double v) { return v; }
static double _snd_inv(double v) { return (v == 0) ? 1e99 : 1/v; }
static double _snd_abs(double v) { return (v >= 0) ? v : -v; }
-static double _snd_sqrt(double v) { return (v < 0) ? sqrt(-v) : sqrt(v); }
-static double _snd_log10(double v) { return (v < 1) ? 0 : fast_log10(v); }
-static double _snd_log(double v) { return (v < 1) ? 0 : fast_log(v); }
+static double _snd_sqrt(double v) { return sqrt(fabs(v)); }
+static double _snd_log10(double v) { return log10(fabs(v)+1e-9); }
+static double _snd_log(double v) { return log(fabs(v)+1e-9); }
// static double _snd_sqr(double v) { return v*v; }
// static double _snd_pow3(double v) { return v*v*v; }
static const struct {
- char *name;
+ const char *name;
double (*fn)(double);
} __sound_fn[] = {
-// {"lin", _snd_lin},
{"inv", _snd_inv},
{"abs", _snd_abs},
{"sqrt", _snd_sqrt},
{"log", _snd_log10},
{"ln", _snd_log},
-// {"sqr", _snd_sqr},
-// {"pow3", _snd_pow3},
{"", NULL}
};
SGXmlSound::SGXmlSound()
: _sample(NULL),
- _condition(NULL),
- _property(NULL),
_active(false),
_name(""),
_mode(SGXmlSound::ONCE),
_prev_value(0),
_dt_play(0.0),
_dt_stop(0.0),
- _stopping(0.0)
+ _delay(0.0),
+ _stopping(0.0),
+ _initialized(false)
{
}
SGXmlSound::~SGXmlSound()
{
- _sample->stop();
-
- if (_property)
- delete _property;
-
- if (_condition)
- delete _condition;
+ if (_sample)
+ _sample->stop();
_volume.clear();
_pitch.clear();
- delete _sample;
}
void
-SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
- const string &path)
+SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node,
+ SGSampleGroup *sgrp, SGSampleGroup *avionics,
+ const SGPath& currentDir)
{
//
// set global sound properties
//
-
+
_name = node->getStringValue("name", "");
- SG_LOG(SG_GENERAL, SG_INFO, "Loading sound information for: " << _name );
+ SG_LOG(SG_GENERAL, SG_DEBUG, "Loading sound information for: " << _name );
- const char *mode_str = node->getStringValue("mode", "");
- if ( !strcmp(mode_str, "looped") ) {
+ string mode_str = node->getStringValue("mode", "");
+ if ( mode_str == "looped" ) {
_mode = SGXmlSound::LOOPED;
- } else if ( !strcmp(mode_str, "in-transit") ) {
+ } else if ( mode_str == "in-transit" ) {
_mode = SGXmlSound::IN_TRANSIT;
} else {
_mode = SGXmlSound::ONCE;
-
- if ( strcmp(mode_str, "") )
- SG_LOG(SG_GENERAL,SG_INFO, " Unknown sound mode, default to 'once'");
}
- _property = root->getNode(node->getStringValue("property", ""), true);
+ bool is_avionics = false;
+ string type_str = node->getStringValue("type", "fx");
+ if ( type_str == "avionics" )
+ is_avionics = true;
+
+ string propval = node->getStringValue("property", "");
+ if (propval != "")
+ _property = root->getNode(propval, true);
+
SGPropertyNode *condition = node->getChild("condition");
if (condition != NULL)
_condition = sgReadCondition(root, condition);
SG_LOG(SG_GENERAL, SG_WARN,
" Neither a condition nor a property specified");
+ _delay = node->getDoubleValue("delay-sec", 0.0);
+
//
// set volume properties
//
unsigned int i;
float v = 0.0;
- vector<SGPropertyNode_ptr> kids = node->getChildren("volume");
+ std::vector<SGPropertyNode_ptr> kids = node->getChildren("volume");
for (i = 0; (i < kids.size()) && (i < SGXmlSound::MAXPROP); i++) {
_snd_prop volume = {NULL, NULL, NULL, 1.0, 0.0, 0.0, 0.0, false};
- if (strcmp(kids[i]->getStringValue("property"), ""))
- volume.prop = root->getNode(kids[i]->getStringValue("property", ""), true);
+ propval = kids[i]->getStringValue("property", "");
+ if ( propval != "" )
+ volume.prop = root->getNode(propval, true);
- const char *intern_str = kids[i]->getStringValue("internal", "");
- if (!strcmp(intern_str, "dt_play"))
+ string intern_str = kids[i]->getStringValue("internal", "");
+ if (intern_str == "dt_play")
volume.intern = &_dt_play;
- else if (!strcmp(intern_str, "dt_stop"))
+ else if (intern_str == "dt_stop")
volume.intern = &_dt_stop;
if ((volume.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
volume.subtract = true;
}
- const char *type_str = kids[i]->getStringValue("type", "");
- if ( strcmp(type_str, "") ) {
+ string type_str = kids[i]->getStringValue("type", "");
+ if ( type_str != "" ) {
for (int j=0; __sound_fn[j].fn; j++)
- if ( !strcmp(type_str, __sound_fn[j].name) ) {
+ if ( type_str == __sound_fn[j].name ) {
volume.fn = __sound_fn[j].fn;
break;
}
}
- float reference_dist = node->getDoubleValue("reference-dist", 500.0);
- float max_dist = node->getDoubleValue("max-dist", 3000.0);
-
+ // rule of thumb: make reference distance a 100th of the maximum distance.
+ float reference_dist = node->getDoubleValue("reference-dist", 60.0);
+ float max_dist = node->getDoubleValue("max-dist", 6000.0);
+
//
// set pitch properties
//
for (i = 0; (i < kids.size()) && (i < SGXmlSound::MAXPROP); i++) {
_snd_prop pitch = {NULL, NULL, NULL, 1.0, 1.0, 0.0, 0.0, false};
- if (strcmp(kids[i]->getStringValue("property", ""), ""))
- pitch.prop = root->getNode(kids[i]->getStringValue("property", ""), true);
+ propval = kids[i]->getStringValue("property", "");
+ if (propval != "")
+ pitch.prop = root->getNode(propval, true);
- const char *intern_str = kids[i]->getStringValue("internal", "");
- if (!strcmp(intern_str, "dt_play"))
+ string intern_str = kids[i]->getStringValue("internal", "");
+ if (intern_str == "dt_play")
pitch.intern = &_dt_play;
- else if (!strcmp(intern_str, "dt_stop"))
+ else if (intern_str == "dt_stop")
pitch.intern = &_dt_stop;
if ((pitch.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
pitch.subtract = true;
}
- const char *type_str = kids[i]->getStringValue("type", "");
- if ( strcmp(type_str, "") ) {
+ string type_str = kids[i]->getStringValue("type", "");
+ if ( type_str != "" ) {
for (int j=0; __sound_fn[j].fn; j++)
- if ( !strcmp(type_str, __sound_fn[j].name) ) {
+ if ( type_str == __sound_fn[j].name ) {
pitch.fn = __sound_fn[j].fn;
break;
}
//
// Relative position
//
- sgVec3 offset_pos;
- sgSetVec3( offset_pos, 0.0, 0.0, 0.0 );
- SGPropertyNode_ptr pos = node->getChild("position");
- if ( pos != NULL ) {
- offset_pos[0] = pos->getDoubleValue("x", 0.0);
- offset_pos[1] = pos->getDoubleValue("y", 0.0);
- offset_pos[2] = pos->getDoubleValue("z", 0.0);
+ SGVec3f offset_pos = SGVec3f::zeros();
+ SGPropertyNode_ptr prop = node->getChild("position");
+ if ( prop != NULL ) {
+ offset_pos[0] = -prop->getDoubleValue("x", 0.0);
+ offset_pos[1] = -prop->getDoubleValue("y", 0.0);
+ offset_pos[2] = -prop->getDoubleValue("z", 0.0);
}
//
- // Initialize the sample
+ // Orientation
//
- _mgr = sndmgr;
- if ( (_sample = _mgr->find(_name)) == NULL ) {
- _sample = new SGSoundSample( path.c_str(),
- node->getStringValue("path", ""),
- true );
-
- _mgr->add( _sample, _name );
+ SGVec3f dir = SGVec3f::zeros();
+ float inner = 360.0;
+ float outer = 360.0;
+ float outer_gain = 0.0;
+ prop = node->getChild("orientation");
+ if ( prop != NULL ) {
+ dir = SGVec3f(-prop->getFloatValue("x", 0.0),
+ -prop->getFloatValue("y", 0.0),
+ -prop->getFloatValue("z", 0.0));
+ inner = prop->getFloatValue("inner-angle", 360.0);
+ outer = prop->getFloatValue("outer-angle", 360.0);
+ outer_gain = prop->getFloatValue("outer-gain", 0.0);
}
- _sample->set_offset_pos( offset_pos );
- _sample->set_volume(v);
+ //
+ // Initialize the sample
+ //
+ if (is_avionics) {
+ _sgrp = avionics;
+ } else {
+ _sgrp = sgrp;
+ }
+ string soundFileStr = node->getStringValue("path", "");
+ _sample = new SGSoundSample(soundFileStr.c_str(), currentDir);
+ if (!_sample->file_path().exists()) {
+ throw sg_io_exception("XML sound: couldn't find file: '" + soundFileStr + "'");
+ }
+
+ _sample->set_relative_position( offset_pos );
+ _sample->set_direction( dir );
+ _sample->set_audio_cone( inner, outer, outer_gain );
_sample->set_reference_dist( reference_dist );
_sample->set_max_dist( max_dist );
- _sample->set_pitch(p);
+ _sample->set_volume( v );
+ _sample->set_pitch( p );
+ _sgrp->add( _sample, _name );
}
void
if (_property)
curr_value = _property->getDoubleValue();
+ if (!_initialized)
+ {
+ // update initial value before detecting changes
+ _prev_value = curr_value;
+ _initialized = true;
+ }
+
+ // If a condition is defined, test whether it is FALSE,
+ // else
+ // if a property is defined then test if it's value is FALSE
+ // or if the mode is IN_TRANSIT then
+ // test whether the current value matches the previous value.
if ( // Lisp, anyone?
(_condition && !_condition->test()) ||
(!_condition && _property &&
)
)
{
- if ((_mode != SGXmlSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME)) {
+ if ((_mode != SGXmlSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME))
+ {
if (_sample->is_playing()) {
- SG_LOG(SG_GENERAL, SG_INFO, "Stopping audio after " << _dt_play
+ SG_LOG(SG_GENERAL, SG_DEBUG, "Stopping audio after " << _dt_play
<< " sec: " << _name );
_sample->stop();
}
//
- // If the mode is ONCE and the sound is still playing,
- // we have nothing to do anymore.
+ // mode is ONCE and the sound is still playing?
//
if (_active && (_mode == SGXmlSound::ONCE)) {
_dt_play += dt;
}
- return;
+ } else {
+
+ //
+ // Update the playing time, cache the current value and
+ // clear the delay timer.
+ //
+ _dt_play += dt;
+ _prev_value = curr_value;
+ _stopping = 0.0;
}
- //
- // Update the playing time, cache the current value and
- // clear the delay timer.
- //
- _dt_play += dt;
- _prev_value = curr_value;
- _stopping = 0.0;
+ if (_dt_play < _delay)
+ return;
//
// Update the volume
//
// Change sample state
//
+
+ double vol = volume_offset + volume;
+ if (vol > 1.0) {
+ SG_LOG(SG_GENERAL, SG_DEBUG, "Sound volume too large for '"
+ << _name << "': " << vol << " -> clipping to 1.0");
+ vol = 1.0;
+ }
+ _sample->set_volume(vol);
_sample->set_pitch( pitch_offset + pitch );
- _sample->set_volume( volume_offset + volume );
//
else
_sample->play(true);
- SG_LOG(SG_GENERAL, SG_INFO, "Playing audio after " << _dt_stop
+ SG_LOG(SG_GENERAL, SG_DEBUG, "Playing audio after " << _dt_stop
<< " sec: " << _name);
- SG_LOG(SG_GENERAL, SG_BULK,
+ SG_LOG(SG_GENERAL, SG_DEBUG,
"Playing " << ((_mode == ONCE) ? "once" : "looped"));
_active = true;
projects / simgear.git / blobdiff