Move XPRESS_TABLEBITS to xpress-decompress.c
[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  * The XPRESS compression format is an LZ77 and Huffman-code based algorithm.
30  * That means it is fairly similar to LZX compression, but XPRESS is simpler, so
31  * it is a little faster to compress and decompress.
32  *
33  * The XPRESS compression format is mostly documented in a file called "[MS-XCA]
34  * Xpress Compression Algorithm".  In the MSDN library, it can currently be
35  * found under Open Specifications => Protocols => Windows Protocols => Windows
36  * Server Protocols => [MS-XCA] Xpress Compression Algorithm".  The format in
37  * WIMs is specifically the algorithm labeled as the "LZ77+Huffman Algorithm"
38  * (there apparently are some other versions of XPRESS as well).
39  *
40  * If you are already familiar with the LZ77 algorithm and Huffman coding, the
41  * XPRESS format is fairly simple.  The compressed data begins with 256 bytes
42  * that contain 512 4-bit integers that are the lengths of the symbols in the
43  * Huffman code used for match/literal headers.  In contrast with more
44  * complicated formats such as DEFLATE and LZX, this is the only Huffman code
45  * that is used for the entirety of the XPRESS 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 represent the corresponding literal bytes.  Values 256 through 511
50  * represent matches and may require extra bits or bytes to be read to get the
51  * match offset and match length.
52  *
53  * The trickiest part is probably the way in which literal bytes for match
54  * lengths are interleaved in the bitstream.
55  *
56  * Also, a caveat--- according to Microsoft's documentation for XPRESS,
57  *
58  *      "Some implementation of the decompression algorithm expect an extra
59  *      symbol to mark the end of the data.  Specifically, some implementations
60  *      fail during decompression if the Huffman symbol 256 is not found after
61  *      the actual data."
62  *
63  * This is the case for the implementation in WIMGAPI.  However, wimlib's
64  * decompressor in this file currently does not care if this extra symbol is
65  * there or not.
66  */
67
68 #ifdef HAVE_CONFIG_H
69 #  include "config.h"
70 #endif
71
72 #include "wimlib/decompressor_ops.h"
73 #include "wimlib/decompress_common.h"
74 #include "wimlib/error.h"
75 #include "wimlib/xpress.h"
76
77 /* This value is chosen for fast decompression.  */
78 #define XPRESS_TABLEBITS 12
79
80 /*
81  * Decodes a symbol @sym that begins an XPRESS match.
82  *
83  * The low 8 bits of the symbol are divided into:
84  *
85  * bits 0-3:  length header
86  * bits 4-7:  index of high-order bit of match offset
87  *
88  * Returns the match length, or -1 if the data is invalid.
89  */
90 static int
91 xpress_decode_match(unsigned sym, u32 window_pos,
92                     u32 window_len, u8 window[restrict],
93                     struct input_bitstream * restrict istream)
94 {
95         unsigned len_hdr;
96         unsigned offset_bsr;
97         unsigned match_len;
98         unsigned match_offset;
99
100         sym -= XPRESS_NUM_CHARS;
101         len_hdr = sym & 0xf;
102         offset_bsr = sym >> 4;
103
104         bitstream_ensure_bits(istream, 16);
105
106         match_offset = (1U << offset_bsr) | bitstream_pop_bits(istream, offset_bsr);
107
108         if (len_hdr == 0xf) {
109                 match_len = bitstream_read_byte(istream);
110                 if (unlikely(match_len == 0xff)) {
111                         match_len = bitstream_read_byte(istream);
112                         match_len |= (unsigned)bitstream_read_byte(istream) << 8;
113                 } else {
114                         match_len += 0xf;
115                 }
116         } else {
117                 match_len = len_hdr;
118         }
119         match_len += XPRESS_MIN_MATCH_LEN;
120
121         if (unlikely(match_len > window_len - window_pos))
122                 return -1;
123
124         if (unlikely(match_offset > window_pos))
125                 return -1;
126
127         lz_copy(&window[window_pos], match_len, match_offset,
128                 &window[window_len]);
129
130         return match_len;
131 }
132
133 /* Decodes the Huffman-encoded matches and literal bytes in a region of
134  * XPRESS-encoded data.  */
135 static int
136 xpress_lz_decode(struct input_bitstream * restrict istream,
137                  u8 uncompressed_data[restrict],
138                  unsigned uncompressed_len,
139                  const u16 decode_table[restrict])
140 {
141         u32 curpos;
142         unsigned match_len;
143
144         for (curpos = 0; curpos < uncompressed_len; curpos += match_len) {
145                 unsigned sym;
146                 int ret;
147
148                 sym = read_huffsym(istream, decode_table,
149                                    XPRESS_TABLEBITS, XPRESS_MAX_CODEWORD_LEN);
150                 if (sym < XPRESS_NUM_CHARS) {
151                         /* Literal  */
152                         uncompressed_data[curpos] = sym;
153                         match_len = 1;
154                 } else {
155                         /* Match  */
156                         ret = xpress_decode_match(sym,
157                                                   curpos,
158                                                   uncompressed_len,
159                                                   uncompressed_data,
160                                                   istream);
161                         if (unlikely(ret < 0))
162                                 return -1;
163                         match_len = ret;
164                 }
165         }
166         return 0;
167 }
168
169
170 static int
171 xpress_decompress(const void *compressed_data, size_t compressed_size,
172                   void *uncompressed_data, size_t uncompressed_size, void *_ctx)
173 {
174         const u8 *cdata = compressed_data;
175         u8 lens[XPRESS_NUM_SYMBOLS];
176         u8 *lens_p;
177         u16 decode_table[(1 << XPRESS_TABLEBITS) + 2 * XPRESS_NUM_SYMBOLS]
178                         _aligned_attribute(DECODE_TABLE_ALIGNMENT);
179         struct input_bitstream istream;
180
181         /* XPRESS uses only one Huffman code.  It contains 512 symbols, and the
182          * code lengths of these symbols are given literally as 4-bit integers
183          * in the first 256 bytes of the compressed data.  */
184         if (compressed_size < XPRESS_NUM_SYMBOLS / 2)
185                 return -1;
186
187         lens_p = lens;
188         for (unsigned i = 0; i < XPRESS_NUM_SYMBOLS / 2; i++) {
189                 *lens_p++ = cdata[i] & 0xf;
190                 *lens_p++ = cdata[i] >> 4;
191         }
192
193         if (make_huffman_decode_table(decode_table, XPRESS_NUM_SYMBOLS,
194                                       XPRESS_TABLEBITS, lens,
195                                       XPRESS_MAX_CODEWORD_LEN))
196                 return -1;
197
198         init_input_bitstream(&istream, cdata + XPRESS_NUM_SYMBOLS / 2,
199                              compressed_size - XPRESS_NUM_SYMBOLS / 2);
200
201         return xpress_lz_decode(&istream, uncompressed_data,
202                                 uncompressed_size, decode_table);
203 }
204
205 static int
206 xpress_create_decompressor(size_t max_block_size, void **dec_ret)
207 {
208         if (max_block_size > XPRESS_MAX_OFFSET + 1)
209                 return WIMLIB_ERR_INVALID_PARAM;
210
211         return 0;
212 }
213
214 const struct decompressor_ops xpress_decompressor_ops = {
215         .create_decompressor = xpress_create_decompressor,
216         .decompress          = xpress_decompress,
217 };