ossimTiffTileSource.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
//          Frank Warmerdam (warmerdam@pobox.com)
//
// Description:
//
// Contains class declaration for ossimTiffTileSource.
// ossimTiffTileSource  is derived from ImageHandler which is derived from
// TileSource.
//*******************************************************************
// $Id$

#ifndef ossimTiffTileSource_HEADER
#define ossimTiffTileSource_HEADER 1

#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/base/ossimIrect.h>
#include <vector>
#include <ossim/base/ossimStreamFactoryRegistry.h>
#include <ossim/support_data/TiffStreamAdaptor.h>
/*
 * TIFF is defined as an incomplete type to hide the tiff library's internal
 * data structures from clients.
 */
typedef struct tiff TIFF;  

class ossimImageData;
class ossimTiffOverviewTileSource;
class TiffStreamAdaptor;
class OSSIMDLLEXPORT ossimTiffTileSource : public ossimImageHandler
{
public:
  friend class TiffStreamAdaptor; 
   enum ReadMethod
   {
      UNKNOWN,
      READ_RGBA_U8_TILE,
      READ_RGBA_U8_STRIP,
      READ_RGBA_U8A_STRIP,
      READ_SCAN_LINE,
      READ_TILE,
      READ_U16_STRIP
   };

   ossimTiffTileSource();

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

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

   virtual void close();
   
   virtual ossimRefPtr<ossimImageData> getTile(const  ossimIrect& rect,
                                               ossim_uint32 resLevel=0);
   
   virtual bool getTile(ossimImageData* result, ossim_uint32 resLevel=0);
   
   virtual ossim_uint32 getNumberOfInputBands() const;
   virtual ossim_uint32 getNumberOfOutputBands () const;

   virtual bool isBandSelector() const;

   virtual bool setOutputBandList(const std::vector<ossim_uint32>& band_list);

   virtual void getOutputBandList(std::vector<ossim_uint32>& bandList) const;
   
   virtual ossim_uint32 getNumberOfLines(ossim_uint32 resLevel = 0) const;
   
   virtual ossim_uint32 getNumberOfSamples(ossim_uint32 resLevel = 0) const;

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

   virtual bool isOpen()const;

   virtual ossimScalarType getOutputScalarType() const;

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

   bool hasR0() const;
  
   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;
   
   virtual bool isValidRLevel(ossim_uint32 resLevel) const;

   virtual ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;

   void setApplyColorPaletteFlag(bool flag);
   bool getApplyColorPaletteFlag()const;

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

   TIFF* tiffPtr()
   {
      return theTiffPtr;
   }
#if 0

   virtual ossimImageGeometry* getImageGeometry();
#endif   
protected:
   virtual ~ossimTiffTileSource();
   bool open();

   // Must be protected for derived ossimTerraSarTiffReader.
   TIFF* theTiffPtr; 


private:

   void adjustToStartOfTile(ossimIpt& pt) const;

   ossim_uint32 getCurrentTiffRLevel() const;
   
   ossimString getReadMethod(ossim_uint32 directory) const;
   
   bool loadTile(const ossimIrect& tile_rect,
                 const ossimIrect& clip_rect,
                 ossimImageData* result);
   
   bool loadFromRgbaU8Tile(const ossimIrect& tile_rect,
                           const ossimIrect& clip_rect,
                           ossimImageData* result);
   
   bool loadFromRgbaU8Strip(const ossimIrect& tile_rect,
                            const ossimIrect& clip_rect,
                            ossimImageData* result);
   
   bool loadFromRgbaU8aStrip(const ossimIrect& tile_rect,
                             const ossimIrect& clip_rect,
                             ossimImageData* result);

   bool loadFromU16Strip(const ossimIrect& clip_rect,
                         ossimImageData* result);
   
   bool loadFromScanLine(const ossimIrect& clip_rect,
                         ossimImageData* result);

   bool loadFromTile(const ossimIrect& clip_rect,
                     ossimImageData* result);
   
   void setReadMethod();
   
   bool setTiffDirectory(ossim_uint16 directory);

   void populateLut();

   void validateMinMaxNull();

   bool isPowerOfTwoDecimation(ossim_uint32 dir) const;

   void allocateTile();

   bool allocateBuffer();  
   
   ossimRefPtr<ossimImageData> theTile;
   
   ossim_uint8*         theBuffer;
   ossim_uint32         theBufferSize;
   ossimIrect           theBufferRect;
   ossim_uint32         theBufferRLevel;
   ossim_uint32         theCurrentTileWidth;
   ossim_uint32         theCurrentTileHeight;

   ossim_uint16         theSamplesPerPixel;
   ossim_uint16         theBitsPerSample;
   ossim_uint16         theSampleFormatUnit;

   ossim_float64        theMaxSampleValue;
   ossim_float64        theMinSampleValue;
   ossim_float64        theNullSampleValue;

   ossim_uint16         theNumberOfDirectories;
   ossim_uint16         theCurrentDirectory;
   bool                 theR0isFullRes;
   ossim_uint32         theBytesPerPixel;
   ossimScalarType      theScalarType;
   bool                 theApplyColorPaletteFlag;

   // Things we need from each directory as they can be different.
   std::vector<ossim_uint32> theImageWidth;
   std::vector<ossim_uint32> theImageLength;
   std::vector<ReadMethod>   theReadMethod;
   std::vector<ossim_uint16> thePlanarConfig;
   std::vector<ossim_uint16> thePhotometric;
   std::vector<ossim_uint32> theRowsPerStrip;
   std::vector<ossim_uint32> theImageTileWidth;
   std::vector<ossim_uint32> theImageTileLength;
   std::vector<ossim_uint32> theImageDirectoryList;
   
   ossim_uint32              theCurrentTiffRlevel;
   ossim_int32               theCompressionType;
   std::vector<ossim_uint32> theOutputBandList;
   std::shared_ptr<ossim::TiffIStreamAdaptor> m_streamAdaptor;

TYPE_DATA
};

#endif /* #ifndef ossimTiffTileSource_HEADER */