src/ATC/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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include <simgear/sound/soundmgr.hxx>
  26
  27 #include <Main/globals.hxx>
  28 #include <Main/fg_props.hxx>
  29
  30 #include "ATC.hxx"
  31 #include "ATCdisplay.hxx"
  32
  33 FGATC::FGATC() {
  34         freqClear = true;
  35         receiving = false;
  36         respond = false;
  37         runResponseCounter = false;
  38         _runReleaseCounter = false;
  39         responseID = "";
  40         responseReqd = false;
  41         _type = INVALID;
  42         _display = false;
  43         _displaying = false;
  44
  45         // Transmission timing stuff
  46         pending_transmission = "";
  47         _timeout = 0;
  48         _pending = false;
  49         _callback_code = 0;
  50         _transmit = false;
  51         _transmitting = false;
  52         _counter = 0.0;
  53         _max_count = 5.0;
  54 }
  55
  56 FGATC::~FGATC() {
  57 }
  58
  59 // Derived classes wishing to use the response counter should call this from their own Update(...).
  60 void FGATC::Update(double dt) {
  61         if(runResponseCounter) {
  62                 //cout << responseCounter << '\t' << responseTime << '\n';
  63                 if(responseCounter >= responseTime) {
  64                         runResponseCounter = false;
  65                         respond = true;
  66                         //cout << "RESPOND\n";
  67                 } else {
  68                         responseCounter += dt;
  69                 }
  70         }
  71
  72         if(_runReleaseCounter) {
  73                 if(_releaseCounter >= _releaseTime) {
  74                         freqClear = true;
  75                         _runReleaseCounter = false;
  76                 } else {
  77                         _releaseCounter += dt;
  78                 }
  79         }
  80
  81         // Transmission stuff cribbed from AIPlane.cxx
  82         if(_pending) {
  83                 if(GetFreqClear()) {
  84                         //cout << "TUNED STATION FREQ CLEAR\n";
  85                         SetFreqInUse();
  86                         _pending = false;
  87                         _transmit = true;
  88                         _transmitting = false;
  89                 } else {
  90                         if(_timeout > 0.0) {    // allows count down to be avoided by initially setting it to zero
  91                                 _timeout -= dt;
  92                                 if(_timeout <= 0.0) {
  93                                         _timeout = 0.0;
  94                                         _pending = false;
  95                                         // timed out - don't render.
  96                                 }
  97                         }
  98                 }
  99         }
 100
 101         if(_transmit) {
 102                 _counter = 0.0;
 103                 _max_count = 5.0;               // FIXME - hardwired length of message - need to calculate it!
 104
 105                 //cout << "Transmission = " << pending_transmission << '\n';
 106                 if(_display) {
 107                         //Render(pending_transmission, ident, false);
 108                         // At the moment Render only works for ATIS
 109                         globals->get_ATC_display()->RegisterSingleMessage(pending_transmission);
 110                 }
 111                 // Run the callback regardless of whether on same freq as user or not.
 112                 //cout << "_callback_code = " << _callback_code << '\n';
 113                 if(_callback_code) {
 114                         ProcessCallback(_callback_code);
 115                 }
 116                 _transmit = false;
 117                 _transmitting = true;
 118         } else if(_transmitting) {
 119                 if(_counter >= _max_count) {
 120                         //NoRender(plane.callsign);  commented out since at the moment NoRender is designed just to stop repeating messages,
 121                         // and this will be primarily used on single messages.
 122                         _transmitting = false;
 123                         //if(tuned_station) tuned_station->NotifyTransmissionFinished(plane.callsign);
 124                         // TODO - need to let the plane the transmission is aimed at that it's finished.
 125                 }
 126                 _counter += dt;
 127         }
 128 }
 129
 130 void FGATC::ReceiveUserCallback(int code) {
 131         SG_LOG(SG_ATC, SG_WARN, "WARNING - whichever ATC class was intended to receive callback code " << code << " didn't get it!!!");
 132 }
 133
 134 void FGATC::SetResponseReqd(string rid) {
 135         receiving = false;
 136         responseReqd = true;
 137         respond = false;        // TODO - this ignores the fact that more than one plane could call this before response
 138                                                 // Shouldn't happen with AI only, but user could confuse things??
 139         responseID = rid;
 140         runResponseCounter = true;
 141         responseCounter = 0.0;
 142         responseTime = 1.8;             // TODO - randomize this slightly.
 143 }
 144
 145 void FGATC::NotifyTransmissionFinished(string rid) {
 146         //cout << "Transmission finished, callsign = " << rid << '\n';
 147         receiving = false;
 148         responseID = rid;
 149         if(responseReqd) {
 150                 runResponseCounter = true;
 151                 responseCounter = 0.0;
 152                 responseTime = 1.2;     // TODO - randomize this slightly, and allow it to be dependent on the transmission and how busy the ATC is.
 153                 respond = false;        // TODO - this ignores the fact that more than one plane could call this before response
 154                                                         // Shouldn't happen with AI only, but user could confuse things??
 155         } else {
 156                 freqClear = true;
 157         }
 158 }
 159
 160 void FGATC::Transmit(int callback_code) {
 161         SG_LOG(SG_ATC, SG_INFO, "Transmit called by " << ident << " " << _type << ", msg = " << pending_transmission);
 162         _pending = true;
 163         _callback_code = callback_code;
 164         _timeout = 0.0;
 165 }
 166
 167 void FGATC::ConditionalTransmit(double timeout, int callback_code) {
 168         SG_LOG(SG_ATC, SG_INFO, "Timed transmit called by " << ident << " " << _type << ", msg = " << pending_transmission);
 169         _pending = true;
 170         _callback_code = callback_code;
 171         _timeout = timeout;
 172 }
 173
 174 void FGATC::ImmediateTransmit(int callback_code) {
 175         SG_LOG(SG_ATC, SG_INFO, "Immediate transmit called by " << ident << " " << _type << ", msg = " << pending_transmission);
 176         if(_display) {
 177                 //Render(pending_transmission, ident, false);
 178                 // At the moment Render doesn't work except for ATIS
 179                 globals->get_ATC_display()->RegisterSingleMessage(pending_transmission);
 180         }
 181         if(callback_code) {
 182                 ProcessCallback(callback_code);
 183         }
 184 }
 185
 186 // Derived classes should override this.
 187 void FGATC::ProcessCallback(int code) {
 188 }
 189
 190 void FGATC::AddPlane(string pid) {
 191 }
 192
 193 int FGATC::RemovePlane() {
 194         return 0;
 195 }
 196
 197 void FGATC::SetData(ATCData* d) {
 198         lon = d->lon;
 199         lat = d->lat;
 200         elev = d->elev;
 201         x = d->x;
 202         y = d->y;
 203         z = d->z;
 204         range = d->range;
 205         ident = d->ident;
 206         name = d->name;
 207         freq = d->freq;
 208 }
 209
 210 // Render a transmission
 211 // Outputs the transmission either on screen or as audio depending on user preference
 212 // The refname is a string to identify this sample to the sound manager
 213 // The repeating flag indicates whether the message should be repeated continuously or played once.
 214 void FGATC::Render(string msg, string refname, bool repeating) {
 215         #ifdef ENABLE_AUDIO_SUPPORT
 216         voice = (voiceOK && fgGetBool("/sim/sound/audible")
 217         && fgGetBool("/sim/sound/voice"));
 218         if(voice) {
 219                 int len;
 220                 unsigned char* buf = vPtr->WriteMessage((char*)msg.c_str(), len, voice);
 221                 if(voice) {
 222                         SGSimpleSound* simple = new SGSimpleSound(buf, len);
 223                         // TODO - at the moment the volume is always set off comm1
 224                         // and can't be changed after the transmission has started.
 225                         simple->set_volume(5.0 * fgGetDouble("/radios/comm[0]/volume"));
 226                         globals->get_soundmgr()->add(simple, refname);
 227                         if(repeating) {
 228                                 globals->get_soundmgr()->play_looped(refname);
 229                         } else {
 230                                 globals->get_soundmgr()->play_once(refname);
 231                         }
 232                 }
 233                 delete[] buf;
 234         }
 235         #endif  // ENABLE_AUDIO_SUPPORT
 236         if(!voice) {
 237                 // first rip the underscores and the pause hints out of the string - these are for the convienience of the voice parser
 238                 for(unsigned int i = 0; i < msg.length(); ++i) {
 239                         if((msg.substr(i,1) == "_") || (msg.substr(i,1) == "/")) {
 240                                 msg[i] = ' ';
 241                         }
 242                 }
 243                 globals->get_ATC_display()->RegisterRepeatingMessage(msg);
 244         }
 245         playing = true;
 246 }
 247
 248
 249 // Cease rendering a transmission.
 250 void FGATC::NoRender(string refname) {
 251         if(playing) {
 252                 if(voice) {
 253                         #ifdef ENABLE_AUDIO_SUPPORT
 254                         globals->get_soundmgr()->stop(refname);
 255                         globals->get_soundmgr()->remove(refname);
 256                         #endif
 257                 } else {
 258                         globals->get_ATC_display()->CancelRepeatingMessage();
 259                 }
 260                 playing = false;
 261         }
 262 }
 263
 264 // Generate the text of a message from its parameters and the current context.
 265 string FGATC::GenText(const string& m, int c) {
 266         return("");
 267 }
 268
 269 ostream& operator << (ostream& os, atc_type atc) {
 270         switch(atc) {
 271                 case(INVALID):    return(os << "INVALID");
 272                 case(ATIS):       return(os << "ATIS");
 273                 case(GROUND):     return(os << "GROUND");
 274                 case(TOWER):      return(os << "TOWER");
 275                 case(APPROACH):   return(os << "APPROACH");
 276                 case(DEPARTURE):  return(os << "DEPARTURE");
 277                 case(ENROUTE):    return(os << "ENROUTE");
 278         }
 279         return(os << "ERROR - Unknown switch in atc_type operator << ");
 280 }