marytts.language.ru

Class Phonemiser

java.lang.Object

marytts.modules.InternalModule

marytts.language.ru.Phonemiser

All Implemented Interfaces:

MaryModule

public class Phonemiser
extends InternalModule

Russian phonemiser module

Author:

Nickolay V. Shmyrev, Marc Schröder, Sathish

Field Summary

Fields

Modifier and Type	Field and Description
protected AllophoneSet	allophoneSet
protected FSTLookup	lexicon
protected Map<String,List<String>>	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
Phonemiser(String propertyPrefix)
Phonemiser(String componentName, MaryDataType inputType, MaryDataType outputType, String allophonesProperty, String userdictProperty) Constructor providing the individual filenames of files that are required.

Method Summary

Methods

Modifier and Type	Method and Description
String	phonemise(String text, String pos, StringBuilder g2pMethod) Phonemise the word text.
MaryData	process(MaryData d) Perform this module's processing on abstract "MaryData" input d.
protected Map<String,List<String>>	readLexicon(String lexiconFilename) Read a lexicon.
protected void	setPh(Element t, String ph)
String	userdictLookup(String text, String pos) look a given text up in the userdict.

Methods inherited from class marytts.modules.InternalModule

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

Methods inherited from class java.lang.Object

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

Field Detail

userdict

protected Map<String,List<String>> userdict

lexicon

protected FSTLookup lexicon

allophoneSet

protected AllophoneSet allophoneSet

Constructor Detail

Phonemiser

public Phonemiser(String propertyPrefix)
           throws IOException,
                  SAXException,
                  ParserConfigurationException,
                  MaryConfigurationException

Throws:

IOException

SAXException

ParserConfigurationException

MaryConfigurationException

Phonemiser

public Phonemiser(String componentName,
          MaryDataType inputType,
          MaryDataType outputType,
          String allophonesProperty,
          String userdictProperty)
           throws IOException,
                  SAXException,
                  ParserConfigurationException,
                  MaryConfigurationException

Constructor providing the individual filenames of files that are required.

Parameters:

componentName - componentName

inputType - inputType

outputType - outputType

allophonesProperty - allophonesProperty

userdictProperty - userdictProperty

Throws:

IOException - IOException

SAXException - SAXException

ParserConfigurationException - ParserConfigurationException

MaryConfigurationException - MaryConfigurationException

Method Detail

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 InternalModule

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)
                 throws IOException

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.

Parameters:

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

pos - the part-of-speech of the word

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.

Throws:

IOException - IOException

userdictLookup

public String userdictLookup(String text,
                    String pos)

look a given text up in the userdict. part-of-speech is used in case of ambiguity.

Parameters:

text - text

pos - pos

Returns:

null if userdict == null || text == null || text.length() == 0, null if entries == null, transcr otherwise

readLexicon

protected Map<String,List<String>> readLexicon(String lexiconFilename)
                                        throws IOException

Read a lexicon. Lines must have the format graphemestring | phonestring | optional-parts-of-speech The pos-item is optional. Different pos's belonging to one grapheme chain may be separated by whitespace

Parameters:

lexiconFilename - lexiconFilename

Returns:

fLexicon

Throws:

IOException - IOException

setPh

protected void setPh(Element t,
         String ph)