livekit-plugins-clova 1.0.0.dev4__tar.gz

livekit_plugins_clova-1.0.0.dev4/.gitignore

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

livekit_plugins_clova-1.0.0.dev4/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-clova
+Version: 1.0.0.dev4
+Summary: LiveKit Agents Plugin for LINE Clova STT
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: LiveKit <support@livekit.io>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,video,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>=1.0.0.dev4
+Description-Content-Type: text/markdown
+
+# LiveKit Plugins Clova
+
+Agent Framework plugin for speech-to-text with [Clova](https://api.ncloud-docs.com/docs/)'s API. Currently supports speech-to-text.
+
+## Installation
+
+```bash
+pip install livekit-plugins-clova
+```
+
+## Pre-requisites
+
+You need invoke url and secret key from Naver cloud platform -> Clova Speech and set as environment variables: `CLOVA_STT_INVOKE_URL` & `CLOVA_STT_SECRET_KEY`

livekit_plugins_clova-1.0.0.dev4/README.md

@@ -0,0 +1,13 @@
+# LiveKit Plugins Clova
+
+Agent Framework plugin for speech-to-text with [Clova](https://api.ncloud-docs.com/docs/)'s API. Currently supports speech-to-text.
+
+## Installation
+
+```bash
+pip install livekit-plugins-clova
+```
+
+## Pre-requisites
+
+You need invoke url and secret key from Naver cloud platform -> Clova Speech and set as environment variables: `CLOVA_STT_INVOKE_URL` & `CLOVA_STT_SECRET_KEY`

livekit_plugins_clova-1.0.0.dev4/livekit/plugins/clova/__init__.py

@@ -0,0 +1,30 @@
+from .stt import STT
+from .version import __version__
+
+__all__ = [
+    "STT",
+    "__version__",
+]
+
+
+from livekit.agents import Plugin
+
+
+class ClovaSTTPlugin(Plugin):
+    def __init__(self):
+        super().__init__(__name__, __version__, __package__)
+
+    def download_files(self):
+        pass
+
+
+Plugin.register_plugin(ClovaSTTPlugin())
+
+# 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_clova-1.0.0.dev4/livekit/plugins/clova/common.py

@@ -0,0 +1,13 @@
+import io
+
+from pydub import AudioSegment
+
+
+def resample_audio(audio_bytes, original_sample_rate, target_sample_rate):
+    resampled_audio = AudioSegment.from_raw(
+        io.BytesIO(audio_bytes),
+        sample_width=2,
+        frame_rate=original_sample_rate,
+        channels=1,
+    ).set_frame_rate(target_sample_rate)
+    return resampled_audio.raw_data

livekit_plugins_clova-1.0.0.dev4/livekit/plugins/clova/constants.py

@@ -0,0 +1,2 @@
+CLOVA_INPUT_SAMPLE_RATE = 16000
+LIVEKIT_INPUT_SAMPLE_RATE = 48000

livekit_plugins_clova-1.0.0.dev4/livekit/plugins/clova/log.py

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

livekit_plugins_clova-1.0.0.dev4/livekit/plugins/clova/models.py

@@ -0,0 +1,15 @@
+from typing import Literal
+
+ClovaSttLanguages = Literal["ko-KR", "en-US", "enko", "ja", "zh-cn", "zh-tw"]
+
+ClovaSpeechAPIType = Literal["recognizer/object-storage", "recognizer/url", "recognizer/upload"]
+
+clova_languages_mapping = {
+    "en": "en-US",
+    "ko-KR": "ko-KR",
+    "en-US": "en-US",
+    "enko": "enko",
+    "ja": "ja",
+    "zh-cn": "zh-cn",
+    "zh-tw": "zh-tw",
+}

livekit_plugins_clova-1.0.0.dev4/livekit/plugins/clova/stt.py

@@ -0,0 +1,145 @@
+# 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 io
+import json
+import os
+import time
+import wave
+
+import aiohttp
+
+from livekit.agents import APIConnectOptions, APIStatusError, APITimeoutError, stt, utils
+from livekit.agents.stt import SpeechEventType, STTCapabilities
+from livekit.agents.utils import AudioBuffer, merge_frames
+from livekit.plugins.clova.constants import CLOVA_INPUT_SAMPLE_RATE
+
+from .common import resample_audio
+from .log import logger
+from .models import ClovaSpeechAPIType, ClovaSttLanguages, clova_languages_mapping
+
+
+class STT(stt.STT):
+    def __init__(
+        self,
+        *,
+        language: ClovaSttLanguages = "en-US",
+        secret: str | None = None,
+        invoke_url: str | None = None,
+        http_session: aiohttp.ClientSession | None = None,
+        threshold: float = 0.5,
+    ):
+        """
+        Create a new instance of Clova STT.
+
+        ``secret`` and ``invoke_url`` must be set, either using arguments or by setting the
+        ``CLOVA_STT_SECRET_KEY`` and ``CLOVA_STT_INVOKE_URL`` environmental variables, respectively.
+        """
+
+        super().__init__(capabilities=STTCapabilities(streaming=False, interim_results=True))
+        self._secret = secret or os.environ.get("CLOVA_STT_SECRET_KEY")
+        self._invoke_url = invoke_url or os.environ.get("CLOVA_STT_INVOKE_URL")
+        self._language = clova_languages_mapping.get(language, language)
+        self._session = http_session
+        if self._secret is None:
+            raise ValueError(
+                "Clova STT secret key is required. It should be set with env CLOVA_STT_SECRET_KEY"
+            )
+        self.threshold = threshold
+
+    def update_options(self, *, language: str | None = None) -> None:
+        self._language = clova_languages_mapping.get(language, language) or self._language
+
+    def _ensure_session(self) -> aiohttp.ClientSession:
+        if not self._session:
+            self._session = utils.http_context.http_session()
+        return self._session
+
+    def url_builder(self, process_method: ClovaSpeechAPIType = "recognizer/upload") -> str:
+        return f"{self._invoke_url}/{process_method}"
+
+    async def _recognize_impl(
+        self,
+        buffer: AudioBuffer,
+        *,
+        language: ClovaSttLanguages | str | None,
+        conn_options: APIConnectOptions,
+    ) -> stt.SpeechEvent:
+        try:
+            url = self.url_builder()
+            payload = json.dumps({"language": self._language, "completion": "sync"})
+
+            buffer = merge_frames(buffer)
+            buffer_bytes = resample_audio(
+                buffer.data.tobytes(), buffer.sample_rate, CLOVA_INPUT_SAMPLE_RATE
+            )
+
+            io_buffer = io.BytesIO()
+            with wave.open(io_buffer, "wb") as wav:
+                wav.setnchannels(1)
+                wav.setsampwidth(2)  # 16-bit
+                wav.setframerate(CLOVA_INPUT_SAMPLE_RATE)
+                wav.writeframes(buffer_bytes)
+            io_buffer.seek(0)
+
+            headers = {"X-CLOVASPEECH-API-KEY": self._secret}
+            form_data = aiohttp.FormData()
+            form_data.add_field("params", payload)
+            form_data.add_field("media", io_buffer, filename="audio.wav", content_type="audio/wav")
+            start = time.time()
+            async with self._ensure_session().post(
+                url,
+                data=form_data,
+                headers=headers,
+                timeout=aiohttp.ClientTimeout(
+                    total=30,
+                    sock_connect=conn_options.timeout,
+                ),
+            ) as response:
+                response_data = await response.json()
+                end = time.time()
+                text = response_data.get("text")
+                confidence = response_data.get("confidence")
+                logger.info(f"{text} | {confidence} | total_seconds: {end - start}")
+                if not text or "error" in response_data:
+                    raise ValueError(f"Unexpected response: {response_data}")
+                if confidence < self.threshold:
+                    raise ValueError(
+                        f"Confidence: {confidence} is bellow threshold {self.threshold}. Skipping."
+                    )
+                logger.info(f"final event: {response_data}")
+                return self._transcription_to_speech_event(text=text)
+
+        except asyncio.TimeoutError as e:
+            raise APITimeoutError() from e
+        except aiohttp.ClientResponseError as e:
+            raise APIStatusError(
+                message=e.message,
+                status_code=e.status,
+                request_id=None,
+                body=None,
+            ) from e
+
+    def _transcription_to_speech_event(
+        self,
+        event_type: SpeechEventType = stt.SpeechEventType.INTERIM_TRANSCRIPT,
+        text: str | None = None,
+    ) -> stt.SpeechEvent:
+        return stt.SpeechEvent(
+            type=event_type,
+            alternatives=[stt.SpeechData(text=text, language=self._language)],
+        )

livekit_plugins_clova-1.0.0.dev4/livekit/plugins/clova/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.0.0.dev4"

livekit_plugins_clova-1.0.0.dev4/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-clova"
+dynamic = ["version"]
+description = "LiveKit Agents Plugin for LINE Clova STT"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.9.0"
+authors = [{ name = "LiveKit", email = "support@livekit.io" }]
+keywords = ["webrtc", "realtime", "audio", "video", "livekit"]
+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>=1.0.0.dev4"]
+
+[project.urls]
+Documentation = "https://docs.livekit.io"
+Website = "https://livekit.io/"
+Source = "https://github.com/livekit/agents"
+
+[tool.hatch.version]
+path = "livekit/plugins/clova/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]