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/structure/exception.hxx>
32 #include <Main/globals.hxx>
33 #include <Main/fg_props.hxx>
34 #include <ATC/CommStation.hxx>
35 #include <Airports/simple.hxx>
39 _currentStation(NULL),
49 runResponseCounter(false),
50 _runReleaseCounter(false),
52 // Transmission timing stuff
53 pending_transmission(""),
66 SGSoundMgr *smgr = globals->get_soundmgr();
67 _sgr = smgr->find("atc", true);
68 _sgr->tie_to_listener();
70 _masterVolume = fgGetNode("/sim/sound/atc/volume", true);
71 _enabled = fgGetNode("/sim/sound/atc/enabled", true);
72 _atc_external = fgGetNode("/sim/sound/atc/external-view", true);
73 _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 #ifdef ENABLE_AUDIO_SUPPORT
84 bool active = _atc_external->getBoolValue() ||
85 _internal->getBoolValue();
87 if ( active && _enabled->getBoolValue() ) {
88 _sgr->set_volume( _masterVolume->getFloatValue() );
89 _sgr->resume(); // no-op if already in resumed state
96 if(runResponseCounter) {
97 //cout << responseCounter << '\t' << responseTime << '\n';
98 if(responseCounter >= responseTime) {
99 runResponseCounter = false;
101 //cout << "RESPOND\n";
103 responseCounter += dt;
107 if(_runReleaseCounter) {
108 if(_releaseCounter >= _releaseTime) {
110 _runReleaseCounter = false;
112 _releaseCounter += dt;
116 // Transmission stuff cribbed from AIPlane.cxx
119 //cout << "TUNED STATION FREQ CLEAR\n";
123 _transmitting = false;
125 if(_timeout > 0.0) { // allows count down to be avoided by initially setting it to zero
127 if(_timeout <= 0.0) {
130 // timed out - don't render.
138 _max_count = 5.0; // FIXME - hardwired length of message - need to calculate it!
140 //cout << "Transmission = " << pending_transmission << '\n';
142 //Render(pending_transmission, ident, false);
143 Render(pending_transmission);
146 _transmitting = true;
147 } else if(_transmitting) {
148 if(_counter >= _max_count) {
149 //NoRender(plane.callsign); commented out since at the moment NoRender is designed just to stop repeating messages,
150 // and this will be primarily used on single messages.
151 _transmitting = false;
152 //if(tuned_station) tuned_station->NotifyTransmissionFinished(plane.callsign);
153 // TODO - need to let the plane the transmission is aimed at that it's finished.
154 // However, for now we'll just release the frequency since if we don't it all goes pear-shaped
155 _releaseCounter = 0.0;
157 _runReleaseCounter = true;
165 void FGATC::ReceiveUserCallback(int code) {
166 SG_LOG(SG_ATC, SG_WARN, "WARNING - whichever ATC class was intended to receive callback code " << code << " didn't get it!!!");
169 void FGATC::SetResponseReqd(const string& rid) {
172 respond = false; // TODO - this ignores the fact that more than one plane could call this before response
173 // Shouldn't happen with AI only, but user could confuse things??
175 runResponseCounter = true;
176 responseCounter = 0.0;
177 responseTime = 1.8; // TODO - randomize this slightly.
180 void FGATC::NotifyTransmissionFinished(const string& rid) {
181 //cout << "Transmission finished, callsign = " << rid << '\n';
185 runResponseCounter = true;
186 responseCounter = 0.0;
187 responseTime = 1.2; // TODO - randomize this slightly, and allow it to be dependent on the transmission and how busy the ATC is.
188 respond = false; // TODO - this ignores the fact that more than one plane could call this before response
189 // Shouldn't happen with AI only, but user could confuse things??
196 void FGATC::SetStation(flightgear::CommStation* sta) {
197 if (_currentStation == sta)
199 _currentStation = sta;
203 switch (sta->type()) {
204 case FGPositioned::FREQ_ATIS: _type = ATIS; break;
205 case FGPositioned::FREQ_AWOS: _type = AWOS; break;
220 Update(0); // one last update
227 range = sta->rangeNm();
228 ident = sta->airport()->ident();
229 name = sta->airport()->name();
230 freq = sta->freqKHz();
235 // Render a transmission
236 // Outputs the transmission either on screen or as audio depending on user preference
237 // The refname is a string to identify this sample to the sound manager
238 // The repeating flag indicates whether the message should be repeated continuously or played once.
239 void FGATC::Render(string& msg, const float volume,
240 const string& refname, const bool repeating) {
241 if ((!_display) ||(volume < 0.05))
248 fgSetString("/sim/messages/atis", msg.c_str());
250 fgSetString("/sim/messages/atc", msg.c_str());
252 #ifdef ENABLE_AUDIO_SUPPORT
253 bool useVoice = _voice && fgGetBool("/sim/sound/voice") && fgGetBool("/sim/sound/atc/enabled");
254 SGSoundSample *simple = _sgr->find(refname);
256 if (simple && (_currentMsg == msg))
258 simple->set_volume(volume);
266 _vPtr = GetVoicePointer();
268 buf = _vPtr->WriteMessage((char*)msg.c_str(), &len);
272 // >>> Beware: must pass a (new) object to the (add) method,
273 // >>> because the (remove) method is going to do a (delete)
274 // >>> whether that's what you want or not.
275 simple = new SGSoundSample(&buf, len, 8000);
276 simple->set_volume(volume);
277 _sgr->add(simple, refname);
278 _sgr->play(refname, repeating);
279 } catch ( sg_io_exception &e ) {
280 SG_LOG(SG_ATC, SG_ALERT, e.getFormattedMessage());
290 #endif // ENABLE_AUDIO_SUPPORT
294 // first rip the underscores and the pause hints out of the string - these are for the convenience of the voice parser
295 for(unsigned int i = 0; i < msg.length(); ++i) {
296 if((msg.substr(i,1) == "_") || (msg.substr(i,1) == "/")) {
305 // Cease rendering a transmission.
306 void FGATC::NoRender(const string& refname) {
309 #ifdef ENABLE_AUDIO_SUPPORT
311 _sgr->remove(refname);
319 // Generate the text of a message from its parameters and the current context.
320 string FGATC::GenText(const string& m, int c) {
324 ostream& operator << (ostream& os, atc_type atc) {
326 case(AWOS): return(os << "AWOS");
327 case(ATIS): return(os << "ATIS");
328 case(GROUND): return(os << "GROUND");
329 case(TOWER): return(os << "TOWER");
330 case(APPROACH): return(os << "APPROACH");
331 case(DEPARTURE): return(os << "DEPARTURE");
332 case(ENROUTE): return(os << "ENROUTE");
333 case(INVALID): return(os << "INVALID");
335 return(os << "ERROR - Unknown switch in atc_type operator << ");
338 std::istream& operator >> ( std::istream& fin, ATCData& a )
361 return fin >> skipeol;
363 SG_LOG(SG_ATC, SG_ALERT, "Warning - unknown type \'" << tp << "\' found whilst reading ATC frequency data!\n");
365 return fin >> skipeol;
368 double lat, lon, elev;
370 fin >> lat >> lon >> elev >> f >> a.range >> a.ident;
371 a.geod = SGGeod::fromDegM(lon, lat, elev);
374 if(ch != '"') a.name += ch;
377 fin.unsetf(std::ios::skipws);
379 if((ch == '"') || (ch == 0x0A)) {
381 } // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
384 fin.setf(std::ios::skipws);
385 //cout << "Comm name = " << a.name << '\n';
387 a.freq = (int)(f*100.0 + 0.5);
389 // cout << a.ident << endl;
391 // generate cartesian coordinates
392 a.cart = SGVec3d::fromGeod(a.geod);
393 return fin >> skipeol;