src/coders/huffman_codes.h

   1 /* huffman_codes.h
   2    Copyright (C) 2008, Francisco Claude, all rights reserved.
   3
   4    Wrapper for huff written by Gonzalo Navarro
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19
  20 */
  21
  22 #ifndef HUFFMAN_CODES_H
  23 #define HUFFMAN_CODES_H
  24
  25 #include <basics.h>
  26 #include <huff.h>
  27
  28 /** Wrapper for the canonical huffman implementation of Gonzalo Navarro.
  29  *
  30  *  @author Francisco Claude
  31  */
  32 class huffman_codes {
  33
  34   public:
  35     /** Creates the codes for the sequence seq of length n */
  36     huffman_codes(uint * seq, uint n);
  37     huffman_codes(uchar * seq, uint n);
  38     ~huffman_codes();
  39
  40     /** Encodes symb into stream at bit-position pos, return the ending position (bits) */
  41     ulong encode(uint symb, uint * stream, ulong pos);
  42
  43     /** decodes into symb from stream at bit-position pos, returns the new position */
  44     ulong decode(uint * symb, uint * stream, ulong pos);
  45
  46     /** Returns the maximum length of a code */
  47     uint max_length();
  48
  49     /** Returns the size of the table */
  50     uint size();
  51
  52     /** Saves the coder to a file */
  53     uint save(FILE *fp);
  54
  55     /** Loads a coder from a file */
  56     static huffman_codes * load(FILE *fp);
  57
  58   protected:
  59     huffman_codes();
  60     THuff huff_table;
  61 };
  62
  63 #endif