1 // fgcom.cxx -- FGCom: Voice communication
3 // Written by Clement de l'Hamaide, started May 2013.
5 // This program is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License as
7 // published by the Free Software Foundation; either version 2 of the
8 // License, or (at your option) any later version.
10 // This program is distributed in the hope that it will be useful, but
11 // WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 // standard library includes
29 #include <simgear/compiler.h>
30 #include <simgear/sg_inlines.h>
31 #include <simgear/debug/logstream.hxx>
32 #include <simgear/math/sg_geodesy.hxx>
33 #include <simgear/timing/timestamp.hxx>
35 // flightgear includes
36 #include <Main/fg_props.hxx>
37 #include <Main/globals.hxx>
38 #include <ATC/CommStation.hxx>
39 #include <Airports/airport.hxx>
40 #include <Navaids/navlist.hxx>
42 #include <utils/iaxclient/lib/iaxclient.h>
46 #define MAX_GND_RANGE 10.0
47 #define MAX_TWR_RANGE 50.0
48 #define MAX_RANGE 100.0
49 #define MIN_RANGE 20.0
50 #define MIN_GNDTWR_RANGE 0.0
51 #define DEFAULT_SERVER "fgcom.flightgear.org"
52 #define IAX_DELAY 300 // delay between calls in milliseconds
53 #define TEST_FREQ 910.00
54 #define NULL_ICAO "ZZZZ"
56 const int special_freq[] = { // Define some freq who need to be used with NULL_ICAO
67 static FGCom* static_instance = NULL;
71 static int iaxc_callback( iaxc_event e )
76 static_instance->iaxTextEvent(e.ev.text);
86 void FGCom::iaxTextEvent(struct iaxc_ev_text text)
88 if( (text.type == IAXC_TEXT_TYPE_STATUS ||
89 text.type == IAXC_TEXT_TYPE_IAX) &&
90 _showMessages_node->getBoolValue() )
92 _text_node->setStringValue(text.message);
101 _listener_active = 0;
114 SGPropertyNode *node = fgGetNode("/sim/fgcom", 0, true);
115 _test_node = node->getChild( "test", 0, true );
116 _server_node = node->getChild( "server", 0, true );
117 _enabled_node = node->getChild( "enabled", 0, true );
118 _micBoost_node = node->getChild( "mic-boost", 0, true );
119 _micLevel_node = node->getChild( "mic-level", 0, true );
120 _speakerLevel_node = node->getChild( "speaker-level", 0, true );
121 _selectedInput_node = node->getChild( "device-input", 0, true );
122 _selectedOutput_node = node->getChild( "device-output", 0, true );
123 _showMessages_node = node->getChild( "show-messages", 0, true );
125 SGPropertyNode *reg_node = node->getChild("register", 0, true);
126 _register_node = reg_node->getChild( "enabled", 0, true );
127 _username_node = reg_node->getChild( "username", 0, true );
128 _password_node = reg_node->getChild( "password", 0, true );
130 //_nav0_node = fgGetNode("/instrumentation/nav[0]/frequencies/selected-mhz", true);
131 //_nav1_node = fgGetNode("/instrumentation/nav[1]/frequencies/selected-mhz", true);
132 _comm0_node = fgGetNode("/instrumentation/comm[0]/frequencies/selected-mhz", true);
133 //_comm1_node = fgGetNode("/instrumentation/comm[1]/frequencies/selected-mhz", true);
134 _ptt0_node = fgGetNode("/instrumentation/comm[0]/ptt", true); //FIXME: what about /instrumentation/comm[1]/ptt ?
135 _callsign_node = fgGetNode("/sim/multiplay/callsign", true);
136 _text_node = fgGetNode("/sim/messages/atc", true );
138 // Set default values if not provided
139 if ( !_enabled_node->hasValue() )
140 _enabled_node->setBoolValue(true);
142 if ( !_test_node->hasValue() )
143 _test_node->setBoolValue(false);
145 if ( !_micBoost_node->hasValue() )
146 _micBoost_node->setIntValue(1);
148 if ( !_server_node->hasValue() )
149 _server_node->setStringValue(DEFAULT_SERVER);
151 if ( !_speakerLevel_node->hasValue() )
152 _speakerLevel_node->setFloatValue(1.0);
154 if ( !_micLevel_node->hasValue() )
155 _micLevel_node->setFloatValue(1.0);
157 if ( !_register_node->hasValue() )
158 _register_node->setBoolValue(false);
160 if ( !_username_node->hasValue() )
161 _username_node->setStringValue("guest");
163 if ( !_password_node->hasValue() )
164 _password_node->setStringValue("guest");
166 if ( !_showMessages_node->hasValue() )
167 _showMessages_node->setBoolValue(false);
169 _selectedOutput_node->addChangeListener(this);
170 _selectedInput_node->addChangeListener(this);
171 _speakerLevel_node->addChangeListener(this);
172 _micBoost_node->addChangeListener(this);
173 _micLevel_node->addChangeListener(this);
174 _enabled_node->addChangeListener(this);
175 _comm0_node->addChangeListener(this);
176 //_comm1_node->addChangeListener(this);
177 //_nav0_node->addChangeListener(this);
178 //_nav1_node->addChangeListener(this);
179 _ptt0_node->addChangeListener(this);
180 _test_node->addChangeListener(this);
193 _enabled = _enabled_node->getBoolValue();
194 _server = _server_node->getStringValue();
195 _register = _register_node->getBoolValue();
196 _username = _username_node->getStringValue();
197 _password = _password_node->getStringValue();
199 _currentComm0 = _comm0_node->getDoubleValue();
200 //_currentComm1 = _comm1_node->getDoubleValue();
201 //_currentNav0 = _nav0_node->getDoubleValue();
202 //_currentNav1 = _nav1_node->getDoubleValue();
204 _comm0Changed = false;
205 //_comm1Changed = false;
206 //_nav0Changed = false;
207 //_nav1Changed = false;
209 _maxRange = MAX_RANGE;
210 _minRange = MIN_RANGE;
215 void FGCom::postinit()
221 //WARNING: this _must_ be executed after sound system is totally initialized !
222 if( iaxc_initialize(NUM_CALLS) ) {
223 SG_LOG(SG_IO, SG_ALERT, "FGCom: cannot initialize iaxclient");
228 assert( static_instance == NULL );
229 static_instance = this;
230 iaxc_set_event_callback( iaxc_callback );
232 // FIXME: To be implemented in IAX audio driver
233 //iaxc_mic_boost_set( _micBoost_node->getIntValue() );
234 iaxc_set_formats( IAXC_FORMAT_GSM, IAXC_FORMAT_GSM );
235 iaxc_start_processing_thread ();
237 // Now IAXClient is initialized
241 _regId = iaxc_register( const_cast<char*>(_username.c_str()),
242 const_cast<char*>(_password.c_str()),
243 const_cast<char*>(_server.c_str()) );
245 SG_LOG(SG_IO, SG_ALERT, "FGCom: cannot register iaxclient");
251 Here we will create the list of available audio devices
252 Each audio device has a name, an ID, and a list of capabilities
253 If an audio device can output sound, available-output=true
254 If an audio device can input sound, available-input=true
256 /sim/fgcom/selected-input (int)
257 /sim/fgcom/selected-output (int)
259 /sim/fgcom/device[n]/id (int)
260 /sim/fgcom/device[n]/name (string)
261 /sim/fgcom/device[n]/available-input (bool)
262 /sim/fgcom/device[n]/available-output (bool)
265 //FIXME: OpenAL driver use an hard-coded device
266 // so all following is unused finally until someone
267 // implement "multi-device" support in IAX audio driver
268 SGPropertyNode *node = fgGetNode("/sim/fgcom", 0, true);
270 struct iaxc_audio_device *devs;
271 int nDevs, input, output, ring;
273 iaxc_audio_devices_get(&devs,&nDevs, &input, &output, &ring);
275 for(int i=0; i<nDevs; i++ ) {
276 SGPropertyNode *in_node = node->getChild("device", i, true);
279 _deviceID_node[i] = in_node->getChild("id", 0, true);
280 _deviceID_node[i]->setIntValue(devs[i].devID);
283 _deviceName_node[i] = in_node->getChild("name", 0, true);
284 _deviceName_node[i]->setStringValue(devs[i].name);
287 _deviceInput_node[i] = in_node->getChild("available-input", 0, true);
288 if( devs[i].capabilities & IAXC_AD_INPUT )
289 _deviceInput_node[i]->setBoolValue(true);
291 _deviceInput_node[i]->setBoolValue(false);
294 _deviceOutput_node[i] = in_node->getChild("available-output", 0, true);
295 if( devs[i].capabilities & IAXC_AD_OUTPUT )
296 _deviceOutput_node[i]->setBoolValue(true);
298 _deviceOutput_node[i]->setBoolValue(false);
300 // use default device at start
301 if( devs[i].capabilities & IAXC_AD_INPUT_DEFAULT )
302 _selectedInput_node->setIntValue(devs[i].devID);
303 if( devs[i].capabilities & IAXC_AD_OUTPUT_DEFAULT )
304 _selectedOutput_node->setIntValue(devs[i].devID);
307 // Mute the mic and set speaker at start
308 iaxc_input_level_set( 0.0 );
309 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
313 // Do the first call at start
314 const double freq = _comm0_node->getDoubleValue();
315 _currentFreqKhz = 10 * static_cast<int>(freq * 100 + 0.25);
316 std::string num = computePhoneNumber(freq, getAirportCode(freq));
318 _callComm0 = iaxc_call(num.c_str());
320 if( _callComm0 == -1 )
321 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
326 void FGCom::updateCall(bool& changed, int& callNo, double freqMHz)
329 _currentFreqKhz = 10 * static_cast<int>(freqMHz * 100 + 0.25);
332 if( !isInRange(freqMHz) ) {
333 iaxc_dump_call_number(callNo);
342 changed = false; // FIXME, out-params are confusing
345 iaxc_dump_call_number( callNo );
349 if(_p.elapsedMSec() > IAX_DELAY) {
350 std::string num = computePhoneNumber(freqMHz, getAirportCode(freqMHz));
351 if( !isInRange(freqMHz) )
354 callNo = iaxc_call_ex(num.c_str(), _callsign.c_str(), NULL, 0 /* no video */);
357 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
366 void FGCom::update(double dt)
368 if ( !_enabled || !_initialized ) {
372 // For now we manage FGCom for only one freq because IAXClient
373 // is not able to handle multiple calls at same time.
374 updateCall(_comm0Changed, _callComm0, _comm0_node->getDoubleValue());
375 // updateCall(_comm1Changed, _callComm1, _comm1_node->getDoubleValue());
376 // updateCall(_nav0Changed, _callNav0, _nav0_node->getDoubleValue());
377 // updateCall(_nav1Changed, _callNav1, _nav1_node->getDoubleValue());
382 void FGCom::shutdown()
388 _initialized = false;
391 iaxc_set_event_callback(NULL);
392 iaxc_unregister(_regId);
393 iaxc_stop_processing_thread();
396 assert( static_instance == this );
397 static_instance = NULL;
402 void FGCom::valueChanged(SGPropertyNode *prop)
404 if (prop == _enabled_node) {
405 if( prop->getBoolValue() ) {
414 if (prop == _ptt0_node && _enabled) {
415 if( _ptt0_node->getBoolValue() ) {
416 iaxc_output_level_set( 0.0 );
417 iaxc_input_level_set( _micLevel_node->getFloatValue() ); //0.0 = min , 1.0 = max
419 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
420 iaxc_input_level_set( 0.0 );
424 if (prop == _test_node) {
425 testMode( prop->getBoolValue() );
429 //FIXME: not implemented in IAX audio driver (audio_openal.c)
430 if (prop == _micBoost_node && _initialized) {
431 int micBoost = prop->getIntValue();
432 SG_CLAMP_RANGE<int>( micBoost, 0, 1 );
433 iaxc_mic_boost_set( micBoost ) ; // 0 = enabled , 1 = disabled
437 //FIXME: not implemented in IAX audio driver (audio_openal.c)
438 if ((prop == _selectedInput_node || prop == _selectedOutput_node) && _initialized) {
439 int selectedInput = _selectedInput_node->getIntValue();
440 int selectedOutput = _selectedOutput_node->getIntValue();
441 iaxc_audio_devices_set(selectedInput, selectedOutput, 0);
445 if (_listener_active)
450 if (prop == _speakerLevel_node && _enabled) {
451 float speakerLevel = prop->getFloatValue();
452 SG_CLAMP_RANGE<float>( speakerLevel, 0.0, 1.0 );
453 _speakerLevel_node->setFloatValue(speakerLevel);
454 //iaxc_output_level_set(speakerLevel);
457 if (prop == _micLevel_node && _enabled) {
458 float micLevel = prop->getFloatValue();
459 SG_CLAMP_RANGE<float>( micLevel, 0.0, 1.0 );
460 _micLevel_node->setFloatValue(micLevel);
461 //iaxc_input_level_set(micLevel);
464 if (prop == _comm0_node) {
465 if( _currentComm0 != prop->getDoubleValue() ) {
466 _currentComm0 = prop->getDoubleValue();
468 _comm0Changed = true;
472 if (prop == _comm1_node) {
473 if( _currentComm1 != prop->getDoubleValue() ) {
474 _currentComm1 = prop->getDoubleValue();
476 _comm1Changed = true;
480 if (prop == _nav0_node) {
481 if( _currentNav0 != prop->getDoubleValue() ) {
482 _currentNav0 = prop->getDoubleValue();
487 if (prop == _nav1_node) {
488 if( _currentNav1 != prop->getDoubleValue() ) {
489 _currentNav1 = prop->getDoubleValue();
500 void FGCom::testMode(bool testMode)
502 if(testMode && _initialized) {
504 iaxc_dump_call_number(_callComm0);
505 iaxc_input_level_set( _micLevel_node->getFloatValue() );
506 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
507 std::string num = computePhoneNumber(TEST_FREQ, NULL_ICAO);
508 if( num.size() > 0 ) {
509 iaxc_millisleep(IAX_DELAY);
510 _callComm0 = iaxc_call(num.c_str());
512 if( _callComm0 == -1 )
513 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
516 iaxc_dump_call_number(_callComm0);
517 iaxc_millisleep(IAX_DELAY);
527 \param freq The requested frequency e.g 120.825
528 \return The ICAO code as string e.g LFMV
531 std::string FGCom::getAirportCode(const double& freq)
533 SGGeod aircraftPos = globals->get_aircraft_position();
535 for(size_t i=0; i<sizeof(special_freq)/sizeof(special_freq[0]); i++) { // Check if it's a special freq
536 if(special_freq[i] == _currentFreqKhz) {
541 flightgear::CommStation* apt = flightgear::CommStation::findByFreq(_currentFreqKhz, aircraftPos);
543 return std::string();
546 if( apt->type() == FGPositioned::FREQ_TOWER ) {
547 _maxRange = MAX_TWR_RANGE;
548 _minRange = MIN_GNDTWR_RANGE;
549 } else if( apt->type() == FGPositioned::FREQ_GROUND ) {
550 _maxRange = MAX_GND_RANGE;
551 _minRange = MIN_GNDTWR_RANGE;
553 _maxRange = MAX_RANGE;
554 _minRange = MIN_RANGE;
557 _aptPos = apt->geod();
558 return apt->airport()->ident();
564 \param freq The requested frequency e.g 112.7
565 \return The ICAO code as string e.g ITS
568 std::string FGCom::getVorCode(const double& freq) const
570 SGGeod aircraftPos = globals->get_aircraft_position();
571 FGNavList::TypeFilter filter(FGPositioned::VOR);
573 FGNavRecord* vor = FGNavList::findByFreq( freq, aircraftPos, &filter);
575 return std::string();
578 return vor->get_ident();
584 \param freq The requested frequency e.g 120.825
585 \param iaco The associated ICAO code e.g LFMV
586 \return The phone number as string i.e username:password@fgcom.flightgear.org/0176707786120825
589 std::string FGCom::computePhoneNumber(const double& freq, const std::string& icao) const
592 return std::string();
594 char phoneNumber[256];
598 /*Convert ICAO to ASCII */
599 sprintf( tmp, "%4s", icao.c_str() );
601 /*Built the phone number */
603 "%02d%02d%02d%02d%02d%06d",
609 (int) (freq * 1000 + 0.5) );
612 snprintf( phoneNumber,
613 sizeof (phoneNumber),
626 \return A boolean value, 1=in range, 0=out of range
629 bool FGCom::isInRange(const double &freq) const
631 for(size_t i=0; i<sizeof(special_freq)/sizeof(special_freq[0]); i++) { // Check if it's a special freq
632 if( (special_freq[i]) == _currentFreqKhz ) {
637 SGGeod acftPos = globals->get_aircraft_position();
638 double distNm = SGGeodesy::distanceNm(_aptPos, acftPos);
639 double delta_elevation_ft = fabs(acftPos.getElevationFt() - _aptPos.getElevationFt());
640 double rangeNm = 1.23 * sqrt(delta_elevation_ft);
642 if (rangeNm > _maxRange) rangeNm = _maxRange;
643 if (rangeNm < _minRange) rangeNm = _minRange;
644 if( distNm > rangeNm ) return 0;