feat: refactor init funtion

.gitignore

@@ -18,3 +18,6 @@ dist
 
 # Created by unit tests
 .pytest_cache/
+__pycache__
+hello.wav
+test/models

ovos_tts_plugin_piper/lang2voices.py

@@ -0,0 +1,63 @@
+LANG2VOICES = {
+    "ar": ["kareem-medium"],
+    "ca": ["upc_ona-x-low", "upc_pau-x-low"],
+    "cs": ["jirka-low", "jirka-medium"],
+    "da": ["nst_talesyntese-medium"],
+    "de": [
+        "eva_k-x-low",
+        "karlsson-low",
+        "kerstin-low",
+        "pavoque-low",
+        "ramona-low",
+        "thorsten-high",
+        "thorsten-low",
+        "thorsten-medium",
+        "thorsten_emotional-medium",
+    ],
+    "el": ["rapunzelina-low"],
+    "en-gb": ["alan-low", "alba-medium", "southern_english_female-low"],
+    "en-us": [
+        "amy-low",
+        "danny-low",
+        "kathleen-low",
+        "lessac-low",
+        "lessac-medium",
+        "libritts-high",
+        "ryan-high",
+        "ryan-low",
+        "ryan-medium",
+        "lessac",
+    ],
+    "es": [
+        "ald-medium",
+        "carlfm-x-low",
+        "davefx-medium",
+        "mls_10246-low",
+        "mls_9972-low",
+        "sharvard-medium",
+    ],
+    "fi": ["harri-low", "harri-medium"],
+    "fr": ["gilles-low", "mls_1840-low", "siwis-low", "siwis-medium", "upmc-medium"],
+    "hu": ["anna-medium", "berta-medium", "imre-medium"],
+    "is": ["bui-medium", "salka-medium", "steinn-medium", "ugla-medium"],
+    "it": ["riccardo_fasol-x-low"],
+    "ka": ["natia-medium"],
+    "kk": ["iseke-x-low", "issai-high", "raya-x-low"],
+    "lb": ["marylux-medium"],
+    "ne": ["google-medium", "google-x-low"],
+    "nl": ["mls_5809-low", "mls_7432-low", "nathalie-x-low", "rdh-medium", "rdh-x-low"],
+    "no": ["talesyntese-medium"],
+    "pl": ["darkman-medium", "gosia-medium", "mc_speech-medium", "mls_6892-low"],
+    "pt-br": ["edresson-low", "faber-medium"],
+    "pt": ["tugao-medium"],
+    "ro": ["mihai-medium"],
+    "ru": ["irina-medium", "denis-medium", "dmitri-medium", "ruslan-medium"],
+    "sk": ["lili-medium"],
+    "sr": ["serbski_institut-medium"],
+    "sv": ["nst-medium"],
+    "sw": ["lanfrica-medium"],
+    "tr": ["dfki-medium", "fahrettin-medium"],
+    "uk": ["lada-x-low", "ukrainian_tts-medium"],
+    "vi": ["25hours-single-low", "vais1000-medium", "vos-x-low"],
+    "zh-cn": ["huayan-x-low", "huayan-medium"],
+}

ovos_tts_plugin_piper/voice2url.py

