ossimNitfTileSource.h

Go to the documentation of this file.

//---
//
// License: MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  David Burken
//
// Description:
//
// Contains class declaration for NitfTileSource.
//
//---
// $Id$

#ifndef ossimNitfTileSource_HEADER
#define ossimNitfTileSource_HEADER 1

#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/base/ossimIoStream.h>
#include <ossim/imaging/ossimAppFixedTileCache.h>
#include <ossim/support_data/ossimNitfFile.h>
#include <ossim/support_data/ossimNitfFileHeader.h>
#include <ossim/support_data/ossimNitfImageHeader.h>
#include <memory>

struct jpeg_decompress_struct;

class OSSIM_DLL ossimNitfTileSource : public ossimImageHandler
{
public:

   enum ReadMode
   {
      READ_MODE_UNKNOWN = 0,
      
      READ_BIB_BLOCK = 1,

      READ_BIP_BLOCK = 2,

      READ_BIR_BLOCK = 3,

      READ_BSQ_BLOCK = 4,

      READ_BIB       = 5,

      READ_BIP       = 6,

      READ_BIR       = 7,

      READ_JPEG_BLOCK = 8
   };

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

   virtual bool open();

   bool open( std::shared_ptr<ossim::istream>& str,
              const std::string& connectionString );

   virtual void close();

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

   virtual ossim_uint32 getNumberOfInputBands() const;

   virtual ossim_uint32 getNumberOfOutputBands() const;

   virtual ossim_uint32 getNumberOfLines(ossim_uint32 resLevel = 0) const;
   
   virtual ossim_uint32 getNumberOfSamples(ossim_uint32 resLevel = 0) const;
   
   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=0)const;
   
   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);

   virtual ossimScalarType getOutputScalarType() const;

   virtual ossim_uint32 getTileWidth() const;
   
   virtual ossim_uint32 getTileHeight() const;

   virtual ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;   

   virtual bool isOpen()const;

   virtual ossim_uint32 getCurrentEntry() const;

   virtual void getEntryList(std::vector<ossim_uint32>& entryList) const;

   ossim_uint32 getNumberOfEntries() const;
   
   virtual bool setCurrentEntry(ossim_uint32 entryIdx);

   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   ossimString getSecurityClassification()const;
   
   bool getCacheEnabledFlag() const;

   void setCacheEnabledFlag(bool flag);

   virtual double getMinPixelValue(ossim_uint32 band=0)const;
   virtual double getMaxPixelValue(ossim_uint32 band=0)const;
   virtual double getNullPixelValue(ossim_uint32 band=0)const;

   const ossimNitfFileHeader* getFileHeader()const;
   ossimNitfFileHeader* getFileHeader();
   const ossimNitfImageHeader* getCurrentImageHeader() const;
   ossimNitfImageHeader* getCurrentImageHeader();

   virtual bool getRgbBandList(std::vector<ossim_uint32>& bandList) const;

protected:
   virtual ~ossimNitfTileSource();

   void setBoundingRectangle(const ossimIrect& imageRect);
   
   ossimNitfTileSource(const ossimNitfTileSource& obj);

   ossimNitfTileSource& operator=(const ossimNitfTileSource& rhs); 

   bool loadTile(const ossimIrect& clipRect);

   ossim_uint32 getBlockNumber(const ossimIpt& block_origin) const;

   void destroy();

   virtual bool parseFile();

   virtual bool allocate();

   virtual bool allocateBuffers();

   virtual bool canUncompress(const ossimNitfImageHeader* hdr) const;

   virtual void initializeScalarType();

   virtual void initializeSwapBytesFlag();
   
   virtual void initializeReadMode();

   void initializeBandCount();

   bool initializeBlockSize();

   virtual bool initializeImageRect();

   void initializeCacheSize();

   virtual void initializeCacheTileInterLeaveType();
   
   void initializeCacheTile();

   virtual void initializeCompressedBuf();

   virtual void initializeOutputTile();

   void initializeLut();

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

   virtual bool loadBlock(ossim_uint32 x, ossim_uint32 y);

   bool getPosition(std::streamoff& position,
                    ossim_uint32 x,
                    ossim_uint32 y,
                    ossim_uint32 band) const;

   ossim_uint32 getNumberOfBlocks() const;

   std::streampos getBandOffset() const;

   std::streampos getBlockOffset() const;
   

   void explodePackedBits(ossimRefPtr<ossimImageData> packedBuffer)const;

   void convertTransparentToNull(ossimRefPtr<ossimImageData> tile)const;
   
   ossim_uint32 getPartialReadSize(const ossimIpt& blockOrigin)const;
   bool isVqCompressed(const ossimString& compressionCode)const;

   void vqUncompressC4(ossimRefPtr<ossimImageData> destination,
                       ossim_uint8* source);
   
   void vqUncompressM4(ossimRefPtr<ossimImageData> destination,
                       ossim_uint8* source);

   void lutUncompress(ossimRefPtr<ossimImageData> destination,
                     ossim_uint8* source);

   virtual bool scanForJpegBlockOffsets();

   virtual bool uncompressJpegBlock(ossim_uint32 x, ossim_uint32 y);

   bool loadJpegQuantizationTables(jpeg_decompress_struct& cinfo) const;

   bool loadJpegHuffmanTables(jpeg_decompress_struct& cinfo) const;
   
   virtual void establishDecimationFactors();

   ossimRefPtr<ossimImageData>   theTile;
   ossimRefPtr<ossimImageData>   theCacheTile;
   ossimRefPtr<ossimNitfFile>    theNitfFile;
   std::vector<ossimRefPtr<ossimNitfImageHeader> > theNitfImageHeader;
   ReadMode                      theReadMode;
   ossimScalarType               theScalarType;
   bool                          theSwapBytesFlag;
   ossim_uint32                  theNumberOfInputBands;
   ossim_uint32                  theNumberOfOutputBands;
   ossim_uint32                  theBlockSizeInBytes;
   ossim_uint32                  theReadBlockSizeInBytes;
   ossim_uint32                  theNumberOfImages;
   ossim_uint32                  theCurrentEntry;
   ossimIrect                    theImageRect;
   std::shared_ptr<ossim::istream> theFileStr;
   std::vector<ossim_uint32>     theSelectorBandList;
   std::vector<ossim_uint32>     theOutputBandList;
   ossimIpt                      theCacheSize;
   ossimInterleaveType           theCacheTileInterLeaveType;
   bool                          theCacheEnabledFlag;
   std::vector<ossim_uint32>     theEntryList;
   ossimAppFixedTileCache::ossimAppFixedCacheId theCacheId;
   bool                          thePackedBitsFlag;
   ossimIrect                    theBlockImageRect;
   std::vector<ossim_uint8>      theCompressedBuf;

   //---
   // Have compressed jpeg blocks of variable length so we must scan and
   // capture the offsetts and block sizes for reading.
   //---
   std::vector<std::streamoff>   theNitfBlockOffset;
   std::vector<ossim_uint32>     theNitfBlockSize;
   
   //---
   // If set to true indicates scanForJpegBlockOffsets() needs to be called
   // prior to grabbing a block.
   //---
   bool m_jpegOffsetsDirty;
   
TYPE_DATA
};
   
#endif /* #ifndef ossimNitfTileSource_HEADER */