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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
use crate::data_channel::RTCDataChannelId;
use crate::data_channel::message::RTCDataChannelMessage;
use crate::peer_connection::event::RTCEventInternal;
use crate::peer_connection::event::RTCPeerConnectionEvent;
use crate::peer_connection::event::data_channel_event::RTCDataChannelEvent;
use crate::peer_connection::message::internal::{
ApplicationMessage, DTLSMessage, DataChannelEvent, RTCMessageInternal, RTPMessage,
TaggedRTCMessageInternal, TrackPacket,
};
use crate::media_stream::track::MediaStreamTrackId;
use crate::peer_connection::configuration::media_engine::{MIME_TYPE_RTX, MediaEngine};
use crate::peer_connection::event::track_event::{RTCTrackEvent, RTCTrackEventInit};
use crate::rtp_transceiver::rtp_receiver::internal::RTCRtpReceiverInternal;
use crate::rtp_transceiver::rtp_sender::rtp_codec::{
find_fec_payload_type, find_rtx_payload_type, parse_rtx_apt,
};
use crate::rtp_transceiver::rtp_sender::{
RTCRtpCodecParameters, RTCRtpCodingParameters, RTCRtpHeaderExtensionCapability,
};
use crate::rtp_transceiver::{
PayloadType, RTCRtpReceiverId, SSRC, internal::RTCRtpTransceiverInternal,
};
use crate::statistics::accumulator::RTCStatsAccumulator;
use interceptor::{Interceptor, Packet};
use log::{debug, trace, warn};
use shared::TransportContext;
use shared::error::{Error, Result};
use shared::marshal::MarshalSize;
use std::collections::VecDeque;
use std::time::Instant;
#[derive(Default)]
pub(crate) struct EndpointHandlerContext {
pub(crate) read_outs: VecDeque<TaggedRTCMessageInternal>,
pub(crate) write_outs: VecDeque<TaggedRTCMessageInternal>,
pub(crate) event_outs: VecDeque<RTCEventInternal>,
}
/// EndpointHandler implements DataChannel/Media Endpoint handling
/// The transmits queue is now stored in RTCPeerConnection and passed by reference
pub(crate) struct EndpointHandler<'a, I>
where
I: Interceptor,
{
ctx: &'a mut EndpointHandlerContext,
rtp_transceivers: &'a mut Vec<RTCRtpTransceiverInternal<I>>,
media_engine: &'a MediaEngine,
interceptor: &'a mut I,
stats: &'a mut RTCStatsAccumulator,
}
impl<'a, I> EndpointHandler<'a, I>
where
I: Interceptor,
{
pub(crate) fn new(
ctx: &'a mut EndpointHandlerContext,
rtp_transceivers: &'a mut Vec<RTCRtpTransceiverInternal<I>>,
media_engine: &'a MediaEngine,
interceptor: &'a mut I,
stats: &'a mut RTCStatsAccumulator,
) -> Self {
EndpointHandler {
ctx,
rtp_transceivers,
media_engine,
interceptor,
stats,
}
}
pub(crate) fn name(&self) -> &'static str {
"EndpointHandler"
}
}
// Implement Protocol trait for message processing
impl<'a, I> sansio::Protocol<TaggedRTCMessageInternal, TaggedRTCMessageInternal, RTCEventInternal>
for EndpointHandler<'a, I>
where
I: Interceptor,
{
type Rout = TaggedRTCMessageInternal;
type Wout = TaggedRTCMessageInternal;
type Eout = RTCEventInternal;
type Error = Error;
type Time = Instant;
fn handle_read(&mut self, msg: TaggedRTCMessageInternal) -> Result<()> {
match msg.message {
RTCMessageInternal::Dtls(DTLSMessage::DataChannel(message)) => {
self.handle_dtls_message(msg.now, msg.transport, message)
}
RTCMessageInternal::Rtp(RTPMessage::Packet(Packet::Rtp(message))) => {
self.handle_rtp_message(msg.now, msg.transport, message)
}
RTCMessageInternal::Rtp(RTPMessage::Packet(Packet::Rtcp(message))) => {
self.handle_rtcp_message(msg.now, msg.transport, message)
}
_ => {
warn!("drop unsupported message from {}", msg.transport.peer_addr);
Ok(())
}
}
}
fn poll_read(&mut self) -> Option<Self::Rout> {
self.ctx.read_outs.pop_front()
}
fn handle_write(&mut self, msg: TaggedRTCMessageInternal) -> Result<()> {
self.ctx.write_outs.push_back(msg);
Ok(())
}
fn poll_write(&mut self) -> Option<Self::Wout> {
self.ctx.write_outs.pop_front()
}
fn handle_event(&mut self, evt: RTCEventInternal) -> Result<()> {
self.ctx.event_outs.push_back(evt);
Ok(())
}
fn poll_event(&mut self) -> Option<Self::Eout> {
self.ctx.event_outs.pop_front()
}
fn handle_timeout(&mut self, _now: Instant) -> Result<()> {
Ok(())
}
fn poll_timeout(&mut self) -> Option<Instant> {
None
}
fn close(&mut self) -> Result<()> {
Ok(())
}
}
impl<'a, I> EndpointHandler<'a, I>
where
I: Interceptor,
{
fn handle_dtls_message(
&mut self,
now: Instant,
transport_context: TransportContext,
message: ApplicationMessage,
) -> Result<()> {
match message.data_channel_event {
DataChannelEvent::Open => {
self.handle_datachannel_open(now, transport_context, message.data_channel_id)
}
DataChannelEvent::Message(data_channel_message) => self.handle_datachannel_message(
now,
transport_context,
message.data_channel_id,
data_channel_message,
),
DataChannelEvent::Close => {
self.handle_datachannel_close(now, transport_context, message.data_channel_id)
}
}
}
fn handle_rtp_message(
&mut self,
now: Instant,
transport_context: TransportContext,
mut rtp_packet: rtp::Packet,
) -> Result<()> {
debug!("handle_rtp_message {}", transport_context.peer_addr);
// RFC 4588: if this packet belongs to a retransmission (RTX) stream,
// de-encapsulate it back into its primary stream before dispatching.
// The RTX payload is `[OSN (2 bytes)][original RTP payload]`; the
// recovered packet carries the primary SSRC, the original payload type
// (resolved via the RTX codec's `apt=`) and the original sequence number
// (OSN), while keeping the timestamp/marker/extensions "as is". RTX
// receive statistics are tracked upstream in the interceptor handler
// (using the RTX SSRC), so they are not touched here.
if let Some((primary_ssrc, primary_payload_type)) =
self.rtx_primary_for(rtp_packet.header.ssrc, rtp_packet.header.payload_type)
{
let recovered = deencapsulate_rtx(&mut rtp_packet, primary_ssrc, primary_payload_type);
if !recovered {
// RTX packet with no OSN header (e.g. a padding-only bandwidth-probe
// packet, RFC 4588 §4): nothing to recover.
trace!(
"drop rtx packet ssrc = {} without OSN payload",
rtp_packet.header.ssrc
);
return Ok(());
}
}
let ssrc = rtp_packet.header.ssrc;
if let Some(track_id) = self.find_track_id(ssrc, Some(&rtp_packet.header)) {
// Track RTP stats if accumulator exists (created when OnOpen event is fired)
if let Some(stream) = self.stats.inbound_rtp_streams.get_mut(&ssrc) {
stream.on_rtp_received(
rtp_packet.header.marshal_size(),
rtp_packet.payload.len(),
now,
);
}
self.ctx.read_outs.push_back(TaggedRTCMessageInternal {
now,
transport: transport_context,
message: RTCMessageInternal::Rtp(RTPMessage::TrackPacket(TrackPacket {
track_id,
packet: Packet::Rtp(rtp_packet),
})),
});
} else {
debug!("drop rtp packet ssrc = {}", ssrc);
}
Ok(())
}
fn handle_rtcp_message(
&mut self,
now: Instant,
transport_context: TransportContext,
rtcp_packets: Vec<Box<dyn rtcp::Packet>>,
) -> Result<()> {
debug!("handle_rtcp_message {}", transport_context.peer_addr);
let rtcp_ssrc = if let Some(rtcp_packet) = rtcp_packets.first() {
rtcp_packet.destination_ssrc().first().cloned()
} else {
None
};
if let Some(rtcp_ssrc) = rtcp_ssrc {
if let Some(track_id) = self.find_track_id(rtcp_ssrc, None) {
self.ctx.read_outs.push_back(TaggedRTCMessageInternal {
now,
transport: transport_context,
message: RTCMessageInternal::Rtp(RTPMessage::TrackPacket(TrackPacket {
track_id,
packet: Packet::Rtcp(rtcp_packets),
})),
});
} else {
debug!("drop rtcp packet ssrc = {}", rtcp_ssrc);
}
} else {
debug!("drop rtcp packet due to empty ssrc");
}
Ok(())
}
fn handle_datachannel_open(
&mut self,
_now: Instant,
transport_context: TransportContext,
data_channel_id: RTCDataChannelId,
) -> Result<()> {
debug!("data channel is open for {:?}", transport_context);
self.ctx
.event_outs
.push_back(RTCEventInternal::RTCPeerConnectionEvent(
RTCPeerConnectionEvent::OnDataChannel(RTCDataChannelEvent::OnOpen(data_channel_id)),
));
Ok(())
}
fn handle_datachannel_close(
&mut self,
_now: Instant,
transport_context: TransportContext,
data_channel_id: RTCDataChannelId,
) -> Result<()> {
debug!("data channel is close for {:?}", transport_context);
self.ctx
.event_outs
.push_back(RTCEventInternal::RTCPeerConnectionEvent(
RTCPeerConnectionEvent::OnDataChannel(RTCDataChannelEvent::OnClose(
data_channel_id,
)),
));
Ok(())
}
fn handle_datachannel_message(
&mut self,
now: Instant,
transport_context: TransportContext,
data_channel_id: RTCDataChannelId,
data_channel_message: RTCDataChannelMessage,
) -> Result<()> {
debug!("data channel recv message for {:?}", transport_context);
self.ctx.read_outs.push_back(TaggedRTCMessageInternal {
now,
transport: transport_context,
message: RTCMessageInternal::Dtls(DTLSMessage::DataChannel(ApplicationMessage {
data_channel_id,
data_channel_event: DataChannelEvent::Message(data_channel_message),
})),
});
Ok(())
}
/// RFC 4588: resolves a retransmission (RTX) SSRC to the primary stream it repairs.
///
/// Returns `(primary_ssrc, primary_payload_type)` when `rtx_ssrc` matches the
/// RTX SSRC of one of this endpoint's receive codings (declared via
/// `a=ssrc-group:FID <primary> <rtx>` in the remote SDP, RFC 5576). The
/// original payload type is resolved from the negotiated RTX codec's `apt=`
/// parameter, looked up by the packet's RTX `payload_type`. Returns `None`
/// (leaving the packet to be handled as a regular RTP packet) when the SSRC
/// is not a known RTX SSRC or the `apt` mapping cannot be resolved.
fn rtx_primary_for(
&self,
rtx_ssrc: SSRC,
rtx_payload_type: PayloadType,
) -> Option<(SSRC, PayloadType)> {
self.rtp_transceivers.iter().find_map(|transceiver| {
let receiver = transceiver.receiver().as_ref()?;
resolve_rtx_primary(
receiver.get_coding_parameters(),
receiver.get_codec_preferences(),
rtx_ssrc,
rtx_payload_type,
)
})
}
// crosscheck with RTCPeerConnection::start_rtp, since remote tracks(RTCRtpCodingParameters) are added in it
fn find_track_id(
&mut self,
ssrc: SSRC,
rtp_header: Option<&rtp::Header>,
) -> Option<MediaStreamTrackId> {
if let Some(track_id) = self.find_track_id_by_ssrc(ssrc, rtp_header) {
Some(track_id)
} else if let Some(rtp_header) = rtp_header // rid search only for RTP packet
&& let Some(track_id) = self.find_track_id_by_rid(ssrc, rtp_header)
{
Some(track_id)
} else {
None
}
}
fn find_track_id_by_ssrc(
&mut self,
ssrc: SSRC,
rtp_header: Option<&rtp::Header>,
) -> Option<MediaStreamTrackId> {
if let Some((id, transceiver)) =
self.rtp_transceivers
.iter_mut()
.enumerate()
.find(|(_, transceiver)| {
if let Some(receiver) = transceiver.receiver() {
receiver.get_coding_parameters().iter().any(|coding| {
coding.ssrc.is_some_and(|coding_ssrc| coding_ssrc == ssrc)
})
} else {
false
}
})
{
// Get kind and mid before borrowing receiver mutably
let kind = transceiver.kind();
let mid = transceiver.mid().clone().unwrap_or_default();
if let Some(receiver) = transceiver.receiver_mut()
&& receiver
.track()
.ssrcs()
.any(|track_ssrc| track_ssrc == ssrc)
{
let (is_track_codec_empty, track_id) = (
receiver
.track()
.get_codec_by_ssrc(ssrc)
.is_some_and(|codec| codec.mime_type.is_empty()),
receiver.track().track_id().clone(),
);
let track_codec = if is_track_codec_empty
&& let Some(rtp_header) = rtp_header
&& let Some(codec) = receiver
.get_codec_preferences()
.iter()
.find(|codec| codec.payload_type == rtp_header.payload_type)
// RTX packets are de-encapsulated into their primary stream in
// handle_rtp_message before reaching here, so payload_type is the
// primary codec's. FEC de-encapsulation is still TODO (see #12).
{
Some((codec.rtp_codec.clone(), rtp_header.payload_type))
} else {
None
};
if let Some((codec, payload_type)) = track_codec {
// Resolved before the bind rather than after it: the repair flows are bound
// alongside the primary below, and the stats accumulator wants the same pair.
let (rtx_ssrc, fec_ssrc) = receiver
.get_coding_parameters()
.iter()
.find(|c| c.ssrc == Some(ssrc))
.map(|c| {
(
c.rtx.as_ref().map(|r| r.ssrc),
c.fec.as_ref().map(|f| f.ssrc),
)
})
.unwrap_or((None, None));
let parameters = receiver.get_parameters(self.media_engine);
RTCRtpReceiverInternal::interceptor_remote_stream_op(
self.interceptor,
true,
ssrc,
payload_type,
&codec,
¶meters.rtp_parameters.header_extensions,
);
// Each repair flow in its own right, exactly as `interceptor_remote_streams_op`
// binds them: a real RTP stream with its own SSRC and sequence-number space,
// which an interceptor tracking arrivals has to know about. It also keeps the
// pair balanced — `stop` unbinds all three, so binding only the primary would
// leave the repair flows unbound having never been bound.
if let Some(ssrc_rtx) = rtx_ssrc {
RTCRtpReceiverInternal::interceptor_remote_stream_op(
self.interceptor,
true,
ssrc_rtx,
find_rtx_payload_type(payload_type, ¶meters.rtp_parameters.codecs)
.unwrap_or_default(),
&codec,
¶meters.rtp_parameters.header_extensions,
);
}
if let Some(ssrc_fec) = fec_ssrc {
RTCRtpReceiverInternal::interceptor_remote_stream_op(
self.interceptor,
true,
ssrc_fec,
find_fec_payload_type(¶meters.rtp_parameters.codecs)
.unwrap_or_default(),
&codec,
¶meters.rtp_parameters.header_extensions,
);
}
// Set valid Codec for track when received the first RTP packet for such ssrc stream
// assert not inserting new entry
let new_entry = receiver.track_mut().set_codec_by_ssrc(codec, ssrc);
assert!(!new_entry);
// Create inbound stream accumulator before firing OnOpen event
self.stats.get_or_create_inbound_rtp_streams(
ssrc, kind, &track_id, &mid, rtx_ssrc, fec_ssrc, id,
);
// Fire RTCTrackEvent::OnOpen event when received the first RTP packet for such ssrc stream
self.ctx
.event_outs
.push_back(RTCEventInternal::RTCPeerConnectionEvent(
RTCPeerConnectionEvent::OnTrack(RTCTrackEvent::OnOpen(
RTCTrackEventInit {
receiver_id: RTCRtpReceiverId(id),
track_id: receiver.track().track_id().to_owned(),
stream_ids: vec![receiver.track().stream_id().to_owned()],
ssrc,
rid: None,
},
)),
));
}
return Some(track_id);
}
}
// No receiver owns this ssrc. For inbound RTCP (no rtp_header) it may be feedback
// (PLI/FIR/RR) about one of our *senders* — e.g. a subscriber's keyframe request for
// a forwarded stream. Surface it tagged with the sender's track id so the
// application (an SFU) can relay the feedback upstream to the publisher. RTP media
// is never inbound on a sender, so this branch is RTCP-only.
if rtp_header.is_none()
&& let Some(track_id) = self.rtp_transceivers.iter().find_map(|transceiver| {
transceiver.sender().as_ref().and_then(|sender| {
let track = sender.track();
track
.ssrcs()
.any(|track_ssrc| track_ssrc == ssrc)
.then(|| track.track_id().clone())
})
})
{
return Some(track_id);
}
trace!(
"no track id for {:?} for {}",
ssrc,
if rtp_header.is_some() {
"RTP packet, let's try search rid"
} else {
"RTCP packet"
}
);
None
}
fn find_track_id_by_rid(
&mut self,
ssrc: SSRC,
rtp_header: &rtp::Header,
) -> Option<MediaStreamTrackId> {
// If the remote SDP was only one media section the ssrc doesn't have to be explicitly declared
let track_id = self.handle_undeclared_ssrc(rtp_header);
if track_id.is_some() {
return track_id;
}
let (mid, rid, rrid) =
if let Some((mid, rid, rrid)) = self.get_rtp_header_extension_ids(rtp_header) {
if mid.is_empty() || (rid.is_empty() && rrid.is_empty()) {
return None;
}
(mid, rid, rrid)
} else {
return None;
};
// If rtp header extension has valid mid, find receiver based on mid, instead of rid,
// since rid is not unique across m= lines
if let Some((id, transceiver)) =
self.rtp_transceivers
.iter_mut()
.enumerate()
.find(|(_, transceiver)| {
transceiver
.mid()
.as_deref()
.is_some_and(|t_mid| t_mid == mid)
})
{
// Get kind before borrowing receiver mutably
let kind = transceiver.kind();
if let Some(receiver) = transceiver.receiver_mut()
&& let Some(codec) = receiver
.get_codec_preferences()
.iter()
.find(|codec| codec.payload_type == rtp_header.payload_type) //TODO: what about RTX/FEC stream?
.cloned()
{
if !rrid.is_empty() {
//TODO: Add support of handling repair rtp stream id (rrid) #12
} else {
if let Some(coding) = receiver.get_coding_parameter_mut_by_rid(rid.as_str()) {
coding.ssrc = Some(ssrc);
}
// Resolved before the bind: each simulcast layer has its own repair flow, so
// the pair has to be the one belonging to *this* coding — the `ssrc` assigned
// just above.
let (rtx_ssrc, fec_ssrc) = receiver
.get_coding_parameters()
.iter()
.find(|c| c.ssrc == Some(ssrc))
.map(|c| {
(
c.rtx.as_ref().map(|r| r.ssrc),
c.fec.as_ref().map(|f| f.ssrc),
)
})
.unwrap_or((None, None));
let parameters = receiver.get_parameters(self.media_engine);
RTCRtpReceiverInternal::interceptor_remote_stream_op(
self.interceptor,
true,
rtp_header.ssrc,
codec.payload_type,
&codec.rtp_codec,
¶meters.rtp_parameters.header_extensions,
);
// And each repair flow in its own right. Simulcast is where this matters most:
// every layer has its own retransmission flow, and NACK-driven repair is what
// keeps the upper layers usable.
if let Some(ssrc_rtx) = rtx_ssrc {
RTCRtpReceiverInternal::interceptor_remote_stream_op(
self.interceptor,
true,
ssrc_rtx,
find_rtx_payload_type(
codec.payload_type,
¶meters.rtp_parameters.codecs,
)
.unwrap_or_default(),
&codec.rtp_codec,
¶meters.rtp_parameters.header_extensions,
);
}
if let Some(ssrc_fec) = fec_ssrc {
RTCRtpReceiverInternal::interceptor_remote_stream_op(
self.interceptor,
true,
ssrc_fec,
find_fec_payload_type(¶meters.rtp_parameters.codecs)
.unwrap_or_default(),
&codec.rtp_codec,
¶meters.rtp_parameters.header_extensions,
);
}
let new_entry =
receiver
.track_mut()
.set_codec_ssrc_by_rid(codec.rtp_codec, ssrc, &rid);
assert!(!new_entry);
let track_id = receiver.track().track_id().to_owned();
// Create inbound stream accumulator before firing OnOpen event
self.stats.get_or_create_inbound_rtp_streams(
ssrc, kind, &track_id, &mid, rtx_ssrc, fec_ssrc, id,
);
// Fire RTCTrackEvent::OnOpen event when received the first RTP packet for such ssrc stream
self.ctx
.event_outs
.push_back(RTCEventInternal::RTCPeerConnectionEvent(
RTCPeerConnectionEvent::OnTrack(RTCTrackEvent::OnOpen(
RTCTrackEventInit {
receiver_id: RTCRtpReceiverId(id),
track_id: track_id.clone(),
stream_ids: vec![receiver.track().stream_id().to_owned()],
ssrc,
rid: Some(rid),
},
)),
));
return Some(track_id);
}
}
}
None
}
fn handle_undeclared_ssrc(&mut self, rtp_header: &rtp::Header) -> Option<MediaStreamTrackId> {
if self.rtp_transceivers.len() != 1 {
// it is multi-media-section case, let's use find_track_id_by_rid
return None;
}
if let Some(transceiver) = self.rtp_transceivers.first()
&& let Some(receiver) = transceiver.receiver()
&& !receiver.track().codings().is_empty()
{
// it is rid-based, let's use find_track_id_by_rid
return None;
}
if let Some(transceiver) = self.rtp_transceivers.first_mut() {
// Get kind and mid before borrowing receiver mutably
let kind = transceiver.kind();
let mid = transceiver.mid().clone().unwrap_or_default();
if let Some(receiver) = transceiver.receiver_mut()
&& let Some(codec) = receiver
.get_codec_preferences()
.iter()
.find(|codec| codec.payload_type == rtp_header.payload_type) //TODO: what about RTX/FEC stream?
.cloned()
{
let receive_codings = vec![RTCRtpCodingParameters {
rid: "".to_string(),
ssrc: Some(rtp_header.ssrc),
rtx: None,
fec: None,
}];
receiver.set_coding_parameters(receive_codings);
let parameters = receiver.get_parameters(self.media_engine);
RTCRtpReceiverInternal::interceptor_remote_stream_op(
self.interceptor,
true,
rtp_header.ssrc,
codec.payload_type,
&codec.rtp_codec,
¶meters.rtp_parameters.header_extensions,
);
// assert it inserts a new entry
let new_entry = receiver
.track_mut()
.set_codec_by_ssrc(codec.rtp_codec, rtp_header.ssrc);
assert!(new_entry);
let track_id = receiver.track().track_id().to_owned();
// Create inbound stream accumulator before firing OnOpen event
// Note: undeclared SSRC case doesn't have RTX/FEC info
self.stats.get_or_create_inbound_rtp_streams(
rtp_header.ssrc,
kind,
&track_id,
&mid,
None,
None,
0, // Undeclared SSRC is always for the first transceiver
);
// Fire RTCTrackEvent::OnOpen event when received the first RTP packet for such ssrc stream
self.ctx
.event_outs
.push_back(RTCEventInternal::RTCPeerConnectionEvent(
RTCPeerConnectionEvent::OnTrack(RTCTrackEvent::OnOpen(RTCTrackEventInit {
receiver_id: RTCRtpReceiverId(0),
track_id: track_id.clone(),
stream_ids: vec![receiver.track().stream_id().to_owned()],
ssrc: rtp_header.ssrc,
rid: None,
})),
));
return Some(track_id);
}
}
None
}
fn get_rtp_header_extension_ids(
&self,
rtp_header: &rtp::Header,
) -> Option<(String, String, String)> {
if !rtp_header.extension {
return None;
}
// Get MID extension ID
let (mid_extension_id, audio_supported, video_supported) = self
.media_engine
.get_header_extension_id(RTCRtpHeaderExtensionCapability {
uri: ::sdp::extmap::SDES_MID_URI.to_owned(),
});
if !audio_supported && !video_supported {
return None;
}
// Get RID extension ID
let (rid_extension_id, audio_supported, video_supported) = self
.media_engine
.get_header_extension_id(RTCRtpHeaderExtensionCapability {
uri: ::sdp::extmap::SDES_RTP_STREAM_ID_URI.to_owned(),
});
if !audio_supported && !video_supported {
return None;
}
// Get RRID extension ID
let (rrid_extension_id, _, _) =
self.media_engine
.get_header_extension_id(RTCRtpHeaderExtensionCapability {
uri: ::sdp::extmap::SDES_REPAIR_RTP_STREAM_ID_URI.to_owned(),
});
let mid = if let Some(payload) = rtp_header.get_extension(mid_extension_id as u8) {
String::from_utf8(payload.to_vec()).unwrap_or_default()
} else {
String::new()
};
let rid = if let Some(payload) = rtp_header.get_extension(rid_extension_id as u8) {
String::from_utf8(payload.to_vec()).unwrap_or_default()
} else {
String::new()
};
let rrid = if let Some(payload) = rtp_header.get_extension(rrid_extension_id as u8) {
String::from_utf8(payload.to_vec()).unwrap_or_default()
} else {
String::new()
};
Some((mid, rid, rrid))
}
}
/// RFC 4588: resolve a single receiver's coding/codec state to the primary
/// stream that an RTX packet (`rtx_ssrc`, `rtx_payload_type`) repairs.
///
/// Returns `(primary_ssrc, primary_payload_type)` when `rtx_ssrc` is the RTX
/// SSRC of one of `coding_parameters` (declared via `a=ssrc-group:FID <primary>
/// <rtx>`, RFC 5576) and the original payload type can be resolved from the
/// matching RTX codec's `apt=` parameter (looked up by `rtx_payload_type`).
/// Returns `None` when the SSRC is not a known RTX SSRC or the `apt` mapping
/// cannot be resolved.
fn resolve_rtx_primary(
coding_parameters: &[RTCRtpCodingParameters],
codec_preferences: &[RTCRtpCodecParameters],
rtx_ssrc: SSRC,
rtx_payload_type: PayloadType,
) -> Option<(SSRC, PayloadType)> {
// Associate the RTX SSRC with its primary stream via the FID group recorded
// in the coding parameters.
let primary_ssrc =
coding_parameters
.iter()
.find_map(|coding| match (&coding.rtx, coding.ssrc) {
(Some(rtx), Some(primary_ssrc)) if rtx.ssrc == rtx_ssrc => Some(primary_ssrc),
_ => None,
})?;
// Resolve the original payload type from the negotiated RTX codec's `apt=`
// parameter.
let primary_payload_type = codec_preferences.iter().find_map(|codec| {
if codec.payload_type == rtx_payload_type
&& codec
.rtp_codec
.mime_type
.eq_ignore_ascii_case(MIME_TYPE_RTX)
{
parse_rtx_apt(&codec.rtp_codec.sdp_fmtp_line)
} else {
None
}
})?;
Some((primary_ssrc, primary_payload_type))
}
/// RFC 4588 §4: recover the original RTP packet carried inside an RTX packet.
///
/// The retransmission payload is `[OSN: u16 big-endian][original RTP payload]`,
/// where OSN "MUST be set to the sequence number of the associated original RTP
/// packet" (RFC 4588 §4). On success the packet is rewritten in place to look
/// like the original: the SSRC becomes `primary_ssrc`, the payload type becomes
/// `primary_payload_type` (the `apt`), the sequence number becomes the OSN, and
/// the 2-byte OSN header is stripped from the payload. The timestamp, marker and
/// CSRC list are already carried "as is" by the RTX packet per RFC 4588 §4 and
/// are left untouched; any original RTP padding was removed by the sender before
/// retransmission, so the padding flag is cleared.
///
/// Returns `false` without modifying the packet when the payload is shorter than
/// the 2-byte OSN header (e.g. a padding-only bandwidth-probe packet).
fn deencapsulate_rtx(
packet: &mut rtp::Packet,
primary_ssrc: SSRC,
primary_payload_type: PayloadType,
) -> bool {
if packet.payload.len() < 2 {
return false;
}
let original_sequence_number = u16::from_be_bytes([packet.payload[0], packet.payload[1]]);
packet.header.ssrc = primary_ssrc;
packet.header.payload_type = primary_payload_type;
packet.header.sequence_number = original_sequence_number;
packet.header.padding = false;
packet.payload = packet.payload.slice(2..);
true
}
#[cfg(test)]
mod rtx_tests {
use super::{
EndpointHandler, EndpointHandlerContext, Instant, Packet, RTCMessageInternal,
RTCRtpCodecParameters, RTCRtpCodingParameters, RTCRtpTransceiverInternal, RTPMessage,
TrackPacket, TransportContext, deencapsulate_rtx, resolve_rtx_primary,
};
use crate::media_stream::track::MediaStreamTrack;
use crate::peer_connection::configuration::media_engine::{MIME_TYPE_RTX, MediaEngine};
use crate::rtp_transceiver::rtp_sender::{
RTCRtpCodec, RTCRtpEncodingParameters, RTCRtpHeaderExtensionCapability,
RTCRtpRtxParameters, RtpCodecKind,
};
use crate::rtp_transceiver::{RTCRtpTransceiverDirection, RTCRtpTransceiverInit};
use crate::statistics::accumulator::RTCStatsAccumulator;
use bytes::Bytes;
use interceptor::{Interceptor, NoopInterceptor, StreamInfo, TaggedPacket};
use shared::TransportProtocol;
use shared::error::{Error, Result};
use std::sync::{Arc, Mutex};
fn coding(primary_ssrc: u32, rtx_ssrc: Option<u32>) -> RTCRtpCodingParameters {
RTCRtpCodingParameters {
rid: String::new(),
ssrc: Some(primary_ssrc),
rtx: rtx_ssrc.map(|ssrc| RTCRtpRtxParameters { ssrc }),
fec: None,
}
}
fn codec(payload_type: u8, mime_type: &str, fmtp: &str) -> RTCRtpCodecParameters {
RTCRtpCodecParameters {
rtp_codec: RTCRtpCodec {
mime_type: mime_type.to_owned(),
clock_rate: 90000,
channels: 0,
sdp_fmtp_line: fmtp.to_owned(),
rtcp_feedback: vec![],
},
payload_type,
}
}
#[test]
fn resolves_rtx_ssrc_to_primary_and_apt() {
let codings = [coding(1000, Some(2000))];
let prefs = [codec(96, "video/VP8", ""), codec(97, "video/rtx", "apt=96")];
assert_eq!(
resolve_rtx_primary(&codings, &prefs, 2000, 97),
Some((1000, 96))
);
}
#[test]
fn selects_the_correct_primary_among_several_codings() {
let codings = [coding(1000, Some(2000)), coding(1001, Some(2001))];
let prefs = [
codec(97, "video/rtx", "apt=96"),
codec(99, "video/rtx", "apt=98"),
];
assert_eq!(
resolve_rtx_primary(&codings, &prefs, 2001, 99),
Some((1001, 98))
);
}
#[test]
fn unknown_rtx_ssrc_is_not_resolved() {
let codings = [coding(1000, Some(2000))];
let prefs = [codec(97, "video/rtx", "apt=96")];
// 2000 is the only RTX SSRC: an unknown SSRC (9999) and the primary's own
// SSRC (1000) must not be mistaken for RTX.
assert_eq!(resolve_rtx_primary(&codings, &prefs, 9999, 97), None);
assert_eq!(resolve_rtx_primary(&codings, &prefs, 1000, 97), None);
}
#[test]
fn coding_without_rtx_pairing_is_not_resolved() {
// rid-based / undeclared codings carry no rtx SSRC (rtx: None).
let codings = [coding(1000, None)];
let prefs = [codec(97, "video/rtx", "apt=96")];
assert_eq!(resolve_rtx_primary(&codings, &prefs, 2000, 97), None);
}
#[test]
fn missing_or_mismatched_rtx_codec_pref_is_not_resolved() {
let codings = [coding(1000, Some(2000))];
// No codec preference at the RTX payload type.
assert_eq!(resolve_rtx_primary(&codings, &[], 2000, 97), None);
// Payload type present but it is not an RTX codec.
let non_rtx = [codec(97, "video/VP8", "")];
assert_eq!(resolve_rtx_primary(&codings, &non_rtx, 2000, 97), None);
// RTX codec present but without a parseable apt.
let no_apt = [codec(97, "video/rtx", "")];
assert_eq!(resolve_rtx_primary(&codings, &no_apt, 2000, 97), None);
}
// RFC 4588 §4: the RTX payload is [OSN (2 bytes, big-endian)][original payload].
#[test]
fn deencapsulates_rtx_packet_into_primary() {
let mut packet = rtp::Packet {
header: rtp::Header {
marker: true,
payload_type: 97, // negotiated RTX payload type
sequence_number: 42, // RTX stream sequence number (independent)
timestamp: 9000, // already the original timestamp (RFC 4588 §4)
ssrc: 0xDEAD_BEEF, // RTX SSRC
padding: true,
..Default::default()
},
// OSN = 0x1234, followed by the original media payload.
payload: Bytes::from(vec![0x12, 0x34, 0xAA, 0xBB, 0xCC]),
};
assert!(deencapsulate_rtx(&mut packet, 0x1111_2222, 96));
// Rewritten to look like the original primary packet.
assert_eq!(packet.header.ssrc, 0x1111_2222);
assert_eq!(packet.header.payload_type, 96);
assert_eq!(packet.header.sequence_number, 0x1234); // OSN
// Kept "as is".
assert_eq!(packet.header.timestamp, 9000);
assert!(packet.header.marker);
// Original padding was removed by the sender before retransmission.
assert!(!packet.header.padding);
// OSN header stripped, original payload preserved.
assert_eq!(&packet.payload[..], &[0xAA, 0xBB, 0xCC]);
}
#[test]
fn padding_only_probe_packet_is_left_unchanged() {
// A bandwidth-probe RTX packet may carry fewer than 2 payload bytes and
// therefore has no OSN to recover.
let mut packet = rtp::Packet {
header: rtp::Header {
payload_type: 97,
ssrc: 0xDEAD_BEEF,
..Default::default()
},
payload: Bytes::from(vec![0x00]),
};
let before = packet.clone();
assert!(!deencapsulate_rtx(&mut packet, 0x1111_2222, 96));
assert_eq!(packet, before);
}
#[test]
fn empty_payload_is_left_unchanged() {
let mut packet = rtp::Packet {
header: rtp::Header {
payload_type: 97,
ssrc: 7,
..Default::default()
},
payload: Bytes::new(),
};
assert!(!deencapsulate_rtx(&mut packet, 1, 96));
}
// Builds a video receive transceiver whose primary stream is paired with an
// RTX stream via the FID group, matching what start_rtp sets up for an
// `a=ssrc-group:FID` offer. The primary SSRC already has a (non-empty) codec
// so find_track_id resolves it directly.
fn rtx_receiver_transceiver(
primary_ssrc: u32,
rtx_ssrc: u32,
primary_pt: u8,
rtx_pt: u8,
) -> RTCRtpTransceiverInternal<NoopInterceptor> {
let mut transceiver = RTCRtpTransceiverInternal::<NoopInterceptor>::new(
RtpCodecKind::Video,
None,
RTCRtpTransceiverInit {
direction: RTCRtpTransceiverDirection::Recvonly,
streams: vec![],
send_encodings: vec![],
},
);
let receiver = transceiver.receiver_mut().as_mut().unwrap();
receiver.set_coding_parameters(vec![coding(primary_ssrc, Some(rtx_ssrc))]);
receiver.set_codec_preferences(vec![
codec(primary_pt, "video/VP8", ""),
codec(rtx_pt, "video/rtx", &format!("apt={primary_pt}")),
]);
receiver.set_track(MediaStreamTrack::new(
"stream".to_string(),
"track".to_string(),
"label".to_string(),
RtpCodecKind::Video,
vec![RTCRtpEncodingParameters {
rtp_coding_parameters: coding(primary_ssrc, Some(rtx_ssrc)),
active: true,
codec: RTCRtpCodec {
mime_type: "video/VP8".to_owned(),
clock_rate: 90000,
channels: 0,
sdp_fmtp_line: String::new(),
rtcp_feedback: vec![],
},
max_bitrate: 0,
max_framerate: None,
scale_resolution_down_by: None,
}],
));
transceiver
}
fn test_transport() -> TransportContext {
TransportContext {
local_addr: "127.0.0.1:5000".parse().unwrap(),
peer_addr: "127.0.0.1:5001".parse().unwrap(),
transport_protocol: TransportProtocol::UDP,
ecn: None,
}
}
#[test]
fn handle_rtp_message_deencapsulates_and_dispatches_rtx() {
let (primary_ssrc, rtx_ssrc, primary_pt, rtx_pt) = (1000u32, 2000u32, 96u8, 97u8);
let mut transceivers = vec![rtx_receiver_transceiver(
primary_ssrc,
rtx_ssrc,
primary_pt,
rtx_pt,
)];
let media_engine = MediaEngine::default();
let mut interceptor = NoopInterceptor::new();
let mut stats = RTCStatsAccumulator::new();
let mut ctx = EndpointHandlerContext::default();
// RTX packet on the RTX SSRC: payload = [OSN=42][media 0xDE 0xAD].
let rtx_packet = rtp::Packet {
header: rtp::Header {
marker: true,
payload_type: rtx_pt,
sequence_number: 9, // RTX stream sequence number (independent)
timestamp: 12_345,
ssrc: rtx_ssrc,
..Default::default()
},
payload: Bytes::from(vec![0x00, 0x2A, 0xDE, 0xAD]),
};
{
let mut handler = EndpointHandler::new(
&mut ctx,
&mut transceivers,
&media_engine,
&mut interceptor,
&mut stats,
);
handler
.handle_rtp_message(Instant::now(), test_transport(), rtx_packet)
.expect("handle_rtp_message");
}
// The recovered packet is dispatched on the primary stream, de-encapsulated.
let dispatched = ctx
.read_outs
.pop_front()
.expect("a track packet should be dispatched");
match dispatched.message {
RTCMessageInternal::Rtp(RTPMessage::TrackPacket(TrackPacket {
packet: Packet::Rtp(packet),
..
})) => {
assert_eq!(packet.header.ssrc, primary_ssrc);
assert_eq!(packet.header.payload_type, primary_pt);
assert_eq!(packet.header.sequence_number, 42); // OSN
assert_eq!(packet.header.timestamp, 12_345); // preserved
assert!(packet.header.marker); // preserved
assert_eq!(&packet.payload[..], &[0xDE, 0xAD]); // OSN stripped
}
_ => panic!("expected a de-encapsulated RTP TrackPacket on the primary stream"),
}
}
#[test]
fn handle_rtp_message_drops_rtx_probe_packet() {
let (primary_ssrc, rtx_ssrc, primary_pt, rtx_pt) = (1000u32, 2000u32, 96u8, 97u8);
let mut transceivers = vec![rtx_receiver_transceiver(
primary_ssrc,
rtx_ssrc,
primary_pt,
rtx_pt,
)];
let media_engine = MediaEngine::default();
let mut interceptor = NoopInterceptor::new();
let mut stats = RTCStatsAccumulator::new();
let mut ctx = EndpointHandlerContext::default();
// A padding-only probe on the RTX SSRC: payload shorter than the OSN.
let probe = rtp::Packet {
header: rtp::Header {
payload_type: rtx_pt,
ssrc: rtx_ssrc,
..Default::default()
},
payload: Bytes::from(vec![0x00]),
};
{
let mut handler = EndpointHandler::new(
&mut ctx,
&mut transceivers,
&media_engine,
&mut interceptor,
&mut stats,
);
handler
.handle_rtp_message(Instant::now(), test_transport(), probe)
.expect("handle_rtp_message");
}
assert!(
ctx.read_outs.is_empty(),
"an RTX probe packet with no OSN should be dropped, not dispatched"
);
}
/// An interceptor that records which remote streams it was told about.
///
/// `NoopInterceptor` suffices where only the packets matter; this exists because the property
/// under test is a *call that never happened*, which no amount of inspecting packets can show.
#[derive(Clone, Default)]
struct Recorder {
bound: Arc<Mutex<Vec<StreamInfo>>>,
}
impl Recorder {
fn bound_ssrcs(&self) -> Vec<u32> {
self.bound
.lock()
.unwrap()
.iter()
.map(|info| info.ssrc)
.collect()
}
}
impl sansio::Protocol<TaggedPacket, TaggedPacket, ()> for Recorder {
type Rout = TaggedPacket;
type Wout = TaggedPacket;
type Eout = ();
type Error = Error;
type Time = Instant;
fn handle_read(&mut self, _msg: TaggedPacket) -> Result<()> {
Ok(())
}
fn poll_read(&mut self) -> Option<Self::Rout> {
None
}
fn handle_write(&mut self, _msg: TaggedPacket) -> Result<()> {
Ok(())
}
fn poll_write(&mut self) -> Option<Self::Wout> {
None
}
fn handle_timeout(&mut self, _now: Instant) -> Result<()> {
Ok(())
}
fn poll_timeout(&mut self) -> Option<Instant> {
None
}
}
impl Interceptor for Recorder {
fn bind_local_stream(&mut self, _info: &StreamInfo) {}
fn unbind_local_stream(&mut self, _info: &StreamInfo) {}
fn bind_remote_stream(&mut self, info: &StreamInfo) {
self.bound.lock().unwrap().push(info.clone());
}
fn unbind_remote_stream(&mut self, _info: &StreamInfo) {}
}
/// A receiver for a remote track whose SSRC was declared in the SDP but whose codec is not yet
/// known — the state `RTCPeerConnection::start_rtp` leaves a declared-SSRC track in, with the
/// codec deferred until the first RTP packet names a payload type.
fn declared_ssrc_transceiver(
ssrc: u32,
payload_type: u8,
rtx: Option<(u32, u8)>,
) -> RTCRtpTransceiverInternal<Recorder> {
let mut transceiver = RTCRtpTransceiverInternal::<Recorder>::new(
RtpCodecKind::Video,
None,
RTCRtpTransceiverInit {
direction: RTCRtpTransceiverDirection::Recvonly,
streams: vec![],
send_encodings: vec![],
},
);
let mut preferences = vec![codec(payload_type, "video/VP8", "")];
if let Some((_, rtx_payload_type)) = rtx {
preferences.push(codec(
rtx_payload_type,
"video/rtx",
&format!("apt={payload_type}"),
));
}
let receiver = transceiver.receiver_mut().as_mut().unwrap();
receiver.set_coding_parameters(vec![coding(ssrc, rtx.map(|(rtx_ssrc, _)| rtx_ssrc))]);
receiver.set_codec_preferences(preferences);
receiver.set_track(MediaStreamTrack::new(
"stream".to_string(),
"track".to_string(),
"label".to_string(),
RtpCodecKind::Video,
vec![RTCRtpEncodingParameters {
rtp_coding_parameters: coding(ssrc, rtx.map(|(rtx_ssrc, _)| rtx_ssrc)),
active: true,
// Empty: not known until a packet arrives. This is the whole point.
codec: RTCRtpCodec::default(),
max_bitrate: 0,
max_framerate: None,
scale_resolution_down_by: None,
}],
));
transceiver
}
/// A media engine that has negotiated VP8 and its RTX pairing.
///
/// `MediaEngine::default()` registers nothing, and the repair payload type is resolved against
/// the *negotiated* codecs — so with an empty engine `find_rtx_payload_type` returns `None`,
/// no repair flow is ever recognised, and a test asserting one would fail for a reason that has
/// nothing to do with binding.
fn media_engine_with_rtx() -> MediaEngine {
let mut media_engine = MediaEngine::default();
media_engine
.register_codec(codec(96, "video/VP8", ""), RtpCodecKind::Video)
.expect("vp8");
media_engine
.register_codec(codec(97, MIME_TYPE_RTX, "apt=96"), RtpCodecKind::Video)
.expect("rtx");
media_engine
}
fn feed(
transceivers: &mut Vec<RTCRtpTransceiverInternal<Recorder>>,
interceptor: &mut Recorder,
ssrc: u32,
payload_type: u8,
packets: u16,
) {
let media_engine = media_engine_with_rtx();
let mut stats = RTCStatsAccumulator::new();
let mut ctx = EndpointHandlerContext::default();
let mut handler = EndpointHandler::new(
&mut ctx,
transceivers,
&media_engine,
interceptor,
&mut stats,
);
for sequence_number in 1..=packets {
let packet = rtp::Packet {
header: rtp::Header {
payload_type,
sequence_number,
timestamp: 12_345,
ssrc,
..Default::default()
},
payload: Bytes::from_static(&[0xDE, 0xAD]),
};
handler
.handle_rtp_message(Instant::now(), test_transport(), packet)
.expect("handle_rtp_message");
}
}
/// A declared-SSRC remote stream reaches the interceptors once its codec resolves.
///
/// The track is built from the remote SDP before any packet arrives, so its codec is empty then
/// and the bind attempted at that point resolves nothing — see `RTCPeerConnection::start_rtp`.
/// The first RTP packet is the first moment the stream can be described, and if it is not bound
/// there it never is.
///
/// The failure this guards against is silent: media flows perfectly and only the *feedback* is
/// missing, because the interceptors that generate receiver reports, TWCC, NACK and PLI sit in
/// the chain having never been told the stream exists. A publisher then sees its
/// `remote-inbound-rtp` stats stay empty and quietly lowers its bitrate.
#[test]
fn a_declared_ssrc_stream_is_bound_when_its_codec_resolves() {
let (ssrc, payload_type) = (1000u32, 96u8);
let mut transceivers = vec![declared_ssrc_transceiver(ssrc, payload_type, None)];
let recorder = Recorder::default();
let mut interceptor = recorder.clone();
feed(&mut transceivers, &mut interceptor, ssrc, payload_type, 1);
assert_eq!(
vec![ssrc],
recorder.bound_ssrcs(),
"the stream must be bound once its codec is known"
);
}
/// Bound exactly once, however many packets arrive.
///
/// The bind rides the same branch that resolves the codec, and that branch is guarded on the
/// codec still being empty. Binding per packet would re-register the stream on every one,
/// resetting whatever the interceptors keep per stream — sequence tracking, loss counters,
/// jitter — so the feedback would be wrong rather than absent.
#[test]
fn a_declared_ssrc_stream_is_bound_only_once() {
let (ssrc, payload_type) = (1000u32, 96u8);
let mut transceivers = vec![declared_ssrc_transceiver(ssrc, payload_type, None)];
let recorder = Recorder::default();
let mut interceptor = recorder.clone();
feed(&mut transceivers, &mut interceptor, ssrc, payload_type, 5);
assert_eq!(
vec![ssrc],
recorder.bound_ssrcs(),
"five packets, one bind: the codec is only unresolved once"
);
}
/// The repair flow is bound in its own right, not merely named as an association on the primary.
///
/// `interceptor_remote_streams_op` binds all three — primary, RTX, FEC — and `stop` unbinds all
/// three. Binding only the primary here would leave the RTX stream unbound while still being
/// unbound at teardown, and an interceptor tracking arrivals would never learn that the
/// retransmission SSRC exists.
#[test]
fn a_declared_ssrc_stream_binds_its_repair_flow_too() {
let (ssrc, payload_type) = (1000u32, 96u8);
let (rtx_ssrc, rtx_payload_type) = (2000u32, 97u8);
let mut transceivers = vec![declared_ssrc_transceiver(
ssrc,
payload_type,
Some((rtx_ssrc, rtx_payload_type)),
)];
let recorder = Recorder::default();
let mut interceptor = recorder.clone();
feed(&mut transceivers, &mut interceptor, ssrc, payload_type, 1);
assert_eq!(
vec![ssrc, rtx_ssrc],
recorder.bound_ssrcs(),
"the primary and its retransmission stream are both real streams"
);
}
/// A simulcast layer binds its repair flow in its own right, as the declared-SSRC path does.
///
/// The RID path already bound the primary, naming the RTX SSRC as an *association* on it —
/// which tells an interceptor which flow repairs which, not that a stream with its own SSRC and
/// sequence-number space is arriving. Simulcast is where that matters most: every layer has its
/// own retransmission flow, and NACK-driven repair is what keeps the upper layers usable.
///
/// It also kept the pair unbalanced — `stop` unbinds all three per coding, so the repair flow
/// was unbound having never been bound.
#[test]
fn a_simulcast_layer_binds_its_repair_flow_too() {
let (ssrc, payload_type) = (1000u32, 96u8);
let (rtx_ssrc, rtx_payload_type) = (2000u32, 97u8);
let mut media_engine = media_engine_with_rtx();
media_engine
.register_header_extension(
RTCRtpHeaderExtensionCapability {
uri: ::sdp::extmap::SDES_MID_URI.to_owned(),
},
RtpCodecKind::Video,
None,
)
.expect("mid extension");
media_engine
.register_header_extension(
RTCRtpHeaderExtensionCapability {
uri: ::sdp::extmap::SDES_RTP_STREAM_ID_URI.to_owned(),
},
RtpCodecKind::Video,
None,
)
.expect("rid extension");
// Registering makes an extension *offerable*; the handler resolves mid/rid through the
// *negotiated* set, which SDP fills in. Negotiate them here, as an answer would.
media_engine
.update_header_extension(1, ::sdp::extmap::SDES_MID_URI, RtpCodecKind::Video)
.expect("negotiate mid");
media_engine
.update_header_extension(
2,
::sdp::extmap::SDES_RTP_STREAM_ID_URI,
RtpCodecKind::Video,
)
.expect("negotiate rid");
// Ask the engine which ids it assigned rather than assuming: the handler resolves mid/rid
// through the same lookup, so a guess that disagreed would make this test fail for a
// reason unrelated to binding.
let (mid_extension_id, _, _) =
media_engine.get_header_extension_id(RTCRtpHeaderExtensionCapability {
uri: ::sdp::extmap::SDES_MID_URI.to_owned(),
});
let (rid_extension_id, _, _) =
media_engine.get_header_extension_id(RTCRtpHeaderExtensionCapability {
uri: ::sdp::extmap::SDES_RTP_STREAM_ID_URI.to_owned(),
});
// A layer whose SSRC is not yet known: the RID path is what learns it from the first packet.
let mut transceiver = RTCRtpTransceiverInternal::<Recorder>::new(
RtpCodecKind::Video,
None,
RTCRtpTransceiverInit {
direction: RTCRtpTransceiverDirection::Recvonly,
streams: vec![],
send_encodings: vec![],
},
);
transceiver.set_mid("0".to_owned()).expect("mid");
{
let receiver = transceiver.receiver_mut().as_mut().unwrap();
receiver.set_coding_parameters(vec![RTCRtpCodingParameters {
rid: "h".to_owned(),
ssrc: None,
rtx: Some(RTCRtpRtxParameters { ssrc: rtx_ssrc }),
fec: None,
}]);
receiver.set_codec_preferences(vec![
codec(payload_type, "video/VP8", ""),
codec(
rtx_payload_type,
MIME_TYPE_RTX,
&format!("apt={payload_type}"),
),
]);
receiver.set_track(MediaStreamTrack::new(
"stream".to_string(),
"track".to_string(),
"label".to_string(),
RtpCodecKind::Video,
vec![RTCRtpEncodingParameters {
rtp_coding_parameters: RTCRtpCodingParameters {
rid: "h".to_owned(),
ssrc: None,
rtx: Some(RTCRtpRtxParameters { ssrc: rtx_ssrc }),
fec: None,
},
active: true,
codec: RTCRtpCodec::default(),
max_bitrate: 0,
max_framerate: None,
scale_resolution_down_by: None,
}],
));
}
let mut transceivers = vec![transceiver];
let recorder = Recorder::default();
let mut interceptor = recorder.clone();
let mut stats = RTCStatsAccumulator::new();
let mut ctx = EndpointHandlerContext::default();
let mut header = rtp::Header {
extension: true,
// One-byte extension form (RFC 8285). Without it the header is read as RFC 3550 and
// rejects these ids outright.
extension_profile: 0xBEDE,
payload_type,
sequence_number: 1,
timestamp: 12_345,
ssrc,
..Default::default()
};
header
.set_extension(mid_extension_id as u8, Bytes::from_static(b"0"))
.expect("mid extension");
header
.set_extension(rid_extension_id as u8, Bytes::from_static(b"h"))
.expect("rid extension");
{
let mut handler = EndpointHandler::new(
&mut ctx,
&mut transceivers,
&media_engine,
&mut interceptor,
&mut stats,
);
handler
.handle_rtp_message(
Instant::now(),
test_transport(),
rtp::Packet {
header,
payload: Bytes::from_static(&[0xDE, 0xAD]),
},
)
.expect("handle_rtp_message");
}
assert_eq!(
vec![ssrc, rtx_ssrc],
recorder.bound_ssrcs(),
"the layer and its retransmission stream are both real streams"
);
}
}