Browse Source

Update the documentation to use espeak-ng, etc.

master
Reece H. Dunn 9 years ago
parent
commit
1e2b619b24
6 changed files with 26 additions and 26 deletions
  1. 1
    1
      docs/add_language.html
  2. 14
    14
      docs/commands.html
  3. 3
    3
      docs/languages.html
  4. 3
    3
      docs/mbrola.html
  5. 1
    1
      docs/phonemes.html
  6. 4
    4
      docs/voices.html

+ 1
- 1
docs/add_language.html View File

@@ -97,7 +97,7 @@ For many languages, the consonant phonemes which are already available in eSpeak
Once the language's phonemes have been defined, then pronunciation dictionary data can be produced in order to translate the language's source text into phonemes. This consists of two source files: <B>fr_rules</B> (the spelling to phoneme rules) and <B>fr_list</B> (an exceptions list, and attributes of certain words). The corresponding compiled data file is <B>espeak-data/fr_dict</B> which is produced from <B>fr_rules</B> and <B>fr_list</B> sources by the command:
</P>
<BLOCKQUOTE>
<CODE>espeak --compile=fr</CODE>.
<CODE>espeak-ng --compile=fr</CODE>.
</BLOCKQUOTE>
<P></P>
<P>

+ 14
- 14
docs/commands.html View File

@@ -13,18 +13,18 @@
<h3>2.1.1 Linux and other Posix systems</h3>
There are two versions of the command line program. They both have the same command parameters (see below).
<ol>
<li><strong>espeak</strong> uses speech engine in the <strong>libespeak</strong> shared library. The libespeak library must first be installed.
<li><strong>espeak-ng</strong> uses speech engine in the <strong>libespeak-ng</strong> shared library. The libespeak-ng library must first be installed.
<p>
<li><strong>speak</strong> is a stand-alone version which includes its own copy of the speech engine.
<li><strong>speak-ng</strong> is a stand-alone version which includes its own copy of the speech engine.
</ol>
Place the <strong>espeak</strong> or <strong>speak</strong> executable file in the command path, eg in <strong>/usr/local/bin</strong>
Place the <strong>espeak-ng</strong> or <strong>speak-ng</strong> executable file in the command path, eg in <strong>/usr/local/bin</strong>
<p>
Place the "<strong>espeak-data</strong>" directory in /usr/share as <strong>/usr/share/espeak-data</strong>.<br>
Alternatively if it is placed in the user's home directory (i.e. <strong>/home/&lt;user&gt;/espeak-data</strong>)
then that will be used instead.
<p>
<h4>Dependencies</h4>
<strong>espeak</strong> uses the PortAudio sound library (version 18), so you will need to have the <strong>libportaudio0</strong> library package installed. It may be already, since it's used by other software, such as OpenOffice.org and the Audacity sound editor.<p>
<strong>espeak-ng</strong> uses the PortAudio sound library (version 18), so you will need to have the <strong>libportaudio0</strong> library package installed. It may be already, since it's used by other software, such as OpenOffice.org and the Audacity sound editor.<p>
Some Linux distrubitions (eg. SuSe 10) have version 19 of PortAudio which has a slightly different API. The speak program can be compiled to use version 19 of PortAudio by copying the file portaudio19.h to portaudio.h before compiling.<p>
The speak program may be compiled without using PortAudio, by removing the line<pre> #define USE_PORTAUDIO
</pre>in the file speech.h.
@@ -34,28 +34,28 @@ Some Linux distrubitions (eg. SuSe 10) have version 19 of PortAudio which has a
The installer: <strong>setup_espeak.exe</strong> installs the SAPI5 version of eSpeak.
During installation you need to specify which voices you want to appear in SAPI5 voice menus.
<p>
It also installs a command line program <strong>espeak</strong> in the espeak program directory.
It also installs a command line program <strong>espeak-ng</strong> in the espeak-ng program directory.

