marytts.modules

Class SynthesisCallerBase

java.lang.Object

marytts.modules.InternalModule

marytts.modules.SynthesisCallerBase

All Implemented Interfaces:

MaryModule

Direct Known Subclasses:

FestivalCaller

public abstract class SynthesisCallerBase
extends InternalModule

A base class for a synthesis caller. This can work as a normal MARY module, converting synthesis markup data into audio, or it can be indirectly called from the corresponding Synthesizer.

Author:

Marc Schröder

Field Summary

Fields inherited from class marytts.modules.InternalModule

logger, state

Fields inherited from interface marytts.modules.MaryModule

MODULE_OFFLINE, MODULE_RUNNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SynthesisCallerBase(String name, MaryDataType inputType, MaryDataType outputType)

Method Summary

Methods

Modifier and Type	Method and Description
protected AudioInputStream	convertIfNeededAndPossible(AudioInputStream input, AudioFormat format, String voiceName)
void	powerOnSelfTest() Perform a power-on self test by processing some example input data.
MaryData	process(MaryData d) From synthesis markup input d, create audio output of the type specified by a preceding call to setAudioType().
void	startup() Allow the module to start up, performing whatever is necessary to become operational.
abstract AudioInputStream	synthesiseOneSection(String synthesisMarkup, Voice voice) Synthesise one chunk of synthesis markup with a given voice.

Methods inherited from class marytts.modules.InternalModule

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SynthesisCallerBase

protected SynthesisCallerBase(String name,
                   MaryDataType inputType,
                   MaryDataType outputType)

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 InternalModule

Throws:

Exception - Exception

powerOnSelfTest

public void powerOnSelfTest()

Perform a power-on self test by processing some example input data. This implementation does nothing; instead, the module test is carried out via Synthesis in the WaveformSynthesizer associated with this Caller.

Specified by:

powerOnSelfTest in interface MaryModule

Overrides:

powerOnSelfTest in class InternalModule

process

public MaryData process(MaryData d)
                 throws TransformerConfigurationException,
                        TransformerException,
                        FileNotFoundException,
                        IOException,
                        ParserConfigurationException,
                        SAXException,
                        Exception

From synthesis markup input d, create audio output of the type specified by a preceding call to setAudioType(). Returns a MaryData structure whose data is an input stream from which audio data of the specified type can be read.

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:

TransformerConfigurationException - TransformerConfigurationException

TransformerException - TransformerException

FileNotFoundException - FileNotFoundException

IOException - IOException

ParserConfigurationException - ParserConfigurationException

SAXException - SAXException

Exception - Exception

convertIfNeededAndPossible

protected AudioInputStream convertIfNeededAndPossible(AudioInputStream input,
                                          AudioFormat format,
                                          String voiceName)

synthesiseOneSection

public abstract AudioInputStream synthesiseOneSection(String synthesisMarkup,
                                    Voice voice)
                                               throws IOException

Synthesise one chunk of synthesis markup with a given voice.

Parameters:

synthesisMarkup - the input data in the native format expected by the synthesis engine

voice - the voice with which to synthesise the data

Returns:

an AudioInputStream in the native audio format of the voice

Throws:

IOException - IOException