wimlib.net Git - wimlib/blob - 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 /*
  30  * The XPRESS compression format is a LZ77 and Huffman-code based algorithm.
  31  * That means it is quite similar to LZX compression, but XPRESS is slightly
  32  * simpler, so it is a little faster to compress and decompress.
  33  *
  34  * The XPRESS compression format is mostly documented in a file called "[MS-XCA]
  35  * Xpress Compression Algorithm".  In the MSDN library, it can currently be
  36  * found under Open Specifications => Protocols => Windows Protocols => Windows
  37  * Server Protocols => [MS-XCA] Xpress Compression Algorithm".  The format in
  38  * WIMs is specifically the algorithm labeled as the "LZ77+Huffman Algorithm"
  39  * (there apparently are some other versions of XPRESS as well).
  40  *
  41  * If you are already familiar with the LZ77 algorithm and Huffman coding, the
  42  * XPRESS format is fairly simple.  The compressed data begins with 256 bytes
  43  * that contain 512 4-bit integers that are the lengths of the symbols in the
  44  * Huffman tree used for decoding compressed literals.  This is the only Huffman
  45  * tree that is used for the entirety of the 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 are literal bytes.  Values 256 through 511 are matches and may require
  50  * extra bits or bytes to be read to get the match offset and match length.
  51  *
  52  * There is no notion of a "compressed block" in the XPRESS format, so in the
  53  * XPRESS format, each WIM chunk (32768 bytes) will always use only one Huffman
  54  * tree.
  55  *
  56  * The trickiest part is probably the fact that literal bytes for match lengths
  57  * are encoded "separately" from the bitstream.
  58  *
  59  * Also, a caveat--- according to Microsoft's documentation for XPRESS,
  60  *
  61  *      "Some implementation of the decompression algorithm expect an extra
  62  *      symbol to mark the end of the data.  Specifically, some implementations
  63  *      fail during decompression if the Huffman symbol 256 is not found after
  64  *      the actual data."
  65  *
  66  * This is the case for WIM files--- in we must write this extra symbol "256" at
  67  * the end.  Otherwise Microsoft's software will fail to decompress the
  68  * XPRESS-compressed data.
  69  *
  70  * However, wimlib's decompressor in this file currently does not care if this
  71  * extra symbol is there or not.
  72  */
  73
  74 #include "util.h"
  75 #include "xpress.h"
  76 #include "wimlib.h"
  77
  78 #define XPRESS_DECOMP
  79 #include "decompress.h"
  80
  81 /*
  82  * Decodes a symbol @huffsym that begins an XPRESS match.
  83  *
  84  * The low 8 bits of the symbol are divided into:
  85  *
  86  * bits 0-3:  length header
  87  * bits 4-7:  index of high-order bit of match offset
  88  *
  89  * Note: taking the low 8 bits of the symbol is the same as subtracting 256, the
  90  * number of symbols reserved for literals.
  91  *
  92  * Returns the match length, or -1 on error.
  93  */
  94 static int xpress_decode_match(unsigned huffsym, unsigned window_pos,
  95                                unsigned window_len, u8 window[],
  96                                struct input_bitstream *istream)
  97 {
  98         unsigned match_len;
  99         unsigned match_offset;
 100         u8 match_sym = (u8)huffsym;
 101         u8 len_hdr = match_sym & 0xf;
 102         u8 offset_bsr = match_sym >> 4;
 103         int ret;
 104         u8 *match_dest;
 105         u8 *match_src;
 106         unsigned i;
 107
 108         ret = bitstream_read_bits(istream, offset_bsr, &match_offset);
 109         if (ret != 0)
 110                 return ret;
 111         match_offset |= (1 << offset_bsr);
 112
 113         if (len_hdr == 0xf) {
 114                 ret = bitstream_read_byte(istream);
 115                 if (ret < 0)
 116                         return ret;
 117                 match_len = ret;
 118                 if (match_len == 0xff) {
 119                         ret = bitstream_read_byte(istream);
 120                         if (ret < 0)
 121                                 return ret;
 122                         match_len = ret;
 123
 124                         ret = bitstream_read_byte(istream);
 125                         if (ret < 0)
 126                                 return ret;
 127
 128                         match_len |= (ret << 8);
 129                 } else {
 130                         match_len += 0xf;
 131                 }
 132         } else {
 133                 match_len = len_hdr;
 134         }
 135         match_len += XPRESS_MIN_MATCH;
 136
 137         /* Verify that the match is in the bounds of the part of the window
 138          * currently in use, then copy the source of the match to the current
 139          * position. */
 140
 141         match_dest = window + window_pos;
 142         match_src = match_dest - match_offset;
 143
 144         if (window_pos + match_len > window_len) {
 145                 ERROR("XPRESS decompression error: match of length %u "
 146                       "bytes overflows window", match_len);
 147                 return -1;
 148         }
 149
 150         if (match_src < window) {
 151                 ERROR("XPRESS decompression error: match of length %u bytes "
 152                       "references data before window (match_offset = %u, "
 153                       "window_pos = %u)", match_len, match_offset, window_pos);
 154                 return -1;
 155         }
 156
 157         for (i = 0; i < match_len; i++)
 158                 match_dest[i] = match_src[i];
 159
 160         return match_len;
 161 }
 162
 163 /* Decodes the Huffman-encoded matches and literal bytes in a block of
 164  * XPRESS-encoded data. */
 165 static int xpress_decompress_block(struct input_bitstream *istream,
 166                                    u8 uncompressed_data[],
 167                                    unsigned uncompressed_len,
 168                                    const u8 lens[],
 169                                    const u16 decode_table[])
 170 {
 171         unsigned curpos;
 172         unsigned huffsym;
 173         int ret;
 174         int match_len;
 175
 176         curpos = 0;
 177         while (curpos < uncompressed_len) {
 178                 ret = read_huffsym(istream, decode_table, lens,
 179                                    XPRESS_NUM_SYMBOLS, XPRESS_TABLEBITS,
 180                                    &huffsym, XPRESS_MAX_CODEWORD_LEN);
 181                 if (ret != 0)
 182                         return ret;
 183
 184                 if (huffsym < XPRESS_NUM_CHARS) {
 185                         uncompressed_data[curpos++] = huffsym;
 186                 } else {
 187                         match_len = xpress_decode_match(huffsym,
 188                                                         curpos,
 189                                                         uncompressed_len,
 190                                                         uncompressed_data,
 191                                                         istream);
 192                         if (match_len < 0)
 193                                 return match_len;
 194                         curpos += match_len;
 195                 }
 196         }
 197         return 0;
 198 }
 199
 200
 201 int xpress_decompress(const void *__compressed_data, unsigned compressed_len,
 202                       void *uncompressed_data, unsigned uncompressed_len)
 203 {
 204         u8 lens[XPRESS_NUM_SYMBOLS];
 205         u16 decode_table[(1 << XPRESS_TABLEBITS) + 2 * XPRESS_NUM_SYMBOLS];
 206         struct input_bitstream istream;
 207         u8 *lens_p;
 208         const u8 *compressed_data;
 209         unsigned i;
 210         int ret;
 211
 212         compressed_data = __compressed_data;
 213         lens_p = lens;
 214
 215         DEBUG2("compressed_len = %d, uncompressed_len = %d",
 216                compressed_len, uncompressed_len);
 217
 218         /* XPRESS uses only one Huffman tree.  It contains 512 symbols, and the
 219          * code lengths of these symbols are given literally as 4-bit integers
 220          * in the first 256 bytes of the compressed data.
 221          */
 222         if (compressed_len < XPRESS_NUM_SYMBOLS / 2)
 223                 return -1;
 224
 225         for (i = 0; i < XPRESS_NUM_SYMBOLS / 2; i++) {
 226                 *lens_p++ = compressed_data[i] & 0xf;
 227                 *lens_p++ = compressed_data[i] >> 4;
 228         }
 229
 230         ret = make_huffman_decode_table(decode_table, XPRESS_NUM_SYMBOLS,
 231                                         XPRESS_TABLEBITS, lens,
 232                                         XPRESS_MAX_CODEWORD_LEN);
 233         if (ret != 0)
 234                 return ret;
 235
 236         init_input_bitstream(&istream, compressed_data + XPRESS_NUM_SYMBOLS / 2,
 237                              compressed_len - XPRESS_NUM_SYMBOLS / 2);
 238
 239         return xpress_decompress_block(&istream, uncompressed_data,
 240                                        uncompressed_len, lens,
 241                                        decode_table);
 242 }