rebgzf 0.2.0

Efficient gzip to BGZF transcoder using Puffin-style half-decompression
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
use super::tables::{CODE_LENGTH_ORDER, DISTANCE_TABLE, LENGTH_TABLE};
use super::tokens::{CodeLengths, LZ77Block, LZ77Token};
use crate::bits::{BitRead, BitReader, SliceBitReader};
use crate::error::{Error, Result};
use crate::huffman::HuffmanDecoder;
use std::io::Read;

/// Parses DEFLATE blocks and extracts LZ77 stream.
///
/// Generic over the bit reader type to support both stream-based (`BitReader<R>`)
/// and slice-based (`SliceBitReader`) inputs.
pub struct DeflateParser<B: BitRead> {
    bits: B,
    /// Whether we've seen the final block
    finished: bool,
}

impl<R: Read> DeflateParser<BitReader<R>> {
    /// Create a parser from a `Read` source (stdin, network, etc.)
    pub fn new(reader: R) -> Self {
        Self { bits: BitReader::new(reader), finished: false }
    }
}

impl<'a> DeflateParser<SliceBitReader<'a>> {
    /// Create a parser from a byte slice (e.g., mmap'd file).
    /// `offset` is the byte position where DEFLATE data starts (after gzip header).
    pub fn from_slice(data: &'a [u8], offset: usize) -> Self {
        let mut bits = SliceBitReader::new(data);
        bits.set_position(offset);
        Self { bits, finished: false }
    }
}

/// Internal helper: parse dynamic Huffman tables and also return the raw code length vecs.
///
/// Returns `(lit_lengths, dist_lengths, lit_decoder, dist_decoder)`.
#[allow(clippy::type_complexity)]
fn parse_dynamic_huffman_tables_inner<B: BitRead>(
    bits: &mut B,
) -> Result<(Vec<u8>, Vec<u8>, HuffmanDecoder, Option<HuffmanDecoder>)> {
    // Read header
    let hlit = bits.read_bits(5)? as usize + 257; // # of literal/length codes
    let hdist = bits.read_bits(5)? as usize + 1; // # of distance codes
    let hclen = bits.read_bits(4)? as usize + 4; // # of code length codes

    // Read code length code lengths
    let mut code_length_lengths = [0u8; 19];
    for i in 0..hclen {
        code_length_lengths[CODE_LENGTH_ORDER[i]] = bits.read_bits(3)? as u8;
    }

    // Build code length decoder
    let code_length_decoder = HuffmanDecoder::from_code_lengths(&code_length_lengths)?;

    // Decode literal/length and distance code lengths
    let total_codes = hlit + hdist;
    let mut all_lengths = Vec::with_capacity(total_codes);

    while all_lengths.len() < total_codes {
        let sym = code_length_decoder.decode(bits)?;

        match sym {
            0..=15 => {
                // Literal code length
                all_lengths.push(sym as u8);
            }
            16 => {
                // Copy previous code length 3-6 times
                let repeat = bits.read_bits(2)? as usize + 3;
                let prev = *all_lengths.last().ok_or(Error::HuffmanIncomplete)?;
                if all_lengths.len() + repeat > total_codes {
                    return Err(Error::HuffmanIncomplete);
                }
                for _ in 0..repeat {
                    all_lengths.push(prev);
                }
            }
            17 => {
                // Repeat zero 3-10 times
                let repeat = bits.read_bits(3)? as usize + 3;
                if all_lengths.len() + repeat > total_codes {
                    return Err(Error::HuffmanIncomplete);
                }
                all_lengths.resize(all_lengths.len() + repeat, 0);
            }
            18 => {
                // Repeat zero 11-138 times
                let repeat = bits.read_bits(7)? as usize + 11;
                if all_lengths.len() + repeat > total_codes {
                    return Err(Error::HuffmanIncomplete);
                }
                all_lengths.resize(all_lengths.len() + repeat, 0);
            }
            _ => return Err(Error::InvalidHuffmanSymbol(sym)),
        }
    }

    // Split into literal/length and distance lengths
    let literal_lengths: Vec<u8> = all_lengths[..hlit].to_vec();
    let distance_lengths: Vec<u8> = all_lengths[hlit..].to_vec();

    // Build decoders
    let lit_decoder = HuffmanDecoder::from_code_lengths(&literal_lengths)?;
    let dist_decoder = if distance_lengths.iter().all(|&l| l == 0) {
        // No distance codes - this is valid for blocks with only literals
        None
    } else {
        Some(HuffmanDecoder::from_code_lengths(&distance_lengths)?)
    };

    Ok((literal_lengths, distance_lengths, lit_decoder, dist_decoder))
}