@@ -0,0 +1,90 @@
+VOICE2URL = {
+    "25hours-single-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-vi-25hours-single-low.tar.gz",
+    "alan-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-gb-alan-low.tar.gz",
+    "alba-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/v1.0.0/en/en_GB/alba/medium/en_GB-alba-medium.onnx",
+    "ald-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/es/es_MX/ald/medium/es_MX-ald-medium.onnx",
+    "amy-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-amy-low.tar.gz",
+    "anna-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/hu/hu_HU/anna/medium/hu_HU-anna-medium.onnx",
+    "berta-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/hu/hu_HU/berta/medium/hu_HU-berta-medium.onnx",
+    "bui-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/is/is_IS/bui/medium/is_IS-bui-medium.onnx",
+    "carlfm-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-es-carlfm-x-low.tar.gz",
+    "danny-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-danny-low.tar.gz",
+    "darkman-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/pl/pl_PL/darkman/medium/pl_PL-darkman-medium.onnx",
+    "davefx-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/es/es_ES/davefx/medium/es_ES-davefx-medium.onnx",
+    "denis-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/ru/ru_RU/denis/medium/ru_RU-denis-medium.onnx",
+    "dfki-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/tr/tr_TR/dfki/medium/tr_TR-dfki-medium.onnx",
+    "dmitri-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/ru/ru_RU/dmitri/medium/ru_RU-dmitri-medium.onnx",
+    "edresson-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-pt-br-edresson-low.tar.gz",
+    "eva_k-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-de-eva_k-x-low.tar.gz",
+    "faber-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/pt/pt_BR/faber/medium/pt_BR-faber-medium.onnx",
+    "fahrettin-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/tr/tr_TR/fahrettin/medium/tr_TR-fahrettin-medium.onnx",
+    "gilles-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-fr-gilles-low.tar.gz",
+    "google-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-ne-google-medium.tar.gz",
+    "google-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-ne-google-x-low.tar.gz",
+    "gosia-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/pl/pl_PL/gosia/medium/pl_PL-gosia-medium.onnx",
+    "harri-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-fi-harri-low.tar.gz",
+    "harri-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/fi/fi_FI/harri/medium/fi_FI-harri-medium.onnx",
+    "huayan-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/zh/zh_CN/huayan/medium/zh_CN-huayan-medium.onnx",
+    "huayan-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-zh-cn-huayan-x-low.tar.gz",
+    "imre-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/hu/hu_HU/imre/medium/hu_HU-imre-medium.onnx",
+    "irina-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-ru-irinia-medium.tar.gz",
+    "iseke-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-kk-iseke-x-low.tar.gz",
+    "issai-high": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-kk-issai-high.tar.gz",
+    "jirka-low": "https://huggingface.co/rhasspy/piper-voices/resolve/main/cs/cs_CZ/jirka/low/cs_CZ-jirka-low.onnx",
+    "jirka-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/cs/cs_CZ/jirka/medium/cs_CZ-jirka-medium.onnx",
+    "kareem-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/ar/ar_JO/kareem/medium/ar_JO-kareem-medium.onnx",
+    "karlsson-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-de-karlsson-low.tar.gz",
+    "kathleen-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-kathleen-low.tar.gz",
+    "kerstin-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-de-kerstin-low.tar.gz",
+    "lada-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-uk-lada-x-low.tar.gz",
+    "lanfrica-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/sw/sw_CD/lanfrica/medium/sw_CD-lanfrica-medium.onnx",
+    "lessac": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us_lessac.tar.gz",
+    "lessac-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-lessac-low.tar.gz",
+    "lessac-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-lessac-medium.tar.gz",
+    "libritts-high": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-libritts-high.tar.gz",
+    "lili-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/sk/sk_SK/lili/medium/sk_SK-lili-medium.onnx",
+    "marylux-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/lb/lb_LU/marylux/medium/lb_LU-marylux-medium.onnx",
+    "mc_speech-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/pl/pl_PL/mc_speech/medium/pl_PL-mc_speech-medium.onnx",
+    "mihai-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/ro/ro_RO/mihai/medium/ro_RO-mihai-medium.onnx",
+    "mls_10246-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-es-mls_10246-low.tar.gz",
+    "mls_1840-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-fr-mls_1840-low.tar.gz",
+    "mls_5809-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-nl-mls_5809-low.tar.gz",
+    "mls_6892-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-pl-mls_6892-low.tar.gz",
+    "mls_7432-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-nl-mls_7432-low.tar.gz",
+    "mls_9972-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-es-mls_9972-low.tar.gz",
+    "nathalie-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-nl-nathalie-x-low.tar.gz",
+    "natia-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/ka/ka_GE/natia/medium/ka_GE-natia-medium.onnx",
+    "nst-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/sv/sv_SE/nst/medium/sv_SE-nst-medium.onnx",
+    "nst_talesyntese-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-da-nst_talesyntese-medium.tar.gz",
+    "pavoque-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-de-pavoque-low.tar.gz",
+    "ramona-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-de-ramona-low.tar.gz",
+    "rapunzelina-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-el-gr-rapunzelina-low.tar.gz",
+    "raya-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-kk-raya-x-low.tar.gz",
+    "rdh-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-nl-rdh-medium.tar.gz",
+    "rdh-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-nl-rdh-x-low.tar.gz",
+    "riccardo_fasol-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-it-riccardo_fasol-x-low.tar.gz",
+    "ruslan-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/ru/ru_RU/ruslan/medium/ru_RU-ruslan-medium.onnx",
+    "ryan-high": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-ryan-high.tar.gz",
+    "ryan-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-ryan-low.tar.gz",
+    "ryan-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-us-ryan-medium.tar.gz",
+    "salka-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/is/is_IS/salka/medium/is_IS-salka-medium.onnx",
+    "serbski_institut-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/sr/sr_RS/serbski_institut/medium/sr_RS-serbski_institut-medium.onnx",
+    "sharvard-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/es/es_ES/sharvard/medium/es_ES-sharvard-medium.onnx",
+    "siwis-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-fr-siwis-low.tar.gz",
+    "siwis-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-fr-siwis-medium.tar.gz",
+    "steinn-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/is/is_IS/steinn/medium/is_IS-steinn-medium.onnx",
+    "southern_english_female-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-en-gb-southern_english_female-low.tar.gz",
+    "talesyntese-medium": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-no-talesyntese-medium.tar.gz",
+    "thorsten-high": "https://huggingface.co/rhasspy/piper-voices/resolve/main/de/de_DE/thorsten/high/de_DE-thorsten-high.onnx",
+    "thorsten-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-de-thorsten-low.tar.gz",
+    "thorsten-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/de/de_DE/thorsten/medium/de_DE-thorsten-medium.onnx",
+    "thorsten_emotional-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/de/de_DE/thorsten_emotional/medium/de_DE-thorsten_emotional-medium.onnx",
+    "tugao-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/pt/pt_PT/tug%C3%A3o/medium/pt_PT-tug%C3%A3o-medium.onnx",
+    "ugla-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/is/is_IS/ugla/medium/is_IS-ugla-medium.onnx",
+    "ukrainian_tts-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/uk/uk_UA/ukrainian_tts/medium/uk_UA-ukrainian_tts-medium.onnx",
+    "upc_ona-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-ca-upc_ona-x-low.tar.gz",
+    "upc_pau-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-ca-upc_pau-x-low.tar.gz",
+    "upmc-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/fr/fr_FR/upmc/medium/fr_FR-upmc-medium.onnx",
+    "vais1000-medium": "https://huggingface.co/rhasspy/piper-voices/resolve/main/vi/vi_VN/vais1000/medium/vi_VN-vais1000-medium.onnx",
+    "vos-x-low": "https://github.com/rhasspy/piper/releases/download/v0.0.2/voice-vi-vivos-x-low.tar.gz",
+}

