[de0c1bf] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY freetts-download-http "http://prdownloads.sourceforge.net/freetts/freetts-&freetts-version;-src.zip">
|
---|
| 8 | <!ENTITY freetts-download-ftp " ">
|
---|
| 9 | <!ENTITY freetts-md5sum "f3e3ceae5b8cb5e175b50931f2e350e8">
|
---|
| 10 | <!ENTITY freetts-size "14.1 MB">
|
---|
| 11 | <!ENTITY freetts-buildsize "112 MB">
|
---|
| 12 | <!ENTITY freetts-time "0.4 SBU">
|
---|
| 13 |
|
---|
| 14 | <!ENTITY freetts-testsuite-download "http://prdownloads.sourceforge.net/freetts/freetts-&freetts-version;-tst.zip">
|
---|
| 15 | <!ENTITY freetts-testsuite-md5sum "8e461701ee94b3942cc37783f6de4128">
|
---|
| 16 | <!ENTITY freetts-testsuite-size "3.9 MB">
|
---|
| 17 |
|
---|
| 18 | ]>
|
---|
| 19 |
|
---|
| 20 | <sect1 id="freetts" xreflabel="FreeTTS-&freetts-version;">
|
---|
| 21 | <?dbhtml filename="freetts.html"?>
|
---|
| 22 |
|
---|
| 23 | <sect1info>
|
---|
| 24 | <othername>$LastChangedBy$</othername>
|
---|
| 25 | <date>$Date$</date>
|
---|
[4b4814c2] | 26 | <keywordset>
|
---|
| 27 | <keyword role="package">freetts-&freetts-version;-src.zip</keyword>
|
---|
[f15e274] | 28 | <keyword role="ftpdir">freetts</keyword>
|
---|
[4b4814c2] | 29 | </keywordset>
|
---|
[de0c1bf] | 30 | </sect1info>
|
---|
| 31 |
|
---|
| 32 | <title>FreeTTS-&freetts-version;</title>
|
---|
| 33 |
|
---|
| 34 | <indexterm zone="freetts">
|
---|
| 35 | <primary sortas="a-FreeTTS">FreeTTS</primary>
|
---|
| 36 | </indexterm>
|
---|
| 37 |
|
---|
| 38 | <sect2 role="package">
|
---|
| 39 | <title>Introduction to FreeTTS</title>
|
---|
| 40 |
|
---|
[e204bf91] | 41 | <para>The <application>FreeTTS</application> package contains a speech
|
---|
[d7ecaa6] | 42 | synthesis system written entirely in the <application>Java</application>
|
---|
[e204bf91] | 43 | programming language. It is based upon
|
---|
| 44 | <ulink url="http://www.cmuflite.org/">Flite</ulink>: a small run-time
|
---|
| 45 | speech synthesis engine developed at Carnegie Mellon University.
|
---|
| 46 | <application>Flite</application> is derived from the
|
---|
[d7ecaa6] | 47 | <ulink url="http://www.cstr.ed.ac.uk/projects/festival/">Festival</ulink>
|
---|
[e204bf91] | 48 | Speech Synthesis System from the University of Edinburgh and the
|
---|
| 49 | <ulink url ="http://festvox.org/">FestVox</ulink> project from Carnegie
|
---|
| 50 | Mellon University. The <application>FreeTTS</application> package is used
|
---|
[de0c1bf] | 51 | to convert text to audible speech through the system audio hardware.</para>
|
---|
| 52 |
|
---|
| 53 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 54 | <itemizedlist spacing="compact">
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Download (HTTP): <ulink url="&freetts-download-http;"/></para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Download (FTP): <ulink url="&freetts-download-ftp;"/></para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>Download MD5 sum: &freetts-md5sum;</para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>Download size: &freetts-size;</para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>Estimated disk space required: &freetts-buildsize;</para>
|
---|
| 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
| 71 | <para>Estimated build time: &freetts-time;</para>
|
---|
| 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 76 | <itemizedlist spacing="compact">
|
---|
| 77 | <listitem>
|
---|
| 78 | <para>Test suite: <ulink url="&freetts-testsuite-download;"/></para>
|
---|
| 79 | </listitem>
|
---|
| 80 | <listitem>
|
---|
| 81 | <para>Download MD5 sum: &freetts-testsuite-md5sum;</para>
|
---|
| 82 | </listitem>
|
---|
| 83 | <listitem>
|
---|
| 84 | <para>Download size: &freetts-testsuite-size;</para>
|
---|
| 85 | </listitem>
|
---|
| 86 | </itemizedlist>
|
---|
| 87 |
|
---|
| 88 | <bridgehead renderas="sect3">FreeTTS Dependencies</bridgehead>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[4b4814c2] | 91 | <para role="required"><xref linkend="apache-ant"/> (and
|
---|
[d7ecaa6] | 92 | <ulink url="http://www.junit.org/">JUnit</ulink>
|
---|
[e204bf91] | 93 | to run the test suite),
|
---|
[de0c1bf] | 94 | <xref linkend="unzip"/> and working audio hardware/software.</para>
|
---|
| 95 |
|
---|
| 96 | </sect2>
|
---|
| 97 |
|
---|
| 98 | <sect2 role="installation">
|
---|
| 99 | <title>Installation of FreeTTS</title>
|
---|
| 100 |
|
---|
[e204bf91] | 101 | <para>The <application>FreeTTS</application> package is distributed in
|
---|
| 102 | ZIP format and the <command>unzip</command> command will default to
|
---|
| 103 | creating an unused source directory. Additionally,
|
---|
[5aee372] | 104 | unzipping the test suite file will prompt for questions
|
---|
[e204bf91] | 105 | about overwriting existing files. Use the following commands to
|
---|
[de0c1bf] | 106 | <command>unzip</command> the source files:</para>
|
---|
| 107 |
|
---|
| 108 | <screen><userinput>unzip -q freetts-&freetts-version;-src.zip -x META-INF/* &&
|
---|
| 109 | unzip -q freetts-&freetts-version;-tst.zip \
|
---|
| 110 | -x {META-INF/*,freetts-&freetts-version;/{acknowledgments.txt,license.terms}}</userinput></screen>
|
---|
| 111 |
|
---|
[e204bf91] | 112 | <para>Install <application>FreeTTS</application> by running the following
|
---|
[de0c1bf] | 113 | commands:</para>
|
---|
| 114 |
|
---|
[c033874] | 115 | <screen><userinput>cd lib &&
|
---|
| 116 | yes | sh jsapi.sh &&
|
---|
| 117 | cd .. &&
|
---|
[de0c1bf] | 118 | ant</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | <para>To test the results, issue:</para>
|
---|
| 121 |
|
---|
| 122 | <screen><userinput>ant junit &&
|
---|
| 123 | sh regression.sh</userinput></screen>
|
---|
| 124 |
|
---|
| 125 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 126 |
|
---|
| 127 | <screen role="root"><userinput>install -v -m755 -d /opt/freetts-&freetts-version;/{lib,docs/{audio,images}} &&
|
---|
| 128 | install -v -m644 lib/*.jar /opt/freetts-&freetts-version;/lib &&
|
---|
| 129 | install -v -m644 *.txt RELEASE_NOTES license.terms \
|
---|
| 130 | docs/*.{pdf,html,txt,sx{w,d}} \
|
---|
| 131 | /opt/freetts-&freetts-version;/docs &&
|
---|
| 132 | install -v -m644 docs/audio/* /opt/freetts-&freetts-version;/docs/audio &&
|
---|
| 133 | install -v -m644 docs/images/* /opt/freetts-&freetts-version;/docs/images &&
|
---|
| 134 | cp -v -R javadoc /opt/freetts-&freetts-version; &&
|
---|
| 135 | ln -v -s freetts-&freetts-version; /opt/freetts</userinput></screen>
|
---|
| 136 |
|
---|
[e204bf91] | 137 | <para>Optionally, install any or all of the additional
|
---|
| 138 | <application>FreeTTS</application> components using the following
|
---|
| 139 | commands as the <systemitem class="username">root</systemitem> user
|
---|
[3502f04a] | 140 | (see the Command Explanations section for details):</para>
|
---|
[de0c1bf] | 141 |
|
---|
| 142 | <screen role="root"><userinput>cp -v -R bin /opt/freetts-&freetts-version; &&
|
---|
| 143 | install -v -m644 speech.properties /opt/jdk/jdk/jre/lib &&
|
---|
| 144 | cp -v -R tools /opt/freetts-&freetts-version; &&
|
---|
| 145 | cp -v -R mbrola /opt/freetts-&freetts-version; &&
|
---|
| 146 | cp -v -R demo /opt/freetts-&freetts-version;</userinput></screen>
|
---|
| 147 |
|
---|
| 148 | </sect2>
|
---|
| 149 |
|
---|
| 150 | <sect2 role="commands">
|
---|
| 151 | <title>Command Explanations</title>
|
---|
| 152 |
|
---|
[e204bf91] | 153 | <para><command>yes | sh jsapi.sh</command>: This command installs the
|
---|
| 154 | <application>Java Speech API</application> into the
|
---|
[d7ecaa6] | 155 | <application>FreeTTS</application> source tree. <command>yes</command>
|
---|
[de0c1bf] | 156 | is piped so that this command can be scripted and will automatically
|
---|
| 157 | agree to the JSAPI license terms. You can view the license you are
|
---|
[e204bf91] | 158 | agreeing to at
|
---|
[de0c1bf] | 159 | <ulink url="http://linuxfromscratch.org/~randy/jsapi-license.txt"/>.</para>
|
---|
| 160 |
|
---|
| 161 | <para><command>ant</command>: <application>FreeTTS</application> uses the
|
---|
[e204bf91] | 162 | <application>Apache Ant</application> build system instead of the GNU
|
---|
[de0c1bf] | 163 | <application>autotools</application>. This commands builds everything,
|
---|
| 164 | including the class libraries, tools and demos.</para>
|
---|
| 165 |
|
---|
| 166 | <para><command>cp -v -R bin ...</command>;
|
---|
| 167 | <command>install -v -m644 speech.properties</command>: These two commands
|
---|
[e204bf91] | 168 | install the demonstration programs. Optionally copy the
|
---|
| 169 | <filename>speech.properties</filename> file to
|
---|
| 170 | <filename>~/speech.properties</filename> if you don't want to make it
|
---|
[de0c1bf] | 171 | available system-wide.</para>
|
---|
| 172 |
|
---|
| 173 | <para><command>cp -v -R tools ...</command>: This installs the voice data
|
---|
[e204bf91] | 174 | import utilities. See the <filename>README.html</filename> files in the
|
---|
| 175 | <filename class='directory'>tools/</filename> subdirectories for
|
---|
[de0c1bf] | 176 | information and instructions about using the tools.</para>
|
---|
| 177 |
|
---|
[e204bf91] | 178 | <para><command>cp -v -R mbrola ...</command>: This installs the
|
---|
| 179 | <filename class='libraryfile'>mbrola.jar</filename> file, required if you
|
---|
| 180 | use the <ulink
|
---|
[de0c1bf] | 181 | url="http://freetts.sourceforge.net/mbrola/README.html">MBROLA</ulink>
|
---|
| 182 | voices.</para>
|
---|
| 183 |
|
---|
[e204bf91] | 184 | <para><command>cp -v -R demo ...</command>: This installs the sources
|
---|
[de0c1bf] | 185 | and documentation for the demonstration programs.</para>
|
---|
| 186 |
|
---|
[e204bf91] | 187 | <para>For additional information and documentation about the
|
---|
| 188 | <application>FreeTTS</application> project, visit the main web page at
|
---|
[de0c1bf] | 189 | <ulink url="http://freetts.sourceforge.net"/>.</para>
|
---|
| 190 |
|
---|
| 191 | </sect2>
|
---|
| 192 |
|
---|
| 193 | <sect2 role="testing">
|
---|
| 194 | <title>Testing the Installation</title>
|
---|
| 195 |
|
---|
| 196 | <para>Test the installation using the following command:</para>
|
---|
| 197 |
|
---|
[bbdb0ff4] | 198 | <screen><userinput>java -jar /opt/freetts/lib/freetts.jar \
|
---|
[de0c1bf] | 199 | -text "This is a test of the FreeTTS speech synthesis system"</userinput></screen>
|
---|
| 200 |
|
---|
[e204bf91] | 201 | <para>Depending on the setup of your audio drivers and software, you
|
---|
[de0c1bf] | 202 | may have to add the <option>-streaming</option> switch to the command
|
---|
| 203 | as shown below:</para>
|
---|
| 204 |
|
---|
[bbdb0ff4] | 205 | <screen><userinput>java -jar /opt/freetts/lib/freetts.jar -streaming \
|
---|
[de0c1bf] | 206 | -text "This is a test of the FreeTTS speech synthesis system"</userinput></screen>
|
---|
| 207 |
|
---|
| 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | <sect2 role="content">
|
---|
| 211 | <title>Contents</title>
|
---|
| 212 |
|
---|
| 213 | <segmentedlist>
|
---|
| 214 | <segtitle>Installed Programs</segtitle>
|
---|
| 215 | <segtitle>Installed Libraries</segtitle>
|
---|
| 216 | <segtitle>Installed Directory</segtitle>
|
---|
| 217 |
|
---|
| 218 | <seglistitem>
|
---|
| 219 | <seg>None</seg>
|
---|
| 220 | <seg>/opt/freetts-&freetts-version;/lib/*.jar</seg>
|
---|
| 221 | <seg>/opt/freetts-&freetts-version;</seg>
|
---|
| 222 | </seglistitem>
|
---|
| 223 | </segmentedlist>
|
---|
| 224 |
|
---|
| 225 | <variablelist>
|
---|
| 226 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 227 | <?dbfo list-presentation="list"?>
|
---|
| 228 | <?dbhtml list-presentation="table"?>
|
---|
| 229 |
|
---|
| 230 | <varlistentry>
|
---|
| 231 | <term><filename class='libraryfile'>*.jar </filename></term>
|
---|
| 232 | <listitem>
|
---|
[e204bf91] | 233 | <para>contains the class libraries which make up the
|
---|
[de0c1bf] | 234 | <application>FreeTTS</application> speech synthesis system.</para>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 | </variablelist>
|
---|
| 238 |
|
---|
| 239 | </sect2>
|
---|
| 240 |
|
---|
| 241 | </sect1>
|
---|