huffman.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_HUFFMAN_H
#define COMMON_HUFFMAN_H

#include <vector>
#include <list>

#include "src/common/types.h"

namespace Common {

class BitStream;

struct HuffmanTable {
    uint8  maxLength; 
    size_t codeCount; 

    const uint32 *codes;   
    const uint8  *lengths; 
    const uint32 *symbols; 
};

class Huffman {
public:
    Huffman(uint8 maxLength, size_t codeCount, const uint32 *codes,
            const uint8 *lengths, const uint32 *symbols = 0);
    Huffman(const HuffmanTable &table);
    ~Huffman();

    void setSymbols(const uint32 *symbols = 0);

    uint32 getSymbol(BitStream &bits) const;

private:
    struct Symbol {
        uint32 code;
        uint32 symbol;

        Symbol(uint32 c, uint32 s);
    };

    typedef std::list<Symbol>     CodeList;
    typedef std::vector<CodeList> CodeLists;
    typedef std::vector<Symbol *> SymbolList;

    CodeLists _codes;

    SymbolList _symbols;

    void init(uint8 maxLength, size_t codeCount, const uint32 *codes,
              const uint8 *lengths, const uint32 *symbols);
};

} // End of namespace Common

#endif // COMMON_HUFFMAN_H