ossimKakaduCompressor.h

Go to the documentation of this file.

//---
//
// License: MIT
//
// Description: Wrapper class to compress whole tiles using kdu_analysis
// object.
//
//---
// $Id$

#ifndef ossimKakaduCompressor_HEADER
#define ossimKakaduCompressor_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/base/ossimObject.h>
#include <ossim/base/ossimProperty.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/base/ossimString.h>
#include <ossim/imaging/ossimKakaduCompressorInterface.h>
#include <kdu_compressed.h>
#include <kdu_elementary.h>
#include <kdu_sample_processing.h>
#include <kdu_stripe_compressor.h>

#include <iosfwd>

class ossimFilename;
class ossimImageData;
class ossimImageGeometry;
class ossimIpt;
class ossimKakaduCompressedTarget;
class ossimNitfJ2klraTag;

namespace kdu_supp
{
   class jp2_family_tgt;
   class jp2_target; 
}

class ossimKakaduCompressor :
   public ossimObject, public ossimKakaduCompressorInterface
{
public:

   // Enums moved to: ossimKakaduCompressorInterface.h
   // Matches static "COMPRESSION_QUALITY" string array in .cpp.
   // enum ossimKakaduCompressionQuality
   // {
   //  Prefixed with OKP for OSSIM Kakadu Plugin to avoid clashes.
   //   OKP_UNKNOWN              = 0,
   //   OKP_USER_DEFINED         = 1,
   //   OKP_NUMERICALLY_LOSSLESS = 2,
   //   OKP_VISUALLY_LOSSLESS    = 3,
   //   OKP_LOSSY                = 4,
   //   OKP_EPJE                 = 5  // Exploitation Preferred J2K Encoding
   // };

   ossimKakaduCompressor();

   virtual ~ossimKakaduCompressor();

 virtual void create(ossim::ostream* os,
                     ossimScalarType scalar,
                     ossim_uint32 bands,
                     const ossimIrect& imageRect,
                     const ossimIpt& tileSize,
                     ossim_uint32 tilesToWrite,
                     bool jp2);

   void openJp2Codestream();

   virtual bool writeTile(ossimImageData& srcTile);

   virtual void finish();

   virtual void setQualityType(ossimKakaduCompressionQuality type);

   ossimKakaduCompressionQuality getQualityType() const;

   void setReversibleFlag(bool reversible);
   
   bool getReversibleFlag() const;
   
   virtual void setAlphaChannelFlag( bool flag );

   bool getAlphaChannelFlag() const;

   virtual 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);
   
   virtual bool setProperty(ossimRefPtr<ossimProperty> property);
   
   ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   
   void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   bool writeGeotiffBox(const ossimImageGeometry* geom,
                        const ossimIrect& rect,
                        const ossimFilename& tmpFile,
                        ossimPixelType pixelType);

   bool writeGmlBox( const ossimImageGeometry* geom,
                     const ossimIrect& rect );
   
   void initialize( ossimNitfJ2klraTag* j2klraTag,
                    ossim_uint32 actualBitsPerPixel ) const;

   // ossimObject virtuals:
   virtual ossimString getLongName()  const;
   virtual ossimString getClassName() const;

private:

   void initializeCodingParams(kdu_core::kdu_params* cod, const ossimIrect& imageRect);
   
   int  getNumberOfLayers() const;

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

   void setLevels(kdu_core::kdu_params* cod,
                  const ossimIrect& imageRect,
                  ossim_int32 levels);

   void setCodeBlockSize(kdu_core::kdu_params* cod,
                         ossim_int32 xSize,
                         ossim_int32 ySize);

   void setProgressionOrder(kdu_core::kdu_params* cod,
                            ossim_int32 corder);

   void setWaveletKernel(kdu_core::kdu_params* cod, ossim_int32 kernel);

   void setQualityLayers(kdu_core::kdu_params* cod, ossim_int32 layers);

   void setTlmTileCount(ossim_uint32 tilesToWrite);

   void printCompressionQualityTypes( std::ostream& out ) const;

   ossimKakaduCompressedTarget* m_target;
   
   kdu_supp::jp2_family_tgt*    m_jp2FamTgt;
   kdu_supp::jp2_target*        m_jp2Target;
   kdu_core::kdu_codestream     m_codestream;
   kdu_core::kdu_thread_env*    m_threadEnv;
   kdu_core::kdu_thread_queue*  m_threadQueue;

   int                          m_layerSpecCount;

   std::vector<kdu_core::kdu_long> m_layerByteSizes;
   
   // std::vector<kdu_uint16>      m_layerSlopes;

   ossimIrect                   m_imageRect;

   bool                         m_reversible;

   bool                         m_alpha;

   ossim_int32                  m_levels;

   ossim_int32                  m_threads;

   std::vector<ossimString> m_options;

   ossimKakaduCompressionQuality m_qualityType;

   ossimRefPtr<ossimImageData> m_normTile;

TYPE_DATA
}; // End: class ossimKakaduCompressor

#endif /* matches: #ifndef ossimKakaduCompressor_HEADER */