marytts.util

Class MaryRuntimeUtils

java.lang.Object

marytts.util.MaryRuntimeUtils

public class MaryRuntimeUtils
extends Object

Author:

marc

Constructor Summary

Constructors

Constructor and Description
MaryRuntimeUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canCreateMP3() Determine whether conversion to mp3 is possible.
static boolean	canCreateOgg() Determine whether conversion to ogg vorbis format is possible.
static String[]	checkLexicon(String propertyName, String token)
static AudioDestination	createAudioDestination() Create an AudioDestination to which the audio data can be written.
static AllophoneSet	determineAllophoneSet(Element e) For an element in a MaryXML document, do what you can to determine the appropriate AllophoneSet.
static AllophoneSet	determineAllophoneSet(Locale locale) Try to determine the Allophone set to use for the given locale.
static void	ensureMaryStarted()
static String	getAudioEffectDefaultParam(String effectName)
static String	getAudioEffectHelpText(String effectName)
static String	getAudioFileFormatTypes() List the available audio file format types, as a multi-line string.
static String	getDataTypes()
static String	getDefaultAudioEffects()
static Vector<String>	getDefaultVoiceExampleTexts()
static String	getDefaultVoiceName()
static String	getExampleText(String datatype, Locale locale)
static String	getFullAudioEffect(String effectName, String currentEffectParams)
static String	getLocales()
static String	getMaryVersion()
static AudioFormat	getMP3AudioFormat()
static AudioFormat	getOggAudioFormat()
static String	getStyles(String voiceName) For the voice with the given name, return the list of styles supported by this voice, if any, one style per line.
static String	getVocalizations(String voiceName) For the voice with the given name, return the list of vocalizations supported by this voice, one vocalization per line.
static String	getVoiceExampleText(String voiceName)
static String	getVoices()
static Object	instantiateObject(String objectInitInfo) Instantiate an object by calling one of its constructors.
static String	isHmmAudioEffect(String effectName)
static boolean	lowMemoryCondition() Verify if the java virtual machine is in a low memory condition.
static AllophoneSet	needAllophoneSet(String propertyName) Convenience method to access the allophone set referenced in the MARY property with the given name.
static boolean	veryLowMemoryCondition() Verify if the java virtual machine is in a very low memory condition.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaryRuntimeUtils

public MaryRuntimeUtils()

Method Detail

ensureMaryStarted

public static void ensureMaryStarted()
                              throws Exception

Throws:

Exception

instantiateObject

public static Object instantiateObject(String objectInitInfo)
                                throws MaryConfigurationException

Instantiate an object by calling one of its constructors.

Parameters:

objectInitInfo - a string description of the object to instantiate. The objectInitInfo is expected to have one of the following forms:

1. my.cool.Stuff
2. my.cool.Stuff(any,string,args,without,spaces)
3. my.cool.Stuff(arguments,$my.special.property,other,args)

where 'my.special.property' is a property in one of the MARY config files.

Returns:

the newly instantiated object.

Throws:

MaryConfigurationException - MaryConfigurationException

lowMemoryCondition

public static boolean lowMemoryCondition()

Verify if the java virtual machine is in a low memory condition. The memory is considered low if less than a specified value is still available for processing. "Available" memory is calculated using availableMemory().The threshold value can be specified as the Mary property mary.lowmemory (in bytes). It defaults to 20000000 bytes.

Returns:

a boolean indicating whether or not the system is in low memory condition.

veryLowMemoryCondition

public static boolean veryLowMemoryCondition()

Verify if the java virtual machine is in a very low memory condition. The memory is considered very low if less than half a specified value is still available for processing. "Available" memory is calculated using availableMemory() .The threshold value can be specified as the Mary property mary.lowmemory (in bytes). It defaults to 20000000 bytes.

Returns:

a boolean indicating whether or not the system is in very low memory condition.

getAudioFileFormatTypes

public static String getAudioFileFormatTypes()

List the available audio file format types, as a multi-line string. Each line consists of the name of an Audio file format type, followed by a suffix "_FILE" if the format can be produced as a file, and "_STREAM" if the format can be streamed.

