]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/C/BrotliCompress/dec/huffman.h
BaseTools: Copy Brotli algorithm 3rd party source code for tool
[mirror_edk2.git] / BaseTools / Source / C / BrotliCompress / dec / huffman.h
CommitLineData
11b7501a
SB
1/* Copyright 2013 Google Inc. All Rights Reserved.\r
2\r
3 Distributed under MIT license.\r
4 See file LICENSE for detail or copy at https://opensource.org/licenses/MIT\r
5*/\r
6\r
7/* Utilities for building Huffman decoding tables. */\r
8\r
9#ifndef BROTLI_DEC_HUFFMAN_H_\r
10#define BROTLI_DEC_HUFFMAN_H_\r
11\r
12#include "../common/types.h"\r
13#include "./port.h"\r
14\r
15#if defined(__cplusplus) || defined(c_plusplus)\r
16extern "C" {\r
17#endif\r
18\r
19#define BROTLI_HUFFMAN_MAX_CODE_LENGTH 15\r
20\r
21/* Maximum possible Huffman table size for an alphabet size of (index * 32),\r
22 * max code length 15 and root table bits 8. */\r
23static const uint16_t kMaxHuffmanTableSize[] = {\r
24 256, 402, 436, 468, 500, 534, 566, 598, 630, 662, 694, 726, 758, 790, 822,\r
25 854, 886, 920, 952, 984, 1016, 1048, 1080};\r
26/* BROTLI_NUM_BLOCK_LEN_SYMBOLS == 26 */\r
27#define BROTLI_HUFFMAN_MAX_SIZE_26 396\r
28/* BROTLI_MAX_BLOCK_TYPE_SYMBOLS == 258 */\r
29#define BROTLI_HUFFMAN_MAX_SIZE_258 632\r
30/* BROTLI_MAX_CONTEXT_MAP_SYMBOLS == 272 */\r
31#define BROTLI_HUFFMAN_MAX_SIZE_272 646\r
32\r
33#define BROTLI_HUFFMAN_MAX_CODE_LENGTH_CODE_LENGTH 5\r
34\r
35typedef struct {\r
36 uint8_t bits; /* number of bits used for this symbol */\r
37 uint16_t value; /* symbol value or table offset */\r
38} HuffmanCode;\r
39\r
40/* Builds Huffman lookup table assuming code lengths are in symbol order. */\r
41BROTLI_INTERNAL void BrotliBuildCodeLengthsHuffmanTable(HuffmanCode* root_table,\r
42 const uint8_t* const code_lengths, uint16_t* count);\r
43\r
44/* Builds Huffman lookup table assuming code lengths are in symbol order. */\r
45/* Returns size of resulting table. */\r
46BROTLI_INTERNAL uint32_t BrotliBuildHuffmanTable(HuffmanCode* root_table,\r
47 int root_bits, const uint16_t* const symbol_lists, uint16_t* count_arg);\r
48\r
49/* Builds a simple Huffman table. The num_symbols parameter is to be */\r
50/* interpreted as follows: 0 means 1 symbol, 1 means 2 symbols, 2 means 3 */\r
51/* symbols, 3 means 4 symbols with lengths 2,2,2,2, 4 means 4 symbols with */\r
52/* lengths 1,2,3,3. */\r
53BROTLI_INTERNAL uint32_t BrotliBuildSimpleHuffmanTable(HuffmanCode* table,\r
54 int root_bits, uint16_t* symbols, uint32_t num_symbols);\r
55\r
56/* Contains a collection of Huffman trees with the same alphabet size. */\r
57typedef struct {\r
58 HuffmanCode** htrees;\r
59 HuffmanCode* codes;\r
60 uint16_t alphabet_size;\r
61 uint16_t num_htrees;\r
62} HuffmanTreeGroup;\r
63\r
64#if defined(__cplusplus) || defined(c_plusplus)\r
65} /* extern "C" */\r
66#endif\r
67\r
68#endif /* BROTLI_DEC_HUFFMAN_H_ */\r