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/fg_props.hxx>
  28
  29 #include "ATC.hxx"
  30 #include "ATCdisplay.hxx"
  31
  32 FGATC::FGATC() {
  33         freqClear = true;
  34         receiving = false;
  35         respond = false;
  36         runResponseCounter = false;
  37         responseID = "";
  38         responseReqd = false;
  39 }
  40
  41 FGATC::~FGATC() {
  42 }
  43
  44 // Derived classes wishing to use the response counter should call this from their own Update(...).
  45 void FGATC::Update(double dt) {
  46         if(runResponseCounter) {
  47                 //cout << responseCounter << '\t' << responseTime << '\n';
  48                 if(responseCounter >= responseTime) {
  49                         runResponseCounter = false;
  50                         respond = true;
  51                         //cout << "RESPOND\n";
  52                 } else {
  53                         responseCounter += dt;
  54                 }
  55         }
  56 }
  57
  58 void FGATC::ReceiveUserCallback(int code) {
  59         SG_LOG(SG_ATC, SG_WARN, "WARNING - whichever ATC class was intended to receive callback code " << code << " didn't get it!!!");
  60 }
  61
  62 void FGATC::SetResponseReqd(string rid) {
  63         receiving = false;
  64         responseReqd = true;
  65         respond = false;        // TODO - this ignores the fact that more than one plane could call this before response
  66                                                 // Shouldn't happen with AI only, but user could confuse things??
  67         responseID = rid;
  68         runResponseCounter = true;
  69         responseCounter = 0.0;
  70         responseTime = 1.8;             // TODO - randomize this slightly.
  71 }
  72
  73 void FGATC::NotifyTransmissionFinished(string rid) {
  74         receiving = false;
  75         responseID = rid;
  76         if(responseReqd) {
  77                 runResponseCounter = true;
  78                 responseCounter = 0.0;
  79                 responseTime = 1.8;             // TODO - randomize this slightly.
  80         } else {
  81                 freqClear = true;
  82         }
  83 }
  84
  85 void FGATC::AddPlane(string pid) {
  86 }
  87
  88 int FGATC::RemovePlane() {
  89         return 0;
  90 }
  91
  92 void FGATC::SetDisplay() {
  93 }
  94
  95 void FGATC::SetNoDisplay() {
  96 }
  97
  98 atc_type FGATC::GetType() {
  99         return INVALID;
 100 }
 101
 102 void FGATC::SetData(ATCData* d) {
 103         lon = d->lon;
 104         lat = d->lat;
 105         elev = d->elev;
 106         x = d->x;
 107         y = d->y;
 108         z = d->z;
 109         range = d->range;
 110         ident = d->ident;
 111         name = d->name;
 112         freq = d->freq;
 113 }
 114
 115 // Render a transmission
 116 // Outputs the transmission either on screen or as audio depending on user preference
 117 // The refname is a string to identify this sample to the sound manager
 118 // The repeating flag indicates whether the message should be repeated continuously or played once.
 119 void FGATC::Render(string msg, string refname, bool repeating) {
 120         #ifdef ENABLE_AUDIO_SUPPORT
 121         voice = (voiceOK && fgGetBool("/sim/sound/audible")
 122         && fgGetBool("/sim/sound/voice"));
 123         if(voice) {
 124                 int len;
 125                 unsigned char* buf = vPtr->WriteMessage((char*)msg.c_str(), len, voice);
 126                 if(voice) {
 127                         SGSimpleSound* simple = new SGSimpleSound(buf, len);
 128                         // TODO - at the moment the volume is always set off comm1
 129                         // and can't be changed after the transmission has started.
 130                         simple->set_volume(5.0 * fgGetDouble("/radios/comm[0]/volume"));
 131                         globals->get_soundmgr()->add(simple, refname);
 132                         if(repeating) {
 133                                 globals->get_soundmgr()->play_looped(refname);
 134                         } else {
 135                                 globals->get_soundmgr()->play_once(refname);
 136                         }
 137                 }
 138                 delete[] buf;
 139         }
 140         #endif  // ENABLE_AUDIO_SUPPORT
 141         if(!voice) {
 142                 // first rip the underscores and the pause hints out of the string - these are for the convienience of the voice parser
 143                 for(unsigned int i = 0; i < msg.length(); ++i) {
 144                         if((msg.substr(i,1) == "_") || (msg.substr(i,1) == "/")) {
 145                                 msg[i] = ' ';
 146                         }
 147                 }
 148                 globals->get_ATC_display()->RegisterRepeatingMessage(msg);
 149         }
 150         playing = true;
 151 }
 152
 153
 154 // Cease rendering a transmission.
 155 void FGATC::NoRender(string refname) {
 156         if(playing) {
 157                 if(voice) {
 158                         #ifdef ENABLE_AUDIO_SUPPORT
 159                         globals->get_soundmgr()->stop(refname);
 160                         globals->get_soundmgr()->remove(refname);
 161                         #endif
 162                 } else {
 163                         globals->get_ATC_display()->CancelRepeatingMessage();
 164                 }
 165                 playing = false;
 166         }
 167 }
 168
 169 // Generate the text of a message from its parameters and the current context.
 170 string FGATC::GenText(const string& m, int c) {
 171         return("");
 172 }
 173
 174 ostream& operator << (ostream& os, atc_type atc) {
 175         switch(atc) {
 176                 case(INVALID):    return(os << "INVALID");
 177                 case(ATIS):       return(os << "ATIS");
 178                 case(GROUND):     return(os << "GROUND");
 179                 case(TOWER):      return(os << "TOWER");
 180                 case(APPROACH):   return(os << "APPROACH");
 181                 case(DEPARTURE):  return(os << "DEPARTURE");
 182                 case(ENROUTE):    return(os << "ENROUTE");
 183         }
 184         return(os << "ERROR - Unknown switch in atc_type operator << ");
 185 }