ossimPdfWriter.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  See top level LICENSE.txt file
//
// Author:  David Burken
//
// Description: OSSIM Portable Document Format (PDF) writer.
//
//----------------------------------------------------------------------------
// $Id$

#ifndef ossimPdfWriter_HEADER
#define ossimPdfWriter_HEADER 1

#include <ossim/imaging/ossimImageFileWriter.h>
#include <ossim/base/ossimConnectableObject.h>
#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/base/ossimRtti.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/imaging/ossimImageSource.h>
#include <iosfwd>
#include <mutex>

// Forward class declarations:
class ossimImageData;
class ossimIpt;
class ossimIrect;

class OSSIM_DLL ossimPdfWriter : public ossimImageFileWriter
{
public:

   enum ossimPdfImageType
   {
      UNKNOWN = 0,
      JPEG    = 1, // JPEG
      RAW     = 2  // general raster, band interleaved by pixel(BIP)
   };

   ossimPdfWriter();

   virtual ~ossimPdfWriter();

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

   virtual bool open();
   
   virtual void close();
   
   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;

   virtual bool hasImageType(const ossimString& imageType) const;

   virtual bool writeStream();

   virtual bool setOutputStream( std::ostream& stream );

private:

   virtual bool writeFile();

   void writeHeader( std::ostream* str );

   void writeCatalog( std::ostream* str,
                      std::vector<std::streamoff>& xref );
   
#if 0
   void writeOutlines( std::ostream* str,
                       std::vector<std::streamoff>& xref );
#endif

   void writePages( std::ostream* str,
                    std::vector<std::streamoff>& xref );

   void writeInfo( std::ostream* str,
                   std::vector<std::streamoff>& xref );
   
   bool writeImage( std::ostream* str );

   void writeJpegTile( std::ostream* str,
                       std::vector<std::streamoff>& xref,
                       ossimImageData* id,
                       const ossimIrect& aoi,
                       ossimIrect& outputTileRect );
   
   void writeRawTile( std::ostream* str,
                      std::vector<std::streamoff>& xref,
                      ossimImageData* id,
                      const ossimIrect& aoi,
                      ossimIrect& outputTileRect );
   
   void writeXref( std::ostream* str,
                   const std::vector<std::streamoff>& xref );

   void writeTrailer( std::ostream* str,
                      ossim_uint32 entrySize,
                      std::streamoff xrefOffset );

#if 0
   void writeDummy( std::ostream* str,
                    std::vector<std::streamoff>& xref );
#endif
   
   void setupInputChain();

   ossimPdfImageType getImageType() const;   

   void getImageType( std::string& type ) const;

   void addOption( const std::string& key, const std::string& value );

#if 0
   void getMediaBoxSize( ossim_uint32 imageWidth,
                         ossim_uint32 imageHeight,
                         ossimIpt& size ) const;
#endif

   void getLowerLeftPageOffset( const ossimIrect& aoi,
                                ossimIpt& offset ) const;

   void getLgiDict( ossimImageGeometry* geom,
                    const ossimIrect& aoi,
                    std::string& s ) const;

   void getLgiDictProjection( ossimImageGeometry* geom,
                              std::string& s ) const;

   
   void getLgiDictCtm( ossimImageGeometry* geom,
                       const ossimIrect& aoi,
                       std::string& s ) const;

   void getLgiDictDatum( ossimImageGeometry* geom,
                         std::string& s ) const;

   void getLgiDictDescription( ossimImageGeometry* geom,
                               std::string& s ) const;
   
#if 0
   void getLgiDictNeatline( ossimImageGeometry* geom,
                            std::string& s ) const;
#endif

   void getLgiDictProjectionType( ossimImageGeometry* geom,
                                  std::string& s ) const;
   
   ossim_uint32 getEpsgCode( const ossimImageGeometry* geom ) const;

#if 0
   void getNumberOfTiles( ossim_uint32 imageWidth,
                          ossim_uint32 imageHeight,
                          ossimIpt& size ) const;
#endif

   void getTitle( std::string& s ) const;
   
   void getAuthor( std::string& s ) const;

   void getSubject( std::string& s ) const;

   void getKeywords( std::string& s ) const;

   void getCreator( std::string& s ) const;
   
   void getProducer( std::string& s ) const;

   void getCreationDate( std::string& s ) const;

   void getModDate( std::string& s ) const;

   void getGmtDate( std::string& s ) const;

   void getTileSize( std::string& s ) const;

   void getTileSize( ossimIpt& tileSize ) const;
   
   std::string getTileString( ossim_uint32 x, ossim_uint32 y ) const;

   std::ostream* m_str;
   bool m_ownsStream;

   ossimRefPtr<ossimConnectableObject> m_savedInput;

   ossimRefPtr<ossimKeywordlist> m_kwl;

   std::mutex m_mutex;

TYPE_DATA
};

#endif /* #ifndef ossimPdfWriter_HEADER */