marytts.modules.phonemiser

Class AllophoneSet

java.lang.Object

marytts.modules.phonemiser.AllophoneSet

public class AllophoneSet
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AllophoneSet.Stress Constants for Stress markers

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkAllophoneSyntax(String allophoneString) Check whether the given allophone string has a correct syntax according to this allophone set.
Allophone	getAllophone(String ph) Get the Allophone with the given name
Set<String>	getAllophoneNames() This returns the names of all allophones contained in this AllophoneSet, as a Set of Strings
static AllophoneSet	getAllophoneSet(InputStream inStream, String identifier) Return the allophone set that can be read from the given input stream, identified by the given identifier.
static AllophoneSet	getAllophoneSet(String filename) Return the allophone set specified by the given filename.
static AllophoneSet	getAllophoneSetById(String identifier) Get a previously loaded allophone set by its identifier.
String	getIgnoreChars() Obtain the ignore chars in this AllophoneSet Default: "',-"
Locale	getLocale()
String	getPhoneFeature(String ph, String featureName) For the Allophone with name ph, return the value of the named feature.
Set<String>	getPhoneFeatures() Get the list of available phone features for this allophone set.
String[]	getPossibleFeatureValues(String featureName) For the given feature name, get the list of all possible values that the feature can take in this allophone set.
Allophone	getSilence() Obtain the silence allophone in this AllophoneSet
static boolean	hasAllophoneSet(String identifier) Determine whether the registry of previously loaded allophone sets already contains an allophone set with the given identifier.
String	splitAllophoneString(String allophoneString) Split allophone string into a list of allophone symbols.
List<String>	splitIntoAllophoneList(String allophonesString) Split allophone string into a list of allophone symbols, preserving all stress and syllable boundaries that may be present
Allophone[]	splitIntoAllophones(String allophoneString) Split a phonetic string into allophone symbols.
String	syllabify(String phoneString) Syllabify a string of allophones.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAllophoneSet

public static AllophoneSet getAllophoneSet(String filename)
                                    throws MaryConfigurationException

Return the allophone set specified by the given filename. It will only be loaded if it was not loaded before.

Parameters:

filename - filename

Returns:

the allophone set, if one can be created. This method will never return null.

Throws:

MaryConfigurationException - if no allophone set can be loaded from the given file.

hasAllophoneSet

public static boolean hasAllophoneSet(String identifier)

Determine whether the registry of previously loaded allophone sets already contains an allophone set with the given identifier. If this returns true, then a call to getAllophoneSetById(String) with the same identifier will return a non-null Allophone set.

Parameters:

identifier - the identifier of the allophone set to test.

Returns:

true if the registry already contains the given allophone set, false otherwise.

getAllophoneSetById

public static AllophoneSet getAllophoneSetById(String identifier)

Get a previously loaded allophone set by its identifier. The method will make no attempt to load the allophone set if it is not yet available.

Parameters:

identifier - the identifier of the allophone set

Returns:

the allophone set if available, null otherwise.

getAllophoneSet

public static AllophoneSet getAllophoneSet(InputStream inStream,
                           String identifier)
                                    throws MaryConfigurationException

Return the allophone set that can be read from the given input stream, identified by the given identifier. It will only be loaded if it was not loaded before.

Parameters:

inStream - an open stream from which the allophone set can be loaded. it will be closed when this method returns.

identifier - a unique identifier for this allophone set.

Returns:

the allophone set, if one can be created. This method will never return null.

Throws:

MaryConfigurationException - if no allophone set can be loaded from the given file.

getLocale

public Locale getLocale()

getAllophone

public Allophone getAllophone(String ph)

Get the Allophone with the given name

Parameters:

ph - name of Allophone to get

Returns:

the Allophone

Throws:

IllegalArgumentException - if the Allophone is not found in the AllophoneSet

getSilence

public Allophone getSilence()

Obtain the silence allophone in this AllophoneSet

Returns:

silence

getIgnoreChars

public String getIgnoreChars()

Obtain the ignore chars in this AllophoneSet Default: "',-"

Returns:

ignore_chars

getPhoneFeature

public String getPhoneFeature(String ph,
                     String featureName)

For the Allophone with name ph, return the value of the named feature.

Parameters:

ph - ph

featureName - feature name

Returns:

the allophone feature, or null if either the allophone or the feature does not exist.

getPhoneFeatures

public Set<String> getPhoneFeatures()

Get the list of available phone features for this allophone set.

Returns:

Collections.unmodifiableSet(featureValueMap.keySet())

getPossibleFeatureValues

public String[] getPossibleFeatureValues(String featureName)

For the given feature name, get the list of all possible values that the feature can take in this allophone set.

Parameters:

featureName - featureName

Returns:

the list of values, "0" first.

Throws:

IllegalArgumentException - if featureName is not a known feature name.

getAllophoneNames

public Set<String> getAllophoneNames()

This returns the names of all allophones contained in this AllophoneSet, as a Set of Strings

Returns:

allophoneKeySet

splitIntoAllophones

public Allophone[] splitIntoAllophones(String allophoneString)

Split a phonetic string into allophone symbols. Symbols representing primary and secondary stress, syllable boundaries, and spaces, will be silently skipped.

Parameters:

allophoneString - the phonetic string to split

Returns:

an array of Allophone objects corresponding to the string given as input

Throws:

IllegalArgumentException - if the allophoneString contains unknown symbols.

splitAllophoneString

public String splitAllophoneString(String allophoneString)

Split allophone string into a list of allophone symbols. Include stress markers (',) and syllable boundaries (-), skip space characters.

Parameters:

allophoneString - allophoneString

Returns:

a String containing allophones and stress markers / syllable boundaries, separated with spaces

Throws:

IllegalArgumentException - if the string contains illegal symbols.

splitIntoAllophoneList

public List<String> splitIntoAllophoneList(String allophonesString)

Split allophone string into a list of allophone symbols, preserving all stress and syllable boundaries that may be present

Parameters:

allophonesString - allophonesString

Returns:

a List of allophone Strings

Throws:

IllegalArgumentException - if allophoneString contains a symbol for which no Allophone can be found

checkAllophoneSyntax

public boolean checkAllophoneSyntax(String allophoneString)

Check whether the given allophone string has a correct syntax according to this allophone set.

Parameters:

allophoneString - allophoneString

Returns:

true if the syntax is correct, false otherwise.

syllabify

public String syllabify(String phoneString)
                 throws IllegalArgumentException

Syllabify a string of allophones. If stress markers are provided, they are preserved; otherwise, primary stress will be assigned to the initial syllable.

The syllabification algorithm itself follows the Core Syllabification Principle (CSP) from

G.N. Clements (1990) "The role of the sonority cycle in core syllabification." In: J. Kingston & M.E. Beckman (Eds.), Papers in Laboratory Phonology I: Between the Grammar and Physics of Speech, Ch. 17, pp. 283-333, Cambridge University Press.

Parameters:

phoneString - phoneString

Returns:

a syllabified string; individual allophones are separated by spaces, and syllables, by dashes.

Throws:

IllegalArgumentException - if the phoneString is empty or contains a symbol that satisfies none of the following conditions:

1. the symbol corresponds to an Allophone, or
2. the symbol is a stress symbol (cf. AllophoneSet.Stress), or
3. the symbol is a syllable boundary (-)