marytts.modules.synthesis

Class Voice

java.lang.Object

marytts.modules.synthesis.Voice

Direct Known Subclasses:

HMMVoice, InterpolatingVoice, UnitSelectionVoice

public class Voice
extends Object

A helper class for the synthesis module; each Voice object represents one available voice database.

Author:

Marc Schröder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Voice.Gender

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Model>	acousticModels
static AudioFormat	AF16000 Audio format: 16kHz,16bit,mono, native byte order
static AudioFormat	AF16000BE Audio format: 16kHz,16bit,mono, big endian
static AudioFormat	AF22050 Audio format: 22.05kHz,16bit,mono, native byte order
protected DirectedGraph	durationGraph
protected FeatureFileReader	f0ContourFeatures
protected DirectedGraph	f0Graph
static Voice.Gender	FEMALE Gender: female.
protected static org.apache.log4j.Logger	logger
static Voice.Gender	MALE Gender: male.

Constructor Summary

Constructors

Constructor and Description
Voice(String name, Locale locale, AudioFormat dbAudioFormat, WaveformSynthesizer synthesizer, Voice.Gender gender) Deprecated.
Voice(String name, WaveformSynthesizer synthesizer)

Method Summary

Methods

Modifier and Type	Method and Description
AudioFormat	dbAudioFormat()
Voice.Gender	gender()
Map<String,Model>	getAcousticModels() Get the acoustic models defined for this voice.
Allophone	getAllophone(String phoneSymbol) Deprecated. use AllophoneSet.getAllophone(String) directly instead
AllophoneSet	getAllophoneSet() Get the allophone set associated with this voice.
static Collection<Voice>	getAvailableVoices() Get the list of all available voices.
static Collection<Voice>	getAvailableVoices(Locale locale) Get the list of all available voices for a given locale.
static Collection<Voice>	getAvailableVoices(WaveformSynthesizer synth) Get the list of all available voices for a given waveform synthesizer.
static Collection<Voice>	getAvailableVoices(WaveformSynthesizer synth, Locale locale) Get the list of all available voices for a given waveform synthesizer and locale.
Model	getBoundaryModel() Get the boundary duration model for this voice.
static Voice	getDefaultVoice(Locale locale)
DirectedGraph	getDurationGraph()
Model	getDurationModel() Get the duration model for this voice.
FeatureFileReader	getF0ContourFeatures()
DirectedGraph	getF0Graph()
Model	getF0Model() Get the F0 model for this voice.
Locale	getLocale()
String	getName() Return the name of this voice.
Map<String,Model>	getOtherModels() Return any "other" acoustic models that we have.
Vector<MaryModule>	getPreferredModulesAcceptingType(MaryDataType type)
String[]	getStyles() Get any styles supported by this voice.
static Voice	getSuitableVoice(MaryData d)
VocalizationSynthesizer	getVocalizationSynthesizer()
static Voice	getVoice(Element voiceElement)
static Voice	getVoice(Locale locale, Voice.Gender gender)
static Voice	getVoice(String name) Get the voice with the given name, or null if there is no voice with that name.
boolean	hasName(String aName)
boolean	hasVocalizationSupport()
static void	registerVoice(Voice voice) Register the given voice.
AudioInputStream	synthesize(List<Element> tokensAndBoundaries, String outputParams) Synthesize a list of tokens and boundaries with the waveform synthesizer providing this voice.
WaveformSynthesizer	synthesizer()
String	toString() Returns the return value of getName().

Methods inherited from class java.lang.Object

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

Field Detail

MALE

public static final Voice.Gender MALE

Gender: male.

FEMALE

public static final Voice.Gender FEMALE

Gender: female.

AF16000

public static final AudioFormat AF16000

Audio format: 16kHz,16bit,mono, native byte order

AF16000BE

public static final AudioFormat AF16000BE

Audio format: 16kHz,16bit,mono, big endian

AF22050

public static final AudioFormat AF22050

Audio format: 22.05kHz,16bit,mono, native byte order

logger

protected static org.apache.log4j.Logger logger

durationGraph

protected DirectedGraph durationGraph

f0Graph

protected DirectedGraph f0Graph

f0ContourFeatures

protected FeatureFileReader f0ContourFeatures

acousticModels

protected Map<String,Model> acousticModels

Constructor Detail

Voice

@Deprecated
public Voice(String name,
                Locale locale,
                AudioFormat dbAudioFormat,
                WaveformSynthesizer synthesizer,
                Voice.Gender gender)
      throws MaryConfigurationException

Deprecated.

Throws:

MaryConfigurationException

Voice

public Voice(String name,
     WaveformSynthesizer synthesizer)
      throws MaryConfigurationException

Throws:

MaryConfigurationException

Method Detail

getAllophoneSet

public AllophoneSet getAllophoneSet()

Get the allophone set associated with this voice.

