Introduction

This document provides information about direct integration of Orca with Speech Dispatcher. SD backend is included in Orca from version 2.19.0, but version 2.19.90 or later is highly recommended.

This backend bypasses the Gnome Speech layer. There is also another solution, which runs as a Gnome Speech driver. The primary motivation for the direct approach is to allow a more straightforward mapping of the Orca speech API to the logic of Speech Dispatcher's API. Advanced features not supported by Gnome Speech may be used that way. Additional advantages might be lower latency and better stability.

Possible reasons for using Orca with Speech Dispatcher:

Important note: Please make sure you are not using Speech Dispatcher as the Gnome Speech driver before reporting any problems, since the driver doesn't support many features described here. Read the section "Quick Start" carefully to check the difference in configuration.

News

Quick Start

Speech Dispatcher 0.6.6 or later is recommended, but you will get some basic support even with 0.6.2. If you installed Speech Dispatcher as a package, you may (depending on your distribution) also need to install the Speech Dispatcher Python Interface. In Debian and Ubuntu, the package is called 'python-speechd'.

Before proceeding it is always a good idea to test whether Speech Dispatcher works as expected by invoking the command "spd-say something".

If you have Speech Dispatcher working, the backend will automatically appear in the Orca preferences dialog. It must be listed in the "Speech system" combo box. The "Speech Dispatcher" item in the "Speech synthesizer" combo box belongs to the Speech Dispatcher Gnome Speech driver, so please make sure you select it as the "Speech system". If it doesn't appear there, see the Troubleshooting section below.

Configuration

You may use the Speech Dispatcher's per-client configuration to change its default setup just for Orca. The client name is 'orca', so your /etc/speech-dispatcher/clients/orca.conf may look like:

# Local configuration for Orca
BeginClient "*:orca:*"
    DefaultLanguage "es"
    DefaultCapLetRecognition "none"
EndClient

Don't forget to include orca.conf in your /etc/speech-dispatcher/speechd.conf. Learn more about client specific configuration in Speech Dispatcher Documentation.

Troubleshooting

Speech Dispatcher doesn't appear in the list of available speech systems

You probably don't have the right version of Speech Dispatcher or its Python client library.

1. Invoke the following command in terminal to check your installed SD version:

  $ speech-dispatcher --version

If it's not 0.6.2 or later, go and get it.

2. Check whether Speech Dispatcher works:

  $ spd-say "Hello, how are you?"

If it doesn't speak, check your configuration, see the logs (usually in /var/log/speech-dispatcher), read Speech Dispatcher's documentation or contact the mailing list to find out where the problem is.

3. Check the Python Speech Dispatcher interface:

  $ python -c "import speechd"

If that fails, the Python interface to Speech Dispatcher is not installed or not in your Python path. If you are on Debian or Ubuntu, check that you have the package 'python-speechd' installed. If you installed SD from source, check that the python libraries are installed in one of the directories returned by the following command:

  $ python -c "import sys; print sys.path"

Contact the mailing list if you are not able to solve this yourself.

The "Say all" function doesn't work

Make sure you are not using Speech Dispatcher as the Gnome Speech driver. The driver doesn't support this functionality. Please re-read the section Setup to make sure you are using the SD backend described in this document.

Orca hangs with 100% CPU usage when attempting to run setup

This sometimes happens with the Gnome Speech Festival driver. You need to kill the process named 'festival-synthesis-driver' and sometimes also Orca itself.

A possible workaround is to create a file ~/.orca/orca-customizations.py and copy the following code in it:

import orca.settings
# Omit "gnomespeechfactory" to prevent festival-synthesis-driver problem.
orca.settings.speechFactoryModules = ["espeechfactory","speechdispatcherfactory"]
orca.settings.speechServerFactory  = "speechdispatcherfactory"

Note, that this completely disables Gnome Speech from being used by Orca. Suggestions for a better solution are welcome.

Speech Dispatcher crashes frequently on a dual processor system

Install Speech Dispatcher 0.6.6 or later. It fixes important SMP bugs.

TODO

Contact

Any feedback is welcome.

Orca/SpeechDispatcher (last edited 2008-06-09 06:01:01 by TomasCerha)