audio_samples_io 0.2.0

A Rust library for audio input and output operations.
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
//! FLAC frame encoding and decoding.
//!
//! A FLAC frame consists of:
//! - Frame header (sync code, parameters, CRC-8)
//! - One subframe per channel
//! - Padding to byte boundary
//! - Frame footer (CRC-16)

use crate::flac::ChannelAssignment;
use crate::flac::bitstream::{BitReader, BitWriter};
use crate::flac::constants::{
    BITS_PER_SAMPLE_TABLE, BLOCK_SIZE_TABLE, FRAME_SYNC_CODE, SAMPLE_RATE_TABLE,
    bits_per_sample_to_code, block_size_to_code, sample_rate_to_code,
};
use crate::flac::crc::{Crc8, Crc16};
use crate::flac::error::FlacError;
use crate::flac::subframe::{Subframe, decode_subframe, decode_subframe_into};
#[cfg(not(feature = "flac-parallel"))]
use crate::flac::subframe::encode_subframe_into;
#[cfg(feature = "flac-parallel")]
use crate::flac::subframe::{EncodedSubframe, encode_subframe};

/// Decoded frame header.
#[derive(Debug, Clone, Copy)]
pub struct FrameHeader {
    /// Blocking strategy (false = fixed-blocksize, true = variable-blocksize)
    pub variable_blocksize: bool,
    /// Block size in samples
    pub block_size: u32,
    /// Sample rate in Hz
    pub sample_rate: u32,
    /// Channel assignment
    pub channel_assignment: ChannelAssignment,
    /// Bits per sample (from STREAMINFO if 0)
    pub bits_per_sample: u8,
    /// Frame or sample number (depending on blocking strategy)
    pub frame_or_sample_number: u64,
}

/// A decoded FLAC frame.
#[derive(Debug)]
pub struct Frame {
    /// Frame header
    pub header: FrameHeader,
    /// Subframes (one per channel)
    pub subframes: Vec<Subframe>,
}

impl Frame {
    /// Consume the frame and return decoded samples per channel.
    ///
    /// For stereo decorrelation modes (left-side, right-side, mid-side),
    /// this undoes the decorrelation and returns independent channel data.
    ///
    /// Returns a Vec of channels, where each inner Vec contains the samples
    /// for that channel as i32 (FLAC's internal representation).
    pub fn into_channel_samples(self) -> Vec<Vec<i32>> {
        let block_size = self.subframes.first().map(|s| s.samples.len()).unwrap_or(0);

        match self.header.channel_assignment {
            ChannelAssignment::LeftSide => {
                // Left-side: subframe 0 = left, subframe 1 = left - right (side)
                // Restore: right = left - side
                let mut iter = self.subframes.into_iter();
                let left = iter.next().map(|s| s.samples).unwrap_or_default();
                let side = iter.next().map(|s| s.samples).unwrap_or_default();

                let right: Vec<i32> = left.iter().zip(side.iter()).map(|(&l, &s)| l - s).collect();
                vec![left, right]
            }
            ChannelAssignment::RightSide => {
                // Right-side: subframe 0 = left - right (side), subframe 1 = right
                // Restore: left = side + right
                let mut iter = self.subframes.into_iter();
                let side = iter.next().map(|s| s.samples).unwrap_or_default();
                let right = iter.next().map(|s| s.samples).unwrap_or_default();

                let left: Vec<i32> = side
                    .iter()
                    .zip(right.iter())
                    .map(|(&s, &r)| s + r)
                    .collect();
                vec![left, right]
            }
            ChannelAssignment::MidSide => {
                // Mid-side: subframe 0 = mid = (left + right) >> 1, subframe 1 = side = left - right
                // Restore: left = mid + (side + 1) >> 1, right = mid - (side >> 1)
                // More precisely: left = mid + (side >> 1) + (side & 1), right = left - side
                let mut iter = self.subframes.into_iter();
                let mid = iter.next().map(|s| s.samples).unwrap_or_default();
                let side = iter.next().map(|s| s.samples).unwrap_or_default();

                let mut left = Vec::with_capacity(block_size);
                let mut right = Vec::with_capacity(block_size);

                for (&m, &s) in mid.iter().zip(side.iter()) {
                    let l = m + (s >> 1) + (s & 1);
                    let r = l - s;
                    left.push(l);
                    right.push(r);
                }

                vec![left, right]
            }
            ChannelAssignment::Independent(_) => {
                // Independent channels: return as-is
                self.subframes.into_iter().map(|sf| sf.samples).collect()
            }
        }
    }

    /// Get the number of samples per channel in this frame.
    pub fn block_size(&self) -> usize {
        self.subframes.first().map(|s| s.samples.len()).unwrap_or(0)
    }

    /// Get the number of channels in this frame.
    pub const fn num_channels(&self) -> usize {
        self.subframes.len()
    }
}

