| 1 |
|
| 2 |
The requirements: |
| 3 |
================= |
| 4 |
|
| 5 |
You will need these components to compile Speech Dispatcher: |
| 6 |
- glib 2.0 (http://www.gtk.org) |
| 7 |
- libdotconf 1.3 (http://github.com/williamh/dotconf) |
| 8 |
- libsndfile 1.0.2 (http://www.mega-nerd.com/libsndfile/) |
| 9 |
- pthreads |
| 10 |
- gcc and GNU make (http://www.gnu.org) |
| 11 |
- festival-freebsoft-utils 0.3+ (optional) |
| 12 |
(http://www.freebsoft.org/festival-freebsoft-utils) |
| 13 |
- Python 3, PyXDG (optional) |
| 14 |
(http://www.python.org) |
| 15 |
|
| 16 |
Only if you are building from Git, you also need these: |
| 17 |
- automake 1.11+, autoconf, autopoint, pkg-config, libtool, makeinfo, texinfo |
| 18 |
and gettext |
| 19 |
|
| 20 |
We recommend to also install these packages: |
| 21 |
- PulseAudio (http://www.pulseaudio.org) |
| 22 |
- Festival (http://www.cstr.ed.ac.uk/projects/festival/) |
| 23 |
- Espeak (http://espeak.sourceforge.net/) |
| 24 |
- Gettext 0.19.8+ (https://www.gnu.org/software/gettext/) for internationalization support. |
| 25 |
|
| 26 |
These packages are known to work with Speech Dispatcher: |
| 27 |
Software synthesizers: |
| 28 |
- Festival (http://www.cstr.ed.ac.uk/projects/festival/) -- an extensible |
| 29 |
speech synthesis engine with support for various languages (English, |
| 30 |
Spanish, Italian, Finnish, Czech, Russian, Hindi, some African languages |
| 31 |
and others) |
| 32 |
- Espeak (http://espeak.sourceforge.net/) -- a light and fast multi-lingual |
| 33 |
synthesizer with very good support for various Speech Dispatcher |
| 34 |
features. |
| 35 |
- Flite, Cicero, IBM TTS, Dectalk Software, Ivona, SVOX Pico |
| 36 |
|
| 37 |
User applications: |
| 38 |
- Orca (http://www.gnome.org/projects/orca/) -- AT-SPI screen reader (Gnome) |
| 39 |
- speechd-el (http://www.freebsoft.org/) -- Emacs speech interface |
| 40 |
- Linux Screen Reader (LSR (http://live.gnome.org/LSR) |
| 41 |
- BrlTTY (http://mielke.cc/brltty/) |
| 42 |
- ... |
| 43 |
|
| 44 |
Building Speech Dispatcher: |
| 45 |
=========================== |
| 46 |
|
| 47 |
(for instructions about how to build from Git or Git snapshot see below) |
| 48 |
|
| 49 |
If you want to use Speech Dispatcher with Festival (recommended), you |
| 50 |
also need to install festival-freebsoft-utils version 0.3 or higher! |
| 51 |
|
| 52 |
If you want to use Speech Dispatcher with Ivona, you need to install |
| 53 |
libdumbtts |
| 54 |
|
| 55 |
To compile the whole project, including Speech Dispatcher server, all modules |
| 56 |
and clients, simply extract the distribution archive and change to |
| 57 |
speech-dispatcher-<version> directory and run "make all" command as follows: |
| 58 |
|
| 59 |
$ tar -xzvf speech-dispatcher-[version].tar.gz |
| 60 |
$ cd speech-dispatcher-[version] |
| 61 |
|
| 62 |
|
| 63 |
Notes about Pulse, LIBAO, ALSA, OSS and NAS support |
| 64 |
============================================ |
| 65 |
|
| 66 |
Speech Dispatcher's default audio output system is the first discovered |
| 67 |
during configuration started with the Pulse Audio and followed by libao, ALSA, |
| 68 |
OSS and NAS. It is possible to explicitly setup default audio output system |
| 69 |
while building Speech Dispatcher, see configuration options. |
| 70 |
This value can be redefined during run time in the speechd.conf. |
| 71 |
If multiple audio output systems separated by comma are defined as default |
| 72 |
audio output system e.g. "pulse,alsa" an automatic fallback will be done. |
| 73 |
|
| 74 |
Notes about Espeak support |
| 75 |
========================== |
| 76 |
|
| 77 |
You need to install Espeak libraries to be able to use the native |
| 78 |
output module. Some distributions like debian provide |
| 79 |
those libraries in a different package (libespeak1 and libespeak-dev). |
| 80 |
|
| 81 |
Notes about Flite support |
| 82 |
========================= |
| 83 |
|
| 84 |
You don't need to do anything special to compile Speech Dispatcher |
| 85 |
with Flite support, Flite will be detected automatically when running |
| 86 |
./configure. However, make sure that you have correctly installed |
| 87 |
flite libraries and examine the output of ./configure carefully. |
| 88 |
|
| 89 |
You should have configured flite with |
| 90 |
./configure --enable-shared |
| 91 |
to be able to use the flite plug-in. If you aren't sure if you have done this, |
| 92 |
check for example for libflite_cmu_us_kal.so in your library directory. |
| 93 |
(It's also possible to use Speech Dispatcher with Flite static libraries, |
| 94 |
but it is generally not a good way unless you know what you are doing.) |
| 95 |
|
| 96 |
Notes about IBM TTS support |
| 97 |
=========================== |
| 98 |
|
| 99 |
In order to build the propriatary (non-free software) ibmtts output |
| 100 |
module, you will need one of two things: |
| 101 |
|
| 102 |
1. An install of the proprietary commercial IBM TTS synthesizer (for Linux), |
| 103 |
or |
| 104 |
|
| 105 |
2. The sdk for IBM TTS, which contains the headers and a "stub library" for |
| 106 |
linking against. This SDK is Free Software and freely available, however |
| 107 |
it doesn't contain the synthesizer. It will enable you to build the |
| 108 |
module, but this module will give you no sound until you install the |
| 109 |
synthesizer itself. |
| 110 |
|
| 111 |
The sdk can be obtained here: |
| 112 |
|
| 113 |
http://ibmtts-sdk.sourceforge.net/ |
| 114 |
|
| 115 |
It isn't obvious on that website, but you download the sdk using cvs: |
| 116 |
|
| 117 |
cvs -d:pserver:[email protected]:/cvsroot/ibmtts-sdk login |
| 118 |
|
| 119 |
cvs -d:pserver:[email protected]:/cvsroot/ibmtts-sdk co sdk |
| 120 |
|
| 121 |
The sdk is licensed using a BSD-style license. |
| 122 |
|
| 123 |
You will also need libsndfile in order to enable sound icon emulation with the |
| 124 |
ibmtts output module. (As of Apr 2006, the Debian packages you need are |
| 125 |
libsndfile1 and libsndfile1-dev.) |
| 126 |
|
| 127 |
Notes about SVOX Pico support |
| 128 |
============================= |
| 129 |
|
| 130 |
SVOX Pico software can be obtained from |
| 131 |
http://git.debian.org/?p=collab-maint/svox.git |
| 132 |
|
| 133 |
SVOX Pico documentation can be found under |
| 134 |
http://android.git.kernel.org/?p=platform/external/svox.git;a=tree;f=pico_resources/docs |
| 135 |
It includes three manuals: |
| 136 |
- SVOX_Pico_Lingware.pdf |
| 137 |
- SVOX_Pico_Manual.pdf |
| 138 |
- SVOX_Pico_architecture_and_design.pdf |
| 139 |
|
| 140 |
To build SVOX Pico, fetch the debian-sid branch with |
| 141 |
|
| 142 |
git checkout debian-sid |
| 143 |
|
| 144 |
then apply Debian patches with |
| 145 |
|
| 146 |
QUILT_PATCHES=debian/patches quilt push -a |
| 147 |
|
| 148 |
then go to the pico subdirectory and type |
| 149 |
chmod +x autogen.sh |
| 150 |
./autogen.sh |
| 151 |
./configure |
| 152 |
make install |
| 153 |
|
| 154 |
Continue building Speech Dispatcher |
| 155 |
=================================== |
| 156 |
|
| 157 |
On some systems, before running make, you have to set the environment variable |
| 158 |
SED to your binary of the sed application. This is usually done as: |
| 159 |
|
| 160 |
$ export SED=sed |
| 161 |
|
| 162 |
$ ./configure |
| 163 |
$ make all |
| 164 |
|
| 165 |
If everything worked ok, you can install all the parts to the default |
| 166 |
path by running (as root): |
| 167 |
|
| 168 |
# make install |
| 169 |
# ldconfig |
| 170 |
|
| 171 |
If it doesn't work, please see "Building from Git" if this is your case. If |
| 172 |
not, you can ask us on [email protected] . |
| 173 |
|
| 174 |
Building from Git |
| 175 |
================= |
| 176 |
|
| 177 |
If you are building directly from Git or from some Git tarball snapshot, you |
| 178 |
must first create the ./configure file. Please make sure you have all the |
| 179 |
necessary tools listed in the requirements at the beginning of this README |
| 180 |
in their appropriate versions. Automake and autoconf are especially version |
| 181 |
sensitive. |
| 182 |
|
| 183 |
Then please do: |
| 184 |
|
| 185 |
$ cd speech-dispatcher # where speech-dispatcher is your Git clone |
| 186 |
$ ./build.sh |
| 187 |
|
| 188 |
Now the configure file should be created and you can proceed like with |
| 189 |
an ordinary instalation. |
| 190 |
|
| 191 |
Installing Festival Speech Dispatcher interface: |
| 192 |
================================================ |
| 193 |
|
| 194 |
You need to install the new version of festival-freebsoft-utils (0.3 |
| 195 |
or higher). |
| 196 |
|
| 197 |
Please make sure that Festival server_access_list configuration |
| 198 |
variable and your /etc/hosts.conf are set properly. server_access_list |
| 199 |
must contain the symbolic name of your machine and this name must be |
| 200 |
defined in /etc/hosts.conf and point to your IP address. You can test |
| 201 |
if this is set correctly by trying to connect to the port Festival |
| 202 |
server is running on via an ordinary telnet. If you are not rejected, |
| 203 |
it probably works. |
| 204 |
|
| 205 |
Example of the server_access_list configuration line |
| 206 |
in festival.scm: |
| 207 |
(set! server_access_list '("127.0.0.1" "localhost" "chopin")) |
| 208 |
|
| 209 |
Testing |
| 210 |
======= |
| 211 |
|
| 212 |
You can try to execute Speech Dispatcher by |
| 213 |
$ speech-dispatcher |
| 214 |
|
| 215 |
If Speech Dispatcher is running, you can test if it's working by: |
| 216 |
(on some other console) |
| 217 |
$ cd speech-dispatcher-[version]/src/tests |
| 218 |
$ make check |
| 219 |
$ ./run_test basic.test |
| 220 |
(You can also try other tests, if you like.) |
| 221 |
|
| 222 |
Also try |
| 223 |
$ speech-dispatcher --help |
| 224 |
to see how you can run it as a standalone program and possibly see |
| 225 |
what's wrong. |
| 226 |
|
| 227 |
Troubleshooting |
| 228 |
=============== |
| 229 |
|
| 230 |
If you think something is missing, try additionally: |
| 231 |
|
| 232 |
$ mkdir PREFIX/etc/speech-dispatcher |
| 233 |
$ cp -r config PREFIX/etc/speech-dispatcher |
| 234 |
$ mkdir PREFIX/include |
| 235 |
$ cp clients/libspeechd.h PREFIX/include/ |
| 236 |
|
| 237 |
where PREFIX is your installation path prefix (defaulting to /usr/local). |
| 238 |
|
| 239 |
Building in more detail: |
| 240 |
======================== |
| 241 |
|
| 242 |
The hierarchy of Makefiles is used to build each of the parts. The top |
| 243 |
level Makefile allows you to compile some extra parts of the project. |
| 244 |
These are: |
| 245 |
|
| 246 |
- doc ........ build documentation in all supported formats |
| 247 |
(see doc/README for more information) |
| 248 |
- src/server ..... build speachd server - this is the same as |
| 249 |
cd src/server; make all |
| 250 |
- src/modules .... build all speachd modules - this is the same as |
| 251 |
cd src/modules; make all |
| 252 |
- src/clients .... build all clients - this is the same as |
| 253 |
cd src/clients; make all |
| 254 |
- clean ...... remove all files except the sources (does not |
| 255 |
clean documentation) |
| 256 |
- all ........ build server, modules and clients |
| 257 |
|
| 258 |
If you are building directly from git or from some git tarball snapshot, you |
| 259 |
must first create the ./configure file. Please make sure you have all the |
| 260 |
necessary tools listed in the requirements at the beginning of this README |
| 261 |
in their appropriate versions. Automake and autoconf are especially version |
| 262 |
sensitive. |
| 263 |
|
| 264 |
Then please do: |
| 265 |
|
| 266 |
$ cd speech-dispatcher-[version] |
| 267 |
$ ./build.sh |
| 268 |
|
| 269 |
Now the configure file should be created and you can proceed like with |
| 270 |
an ordinary instalation. |
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
Copyright (C) 2001-2012 Brailcom, o.p.s |
| 275 |
Copyright (C) 2010 Rui Batista <[email protected]> |
| 276 |
Copyright (C) 2010 William Hubbs <[email protected]> |
| 277 |
Copyright (C) 2010-2016 Andrei Kholodnyi <[email protected]> |
| 278 |
Copyright (C) 2015 Luke Yelavich <[email protected]> |
| 279 |
Copyright (C) 2018-2020, 2025 Samuel Thibault <[email protected]> |
| 280 |
|
| 281 |
This program is free software; you can redistribute it and/or modify it under |
| 282 |
the terms of the GNU General Public License as published by the Free Software |
| 283 |
Foundation; either version 2 of the License, or (at your option) any later |
| 284 |
version. |
| 285 |
|
| 286 |
This program is distributed in the hope that it will be useful, but WITHOUT ANY |
| 287 |
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
| 288 |
PARTICULAR PURPOSE. See the GNU General Public License for more details (file |
| 289 |
COPYING in the root directory). |
| 290 |
|
| 291 |
You should have received a copy of the GNU General Public License |
| 292 |
along with this program. If not, see <https://www.gnu.org/licenses/>. |