Returns:

a multi-line string, or an empty string if no audio file types are available.

canCreateMP3

public static boolean canCreateMP3()

Determine whether conversion to mp3 is possible.

Returns:

AudioSystem.isConversionSupported(getMP3AudioFormat(), Voice.AF22050)

getMP3AudioFormat

public static AudioFormat getMP3AudioFormat()

canCreateOgg

public static boolean canCreateOgg()

Determine whether conversion to ogg vorbis format is possible.

Returns:

AudioSystem.isConversionSupported(getOggAudioFormat(), Voice.AF22050)

getOggAudioFormat

public static AudioFormat getOggAudioFormat()

determineAllophoneSet

public static AllophoneSet determineAllophoneSet(Element e)
                                          throws MaryConfigurationException

For an element in a MaryXML document, do what you can to determine the appropriate AllophoneSet. First search for the suitable voice, then if that fails, go by locale.

Parameters:

e - e

Returns:

an allophone set if there is any way of determining it, or null.

Throws:

MaryConfigurationException - if a suitable allophone set exists in principle, but there were problems loading it.

determineAllophoneSet

public static AllophoneSet determineAllophoneSet(Locale locale)
                                          throws MaryConfigurationException

Try to determine the Allophone set to use for the given locale.

Parameters:

locale - locale

Returns:

the allophone set defined for the given locale, or null if no such allophone set can be determined.

Throws:

MaryConfigurationException - if an allophone set exists for the given locale in principle, but there were problems loading it.

createAudioDestination

public static AudioDestination createAudioDestination()
                                               throws IOException

Create an AudioDestination to which the audio data can be written. Depending on the mary property "synthesis.audiostore", this will use either a ByteArrayOutputStream or a FileOutputStream. The calling code is responsible for administering this AudioDestination.

Returns:

AudioDestination(ram)

Throws:

IOException - if the underlying OutputStream could not be created.

needAllophoneSet

public static AllophoneSet needAllophoneSet(String propertyName)
                                     throws MaryConfigurationException

Convenience method to access the allophone set referenced in the MARY property with the given name.

Parameters:

propertyName - name of the property referring to the allophone set

Returns:

the requested allophone set. This method will never return null; if it cannot get the allophone set, it throws an exception.

Throws:

MaryConfigurationException - if the allophone set cannot be obtained

checkLexicon

public static String[] checkLexicon(String propertyName,
                    String token)
                             throws IOException,
                                    MaryConfigurationException

Throws:

IOException

MaryConfigurationException

getMaryVersion

public static String getMaryVersion()

getDataTypes

public static String getDataTypes()

getLocales

public static String getLocales()

getVoices

public static String getVoices()

getDefaultVoiceName

public static String getDefaultVoiceName()

getExampleText

public static String getExampleText(String datatype,
                    Locale locale)

getDefaultVoiceExampleTexts

public static Vector<String> getDefaultVoiceExampleTexts()

getVoiceExampleText

public static String getVoiceExampleText(String voiceName)

getVocalizations

public static String getVocalizations(String voiceName)

For the voice with the given name, return the list of vocalizations supported by this voice, one vocalization per line. These values can be used in the "name" attribute of the vocalization tag.

Parameters:

voiceName - voiceName

Returns:

the list of vocalizations, or the empty string if the voice does not support vocalizations.

getStyles

public static String getStyles(String voiceName)

For the voice with the given name, return the list of styles supported by this voice, if any, one style per line. These values can be used as the global "style" value in a synthesis request, or in the "style" attribute of the MaryXML prosody element.

Parameters:

voiceName - voiceName

Returns:

the list of styles, or the empty string if the voice does not support styles.

getDefaultAudioEffects

public static String getDefaultAudioEffects()

getAudioEffectDefaultParam

public static String getAudioEffectDefaultParam(String effectName)

getFullAudioEffect

public static String getFullAudioEffect(String effectName,
                        String currentEffectParams)

getAudioEffectHelpText

public static String getAudioEffectHelpText(String effectName)

isHmmAudioEffect

public static String isHmmAudioEffect(String effectName)