1 // Implementation of FGATC - ATC subsystem base class.
3 // Written by David Luff, started February 2002.
5 // Copyright (C) 2002 David C Luff - david.luff@nottingham.ac.uk
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.
29 #include <simgear/sound/soundmgr_openal.hxx>
30 #include <simgear/sound/sample_group.hxx>
31 #include <simgear/structure/exception.hxx>
33 #include <Main/globals.hxx>
34 #include <Main/fg_props.hxx>
35 #include <ATC/CommStation.hxx>
36 #include <Airports/airport.hxx>
40 _currentStation(NULL),
52 runResponseCounter(false),
53 _runReleaseCounter(false),
55 // Transmission timing stuff
56 pending_transmission(""),
65 SGSoundMgr *smgr = globals->get_soundmgr();
66 _sgr = smgr->find("atc", true);
67 _sgr->tie_to_listener();
69 _masterVolume = fgGetNode("/sim/sound/atc/volume", true);
70 _enabled = fgGetNode("/sim/sound/atc/enabled", true);
71 _atc_external = fgGetNode("/sim/sound/atc/external-view", true);
72 _internal = fgGetNode("/sim/current-view/internal", true);
79 // Derived classes wishing to use the response counter should
80 // call this from their own Update(...).
81 void FGATC::update(double dt) {
83 // TODO This doesn't really do anything specific to this instance.
84 // All FGATCs share the same "_sgr" sound group. So this really should
85 // only be done once for all FGATCs.
86 #ifdef ENABLE_AUDIO_SUPPORT
87 bool active = _atc_external->getBoolValue() ||
88 _internal->getBoolValue();
90 if ( active && _enabled->getBoolValue() ) {
91 _sgr->set_volume( _masterVolume->getFloatValue() );
92 _sgr->resume(); // no-op if already in resumed state
100 void FGATC::SetStation(flightgear::CommStation* sta) {
101 if (_currentStation == sta)
103 _currentStation = sta;
107 switch (sta->type()) {
108 case FGPositioned::FREQ_ATIS: _type = ATIS; break;
109 case FGPositioned::FREQ_AWOS: _type = AWOS; break;
124 update(0); // one last update
131 range = sta->rangeNm();
132 ident = sta->airport()->ident();
133 name = sta->airport()->name();
134 freq = sta->freqKHz();
139 // Render a transmission
140 // Outputs the transmission either on screen or as audio depending on user preference
141 // The refname is a string to identify this sample to the sound manager
142 // The repeating flag indicates whether the message should be repeated continuously or played once.
143 void FGATC::Render(std::string& msg, const float volume,
144 const std::string& refname, const bool repeating) {
145 if ((!_display) ||(volume < 0.05))
152 fgSetString("/sim/messages/atis", msg.c_str());
154 fgSetString("/sim/messages/atc", msg.c_str());
156 #ifdef ENABLE_AUDIO_SUPPORT
157 bool useVoice = _voice && fgGetBool("/sim/sound/voice") && fgGetBool("/sim/sound/atc/enabled");
158 SGSoundSample *simple = _sgr->find(refname);
160 if (simple && (_currentMsg == msg))
162 simple->set_volume(volume);
169 FGATCVoice* vPtr = GetVoicePointer();
171 buf = vPtr->WriteMessage((char*)msg.c_str(), &len);
175 // >>> Beware: must pass a (new) object to the (add) method,
176 // >>> because the (remove) method is going to do a (delete)
177 // >>> whether that's what you want or not.
178 simple = new SGSoundSample(&buf, len, 8000);
179 simple->set_volume(volume);
180 _sgr->add(simple, refname);
181 _sgr->play(refname, repeating);
182 } catch ( sg_io_exception &e ) {
183 SG_LOG(SG_ATC, SG_ALERT, e.getFormattedMessage());
194 bool useVoice = false;
195 #endif // ENABLE_AUDIO_SUPPORT
199 // first rip the underscores and the pause hints out of the string - these are for the convenience of the voice parser
200 for(unsigned int i = 0; i < msg.length(); ++i) {
201 if((msg.substr(i,1) == "_") || (msg.substr(i,1) == "/")) {
210 // Cease rendering a transmission.
211 void FGATC::NoRender(const std::string& refname) {
214 #ifdef ENABLE_AUDIO_SUPPORT
216 _sgr->remove(refname);
224 // Derived classes wishing to use the response counter should
225 // call this from their own Update(...).
226 void FGATC::Update(double dt) {
228 #ifdef ENABLE_AUDIO_SUPPORT
229 bool active = _atc_external->getBoolValue() ||
230 _internal->getBoolValue();
232 if ( active && _enabled->getBoolValue() ) {
233 _sgr->set_volume( _masterVolume->getFloatValue() );
234 _sgr->resume(); // no-op if already in resumed state
240 if(runResponseCounter) {
241 //cout << responseCounter << '\t' << responseTime << '\n';
242 if(responseCounter >= responseTime) {
243 runResponseCounter = false;
245 //cout << "RESPOND\n";
247 responseCounter += dt;
251 if(_runReleaseCounter) {
252 if(_releaseCounter >= _releaseTime) {
254 _runReleaseCounter = false;
256 _releaseCounter += dt;
260 // Transmission stuff cribbed from AIPlane.cxx
263 //cout << "TUNED STATION FREQ CLEAR\n";
267 _transmitting = false;
269 if(_timeout > 0.0) { // allows count down to be avoided by initially setting it to zero
271 if(_timeout <= 0.0) {
274 // timed out - don't render.
282 _max_count = 5.0; // FIXME - hardwired length of message - need to calculate it!
284 //cout << "Transmission = " << pending_transmission << '\n';
286 //Render(pending_transmission, ident, false);
287 Render(pending_transmission);
290 _transmitting = true;
291 } else if(_transmitting) {
292 if(_counter >= _max_count) {
293 //NoRender(plane.callsign); commented out since at the moment NoRender is designed just to stop repeating messages,
294 // and this will be primarily used on single messages.
295 _transmitting = false;
296 //if(tuned_station) tuned_station->NotifyTransmissionFinished(plane.callsign);
297 // TODO - need to let the plane the transmission is aimed at that it's finished.
298 // However, for now we'll just release the frequency since if we don't it all goes pear-shaped
299 _releaseCounter = 0.0;
301 _runReleaseCounter = true;
307 void FGATC::ReceiveUserCallback(int code) {
308 SG_LOG(SG_ATC, SG_WARN, "WARNING - whichever ATC class was intended to receive callback code " << code << " didn't get it!!!");
311 void FGATC::SetResponseReqd(const string& rid) {
314 respond = false; // TODO - this ignores the fact that more than one plane could call this before response
315 // Shouldn't happen with AI only, but user could confuse things??
317 runResponseCounter = true;
318 responseCounter = 0.0;
319 responseTime = 1.8; // TODO - randomize this slightly.
322 void FGATC::NotifyTransmissionFinished(const string& rid) {
323 //cout << "Transmission finished, callsign = " << rid << '\n';
327 runResponseCounter = true;
328 responseCounter = 0.0;
329 responseTime = 1.2; // TODO - randomize this slightly, and allow it to be dependent on the transmission and how busy the ATC is.
330 respond = false; // TODO - this ignores the fact that more than one plane could call this before response
331 // Shouldn't happen with AI only, but user could confuse things??
337 // Generate the text of a message from its parameters and the current context.
338 string FGATC::GenText(const string& m, int c) {
342 ostream& operator << (ostream& os, atc_type atc) {
344 case(AWOS): return(os << "AWOS");
345 case(ATIS): return(os << "ATIS");
346 case(GROUND): return(os << "GROUND");
347 case(TOWER): return(os << "TOWER");
348 case(APPROACH): return(os << "APPROACH");
349 case(DEPARTURE): return(os << "DEPARTURE");
350 case(ENROUTE): return(os << "ENROUTE");
351 case(INVALID): return(os << "INVALID");
353 return(os << "ERROR - Unknown switch in atc_type operator << ");
356 std::istream& operator >> ( std::istream& fin, ATCData& a )
379 return fin >> skipeol;
381 SG_LOG(SG_ATC, SG_ALERT, "Warning - unknown type \'" << tp << "\' found whilst reading ATC frequency data!\n");
383 return fin >> skipeol;
386 double lat, lon, elev;
388 fin >> lat >> lon >> elev >> f >> a.range >> a.ident;
389 a.geod = SGGeod::fromDegM(lon, lat, elev);
392 if(ch != '"') a.name += ch;
395 fin.unsetf(std::ios::skipws);
397 if((ch == '"') || (ch == 0x0A)) {
399 } // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
402 fin.setf(std::ios::skipws);
403 //cout << "Comm name = " << a.name << '\n';
405 a.freq = (int)(f*100.0 + 0.5);
407 // cout << a.ident << endl;
409 // generate cartesian coordinates
410 a.cart = SGVec3d::fromGeod(a.geod);
411 return fin >> skipeol;