/// Decode a FLAC frame from the bitstream.
///
/// # Arguments
/// * `data` - Byte slice containing the frame
/// * `streaminfo_sample_rate` - Sample rate from STREAMINFO (fallback)
/// * `streaminfo_bits_per_sample` - Bits per sample from STREAMINFO (fallback)
/// * `streaminfo_channels` - Channel count from STREAMINFO (fallback)
///
/// # Returns
/// Tuple of (decoded frame, bytes consumed)
pub fn decode_frame(
    data: &[u8],
    streaminfo_sample_rate: u32,
    streaminfo_bits_per_sample: u8,
    _streaminfo_channels: u8,
) -> Result<(Frame, usize), FlacError> {
    if data.len() < 6 {
        return Err(FlacError::UnexpectedEof);
    }

    let mut reader = BitReader::new(data);

    // Sync code (14 bits) + reserved (1 bit) + blocking strategy (1 bit)
    let sync = reader.read_bits(14)? as u16;
    if sync != FRAME_SYNC_CODE {
        return Err(FlacError::invalid_frame_sync(sync));
    }

    let reserved = reader.read_bit()?;
    if reserved {
        return Err(FlacError::InvalidFrameSync { found: 0xFFFF });
    }

    let variable_blocksize = reader.read_bit()?;

    // Block size code (4 bits) + sample rate code (4 bits)
    let block_size_code = reader.read_bits(4)? as u8;
    let sample_rate_code = reader.read_bits(4)? as u8;

    // Channel assignment (4 bits) + sample size code (3 bits) + reserved (1 bit)
    let channel_code = reader.read_bits(4)? as u8;
    let sample_size_code = reader.read_bits(3)? as u8;
    let reserved2 = reader.read_bit()?;
    if reserved2 {
        return Err(FlacError::ReservedBitsPerSampleCode);
    }

    // Parse channel assignment
    let channel_assignment = ChannelAssignment::from_code(channel_code)
        .ok_or(FlacError::InvalidChannelAssignment(channel_code))?;

    // Parse sample size
    let bits_per_sample = if sample_size_code == 0 {
        streaminfo_bits_per_sample
    } else if sample_size_code == 0b011 {
        return Err(FlacError::ReservedBitsPerSampleCode);
    } else {
        BITS_PER_SAMPLE_TABLE[sample_size_code as usize]
    };

    // Read frame/sample number (UTF-8 coded)
    let frame_or_sample_number = reader.read_utf8_coded()?;
    // Add UTF-8 bytes to CRC (we need the raw bytes)
    // For now, we'll recalculate from the current position
    // This is a simplification; proper implementation would track bytes

    // Parse block size (may need extra bytes)
    let block_size = match block_size_code {
        0b0000 => return Err(FlacError::ReservedBlockSizeCode),
        0b0110 => reader.read_bits(8)? + 1,
        0b0111 => reader.read_bits(16)? + 1,
        _ => BLOCK_SIZE_TABLE[block_size_code as usize],
    };

    // Parse sample rate (may need extra bytes)
    let sample_rate = match sample_rate_code {
        0b0000 => streaminfo_sample_rate,
        0b1100 => reader.read_bits(8)? * 1000,
        0b1101 => reader.read_bits(16)?,
        0b1110 => reader.read_bits(16)? * 10,
        0b1111 => return Err(FlacError::ReservedSampleRateCode),
        _ => SAMPLE_RATE_TABLE[sample_rate_code as usize],
    };

    // Verify CRC-8 over all header bytes preceding this byte
    let crc8_header_len = reader.byte_position();
    let crc8_expected = reader.read_bits(8)? as u8;
    let crc8_computed = Crc8::compute(&data[..crc8_header_len]);
    if crc8_computed != crc8_expected {
        return Err(FlacError::FrameHeaderCrcMismatch { expected: crc8_expected, computed: crc8_computed });
    }

    let header = FrameHeader {
        variable_blocksize,
        block_size,
        sample_rate,
        channel_assignment,
        bits_per_sample,
        frame_or_sample_number,
    };

    // Decode subframes
    let num_channels = channel_assignment.channels() as usize;
    let mut subframes = Vec::with_capacity(num_channels);

    for ch in 0..num_channels {
        // Adjust bits per sample for stereo decorrelation
        let subframe_bps = match (channel_assignment, ch) {
            (ChannelAssignment::MidSide, 1)|(ChannelAssignment::RightSide, 0)| (ChannelAssignment::LeftSide, 1) => bits_per_sample + 1,
            _ => bits_per_sample,
        };

        let subframe = decode_subframe(&mut reader, block_size as usize, subframe_bps)?;
        subframes.push(subframe);
    }

    // Align to byte boundary (single frame-level padding before CRC-16)
    reader.align_to_byte();

    // Verify CRC-16 over all frame bytes preceding the footer
    let crc16_frame_len = reader.byte_position();
    let crc16_expected = reader.read_bits(16)? as u16;
    let bytes_consumed = reader.byte_position();
    let crc16_computed = Crc16::compute(&data[..crc16_frame_len]);
    if crc16_computed != crc16_expected {
        return Err(FlacError::FrameCrcMismatch { expected: crc16_expected, computed: crc16_computed });
    }

    Ok((Frame { header, subframes }, bytes_consumed))
}

