rustrtc 0.3.51

A high-performance implementation of WebRTC
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
use anyhow::Result;
use rustrtc::{MediaKind, RtcConfiguration};
use rustrtc::{PeerConnection, TransceiverDirection};
use std::sync::Arc;
use std::time::Duration;
use tokio::time::timeout;
use webrtc::api::APIBuilder;
use webrtc::api::interceptor_registry::register_default_interceptors;
use webrtc::api::media_engine::MediaEngine;
use webrtc::interceptor::registry::Registry;
use webrtc::peer_connection::configuration::RTCConfiguration as WebrtcConfiguration;
use webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState;
use webrtc::peer_connection::sdp::session_description::RTCSessionDescription;

#[tokio::test]
async fn interop_ice_dtls_handshake() -> Result<()> {
    rustls::crypto::CryptoProvider::install_default(rustls::crypto::ring::default_provider()).ok();
    let _ = env_logger::builder().is_test(true).try_init();

    // 1. Create RustRTC PeerConnection (Offerer)
    let rust_config = RtcConfiguration::default();
    let rust_pc = PeerConnection::new(rust_config);

    // Add a transceiver to trigger ICE gathering
    rust_pc.add_transceiver(MediaKind::Audio, TransceiverDirection::SendRecv);

    // 2. Create WebRTC PeerConnection (Answerer)
    let mut m = MediaEngine::default();
    m.register_default_codecs()?;
    let mut registry = Registry::new();
    registry = register_default_interceptors(registry, &mut m)?;
    let api = APIBuilder::new()
        .with_media_engine(m)
        .with_interceptor_registry(registry)
        .build();

    let webrtc_config = WebrtcConfiguration::default();
    let webrtc_pc = api.new_peer_connection(webrtc_config).await?;

    // 3. RustRTC creates Offer
    // Trigger gathering
    let _ = rust_pc.create_offer().await?;

    // Wait for gathering to complete
    rust_pc.wait_for_gathering_complete().await;

    let offer = rust_pc.create_offer().await?;
    println!("RustRTC Offer SDP:\n{}", offer.to_sdp_string());
    rust_pc.set_local_description(offer.clone())?;

    // Convert RustRTC SDP to WebRTC SDP
    let offer_sdp = offer.to_sdp_string();
    let webrtc_desc = RTCSessionDescription::offer(offer_sdp)?;

    // 4. WebRTC sets Remote Description
    webrtc_pc.set_remote_description(webrtc_desc).await?;

    // 5. WebRTC creates Answer
    let answer = webrtc_pc.create_answer(None).await?;
    let mut gather_complete = webrtc_pc.gathering_complete_promise().await;
    webrtc_pc.set_local_description(answer.clone()).await?;
    let _ = gather_complete.recv().await;

    let answer = webrtc_pc.local_description().await.unwrap();
    println!("WebRTC Answer SDP:\n{}", answer.sdp);

    // Convert WebRTC SDP to RustRTC SDP
    // We need to parse the SDP string into rustrtc_core::SessionDescription
    let answer_sdp = answer.sdp;
    let rust_answer = rustrtc::SessionDescription::parse(rustrtc::SdpType::Answer, &answer_sdp)?;

    // 6. RustRTC sets Remote Description
    rust_pc.set_remote_description(rust_answer).await?;

    // 7. Wait for connection
    rust_pc.wait_for_connected().await?;

    let (done_tx, mut done_rx) = tokio::sync::mpsc::channel::<()>(1);
    let done_tx = Arc::new(done_tx);

    let done_tx_clone = done_tx.clone();
    webrtc_pc.on_peer_connection_state_change(Box::new(move |s: RTCPeerConnectionState| {
        if s == RTCPeerConnectionState::Connected {
            let _ = done_tx_clone.try_send(());
        }
        Box::pin(async {})
    }));

    if webrtc_pc.connection_state() == RTCPeerConnectionState::Connected {
        let _ = done_tx.try_send(());
    }

    timeout(Duration::from_secs(10), done_rx.recv())
        .await?
        .ok_or_else(|| anyhow::anyhow!("Connection timed out"))?;

    // Cleanup
    rust_pc.close();
    webrtc_pc.close().await?;

    Ok(())
}

