marytts

Class LocalMaryInterface

java.lang.Object

marytts.LocalMaryInterface

All Implemented Interfaces:

MaryInterface

public class LocalMaryInterface
extends Object
implements MaryInterface

This class and its subclasses are intended to grow into a simple-to-use, unified interface for both the local MARY server and a MARY client.

Author:

marc

Constructor Summary

Constructors

Constructor and Description
LocalMaryInterface()

Method Summary

Methods

Modifier and Type	Method and Description
AudioInputStream	generateAudio(Document doc) Synthesis from an XML format, such as SSML, to audio.
AudioInputStream	generateAudio(String text) Synthesis from a text format to audio.
String	generateText(Document doc) Partial processing command, converting an input XML format such as SSML into an output text format such as TARGETFEATURES.
String	generateText(String text) Partial processing command, converting an input text format such as TEXT into an output text format such as TARGETFEATURES.
Document	generateXML(Document doc) Partial processing command, converting one XML format such as RAWMARYXML into another XML format such as TOKENS.
Document	generateXML(String text) Partial processing command, converting an input text format such as TEXT into an XML format such as ALLOPHONES.
String	getAudioEffects() Get the currently set audio effects.
Set<String>	getAvailableInputTypes() List the names of the input types that can be used in MaryInterface.setInputType(String).
Set<Locale>	getAvailableLocales() List the locales that can be used in MaryInterface.setLocale(Locale).
Set<String>	getAvailableOutputTypes() List the names of the input types that can be used in MaryInterface.setInputType(String).
Set<String>	getAvailableVoices() List the names of all the voices that can be used in MaryInterface.setVoice(String).
Set<String>	getAvailableVoices(Locale aLocale) List the names of all the voices for the given locale that can be used in MaryInterface.setVoice(String).
String	getInputType() Get the current input type, either the default ("TEXT") or the value most recently set through MaryInterface.setInputType(String).
Locale	getLocale() Get the current locale used for processing.
String	getOutputType() Get the current output type, either the default ("AUDIO") or the value most recently set through MaryInterface.setInputType(String).
String	getOutputTypeParams() Get the currently set output type parameters.
String	getStyle() Get the currently speaking style.
String	getVoice() The name of the current voice, if any.
protected void	init()
boolean	isAudioType(String dataType) Check whether the given data type is an audio type.
boolean	isStreamingAudio() Whether to stream audio.
boolean	isTextType(String dataType) Check whether the given data type is a text type.
boolean	isXMLType(String dataType) Check whether the given data type is an XML type.
void	setAudioEffects(String audioEffects) Set the audio effects.
void	setInputType(String newInputType) Set the input type for processing to the new input type.
void	setLocale(Locale newLocale) Set the locale for processing.
void	setOutputType(String newOutputType) Set the output type for processing to the new output type.
void	setOutputTypeParams(String params) Set the output type parameters.
protected void	setReasonableDefaults()
void	setStreamingAudio(boolean newIsStreaming) Set whether to stream audio.
void	setStyle(String newStyle) Set the speaking style.
void	setVoice(String voiceName) Set the voice to be used for processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalMaryInterface

public LocalMaryInterface()
                   throws MaryConfigurationException

Throws:

MaryConfigurationException

Method Detail

init

protected void init()

setReasonableDefaults

protected void setReasonableDefaults()

setInputType

public void setInputType(String newInputType)
                  throws IllegalArgumentException

Description copied from interface: MaryInterface

Set the input type for processing to the new input type.

Specified by:

setInputType in interface MaryInterface

Parameters:

newInputType - a string representation of a MaryDataType.

Throws:

IllegalArgumentException - if newInputType is not a valid and known input data type.

getInputType

public String getInputType()

Description copied from interface: MaryInterface

Get the current input type, either the default ("TEXT") or the value most recently set through MaryInterface.setInputType(String).

Specified by:

getInputType in interface MaryInterface

Returns:

the currently set input type.

setOutputType

public void setOutputType(String newOutputType)
                   throws IllegalArgumentException

Description copied from interface: MaryInterface

Set the output type for processing to the new output type.

Specified by:

setOutputType in interface MaryInterface

Parameters:

newOutputType - a string representation of a MaryDataType.

Throws:

