4 * A decompressor for the XPRESS compression format (Huffman variant).
9 * Copyright (C) 2012, 2013 Eric Biggers
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
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
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/.
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.
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).
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.
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.
51 * The trickiest part is probably the way in which literal bytes for match
52 * lengths are interleaved in the bitstream.
54 * Also, a caveat--- according to Microsoft's documentation for XPRESS,
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
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
70 #include "wimlib/decompressor_ops.h"
71 #include "wimlib/decompress_common.h"
72 #include "wimlib/error.h"
73 #include "wimlib/xpress_constants.h"
75 /* This value is chosen for fast decompression. */
76 #define XPRESS_TABLEBITS 12
78 /* Decode the matches and literal bytes in a region of XPRESS-encoded data. */
80 xpress_decode_window(struct input_bitstream *istream, const u16 *decode_table,
81 u8 *window, unsigned window_size)
83 u8 *window_ptr = window;
84 u8 *window_end = &window[window_size];
87 unsigned offset_high_bit;
88 unsigned match_offset;
90 while (window_ptr != window_end) {
92 sym = read_huffsym(istream, decode_table,
93 XPRESS_TABLEBITS, XPRESS_MAX_CODEWORD_LEN);
94 if (sym < XPRESS_NUM_CHARS) {
101 match_len = sym & 0xf;
102 offset_high_bit = (sym >> 4) & 0xf;
104 bitstream_ensure_bits(istream, 16);
106 match_offset = (1 << offset_high_bit) |
107 bitstream_pop_bits(istream, offset_high_bit);
109 if (match_len == 0xf) {
110 match_len += bitstream_read_byte(istream);
111 if (match_len == 0xf + 0xff)
112 match_len = bitstream_read_u16(istream);
114 match_len += XPRESS_MIN_MATCH_LEN;
116 if (unlikely(match_offset > window_ptr - window))
119 if (unlikely(match_len > window_end - window_ptr))
122 lz_copy(window_ptr, match_len, match_offset, window_end,
123 XPRESS_MIN_MATCH_LEN);
125 window_ptr += match_len;
131 xpress_decompress(const void *compressed_data, size_t compressed_size,
132 void *uncompressed_data, size_t uncompressed_size, void *_ctx)
134 const u8 *cdata = compressed_data;
137 u16 decode_table[(1 << XPRESS_TABLEBITS) + 2 * XPRESS_NUM_SYMBOLS]
138 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
139 u8 lens[XPRESS_NUM_SYMBOLS];
141 struct input_bitstream istream;
143 /* XPRESS uses only one Huffman code. It contains 512 symbols, and the
144 * code lengths of these symbols are given literally as 4-bit integers
145 * in the first 256 bytes of the compressed data. */
146 if (compressed_size < XPRESS_NUM_SYMBOLS / 2)
150 for (unsigned i = 0; i < XPRESS_NUM_SYMBOLS / 2; i++) {
151 *lens_p++ = cdata[i] & 0xf;
152 *lens_p++ = cdata[i] >> 4;
155 if (make_huffman_decode_table(u.decode_table, XPRESS_NUM_SYMBOLS,
156 XPRESS_TABLEBITS, u.lens,
157 XPRESS_MAX_CODEWORD_LEN))
160 init_input_bitstream(&istream, cdata + XPRESS_NUM_SYMBOLS / 2,
161 compressed_size - XPRESS_NUM_SYMBOLS / 2);
163 return xpress_decode_window(&istream, u.decode_table,
164 uncompressed_data, uncompressed_size);
168 xpress_create_decompressor(size_t max_block_size, void **dec_ret)
170 if (max_block_size > XPRESS_MAX_OFFSET + 1)
171 return WIMLIB_ERR_INVALID_PARAM;
176 const struct decompressor_ops xpress_decompressor_ops = {
177 .create_decompressor = xpress_create_decompressor,
178 .decompress = xpress_decompress,