wyoming-piper 1.3.2__py3-none-any.whl → 1.5.3__py3-none-any.whl

wyoming_piper/__init__.py

@@ -1 +1,6 @@
 """Wyoming server for piper."""
+from importlib.metadata import version
+
+__version__ = version("wyoming_piper")
+
+__all__ = ["__version__"]

wyoming_piper/__main__.py

@@ -7,9 +7,10 @@ from functools import partial
 from pathlib import Path
 from typing import Any, Dict, Set
 
-from wyoming.info import Attribution, Info, TtsProgram, TtsVoice
+from wyoming.info import Attribution, Info, TtsProgram, TtsVoice, TtsVoiceSpeaker
 from wyoming.server import AsyncServer
 
+from . import __version__
 from .download import find_voice, get_voices
 from .handler import PiperEventHandler
 from .process import PiperProcessManager
@@ -67,13 +68,25 @@ async def main() -> None:
     )
     #
     parser.add_argument("--debug", action="store_true", help="Log DEBUG messages")
+    parser.add_argument(
+        "--log-format", default=logging.BASIC_FORMAT, help="Format for log messages"
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=__version__,
+        help="Print version and exit",
+    )
     args = parser.parse_args()
 
     if not args.download_dir:
         # Default to first data directory
         args.download_dir = args.data_dir[0]
 
-    logging.basicConfig(level=logging.DEBUG if args.debug else logging.INFO)
+    logging.basicConfig(
+        level=logging.DEBUG if args.debug else logging.INFO, format=args.log_format
+    )
+    _LOGGER.debug(args)
 
     # Load voice info
     voices_info = get_voices(args.download_dir, update_voices=args.update_voices)
@@ -93,15 +106,19 @@ async def main() -> None:
                 name="rhasspy", url="https://github.com/rhasspy/piper"
             ),
             installed=True,
-            languages=[voice_info["language"]["code"]],
-            #
-            # Don't send speakers for now because it overflows StreamReader buffers
-            # speakers=[
-            #     TtsVoiceSpeaker(name=speaker_name)
-            #     for speaker_name in voice_info["speaker_id_map"]
-            # ]
-            # if voice_info.get("speaker_id_map")
-            # else None,
+            version=None,
+            languages=[
+                voice_info.get("language", {}).get(
+                    "code",
+                    voice_info.get("espeak", {}).get("voice", voice_name.split("_")[0]),
+                )
+            ],
+            speakers=[
+                TtsVoiceSpeaker(name=speaker_name)
+                for speaker_name in voice_info["speaker_id_map"]
+            ]
+            if voice_info.get("speaker_id_map")
+            else None,
         )
         for voice_name, voice_info in voices_info.items()
         if not voice_info.get("_is_alias", False)
@@ -123,20 +140,32 @@ async def main() -> None:
 
     for custom_voice_name in custom_voice_names:
         # Add custom voice info
-        _custom_voice_path, custom_config_path = find_voice(
+        custom_voice_path, custom_config_path = find_voice(
             custom_voice_name, args.data_dir
         )
         with open(custom_config_path, "r", encoding="utf-8") as custom_config_file:
             custom_config = json.load(custom_config_file)
-            custom_name = custom_config["dataset"]
-            custom_quality = custom_config["audio"]["quality"]
+            custom_name = custom_config.get("dataset", custom_voice_path.stem)
+            custom_quality = custom_config.get("audio", {}).get("quality")
+            if custom_quality:
+                description = f"{custom_name} ({custom_quality})"
+            else:
+                description = custom_name
+
+            lang_code = custom_config.get("language", {}).get("code")
+            if not lang_code:
+                lang_code = custom_config.get("espeak", {}).get("voice")
+                if not lang_code:
+                    lang_code = custom_voice_path.stem.split("_")[0]
+
             voices.append(
                 TtsVoice(
                     name=custom_name,
-                    description=f"{custom_name} ({custom_quality})",
+                    description=description,
+                    version=None,
                     attribution=Attribution(name="", url=""),
                     installed=True,
-                    languages=[custom_config["language"]["code"]],
+                    languages=[lang_code],
                 )
             )
 
@@ -150,6 +179,7 @@ async def main() -> None:
                 ),
                 installed=True,
                 voices=sorted(voices, key=lambda v: v.name),
+                version=__version__,
             )
         ],
     )
@@ -188,8 +218,13 @@ def get_description(voice_info: Dict[str, Any]):
 
 # -----------------------------------------------------------------------------
 
+
+def run():
+    asyncio.run(main())
+
+
 if __name__ == "__main__":
     try:
-        asyncio.run(main())
+        run()
     except KeyboardInterrupt:
         pass

wyoming_piper/download.py

