src/Sound/morse.hxx

   1 // morse.hxx -- Morse code generation class
   2 //
   3 // Written by Curtis Olson, started March 2001.
   4 //
   5 // Copyright (C) 2001  Curtis L. Olson - http://www.flightgear.org/~curt
   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 // $Id$
  22
  23
  24 #ifndef _MORSE_HXX
  25 #define _MORSE_HXX
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include <config.h>
  29 #endif
  30
  31 #include <simgear/compiler.h>
  32 #include <simgear/sound/soundmgr_openal.hxx>
  33
  34
  35 // Quoting from http://www.kluft.com/~ikluft/ham/morse-intro.html by
  36 // Ian Kluft KO6YQ <ikluft@kluft.com>
  37 //
  38 // [begin quote]
  39 //
  40 // What is the Standard for Measuring Morse Code Speed?
  41 //
  42 // [This was adapted from the Ham Radio FAQ which used to be posted on UseNet.]
  43 //
  44 // The word PARIS was chosen as the standard length for CW code
  45 // speed. Each dit counts for one count, each dah counts for three
  46 // counts, intra-character spacing is one count, inter-character
  47 // spacing is three counts and inter-word spacing is seven counts, so
  48 // the word PARIS is exactly 50 counts:
  49 //
  50 // PPPPPPPPPPPPPP    AAAAAA    RRRRRRRRRR    IIIIII    SSSSSSSSSS
  51 // di  da  da  di    di  da    di  da  di    di  di    di  di  di
  52 // 1 1 3 1 3 1 1  3  1 1 3  3  1 1 3 1 1  3  1 1 1  3  1 1 1 1 1  7 = 50
  53 //   ^                      ^                                     ^
  54 //   ^Intra-character       ^Inter-character            Inter-word^
  55 //
  56 // So 5 words-per-minute = 250 counts-per-minute / 50 counts-per-word
  57 // or one count every 240 milliseconds. 13 words-per-minute is one
  58 // count every ~92.3 milliseconds. This method of sending code is
  59 // sometimes called "Slow Code", because at 5 wpm it sounds VERY SLOW.
  60 //
  61 // The "Farnsworth" method is accomplished by sending the dits and
  62 // dahs and intra-character spacing at a higher speed, then increasing
  63 // the inter-character and inter-word spacing to slow the sending
  64 // speed down to the desired speed. For example, to send at 5 wpm with
  65 // 13 wpm characters in Farnsworth method, the dits and
  66 // intra-character spacing would be 92.3 milliseconds, the dah would
  67 // be 276.9 milliseconds, the inter-character spacing would be 1.443
  68 // seconds and inter-word spacing would be 3.367 seconds.
  69 //
  70 // [end quote]
  71
  72 // Ok, back to Curt
  73
  74 // My formulation is based dit = 1 count, dah = 3 counts, 1 count for
  75 // intRA-character space, 3 counts for intER-character space.  Target
  76 // is 5 wpm which by the above means 1 count = 240 milliseconds.
  77 //
  78 // AIM 1-1-7 (f) states that the frequency of the tone should be 1020
  79 // Hz for the VOR ident.
  80
  81
  82 static const char DI = '1';
  83 static const char DIT = '1';
  84 static const char DA = '2';
  85 static const char DAH = '2';
  86 static const char END = '0';
  87
  88 static const int BYTES_PER_SECOND = 22050;
  89 // static const int BEAT_LENGTH = 240; // milleseconds (5 wpm)
  90 static const int BEAT_LENGTH = 92;  // milleseconds (13 wpm)
  91 static const int TRANSITION_BYTES = (int)(0.005 * BYTES_PER_SECOND);
  92 static const int COUNT_SIZE = BYTES_PER_SECOND * BEAT_LENGTH / 1000;
  93 static const int DIT_SIZE = 2 * COUNT_SIZE;   // 2 counts
  94 static const int DAH_SIZE = 4 * COUNT_SIZE;   // 4 counts
  95 static const int SPACE_SIZE = 3 * COUNT_SIZE; // 3 counts
  96 static const int LO_FREQUENCY = 1020;    // AIM 1-1-7 (f) specified in Hz
  97 static const int HI_FREQUENCY = 1350;    // AIM 1-1-7 (f) specified in Hz
  98
  99 // manages everything we need to know for an individual sound sample
 100 class FGMorse {
 101
 102 private:
 103
 104     unsigned char hi_dit[ DIT_SIZE ] ;
 105     unsigned char lo_dit[ DIT_SIZE ] ;
 106     unsigned char hi_dah[ DAH_SIZE ] ;
 107     unsigned char lo_dah[ DAH_SIZE ] ;
 108     unsigned char space[ SPACE_SIZE ] ;
 109
 110     unsigned char cust_dit[ DIT_SIZE ] ;
 111     unsigned char cust_dah[ DAH_SIZE ] ;
 112
 113     bool cust_init( const int freq );
 114
 115 public:
 116
 117     FGMorse();
 118     ~FGMorse();
 119
 120     // allocate and initialize sound samples
 121     bool init();
 122
 123     // make a SimpleSound morse code transmission for the specified string
 124     SGSoundSample *make_ident( const string& id,
 125                                const int freq = LO_FREQUENCY );
 126 };
 127
 128
 129 /**
 130  * \relates FGMorse
 131  * Make a tone of specified freq and total_len with trans_len ramp in
 132  * and out and only the first len bytes with sound, the rest with
 133  * silence.
 134  * @param buf unsigned char pointer to sound buffer
 135  * @param freq desired frequency of tone
 136  * @param len length of tone within sound
 137  * @param total_len total length of sound (anything more than len is padded
 138  *        with silence.
 139  * @param trans_len length of ramp up and ramp down to avoid audio "pop"
 140  */
 141 void make_tone( unsigned char *buf, int freq,
 142                 int len, int total_len, int trans_len );
 143
 144 #endif // _MORSE_HXX
 145
 146