huffman.c 5.09 KB
Newer Older
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 9 10 11
 * 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.
 *
12
 * Libav is distributed in the hope that it will be useful,
13 14 15 16 17
 * 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.
 *
 * 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 20 21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

22 23 24 25 26
/**
 * @file
 * huffman tree builder and VLC generator
 */

27 28
#include <stdint.h>

29
#include "avcodec.h"
30
#include "get_bits.h"
31 32 33 34 35
#include "huffman.h"

/* symbol for Huffman tree node */
#define HNODE -1

36
typedef struct HeapElem {
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
    uint64_t val;
    int name;
} HeapElem;

static void heap_sift(HeapElem *h, int root, int size)
{
    while (root * 2 + 1 < size) {
        int child = root * 2 + 1;
        if (child < size - 1 && h[child].val > h[child+1].val)
            child++;
        if (h[root].val > h[child].val) {
            FFSWAP(HeapElem, h[root], h[child]);
            root = child;
        } else
            break;
    }
}

void ff_huff_gen_len_table(uint8_t *dst, const uint64_t *stats)
{
    HeapElem h[256];
    int up[2*256];
    int len[2*256];
    int offset, i, next;
    int size = 256;

    for (offset = 1; ; offset <<= 1) {
        for (i=0; i < size; i++) {
            h[i].name = i;
            h[i].val = (stats[i] << 8) + offset;
        }
        for (i = size / 2 - 1; i >= 0; i--)
            heap_sift(h, i, size);

        for (next = size; next < size * 2 - 1; next++) {
            // merge the two smallest entries, and put it back in the heap
            uint64_t min1v = h[0].val;
            up[h[0].name] = next;
            h[0].val = INT64_MAX;
            heap_sift(h, 0, size);
            up[h[0].name] = next;
            h[0].name = next;
            h[0].val += min1v;
            heap_sift(h, 0, size);
        }

        len[2 * size - 2] = 0;
        for (i = 2 * size - 3; i >= size; i--)
            len[i] = len[up[i]] + 1;
        for (i = 0; i < size; i++) {
            dst[i] = len[up[i]] + 1;
            if (dst[i] >= 32) break;
        }
        if (i==size) break;
    }
}
93

94 95 96
static void get_tree_codes(uint32_t *bits, int16_t *lens, uint8_t *xlat,
                           Node *nodes, int node,
                           uint32_t pfx, int pl, int *pos, int no_zero_count)
97 98 99 100
{
    int s;

    s = nodes[node].sym;
101
    if (s != HNODE || (no_zero_count && !nodes[node].count)) {
102 103 104 105
        bits[*pos] = pfx;
        lens[*pos] = pl;
        xlat[*pos] = s;
        (*pos)++;
106
    } else {
107 108
        pfx <<= 1;
        pl++;
109 110
        get_tree_codes(bits, lens, xlat, nodes, nodes[node].n0, pfx, pl,
                       pos, no_zero_count);
111
        pfx |= 1;
112 113
        get_tree_codes(bits, lens, xlat, nodes, nodes[node].n0 + 1, pfx, pl,
                       pos, no_zero_count);
114 115 116
    }
}

117
static int build_huff_tree(VLC *vlc, Node *nodes, int head, int flags)
118
{
119
    int no_zero_count = !(flags & FF_HUFFMAN_FLAG_ZERO_COUNT);
120 121 122 123 124
    uint32_t bits[256];
    int16_t lens[256];
    uint8_t xlat[256];
    int pos = 0;

125 126
    get_tree_codes(bits, lens, xlat, nodes, head, 0, 0,
                   &pos, no_zero_count);
127
    return ff_init_vlc_sparse(vlc, FF_HUFFMAN_BITS, pos, lens, 2, 2, bits, 4, 4, xlat, 1, 1, 0);
128 129 130 131
}


/**
132
 * nodes size must be 2*nb_codes
133 134 135
 * first nb_codes nodes.count must be set
 */
int ff_huff_build_tree(AVCodecContext *avctx, VLC *vlc, int nb_codes,
136
                       Node *nodes, HuffCmp cmp, int flags)
137 138 139 140 141
{
    int i, j;
    int cur_node;
    int64_t sum = 0;

142
    for (i = 0; i < nb_codes; i++) {
143 144 145 146 147
        nodes[i].sym = i;
        nodes[i].n0 = -2;
        sum += nodes[i].count;
    }

148 149 150 151
    if (sum >> 31) {
        av_log(avctx, AV_LOG_ERROR,
               "Too high symbol frequencies. "
               "Tree construction is not possible\n");
152 153 154 155
        return -1;
    }
    qsort(nodes, nb_codes, sizeof(Node), cmp);
    cur_node = nb_codes;
156
    nodes[nb_codes*2-1].count = 0;
157
    for (i = 0; i < nb_codes * 2 - 1; i += 2) {
158
        nodes[cur_node].sym = HNODE;
159
        nodes[cur_node].count = nodes[i].count + nodes[i + 1].count;
160
        nodes[cur_node].n0 = i;
161 162 163 164 165 166
        for (j = cur_node; j > 0; j--) {
            if (nodes[j].count > nodes[j - 1].count ||
                (nodes[j].count == nodes[j - 1].count &&
                 (!(flags & FF_HUFFMAN_FLAG_HNODE_FIRST) ||
                  nodes[j].n0 == j - 1 || nodes[j].n0 == j - 2 ||
                  (nodes[j].sym!=HNODE && nodes[j-1].sym!=HNODE))))
167
                break;
168
            FFSWAP(Node, nodes[j], nodes[j - 1]);
169 170 171
        }
        cur_node++;
    }
172
    if (build_huff_tree(vlc, nodes, nb_codes * 2 - 2, flags) < 0) {
173 174 175 176 177
        av_log(avctx, AV_LOG_ERROR, "Error building tree\n");
        return -1;
    }
    return 0;
}