]> git.mxchange.org Git - flightgear.git/blobdiff - src/ATCDCL/ATCVoice.cxx
VoiceSynthesizer: add some test/debug properties
[flightgear.git] / src / ATCDCL / ATCVoice.cxx
index 3648bfedd49f1ab7643b16f3edb01fc44d6f49a0..71f15e5876bf7ec63f6077f4bc1d392be49c1c68 100644 (file)
 #include "ATCVoice.hxx"
 
 #include <stdlib.h>
+#include <string.h>
 #include <ctype.h>
 #include <fstream>
-#include <list>
 #include <vector>
-
-#include <boost/shared_array.hpp>
+#include <algorithm>
 
 #include <simgear/sound/soundmgr_openal.hxx>
+#include <simgear/sound/sample_openal.hxx>
+#include <simgear/misc/sg_dir.hxx>
+
 #include <simgear/misc/sg_path.hxx>
 #include <simgear/debug/logstream.hxx>
 #include <simgear/misc/sgstream.hxx>
 
 #include <Main/globals.hxx>
 
-#include <stdio.h>
-
-#ifdef _MSC_VER
-#define strtok_r strtok_s
-#endif
-
 using namespace std;
 
-FGATCVoice::FGATCVoice() {
-  SoundData = 0;
-  rawSoundData = 0;
+FGATCVoice::FGATCVoice() :
+    rawSoundData(0),
+    rawDataSize(0),
+    SoundData(0)
+{
 }
 
 FGATCVoice::~FGATCVoice() {
     if (rawSoundData)
-       free( rawSoundData );
+        free( rawSoundData );
     delete SoundData;
 }
 
-// Load the two voice files - one containing the raw sound data (.wav) and one containing the word positions (.vce).
+// Load all data for the requested voice.
 // Return true if successful.
-bool FGATCVoice::LoadVoice(const string& voice) {
-       std::ifstream fin;
+bool FGATCVoice::LoadVoice(const string& voicename)
+{
+    rawDataSize = 0;
+    if (rawSoundData)
+        free(rawSoundData);
+    rawSoundData = NULL;
+
+    // determine voice directory
+    SGPath voicepath = globals->get_fg_root();
+    voicepath.append( "ATC" );
+    voicepath.append( "voices" );
+    voicepath.append( voicename );
+
+    simgear::Dir d(voicepath);
+    if (!d.exists())
+    {
+        SG_LOG(SG_ATC, SG_ALERT, "Unable to load ATIS voice. No such directory: " << voicepath.str());
+        return false;
+    }
+
+    // load all files from the voice's directory
+    simgear::PathList paths = d.children(simgear::Dir::TYPE_FILE);
+    bool Ok = false;
+    for (unsigned int i=0; i<paths.size(); ++i)
+    {
+        if (paths[i].lower_extension() == "vce")
+            Ok |= AppendVoiceFile(voicepath, paths[i].file_base());
+    }
+
+    if (!Ok)
+    {
+        SG_LOG(SG_ATC, SG_ALERT, "Unable to load ATIS voice. Files are invalid or no files in directory: " << voicepath.str());
+    }
+
+    // ok when at least some files loaded fine
+    return Ok;
+}
+
+// load a voice file and append it to the current word database
+bool FGATCVoice::AppendVoiceFile(const SGPath& basepath, const string& file)
+{
+    size_t offset = 0;
+
+    SG_LOG(SG_ATC, SG_INFO, "Loading ATIS voice file: " << file);
+
+    // path to compressed voice file
+    SGPath path(basepath);
+    path.append(file + ".wav.gz");
+
+    // load wave data
+    SGSoundMgr *smgr = globals->get_soundmgr();
+    int format, freq;
+    void *data;
+    size_t size;
+    if (!smgr->load(path.str(), &data, &format, &size, &freq))
+        return false;
+
+    // append to existing data
+    if (!rawSoundData)
+        rawSoundData = (char*)data;
+    else
+    {
+        rawSoundData = (char*) realloc(rawSoundData, rawDataSize + size);
+        // new data starts behind existing sound data
+        offset = rawDataSize;
+        if (!rawSoundData)
+        {
+            SG_LOG(SG_ATC, SG_ALERT, "Out of memory. Cannot load file " << path.str());
+            rawDataSize = 0;
+            return false;
+        }
+        // append to existing sound data
+        memcpy(rawSoundData+offset, data, size);
+        free(data);
+        data = NULL;
+    }
+    rawDataSize += size;
 
-       SGPath path = globals->get_fg_root();
-       string file = voice + ".wav";
-       path.append( "ATC" );
-       path.append( file );
-       
-       string full_path = path.str();
-       int format, freq;
-       SGSoundMgr *smgr = globals->get_soundmgr();
-       void *data;
-       if (!smgr->load(full_path, &data, &format, &rawDataSize, &freq))
-           return false;
-       rawSoundData = (char*)data;
 #ifdef VOICE_TEST
        cout << "ATCVoice:  format: " << format
                        << "  size: " << rawDataSize << endl;
-#endif 
-       path = globals->get_fg_root();
-       string wordPath = "ATC/" + voice + ".vce";
-       path.append(wordPath);
+#endif
+
+       // load and parse index file (.vce)
+       return ParseVoiceIndex(basepath, file, offset);
+}
+
+// Load and parse a voice index file (.vce)
+bool FGATCVoice::ParseVoiceIndex(const SGPath& basepath, const string& file, size_t globaloffset)
+{
+       // path to voice index file
+       SGPath path(basepath);
+       path.append(file + ".vce");
        
        // Now load the word data
+       std::ifstream fin;
        fin.open(path.c_str(), ios::in);
        if(!fin) {
                SG_LOG(SG_ATC, SG_ALERT, "Unable to open input file " << path.c_str());
                return(false);
        }
-       SG_LOG(SG_ATC, SG_INFO, "Opened word data file " << wordPath << " OK...");
+       SG_LOG(SG_ATC, SG_INFO, "Opened word data file " << path.c_str() << " OK...");
+
        char numwds[10];
        char wrd[100];
        string wrdstr;
@@ -100,38 +171,49 @@ bool FGATCVoice::LoadVoice(const string& voice) {
        unsigned int wrdOffset;         // Offset into the raw sound data that the word sample begins
        unsigned int wrdLength;         // Length of the word sample in bytes
        WordData wd;
+
+       // first entry: number of words in the index
        fin >> numwds;
        unsigned int numwords = atoi(numwds);
        //cout << numwords << '\n';
+
+       // now load each word, its file offset and length
        for(unsigned int i=0; i < numwords; ++i) {
+           // read data
                fin >> wrd;
-               wrdstr = wrd;
                fin >> wrdOffsetStr;
                fin >> wrdLengthStr;
+
+               wrdstr    = wrd;
                wrdOffset = atoi(wrdOffsetStr);
                wrdLength = atoi(wrdLengthStr);
-               wd.offset = wrdOffset;
+
+               // store word in map
+               wd.offset = wrdOffset + globaloffset;
                wd.length = wrdLength;
                wordMap[wrdstr] = wd;
-               string ws2 = wrdstr;
-               for(string::iterator p = ws2.begin(); p != ws2.end(); p++){
-                 *p = tolower(*p);
-                 if (*p == '-') *p = '_';
-               }
-               if (wrdstr != ws2)  wordMap[ws2] = wd;
+
+               // post-process words
+               string ws2 = wrdstr;
+               for(string::iterator p = ws2.begin(); p != ws2.end(); p++){
+                   *p = tolower(*p);
+                   if (*p == '-')
+                       *p = '_';
+               }
+
+               // store alternative version of word (lowercase/no hyphen)
+               if (wrdstr != ws2)
+                   wordMap[ws2] = wd;
 
                //cout << wrd << "\t\t" << wrdOffset << "\t\t" << wrdLength << '\n';
                //cout << i << '\n';
        }
-       
+
        fin.close();
        return(true);
 }
 
 
-typedef list < string > tokenList_type;
-typedef tokenList_type::iterator tokenList_iterator;
-
 // Given a desired message, return a string containing the
 // sound-sample data
 void* FGATCVoice::WriteMessage(const string& message, size_t* len) {
@@ -140,83 +222,76 @@ void* FGATCVoice::WriteMessage(const string& message, size_t* len) {
        // First - parse the message into a list of tokens.
        // Sort the tokens into those we understand and those we don't.
        // Add all the raw lengths of the token sound data, allocate enough space, and fill it with the rqd data.
-       tokenList_type tokenList;
-       tokenList_iterator tokenListItr;
-
-       // TODO - at the moment we're effectively taking 3 passes through the data.
-       // There is no need for this - 2 should be sufficient - we can probably ditch the tokenList.
-        char* msg = (char *)message.c_str();
-       char* token;
-       int numWords = 0;
+
+       vector<char> sound;
        const char delimiters[] = " \t.,;:\"\n";
-       char* context;
-       token = strtok_r(msg, delimiters, &context);
-       while(token != NULL) {
-               for (char *t = token; *t; t++) {
-                 *t = tolower(*t);     // canonicalize the case, to
-                 if (*t == '-') *t = '_';   // match what's in the index
-               }
-               tokenList.push_back(token);
-               ++numWords;
-               SG_LOG(SG_ATC, SG_DEBUG, "voice synth: token: '"
-                   << token << "'");
-               token = strtok_r(NULL, delimiters, &context);
-       }
+       string::size_type token_start = message.find_first_not_of(delimiters);
+       while(token_start != string::npos) {
+               string::size_type token_end = message.find_first_of(delimiters, token_start);
+               string token;
+               if (token_end == string::npos) {
+                       token = message.substr(token_start);
+                       token_start = string::npos;
+               } else {
+                       token = message.substr(token_start, token_end - token_start);
+                       token_start = message.find_first_not_of(delimiters, token_end);
+               }
+
+                if (token == "/_") continue;
 
-       vector<WordData> wdptr;
-       wdptr.reserve(numWords);
-       unsigned int cumLength = 0;
+               for(string::iterator t = token.begin(); t != token.end(); t++) {
+                       // canonicalize the token, to match what's in the index
+                       *t = (*t == '-') ? '_' : tolower(*t);
+               }
+               SG_LOG(SG_ATC, SG_DEBUG, "voice synth: token: '"
+                    << token << "'");
 
-       tokenListItr = tokenList.begin();
-       while(tokenListItr != tokenList.end()) {
-               if(wordMap.find(*tokenListItr) == wordMap.end()) {
-               // Oh dear - the token isn't in the sound file
-                 SG_LOG(SG_ATC, SG_DEBUG, "voice synth: word '"
-                     << *tokenListItr << "' not found");
+               atc_word_map_const_iterator wordIt = wordMap.find(token);
+               if(wordIt == wordMap.end()) {
+                       // Oh dear - the token isn't in the sound file
+                       SG_LOG(SG_ATC, SG_ALERT, "voice synth: word '"
+                               << token << "' not found");
                } else {
-                   wdptr.push_back(wordMap[*tokenListItr]);
-                   cumLength += wdptr.back().length;
+                       const WordData& word = wordIt->second;
+                       /*
+                       *  Sanity check for corrupt/mismatched sound data input - avoids a seg fault
+                       *  (As long as the calling function checks the return value!!)
+                       *  This check should be left in even when the default Flightgear files are known
+                       *  to be OK since it checks for mis-indexing of voice files by 3rd party developers.
+                       */
+                       if((word.offset + word.length) > rawDataSize) {
+                               SG_LOG(SG_ATC, SG_ALERT, "ERROR - mismatch between ATC .wav and .vce file in ATCVoice.cxx\n");
+                               SG_LOG(SG_ATC, SG_ALERT, "Offset + length: " << word.offset + word.length
+                                       << " exceeds rawdata size: " << rawDataSize << endl);
+
+                               *len = 0;
+                               return 0;
+                       }
+                       sound.insert(sound.end(), rawSoundData + word.offset, rawSoundData + word.offset + word.length);
                }
-               ++tokenListItr;
        }
-       const size_t word = wdptr.size();
-       
+
        // Check for no tokens found else slScheduler can be crashed
-       if(!word) {
+       *len = sound.size();
+       if (*len == 0) {
+               return 0;
+       }
+
+       char* data = (char*)malloc(*len);
+       if (data == 0) {
+               SG_LOG(SG_ATC, SG_ALERT, "ERROR - could not allocate " << *len << " bytes of memory for ATIS sound\n");
                *len = 0;
-               return NULL;
+               return 0;
        }
-       boost::shared_array<char> tmpbuf(new char[cumLength]);
-       unsigned int bufpos = 0;
-       for(int i=0; i<word; ++i) {
-               /*
-               *  Sanity check for corrupt/mismatched sound data input - avoids a seg fault
-               *  (As long as the calling function checks the return value!!)
-               *  This check should be left in even when the default Flightgear files are known
-               *  to be OK since it checks for mis-indexing of voice files by 3rd party developers.
-               */
-               if((wdptr[i].offset + wdptr[i].length) > rawDataSize) {
-                       SG_LOG(SG_ATC, SG_ALERT, "ERROR - mismatch between ATC .wav and .vce file in ATCVoice.cxx\n");
-                       SG_LOG(SG_ATC, SG_ALERT, "Offset + length: " << wdptr[i].offset + wdptr[i].length
-                            << " exceeds rawdata size: " << rawDataSize << endl);
-
-                       *len = 0;
-                       return NULL;
-               }
-               memcpy(tmpbuf.get() + bufpos, rawSoundData + wdptr[i].offset, wdptr[i].length);
-               bufpos += wdptr[i].length;
+
+       // randomize start position
+       unsigned int offsetIn = (unsigned int)(*len * sg_random());
+       if (offsetIn > 0 && offsetIn < *len) {
+               copy(sound.begin() + offsetIn, sound.end(), data);
+               copy(sound.begin(), sound.begin() + offsetIn, data + *len - offsetIn);
+       } else {
+               copy(sound.begin(), sound.end(), data);
        }
-       
-       // tmpbuf now contains the message starting at the beginning - but we want it to start at a random position.
-       unsigned int offsetIn = (int)(cumLength * sg_random());
-       if(offsetIn > cumLength) offsetIn = cumLength;
-
-       unsigned char *data = (unsigned char *)calloc(1, cumLength);
-       *len = cumLength;
-#if 0
-memcpy(data, tmpbuf.get() + offsetIn, cumLength - offsetIn);
-       memcpy(data + cumLength - offsetIn, tmpbuf.get(), offsetIn);
-#endif
 
        return data;
 }