marytts.language.de

Class JPhonemiser

java.lang.Object

marytts.modules.InternalModule

marytts.modules.JPhonemiser

marytts.language.de.JPhonemiser

All Implemented Interfaces:

MaryModule

public class JPhonemiser
extends JPhonemiser

The phonemiser module -- java implementation.

Author:

Marc Schröder

Field Summary

Fields inherited from class marytts.modules.JPhonemiser

allophoneSet, lexicon, lts, punctuationPosRegex, removeTrailingOneFromPhones, unpronounceablePosRegex, userdict

Fields inherited from class marytts.modules.InternalModule

logger, state

Fields inherited from interface marytts.modules.MaryModule

MODULE_OFFLINE, MODULE_RUNNING

Constructor Summary

Constructors

Constructor and Description
JPhonemiser()

Method Summary

Methods

Modifier and Type	Method and Description
String	phonemise(String text, String pos, StringBuilder g2pMethod) Phonemise the word text.
String	phonemiseEn(String text) Try to determine an English transcription of the text according to English rules, but using German Sampa.
MaryData	process(MaryData d) Perform this module's processing on abstract "MaryData" input d.
void	shutdown() Allow the module to shut down cleanly.
void	startup() Allow the module to start up, performing whatever is necessary to become operational.

Methods inherited from class marytts.modules.JPhonemiser

getAllophoneSet, isPosPunctuation, isUnpronounceable, lexiconLookup, maybePronounceable, readLexicon, setPh, setPunctuationPosRegex, setUnpronounceablePosRegex, userdictLookup

Methods inherited from class marytts.modules.InternalModule

getInputType, getLocale, getOutputType, getState, inputType, name, outputType, powerOnSelfTest

Methods inherited from class java.lang.Object

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

Constructor Detail

JPhonemiser

public JPhonemiser()
            throws IOException,
                   MaryConfigurationException

Throws:

IOException

MaryConfigurationException

Method Detail

startup

public void startup()
             throws Exception

Description copied from interface: MaryModule

Allow the module to start up, performing whatever is necessary to become operational. After successful completion, getState() should return MODULE_RUNNING.

Specified by:

startup in interface MaryModule

Overrides:

startup in class JPhonemiser

Throws:

Exception - Exception

shutdown

public void shutdown()

Description copied from interface: MaryModule

Allow the module to shut down cleanly. After this has successfully completed, getState() should return MODULE_OFFLINE.

Specified by:

shutdown in interface MaryModule

Overrides:

shutdown in class InternalModule

process

public MaryData process(MaryData d)
                 throws Exception

Description copied from class: InternalModule

Perform this module's processing on abstract "MaryData" input d. Subclasses need to make sure that the process() method is thread-safe, because in server-mode, it will be called from different threads at the same time. A sensible way to do this seems to be not to use any global or static variables, or to use them read-only.

Specified by:

process in interface MaryModule

Overrides:

process in class JPhonemiser

Parameters:

d - d

Returns:

A MaryData object of type outputType() encapsulating the processing result.

This method just returns its input. Subclasses should override this.

Throws:

Exception - Exception

phonemise

public String phonemise(String text,
               String pos,
               StringBuilder g2pMethod)

Phonemise the word text. This starts with a simple lexicon lookup, followed by some heuristics, and finally applies letter-to-sound rules if nothing else was successful.

Overrides:

phonemise in class JPhonemiser

Parameters:

text - the textual (graphemic) form of a word.

pos - pos

g2pMethod - This is an awkward way to return a second String parameter via a StringBuilder. If a phonemisation of the text is found, this parameter will be filled with the method of phonemisation ("lexicon", ... "rules").

Returns:

a phonemisation of the text if one can be generated, or null if no phonemisation method was successful.

phonemiseEn

public String phonemiseEn(String text)

Try to determine an English transcription of the text according to English rules, but using German Sampa.

Parameters:

text - Word to transcribe

Returns:

the transcription, or null if none could be determined.