o i*t@sTdZddlZddlmZddlmZmZmZmZm Z ddl Z ddl m Z ddl mZddlmZddlmZmZmZmZmZmZmZmZmZmZmZdd lmZmZm Z dd l!m"Z"dd l#m$Z$dd l%m&Z&m'Z'dd l(m)Z)m*Z*m+Z+GdddZ,GdddeZ-Gddde*Z.GdddZ/Gddde"Z0Gddde$Z1Gddde&Z2dS)aTavus transport implementation for Pipecat. This module provides integration with the Tavus platform for creating conversational AI applications with avatars. It manages conversation sessions and provides real-time audio/video streaming capabilities through the Tavus API. N)partial)Any AwaitableCallableMappingOptional) AudioData)logger) BaseModel) BotConnectedFrame CancelFrameClientConnectedFrameEndFrameFrameInputAudioRawFrameInterruptionFrameOutputAudioRawFrameOutputTransportMessageFrame!OutputTransportMessageUrgentFrame StartFrame)FrameDirectionFrameProcessorFrameProcessorSetup)BaseInputTransport)BaseOutputTransport) BaseTransportTransportParams)DailyCallbacks DailyParamsDailyTransportClientc@sfeZdZdZdZdZdZdedej fddZ d ed ed e fd d Z defddZ d ed efddZdS)TavusApizHelper class for interacting with the Tavus API (v2). Provides methods for creating and managing conversations with Tavus avatars, including conversation lifecycle management and persona information retrieval. zhttps://tavusapi.com/v2zdev-conversationTestTavusTransportapi_keysessioncCs*||_||_d|jd|_td|_dS)zInitialize the TavusApi client. Args: api_key: Tavus API key for authentication. session: An aiohttp session for making HTTP requests. zapplication/json)z Content-Typez x-api-keyTAVUS_SAMPLE_ROOM_URLN)_api_key_session_headersosgetenv _dev_room_url)selfr"r#r,V/home/ubuntu/.local/lib/python3.10/site-packages/pipecat/transports/tavus/transport.py__init__:szTavusApi.__init__ replica_id persona_idreturnc s|jr |j|jdStd|d||jd}||d}|jj||j|d4IdH }|| IdH}td||WdIdHS1IdHsUwYdS) a?Create a new conversation with the specified replica and persona. Args: replica_id: ID of the replica to use in the conversation. persona_id: ID of the persona to use in the conversation. Returns: Dictionary containing conversation_id and conversation_url. )conversation_idconversation_urlz%Creating Tavus conversation: replica=z , persona=z/conversations)r/r0)headersjsonNzCreated Tavus conversation: ) r*MOCK_CONVERSATION_IDr debugBASE_URLr&postr'raise_for_statusr5)r+r/r0urlpayloadrresponser,r,r-create_conversationGs   0zTavusApi.create_conversationr2c s|dus ||jkr dS|jd|d}|jj||jd4IdH}|td|WdIdHdS1IdHs@wYdS)zqEnd an existing conversation. Args: conversation_id: ID of the conversation to end. Nz/conversations/z/endr4zEnded Tavus conversation )r6r8r&r9r'r:r r7)r+r2r;r=r,r,r-end_conversationcs.zTavusApi.end_conversationc s|jdur |jS|jd|}|jj||jd4IdH"}||IdH}t d||dWdIdHS1IdHsFwYdS)zGet the name of a persona by ID. Args: persona_id: ID of the persona to retrieve. Returns: The name of the persona. Nz /personas/r@zFetched Tavus persona: persona_name) r*MOCK_PERSONA_NAMEr8r&getr'r:r5r r7)r+r0r;r=r>r,r,r-get_persona_nameqs 0zTavusApi.get_persona_nameN)__name__ __module__ __qualname____doc__r8r6rCstraiohttp ClientSessionr.dictr?rArEr,r,r,r-r /s r c@sneZdZUdZeeeefgedfe d<eeeefgedfe d<eeeefegedfe d<dS)TavusCallbacksaCallback handlers for Tavus events. Parameters: on_joined: Called when the bot joins the Daily room. on_participant_joined: Called when a participant joins the conversation. on_participant_left: Called when a participant leaves the conversation. N on_joinedon_participant_joinedon_participant_left) rFrGrHrIrrrJrr__annotations__r,r,r,r-rNs $rNc@s6eZdZUdZdZeed<dZeed<dZeed<dS) TavusParamsa(Configuration parameters for the Tavus transport. Parameters: audio_in_enabled: Whether to enable audio input from participants. audio_out_enabled: Whether to enable audio output to participants. microphone_out_enabled: Whether to enable microphone output track. Taudio_in_enabledaudio_out_enabledFmicrophone_out_enabledN) rFrGrHrIrTboolrRrUrVr,r,r,r-rSs   rSc@s\eZdZdZedddededededed ed ejd d fd dZ d efddZ de fddZ ddZ ddZddZddZd efddZdefdd Zd!d"Z # $ %dDd&ed'ed(ed)ed*ef d+d,Z - . /dEd&ed'ed0ed1ed2ef d3d4ZdeeBfd5d6Zed efd7d8Zed efd9d:ZdFd;d<ZdGd=d>Z de!d e"fd?d@Z#dAefdBdCZ$d S)HTavusTransportClientaTransport client that integrates Pipecat with the Tavus platform. A transport client that integrates a Pipecat Bot with the Tavus platform by managing conversation sessions using the Tavus API. This client uses `TavusApi` to interact with the Tavus backend services. When a conversation is started via `TavusApi`, Tavus provides a `roomURL` that can be used to connect the Pipecat Bot into the same virtual room where the TavusBot is operating. pipecat-stream)paramsr0bot_namerZ callbacksr"r/r0r#r1NcCs:||_t|||_||_||_d|_d|_||_||_dS)aInitialize the Tavus transport client. Args: bot_name: The name of the Pipecat bot instance. params: Optional parameters for Tavus operation. callbacks: Callback handlers for Tavus-related events. api_key: API key for authenticating with Tavus API. replica_id: ID of the replica to use in the Tavus conversation. persona_id: ID of the Tavus persona. Defaults to "pipecat-stream", which signals Tavus to use the TTS voice of the Pipecat bot instead of a Tavus persona voice. session: The aiohttp session for making async HTTP requests. N) _bot_namer _api _replica_id _persona_id_conversation_id_client _callbacks_params)r+r[rZr\r"r/r0r#r,r,r-r.s  zTavusTransportClient.__init__cs,|j|j|jIdH}|d|_|dS)z4Initialize the conversation and return the room URL.Nr2r3)r^r?r_r`ra)r+r>r,r,r- _initializes z TavusTransportClient._initializesetupc s@|jdurtd|jdSz|IdH}td"idt|jdd|jd|jdt|jddt|jddt|jdd t|jd d t|jd d t|jd d t|jd d t|jd dt|jddt|jddt|jddt|jddt|jddt|jddt|jddt|jddt|jdd|j j d|j j dt|jddt|jddt|jddt|jddt|jddt|jddt|jd}t |dd |j ||j|_|j|IdHWdSty}ztd!||j|jIdHd|_WYd}~dSd}~ww)#zSetup the client and initialize the conversation. Args: setup: The frame processor setup configuration. Nz!Conversation ID already defined: on_active_speaker_changedrOon_lefton_before_leaveon_erroron_app_messageon_call_state_updatedon_client_connectedon_client_disconnectedon_dialin_connectedon_dialin_readyon_dialin_stoppedon_dialin_erroron_dialin_warningon_dialout_answeredon_dialout_connectedon_dialout_stoppedon_dialout_erroron_dialout_warning on_dtmf_eventrPrQon_participant_updatedon_transcription_messageon_recording_startedon_recording_stoppedon_recording_erroron_transcription_stoppedon_transcription_errorPipecatz&Failed to setup TavusTransportClient: r,)rar r7rerr_on_handle_callback _on_joined_on_leftrcrPrQrrdr]rbrf Exceptionerrorr^rA)r+rfroom_urldaily_callbackser,r,r-rfs                        #%zTavusTransportClient.setupc sPz |jIdHWdSty'}ztd|WYd}~dSd}~ww)zCleanup client resources.NzException during cleanup: )rbcleanuprr r)r+rr,r,r-r szTavusTransportClient.cleanupcs"td|j|IdHdS)zHandle joined event.zTavusTransportClient joined!N)r r7rcrOr+datar,r,r-rs zTavusTransportClient._on_joinedcstddS)zHandle left event.zTavusTransportClient left!N)r r7r+r,r,r-rszTavusTransportClient._on_leftcs"td|d|d|dS)zHandle generic callback events.z [Callback] z called with args=z , kwargs=N)r trace)r+ event_nameargskwargsr,r,r-rs z(TavusTransportClient._on_handle_callbackcs|j|jIdHS)zjGet the persona name from the API. Returns: The name of the current persona. N)r^rEr`rr,r,r-rE sz%TavusTransportClient.get_persona_nameframecs2td|j|IdH|jIdHdS)zStart the client and join the room. Args: frame: The start frame containing initialization parameters. z#TavusTransportClient start invoked!N)r r7rbstartjoinr+rr,r,r-r(s zTavusTransportClient.startcs0|jIdH|j|jIdHd|_dS)z)Stop the client and end the conversation.N)rbleaver^rArarr,r,r-stop2s zTavusTransportClient.stopcameraRGBparticipant_idcallback framerate video_source color_formatc |j|||||IdHdS)aoCapture video from a participant. Args: participant_id: ID of the participant to capture video from. callback: Callback function to handle video frames. framerate: Desired framerate for video capture. video_source: Video source to capture from. color_format: Color format for video frames. N)rbcapture_participant_video)r+rrrrrr,r,r-r8 z.TavusTransportClient.capture_participant_video microphone> audio_source sample_ratecallback_interval_mscr)aCapture audio from a participant. Args: participant_id: ID of the participant to capture audio from. callback: Callback function to handle audio data. audio_source: Audio source to capture from. sample_rate: Desired sample rate for audio capture. callback_interval_ms: Interval between audio callbacks in milliseconds. N)rbcapture_participant_audio)r+rrrrrr,r,r-rMrz.TavusTransportClient.capture_participant_audioc|j|IdHdS)eSend a message to participants. Args: frame: The message frame to send. N)rb send_messagerr,r,r-rbsz!TavusTransportClient.send_messagecC|jjS)z`Get the output sample rate. Returns: The output sample rate in Hz. )rbout_sample_raterr,r,r-rlz$TavusTransportClient.out_sample_ratecCr)z^Get the input sample rate. Returns: The input sample rate in Hz. )rbin_sample_raterr,r,r-rurz#TavusTransportClient.in_sample_ratecs*tdd|jdd}||IdHdS)z.Send an interrupt message to the conversation. conversationzconversation.interrupt) message_type event_typer2)messageN)rrar)r+transport_framer,r,r-send_interrupt_message~sz+TavusTransportClient.send_interrupt_messagecs&|jsdS|jj||dIdHdS)Update subscription settings for participants. Args: participant_settings: Per-participant subscription settings. profile_settings: Global subscription profile settings. Nparticipant_settingsprofile_settingsrbupdate_subscriptionsr+rrr,r,r-rs z)TavusTransportClient.update_subscriptionscs|jsdS|j|IdHS)zWrite an audio frame to the transport. Args: frame: The audio frame to write. Returns: True if the audio frame was written successfully, False otherwise. FN)rbwrite_audio_framerr,r,r-rs z&TavusTransportClient.write_audio_frame destinationcs"|jsdS|j|IdHdS)zRegister an audio destination for output. Args: destination: The destination identifier to register. Nrbregister_audio_destinationr+rr,r,r-rsz/TavusTransportClient.register_audio_destination)rrr)rrr)r1NNN)%rFrGrHrIrSrJrNrKrLr.rerrfrrrrrErrrrintrrrrrpropertyrrrrrrWrrr,r,r,r-rXs  !9         rXcseZdZdZdedeffdd Zdeffdd Zfd d Z d e ffd d Z d e ffdd Z d effdd ZddZdededefddZZS)TavusInputTransportzInput transport for receiving audio and events from Tavus conversations. Handles incoming audio streams from participants and manages audio capture from the Daily room connected to the Tavus conversation. clientrZc s*tj|fi|||_||_d|_dS)zInitialize the Tavus input transport. Args: client: The Tavus transport client instance. params: Transport configuration parameters. **kwargs: Additional arguments passed to parent class. FN)superr.rbrd _initializedr+rrZr __class__r,r-r.s  zTavusInputTransport.__init__rfc*t|IdH|j|IdHdS)znSetup the input transport. Args: setup: The frame processor setup configuration. Nrrfrbr+rfrr,r-rfzTavusInputTransport.setupc&tIdH|jIdHdS)z"Cleanup input transport resources.Nrrrbrrr,r-rzTavusInputTransport.cleanuprcsJt|IdH|jrdSd|_|j|IdH||IdHdS)z{Start the input transport. Args: frame: The start frame containing initialization parameters. NT)rrrrbset_transport_readyrrr,r-rszTavusInputTransport.startc(t|IdH|jIdHdS)zpStop the input transport. Args: frame: The end frame signaling transport shutdown. Nrrrbrrr,r-rzTavusInputTransport.stopc(t|IdH|jIdHdS)zyCancel the input transport. Args: frame: The cancel frame signaling immediate cancellation. Nrcancelrbrrrr,r-rrzTavusInputTransport.cancelcsH|jjr"td|d|jj|d|j|jjdIdHdSdS)zStart capturing audio from a participant. Args: participant: The participant to capture audio from. z;TavusTransportClient start capturing audio for participant id)rrrN)rdrTr inforbr_on_participant_audio_datarr+ participantr,r,r-start_capturing_audios z)TavusInputTransport.start_capturing_audioraudiorcs0t|j|j|jd}||_||IdHdS)z'Handle received participant audio data.)rr num_channelsN)r audio_framesrrtransport_sourcepush_audio_frame)r+rrrrr,r,r-r sz.TavusInputTransport._on_participant_audio_data)rFrGrHrIrXrr.rrfrrrrrr rrrJrr __classcell__r,r,rr-rs(   rcseZdZdZdedeffdd Zdeffdd Zfd d Z d e ffd d Z d e ffdd Z d effdd Zd eeBfddZd edeffdd ZddZd edefddZdefddZZS)TavusOutputTransportzOutput transport for sending audio and events to Tavus conversations. Handles outgoing audio streams to participants and manages the custom audio track expected by the Tavus platform. rrZc s0tj|fi|||_||_d|_d|_dS)zInitialize the Tavus output transport. Args: client: The Tavus transport client instance. params: Transport configuration parameters. **kwargs: Additional arguments passed to parent class. FstreamN)rr.rbrdr_transport_destinationrrr,r-r.s   zTavusOutputTransport.__init__rfcr)zoSetup the output transport. Args: setup: The frame processor setup configuration. Nrrrr,r-rf4rzTavusOutputTransport.setupcr)z#Cleanup output transport resources.Nrrrr,r-r=rzTavusOutputTransport.cleanuprcsdt|IdH|jrdSd|_|j|IdH|jr(|j|jIdH||IdHdS)z|Start the output transport. Args: frame: The start frame containing initialization parameters. NT)rrrrbrrrrrr,r-rBszTavusOutputTransport.startcr)zqStop the output transport. Args: frame: The end frame signaling transport shutdown. Nrrrr,r-rVrzTavusOutputTransport.stopcr)zzCancel the output transport. Args: frame: The cancel frame signaling immediate cancellation. Nrrrr,r-r_rzTavusOutputTransport.cancelcs(td||j|IdHdS)rz%TavusOutputTransport sending message N)r rrbrrr,r,r-rhsz!TavusOutputTransport.send_message directioncs6t||IdHt|tr|IdHdSdS)zProcess frames and handle interruptions. Args: frame: The frame to process. direction: The direction of frame flow in the pipeline. N)r process_frame isinstancer_handle_interruptions)r+rrrr,r-rss  z"TavusOutputTransport.process_framecs|jIdHdS)z8Handle interruption events by sending interrupt message.N)rbrrr,r,r-r~sz*TavusOutputTransport._handle_interruptionsr1cs|j|_|j|IdHS)zWrite an audio frame to the Tavus transport. Args: frame: The audio frame to write. Returns: True if the audio frame was written successfully, False otherwise. N)rtransport_destinationrbrrr,r,r-rs z&TavusOutputTransport.write_audio_framercr)zwRegister an audio destination. Args: destination: The destination identifier to register. Nrrr,r,r-rsz/TavusOutputTransport.register_audio_destination)rFrGrHrIrXrr.rrfrrrrrr rrrrrrrrrrWrrJrrr,r,rr-rs&       rcseZdZdZdeddfdedejdededed ed eed eeffd d Z ddZ ddZ ddZ d ddZ defddZdefddZdefddZdefddZZS)!TavusTransportaTransport implementation for Tavus video calls. When used, the Pipecat bot joins the same virtual room as the Tavus Avatar and the user. This is achieved by using `TavusTransportClient`, which initiates the conversation via `TavusApi` and obtains a room URL that all participants connect to. Event handlers available: - on_connected(transport, data): Bot connected to the room - on_client_connected(transport, participant): Participant connected to the session - on_client_disconnected(transport, participant): Participant disconnected from the session Example:: @transport.event_handler("on_client_connected") async def on_client_connected(transport, participant): ... rYNr[r#r"r/r0rZ input_name output_namec svtj||d||_t|j|j|jd} td| |||||d|_d|_ d|_ d|_ | d| d| ddS) aqInitialize the Tavus transport. Args: bot_name: The name of the Pipecat bot. session: aiohttp session used for async HTTP requests. api_key: Tavus API key for authentication. replica_id: ID of the replica model used for voice generation. persona_id: ID of the Tavus persona. Defaults to "pipecat-stream" to use the Pipecat TTS voice. params: Optional Tavus-specific configuration parameters. input_name: Optional name for the input transport. output_name: Optional name for the output transport. )rr)rOrPrQr)r[r\r"r/r0r#rZN on_connectedrmrn) rr.rdrNr_on_participant_joined_on_participant_leftrXrb_input_output_tavus_participant_id_register_event_handler) r+r[r#r"r/r0rZrrr\rr,r-r.s,   zTavusTransport.__init__c6|d|IdH|jr|jtIdHdSdS)zHandle bot joined room event.rN)_call_event_handlerr push_framer rr,r,r-r zTavusTransport._on_joinedcsB|jIdH}|didd|kr||IdHdSdS)zHandle participant left events.NruserName)rbrErD_on_client_disconnected)r+rreasonrBr,r,r-rs z#TavusTransport._on_participant_leftcs|jIdH}|didd|kr|d|_dS||IdH|jrAtd|jd|j|jdd d iiid IdH|jrO|j |IdHdSdS) z!Handle participant joined events.Nrrrrz Ignoring z 's microphonemediar unsubscribed)r) rbrErDr_on_client_connectedr r7rrr)r+rrBr,r,r-rs  z%TavusTransport._on_participant_joinedcs|jj||dIdHdS)rrNrrr,r,r-rs z#TavusTransport.update_subscriptionsr1cC|js t|j|jd|_|jS)zGet the input transport for receiving media and events. Returns: The Tavus input transport instance. rrZ)rrrbrdrr,r,r-input zTavusTransport.inputcCr)zGet the output transport for sending media and events. Returns: The Tavus output transport instance. r)rrrbrdrr,r,r-outputrzTavusTransport.outputrcr)zHandle client connected events.rmN)rrrr rr,r,r-r!rz#TavusTransport._on_client_connectedcs|d|IdHdS)z"Handle client disconnected events.rnN)rrr,r,r-r'sz&TavusTransport._on_client_disconnectedr)rFrGrHrIrSrJrKrLrr.rrrrrrrrrrrr,r,rr-rs> 3    r)3rIr( functoolsrtypingrrrrrrK daily.dailyrlogurur pydanticr pipecat.frames.framesr r r rrrrrrrr"pipecat.processors.frame_processorrrrpipecat.transports.base_inputrpipecat.transports.base_outputr!pipecat.transports.base_transportrr"pipecat.transports.daily.transportrrrr rNrSrXrrrr,r,r,r-s0    4  Vg