zpack.h

Go to the documentation of this file.

 
/*
  ZPack format:
    u8  _signature; // = 0x99 = ZPack::Signature
    u8  _compression_method[2:0]  // = 0:huffman->rle 1:huffman 2:flat 3:flat with size
        reserved[7:3]  // reserved
 
    // only when 3:flat with size
    u8  size[ 7 : 0]
    u8  size[15 : 8]
    u8  size[23 :16]
*/
 
#pragma once
 
#include <memory>
#include <b8/type.h>
#include <pipe.h>
 
namespace ZPack {
constexpr u8  Signature = 0x99;
 
enum CompressionMethod {
  HuffmanToRle, 
  Huffman,      
  Flat,         
  FlatWithSize  
};
 
class CZPackEncoder {
  std::shared_ptr< Pipe::CPipe > _pipe_in  = std::make_shared< Pipe::CNullPipe >();
  std::shared_ptr< Pipe::CPipe > _pipe_out = std::make_shared< Pipe::CNullPipe >();
public:
  void  SetIn ( std::shared_ptr< Pipe::CPipe > pipe_in_  );
  
  void  SetOut( std::shared_ptr< Pipe::CPipe > pipe_out_ );
  
  void  Encode();
};
 
class CZPackDecoder {
  std::shared_ptr< Pipe::CPipe > _pipe_in  = std::make_shared< Pipe::CNullPipe >();
  std::shared_ptr< Pipe::CPipe > _pipe_out = std::make_shared< Pipe::CNullPipe >();
public:
  enum DecodeResult{
    DECODE_OK,                   
    DECODE_ERR_INVALID_SIGNATURE,
    DECODE_INVALID_DATA,         
  };
  
  void  SetIn ( std::shared_ptr< Pipe::CPipe > pipe_in_  );
  
  void  SetOut( std::shared_ptr< Pipe::CPipe > pipe_out_ );
 
  CZPackDecoder::DecodeResult Decode();
};
 
} // namespace ZPack