/// Parse the dynamic Huffman tables from a DEFLATE block header.
///
/// Reads HLIT, HDIST, HCLEN, the code length code lengths, and the full code length
/// sequence from `bits`, then builds and returns `(lit_decoder, dist_decoder)`.
///
/// `dist_decoder` is `None` when the distance code lengths are all zero (literal-only blocks).
///
/// The caller is responsible for having already consumed the BFINAL and BTYPE bits before
/// calling this function.
pub fn parse_dynamic_huffman_tables<B: BitRead>(
    bits: &mut B,
) -> Result<(HuffmanDecoder, Option<HuffmanDecoder>)> {
    let (_, _, lit_decoder, dist_decoder) = parse_dynamic_huffman_tables_inner(bits)?;
    Ok((lit_decoder, dist_decoder))
}

impl<B: BitRead> DeflateParser<B> {
    /// Parse the next DEFLATE block, returning LZ77 tokens
    /// Returns None when stream is exhausted
    pub fn parse_block(&mut self) -> Result<Option<LZ77Block>> {
        if self.finished {
            return Ok(None);
        }

        let is_final = self.bits.read_bit()?;
        let block_type = self.bits.read_bits(2)? as u8;

        let block = match block_type {
            0 => self.parse_stored_block(is_final)?,
            1 => self.parse_fixed_block(is_final)?,
            2 => self.parse_dynamic_block(is_final)?,
            _ => return Err(Error::InvalidBlockType(block_type)),
        };

        if is_final {
            self.finished = true;
        }

        Ok(Some(block))
    }

    /// Parse a stored (uncompressed) block
    fn parse_stored_block(&mut self, is_final: bool) -> Result<LZ77Block> {
        // Align to byte boundary
        self.bits.align_to_byte();

        // Read LEN and NLEN
        let len = self.bits.read_u16_le()?;
        let nlen = self.bits.read_u16_le()?;

        // Verify LEN and NLEN are complements
        if len != !nlen {
            return Err(Error::StoredBlockLengthMismatch { len, nlen });
        }

        // Read literal bytes
        let mut tokens = Vec::with_capacity(len as usize + 1);
        for _ in 0..len {
            let byte = self.bits.read_bits(8)? as u8;
            tokens.push(LZ77Token::Literal(byte));
        }
        tokens.push(LZ77Token::EndOfBlock);

        Ok(LZ77Block::new(tokens, is_final, 0))
    }

    /// Parse a block with fixed Huffman codes
    fn parse_fixed_block(&mut self, is_final: bool) -> Result<LZ77Block> {
        let lit_decoder = HuffmanDecoder::fixed_literal_length();
        let dist_decoder = HuffmanDecoder::fixed_distance();

        let tokens = self.decode_symbols(&lit_decoder, &dist_decoder)?;
        Ok(LZ77Block::new(tokens, is_final, 1))
    }

    /// Parse a block with dynamic Huffman codes
    fn parse_dynamic_block(&mut self, is_final: bool) -> Result<LZ77Block> {
        let (literal_lengths, distance_lengths, lit_decoder, dist_decoder) =
            parse_dynamic_huffman_tables_inner(&mut self.bits)?;

        // Decode symbols
        let tokens = self.decode_symbols_with_optional_dist(&lit_decoder, dist_decoder.as_ref())?;

        let mut block = LZ77Block::new(tokens, is_final, 2);
        block.code_lengths = Some(CodeLengths { literal_lengths, distance_lengths });

        Ok(block)
    }

