def _get_supportedSettings(self):
self.supportedSettings = settings = [
SynthDriver.VoiceSetting(),
SynthDriver.RateSetting(),
]
if self.supportsProsodyOptions:
settings.append(SynthDriver.RateBoostSetting())
settings.extend([
SynthDriver.PitchSetting(),
SynthDriver.VolumeSetting(),
])
return settings
class SynthDriver(SynthDriver):
name = "espeak"
description = "eSpeak NG"
supportedSettings = (
SynthDriver.VoiceSetting(),
SynthDriver.VariantSetting(),
SynthDriver.RateSetting(),
SynthDriver.RateBoostSetting(),
SynthDriver.PitchSetting(),
SynthDriver.InflectionSetting(),
SynthDriver.VolumeSetting(),
)
supportedCommands = {
speech.IndexCommand,
speech.CharacterModeCommand,
speech.LangChangeCommand,
speech.BreakCommand,
speech.PitchCommand,
speech.RateCommand,
speech.VolumeCommand,
speech.PhonemeCommand,
}
supportedNotifications = {synthIndexReached, synthDoneSpeaking}
@classmethod
def check(cls):
return True
def __init__(self):
_espeak.initialize(self._onIndexReached)
log.info("Using eSpeak NG version %s" % _espeak.info())
lang = languageHandler.getLanguage()
_espeak.setVoiceByLanguage(lang)
self._language = lang
self._variantDict = _espeak.getVariantDict()
self.variant = "max"
self.rate = 30
self.pitch = 40
self.inflection = 75
def _get_language(self):
return self._language
PROSODY_ATTRS = {
speech.PitchCommand: "pitch",
speech.VolumeCommand: "volume",
speech.RateCommand: "rate",
}
IPA_TO_ESPEAK = {
u"θ": u"T",
u"s": u"s",
u"ˈ": u"'",
}
def _processText(self, text):
# We need to make several replacements.
return text.translate({
0x1: None, # used for embedded commands
0x3C: u"<", # <: because of XML
0x3E: u">", # >: because of XML
0x5B: u" [", # [: [[ indicates phonemes
})
def speak(self, speechSequence):
defaultLanguage = self._language
textList = []
langChanged = False
prosody = {}
# We output malformed XML, as we might close an outer tag after opening an inner one; e.g.
# <voice><prosody></voice></prosody>.
# However, eSpeak doesn't seem to mind.
for item in speechSequence:
if isinstance(item, str):
textList.append(self._processText(item))
elif isinstance(item, speech.IndexCommand):
textList.append("<mark name=\"%d\" />" % item.index)
elif isinstance(item, speech.CharacterModeCommand):
textList.append("<say-as interpret-as=\"characters\">" if item.
state else "</say-as>")
elif isinstance(item, speech.LangChangeCommand):
if langChanged:
textList.append("</voice>")
textList.append(
"<voice xml:lang=\"%s\">" %
(item.lang if item.lang else defaultLanguage).replace(
'_', '-'))
langChanged = True
elif isinstance(item, speech.BreakCommand):
textList.append('<break time="%dms" />' % item.time)
elif type(item) in self.PROSODY_ATTRS:
if prosody:
# Close previous prosody tag.
textList.append("</prosody>")
attr = self.PROSODY_ATTRS[type(item)]
if item.multiplier == 1:
# Returning to normal.
try:
del prosody[attr]
except KeyError:
pass
else:
prosody[attr] = int(item.multiplier * 100)
if not prosody:
continue
textList.append("<prosody")
for attr, val in prosody.items():
textList.append(' %s="%d%%"' % (attr, val))
textList.append(">")
elif isinstance(item, speech.PhonemeCommand):
# We can't use str.translate because we want to reject unknown characters.
try:
phonemes = "".join(
[self.IPA_TO_ESPEAK[char] for char in item.ipa])
# There needs to be a space after the phoneme command.
# Otherwise, eSpeak will announce a subsequent SSML tag instead of processing it.
textList.append(u"[[%s]] " % phonemes)
except KeyError:
log.debugWarning("Unknown character in IPA string: %s" %
item.ipa)
if item.text:
textList.append(self._processText(item.text))
else:
log.error("Unknown speech: %s" % item)
# Close any open tags.
if langChanged:
textList.append("</voice>")
if prosody:
textList.append("</prosody>")
text = u"".join(textList)
_espeak.speak(text)
def cancel(self):
_espeak.stop()
def pause(self, switch):
_espeak.pause(switch)
_rateBoost = False
RATE_BOOST_MULTIPLIER = 3
def _get_rateBoost(self):
return self._rateBoost
def _set_rateBoost(self, enable):
if enable == self._rateBoost:
return
rate = self.rate
self._rateBoost = enable
self.rate = rate
def _get_rate(self):
val = _espeak.getParameter(_espeak.espeakRATE, 1)
if self._rateBoost:
val = int(val / self.RATE_BOOST_MULTIPLIER)
return self._paramToPercent(val, _espeak.minRate, _espeak.maxRate)
def _set_rate(self, rate):
val = self._percentToParam(rate, _espeak.minRate, _espeak.maxRate)
if self._rateBoost:
val = int(val * self.RATE_BOOST_MULTIPLIER)
_espeak.setParameter(_espeak.espeakRATE, val, 0)
def _get_pitch(self):
val = _espeak.getParameter(_espeak.espeakPITCH, 1)
return self._paramToPercent(val, _espeak.minPitch, _espeak.maxPitch)
def _set_pitch(self, pitch):
val = self._percentToParam(pitch, _espeak.minPitch, _espeak.maxPitch)
_espeak.setParameter(_espeak.espeakPITCH, val, 0)
def _get_inflection(self):
val = _espeak.getParameter(_espeak.espeakRANGE, 1)
return self._paramToPercent(val, _espeak.minPitch, _espeak.maxPitch)
def _set_inflection(self, val):
val = self._percentToParam(val, _espeak.minPitch, _espeak.maxPitch)
_espeak.setParameter(_espeak.espeakRANGE, val, 0)
def _get_volume(self):
return _espeak.getParameter(_espeak.espeakVOLUME, 1)
def _set_volume(self, volume):
_espeak.setParameter(_espeak.espeakVOLUME, volume, 0)
def _getAvailableVoices(self):
voices = OrderedDict()
for v in _espeak.getVoiceList():
l = _espeak.decodeEspeakString(v.languages[1:])
# #7167: Some languages names contain unicode characters EG: Norwegian Bokmål
name = _espeak.decodeEspeakString(v.name)
# #5783: For backwards compatibility, voice identifies should always be lowercase
identifier = os.path.basename(
_espeak.decodeEspeakString(v.identifier)).lower()
voices[identifier] = VoiceInfo(identifier, name, l)
return voices
def _get_voice(self):
curVoice = getattr(self, '_voice', None)
if curVoice: return curVoice
curVoice = _espeak.getCurrentVoice()
if not curVoice:
return ""
# #5783: For backwards compatibility, voice identifies should always be lowercase
return _espeak.decodeEspeakString(
curVoice.identifier).split('+')[0].lower()
def _set_voice(self, identifier):
if not identifier:
return
# #5783: For backwards compatibility, voice identifies should always be lowercase
identifier = identifier.lower()
if "\\" in identifier:
identifier = os.path.basename(identifier)
self._voice = identifier
try:
_espeak.setVoiceAndVariant(voice=identifier, variant=self._variant)
except:
self._voice = None
raise
self._language = super(SynthDriver, self).language
def _onIndexReached(self, index):
if index is not None:
synthIndexReached.notify(synth=self, index=index)
else:
synthDoneSpeaking.notify(synth=self)
def terminate(self):
_espeak.terminate()
def _get_variant(self):
return self._variant
def _set_variant(self, val):
self._variant = val if val in self._variantDict else "max"
_espeak.setVoiceAndVariant(variant=self._variant)
def _getAvailableVariants(self):
return OrderedDict((ID, VoiceInfo(ID, name))
for ID, name in self._variantDict.items())
class SynthDriver(SynthDriver):
name = "espeak"
description = "eSpeak NG"
supportedSettings = (
SynthDriver.VoiceSetting(),
SynthDriver.VariantSetting(),
SynthDriver.RateSetting(),
SynthDriver.RateBoostSetting(),
SynthDriver.PitchSetting(),
SynthDriver.InflectionSetting(),
SynthDriver.VolumeSetting(),
)
supportedCommands = {
IndexCommand,
CharacterModeCommand,
LangChangeCommand,
BreakCommand,
PitchCommand,
RateCommand,
VolumeCommand,
PhonemeCommand,
}
supportedNotifications = {synthIndexReached, synthDoneSpeaking}
# A mapping of commonly used language codes to eSpeak languages.
# Introduced due to eSpeak issue: https://github.com/espeak-ng/espeak-ng/issues/1200
# These are used when eSpeak doesn't support a given language code
# but a default alias is appropriate.
_defaultLangToLocale = {
# Languages without locale that aren't supported in eSpeak 7e5457f91e10,
# with a language with locale that is supported.
# Found via:
# set(stripLocaleFromLangCode(lang) for lang in self.availableLanguages).difference(self.availableLanguages)
"en": "en-gb",
"chr": "chr-US-Qaaa-x-west",
"fr": "fr-fr",
}
availableLanguages: Set[Optional[str]]
"""
For eSpeak commit 7e5457f91e10, this is equivalent to:
{
'ia',
'ru',
'cy',
'ms',
'af',
'fi',
'fr-fr',
'nog',
'gu',
'hu',
'eu',
'om',
'en-029',
'de',
'es',
'kk',
'an',
'nci',
'uk',
'vi-vn-x-south',
'grc',
'it',
'vi-vn-x-central',
'bg',
'piqd',
'ug',
'ar',
'da',
'mi',
'mr',
'pt-br',
'fr-ch',
'py',
'uz',
'en-gb',
'sw',
'as',
'shn',
'vi',
'nl',
'bs',
'ga',
'pap',
'sv',
'kn',
'gn',
'th',
'tr',
'pa',
'mt',
'chr-US-Qaaa-x-west',
'eo',
'kok',
'ky',
'lfn',
'is',
'pt',
'en-gb-x-gbcwmd',
'en-gb-x-rp',
'ht',
'bpy',
'fr-be',
'nb',
'lt',
'ja',
'te',
'tn',
'es-419',
'gd',
'sjn',
'he',
'hyw',
'et',
'ro',
'ru-lv',
'sq',
'quc',
'am',
'hr',
'qya',
'ka',
'el',
'tt',
'or',
'pl',
'qu',
'ba',
'ta',
'cmn',
'io',
'en-us',
'ur',
'hi',
'en-gb-scotland',
'fa',
'kl',
'tk',
'ku',
'si',
'cv',
'ca',
'qdb',
'hak',
'fa-latn',
'lv',
'en-gb-x-gbclan',
'ltg',
'ne',
'sl',
'az',
'yue',
'sk',
'hy',
'my',
'ko',
'mk',
'smj',
'ml',
'cmn-latn-pinyin',
'id',
'la',
'sr',
'bn',
'sd',
'cs',
'jbo',
'haw'
}
"""
@classmethod
def check(cls):
return True
def __init__(self):
_espeak.initialize(self._onIndexReached)
log.info("Using eSpeak NG version %s" % _espeak.info())
lang = getLanguage()
_espeak.setVoiceByLanguage(lang)
self._language = lang
self._variantDict = _espeak.getVariantDict()
self.variant = "max"
self.rate = 30
self.pitch = 40
self.inflection = 75
def _get_language(self):
return self._language
PROSODY_ATTRS = {
PitchCommand: "pitch",
VolumeCommand: "volume",
RateCommand: "rate",
}
IPA_TO_ESPEAK = {
u"θ": u"T",
u"s": u"s",
u"ˈ": u"'",
}
def _processText(self, text):
# We need to make several replacements.
return text.translate({
0x1: None, # used for embedded commands
0x3C: u"<", # <: because of XML
0x3E: u">", # >: because of XML
0x5B: u" [", # [: [[ indicates phonemes
})
def _normalizeLangCommand(self,
command: LangChangeCommand) -> LangChangeCommand:
"""
Checks if a LangChangeCommand language is compatible with eSpeak.
If not, find a default mapping occurs in L{_defaultLangToLocale}.
Otherwise, finds a language of a different dialect exists (e.g. ru-ru to ru).
Returns an eSpeak compatible LangChangeCommand.
"""
lowerCaseAvailableLangs = set(lang.lower()
for lang in self.availableLanguages)
# Use default language if no command.lang is supplied
langWithLocale = command.lang if command.lang else self._language
langWithLocale = langWithLocale.lower().replace('_', '-')
langWithoutLocale: Optional[str] = stripLocaleFromLangCode(
langWithLocale)
# Check for any language where the language code matches, regardless of dialect: e.g. ru-ru to ru
matchingLangs = filter(
lambda lang: stripLocaleFromLangCode(lang) == langWithoutLocale,
lowerCaseAvailableLangs)
anyLocaleMatchingLang = next(matchingLangs, None)
# Check from a list of known default mapping locales: e.g. en to en-gb
# Created due to eSpeak issue: https://github.com/espeak-ng/espeak-ng/issues/1200
knownDefaultLang = self._defaultLangToLocale.get(
langWithoutLocale, None)
if knownDefaultLang is not None and knownDefaultLang not in self.availableLanguages:
# This means eSpeak has changed and we need to update the mapping
log.error(
f"Default mapping unknown to eSpeak {knownDefaultLang} not in {self.availableLanguages}"
)
knownDefaultLang = None
if langWithLocale in lowerCaseAvailableLangs:
eSpeakLang = langWithLocale
elif knownDefaultLang is not None:
eSpeakLang = knownDefaultLang
elif langWithoutLocale in lowerCaseAvailableLangs:
eSpeakLang = langWithoutLocale
elif anyLocaleMatchingLang is not None:
eSpeakLang = anyLocaleMatchingLang
else:
log.debugWarning(
f"Unable to find an eSpeak language for '{langWithLocale}'")
eSpeakLang = None
return LangChangeCommand(eSpeakLang)
def _handleLangChangeCommand(
self,
langChangeCommand: LangChangeCommand,
langChanged: bool,
) -> str:
"""Get language xml tags needed to handle a lang change command.
- if a language change has already been handled for this speech,
close the open voice tag.
- if the language is supported by eSpeak, switch to that language.
- otherwise, switch to the default synthesizer language.
"""
langChangeCommand = self._normalizeLangCommand(langChangeCommand)
voiceChangeXML = ""
if langChanged:
# Close existing voice tag
voiceChangeXML += "</voice>"
if langChangeCommand.lang is not None:
# Open new voice tag using eSpeak compatible language
voiceChangeXML += f'<voice xml:lang="{langChangeCommand.lang}">'
else:
# Open new voice tag using default voice
voiceChangeXML += "<voice>"
return voiceChangeXML
# C901 'speak' is too complex
# Note: when working on speak, look for opportunities to simplify
# and move logic out into smaller helper functions.
def speak(self, speechSequence: SpeechSequence): # noqa: C901
textList: List[str] = []
langChanged = False
prosody: Dict[str, int] = {}
# We output malformed XML, as we might close an outer tag after opening an inner one; e.g.
# <voice><prosody></voice></prosody>.
# However, eSpeak doesn't seem to mind.
for item in speechSequence:
if isinstance(item, str):
textList.append(self._processText(item))
elif isinstance(item, IndexCommand):
textList.append("<mark name=\"%d\" />" % item.index)
elif isinstance(item, CharacterModeCommand):
textList.append("<say-as interpret-as=\"characters\">" if item.
state else "</say-as>")
elif isinstance(item, LangChangeCommand):
langChangeXML = self._handleLangChangeCommand(
item, langChanged)
textList.append(langChangeXML)
langChanged = True
elif isinstance(item, BreakCommand):
# Break commands are ignored at the start of speech unless strength is specified.
# Refer to eSpeak issue: https://github.com/espeak-ng/espeak-ng/issues/1232
textList.append(f'<break time="{item.time}ms" strength="1" />')
elif type(item) in self.PROSODY_ATTRS:
if prosody:
# Close previous prosody tag.
textList.append("</prosody>")
attr = self.PROSODY_ATTRS[type(item)]
if item.multiplier == 1:
# Returning to normal.
try:
del prosody[attr]
except KeyError:
pass
else:
prosody[attr] = int(item.multiplier * 100)
if not prosody:
continue
textList.append("<prosody")
for attr, val in prosody.items():
textList.append(' %s="%d%%"' % (attr, val))
textList.append(">")
elif isinstance(item, PhonemeCommand):
# We can't use str.translate because we want to reject unknown characters.
try:
phonemes = "".join(
[self.IPA_TO_ESPEAK[char] for char in item.ipa])
# There needs to be a space after the phoneme command.
# Otherwise, eSpeak will announce a subsequent SSML tag instead of processing it.
textList.append(u"[[%s]] " % phonemes)
except KeyError:
log.debugWarning("Unknown character in IPA string: %s" %
item.ipa)
if item.text:
textList.append(self._processText(item.text))
else:
log.error("Unknown speech: %s" % item)
# Close any open tags.
if langChanged:
textList.append("</voice>")
if prosody:
textList.append("</prosody>")
text = u"".join(textList)
_espeak.speak(text)
def cancel(self):
_espeak.stop()
def pause(self, switch):
_espeak.pause(switch)
_rateBoost = False
RATE_BOOST_MULTIPLIER = 3
def _get_rateBoost(self):
return self._rateBoost
def _set_rateBoost(self, enable):
if enable == self._rateBoost:
return
rate = self.rate
self._rateBoost = enable
self.rate = rate
def _get_rate(self):
val = _espeak.getParameter(_espeak.espeakRATE, 1)
if self._rateBoost:
val = int(val / self.RATE_BOOST_MULTIPLIER)
return self._paramToPercent(val, _espeak.minRate, _espeak.maxRate)
def _set_rate(self, rate):
val = self._percentToParam(rate, _espeak.minRate, _espeak.maxRate)
if self._rateBoost:
val = int(val * self.RATE_BOOST_MULTIPLIER)
_espeak.setParameter(_espeak.espeakRATE, val, 0)
def _get_pitch(self):
val = _espeak.getParameter(_espeak.espeakPITCH, 1)
return self._paramToPercent(val, _espeak.minPitch, _espeak.maxPitch)
def _set_pitch(self, pitch):
val = self._percentToParam(pitch, _espeak.minPitch, _espeak.maxPitch)
_espeak.setParameter(_espeak.espeakPITCH, val, 0)
def _get_inflection(self):
val = _espeak.getParameter(_espeak.espeakRANGE, 1)
return self._paramToPercent(val, _espeak.minPitch, _espeak.maxPitch)
def _set_inflection(self, val):
val = self._percentToParam(val, _espeak.minPitch, _espeak.maxPitch)
_espeak.setParameter(_espeak.espeakRANGE, val, 0)
def _get_volume(self):
return _espeak.getParameter(_espeak.espeakVOLUME, 1)
def _set_volume(self, volume):
_espeak.setParameter(_espeak.espeakVOLUME, volume, 0)
def _getAvailableVoices(self):
voices = OrderedDict()
for v in _espeak.getVoiceList():
l = _espeak.decodeEspeakString(v.languages[1:])
# #7167: Some languages names contain unicode characters EG: Norwegian Bokmål
name = _espeak.decodeEspeakString(v.name)
# #5783: For backwards compatibility, voice identifies should always be lowercase
identifier = os.path.basename(
_espeak.decodeEspeakString(v.identifier)).lower()
voices[identifier] = VoiceInfo(identifier, name, l)
return voices
def _get_voice(self):
curVoice = getattr(self, '_voice', None)
if curVoice: return curVoice
curVoice = _espeak.getCurrentVoice()
if not curVoice:
return ""
# #5783: For backwards compatibility, voice identifies should always be lowercase
return _espeak.decodeEspeakString(
curVoice.identifier).split('+')[0].lower()
def _set_voice(self, identifier):
if not identifier:
return
# #5783: For backwards compatibility, voice identifies should always be lowercase
identifier = identifier.lower()
if "\\" in identifier:
identifier = os.path.basename(identifier)
self._voice = identifier
try:
_espeak.setVoiceAndVariant(voice=identifier, variant=self._variant)
except:
self._voice = None
raise
self._language = super(SynthDriver, self).language
def _onIndexReached(self, index):
if index is not None:
synthIndexReached.notify(synth=self, index=index)
else:
synthDoneSpeaking.notify(synth=self)
def terminate(self):
_espeak.terminate()
def _get_variant(self):
return self._variant
def _set_variant(self, val):
self._variant = val if val in self._variantDict else "max"
_espeak.setVoiceAndVariant(variant=self._variant)
def _getAvailableVariants(self):
return OrderedDict((ID, VoiceInfo(ID, name))
for ID, name in self._variantDict.items())