haagenti-zstd 0.1.1

Zstandard-inspired compression for Haagenti (internal format, not Zstd-compatible)
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
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
//! Correct tANS (table-based Asymmetric Numeral Systems) encoder for Zstd sequences.
//!
//! This implements the exact FSE encoding algorithm from Zstd's reference implementation.
//!
//! ## Algorithm (from Zstd fse.h)
//!
//! ```text
//! nbBitsOut = (state + deltaNbBits) >> 16
//! output low nbBitsOut bits of state
//! next_state = stateTable[(state >> nbBitsOut) + deltaFindState]
//! ```
//!
//! Where:
//! - `deltaNbBits = (maxBitsOut << 16) - minStatePlus`
//! - `minStatePlus = prob << maxBitsOut`
//! - `maxBitsOut = tableLog - highbit32(prob - 1)` for prob > 1
//! - `deltaFindState = cumulative_total - prob`
//!
//! ## State Table
//!
//! The state table stores `tableSize + position` for each decode table position,
//! ensuring encoder states are in [tableSize, 2*tableSize).
//!
//! ## Performance
//!
//! Uses `Arc<[T]>` for immutable table data, making Clone O(1) via reference
//! counting instead of O(n) deep copies. Only the mutable `state` is copied.

use super::table::FseTable;
use std::sync::Arc;

use super::{cloned_ll_encoder, cloned_ml_encoder, cloned_of_encoder};

/// tANS encoding parameters for a single symbol.
#[derive(Debug, Clone, Copy, Default)]
pub struct TansSymbolParams {
    /// Delta for computing number of bits to output.
    /// Formula: nb_bits = (state + delta_nb_bits) >> 16
    pub delta_nb_bits: u32,
    /// Delta for finding next state in state table.
    /// Formula: idx = (state >> nb_bits) + delta_find_state
    pub delta_find_state: i32,
}

/// tANS encoder for a single stream.
///
/// Uses `Arc<[T]>` for immutable tables, making Clone O(1) instead of O(n).
/// Only the mutable `state` field is copied on clone.
#[derive(Debug, Clone)]
pub struct TansEncoder {
    /// Symbol encoding parameters (indexed by symbol).
    /// Shared via Arc for O(1) clone.
    symbol_params: Arc<[TansSymbolParams]>,
    /// State table for finding next state.
    /// Indexed by: (state >> nb_bits) + delta_find_state
    /// Values are in [table_size, 2*table_size)
    /// Shared via Arc for O(1) clone.
    state_table: Arc<[u16]>,
    /// Num bits to output for each decode state (indexed by decode_state = encoder_state - table_size).
    /// Shared via Arc for O(1) clone.
    #[allow(dead_code)]
    num_bits_per_state: Arc<[u8]>,
    /// Baseline for each decode state (for computing decoder's next state).
    /// Shared via Arc for O(1) clone.
    #[allow(dead_code)]
    baseline_per_state: Arc<[u16]>,
    /// Current encoder state (in [table_size, 2*table_size)).
    state: u32,
    /// Table size (1 << accuracy_log).
    table_size: u32,
    /// Accuracy log.
    accuracy_log: u8,
}

impl TansEncoder {
    /// Build a tANS encoder from a decode table.
    ///
    /// Implements the exact algorithm from Zstd's FSE_buildCTable_wksp.
    pub fn from_decode_table(decode_table: &FseTable) -> Self {
        let accuracy_log = decode_table.accuracy_log();
        let table_size = decode_table.size() as u32;

        // Count probability for each symbol from decode table
        let mut symbol_probs = vec![0i32; 256];
        for state in 0..table_size as usize {
            let entry = decode_table.decode(state);
            symbol_probs[entry.symbol as usize] += 1;
        }

        // Find highest symbol with non-zero probability
        let max_symbol = symbol_probs
            .iter()
            .enumerate()
            .rev()
            .find(|&(_, &p)| p > 0)
            .map(|(i, _)| i)
            .unwrap_or(0);

        // Compute cumulative probabilities
        let mut cumul = vec![0u32; max_symbol + 2];
        for i in 0..=max_symbol {
            cumul[i + 1] = cumul[i] + symbol_probs[i].unsigned_abs();
        }

        // Build symbol encoding parameters (symbolTT in Zstd)
        let mut symbol_params = vec![TansSymbolParams::default(); max_symbol + 1];
        let mut total: u32 = 0;

        for (symbol, &prob) in symbol_probs.iter().enumerate().take(max_symbol + 1) {
            if prob == 0 {
                // Symbol not present - use sentinel values
                symbol_params[symbol] = TansSymbolParams {
                    delta_nb_bits: ((accuracy_log as u32 + 1) << 16) - table_size,
                    delta_find_state: 0,
                };
            } else if prob == 1 || prob == -1 {
                // Special case for prob = 1 or -1 (less-than-one probability)
                // deltaNbBits = (tableLog << 16) - (1 << tableLog)
                symbol_params[symbol] = TansSymbolParams {
                    delta_nb_bits: ((accuracy_log as u32) << 16).wrapping_sub(table_size),
                    delta_find_state: total as i32 - 1,
                };
                total += 1;
            } else {
                // Normal case for prob > 1
                // maxBitsOut = tableLog - highbit32(prob - 1)
                let high_bit = 31 - (prob as u32 - 1).leading_zeros();
                let max_bits_out = accuracy_log as u32 - high_bit;

                // minStatePlus = prob << maxBitsOut
                let min_state_plus = (prob as u32) << max_bits_out;

                // deltaNbBits = (maxBitsOut << 16) - minStatePlus
                let delta_nb_bits = (max_bits_out << 16).wrapping_sub(min_state_plus);

                // deltaFindState = total - prob
                let delta_find_state = total as i32 - prob;

                symbol_params[symbol] = TansSymbolParams {
                    delta_nb_bits,
                    delta_find_state,
                };
                total += prob as u32;
            }
        }

        // Build state table using decode table order
        // stateTable[cumul[s]++] = tableSize + position
        let mut state_table = vec![0u16; table_size as usize];
        let mut cumul_copy = cumul.clone();

        for position in 0..table_size as usize {
            let symbol = decode_table.decode(position).symbol as usize;
            if symbol <= max_symbol {
                let idx = cumul_copy[symbol] as usize;
                if idx < state_table.len() {
                    // Store tableSize + position (state range: [tableSize, 2*tableSize))
                    state_table[idx] = (table_size + position as u32) as u16;
                    cumul_copy[symbol] += 1;
                }
            }
        }

        // Copy num_bits and baseline from decode table for each state
        // These are used during encoding to output the correct number of bits
        let mut num_bits_per_state = vec![0u8; table_size as usize];
        let mut baseline_per_state = vec![0u16; table_size as usize];
        for position in 0..table_size as usize {
            let entry = decode_table.decode(position);
            num_bits_per_state[position] = entry.num_bits;
            baseline_per_state[position] = entry.baseline;
        }

        Self {
            symbol_params: symbol_params.into(),
            state_table: state_table.into(),
            num_bits_per_state: num_bits_per_state.into(),
            baseline_per_state: baseline_per_state.into(),
            state: table_size, // Initial state
            table_size,
            accuracy_log,
        }
    }