    /// Decode symbols using literal/length and distance decoders.
    /// This is the hot path — called for every DEFLATE block.
    #[inline(never)] // Prevent inlining into parse_block to keep it in its own hot function
    fn decode_symbols(
        &mut self,
        lit_decoder: &HuffmanDecoder,
        dist_decoder: &HuffmanDecoder,
    ) -> Result<Vec<LZ77Token>> {
        let mut tokens = Vec::with_capacity(8192);

        loop {
            let sym = lit_decoder.decode(&mut self.bits)?;

            if sym <= 255 {
                // Literal byte — most common case (~60% of symbols)
                tokens.push(LZ77Token::Literal(sym as u8));
                continue;
            }

            if sym == 256 {
                // End of block
                tokens.push(LZ77Token::EndOfBlock);
                break;
            }

            // Length code (257..=285)
            if sym > 285 {
                return Err(Error::InvalidLengthCode(sym));
            }

            let len_idx = (sym - 257) as usize;
            // Safety: len_idx is 0..28, LENGTH_TABLE has 29 entries
            let (base_len, extra_bits) = unsafe { *LENGTH_TABLE.get_unchecked(len_idx) };
            let extra = if extra_bits > 0 { self.bits.read_bits(extra_bits)? } else { 0 };
            let length = base_len + extra as u16;

            // Read distance
            let dist_sym = dist_decoder.decode(&mut self.bits)?;
            if dist_sym > 29 {
                return Err(Error::InvalidDistanceCode(dist_sym));
            }

            // Safety: dist_sym <= 29, DISTANCE_TABLE has 30 entries
            let (base_dist, dist_extra_bits) =
                unsafe { *DISTANCE_TABLE.get_unchecked(dist_sym as usize) };
            let dist_extra =
                if dist_extra_bits > 0 { self.bits.read_bits(dist_extra_bits)? } else { 0 };
            let distance = base_dist + dist_extra as u16;

            tokens.push(LZ77Token::Copy { length, distance });
        }

        Ok(tokens)
    }

    /// Decode symbols, optionally using a distance decoder (for blocks with no distance codes)
    fn decode_symbols_with_optional_dist(
        &mut self,
        lit_decoder: &HuffmanDecoder,
        dist_decoder: Option<&HuffmanDecoder>,
    ) -> Result<Vec<LZ77Token>> {
        // Fast path: if we have a distance decoder, use the optimized version
        if let Some(dist_dec) = dist_decoder {
            return self.decode_symbols(lit_decoder, dist_dec);
        }

        // Slow path: no distance decoder (rare — blocks with only literals)
        let mut tokens = Vec::with_capacity(8192);

        loop {
            let sym = lit_decoder.decode(&mut self.bits)?;

            match sym {
                0..=255 => tokens.push(LZ77Token::Literal(sym as u8)),
                256 => {
                    tokens.push(LZ77Token::EndOfBlock);
                    break;
                }
                257..=285 => {
                    return Err(Error::InvalidDistanceCode(0));
                }
                _ => return Err(Error::InvalidLengthCode(sym)),
            }
        }

        Ok(tokens)
    }

    /// Get bytes read so far
    pub fn bytes_read(&self) -> u64 {
        self.bits.bytes_read()
    }

    /// Check if we've finished parsing
    pub fn is_finished(&self) -> bool {
        self.finished
    }

    /// Get the underlying bit reader (for reading trailer)
    pub fn into_inner(self) -> B {
        self.bits
    }

