Institute

Studying

Research


 

README.ims_german_festival

                          IMS GERMAN FESTIVAL
                       (open source distribution)
                  version 1.3-os(beta) (based on Festival 2.1)
                                                                
                 Institute of Natural Language Processing
                     University of Stuttgart, Germany           
                           Copyright (c) 2012                     
                          All Rights Reserved.                    

1. Introduction
2. Copying
3. Requirements
4. Configuration
5. Compilation
6. Description
7. More


1. INTRODUCTION

This is information about the German Festival version developed at the
Institute of Natural Language Processing, University of Stuttgart by
Gregor Möhler, Antje Schweitzer, Mark Breitenbücher, Martin Barbisch,
and others (see ACKNOWLEDGEMENTS section in the manual for full list).

The IMS German Festival is a full German Text-to-Speech engine based
on the original Festival distribution by CSTR, University of
Edinburgh. Together with two non-IMS resources (the BOMP lexicon and
diphones from the MBROLA project, see below) it enables Festival to
speak German.

This is version 1.3-os(beta), which has been tested only on Fedora Linux
so far. Theoretically, it should run fine on most Linux machines.

2. COPYING

Basically the packages are distributed for research and educational
(i.e. non-commercial and non-military) purposes. The license terms can
be found in the file COPYING.ims_german_festival for the IMS German
Festival package and in file COPYING.bomp for the BOMP lexicon.

3. REQUIREMENTS
 
In order to run IMS German Festival you will need the Festival 2.1
(speech_tools and festival itself) already installed and running on
your machine. Get the sources from
http://www.festvox.org/festival/ and follow the
installation instructions. Test your installation by synthesizing an
English text. In case of problems please refer to the home page and
mailing lists available in Edinburgh.

Once Festival is running get the following four packages from the IMS
Web page:

'ims_german_1.3-os.tgz'
The sources and scheme file for the IMS German Festival

'bomp_full.corr.tgz'
The BOMP lexicon provided by the IKP, University of Bonn,
with some modifications by us.

Unpack all the packages in the Festival base directory (this is where
you already have the two subdirectories speech_tools/ and festival/)

Additionally you will need the MBROLA engine and at least one voice
from the MBROLA project page http://tcts.fpms.ac.be/synthesis/

Install the the MBROLA engine in directory of your choice
(e.g. /usr/local/MBROLA/) and the voices in subdirectories below.


4. CONFIGURATION

We will assume that you have an Unix machine although everything
should also work on Windows.

Add the following line to the Festival config file festival/config/config:

    ALSO_INCLUDE += ims_german_text

Add the MBROLA base directory (here we suppose it is
/usr/local/MBROLA/) to the file festival/lib/sitevars.scm (create the
file if it does not exist):

    (set! mbrola-path "/usr/local/MBROLA/")
    (set! mbrola_progname (string-append mbrola-path "mbrola -e"))

Add a line to the file festival/lib/siteinit.scm that loads the German
modules into Festival:

    (require 'ims_german_opensource)

5. COMPILATION

Re-compile festival:

    cd festival
    gmake info
    gmake
    cd ..

6. DESCRIPTION

The IMS German Festival contains all modules necessary for
Text-to-Speech conversion. More explicitly this involves linguistic
text analysis (modules tokenization, token-pos, token-to-word)
grapheme-to-phoneme conversion (lexicon-lookup, letter-to-sound rules),
prosody (phrasing, intonation, duration, intonation targets) and
waveform synthesis (carried out by the MBROLA engine through an
appropriate interface).

For more background information about the IMS German Festival consult
the manual festival/doc/german/germanfestival-manual.ps or
festival/doc/german/germanfestival-manual/index.html.

To synthesize German text start festival

    festival/bin/festival

choose a German voice, e.g.

    festival> (voice_german_de2_os)

synthesize a text:

    festival> (SayText "Hallo Welt.")

and enjoy listening to it.

You can also synthesize the German introduction text by typing

    festival> (intro-german)

If you want to use a German voice with the text2wave script,
provide the scheme command to load the voice via -eval, e.g.

        shell> echo hallo | $FESTDIR/examples/text2wave -o hallo.wav -eval '(voice_german_de2_os)'

7. MORE

Keep updated by regularly checking the IMS German Festival homepage
  http://www.ims.uni-stuttgart.de/phonetik/synthesis/

If you have questions or problems regarding Festival itself, please
post them to the festival mailing list
     festival-talk@festvox.org
(more info on the Festival home page
http://www.festvox.org/festival).

If you encounter problems using German within Festival please mail to
the following address:
    german-festival@ims.uni-stuttgart.de