marytts.server

Class Mary

java.lang.Object

marytts.server.Mary

public class Mary
extends Object

The main program for the mary TtS system. It can run as a socket server or as a stand-alone program.

Author:

Marc Schröder

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_OFF
static int	STATE_RUNNING
static int	STATE_SHUTTING_DOWN
static int	STATE_STARTING

Constructor Summary

Constructors

Constructor and Description
Mary()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addJarsToClasspath() Add jars to classpath.
static int	currentState() Inform about system state.
static void	main(String[] args) The starting point of the standalone Mary program.
static void	process(String input, String inputTypeName, String outputTypeName, String localeString, String audioTypeName, String voiceName, String style, String effects, String outputTypeParams, OutputStream output) Process input into output using the MARY system.
static void	shutdown() Orderly shut down the MARY system.
static void	startup() Start the MARY system and all modules.
static void	startup(boolean addJarsToClasspath) Start the MARY system and all modules.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_OFF

public static final int STATE_OFF

See Also:

Constant Field Values

STATE_STARTING

public static final int STATE_STARTING

See Also:

Constant Field Values

STATE_RUNNING

public static final int STATE_RUNNING

See Also:

Constant Field Values

STATE_SHUTTING_DOWN

public static final int STATE_SHUTTING_DOWN

See Also:

Constant Field Values

Constructor Detail

Mary

public Mary()

Method Detail

currentState

public static int currentState()

Inform about system state.

Returns:

an integer representing the current system state.

See Also:

STATE_OFF, STATE_STARTING, STATE_RUNNING, STATE_SHUTTING_DOWN

addJarsToClasspath

protected static void addJarsToClasspath()
                                  throws Exception

Add jars to classpath. Normally this is called from startup().

Throws:

Exception - Exception

startup

public static void startup()
                    throws Exception

Start the MARY system and all modules. This method must be called once before any calls to process(String input, String inputTypeName, String outputTypeName, String localeString, String audioTypeName, String voiceName, String style, String effects, String outputTypeParams, OutputStream output) are possible. The method will dynamically extend the classpath to all jar files in MARY_BASE/java/*.jar. Use startup(false) if you do not want to automatically extend the classpath in this way.

Throws:

IllegalStateException - if the system is not offline.

Exception - Exception

startup

public static void startup(boolean addJarsToClasspath)
                    throws Exception

Start the MARY system and all modules. This method must be called once before any calls to process(String input, String inputTypeName, String outputTypeName, String localeString, String audioTypeName, String voiceName, String style, String effects, String outputTypeParams, OutputStream output) are possible.

Parameters:

addJarsToClasspath - if true, the method will dynamically extend the classpath to all jar files in MARY_BASE/java/*.jar; if false, the classpath will remain unchanged.

Throws:

IllegalStateException - if the system is not offline.

Exception - Exception

shutdown

public static void shutdown()

Orderly shut down the MARY system.

Throws:

IllegalStateException - if the MARY system is not running.

process

public static void process(String input,
           String inputTypeName,
           String outputTypeName,
           String localeString,
           String audioTypeName,
           String voiceName,
           String style,
           String effects,
           String outputTypeParams,
           OutputStream output)
                    throws Exception

Process input into output using the MARY system. For inputType TEXT and output type AUDIO, this does text-to-speech conversion; for other settings, intermediate processing results can be generated or provided as input.

Parameters:

input - input

inputTypeName - inputTypeName

outputTypeName - outputTypeName

localeString - localeString

audioTypeName - audioTypeName

voiceName - voiceName

style - style

effects - effects

outputTypeParams - outputTypeParams

output - the output stream into which the processing result will be written.

Throws:

IllegalStateException - if the MARY system is not running.

Exception - Exception

main

public static void main(String[] args)
                 throws Exception

The starting point of the standalone Mary program. If server mode is requested by property settings, starts the MaryServer; otherwise, a Request is created reading from the file given as first argument and writing to System.out.

Usage:

As a socket server:

 java -Dmary.base=$MARY_BASE -Dserver=true marytts.server.Mary
 

As a stand-alone program:

 java -Dmary.base=$MARY_BASE marytts.server.Mary myfile.txt
 

Parameters:

args - args

Throws:

Exception - Exception

See Also:

MaryProperties, MaryServer, RequestHandler, Request