wimlib.net Git - wimlib/blob - 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-2016 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/util.h"
  74 #include "wimlib/xpress_constants.h"
  75
  76 /* This value is chosen for fast decompression.  */
  77 #define XPRESS_TABLEBITS 11
  78
  79 struct xpress_decompressor {
  80         union {
  81                 DECODE_TABLE(decode_table, XPRESS_NUM_SYMBOLS,
  82                              XPRESS_TABLEBITS, XPRESS_MAX_CODEWORD_LEN);
  83                 u8 lens[XPRESS_NUM_SYMBOLS];
  84         };
  85 } _aligned_attribute(DECODE_TABLE_ALIGNMENT);
  86
  87 static int
  88 xpress_decompress(const void *restrict compressed_data, size_t compressed_size,
  89                   void *restrict uncompressed_data, size_t uncompressed_size,
  90                   void *restrict _d)
  91 {
  92         struct xpress_decompressor *d  = _d;
  93         const u8 * const in_begin = compressed_data;
  94         u8 * const out_begin = uncompressed_data;
  95         u8 *out_next = out_begin;
  96         u8 * const out_end = out_begin + uncompressed_size;
  97         struct input_bitstream is;
  98
  99         /* Read the Huffman codeword lengths.  */
 100         if (compressed_size < XPRESS_NUM_SYMBOLS / 2)
 101                 return -1;
 102         for (int i = 0; i < XPRESS_NUM_SYMBOLS / 2; i++) {
 103                 d->lens[2 * i + 0] = in_begin[i] & 0xf;
 104                 d->lens[2 * i + 1] = in_begin[i] >> 4;
 105         }
 106
 107         /* Build a decoding table for the Huffman code.  */
 108         if (make_huffman_decode_table(d->decode_table, XPRESS_NUM_SYMBOLS,
 109                                       XPRESS_TABLEBITS, d->lens,
 110                                       XPRESS_MAX_CODEWORD_LEN))
 111                 return -1;
 112
 113         /* Decode the matches and literals.  */
 114
 115         init_input_bitstream(&is, in_begin + XPRESS_NUM_SYMBOLS / 2,
 116                              compressed_size - XPRESS_NUM_SYMBOLS / 2);
 117
 118         while (out_next != out_end) {
 119                 unsigned sym;
 120                 unsigned log2_offset;
 121                 u32 length;
 122                 u32 offset;
 123
 124                 sym = read_huffsym(&is, d->decode_table,
 125                                    XPRESS_TABLEBITS, XPRESS_MAX_CODEWORD_LEN);
 126                 if (sym < XPRESS_NUM_CHARS) {
 127                         /* Literal  */
 128                         *out_next++ = sym;
 129                 } else {
 130                         /* Match  */
 131                         length = sym & 0xf;
 132                         log2_offset = (sym >> 4) & 0xf;
 133
 134                         bitstream_ensure_bits(&is, 16);
 135
 136                         offset = ((u32)1 << log2_offset) |
 137                                  bitstream_pop_bits(&is, log2_offset);
 138
 139                         if (length == 0xf) {
 140                                 length += bitstream_read_byte(&is);
 141                                 if (length == 0xf + 0xff)
 142                                         length = bitstream_read_u16(&is);
 143                         }
 144                         length += XPRESS_MIN_MATCH_LEN;
 145
 146                         if (unlikely(lz_copy(length, offset,
 147                                              out_begin, out_next, out_end,
 148                                              XPRESS_MIN_MATCH_LEN)))
 149                                 return -1;
 150
 151                         out_next += length;
 152                 }
 153         }
 154         return 0;
 155 }
 156
 157 static int
 158 xpress_create_decompressor(size_t max_block_size, void **d_ret)
 159 {
 160         struct xpress_decompressor *d;
 161
 162         if (max_block_size > XPRESS_MAX_OFFSET + 1)
 163                 return WIMLIB_ERR_INVALID_PARAM;
 164
 165         d = ALIGNED_MALLOC(sizeof(*d), DECODE_TABLE_ALIGNMENT);
 166         if (!d)
 167                 return WIMLIB_ERR_NOMEM;
 168
 169         *d_ret = d;
 170         return 0;
 171 }
 172
 173 static void
 174 xpress_free_decompressor(void *_d)
 175 {
 176         ALIGNED_FREE(_d);
 177 }
 178
 179 const struct decompressor_ops xpress_decompressor_ops = {
 180         .create_decompressor = xpress_create_decompressor,
 181         .decompress          = xpress_decompress,
 182         .free_decompressor   = xpress_free_decompressor,
 183 };