/// Decode a FLAC frame, writing samples directly into pre-allocated channel buffers.
///
/// Eliminates the intermediate `Frame` / `Subframe` structs and all per-subframe
/// `Vec<i32>` allocations. For independent channels, samples are decoded straight
/// into `out_channels[ch]`. For stereo decorrelation modes (left-side, right-side,
/// mid-side), two scratch buffers are used and the decorrelation is applied while
/// appending to `out_channels`.
///
/// Returns the number of bytes consumed from `data`.
pub(crate) fn decode_frame_into_channels(
    data: &[u8],
    streaminfo_sample_rate: u32,
    streaminfo_bits_per_sample: u8,
    _streaminfo_channels: u8,
    out_channels: &mut [Vec<i32>],
    scratch: &mut (Vec<i32>, Vec<i32>),
) -> Result<usize, FlacError> {
    if data.len() < 6 {
        return Err(FlacError::UnexpectedEof);
    }

    let mut reader = BitReader::new(data);

    let sync = reader.read_bits(14)? as u16;
    if sync != FRAME_SYNC_CODE {
        return Err(FlacError::invalid_frame_sync(sync));
    }
    let reserved = reader.read_bit()?;
    if reserved {
        return Err(FlacError::InvalidFrameSync { found: 0xFFFF });
    }
    let _variable_blocksize = reader.read_bit()?;

    let block_size_code = reader.read_bits(4)? as u8;
    let sample_rate_code = reader.read_bits(4)? as u8;
    let channel_code = reader.read_bits(4)? as u8;
    let sample_size_code = reader.read_bits(3)? as u8;
    let reserved2 = reader.read_bit()?;
    if reserved2 {
        return Err(FlacError::ReservedBitsPerSampleCode);
    }

    let channel_assignment = ChannelAssignment::from_code(channel_code)
        .ok_or(FlacError::InvalidChannelAssignment(channel_code))?;

    let bits_per_sample = if sample_size_code == 0 {
        streaminfo_bits_per_sample
    } else if sample_size_code == 0b011 {
        return Err(FlacError::ReservedBitsPerSampleCode);
    } else {
        BITS_PER_SAMPLE_TABLE[sample_size_code as usize]
    };

    let _frame_or_sample_number = reader.read_utf8_coded()?;

    let block_size = match block_size_code {
        0b0000 => return Err(FlacError::ReservedBlockSizeCode),
        0b0110 => reader.read_bits(8)? + 1,
        0b0111 => reader.read_bits(16)? + 1,
        _ => BLOCK_SIZE_TABLE[block_size_code as usize],
    } as usize;

    let _sample_rate = match sample_rate_code {
        0b0000 => streaminfo_sample_rate,
        0b1100 => reader.read_bits(8)? * 1000,
        0b1101 => reader.read_bits(16)?,
        0b1110 => reader.read_bits(16)? * 10,
        0b1111 => return Err(FlacError::ReservedSampleRateCode),
        _ => SAMPLE_RATE_TABLE[sample_rate_code as usize],
    };

    let crc8_header_len = reader.byte_position();
    let crc8_expected = reader.read_bits(8)? as u8;
    let crc8_computed = Crc8::compute(&data[..crc8_header_len]);
    if crc8_computed != crc8_expected {
        return Err(FlacError::FrameHeaderCrcMismatch {
            expected: crc8_expected,
            computed: crc8_computed,
        });
    }

    let num_channels = channel_assignment.channels() as usize;

    match channel_assignment {
        ChannelAssignment::Independent(_) => {
            // Decode directly into the output buffers — zero scratch needed.
            for ch in out_channels.iter_mut().take(num_channels) {
                decode_subframe_into(&mut reader, block_size, bits_per_sample, ch)?;
            }
        }
        ChannelAssignment::LeftSide => {
            // subframe 0 = left (normal bps), subframe 1 = side (bps+1)
            // right = left - side; transform side → right in-place, then bulk copy.
            scratch.0.clear();
            scratch.1.clear();
            decode_subframe_into(&mut reader, block_size, bits_per_sample,     &mut scratch.0)?;
            decode_subframe_into(&mut reader, block_size, bits_per_sample + 1, &mut scratch.1)?;
            for (s, &l) in scratch.1.iter_mut().zip(scratch.0.iter()) {
                *s = l - *s;
            }
            let (a, b) = out_channels.split_at_mut(1);
            a[0].extend_from_slice(&scratch.0);
            b[0].extend_from_slice(&scratch.1);
        }
        ChannelAssignment::RightSide => {
            // subframe 0 = side (bps+1), subframe 1 = right (normal bps)
            // left = side + right; transform side → left in-place, then bulk copy.
            scratch.0.clear();
            scratch.1.clear();
            decode_subframe_into(&mut reader, block_size, bits_per_sample + 1, &mut scratch.0)?;
            decode_subframe_into(&mut reader, block_size, bits_per_sample,     &mut scratch.1)?;
            for (s, &r) in scratch.0.iter_mut().zip(scratch.1.iter()) {
                *s += r;
            }
            let (a, b) = out_channels.split_at_mut(1);
            a[0].extend_from_slice(&scratch.0);
            b[0].extend_from_slice(&scratch.1);
        }
        ChannelAssignment::MidSide => {
            // subframe 0 = mid (normal bps), subframe 1 = side (bps+1)
            // Decorrelate in-place on scratch (L1-hot), then bulk-copy (SIMD memcpy).
            scratch.0.clear();
            scratch.1.clear();
            decode_subframe_into(&mut reader, block_size, bits_per_sample,     &mut scratch.0)?;
            decode_subframe_into(&mut reader, block_size, bits_per_sample + 1, &mut scratch.1)?;
            for (m, s) in scratch.0.iter_mut().zip(scratch.1.iter_mut()) {
                let mid = (*m << 1) | (*s & 1);
                let side = *s;
                *m = (mid + side) >> 1;
                *s = (mid - side) >> 1;
            }
            let (a, b) = out_channels.split_at_mut(1);
            a[0].extend_from_slice(&scratch.0);
            b[0].extend_from_slice(&scratch.1);
        }
    }

    reader.align_to_byte();
    let crc16_frame_len = reader.byte_position();
    let crc16_expected = reader.read_bits(16)? as u16;
    let bytes_consumed = reader.byte_position();
    let crc16_computed = Crc16::compute(&data[..crc16_frame_len]);
    if crc16_computed != crc16_expected {
        return Err(FlacError::FrameCrcMismatch {
            expected: crc16_expected,
            computed: crc16_computed,
        });
    }

    Ok(bytes_consumed)
}

