]> wimlib.net Git - wimlib/blobdiff - src/xpress-decomp.c
wimlib_internal.h: Some comment improvements
[wimlib] / src / xpress-decomp.c
index e67637d65b9a8894eb0cbee49d83cfe64ed84a6b..629b3743a5490df82119dc9db162e828df1dfc46 100644 (file)
@@ -2,23 +2,26 @@
  * xpress-decomp.c
  *
  * XPRESS decompression routines.
+ */
+
+/*
  *
  * Copyright (C) 2012 Eric Biggers
  *
- * wimlib - Library for working with WIM files 
+ * This file is part of wimlib, a library for working with WIM files.
  *
- * This library is free software; you can redistribute it and/or modify it under
- * the terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option) any
- * later version.
+ * wimlib is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option)
+ * any later version.
  *
- * This library is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
- * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ * A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
  *
- * You should have received a copy of the GNU Lesser General Public License along
- * with this library; if not, write to the Free Software Foundation, Inc., 59
- * Temple Place, Suite 330, Boston, MA 02111-1307 USA 
+ * You should have received a copy of the GNU General Public License
+ * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
 
@@ -55,7 +58,7 @@
  * The trickiest part is probably the fact that literal bytes for match lengths
  * are encoded "separately" from the bitstream.
  *
- * Also, a caveat--- according to M$'s documentation for XPRESS,
+ * Also, a caveat--- according to Microsoft's documentation for XPRESS,
  *
  *     "Some implementation of the decompression algorithm expect an extra
  *     symbol to mark the end of the data.  Specifically, some implementations
@@ -66,7 +69,7 @@
  * the end.  Otherwise Microsoft's software will fail to decompress the
  * XPRESS-compressed data.
  *
- * Howeve, WIMLIB's decompressor in xpress-decomp.c currently does not care if
+ * Howeve, wimlib's decompressor in xpress-decomp.c currently does not care if
  * this extra symbol is there or not.
  */
 
 #include "decomp.h"
 
 
-
-
 /* Decodes @huffsym, a value >= XPRESS_NUM_CHARS, that is the header of a match.
  * */
-static int xpress_decode_match(int huffsym, uint window_pos, uint window_len, 
-                               u8 window[], struct input_bitstream *istream)
+static int xpress_decode_match(int huffsym, unsigned window_pos,
+                              unsigned window_len, u8 window[],
+                              struct input_bitstream *istream)
 {
-       uint match_len;
-       uint match_offset;
+       unsigned match_len;
+       unsigned match_offset;
        u8 match_sym = (u8)huffsym;
        u8 len_hdr = match_sym & 0xf;
        u8 offset_bsr = match_sym >> 4;
        int ret;
        u8 *match_dest;
        u8 *match_src;
-       uint i;
+       unsigned i;
 
        ret = bitstream_read_bits(istream, offset_bsr, &match_offset);
        if (ret != 0)
@@ -136,16 +138,15 @@ static int xpress_decode_match(int huffsym, uint window_pos, uint window_len,
        match_src = match_dest - match_offset;
 
        if (window_pos + match_len > window_len) {
-               ERROR("XPRESS dedecompression error: match of length %d "
-                               "bytes overflows window\n", match_len);
+               ERROR("XPRESS decompression error: match of length %d "
+                     "bytes overflows window", match_len);
                return -1;
        }
 
        if (match_src < window) {
                ERROR("XPRESS decompression error: match of length %d bytes "
-                               "references data before window (match_offset = "
-                               "%d, window_pos = %d)\n", match_len,
-                               match_offset, window_pos);
+                     "references data before window (match_offset = %d, "
+                     "window_pos = %d)", match_len, match_offset, window_pos);
                return -1;
        }
 
@@ -157,55 +158,59 @@ static int xpress_decode_match(int huffsym, uint window_pos, uint window_len,
 
 /* Decodes the Huffman-encoded matches and literal bytes in a block of
  * XPRESS-encoded data. */
-static int xpress_decompress_literals(struct input_bitstream *istream, 
-                                     u8 uncompressed_data[], 
-                                     uint uncompressed_len, 
-                                     const u8 lens[], 
+static int xpress_decompress_literals(struct input_bitstream *istream,
+                                     u8 uncompressed_data[],
+                                     unsigned uncompressed_len,
+                                     const u8 lens[],
                                      const u16 decode_table[])
 {
-       uint curpos = 0;
-       uint huffsym;
+       unsigned curpos = 0;
+       unsigned huffsym;
        int match_len;
-       int ret;
+       int ret = 0;
 
        while (curpos < uncompressed_len) {
-               ret = read_huffsym(istream, decode_table, lens, 
-                               XPRESS_NUM_SYMBOLS, XPRESS_TABLEBITS, &huffsym,
-                               XPRESS_MAX_CODEWORD_LEN);
+               ret = read_huffsym(istream, decode_table, lens,
+                                  XPRESS_NUM_SYMBOLS, XPRESS_TABLEBITS,
+                                  &huffsym, XPRESS_MAX_CODEWORD_LEN);
                if (ret != 0)
-                       return ret;
+                       break;
 
                if (huffsym < XPRESS_NUM_CHARS) {
                        uncompressed_data[curpos++] = huffsym;
                } else {
-                       match_len = xpress_decode_match(huffsym, curpos, 
-                                               uncompressed_len, 
-                                               uncompressed_data, istream);
-                       if (match_len == -1)
-                               return 1;
+                       match_len = xpress_decode_match(huffsym,
+                                                       curpos,
+                                                       uncompressed_len,
+                                                       uncompressed_data,
+                                                       istream);
+                       if (match_len == -1) {
+                               ret = 1;
+                               break;
+                       }
                        curpos += match_len;
                }
        }
-       return 0;
+       return ret;
 }
 
 
-int xpress_decompress(const void *__compressed_data, uint compressed_len, 
-                       void *uncompressed_data, uint uncompressed_len)
+int xpress_decompress(const void *__compressed_data, unsigned compressed_len,
+                     void *uncompressed_data, unsigned uncompressed_len)
 {
        u8 lens[XPRESS_NUM_SYMBOLS];
        u16 decode_table[(1 << XPRESS_TABLEBITS) + 2 * XPRESS_NUM_SYMBOLS];
        struct input_bitstream istream;
        u8 *lens_p;
        const u8 *compressed_data;
-       uint i;
+       unsigned i;
        int ret;
 
        compressed_data = __compressed_data;
        lens_p = lens;
 
-       DEBUG2("compressed_len = %d, uncompressed_len = %d\n",
-                       compressed_len, uncompressed_len);
+       DEBUG2("compressed_len = %d, uncompressed_len = %d",
+              compressed_len, uncompressed_len);
 
        /* XPRESS uses only one Huffman tree.  It contains 512 symbols, and the
         * code lengths of these symbols are given literally as 4-bit integers
@@ -225,9 +230,10 @@ int xpress_decompress(const void *__compressed_data, uint compressed_len,
        if (ret != 0)
                return ret;
 
-       init_input_bitstream(&istream, compressed_data + XPRESS_NUM_SYMBOLS / 2, 
-                                       compressed_len - XPRESS_NUM_SYMBOLS / 2);
+       init_input_bitstream(&istream, compressed_data + XPRESS_NUM_SYMBOLS / 2,
+                            compressed_len - XPRESS_NUM_SYMBOLS / 2);
 
-       return xpress_decompress_literals(&istream, uncompressed_data, 
-                                       uncompressed_len, lens, decode_table);
+       return xpress_decompress_literals(&istream, uncompressed_data,
+                                         uncompressed_len, lens,
+                                         decode_table);
 }