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 "fg_fx.hxx"
  33
  34 #include <simgear/debug/logstream.hxx>
  35 #include <simgear/structure/exception.hxx>
  36 #include <simgear/misc/sg_path.hxx>
  37 #include <simgear/props/props.hxx>
  38 #include <simgear/sound/xmlsound.hxx>
  39 #include <simgear/sound/soundmgr_openal.hxx>
  40
  41 #include <Main/fg_props.hxx>
  42
  43 #include <simgear/scene/model/placement.hxx>
  44 #include <Model/acmodel.hxx>
  45 #include <Main/viewer.hxx>
  46
  47 FGFX::FGFX () :
  48     last_visitor_pos(SGVec3d::zeros()),
  49     last_model_pos(SGVec3d::zeros()),
  50     last_pause( true ),
  51     last_volume( 0.0 ),
  52     _pause( fgGetNode("/sim/sound/pause") ),
  53     _volume( fgGetNode("/sim/sound/volume") )
  54 {
  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     // command sound manger
 141     bool pause = _pause->getBoolValue();
 142     if ( pause != last_pause ) {
 143         if ( pause ) {
 144             smgr->pause();
 145         } else {
 146             smgr->resume();
 147         }
 148         last_pause = pause;
 149     }
 150
 151     // process mesage queue
 152     const string msgid = "Sequential Audio Message";
 153     bool is_playing = false;
 154     if ( smgr->exists( msgid ) ) {
 155         if ( smgr->is_playing( msgid ) ) {
 156             // still playing, do nothing
 157             is_playing = true;
 158         } else {
 159             // current message finished, stop and remove
 160             smgr->stop( msgid );   // removes source
 161             smgr->remove( msgid ); // removes buffer
 162         }
 163     }
 164     if ( !is_playing ) {
 165         // message queue idle, add next sound if we have one
 166         if ( _samplequeue.size() > 0 ) {
 167             smgr->add( _samplequeue.front(), msgid );
 168             _samplequeue.pop();
 169             smgr->play_once( msgid );
 170         }
 171     }
 172
 173     double volume = _volume->getDoubleValue();
 174     if ( volume != last_volume ) {
 175         smgr->set_volume( volume );
 176         last_volume = volume;
 177     }
 178
 179     if ( !pause ) {
 180         // update sound effects if not paused
 181         for ( unsigned int i = 0; i < _sound.size(); i++ ) {
 182             _sound[i]->update(dt);
 183         }
 184     }
 185 }
 186
 187 void
 188 FGFX::update_fx_late(double dt)
 189 {
 190   SGSoundMgr *smgr = globals->get_soundmgr();
 191   if (!smgr->is_working()) {
 192     return;
 193   }
 194
 195   smgr->update(dt);
 196   update_pos_and_orientation(smgr, dt);
 197 }
 198
 199 /**
 200  * add a sound sample to the message queue which is played sequentially
 201  * in order.
 202  */
 203 void
 204 FGFX::play_message( SGSoundSample *_sample )
 205 {
 206     _samplequeue.push( _sample );
 207 }
 208 void
 209 FGFX::play_message( const std::string& path, const std::string& fname, double volume )
 210 {
 211     if (globals->get_soundmgr()->is_working() == true) {
 212         SGSoundSample *sample;
 213         sample = new SGSoundSample( path.c_str(), fname.c_str() );
 214         sample->set_volume( volume );
 215         play_message( sample );
 216     }
 217 }
 218
 219 void
 220 FGFX::update_pos_and_orientation(SGSoundMgr *smgr, double dt)
 221 {
 222     SGModelPlacement *model = globals->get_aircraft_model()->get3DModel();
 223     FGViewer *observer = globals->get_current_view();
 224
 225     // Right now we make a simplifying assumption that the primary
 226     // aircraft is the source of all sounds and that all sounds are
 227     // positioned in the aircraft base
 228     // EMH: Note: this is fine, to hear multiple aircraft simulataniously
 229     //      we just have to trigger one instance of the FGFX class for every
 230     //      aircraft
 231
 232     // get the orientation
 233     const SGQuatd view_or = observer->getViewOrientation();
 234     SGQuatd surf_or = SGQuatd::fromLonLat(observer->getPosition());
 235
 236     SGQuatd model_or = SGQuatd::fromYawPitchRollDeg(
 237                                 model->getHeadingDeg(),
 238                                 model->getPitchDeg(),
 239                                 model->getRollDeg());
 240
 241     // get the up and at vector in the aircraft base
 242     // (ok, the up vector is a down vector, but the coordinates
 243     // are finally calculated in a left hand system and openal
 244     // lives in a right hand system. Therefore we need to pass
 245     // the down vector to get correct stereo sound.)
 246     SGVec3d sgv_up
 247       = model_or.rotateBack(surf_or.rotateBack(view_or.rotate(SGVec3d(0,1,0))));
 248     SGVec3d sgv_at
 249       = model_or.rotateBack(surf_or.rotateBack(view_or.rotate(SGVec3d(0,0,1))));
 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     SGVec3d moved = last_visitor_pos - observer->get_view_pos();
 257     last_visitor_pos = observer->get_view_pos();
 258     SGVec3f listener_vel(model_or.rotateBack(surf_or.rotateBack(moved)));
 259
 260     moved = last_model_pos - absolute_view_pos;
 261     last_model_pos = absolute_view_pos;
 262     SGVec3f model_vel(model_or.rotateBack(surf_or.rotateBack(moved)));
 263
 264     if (dt > 0) {
 265       model_vel /= dt;
 266       listener_vel /= dt;
 267     }
 268
 269     // checking, if the listener pos has moved suddenly
 270     if (length(listener_vel) > 1000) {
 271         // check if the relative speed model vs listener has moved suddenly, too
 272         SGVec3f delta_vel = listener_vel - model_vel;
 273         if (length(delta_vel) > 1000)
 274             // a sane value
 275             smgr->set_listener_vel(model_vel.data());
 276         else
 277             smgr->set_listener_vel(listener_vel.data());
 278     } else {
 279       smgr->set_listener_vel( listener_vel.data());
 280     }
 281
 282     // set positional offset for sources
 283     SGVec3d dsource_pos_offset = observer->get_view_pos() - absolute_view_pos;
 284     dsource_pos_offset = model_or.rotateBack(surf_or.rotateBack(
 285                                    dsource_pos_offset
 286                                 ));
 287
 288     smgr->set_source_pos_all( SGVec3f(dsource_pos_offset).data() );
 289     smgr->set_source_vel_all(model_vel.data() );
 290
 291     float orient[6];
 292     for (int i = 0; i < 3; i++) {
 293         orient[i] = sgv_at[i];
 294         orient[i + 3] = sgv_up[i];
 295     }
 296     smgr->set_listener_orientation( orient );
 297
 298     // The listener is always positioned at the origin.
 299     smgr->set_listener_pos( SGVec3f::zeros().data() );
 300 }
 301
 302 // end of fg_fx.cxx