    /// Initialize encoder state for a specific symbol.
    ///
    /// Implements FSE_initCState2 from Zstd:
    /// ```text
    /// nbBitsOut = (deltaNbBits + (1<<15)) >> 16  // with rounding
    /// value = (nbBitsOut << 16) - deltaNbBits
    /// state = stateTable[(value >> nbBitsOut) + deltaFindState]
    /// ```
    /// This sets up the encoder for the first (last in sequence) symbol
    /// without outputting any bits.
    pub fn init_state(&mut self, symbol: u8) {
        let sym_idx = symbol as usize;
        if sym_idx >= self.symbol_params.len() {
            self.state = self.table_size;
            return;
        }

        let params = &self.symbol_params[sym_idx];

        // FSE_initCState2 algorithm:
        // 1. nbBitsOut = (deltaNbBits + (1<<15)) >> 16
        let nb_bits_out = ((params.delta_nb_bits as u64 + 0x8000) >> 16) as u32;

        // 2. value = (nbBitsOut << 16) - deltaNbBits
        let value = ((nb_bits_out as u64) << 16).wrapping_sub(params.delta_nb_bits as u64) as u32;

        // 3. state = stateTable[(value >> nbBitsOut) + deltaFindState]
        let value_shifted = if nb_bits_out >= 32 {
            0
        } else {
            value >> nb_bits_out
        };
        let idx = value_shifted as i64 + params.delta_find_state as i64;

        if idx >= 0 && (idx as usize) < self.state_table.len() {
            self.state = self.state_table[idx as usize] as u32;
        } else {
            // Fallback to tableSize
            self.state = self.table_size;
        }
    }

    /// Encode a symbol and return (bits, num_bits).
    ///
    /// Implements FSE_encodeSymbol from Zstd:
    /// ```text
    /// nbBitsOut = (state + deltaNbBits) >> 16
    /// output low nbBitsOut bits of state
    /// state = stateTable[(state >> nbBitsOut) + deltaFindState]
    /// ```
    #[inline]
    pub fn encode_symbol(&mut self, symbol: u8) -> (u32, u8) {
        let sym_idx = symbol as usize;

        if sym_idx >= self.symbol_params.len() {
            return (0, 0);
        }

        let params = &self.symbol_params[sym_idx];

        // Step 1: nbBitsOut = (state + deltaNbBits) >> 16
        // This is the core Zstd FSE formula
        let nb_bits_out = ((self.state as u64 + params.delta_nb_bits as u64) >> 16) as u8;

        // Step 2: Output low nbBitsOut bits of state
        let bits_mask = if nb_bits_out >= 32 {
            u32::MAX
        } else {
            (1u32 << nb_bits_out) - 1
        };
        let bits = self.state & bits_mask;

        // Step 3: state = stateTable[(state >> nbBitsOut) + deltaFindState]
        let state_shifted = if nb_bits_out >= 32 {
            0
        } else {
            self.state >> nb_bits_out
        };
        let idx = state_shifted as i64 + params.delta_find_state as i64;

        let next_state = if idx >= 0 && (idx as usize) < self.state_table.len() {
            self.state_table[idx as usize] as u32
        } else {
            self.table_size
        };

        self.state = next_state;
        (bits, nb_bits_out)
    }

    /// Get current state for serialization.
    ///
    /// The decoder reads this as the initial state.
    /// For the bitstream, we write (state - tableSize) masked to accuracy_log bits.
    #[inline]
    pub fn get_state(&self) -> u32 {
        // Return the decode state (0 to tableSize-1)
        self.state.saturating_sub(self.table_size) & ((1 << self.accuracy_log) - 1)
    }

    /// Get accuracy log.
    #[inline]
    pub fn accuracy_log(&self) -> u8 {
        self.accuracy_log
    }

    /// Reset encoder for new stream.
    pub fn reset(&mut self) {
        self.state = self.table_size;
    }
}

/// Interleaved tANS encoder for Zstd sequences (LL, OF, ML).
#[derive(Debug)]
pub struct InterleavedTansEncoder {
    ll_encoder: TansEncoder,
    of_encoder: TansEncoder,
    ml_encoder: TansEncoder,
}

impl InterleavedTansEncoder {
    /// Create encoder from three FSE tables.
    ///
    /// Note: For predefined tables, prefer `new_predefined()` which uses
    /// cached encoders for better performance.
    pub fn new(ll_table: &FseTable, of_table: &FseTable, ml_table: &FseTable) -> Self {
        Self {
            ll_encoder: TansEncoder::from_decode_table(ll_table),
            of_encoder: TansEncoder::from_decode_table(of_table),
            ml_encoder: TansEncoder::from_decode_table(ml_table),
        }
    }

    /// Create encoder using cached predefined tANS encoders.
    ///
    /// This is the fast path for encoding with predefined FSE tables.
    /// Cloning cached encoders is much faster than building from scratch.
    #[inline]
    pub fn new_predefined() -> Self {
        Self {
            ll_encoder: cloned_ll_encoder(),
            of_encoder: cloned_of_encoder(),
            ml_encoder: cloned_ml_encoder(),
        }
    }

    /// Create encoder from pre-built tANS encoders.
    ///
    /// This allows using custom FSE tables by building encoders separately.
    pub fn from_encoders(
        ll_encoder: TansEncoder,
        of_encoder: TansEncoder,
        ml_encoder: TansEncoder,
    ) -> Self {
        Self {
            ll_encoder,
            of_encoder,
            ml_encoder,
        }
    }

    /// Initialize all three encoders with their first symbols.
    ///
    /// These should be the LAST symbols in the sequence (encoding is reversed).
    pub fn init_states(&mut self, ll: u8, of: u8, ml: u8) {
        self.ll_encoder.init_state(ll);
        self.of_encoder.init_state(of);
        self.ml_encoder.init_state(ml);
    }

    /// Encode one sequence (LL, OF, ML) and return bits for each.
    ///
    /// Returns [(ll_bits, ll_nbits), (of_bits, of_nbits), (ml_bits, ml_nbits)]
    ///
    /// Note: tANS encoding order matters! We encode in reverse of decode order.
    /// Decoder reads FSE updates: LL, ML, OF
    /// So we encode: OF, ML, LL (reverse order for correct state transitions)
    #[inline]
    pub fn encode_sequence(&mut self, ll: u8, of: u8, ml: u8) -> [(u32, u8); 3] {
        // Encode in reverse of decoder read order: OF, ML, LL
        let of_bits = self.of_encoder.encode_symbol(of);
        let ml_bits = self.ml_encoder.encode_symbol(ml);
        let ll_bits = self.ll_encoder.encode_symbol(ll);
        // Return in standard order for caller convenience
        [ll_bits, of_bits, ml_bits]
    }

    /// Get final states for all three encoders.
    ///
    /// These become the decoder's initial states.
    #[inline]
    pub fn get_states(&self) -> (u32, u32, u32) {
        (
            self.ll_encoder.get_state(),
            self.of_encoder.get_state(),
            self.ml_encoder.get_state(),
        )
    }

    /// Get accuracy logs for all three encoders.
    #[inline]
    pub fn accuracy_logs(&self) -> (u8, u8, u8) {
        (
            self.ll_encoder.accuracy_log(),
            self.of_encoder.accuracy_log(),
            self.ml_encoder.accuracy_log(),
        )
    }

