simgear/sound/xmlsound.cxx

   1 // sound.cxx -- Sound class implementation
   2 //
   3 // Started by Erik Hofman, February 2002
   4 // (Reuses some code from  fg_fx.cxx created by David Megginson)
   5 //
   6 // Copyright (C) 2002  Curtis L. Olson - http://www.flightgear.org/~curt
   7 //
   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.
  12 //
  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.
  17 //
  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.
  21 //
  22 // $Id$
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <simgear_config.h>
  26 #endif
  27
  28 #include <simgear/compiler.h>
  29
  30 #include <string.h>
  31
  32 #include <simgear/debug/logstream.hxx>
  33 #include <simgear/props/condition.hxx>
  34 #include <simgear/math/SGMath.hxx>
  35
  36
  37 #include "xmlsound.hxx"
  38
  39
  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)+1e-9); }
  45 static double _snd_log(double v)   { return log(fabs(v)+1e-9); }
  46 // static double _snd_sqr(double v)   { return v*v; }
  47 // static double _snd_pow3(double v)  { return v*v*v; }
  48
  49 static const struct {
  50         const char *name;
  51         double (*fn)(double);
  52 } __sound_fn[] = {
  53         {"inv", _snd_inv},
  54         {"abs", _snd_abs},
  55         {"sqrt", _snd_sqrt},
  56         {"log", _snd_log10},
  57         {"ln", _snd_log},
  58         {"", NULL}
  59 };
  60
  61 SGXmlSound::SGXmlSound()
  62   : _sample(NULL),
  63     _active(false),
  64     _name(""),
  65     _mode(SGXmlSound::ONCE),
  66     _prev_value(0),
  67     _dt_play(0.0),
  68     _dt_stop(0.0),
  69     _delay(0.0),
  70     _stopping(0.0)
  71 {
  72 }
  73
  74 SGXmlSound::~SGXmlSound()
  75 {
  76     if (_sample)
  77         _sample->stop();
  78
  79     _volume.clear();
  80     _pitch.clear();
  81 }
  82
  83 void
  84 SGXmlSound::init(SGPropertyNode *root, SGPropertyNode *node,
  85                  SGSampleGroup *sgrp, SGSampleGroup *avionics,
  86                  const string &path)
  87 {
  88
  89    //
  90    // set global sound properties
  91    //
  92
  93    _name = node->getStringValue("name", "");
  94    SG_LOG(SG_GENERAL, SG_DEBUG, "Loading sound information for: " << _name );
  95
  96    const char *mode_str = node->getStringValue("mode", "");
  97    if ( !strcmp(mode_str, "looped") ) {
  98        _mode = SGXmlSound::LOOPED;
  99
 100    } else if ( !strcmp(mode_str, "in-transit") ) {
 101        _mode = SGXmlSound::IN_TRANSIT;
 102
 103    } else {
 104       _mode = SGXmlSound::ONCE;
 105    }
 106
 107    bool is_avionics = false;
 108    const char *type_str = node->getStringValue("type", "fx");
 109    if ( !strcmp(type_str, "avionics") )
 110       is_avionics = true;
 111
 112    _property = root->getNode(node->getStringValue("property", ""), true);
 113    SGPropertyNode *condition = node->getChild("condition");
 114    if (condition != NULL)
 115       _condition = sgReadCondition(root, condition);
 116
 117    if (!_property && !_condition)
 118       SG_LOG(SG_GENERAL, SG_WARN,
 119              "  Neither a condition nor a property specified");
 120
 121    _delay = node->getDoubleValue("delay-sec", 0.0);
 122
 123    //
 124    // set volume properties
 125    //
 126    unsigned int i;
 127    float v = 0.0;
 128    std::vector<SGPropertyNode_ptr> kids = node->getChildren("volume");
 129    for (i = 0; (i < kids.size()) && (i < SGXmlSound::MAXPROP); i++) {
 130       _snd_prop volume = {NULL, NULL, NULL, 1.0, 0.0, 0.0, 0.0, false};
 131
 132       if (strcmp(kids[i]->getStringValue("property"), ""))
 133          volume.prop = root->getNode(kids[i]->getStringValue("property", ""), true);
 134
 135       const char *intern_str = kids[i]->getStringValue("internal", "");
 136       if (!strcmp(intern_str, "dt_play"))
 137          volume.intern = &_dt_play;
 138       else if (!strcmp(intern_str, "dt_stop"))
 139          volume.intern = &_dt_stop;
 140
 141       if ((volume.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
 142          if (volume.factor < 0.0) {
 143             volume.factor = -volume.factor;
 144             volume.subtract = true;
 145          }
 146
 147       const char *type_str = kids[i]->getStringValue("type", "");
 148       if ( strcmp(type_str, "") ) {
 149
 150          for (int j=0; __sound_fn[j].fn; j++)
 151            if ( !strcmp(type_str, __sound_fn[j].name) ) {
 152                volume.fn = __sound_fn[j].fn;
 153                break;
 154             }
 155
 156          if (!volume.fn)
 157             SG_LOG(SG_GENERAL,SG_INFO,
 158                    "  Unknown volume type, default to 'lin'");
 159       }
 160
 161       volume.offset = kids[i]->getDoubleValue("offset", 0.0);
 162
 163       if ((volume.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
 164          SG_LOG( SG_GENERAL, SG_WARN,
 165           "Volume minimum value below 0. Forced to 0.");
 166
 167       volume.max = kids[i]->getDoubleValue("max", 0.0);
 168       if (volume.max && (volume.max < volume.min) )
 169          SG_LOG(SG_GENERAL,SG_ALERT,
 170                 "  Volume maximum below minimum. Neglected.");
 171
 172       _volume.push_back(volume);
 173       v += volume.offset;
 174
 175    }
 176
 177    // rule of thumb: make reference distance a 100th of the maximum distance.
 178    float reference_dist = node->getDoubleValue("reference-dist", 60.0);
 179    float max_dist = node->getDoubleValue("max-dist", 6000.0);
 180
 181    //
 182    // set pitch properties
 183    //
 184    float p = 0.0;
 185    kids = node->getChildren("pitch");
 186    for (i = 0; (i < kids.size()) && (i < SGXmlSound::MAXPROP); i++) {
 187       _snd_prop pitch = {NULL, NULL, NULL, 1.0, 1.0, 0.0, 0.0, false};
 188
 189       if (strcmp(kids[i]->getStringValue("property", ""), ""))
 190          pitch.prop = root->getNode(kids[i]->getStringValue("property", ""), true);
 191
 192       const char *intern_str = kids[i]->getStringValue("internal", "");
 193       if (!strcmp(intern_str, "dt_play"))
 194          pitch.intern = &_dt_play;
 195       else if (!strcmp(intern_str, "dt_stop"))
 196          pitch.intern = &_dt_stop;
 197
 198       if ((pitch.factor = kids[i]->getDoubleValue("factor", 1.0)) != 0.0)
 199          if (pitch.factor < 0.0) {
 200             pitch.factor = -pitch.factor;
 201             pitch.subtract = true;
 202          }
 203
 204       const char *type_str = kids[i]->getStringValue("type", "");
 205       if ( strcmp(type_str, "") ) {
 206
 207          for (int j=0; __sound_fn[j].fn; j++)
 208             if ( !strcmp(type_str, __sound_fn[j].name) ) {
 209                pitch.fn = __sound_fn[j].fn;
 210                break;
 211             }
 212
 213          if (!pitch.fn)
 214             SG_LOG(SG_GENERAL,SG_INFO,
 215                    "  Unknown pitch type, default to 'lin'");
 216       }
 217
 218       pitch.offset = kids[i]->getDoubleValue("offset", 1.0);
 219
 220       if ((pitch.min = kids[i]->getDoubleValue("min", 0.0)) < 0.0)
 221          SG_LOG(SG_GENERAL,SG_WARN,
 222                 "  Pitch minimum value below 0. Forced to 0.");
 223
 224       pitch.max = kids[i]->getDoubleValue("max", 0.0);
 225       if (pitch.max && (pitch.max < pitch.min) )
 226          SG_LOG(SG_GENERAL,SG_ALERT,
 227                 "  Pitch maximum below minimum. Neglected");
 228
 229       _pitch.push_back(pitch);
 230       p += pitch.offset;
 231    }
 232
 233    //
 234    // Relative position
 235    //
 236    SGVec3f offset_pos = SGVec3f::zeros();
 237    SGPropertyNode_ptr prop = node->getChild("position");
 238    if ( prop != NULL ) {
 239        offset_pos[0] = -prop->getDoubleValue("x", 0.0);
 240        offset_pos[1] = -prop->getDoubleValue("y", 0.0);
 241        offset_pos[2] = -prop->getDoubleValue("z", 0.0);
 242    }
 243
 244    //
 245    // Orientation
 246    //
 247    SGVec3f dir = SGVec3f::zeros();
 248    float inner = 360.0;
 249    float outer = 360.0;
 250    float outer_gain = 0.0;
 251    prop = node->getChild("orientation");
 252    if ( prop != NULL ) {
 253       dir = SGVec3f(-prop->getFloatValue("x", 0.0),
 254                     -prop->getFloatValue("y", 0.0),
 255                     -prop->getFloatValue("z", 0.0));
 256       inner = prop->getFloatValue("inner-angle", 360.0);
 257       outer = prop->getFloatValue("outer-angle", 360.0);
 258       outer_gain = prop->getFloatValue("outer-gain", 0.0);
 259    }
 260
 261    //
 262    // Initialize the sample
 263    //
 264    if (is_avionics) {
 265       _sgrp = avionics;
 266    } else {
 267       _sgrp = sgrp;
 268    }
 269    _sample = new SGSoundSample( path.c_str(), node->getStringValue("path", ""));
 270    _sample->set_relative_position( offset_pos );
 271    _sample->set_direction( dir );
 272    _sample->set_audio_cone( inner, outer, outer_gain );
 273    _sample->set_reference_dist( reference_dist );
 274    _sample->set_max_dist( max_dist );
 275    _sample->set_volume( v );
 276    _sample->set_pitch( p );
 277    _sgrp->add( _sample, _name );
 278 }
 279
 280 void
 281 SGXmlSound::update (double dt)
 282 {
 283    double curr_value = 0.0;
 284
 285    //
 286    // If the state changes to false, stop playing.
 287    //
 288    if (_property)
 289        curr_value = _property->getDoubleValue();
 290
 291    // If a condition is defined, test whether it is FALSE,
 292    // else
 293    //   if a property is defined then test if it's value is FALSE
 294    //      or if the mode is IN_TRANSIT then
 295    //            test whether the current value matches the previous value.
 296    if (                                                 // Lisp, anyone?
 297        (_condition && !_condition->test()) ||
 298        (!_condition && _property &&
 299         (
 300          !curr_value ||
 301          ( (_mode == SGXmlSound::IN_TRANSIT) && (curr_value == _prev_value) )
 302          )
 303         )
 304        )
 305    {
 306        if ((_mode != SGXmlSound::IN_TRANSIT) || (_stopping > MAX_TRANSIT_TIME))
 307        {
 308            if (_sample->is_playing()) {
 309                SG_LOG(SG_GENERAL, SG_DEBUG, "Stopping audio after " << _dt_play
 310                       << " sec: " << _name );
 311
 312                _sample->stop();
 313            }
 314
 315            _active = false;
 316            _dt_stop += dt;
 317            _dt_play = 0.0;
 318        } else {
 319            _stopping += dt;
 320        }
 321
 322        return;
 323    }
 324
 325    //
 326    // mode is ONCE and the sound is still playing?
 327    //
 328    if (_active && (_mode == SGXmlSound::ONCE)) {
 329
 330       if (!_sample->is_playing()) {
 331          _dt_stop += dt;
 332          _dt_play = 0.0;
 333       } else {
 334          _dt_play += dt;
 335       }
 336
 337    } else {
 338
 339       //
 340       // Update the playing time, cache the current value and
 341       // clear the delay timer.
 342       //
 343       _dt_play += dt;
 344       _prev_value = curr_value;
 345       _stopping = 0.0;
 346    }
 347
 348    if (_dt_play < _delay)
 349       return;
 350
 351    //
 352    // Update the volume
 353    //
 354    int i;
 355    int max = _volume.size();
 356    double volume = 1.0;
 357    double volume_offset = 0.0;
 358
 359    for(i = 0; i < max; i++) {
 360       double v = 1.0;
 361
 362       if (_volume[i].prop)
 363          v = _volume[i].prop->getDoubleValue();
 364
 365       else if (_volume[i].intern)
 366          v = *_volume[i].intern;
 367
 368       if (_volume[i].fn)
 369          v = _volume[i].fn(v);
 370
 371       v *= _volume[i].factor;
 372
 373       if (_volume[i].max && (v > _volume[i].max))
 374          v = _volume[i].max;
 375
 376       else if (v < _volume[i].min)
 377          v = _volume[i].min;
 378
 379       if (_volume[i].subtract)                          // Hack!
 380          volume = _volume[i].offset - v;
 381
 382       else {
 383          volume_offset += _volume[i].offset;
 384          volume *= v;
 385       }
 386    }
 387
 388    //
 389    // Update the pitch
 390    //
 391    max = _pitch.size();
 392    double pitch = 1.0;
 393    double pitch_offset = 0.0;
 394
 395    for(i = 0; i < max; i++) {
 396       double p = 1.0;
 397
 398       if (_pitch[i].prop)
 399          p = _pitch[i].prop->getDoubleValue();
 400
 401       else if (_pitch[i].intern)
 402          p = *_pitch[i].intern;
 403
 404       if (_pitch[i].fn)
 405          p = _pitch[i].fn(p);
 406
 407       p *= _pitch[i].factor;
 408
 409       if (_pitch[i].max && (p > _pitch[i].max))
 410          p = _pitch[i].max;
 411
 412       else if (p < _pitch[i].min)
 413          p = _pitch[i].min;
 414
 415       if (_pitch[i].subtract)                           // Hack!
 416          pitch = _pitch[i].offset - p;
 417
 418       else {
 419          pitch_offset += _pitch[i].offset;
 420          pitch *= p;
 421       }
 422    }
 423
 424    //
 425    // Change sample state
 426    //
 427
 428    double vol = volume_offset + volume;
 429    if (vol > 1.0) {
 430       SG_LOG(SG_GENERAL, SG_DEBUG, "Sound volume too large for '"
 431               << _name << "':  " << vol << "  ->  clipping to 1.0");
 432       vol = 1.0;
 433    }
 434    _sample->set_volume(vol);
 435    _sample->set_pitch( pitch_offset + pitch );
 436
 437
 438    //
 439    // Do we need to start playing the sample?
 440    //
 441    if (!_active) {
 442
 443       if (_mode == SGXmlSound::ONCE)
 444          _sample->play(false);
 445
 446       else
 447          _sample->play(true);
 448
 449       SG_LOG(SG_GENERAL, SG_DEBUG, "Playing audio after " << _dt_stop
 450                                    << " sec: " << _name);
 451       SG_LOG(SG_GENERAL, SG_DEBUG,
 452                          "Playing " << ((_mode == ONCE) ? "once" : "looped"));
 453
 454       _active = true;
 455       _dt_stop = 0.0;
 456    }
 457 }