livekit-plugins-avatartalk 1.0.1__tar.gz

livekit_plugins_avatartalk-1.0.1/.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_avatartalk-1.0.1/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-avatartalk
+Version: 1.0.1
+Summary: Agent Framework plugin for AvatarTalk
+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: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+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.3.1
+Description-Content-Type: text/markdown
+
+# AvatarTalk virtual avatar plugin for LiveKit Agents
+
+Support for the [AvatarTalk](https://avatartalk.ai/) virtual avatar.
+
+See [https://docs.livekit.io/agents/integrations/avatar/avatartalk/](https://docs.livekit.io/agents/integrations/avatar/avatartalk/) for more information.
+

livekit_plugins_avatartalk-1.0.1/README.md

@@ -0,0 +1,6 @@
+# AvatarTalk virtual avatar plugin for LiveKit Agents
+
+Support for the [AvatarTalk](https://avatartalk.ai/) virtual avatar.
+
+See [https://docs.livekit.io/agents/integrations/avatar/avatartalk/](https://docs.livekit.io/agents/integrations/avatar/avatartalk/) for more information.
+

livekit_plugins_avatartalk-1.0.1/livekit/plugins/avatartalk/__init__.py

@@ -0,0 +1,40 @@
+# Copyright 2025 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.
+
+"""AvatarTalk virtual avatar plugin for LiveKit Agents
+
+See https://docs.livekit.io/agents/integrations/avatar/avatartalk/ for more information.
+"""
+
+from .api import AvatarTalkException
+from .avatar import AvatarSession
+from .version import __version__
+
+__all__ = [
+    "AvatarTalkException",
+    "AvatarSession",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class AvatarTalkPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(AvatarTalkPlugin())

livekit_plugins_avatartalk-1.0.1/livekit/plugins/avatartalk/api.py

@@ -0,0 +1,68 @@
+import logging
+import os
+from typing import Any
+
+import aiohttp
+
+from livekit.agents import NOT_GIVEN, NotGivenOr
+
+logger = logging.getLogger(__name__)
+
+DEFAULT_API_URL = "https://api.avatartalk.ai"
+
+
+class AvatarTalkException(Exception):
+    """Exception for AvatarTalkAPI errors"""
+
+
+class AvatarTalkAPI:
+    def __init__(
+        self,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+    ):
+        self._api_url = api_url or DEFAULT_API_URL
+        avatartalk_api_key = api_key or os.getenv("AVATARTALK_API_KEY")
+        if avatartalk_api_key is None:
+            raise AvatarTalkException("AVATARTALK_API_KEY must be set")
+
+        self._api_key = avatartalk_api_key
+        self._headers = {"Authorization": f"Bearer {self._api_key}"}
+
+    async def _request(self, method: str, path: str, **kwargs):
+        async with aiohttp.ClientSession() as session:
+            async with session.request(
+                method, f"{self._api_url}{path}", headers=self._headers, **kwargs
+            ) as response:
+                if response.ok:
+                    return await response.json()
+                else:
+                    r = await response.json()
+                    raise AvatarTalkException(f"API request failed: {response.status} {r}")
+
+    async def start_session(
+        self,
+        livekit_url: str,
+        avatar: str,
+        emotion: str,
+        room_name: str,
+        livekit_listener_token: str,
+        livekit_room_token: str,
+        agent_identity: str,
+    ) -> dict[str, Any]:
+        return await self._request(
+            "POST",
+            "/livekit/create-session",
+            json={
+                "livekit_url": livekit_url,
+                "avatar": avatar,
+                "emotion": emotion,
+                "room_name": room_name,
+                "room_token": livekit_room_token,
+                "listener_token": livekit_listener_token,
+                "agent_identity": agent_identity,
+            },
+        )
+
+    async def stop_session(self, task_id: str) -> dict[str, Any]:
+        return await self._request("DELETE", f"/livekit/delete-session/{task_id}")

livekit_plugins_avatartalk-1.0.1/livekit/plugins/avatartalk/avatar.py

@@ -0,0 +1,154 @@
+import os
+from typing import Optional
+
+from livekit import api, rtc
+from livekit.agents import NOT_GIVEN, AgentSession, NotGivenOr, get_job_context
+from livekit.agents.types import ATTRIBUTE_PUBLISH_ON_BEHALF
+from livekit.agents.voice.avatar import DataStreamAudioOutput
+
+from .api import AvatarTalkAPI, AvatarTalkException
+from .log import logger
+
+_AVATAR_AGENT_IDENTITY = "avatartalk-agent"
+_AVATAR_AGENT_NAME = "avatartalk-agent"
+DEFAULT_AVATAR_NAME = "japanese_man"
+DEFAULT_AVATAR_EMOTION = "expressive"
+SAMPLE_RATE = 16000
+
+
+class AvatarSession:
+    """AvatarTalkAPI avatar session"""
+
+    def __init__(
+        self,
+        *,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_secret: NotGivenOr[str] = NOT_GIVEN,
+        avatar: NotGivenOr[str | None] = NOT_GIVEN,
+        emotion: NotGivenOr[str | None] = NOT_GIVEN,
+        avatar_participant_identity: NotGivenOr[str | None] = NOT_GIVEN,
+        avatar_participant_name: NotGivenOr[str | None] = NOT_GIVEN,
+    ):
+        self._avatartalk_api = AvatarTalkAPI(api_url, api_secret)
+        self._avatar = avatar or (os.getenv("AVATARTALK_AVATAR") or DEFAULT_AVATAR_NAME)
+        self._emotion = emotion or (os.getenv("AVATARTALK_EMOTION") or DEFAULT_AVATAR_EMOTION)
+        self._avatar_participant_identity = avatar_participant_identity or _AVATAR_AGENT_IDENTITY
+        self._avatar_participant_name = avatar_participant_name or _AVATAR_AGENT_NAME
+        self._agent_track = None
+
+    def __generate_lk_token(
+        self,
+        livekit_api_key: str,
+        livekit_api_secret: str,
+        room: rtc.Room,
+        participant_identity: str,
+        participant_name: str,
+        as_agent: bool = True,
+        local_participant_identity: Optional[str] = None,
+    ):
+        token = (
+            api.AccessToken(api_key=livekit_api_key, api_secret=livekit_api_secret)
+            .with_identity(participant_identity)
+            .with_name(participant_name)
+            .with_grants(api.VideoGrants(room_join=True, room=room.name))
+            .with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+        )
+        if as_agent:
+            token = token.with_kind("agent")
+
+        if local_participant_identity is not None:
+            token = token.with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+
+        return token.to_jwt()
+
+    async def start(
+        self,
+        agent_session: AgentSession,
+        room: rtc.Room,
+        *,
+        livekit_url: NotGivenOr[str | None] = NOT_GIVEN,
+        livekit_api_key: NotGivenOr[str | None] = NOT_GIVEN,
+        livekit_api_secret: NotGivenOr[str | None] = NOT_GIVEN,
+    ):
+        livekit_url = livekit_url or (os.getenv("LIVEKIT_URL") or NOT_GIVEN)
+        livekit_api_key = livekit_api_key or (os.getenv("LIVEKIT_API_KEY") or NOT_GIVEN)
+        livekit_api_secret = livekit_api_secret or (os.getenv("LIVEKIT_API_SECRET") or NOT_GIVEN)
+        if not livekit_url or not livekit_api_key or not livekit_api_secret:
+            raise AvatarTalkException(
+                "livekit_url, livekit_api_key, and livekit_api_secret must be set by arguments or environment variables"
+            )
+
+        session_task_mapping = {}
+
+        try:
+            job_ctx = get_job_context()
+            local_participant_identity = job_ctx.token_claims().identity
+
+            async def _shutdown_session():
+                if room.name not in session_task_mapping:
+                    return
+                await self._avatartalk_api.stop_session(session_task_mapping[room.name])
+
+            job_ctx.add_shutdown_callback(_shutdown_session)
+        except (RuntimeError, KeyError):
+            if not room.isconnected():
+                raise AvatarTalkException(
+                    "local participant identity not found in token, and room is not connected"
+                ) from None
+            local_participant_identity = room.local_participant.identity
+
+        livekit_token = self.__generate_lk_token(
+            livekit_api_key,
+            livekit_api_secret,
+            room,
+            self._avatar_participant_identity,
+            self._avatar_participant_name,
+            as_agent=True,
+            local_participant_identity=local_participant_identity,
+        )
+
+        livekit_listener_token = self.__generate_lk_token(
+            livekit_api_key,
+            livekit_api_secret,
+            room,
+            "listener",
+            "listener",
+            as_agent=False,
+            local_participant_identity=None,
+        )
+
+        logger.debug(
+            "Starting Avatartalk agent session",
+            extra={"avatar": self._avatar, "room_name": room.name},
+        )
+        try:
+            resp = await self._avatartalk_api.start_session(
+                livekit_url=livekit_url,
+                avatar=self._avatar,
+                emotion=self._emotion,
+                room_name=room.name,
+                livekit_listener_token=livekit_listener_token,
+                livekit_room_token=livekit_token,
+                agent_identity=local_participant_identity,
+            )
+
+            self.conversation_id = resp["task_id"]
+            logger.debug(
+                "Avatartalk agent session started",
+                extra={
+                    "avatar": self._avatar,
+                    "emotion": self._emotion,
+                    "room_name": room.name,
+                    "task_id": self.conversation_id,
+                },
+            )
+            session_task_mapping[room.name] = self.conversation_id
+
+            agent_session.output.audio = DataStreamAudioOutput(
+                room=room,
+                destination_identity="listener",
+                sample_rate=SAMPLE_RATE,
+                # wait_remote_track=rtc.TrackKind.KIND_VIDEO,
+            )
+        except AvatarTalkException as e:
+            logger.error(e)

livekit_plugins_avatartalk-1.0.1/livekit/plugins/avatartalk/log.py

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

livekit_plugins_avatartalk-1.0.1/livekit/plugins/avatartalk/version.py

@@ -0,0 +1,15 @@
+# Copyright 2025 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.1"

livekit_plugins_avatartalk-1.0.1/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-avatartalk"
+dynamic = ["version"]
+description = "Agent Framework plugin for AvatarTalk"
+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.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = ["livekit-agents>=1.3.1"]
+
+[project.urls]
+Documentation = "https://docs.livekit.io"
+Website = "https://livekit.io/"
+Source = "https://github.com/livekit/agents"
+
+[tool.hatch.version]
+path = "livekit/plugins/avatartalk/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]