ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

huffman.h

Go to the documentation of this file.
00001 /* ScummVM - Graphic Adventure Engine
00002  *
00003  * ScummVM is the legal property of its developers, whose names
00004  * are too numerous to list here. Please refer to the COPYRIGHT
00005  * file distributed with this source distribution.
00006  *
00007  * This program is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU General Public License
00009  * as published by the Free Software Foundation; either version 2
00010  * of the License, or (at your option) any later version.
00011  *
00012  * This program is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with this program; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00020  *
00021  */
00022 
00023 // Based on eos' Huffman code
00024 
00025 #ifndef COMMON_HUFFMAN_H
00026 #define COMMON_HUFFMAN_H
00027 
00028 #include "common/array.h"
00029 #include "common/list.h"
00030 #include "common/types.h"
00031 
00032 namespace Common {
00033 
00040 class Huffman {
00041 public:
00050     Huffman(uint8 maxLength, uint32 codeCount, const uint32 *codes, const uint8 *lengths, const uint32 *symbols = nullptr);
00051     ~Huffman();
00052 
00054     void setSymbols(const uint32 *symbols = nullptr);
00055 
00057     template<class BITSTREAM>
00058     uint32 getSymbol(BITSTREAM &bits) const {
00059         uint32 code = 0;
00060 
00061         for (uint32 i = 0; i < _codes.size(); i++) {
00062             bits.addBit(code, i);
00063 
00064             for (CodeList::const_iterator cCode = _codes[i].begin(); cCode != _codes[i].end(); ++cCode)
00065                 if (code == cCode->code)
00066                     return cCode->symbol;
00067         }
00068 
00069         error("Unknown Huffman code");
00070         return 0;
00071     }
00072 
00073 private:
00074     struct Symbol {
00075         uint32 code;
00076         uint32 symbol;
00077 
00078         Symbol(uint32 c, uint32 s);
00079     };
00080 
00081     typedef List<Symbol> CodeList;
00082     typedef Array<CodeList> CodeLists;
00083     typedef Array<Symbol *> SymbolList;
00084 
00086     CodeLists _codes;
00087 
00089     SymbolList _symbols;
00090 };
00091 
00092 } // End of namespace Common
00093 
00094 #endif // COMMON_HUFFMAN_H


Generated on Sat Mar 16 2019 05:01:36 for ResidualVM by doxygen 1.7.1
curved edge   curved edge