Import Debian changes 1.2.2-5.1
[debian/freetts] / mbrola / README.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3 <!--
4
5 /**
6  * Copyright 2001,2003 Sun Microsystems, Inc.
7  * 
8  * See the file "license.terms" for information on usage and
9  * redistribution of this file, and for a DISCLAIMER OF ALL 
10  * WARRANTIES.
11  */
12
13 -->
14
15 <html>
16     <head><title>Setting up MBROLA for FreeTTS</title></head>
17     <body>
18         <center>
19             <table bgcolor="#FFCC66" width="100%">
20                 <tr>
21                     <td align=center width="100%">
22                         <h1>Setting up MBROLA for FreeTTS</h1>
23                     </td>
24                 </tr>
25             </table>
26         </center>
27
28         <p>The aim of the MBROLA project, initiated by the TCTS Lab of
29         the Faculte Polytechnique de Mons (Belgium), is to obtain a
30         set of speech synthesizers for as many languages as possible,
31         and provide them free for non-commercial applications.  The
32         MBROLA source code is held tightly by its owners, but
33         fortunately they provide standalone binaries for a large
34         number of platforms.  In addition, a large number of diphone
35         voice databases exist for many languages.</p>
36
37         <p><b><font color="ff0000">NOTE:</font> FreeTTS support for
38         MBROLA on the Windows platform has been troublesome in the
39         past, but appears to have been fixed by the MBROLA team.
40         Please refer to the 
41         <a
42         href="http://sourceforge.net/forum/forum.php?thread_id=1219083&forum_id=137669">FreeTTS Forum</a>
43         for more information.</b></p>
44
45         <p>Three US English voices exist, named us1 (female), us2
46         (male) and us3 (male).  Thanks to the work of Marc Schroder,
47         text-to-speech Researcher in the Language Technology Lab at
48         DFKI, Saarbrucken, Germany, FreeTTS can use these voices.</p>
49
50         <h3>Download and Install MBROLA Binaries</h3>
51         <p>The MBROLA binaries and voice databases can be downloaded free
52         for non-commercial, non-military use at:</p>
53
54         <ul>
55             <p><a href="http://tcts.fpms.ac.be/synthesis/mbrola.html">
56             http://tcts.fpms.ac.be/synthesis/mbrola.html</a></p>
57         </ul>
58
59         <p>Decide on a base directory to put both MBROLA binary
60         and MBROLA voice databases.  Let's assume this is
61         /home/jim/mbrola.  Download and install the MBROLA binaries
62         for your platform into this directory.  Also download and 
63         install the us1, us2, and us3 binaries into this directory.
64         When you are done, you should have a directory that looks 
65         something like the following (sample taken from Mac OS X):</p>
66
67         <pre>
68         bash-2.05a$ ls -l /home/jim/mbrola
69         total 184
70         -rwxrwxrwx  1 jim staff  31686 Mar  6  2001 License.txt
71         drwxrwxrwx  3 jim staff    102 Mar  5  2001 MbroliX.app
72         -rwxrwxrwx  1 jim staff   1318 Mar  5  2001 ReadMe.rtf
73         -rwxrwxrwx  1 jim staff   1044 Mar  5  2001 ReadMe.txt
74         drwxr-xr-x  9 jim staff    306 Aug 28 17:04 distrib
75         -rw-r--r--  1 jim staff      0 Aug 28 17:50 foo.raw
76         lrwxr-xr-x  1 jim staff     17 Aug 28 17:50 mbrola -> mbrola-darwin-ppc
77         -rwxr-xr-x  1 jim staff  47616 May  6  2002 mbrola-darwin-ppc
78         drwxr-xr-x  8 jim staff    272 Aug 19 16:11 us1
79         drwxr-xr-x  7 jim staff    238 Aug 19 16:11 us2
80         drwxr-xr-x  7 jim staff    238 Aug 19 16:11 us3
81         </pre>
82
83         <p>Note that FreeTTS expects the MBROLA binary to be named "mbrola."
84         As a result, you may need to rename the mbrola binary or create a
85         symbolic link to it.  For example, on Mac OS X, the mbrola binary
86         is named "mbrola-darwin-ppc."  Creating a symbolic link named "mbrola"
87         that points to "mbrola-darwin-ppc" (as shown above) will allow FreeTTS 
88         to find the mbrola binary.
89
90         <p>Also make sure that both the link "mbrola" and the mbrola binary
91         are executable. Using this example:
92
93         <ul>
94         <p><code>chmod a+x mbrola mbrola-darwin-ppc</code>
95         </ul>
96
97         <h3>Enable FreeTTS Support for MBROLA</h3> 
98         <p>To enable FreeTTS support for MBROLA, merely copy
99         mbrola/mbrola.jar to lib/mbrola.jar.  Then, whenever you run
100         any FreeTTS application, specify the "mbrola.base" directory
101         as a system property:</p>
102         <ul>
103             <p><code>java -Dmbrola.base=/home/jim/mbrola -jar
104             bin/FreeTTSHelloWorld.jar mbrola_us1</code></p>
105         </ul>
106
107         <h3>Determining Available MBROLA Voices</h3> 
108         <p>To get the names of the available MBROLA voices, run the
109         mbrola.jar file:</p>
110         <ul>
111 <pre>
112 java -Dmbrola.base=/home/jim/mbrola -jar lib/mbrola.jar
113 VoiceDirectory 'de.dfki.lt.freetts.en.us.MbrolaVoiceDirectory'
114
115 Name: mbrola_us1
116         Description: MBROLA Voice us1
117         Organization: mbrola
118         Domain: general
119         Locale: en_US
120         Style: standard
121         Gender: FEMALE
122         Age: YOUNGER_ADULT
123         Pitch: 180.0
124         Pitch Range: 22.0
125         Pitch Shift: 1.0
126         Rate: 150.0
127         Volume: 1.0
128
129
130 Name: mbrola_us2
131         Description: MBROLA Voice us2
132         Organization: mbrola
133         Domain: general
134         Locale: en_US
135         Style: standard
136         Gender: MALE
137         Age: YOUNGER_ADULT
138         Pitch: 115.0
139         Pitch Range: 12.0
140         Pitch Shift: 1.0
141         Rate: 150.0
142         Volume: 1.0
143
144
145 Name: mbrola_us3
146         Description: MBROLA Voice us3
147         Organization: mbrola
148         Domain: general
149         Locale: en_US
150         Style: standard
151         Gender: MALE
152         Age: YOUNGER_ADULT
153         Pitch: 125.0
154         Pitch Range: 12.0
155         Pitch Shift: 1.0
156         Rate: 150.0
157         Volume: 1.0
158 </pre>
159         </ul>
160
161         <hr>
162
163         <p>See the <a href="../license.terms">license terms</a>
164         and <a href="../acknowledgments.txt">acknowledgments</a>.
165         <br>
166         Copyright 2001,2003 Sun Microsystems, Inc.  All Rights
167         Reserved.  Use is subject to license terms.</p>
168     </body>
169 </html>