wiki:SpeechEngine

Version 9 (modified by welberge, 7 years ago) (diff)

--

SpeechEngine

AsapRealizer's default SpeechEngine provides flexible support for different TTS systems. Lipsync can flexibly be configured through lipsync providers. Loaders and default configurations are provided for  MARYTTS and Microsoft Speech API compatible TTS systems.

XML Setup

AsapRealizer's default SpeechEngine is set up through a SpeechEngineLoader xml description.

Typical setup:

<Loader id="facelipsync" requiredloaders="faceengine" loader="asap.faceengine.loader.TimedFaceUnitLipSynchProviderLoader">
  <MorphVisemeBinding resources="Humanoids/armandia/facebinding/" filename="ikpvisemebinding.xml"/>
</Loader>

<Loader id="jawlipsync" requiredloaders="animationengine" loader="asap.animationengine.loader.TimedAnimationUnitLipSynchProviderLoader">
  <SpeechBinding basedir="" resources="Humanoids/shared/speechbinding/" filename="ikpspeechbinding.xml"/>
</Loader>
 
<Loader id="speechengine" loader="asap.speechengine.loader.SpeechEngineLoader" requiredloaders="facelipsync,jawlipsync">
  <Voice voicetype="MARY" localmarydir="HmiResource/MARYTTS" factory="WAV_TTS"/>
</Loader>

The connection to the TTS system and the voice selection is specified in the Voice element. It has the following attributes:

AttributeUseDescription
voicetyperequiredeither MARY for MARYTTS or SAPI5 for a Microsoft Speech API compatible voice (Windows only)
voicenameoptionalthe name of the voice that is to be used
localmarydirMARYTTS only, either marydir or localmarydir should be specifiedthe directory in which MARYTTS is installed, relative to shared.project.root
marydirMARYTTS only, either marydir or localmarydir should be specifiedthe directory in which MARYTTS is installed (absolute path)
factoryoptional, defaults to WAV_TTSWAV_TTS or DIRECT_TTS whether speech is to be produced directly by the TTS-system (DIRECT_TTS) or by first having the TTS system generate a .wav file and then play that back (WAV_TTS). DIRECT_TTS is experimental.

TODO: document <SpeechUI>

MaryTTS Setup

TODO

Microsoft SAPI Setup

TODO

Discussion

SpeechEngine
 unsolved

If you have any questions, documentation requests, hints, tips, or corrections to this document, please add them here by replying to this topic.