src/ATC/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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 #ifndef _FG_ATC_VOICE
  22 #define _FG_ATC_VOICE
  23
  24 #include <simgear/compiler.h>
  25
  26 #if defined( SG_HAVE_STD_INCLUDES ) || defined( __BORLANDC__ ) || (__APPLE__)
  27 #  include <fstream>
  28 #  include <iostream>
  29 #else
  30 #  include <fstream.h>
  31 #  include <iostream.h>
  32 #endif
  33
  34 #include <map>
  35 #include <list>
  36 #include <string>
  37
  38 #include <simgear/sound/sample_openal.hxx>
  39
  40 SG_USING_STD(map);
  41 SG_USING_STD(list);
  42 SG_USING_STD(string);
  43
  44 SG_USING_STD(cout);
  45 SG_USING_STD(ios);
  46 SG_USING_STD(ofstream);
  47 SG_USING_STD(ifstream);
  48
  49
  50 struct WordData {
  51         unsigned int offset;    // Offset of beginning of word sample into raw sound sample
  52         unsigned int length;    // Byte length of word sample
  53 };
  54
  55 typedef map < string, WordData > atc_word_map_type;
  56 typedef atc_word_map_type::iterator atc_word_map_iterator;
  57 typedef atc_word_map_type::const_iterator atc_word_map_const_iterator;
  58
  59 class FGATCVoice {
  60
  61 public:
  62
  63         FGATCVoice();
  64         ~FGATCVoice();
  65
  66         // Load the two voice files - one containing the raw sound data (.wav) and one containing the word positions (.vce).
  67         // Return true if successful.
  68         bool LoadVoice(string voice);
  69
  70         // Given a desired message, return a pointer to the data buffer and write the buffer length into len.
  71         // Sets dataOK = true if the returned buffer is valid.
  72         unsigned char* WriteMessage(char* message, int& len, bool& dataOK);
  73
  74
  75 private:
  76
  77         // the sound and word position data
  78         char* rawSoundData;
  79         unsigned int rawDataSize;
  80         SGSoundSample *SoundData;
  81
  82         // A map of words vs. byte position and length in rawSoundData
  83         atc_word_map_type wordMap;
  84
  85 };
  86
  87 #endif  // _FG_ATC_VOICE