    /// Reset all encoders.
    pub fn reset(&mut self) {
        self.ll_encoder.reset();
        self.of_encoder.reset();
        self.ml_encoder.reset();
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::fse::{
        LITERAL_LENGTH_ACCURACY_LOG, LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
        MATCH_LENGTH_ACCURACY_LOG, MATCH_LENGTH_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG,
        OFFSET_DEFAULT_DISTRIBUTION,
    };

    #[test]
    fn test_tans_encoder_creation() {
        let table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let encoder = TansEncoder::from_decode_table(&table);
        assert_eq!(encoder.accuracy_log(), LITERAL_LENGTH_ACCURACY_LOG);
        assert_eq!(encoder.table_size, 1 << LITERAL_LENGTH_ACCURACY_LOG);
    }

    #[test]
    fn test_tans_encoder_state_range() {
        let table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let mut encoder = TansEncoder::from_decode_table(&table);
        let table_size = encoder.table_size;

        // Initialize with symbol 0
        encoder.init_state(0);

        // State should be in valid range [table_size, 2*table_size)
        assert!(
            encoder.state >= table_size,
            "State {} should be >= table_size {}",
            encoder.state,
            table_size
        );
        assert!(
            encoder.state < 2 * table_size,
            "State {} should be < 2*table_size {}",
            encoder.state,
            2 * table_size
        );
    }

    #[test]
    fn test_tans_encoder_encode_symbol() {
        let table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let mut encoder = TansEncoder::from_decode_table(&table);
        encoder.init_state(0);

        let table_size = encoder.table_size;

        // Encode several symbols and verify state stays valid
        for _ in 0..20 {
            let (bits, num_bits) = encoder.encode_symbol(0);

            // num_bits should be reasonable
            assert!(
                num_bits <= LITERAL_LENGTH_ACCURACY_LOG + 1,
                "num_bits {} too large",
                num_bits
            );

            // bits should fit in num_bits
            if num_bits > 0 && num_bits < 32 {
                assert!(
                    bits < (1 << num_bits),
                    "bits {} doesn't fit in {} bits",
                    bits,
                    num_bits
                );
            }

            // State should remain valid
            assert!(encoder.state >= table_size);
            assert!(encoder.state < 2 * table_size);
        }
    }

    #[test]
    fn test_tans_encoder_all_symbols() {
        let table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let mut encoder = TansEncoder::from_decode_table(&table);
        let table_size = encoder.table_size;

        // Test encoding each valid symbol
        for symbol in 0..36u8 {
            encoder.init_state(symbol);

            let (bits, num_bits) = encoder.encode_symbol(symbol);

            // Verify reasonable output
            assert!(
                num_bits <= LITERAL_LENGTH_ACCURACY_LOG + 1,
                "Symbol {} produced {} bits",
                symbol,
                num_bits
            );

            // State should be valid after encoding
            assert!(
                encoder.state >= table_size,
                "Symbol {} left state {} < table_size",
                symbol,
                encoder.state
            );
            assert!(
                encoder.state < 2 * table_size,
                "Symbol {} left state {} >= 2*table_size",
                symbol,
                encoder.state
            );
        }
    }

    #[test]
    fn test_interleaved_encoder() {
        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();
        let ml_table = FseTable::from_predefined(
            &MATCH_LENGTH_DEFAULT_DISTRIBUTION,
            MATCH_LENGTH_ACCURACY_LOG,
        )
        .unwrap();
        let of_table =
            FseTable::from_predefined(&OFFSET_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG).unwrap();

        let mut encoder = InterleavedTansEncoder::new(&ll_table, &of_table, &ml_table);
        encoder.init_states(0, 0, 0);

        // Encode a sequence
        let [ll_bits, of_bits, ml_bits] = encoder.encode_sequence(0, 0, 0);

        // All should produce valid outputs
        assert!(ll_bits.1 <= LITERAL_LENGTH_ACCURACY_LOG + 1);
        assert!(of_bits.1 <= OFFSET_ACCURACY_LOG + 1);
        assert!(ml_bits.1 <= MATCH_LENGTH_ACCURACY_LOG + 1);

        // Get final states
        let (ll_state, of_state, ml_state) = encoder.get_states();

        // States should be valid decode states (0 to table_size-1)
        assert!(ll_state < (1 << LITERAL_LENGTH_ACCURACY_LOG));
        assert!(of_state < (1 << OFFSET_ACCURACY_LOG));
        assert!(ml_state < (1 << MATCH_LENGTH_ACCURACY_LOG));
    }
}

#[cfg(test)]
mod debug_tests {
    use super::*;
    use crate::fse::{
        BitReader, FseBitWriter, FseDecoder, FseTable, LITERAL_LENGTH_ACCURACY_LOG,
        LITERAL_LENGTH_DEFAULT_DISTRIBUTION, MATCH_LENGTH_ACCURACY_LOG,
        MATCH_LENGTH_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG, OFFSET_DEFAULT_DISTRIBUTION,
    };

