ossimKakaduJ2kReader.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  LGPL
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Description:
//
// Class declaration for JPEG2000 (J2K) reader.
//
//----------------------------------------------------------------------------
// $Id: ossimKakaduJ2kReader.h 22884 2014-09-12 13:14:35Z dburken $

#ifndef ossimKakaduJ2kReader_HEADER
#define ossimKakaduJ2kReader_HEADER 1

#include <ossim/plugin/ossimPluginConstants.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/support_data/ossimJ2kSizRecord.h>
#include <ossim/imaging/ossimAppFixedTileCache.h>
#include <iosfwd>
#include <fstream>

// Forward class declarations.
class ossimImageData;

//---
// Kakadu put multiple classes in header:  kdu_compressed_source, kd_thread_env
//---
#include <kdu_compressed.h>
// #include <kdu_region_decompressor.h>

namespace kdu_core
{
   class kdu_line_buf;
   class kdu_thread_queue;
}

class OSSIM_PLUGINS_DLL ossimKakaduJ2kReader :
   public ossimImageHandler, public kdu_core::kdu_compressed_source
{
public:

   ossimKakaduJ2kReader();
   
   virtual ~ossimKakaduJ2kReader();

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

   virtual ossimString getClassName() const;

   virtual ossimRefPtr<ossimImageData> getTile(const  ossimIrect& rect,
                                               ossim_uint32 resLevel=0);

   virtual ossim_uint32 getNumberOfInputBands() const;

   virtual ossim_uint32 getNumberOfOutputBands()const; 
   virtual ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;

   virtual ossimScalarType getOutputScalarType() const;
   
   virtual void getDecimationFactor(ossim_uint32 resLevel,
                                    ossimDpt& result) const;

   virtual void getDecimationFactors(vector<ossimDpt>& decimations) 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 bool open();

   virtual bool isOpen()const;

   virtual void closeEntry();

   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);   

protected:

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

   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:

   void initializeTile();

   bool loadTileFromCache(ossim_uint32 x, ossim_uint32 y,
                          const ossimIrect& clipRect);
   
   bool loadTile(ossim_uint32 x, ossim_uint32 y);

   kdu_core::kdu_codestream     theCodestream;
   kdu_core::kdu_thread_env*    theThreadEnv;
   kdu_core::kdu_thread_queue*  theOpenTileThreadQueue;
   ossim_uint32                 theSourcePrecisionBits;
   ossim_uint32                 theMinDwtLevels;
   std::ifstream                theFileStr;
   ossimJ2kSizRecord            theSizRecord;
   ossimScalarType              theScalarType;
   ossimIrect                   theImageRect;
   ossimRefPtr<ossimImageData>  theTile;
   ossimRefPtr<ossimImageData>  theCacheTile;
   ossim_uint32                 theTileSizeX;
   ossim_uint32                 theTileSizeY;
   

   ossimAppFixedTileCache::ossimAppFixedCacheId theCacheId;
   
TYPE_DATA   
};

inline ossim_int32 ossimKakaduJ2kReader::get_capabilities()
{
   return ( KDU_SOURCE_CAP_SEEKABLE );
}

inline ossim_int32 ossimKakaduJ2kReader::read(kdu_core::kdu_byte *buf,
                                              ossim_int32 num_bytes)
{
   theFileStr.read((char*)buf, num_bytes);
   return theFileStr.gcount();
}

inline bool ossimKakaduJ2kReader::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, ios_base::beg);

   return theFileStr.good();
}

inline kdu_core::kdu_long ossimKakaduJ2kReader::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());
}

#endif /* #ifndef ossimKakaduJ2kReader_HEADER */