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