From 75719bf8143d23cadf5fd7c1aebd77510bdcf5d4 Mon Sep 17 00:00:00 2001 From: "Reece H. Dunn" Date: Sat, 26 Dec 2015 13:51:48 +0000 Subject: [PATCH] Fix and update the phontab.md documentation; merge in the relevant parts of the phonemes documentation. --- Makefile.am | 1 + docs/index.md | 1 - docs/phonemes.html | 168 ----------- docs/phonemes.md | 109 ------- docs/phontab.html | 387 ------------------------ docs/phontab.md | 726 ++++++++++++++++++++++++++++----------------- 6 files changed, 451 insertions(+), 941 deletions(-) delete mode 100644 docs/phonemes.html delete mode 100644 docs/phonemes.md delete mode 100644 docs/phontab.html diff --git a/Makefile.am b/Makefile.am index 95370d16..e2281e4a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -65,6 +65,7 @@ docs: docs/index.html \ docs/add_language.html \ docs/dictionary.html \ docs/mbrola.html \ + docs/phontab.html \ docs/voices.html \ src/espeak-ng.1.html \ README.html \ diff --git a/docs/index.md b/docs/index.md index 73975729..4ce0f1c7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,6 @@ - [Text to Phoneme Translation](dictionary.md) - [Voice Files](voices.md) - [MBROLA Voices](mbrola.md) - - [Phonemes](phonemes.md) - [Phoneme Tables](phontab.md) - [Intonation](intonation.md) - [Markup Tags](ssml.md) diff --git a/docs/phonemes.html b/docs/phonemes.html deleted file mode 100644 index 3c1a29ad..00000000 --- a/docs/phonemes.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - sSpeak: Phonemes - - - - - -Back -
-

PHONEMES

-
-In general a different set of phonemes can be defined for each language. -

-In most cases different languages inherit the same basic set of consonants. They can add to these or modify them as needed. -

-The phoneme mnemonics are based on the scheme by Kirshenbaum which represents International Phonetic Alphabet symbols using ascii characters. See: www.kirshenbaum.net/IPA/ascii-ipa.pdf. -

-Phoneme mnemonics can be used directly 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:
-[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]] -

English Consonants

- - - - - - - - - - - - - - - - -

-

- - -
[p] -[b] -
[t] -[d] -
[tS]church -[dZ]judge -
[k] -[g] -

- -

[f] -[v] -
[T]thin -[D]this -
[s] -[z] -
[S]shop -[Z]pleasure -
[h] -

- -

[m] -[n] -
[N]sing -
[l] -[r]red (Omitted if not immediately followed by a vowel). -
[j]yes -[w] -

- -

Some Additional Consonants
[C]German ich -[x]German buch -
[l^]Italian gli -[n^]Spanish ñ - -
- - - - - - -

English Vowels

-These are the phonemes which are used by the English spelling-to-phoneme translations (en_rules and en_list). In some varieties of English different phonemes may have the same sound, but they are kept separate 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. -

- - - - -
[@] -alphaschwa - -
[3] -betterrhotic 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:]nurse -
[@L]simple -
[@2]theUsed only for "the". -
[@5]toUsed only for "to". -

- -

