========================================================================

			 ---  OGIresLPC  ---

		     OGI Residual LPC Synthesizer
			    version 2.0.9
			      Oct 2000

		     http://cslu.cse.ogi.edu/tts

		    Mike Macon <macon@ee.ogi.edu>
		   Andrew Cronk <cronk@cse.ogi.edu>
		  Alexander Kain <kain@cse.ogi.edu>
		 Johan Wouters <wouters@cse.ogi.edu>

   This file is additional code NOT INCLUDED with the Festival TTS
	system as distributed by CSTR/University of Edinburgh.

			  Copyright (c) 2000
	       Center for Spoken Language Understanding
	  Oregon Graduate Institute of Science & Technology

Please see the file "license_ogi_tts.txt" for information on usage and
       redistribution, and for a DISCLAIMER OF ALL WARRANTIES.

========================================================================


DESCRIPTION
-----------

This package is a drop-in module for the Festival TTS system created
by CSTR at the University of Edinburgh.  This version of OGIresLPC has
been designed to work with Festival version 1.4.1, released Dec 1999.
It is meant to serve as a simple baseline synthesizer in the CSLU
Toolkit and for other projects.

If you have ftp'ed all the files, the distribution includes the following
 1) OGIresLPC-2.0.9.tar.gz -- the C++ and Scheme code
 2) OGIfestpatch-1.4.1.2.tar.gz -- some patches to Festival
 3) OGIlexicon-2.0.tar.gz -- a pronunciation lexicon that started as 
     a union of CMUdict and Moby, many entries changed since.
 4) a bunch of voices:
	voice_mwm_di-2.0.tar.gz -- American male voice
	voice_aec_di-2.0.tar.gz -- American male voice
	voice_jph_di-2.0.tar.gz -- American male voice
	voice_tll_di-2.0.tar.gz -- American female voice
	voice_ogirab_di-2.0.tar.gz -- British English male voice using diphones from CSTR
	voice_convert_di-2.0.tar.gz -- TLL and JPH voices mapped from MWM using
                                       a voice conversion technique
 
You must first install the OGIresLPC package in order to use the
voices. Festival itself is available from CSTR at
http://www.cstr.ed.ac.uk/projects/festival.html.

INSTALLATION
------------
OGIresLPC:
1) Uncompress and unpack all the tar files in the directory above festival/
   This will unpack the synthesizer code into your existing festival 
   installation.
2) Add the following lines to the file festival/config/config
          ALSO_INCLUDE += OGIcommon
          ALSO_INCLUDE += OGIdbase
          ALSO_INCLUDE += OGIresLPC
3) cd to the festival/ directory and remake festival.  You should see
   the make routine compiling the new code in the festival/src/modules/OGIresLPC
   directory and festival/src/modules/OGIcommon directory.  If not, 'make clean' 
   on your whole installation and start over.
4) Be sure you have unpacked everything (except perhaps the voices)
   from the Edinburgh distribution - specifically, the 
   *POSLEX.tar files (found in the CSTR ftp dir where you 
   got Festival).
5) When festival is restarted, the commands (voice_???_diphone)
   with ??? replaced by the particular voice names above should be available 
   in Festival.
6) If you unpack new voices at a later time, no recompilation is needed.


USING VOICES
------------
When properly installed, you should be able to issue the festival commands  
   festival> (voice_???_diphone)
where ??? is one of {mwm, aec, jph, tll, mwm2tll, mwm2jph, ogirab}, depending 
on which of the optional modules you have installed.  Subsequent 
synthesis will then use the selected voice.

Notes:

1) The voices AEC, JPH, and TLL were created by recording nonsense
words and then _automatically_ aligning phonetic labels to them using
an HMM speech recognizer in the CSLU Toolkit.  The MWM diphones were 
manually labeled.


CITATIONS
---------

If you find this module useful for your own research projects, please
cite our work in your publications.   Citations in your papers
should appear like this:

M. Macon, A. Cronk, J. Wouters, and A. Kain,  
"OGIresLPC: Diphone synthesiser using residual-excited linear prediction",
Technical Report CSE-97-007, Department of Computer Science,
Oregon Graduate Institute of Science and Technology, September 1997.

A. Kain and M. W. Macon, "Spectral Voice Conversion for Text-to-Speech
Synthesis," Proc. of International Conference on Acoustics, Speech,
and Signal Processing, Vol. 1, pp. 285-288, 1998.

To download these and other publications by our group, please see our
web page.


LICENSE 
------- 
This module and accompanying data are freely available for
non-commercial use only, and are covered under the same licensing
agreement as the CSLU Toolkit.  Please see the file
"license_ogi_tts.txt" for information on usage and redistribution, and
for a DISCLAIMER OF ALL WARRANTIES.  Please contact CSTR for
information regarding commercial use of Festival or the British
English diphone set.


BUGS and IMPROVEMENTS
---------------------
Please contact us via email <macon@ece.ogi.edu> if you find bugs, have
suggestions for improvements, or would like to be informed of future 
releases of the module.










