src/ATCDCL/ATC.cxx

   1 // Implementation of FGATC - ATC subsystem base class.
   2 //
   3 // Written by David Luff, started February 2002.
   4 //
   5 // Copyright (C) 2002  David C Luff - david.luff@nottingham.ac.uk
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include "ATC.hxx"
  26
  27 #include <iostream>
  28
  29 #include <simgear/sound/soundmgr_openal.hxx>
  30 #include <simgear/structure/exception.hxx>
  31
  32 #include <Main/globals.hxx>
  33 #include <Main/fg_props.hxx>
  34
  35
  36
  37 FGATC::FGATC() :
  38         _voiceOK(false),
  39         _sgr(NULL),
  40         freqClear(true),
  41         receiving(false),
  42         respond(false),
  43         responseID(""),
  44         runResponseCounter(false),
  45         _runReleaseCounter(false),
  46         responseReqd(false),
  47         _type(INVALID),
  48         _display(false),
  49         // Transmission timing stuff
  50         pending_transmission(""),
  51         _timeout(0),
  52         _pending(false),
  53         _callback_code(0),
  54         _transmit(false),
  55         _transmitting(false),
  56         _counter(0.0),
  57         _max_count(5.0)
  58 {
  59 }
  60
  61 FGATC::~FGATC() {
  62 }
  63
  64 // Derived classes wishing to use the response counter should
  65 // call this from their own Update(...).
  66 void FGATC::Update(double dt) {
  67         if(runResponseCounter) {
  68                 //cout << responseCounter << '\t' << responseTime << '\n';
  69                 if(responseCounter >= responseTime) {
  70                         runResponseCounter = false;
  71                         respond = true;
  72                         //cout << "RESPOND\n";
  73                 } else {
  74                         responseCounter += dt;
  75                 }
  76         }
  77
  78         if(_runReleaseCounter) {
  79                 if(_releaseCounter >= _releaseTime) {
  80                         freqClear = true;
  81                         _runReleaseCounter = false;
  82                 } else {
  83                         _releaseCounter += dt;
  84                 }
  85         }
  86
  87         // Transmission stuff cribbed from AIPlane.cxx
  88         if(_pending) {
  89                 if(GetFreqClear()) {
  90                         //cout << "TUNED STATION FREQ CLEAR\n";
  91                         SetFreqInUse();
  92                         _pending = false;
  93                         _transmit = true;
  94                         _transmitting = false;
  95                 } else {
  96                         if(_timeout > 0.0) {    // allows count down to be avoided by initially setting it to zero
  97                                 _timeout -= dt;
  98                                 if(_timeout <= 0.0) {
  99                                         _timeout = 0.0;
 100                                         _pending = false;
 101                                         // timed out - don't render.
 102                                 }
 103                         }
 104                 }
 105         }
 106
 107         if(_transmit) {
 108                 _counter = 0.0;
 109                 _max_count = 5.0;               // FIXME - hardwired length of message - need to calculate it!
 110
 111                 //cout << "Transmission = " << pending_transmission << '\n';
 112                 if(_display) {
 113                         //Render(pending_transmission, ident, false);
 114                         Render(pending_transmission);
 115                 }
 116                 // Run the callback regardless of whether on same freq as user or not.
 117                 //cout << "_callback_code = " << _callback_code << '\n';
 118                 if(_callback_code) {
 119                         ProcessCallback(_callback_code);
 120                 }
 121                 _transmit = false;
 122                 _transmitting = true;
 123         } else if(_transmitting) {
 124                 if(_counter >= _max_count) {
 125                         //NoRender(plane.callsign);  commented out since at the moment NoRender is designed just to stop repeating messages,
 126                         // and this will be primarily used on single messages.
 127                         _transmitting = false;
 128                         //if(tuned_station) tuned_station->NotifyTransmissionFinished(plane.callsign);
 129                         // TODO - need to let the plane the transmission is aimed at that it's finished.
 130                         // However, for now we'll just release the frequency since if we don't it all goes pear-shaped
 131                         _releaseCounter = 0.0;
 132                         _releaseTime = 0.9;
 133                         _runReleaseCounter = true;
 134                 }
 135                 _counter += dt;
 136         }
 137 }
 138
 139 void FGATC::ReceiveUserCallback(int code) {
 140         SG_LOG(SG_ATC, SG_WARN, "WARNING - whichever ATC class was intended to receive callback code " << code << " didn't get it!!!");
 141 }
 142
 143 void FGATC::SetResponseReqd(const string& rid) {
 144         receiving = false;
 145         responseReqd = true;
 146         respond = false;        // TODO - this ignores the fact that more than one plane could call this before response
 147                                                 // Shouldn't happen with AI only, but user could confuse things??
 148         responseID = rid;
 149         runResponseCounter = true;
 150         responseCounter = 0.0;
 151         responseTime = 1.8;             // TODO - randomize this slightly.
 152 }
 153
 154 void FGATC::NotifyTransmissionFinished(const string& rid) {
 155         //cout << "Transmission finished, callsign = " << rid << '\n';
 156         receiving = false;
 157         responseID = rid;
 158         if(responseReqd) {
 159                 runResponseCounter = true;
 160                 responseCounter = 0.0;
 161                 responseTime = 1.2;     // TODO - randomize this slightly, and allow it to be dependent on the transmission and how busy the ATC is.
 162                 respond = false;        // TODO - this ignores the fact that more than one plane could call this before response
 163                                                         // Shouldn't happen with AI only, but user could confuse things??
 164         } else {
 165                 freqClear = true;
 166         }
 167 }
 168
 169 void FGATC::Transmit(int callback_code) {
 170         SG_LOG(SG_ATC, SG_INFO, "Transmit called by " << ident << " " << _type << ", msg = " << pending_transmission);
 171         _pending = true;
 172         _callback_code = callback_code;
 173         _timeout = 0.0;
 174 }
 175
 176 void FGATC::ConditionalTransmit(double timeout, int callback_code) {
 177         SG_LOG(SG_ATC, SG_INFO, "Timed transmit called by " << ident << " " << _type << ", msg = " << pending_transmission);
 178         _pending = true;
 179         _callback_code = callback_code;
 180         _timeout = timeout;
 181 }
 182
 183 void FGATC::ImmediateTransmit(int callback_code) {
 184         SG_LOG(SG_ATC, SG_INFO, "Immediate transmit called by " << ident << " " << _type << ", msg = " << pending_transmission);
 185         if(_display) {
 186                 //Render(pending_transmission, ident, false);
 187                 Render(pending_transmission);
 188                 // At the moment Render doesn't work except for ATIS
 189         }
 190         if(callback_code) {
 191                 ProcessCallback(callback_code);
 192         }
 193 }
 194
 195 // Derived classes should override this.
 196 void FGATC::ProcessCallback(int code) {
 197 }
 198
 199 void FGATC::AddPlane(const string& pid) {
 200 }
 201
 202 int FGATC::RemovePlane() {
 203         return 0;
 204 }
 205
 206 void FGATC::SetData(ATCData* d) {
 207         _type = d->type;
 208         _geod = d->geod;
 209         _cart = d->cart;
 210         range = d->range;
 211         ident = d->ident;
 212         name = d->name;
 213         freq = d->freq;
 214 }
 215
 216 // Render a transmission
 217 // Outputs the transmission either on screen or as audio depending on user preference
 218 // The refname is a string to identify this sample to the sound manager
 219 // The repeating flag indicates whether the message should be repeated continuously or played once.
 220 void FGATC::Render(string& msg, const float volume,
 221                                    const string& refname, const bool repeating) {
 222         if (repeating)
 223                 fgSetString("/sim/messages/atis", msg.c_str());
 224         else
 225                 fgSetString("/sim/messages/atc", msg.c_str());
 226
 227 #ifdef ENABLE_AUDIO_SUPPORT
 228         _voice = (_voiceOK && fgGetBool("/sim/sound/voice"));
 229         if(_voice) {
 230                 string buf = _vPtr->WriteMessage((char*)msg.c_str(), _voice);
 231                 if(_voice && (volume > 0.05)) {
 232                         NoRender(refname);
 233                         try {
 234 // >>> Beware: must pass a (new) object to the (add) method,
 235 // >>> because the (remove) method is going to do a (delete)
 236 // >>> whether that's what you want or not.
 237                                 SGSoundSample *simple =
 238                                 new SGSoundSample((unsigned char*) buf.c_str(),  buf.length(), 8000);
 239                                 // TODO - at the moment the volume can't be changed
 240                                 // after the transmission has started.
 241                                 if (!_sgr) {
 242                                         SGSoundMgr *smgr;
 243                                         smgr = (SGSoundMgr *)globals->get_subsystem("soundmgr");
 244                                         _sgr = smgr->find("atc", true);
 245                                 }
 246                                 simple->set_volume(volume);
 247                                 _sgr->add(simple, refname);
 248                                 _sgr->play(refname, repeating);
 249                         } catch ( sg_io_exception &e ) {
 250                                 SG_LOG(SG_GENERAL, SG_ALERT, e.getFormattedMessage());
 251                         }
 252                 }
 253         }
 254 #endif  // ENABLE_AUDIO_SUPPORT
 255         if(!_voice) {
 256                 // first rip the underscores and the pause hints out of the string - these are for the convienience of the voice parser
 257                 for(unsigned int i = 0; i < msg.length(); ++i) {
 258                         if((msg.substr(i,1) == "_") || (msg.substr(i,1) == "/")) {
 259                                 msg[i] = ' ';
 260                         }
 261                 }
 262         }
 263         _playing = true;
 264 }
 265
 266
 267 // Cease rendering a transmission.
 268 void FGATC::NoRender(const string& refname) {
 269         if(_playing) {
 270                 if(_voice) {
 271 #ifdef ENABLE_AUDIO_SUPPORT
 272                         _sgr->stop(refname);
 273                         _sgr->remove(refname);
 274 #endif
 275                 }
 276                 _playing = false;
 277         }
 278 }
 279
 280 // Generate the text of a message from its parameters and the current context.
 281 string FGATC::GenText(const string& m, int c) {
 282         return("");
 283 }
 284
 285 ostream& operator << (ostream& os, atc_type atc) {
 286         switch(atc) {
 287                 case(AWOS):        return(os << "AWOS");
 288                 case(ATIS):        return(os << "ATIS");
 289                 case(GROUND):    return(os << "GROUND");
 290                 case(TOWER):      return(os << "TOWER");
 291                 case(APPROACH):   return(os << "APPROACH");
 292                 case(DEPARTURE):  return(os << "DEPARTURE");
 293                 case(ENROUTE):  return(os << "ENROUTE");
 294                 case(INVALID):  return(os << "INVALID");
 295         }
 296         return(os << "ERROR - Unknown switch in atc_type operator << ");
 297 }
 298
 299 std::istream& operator >> ( std::istream& fin, ATCData& a )
 300 {
 301         double f;
 302         char ch;
 303         char tp;
 304
 305         fin >> tp;
 306
 307         switch(tp) {
 308         case 'I':
 309                 a.type = ATIS;
 310                 break;
 311         case 'T':
 312                 a.type = TOWER;
 313                 break;
 314         case 'G':
 315                 a.type = GROUND;
 316                 break;
 317         case 'A':
 318                 a.type = APPROACH;
 319                 break;
 320         case '[':
 321                 a.type = INVALID;
 322                 return fin >> skipeol;
 323         default:
 324                 SG_LOG(SG_GENERAL, SG_ALERT, "Warning - unknown type \'" << tp << "\' found whilst reading ATC frequency data!\n");
 325                 a.type = INVALID;
 326                 return fin >> skipeol;
 327         }
 328
 329         double lat, lon, elev;
 330
 331         fin >> lat >> lon >> elev >> f >> a.range >> a.ident;
 332         a.geod = SGGeod::fromDegM(lon, lat, elev);
 333         a.name = "";
 334         fin >> ch;
 335         if(ch != '"') a.name += ch;
 336         while(1) {
 337                 //in >> noskipws
 338                 fin.unsetf(std::ios::skipws);
 339                 fin >> ch;
 340                 if((ch == '"') || (ch == 0x0A)) {
 341                         break;
 342                 }   // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
 343                 a.name += ch;
 344         }
 345         fin.setf(std::ios::skipws);
 346         //cout << "Comm name = " << a.name << '\n';
 347
 348         a.freq = (int)(f*100.0 + 0.5);
 349
 350         // cout << a.ident << endl;
 351
 352         // generate cartesian coordinates
 353         a.cart = SGVec3d::fromGeod(a.geod);
 354         return fin >> skipeol;
 355 }
 356