(Latest update is at http://www.cs.dal.ca/~lalita/festival/festivalXP.htm )

Compiling the Festival Speech Synthesis System Version 1.95 on Window XP SP2

Lalita Narupiyakul, 13 March 2006

Following my experience of compiling and installing the Festival Speech Synthesis v. 1.95 on Window XP, I wrote this instruction for people who might be interested to use The Festival Speech Synthesis system (Festival) [ref] developed by The Centre of Speech Technology Research, The University of Edinburgh. The Festival generally supports UNIX operating system and compatible with gcc 3.2, 3.3 and 3.4. The developers also provide a way to compile the Festival with Visual C++ v. 6.0. However, if we want to use the Festival on Win XP, we must put a lot of afford to configure, remark, and change some codes. Therefore, I wrote the short step-by-step instruction to install the Festival on Win XP.

System Requirements

• Window XP SP 2
• Visual C++ 6.0 SP 5
• New Cygwin DLL 1.5.19-4 release with GNU make v. 3.80 (http://www.cygwin.com/)
• Festival Speech Synthesis v. 1.95-beta (http://www.cstr.ed.ac.uk/projects/festival/)

1. Preparation Step

• I assume that you are already have window XP and installed Visual C++ v. 6.0
• Download Cygwin from http://www.cygwin.com/ and install Cygwin following the Cygwin’s manual. You have to make sure that the GNU make and gcc have been selected for installation.
• After the Cygwin’s installation completed, download the Festival 1.95 beta from http://www.cstr.ed.ac.uk/projects/festival/. You must download both festival-1.95-beta.tar.gz and speech_tools-1.2.95-beta.tar.gz.
• Download these files also: festlex_CMU.tar.gz, festlex_OALD.tar.gz, festlex_POSLEX.tar.gz, festvox_cmu_us_awb_arctic_hts.tar.gz, festvox_cmu_us_bdl_arctic_hts.tar.gz, festvox_cmu_us_jmk_arctic_hts.tar.gz, festvox_cmu_us_slt_arctic_hts.tar.gz, festvox_cstr_us_awb_arctic_multisyn-1.0.tar.gz, festvox_cstr_us_jmk_arctic_multisyn-1.0.tar.gz, festvox_don.tar.gz, festvox_ellpc11k.tar.gz, festvox_en1.tar.gz, festvox_kallpc16k.tar.gz, festvox_kallpc16k.tar.gz, , festvox_rablpc16k.tar.gz, festvox_us1.tar.gz, festvox_us2.tar.gz, festvox_us3.tar.gz

2. Unpacking festival and speech_tools

• Click start at Win XP and select Run…
• Print cmd and there will be a pop-up window with command prompt
• Print cd \cygwin (if you install Cygwin at “C:\Cygwin”)
• Print cygwin
• Check GNU make version by print make –v
• If you download festival-1.95-beta.tar.gz and speech_tools-1.2.95-beta.tar.gz. to this directory “c:\cygwin\home\username\fest\”, you print cd fest
• Extract files

• tar xvfz festival-1.95-beta.tar.gz
• tar xvfz speech_tools-1.2.95-beta.tar.gz
• tar xvfz festlex_OALD.tar.gz
• tar xvfz festlex_POSLEX.tar.gz
• tar xvfz festvox_cmu_us_awb_arctic_hts.tar.gz
• tar xvfz festvox_cmu_us_bdl_arctic_hts.tar.gz
• tar xvfz festvox_cmu_us_jmk_arctic_hts.tar.gz
• tar xvfz festvox_cmu_us_slt_arctic_hts.tar.gz
• tar xvfz festvox_cstr_us_awb_arctic_multisyn-1.0.tar.gz
• tar xvfz festvox_cstr_us_jmk_arctic_multisyn-1.0.tar.gz
• tar xvfz festvox_don.tar.gz
• tar xvfz festvox_ellpc11k.tar.gz
• tar xvfz festvox_en1.tar.gz
• tar xvfz festvox_kallpc16k.tar.gz
• tar xvfz festvox_kallpc16k.tar.gz
• tar xvfz festvox_rablpc16k.tar.gz
• tar xvfz festvox_us1.tar.gz
• tar xvfz festvox_us2.tar.gz
• tar xvfz festvox_us3.tar.gz

3. Creating Make file of festival and speech_tools for Visual C++

• Print cd speech_tools
• Print make VCMakefile
• Print cp config/vc_config_make_rules-dist config/vc_config_make_rules
• Print cd ../festival
• Print make VCMakefile
• Print cp config/vc_config_make_rules-dist config/vc_config_make_rules
• Print make –C src/modules init_modules.cc
• Edit the file vc_config_make_rules in directory festival/config
• At line SYSTEM_LIB=c:\\festival\\lib change to the current directory in your computer now. To see the current directory, print pwd
• For example: SYSTEM_LIB=c:\\festival\\lib change to SYSTEM_LIB=c:\\cygwin\\home\\username\\fest\\festival\\lib
• Save file vc_config_make_rules

4. Preparing Visual C++

• Click start at Win XP and select Run…
• Print cmd
• Print cd \Cygwin\home\username\fest\speech_tools
• Print vcvars32.bat

• If your machine cannot find vcvars.bat, you have to set path to Visual C++ directory in your machine
• To set PATH, you need to check setting PATH in your machine by print path if the Visual C++ directory (such as “C:\Program Files\Microsoft Visual Studio\VC98\Bin”) is not included in PATH then you have to set PATH
• To set PATH, print PATH %path%; “C:\Program Files\Microsoft Visual Studio\VC98\Bin”
• Now, you can print vcvars.bat

5. Compiling speech_tools

• EST_ServiceTable.cc

- Open and Edit file EST_ServiceTable.cc in directory speech_tools\utils\

- Go to the bottom of the file and looking for these lines

o Declare_KVL_T(EST_String, EST_ServiceTable::Entry, EST_String_ST_entry)

o #if defined(INSTANTIATE_TEMPLATES)

o #include "../base_class/EST_TList.cc"

o #include "../base_class/EST_TSortable.cc"

o #include "../base_class/EST_TKVL.cc"

o Instantiate_KVL_T(EST_String, EST_ServiceTable::Entry, EST_String_ST_entry)

o #endif

- Move these lines to the top of the file and paste them under this line no 47

o #include <time.h>

o Declare_KVL_T(EST_String, EST_ServiceTable::Entry, EST_String_ST_entry)

o #if defined(INSTANTIATE_TEMPLATES)

o #include "../base_class/EST_TList.cc"

o #include "../base_class/EST_TSortable.cc"

o #include "../base_class/EST_TKVL.cc"

o Instantiate_KVL_T(EST_String, EST_ServiceTable::Entry, EST_String_ST_entry)

o #endif

• list_i_t.cc

- Open and Edit list_i_t.cc in the directory speech_tools\base_class\inst_tmpl\

- Remark at line no. 50 Instantiate_TList(int)

o //Instantiate_TList(int)

- Save file

• vector_fvector_t.cc

- Open and Edit vector_fvector_t.cc in the directory speech_tools\base_class\inst_tmpl\

- Remark at line no. 49 Instantiate_TVector_T(EST_FVector, tvector_fvector)

o // Instantiate_TVector_T(EST_FVector, tvector_fvector)

- Save file

• Compile the speech_tools
• Select the dos window (at speech_tools directory)
• Print nmake /nologo /f VCMakefile (wait for a few minutes)

6. Buliding the Festival

• EST_JoinCostCache.cc

- Open and Edit EST_JoinCostCache.cc in the directory festival\src\modules\MultiSyn\

- Remark at line no. 45 #include <iostream>

o // #include <iostream>

- Save file

• EST_JoinCostCache.h

- Open and Edit EST_JoinCostCache.h in the directory festival\src\modules\MultiSyn\

- Remark at line no. 91, 92, and 93

static const unsigned char minVal = 0x0;

static const unsigned char maxVal = 0xff;

static const unsigned char defVal = 0xff;

- Change to …

//static const unsigned char minVal = 0x0;

//static const unsigned char maxVal = 0xff;

//static const unsigned char defVal = 0xff;

- Save file

• EST_JoinCostCache.cc

- Open and Edit EST_JoinCostCache.cc in the directory festival\src\modules\MultiSyn\

- At line no.

Line 91: return minVal;

Line 97: return defVal;

Line 135: unsigned int qleveln = maxVal-minVal;

Line 148: qcost = maxVal;

Line 150: qcost = minVal;

- Change to …

Line 91: return 0x0;

Line 97: return 0xff;

Line 135: unsigned int qleveln = 0xff -0x0;

Line 148: qcost = 0xff;

Line 150: qcost = 0x0;

- Save file

• us_diphone_index.cc

- Open and Edit us_diphone_index.cc in the directory festival\src\modules\ UniSyn_diphone \

- At line no.

Line 265: for (int i = 0; i < diph_index->diphone.n(); ++i)

Line 547: for (int j = 0; j < sub_coefs->num_frames(); ++j)

- Change to …

Line 265: int i; for ( i = 0; i < diph_index->diphone.n(); ++i)

Line 547: int j; for ( j = 0; j < sub_coefs->num_frames(); ++j)

- Save file

• us_prosody.cc

- Open and Edit us_prosody.cc in the directory festival\src\modules\ UniSyn\

- At line no.

Line 97: for( int i=0; i<fz_len; i++ ){

Line 205: for (int i = 0 ; i < f0.num_frames(); ++i)

- Change to …

Line 97: for( i=0; i<fz_len; i++ ){

Line 205: int i; for ( i = 0 ; i < f0.num_frames(); ++i)

- Save file

• us_mapping.cc

- Open and Edit usmapping.cc in the directory festival\src\modules\ UniSyn\

- At line no.

Line 208: for (int i = 0; i < pm_num_frames; ++i)

Line 232: for( int i=0; i<num_frames; ++i ){

Line 265: for( int i=0; i<left_start_index; ++i ){

Line 298: for( int i=left_start_index; i<right_end_index; ++i )

Lint 353: for( int i=0; i<smoothn; ++i )

Line 360: for( int i=0; i<smoothn; ++i )

Line 368: for( int i=left_start_index; i<right_end_index; ++i ){

Line 375: for( int i=left_start_index; i<right_end_index; ++i ){

Line 390: for( int i=left_start_index; i<target_pm_length; ++i )

Line 457: for( int i=0; i<left_start_index; ++i ){

Line 490: for( int i=left_start_index; i<right_end_index; ++i )

Line 545: for( int i=left_start_index; i<right_end_index; ++i ){

Line 560: for( int i=left_start_index; i<target_pm_length; ++i )

- Change to …

Line 208: int i; for ( i = 0; i < pm_num_frames; ++i)

Line 232: int i; for( i=0; i<num_frames; ++i ){

Line 265: int i; for( i=0; i<left_start_index; ++i ){

Line 298: for( i=left_start_index; i<right_end_index; ++i )

Lint 353: for( i=0; i<smoothn; ++i )

Line 360: for( i=0; i<smoothn; ++i )

Line 368: for( i=left_start_index; i<right_end_index; ++i ){

Line 375: for( i=left_start_index; i<right_end_index; ++i ){

Line 390: for( i=left_start_index; i<target_pm_length; ++i )

Line 457: int i; for( i=0; i<left_start_index; ++i ){

Line 490: for( i=left_start_index; i<right_end_index; ++i )

Line 545: for( i=left_start_index; i<right_end_index; ++i ){

Line 560: for( i=left_start_index; i<target_pm_length; ++i )

- Save file

• us_unit.cc

- Open and Edit us_unit.cc in the directory festival\src\modules\ UniSyn\

- At line no.

Line 534: for( int i=0; i<pp_length; ++i ){

Line 595: for( int i=smooth_start_index; i<=left_end_index; ++i, factor+=factor_incr ){

Line 603: for( int i=right_start_index; i<=smooth_end_index; ++i, factor+=factor_incr){

- Change to …

Line 534: int i; for( i=0; i<pp_length; ++i ){

Line 595: int i; for( i=smooth_start_index; i<=left_end_index; ++i, factor+=factor_incr ){

Line 603: for( i=right_start_index; i<=smooth_end_index; ++i, factor+=factor_incr){

- Save file

• EST_JoinCost.h

- Open and Edit EST_JoinCost.h in the directory festival\src\modules\ MultiSyn\

- At line no.

Line 190: for(int i = 0; i < l_length; i++)

- Change to …

Line 190: int i; for( i = 0; i < l_length; i++)

- Save file

• duffint.cc

- Open and Edit duffint.cc in the directory festival\src\modules\ Intonation\

- At line no.

Line 111: for (int i = 0; i < n_frames; ++ i)

- Change to …

Line 111: int i; for ( i = 0; i < n_frames; ++ i)

- Save file

• UnitSelection.cc

- Open and Edit unitSelection.cc in the directory festival\src\modules\ MultiSyn\

- At line no.

Line 205: if( DiphoneUnitVoice* duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_duv)) ){

Line 220: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(x)) ){

Line 233: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_voice)) ){

Line 246: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_voice)) ){

Line 257: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_voice)) ){

Line 272: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_voice)) )

Line 289: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_voice)) )

Line 316: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_voice)) )

Line 338: if( DiphoneVoiceModule *dvm = dynamic_cast<DiphoneVoiceModule*>(voice(l_vm)) ){

Line 354: if( DiphoneUnitVoice *duv = dynamic_cast<DiphoneUnitVoice*>(voice(l_vm)) ){

- Change to …

Line 205: if( DiphoneUnitVoice* duv = (DiphoneUnitVoice*)(voice(l_duv)) ){

Line 220: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(x)) ){

Line 233: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(l_voice)) ){

Line 246: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(l_voice)) ){

Line 257: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(l_voice)) ){

Line 272: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(l_voice)) )

Line 289: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(l_voice)) )

Line 316: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(l_voice)) )