IllegalArgumentException - if newOutputType is not a valid and known output data type.

getOutputType

public String getOutputType()

Description copied from interface: MaryInterface

Get the current output type, either the default ("AUDIO") or the value most recently set through MaryInterface.setInputType(String).

Specified by:

getOutputType in interface MaryInterface

Returns:

the currently set input type.

setLocale

public void setLocale(Locale newLocale)
               throws IllegalArgumentException

Description copied from interface: MaryInterface

Set the locale for processing. Set the voice to the default voice for this locale.

Specified by:

setLocale in interface MaryInterface

Parameters:

newLocale - a supported locale.

Throws:

IllegalArgumentException - if newLocale is not among the MaryInterface.getAvailableLocales().

getLocale

public Locale getLocale()

Description copied from interface: MaryInterface

Get the current locale used for processing. Either the default (US English) or the value most recently set through MaryInterface.setLocale(Locale) or indirectly through MaryInterface.setVoice(String).

Specified by:

getLocale in interface MaryInterface

Returns:

the locale

setVoice

public void setVoice(String voiceName)
              throws IllegalArgumentException

Description copied from interface: MaryInterface

Set the voice to be used for processing. If the current locale differs from the voice's locale, the locale is updated accordingly.

Specified by:

setVoice in interface MaryInterface

Parameters:

voiceName - the name of a valid voice.

Throws:

IllegalArgumentException - if voiceName is not among the MaryInterface.getAvailableVoices().

getVoice

public String getVoice()

Description copied from interface: MaryInterface

The name of the current voice, if any.

Specified by:

getVoice in interface MaryInterface

Returns:

the voice name, or null if no voice is currently set.

setAudioEffects

public void setAudioEffects(String audioEffects)

Description copied from interface: MaryInterface

Set the audio effects. For advanced use only.

Specified by:

setAudioEffects in interface MaryInterface

Parameters:

audioEffects - audioEffects

getAudioEffects

public String getAudioEffects()

Description copied from interface: MaryInterface

Get the currently set audio effects. For advanced use only.

Specified by:

getAudioEffects in interface MaryInterface

Returns:

audio effects

setStyle

public void setStyle(String newStyle)

Description copied from interface: MaryInterface

Set the speaking style. For advanced use only.

Specified by:

setStyle in interface MaryInterface

Parameters:

newStyle - newStyle

getStyle

public String getStyle()

Description copied from interface: MaryInterface

Get the currently speaking style. For advanced use only.

Specified by:

getStyle in interface MaryInterface

Returns:

style

setOutputTypeParams

public void setOutputTypeParams(String params)

Description copied from interface: MaryInterface

Set the output type parameters. For advanced use only.

Specified by:

setOutputTypeParams in interface MaryInterface

Parameters:

params - params

getOutputTypeParams

public String getOutputTypeParams()

Description copied from interface: MaryInterface

Get the currently set output type parameters. For advanced use only.

Specified by:

getOutputTypeParams in interface MaryInterface

Returns:

output type params

setStreamingAudio

public void setStreamingAudio(boolean newIsStreaming)

Description copied from interface: MaryInterface

Set whether to stream audio. For advanced use only.

Specified by:

setStreamingAudio in interface MaryInterface

Parameters:

newIsStreaming - newIsStreaming

isStreamingAudio

public boolean isStreamingAudio()

Description copied from interface: MaryInterface

Whether to stream audio. For advanced use only.

Specified by:

isStreamingAudio in interface MaryInterface

Returns:

stream audio

generateText

public String generateText(String text)
                    throws SynthesisException

Description copied from interface: MaryInterface

Partial processing command, converting an input text format such as TEXT into an output text format such as TARGETFEATURES.

Specified by:

generateText in interface MaryInterface

Parameters:

text - text

Returns:

text

Throws:

SynthesisException - SynthesisException

generateText

public String generateText(Document doc)
                    throws SynthesisException

Description copied from interface: MaryInterface

Partial processing command, converting an input XML format such as SSML into an output text format such as TARGETFEATURES.

Specified by:

generateText in interface MaryInterface

Parameters:

doc - doc

Returns:

text

Throws:

SynthesisException - SynthesisException

generateXML

public Document generateXML(String text)
                     throws SynthesisException

