livekit-plugins-lmnt 1.1.0__tar.gz

livekit_plugins_lmnt-1.1.0/.gitignore

@@ -0,0 +1,172 @@
+**/.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/

livekit_plugins_lmnt-1.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-lmnt
+Version: 1.1.0
+Summary: LMNT TTS plugin 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-email: LiveKit <hello@livekit.io>
+License-Expression: Apache-2.0
+Keywords: LMNT,TTS,audio,livekit,realtime,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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9.0
+Requires-Dist: livekit-agents>=1.1.0
+Description-Content-Type: text/markdown
+
+# LLMNT plugin for LiveKit Agents
+
+Support for voice synthesis with [LMNT](https://app.lmnt.com/).
+
+See [https://docs.livekit.io/agents/integrations/tts/lmnt/]https://docs.livekit.io/agents/integrations/tts/lmnt/ for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-lmnt
+```
+
+## Pre-requisites
+
+You'll need an API key from LMNT. It can be set as an environment variable: `LMNT_API_KEY`. You can get it from [here](https://app.lmnt.com/account#api-keys)

livekit_plugins_lmnt-1.1.0/README.md

@@ -0,0 +1,15 @@
+# LLMNT plugin for LiveKit Agents
+
+Support for voice synthesis with [LMNT](https://app.lmnt.com/).
+
+See [https://docs.livekit.io/agents/integrations/tts/lmnt/]https://docs.livekit.io/agents/integrations/tts/lmnt/ for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-lmnt
+```
+
+## Pre-requisites
+
+You'll need an API key from LMNT. It can be set as an environment variable: `LMNT_API_KEY`. You can get it from [here](https://app.lmnt.com/account#api-keys)

livekit_plugins_lmnt-1.1.0/livekit/plugins/lmnt/__init__.py

@@ -0,0 +1,42 @@
+# 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.
+
+"""LMNT plugin for LiveKit Agents
+
+See https://docs.livekit.io/agents/integrations/tts/lmnt/ for more information.
+"""
+
+from .tts import TTS, ChunkedStream
+from .version import __version__
+
+__all__ = ["TTS", "ChunkedStream", "__version__"]
+
+from livekit.agents import Plugin
+
+
+class LMNTPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__)
+
+
+Plugin.register_plugin(LMNTPlugin())
+
+# Cleanup docs of unexported modules
+_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_lmnt-1.1.0/livekit/plugins/lmnt/models.py

@@ -0,0 +1,27 @@
+from typing import Literal
+
+LMNTAudioFormats = Literal["aac", "mp3", "mulaw", "raw", "wav"]
+LMNTLanguages = Literal[
+    "auto",
+    "de",
+    "en",
+    "es",
+    "fr",
+    "hi",
+    "id",
+    "it",
+    "ja",
+    "ko",
+    "nl",
+    "pl",
+    "pt",
+    "ru",
+    "sv",
+    "th",
+    "tr",
+    "uk",
+    "vi",
+    "zh",
+]
+LMNTModels = Literal["blizzard", "aurora"]
+LMNTSampleRate = Literal[8000, 16000, 24000]

livekit_plugins_lmnt-1.1.0/livekit/plugins/lmnt/tts.py

@@ -0,0 +1,255 @@
+# 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.
+from __future__ import annotations
+
+import asyncio
+import os
+from dataclasses import dataclass, replace
+from typing import Final
+
+import aiohttp
+
+from livekit.agents import (
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    APITimeoutError,
+    tts,
+    utils,
+)
+from livekit.agents.types import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    NotGivenOr,
+)
+from livekit.agents.utils import is_given
+
+from .models import LMNTAudioFormats, LMNTLanguages, LMNTModels, LMNTSampleRate
+
+LMNT_BASE_URL: Final[str] = "https://api.lmnt.com/v1/ai/speech/bytes"
+NUM_CHANNELS: Final[int] = 1
+MIME_TYPE: dict[str, str] = {
+    "aac": "audio/aac",
+    "mp3": "audio/mpeg",
+    "mulaw": "audio/basic",
+    "raw": "application/octet-stream",
+    "wav": "audio/wav",
+}
+
+
+@dataclass
+class _TTSOptions:
+    sample_rate: LMNTSampleRate
+    model: LMNTModels
+    format: LMNTAudioFormats
+    language: LMNTLanguages
+    num_channels: int
+    voice: str
+    api_key: str
+    temperature: float
+    top_p: float
+
+
+class TTS(tts.TTS):
+    """
+    Text-to-Speech (TTS) plugin for LMNT.
+    """
+
+    def __init__(
+        self,
+        *,
+        model: LMNTModels = "blizzard",
+        voice: str = "leah",
+        language: LMNTLanguages | None = None,
+        format: LMNTAudioFormats = "mp3",
+        sample_rate: LMNTSampleRate = 24000,
+        api_key: str | None = None,
+        http_session: aiohttp.ClientSession | None = None,
+        temperature: float = 1.0,
+        top_p: float = 0.8,
+    ) -> None:
+        """
+        Create a new instance of LMNT TTS.
+
+        See: https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes
+
+        Args:
+            model: The model to use for synthesis. Default is "blizzard".
+                Learn more at: https://docs.lmnt.com/guides/models
+            voice: The voice ID to use. Default is "leah". Find more amazing voices at https://app.lmnt.com/
+            language: Two-letter ISO 639-1 language code. Defaults to None.
+                See: https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes#body-language
+            format: Output file format. Options: aac, mp3, mulaw, raw, wav. Default is "mp3".
+            sample_rate: Output sample rate in Hz. Default is 24000.
+                See: https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes#body-sample-rate
+            api_key: API key for authentication. Defaults to the LMNT_API_KEY environment variable.
+            http_session: Optional aiohttp ClientSession. A new session is created if not provided.
+            temperature: Influences how expressive and emotionally varied the speech becomes.
+                Lower values (like 0.3) create more neutral, consistent speaking styles.
+                Higher values (like 1.0) allow for more dynamic emotional range and speaking styles.
+                Default is 1.0.
+            top_p: Controls the stability of the generated speech.
+                A lower value (like 0.3) produces more consistent, reliable speech.
+                A higher value (like 0.9) gives more flexibility in how words are spoken,
+                but might occasionally produce unusual intonations or speech patterns.
+                Default is 0.8.
+        """
+        super().__init__(
+            capabilities=tts.TTSCapabilities(streaming=False),
+            sample_rate=sample_rate,
+            num_channels=NUM_CHANNELS,
+        )
+        api_key = api_key or os.environ.get("LMNT_API_KEY")
+        if not api_key:
+            raise ValueError(
+                "LMNT API key is required. "
+                "Set it via environment variable or pass it as an argument."
+            )
+
+        if not language:
+            language = "auto" if model == "blizzard" else "en"
+
+        self._opts = _TTSOptions(
+            model=model,
+            sample_rate=sample_rate,
+            num_channels=NUM_CHANNELS,
+            language=language,
+            voice=voice,
+            format=format,
+            api_key=api_key,
+            temperature=temperature,
+            top_p=top_p,
+        )
+
+        self._session = http_session
+
+    def synthesize(
+        self,
+        text: str,
+        *,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> ChunkedStream:
+        return ChunkedStream(
+            tts=self,
+            input_text=text,
+            conn_options=conn_options,
+        )
+
+    def update_options(
+        self,
+        *,
+        model: NotGivenOr[LMNTModels] = NOT_GIVEN,
+        voice: NotGivenOr[str] = NOT_GIVEN,
+        language: NotGivenOr[LMNTLanguages] = NOT_GIVEN,
+        format: NotGivenOr[LMNTAudioFormats] = NOT_GIVEN,
+        sample_rate: NotGivenOr[LMNTSampleRate] = NOT_GIVEN,
+        temperature: NotGivenOr[float] = NOT_GIVEN,
+        top_p: NotGivenOr[float] = NOT_GIVEN,
+    ) -> None:
+        """
+        Update the TTS options.
+
+        Args:
+            model: The model to use for synthesis. Learn more at: https://docs.lmnt.com/guides/models
+            voice: The voice ID to update.
+            language: Two-letter ISO 639-1 code.
+                See: https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes#body-language
+            format: Audio output format. Options: aac, mp3, mulaw, raw, wav.
+            sample_rate: Output sample rate in Hz.
+            temperature: Controls the expressiveness of the speech. A number between 0.0 and 1.0.
+            top_p: Controls the stability of the generated speech. A number between 0.0 and 1.0.
+        """
+        if is_given(model):
+            self._opts.model = model
+        if is_given(voice):
+            self._opts.voice = voice
+        if is_given(language):
+            self._opts.language = language
+        if is_given(format):
+            self._opts.format = format
+        if is_given(sample_rate):
+            self._opts.sample_rate = sample_rate
+        if is_given(temperature):
+            self._opts.temperature = temperature
+        if is_given(top_p):
+            self._opts.top_p = top_p
+
+    def _ensure_session(self) -> aiohttp.ClientSession:
+        if not self._session:
+            self._session = utils.http_context.http_session()
+
+        return self._session
+
+
+class ChunkedStream(tts.ChunkedStream):
+    """Synthesize text to speech in chunks."""
+
+    def __init__(
+        self,
+        *,
+        tts: TTS,
+        input_text: str,
+        conn_options: APIConnectOptions,
+    ) -> None:
+        super().__init__(tts=tts, input_text=input_text, conn_options=conn_options)
+        self._tts = tts
+        self._opts = replace(tts._opts)
+
+    async def _run(self, output_emitter: tts.AudioEmitter) -> None:
+        data = {
+            "text": self._input_text,
+            "voice": self._opts.voice,
+            "language": self._opts.language,
+            "sample_rate": self._opts.sample_rate,
+            "model": self._opts.model,
+            "format": self._opts.format,
+            "temperature": self._opts.temperature,
+            "top_p": self._opts.top_p,
+        }
+
+        try:
+            async with self._tts._ensure_session().post(
+                LMNT_BASE_URL,
+                headers={
+                    "Content-Type": "application/json",
+                    "X-API-Key": self._opts.api_key,
+                },
+                json=data,
+                timeout=aiohttp.ClientTimeout(
+                    total=30,
+                    sock_connect=self._conn_options.timeout,
+                ),
+            ) as resp:
+                resp.raise_for_status()
+                output_emitter.initialize(
+                    request_id=utils.shortuuid(),
+                    sample_rate=self._opts.sample_rate,
+                    num_channels=NUM_CHANNELS,
+                    mime_type=MIME_TYPE[self._opts.format],
+                )
+                async for data, _ in resp.content.iter_chunks():
+                    output_emitter.push(data)
+
+                output_emitter.flush()
+        except asyncio.TimeoutError:
+            raise APITimeoutError() from None
+        except aiohttp.ClientResponseError as e:
+            raise APIStatusError(
+                message=e.message,
+                status_code=e.status,
+                request_id=None,
+                body=None,
+            ) from None
+        except Exception as e:
+            raise APIConnectionError() from e

livekit_plugins_lmnt-1.1.0/livekit/plugins/lmnt/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.1.0"

livekit_plugins_lmnt-1.1.0/pyproject.toml

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