    /// Test that our FSE bitstream exactly matches reference.
    #[test]
    fn test_build_exact_reference_bitstream() {
        println!("=== Build Exact Reference Bitstream ===\n");

        // Reference encodes: LL=4, OF=2, ML=41
        // Reference states: LL=4, OF=14, ML=19
        // Reference FSE bytes: [0xfd, 0xe4, 0x88]
        // Reference extra bits: ll_extra=0 (0 bits), of_extra=3 (2 bits), ml_extra=13 (4 bits)

        // Build tables
        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();
        let of_table =
            FseTable::from_predefined(&OFFSET_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG).unwrap();
        let ml_table = FseTable::from_predefined(
            &MATCH_LENGTH_DEFAULT_DISTRIBUTION,
            MATCH_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        // Build interleaved encoder
        let mut tans = InterleavedTansEncoder::new(&ll_table, &of_table, &ml_table);

        // Initialize with the codes
        let ll_code = 4u8;
        let of_code = 2u8;
        let ml_code = 41u8;
        let of_extra = 3u32; // 2 bits
        let of_bits = 2u8;
        let ml_extra = 13u32; // 4 bits
        let ml_bits = 4u8;
        let ll_extra = 0u32; // 0 bits
        let ll_bits = 0u8;

        println!("Codes: LL={}, OF={}, ML={}", ll_code, of_code, ml_code);
        println!(
            "Extras: LL={}({} bits), OF={}({} bits), ML={}({} bits)",
            ll_extra, ll_bits, of_extra, of_bits, ml_extra, ml_bits
        );

        // Init states
        tans.init_states(ll_code, of_code, ml_code);
        let (ll_state, of_state, ml_state) = tans.get_states();
        println!(
            "Init states: LL={}, OF={}, ML={}",
            ll_state, of_state, ml_state
        );

        // Build bitstream exactly like build_fse_bitstream does for single sequence
        let mut bits = FseBitWriter::new();

        // 1. Write LAST sequence's extra bits first
        //    Order: OF, ML, LL (reverse of read order)
        println!("\nWriting extra bits:");
        if of_bits > 0 {
            println!("  OF extra: {} ({} bits)", of_extra, of_bits);
            bits.write_bits(of_extra, of_bits);
        }
        if ml_bits > 0 {
            println!("  ML extra: {} ({} bits)", ml_extra, ml_bits);
            bits.write_bits(ml_extra, ml_bits);
        }
        if ll_bits > 0 {
            println!("  LL extra: {} ({} bits)", ll_extra, ll_bits);
            bits.write_bits(ll_extra, ll_bits);
        }

        // 2. No more sequences to process (single sequence)

        // 3. Write final states: ML, OF, LL order
        println!("\nWriting states:");
        println!(
            "  ML state: {} ({} bits)",
            ml_state, MATCH_LENGTH_ACCURACY_LOG
        );
        bits.write_bits(ml_state, MATCH_LENGTH_ACCURACY_LOG);
        println!("  OF state: {} ({} bits)", of_state, OFFSET_ACCURACY_LOG);
        bits.write_bits(of_state, OFFSET_ACCURACY_LOG);
        println!(
            "  LL state: {} ({} bits)",
            ll_state, LITERAL_LENGTH_ACCURACY_LOG
        );
        bits.write_bits(ll_state, LITERAL_LENGTH_ACCURACY_LOG);

        let our_bitstream = bits.finish();
        let ref_bitstream = [0xfd, 0xe4, 0x88];

        println!("\nOur bitstream: {:02x?}", our_bitstream);
        println!("Ref bitstream: {:02x?}", ref_bitstream);

        // Analyze bit by bit
        println!("\nBit comparison (LSB first):");
        for i in 0..3 {
            let our_byte = our_bitstream.get(i).copied().unwrap_or(0);
            let ref_byte = ref_bitstream[i];
            println!(
                "  Byte {}: our={:08b}, ref={:08b}, diff={}",
                i,
                our_byte,
                ref_byte,
                if our_byte == ref_byte {
                    "MATCH"
                } else {
                    "DIFFER"
                }
            );
        }

        // Analyze what's in the bits
        // Total bits: 2 (of_extra) + 4 (ml_extra) + 0 (ll_extra) + 6 (ml_state) + 5 (of_state) + 6 (ll_state) = 23 bits
        println!(
            "\nTotal bits: {} + {} + {} + 6 + 5 + 6 = {} bits",
            of_bits,
            ml_bits,
            ll_bits,
            of_bits as usize + ml_bits as usize + ll_bits as usize + 17
        );

        // What reference produces:
        // [fd, e4, 88] = [11111101, 11100100, 10001000] (binary, MSB first)
        // Reading from the END (FSE backward reading):
        // 0x88 = 10001000 - bit 7 is marker, bits 0-6 are data = 0001000 (7 bits available)
        // After marker: we have 23 bits of data

        // Analyze the bit-level difference
        println!("\nBit-level analysis:");

        // Our byte 0: 0xF7 = 11110111
        // Ref byte 0: 0xFD = 11111101
        // OF extra at bits 0-1: ours=11 (3), needs to verify ref
        // ML extra at bits 2-5: ours=1011 (11 if read MSB-first from 5 down to 2)

        // Let's verify what values we get when reading MSB-first vs LSB-first
        println!(
            "Our bits 2-5: {} {} {} {} = {} (LSB-first) or {} (MSB-first)",
            (0xF7 >> 2) & 1,
            (0xF7 >> 3) & 1,
            (0xF7 >> 4) & 1,
            (0xF7 >> 5) & 1,
            (0xF7 >> 2) & 0xF, // LSB-first read
            ((0xF7 >> 5) & 1) << 3
                | ((0xF7 >> 4) & 1) << 2
                | ((0xF7 >> 3) & 1) << 1
                | ((0xF7 >> 2) & 1)  // MSB-first read
        );

        println!(
            "Ref bits 2-5: {} {} {} {} = {} (LSB-first) or {} (MSB-first)",
            (0xFD >> 2) & 1,
            (0xFD >> 3) & 1,
            (0xFD >> 4) & 1,
            (0xFD >> 5) & 1,
            (0xFD >> 2) & 0xF,
            ((0xFD >> 5) & 1) << 3
                | ((0xFD >> 4) & 1) << 2
                | ((0xFD >> 3) & 1) << 1
                | ((0xFD >> 2) & 1)
        );

        // The issue: we write 13 = 0b1101 LSB-first at bits 2-5
        // This puts: bit2=1, bit3=0, bit4=1, bit5=1
        // If read LSB-first: (bit5<<3)|(bit4<<2)|(bit3<<1)|bit2 = 8+4+0+1 = 13 ✓
        // If read MSB-first from HIGH bit position: bit5,bit4,bit3,bit2 = 1,1,0,1 = 13 ✓

        // Actually both should give 13! Let me verify what reference has...
        // Reference expects ML_extra = 13. If ref bits 2-5 differ, what value does it encode?

        // For decoder, it reads from bit position (not byte position) going DOWN
        // After reading 17 bits (states), we're at some position in F7/FD
        // Then we read ML_extra (4 bits)

        // Let me decode reference to see what ML_extra it gives
        let mut ref_bits = BitReader::new(&ref_bitstream);
        ref_bits.init_from_end().unwrap();

        // Read states (should match)
        let ref_ll = ref_bits.read_bits(6).unwrap();
        let ref_of = ref_bits.read_bits(5).unwrap();
        let ref_ml = ref_bits.read_bits(6).unwrap();
        println!(
            "\nReference decoded states: LL={}, OF={}, ML={}",
            ref_ll, ref_of, ref_ml
        );

        // Read extras
        let ref_ll_extra = 0u32; // 0 bits for LL code 4
        let ref_ml_extra = ref_bits.read_bits(4).unwrap();
        let ref_of_extra = ref_bits.read_bits(2).unwrap();
        println!(
            "Reference decoded extras: LL_extra={}, ML_extra={}, OF_extra={}",
            ref_ll_extra, ref_ml_extra, ref_of_extra
        );

        // Now decode our bitstream
        let mut our_bits = BitReader::new(&our_bitstream);
        our_bits.init_from_end().unwrap();

        let our_ll = our_bits.read_bits(6).unwrap();
        let our_of = our_bits.read_bits(5).unwrap();
        let our_ml = our_bits.read_bits(6).unwrap();
        println!(
            "\nOur decoded states: LL={}, OF={}, ML={}",
            our_ll, our_of, our_ml
        );

        let our_ll_extra = 0u32;
        let our_ml_extra = our_bits.read_bits(4).unwrap();
        let our_of_extra = our_bits.read_bits(2).unwrap();
        println!(
            "Our decoded extras: LL_extra={}, ML_extra={}, OF_extra={}",
            our_ll_extra, our_ml_extra, our_of_extra
        );

        // The real question: does reference have different extra values, or is
        // the bit reading/writing order different?
    }

    /// Debug trace of bit reading from reference FSE bytes
    #[test]
    fn test_trace_bit_reading() {
        println!("=== Tracing Bit Reading from Reference FSE Bytes ===\n");

        let fse_bytes = [0xfd, 0xe4, 0x88];
        println!("Bytes: {:02x?}", fse_bytes);
        println!("Binary:");
        println!("  0xFD = {:08b} (bits 0-7)", 0xFD);
        println!("  0xE4 = {:08b} (bits 8-15)", 0xE4);
        println!("  0x88 = {:08b} (bits 16-23)", 0x88);

        // Initialize BitReader in reversed mode
        let mut bits = BitReader::new(&fse_bytes);
        bits.init_from_end().unwrap();
        println!("\nBits available after init: {}", bits.bits_remaining());

        // Read states
        let ll_state = bits.read_bits(6).unwrap();
        println!("\nRead LL state (6 bits): {} (expect 4)", ll_state);
        println!("  Bits remaining: {}", bits.bits_remaining());

        let of_state = bits.read_bits(5).unwrap();
        println!("Read OF state (5 bits): {} (expect 14)", of_state);
        println!("  Bits remaining: {}", bits.bits_remaining());

        let ml_state = bits.read_bits(6).unwrap();
        println!("Read ML state (6 bits): {} (expect 19)", ml_state);
        println!("  Bits remaining: {}", bits.bits_remaining());

        // Switch to LSB-first mode for reading extra bits
        // (Extra bits are at the beginning of the bitstream, read from bit 0 up)
        bits.switch_to_lsb_mode().unwrap();

        // Read extras (in sequence order: LL, ML, OF)
        // LL code 4 has 0 extra bits
        // ML code 41 has 4 extra bits
        // OF code 2 has 2 extra bits

        let ll_extra = 0u32; // 0 bits for LL code 4
        println!(
            "\nRead LL extra (0 bits): {} (no extra for code 4)",
            ll_extra
        );
        println!("  Bits remaining: {}", bits.bits_remaining());

        let ml_extra = bits.read_bits(4).unwrap();
        println!("Read ML extra (4 bits): {} (expect 13)", ml_extra);
        println!("  Bits remaining: {}", bits.bits_remaining());

        let of_extra = bits.read_bits(2).unwrap();
        println!("Read OF extra (2 bits): {} (expect 3)", of_extra);
        println!("  Bits remaining: {}", bits.bits_remaining());

        // Verify values
        assert_eq!(ll_state, 4, "LL state mismatch");
        assert_eq!(of_state, 14, "OF state mismatch");
        assert_eq!(ml_state, 19, "ML state mismatch");
        assert_eq!(ml_extra, 13, "ML extra mismatch - THIS IS THE BUG!");
        assert_eq!(of_extra, 3, "OF extra mismatch");

        // Calculate what match_length we get
        let match_length = 83 + ml_extra; // baseline 83 for ML code 41
        println!("\nMatch length: 83 + {} = {}", ml_extra, match_length);
        println!(
            "Total bytes: 4 (literals) + {} (match) = {}",
            match_length,
            4 + match_length
        );
    }

    /// Test full reference frame decompression
    #[test]
    fn test_full_reference_frame_decode() {
        // Reference zstd -1 --no-check of "ABCD"x25
        let ref_frame: [u8; 19] = [
            0x28, 0xb5, 0x2f, 0xfd, // magic
            0x20, // FHD: Single_Segment=1, no checksum
            0x64, // content size = 100
            0x55, 0x00, 0x00, // block header
            0x20, // literals header
            0x41, 0x42, 0x43, 0x44, // literals "ABCD"
            0x01, // 1 sequence
            0x00, // mode byte (predefined tables)
            0xfd, 0xe4, 0x88, // FSE bitstream
        ];

        // Decompress with our decoder
        let decompressed = crate::decompress::decompress_frame(&ref_frame)
            .expect("Failed to decompress reference frame");
        let expected = "ABCD".repeat(25);

        println!("Decompressed length: {}", decompressed.len());
        println!("Expected length: {}", expected.len());
        println!(
            "First 20 bytes: {:?}",
            &decompressed[..20.min(decompressed.len())]
        );

        assert_eq!(decompressed.len(), 100, "Length mismatch");
        assert_eq!(decompressed, expected.as_bytes(), "Content mismatch");
        println!("Reference frame decompression verified!");
    }

    /// Debug test to decode reference FSE bytes and understand what they encode.
    #[test]
    fn test_decode_reference_fse_bytes() {
        // Reference FSE bytes from zstd -1 compression of "ABCD"x25
        let fse_bytes = [0xfd, 0xe4, 0x88];

        println!("=== Decoding Reference FSE Bytes ===");
        println!("Bytes: {:02x?}", fse_bytes);

        // Build predefined tables
        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();
        let of_table =
            FseTable::from_predefined(&OFFSET_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG).unwrap();
        let ml_table = FseTable::from_predefined(
            &MATCH_LENGTH_DEFAULT_DISTRIBUTION,
            MATCH_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        // Create decoders
        let mut ll_decoder = FseDecoder::new(&ll_table);
        let mut of_decoder = FseDecoder::new(&of_table);
        let mut ml_decoder = FseDecoder::new(&ml_table);

        // Init bit reader from end
        let mut bits = BitReader::new(&fse_bytes);
        bits.init_from_end().unwrap();
        println!("Bits available after init: {}", bits.bits_remaining());

        // Read initial states (LL, OF, ML order)
        ll_decoder.init_state(&mut bits).unwrap();
        of_decoder.init_state(&mut bits).unwrap();
        ml_decoder.init_state(&mut bits).unwrap();

        let ll_state = ll_decoder.state();
        let of_state = of_decoder.state();
        let ml_state = ml_decoder.state();

        println!(
            "Initial states: LL={}, OF={}, ML={}",
            ll_state, of_state, ml_state
        );
        println!("Bits remaining after states: {}", bits.bits_remaining());

        // Get symbols from states
        let ll_code = ll_table.decode(ll_state).symbol;
        let of_code = of_table.decode(of_state).symbol;
        let ml_code = ml_table.decode(ml_state).symbol;

        println!("Symbols from states:");
        println!("  LL code {} (from state {})", ll_code, ll_state);
        println!("  OF code {} (from state {})", of_code, of_state);
        println!("  ML code {} (from state {})", ml_code, ml_state);

        // Print what these codes mean:
        println!("\nCode meanings:");

        // LL code interpretation
        if ll_code <= 15 {
            println!(
                "  LL code {}: literal_length = {} (no extra bits)",
                ll_code, ll_code
            );
        } else {
            let extra_bits = match ll_code {
                16..=17 => 1,
                18..=19 => 1,
                20..=21 => 2,
                22..=23 => 3,
                24..=25 => 4,
                26..=27 => 5,
                28..=29 => 6,
                30..=31 => 7,
                32..=33 => 8,
                34..=35 => 9,
                _ => 0,
            };
            println!("  LL code {}: needs {} extra bits", ll_code, extra_bits);
        }

        // OF code = offset code, number of extra bits = of_code
        println!(
            "  OF code {}: offset = 2^{} + {} extra bits",
            of_code, of_code, of_code
        );

        // ML code interpretation
        if ml_code <= 31 {
            println!(
                "  ML code {}: match_length = {} (no extra bits)",
                ml_code,
                ml_code + 3
            );
        } else {
            println!("  ML code {}: needs extra bits", ml_code);
        }

        // Read remaining extra bits
        let remaining = bits.bits_remaining();
        println!("\nRemaining bits for extras: {}", remaining);

        // For a single sequence with predefined tables, the extra bits should be:
        // LL extra, ML extra, OF extra (in read order)
        // But we need to know how many bits each needs
    }

    /// Debug test to trace init_state calculation.
    #[test]
    fn test_trace_init_state() {
        println!("=== Tracing init_state calculation ===\n");

        // Build LL table and encoder
        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let encoder = TansEncoder::from_decode_table(&ll_table);

        // Print which states decode to symbol 0
        println!("States that decode to LL symbol 0:");
        for state in 0..64 {
            let entry = ll_table.decode(state);
            if entry.symbol == 0 {
                println!(
                    "  State {}: symbol={}, num_bits={}, baseline={}",
                    state, entry.symbol, entry.num_bits, entry.baseline
                );
            }
        }

        // Print symbol params for symbol 0
        let params = &encoder.symbol_params[0];
        println!("\nSymbol 0 params:");
        println!(
            "  delta_nb_bits: {} (0x{:x})",
            params.delta_nb_bits, params.delta_nb_bits
        );
        println!("  delta_find_state: {}", params.delta_find_state);

        // Trace init_state calculation
        let sym_idx = 0usize;
        let nb_bits_out = ((params.delta_nb_bits as u64 + 0x8000) >> 16) as u32;
        let value = ((nb_bits_out as u64) << 16).wrapping_sub(params.delta_nb_bits as u64) as u32;
        let value_shifted = if nb_bits_out >= 32 {
            0
        } else {
            value >> nb_bits_out
        };
        let idx = value_shifted as i64 + params.delta_find_state as i64;

        println!("\ninit_state(0) calculation:");
        println!(
            "  nb_bits_out = ({} + 0x8000) >> 16 = {}",
            params.delta_nb_bits, nb_bits_out
        );
        println!(
            "  value = ({} << 16) - {} = {}",
            nb_bits_out, params.delta_nb_bits, value
        );
        println!(
            "  value_shifted = {} >> {} = {}",
            value, nb_bits_out, value_shifted
        );
        println!(
            "  idx = {} + {} = {}",
            value_shifted, params.delta_find_state, idx
        );
        println!(
            "  state_table[{}] = {}",
            idx, encoder.state_table[idx as usize]
        );
        println!(
            "  Final decode_state = {} - 64 = {}",
            encoder.state_table[idx as usize],
            encoder.state_table[idx as usize] as i32 - 64
        );

        // What init state does our encoder produce?
        let mut test_encoder = TansEncoder::from_decode_table(&ll_table);
        test_encoder.init_state(0);
        let our_state = test_encoder.get_state();
        println!("\nOur init_state(0) produces decode_state: {}", our_state);

        // Verify it decodes to symbol 0
        let entry = ll_table.decode(our_state as usize);
        println!("State {} decodes to symbol {}", our_state, entry.symbol);

        // What's at state 38 (reference)?
        let ref_entry = ll_table.decode(38);
        println!(
            "\nReference state 38 decodes to symbol {}",
            ref_entry.symbol
        );
    }

    /// Test init_state for the specific codes used by reference.
    #[test]
    fn test_init_state_for_reference_codes() {
        println!("=== Init State for Reference Codes ===\n");

        // Reference encodes: LL=4, OF=2, ML=41
        // Reference states: LL=4, OF=14, ML=19

        // Build tables
        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();
        let of_table =
            FseTable::from_predefined(&OFFSET_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG).unwrap();
        let ml_table = FseTable::from_predefined(
            &MATCH_LENGTH_DEFAULT_DISTRIBUTION,
            MATCH_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        // Build encoders
        let mut ll_encoder = TansEncoder::from_decode_table(&ll_table);
        let mut of_encoder = TansEncoder::from_decode_table(&of_table);
        let mut ml_encoder = TansEncoder::from_decode_table(&ml_table);

        // Test LL code 4
        ll_encoder.init_state(4);
        let our_ll_state = ll_encoder.get_state();
        let ref_ll_state = 4u32;
        let ll_entry = ll_table.decode(our_ll_state as usize);
        println!("LL code 4:");
        println!("  Reference state: {}", ref_ll_state);
        println!("  Our state: {}", our_ll_state);
        println!("  Our state decodes to symbol: {}", ll_entry.symbol);
        println!("  Match: {}", our_ll_state == ref_ll_state);

        // Test OF code 1 (repeat offset 2 = 4)
        of_encoder.init_state(1);
        let of_state_for_code1 = of_encoder.get_state();
        println!("\nOF code 1 (repeat offset 2 = 4):");
        println!("  Our state: {}", of_state_for_code1);
        println!(
            "  Decodes to symbol: {}",
            of_table.decode(of_state_for_code1 as usize).symbol
        );

        // Test OF code 2
        of_encoder.init_state(2);
        let our_of_state = of_encoder.get_state();
        let ref_of_state = 14u32;
        let of_entry = of_table.decode(our_of_state as usize);
        println!("\nOF code 2:");
        println!("  Reference state: {}", ref_of_state);
        println!("  Our state: {}", our_of_state);
        println!("  Our state decodes to symbol: {}", of_entry.symbol);
        println!("  Match: {}", our_of_state == ref_of_state);

        // Test ML code 41
        ml_encoder.init_state(41);
        let our_ml_state = ml_encoder.get_state();
        let ref_ml_state = 19u32;
        let ml_entry = ml_table.decode(our_ml_state as usize);
        println!("\nML code 41:");
        println!("  Reference state: {}", ref_ml_state);
        println!("  Our state: {}", our_ml_state);
        println!("  Our state decodes to symbol: {}", ml_entry.symbol);
        println!("  Match: {}", our_ml_state == ref_ml_state);

        // Print which states decode to each symbol
        println!("\n--- States that decode to symbol 4 in LL table ---");
        for state in 0..64 {
            if ll_table.decode(state).symbol == 4 {
                println!("  State {}", state);
            }
        }

        println!("\n--- Full OF table (state -> symbol) ---");
        for state in 0..32 {
            let entry = of_table.decode(state);
            println!(
                "  State {:2} -> symbol {:2} (num_bits={}, baseline={})",
                state, entry.symbol, entry.num_bits, entry.baseline
            );
        }

        println!("\n--- States that decode to symbol 1 in OF table (for offset 4) ---");
        for state in 0..32 {
            if of_table.decode(state).symbol == 1 {
                println!("  State {}", state);
            }
        }

        println!("\n--- States that decode to symbol 5 in OF table (for offset 4-7) ---");
        for state in 0..32 {
            if of_table.decode(state).symbol == 5 {
                println!("  State {}", state);
            }
        }

        println!("\n--- States that decode to symbol 41 in ML table ---");
        for state in 0..64 {
            if ml_table.decode(state).symbol == 41 {
                println!("  State {}", state);
            }
        }

        // Assert matches
        assert_eq!(our_ll_state, ref_ll_state, "LL state mismatch");
        assert_eq!(our_of_state, ref_of_state, "OF state mismatch");
        assert_eq!(our_ml_state, ref_ml_state, "ML state mismatch");
    }

    /// Debug: print state_table construction
    #[test]
    fn test_state_table_construction() {
        println!("=== State Table Construction ===\n");

        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let encoder = TansEncoder::from_decode_table(&ll_table);

        // Print first 20 entries of state_table
        println!("state_table (first 20 entries):");
        for i in 0..20 {
            let encoder_state = encoder.state_table[i];
            let decode_state = encoder_state as i32 - 64;
            let entry = ll_table.decode(decode_state as usize);
            println!(
                "  state_table[{:2}] = {} (decode_state={}, symbol={})",
                i, encoder_state, decode_state, entry.symbol
            );
        }

        // Print symbol params
        println!("\nSymbol params (first 10 symbols):");
        for sym in 0..10 {
            if sym < encoder.symbol_params.len() {
                let params = &encoder.symbol_params[sym];
                println!(
                    "  Symbol {:2}: delta_nb_bits={:6}, delta_find_state={:3}",
                    sym, params.delta_nb_bits, params.delta_find_state
                );
            }
        }
    }

    #[test]
    fn test_tans_encode_decode_roundtrip() {
        let table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let mut encoder = TansEncoder::from_decode_table(&table);
        let accuracy_log = encoder.accuracy_log;

        // Encode a simple sequence: [0, 0, 0]
        let symbols = [0u8, 0, 0];

        println!("symbol_params len: {}", encoder.symbol_params.len());
        println!(
            "num_bits_per_state len: {}",
            encoder.num_bits_per_state.len()
        );
        println!(
            "baseline_per_state len: {}",
            encoder.baseline_per_state.len()
        );

        // Debug: print symbol params for symbol 0
        let params0 = &encoder.symbol_params[0];
        println!(
            "Symbol 0 params: delta_nb_bits={}, delta_find_state={}",
            params0.delta_nb_bits, params0.delta_find_state
        );
        println!(
            "  Expected nbBitsOut at state 64: (64 + {}) >> 16 = {}",
            params0.delta_nb_bits,
            (64u64 + params0.delta_nb_bits as u64) >> 16
        );

        // Print decode table for first few states
        println!("Decode table:");
        for s in 0..4 {
            let entry = table.decode(s);
            println!(
                "  state {}: symbol={}, num_bits={}, baseline={}",
                s, entry.symbol, entry.num_bits, entry.baseline
            );
        }

        // Initialize with last symbol (no bits output)
        encoder.init_state(symbols[2]);
        let init_state = encoder.state;
        println!(
            "After init_state(0): encoder_state={}, decode_state={}",
            init_state,
            init_state.saturating_sub(64)
        );

        // Collect bits from encoding remaining symbols in reverse
        let mut all_bits: Vec<(u32, u8)> = Vec::new();
        for &sym in symbols[..2].iter().rev() {
            let old_state = encoder.state;
            let old_decode = old_state.saturating_sub(64);
            println!(
                "Before encode sym={}: encoder_state={}, decode_state={}",
                sym, old_state, old_decode
            );
            let (bits, nb) = encoder.encode_symbol(sym);
            let new_decode = encoder.state.saturating_sub(64);
            println!(
                "After encode: bits={}, nb_bits={}, new_decode_state={}",
                bits, nb, new_decode
            );
            all_bits.push((bits, nb));
        }

        // Get final state for decoder init
        let final_state = encoder.get_state();

        // Build bitstream: bits in forward order, then final state
        // Reader reads backwards, so forward write order gives correct read order
        let mut writer = FseBitWriter::new();
        for (bits, nb) in all_bits.iter() {
            writer.write_bits(*bits, *nb);
        }
        writer.write_bits(final_state, accuracy_log);
        let bitstream = writer.finish();

        println!("Encoded sequence {:?}", symbols);
        println!("Init state: {}, Final state: {}", init_state, final_state);
        println!("Bits: {:?}", all_bits);
        println!("Bitstream ({} bytes): {:?}", bitstream.len(), bitstream);

        // Decode
        let mut decoder = FseDecoder::new(&table);
        let mut bits_reader = BitReader::new(&bitstream);
        bits_reader.init_from_end().unwrap();
        println!(
            "Bits remaining after init_from_end: {}",
            bits_reader.bits_remaining()
        );

        // Read initial state
        decoder.init_state(&mut bits_reader).unwrap();
        println!("Decoder initial state: {}", decoder.state());
        println!(
            "Bits remaining after init_state: {}",
            bits_reader.bits_remaining()
        );

        // Decode symbols
        // Note: For N symbols, we encode N-1 (the first is just initialized)
        // So we decode N-1 symbols that read bits, then peek the last symbol
        let mut decoded = Vec::new();

        // Decode first N-1 symbols (these read bits)
        for i in 0..2 {
            let entry = table.decode(decoder.state());
            println!(
                "Before decode[{}]: state={}, needs {} bits, bits_remaining={}",
                i,
                decoder.state(),
                entry.num_bits,
                bits_reader.bits_remaining()
            );

            let sym = decoder.decode_symbol(&mut bits_reader).unwrap();
            decoded.push(sym);
            println!("Decoded: {}, new state: {}", sym, decoder.state());
        }

        // Last symbol: just peek, don't read bits (this was the initialized one)
        let last_sym = decoder.peek_symbol();
        decoded.push(last_sym);
        println!("Last symbol (peek): {}", last_sym);

        println!("Decoded sequence: {:?}", decoded);
        assert_eq!(
            decoded,
            symbols.to_vec(),
            "Decoded sequence doesn't match original"
        );
    }

    #[test]
    fn test_tans_mixed_symbols_roundtrip() {
        let table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        // Debug: print decode table for first 40 states
        println!("Decode table (first 40 states):");
        for s in 0..40 {
            let entry = table.decode(s);
            println!(
                "  state {:2}: symbol={:2}, num_bits={}, baseline={:2}",
                s, entry.symbol, entry.num_bits, entry.baseline
            );
        }

        let mut encoder = TansEncoder::from_decode_table(&table);
        let accuracy_log = encoder.accuracy_log;

        // Encode a sequence with different symbols: [0, 1, 2, 0, 1]
        let symbols = [0u8, 1, 2, 0, 1];

        println!("\nEncoding symbols: {:?}", symbols);

        // Initialize with last symbol
        encoder.init_state(symbols[4]);
        println!("After init_state({}): state={}", symbols[4], encoder.state);

        // Encode remaining in reverse
        let mut all_bits: Vec<(u32, u8)> = Vec::new();
        for &sym in symbols[..4].iter().rev() {
            let (bits, nb) = encoder.encode_symbol(sym);
            println!(
                "Encode sym={}: bits={}, nb_bits={}, new_state={}",
                sym, bits, nb, encoder.state
            );
            all_bits.push((bits, nb));
        }

        let final_state = encoder.get_state();
        println!("Final state: {}", final_state);

        // Build bitstream
        // Bits are read backwards, so write in forward order: B4, B3, B2, B1, then D_0
        // This way reader gets: D_0, B1, B2, B3, B4 (correct order for decoding)
        let mut writer = FseBitWriter::new();
        for (bits, nb) in all_bits.iter() {
            // Forward order: B4, B3, B2, B1
            writer.write_bits(*bits, *nb);
        }
        writer.write_bits(final_state, accuracy_log);
        let bitstream = writer.finish();

        println!("Bitstream ({} bytes): {:?}", bitstream.len(), bitstream);

        // Decode
        let mut decoder = FseDecoder::new(&table);
        let mut bits_reader = BitReader::new(&bitstream);
        bits_reader.init_from_end().unwrap();

        decoder.init_state(&mut bits_reader).unwrap();
        println!("Decoder initial state: {}", decoder.state());

        let mut decoded = Vec::new();
        for _ in 0..4 {
            let sym = decoder.decode_symbol(&mut bits_reader).unwrap();
            decoded.push(sym);
            println!("Decoded: {}, new state: {}", sym, decoder.state());
        }
        let last_sym = decoder.peek_symbol();
        decoded.push(last_sym);

        println!("Decoded sequence: {:?}", decoded);
        assert_eq!(
            decoded,
            symbols.to_vec(),
            "Decoded sequence doesn't match original"
        );
    }

    #[test]
    fn test_ml_codes_38_and_43() {
        println!("\n=== ML Codes 38 and 43 State Mapping ===");

        // Build ML table
        let ml_table = FseTable::from_predefined(
            &MATCH_LENGTH_DEFAULT_DISTRIBUTION,
            MATCH_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let mut encoder = TansEncoder::from_decode_table(&ml_table);

        // Test code 38
        encoder.init_state(38);
        let state_38 = encoder.get_state();
        let decode_38 = ml_table.decode(state_38 as usize);
        println!(
            "ML code 38 -> state {} -> decodes to symbol {}",
            state_38, decode_38.symbol
        );

        // Test code 43
        encoder.init_state(43);
        let state_43 = encoder.get_state();
        let decode_43 = ml_table.decode(state_43 as usize);
        println!(
            "ML code 43 -> state {} -> decodes to symbol {}",
            state_43, decode_43.symbol
        );

        // Verify they decode correctly
        assert_eq!(
            decode_38.symbol, 38,
            "State {} should decode to symbol 38",
            state_38
        );
        assert_eq!(
            decode_43.symbol, 43,
            "State {} should decode to symbol 43",
            state_43
        );
    }

    #[test]
    fn test_ll_code_23() {
        println!("\n=== LL Code 23 State Mapping ===");

        // Build LL table
        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        let mut encoder = TansEncoder::from_decode_table(&ll_table);

        // Test code 23
        encoder.init_state(23);
        let state_23 = encoder.get_state();
        let decode_23 = ll_table.decode(state_23 as usize);
        println!(
            "LL code 23 -> state {} -> decodes to symbol {}",
            state_23, decode_23.symbol
        );

        // Verify it decodes correctly
        assert_eq!(
            decode_23.symbol, 23,
            "State {} should decode to symbol 23",
            state_23
        );
    }
}

#[cfg(test)]
mod trace_tests {
    use super::*;
    use crate::fse::{
        LITERAL_LENGTH_ACCURACY_LOG, LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
        MATCH_LENGTH_ACCURACY_LOG, MATCH_LENGTH_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG,
        OFFSET_DEFAULT_DISTRIBUTION,
    };

    #[test]
    fn test_trace_encode_sequence() {
        println!("\n=== Trace FSE Encode Sequence ===\n");

        // Build tables
        let ll_table = FseTable::from_predefined(
            &LITERAL_LENGTH_DEFAULT_DISTRIBUTION,
            LITERAL_LENGTH_ACCURACY_LOG,
        )
        .unwrap();
        let of_table =
            FseTable::from_predefined(&OFFSET_DEFAULT_DISTRIBUTION, OFFSET_ACCURACY_LOG).unwrap();
        let ml_table = FseTable::from_predefined(
            &MATCH_LENGTH_DEFAULT_DISTRIBUTION,
            MATCH_LENGTH_ACCURACY_LOG,
        )
        .unwrap();

        // Build encoders
        let mut ll_enc = TansEncoder::from_decode_table(&ll_table);
        let mut of_enc = TansEncoder::from_decode_table(&of_table);
        let mut ml_enc = TansEncoder::from_decode_table(&ml_table);

        // Print symbol params for relevant symbols
        println!(
            "LL symbol 0 params: delta_nb_bits={}, delta_find_state={}",
            ll_enc.symbol_params[0].delta_nb_bits, ll_enc.symbol_params[0].delta_find_state
        );
        println!(
            "LL symbol 4 params: delta_nb_bits={}, delta_find_state={}",
            ll_enc.symbol_params[4].delta_nb_bits, ll_enc.symbol_params[4].delta_find_state
        );

        // Init with seq[1] codes
        ll_enc.init_state(0);
        of_enc.init_state(2);
        ml_enc.init_state(43);

        let ll_s0 = ll_enc.state;
        let of_s0 = of_enc.state;
        let ml_s0 = ml_enc.state;
        println!("\nAfter init:");
        println!(
            "  LL: encoder_state={}, decoder_state={}",
            ll_s0,
            ll_s0 - 64
        );
        println!(
            "  OF: encoder_state={}, decoder_state={}",
            of_s0,
            of_s0 - 32
        );
        println!(
            "  ML: encoder_state={}, decoder_state={}",
            ml_s0,
            ml_s0 - 64
        );

        // Encode seq[0] codes
        println!("\nEncoding seq[0] codes (4, 2, 45):");

        // LL
        let ll_params = &ll_enc.symbol_params[4];
        let ll_nb = ((ll_s0 as u64 + ll_params.delta_nb_bits as u64) >> 16) as u8;
        let ll_bits = ll_s0 & ((1u32 << ll_nb) - 1);
        println!(
            "  LL: state={}, delta_nb_bits={}, nb_bits_out={}, bits={}",
            ll_s0, ll_params.delta_nb_bits, ll_nb, ll_bits
        );
        let (ll_out_bits, ll_out_nb) = ll_enc.encode_symbol(4);
        println!(
            "  LL encode_symbol output: bits={}, nb={}",
            ll_out_bits, ll_out_nb
        );

        // OF
        let of_params = &of_enc.symbol_params[2];
        let of_nb = ((of_s0 as u64 + of_params.delta_nb_bits as u64) >> 16) as u8;
        let of_bits = of_s0 & ((1u32 << of_nb) - 1);
        println!(
            "  OF: state={}, delta_nb_bits={}, nb_bits_out={}, bits={}",
            of_s0, of_params.delta_nb_bits, of_nb, of_bits
        );
        let (of_out_bits, of_out_nb) = of_enc.encode_symbol(2);
        println!(
            "  OF encode_symbol output: bits={}, nb={}",
            of_out_bits, of_out_nb
        );

        // ML
        let ml_params = &ml_enc.symbol_params[45];
        let ml_nb = ((ml_s0 as u64 + ml_params.delta_nb_bits as u64) >> 16) as u8;
        let ml_bits = ml_s0 & ((1u32 << ml_nb) - 1);
        println!(
            "  ML: state={}, delta_nb_bits={}, nb_bits_out={}, bits={}",
            ml_s0, ml_params.delta_nb_bits, ml_nb, ml_bits
        );
        let (ml_out_bits, ml_out_nb) = ml_enc.encode_symbol(45);
        println!(
            "  ML encode_symbol output: bits={}, nb={}",
            ml_out_bits, ml_out_nb
        );

        let ll_s1 = ll_enc.state;
        let of_s1 = of_enc.state;
        let ml_s1 = ml_enc.state;
        println!("\nAfter encode:");
        println!(
            "  LL: encoder_state={}, decoder_state={}",
            ll_s1,
            ll_s1 - 64
        );
        println!(
            "  OF: encoder_state={}, decoder_state={}",
            of_s1,
            of_s1 - 32
        );
        println!(
            "  ML: encoder_state={}, decoder_state={}",
            ml_s1,
            ml_s1 - 64
        );

        // Verify decode table
        println!("\nDecode table verification:");
        println!(
            "  LL[{}] = symbol {}",
            ll_s1 - 64,
            ll_table.decode((ll_s1 - 64) as usize).symbol
        );
        println!(
            "  OF[{}] = symbol {}",
            of_s1 - 32,
            of_table.decode((of_s1 - 32) as usize).symbol
        );
        println!(
            "  ML[{}] = symbol {}",
            ml_s1 - 64,
            ml_table.decode((ml_s1 - 64) as usize).symbol
        );
    }
}