/// Decode one FLAC frame into per-channel scratch buffers (overwrite mode).
///
/// Unlike `decode_frame_into_channels`, this function:
/// - Clears `scratch[ch]` before writing (no accumulation across frames)
/// - Uses `scratch[0]`/`scratch[1]` directly for stereo decorrelation
///
/// On return, `scratch[ch]` holds exactly `block_size` decoded i32 samples.
/// The caller converts scratch → typed output while it is L1/L2-hot.
pub(crate) fn decode_frame_into_scratch(
    data: &[u8],
    streaminfo_sample_rate: u32,
    streaminfo_bits_per_sample: u8,
    scratch: &mut [Vec<i32>],
) -> Result<usize, FlacError> {
    if data.len() < 6 {
        return Err(FlacError::UnexpectedEof);
    }

    let mut reader = BitReader::new(data);

    let sync = reader.read_bits(14)? as u16;
    if sync != FRAME_SYNC_CODE {
        return Err(FlacError::invalid_frame_sync(sync));
    }
    let reserved = reader.read_bit()?;
    if reserved {
        return Err(FlacError::InvalidFrameSync { found: 0xFFFF });
    }
    let _variable_blocksize = reader.read_bit()?;

    let block_size_code = reader.read_bits(4)? as u8;
    let sample_rate_code = reader.read_bits(4)? as u8;
    let channel_code = reader.read_bits(4)? as u8;
    let sample_size_code = reader.read_bits(3)? as u8;
    let reserved2 = reader.read_bit()?;
    if reserved2 {
        return Err(FlacError::ReservedBitsPerSampleCode);
    }

    let channel_assignment = ChannelAssignment::from_code(channel_code)
        .ok_or(FlacError::InvalidChannelAssignment(channel_code))?;

    let bits_per_sample = if sample_size_code == 0 {
        streaminfo_bits_per_sample
    } else if sample_size_code == 0b011 {
        return Err(FlacError::ReservedBitsPerSampleCode);
    } else {
        BITS_PER_SAMPLE_TABLE[sample_size_code as usize]
    };

    let _frame_or_sample_number = reader.read_utf8_coded()?;

    let block_size = match block_size_code {
        0b0000 => return Err(FlacError::ReservedBlockSizeCode),
        0b0110 => reader.read_bits(8)? + 1,
        0b0111 => reader.read_bits(16)? + 1,
        _ => BLOCK_SIZE_TABLE[block_size_code as usize],
    } as usize;

    let _sample_rate = match sample_rate_code {
        0b0000 => streaminfo_sample_rate,
        0b1100 => reader.read_bits(8)? * 1000,
        0b1101 => reader.read_bits(16)?,
        0b1110 => reader.read_bits(16)? * 10,
        0b1111 => return Err(FlacError::ReservedSampleRateCode),
        _ => SAMPLE_RATE_TABLE[sample_rate_code as usize],
    };

    let crc8_header_len = reader.byte_position();
    let crc8_expected = reader.read_bits(8)? as u8;
    let crc8_computed = Crc8::compute(&data[..crc8_header_len]);
    if crc8_computed != crc8_expected {
        return Err(FlacError::FrameHeaderCrcMismatch {
            expected: crc8_expected,
            computed: crc8_computed,
        });
    }

    let num_channels = channel_assignment.channels() as usize;

    // Clear scratch for this frame (overwrite mode).
    for ch in scratch[..num_channels].iter_mut() {
        ch.clear();
    }

    match channel_assignment {
        ChannelAssignment::Independent(_) => {
            for ch in scratch.iter_mut().take(num_channels) {
                decode_subframe_into(&mut reader, block_size, bits_per_sample, ch)?;
            }
        }
        ChannelAssignment::LeftSide => {
            // scratch[0] = left, scratch[1] = side → decorate in-place to right
            decode_subframe_into(&mut reader, block_size, bits_per_sample,     &mut scratch[0])?;
            decode_subframe_into(&mut reader, block_size, bits_per_sample + 1, &mut scratch[1])?;
            let (left, rest) = scratch.split_at_mut(1);
            for (s, &l) in rest[0].iter_mut().zip(left[0].iter()) {
                *s = l - *s;
            }
        }
        ChannelAssignment::RightSide => {
            // scratch[0] = side → left, scratch[1] = right
            decode_subframe_into(&mut reader, block_size, bits_per_sample + 1, &mut scratch[0])?;
            decode_subframe_into(&mut reader, block_size, bits_per_sample,     &mut scratch[1])?;
            let (side, rest) = scratch.split_at_mut(1);
            for (s, &r) in side[0].iter_mut().zip(rest[0].iter()) {
                *s += r;
            }
        }
        ChannelAssignment::MidSide => {
            decode_subframe_into(&mut reader, block_size, bits_per_sample,     &mut scratch[0])?;
            decode_subframe_into(&mut reader, block_size, bits_per_sample + 1, &mut scratch[1])?;
            let (mid_slice, side_slice) = scratch.split_at_mut(1);
            for (m, s) in mid_slice[0].iter_mut().zip(side_slice[0].iter_mut()) {
                let mid = (*m << 1) | (*s & 1);
                let side = *s;
                *m = (mid + side) >> 1;
                *s = (mid - side) >> 1;
            }
        }
    }

    reader.align_to_byte();
    let crc16_frame_len = reader.byte_position();
    let crc16_expected = reader.read_bits(16)? as u16;
    let bytes_consumed = reader.byte_position();
    let crc16_computed = Crc16::compute(&data[..crc16_frame_len]);
    if crc16_computed != crc16_expected {
        return Err(FlacError::FrameCrcMismatch {
            expected: crc16_expected,
            computed: crc16_computed,
        });
    }

    Ok(bytes_consumed)
}