readme.md

@@ -8,13 +8,20 @@ OVOS TTS plugin for [piper](https://github.com/rhasspy/piper)
 
 ## Configuration
 
-download models from https://github.com/rhasspy/piper/releases/tag/v0.0.2
+Models can be loaded from the ones built-in to Piper, a list of pre-defined downloadable voices, or from the devices local storage.
+Models are stored in `$XDG_HOME/piper_tts/$model_name"` and consist of a .onnx and .json file, ex:
+```bash
+ls -1 $XDG_HOME/piper_tts/example/
+example.onnx
+example.onnx.json
+```
 
-you can also pass an url for a .tar.gz model, and it will be auto downloaded
+Available aliases can be found in [this list](https://github.com/OpenVoiceOS/ovos-tts-plugin-piper/blob/dev/ovos_tts_plugin_piper/__init__.py#L154)
+A list of downloadable models can be found [here](https://github.com/rhasspy/piper/releases/tag/v0.0.2) or [here](https://huggingface.co/rhasspy/piper-voices/tree/main), to use one just link to the .onnx file in the `voice` parameter of the configuration
 
-if no model is passed it will be auto selected based on language
+Passed URLs can be to a .onnx file which contains an appropriately named .json definition file in the same location, or to a .tar.gz archive containing the files
 
-you can pass a model name alias, eg "alan-low"
+if no model is passed it will be auto selected based on language
 
 ```json
   "tts": {
@@ -24,3 +31,5 @@ you can pass a model name alias, eg "alan-low"
     }
   }
 ```
+
+

requirements.txt

@@ -1,2 +1,2 @@
 ovos-plugin-manager>=0.0.5
-piper-tts==1.2.0
+piper-tts>=1.1.0

test/unittests/piper_tts_plugin_test.py

@@ -0,0 +1,73 @@
+import unittest
+import os
+import shutil
+
+from ovos_tts_plugin_piper import PiperTTSPlugin
+
+class TestPiperTTSPluginMethods(unittest.TestCase):
+    def tearDown(self) -> None:
+        try:
+            shutil.rmtree("./test/models")
+            os.remove("./test/hello.wav")
+        except:
+            pass
+
+        return super().tearDown()
+
+    def test_class_setup(self):
+        plugin = PiperTTSPlugin()
+        self.assertEqual(plugin.voice, "alan-low")
+        self.assertEqual(plugin.use_cuda, False)
+
+    def test_class_setup_with_config(self):
+        plugin = PiperTTSPlugin(config={
+            "model": "alba-medium",
+            "use_cuda": True,
+            "noise-scale": 1,
+            "length-scale": 1,
+            "noise-w": 1,
+            "model-path": "./test/models"
+        })
+        self.assertEqual(plugin.voice, "alba-medium")
+        self.assertEqual(plugin.use_cuda, True)
+        self.assertEqual(plugin.noise_scale, 1)
+        self.assertEqual(plugin.length_scale, 1)
+        self.assertEqual(plugin.noise_w, 1)
+        self.assertEqual(plugin.model_path, "./test/models")
+
+    def test_get_model_name(self):
+        plugin = PiperTTSPlugin(config={
+            "model-path": "./test/models"
+        })
+        self.assertEqual(plugin.get_model_name("alba-medium"), "en_GB-alba-medium")
+        self.assertEqual(plugin.get_model_name("https://huggingface.co/rhasspy/piper-voices/resolve/main/pt/pt_BR/faber/medium/pt_BR-faber-medium.onnx"), "pt_BR-faber-medium")
+        with self.assertRaises(ValueError):
+            plugin.get_model_name("something-invalid")
+
+    def test_download_model(self):
+        plugin = PiperTTSPlugin(config={
+            "model-path": "./test/models"
+        })
+        plugin.download_model("./test/models/pt_BR-faber-medium", "https://huggingface.co/rhasspy/piper-voices/resolve/main/pt/pt_BR/faber/medium/pt_BR-faber-medium.onnx")
+        self.assertTrue(os.path.isfile("./test/models/pt_BR-faber-medium/pt_BR-faber-medium.onnx"))
+        self.assertTrue(os.path.isfile("./test/models/pt_BR-faber-medium/pt_BR-faber-medium.onnx.json"))
+
+    def test_get_voice_subtype_from_model_name(self):
+        plugin = PiperTTSPlugin()
+        self.assertEqual(plugin.get_speaker_from_model_name("alan-low"), 0)
+        self.assertEqual(plugin.get_speaker_from_model_name("alan-low#"), 0)
+        self.assertEqual(plugin.get_speaker_from_model_name("alan-low#1"), 1)
+
+    def test_get_tts(self):
+        plugin = PiperTTSPlugin(config={
+            "model-path": "./test/models"
+        })
+        plugin.get_tts("one oh clock? yes! it is one on the clock", "./test/hello.wav")
+        self.assertTrue(os.path.isfile("./test/hello.wav"))
+        file_stats = os.stat("./test/hello.wav")
+        self.assertTrue(file_stats.st_size > 0)
+
+
+if __name__ == '__main__':
+    unittest.main()
+