    /// Read the gzip trailer (CRC32, ISIZE) and check for another gzip member.
    /// Returns Ok(true) if another member follows, Ok(false) if EOF.
    /// Must be called after all DEFLATE blocks are parsed (is_finished() == true).
    pub fn read_trailer_and_check_next(&mut self) -> Result<bool> {
        if !self.finished {
            return Err(Error::Internal("Cannot read trailer before DEFLATE is finished".into()));
        }

        // Align to byte boundary (discard any remaining bits)
        self.bits.align_to_byte();

        // Read CRC32 and ISIZE (we don't validate them, just skip)
        let _crc32 = self.bits.read_u32_le()?;
        let _isize = self.bits.read_u32_le()?;

        // Try to read the next gzip magic bytes
        match self.bits.read_bits(8) {
            Ok(b1) => {
                match self.bits.read_bits(8) {
                    Ok(b2) => {
                        if b1 == 0x1f && b2 == 0x8b {
                            // Another gzip member! Reset parser state.
                            // Skip the rest of the gzip header (we already read magic)
                            // Read compression method
                            let method = self.bits.read_bits(8)? as u8;
                            if method != 8 {
                                return Err(Error::UnsupportedCompressionMethod(method));
                            }

                            // Read flags
                            let flags = self.bits.read_bits(8)? as u8;

                            // Skip mtime (4 bytes), xfl (1), os (1)
                            let _mtime = self.bits.read_u32_le()?;
                            let _xfl = self.bits.read_bits(8)?;
                            let _os = self.bits.read_bits(8)?;

                            // Handle optional fields based on flags
                            const FEXTRA: u8 = 1 << 2;
                            const FNAME: u8 = 1 << 3;
                            const FCOMMENT: u8 = 1 << 4;
                            const FHCRC: u8 = 1 << 1;

                            if flags & FEXTRA != 0 {
                                let xlen = self.bits.read_u16_le()?;
                                for _ in 0..xlen {
                                    self.bits.read_bits(8)?;
                                }
                            }

                            if flags & FNAME != 0 {
                                // Read null-terminated string
                                loop {
                                    if self.bits.read_bits(8)? == 0 {
                                        break;
                                    }
                                }
                            }

                            if flags & FCOMMENT != 0 {
                                // Read null-terminated string
                                loop {
                                    if self.bits.read_bits(8)? == 0 {
                                        break;
                                    }
                                }
                            }

                            if flags & FHCRC != 0 {
                                let _hcrc = self.bits.read_u16_le()?;
                            }

                            // Reset finished flag for next member
                            self.finished = false;
                            Ok(true)
                        } else {
                            // Not a gzip header - probably garbage or wrong format
                            Err(Error::InvalidGzipMagic(((b2 as u16) << 8) | (b1 as u16)))
                        }
                    }
                    Err(Error::UnexpectedEof) => Ok(false), // EOF after first byte
                    Err(e) => Err(e),
                }
            }
            Err(Error::UnexpectedEof) => Ok(false), // Clean EOF
            Err(e) => Err(e),
        }
    }
}

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

    #[test]
    fn test_parse_stored_block() {
        // Stored block: BFINAL=1, BTYPE=00, LEN=5, NLEN=!5, "Hello"
        let data = vec![
            0b00000001, // BFINAL=1, BTYPE=00 (stored) - packed LSB first
            0x05, 0x00, // LEN = 5
            0xFA, 0xFF, // NLEN = !5 = 0xFFFA
            b'H', b'e', b'l', b'l', b'o',
        ];

        let mut parser = DeflateParser::new(Cursor::new(data));
        let block = parser.parse_block().unwrap().unwrap();

        assert!(block.is_final);
        assert_eq!(block.block_type, 0);
        assert_eq!(block.tokens.len(), 6); // 5 literals + EndOfBlock

        // Verify content
        assert_eq!(block.tokens[0], LZ77Token::Literal(b'H'));
        assert_eq!(block.tokens[1], LZ77Token::Literal(b'e'));
        assert_eq!(block.tokens[2], LZ77Token::Literal(b'l'));
        assert_eq!(block.tokens[3], LZ77Token::Literal(b'l'));
        assert_eq!(block.tokens[4], LZ77Token::Literal(b'o'));
        assert_eq!(block.tokens[5], LZ77Token::EndOfBlock);
    }

    #[test]
    fn test_parse_real_gzip() {
        // Use flate2 to create a test deflate stream
        use std::io::Write;
        let mut encoder =
            flate2::write::DeflateEncoder::new(Vec::new(), flate2::Compression::default());
        encoder.write_all(b"Hello, World!").unwrap();
        let compressed = encoder.finish().unwrap();

        let mut parser = DeflateParser::new(Cursor::new(compressed));
        let mut total_size = 0;

        while let Some(block) = parser.parse_block().unwrap() {
            total_size += block.uncompressed_size();
            if block.is_final {
                break;
            }
        }

        assert_eq!(total_size, 13);
    }

    #[test]
    fn test_parse_dynamic_header_only() {
        use std::io::Write;
        let mut encoder =
            flate2::write::DeflateEncoder::new(Vec::new(), flate2::Compression::default());
        // Use a longer, varied input that reliably produces a dynamic Huffman block
        let input: Vec<u8> = (0u8..=127).cycle().take(512).collect();
        encoder.write_all(&input).unwrap();
        let compressed = encoder.finish().unwrap();

        let mut bits = SliceBitReader::new(&compressed);
        let _bfinal = bits.read_bit().unwrap();
        let btype = bits.read_bits(2).unwrap();
        assert_eq!(btype, 2); // dynamic

        let (lit_decoder, dist_decoder) = parse_dynamic_huffman_tables(&mut bits).unwrap();
        assert!(!lit_decoder.is_empty());
        let _ = dist_decoder;
    }
}