Returns:

allophoneSet

getAllophone

@Deprecated
public Allophone getAllophone(String phoneSymbol)

Deprecated. use AllophoneSet.getAllophone(String) directly instead

Get the Allophone set for the given phone symbol.

Parameters:

phoneSymbol - phoneSymbol

Returns:

an Allophone object if phoneSymbol is a known phone symbol in the voice's AllophoneSet.

getPreferredModulesAcceptingType

public Vector<MaryModule> getPreferredModulesAcceptingType(MaryDataType type)

hasName

public boolean hasName(String aName)

getName

public String getName()

Return the name of this voice. If the voice has several possible names, the first one is returned.

Returns:

voiceName

toString

public String toString()

Returns the return value of getName().

Overrides:

toString in class Object

getLocale

public Locale getLocale()

dbAudioFormat

public AudioFormat dbAudioFormat()

synthesizer

public WaveformSynthesizer synthesizer()

gender

public Voice.Gender gender()

hasVocalizationSupport

public boolean hasVocalizationSupport()

getVocalizationSynthesizer

public VocalizationSynthesizer getVocalizationSynthesizer()

getStyles

public String[] getStyles()

Get any styles supported by this voice.

Returns:

an array of style names supported by this voice, or null if styles are not supported.

synthesize

public AudioInputStream synthesize(List<Element> tokensAndBoundaries,
                          String outputParams)
                            throws SynthesisException

Synthesize a list of tokens and boundaries with the waveform synthesizer providing this voice.

Parameters:

tokensAndBoundaries - tokensAndBoundaries

outputParams - outputParams

Returns:

f0ContourFeatures

Throws:

SynthesisException - SynthesisException

getDurationGraph

public DirectedGraph getDurationGraph()

getF0Graph

public DirectedGraph getF0Graph()

getF0ContourFeatures

public FeatureFileReader getF0ContourFeatures()

getAcousticModels

public Map<String,Model> getAcousticModels()

Get the acoustic models defined for this voice.

Returns:

a Map mapping model names to models, or null if there are no such models.

getDurationModel

public Model getDurationModel()

Get the duration model for this voice.

Returns:

the model, or null if no such model is defined.

getF0Model

public Model getF0Model()

Get the F0 model for this voice.

Returns:

the model, or null if no such model is defined.

getBoundaryModel

public Model getBoundaryModel()

Get the boundary duration model for this voice.

Returns:

the model, or null if no such model is defined.

getOtherModels

public Map<String,Model> getOtherModels()

Return any "other" acoustic models that we have. Other models are acoustic models beyond duration, F0 and boundary.

Returns:

a Map mapping the model name to the model, or null if no other models exist.

registerVoice

public static void registerVoice(Voice voice)

Register the given voice. It will be contained in the list of available voices returned by any subsequent calls to getAvailableVoices(). If the voice has the highest value of wantToBeDefault for its locale it will be registered as the default voice for its locale. This value is set in the config file setting voice.(name).want.to.be.default.voice.

Parameters:

voice - voicwe

getVoice

public static Voice getVoice(String name)

Get the voice with the given name, or null if there is no voice with that name.

Parameters:

name - name

Returns:

v if it has name

getAvailableVoices

public static Collection<Voice> getAvailableVoices()

Get the list of all available voices. The iterator of the collection returned will return the voices in decreasing order of their "wantToBeDefault" value.

Returns:

Collections.unmodifiableSet(allVoices)

getAvailableVoices

public static Collection<Voice> getAvailableVoices(Locale locale)

Get the list of all available voices for a given locale. The iterator of the collection returned will return the voices in decreasing order of their "wantToBeDefault" value.

Parameters:

locale - locale

Returns:

a collection of Voice objects, or an empty collection if no voice is available for the given locale.

getAvailableVoices

public static Collection<Voice> getAvailableVoices(WaveformSynthesizer synth)

Get the list of all available voices for a given waveform synthesizer. The iterator of the collection returned will return the voices in decreasing order of their "wantToBeDefault" value.

Parameters:

synth - synth

Returns:

a collection of Voice objects, or an empty collection if no voice is available for the given waveform synthesizer.

getAvailableVoices

public static Collection<Voice> getAvailableVoices(WaveformSynthesizer synth,
                                   Locale locale)

Get the list of all available voices for a given waveform synthesizer and locale. The iterator of the collection returned will return the voices in decreasing order of their "wantToBeDefault" value.

Parameters:

synth - synth

locale - locale

Returns:

a collection of Voice objects, or an empty collection if no voice is available for the given locale.

getVoice

public static Voice getVoice(Locale locale,
             Voice.Gender gender)

getVoice

public static Voice getVoice(Element voiceElement)

getDefaultVoice

public static Voice getDefaultVoice(Locale locale)

getSuitableVoice

public static Voice getSuitableVoice(MaryData d)