ossimGpkgWriter.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// File: ossimGpkgWriter.h
//
// Author:  David Burken
//
// License:  LGPL
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Description: OSSIM Geo Package writer.
//
//----------------------------------------------------------------------------
// $Id$
#ifndef ossimGpkgWriter_HEADER
#define ossimGpkgWriter_HEADER 1

#include <ossim/imaging/ossimGpkgWriterInterface.h>
#include <ossim/imaging/ossimImageFileWriter.h>
#include <ossim/base/ossimIpt.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimCodecBase.h>
#include <vector>

// Forward class declarations.
class ossimDpt;
class ossimImageData;
class ossimIrect;
struct jpeg_compress_struct;
struct sqlite3;
struct sqlite3_stmt;

class ossimGpkgWriter :
   public ossimImageFileWriter, public ossimGpkgWriterInterface
{
public:

   // Anonymous enums:
   enum
   {
      DEFAULT_JPEG_QUALITY = 75
   };
   
   enum ossimGpkgWriterMode
   {
      OSSIM_GPGK_WRITER_MODE_UNKNOWN = 0,
      OSSIM_GPGK_WRITER_MODE_JPEG    = 1,  // RGB, 8-bit, JPEG compressed
      OSSIM_GPGK_WRITER_MODE_PNG     = 2,  // PNG,
      OSSIM_GPGK_WRITER_MODE_PNGA    = 3,  // PNG with alpha
      OSSIM_GPGK_WRITER_MODE_MIXED   = 4   // full tiles=jpeg, partials=pnga
   };

   /* default constructor */
   ossimGpkgWriter();

   /* virtual destructor */
   virtual ~ossimGpkgWriter();

   virtual ossimString getShortName() const;

   virtual ossimString getLongName()  const;

   virtual ossimString getClassName()    const;

   virtual ossimString getExtension() const;

   virtual void getImageTypeList(std::vector<ossimString>& imageTypeList)const;
   
   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=0)const;
   
   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);

   virtual void setProperty(ossimRefPtr<ossimProperty> property);

   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;

   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   bool hasImageType(const ossimString& imageType) const;

   ossimString getCompressionLevel() const;

   bool setCompressionLevel(const ossimString& level);

       
   virtual bool isOpen()const;   
   
   virtual bool open();

   virtual bool openFile( const ossimKeywordlist& options );
   
   virtual void close();

   ossimGpkgWriterMode getWriterMode() const;

   std::string getWriterModeString( ossimGpkgWriterMode mode ) const;

   void setCompressionQuality( const std::string& quality );

   ossim_uint32 getCompressionQuality() const;

   virtual ossim_int32 beginTileProcessing();

   virtual bool writeTile( ossimRefPtr<ossimImageData>& tile,
                           ossim_int32 zoomLevel,
                           ossim_int64 row,
                           ossim_int64 col);

   virtual bool writeCodecTile( ossim_uint8* codecTile,
                           ossim_int32 codecTileSize,
                           ossim_int32 zoomLevel,
                           ossim_int64 row,
                           ossim_int64 col);

   virtual void finalizeTileProcessing();
   
private:

   virtual bool writeFile();

   bool writeEntry();

   bool addLevels();
   
   bool createTables( sqlite3* db );

   ossim_int32 writeGpkgSpatialRefSysTable(
      sqlite3* db, const ossimMapProjection* proj );

   bool writeGpkgContentsTable( sqlite3* db,
                                const ossimDrect& boundingRect );
   
   bool writeGpkgTileMatrixSetTable( sqlite3* db,
                                     const ossimDrect& boundingRect );

   bool writeGpkgTileMatrixTable( sqlite3* db,
                                  ossim_int32 zoom_level,
                                  const ossimIpt& matrixSize,
                                  const ossimDpt& gsd );

   
   bool writeGpkgNsgTileMatrixExtentTable( sqlite3* db,
                                           ossim_int32 zoom_level,
                                           const ossimIrect& expandedAoi,
                                           const ossimIrect& clippedAoi);

   void writeZoomLevels( sqlite3* db,
                         ossimMapProjection* proj,
                         const std::vector<ossim_int32>& zoomLevels );

   void writeTiles( sqlite3* db,
                    const ossimIrect& aoi,
                    ossim_int32 zoomLevel,
                    const ossim_float64& totalTiles,
                    ossim_float64& tilesWritten );  

   void writeTile( sqlite3_stmt* pStmt,
                   sqlite3* db,
                   ossimRefPtr<ossimImageData>& tile,
                   ossim_int32 zoomLevel,
                   ossim_int64 row,
                   ossim_int64 col);
   void writeCodecTile( sqlite3_stmt* pStmt,
                   sqlite3* db,
                   ossim_uint8* codecTile,
                   ossim_int32 codecTileSize,
                   ossim_int32 zoomLevel,
                   ossim_int64 row,
                   ossim_int64 col);
   
