oozextract 0.2.0

Open source Kraken / Mermaid / Selkie / Leviathan / LZNA / Bitknit decompressor
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

use crate::core::Core;
use crate::error::{ErrorContext, Res, WithContext};
use crate::pointer::Pointer;

pub struct BitReader {
    /// |p| holds the current u8 and |p_end| the end of the buffer.
    pub p: Pointer,
    pub p_end: Pointer,
    /// Bits accumulated so far
    pub bits: u32,
    /// Next u8 will end up in the |bitpos| position in |bits|.
    pub bitpos: i32,
}

impl ErrorContext for BitReader {}

pub struct BitReader2 {
    pub p: Pointer,
    pub p_end: Pointer,
    pub bitpos: u32,
}

impl BitReader {
    /// Read more bytes to make sure we always have at least 24 bits in |bits|.
    pub fn refill(&mut self, source: &Core) -> Res<()> {
        assert!(self.bitpos <= 24);
        while self.bitpos > 0 {
            if self.p < self.p_end {
                self.bits |= (source.get_byte(self.p)? as u32) << self.bitpos;
            }
            self.bitpos -= 8;
            self.p += 1;
        }
        Ok(())
    }

    /// Read more bytes to make sure we always have at least 24 bits in |bits|,
    /// used when reading backwards.
    pub fn refill_backwards(&mut self, source: &Core) -> Res<()> {
        assert!(self.bitpos <= 24);
        while self.bitpos > 0 {
            self.p -= 1;
            if self.p >= self.p_end {
                self.bits |= (source.get_byte(self.p)? as u32) << self.bitpos;
            }
            self.bitpos -= 8;
        }
        Ok(())
    }

    /// Refill bits then read a single bit.
    pub fn read_bit(&mut self, source: &Core) -> Res<bool> {
        self.refill(source).at(self)?;
        let r = self.bits >> 31;
        self.bits <<= 1;
        self.bitpos += 1;
        Ok(r != 0)
    }

    pub fn read_bit_no_refill(&mut self) -> bool {
        let r = self.bits >> 31;
        self.bits <<= 1;
        self.bitpos += 1;
        r != 0
    }

    /// Read |n| bits without refilling.
    pub fn read_bits_no_refill(&mut self, n: i32) -> i32 {
        let r = self.bits >> (32 - n);
        self.bits <<= n;
        self.bitpos += n;
        r as _
    }

    /// Read |n| bits without refilling, n may be zero.
    pub fn read_bits_no_refill_zero(&mut self, n: i32) -> i32 {
        let r = self.bits >> 1 >> (31 - n);
        self.bits <<= n;
        self.bitpos += n;
        r as _
    }

    pub fn read_more_than24bits(&mut self, source: &Core, n: i32) -> Res<i32> {
        let mut rv;
        if n <= 24 {
            rv = self.read_bits_no_refill_zero(n);
        } else {
            // no test coverage
            rv = self.read_bits_no_refill(24) << (n - 24);
            self.refill(source).at(self)?;
            rv += self.read_bits_no_refill(n - 24);
        }
        self.refill(source).at(self)?;
        Ok(rv)
    }

    pub fn read_more_than_24_bits_b(&mut self, source: &Core, n: i32) -> Res<i32> {
        let mut rv;
        if n <= 24 {
            rv = self.read_bits_no_refill_zero(n);
        } else {
            // no test coverage
            rv = self.read_bits_no_refill(24) << (n - 24);
            self.refill_backwards(source).at(self)?;
            rv += self.read_bits_no_refill(n - 24);
        }
        self.refill_backwards(source).at(self)?;
        Ok(rv)
    }

    /// Reads an offset code parametrized by |v|.
    pub fn read_distance(&mut self, source: &Core, v: i32) -> Res<i32> {
        let w;
        let m;
        let n;
        let mut rv;
        if v < 0xF0 {
            n = (v >> 4) + 4;
            w = (self.bits | 1).rotate_left(n as u32);
            self.bitpos += n;
            m = (2 << n) - 1;
            self.bits = w & !m;
            rv = ((w & m) << 4) + (v & 0xF) as u32 - 248;
        } else {
            n = v - 0xF0 + 4;
            w = (self.bits | 1).rotate_left(n as u32);
            self.bitpos += n;
            m = (2 << n) - 1;
            self.bits = w & !m;
            rv = 8322816 + ((w & m) << 12);
            self.refill(source).at(self)?;
            rv += self.bits >> 20;
            self.bitpos += 12;
            self.bits <<= 12;
        }
        self.refill(source).at(self)?;
        Ok(rv as _)
    }

    /// Reads an offset code parametrized by |v|, backwards.
    pub fn read_distance_b(&mut self, source: &Core, v: i32) -> Res<i32> {
        let w;
        let m;
        let n;
        let mut rv;

        if v < 0xF0 {
            n = (v >> 4) + 4;
            w = (self.bits | 1).rotate_left(n as u32);
            self.bitpos += n;
            m = (2 << n) - 1;
            self.bits = w & !m;
            rv = ((w & m) << 4) + (v & 0xF) as u32 - 248;
        } else {
            n = v - 0xF0 + 4;
            w = (self.bits | 1).rotate_left(n as u32);
            self.bitpos += n;
            m = (2 << n) - 1;
            self.bits = w & !m;
            rv = 8322816 + ((w & m) << 12);
            self.refill_backwards(source).at(self)?;
            rv += self.bits >> (32 - 12);
            self.bitpos += 12;
            self.bits <<= 12;
        }
        self.refill_backwards(source).at(self)?;
        Ok(rv as _)
    }

    /// Reads a length code.
    pub fn read_length(&mut self, source: &Core) -> Res<i32> {
        let mut n;
        n = self.leading_zeros();
        assert!(n <= 12);
        self.bitpos += n;
        self.bits <<= n;
        self.refill(source).at(self)?;
        n += 7;
        self.bitpos += n;
        let rv = (self.bits >> (32 - n)) - 64;
        self.bits <<= n;
        self.refill(source).at(self)?;
        Ok(rv as _)
    }

    /// Reads a length code, backwards.
    pub fn read_length_b(&mut self, source: &Core) -> Res<i32> {
        let mut n = self.leading_zeros();
        assert!(n <= 12);
        self.bitpos += n;
        self.bits <<= n;
        self.refill_backwards(source).at(self)?;
        n += 7;
        self.bitpos += n;
        let rv = (self.bits >> (32 - n)) - 64;
        self.bits <<= n;
        self.refill_backwards(source).at(self)?;
        Ok(rv as _)
    }

    pub fn read_fluff(&mut self, num_symbols: i32) -> usize {
        if num_symbols == 256 {
            return 0;
        }

        let mut x = 257 - num_symbols;
        if x > num_symbols {
            x = num_symbols;
        }

        x *= 2;

        let y = (x - 1i32).ilog2() + 1;

        let v = self.bits >> (32 - y);
        let z = (1 << y) - x as u32;

        if (v >> 1) >= z {
            self.bits <<= y;
            self.bitpos += y as i32;
            (v - z) as _
        } else {
            self.bits <<= y - 1;
            self.bitpos += (y - 1) as i32;
            (v >> 1) as _
        }
    }

    pub fn leading_zeros(&self) -> i32 {
        self.bits.leading_zeros() as _
    }
}