marytts

Interface MaryInterface

public interface MaryInterface

A simple access API for using MARY TTS. The same API can be used to interact with a local TTS runtime, in the same JVM, or with a remote TTS server via a client-server protocol. The basic idea is to use reasonable defaults when instantiating a MaryInterface, but to let the user adapt all parts of it. Examples of use: MaryInterface marytts = new LocalMaryInterface(); AudioInputStream audio = marytts.generateAudio("This is my text."); Default voice in a different language: MaryInterface marytts = new LocalMaryInterface(); marytts.setLocale(Locale.SWEDISH); AudioInputStream audio = marytts.generateAudio("Välkommen till talsyntesens värld!"); Custom voice: MaryInterface marytts = new LocalMaryInterface(); marytts.setVoice("dfki-pavoque-neutral"); // a German voice AudioInputStream audio = marytts.generateAudio("Hallo und willkommen!"); Other input and output types: MaryInterface marytts = new LocalMaryInterface(); marytts.setInputType("SSML"); marytts.setOutputType("TARGETFEATURES"); marytts.setLocale(Locale.SWEDISH); Document ssmlDoc = DomUtils.parseDocument("myfile.ssml"); String targetfeatures = marytts.generateText(ssmlDoc); The exact same syntax should work with the RemoteMaryInterface included in the marytts-client package: MaryInterface marytts = new RemoteMaryInterface("localhost", 59125); AudioInputStream audio = marytts.generateAudio("This is my text."); Some introspection: MaryInterface marytts = new LocalMaryInterface(); System.out.println("I currently have " + marytts.getAvailableVoices() + " voices in " + marytts.getAvailableLocales() + " languages available."); System.out.println("Out of these, " + marytts.getAvailableVoices(Locale.US) + " are for US English.");

Author:

marc

Method Summary

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 setInputType(String).
Set<Locale>	getAvailableLocales() List the locales that can be used in setLocale(Locale).
Set<String>	getAvailableOutputTypes() List the names of the input types that can be used in setInputType(String).
Set<String>	getAvailableVoices() List the names of all the voices that can be used in setVoice(String).
Set<String>	getAvailableVoices(Locale locale) List the names of all the voices for the given locale that can be used in setVoice(String).
String	getInputType() Get the current input type, either the default ("TEXT") or the value most recently set through 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 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.
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.
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.

Method Detail

setInputType

void setInputType(String newInputType)
           throws IllegalArgumentException

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

Parameters:

newInputType - a string representation of a MaryDataType.

Throws:

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

getInputType

String getInputType()

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

Returns:

the currently set input type.

setOutputType

void setOutputType(String newOutputType)
            throws IllegalArgumentException

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

Parameters:

newOutputType - a string representation of a MaryDataType.

Throws:

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

getOutputType

String getOutputType()

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

Returns:

the currently set input type.

setLocale

void setLocale(Locale newLocale)
        throws IllegalArgumentException

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

Parameters:

newLocale - a supported locale.

Throws:

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

getLocale

Locale getLocale()

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

Returns:

the locale

setVoice

void setVoice(String voiceName)
       throws IllegalArgumentException

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

Parameters:

voiceName - the name of a valid voice.

Throws:

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

getVoice

String getVoice()

The name of the current voice, if any.

Returns:

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

setAudioEffects

void setAudioEffects(String audioEffects)

Set the audio effects. For advanced use only.

Parameters:

audioEffects - audioEffects

getAudioEffects

String getAudioEffects()

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

Returns:

audio effects

setStyle

void setStyle(String newStyle)

Set the speaking style. For advanced use only.

Parameters:

newStyle - newStyle

getStyle

String getStyle()

Get the currently speaking style. For advanced use only.

Returns:

style

setOutputTypeParams

void setOutputTypeParams(String params)

Set the output type parameters. For advanced use only.

Parameters:

params - params

getOutputTypeParams

String getOutputTypeParams()

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

Returns:

output type params

setStreamingAudio

void setStreamingAudio(boolean newIsStreaming)

Set whether to stream audio. For advanced use only.

Parameters:

newIsStreaming - newIsStreaming

isStreamingAudio

boolean isStreamingAudio()

Whether to stream audio. For advanced use only.

Returns:

stream audio

generateText

String generateText(String text)
             throws SynthesisException

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

Parameters:

text - text

Returns:

text

Throws:

SynthesisException - SynthesisException

generateText

String generateText(Document doc)
             throws SynthesisException

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

Parameters:

doc - doc

Returns:

text

Throws:

SynthesisException - SynthesisException

generateXML

Document generateXML(String text)
              throws SynthesisException

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

Parameters:

text - text

Returns:

xml

Throws:

SynthesisException - SynthesisException

generateXML

Document generateXML(Document doc)
              throws SynthesisException

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

Parameters:

doc - doc

Returns:

xml

Throws:

SynthesisException - SynthesisException

generateAudio

AudioInputStream generateAudio(String text)
                        throws SynthesisException

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

Parameters:

text - text

Returns:

audio

Throws:

SynthesisException - SynthesisException

generateAudio

AudioInputStream generateAudio(Document doc)
                        throws SynthesisException

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

Parameters:

doc - doc

Returns:

audio

Throws:

SynthesisException - SynthesisException

getAvailableVoices

Set<String> getAvailableVoices()

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

Returns:

voices

getAvailableVoices

Set<String> getAvailableVoices(Locale locale)

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

Parameters:

locale - locale

Returns:

voices

getAvailableLocales

Set<Locale> getAvailableLocales()

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

Returns:

locales

getAvailableInputTypes

Set<String> getAvailableInputTypes()

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

Returns:

inputtypes

getAvailableOutputTypes

Set<String> getAvailableOutputTypes()

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

Returns:

output types

isTextType

boolean isTextType(String dataType)

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

Parameters:

dataType - an input or output data type.

Returns:

type

isXMLType

boolean isXMLType(String dataType)

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

Parameters:

dataType - an input or output data type.

Returns:

type

isAudioType

boolean isAudioType(String dataType)

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

Parameters:

dataType - an input or output data type

Returns:

type