mahta.fetrat
/
HomoFast-eSpeak-Persian
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

Syntax of tables fixed for Github flawor

master
Valdis Vitolins 9 years ago
parent
13afeb3ccb
commit
32dbffd43f
5 changed files with 190 additions and 309 deletions
Split View Show Diff Stats
  1. 80
    117
      docs/commands.md
  2. 4
    5
      docs/dictionary.md
  3. 60
    111
      docs/phonemes.md
  4. 42
    71
      docs/phontab.md
  5. 4
    5
      docs/ssml.md

+ 80
- 117
docs/commands.md View File

@@ -24,8 +24,7 @@ path, e.g. in **/usr/local/bin**

Place the **espeak-data** directory in **/usr/share** as **/usr/share/espeak-data**.

Alternatively if it is placed in the user's home directory (e.g.
**/home/\<user\>/espeak-data**) then that will be used instead.
Alternatively if it is placed in the user's home directory (e.g. **/home/\<user\>/espeak-data**) then that will be used instead.

## Dependencies

@@ -70,88 +69,74 @@ Use **espeak-ng -x** to see the corresponding phoneme codes.

## The Command Line Options

**espeak-ng [options] ["text words"]**
* **espeak-ng [options] ["text words"]**
Text input can be taken either from a file, from a string in the command, or from stdin.

> Text input can be taken either from a file, from a string in the command, or from stdin.
* **-f \<text file\>**
Speaks a text file.

**-f \<text file\>**
* **--stdin**
Takes the text input from stdin. If neither -f nor --stdin is given, then the text input is taken from "text words" (a text string within double quotes). If that is not present then text is taken from stdin, but each line is treated as a separate sentence.

> Speaks a text file.
* **-a \<integer\>**
Sets amplitude (volume) in a range of 0 to 200. The default is 100.

**--stdin**
* **-p \<integer\>**
Adjusts the pitch in a range of 0 to 99. The default is 50.

> Takes the text input from stdin. If neither -f nor --stdin is given, then the text input is taken from "text words" (a text string within double quotes). If that is not present then text is taken from stdin, but each line is treated as a separate sentence.

**-a \<integer\>**

> Sets amplitude (volume) in a range of 0 to 200. The default is 100.

**-p \<integer\>**

> Adjusts the pitch in a range of 0 to 99. The default is 50.

**-s \<integer\>**

