Module livekit.agents.cli.tcp_console

Classes

class TcpAudioInput
Expand source code 
class TcpAudioInput(io.AudioInput):
    """Audio input bridging the producer loop to the agent-session loop.

    push_frame runs on the transport host's loop while __anext__ runs on the
    agent-session loop; these differ when JobExecutorType.THREAD is used. Frames
    are marshalled onto the consumer loop via call_soon_threadsafe, so the queue
    is a plain asyncio.Queue owned by that loop (mirrors TcpAudioOutput).
    """

    def __init__(self) -> None:
        super().__init__(label="TCP Console")
        self._queue: asyncio.Queue[rtc.AudioFrame | object] = asyncio.Queue()
        self._loop: asyncio.AbstractEventLoop | None = None
        self._resampler = rtc.AudioResampler(
            input_rate=WIRE_SAMPLE_RATE,
            output_rate=AGENT_SAMPLE_RATE,
            num_channels=1,
        )
        self._closed = False

    def push_frame(self, frame: agent_pb.AgentSessionMessage.ConsoleIO.AudioFrame) -> None:
        # the consumer loop is captured on the first __anext__; frames pushed before
        # that startup window are dropped (same assumption as TcpAudioOutput).
        if self._closed or self._loop is None:
            return
        audio_frame = rtc.AudioFrame(
            data=frame.data,
            sample_rate=frame.sample_rate,
            num_channels=frame.num_channels,
            samples_per_channel=frame.samples_per_channel,
        )
        resampled = self._resampler.push(audio_frame)
        for rf in resampled:
            self._loop.call_soon_threadsafe(self._queue.put_nowait, rf)

    def close(self) -> None:
        """Unblock any waiting consumer and mark as closed."""
        self._closed = True
        if self._loop is not None:
            self._loop.call_soon_threadsafe(self._queue.put_nowait, _SENTINEL)

    async def __anext__(self) -> rtc.AudioFrame:
        if self._loop is None:
            self._loop = asyncio.get_running_loop()
        item = await self._queue.get()
        if item is _SENTINEL:
            raise StopAsyncIteration
        return cast(rtc.AudioFrame, item)

Audio input bridging the producer loop to the agent-session loop.

push_frame runs on the transport host's loop while anext runs on the agent-session loop; these differ when JobExecutorType.THREAD is used. Frames are marshalled onto the consumer loop via call_soon_threadsafe, so the queue is a plain asyncio.Queue owned by that loop (mirrors TcpAudioOutput).

Ancestors

Methods

def close(self) ‑> None
Expand source code 
def close(self) -> None:
    """Unblock any waiting consumer and mark as closed."""
    self._closed = True
    if self._loop is not None:
        self._loop.call_soon_threadsafe(self._queue.put_nowait, _SENTINEL)

Unblock any waiting consumer and mark as closed.

def push_frame(self, frame: agent_pb.AgentSessionMessage.ConsoleIO.AudioFrame) ‑> None
Expand source code 
def push_frame(self, frame: agent_pb.AgentSessionMessage.ConsoleIO.AudioFrame) -> None:
    # the consumer loop is captured on the first __anext__; frames pushed before
    # that startup window are dropped (same assumption as TcpAudioOutput).
    if self._closed or self._loop is None:
        return
    audio_frame = rtc.AudioFrame(
        data=frame.data,
        sample_rate=frame.sample_rate,
        num_channels=frame.num_channels,
        samples_per_channel=frame.samples_per_channel,
    )
    resampled = self._resampler.push(audio_frame)
    for rf in resampled:
        self._loop.call_soon_threadsafe(self._queue.put_nowait, rf)
