root/OpenSceneGraph/trunk/src/osgPlugins/png/ReaderWriterPNG.cpp @ 10763

Revision 10763, 13.6 kB (checked in by robert, 5 years ago)

Added OSG_CPP_EXCEPTIONS_AVAILABLE cmake option to enable optional build of plugins and examples that required C++ exceptions

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
RevLine 
[2]1#include <osg/Image>
[2397]2#include <osg/Notify>
[2]3#include <osg/Geode>
[1257]4#include <osg/GL>
[2397]5#include <osg/Endian>
[2]6
[1257]7#include <osgDB/Registry>
[2501]8#include <osgDB/FileUtils>
[1257]9#include <osgDB/FileNameUtils>
[8]10
[5029]11#include <sstream>
12
[2]13using namespace osg;
14
[8]15extern "C"
16{
[2031]17    #include <zlib.h>
[8]18    #include <png.h>
[2]19}
20
[8]21
[2]22/* Transparency parameters */
[8]23#define PNG_ALPHA     -2         /* Use alpha channel in PNG file, if there is one */
24#define PNG_SOLID     -1         /* No transparency                                */
25#define PNG_STENCIL    0         /* Sets alpha to 0 for r=g=b=0, 1 otherwise       */
[2]26
[8]27typedef struct
28{
29    unsigned int Width;
30    unsigned int Height;
31    unsigned int Depth;
32    unsigned int Alpha;
[2]33} pngInfo;
34
[8378]35class PNGError
36{
37public:
38    PNGError(const char* message)
39    {
40        _message = "PNG lib error : ";
41        _message += message;
42    }
43    friend std::ostream& operator<<(std::ostream& stream, const PNGError& err)
44    {
45        stream << err._message;
46        return stream;
47    }
48private:
49    std::string _message;
50};
51
52void user_error_fn(png_structp png_ptr, png_const_charp error_msg)
53{
[10763]54#ifdef OSG_CPP_EXCEPTIONS_AVAILABLE
[8378]55    throw PNGError(error_msg);
[10763]56#else
57    osg::notify(osg::WARN) << "PNG lib warning : " << error_msg << std::endl;
58#endif
[8378]59}
60
61void user_warning_fn(png_structp png_ptr, png_const_charp warning_msg)
62{
63    osg::notify(osg::WARN) << "PNG lib warning : " << warning_msg << std::endl;
64}
65
[4455]66void png_read_istream(png_structp png_ptr, png_bytep data, png_size_t length)
67{
68    std::istream *stream = (std::istream*)png_get_io_ptr(png_ptr); //Get pointer to istream
69    stream->read((char*)data,length); //Read requested amount of data
70}
71
[5025]72void png_write_ostream(png_structp png_ptr, png_bytep data, png_size_t length)
73{
74    std::ostream *stream = (std::ostream*)png_get_io_ptr(png_ptr); //Get pointer to ostream
75    stream->write((char*)data,length); //Write requested amount of data
76}
77
78void png_flush_ostream(png_structp png_ptr)
79{
80    std::ostream *stream = (std::ostream*)png_get_io_ptr(png_ptr); //Get pointer to ostream
81    stream->flush();
82}
83
[8]84class ReaderWriterPNG : public osgDB::ReaderWriter
[2]85{
86    public:
[8578]87        ReaderWriterPNG()
88        {
89            supportsExtension("png","PNG Image format");
90        }
91       
[3539]92        virtual const char* className() const { return "PNG Image Reader/Writer"; }
[2]93
[5029]94        WriteResult::WriteStatus writePngStream(std::ostream& fout, const osg::Image& img, int compression_level) const
[5025]95        {
96            png_structp png = NULL;
97            png_infop   info = NULL;
98            int color;
99            png_bytep *rows = NULL;
100
101            //Create write structure
102            png = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
103            if(!png) return WriteResult::ERROR_IN_WRITING_FILE;
104
105            //Create infr structure
106            info = png_create_info_struct(png);
107            if(!info) return WriteResult::ERROR_IN_WRITING_FILE;
108
109            //Set custom write function so it will write to ostream
110            png_set_write_fn(png,&fout,png_write_ostream,png_flush_ostream);
111
[5029]112            //Set compression level
113            png_set_compression_level(png, compression_level);
114
[5025]115            switch(img.getPixelFormat()) {
116                case(GL_LUMINANCE): color = PNG_COLOR_TYPE_GRAY; break;
117                case(GL_ALPHA): color = PNG_COLOR_TYPE_GRAY; break; //Couldn't find a color type for pure alpha, using gray instead
118                case(GL_LUMINANCE_ALPHA): color = PNG_COLOR_TYPE_GRAY_ALPHA ; break;
119                case(GL_RGB): color = PNG_COLOR_TYPE_RGB; break;
120                case(GL_RGBA): color = PNG_COLOR_TYPE_RGB_ALPHA; break;
121                default: return WriteResult::ERROR_IN_WRITING_FILE; break;               
122            }
123
124            //Create row data
125            rows = new png_bytep[img.t()];
126            for(int i = 0; i < img.t(); ++i) {
127                rows[i] = (png_bytep)img.data(0,img.t() - i - 1);
128            }
129
130            //Write header info
131            png_set_IHDR(png, info, img.s(), img.t(),
132                        8, color, PNG_INTERLACE_NONE,
133                        PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
134
135            png_write_info(png, info);
136
137            //Write data
138            png_write_image(png, rows);
139
140            //End write
141            png_write_end(png, NULL);
142
143            //Cleanup
144            png_destroy_write_struct(&png,&info);
145            delete [] rows;
146
147            return WriteResult::FILE_SAVED;
148        }
149
[4455]150        ReadResult readPNGStream(std::istream& fin) const
[2]151        {
[8]152            int trans = PNG_ALPHA;
153            pngInfo pInfo;
154            pngInfo *pinfo = &pInfo;
[2]155
[8]156            unsigned char header[8];
157            png_structp png;
158            png_infop   info;
159            png_infop   endinfo;
160            png_bytep   data;    //, data2;
161            png_bytep  *row_p;
162            double  fileGamma;
[2]163
[8]164            png_uint_32 width, height;
165            int depth, color;
[2]166
[8]167            png_uint_32 i;
168            png = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
[8378]169 
170            // Set custom error handlers
171            png_set_error_fn(png, png_get_error_ptr(png), user_error_fn, user_warning_fn);
[2]172
[10763]173            #ifdef OSG_CPP_EXCEPTIONS_AVAILABLE
[8378]174            try
[10763]175            #endif
[8]176            {
[8378]177                info = png_create_info_struct(png);
178                endinfo = png_create_info_struct(png);
[2]179
[8378]180                fin.read((char*)header,8);
181                if (fin.gcount() == 8 && png_check_sig(header, 8))
182                    png_set_read_fn(png,&fin,png_read_istream); //Use custom read function that will get data from istream
183                else
184                {
185                    png_destroy_read_struct(&png, &info, &endinfo);
186                    return ReadResult::FILE_NOT_HANDLED;
187                }
188                png_set_sig_bytes(png, 8);
[2]189
[8378]190                png_read_info(png, info);
191                png_get_IHDR(png, info, &width, &height, &depth, &color, NULL, NULL, NULL);
[2397]192
[8378]193                if (pinfo != NULL)
194                {
195                    pinfo->Width  = width;
196                    pinfo->Height = height;
197                    pinfo->Depth  = depth;
198                }
[2397]199
[8378]200                osg::notify(osg::INFO)<<"width="<<width<<" height="<<height<<" depth="<<depth<<std::endl;
201                if ( color == PNG_COLOR_TYPE_RGB) osg::notify(osg::INFO) << "color == PNG_COLOR_TYPE_RGB "<<std::endl;
202                if ( color == PNG_COLOR_TYPE_GRAY) osg::notify(osg::INFO) << "color == PNG_COLOR_TYPE_GRAY "<<std::endl;
203                if ( color == PNG_COLOR_TYPE_GRAY_ALPHA) osg::notify(osg::INFO) << "color ==  PNG_COLOR_TYPE_GRAY_ALPHA"<<std::endl;
[2397]204
[8378]205                // png default to big endian, so we'll need to swap bytes if on a little endian machine.
206                if (depth>8 && getCpuByteOrder()==osg::LittleEndian)
207                    png_set_swap(png);
[2]208
209
[8378]210                if (color == PNG_COLOR_TYPE_GRAY || color == PNG_COLOR_TYPE_GRAY_ALPHA)
211                {
212                    //png_set_gray_to_rgb(png);
213                }
[2397]214
[8378]215                if (color&PNG_COLOR_MASK_ALPHA && trans != PNG_ALPHA)
216                {
217                    png_set_strip_alpha(png);
218                    color &= ~PNG_COLOR_MASK_ALPHA;
219                }
[2397]220
[2987]221
[2]222
[8378]223                //    if (!(PalettedTextures && mipmap >= 0 && trans == PNG_SOLID))
224                //if (color == PNG_COLOR_TYPE_PALETTE)
225                //    png_set_expand(png);
[2987]226
[8378]227                // In addition to expanding the palette, we also need to check
228                // to expand greyscale and alpha images.  See libpng man page.
229                if (color == PNG_COLOR_TYPE_PALETTE)
230                    png_set_palette_to_rgb(png);
231                if (color == PNG_COLOR_TYPE_GRAY && depth < 8)
232                    png_set_gray_1_2_4_to_8(png);
233                if (png_get_valid(png, info, PNG_INFO_tRNS))
234                    png_set_tRNS_to_alpha(png);
[2987]235
[8378]236                // Make sure that files of small depth are packed properly.
237                if (depth < 8)
238                    png_set_packing(png);
[2]239
240
[8378]241                /*--GAMMA--*/
242                //    checkForGammaEnv();
243                double screenGamma = 2.2 / 1.0;
244                if (png_get_gAMA(png, info, &fileGamma))
245                    png_set_gamma(png, screenGamma, fileGamma);
[8]246                else
[8378]247                    png_set_gamma(png, screenGamma, 1.0/2.2);
[2]248
[8378]249                png_read_update_info(png, info);
[2]250
[8378]251                data = (png_bytep) new unsigned char [png_get_rowbytes(png, info)*height];
252                row_p = new png_bytep [height];
[2987]253
[8378]254                bool StandardOrientation = true;
255                for (i = 0; i < height; i++)
256                {
257                    if (StandardOrientation)
258                        row_p[height - 1 - i] = &data[png_get_rowbytes(png, info)*i];
259                    else
260                        row_p[i] = &data[png_get_rowbytes(png, info)*i];
261                }
[2987]262
[8378]263                png_read_image(png, row_p);
264                delete [] row_p;
265                png_read_end(png, endinfo);
[2]266
[8378]267                GLenum pixelFormat = 0;
268                GLenum dataType = depth<=8?GL_UNSIGNED_BYTE:GL_UNSIGNED_SHORT;
269                switch(color)
270                {
271                  case(PNG_SOLID): pixelFormat = GL_LUMINANCE; break;
272                  case(PNG_ALPHA): pixelFormat = GL_ALPHA; break;
273                  case(PNG_COLOR_TYPE_GRAY): pixelFormat =GL_LUMINANCE ; break;
274                  case(PNG_COLOR_TYPE_GRAY_ALPHA): pixelFormat = GL_LUMINANCE_ALPHA; break;
275                  case(PNG_COLOR_TYPE_RGB): pixelFormat = GL_RGB; break;
276                  case(PNG_COLOR_TYPE_PALETTE): pixelFormat = GL_RGB; break;
277                  case(PNG_COLOR_TYPE_RGB_ALPHA): pixelFormat = GL_RGBA; break;
278                  default: break;               
279                }
[2]280
[8378]281                // Some paletted images contain alpha information.  To be
282                // able to give that back to the calling program, we need to
283                // check the number of channels in the image.  However, the
284                // call might not return correct information unless
285                // png_read_end is called first.  See libpng man page.
286                if (pixelFormat == GL_RGB && png_get_channels(png, info) == 4)
287                    pixelFormat = GL_RGBA;
[2]288
[8378]289                int internalFormat = pixelFormat;
[576]290
[8378]291                png_destroy_read_struct(&png, &info, &endinfo);
[2]292
[8378]293                //    delete [] data;
[2397]294
[8378]295                if (pixelFormat==0)
296                    return ReadResult::FILE_NOT_HANDLED;
297
298                osg::Image* pOsgImage = new osg::Image();
299
300                pOsgImage->setImage(width, height, 1,
301                    internalFormat,
302                    pixelFormat,
303                    dataType,
304                    data,
305                    osg::Image::USE_NEW_DELETE);
306
307                return pOsgImage;
[10763]308
[8378]309            }
[10763]310            #ifdef OSG_CPP_EXCEPTIONS_AVAILABLE
[8378]311            catch (PNGError& err)
312            {
313                osg::notify(osg::WARN) << err << std::endl;
314                png_destroy_read_struct(&png, &info, &endinfo);
315                return ReadResult::ERROR_IN_READING_FILE;
316            }
[10763]317            #endif
[2]318        }
[4455]319
[5029]320        int getCompressionLevel(const osgDB::ReaderWriter::Options *options) const
321        {
322            if(options) {
323                std::istringstream iss(options->getOptionString());
324                std::string opt;
325                while (iss >> opt) {
326                    if(opt=="PNG_COMPRESSION") {
327                        int level;
328                        iss >> level;
329                        return level;
330                    }
331                }
332            }
333
334            return Z_DEFAULT_COMPRESSION;
335        }
336
[7878]337        virtual ReadResult readObject(std::istream& fin,const osgDB::ReaderWriter::Options* options =NULL) const
338        {
339            return readImage(fin, options);
340        }
341
342        virtual ReadResult readObject(const std::string& file, const osgDB::ReaderWriter::Options* options =NULL) const
343        {
344            return readImage(file, options);
345        }
346
[4455]347        virtual ReadResult readImage(std::istream& fin,const Options* =NULL) const
348        {
349            return readPNGStream(fin);
350        }
351
352        virtual ReadResult readImage(const std::string& file, const osgDB::ReaderWriter::Options* options) const
353        {
354            std::string ext = osgDB::getLowerCaseFileExtension(file);
355            if (!acceptsExtension(ext)) return ReadResult::FILE_NOT_HANDLED;
356
357            std::string fileName = osgDB::findDataFile( file, options );
358            if (fileName.empty()) return ReadResult::FILE_NOT_FOUND;
359
360            std::ifstream istream(fileName.c_str(), std::ios::in | std::ios::binary);
361            if(!istream) return ReadResult::FILE_NOT_HANDLED;
362            ReadResult rr = readPNGStream(istream);
363            if(rr.validImage()) rr.getImage()->setFileName(file);
364            return rr;
365        }
[5025]366
367        virtual WriteResult writeImage(const osg::Image& img,std::ostream& fout,const osgDB::ReaderWriter::Options *options) const
368        {
[5029]369            WriteResult::WriteStatus ws = writePngStream(fout,img,getCompressionLevel(options));
[5025]370            return ws;
371        }
372
373        virtual WriteResult writeImage(const osg::Image &img,const std::string& fileName, const osgDB::ReaderWriter::Options *options) const
374        {
375            std::string ext = osgDB::getFileExtension(fileName);
376            if (!acceptsExtension(ext)) return WriteResult::FILE_NOT_HANDLED;
377
378            std::ofstream fout(fileName.c_str(), std::ios::out | std::ios::binary);
379            if(!fout) return WriteResult::ERROR_IN_WRITING_FILE;
380
381            return writeImage(img,fout,options);
382        }
[2]383};
384
385// now register with Registry to instantiate the above
386// reader/writer.
[7076]387REGISTER_OSGPLUGIN(png, ReaderWriterPNG)
Note: See TracBrowser for help on using the browser.