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 <Main/fg_props.hxx>
  35
  36 #include <simgear/props/props.hxx>
  37 #include <simgear/props/props_io.hxx>
  38 #include <simgear/misc/sg_path.hxx>
  39 #include <simgear/sound/soundmgr_openal.hxx>
  40 #include <simgear/sound/xmlsound.hxx>
  41
  42 FGFX::FGFX ( SGSoundMgr *smgr, const string &refname, SGPropertyNode *props ) :
  43     _props( props )
  44 {
  45     if (!props) {
  46         _is_aimodel = false;
  47         _props = globals->get_props();
  48         _enabled = fgGetNode("/sim/sound/effects/enabled", true);
  49         _volume = fgGetNode("/sim/sound/effects/volume", true);
  50     } else {
  51         _is_aimodel = true;
  52         _enabled = _props->getNode("/sim/sound/aimodels/enabled", true);
  53         _enabled->setBoolValue(fgGetBool("/sim/sound/effects/enabled"));
  54          _volume = _props->getNode("/sim/sound/aimodels/volume", true);
  55         _volume->setFloatValue(fgGetFloat("/sim/sound/effects/volume"));
  56 _volume->setFloatValue(0.1f);
  57     }
  58
  59     _avionics_enabled = _props->getNode("sim/sound/avionics/enabled", true);
  60     _avionics_volume = _props->getNode("sim/sound/avionics/volume", true);
  61     _avionics_ext = _props->getNode("sim/sound/avionics/external-view", true);
  62     _internal = _props->getNode("sim/current-view/internal", true);
  63
  64     SGSampleGroup::_smgr = smgr;
  65     SGSampleGroup::_refname = refname;
  66     SGSampleGroup::_smgr->add(this, refname);
  67
  68     if (_avionics_enabled->getBoolValue())
  69     {
  70         _avionics = _smgr->find("avionics", true);
  71         _avionics->tie_to_listener();
  72     }
  73 }
  74
  75
  76 FGFX::~FGFX ()
  77 {
  78     for (unsigned int i = 0; i < _sound.size(); i++ ) {
  79         delete _sound[i];
  80     }
  81     _sound.clear();
  82 }
  83
  84
  85 void
  86 FGFX::init()
  87 {
  88     SGPropertyNode *node = _props->getNode("sim/sound", true);
  89
  90     string path_str = node->getStringValue("path");
  91     if (path_str.empty()) {
  92         SG_LOG(SG_SOUND, SG_ALERT, "No path in sim/sound/path");
  93         return;
  94     }
  95
  96     SGPath path = globals->resolve_aircraft_path(path_str);
  97     SG_LOG(SG_SOUND, SG_INFO, "Reading sound " << node->getName()
  98            << " from " << path.str());
  99
 100     SGPropertyNode root;
 101     try {
 102         readProperties(path.str(), &root);
 103     } catch (const sg_exception &) {
 104         SG_LOG(SG_SOUND, SG_ALERT,
 105                "Error reading file '" << path.str() << '\'');
 106         return;
 107     }
 108
 109     node = root.getNode("fx");
 110     if(node && !_is_aimodel) {
 111         for (int i = 0; i < node->nChildren(); ++i) {
 112             SGXmlSound *soundfx = new SGXmlSound();
 113
 114             try {
 115                 soundfx->init( _props, node->getChild(i), this, _avionics,
 116                                path.dir() );
 117                 _sound.push_back( soundfx );
 118             } catch ( sg_exception &e ) {
 119                 SG_LOG(SG_SOUND, SG_ALERT, e.getFormattedMessage());
 120                 delete soundfx;
 121             }
 122         }
 123     }
 124 }
 125
 126
 127 void
 128 FGFX::reinit()
 129 {
 130     for ( unsigned int i = 0; i < _sound.size(); i++ ) {
 131         delete _sound[i];
 132     }
 133     _sound.clear();
 134     init();
 135 };
 136
 137
 138 void
 139 FGFX::update (double dt)
 140 {
 141     bool active = _avionics_ext->getBoolValue() ||
 142                   _internal->getBoolValue();
 143
 144     if (_avionics_enabled->getBoolValue()) {
 145         if (!_avionics) {
 146             _avionics = _smgr->find("avionics", true);
 147             _avionics->tie_to_listener();
 148         }
 149
 150         if ( active )
 151             _avionics->resume(); // no-op if already in resumed state
 152         else
 153             _avionics->suspend();
 154         _avionics->set_volume( _avionics_volume->getFloatValue() );
 155     }
 156
 157     if ( _enabled->getBoolValue() ) {
 158         set_volume( _volume->getDoubleValue() );
 159         resume();
 160
 161         // update sound effects if not paused
 162         for ( unsigned int i = 0; i < _sound.size(); i++ ) {
 163             _sound[i]->update(dt);
 164         }
 165
 166         SGSampleGroup::update(dt);
 167     }
 168     else
 169         suspend();
 170 }
 171
 172 // end of fg_fx.cxx