2a3db87df3720a740589bd8486ff82abd57ae104
[ffmpeg.git] / libavcodec / huffman.c
1 /*
2  * Copyright (c) 2006 Konstantin Shishkov
3  * Copyright (c) 2007 Loren Merritt
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * huffman tree builder and VLC generator
25  */
26
27 #include <stdint.h>
28
29 #include "avcodec.h"
30 #include "huffman.h"
31
32 /* symbol for Huffman tree node */
33 #define HNODE -1
34
35 typedef struct HeapElem {
36     uint64_t val;
37     int name;
38 } HeapElem;
39
40 static void heap_sift(HeapElem *h, int root, int size)
41 {
42     while (root * 2 + 1 < size) {
43         int child = root * 2 + 1;
44         if (child < size - 1 && h[child].val > h[child+1].val)
45             child++;
46         if (h[root].val > h[child].val) {
47             FFSWAP(HeapElem, h[root], h[child]);
48             root = child;
49         } else
50             break;
51     }
52 }
53
54 void ff_huff_gen_len_table(uint8_t *dst, const uint64_t *stats)
55 {
56     HeapElem h[256];
57     int up[2*256];
58     int len[2*256];
59     int offset, i, next;
60     int size = 256;
61
62     for (offset = 1; ; offset <<= 1) {
63         for (i=0; i < size; i++) {
64             h[i].name = i;
65             h[i].val = (stats[i] << 8) + offset;
66         }
67         for (i = size / 2 - 1; i >= 0; i--)
68             heap_sift(h, i, size);
69
70         for (next = size; next < size * 2 - 1; next++) {
71             // merge the two smallest entries, and put it back in the heap
72             uint64_t min1v = h[0].val;
73             up[h[0].name] = next;
74             h[0].val = INT64_MAX;
75             heap_sift(h, 0, size);
76             up[h[0].name] = next;
77             h[0].name = next;
78             h[0].val += min1v;
79             heap_sift(h, 0, size);
80         }
81
82         len[2 * size - 2] = 0;
83         for (i = 2 * size - 3; i >= size; i--)
84             len[i] = len[up[i]] + 1;
85         for (i = 0; i < size; i++) {
86             dst[i] = len[up[i]] + 1;
87             if (dst[i] >= 32) break;
88         }
89         if (i==size) break;
90     }
91 }
92
93 static void get_tree_codes(uint32_t *bits, int16_t *lens, uint8_t *xlat,
94                            Node *nodes, int node,
95                            uint32_t pfx, int pl, int *pos, int no_zero_count)
96 {
97     int s;
98
99     s = nodes[node].sym;
100     if (s != HNODE || (no_zero_count && !nodes[node].count)) {
101         bits[*pos] = pfx;
102         lens[*pos] = pl;
103         xlat[*pos] = s;
104         (*pos)++;
105     } else {
106         pfx <<= 1;
107         pl++;
108         get_tree_codes(bits, lens, xlat, nodes, nodes[node].n0, pfx, pl,
109                        pos, no_zero_count);
110         pfx |= 1;
111         get_tree_codes(bits, lens, xlat, nodes, nodes[node].n0 + 1, pfx, pl,
112                        pos, no_zero_count);
113     }
114 }
115
116 static int build_huff_tree(VLC *vlc, Node *nodes, int head, int flags, int nb_bits)
117 {
118     int no_zero_count = !(flags & FF_HUFFMAN_FLAG_ZERO_COUNT);
119     uint32_t bits[256];
120     int16_t lens[256];
121     uint8_t xlat[256];
122     int pos = 0;
123
124     get_tree_codes(bits, lens, xlat, nodes, head, 0, 0,
125                    &pos, no_zero_count);
126     return ff_init_vlc_sparse(vlc, nb_bits, pos, lens, 2, 2, bits, 4, 4, xlat, 1, 1, 0);
127 }
128
129
130 /**
131  * nodes size must be 2*nb_codes
132  * first nb_codes nodes.count must be set
133  */
134 int ff_huff_build_tree(AVCodecContext *avctx, VLC *vlc, int nb_codes, int nb_bits,
135                        Node *nodes, HuffCmp cmp, int flags)
136 {
137     int i, j;
138     int cur_node;
139     int64_t sum = 0;
140
141     for (i = 0; i < nb_codes; i++) {
142         nodes[i].sym = i;
143         nodes[i].n0 = -2;
144         sum += nodes[i].count;
145     }
146
147     if (sum >> 31) {
148         av_log(avctx, AV_LOG_ERROR,
149                "Too high symbol frequencies. "
150                "Tree construction is not possible\n");
151         return -1;
152     }
153     qsort(nodes, nb_codes, sizeof(Node), cmp);
154     cur_node = nb_codes;
155     nodes[nb_codes*2-1].count = 0;
156     for (i = 0; i < nb_codes * 2 - 1; i += 2) {
157         nodes[cur_node].sym = HNODE;
158         nodes[cur_node].count = nodes[i].count + nodes[i + 1].count;
159         nodes[cur_node].n0 = i;
160         for (j = cur_node; j > 0; j--) {
161             if (nodes[j].count > nodes[j - 1].count ||
162                 (nodes[j].count == nodes[j - 1].count &&
163                  (!(flags & FF_HUFFMAN_FLAG_HNODE_FIRST) ||
164                   nodes[j].n0 == j - 1 || nodes[j].n0 == j - 2 ||
165                   (nodes[j].sym!=HNODE && nodes[j-1].sym!=HNODE))))
166                 break;
167             FFSWAP(Node, nodes[j], nodes[j - 1]);
168         }
169         cur_node++;
170     }
171     if (build_huff_tree(vlc, nodes, nb_codes * 2 - 2, flags, nb_bits) < 0) {
172         av_log(avctx, AV_LOG_ERROR, "Error building tree\n");
173         return -1;
174     }
175     return 0;
176 }