wyoming-piper 1.3.2__tar.gz → 1.5.3__tar.gz

wyoming_piper-1.5.3/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Michael Hansen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wyoming_piper-1.5.3/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: wyoming-piper
+Version: 1.5.3
+Summary: Wyoming Server for Piper
+Author-email: Michael Hansen <mike@rhasspy.org>
+License: MIT
+Project-URL: Homepage, http://github.com/rhasspy/wyoming-piper
+Keywords: rhasspy,wyoming,piper,tts
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: <3.13,>=3.8.1
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: wyoming>=1.5.3
+Provides-Extra: dev
+Requires-Dist: black==22.12.0; extra == "dev"
+Requires-Dist: flake8==6.0.0; extra == "dev"
+Requires-Dist: isort==5.11.3; extra == "dev"
+Requires-Dist: mypy==0.991; extra == "dev"
+Requires-Dist: pylint==2.15.9; extra == "dev"
+Requires-Dist: pytest==7.4.4; extra == "dev"
+Requires-Dist: pytest-asyncio==0.23.3; extra == "dev"
+Requires-Dist: build==1.2.2.post1; extra == "dev"
+Requires-Dist: scipy<2,>=1.10; extra == "dev"
+Requires-Dist: numpy<2,>=1.20; extra == "dev"
+Requires-Dist: python-speech-features==0.6; extra == "dev"
+Dynamic: license-file
+
+# Wyoming Piper
+
+[Wyoming protocol](https://github.com/rhasspy/wyoming) server for the [Piper](https://github.com/rhasspy/piper/) text to speech system.
+
+## Home Assistant Add-on
+
+[![Show add-on](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_piper)
+
+[Source](https://github.com/home-assistant/addons/tree/master/piper)
+
+## Local Install
+
+Clone the repository and set up Python virtual environment:
+
+``` sh
+git clone https://github.com/rhasspy/wyoming-piper.git
+cd wyoming-piper
+script/setup
+```
+
+Install Piper
+```sh
+curl -L -s "https://github.com/rhasspy/piper/releases/download/v1.2.0/piper_amd64.tar.gz" | tar -zxvf - -C /usr/share
+```
+
+Run a server that anyone can connect to:
+
+``` sh
+script/run --piper '/usr/share/piper/piper' --voice en_US-lessac-medium --uri 'tcp://0.0.0.0:10200' --data-dir /data --download-dir /data 
+```
+
+## Docker Image
+
+``` sh
+docker run -it -p 10200:10200 -v /path/to/local/data:/data rhasspy/wyoming-piper \
+    --voice en_US-lessac-medium
+```
+
+[Source](https://github.com/rhasspy/wyoming-addons/tree/master/piper)

wyoming_piper-1.5.3/README.md

@@ -0,0 +1,39 @@
+# Wyoming Piper
+
+[Wyoming protocol](https://github.com/rhasspy/wyoming) server for the [Piper](https://github.com/rhasspy/piper/) text to speech system.
+
+## Home Assistant Add-on
+
+[![Show add-on](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_piper)
+
+[Source](https://github.com/home-assistant/addons/tree/master/piper)
+
+## Local Install
+
+Clone the repository and set up Python virtual environment:
+
+``` sh
+git clone https://github.com/rhasspy/wyoming-piper.git
+cd wyoming-piper
+script/setup
+```
+
+Install Piper
+```sh
+curl -L -s "https://github.com/rhasspy/piper/releases/download/v1.2.0/piper_amd64.tar.gz" | tar -zxvf - -C /usr/share
+```
+
+Run a server that anyone can connect to:
+
+``` sh
+script/run --piper '/usr/share/piper/piper' --voice en_US-lessac-medium --uri 'tcp://0.0.0.0:10200' --data-dir /data --download-dir /data 
+```
+
+## Docker Image
+
+``` sh
+docker run -it -p 10200:10200 -v /path/to/local/data:/data rhasspy/wyoming-piper \
+    --voice en_US-lessac-medium
+```
+
+[Source](https://github.com/rhasspy/wyoming-addons/tree/master/piper)

wyoming_piper-1.5.3/pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+name = "wyoming-piper"
+version = "1.5.3"
+description = "Wyoming Server for Piper"
+readme = "README.md"
+requires-python = ">=3.8.1,<3.13"
+license = {text = "MIT"}
+authors = [
+    {name = "Michael Hansen", email = "mike@rhasspy.org"}
+]
+keywords = ["rhasspy", "wyoming", "piper", "tts"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Text Processing :: Linguistic",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "wyoming>=1.5.3",
+]
+
+[project.urls]
+Homepage = "http://github.com/rhasspy/wyoming-piper"
+
+[project.scripts]
+wyoming-piper = "wyoming_piper.__main__:run"
+
+[tool.setuptools.packages.find]
+include = ["wyoming_piper"]
+exclude = ["tests", "tests.*"]
+
+[tool.setuptools.package-data]
+wyoming_piper = ["voices.json"]
+
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_untyped_defs = true
+
+[project.optional-dependencies]
+dev = [
+    "black==22.12.0",
+    "flake8==6.0.0",
+    "isort==5.11.3",
+    "mypy==0.991",
+    "pylint==2.15.9",
+    "pytest==7.4.4",
+    "pytest-asyncio==0.23.3",
+    "build==1.2.2.post1",
+    "scipy>=1.10,<2",
+    "numpy>=1.20,<2",
+    "python-speech-features==0.6",
+]

wyoming_piper-1.5.3/setup.cfg

@@ -0,0 +1,21 @@
+[flake8]
+max-line-length = 88
+ignore = 
+	E501,
+	W503,
+	E203,
+	D202,
+	W504
+
+[isort]
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True
+line_length = 88
+indent = "    "
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

wyoming_piper-1.5.3/tests/test_piper.py

@@ -0,0 +1,123 @@
+"""Tests for wyoming-piper"""
+import asyncio
+import sys
+import tarfile
+import wave
+from asyncio.subprocess import PIPE
+from pathlib import Path
+from urllib.request import urlopen
+
+import numpy as np
+import pytest
+import python_speech_features
+from wyoming.audio import AudioChunk, AudioStart, AudioStop
+from wyoming.event import async_read_event, async_write_event
+from wyoming.info import Describe, Info
+from wyoming.tts import Synthesize, SynthesizeVoice
+
+from .dtw import compute_optimal_path
+
+_DIR = Path(__file__).parent
+_LOCAL_DIR = _DIR.parent / "local"
+_PIPER_URL = (
+    "https://github.com/rhasspy/piper/releases/download/v1.2.0/piper_amd64.tar.gz"
+)
+_TIMEOUT = 60
+
+
+def download_piper() -> None:
+    """Downloads a binary version of Piper."""
+    piper_path = _LOCAL_DIR / "piper"
+    if piper_path.exists():
+        return
+
+    _LOCAL_DIR.mkdir(parents=True, exist_ok=True)
+    with urlopen(_PIPER_URL) as response:
+        with tarfile.open(fileobj=response, mode="r|*") as piper_file:
+            piper_file.extractall(_LOCAL_DIR)
+
+
+@pytest.mark.asyncio
+async def test_piper() -> None:
+    download_piper()
+
+    proc = await asyncio.create_subprocess_exec(
+        sys.executable,
+        "-m",
+        "wyoming_piper",
+        "--uri",
+        "stdio://",
+        "--piper",
+        str(_LOCAL_DIR / "piper" / "piper"),
+        "--voice",
+        "en_US-ryan-low",
+        "--data-dir",
+        str(_LOCAL_DIR),
+        stdin=PIPE,
+        stdout=PIPE,
+    )
+    assert proc.stdin is not None
+    assert proc.stdout is not None
+
+    # Check info
+    await async_write_event(Describe().event(), proc.stdin)
+    while True:
+        event = await asyncio.wait_for(async_read_event(proc.stdout), timeout=_TIMEOUT)
+        assert event is not None
+
+        if not Info.is_type(event.type):
+            continue
+
+        info = Info.from_event(event)
+        assert len(info.tts) == 1, "Expected one tts service"
+        tts = info.tts[0]
+        assert len(tts.voices) > 0, "Expected at least one voice"
+        voice_model = next((v for v in tts.voices if v.name == "en_US-ryan-low"), None)
+        assert voice_model is not None, "Expected ryan voice"
+        break
+
+    # Synthesize text
+    await async_write_event(
+        Synthesize("This is a test.", voice=SynthesizeVoice("en_US-ryan-low")).event(),
+        proc.stdin,
+    )
+
+    event = await asyncio.wait_for(async_read_event(proc.stdout), timeout=_TIMEOUT)
+    assert event is not None
+    assert AudioStart.is_type(event.type)
+    audio_start = AudioStart.from_event(event)
+
+    with wave.open(str(_DIR / "this_is_a_test.wav"), "rb") as wav_file:
+        assert audio_start.rate == wav_file.getframerate()
+        assert audio_start.width == wav_file.getsampwidth()
+        assert audio_start.channels == wav_file.getnchannels()
+        expected_audio = wav_file.readframes(wav_file.getnframes())
+        expected_array = np.frombuffer(expected_audio, dtype=np.int16)
+
+    actual_audio = bytes()
+    while True:
+        event = await asyncio.wait_for(async_read_event(proc.stdout), timeout=_TIMEOUT)
+        assert event is not None
+        if AudioStop.is_type(event.type):
+            break
+
+        if AudioChunk.is_type(event.type):
+            chunk = AudioChunk.from_event(event)
+            assert chunk.rate == audio_start.rate
+            assert chunk.width == audio_start.width
+            assert chunk.channels == audio_start.channels
+            actual_audio += chunk.audio
+
+    actual_array = np.frombuffer(actual_audio, dtype=np.int16)
+
+    # Less than 20% difference in length
+    assert (
+        abs(len(actual_array) - len(expected_array))
+        / max(len(actual_array), len(expected_array))
+        < 0.2
+    )
+
+    # Compute dynamic time warping (DTW) distance of MFCC features
+    expected_mfcc = python_speech_features.mfcc(expected_array, winstep=0.02)
+    actual_mfcc = python_speech_features.mfcc(actual_array, winstep=0.02)
+    assert compute_optimal_path(actual_mfcc, expected_mfcc) < 10

wyoming_piper-1.5.3/wyoming_piper/__init__.py

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

{wyoming_piper-1.3.2 → wyoming_piper-1.5.3}/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-1.3.2 → wyoming_piper-1.5.3}/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-1.3.2 → wyoming_piper-1.5.3}/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)