wimlib.net Git - wimlib/blob - src/lzx.h

   1 #ifndef _WIMLIB_LZX_H
   2 #define _WIMLIB_LZX_H
   3
   4 #include "util.h"
   5
   6 //#define ENABLE_LZX_DEBUG
   7 #ifdef ENABLE_LZX_DEBUG
   8 #       define LZX_DEBUG DEBUG
   9 #else
  10 #       define LZX_DEBUG(format, ...)
  11 #endif
  12
  13
  14 /* Constants, some defined by the LZX specification: */
  15
  16 /* The smallest and largest allowed match lengths. */
  17 #define LZX_MIN_MATCH                2
  18 #define LZX_MAX_MATCH                257
  19
  20 /* Number of values an uncompressed literal byte can represent. */
  21 #define LZX_NUM_CHARS                256
  22
  23 /* Each LZX block begins with 3 bits that determines the block type: */
  24 #define LZX_BLOCKTYPE_VERBATIM       1
  25 #define LZX_BLOCKTYPE_ALIGNED        2
  26 #define LZX_BLOCKTYPE_UNCOMPRESSED   3
  27 /* values 0, and 4 through 7, are invalid. */
  28
  29
  30 #define LZX_NUM_PRIMARY_LENS         7  /* this one missing from spec! */
  31
  32 /* Only valid for 32768 block size! */
  33 #define LZX_NUM_POSITION_SLOTS       30
  34
  35 /* Read the LZX specification for information about the Huffman trees used in
  36  * the LZX compression format.  Basically there are 4 of them: The main tree,
  37  * the length tree, the pre tree, and the aligned tree.  The main tree and
  38  * length tree are given at the beginning of VERBATIM and ALIGNED blocks as a
  39  * list of *_NUM_SYMBOLS code length values.  They are read using the
  40  * read_code_lens() function and built using the make_decode_table() function.
  41  * The decode table is not a real tree but rather a table that we can index by
  42  * some number of bits (*_TABLEBITS) of the input to quickly look up the symbol
  43  * corresponding to a Huffman code.
  44  *
  45  * The ALIGNED tree is only present on ALIGNED blocks.
  46  *
  47  * A PRETREE is used to encode the code lengths for the main tree and the length
  48  * tree.  There is a separate pretree for each half of the main tree.  */
  49
  50 #define LZX_MAINTREE_NUM_SYMBOLS         (LZX_NUM_CHARS + \
  51                                         (LZX_NUM_POSITION_SLOTS << 3))
  52 #define LZX_MAINTREE_TABLEBITS          12
  53
  54 #define LZX_LENTREE_NUM_SYMBOLS         249
  55 #define LZX_LENTREE_TABLEBITS           12
  56
  57 #define LZX_PRETREE_NUM_SYMBOLS         20
  58 #define LZX_PRETREE_TABLEBITS           6
  59 #define LZX_PRETREE_ELEMENT_SIZE        4
  60
  61
  62 #define LZX_ALIGNEDTREE_NUM_SYMBOLS     8
  63 #define LZX_ALIGNEDTREE_TABLEBITS       7
  64 #define LZX_ALIGNEDTREE_ELEMENT_SIZE    3
  65
  66 /* Maximum allowed length of a Huffman code. */
  67 #define LZX_MAX_CODEWORD_LEN            16
  68
  69 /* For the LZX-compressed blocks in WIM files, this value is always used as the
  70  * filesize parameter for the call instruction (0xe8 byte) preprocessing, even
  71  * though the blocks themselves are not this size, and the size of the actual
  72  * file resource in the WIM file is very likely to be something entirely
  73  * different as well.  */
  74 #define LZX_MAGIC_FILESIZE           12000000
  75
  76 extern const u8 lzx_extra_bits[51];
  77 extern const u32 lzx_position_base[51];
  78
  79 /* Least-recently used queue for match offsets. */
  80 struct lru_queue {
  81         int R0;
  82         int R1;
  83         int R2;
  84 };
  85
  86 extern int lzx_decompress(const void *compressed_data, uint compressed_len,
  87                           void *uncompressed_data, uint uncompressed_len);
  88
  89 extern int lzx_compress(const void *uncompressed_data, uint uncompressed_len,
  90                         void *compressed_data, uint *compressed_len_ret);
  91
  92 #endif /* _WIMLIB_LZX_H */