Skip to main content

active_call/
event.rs

1use crate::media::PcmBuf;
2use serde::{Deserialize, Serialize};
3use serde_with::skip_serializing_none;
4use std::{collections::HashMap, fmt::Display};
5
6#[derive(Debug, Clone, Serialize, Deserialize)]
7#[serde(rename_all = "camelCase")]
8pub struct Attendee {
9    pub username: String,
10    pub realm: String,
11    pub source: String,
12}
13
14impl From<&String> for Attendee {
15    fn from(source: &String) -> Self {
16        let uri = rsipstack::rsip::Uri::try_from(source.as_str()).unwrap_or_default();
17        Self {
18            username: uri.user().unwrap_or_default().to_string(),
19            realm: uri.host().to_string(),
20            source: source.to_string(),
21        }
22    }
23}
24
25#[skip_serializing_none]
26#[derive(Debug, Clone, Serialize, Deserialize)]
27#[serde(
28    tag = "event",
29    rename_all = "camelCase",
30    rename_all_fields = "camelCase"
31)]
32pub enum SessionEvent {
33    Incoming {
34        track_id: String,
35        timestamp: u64,
36        caller: String,
37        callee: String,
38        sdp: String,
39        headers: Option<HashMap<String, String>>,
40    },
41    Answer {
42        track_id: String,
43        timestamp: u64,
44        sdp: String,
45        refer: Option<bool>,
46    },
47    MediaReady {
48        track_id: String,
49        timestamp: u64,
50    },
51    Reject {
52        track_id: String,
53        timestamp: u64,
54        reason: String,
55        refer: Option<bool>,
56        code: Option<u32>,
57    },
58    Ringing {
59        track_id: String,
60        timestamp: u64,
61        early_media: bool,
62        refer: Option<bool>,
63    },
64    Hangup {
65        track_id: String,
66        timestamp: u64,
67        reason: Option<String>,
68        initiator: Option<String>,
69        start_time: String,
70        hangup_time: String,
71        answer_time: Option<String>,
72        ringing_time: Option<String>,
73        from: Option<Attendee>,
74        to: Option<Attendee>,
75        extra: Option<HashMap<String, serde_json::Value>>,
76        refer: Option<bool>,
77    },
78    AnswerMachineDetection {
79        // Answer machine detection
80        track_id: String,
81        timestamp: u64,
82        start_time: u64,
83        end_time: u64,
84        text: String,
85    },
86    Interrupt {
87        receiver: Option<String>,
88    },
89    FunctionCall {
90        track_id: String,
91        call_id: String,
92        name: String,
93        arguments: String,
94        timestamp: u64,
95    },
96    Speaking {
97        track_id: String,
98        timestamp: u64,
99        start_time: u64,
100        is_filler: Option<bool>,
101        confidence: Option<f32>,
102        refer: Option<bool>,
103    },
104    Silence {
105        track_id: String,
106        timestamp: u64,
107        start_time: u64,
108        duration: u64,
109        refer: Option<bool>,
110        #[serde(skip)]
111        samples: Option<PcmBuf>,
112    },
113    ///End of Utterance
114    Eou {
115        track_id: String,
116        timestamp: u64,
117        completed: bool,
118        interrupt_point: Option<String>,
119        text: Option<String>,
120        refer: Option<bool>,
121    },
122    ///Inactivity timeout
123    Inactivity {
124        track_id: String,
125        timestamp: u64,
126    },
127    Dtmf {
128        track_id: String,
129        timestamp: u64,
130        digit: String,
131        refer: Option<bool>,
132    },
133    Hold {
134        track_id: String,
135        timestamp: u64,
136        on_hold: bool,
137        refer: Option<bool>,
138    },
139    TransferRequest {
140        track_id: String,
141        timestamp: u64,
142        refer_to: String,
143        referred_by: Option<String>,
144        refer: Option<bool>,
145        /// Session id of the leg that received the REFER (the ref call id
146        /// for refer bridge legs). Lets the actor tell the current
147        /// INVITE-mode bridge leg apart from other refer legs.
148        #[serde(default, skip_serializing_if = "Option::is_none")]
149        leg_session_id: Option<String>,
150        /// RFC 3515 implicit-subscription notifier for the REFER's parent
151        /// dialog; used to report transfer progress back to the referrer.
152        #[serde(skip)]
153        notify: Option<std::sync::Arc<crate::call::sip::ReferProgressNotifier>>,
154    },
155    Message {
156        track_id: String,
157        timestamp: u64,
158        body: String,
159        content_type: Option<String>,
160        refer: Option<bool>,
161    },
162    TrackStart {
163        track_id: String,
164        timestamp: u64,
165        play_id: Option<String>,
166    },
167    TrackEnd {
168        track_id: String,
169        timestamp: u64,
170        duration: u64,
171        ssrc: u32,
172        play_id: Option<String>,
173        /// Hangup intent carried by the track itself; when set, the call
174        /// should hang up with this reason once the track ends.
175        auto_hangup: Option<crate::callrecord::CallRecordHangupReason>,
176    },
177    Interruption {
178        track_id: String,
179        timestamp: u64,
180        play_id: Option<String>,
181        subtitle: Option<String>, // current tts text
182        position: Option<u32>,    // word index in subtitle
183        total_duration: u32,      // whole tts duration
184        current: u32,             // elapsed time since start of tts
185    },
186    AsrFinal {
187        track_id: String,
188        timestamp: u64,
189        index: u32,
190        start_time: Option<u64>,
191        end_time: Option<u64>,
192        text: String,
193        is_filler: Option<bool>,
194        confidence: Option<f32>,
195        task_id: Option<String>,
196        refer: Option<bool>,
197    },
198    AsrDelta {
199        track_id: String,
200        index: u32,
201        timestamp: u64,
202        start_time: Option<u64>,
203        end_time: Option<u64>,
204        text: String,
205        is_filler: Option<bool>,
206        confidence: Option<f32>,
207        task_id: Option<String>,
208        refer: Option<bool>,
209    },
210    Metrics {
211        timestamp: u64,
212        key: String,
213        duration: u32,
214        data: serde_json::Value,
215    },
216    Error {
217        track_id: String,
218        timestamp: u64,
219        sender: String,
220        error: String,
221        code: Option<u32>,
222    },
223    AddHistory {
224        sender: Option<String>,
225        timestamp: u64,
226        speaker: String,
227        text: String,
228    },
229    Other {
230        track_id: String,
231        timestamp: u64,
232        sender: String,
233        extra: Option<HashMap<String, String>>,
234    },
235    Binary {
236        track_id: String,
237        timestamp: u64,
238        data: Vec<u8>,
239    },
240    Ping {
241        timestamp: u64,
242        payload: Option<String>,
243    },
244    Custom {
245        timestamp: u64,
246        sender: Option<String>,
247        data: serde_json::Value,
248    },
249    RingbackState {
250        track_id: String,
251        timestamp: u64,
252        /// Current line state: "ringing", "human_voice", "busy_tone", "silence", etc.
253        state: String,
254        /// Class index from the TelcoClassifier (3=ringing, 9=human_voice, ...)
255        state_index: u32,
256        /// Confidence of the prediction
257        confidence: f32,
258        /// Previous state (None on first detection)
259        prev_state: Option<String>,
260        prev_confidence: Option<f32>,
261        refer: Option<bool>,
262        /// Whether this is the final determination
263        #[serde(default)]
264        is_final: bool,
265    },
266}
267
268impl Display for SessionEvent {
269    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
270        match self {
271            SessionEvent::Silence {
272                track_id, duration, ..
273            } => {
274                write!(f, "Silence(track_id={}, duration={})", track_id, duration)
275            }
276            SessionEvent::Binary { track_id, data, .. } => {
277                write!(f, "Silence(track_id={}, data_len={})", track_id, data.len())
278            }
279            _ => {
280                write!(f, "{:?}", self)
281            }
282        }
283    }
284}
285
286pub type EventSender = tokio::sync::broadcast::Sender<SessionEvent>;
287pub type EventReceiver = tokio::sync::broadcast::Receiver<SessionEvent>;
288
289pub fn create_event_sender() -> EventSender {
290    EventSender::new(128)
291}