Replaced all "uint" with "unsigned"
[wimlib] / src / compress.c
1 /*
2  * compress.c
3  *
4  * Functions used for compression.
5  */
6
7 /*
8  * Copyright (C) 2012 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU General Public License as published by the Free
14  * Software Foundation; either version 3 of the License, or (at your option)
15  * any later version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 #include "compress.h"
27 #include <stdlib.h>
28 #include <string.h>
29
30 static inline void flush_bits(struct output_bitstream *ostream)
31 {
32         *(u16*)ostream->bit_output = cpu_to_le16(ostream->bitbuf);
33         ostream->bit_output = ostream->next_bit_output;
34         ostream->next_bit_output = ostream->output;
35         ostream->output += 2;
36         ostream->num_bytes_remaining -= 2;
37 }
38
39 /* Writes @num_bits bits, given by the @num_bits least significant bits of
40  * @bits, to the output @ostream. */
41 int bitstream_put_bits(struct output_bitstream *ostream, output_bitbuf_t bits,
42                        unsigned num_bits)
43 {
44         unsigned rem_bits;
45
46         wimlib_assert(num_bits <= 16);
47         if (num_bits <= ostream->free_bits) {
48                 ostream->bitbuf = (ostream->bitbuf << num_bits) | bits;
49                 ostream->free_bits -= num_bits;
50         } else {
51
52                 if (ostream->num_bytes_remaining + (ostream->output -
53                                                 ostream->bit_output) < 2)
54                         return 1;
55
56                 /* It is tricky to output the bits correctly.  The correct way
57                  * is to output little-endian 2-byte words, such that the bits
58                  * in the SECOND byte logically precede those in the FIRST byte.
59                  * While the byte order is little-endian, the bit order is
60                  * big-endian; the first bit in a byte is the high-order one.
61                  * Any multi-bit numbers are in bit-big-endian form, so the
62                  * low-order bit of a multi-bit number is the LAST bit to be
63                  * output. */
64                 rem_bits = num_bits - ostream->free_bits;
65                 ostream->bitbuf <<= ostream->free_bits;
66                 ostream->bitbuf |= bits >> rem_bits;
67                 flush_bits(ostream);
68                 ostream->free_bits = 16 - rem_bits;
69                 ostream->bitbuf = bits;
70
71         }
72         return 0;
73 }
74
75 /* Flushes any remaining bits in the output buffer to the output byte stream. */
76 int flush_output_bitstream(struct output_bitstream *ostream)
77 {
78         if (ostream->num_bytes_remaining + (ostream->output -
79                                         ostream->bit_output) < 2)
80                 return 1;
81         if (ostream->free_bits != 16) {
82                 ostream->bitbuf <<= ostream->free_bits;
83                 flush_bits(ostream);
84         }
85         return 0;
86 }
87
88 /* Initializes an output bit buffer to write its output to the memory location
89  * pointer to by @data. */
90 void init_output_bitstream(struct output_bitstream *ostream, void *data,
91                            unsigned num_bytes)
92 {
93         wimlib_assert(num_bytes >= 4);
94
95         ostream->bitbuf              = 0;
96         ostream->free_bits           = 16;
97         ostream->bit_output          = (u8*)data;
98         ostream->next_bit_output     = (u8*)data + 2;
99         ostream->output              = (u8*)data + 4;
100         ostream->num_bytes_remaining = num_bytes - 4;
101 }
102
103 /* Intermediate (non-leaf) node in a Huffman tree. */
104 typedef struct HuffmanNode {
105         u32 freq;
106         u16 sym;
107         union {
108                 u16 path_len;
109                 u16 height;
110         };
111         struct HuffmanNode *left_child;
112         struct HuffmanNode *right_child;
113 } HuffmanNode;
114
115 /* Leaf node in a Huffman tree.  The fields are in the same order as the
116  * HuffmanNode, so it can be cast to a HuffmanNode.  There are no pointers to
117  * the children in the leaf node. */
118 typedef struct {
119         u32 freq;
120         u16 sym;
121         union {
122                 u16 path_len;
123                 u16 height;
124         };
125 } HuffmanLeafNode;
126
127 /* Comparator function for HuffmanLeafNodes.  Sorts primarily by symbol
128  * frequency and secondarily by symbol value. */
129 static int cmp_leaves_by_freq(const void *__leaf1, const void *__leaf2)
130 {
131         const HuffmanLeafNode *leaf1 = __leaf1;
132         const HuffmanLeafNode *leaf2 = __leaf2;
133
134         int freq_diff = (int)leaf1->freq - (int)leaf2->freq;
135
136         if (freq_diff == 0)
137                 return (int)leaf1->sym - (int)leaf2->sym;
138         else
139                 return freq_diff;
140 }
141
142 /* Comparator function for HuffmanLeafNodes.  Sorts primarily by code length and
143  * secondarily by symbol value. */
144 static int cmp_leaves_by_code_len(const void *__leaf1, const void *__leaf2)
145 {
146         const HuffmanLeafNode *leaf1 = __leaf1;
147         const HuffmanLeafNode *leaf2 = __leaf2;
148
149         int code_len_diff = (int)leaf1->path_len - (int)leaf2->path_len;
150
151         if (code_len_diff == 0)
152                 return (int)leaf1->sym - (int)leaf2->sym;
153         else
154                 return code_len_diff;
155 }
156
157 /* Recursive function to calculate the depth of the leaves in a Huffman tree.
158  * */
159 static void huffman_tree_compute_path_lengths(HuffmanNode *node, u16 cur_len)
160 {
161         if (node->sym == (u16)(-1)) {
162                 /* Intermediate node. */
163                 huffman_tree_compute_path_lengths(node->left_child, cur_len + 1);
164                 huffman_tree_compute_path_lengths(node->right_child, cur_len + 1);
165         } else {
166                 /* Leaf node. */
167                 node->path_len = cur_len;
168         }
169 }
170
171 /* Creates a canonical Huffman code from an array of symbol frequencies.
172  *
173  * The algorithm used is similar to the well-known algorithm that builds a
174  * Huffman tree using a minheap.  In that algorithm, the leaf nodes are
175  * initialized and inserted into the minheap with the frequency as the key.
176  * Repeatedly, the top two nodes (nodes with the lowest frequency) are taken out
177  * of the heap and made the children of a new node that has a frequency equal to
178  * the sum of the two frequencies of its children.  This new node is inserted
179  * into the heap.  When all the nodes have been removed from the heap, what
180  * remains is the Huffman tree. The Huffman code for a symbol is given by the
181  * path to it in the tree, where each left pointer is mapped to a 0 bit and each
182  * right pointer is mapped to a 1 bit.
183  *
184  * The algorithm used here uses an optimization that removes the need to
185  * actually use a heap.  The leaf nodes are first sorted by frequency, as
186  * opposed to being made into a heap.  Note that this sorting step takes O(n log
187  * n) time vs.  O(n) time for heapifying the array, where n is the number of
188  * symbols.  However, the heapless method is probably faster overall, due to the
189  * time saved later.  In the heapless method, whenever an intermediate node is
190  * created, it is not inserted into the sorted array.  Instead, the intermediate
191  * nodes are kept in a separate array, which is easily kept sorted because every
192  * time an intermediate node is initialized, it will have a frequency at least
193  * as high as that of the previous intermediate node that was initialized.  So
194  * whenever we want the 2 nodes, leaf or intermediate, that have the lowest
195  * frequency, we check the low-frequency ends of both arrays, which is an O(1)
196  * operation.
197  *
198  * The function builds a canonical Huffman code, not just any Huffman code.  A
199  * Huffman code is canonical if the codeword for each symbol numerically
200  * precedes the codeword for all other symbols of the same length that are
201  * numbered higher than the symbol, and additionally, all shorter codewords,
202  * 0-extended, numerically precede longer codewords.  A canonical Huffman code
203  * is useful because it can be reconstructed by only knowing the path lengths in
204  * the tree.  See the make_huffman_decode_table() function to see how to
205  * reconstruct a canonical Huffman code from only the lengths of the codes.
206  *
207  * @num_syms:  The number of symbols in the alphabet.
208  *
209  * @max_codeword_len:  The maximum allowed length of a codeword in the code.
210  *                      Note that if the code being created runs up against
211  *                      this restriction, the code ultimately created will be
212  *                      suboptimal, although there are some advantages for
213  *                      limiting the length of the codewords.
214  *
215  * @freq_tab:  An array of length @num_syms that contains the frequencies
216  *                      of each symbol in the uncompressed data.
217  *
218  * @lens:          An array of length @num_syms into which the lengths of the
219  *                      codewords for each symbol will be written.
220  *
221  * @codewords:     An array of @num_syms short integers into which the
222  *                      codewords for each symbol will be written.  The first
223  *                      lens[i] bits of codewords[i] will contain the codeword
224  *                      for symbol i.
225  */
226 void make_canonical_huffman_code(unsigned num_syms, unsigned max_codeword_len,
227                                  const u32 freq_tab[], u8 lens[],
228                                  u16 codewords[])
229 {
230         /* We require at least 2 possible symbols in the alphabet to produce a
231          * valid Huffman decoding table. It is allowed that fewer than 2 symbols
232          * are actually used, though. */
233         wimlib_assert(num_syms >= 2);
234
235         /* Initialize the lengths and codewords to 0 */
236         memset(lens, 0, num_syms * sizeof(lens[0]));
237         memset(codewords, 0, num_syms * sizeof(codewords[0]));
238
239         /* Calculate how many symbols have non-zero frequency.  These are the
240          * symbols that actually appeared in the input. */
241         unsigned num_used_symbols = 0;
242         for (unsigned i = 0; i < num_syms; i++)
243                 if (freq_tab[i] != 0)
244                         num_used_symbols++;
245
246
247         /* It is impossible to make a code for num_used_symbols symbols if there
248          * aren't enough code bits to uniquely represent all of them. */
249         wimlib_assert((1 << max_codeword_len) > num_used_symbols);
250
251         /* Initialize the array of leaf nodes with the symbols and their
252          * frequencies. */
253         HuffmanLeafNode leaves[num_used_symbols];
254         unsigned leaf_idx = 0;
255         for (unsigned i = 0; i < num_syms; i++) {
256                 if (freq_tab[i] != 0) {
257                         leaves[leaf_idx].freq = freq_tab[i];
258                         leaves[leaf_idx].sym  = i;
259                         leaves[leaf_idx].height = 0;
260                         leaf_idx++;
261                 }
262         }
263
264         /* Deal with the special cases where num_used_symbols < 2. */
265         if (num_used_symbols < 2) {
266                 if (num_used_symbols == 0) {
267                         /* If num_used_symbols is 0, there are no symbols in the
268                          * input, so it must be empty.  This should be an error,
269                          * but the LZX format expects this case to succeed.  All
270                          * the codeword lengths are simply marked as 0 (which
271                          * was already done.) */
272                 } else {
273                         /* If only one symbol is present, the LZX format
274                          * requires that the Huffman code include two codewords.
275                          * One is not used.  Note that this doesn't make the
276                          * encoded data take up more room anyway, since binary
277                          * data itself has 2 symbols. */
278
279                         unsigned sym = leaves[0].sym;
280
281                         codewords[0] = 0;
282                         lens[0]      = 1;
283                         if (sym == 0) {
284                                 /* dummy symbol is 1, real symbol is 0 */
285                                 codewords[1] = 1;
286                                 lens[1]      = 1;
287                         } else {
288                                 /* dummy symbol is 0, real symbol is sym */
289                                 codewords[sym] = 1;
290                                 lens[sym]      = 1;
291                         }
292                 }
293                 return;
294         }
295
296         /* Otherwise, there are at least 2 symbols in the input, so we need to
297          * find a real Huffman code. */
298
299
300         /* Declare the array of intermediate nodes.  An intermediate node is not
301          * associated with a symbol. Instead, it represents some binary code
302          * prefix that is shared between at least 2 codewords.  There can be at
303          * most num_used_symbols - 1 intermediate nodes when creating a Huffman
304          * code.  This is because if there were at least num_used_symbols nodes,
305          * the code would be suboptimal because there would be at least one
306          * unnecessary intermediate node.
307          *
308          * The worst case (greatest number of intermediate nodes) would be if
309          * all the intermediate nodes were chained together.  This results in
310          * num_used_symbols - 1 intermediate nodes.  If num_used_symbols is at
311          * least 17, this configuration would not be allowed because the LZX
312          * format constrains codes to 16 bits or less each.  However, it is
313          * still possible for there to be more than 16 intermediate nodes, as
314          * long as no leaf has a depth of more than 16.  */
315         HuffmanNode inodes[num_used_symbols - 1];
316
317
318         /* Pointer to the leaf node of lowest frequency that hasn't already been
319          * added as the child of some intermediate note. */
320         HuffmanLeafNode *cur_leaf;
321
322         /* Pointer past the end of the array of leaves. */
323         HuffmanLeafNode *end_leaf = &leaves[num_used_symbols];
324
325         /* Pointer to the intermediate node of lowest frequency. */
326         HuffmanNode     *cur_inode;
327
328         /* Pointer to the next unallocated intermediate node. */
329         HuffmanNode     *next_inode;
330
331         /* Only jump back to here if the maximum length of the codewords allowed
332          * by the LZX format (16 bits) is exceeded. */
333 try_building_tree_again:
334
335         /* Sort the leaves from those that correspond to the least frequent
336          * symbol, to those that correspond to the most frequent symbol.  If two
337          * leaves have the same frequency, they are sorted by symbol. */
338         qsort(leaves, num_used_symbols, sizeof(leaves[0]), cmp_leaves_by_freq);
339
340         cur_leaf   = &leaves[0];
341         cur_inode  = &inodes[0];
342         next_inode = &inodes[0];
343
344         /* The following loop takes the two lowest frequency nodes of those
345          * remaining and makes them the children of the next available
346          * intermediate node.  It continues until all the leaf nodes and
347          * intermediate nodes have been used up, or the maximum allowed length
348          * for the codewords is exceeded.  For the latter case, we must adjust
349          * the frequencies to be more equal and then execute this loop again. */
350         while (1) {
351
352                 /* Lowest frequency node. */
353                 HuffmanNode *f1 = NULL;
354
355                 /* Second lowest frequency node. */
356                 HuffmanNode *f2 = NULL;
357
358                 /* Get the lowest and second lowest frequency nodes from
359                  * the remaining leaves or from the intermediate nodes.
360                  * */
361
362                 if (cur_leaf != end_leaf && (cur_inode == next_inode ||
363                                         cur_leaf->freq <= cur_inode->freq)) {
364                         f1 = (HuffmanNode*)cur_leaf++;
365                 } else if (cur_inode != next_inode) {
366                         f1 = cur_inode++;
367                 }
368
369                 if (cur_leaf != end_leaf && (cur_inode == next_inode ||
370                                         cur_leaf->freq <= cur_inode->freq)) {
371                         f2 = (HuffmanNode*)cur_leaf++;
372                 } else if (cur_inode != next_inode) {
373                         f2 = cur_inode++;
374                 }
375
376                 /* All nodes used up! */
377                 if (f1 == NULL || f2 == NULL)
378                         break;
379
380                 /* next_inode becomes the parent of f1 and f2. */
381
382                 next_inode->freq   = f1->freq + f2->freq;
383                 next_inode->sym    = (u16)(-1); /* Invalid symbol. */
384                 next_inode->left_child   = f1;
385                 next_inode->right_child  = f2;
386
387                 /* We need to keep track of the height so that we can detect if
388                  * the length of a codeword has execeed max_codeword_len.   The
389                  * parent node has a height one higher than the maximum height
390                  * of its children. */
391                 next_inode->height = max(f1->height, f2->height) + 1;
392
393                 /* Check to see if the code length of the leaf farthest away
394                  * from next_inode has exceeded the maximum code length. */
395                 if (next_inode->height > max_codeword_len) {
396                         /* The code lengths can be made more uniform by making
397                          * the frequencies more uniform.  Divide all the
398                          * frequencies by 2, leaving 1 as the minimum frequency.
399                          * If this keeps happening, the symbol frequencies will
400                          * approach equality, which makes their Huffman
401                          * codewords approach the length
402                          * log_2(num_used_symbols).
403                          * */
404                         for (unsigned i = 0; i < num_used_symbols; i++)
405                                 if (leaves[i].freq > 1)
406                                         leaves[i].freq >>= 1;
407                         goto try_building_tree_again;
408                 }
409                 next_inode++;
410         }
411
412         /* The Huffman tree is now complete, and its height is no more than
413          * max_codeword_len.  */
414
415         HuffmanNode *root = next_inode - 1;
416         wimlib_assert(root->height <= max_codeword_len);
417
418         /* Compute the path lengths for the leaf nodes. */
419         huffman_tree_compute_path_lengths(root, 0);
420
421         /* Sort the leaf nodes primarily by code length and secondarily by
422          * symbol.  */
423         qsort(leaves, num_used_symbols, sizeof(leaves[0]), cmp_leaves_by_code_len);
424
425         u16 cur_codeword = 0;
426         unsigned cur_codeword_len = 0;
427         for (unsigned i = 0; i < num_used_symbols; i++) {
428
429                 /* Each time a codeword becomes one longer, the current codeword
430                  * is left shifted by one place.  This is part of the procedure
431                  * for enumerating the canonical Huffman code.  Additionally,
432                  * whenever a codeword is used, 1 is added to the current
433                  * codeword.  */
434
435                 unsigned len_diff = leaves[i].path_len - cur_codeword_len;
436                 cur_codeword <<= len_diff;
437                 cur_codeword_len += len_diff;
438
439                 u16 sym = leaves[i].sym;
440                 codewords[sym] = cur_codeword;
441                 lens[sym] = cur_codeword_len;
442
443                 cur_codeword++;
444         }
445 }