]> git.mxchange.org Git - simgear.git/blobdiff - simgear/sound/xmlsound.cxx
#348: (continued) Missing sound files not reported properly
[simgear.git] / simgear / sound / xmlsound.cxx
index 18850f84b866a1fc38a7bb7e788be45cc6eb6358..3e90752ea3f8e9f7a7a6f7bb7993152b336aaf0a 100644 (file)
@@ -32,7 +32,8 @@
 #include <simgear/debug/logstream.hxx>
 #include <simgear/props/condition.hxx>
 #include <simgear/math/SGMath.hxx>
-
+#include <simgear/structure/exception.hxx>
+#include <simgear/misc/sg_path.hxx>
 
 #include "xmlsound.hxx"
 
@@ -41,8 +42,8 @@
 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 sqrt(fabs(v)); }
-static double _snd_log10(double v) { return log10(fabs(v)); }
-static double _snd_log(double v)   { return log(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; }
 
@@ -50,20 +51,16 @@ static const struct {
        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),
     _active(false),
     _name(""),
     _mode(SGXmlSound::ONCE),
@@ -71,7 +68,8 @@ SGXmlSound::SGXmlSound()
     _dt_play(0.0),
     _dt_stop(0.0),
     _delay(0.0),
-    _stopping(0.0)
+    _stopping(0.0),
+    _initialized(false)
 {
 }
 
@@ -80,39 +78,43 @@ SGXmlSound::~SGXmlSound()
     if (_sample)
         _sample->stop();
 
-    delete _condition;
-
     _volume.clear();
     _pitch.clear();
 }
 
 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);
@@ -132,13 +134,14 @@ SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
    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)
@@ -147,11 +150,11 @@ SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
             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;
             }
@@ -177,9 +180,10 @@ SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
 
    }
 
-   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
    //
@@ -188,13 +192,14 @@ SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
    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)
@@ -203,11 +208,11 @@ SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
             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;
             }
@@ -235,58 +240,53 @@ SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node, SGSoundMgr *sndmgr,
    //
    // 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);
    }
 
    //
    // Orientation
    //
-   sgVec3 dir;
-   float inner, outer, outer_gain;
-   sgSetVec3( dir, 0.0, 0.0, 0.0 );
-   inner = outer = 360.0;
-   outer_gain = 0.0;
-   pos = node->getChild("orientation");
-   if ( pos != NULL ) {
-      dir[0] = pos->getDoubleValue("x", 0.0);
-      dir[1] = -pos->getDoubleValue("y", 0.0);
-      dir[2] = pos->getDoubleValue("z", 0.0);
-      inner = pos->getDoubleValue("inner-angle", 360.0);
-      outer = pos->getDoubleValue("outer-angle", 360.0);
-      outer_gain = pos->getDoubleValue("outer-gain", 0.0);
+   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);
    }
-   
+
    //
    // Initialize the sample
    //
-   _mgr = sndmgr;
-   if ( (_sample = _mgr->find(_name)) == NULL ) {
-       // FIXME: Does it make sense to overwrite a previous entry's
-       // configuration just because a new entry has the same name?
-       // Note that we can't match on identical "path" because we the
-       // new entry could be at a different location with different
-       // configuration so we need a new sample which creates a new
-       // "alSource".  The semantics of what is going on here seems
-       // confused and needs to be thought through more carefully.
-        _sample = new SGSoundSample( path.c_str(),
-                                    node->getStringValue("path", ""),
-                                    false );
-
-       _mgr->add( _sample, _name );
+   if (is_avionics) {
+      _sgrp = avionics;
+   } else {
+      _sgrp = sgrp;
    }
-
-   _sample->set_offset_pos( offset_pos );
-   _sample->set_orientation(dir, inner, outer, outer_gain);
-   _sample->set_volume(v);
+   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
@@ -300,6 +300,18 @@ SGXmlSound::update (double dt)
    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 &&
@@ -310,9 +322,10 @@ SGXmlSound::update (double dt)
         )
        )
    {
-       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();
@@ -433,7 +446,7 @@ SGXmlSound::update (double dt)
 
    double vol = volume_offset + volume;
    if (vol > 1.0) {
-      SG_LOG(SG_GENERAL, SG_WARN, "Sound volume too large for '"
+      SG_LOG(SG_GENERAL, SG_DEBUG, "Sound volume too large for '"
               << _name << "':  " << vol << "  ->  clipping to 1.0");
       vol = 1.0;
    }
@@ -452,9 +465,9 @@ SGXmlSound::update (double dt)
       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;