#[tokio::test]
async fn interop_vp8_echo() -> Result<()> {
    use rustrtc::media::track::MediaStreamTrack;
    use webrtc::track::track_local::TrackLocalWriter;

    let _ = env_logger::builder().is_test(true).try_init();

    // 1. Create RustRTC PeerConnection (Offerer)
    let rust_config = RtcConfiguration::default();
    let rust_pc = PeerConnection::new(rust_config);

    // Add a transceiver for Video
    let transceiver = rust_pc.add_transceiver(MediaKind::Video, TransceiverDirection::SendRecv);

    // Create a sample track to send data
    let (source, track, _) = rustrtc::media::sample_track(rustrtc::media::MediaKind::Video, 10);
    let params = rustrtc::RtpCodecParameters {
        payload_type: 96,
        clock_rate: 90000,
        channels: 0,
    };
    let sender = rustrtc::peer_connection::RtpSender::builder(track, 12345)
        .stream_id("stream".to_string())
        .params(params)
        .build();
    transceiver.set_sender(Some(sender));

    // 2. Create WebRTC PeerConnection (Answerer)
    let mut m = MediaEngine::default();
    m.register_default_codecs()?;
    let mut registry = Registry::new();
    registry = register_default_interceptors(registry, &mut m)?;
    let api = APIBuilder::new()
        .with_media_engine(m)
        .with_interceptor_registry(registry)
        .build();

    let webrtc_config = WebrtcConfiguration::default();
    let webrtc_pc = api.new_peer_connection(webrtc_config).await?;

    // Setup Echo on WebRTC side
    // Create a TrackLocalStaticRTP to send back data
    let codec = webrtc::rtp_transceiver::rtp_codec::RTCRtpCodecCapability {
        mime_type: webrtc::api::media_engine::MIME_TYPE_VP8.to_owned(),
        clock_rate: 90000,
        channels: 0,
        ..Default::default()
    };
    let video_track = Arc::new(
        webrtc::track::track_local::track_local_static_rtp::TrackLocalStaticRTP::new(
            codec,
            "video_echo".to_string(),
            "webrtc_stream".to_string(),
        ),
    );

    let _rtp_sender = webrtc_pc.add_track(video_track.clone()).await?;

    // Handle incoming track on WebRTC
    let video_track_clone = video_track.clone();
    webrtc_pc.on_track(Box::new(
        move |track: Arc<webrtc::track::track_remote::TrackRemote>,
              _receiver: Arc<webrtc::rtp_transceiver::rtp_receiver::RTCRtpReceiver>,
              _transceiver: Arc<webrtc::rtp_transceiver::RTCRtpTransceiver>| {
            if track.codec().capability.mime_type == webrtc::api::media_engine::MIME_TYPE_VP8 {
                let video_track = video_track_clone.clone();
                tokio::spawn(async move {
                    loop {
                        match track.read_rtp().await {
                            Ok((packet, _)) => {
                                if let Err(_) = video_track.write_rtp(&packet).await {
                                    break;
                                }
                            }
                            Err(_) => break,
                        }
                    }
                });
            }
            Box::pin(async {})
        },
    ));

    // 3. RustRTC creates Offer
    // Trigger gathering
    let _ = rust_pc.create_offer().await?;

    // Wait for gathering to complete
    rust_pc.wait_for_gathering_complete().await;

    let offer = rust_pc.create_offer().await?;
    rust_pc.set_local_description(offer.clone())?;

    // Convert RustRTC SDP to WebRTC SDP
    let offer_sdp = offer.to_sdp_string();
    let webrtc_desc = RTCSessionDescription::offer(offer_sdp)?;

    // 4. WebRTC sets Remote Description
    webrtc_pc.set_remote_description(webrtc_desc).await?;

    // 5. WebRTC creates Answer
    let answer = webrtc_pc.create_answer(None).await?;
    let mut gather_complete = webrtc_pc.gathering_complete_promise().await;
    webrtc_pc.set_local_description(answer.clone()).await?;
    let _ = gather_complete.recv().await;

    let answer = webrtc_pc.local_description().await.unwrap();

    // Convert WebRTC SDP to RustRTC SDP
    let answer_sdp = answer.sdp;
    let rust_answer = rustrtc::SessionDescription::parse(rustrtc::SdpType::Answer, &answer_sdp)?;

    // 6. RustRTC sets Remote Description
    rust_pc.set_remote_description(rust_answer).await?;

    // Wait for connection
    rust_pc.wait_for_connected().await?;

    // 7. Start sending data from RustRTC
    let source_clone = source.clone();
    tokio::spawn(async move {
        for i in 0..20 {
            let mut data = bytes::BytesMut::with_capacity(4);
            data.extend_from_slice(&u32::to_be_bytes(i));
            let frame = rustrtc::media::VideoFrame {
                rtp_timestamp: i as u32 * 3000,
                data: data.freeze(),
                is_last_packet: true,
                payload_type: None,
                ..Default::default()
            };
            if let Err(_) = source_clone.send_video(frame).await {
                break;
            }
            tokio::time::sleep(Duration::from_millis(33)).await;
        }
    });

    // 8. Verify Echo on RustRTC
    let receiver = transceiver.receiver().unwrap();
    let track = receiver.track();

    let mut received_count = 0;
    let mut received_indices = std::collections::HashSet::new();
    let timeout_duration = Duration::from_secs(10);

    let receive_task = async {
        loop {
            match track.recv().await {
                Ok(sample) => {
                    if let rustrtc::media::MediaSample::Video(frame) = sample {
                        if frame.data.len() == 4 {
                            let mut buf = [0u8; 4];
                            buf.copy_from_slice(&frame.data);
                            let index = u32::from_be_bytes(buf);
                            received_indices.insert(index);
                            received_count += 1;
                        }

                        if received_count >= 10 {
                            break;
                        }
                    }
                }
                Err(_) => break,
            }
        }
        Ok::<(), anyhow::Error>(())
    };

    timeout(timeout_duration, receive_task).await??;

    // Verify we received valid indices
    assert!(received_indices.iter().all(|&i| i < 20));
    assert!(received_indices.len() >= 10);

    // Cleanup
    rust_pc.close();
    webrtc_pc.close().await?;

    Ok(())
}

