frame-header 0.2.0

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

#[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)]
pub enum Endianness {
    LittleEndian,
    BigEndian,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)]
pub enum EncodingFlag {
    PCMSigned = 0,
    PCMFloat = 1,
    Opus = 2,
    FLAC = 3,
    AAC = 4,
    H264 = 5,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct FrameHeader {
    encoding: EncodingFlag,
    sample_size: u16,
    sample_rate: u32,
    channels: u8,
    bits_per_sample: u8,
    endianness: Endianness,

    #[cfg(not(target_arch = "wasm32"))]
    id: Option<u64>,
    pts: Option<u64>,

    #[cfg(target_arch = "wasm32")]
    #[serde(
        serialize_with = "serialize_id_wasm",
        deserialize_with = "deserialize_id_wasm"
    )]
    id: Option<u64>,
}

#[cfg(target_arch = "wasm32")]
fn serialize_id_wasm<S>(id: &Option<u64>, serializer: S) -> Result<S::Ok, S::Error>
where
    S: serde::Serializer,
{
    match id {
        Some(value) => serializer.serialize_some(&value.to_string()),
        None => serializer.serialize_none(),
    }
}

#[cfg(target_arch = "wasm32")]
fn deserialize_id_wasm<'de, D>(deserializer: D) -> Result<Option<u64>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    use serde::de::Error;
    let id: Option<String> = Option::deserialize(deserializer)?;
    match id {
        Some(id_str) => id_str.parse::<u64>().map(Some).map_err(D::Error::custom),
        None => Ok(None),
    }
}

impl FrameHeader {
    const MAGIC_WORD: u32 = 0x2A;
    const MAGIC_SHIFT: u32 = 26;
    const MAGIC_MASK: u32 = 0x3F << 26;

    const SAMPLE_RATE_SHIFT: u32 = 24;
    const SAMPLE_RATE_MASK: u32 = 0x3 << 24;

    const BITS_SHIFT: u32 = 22;
    const BITS_MASK: u32 = 0x3 << 22;

    const PTS_SHIFT: u32 = 21;
    const PTS_MASK: u32 = 0x1 << 21;

    const ID_SHIFT: u32 = 20;
    const ID_MASK: u32 = 0x1 << 20;

    const ENCODING_SHIFT: u32 = 17;
    const ENCODING_MASK: u32 = 0x7 << 17;

    const ENDIAN_SHIFT: u32 = 16;
    const ENDIAN_MASK: u32 = 0x1 << 16;

    const CHANNELS_SHIFT: u32 = 12;
    const CHANNELS_MASK: u32 = 0xF << 12;

    const SAMPLE_SIZE_MASK: u32 = 0xFFF;

    const VALID_SAMPLE_RATES: [u32; 4] = [16000, 44100, 48000, 96000];
    const MAX_SAMPLE_SIZE: u16 = 0xFFF;

    pub fn new(
        encoding: EncodingFlag,
        sample_size: u16,
        sample_rate: u32,
        channels: u8,
        bits_per_sample: u8,
        endianness: Endianness,
        id: Option<u64>,
        pts: Option<u64>,
    ) -> Result<Self, String> {
        if channels == 0 || channels > 16 {
            return Err("Channel count must be between 1 and 16".to_string());
        }

        match bits_per_sample {
            16 | 24 | 32 => {}
            _ => return Err("Bits per sample must be 16, 24, or 32".to_string()),
        }

        if sample_size > Self::MAX_SAMPLE_SIZE {
            return Err(format!(
                "Sample size exceeds maximum value ({})",
                Self::MAX_SAMPLE_SIZE
            ));
        }

        if !Self::VALID_SAMPLE_RATES.contains(&sample_rate) {
            return Err(format!(
                "Invalid sample rate: {}. Must be one of: {:?}",
                sample_rate,
                Self::VALID_SAMPLE_RATES
            ));
        }

        Ok(FrameHeader {
            encoding,
            sample_size,
            sample_rate,
            channels,
            bits_per_sample,
            endianness,
            id,
            pts,
        })
    }

