ImageCompressor.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLIO/src/ICLIO/ImageCompressor.h                      **
** Module : ICLIO                                                  **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Uncopyable.h>
#include <ICLCore/Img.h>

namespace icl{
  namespace io{

    class ICLIO_API ImageCompressor : public utils::Uncopyable{
      struct Data;  
      Data *m_data; 

      int estimateEncodedBufferSize(const core::ImgBase *image, bool skipMetaData);

      int estimateRawDataSize(const core::ImgBase *image, bool skipMetaData);

      public:
      struct ICLIO_API CompressionSpec{
        explicit CompressionSpec(const std::string &mode=std::string(),
                        const std::string &quality=std::string()):mode(mode),quality(quality){}
        std::string mode;    
        std::string quality; 
      };

      protected:
      struct Header{
        struct Params{
          char magick[4];            
          char compressionMode[4];   
          icl32s compressionQuality; 
          icl32s width;              
          icl32s height;             
          icl32s roiX;               
          icl32s roiY;               
          icl32s roiWidth;           
          icl32s roiHeight;          
          icl32s channels;           
          icl32s colorFormat;        
          icl32s depth;              
          icl32s dataLen;            
          icl32s metaLen;            
          int64_t timeStamp;         
        } params;

        const icl8u *data;           
        inline const char *metaBegin() const { return (char*)(data + sizeof(Params)); }
        inline const icl8u *imageBegin() const { return (icl8u*)(metaBegin() + params.metaLen); }
        inline int imageLen() const { return params.dataLen - sizeof(Params) - params.metaLen; }
        inline std::string getMagickCode() const { return std::string(params.magick,params.magick+4); }
        inline std::string getCompressionMode() const { return std::string(params.compressionMode,params.compressionMode+4); }
        CompressionSpec compressionSpec() const;
        void setupImage(core::ImgBase **image);  
      };




      Header uncompressHeader(const icl8u *compressedData, int len);

      Header createHeader(const core::ImgBase *image, bool skipMetaData);

      public:



      struct ICLIO_API CompressedData{
        CompressedData(icl8u *bytes=0,int len=0, float compressionRatio=0,
                       const CompressionSpec &compression=CompressionSpec()):
        bytes(bytes),len(len),compressionRatio(compressionRatio),
          compression(compression){}

        icl8u *bytes;

        int len;

        float compressionRatio;

        CompressionSpec compression;
      };

      ImageCompressor(const CompressionSpec &spec=CompressionSpec("none"));

      ~ImageCompressor();


      virtual void setCompression(const CompressionSpec &spec);

      virtual CompressionSpec getCompression() const;




      utils::Time pickTimeStamp(const icl8u *compressedData);


      const CompressedData compress(const core::ImgBase *image, bool skipMetaData=false);

      const core::ImgBase *uncompress(const icl8u *compressedData, int len, core::ImgBase **dst=0);
    };

  } // namespace io
}