livekit-plugins-spitch 1.4.0rc1__tar.gz

livekit_plugins_spitch-1.4.0rc1/.gitignore

@@ -0,0 +1,179 @@
+**/.vscode
+**/.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# trunk
+.trunk/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+node_modules
+
+credentials.json
+pyrightconfig.json
+docs/
+
+# Database files
+*.db
+
+
+# Examples for development
+examples/dev/*

livekit_plugins_spitch-1.4.0rc1/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-spitch
+Version: 1.4.0rc1
+Summary: spitch plugin template for LiveKit Agents
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Author: LiveKit
+License-Expression: Apache-2.0
+Keywords: ai,audio,livekit,realtime,video,voice,webrtc
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9.0
+Requires-Dist: livekit-agents[codecs]>=1.4.0.rc1
+Requires-Dist: spitch
+Description-Content-Type: text/markdown
+
+# Spitch plugin for LiveKit Agents
+
+Support for [Spitch](https://spitch.app/)'s African-language voice AI services in LiveKit Agents.
+
+More information is available in the docs for the [STT](https://docs.livekit.io/agents/integrations/stt/spitch/) and [TTS](https://docs.livekit.io/agents/integrations/tts/spitch/) integrations.
+
+## Installation
+
+```bash
+pip install livekit-plugins-spitch
+```
+
+## Pre-requisites
+
+You'll need an API key from Spitch. It can be set as an environment variable: `SPITCH_API_KEY`

livekit_plugins_spitch-1.4.0rc1/README.md

@@ -0,0 +1,15 @@
+# Spitch plugin for LiveKit Agents
+
+Support for [Spitch](https://spitch.app/)'s African-language voice AI services in LiveKit Agents.
+
+More information is available in the docs for the [STT](https://docs.livekit.io/agents/integrations/stt/spitch/) and [TTS](https://docs.livekit.io/agents/integrations/tts/spitch/) integrations.
+
+## Installation
+
+```bash
+pip install livekit-plugins-spitch
+```
+
+## Pre-requisites
+
+You'll need an API key from Spitch. It can be set as an environment variable: `SPITCH_API_KEY`

livekit_plugins_spitch-1.4.0rc1/livekit/plugins/spitch/__init__.py

@@ -0,0 +1,41 @@
+# Copyright 2023 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Spitch plugin for LiveKit Agents"""
+
+from .stt import STT
+from .tts import TTS
+from .version import __version__
+
+__all__ = ["STT", "TTS", "__version__"]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class SpitchPlugin(Plugin):
+    def __init__(self):
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(SpitchPlugin())
+
+_module = dir()
+NOT_IN_ALL = [m for m in _module if m not in __all__]
+
+__pdoc__ = {}
+
+for n in NOT_IN_ALL:
+    __pdoc__[n] = False

livekit_plugins_spitch-1.4.0rc1/livekit/plugins/spitch/log.py

@@ -0,0 +1,3 @@
+import logging
+
+logger = logging.getLogger("livekit.plugins.spitch")

livekit_plugins_spitch-1.4.0rc1/livekit/plugins/spitch/stt.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+import dataclasses
+from dataclasses import dataclass
+
+import httpx
+
+import spitch
+from livekit import rtc
+from livekit.agents import (
+    NOT_GIVEN,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    APITimeoutError,
+    NotGivenOr,
+)
+from livekit.agents.stt import stt
+from livekit.agents.utils import AudioBuffer
+from livekit.agents.voice.io import TimedString
+from spitch import AsyncSpitch
+
+
+@dataclass
+class _STTOptions:
+    language: str
+
+
+class STT(stt.STT):
+    def __init__(self, *, language: str = "en") -> None:
+        super().__init__(
+            capabilities=stt.STTCapabilities(
+                streaming=False,
+                interim_results=False,
+                # word timestamps don't seem to work despite the docs saying they do
+                aligned_transcript=False,
+            )
+        )
+
+        self._opts = _STTOptions(language=language)
+        self._client = AsyncSpitch()
+
+    @property
+    def model(self) -> str:
+        return "unknown"
+
+    @property
+    def provider(self) -> str:
+        return "Spitch"
+
+    def update_options(self, language: str) -> None:
+        self._opts.language = language or self._opts.language
+
+    def _sanitize_options(self, *, language: str | None = None) -> _STTOptions:
+        config = dataclasses.replace(self._opts)
+        config.language = language or config.language
+        return config
+
+    async def _recognize_impl(
+        self,
+        buffer: AudioBuffer,
+        *,
+        language: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions,
+    ) -> stt.SpeechEvent:
+        try:
+            config = self._sanitize_options(language=language or None)
+            data = rtc.combine_audio_frames(buffer).to_wav_bytes()
+            model = "mansa_v1" if config.language == "en" else "legacy"
+            resp = await self._client.speech.transcribe(
+                language=config.language,  # type: ignore
+                content=data,
+                timeout=httpx.Timeout(30, connect=conn_options.timeout),
+                timestamp="word" if "mansa" in model else None,
+            )
+
+            return stt.SpeechEvent(
+                type=stt.SpeechEventType.FINAL_TRANSCRIPT,
+                alternatives=[
+                    stt.SpeechData(
+                        text=resp.text or "",
+                        language=config.language or "",
+                        start_time=resp.segments[0].start
+                        if resp.segments and resp.segments[0]
+                        else 0,
+                        end_time=resp.segments[-1].end
+                        if resp.segments and resp.segments[-1]
+                        else 0,
+                        words=[
+                            TimedString(
+                                text=segment.text,
+                                start_time=segment.start,
+                                end_time=segment.end,
+                            )
+                            for segment in resp.segments
+                        ]
+                        if resp.segments
+                        else None,
+                    ),
+                ],
+            )
+        except spitch.APITimeoutError as e:
+            raise APITimeoutError() from e
+        except spitch.APIStatusError as e:
+            raise APIStatusError(e.message, status_code=e.status_code, body=e.body) from e
+        except Exception as e:
+            raise APIConnectionError() from e

livekit_plugins_spitch-1.4.0rc1/livekit/plugins/spitch/tts.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+import uuid
+from dataclasses import dataclass
+
+import httpx
+
+import spitch
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    APITimeoutError,
+    tts,
+)
+from spitch import AsyncSpitch
+
+SAMPLE_RATE = 24_000
+NUM_CHANNELS = 1
+MIME_TYPE = "audio/mpeg"
+
+
+@dataclass
+class _TTSOptions:
+    language: str
+    voice: str
+
+
+class TTS(tts.TTS):
+    def __init__(self, *, language: str = "en", voice: str = "lina"):
+        super().__init__(
+            capabilities=tts.TTSCapabilities(streaming=False), sample_rate=24_000, num_channels=1
+        )
+
+        self._opts = _TTSOptions(language=language, voice=voice)
+        self._client = AsyncSpitch()
+
+    @property
+    def model(self) -> str:
+        return "unknown"
+
+    @property
+    def provider(self) -> str:
+        return "Spitch"
+
+    def synthesize(
+        self,
+        text: str,
+        *,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> ChunkedStream:
+        return ChunkedStream(
+            tts=self,
+            input_text=text,
+            conn_options=conn_options,
+            opts=self._opts,
+            client=self._client,
+        )
+
+
+class ChunkedStream(tts.ChunkedStream):
+    def __init__(
+        self,
+        *,
+        tts: TTS,
+        input_text: str,
+        conn_options: APIConnectOptions,
+        opts: _TTSOptions,
+        client: AsyncSpitch,
+    ) -> None:
+        super().__init__(tts=tts, input_text=input_text, conn_options=conn_options)
+        self._client = client
+        self._opts = opts
+
+    async def _run(self, output_emitter: tts.AudioEmitter) -> None:
+        spitch_stream = self._client.speech.with_streaming_response.generate(
+            text=self.input_text,
+            language=self._opts.language,  # type: ignore
+            voice=self._opts.voice,  # type: ignore
+            format="mp3",
+            timeout=httpx.Timeout(30, connect=self._conn_options.timeout),
+        )
+
+        request_id = str(uuid.uuid4().hex)[:12]
+        try:
+            async with spitch_stream as stream:
+                output_emitter.initialize(
+                    request_id=request_id,
+                    sample_rate=SAMPLE_RATE,
+                    num_channels=NUM_CHANNELS,
+                    mime_type=MIME_TYPE,
+                )
+
+                async for data in stream.iter_bytes():
+                    output_emitter.push(data)
+
+            output_emitter.flush()
+
+        except spitch.APITimeoutError:
+            raise APITimeoutError() from None
+        except spitch.APIStatusError as e:
+            raise APIStatusError(
+                e.message, status_code=e.status_code, request_id=request_id, body=e.body
+            ) from None
+        except Exception as e:
+            raise APIConnectionError() from e

livekit_plugins_spitch-1.4.0rc1/livekit/plugins/spitch/version.py

@@ -0,0 +1,15 @@
+# Copyright 2023 LiveKit, Inc.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = "1.4.0.rc1"

livekit_plugins_spitch-1.4.0rc1/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-spitch"
+dynamic = ["version"]
+description = "spitch plugin template for LiveKit Agents"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.9.0"
+authors = [{ name = "LiveKit" }]
+keywords = ["voice", "ai", "realtime", "audio", "video", "livekit", "webrtc"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = ["livekit-agents[codecs]>=1.4.0.rc1", "spitch"]
+
+[project.urls]
+Documentation = "https://docs.livekit.io"
+Website = "https://livekit.io/"
+Source = "https://github.com/livekit/agents"
+
+[tool.hatch.version]
+path = "livekit/plugins/spitch/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]