src/Sound/beacon.hxx

   1 /**
   2  * \file beacon.hxx -- Provides marker beacon audio generation.
   3  */
   4
   5 // Written by Curtis Olson, started March 2001.
   6 //
   7 // Copyright (C) 2001  Curtis L. Olson - http://www.flightgear.org/~curt
   8 //
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License as
  11 // published by the Free Software Foundation; either version 2 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful, but
  15 // WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23
  24 #ifndef _BEACON_HXX
  25 #define _BEACON_HXX
  26
  27 #include "soundgenerator.hxx"
  28
  29 #include <simgear/compiler.h>
  30 #include <simgear/sound/soundmgr_openal.hxx>
  31 #include <simgear/structure/SGReferenced.hxx>
  32 #include <simgear/structure/SGSharedPtr.hxx>
  33
  34 // Quoting from http://www.smartregs.com/data/sa326.htm
  35 // Smart REGS Glossary - marker beacon
  36 //
  37 // An electronic navigation facility transmitting a 75 MHz vertical fan
  38 // or boneshaped radiation pattern.  Marker beacons are identified by
  39 // their modulation frequency and keying code, and when received by
  40 // compatible airborne equipment, indicate to the pilot, both aurally
  41 // and visually, that he is passing over the facility.
  42 // (See outer marker middle marker inner marker.)
  43 //
  44 // Smart REGS Glossary - outer marker
  45 //
  46 // A marker beacon at or near the glideslope intercept altitude of an
  47 // ILS approach.  It is keyed to transmit two dashes per second on a
  48 // 400 Hz tone, which is received aurally and visually by compatible
  49 // airborne equipment.  The OM is normally located four to seven miles from
  50 // the runway threshold on the extended centerline of the runway.
  51 //
  52 // Smart REGS Glossary - middle marker
  53 //
  54 // A marker beacon that defines a point along the glideslope of an
  55 // ILS normally located at or near the point of decision height
  56 // (ILS Category I).  It is keyed to transmit alternate dots and dashes,
  57 // with the alternate dots and dashes keyed at the rate of 95 dot/dash
  58 // combinations per minute on a 1300 Hz tone, which is received
  59 // aurally and visually by compatible airborne equipment.
  60 //
  61 // Smart REGS Glossary - inner marker
  62 //
  63 // A marker beacon used with an ILS (CAT II) precision approach located
  64 // between the middle marker and the end of the ILS runway,
  65 // transmitting a radiation pattern keyed at six dots per second and
  66 // indicating to the pilot, both aurally and visually, that he is at
  67 // the designated decision height (DH), normally 100 feet above the
  68 // touchdown zone elevation, on the ILS CAT II approach.  It also marks
  69 // progress during a CAT III approach.
  70 // (See instrument landing system) (Refer to AIM.)
  71
  72
  73 // manages everything we need to know for an individual sound sample
  74 class FGBeacon : public FGSoundGenerator {
  75
  76 private:
  77     static const int INNER_FREQ = 3000;
  78     static const int MIDDLE_FREQ = 1300;
  79     static const int OUTER_FREQ = 400;
  80
  81     static const int INNER_SIZE = BYTES_PER_SECOND;
  82     static const int MIDDLE_SIZE = (int)(BYTES_PER_SECOND * 60 / 95 );
  83     static const int OUTER_SIZE = BYTES_PER_SECOND;
  84
  85     static const int INNER_DIT_LEN = (int)(BYTES_PER_SECOND / 6.0);
  86     static const int MIDDLE_DIT_LEN = (int)(MIDDLE_SIZE / 3.0);
  87     static const int MIDDLE_DAH_LEN = (int)(MIDDLE_SIZE * 2 / 3.0);
  88     static const int OUTER_DAH_LEN = (int)(BYTES_PER_SECOND / 2.0);
  89
  90     SGSharedPtr<SGSoundSample> inner;
  91     SGSharedPtr<SGSoundSample> middle;
  92     SGSharedPtr<SGSoundSample> outer;
  93
  94     // allocate and initialize sound samples
  95     bool init();
  96     static FGBeacon * _instance;
  97 public:
  98
  99     FGBeacon();
 100     ~FGBeacon();
 101     static FGBeacon * instance();
 102
 103     SGSoundSample *get_inner() { return inner; }
 104     SGSoundSample *get_middle() { return middle; }
 105     SGSoundSample *get_outer() { return outer; }
 106
 107 };
 108
 109
 110
 111 #endif // _BEACON_HXX
 112
 113