    pub fn encode<W: Write>(&self, writer: &mut W) -> io::Result<()> {
        let mut header: u32 = Self::MAGIC_WORD << Self::MAGIC_SHIFT;

        let sample_rate_code = match self.sample_rate {
            16000 => 0,
            44100 => 1,
            48000 => 2,
            96000 => 3,
            _ => {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidInput,
                    "Invalid sample rate",
                ))
            }
        };
        header |= sample_rate_code << Self::SAMPLE_RATE_SHIFT;

        let bits_code = match self.bits_per_sample {
            16 => 0,
            24 => 1,
            32 => 2,
            _ => {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidInput,
                    "Invalid bits per sample",
                ))
            }
        };
        header |= bits_code << Self::BITS_SHIFT;

        header |= (self.pts.is_some() as u32) << Self::PTS_SHIFT;
        header |= (self.id.is_some() as u32) << Self::ID_SHIFT;
        header |= (self.encoding as u32) << Self::ENCODING_SHIFT;
        header |= (self.endianness as u32) << Self::ENDIAN_SHIFT;
        header |= ((self.channels - 1) as u32) << Self::CHANNELS_SHIFT;
        header |= self.sample_size as u32;

        writer.write_all(&header.to_be_bytes())?;

        if let Some(id) = self.id {
            writer.write_all(&id.to_be_bytes())?;
        }

        if let Some(pts) = self.pts {
            writer.write_all(&pts.to_be_bytes())?;
        }

        Ok(())
    }

    pub fn decode<R: Read>(reader: &mut R) -> io::Result<Self> {
        let mut header_bytes = [0u8; 4];
        reader.read_exact(&mut header_bytes)?;
        let header = u32::from_be_bytes(header_bytes);

        if (header & Self::MAGIC_MASK) >> Self::MAGIC_SHIFT != Self::MAGIC_WORD {
            return Err(io::Error::new(
                io::ErrorKind::InvalidData,
                "Invalid header magic word",
            ));
        }

        let sample_rate = match (header & Self::SAMPLE_RATE_MASK) >> Self::SAMPLE_RATE_SHIFT {
            0 => 16000,
            1 => 44100,
            2 => 48000,
            3 => 96000,
            _ => {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidData,
                    "Invalid sample rate code",
                ))
            }
        };

        let bits_per_sample = match (header & Self::BITS_MASK) >> Self::BITS_SHIFT {
            0 => 16,
            1 => 24,
            2 => 32,
            _ => {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidData,
                    "Invalid bits per sample code",
                ))
            }
        };

        let has_pts = (header & Self::PTS_MASK) >> Self::PTS_SHIFT == 1;
        let has_id = (header & Self::ID_MASK) >> Self::ID_SHIFT == 1;

        let encoding = match (header & Self::ENCODING_MASK) >> Self::ENCODING_SHIFT {
            0 => EncodingFlag::PCMSigned,
            1 => EncodingFlag::PCMFloat,
            2 => EncodingFlag::Opus,
            3 => EncodingFlag::FLAC,
            4 => EncodingFlag::AAC,
            _ => {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidData,
                    "Invalid encoding flag",
                ))
            }
        };

        let endianness = if (header & Self::ENDIAN_MASK) >> Self::ENDIAN_SHIFT == 0 {
            Endianness::LittleEndian
        } else {
            Endianness::BigEndian
        };

        let channels = (((header & Self::CHANNELS_MASK) >> Self::CHANNELS_SHIFT) + 1) as u8;
        let sample_size = (header & Self::SAMPLE_SIZE_MASK) as u16;

        let id = if has_id {
            let mut id_bytes = [0u8; 8];
            reader.read_exact(&mut id_bytes)?;
            Some(u64::from_be_bytes(id_bytes))
        } else {
            None
        };

        let pts = if has_pts {
            let mut pts_bytes = [0u8; 8];
            reader.read_exact(&mut pts_bytes)?;
            Some(u64::from_be_bytes(pts_bytes))
        } else {
            None
        };

        Ok(FrameHeader {
            encoding,
            sample_size,
            sample_rate,
            channels,
            bits_per_sample,
            endianness,
            id,
            pts,
        })
    }

    pub fn validate_header(header_bytes: &[u8]) -> Result<bool, String> {
        if header_bytes.len() < 4 {
            return Err("Header too small".to_string());
        }

        let header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());

        if (header & Self::MAGIC_MASK) >> Self::MAGIC_SHIFT != Self::MAGIC_WORD {
            return Ok(false);
        }

        let encoding = (header & Self::ENCODING_MASK) >> Self::ENCODING_SHIFT;
        if encoding > 4 {
            return Ok(false);
        }

        let sample_rate_code = (header & Self::SAMPLE_RATE_MASK) >> Self::SAMPLE_RATE_SHIFT;
        if sample_rate_code > 3 {
            return Ok(false);
        }

        let channels = (((header & Self::CHANNELS_MASK) >> Self::CHANNELS_SHIFT) + 1) as u8;
        if channels == 0 || channels > 16 {
            return Ok(false);
        }

        let bits_code = (header & Self::BITS_MASK) >> Self::BITS_SHIFT;
        if bits_code > 2 {
            return Ok(false);
        }

        Ok(true)
    }

    pub fn size(&self) -> usize {
        4 + // Base header
        (self.id.is_some() as usize) * 8 + // Optional ID
        (self.pts.is_some() as usize) * 8 // Optional PTS
    }

    // Getter methods
    pub fn encoding(&self) -> &EncodingFlag {
        &self.encoding
    }

    pub fn sample_size(&self) -> u16 {
        self.sample_size
    }

    pub fn sample_rate(&self) -> u32 {
        self.sample_rate
    }

    pub fn channels(&self) -> u8 {
        self.channels
    }

    pub fn bits_per_sample(&self) -> u8 {
        self.bits_per_sample
    }

    pub fn endianness(&self) -> &Endianness {
        &self.endianness
    }

    pub fn id(&self) -> Option<u64> {
        self.id
    }

    pub fn pts(&self) -> Option<u64> {
        self.pts
    }

    // Extract methods
    pub fn extract_sample_count(header_bytes: &[u8]) -> Result<u16, String> {
        if header_bytes.len() < 4 {
            return Err("Header too small".to_string());
        }

        let header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());

        if (header & Self::MAGIC_MASK) >> Self::MAGIC_SHIFT != Self::MAGIC_WORD {
            return Err("Invalid magic word".to_string());
        }

        Ok((header & Self::SAMPLE_SIZE_MASK) as u16)
    }

    pub fn extract_encoding(header_bytes: &[u8]) -> Result<EncodingFlag, String> {
        if header_bytes.len() < 4 {
            return Err("Header too small".to_string());
        }

        let header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());

        if (header & Self::MAGIC_MASK) >> Self::MAGIC_SHIFT != Self::MAGIC_WORD {
            return Err("Invalid magic word".to_string());
        }

        match (header & Self::ENCODING_MASK) >> Self::ENCODING_SHIFT {
            0 => Ok(EncodingFlag::PCMSigned),
            1 => Ok(EncodingFlag::PCMFloat),
            2 => Ok(EncodingFlag::Opus),
            3 => Ok(EncodingFlag::FLAC),
            4 => Ok(EncodingFlag::AAC),
            _ => Err("Invalid encoding flag".to_string()),
        }
    }

    pub fn extract_id(header_bytes: &[u8]) -> Result<Option<u64>, String> {
        if header_bytes.len() < 4 {
            return Err("Header too small".to_string());
        }

        let header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());

        if (header & Self::MAGIC_MASK) >> Self::MAGIC_SHIFT != Self::MAGIC_WORD {
            return Err("Invalid magic word".to_string());
        }

        if (header & Self::ID_MASK) >> Self::ID_SHIFT == 0 {
            return Ok(None);
        }

        if header_bytes.len() < 12 {
            return Err("Header indicates ID present but buffer too small".to_string());
        }

        Ok(Some(u64::from_be_bytes(
            header_bytes[4..12].try_into().unwrap(),
        )))
    }

    pub fn extract_pts(header_bytes: &[u8]) -> Result<Option<u64>, String> {
        if header_bytes.len() < 4 {
            return Err("Header too small".to_string());
        }

        let header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());

        if (header & Self::MAGIC_MASK) >> Self::MAGIC_SHIFT != Self::MAGIC_WORD {
            return Err("Invalid magic word".to_string());
        }

        let has_pts = (header & Self::PTS_MASK) >> Self::PTS_SHIFT == 1;
        if !has_pts {
            return Ok(None);
        }

        let has_id = (header & Self::ID_MASK) >> Self::ID_SHIFT == 1;
        let pts_offset = 4 + if has_id { 8 } else { 0 };

        if header_bytes.len() < pts_offset + 8 {
            return Err("Header indicates PTS present but buffer too small".to_string());
        }

        Ok(Some(u64::from_be_bytes(
            header_bytes[pts_offset..pts_offset + 8].try_into().unwrap(),
        )))
    }

    // Patch methods
    pub fn patch_bits_per_sample(header_bytes: &mut [u8], bits: u8) -> Result<(), String> {
        if !Self::validate_header(header_bytes)? {
            return Err("Invalid header".to_string());
        }

        let bits_code = match bits {
            16 => 0,
            24 => 1,
            32 => 2,
            _ => return Err("Bits per sample must be 16, 24, or 32".to_string()),
        };

        let mut header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());
        header &= !Self::BITS_MASK;
        header |= (bits_code << Self::BITS_SHIFT) & Self::BITS_MASK;
        header_bytes[..4].copy_from_slice(&header.to_be_bytes());
        Ok(())
    }

    pub fn patch_sample_size(header_bytes: &mut [u8], new_sample_size: u16) -> Result<(), String> {
        if !Self::validate_header(header_bytes)? {
            return Err("Invalid header".to_string());
        }

        if new_sample_size > Self::MAX_SAMPLE_SIZE {
            return Err(format!(
                "Sample size exceeds maximum value ({})",
                Self::MAX_SAMPLE_SIZE
            ));
        }

        let mut header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());
        header &= !Self::SAMPLE_SIZE_MASK;
        header |= new_sample_size as u32;
        header_bytes[..4].copy_from_slice(&header.to_be_bytes());
        Ok(())
    }

    pub fn patch_encoding(header_bytes: &mut [u8], encoding: EncodingFlag) -> Result<(), String> {
        if !Self::validate_header(header_bytes)? {
            return Err("Invalid header".to_string());
        }

        let mut header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());
        header &= !Self::ENCODING_MASK;
        header |= ((encoding as u32) << Self::ENCODING_SHIFT) & Self::ENCODING_MASK;
        header_bytes[..4].copy_from_slice(&header.to_be_bytes());
        Ok(())
    }

    pub fn patch_sample_rate(header_bytes: &mut [u8], sample_rate: u32) -> Result<(), String> {
        if !Self::validate_header(header_bytes)? {
            return Err("Invalid header".to_string());
        }

        let rate_code = match sample_rate {
            16000 => 0,
            44100 => 1,
            48000 => 2,
            96000 => 3,
            _ => {
                return Err(format!(
                    "Invalid sample rate: {}. Must be one of: {:?}",
                    sample_rate,
                    Self::VALID_SAMPLE_RATES
                ))
            }
        };

        let mut header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());
        header &= !Self::SAMPLE_RATE_MASK;
        header |= (rate_code << Self::SAMPLE_RATE_SHIFT) & Self::SAMPLE_RATE_MASK;
        header_bytes[..4].copy_from_slice(&header.to_be_bytes());
        Ok(())
    }

    pub fn patch_channels(header_bytes: &mut [u8], channels: u8) -> Result<(), String> {
        if !Self::validate_header(header_bytes)? {
            return Err("Invalid header".to_string());
        }

        if channels == 0 || channels > 16 {
            return Err("Channel count must be between 1 and 16".to_string());
        }

        let mut header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());
        header &= !Self::CHANNELS_MASK;
        header |= (((channels - 1) as u32) << Self::CHANNELS_SHIFT) & Self::CHANNELS_MASK;
        header_bytes[..4].copy_from_slice(&header.to_be_bytes());
        Ok(())
    }

    pub fn patch_id(header_bytes: &mut [u8], id: Option<u64>) -> Result<(), String> {
        if !Self::validate_header(header_bytes)? {
            return Err("Invalid header".to_string());
        }

        let mut header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());
        header &= !Self::ID_MASK;
        header |= ((id.is_some() as u32) << Self::ID_SHIFT) & Self::ID_MASK;
        header_bytes[..4].copy_from_slice(&header.to_be_bytes());

        if let Some(id_value) = id {
            if header_bytes.len() < 12 {
                return Err("Buffer too small to add ID".to_string());
            }
            header_bytes[4..12].copy_from_slice(&id_value.to_be_bytes());
        }

        Ok(())
    }

    pub fn patch_pts(header_bytes: &mut [u8], pts: Option<u64>) -> Result<(), String> {
        if !Self::validate_header(header_bytes)? {
            return Err("Invalid header".to_string());
        }

        let mut header = u32::from_be_bytes(header_bytes[..4].try_into().unwrap());
        header &= !Self::PTS_MASK;
        header |= ((pts.is_some() as u32) << Self::PTS_SHIFT) & Self::PTS_MASK;

        let has_id = (header & Self::ID_MASK) >> Self::ID_SHIFT == 1;
        let pts_offset = 4 + if has_id { 8 } else { 0 };

        if let Some(pts_value) = pts {
            if header_bytes.len() < pts_offset + 8 {
                return Err("Buffer too small to add PTS".to_string());
            }
            header_bytes[pts_offset..pts_offset + 8].copy_from_slice(&pts_value.to_be_bytes());
        }

        header_bytes[..4].copy_from_slice(&header.to_be_bytes());
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn create_test_header() -> Vec<u8> {
        let header = FrameHeader::new(
            EncodingFlag::PCMSigned,
            1024,
            48000,
            2,
            24,
            Endianness::LittleEndian,
            None,
            None,
        )
        .unwrap();
        let mut buffer = Vec::new();
        header.encode(&mut buffer).unwrap();
        buffer
    }

    fn create_header_with_pts() -> Vec<u8> {
        let header = FrameHeader::new(
            EncodingFlag::PCMSigned,
            1024,
            48000,
            2,
            24,
            Endianness::LittleEndian,
            None,
            Some(0x1234567890ABCDEF),
        )
        .unwrap();
        let mut buffer = Vec::new();
        header.encode(&mut buffer).unwrap();
        buffer
    }

    fn create_header_with_id_and_pts() -> Vec<u8> {
        let header = FrameHeader::new(
            EncodingFlag::PCMSigned,
            1024,
            48000,
            2,
            24,
            Endianness::LittleEndian,
            Some(0xDEADBEEF),
            Some(0xFEEDFACE),
        )
        .unwrap();
        let mut buffer = Vec::new();
        header.encode(&mut buffer).unwrap();
        buffer
    }

    #[test]
    fn test_pts_handling() {
        // Test header with PTS
        let header_bytes = create_header_with_pts();
        assert_eq!(header_bytes.len(), 12); // 4 bytes header + 8 bytes PTS

        let decoded = FrameHeader::decode(&mut &header_bytes[..]).unwrap();
        assert_eq!(decoded.pts(), Some(0x1234567890ABCDEF));
        assert_eq!(decoded.size(), 12);

        // Test header with both ID and PTS
        let header_bytes = create_header_with_id_and_pts();
        assert_eq!(header_bytes.len(), 20); // 4 bytes header + 8 bytes ID + 8 bytes PTS

        let decoded = FrameHeader::decode(&mut &header_bytes[..]).unwrap();
        assert_eq!(decoded.id(), Some(0xDEADBEEF));
        assert_eq!(decoded.pts(), Some(0xFEEDFACE));
        assert_eq!(decoded.size(), 20);

        // Test patching PTS
        let mut header_bytes = create_test_header();
        assert_eq!(header_bytes.len(), 4); // No PTS initially

        let mut extended_bytes = vec![0; 12];
        extended_bytes[..4].copy_from_slice(&header_bytes);

        assert!(FrameHeader::patch_pts(&mut extended_bytes, Some(0xCAFEBABE)).is_ok());
        let updated = FrameHeader::decode(&mut &extended_bytes[..]).unwrap();
        assert_eq!(updated.pts(), Some(0xCAFEBABE));
    }

    #[test]
    fn test_extract_pts() {
        // Test header with PTS
        let header_with_pts = create_header_with_pts();
        let pts = FrameHeader::extract_pts(&header_with_pts).unwrap();
        assert_eq!(pts, Some(0x1234567890ABCDEF));

        // Test header without PTS
        let header_no_pts = create_test_header();
        let pts = FrameHeader::extract_pts(&header_no_pts).unwrap();
        assert_eq!(pts, None);

        // Test invalid cases
        let mut invalid_header = header_with_pts.clone();
        invalid_header[0] = 0; // Corrupt magic word
        assert!(FrameHeader::extract_pts(&invalid_header).is_err());

        // Test truncated header with PTS flag set
        let truncated = header_with_pts[..4].to_vec();
        assert!(FrameHeader::extract_pts(&truncated).is_err());
    }

    #[test]
    fn test_encoding_roundtrip_with_pts() {
        let original = FrameHeader::new(
            EncodingFlag::Opus,
            2048,
            48000,
            8,
            16,
            Endianness::LittleEndian,
            Some(0xDEADBEEF),
            Some(0xCAFEBABE),
        )
        .unwrap();

        let mut buffer = Vec::new();
        original.encode(&mut buffer).unwrap();

        let decoded = FrameHeader::decode(&mut &buffer[..]).unwrap();

        assert_eq!(decoded.pts(), original.pts());
        assert_eq!(decoded.id(), original.id());
        assert_eq!(decoded.size(), original.size());
        assert_eq!(buffer.len(), decoded.size());
    }

    #[test]
    fn test_patch_operations() {
        let mut header_bytes = create_test_header();

        // Test sample size patching
        assert!(FrameHeader::patch_sample_size(&mut header_bytes, 2048).is_ok());
        let updated = FrameHeader::decode(&mut &header_bytes[..]).unwrap();
        assert_eq!(updated.sample_size(), 2048);

        // Test encoding patching
        assert!(FrameHeader::patch_encoding(&mut header_bytes, EncodingFlag::FLAC).is_ok());
        let updated = FrameHeader::decode(&mut &header_bytes[..]).unwrap();
        assert_eq!(*updated.encoding(), EncodingFlag::FLAC);

        // Test sample rate patching
        assert!(FrameHeader::patch_sample_rate(&mut header_bytes, 96000).is_ok());
        let updated = FrameHeader::decode(&mut &header_bytes[..]).unwrap();
        assert_eq!(updated.sample_rate(), 96000);

        // Test bits per sample patching
        assert!(FrameHeader::patch_bits_per_sample(&mut header_bytes, 32).is_ok());
        let updated = FrameHeader::decode(&mut &header_bytes[..]).unwrap();
        assert_eq!(updated.bits_per_sample(), 32);

        // Test channels patching
        assert!(FrameHeader::patch_channels(&mut header_bytes, 16).is_ok());
        let updated = FrameHeader::decode(&mut &header_bytes[..]).unwrap();
        assert_eq!(updated.channels(), 16);

        // Test PTS patching
        let mut extended_bytes = vec![0; 20]; // Enough space for header + id + pts
        extended_bytes[..header_bytes.len()].copy_from_slice(&header_bytes);
        assert!(FrameHeader::patch_pts(&mut extended_bytes, Some(0xCAFEBABE)).is_ok());
        let updated = FrameHeader::decode(&mut &extended_bytes[..]).unwrap();
        assert_eq!(updated.pts(), Some(0xCAFEBABE));
    }

    #[test]
    fn test_extract_operations() {
        let header_bytes = create_header_with_id_and_pts();

        assert_eq!(
            FrameHeader::extract_sample_count(&header_bytes).unwrap(),
            1024
        );
        assert_eq!(
            FrameHeader::extract_encoding(&header_bytes).unwrap(),
            EncodingFlag::PCMSigned
        );
        assert_eq!(
            FrameHeader::extract_id(&header_bytes).unwrap(),
            Some(0xDEADBEEF)
        );
        assert_eq!(
            FrameHeader::extract_pts(&header_bytes).unwrap(),
            Some(0xFEEDFACE)
        );

        // Test with invalid header
        let mut invalid_header = header_bytes.clone();
        invalid_header[0] = 0; // Corrupt magic word
        assert!(FrameHeader::extract_sample_count(&invalid_header).is_err());
        assert!(FrameHeader::extract_encoding(&invalid_header).is_err());
        assert!(FrameHeader::extract_id(&invalid_header).is_err());
        assert!(FrameHeader::extract_pts(&invalid_header).is_err());
    }

    #[test]
    fn test_patch_validation() {
        let mut header_bytes = create_test_header();

        // Test invalid sample size
        assert!(FrameHeader::patch_sample_size(&mut header_bytes, 5000).is_err());

        // Test invalid sample rate
        assert!(FrameHeader::patch_sample_rate(&mut header_bytes, 192000).is_err());

        // Test invalid channels
        assert!(FrameHeader::patch_channels(&mut header_bytes, 17).is_err());
        assert!(FrameHeader::patch_channels(&mut header_bytes, 0).is_err());

        // Test invalid bits per sample
        assert!(FrameHeader::patch_bits_per_sample(&mut header_bytes, 20).is_err());
    }

    #[test]
    fn test_sample_size_extraction() {
        let header = FrameHeader::new(
            EncodingFlag::PCMSigned,
            1024,
            48000,
            2,
            24,
            Endianness::LittleEndian,
            None,
            None,
        )
        .unwrap();

        let mut buffer = Vec::new();
        header.encode(&mut buffer).unwrap();

        let extracted = FrameHeader::extract_sample_count(&buffer).unwrap();
        assert_eq!(extracted, 1024, "Sample size extraction failed");

        // Now test with a decoded header to verify consistency
        let decoded = FrameHeader::decode(&mut &buffer[..]).unwrap();
        assert_eq!(decoded.sample_size(), 1024, "Sample size decode failed");
    }

    //This test ensures field boundaries by setting each field to its maximum value and verifying no corruption.
    #[test]
    fn test_bit_layout() {
        let header = FrameHeader::new(
            EncodingFlag::PCMSigned, // 000
            0xFFF,                   // 111111111111
            48000,                   // 01
            16,                      // 1111
            32,                      // 10
            Endianness::BigEndian,   // 1
            Some(1),                 // 1
            Some(1),                 // 1
        )
        .unwrap();

        let mut buffer = Vec::new();
        header.encode(&mut buffer).unwrap();
        let decoded = FrameHeader::decode(&mut &buffer[..]).unwrap();

        // Verify max values are preserved
        assert_eq!(decoded.sample_size(), 0xFFF);
        assert_eq!(decoded.channels(), 16);
        assert_eq!(decoded.bits_per_sample(), 32);
        assert_eq!(decoded.endianness(), &Endianness::BigEndian);
        assert!(decoded.id().is_some());
        assert!(decoded.pts().is_some());
    }
    #[test]
    fn test_valid_opus_and_flac_sample_sizes_with_varied_pts_and_ids() {
        let opus_sample_sizes = [80, 160, 240, 480, 960, 1920, 2880];
        let flac_sample_sizes = [512, 1024, 2048];
        let sample_rates = [16000, 44100, 48000, 96000];
        let channels_list = [1, 2, 8, 16];
        let bits_list = [16, 24, 32];
        let endianness_list = [Endianness::LittleEndian, Endianness::BigEndian];
        let pts_values = [
            1_670_000_000_000_000,
            1_671_000_000_000_000,
            1_672_000_000_000_000,
            1_673_000_000_000_000,
            1_674_000_000_000_000,
            1_675_000_000_000_000,
        ];
        let id_values = [
            0xFFFFFFFFFFFFFFFF,
            0x0123456789ABCDEF,
            0xDEADBEEFDEADBEEF,
            0,
            1,
            42,
        ];
        for &encoding in &[EncodingFlag::Opus, EncodingFlag::FLAC] {
            let sample_sizes: &[u16] = match encoding {
                EncodingFlag::Opus => &opus_sample_sizes,
                EncodingFlag::FLAC => &flac_sample_sizes,
                _ => continue,
            };
            for &sample_size in sample_sizes {
                for &sample_rate in &sample_rates {
                    for &channels in &channels_list {
                        for &bits in &bits_list {
                            for &endianness in &endianness_list {
                                for &id_val in &id_values {
                                    for &pts_val in &pts_values {
                                        let header = FrameHeader::new(
                                            encoding,
                                            sample_size,
                                            sample_rate,
                                            channels,
                                            bits,
                                            endianness,
                                            Some(id_val),
                                            Some(pts_val),
                                        );

                                        assert!(
                                        header.is_ok(),
                                        "Failed to create header for encoding: {:?}, sample_size: {}, sample_rate: {}, channels: {}, bits: {}, endianness: {:?}, id: {:?}, pts: {:?}",
                                        encoding, sample_size, sample_rate, channels, bits, endianness, id_val, pts_val
                                    );

                                        let header = header.unwrap();
                                        let mut buffer = Vec::new();

                                        assert!(
                                        header.encode(&mut buffer).is_ok(),
                                        "Failed to encode header for encoding: {:?}, sample_size: {}, sample_rate: {}, channels: {}, bits: {}, endianness: {:?}, id: {:?}, pts: {:?}",
                                        encoding, sample_size, sample_rate, channels, bits, endianness, id_val, pts_val
                                    );

                                        let decoded = FrameHeader::decode(&mut &buffer[..]);

                                        assert!(
                                        decoded.is_ok(),
                                        "Failed to decode header for encoding: {:?}, sample_size: {}, sample_rate: {}, channels: {}, bits: {}, endianness: {:?}, id: {:?}, pts: {:?}",
                                        encoding, sample_size, sample_rate, channels, bits, endianness, id_val, pts_val
                                    );

                                        let decoded = decoded.unwrap();
                                        assert_eq!(*decoded.encoding(), encoding);
                                        assert_eq!(decoded.sample_size(), sample_size);
                                        assert_eq!(decoded.sample_rate(), sample_rate);
                                        assert_eq!(decoded.channels(), channels);
                                        assert_eq!(decoded.bits_per_sample(), bits);
                                        assert_eq!(*decoded.endianness(), endianness);
                                        assert_eq!(decoded.id(), Some(id_val));
                                        assert_eq!(decoded.pts(), Some(pts_val));
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }

    #[test]
    fn test_patch_field_isolation() {
        // Create a header with known values for all fields
        let original = FrameHeader::new(
            EncodingFlag::PCMSigned,
            1024,
            48000,
            4,
            24,
            Endianness::LittleEndian,
            Some(0xDEADBEEF),
            Some(0xCAFEBABE),
        )
        .unwrap();

        let mut buffer = Vec::new();
        original.encode(&mut buffer).unwrap();

        // Test sample size patching
        let mut test_buffer = buffer.clone();
        FrameHeader::patch_sample_size(&mut test_buffer, 2048).unwrap();
        let updated = FrameHeader::decode(&mut &test_buffer[..]).unwrap();
        assert_eq!(updated.sample_size(), 2048); // Changed field
        assert_eq!(*updated.encoding(), *original.encoding());
        assert_eq!(updated.sample_rate(), original.sample_rate());
        assert_eq!(updated.channels(), original.channels());
        assert_eq!(updated.bits_per_sample(), original.bits_per_sample());
        assert_eq!(*updated.endianness(), *original.endianness());
        assert_eq!(updated.id(), original.id());
        assert_eq!(updated.pts(), original.pts());

        // Test encoding patching
        let mut test_buffer = buffer.clone();
        FrameHeader::patch_encoding(&mut test_buffer, EncodingFlag::FLAC).unwrap();
        let updated = FrameHeader::decode(&mut &test_buffer[..]).unwrap();
        assert_eq!(*updated.encoding(), EncodingFlag::FLAC); // Changed field
        assert_eq!(updated.sample_size(), original.sample_size());
        assert_eq!(updated.sample_rate(), original.sample_rate());
        assert_eq!(updated.channels(), original.channels());
        assert_eq!(updated.bits_per_sample(), original.bits_per_sample());
        assert_eq!(*updated.endianness(), *original.endianness());
        assert_eq!(updated.id(), original.id());
        assert_eq!(updated.pts(), original.pts());

        // Test sample rate patching
        let mut test_buffer = buffer.clone();
        FrameHeader::patch_sample_rate(&mut test_buffer, 96000).unwrap();
        let updated = FrameHeader::decode(&mut &test_buffer[..]).unwrap();
        assert_eq!(updated.sample_rate(), 96000); // Changed field
        assert_eq!(*updated.encoding(), *original.encoding());
        assert_eq!(updated.sample_size(), original.sample_size());
        assert_eq!(updated.channels(), original.channels());
        assert_eq!(updated.bits_per_sample(), original.bits_per_sample());
        assert_eq!(*updated.endianness(), *original.endianness());
        assert_eq!(updated.id(), original.id());
        assert_eq!(updated.pts(), original.pts());

        // Test bits per sample patching
        let mut test_buffer = buffer.clone();
        FrameHeader::patch_bits_per_sample(&mut test_buffer, 32).unwrap();
        let updated = FrameHeader::decode(&mut &test_buffer[..]).unwrap();
        assert_eq!(updated.bits_per_sample(), 32); // Changed field
        assert_eq!(*updated.encoding(), *original.encoding());
        assert_eq!(updated.sample_size(), original.sample_size());
        assert_eq!(updated.sample_rate(), original.sample_rate());
        assert_eq!(updated.channels(), original.channels());
        assert_eq!(*updated.endianness(), *original.endianness());
        assert_eq!(updated.id(), original.id());
        assert_eq!(updated.pts(), original.pts());

        // Test channels patching
        let mut test_buffer = buffer.clone();
        FrameHeader::patch_channels(&mut test_buffer, 8).unwrap();
        let updated = FrameHeader::decode(&mut &test_buffer[..]).unwrap();
        assert_eq!(updated.channels(), 8); // Changed field
        assert_eq!(*updated.encoding(), *original.encoding());
        assert_eq!(updated.sample_size(), original.sample_size());
        assert_eq!(updated.sample_rate(), original.sample_rate());
        assert_eq!(updated.bits_per_sample(), original.bits_per_sample());
        assert_eq!(*updated.endianness(), *original.endianness());
        assert_eq!(updated.id(), original.id());
        assert_eq!(updated.pts(), original.pts());

        // Test ID patching
        let mut test_buffer = buffer.clone();
        FrameHeader::patch_id(&mut test_buffer, Some(0xFEEDFACE)).unwrap();
        let updated = FrameHeader::decode(&mut &test_buffer[..]).unwrap();
        assert_eq!(updated.id(), Some(0xFEEDFACE)); // Changed field
        assert_eq!(*updated.encoding(), *original.encoding());
        assert_eq!(updated.sample_size(), original.sample_size());
        assert_eq!(updated.sample_rate(), original.sample_rate());
        assert_eq!(updated.channels(), original.channels());
        assert_eq!(updated.bits_per_sample(), original.bits_per_sample());
        assert_eq!(*updated.endianness(), *original.endianness());
        assert_eq!(updated.pts(), original.pts());

        // Test PTS patching
        let mut test_buffer = buffer.clone();
        FrameHeader::patch_pts(&mut test_buffer, Some(0xF00DFACE)).unwrap();
        let updated = FrameHeader::decode(&mut &test_buffer[..]).unwrap();
        assert_eq!(updated.pts(), Some(0xF00DFACE)); // Changed field
        assert_eq!(*updated.encoding(), *original.encoding());
        assert_eq!(updated.sample_size(), original.sample_size());
        assert_eq!(updated.sample_rate(), original.sample_rate());
        assert_eq!(updated.channels(), original.channels());
        assert_eq!(updated.bits_per_sample(), original.bits_per_sample());
        assert_eq!(*updated.endianness(), *original.endianness());
        assert_eq!(updated.id(), original.id());
    }

    #[test]
    fn test_magic_word_off_by_one() {
        // Create a valid header as base
        let valid_header = FrameHeader::new(
            EncodingFlag::PCMSigned,
            1024,
            48000,
            2,
            24,
            Endianness::LittleEndian,
            None,
            None,
        )
        .unwrap();
        let mut valid_buffer = Vec::new();
        valid_header.encode(&mut valid_buffer).unwrap();

        // Test magic word off by one higher
        let mut buffer = valid_buffer.clone();
        let mut header = u32::from_be_bytes(buffer[..4].try_into().unwrap());
        header = (header & !FrameHeader::MAGIC_MASK)
            | ((FrameHeader::MAGIC_WORD + 1) << FrameHeader::MAGIC_SHIFT);
        buffer[..4].copy_from_slice(&header.to_be_bytes());
        assert!(
            FrameHeader::decode(&mut &buffer[..]).is_err(),
            "Failed to detect magic word too high"
        );
        assert!(
            !FrameHeader::validate_header(&buffer).unwrap(),
            "Validation passed with magic word too high"
        );

        // Test magic word off by one lower
        let mut buffer = valid_buffer.clone();
        let mut header = u32::from_be_bytes(buffer[..4].try_into().unwrap());
        header = (header & !FrameHeader::MAGIC_MASK)
            | ((FrameHeader::MAGIC_WORD - 1) << FrameHeader::MAGIC_SHIFT);
        buffer[..4].copy_from_slice(&header.to_be_bytes());
        assert!(
            FrameHeader::decode(&mut &buffer[..]).is_err(),
            "Failed to detect magic word too low"
        );
        assert!(
            !FrameHeader::validate_header(&buffer).unwrap(),
            "Validation passed with magic word too low"
        );

        // Test magic word shifted right by one bit
        let mut buffer = valid_buffer.clone();
        let mut header = u32::from_be_bytes(buffer[..4].try_into().unwrap());
        header = (header & !FrameHeader::MAGIC_MASK)
            | ((FrameHeader::MAGIC_WORD >> 1) << FrameHeader::MAGIC_SHIFT);
        buffer[..4].copy_from_slice(&header.to_be_bytes());
        assert!(
            FrameHeader::decode(&mut &buffer[..]).is_err(),
            "Failed to detect magic word bit-shifted right"
        );
        assert!(
            !FrameHeader::validate_header(&buffer).unwrap(),
            "Validation passed with magic word bit-shifted right"
        );

        // Test magic word shifted left by one bit
        let mut buffer = valid_buffer.clone();
        let mut header = u32::from_be_bytes(buffer[..4].try_into().unwrap());
        header = (header & !FrameHeader::MAGIC_MASK)
            | ((FrameHeader::MAGIC_WORD << 1) << FrameHeader::MAGIC_SHIFT);
        buffer[..4].copy_from_slice(&header.to_be_bytes());
        assert!(
            FrameHeader::decode(&mut &buffer[..]).is_err(),
            "Failed to detect magic word bit-shifted left"
        );
        assert!(
            !FrameHeader::validate_header(&buffer).unwrap(),
            "Validation passed with magic word bit-shifted left"
        );

        // Test magic word at wrong bit position (shifted by 1 in final header)
        let mut buffer = valid_buffer;
        let mut header = u32::from_be_bytes(buffer[..4].try_into().unwrap());
        header = (header & !FrameHeader::MAGIC_MASK)
            | (FrameHeader::MAGIC_WORD << (FrameHeader::MAGIC_SHIFT + 1));
        buffer[..4].copy_from_slice(&header.to_be_bytes());
        assert!(
            FrameHeader::decode(&mut &buffer[..]).is_err(),
            "Failed to detect magic word at wrong position"
        );
        assert!(
            !FrameHeader::validate_header(&buffer).unwrap(),
            "Validation passed with magic word at wrong position"
        );
    }
}