Fix STT and TTS configuration handling #187

NeonDaniel · 2023-10-12T22:13:17Z

Fix STT and TTS config handling to pass parsed plugin config to plugin init
Closes #132

The get_plugin_config method is intended to load a complete configuration dict for a plugin where plugin-specific config takes the highest priority, then plugin class config (i.e. 'stt', 'tts'), and then global config (i.e. Configuration()['lang'])

codecov · 2023-10-12T22:14:22Z

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (dev@0063ba6). Click here to learn what that means.

Additional details and impacted files

@@          Coverage Diff          @@
##             dev    #187   +/-   ##
=====================================
  Coverage       ?   0.00%           
=====================================
  Files          ?      57           
  Lines          ?    3946           
  Branches       ?       0           
=====================================
  Hits           ?       0           
  Misses         ?    3946           
  Partials       ?       0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mikejgray · 2023-10-13T19:56:07Z

With this config:

{
  "play_wav_cmdline": "paplay %1",
  "play_mp3_cmdline": "paplay %1",
  "time_format": "half",
  "system_unit": "imperial",
  "lang": "de-de",
  "tts": {
    "module": "ovos_tts_plugin_espeakng",
    "ovos_tts_plugin_espeakng": {
      "lang": "de-de",
      "voice": "german-mbrola-5",
      "speed": "135",
      "amplitude": "80",
      "pitch": "20"
    }
  }
}

I receive these errors, and TTS fails to load:

