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 <3rdparty/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);
116 SGPropertyNode *node = fgGetNode("/sim/fgcom", 0, true);
117 _test_node = node->getChild( "test", 0, true );
118 _server_node = node->getChild( "server", 0, true );
119 _enabled_node = node->getChild( "enabled", 0, true );
120 _micBoost_node = node->getChild( "mic-boost", 0, true );
121 _micLevel_node = node->getChild( "mic-level", 0, true );
122 _speakerLevel_node = node->getChild( "speaker-level", 0, true );
123 _selectedInput_node = node->getChild( "device-input", 0, true );
124 _selectedOutput_node = node->getChild( "device-output", 0, true );
125 _showMessages_node = node->getChild( "show-messages", 0, true );
127 SGPropertyNode *reg_node = node->getChild("register", 0, true);
128 _register_node = reg_node->getChild( "enabled", 0, true );
129 _username_node = reg_node->getChild( "username", 0, true );
130 _password_node = reg_node->getChild( "password", 0, true );
132 //_nav0_node = fgGetNode("/instrumentation/nav[0]/frequencies/selected-mhz", true);
133 //_nav1_node = fgGetNode("/instrumentation/nav[1]/frequencies/selected-mhz", true);
134 _comm0_node = fgGetNode("/instrumentation/comm[0]/frequencies/selected-mhz", true);
135 //_comm1_node = fgGetNode("/instrumentation/comm[1]/frequencies/selected-mhz", true);
136 _ptt0_node = fgGetNode("/instrumentation/comm[0]/ptt", true); //FIXME: what about /instrumentation/comm[1]/ptt ?
137 _callsign_node = fgGetNode("/sim/multiplay/callsign", true);
138 _text_node = fgGetNode("/sim/messages/atc", true );
139 _version_node = fgGetNode("/sim/version/flightgear", true );
141 // Set default values if not provided
142 if ( !_enabled_node->hasValue() )
143 _enabled_node->setBoolValue(true);
145 if ( !_test_node->hasValue() )
146 _test_node->setBoolValue(false);
148 if ( !_micBoost_node->hasValue() )
149 _micBoost_node->setIntValue(1);
151 if ( !_server_node->hasValue() )
152 _server_node->setStringValue(DEFAULT_SERVER);
154 if ( !_speakerLevel_node->hasValue() )
155 _speakerLevel_node->setFloatValue(1.0);
157 if ( !_micLevel_node->hasValue() )
158 _micLevel_node->setFloatValue(1.0);
160 if ( !_register_node->hasValue() )
161 _register_node->setBoolValue(false);
163 if ( !_username_node->hasValue() )
164 _username_node->setStringValue("guest");
166 if ( !_password_node->hasValue() )
167 _password_node->setStringValue("guest");
169 if ( !_showMessages_node->hasValue() )
170 _showMessages_node->setBoolValue(false);
172 _selectedOutput_node->addChangeListener(this);
173 _selectedInput_node->addChangeListener(this);
174 _speakerLevel_node->addChangeListener(this);
175 _micBoost_node->addChangeListener(this);
176 _micLevel_node->addChangeListener(this);
177 _enabled_node->addChangeListener(this);
178 _comm0_node->addChangeListener(this);
179 //_comm1_node->addChangeListener(this);
180 //_nav0_node->addChangeListener(this);
181 //_nav1_node->addChangeListener(this);
182 _ptt0_node->addChangeListener(this);
183 _test_node->addChangeListener(this);
196 _enabled = _enabled_node->getBoolValue();
197 _server = _server_node->getStringValue();
198 _register = _register_node->getBoolValue();
199 _username = _username_node->getStringValue();
200 _password = _password_node->getStringValue();
202 _currentComm0 = _comm0_node->getDoubleValue();
203 //_currentComm1 = _comm1_node->getDoubleValue();
204 //_currentNav0 = _nav0_node->getDoubleValue();
205 //_currentNav1 = _nav1_node->getDoubleValue();
207 _comm0Changed = false;
208 //_comm1Changed = false;
209 //_nav0Changed = false;
210 //_nav1Changed = false;
212 _maxRange = MAX_RANGE;
213 _minRange = MIN_RANGE;
218 void FGCom::postinit()
224 //WARNING: this _must_ be executed after sound system is totally initialized !
225 if( iaxc_initialize(NUM_CALLS) ) {
226 SG_LOG(SG_IO, SG_ALERT, "FGCom: cannot initialize iaxclient");
231 assert( static_instance == NULL );
232 static_instance = this;
233 iaxc_set_event_callback( iaxc_callback );
235 // FIXME: To be implemented in IAX audio driver
236 //iaxc_mic_boost_set( _micBoost_node->getIntValue() );
237 std::string app = "FGFS-";
238 app += _version_node->getStringValue();
240 iaxc_set_callerid( _callsign_node->getStringValue(), app.c_str() );
241 iaxc_set_formats( IAXC_FORMAT_GSM, IAXC_FORMAT_GSM );
242 iaxc_start_processing_thread ();
244 // Now IAXClient is initialized
248 _regId = iaxc_register( const_cast<char*>(_username.c_str()),
249 const_cast<char*>(_password.c_str()),
250 const_cast<char*>(_server.c_str()) );
252 SG_LOG(SG_IO, SG_ALERT, "FGCom: cannot register iaxclient");
258 Here we will create the list of available audio devices
259 Each audio device has a name, an ID, and a list of capabilities
260 If an audio device can output sound, available-output=true
261 If an audio device can input sound, available-input=true
263 /sim/fgcom/selected-input (int)
264 /sim/fgcom/selected-output (int)
266 /sim/fgcom/device[n]/id (int)
267 /sim/fgcom/device[n]/name (string)
268 /sim/fgcom/device[n]/available-input (bool)
269 /sim/fgcom/device[n]/available-output (bool)
272 //FIXME: OpenAL driver use an hard-coded device
273 // so all following is unused finally until someone
274 // implement "multi-device" support in IAX audio driver
275 SGPropertyNode *node = fgGetNode("/sim/fgcom", 0, true);
277 struct iaxc_audio_device *devs;
278 int nDevs, input, output, ring;
280 iaxc_audio_devices_get(&devs,&nDevs, &input, &output, &ring);
282 for(int i=0; i<nDevs; i++ ) {
283 SGPropertyNode *in_node = node->getChild("device", i, true);
286 _deviceID_node[i] = in_node->getChild("id", 0, true);
287 _deviceID_node[i]->setIntValue(devs[i].devID);
290 _deviceName_node[i] = in_node->getChild("name", 0, true);
291 _deviceName_node[i]->setStringValue(devs[i].name);
294 _deviceInput_node[i] = in_node->getChild("available-input", 0, true);
295 if( devs[i].capabilities & IAXC_AD_INPUT )
296 _deviceInput_node[i]->setBoolValue(true);
298 _deviceInput_node[i]->setBoolValue(false);
301 _deviceOutput_node[i] = in_node->getChild("available-output", 0, true);
302 if( devs[i].capabilities & IAXC_AD_OUTPUT )
303 _deviceOutput_node[i]->setBoolValue(true);
305 _deviceOutput_node[i]->setBoolValue(false);
307 // use default device at start
308 if( devs[i].capabilities & IAXC_AD_INPUT_DEFAULT )
309 _selectedInput_node->setIntValue(devs[i].devID);
310 if( devs[i].capabilities & IAXC_AD_OUTPUT_DEFAULT )
311 _selectedOutput_node->setIntValue(devs[i].devID);
314 // Mute the mic and set speaker at start
315 iaxc_input_level_set( 0.0 );
316 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
320 // Do the first call at start
321 const double freq = _comm0_node->getDoubleValue();
322 _currentFreqKhz = 10 * static_cast<int>(freq * 100 + 0.25);
323 std::string num = computePhoneNumber(freq, getAirportCode(freq));
325 _callComm0 = iaxc_call(num.c_str());
327 if( _callComm0 == -1 )
328 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
333 void FGCom::updateCall(bool& changed, int& callNo, double freqMHz)
336 _currentFreqKhz = 10 * static_cast<int>(freqMHz * 100 + 0.25);
339 if( !isInRange(freqMHz) ) {
340 iaxc_dump_call_number(callNo);
349 changed = false; // FIXME, out-params are confusing
352 iaxc_dump_call_number( callNo );
356 if(_p.elapsedMSec() > IAX_DELAY) {
357 std::string num = computePhoneNumber(freqMHz, getAirportCode(freqMHz));
358 if( !isInRange(freqMHz) )
361 callNo = iaxc_call(num.c_str());
364 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
373 void FGCom::update(double dt)
375 if ( !_enabled || !_initialized ) {
379 // For now we manage FGCom for only one freq because IAXClient
380 // is not able to handle multiple calls at same time.
381 updateCall(_comm0Changed, _callComm0, _comm0_node->getDoubleValue());
382 // updateCall(_comm1Changed, _callComm1, _comm1_node->getDoubleValue());
383 // updateCall(_nav0Changed, _callNav0, _nav0_node->getDoubleValue());
384 // updateCall(_nav1Changed, _callNav1, _nav1_node->getDoubleValue());
389 void FGCom::shutdown()
395 _initialized = false;
398 iaxc_set_event_callback(NULL);
399 iaxc_unregister(_regId);
400 iaxc_stop_processing_thread();
403 assert( static_instance == this );
404 static_instance = NULL;
409 void FGCom::valueChanged(SGPropertyNode *prop)
411 if (prop == _enabled_node) {
412 bool isEnabled = prop->getBoolValue();
413 if (_enabled == isEnabled) {
426 if (prop == _ptt0_node && _enabled) {
427 if( _ptt0_node->getBoolValue() ) {
428 iaxc_output_level_set( 0.0 );
429 iaxc_input_level_set( _micLevel_node->getFloatValue() ); //0.0 = min , 1.0 = max
431 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
432 iaxc_input_level_set( 0.0 );
436 if (prop == _test_node) {
437 testMode( prop->getBoolValue() );
441 //FIXME: not implemented in IAX audio driver (audio_openal.c)
442 if (prop == _micBoost_node && _initialized) {
443 int micBoost = prop->getIntValue();
444 SG_CLAMP_RANGE<int>( micBoost, 0, 1 );
445 iaxc_mic_boost_set( micBoost ) ; // 0 = enabled , 1 = disabled
449 //FIXME: not implemented in IAX audio driver (audio_openal.c)
450 if ((prop == _selectedInput_node || prop == _selectedOutput_node) && _initialized) {
451 int selectedInput = _selectedInput_node->getIntValue();
452 int selectedOutput = _selectedOutput_node->getIntValue();
453 iaxc_audio_devices_set(selectedInput, selectedOutput, 0);
457 if (_listener_active)
462 if (prop == _speakerLevel_node && _enabled) {
463 float speakerLevel = prop->getFloatValue();
464 SG_CLAMP_RANGE<float>( speakerLevel, 0.0, 1.0 );
465 _speakerLevel_node->setFloatValue(speakerLevel);
466 //iaxc_output_level_set(speakerLevel);
469 if (prop == _micLevel_node && _enabled) {
470 float micLevel = prop->getFloatValue();
471 SG_CLAMP_RANGE<float>( micLevel, 0.0, 1.0 );
472 _micLevel_node->setFloatValue(micLevel);
473 //iaxc_input_level_set(micLevel);
476 if (prop == _comm0_node) {
477 if( _currentComm0 != prop->getDoubleValue() ) {
478 _currentComm0 = prop->getDoubleValue();
480 _comm0Changed = true;
484 if (prop == _comm1_node) {
485 if( _currentComm1 != prop->getDoubleValue() ) {
486 _currentComm1 = prop->getDoubleValue();
488 _comm1Changed = true;
492 if (prop == _nav0_node) {
493 if( _currentNav0 != prop->getDoubleValue() ) {
494 _currentNav0 = prop->getDoubleValue();
499 if (prop == _nav1_node) {
500 if( _currentNav1 != prop->getDoubleValue() ) {
501 _currentNav1 = prop->getDoubleValue();
512 void FGCom::testMode(bool testMode)
514 if(testMode && _initialized) {
516 iaxc_dump_call_number(_callComm0);
517 iaxc_input_level_set( _micLevel_node->getFloatValue() );
518 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
519 std::string num = computePhoneNumber(TEST_FREQ, NULL_ICAO);
520 if( num.size() > 0 ) {
521 iaxc_millisleep(IAX_DELAY);
522 _callComm0 = iaxc_call(num.c_str());
524 if( _callComm0 == -1 )
525 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
528 iaxc_dump_call_number(_callComm0);
529 iaxc_millisleep(IAX_DELAY);
539 \param freq The requested frequency e.g 120.825
540 \return The ICAO code as string e.g LFMV
543 std::string FGCom::getAirportCode(const double& freq)
545 SGGeod aircraftPos = globals->get_aircraft_position();
547 for(size_t i=0; i<sizeof(special_freq)/sizeof(special_freq[0]); i++) { // Check if it's a special freq
548 if(special_freq[i] == _currentFreqKhz) {
553 flightgear::CommStation* apt = flightgear::CommStation::findByFreq(_currentFreqKhz, aircraftPos);
555 return std::string();
558 if( apt->type() == FGPositioned::FREQ_TOWER ) {
559 _maxRange = MAX_TWR_RANGE;
560 _minRange = MIN_GNDTWR_RANGE;
561 } else if( apt->type() == FGPositioned::FREQ_GROUND ) {
562 _maxRange = MAX_GND_RANGE;
563 _minRange = MIN_GNDTWR_RANGE;
565 _maxRange = MAX_RANGE;
566 _minRange = MIN_RANGE;
569 _aptPos = apt->geod();
570 return apt->airport()->ident();
576 \param freq The requested frequency e.g 112.7
577 \return The ICAO code as string e.g ITS
580 std::string FGCom::getVorCode(const double& freq) const
582 SGGeod aircraftPos = globals->get_aircraft_position();
583 FGNavList::TypeFilter filter(FGPositioned::VOR);
585 FGNavRecord* vor = FGNavList::findByFreq( freq, aircraftPos, &filter);
587 return std::string();
590 return vor->get_ident();
596 \param freq The requested frequency e.g 120.825
597 \param iaco The associated ICAO code e.g LFMV
598 \return The phone number as string i.e username:password@fgcom.flightgear.org/0176707786120825
601 std::string FGCom::computePhoneNumber(const double& freq, const std::string& icao) const
604 return std::string();
606 char phoneNumber[256];
610 /*Convert ICAO to ASCII */
611 sprintf( tmp, "%4s", icao.c_str() );
613 /*Built the phone number */
615 "%02d%02d%02d%02d%02d%06d",
621 (int) (freq * 1000 + 0.5) );
624 snprintf( phoneNumber,
625 sizeof (phoneNumber),
638 \return A boolean value, 1=in range, 0=out of range
641 bool FGCom::isInRange(const double &freq) const
643 for(size_t i=0; i<sizeof(special_freq)/sizeof(special_freq[0]); i++) { // Check if it's a special freq
644 if( (special_freq[i]) == _currentFreqKhz ) {
649 SGGeod acftPos = globals->get_aircraft_position();
650 double distNm = SGGeodesy::distanceNm(_aptPos, acftPos);
651 double delta_elevation_ft = fabs(acftPos.getElevationFt() - _aptPos.getElevationFt());
652 double rangeNm = 1.23 * sqrt(delta_elevation_ft);
654 if (rangeNm > _maxRange) rangeNm = _maxRange;
655 if (rangeNm < _minRange) rangeNm = _minRange;
656 if( distNm > rangeNm ) return 0;