/// Encode samples into a FLAC frame.
///
/// # Arguments
/// * `samples` - Interleaved samples
/// * `channels` - Number of channels
/// * `block_size` - Number of samples per channel
/// * `sample_rate` - Sample rate in Hz
/// * `bits_per_sample` - Bits per sample
/// * `frame_number` - Frame number (for fixed-blocksize)
/// * `max_lpc_order` - Maximum LPC order (0 = fixed only)
/// * `qlp_precision` - QLP coefficient precision
/// * `min_partition_order` - Minimum Rice partition order
/// * `max_partition_order` - Maximum Rice partition order
/// * `try_mid_side` - Whether to try mid-side stereo
/// * `exhaustive_rice` - Use exhaustive Rice parameter search
pub fn encode_frame(
    samples: &[i32],
    channels: u8,
    block_size: u32,
    sample_rate: u32,
    bits_per_sample: u8,
    frame_number: u64,
    max_lpc_order: usize,
    qlp_precision: u8,
    min_partition_order: u8,
    max_partition_order: u8,
    try_mid_side: bool,
    exhaustive_rice: bool,
) -> Result<Vec<u8>, FlacError> {
    let num_channels = channels as usize;
    let samples_per_channel = block_size as usize;

    // Deinterleave samples
    let mut ch_vecs: Vec<Vec<i32>> = vec![Vec::with_capacity(samples_per_channel); num_channels];
    for (i, &sample) in samples.iter().enumerate() {
        ch_vecs[i % num_channels].push(sample);
    }

    let ch_slices: Vec<&[i32]> = ch_vecs.iter().map(|v| v.as_slice()).collect();
    encode_frame_from_channels(
        &ch_slices,
        bits_per_sample,
        sample_rate,
        frame_number,
        max_lpc_order,
        qlp_precision,
        min_partition_order,
        max_partition_order,
        try_mid_side,
        exhaustive_rice,
    )
}

/// Encode frame header.
fn encode_frame_header(
    writer: &mut BitWriter,
    block_size: u32,
    sample_rate: u32,
    channel_assignment: ChannelAssignment,
    bits_per_sample: u8,
    frame_number: u64,
) -> Result<(), FlacError> {
    // Sync code (14 bits)
    writer.write_bits(FRAME_SYNC_CODE as u32, 14);

    // Reserved (1 bit) = 0
    writer.write_bit(false);

    // Blocking strategy (1 bit) - using fixed for now
    writer.write_bit(false);

    // Block size code
    let (bs_code, bs_extra) = block_size_to_code(block_size);
    writer.write_bits(bs_code as u32, 4);

    // Sample rate code
    let (sr_code, sr_extra) = sample_rate_to_code(sample_rate);
    writer.write_bits(sr_code as u32, 4);

    // Channel assignment
    writer.write_bits(channel_assignment.code() as u32, 4);

    // Sample size
    let bps_code = bits_per_sample_to_code(bits_per_sample).unwrap_or(0);
    writer.write_bits(bps_code as u32, 3);

    // Reserved (1 bit) = 0
    writer.write_bit(false);

    // Frame number (UTF-8 coded)
    writer.write_utf8_coded(frame_number);

    // Extra block size bytes
    match bs_extra {
        1 => writer.write_bits((block_size - 1) as u32, 8),
        2 => writer.write_bits((block_size - 1) as u32, 16),
        _ => {}
    }

    // Extra sample rate bytes
    match sr_extra {
        1 => writer.write_bits(sample_rate / 1000, 8),
        2 => writer.write_bits(sample_rate, 16),
        3 => writer.write_bits(sample_rate / 10, 16),
        _ => {}
    }

    Ok(())
}

