src/Sound/fg_fx.cxx

   1 // fg_fx.cxx -- Sound effect management class implementation
   2 //
   3 // Started by David Megginson, October 2001
   4 // (Reuses some code from main.cxx, probably by Curtis Olson)
   5 //
   6 // Copyright (C) 2001  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 _MSC_VER
  25 #pragma warning (disable: 4786)
  26 #endif
  27
  28 #ifdef HAVE_CONFIG_H
  29 #  include <config.h>
  30 #endif
  31
  32 #include <simgear/debug/logstream.hxx>
  33 #include <simgear/structure/exception.hxx>
  34 #include <simgear/misc/sg_path.hxx>
  35 #include <simgear/props/props.hxx>
  36 #include <simgear/sound/xmlsound.hxx>
  37
  38 #include <Main/fg_props.hxx>
  39
  40 #include <simgear/scene/model/placement.hxx>
  41 #include <Model/acmodel.hxx>
  42 #include <Main/viewer.hxx>
  43
  44 #include "fg_fx.hxx"
  45
  46
  47 FGFX::FGFX () :
  48     last_pause( true ),
  49     last_volume( 0.0 ),
  50     _pause( fgGetNode("/sim/sound/pause") ),
  51     _volume( fgGetNode("/sim/sound/volume") )
  52 {
  53     sgdSetVec3(last_visitor_pos, 0, 0, 0);
  54     sgdSetVec3(last_model_pos, 0, 0, 0);
  55 }
  56
  57 FGFX::~FGFX ()
  58 {
  59     unsigned int i;
  60     for ( i = 0; i < _sound.size(); i++ ) {
  61         delete _sound[i];
  62     }
  63     _sound.clear();
  64
  65     while ( _samplequeue.size() > 0 ) {
  66         delete _samplequeue.front();
  67         _samplequeue.pop();
  68     }
  69 }
  70
  71 void
  72 FGFX::init()
  73 {
  74     SGPropertyNode *node = fgGetNode("/sim/sound", true);
  75
  76     string path_str = node->getStringValue("path");
  77     SGPath path( globals->get_fg_root() );
  78     if (path_str.empty()) {
  79         SG_LOG(SG_GENERAL, SG_ALERT, "No path in /sim/sound/path");
  80         return;
  81     }
  82
  83     path.append(path_str.c_str());
  84     SG_LOG(SG_GENERAL, SG_INFO, "Reading sound " << node->getName()
  85            << " from " << path.str());
  86
  87     SGPropertyNode root;
  88     try {
  89         readProperties(path.str(), &root);
  90     } catch (const sg_exception &) {
  91         SG_LOG(SG_GENERAL, SG_ALERT,
  92                "Error reading file '" << path.str() << '\'');
  93         return;
  94     }
  95
  96     node = root.getNode("fx");
  97     if(node) {
  98         for (int i = 0; i < node->nChildren(); ++i) {
  99             SGXmlSound *sound = new SGXmlSound();
 100
 101             try {
 102                 sound->init(globals->get_props(), node->getChild(i),
 103                             globals->get_soundmgr(), globals->get_fg_root());
 104
 105                 _sound.push_back(sound);
 106             } catch ( sg_exception &e ) {
 107                 SG_LOG(SG_GENERAL, SG_ALERT, e.getFormattedMessage());
 108                 delete sound;
 109             }
 110         }
 111     }
 112 }
 113
 114 void
 115 FGFX::reinit()
 116 {
 117    _sound.clear();
 118    init();
 119 };
 120
 121 void
 122 FGFX::bind ()
 123 {
 124 }
 125
 126 void
 127 FGFX::unbind ()
 128 {
 129 }
 130
 131 void
 132 FGFX::update (double dt)
 133 {
 134     SGSoundMgr *smgr = globals->get_soundmgr();
 135
 136     if (smgr->is_working() == false) {
 137         return;
 138     }
 139
 140 #if 0
 141     // moved back to the mainloop to prevent audio problems
 142     smgr->update(dt);
 143     update_pos_and_orientation(smgr, dt);
 144 #endif
 145
 146     // command sound manger
 147     bool pause = _pause->getBoolValue();
 148     if ( pause != last_pause ) {
 149         if ( pause ) {
 150             smgr->pause();
 151         } else {
 152             smgr->resume();
 153         }
 154         last_pause = pause;
 155     }
 156
 157     // process mesage queue
 158     const string msgid = "Sequential Audio Message";
 159     bool is_playing = false;
 160     if ( smgr->exists( msgid ) ) {
 161         if ( smgr->is_playing( msgid ) ) {
 162             // still playing, do nothing
 163             is_playing = true;
 164         } else {
 165             // current message finished, stop and remove
 166             smgr->stop( msgid );   // removes source
 167             smgr->remove( msgid ); // removes buffer
 168         }
 169     }
 170     if ( !is_playing ) {
 171         // message queue idle, add next sound if we have one
 172         if ( _samplequeue.size() > 0 ) {
 173             smgr->add( _samplequeue.front(), msgid );
 174             _samplequeue.pop();
 175             smgr->play_once( msgid );
 176         }
 177     }
 178
 179     double volume = _volume->getDoubleValue();
 180     if ( volume != last_volume ) {
 181         smgr->set_volume( volume );
 182         last_volume = volume;
 183     }
 184
 185     if ( !pause ) {
 186         // update sound effects if not paused
 187         for ( unsigned int i = 0; i < _sound.size(); i++ ) {
 188             _sound[i]->update(dt);
 189         }
 190     }
 191 }
 192
 193 /**
 194  * add a sound sample to the message queue which is played sequentially
 195  * in order.
 196  */
 197 void
 198 FGFX::play_message( SGSoundSample *_sample )
 199 {
 200     _samplequeue.push( _sample );
 201 }
 202 void
 203 FGFX::play_message( const string path, const string fname, double volume )
 204 {
 205     if (globals->get_soundmgr()->is_working() == false) {
 206         return;
 207     }
 208     SGSoundSample *sample;
 209     sample = new SGSoundSample( path.c_str(), fname.c_str() );
 210     sample->set_volume( volume );
 211     play_message( sample );
 212 }
 213
 214 void
 215 FGFX::update_pos_and_orientation(SGSoundMgr *smgr, double dt)
 216 {
 217     SGModelPlacement *model = globals->get_aircraft_model()->get3DModel();
 218     FGViewer *observer = globals->get_current_view();
 219
 220     // Right now we make a simplifying assumption that the primary
 221     // aircraft is the source of all sounds and that all sounds are
 222     // positioned in the aircraft base
 223     // EMH: Note: this is fine, to hear multiple aircraft simulataniously
 224     //      we just have to trigger one instance of the FGFX class for every
 225     //      aircraft
 226
 227     // get the orientation
 228     const SGQuatd view_or = observer->getViewOrientation();
 229     SGQuatd surf_or = SGQuatd::fromLonLat(observer->getPosition());
 230
 231     SGQuatd model_or = SGQuatd::fromYawPitchRollDeg(
 232                                 model->getHeadingDeg(),
 233                                 model->getPitchDeg(),
 234                                 model->getRollDeg());
 235
 236     // get the up and at vector in the aircraft base
 237     // (ok, the up vector is a down vector, but the coordinates
 238     // are finally calculated in a left hand system and openal
 239     // lives in a right hand system. Therefore we need to pass
 240     // the down vector to get correct stereo sound.)
 241     SGVec3d sgv_up, sgv_at;
 242     sgVec3 up, at;
 243
 244     sgv_up
 245       = model_or.rotateBack(surf_or.rotateBack(view_or.rotate(SGVec3d(0,1,0))));
 246     sgSetVec3(up, sgv_up[0], sgv_up[1], sgv_up[2]);
 247     sgv_at
 248       = model_or.rotateBack(surf_or.rotateBack(view_or.rotate(SGVec3d(0,0,1))));
 249     sgSetVec3(at, sgv_at[0], sgv_at[1], sgv_at[2]);
 250
 251     // get the location data for the primary FDM (now hardcoded to ac model)...
 252     // EMH: to add multiple sound sources this should be replaced
 253     SGVec3d absolute_view_pos = SGVec3d::fromGeod(model->getPosition());
 254
 255     // calculate speed of visitor and model
 256     sgVec3 listener_vel, model_vel;
 257     SGVec3d SGV3d_help;
 258     sgdVec3 sgdv3_help;
 259     sgdVec3 sgdv3_null = {0, 0, 0};
 260
 261
 262     sgdSubVec3(sgdv3_help,
 263                 last_visitor_pos, (double *)&observer->get_view_pos());
 264     sgdAddVec3(last_visitor_pos,
 265                 sgdv3_null, (double *)&observer->get_view_pos());
 266
 267     SGV3d_help = model_or.rotateBack(
 268                     surf_or.rotateBack(
 269                        SGVec3d(sgdv3_help[0], sgdv3_help[1], sgdv3_help[2])
 270                     ));
 271     sgSetVec3(listener_vel, SGV3d_help[0], SGV3d_help[1], SGV3d_help[2]);
 272
 273     sgdSubVec3(sgdv3_help, last_model_pos, absolute_view_pos.sg());
 274     sgdAddVec3(last_model_pos, sgdv3_null, absolute_view_pos.sg());
 275
 276     SGV3d_help = model_or.rotateBack(
 277                     surf_or.rotateBack(
 278                        SGVec3d(sgdv3_help[0], sgdv3_help[1], sgdv3_help[2])
 279                     ));
 280     sgSetVec3( model_vel, SGV3d_help[0], SGV3d_help[1], SGV3d_help[2]);
 281
 282     if (dt > 0) {
 283         sgScaleVec3( model_vel, 1 / dt );
 284         sgScaleVec3( listener_vel, 1 / dt );
 285     }
 286
 287     // checking, if the listener pos has moved suddenly
 288     if (sgLengthVec3(listener_vel) > 1000)
 289     {
 290         // check if the relative speed model vs listener has moved suddenly, too
 291         sgVec3 delta_vel;
 292         sgSubVec3(delta_vel, listener_vel, model_vel);
 293         if (sgLengthVec3(delta_vel) > 1000)
 294             // a sane value
 295             sgSetVec3(listener_vel, model_vel[0], model_vel[1], model_vel[2]);
 296         else
 297             smgr->set_listener_vel(listener_vel);
 298     }
 299     else
 300         smgr->set_listener_vel( listener_vel );
 301
 302     // set positional offset for sources
 303     sgdVec3 dsource_pos_offset;
 304     sgdSubVec3( dsource_pos_offset,
 305                 (double*) &observer->get_view_pos(),
 306                 absolute_view_pos.sg() );
 307     SGVec3d sgv_dsource_pos_offset;
 308     sgv_dsource_pos_offset = model_or.rotateBack(
 309                                 surf_or.rotateBack(
 310                                    SGVec3d(dsource_pos_offset[0],
 311                                           dsource_pos_offset[1],
 312                                           dsource_pos_offset[2])
 313                                 ));
 314     sgVec3 source_pos_offset;
 315     sgSetVec3(source_pos_offset,
 316                  sgv_dsource_pos_offset[0],
 317                  sgv_dsource_pos_offset[1],
 318                  sgv_dsource_pos_offset[2]);
 319
 320     smgr->set_source_pos_all( source_pos_offset );
 321     smgr->set_source_vel_all( model_vel );
 322
 323     float orient[6];
 324     for (int i = 0; i < 3; i++) {
 325         orient[i] = sgv_at[i];
 326         orient[i + 3] = sgv_up[i];
 327     }
 328     smgr->set_listener_orientation( orient );
 329
 330     // The listener is always positioned at the origin.
 331     sgVec3 listener_pos;
 332     sgSetVec3( listener_pos, 0.0, 0.0, 0.0 );
 333     smgr->set_listener_pos( listener_pos );
 334 }
 335
 336 // end of fg_fx.cxx