xpress_decompress.c: consolidate XPRESS decompressor into one function
[wimlib] / src / xpress_decompress.c
1 /*
2  * xpress_decompress.c
3  *
4  * A decompressor for the XPRESS compression format (Huffman variant).
5  */
6
7 /*
8  *
9  * Copyright (C) 2012, 2013, 2015 Eric Biggers
10  *
11  * This file is free software; you can redistribute it and/or modify it under
12  * the terms of the GNU Lesser General Public License as published by the Free
13  * Software Foundation; either version 3 of the License, or (at your option) any
14  * later version.
15  *
16  * This file is distributed in the hope that it will be useful, but WITHOUT
17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
19  * details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this file; if not, see http://www.gnu.org/licenses/.
23  */
24
25
26 /*
27  * The XPRESS compression format is an LZ77 and Huffman-code based algorithm.
28  * That means it is fairly similar to LZX compression, but XPRESS is simpler, so
29  * it is a little faster to compress and decompress.
30  *
31  * The XPRESS compression format is mostly documented in a file called "[MS-XCA]
32  * Xpress Compression Algorithm".  In the MSDN library, it can currently be
33  * found under Open Specifications => Protocols => Windows Protocols => Windows
34  * Server Protocols => [MS-XCA] Xpress Compression Algorithm".  The format in
35  * WIMs is specifically the algorithm labeled as the "LZ77+Huffman Algorithm"
36  * (there apparently are some other versions of XPRESS as well).
37  *
38  * If you are already familiar with the LZ77 algorithm and Huffman coding, the
39  * XPRESS format is fairly simple.  The compressed data begins with 256 bytes
40  * that contain 512 4-bit integers that are the lengths of the symbols in the
41  * Huffman code used for match/literal headers.  In contrast with more
42  * complicated formats such as DEFLATE and LZX, this is the only Huffman code
43  * that is used for the entirety of the XPRESS compressed data, and the codeword
44  * lengths are not encoded with a pretree.
45  *
46  * The rest of the compressed data is Huffman-encoded symbols.  Values 0 through
47  * 255 represent the corresponding literal bytes.  Values 256 through 511
48  * represent matches and may require extra bits or bytes to be read to get the
49  * match offset and match length.
50  *
51  * The trickiest part is probably the way in which literal bytes for match
52  * lengths are interleaved in the bitstream.
53  *
54  * Also, a caveat--- according to Microsoft's documentation for XPRESS,
55  *
56  *      "Some implementation of the decompression algorithm expect an extra
57  *      symbol to mark the end of the data.  Specifically, some implementations
58  *      fail during decompression if the Huffman symbol 256 is not found after
59  *      the actual data."
60  *
61  * This is the case for the implementation in WIMGAPI.  However, wimlib's
62  * decompressor in this file currently does not care if this extra symbol is
63  * there or not.
64  */
65
66 #ifdef HAVE_CONFIG_H
67 #  include "config.h"
68 #endif
69
70 #include "wimlib/decompressor_ops.h"
71 #include "wimlib/decompress_common.h"
72 #include "wimlib/error.h"
73 #include "wimlib/xpress_constants.h"
74
75 /* This value is chosen for fast decompression.  */
76 #define XPRESS_TABLEBITS 12
77
78 static int
79 xpress_decompress(const void *compressed_data, size_t compressed_size,
80                   void *uncompressed_data, size_t uncompressed_size, void *_ctx)
81 {
82         const u8 * const in_begin = compressed_data;
83         u8 * const out_begin = uncompressed_data;
84         u8 *out_next = out_begin;
85         u8 * const out_end = out_begin + uncompressed_size;
86         union {
87                 u16 decode_table[(1 << XPRESS_TABLEBITS) + 2 * XPRESS_NUM_SYMBOLS]
88                                 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
89                 u8 lens[XPRESS_NUM_SYMBOLS];
90         } u;
91         struct input_bitstream is;
92
93         /* Read the Huffman codeword lengths.  */
94         if (compressed_size < XPRESS_NUM_SYMBOLS / 2)
95                 return -1;
96         for (int i = 0; i < XPRESS_NUM_SYMBOLS / 2; i++) {
97                 u.lens[2 * i + 0] = in_begin[i] & 0xf;
98                 u.lens[2 * i + 1] = in_begin[i] >> 4;
99         }
100
101         /* Build a decoding table for the Huffman code.  */
102         if (make_huffman_decode_table(u.decode_table, XPRESS_NUM_SYMBOLS,
103                                       XPRESS_TABLEBITS, u.lens,
104                                       XPRESS_MAX_CODEWORD_LEN))
105                 return -1;
106
107         /* Decode the matches and literals.  */
108
109         init_input_bitstream(&is, in_begin + XPRESS_NUM_SYMBOLS / 2,
110                              compressed_size - XPRESS_NUM_SYMBOLS / 2);
111
112         while (out_next != out_end) {
113                 unsigned sym;
114                 unsigned log2_offset;
115                 u32 length;
116                 u32 offset;
117
118                 sym = read_huffsym(&is, u.decode_table,
119                                    XPRESS_TABLEBITS, XPRESS_MAX_CODEWORD_LEN);
120                 if (sym < XPRESS_NUM_CHARS) {
121                         /* Literal  */
122                         *out_next++ = sym;
123                 } else {
124                         /* Match  */
125                         length = sym & 0xf;
126                         log2_offset = (sym >> 4) & 0xf;
127
128                         bitstream_ensure_bits(&is, 16);
129
130                         offset = ((u32)1 << log2_offset) |
131                                  bitstream_pop_bits(&is, log2_offset);
132
133                         if (length == 0xf) {
134                                 length += bitstream_read_byte(&is);
135                                 if (length == 0xf + 0xff)
136                                         length = bitstream_read_u16(&is);
137                         }
138                         length += XPRESS_MIN_MATCH_LEN;
139
140                         if (unlikely(offset > out_next - out_begin))
141                                 return -1;
142
143                         if (unlikely(length > out_end - out_next))
144                                 return -1;
145
146                         lz_copy(out_next, length, offset, out_end,
147                                 XPRESS_MIN_MATCH_LEN);
148
149                         out_next += length;
150                 }
151         }
152         return 0;
153 }
154
155 static int
156 xpress_create_decompressor(size_t max_block_size, void **dec_ret)
157 {
158         if (max_block_size > XPRESS_MAX_OFFSET + 1)
159                 return WIMLIB_ERR_INVALID_PARAM;
160
161         return 0;
162 }
163
164 const struct decompressor_ops xpress_decompressor_ops = {
165         .create_decompressor = xpress_create_decompressor,
166         .decompress          = xpress_decompress,
167 };