> Sets the speed in words-per-minute (approximate values for the
* **-s \<integer\>**
Sets the speed in words-per-minute (approximate values for the
default English voice, others may differ slightly). The default
value is 175. I generally use a faster speed of 260. The lower limit
is 80. There is no upper limit, but about 500 is probably a
practical maximum.

**-b \<integer\>**

> Input text character format.
> 1   UTF-8. This is the default.
> 2   The 8-bit character set which corresponds to the language (eg. Latin-2 for Polish).
> 4   16 bit Unicode.
> Without this option, eSpeak NG assumes text is UTF-8, but will
* **-b \<integer\>**
Input text character format.
1   UTF-8. This is the default.
2   The 8-bit character set which corresponds to the language (eg. Latin-2 for Polish).
4   16 bit Unicode.
Without this option, eSpeak NG assumes text is UTF-8, but will
automatically switch to the 8-bit character set if it finds an
illegal UTF-8 sequence.

**-g \<integer\>**

> Word gap. This option inserts a pause between words. The value is
* **-g \<integer\>**
Word gap. This option inserts a pause between words. The value is
the length of the pause, in units of 10 mS (at the default speed of
170 wpm).

**-h** or **--help**

> The first line of output gives the eSpeak NG version number.
* **-h** or **--help**
The first line of output gives the eSpeak NG version number.

**-k \<integer\>**

> Indicate words which begin with capital letters.
> 1   eSpeak NG uses a click sound to indicate when a word starts with a
capital letter, or double click if word is all capitals.
> 2   eSpeak NG speaks the word "capital" before a word which begins with
a capital letter.
> Other values:   eSpeak NG increases the pitch for words which begin
* **-k \<integer\>**
Indicate words which begin with capital letters.
1   eSpeak NG uses a click sound to indicate when a word starts with a
apital letter, or double click if word is all capitals.
2   eSpeak NG speaks the word "capital" before a word which begins with
capital letter.
Other values:   eSpeak NG increases the pitch for words which begin
with a capital letter. The greater the value, the greater the
increase in pitch. Try -k20.

**-l \<integer\>**

> Line-break length, default value 0. If set, then lines which are
* **-l \<integer\>**
Line-break length, default value 0. If set, then lines which are
shorter than this are treated as separate clauses and spoken
separately with a break between them. This can be useful for some
text files, but bad for others.

**-m**

> Indicates that the text contains SSML (Speech Synthesis Markup
* **-m**
Indicates that the text contains SSML (Speech Synthesis Markup
Language) tags or other XML tags. Those SSML tags which are
supported are interpreted. Other tags, including HTML, are ignored,
except that some HTML tags such as \<hr\> \<h2\> and \<li\> ensure a
break in the speech.

**-q**

> Quiet. No sound is generated. This may be useful with options such
* **-q**
Quiet. No sound is generated. This may be useful with options such
as -x and --pho.

**-v \<voice filename\>[+\<variant\>]**

> Sets a Voice for the speech, usually to select a language. eg:
* **-v \<voice filename\>[+\<variant\>]**
Sets a Voice for the speech, usually to select a language. eg:
`espeak-ng -vaf` To use the Afrikaans voice. A modifier after the voice name can be used to vary the tone of the voice, eg:
`espeak-ng -vaf+3`
The variants are `+m1 +m2 +m3 +m4 +m5 +m6 +m7` for male voices and `+f1 +f2 +f3 +f4 `which simulate female voices by using higher pitches. Other variants include `+croak` and `+whisper`.
@@ -161,92 +146,70 @@ Voice files can specify a language, alternative pronunciations or phoneme sets,
Voice names which start with **mb-** are for use with Mbrola diphone voices, see [mbrola](mbrola.md)
Some languages may need additional dictionary data, see [languages](languages.md)

**-w \<wave file\>**

> Writes the speech output to a file in WAV format, rather than speaking it.

**-x**

> The phoneme mnemonics, into which the input text is translated, are written to stdout. If a phoneme name contains more than one letter (eg. [tS]), the --sep or --tie option can be used to distinguish this from separate phonemes.

**-X**
* **-w \<wave file\>**
Writes the speech output to a file in WAV format, rather than speaking it.

> As -x, but in addition, details are shown of the pronunciation rule and dictionary list lookup. This can be useful to see why a certain pronunciation is being produced. Each matching pronunciation rule is listed, together with its score, the highest scoring rule being used in the translation. "Found:" indicates the word was found in the dictionary lookup list, and "Flags:" means the word was found with only properties and not a pronunciation. You can see when a word has been retranslated after removing a prefix or suffix.
* **-x**
The phoneme mnemonics, into which the input text is translated, are written to stdout. If a phoneme name contains more than one letter (eg. [tS]), the --sep or --tie option can be used to distinguish this from separate phonemes.

**-z**
* **-X**
As -x, but in addition, details are shown of the pronunciation rule and dictionary list lookup. This can be useful to see why a certain pronunciation is being produced. Each matching pronunciation rule is listed, together with its score, the highest scoring rule being used in the translation. "Found:" indicates the word was found in the dictionary lookup list, and "Flags:" means the word was found with only properties and not a pronunciation. You can see when a word has been retranslated after removing a prefix or suffix.

> The option removes the end-of-sentence pause which normally occurs at the end of the text.
* **-z**
The option removes the end-of-sentence pause which normally occurs at the end of the text.

**--stdout**
* **--stdout**
Writes the speech output to stdout as it is produced, rather than speaking it. The data starts with a WAV file header which indicates the sample rate and format of the data. The length field is set to zero because the length of the data is unknown when the header is produced.

> Writes the speech output to stdout as it is produced, rather than speaking it. The data starts with a WAV file header which indicates the sample rate and format of the data. The length field is set to zero because the length of the data is unknown when the header is produced.
* **--compile [=\<voice name\>]**
Compile the pronunciation rule and dictionary lookup data from their source files in the current directory. The Voice determines which language's files are compiled. For example, if it's an English voice, then *en\_rules*, *en\_list*, and *en\_extra* (if present), are compiled to replace *en\_dict* in the *speak-data* directory. If no Voice is specified then the default Voice is used.

**--compile [=\<voice name\>]**
* **--compile-debug [=\<voice name\>]**
The same as **--compile**, but source line numbers from the \*\_rules file are included. These are included in the rules trace when the **-X** option is used.

> Compile the pronunciation rule and dictionary lookup data from their source files in the current directory. The Voice determines which language's files are compiled. For example, if it's an English voice, then *en\_rules*, *en\_list*, and *en\_extra* (if present), are compiled to replace *en\_dict* in the *speak-data* directory. If no Voice is specified then the default Voice is used.

**--compile-debug [=\<voice name\>]**
* **--ipa**
Writes phonemes to stdout, using the International Phonetic Alphabet (IPA). If a phoneme name contains more than one letter (eg. [tS]), the --sep or --tie option can be used to distinguish this from separate phonemes.

> The same as **--compile**, but source line numbers from the \*\_rules file are included. These are included in the rules trace when the **-X** option is used.
* **--path [="\<directory path\>"]**
Specifies the directory which contains the espeak-data directory.

* **--pho**
When used with an mbrola voice (eg. -v mb-en1), it writes mbrola phoneme data (.pho file format) to stdout. This includes the mbrola phoneme names with duration and pitch information, in a form which is suitable as input to this mbrola voice. The --phonout option can be used to write this data to a file.

**--ipa**
* **--phonout [="\<filename\>"]**
If specified, the output from -x, -X, --ipa, and --pho options is written to this file, rather than to stdout.

> Writes phonemes to stdout, using the International Phonetic Alphabet (IPA). If a phoneme name contains more than one letter (eg. [tS]), the --sep or --tie option can be used to distinguish this from separate phonemes.

**--path [="\<directory path\>"]**

> Specifies the directory which contains the espeak-data directory.

**--pho**

> When used with an mbrola voice (eg. -v mb-en1), it writes mbrola phoneme data (.pho file format) to stdout. This includes the mbrola phoneme names with duration and pitch information, in a form which is suitable as input to this mbrola voice. The --phonout option can be used to write this data to a file.

**--phonout [="\<filename\>"]**

> If specified, the output from -x, -X, --ipa, and --pho options is written to this file, rather than to stdout.

**--punct [="\<characters\>"]**

> Speaks the names of punctuation characters when they are encountered in the text. If \<characters\> are given, then only those listed punctuation characters are spoken, eg. `--punct=".,;?"`
* **--punct [="\<characters\>"]**
Speaks the names of punctuation characters when they are encountered in the text. If \<characters\> are given, then only those listed punctuation characters are spoken, eg. `--punct=".,;?"`
**--sep [=\<character\>]**

> The character is used to separate individual phonemes in the output which is produced by the -x or --ipa options. The default is a space character. The character z means use a ZWNJ character (U+200c).
* **--sep [=\<character\>]**
The character is used to separate individual phonemes in the output which is produced by the -x or --ipa options. The default is a space character. The character z means use a ZWNJ character (U+200c).

**--split [=\<minutes\>]**
* **--split [=\<minutes\>]**
Used with **-w**, it starts a new WAV file every `<minutes>` minutes, at the next sentence boundary.

> Used with **-w**, it starts a new WAV file every `<minutes>` minutes, at the next sentence boundary.
* **--tie [=\<character\>]**
The character is used within multi-letter phonemes in the output which is produced by the -x or --ipa options. The default is the tie character  ͡ U+361. The character z means use a ZWJ character (U+200d).

**--tie [=\<character\>]**

> The character is used within multi-letter phonemes in the output which is produced by the -x or --ipa options. The default is the tie character  ͡ U+361. The character z means use a ZWJ character (U+200d).

**--voices [=\<language code\>]**

> Lists the available voices.
If =\<language code\> is present then only those voices which are suitable for that language are listed.

> `--voices=mbrola` lists the voices which use mbrola diphone voices. These are not included in the default `--voices` list.

> `--voices=variant` lists the available voice variants (voice modifiers).
* **--voices [=\<language code\>]**
Lists the available voices.
If =\<language code\> is present then only those voices which are suitable for that language are listed.
`--voices=mbrola` lists the voices which use mbrola diphone voices. These are not included in the default `--voices` list.
`--voices=variant` lists the available voice variants (voice modifiers).

## The Input Text

**HTML Input**

> If the -m option is used to indicate marked-up text, then HTML can
* **HTML Input**
If the -m option is used to indicate marked-up text, then HTML can
be spoken directly.

**Phoneme Input**

> As well as plain text, phoneme mnemonics can be used in the text
* **Phoneme Input**
As well as plain text, phoneme mnemonics can be used in the text
input to **espeak-ng**. They are enclosed within double square
brackets. Spaces are used to separate words and all stressed
syllables must be marked explicitly.
eg:  

> `espeak-ng -v en "[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]"`

> This command will speak: "This is some phonetic text input".
eg:
`espeak-ng -v en "[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]"`
This command will speak: "This is some phonetic text input".


+ 4
- 5
docs/dictionary.md View File

@@ -141,9 +141,8 @@ are used in \<pre\> and \<post\> with special meanings.
### Special characters in \<phoneme string\>:


**_^_\<language code\>**

> Translate using a different language.
* **_^_\<language code\>**
Translate using a different language.
If this rule is selected when translating a word, then the translation is aborted and the word is re-translated using the specified different language. \<language code\> may be upper or lower case. This can be used to recognise certain letter combinations as being foreign words and to use the foreign pronunciation for them. eg:
`th (_ _^_EN`

@@ -326,7 +325,7 @@ $u | The word is unstressed. In the case of a multi-sylla
$u1 | The word is unstressed, with a slight stress on its 1st syllable.
$u2 | The word is unstressed, with a slight stress on its 2nd syllable.
$u3 | The word is unstressed, with a slight stress on its 3rd syllable.
$u+ $u1+ $u2+ $u3+ | As above, but the word has full stress if it's at the end of a clause.
$u+ $u1+ $u2+ $u3+ | As above, but the word has full stress if it's at the end of a clause.
$1 | Primary stress on the 1st syllable.
$2 | Primary stress on the 2nd syllable.
$3 | Primary stress on the 3rd syllable.
@@ -352,7 +351,7 @@ $sentence | The rule only applies if the clause includes end-of-
$abbrev | This has two meanings. If there is no phoneme string: Speak the word as individual letters, even if it contains a vowel (eg. "abc" should be spoken as "a" "b" "c"). If there is a phoneme string: This word is capitalized because it is an abbreviation and capitalization does not indicate emphasis (if the "emphasize all-caps" is on).
$accent | Used for the pronunciation of a single alphabetic character. The character name is spoken as the base-letter name plus the accent (diacritic) name. eg. It can be used to specify that "â" is spoken as "a" "circumflex".
$combine | This word is treated as though it is combined with the following word with a hyphen. This may be subject to fuither conditions for certain languages.
$alt   $alt2   $alt3 | These are language specific. Their use should be described in the language's \*\*\_list file
$alt   $alt2   $alt3 | These are language specific. Their use should be described in the language's \*\*\_list file
$verb | Use this pronunciation if it's a verb.
$noun | Use this pronunciation if it's a noun.
$past | Use this pronunciation if it's past tense.

+ 60
- 111
docs/phonemes.md View File

@@ -26,41 +26,28 @@ explicitly. eg:

## English Consonants

+----------------+-------------------------------+
|\[p\] | \[b\] |
+----------------+-------------------------------+
|\[t\] | \[d\] |
+----------------+-------------------------------+
|\[tS\] **ch**urch | \[dZ\] **j**udge |
+----------------+-------------------------------+
|\[k\] | \[g\] |
+----------------+-------------------------------+
|\[f\] | \[v\] |
+----------------+-------------------------------+
|\[T\] **th**in | \[D\] **th**is |
+----------------+-------------------------------+
|\[s\] | \[z\] |
+----------------+-------------------------------+
|\[S\] **sh**op | \[Z\] plea**s**ure |
+----------------+-------------------------------+
|\[h\] | |
+----------------+-------------------------------+
|\[m\] | \[n\] |
+----------------+-------------------------------+
|\[N\] si**ng** | |
+----------------+-------------------------------+
|\[l\] | \[r\] **r**ed (Omitted if not immediately followed by a vowel). |
+----------------+-------------------------------+
|\[j\] **y**es | \[w\] |
+----------------+-------------------------------+
Phoneme|Phoneme
----------------|-----------
\[p\] | \[b\]
\[t\] | \[d\]
\[tS\] **ch**urch | \[dZ\] **j**udge
\[k\] | \[g\]
\[f\] | \[v\]
\[T\] **th**in | \[D\] **th**is
\[s\] | \[z\]
\[S\] **sh**op | \[Z\] plea**s**ure
\[h\] |
\[m\] | \[n\]
\[N\] si**ng** |
\[l\] | \[r\] **r**ed (Omitted if not immediately followed by a vowel). |
\[j\] **y**es | \[w\]

## Some Additional Consonants

+-------------------------+---------------------------+
| \[C]\ German i**ch** | \[x\] German bu**ch** |
+---------------------+-------------------------------+
| \[l^\] Italian **g**li | \[n^\] Spanish **ñ** |
+-------------------------+---------------------------+
Phoneme|Phoneme
------------------------|-----------
\[C]\ German i**ch** | \[x\] German bu**ch**
\[l^\] Italian **g**li | \[n^\] Spanish **ñ**

## English Vowels

@@ -72,89 +59,51 @@ because they may differ in another variety.
In rhotic accents, such as General American, the phonemes
`[3:], [A@], [e@], [i@], [O@], [U@]` include the "r" sound.

+---------+--------------------------+---------------------------------------------------------------------+
|\[@\] | alph**a** | schwa |
+---------+--------------------------+---------------------------------------------------------------------+
|\[3\] | bett**er** | rhotic schwa. In British English this is the same as \[@\], |
| | | but it includes 'r' colouring in American and other rhotic accents. |
| | | In these cases a separate \[r\] should not be included unless it is |
| | | followed immediately by another vowel. |
+---------+--------------------------+---------------------------------------------------------------------+
|\[3:\] | n**ur**se | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[@L\] | simp**le** | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[@2\] | the Used only for "the". | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[@5\] | to Used only for "to". | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[a\] | tr**a**p | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[aa\] | b**a**th | This is \[a\] in some accents, \[A:\] in others. |
+---------+--------------------------+---------------------------------------------------------------------+
|\[a#\] | **a**bout | This may be \[@\] or may be a more open schwa. |
+---------+--------------------------+---------------------------------------------------------------------+
|\[A:\] | p**al**m | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[A@\] | st**ar**t | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[E\] | dr**e**ss | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[e@\] | squ**are** | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[I\] | k**i**t | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[I2\] | **i**ntend | As \[I\], but also indicates an unstressed syllable. |
+---------+--------------------------+---------------------------------------------------------------------+
|\[i\] | happ**y** | An unstressed "i" sound at the end of a word. |
+---------+--------------------------+---------------------------------------------------------------------+
|\[i:\] | fl**ee**ce | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[i@\] | n**ear** | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[0\] | l**o**t | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[V\] | str**u**t | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[u:\] | g**oo**se | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[U\] | f**oo**t | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[U@\] | c**ure** | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[O:\] | th**ou**ght | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[O@\] | n**or**th | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[o@\] | f**or**ce | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[aI\] | pr**i**ce | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[eI\] | f**a**ce | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[OI\] | ch**oi**ce | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[aU\] | m**ou**th | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[oU\] | g**oa**t | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[aI@\] | sc**ie**nce | |
+---------+--------------------------+---------------------------------------------------------------------+
|\[aU@\] | h**our** | |
+---------+--------------------------+---------------------------------------------------------------------+
Phoneme|Pronunciation|Description
----------|-------------------------|--------------------------------------------
\[@\] | alph**a** | schwa
\[3\] | bett**er** | rhotic schwa. In British English this is the same as \[@\], but it includes 'r' colouring in American and other rhotic accents. In these cases a separate \[r\] should not be included unless it is followed immediately by another vowel.
\[3:\] | n**ur**se |
\[@L\] | simp**le** |
\[@2\] | the Used only for "the". |
\[@5\] | to Used only for "to". |
\[a\] | tr**a**p |
\[aa\] | b**a**th | This is \[a\] in some accents, \[A:\] in others.
\[a#\] | **a**bout | This may be \[@\] or may be a more open schwa.
\[A:\] | p**al**m |
\[A@\] | st**ar**t |
\[E\] | dr**e**ss |
\[e@\] | squ**are** |
\[I\] | k**i**t |
\[I2\] | **i**ntend | As \[I\], but also indicates an unstressed syllable.
\[i\] | happ**y** | An unstressed "i" sound at the end of a word.
\[i:\] | fl**ee**ce |
\[i@\] | n**ear** |
\[0\] | l**o**t |
\[V\] | str**u**t |
\[u:\] | g**oo**se |
\[U\] | f**oo**t |
\[U@\] | c**ure** |
\[O:\] | th**ou**ght |
\[O@\] | n**or**th |
\[o@\] | f**or**ce |
\[aI\] | pr**i**ce |
\[eI\] | f**a**ce |
\[OI\] | ch**oi**ce |
\[aU\] | m**ou**th |
\[oU\] | g**oa**t |
\[aI@\] | sc**ie**nce |
\[aU@\] | h**our** |

## Some Additional Vowels

Other languages will have their own vowel definitions, eg:

+---------+--------------------------------------+
| \[e\] | German **eh**, French **é** |
+-------------------+----------------------------+
| \[o\] | German **oo**, French **o** |
+-------------------+----------------------------+
| \[y\] | German **ü**, French **u** |
+-------------------+----------------------------+
| \[Y\] | German **ö**, French **oe** |
+---------+--------------------------------------+
Phoneme|Description
--------|------------------------
\[e\] | German **eh**, French **é**
\[o\] | German **oo**, French **o**
\[y\] | German **ü**, French **u**
\[Y\] | German **ö**, French **oe**

**\[:\]** can be used to lengthen a vowel, eg \[e:\]

+ 42
- 71
docs/phontab.md View File

@@ -118,77 +118,48 @@ indicates only for vowels, (C) only for consonants)

Type. One of these must be present.

+------------+-----------------------------------------------+
| **vowel** | |
+------------+-----------------------------------------------+
| **liquid** | semi-vowels, such as: `r, l, j, w` |
+------------+-----------------------------------------------+
| **nasal** | nasal eg: `m, n, N` |
+------------+-----------------------------------------------+
| **stop** | stop eg: `p, b, t, d, k, g` |
+------------+-----------------------------------------------+
| **frc** | fricative eg: `f, v, T, D, s, z, S, Z, C, x` |
+------------+-----------------------------------------------+
| **afr** | affricate eg: `tS, dZ` |
+------------+-----------------------------------------------+
| **pause** | |
+------------+-----------------------------------------------+
| **stress** | used for stress symbols, eg: ' , = % |
+------------+-----------------------------------------------+
| **virtual**| Used to represent a class of phonemes. |
+------------+-----------------------------------------------+
Type|Description
-----------|----------------------------------------------
**vowel** |
**liquid** | semi-vowels, such as: `r, l, j, w`
**nasal** | nasal eg: `m, n, N`
**stop** | stop eg: `p, b, t, d, k, g`
**frc** | fricative eg: `f, v, T, D, s, z, S, Z, C, x`
**afr** | affricate eg: `tS, dZ`
**pause** |
**stress** | used for stress symbols, eg: ' , = %
**virtual**| Used to represent a class of phonemes.

Properties:

+--------------+----------------------------------------------------------------------------------+
|**vls** | (C) voiceless eg. `p, t, k, f, s` |
+--------------+----------------------------------------------------------------------------------+
|**vcd** | (C) voiced eg. `b, d, g, v, z` |
+--------------+----------------------------------------------------------------------------------+
|**sibilant** | (C) eg: `s, z, S, Z, tS, dZ` |
+--------------+----------------------------------------------------------------------------------+
|**palatal** | (C) A palatal or palatalized consonant. |
+--------------+----------------------------------------------------------------------------------+
|**rhotic** | (C) An "r" type consonant. |
+--------------+----------------------------------------------------------------------------------+
|**unstressed**| (V) This vowel is always unstressed, unless explicitly marked otherwise. |
+--------------+----------------------------------------------------------------------------------+
|**nolink** | Prevent any linking from the previous phoneme. |
+--------------+----------------------------------------------------------------------------------+
|**nopause** | Used in a `liquid` or `nasal` phoneme to prevent eSpeak inserting a short |
| | pause if a word starts with this phoneme and the previous word ends with a vowel.|
+--------------+----------------------------------------------------------------------------------+
|**trill** | (C) Apply trill to the voicing. |
+--------------+----------------------------------------------------------------------------------+
Property|Description
--------------|--------------------------------------
**vls** | (C) voiceless eg. `p, t, k, f, s`
**vcd** | (C) voiced eg. `b, d, g, v, z`
**sibilant** | (C) eg: `s, z, S, Z, tS, dZ`
**palatal** | (C) A palatal or palatalized consonant.
**rhotic** | (C) An "r" type consonant.
**unstressed**| (V) This vowel is always unstressed, unless explicitly marked otherwise.
**nolink** | Prevent any linking from the previous phoneme.
**nopause** | Used in a `liquid` or `nasal` phoneme to prevent eSpeak inserting a short pause if a word starts with this phoneme and the previous word ends with a vowel.
**trill** | \(C\) Apply trill to the voicing.

Place of Articulation (C):

+--------+------------------+
|**blb** | bi-labial |
+--------+------------------+
|**ldb** | labio-dental |
+--------+------------------+
|**dnt** | dental |
+--------+------------------+
|**alv** | alveolar |
+--------+------------------+
|**rfx** | retroflex |
+--------+------------------+
|**pla** | palato-alveolar |
+--------+------------------+
|**pal** | palatal |
+--------+------------------+
|**vel** | velar |
+--------+------------------+
|**lbv** | labio-velar |
+--------+------------------+
|**uvl** | uvular |
+--------+------------------+
|**phr** | pharyngeal |
+--------+------------------+
|**glt** | glottal |
+--------+------------------+

Articulation|Description
--------|------------------
**blb** | bi-labial
**ldb** | labio-dental
**dnt** | dental
**alv** | alveolar
**rfx** | retroflex
**pla** | palato-alveolar
**pal** | palatal
**vel** | velar
**lbv** | labio-velar
**uvl** | uvular
**phr** | pharyngeal
**glt** | glottal

* **starttype** \<phoneme\>
Allocates this phoneme to a group so that conditions such as nextPh(#e) can test for any of a group of phonemes. Pre-defined groups for use for vowels are: #@ #a #e #i #o #u. Additional groups can be defined as phonemes with type "virtual".
@@ -441,13 +412,13 @@ is limited by the speak program.
2: f1 formant frequency decreases more.

* **f2=<freq> <min> <max>**
<freq>: The frequency towards which the f2 formant moves (Hz).
<min>: Signed integer (Hz). The minimum f2 frequency change.
<max>: Signed integer (Hz). The maximum f2 frequency change.
\<freq\>: The frequency towards which the f2 formant moves (Hz).
\<min\>: Signed integer (Hz). The minimum f2 frequency change.
\<max\>: Signed integer (Hz). The maximum f2 frequency change.

* **f3=<change> <amplitude>**
<change>: Signed integer (Hz). Frequence change of f3, f4, and f5 formants.
<amplitude>: Amplitude of the f3, f4, and f5 formants at the end of the transition. 100 = no change.
* **f3=<change> <amplitude>**
\<change\>: Signed integer (Hz). Frequence change of f3, f4, and f5 formants.
\<amplitude\>: Amplitude of the f3, f4, and f5 formants at the end of the transition. 100 = no change.

* **brk**
Break. Do not merge the synthesized wave of the consonant into the vowel. This will produce a discontinuity in the formants.

+ 4
- 5
docs/ssml.md View File

@@ -67,12 +67,11 @@ eSpeak can speak HTML text directly, or text containing both SSML and HTML marku
Any unrecognised tags are ignored.

The following tags case a sentence break.
**\<br\> \<dd\> \<li\> \<img\> \<td\> **
**\<br\> \<dd\> \<li\> \<img\> \<td\>**

The following tags case a paragraph break.
**\<h1\> \<h2\> \<h3\> \<h4\> \<hr\> **
**\<h1\> \<h2\> \<h3\> \<h4\> \<hr\>**

Text between the following tags is ignored.
**\<script\> ... \</script\>
\<style\> ... \</style\>
**
**\<script\> ... \</script\>**
**\<style\> ... \</style\>**

Write Preview
Loading…
Cancel
Save