Source/System/Image/FileIO/OSGPNGImageFileType.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGPNGIMAGEFILETYPE_H_
  40 #define _OSGPNGIMAGEFILETYPE_H_
  41
  42 #ifdef  __sgi
  43 #pragma  once
  44 #endif
  45
  46 #include "OSGImageFileIODef.h"
  47 #include "OSGImageFileType.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief PNG File Handler.
  52     See \ref PageSystemImage for a detailed description.
  53
  54     \ingroup GrpImageFileIOPNG
  55     \ingroup GrpLibOSGImageFileIO
  56  */
  57
  58 class OSG_IMGFILEIO_DLLMAPPING PNGImageFileType : public ImageFileType
  59 {
  60
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     /*---------------------------------------------------------------------*/
  66     /*! \name                   Destructor                                 */
  67     /*! \{                                                                 */
  68
  69     virtual ~PNGImageFileType (void);
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                   Read/Write                                 */
  74     /*! \{                                                                 */
  75
  76     virtual bool read (      Image            *pImage,
  77                              std::istream     &is,
  78                        const std::string      &mimetype);
  79
  80     virtual bool write(const Image            *pImage,
  81                              std::ostream     &os,
  82                        const std::string      &mimetype);
  83
  84     /*! \}                                                                 */
  85     /*---------------------------------------------------------------------*/
  86     /*! \name                   Read/Write                                 */
  87     /*! \{                                                                 */
  88
  89     virtual std::string determineMimetypeFromStream(std::istream &is);
  90
  91     /*! \}                                                                 */
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                   Read/Write                                 */
  94     /*! \{                                                                 */
  95
  96     virtual bool validateHeader(const Char8    *fileName,
  97                                       bool     &implemented);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                     Buffer                                   */
 102     /*! \{                                                                 */
 103
 104     virtual UInt64 restoreData(      Image            *pImage,
 105                                const UChar8           *buffer,
 106                                      Int32             memSize = -1) const;
 107
 108     virtual UInt64 storeData  (const Image            *pImage,
 109                                      UChar8           *buffer,
 110                                      Int32             memSize = -1) const;
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                     Buffer                                   */
 115     /*! \{                                                                 */
 116
 117     static const PNGImageFileType &the(void);
 118
 119     /*! \}                                                                 */
 120     /*=========================  PROTECTED  ===============================*/
 121
 122   protected:
 123
 124     /*---------------------------------------------------------------------*/
 125     /*! \name               Default Constructor                            */
 126     /*! \{                                                                 */
 127
 128     PNGImageFileType(const Char8  *mimeType,
 129                      const Char8  *suffixArray[],
 130                            UInt16  suffixByteCount,
 131                            UInt32  flags          );
 132
 133     /*! \}                                                                 */
 134     /*---------------------------------------------------------------------*/
 135     /*! \name                         Copy Op                              */
 136     /*! \{                                                                 */
 137
 138           PNGImageFileType            (const PNGImageFileType &obj);
 139     const PNGImageFileType &operator =(const PNGImageFileType &obj);
 140
 141     /*! \}                                                                 */
 142     /*===========================  PRIVATE  ===============================*/
 143
 144   private:
 145
 146     typedef ImageFileType Inherited;
 147
 148     static PNGImageFileType _the;
 149
 150 };
 151
 152 typedef PNGImageFileType *PNGImageFileTypeP;
 153
 154 OSG_END_NAMESPACE
 155
 156 #endif // _OSGPNGIMAGEFILETYPE_H_