Claw  1.7.3
rle_decoder.hpp
Go to the documentation of this file.
1 /*
2  CLAW - a C++ Library Absolutely Wonderful
3 
4  CLAW is a free library without any particular aim but being useful to
5  anyone.
6 
7  Copyright (C) 2005-2011 Julien Jorge
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 
23  contact: julien.jorge@gamned.org
24 */
30 #ifndef __CLAW_RLE_DECODER_HPP__
31 #define __CLAW_RLE_DECODER_HPP__
32 
33 namespace claw
34 {
53  template< typename Pattern, typename InputBuffer, typename OutputBuffer >
55  {
56  public:
58  typedef Pattern pattern_type;
59 
61  typedef InputBuffer input_buffer_type;
62 
64  typedef OutputBuffer output_buffer_type;
65 
66  protected:
70  enum mode
71  {
74 
76  raw,
77 
80  }; // enum mode
81 
82  public:
83  rle_decoder();
84  virtual ~rle_decoder();
85 
86  void decode( input_buffer_type& input, output_buffer_type& output );
87 
88  protected:
89  virtual void read_mode( input_buffer_type& input,
90  output_buffer_type& output ) = 0;
91 
92  protected:
95 
101  unsigned int m_count;
102 
105  }; // class rle_decoder
106 } // namespace claw
107 
108 #include <claw/impl/rle_decoder.tpp>
109 
110 #endif // __CLAW_RLE_DECODER_HPP__
claw::rle_decoder::output_buffer_type
OutputBuffer output_buffer_type
The type of the output buffer.
Definition: rle_decoder.hpp:64
claw::rle_decoder::stop
@ stop
Stop the decoding.
Definition: rle_decoder.hpp:73
claw
This is the main namespace.
Definition: algorithm.hpp:33
claw::rle_decoder::input_buffer_type
InputBuffer input_buffer_type
The type of the input buffer.
Definition: rle_decoder.hpp:61
claw::rle_decoder::m_mode
mode m_mode
Current mode of the decompression.
Definition: rle_decoder.hpp:94
claw::rle_decoder::compressed
@ compressed
Next bytes represent compressed data.
Definition: rle_decoder.hpp:79
claw::rle_decoder::pattern_type
Pattern pattern_type
The type of the patterns we will read in the input buffer.
Definition: rle_decoder.hpp:58
claw::rle_decoder::m_count
unsigned int m_count
Case of m_mode :
Definition: rle_decoder.hpp:101
claw::rle_decoder
A class to help decoding run-length encoded (RLE) streams.
Definition: rle_decoder.hpp:54
claw::rle_decoder::m_pattern
pattern_type m_pattern
The pattern to repeat.
Definition: rle_decoder.hpp:104
claw::rle_decoder::raw
@ raw
Next bytes represent raw data.
Definition: rle_decoder.hpp:76
claw::rle_decoder< rgba_pixel_8, InputBuffer, rle_targa_output_buffer< InputBuffer > >::mode
mode
State of the decompression.
Definition: rle_decoder.hpp:70