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>
45 runResponseCounter(false),
46 _runReleaseCounter(false),
50 // Transmission timing stuff
51 pending_transmission(""),
59 SGSoundMgr *smgr = globals->get_soundmgr();
60 _sgr = smgr->find("atc", true);
61 _sgr->tie_to_listener();
63 _volume = fgGetNode("/sim/sound/atc/volume", true);
64 _enabled = fgGetNode("/sim/sound/atc/enabled", true);
65 _atc_external = fgGetNode("/sim/sound/atc/external-view", true);
66 _internal = fgGetNode("/sim/current-view/internal", true);
72 // Derived classes wishing to use the response counter should
73 // call this from their own Update(...).
74 void FGATC::Update(double dt) {
75 if(runResponseCounter) {
76 //cout << responseCounter << '\t' << responseTime << '\n';
77 if(responseCounter >= responseTime) {
78 runResponseCounter = false;
80 //cout << "RESPOND\n";
82 responseCounter += dt;
86 if(_runReleaseCounter) {
87 if(_releaseCounter >= _releaseTime) {
89 _runReleaseCounter = false;
91 _releaseCounter += dt;
95 // Transmission stuff cribbed from AIPlane.cxx
98 //cout << "TUNED STATION FREQ CLEAR\n";
102 _transmitting = false;
104 if(_timeout > 0.0) { // allows count down to be avoided by initially setting it to zero
106 if(_timeout <= 0.0) {
109 // timed out - don't render.
115 #ifdef ENABLE_AUDIO_SUPPORT
116 bool active = _atc_external->getBoolValue() ||
117 _internal->getBoolValue();
119 if ( active && _enabled->getBoolValue() ) {
120 _sgr->set_volume( _volume->getFloatValue() );
121 _sgr->resume(); // no-op if already in resumed state
129 _max_count = 5.0; // FIXME - hardwired length of message - need to calculate it!
131 //cout << "Transmission = " << pending_transmission << '\n';
133 //Render(pending_transmission, ident, false);
134 Render(pending_transmission);
137 _transmitting = true;
138 } else if(_transmitting) {
139 if(_counter >= _max_count) {
140 //NoRender(plane.callsign); commented out since at the moment NoRender is designed just to stop repeating messages,
141 // and this will be primarily used on single messages.
142 _transmitting = false;
143 //if(tuned_station) tuned_station->NotifyTransmissionFinished(plane.callsign);
144 // TODO - need to let the plane the transmission is aimed at that it's finished.
145 // However, for now we'll just release the frequency since if we don't it all goes pear-shaped
146 _releaseCounter = 0.0;
148 _runReleaseCounter = true;
154 void FGATC::ReceiveUserCallback(int code) {
155 SG_LOG(SG_ATC, SG_WARN, "WARNING - whichever ATC class was intended to receive callback code " << code << " didn't get it!!!");
158 void FGATC::SetResponseReqd(const string& rid) {
161 respond = false; // TODO - this ignores the fact that more than one plane could call this before response
162 // Shouldn't happen with AI only, but user could confuse things??
164 runResponseCounter = true;
165 responseCounter = 0.0;
166 responseTime = 1.8; // TODO - randomize this slightly.
169 void FGATC::NotifyTransmissionFinished(const string& rid) {
170 //cout << "Transmission finished, callsign = " << rid << '\n';
174 runResponseCounter = true;
175 responseCounter = 0.0;
176 responseTime = 1.2; // TODO - randomize this slightly, and allow it to be dependent on the transmission and how busy the ATC is.
177 respond = false; // TODO - this ignores the fact that more than one plane could call this before response
178 // Shouldn't happen with AI only, but user could confuse things??
184 void FGATC::SetStation(flightgear::CommStation* sta) {
185 switch (sta->type()) {
186 case FGPositioned::FREQ_ATIS: _type = ATIS; break;
187 case FGPositioned::FREQ_AWOS: _type = AWOS; break;
189 throw sg_exception("unsupported comm station type");
194 range = sta->rangeNm();
195 ident = sta->airport()->ident();
196 name = sta->airport()->name();
197 freq = sta->freqKHz();
200 // Render a transmission
201 // Outputs the transmission either on screen or as audio depending on user preference
202 // The refname is a string to identify this sample to the sound manager
203 // The repeating flag indicates whether the message should be repeated continuously or played once.
204 void FGATC::Render(string& msg, const float volume,
205 const string& refname, const bool repeating) {
206 if (volume < 0.05) return;
209 fgSetString("/sim/messages/atis", msg.c_str());
211 fgSetString("/sim/messages/atc", msg.c_str());
213 #ifdef ENABLE_AUDIO_SUPPORT
214 _voice = (_voiceOK && fgGetBool("/sim/sound/voice"));
217 void* buf = _vPtr->WriteMessage((char*)msg.c_str(), &len);
221 // >>> Beware: must pass a (new) object to the (add) method,
222 // >>> because the (remove) method is going to do a (delete)
223 // >>> whether that's what you want or not.
224 SGSoundSample *simple = new SGSoundSample(&buf, len, 8000);
225 simple->set_volume(volume);
226 _sgr->add(simple, refname);
227 _sgr->play(refname, repeating);
228 } catch ( sg_io_exception &e ) {
229 SG_LOG(SG_GENERAL, SG_ALERT, e.getFormattedMessage());
233 #endif // ENABLE_AUDIO_SUPPORT
235 // first rip the underscores and the pause hints out of the string - these are for the convienience of the voice parser
236 for(unsigned int i = 0; i < msg.length(); ++i) {
237 if((msg.substr(i,1) == "_") || (msg.substr(i,1) == "/")) {
246 // Cease rendering a transmission.
247 void FGATC::NoRender(const string& refname) {
250 #ifdef ENABLE_AUDIO_SUPPORT
252 _sgr->remove(refname);
259 // Generate the text of a message from its parameters and the current context.
260 string FGATC::GenText(const string& m, int c) {
264 ostream& operator << (ostream& os, atc_type atc) {
266 case(AWOS): return(os << "AWOS");
267 case(ATIS): return(os << "ATIS");
268 case(GROUND): return(os << "GROUND");
269 case(TOWER): return(os << "TOWER");
270 case(APPROACH): return(os << "APPROACH");
271 case(DEPARTURE): return(os << "DEPARTURE");
272 case(ENROUTE): return(os << "ENROUTE");
273 case(INVALID): return(os << "INVALID");
275 return(os << "ERROR - Unknown switch in atc_type operator << ");
278 std::istream& operator >> ( std::istream& fin, ATCData& a )
301 return fin >> skipeol;
303 SG_LOG(SG_GENERAL, SG_ALERT, "Warning - unknown type \'" << tp << "\' found whilst reading ATC frequency data!\n");
305 return fin >> skipeol;
308 double lat, lon, elev;
310 fin >> lat >> lon >> elev >> f >> a.range >> a.ident;
311 a.geod = SGGeod::fromDegM(lon, lat, elev);
314 if(ch != '"') a.name += ch;
317 fin.unsetf(std::ios::skipws);
319 if((ch == '"') || (ch == 0x0A)) {
321 } // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
324 fin.setf(std::ios::skipws);
325 //cout << "Comm name = " << a.name << '\n';
327 a.freq = (int)(f*100.0 + 0.5);
329 // cout << a.ident << endl;
331 // generate cartesian coordinates
332 a.cart = SGVec3d::fromGeod(a.geod);
333 return fin >> skipeol;