/// Find the best stereo encoding mode using residual energy estimation.
///
/// Rather than fully encoding all four candidate modes (8 subframe encodes),
/// this uses L1 residual energy as a proxy for encoding cost. The mode with
/// the lowest estimated energy is selected and only that mode's channel data
/// is returned. The side-channel modes incur a +1 bit-per-sample overhead
/// which is approximated as a penalty of `block_size` to the energy score.
fn find_best_stereo_mode(
    left: &[i32],
    right: &[i32],
) -> (ChannelAssignment, Vec<Vec<i32>>) {
    let n = left.len() as u64;

    let side: Vec<i32> = left.iter().zip(right.iter()).map(|(&l, &r)| l - r).collect();
    let mid: Vec<i32> = left.iter().zip(right.iter()).map(|(&l, &r)| (l + r) >> 1).collect();

    let e_left: u64 = left.iter().map(|&s| (s as i64).unsigned_abs()).sum();
    let e_right: u64 = right.iter().map(|&s| (s as i64).unsigned_abs()).sum();
    let e_side: u64 = side.iter().map(|&s| (s as i64).unsigned_abs()).sum();
    let e_mid: u64 = mid.iter().map(|&s| (s as i64).unsigned_abs()).sum();

    // Side-channel modes require 1 extra bit/sample — model as +n penalty
    let score_ind = e_left + e_right;
    let score_ls  = e_left + e_side + n;
    let score_rs  = e_side + e_right + n;
    let score_ms  = e_mid  + e_side + n;

    if score_ind <= score_ls && score_ind <= score_rs && score_ind <= score_ms {
        (ChannelAssignment::Independent(2), vec![left.to_vec(), right.to_vec()])
    } else if score_ls <= score_rs && score_ls <= score_ms {
        (ChannelAssignment::LeftSide, vec![left.to_vec(), side])
    } else if score_rs <= score_ms {
        (ChannelAssignment::RightSide, vec![side, right.to_vec()])
    } else {
        (ChannelAssignment::MidSide, vec![mid, side])
    }
}

