marytts.modules

Interface MaryModule

All Known Implementing Classes:

AcousticModeller, APMLParser, CARTDurationModeller, CARTF0Modeller, DummyAllophones2AcoustParams, DummyDuration2AcoustParams, DummyTokens2Words, EmotionmlParser, ExternalModule, FestivalCaller, HalfPhoneTargetFeatureLister, HMMDurationF0Modeller, HTSEngine, InternalModule, JPhonemiser, JTokeniser, KlattDurationModeller, MaryXMLToText, MinimalisticPosTagger, OpenNLPPosTagger, PolynomialF0Modeller, PraatTextGridGenerator, PronunciationModel, ProsodyGeneric, ProsodyGenericFST, RealisedAcoustparamsExtractor, RealisedDurationsExtractor, SableParser, SimplePhoneme2AP, SoPDurationModeller, SoPF0Modeller, SSMLParser, Synthesis, SynthesisCallerBase, TargetFeatureLister, TextToMaryXML

public interface MaryModule

A generic interface for Mary Modules. This interface defines the communication of the Mary.java main program with the individual modules.

The main program calls

• startup() once after module instantiation,
• process() many times, from different threads, possibly at the same time, during the lifetime of the server
• shutdown() once, at the end of the program.

Author:

Marc Schröder

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODULE_OFFLINE
static int	MODULE_RUNNING

Method Summary

Methods

Modifier and Type	Method and Description
MaryDataType	getInputType()
Locale	getLocale() The locale of this module, i.e.
MaryDataType	getOutputType()
int	getState() Inform about the state of this module.
MaryDataType	inputType() Deprecated.
String	name() This module's name, as free text, for example "Tokeniser"
MaryDataType	outputType() Deprecated.
void	powerOnSelfTest() Perform a power-on self test by processing some example input data.
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.

Field Detail

MODULE_OFFLINE

static final int MODULE_OFFLINE

See Also:

Constant Field Values

MODULE_RUNNING

static final int MODULE_RUNNING

See Also:

Constant Field Values

Method Detail

name

String name()

This module's name, as free text, for example "Tokeniser"

Returns:

name

inputType

@Deprecated
MaryDataType inputType()

Deprecated.

The type of input data needed by this module.

Returns:

input type

getInputType

MaryDataType getInputType()

outputType

@Deprecated
MaryDataType outputType()

Deprecated.

The type of output data produced by this module.

Returns:

outputType

getOutputType

MaryDataType getOutputType()

getLocale

Locale getLocale()

The locale of this module, i.e. the locale of data that this module can process. If null, indicates that the module can use data of any locale (i.e., the module is language-independent.)

Returns:

the locale of this module, if any, or null

startup

void startup()
             throws Exception

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

Throws:

Exception - Exception

getState

int getState()

Inform about the state of this module.

Returns:

an int identifying the state of this module, either MODULE_OFFLINE or MODULE_RUNNING.

powerOnSelfTest

void powerOnSelfTest()
                     throws Error

Perform a power-on self test by processing some example input data.

Throws:

Error - if the module does not work properly.

shutdown

void shutdown()

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

process

MaryData process(MaryData d)
                 throws Exception

Perform this module's processing on abstract "MaryData" input d. Classes implementing this interface need to make the process() method thread-safe, because in server-mode, it will be called from different threads at the same time.

The result is returned encapsulated in a MaryData object of type outputType().

This method should never return null ; in case of a failure, an exception should be thrown.

Parameters:

d - d

Returns:

result

Throws:

Exception - Exception