#[tokio::test]
async fn interop_vp8_echo_with_pli() -> Result<()> {
    use rustrtc::media::track::MediaStreamTrack;
    use webrtc::rtcp::payload_feedbacks::picture_loss_indication::PictureLossIndication;
    use webrtc::track::track_local::TrackLocalWriter;

    let _ = env_logger::builder().is_test(true).try_init();

    // 1. Create RustRTC PeerConnection (Offerer)
    let rust_config = RtcConfiguration::default();
    let rust_pc = PeerConnection::new(rust_config);

    // Add a transceiver for Video
    let transceiver = rust_pc.add_transceiver(MediaKind::Video, TransceiverDirection::SendRecv);

    // Create a sample track to send data
    let (source, track, _) = rustrtc::media::sample_track(rustrtc::media::MediaKind::Video, 10);
    let params = rustrtc::RtpCodecParameters {
        payload_type: 96,
        clock_rate: 90000,
        channels: 0,
    };
    let sender = rustrtc::peer_connection::RtpSender::builder(track, 12345)
        .stream_id("stream".to_string())
        .params(params)
        .build();
    transceiver.set_sender(Some(sender));

    // 2. Create WebRTC PeerConnection (Answerer)
    let mut m = MediaEngine::default();
    m.register_default_codecs()?;
    let mut registry = Registry::new();
    registry = register_default_interceptors(registry, &mut m)?;
    let api = APIBuilder::new()
        .with_media_engine(m)
        .with_interceptor_registry(registry)
        .build();

    let webrtc_config = WebrtcConfiguration::default();
    let webrtc_pc = Arc::new(api.new_peer_connection(webrtc_config).await?);

    // Setup Echo on WebRTC side
    let codec = webrtc::rtp_transceiver::rtp_codec::RTCRtpCodecCapability {
        mime_type: webrtc::api::media_engine::MIME_TYPE_VP8.to_owned(),
        clock_rate: 90000,
        channels: 0,
        ..Default::default()
    };
    let video_track = Arc::new(
        webrtc::track::track_local::track_local_static_rtp::TrackLocalStaticRTP::new(
            codec,
            "video_echo".to_string(),
            "webrtc_stream".to_string(),
        ),
    );

    let _rtp_sender = webrtc_pc.add_track(video_track.clone()).await?;

    // Handle incoming track on WebRTC
    let video_track_clone = video_track.clone();
    let webrtc_pc_clone = webrtc_pc.clone();
    webrtc_pc.on_track(Box::new(
        move |track: Arc<webrtc::track::track_remote::TrackRemote>,
              _receiver: Arc<webrtc::rtp_transceiver::rtp_receiver::RTCRtpReceiver>,
              _transceiver: Arc<webrtc::rtp_transceiver::RTCRtpTransceiver>| {
            if track.codec().capability.mime_type == webrtc::api::media_engine::MIME_TYPE_VP8 {
                let video_track = video_track_clone.clone();
                let pc = webrtc_pc_clone.clone();
                tokio::spawn(async move {
                    let mut packet_count = 0;
                    loop {
                        match track.read_rtp().await {
                            Ok((packet, _)) => {
                                packet_count += 1;
                                if let Err(_) = video_track.write_rtp(&packet).await {
                                    break;
                                }

                                // Send PLI after 5 packets
                                if packet_count == 5 {
                                    println!("Sending PLI from WebRTC");
                                    let pli = PictureLossIndication {
                                        sender_ssrc: 0,
                                        media_ssrc: track.ssrc(),
                                    };
                                    if let Err(e) = pc.write_rtcp(&[Box::new(pli)]).await {
                                        println!("Failed to send PLI: {}", e);
                                    }
                                }
                            }
                            Err(_) => break,
                        }
                    }
                });
            }
            Box::pin(async {})
        },
    ));

    // 3. RustRTC creates Offer
    // Trigger gathering
    let _ = rust_pc.create_offer().await?;

    // Wait for gathering to complete
    rust_pc.wait_for_gathering_complete().await;

    let offer = rust_pc.create_offer().await?;
    rust_pc.set_local_description(offer.clone())?;

    // Convert RustRTC SDP to WebRTC SDP
    let offer_sdp = offer.to_sdp_string();
    let webrtc_desc = RTCSessionDescription::offer(offer_sdp)?;

    // 4. WebRTC sets Remote Description
    webrtc_pc.set_remote_description(webrtc_desc).await?;

    // 5. WebRTC creates Answer
    let answer = webrtc_pc.create_answer(None).await?;
    let mut gather_complete = webrtc_pc.gathering_complete_promise().await;
    webrtc_pc.set_local_description(answer.clone()).await?;
    let _ = gather_complete.recv().await;

    let answer = webrtc_pc.local_description().await.unwrap();

    // Convert WebRTC SDP to RustRTC SDP
    let answer_sdp = answer.sdp;
    let rust_answer = rustrtc::SessionDescription::parse(rustrtc::SdpType::Answer, &answer_sdp)?;

    // 6. RustRTC sets Remote Description
    rust_pc.set_remote_description(rust_answer).await?;

    // Wait for connection
    rust_pc.wait_for_connected().await?;

    // 7. Start sending data from RustRTC
    let source_clone = source.clone();
    tokio::spawn(async move {
        for i in 0..50 {
            let mut data = bytes::BytesMut::with_capacity(4);
            data.extend_from_slice(&u32::to_be_bytes(i));
            let frame = rustrtc::media::VideoFrame {
                rtp_timestamp: i as u32 * 3000,
                data: data.freeze(),
                is_last_packet: true,
                payload_type: None,
                ..Default::default()
            };
            if let Err(_) = source_clone.send_video(frame).await {
                break;
            }
            tokio::time::sleep(Duration::from_millis(33)).await;
        }
    });

    // 8. Verify Echo on RustRTC
    let receiver = transceiver.receiver().unwrap();
    let track = receiver.track();

    let mut received_count = 0;
    let timeout_duration = Duration::from_secs(10);

    let receive_task = async {
        loop {
            match track.recv().await {
                Ok(sample) => {
                    if let rustrtc::media::MediaSample::Video(_frame) = sample {
                        received_count += 1;
                        if received_count >= 20 {
                            break;
                        }
                    }
                }
                Err(_) => break,
            }
        }
        Ok::<(), anyhow::Error>(())
    };

    timeout(timeout_duration, receive_task).await??;

    // Cleanup
    rust_pc.close();
    webrtc_pc.close().await?;

    Ok(())
}

