livekit-plugins-meshlite 0.1.0__tar.gz

livekit_plugins_meshlite-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+.env

livekit_plugins_meshlite-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

livekit_plugins_meshlite-0.1.0/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.5
+Name: livekit-plugins-meshlite
+Version: 0.1.0
+Summary: MeshLite avatar for LiveKit Agents: the agent voice drives a lip-synced avatar rendered in the visitor's browser
+Project-URL: Homepage, https://meshlite.io
+Project-URL: Documentation, https://github.com/meshlite-avatar/livekit-plugins-meshlite#readme
+Project-URL: Source, https://github.com/meshlite-avatar/livekit-plugins-meshlite
+Project-URL: Issues, https://github.com/meshlite-avatar/livekit-plugins-meshlite/issues
+Author: MeshLite
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,avatar,lip-sync,livekit,meshlite,realtime,webrtc
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: livekit-agents<2,>=1.0.0
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# livekit-plugins-meshlite
+
+Give your [LiveKit Agents](https://docs.livekit.io/agents/) voice agent a lip-synced
+[MeshLite](https://meshlite.io) face. Your agent keeps its own speech-to-text, LLM and
+voice (or realtime model); MeshLite only renders the face, in the visitor's browser.
+
+```
+your agent (Python)  --lk.audio_stream-->  visitor page (livekit-client)  -->  MeshLite avatar (face + lips)
+                     <--playback RPCs----
+```
+
+- No video server, no GPU, no extra participant in the room: the agent sends its voice to
+  the visitor page over the LiveKit data channel, using the LiveKit Agents avatar
+  data-stream protocol, and the MeshLite web SDK animates the avatar locally.
+- Interruptions work as usual: the face stops at once and reports the position really
+  heard, so the chat context keeps only what the visitor heard.
+- No MeshLite voice minutes are used. The session still counts as a conversation
+  (concurrent conversations, seats, statistics) and lasts at most 2 hours.
+
+## Install
+
+```bash
+pip install livekit-plugins-meshlite
+```
+
+Requires Python 3.9+ and `livekit-agents` 1.x.
+
+## Agent side
+
+```python
+from livekit.agents import Agent, AgentSession, JobContext
+from livekit.plugins import meshlite
+
+async def entrypoint(ctx: JobContext):
+    await ctx.connect()
+    session = AgentSession(stt=..., llm=..., tts=...)   # or a realtime model
+
+    avatar = meshlite.AvatarSession()           # visitor_identity="..." if several visitors share the room
+    await avatar.start(session, room=ctx.room)  # after ctx.connect(), before session.start()
+
+    await session.start(agent=Agent(instructions="..."), room=ctx.room)
+```
+
+`AvatarSession.start()` waits for the visitor participant (the first standard participant,
+or `visitor_identity`) and replaces the session audio output with LiveKit's
+`DataStreamAudioOutput`. The agent then publishes no audio track: its voice reaches the
+page as data and the MeshLite SDK plays it in sync with the face.
+
+| Argument | Default | Meaning |
+|---|---|---|
+| `visitor_identity` | first standard participant | browser participant whose page shows the avatar |
+| `sample_rate` | `24000` | PCM rate sent to the page (8000 to 48000) |
+| `clear_buffer_timeout` | `2.0` | seconds to wait for the page to confirm an interruption |
+
+### Audio format
+
+One `lk.audio_stream` byte stream per speech segment: raw 16-bit signed little-endian PCM
+(usually mono), 24 kHz by default, with `sample_rate` and `num_channels` stream attributes. The
+agent sends the `lk.clear_buffer` RPC on interruption; the page answers with the
+`lk.playback_started` and `lk.playback_finished` RPCs
+(`{"playback_position": float, "interrupted": bool}`).
+
+The data-stream protocol cannot pause and resume a segment. If your agent version offers
+false-interruption resume, disable it: `AgentSession(..., resume_false_interruption=False)`.
+
+## Browser side
+
+You need a MeshLite account on a plan that can embed the SDK on a website, a declared
+domain, a publishable key and a secret key of the same environment, and an avatar id
+(all in the MeshLite console).
+
+**1. Your server creates the MeshLite session** with `audio: "livekit"`. The secret key
+stays on your server:
+
+```js
+const upstream = await fetch("https://console.meshlite.io/api/v1/client-sessions", {
+  method: "POST",
+  headers: { Authorization: `Bearer ${process.env.MESHLITE_SECRET_KEY}`, "Content-Type": "application/json" },
+  body: JSON.stringify({
+    publishableKey: process.env.MESHLITE_PUBLISHABLE_KEY,
+    origin: "https://www.example.com",   // set by your server, never copied from the browser
+    avatar: "your-avatar-id",
+    audio: "livekit",
+  }),
+});
+const { sessionToken } = await upstream.json();
+```
+
+**2. The visitor page mounts the avatar and attaches the room** before connecting:
+
+```html
+<div id="avatar" style="width:340px;height:510px"></div>
+<script src="https://console.meshlite.io/sdk/1.11.46/meshlite.js" crossorigin="anonymous"></script>
+<script type="module">
+  import { Room } from "https://cdn.jsdelivr.net/npm/livekit-client@2.23.0/+esm";
+
+  const avatar = MeshLite.mount({
+    container: "#avatar",
+    avatar: "your-avatar-id",
+    publishableKey: "ml_pk_live_...",
+    sessionToken,                                  // from your server (step 1)
+    audio: "livekit",
+  });
+
+  const room = new Room();
+  const link = avatar.attachLiveKit(room);         // attach before connect so no speech is missed
+  link.on("ready", ({ output }) => console.log("avatar ready, voice played by", output));
+  link.on("fallback", ({ code }) => console.warn("avatar unavailable, the voice continues", code));
+  link.on("audio-blocked", () => showClickToEnableSound(() => link.resumeAudio()));
+
+  await room.connect(LIVEKIT_URL, participantToken);  // your LiveKit token (data publishing allowed)
+  await room.localParticipant.setMicrophoneEnabled(true);
+</script>
+```
+
+Requirements: `livekit-client` 2.9 or later (tested with 2.23.0), MeshLite web SDK 1.11.45
+or later, HTTPS (or `http://localhost` with test keys). Do not subscribe the agent audio
+yourself: the SDK plays the voice.
+
+`attachLiveKit(room, options)` accepts `agentIdentity` (accept audio only from this
+participant), `output` (`"auto"`, `"frame"` or `"page"`) and `fallback` (default `true`).
+With `output: "auto"`, Firefox plays the voice in your page while the avatar animates the
+lips in silence, so Firefox's echo cancellation hears it; other browsers play it in the
+avatar frame.
+
+### Fallback: the avatar never blocks the conversation
+
+When the face cannot start (refused session, network, timeout), fails, or is stopped
+(maximum duration, quota), the page plays the agent voice itself from the position already
+heard, the agent keeps receiving playback events and interruptions, and `link` emits
+`fallback` with an error `code`. Use `fallback: false` to stop instead (`failed` /
+`stopped` events).
+
+## Limits
+
+- Maximum session duration: 2 hours.
+- LiveKit recordings (egress) do not contain the agent voice, since no audio track is
+  published.
+- The MeshLite avatar is not a room participant: `avatar.avatar_identity` on the agent side
+  is the visitor identity.
+
+## Example app
+
+[`examples/browser-avatar`](examples/browser-avatar) is a complete local demo: a LiveKit
+agent, a small Python server that creates both session tokens, and a page with the avatar.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+The tests run offline with a fake room and check the exact protocol the MeshLite web SDK
+implements.
+
+## License
+
+[Apache-2.0](LICENSE)

livekit_plugins_meshlite-0.1.0/README.md

@@ -0,0 +1,159 @@
+# livekit-plugins-meshlite
+
+Give your [LiveKit Agents](https://docs.livekit.io/agents/) voice agent a lip-synced
+[MeshLite](https://meshlite.io) face. Your agent keeps its own speech-to-text, LLM and
+voice (or realtime model); MeshLite only renders the face, in the visitor's browser.
+
+```
+your agent (Python)  --lk.audio_stream-->  visitor page (livekit-client)  -->  MeshLite avatar (face + lips)
+                     <--playback RPCs----
+```
+
+- No video server, no GPU, no extra participant in the room: the agent sends its voice to
+  the visitor page over the LiveKit data channel, using the LiveKit Agents avatar
+  data-stream protocol, and the MeshLite web SDK animates the avatar locally.
+- Interruptions work as usual: the face stops at once and reports the position really
+  heard, so the chat context keeps only what the visitor heard.
+- No MeshLite voice minutes are used. The session still counts as a conversation
+  (concurrent conversations, seats, statistics) and lasts at most 2 hours.
+
+## Install
+
+```bash
+pip install livekit-plugins-meshlite
+```
+
+Requires Python 3.9+ and `livekit-agents` 1.x.
+
+## Agent side
+
+```python
+from livekit.agents import Agent, AgentSession, JobContext
+from livekit.plugins import meshlite
+
+async def entrypoint(ctx: JobContext):
+    await ctx.connect()
+    session = AgentSession(stt=..., llm=..., tts=...)   # or a realtime model
+
+    avatar = meshlite.AvatarSession()           # visitor_identity="..." if several visitors share the room
+    await avatar.start(session, room=ctx.room)  # after ctx.connect(), before session.start()
+
+    await session.start(agent=Agent(instructions="..."), room=ctx.room)
+```
+
+`AvatarSession.start()` waits for the visitor participant (the first standard participant,
+or `visitor_identity`) and replaces the session audio output with LiveKit's
+`DataStreamAudioOutput`. The agent then publishes no audio track: its voice reaches the
+page as data and the MeshLite SDK plays it in sync with the face.
+
+| Argument | Default | Meaning |
+|---|---|---|
+| `visitor_identity` | first standard participant | browser participant whose page shows the avatar |
+| `sample_rate` | `24000` | PCM rate sent to the page (8000 to 48000) |
+| `clear_buffer_timeout` | `2.0` | seconds to wait for the page to confirm an interruption |
+
+### Audio format
+
+One `lk.audio_stream` byte stream per speech segment: raw 16-bit signed little-endian PCM
+(usually mono), 24 kHz by default, with `sample_rate` and `num_channels` stream attributes. The
+agent sends the `lk.clear_buffer` RPC on interruption; the page answers with the
+`lk.playback_started` and `lk.playback_finished` RPCs
+(`{"playback_position": float, "interrupted": bool}`).
+
+The data-stream protocol cannot pause and resume a segment. If your agent version offers
+false-interruption resume, disable it: `AgentSession(..., resume_false_interruption=False)`.
+
+## Browser side
+
+You need a MeshLite account on a plan that can embed the SDK on a website, a declared
+domain, a publishable key and a secret key of the same environment, and an avatar id
+(all in the MeshLite console).
+
+**1. Your server creates the MeshLite session** with `audio: "livekit"`. The secret key
+stays on your server:
+
+```js
+const upstream = await fetch("https://console.meshlite.io/api/v1/client-sessions", {
+  method: "POST",
+  headers: { Authorization: `Bearer ${process.env.MESHLITE_SECRET_KEY}`, "Content-Type": "application/json" },
+  body: JSON.stringify({
+    publishableKey: process.env.MESHLITE_PUBLISHABLE_KEY,
+    origin: "https://www.example.com",   // set by your server, never copied from the browser
+    avatar: "your-avatar-id",
+    audio: "livekit",
+  }),
+});
+const { sessionToken } = await upstream.json();
+```
+
+**2. The visitor page mounts the avatar and attaches the room** before connecting:
+
+```html
+<div id="avatar" style="width:340px;height:510px"></div>
+<script src="https://console.meshlite.io/sdk/1.11.46/meshlite.js" crossorigin="anonymous"></script>
+<script type="module">
+  import { Room } from "https://cdn.jsdelivr.net/npm/livekit-client@2.23.0/+esm";
+
+  const avatar = MeshLite.mount({
+    container: "#avatar",
+    avatar: "your-avatar-id",
+    publishableKey: "ml_pk_live_...",
+    sessionToken,                                  // from your server (step 1)
+    audio: "livekit",
+  });
+
+  const room = new Room();
+  const link = avatar.attachLiveKit(room);         // attach before connect so no speech is missed
+  link.on("ready", ({ output }) => console.log("avatar ready, voice played by", output));
+  link.on("fallback", ({ code }) => console.warn("avatar unavailable, the voice continues", code));
+  link.on("audio-blocked", () => showClickToEnableSound(() => link.resumeAudio()));
+
+  await room.connect(LIVEKIT_URL, participantToken);  // your LiveKit token (data publishing allowed)
+  await room.localParticipant.setMicrophoneEnabled(true);
+</script>
+```
+
+Requirements: `livekit-client` 2.9 or later (tested with 2.23.0), MeshLite web SDK 1.11.45
+or later, HTTPS (or `http://localhost` with test keys). Do not subscribe the agent audio
+yourself: the SDK plays the voice.
+
+`attachLiveKit(room, options)` accepts `agentIdentity` (accept audio only from this
+participant), `output` (`"auto"`, `"frame"` or `"page"`) and `fallback` (default `true`).
+With `output: "auto"`, Firefox plays the voice in your page while the avatar animates the
+lips in silence, so Firefox's echo cancellation hears it; other browsers play it in the
+avatar frame.
+
+### Fallback: the avatar never blocks the conversation
+
+When the face cannot start (refused session, network, timeout), fails, or is stopped
+(maximum duration, quota), the page plays the agent voice itself from the position already
+heard, the agent keeps receiving playback events and interruptions, and `link` emits
+`fallback` with an error `code`. Use `fallback: false` to stop instead (`failed` /
+`stopped` events).
+
+## Limits
+
+- Maximum session duration: 2 hours.
+- LiveKit recordings (egress) do not contain the agent voice, since no audio track is
+  published.
+- The MeshLite avatar is not a room participant: `avatar.avatar_identity` on the agent side
+  is the visitor identity.
+
+## Example app
+
+[`examples/browser-avatar`](examples/browser-avatar) is a complete local demo: a LiveKit
+agent, a small Python server that creates both session tokens, and a page with the avatar.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+The tests run offline with a fake room and check the exact protocol the MeshLite web SDK
+implements.
+
+## License
+
+[Apache-2.0](LICENSE)

livekit_plugins_meshlite-0.1.0/livekit/plugins/meshlite/__init__.py

@@ -0,0 +1,20 @@
+"""MeshLite avatar plugin for LiveKit Agents.
+
+See https://console.meshlite.io for the web SDK that renders the avatar.
+"""
+
+from livekit.agents import Plugin
+
+from .avatar import DEFAULT_SAMPLE_RATE, AvatarSession
+from .log import logger
+from .version import __version__
+
+__all__ = ["AvatarSession", "DEFAULT_SAMPLE_RATE", "__version__"]
+
+
+class MeshLitePlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(MeshLitePlugin())

livekit_plugins_meshlite-0.1.0/livekit/plugins/meshlite/avatar.py

@@ -0,0 +1,177 @@
+"""MeshLite avatar for LiveKit Agents.
+
+The MeshLite avatar is not a participant of the room and the agent never
+renders or publishes video. The visitor's web page shows the avatar with the
+MeshLite web SDK (``audio: "livekit"`` + ``controller.attachLiveKit(room)``);
+this module only routes the agent voice to that page.
+
+Wire protocol (the LiveKit Agents avatar data-stream protocol):
+
+* agent -> visitor: one ``lk.audio_stream`` byte stream per speech segment,
+  16-bit PCM, ``sample_rate`` and ``num_channels`` stream attributes;
+* agent -> visitor: RPC ``lk.clear_buffer`` on interruption;
+* visitor -> agent: RPC ``lk.playback_started`` and ``lk.playback_finished``
+  (``{"playback_position": float, "interrupted": bool}``).
+"""
+
+from __future__ import annotations
+
+import inspect
+
+from livekit import rtc
+from livekit.agents import AgentSession, utils
+from livekit.agents.voice.avatar import DataStreamAudioOutput
+
+from .log import logger
+
+DEFAULT_SAMPLE_RATE = 24000
+_MIN_SAMPLE_RATE = 8000
+_MAX_SAMPLE_RATE = 48000
+
+try:
+    _OUTPUT_PARAMS = inspect.signature(DataStreamAudioOutput.__init__).parameters
+except (TypeError, ValueError):  # pragma: no cover - exotic builds
+    _OUTPUT_PARAMS = {}
+
+
+class AvatarSession:
+    """Route an :class:`~livekit.agents.AgentSession` voice to a MeshLite avatar.
+
+    Call :meth:`start` after ``await ctx.connect()`` and **before**
+    ``await session.start(...)``: the agent then sends its voice to the
+    visitor's page instead of publishing an audio track, and the page plays
+    it in sync with the avatar's face.
+
+    Args:
+        visitor_identity: identity of the browser participant whose page
+            shows the avatar. When omitted, the first standard (non-agent,
+            non-SIP) remote participant of the room is used, which is the
+            participant :class:`AgentSession` links to by default.
+        sample_rate: PCM rate sent to the page. The page converts any rate;
+            24 kHz matches the MeshLite engine and keeps the stream small.
+        clear_buffer_timeout: seconds the agent waits for the page to confirm
+            an interruption before it considers the speech stopped.
+    """
+
+    def __init__(
+        self,
+        *,
+        visitor_identity: str | None = None,
+        sample_rate: int = DEFAULT_SAMPLE_RATE,
+        clear_buffer_timeout: float | None = 2.0,
+    ) -> None:
+        if visitor_identity is not None and (
+            not isinstance(visitor_identity, str) or not visitor_identity.strip()
+        ):
+            raise ValueError("visitor_identity must be a non-empty string")
+        if (
+            isinstance(sample_rate, bool)
+            or not isinstance(sample_rate, int)
+            or not _MIN_SAMPLE_RATE <= sample_rate <= _MAX_SAMPLE_RATE
+        ):
+            raise ValueError(
+                f"sample_rate must be an integer between {_MIN_SAMPLE_RATE} and {_MAX_SAMPLE_RATE}"
+            )
+        if clear_buffer_timeout is not None and not clear_buffer_timeout >= 0:
+            raise ValueError("clear_buffer_timeout must be >= 0 or None")
+
+        self._visitor_identity = visitor_identity
+        self._sample_rate = sample_rate
+        self._clear_buffer_timeout = clear_buffer_timeout
+        self._audio_output: DataStreamAudioOutput | None = None
+        self._agent_session: AgentSession | None = None
+        self._starting = False
+        self._closed = False
+
+    @property
+    def provider(self) -> str:
+        return "meshlite"
+
+    @property
+    def visitor_identity(self) -> str | None:
+        """Identity of the participant that renders the avatar (known after start)."""
+        return self._visitor_identity
+
+    @property
+    def avatar_identity(self) -> str:
+        """The participant whose page renders the avatar.
+
+        MeshLite has no avatar participant: the avatar lives in the visitor's
+        page, so this is the visitor identity.
+        """
+        if self._visitor_identity is None:
+            raise RuntimeError("the visitor identity is known once start() has returned")
+        return self._visitor_identity
+
+    @property
+    def audio_output(self) -> DataStreamAudioOutput | None:
+        return self._audio_output
+
+    async def start(self, agent_session: AgentSession, room: rtc.Room) -> None:
+        if self._closed:
+            raise RuntimeError("this MeshLite AvatarSession is closed")
+        if self._starting or self._audio_output is not None:
+            raise RuntimeError("MeshLite AvatarSession.start() can only be called once")
+        self._starting = True
+        try:
+            identity = self._visitor_identity
+            if identity is None:
+                if not room.isconnected():
+                    raise RuntimeError(
+                        "connect to the room (await ctx.connect()) before starting the MeshLite "
+                        "avatar, or pass visitor_identity"
+                    )
+                logger.debug("waiting for the visitor participant")
+                participant = await utils.wait_for_participant(
+                    room, kind=rtc.ParticipantKind.PARTICIPANT_KIND_STANDARD
+                )
+                identity = participant.identity
+            if self._closed:
+                raise RuntimeError("this MeshLite AvatarSession was closed while starting")
+
+            previous = agent_session.output.audio
+            if previous is not None:
+                logger.warning(
+                    "replacing the session audio output with the MeshLite avatar output; "
+                    "call AvatarSession.start() before AgentSession.start() so the agent "
+                    "does not publish its own audio track",
+                    extra={"previous_output": getattr(previous, "label", type(previous).__name__)},
+                )
+
+            options: dict[str, object] = {}
+            if "clear_buffer_timeout" in _OUTPUT_PARAMS:
+                options["clear_buffer_timeout"] = self._clear_buffer_timeout
+            if "wait_playback_start" in _OUTPUT_PARAMS:
+                # The page reports when the avatar really starts speaking.
+                options["wait_playback_start"] = True
+            output = DataStreamAudioOutput(
+                room,
+                destination_identity=identity,
+                sample_rate=self._sample_rate,
+                **options,  # type: ignore[arg-type]
+            )
+            agent_session.output.audio = output
+
+            self._visitor_identity = identity
+            self._audio_output = output
+            self._agent_session = agent_session
+            logger.info(
+                "MeshLite avatar voice routed to the visitor page",
+                extra={"visitor_identity": identity, "sample_rate": self._sample_rate},
+            )
+        finally:
+            self._starting = False
+
+    async def aclose(self) -> None:
+        """Stop routing the voice to the avatar.
+
+        Unlike video avatar plugins this never removes a participant from the
+        room: the only participant involved is the visitor.
+        """
+        if self._closed:
+            return
+        self._closed = True
+        session, output = self._agent_session, self._audio_output
+        self._agent_session = None
+        if session is not None and output is not None and session.output.audio is output:
+            session.output.audio = None

livekit_plugins_meshlite-0.1.0/livekit/plugins/meshlite/log.py

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

livekit_plugins_meshlite-0.1.0/livekit/plugins/meshlite/version.py

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

livekit_plugins_meshlite-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-meshlite"
+dynamic = ["version"]
+description = "MeshLite avatar for LiveKit Agents: the agent voice drives a lip-synced avatar rendered in the visitor's browser"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+authors = [{ name = "MeshLite" }]
+keywords = ["livekit", "agents", "avatar", "meshlite", "webrtc", "realtime", "lip-sync"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+dependencies = ["livekit-agents>=1.0.0,<2"]
+
+[project.optional-dependencies]
+test = ["pytest>=8", "pytest-asyncio>=0.23"]
+
+[project.urls]
+Homepage = "https://meshlite.io"
+Documentation = "https://github.com/meshlite-avatar/livekit-plugins-meshlite#readme"
+Source = "https://github.com/meshlite-avatar/livekit-plugins-meshlite"
+Issues = "https://github.com/meshlite-avatar/livekit-plugins-meshlite/issues"
+
+[tool.hatch.version]
+path = "livekit/plugins/meshlite/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit", "/README.md", "/LICENSE"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+testpaths = ["tests"]