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