/// Encode samples into a FLAC frame from already-deinterleaved channel slices.
///
/// This avoids the interleave→deinterleave round-trip of `encode_frame`.
/// For independent channels the input slices are encoded directly without
/// allocating intermediate owned Vecs.
pub fn encode_frame_from_channels(
    channel_samples: &[&[i32]],
    bits_per_sample: u8,
    sample_rate: u32,
    frame_number: u64,
    max_lpc_order: usize,
    qlp_precision: u8,
    min_partition_order: u8,
    max_partition_order: u8,
    try_mid_side: bool,
    exhaustive_rice: bool,
) -> Result<Vec<u8>, FlacError> {
    let num_channels = channel_samples.len() as u8;
    if channel_samples.is_empty() {
        return Err(FlacError::InvalidChannelCount { channels: 0 });
    }
    let block_size = channel_samples[0].len() as u32;

    let mut writer =
        BitWriter::with_capacity(channel_samples[0].len() * num_channels as usize * 4);

    if num_channels == 2 && try_mid_side {
        let (channel_assignment, owned) =
            find_best_stereo_mode(channel_samples[0], channel_samples[1]);

        // Write header before subframe encoding so the sequential path can write
        // subframes directly into the frame writer without an intermediate buffer.
        encode_frame_header(&mut writer, block_size, sample_rate, channel_assignment,
            bits_per_sample, frame_number)?;
        writer.align_to_byte();
        let crc8 = Crc8::compute(writer.data());
        writer.write_bits(crc8 as u32, 8);

        #[cfg(feature = "flac-parallel")]
        {
            use rayon::prelude::*;
            let subframe_data: Vec<EncodedSubframe> = owned
                .par_iter()
                .enumerate()
                .map(|(ch, ch_data)| {
                    let subframe_bps = match (channel_assignment, ch) {
                        (ChannelAssignment::LeftSide, 1)
                        | (ChannelAssignment::RightSide, 0)
                        | (ChannelAssignment::MidSide, 1) => bits_per_sample + 1,
                        _ => bits_per_sample,
                    };
                    encode_subframe(ch_data, subframe_bps, max_lpc_order, qlp_precision,
                        min_partition_order, max_partition_order, exhaustive_rice)
                })
                .collect::<Result<Vec<_>, _>>()?;
            for encoded in &subframe_data {
                writer.write_packed_bits(&encoded.data, encoded.bits);
            }
        }
        #[cfg(not(feature = "flac-parallel"))]
        for (ch, ch_data) in owned.iter().enumerate() {
            let subframe_bps = match (channel_assignment, ch) {
                (ChannelAssignment::LeftSide, 1)
                | (ChannelAssignment::RightSide, 0)
                | (ChannelAssignment::MidSide, 1) => bits_per_sample + 1,
                _ => bits_per_sample,
            };
            encode_subframe_into(&mut writer, ch_data, subframe_bps, max_lpc_order,
                qlp_precision, min_partition_order, max_partition_order, exhaustive_rice)?;
        }
    } else {
        let channel_assignment = ChannelAssignment::Independent(num_channels);

        encode_frame_header(&mut writer, block_size, sample_rate, channel_assignment,
            bits_per_sample, frame_number)?;
        writer.align_to_byte();
        let crc8 = Crc8::compute(writer.data());
        writer.write_bits(crc8 as u32, 8);

        #[cfg(feature = "flac-parallel")]
        {
            use rayon::prelude::*;
            let subframe_data: Vec<EncodedSubframe> = channel_samples
                .par_iter()
                .map(|&ch_data| {
                    encode_subframe(ch_data, bits_per_sample, max_lpc_order, qlp_precision,
                        min_partition_order, max_partition_order, exhaustive_rice)
                })
                .collect::<Result<Vec<_>, _>>()?;
            for encoded in &subframe_data {
                writer.write_packed_bits(&encoded.data, encoded.bits);
            }
        }
        #[cfg(not(feature = "flac-parallel"))]
        for &ch_data in channel_samples {
            encode_subframe_into(&mut writer, ch_data, bits_per_sample, max_lpc_order,
                qlp_precision, min_partition_order, max_partition_order, exhaustive_rice)?;
        }
    }

    // Single frame-level padding to byte boundary before CRC-16
    writer.align_to_byte();

    let frame_data = writer.data();
    let crc16 = Crc16::compute(frame_data);
    writer.write_bits(crc16 as u32, 16);

    Ok(writer.finish())
}

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

    #[test]
    fn test_channel_assignment_code_roundtrip() {
        let assignments = [
            ChannelAssignment::Independent(1),
            ChannelAssignment::Independent(2),
            ChannelAssignment::Independent(8),
            ChannelAssignment::LeftSide,
            ChannelAssignment::RightSide,
            ChannelAssignment::MidSide,
        ];

        for assignment in assignments {
            let code = assignment.code();
            let parsed = ChannelAssignment::from_code(code);
            assert!(
                parsed.is_some(),
                "Failed to parse code for {:?}",
                assignment
            );
            assert_eq!(parsed.unwrap().channels(), assignment.channels());
        }
    }

    #[test]
    fn test_stereo_decorrelation_roundtrip() {
        // Create test stereo data
        let left: Vec<i32> = (0..100).map(|i| (i * 100) as i32).collect();
        let right: Vec<i32> = (0..100).map(|i| (i * 50 + 25) as i32).collect();

        // Interleave
        let mut interleaved = Vec::with_capacity(200);
        for i in 0..100 {
            interleaved.push(left[i]);
            interleaved.push(right[i]);
        }

        // Create a frame with independent channels
        let frame = Frame {
            header: FrameHeader {
                variable_blocksize: false,
                block_size: 100,
                sample_rate: 44100,
                channel_assignment: ChannelAssignment::Independent(2),
                bits_per_sample: 16,
                frame_or_sample_number: 0,
            },
            subframes: vec![
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: left.clone(),
                },
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: right.clone(),
                },
            ],
        };

        let decoded = frame.into_channel_samples();
        assert_eq!(decoded.len(), 2);
        assert_eq!(decoded[0], left);
        assert_eq!(decoded[1], right);
    }

    #[test]
    fn test_mid_side_decorrelation() {
        let left = vec![100i32, 200, 300];
        let right = vec![50i32, 150, 250];

        // Compute mid and side
        let mid: Vec<i32> = left
            .iter()
            .zip(&right)
            .map(|(&l, &r)| (l + r) >> 1)
            .collect();
        let side: Vec<i32> = left.iter().zip(&right).map(|(&l, &r)| l - r).collect();

        let frame = Frame {
            header: FrameHeader {
                variable_blocksize: false,
                block_size: 3,
                sample_rate: 44100,
                channel_assignment: ChannelAssignment::MidSide,
                bits_per_sample: 16,
                frame_or_sample_number: 0,
            },
            subframes: vec![
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: mid,
                },
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: side,
                },
            ],
        };

        let decoded = frame.into_channel_samples();

        // Should recover original left/right channels
        assert_eq!(decoded.len(), 2);
        assert_eq!(decoded[0], left);
        assert_eq!(decoded[1], right);
    }

    // =========================================================================
    // encode_frame / decode_frame roundtrip tests
    // =========================================================================

    /// Encode a mono frame then decode it; verify sample count and block_size.
    #[test]
    fn test_encode_decode_frame_mono_constant() {
        // Use silence (all zeros) — will encode as CONSTANT subframe, which is lossless.
        let block_size = 512u32;
        let samples: Vec<i32> = vec![0i32; block_size as usize];

        let frame_bytes = encode_frame(
            &samples,
            1,         // mono
            block_size,
            44100,
            16,
            0,         // frame number
            0,         // max_lpc_order = 0 → fixed only
            12,        // qlp_precision
            0, 3,      // rice partition order range
            false,     // no mid-side
            false,     // no exhaustive rice
        )
        .expect("encode_frame should succeed");

        assert!(!frame_bytes.is_empty(), "encoded frame must not be empty");

        let (frame, bytes_consumed) =
            decode_frame(&frame_bytes, 44100, 16, 1).expect("decode_frame should succeed");

        assert_eq!(bytes_consumed, frame_bytes.len(), "all bytes consumed");
        assert_eq!(frame.block_size(), block_size as usize, "block size");
        assert_eq!(frame.num_channels(), 1, "channels");

        let channels = frame.into_channel_samples();
        assert_eq!(channels.len(), 1);
        assert_eq!(channels[0].len(), block_size as usize);
        assert!(channels[0].iter().all(|&s| s == 0), "silence should decode to zeros");
    }

    /// Encode constant non-zero audio mono.
    #[test]
    fn test_encode_decode_frame_mono_dc() {
        let block_size = 1024u32;
        let dc_value = 1000i32;
        let samples: Vec<i32> = vec![dc_value; block_size as usize];

        let frame_bytes = encode_frame(
            &samples, 1, block_size, 44100, 16, 0, 0, 12, 0, 3, false, false,
        )
        .expect("encode");

        let (frame, _) = decode_frame(&frame_bytes, 44100, 16, 1).expect("decode");
        let channels = frame.into_channel_samples();
        assert_eq!(channels[0].len(), block_size as usize);
        // DC audio should be lossless via CONSTANT subframe
        assert!(
            channels[0].iter().all(|&s| s == dc_value),
            "DC signal should decode exactly"
        );
    }

    /// Encode a mono frame of block_size 4096.
    #[test]
    fn test_encode_decode_frame_large_block() {
        let block_size = 4096u32;
        let samples: Vec<i32> = vec![0i32; block_size as usize];

        let frame_bytes = encode_frame(
            &samples, 1, block_size, 48000, 16, 5, 0, 12, 0, 4, false, false,
        )
        .expect("encode large block");

        let (frame, consumed) = decode_frame(&frame_bytes, 48000, 16, 1).expect("decode large block");
        assert_eq!(consumed, frame_bytes.len());
        assert_eq!(frame.block_size(), block_size as usize);
    }

    /// Frame number is encoded correctly (UTF-8 coded in header).
    #[test]
    fn test_encode_decode_frame_number() {
        let block_size = 1024u32;
        let samples: Vec<i32> = vec![0i32; block_size as usize];

        for frame_number in [0u64, 1, 127, 128, 0x3FFF, 0x1FFFFF] {
            let frame_bytes = encode_frame(
                &samples, 1, block_size, 44100, 16, frame_number, 0, 12, 0, 3, false, false,
            )
            .unwrap_or_else(|e| panic!("encode frame {frame_number}: {e}"));

            let (frame, _) = decode_frame(&frame_bytes, 44100, 16, 1)
                .unwrap_or_else(|e| panic!("decode frame {frame_number}: {e}"));
            assert_eq!(
                frame.header.frame_or_sample_number, frame_number,
                "frame number should match"
            );
        }
    }

    /// Different sample rates survive the encode→decode header.
    #[test]
    fn test_encode_decode_various_sample_rates() {
        let block_size = 512u32;
        let samples: Vec<i32> = vec![0i32; block_size as usize];

        for sr in [44100u32, 48000, 96000] {
            let frame_bytes = encode_frame(
                &samples, 1, block_size, sr, 16, 0, 0, 12, 0, 3, false, false,
            )
            .unwrap_or_else(|e| panic!("encode sr={sr}: {e}"));

            let (frame, _) = decode_frame(&frame_bytes, sr, 16, 1)
                .unwrap_or_else(|e| panic!("decode sr={sr}: {e}"));

            // Sample rate is encoded in the frame header; verify it survives
            assert_eq!(frame.header.sample_rate, sr, "sample rate should be preserved");
        }
    }

    /// Left-side stereo decorrelation: encode stereo with left-side mode,
    /// decode and verify the two channels come back as independent.
    #[test]
    fn test_left_side_decorrelation_roundtrip() {
        // Simple ascending samples for predictable encoding
        let left: Vec<i32> = (0..100).map(|i| i as i32 * 10).collect();
        let right: Vec<i32> = (0..100).map(|i| i as i32 * 10 + 5).collect();

        // Manually compute left-side encoded form
        let side: Vec<i32> = left.iter().zip(&right).map(|(&l, &r)| l - r).collect();

        let frame = Frame {
            header: FrameHeader {
                variable_blocksize: false,
                block_size: 100,
                sample_rate: 44100,
                channel_assignment: ChannelAssignment::LeftSide,
                bits_per_sample: 16,
                frame_or_sample_number: 0,
            },
            subframes: vec![
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: left.clone(),
                },
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: side,
                },
            ],
        };

        let decoded = frame.into_channel_samples();
        assert_eq!(decoded[0], left, "left channel should match");
        assert_eq!(decoded[1], right, "right channel should be restored");
    }

    /// Right-side stereo decorrelation roundtrip.
    #[test]
    fn test_right_side_decorrelation_roundtrip() {
        let left: Vec<i32> = (0..50).map(|i| i as i32 * 20).collect();
        let right: Vec<i32> = (0..50).map(|i| i as i32 * 20 + 10).collect();
        let side: Vec<i32> = left.iter().zip(&right).map(|(&l, &r)| l - r).collect();

        let frame = Frame {
            header: FrameHeader {
                variable_blocksize: false,
                block_size: 50,
                sample_rate: 44100,
                channel_assignment: ChannelAssignment::RightSide,
                bits_per_sample: 16,
                frame_or_sample_number: 0,
            },
            subframes: vec![
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: side,
                },
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Verbatim,
                    wasted_bits: 0,
                    samples: right.clone(),
                },
            ],
        };

        let decoded = frame.into_channel_samples();
        assert_eq!(decoded[0], left, "left channel");
        assert_eq!(decoded[1], right, "right channel");
    }

    /// Frame block_size() and num_channels() accessors.
    #[test]
    fn test_frame_accessors() {
        let frame = Frame {
            header: FrameHeader {
                variable_blocksize: false,
                block_size: 256,
                sample_rate: 44100,
                channel_assignment: ChannelAssignment::Independent(3),
                bits_per_sample: 16,
                frame_or_sample_number: 42,
            },
            subframes: vec![
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Constant,
                    wasted_bits: 0,
                    samples: vec![0i32; 256],
                },
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Constant,
                    wasted_bits: 0,
                    samples: vec![0i32; 256],
                },
                Subframe {
                    subframe_type: crate::flac::subframe::SubframeType::Constant,
                    wasted_bits: 0,
                    samples: vec![0i32; 256],
                },
            ],
        };
        assert_eq!(frame.block_size(), 256);
        assert_eq!(frame.num_channels(), 3);
    }
}