Description copied from interface: MaryInterface

Partial processing command, converting an input text format such as TEXT into an XML format such as ALLOPHONES.

Specified by:

generateXML in interface MaryInterface

Parameters:

text - text

Returns:

xml

Throws:

SynthesisException - SynthesisException

generateXML

public Document generateXML(Document doc)
                     throws SynthesisException

Description copied from interface: MaryInterface

Partial processing command, converting one XML format such as RAWMARYXML into another XML format such as TOKENS.

Specified by:

generateXML in interface MaryInterface

Parameters:

doc - doc

Returns:

xml

Throws:

SynthesisException - SynthesisException

generateAudio

public AudioInputStream generateAudio(String text)
                               throws SynthesisException

Description copied from interface: MaryInterface

Synthesis from a text format to audio. This is the method you want to call for text-to-speech conversion.

Specified by:

generateAudio in interface MaryInterface

Parameters:

text - text

Returns:

audio

Throws:

SynthesisException - SynthesisException

generateAudio

public AudioInputStream generateAudio(Document doc)
                               throws SynthesisException

Description copied from interface: MaryInterface

Synthesis from an XML format, such as SSML, to audio.

Specified by:

generateAudio in interface MaryInterface

Parameters:

doc - doc

Returns:

audio

Throws:

SynthesisException - SynthesisException

getAvailableVoices

public Set<String> getAvailableVoices()

Description copied from interface: MaryInterface

List the names of all the voices that can be used in MaryInterface.setVoice(String).

Specified by:

getAvailableVoices in interface MaryInterface

Returns:

voices

getAvailableVoices

public Set<String> getAvailableVoices(Locale aLocale)

Description copied from interface: MaryInterface

List the names of all the voices for the given locale that can be used in MaryInterface.setVoice(String).

Specified by:

getAvailableVoices in interface MaryInterface

Parameters:

aLocale - locale

Returns:

voices

getAvailableLocales

public Set<Locale> getAvailableLocales()

Description copied from interface: MaryInterface

List the locales that can be used in MaryInterface.setLocale(Locale).

Specified by:

getAvailableLocales in interface MaryInterface

Returns:

locales

getAvailableInputTypes

public Set<String> getAvailableInputTypes()

Description copied from interface: MaryInterface

List the names of the input types that can be used in MaryInterface.setInputType(String).

Specified by:

getAvailableInputTypes in interface MaryInterface

Returns:

inputtypes

getAvailableOutputTypes

public Set<String> getAvailableOutputTypes()

Description copied from interface: MaryInterface

List the names of the input types that can be used in MaryInterface.setInputType(String).

Specified by:

getAvailableOutputTypes in interface MaryInterface

Returns:

output types

isTextType

public boolean isTextType(String dataType)

Description copied from interface: MaryInterface

Check whether the given data type is a text type. For input types (i.e. types contained in MaryInterface.getAvailableInputTypes()) that are text types, the synthesis methods MaryInterface.generateText(String), MaryInterface.generateXML(String) and MaryInterface.generateAudio(String) can be used; for output types that are text types, the synthesis methods MaryInterface.generateText(String) and MaryInterface.generateText(Document) can be used.

Specified by:

isTextType in interface MaryInterface

Parameters:

dataType - an input or output data type.

Returns:

type

isXMLType

public boolean isXMLType(String dataType)

Description copied from interface: MaryInterface

Check whether the given data type is an XML type. For input types (i.e. types contained in MaryInterface.getAvailableInputTypes()) that are XML types, the synthesis methods MaryInterface.generateText(Document), MaryInterface.generateXML(Document) and MaryInterface.generateAudio(Document) can be used; for output types that are XML types, the synthesis methods MaryInterface.generateXML(String) and MaryInterface.generateXML(Document) can be used.

Specified by:

isXMLType in interface MaryInterface

Parameters:

dataType - an input or output data type.

Returns:

type

isAudioType

public boolean isAudioType(String dataType)

Description copied from interface: MaryInterface

Check whether the given data type is an audio type. There are no input audio types; for output audio types, the methods MaryInterface.generateAudio(String) and MaryInterface.generateAudio(Document) can be used.

Specified by:

isAudioType in interface MaryInterface

Parameters:

dataType - an input or output data type

Returns:

type