@@ -4,6 +4,8 @@ import logging
 import shutil
 from pathlib import Path
 from typing import Any, Dict, Iterable, Set, Tuple, Union
+from urllib.error import URLError
+from urllib.parse import quote, urlsplit, urlunsplit
 from urllib.request import urlopen
 
 from .file_hash import get_file_hash
@@ -20,6 +22,13 @@ class VoiceNotFoundError(Exception):
     pass
 
 
+def _quote_url(url: str) -> str:
+    """Quote file part of URL in case it contains UTF-8 characters."""
+    parts = list(urlsplit(url))
+    parts[2] = quote(parts[2])
+    return urlunsplit(parts)
+
+
 def get_voices(
     download_dir: Union[str, Path], update_voices: bool = False
 ) -> Dict[str, Any]:
@@ -32,7 +41,7 @@ def get_voices(
         try:
             voices_url = URL_FORMAT.format(file="voices.json")
             _LOGGER.debug("Downloading %s to %s", voices_url, voices_download)
-            with urlopen(voices_url) as response:
+            with urlopen(_quote_url(voices_url)) as response:
                 with open(voices_download, "wb") as download_file:
                     shutil.copyfileobj(response, download_file)
         except Exception:
@@ -72,6 +81,7 @@ def ensure_voice_exists(
 
     voice_info = voices_info[name]
     voice_files = voice_info["files"]
+    verified_files: Set[str] = set()
     files_to_download: Set[str] = set()
 
     for data_dir in data_dirs:
@@ -79,8 +89,8 @@ def ensure_voice_exists(
 
         # Check sizes/hashes
         for file_path, file_info in voice_files.items():
-            if file_path in files_to_download:
-                # Already planning to download
+            if file_path in verified_files:
+                # Already verified this file in a different data directory
                 continue
 
             file_name = Path(file_path).name
@@ -118,28 +128,36 @@ def ensure_voice_exists(
                 files_to_download.add(file_path)
                 continue
 
+            # File exists and has been verified
+            verified_files.add(file_path)
+            files_to_download.discard(file_path)
+
     if (not voice_files) and (not files_to_download):
         raise ValueError(f"Unable to find or download voice: {name}")
 
-    # Download missing files
-    download_dir = Path(download_dir)
+    try:
+        # Download missing or update to date files
+        download_dir = Path(download_dir)
 
-    for file_path in files_to_download:
-        file_name = Path(file_path).name
-        if file_name in _SKIP_FILES:
-            continue
+        for file_path in files_to_download:
+            file_name = Path(file_path).name
+            if file_name in _SKIP_FILES:
+                continue
 
-        file_url = URL_FORMAT.format(file=file_path)
-        download_file_path = download_dir / file_name
-        download_file_path.parent.mkdir(parents=True, exist_ok=True)
+            file_url = URL_FORMAT.format(file=file_path)
+            download_file_path = download_dir / file_name
+            download_file_path.parent.mkdir(parents=True, exist_ok=True)
 
-        _LOGGER.debug("Downloading %s to %s", file_url, download_file_path)
-        with urlopen(file_url) as response, open(
-            download_file_path, "wb"
-        ) as download_file:
-            shutil.copyfileobj(response, download_file)
+            _LOGGER.debug("Downloading %s to %s", file_url, download_file_path)
+            with urlopen(_quote_url(file_url)) as response, open(
+                download_file_path, "wb"
+            ) as download_file:
+                shutil.copyfileobj(response, download_file)
 
-        _LOGGER.info("Downloaded %s (%s)", download_file_path, file_url)
+            _LOGGER.info("Downloaded %s (%s)", download_file_path, file_url)
+    except URLError:
+        # find_voice will fail down the line
+        _LOGGER.exception("Unexpected error while downloading files for %s", name)
 
 
 def find_voice(name: str, data_dirs: Iterable[Union[str, Path]]) -> Tuple[Path, Path]:

wyoming_piper/handler.py

@@ -8,6 +8,7 @@ import wave
 from typing import Any, Dict, Optional
 
 from wyoming.audio import AudioChunk, AudioStart, AudioStop
+from wyoming.error import Error
 from wyoming.event import Event
 from wyoming.info import Describe, Info
 from wyoming.server import AsyncEventHandler
@@ -43,6 +44,15 @@ class PiperEventHandler(AsyncEventHandler):
             _LOGGER.warning("Unexpected event: %s", event)
             return True
 
+        try:
+            return await self._handle_event(event)
+        except Exception as err:
+            await self.write_event(
+                Error(text=str(err), code=err.__class__.__name__).event()
+            )
+            raise err
+
+    async def _handle_event(self, event: Event) -> bool:
         synthesize = Synthesize.from_event(event)
         _LOGGER.debug(synthesize)