TTS Plugins

TTS plugins are responsible for converting text into audio for playback

List of TTS plugins

Plugin	Offline	Type
ovos-tts-plugin-mimic	yes	FOSS
ovos-tts-plugin-mimic2	no	API (free)
ovos-tts-plugin-mimic3	yes	FOSS
ovos-tts-plugin-marytts	no	API (self hosted)
neon-tts-plugin-larynx_server	no	API (self hosted)
ovos-tts-server-plugin	no	API (self hosted)
ovos-tts-plugin-pico	yes	FOSS
neon-tts-plugin-glados	yes	FOSS
neon-tts-plugin-mozilla_local	yes	FOSS
neon-tts-plugin-polly	no	API (key)
ovos-tts-plugin-voicerss	no	API (key)
ovos-tts-plugin-google-TX	no	API (free)
ovos-tts-plugin-responsivevoice	no	API (free)
neon-tts-plugin-mozilla_remote	no	API (self hosted)
neon-tts-plugin-tacotron2	yes	FOSS
ovos-tts-plugin-espeakNG	yes	FOSS
ovos-tts-plugin-cotovia	yes	FOSS
ovos-tts-plugin-catotron	no	API (self hosted)
ovos-tts-plugin-softcatala	no	API (self hosted)
ovos-tts-plugin-SAM	yes	Abandonware
ovos-tts-plugin-beepspeak	yes	Fun

Plugin Template

from ovos_plugin_manager.templates.tts import TTS


# base plugin class
class MyTTSPlugin(TTS):
    def __init__(self, *args, **kwargs):
        # in here you should specify if your plugin return wav or mp3 files
        # you should also specify any valid ssml tags
        ssml_tags = ["speak", "s", "w", "voice", "prosody", 
                     "say-as", "break", "sub", "phoneme"]
        super().__init__(*args, **kwargs, audio_ext="wav", ssml_tags=ssml_tags)
        # read config settings for your plugin if any
        self.pitch = self.config.get("pitch", 0.5)

    def get_tts(self, sentence, wav_file):
        # TODO - create TTS audio @ wav_file (path)
        return wav_file, None

    @property
    def available_languages(self):
        """Return languages supported by this TTS implementation in this state
        This property should be overridden by the derived class to advertise
        what languages that engine supports.
        Returns:
            set: supported languages
        """
        # TODO - what langs can this TTS handle?
        return {"en-us", "es-es"}



# sample valid configurations per language
# "display_name" and "offline" provide metadata for UI
# "priority" is used to calculate position in selection dropdown 
#       0 - top, 100-bottom
# all other keys represent an example valid config for the plugin 
MyTTSConfig = {
    lang: [{"lang": lang,
            "display_name": f"MyTTS ({lang}",
            "priority": 70,
            "offline": True}]
    for lang in ["en-us", "es-es"]
}