<p>&nbsp;<hr>
<h2>2.2 COMMAND OPTIONS</h2>
<hr>
<h3>2.2.1 Examples</h3>
To use at the command line, type:<br>
&nbsp; <strong>espeak "This is a test"</strong><br>
&nbsp; <strong>espeak-ng "This is a test"</strong><br>
or<br>
&nbsp; <strong>espeak -f &lt;text file&gt;</strong>
&nbsp; <strong>espeak-ng -f &lt;text file&gt;</strong>
<p>
Or just type<br>
&nbsp; <strong>espeak</strong><br>
&nbsp; <strong>espeak-ng</strong><br>
followed by text on subsequent lines. Each line is spoken when
RETURN is pressed.
<p>
Use <strong>espeak -x</strong> to see the corresponding phoneme codes.
Use <strong>espeak-ng -x</strong> to see the corresponding phoneme codes.
<p>&nbsp;<hr>
<h3>2.2.2 The Command Line Options</h3>
<dl>
<dt>
<strong>espeak [options] ["text words"]</strong><br>
<strong>espeak-ng [options] ["text words"]</strong><br>
<dd>Text input can be taken either from a file, from a string in the command, or from stdin.
<p>
<dt>
@@ -123,9 +123,9 @@ Quiet. No sound is generated. This may be useful with options such as -x and --
<dt>
<strong>-v &lt;voice filename&gt;[+&lt;variant&gt;]</strong><br>
<dd>Sets a Voice for the speech, usually to select a language. eg:
<pre> espeak -vaf</pre>
<pre> espeak-ng -vaf</pre>
To use the Afrikaans voice. A modifier after the voice name can be used to vary the tone of the voice, eg:
<pre> espeak -vaf+3</pre>
<pre> espeak-ng -vaf+3</pre>
The variants are <code> +m1 +m2 +m3 +m4 +m5 +m6 +m7</code> for male voices and <code> +f1 +f2 +f3 +f4 </code> which simulate female voices by using higher pitches. Other variants include <code>+croak</code> and <code>+whisper</code>.
<p>
&lt;voice filename&gt; is a file within the <code>espeak-data/voices</code> directory.<br>
@@ -216,8 +216,8 @@ If the -m option is used to indicate marked-up text, then HTML can be spoken dir
<p>
<dt><b>Phoneme Input</b>
<dd>
As well as plain text, phoneme mnemonics can be used in the text input to <strong>espeak</strong>. They are enclosed within double square brackets. Spaces are used to separate words and all stressed syllables must be marked explicitly.<p>
&nbsp; eg: &nbsp; <code> espeak -v en "[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]" </code><p>
As well as plain text, phoneme mnemonics can be used in the text input to <strong>espeak-ng</strong>. They are enclosed within double square brackets. Spaces are used to separate words and all stressed syllables must be marked explicitly.<p>
&nbsp; eg: &nbsp; <code> espeak-ng -v en "[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]" </code><p>
This command will speak: "This is some phonetic text input".
</dl>


+ 3
- 3
docs/languages.html View File

@@ -27,7 +27,7 @@ Sample texts in various languages can be found at <a href="http://meta.wikimedi
A number of Voice files are provided in the <code>espeak-data/voices</code> directory.
You can select one of these with the <strong>-v &lt;voice filename&gt;</strong> parameter to the
speak command, eg:
<pre> espeak -vaf</pre>
<pre> espeak-ng -vaf</pre>
to speak using the Afrikaans voice.<p>Language voices generally start with the 2 letter <a href="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1 code</a> for the language. If the language does not have an ISO 639-1 code, then the 3 letter <a href="http://www.sil.org/iso639-3/codes.asp">ISO 639-3 code</a> can be used.
<p>
For details of the voice files see <a href="voices.html">Voices</a>.
@@ -69,9 +69,9 @@ To make alternative voices for a language, you can make additional voice files i
Alternatively there are some preset voice variants which can be applied to any of the language voices, by appending <code>+</code> and a variant name. Their effects are defined by files in <code>espeak-data/voices/!v</code>.
<p>
The variants are <code> +m1 +m2 +m3 +m4 +m5 +m6 +m7</code> for male voices, <code> +f1 +f2 +f3 +f4 +f5 </code> for female voices, and <code> +croak +whisper</code> for other effects. For example:
<pre> espeak -ven+m3</pre>
<pre> espeak-ng -ven+m3</pre>
The available voice variants can be listed with:<br>
<pre> espeak --voices=variant</pre>
<pre> espeak-ng --voices=variant</pre>
<h3>3.4 Other Languages</h3>
The eSpeak speech synthesizer does text to speech for the following additional langauges.
<ul>