[a]trap -
[aa]bathThis is [a] in some accents, [A:] in others. -
[a#]aboutThis may be [@] or may be a more open schwa. -
[A:]palm -
[A@]start -

- -

[E]dress -
[e@]square -

- -

[I]kit -
[I2]intendAs [I], but also indicates an unstressed syllable. -
[i]happyAn unstressed "i" sound at the end of a word. -
[i:]fleece -
[i@]near -

- -

[0]lot -

- -

[V]strut -

- -

[u:]goose -
[U]foot -
[U@]cure -

- -

[O:]thought -
[O@]north -
[o@]force -

- - -

[aI]price -
[eI]face -
[OI]choice -
[aU]mouth -
[oU]goat - -
[aI@]science -
[aU@]hour -
- -

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 - -
-

- [:] can be used to lengthen a vowel, eg [e:] - - - diff --git a/docs/phonemes.md b/docs/phonemes.md deleted file mode 100644 index d2758a67..00000000 --- a/docs/phonemes.md +++ /dev/null @@ -1,109 +0,0 @@ -# Table of contents - - * [Phonemes](#phonemes) - * [English Consonants](#english-consonants) - * [Some Additional Consonants](#some-additional-consonants) - * [English Vowels](#english-vowels) - * [Some Additional Vowels](#some-additional-vowels) - -# Phonemes - -In general a different set of phonemes can be defined for each language. - -In most cases different languages inherit the same basic set of -consonants. They can add to these or modify them as needed. - -The phoneme mnemonics are based on the scheme by Kirshenbaum which -represents International Phonetic Alphabet symbols using ascii -characters. See: -[www.kirshenbaum.net/IPA/ascii-ipa.pdf](http://www.kirshenbaum.net/IPA/ascii-ipa.pdf). - -Phoneme mnemonics can be used directly 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: -\[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]\] - -## English Consonants - -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 - -Phoneme|Phoneme -------------------------|----------- -\[C]\ German i**ch** | \[x\] German bu**ch** -\[l^\] Italian **g**li | \[n^\] Spanish **ñ** - -## English Vowels - -These are the phonemes which are used by the English spelling-to-phoneme -translations (en\_rules and en\_list). In some varieties of English -different phonemes may have the same sound, but they are kept separate -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. - -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: - -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:\] diff --git a/docs/phontab.html b/docs/phontab.html deleted file mode 100644 index 2bd9e01d..00000000 --- a/docs/phontab.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - eSpeak: Phoneme tables - - - - -Back -

-

PHONEME TABLES

-
-A phoneme table defines all the phonemes which are used by a language, together with their properties and the data for their production as sounds. -

-Generally each language has its own phoneme table, although additional phoneme tables can be used for different voices within the language. These alternatives are referenced from Voice files. -

-A phoneme table does not need to define all the phonemes used by a language. It can inherit the phonemes from a previously defined phoneme table. For example, a phoneme table may redefine (or add) some of the vowels that it uses, but inherit most of its consonants from a standard set. -

-The source files for the phoneme data are in the "phsource" directory in the espeakedit download package. "Vowel files", which are referenced in FMT(), VowelStart(), and VowelEnding() instructions are made using the espeakedit program. - -

 

-

Phoneme files

-The phoneme tables are defined in a master phoneme file, named phonemes. This starts with the base phoneme table followed by phoneme tables for other languages and voices. These inherit phonemes from the base table or previously defined tables. -

-In addition to phoneme definitions, the phoneme file can contain the following: -

-
include <filename> -
Includes the text of the specified file at this point. This allows different phoneme tables to be kept in different text files, for convenience. <filename> is a relative path. The included file can itself contain include statements. -

-

phonemetable <name> <parent> -
Starts a new phoneme table, and ends the previous table.
-<name> Is the name of this phoneme table. This name is used in Voice files.
-<parent> Is the name of a previously defined phoneme table whose phoneme definitions are inherited by this one. The name base indicates the first (base) phoneme table. - -
-

 

-

Phoneme definitions

-Note: These new Phoneme definitions apply to eSpeak version 1.42.20 and later. -

-A phoneme table contains a list of phoneme definitions. Each starts with the keyword phoneme and the phoneme name (this is the name used in the pronunciation rules in a language's *_rules and *_list files), and ends with the keyword endphoneme. For example: -

  phoneme aI
-    vowel
-    starttype #a endtype #i
-    length 230
-    FMT(vowels/ai)
-  endphoneme
-
-  phoneme s
-    vls alv frc sibilant
-    voicingswitch z
-    lengthmod 3
-    Vowelin  f1=0  f2=1700 -300 300  f3=-100 80
-    Vowelout f1=0  f2=1700 -300 250  f3=-100 80  rms=20
-
-    IF nextPh(isPause) THEN
-      WAV(ufric/s_)
-    ELIF nextPh(p) OR nextPh(t) OR nextPh(k) THEN
-      WAV(ufric/s!)
-    ENDIF
-    WAV(ufric/s)
-  endphoneme
-
-
-

-A phoneme definition contains both static properties and executed instructions. The instructions may contain conditional statements, so that the effect of the phoneme may be different depending on adjacent phonemes, whether the syllable is stressed, etc. -

-The instructions of a phoneme are interpreted in two different phases. In the first phase, the instructions may change the phoneme and replace it by a different phoneme. In the second phase, instructions are used to produce the sound for the phoneme. -

-The import_phoneme statement can be used to copy a previously defined phoneme from a specified phoneme table. For example: -

-  phoneme t
-    import_phoneme base/t[
-  endphoneme 
-
-means: phoneme t in this phoneme table is a copy of phoneme t[ from phoneme table "base". A length instruction can be used after import_phoneme to vary the length from the original. - -

 

-

Phoneme Properties

- -Within the phoneme definition the following lines may occur: ( (V) indicates only for vowels, (C) only for consonants) -

-

- -

 

-

Phoneme Instructions

- -Phoneme Instructions may be included within conditional statements. -

-During the first phase of phoneme interpretation, an instruction which causes a change to a different phoneme will terminate the instructions. During the second phase, FMT() and WAV() instructions will terminate the instructions. -

-

 

-

Conditional Statements

-Phoneme definitions can contain conditional statements such as: -
-  IF <condition> THEN
-    <statements>
-  ENDIF
-
-or more generally: -
-  IF <condition> THEN
-    <statements>
-  ELIF <condition> THEN
-    <statements>
-  ...
-  ELSE
-    <statements>
-  ENDIF
-
-where the ELSE and multiple ELSE parts are optional. -

-Multiple conditions may be joined with AND or OR, but not a mixture of ANDs and ORs. -

-A condition may be preceded by NOT. For example: -

-  IF <condition> AND NOT <condition> THEN
-    <statements>
-  ENDIF
-
-

-Condition -Can be: -

-Attributes - - -

 

-

Sound Specifications

-There are three ways to produce sounds: - -

 

-

Vowel Transitions

-These specify how a consonant affects an adjacent vowel. A consonant may cause a transition in the vowel's formants as the mouth changes shape between the consonant and the vowel. The following attributes may be specified. Note that the maximum rate of change of formant frequencies is limited by the speak program.

-

- - diff --git a/docs/phontab.md b/docs/phontab.md index 69a697ef..40ac5e29 100644 --- a/docs/phontab.md +++ b/docs/phontab.md @@ -1,15 +1,39 @@ -# Table of contents +# Phoneme Tables - * [Phoneme tables](#phoneme-tables) - * [Phoneme files](#phoneme-files) - * [Phoneme definitions](#phoneme-definitions) - * [Phoneme Properties](#phoneme-properties) - * [Phoneme Instructions](#phoneme-instructions) - * [Conditional Statements](#conditional-statements) - * [Sound Specifications](#sound-specifications) - * [Vowel Transitions](#vowel-transitions) +- [Phoneme files](#phoneme-files) +- [Phoneme Definitions](#phoneme-definitions) +- [Phoneme Properties](#phoneme-properties) + - [Type](#type) + - [Properties](#properties) + - [Place of Articulation](#place-of-articulation) + - [starttype](#starttype) + - [endtype](#endtype) + - [lengthmod](#lengthmod) + - [voicingswitch](#voicingswitch) +- [Phoneme Instructions](#phoneme-instructions) + - [length](#length) + - [ipa](#ipa) + - [WAV](#wav) + - [FMT](#fmt) + - [VowelStart](#vowelstart) + - [VowelEnding](#vowelending) + - [Vowelin](#vowelin) + - [Vowelout](#vowelout) + - [ChangePhoneme](#changephoneme) + - [ChangeIfDiminished](#changeifdiminished) + - [ChangeIfUnstressed](#changeifunstressed) + - [ChangeIfNotStressed](#changeifnotstressed) + - [ChangeIfStressed](#changeifstressed) + - [IfNextVowelAppend](#ifnextvowelappend) + - [RETURN](#return) + - [CALL](#call) +- [Conditional Statements](#conditional-statements) + - [Conditions](#conditions) + - [Attributes](#attributes) +- [Sound Specifications](#sound-specifications) +- [Vowel Transitions](#vowel-transitions) -# Phoneme tables +---------- A phoneme table defines all the phonemes which are used by a language, together with their properties and the data for their production as @@ -27,65 +51,71 @@ set. The source files for the phoneme data are in the "phsource" directory in the espeakedit download package. "Vowel files", which are referenced in -FMT(), VowelStart(), and VowelEnding() instructions are made using the +`FMT()`, `VowelStart()`, and `VowelEnding()` instructions are made using the espeakedit program. -## Phoneme files +## Phoneme Files The phoneme tables are defined in a master phoneme file, named -**phonemes**. This starts with the **base** phoneme table followed by +`phonemes`. This starts with the `base` phoneme table followed by phoneme tables for other languages and voices. These inherit phonemes -from the **base** table or previously defined tables. +from the `base` table or previously defined tables. In addition to phoneme definitions, the phoneme file can contain the following: -* **include** \ - Includes the text of the specified file at this point. This allows - different phoneme tables to be kept in different text files, for - convenience. \ is a relative path. The included file can - itself contain **include** statements. -* **phonemetable** \ \ - Starts a new phoneme table, and ends the previous table. - \ Is the name of this phoneme table. This name is used in - Voice files. - \ Is the name of a previously defined phoneme table whose - phoneme definitions are inherited by this one. The name **base** - indicates the first (base) phoneme table. + include -## Phoneme definitions +Includes the text of the specified file at this point. This allows +different phoneme tables to be kept in different text files, for +convenience. \ is a relative path. The included file can +itself contain `include` statements. -Note: These new Phoneme definitions apply to eSpeak NG version 420 and -later. + phonemetable + +Starts a new phoneme table, and ends the previous table. + +\ Is the name of this phoneme table. This name is used in Voice files. + +\ Is the name of a previously defined phoneme table whose phoneme +definitions are inherited by this one. The name `base` indicates the first +(base) phoneme table. + +## Phoneme Definitions A phoneme table contains a list of phoneme definitions. Each starts with -the keyword **phoneme** and the phoneme name (this is the name used in +the keyword `phoneme` and the phoneme name (this is the name used in the pronunciation rules in a language's \*\_rules and \*\_list files), -and ends with the keyword **endphoneme**. For example: +and ends with the keyword `endphoneme`. -``` - phoneme aI - vowel - starttype #a endtype #i - length 230 - FMT(vowels/ai) - endphoneme +The phoneme mnemonics are based on the scheme by +[Evan Kirshenbaum](http://www.kirshenbaum.net/IPA/ascii-ipa.pdf) +which represents International Phonetic Alphabet symbols using ascii +characters. - phoneme s - vls alv frc sibilant - voicingswitch z - lengthmod 3 - Vowelin f1=0 f2=1700 -300 300 f3=-100 80 - Vowelout f1=0 f2=1700 -300 250 f3=-100 80 rms=20 +For example: - IF nextPh(isPause) THEN - WAV(ufric/s_) - ELIF nextPh(p) OR nextPh(t) OR nextPh(k) THEN - WAV(ufric/s!) - ENDIF - WAV(ufric/s) - endphoneme -``` + phoneme aI + vowel + starttype #a endtype #i + length 230 + FMT(vowels/ai) + endphoneme + + phoneme s + vls alv frc sibilant + voicingswitch z + lengthmod 3 + Vowelin f1=0 f2=1700 -300 300 f3=-100 80 + Vowelout f1=0 f2=1700 -300 250 f3=-100 80 rms=20 + + IF nextPh(isPause) THEN + WAV(ufric/s_) + ELIF nextPh(p) OR nextPh(t) OR nextPh(k) THEN + WAV(ufric/s!) + ENDIF + WAV(ufric/s) + endphoneme A phoneme definition contains both static properties and executed instructions. The instructions may contain conditional statements, so @@ -97,82 +127,101 @@ In the first phase, the instructions may change the phoneme and replace it by a different phoneme. In the second phase, instructions are used to produce the sound for the phoneme. -The **import\_phoneme** statement can be used to copy a previously +The `import_phoneme` statement can be used to copy a previously defined phoneme from a specified phoneme table. For example: -``` - phoneme t - import_phoneme base/t[ - endphoneme -``` + phoneme t + import_phoneme base/t[ + endphoneme -means: `phoneme t` in this phoneme table is a copy of -`phoneme t[` from phoneme table "base". A **length** -instruction can be used after **import\_phoneme** to vary the length -from the original. +means: `phoneme t` in this phoneme table is a copy of`phoneme t[` from phoneme +table `base`. A `length` instruction can be used after `import\_phoneme` to +vary the length from the original. ## Phoneme Properties -Within the phoneme definition the following lines may occur: ( (V) -indicates only for vowels, (C) only for consonants) +Within the phoneme definition the following lines may occur: (`(V)` indicates +only for vowels, `(C)` only for consonants). -Type. One of these must be present. +### Type -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. +One of these must be present. -Properties: +| Type | Description | +|-----------|-------------| +| `vowel` | | +| `liquid` | semi-vowels, such as: `r`, `l`, `j`, `w` | +| `nasal` | nasal e.g.: `m`, `n`, `N` | +| `stop` | stop (plosive) e.g.: `p`, `b`, `t`, `d`, `k`, `g` | +| `frc` | fricative e.g.: `f`, `v`, `T`, `D`, `s`, `z`, `S`, `Z`, `C`, `x` | +| `afr` | affricate e.g.: `tS`, `dZ` | +| `pause` | | +| `stress` | Used for stress symbols, eg: `'` `,` `=` `%` | +| `virtual` | Used to represent a class of phonemes. | -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. +### Properties -Place of Articulation (C): +| Property | Type | Description | +|--------------|------|-------------| +| `vls` | (C) | voiceless e.g. `p`, `t`, `k`, `f`, `s` | +| `vcd` | (C) | voiced e.g. `b`, `d`, `g`, `v`, `z` | +| `sibilant` | (C) | e.g.: `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 NG 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. | -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 +### Place of Articulation -* **starttype** \ - 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". +| Articulation | Type | Description | +|--------------|------|-----------------| +| `blb` | (C) | bilabial | +| `ldb` | (C) | labio-dental | +| `dnt` | (C) | dental | +| `alv` | (C) | alveolar | +| `rfx` | (C) | retroflex | +| `pla` | (C) | palato-alveolar | +| `pal` | (C) | palatal | +| `vel` | (C) | velar | +| `lbv` | (C) | labio-velar | +| `uvl` | (C) | uvular | +| `phr` | (C) | pharyngeal | +| `glt` | (C) | glottal | -* **endtype** \ - Allocates this phoneme to a group so that conditions such as prevPh(#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". +### starttype -* **lengthmod** \ - \(C\) Determines how this consonant affects the length of the previous vowel. - This value is used as index into the `length_mods` table in the `CalcLengths()` function in the eSpeak program. + starttype -* **voicingswitch** \ - This is used for some languages to change between voiced and unvoiced phonemes. +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`. + +### endtype + + endtype + +Allocates this phoneme to a group so that conditions such as `prevPh(#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`. + +### lengthmod + + lengthmod + +(C) Determines how this consonant affects the length of the previous vowel. + +This value is used as index into the `length_mods` table in the `CalcLengths()` +function in the eSpeak NG program. + +### voicingswitch + + voicingswitch + +This is used for some languages to change between voiced and unvoiced phonemes. ## Phoneme Instructions @@ -183,212 +232,325 @@ causes a change to a different phoneme will terminate the instructions. During the second phase, FMT() and WAV() instructions will terminate the instructions. -* **length** \ - The relative length of the phoneme, typically about 140 for a short vowel and from 200 to 300 for a long vowel or diphong. A length() instruction is needed for vowels. It is optional for consonants. +### length -* **ipa** \ - In many cases, eSpeak makes IPA (International Phonetic Alpbabet) phoneme names automatically from eSpeak phoneme names. If this is not correct, then the phoneme definition can include an **ipa** instruction to specify the correct IPA name. IPA strings may include non-ascii characters. They may also include characters specified by their character codes in the form U+ followed by 4 hexadecimal digits. For example a string: aU+0303 indicates 'a' with a 'combining tilde'. + length -* **WAV**(\, \) - \ is a path to a WAV file (22 kHz, 16 bits, mono) within `phsource/` which will be played to produce the sound. This method is used for unvoiced consonants. \ does not include a .WAV filename extension, although the file to which it refers may or may not have one. -\ is optional. It is a percentage change to the amplitude of the WAV file. So, `WAV(ufric/s, 50)` means: play file 'ufric/s.wav' at 50% amplitude. +The relative length of the phoneme, typically about 140 for a short vowel and +from 200 to 300 for a long vowel or diphong. A `length()` instruction is +needed for vowels. It is optional for consonants. -* **FMT**(\, \) - \ is a path to a file (within `phsource/`) which defines how to generate the sound (a vowel or voiced consonant) from a sequence of formant values. Vowel files are made using the espeakedit program. -\ is optional. It is a percentage change to the amplitude of the sound which is synthesized from the FMT() instruction. +### ipa -* **FMT**(\, \) **addWav**(\, \) - For voiced consonants, a FMT() instruction may be followed by an addWav() instruction. addWav() has the same format as a WAV() instruction, but the WAV file is mixed with the sound which is synthesized from the FMT() instruction. + ipa -* **VowelStart**(\, \) - This is used to modify the start of a vowel when it follows a sonorant consonant (such as [l] or [j]). It replaces the first frame of the \ which is specified in a FMT() instruction by this \, and adjusts the length of the original by a signed value \. The VowelStart() instruction may be specified either in the phoneme definition of the vowel, or in the phoneme definition of the sonorant consonant which precedes the vowel. The former takes precedence. +In many cases, eSpeak NG makes IPA (International Phonetic Alpbabet) phoneme +names automatically from eSpeak NG phoneme names. If this is not correct, then +the phoneme definition can include an `ipa` instruction to specify the correct +IPA name. IPA strings may include non-ascii characters. They may also include +characters specified by their character codes in the form `U+` followed by 4 +hexadecimal digits. For example a string: `aU+0303` indicates 'a' with a +'combining tilde'. -* **VowelEnding**(\, \) - This is used to modify the end of a vowel when it is followed by a sonorant consonant (such as [l] or [j]). It is appended to the \ which is specified in a FMT() instruction by this \, and adjusts the length of the original by a signed value \. The VowelEnding() instruction may be specified either in the phoneme definition of the vowel, or in the phoneme definition of the sonorant consonant which follows the vowel. The former takes precedence. +### WAV -* **Vowelin** \ - (C) Specifies the effects of this consonant on the formants of a following vowel. See "vowel transitions", below. + WAV(, ) -* **Vowelout** \ - (C) Specifies the effects of this consonant on the formants of a preceding vowel. See "vowel transitions", below. +\ is a path to a WAV file (22 kHz, 16 bits, mono) within `phsource/` +which will be played to produce the sound. This method is used for unvoiced +consonants. \ does not include a .WAV filename extension, although +the file to which it refers may or may not have one. -* **ChangePhoneme(**\) - Change to the specified phoneme. +\ is optional. It is a percentage change to the amplitude of the +WAV file. So, `WAV(ufric/s, 50)` means: play file 'ufric/s.wav' at 50% amplitude. -* **ChangeIfDiminished(**\) - Change to the specified phoneme (such as schwa, @) if this syllable has "diminished" stress. +### FMT -* **ChangeIfUnstressed(**\) - Change to the specified phoneme if this syllable has "diminished" or "unstressed" stress. + FMT(, ) -* **ChangeIfNotStressed(**\) - Change to the specified phoneme if this syllable does not have "primary" stress. +\ is a path to a file (within `phsource/`) which defines how to +generate the sound (a vowel or voiced consonant) from a sequence of formant +values. Vowel files are made using the espeakedit program. -* **ChangeIfStressed(**\) - Change to the specified phoneme if this syllable has "primary" stress. +\ is optional. It is a percentage change to the amplitude of the +sound which is synthesized from the `FMT()` instruction. -* **IfNextVowelAppend(**\) - If the following phoneme is a vowel then this additional phoneme will be inserted before it. + FMT(, ) addWav(, ) -* **RETURN** - Ends executions of instructions. +For voiced consonants, a `FMT()` instruction may be followed by an `addWav()` +instruction. `addWav()` has the same format as a `WAV()` instruction, but the +WAV file is mixed with the sound which is synthesized from the `FMT()` instruction. -* **CALL** \/\ - Executes the instructions of the specified phoneme. +### VowelStart + VowelStart(, ) -### Conditional Statements +This is used to modify the start of a vowel when it follows a sonorant consonant +(such as `[l]` or `[j]`). It replaces the first frame of the \ which +is specified in a `FMT()` instruction by this \, and adjusts the +length of the original by a signed value \. The `VowelStart()` +instruction may be specified either in the phoneme definition of the vowel, or +in the phoneme definition of the sonorant consonant which precedes the vowel. +The former takes precedence. + +### VowelEnding + + VowelEnding(, ) + +This is used to modify the end of a vowel when it is followed by a sonorant +consonant (such as `[l]` or `[j]`). It is appended to the \ which +is specified in a `FMT()` instruction by this \, and adjusts the +length of the original by a signed value \. The `VowelEnding()` +instruction may be specified either in the phoneme definition of the vowel, or +in the phoneme definition of the sonorant consonant which follows the vowel. +The former takes precedence. + +### Vowelin + + Vowelin + +(C) Specifies the effects of this consonant on the formants of a following +vowel. See "vowel transitions", below. + +### Vowelout + + Vowelout + +(C) Specifies the effects of this consonant on the formants of a preceding +vowel. See "vowel transitions", below. + +### ChangePhoneme + + ChangePhoneme() + +Change to the specified phoneme. + +### ChangeIfDiminished + + ChangeIfDiminished() + +Change to the specified phoneme (such as schwa, `@`) if this syllable has +"diminished" stress. + +### ChangeIfUnstressed + + ChangeIfUnstressed() + +Change to the specified phoneme if this syllable has "diminished" or +"unstressed" stress. + +### ChangeIfNotStressed + + ChangeIfNotStressed() + +Change to the specified phoneme if this syllable does not have "primary" stress. + +### ChangeIfStressed + + ChangeIfStressed() + +Change to the specified phoneme if this syllable has "primary" stress. + +### IfNextVowelAppend + + IfNextVowelAppend() + +If the following phoneme is a vowel then this additional phoneme will be +inserted before it. + +### RETURN + +Ends executions of instructions. + +### CALL + + CALL / + +Executes the instructions of the specified phoneme. + +## Conditional Statements Phoneme definitions can contain conditional statements such as: -``` -
  IF  THEN
-    
-  ENDIF
-
-``` + IF THEN + + ENDIF or more generally: -``` -
  IF  THEN
-    
-  ELIF  THEN
-    
-  ...
-  ELSE
-    
-  ENDIF
-
-``` + IF THEN + + ELIF THEN + + ... + ELSE + + ENDIF where the `ELSE` and multiple `ELSE` parts are optional. -Multiple conditions may be joined with `AND` or `OR`, but not a mixture of `AND`s and `OR`s. +Multiple conditions may be joined with `AND` or `OR`, but not a mixture of +`AND`s and `OR`s. A condition may be preceded by `NOT`. For example: -``` -
  IF  AND NOT  THEN
-    
-  ENDIF
-
-``` + IF AND NOT THEN + + ENDIF ### Conditions Conditions can be: -* thisPh(\) - Test this current phoneme + thisPh() -* prevPh(\) - Test the previous phoneme +Test this current phoneme -* prevPhW(\) - Test the previous phoneme, but only within the same word. Returns false if there is no previous phoneme in the word. - -* prev2PhW(\) - Test the phoneme before the previous phoneme, but only within the same word. Returns false if it is not in this word. - -* nextPh(\) - Test the following phoneme - -* next2Ph(\) - Test the phoneme after the next phoneme. - -* nextPhW(\) - Test the next phoneme, but only within the same word. Returns false if there is no following phoneme in the word. - -* next2PhW(\) - Test the phoneme after the next phoneme, but only within the same word. Returns false if not found before the word end. - -* next3PhW(\) - Test the third phoneme after the current phoneme, but only within the same word. Returns false if not found before the word end. - -* nextVowel(\) - Test the next vowel after the current phoneme, but only within the same word. Returns false if there is none. - -* prevVowel(\) - Test the previous vowel before the current phoneme, but only within the same word. Returns false if there is none. - -* PreVoicing() - This is used as part of the instructions for voiced stop consonants (eg. [d] [g]). If true then produce a voiced murmur before the stop. - -* KlattSynth() - Returns true if the voice is using the Klatt synthesizer rather than the eSpeak synthesizer. + prevPh() +Test the previous phoneme + + prevPhW() + +Test the previous phoneme, but only within the same word. Returns false if +there is no previous phoneme in the word. + + prev2PhW() + +Test the phoneme before the previous phoneme, but only within the same word. +Returns false if it is not in this word. + + nextPh() + +Test the following phoneme + + next2Ph() + +Test the phoneme after the next phoneme. + + nextPhW() + +Test the next phoneme, but only within the same word. Returns false if there +is no following phoneme in the word. + + next2PhW() + +Test the phoneme after the next phoneme, but only within the same word. Returns +false if not found before the word end. + + next3PhW() + +Test the third phoneme after the current phoneme, but only within the same word. +Returns false if not found before the word end. + + nextVowel() + +Test the next vowel after the current phoneme, but only within the same word. +Returns false if there is none. + + prevVowel() + +Test the previous vowel before the current phoneme, but only within the same +word. Returns false if there is none. + + PreVoicing() + +This is used as part of the instructions for voiced stop consonants (e.g. `[d]` +and `[g]`). If true then produce a voiced murmur before the stop. + + KlattSynth() + +Returns true if the voice is using the Klatt synthesizer rather than the eSpeak synthesizer. ### Attributes -Note: Additional attributes could be added to eSpeak if needed. + True if the phoneme has this phoneme name. -* \ - True if the phoneme has this phoneme name. + -* \ - True if the phoneme has this starttype (or if it has this endtype if it's used in prevPh() ). The pre-defined phoneme groups are #@, #a, #e, #i, #o, #u. +True if the phoneme has this `starttype` (or if it has this `endtype` if it is +used in `prevPh()`). The pre-defined phoneme groups are `#@`, `#a`, `#e`, `#i`, +`#o`, `#u`. -* isPause - True if the phoneme is a pause. + isPause -* isPause2 - `nextPh(isPause2)` is used to test whether the next phoneme is not a vowel or liquid consonant within the same word. +True if the phoneme is a pause. -* isVowel - isNotVowel - isLiquid - isNasal - isVFricative - These test the phoneme type. + isPause2 -* isPalatal - isRhotic - These test whether the phoneme has this property. +`nextPh(isPause2)` is used to test whether the next phoneme is not a vowel or +liquid consonant within the same word. -* isWordStart - notWordStart - * These text whether this is the first phoneme in a word. + isVowel + isNotVowel + isLiquid + isNasal + isVFricative -* isWordEnd - True if this is the final phoneme in a word. +These test the phoneme type. -* isFirstVowel - isSecondVowel - isFinalVowel - * True if this is the First, Second, or Last vowel in a word. + isPalatal + isRhotic -* isAfterStress - True if this phoneme is after the stressed vowel in a word. +These test whether the phoneme has this property. -* isVoiced - True if this phoneme is a vowel or a voiced consonant. + isWordStart + notWordStart -* isDiminished - True if the syllable stress is "diminished" +These text whether this is the first phoneme in a word. -* isUnstressed - True if the syllable stress is "diminished" or "unstressed" + isWordEnd -* isNotStressed - True if the syllable stress is not "primary stress". +True if this is the final phoneme in a word. -* isStressed - True if the syllable stress is "primary stress". + isFirstVowel + isSecondVowel + isFinalVowel -* isMaxStress - True if this is the highest stressed syllable in the word. +True if this is the First, Second, or Last vowel in a word. + + isAfterStress + +True if this phoneme is after the stressed vowel in a word. + + isVoiced + +True if this phoneme is a vowel or a voiced consonant. + + isDiminished + +True if the syllable stress is "diminished" + + isUnstressed + +True if the syllable stress is "diminished" or "unstressed" + + isNotStressed + +True if the syllable stress is not "primary stress". + + isStressed + +True if the syllable stress is "primary stress". + + isMaxStress + +True if this is the highest stressed syllable in the word. ## Sound Specifications There are three ways to produce sounds: -* Playing a WAV file, by using a WAV() instruction. This is used for unvoiced consonants such as `[p] [t] [s]`. -* Generating a wave from a sequence of formant parameters, by using a FMT() instruction.This is used for vowels and also for sonorants such as `[l] [j] [n]`. -* A mixture of these. A stored WAV file is mixed with a wave generated from formant parameters. Use a FMT() instruction followed by addWav(). This is used for voiced stops and fricatives such as `[b] [g] [v] [z]`. - +* Playing a WAV file, by using a `WAV()` instruction. This is used for unvoiced + consonants such as `[p]`, `[t]` and [s]`. +* Generating a wave from a sequence of formant parameters, by using a `FMT()` + instruction. This is used for vowels and also for sonorants such as ``[l]`, + `[j]` and `[n]`. +* A mixture of these. A stored `WAV` file is mixed with a wave generated from + formant parameters. Use a `FMT()` instruction followed by `addWav()`. This is + used for voiced stops and fricatives such as `[b]`, `[g]`, `[v]` and `[z]`. ## Vowel Transitions @@ -396,37 +558,49 @@ These specify how a consonant affects an adjacent vowel. A consonant may cause a transition in the vowel's formants as the mouth changes shape between the consonant and the vowel. The following attributes may be specified. Note that the maximum rate of change of formant frequencies -is limited by the speak program. +is limited by the program. + len= +Nominal length of the transition in mS. If omitted a default value is used. -* **len=** - Nominal length of the transition in mS. If omitted a default value is used. + rms= -* **rms=** - Adjusts the amplitude of the vowel at the end of the transition. If omitted a default value is used. +Adjusts the amplitude of the vowel at the end of the transition. If omitted +a default value is used. -* **f1=** - 0: f1 formant frequency unchanged. - 1: f1 formant frequency decreases. - 2: f1 formant frequency decreases more. + f1= -* **f2= ** - \: The frequency towards which the f2 formant moves (Hz). - \: Signed integer (Hz). The minimum f2 frequency change. - \: Signed integer (Hz). The maximum f2 frequency change. +0: f1 formant frequency unchanged. -* **f3= ** - \: Signed integer (Hz). Frequence change of f3, f4, and f5 formants. - \: Amplitude of the f3, f4, and f5 formants at the end of the transition. 100 = no change. +1: f1 formant frequency decreases. -* **brk** - Break. Do not merge the synthesized wave of the consonant into the vowel. This will produce a discontinuity in the formants. +2: f1 formant frequency decreases more. -* **rate** - Allow a greater maximum rate of change of formant frequencies. + f2= -* **glstop** - Indicates a glottal stop. +\: The frequency towards which the f2 formant moves (Hz). +\: Signed integer (Hz). The minimum f2 frequency change. +\: Signed integer (Hz). The maximum f2 frequency change. + + f3= + +\: Signed integer (Hz). Frequence change of f3, f4, and f5 formants. + +\: 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. + + rate + +Allow a greater maximum rate of change of formant frequencies. + + glstop + +Indicates a glottal stop.