livekit-plugins-bithuman 1.0.14__py3-none-any.whl

livekit/plugins/bithuman/__init__.py

@@ -0,0 +1,35 @@
+# 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 .avatar import AvatarSession, BitHumanException
+from .version import __version__
+
+__all__ = [
+    "BitHumanException",
+    "AvatarSession",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class BitHumanPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(BitHumanPlugin())

livekit/plugins/bithuman/avatar.py

@@ -0,0 +1,155 @@
+from __future__ import annotations
+
+import os
+import sys
+from collections.abc import AsyncGenerator, AsyncIterator
+
+import cv2
+import numpy as np
+from loguru import logger as _logger
+
+from bithuman import AsyncBithuman
+from livekit import rtc
+from livekit.agents import NOT_GIVEN, AgentSession, NotGivenOr, utils
+from livekit.agents.voice.avatar import (
+    AudioSegmentEnd,
+    AvatarOptions,
+    AvatarRunner,
+    QueueAudioOutput,
+    VideoGenerator,
+)
+
+from .log import logger
+
+_logger.remove()
+_logger.add(sys.stdout, level="INFO")
+
+
+class BitHumanException(Exception):
+    """Exception for BitHuman errors"""
+
+
+class AvatarSession:
+    """A Beyond Presence avatar session"""
+
+    def __init__(
+        self,
+        *,
+        model_path: NotGivenOr[str | None] = NOT_GIVEN,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_secret: NotGivenOr[str] = NOT_GIVEN,
+        api_token: NotGivenOr[str] = NOT_GIVEN,
+    ) -> None:
+        self._api_url = api_url or os.getenv("BITHUMAN_API_URL")
+        self._api_secret = api_secret or os.getenv("BITHUMAN_API_SECRET")
+        self._api_token = api_token or os.getenv("BITHUMAN_API_TOKEN")
+        self._model_path = model_path or os.getenv("BITHUMAN_MODEL_PATH")
+
+        if self._api_secret is None and self._api_token is None:
+            raise BitHumanException("BITHUMAN_API_SECRET or BITHUMAN_API_TOKEN must be set")
+        if self._model_path is None:
+            raise BitHumanException("BITHUMAN_MODEL_PATH must be set")
+
+        self._avatar_runner: AvatarRunner | None = None
+
+    async def start(self, agent_session: AgentSession, room: rtc.Room) -> None:
+        kwargs = {
+            "model_path": self._model_path,
+        }
+        if self._api_secret:
+            kwargs["api_secret"] = self._api_secret
+        if self._api_token:
+            kwargs["token"] = self._api_token
+        if self._api_url:
+            kwargs["api_url"] = self._api_url
+
+        runtime = await AsyncBithuman.create(**kwargs)
+        await runtime.start()
+        video_generator = BithumanGenerator(runtime)
+
+        output_width, output_height = video_generator.video_resolution
+        avatar_options = AvatarOptions(
+            video_width=output_width,
+            video_height=output_height,
+            video_fps=video_generator.video_fps,
+            audio_sample_rate=video_generator.audio_sample_rate,
+            audio_channels=1,
+        )
+
+        audio_buffer = QueueAudioOutput(sample_rate=runtime.settings.INPUT_SAMPLE_RATE)
+        # create avatar runner
+        self._avatar_runner = AvatarRunner(
+            room=room,
+            video_gen=video_generator,
+            audio_recv=audio_buffer,
+            options=avatar_options,
+        )
+        await self._avatar_runner.start()
+
+        agent_session.output.audio = audio_buffer
+
+
+class BithumanGenerator(VideoGenerator):
+    def __init__(self, runtime: AsyncBithuman):
+        self._runtime = runtime
+
+    @property
+    def video_resolution(self) -> tuple[int, int]:
+        frame = self._runtime.get_first_frame()
+        if frame is None:
+            raise ValueError("Failed to read frame")
+        return frame.shape[1], frame.shape[0]
+
+    @property
+    def video_fps(self) -> int:
+        return self._runtime.settings.FPS
+
+    @property
+    def audio_sample_rate(self) -> int:
+        return self._runtime.settings.INPUT_SAMPLE_RATE
+
+    @utils.log_exceptions(logger=logger)
+    async def push_audio(self, frame: rtc.AudioFrame | AudioSegmentEnd) -> None:
+        if isinstance(frame, AudioSegmentEnd):
+            await self._runtime.flush()
+            return
+        await self._runtime.push_audio(bytes(frame.data), frame.sample_rate, last_chunk=False)
+
+    def clear_buffer(self) -> None:
+        self._runtime.interrupt()
+
+    def __aiter__(self) -> AsyncIterator[rtc.VideoFrame | rtc.AudioFrame | AudioSegmentEnd]:
+        return self._stream_impl()
+
+    async def _stream_impl(
+        self,
+    ) -> AsyncGenerator[rtc.VideoFrame | rtc.AudioFrame | AudioSegmentEnd, None]:
+        def create_video_frame(image: np.ndarray) -> rtc.VideoFrame:
+            image = cv2.cvtColor(image, cv2.COLOR_BGR2RGBA)
+            return rtc.VideoFrame(
+                width=image.shape[1],
+                height=image.shape[0],
+                type=rtc.VideoBufferType.RGBA,
+                data=image.tobytes(),
+            )
+
+        async for frame in self._runtime.run():
+            if frame.bgr_image is not None:
+                video_frame = create_video_frame(frame.bgr_image)
+                yield video_frame
+
+            audio_chunk = frame.audio_chunk
+            if audio_chunk is not None:
+                audio_frame = rtc.AudioFrame(
+                    data=audio_chunk.bytes,
+                    sample_rate=audio_chunk.sample_rate,
+                    num_channels=1,
+                    samples_per_channel=len(audio_chunk.array),
+                )
+                yield audio_frame
+
+            if frame.end_of_speech:
+                yield AudioSegmentEnd()
+
+    async def stop(self) -> None:
+        await self._runtime.stop()

livekit/plugins/bithuman/log.py

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

livekit/plugins/bithuman/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.14"

livekit_plugins_bithuman-1.0.14.dist-info/METADATA

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-bithuman
+Version: 1.0.14
+Summary: Agent Framework plugin for services from BitHuman Avatar Rendering
+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.14
+Description-Content-Type: text/markdown
+
+# LiveKit Plugins BitHuman Avatar Runtime
+
+Agent Framework Plugin for avatars with [bitHuman](https://www.bithuman.ai/)'s local runtime SDK.

livekit_plugins_bithuman-1.0.14.dist-info/RECORD

@@ -0,0 +1,7 @@
+livekit/plugins/bithuman/__init__.py,sha256=DokxJEJVz4fcsIMKMvuW3IkR_OY5zPCiojtV0nGKfUM,981
+livekit/plugins/bithuman/avatar.py,sha256=XdvsIhKofmtDTJKe6Je2Yx67fzcbd1ikM2MTYvaztxs,5089
+livekit/plugins/bithuman/log.py,sha256=1lFUaugLdHDmBqFuNz2Z70iMRyuOtQ9KkL5h3ney0So,71
+livekit/plugins/bithuman/version.py,sha256=mZeHadhLY3NHWPLDWAefxB_AY_r7LJWUDEwaBi_7reM,601
+livekit_plugins_bithuman-1.0.14.dist-info/METADATA,sha256=5kwf9Q9-20-kVnbw1x3nHaT8ytqupalLWdhsZBej0Cc,1130
+livekit_plugins_bithuman-1.0.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+livekit_plugins_bithuman-1.0.14.dist-info/RECORD,,

livekit_plugins_bithuman-1.0.14.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any