src/ATCDCL/atis.cxx

   1 // atis.cxx - routines to generate the ATIS info string
   2 // This is the implementation of the FGATIS class
   3 //
   4 // Written by David Luff, started October 2001.
   5 //
   6 // Copyright (C) 2001  David C Luff - david.luff@nottingham.ac.uk
   7 //
   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.
  12 //
  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.
  17 //
  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.
  21
  22 /////
  23 ///// TODO:  _Cumulative_ sky coverage.
  24 ///// TODO:  wind _gust_
  25 ///// TODO:  more-sensible encoding of voice samples
  26 /////       u-law?  outright synthesis?
  27 /////
  28
  29 #ifdef HAVE_CONFIG_H
  30 #  include <config.h>
  31 #endif
  32
  33 #include "atis.hxx"
  34 #include "atis_lexicon.hxx"
  35
  36 #include <simgear/compiler.h>
  37
  38 #include <stdlib.h> // atoi()
  39 #include <stdio.h>  // sprintf
  40 #include <string>
  41 #include <iostream>
  42
  43 #include <boost/tuple/tuple.hpp>
  44 #include <boost/algorithm/string.hpp>
  45 #include <boost/algorithm/string/case_conv.hpp>
  46
  47
  48 #include <simgear/misc/sg_path.hxx>
  49
  50 #include <Environment/environment_mgr.hxx>
  51 #include <Environment/environment.hxx>
  52 #include <Environment/atmosphere.hxx>
  53
  54 #include <Main/fg_props.hxx>
  55 #include <Main/globals.hxx>
  56 #include <Airports/runways.hxx>
  57
  58
  59 #include "commlist.hxx"
  60 #include "ATCutils.hxx"
  61 #include "ATCmgr.hxx"
  62
  63 using std::cout;
  64 using std::cout;
  65 using boost::ref;
  66 using boost::tie;
  67
  68 FGATIS::FGATIS() :
  69   transmission(""),
  70   trans_ident(""),
  71   old_volume(0),
  72   atis_failed(false),
  73   msg_OK(0),
  74   attention(0),
  75   _prev_display(0),
  76   refname("atis")
  77 {
  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");
  82   }
  83   fgTie("/environment/attention", this, (int_getter)0, &FGATIS::attend);
  84
  85 ///////////////
  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.
  89 //
  90 // Load the remap list from the .hxx file:
  91   using namespace lex;
  92 # define NIL ""
  93 # define REMAP(from,to) _remap[#from] = to;
  94 # include "atis_remap.hxx"
  95 # undef REMAP
  96 # undef NIL
  97
  98 #ifdef ATIS_TEST
  99   SG_LOG(SG_ATC, SG_ALERT, "ATIS initialized");
 100 #endif
 101 }
 102
 103 // Hint:
 104 // http://localhost:5400/environment/attention?value=1&submit=update
 105
 106 FGATIS::~FGATIS() {
 107   fgUntie("/environment/attention");
 108 }
 109
 110 void FGATIS::Init() {
 111 // Nothing to see here.  Move along.
 112 }
 113
 114 void
 115 FGATIS::attend (int attn)
 116 {
 117   attention = attn;
 118 #ifdef ATMO_TEST
 119   int flag = fgGetInt("/sim/logging/atmo");
 120   if (flag) {
 121     FGAltimeter().check_model();
 122         FGAltimeter().dump_stack();
 123   }
 124 #endif
 125 }
 126
 127
 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);
 132 #ifdef ATIS_TEST
 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;
 138     msg_time = cur_time;
 139   }
 140 #endif
 141   if(_display) {
 142     double volume(0);
 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());
 147     }
 148
 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);
 157       old_volume = volume;
 158     }
 159   } else {
 160 // We shouldn't be displaying
 161     //cout << "ATIS.CXX - calling NoRender()..." << endl;
 162     NoRender(refname);
 163   }
 164   _prev_display = _display;
 165   attention = 0;
 166 }
 167
 168 string uppercase(const string &s) {
 169   string rslt(s);
 170   for(string::iterator p = rslt.begin(); p != rslt.end(); p++){
 171     *p = toupper(*p);
 172   }
 173   return rslt;
 174 }
 175
 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 + "-";
 185
 186   size_t where(0);
 187   for ( ; (where = orig.find(www, where)) != string::npos ; ) {
 188     orig.replace(where, www.length(), nnn);
 189     where += nnn.length();
 190   }
 191
 192   www = uppercase(www);
 193   for ( ; (where = orig.find(www, where)) != string::npos ; ) {
 194     orig.replace(where, www.length(), nnn);
 195     where += nnn.length();
 196   }
 197   where = orig.length();
 198   return orig.substr(1, where-2);
 199 }
 200
 201 // Normally the interval is 1 hour,
 202 // but you can shorten it for testing.
 203 const int minute(60);           // measured in seconds
 204 #ifdef ATIS_TEST
 205   const int ATIS_interval(2*minute);
 206 #else
 207   const int ATIS_interval(60*minute);
 208 #endif
 209
 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;
 216   using namespace lex;
 217
 218   string BRK = ".\n";
 219
 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
 228   }
 229
 230   const int bs(100);
 231   char buf[bs];
 232   string time_str = fgGetString("sim/time/gmt-string");
 233   string hours, mins;
 234   string phonetic_seq_string;
 235
 236   transmission = "";
 237
 238   if (ident.substr(0,2) == "EG") {
 239 // UK CAA radiotelephony manual indicates ATIS transmissions start
 240 // with "This is ..."
 241     transmission += This_is + " ";
 242   } else {
 243     // In the US they just start with the airport name.
 244   }
 245
 246   // SG_LOG(SG_ATC, SG_ALERT, "ATIS: facility name: " << name);
 247
 248 // Note that at this point, multi-word facility names
 249 // will sometimes contain hyphens, not spaces.
 250
 251   vector<string> name_words;
 252   boost::split(name_words, name, boost::is_any_of(" -"));
 253
 254   for (vector<string>::const_iterator wordp = name_words.begin();
 255                 wordp != name_words.end(); wordp++) {
 256     string word(*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);
 266       if (tmp1 == tmp2) {
 267         word = replace->second;
 268         break;
 269       }
 270     }
 271     transmission += word + " ";
 272   }
 273
 274   if (_type == ATIS /* as opposed to AWOS */) {
 275     transmission += airport_information + " ";
 276   } else {
 277     transmission += Automated_weather_observation + " ";
 278   }
 279
 280   phonetic_seq_string = GetPhoneticLetter(sequence);  // Add the sequence letter
 281   transmission += phonetic_seq_string + BRK;
 282
 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;
 289
 290   transmission += wind + ": ";
 291
 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:
 312       wind_dir = 270;
 313       transmission += " " + light_and_variable;
 314   } else {
 315       // FIXME: get gust factor in somehow
 316       snprintf(buf, bs, "%03.0f", 5*SGMiscd::round(wind_dir/5));
 317       transmission += ConvertNumToSpokenDigits(buf);
 318
 319       snprintf(buf, bs, "%1.0f", wind_speed);
 320       transmission += " " + at + " " + ConvertNumToSpokenDigits(buf) + BRK;
 321   }
 322
 323   int did_some(0);
 324   int did_ceiling(0);
 325
 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 + ": ";
 337       did_some++;
 338     } else /* must be a ceiling */  if (!did_ceiling) {
 339       transmission += "   " + Ceiling + ": ";
 340       did_ceiling++;
 341       did_some++;
 342     } else {
 343       transmission += "   ";
 344     }
 345     int cig00  = int(SGMiscd::round(ceiling/100));  // hundreds of feet
 346     if (cig00) {
 347       int cig000 = cig00/10;
 348       cig00 -= cig000*10;       // just the hundreds digit
 349       if (cig000) {
 350     snprintf(buf, bs, "%i", cig000);
 351     transmission += ConvertNumToSpokenDigits(buf);
 352     transmission += " " + thousand + " ";
 353       }
 354       if (cig00) {
 355     snprintf(buf, bs, "%i", cig00);
 356     transmission += ConvertNumToSpokenDigits(buf);
 357     transmission += " " + hundred + " ";
 358       }
 359     } else {
 360       // Should this be "sky obscured?"
 361       transmission += " " + zero + " ";     // not "zero hundred"
 362     }
 363     transmission += coverage + BRK;
 364   }
 365
 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)));
 369   if(temp < 0) {
 370       transmission += lex::minus + " ";
 371   }
 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())));
 378   if(temp < 0) {
 379       transmission += lex::minus + " ";
 380   }
 381   snprintf(buf, bs, "%i", abs(temp));
 382   transmission += ConvertNumToSpokenDigits(buf);
 383   transmission += " " + Celsius + BRK;
 384
 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;
 398   } else {
 399     // integer miles
 400     if (visibility > 10) visibility = 10;
 401     sprintf(buf, "%i", int(.5 + visibility));
 402     transmission += ConvertNumToSpokenDigits(buf);
 403   }
 404   transmission += BRK;
 405
 406   transmission += Altimeter + ": ";
 407   double myQNH;
 408   double Psl = fgGetDouble("/environment/pressure-sea-level-inhg");
 409   {
 410     double press, temp;
 411
 412     tie(press, temp) = PT_vs_hpt(_geod.getElevationM(), Psl*inHg, Tsl + freezing);
 413 #if 0
 414     SG_LOG(SG_ATC, SG_ALERT, "Field P: " << press << "  T: " << temp);
 415     SG_LOG(SG_ATC, SG_ALERT, "based on elev " << elev
 416                                 << "  Psl: " << Psl
 417                                 << "  Tsl: " << Tsl);
 418 #endif
 419     myQNH = FGAtmo().QNH(_geod.getElevationM(), press);
 420   }
 421   if(ident.substr(0,2) == "EG" && fgGetBool("/sim/atc/use-millibars")) {
 422     // Convert to millibars for the UK!
 423     myQNH /= mbar;
 424     if  (myQNH > 1000) myQNH -= 1000;       // drop high digit
 425     snprintf(buf, bs, "%03.0f", myQNH);
 426   } else {
 427     myQNH /= inHg;
 428     myQNH *= 100.;                        // shift two decimal places
 429     snprintf(buf, bs, "%04.0f", myQNH);
 430   }
 431   transmission += ConvertNumToSpokenDigits(buf) + BRK;
 432
 433   if (_type == ATIS /* as opposed to AWOS */) {
 434       const FGAirport* apt = fgFindAirportID(ident);
 435       assert(apt);
 436         string rwy_no = apt->getActiveRunwayForUsage()->ident();
 437       if(rwy_no != "NN") {
 438         transmission += Landing_and_departing_runway + " ";
 439         transmission += ConvertRwyNumToSpokenString(rwy_no) + BRK;
 440         if (msg_OK) {
 441           msg_time = cur_time;
 442           //cout << "In atis.cxx, r.rwy_no: " << rwy_no
 443           //   << " wind_dir: " << wind_dir << endl;
 444         }
 445     }
 446     transmission += On_initial_contact_advise_you_have_information + " ";
 447     transmission += phonetic_seq_string;
 448     transmission += "... " + BRK;
 449   }
 450 #ifdef ATIS_TEST
 451   cout << "**** ATIS active on:";
 452 #endif
 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());
 457 #ifdef ATIS_TEST
 458     cout << "  " << prop;
 459 #endif
 460   }
 461 #ifdef ATIS_TEST
 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]
 468 #endif
 469
 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, " /_ ");
 478   }
 479   return 1;
 480 }