livekit-plugins-keyframe 1.4.4__py3-none-any.whl

livekit/plugins/keyframe/__init__.py

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

livekit/plugins/keyframe/api.py

@@ -0,0 +1,119 @@
+from __future__ import annotations
+
+import asyncio
+from typing import Any
+
+import aiohttp
+
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+)
+
+from .log import logger
+
+DEFAULT_API_URL = "https://api.keyframelabs.com"
+
+
+class KeyframeAPI:
+    """Asynchronous client for the Keyframe Labs session API."""
+
+    def __init__(
+        self,
+        api_key: str,
+        api_url: str,
+        *,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+        session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        self._api_key = api_key
+        self._api_url = api_url
+        self._conn_options = conn_options
+        self._session = session
+        self._own_session = session is None
+
+    async def __aenter__(self) -> KeyframeAPI:
+        if self._own_session:
+            self._session = aiohttp.ClientSession()
+        return self
+
+    async def __aexit__(
+        self, exc_type: type | None, exc_val: Exception | None, exc_tb: Any
+    ) -> None:
+        if self._own_session and self._session and not self._session.closed:
+            await self._session.close()
+
+    async def create_plugin_session(
+        self,
+        *,
+        persona_id: str | None = None,
+        persona_slug: str | None = None,
+        room_name: str,
+        livekit_url: str,
+        livekit_token: str,
+        source_participant_identity: str,
+    ) -> dict[str, Any]:
+        """Create a plugin session via POST /v1/sessions/plugins/livekit.
+
+        Returns dict with reservation_id and avatar_participant_identity.
+        """
+        payload: dict[str, Any] = {
+            "room_name": room_name,
+            "livekit_url": livekit_url,
+            "livekit_token": livekit_token,
+            "source_participant_identity": source_participant_identity,
+        }
+        if persona_id:
+            payload["persona_id"] = persona_id
+        if persona_slug:
+            payload["persona_slug"] = persona_slug
+
+        headers = {
+            "Authorization": f"Bearer {self._api_key}",
+            "Content-Type": "application/json",
+        }
+        return await self._post("/v1/sessions/plugins/livekit", payload, headers)
+
+    async def _post(
+        self, endpoint: str, payload: dict[str, Any], headers: dict[str, str]
+    ) -> dict[str, Any]:
+        url = f"{self._api_url}{endpoint}"
+        session = self._session or aiohttp.ClientSession()
+        try:
+            for i in range(self._conn_options.max_retry + 1):
+                try:
+                    async with session.post(
+                        url,
+                        headers=headers,
+                        json=payload,
+                        timeout=aiohttp.ClientTimeout(sock_connect=self._conn_options.timeout),
+                    ) as response:
+                        if not response.ok:
+                            text = await response.text()
+                            raise APIStatusError(
+                                f"Keyframe API error for {url}: {response.status}",
+                                status_code=response.status,
+                                body=text,
+                            )
+                        return await response.json()  # type: ignore
+                except Exception as e:
+                    if isinstance(e, APIStatusError) and not e.retryable:
+                        raise APIConnectionError(
+                            f"Failed to call Keyframe API at {url} with non-retryable error",
+                            retryable=False,
+                        ) from e
+
+                    if isinstance(e, APIConnectionError):
+                        logger.warning("Failed to call Keyframe API", extra={"error": str(e)})
+                    else:
+                        logger.exception("Failed to call Keyframe API")
+
+                    if i < self._conn_options.max_retry:
+                        await asyncio.sleep(self._conn_options._interval_for_retry(i))
+        finally:
+            if not self._session:
+                await session.close()
+
+        raise APIConnectionError("Failed to call Keyframe API after all retries.")

livekit/plugins/keyframe/avatar.py

@@ -0,0 +1,172 @@
+from __future__ import annotations
+
+import os
+
+from livekit import api, rtc
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    AgentSession,
+    APIConnectOptions,
+    NotGivenOr,
+    get_job_context,
+    utils,
+)
+from livekit.agents.voice.avatar import DataStreamAudioOutput
+from livekit.agents.voice.room_io import ATTRIBUTE_PUBLISH_ON_BEHALF
+
+from .api import DEFAULT_API_URL, KeyframeAPI
+from .errors import KeyframeException
+from .log import logger
+from .types import Emotion
+
+SAMPLE_RATE = 24000
+CONTROL_TOPIC = "lk.control"
+_AVATAR_AGENT_IDENTITY = "keyframe-avatar-agent"
+_AVATAR_AGENT_NAME = "keyframe-avatar-agent"
+
+
+class AvatarSession:
+    """A Keyframe avatar session for the LiveKit Agents framework."""
+
+    def __init__(
+        self,
+        *,
+        persona_id: NotGivenOr[str] = NOT_GIVEN,
+        persona_slug: NotGivenOr[str] = NOT_GIVEN,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_identity: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_name: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> None:
+        self._room: rtc.Room | None = None
+        self._conn_options = conn_options
+        self._avatar_participant_identity = (
+            avatar_participant_identity
+            if utils.is_given(avatar_participant_identity)
+            else _AVATAR_AGENT_IDENTITY
+        )
+        self._avatar_participant_name = (
+            avatar_participant_name
+            if utils.is_given(avatar_participant_name)
+            else _AVATAR_AGENT_NAME
+        )
+
+        # Resolve persona
+        has_id = utils.is_given(persona_id)
+        has_slug = utils.is_given(persona_slug)
+        if has_id == has_slug:
+            raise KeyframeException("Provide exactly one of persona_id or persona_slug")
+
+        self._persona_id: str | None = None
+        self._persona_slug: str | None = None
+        if utils.is_given(persona_id):
+            self._persona_id = persona_id
+        if utils.is_given(persona_slug):
+            self._persona_slug = persona_slug
+
+        # Resolve API config
+        api_url_val = (
+            api_url if utils.is_given(api_url) else os.getenv("KEYFRAME_API_URL", DEFAULT_API_URL)
+        )
+        api_key_val = api_key if utils.is_given(api_key) else os.getenv("KEYFRAME_API_KEY")
+
+        if not api_key_val:
+            raise KeyframeException(
+                "KEYFRAME_API_KEY must be set by arguments or environment variables"
+            )
+
+        self._api_url = api_url_val
+        self._api_key = api_key_val
+
+    async def start(
+        self,
+        agent_session: AgentSession,
+        room: rtc.Room,
+        *,
+        livekit_url: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_key: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_secret: NotGivenOr[str] = NOT_GIVEN,
+    ) -> None:
+        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 KeyframeException(
+                "livekit_url, livekit_api_key, and livekit_api_secret must be set "
+                "by arguments or environment variables"
+            )
+
+        job_ctx = get_job_context()
+        local_participant_identity = job_ctx.local_participant_identity
+
+        # Mint a LiveKit token for the avatar worker with publish_on_behalf
+        livekit_token = (
+            api.AccessToken(
+                api_key=livekit_api_key,
+                api_secret=livekit_api_secret,
+            )
+            .with_kind("agent")
+            .with_identity(self._avatar_participant_identity)
+            .with_name(self._avatar_participant_name)
+            .with_grants(
+                api.VideoGrants(
+                    room_join=True,
+                    room=room.name,
+                    can_publish=True,
+                    can_subscribe=True,
+                )
+            )
+            .with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+            .to_jwt()
+        )
+
+        # Call API to create a reservation and dispatch
+        async with KeyframeAPI(
+            api_key=self._api_key,
+            api_url=self._api_url,
+            conn_options=self._conn_options,
+        ) as keyframe_api:
+            result = await keyframe_api.create_plugin_session(
+                persona_id=self._persona_id,
+                persona_slug=self._persona_slug,
+                room_name=room.name,
+                livekit_url=livekit_url,
+                livekit_token=livekit_token,
+                source_participant_identity=local_participant_identity,
+            )
+            logger.debug(
+                "Keyframe plugin session created: reservation_id=%s",
+                result.get("reservation_id"),
+            )
+
+        self._room = room
+
+        agent_session.output.audio = DataStreamAudioOutput(
+            room=room,
+            destination_identity=self._avatar_participant_identity,
+            sample_rate=SAMPLE_RATE,
+            wait_remote_track=rtc.TrackKind.KIND_VIDEO,
+            clear_buffer_timeout=None,
+        )
+
+    async def set_emotion(self, emotion: Emotion) -> None:
+        """Set the avatar's emotional expression.
+
+        Sends a control message to the avatar worker to change its facial
+        expression and demeanor.
+
+        Args:
+            emotion: The emotion to express ('neutral', 'happy', 'sad', 'angry').
+        """
+        if self._room is None:
+            logger.warning("set_emotion() called before start()")
+            return
+
+        await self._room.local_participant.publish_data(
+            f"emotion:{emotion}".encode(),
+            reliable=False,
+            topic=CONTROL_TOPIC,
+            destination_identities=[self._avatar_participant_identity],
+        )

livekit/plugins/keyframe/errors.py

@@ -0,0 +1,4 @@
+class KeyframeException(Exception):
+    """Base exception for Keyframe plugin errors."""
+
+    pass

livekit/plugins/keyframe/log.py

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

livekit/plugins/keyframe/py.typed

@@ -0,0 +1 @@
+ 

livekit/plugins/keyframe/types.py

@@ -0,0 +1,3 @@
+from typing import Literal
+
+Emotion = Literal["neutral", "happy", "sad", "angry"]

livekit/plugins/keyframe/version.py

@@ -0,0 +1 @@
+__version__ = "1.4.4"

livekit_plugins_keyframe-1.4.4.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-keyframe
+Version: 1.4.4
+Summary: Agent Framework plugin for Keyframe Labs avatars
+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: ai,audio,avatar,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.10
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10.0
+Requires-Dist: livekit-agents>=1.4.4
+Description-Content-Type: text/markdown
+
+# livekit-plugins-keyframe
+
+Agent Framework plugin for [Keyframe Labs](https://keyframelabs.com) avatars.
+
+## Installation
+
+```bash
+pip install livekit-plugins-keyframe
+```
+
+## Usage
+
+```python
+from livekit.agents import AgentSession
+from livekit.plugins import keyframe
+
+session = AgentSession(stt=..., llm=..., tts=...)
+
+avatar = keyframe.AvatarSession(
+    persona_id="ab85a2a0-0555-428d-87b2-ff3019a58b93",  # or persona_slug="public:cosmo_persona-1.5-live"
+    api_key="keyframe_sk_live_...",  # or set KEYFRAME_API_KEY env var
+)
+
+await avatar.start(session, room=ctx.room)
+await session.start(room=ctx.room, agent=my_agent)
+```
+
+## Authentication
+
+Set the following environment variables:
+
+- `KEYFRAME_API_KEY` - Your Keyframe API key
+- `LIVEKIT_URL` - LiveKit server URL
+- `LIVEKIT_API_KEY` - LiveKit API key
+- `LIVEKIT_API_SECRET` - LiveKit API secret

livekit_plugins_keyframe-1.4.4.dist-info/RECORD

@@ -0,0 +1,11 @@
+livekit/plugins/keyframe/__init__.py,sha256=hTb3_6H4v3G1Zoet0fGGpNUJ_AepeEeL_OsvBe6qrqo,1041
+livekit/plugins/keyframe/api.py,sha256=OfvJm9snjQeoOxXC40JBO6TWMw2AEhNkNkI74L94QRs,4177
+livekit/plugins/keyframe/avatar.py,sha256=6dWK0vXtV24bTAuQ7ARweFGXMoxuF8jywm_M_ZuL6Ss,6077
+livekit/plugins/keyframe/errors.py,sha256=CCD-XKfxHeAFkKzl1W6Ixuz7IwM_QqiCXRw1eercNH4,99
+livekit/plugins/keyframe/log.py,sha256=wy2ZsjHZnSJwRrhmFmK5JXppiaP_M_9PvE_nxKIb1og,71
+livekit/plugins/keyframe/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
+livekit/plugins/keyframe/types.py,sha256=Xi-oJwJIZB4lEY-ZO3X9MPLj8DhVuTLtJMR_kgD9gns,82
+livekit/plugins/keyframe/version.py,sha256=6stz_YFBRP_lguydVylsTgSmj3VTb6WFq8Sp45WYQyY,22
+livekit_plugins_keyframe-1.4.4.dist-info/METADATA,sha256=oYj7LLolXcjiWVAkPpU0ht7xMe69On3w___ogYiaxSQ,1796
+livekit_plugins_keyframe-1.4.4.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+livekit_plugins_keyframe-1.4.4.dist-info/RECORD,,

livekit_plugins_keyframe-1.4.4.dist-info/WHEEL

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