2023-10-13 14:53:56.447 - ovos-launcher - ovos_plugin_manager.tts:create:197 - INFO - Found plugin ovos_tts_plugin_espeakng
2023-10-13 14:53:56.465 - ovos-launcher - ovos_plugin_manager.tts:create:206 - ERROR - The TTS plugin "ovos_tts_plugin_espeakng" could not be loaded.
Available modules: ovos-tts-plugin-mimic3-server,ovos-tts-plugin-mimic,ovos-tts-plugin-server,ovos-tts-plugin-dummy,ovos_tts_plugin_espeakng
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/tts.py", line 198, in create
    tts = clazz(tts_lang, tts_config)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_tts_plugin_espeakng/__init__.py", line 12, in __init__
    super().__init__(*args, **kwargs,
TypeError: TTS.__init__() got multiple values for argument 'lang'
2023-10-13 14:53:56.466 - ovos-launcher - ovos_audio.service:__init__:82 - ERROR - TTS.__init__() got multiple values for argument 'lang'
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 79, in __init__
    self._maybe_reload_tts()
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 295, in _maybe_reload_tts
    self.tts = TTSFactory.create(config)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/tts.py", line 9, in create
    return OVOSTTSFactory.create(config)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/tts.py", line 198, in create
    tts = clazz(tts_lang, tts_config)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_tts_plugin_espeakng/__init__.py", line 12, in __init__
    super().__init__(*args, **kwargs,
TypeError: TTS.__init__() got multiple values for argument 'lang'
2023-10-13 14:53:56.467 - ovos-launcher - ovos_audio.service:on_error:38 - ERROR - Audio service failed to launch (TTS.__init__() got multiple values for argument 'lang').
2023-10-13 14:53:56.482 - ovos-launcher - ovos_plugin_manager.templates.tts:add_metric:520 - ERROR - 'EspeakNGTTS' object has no attribute 'log_timestamps'
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/templates/tts.py", line 517, in add_metric
    if self.log_timestamps:
AttributeError: 'EspeakNGTTS' object has no attribute 'log_timestamps'

mikejgray · 2023-10-14T04:07:50Z

The latest change appears to have broken it entirely. Here's what it looks like with various combinations of lang set to de-de:

TypeError: TTS.__init__() got multiple values for argument 'lang'
2023-10-13 22:58:21.420 - ovos-launcher - ovos_audio.service:__init__:82 - ERROR - TTS.__init__() got multiple values for argument 'lang'
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 79, in __init__
    self._maybe_reload_tts()
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 295, in _maybe_reload_tts
    self.tts = TTSFactory.create(config)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/tts.py", line 9, in create
    return OVOSTTSFactory.create(config)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/tts.py", line 197, in create
    tts = clazz(None,  # don't pass lang and force read from config
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_tts_plugin_espeakng/__init__.py", line 12, in __init__
    super().__init__(*args, **kwargs,
TypeError: TTS.__init__() got multiple values for argument 'lang'
2023-10-13 22:58:21.422 - ovos-launcher - ovos_audio.service:on_error:38 - ERROR - Audio service failed to launch (TTS.__init__() got multiple values for argument 'lang').
2023-10-13 22:58:21.431 - ovos-launcher - ovos_plugin_manager.templates.tts:add_metric:275 - ERROR - 'EspeakNGTTS' object has no attribute 'log_timestamps'
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/templates/tts.py", line 272, in add_metric
    if self.log_timestamps:
AttributeError: 'EspeakNGTTS' object has no attribute 'log_timestamps'

And here's with the ovos-launcher default TTS and lang set to en-us:

2023-10-13 23:06:02.758 - ovos-launcher - ovos_plugin_manager.templates.tts:init:317 - WARNING - PlaybackThread should be inited by ovos-audio, initing via plugin has been deprecated, please pass playback=PlaybackThread() to TTS.init
2023-10-13 23:06:02.759 - ovos-launcher - ovos_plugin_manager.templates.tts:__new__:62 - WARNING - PlaybackThread moved to ovos_audio.playback
2023-10-13 23:06:02.760 - ovos-launcher - ovos_audio.service:__init__:82 - ERROR - please install ovos-audio for playback handling
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/templates/tts.py", line 64, in __new__
    from ovos_audio.playback import PlaybackThread
ModuleNotFoundError: No module named 'ovos_audio.playback'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 79, in __init__
    self._maybe_reload_tts()
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 296, in _maybe_reload_tts
    self.tts.init(self.bus)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/templates/tts.py", line 321, in init
    playback = PlaybackThread(TTS.queue, self.bus)  # compat
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/templates/tts.py", line 67, in __new__
    raise ImportError("please install ovos-audio for playback handling")
ImportError: please install ovos-audio for playback handling
2023-10-13 23:06:02.762 - ovos-launcher - ovos_audio.service:on_error:38 - ERROR - Audio service failed to launch (please install ovos-audio for playback handling).

mikejgray · 2023-10-14T04:29:37Z

Jarbas pointed out I had some version mismatches with ovos-audio, but even after resolving some:

2023-10-13 23:27:41.562 - ovos-launcher - ovos_plugin_manager.tts:create:206 - ERROR - The TTS plugin "ovos-tts-plugin-mimic3-server" could not be loaded.
Available modules: ovos-tts-plugin-mimic3-server,ovos-tts-plugin-mimic,ovos-tts-plugin-dummy,ovos-tts-plugin-server,ovos_tts_plugin_espeakng
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/tts.py", line 197, in create
    tts = clazz(None,  # don't pass lang and force read from config
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_tts_plugin_mimic3_server/__init__.py", line 52, in __init__
    lang = lang.split("-")[0]
AttributeError: 'NoneType' object has no attribute 'split'
2023-10-13 23:27:41.563 - ovos-launcher - ovos_audio.service:__init__:88 - ERROR - 'NoneType' object has no attribute 'split'
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 85, in __init__
    self._maybe_reload_tts()
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 332, in _maybe_reload_tts
    self._get_tts_fallback()
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/service.py", line 360, in _get_tts_fallback
    self.fallback_tts = TTSFactory.create(cfg)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_audio/tts.py", line 9, in create
    return OVOSTTSFactory.create(config)
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/tts.py", line 197, in create
    tts = clazz(None,  # don't pass lang and force read from config
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_tts_plugin_mimic3_server/__init__.py", line 52, in __init__
    lang = lang.split("-")[0]
AttributeError: 'NoneType' object has no attribute 'split'
2023-10-13 23:27:41.564 - ovos-launcher - ovos_audio.service:on_error:39 - ERROR - Audio service failed to launch ('NoneType' object has no attribute 'split').
2023-10-13 23:27:41.572 - ovos-launcher - ovos_plugin_manager.templates.tts:add_metric:275 - ERROR - 'Mimic3ServerTTSPlugin' object has no attribute 'log_timestamps'
Traceback (most recent call last):
  File "/home/mike/ovos-launcher/.venv/lib/python3.10/site-packages/ovos_plugin_manager/templates/tts.py", line 272, in add_metric
    if self.log_timestamps:
AttributeError: 'Mimic3ServerTTSPlugin' object has no attribute 'log_timestamps'

This is with default config, latest alphas of everything I could (some packages were forcing older versions and I had to push them forward manually)

NeonDaniel · 2023-10-18T16:40:11Z

Interesting.. it appears there's something wrong with lang handling still that's causing this; I'll see if I can reproduce this behavior in a unit test and fix it

ovos_plugin_manager/tts.py

mikejgray · 2023-10-23T13:37:52Z

I did a spot check and I think this fixed the issue, but I'll do some additional testing and come back with logs to confirm

mikejgray

2023-10-24 22:22:31.234 - audio - ovos_plugin_manager.tts:create:209 - INFO - Loaded plugin ovos_tts_plugin_espeakng

…n init

NeonDaniel requested review from mikejgray and a team October 12, 2023 22:13

JarbasAl added the bug Something isn't working label Oct 18, 2023

JarbasAl reviewed Oct 19, 2023

View reviewed changes

ovos_plugin_manager/tts.py Show resolved Hide resolved

NeonDaniel requested a review from JarbasAl October 21, 2023 01:31

JarbasAl approved these changes Oct 24, 2023

View reviewed changes

mikejgray approved these changes Oct 25, 2023

View reviewed changes

NeonDaniel and others added 7 commits October 25, 2023 11:27

Fix STT and TTS config handling to pass parsed plugin config to plugi…

e7ec8af

…n init

Fix lang handling in TTS init

6c8d0f5

Add TTS factory unit tests with configuration handling fixes

724c91e

Add STT factory unit tests with configuration handling fixes

5c521ad

Update unit tests to handle added kwargs passed to get_config

e9d9841

Mark mapped module handling as deprecated

4614eb8

Update exception logging

1b99cf2

NeonDaniel force-pushed the FIX_SttTtsPluginConfig branch from a78d58f to 1b99cf2 Compare October 25, 2023 18:27

JarbasAl merged commit 74a6045 into dev Oct 25, 2023

JarbasAl deleted the FIX_SttTtsPluginConfig branch October 25, 2023 18:29

github-actions bot mentioned this pull request Oct 26, 2023

0.0.24 #192

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix STT and TTS configuration handling #187

Fix STT and TTS configuration handling #187

NeonDaniel commented Oct 12, 2023 •

edited

Loading

codecov bot commented Oct 12, 2023 •

edited

Loading

mikejgray commented Oct 13, 2023

mikejgray commented Oct 14, 2023

mikejgray commented Oct 14, 2023

NeonDaniel commented Oct 18, 2023

mikejgray commented Oct 23, 2023

mikejgray left a comment

Fix STT and TTS configuration handling #187

Fix STT and TTS configuration handling #187

Conversation

NeonDaniel commented Oct 12, 2023 • edited Loading

codecov bot commented Oct 12, 2023 • edited Loading

Codecov Report

mikejgray commented Oct 13, 2023

mikejgray commented Oct 14, 2023

mikejgray commented Oct 14, 2023

NeonDaniel commented Oct 18, 2023

mikejgray commented Oct 23, 2023

mikejgray left a comment

Choose a reason for hiding this comment

NeonDaniel commented Oct 12, 2023 •

edited

Loading

codecov bot commented Oct 12, 2023 •

edited

Loading