287 lines
12 KiB
Python
287 lines
12 KiB
Python
#
|
||
# Copyright (c) 2024–2025, Daily
|
||
#
|
||
# SPDX-License-Identifier: BSD 2-Clause License
|
||
#
|
||
|
||
"""Simli video service for real-time avatar generation."""
|
||
|
||
import asyncio
|
||
import warnings
|
||
from typing import Optional
|
||
|
||
import numpy as np
|
||
from loguru import logger
|
||
from pydantic import BaseModel
|
||
|
||
from pipecat.frames.frames import (
|
||
CancelFrame,
|
||
EndFrame,
|
||
Frame,
|
||
InterruptionFrame,
|
||
OutputImageRawFrame,
|
||
TTSAudioRawFrame,
|
||
TTSStoppedFrame,
|
||
UserStartedSpeakingFrame,
|
||
)
|
||
from pipecat.processors.frame_processor import FrameDirection, FrameProcessor, StartFrame
|
||
|
||
try:
|
||
from av.audio.frame import AudioFrame
|
||
from av.audio.resampler import AudioResampler
|
||
from simli import SimliClient, SimliConfig
|
||
except ModuleNotFoundError as e:
|
||
logger.error(f"Exception: {e}")
|
||
logger.error("In order to use Simli, you need to `pip install pipecat-ai[simli]`.")
|
||
raise Exception(f"Missing module: {e}")
|
||
|
||
|
||
class SimliVideoService(FrameProcessor):
|
||
"""Simli video service for real-time avatar generation.
|
||
|
||
Provides real-time avatar video generation by processing audio frames
|
||
and producing synchronized video output using the Simli API. Handles
|
||
audio resampling, video frame processing, and connection management.
|
||
"""
|
||
|
||
class InputParams(BaseModel):
|
||
"""Input parameters for Simli video configuration.
|
||
|
||
Parameters:
|
||
max_session_length: Absolute maximum session duration in seconds.
|
||
Avatar will disconnect after this time even if it's speaking.
|
||
max_idle_time: Maximum duration in seconds the avatar is not speaking
|
||
before the avatar disconnects.
|
||
"""
|
||
|
||
max_session_length: Optional[int] = None
|
||
max_idle_time: Optional[int] = None
|
||
|
||
def __init__(
|
||
self,
|
||
*,
|
||
api_key: Optional[str] = None,
|
||
face_id: Optional[str] = None,
|
||
simli_config: Optional[SimliConfig] = None,
|
||
use_turn_server: bool = False,
|
||
latency_interval: int = 0,
|
||
simli_url: str = "https://api.simli.ai",
|
||
is_trinity_avatar: bool = False,
|
||
params: Optional[InputParams] = None,
|
||
**kwargs,
|
||
):
|
||
"""Initialize the Simli video service.
|
||
|
||
Args:
|
||
api_key: Simli API key for authentication.
|
||
face_id: Simli Face ID. For Trinity avatars, specify "faceId/emotionId"
|
||
to use a different emotion than the default.
|
||
simli_config: Configuration object for Simli client settings.
|
||
Use api_key and face_id instead.
|
||
|
||
.. deprecated:: 0.0.92
|
||
The 'simli_config' parameter is deprecated and will be removed in a future version.
|
||
Please use 'api_key' and 'face_id' parameters instead.
|
||
|
||
use_turn_server: Whether to use TURN server for connection. Defaults to False.
|
||
|
||
.. deprecated:: 0.0.95
|
||
The 'use_turn_server' parameter is deprecated and will be removed in a future version.
|
||
|
||
latency_interval: Latency interval setting for sending health checks to check
|
||
the latency to Simli Servers. Defaults to 0.
|
||
simli_url: URL of the simli servers. Can be changed for custom deployments
|
||
of enterprise users.
|
||
is_trinity_avatar: Boolean to tell simli client that this is a Trinity avatar
|
||
which reduces latency when using Trinity.
|
||
params: Additional input parameters for session configuration.
|
||
**kwargs: Additional arguments passed to the parent FrameProcessor.
|
||
"""
|
||
super().__init__(**kwargs)
|
||
|
||
params = params or SimliVideoService.InputParams()
|
||
|
||
# Handle deprecated simli_config parameter
|
||
if simli_config is not None:
|
||
if api_key is not None or face_id is not None:
|
||
raise ValueError(
|
||
"Cannot specify both simli_config and api_key/face_id. "
|
||
"Please use api_key and face_id (simli_config is deprecated)."
|
||
)
|
||
|
||
warnings.warn(
|
||
"The 'simli_config' parameter is deprecated and will be removed in a future version. "
|
||
"Please use 'api_key' and 'face_id' parameters instead, with optional 'params' for "
|
||
"max_session_length and max_idle_time configuration.",
|
||
DeprecationWarning,
|
||
stacklevel=2,
|
||
)
|
||
|
||
# Use the provided simli_config
|
||
config = simli_config
|
||
else:
|
||
# Validate new parameters
|
||
if api_key is None:
|
||
raise ValueError("api_key is required")
|
||
if face_id is None:
|
||
raise ValueError("face_id is required")
|
||
|
||
# Build SimliConfig from new parameters
|
||
# Only pass optional parameters if explicitly provided to use SimliConfig defaults
|
||
config_kwargs = {
|
||
"apiKey": api_key,
|
||
"faceId": face_id,
|
||
}
|
||
if params.max_session_length is not None:
|
||
config_kwargs["maxSessionLength"] = params.max_session_length
|
||
if params.max_idle_time is not None:
|
||
config_kwargs["maxIdleTime"] = params.max_idle_time
|
||
|
||
config = SimliConfig(**config_kwargs)
|
||
|
||
if use_turn_server:
|
||
warnings.warn(
|
||
"The 'use_turn_server' parameter is deprecated and will be removed in a future version.",
|
||
DeprecationWarning,
|
||
stacklevel=2,
|
||
)
|
||
|
||
self._initialized = False
|
||
# Add buffer time to session limits
|
||
config.maxIdleTime += 5
|
||
config.maxSessionLength += 5
|
||
self._simli_client = SimliClient(
|
||
config=config,
|
||
latencyInterval=latency_interval,
|
||
simliURL=simli_url,
|
||
)
|
||
|
||
self._pipecat_resampler: AudioResampler = None
|
||
self._pipecat_resampler_event = asyncio.Event()
|
||
self._simli_resampler = AudioResampler("s16", "mono", 16000)
|
||
|
||
self._audio_task: asyncio.Task = None
|
||
self._video_task: asyncio.Task = None
|
||
self._is_trinity_avatar = is_trinity_avatar
|
||
self._previously_interrupted = is_trinity_avatar
|
||
self._audio_buffer = bytearray()
|
||
|
||
async def _start_connection(self):
|
||
"""Start the connection to Simli service and begin processing tasks."""
|
||
try:
|
||
if not self._initialized:
|
||
await self._simli_client.Initialize()
|
||
self._initialized = True
|
||
|
||
# Create task to consume and process audio and video
|
||
await self._simli_client.sendSilence()
|
||
self._audio_task = self.create_task(self._consume_and_process_audio())
|
||
self._video_task = self.create_task(self._consume_and_process_video())
|
||
except Exception as e:
|
||
logger.error(f"{self}: unable to start connection: {e}")
|
||
|
||
async def _consume_and_process_audio(self):
|
||
"""Consume audio frames from Simli and push them downstream."""
|
||
await self._pipecat_resampler_event.wait()
|
||
audio_iterator = self._simli_client.getAudioStreamIterator()
|
||
async for audio_frame in audio_iterator:
|
||
resampled_frames = self._pipecat_resampler.resample(audio_frame)
|
||
for resampled_frame in resampled_frames:
|
||
audio_array = resampled_frame.to_ndarray()
|
||
# Only push frame is there is audio (e.g. not silence)
|
||
if audio_array.any():
|
||
await self.push_frame(
|
||
TTSAudioRawFrame(
|
||
audio=audio_array.tobytes(),
|
||
sample_rate=self._pipecat_resampler.rate,
|
||
num_channels=1,
|
||
),
|
||
)
|
||
|
||
async def _consume_and_process_video(self):
|
||
"""Consume video frames from Simli and convert them to output frames."""
|
||
await self._pipecat_resampler_event.wait()
|
||
video_iterator = self._simli_client.getVideoStreamIterator(targetFormat="rgb24")
|
||
async for video_frame in video_iterator:
|
||
# Process the video frame
|
||
convertedFrame: OutputImageRawFrame = OutputImageRawFrame(
|
||
image=video_frame.to_rgb().to_image().tobytes(),
|
||
size=(video_frame.width, video_frame.height),
|
||
format="RGB",
|
||
)
|
||
convertedFrame.pts = video_frame.pts
|
||
await self.push_frame(convertedFrame)
|
||
|
||
async def process_frame(self, frame: Frame, direction: FrameDirection):
|
||
"""Process incoming frames and handle Simli video generation.
|
||
|
||
Args:
|
||
frame: The frame to process.
|
||
direction: The direction of frame processing.
|
||
"""
|
||
await super().process_frame(frame, direction)
|
||
if isinstance(frame, StartFrame):
|
||
await self._start_connection()
|
||
elif isinstance(frame, TTSAudioRawFrame):
|
||
# Send audio frame to Simli
|
||
try:
|
||
old_frame = AudioFrame.from_ndarray(
|
||
np.frombuffer(frame.audio, dtype=np.int16)[None, :],
|
||
layout="mono" if frame.num_channels == 1 else "stereo",
|
||
)
|
||
old_frame.sample_rate = frame.sample_rate
|
||
|
||
if self._pipecat_resampler is None:
|
||
self._pipecat_resampler = AudioResampler(
|
||
"s16", old_frame.layout, old_frame.sample_rate
|
||
)
|
||
self._pipecat_resampler_event.set()
|
||
|
||
resampled_frames = self._simli_resampler.resample(old_frame)
|
||
for resampled_frame in resampled_frames:
|
||
audioBytes = resampled_frame.to_ndarray().astype(np.int16).tobytes()
|
||
if self._previously_interrupted:
|
||
self._audio_buffer.extend(audioBytes)
|
||
if len(self._audio_buffer) >= 128000:
|
||
try:
|
||
for flushFrame in self._simli_resampler.resample(None):
|
||
self._audio_buffer.extend(
|
||
flushFrame.to_ndarray().astype(np.int16).tobytes()
|
||
)
|
||
finally:
|
||
await self._simli_client.playImmediate(self._audio_buffer)
|
||
self._previously_interrupted = False
|
||
self._audio_buffer = bytearray()
|
||
else:
|
||
await self._simli_client.send(audioBytes)
|
||
return
|
||
except Exception as e:
|
||
logger.exception(f"{self} exception: {e}")
|
||
elif isinstance(frame, TTSStoppedFrame):
|
||
try:
|
||
if self._previously_interrupted and len(self._audio_buffer) > 0:
|
||
await self._simli_client.playImmediate(self._audio_buffer)
|
||
self._previously_interrupted = False
|
||
self._audio_buffer = bytearray()
|
||
except Exception as e:
|
||
logger.exception(f"{self} exception: {e}")
|
||
return
|
||
elif isinstance(frame, (EndFrame, CancelFrame)):
|
||
await self._stop()
|
||
elif isinstance(frame, (InterruptionFrame, UserStartedSpeakingFrame)):
|
||
if not self._previously_interrupted:
|
||
await self._simli_client.clearBuffer()
|
||
self._previously_interrupted = self._is_trinity_avatar
|
||
|
||
await self.push_frame(frame, direction)
|
||
|
||
async def _stop(self):
|
||
"""Stop the Simli client and cancel processing tasks."""
|
||
await self._simli_client.stop()
|
||
if self._audio_task:
|
||
await self.cancel_task(self._audio_task)
|
||
self._audio_task = None
|
||
if self._video_task:
|
||
await self.cancel_task(self._video_task)
|
||
self._video_task = None
|