marytts.client

Class MarySocketClient

java.lang.Object

marytts.client.MaryClient

marytts.client.MarySocketClient

public class MarySocketClient
extends MaryClient

A socket client implementing the MARY protocol. It can be used as a command line client or from within java code.

Author:

Marc Schröder

See Also:

A GUI interface to this client, Description of the MARY protocol

Nested Class Summary

Nested classes/interfaces inherited from class marytts.client.MaryClient

MaryClient.AudioPlayerListener, MaryClient.DataType, MaryClient.Voice, MaryClient.WarningReader

Field Summary

Fields inherited from class marytts.client.MaryClient

beQuiet, data, doProfile

Constructor Summary

Constructors

Constructor and Description
MarySocketClient() The simplest way to create a mary client.
MarySocketClient(Address serverAddress) The typical way to create a mary client.
MarySocketClient(Address serverAddress, boolean profile, boolean quiet) An alternative way to create a mary client, which works with applets.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_process(String input, String inputType, String outputType, String locale, String audioType, String defaultVoiceName, String defaultStyle, String defaultEffects, Object output, long timeout, boolean streamingAudio, String outputTypeParams, MaryClient.AudioPlayerListener playerListener)
protected void	fillAudioFileFormatAndOutTypes()
protected void	fillDataTypes()
protected void	fillEffectHelpText(String effectName)
protected void	fillLocales()
protected void	fillServerExampleText(String dataType, String locale)
protected void	fillServerVersion() Get the version info from the server.
protected void	fillVoiceExampleTexts(String voicename)
protected void	fillVoices()
protected String	getDefaultAudioEffects() Request the available audio effects for a voice from the server
String	getFeatures(String locale)
String	getFeaturesForVoice(String voice)
boolean	isHMMEffect(String effectName)
String	requestDefaultEffectParameters(String effectName)
String	requestFullEffect(String effectName, String currentEffectParams)

Methods inherited from class marytts.client.MaryClient

getAddress, getAllDataTypes, getAudioEffects, getAudioFileFormatType, getAudioFileFormatTypes, getAudioOutTypes, getGeneralDomainVoices, getGeneralDomainVoices, getHost, getInputDataTypes, getLimitedDomainVoices, getLimitedDomainVoices, getLocales, getMaryClient, getMaryClient, getMaryClient, getOutputDataTypes, getPort, getServerExampleText, getVoiceExampleTextsLimitedDomain, getVoices, getVoices, initialise, isServerVersionAtLeast, main, process, process, process, process, requestEffectHelpText, streamAudio, usage

Methods inherited from class java.lang.Object

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

Constructor Detail

MarySocketClient

public MarySocketClient()
                 throws IOException

The simplest way to create a mary client. It will connect to the MARY server running at DFKI. Only use this for testing purposes!

Throws:

IOException - if communication with the server fails

MarySocketClient

public MarySocketClient(Address serverAddress)
                 throws IOException

The typical way to create a mary client. It will connect to the MARY client running at the given host and port. This constructor reads two system properties:

• mary.client.profile (=true/false) - determines whether profiling (timing) information is calculated;
• mary.client.quiet (=true/false) - tells the client not to print any of the normal information to stderr.

Parameters:

serverAddress - the address of the server

Throws:

IOException - if communication with the server fails

MarySocketClient

public MarySocketClient(Address serverAddress,
                boolean profile,
                boolean quiet)
                 throws IOException

An alternative way to create a mary client, which works with applets. It will connect to the MARY client running at the given host and port. Note that in applets, the host must be the same as the one from which the applet was loaded; otherwise, a security exception is thrown.

Parameters:

serverAddress - the address of the server

profile - determines whether profiling (timing) information is calculated

quiet - tells the client not to print any of the normal information to stderr

Throws:

IOException - if communication with the server fails

Method Detail

_process

protected void _process(String input,
            String inputType,
            String outputType,
            String locale,
            String audioType,
            String defaultVoiceName,
            String defaultStyle,
            String defaultEffects,
            Object output,
            long timeout,
            boolean streamingAudio,
            String outputTypeParams,
            MaryClient.AudioPlayerListener playerListener)
                 throws IOException

Specified by:

_process in class MaryClient

Throws:

IOException

fillServerVersion

protected void fillServerVersion()
                          throws IOException,
                                 UnknownHostException

Get the version info from the server. This is optional information which is not required for the normal operation of the client, but may help to avoid incompatibilities.

Specified by:

fillServerVersion in class MaryClient

Throws:

IOException - if communication with the server fails

UnknownHostException - if the host could not be found

fillDataTypes

protected void fillDataTypes()
                      throws UnknownHostException,
                             IOException

Specified by:

fillDataTypes in class MaryClient

Throws:

UnknownHostException

IOException

fillVoices

protected void fillVoices()
                   throws IOException,
                          UnknownHostException

Specified by:

fillVoices in class MaryClient

Throws:

IOException

UnknownHostException

fillLocales

protected void fillLocales()
                    throws IOException,
                           UnknownHostException

Specified by:

fillLocales in class MaryClient

Throws:

IOException

UnknownHostException

fillVoiceExampleTexts

protected void fillVoiceExampleTexts(String voicename)
                              throws IOException

Specified by:

fillVoiceExampleTexts in class MaryClient

Throws:

IOException

fillServerExampleText

protected void fillServerExampleText(String dataType,
                         String locale)
                              throws IOException

Specified by:

fillServerExampleText in class MaryClient

Throws:

IOException

getDefaultAudioEffects

protected String getDefaultAudioEffects()
                                 throws IOException

Request the available audio effects for a voice from the server

Specified by:

getDefaultAudioEffects in class MaryClient

Returns:

A string of available audio effects and default parameters, i.e. "FIRFilter,Robot(amount=50)"

Throws:

IOException - IOException

requestDefaultEffectParameters

public String requestDefaultEffectParameters(String effectName)
                                      throws IOException,
                                             UnknownHostException

Specified by:

requestDefaultEffectParameters in class MaryClient

Throws:

IOException

UnknownHostException

requestFullEffect

public String requestFullEffect(String effectName,
                       String currentEffectParams)
                         throws IOException,
                                UnknownHostException

Specified by:

requestFullEffect in class MaryClient

Throws:

IOException

UnknownHostException

fillEffectHelpText

protected void fillEffectHelpText(String effectName)
                           throws IOException

Specified by:

fillEffectHelpText in class MaryClient

Throws:

IOException

isHMMEffect

public boolean isHMMEffect(String effectName)
                    throws IOException,
                           UnknownHostException

Specified by:

isHMMEffect in class MaryClient

Throws:

IOException

UnknownHostException

getFeatures

public String getFeatures(String locale)
                   throws IOException

Specified by:

getFeatures in class MaryClient

Throws:

IOException

getFeaturesForVoice

public String getFeaturesForVoice(String voice)
                           throws IOException

Specified by:

getFeaturesForVoice in class MaryClient

Throws:

IOException

fillAudioFileFormatAndOutTypes

protected void fillAudioFileFormatAndOutTypes()
                                       throws IOException

Specified by:

fillAudioFileFormatAndOutTypes in class MaryClient

Throws:

IOException