src/ATCDCL/ATCVoice.hxx

   1 // FGATCVoice.hxx - a class to encapsulate an ATC voice
   2 //
   3 // Written by David Luff, started November 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 #ifndef _FG_ATC_VOICE
  22 #define _FG_ATC_VOICE
  23
  24 #include <simgear/compiler.h>
  25
  26 #  include <fstream>
  27 #include <map>
  28 #include <list>
  29 #include <string>
  30
  31 #include <simgear/sound/sample_openal.hxx>
  32
  33 using std::map;
  34 using std::list;
  35 using std::string;
  36
  37
  38 struct WordData {
  39         unsigned int offset;    // Offset of beginning of word sample into raw sound sample
  40         unsigned int length;    // Byte length of word sample
  41 };
  42
  43 typedef std::map < std::string, WordData > atc_word_map_type;
  44 typedef atc_word_map_type::iterator atc_word_map_iterator;
  45 typedef atc_word_map_type::const_iterator atc_word_map_const_iterator;
  46
  47 class FGATCVoice {
  48
  49 public:
  50
  51         FGATCVoice();
  52         ~FGATCVoice();
  53
  54         // Load the two voice files - one containing the raw sound data (.wav) and one containing the word positions (.vce).
  55         // Return true if successful.
  56         bool LoadVoice(const std::string& voice);
  57
  58         // Given a desired message, return a pointer to the data buffer and write the buffer length into len.
  59         // Sets dataOK = true if the returned buffer is valid.
  60         unsigned char* WriteMessage(char* message, int& len, bool& dataOK);
  61
  62
  63 private:
  64
  65         // the sound and word position data
  66         char* rawSoundData;
  67         unsigned int rawDataSize;
  68         SGSoundSample *SoundData;
  69
  70         // A map of words vs. byte position and length in rawSoundData
  71         atc_word_map_type wordMap;
  72
  73 };
  74
  75 #endif  // _FG_ATC_VOICE