1 // audioident.cxx -- audible station identifiers
3 // Written by Torsten Dreyer, September 2011
5 // Copyright (C) 2001 Curtis L. Olson - http://www.flightgear.org/~curt
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 #include "audioident.hxx"
23 #include <simgear/sg_inlines.h>
24 #include <simgear/sound/sample_group.hxx>
26 #include <Main/globals.hxx>
27 #include <Sound/morse.hxx>
29 AudioIdent::AudioIdent( const std::string & fx_name, const double interval_secs, const int frequency_hz ) :
31 _frequency(frequency_hz),
33 _interval(interval_secs),
38 void AudioIdent::init()
43 _sgr = globals->get_soundmgr()->find("avionics", true);
44 _sgr->tie_to_listener();
47 void AudioIdent::stop()
49 if( _sgr->exists( _fx_name ) )
50 _sgr->stop( _fx_name );
54 void AudioIdent::start()
57 _sgr->play_once(_fx_name);
61 void AudioIdent::setVolumeNorm( double volumeNorm )
63 SG_CLAMP_RANGE(volumeNorm, 0.0, 1.0);
65 SGSoundSample *sound = _sgr->find( _fx_name );
67 if ( sound != NULL ) {
68 sound->set_volume( volumeNorm );
72 void AudioIdent::setIdent( const std::string & ident, double volumeNorm )
74 // Signal may flicker very frequently (due to our realistic newnavradio...).
75 // Avoid recreating identical sound samples all the time, instead turn off
76 // volume when signal is lost, and save the most recent sample.
80 if(( _ident == ident )||
81 (volumeNorm == 0)) // don't bother with sounds when volume is OFF anyway...
83 if( false == _ident.empty() )
84 setVolumeNorm( volumeNorm );
91 if ( _sgr->exists( _fx_name ) )
92 _sgr->remove( _fx_name );
94 if( false == ident.empty() ) {
96 SGSoundSample* sound = FGMorse::instance()->make_ident(ident, _frequency );
97 sound->set_volume( volumeNorm );
98 if (!_sgr->add( sound, _fx_name )) {
99 SG_LOG(SG_SOUND, SG_WARN, "Failed to add sound '" << _fx_name << "' for ident '" << ident << "'" );
108 } catch (sg_io_exception& e) {
109 SG_LOG(SG_SOUND, SG_ALERT, e.getFormattedMessage());
114 void AudioIdent::update( double dt )
117 if( false == _running || _interval < SGLimitsd::min() )
122 if( _timer < SGLimitsd::min() ) {
129 // FIXME: shall transmit at least 6 wpm (ICAO Annex 10 - 3.5.3.6.3)
130 DMEAudioIdent::DMEAudioIdent( const std::string & fx_name )
131 : AudioIdent( fx_name, 40, FGMorse::HI_FREQUENCY )
136 //FIXME: for co-located VOR/DME or ILS/DME, assign four time-slots
137 // 3xVOR/ILS ident, 1xDME ident
139 // FIXME: shall transmit at approx. 7 wpm (ICAO Annex 10 - 3.3.6.5.1)
140 VORAudioIdent::VORAudioIdent( const std::string & fx_name )
141 : AudioIdent( fx_name, 10, FGMorse::LO_FREQUENCY )
145 //FIXME: LOCAudioIdent at approx 7wpm (ICAO Annex 10 - 3.1.3.9.4)
146 // not less than six times per minute at approx equal intervals
147 // frequency 1020+/-50Hz (3.1.3.9.2)
148 LOCAudioIdent::LOCAudioIdent( const std::string & fx_name )
149 : AudioIdent( fx_name, 10, FGMorse::LO_FREQUENCY )
154 // FIXME: NDBAudioIdent at approx 7 wpm (ICAO ANNEX 10 - 3.4.5.1)
155 // at least once every 10s (3.4.5.2.1)
156 // frequency 1020+/-50Hz or 400+/-25Hz (3.4.5.4)