Fixes; comments
[wimlib] / src / xpress-decompress.c
1 /*
2  * xpress-decompress.c
3  *
4  * XPRESS decompression routines.
5  */
6
7 /*
8  *
9  * Copyright (C) 2012, 2013 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 and Huffman-code based algorithm.
31  * That means it is quite similar to LZX compression, but XPRESS is slightly
32  * simpler, so it is a 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".  The format in
38  * WIMs is specifically the algorithm labeled as the "LZ77+Huffman Algorithm"
39  * (there apparently are some other versions of XPRESS as well).
40  *
41  * If you are already familiar with the LZ77 algorithm and Huffman coding, the
42  * XPRESS format is fairly simple.  The compressed data begins with 256 bytes
43  * that contain 512 4-bit integers that are the lengths of the symbols in the
44  * Huffman tree used for decoding compressed literals.  This is the only Huffman
45  * tree that is used for the entirety of the compressed data, and the codeword
46  * lengths are not encoded with a pretree.
47  *
48  * The rest of the compressed data is Huffman-encoded symbols.  Values 0 through
49  * 255 are literal bytes.  Values 256 through 511 are matches and may require
50  * extra bits or bytes to be read to get the match offset and match length.
51  *
52  * There is no notion of a "compressed block" in the XPRESS format, so in the
53  * XPRESS format, each WIM chunk (32768 bytes) will always use only one Huffman
54  * tree.
55  *
56  * The trickiest part is probably the fact that literal bytes for match lengths
57  * are encoded "separately" from the bitstream.
58  *
59  * Also, a caveat--- according to Microsoft's documentation for XPRESS,
60  *
61  *      "Some implementation of the decompression algorithm expect an extra
62  *      symbol to mark the end of the data.  Specifically, some implementations
63  *      fail during decompression if the Huffman symbol 256 is not found after
64  *      the actual data."
65  *
66  * This is the case for WIM files--- in we must write this extra symbol "256" at
67  * the end.  Otherwise Microsoft's software will fail to decompress the
68  * XPRESS-compressed data.
69  *
70  * However, wimlib's decompressor in this file currently does not care if this
71  * extra symbol is there or not.
72  */
73
74 #include "util.h"
75 #include "xpress.h"
76 #include "wimlib.h"
77
78 #define XPRESS_DECOMP
79 #include "decompress.h"
80
81 /*
82  * Decodes a symbol @huffsym that begins an XPRESS match.
83  *
84  * The low 8 bits of the symbol are divided into:
85  *
86  * bits 0-3:  length header
87  * bits 4-7:  index of high-order bit of match offset
88  *
89  * Note: taking the low 8 bits of the symbol is the same as subtracting 256, the
90  * number of symbols reserved for literals.
91  *
92  * Returns the match length, or -1 on error.
93  */
94 static int
95 xpress_decode_match(unsigned huffsym, unsigned window_pos,
96                     unsigned window_len, u8 window[],
97                     struct input_bitstream *istream)
98 {
99         unsigned match_len;
100         unsigned match_offset;
101         u8 match_sym = (u8)huffsym;
102         u8 len_hdr = match_sym & 0xf;
103         u8 offset_bsr = match_sym >> 4;
104         int ret;
105         u8 *match_dest;
106         u8 *match_src;
107         unsigned i;
108
109         ret = bitstream_read_bits(istream, offset_bsr, &match_offset);
110         if (ret != 0)
111                 return ret;
112         match_offset |= (1 << offset_bsr);
113
114         if (len_hdr == 0xf) {
115                 ret = bitstream_read_byte(istream);
116                 if (ret < 0)
117                         return ret;
118                 match_len = ret;
119                 if (match_len == 0xff) {
120                         ret = bitstream_read_byte(istream);
121                         if (ret < 0)
122                                 return ret;
123                         match_len = ret;
124
125                         ret = bitstream_read_byte(istream);
126                         if (ret < 0)
127                                 return ret;
128
129                         match_len |= (ret << 8);
130                 } else {
131                         match_len += 0xf;
132                 }
133         } else {
134                 match_len = len_hdr;
135         }
136         match_len += XPRESS_MIN_MATCH;
137
138         /* Verify that the match is in the bounds of the part of the window
139          * currently in use, then copy the source of the match to the current
140          * position. */
141
142         match_dest = window + window_pos;
143         match_src = match_dest - match_offset;
144
145         if (window_pos + match_len > window_len) {
146                 ERROR("XPRESS decompression error: match of length %u "
147                       "bytes overflows window", match_len);
148                 return -1;
149         }
150
151         if (match_src < window) {
152                 ERROR("XPRESS decompression error: match of length %u bytes "
153                       "references data before window (match_offset = %u, "
154                       "window_pos = %u)", match_len, match_offset, window_pos);
155                 return -1;
156         }
157
158         for (i = 0; i < match_len; i++)
159                 match_dest[i] = match_src[i];
160
161         return match_len;
162 }
163
164 /* Decodes the Huffman-encoded matches and literal bytes in a block of
165  * XPRESS-encoded data. */
166 static int
167 xpress_decompress_block(struct input_bitstream *istream,
168                         u8 uncompressed_data[],
169                         unsigned uncompressed_len,
170                         const u8 lens[],
171                         const u16 decode_table[])
172 {
173         unsigned curpos;
174         unsigned huffsym;
175         int ret;
176         int match_len;
177
178         curpos = 0;
179         while (curpos < uncompressed_len) {
180                 ret = read_huffsym(istream, decode_table, lens,
181                                    XPRESS_NUM_SYMBOLS, XPRESS_TABLEBITS,
182                                    &huffsym, XPRESS_MAX_CODEWORD_LEN);
183                 if (ret)
184                         return ret;
185
186                 if (huffsym < XPRESS_NUM_CHARS) {
187                         uncompressed_data[curpos++] = huffsym;
188                 } else {
189                         match_len = xpress_decode_match(huffsym,
190                                                         curpos,
191                                                         uncompressed_len,
192                                                         uncompressed_data,
193                                                         istream);
194                         if (match_len < 0)
195                                 return match_len;
196                         curpos += match_len;
197                 }
198         }
199         return 0;
200 }
201
202
203 /* Documented in wimlib.h */
204 WIMLIBAPI int
205 wimlib_xpress_decompress(const void *__compressed_data, unsigned compressed_len,
206                          void *uncompressed_data, unsigned uncompressed_len)
207 {
208         u8 lens[XPRESS_NUM_SYMBOLS];
209         u16 decode_table[(1 << XPRESS_TABLEBITS) + 2 * XPRESS_NUM_SYMBOLS];
210         struct input_bitstream istream;
211         u8 *lens_p;
212         const u8 *compressed_data;
213         unsigned i;
214         int ret;
215
216         compressed_data = __compressed_data;
217         lens_p = lens;
218
219         DEBUG2("compressed_len = %d, uncompressed_len = %d",
220                compressed_len, uncompressed_len);
221
222         /* XPRESS uses only one Huffman tree.  It contains 512 symbols, and the
223          * code lengths of these symbols are given literally as 4-bit integers
224          * in the first 256 bytes of the compressed data.
225          */
226         if (compressed_len < XPRESS_NUM_SYMBOLS / 2) {
227                 ERROR("xpress_decompress(): Compressed length too short!");
228                 return -1;
229         }
230
231         for (i = 0; i < XPRESS_NUM_SYMBOLS / 2; i++) {
232                 *lens_p++ = compressed_data[i] & 0xf;
233                 *lens_p++ = compressed_data[i] >> 4;
234         }
235
236         ret = make_huffman_decode_table(decode_table, XPRESS_NUM_SYMBOLS,
237                                         XPRESS_TABLEBITS, lens,
238                                         XPRESS_MAX_CODEWORD_LEN);
239         if (ret)
240                 return ret;
241
242         init_input_bitstream(&istream, compressed_data + XPRESS_NUM_SYMBOLS / 2,
243                              compressed_len - XPRESS_NUM_SYMBOLS / 2);
244
245         return xpress_decompress_block(&istream, uncompressed_data,
246                                        uncompressed_len, lens,
247                                        decode_table);
248 }