streamcore 0.1.0__tar.gz

streamcore-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.

streamcore-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: streamcore
+Version: 0.1.0
+Summary: Python SDK for connecting to a Pion Voice Agent server via WebRTC + WHIP
+License-Expression: Apache-2.0
+Keywords: webrtc,whip,voice-agent,pion,real-time,audio
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiortc>=1.9.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: av>=12.0.0
+Requires-Dist: numpy>=1.24.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Dynamic: license-file
+
+# streamcore (Python)
+
+Python SDK for connecting to a [streamcore](https://github.com/streamcore/streamcore-server) server via WebRTC + WHIP, powered by [aiortc](https://github.com/aiortc/aiortc).
+
+## Requirements
+
+- **Python 3.10+**
+
+## Installation
+
+```bash
+pip install streamcore
+```
+
+Or install from source:
+
+```bash
+cd python-sdk
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import asyncio
+import numpy as np
+import streamcore
+
+
+async def main():
+    def on_transcript(entry, all_entries):
+        print(f"[{entry.role}] {entry.text}")
+
+    client = streamcore.Client(
+        config=streamcore.Config(whip_endpoint="http://localhost:8080/whip"),
+        events=streamcore.EventHandler(
+            on_transcript=on_transcript,
+            on_error=lambda err: print(f"Error: {err}"),
+        ),
+    )
+
+    await client.connect()
+
+    # Send a 20 ms frame of silence
+    pcm = np.zeros(streamcore.FRAME_SIZE, dtype=np.int16)
+    await client.send_pcm(pcm)
+
+    # Receive decoded audio from the agent
+    audio = await client.recv_pcm()  # numpy int16 array
+
+    await client.disconnect()
+
+
+asyncio.run(main())
+```
+
+## API
+
+### `Client(config?, events?)`
+
+Creates a new voice agent client.
+
+#### `Config`
+
+| Field           | Type         | Default                        | Description                 |
+| --------------- | ------------ | ------------------------------ | --------------------------- |
+| `whip_endpoint` | `str`        | `"http://localhost:8080/whip"` | WHIP signaling endpoint URL |
+| `ice_servers`   | `list[str]`  | `["stun:stun.l.google.com:19302"]` | ICE server URLs        |
+
+#### `EventHandler`
+
+| Callback                 | Signature                                                       | Description                           |
+| ------------------------ | --------------------------------------------------------------- | ------------------------------------- |
+| `on_status_change`       | `(status: ConnectionStatus) -> None`                            | Fired when connection status changes  |
+| `on_transcript`          | `(entry: TranscriptEntry, all: list[TranscriptEntry]) -> None`  | Fired on new or updated transcript    |
+| `on_error`               | `(error: Exception) -> None`                                    | Fired on connection or server errors  |
+| `on_data_channel_message`| `(msg: DataChannelMessage) -> None`                             | Fired for every raw DC message        |
+
+#### Methods
+
+| Method                          | Description                                                  |
+| ------------------------------- | ------------------------------------------------------------ |
+| `await client.connect(track?)`  | Connect via WHIP. Optionally pass an aiortc audio track.     |
+| `await client.disconnect()`     | Tear down connection and free resources.                     |
+| `await client.send_pcm(pcm)`   | Send a numpy int16 PCM buffer (mono 48 kHz) to the agent.   |
+| `await client.recv_pcm()`      | Receive decoded PCM audio as a numpy int16 array.            |
+| `client.status`                 | Current `ConnectionStatus`.                                  |
+| `client.transcript`             | Current conversation as `list[TranscriptEntry]`.             |
+| `client.remote_track`           | Inbound audio track from the agent (available after connect).|
+
+#### Audio Constants
+
+| Constant      | Value    | Description                      |
+| ------------- | -------- | -------------------------------- |
+| `SAMPLE_RATE` | `48000`  | Audio sample rate in Hz          |
+| `CHANNELS`    | `1`      | Number of channels (mono)        |
+| `FRAME_SIZE`  | `960`    | Samples per 20 ms frame          |
+
+## Audio I/O
+
+The SDK handles aiortc track management, `av.AudioFrame` construction, and
+resampling internally. Callers only deal with raw PCM data as numpy int16
+arrays:
+
+```python
+# Send microphone audio (960 samples = 20 ms at 48 kHz)
+await client.send_pcm(pcm_int16)
+
+# Receive agent audio
+audio = await client.recv_pcm()
+```
+
+If you need direct track access (e.g. for a custom aiortc pipeline), pass
+your own `AudioStreamTrack` via `client.connect(user_track=my_track)`.
+
+## Dependencies
+
+| Package  | Purpose                        |
+| -------- | ------------------------------ |
+| `aiortc` | WebRTC stack                   |
+| `aiohttp`| HTTP client for WHIP signaling |
+| `av`     | Audio frame encoding/decoding  |
+| `numpy`  | PCM audio buffers              |
+
+## License
+
+Apache-2.0

streamcore-0.1.0/README.md

@@ -0,0 +1,127 @@
+# streamcore (Python)
+
+Python SDK for connecting to a [streamcore](https://github.com/streamcore/streamcore-server) server via WebRTC + WHIP, powered by [aiortc](https://github.com/aiortc/aiortc).
+
+## Requirements
+
+- **Python 3.10+**
+
+## Installation
+
+```bash
+pip install streamcore
+```
+
+Or install from source:
+
+```bash
+cd python-sdk
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import asyncio
+import numpy as np
+import streamcore
+
+
+async def main():
+    def on_transcript(entry, all_entries):
+        print(f"[{entry.role}] {entry.text}")
+
+    client = streamcore.Client(
+        config=streamcore.Config(whip_endpoint="http://localhost:8080/whip"),
+        events=streamcore.EventHandler(
+            on_transcript=on_transcript,
+            on_error=lambda err: print(f"Error: {err}"),
+        ),
+    )
+
+    await client.connect()
+
+    # Send a 20 ms frame of silence
+    pcm = np.zeros(streamcore.FRAME_SIZE, dtype=np.int16)
+    await client.send_pcm(pcm)
+
+    # Receive decoded audio from the agent
+    audio = await client.recv_pcm()  # numpy int16 array
+
+    await client.disconnect()
+
+
+asyncio.run(main())
+```
+
+## API
+
+### `Client(config?, events?)`
+
+Creates a new voice agent client.
+
+#### `Config`
+
+| Field           | Type         | Default                        | Description                 |
+| --------------- | ------------ | ------------------------------ | --------------------------- |
+| `whip_endpoint` | `str`        | `"http://localhost:8080/whip"` | WHIP signaling endpoint URL |
+| `ice_servers`   | `list[str]`  | `["stun:stun.l.google.com:19302"]` | ICE server URLs        |
+
+#### `EventHandler`
+
+| Callback                 | Signature                                                       | Description                           |
+| ------------------------ | --------------------------------------------------------------- | ------------------------------------- |
+| `on_status_change`       | `(status: ConnectionStatus) -> None`                            | Fired when connection status changes  |
+| `on_transcript`          | `(entry: TranscriptEntry, all: list[TranscriptEntry]) -> None`  | Fired on new or updated transcript    |
+| `on_error`               | `(error: Exception) -> None`                                    | Fired on connection or server errors  |
+| `on_data_channel_message`| `(msg: DataChannelMessage) -> None`                             | Fired for every raw DC message        |
+
+#### Methods
+
+| Method                          | Description                                                  |
+| ------------------------------- | ------------------------------------------------------------ |
+| `await client.connect(track?)`  | Connect via WHIP. Optionally pass an aiortc audio track.     |
+| `await client.disconnect()`     | Tear down connection and free resources.                     |
+| `await client.send_pcm(pcm)`   | Send a numpy int16 PCM buffer (mono 48 kHz) to the agent.   |
+| `await client.recv_pcm()`      | Receive decoded PCM audio as a numpy int16 array.            |
+| `client.status`                 | Current `ConnectionStatus`.                                  |
+| `client.transcript`             | Current conversation as `list[TranscriptEntry]`.             |
+| `client.remote_track`           | Inbound audio track from the agent (available after connect).|
+
+#### Audio Constants
+
+| Constant      | Value    | Description                      |
+| ------------- | -------- | -------------------------------- |
+| `SAMPLE_RATE` | `48000`  | Audio sample rate in Hz          |
+| `CHANNELS`    | `1`      | Number of channels (mono)        |
+| `FRAME_SIZE`  | `960`    | Samples per 20 ms frame          |
+
+## Audio I/O
+
+The SDK handles aiortc track management, `av.AudioFrame` construction, and
+resampling internally. Callers only deal with raw PCM data as numpy int16
+arrays:
+
+```python
+# Send microphone audio (960 samples = 20 ms at 48 kHz)
+await client.send_pcm(pcm_int16)
+
+# Receive agent audio
+audio = await client.recv_pcm()
+```
+
+If you need direct track access (e.g. for a custom aiortc pipeline), pass
+your own `AudioStreamTrack` via `client.connect(user_track=my_track)`.
+
+## Dependencies
+
+| Package  | Purpose                        |
+| -------- | ------------------------------ |
+| `aiortc` | WebRTC stack                   |
+| `aiohttp`| HTTP client for WHIP signaling |
+| `av`     | Audio frame encoding/decoding  |
+| `numpy`  | PCM audio buffers              |
+
+## License
+
+Apache-2.0

streamcore-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "streamcore"
+version = "0.1.0"
+description = "Python SDK for connecting to a Pion Voice Agent server via WebRTC + WHIP"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+keywords = ["webrtc", "whip", "voice-agent", "pion", "real-time", "audio"]
+dependencies = [
+    "aiortc>=1.9.0",
+    "aiohttp>=3.9.0",
+    "av>=12.0.0",
+    "numpy>=1.24.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-asyncio",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]

streamcore-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

streamcore-0.1.0/src/streamcore/__init__.py

@@ -0,0 +1,21 @@
+from .audio import CHANNELS, FRAME_SIZE, SAMPLE_RATE
+from .types import (
+    ConnectionStatus,
+    TranscriptEntry,
+    DataChannelMessage,
+    Config,
+    EventHandler,
+)
+from .client import Client
+from .whip import whip_offer, whip_delete
+
+__all__ = [
+    "Client",
+    "Config",
+    "EventHandler",
+    "ConnectionStatus",
+    "TranscriptEntry",
+    "DataChannelMessage",
+    "whip_offer",
+    "whip_delete",
+]

streamcore-0.1.0/src/streamcore/audio.py

@@ -0,0 +1,54 @@
+"""Audio helpers for the StreamCoreAI Python SDK.
+
+Provides PCM-level send/receive so callers never need to deal with
+aiortc tracks, av.AudioFrame construction, or resampling.
+"""
+
+from __future__ import annotations
+
+import asyncio
+import fractions
+
+import av
+import numpy as np
+from aiortc.mediastreams import AudioStreamTrack, MediaStreamError
+
+SAMPLE_RATE: int = 48_000
+"""Audio sample rate in Hz (48 kHz)."""
+
+CHANNELS: int = 1
+"""Number of audio channels (mono)."""
+
+FRAME_SIZE: int = 960
+"""Number of samples per 20 ms frame at 48 kHz."""
+
+
+class _SDKAudioTrack(AudioStreamTrack):
+    """Internal aiortc track fed by :meth:`Client.send_pcm`."""
+
+    kind = "audio"
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._queue: asyncio.Queue[np.ndarray] = asyncio.Queue()
+        self._samples: int = 0
+        self._time_base = fractions.Fraction(1, SAMPLE_RATE)
+
+    async def recv(self) -> av.AudioFrame:
+        if self.readyState != "live":
+            raise MediaStreamError
+        try:
+            pcm = await asyncio.wait_for(self._queue.get(), timeout=0.02)
+        except asyncio.TimeoutError:
+            pcm = np.zeros(FRAME_SIZE, dtype=np.int16)
+
+        pts = self._samples
+        n = len(pcm)
+        self._samples += n
+
+        frame = av.AudioFrame(format="s16", layout="mono", samples=n)
+        frame.planes[0].update(pcm.tobytes())
+        frame.pts = pts
+        frame.sample_rate = SAMPLE_RATE
+        frame.time_base = self._time_base
+        return frame

streamcore-0.1.0/src/streamcore/client.py

@@ -0,0 +1,277 @@
+from __future__ import annotations
+
+import asyncio
+import json
+import logging
+from threading import Lock
+
+import av
+import numpy as np
+from aiortc import (
+    RTCConfiguration,
+    RTCIceServer,
+    RTCPeerConnection,
+    RTCSessionDescription,
+)
+from aiortc.contrib.media import MediaBlackhole
+
+from .audio import SAMPLE_RATE, _SDKAudioTrack
+from .types import (
+    Config,
+    ConnectionStatus,
+    DataChannelMessage,
+    EventHandler,
+    TranscriptEntry,
+)
+from .whip import whip_delete, whip_offer
+
+logger = logging.getLogger("streamcore")
+
+
+class Client:
+    """Manages a WebRTC connection to a Voice Agent server via WHIP signaling.
+
+    After :meth:`connect` returns, the peer connection is active. Remote audio
+    is consumed internally (or via the ``remote_track`` attribute). Provide an
+    audio track via ``user_track`` to send microphone audio to the server.
+    """
+
+    def __init__(
+        self,
+        config: Config | None = None,
+        events: EventHandler | None = None,
+    ) -> None:
+        self.config = config or Config()
+        self.events = events or EventHandler()
+
+        self._pc: RTCPeerConnection | None = None
+        self._session_url: str = ""
+        self._blackhole: MediaBlackhole | None = None
+
+        self._lock = Lock()
+        self._status = ConnectionStatus.IDLE
+        self._transcript: list[TranscriptEntry] = []
+        self._assist_buf: str = ""
+
+        self.remote_track = None
+        """The inbound audio track from the agent, available after connect."""
+
+        self._sdk_track: _SDKAudioTrack | None = None
+        self._remote_track_ready = asyncio.Event()
+        self._resampler: av.AudioResampler | None = None
+
+    @property
+    def status(self) -> ConnectionStatus:
+        with self._lock:
+            return self._status
+
+    @property
+    def transcript(self) -> list[TranscriptEntry]:
+        with self._lock:
+            return list(self._transcript)
+
+    async def connect(self, user_track=None) -> None:
+        """Establish a WebRTC connection to the voice agent server.
+
+        Args:
+            user_track: An optional aiortc MediaStreamTrack for the user's
+                microphone audio. If provided it will be added to the peer
+                connection so the server receives audio from the user.
+        """
+        self._set_status(ConnectionStatus.CONNECTING)
+
+        try:
+            ice_servers = [RTCIceServer(urls=url) for url in self.config.ice_servers]
+            pc = RTCPeerConnection(RTCConfiguration(iceServers=ice_servers))
+            self._pc = pc
+
+            # Add user audio track if provided, otherwise create SDK track.
+            if user_track is not None:
+                pc.addTrack(user_track)
+            else:
+                self._sdk_track = _SDKAudioTrack()
+                pc.addTrack(self._sdk_track)
+
+            # Create data channel for receiving events from the server.
+            dc = pc.createDataChannel("events")
+
+            @dc.on("message")
+            def on_dc_message(message):
+                try:
+                    data = json.loads(message)
+                    msg = DataChannelMessage(
+                        type=data.get("type", ""),
+                        text=data.get("text", ""),
+                        final=data.get("final", False),
+                        message=data.get("message", ""),
+                    )
+                    if self.events.on_data_channel_message:
+                        self.events.on_data_channel_message(msg)
+                    self._handle_data_channel_message(msg)
+                except Exception as exc:
+                    logger.warning("Failed to parse DC message: %s", exc)
+
+            @pc.on("track")
+            def on_track(track):
+                self.remote_track = track
+                self._remote_track_ready.set()
+
+            @pc.on("connectionstatechange")
+            async def on_connection_state_change():
+                state = pc.connectionState
+                if state == "connected":
+                    self._set_status(ConnectionStatus.CONNECTED)
+                elif state in ("failed", "closed", "disconnected"):
+                    self._set_status(ConnectionStatus.DISCONNECTED)
+
+            # Create offer and gather ICE candidates.
+            offer = await pc.createOffer()
+            await pc.setLocalDescription(offer)
+
+            # aiortc gathers ICE candidates during setLocalDescription,
+            # so localDescription.sdp already contains all candidates.
+            offer_sdp = pc.localDescription.sdp
+
+            # WHIP exchange.
+            result = await whip_offer(self.config.whip_endpoint, offer_sdp)
+            self._session_url = result.session_url
+
+            answer = RTCSessionDescription(sdp=result.answer_sdp, type="answer")
+            await pc.setRemoteDescription(answer)
+
+        except Exception as exc:
+            logger.error("Connect error: %s", exc)
+            self._set_status(ConnectionStatus.ERROR)
+            if self.events.on_error:
+                self.events.on_error(exc)
+            raise
+
+    async def disconnect(self) -> None:
+        """Tear down the WebRTC connection and free resources."""
+        # Stop SDK track first so aiortc's internal consumer unblocks.
+        if self._sdk_track is not None:
+            self._sdk_track.stop()
+            self._sdk_track = None
+        await whip_delete(self._session_url)
+        self._session_url = ""
+        if self._blackhole:
+            await self._blackhole.stop()
+            self._blackhole = None
+        if self._pc:
+            pc = self._pc
+            self._pc = None
+            try:
+                await asyncio.wait_for(pc.close(), timeout=3)
+            except (asyncio.TimeoutError, Exception):
+                pass
+        self._remote_track_ready.clear()
+        self._resampler = None
+        self._set_status(ConnectionStatus.IDLE)
+        self._assist_buf = ""
+
+    # ── Audio helpers ────────────────────────────────────────────────
+
+    async def send_pcm(self, pcm: np.ndarray) -> None:
+        """Send a buffer of 16-bit PCM samples to the voice agent.
+
+        Args:
+            pcm: numpy int16 array of audio samples (mono, 48 kHz).
+                 Typically ``FRAME_SIZE`` (960) samples for a 20 ms frame.
+        """
+        if self._sdk_track is None:
+            raise RuntimeError(
+                "send_pcm requires the built-in audio track; "
+                "do not pass user_track to connect()"
+            )
+        await self._sdk_track._queue.put(pcm)
+
+    async def recv_pcm(self) -> np.ndarray:
+        """Receive decoded PCM audio from the voice agent.
+
+        Blocks until the remote audio track is available, then returns
+        a numpy int16 array of mono 48 kHz samples.
+        """
+        await self._remote_track_ready.wait()
+        track = self.remote_track
+
+        if self._resampler is None:
+            self._resampler = av.AudioResampler(
+                format="s16", layout="mono", rate=SAMPLE_RATE
+            )
+
+        frame = await track.recv()
+        arrays = []
+        for resampled in self._resampler.resample(frame):
+            arrays.append(resampled.to_ndarray().flatten())
+        if arrays:
+            return np.concatenate(arrays)
+        return np.array([], dtype=np.int16)
+
+    # ── Internal helpers ─────────────────────────────────────────────
+
+    def _set_status(self, status: ConnectionStatus) -> None:
+        with self._lock:
+            self._status = status
+        if self.events.on_status_change:
+            self.events.on_status_change(status)
+
+    def _handle_data_channel_message(self, msg: DataChannelMessage) -> None:
+        with self._lock:
+            if msg.type == "transcript":
+                if msg.final:
+                    pending_assistant = self._assist_buf
+                    self._assist_buf = ""
+
+                    updated = [
+                        e
+                        for e in self._transcript
+                        if not (e.role == "user" and e.partial)
+                        and not (e.role == "assistant" and e.partial)
+                    ]
+                    if pending_assistant:
+                        updated.append(
+                            TranscriptEntry(role="assistant", text=pending_assistant)
+                        )
+                    updated.append(TranscriptEntry(role="user", text=msg.text))
+                    self._transcript = updated
+                else:
+                    updated = [
+                        e
+                        for e in self._transcript
+                        if not (e.role == "user" and e.partial)
+                    ]
+                    updated.append(
+                        TranscriptEntry(role="user", text=msg.text, partial=True)
+                    )
+                    self._transcript = updated
+
+                entry = self._transcript[-1]
+                all_entries = list(self._transcript)
+
+            elif msg.type == "response":
+                self._assist_buf += msg.text
+                current_text = self._assist_buf
+
+                updated = [
+                    e
+                    for e in self._transcript
+                    if not (e.role == "assistant" and e.partial)
+                ]
+                updated.append(
+                    TranscriptEntry(role="assistant", text=current_text, partial=True)
+                )
+                self._transcript = updated
+
+                entry = self._transcript[-1]
+                all_entries = list(self._transcript)
+
+            elif msg.type == "error":
+                logger.error("Server error: %s", msg.message)
+                if self.events.on_error:
+                    self.events.on_error(RuntimeError(msg.message))
+                return
+            else:
+                return
+
+        if self.events.on_transcript:
+            self.events.on_transcript(entry, all_entries)

streamcore-0.1.0/src/streamcore/types.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Callable
+
+
+class ConnectionStatus(str, Enum):
+    IDLE = "idle"
+    CONNECTING = "connecting"
+    CONNECTED = "connected"
+    ERROR = "error"
+    DISCONNECTED = "disconnected"
+
+
+@dataclass
+class TranscriptEntry:
+    role: str  # "user" or "assistant"
+    text: str
+    partial: bool = False
+
+
+@dataclass
+class DataChannelMessage:
+    type: str  # "transcript", "response", or "error"
+    text: str = ""
+    final: bool = False
+    message: str = ""  # for error type
+
+
+@dataclass
+class Config:
+    """Configuration for a StreamCoreAIClient."""
+
+    whip_endpoint: str = "http://localhost:8080/whip"
+    ice_servers: list[str] = field(
+        default_factory=lambda: ["stun:stun.l.google.com:19302"]
+    )
+
+
+@dataclass
+class EventHandler:
+    """Callbacks for voice agent events. All callbacks are optional."""
+
+    on_status_change: Callable[[ConnectionStatus], None] | None = None
+    on_transcript: Callable[[TranscriptEntry, list[TranscriptEntry]], None] | None = (
+        None
+    )
+    on_error: Callable[[Exception], None] | None = None
+    on_data_channel_message: Callable[[DataChannelMessage], None] | None = None

streamcore-0.1.0/src/streamcore/whip.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from urllib.parse import urlparse, urlunparse
+
+import aiohttp
+
+
+@dataclass
+class WhipResult:
+    answer_sdp: str
+    session_url: str
+
+
+async def whip_offer(endpoint: str, offer_sdp: str) -> WhipResult:
+    """Perform a WHIP signaling exchange per RFC 9725 §4.2.
+
+    POST an SDP offer, receive a 201 Created with SDP answer and Location header.
+    """
+    async with aiohttp.ClientSession() as session:
+        async with session.post(
+            endpoint,
+            data=offer_sdp,
+            headers={"Content-Type": "application/sdp"},
+        ) as resp:
+            if resp.status != 201:
+                body = await resp.text()
+                raise RuntimeError(f"WHIP: unexpected status {resp.status}: {body}")
+
+            answer_sdp = await resp.text()
+
+            location = resp.headers.get("Location", "")
+            session_url = location
+            if location and not location.startswith("http"):
+                parsed = urlparse(endpoint)
+                session_url = urlunparse(
+                    (parsed.scheme, parsed.netloc, location, "", "", "")
+                )
+
+            return WhipResult(answer_sdp=answer_sdp, session_url=session_url)
+
+
+async def whip_delete(session_url: str) -> None:
+    """Terminate a WHIP session per RFC 9725 §4.2.
+
+    Send HTTP DELETE to the WHIP session URL. Best-effort; errors are ignored.
+    """
+    if not session_url:
+        return
+    try:
+        timeout = aiohttp.ClientTimeout(total=3)
+        async with aiohttp.ClientSession(timeout=timeout) as session:
+            async with session.delete(session_url):
+                pass
+    except Exception:
+        pass

streamcore-0.1.0/src/streamcore.egg-info/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: streamcore
+Version: 0.1.0
+Summary: Python SDK for connecting to a Pion Voice Agent server via WebRTC + WHIP
+License-Expression: Apache-2.0
+Keywords: webrtc,whip,voice-agent,pion,real-time,audio
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiortc>=1.9.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: av>=12.0.0
+Requires-Dist: numpy>=1.24.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Dynamic: license-file
+
+# streamcore (Python)
+
+Python SDK for connecting to a [streamcore](https://github.com/streamcore/streamcore-server) server via WebRTC + WHIP, powered by [aiortc](https://github.com/aiortc/aiortc).
+
+## Requirements
+
+- **Python 3.10+**
+
+## Installation
+
+```bash
+pip install streamcore
+```
+
+Or install from source:
+
+```bash
+cd python-sdk
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import asyncio
+import numpy as np
+import streamcore
+
+
+async def main():
+    def on_transcript(entry, all_entries):
+        print(f"[{entry.role}] {entry.text}")
+
+    client = streamcore.Client(
+        config=streamcore.Config(whip_endpoint="http://localhost:8080/whip"),
+        events=streamcore.EventHandler(
+            on_transcript=on_transcript,
+            on_error=lambda err: print(f"Error: {err}"),
+        ),
+    )
+
+    await client.connect()
+
+    # Send a 20 ms frame of silence
+    pcm = np.zeros(streamcore.FRAME_SIZE, dtype=np.int16)
+    await client.send_pcm(pcm)
+
+    # Receive decoded audio from the agent
+    audio = await client.recv_pcm()  # numpy int16 array
+
+    await client.disconnect()
+
+
+asyncio.run(main())
+```
+
+## API
+
+### `Client(config?, events?)`
+
+Creates a new voice agent client.
+
+#### `Config`
+
+| Field           | Type         | Default                        | Description                 |
+| --------------- | ------------ | ------------------------------ | --------------------------- |
+| `whip_endpoint` | `str`        | `"http://localhost:8080/whip"` | WHIP signaling endpoint URL |
+| `ice_servers`   | `list[str]`  | `["stun:stun.l.google.com:19302"]` | ICE server URLs        |
+
+#### `EventHandler`
+
+| Callback                 | Signature                                                       | Description                           |
+| ------------------------ | --------------------------------------------------------------- | ------------------------------------- |
+| `on_status_change`       | `(status: ConnectionStatus) -> None`                            | Fired when connection status changes  |
+| `on_transcript`          | `(entry: TranscriptEntry, all: list[TranscriptEntry]) -> None`  | Fired on new or updated transcript    |
+| `on_error`               | `(error: Exception) -> None`                                    | Fired on connection or server errors  |
+| `on_data_channel_message`| `(msg: DataChannelMessage) -> None`                             | Fired for every raw DC message        |
+
+#### Methods
+
+| Method                          | Description                                                  |
+| ------------------------------- | ------------------------------------------------------------ |
+| `await client.connect(track?)`  | Connect via WHIP. Optionally pass an aiortc audio track.     |
+| `await client.disconnect()`     | Tear down connection and free resources.                     |
+| `await client.send_pcm(pcm)`   | Send a numpy int16 PCM buffer (mono 48 kHz) to the agent.   |
+| `await client.recv_pcm()`      | Receive decoded PCM audio as a numpy int16 array.            |
+| `client.status`                 | Current `ConnectionStatus`.                                  |
+| `client.transcript`             | Current conversation as `list[TranscriptEntry]`.             |
+| `client.remote_track`           | Inbound audio track from the agent (available after connect).|
+
+#### Audio Constants
+
+| Constant      | Value    | Description                      |
+| ------------- | -------- | -------------------------------- |
+| `SAMPLE_RATE` | `48000`  | Audio sample rate in Hz          |
+| `CHANNELS`    | `1`      | Number of channels (mono)        |
+| `FRAME_SIZE`  | `960`    | Samples per 20 ms frame          |
+
+## Audio I/O
+
+The SDK handles aiortc track management, `av.AudioFrame` construction, and
+resampling internally. Callers only deal with raw PCM data as numpy int16
+arrays:
+
+```python
+# Send microphone audio (960 samples = 20 ms at 48 kHz)
+await client.send_pcm(pcm_int16)
+
+# Receive agent audio
+audio = await client.recv_pcm()
+```
+
+If you need direct track access (e.g. for a custom aiortc pipeline), pass
+your own `AudioStreamTrack` via `client.connect(user_track=my_track)`.
+
+## Dependencies
+
+| Package  | Purpose                        |
+| -------- | ------------------------------ |
+| `aiortc` | WebRTC stack                   |
+| `aiohttp`| HTTP client for WHIP signaling |
+| `av`     | Audio frame encoding/decoding  |
+| `numpy`  | PCM audio buffers              |
+
+## License
+
+Apache-2.0

streamcore-0.1.0/src/streamcore.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+src/streamcore/__init__.py
+src/streamcore/audio.py
+src/streamcore/client.py
+src/streamcore/types.py
+src/streamcore/whip.py
+src/streamcore.egg-info/PKG-INFO
+src/streamcore.egg-info/SOURCES.txt
+src/streamcore.egg-info/dependency_links.txt
+src/streamcore.egg-info/requires.txt
+src/streamcore.egg-info/top_level.txt

streamcore-0.1.0/src/streamcore.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

streamcore-0.1.0/src/streamcore.egg-info/requires.txt

@@ -0,0 +1,8 @@
+aiortc>=1.9.0
+aiohttp>=3.9.0
+av>=12.0.0
+numpy>=1.24.0
+
+[dev]
+pytest
+pytest-asyncio

streamcore-0.1.0/src/streamcore.egg-info/top_level.txt

@@ -0,0 +1 @@
+streamcore