Fix sequential extraction, and include progress info
[wimlib] / src / xpress-decomp.c
1 /*
2  * xpress-decomp.c
3  *
4  * XPRESS decompression routines.
5  */
6
7 /*
8  *
9  * Copyright (C) 2012 Eric Biggers
10  *
11  * This file is part of wimlib, a library for working with WIM files.
12  *
13  * wimlib is free software; you can redistribute it and/or modify it under the
14  * terms of the GNU General Public License as published by the Free
15  * Software Foundation; either version 3 of the License, or (at your option)
16  * any later version.
17  *
18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
20  * A PARTICULAR PURPOSE. See the GNU General Public License for more
21  * details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
25  */
26
27
28
29 /*
30  * The XPRESS compression format is a LZ77-based algorithm.  That means it is
31  * quite similar to LZX compression, but XPRESS is slightly simpler, so it is a
32  * little faster to compress and decompress.
33  *
34  * The XPRESS compression format is mostly documented in a file called "[MS-XCA]
35  * Xpress Compression Algorithm".  In the MSDN library, it can currently be
36  * found under Open Specifications => Protocols => Windows Protocols => Windows
37  * Server Protocols => [MS-XCA] Xpress Compression Algorithm".  Note that
38  * Microsoft apparently also has either a slightly different format or an
39  * entirely different format that is also called XPRESS.  The other one is
40  * supposedly used in Windows' hibernation file or something, but the one used
41  * in WIM files is the one described in the above document.
42  *
43  * If you are already familiar with the LZ77 algorithm and Huffman coding, the
44  * XPRESS format is pretty simple.  The compressed data begins with 256 bytes
45  * that contain 512 4-bit integers that are the lengths of the symbols in the
46  * Huffman tree used for decoding compressed literals.  This is the only Huffman
47  * tree that is used for the entirety of the compressed data, and the codeword
48  * lengths are not encoded with a pretree.
49  *
50  * The rest of the compressed data is Huffman-encoded symbols.  Values 0 through
51  * 255 are literal bytes.  Values 256 through 511 are matches and may require
52  * extra bits or bytes to be read to get the match offset and match length.
53  *
54  * There is no notion of a "compressed block" in the XPRESS format, so in the
55  * XPRESS format, each WIM chunk (32768 bytes) will always use only one Huffman
56  * tree.
57  *
58  * The trickiest part is probably the fact that literal bytes for match lengths
59  * are encoded "separately" from the bitstream.
60  *
61  * Also, a caveat--- according to M$'s documentation for XPRESS,
62  *
63  *      "Some implementation of the decompression algorithm expect an extra
64  *      symbol to mark the end of the data.  Specifically, some implementations
65  *      fail during decompression if the Huffman symbol 256 is not found after
66  *      the actual data."
67  *
68  * This is the case for WIM files--- in we must write this extra symbol "256" at
69  * the end.  Otherwise Microsoft's software will fail to decompress the
70  * XPRESS-compressed data.
71  *
72  * Howeve, wimlib's decompressor in xpress-decomp.c currently does not care if
73  * this extra symbol is there or not.
74  */
75
76 #include "util.h"
77 #include "xpress.h"
78 #include "wimlib.h"
79
80 #define XPRESS_DECOMP
81 #include "decomp.h"
82
83
84 /* Decodes @huffsym, a value >= XPRESS_NUM_CHARS, that is the header of a match.
85  * */
86 static int xpress_decode_match(int huffsym, uint window_pos, uint window_len,
87                                 u8 window[], struct input_bitstream *istream)
88 {
89         uint match_len;
90         uint match_offset;
91         u8 match_sym = (u8)huffsym;
92         u8 len_hdr = match_sym & 0xf;
93         u8 offset_bsr = match_sym >> 4;
94         int ret;
95         u8 *match_dest;
96         u8 *match_src;
97         uint i;
98
99         ret = bitstream_read_bits(istream, offset_bsr, &match_offset);
100         if (ret != 0)
101                 return -1;
102         match_offset |= (1 << offset_bsr);
103
104         if (len_hdr == 0xf) {
105                 ret = bitstream_read_byte(istream);
106                 if (ret == -1)
107                         return -1;
108                 match_len = ret;
109                 if (match_len == 0xff) {
110
111                         ret = bitstream_read_byte(istream);
112                         if (ret == -1)
113                                 return -1;
114                         match_len = ret;
115
116                         ret = bitstream_read_byte(istream);
117                         if (ret == -1)
118                                 return -1;
119
120                         match_len |= (ret << 8);
121                         if (match_len < 0xf)
122                                 return -1;
123                 } else {
124                         match_len += 0xf;
125                 }
126         } else {
127                 match_len = len_hdr;
128         }
129         match_len += XPRESS_MIN_MATCH;
130
131
132         /* Verify that the match is in the bounds of the part of the window
133          * currently in use, then copy the source of the match to the current
134          * position. */
135
136         match_dest = window + window_pos;
137         match_src = match_dest - match_offset;
138
139         if (window_pos + match_len > window_len) {
140                 ERROR("XPRESS dedecompression error: match of length %d "
141                       "bytes overflows window", match_len);
142                 return -1;
143         }
144
145         if (match_src < window) {
146                 ERROR("XPRESS decompression error: match of length %d bytes "
147                       "references data before window (match_offset = %d, "
148                       "window_pos = %d)", match_len, match_offset, window_pos);
149                 return -1;
150         }
151
152         for (i = 0; i < match_len; i++)
153                 match_dest[i] = match_src[i];
154
155         return match_len;
156 }
157
158 /* Decodes the Huffman-encoded matches and literal bytes in a block of
159  * XPRESS-encoded data. */
160 static int xpress_decompress_literals(struct input_bitstream *istream,
161                                       u8 uncompressed_data[],
162                                       uint uncompressed_len,
163                                       const u8 lens[],
164                                       const u16 decode_table[])
165 {
166         uint curpos = 0;
167         uint huffsym;
168         int match_len;
169         int ret = 0;
170
171         while (curpos < uncompressed_len) {
172                 ret = read_huffsym(istream, decode_table, lens,
173                                    XPRESS_NUM_SYMBOLS, XPRESS_TABLEBITS,
174                                    &huffsym, XPRESS_MAX_CODEWORD_LEN);
175                 if (ret != 0)
176                         break;
177
178                 if (huffsym < XPRESS_NUM_CHARS) {
179                         uncompressed_data[curpos++] = huffsym;
180                 } else {
181                         match_len = xpress_decode_match(huffsym,
182                                                         curpos,
183                                                         uncompressed_len,
184                                                         uncompressed_data,
185                                                         istream);
186                         if (match_len == -1) {
187                                 ret = 1;
188                                 break;
189                         }
190                         curpos += match_len;
191                 }
192         }
193         return ret;
194 }
195
196
197 int xpress_decompress(const void *__compressed_data, uint compressed_len,
198                       void *uncompressed_data, uint uncompressed_len)
199 {
200         u8 lens[XPRESS_NUM_SYMBOLS];
201         u16 decode_table[(1 << XPRESS_TABLEBITS) + 2 * XPRESS_NUM_SYMBOLS];
202         struct input_bitstream istream;
203         u8 *lens_p;
204         const u8 *compressed_data;
205         uint i;
206         int ret;
207
208         compressed_data = __compressed_data;
209         lens_p = lens;
210
211         DEBUG2("compressed_len = %d, uncompressed_len = %d",
212                compressed_len, uncompressed_len);
213
214         /* XPRESS uses only one Huffman tree.  It contains 512 symbols, and the
215          * code lengths of these symbols are given literally as 4-bit integers
216          * in the first 256 bytes of the compressed data.
217          */
218         if (compressed_len < XPRESS_NUM_SYMBOLS / 2)
219                 return WIMLIB_ERR_DECOMPRESSION;
220
221         for (i = 0; i < XPRESS_NUM_SYMBOLS / 2; i++) {
222                 *lens_p++ = compressed_data[i] & 0xf;
223                 *lens_p++ = compressed_data[i] >> 4;
224         }
225
226         ret = make_huffman_decode_table(decode_table, XPRESS_NUM_SYMBOLS,
227                                         XPRESS_TABLEBITS, lens,
228                                         XPRESS_MAX_CODEWORD_LEN);
229         if (ret != 0)
230                 return ret;
231
232         init_input_bitstream(&istream, compressed_data + XPRESS_NUM_SYMBOLS / 2,
233                              compressed_len - XPRESS_NUM_SYMBOLS / 2);
234
235         return xpress_decompress_literals(&istream, uncompressed_data,
236                                           uncompressed_len, lens,
237                                           decode_table);
238 }