rle_decoder.hpp

Go to the documentation of this file.

/*
  CLAW - a C++ Library Absolutely Wonderful

  CLAW is a free library without any particular aim but being useful to 
  anyone.

  Copyright (C) 2005-2011 Julien Jorge

  This library is free software; you can redistribute it and/or
  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.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

  contact: julien.jorge@gamned.org
*/
#ifndef __CLAW_RLE_DECODER_HPP__
#define __CLAW_RLE_DECODER_HPP__

namespace claw
{
  template< typename Pattern, typename InputBuffer, typename OutputBuffer >
  class rle_decoder
  {
  public:
    typedef Pattern pattern_type;

    typedef InputBuffer input_buffer_type;

    typedef OutputBuffer output_buffer_type;

  protected:
    enum mode
      {
        stop,

        raw,

        compressed
      }; // enum mode

  public:
    rle_decoder();
    virtual ~rle_decoder();

    void decode( input_buffer_type& input, output_buffer_type& output );
  
  protected:
    virtual void read_mode( input_buffer_type& input,
                            output_buffer_type& output ) = 0;

  protected:
    mode m_mode;

    unsigned int m_count;

    pattern_type m_pattern;
  }; // class rle_decoder
} // namespace claw

#include <claw/impl/rle_decoder.tpp>

#endif // __CLAW_RLE_DECODER_HPP__