class TcpAudioOutput (transport: TcpSessionTransport)
Expand source code 
class TcpAudioOutput(io.AudioOutput):
    def __init__(self, transport: TcpSessionTransport) -> None:
        super().__init__(
            label="TCP Console",
            next_in_chain=None,
            sample_rate=AGENT_SAMPLE_RATE,
            capabilities=io.AudioOutputCapabilities(pause=True),
        )
        self._transport = transport
        self._resampler = rtc.AudioResampler(
            input_rate=AGENT_SAMPLE_RATE,
            output_rate=WIRE_SAMPLE_RATE,
            num_channels=1,
        )

        self._pushed_duration: float = 0.0
        self._capture_start: float = 0.0
        self._flush_task: asyncio.Task[None] | None = None
        self._playout_done = asyncio.Event()
        self._interrupted_ev = asyncio.Event()
        self._agent_loop: asyncio.AbstractEventLoop | None = None

    async def capture_frame(self, frame: rtc.AudioFrame) -> None:
        await super().capture_frame(frame)

        if self._agent_loop is None:
            self._agent_loop = asyncio.get_running_loop()

        if self._flush_task and not self._flush_task.done():
            logger.error("capture_frame called while previous flush is in progress")
            await self._flush_task

        if not self._pushed_duration:
            self._capture_start = time.monotonic()
            self.on_playback_started(created_at=time.time())

        self._pushed_duration += frame.duration

        resampled = self._resampler.push(frame)
        for rf in resampled:
            audio_frame = agent_pb.AgentSessionMessage.ConsoleIO.AudioFrame(
                data=bytes(rf.data),
                sample_rate=WIRE_SAMPLE_RATE,
                num_channels=rf.num_channels,
                samples_per_channel=rf.samples_per_channel,
            )
            msg = agent_pb.AgentSessionMessage(audio_output=audio_frame)
            self._transport.send_message_threadsafe(msg)

    def flush(self) -> None:
        super().flush()
        msg = agent_pb.AgentSessionMessage(
            audio_playback_flush=agent_pb.AgentSessionMessage.ConsoleIO.AudioPlaybackFlush()
        )
        self._transport.send_message_threadsafe(msg)

        if self._pushed_duration:
            if self._flush_task and not self._flush_task.done():
                logger.error("flush called while previous flush is in progress")
                self._flush_task.cancel()

            self._playout_done.clear()
            self._interrupted_ev.clear()
            self._flush_task = asyncio.create_task(self._wait_for_playout())

    def clear_buffer(self) -> None:
        msg = agent_pb.AgentSessionMessage(
            audio_playback_clear=agent_pb.AgentSessionMessage.ConsoleIO.AudioPlaybackClear()
        )
        self._transport.send_message_threadsafe(msg)

        if self._pushed_duration:
            self._interrupted_ev.set()

    def notify_playout_finished(self) -> None:
        if self._agent_loop is not None:
            self._agent_loop.call_soon_threadsafe(self._playout_done.set)
        else:
            self._playout_done.set()

    async def _wait_for_playout(self) -> None:
        wait_done = asyncio.create_task(self._playout_done.wait())
        wait_interrupt = asyncio.create_task(self._interrupted_ev.wait())
        try:
            await asyncio.wait(
                [wait_done, wait_interrupt],
                return_when=asyncio.FIRST_COMPLETED,
            )
            interrupted = wait_interrupt.done() and not wait_done.done()
        finally:
            wait_done.cancel()
            wait_interrupt.cancel()

        if interrupted:
            played = time.monotonic() - self._capture_start
            played = min(max(0, played), self._pushed_duration)
        else:
            played = self._pushed_duration

        self.on_playback_finished(playback_position=played, interrupted=interrupted)

        self._pushed_duration = 0.0
        self._interrupted_ev.clear()

Helper class that provides a standard way to create an ABC using inheritance.

Args

sample_rate
The sample rate required by the audio sink, if None, any sample rate is accepted

Ancestors

Methods

def notify_playout_finished(self) ‑> None
Expand source code 
def notify_playout_finished(self) -> None:
    if self._agent_loop is not None:
        self._agent_loop.call_soon_threadsafe(self._playout_done.set)
    else:
        self._playout_done.set()

Inherited members