1 // atis.cxx - routines to generate the ATIS info string
2 // This is the implementation of the FGATIS class
4 // Written by David Luff, started October 2001.
6 // Copyright (C) 2001 David C Luff - david.luff@nottingham.ac.uk
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 ///// TODO: _Cumulative_ sky coverage.
24 ///// TODO: wind _gust_
25 ///// TODO: more-sensible encoding of voice samples
26 ///// u-law? outright synthesis?
34 #include "atis_lexicon.hxx"
36 #include <simgear/compiler.h>
38 #include <stdlib.h> // atoi()
39 #include <stdio.h> // sprintf
43 #include <boost/tuple/tuple.hpp>
44 #include <boost/algorithm/string.hpp>
45 #include <boost/algorithm/string/case_conv.hpp>
48 #include <simgear/misc/sg_path.hxx>
50 #include <Environment/environment_mgr.hxx>
51 #include <Environment/environment.hxx>
52 #include <Environment/atmosphere.hxx>
54 #include <Main/fg_props.hxx>
55 #include <Main/globals.hxx>
56 #include <Airports/runways.hxx>
59 #include "commlist.hxx"
60 #include "ATCutils.hxx"
78 _vPtr = globals->get_ATC_mgr()->GetVoicePointer(ATIS);
79 _voiceOK = (_vPtr == NULL ? false : true);
80 if (!(_type != ATIS || _type == AWOS)) {
81 SG_LOG(SG_ATC, SG_ALERT, "ERROR - _type not ATIS or AWOS in atis.cxx");
83 fgTie("/environment/attention", this, (int_getter)0, &FGATIS::attend);
86 // FIXME: This would be more flexible and more extensible
87 // if the mappings were taken from an XML file, not hard-coded ...
88 // ... although having it in a .hxx file is better than nothing.
90 // Load the remap list from the .hxx file:
93 # define REMAP(from,to) _remap[#from] = to;
94 # include "atis_remap.hxx"
99 SG_LOG(SG_ATC, SG_ALERT, "ATIS initialized");
104 // http://localhost:5400/environment/attention?value=1&submit=update
107 fgUntie("/environment/attention");
110 void FGATIS::Init() {
111 // Nothing to see here. Move along.
115 FGATIS::attend (int attn)
119 int flag = fgGetInt("/sim/logging/atmo");
121 FGAltimeter().check_model();
122 FGAltimeter().dump_stack();
128 // Main update function - checks whether we are displaying or not the correct message.
129 void FGATIS::Update(double dt) {
130 cur_time = globals->get_time_params()->get_cur_time();
131 msg_OK = (msg_time < cur_time);
133 if (msg_OK || _display != _prev_display) {
134 cout << "ATIS Update: " << _display << " " << _prev_display
135 << " len: " << transmission.length()
136 << " oldvol: " << old_volume
137 << " dt: " << dt << endl;
143 for (map<string,int>::iterator act = active_on.begin();
144 act != active_on.end(); act++) {
145 string prop = "/instrumentation/" + act->first + "/volume";
146 volume += globals->get_props()->getDoubleValue(prop.c_str());
149 // Check if we need to update the message
150 // - basically every hour and if the weather changes significantly at the station
151 // If !_prev_display, the radio had been detuned for a while and our
152 // "transmission" variable was lost when we were de-instantiated.
153 int rslt = GenTransmission(!_prev_display, attention);
154 if (rslt || volume != old_volume) {
155 //cout << "ATIS calling ATC::render volume: " << volume << endl;
156 Render(transmission, volume, refname, true);
160 // We shouldn't be displaying
161 //cout << "ATIS.CXX - calling NoRender()..." << endl;
164 _prev_display = _display;
168 string uppercase(const string &s) {
170 for(string::iterator p = rslt.begin(); p != rslt.end(); p++){
176 // Replace all occurrences of a given word.
177 // Words in the original string must be separated by hyphens (not spaces).
178 // We check for the word as given, and for the all-caps version thereof.
179 string replace_word(const string _orig, const string _www, const string _nnn){
180 // The following are so we can match words at the beginning
181 // and end of the string.
182 string orig = "-" + _orig + "-";
183 string www = "-" + _www + "-";
184 string nnn = "-" + _nnn + "-";
187 for ( ; (where = orig.find(www, where)) != string::npos ; ) {
188 orig.replace(where, www.length(), nnn);
189 where += nnn.length();
192 www = uppercase(www);
193 for ( ; (where = orig.find(www, where)) != string::npos ; ) {
194 orig.replace(where, www.length(), nnn);
195 where += nnn.length();
197 where = orig.length();
198 return orig.substr(1, where-2);
201 // Normally the interval is 1 hour,
202 // but you can shorten it for testing.
203 const int minute(60); // measured in seconds
205 const int ATIS_interval(2*minute);
207 const int ATIS_interval(60*minute);
210 // Generate the actual broadcast ATIS transmission.
211 // Regen means regenerate the /current/ transmission.
212 // Special means generate a new transmission, with a new sequence.
213 // Returns 1 if we actually generated something.
214 int FGATIS::GenTransmission(const int regen, const int special) {
215 using namespace atmodel;
220 double tstamp = atof(fgGetString("sim/time/elapsed-sec"));
221 int interval = ATIS ? ATIS_interval : 2*minute; // AWOS updated frequently
222 int sequence = current_commlist->GetAtisSequence(ident,
223 tstamp, interval, special);
224 if (!regen && sequence > LTRS) {
225 //xx if (msg_OK) cout << "ATIS: no change: " << sequence << endl;
226 //xx msg_time = cur_time;
227 return 0; // no change since last time
232 string time_str = fgGetString("sim/time/gmt-string");
234 string phonetic_seq_string;
238 if (ident.substr(0,2) == "EG") {
239 // UK CAA radiotelephony manual indicates ATIS transmissions start
240 // with "This is ..."
241 transmission += This_is + " ";
243 // In the US they just start with the airport name.
246 // SG_LOG(SG_ATC, SG_ALERT, "ATIS: facility name: " << name);
248 // Note that at this point, multi-word facility names
249 // will sometimes contain hyphens, not spaces.
251 vector<string> name_words;
252 boost::split(name_words, name, boost::is_any_of(" -"));
254 for (vector<string>::const_iterator wordp = name_words.begin();
255 wordp != name_words.end(); wordp++) {
257 // Remap some abbreviations that occur in apt.dat, to
258 // make things nicer for the text-to-speech system:
259 for (MSS::const_iterator replace = _remap.begin();
260 replace != _remap.end(); replace++) {
261 // Due to inconsistent capitalisation in the apt.dat file, we need
262 // to do a case-insensitive comparison here.
263 string tmp1 = word, tmp2 = replace->first;
264 boost::algorithm::to_lower(tmp1);
265 boost::algorithm::to_lower(tmp2);
267 word = replace->second;
271 transmission += word + " ";
274 if (_type == ATIS /* as opposed to AWOS */) {
275 transmission += airport_information + " ";
277 transmission += Automated_weather_observation + " ";
280 phonetic_seq_string = GetPhoneticLetter(sequence); // Add the sequence letter
281 transmission += phonetic_seq_string + BRK;
283 // Warning - this is fragile if the time string format changes
284 hours = time_str.substr(0,2).c_str();
285 mins = time_str.substr(3,2).c_str();
286 // speak each digit separately:
287 transmission += ConvertNumToSpokenDigits(hours + mins);
288 transmission += " " + zulu + " " + weather + BRK;
290 transmission += wind + ": ";
292 double wind_speed = fgGetDouble("/environment/config/boundary/entry[0]/wind-speed-kt");
293 double wind_dir = fgGetDouble("/environment/config/boundary/entry[0]/wind-from-heading-deg");
294 while (wind_dir <= 0) wind_dir += 360;
295 // The following isn't as bad a kludge as it might seem.
296 // It combines the magvar at the /aircraft/ location with
297 // the wind direction in the environment/config array.
298 // But if the aircraft is close enough to the station to
299 // be receiving the ATIS signal, this should be a good-enough
300 // approximation. For more-distant aircraft, the wind_dir
301 // shouldn't be corrected anyway.
302 // The less-kludgy approach would be to use the magvar associated
303 // with the station, but that is not tabulated in the stationweather
304 // structure as it stands, and computing it would be expensive.
305 // Also note that as it stands, there is only one environment in
306 // the entire FG universe, so the aircraft environment is the same
307 // as the station environment anyway.
308 wind_dir -= fgGetDouble("/environment/magnetic-variation-deg"); // wind_dir now magnetic
309 if (wind_speed == 0) {
310 // Force west-facing rwys to be used in no-wind situations
311 // which is consistent with Flightgear's initial setup:
313 transmission += " " + light_and_variable;
315 // FIXME: get gust factor in somehow
316 snprintf(buf, bs, "%03.0f", 5*SGMiscd::round(wind_dir/5));
317 transmission += ConvertNumToSpokenDigits(buf);
319 snprintf(buf, bs, "%1.0f", wind_speed);
320 transmission += " " + at + " " + ConvertNumToSpokenDigits(buf) + BRK;
326 for (int layer = 0; layer <= 4; layer++) {
327 snprintf(buf, bs, "/environment/clouds/layer[%i]/coverage", layer);
328 string coverage = fgGetString(buf);
329 if (coverage == clear) continue;
330 snprintf(buf, bs, "/environment/clouds/layer[%i]/thickness-ft", layer);
331 if (fgGetDouble(buf) == 0) continue;
332 snprintf(buf, bs, "/environment/clouds/layer[%i]/elevation-ft", layer);
333 double ceiling = int(fgGetDouble(buf) - _geod.getElevationFt());
334 if (ceiling > 12000) continue;
335 if (coverage == scattered) {
336 if (!did_some) transmission += " " + Sky_condition + ": ";
338 } else /* must be a ceiling */ if (!did_ceiling) {
339 transmission += " " + Ceiling + ": ";
345 int cig00 = int(SGMiscd::round(ceiling/100)); // hundreds of feet
347 int cig000 = cig00/10;
348 cig00 -= cig000*10; // just the hundreds digit
350 snprintf(buf, bs, "%i", cig000);
351 transmission += ConvertNumToSpokenDigits(buf);
352 transmission += " " + thousand + " ";
355 snprintf(buf, bs, "%i", cig00);
356 transmission += ConvertNumToSpokenDigits(buf);
357 transmission += " " + hundred + " ";
360 // Should this be "sky obscured?"
361 transmission += " " + zero + " "; // not "zero hundred"
363 transmission += coverage + BRK;
366 transmission += Temperature + ": ";
367 double Tsl = fgGetDouble("/environment/temperature-sea-level-degc");
368 int temp = int(SGMiscd::round(FGAtmo().fake_T_vs_a_us(_geod.getElevationFt(), Tsl)));
370 transmission += lex::minus + " ";
372 snprintf(buf, bs, "%i", abs(temp));
373 transmission += ConvertNumToSpokenDigits(buf);
374 transmission += " " + Celsius;
375 transmission += " " + dewpoint + " ";
376 double dpsl = fgGetDouble("/environment/dewpoint-sea-level-degc");
377 temp = int(SGMiscd::round(FGAtmo().fake_dp_vs_a_us(dpsl, _geod.getElevationFt())));
379 transmission += lex::minus + " ";
381 snprintf(buf, bs, "%i", abs(temp));
382 transmission += ConvertNumToSpokenDigits(buf);
383 transmission += " " + Celsius + BRK;
385 transmission += Visibility + ": ";
386 double visibility = fgGetDouble("/environment/config/boundary/entry[0]/visibility-m");
387 visibility /= atmodel::sm; // convert to statute miles
388 if (visibility < 0.25) {
389 transmission += less_than_one_quarter;
390 } else if (visibility < 0.5) {
391 transmission += one_quarter;
392 } else if (visibility < 0.75) {
393 transmission += one_half;
394 } else if (visibility < 1.0) {
395 transmission += three_quarters;
396 } else if (visibility >= 1.5 && visibility < 2.0) {
397 transmission += one_and_one_half;
400 if (visibility > 10) visibility = 10;
401 sprintf(buf, "%i", int(.5 + visibility));
402 transmission += ConvertNumToSpokenDigits(buf);
406 transmission += Altimeter + ": ";
408 double Psl = fgGetDouble("/environment/pressure-sea-level-inhg");
412 tie(press, temp) = PT_vs_hpt(_geod.getElevationM(), Psl*inHg, Tsl + freezing);
414 SG_LOG(SG_ATC, SG_ALERT, "Field P: " << press << " T: " << temp);
415 SG_LOG(SG_ATC, SG_ALERT, "based on elev " << elev
419 myQNH = FGAtmo().QNH(_geod.getElevationM(), press);
421 if(ident.substr(0,2) == "EG" && fgGetBool("/sim/atc/use-millibars")) {
422 // Convert to millibars for the UK!
424 if (myQNH > 1000) myQNH -= 1000; // drop high digit
425 snprintf(buf, bs, "%03.0f", myQNH);
428 myQNH *= 100.; // shift two decimal places
429 snprintf(buf, bs, "%04.0f", myQNH);
431 transmission += ConvertNumToSpokenDigits(buf) + BRK;
433 if (_type == ATIS /* as opposed to AWOS */) {
434 const FGAirport* apt = fgFindAirportID(ident);
436 string rwy_no = apt->getActiveRunwayForUsage()->ident();
438 transmission += Landing_and_departing_runway + " ";
439 transmission += ConvertRwyNumToSpokenString(rwy_no) + BRK;
442 //cout << "In atis.cxx, r.rwy_no: " << rwy_no
443 // << " wind_dir: " << wind_dir << endl;
446 transmission += On_initial_contact_advise_you_have_information + " ";
447 transmission += phonetic_seq_string;
448 transmission += "... " + BRK;
451 cout << "**** ATIS active on:";
453 for (map<string,int>::iterator act = active_on.begin(); act != active_on.end(); act++){
454 string prop = "/instrumentation/" + act->first + "/atis";
455 globals->get_props()->setStringValue(prop.c_str(),
456 ("<pre>\n" + transmission + "</pre>\n").c_str());
462 cout << " ****" << endl;
463 cout << transmission << endl;
464 // Note that even if we aren't outputting the transmission
465 // on stdout, you can still see it by pointing a web browser
466 // at the property tree. The second comm radio is:
467 // http://localhost:5400/instrumentation/comm[1]
470 // Take the previous English-looking string and munge it to
471 // be relatively-more acceptable to the primitive tts system.
472 // Note that : ; and . are among the token-delimeters recognized
473 // by the tts system.
474 for (size_t where;;) {
475 where = transmission.find_first_of(":.");
476 if (where == string::npos) break;
477 transmission.replace(where, 1, " /_ ");