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 _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 );
137 _version_node = fgGetNode("/sim/version/flightgear", true );
139 // Set default values if not provided
140 if ( !_enabled_node->hasValue() )
141 _enabled_node->setBoolValue(true);
143 if ( !_test_node->hasValue() )
144 _test_node->setBoolValue(false);
146 if ( !_micBoost_node->hasValue() )
147 _micBoost_node->setIntValue(1);
149 if ( !_server_node->hasValue() )
150 _server_node->setStringValue(DEFAULT_SERVER);
152 if ( !_speakerLevel_node->hasValue() )
153 _speakerLevel_node->setFloatValue(1.0);
155 if ( !_micLevel_node->hasValue() )
156 _micLevel_node->setFloatValue(1.0);
158 if ( !_register_node->hasValue() )
159 _register_node->setBoolValue(false);
161 if ( !_username_node->hasValue() )
162 _username_node->setStringValue("guest");
164 if ( !_password_node->hasValue() )
165 _password_node->setStringValue("guest");
167 if ( !_showMessages_node->hasValue() )
168 _showMessages_node->setBoolValue(false);
170 _selectedOutput_node->addChangeListener(this);
171 _selectedInput_node->addChangeListener(this);
172 _speakerLevel_node->addChangeListener(this);
173 _micBoost_node->addChangeListener(this);
174 _micLevel_node->addChangeListener(this);
175 _enabled_node->addChangeListener(this);
176 _comm0_node->addChangeListener(this);
177 _comm1_node->addChangeListener(this);
178 _ptt0_node->addChangeListener(this);
179 _test_node->addChangeListener(this);
192 _enabled = _enabled_node->getBoolValue();
193 _server = _server_node->getStringValue();
194 _register = _register_node->getBoolValue();
195 _username = _username_node->getStringValue();
196 _password = _password_node->getStringValue();
199 _currentComm0 = _comm0_node->getDoubleValue();
200 _currentComm1 = _comm1_node->getDoubleValue();
202 _comm0Changed = false;
203 _comm1Changed = false;
205 _maxRange = MAX_RANGE;
206 _minRange = MIN_RANGE;
211 void FGCom::postinit()
217 //WARNING: this _must_ be executed after sound system is totally initialized !
218 if( iaxc_initialize(NUM_CALLS) ) {
219 SG_LOG(SG_IO, SG_ALERT, "FGCom: cannot initialize iaxclient");
224 assert( static_instance == NULL );
225 static_instance = this;
226 iaxc_set_event_callback( iaxc_callback );
228 // FIXME: To be implemented in IAX audio driver
229 //iaxc_mic_boost_set( _micBoost_node->getIntValue() );
230 std::string app = "FGFS-";
231 app += _version_node->getStringValue();
233 iaxc_set_callerid( _callsign_node->getStringValue(), app.c_str() );
234 iaxc_set_formats (IAXC_FORMAT_SPEEX, IAXC_FORMAT_ULAW|IAXC_FORMAT_SPEEX);
235 iaxc_set_speex_settings(1, 5, 0, 1, 0, 3);
236 iaxc_set_filters(IAXC_FILTER_AGC | IAXC_FILTER_DENOISE);
237 iaxc_set_silence_threshold(-20.0);
238 iaxc_start_processing_thread ();
240 // Now IAXClient is initialized
244 _regId = iaxc_register( const_cast<char*>(_username.c_str()),
245 const_cast<char*>(_password.c_str()),
246 const_cast<char*>(_server.c_str()) );
248 SG_LOG(SG_IO, SG_ALERT, "FGCom: cannot register iaxclient");
254 Here we will create the list of available audio devices
255 Each audio device has a name, an ID, and a list of capabilities
256 If an audio device can output sound, available-output=true
257 If an audio device can input sound, available-input=true
259 /sim/fgcom/selected-input (int)
260 /sim/fgcom/selected-output (int)
262 /sim/fgcom/device[n]/id (int)
263 /sim/fgcom/device[n]/name (string)
264 /sim/fgcom/device[n]/available-input (bool)
265 /sim/fgcom/device[n]/available-output (bool)
268 //FIXME: OpenAL driver use an hard-coded device
269 // so all following is unused finally until someone
270 // implement "multi-device" support in IAX audio driver
271 SGPropertyNode *node = fgGetNode("/sim/fgcom", 0, true);
273 struct iaxc_audio_device *devs;
274 int nDevs, input, output, ring;
276 iaxc_audio_devices_get(&devs,&nDevs, &input, &output, &ring);
278 for(int i=0; i<nDevs; i++ ) {
279 SGPropertyNode *in_node = node->getChild("device", i, true);
282 _deviceID_node[i] = in_node->getChild("id", 0, true);
283 _deviceID_node[i]->setIntValue(devs[i].devID);
286 _deviceName_node[i] = in_node->getChild("name", 0, true);
287 _deviceName_node[i]->setStringValue(devs[i].name);
290 _deviceInput_node[i] = in_node->getChild("available-input", 0, true);
291 if( devs[i].capabilities & IAXC_AD_INPUT )
292 _deviceInput_node[i]->setBoolValue(true);
294 _deviceInput_node[i]->setBoolValue(false);
297 _deviceOutput_node[i] = in_node->getChild("available-output", 0, true);
298 if( devs[i].capabilities & IAXC_AD_OUTPUT )
299 _deviceOutput_node[i]->setBoolValue(true);
301 _deviceOutput_node[i]->setBoolValue(false);
303 // use default device at start
304 if( devs[i].capabilities & IAXC_AD_INPUT_DEFAULT )
305 _selectedInput_node->setIntValue(devs[i].devID);
306 if( devs[i].capabilities & IAXC_AD_OUTPUT_DEFAULT )
307 _selectedOutput_node->setIntValue(devs[i].devID);
310 // Mute the mic and set speaker at start
311 iaxc_input_level_set( 0.0 );
312 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
316 // Do the first call at start
317 const double freq = _comm0_node->getDoubleValue();
318 _currentFreqKhz = 10 * static_cast<int>(freq * 100 + 0.25);
319 std::string num = computePhoneNumber(freq, getAirportCode(freq));
321 _callComm0 = iaxc_call(num.c_str());
323 if( _callComm0 == -1 )
324 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
329 void FGCom::updateCall(bool& changed, int& callNo, double freqMHz)
332 _currentFreqKhz = 10 * static_cast<int>(freqMHz * 100 + 0.25);
335 if( !isInRange(freqMHz) ) {
336 iaxc_dump_call_number(callNo);
345 changed = false; // FIXME, out-params are confusing
348 iaxc_dump_call_number( callNo );
352 if(_p.elapsedMSec() > IAX_DELAY) {
353 std::string num = computePhoneNumber(freqMHz, getAirportCode(freqMHz));
354 if( !isInRange(freqMHz) )
357 callNo = iaxc_call(num.c_str());
360 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
369 void FGCom::update(double dt)
371 if ( !_enabled || !_initialized ) {
375 // For now we manage FGCom for only one freq because IAXClient
376 // is not able to handle multiple calls at same time.
377 if( _selectedComm == 0) {
378 updateCall(_comm0Changed, _callComm0, _comm0_node->getDoubleValue());
380 updateCall(_comm1Changed, _callComm0, _comm1_node->getDoubleValue());
386 void FGCom::shutdown()
392 _initialized = false;
395 iaxc_set_event_callback(NULL);
396 iaxc_unregister(_regId);
397 iaxc_stop_processing_thread();
400 assert( static_instance == this );
401 static_instance = NULL;
406 void FGCom::valueChanged(SGPropertyNode *prop)
408 if (prop == _enabled_node) {
409 bool isEnabled = prop->getBoolValue();
410 if (_enabled == isEnabled) {
423 if (prop == _ptt0_node && _enabled) {
424 if( _ptt0_node->getIntValue() == 2 ) {
425 if( _selectedComm == 0 ) {
426 SG_LOG( SG_IO, SG_INFO, "FGCom: change comm source to comm[1]" );
427 _comm1Changed = true;
430 SG_LOG( SG_IO, SG_INFO, "FGCom: change comm source to comm[0]" );
431 _comm0Changed = true;
436 if( _ptt0_node->getBoolValue() ) {
437 iaxc_output_level_set( 0.0 );
438 iaxc_input_level_set( _micLevel_node->getFloatValue() ); //0.0 = min , 1.0 = max
440 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
441 iaxc_input_level_set( 0.0 );
445 if (prop == _test_node) {
446 testMode( prop->getBoolValue() );
450 //FIXME: not implemented in IAX audio driver (audio_openal.c)
451 if (prop == _micBoost_node && _initialized) {
452 int micBoost = prop->getIntValue();
453 SG_CLAMP_RANGE<int>( micBoost, 0, 1 );
454 iaxc_mic_boost_set( micBoost ) ; // 0 = enabled , 1 = disabled
458 //FIXME: not implemented in IAX audio driver (audio_openal.c)
459 if ((prop == _selectedInput_node || prop == _selectedOutput_node) && _initialized) {
460 int selectedInput = _selectedInput_node->getIntValue();
461 int selectedOutput = _selectedOutput_node->getIntValue();
462 iaxc_audio_devices_set(selectedInput, selectedOutput, 0);
466 if (_listener_active)
471 if (prop == _speakerLevel_node && _enabled) {
472 float speakerLevel = prop->getFloatValue();
473 SG_CLAMP_RANGE<float>( speakerLevel, 0.0, 1.0 );
474 _speakerLevel_node->setFloatValue(speakerLevel);
475 //iaxc_output_level_set(speakerLevel);
478 if (prop == _micLevel_node && _enabled) {
479 float micLevel = prop->getFloatValue();
480 SG_CLAMP_RANGE<float>( micLevel, 0.0, 1.0 );
481 _micLevel_node->setFloatValue(micLevel);
482 //iaxc_input_level_set(micLevel);
485 if (prop == _comm0_node) {
486 if( _currentComm0 != prop->getDoubleValue() ) {
487 _currentComm0 = prop->getDoubleValue();
489 _comm0Changed = true;
493 if (prop == _comm1_node) {
494 if( _currentComm1 != prop->getDoubleValue() ) {
495 _currentComm1 = prop->getDoubleValue();
497 _comm1Changed = true;
506 void FGCom::testMode(bool testMode)
508 if(testMode && _initialized) {
510 iaxc_dump_all_calls();
511 iaxc_input_level_set( 1.0 );
512 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
513 std::string num = computePhoneNumber(TEST_FREQ, NULL_ICAO);
514 if( num.size() > 0 ) {
515 iaxc_millisleep(IAX_DELAY);
516 _callComm0 = iaxc_call(num.c_str());
518 if( _callComm0 == -1 )
519 SG_LOG( SG_IO, SG_DEBUG, "FGCom: cannot call " << num.c_str() );
522 iaxc_dump_all_calls();
523 iaxc_millisleep(IAX_DELAY);
524 iaxc_input_level_set( 0.0 );
525 iaxc_output_level_set( _speakerLevel_node->getFloatValue() );
535 \param freq The requested frequency e.g 120.825
536 \return The ICAO code as string e.g LFMV
539 std::string FGCom::getAirportCode(const double& freq)
541 SGGeod aircraftPos = globals->get_aircraft_position();
543 for(size_t i=0; i<sizeof(special_freq)/sizeof(special_freq[0]); i++) { // Check if it's a special freq
544 if(special_freq[i] == _currentFreqKhz) {
549 flightgear::CommStation* apt = flightgear::CommStation::findByFreq(_currentFreqKhz, aircraftPos);
551 return std::string();
554 if( apt->type() == FGPositioned::FREQ_TOWER ) {
555 _maxRange = MAX_TWR_RANGE;
556 _minRange = MIN_GNDTWR_RANGE;
557 } else if( apt->type() == FGPositioned::FREQ_GROUND ) {
558 _maxRange = MAX_GND_RANGE;
559 _minRange = MIN_GNDTWR_RANGE;
561 _maxRange = MAX_RANGE;
562 _minRange = MIN_RANGE;
565 _aptPos = apt->geod();
566 return apt->airport()->ident();
572 \param freq The requested frequency e.g 120.825
573 \param iaco The associated ICAO code e.g LFMV
574 \return The phone number as string i.e username:password@fgcom.flightgear.org/0176707786120825
577 std::string FGCom::computePhoneNumber(const double& freq, const std::string& icao) const
580 return std::string();
582 char phoneNumber[256];
586 /*Convert ICAO to ASCII */
587 sprintf( tmp, "%4s", icao.c_str() );
589 /*Built the phone number */
591 "%02d%02d%02d%02d%02d%06d",
597 (int) (freq * 1000 + 0.5) );
600 snprintf( phoneNumber,
601 sizeof (phoneNumber),
614 \return A boolean value, 1=in range, 0=out of range
617 bool FGCom::isInRange(const double &freq) const
619 for(size_t i=0; i<sizeof(special_freq)/sizeof(special_freq[0]); i++) { // Check if it's a special freq
620 if( (special_freq[i]) == _currentFreqKhz ) {
625 SGGeod acftPos = globals->get_aircraft_position();
626 double distNm = SGGeodesy::distanceNm(_aptPos, acftPos);
627 double delta_elevation_ft = fabs(acftPos.getElevationFt() - _aptPos.getElevationFt());
628 double rangeNm = 1.23 * sqrt(delta_elevation_ft);
630 if (rangeNm > _maxRange) rangeNm = _maxRange;
631 if (rangeNm < _minRange) rangeNm = _minRange;
632 if( distNm > rangeNm ) return 0;