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
use super::{BitRead, CodecExtra, Depacketizer, PacketError, Packetizer};
use std::fmt;
/// Max VP9 RTP payload descriptor size for non-flexible mode:
/// flags(1) + 15-bit PID(2) + L byte(1) + tl0picidx(1) + SS(3 on keyframes) = 8
const VP9_NON_FLEXIBLE_HEADER_SIZE: usize = 8;
/// VP9 RTP payload descriptor size for flexible mode:
/// flags(1) + 15-bit PID(2) = 3
const VP9_FLEXIBLE_HEADER_SIZE: usize = 3;
const MAX_SPATIAL_LAYERS: usize = 3;
const MAX_VP9REF_PICS: usize = 3;
/// VP9 packetizer mode controlling the RTP payload descriptor format.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum Vp9PacketizerMode {
/// Flexible mode (F=1): minimal 3-byte header (flags + 15-bit PID).
/// Simpler but causes issues with Safari which drops inter-frames.
Flexible,
/// Non-flexible mode (F=0): 5-8 byte header with layer indices and
/// scalability structure. Compatible with all major browsers.
#[default]
NonFlexible,
}
/// Vp9 information describing the depacketized/packetized data.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub struct Vp9CodecExtra {
/// Map of the SVC layers.
///
/// Index of each element corresponds to `spatial layer` index.
///
/// Each element represents the end (not including) in [`MediaData::data`]
/// for `spatial layer` it belongs.
///
/// The all `spatial layer`s (up to 3) in [`MediaData::data`] are sorted by
/// `spatial layer` index from lower to greater. So, the beginning of some
/// `spatial layer` is the end (including) of the previous `spatial layer`
/// (for the `spatial layer` with index 0 the beginning is 0).
///
/// ```text
/// [MediaData::data]:
/// +-----+----------------------+---------------------------+
/// | SL0 | SL1 | SL2 |
/// +-----+----------------------+---------------------------+
/// | | | |
/// V V V V
/// 0 layers_scheme[0] layers_scheme[1] layers_scheme[2]
/// ```
///
/// **Note:** There is no syncronization between
/// [`Vp9CodecExtra::layers_scheme`] and [`MediaData::data`]! If you need
/// to keep [`Vp9CodecExtra::layers_scheme`] in actual state you have to
/// update the [`Vp9CodecExtra::layers_scheme`] on mutating the
/// [`MediaData::data`].
///
/// [`MediaData::data`]: crate::media::MediaData::data
///
/// ## Example
///
/// Say you have a VP9 track working in "L3T3" scalability mode and you
/// want to retranslate S1T2 layer. So you need to retranslate the all
/// spatial and temporal layers <= target layer.
///
/// ```no_run
/// # use str0m::{format::CodecExtra, media::MediaData};
/// #
/// // We want to receive S1T2 layer.
/// let (target_spatial, target_temporal) = (1u8, 2u8);
///
/// let mut media_data: MediaData = todo!();
///
/// if let CodecExtra::Vp9(vp9_extra) = media_data.codec_extra {
/// // Try to get current `temporal layer`. If `None` there is no SVC.
/// if let Some(tid) = vp9_extra.tid {
/// if let (true, Some(end_of_target_layer)) = (
/// // Check whether we need this `temporal layer`.
/// tid <= target_temporal,
/// // Check whether we have information about the right
/// // border of data for the target `spatial layer`.
/// vp9_extra.layers_scheme[target_spatial as usize],
/// ) {
/// // Cut off unwanted data of `spatial layer`s with spatial
/// // indeces higher than `target_spatial`.
/// media_data.data.drain(end_of_target_layer..);
/// }
/// }
/// }
/// ```
pub layers_scheme: [Option<usize>; MAX_SPATIAL_LAYERS],
/// Temporal layer id.
pub tid: Option<u8>,
/// Map of the SVC layers widths.
///
/// Specified for every spatial layer.
pub layers_widths: [Option<u16>; MAX_SPATIAL_LAYERS],
/// Map of the SVC layers heights.
///
/// Specified for every spatial layer.
pub layers_heights: [Option<u16>; MAX_SPATIAL_LAYERS],
/// Extended picture id of layer 0 frames, if present
pub tl0_picture_id: Option<u8>,
/// Picture ID.
pub pid: u16,
/// Flag which indicates that within [`MediaData`], there is an individual frame
/// containing complete and independent visual information. This frame serves
/// as a reference point for other frames in the video sequence.
///
/// [`MediaData`]: crate::media::MediaData
pub is_keyframe: bool,
}
/// Detect whether a raw VP9 frame is a keyframe by inspecting the bitstream header.
///
/// VP9 uncompressed header (profile 0/1):
/// `frame_marker(2) | profile_low(1) | profile_high(1) | show_existing(1) | frame_type(1)`
///
/// VP9 uncompressed header (profile 2/3):
/// `frame_marker(2) | profile_low(1) | profile_high(1) | reserved(1) | show_existing(1) | frame_type(1)`
///
/// - `frame_marker` must be `0b10`
/// - `frame_type`: 0 = KEY_FRAME, 1 = NON_KEY_FRAME
/// - `show_existing_frame` = 1 references a previously decoded frame (not a real keyframe)
///
/// This function works on raw VP9 bitstream data (without RTP descriptor).
pub fn detect_vp9_keyframe_bitstream(payload: &[u8]) -> bool {
if payload.is_empty() {
return false;
}
let b = payload[0];
// frame_marker must be 0b10 (bits 7-6)
if (b & 0xC0) != 0x80 {
return false;
}
// profile_high_bit is at bit 4
let profile_high = (b >> 4) & 1;
let (show_existing_frame, frame_type) = if profile_high == 1 {
// Profile 2 or 3: reserved_zero at bit 3, show_existing at bit 2, frame_type at bit 1
((b >> 2) & 1, (b >> 1) & 1)
} else {
// Profile 0 or 1: show_existing at bit 3, frame_type at bit 2
((b >> 3) & 1, (b >> 2) & 1)
};
// show_existing_frame references a previously decoded frame, not a real keyframe
if show_existing_frame != 0 {
return false;
}
// frame_type: 0 = KEY_FRAME
frame_type == 0
}
/// Detect whether a VP9 RTP payload contains a keyframe by inspecting the P bit.
///
/// VP9 RTP descriptor byte 0: `I|P|L|F|B|E|V|Z`
/// - P=0: independently decodable frame (keyframe)
/// - P=1: inter-picture predicted frame
///
/// Works with both flexible (F=1) and non-flexible (F=0) mode packets.
pub fn detect_vp9_keyframe(payload: &[u8]) -> bool {
if payload.is_empty() {
return false;
}
// P bit is bit 6 of byte 0. P=0 means keyframe.
(payload[0] & 0x40) == 0
}
/// Packetizes VP9 RTP packets.
///
/// Supports both non-flexible mode (F=0) and flexible mode (F=1), controlled
/// by [`Vp9PacketizerMode`]. Defaults to non-flexible mode for broad browser
/// compatibility — Safari and older Chrome drop inter-frames with F=1.
#[derive(Default, Clone)]
pub struct Vp9Packetizer {
picture_id: u16,
/// Temporal layer 0 picture index — increments on every frame (since all
/// frames are packetized as TID=0). Used in L byte for non-flexible mode.
tl0picidx: u8,
initialized: bool,
mode: Vp9PacketizerMode,
#[cfg(test)]
initial_picture_id: u16,
}
impl Vp9Packetizer {
/// Create a VP9 packetizer with the specified mode.
pub fn with_mode(mode: Vp9PacketizerMode) -> Self {
Self {
mode,
..Default::default()
}
}
}
impl fmt::Debug for Vp9Packetizer {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Vp9Packetizer")
.field("picture_id", &self.picture_id)
.field("tl0picidx", &self.tl0picidx)
.field("initialized", &self.initialized)
.field("mode", &self.mode)
.finish()
}
}
impl Packetizer for Vp9Packetizer {
/// Packetize a VP9 frame into one or more RTP packets.
fn packetize(&mut self, mtu: usize, payload: &[u8]) -> Result<Vec<Vec<u8>>, PacketError> {
if payload.is_empty() || mtu == 0 {
return Ok(vec![]);
}
if !self.initialized {
#[cfg(test)]
{
self.picture_id = self.initial_picture_id;
}
#[cfg(not(test))]
{
use str0m_proto::NonCryptographicRng;
self.picture_id = NonCryptographicRng::u16() & 0x7FFF;
}
self.initialized = true;
}
match self.mode {
Vp9PacketizerMode::NonFlexible => self.packetize_non_flexible(mtu, payload),
Vp9PacketizerMode::Flexible => self.packetize_flexible(mtu, payload),
}
}
fn is_marker(&mut self, _data: &[u8], _previous: Option<&[u8]>, last: bool) -> bool {
last
}
}
impl Vp9Packetizer {
/// Non-flexible mode (F=0) packetization.
///
/// 5-8 byte header with layer indices and scalability structure.
/// Compatible with all major browsers including Safari.
///
/// ```text
/// 0 1 2 3 4 5 6 7
/// +-+-+-+-+-+-+-+-+
/// |I|P|L|F|B|E|V|Z| (REQUIRED)
/// +-+-+-+-+-+-+-+-+
/// I: |M| PICTURE ID | (RECOMMENDED)
/// +-+-+-+-+-+-+-+-+
/// M: | EXTENDED PID | (RECOMMENDED)
/// +-+-+-+-+-+-+-+-+
/// L: | tid |U| SID |D| (CONDITIONALLY RECOMMENDED)
/// +-+-+-+-+-+-+-+-+
/// | tl0picidx | (CONDITIONALLY REQUIRED)
/// +-+-+-+-+-+-+-+-+
/// V: | SS |
/// | .. |
/// +-+-+-+-+-+-+-+-+
/// ```
fn packetize_non_flexible(
&mut self,
mtu: usize,
payload: &[u8],
) -> Result<Vec<Vec<u8>>, PacketError> {
// Detect keyframe from VP9 bitstream to set P flag correctly.
let is_keyframe = detect_vp9_keyframe_bitstream(payload);
// tl0picidx increments on every TID=0 frame. Since we always emit TID=0,
// this increments on every frame per draft-ietf-payload-vp9, Section 6.3.
self.tl0picidx = self.tl0picidx.wrapping_add(1);
// VP9_NON_FLEXIBLE_HEADER_SIZE is the max header (8 bytes, accounting for SS
// on keyframes). This ensures we never exceed MTU even on keyframe first-packets.
let max_fragment_size = mtu as isize - VP9_NON_FLEXIBLE_HEADER_SIZE as isize;
let mut payloads = vec![];
let mut payload_data_remaining = payload.len();
let mut payload_data_index = 0;
if std::cmp::min(max_fragment_size, payload_data_remaining as isize) <= 0 {
return Ok(vec![]);
}
while payload_data_remaining > 0 {
let current_fragment_size =
std::cmp::min(max_fragment_size as usize, payload_data_remaining);
let is_first = payload_data_index == 0;
let is_last = payload_data_remaining == current_fragment_size;
// Non-keyframe: 5 bytes (flags + 15-bit PID + L + tl0picidx)
// Keyframe first packet: 8 bytes (+ 3 bytes SS data)
let ss_size = if is_keyframe && is_first { 3 } else { 0 };
let header_size = 5 + ss_size;
let mut out = Vec::with_capacity(header_size + current_fragment_size);
// Byte 0: I|P|L|F|B|E|V|Z
let mut flags = 0xA0u8; // I=1, L=1 (F=0 implicit)
if !is_keyframe {
flags |= 0x40; // P=1 for inter-predicted frames
}
if is_first {
flags |= 0x08; // B=1 (beginning of frame)
}
if is_last {
flags |= 0x04; // E=1 (end of frame)
}
if is_keyframe && is_first {
flags |= 0x02; // V=1 (scalability structure present)
}
out.push(flags);
// Bytes 1-2: 15-bit picture ID (M=1)
out.push((self.picture_id >> 8) as u8 | 0x80);
out.push((self.picture_id & 0xFF) as u8);
// Bytes 3-4: Layer indices (L=1, non-flexible mode)
// TID(3)|U(1)|SID(3)|D(1) = TID=0, U=1, SID=0, D=0
out.push(0x10);
// tl0picidx (required when F=0 and L=1)
out.push(self.tl0picidx);
// SS data on keyframe first packet (V=1)
if is_keyframe && is_first {
// N_S(3)|Y(1)|G(1)|RES(3) = N_S=0 (1 spatial layer), Y=0, G=1
out.push(0x08);
// N_G = 1 (1 picture in GOF)
out.push(0x01);
// GOF[0]: TID(3)|U(1)|R(2)|RES(2) = TID=0, U=0, R=0
out.push(0x00);
}
out.extend_from_slice(
&payload[payload_data_index..payload_data_index + current_fragment_size],
);
payloads.push(out);
payload_data_remaining -= current_fragment_size;
payload_data_index += current_fragment_size;
}
self.picture_id += 1;
self.picture_id &= 0x7FFF;
Ok(payloads)
}
/// Flexible mode (F=1) packetization.
///
/// Minimal 3-byte header (flags + 15-bit PID). Simpler but may cause
/// issues with Safari which drops inter-frames.
///
/// ```text
/// 0 1 2 3 4 5 6 7
/// +-+-+-+-+-+-+-+-+
/// |I|P|L|F|B|E|V|Z| (REQUIRED)
/// +-+-+-+-+-+-+-+-+
/// I: |M| PICTURE ID | (RECOMMENDED)
/// +-+-+-+-+-+-+-+-+
/// M: | EXTENDED PID | (RECOMMENDED)
/// +-+-+-+-+-+-+-+-+
/// ```
fn packetize_flexible(
&mut self,
mtu: usize,
payload: &[u8],
) -> Result<Vec<Vec<u8>>, PacketError> {
let max_fragment_size = mtu as isize - VP9_FLEXIBLE_HEADER_SIZE as isize;
let mut payloads = vec![];
let mut payload_data_remaining = payload.len();
let mut payload_data_index = 0;
if std::cmp::min(max_fragment_size, payload_data_remaining as isize) <= 0 {
return Ok(vec![]);
}
while payload_data_remaining > 0 {
let current_fragment_size =
std::cmp::min(max_fragment_size as usize, payload_data_remaining);
let is_first = payload_data_index == 0;
let is_last = payload_data_remaining == current_fragment_size;
let mut out = Vec::with_capacity(VP9_FLEXIBLE_HEADER_SIZE + current_fragment_size);
// Byte 0: I|P|L|F|B|E|V|Z — I=1, F=1
let mut flags = 0x90u8; // I=1, F=1
if is_first {
flags |= 0x08; // B=1
}
if is_last {
flags |= 0x04; // E=1
}
out.push(flags);
// Bytes 1-2: 15-bit picture ID (M=1)
out.push((self.picture_id >> 8) as u8 | 0x80);
out.push((self.picture_id & 0xFF) as u8);
out.extend_from_slice(
&payload[payload_data_index..payload_data_index + current_fragment_size],
);
payloads.push(out);
payload_data_remaining -= current_fragment_size;
payload_data_index += current_fragment_size;
}
self.picture_id += 1;
self.picture_id &= 0x7FFF;
Ok(payloads)
}
}
/// Depacketizes VP9 RTP packets.
#[derive(PartialEq, Eq, Debug, Default, Clone)]
pub struct Vp9Depacketizer {
/// picture ID is present
pub i: bool,
/// inter-picture predicted frame.
pub p: bool,
/// layer indices present
pub l: bool,
/// flexible mode
pub f: bool,
/// start of frame. beginning of new vp9 frame
pub b: bool,
/// end of frame
pub e: bool,
/// scalability structure (SS) present
pub v: bool,
/// Not a reference frame for upper spatial layers
pub z: bool,
/// Recommended headers
/// 7 or 16 bits, picture ID.
pub picture_id: u16,
/// Conditionally recommended headers
/// Temporal layer ID
pub tid: u8,
/// Switching up point
pub u: bool,
/// Spatial layer ID
pub sid: u8,
/// Inter-layer dependency used
pub d: bool,
/// Conditionally required headers
/// Reference index (F=1)
pub pdiff: [u8; MAX_VP9REF_PICS],
/// Temporal layer zero index (F=0)
pub tl0picidx: u8,
/// Scalability structure headers
/// N_S + 1 indicates the number of spatial layers present in the VP9 stream
pub ns: u8,
/// Each spatial layer's frame resolution present
pub y: bool,
/// PG description present flag.
pub g: bool,
/// N_G indicates the number of pictures in a Picture Group (PG)
pub ng: u8,
pub width: [Option<u16>; MAX_SPATIAL_LAYERS],
pub height: [Option<u16>; MAX_SPATIAL_LAYERS],
/// Temporal layer ID of pictures in a Picture Group
pub pgtid: Vec<u8>,
/// Switching up point of pictures in a Picture Group
pub pgu: Vec<bool>,
/// Reference indices of pictures in a Picture Group
pub pgpdiff: Vec<Vec<u8>>,
}
impl Depacketizer for Vp9Depacketizer {
fn out_size_hint(&self, packets_size: usize) -> Option<usize> {
Some(packets_size)
}
/// depacketize parses the passed byte slice and stores the result
/// in the Vp9Packet this method is called upon
fn depacketize(
&mut self,
packet: &[u8],
out: &mut Vec<u8>,
extra: &mut CodecExtra,
) -> Result<(), PacketError> {
if packet.is_empty() {
return Err(PacketError::ErrShortPacket);
}
let mut reader = (packet, 0);
let b = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
self.i = (b & 0x80) != 0;
self.p = (b & 0x40) != 0;
self.l = (b & 0x20) != 0;
self.f = (b & 0x10) != 0;
self.b = (b & 0x08) != 0;
self.e = (b & 0x04) != 0;
self.v = (b & 0x02) != 0;
self.z = (b & 0x01) != 0;
let mut payload_index = 1;
if self.i {
payload_index = self.parse_picture_id(&mut reader, payload_index)?;
}
if self.l {
payload_index = self.parse_layer_info(&mut reader, payload_index)?;
}
if self.f && self.p {
payload_index = self.parse_ref_indices(&mut reader, payload_index)?;
}
if self.v {
payload_index = self.parse_ssdata(&mut reader, payload_index)?;
}
self.update_extra(extra, out.len(), packet.len(), payload_index)?;
out.extend_from_slice(&packet[payload_index..]);
Ok(())
}
/// is_partition_head checks whether if this is a head of the VP9 partition
fn is_partition_head(&self, payload: &[u8]) -> bool {
if payload.is_empty() {
false
} else {
(payload[0] & 0x08) != 0
}
}
fn is_partition_tail(&self, marker: bool, _payload: &[u8]) -> bool {
marker
}
}
impl Vp9Depacketizer {
/// Updates provided [`CodecExtra`].
/// __MUST__ be called after the all transformations of `payload_index`.
fn update_extra(
&self,
extra: &mut CodecExtra,
out_len: usize,
packet_len: usize,
payload_index: usize,
) -> Result<(), PacketError> {
let mut vp9_extra = match extra {
CodecExtra::Vp9(e) => *e,
_ => Vp9CodecExtra::default(),
};
if self.l {
let new_stop = out_len + packet_len - payload_index;
if let Some(stop) = vp9_extra.layers_scheme[self.sid as usize] {
if stop != out_len {
return Err(PacketError::ErrVP9CorruptedPacket);
}
}
vp9_extra.layers_scheme[self.sid as usize] = Some(new_stop);
vp9_extra.tid = Some(self.tid);
if !self.f {
vp9_extra.tl0_picture_id = Some(self.tl0picidx);
}
}
vp9_extra.pid = self.picture_id;
vp9_extra
.layers_widths
.copy_from_slice(&self.width[..MAX_SPATIAL_LAYERS]);
vp9_extra
.layers_heights
.copy_from_slice(&self.height[..MAX_SPATIAL_LAYERS]);
vp9_extra.is_keyframe |= !self.p && (self.sid == 0 || !self.l) && self.b;
*extra = CodecExtra::Vp9(vp9_extra);
Ok(())
}
// Picture ID:
//
// +-+-+-+-+-+-+-+-+
// I: |M| PICTURE ID | M:0 => picture id is 7 bits.
// +-+-+-+-+-+-+-+-+ M:1 => picture id is 15 bits.
// M: | EXTENDED PID |
// +-+-+-+-+-+-+-+-+
//
fn parse_picture_id(
&mut self,
reader: &mut dyn BitRead,
mut payload_index: usize,
) -> Result<usize, PacketError> {
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
let b = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
// PID present?
if (b & 0x80) != 0 {
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
// M == 1, PID is 15bit
let x = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
self.picture_id = (((b & 0x7f) as u16) << 8) | (x as u16);
payload_index += 1;
} else {
self.picture_id = (b & 0x7F) as u16;
}
Ok(payload_index)
}
fn parse_layer_info(
&mut self,
reader: &mut dyn BitRead,
mut payload_index: usize,
) -> Result<usize, PacketError> {
payload_index = self.parse_layer_info_common(reader, payload_index)?;
if self.f {
Ok(payload_index)
} else {
self.parse_layer_info_non_flexible_mode(reader, payload_index)
}
}
// Layer indices (flexible mode):
//
// +-+-+-+-+-+-+-+-+
// L: | T |U| S |D|
// +-+-+-+-+-+-+-+-+
//
fn parse_layer_info_common(
&mut self,
reader: &mut dyn BitRead,
mut payload_index: usize,
) -> Result<usize, PacketError> {
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
let b = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
self.tid = b >> 5;
self.u = b & 0x10 != 0;
self.sid = (b >> 1) & 0x7;
self.d = b & 0x01 != 0;
if self.sid as usize >= MAX_SPATIAL_LAYERS {
Err(PacketError::ErrTooManySpatialLayers)
} else {
Ok(payload_index)
}
}
// Layer indices (non-flexible mode):
//
// +-+-+-+-+-+-+-+-+
// L: | T |U| S |D|
// +-+-+-+-+-+-+-+-+
// | tl0picidx |
// +-+-+-+-+-+-+-+-+
//
fn parse_layer_info_non_flexible_mode(
&mut self,
reader: &mut dyn BitRead,
mut payload_index: usize,
) -> Result<usize, PacketError> {
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
self.tl0picidx = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
Ok(payload_index)
}
// Reference indices:
//
// +-+-+-+-+-+-+-+-+ P=1,F=1: At least one reference index
// P,F: | P_DIFF |N| up to 3 times has to be specified.
// +-+-+-+-+-+-+-+-+ N=1: An additional P_DIFF follows
// current P_DIFF.
//
fn parse_ref_indices(
&mut self,
reader: &mut dyn BitRead,
mut payload_index: usize,
) -> Result<usize, PacketError> {
let mut b = 1u8;
let mut num_ref_pics = 0;
while (b & 0x1) != 0 {
if num_ref_pics == MAX_VP9REF_PICS {
return Err(PacketError::ErrTooManyPDiff);
}
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
b = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
self.pdiff[num_ref_pics] = b >> 1;
num_ref_pics += 1;
}
Ok(payload_index)
}
// Scalability structure (SS):
//
// +-+-+-+-+-+-+-+-+
// V: | N_S |Y|G|-|-|-|
// +-+-+-+-+-+-+-+-+ -|
// Y: | WIDTH | (OPTIONAL) .
// + + .
// | | (OPTIONAL) .
// +-+-+-+-+-+-+-+-+ . N_S + 1 times
// | HEIGHT | (OPTIONAL) .
// + + .
// | | (OPTIONAL) .
// +-+-+-+-+-+-+-+-+ -|
// G: | N_G | (OPTIONAL)
// +-+-+-+-+-+-+-+-+ -|
// N_G: | T |U| R |-|-| (OPTIONAL) .
// +-+-+-+-+-+-+-+-+ -| . N_G times
// | P_DIFF | (OPTIONAL) . R times .
// +-+-+-+-+-+-+-+-+ -| -|
//
fn parse_ssdata(
&mut self,
reader: &mut dyn BitRead,
mut payload_index: usize,
) -> Result<usize, PacketError> {
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
let b = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
self.ns = b >> 5;
self.y = b & 0x10 != 0;
self.g = (b >> 1) & 0x7 != 0;
let ns = (self.ns + 1) as usize;
self.ng = 0;
if ns > MAX_SPATIAL_LAYERS {
return Err(PacketError::ErrVP9CorruptedPacket);
}
if self.y {
if reader.remaining_bits() < 4 * ns {
return Err(PacketError::ErrShortPacket);
}
for i in 0..ns {
self.width[i] = Some(reader.get_u16().ok_or(PacketError::ErrShortPacket)?);
self.height[i] = Some(reader.get_u16().ok_or(PacketError::ErrShortPacket)?);
}
payload_index += 4 * ns;
}
if self.g {
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
self.ng = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
}
for i in 0..self.ng as usize {
if reader.remaining_bits() == 0 {
return Err(PacketError::ErrShortPacket);
}
let b = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
self.pgtid.push(b >> 5);
self.pgu.push(b & 0x10 != 0);
let r = ((b >> 2) & 0x3) as usize;
if reader.remaining_bits() < r {
return Err(PacketError::ErrShortPacket);
}
self.pgpdiff.push(vec![]);
for _ in 0..r {
let b = reader.get_u8().ok_or(PacketError::ErrShortPacket)?;
payload_index += 1;
self.pgpdiff[i].push(b);
}
}
Ok(payload_index)
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_vp9_packet_unmarshal() -> Result<(), PacketError> {
let tests: Vec<(&str, &[u8], Vp9Depacketizer, &[u8], Option<PacketError>)> = vec![
(
"Empty",
&[],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"NonFlexible",
&[0x00, 0xAA],
Vp9Depacketizer::default(),
&[0xAA],
None,
),
(
"NonFlexiblePictureID",
&[0x80, 0x02, 0xAA],
Vp9Depacketizer {
i: true,
picture_id: 0x02,
..Default::default()
},
&[0xAA],
None,
),
(
"NonFlexiblePictureIDExt",
&[0x80, 0x81, 0xFF, 0xAA],
Vp9Depacketizer {
i: true,
picture_id: 0x01FF,
..Default::default()
},
&[0xAA],
None,
),
(
"NonFlexiblePictureIDExt_ShortPacket0",
&[0x80, 0x81],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"NonFlexiblePictureIDExt_ShortPacket1",
&[0x80],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"NonFlexibleLayerIndicePictureID",
&[0xA0, 0x02, 0x23, 0x01, 0xAA],
Vp9Depacketizer {
i: true,
l: true,
picture_id: 0x02,
tid: 0x01,
sid: 0x01,
d: true,
tl0picidx: 0x01,
..Default::default()
},
&[0xAA],
None,
),
(
"FlexibleLayerIndicePictureID",
&[0xB0, 0x02, 0x23, 0x01, 0xAA],
Vp9Depacketizer {
f: true,
i: true,
l: true,
picture_id: 0x02,
tid: 0x01,
sid: 0x01,
d: true,
..Default::default()
},
&[0x01, 0xAA],
None,
),
(
"NonFlexibleLayerIndicePictureID_ShortPacket0",
&[0xA0, 0x02, 0x23],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"NonFlexibleLayerIndicePictureID_ShortPacket1",
&[0xA0, 0x02],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"FlexiblePictureIDRefIndex",
&[0xD0, 0x02, 0x03, 0x04, 0xAA],
Vp9Depacketizer {
i: true,
p: true,
f: true,
picture_id: 0x02,
pdiff: [0x01, 0x02, 0],
..Default::default()
},
&[0xAA],
None,
),
(
"FlexiblePictureIDRefIndex_TooManyPDiff",
&[0xD0, 0x02, 0x03, 0x05, 0x07, 0x09, 0x10, 0xAA],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrTooManyPDiff),
),
(
"FlexiblePictureIDRefIndexNoPayload",
&[0xD0, 0x02, 0x03, 0x04],
Vp9Depacketizer {
i: true,
p: true,
f: true,
picture_id: 0x02,
pdiff: [0x01, 0x02, 0],
..Default::default()
},
&[],
None,
),
(
"FlexiblePictureIDRefIndex_ShortPacket0",
&[0xD0, 0x02, 0x03],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"FlexiblePictureIDRefIndex_ShortPacket1",
&[0xD0, 0x02],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"FlexiblePictureIDRefIndex_ShortPacket2",
&[0xD0],
Vp9Depacketizer::default(),
&[],
Some(PacketError::ErrShortPacket),
),
(
"ScalabilityStructureResolutionsNoPayload",
&[
0x0A,
(1 << 5) | (1 << 4), // NS:1 Y:1 G:0
(640 >> 8) as u8,
(640 & 0xff) as u8,
(360 >> 8) as u8,
(360 & 0xff) as u8,
(1280 >> 8) as u8,
(1280 & 0xff) as u8,
(720 >> 8) as u8,
(720 & 0xff) as u8,
],
Vp9Depacketizer {
b: true,
v: true,
ns: 1,
y: true,
g: false,
ng: 0,
width: {
let mut res = [None; MAX_SPATIAL_LAYERS];
res[0] = Some(640);
res[1] = Some(1280);
res
},
height: {
let mut res = [None; MAX_SPATIAL_LAYERS];
res[0] = Some(360);
res[1] = Some(720);
res
},
..Default::default()
},
&[],
None,
),
(
"ScalabilityStructureNoPayload",
&[
0x0A,
(1 << 5) | (1 << 3), // NS:1 Y:0 G:1
2,
(1 << 4), // T:0 U:1 R:0 -
(2 << 5) | (1 << 2), // T:2 U:0 R:1 -
33,
],
Vp9Depacketizer {
b: true,
v: true,
ns: 1,
y: false,
g: true,
ng: 2,
pgtid: vec![0, 2],
pgu: vec![true, false],
pgpdiff: vec![vec![], vec![33]],
..Default::default()
},
&[],
None,
),
(
"ScalabilityStructureThreeLayers",
&[
0x0A,
(2 << 5) | (1 << 4), // NS:2 Y:1 G:0
(480 >> 8) as u8,
(480 & 0xff) as u8,
(270 >> 8) as u8,
(270 & 0xff) as u8,
(960 >> 8) as u8,
(960 & 0xff) as u8,
(540 >> 8) as u8,
(540 & 0xff) as u8,
(1920 >> 8) as u8,
(1920 & 0xff) as u8,
(1080 >> 8) as u8,
(1080 & 0xff) as u8,
],
Vp9Depacketizer {
b: true,
v: true,
ns: 2,
y: true,
g: false,
ng: 0,
width: [Some(480), Some(960), Some(1920)],
height: [Some(270), Some(540), Some(1080)],
..Default::default()
},
&[],
None,
),
(
"ParseRefIdx",
&[
0xD8, /* I:1 P:1 L:0 F:1
* B:1 E:0 V:0 Z:0 */
(0x80 | ((17 >> 8) & 0x7F)) as u8, // Two byte pictureID.
17, // TL0PICIDX
(17 << 1) | 1, // P_DIFF N:1
(18 << 1) | 1, // P_DIFF N:1
(127 << 1) | 0, // P_DIFF N:0
],
Vp9Depacketizer {
i: true,
p: true,
f: true,
b: true,
picture_id: 17,
pdiff: [17, 18, 127],
..Default::default()
},
&[],
None,
),
];
for (name, b, pkt, expected, err) in tests {
let mut p = Vp9Depacketizer::default();
if let Some(expected) = err {
let mut payload = Vec::new();
let mut extra = CodecExtra::None;
if let Err(actual) = p.depacketize(b, &mut payload, &mut extra) {
assert_eq!(
expected, actual,
"{name}: expected {expected}, but got {actual}"
);
} else {
panic!("{name}: expected error, but got passed");
}
} else {
let mut payload = Vec::new();
let mut extra = CodecExtra::None;
p.depacketize(b, &mut payload, &mut extra)?;
assert_eq!(pkt, p, "{name}: expected {pkt:?}, but got {p:?}");
assert_eq!(payload, expected);
}
}
Ok(())
}
#[test]
fn test_vp9_packetizer_payload() -> Result<(), PacketError> {
let mut r0 = 8692;
let mut rands = vec![];
for _ in 0..10 {
rands.push(vec![(r0 >> 8) as u8 | 0x80, (r0 & 0xFF) as u8]);
r0 += 1;
}
// Non-flexible mode (F=0) header layout:
// Byte 0: I|P|L|F|B|E|V|Z (I=1, L=1 always set)
// Bytes 1-2: 15-bit PID (M=1)
// Byte 3: TID(3)|U(1)|SID(3)|D(1) = 0x10 (TID=0, U=1, SID=0, D=0)
// Byte 4: tl0picidx (wrapping u8, increments every frame)
// [Bytes 5-7]: SS data on keyframe first packet only
//
// Flags byte (non-keyframe): I=1,P=1,L=1,F=0 = 0xE0 base
// + B=0x08, E=0x04
// B+E: 0xEC, B only: 0xE8, E only: 0xE4, neither: 0xE0
//
// Test payloads (0x01, 0x02, etc.) don't match VP9 bitstream keyframe
// pattern (frame_marker != 0b10), so they are treated as inter-frames (P=1).
// tl0picidx starts at 0 and increments by 1 per frame.
let tests: Vec<(&str, Vec<Vec<u8>>, usize, Vec<Vec<u8>>)> = vec![
("NilPayload", vec![vec![]], 100, vec![]),
("SmallMTU", vec![vec![0x00, 0x00]], 1, vec![]),
("NegativeMTU", vec![vec![0x00, 0x00]], 0, vec![]),
(
// Inter-frame, single packet: B+E set, tl0picidx=1
"OnePacket",
vec![vec![0x01, 0x02]],
10,
vec![vec![0xEC, rands[0][0], rands[0][1], 0x10, 0x01, 0x01, 0x02]],
),
(
// Inter-frame, 2 packets: MTU=9 → max_frag=1, tl0picidx=1
"TwoPackets",
vec![vec![0x01, 0x02]],
9,
vec![
vec![0xE8, rands[0][0], rands[0][1], 0x10, 0x01, 0x01],
vec![0xE4, rands[0][0], rands[0][1], 0x10, 0x01, 0x02],
],
),
(
// Inter-frame, 3 packets: MTU=9 → max_frag=1, tl0picidx=1
"ThreePackets",
vec![vec![0x01, 0x02, 0x03]],
9,
vec![
vec![0xE8, rands[0][0], rands[0][1], 0x10, 0x01, 0x01],
vec![0xE0, rands[0][0], rands[0][1], 0x10, 0x01, 0x02],
vec![0xE4, rands[0][0], rands[0][1], 0x10, 0x01, 0x03],
],
),
(
// Two inter-frames: frame1 tl0picidx=1, frame2 tl0picidx=2
"TwoFramesFourPackets",
vec![vec![0x01, 0x02, 0x03], vec![0x04]],
10,
vec![
vec![0xE8, rands[0][0], rands[0][1], 0x10, 0x01, 0x01, 0x02],
vec![0xE4, rands[0][0], rands[0][1], 0x10, 0x01, 0x03],
vec![0xEC, rands[1][0], rands[1][1], 0x10, 0x02, 0x04],
],
),
];
for (name, bs, mtu, expected) in tests {
let mut pck = Vp9Packetizer {
initial_picture_id: 8692,
..Default::default()
};
let mut actual = vec![];
for b in &bs {
actual.extend(pck.packetize(mtu, b)?);
}
assert_eq!(expected, actual, "{name}: Payloaded packet");
}
//"PictureIDOverflow"
{
let mut pck = Vp9Packetizer {
initial_picture_id: 8692,
..Default::default()
};
let mut p_prev = Vp9Depacketizer::default();
for i in 0..0x8000 {
let res = pck.packetize(9, &[0x01])?;
let mut p = Vp9Depacketizer::default();
let mut payload = Vec::new();
let mut extra = CodecExtra::None;
p.depacketize(&res[0], &mut payload, &mut extra)?;
if i > 0 {
if p_prev.picture_id == 0x7FFF {
assert_eq!(
p.picture_id, 0,
"Picture ID next to 0x7FFF must be 0, got {}",
p.picture_id
);
} else if p_prev.picture_id + 1 != p.picture_id {
panic!(
"Picture ID next must be incremented by 1: {} -> {}",
p_prev.picture_id, p.picture_id,
);
}
}
p_prev = p;
}
}
Ok(())
}
#[test]
fn test_vp9_packetizer_keyframe() -> Result<(), PacketError> {
let mut pck = Vp9Packetizer {
initial_picture_id: 100,
..Default::default()
};
// VP9 profile 0 keyframe bitstream: 0x82 = 0b10_00_0_0_10
// frame_marker=10, profile=00, show_existing=0, frame_type=0 (KEY)
let keyframe = vec![0x82, 0xAA, 0xBB];
let packets = pck.packetize(20, &keyframe)?;
assert_eq!(packets.len(), 1);
let pkt = &packets[0];
// Flags: I=1,P=0,L=1,F=0,B=1,E=1,V=1,Z=0 = 0xAE
assert_eq!(pkt[0], 0xAE, "Keyframe flags should be 0xAE");
// PID
assert_eq!(pkt[1], (100 >> 8) as u8 | 0x80);
assert_eq!(pkt[2], 100 & 0xFF);
// L byte: TID=0, U=1, SID=0, D=0
assert_eq!(pkt[3], 0x10);
// tl0picidx = 1 (first frame)
assert_eq!(pkt[4], 1);
// SS: N_S=0, Y=0, G=1 → 0x08
assert_eq!(pkt[5], 0x08);
// N_G=1
assert_eq!(pkt[6], 0x01);
// GOF[0]: TID=0, U=0, R=0
assert_eq!(pkt[7], 0x00);
// Payload
assert_eq!(&pkt[8..], &keyframe[..]);
// Now an inter-frame: 0x84 = 0b10_00_0_1_00 (frame_type=1)
let inter = vec![0x84, 0xCC];
let packets = pck.packetize(20, &inter)?;
assert_eq!(packets.len(), 1);
let pkt = &packets[0];
// Flags: I=1,P=1,L=1,F=0,B=1,E=1,V=0,Z=0 = 0xEC
assert_eq!(pkt[0], 0xEC, "Inter-frame flags should be 0xEC");
// tl0picidx = 2 (second frame, both TID=0 so both increment)
assert_eq!(pkt[4], 2);
// No SS data — payload starts at byte 5
assert_eq!(&pkt[5..], &inter[..]);
Ok(())
}
#[test]
fn test_vp9_packetizer_fragmented_keyframe() -> Result<(), PacketError> {
let mut pck = Vp9Packetizer {
initial_picture_id: 50,
..Default::default()
};
// VP9 profile 0 keyframe: 0x82 = frame_marker=10, profile=00, show_existing=0, frame_type=0
// 10 bytes of payload, MTU=12 → max_frag = 12 - 8 = 4
// First packet: 8-byte header (with SS) + 4 bytes payload = 12 ≤ MTU
// Second packet: 5-byte header + 4 bytes payload = 9 ≤ MTU
// Third packet: 5-byte header + 2 bytes payload = 7 ≤ MTU
let keyframe = vec![0x82, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09];
let packets = pck.packetize(12, &keyframe)?;
assert_eq!(
packets.len(),
3,
"10-byte keyframe at MTU=12 should produce 3 packets"
);
// Packet 1: B=1, E=0, V=1 (keyframe first)
// Flags: I=1,P=0,L=1,F=0,B=1,E=0,V=1,Z=0 = 0xAA
assert_eq!(packets[0][0], 0xAA);
assert_eq!(packets[0].len(), 12); // 8-byte header + 4-byte payload
assert_eq!(packets[0][3], 0x10); // L byte
assert_eq!(packets[0][4], 1); // tl0picidx
assert_eq!(packets[0][5], 0x08); // SS byte 1
assert_eq!(packets[0][6], 0x01); // SS byte 2 (N_G)
assert_eq!(packets[0][7], 0x00); // SS byte 3 (GOF[0])
assert_eq!(&packets[0][8..], &keyframe[0..4]); // payload
// Packet 2: B=0, E=0, V=0 (middle)
// Flags: I=1,P=0,L=1,F=0,B=0,E=0,V=0,Z=0 = 0xA0
assert_eq!(packets[1][0], 0xA0);
assert_eq!(packets[1].len(), 9); // 5-byte header + 4-byte payload
assert_eq!(packets[1][4], 1); // same tl0picidx
assert_eq!(&packets[1][5..], &keyframe[4..8]);
// Packet 3: B=0, E=1, V=0 (last)
// Flags: I=1,P=0,L=1,F=0,B=0,E=1,V=0,Z=0 = 0xA4
assert_eq!(packets[2][0], 0xA4);
assert_eq!(packets[2].len(), 7); // 5-byte header + 2-byte payload
assert_eq!(&packets[2][5..], &keyframe[8..10]);
// Verify none exceed MTU
for (i, pkt) in packets.iter().enumerate() {
assert!(
pkt.len() <= 12,
"Packet {i} exceeds MTU: {} > 12",
pkt.len()
);
}
// Verify depacketizer round-trip: all 3 packets produce original payload
let mut full_payload = Vec::new();
let mut extra = CodecExtra::None;
for pkt in &packets {
let mut depkt = Vp9Depacketizer::default();
depkt.depacketize(pkt, &mut full_payload, &mut extra)?;
}
assert_eq!(full_payload, keyframe);
Ok(())
}
#[test]
fn test_vp9_tl0picidx_wrapping() -> Result<(), PacketError> {
let mut pck = Vp9Packetizer {
initial_picture_id: 0,
tl0picidx: 254, // Start near wrap point
..Default::default()
};
// Frame 1: tl0picidx wraps 254 → 255
let packets = pck.packetize(20, &[0x01])?;
assert_eq!(packets[0][4], 255);
// Frame 2: tl0picidx wraps 255 → 0
let packets = pck.packetize(20, &[0x01])?;
assert_eq!(packets[0][4], 0);
// Frame 3: 0 → 1
let packets = pck.packetize(20, &[0x01])?;
assert_eq!(packets[0][4], 1);
Ok(())
}
#[test]
fn test_vp9_packetizer_flexible_mode() -> Result<(), PacketError> {
let mut r0 = 8692;
let mut rands = vec![];
for _ in 0..10 {
rands.push(vec![(r0 >> 8) as u8 | 0x80, (r0 & 0xFF) as u8]);
r0 += 1;
}
// With VP9_FLEXIBLE_HEADER_SIZE=3, min productive MTU is 4.
// Flexible mode: 3 bytes header (flags + 15-bit PID)
//
// Flags byte: I|P|L|F|B|E|V|Z
// I=1(0x80), F=1(0x10), B=first(0x08), E=last(0x04)
// B+E: 0x80|0x10|0x08|0x04 = 0x9C
// B: 0x80|0x10|0x08 = 0x98
// E: 0x80|0x10|0x04 = 0x94
// none:0x80|0x10 = 0x90
let tests: Vec<(&str, Vec<Vec<u8>>, usize, Vec<Vec<u8>>)> = vec![
("NilPayload", vec![vec![]], 100, vec![]),
("SmallMTU", vec![vec![0x00, 0x00]], 1, vec![]),
("NegativeMTU", vec![vec![0x00, 0x00]], 0, vec![]),
(
"OnePacket",
vec![vec![0x01, 0x02]],
10,
vec![vec![0x9C, rands[0][0], rands[0][1], 0x01, 0x02]],
),
(
// MTU=4 → max_frag=1 → 2 packets
"TwoPackets",
vec![vec![0x01, 0x02]],
4,
vec![
vec![0x98, rands[0][0], rands[0][1], 0x01],
vec![0x94, rands[0][0], rands[0][1], 0x02],
],
),
(
// MTU=4 → max_frag=1 → 3 packets
"ThreePackets",
vec![vec![0x01, 0x02, 0x03]],
4,
vec![
vec![0x98, rands[0][0], rands[0][1], 0x01],
vec![0x90, rands[0][0], rands[0][1], 0x02],
vec![0x94, rands[0][0], rands[0][1], 0x03],
],
),
(
// MTU=5 → max_frag=2 → frame1: 2 pkts, frame2: 1 pkt
"TwoFramesFourPackets",
vec![vec![0x01, 0x02, 0x03], vec![0x04]],
5,
vec![
vec![0x98, rands[0][0], rands[0][1], 0x01, 0x02],
vec![0x94, rands[0][0], rands[0][1], 0x03],
vec![0x9C, rands[1][0], rands[1][1], 0x04],
],
),
];
for (name, bs, mtu, expected) in tests {
let mut pck = Vp9Packetizer {
initial_picture_id: 8692,
mode: Vp9PacketizerMode::Flexible,
..Default::default()
};
let mut actual = vec![];
for b in &bs {
actual.extend(pck.packetize(mtu, b)?);
}
assert_eq!(expected, actual, "{name}: Payloaded packet");
}
Ok(())
}
#[test]
fn test_vp9_packetizer_with_mode() {
let pck = Vp9Packetizer::with_mode(Vp9PacketizerMode::Flexible);
assert_eq!(pck.mode, Vp9PacketizerMode::Flexible);
let pck = Vp9Packetizer::with_mode(Vp9PacketizerMode::NonFlexible);
assert_eq!(pck.mode, Vp9PacketizerMode::NonFlexible);
let pck = Vp9Packetizer::default();
assert_eq!(pck.mode, Vp9PacketizerMode::NonFlexible);
}
#[test]
fn test_detect_vp9_keyframe_bitstream() {
// Empty payload
assert!(!detect_vp9_keyframe_bitstream(&[]));
// Invalid frame_marker (not 0b10)
assert!(!detect_vp9_keyframe_bitstream(&[0x00])); // frame_marker=00
assert!(!detect_vp9_keyframe_bitstream(&[0xC0])); // frame_marker=11
assert!(!detect_vp9_keyframe_bitstream(&[0x40])); // frame_marker=01
// Profile 0 keyframe: 10_00_0_0_xx = 0x80..0x83
assert!(detect_vp9_keyframe_bitstream(&[0x80]));
assert!(detect_vp9_keyframe_bitstream(&[0x82]));
// Profile 0 inter-frame: 10_00_0_1_xx = 0x84..0x87
assert!(!detect_vp9_keyframe_bitstream(&[0x84]));
assert!(!detect_vp9_keyframe_bitstream(&[0x86]));
// Profile 0 show_existing_frame=1: 10_00_1_x_xx = 0x88..0x8F
assert!(!detect_vp9_keyframe_bitstream(&[0x88]));
assert!(!detect_vp9_keyframe_bitstream(&[0x8C]));
// Profile 1 keyframe: 10_10_0_0_xx = 0xA0..0xA3
assert!(detect_vp9_keyframe_bitstream(&[0xA0]));
// Profile 1 inter-frame: 10_10_0_1_xx = 0xA4..0xA7
assert!(!detect_vp9_keyframe_bitstream(&[0xA4]));
// Profile 2 keyframe: 10_01_R_0_0_x
// 0x90 = 10_01_0_0_00 → profile_high=1, show_existing=0, frame_type=0
assert!(detect_vp9_keyframe_bitstream(&[0x90]));
// Profile 2 inter-frame: 10_01_0_0_1_0 = 0x92
assert!(!detect_vp9_keyframe_bitstream(&[0x92]));
}
#[test]
fn test_vp9_partition_head_checker_is_partition_head() -> Result<(), PacketError> {
let vp9 = Vp9Depacketizer::default();
//"SmallPacket"
assert!(
!vp9.is_partition_head(&[]),
"Small packet should not be the head of a new partition"
);
//"NormalPacket"
assert!(
vp9.is_partition_head(&[0x18, 0x00, 0x00]),
"VP9 RTP packet with B flag should be head of a new partition"
);
assert!(
!vp9.is_partition_head(&[0x10, 0x00, 0x00]),
"VP9 RTP packet without B flag should not be head of a new partition"
);
Ok(())
}
#[test]
fn test_detect_vp9_keyframe() {
// Empty payload
assert!(!detect_vp9_keyframe(&[]));
// VP9 RTP descriptor byte 0: I|P|L|F|B|E|V|Z
// P=0 (bit 6 clear) → keyframe
// P=1 (bit 6 set) → inter-frame
// Keyframes (P=0)
assert!(detect_vp9_keyframe(&[0x80])); // I=1
assert!(detect_vp9_keyframe(&[0xA0])); // I=1, L=1
assert!(detect_vp9_keyframe(&[0xAE])); // I=1, L=1, B=1, E=1, V=1
assert!(detect_vp9_keyframe(&[0x00])); // all flags clear
// Inter-frames (P=1)
assert!(!detect_vp9_keyframe(&[0xE8])); // I=1, P=1, L=1, B=1
assert!(!detect_vp9_keyframe(&[0xEC])); // I=1, P=1, L=1, B=1, E=1
assert!(!detect_vp9_keyframe(&[0x40])); // P=1 only
assert!(!detect_vp9_keyframe(&[0xD5])); // I=1, P=1, F=1, E=1, Z=1
}
}