source: archive/freetts.xml

trunk
Last change on this file was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 10.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY freetts-download-http "&sourceforge-dl;/freetts/freetts-&freetts-version;-src.zip">
8 <!ENTITY freetts-download-ftp " ">
9 <!ENTITY freetts-md5sum "692b5ece251fed88539736e55af5f391">
10 <!ENTITY freetts-size "13.5 MB">
11 <!ENTITY freetts-buildsize "92 MB">
12 <!ENTITY freetts-time "0.3 SBU">
13
14 <!ENTITY freetts-testsuite-download "&sourceforge-dl;/freetts/freetts-&freetts-version;-tst.zip">
15 <!ENTITY freetts-testsuite-md5sum "4348c7db928612d4b6f6eb2fd621a949">
16 <!ENTITY freetts-testsuite-size "3.8 MB">
17
18]>
19
20<sect1 id="freetts" xreflabel="FreeTTS-&freetts-version;">
21 <?dbhtml filename="freetts.html"?>
22
23 <sect1info>
24 <date>$Date$</date>
25 </sect1info>
26
27 <title>FreeTTS-&freetts-version;</title>
28
29 <indexterm zone="freetts">
30 <primary sortas="a-FreeTTS">FreeTTS</primary>
31 </indexterm>
32
33 <sect2 role="package">
34 <title>Introduction to FreeTTS</title>
35
36 <para>
37 The <application>FreeTTS</application> package contains a speech
38 synthesis system written entirely in the <application>Java</application>
39 programming language. It is based upon
40 <ulink url="http://www.cmuflite.org/">Flite</ulink>: a small run-time
41 speech synthesis engine developed at Carnegie Mellon University.
42 <application>Flite</application> is derived from the
43 <ulink url="http://www.cstr.ed.ac.uk/projects/festival/">Festival</ulink>
44 Speech Synthesis System from the University of Edinburgh and the
45 <ulink url ="http://festvox.org/">FestVox</ulink> project from Carnegie
46 Mellon University. The <application>FreeTTS</application> package is used
47 to convert text to audible speech through the system audio hardware.
48 </para>
49
50 &lfs81_checked;
51
52 <bridgehead renderas="sect3">Package Information</bridgehead>
53 <itemizedlist spacing="compact">
54 <listitem>
55 <para>
56 Download (HTTP): <ulink url="&freetts-download-http;"/>
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download (FTP): <ulink url="&freetts-download-ftp;"/>
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Download MD5 sum: &freetts-md5sum;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Download size: &freetts-size;
72 </para>
73 </listitem>
74 <listitem>
75 <para>
76 Estimated disk space required: &freetts-buildsize;
77 </para>
78 </listitem>
79 <listitem>
80 <para>
81 Estimated build time: &freetts-time;
82 </para>
83 </listitem>
84 </itemizedlist>
85
86 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
87 <itemizedlist spacing="compact">
88 <listitem>
89 <para>
90 Test suite: <ulink url="&freetts-testsuite-download;"/>
91 </para>
92 </listitem>
93 <listitem>
94 <para>
95 Download MD5 sum: &freetts-testsuite-md5sum;
96 </para>
97 </listitem>
98 <listitem>
99 <para>
100 Download size: &freetts-testsuite-size;
101 </para>
102 </listitem>
103 </itemizedlist>
104
105 <bridgehead renderas="sect3">FreeTTS Dependencies</bridgehead>
106
107 <bridgehead renderas="sect4">Required</bridgehead>
108 <para role="required">
109 <xref linkend="apache-ant"/> and
110 <xref linkend="sharutils"/>
111 </para>
112
113 <para condition="html" role="usernotes">User Notes:
114 <ulink url="&blfs-wiki;/freetts"/>
115 </para>
116 </sect2>
117
118 <sect2 role="installation">
119 <title>Installation of FreeTTS</title>
120
121 <para>
122 The <application>FreeTTS</application> package is distributed in
123 ZIP format and the <command>unzip</command> command will default to
124 creating an unused source directory. Additionally,
125 unzipping the test suite file will prompt for questions
126 about overwriting existing files. Use the following commands to
127 <command>unzip</command> the source files:
128 </para>
129
130<screen><userinput>unzip -q freetts-&freetts-version;-src.zip -x META-INF/* &amp;&amp;
131unzip -q freetts-&freetts-version;-tst.zip -x META-INF/*</userinput></screen>
132
133 <tip>
134 <para>
135 The <command>sh jsapi.sh</command> command below installs the Java
136 Speech API components into the <application>FreeTTS</application> source
137 tree. You will be required to view, and then accept (by entering a
138 <keycap>y</keycap> keypress), a license agreement before the installation
139 will continue. If you are scripting (automating) the build, you'll need
140 to account for this. There is information about automating build commands
141 in the <xref linkend="automating-builds"/> section of Chapter 2. Towards
142 the end of this section, specific information for automating this type of
143 installation is discussed.
144 </para>
145 </tip>
146
147 <para>
148 Install <application>FreeTTS</application> by running the following
149 commands:
150 </para>
151
152<screen><userinput>sed -i 's/value="src/value="./' build.xml &amp;&amp;
153cd lib &amp;&amp;
154sh jsapi.sh &amp;&amp;
155cd .. &amp;&amp;
156ant</userinput></screen>
157
158 <para>
159 To test the results, issue:
160 </para>
161
162<screen><userinput>ant junit &amp;&amp;
163cd tests &amp;&amp;
164sh regression.sh &amp;&amp;
165cd ..</userinput></screen>
166
167 <para>
168 Now, as the <systemitem class="username">root</systemitem> user:
169 </para>
170
171<screen role="root"><userinput>install -v -m755 -d /opt/freetts-&freetts-version;/{lib,docs/{audio,images}} &amp;&amp;
172install -v -m644 lib/*.jar /opt/freetts-&freetts-version;/lib &amp;&amp;
173install -v -m644 *.txt RELEASE_NOTES docs/*.{pdf,html,txt,sx{w,d}} \
174 /opt/freetts-&freetts-version;/docs &amp;&amp;
175install -v -m644 docs/audio/* /opt/freetts-&freetts-version;/docs/audio &amp;&amp;
176install -v -m644 docs/images/* /opt/freetts-&freetts-version;/docs/images &amp;&amp;
177cp -v -R javadoc /opt/freetts-&freetts-version; &amp;&amp;
178ln -v -s freetts-&freetts-version; /opt/freetts</userinput></screen>
179
180 <para>
181 Optionally, install any or all of the additional
182 <application>FreeTTS</application> components using the following
183 commands as the <systemitem class="username">root</systemitem> user
184 (see the Command Explanations section for details):
185 </para>
186
187<screen role="root"><userinput>cp -v -R bin /opt/freetts-&freetts-version; &amp;&amp;
188install -v -m644 speech.properties $JAVA_HOME/jre/lib &amp;&amp;
189cp -v -R tools /opt/freetts-&freetts-version; &amp;&amp;
190cp -v -R mbrola /opt/freetts-&freetts-version; &amp;&amp;
191cp -v -R demo /opt/freetts-&freetts-version;</userinput></screen>
192
193 </sect2>
194
195 <sect2 role="commands">
196 <title>Command Explanations</title>
197
198 <para>
199 <command>sed -i 's/value="src/value="./' build.xml</command>: Fix an
200 error in the build file to allow the program to find the source.
201 </para>
202
203 <para>
204 <command>sh jsapi.sh</command>: This command installs the
205 <application>Java Speech API</application> components into the
206 <application>FreeTTS</application> source tree.
207 </para>
208
209 <para>
210 <command>ant</command>: <application>FreeTTS</application> uses the
211 <application>Apache Ant</application> build system instead of the GNU
212 <application>autotools</application>. This commands builds everything,
213 including the class libraries, tools and demos.
214 </para>
215
216 <para>
217 <command>cp -v -R bin ...</command>;
218 <command>install -v -m644 speech.properties</command>: These two commands
219 install the demonstration programs. Optionally copy the
220 <filename>speech.properties</filename> file to
221 <filename>~/speech.properties</filename> if you don't want to make it
222 available system-wide.
223 </para>
224
225 <para>
226 <command>cp -v -R tools ...</command>: This installs the voice data
227 import utilities. See the <filename>README.html</filename> files in the
228 <filename class="directory">tools/</filename> subdirectories for
229 information and instructions about using the tools.
230 </para>
231
232 <para>
233 <command>cp -v -R mbrola ...</command>: This installs the
234 <filename class="libraryfile">mbrola.jar</filename> file, required if you
235 use the <ulink
236 url="http://freetts.sourceforge.net/mbrola/README.html">MBROLA</ulink>
237 voices.
238 </para>
239
240 <para>
241 <command>cp -v -R demo ...</command>: This installs the sources
242 and documentation for the demonstration programs.
243 </para>
244
245 <para>
246 For additional information and documentation about the
247 <application>FreeTTS</application> project, visit the main web
248 page at <ulink url="http://freetts.sourceforge.net"/>.
249 </para>
250
251 </sect2>
252
253 <sect2 role="testing">
254 <title>Testing the Installation</title>
255
256 <para>
257 Test the installation using the following command:
258 </para>
259
260<screen><userinput>java -jar /opt/freetts/lib/freetts.jar \
261 -text "This is a test of the FreeTTS speech synthesis system"</userinput></screen>
262
263 <para>
264 Depending on the setup of your audio drivers and software, you
265 may have to add the <option>-streaming</option> switch to the command
266 as shown below:
267 </para>
268
269<screen><userinput>java -jar /opt/freetts/lib/freetts.jar -streaming \
270 -text "This is a test of the FreeTTS speech synthesis system"</userinput></screen>
271
272 </sect2>
273
274 <sect2 role="content">
275 <title>Contents</title>
276
277 <segmentedlist>
278 <segtitle>Installed Programs</segtitle>
279 <segtitle>Installed Libraries</segtitle>
280 <segtitle>Installed Directory</segtitle>
281
282 <seglistitem>
283 <seg>
284 None
285 </seg>
286 <seg>
287 /opt/freetts-&freetts-version;/lib/*.jar
288 </seg>
289 <seg>
290 /opt/freetts-&freetts-version;
291 </seg>
292 </seglistitem>
293 </segmentedlist>
294
295 <variablelist>
296 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
297 <?dbfo list-presentation="list"?>
298 <?dbhtml list-presentation="table"?>
299
300 <varlistentry>
301 <term><filename class="libraryfile">*.jar </filename></term>
302 <listitem>
303 <para>
304 contains the class libraries which make up the
305 <application>FreeTTS</application> speech synthesis system.
306 </para>
307 </listitem>
308 </varlistentry>
309 </variablelist>
310
311 </sect2>
312
313</sect1>
Note: See TracBrowser for help on using the repository browser.