#[tokio::test]
async fn interop_ice_close_triggers_pc_close() -> Result<()> {
    let _ = env_logger::builder().is_test(true).try_init();

    // 1. Create RustRTC PeerConnection (Offerer)
    let rust_config = RtcConfiguration::default();
    let rust_pc = PeerConnection::new(rust_config);

    // Add a transceiver to trigger ICE gathering
    rust_pc.add_transceiver(MediaKind::Audio, TransceiverDirection::SendRecv);

    // 2. Create WebRTC PeerConnection (Answerer)
    let mut m = MediaEngine::default();
    m.register_default_codecs()?;
    let mut registry = Registry::new();
    registry = register_default_interceptors(registry, &mut m)?;
    let api = APIBuilder::new()
        .with_media_engine(m)
        .with_interceptor_registry(registry)
        .build();

    let webrtc_config = WebrtcConfiguration::default();
    let webrtc_pc = api.new_peer_connection(webrtc_config).await?;

    // 3. RustRTC creates Offer
    let _ = rust_pc.create_offer().await?;

    // Wait for gathering to complete
    rust_pc.wait_for_gathering_complete().await;

    let offer = rust_pc.create_offer().await?;
    rust_pc.set_local_description(offer.clone())?;

    let offer_sdp = offer.to_sdp_string();
    let webrtc_desc = RTCSessionDescription::offer(offer_sdp)?;

    // 4. WebRTC sets Remote Description
    webrtc_pc.set_remote_description(webrtc_desc).await?;

    // 5. WebRTC creates Answer
    let answer = webrtc_pc.create_answer(None).await?;
    let mut gather_complete = webrtc_pc.gathering_complete_promise().await;
    webrtc_pc.set_local_description(answer.clone()).await?;
    let _ = gather_complete.recv().await;

    let answer = webrtc_pc.local_description().await.unwrap();
    let answer_sdp = answer.sdp;
    let rust_answer = rustrtc::SessionDescription::parse(rustrtc::SdpType::Answer, &answer_sdp)?;

    // 6. RustRTC sets Remote Description
    rust_pc.set_remote_description(rust_answer).await?;

    // 7. Wait for connection
    rust_pc.wait_for_connected().await?;

    // 8. Close WebRTC side
    webrtc_pc.close().await?;

    // 9. Verify RustRTC detects close
    let mut state_rx = rust_pc.subscribe_peer_state();
    let timeout_duration = Duration::from_secs(10);

    let check_close = async {
        loop {
            let state = *state_rx.borrow_and_update();
            if state == rustrtc::PeerConnectionState::Closed
                || state == rustrtc::PeerConnectionState::Failed
                || state == rustrtc::PeerConnectionState::Disconnected
            {
                return Ok(());
            }
            if state_rx.changed().await.is_err() {
                return Err(anyhow::anyhow!("State channel closed"));
            }
        }
    };

    timeout(timeout_duration, check_close).await??;

    Ok(())
}