Line 338: if( DiphoneVoiceModule *dvm = (DiphoneVoiceModule*) (voice(l_vm)) ){

Line 354: if( DiphoneUnitVoice *duv = (DiphoneUnitVoice*) (voice(l_vm)) ){

- Save file

• list_s_t.cc

- Open and Edit list_s_t.cc in the directory speech_tools\base_class\inst_tmpl\

- Remark at line no. 53 Instantiate_TList(EST_String)

o // Instantiate_TList(EST_String)

- Save file

• At Dos prompt, print ..\speech_tools\base_class\inst_tmpl
• Print nmake /nologo /f VCMakefile

• print ..\..\..\festival
• Print nmake /nologo /f VCMakefile

7. Run the Festival

• Print cd src\main

• Print festival
• Print (SatText “Hello World”)

8. Patch for the Festival on Windows XP

• If you do not want to follow the instruction, you can download this file and extract to a directory

• The instruction to extract and set up this file is coming soon
• Download festXP.tar.gz here (under construction)

Reference

• http://www.cstr.ed.ac.uk/projects/festival/
• http://www.bangor.ac.uk/~cbs204/festival/windows_build.txt
• http://festvox.org/docs/manual-1.4.3/festival_6.html#SEC14
• http://www.seas.upenn.edu/~mfickett/msinstall.txt
• https://lists.berlios.de/pipermail/festlang-talk/2005-May/000195.html

(Updated March 15, 2006)