/*
   void writeJpegTiles( sqlite3* db,
                        const ossimIrect& aoi,
                        ossim_int32 zoomLevel,
                        ossim_uint32 quality,
                        const ossim_float64& totalTiles,
                        ossim_float64& tilesWritten );  

   void writeJpegTile( sqlite3_stmt* pStmt,
                       sqlite3* db,
                       const ossimRefPtr<ossimImageData>& tile,
                       ossim_int32 zoomLevel,
                       ossim_uint32 row,
                       ossim_uint32 col,
                       ossim_uint32 quality );
*/
   void getGsd( const ossimDpt& fullResGsd,
                ossim_int32 fullResZoomLevel,
                ossim_int32 currentZoomLevel,
                ossimDpt& gsd );

   void getGsd( const ossimMapProjection* proj,
                ossimDpt& gsd ) const;

   void getGsd( const ossimImageGeometry* geom,
                ossimDpt& gsd ) const;

   void getGsd( const ossimMapProjection* proj,
                ossim_int32 zoomLevel,
                ossimDpt& gsd ) const;

   bool alignToGrid() const;

   bool append() const;

   bool addLevels() const;

   bool addEntry() const;

   ossimRefPtr<ossimMapProjection> getNewOutputProjection(
      ossimImageGeometry* geom ) const;

   ossimRefPtr<ossimMapProjection> getNewOutputProjection() const;

   ossimRefPtr<ossimMapProjection> getNewGeographicProjection() const;
   
   ossimRefPtr<ossimMapProjection> getNewWorldMercatorProjection() const;

   // Propagates view to all resamplers.
   void setView( ossimMapProjection* proj );

   void reInitializeCombiners();

   void reInitializeCutters( const ossimMapProjection* proj );
   
   bool keyIsTrue( const std::string& key ) const;

   void getTileSize( ossimIpt& tileSize ) const;

   ossim_uint64 getBatchSize() const;

   ossim_int32 getNumberOfZoomLevels( const ossimIrect& aoi ) const;

   void getZoomLevels( std::vector<ossim_int32>& zoomLevels ) const;
   

   void getZoomLevels( const ossimMapProjection* proj,
                       const ossimIrect& aoi,
                       const ossimDpt& sourceGsd,
                       std::vector<ossim_int32>& zoomLevels,
                       ossimDpt& fullResGsd ) const;

   void getAoiFromRect( const ossimMapProjection* proj,
                        const ossimDrect& rect,
                        ossimIrect& aoi );
   
   void getExpandedAoi( const ossimIrect& aoi, ossimIrect& expandedAoi ) const;
   
   void getMatrixSize( const ossimIrect& rect,
                       ossimIpt& matrixSize ) const;

   void setProjectionTie( ossimMapProjection* proj ) const;

   bool requiresEightBit() const;

   ossim_uint32 getEpsgCode() const;

   void getProjectionDimensionsInMeters(
      const ossimMapProjection* proj, ossimDpt& dims ) const;

#if 0
   void clipToProjectionBounds(
      const ossimMapProjection* proj,
      const ossimGpt& inUlGpt, const ossimGpt& inLrGpt,
      ossimGpt& outUlGpt, ossimGpt& outLrGpt ) const;
#endif

   void initializeProjectionRect( const ossimMapProjection* productProj );

   void initializeRect( const ossimMapProjection* proj,
                        const ossimIrect& aoi,
                        ossimDrect& rect );

   void getTileTableName( std::string& tileTableName ) const;

   bool getFilename( ossimFilename& file ) const;

   void initializeCodec();

   bool initializeGpkg();

   bool getWmsCutBox( ossimDrect& rect ) const;

   bool getClipExtents( ossimDrect& rect, bool& alignToGridFlag ) const;
  

   bool getRect( const std::string& key, ossimDrect& rect ) const;

   void checkLevels( const std::vector<ossim_int32>& currentZoomLevels,
                     const std::vector<ossim_int32>& newZoomLevels ) const;

   bool isValidZoomLevelRowCol( ossim_int32 level,
                                ossim_int32 row,
                                ossim_int32 col  ) const;

   void applyScaleToProjection( ossimMapProjection* proj,
                                const ossimDpt& desiredGsd ) const;

   sqlite3* m_db;

   ossim_uint64 m_batchCount;

   ossim_uint64 m_batchSize;   

   ossimDrect m_projectionBoundingRect;

   ossimDrect m_sceneBoundingRect;

   ossimDrect m_clipRect; 

   ossimDrect m_outputRect;

   ossimIpt m_tileSize;

   std::string m_tileTableName;

   ossim_int32 m_srs_id;

   ossimRefPtr<ossimKeywordlist> m_kwl;

   ossimRefPtr<ossimCodecBase> m_fullTileCodec;
   ossimRefPtr<ossimCodecBase> m_partialTileCodec;

   bool m_fullTileCodecAlpha;
   bool m_partialTileCodecAlpha;

   std::vector<ossim_int32> m_zoomLevels;

   std::vector<ossimIpt> m_zoomLevelMatrixSizes;

   sqlite3_stmt* m_pStmt;

   bool m_writeBlanks;

   TYPE_DATA
};

#endif /* #ifndef ossimGpkgWriter_HEADER */