ossimOpjCompressor.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  LGPL
//
// See LICENSE.txt file in the top level directory for more details.
//
// Description: Wrapper class to compress whole tiles using OpenJPEG code.
//
//----------------------------------------------------------------------------
// $Id$

#ifndef ossimOpjCompressor_HEADER
#define ossimOpjCompressor_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/base/ossimProperty.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/base/ossimString.h>
#include <opj_config.h>
#include <openjpeg.h>
#include <iosfwd>

class ossimFilename;
class ossimImageData;
class ossimImageGeometry;
class ossimIpt;

class ossimOpjCompressor
{
public:

   // Matches static "COMPRESSION_QUALITY" string array in .cpp.
   enum ossimOpjCompressionQuality
   {
      OPJ_UNKNOWN              = 0,
      OPJ_USER_DEFINED         = 1,
      OPJ_NUMERICALLY_LOSSLESS = 2,
      OPJ_VISUALLY_LOSSLESS    = 3,
      OPJ_LOSSY                = 4
   };
   
   ossimOpjCompressor();
   
   ~ossimOpjCompressor();
   
   void create(std::ostream* os,
               ossimScalarType scalar,
               ossim_uint32 bands,
               const ossimIrect& imageRect,
               const ossimIpt& tileSize,
               bool jp2);
   
   void openJp2Codestream();
   
   bool writeTile(ossimImageData* srcTile, ossim_uint32 tileIndex);

   void finish();
   
   void setQualityType(ossimOpjCompressionQuality type);
   
   ossimOpjCompressionQuality getQualityType() const;
   
   void setReversibleFlag(bool reversible);
   
   bool getReversibleFlag() const;
   
   void setAlphaChannelFlag( bool flag );

   bool getAlphaChannelFlag() const;

   void setLevels(ossim_int32 levels);

   ossim_int32 getLevels() const;
   
   void setThreads(ossim_int32 threads);

   ossim_int32 getThreads() const;

   void setOptions(const std::vector<ossimString>& options);
   
   void getOptions(std::vector<ossimString>& options) const;
  
   bool saveState(ossimKeywordlist& kwl, const char* prefix=0)const;
   
   bool loadState(const ossimKeywordlist& kwl, const char* prefix=0);
   
   bool setProperty(ossimRefPtr<ossimProperty> property);
   
   ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   
   void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   bool writeGeotiffBox(std::ostream* stream,
                        const ossimImageGeometry* geom,
                        const ossimIrect& rect,
                        const ossimFilename& tmpFile,
                        ossimPixelType pixelType);
   
   bool writeGmlBox( std::ostream* stream,
                     const ossimImageGeometry* geom,
                     const ossimIrect& rect );
   
private:

   void initOpjCodingParams( bool jp2,
                             const ossimIpt& tileSize,
                             const ossimIrect& imageRect );
   
   int  getNumberOfLayers() const;

   ossimString getQualityTypeString() const;
   void setQualityTypeString(const ossimString& s);

   void initLevels( const ossimIrect& imageRect );

   void setCodeBlockSize( ossim_int32 xSize, ossim_int32 ySize);

   void setProgressionOrder( OPJ_PROG_ORDER progressionOrder );

   void setTlmTileCount(ossim_uint32 tilesToWrite);

   opj_cparameters_t* createOpjCodingParameters(
      bool jp2,
      const ossimIpt& tileSize,
      const ossimIrect& imageRect ) const;
   
   opj_codec_t* createOpjCodec( bool jp2 ) const;

   opj_stream_t* createOpjStream( std::ostream* os ) const;
   
   opj_image_t* createOpjImage( ossimScalarType scalar,
                                ossim_uint32 bands,
                                const ossimIrect& imageRect ) const;

   opj_cparameters_t* m_params;
   opj_codec_t*       m_codec;
   opj_stream_t*      m_stream;
   
   opj_image_t*       m_image;
   
   
   // opj_codec* m_stream;
   // opj_image_t* m_image = 0;

   
   ossimIrect                   m_imageRect;

   bool                         m_reversible;

   bool                         m_alpha;

   ossim_int32                  m_levels;

   ossim_int32                  m_threads;

   std::vector<ossimString> m_options;

   ossimOpjCompressionQuality m_qualityType;
   
};

#endif /* matches: #ifndef ossimOpjCompressor_HEADER */