+ 3
- 3
docs/mbrola.html View File

@@ -62,13 +62,13 @@ Unpack the archive, and copy the "<b>en1</b>" data file (not the whole "en1"
directory) to <code>/usr/share/mbrola/en1</code>.<p>eSpeak will look for mbrola voices firstly in <code>espeak-data/mbrola</code> and then in <code>/usr/share/mbrola</code>
<p>
<li>If you use the eSpeak voice such as "<b>mb-en1</b>" then eSpeak will use the mbrola "en1" voice, eg:<br>
<code>espeak -v mb-en1 "Hello world"
<code>espeak-ng -v mb-en1 "Hello world"
</code>
<p><p>
To generate mbrola phoneme data (.pho file) you can use:<br>
<code>espeak -v mb-en1 -q --pho "Hello world"</code>
<code>espeak-ng -v mb-en1 -q --pho "Hello world"</code>
<br>or<br>
<code>espeak -v mb-en1 -q --pho --phonout=out.pho "Hello world"</code>
<code>espeak-ng -v mb-en1 -q --pho --phonout=out.pho "Hello world"</code>

</ol>
<h3>Mbrola Voice Files</h3>

+ 1
- 1
docs/phonemes.html View File

@@ -18,7 +18,7 @@ In most cases different languages inherit the same basic set of consonants. The
<p>
The phoneme mnemonics are based on the scheme by Kirshenbaum which represents International Phonetic Alphabet symbols using ascii characters. See: <a href="http://www.kirshenbaum.net/IPA/ascii-ipa.pdf">www.kirshenbaum.net/IPA/ascii-ipa.pdf</a>.
<p>
Phoneme mnemonics can be used directly in the text input to <strong>espeak</strong>. They are enclosed within double square brackets. Spaces are used to separate words, and all stressed syllables must be marked explicitly. eg:<br>
Phoneme mnemonics can be used directly in the text input to <strong>espeak-ng</strong>. They are enclosed within double square brackets. Spaces are used to separate words, and all stressed syllables must be marked explicitly. eg:<br>
<code>[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]</code>
<h3>English Consonants</h3>
<table>

+ 4
- 4
docs/voices.html View File

@@ -14,13 +14,13 @@
A Voice file specifies a language (and possibly a language variant or dialect) together with various attributes that affect the characteristics of the voice quality and how the language is spoken.<p>
Voice files are placed in the <code>espeak-data/voices</code> directory, or within subdirectories in there.<p>
The available voice files can be listed by:<pre>
espeak --voices
espeak-ng --voices
or
espeak --voices=&lt;language&gt;</pre>
espeak-ng --voices=&lt;language&gt;</pre>
also
<pre> espeak --voices=&lt;variant&gt;</pre>
<pre> espeak-ng --voices=&lt;variant&gt;</pre>
Lists voice variants which can be applied to eSpeak voices.
<pre> espeak --voices=&lt;mbrola&gt;</pre>
<pre> espeak-ng --voices=&lt;mbrola&gt;</pre>
Lists the Mbrola voices.
<hr>
<h3>5.2 Contents of Voice Files</h3>

Loading…
Cancel
Save