ossimKakaduNitfReader.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License: MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Description:
//
// Class declaration for reader of NITF images with JPEG2000 (J2K) compressed
// blocks using kakadu library for decompression.
//
//----------------------------------------------------------------------------
// $Id$

#ifndef ossimKakaduNitfReader_HEADER
#define ossimKakaduNitfReader_HEADER 1

#include <ossim/plugin/ossimPluginConstants.h>
#include <ossim/imaging/ossimNitfTileSource.h>
#include <kdu_compressed.h>
#include <iosfwd>
#include <fstream>

// Forward declarations:

namespace kdu_core
{
   class kdu_thread_queue;
}

namespace kdu_supp
{
   class jp2_family_src;
   class jp2_source;
   struct kdu_channel_mapping;
}



class OSSIM_PLUGINS_DLL ossimKakaduNitfReader :
   public ossimNitfTileSource, public kdu_core::kdu_compressed_source
{
public:

   enum
   {
      SIGNATURE_BOX_SIZE = 12
   };

   ossimKakaduNitfReader();
   
   virtual ~ossimKakaduNitfReader();

   virtual ossimString getShortName() const;
   
   virtual ossimString getLongName()  const;

   virtual ossim_uint32 getNumberOfDecimationLevels()const;

   virtual ossim_uint32 getNumberOfLines(ossim_uint32 resLevel = 0) const;

   virtual ossim_uint32 getNumberOfSamples(ossim_uint32 resLevel = 0) const;

   virtual void setMinPixelValue(ossim_uint32 band, const ossim_float64& pix);

   virtual void setMaxPixelValue(ossim_uint32 band, const ossim_float64& pix);

   virtual void setNullPixelValue(ossim_uint32 band, const ossim_float64& pix);

   virtual ossim_float64 getMinPixelValue(ossim_uint32 band=0)const;

   virtual ossim_float64 getMaxPixelValue(ossim_uint32 band=0)const;

   virtual ossim_float64 getNullPixelValue(ossim_uint32 band=0)const;

protected:

  virtual bool getOverviewTile(ossim_uint32 resLevel,
                               ossimImageData* result); 

  
  virtual bool loadBlock(ossim_uint32 x, ossim_uint32 y);
  
   virtual bool parseFile();

   virtual bool allocate(); 

   virtual bool allocateBuffers();
   
   virtual bool canUncompress(const ossimNitfImageHeader* hdr) const;

   virtual void initializeReadMode();

   virtual bool scanForJpegBlockOffsets();

   virtual void initializeSwapBytesFlag();

   virtual void initializeCacheTileInterLeaveType();

   virtual ossim_int32 get_capabilities();
   
   virtual ossim_int32 read(kdu_core::kdu_byte *buf, ossim_int32 num_bytes);

   virtual bool seek(kdu_core::kdu_long offset);

   virtual kdu_core::kdu_long get_pos();

private:

   bool isEntryJ2k() const;

   bool checkJp2Signature();

   void configureChannelMapping();

   

   std::ostream& dumpTiles(std::ostream& out);

   std::streamoff m_startOfCodestreamOffset;

   kdu_supp::jp2_family_src*      m_jp2FamilySrc;
   kdu_supp::jp2_source*          m_jp2Source;
   kdu_supp::kdu_channel_mapping* m_channels;
   kdu_core::kdu_codestream       m_codestream;
   kdu_core::kdu_thread_env*      m_threadEnv;
   kdu_core::kdu_thread_queue*    m_openTileThreadQueue;
   
   ossim_uint32               m_sourcePrecisionBits;
   ossim_uint32               m_minDwtLevels;
   
   std::vector<ossimIrect>    m_imageDims;

   ossim_float64              m_minSampleValue;
   ossim_float64              m_maxSampleValue;
   ossim_float64              m_nullSampleValue;

TYPE_DATA   
};

inline ossim_int32 ossimKakaduNitfReader::get_capabilities()
{
   return ( KDU_SOURCE_CAP_SEEKABLE | KDU_SOURCE_CAP_SEQUENTIAL );
}

inline ossim_int32 ossimKakaduNitfReader::read(kdu_core::kdu_byte *buf, ossim_int32 num_bytes)
{
   theFileStr->read((char*)buf, num_bytes);
   return theFileStr->gcount();
}

inline bool ossimKakaduNitfReader::seek(kdu_core::kdu_long offset)
{
   // If the last byte is read, the eofbit must be reset. 
   if ( theFileStr->eof() )
   {
      theFileStr->clear();
   }

   //---
   // All seeks are relative to the start of code stream.
   //---
   theFileStr->seekg(offset+m_startOfCodestreamOffset, ios_base::beg);
   return theFileStr->good();
}

inline kdu_core::kdu_long ossimKakaduNitfReader::get_pos()
{
   //---
   // Must subtract the SOC(start of code stream) from the real file position
   // since positions are relative to SOC.
   //---
   return static_cast<kdu_core::kdu_long>(theFileStr->tellg() - m_startOfCodestreamOffset );
}

#endif /* #ifndef ossimKakaduNitfReader_HEADER */