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    /// Incoming RTC media stopped; informational only, never hangs up the call.
123    RtpTimeout {
124        track_id: String,
125        timestamp: u64,
126        /// Configured timeout in seconds.
127        timeout: u64,
128    },
129    ///Inactivity timeout
130    Inactivity {
131        track_id: String,
132        timestamp: u64,
133    },
134    Dtmf {
135        track_id: String,
136        timestamp: u64,
137        digit: String,
138        refer: Option<bool>,
139    },
140    Hold {
141        track_id: String,
142        timestamp: u64,
143        on_hold: bool,
144        refer: Option<bool>,
145    },
146    TransferRequest {
147        track_id: String,
148        timestamp: u64,
149        refer_to: String,
150        referred_by: Option<String>,
151        refer: Option<bool>,
152        /// RFC 3515 implicit-subscription notifier for the REFER's parent
153        /// dialog; used to report transfer progress back to the referrer.
154        #[serde(skip)]
155        notify: Option<std::sync::Arc<crate::call::sip::ReferProgressNotifier>>,
156    },
157    Message {
158        track_id: String,
159        timestamp: u64,
160        body: String,
161        content_type: Option<String>,
162        refer: Option<bool>,
163    },
164    TrackStart {
165        track_id: String,
166        timestamp: u64,
167        play_id: Option<String>,
168    },
169    TrackEnd {
170        track_id: String,
171        timestamp: u64,
172        duration: u64,
173        ssrc: u32,
174        play_id: Option<String>,
175        /// Hangup intent carried by the track itself; when set, the call
176        /// should hang up with this reason once the track ends.
177        auto_hangup: Option<crate::callrecord::CallRecordHangupReason>,
178    },
179    Interruption {
180        track_id: String,
181        timestamp: u64,
182        play_id: Option<String>,
183        subtitle: Option<String>, // current tts text
184        position: Option<u32>,    // word index in subtitle
185        total_duration: u32,      // whole tts duration
186        current: u32,             // elapsed time since start of tts
187    },
188    AsrFinal {
189        track_id: String,
190        timestamp: u64,
191        index: u32,
192        start_time: Option<u64>,
193        end_time: Option<u64>,
194        text: String,
195        is_filler: Option<bool>,
196        confidence: Option<f32>,
197        task_id: Option<String>,
198        refer: Option<bool>,
199    },
200    AsrDelta {
201        track_id: String,
202        index: u32,
203        timestamp: u64,
204        start_time: Option<u64>,
205        end_time: Option<u64>,
206        text: String,
207        is_filler: Option<bool>,
208        confidence: Option<f32>,
209        task_id: Option<String>,
210        refer: Option<bool>,
211    },
212    Metrics {
213        timestamp: u64,
214        key: String,
215        duration: u32,
216        data: serde_json::Value,
217    },
218    Error {
219        track_id: String,
220        timestamp: u64,
221        sender: String,
222        error: String,
223        code: Option<u32>,
224    },
225    AddHistory {
226        sender: Option<String>,
227        timestamp: u64,
228        speaker: String,
229        text: String,
230    },
231    Other {
232        track_id: String,
233        timestamp: u64,
234        sender: String,
235        extra: Option<HashMap<String, String>>,
236    },
237    Binary {
238        track_id: String,
239        timestamp: u64,
240        data: Vec<u8>,
241    },
242    Ping {
243        timestamp: u64,
244        payload: Option<String>,
245    },
246    Custom {
247        timestamp: u64,
248        sender: Option<String>,
249        data: serde_json::Value,
250    },
251    RingbackState {
252        track_id: String,
253        timestamp: u64,
254        /// Current line state: "ringing", "human_voice", "busy_tone", "silence", etc.
255        state: String,
256        /// Class index from the TelcoClassifier (3=ringing, 9=human_voice, ...)
257        state_index: u32,
258        /// Confidence of the prediction
259        confidence: f32,
260        /// Previous state (None on first detection)
261        prev_state: Option<String>,
262        prev_confidence: Option<f32>,
263        refer: Option<bool>,
264        /// Whether this is the final determination
265        #[serde(default)]
266        is_final: bool,
267    },
268}
269
270impl Display for SessionEvent {
271    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
272        match self {
273            SessionEvent::Silence {
274                track_id, duration, ..
275            } => {
276                write!(f, "Silence(track_id={}, duration={})", track_id, duration)
277            }
278            SessionEvent::Binary { track_id, data, .. } => {
279                write!(f, "Silence(track_id={}, data_len={})", track_id, data.len())
280            }
281            _ => {
282                write!(f, "{:?}", self)
283            }
284        }
285    }
286}
287
288pub type EventSender = tokio::sync::broadcast::Sender<SessionEvent>;
289pub type EventReceiver = tokio::sync::broadcast::Receiver<SessionEvent>;
290
291pub fn create_event_sender() -> EventSender {
292    EventSender::new(128)
293}