ossimPngWriter.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  See top level LICENSE.txt file
//
// Author:  David Burken
//
// Description: OSSIM Portable Network Graphics (PNG) writer.
//
//----------------------------------------------------------------------------
// $Id: ossimPngWriter.h 19878 2011-07-28 16:27:26Z dburken $
#ifndef ossimPngWriter_HEADER
#define ossimPngWriter_HEADER


#include <ossim/base/ossimRtti.h>
#include <ossim/imaging/ossimImageFileWriter.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/base/ossimNBandLutDataObject.h>
#include <ossim/base/ossimRefPtr.h>
#include <png.h>
#include <ostream>

class ossimPngWriter : public ossimImageFileWriter
{
public:

   /* default constructor */
   ossimPngWriter();

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

   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;

   bool hasImageType(const ossimString& imageType) const;

   void setLut(const ossimNBandLutDataObject& lut);

   ossimString getCompressionLevel() const;

   bool setCompressionLevel(const ossimString& level);

   bool getAlphaChannelFlag( void ) const;

   void setAlphaChannelFlag( bool flag );

   virtual bool writeStream();

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

private:

   virtual bool writeFile();

   static void pngWriteData(png_structp png_ptr, png_bytep data,
                            png_size_t length);

   static void pngFlush(png_structp png_ptr);

   bool doSwap(ossimScalarType outputScalar) const;

   bool isLutEnabled()const;

   void writeOptionalChunks(png_structp pp, png_infop info);
   
   //---
   // Chunck writers.  In place but not implemnted yet.
   //---

   void writeTransparentColorChunk(png_structp pp, png_infop info);

   void writeGammaChunk(png_structp pp, png_infop info);

   void writeBackgroundColorChunk(png_structp pp, png_infop info);
   
   void writeTimeStampChunk(png_structp pp, png_infop info);
   
   void writeLatinTextChunk(png_structp pp, png_infop info);
   
   void writeInternationalTextChunk(png_structp pp, png_infop info);
   
   void writeHistogram(png_structp pp, png_infop info);
   
   void writeSuggestedPalette(png_structp pp, png_infop info);

   void writeSignificantBits(png_structp pp, png_infop info);
   
   void writePhysicalPixelDimensions(png_structp pp, png_infop info);
   
   void writePhysicalScale(png_structp pp, png_infop info);
   
   void writeImageOffset(png_structp pp, png_infop info);
   
   void writePixelCalibration(png_structp pp, png_infop info);
   
   void writeFractalParameters(png_structp pp, png_infop info);

   ossim_int32 getColorType(ossim_int32 bands) const;
   
   ossim_int32 getBitDepth(ossimScalarType outputScalar) const;
   
   std::ostream* theOutputStream;
   bool          theOwnsStreamFlag;

   ossim_int32       theCompressionLevel;

   ossim_int32 theInterlaceSupport;

   ossim_int32 theCompressionStratagy;

   ossim_int32 thePngFilter;

   bool                                 theGammaFlag;
   ossim_float64                        theGamma;

   bool                                 theTimeFlag;

   bool                                 theAlphaChannelFlag;

   bool                                 theBackgroundFlag;
   ossim_uint16                         theBackgroundRed;
   ossim_uint16                         theBackgroundGreen;
   ossim_uint16                         theBackgroundBlue;
   ossim_uint16                         theBackgroundGray;

   bool                                 theTransparentFlag;
   ossim_uint16                         theTransparentRed;
   ossim_uint16                         theTransparentGreen;
   ossim_uint16                         theTransparentBlue;
   ossim_uint16                         theTransparentGray;

   TYPE_DATA

};

#endif /* #ifndef ossimPngVoid Writer_HEADER */