active_call/media/
stream.rs

1use crate::event::{EventSender, SessionEvent};
2use crate::media::dtmf::DtmfDetector;
3use crate::media::{AudioFrame, Samples, TrackId};
4use crate::media::{
5    processor::Processor,
6    recorder::{Recorder, RecorderOption},
7    track::{Track, TrackPacketReceiver, TrackPacketSender},
8};
9use anyhow::Result;
10use std::collections::{HashMap, HashSet};
11use std::path::Path;
12use std::time::Duration;
13use tokio::task::JoinHandle;
14use tokio::{
15    select,
16    sync::{Mutex, mpsc},
17};
18use tokio_util::sync::CancellationToken;
19use tracing::{debug, info, warn};
20use uuid;
21
22pub struct MediaStream {
23    id: String,
24    pub cancel_token: CancellationToken,
25    recorder_option: Mutex<Option<RecorderOption>>,
26    tracks: Mutex<HashMap<TrackId, (Box<dyn Track>, DtmfDetector)>>,
27    suppressed_sources: Mutex<HashSet<TrackId>>,
28    event_sender: EventSender,
29    pub packet_sender: TrackPacketSender,
30    packet_receiver: Mutex<Option<TrackPacketReceiver>>,
31    recorder_sender: mpsc::UnboundedSender<AudioFrame>,
32    recorder_receiver: Mutex<Option<mpsc::UnboundedReceiver<AudioFrame>>>,
33    recorder_handle: Mutex<Option<JoinHandle<()>>>,
34}
35
36const CALLEE_TRACK_ID: &str = "callee-track";
37const QUEUE_HOLD_TRACK_ID: &str = "queue-hold-track";
38
39pub struct MediaStreamBuilder {
40    cancel_token: Option<CancellationToken>,
41    id: Option<String>,
42    event_sender: EventSender,
43    recorder_config: Option<RecorderOption>,
44}
45
46impl MediaStreamBuilder {
47    pub fn new(event_sender: EventSender) -> Self {
48        Self {
49            id: Some(format!("ms:{}", uuid::Uuid::new_v4())),
50            cancel_token: None,
51            event_sender,
52            recorder_config: None,
53        }
54    }
55    pub fn with_id(mut self, id: String) -> Self {
56        self.id = Some(id);
57        self
58    }
59
60    pub fn with_cancel_token(mut self, cancel_token: CancellationToken) -> Self {
61        self.cancel_token = Some(cancel_token);
62        self
63    }
64
65    pub fn with_recorder_config(mut self, recorder_config: RecorderOption) -> Self {
66        self.recorder_config = Some(recorder_config);
67        self
68    }
69
70    pub fn build(self) -> MediaStream {
71        let cancel_token = self
72            .cancel_token
73            .unwrap_or_else(|| CancellationToken::new());
74        let tracks = Mutex::new(HashMap::new());
75        let (track_packet_sender, track_packet_receiver) = mpsc::unbounded_channel();
76        let (recorder_sender, recorder_receiver) = mpsc::unbounded_channel();
77        MediaStream {
78            id: self.id.unwrap_or_default(),
79            cancel_token,
80            recorder_option: Mutex::new(self.recorder_config),
81            tracks,
82            suppressed_sources: Mutex::new(HashSet::new()),
83            event_sender: self.event_sender,
84            packet_sender: track_packet_sender,
85            packet_receiver: Mutex::new(Some(track_packet_receiver)),
86            recorder_sender,
87            recorder_receiver: Mutex::new(Some(recorder_receiver)),
88            recorder_handle: Mutex::new(None),
89        }
90    }
91}
92
93impl MediaStream {
94    pub async fn serve(&self) -> Result<()> {
95        let packet_receiver = match self.packet_receiver.lock().await.take() {
96            Some(receiver) => receiver,
97            None => {
98                warn!(
99                    session_id = self.id,
100                    "MediaStream::serve() called multiple times, stream already serving"
101                );
102                return Ok(());
103            }
104        };
105        self.start_recorder().await.ok();
106        info!(session_id = self.id, "mediastream serving");
107        select! {
108            _ = self.cancel_token.cancelled() => {}
109            r = self.handle_forward_track(packet_receiver) => {
110                info!(session_id = self.id, "track packet receiver stopped {:?}", r);
111            }
112        }
113        Ok(())
114    }
115
116    pub fn stop(&self, _reason: Option<String>, _initiator: Option<String>) {
117        self.cancel_token.cancel()
118    }
119
120    pub async fn cleanup(&self) -> Result<()> {
121        self.cancel_token.cancel();
122        if let Some(recorder_handle) = self.recorder_handle.lock().await.take() {
123            if let Ok(Ok(_)) = tokio::time::timeout(Duration::from_secs(30), recorder_handle).await
124            {
125                info!(session_id = self.id, "recorder stopped");
126            } else {
127                warn!(session_id = self.id, "recorder timeout");
128            }
129        }
130        Ok(())
131    }
132
133    pub async fn update_recorder_option(&self, recorder_config: RecorderOption) {
134        *self.recorder_option.lock().await = Some(recorder_config);
135        self.start_recorder().await.ok();
136    }
137
138    pub async fn remove_track(&self, id: &TrackId, graceful: bool) {
139        if let Some((track, _)) = self.tracks.lock().await.remove(id) {
140            self.suppressed_sources.lock().await.remove(id);
141            let res = if !graceful {
142                track.stop().await
143            } else {
144                track.stop_graceful().await
145            };
146            match res {
147                Ok(_) => {}
148                Err(e) => {
149                    warn!(session_id = self.id, "failed to stop track: {}", e);
150                }
151            }
152        }
153    }
154    pub async fn update_remote_description(
155        &self,
156        track_id: &TrackId,
157        answer: &String,
158    ) -> Result<()> {
159        if let Some((track, _)) = self.tracks.lock().await.get_mut(track_id) {
160            track.update_remote_description(answer).await?;
161        }
162        Ok(())
163    }
164
165    pub async fn update_remote_description_force(
166        &self,
167        track_id: &TrackId,
168        answer: &String,
169    ) -> Result<()> {
170        if let Some((track, _)) = self.tracks.lock().await.get_mut(track_id) {
171            track.update_remote_description_force(answer).await?;
172        }
173        Ok(())
174    }
175    pub async fn update_track(&self, mut track: Box<dyn Track>, play_id: Option<String>) {
176        self.remove_track(track.id(), false).await;
177        if self.recorder_option.lock().await.is_some() {
178            track.insert_processor(Box::new(RecorderProcessor::new(
179                self.recorder_sender.clone(),
180            )));
181        }
182        match track
183            .start(self.event_sender.clone(), self.packet_sender.clone())
184            .await
185        {
186            Ok(_) => {
187                info!(session_id = self.id, track_id = track.id(), "track started");
188                let track_id = track.id().clone();
189                self.tracks
190                    .lock()
191                    .await
192                    .insert(track_id.clone(), (track, DtmfDetector::new()));
193                self.event_sender
194                    .send(SessionEvent::TrackStart {
195                        track_id,
196                        timestamp: crate::media::get_timestamp(),
197                        play_id,
198                    })
199                    .ok();
200            }
201            Err(e) => {
202                warn!(
203                    session_id = self.id,
204                    track_id = track.id(),
205                    play_id = play_id.as_deref(),
206                    "Failed to start track: {}",
207                    e
208                );
209            }
210        }
211    }
212
213    pub async fn mute_track(&self, id: Option<TrackId>) {
214        if let Some(id) = id {
215            if let Some((track, _)) = self.tracks.lock().await.get_mut(&id) {
216                MuteProcessor::mute_track(track.as_mut());
217            }
218        } else {
219            for (track, _) in self.tracks.lock().await.values_mut() {
220                MuteProcessor::mute_track(track.as_mut());
221            }
222        }
223    }
224
225    pub async fn unmute_track(&self, id: Option<TrackId>) {
226        if let Some(id) = id {
227            if let Some((track, _)) = self.tracks.lock().await.get_mut(&id) {
228                MuteProcessor::unmute_track(track.as_mut());
229            }
230        } else {
231            for (track, _) in self.tracks.lock().await.values_mut() {
232                MuteProcessor::unmute_track(track.as_mut());
233            }
234        }
235    }
236
237    pub async fn suppress_forwarding(&self, track_id: &TrackId) {
238        self.suppressed_sources
239            .lock()
240            .await
241            .insert(track_id.clone());
242    }
243
244    pub async fn resume_forwarding(&self, track_id: &TrackId) {
245        self.suppressed_sources.lock().await.remove(track_id);
246    }
247}
248
249#[derive(Clone)]
250pub struct RecorderProcessor {
251    sender: mpsc::UnboundedSender<AudioFrame>,
252}
253
254impl RecorderProcessor {
255    pub fn new(sender: mpsc::UnboundedSender<AudioFrame>) -> Self {
256        Self { sender }
257    }
258}
259
260impl Processor for RecorderProcessor {
261    fn process_frame(&mut self, frame: &mut AudioFrame) -> Result<()> {
262        let frame_clone = frame.clone();
263        let _ = self.sender.send(frame_clone);
264        Ok(())
265    }
266}
267
268impl MediaStream {
269    pub async fn start_recorder(&self) -> Result<()> {
270        let recorder_option = self.recorder_option.lock().await.clone();
271        if let Some(recorder_option) = recorder_option {
272            if recorder_option.recorder_file.is_empty() {
273                warn!(
274                    session_id = self.id,
275                    "recorder file is empty, skipping recorder start"
276                );
277                return Ok(());
278            }
279            let recorder_receiver = match self.recorder_receiver.lock().await.take() {
280                Some(receiver) => receiver,
281                None => {
282                    return Ok(());
283                }
284            };
285            let cancel_token = self.cancel_token.child_token();
286            let session_id_clone = self.id.clone();
287
288            info!(
289                session_id = session_id_clone,
290                sample_rate = recorder_option.samplerate,
291                ptime = recorder_option.ptime,
292                "start recorder",
293            );
294
295            let recorder_handle = crate::spawn(async move {
296                let recorder_file = recorder_option.recorder_file.clone();
297                let recorder =
298                    Recorder::new(cancel_token, session_id_clone.clone(), recorder_option);
299                match recorder
300                    .process_recording(Path::new(&recorder_file), recorder_receiver)
301                    .await
302                {
303                    Ok(_) => {}
304                    Err(e) => {
305                        warn!(
306                            session_id = session_id_clone,
307                            "Failed to process recorder: {}", e
308                        );
309                    }
310                }
311            });
312            *self.recorder_handle.lock().await = Some(recorder_handle);
313        }
314        Ok(())
315    }
316
317    async fn handle_forward_track(&self, mut packet_receiver: TrackPacketReceiver) {
318        let event_sender = self.event_sender.clone();
319        while let Some(packet) = packet_receiver.recv().await {
320            let suppressed = {
321                self.suppressed_sources
322                    .lock()
323                    .await
324                    .contains(&packet.track_id)
325            };
326            // Process the packet with each track
327            for (track, dtmf_detector) in self.tracks.lock().await.values_mut() {
328                if track.id() == &packet.track_id {
329                    match &packet.samples {
330                        Samples::RTP {
331                            payload_type,
332                            payload,
333                            ..
334                        } => {
335                            if let Some(digit) = dtmf_detector.detect_rtp(*payload_type, payload) {
336                                debug!(track_id = track.id(), digit, "DTMF detected");
337                                event_sender
338                                    .send(SessionEvent::Dtmf {
339                                        track_id: packet.track_id.to_string(),
340                                        timestamp: packet.timestamp,
341                                        digit,
342                                    })
343                                    .ok();
344                            }
345                        }
346                        _ => {}
347                    }
348                    continue;
349                }
350                if suppressed {
351                    continue;
352                }
353                if packet.track_id == QUEUE_HOLD_TRACK_ID && track.id() == CALLEE_TRACK_ID {
354                    continue;
355                }
356                if let Err(e) = track.send_packet(&packet).await {
357                    warn!(
358                        id = track.id(),
359                        "media_stream: Failed to send packet to track: {}", e
360                    );
361                }
362            }
363        }
364    }
365}
366
367pub struct MuteProcessor;
368
369impl MuteProcessor {
370    pub fn mute_track(track: &mut dyn Track) {
371        let chain = track.processor_chain();
372        if !chain.has_processor::<MuteProcessor>() {
373            chain.insert_processor(Box::new(MuteProcessor));
374        }
375    }
376
377    pub fn unmute_track(track: &mut dyn Track) {
378        let chain = track.processor_chain();
379        chain.remove_processor::<MuteProcessor>();
380    }
381}
382
383impl Processor for MuteProcessor {
384    fn process_frame(&mut self, frame: &mut AudioFrame) -> Result<()> {
385        match &mut frame.samples {
386            Samples::PCM { samples } => {
387                samples.fill(0);
388            }
389            // discard DTMF frames
390            Samples::RTP { payload_type, .. } if *payload_type >= 96 && *payload_type <= 127 => {
391                frame.samples = Samples::Empty;
392            }
393            _ => {}
394        }
395        Ok(())
396    }
397}