ossimGeoPdfReader.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  LGPL
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  Mingjie Su
//
// Description:  Class declaration GeoPdf reader.
//
// Specification: ISO/IEC 15444
//
//----------------------------------------------------------------------------
// $Id: ossimGeoPdfReader.h 21634 2012-09-06 18:15:26Z dburken $

#ifndef ossimGeoPdfReader_HEADER
#define ossimGeoPdfReader_HEADER 1

#include <iosfwd>
#include <fstream>
#include <vector>

//PoDoFo includes
#include <podofo/podofo.h>

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

// Forward class declarations.
class ossimImageData;
class ossimDpt;
class ossimProjection;
class PdfMemDocument;
class PdfObject;
class ossimGeoPdfVectorPageNode;

class OSSIM_PLUGINS_DLL ossimGeoPdfReader : public ossimImageHandler
{
public:

   ossimGeoPdfReader();
   
   virtual ~ossimGeoPdfReader();

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

   virtual ossimString getClassName() const;

   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 ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;

   virtual ossimScalarType getOutputScalarType() 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 ossimRefPtr<ossimImageGeometry> getImageGeometry();

   virtual ossimRefPtr<ossimImageGeometry> getInternalImageGeometry() const;

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

   virtual bool setCurrentEntry(ossim_uint32 entryIdx);

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

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

protected:

  struct ossimFrameEntryData
  {
    ossimFrameEntryData()
      :theRow(-1),
      theCol(-1),
      thePixelRow(-1),
      thePixelCol(-1)
    {}
    ossimFrameEntryData(ossim_int32 row,
      ossim_int32 col,
      ossim_int32 pixelRow,
      ossim_int32 pixelCol,
      std::vector<PoDoFo::PdfObject*> entry)
      :theRow(row),
      theCol(col),
      thePixelRow(pixelRow),
      thePixelCol(pixelCol),
      theFrameEntry(entry)
    {}
    ossimFrameEntryData(const ossimFrameEntryData& rhs)
      :theRow(rhs.theRow),
      theCol(rhs.theCol),
      thePixelRow(rhs.thePixelRow),
      thePixelCol(rhs.thePixelCol),
      theFrameEntry(rhs.theFrameEntry)
    {}
    ossim_int32 theRow;
    ossim_int32 theCol;
    ossim_int32 thePixelRow;
    ossim_int32 thePixelCol;
    std::vector<PoDoFo::PdfObject*> theFrameEntry;
  };

  std::vector<ossimFrameEntryData> getIntersectingEntries(const ossimIrect& rect);
   
private:

  ossimProjection* getGeoProjection();

  ossimProjection* getVPGeoProjection();

  ossimProjection* getLGIDictGeoProjection();

  ossimProjection* getProjectionFromStr(ossimString projContents);

  ossimDrect computeBoundingRect(ossimRefPtr<ossimImageGeometry> geoImage);

  void setPodofoInfo(PoDoFo::PdfObject* object);

  void setPodofoRefInfo(PoDoFo::PdfObject* object);

  void setPodofoArrayInfo(PoDoFo::PdfObject* object);

  void setPodofoDictInfo(PoDoFo::PdfObject* object);

  void parseTileStructure(std::vector<ossimString> tileInfo);

  void setPodofoImageInfo();

  void buildFrameEntryArray();

  void buildTileInfo(ossimString tileInfo);

  void resetCacheBuffer(ossimFrameEntryData entry);

  template <class T>
  void fillTile(T, // dummy template variable
                const ossimIrect& clip_rect, 
                ossimImageData* tile);
   
  ossimIrect                                                   m_imageRect; 
  ossim_uint32                                                 m_numberOfBands;
  ossim_uint32                                                 m_numberOfLines;
  ossim_uint32                                                 m_numberOfSamples;
  ossim_int32                                                  m_numOfFramesVertical;
  ossim_int32                                                  m_numOfFramesHorizontal;
  ossim_int32                                                  m_currentRow;
  ossim_int32                                                  m_currentCol;
  std::map<ossim_int32, ossim_int32>                           m_frameWidthVector;
  std::map<ossim_int32, ossim_int32>                           m_frameHeightVector;
  ossimScalarType                                              m_scalarType;
  ossimRefPtr<ossimImageData>                                  m_tile;
  
  std::map<ossimString, ossimString, ossimStringLtstr>         m_podofoProjInfo;

  //std::map<tileIndex, std::map<row, column> >
  std::map<ossim_int32, std::pair<ossim_int32, ossim_int32> >  m_podofoTileInfo;  
  std::map<ossim_int32, PoDoFo::PdfObject*>                    m_podofoImageObjs;
  PoDoFo::PdfMemDocument*                                      m_pdfMemDocument;
  bool                                                         m_isLGIDict;
  bool                                                         m_isJpeg;
  std::vector<ossimGeoPdfVectorPageNode*>                      m_pageVector;

  ossimRefPtr<ossimImageData>                                  m_cacheTile;
  ossimIpt                                                     m_cacheSize;
  ossimAppFixedTileCache::ossimAppFixedCacheId                 m_cacheId;
  std::vector<std::vector< std::vector<PoDoFo::PdfObject*> > > m_frameEntryArray;
TYPE_DATA
};

#endif /* #ifndef ossimGeoPdfReader_HEADER */