ossimKakaduJp2Reader.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 JP2 reader.
//
// Specification: ISO/IEC 15444
//
//----------------------------------------------------------------------------
// $Id: ossimKakaduJp2Reader.h 22884 2014-09-12 13:14:35Z dburken $

#ifndef ossimKakaduJp2Reader_HEADER
#define ossimKakaduJp2Reader_HEADER 1


#include <ossim/plugin/ossimPluginConstants.h>
#include <ossim/base/ossimIpt.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimAppFixedTileCache.h>
#include <ossim/imaging/ossimImageData.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/support_data/ossimJ2kSizRecord.h>

#include <kdu_compressed.h>

#include <vector>

// Forward declarations:

class ossimKeywordlist;

class kdu_tile;

namespace kdu_core
{
   class kdu_compressed_source;
   class kdu_line_buf;
   class kdu_thread_queue;
}

namespace kdu_supp
{
   struct kdu_channel_mapping;
   class jp2_family_src;
}

class OSSIM_PLUGINS_DLL ossimKakaduJp2Reader : public ossimImageHandler
{
public:

   ossimKakaduJp2Reader();
   
   virtual ~ossimKakaduJp2Reader();

   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 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();

   enum
   {
      SIGNATURE_BOX_SIZE = 12,
      GEOTIFF_UUID_SIZE  = 16
   };

   virtual ossimRefPtr<ossimImageGeometry> getImageGeometry();

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

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

   virtual ossimRefPtr<ossimImageGeometry> getInternalImageGeometry();

   virtual ossimRefPtr<ossimImageGeometry> getImageGeometryFromGeotiffBox();

   virtual ossimRefPtr<ossimImageGeometry> getImageGeometryFromGmlBox();

   ossimRefPtr<ossimImageGeometry> getMetadataImageGeometry() const;

   bool isJp2();

   bool openJp2File();
   
   void initializeTile();

   bool loadTileFromCache(const ossimIpt& origin,
                          const ossimIrect& clipRect);
   
   bool loadTile(const ossimIpt& origin);

   bool configureChannelMapping();

   kdu_supp::jp2_family_src*        theJp2FamilySrc;
   kdu_core::kdu_compressed_source* theJp2Source;
   kdu_supp::kdu_channel_mapping*   theChannels;
   kdu_core::kdu_codestream         theCodestream;
   kdu_core::kdu_thread_env*        theThreadEnv;
   kdu_core::kdu_thread_queue*      theOpenTileThreadQueue;
   
   ossim_uint32                theMinDwtLevels;
   ossim_uint32                theNumberOfBands;
   ossimIpt                    theCacheSize;
   ossimScalarType             theScalarType;
   ossimIrect                  theImageRect; 
   std::vector<ossimIrect>      theJp2Dims;

   std::vector<ossimIrect>      theJp2TileDims;

   ossimRefPtr<ossimImageData>  theTile;
   ossimRefPtr<ossimImageData>  theCacheTile;

   ossimAppFixedTileCache::ossimAppFixedCacheId theCacheId;
   
TYPE_DATA   
};

#endif /* #ifndef ossimKakaduJp2Reader_HEADER */