Merge pull request #59 from daily-co/remove-requirements

Remove unused requirements file

LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2024, Daily
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,8 +1,82 @@
-# dailyai SDK
+# dailyai — an open source framework for real-time, multi-modal, conversational AI applications
 
-This SDK can help you build applications that participate in WebRTC meetings and use various AI services to interact with other participants.
+Build things like this:
 
-## Build/Install
+[![AI-powered voice patient intake for healthcare](https://img.youtube.com/vi/lDevgsp9vn0/0.jpg)](https://www.youtube.com/watch?v=lDevgsp9vn0)
+
+
+
+
+**`dailyai` started as a toolkit for implementing generative AI voice bots.** Things like personal coaches, meeting assistants, story-telling toys for kids, customer support bots, and snarky social companions. 
+
+
+In 2023 a *lot* of us got excited about the possibility of having open-ended conversations with LLMs. It became clear pretty quickly that we were all solving the same [low-level problems](https://www.daily.co/blog/how-to-talk-to-an-llm-with-your-voice/):
+- low-latency, reliable audio transport
+- echo cancellation 
+- phrase endpointing (knowing when the bot should respond to human speech)
+- interruptibility
+- writing clean code to stream data through "pipelines" of speech-to-text, LLM inference, and text-to-speech models
+
+As our applications expanded to include additional things like image generation, function calling, and vision models, we started to think about what a complete framework for these kinds of apps could look like.
+
+Today, `dailyai` is:
+
+1. a set of code building blocks for interacting with generative AI services and creating low-latency, interruptible data pipelines that use multiple services
+2. transport services that moves audio, video, and events across the Internet
+3. implementations of specific generative AI services
+
+Currently implemented services:
+- Speech-to-text
+  - Deepgram
+  - Whisper
+- LLMs
+  - Azure
+  - OpenAI
+- Image generation
+  - Azure
+  - Fal
+  - OpenAI
+- Text-to-speech
+  - Azure
+  - Deepgram
+  - ElevenLabs
+- Transport
+  - Daily
+  - Local (in progress, intended as a quick start example service)
+
+If you'd like to [implement a service]((https://github.com/daily-co/daily-ai-sdk/tree/main/src/dailyai/services)), we welcome PRs! Our goal is to support lots of services in all of the above categories, plus new categories (like real-time video) as they emerge.
+
+## Step 1: Get started
+
+Today, the easiest way to get started with `dailyai` is to use [Daily](https://www.daily.co/) as your transport service. This toolkit started life as an internal SDK at Daily and millions of minutes of AI conversation have been served using it and its earlier prototype incarnations. (The [transport base class](https://github.com/daily-co/daily-ai-sdk/blob/main/src/dailyai/services/base_transport_service.py) is easy to extend, though, so feel free to submit PRs if you'd like to implement another transport service.)
+
+```
+# install the module
+pip install dailyai
+
+# set up an .env file with API keys
+# for example
+OPENAI_API_KEY=...
+ELEVENLABS_API_KEY=...
+ELEVENLABS_VOICE_ID=...
+DAILY_SAMPLE_ROOM_URL=https://...
+
+# sign up for a free Daily account, if you don't already have one, and
+# join the Daily room URL directly from a browser tab, then run one of the
+# samples
+python src/examples/foundational/02-llm-say-one-thing.py
+```
+
+## Code examples
+
+There are two directories of examples:
+
+- [foundational](https://github.com/daily-co/daily-ai-sdk/tree/main/src/examples/foundational) — demos that build on each other, introducing one or two concepts at a time
+- [starter apps](https://github.com/daily-co/daily-ai-sdk/tree/main/src/examples/starter-apps) — complete applications that you can use as starting points for development
+
+
+
+## Hacking on the framework itself
 
 _Note that you may need to set up a virtual environment before following the instructions below. For instance, you might need to run the following from the root of the repo:_
 
@@ -30,111 +104,3 @@ If you want to use this package from another directory, you can run:
 pip install path_to_this_repo
 ```
 
-## Running the samples
-
-Tou can run the simple sample like so:
-
-```
-python src/samples/theoretical-to-real/01-say-one-thing.py -u <url of your Daily meeting> -k <your Daily API Key>
-```
-
-Note that the sample uses Azure's TTS and LLM services. You'll need to set the following environment variables for the sample to work:
-
-```
-AZURE_SPEECH_SERVICE_KEY
-AZURE_SPEECH_SERVICE_REGION
-AZURE_CHATGPT_KEY
-AZURE_CHATGPT_ENDPOINT
-AZURE_CHATGPT_DEPLOYMENT_ID
-```
-
-If you have those environment variables stored in an .env file, you can quickly load them into your terminal's environment by running this:
-
-```bash
-export $(grep -v '^#' .env | xargs)
-```
-
-## Overview
-The Daily AI SDK allows you to build applications that can participate in WebRTC sessions and interact with AI Services. Some examples of what you can build with this:
-* conversational bots that interact 1:1 with a user, using voice recognition and text-to-speech
-* assistant bots that aggregate transcriptions from multiple participants in a meeting and provide realtime summaries or other AI-generated output.
-* image-recognition bots
-* etc
-## Concepts
-### Transport Service
-The SDK provides one “transport service”, which is a wrapper around Daily’s `daily-python` client (tk add link). You can use this service to listen for events related to a WebRTC session, such as “a participant joined the meeting”.
-The transport service also exposes a send queue, and a receive queue. You can use the send queue to send audio and video to the WebRTC session, and you can listen to the receive queue to see audio, video and transcription data from the WebRTC session.
-### AI Services
-The AI Service classes provide wrappers around various AI providers, and allow you to query LLMs, convert text to speech and make images from text. The audio and images can then be placed on the transport service’s send queue, where they’ll be sent to the WebRTC session.
-### Queue Frames
-Communication between the transport service and AI services, and between various AI services, takes place in Queue Frames. These frames contain an indication of the type of data as well as the data itself.
-## Using Transports, AI Services and Frames
-AI Services all define a `.run` method. This method consumes and generates `QueueFrame` frames. The kind of frames that can be consumed and generated depend on the kind of service. For instance, an LLM AI Service consumes `LLM_MESSAGE` frames (which define a history of interaction with an LLM) and emit `TEXT` frames (the response from the LLM).
-
-The `.run` method is an `AsyncIterable`, and it takes an `iterable`, `AsyncIterable` or `asyncio.Queue` that produces QueueFrames as a parameter. This makes it easy to chain AI Services, and consume input from the Transport’s `receive_queue` .
-
-AI Services also have a `.run_to_queue` method. This method is not an AsyncIterable, but instead sends processed QueueFrames to a queue. This makes it easy to send the output of an AI Service to the Transport’s `send_queue`.
-
-AI Services also define convenience functions that let you bypass creating QueueFrames for some simple cases (eg. using the TTS service to convert a string to audio output and send that audio to the transport’s `send_queue`). See below for examples.
-## Examples
-### Say Something
-The base TTS AI service exposes a `.say` method. After creating a transport and TTS service, you can use this method like so:
-```
-transport = DailyTransportService(...)
-tts = AzureTTSService()
-await tts.say("hello world", transport.send_queue)
-```
-This will call the TTS service to render the text to audio frames, then put the audio frames on the transport’s send queue. The transport will then send those frames along to the WebRTC session.
-
-### Speak an LLM response
-Given a system prompt contained in a `messages` array, you can emit the LLM’s response as audio with a chain like this:
-```
-transport = DailyTransportService(...) # setup parameters omitted
-tts = AzureTTSService()
-llm = AzureLLMService()
-messages = [...] # system prompt omitted for brevity
-
-await tts.run_to_queue(
-  transport.send_queue,
-  llm.run([QueueFrame.LLM_MESSAGES, messages])
-)
-```
-In this code, the LLM service object sends the messages to Azure’s OpenAI implementation, which streams chunks back asynchronously. Those chunks are aggregated by the TTS Service to ensure the best audio response (TTS works best when it gets complete sentence, so it can inflect correctly), then sent to Azure’s TTS service, converted to audio frames, and sent to the WebRTC session via the Daily transport.
-
-### Pre-cache an LLM response
-Sometimes LLMs can be slower than we’d like for natural-feeling communication. Here’s an example where we take advantage of the time it takes to speak some pre-defined text to get a head start on the LLM response:
-
-(TK link to 04- sample)
-
-In this sample, we set up a buffer queue to receive the audio frames from the LLM response before while we are joining the call and start an asynchronous task to start filling this buffer:
-```
-    buffer_queue = asyncio.Queue()
-    llm_response_task = asyncio.create_task(
-        elevenlabs_tts.run_to_queue(
-            buffer_queue,
-            llm.run([QueueFrame(FrameType.LLM_MESSAGE, messages)]),
-            True,
-        )
-    )
-```
-
-Then, when we’ve joined the call, we speak the static text:
-```
-        await azure_tts.say("My friend...", transport.send_queue)
-```
-
-As that text is being spoken, the asynchronous LLM task continues in the background. When the text is done, we pull the frames off the buffer queue and put them in the transport’s `send_queue`:
-```
-        async def buffer_to_send_queue():
-            while True:
-                frame = await buffer_queue.get()
-                await transport.send_queue.put(frame)
-                buffer_queue.task_done()
-                if frame.frame_type == FrameType.END_STREAM:
-                    break
-
-        await asyncio.gather(llm_response_task, buffer_to_send_queue())
-
-```
-
-One thing to note here is the last parameter to `run_to_queue` in the first code clause above: this causes the `run_to_queue` method to send an `END_STREAM` frame when it’s done rendering. This lets us know when to stop our `buffer_to_send_queue` task above.

docs/README.md

@@ -0,0 +1,13 @@
+# Daily AI SDK Docs
+
+## [Architecture Overview](architecture.md)
+
+Learn about the thinking behind the SDK's design.
+
+## [Example Code](examples/)
+
+The repo includes several example apps in the `src/examples` directory. The docs explain how they work.
+
+## [API Reference](api/)
+
+Complete documentation of the available classes and methods in the SDK.

docs/architecture.md

@@ -0,0 +1,2 @@
+# Daily AI SDK Architecture Guide
+

docs/examples/01-say-one-thing.md

@@ -0,0 +1,119 @@
+# 01: Say One Thing
+
+_video here - youtube?_
+
+This example uses a text-to-speech (TTS) service to say one predefined sentence. But first, a quick overview of the general structure of these examples.
+
+## Running the demos
+
+All of the demos have something like this at the bottom of the file:
+
+```python
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url, token))
+```
+
+### `configure()`
+
+The `configure()` function comes from `src/examples/foundational/support/runner.py`, and it allows you to configure the examples from the command line directly, or using environment variables:
+
+```bash
+python 01-say-one-thing.py -u https://YOUR_DOMAIN.daily.co/YOUR_ROOM -k YOUR_API_KEY
+# or
+DAILY_ROOM_URL=https://YOUR_DOMAIN.daily.co/YOUR_ROOM DAILY_API_KEY=YOUR_API_KEY python 01-say-one-thing.py
+# or set DAILY_ROOM_URL and DAILY_API_KEY in a .env file
+python 01-say-one-thing.py
+```
+
+You'll need a Daily account to run these demos. You can sign up for free at [daily.co](https://daily.co). Once you've signed up you can create a room from the [Dashboard](https://dashboard.daily.co/rooms), and grab [your API key](https://dashboard.daily.co/developers) while you're there.
+
+Some functionality (such as transcription) requires the bot to have owner privileges in the room. `runner.py` uses the Daily REST API to create a meeting token with owner privileges. You can learn more about meeting tokens in the [Daily docs](https://docs.daily.co/reference/rest-api/meeting-tokens).
+
+### `asyncio.run()`
+
+The AI SDK makes heavy use of Python's `asyncio` module. [This is a reasonable intro to the topic](https://builtin.com/data-science/asyncio) if you haven't worked with `asyncio` and coroutines before.
+
+You can learn a bit more about the specifics of how the Daily AI SDK uses coroutines in the [Architecture Guide](../architecture.md).
+
+## The `main()` function
+
+All of the examples have a `main()` function with a similar structure:
+
+- Configure the transport
+- Configure the AI service(s) used in the demo
+- Configure any event listeners
+- Define a processing pipeline
+- Run the example's coroutine(s)
+
+### Configuring the transport
+
+The first section of the `main()` function configures the transport object:
+
+```python
+meeting_duration_minutes = 5
+transport = DailyTransportService(
+    room_url,
+    None,
+    "Say One Thing",
+    meeting_duration_minutes,
+)
+transport.mic_enabled = True
+```
+
+The [Architecture Guide](../architecture.md) explains the transport object in more detail. In this case, we're configuring a Daily transport object and enabling the virtual microphone, so our bot can play audio.
+
+### Configuring the services
+
+As described in the [Architecture Guide](../architecture.md), 'a 'Service' is a class that processes 'Frames' as part of a 'Pipeline'. In this demo app, we'll only need one service: a text-to-speech generator. We can create an instance of the `ElevenLabsTTSService` class with this line of code:
+
+```python
+tts = ElevenLabsTTSService(aiohttp_session=session, api_key=os.getenv("ELEVENLABS_API_KEY"), voice_id=os.getenv("ELEVENLABS_VOICE_ID"))
+```
+
+You'll need to make sure and set those environment variables somewhere. The easiest way to do that is to copy the `example.env` file in the repo and rename it to `.env`, and then add your credentials to that file. `runner.py` loads the `python-dotenv` module and initializes it, making the values in that file available in the environment.
+
+### Configuring event listeners
+
+This part isn't strictly necessary for an app like this. You could include the contents of the `on_participant_joined` function directly in the body of the `main()` function, and it would run as soon as you started the script from the command line.
+
+Instead, we can use an event handler to wait to run that code until someone else joins the meeting. We'll define a function called `greet_user()`, and use the `@transport.event_handler("on_participant_joined")` decorator to tell the SDK that we want to run that function whenever a user joins the room.
+
+```python
+@transport.event_handler("on_participant_joined")
+async def greet_user(transport, participant):
+    if participant["info"]["isLocal"]:
+        return
+
+    await tts.say(
+        "Hello there, " + participant["info"]["userName"] + "!",
+        transport.send_queue,
+    )
+
+    # wait for the output queue to be empty, then leave the meeting
+    await transport.stop_when_done()
+```
+
+### Defining a processing pipeline
+
+In this example, we don't actually have much of a processing pipeline! In fact, we're doing the whole thing inside the `greet_user()` function already.
+
+Pipelines usually look like a bunch of nested calls to the `run()` or `run_to_queue()` function from different Services. In this example, we're using the `say()` function from the TTS service. This is effectively a convenience wrapper around the `run_to_queue()` function, which we'll discuss more later. It's important to `await` this function to ensure that the speech frames are queued for playback before the next line of code, because of the `stop_when_done()` function being called immediately afterward.
+
+The output of the `say()` function goes to the transport's `send_queue`. This queue is the all-important connection between the world of the Services pipeline that's generating frames asynchronously and the ordered playback of audio and visual media in the WebRTC call.
+
+### Running the coroutines
+
+In this example, we don't actually have any separate processing pipelines—everything happens as a result of an event from the transport. So we only need to run the transport's coroutine, and await its completion:
+
+```python
+await transport.run()
+```
+
+In future examples, we'll run more processes in parallel. For now, this script can run until the transport exits—which will happen based on calling `stop_when_done()` in the `greet_user()` function.
+
+## Next Steps
+
+Next, we'll start connecting multiple AI services together by building a service pipeline.
+
+## [02 - LLM Say One Thing »](02-llm-say-one-thing.md)

docs/examples/README.md

@@ -0,0 +1,5 @@
+# Daily AI SDK Examples
+
+The docs in this folder pair with the example apps located in `src/examples/foundational`. They are designed to serve as a quick references for building different kinds of AI apps. But the examples also build on one another, so it can be really helpful to walk through them in order.
+
+To start, you can learn about the overall structure of the examples in [01 - Say One Thing](01-say-one-thing.md).

pyproject.toml

@@ -3,22 +3,43 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "daily_ai"
+name = "dailyai"
 version = "0.0.1"
-description = "Orchestrator for AI bots with Daily"
-dependencies = [
-    "daily-python",
-    "Pillow",
-    "typing-extensions",
-    "openai",
-    "google-cloud-texttospeech",
-    "azure-cognitiveservices-speech",
-    "pyht",
-    "opentelemetry-sdk",
-    "aiohttp",
-    "fal",
-    "faster_whisper"
+description = "An open source framework for real-time, multi-modal, conversational AI applications"
+license = { text = "BSD 2-Clause License" }
+readme = "README.md"
+requires-python = ">=3.7"
+keywords = ["webrtc", "audio", "video", "ai"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Topic :: Communications :: Conferencing",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence"
 ]
+dependencies = [
+    "aiohttp",
+    "azure-cognitiveservices-speech",
+    "daily-python",
+    "fal",
+    "faster_whisper",
+    "google-cloud-texttospeech",
+    "numpy",
+    "openai",
+    "Pillow",
+    "pyht",
+    "python-dotenv",
+    "torch",
+    "torchaudio",
+    "pyaudio",
+    "typing-extensions"
+]
+
+[project.urls]
+Source = "https://github.com/daily-co/daily-ai-sdk"
+Website = "https://daily.co"
 
 [tool.setuptools.packages.find]
 # All the following settings are optional:

requirements.txt

@@ -1,4 +1,4 @@
 autopep8==2.0.4
 build==1.0.3
 packaging==23.2
-pyproject_hooks==1.0.0
+pyproject_hooks==1.0.0

src/dailyai/conversation_wrappers.py

@@ -1,76 +0,0 @@
-import asyncio
-import copy
-import functools
-from typing import AsyncGenerator, Awaitable, Callable
-from dailyai.queue_aggregators import LLMContextAggregator
-from dailyai.queue_frame import EndStreamQueueFrame, QueueFrame, TranscriptionQueueFrame
-
-class InterruptibleConversationWrapper:
-
-    def __init__(
-        self,
-        frame_generator: Callable[[], AsyncGenerator[QueueFrame, None]],
-        runner: Callable[
-            [str, LLMContextAggregator, LLMContextAggregator], Awaitable[None]
-        ],
-        interrupt: Callable[[], None],
-        my_participant_id: str|None,
-        llm_messages: list[dict[str, str]],
-        llm_context_aggregator_in=LLMContextAggregator,
-        llm_context_aggregator_out=LLMContextAggregator,
-        delay_before_speech_seconds: float = 1.0,
-    ):
-        self._frame_generator: Callable[[], AsyncGenerator[QueueFrame, None]] = frame_generator
-        self._runner: Callable[
-            [str, LLMContextAggregator, LLMContextAggregator], Awaitable[None]
-        ] = runner
-        self._interrupt: Callable[[], None] = interrupt
-        self._my_participant_id = my_participant_id
-        self._messages: list[dict[str, str]] = llm_messages
-        self._delay_before_speech_seconds = delay_before_speech_seconds
-        self._llm_context_aggregator_in = llm_context_aggregator_in
-        self._llm_context_aggregator_out = llm_context_aggregator_out
-
-        self._current_phrase = ""
-
-    def update_messages(self, new_messages: list[dict[str, str]], task: asyncio.Task | None):
-        if task:
-            if not task.cancelled():
-                self._current_phrase = ""
-                self._messages = new_messages
-
-    async def speak_after_delay(self, user_speech, messages):
-        await asyncio.sleep(self._delay_before_speech_seconds)
-        tma_in = self._llm_context_aggregator_in(
-            messages, "user", self._my_participant_id, False
-        )
-        tma_out = self._llm_context_aggregator_out(
-            messages, "assistant", self._my_participant_id
-        )
-
-        await self._runner(user_speech, tma_in, tma_out)
-
-    async def run_conversation(self):
-        current_response_task = None
-
-        async for frame in self._frame_generator():
-            if isinstance(frame, EndStreamQueueFrame):
-                break
-            elif not isinstance(frame, TranscriptionQueueFrame):
-                continue
-
-            if frame.participantId == self._my_participant_id:
-                continue
-
-            if current_response_task:
-                current_response_task.cancel()
-                self._interrupt()
-
-            self._current_phrase += " " + frame.text
-            current_llm_messages = copy.deepcopy(self._messages)
-            current_response_task = asyncio.create_task(
-                self.speak_after_delay(self._current_phrase, current_llm_messages)
-            )
-            current_response_task.add_done_callback(
-                functools.partial(self.update_messages, current_llm_messages)
-            )

src/dailyai/pipeline/aggregators.py

@@ -0,0 +1,383 @@
+import asyncio
+import re
+
+from dailyai.pipeline.frame_processor import FrameProcessor
+
+from dailyai.pipeline.frames import (
+    EndFrame,
+    AudioFrame,
+    EndPipeFrame,
+    Frame,
+    ImageFrame,
+    LLMMessagesQueueFrame,
+    LLMResponseEndFrame,
+    LLMResponseStartFrame,
+    TextFrame,
+    TranscriptionQueueFrame,
+    UserStartedSpeakingFrame,
+    UserStoppedSpeakingFrame,
+)
+from dailyai.pipeline.pipeline import Pipeline
+from dailyai.services.ai_services import AIService
+
+from typing import AsyncGenerator, Callable, Coroutine, List
+
+from dailyai.services.openai_llm_context import OpenAILLMContext
+
+
+class ResponseAggregator(FrameProcessor):
+
+    def __init__(
+        self,
+        *,
+        messages: list[dict] | None,
+        role: str,
+        start_frame,
+        end_frame,
+        accumulator_frame,
+        pass_through=True,
+    ):
+        self.aggregation = ""
+        self.aggregating = False
+        self.messages = messages
+        self._role = role
+        self._start_frame = start_frame
+        self._end_frame = end_frame
+        self._accumulator_frame = accumulator_frame
+        self._pass_through = pass_through
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if not self.messages:
+            return
+
+        if isinstance(frame, self._start_frame):
+            self.aggregating = True
+        elif isinstance(frame, self._end_frame):
+            self.aggregating = False
+            # Sometimes VAD triggers quickly on and off. If we don't get any transcription,
+            # it creates empty LLM message queue frames
+            if len(self.aggregation) > 0:
+                self.messages.append({"role": self._role, "content": self.aggregation})
+                self.aggregation = ""
+                yield self._end_frame()
+                yield LLMMessagesQueueFrame(self.messages)
+        elif isinstance(frame, self._accumulator_frame) and self.aggregating:
+            self.aggregation += f" {frame.text}"
+            if self._pass_through:
+                yield frame
+        else:
+            yield frame
+
+
+class LLMResponseAggregator(ResponseAggregator):
+    def __init__(self, messages: list[dict]):
+        super().__init__(
+            messages=messages,
+            role="assistant",
+            start_frame=LLMResponseStartFrame,
+            end_frame=LLMResponseEndFrame,
+            accumulator_frame=TextFrame,
+        )
+
+
+class UserResponseAggregator(ResponseAggregator):
+    def __init__(self, messages: list[dict]):
+        super().__init__(
+            messages=messages,
+            role="user",
+            start_frame=UserStartedSpeakingFrame,
+            end_frame=UserStoppedSpeakingFrame,
+            accumulator_frame=TranscriptionQueueFrame,
+            pass_through=False,
+        )
+
+
+class LLMContextAggregator(AIService):
+    def __init__(
+        self,
+        messages: list[dict],
+        role: str,
+        bot_participant_id=None,
+        complete_sentences=True,
+        pass_through=True,
+    ):
+        super().__init__()
+        self.messages = messages
+        self.bot_participant_id = bot_participant_id
+        self.role = role
+        self.sentence = ""
+        self.complete_sentences = complete_sentences
+        self.pass_through = pass_through
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        # We don't do anything with non-text frames, pass it along to next in the pipeline.
+        if not isinstance(frame, TextFrame):
+            yield frame
+            return
+
+        # Ignore transcription frames from the bot
+        if isinstance(frame, TranscriptionQueueFrame):
+            if frame.participantId == self.bot_participant_id:
+                return
+
+        # The common case for "pass through" is receiving frames from the LLM that we'll
+        # use to update the "assistant" LLM messages, but also passing the text frames
+        # along to a TTS service to be spoken to the user.
+        if self.pass_through:
+            yield frame
+
+        # TODO: split up transcription by participant
+        if self.complete_sentences:
+            # type: ignore -- the linter thinks this isn't a TextQueueFrame, even
+            # though we check it above
+            self.sentence += frame.text
+            if self.sentence.endswith((".", "?", "!")):
+                self.messages.append({"role": self.role, "content": self.sentence})
+                self.sentence = ""
+                yield LLMMessagesQueueFrame(self.messages)
+        else:
+            # type: ignore -- the linter thinks this isn't a TextQueueFrame, even
+            # though we check it above
+            self.messages.append({"role": self.role, "content": frame.text})
+            yield LLMMessagesQueueFrame(self.messages)
+
+
+class LLMUserContextAggregator(LLMContextAggregator):
+    def __init__(
+        self, messages: list[dict], bot_participant_id=None, complete_sentences=True
+    ):
+        super().__init__(
+            messages, "user", bot_participant_id, complete_sentences, pass_through=False
+        )
+
+
+class LLMAssistantContextAggregator(LLMContextAggregator):
+    def __init__(
+        self, messages: list[dict], bot_participant_id=None, complete_sentences=True
+    ):
+        super().__init__(
+            messages,
+            "assistant",
+            bot_participant_id,
+            complete_sentences,
+            pass_through=True,
+        )
+
+
+class SentenceAggregator(FrameProcessor):
+    """This frame processor aggregates text frames into complete sentences.
+
+    Frame input/output:
+        TextFrame("Hello,") -> None
+        TextFrame(" world.") -> TextFrame("Hello world.")
+
+    Doctest:
+    >>> async def print_frames(aggregator, frame):
+    ...     async for frame in aggregator.process_frame(frame):
+    ...         print(frame.text)
+
+    >>> aggregator = SentenceAggregator()
+    >>> asyncio.run(print_frames(aggregator, TextFrame("Hello,")))
+    >>> asyncio.run(print_frames(aggregator, TextFrame(" world.")))
+    Hello, world.
+    """
+
+    def __init__(self):
+        self.aggregation = ""
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, TextFrame):
+            m = re.search("(.*[?.!])(.*)", frame.text)
+            if m:
+                yield TextFrame(self.aggregation + m.group(1))
+                self.aggregation = m.group(2)
+            else:
+                self.aggregation += frame.text
+        elif isinstance(frame, EndFrame):
+            if self.aggregation:
+                yield TextFrame(self.aggregation)
+            yield frame
+        else:
+            yield frame
+
+
+class LLMFullResponseAggregator(FrameProcessor):
+    """This class aggregates Text frames until it receives a
+    LLMResponseEndFrame, then emits the concatenated text as
+    a single text frame.
+
+    given the following frames:
+
+        TextFrame("Hello,")
+        TextFrame(" world.")
+        TextFrame(" I am")
+        TextFrame(" an LLM.")
+        LLMResponseEndFrame()]
+
+    this processor will yield nothing for the first 4 frames, then
+
+        TextFrame("Hello, world. I am an LLM.")
+        LLMResponseEndFrame()
+
+    when passed the last frame.
+
+    >>> async def print_frames(aggregator, frame):
+    ...     async for frame in aggregator.process_frame(frame):
+    ...         if isinstance(frame, TextFrame):
+    ...             print(frame.text)
+    ...         else:
+    ...             print(frame.__class__.__name__)
+
+    >>> aggregator = LLMFullResponseAggregator()
+    >>> asyncio.run(print_frames(aggregator, TextFrame("Hello,")))
+    >>> asyncio.run(print_frames(aggregator, TextFrame(" world.")))
+    >>> asyncio.run(print_frames(aggregator, TextFrame(" I am")))
+    >>> asyncio.run(print_frames(aggregator, TextFrame(" an LLM.")))
+    >>> asyncio.run(print_frames(aggregator, LLMResponseEndFrame()))
+    Hello, world. I am an LLM.
+    LLMResponseEndFrame
+    """
+
+    def __init__(self):
+        self.aggregation = ""
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, TextFrame):
+            self.aggregation += frame.text
+        elif isinstance(frame, LLMResponseEndFrame):
+            yield TextFrame(self.aggregation)
+            yield frame
+            self.aggregation = ""
+        else:
+            yield frame
+
+
+class StatelessTextTransformer(FrameProcessor):
+    """This processor calls the given function on any text in a text frame.
+
+    >>> async def print_frames(aggregator, frame):
+    ...     async for frame in aggregator.process_frame(frame):
+    ...         print(frame.text)
+
+    >>> aggregator = StatelessTextTransformer(lambda x: x.upper())
+    >>> asyncio.run(print_frames(aggregator, TextFrame("Hello")))
+    HELLO
+    """
+
+    def __init__(self, transform_fn):
+        self.transform_fn = transform_fn
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, TextFrame):
+            result = self.transform_fn(frame.text)
+            if isinstance(result, Coroutine):
+                result = await result
+
+            yield TextFrame(result)
+        else:
+            yield frame
+
+
+class ParallelPipeline(FrameProcessor):
+    """Run multiple pipelines in parallel.
+
+    This class takes frames from its source queue and sends them to each
+    sub-pipeline. Each sub-pipeline emits its frames into this class's
+    sink queue. No guarantees are made about the ordering of frames in
+    the sink queue (that is, no sub-pipeline has higher priority than
+    any other, frames are put on the sink in the order they're emitted
+    by the sub-pipelines).
+
+    After each frame is taken from this class's source queue and placed
+    in each sub-pipeline's source queue, an EndPipeFrame is put on each
+    sub-pipeline's source queue. This indicates to the sub-pipe runner
+    that it should exit.
+
+    Since frame handlers pass through unhandled frames by convention, this
+    class de-dupes frames in its sink before yielding them.
+    """
+
+    def __init__(self, pipeline_definitions: List[List[FrameProcessor]]):
+        self.sources = [asyncio.Queue() for _ in pipeline_definitions]
+        self.sink: asyncio.Queue[Frame] = asyncio.Queue()
+        self.pipelines: list[Pipeline] = [
+            Pipeline(
+                pipeline_definition,
+                source,
+                self.sink,
+            )
+            for source, pipeline_definition in zip(self.sources, pipeline_definitions)
+        ]
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        for source in self.sources:
+            await source.put(frame)
+            await source.put(EndPipeFrame())
+
+        await asyncio.gather(*[pipeline.run_pipeline() for pipeline in self.pipelines])
+
+        seen_ids = set()
+        while not self.sink.empty():
+            frame = await self.sink.get()
+
+            # de-dup frames. Because the convention is to yield a frame that isn't processed,
+            # each pipeline will likely yield the same frame, so we will end up with _n_ copies
+            # of unprocessed frames where _n_ is the number of parallel pipes that don't
+            # process that frame.
+            if id(frame) in seen_ids:
+                continue
+            seen_ids.add(id(frame))
+
+            # Skip passing along EndParallelPipeQueueFrame, because we use them for our own flow control.
+            if not isinstance(frame, EndPipeFrame):
+                yield frame
+
+
+class GatedAggregator(FrameProcessor):
+    """Accumulate frames, with custom functions to start and stop accumulation.
+    Yields gate-opening frame before any accumulated frames, then ensuing frames
+    until and not including the gate-closed frame.
+
+    >>> async def print_frames(aggregator, frame):
+    ...     async for frame in aggregator.process_frame(frame):
+    ...         if isinstance(frame, TextFrame):
+    ...             print(frame.text)
+    ...         else:
+    ...             print(frame.__class__.__name__)
+
+    >>> aggregator = GatedAggregator(
+    ...     gate_close_fn=lambda x: isinstance(x, LLMResponseStartFrame),
+    ...     gate_open_fn=lambda x: isinstance(x, ImageFrame),
+    ...     start_open=False)
+    >>> asyncio.run(print_frames(aggregator, TextFrame("Hello")))
+    >>> asyncio.run(print_frames(aggregator, TextFrame("Hello again.")))
+    >>> asyncio.run(print_frames(aggregator, ImageFrame(url='', image=bytes([]))))
+    ImageFrame
+    Hello
+    Hello again.
+    >>> asyncio.run(print_frames(aggregator, TextFrame("Goodbye.")))
+    Goodbye.
+    """
+
+    def __init__(self, gate_open_fn, gate_close_fn, start_open):
+        self.gate_open_fn = gate_open_fn
+        self.gate_close_fn = gate_close_fn
+        self.gate_open = start_open
+        self.accumulator: List[Frame] = []
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if self.gate_open:
+            if self.gate_close_fn(frame):
+                self.gate_open = False
+        else:
+            if self.gate_open_fn(frame):
+                self.gate_open = True
+
+        if self.gate_open:
+            yield frame
+            if self.accumulator:
+                for frame in self.accumulator:
+                    yield frame
+            self.accumulator = []
+        else:
+            self.accumulator.append(frame)

src/dailyai/pipeline/frame_processor.py

@@ -0,0 +1,33 @@
+from abc import abstractmethod
+from typing import AsyncGenerator
+
+from dailyai.pipeline.frames import ControlFrame, Frame
+
+
+class FrameProcessor:
+    """This is the base class for all frame processors. Frame processors consume a frame
+    and yield 0 or more frames. Generally frame processors are used as part of a pipeline
+    where frames come from a source queue, are processed by a series of frame processors,
+    then placed on a sink queue.
+
+    By convention, FrameProcessors should immediately yield any frames they don't process.
+
+    Stateful FrameProcessors should watch for the EndStreamQueueFrame and finalize their
+    output, eg. yielding an unfinished sentence if they're aggregating LLM output to full
+    sentences. EndStreamQueueFrame is also a chance to clean up any services that need to
+    be closed, del'd, etc.
+    """
+
+    @abstractmethod
+    async def process_frame(
+        self, frame: Frame
+    ) -> AsyncGenerator[Frame, None]:
+        """Process a single frame and yield 0 or more frames."""
+        if isinstance(frame, ControlFrame):
+            yield frame
+        yield frame
+
+    @abstractmethod
+    async def interrupted(self) -> None:
+        """Handle any cleanup if the pipeline was interrupted."""
+        pass

src/dailyai/pipeline/frames.py

@@ -0,0 +1,127 @@
+from dataclasses import dataclass
+from typing import Any, List
+
+from dailyai.services.openai_llm_context import OpenAILLMContext
+
+
+class Frame:
+    def __str__(self):
+        return f"{self.__class__.__name__}"
+
+
+class ControlFrame(Frame):
+    # Control frames should contain no instance data, so
+    # equality is based solely on the class.
+    def __eq__(self, other):
+        return type(other) == self.__class__
+
+
+class StartFrame(ControlFrame):
+    pass
+
+
+class EndFrame(ControlFrame):
+    pass
+
+
+class EndPipeFrame(ControlFrame):
+    pass
+
+
+class PipelineStartedFrame(ControlFrame):
+    """
+    Used by the transport to indicate that execution of a pipeline is starting
+    (or restarting). It should be the first frame your app receives when it
+    starts, or when an interruptible pipeline has been interrupted.
+    """
+
+    pass
+
+
+class LLMResponseStartFrame(ControlFrame):
+    pass
+
+
+class LLMResponseEndFrame(ControlFrame):
+    pass
+
+
+@dataclass()
+class AudioFrame(Frame):
+    data: bytes
+
+    def __str__(self):
+        return f"{self.__class__.__name__}, size: {len(self.data)} B"
+
+
+@dataclass()
+class ImageFrame(Frame):
+    url: str | None
+    image: bytes
+
+    def __str__(self):
+        return f"{self.__class__.__name__}, url: {self.url}, image size: {len(self.image)} B"
+
+
+@dataclass()
+class SpriteFrame(Frame):
+    images: list[bytes]
+
+    def __str__(self):
+        return f"{self.__class__.name__}, list size: {len(self.images)}"
+
+
+@dataclass()
+class TextFrame(Frame):
+    text: str
+
+    def __str__(self):
+        return f'{self.__class__.__name__}: "{self.text}"'
+
+
+@dataclass()
+class TranscriptionQueueFrame(TextFrame):
+    participantId: str
+    timestamp: str
+
+
+@dataclass()
+class LLMMessagesQueueFrame(Frame):
+    messages: List[dict]
+
+
+@dataclass()
+class OpenAILLMContextFrame(Frame):
+    context: OpenAILLMContext
+
+
+class AppMessageQueueFrame(Frame):
+    message: Any
+    participantId: str
+
+
+class UserStartedSpeakingFrame(Frame):
+    pass
+
+
+class UserStoppedSpeakingFrame(Frame):
+    pass
+
+
+class BotStartedSpeakingFrame(Frame):
+    pass
+
+
+class BotStoppedSpeakingFrame(Frame):
+    pass
+
+
+@dataclass()
+class LLMFunctionStartFrame(Frame):
+    function_name: str
+
+
+@dataclass()
+class LLMFunctionCallFrame(Frame):
+    function_name: str
+    arguments: str

src/dailyai/pipeline/opeanai_llm_aggregator.py

@@ -0,0 +1,106 @@
+from typing import Any, AsyncGenerator, Callable
+from dailyai.pipeline.frame_processor import FrameProcessor
+from dailyai.pipeline.frames import (
+    Frame,
+    LLMResponseEndFrame,
+    LLMResponseStartFrame,
+    OpenAILLMContextFrame,
+    TextFrame,
+    TranscriptionQueueFrame,
+    UserStartedSpeakingFrame,
+    UserStoppedSpeakingFrame,
+)
+from dailyai.services.openai_llm_context import OpenAILLMContext
+
+from openai.types.chat import ChatCompletionRole
+
+
+class OpenAIContextAggregator(FrameProcessor):
+
+    def __init__(
+        self,
+        context: OpenAILLMContext,
+        aggregator: Callable[[Frame, str | None], str | None],
+        role: ChatCompletionRole,
+        start_frame: type,
+        end_frame: type,
+        accumulator_frame: type,
+        pass_through=True,
+    ):
+        if not (
+            issubclass(start_frame, Frame)
+            and issubclass(end_frame, Frame)
+            and issubclass(accumulator_frame, Frame)
+        ):
+            raise TypeError(
+                "start_frame, end_frame and accumulator_frame must be instances of Frame"
+            )
+
+        self._context: OpenAILLMContext = context
+        self._aggregator: Callable[[Frame, str | None], None] = aggregator
+        self._role: ChatCompletionRole = role
+        self._start_frame = start_frame
+        self._end_frame = end_frame
+        self._accumulator_frame = accumulator_frame
+        self._pass_through = pass_through
+
+        self._aggregating = False
+        self._aggregation = None
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, self._start_frame):
+            self._aggregating = True
+        elif isinstance(frame, self._end_frame):
+            self._aggregating = False
+            if self._aggregation:
+                self._context.add_message(
+                    {
+                        "role": self._role,
+                        "content": self._aggregation,
+                        "name": self._role,
+                    }  # type: ignore
+                )
+            self._aggregation = None
+            yield OpenAILLMContextFrame(self._context)
+        elif isinstance(frame, self._accumulator_frame) and self._aggregating:
+            self._aggregation = self._aggregator(frame, self._aggregation)
+            if self._pass_through:
+                yield frame
+        else:
+            yield frame
+
+    def string_aggregator(self, frame: Frame, aggregation: str | None) -> str | None:
+        if not isinstance(frame, TextFrame):
+            raise TypeError(
+                "Frame must be a TextFrame instance to be aggregated by a string aggregator."
+            )
+        if not aggregation:
+            aggregation = ""
+        return " ".join([aggregation, frame.text])
+
+
+class OpenAIUserContextAggregator(OpenAIContextAggregator):
+    def __init__(self, context: OpenAILLMContext):
+        super().__init__(
+            context=context,
+            aggregator=self.string_aggregator,
+            role="user",
+            start_frame=UserStartedSpeakingFrame,
+            end_frame=UserStoppedSpeakingFrame,
+            accumulator_frame=TranscriptionQueueFrame,
+            pass_through=False,
+        )
+
+
+class OpenAIAssistantContextAggregator(OpenAIContextAggregator):
+
+    def __init__(self, context:OpenAILLMContext):
+        super().__init__(
+            context,
+            aggregator=self.string_aggregator,
+            role="assistant",
+            start_frame=LLMResponseStartFrame,
+            end_frame=LLMResponseEndFrame,
+            accumulator_frame=TextFrame,
+            pass_through=True,
+        )

src/dailyai/pipeline/pipeline.py

@@ -0,0 +1,104 @@
+import asyncio
+from typing import AsyncGenerator, List
+from dailyai.pipeline.frame_processor import FrameProcessor
+
+from dailyai.pipeline.frames import EndPipeFrame, EndFrame, Frame
+
+
+class Pipeline:
+    """
+    This class manages a pipe of FrameProcessors, and runs them in sequence. The "source"
+    and "sink" queues are managed by the caller. You can use this class stand-alone to
+    perform specialized processing, or you can use the Transport's run_pipeline method to
+    instantiate and run a pipeline with the Transport's sink and source queues.
+    """
+
+    def __init__(
+        self,
+        processors: List[FrameProcessor],
+        source: asyncio.Queue | None = None,
+        sink: asyncio.Queue[Frame] | None = None,
+    ):
+        """Create a new pipeline. By default neither the source nor sink
+        queues are set, so you'll need to pass them to this constructor or
+        call set_source and set_sink before using the pipeline. Note that
+        the transport's run_*_pipeline methods will set the source and sink
+        queues on the pipeline for you.
+        """
+        self.processors = processors
+        self.source: asyncio.Queue[Frame] | None = source
+        self.sink: asyncio.Queue[Frame] | None = sink
+
+    def set_source(self, source: asyncio.Queue[Frame]):
+        """Set the source queue for this pipeline. Frames from this queue
+        will be processed by each frame_processor in the pipeline, or order
+        from first to last."""
+        self.source = source
+
+    def set_sink(self, sink: asyncio.Queue[Frame]):
+        """Set the sink queue for this pipeline. After the last frame_processor
+        has processed a frame, its output will be placed on this queue."""
+        self.sink = sink
+
+    async def get_next_source_frame(self) -> AsyncGenerator[Frame, None]:
+        """Convenience function to get the next frame from the source queue. This
+        lets us consistently have an AsyncGenerator yield frames, from either the
+        source queue or a frame_processor."""
+        if self.source is None:
+            raise ValueError("Source queue not set")
+        yield await self.source.get()
+
+    async def run_pipeline_recursively(
+        self, initial_frame: Frame, processors: List[FrameProcessor]
+    ) -> AsyncGenerator[Frame, None]:
+        if processors:
+            async for frame in processors[0].process_frame(initial_frame):
+                async for final_frame in self.run_pipeline_recursively(
+                    frame, processors[1:]
+                ):
+                    yield final_frame
+        else:
+            yield initial_frame
+
+    async def run_pipeline(self):
+        """Run the pipeline. Take each frame from the source queue, pass it to
+        the first frame_processor, pass the output of that frame_processor to the
+        next in the list, etc. until the last frame_processor has processed the
+        resulting frames, then place those frames in the sink queue.
+
+        The source and sink queues must be set before calling this method.
+
+        This method will exit when an EndStreamQueueFrame is placed on the sink queue.
+        No more frames will be placed on the sink queue after an EndStreamQueueFrame, even
+        if it's not the last frame yielded by the last frame_processor in the pipeline..
+        """
+
+        if self.source is None or self.sink is None:
+            raise ValueError("Source or sink queue not set")
+
+        try:
+            while True:
+                initial_frame = await self.source.get()
+                async for frame in self.run_pipeline_recursively(
+                    initial_frame, self.processors
+                ):
+                    await self.sink.put(frame)
+
+                if isinstance(initial_frame, EndFrame) or isinstance(
+                    initial_frame, EndPipeFrame
+                ):
+                    break
+        except asyncio.CancelledError:
+            # this means there's been an interruption, do any cleanup necessary here.
+            for processor in self.processors:
+                await processor.interrupted()
+            pass
+
+    async def queue_frames(self, frames: Frame | List[Frame]):
+        """Insert frames directly into a pipeline. This is typically used inside a transport
+        participant_joined callback to prompt a bot to start a conversation, for example.
+        """
+        if not isinstance(frames, List):
+            frames = [frames]
+        for f in frames:
+            await self.source.put(f)

src/dailyai/queue_aggregators.py

@@ -1,48 +0,0 @@
-import asyncio
-
-from dailyai.queue_frame import LLMMessagesQueueFrame, QueueFrame, TextQueueFrame
-from dailyai.services.ai_services import AIService
-
-from typing import AsyncGenerator, List
-
-class QueueTee:
-    async def run_to_queue_and_generate(
-        self,
-        output_queue: asyncio.Queue,
-        generator: AsyncGenerator[QueueFrame, None]
-    ) -> AsyncGenerator[QueueFrame, None]:
-        async for frame in generator:
-            await output_queue.put(frame)
-            yield frame
-
-    async def run_to_queues(
-        self,
-        output_queues: List[asyncio.Queue],
-        generator: AsyncGenerator[QueueFrame, None]
-    ):
-        async for frame in generator:
-            for queue in output_queues:
-                await queue.put(frame)
-
-class LLMContextAggregator(AIService):
-    def __init__(self, messages: list[dict], role:str, bot_participant_id=None, complete_sentences=True):
-        self.messages = messages
-        self.bot_participant_id = bot_participant_id
-        self.role = role
-        self.sentence = ""
-        self.complete_sentences = complete_sentences
-
-    async def process_frame(self, frame:QueueFrame) -> AsyncGenerator[QueueFrame, None]:
-        # TODO: split up transcription by participant
-        if isinstance(frame, TextQueueFrame):
-            if self.complete_sentences:
-                self.sentence += frame.text
-                if self.sentence.endswith((".", "?", "!")):
-                    self.messages.append({"role": self.role, "content": self.sentence})
-                    self.sentence = ""
-                    yield LLMMessagesQueueFrame(self.messages)
-            else:
-                self.messages.append({"role": self.role, "content": frame.text})
-                yield LLMMessagesQueueFrame(self.messages)
-
-        yield frame

src/dailyai/queue_frame.py

@@ -1,41 +0,0 @@
-from enum import Enum
-from dataclasses import dataclass
-from typing import Any
-
-class QueueFrame:
-    pass
-
-class ControlQueueFrame(QueueFrame):
-    pass
-
-class StartStreamQueueFrame(ControlQueueFrame):
-    pass
-
-class EndStreamQueueFrame(ControlQueueFrame):
-    pass
-
-@dataclass()
-class AudioQueueFrame(QueueFrame):
-    data: bytes
-
-@dataclass()
-class ImageQueueFrame(QueueFrame):
-    url: str | None
-    image: bytes
-
-@dataclass()
-class TextQueueFrame(QueueFrame):
-    text: str
-
-@dataclass()
-class TranscriptionQueueFrame(TextQueueFrame):
-    participantId: str
-    timestamp: str
-
-@dataclass()
-class LLMMessagesQueueFrame(QueueFrame):
-    messages: list[dict[str,str]] # TODO: define this more concretely!
-
-class AppMessageQueueFrame(QueueFrame):
-    message: Any
-    participantId: str

src/dailyai/requirements.txt

@@ -1,3 +0,0 @@
-Pillow==10.1.0
-typing_extensions==4.9.0
-faster-whisper==0.10.0

src/dailyai/services/ai_services.py

@@ -1,24 +1,29 @@
 import asyncio
 import io
 import logging
+import time
 import wave
+from dailyai.pipeline.frame_processor import FrameProcessor
 
-from dailyai.queue_frame import (
-    AudioQueueFrame,
-    ControlQueueFrame,
-    EndStreamQueueFrame,
-    ImageQueueFrame,
+from dailyai.pipeline.frames import (
+    AudioFrame,
+    EndFrame,
+    ImageFrame,
     LLMMessagesQueueFrame,
-    QueueFrame,
-    TextQueueFrame,
+    LLMResponseEndFrame,
+    LLMResponseStartFrame,
+    LLMFunctionStartFrame,
+    LLMFunctionCallFrame,
+    Frame,
+    TextFrame,
+    TranscriptionQueueFrame,
 )
 
 from abc import abstractmethod
-from typing import AsyncGenerator, AsyncIterable, BinaryIO, Iterable
-from dataclasses import dataclass
+from typing import AsyncGenerator, AsyncIterable, BinaryIO, Iterable, List
 
 
-class AIService:
+class AIService(FrameProcessor):
 
     def __init__(self):
         self.logger = logging.getLogger("dailyai")
@@ -26,19 +31,19 @@ class AIService:
     def stop(self):
         pass
 
-    async def run_to_queue(self, queue: asyncio.Queue, frames, add_end_of_stream=False) -> None:
+    async def run_to_queue(
+        self, queue: asyncio.Queue, frames, add_end_of_stream=False
+    ) -> None:
         async for frame in self.run(frames):
             await queue.put(frame)
 
         if add_end_of_stream:
-            await queue.put(EndStreamQueueFrame())
+            await queue.put(EndFrame())
 
     async def run(
         self,
-        frames: Iterable[QueueFrame]
-        | AsyncIterable[QueueFrame]
-        | asyncio.Queue[QueueFrame],
-    ) -> AsyncGenerator[QueueFrame, None]:
+        frames: Iterable[Frame] | AsyncIterable[Frame] | asyncio.Queue[Frame],
+    ) -> AsyncGenerator[Frame, None]:
         try:
             if isinstance(frames, AsyncIterable):
                 async for frame in frames:
@@ -53,43 +58,20 @@ class AIService:
                     frame = await frames.get()
                     async for output_frame in self.process_frame(frame):
                         yield output_frame
-                    if isinstance(frame, EndStreamQueueFrame):
+                    if isinstance(frame, EndFrame):
                         break
             else:
                 raise Exception("Frames must be an iterable or async iterable")
-
-            async for output_frame in self.finalize():
-                yield output_frame
         except Exception as e:
             self.logger.error("Exception occurred while running AI service", e)
             raise e
 
-    @abstractmethod
-    async def process_frame(self, frame:QueueFrame) -> AsyncGenerator[QueueFrame, None]:
-        if isinstance(frame, ControlQueueFrame):
-            yield frame
-
-    @abstractmethod
-    async def finalize(self) -> AsyncGenerator[QueueFrame, None]:
-        # This is a trick for the interpreter (and linter) to know that this is a generator.
-        if False:
-            yield QueueFrame()
 
 class LLMService(AIService):
-    @abstractmethod
-    async def run_llm_async(self, messages) -> AsyncGenerator[str, None]:
-        yield ""
+    """This class is a no-op but serves as a base class for LLM services."""
 
-    @abstractmethod
-    async def run_llm(self, messages) -> str:
-        pass
-
-    async def process_frame(self, frame: QueueFrame) -> AsyncGenerator[QueueFrame, None]:
-        if isinstance(frame, ControlQueueFrame):
-            yield frame
-        elif isinstance(frame, LLMMessagesQueueFrame):
-            async for text_chunk in self.run_llm_async(frame.messages):
-                yield TextQueueFrame(text_chunk)
+    def __init__(self):
+        super().__init__()
 
 
 class TTSService(AIService):
@@ -109,34 +91,38 @@ class TTSService(AIService):
         # yield empty bytes here, so linting can infer what this method does
         yield bytes()
 
-    async def process_frame(self, frame: QueueFrame) -> AsyncGenerator[QueueFrame, None]:
-        if isinstance(frame, ControlQueueFrame):
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, EndFrame):
+            if self.current_sentence:
+                async for audio_chunk in self.run_tts(self.current_sentence):
+                    yield AudioFrame(audio_chunk)
+                yield TextFrame(self.current_sentence)
+
+        if not isinstance(frame, TextFrame):
             yield frame
             return
-        elif not isinstance(frame, TextQueueFrame):
-            return
 
         text: str | None = None
         if not self.aggregate_sentences:
             text = frame.text
         else:
             self.current_sentence += frame.text
-            if self.current_sentence.endswith((".", "?", "!")):
+            if self.current_sentence.strip().endswith((".", "?", "!")):
                 text = self.current_sentence
                 self.current_sentence = ""
 
         if text:
             async for audio_chunk in self.run_tts(text):
-                yield AudioQueueFrame(audio_chunk)
+                yield AudioFrame(audio_chunk)
 
-    async def finalize(self):
-        if self.current_sentence:
-            async for audio_chunk in self.run_tts(self.current_sentence):
-                yield AudioQueueFrame(audio_chunk)
+            # note we pass along the text frame *after* the audio, so the text frame is completed after the audio is processed.
+            yield TextFrame(text)
 
     # Convenience function to send the audio for a sentence to the given queue
     async def say(self, sentence, queue: asyncio.Queue):
-        await self.run_to_queue(queue, [TextQueueFrame(sentence)])
+        await self.run_to_queue(
+            queue, [LLMResponseStartFrame(), TextFrame(sentence), LLMResponseEndFrame()]
+        )
 
 
 class ImageGenService(AIService):
@@ -146,34 +132,35 @@ class ImageGenService(AIService):
 
     # Renders the image. Returns an Image object.
     @abstractmethod
-    async def run_image_gen(self, sentence:str) -> tuple[str, bytes]:
+    async def run_image_gen(self, sentence: str) -> tuple[str, bytes]:
         pass
 
-    async def process_frame(self, frame: QueueFrame) -> AsyncGenerator[QueueFrame, None]:
-        if not isinstance(frame, TextQueueFrame):
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if not isinstance(frame, TextFrame):
             yield frame
             return
 
         (url, image_data) = await self.run_image_gen(frame.text)
-        yield ImageQueueFrame(url, image_data)
+        yield ImageFrame(url, image_data)
+
 
 class STTService(AIService):
     """STTService is a base class for speech-to-text services."""
 
     _frame_rate: int
+
     def __init__(self, frame_rate: int = 16000, **kwargs):
         super().__init__(**kwargs)
         self._frame_rate = frame_rate
 
-
     @abstractmethod
     async def run_stt(self, audio: BinaryIO) -> str:
         """Returns transcript as a string"""
         pass
 
-    async def process_frame(self, frame: QueueFrame) -> AsyncGenerator[QueueFrame, None]:
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
         """Processes a frame of audio data, either buffering or transcribing it."""
-        if not isinstance(frame, AudioQueueFrame):
+        if not isinstance(frame, AudioFrame):
             return
 
         data = frame.data
@@ -186,11 +173,18 @@ class STTService(AIService):
         ww.close()
         content.seek(0)
         text = await self.run_stt(content)
-        yield TextQueueFrame(text)
+        yield TranscriptionQueueFrame(text, "", str(time.time()))
 
-@dataclass
-class AIServiceConfig:
-    tts: TTSService
-    image: ImageGenService
-    llm: LLMService
-    stt: STTService
+
+class FrameLogger(AIService):
+    def __init__(self, prefix="Frame", **kwargs):
+        super().__init__(**kwargs)
+        self.prefix = prefix
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, (AudioFrame, ImageFrame)):
+            self.logger.info(f"{self.prefix}: {type(frame)}")
+        else:
+            print(f"{self.prefix}: {frame}")
+
+        yield frame

src/dailyai/services/azure_ai_services.py

@@ -2,6 +2,7 @@ import aiohttp
 import asyncio
 import io
 import json
+import time
 from openai import AsyncAzureOpenAI
 
 import os
@@ -13,28 +14,37 @@ from dailyai.services.ai_services import LLMService, TTSService, ImageGenService
 from PIL import Image
 
 # See .env.example for Azure configuration needed
-from azure.cognitiveservices.speech import SpeechSynthesizer, SpeechConfig, ResultReason, CancellationReason
+from azure.cognitiveservices.speech import (
+    SpeechSynthesizer,
+    SpeechConfig,
+    ResultReason,
+    CancellationReason,
+)
+
+from dailyai.services.openai_api_llm_service import BaseOpenAILLMService
+
 
 class AzureTTSService(TTSService):
-    def __init__(self, speech_key=None, speech_region=None):
+    def __init__(self, *, api_key, region):
         super().__init__()
 
-        speech_key = speech_key or os.getenv("AZURE_SPEECH_SERVICE_KEY")
-        speech_region = speech_region or os.getenv("AZURE_SPEECH_SERVICE_REGION")
-
-        self.speech_config = SpeechConfig(subscription=speech_key, region=speech_region)
-        self.speech_synthesizer = SpeechSynthesizer(speech_config=self.speech_config, audio_config=None)
+        self.speech_config = SpeechConfig(subscription=api_key, region=region)
+        self.speech_synthesizer = SpeechSynthesizer(
+            speech_config=self.speech_config, audio_config=None
+        )
 
     async def run_tts(self, sentence) -> AsyncGenerator[bytes, None]:
         self.logger.info("Running azure tts")
-        ssml = "<speak version='1.0' xml:lang='en-US' xmlns='http://www.w3.org/2001/10/synthesis' " \
-           "xmlns:mstts='http://www.w3.org/2001/mstts'>" \
-           "<voice name='en-US-SaraNeural'>" \
-           "<mstts:silence type='Sentenceboundary' value='20ms' />" \
-           "<mstts:express-as style='lyrical' styledegree='2' role='SeniorFemale'>" \
-           "<prosody rate='1.05'>" \
-           f"{sentence}" \
-           "</prosody></mstts:express-as></voice></speak> "
+        ssml = (
+            "<speak version='1.0' xml:lang='en-US' xmlns='http://www.w3.org/2001/10/synthesis' "
+            "xmlns:mstts='http://www.w3.org/2001/mstts'>"
+            "<voice name='en-US-SaraNeural'>"
+            "<mstts:silence type='Sentenceboundary' value='20ms' />"
+            "<mstts:express-as style='lyrical' styledegree='2' role='SeniorFemale'>"
+            "<prosody rate='1.05'>"
+            f"{sentence}"
+            "</prosody></mstts:express-as></voice></speak> "
+        )
         result = await asyncio.to_thread(self.speech_synthesizer.speak_ssml, (ssml))
         self.logger.info("Got azure tts result")
         if result.reason == ResultReason.SynthesizingAudioCompleted:
@@ -43,130 +53,84 @@ class AzureTTSService(TTSService):
             yield result.audio_data[44:]
         elif result.reason == ResultReason.Canceled:
             cancellation_details = result.cancellation_details
-            self.logger.info("Speech synthesis canceled: {}".format(cancellation_details.reason))
+            self.logger.info(
+                "Speech synthesis canceled: {}".format(cancellation_details.reason)
+            )
             if cancellation_details.reason == CancellationReason.Error:
-                self.logger.info("Error details: {}".format(cancellation_details.error_details))
+                self.logger.info(
+                    "Error details: {}".format(cancellation_details.error_details)
+                )
 
-class AzureLLMService(LLMService):
-    def __init__(self, api_key=None, azure_endpoint=None, api_version=None, model=None):
-        super().__init__()
-        api_key = api_key or os.getenv("AZURE_CHATGPT_KEY")
 
-        azure_endpoint = azure_endpoint or os.getenv("AZURE_CHATGPT_ENDPOINT")
-        if not azure_endpoint:
-            raise Exception("No azure endpoint specified for Azure LLM, please set AZURE_CHATGPT_ENDPOINT in the environment or pass it to the AzureLLMService constructor")
+class AzureLLMService(BaseOpenAILLMService):
+    def __init__(self, *, api_key, endpoint, api_version="2023-12-01-preview", model):
+        super().__init__(model)
 
-        model: str | None = model or os.getenv("AZURE_CHATGPT_DEPLOYMENT_ID")
-        if not model:
-            raise Exception("No model specified for Azure LLM, please set AZURE_CHATGPT_DEPLOYMENT_ID in the environment or pass it to the AzureLLMService constructor")
-        self.model: str = model
-
-        api_version = api_version or "2023-12-01-preview"
-        self.client = AsyncAzureOpenAI(
+        # This overrides the client created by the super class init
+        self._client = AsyncAzureOpenAI(
             api_key=api_key,
-            azure_endpoint=azure_endpoint,
+            azure_endpoint=endpoint,
             api_version=api_version,
         )
 
-    async def run_llm_async(self, messages) -> AsyncGenerator[str, None]:
-        messages_for_log = json.dumps(messages)
-        self.logger.debug(f"Generating chat via azure: {messages_for_log}")
-
-        chunks = await self.client.chat.completions.create(model=self.model, stream=True, messages=messages)
-        async for chunk in chunks:
-            if len(chunk.choices) == 0:
-                continue
-
-            if chunk.choices[0].delta.content:
-                yield chunk.choices[0].delta.content
-
-    async def run_llm(self, messages) -> str | None:
-        messages_for_log = json.dumps(messages)
-        self.logger.debug(f"Generating chat via azure: {messages_for_log}")
-
-        response = await self.client.chat.completions.create(model=self.model, stream=False, messages=messages)
-        if response and len(response.choices) > 0:
-            return response.choices[0].message.content
-        else:
-            return None
 
 class AzureImageGenServiceREST(ImageGenService):
 
-    def __init__(self, image_size:str, api_key=None, azure_endpoint=None, api_version=None, model=None):
+    def __init__(
+        self,
+        *,
+        api_version="2023-06-01-preview",
+        image_size: str,
+        aiohttp_session: aiohttp.ClientSession,
+        api_key,
+        endpoint,
+        model,
+    ):
         super().__init__(image_size=image_size)
-        self.api_key = api_key or os.getenv("AZURE_DALLE_KEY")
-        self.azure_endpoint = azure_endpoint or os.getenv("AZURE_DALLE_ENDPOINT")
-        self.api_version = api_version or "2023-06-01-preview"
-        self.model = model or os.getenv("AZURE_DALLE_DEPLOYMENT_ID")
+
+        self._api_key = api_key
+        self._azure_endpoint = endpoint
+        self._api_version = api_version
+        self._model = model
+        self._aiohttp_session = aiohttp_session
 
     async def run_image_gen(self, sentence) -> tuple[str, bytes]:
-        # TODO hoist the session to app-level
-        async with aiohttp.ClientSession() as session:
-            url = f"{self.azure_endpoint}openai/images/generations:submit?api-version={self.api_version}"
-            headers= { "api-key": self.api_key, "Content-Type": "application/json" }
-            body = {
-                # Enter your prompt text here
-                "prompt": sentence,
-                "size": self.image_size,
-                "n": 1,
-            }
-            async with session.post(url, headers=headers, json=body) as submission:
-                operation_location = submission.headers['operation-location']
+        url = f"{self._azure_endpoint}openai/images/generations:submit?api-version={self._api_version}"
+        headers = {"api-key": self._api_key, "Content-Type": "application/json"}
+        body = {
+            # Enter your prompt text here
+            "prompt": sentence,
+            "size": self.image_size,
+            "n": 1,
+        }
+        async with self._aiohttp_session.post(
+            url, headers=headers, json=body
+        ) as submission:
+            # We never get past this line, because this header isn't
+            # defined on a 429 response, but something is eating our exceptions!
+            operation_location = submission.headers["operation-location"]
+            status = ""
+            attempts_left = 120
+            json_response = None
+            while status != "succeeded":
+                attempts_left -= 1
+                if attempts_left == 0:
+                    raise Exception("Image generation timed out")
 
-                status = ""
-                attempts_left = 120
-                json_response = None
-                while status != "succeeded":
-                    attempts_left -= 1
-                    if attempts_left == 0:
-                        raise Exception("Image generation timed out")
+                await asyncio.sleep(1)
+                response = await self._aiohttp_session.get(
+                    operation_location, headers=headers
+                )
+                json_response = await response.json()
+                status = json_response["status"]
 
-                    await asyncio.sleep(1)
-                    response = await session.get(operation_location, headers=headers)
-                    json_response = await response.json()
-                    status = json_response["status"]
-
-                image_url = json_response["result"]["data"][0]["url"] if json_response else None
-                if not image_url:
-                    raise Exception("Image generation failed")
-
-                # Load the image from the url
-                async with session.get(image_url) as response:
-                    image_stream = io.BytesIO(await response.content.read())
-                    image = Image.open(image_stream)
-                    return (image_url, image.tobytes())
-
-
-class AzureImageGenService(ImageGenService):
-
-    def __init__(self, api_key=None, azure_endpoint=None, api_version=None, model=None):
-        super().__init__()
-
-        api_key = api_key or os.getenv("AZURE_DALLE_KEY")
-        azure_endpoint = azure_endpoint or os.getenv("AZURE_DALLE_ENDPOINT")
-        api_version = api_version or "2023-06-01-preview"
-        self.model = model or os.getenv("AZURE_DALLE_DEPLOYMENT_ID")
-
-        self.client = AzureOpenAI(
-            api_key=api_key,
-            azure_endpoint=azure_endpoint,
-            api_version=api_version,
-        )
-
-    async def run_image_gen(self, sentence) -> tuple[str, bytes]:
-        self.logger.info("Generating azure image", sentence)
-
-        image = self.client.images.generate(
-            model=self.model,
-            prompt=sentence,
-            n=1,
-            size=self.image_size,
-        )
-
-        url = image["data"][0]["url"]
-        response = requests.get(url)
-
-        dalle_stream = io.BytesIO(response.content)
-        dalle_im = Image.open(dalle_stream.tobytes())
-
-        return (url, dalle_im)
+            image_url = (
+                json_response["result"]["data"][0]["url"] if json_response else None
+            )
+            if not image_url:
+                raise Exception("Image generation failed")
+            # Load the image from the url
+            async with self._aiohttp_session.get(image_url) as response:
+                image_stream = io.BytesIO(await response.content.read())
+                image = Image.open(image_stream)
+                return (image_url, image.tobytes())

src/dailyai/services/base_transport_service.py

@@ -0,0 +1,457 @@
+from abc import abstractmethod
+import asyncio
+import itertools
+import logging
+import numpy as np
+import pyaudio
+import torch
+import queue
+import threading
+import time
+from typing import AsyncGenerator
+from enum import Enum
+from dailyai.pipeline.frame_processor import FrameProcessor
+
+from dailyai.pipeline.frames import (
+    AudioFrame,
+    EndFrame,
+    ImageFrame,
+    Frame,
+    PipelineStartedFrame,
+    SpriteFrame,
+    StartFrame,
+    TranscriptionQueueFrame,
+    UserStartedSpeakingFrame,
+    UserStoppedSpeakingFrame,
+)
+from dailyai.pipeline.pipeline import Pipeline
+
+torch.set_num_threads(1)
+
+model, utils = torch.hub.load(
+    repo_or_dir="snakers4/silero-vad", model="silero_vad", force_reload=False
+)
+
+(get_speech_timestamps, save_audio, read_audio, VADIterator, collect_chunks) = utils
+
+# Taken from utils_vad.py
+
+
+def validate(model, inputs: torch.Tensor):
+    with torch.no_grad():
+        outs = model(inputs)
+    return outs
+
+
+# Provided by Alexander Veysov
+
+
+def int2float(sound):
+    abs_max = np.abs(sound).max()
+    sound = sound.astype("float32")
+    if abs_max > 0:
+        sound *= 1 / 32768
+    sound = sound.squeeze()  # depends on the use case
+    return sound
+
+
+FORMAT = pyaudio.paInt16
+CHANNELS = 1
+SAMPLE_RATE = 16000
+CHUNK = int(SAMPLE_RATE / 10)
+
+audio = pyaudio.PyAudio()
+
+
+class VADState(Enum):
+    QUIET = 1
+    STARTING = 2
+    SPEAKING = 3
+    STOPPING = 4
+
+
+class BaseTransportService:
+
+    def __init__(
+        self,
+        **kwargs,
+    ) -> None:
+        self._mic_enabled = kwargs.get("mic_enabled") or False
+        self._mic_sample_rate = kwargs.get("mic_sample_rate") or 16000
+        self._camera_enabled = kwargs.get("camera_enabled") or False
+        self._camera_width = kwargs.get("camera_width") or 1024
+        self._camera_height = kwargs.get("camera_height") or 768
+        self._speaker_enabled = kwargs.get("speaker_enabled") or False
+        self._speaker_sample_rate = kwargs.get("speaker_sample_rate") or 16000
+        self._fps = kwargs.get("fps") or 8
+        self._vad_start_s = kwargs.get("vad_start_s") or 0.2
+        self._vad_stop_s = kwargs.get("vad_stop_s") or 0.8
+        self._context = kwargs.get("context") or []
+        self._vad_enabled = kwargs.get("vad_enabled") or False
+
+        if self._vad_enabled and self._speaker_enabled:
+            raise Exception(
+                "Sorry, you can't use speaker_enabled and vad_enabled at the same time. Please set one to False."
+            )
+
+        self._vad_samples = 1536
+        vad_frame_s = self._vad_samples / SAMPLE_RATE
+        self._vad_start_frames = round(self._vad_start_s / vad_frame_s)
+        self._vad_stop_frames = round(self._vad_stop_s / vad_frame_s)
+        self._vad_starting_count = 0
+        self._vad_stopping_count = 0
+        self._vad_state = VADState.QUIET
+        self._user_is_speaking = False
+
+        duration_minutes = kwargs.get("duration_minutes") or 10
+        self._expiration = time.time() + duration_minutes * 60
+
+        self.send_queue = asyncio.Queue()
+        self.receive_queue = asyncio.Queue()
+
+        self.completed_queue = asyncio.Queue()
+
+        self._threadsafe_send_queue = queue.Queue()
+
+        self._images = None
+
+        try:
+            self._loop: asyncio.AbstractEventLoop | None = asyncio.get_running_loop()
+        except RuntimeError:
+            self._loop = None
+
+        self._stop_threads = threading.Event()
+        self._is_interrupted = threading.Event()
+
+        self._logger: logging.Logger = logging.getLogger()
+
+    async def run(self):
+        self._prerun()
+
+        async_output_queue_marshal_task = asyncio.create_task(self._marshal_frames())
+
+        self._camera_thread = threading.Thread(target=self._run_camera, daemon=True)
+        self._camera_thread.start()
+
+        self._frame_consumer_thread = threading.Thread(
+            target=self._frame_consumer, daemon=True
+        )
+        self._frame_consumer_thread.start()
+
+        if self._speaker_enabled:
+            self._receive_audio_thread = threading.Thread(
+                target=self._receive_audio, daemon=True
+            )
+            self._receive_audio_thread.start()
+
+        if self._vad_enabled:
+            self._vad_thread = threading.Thread(target=self._vad, daemon=True)
+            self._vad_thread.start()
+
+        try:
+            while time.time() < self._expiration and not self._stop_threads.is_set():
+                await asyncio.sleep(1)
+        except Exception as e:
+            self._logger.error(f"Exception {e}")
+            raise e
+        finally:
+            # Do anything that must be done to clean up
+            self._post_run()
+
+        self._stop_threads.set()
+
+        await self.send_queue.put(EndFrame())
+        await async_output_queue_marshal_task
+        await self.send_queue.join()
+        self._frame_consumer_thread.join()
+
+        if self._speaker_enabled:
+            self._receive_audio_thread.join()
+
+        if self._vad_enabled:
+            self._vad_thread.join()
+
+    async def run_uninterruptible_pipeline(self, pipeline: Pipeline):
+        pipeline.set_sink(self.send_queue)
+        pipeline.set_source(self.receive_queue)
+        await pipeline.run_pipeline()
+
+    async def run_interruptible_pipeline(
+        self,
+        pipeline: Pipeline,
+        allow_interruptions=True,
+        pre_processor=None,
+        post_processor: FrameProcessor | None = None,
+    ):
+        pipeline.set_sink(self.send_queue)
+        source_queue = asyncio.Queue()
+        pipeline.set_source(source_queue)
+        pipeline.set_sink(self.send_queue)
+        pipeline_task = asyncio.create_task(pipeline.run_pipeline())
+
+        async def yield_frame(frame: Frame) -> AsyncGenerator[Frame, None]:
+            yield frame
+
+        async def post_process(post_processor: FrameProcessor):
+            while True:
+                frame = await self.completed_queue.get()
+
+                # We ignore the output of the post_processor's process frame;
+                # this is called to update the post-processor's state.
+                async for frame in post_processor.process_frame(frame):
+                    pass
+
+                if isinstance(frame, EndFrame):
+                    break
+
+        if post_processor:
+            post_process_task = asyncio.create_task(post_process(post_processor))
+
+        started = False
+
+        async for frame in self.get_receive_frames():
+            if isinstance(frame, UserStartedSpeakingFrame):
+                pipeline_task.cancel()
+                self.interrupt()
+                pipeline_task = asyncio.create_task(pipeline.run_pipeline())
+                started = False
+
+            if not started:
+                await self.send_queue.put(StartFrame())
+
+            if pre_processor:
+                frame_generator = pre_processor.process_frame(frame)
+            else:
+                frame_generator = yield_frame(frame)
+
+            async for frame in frame_generator:
+                await source_queue.put(frame)
+
+            if isinstance(frame, EndFrame):
+                break
+
+        await asyncio.gather(pipeline_task, post_process_task)
+
+    def _post_run(self):
+        # Note that this function must be idempotent! It can be called multiple times
+        # if, for example, a keyboard interrupt occurs.
+        pass
+
+    def stop(self):
+        self._stop_threads.set()
+
+    async def stop_when_done(self):
+        await self._wait_for_send_queue_to_empty()
+        self.stop()
+
+    async def _wait_for_send_queue_to_empty(self):
+        await self.send_queue.join()
+        self._threadsafe_send_queue.join()
+
+    @abstractmethod
+    def write_frame_to_camera(self, frame: bytes):
+        pass
+
+    @abstractmethod
+    def write_frame_to_mic(self, frame: bytes):
+        pass
+
+    @abstractmethod
+    def read_audio_frames(self, desired_frame_count):
+        return bytes()
+
+    @abstractmethod
+    def _prerun(self):
+        pass
+
+    def _vad(self):
+        # CB: Starting silero VAD stuff
+        # TODO-CB: Probably need to force virtual speaker creation if we're
+        # going to build this in?
+        # TODO-CB: pyaudio installation
+        while not self._stop_threads.is_set():
+            audio_chunk = self.read_audio_frames(self._vad_samples)
+            audio_int16 = np.frombuffer(audio_chunk, np.int16)
+            audio_float32 = int2float(audio_int16)
+            new_confidence = model(torch.from_numpy(audio_float32), 16000).item()
+            speaking = new_confidence > 0.5
+
+            if speaking:
+                match self._vad_state:
+                    case VADState.QUIET:
+                        self._vad_state = VADState.STARTING
+                        self._vad_starting_count = 1
+                    case VADState.STARTING:
+                        self._vad_starting_count += 1
+                    case VADState.STOPPING:
+                        self._vad_state = VADState.SPEAKING
+                        self._vad_stopping_count = 0
+            else:
+                match self._vad_state:
+                    case VADState.STARTING:
+                        self._vad_state = VADState.QUIET
+                        self._vad_starting_count = 0
+                    case VADState.SPEAKING:
+                        self._vad_state = VADState.STOPPING
+                        self._vad_stopping_count = 1
+                    case VADState.STOPPING:
+                        self._vad_stopping_count += 1
+
+            if (
+                self._vad_state == VADState.STARTING
+                and self._vad_starting_count >= self._vad_start_frames
+            ):
+                asyncio.run_coroutine_threadsafe(
+                    self.receive_queue.put(UserStartedSpeakingFrame()), self._loop
+                )
+                # self.interrupt()
+                self._vad_state = VADState.SPEAKING
+                self._vad_starting_count = 0
+            if (
+                self._vad_state == VADState.STOPPING
+                and self._vad_stopping_count >= self._vad_stop_frames
+            ):
+                asyncio.run_coroutine_threadsafe(
+                    self.receive_queue.put(UserStoppedSpeakingFrame()), self._loop
+                )
+                self._vad_state = VADState.QUIET
+                self._vad_stopping_count = 0
+
+    async def _marshal_frames(self):
+        while True:
+            frame: Frame | list = await self.send_queue.get()
+            self._threadsafe_send_queue.put(frame)
+            self.send_queue.task_done()
+            if isinstance(frame, EndFrame):
+                break
+
+    def interrupt(self):
+        self._logger.debug("### Interrupting")
+        self._is_interrupted.set()
+
+    async def get_receive_frames(self) -> AsyncGenerator[Frame, None]:
+        while True:
+            frame = await self.receive_queue.get()
+            yield frame
+            if isinstance(frame, EndFrame):
+                break
+
+    def _receive_audio(self):
+        if not self._loop:
+            self._logger.error("No loop available for audio thread")
+            return
+
+        seconds = 1
+        desired_frame_count = self._speaker_sample_rate * seconds
+        while not self._stop_threads.is_set():
+            buffer = self.read_audio_frames(desired_frame_count)
+            if len(buffer) > 0:
+                frame = AudioFrame(buffer)
+                asyncio.run_coroutine_threadsafe(
+                    self.receive_queue.put(frame), self._loop
+                )
+
+        asyncio.run_coroutine_threadsafe(self.receive_queue.put(EndFrame()), self._loop)
+
+    def _set_image(self, image: bytes):
+        self._images = itertools.cycle([image])
+
+    def _set_images(self, images: list[bytes], start_frame=0):
+        self._images = itertools.cycle(images)
+
+    def _run_camera(self):
+        try:
+            while not self._stop_threads.is_set():
+                if self._images:
+                    this_frame = next(self._images)
+                    self.write_frame_to_camera(this_frame)
+
+                time.sleep(1.0 / self._fps)
+        except Exception as e:
+            self._logger.error(f"Exception {e} in camera thread.")
+            raise e
+
+    def _frame_consumer(self):
+        self._logger.info("🎬 Starting frame consumer thread")
+        b = bytearray()
+        smallest_write_size = 3200
+        largest_write_size = 8000
+        while True:
+            try:
+                frames_or_frame: Frame | list[Frame] = self._threadsafe_send_queue.get()
+                if (
+                    isinstance(frames_or_frame, AudioFrame)
+                    and len(frames_or_frame.data) > largest_write_size
+                ):
+                    # subdivide large audio frames to enable interruption
+                    frames = []
+                    for i in range(0, len(frames_or_frame.data), largest_write_size):
+                        frames.append(
+                            AudioFrame(frames_or_frame.data[i : i + largest_write_size])
+                        )
+                elif isinstance(frames_or_frame, Frame):
+                    frames: list[Frame] = [frames_or_frame]
+                elif isinstance(frames_or_frame, list):
+                    frames: list[Frame] = frames_or_frame
+                else:
+                    raise Exception("Unknown type in output queue")
+
+                for frame in frames:
+                    if isinstance(frame, EndFrame):
+                        self._logger.info("Stopping frame consumer thread")
+                        self._threadsafe_send_queue.task_done()
+                        if self._loop:
+                            asyncio.run_coroutine_threadsafe(
+                                self.completed_queue.put(frame), self._loop
+                            )
+                        return
+
+                    # if interrupted, we just pull frames off the queue and discard them
+                    if not self._is_interrupted.is_set():
+                        if frame:
+                            if isinstance(frame, AudioFrame):
+                                chunk = frame.data
+
+                                b.extend(chunk)
+                                truncated_length: int = len(b) - (
+                                    len(b) % smallest_write_size
+                                )
+                                if truncated_length:
+                                    self.write_frame_to_mic(bytes(b[:truncated_length]))
+                                    b = b[truncated_length:]
+                            elif isinstance(frame, ImageFrame):
+                                self._set_image(frame.image)
+                            elif isinstance(frame, SpriteFrame):
+                                self._set_images(frame.images)
+                        elif len(b):
+                            self.write_frame_to_mic(bytes(b))
+                            b = bytearray()
+                    else:
+                        # if there are leftover audio bytes, write them now; failing to do so
+                        # can cause static in the audio stream.
+                        if len(b):
+                            truncated_length = len(b) - (len(b) % 160)
+                            self.write_frame_to_mic(bytes(b[:truncated_length]))
+                            b = bytearray()
+
+                        if isinstance(frame, StartFrame):
+                            self._is_interrupted.clear()
+                            asyncio.run_coroutine_threadsafe(
+                                self.receive_queue.put(PipelineStartedFrame()),
+                                self._loop,
+                            )
+
+                    if self._loop:
+                        asyncio.run_coroutine_threadsafe(
+                            self.completed_queue.put(frame), self._loop
+                        )
+
+                self._threadsafe_send_queue.task_done()
+            except queue.Empty:
+                if len(b):
+                    self.write_frame_to_mic(bytes(b))
+
+                b = bytearray()
+            except Exception as e:
+                self._logger.error(f"Exception in frame_consumer: {e}, {len(b)}")
+                raise e

src/dailyai/services/daily_transport_service.py

@@ -1,25 +1,17 @@
 import asyncio
 import inspect
 import logging
+import signal
 import threading
-import time
 import types
 
 from functools import partial
-from queue import Queue, Empty
-from typing import AsyncGenerator
 
-from dailyai.queue_frame import (
-    AudioQueueFrame,
-    EndStreamQueueFrame,
-    ImageQueueFrame,
-    QueueFrame,
-    StartStreamQueueFrame,
-    TextQueueFrame,
+from dailyai.pipeline.frames import (
     TranscriptionQueueFrame,
 )
 
-from threading import Thread, Event
+from threading import Event
 
 from daily import (
     EventHandler,
@@ -30,58 +22,43 @@ from daily import (
     VirtualSpeakerDevice,
 )
 
-class DailyTransportService(EventHandler):
+from dailyai.services.base_transport_service import BaseTransportService
+
+
+class DailyTransportService(BaseTransportService, EventHandler):
     _daily_initialized = False
     _lock = threading.Lock()
 
-    speaker_enabled: bool
-    speaker_sample_rate: int
+    _speaker_enabled: bool
+    _speaker_sample_rate: int
+    _vad_enabled: bool
+
+    # This is necessary to override EventHandler's __new__ method.
+    def __new__(cls, *args, **kwargs):
+        return super().__new__(cls)
 
     def __init__(
         self,
         room_url: str,
         token: str | None,
         bot_name: str,
-        duration: float = 10,
         min_others_count: int = 1,
-        start_transcription: bool = True,
-        speaker_enabled: bool = False,
-        speaker_sample_rate: int = 16000,
+        start_transcription: bool = False,
+        **kwargs,
     ):
-        super().__init__()
-        self.bot_name: str = bot_name
-        self.room_url: str = room_url
-        self.token: str | None = token
-        self.duration: float = duration
-        self.expiration = time.time() + duration * 60
-        self.min_others_count = min_others_count
-        self.start_transcription = start_transcription
+        super().__init__(**kwargs)  # This will call BaseTransportService.__init__ method, not EventHandler
 
-        # This queue is used to marshal frames from the async send queue to the thread that emits audio & video.
-        # We need this to maintain the asynchronous behavior of asyncio queues -- to give async functions
-        # a chance to run while waiting for queue items -- but also to maintain thread safety and have a threaded
-        # handler to send frames, to ensure that sending isn't subject to pauses in the async thread.
-        self.threadsafe_send_queue = Queue()
+        self._room_url: str = room_url
+        self._bot_name: str = bot_name
+        self._token: str | None = token
+        self._min_others_count = min_others_count
+        self._start_transcription = start_transcription
 
-        self.is_interrupted = Event()
-        self.stop_threads = Event()
-        self.story_started = False
-        self.mic_enabled = False
-        self.mic_sample_rate = 16000
-        self.camera_width = 1024
-        self.camera_height = 768
-        self.camera_enabled = False
-        self.speaker_enabled = speaker_enabled
-        self.speaker_sample_rate = speaker_sample_rate
+        self._is_interrupted = Event()
+        self._stop_threads = Event()
 
-        self.send_queue = asyncio.Queue()
-        self.receive_queue = asyncio.Queue()
-
-        self.other_participant_has_joined = False
-        self.my_participant_id = None
-
-        self.camera_thread = None
-        self.frame_consumer_thread = None
+        self._other_participant_has_joined = False
+        self._my_participant_id = None
 
         self.transcription_settings = {
             "language": "en",
@@ -95,27 +72,26 @@ class DailyTransportService(EventHandler):
             },
         }
 
-        self.logger: logging.Logger = logging.getLogger("dailyai")
+        self._logger: logging.Logger = logging.getLogger("dailyai")
 
-        self.event_handlers = {}
+        self._event_handlers = {}
 
+    def _patch_method(self, event_name, *args, **kwargs):
         try:
-            self.loop = asyncio.get_running_loop()
-        except RuntimeError:
-            self.loop = None
-
-    def patch_method(self, event_name, *args, **kwargs):
-        try:
-            for handler in self.event_handlers[event_name]:
+            for handler in self._event_handlers[event_name]:
                 if inspect.iscoroutinefunction(handler):
-                    if self.loop:
-                        asyncio.run_coroutine_threadsafe(handler(*args, **kwargs), self.loop)
+                    if self._loop:
+                        future = asyncio.run_coroutine_threadsafe(handler(*args, **kwargs), self._loop)
+
+                        # wait for the coroutine to finish. This will also raise any exceptions raised by the coroutine.
+                        future.result()
                     else:
-                        raise Exception("No event loop to run coroutine. In order to use async event handlers, you must run the DailyTransportService in an asyncio event loop.")
+                        raise Exception(
+                            "No event loop to run coroutine. In order to use async event handlers, you must run the DailyTransportService in an asyncio event loop.")
                 else:
                     handler(*args, **kwargs)
         except Exception as e:
-            self.logger.error(f"Exception in event handler {event_name}: {e}")
+            self._logger.error(f"Exception in event handler {event_name}: {e}")
             raise e
 
     def add_event_handler(self, event_name: str, handler):
@@ -126,11 +102,14 @@ class DailyTransportService(EventHandler):
         if event_name not in [method[0] for method in methods]:
             raise Exception(f"Event handler {event_name} not found")
 
-        if not event_name in self.event_handlers:
-            self.event_handlers[event_name] = [getattr(self, event_name), types.MethodType(handler, self)]
-            setattr(self, event_name, partial(self.patch_method, event_name))
+        if event_name not in self._event_handlers:
+            self._event_handlers[event_name] = [
+                getattr(
+                    self, event_name), types.MethodType(
+                    handler, self)]
+            setattr(self, event_name, partial(self._patch_method, event_name))
         else:
-            self.event_handlers[event_name].append(types.MethodType(handler, self))
+            self._event_handlers[event_name].append(types.MethodType(handler, self))
 
     def event_handler(self, event_name: str):
         def decorator(handler):
@@ -139,7 +118,17 @@ class DailyTransportService(EventHandler):
 
         return decorator
 
-    def configure_daily(self):
+    def write_frame_to_camera(self, frame: bytes):
+        self.camera.write_frame(frame)
+
+    def write_frame_to_mic(self, frame: bytes):
+        self.mic.write_frames(frame)
+
+    def read_audio_frames(self, desired_frame_count):
+        bytes = self._speaker.read_frames(desired_frame_count)
+        return bytes
+
+    def _prerun(self):
         # Only initialize Daily once
         if not DailyTransportService._daily_initialized:
             with DailyTransportService._lock:
@@ -147,185 +136,125 @@ class DailyTransportService(EventHandler):
                 DailyTransportService._daily_initialized = True
         self.client = CallClient(event_handler=self)
 
-        if self.mic_enabled:
+        if self._mic_enabled:
             self.mic: VirtualMicrophoneDevice = Daily.create_microphone_device(
-                "mic", sample_rate=self.mic_sample_rate, channels=1
+                "mic", sample_rate=self._mic_sample_rate, channels=1
             )
 
-        if self.camera_enabled:
+        if self._camera_enabled:
             self.camera: VirtualCameraDevice = Daily.create_camera_device(
-                "camera", width=self.camera_width, height=self.camera_height, color_format="RGB"
+                "camera", width=self._camera_width, height=self._camera_height, color_format="RGB"
             )
 
-        if self.speaker_enabled:
-            self.speaker: VirtualSpeakerDevice = Daily.create_speaker_device(
-                "speaker", sample_rate=self.speaker_sample_rate, channels=1
+        if self._speaker_enabled or self._vad_enabled:
+            self._speaker: VirtualSpeakerDevice = Daily.create_speaker_device(
+                "speaker", sample_rate=self._speaker_sample_rate, channels=1
             )
             Daily.select_speaker_device("speaker")
 
-        self.image: bytes | None = None
-        self.camera_thread = Thread(target=self.run_camera, daemon=True)
-        self.camera_thread.start()
-
-        self.logger.info("Starting frame consumer thread")
-        self.frame_consumer_thread = Thread(target=self.frame_consumer, daemon=True)
-        self.frame_consumer_thread.start()
-
-        self.client.set_user_name(self.bot_name)
-        self.client.join(self.room_url, self.token, completion=self.call_joined)
-        self.my_participant_id = self.client.participants()["local"]["id"]
-
-        self.client.update_inputs(
-            {
-                "camera": {
-                    "isEnabled": True,
-                    "settings": {
-                        "deviceId": "camera",
+        self.client.set_user_name(self._bot_name)
+        self.client.join(
+            self._room_url,
+            self._token,
+            completion=self.call_joined,
+            client_settings={
+                "inputs": {
+                    "camera": {
+                        "isEnabled": True,
+                        "settings": {
+                            "deviceId": "camera",
+                        },
                     },
-                },
-                "microphone": {
-                    "isEnabled": True,
-                    "settings": {
-                        "deviceId": "mic",
-                        "customConstraints": {
-                            "autoGainControl": {"exact": False},
-                            "echoCancellation": {"exact": False},
-                            "noiseSuppression": {"exact": False},
+                    "microphone": {
+                        "isEnabled": True,
+                        "settings": {
+                            "deviceId": "mic",
+                            "customConstraints": {
+                                "autoGainControl": {"exact": False},
+                                "echoCancellation": {"exact": False},
+                                "noiseSuppression": {"exact": False},
+                            },
                         },
                     },
                 },
-            }
-        )
-
-        self.client.update_publishing(
-            {
-                "camera": {
-                    "sendSettings": {
-                        "maxQuality": "low",
-                        "encodings": {
-                            "low": {
-                                "maxBitrate": 250000,
-                                "scaleResolutionDownBy": 1.333,
-                                "maxFramerate": 8,
-                            }
-                        },
+                "publishing": {
+                    "camera": {
+                        "sendSettings": {
+                            "maxQuality": "low",
+                            "encodings": {
+                                "low": {
+                                    "maxBitrate": 250000,
+                                    "scaleResolutionDownBy": 1.333,
+                                    "maxFramerate": 8,
+                                }
+                            },
+                        }
                     }
-                }
-            }
+                },
+            },
         )
+        self._my_participant_id = self.client.participants()["local"]["id"]
 
-        if self.token and self.start_transcription:
+        self.client.update_subscription_profiles({
+            "base": {
+                "camera": "unsubscribed",
+            }
+        })
+
+        if self._token and self._start_transcription:
             self.client.start_transcription(self.transcription_settings)
 
-    def _receive_audio(self):
-        """Receive audio from the Daily call and put it on the receive queue"""
-        seconds = 1
-        desired_frame_count = self.speaker_sample_rate * seconds
-        while True:
-            buffer = self.speaker.read_frames(desired_frame_count)
-            if len(buffer) > 0:
-                frame = AudioQueueFrame(buffer)
-                if self.loop:
-                    asyncio.run_coroutine_threadsafe(self.receive_queue.put(frame), self.loop)
+        self.original_sigint_handler = signal.getsignal(signal.SIGINT)
+        signal.signal(signal.SIGINT, self.process_interrupt_handler)
 
-    def interrupt(self):
-        self.is_interrupted.set()
+    def process_interrupt_handler(self, signum, frame):
+        self._post_run()
+        if callable(self.original_sigint_handler):
+            self.original_sigint_handler(signum, frame)
 
-    async def get_receive_frames(self) -> AsyncGenerator[QueueFrame, None]:
-        while True:
-            frame = await self.receive_queue.get()
-            yield frame
-            if isinstance(frame, EndStreamQueueFrame):
-                break
-
-    def get_async_send_queue(self):
-        return self.send_queue
-
-    async def marshal_frames(self):
-        while True:
-            frame: QueueFrame | list = await self.send_queue.get()
-            self.threadsafe_send_queue.put(frame)
-            self.send_queue.task_done()
-            if isinstance(frame, EndStreamQueueFrame):
-                break
-
-    async def wait_for_send_queue_to_empty(self):
-        await self.send_queue.join()
-        self.threadsafe_send_queue.join()
-
-    async def stop_when_done(self):
-        await self.wait_for_send_queue_to_empty()
-        self.stop()
-
-    async def run(self) -> None:
-        self.configure_daily()
-
-        self.do_shutdown = False
-
-        async_output_queue_marshal_task = asyncio.create_task(self.marshal_frames())
-
-        try:
-            participant_count: int = len(self.client.participants())
-            self.logger.info(f"{participant_count} participants in room")
-            while time.time() < self.expiration and not self.do_shutdown and not self.stop_threads.is_set():
-                await asyncio.sleep(1)
-        except Exception as e:
-            self.logger.error(f"Exception {e}")
-            raise e
-        finally:
-            self.client.leave()
-
-        self.stop_threads.set()
-
-        await self.receive_queue.put(EndStreamQueueFrame())
-        await self.send_queue.put(EndStreamQueueFrame())
-        await async_output_queue_marshal_task
-
-        if self.camera_thread and self.camera_thread.is_alive():
-            self.camera_thread.join()
-        if self.frame_consumer_thread and self.frame_consumer_thread.is_alive():
-            self.frame_consumer_thread.join()
-
-    def stop(self):
-        self.stop_threads.set()
+    def _post_run(self):
+        self.client.leave()
 
     def on_first_other_participant_joined(self):
         pass
 
     def call_joined(self, join_data, client_error):
-        self.logger.info(f"Call_joined: {join_data}, {client_error}")
-        if self.speaker_enabled:
-            t = Thread(target=self._receive_audio, daemon=True)
-            t.start()
+        self._logger.info(f"Call_joined: {join_data}, {client_error}")
+
+    def dialout(self, number):
+        self.client.start_dialout({"phoneNumber": number})
+
+    def start_recording(self):
+        self.client.start_recording()
 
     def on_error(self, error):
-        self.logger.error(f"on_error: {error}")
+        self._logger.error(f"on_error: {error}")
 
     def on_call_state_updated(self, state):
         pass
 
     def on_participant_joined(self, participant):
-        if not self.other_participant_has_joined and participant["id"] != self.my_participant_id:
-            self.other_participant_has_joined = True
+        if not self._other_participant_has_joined and participant["id"] != self._my_participant_id:
+            self._other_participant_has_joined = True
             self.on_first_other_participant_joined()
 
     def on_participant_left(self, participant, reason):
-        if len(self.client.participants()) < self.min_others_count + 1:
-            self.do_shutdown = True
-        pass
+        if len(self.client.participants()) < self._min_others_count + 1:
+            self._stop_threads.set()
 
     def on_app_message(self, message, sender):
         pass
 
-    def on_transcription_message(self, message:dict):
-        if self.loop:
+    def on_transcription_message(self, message: dict):
+        if self._loop:
             participantId = ""
             if "participantId" in message:
                 participantId = message["participantId"]
             elif "session_id" in message:
                 participantId = message["session_id"]
-            frame = TranscriptionQueueFrame(message["text"], participantId, message["timestamp"])
-            asyncio.run_coroutine_threadsafe(self.receive_queue.put(frame), self.loop)
+            if self._my_participant_id and participantId != self._my_participant_id:
+                frame = TranscriptionQueueFrame(message["text"], participantId, message["timestamp"])
+                asyncio.run_coroutine_threadsafe(self.receive_queue.put(frame), self._loop)
 
     def on_transcription_stopped(self, stopped_by, stopped_by_error):
         pass
@@ -335,77 +264,3 @@ class DailyTransportService(EventHandler):
 
     def on_transcription_started(self, status):
         pass
-
-    def set_image(self, image: bytes):
-        self.image: bytes | None = image
-
-    def run_camera(self):
-        try:
-            while not self.stop_threads.is_set():
-                if self.image:
-                    self.camera.write_frame(self.image)
-
-                time.sleep(1.0 / 8)  # 8 fps
-        except Exception as e:
-            self.logger.error(f"Exception {e} in camera thread.")
-            raise e
-
-    def frame_consumer(self):
-        self.logger.info("🎬 Starting frame consumer thread")
-        b = bytearray()
-        smallest_write_size = 3200
-        all_audio_frames = bytearray()
-        while True:
-            try:
-                frames_or_frame: QueueFrame | list[QueueFrame] = self.threadsafe_send_queue.get()
-                if isinstance(frames_or_frame, QueueFrame):
-                    frames: list[QueueFrame] = [frames_or_frame]
-                elif isinstance(frames_or_frame,  list):
-                    frames: list[QueueFrame] = frames_or_frame
-                else:
-                    raise Exception("Unknown type in output queue")
-
-                for frame in frames:
-                    if isinstance(frame, EndStreamQueueFrame):
-                        self.logger.info("Stopping frame consumer thread")
-                        self.threadsafe_send_queue.task_done()
-                        return
-
-                    # if interrupted, we just pull frames off the queue and discard them
-                    if not self.is_interrupted.is_set():
-                        if frame:
-                            if isinstance(frame, AudioQueueFrame):
-                                chunk = frame.data
-
-                                all_audio_frames.extend(chunk)
-
-                                b.extend(chunk)
-                                l = len(b) - (len(b) % smallest_write_size)
-                                if l:
-                                    self.mic.write_frames(bytes(b[:l]))
-                                    b = b[l:]
-                            elif isinstance(frame, ImageQueueFrame):
-                                self.set_image(frame.image)
-                        elif len(b):
-                            self.mic.write_frames(bytes(b))
-                            b = bytearray()
-                    else:
-                        # if there are leftover audio bytes, write them now; failing to do so
-                        # can cause static in the audio stream.
-                        if len(b):
-                            self.mic.write_frames(bytes(b))
-                            b = bytearray()
-
-                        if isinstance(frame, StartStreamQueueFrame):
-                            self.is_interrupted.clear()
-
-                self.threadsafe_send_queue.task_done()
-            except Empty:
-                try:
-                    if len(b):
-                        self.mic.write_frames(bytes(b))
-                except Exception as e:
-                    self.logger.error(f"Exception in frame_consumer: {e}, {len(b)}")
-                    raise e
-
-                b = bytearray()

src/dailyai/services/deepgram_ai_service.py

@@ -0,0 +1,36 @@
+import os
+import aiohttp
+import requests
+
+from dailyai.services.ai_services import TTSService
+
+
+class DeepgramAIService(TTSService):
+    def __init__(
+        self,
+        *,
+        aiohttp_session: aiohttp.ClientSession,
+        api_key,
+        voice,
+        sample_rate=16000
+    ):
+        super().__init__()
+
+        self._api_key = api_key
+        self._voice = voice
+        self._sample_rate = sample_rate
+        self._aiohttp_session = aiohttp_session
+
+    async def run_tts(self, sentence):
+        self.logger.info(f"Running deepgram tts for {sentence}")
+        base_url = "https://api.beta.deepgram.com/v1/speak"
+        request_url = f"{base_url}?model={self._voice}&encoding=linear16&container=none&sample_rate={self._sample_rate}"
+        headers = {"authorization": f"token {self._api_key}", "Content-Type": "application/json"}
+        data = {"text": sentence}
+
+        async with self._aiohttp_session.post(
+            request_url, headers=headers, json=data
+        ) as r:
+            async for chunk in r.content:
+                if chunk:
+                    yield chunk

src/dailyai/services/deepgram_ai_services.py

@@ -7,23 +7,24 @@ import requests
 from collections.abc import AsyncGenerator
 from dailyai.services.ai_services import TTSService
 
+
 class DeepgramTTSService(TTSService):
-    def __init__(self, speech_key=None, voice=None):
+    def __init__(self, *, aiohttp_session, api_key, voice="alpha-asteria-en-v2"):
         super().__init__()
 
-        self.voice = voice or os.getenv("DEEPGRAM_VOICE") or "alpha-asteria-en-v2"
-        self.speech_key = speech_key or os.getenv("DEEPGRAM_API_KEY")
-    
+        self._voice = voice
+        self._api_key = api_key
+        self._aiohttp_session = aiohttp_session
+
     def get_mic_sample_rate(self):
         return 24000
 
     async def run_tts(self, sentence) -> AsyncGenerator[bytes, None]:
         self.logger.info(f"Running deepgram tts for {sentence}")
         base_url = "https://api.beta.deepgram.com/v1/speak"
-        request_url = f"{base_url}?model={self.voice}&encoding=linear16&container=none&sample_rate=16000"
-        headers = {"authorization": f"token {self.speech_key}"}
-        body = { "text": sentence }
-        async with aiohttp.ClientSession() as session:
-            async with session.post(request_url, headers=headers, json=body) as r:
-                async for data in r.content:
-                    yield data
+        request_url = f"{base_url}?model={self._voice}&encoding=linear16&container=none&sample_rate=16000"
+        headers = {"authorization": f"token {self._api_key}"}
+        body = {"text": sentence}
+        async with self._aiohttp_session.post(request_url, headers=headers, json=body) as r:
+            async for data in r.content:
+                yield data

src/dailyai/services/elevenlabs_ai_service.py

@@ -9,28 +9,37 @@ from dailyai.services.ai_services import TTSService
 
 
 class ElevenLabsTTSService(TTSService):
-    def __init__(self, api_key=None, voice_id=None):
+
+    def __init__(
+        self,
+        *,
+        aiohttp_session: aiohttp.ClientSession,
+        api_key,
+        voice_id,
+    ):
         super().__init__()
 
-        self.api_key = api_key or os.getenv("ELEVENLABS_API_KEY")
-        self.voice_id = voice_id or os.getenv("ELEVENLABS_VOICE_ID")
+        self._api_key = api_key
+        self._voice_id = voice_id
+        self._aiohttp_session = aiohttp_session
 
     async def run_tts(self, sentence) -> AsyncGenerator[bytes, None]:
-        async with aiohttp.ClientSession() as session:
-            url = f"https://api.elevenlabs.io/v1/text-to-speech/{self.voice_id}/stream"
-            payload = {"text": sentence, "model_id": "eleven_turbo_v2"}
-            querystring = {"output_format": "pcm_16000", "optimize_streaming_latency": 2}
-            headers = {
-                "xi-api-key": self.api_key,
-                "Content-Type": "application/json",
-            }
-            async with session.post(url, json=payload, headers=headers, params=querystring) as r:
-                if r.status != 200:
-                    self.logger.error(
-                        f"audio fetch status code: {r.status}, error: {r.text}"
-                    )
-                    return
+        url = f"https://api.elevenlabs.io/v1/text-to-speech/{self._voice_id}/stream"
+        payload = {"text": sentence, "model_id": "eleven_turbo_v2"}
+        querystring = {"output_format": "pcm_16000", "optimize_streaming_latency": 2}
+        headers = {
+            "xi-api-key": self._api_key,
+            "Content-Type": "application/json",
+        }
+        async with self._aiohttp_session.post(
+            url, json=payload, headers=headers, params=querystring
+        ) as r:
+            if r.status != 200:
+                self.logger.error(
+                    f"audio fetch status code: {r.status}, error: {r.text}"
+                )
+                return
 
-                async for chunk in r.content:
-                    if chunk:
-                        yield chunk
+            async for chunk in r.content:
+                if chunk:
+                    yield chunk

src/dailyai/services/fal_ai_services.py

@@ -2,30 +2,43 @@ import fal
 import aiohttp
 import asyncio
 import io
-import json
+import os
 from PIL import Image
 
+from dailyai.services.ai_services import ImageGenService
+
+
+from dailyai.services.ai_services import ImageGenService
 
-from dailyai.services.ai_services import LLMService, TTSService, ImageGenService
 # Fal expects FAL_KEY_ID and FAL_KEY_SECRET to be set in the env
+
+
 class FalImageGenService(ImageGenService):
-    def __init__(self, image_size):
+    def __init__(
+        self,
+        *,
+        image_size,
+        aiohttp_session: aiohttp.ClientSession,
+        key_id=None,
+        key_secret=None
+    ):
         super().__init__(image_size)
+        self._aiohttp_session = aiohttp_session
+        if key_id:
+            os.environ["FAL_KEY_ID"] = key_id
+        if key_secret:
+            os.environ["FAL_KEY_SECRET"] = key_secret
 
     async def run_image_gen(self, sentence) -> tuple[str, bytes]:
         def get_image_url(sentence, size):
-            print("starting fal submit...")
             handler = fal.apps.submit(
                 "110602490-fast-sdxl",
-                arguments={
-                "prompt": sentence
-                },
-                )
-            print("past fal handler init, about to wait for iter_events...")
+                #"fal-ai/fast-sdxl",
+                arguments={"prompt": sentence},
+            )
             for event in handler.iter_events():
                 if isinstance(event, fal.apps.InProgress):
-                    print('Request in progress')
-                    print(event.logs)
+                    pass
 
             result = handler.get()
 
@@ -34,16 +47,10 @@ class FalImageGenService(ImageGenService):
                 raise Exception("Image generation failed")
 
             return image_url
-        print(f"fetching image url...")
-        image_url = await asyncio.to_thread(get_image_url, sentence, self.image_size)
-        print(f"got image url, downloading image...")
-        # Load the image from the url
-        async with aiohttp.ClientSession() as session:
-            async with session.get(image_url) as response:
-                print("got image response")
-                image_stream = io.BytesIO(await response.content.read())
-                print("read image stream")
-                image = Image.open(image_stream)
-                return (image_url, image.tobytes())
 
-        # return (image_url, dalle_im.tobytes())
+        image_url = await asyncio.to_thread(get_image_url, sentence, self.image_size)
+        # Load the image from the url
+        async with self._aiohttp_session.get(image_url) as response:
+            image_stream = io.BytesIO(await response.content.read())
+            image = Image.open(image_stream)
+            return (image_url, image.tobytes())

src/dailyai/services/local_stt_service.py

@@ -1,9 +1,10 @@
 import array
 import io
 import math
+import time
 from typing import AsyncGenerator
 import wave
-from dailyai.queue_frame import AudioQueueFrame, QueueFrame, TextQueueFrame
+from dailyai.pipeline.frames import AudioFrame, Frame, TranscriptionQueueFrame
 from dailyai.services.ai_services import STTService
 
 
@@ -38,9 +39,9 @@ class LocalSTTService(STTService):
         ww.setframerate(self._frame_rate)
         self._wave = ww
 
-    async def process_frame(self, frame: QueueFrame) -> AsyncGenerator[QueueFrame, None]:
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
         """Processes a frame of audio data, either buffering or transcribing it."""
-        if not isinstance(frame, AudioQueueFrame):
+        if not isinstance(frame, AudioFrame):
             return
 
         data = frame.data
@@ -59,7 +60,7 @@ class LocalSTTService(STTService):
             self._content.seek(0)
             text = await self.run_stt(self._content)
             self._new_wave()
-            yield TextQueueFrame(text)
+            yield TranscriptionQueueFrame(text, '', str(time.time()))
         # If we get this far, this is a frame of silence
         self._current_silence_frames += 1
 

src/dailyai/services/local_transport_service.py

@@ -0,0 +1,76 @@
+import asyncio
+import time
+import numpy as np
+import tkinter as tk
+import pyaudio
+
+from dailyai.services.base_transport_service import BaseTransportService
+
+
+class LocalTransportService(BaseTransportService):
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self._sample_width = kwargs.get("sample_width") or 2
+        self._n_channels = kwargs.get("n_channels") or 1
+        self._tk_root = kwargs.get("tk_root") or None
+
+        if self._camera_enabled and not self._tk_root:
+            raise ValueError("If camera is enabled, a tkinter root must be provided")
+
+        if self._speaker_enabled:
+            self._speaker_buffer_pending = bytearray()
+
+    async def _write_frame_to_tkinter(self, frame: bytes):
+        data = f"P6 {self._camera_width} {self._camera_height} 255 ".encode() + frame
+        photo = tk.PhotoImage(
+            width=self._camera_width,
+            height=self._camera_height,
+            data=data,
+            format="PPM")
+        self._image_label.config(image=photo)
+
+        # This holds a reference to the photo, preventing it from being garbage collected.
+        self._image_label.image = photo  # type: ignore
+
+    def write_frame_to_camera(self, frame: bytes):
+        if self._camera_enabled and self._loop:
+            asyncio.run_coroutine_threadsafe(
+                self._write_frame_to_tkinter(frame), self._loop
+            )
+
+    def write_frame_to_mic(self, frame: bytes):
+        self._audio_stream.write(frame)
+
+    def read_frames(self, desired_frame_count):
+        bytes = self._speaker_stream.read(
+            desired_frame_count,
+            exception_on_overflow=False,
+        )
+        return bytes
+
+    def _prerun(self):
+        if self._mic_enabled:
+            self._pyaudio = pyaudio.PyAudio()
+            self._audio_stream = self._pyaudio.open(
+                format=self._pyaudio.get_format_from_width(self._sample_width),
+                channels=self._n_channels,
+                rate=self._speaker_sample_rate,
+                output=True,
+            )
+
+        if self._camera_enabled:
+            # Start with a neutral gray background.
+            array = np.ones((1024, 1024, 3)) * 128
+            data = f"P5 {1024} {1024} 255 ".encode() + array.astype(np.uint8).tobytes()
+            photo = tk.PhotoImage(width=1024, height=1024, data=data, format="PPM")
+            self._image_label = tk.Label(self._tk_root, image=photo)
+            self._image_label.pack()
+
+        if self._speaker_enabled:
+            self._speaker_stream = self._pyaudio.open(
+                format=self._pyaudio.get_format_from_width(self._sample_width),
+                channels=self._n_channels,
+                rate=self._speaker_sample_rate,
+                frames_per_buffer=self._speaker_sample_rate,
+                input=True
+            )

src/dailyai/services/ollama_ai_services.py

@@ -0,0 +1,7 @@
+from dailyai.services.openai_api_llm_service import BaseOpenAILLMService
+
+
+class OLLamaLLMService(BaseOpenAILLMService):
+
+    def __init__(self, model="llama2", base_url="http://localhost:11434/v1"):
+        super().__init__(model=model, base_url=base_url, api_key="ollama")

src/dailyai/services/open_ai_services.py

@@ -1,67 +1,43 @@
-import requests
 import aiohttp
-import asyncio
 from PIL import Image
 import io
+import time
 from openai import AsyncOpenAI
 
-import os
 import json
 from collections.abc import AsyncGenerator
 
-from dailyai.services.ai_services import AIService, TTSService, LLMService, ImageGenService
+from dailyai.services.ai_services import LLMService, ImageGenService
+from dailyai.services.openai_api_llm_service import BaseOpenAILLMService
 
 
-class OpenAILLMService(LLMService):
-    def __init__(self, api_key=None, model=None):
-        super().__init__()
-        api_key = api_key or os.getenv("OPEN_AI_KEY")
-        self.model = model or os.getenv("OPEN_AI_LLM_MODEL") or "gpt-4"
-        self.client = AsyncOpenAI(api_key=api_key)
+class OpenAILLMService(BaseOpenAILLMService):
 
-    async def get_response(self, messages, stream):
-        return await self.client.chat.completions.create(
-            stream=stream,
-            messages=messages,
-            model=self.model
-        )
+    def __init__(self, model="gpt-4", * args, **kwargs):
+        super().__init__(model, *args, **kwargs)
 
-    async def run_llm_async(self, messages) -> AsyncGenerator[str, None]:
-        messages_for_log = json.dumps(messages)
-        self.logger.debug(f"Generating chat via openai: {messages_for_log}")
-
-        response = await self.get_response(messages, stream=True)
-
-        for chunk in response:
-            if len(chunk.choices) == 0:
-                continue
-
-            if chunk.choices[0].delta.content:
-                yield chunk.choices[0].delta.content
-
-    async def run_llm(self, messages) -> str | None:
-        messages_for_log = json.dumps(messages)
-        self.logger.debug(f"Generating chat via openai: {messages_for_log}")
-
-        response = await self.get_response(messages, stream=False)
-        if response and len(response.choices) > 0:
-            return response.choices[0].message.content
-        else:
-            return None
 
 class OpenAIImageGenService(ImageGenService):
-    def __init__(self, image_size:str, api_key=None, model=None):
+
+    def __init__(
+        self,
+        *,
+        image_size: str,
+        aiohttp_session: aiohttp.ClientSession,
+        api_key,
+        model="dall-e-3",
+    ):
         super().__init__(image_size=image_size)
-        api_key = api_key or os.getenv("OPEN_AI_KEY")
-        self.model = model or os.getenv("OPEN_AI_IMAGE_MODEL") or "dall-e-3"
-        self.client = AsyncOpenAI(api_key=api_key)
+        self._model = model
+        self._client = AsyncOpenAI(api_key=api_key)
+        self._aiohttp_session = aiohttp_session
 
     async def run_image_gen(self, sentence) -> tuple[str, bytes]:
         self.logger.info("Generating OpenAI image", sentence)
 
-        image = await self.client.images.generate(
+        image = await self._client.images.generate(
             prompt=sentence,
-            model=self.model,
+            model=self._model,
             n=1,
             size=self.image_size
         )
@@ -70,10 +46,7 @@ class OpenAIImageGenService(ImageGenService):
             raise Exception("No image provided in response", image)
 
         # Load the image from the url
-        async with aiohttp.ClientSession() as session:
-            async with session.get(image_url) as response:
-                image_stream = io.BytesIO(await response.content.read())
-                image = Image.open(image_stream)
-                return (image_url, image.tobytes())
-
-        return (image_url, dalle_im.tobytes())
+        async with self._aiohttp_session.get(image_url) as response:
+            image_stream = io.BytesIO(await response.content.read())
+            image = Image.open(image_stream)
+            return (image_url, image.tobytes())

src/dailyai/services/openai_api_llm_service.py

@@ -0,0 +1,120 @@
+import json
+import time
+from typing import AsyncGenerator, List
+from openai import AsyncOpenAI, AsyncStream
+from dailyai.pipeline.frames import (
+    Frame,
+    LLMFunctionCallFrame,
+    LLMFunctionStartFrame,
+    LLMMessagesQueueFrame,
+    LLMResponseEndFrame,
+    LLMResponseStartFrame,
+    OpenAILLMContextFrame,
+    TextFrame,
+)
+from dailyai.services.ai_services import LLMService
+from dailyai.services.openai_llm_context import OpenAILLMContext
+
+from openai.types.chat import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    ChatCompletionMessageParam,
+)
+
+
+class BaseOpenAILLMService(LLMService):
+    """This is the base for all services that use the AsyncOpenAI client.
+
+    This service consumes OpenAILLMContextFrame frames, which contain a reference
+    to an OpenAILLMContext frame. The OpenAILLMContext object defines the context
+    sent to the LLM for a completion. This includes user, assistant and system messages
+    as well as tool choices and the tool, which is used if requesting function
+    calls from the LLM.
+    """
+
+    def __init__(self, model: str, api_key=None, base_url=None):
+        super().__init__()
+        self._model: str = model
+        self._client = AsyncOpenAI(api_key=api_key, base_url=base_url)
+
+    async def _stream_chat_completions(
+        self, context: OpenAILLMContext
+    ) -> AsyncStream[ChatCompletionChunk]:
+        messages: List[ChatCompletionMessageParam] = context.get_messages()
+        messages_for_log = json.dumps(messages)
+        self.logger.debug(f"Generating chat via openai: {messages_for_log}")
+
+        start_time = time.time()
+        chunks: AsyncStream[ChatCompletionChunk] = (
+            await self._client.chat.completions.create(
+                model=self._model,
+                stream=True,
+                messages=messages,
+                tools=context.tools,
+                tool_choice=context.tool_choice,
+            )
+        )
+        self.logger.info(f"=== OpenAI LLM TTFB: {time.time() - start_time}")
+        return chunks
+
+    async def _chat_completions(self, messages) -> str | None:
+        messages_for_log = json.dumps(messages)
+        self.logger.debug(f"Generating chat via openai: {messages_for_log}")
+
+        response: ChatCompletion = await self._client.chat.completions.create(
+            model=self._model, stream=False, messages=messages
+        )
+        if response and len(response.choices) > 0:
+            return response.choices[0].message.content
+        else:
+            return None
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, OpenAILLMContextFrame):
+            context: OpenAILLMContext = frame.context
+        elif isinstance(frame, LLMMessagesQueueFrame):
+            context = OpenAILLMContext.from_messages(frame.messages)
+        else:
+            yield frame
+            return
+
+        function_name = ""
+        arguments = ""
+
+        yield LLMResponseStartFrame()
+        chunk_stream: AsyncStream[ChatCompletionChunk] = (
+            await self._stream_chat_completions(context)
+        )
+        async for chunk in chunk_stream:
+            if len(chunk.choices) == 0:
+                continue
+
+            if chunk.choices[0].delta.tool_calls:
+                # We're streaming the LLM response to enable the fastest response times.
+                # For text, we just yield each chunk as we receive it and count on consumers
+                # to do whatever coalescing they need (eg. to pass full sentences to TTS)
+                #
+                # If the LLM is a function call, we'll do some coalescing here.
+                # If the response contains a function name, we'll yield a frame to tell consumers
+                # that they can start preparing to call the function with that name.
+                # We accumulate all the arguments for the rest of the streamed response, then when
+                # the response is done, we package up all the arguments and the function name and
+                # yield a frame containing the function name and the arguments.
+
+                tool_call = chunk.choices[0].delta.tool_calls[0]
+                if tool_call.function and tool_call.function.name:
+                    function_name += tool_call.function.name
+                    yield LLMFunctionStartFrame(function_name=tool_call.function.name)
+                if tool_call.function and tool_call.function.arguments:
+                    # Keep iterating through the response to collect all the argument fragments and
+                    # yield a complete LLMFunctionCallFrame after run_llm_async completes
+                    arguments += tool_call.function.arguments
+            elif chunk.choices[0].delta.content:
+                yield TextFrame(chunk.choices[0].delta.content)
+
+        # if we got a function name and arguments, yield the frame with all the info so
+        # frame consumers can take action based on the function call.
+        if function_name and arguments:
+            yield LLMFunctionCallFrame(function_name=function_name, arguments=arguments)
+
+        yield LLMResponseEndFrame()

src/dailyai/services/openai_llm_context.py

@@ -0,0 +1,52 @@
+from typing import List
+from openai._types import NOT_GIVEN, NotGiven
+
+from openai.types.chat import (
+    ChatCompletionToolParam,
+    ChatCompletionToolChoiceOptionParam,
+    ChatCompletionMessageParam,
+)
+
+
+class OpenAILLMContext:
+
+    def __init__(
+        self,
+        messages: List[ChatCompletionMessageParam] | None = None,
+        tools: List[ChatCompletionToolParam] | NotGiven = NOT_GIVEN,
+        tool_choice: ChatCompletionToolChoiceOptionParam | NotGiven = NOT_GIVEN
+    ):
+        self.messages: List[ChatCompletionMessageParam] = messages if messages else []
+        self.tool_choice: ChatCompletionToolChoiceOptionParam | NotGiven = tool_choice
+        self.tools: List[ChatCompletionToolParam] | NotGiven = tools
+
+    @staticmethod
+    def from_messages(messages: List[dict]) -> "OpenAILLMContext":
+        context = OpenAILLMContext()
+        for message in messages:
+            context.add_message({
+                "content":message["content"],
+                "role":message["role"],
+                "name":message["name"] if "name" in message else message["role"]
+            })
+        return context
+
+    #def __deepcopy__(self, memo):
+
+    def add_message(self, message: ChatCompletionMessageParam):
+        self.messages.append(message)
+
+    def get_messages(self) -> List[ChatCompletionMessageParam]:
+        return self.messages
+
+    def set_tool_choice(
+        self, tool_choice: ChatCompletionToolChoiceOptionParam | NotGiven
+    ):
+        self.tool_choice = tool_choice
+
+    def set_tools(self, tools:List[ChatCompletionToolParam] | NotGiven = NOT_GIVEN):
+        if tools != NOT_GIVEN and len(tools) == 0:
+            tools = NOT_GIVEN
+
+        self.tools = tools
+

src/dailyai/services/playht_ai_service.py

@@ -1,36 +1,40 @@
 import io
-import os
 import struct
 from pyht import Client
-from dotenv import load_dotenv
 from pyht.client import TTSOptions
 from pyht.protos.api_pb2 import Format
 
-from services.ai_service import AIService
+from dailyai.services.ai_services import TTSService
 
-class PlayHTAIService(AIService):
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
 
-        self.speech_key = os.getenv("PLAY_HT_KEY") or ''
-        self.user_id = os.getenv("PLAY_HT_USER_ID") or ''
+class PlayHTAIService(TTSService):
+
+    def __init__(
+        self,
+        *,
+        api_key,
+        user_id,
+        voice_url
+    ):
+        super().__init__()
+
+        self.speech_key = api_key
+        self.user_id = user_id
 
         self.client = Client(
             user_id=self.user_id,
             api_key=self.speech_key,
         )
         self.options = TTSOptions(
-            voice="s3://voice-cloning-zero-shot/820da3d2-3a3b-42e7-844d-e68db835a206/sarah/manifest.json",
+            voice=voice_url,
             sample_rate=16000,
             quality="higher",
-            format=Format.FORMAT_WAV
-        )
+            format=Format.FORMAT_WAV)
 
-    def close(self):
-        super().close()
+    def __del__(self):
         self.client.close()
 
-    def run_tts(self, sentence):
+    async def run_tts(self, sentence):
         b = bytearray()
         in_header = True
         for chunk in self.client.tts(sentence, self.options):
@@ -43,14 +47,15 @@ class PlayHTAIService(AIService):
                     fh = io.BytesIO(b)
                     fh.seek(36)
                     (data, size) = struct.unpack('<4sI', fh.read(8))
-                    self.logger.info(f"first attempt: data: {data}, size: {hex(size)}, position: {fh.tell()}")
+                    self.logger.info(
+                        f"first attempt: data: {data}, size: {hex(size)}, position: {fh.tell()}")
                     while data != b'data':
                         fh.read(size)
                         (data, size) = struct.unpack('<4sI', fh.read(8))
-                        self.logger.info(f"subsequent data: {data}, size: {hex(size)}, position: {fh.tell()}, data != data: {data != b'data'}")
+                        self.logger.info(
+                            f"subsequent data: {data}, size: {hex(size)}, position: {fh.tell()}, data != data: {data != b'data'}")
                     self.logger.info("position: ", fh.tell())
                     in_header = False
             else:
                 if len(chunk):
                     yield chunk
-

src/dailyai/services/to_be_updated/cloudflare_ai_service.py

@@ -4,6 +4,8 @@ from services.ai_service import AIService
 
 # Note that Cloudflare's AI workers are still in beta.
 # https://developers.cloudflare.com/workers-ai/
+
+
 class CloudflareAIService(AIService):
     def __init__(self):
         super().__init__()
@@ -19,11 +21,11 @@ class CloudflareAIService(AIService):
         return response.json()
 
     # https://developers.cloudflare.com/workers-ai/models/llm/
-    def run_llm(self, messages, latest_user_message=None, stream = True):
+    def run_llm(self, messages, latest_user_message=None, stream=True):
         input = {
             "messages": [
-                { "role": "system", "content": "You are a friendly assistant" },
-                { "role": "user", "content": sentence }
+                {"role": "system", "content": "You are a friendly assistant"},
+                {"role": "user", "content": sentence}
             ]
         }
 
@@ -57,9 +59,9 @@ class CloudflareAIService(AIService):
     # https://developers.cloudflare.com/workers-ai/models/embedding/
     def run_embeddings(self, texts, size="medium"):
         models = {
-            "small": "@cf/baai/bge-small-en-v1.5", # 384 output dimensions
-            "medium": "@cf/baai/bge-base-en-v1.5", # 768 output dimensions
-            "large": "@cf/baai/bge-large-en-v1.5" #1024 output dimensions
+            "small": "@cf/baai/bge-small-en-v1.5",  # 384 output dimensions
+            "medium": "@cf/baai/bge-base-en-v1.5",  # 768 output dimensions
+            "large": "@cf/baai/bge-large-en-v1.5"  # 1024 output dimensions
         }
 
         return self.run(models[size], {"text": texts})

src/dailyai/services/to_be_updated/deepgram_ai_service.py

@@ -1,28 +0,0 @@
-import os
-import requests
-
-from services.ai_service import AIService
-from PIL import Image
-
-
-class DeepgramAIService(AIService):
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-
-        self.api_key = os.getenv("DEEPGRAM_API_KEY")
-
-    def get_mic_sample_rate(self):
-        return 24000
-
-    def run_tts(self, sentence):
-        self.logger.info(f"Running deepgram tts for {sentence}")
-        base_url = "https://api.beta.deepgram.com/v1/speak"
-        voice = os.getenv("DEEPGRAM_VOICE") or "alpha-apollo-en-v1"  # move this to an environment variable
-        request_url = f"{base_url}?model={voice}&encoding=linear16&container=none"
-        headers = {"authorization": f"token {self.api_key}"}
-
-        r = requests.post(request_url, headers=headers, data=sentence)
-        self.logger.info(
-            f"audio fetch status code: {r.status_code}, content length: {len(r.content)}"
-        )
-        yield r.content

src/dailyai/services/to_be_updated/google_ai_service.py

@@ -2,9 +2,12 @@ from services.ai_service import AIService
 import openai
 import os
 
-# To use Google Cloud's AI products, you'll need to install Google Cloud CLI and enable the TTS and in your project: https://cloud.google.com/sdk/docs/install
+# To use Google Cloud's AI products, you'll need to install Google Cloud
+# CLI and enable the TTS and in your project:
+# https://cloud.google.com/sdk/docs/install
 from google.cloud import texttospeech
 
+
 class GoogleAIService(AIService):
     def __init__(self):
         super().__init__()
@@ -15,11 +18,14 @@ class GoogleAIService(AIService):
         )
 
         self.audio_config = texttospeech.AudioConfig(
-            audio_encoding = texttospeech.AudioEncoding.LINEAR16,
-            sample_rate_hertz = 16000
+            audio_encoding=texttospeech.AudioEncoding.LINEAR16,
+            sample_rate_hertz=16000
         )
 
     def run_tts(self, sentence):
-        synthesis_input = texttospeech.SynthesisInput(text = sentence.strip())
-        result = self.client.synthesize_speech(input=synthesis_input, voice=self.voice, audio_config=self.audio_config)
+        synthesis_input = texttospeech.SynthesisInput(text=sentence.strip())
+        result = self.client.synthesize_speech(
+            input=synthesis_input,
+            voice=self.voice,
+            audio_config=self.audio_config)
         return result

src/dailyai/services/to_be_updated/huggingface_ai_service.py

@@ -1,7 +1,12 @@
 from services.ai_service import AIService
 from transformers import pipeline
 
-# These functions are just intended for testing, not production use. If you'd like to use HuggingFace, you should use your own models, or do some research into the specific models that will work best for your use case.
+# These functions are just intended for testing, not production use. If
+# you'd like to use HuggingFace, you should use your own models, or do
+# some research into the specific models that will work best for your use
+# case.
+
+
 class HuggingFaceAIService(AIService):
     def __init__(self):
         super().__init__()
@@ -10,9 +15,12 @@ class HuggingFaceAIService(AIService):
         classifier = pipeline("sentiment-analysis")
         return classifier(sentence)
 
-    # available models at https://huggingface.co/Helsinki-NLP (**not all models use 2-character language codes**)
+    # available models at https://huggingface.co/Helsinki-NLP (**not all
+    # models use 2-character language codes**)
     def run_text_translation(self, sentence, source_language, target_language):
-        translator = pipeline(f"translation", model=f"Helsinki-NLP/opus-mt-{source_language}-{target_language}")
+        translator = pipeline(
+            f"translation",
+            model=f"Helsinki-NLP/opus-mt-{source_language}-{target_language}")
 
         return translator(sentence)[0]["translation_text"]
 

src/dailyai/services/to_be_updated/mock_ai_service.py

@@ -4,6 +4,7 @@ import time
 from PIL import Image
 from services.ai_service import AIService
 
+
 class MockAIService(AIService):
     def __init__(self):
         super().__init__()
@@ -20,8 +21,7 @@ class MockAIService(AIService):
         time.sleep(1)
         return (image_url, image)
 
-    def run_llm(self, messages, latest_user_message=None, stream = True):
+    def run_llm(self, messages, latest_user_message=None, stream=True):
         for i in range(5):
             time.sleep(1)
-            yield({"choices": [{"delta": {"content": f"hello {i}!"}}]})
-
+            yield ({"choices": [{"delta": {"content": f"hello {i}!"}}]})

src/dailyai/services/whisper_ai_services.py

@@ -46,7 +46,7 @@ class WhisperSTTService(LocalSTTService):
             compute_type=self._compute_type)
         self._model = model
 
-    async def run_stt(self, audio: BinaryIO = None) -> str:
+    async def run_stt(self, audio: BinaryIO) -> str:
         """Transcribes given audio using Whisper"""
         segments, _ = await asyncio.to_thread(self._model.transcribe, audio)
         res: str = ""

src/dailyai/tests/integration/integration_azure_llm.py

@@ -0,0 +1,29 @@
+import asyncio
+import os
+from dailyai.pipeline.frames import (
+    OpenAILLMContextFrame,
+)
+from dailyai.services.azure_ai_services import AzureLLMService
+from dailyai.services.openai_llm_context import OpenAILLMContext
+
+from openai.types.chat import (
+    ChatCompletionSystemMessageParam,
+)
+
+if __name__=="__main__":
+    async def test_chat():
+        llm = AzureLLMService(
+            api_key=os.getenv("AZURE_CHATGPT_API_KEY"),
+            endpoint=os.getenv("AZURE_CHATGPT_ENDPOINT"),
+            model=os.getenv("AZURE_CHATGPT_MODEL"),
+        )
+        context = OpenAILLMContext()
+        message: ChatCompletionSystemMessageParam = ChatCompletionSystemMessageParam(
+            content="Please tell the world hello.", name="system", role="system"
+        )
+        context.add_message(message)
+        frame = OpenAILLMContextFrame(context)
+        async for s in llm.process_frame(frame):
+            print(s)
+
+    asyncio.run(test_chat())

src/dailyai/tests/integration/integration_ollama_llm.py

@@ -0,0 +1,24 @@
+import asyncio
+from dailyai.pipeline.frames import (
+    OpenAILLMContextFrame,
+)
+from dailyai.services.openai_llm_context import OpenAILLMContext
+
+from openai.types.chat import (
+    ChatCompletionSystemMessageParam,
+)
+from dailyai.services.ollama_ai_services import OLLamaLLMService
+
+if __name__=="__main__":
+    async def test_chat():
+        llm = OLLamaLLMService()
+        context = OpenAILLMContext()
+        message: ChatCompletionSystemMessageParam = ChatCompletionSystemMessageParam(
+            content="Please tell the world hello.", name="system", role="system"
+        )
+        context.add_message(message)
+        frame = OpenAILLMContextFrame(context)
+        async for s in llm.process_frame(frame):
+            print(s)
+
+    asyncio.run(test_chat())

src/dailyai/tests/integration/integration_openai_llm.py

@@ -0,0 +1,84 @@
+import asyncio
+import os
+from dailyai.pipeline.frames import (
+    OpenAILLMContextFrame,
+)
+from dailyai.services.openai_llm_context import OpenAILLMContext
+
+from openai.types.chat import (
+    ChatCompletionSystemMessageParam,
+    ChatCompletionToolParam,
+    ChatCompletionUserMessageParam,
+)
+
+from dailyai.services.openai_api_llm_service import BaseOpenAILLMService
+
+if __name__ == "__main__":
+    async def test_functions():
+        tools = [
+            ChatCompletionToolParam(
+                type="function",
+                function= {
+                    "name": "get_current_weather",
+                    "description": "Get the current weather",
+                    "parameters": {
+                        "type": "object",
+                        "properties": {
+                            "location": {
+                                "type": "string",
+                                "description": "The city and state, e.g. San Francisco, CA",
+                            },
+                            "format": {
+                                "type": "string",
+                                "enum": ["celsius", "fahrenheit"],
+                                "description": "The temperature unit to use. Infer this from the users location.",
+                            },
+                        },
+                        "required": ["location", "format"],
+                    },
+                }
+            )
+        ]
+
+        api_key = os.getenv("OPENAI_API_KEY")
+
+        llm = BaseOpenAILLMService(
+            api_key=api_key or "",
+            model="gpt-4-1106-preview",
+        )
+        context = OpenAILLMContext(tools=tools)
+        system_message: ChatCompletionSystemMessageParam = ChatCompletionSystemMessageParam(
+            content="Ask the user to ask for a weather report", name="system", role="system"
+        )
+        user_message: ChatCompletionUserMessageParam = ChatCompletionUserMessageParam(
+            content="Could you tell me the weather for Boulder, Colorado",
+            name="user",
+            role="user",
+        )
+        context.add_message(system_message)
+        context.add_message(user_message)
+        frame = OpenAILLMContextFrame(context)
+        async for s in llm.process_frame(frame):
+            print(s)
+
+    async def test_chat():
+        api_key = os.getenv("OPENAI_API_KEY")
+
+        llm = BaseOpenAILLMService(
+            api_key=api_key or "",
+            model="gpt-4-1106-preview",
+        )
+        context = OpenAILLMContext()
+        message: ChatCompletionSystemMessageParam = ChatCompletionSystemMessageParam(
+            content="Please tell the world hello.", name="system", role="system"
+        )
+        context.add_message(message)
+        frame = OpenAILLMContextFrame(context)
+        async for s in llm.process_frame(frame):
+            print(s)
+
+    async def run_tests():
+        await test_functions()
+        await test_chat()
+
+    asyncio.run(run_tests())

src/dailyai/tests/test_aggregators.py

@@ -0,0 +1,128 @@
+import asyncio
+import doctest
+import functools
+import unittest
+
+from dailyai.pipeline.aggregators import (
+    GatedAggregator,
+    ParallelPipeline,
+    SentenceAggregator,
+    StatelessTextTransformer,
+)
+from dailyai.pipeline.frames import (
+    AudioFrame,
+    EndFrame,
+    ImageFrame,
+    LLMResponseEndFrame,
+    LLMResponseStartFrame,
+    Frame,
+    TextFrame,
+)
+
+from dailyai.pipeline.pipeline import Pipeline
+
+
+class TestDailyFrameAggregators(unittest.IsolatedAsyncioTestCase):
+    async def test_sentence_aggregator(self):
+        sentence = "Hello, world. How are you? I am fine"
+        expected_sentences = ["Hello, world.", " How are you?", " I am fine "]
+        aggregator = SentenceAggregator()
+        for word in sentence.split(" "):
+            async for sentence in aggregator.process_frame(TextFrame(word + " ")):
+                self.assertIsInstance(sentence, TextFrame)
+                if isinstance(sentence, TextFrame):
+                    self.assertEqual(sentence.text, expected_sentences.pop(0))
+
+        async for sentence in aggregator.process_frame(EndFrame()):
+            if len(expected_sentences):
+                self.assertIsInstance(sentence, TextFrame)
+                if isinstance(sentence, TextFrame):
+                    self.assertEqual(sentence.text, expected_sentences.pop(0))
+            else:
+                self.assertIsInstance(sentence, EndFrame)
+
+        self.assertEqual(expected_sentences, [])
+
+    async def test_gated_accumulator(self):
+        gated_aggregator = GatedAggregator(
+            gate_open_fn=lambda frame: isinstance(frame, ImageFrame),
+            gate_close_fn=lambda frame: isinstance(frame, LLMResponseStartFrame),
+            start_open=False,
+        )
+
+        frames = [
+            LLMResponseStartFrame(),
+            TextFrame("Hello, "),
+            TextFrame("world."),
+            AudioFrame(b"hello"),
+            ImageFrame("image", b"image"),
+            AudioFrame(b"world"),
+            LLMResponseEndFrame(),
+        ]
+
+        expected_output_frames = [
+            ImageFrame("image", b"image"),
+            LLMResponseStartFrame(),
+            TextFrame("Hello, "),
+            TextFrame("world."),
+            AudioFrame(b"hello"),
+            AudioFrame(b"world"),
+            LLMResponseEndFrame(),
+        ]
+        for frame in frames:
+            async for out_frame in gated_aggregator.process_frame(frame):
+                self.assertEqual(out_frame, expected_output_frames.pop(0))
+        self.assertEqual(expected_output_frames, [])
+
+    async def test_parallel_pipeline(self):
+
+        async def slow_add(sleep_time:float, name:str, x: str):
+            await asyncio.sleep(sleep_time)
+            return ":".join([x, name])
+
+        pipe1_annotation = StatelessTextTransformer(functools.partial(slow_add, 0.1, 'pipe1'))
+        pipe2_annotation = StatelessTextTransformer(functools.partial(slow_add, 0.2, 'pipe2'))
+        sentence_aggregator = SentenceAggregator()
+        add_dots = StatelessTextTransformer(lambda x: x + ".")
+
+        source = asyncio.Queue()
+        sink = asyncio.Queue()
+        pipeline = Pipeline(
+            [
+                ParallelPipeline(
+                    [[pipe1_annotation], [sentence_aggregator, pipe2_annotation]]
+                ),
+                add_dots,
+            ],
+            source,
+            sink,
+        )
+
+        frames = [
+            TextFrame("Hello, "),
+            TextFrame("world."),
+            EndFrame()
+        ]
+
+        expected_output_frames: list[Frame] = [
+            TextFrame(text='Hello, :pipe1.'),
+            TextFrame(text='world.:pipe1.'),
+            TextFrame(text='Hello, world.:pipe2.'),
+            EndFrame()
+        ]
+
+        for frame in frames:
+            await source.put(frame)
+
+        await pipeline.run_pipeline()
+
+        while not sink.empty():
+            frame = await sink.get()
+            self.assertEqual(frame, expected_output_frames.pop(0))
+
+
+def load_tests(loader, tests, ignore):
+    """ Run doctests on the aggregators module. """
+    from dailyai.pipeline import aggregators
+    tests.addTests(doctest.DocTestSuite(aggregators))
+    return tests

src/dailyai/tests/test_ai_services.py

@@ -1,24 +1,26 @@
-from re import A
 import unittest
 
 from typing import AsyncGenerator, Generator
 
 from dailyai.services.ai_services import AIService
-from dailyai.queue_frame import EndStreamQueueFrame, QueueFrame, TextQueueFrame
+from dailyai.pipeline.frames import EndFrame, Frame, TextFrame
+
 
 class SimpleAIService(AIService):
-    async def process_frame(self, frame: QueueFrame) -> AsyncGenerator[QueueFrame, None]:
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
         yield frame
 
+
 class TestBaseAIService(unittest.IsolatedAsyncioTestCase):
     async def test_async_input(self):
         service = SimpleAIService()
 
         input_frames = [
-            TextQueueFrame("hello"),
-            EndStreamQueueFrame()
+            TextFrame("hello"),
+            EndFrame()
         ]
-        async def iterate_frames() -> AsyncGenerator[QueueFrame, None]:
+
+        async def iterate_frames() -> AsyncGenerator[Frame, None]:
             for frame in input_frames:
                 yield frame
 
@@ -31,9 +33,9 @@ class TestBaseAIService(unittest.IsolatedAsyncioTestCase):
     async def test_nonasync_input(self):
         service = SimpleAIService()
 
-        input_frames = [TextQueueFrame("hello"), EndStreamQueueFrame()]
+        input_frames = [TextFrame("hello"), EndFrame()]
 
-        def iterate_frames() -> Generator[QueueFrame, None, None]:
+        def iterate_frames() -> Generator[Frame, None, None]:
             for frame in input_frames:
                 yield frame
 

src/dailyai/tests/test_daily_transport_service.py

@@ -0,0 +1,92 @@
+import asyncio
+import threading
+import unittest
+
+from unittest.mock import MagicMock, patch
+
+from dailyai.pipeline.frames import AudioFrame, ImageFrame
+
+
+class TestDailyTransport(unittest.IsolatedAsyncioTestCase):
+
+    async def test_event_handler(self):
+        from dailyai.services.daily_transport_service import DailyTransportService
+
+        transport = DailyTransportService("mock.daily.co/mock", "token", "bot")
+
+        was_called = False
+
+        @transport.event_handler("on_first_other_participant_joined")
+        def test_event_handler(transport):
+            nonlocal was_called
+            was_called = True
+
+        transport.on_first_other_participant_joined()
+
+        self.assertTrue(was_called)
+
+    """
+    TODO: fix this test, it broke when I added the `.result` call in the patch.
+    async def test_event_handler_async(self):
+        from dailyai.services.daily_transport_service import DailyTransportService
+
+        transport = DailyTransportService("mock.daily.co/mock", "token", "bot")
+
+        event = asyncio.Event()
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def test_event_handler(transport):
+            nonlocal event
+            print("sleeping")
+            await asyncio.sleep(0.1)
+            print("setting")
+            event.set()
+            print("returning")
+
+        thread = threading.Thread(target=transport.on_first_other_participant_joined)
+        thread.start()
+        thread.join()
+
+        await asyncio.wait_for(event.wait(), timeout=1)
+        self.assertTrue(event.is_set())
+    """
+
+    """
+    @patch("dailyai.services.daily_transport_service.CallClient")
+    @patch("dailyai.services.daily_transport_service.Daily")
+    async def test_run_with_camera_and_mic(self, daily_mock, callclient_mock):
+        from dailyai.services.daily_transport_service import DailyTransportService
+        transport = DailyTransportService(
+            "https://mock.daily.co/mock",
+            "token",
+            "bot",
+            mic_enabled=True,
+            camera_enabled=True,
+            duration_minutes=0.01,
+        )
+
+        mic = MagicMock()
+        camera = MagicMock()
+        daily_mock.create_microphone_device.return_value = mic
+        daily_mock.create_camera_device.return_value = camera
+
+        async def send_audio_frame():
+            await transport.send_queue.put(AudioQueueFrame(bytes([0] * 3300)))
+
+        async def send_video_frame():
+            await transport.send_queue.put(ImageQueueFrame(None, b"test"))
+
+        await asyncio.gather(transport.run(), send_audio_frame(), send_video_frame())
+
+        daily_mock.init.assert_called_once_with()
+        daily_mock.create_microphone_device.assert_called_once()
+        daily_mock.create_camera_device.assert_called_once()
+
+        callclient_mock.return_value.set_user_name.assert_called_once_with("bot")
+        callclient_mock.return_value.join.assert_called_once_with(
+            "https://mock.daily.co/mock", "token", completion=transport.call_joined
+        )
+
+        camera.write_frame.assert_called_with(b"test")
+        mic.write_frames.assert_called()
+    """

src/dailyai/tests/test_pipeline.py

@@ -0,0 +1,59 @@
+import asyncio
+import unittest
+from dailyai.pipeline.aggregators import SentenceAggregator, StatelessTextTransformer
+from dailyai.pipeline.frames import EndFrame, TextFrame
+
+from dailyai.pipeline.pipeline import Pipeline
+
+
+class TestDailyPipeline(unittest.IsolatedAsyncioTestCase):
+
+    async def test_pipeline_simple(self):
+        aggregator = SentenceAggregator()
+
+        outgoing_queue = asyncio.Queue()
+        incoming_queue = asyncio.Queue()
+        pipeline = Pipeline([aggregator], incoming_queue, outgoing_queue)
+
+        await incoming_queue.put(TextFrame("Hello, "))
+        await incoming_queue.put(TextFrame("world."))
+        await incoming_queue.put(EndFrame())
+
+        await pipeline.run_pipeline()
+
+        self.assertEqual(await outgoing_queue.get(), TextFrame("Hello, world."))
+        self.assertIsInstance(await outgoing_queue.get(), EndFrame)
+
+    async def test_pipeline_multiple_stages(self):
+        sentence_aggregator = SentenceAggregator()
+        to_upper = StatelessTextTransformer(lambda x: x.upper())
+        add_space = StatelessTextTransformer(lambda x: x + " ")
+
+        outgoing_queue = asyncio.Queue()
+        incoming_queue = asyncio.Queue()
+        pipeline = Pipeline(
+            [add_space, sentence_aggregator, to_upper],
+            incoming_queue,
+            outgoing_queue
+        )
+
+        sentence = "Hello, world. It's me, a pipeline."
+        for c in sentence:
+            await incoming_queue.put(TextFrame(c))
+        await incoming_queue.put(EndFrame())
+
+        await pipeline.run_pipeline()
+
+        self.assertEqual(
+            await outgoing_queue.get(), TextFrame("H E L L O ,   W O R L D .")
+        )
+        self.assertEqual(
+            await outgoing_queue.get(),
+            TextFrame("   I T ' S   M E ,   A   P I P E L I N E ."),
+        )
+        # leftover little bit because of the spacing
+        self.assertEqual(
+            await outgoing_queue.get(),
+            TextFrame(" "),
+        )
+        self.assertIsInstance(await outgoing_queue.get(), EndFrame)

src/examples/foundational/01-say-one-thing.py

@@ -0,0 +1,61 @@
+import asyncio
+import aiohttp
+import logging
+import os
+
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            None,
+            "Say One Thing",
+            mic_enabled=True,
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        other_joined_event = asyncio.Event()
+        participant_name = ''
+
+        async def say_hello():
+            nonlocal tts
+            nonlocal participant_name
+
+            await other_joined_event.wait()
+            await tts.say(
+                "Hello there, " + participant_name + "!",
+                transport.send_queue,
+            )
+            await transport.stop_when_done()
+
+        # Register an event handler so we can play the audio when the participant joins.
+        @transport.event_handler("on_participant_joined")
+        async def on_participant_joined(transport, participant):
+            if participant["info"]["isLocal"]:
+                return
+
+            nonlocal participant_name
+            participant_name = participant["info"]["userName"] or ''
+            other_joined_event.set()
+
+        await asyncio.gather(transport.run(), say_hello())
+        del tts
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url))

src/examples/foundational/01a-local-transport.py

@@ -0,0 +1,37 @@
+import asyncio
+import aiohttp
+import logging
+import os
+
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.services.local_transport_service import LocalTransportService
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        meeting_duration_minutes = 1
+        transport = LocalTransportService(
+            duration_minutes=meeting_duration_minutes, mic_enabled=True
+        )
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        async def say_something():
+            await asyncio.sleep(1)
+            await tts.say(
+                "Hello there.",
+                transport.send_queue,
+            )
+            await transport.stop_when_done()
+
+        await asyncio.gather(transport.run(), say_something())
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

src/examples/foundational/02-llm-say-one-thing.py

@@ -0,0 +1,63 @@
+import asyncio
+import os
+import logging
+
+import aiohttp
+
+from dailyai.pipeline.frames import LLMMessagesQueueFrame
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.services.open_ai_services import OpenAILLMService
+
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            None,
+            "Say One Thing From an LLM",
+            mic_enabled=True,
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+
+        messages = [
+            {
+                "role": "system",
+                "content": "You are an LLM in a WebRTC session, and this is a 'hello world' demo. Say hello to the world.",
+            }
+        ]
+
+        other_joined_event = asyncio.Event()
+        async def speak_from_llm():
+            await other_joined_event.wait()
+            await tts.run_to_queue(
+                transport.send_queue,
+                llm.run([LLMMessagesQueueFrame(messages)])
+            )
+            await transport.stop_when_done()
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            other_joined_event.set()
+
+        await asyncio.gather(transport.run(), speak_from_llm())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url))

src/examples/foundational/03-still-frame.py

@@ -0,0 +1,53 @@
+import asyncio
+import aiohttp
+import logging
+import os
+
+from dailyai.pipeline.frames import TextFrame
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.fal_ai_services import FalImageGenService
+
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            None,
+            "Show a still frame image",
+            camera_enabled=True,
+            camera_width=1024,
+            camera_height=1024,
+            duration_minutes=1
+        )
+
+        imagegen = FalImageGenService(
+            image_size="square_hd",
+            aiohttp_session=session,
+            key_id=os.getenv("FAL_KEY_ID"),
+            key_secret=os.getenv("FAL_KEY_SECRET"),
+        )
+
+        other_joined_event = asyncio.Event()
+
+        async def show_image():
+            await other_joined_event.wait()
+            await imagegen.run_to_queue(
+                transport.send_queue, [TextFrame("a cat in the style of picasso")]
+            )
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            other_joined_event.set()
+
+        await asyncio.gather(transport.run(), show_image())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url))

src/examples/foundational/03a-image-local.py

@@ -0,0 +1,56 @@
+import asyncio
+import aiohttp
+import logging
+import os
+
+import tkinter as tk
+
+from dailyai.pipeline.frames import TextFrame
+from dailyai.services.fal_ai_services import FalImageGenService
+from dailyai.services.local_transport_service import LocalTransportService
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+local_joined = False
+participant_joined = False
+
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        meeting_duration_minutes = 2
+        tk_root = tk.Tk()
+        tk_root.title("Calendar")
+        transport = LocalTransportService(
+            tk_root=tk_root,
+            mic_enabled=True,
+            camera_enabled=True,
+            camera_width=1024,
+            camera_height=1024,
+            duration_minutes=meeting_duration_minutes,
+        )
+
+        imagegen = FalImageGenService(
+            image_size="1024x1024",
+            aiohttp_session=session,
+            key_id=os.getenv("FAL_KEY_ID"),
+            key_secret=os.getenv("FAL_KEY_SECRET"),
+        )
+        image_task = asyncio.create_task(
+            imagegen.run_to_queue(
+                transport.send_queue, [TextFrame("a cat in the style of picasso")]
+            )
+        )
+
+        async def run_tk():
+            while not transport._stop_threads.is_set():
+                tk_root.update()
+                tk_root.update_idletasks()
+                await asyncio.sleep(0.1)
+
+        await asyncio.gather(transport.run(), image_task, run_tk())
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

src/examples/foundational/04-utterance-and-speech.py

@@ -0,0 +1,103 @@
+import asyncio
+import logging
+import os
+
+import aiohttp
+from dailyai.pipeline.pipeline import Pipeline
+
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.azure_ai_services import AzureLLMService, AzureTTSService
+from dailyai.services.deepgram_ai_services import DeepgramTTSService
+from dailyai.pipeline.frames import EndFrame, LLMMessagesQueueFrame
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url: str):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            None,
+            "Static And Dynamic Speech",
+            duration_minutes=1,
+            mic_enabled=True,
+            mic_sample_rate=16000,
+        )
+
+        llm = AzureLLMService(
+            api_key=os.getenv("AZURE_CHATGPT_API_KEY"),
+            endpoint=os.getenv("AZURE_CHATGPT_ENDPOINT"),
+            model=os.getenv("AZURE_CHATGPT_MODEL"),
+        )
+        azure_tts = AzureTTSService(
+            api_key=os.getenv("AZURE_SPEECH_API_KEY"),
+            region=os.getenv("AZURE_SPEECH_REGION"),
+        )
+
+        deepgram_tts = DeepgramTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("DEEPGRAM_API_KEY"),
+        )
+        elevenlabs_tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        messages = [{"role": "system", "content": "tell the user a joke about llamas"}]
+
+        # Start a task to run the LLM to create a joke, and convert the LLM output to audio frames. This task
+        # will run in parallel with generating and speaking the audio for static text, so there's no delay to
+        # speak the LLM response.
+        buffer_queue = asyncio.Queue()
+        source_queue = asyncio.Queue()
+        pipeline = Pipeline(
+            source=source_queue, sink=buffer_queue, processors=[llm, elevenlabs_tts]
+        )
+        await source_queue.put(LLMMessagesQueueFrame(messages))
+        await source_queue.put(EndFrame())
+        pipeline_run_task = pipeline.run_pipeline()
+
+        other_participant_joined = asyncio.Event()
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            other_participant_joined.set()
+
+        async def say_something():
+            await other_participant_joined.wait()
+
+            await azure_tts.say(
+                "My friend the LLM is now going to tell a joke about llamas.",
+                transport.send_queue,
+            )
+
+            # khk: deepgram_tts.say() doesn't seem to put bytes in the transport
+            # queue. I get a debug log line that indicates we're set up okay, but
+            # no further log lines or audio bytes. debug this later:
+            #   20 2024-03-10 13:24:46,235 Running deepgram tts for My friend the LLM is now going to tell a joke about llamas.
+            # await deepgram_tts.say(
+            #    "My friend the LLM is now going to tell a joke about llamas.",
+            #    transport.send_queue,
+            # )
+
+            async def buffer_to_send_queue():
+                while True:
+                    frame = await buffer_queue.get()
+                    await transport.send_queue.put(frame)
+                    buffer_queue.task_done()
+                    if isinstance(frame, EndFrame):
+                        break
+
+            await asyncio.gather(pipeline_run_task, buffer_to_send_queue())
+
+        await asyncio.gather(transport.run(), say_something())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url))

src/examples/foundational/05-sync-speech-and-image.py

@@ -0,0 +1,159 @@
+import asyncio
+from re import S
+import aiohttp
+import os
+import logging
+
+from dataclasses import dataclass
+from typing import AsyncGenerator
+
+from dailyai.pipeline.aggregators import (
+    GatedAggregator,
+    LLMFullResponseAggregator,
+    ParallelPipeline,
+    SentenceAggregator,
+)
+from dailyai.pipeline.frames import (
+    Frame,
+    TextFrame,
+    EndFrame,
+    ImageFrame,
+    LLMMessagesQueueFrame,
+    LLMResponseStartFrame,
+)
+from dailyai.pipeline.frame_processor import FrameProcessor
+
+from dailyai.pipeline.pipeline import Pipeline
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.open_ai_services import OpenAILLMService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.services.fal_ai_services import FalImageGenService
+
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+@dataclass
+class MonthFrame(Frame):
+    month: str
+
+
+class MonthPrepender(FrameProcessor):
+    def __init__(self):
+        self.most_recent_month = "Placeholder, month frame not yet received"
+        self.prepend_to_next_text_frame = False
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, MonthFrame):
+            self.most_recent_month = frame.month
+        elif self.prepend_to_next_text_frame and isinstance(frame, TextFrame):
+            yield TextFrame(f"{self.most_recent_month}: {frame.text}")
+            self.prepend_to_next_text_frame = False
+        elif isinstance(frame, LLMResponseStartFrame):
+            self.prepend_to_next_text_frame = True
+            yield frame
+        else:
+            yield frame
+
+
+async def main(room_url):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            None,
+            "Month Narration Bot",
+            mic_enabled=True,
+            camera_enabled=True,
+            mic_sample_rate=16000,
+            camera_width=1024,
+            camera_height=1024,
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+
+        imagegen = FalImageGenService(
+            image_size="square_hd",
+            aiohttp_session=session,
+            key_id=os.getenv("FAL_KEY_ID"),
+            key_secret=os.getenv("FAL_KEY_SECRET"),
+        )
+
+        source_queue = asyncio.Queue()
+
+        for month in [
+            "January",
+            "February",
+            "March",
+            "April",
+            "May",
+            "June",
+            "July",
+            "August",
+            "September",
+            "October",
+            "November",
+            "December",
+        ]:
+            messages = [
+                {
+                    "role": "system",
+                    "content": f"Describe a nature photograph suitable for use in a calendar, for the month of {month}. Include only the image description with no preamble. Limit the description to one sentence, please.",
+                }
+            ]
+            await source_queue.put(MonthFrame(month))
+            await source_queue.put(LLMMessagesQueueFrame(messages))
+
+        await source_queue.put(EndFrame())
+
+        gated_aggregator = GatedAggregator(
+            gate_open_fn=lambda frame: isinstance(frame, ImageFrame),
+            gate_close_fn=lambda frame: isinstance(frame, LLMResponseStartFrame),
+            start_open=False,
+        )
+
+        sentence_aggregator = SentenceAggregator()
+        month_prepender = MonthPrepender()
+        llm_full_response_aggregator = LLMFullResponseAggregator()
+
+        pipeline = Pipeline(
+            source=source_queue,
+            sink=transport.send_queue,
+            processors=[
+                llm,
+                sentence_aggregator,
+                ParallelPipeline(
+                    [[month_prepender, tts], [llm_full_response_aggregator, imagegen]]
+                ),
+                gated_aggregator,
+            ],
+        )
+        pipeline_task = pipeline.run_pipeline()
+
+        other_joined = asyncio.Event()
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            other_joined.set()
+
+        async def show_calendar():
+            await other_joined.wait()
+            await pipeline_task
+            await transport.stop_when_done()
+
+        await asyncio.gather(transport.run(), show_calendar())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url))

src/examples/foundational/05a-local-sync-speech-and-text.py

@@ -0,0 +1,138 @@
+import aiohttp
+import argparse
+import asyncio
+import logging
+import tkinter as tk
+import os
+
+from dailyai.pipeline.frames import AudioFrame, ImageFrame
+from dailyai.services.open_ai_services import OpenAILLMService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.services.fal_ai_services import FalImageGenService
+from dailyai.services.local_transport_service import LocalTransportService
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url):
+    async with aiohttp.ClientSession() as session:
+        meeting_duration_minutes = 5
+        tk_root = tk.Tk()
+        tk_root.title("Calendar")
+
+        transport = LocalTransportService(
+            mic_enabled=True,
+            camera_enabled=True,
+            camera_width=1024,
+            camera_height=1024,
+            duration_minutes=meeting_duration_minutes,
+            tk_root=tk_root,
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+
+        dalle = FalImageGenService(
+            image_size="1024x1024",
+            aiohttp_session=session,
+            key_id=os.getenv("FAL_KEY_ID"),
+            key_secret=os.getenv("FAL_KEY_SECRET"),
+        )
+
+        # Get a complete audio chunk from the given text. Splitting this into its own
+        # coroutine lets us ensure proper ordering of the audio chunks on the send queue.
+        async def get_all_audio(text):
+            all_audio = bytearray()
+            async for audio in tts.run_tts(text):
+                all_audio.extend(audio)
+
+            return all_audio
+
+        async def get_month_data(month):
+            messages = [
+                {
+                    "role": "system",
+                    "content": f"Describe a nature photograph suitable for use in a calendar, for the month of {month}. Include only the image description with no preamble. Limit the description to one sentence, please.",
+                }
+            ]
+
+            image_description = await llm.run_llm(messages)
+            if not image_description:
+                return
+
+            to_speak = f"{month}: {image_description}"
+            audio_task = asyncio.create_task(get_all_audio(to_speak))
+            image_task = asyncio.create_task(dalle.run_image_gen(image_description))
+            (audio, image_data) = await asyncio.gather(audio_task, image_task)
+
+            return {
+                "month": month,
+                "text": image_description,
+                "image_url": image_data[0],
+                "image": image_data[1],
+                "audio": audio,
+            }
+
+        months: list[str] = [
+            "January",
+            "February",
+            "March",
+            "April",
+            "May",
+            "June",
+            "July",
+            "August",
+            "September",
+            "October",
+            "November",
+            "December",
+        ]
+
+        async def show_images():
+            # This will play the months in the order they're completed. The benefit
+            # is we'll have as little delay as possible before the first month, and
+            # likely no delay between months, but the months won't display in order.
+            for month_data_task in asyncio.as_completed(month_tasks):
+                data = await month_data_task
+                if data:
+                    await transport.send_queue.put(
+                        [
+                            ImageFrame(data["image_url"], data["image"]),
+                            AudioFrame(data["audio"]),
+                        ]
+                    )
+
+            await asyncio.sleep(25)
+
+            # wait for the output queue to be empty, then leave the meeting
+            await transport.stop_when_done()
+
+        async def run_tk():
+            while not transport._stop_threads.is_set():
+                tk_root.update()
+                tk_root.update_idletasks()
+                await asyncio.sleep(0.1)
+
+        month_tasks = [asyncio.create_task(get_month_data(month)) for month in months]
+
+        await asyncio.gather(transport.run(), show_images(), run_tk())
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Simple Daily Bot Sample")
+    parser.add_argument(
+        "-u", "--url", type=str, required=True, help="URL of the Daily room to join"
+    )
+
+    args, unknown = parser.parse_known_args()
+
+    asyncio.run(main(args.url))

src/examples/foundational/06-listen-and-respond.py

@@ -0,0 +1,83 @@
+import asyncio
+import aiohttp
+import logging
+import os
+from dailyai.pipeline.pipeline import Pipeline
+
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.services.open_ai_services import OpenAILLMService
+from dailyai.services.ai_services import FrameLogger
+from dailyai.pipeline.aggregators import (
+    LLMAssistantContextAggregator,
+    LLMUserContextAggregator,
+)
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url: str, token):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            token,
+            "Respond bot",
+            duration_minutes=5,
+            start_transcription=True,
+            mic_enabled=True,
+            mic_sample_rate=16000,
+            camera_enabled=False,
+            vad_enabled=True,
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+        fl = FrameLogger("Inner")
+        fl2 = FrameLogger("Outer")
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            await tts.say("Hi, I'm listening!", transport.send_queue)
+
+        async def have_conversation():
+            messages = [
+                {
+                    "role": "system",
+                    "content": "You are a helpful LLM in a WebRTC call. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio. Respond to what the user said in a creative and helpful way.",
+                },
+            ]
+
+            tma_in = LLMUserContextAggregator(messages, transport._my_participant_id)
+            tma_out = LLMAssistantContextAggregator(
+                messages, transport._my_participant_id
+            )
+            pipeline = Pipeline(
+                processors=[
+                    fl,
+                    tma_in,
+                    llm,
+                    fl2,
+                    tts,
+                    tma_out,
+                ],
+            )
+            await transport.run_uninterruptible_pipeline(pipeline)
+
+        transport.transcription_settings["extra"]["endpointing"] = True
+        transport.transcription_settings["extra"]["punctuate"] = True
+        await asyncio.gather(transport.run(), have_conversation())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url, token))

src/examples/foundational/06a-image-sync.py

@@ -0,0 +1,121 @@
+import argparse
+import asyncio
+import os
+import logging
+from typing import AsyncGenerator
+import aiohttp
+import requests
+import time
+import urllib.parse
+from PIL import Image
+
+from dailyai.pipeline.frames import ImageFrame, Frame
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.ai_services import AIService
+from dailyai.pipeline.aggregators import (
+    LLMAssistantContextAggregator,
+    LLMUserContextAggregator,
+)
+from dailyai.services.open_ai_services import OpenAILLMService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.services.fal_ai_services import FalImageGenService
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+class ImageSyncAggregator(AIService):
+    def __init__(self, speaking_path: str, waiting_path: str):
+        self._speaking_image = Image.open(speaking_path)
+        self._speaking_image_bytes = self._speaking_image.tobytes()
+
+        self._waiting_image = Image.open(waiting_path)
+        self._waiting_image_bytes = self._waiting_image.tobytes()
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        yield ImageFrame(None, self._speaking_image_bytes)
+        yield frame
+        yield ImageFrame(None, self._waiting_image_bytes)
+
+
+async def main(room_url: str, token):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            token,
+            "Respond bot",
+            5,
+        )
+        transport._camera_enabled = True
+        transport._camera_width = 1024
+        transport._camera_height = 1024
+        transport._mic_enabled = True
+        transport._mic_sample_rate = 16000
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+
+        img = FalImageGenService(
+            image_size="1024x1024",
+            aiohttp_session=session,
+            key_id=os.getenv("FAL_KEY_ID"),
+            key_secret=os.getenv("FAL_KEY_SECRET"),
+        )
+
+        async def get_images():
+            get_speaking_task = asyncio.create_task(
+                img.run_image_gen("An image of a cat speaking")
+            )
+            get_waiting_task = asyncio.create_task(
+                img.run_image_gen("An image of a cat waiting")
+            )
+
+            (speaking_data, waiting_data) = await asyncio.gather(
+                get_speaking_task, get_waiting_task
+            )
+
+            return speaking_data, waiting_data
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            await tts.say("Hi, I'm listening!", transport.send_queue)
+
+        async def handle_transcriptions():
+            messages = [
+                {
+                    "role": "system",
+                    "content": "You are a helpful LLM in a WebRTC call. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio. Respond to what the user said in a creative and helpful way.",
+                },
+            ]
+
+            tma_in = LLMUserContextAggregator(messages, transport._my_participant_id)
+            tma_out = LLMAssistantContextAggregator(
+                messages, transport._my_participant_id
+            )
+            image_sync_aggregator = ImageSyncAggregator(
+                os.path.join(os.path.dirname(__file__), "assets", "speaking.png"),
+                os.path.join(os.path.dirname(__file__), "assets", "waiting.png"),
+            )
+            await tts.run_to_queue(
+                transport.send_queue,
+                image_sync_aggregator.run(
+                    tma_out.run(llm.run(tma_in.run(transport.get_receive_frames())))
+                ),
+            )
+
+        transport.transcription_settings["extra"]["punctuate"] = True
+        await asyncio.gather(transport.run(), handle_transcriptions())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url, token))

src/examples/foundational/07-interruptible.py

@@ -0,0 +1,74 @@
+import asyncio
+import aiohttp
+import logging
+import os
+from dailyai.pipeline.aggregators import (
+    LLMAssistantContextAggregator,
+    LLMResponseAggregator,
+    LLMUserContextAggregator,
+    UserResponseAggregator,
+)
+
+from dailyai.pipeline.pipeline import Pipeline
+from dailyai.services.ai_services import FrameLogger
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.open_ai_services import OpenAILLMService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url: str, token):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            token,
+            "Respond bot",
+            duration_minutes=5,
+            start_transcription=True,
+            mic_enabled=True,
+            mic_sample_rate=16000,
+            camera_enabled=False,
+            vad_enabled=True,
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id=os.getenv("ELEVENLABS_VOICE_ID"),
+        )
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+
+        pipeline = Pipeline([FrameLogger(), llm, FrameLogger(), tts])
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            await tts.say("Hi, I'm listening!", transport.send_queue)
+
+        async def run_conversation():
+            messages = [
+                {
+                    "role": "system",
+                    "content": "You are a helpful LLM in a WebRTC call. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio. Respond to what the user said in a creative and helpful way.",
+                },
+            ]
+
+            await transport.run_interruptible_pipeline(
+                pipeline,
+                post_processor=LLMResponseAggregator(messages),
+                pre_processor=UserResponseAggregator(messages),
+            )
+
+        transport.transcription_settings["extra"]["punctuate"] = False
+        await asyncio.gather(transport.run(), run_conversation())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url, token))

src/examples/foundational/08-bots-arguing.py

@@ -0,0 +1,143 @@
+from typing import Tuple
+import aiohttp
+import asyncio
+import logging
+import os
+from dailyai.pipeline.aggregators import SentenceAggregator
+from dailyai.pipeline.pipeline import Pipeline
+
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.azure_ai_services import AzureLLMService, AzureTTSService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.services.fal_ai_services import FalImageGenService
+from dailyai.pipeline.frames import AudioFrame, EndFrame, ImageFrame, LLMMessagesQueueFrame, TextFrame
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url: str):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            None,
+            "Respond bot",
+            duration_minutes=10,
+            mic_enabled=True,
+            mic_sample_rate=16000,
+            camera_enabled=True,
+            camera_width=1024,
+            camera_height=1024,
+        )
+
+        llm = AzureLLMService(
+            api_key=os.getenv("AZURE_CHATGPT_API_KEY"),
+            endpoint=os.getenv("AZURE_CHATGPT_ENDPOINT"),
+            model=os.getenv("AZURE_CHATGPT_MODEL"),
+        )
+        tts1 = AzureTTSService(
+            api_key=os.getenv("AZURE_SPEECH_API_KEY"),
+            region=os.getenv("AZURE_SPEECH_REGION"),
+        )
+        tts2 = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id="jBpfuIE2acCO8z3wKNLl",
+        )
+        dalle = FalImageGenService(
+            image_size="1024x1024",
+            aiohttp_session=session,
+            key_id=os.getenv("FAL_KEY_ID"),
+            key_secret=os.getenv("FAL_KEY_SECRET"),
+        )
+
+        bot1_messages = [
+            {
+                "role": "system",
+                "content": "You are a stern librarian. You strongly believe that a hot dog is a sandwich. Start by stating this fact in a few sentences, then be prepared to debate this with the user. You shouldn't ever compromise on the fundamental truth that a hot dog is a sandwich. Your responses should only be a few sentences long.",
+            },
+        ]
+        bot2_messages = [
+            {
+                "role": "system",
+                "content": "You are a silly cat, and you strongly believe that a hot dog is not a sandwich. Debate this with the user, only responding with a few sentences. Don't ever accept that a hot dog is a sandwich.",
+            },
+        ]
+
+        async def get_text_and_audio(messages) -> Tuple[str, bytearray]:
+            """This function streams text from the LLM and uses the TTS service to convert
+             that text to speech as it's received. """
+            source_queue = asyncio.Queue()
+            sink_queue = asyncio.Queue()
+            sentence_aggregator = SentenceAggregator()
+            pipeline = Pipeline(
+                [llm, sentence_aggregator, tts1], source_queue, sink_queue
+            )
+
+            await source_queue.put(LLMMessagesQueueFrame(messages))
+            await source_queue.put(EndFrame())
+            await pipeline.run_pipeline()
+
+            message = ""
+            all_audio = bytearray()
+            while sink_queue.qsize():
+                frame = sink_queue.get_nowait()
+                if isinstance(frame, TextFrame):
+                    message += frame.text
+                elif isinstance(frame, AudioFrame):
+                    all_audio.extend(frame.data)
+
+            return (message, all_audio)
+
+        async def get_bot1_statement():
+            message, audio = await get_text_and_audio(bot1_messages)
+
+            bot1_messages.append({"role": "assistant", "content": message})
+            bot2_messages.append({"role": "user", "content": message})
+
+            return audio
+
+        async def get_bot2_statement():
+            message, audio = await get_text_and_audio(bot2_messages)
+
+            bot2_messages.append({"role": "assistant", "content": message})
+            bot1_messages.append({"role": "user", "content": message})
+
+            return audio
+
+        async def argue():
+            for i in range(100):
+                print(f"In iteration {i}")
+
+                bot1_description = "A woman conservatively dressed as a librarian in a library surrounded by books, cartoon, serious, highly detailed"
+
+                (audio1, image_data1) = await asyncio.gather(
+                    get_bot1_statement(), dalle.run_image_gen(bot1_description)
+                )
+                await transport.send_queue.put(
+                    [
+                        ImageFrame(None, image_data1[1]),
+                        AudioFrame(audio1),
+                    ]
+                )
+
+                bot2_description = "A cat dressed in a hot dog costume, cartoon, bright colors, funny, highly detailed"
+
+                (audio2, image_data2) = await asyncio.gather(
+                    get_bot2_statement(), dalle.run_image_gen(bot2_description)
+                )
+                await transport.send_queue.put(
+                    [
+                        ImageFrame(None, image_data2[1]),
+                        AudioFrame(audio2),
+                    ]
+                )
+
+        await asyncio.gather(transport.run(), argue())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url))

src/examples/foundational/10-wake-word.py

@@ -0,0 +1,184 @@
+import aiohttp
+import asyncio
+import logging
+import os
+import random
+from typing import AsyncGenerator
+from PIL import Image
+
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.open_ai_services import OpenAILLMService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.pipeline.aggregators import (
+    LLMUserContextAggregator,
+    LLMAssistantContextAggregator,
+)
+from dailyai.pipeline.frames import (
+    Frame,
+    TextFrame,
+    ImageFrame,
+    SpriteFrame,
+    TranscriptionQueueFrame,
+)
+from dailyai.services.ai_services import AIService
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+sprites = {}
+image_files = [
+    "sc-default.png",
+    "sc-talk.png",
+    "sc-listen-1.png",
+    "sc-think-1.png",
+    "sc-think-2.png",
+    "sc-think-3.png",
+    "sc-think-4.png",
+]
+
+script_dir = os.path.dirname(__file__)
+
+for file in image_files:
+    # Build the full path to the image file
+    full_path = os.path.join(script_dir, "assets", file)
+    # Get the filename without the extension to use as the dictionary key
+    filename = os.path.splitext(os.path.basename(full_path))[0]
+    # Open the image and convert it to bytes
+    with Image.open(full_path) as img:
+        sprites[file] = img.tobytes()
+
+# When the bot isn't talking, show a static image of the cat listening
+quiet_frame = ImageFrame("", sprites["sc-listen-1.png"])
+# When the bot is talking, build an animation from two sprites
+talking_list = [sprites["sc-default.png"], sprites["sc-talk.png"]]
+talking = [random.choice(talking_list) for x in range(30)]
+talking_frame = SpriteFrame(images=talking)
+
+# TODO: Support "thinking" as soon as we get a valid transcript, while LLM is processing
+thinking_list = [
+    sprites["sc-think-1.png"],
+    sprites["sc-think-2.png"],
+    sprites["sc-think-3.png"],
+    sprites["sc-think-4.png"],
+]
+thinking_frame = SpriteFrame(images=thinking_list)
+
+
+class TranscriptFilter(AIService):
+    def __init__(self, bot_participant_id=None):
+        self.bot_participant_id = bot_participant_id
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, TranscriptionQueueFrame):
+            if frame.participantId != self.bot_participant_id:
+                yield frame
+
+
+class NameCheckFilter(AIService):
+    def __init__(self, names: list[str]):
+        self.names = names
+        self.sentence = ""
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        content: str = ""
+
+        # TODO: split up transcription by participant
+        if isinstance(frame, TextFrame):
+            content = frame.text
+
+        self.sentence += content
+        if self.sentence.endswith((".", "?", "!")):
+            if any(name in self.sentence for name in self.names):
+                out = self.sentence
+                self.sentence = ""
+                yield TextFrame(out)
+            else:
+                out = self.sentence
+                self.sentence = ""
+
+
+class ImageSyncAggregator(AIService):
+    def __init__(self):
+        pass
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        yield talking_frame
+        yield frame
+        yield quiet_frame
+
+
+async def main(room_url: str, token):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            token,
+            "Santa Cat",
+            duration_minutes=3,
+            start_transcription=True,
+            mic_enabled=True,
+            mic_sample_rate=16000,
+            camera_enabled=True,
+            camera_width=720,
+            camera_height=1280,
+        )
+        transport._mic_enabled = True
+        transport._mic_sample_rate = 16000
+        transport._camera_enabled = True
+        transport._camera_width = 720
+        transport._camera_height = 1280
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id="jBpfuIE2acCO8z3wKNLl",
+        )
+        isa = ImageSyncAggregator()
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            await tts.say(
+                "Hi! If you want to talk to me, just say 'hey Santa Cat'.",
+                transport.send_queue,
+            )
+
+        async def handle_transcriptions():
+            messages = [
+                {
+                    "role": "system",
+                    "content": "You are Santa Cat, a cat that lives in Santa's workshop at the North Pole. You should be clever, and a bit sarcastic. You should also tell jokes every once in a while.  Your responses should only be a few sentences long.",
+                },
+            ]
+
+            tma_in = LLMUserContextAggregator(messages, transport._my_participant_id)
+            tma_out = LLMAssistantContextAggregator(
+                messages, transport._my_participant_id
+            )
+            tf = TranscriptFilter(transport._my_participant_id)
+            ncf = NameCheckFilter(["Santa Cat", "Santa"])
+            await tts.run_to_queue(
+                transport.send_queue,
+                isa.run(
+                    tma_out.run(
+                        llm.run(
+                            tma_in.run(ncf.run(tf.run(transport.get_receive_frames())))
+                        )
+                    )
+                ),
+            )
+
+        async def starting_image():
+            await transport.send_queue.put(quiet_frame)
+
+        transport.transcription_settings["extra"]["punctuate"] = True
+        await asyncio.gather(transport.run(), handle_transcriptions(), starting_image())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url, token))

src/examples/foundational/11-sound-effects.py

@@ -0,0 +1,137 @@
+import aiohttp
+import asyncio
+import logging
+import os
+import wave
+
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.open_ai_services import OpenAILLMService
+from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
+from dailyai.pipeline.aggregators import (
+    LLMContextAggregator,
+    LLMUserContextAggregator,
+    LLMAssistantContextAggregator,
+)
+from dailyai.services.ai_services import AIService, FrameLogger
+from dailyai.pipeline.frames import (
+    Frame,
+    AudioFrame,
+    LLMResponseEndFrame,
+    LLMMessagesQueueFrame,
+)
+from typing import AsyncGenerator
+
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+sounds = {}
+sound_files = ["ding1.wav", "ding2.wav"]
+
+script_dir = os.path.dirname(__file__)
+
+for file in sound_files:
+    # Build the full path to the image file
+    full_path = os.path.join(script_dir, "assets", file)
+    # Get the filename without the extension to use as the dictionary key
+    filename = os.path.splitext(os.path.basename(full_path))[0]
+    # Open the image and convert it to bytes
+    with wave.open(full_path) as audio_file:
+        sounds[file] = audio_file.readframes(-1)
+
+
+class OutboundSoundEffectWrapper(AIService):
+    def __init__(self):
+        pass
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, LLMResponseEndFrame):
+            yield AudioFrame(sounds["ding1.wav"])
+            # In case anything else up the stack needs it
+            yield frame
+        else:
+            yield frame
+
+
+class InboundSoundEffectWrapper(AIService):
+    def __init__(self):
+        pass
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, LLMMessagesQueueFrame):
+            yield AudioFrame(sounds["ding2.wav"])
+            # In case anything else up the stack needs it
+            yield frame
+        else:
+            yield frame
+
+
+async def main(room_url: str, token):
+    async with aiohttp.ClientSession() as session:
+        transport = DailyTransportService(
+            room_url,
+            token,
+            "Respond bot",
+            duration_minutes=5,
+            mic_enabled=True,
+            mic_sample_rate=16000,
+            camera_enabled=False,
+        )
+
+        llm = OpenAILLMService(
+            api_key=os.getenv("OPENAI_CHATGPT_API_KEY"), model="gpt-4-turbo-preview"
+        )
+
+        tts = ElevenLabsTTSService(
+            aiohttp_session=session,
+            api_key=os.getenv("ELEVENLABS_API_KEY"),
+            voice_id="ErXwobaYiN019PkySvjV",
+        )
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            await tts.say("Hi, I'm listening!", transport.send_queue)
+            await transport.send_queue.put(AudioFrame(sounds["ding1.wav"]))
+
+        async def handle_transcriptions():
+            messages = [
+                {
+                    "role": "system",
+                    "content": "You are a helpful LLM in a WebRTC call. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio. Respond to what the user said in a creative and helpful way.",
+                },
+            ]
+
+            tma_in = LLMUserContextAggregator(messages, transport._my_participant_id)
+            tma_out = LLMAssistantContextAggregator(
+                messages, transport._my_participant_id
+            )
+            out_sound = OutboundSoundEffectWrapper()
+            in_sound = InboundSoundEffectWrapper()
+            fl = FrameLogger("LLM Out")
+            fl2 = FrameLogger("Transcription In")
+            await out_sound.run_to_queue(
+                transport.send_queue,
+                tts.run(
+                    fl.run(
+                        tma_out.run(
+                            llm.run(
+                                fl2.run(
+                                    in_sound.run(
+                                        tma_in.run(transport.get_receive_frames())
+                                    )
+                                )
+                            )
+                        )
+                    )
+                ),
+            )
+
+        transport.transcription_settings["extra"]["punctuate"] = True
+        await asyncio.gather(transport.run(), handle_transcriptions())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url, token))

src/examples/foundational/13-whisper-transcription.py

@@ -1,22 +1,26 @@
-import argparse
 import asyncio
+import logging
 
 from dailyai.services.daily_transport_service import DailyTransportService
 from dailyai.services.whisper_ai_services import WhisperSTTService
+from examples.support.runner import configure
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
 
 
 async def main(room_url: str):
-    global transport
-    global stt
-
     transport = DailyTransportService(
         room_url,
         None,
         "Transcription bot",
+        start_transcription=True,
+        mic_enabled=False,
+        camera_enabled=False,
+        speaker_enabled=True,
     )
-    transport.mic_enabled = False
-    transport.camera_enabled = False
-    transport.speaker_enabled = True
+
     stt = WhisperSTTService()
     transcription_output_queue = asyncio.Queue()
 
@@ -28,17 +32,12 @@ async def main(room_url: str):
 
     async def handle_speaker():
         await stt.run_to_queue(
-            transcription_output_queue,
-            transport.get_receive_frames()
+            transcription_output_queue, transport.get_receive_frames()
         )
+
     await asyncio.gather(transport.run(), handle_speaker(), handle_transcription())
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(description="Simple Daily Bot Sample")
-    parser.add_argument(
-        "-u", "--url", type=str, required=True, help="URL of the Daily room to join"
-    )
-
-    args, unknown = parser.parse_known_args()
-    asyncio.run(main(args.url))
+    (url, token) = configure()
+    asyncio.run(main(url))

src/examples/foundational/13a-whisper-local.py

@@ -0,0 +1,64 @@
+import argparse
+import asyncio
+import logging
+import wave
+from dailyai.pipeline.frames import EndFrame, TranscriptionQueueFrame
+
+from dailyai.services.local_transport_service import LocalTransportService
+from dailyai.services.whisper_ai_services import WhisperSTTService
+
+logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
+logger = logging.getLogger("dailyai")
+logger.setLevel(logging.DEBUG)
+
+
+async def main(room_url: str):
+    global transport
+    global stt
+
+    meeting_duration_minutes = 1
+    transport = LocalTransportService(
+        mic_enabled=True,
+        camera_enabled=False,
+        speaker_enabled=True,
+        duration_minutes=meeting_duration_minutes,
+        start_transcription=True,
+    )
+    stt = WhisperSTTService()
+    transcription_output_queue = asyncio.Queue()
+    transport_done = asyncio.Event()
+
+    async def handle_transcription():
+        print("`````````TRANSCRIPTION`````````")
+        while not transport_done.is_set():
+            item = await transcription_output_queue.get()
+            print("got item from queue", item)
+            if isinstance(item, TranscriptionQueueFrame):
+                print(item.text)
+            elif isinstance(item, EndFrame):
+                break
+        print("handle_transcription done")
+
+    async def handle_speaker():
+        await stt.run_to_queue(
+            transcription_output_queue, transport.get_receive_frames()
+        )
+        await transcription_output_queue.put(EndFrame())
+        print("handle speaker done.")
+
+    async def run_until_done():
+        await transport.run()
+        transport_done.set()
+        print("run_until_done done")
+
+    await asyncio.gather(run_until_done(), handle_speaker(), handle_transcription())
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Simple Daily Bot Sample")
+    parser.add_argument(
+        "-u", "--url", type=str, required=True, help="URL of the Daily room to join"
+    )
+
+    args, unknown = parser.parse_known_args()
+    asyncio.run(main(args.url))

src/examples/image-gen.py

@@ -7,11 +7,12 @@ import random
 
 from dailyai.services.daily_transport_service import DailyTransportService
 from dailyai.services.azure_ai_services import AzureLLMService, AzureTTSService
-from dailyai.queue_frame import QueueFrame, FrameType
+from dailyai.pipeline.frames import Frame, FrameType
 from dailyai.services.fal_ai_services import FalImageGenService
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
 
-async def main(room_url:str, token):
+
+async def main(room_url: str, token):
     global transport
     global llm
     global tts
@@ -22,30 +23,29 @@ async def main(room_url:str, token):
         "Imagebot",
         1,
     )
-    transport.mic_enabled = True
-    transport.camera_enabled = True
-    transport.mic_sample_rate = 16000
-    transport.camera_width = 1024
-    transport.camera_height = 1024
+    transport._mic_enabled = True
+    transport._camera_enabled = True
+    transport._mic_sample_rate = 16000
+    transport._camera_width = 1024
+    transport._camera_height = 1024
 
     llm = AzureLLMService()
     tts = AzureTTSService()
     img = FalImageGenService()
 
-
     async def handle_transcriptions():
         print("handle_transcriptions got called")
 
         sentence = ""
         async for message in transport.get_transcriptions():
             print(f"transcription message: {message}")
-            if message["session_id"] == transport.my_participant_id:
+            if message["session_id"] == transport._my_participant_id:
                 continue
-            finder =  message["text"].find("start over")
+            finder = message["text"].find("start over")
             print(f"finder: {finder}")
             if finder >= 0:
                 async for audio in tts.run_tts(f"Resetting."):
-                    transport.output_queue.put(QueueFrame(FrameType.AUDIO_FRAME, audio))
+                    transport.output_queue.put(Frame(FrameType.AUDIO_FRAME, audio))
                 sentence = ""
                 continue
             # todo: we could differentiate between transcriptions from different participants
@@ -54,12 +54,12 @@ async def main(room_url:str, token):
             # TODO: Cache this audio
             phrase = random.choice(["OK.", "Got it.", "Sure.", "You bet.", "Sure thing."])
             async for audio in tts.run_tts(phrase):
-                transport.output_queue.put(QueueFrame(FrameType.AUDIO_FRAME, audio))
+                transport.output_queue.put(Frame(FrameType.AUDIO_FRAME, audio))
             img_result = img.run_image_gen(sentence, "1024x1024")
             awaited_img = await asyncio.gather(img_result)
             transport.output_queue.put(
                 [
-                    QueueFrame(FrameType.IMAGE_FRAME, awaited_img[0][1]),
+                    Frame(FrameType.IMAGE_FRAME, awaited_img[0][1]),
                 ]
             )
 
@@ -69,9 +69,10 @@ async def main(room_url:str, token):
         if participant["info"]["isLocal"]:
             return
         async for audio in tts.run_tts("Describe an image, and I'll create it."):
-            audio_generator = tts.run_tts(f"Hello, {participant['info']['userName']}! Describe an image and I'll create it. To start over, just say 'start over'.")
+            audio_generator = tts.run_tts(
+                f"Hello, {participant['info']['userName']}! Describe an image and I'll create it. To start over, just say 'start over'.")
             async for audio in audio_generator:
-                transport.output_queue.put(QueueFrame(FrameType.AUDIO_FRAME, audio))
+                transport.output_queue.put(Frame(FrameType.AUDIO_FRAME, audio))
 
     transport.transcription_settings["extra"]["punctuate"] = False
     transport.transcription_settings["extra"]["endpointing"] = False

src/examples/internal/11a-dial-out.py

@@ -0,0 +1,134 @@
+import aiohttp
+import asyncio
+import os
+import wave
+
+from dailyai.services.daily_transport_service import DailyTransportService
+from dailyai.services.azure_ai_services import AzureLLMService, AzureTTSService
+from dailyai.pipeline.aggregators import LLMContextAggregator
+from dailyai.services.ai_services import AIService, FrameLogger
+from dailyai.pipeline.frames import Frame, AudioFrame, LLMResponseEndFrame, LLMMessagesQueueFrame
+from typing import AsyncGenerator
+
+from examples.support.runner import configure
+
+sounds = {}
+sound_files = [
+    'ding1.wav',
+    'ding2.wav'
+]
+
+script_dir = os.path.dirname(__file__)
+
+for file in sound_files:
+    # Build the full path to the image file
+    full_path = os.path.join(script_dir, "assets", file)
+    # Get the filename without the extension to use as the dictionary key
+    filename = os.path.splitext(os.path.basename(full_path))[0]
+    # Open the image and convert it to bytes
+    with wave.open(full_path) as audio_file:
+        sounds[file] = audio_file.readframes(-1)
+
+
+class OutboundSoundEffectWrapper(AIService):
+    def __init__(self):
+        pass
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, LLMResponseEndFrame):
+            yield AudioFrame(sounds["ding1.wav"])
+            # In case anything else up the stack needs it
+            yield frame
+        else:
+            yield frame
+
+
+class InboundSoundEffectWrapper(AIService):
+    def __init__(self):
+        pass
+
+    async def process_frame(self, frame: Frame) -> AsyncGenerator[Frame, None]:
+        if isinstance(frame, LLMMessagesQueueFrame):
+            yield AudioFrame(sounds["ding2.wav"])
+            # In case anything else up the stack needs it
+            yield frame
+        else:
+            yield frame
+
+
+async def main(room_url: str, token, phone):
+    async with aiohttp.ClientSession() as session:
+
+        global transport
+        global llm
+        global tts
+
+        transport = DailyTransportService(
+            room_url,
+            token,
+            "Respond bot",
+            300,
+        )
+        transport._mic_enabled = True
+        transport._mic_sample_rate = 16000
+        transport._camera_enabled = False
+
+        llm = AzureLLMService()
+        tts = AzureTTSService()
+
+        @transport.event_handler("on_first_other_participant_joined")
+        async def on_first_other_participant_joined(transport):
+            await tts.say("Hi, I'm listening!", transport.send_queue)
+            await transport.send_queue.put(AudioFrame(sounds["ding1.wav"]))
+
+        async def handle_transcriptions():
+            messages = [
+                {"role": "system", "content": "You are a helpful LLM in a WebRTC call. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio. Respond to what the user said in a creative and helpful way."},
+            ]
+
+            tma_in = LLMContextAggregator(
+                messages, "user", transport._my_participant_id
+            )
+            tma_out = LLMContextAggregator(
+                messages, "assistant", transport._my_participant_id
+            )
+            out_sound = OutboundSoundEffectWrapper()
+            in_sound = InboundSoundEffectWrapper()
+            fl = FrameLogger("LLM Out")
+            fl2 = FrameLogger("Transcription In")
+            await out_sound.run_to_queue(
+                transport.send_queue,
+                tts.run(
+                    tma_out.run(
+                        llm.run(
+                            fl2.run(
+                                in_sound.run(
+                                    tma_in.run(
+                                        transport.get_receive_frames()
+                                    )
+                                )
+                            )
+                        )
+                    )
+                )
+            )
+
+        @transport.event_handler("on_participant_joined")
+        async def pax_joined(transport, pax):
+            print(f"PARTICIPANT JOINED: {pax}")
+
+        @transport.event_handler("on_call_state_updated")
+        async def on_call_state_updated(transport, state):
+            if (state == "joined"):
+                if (phone):
+                    transport.start_recording()
+                    transport.dialout(phone)
+
+        transport.transcription_settings["extra"]["punctuate"] = True
+
+        await asyncio.gather(transport.run(), handle_transcriptions())
+
+
+if __name__ == "__main__":
+    (url, token) = configure()
+    asyncio.run(main(url, token))

src/examples/server/Dockerfile

@@ -0,0 +1,39 @@
+# setup
+FROM python:3.11.5
+
+WORKDIR /app
+COPY requirements.txt /app
+COPY *.py /app
+COPY pyproject.toml /app
+
+COPY src/ /app/src/
+
+WORKDIR /app
+RUN ls --recursive /app/
+RUN pip3 install --upgrade -r requirements.txt
+RUN python -m build .
+RUN pip3 install .
+
+# If running on Ubuntu, Azure TTS requires some extra config
+# https://learn.microsoft.com/en-us/azure/ai-services/speech-service/quickstarts/setup-platform?pivots=programming-language-python&tabs=linux%2Cubuntu%2Cdotnetcli%2Cdotnet%2Cjre%2Cmaven%2Cnodejs%2Cmac%2Cpypi
+
+RUN wget -O - https://www.openssl.org/source/openssl-1.1.1w.tar.gz | tar zxf -
+WORKDIR openssl-1.1.1w
+RUN ./config --prefix=/usr/local
+RUN make -j $(nproc)
+RUN make install_sw install_ssldirs
+RUN ldconfig -v
+ENV SSL_CERT_DIR=/etc/ssl/certs
+
+#ENV LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+RUN apt clean
+RUN apt-get update
+RUN apt-get -y install build-essential libssl-dev ca-certificates libasound2 wget
+
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+EXPOSE 8000
+# run
+CMD ["gunicorn", "--workers=2", "--log-level", "debug", "--capture-output", "daily-bot-manager:app", "--bind=0.0.0.0:8000"]

src/examples/server/README.md

@@ -0,0 +1,13 @@
+# Server Example
+
+This is an example server based on [Santa Cat](https://santacat.ai). You can run the server with this command:
+
+```
+flask --app daily-bot-manager.py --debug run
+```
+
+Once the server is started, you can load `http://127.0.0.1:5000/spin-up-kitty` in a browser, and the server will do the following:
+
+- Create a new, randomly-named Daily room with `DAILY_API_KEY` from your .env file or environment
+- Start the `10-wake-word.py` example and connect it to that room
+- 301 redirect your browser to the room

src/examples/server/auth.py

@@ -0,0 +1,33 @@
+import time
+import urllib
+
+from dotenv import load_dotenv
+import requests
+from flask import jsonify
+import os
+
+load_dotenv()
+
+
+def get_meeting_token(room_name, daily_api_key, token_expiry):
+    api_path = os.getenv('DAILY_API_PATH') or 'https://api.daily.co/v1'
+
+    if not token_expiry:
+        token_expiry = time.time() + 600
+    res = requests.post(
+        f'{api_path}/meeting-tokens',
+        headers={
+            'Authorization': f'Bearer {daily_api_key}'},
+        json={
+            'properties': {
+                'room_name': room_name,
+                'is_owner': True,
+                'exp': token_expiry}})
+    if res.status_code != 200:
+        return jsonify({'error': 'Unable to create meeting token', 'detail': res.text}), 500
+    meeting_token = res.json()['token']
+    return meeting_token
+
+
+def get_room_name(room_url):
+    return urllib.parse.urlparse(room_url).path[1:]

src/examples/server/daily-bot-manager.py

@@ -0,0 +1,100 @@
+import os
+import requests
+import subprocess
+import time
+
+from flask import Flask, jsonify, request, redirect
+from flask_cors import CORS
+from examples.server.auth import get_meeting_token
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+app = Flask(__name__)
+CORS(app)
+
+print(f"I loaded an environment, and my FAL_KEY_ID is {os.getenv('FAL_KEY_ID')}")
+
+
+def start_bot(bot_path, args=None):
+    daily_api_key = os.getenv("DAILY_API_KEY")
+    api_path = os.getenv("DAILY_API_PATH") or "https://api.daily.co/v1"
+
+    timeout = int(os.getenv("DAILY_ROOM_TIMEOUT") or os.getenv("DAILY_BOT_MAX_DURATION") or 300)
+    exp = time.time() + timeout
+    res = requests.post(
+        f"{api_path}/rooms",
+        headers={"Authorization": f"Bearer {daily_api_key}"},
+        json={
+            "properties": {
+                "exp": exp,
+                "enable_chat": True,
+                "enable_emoji_reactions": True,
+                "eject_at_room_exp": True,
+                "enable_prejoin_ui": False,
+                "enable_recording": "cloud"
+            }
+        },
+    )
+    if res.status_code != 200:
+        return (
+            jsonify(
+                {
+                    "error": "Unable to create room",
+                    "status_code": res.status_code,
+                    "text": res.text,
+                }
+            ),
+            500,
+        )
+    room_url = res.json()["url"]
+    room_name = res.json()["name"]
+
+    meeting_token = get_meeting_token(room_name, daily_api_key, exp)
+
+    if args:
+        extra_args = " ".join([f'-{x[0]} "{x[1]}"' for x in args])
+    else:
+        extra_args = ""
+
+    proc = subprocess.Popen(
+        [
+            f"python {bot_path} -u {room_url} -t {meeting_token} -k {daily_api_key} {extra_args}"
+        ],
+        shell=True,
+        bufsize=1,
+    )
+
+    # Don't return until the bot has joined the room, but wait for at most 2 seconds.
+    attempts = 0
+    while attempts < 20:
+        time.sleep(0.1)
+        attempts += 1
+        res = requests.get(
+            f"{api_path}/rooms/{room_name}/get-session-data",
+            headers={"Authorization": f"Bearer {daily_api_key}"},
+        )
+        if res.status_code == 200:
+            break
+    print(f"Took {attempts} attempts to join room {room_name}")
+
+    # Additional client config
+    config = {}
+    if os.getenv("CLIENT_VAD_TIMEOUT_SEC"):
+        config['vad_timeout_sec'] = float(os.getenv("DAILY_CLIENT_VAD_TIMEOUT_SEC"))
+    else:
+        config['vad_timeout_sec'] = 1.5
+
+    # return jsonify({"room_url": room_url, "token": meeting_token, "config": config}), 200
+    return redirect(room_url, code=301)
+
+
+@app.route("/spin-up-kitty", methods=["GET", "POST"])
+def spin_up_kitty():
+    return start_bot("./src/examples/foundational/10-wake-word.py")
+
+
+@app.route("/healthz")
+def health_check():
+    return "ok", 200