gosu 0.7.10.3 → 0.7.11
Sign up to get free protection for your applications and to get access to all the features.
- data/Gosu/AutoLink.hpp +0 -0
- data/Gosu/ButtonsMac.hpp +26 -0
- data/Gosu/ButtonsWin.hpp +26 -0
- data/Gosu/ButtonsX.hpp +26 -0
- data/Gosu/Gosu.hpp +1 -0
- data/Gosu/Graphics.hpp +1 -1
- data/Gosu/Input.hpp +4 -5
- data/Gosu/Math.hpp +11 -0
- data/Gosu/Text.hpp +59 -47
- data/Gosu/Utility.hpp +6 -5
- data/GosuImpl/Graphics/DrawOp.hpp +0 -0
- data/GosuImpl/Graphics/Font.cpp +45 -4
- data/GosuImpl/Graphics/Graphics.cpp +25 -0
- data/GosuImpl/Graphics/TexChunk.cpp +0 -0
- data/GosuImpl/Graphics/TexChunk.hpp +0 -0
- data/GosuImpl/Graphics/Text.cpp +26 -2
- data/GosuImpl/Graphics/TextMac.cpp +8 -2
- data/GosuImpl/Graphics/TextPangoFT.cpp +0 -0
- data/GosuImpl/Graphics/Texture.cpp +0 -0
- data/GosuImpl/Graphics/Texture.hpp +0 -0
- data/GosuImpl/Iconv.hpp +62 -0
- data/GosuImpl/InputMac.mm +3 -0
- data/GosuImpl/InputWin.cpp +5 -1
- data/GosuImpl/InputX.cpp +50 -8
- data/GosuImpl/Math.cpp +1 -1
- data/GosuImpl/RubyGosu.swg +24 -5
- data/GosuImpl/RubyGosu_wrap.cxx +181 -10
- data/GosuImpl/Utility.cpp +32 -75
- data/GosuImpl/Utility.cpp~RF6c566.TMP +95 -0
- data/GosuImpl/WindowX.cpp +2 -2
- data/Rakefile +57 -10
- data/examples/Tutorial.cpp +0 -0
- data/examples/media/Beep.wav +0 -0
- data/examples/media/CptnRuby Map.txt b/data/examples/media/CptnRuby → Map.txt +0 -0
- data/examples/media/Explosion.wav +0 -0
- data/examples/media/Space.png +0 -0
- data/examples/media/Star.png +0 -0
- data/examples/media/Starfighter.bmp +0 -0
- data/linux/Makefile.in +0 -0
- data/linux/configure +0 -0
- data/linux/configure.ac +0 -0
- data/mac/Gosu.xcodeproj/jlnr.mode1v3 +1421 -0
- data/mac/Gosu.xcodeproj/jlnr.mode2v3 +1464 -0
- data/mac/Gosu.xcodeproj/jlnr.pbxuser +733 -0
- data/mac/Gosu.xcodeproj/project.pbxproj +4 -2
- data/reference/Async_8hpp-source.html +1 -1
- data/reference/Audio_8hpp-source.html +1 -1
- data/reference/Audio_8hpp.html +1 -1
- data/reference/AutoLink_8hpp-source.html +1 -1
- data/reference/AutoLink_8hpp.html +1 -1
- data/reference/Bitmap_8hpp-source.html +1 -1
- data/reference/Bitmap_8hpp.html +1 -1
- data/reference/ButtonsMac_8hpp-source.html +107 -81
- data/reference/ButtonsWin_8hpp-source.html +84 -58
- data/reference/ButtonsX_8hpp-source.html +131 -105
- data/reference/Color_8hpp-source.html +1 -1
- data/reference/Color_8hpp.html +1 -1
- data/reference/Directories_8hpp-source.html +1 -1
- data/reference/Directories_8hpp.html +1 -1
- data/reference/Font_8hpp-source.html +1 -1
- data/reference/Font_8hpp.html +1 -1
- data/reference/Fwd_8hpp-source.html +1 -1
- data/reference/Fwd_8hpp.html +1 -1
- data/reference/Gosu_8hpp-source.html +5 -4
- data/reference/Gosu_8hpp.html +1 -1
- data/reference/GraphicsBase_8hpp-source.html +1 -1
- data/reference/GraphicsBase_8hpp.html +1 -1
- data/reference/Graphics_8hpp-source.html +2 -2
- data/reference/Graphics_8hpp.html +1 -1
- data/reference/IO_8hpp-source.html +1 -1
- data/reference/IO_8hpp.html +1 -1
- data/reference/ImageData_8hpp-source.html +1 -1
- data/reference/ImageData_8hpp.html +1 -1
- data/reference/Image_8hpp-source.html +1 -1
- data/reference/Image_8hpp.html +1 -1
- data/reference/Input_8hpp-source.html +43 -43
- data/reference/Input_8hpp.html +2 -2
- data/reference/Math_8hpp-source.html +51 -42
- data/reference/Math_8hpp.html +5 -1
- data/reference/Platform_8hpp-source.html +1 -1
- data/reference/Platform_8hpp.html +1 -1
- data/reference/RotFlip_8hpp-source.html +1 -1
- data/reference/RotFlip_8hpp.html +1 -1
- data/reference/Sockets_8hpp-source.html +1 -1
- data/reference/Sockets_8hpp.html +1 -1
- data/reference/TextInput_8hpp-source.html +1 -1
- data/reference/TextInput_8hpp.html +1 -1
- data/reference/Text_8hpp-source.html +12 -8
- data/reference/Text_8hpp.html +3 -1
- data/reference/Timing_8hpp-source.html +1 -1
- data/reference/Timing_8hpp.html +1 -1
- data/reference/Utility_8hpp-source.html +9 -10
- data/reference/Utility_8hpp.html +5 -7
- data/reference/WinUtility_8hpp-source.html +1 -1
- data/reference/WinUtility_8hpp.html +1 -1
- data/reference/Window_8hpp-source.html +3 -3
- data/reference/Window_8hpp.html +1 -1
- data/reference/annotated.html +2 -2
- data/reference/classGosu_1_1Audio-members.html +1 -1
- data/reference/classGosu_1_1Audio.html +1 -1
- data/reference/classGosu_1_1Bitmap-members.html +1 -1
- data/reference/classGosu_1_1Bitmap.html +1 -1
- data/reference/classGosu_1_1Buffer-members.html +1 -1
- data/reference/classGosu_1_1Buffer.html +1 -1
- data/reference/classGosu_1_1Button-members.html +1 -1
- data/reference/classGosu_1_1Button.html +1 -1
- data/reference/classGosu_1_1Color-members.html +1 -1
- data/reference/classGosu_1_1Color.html +1 -1
- data/reference/classGosu_1_1File-members.html +1 -1
- data/reference/classGosu_1_1File.html +1 -1
- data/reference/classGosu_1_1Font-members.html +1 -1
- data/reference/classGosu_1_1Font.html +1 -1
- data/reference/classGosu_1_1Graphics-members.html +1 -1
- data/reference/classGosu_1_1Graphics.html +1 -1
- data/reference/classGosu_1_1Image-members.html +1 -1
- data/reference/classGosu_1_1Image.html +1 -1
- data/reference/classGosu_1_1ImageData-members.html +1 -1
- data/reference/classGosu_1_1ImageData.html +1 -1
- data/reference/classGosu_1_1Input-members.html +1 -1
- data/reference/classGosu_1_1Input.html +4 -4
- data/reference/classGosu_1_1MessageSocket-members.html +1 -1
- data/reference/classGosu_1_1MessageSocket.html +1 -1
- data/reference/classGosu_1_1Resource-members.html +1 -1
- data/reference/classGosu_1_1Resource.html +1 -1
- data/reference/classGosu_1_1Sample-members.html +1 -1
- data/reference/classGosu_1_1Sample.html +1 -1
- data/reference/classGosu_1_1SampleInstance-members.html +1 -1
- data/reference/classGosu_1_1SampleInstance.html +1 -1
- data/reference/classGosu_1_1Song-members.html +1 -1
- data/reference/classGosu_1_1Song.html +1 -1
- data/reference/classGosu_1_1TextInput-members.html +1 -1
- data/reference/classGosu_1_1TextInput.html +1 -1
- data/reference/classGosu_1_1Window-members.html +1 -1
- data/reference/classGosu_1_1Window.html +1 -1
- data/reference/files.html +1 -1
- data/reference/functions.html +1 -1
- data/reference/functions_enum.html +1 -1
- data/reference/functions_func.html +1 -1
- data/reference/functions_vars.html +1 -1
- data/reference/hierarchy.html +1 -1
- data/reference/index.html +1 -1
- data/reference/namespaceGosu.html +935 -492
- data/reference/namespaceGosu_1_1Colors.html +1 -1
- data/reference/namespaceGosu_1_1Win.html +1 -1
- data/reference/namespacemembers.html +13 -2
- data/reference/namespacemembers_enum.html +1 -1
- data/reference/namespacemembers_eval.html +1 -1
- data/reference/namespacemembers_func.html +13 -2
- data/reference/namespacemembers_type.html +1 -1
- data/reference/namespacemembers_vars.html +1 -1
- data/reference/namespaces.html +1 -1
- data/windows/Gosu.vcproj +4 -4
- data/windows/RubyGosu.vcproj +2 -1
- data/windows/zlib, libpng/libpng/ANNOUNCE +61 -0
- data/windows/zlib, libpng/libpng/CHANGES +2173 -0
- data/windows/zlib, libpng/libpng/INSTALL +199 -0
- data/windows/zlib, libpng/libpng/KNOWNBUG +22 -0
- data/windows/zlib, libpng/libpng/LICENSE +109 -0
- data/windows/zlib, libpng/libpng/README +264 -0
- data/windows/zlib, libpng/libpng/TODO +24 -0
- data/windows/zlib, libpng/libpng/Y2KINFO +55 -0
- data/windows/zlib, libpng/libpng/configure +13 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/COPYING +340 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/LICENSE +50 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/Makefile.mingw32 +130 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/Makefile.sgi +104 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/Makefile.unx +132 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/Makefile.w32 +113 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/README +186 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/makevms.com +132 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/readpng.c +304 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/readpng.h +88 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/readpng2.c +645 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/readpng2.h +121 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/readppm.c +179 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/rpng-win.c +684 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/rpng-x.c +904 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/rpng2-win.c +1225 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/rpng2-x.c +2127 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/toucan.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/wpng.c +853 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/writepng.c +392 -0
- data/windows/zlib, libpng/libpng/contrib/gregbook/writepng.h +133 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/decoder/README +6 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/decoder/gather.sh +8 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/decoder/makefile.std +44 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/decoder/pngusr.h +67 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/encoder/README +6 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/encoder/dummy_inflate.c +27 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/encoder/gather.sh +9 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/encoder/makefile.std +43 -0
- data/windows/zlib, libpng/libpng/contrib/pngminim/encoder/pngusr.h +66 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/README +153 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/makefile.std +65 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/makefile.tc3 +38 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/makevms.com +92 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/png2pnm.bat +41 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/png2pnm.c +430 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/png2pnm.sh +42 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/pngminus.bat +4 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/pngminus.sh +5 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/pnm2png.bat +41 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/pnm2png.c +533 -0
- data/windows/zlib, libpng/libpng/contrib/pngminus/pnm2png.sh +42 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn0g01.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn0g02.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn0g04.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn0g08.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn0g16.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn2c08.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn2c16.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn3p01.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn3p02.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn3p04.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn3p08.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn4a08.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn4a16.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn6a08.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/pngsuite/basn6a16.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/PngFile.c +439 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/PngFile.h +27 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/README.txt +58 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/VisualPng.c +961 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/VisualPng.dsp +147 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/VisualPng.dsw +29 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/VisualPng.ico +0 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/VisualPng.png +0 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/VisualPng.rc +152 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/cexcept.h +243 -0
- data/windows/zlib, libpng/libpng/contrib/visupng/resource.h +23 -0
- data/windows/zlib, libpng/libpng/example.c +814 -0
- data/windows/zlib, libpng/libpng/libpng-1.2.29.txt +2906 -0
- data/windows/zlib, libpng/libpng/libpng.3 +3680 -0
- data/windows/zlib, libpng/libpng/libpngpf.3 +274 -0
- data/windows/zlib, libpng/libpng/png.5 +74 -0
- data/windows/zlib, libpng/libpng/png.c +798 -0
- data/windows/zlib, libpng/libpng/png.h +3569 -0
- data/windows/zlib, libpng/libpng/pngbar.jpg +0 -0
- data/windows/zlib, libpng/libpng/pngbar.png +0 -0
- data/windows/zlib, libpng/libpng/pngconf.h +1481 -0
- data/windows/zlib, libpng/libpng/pngerror.c +343 -0
- data/windows/zlib, libpng/libpng/pnggccrd.c +103 -0
- data/windows/zlib, libpng/libpng/pngget.c +901 -0
- data/windows/zlib, libpng/libpng/pngmem.c +608 -0
- data/windows/zlib, libpng/libpng/pngnow.png +0 -0
- data/windows/zlib, libpng/libpng/pngpread.c +1598 -0
- data/windows/zlib, libpng/libpng/pngread.c +1479 -0
- data/windows/zlib, libpng/libpng/pngrio.c +167 -0
- data/windows/zlib, libpng/libpng/pngrtran.c +4292 -0
- data/windows/zlib, libpng/libpng/pngrutil.c +3183 -0
- data/windows/zlib, libpng/libpng/pngset.c +1268 -0
- data/windows/zlib, libpng/libpng/pngtest.c +1563 -0
- data/windows/zlib, libpng/libpng/pngtest.png +0 -0
- data/windows/zlib, libpng/libpng/pngtrans.c +662 -0
- data/windows/zlib, libpng/libpng/pngvcrd.c +1 -0
- data/windows/zlib, libpng/libpng/pngwio.c +234 -0
- data/windows/zlib, libpng/libpng/pngwrite.c +1532 -0
- data/windows/zlib, libpng/libpng/pngwtran.c +572 -0
- data/windows/zlib, libpng/libpng/pngwutil.c +2802 -0
- data/windows/zlib, libpng/libpng/projects/beos/x86-shared.proj +0 -0
- data/windows/zlib, libpng/libpng/projects/beos/x86-shared.txt +22 -0
- data/windows/zlib, libpng/libpng/projects/beos/x86-static.proj +0 -0
- data/windows/zlib, libpng/libpng/projects/beos/x86-static.txt +22 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/libpng.bpf +22 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/libpng.bpg +25 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/libpng.bpr +157 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/libpng.cpp +29 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/libpng.readme.txt +25 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/libpngstat.bpf +22 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/libpngstat.bpr +109 -0
- data/windows/zlib, libpng/libpng/projects/cbuilder5/zlib.readme.txt +14 -0
- data/windows/zlib, libpng/libpng/projects/netware.txt +6 -0
- data/windows/zlib, libpng/libpng/projects/visualc6/README.txt +57 -0
- data/windows/zlib, libpng/libpng/projects/visualc6/libpng.dsp +472 -0
- data/windows/zlib, libpng/libpng/projects/visualc6/libpng.dsw +59 -0
- data/windows/zlib, libpng/libpng/projects/visualc6/pngtest.dsp +314 -0
- data/windows/zlib, libpng/libpng/projects/visualc71/PRJ0041.mak +21 -0
- data/windows/zlib, libpng/libpng/projects/visualc71/README.txt +57 -0
- data/windows/zlib, libpng/libpng/projects/visualc71/README_zlib.txt +44 -0
- data/windows/zlib, libpng/libpng/projects/visualc71/libpng.sln +88 -0
- data/windows/zlib, libpng/libpng/projects/visualc71/libpng.vcproj +702 -0
- data/windows/zlib, libpng/libpng/projects/visualc71/pngtest.vcproj +459 -0
- data/windows/zlib, libpng/libpng/projects/visualc71/zlib.vcproj +670 -0
- data/windows/zlib, libpng/libpng/projects/wince.txt +6 -0
- data/windows/zlib, libpng/libpng/scripts/CMakeLists.txt +210 -0
- data/windows/zlib, libpng/libpng/scripts/SCOPTIONS.ppc +7 -0
- data/windows/zlib, libpng/libpng/scripts/descrip.mms +52 -0
- data/windows/zlib, libpng/libpng/scripts/libpng-config-body.in +96 -0
- data/windows/zlib, libpng/libpng/scripts/libpng-config-head.in +21 -0
- data/windows/zlib, libpng/libpng/scripts/libpng-config.in +124 -0
- data/windows/zlib, libpng/libpng/scripts/libpng.icc +44 -0
- data/windows/zlib, libpng/libpng/scripts/libpng.pc-configure.in +10 -0
- data/windows/zlib, libpng/libpng/scripts/libpng.pc.in +10 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.32sunu +254 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.64sunu +254 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.acorn +51 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.aix +113 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.amiga +48 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.atari +51 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.bc32 +152 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.beos +226 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.bor +162 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.cygwin +299 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.darwin +234 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.dec +214 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.dj2 +55 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.elf +275 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.freebsd +48 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.gcc +79 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.gcmmx +271 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.hp64 +235 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.hpgcc +245 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.hpux +232 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.ibmc +71 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.intel +102 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.knr +99 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.linux +249 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.mingw +289 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.mips +83 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.msc +86 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.ne12bsd +45 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.netbsd +45 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.nommx +252 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.openbsd +73 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.os2 +69 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.sco +229 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.sggcc +242 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.sgi +245 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.so9 +251 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.solaris +249 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.solaris-x86 +248 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.std +92 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.sunos +97 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.tc3 +89 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.vcawin32 +99 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.vcwin32 +99 -0
- data/windows/zlib, libpng/libpng/scripts/makefile.watcom +109 -0
- data/windows/zlib, libpng/libpng/scripts/makevms.com +144 -0
- data/windows/zlib, libpng/libpng/scripts/pngos2.def +257 -0
- data/windows/zlib, libpng/libpng/scripts/pngw32.def +238 -0
- data/windows/zlib, libpng/libpng/scripts/pngw32.rc +112 -0
- data/windows/zlib, libpng/libpng/scripts/smakefile.ppc +30 -0
- data/windows/zlib, libpng/zlib/ChangeLog +855 -0
- data/windows/zlib, libpng/zlib/FAQ +339 -0
- data/windows/zlib, libpng/zlib/INDEX +51 -0
- data/windows/zlib, libpng/zlib/Makefile +154 -0
- data/windows/zlib, libpng/zlib/Makefile.in +154 -0
- data/windows/zlib, libpng/zlib/README +125 -0
- data/windows/zlib, libpng/zlib/adler32.c +149 -0
- data/windows/zlib, libpng/zlib/algorithm.txt +209 -0
- data/windows/zlib, libpng/zlib/amiga/Makefile.pup +66 -0
- data/windows/zlib, libpng/zlib/amiga/Makefile.sas +65 -0
- data/windows/zlib, libpng/zlib/as400/bndsrc +132 -0
- data/windows/zlib, libpng/zlib/as400/compile.clp +123 -0
- data/windows/zlib, libpng/zlib/as400/readme.txt +111 -0
- data/windows/zlib, libpng/zlib/as400/zlib.inc +331 -0
- data/windows/zlib, libpng/zlib/compress.c +79 -0
- data/windows/zlib, libpng/zlib/configure +459 -0
- data/windows/zlib, libpng/zlib/contrib/README.contrib +71 -0
- data/windows/zlib, libpng/zlib/contrib/ada/buffer_demo.adb +106 -0
- data/windows/zlib, libpng/zlib/contrib/ada/mtest.adb +156 -0
- data/windows/zlib, libpng/zlib/contrib/ada/read.adb +156 -0
- data/windows/zlib, libpng/zlib/contrib/ada/readme.txt +65 -0
- data/windows/zlib, libpng/zlib/contrib/ada/test.adb +463 -0
- data/windows/zlib, libpng/zlib/contrib/ada/zlib-streams.adb +225 -0
- data/windows/zlib, libpng/zlib/contrib/ada/zlib-streams.ads +114 -0
- data/windows/zlib, libpng/zlib/contrib/ada/zlib-thin.adb +141 -0
- data/windows/zlib, libpng/zlib/contrib/ada/zlib-thin.ads +450 -0
- data/windows/zlib, libpng/zlib/contrib/ada/zlib.adb +701 -0
- data/windows/zlib, libpng/zlib/contrib/ada/zlib.ads +328 -0
- data/windows/zlib, libpng/zlib/contrib/ada/zlib.gpr +20 -0
- data/windows/zlib, libpng/zlib/contrib/asm586/README.586 +43 -0
- data/windows/zlib, libpng/zlib/contrib/asm586/match.S +364 -0
- data/windows/zlib, libpng/zlib/contrib/asm686/README.686 +34 -0
- data/windows/zlib, libpng/zlib/contrib/asm686/match.S +329 -0
- data/windows/zlib, libpng/zlib/contrib/blast/Makefile +8 -0
- data/windows/zlib, libpng/zlib/contrib/blast/README +4 -0
- data/windows/zlib, libpng/zlib/contrib/blast/blast.c +444 -0
- data/windows/zlib, libpng/zlib/contrib/blast/blast.h +71 -0
- data/windows/zlib, libpng/zlib/contrib/blast/test.pk +0 -0
- data/windows/zlib, libpng/zlib/contrib/blast/test.txt +1 -0
- data/windows/zlib, libpng/zlib/contrib/delphi/ZLib.pas +557 -0
- data/windows/zlib, libpng/zlib/contrib/delphi/ZLibConst.pas +11 -0
- data/windows/zlib, libpng/zlib/contrib/delphi/readme.txt +76 -0
- data/windows/zlib, libpng/zlib/contrib/delphi/zlibd32.mak +93 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib.build +33 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib.chm +0 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib.sln +21 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/AssemblyInfo.cs +58 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/ChecksumImpl.cs +202 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/CircularBuffer.cs +83 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/CodecBase.cs +198 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/Deflater.cs +106 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/DotZLib.cs +288 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/DotZLib.csproj +141 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/GZipStream.cs +301 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/Inflater.cs +105 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/DotZLib/UnitTests.cs +274 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/LICENSE_1_0.txt +23 -0
- data/windows/zlib, libpng/zlib/contrib/dotzlib/readme.txt +58 -0
- data/windows/zlib, libpng/zlib/contrib/infback9/README +1 -0
- data/windows/zlib, libpng/zlib/contrib/infback9/infback9.c +608 -0
- data/windows/zlib, libpng/zlib/contrib/infback9/infback9.h +37 -0
- data/windows/zlib, libpng/zlib/contrib/infback9/inffix9.h +107 -0
- data/windows/zlib, libpng/zlib/contrib/infback9/inflate9.h +47 -0
- data/windows/zlib, libpng/zlib/contrib/infback9/inftree9.c +323 -0
- data/windows/zlib, libpng/zlib/contrib/infback9/inftree9.h +55 -0
- data/windows/zlib, libpng/zlib/contrib/inflate86/inffas86.c +1157 -0
- data/windows/zlib, libpng/zlib/contrib/inflate86/inffast.S +1368 -0
- data/windows/zlib, libpng/zlib/contrib/iostream/test.cpp +24 -0
- data/windows/zlib, libpng/zlib/contrib/iostream/zfstream.cpp +329 -0
- data/windows/zlib, libpng/zlib/contrib/iostream/zfstream.h +128 -0
- data/windows/zlib, libpng/zlib/contrib/iostream2/zstream.h +307 -0
- data/windows/zlib, libpng/zlib/contrib/iostream2/zstream_test.cpp +25 -0
- data/windows/zlib, libpng/zlib/contrib/iostream3/README +35 -0
- data/windows/zlib, libpng/zlib/contrib/iostream3/TODO +17 -0
- data/windows/zlib, libpng/zlib/contrib/iostream3/test.cc +50 -0
- data/windows/zlib, libpng/zlib/contrib/iostream3/zfstream.cc +479 -0
- data/windows/zlib, libpng/zlib/contrib/iostream3/zfstream.h +466 -0
- data/windows/zlib, libpng/zlib/contrib/masm686/match.asm +413 -0
- data/windows/zlib, libpng/zlib/contrib/masmx64/bld_ml64.bat +2 -0
- data/windows/zlib, libpng/zlib/contrib/masmx64/gvmat64.asm +513 -0
- data/windows/zlib, libpng/zlib/contrib/masmx64/gvmat64.obj +0 -0
- data/windows/zlib, libpng/zlib/contrib/masmx64/inffas8664.c +186 -0
- data/windows/zlib, libpng/zlib/contrib/masmx64/inffasx64.asm +392 -0
- data/windows/zlib, libpng/zlib/contrib/masmx64/inffasx64.obj +0 -0
- data/windows/zlib, libpng/zlib/contrib/masmx64/readme.txt +28 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/bld_ml32.bat +2 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/gvmat32.asm +972 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/gvmat32.obj +0 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/gvmat32c.c +62 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/inffas32.asm +1083 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/inffas32.obj +0 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/mkasm.bat +3 -0
- data/windows/zlib, libpng/zlib/contrib/masmx86/readme.txt +21 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/ChangeLogUnzip +67 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/Makefile +25 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/crypt.h +132 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/ioapi.c +177 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/ioapi.h +75 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/iowin32.c +270 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/iowin32.h +21 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/miniunz.c +585 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/minizip.c +420 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/mztools.c +281 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/mztools.h +31 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/unzip.c +1598 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/unzip.h +354 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/zip.c +1219 -0
- data/windows/zlib, libpng/zlib/contrib/minizip/zip.h +235 -0
- data/windows/zlib, libpng/zlib/contrib/pascal/example.pas +599 -0
- data/windows/zlib, libpng/zlib/contrib/pascal/readme.txt +76 -0
- data/windows/zlib, libpng/zlib/contrib/pascal/zlibd32.mak +93 -0
- data/windows/zlib, libpng/zlib/contrib/pascal/zlibpas.pas +236 -0
- data/windows/zlib, libpng/zlib/contrib/puff/Makefile +8 -0
- data/windows/zlib, libpng/zlib/contrib/puff/README +63 -0
- data/windows/zlib, libpng/zlib/contrib/puff/puff.c +837 -0
- data/windows/zlib, libpng/zlib/contrib/puff/puff.h +31 -0
- data/windows/zlib, libpng/zlib/contrib/puff/zeros.raw +0 -0
- data/windows/zlib, libpng/zlib/contrib/testzlib/testzlib.c +275 -0
- data/windows/zlib, libpng/zlib/contrib/testzlib/testzlib.txt +10 -0
- data/windows/zlib, libpng/zlib/contrib/untgz/Makefile +14 -0
- data/windows/zlib, libpng/zlib/contrib/untgz/Makefile.msc +17 -0
- data/windows/zlib, libpng/zlib/contrib/untgz/untgz.c +674 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/readme.txt +73 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/miniunz.vcproj +126 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/minizip.vcproj +126 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/testzlib.vcproj +126 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/zlib.rc +32 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/zlibstat.vcproj +246 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/zlibvc.def +92 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/zlibvc.sln +78 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc7/zlibvc.vcproj +445 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/miniunz.vcproj +566 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/minizip.vcproj +563 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/testzlib.vcproj +948 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/testzlibdll.vcproj +567 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/zlib.rc +32 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/zlibstat.vcproj +870 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/zlibvc.def +92 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/zlibvc.sln +144 -0
- data/windows/zlib, libpng/zlib/contrib/vstudio/vc8/zlibvc.vcproj +1219 -0
- data/windows/zlib, libpng/zlib/crc32.c +423 -0
- data/windows/zlib, libpng/zlib/crc32.h +441 -0
- data/windows/zlib, libpng/zlib/deflate.c +1736 -0
- data/windows/zlib, libpng/zlib/deflate.h +331 -0
- data/windows/zlib, libpng/zlib/example.c +565 -0
- data/windows/zlib, libpng/zlib/examples/README.examples +42 -0
- data/windows/zlib, libpng/zlib/examples/fitblk.c +233 -0
- data/windows/zlib, libpng/zlib/examples/gun.c +693 -0
- data/windows/zlib, libpng/zlib/examples/gzappend.c +500 -0
- data/windows/zlib, libpng/zlib/examples/gzjoin.c +448 -0
- data/windows/zlib, libpng/zlib/examples/gzlog.c +413 -0
- data/windows/zlib, libpng/zlib/examples/gzlog.h +58 -0
- data/windows/zlib, libpng/zlib/examples/zlib_how.html +523 -0
- data/windows/zlib, libpng/zlib/examples/zpipe.c +191 -0
- data/windows/zlib, libpng/zlib/examples/zran.c +404 -0
- data/windows/zlib, libpng/zlib/gzio.c +1026 -0
- data/windows/zlib, libpng/zlib/infback.c +623 -0
- data/windows/zlib, libpng/zlib/inffast.c +318 -0
- data/windows/zlib, libpng/zlib/inffast.h +11 -0
- data/windows/zlib, libpng/zlib/inffixed.h +94 -0
- data/windows/zlib, libpng/zlib/inflate.c +1368 -0
- data/windows/zlib, libpng/zlib/inflate.h +115 -0
- data/windows/zlib, libpng/zlib/inftrees.c +329 -0
- data/windows/zlib, libpng/zlib/inftrees.h +55 -0
- data/windows/zlib, libpng/zlib/make_vms.com +461 -0
- data/windows/zlib, libpng/zlib/minigzip.c +322 -0
- data/windows/zlib, libpng/zlib/msdos/Makefile.bor +109 -0
- data/windows/zlib, libpng/zlib/msdos/Makefile.dj2 +104 -0
- data/windows/zlib, libpng/zlib/msdos/Makefile.emx +69 -0
- data/windows/zlib, libpng/zlib/msdos/Makefile.msc +106 -0
- data/windows/zlib, libpng/zlib/msdos/Makefile.tc +94 -0
- data/windows/zlib, libpng/zlib/old/Makefile.riscos +151 -0
- data/windows/zlib, libpng/zlib/old/README +3 -0
- data/windows/zlib, libpng/zlib/old/descrip.mms +48 -0
- data/windows/zlib, libpng/zlib/old/os2/Makefile.os2 +136 -0
- data/windows/zlib, libpng/zlib/old/os2/zlib.def +51 -0
- data/windows/zlib, libpng/zlib/old/visual-basic.txt +160 -0
- data/windows/zlib, libpng/zlib/old/zlib.html +971 -0
- data/windows/zlib, libpng/zlib/projects/README.projects +41 -0
- data/windows/zlib, libpng/zlib/projects/visualc6/README.txt +73 -0
- data/windows/zlib, libpng/zlib/projects/visualc6/example.dsp +278 -0
- data/windows/zlib, libpng/zlib/projects/visualc6/minigzip.dsp +278 -0
- data/windows/zlib, libpng/zlib/projects/visualc6/zlib.dsp +609 -0
- data/windows/zlib, libpng/zlib/projects/visualc6/zlib.dsw +59 -0
- data/windows/zlib, libpng/zlib/qnx/package.qpg +141 -0
- data/windows/zlib, libpng/zlib/trees.c +1219 -0
- data/windows/zlib, libpng/zlib/trees.h +128 -0
- data/windows/zlib, libpng/zlib/uncompr.c +61 -0
- data/windows/zlib, libpng/zlib/win32/DLL_FAQ.txt +397 -0
- data/windows/zlib, libpng/zlib/win32/Makefile.bor +107 -0
- data/windows/zlib, libpng/zlib/win32/Makefile.emx +69 -0
- data/windows/zlib, libpng/zlib/win32/Makefile.gcc +141 -0
- data/windows/zlib, libpng/zlib/win32/Makefile.msc +126 -0
- data/windows/zlib, libpng/zlib/win32/VisualC.txt +3 -0
- data/windows/zlib, libpng/zlib/win32/zlib.def +60 -0
- data/windows/zlib, libpng/zlib/win32/zlib1.rc +39 -0
- data/windows/zlib, libpng/zlib/zconf.h +332 -0
- data/windows/zlib, libpng/zlib/zconf.in.h +332 -0
- data/windows/zlib, libpng/zlib/zlib.3 +159 -0
- data/windows/zlib, libpng/zlib/zlib.h +1357 -0
- data/windows/zlib, libpng/zlib/zutil.c +318 -0
- data/windows/zlib, libpng/zlib/zutil.h +269 -0
- metadata +669 -216
@@ -0,0 +1,2906 @@
|
|
1
|
+
libpng.txt - A description on how to use and modify libpng
|
2
|
+
|
3
|
+
libpng version 1.2.29 - May 8, 2008
|
4
|
+
Updated and distributed by Glenn Randers-Pehrson
|
5
|
+
<glennrp at users.sourceforge.net>
|
6
|
+
Copyright (c) 1998-2008 Glenn Randers-Pehrson
|
7
|
+
For conditions of distribution and use, see copyright
|
8
|
+
notice in png.h.
|
9
|
+
|
10
|
+
Based on:
|
11
|
+
|
12
|
+
libpng versions 0.97, January 1998, through 1.2.29 - May 8, 2008
|
13
|
+
Updated and distributed by Glenn Randers-Pehrson
|
14
|
+
Copyright (c) 1998-2008 Glenn Randers-Pehrson
|
15
|
+
|
16
|
+
libpng 1.0 beta 6 version 0.96 May 28, 1997
|
17
|
+
Updated and distributed by Andreas Dilger
|
18
|
+
Copyright (c) 1996, 1997 Andreas Dilger
|
19
|
+
|
20
|
+
libpng 1.0 beta 2 - version 0.88 January 26, 1996
|
21
|
+
For conditions of distribution and use, see copyright
|
22
|
+
notice in png.h. Copyright (c) 1995, 1996 Guy Eric
|
23
|
+
Schalnat, Group 42, Inc.
|
24
|
+
|
25
|
+
Updated/rewritten per request in the libpng FAQ
|
26
|
+
Copyright (c) 1995, 1996 Frank J. T. Wojcik
|
27
|
+
December 18, 1995 & January 20, 1996
|
28
|
+
|
29
|
+
I. Introduction
|
30
|
+
|
31
|
+
This file describes how to use and modify the PNG reference library
|
32
|
+
(known as libpng) for your own use. There are five sections to this
|
33
|
+
file: introduction, structures, reading, writing, and modification and
|
34
|
+
configuration notes for various special platforms. In addition to this
|
35
|
+
file, example.c is a good starting point for using the library, as
|
36
|
+
it is heavily commented and should include everything most people
|
37
|
+
will need. We assume that libpng is already installed; see the
|
38
|
+
INSTALL file for instructions on how to install libpng.
|
39
|
+
|
40
|
+
For examples of libpng usage, see the files "example.c", "pngtest.c",
|
41
|
+
and the files in the "contrib" directory, all of which are included in the
|
42
|
+
libpng distribution.
|
43
|
+
|
44
|
+
Libpng was written as a companion to the PNG specification, as a way
|
45
|
+
of reducing the amount of time and effort it takes to support the PNG
|
46
|
+
file format in application programs.
|
47
|
+
|
48
|
+
The PNG specification (second edition), November 2003, is available as
|
49
|
+
a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2003 (E)) at
|
50
|
+
<http://www.w3.org/TR/2003/REC-PNG-20031110/
|
51
|
+
The W3C and ISO documents have identical technical content.
|
52
|
+
|
53
|
+
The PNG-1.2 specification is available at
|
54
|
+
<http://www.libpng.org/pub/png/documents/>. It is technically equivalent
|
55
|
+
to the PNG specification (second edition) but has some additional material.
|
56
|
+
|
57
|
+
The PNG-1.0 specification is available
|
58
|
+
as RFC 2083 <http://www.libpng.org/pub/png/documents/> and as a
|
59
|
+
W3C Recommendation <http://www.w3.org/TR/REC.png.html>.
|
60
|
+
|
61
|
+
Some additional chunks are described in the special-purpose public chunks
|
62
|
+
documents at <http://www.libpng.org/pub/png/documents/>.
|
63
|
+
|
64
|
+
Other information
|
65
|
+
about PNG, and the latest version of libpng, can be found at the PNG home
|
66
|
+
page, <http://www.libpng.org/pub/png/>.
|
67
|
+
|
68
|
+
Most users will not have to modify the library significantly; advanced
|
69
|
+
users may want to modify it more. All attempts were made to make it as
|
70
|
+
complete as possible, while keeping the code easy to understand.
|
71
|
+
Currently, this library only supports C. Support for other languages
|
72
|
+
is being considered.
|
73
|
+
|
74
|
+
Libpng has been designed to handle multiple sessions at one time,
|
75
|
+
to be easily modifiable, to be portable to the vast majority of
|
76
|
+
machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy
|
77
|
+
to use. The ultimate goal of libpng is to promote the acceptance of
|
78
|
+
the PNG file format in whatever way possible. While there is still
|
79
|
+
work to be done (see the TODO file), libpng should cover the
|
80
|
+
majority of the needs of its users.
|
81
|
+
|
82
|
+
Libpng uses zlib for its compression and decompression of PNG files.
|
83
|
+
Further information about zlib, and the latest version of zlib, can
|
84
|
+
be found at the zlib home page, <http://www.info-zip.org/pub/infozip/zlib/>.
|
85
|
+
The zlib compression utility is a general purpose utility that is
|
86
|
+
useful for more than PNG files, and can be used without libpng.
|
87
|
+
See the documentation delivered with zlib for more details.
|
88
|
+
You can usually find the source files for the zlib utility wherever you
|
89
|
+
find the libpng source files.
|
90
|
+
|
91
|
+
Libpng is thread safe, provided the threads are using different
|
92
|
+
instances of the structures. Each thread should have its own
|
93
|
+
png_struct and png_info instances, and thus its own image.
|
94
|
+
Libpng does not protect itself against two threads using the
|
95
|
+
same instance of a structure.
|
96
|
+
|
97
|
+
II. Structures
|
98
|
+
|
99
|
+
There are two main structures that are important to libpng, png_struct
|
100
|
+
and png_info. The first, png_struct, is an internal structure that
|
101
|
+
will not, for the most part, be used by a user except as the first
|
102
|
+
variable passed to every libpng function call.
|
103
|
+
|
104
|
+
The png_info structure is designed to provide information about the
|
105
|
+
PNG file. At one time, the fields of png_info were intended to be
|
106
|
+
directly accessible to the user. However, this tended to cause problems
|
107
|
+
with applications using dynamically loaded libraries, and as a result
|
108
|
+
a set of interface functions for png_info (the png_get_*() and png_set_*()
|
109
|
+
functions) was developed. The fields of png_info are still available for
|
110
|
+
older applications, but it is suggested that applications use the new
|
111
|
+
interfaces if at all possible.
|
112
|
+
|
113
|
+
Applications that do make direct access to the members of png_struct (except
|
114
|
+
for png_ptr->jmpbuf) must be recompiled whenever the library is updated,
|
115
|
+
and applications that make direct access to the members of png_info must
|
116
|
+
be recompiled if they were compiled or loaded with libpng version 1.0.6,
|
117
|
+
in which the members were in a different order. In version 1.0.7, the
|
118
|
+
members of the png_info structure reverted to the old order, as they were
|
119
|
+
in versions 0.97c through 1.0.5. Starting with version 2.0.0, both
|
120
|
+
structures are going to be hidden, and the contents of the structures will
|
121
|
+
only be accessible through the png_get/png_set functions.
|
122
|
+
|
123
|
+
The png.h header file is an invaluable reference for programming with libpng.
|
124
|
+
And while I'm on the topic, make sure you include the libpng header file:
|
125
|
+
|
126
|
+
#include <png.h>
|
127
|
+
|
128
|
+
III. Reading
|
129
|
+
|
130
|
+
We'll now walk you through the possible functions to call when reading
|
131
|
+
in a PNG file sequentially, briefly explaining the syntax and purpose
|
132
|
+
of each one. See example.c and png.h for more detail. While
|
133
|
+
progressive reading is covered in the next section, you will still
|
134
|
+
need some of the functions discussed in this section to read a PNG
|
135
|
+
file.
|
136
|
+
|
137
|
+
Setup
|
138
|
+
|
139
|
+
You will want to do the I/O initialization(*) before you get into libpng,
|
140
|
+
so if it doesn't work, you don't have much to undo. Of course, you
|
141
|
+
will also want to insure that you are, in fact, dealing with a PNG
|
142
|
+
file. Libpng provides a simple check to see if a file is a PNG file.
|
143
|
+
To use it, pass in the first 1 to 8 bytes of the file to the function
|
144
|
+
png_sig_cmp(), and it will return 0 if the bytes match the corresponding
|
145
|
+
bytes of the PNG signature, or nonzero otherwise. Of course, the more bytes
|
146
|
+
you pass in, the greater the accuracy of the prediction.
|
147
|
+
|
148
|
+
If you are intending to keep the file pointer open for use in libpng,
|
149
|
+
you must ensure you don't read more than 8 bytes from the beginning
|
150
|
+
of the file, and you also have to make a call to png_set_sig_bytes_read()
|
151
|
+
with the number of bytes you read from the beginning. Libpng will
|
152
|
+
then only check the bytes (if any) that your program didn't read.
|
153
|
+
|
154
|
+
(*): If you are not using the standard I/O functions, you will need
|
155
|
+
to replace them with custom functions. See the discussion under
|
156
|
+
Customizing libpng.
|
157
|
+
|
158
|
+
|
159
|
+
FILE *fp = fopen(file_name, "rb");
|
160
|
+
if (!fp)
|
161
|
+
{
|
162
|
+
return (ERROR);
|
163
|
+
}
|
164
|
+
fread(header, 1, number, fp);
|
165
|
+
is_png = !png_sig_cmp(header, 0, number);
|
166
|
+
if (!is_png)
|
167
|
+
{
|
168
|
+
return (NOT_PNG);
|
169
|
+
}
|
170
|
+
|
171
|
+
|
172
|
+
Next, png_struct and png_info need to be allocated and initialized. In
|
173
|
+
order to ensure that the size of these structures is correct even with a
|
174
|
+
dynamically linked libpng, there are functions to initialize and
|
175
|
+
allocate the structures. We also pass the library version, optional
|
176
|
+
pointers to error handling functions, and a pointer to a data struct for
|
177
|
+
use by the error functions, if necessary (the pointer and functions can
|
178
|
+
be NULL if the default error handlers are to be used). See the section
|
179
|
+
on Changes to Libpng below regarding the old initialization functions.
|
180
|
+
The structure allocation functions quietly return NULL if they fail to
|
181
|
+
create the structure, so your application should check for that.
|
182
|
+
|
183
|
+
png_structp png_ptr = png_create_read_struct
|
184
|
+
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
|
185
|
+
user_error_fn, user_warning_fn);
|
186
|
+
if (!png_ptr)
|
187
|
+
return (ERROR);
|
188
|
+
|
189
|
+
png_infop info_ptr = png_create_info_struct(png_ptr);
|
190
|
+
if (!info_ptr)
|
191
|
+
{
|
192
|
+
png_destroy_read_struct(&png_ptr,
|
193
|
+
(png_infopp)NULL, (png_infopp)NULL);
|
194
|
+
return (ERROR);
|
195
|
+
}
|
196
|
+
|
197
|
+
png_infop end_info = png_create_info_struct(png_ptr);
|
198
|
+
if (!end_info)
|
199
|
+
{
|
200
|
+
png_destroy_read_struct(&png_ptr, &info_ptr,
|
201
|
+
(png_infopp)NULL);
|
202
|
+
return (ERROR);
|
203
|
+
}
|
204
|
+
|
205
|
+
If you want to use your own memory allocation routines,
|
206
|
+
define PNG_USER_MEM_SUPPORTED and use
|
207
|
+
png_create_read_struct_2() instead of png_create_read_struct():
|
208
|
+
|
209
|
+
png_structp png_ptr = png_create_read_struct_2
|
210
|
+
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
|
211
|
+
user_error_fn, user_warning_fn, (png_voidp)
|
212
|
+
user_mem_ptr, user_malloc_fn, user_free_fn);
|
213
|
+
|
214
|
+
The error handling routines passed to png_create_read_struct()
|
215
|
+
and the memory alloc/free routines passed to png_create_struct_2()
|
216
|
+
are only necessary if you are not using the libpng supplied error
|
217
|
+
handling and memory alloc/free functions.
|
218
|
+
|
219
|
+
When libpng encounters an error, it expects to longjmp back
|
220
|
+
to your routine. Therefore, you will need to call setjmp and pass
|
221
|
+
your png_jmpbuf(png_ptr). If you read the file from different
|
222
|
+
routines, you will need to update the jmpbuf field every time you enter
|
223
|
+
a new routine that will call a png_*() function.
|
224
|
+
|
225
|
+
See your documentation of setjmp/longjmp for your compiler for more
|
226
|
+
information on setjmp/longjmp. See the discussion on libpng error
|
227
|
+
handling in the Customizing Libpng section below for more information
|
228
|
+
on the libpng error handling. If an error occurs, and libpng longjmp's
|
229
|
+
back to your setjmp, you will want to call png_destroy_read_struct() to
|
230
|
+
free any memory.
|
231
|
+
|
232
|
+
if (setjmp(png_jmpbuf(png_ptr)))
|
233
|
+
{
|
234
|
+
png_destroy_read_struct(&png_ptr, &info_ptr,
|
235
|
+
&end_info);
|
236
|
+
fclose(fp);
|
237
|
+
return (ERROR);
|
238
|
+
}
|
239
|
+
|
240
|
+
If you would rather avoid the complexity of setjmp/longjmp issues,
|
241
|
+
you can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in which case
|
242
|
+
errors will result in a call to PNG_ABORT() which defaults to abort().
|
243
|
+
|
244
|
+
Now you need to set up the input code. The default for libpng is to
|
245
|
+
use the C function fread(). If you use this, you will need to pass a
|
246
|
+
valid FILE * in the function png_init_io(). Be sure that the file is
|
247
|
+
opened in binary mode. If you wish to handle reading data in another
|
248
|
+
way, you need not call the png_init_io() function, but you must then
|
249
|
+
implement the libpng I/O methods discussed in the Customizing Libpng
|
250
|
+
section below.
|
251
|
+
|
252
|
+
png_init_io(png_ptr, fp);
|
253
|
+
|
254
|
+
If you had previously opened the file and read any of the signature from
|
255
|
+
the beginning in order to see if this was a PNG file, you need to let
|
256
|
+
libpng know that there are some bytes missing from the start of the file.
|
257
|
+
|
258
|
+
png_set_sig_bytes(png_ptr, number);
|
259
|
+
|
260
|
+
Setting up callback code
|
261
|
+
|
262
|
+
You can set up a callback function to handle any unknown chunks in the
|
263
|
+
input stream. You must supply the function
|
264
|
+
|
265
|
+
read_chunk_callback(png_ptr ptr,
|
266
|
+
png_unknown_chunkp chunk);
|
267
|
+
{
|
268
|
+
/* The unknown chunk structure contains your
|
269
|
+
chunk data, along with similar data for any other
|
270
|
+
unknown chunks: */
|
271
|
+
|
272
|
+
png_byte name[5];
|
273
|
+
png_byte *data;
|
274
|
+
png_size_t size;
|
275
|
+
|
276
|
+
/* Note that libpng has already taken care of
|
277
|
+
the CRC handling */
|
278
|
+
|
279
|
+
/* put your code here. Search for your chunk in the
|
280
|
+
unknown chunk structure, process it, and return one
|
281
|
+
of the following: */
|
282
|
+
|
283
|
+
return (-n); /* chunk had an error */
|
284
|
+
return (0); /* did not recognize */
|
285
|
+
return (n); /* success */
|
286
|
+
}
|
287
|
+
|
288
|
+
(You can give your function another name that you like instead of
|
289
|
+
"read_chunk_callback")
|
290
|
+
|
291
|
+
To inform libpng about your function, use
|
292
|
+
|
293
|
+
png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
|
294
|
+
read_chunk_callback);
|
295
|
+
|
296
|
+
This names not only the callback function, but also a user pointer that
|
297
|
+
you can retrieve with
|
298
|
+
|
299
|
+
png_get_user_chunk_ptr(png_ptr);
|
300
|
+
|
301
|
+
If you call the png_set_read_user_chunk_fn() function, then all unknown
|
302
|
+
chunks will be saved when read, in case your callback function will need
|
303
|
+
one or more of them. This behavior can be changed with the
|
304
|
+
png_set_keep_unknown_chunks() function, described below.
|
305
|
+
|
306
|
+
At this point, you can set up a callback function that will be
|
307
|
+
called after each row has been read, which you can use to control
|
308
|
+
a progress meter or the like. It's demonstrated in pngtest.c.
|
309
|
+
You must supply a function
|
310
|
+
|
311
|
+
void read_row_callback(png_ptr ptr, png_uint_32 row,
|
312
|
+
int pass);
|
313
|
+
{
|
314
|
+
/* put your code here */
|
315
|
+
}
|
316
|
+
|
317
|
+
(You can give it another name that you like instead of "read_row_callback")
|
318
|
+
|
319
|
+
To inform libpng about your function, use
|
320
|
+
|
321
|
+
png_set_read_status_fn(png_ptr, read_row_callback);
|
322
|
+
|
323
|
+
Width and height limits
|
324
|
+
|
325
|
+
The PNG specification allows the width and height of an image to be as
|
326
|
+
large as 2^31-1 (0x7fffffff), or about 2.147 billion rows and columns.
|
327
|
+
Since very few applications really need to process such large images,
|
328
|
+
we have imposed an arbitrary 1-million limit on rows and columns.
|
329
|
+
Larger images will be rejected immediately with a png_error() call. If
|
330
|
+
you wish to override this limit, you can use
|
331
|
+
|
332
|
+
png_set_user_limits(png_ptr, width_max, height_max);
|
333
|
+
|
334
|
+
to set your own limits, or use width_max = height_max = 0x7fffffffL
|
335
|
+
to allow all valid dimensions (libpng may reject some very large images
|
336
|
+
anyway because of potential buffer overflow conditions).
|
337
|
+
|
338
|
+
You should put this statement after you create the PNG structure and
|
339
|
+
before calling png_read_info(), png_read_png(), or png_process_data().
|
340
|
+
If you need to retrieve the limits that are being applied, use
|
341
|
+
|
342
|
+
width_max = png_get_user_width_max(png_ptr);
|
343
|
+
height_max = png_get_user_height_max(png_ptr);
|
344
|
+
|
345
|
+
Unknown-chunk handling
|
346
|
+
|
347
|
+
Now you get to set the way the library processes unknown chunks in the
|
348
|
+
input PNG stream. Both known and unknown chunks will be read. Normal
|
349
|
+
behavior is that known chunks will be parsed into information in
|
350
|
+
various info_ptr members while unknown chunks will be discarded. To change
|
351
|
+
this, you can call:
|
352
|
+
|
353
|
+
png_set_keep_unknown_chunks(png_ptr, keep,
|
354
|
+
chunk_list, num_chunks);
|
355
|
+
keep - 0: default unknown chunk handling
|
356
|
+
1: ignore; do not keep
|
357
|
+
2: keep only if safe-to-copy
|
358
|
+
3: keep even if unsafe-to-copy
|
359
|
+
You can use these definitions:
|
360
|
+
PNG_HANDLE_CHUNK_AS_DEFAULT 0
|
361
|
+
PNG_HANDLE_CHUNK_NEVER 1
|
362
|
+
PNG_HANDLE_CHUNK_IF_SAFE 2
|
363
|
+
PNG_HANDLE_CHUNK_ALWAYS 3
|
364
|
+
chunk_list - list of chunks affected (a byte string,
|
365
|
+
five bytes per chunk, NULL or '\0' if
|
366
|
+
num_chunks is 0)
|
367
|
+
num_chunks - number of chunks affected; if 0, all
|
368
|
+
unknown chunks are affected. If nonzero,
|
369
|
+
only the chunks in the list are affected
|
370
|
+
|
371
|
+
Unknown chunks declared in this way will be saved as raw data onto a
|
372
|
+
list of png_unknown_chunk structures. If a chunk that is normally
|
373
|
+
known to libpng is named in the list, it will be handled as unknown,
|
374
|
+
according to the "keep" directive. If a chunk is named in successive
|
375
|
+
instances of png_set_keep_unknown_chunks(), the final instance will
|
376
|
+
take precedence. The IHDR and IEND chunks should not be named in
|
377
|
+
chunk_list; if they are, libpng will process them normally anyway.
|
378
|
+
|
379
|
+
Here is an example of the usage of png_set_keep_unknown_chunks(),
|
380
|
+
where the private "vpAg" chunk will later be processed by a user chunk
|
381
|
+
callback function:
|
382
|
+
|
383
|
+
png_byte vpAg[5]={118, 112, 65, 103, (png_byte) '\0'};
|
384
|
+
|
385
|
+
#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
|
386
|
+
png_byte unused_chunks[]=
|
387
|
+
{
|
388
|
+
104, 73, 83, 84, (png_byte) '\0', /* hIST */
|
389
|
+
105, 84, 88, 116, (png_byte) '\0', /* iTXt */
|
390
|
+
112, 67, 65, 76, (png_byte) '\0', /* pCAL */
|
391
|
+
115, 67, 65, 76, (png_byte) '\0', /* sCAL */
|
392
|
+
115, 80, 76, 84, (png_byte) '\0', /* sPLT */
|
393
|
+
116, 73, 77, 69, (png_byte) '\0', /* tIME */
|
394
|
+
};
|
395
|
+
#endif
|
396
|
+
|
397
|
+
...
|
398
|
+
|
399
|
+
#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
|
400
|
+
/* ignore all unknown chunks: */
|
401
|
+
png_set_keep_unknown_chunks(read_ptr, 1, NULL, 0);
|
402
|
+
/* except for vpAg: */
|
403
|
+
png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1);
|
404
|
+
/* also ignore unused known chunks: */
|
405
|
+
png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks,
|
406
|
+
(int)sizeof(unused_chunks)/5);
|
407
|
+
#endif
|
408
|
+
|
409
|
+
|
410
|
+
The high-level read interface
|
411
|
+
|
412
|
+
At this point there are two ways to proceed; through the high-level
|
413
|
+
read interface, or through a sequence of low-level read operations.
|
414
|
+
You can use the high-level interface if (a) you are willing to read
|
415
|
+
the entire image into memory, and (b) the input transformations
|
416
|
+
you want to do are limited to the following set:
|
417
|
+
|
418
|
+
PNG_TRANSFORM_IDENTITY No transformation
|
419
|
+
PNG_TRANSFORM_STRIP_16 Strip 16-bit samples to
|
420
|
+
8 bits
|
421
|
+
PNG_TRANSFORM_STRIP_ALPHA Discard the alpha channel
|
422
|
+
PNG_TRANSFORM_PACKING Expand 1, 2 and 4-bit
|
423
|
+
samples to bytes
|
424
|
+
PNG_TRANSFORM_PACKSWAP Change order of packed
|
425
|
+
pixels to LSB first
|
426
|
+
PNG_TRANSFORM_EXPAND Perform set_expand()
|
427
|
+
PNG_TRANSFORM_INVERT_MONO Invert monochrome images
|
428
|
+
PNG_TRANSFORM_SHIFT Normalize pixels to the
|
429
|
+
sBIT depth
|
430
|
+
PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA
|
431
|
+
to BGRA
|
432
|
+
PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA
|
433
|
+
to AG
|
434
|
+
PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity
|
435
|
+
to transparency
|
436
|
+
PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples
|
437
|
+
|
438
|
+
(This excludes setting a background color, doing gamma transformation,
|
439
|
+
dithering, and setting filler.) If this is the case, simply do this:
|
440
|
+
|
441
|
+
png_read_png(png_ptr, info_ptr, png_transforms, NULL)
|
442
|
+
|
443
|
+
where png_transforms is an integer containing the bitwise OR of
|
444
|
+
some set of transformation flags. This call is equivalent to png_read_info(),
|
445
|
+
followed the set of transformations indicated by the transform mask,
|
446
|
+
then png_read_image(), and finally png_read_end().
|
447
|
+
|
448
|
+
(The final parameter of this call is not yet used. Someday it might point
|
449
|
+
to transformation parameters required by some future input transform.)
|
450
|
+
|
451
|
+
You must use png_transforms and not call any png_set_transform() functions
|
452
|
+
when you use png_read_png().
|
453
|
+
|
454
|
+
After you have called png_read_png(), you can retrieve the image data
|
455
|
+
with
|
456
|
+
|
457
|
+
row_pointers = png_get_rows(png_ptr, info_ptr);
|
458
|
+
|
459
|
+
where row_pointers is an array of pointers to the pixel data for each row:
|
460
|
+
|
461
|
+
png_bytep row_pointers[height];
|
462
|
+
|
463
|
+
If you know your image size and pixel size ahead of time, you can allocate
|
464
|
+
row_pointers prior to calling png_read_png() with
|
465
|
+
|
466
|
+
if (height > PNG_UINT_32_MAX/png_sizeof(png_byte))
|
467
|
+
png_error (png_ptr,
|
468
|
+
"Image is too tall to process in memory");
|
469
|
+
if (width > PNG_UINT_32_MAX/pixel_size)
|
470
|
+
png_error (png_ptr,
|
471
|
+
"Image is too wide to process in memory");
|
472
|
+
row_pointers = png_malloc(png_ptr,
|
473
|
+
height*png_sizeof(png_bytep));
|
474
|
+
for (int i=0; i<height, i++)
|
475
|
+
row_pointers[i]=png_malloc(png_ptr,
|
476
|
+
width*pixel_size);
|
477
|
+
png_set_rows(png_ptr, info_ptr, &row_pointers);
|
478
|
+
|
479
|
+
Alternatively you could allocate your image in one big block and define
|
480
|
+
row_pointers[i] to point into the proper places in your block.
|
481
|
+
|
482
|
+
If you use png_set_rows(), the application is responsible for freeing
|
483
|
+
row_pointers (and row_pointers[i], if they were separately allocated).
|
484
|
+
|
485
|
+
If you don't allocate row_pointers ahead of time, png_read_png() will
|
486
|
+
do it, and it'll be free'ed when you call png_destroy_*().
|
487
|
+
|
488
|
+
The low-level read interface
|
489
|
+
|
490
|
+
If you are going the low-level route, you are now ready to read all
|
491
|
+
the file information up to the actual image data. You do this with a
|
492
|
+
call to png_read_info().
|
493
|
+
|
494
|
+
png_read_info(png_ptr, info_ptr);
|
495
|
+
|
496
|
+
This will process all chunks up to but not including the image data.
|
497
|
+
|
498
|
+
Querying the info structure
|
499
|
+
|
500
|
+
Functions are used to get the information from the info_ptr once it
|
501
|
+
has been read. Note that these fields may not be completely filled
|
502
|
+
in until png_read_end() has read the chunk data following the image.
|
503
|
+
|
504
|
+
png_get_IHDR(png_ptr, info_ptr, &width, &height,
|
505
|
+
&bit_depth, &color_type, &interlace_type,
|
506
|
+
&compression_type, &filter_method);
|
507
|
+
|
508
|
+
width - holds the width of the image
|
509
|
+
in pixels (up to 2^31).
|
510
|
+
height - holds the height of the image
|
511
|
+
in pixels (up to 2^31).
|
512
|
+
bit_depth - holds the bit depth of one of the
|
513
|
+
image channels. (valid values are
|
514
|
+
1, 2, 4, 8, 16 and depend also on
|
515
|
+
the color_type. See also
|
516
|
+
significant bits (sBIT) below).
|
517
|
+
color_type - describes which color/alpha channels
|
518
|
+
are present.
|
519
|
+
PNG_COLOR_TYPE_GRAY
|
520
|
+
(bit depths 1, 2, 4, 8, 16)
|
521
|
+
PNG_COLOR_TYPE_GRAY_ALPHA
|
522
|
+
(bit depths 8, 16)
|
523
|
+
PNG_COLOR_TYPE_PALETTE
|
524
|
+
(bit depths 1, 2, 4, 8)
|
525
|
+
PNG_COLOR_TYPE_RGB
|
526
|
+
(bit_depths 8, 16)
|
527
|
+
PNG_COLOR_TYPE_RGB_ALPHA
|
528
|
+
(bit_depths 8, 16)
|
529
|
+
|
530
|
+
PNG_COLOR_MASK_PALETTE
|
531
|
+
PNG_COLOR_MASK_COLOR
|
532
|
+
PNG_COLOR_MASK_ALPHA
|
533
|
+
|
534
|
+
filter_method - (must be PNG_FILTER_TYPE_BASE
|
535
|
+
for PNG 1.0, and can also be
|
536
|
+
PNG_INTRAPIXEL_DIFFERENCING if
|
537
|
+
the PNG datastream is embedded in
|
538
|
+
a MNG-1.0 datastream)
|
539
|
+
compression_type - (must be PNG_COMPRESSION_TYPE_BASE
|
540
|
+
for PNG 1.0)
|
541
|
+
interlace_type - (PNG_INTERLACE_NONE or
|
542
|
+
PNG_INTERLACE_ADAM7)
|
543
|
+
Any or all of interlace_type, compression_type, of
|
544
|
+
filter_method can be NULL if you are
|
545
|
+
not interested in their values.
|
546
|
+
|
547
|
+
channels = png_get_channels(png_ptr, info_ptr);
|
548
|
+
channels - number of channels of info for the
|
549
|
+
color type (valid values are 1 (GRAY,
|
550
|
+
PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
|
551
|
+
4 (RGB_ALPHA or RGB + filler byte))
|
552
|
+
rowbytes = png_get_rowbytes(png_ptr, info_ptr);
|
553
|
+
rowbytes - number of bytes needed to hold a row
|
554
|
+
|
555
|
+
signature = png_get_signature(png_ptr, info_ptr);
|
556
|
+
signature - holds the signature read from the
|
557
|
+
file (if any). The data is kept in
|
558
|
+
the same offset it would be if the
|
559
|
+
whole signature were read (i.e. if an
|
560
|
+
application had already read in 4
|
561
|
+
bytes of signature before starting
|
562
|
+
libpng, the remaining 4 bytes would
|
563
|
+
be in signature[4] through signature[7]
|
564
|
+
(see png_set_sig_bytes())).
|
565
|
+
|
566
|
+
|
567
|
+
width = png_get_image_width(png_ptr,
|
568
|
+
info_ptr);
|
569
|
+
height = png_get_image_height(png_ptr,
|
570
|
+
info_ptr);
|
571
|
+
bit_depth = png_get_bit_depth(png_ptr,
|
572
|
+
info_ptr);
|
573
|
+
color_type = png_get_color_type(png_ptr,
|
574
|
+
info_ptr);
|
575
|
+
filter_method = png_get_filter_type(png_ptr,
|
576
|
+
info_ptr);
|
577
|
+
compression_type = png_get_compression_type(png_ptr,
|
578
|
+
info_ptr);
|
579
|
+
interlace_type = png_get_interlace_type(png_ptr,
|
580
|
+
info_ptr);
|
581
|
+
|
582
|
+
|
583
|
+
These are also important, but their validity depends on whether the chunk
|
584
|
+
has been read. The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and
|
585
|
+
png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the
|
586
|
+
data has been read, or zero if it is missing. The parameters to the
|
587
|
+
png_get_<chunk> are set directly if they are simple data types, or a pointer
|
588
|
+
into the info_ptr is returned for any complex types.
|
589
|
+
|
590
|
+
png_get_PLTE(png_ptr, info_ptr, &palette,
|
591
|
+
&num_palette);
|
592
|
+
palette - the palette for the file
|
593
|
+
(array of png_color)
|
594
|
+
num_palette - number of entries in the palette
|
595
|
+
|
596
|
+
png_get_gAMA(png_ptr, info_ptr, &gamma);
|
597
|
+
gamma - the gamma the file is written
|
598
|
+
at (PNG_INFO_gAMA)
|
599
|
+
|
600
|
+
png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
|
601
|
+
srgb_intent - the rendering intent (PNG_INFO_sRGB)
|
602
|
+
The presence of the sRGB chunk
|
603
|
+
means that the pixel data is in the
|
604
|
+
sRGB color space. This chunk also
|
605
|
+
implies specific values of gAMA and
|
606
|
+
cHRM.
|
607
|
+
|
608
|
+
png_get_iCCP(png_ptr, info_ptr, &name,
|
609
|
+
&compression_type, &profile, &proflen);
|
610
|
+
name - The profile name.
|
611
|
+
compression - The compression type; always
|
612
|
+
PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
|
613
|
+
You may give NULL to this argument to
|
614
|
+
ignore it.
|
615
|
+
profile - International Color Consortium color
|
616
|
+
profile data. May contain NULs.
|
617
|
+
proflen - length of profile data in bytes.
|
618
|
+
|
619
|
+
png_get_sBIT(png_ptr, info_ptr, &sig_bit);
|
620
|
+
sig_bit - the number of significant bits for
|
621
|
+
(PNG_INFO_sBIT) each of the gray,
|
622
|
+
red, green, and blue channels,
|
623
|
+
whichever are appropriate for the
|
624
|
+
given color type (png_color_16)
|
625
|
+
|
626
|
+
png_get_tRNS(png_ptr, info_ptr, &trans, &num_trans,
|
627
|
+
&trans_values);
|
628
|
+
trans - array of transparent entries for
|
629
|
+
palette (PNG_INFO_tRNS)
|
630
|
+
trans_values - graylevel or color sample values of
|
631
|
+
the single transparent color for
|
632
|
+
non-paletted images (PNG_INFO_tRNS)
|
633
|
+
num_trans - number of transparent entries
|
634
|
+
(PNG_INFO_tRNS)
|
635
|
+
|
636
|
+
png_get_hIST(png_ptr, info_ptr, &hist);
|
637
|
+
(PNG_INFO_hIST)
|
638
|
+
hist - histogram of palette (array of
|
639
|
+
png_uint_16)
|
640
|
+
|
641
|
+
png_get_tIME(png_ptr, info_ptr, &mod_time);
|
642
|
+
mod_time - time image was last modified
|
643
|
+
(PNG_VALID_tIME)
|
644
|
+
|
645
|
+
png_get_bKGD(png_ptr, info_ptr, &background);
|
646
|
+
background - background color (PNG_VALID_bKGD)
|
647
|
+
valid 16-bit red, green and blue
|
648
|
+
values, regardless of color_type
|
649
|
+
|
650
|
+
num_comments = png_get_text(png_ptr, info_ptr,
|
651
|
+
&text_ptr, &num_text);
|
652
|
+
num_comments - number of comments
|
653
|
+
text_ptr - array of png_text holding image
|
654
|
+
comments
|
655
|
+
text_ptr[i].compression - type of compression used
|
656
|
+
on "text" PNG_TEXT_COMPRESSION_NONE
|
657
|
+
PNG_TEXT_COMPRESSION_zTXt
|
658
|
+
PNG_ITXT_COMPRESSION_NONE
|
659
|
+
PNG_ITXT_COMPRESSION_zTXt
|
660
|
+
text_ptr[i].key - keyword for comment. Must contain
|
661
|
+
1-79 characters.
|
662
|
+
text_ptr[i].text - text comments for current
|
663
|
+
keyword. Can be empty.
|
664
|
+
text_ptr[i].text_length - length of text string,
|
665
|
+
after decompression, 0 for iTXt
|
666
|
+
text_ptr[i].itxt_length - length of itxt string,
|
667
|
+
after decompression, 0 for tEXt/zTXt
|
668
|
+
text_ptr[i].lang - language of comment (empty
|
669
|
+
string for unknown).
|
670
|
+
text_ptr[i].lang_key - keyword in UTF-8
|
671
|
+
(empty string for unknown).
|
672
|
+
num_text - number of comments (same as
|
673
|
+
num_comments; you can put NULL here
|
674
|
+
to avoid the duplication)
|
675
|
+
Note while png_set_text() will accept text, language,
|
676
|
+
and translated keywords that can be NULL pointers, the
|
677
|
+
structure returned by png_get_text will always contain
|
678
|
+
regular zero-terminated C strings. They might be
|
679
|
+
empty strings but they will never be NULL pointers.
|
680
|
+
|
681
|
+
num_spalettes = png_get_sPLT(png_ptr, info_ptr,
|
682
|
+
&palette_ptr);
|
683
|
+
palette_ptr - array of palette structures holding
|
684
|
+
contents of one or more sPLT chunks
|
685
|
+
read.
|
686
|
+
num_spalettes - number of sPLT chunks read.
|
687
|
+
|
688
|
+
png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
|
689
|
+
&unit_type);
|
690
|
+
offset_x - positive offset from the left edge
|
691
|
+
of the screen
|
692
|
+
offset_y - positive offset from the top edge
|
693
|
+
of the screen
|
694
|
+
unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
|
695
|
+
|
696
|
+
png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
|
697
|
+
&unit_type);
|
698
|
+
res_x - pixels/unit physical resolution in
|
699
|
+
x direction
|
700
|
+
res_y - pixels/unit physical resolution in
|
701
|
+
x direction
|
702
|
+
unit_type - PNG_RESOLUTION_UNKNOWN,
|
703
|
+
PNG_RESOLUTION_METER
|
704
|
+
|
705
|
+
png_get_sCAL(png_ptr, info_ptr, &unit, &width,
|
706
|
+
&height)
|
707
|
+
unit - physical scale units (an integer)
|
708
|
+
width - width of a pixel in physical scale units
|
709
|
+
height - height of a pixel in physical scale units
|
710
|
+
(width and height are doubles)
|
711
|
+
|
712
|
+
png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
|
713
|
+
&height)
|
714
|
+
unit - physical scale units (an integer)
|
715
|
+
width - width of a pixel in physical scale units
|
716
|
+
height - height of a pixel in physical scale units
|
717
|
+
(width and height are strings like "2.54")
|
718
|
+
|
719
|
+
num_unknown_chunks = png_get_unknown_chunks(png_ptr,
|
720
|
+
info_ptr, &unknowns)
|
721
|
+
unknowns - array of png_unknown_chunk
|
722
|
+
structures holding unknown chunks
|
723
|
+
unknowns[i].name - name of unknown chunk
|
724
|
+
unknowns[i].data - data of unknown chunk
|
725
|
+
unknowns[i].size - size of unknown chunk's data
|
726
|
+
unknowns[i].location - position of chunk in file
|
727
|
+
|
728
|
+
The value of "i" corresponds to the order in which the
|
729
|
+
chunks were read from the PNG file or inserted with the
|
730
|
+
png_set_unknown_chunks() function.
|
731
|
+
|
732
|
+
The data from the pHYs chunk can be retrieved in several convenient
|
733
|
+
forms:
|
734
|
+
|
735
|
+
res_x = png_get_x_pixels_per_meter(png_ptr,
|
736
|
+
info_ptr)
|
737
|
+
res_y = png_get_y_pixels_per_meter(png_ptr,
|
738
|
+
info_ptr)
|
739
|
+
res_x_and_y = png_get_pixels_per_meter(png_ptr,
|
740
|
+
info_ptr)
|
741
|
+
res_x = png_get_x_pixels_per_inch(png_ptr,
|
742
|
+
info_ptr)
|
743
|
+
res_y = png_get_y_pixels_per_inch(png_ptr,
|
744
|
+
info_ptr)
|
745
|
+
res_x_and_y = png_get_pixels_per_inch(png_ptr,
|
746
|
+
info_ptr)
|
747
|
+
aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
|
748
|
+
info_ptr)
|
749
|
+
|
750
|
+
(Each of these returns 0 [signifying "unknown"] if
|
751
|
+
the data is not present or if res_x is 0;
|
752
|
+
res_x_and_y is 0 if res_x != res_y)
|
753
|
+
|
754
|
+
The data from the oFFs chunk can be retrieved in several convenient
|
755
|
+
forms:
|
756
|
+
|
757
|
+
x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
|
758
|
+
y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
|
759
|
+
x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
|
760
|
+
y_offset = png_get_y_offset_inches(png_ptr, info_ptr);
|
761
|
+
|
762
|
+
(Each of these returns 0 [signifying "unknown" if both
|
763
|
+
x and y are 0] if the data is not present or if the
|
764
|
+
chunk is present but the unit is the pixel)
|
765
|
+
|
766
|
+
For more information, see the png_info definition in png.h and the
|
767
|
+
PNG specification for chunk contents. Be careful with trusting
|
768
|
+
rowbytes, as some of the transformations could increase the space
|
769
|
+
needed to hold a row (expand, filler, gray_to_rgb, etc.).
|
770
|
+
See png_read_update_info(), below.
|
771
|
+
|
772
|
+
A quick word about text_ptr and num_text. PNG stores comments in
|
773
|
+
keyword/text pairs, one pair per chunk, with no limit on the number
|
774
|
+
of text chunks, and a 2^31 byte limit on their size. While there are
|
775
|
+
suggested keywords, there is no requirement to restrict the use to these
|
776
|
+
strings. It is strongly suggested that keywords and text be sensible
|
777
|
+
to humans (that's the point), so don't use abbreviations. Non-printing
|
778
|
+
symbols are not allowed. See the PNG specification for more details.
|
779
|
+
There is also no requirement to have text after the keyword.
|
780
|
+
|
781
|
+
Keywords should be limited to 79 Latin-1 characters without leading or
|
782
|
+
trailing spaces, but non-consecutive spaces are allowed within the
|
783
|
+
keyword. It is possible to have the same keyword any number of times.
|
784
|
+
The text_ptr is an array of png_text structures, each holding a
|
785
|
+
pointer to a language string, a pointer to a keyword and a pointer to
|
786
|
+
a text string. The text string, language code, and translated
|
787
|
+
keyword may be empty or NULL pointers. The keyword/text
|
788
|
+
pairs are put into the array in the order that they are received.
|
789
|
+
However, some or all of the text chunks may be after the image, so, to
|
790
|
+
make sure you have read all the text chunks, don't mess with these
|
791
|
+
until after you read the stuff after the image. This will be
|
792
|
+
mentioned again below in the discussion that goes with png_read_end().
|
793
|
+
|
794
|
+
Input transformations
|
795
|
+
|
796
|
+
After you've read the header information, you can set up the library
|
797
|
+
to handle any special transformations of the image data. The various
|
798
|
+
ways to transform the data will be described in the order that they
|
799
|
+
should occur. This is important, as some of these change the color
|
800
|
+
type and/or bit depth of the data, and some others only work on
|
801
|
+
certain color types and bit depths. Even though each transformation
|
802
|
+
checks to see if it has data that it can do something with, you should
|
803
|
+
make sure to only enable a transformation if it will be valid for the
|
804
|
+
data. For example, don't swap red and blue on grayscale data.
|
805
|
+
|
806
|
+
The colors used for the background and transparency values should be
|
807
|
+
supplied in the same format/depth as the current image data. They
|
808
|
+
are stored in the same format/depth as the image data in a bKGD or tRNS
|
809
|
+
chunk, so this is what libpng expects for this data. The colors are
|
810
|
+
transformed to keep in sync with the image data when an application
|
811
|
+
calls the png_read_update_info() routine (see below).
|
812
|
+
|
813
|
+
Data will be decoded into the supplied row buffers packed into bytes
|
814
|
+
unless the library has been told to transform it into another format.
|
815
|
+
For example, 4 bit/pixel paletted or grayscale data will be returned
|
816
|
+
2 pixels/byte with the leftmost pixel in the high-order bits of the
|
817
|
+
byte, unless png_set_packing() is called. 8-bit RGB data will be stored
|
818
|
+
in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha()
|
819
|
+
is called to insert filler bytes, either before or after each RGB triplet.
|
820
|
+
16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant
|
821
|
+
byte of the color value first, unless png_set_strip_16() is called to
|
822
|
+
transform it to regular RGB RGB triplets, or png_set_filler() or
|
823
|
+
png_set_add alpha() is called to insert filler bytes, either before or
|
824
|
+
after each RRGGBB triplet. Similarly, 8-bit or 16-bit grayscale data can
|
825
|
+
be modified with
|
826
|
+
png_set_filler(), png_set_add_alpha(), or png_set_strip_16().
|
827
|
+
|
828
|
+
The following code transforms grayscale images of less than 8 to 8 bits,
|
829
|
+
changes paletted images to RGB, and adds a full alpha channel if there is
|
830
|
+
transparency information in a tRNS chunk. This is most useful on
|
831
|
+
grayscale images with bit depths of 2 or 4 or if there is a multiple-image
|
832
|
+
viewing application that wishes to treat all images in the same way.
|
833
|
+
|
834
|
+
if (color_type == PNG_COLOR_TYPE_PALETTE)
|
835
|
+
png_set_palette_to_rgb(png_ptr);
|
836
|
+
|
837
|
+
if (color_type == PNG_COLOR_TYPE_GRAY &&
|
838
|
+
bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr);
|
839
|
+
|
840
|
+
if (png_get_valid(png_ptr, info_ptr,
|
841
|
+
PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);
|
842
|
+
|
843
|
+
These three functions are actually aliases for png_set_expand(), added
|
844
|
+
in libpng version 1.0.4, with the function names expanded to improve code
|
845
|
+
readability. In some future version they may actually do different
|
846
|
+
things.
|
847
|
+
|
848
|
+
As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was
|
849
|
+
added. It expands the sample depth without changing tRNS to alpha.
|
850
|
+
At the same time, png_set_gray_1_2_4_to_8() was deprecated, and it
|
851
|
+
will be removed from a future version.
|
852
|
+
|
853
|
+
|
854
|
+
PNG can have files with 16 bits per channel. If you only can handle
|
855
|
+
8 bits per channel, this will strip the pixels down to 8 bit.
|
856
|
+
|
857
|
+
if (bit_depth == 16)
|
858
|
+
png_set_strip_16(png_ptr);
|
859
|
+
|
860
|
+
If, for some reason, you don't need the alpha channel on an image,
|
861
|
+
and you want to remove it rather than combining it with the background
|
862
|
+
(but the image author certainly had in mind that you *would* combine
|
863
|
+
it with the background, so that's what you should probably do):
|
864
|
+
|
865
|
+
if (color_type & PNG_COLOR_MASK_ALPHA)
|
866
|
+
png_set_strip_alpha(png_ptr);
|
867
|
+
|
868
|
+
In PNG files, the alpha channel in an image
|
869
|
+
is the level of opacity. If you need the alpha channel in an image to
|
870
|
+
be the level of transparency instead of opacity, you can invert the
|
871
|
+
alpha channel (or the tRNS chunk data) after it's read, so that 0 is
|
872
|
+
fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit
|
873
|
+
images) is fully transparent, with
|
874
|
+
|
875
|
+
png_set_invert_alpha(png_ptr);
|
876
|
+
|
877
|
+
PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
|
878
|
+
they can, resulting in, for example, 8 pixels per byte for 1 bit
|
879
|
+
files. This code expands to 1 pixel per byte without changing the
|
880
|
+
values of the pixels:
|
881
|
+
|
882
|
+
if (bit_depth < 8)
|
883
|
+
png_set_packing(png_ptr);
|
884
|
+
|
885
|
+
PNG files have possible bit depths of 1, 2, 4, 8, and 16. All pixels
|
886
|
+
stored in a PNG image have been "scaled" or "shifted" up to the next
|
887
|
+
higher possible bit depth (e.g. from 5 bits/sample in the range [0,31] to
|
888
|
+
8 bits/sample in the range [0, 255]). However, it is also possible to
|
889
|
+
convert the PNG pixel data back to the original bit depth of the image.
|
890
|
+
This call reduces the pixels back down to the original bit depth:
|
891
|
+
|
892
|
+
png_color_8p sig_bit;
|
893
|
+
|
894
|
+
if (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
|
895
|
+
png_set_shift(png_ptr, sig_bit);
|
896
|
+
|
897
|
+
PNG files store 3-color pixels in red, green, blue order. This code
|
898
|
+
changes the storage of the pixels to blue, green, red:
|
899
|
+
|
900
|
+
if (color_type == PNG_COLOR_TYPE_RGB ||
|
901
|
+
color_type == PNG_COLOR_TYPE_RGB_ALPHA)
|
902
|
+
png_set_bgr(png_ptr);
|
903
|
+
|
904
|
+
PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them
|
905
|
+
into 4 or 8 bytes for windowing systems that need them in this format:
|
906
|
+
|
907
|
+
if (color_type == PNG_COLOR_TYPE_RGB)
|
908
|
+
png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
|
909
|
+
|
910
|
+
where "filler" is the 8 or 16-bit number to fill with, and the location is
|
911
|
+
either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
|
912
|
+
you want the filler before the RGB or after. This transformation
|
913
|
+
does not affect images that already have full alpha channels. To add an
|
914
|
+
opaque alpha channel, use filler=0xff or 0xffff and PNG_FILLER_AFTER which
|
915
|
+
will generate RGBA pixels.
|
916
|
+
|
917
|
+
Note that png_set_filler() does not change the color type. If you want
|
918
|
+
to do that, you can add a true alpha channel with
|
919
|
+
|
920
|
+
if (color_type == PNG_COLOR_TYPE_RGB ||
|
921
|
+
color_type == PNG_COLOR_TYPE_GRAY)
|
922
|
+
png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
|
923
|
+
|
924
|
+
where "filler" contains the alpha value to assign to each pixel.
|
925
|
+
This function was added in libpng-1.2.7.
|
926
|
+
|
927
|
+
If you are reading an image with an alpha channel, and you need the
|
928
|
+
data as ARGB instead of the normal PNG format RGBA:
|
929
|
+
|
930
|
+
if (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
|
931
|
+
png_set_swap_alpha(png_ptr);
|
932
|
+
|
933
|
+
For some uses, you may want a grayscale image to be represented as
|
934
|
+
RGB. This code will do that conversion:
|
935
|
+
|
936
|
+
if (color_type == PNG_COLOR_TYPE_GRAY ||
|
937
|
+
color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
|
938
|
+
png_set_gray_to_rgb(png_ptr);
|
939
|
+
|
940
|
+
Conversely, you can convert an RGB or RGBA image to grayscale or grayscale
|
941
|
+
with alpha.
|
942
|
+
|
943
|
+
if (color_type == PNG_COLOR_TYPE_RGB ||
|
944
|
+
color_type == PNG_COLOR_TYPE_RGB_ALPHA)
|
945
|
+
png_set_rgb_to_gray_fixed(png_ptr, error_action,
|
946
|
+
int red_weight, int green_weight);
|
947
|
+
|
948
|
+
error_action = 1: silently do the conversion
|
949
|
+
error_action = 2: issue a warning if the original
|
950
|
+
image has any pixel where
|
951
|
+
red != green or red != blue
|
952
|
+
error_action = 3: issue an error and abort the
|
953
|
+
conversion if the original
|
954
|
+
image has any pixel where
|
955
|
+
red != green or red != blue
|
956
|
+
|
957
|
+
red_weight: weight of red component times 100000
|
958
|
+
green_weight: weight of green component times 100000
|
959
|
+
If either weight is negative, default
|
960
|
+
weights (21268, 71514) are used.
|
961
|
+
|
962
|
+
If you have set error_action = 1 or 2, you can
|
963
|
+
later check whether the image really was gray, after processing
|
964
|
+
the image rows, with the png_get_rgb_to_gray_status(png_ptr) function.
|
965
|
+
It will return a png_byte that is zero if the image was gray or
|
966
|
+
1 if there were any non-gray pixels. bKGD and sBIT data
|
967
|
+
will be silently converted to grayscale, using the green channel
|
968
|
+
data, regardless of the error_action setting.
|
969
|
+
|
970
|
+
With red_weight+green_weight<=100000,
|
971
|
+
the normalized graylevel is computed:
|
972
|
+
|
973
|
+
int rw = red_weight * 65536;
|
974
|
+
int gw = green_weight * 65536;
|
975
|
+
int bw = 65536 - (rw + gw);
|
976
|
+
gray = (rw*red + gw*green + bw*blue)/65536;
|
977
|
+
|
978
|
+
The default values approximate those recommended in the Charles
|
979
|
+
Poynton's Color FAQ, <http://www.inforamp.net/~poynton/>
|
980
|
+
Copyright (c) 1998-01-04 Charles Poynton <poynton at inforamp.net>
|
981
|
+
|
982
|
+
Y = 0.212671 * R + 0.715160 * G + 0.072169 * B
|
983
|
+
|
984
|
+
Libpng approximates this with
|
985
|
+
|
986
|
+
Y = 0.21268 * R + 0.7151 * G + 0.07217 * B
|
987
|
+
|
988
|
+
which can be expressed with integers as
|
989
|
+
|
990
|
+
Y = (6969 * R + 23434 * G + 2365 * B)/32768
|
991
|
+
|
992
|
+
The calculation is done in a linear colorspace, if the image gamma
|
993
|
+
is known.
|
994
|
+
|
995
|
+
If you have a grayscale and you are using png_set_expand_depth(),
|
996
|
+
png_set_expand(), or png_set_gray_to_rgb to change to truecolor or to
|
997
|
+
a higher bit-depth, you must either supply the background color as a gray
|
998
|
+
value at the original file bit-depth (need_expand = 1) or else supply the
|
999
|
+
background color as an RGB triplet at the final, expanded bit depth
|
1000
|
+
(need_expand = 0). Similarly, if you are reading a paletted image, you
|
1001
|
+
must either supply the background color as a palette index (need_expand = 1)
|
1002
|
+
or as an RGB triplet that may or may not be in the palette (need_expand = 0).
|
1003
|
+
|
1004
|
+
png_color_16 my_background;
|
1005
|
+
png_color_16p image_background;
|
1006
|
+
|
1007
|
+
if (png_get_bKGD(png_ptr, info_ptr, &image_background))
|
1008
|
+
png_set_background(png_ptr, image_background,
|
1009
|
+
PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
|
1010
|
+
else
|
1011
|
+
png_set_background(png_ptr, &my_background,
|
1012
|
+
PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
|
1013
|
+
|
1014
|
+
The png_set_background() function tells libpng to composite images
|
1015
|
+
with alpha or simple transparency against the supplied background
|
1016
|
+
color. If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid),
|
1017
|
+
you may use this color, or supply another color more suitable for
|
1018
|
+
the current display (e.g., the background color from a web page). You
|
1019
|
+
need to tell libpng whether the color is in the gamma space of the
|
1020
|
+
display (PNG_BACKGROUND_GAMMA_SCREEN for colors you supply), the file
|
1021
|
+
(PNG_BACKGROUND_GAMMA_FILE for colors from the bKGD chunk), or one
|
1022
|
+
that is neither of these gammas (PNG_BACKGROUND_GAMMA_UNIQUE - I don't
|
1023
|
+
know why anyone would use this, but it's here).
|
1024
|
+
|
1025
|
+
To properly display PNG images on any kind of system, the application needs
|
1026
|
+
to know what the display gamma is. Ideally, the user will know this, and
|
1027
|
+
the application will allow them to set it. One method of allowing the user
|
1028
|
+
to set the display gamma separately for each system is to check for a
|
1029
|
+
SCREEN_GAMMA or DISPLAY_GAMMA environment variable, which will hopefully be
|
1030
|
+
correctly set.
|
1031
|
+
|
1032
|
+
Note that display_gamma is the overall gamma correction required to produce
|
1033
|
+
pleasing results, which depends on the lighting conditions in the surrounding
|
1034
|
+
environment. In a dim or brightly lit room, no compensation other than
|
1035
|
+
the physical gamma exponent of the monitor is needed, while in a dark room
|
1036
|
+
a slightly smaller exponent is better.
|
1037
|
+
|
1038
|
+
double gamma, screen_gamma;
|
1039
|
+
|
1040
|
+
if (/* We have a user-defined screen
|
1041
|
+
gamma value */)
|
1042
|
+
{
|
1043
|
+
screen_gamma = user_defined_screen_gamma;
|
1044
|
+
}
|
1045
|
+
/* One way that applications can share the same
|
1046
|
+
screen gamma value */
|
1047
|
+
else if ((gamma_str = getenv("SCREEN_GAMMA"))
|
1048
|
+
!= NULL)
|
1049
|
+
{
|
1050
|
+
screen_gamma = (double)atof(gamma_str);
|
1051
|
+
}
|
1052
|
+
/* If we don't have another value */
|
1053
|
+
else
|
1054
|
+
{
|
1055
|
+
screen_gamma = 2.2; /* A good guess for a
|
1056
|
+
PC monitor in a bright office or a dim room */
|
1057
|
+
screen_gamma = 2.0; /* A good guess for a
|
1058
|
+
PC monitor in a dark room */
|
1059
|
+
screen_gamma = 1.7 or 1.0; /* A good
|
1060
|
+
guess for Mac systems */
|
1061
|
+
}
|
1062
|
+
|
1063
|
+
The png_set_gamma() function handles gamma transformations of the data.
|
1064
|
+
Pass both the file gamma and the current screen_gamma. If the file does
|
1065
|
+
not have a gamma value, you can pass one anyway if you have an idea what
|
1066
|
+
it is (usually 0.45455 is a good guess for GIF images on PCs). Note
|
1067
|
+
that file gammas are inverted from screen gammas. See the discussions
|
1068
|
+
on gamma in the PNG specification for an excellent description of what
|
1069
|
+
gamma is, and why all applications should support it. It is strongly
|
1070
|
+
recommended that PNG viewers support gamma correction.
|
1071
|
+
|
1072
|
+
if (png_get_gAMA(png_ptr, info_ptr, &gamma))
|
1073
|
+
png_set_gamma(png_ptr, screen_gamma, gamma);
|
1074
|
+
else
|
1075
|
+
png_set_gamma(png_ptr, screen_gamma, 0.45455);
|
1076
|
+
|
1077
|
+
If you need to reduce an RGB file to a paletted file, or if a paletted
|
1078
|
+
file has more entries then will fit on your screen, png_set_dither()
|
1079
|
+
will do that. Note that this is a simple match dither that merely
|
1080
|
+
finds the closest color available. This should work fairly well with
|
1081
|
+
optimized palettes, and fairly badly with linear color cubes. If you
|
1082
|
+
pass a palette that is larger then maximum_colors, the file will
|
1083
|
+
reduce the number of colors in the palette so it will fit into
|
1084
|
+
maximum_colors. If there is a histogram, it will use it to make
|
1085
|
+
more intelligent choices when reducing the palette. If there is no
|
1086
|
+
histogram, it may not do as good a job.
|
1087
|
+
|
1088
|
+
if (color_type & PNG_COLOR_MASK_COLOR)
|
1089
|
+
{
|
1090
|
+
if (png_get_valid(png_ptr, info_ptr,
|
1091
|
+
PNG_INFO_PLTE))
|
1092
|
+
{
|
1093
|
+
png_uint_16p histogram = NULL;
|
1094
|
+
|
1095
|
+
png_get_hIST(png_ptr, info_ptr,
|
1096
|
+
&histogram);
|
1097
|
+
png_set_dither(png_ptr, palette, num_palette,
|
1098
|
+
max_screen_colors, histogram, 1);
|
1099
|
+
}
|
1100
|
+
else
|
1101
|
+
{
|
1102
|
+
png_color std_color_cube[MAX_SCREEN_COLORS] =
|
1103
|
+
{ ... colors ... };
|
1104
|
+
|
1105
|
+
png_set_dither(png_ptr, std_color_cube,
|
1106
|
+
MAX_SCREEN_COLORS, MAX_SCREEN_COLORS,
|
1107
|
+
NULL,0);
|
1108
|
+
}
|
1109
|
+
}
|
1110
|
+
|
1111
|
+
PNG files describe monochrome as black being zero and white being one.
|
1112
|
+
The following code will reverse this (make black be one and white be
|
1113
|
+
zero):
|
1114
|
+
|
1115
|
+
if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
|
1116
|
+
png_set_invert_mono(png_ptr);
|
1117
|
+
|
1118
|
+
This function can also be used to invert grayscale and gray-alpha images:
|
1119
|
+
|
1120
|
+
if (color_type == PNG_COLOR_TYPE_GRAY ||
|
1121
|
+
color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
|
1122
|
+
png_set_invert_mono(png_ptr);
|
1123
|
+
|
1124
|
+
PNG files store 16 bit pixels in network byte order (big-endian,
|
1125
|
+
ie. most significant bits first). This code changes the storage to the
|
1126
|
+
other way (little-endian, i.e. least significant bits first, the
|
1127
|
+
way PCs store them):
|
1128
|
+
|
1129
|
+
if (bit_depth == 16)
|
1130
|
+
png_set_swap(png_ptr);
|
1131
|
+
|
1132
|
+
If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
|
1133
|
+
need to change the order the pixels are packed into bytes, you can use:
|
1134
|
+
|
1135
|
+
if (bit_depth < 8)
|
1136
|
+
png_set_packswap(png_ptr);
|
1137
|
+
|
1138
|
+
Finally, you can write your own transformation function if none of
|
1139
|
+
the existing ones meets your needs. This is done by setting a callback
|
1140
|
+
with
|
1141
|
+
|
1142
|
+
png_set_read_user_transform_fn(png_ptr,
|
1143
|
+
read_transform_fn);
|
1144
|
+
|
1145
|
+
You must supply the function
|
1146
|
+
|
1147
|
+
void read_transform_fn(png_ptr ptr, row_info_ptr
|
1148
|
+
row_info, png_bytep data)
|
1149
|
+
|
1150
|
+
See pngtest.c for a working example. Your function will be called
|
1151
|
+
after all of the other transformations have been processed.
|
1152
|
+
|
1153
|
+
You can also set up a pointer to a user structure for use by your
|
1154
|
+
callback function, and you can inform libpng that your transform
|
1155
|
+
function will change the number of channels or bit depth with the
|
1156
|
+
function
|
1157
|
+
|
1158
|
+
png_set_user_transform_info(png_ptr, user_ptr,
|
1159
|
+
user_depth, user_channels);
|
1160
|
+
|
1161
|
+
The user's application, not libpng, is responsible for allocating and
|
1162
|
+
freeing any memory required for the user structure.
|
1163
|
+
|
1164
|
+
You can retrieve the pointer via the function
|
1165
|
+
png_get_user_transform_ptr(). For example:
|
1166
|
+
|
1167
|
+
voidp read_user_transform_ptr =
|
1168
|
+
png_get_user_transform_ptr(png_ptr);
|
1169
|
+
|
1170
|
+
The last thing to handle is interlacing; this is covered in detail below,
|
1171
|
+
but you must call the function here if you want libpng to handle expansion
|
1172
|
+
of the interlaced image.
|
1173
|
+
|
1174
|
+
number_of_passes = png_set_interlace_handling(png_ptr);
|
1175
|
+
|
1176
|
+
After setting the transformations, libpng can update your png_info
|
1177
|
+
structure to reflect any transformations you've requested with this
|
1178
|
+
call. This is most useful to update the info structure's rowbytes
|
1179
|
+
field so you can use it to allocate your image memory. This function
|
1180
|
+
will also update your palette with the correct screen_gamma and
|
1181
|
+
background if these have been given with the calls above.
|
1182
|
+
|
1183
|
+
png_read_update_info(png_ptr, info_ptr);
|
1184
|
+
|
1185
|
+
After you call png_read_update_info(), you can allocate any
|
1186
|
+
memory you need to hold the image. The row data is simply
|
1187
|
+
raw byte data for all forms of images. As the actual allocation
|
1188
|
+
varies among applications, no example will be given. If you
|
1189
|
+
are allocating one large chunk, you will need to build an
|
1190
|
+
array of pointers to each row, as it will be needed for some
|
1191
|
+
of the functions below.
|
1192
|
+
|
1193
|
+
Reading image data
|
1194
|
+
|
1195
|
+
After you've allocated memory, you can read the image data.
|
1196
|
+
The simplest way to do this is in one function call. If you are
|
1197
|
+
allocating enough memory to hold the whole image, you can just
|
1198
|
+
call png_read_image() and libpng will read in all the image data
|
1199
|
+
and put it in the memory area supplied. You will need to pass in
|
1200
|
+
an array of pointers to each row.
|
1201
|
+
|
1202
|
+
This function automatically handles interlacing, so you don't need
|
1203
|
+
to call png_set_interlace_handling() or call this function multiple
|
1204
|
+
times, or any of that other stuff necessary with png_read_rows().
|
1205
|
+
|
1206
|
+
png_read_image(png_ptr, row_pointers);
|
1207
|
+
|
1208
|
+
where row_pointers is:
|
1209
|
+
|
1210
|
+
png_bytep row_pointers[height];
|
1211
|
+
|
1212
|
+
You can point to void or char or whatever you use for pixels.
|
1213
|
+
|
1214
|
+
If you don't want to read in the whole image at once, you can
|
1215
|
+
use png_read_rows() instead. If there is no interlacing (check
|
1216
|
+
interlace_type == PNG_INTERLACE_NONE), this is simple:
|
1217
|
+
|
1218
|
+
png_read_rows(png_ptr, row_pointers, NULL,
|
1219
|
+
number_of_rows);
|
1220
|
+
|
1221
|
+
where row_pointers is the same as in the png_read_image() call.
|
1222
|
+
|
1223
|
+
If you are doing this just one row at a time, you can do this with
|
1224
|
+
a single row_pointer instead of an array of row_pointers:
|
1225
|
+
|
1226
|
+
png_bytep row_pointer = row;
|
1227
|
+
png_read_row(png_ptr, row_pointer, NULL);
|
1228
|
+
|
1229
|
+
If the file is interlaced (interlace_type != 0 in the IHDR chunk), things
|
1230
|
+
get somewhat harder. The only current (PNG Specification version 1.2)
|
1231
|
+
interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7)
|
1232
|
+
is a somewhat complicated 2D interlace scheme, known as Adam7, that
|
1233
|
+
breaks down an image into seven smaller images of varying size, based
|
1234
|
+
on an 8x8 grid.
|
1235
|
+
|
1236
|
+
libpng can fill out those images or it can give them to you "as is".
|
1237
|
+
If you want them filled out, there are two ways to do that. The one
|
1238
|
+
mentioned in the PNG specification is to expand each pixel to cover
|
1239
|
+
those pixels that have not been read yet (the "rectangle" method).
|
1240
|
+
This results in a blocky image for the first pass, which gradually
|
1241
|
+
smooths out as more pixels are read. The other method is the "sparkle"
|
1242
|
+
method, where pixels are drawn only in their final locations, with the
|
1243
|
+
rest of the image remaining whatever colors they were initialized to
|
1244
|
+
before the start of the read. The first method usually looks better,
|
1245
|
+
but tends to be slower, as there are more pixels to put in the rows.
|
1246
|
+
|
1247
|
+
If you don't want libpng to handle the interlacing details, just call
|
1248
|
+
png_read_rows() seven times to read in all seven images. Each of the
|
1249
|
+
images is a valid image by itself, or they can all be combined on an
|
1250
|
+
8x8 grid to form a single image (although if you intend to combine them
|
1251
|
+
you would be far better off using the libpng interlace handling).
|
1252
|
+
|
1253
|
+
The first pass will return an image 1/8 as wide as the entire image
|
1254
|
+
(every 8th column starting in column 0) and 1/8 as high as the original
|
1255
|
+
(every 8th row starting in row 0), the second will be 1/8 as wide
|
1256
|
+
(starting in column 4) and 1/8 as high (also starting in row 0). The
|
1257
|
+
third pass will be 1/4 as wide (every 4th pixel starting in column 0) and
|
1258
|
+
1/8 as high (every 8th row starting in row 4), and the fourth pass will
|
1259
|
+
be 1/4 as wide and 1/4 as high (every 4th column starting in column 2,
|
1260
|
+
and every 4th row starting in row 0). The fifth pass will return an
|
1261
|
+
image 1/2 as wide, and 1/4 as high (starting at column 0 and row 2),
|
1262
|
+
while the sixth pass will be 1/2 as wide and 1/2 as high as the original
|
1263
|
+
(starting in column 1 and row 0). The seventh and final pass will be as
|
1264
|
+
wide as the original, and 1/2 as high, containing all of the odd
|
1265
|
+
numbered scanlines. Phew!
|
1266
|
+
|
1267
|
+
If you want libpng to expand the images, call this before calling
|
1268
|
+
png_start_read_image() or png_read_update_info():
|
1269
|
+
|
1270
|
+
if (interlace_type == PNG_INTERLACE_ADAM7)
|
1271
|
+
number_of_passes
|
1272
|
+
= png_set_interlace_handling(png_ptr);
|
1273
|
+
|
1274
|
+
This will return the number of passes needed. Currently, this
|
1275
|
+
is seven, but may change if another interlace type is added.
|
1276
|
+
This function can be called even if the file is not interlaced,
|
1277
|
+
where it will return one pass.
|
1278
|
+
|
1279
|
+
If you are not going to display the image after each pass, but are
|
1280
|
+
going to wait until the entire image is read in, use the sparkle
|
1281
|
+
effect. This effect is faster and the end result of either method
|
1282
|
+
is exactly the same. If you are planning on displaying the image
|
1283
|
+
after each pass, the "rectangle" effect is generally considered the
|
1284
|
+
better looking one.
|
1285
|
+
|
1286
|
+
If you only want the "sparkle" effect, just call png_read_rows() as
|
1287
|
+
normal, with the third parameter NULL. Make sure you make pass over
|
1288
|
+
the image number_of_passes times, and you don't change the data in the
|
1289
|
+
rows between calls. You can change the locations of the data, just
|
1290
|
+
not the data. Each pass only writes the pixels appropriate for that
|
1291
|
+
pass, and assumes the data from previous passes is still valid.
|
1292
|
+
|
1293
|
+
png_read_rows(png_ptr, row_pointers, NULL,
|
1294
|
+
number_of_rows);
|
1295
|
+
|
1296
|
+
If you only want the first effect (the rectangles), do the same as
|
1297
|
+
before except pass the row buffer in the third parameter, and leave
|
1298
|
+
the second parameter NULL.
|
1299
|
+
|
1300
|
+
png_read_rows(png_ptr, NULL, row_pointers,
|
1301
|
+
number_of_rows);
|
1302
|
+
|
1303
|
+
Finishing a sequential read
|
1304
|
+
|
1305
|
+
After you are finished reading the image through the
|
1306
|
+
low-level interface, you can finish reading the file. If you are
|
1307
|
+
interested in comments or time, which may be stored either before or
|
1308
|
+
after the image data, you should pass the separate png_info struct if
|
1309
|
+
you want to keep the comments from before and after the image
|
1310
|
+
separate. If you are not interested, you can pass NULL.
|
1311
|
+
|
1312
|
+
png_read_end(png_ptr, end_info);
|
1313
|
+
|
1314
|
+
When you are done, you can free all memory allocated by libpng like this:
|
1315
|
+
|
1316
|
+
png_destroy_read_struct(&png_ptr, &info_ptr,
|
1317
|
+
&end_info);
|
1318
|
+
|
1319
|
+
It is also possible to individually free the info_ptr members that
|
1320
|
+
point to libpng-allocated storage with the following function:
|
1321
|
+
|
1322
|
+
png_free_data(png_ptr, info_ptr, mask, seq)
|
1323
|
+
mask - identifies data to be freed, a mask
|
1324
|
+
containing the bitwise OR of one or
|
1325
|
+
more of
|
1326
|
+
PNG_FREE_PLTE, PNG_FREE_TRNS,
|
1327
|
+
PNG_FREE_HIST, PNG_FREE_ICCP,
|
1328
|
+
PNG_FREE_PCAL, PNG_FREE_ROWS,
|
1329
|
+
PNG_FREE_SCAL, PNG_FREE_SPLT,
|
1330
|
+
PNG_FREE_TEXT, PNG_FREE_UNKN,
|
1331
|
+
or simply PNG_FREE_ALL
|
1332
|
+
seq - sequence number of item to be freed
|
1333
|
+
(-1 for all items)
|
1334
|
+
|
1335
|
+
This function may be safely called when the relevant storage has
|
1336
|
+
already been freed, or has not yet been allocated, or was allocated
|
1337
|
+
by the user and not by libpng, and will in those
|
1338
|
+
cases do nothing. The "seq" parameter is ignored if only one item
|
1339
|
+
of the selected data type, such as PLTE, is allowed. If "seq" is not
|
1340
|
+
-1, and multiple items are allowed for the data type identified in
|
1341
|
+
the mask, such as text or sPLT, only the n'th item in the structure
|
1342
|
+
is freed, where n is "seq".
|
1343
|
+
|
1344
|
+
The default behavior is only to free data that was allocated internally
|
1345
|
+
by libpng. This can be changed, so that libpng will not free the data,
|
1346
|
+
or so that it will free data that was allocated by the user with png_malloc()
|
1347
|
+
or png_zalloc() and passed in via a png_set_*() function, with
|
1348
|
+
|
1349
|
+
png_data_freer(png_ptr, info_ptr, freer, mask)
|
1350
|
+
mask - which data elements are affected
|
1351
|
+
same choices as in png_free_data()
|
1352
|
+
freer - one of
|
1353
|
+
PNG_DESTROY_WILL_FREE_DATA
|
1354
|
+
PNG_SET_WILL_FREE_DATA
|
1355
|
+
PNG_USER_WILL_FREE_DATA
|
1356
|
+
|
1357
|
+
This function only affects data that has already been allocated.
|
1358
|
+
You can call this function after reading the PNG data but before calling
|
1359
|
+
any png_set_*() functions, to control whether the user or the png_set_*()
|
1360
|
+
function is responsible for freeing any existing data that might be present,
|
1361
|
+
and again after the png_set_*() functions to control whether the user
|
1362
|
+
or png_destroy_*() is supposed to free the data. When the user assumes
|
1363
|
+
responsibility for libpng-allocated data, the application must use
|
1364
|
+
png_free() to free it, and when the user transfers responsibility to libpng
|
1365
|
+
for data that the user has allocated, the user must have used png_malloc()
|
1366
|
+
or png_zalloc() to allocate it.
|
1367
|
+
|
1368
|
+
If you allocated your row_pointers in a single block, as suggested above in
|
1369
|
+
the description of the high level read interface, you must not transfer
|
1370
|
+
responsibility for freeing it to the png_set_rows or png_read_destroy function,
|
1371
|
+
because they would also try to free the individual row_pointers[i].
|
1372
|
+
|
1373
|
+
If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
|
1374
|
+
separately, do not transfer responsibility for freeing text_ptr to libpng,
|
1375
|
+
because when libpng fills a png_text structure it combines these members with
|
1376
|
+
the key member, and png_free_data() will free only text_ptr.key. Similarly,
|
1377
|
+
if you transfer responsibility for free'ing text_ptr from libpng to your
|
1378
|
+
application, your application must not separately free those members.
|
1379
|
+
|
1380
|
+
The png_free_data() function will turn off the "valid" flag for anything
|
1381
|
+
it frees. If you need to turn the flag off for a chunk that was freed by your
|
1382
|
+
application instead of by libpng, you can use
|
1383
|
+
|
1384
|
+
png_set_invalid(png_ptr, info_ptr, mask);
|
1385
|
+
mask - identifies the chunks to be made invalid,
|
1386
|
+
containing the bitwise OR of one or
|
1387
|
+
more of
|
1388
|
+
PNG_INFO_gAMA, PNG_INFO_sBIT,
|
1389
|
+
PNG_INFO_cHRM, PNG_INFO_PLTE,
|
1390
|
+
PNG_INFO_tRNS, PNG_INFO_bKGD,
|
1391
|
+
PNG_INFO_hIST, PNG_INFO_pHYs,
|
1392
|
+
PNG_INFO_oFFs, PNG_INFO_tIME,
|
1393
|
+
PNG_INFO_pCAL, PNG_INFO_sRGB,
|
1394
|
+
PNG_INFO_iCCP, PNG_INFO_sPLT,
|
1395
|
+
PNG_INFO_sCAL, PNG_INFO_IDAT
|
1396
|
+
|
1397
|
+
For a more compact example of reading a PNG image, see the file example.c.
|
1398
|
+
|
1399
|
+
Reading PNG files progressively
|
1400
|
+
|
1401
|
+
The progressive reader is slightly different then the non-progressive
|
1402
|
+
reader. Instead of calling png_read_info(), png_read_rows(), and
|
1403
|
+
png_read_end(), you make one call to png_process_data(), which calls
|
1404
|
+
callbacks when it has the info, a row, or the end of the image. You
|
1405
|
+
set up these callbacks with png_set_progressive_read_fn(). You don't
|
1406
|
+
have to worry about the input/output functions of libpng, as you are
|
1407
|
+
giving the library the data directly in png_process_data(). I will
|
1408
|
+
assume that you have read the section on reading PNG files above,
|
1409
|
+
so I will only highlight the differences (although I will show
|
1410
|
+
all of the code).
|
1411
|
+
|
1412
|
+
png_structp png_ptr;
|
1413
|
+
png_infop info_ptr;
|
1414
|
+
|
1415
|
+
/* An example code fragment of how you would
|
1416
|
+
initialize the progressive reader in your
|
1417
|
+
application. */
|
1418
|
+
int
|
1419
|
+
initialize_png_reader()
|
1420
|
+
{
|
1421
|
+
png_ptr = png_create_read_struct
|
1422
|
+
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
|
1423
|
+
user_error_fn, user_warning_fn);
|
1424
|
+
if (!png_ptr)
|
1425
|
+
return (ERROR);
|
1426
|
+
info_ptr = png_create_info_struct(png_ptr);
|
1427
|
+
if (!info_ptr)
|
1428
|
+
{
|
1429
|
+
png_destroy_read_struct(&png_ptr, (png_infopp)NULL,
|
1430
|
+
(png_infopp)NULL);
|
1431
|
+
return (ERROR);
|
1432
|
+
}
|
1433
|
+
|
1434
|
+
if (setjmp(png_jmpbuf(png_ptr)))
|
1435
|
+
{
|
1436
|
+
png_destroy_read_struct(&png_ptr, &info_ptr,
|
1437
|
+
(png_infopp)NULL);
|
1438
|
+
return (ERROR);
|
1439
|
+
}
|
1440
|
+
|
1441
|
+
/* This one's new. You can provide functions
|
1442
|
+
to be called when the header info is valid,
|
1443
|
+
when each row is completed, and when the image
|
1444
|
+
is finished. If you aren't using all functions,
|
1445
|
+
you can specify NULL parameters. Even when all
|
1446
|
+
three functions are NULL, you need to call
|
1447
|
+
png_set_progressive_read_fn(). You can use
|
1448
|
+
any struct as the user_ptr (cast to a void pointer
|
1449
|
+
for the function call), and retrieve the pointer
|
1450
|
+
from inside the callbacks using the function
|
1451
|
+
|
1452
|
+
png_get_progressive_ptr(png_ptr);
|
1453
|
+
|
1454
|
+
which will return a void pointer, which you have
|
1455
|
+
to cast appropriately.
|
1456
|
+
*/
|
1457
|
+
png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
|
1458
|
+
info_callback, row_callback, end_callback);
|
1459
|
+
|
1460
|
+
return 0;
|
1461
|
+
}
|
1462
|
+
|
1463
|
+
/* A code fragment that you call as you receive blocks
|
1464
|
+
of data */
|
1465
|
+
int
|
1466
|
+
process_data(png_bytep buffer, png_uint_32 length)
|
1467
|
+
{
|
1468
|
+
if (setjmp(png_jmpbuf(png_ptr)))
|
1469
|
+
{
|
1470
|
+
png_destroy_read_struct(&png_ptr, &info_ptr,
|
1471
|
+
(png_infopp)NULL);
|
1472
|
+
return (ERROR);
|
1473
|
+
}
|
1474
|
+
|
1475
|
+
/* This one's new also. Simply give it a chunk
|
1476
|
+
of data from the file stream (in order, of
|
1477
|
+
course). On machines with segmented memory
|
1478
|
+
models machines, don't give it any more than
|
1479
|
+
64K. The library seems to run fine with sizes
|
1480
|
+
of 4K. Although you can give it much less if
|
1481
|
+
necessary (I assume you can give it chunks of
|
1482
|
+
1 byte, I haven't tried less then 256 bytes
|
1483
|
+
yet). When this function returns, you may
|
1484
|
+
want to display any rows that were generated
|
1485
|
+
in the row callback if you don't already do
|
1486
|
+
so there.
|
1487
|
+
*/
|
1488
|
+
png_process_data(png_ptr, info_ptr, buffer, length);
|
1489
|
+
return 0;
|
1490
|
+
}
|
1491
|
+
|
1492
|
+
/* This function is called (as set by
|
1493
|
+
png_set_progressive_read_fn() above) when enough data
|
1494
|
+
has been supplied so all of the header has been
|
1495
|
+
read.
|
1496
|
+
*/
|
1497
|
+
void
|
1498
|
+
info_callback(png_structp png_ptr, png_infop info)
|
1499
|
+
{
|
1500
|
+
/* Do any setup here, including setting any of
|
1501
|
+
the transformations mentioned in the Reading
|
1502
|
+
PNG files section. For now, you _must_ call
|
1503
|
+
either png_start_read_image() or
|
1504
|
+
png_read_update_info() after all the
|
1505
|
+
transformations are set (even if you don't set
|
1506
|
+
any). You may start getting rows before
|
1507
|
+
png_process_data() returns, so this is your
|
1508
|
+
last chance to prepare for that.
|
1509
|
+
*/
|
1510
|
+
}
|
1511
|
+
|
1512
|
+
/* This function is called when each row of image
|
1513
|
+
data is complete */
|
1514
|
+
void
|
1515
|
+
row_callback(png_structp png_ptr, png_bytep new_row,
|
1516
|
+
png_uint_32 row_num, int pass)
|
1517
|
+
{
|
1518
|
+
/* If the image is interlaced, and you turned
|
1519
|
+
on the interlace handler, this function will
|
1520
|
+
be called for every row in every pass. Some
|
1521
|
+
of these rows will not be changed from the
|
1522
|
+
previous pass. When the row is not changed,
|
1523
|
+
the new_row variable will be NULL. The rows
|
1524
|
+
and passes are called in order, so you don't
|
1525
|
+
really need the row_num and pass, but I'm
|
1526
|
+
supplying them because it may make your life
|
1527
|
+
easier.
|
1528
|
+
|
1529
|
+
For the non-NULL rows of interlaced images,
|
1530
|
+
you must call png_progressive_combine_row()
|
1531
|
+
passing in the row and the old row. You can
|
1532
|
+
call this function for NULL rows (it will just
|
1533
|
+
return) and for non-interlaced images (it just
|
1534
|
+
does the memcpy for you) if it will make the
|
1535
|
+
code easier. Thus, you can just do this for
|
1536
|
+
all cases:
|
1537
|
+
*/
|
1538
|
+
|
1539
|
+
png_progressive_combine_row(png_ptr, old_row,
|
1540
|
+
new_row);
|
1541
|
+
|
1542
|
+
/* where old_row is what was displayed for
|
1543
|
+
previously for the row. Note that the first
|
1544
|
+
pass (pass == 0, really) will completely cover
|
1545
|
+
the old row, so the rows do not have to be
|
1546
|
+
initialized. After the first pass (and only
|
1547
|
+
for interlaced images), you will have to pass
|
1548
|
+
the current row, and the function will combine
|
1549
|
+
the old row and the new row.
|
1550
|
+
*/
|
1551
|
+
}
|
1552
|
+
|
1553
|
+
void
|
1554
|
+
end_callback(png_structp png_ptr, png_infop info)
|
1555
|
+
{
|
1556
|
+
/* This function is called after the whole image
|
1557
|
+
has been read, including any chunks after the
|
1558
|
+
image (up to and including the IEND). You
|
1559
|
+
will usually have the same info chunk as you
|
1560
|
+
had in the header, although some data may have
|
1561
|
+
been added to the comments and time fields.
|
1562
|
+
|
1563
|
+
Most people won't do much here, perhaps setting
|
1564
|
+
a flag that marks the image as finished.
|
1565
|
+
*/
|
1566
|
+
}
|
1567
|
+
|
1568
|
+
|
1569
|
+
|
1570
|
+
IV. Writing
|
1571
|
+
|
1572
|
+
Much of this is very similar to reading. However, everything of
|
1573
|
+
importance is repeated here, so you won't have to constantly look
|
1574
|
+
back up in the reading section to understand writing.
|
1575
|
+
|
1576
|
+
Setup
|
1577
|
+
|
1578
|
+
You will want to do the I/O initialization before you get into libpng,
|
1579
|
+
so if it doesn't work, you don't have anything to undo. If you are not
|
1580
|
+
using the standard I/O functions, you will need to replace them with
|
1581
|
+
custom writing functions. See the discussion under Customizing libpng.
|
1582
|
+
|
1583
|
+
FILE *fp = fopen(file_name, "wb");
|
1584
|
+
if (!fp)
|
1585
|
+
{
|
1586
|
+
return (ERROR);
|
1587
|
+
}
|
1588
|
+
|
1589
|
+
Next, png_struct and png_info need to be allocated and initialized.
|
1590
|
+
As these can be both relatively large, you may not want to store these
|
1591
|
+
on the stack, unless you have stack space to spare. Of course, you
|
1592
|
+
will want to check if they return NULL. If you are also reading,
|
1593
|
+
you won't want to name your read structure and your write structure
|
1594
|
+
both "png_ptr"; you can call them anything you like, such as
|
1595
|
+
"read_ptr" and "write_ptr". Look at pngtest.c, for example.
|
1596
|
+
|
1597
|
+
png_structp png_ptr = png_create_write_struct
|
1598
|
+
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
|
1599
|
+
user_error_fn, user_warning_fn);
|
1600
|
+
if (!png_ptr)
|
1601
|
+
return (ERROR);
|
1602
|
+
|
1603
|
+
png_infop info_ptr = png_create_info_struct(png_ptr);
|
1604
|
+
if (!info_ptr)
|
1605
|
+
{
|
1606
|
+
png_destroy_write_struct(&png_ptr,
|
1607
|
+
(png_infopp)NULL);
|
1608
|
+
return (ERROR);
|
1609
|
+
}
|
1610
|
+
|
1611
|
+
If you want to use your own memory allocation routines,
|
1612
|
+
define PNG_USER_MEM_SUPPORTED and use
|
1613
|
+
png_create_write_struct_2() instead of png_create_write_struct():
|
1614
|
+
|
1615
|
+
png_structp png_ptr = png_create_write_struct_2
|
1616
|
+
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
|
1617
|
+
user_error_fn, user_warning_fn, (png_voidp)
|
1618
|
+
user_mem_ptr, user_malloc_fn, user_free_fn);
|
1619
|
+
|
1620
|
+
After you have these structures, you will need to set up the
|
1621
|
+
error handling. When libpng encounters an error, it expects to
|
1622
|
+
longjmp() back to your routine. Therefore, you will need to call
|
1623
|
+
setjmp() and pass the png_jmpbuf(png_ptr). If you
|
1624
|
+
write the file from different routines, you will need to update
|
1625
|
+
the png_jmpbuf(png_ptr) every time you enter a new routine that will
|
1626
|
+
call a png_*() function. See your documentation of setjmp/longjmp
|
1627
|
+
for your compiler for more information on setjmp/longjmp. See
|
1628
|
+
the discussion on libpng error handling in the Customizing Libpng
|
1629
|
+
section below for more information on the libpng error handling.
|
1630
|
+
|
1631
|
+
if (setjmp(png_jmpbuf(png_ptr)))
|
1632
|
+
{
|
1633
|
+
png_destroy_write_struct(&png_ptr, &info_ptr);
|
1634
|
+
fclose(fp);
|
1635
|
+
return (ERROR);
|
1636
|
+
}
|
1637
|
+
...
|
1638
|
+
return;
|
1639
|
+
|
1640
|
+
If you would rather avoid the complexity of setjmp/longjmp issues,
|
1641
|
+
you can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in which case
|
1642
|
+
errors will result in a call to PNG_ABORT() which defaults to abort().
|
1643
|
+
|
1644
|
+
Now you need to set up the output code. The default for libpng is to
|
1645
|
+
use the C function fwrite(). If you use this, you will need to pass a
|
1646
|
+
valid FILE * in the function png_init_io(). Be sure that the file is
|
1647
|
+
opened in binary mode. Again, if you wish to handle writing data in
|
1648
|
+
another way, see the discussion on libpng I/O handling in the Customizing
|
1649
|
+
Libpng section below.
|
1650
|
+
|
1651
|
+
png_init_io(png_ptr, fp);
|
1652
|
+
|
1653
|
+
If you are embedding your PNG into a datastream such as MNG, and don't
|
1654
|
+
want libpng to write the 8-byte signature, or if you have already
|
1655
|
+
written the signature in your application, use
|
1656
|
+
|
1657
|
+
png_set_sig_bytes(png_ptr, 8);
|
1658
|
+
|
1659
|
+
to inform libpng that it should not write a signature.
|
1660
|
+
|
1661
|
+
Write callbacks
|
1662
|
+
|
1663
|
+
At this point, you can set up a callback function that will be
|
1664
|
+
called after each row has been written, which you can use to control
|
1665
|
+
a progress meter or the like. It's demonstrated in pngtest.c.
|
1666
|
+
You must supply a function
|
1667
|
+
|
1668
|
+
void write_row_callback(png_ptr, png_uint_32 row,
|
1669
|
+
int pass);
|
1670
|
+
{
|
1671
|
+
/* put your code here */
|
1672
|
+
}
|
1673
|
+
|
1674
|
+
(You can give it another name that you like instead of "write_row_callback")
|
1675
|
+
|
1676
|
+
To inform libpng about your function, use
|
1677
|
+
|
1678
|
+
png_set_write_status_fn(png_ptr, write_row_callback);
|
1679
|
+
|
1680
|
+
You now have the option of modifying how the compression library will
|
1681
|
+
run. The following functions are mainly for testing, but may be useful
|
1682
|
+
in some cases, like if you need to write PNG files extremely fast and
|
1683
|
+
are willing to give up some compression, or if you want to get the
|
1684
|
+
maximum possible compression at the expense of slower writing. If you
|
1685
|
+
have no special needs in this area, let the library do what it wants by
|
1686
|
+
not calling this function at all, as it has been tuned to deliver a good
|
1687
|
+
speed/compression ratio. The second parameter to png_set_filter() is
|
1688
|
+
the filter method, for which the only valid values are 0 (as of the
|
1689
|
+
July 1999 PNG specification, version 1.2) or 64 (if you are writing
|
1690
|
+
a PNG datastream that is to be embedded in a MNG datastream). The third
|
1691
|
+
parameter is a flag that indicates which filter type(s) are to be tested
|
1692
|
+
for each scanline. See the PNG specification for details on the specific filter
|
1693
|
+
types.
|
1694
|
+
|
1695
|
+
|
1696
|
+
/* turn on or off filtering, and/or choose
|
1697
|
+
specific filters. You can use either a single
|
1698
|
+
PNG_FILTER_VALUE_NAME or the bitwise OR of one
|
1699
|
+
or more PNG_FILTER_NAME masks. */
|
1700
|
+
png_set_filter(png_ptr, 0,
|
1701
|
+
PNG_FILTER_NONE | PNG_FILTER_VALUE_NONE |
|
1702
|
+
PNG_FILTER_SUB | PNG_FILTER_VALUE_SUB |
|
1703
|
+
PNG_FILTER_UP | PNG_FILTER_VALUE_UP |
|
1704
|
+
PNG_FILTER_AVE | PNG_FILTER_VALUE_AVE |
|
1705
|
+
PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
|
1706
|
+
PNG_ALL_FILTERS);
|
1707
|
+
|
1708
|
+
If an application
|
1709
|
+
wants to start and stop using particular filters during compression,
|
1710
|
+
it should start out with all of the filters (to ensure that the previous
|
1711
|
+
row of pixels will be stored in case it's needed later), and then add
|
1712
|
+
and remove them after the start of compression.
|
1713
|
+
|
1714
|
+
If you are writing a PNG datastream that is to be embedded in a MNG
|
1715
|
+
datastream, the second parameter can be either 0 or 64.
|
1716
|
+
|
1717
|
+
The png_set_compression_*() functions interface to the zlib compression
|
1718
|
+
library, and should mostly be ignored unless you really know what you are
|
1719
|
+
doing. The only generally useful call is png_set_compression_level()
|
1720
|
+
which changes how much time zlib spends on trying to compress the image
|
1721
|
+
data. See the Compression Library (zlib.h and algorithm.txt, distributed
|
1722
|
+
with zlib) for details on the compression levels.
|
1723
|
+
|
1724
|
+
/* set the zlib compression level */
|
1725
|
+
png_set_compression_level(png_ptr,
|
1726
|
+
Z_BEST_COMPRESSION);
|
1727
|
+
|
1728
|
+
/* set other zlib parameters */
|
1729
|
+
png_set_compression_mem_level(png_ptr, 8);
|
1730
|
+
png_set_compression_strategy(png_ptr,
|
1731
|
+
Z_DEFAULT_STRATEGY);
|
1732
|
+
png_set_compression_window_bits(png_ptr, 15);
|
1733
|
+
png_set_compression_method(png_ptr, 8);
|
1734
|
+
png_set_compression_buffer_size(png_ptr, 8192)
|
1735
|
+
|
1736
|
+
extern PNG_EXPORT(void,png_set_zbuf_size)
|
1737
|
+
|
1738
|
+
Setting the contents of info for output
|
1739
|
+
|
1740
|
+
You now need to fill in the png_info structure with all the data you
|
1741
|
+
wish to write before the actual image. Note that the only thing you
|
1742
|
+
are allowed to write after the image is the text chunks and the time
|
1743
|
+
chunk (as of PNG Specification 1.2, anyway). See png_write_end() and
|
1744
|
+
the latest PNG specification for more information on that. If you
|
1745
|
+
wish to write them before the image, fill them in now, and flag that
|
1746
|
+
data as being valid. If you want to wait until after the data, don't
|
1747
|
+
fill them until png_write_end(). For all the fields in png_info and
|
1748
|
+
their data types, see png.h. For explanations of what the fields
|
1749
|
+
contain, see the PNG specification.
|
1750
|
+
|
1751
|
+
Some of the more important parts of the png_info are:
|
1752
|
+
|
1753
|
+
png_set_IHDR(png_ptr, info_ptr, width, height,
|
1754
|
+
bit_depth, color_type, interlace_type,
|
1755
|
+
compression_type, filter_method)
|
1756
|
+
width - holds the width of the image
|
1757
|
+
in pixels (up to 2^31).
|
1758
|
+
height - holds the height of the image
|
1759
|
+
in pixels (up to 2^31).
|
1760
|
+
bit_depth - holds the bit depth of one of the
|
1761
|
+
image channels.
|
1762
|
+
(valid values are 1, 2, 4, 8, 16
|
1763
|
+
and depend also on the
|
1764
|
+
color_type. See also significant
|
1765
|
+
bits (sBIT) below).
|
1766
|
+
color_type - describes which color/alpha
|
1767
|
+
channels are present.
|
1768
|
+
PNG_COLOR_TYPE_GRAY
|
1769
|
+
(bit depths 1, 2, 4, 8, 16)
|
1770
|
+
PNG_COLOR_TYPE_GRAY_ALPHA
|
1771
|
+
(bit depths 8, 16)
|
1772
|
+
PNG_COLOR_TYPE_PALETTE
|
1773
|
+
(bit depths 1, 2, 4, 8)
|
1774
|
+
PNG_COLOR_TYPE_RGB
|
1775
|
+
(bit_depths 8, 16)
|
1776
|
+
PNG_COLOR_TYPE_RGB_ALPHA
|
1777
|
+
(bit_depths 8, 16)
|
1778
|
+
|
1779
|
+
PNG_COLOR_MASK_PALETTE
|
1780
|
+
PNG_COLOR_MASK_COLOR
|
1781
|
+
PNG_COLOR_MASK_ALPHA
|
1782
|
+
|
1783
|
+
interlace_type - PNG_INTERLACE_NONE or
|
1784
|
+
PNG_INTERLACE_ADAM7
|
1785
|
+
compression_type - (must be
|
1786
|
+
PNG_COMPRESSION_TYPE_DEFAULT)
|
1787
|
+
filter_method - (must be PNG_FILTER_TYPE_DEFAULT
|
1788
|
+
or, if you are writing a PNG to
|
1789
|
+
be embedded in a MNG datastream,
|
1790
|
+
can also be
|
1791
|
+
PNG_INTRAPIXEL_DIFFERENCING)
|
1792
|
+
|
1793
|
+
If you call png_set_IHDR(), the call must appear before any of the
|
1794
|
+
other png_set_*() functions, which might require access to some of
|
1795
|
+
the IHDR settings. The remaining png_set_*() functions can be called
|
1796
|
+
in any order.
|
1797
|
+
|
1798
|
+
png_set_PLTE(png_ptr, info_ptr, palette,
|
1799
|
+
num_palette);
|
1800
|
+
palette - the palette for the file
|
1801
|
+
(array of png_color)
|
1802
|
+
num_palette - number of entries in the palette
|
1803
|
+
|
1804
|
+
png_set_gAMA(png_ptr, info_ptr, gamma);
|
1805
|
+
gamma - the gamma the image was created
|
1806
|
+
at (PNG_INFO_gAMA)
|
1807
|
+
|
1808
|
+
png_set_sRGB(png_ptr, info_ptr, srgb_intent);
|
1809
|
+
srgb_intent - the rendering intent
|
1810
|
+
(PNG_INFO_sRGB) The presence of
|
1811
|
+
the sRGB chunk means that the pixel
|
1812
|
+
data is in the sRGB color space.
|
1813
|
+
This chunk also implies specific
|
1814
|
+
values of gAMA and cHRM. Rendering
|
1815
|
+
intent is the CSS-1 property that
|
1816
|
+
has been defined by the International
|
1817
|
+
Color Consortium
|
1818
|
+
(http://www.color.org).
|
1819
|
+
It can be one of
|
1820
|
+
PNG_sRGB_INTENT_SATURATION,
|
1821
|
+
PNG_sRGB_INTENT_PERCEPTUAL,
|
1822
|
+
PNG_sRGB_INTENT_ABSOLUTE, or
|
1823
|
+
PNG_sRGB_INTENT_RELATIVE.
|
1824
|
+
|
1825
|
+
|
1826
|
+
png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr,
|
1827
|
+
srgb_intent);
|
1828
|
+
srgb_intent - the rendering intent
|
1829
|
+
(PNG_INFO_sRGB) The presence of the
|
1830
|
+
sRGB chunk means that the pixel
|
1831
|
+
data is in the sRGB color space.
|
1832
|
+
This function also causes gAMA and
|
1833
|
+
cHRM chunks with the specific values
|
1834
|
+
that are consistent with sRGB to be
|
1835
|
+
written.
|
1836
|
+
|
1837
|
+
png_set_iCCP(png_ptr, info_ptr, name, compression_type,
|
1838
|
+
profile, proflen);
|
1839
|
+
name - The profile name.
|
1840
|
+
compression - The compression type; always
|
1841
|
+
PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
|
1842
|
+
You may give NULL to this argument to
|
1843
|
+
ignore it.
|
1844
|
+
profile - International Color Consortium color
|
1845
|
+
profile data. May contain NULs.
|
1846
|
+
proflen - length of profile data in bytes.
|
1847
|
+
|
1848
|
+
png_set_sBIT(png_ptr, info_ptr, sig_bit);
|
1849
|
+
sig_bit - the number of significant bits for
|
1850
|
+
(PNG_INFO_sBIT) each of the gray, red,
|
1851
|
+
green, and blue channels, whichever are
|
1852
|
+
appropriate for the given color type
|
1853
|
+
(png_color_16)
|
1854
|
+
|
1855
|
+
png_set_tRNS(png_ptr, info_ptr, trans, num_trans,
|
1856
|
+
trans_values);
|
1857
|
+
trans - array of transparent entries for
|
1858
|
+
palette (PNG_INFO_tRNS)
|
1859
|
+
trans_values - graylevel or color sample values of
|
1860
|
+
the single transparent color for
|
1861
|
+
non-paletted images (PNG_INFO_tRNS)
|
1862
|
+
num_trans - number of transparent entries
|
1863
|
+
(PNG_INFO_tRNS)
|
1864
|
+
|
1865
|
+
png_set_hIST(png_ptr, info_ptr, hist);
|
1866
|
+
(PNG_INFO_hIST)
|
1867
|
+
hist - histogram of palette (array of
|
1868
|
+
png_uint_16)
|
1869
|
+
|
1870
|
+
png_set_tIME(png_ptr, info_ptr, mod_time);
|
1871
|
+
mod_time - time image was last modified
|
1872
|
+
(PNG_VALID_tIME)
|
1873
|
+
|
1874
|
+
png_set_bKGD(png_ptr, info_ptr, background);
|
1875
|
+
background - background color (PNG_VALID_bKGD)
|
1876
|
+
|
1877
|
+
png_set_text(png_ptr, info_ptr, text_ptr, num_text);
|
1878
|
+
text_ptr - array of png_text holding image
|
1879
|
+
comments
|
1880
|
+
text_ptr[i].compression - type of compression used
|
1881
|
+
on "text" PNG_TEXT_COMPRESSION_NONE
|
1882
|
+
PNG_TEXT_COMPRESSION_zTXt
|
1883
|
+
PNG_ITXT_COMPRESSION_NONE
|
1884
|
+
PNG_ITXT_COMPRESSION_zTXt
|
1885
|
+
text_ptr[i].key - keyword for comment. Must contain
|
1886
|
+
1-79 characters.
|
1887
|
+
text_ptr[i].text - text comments for current
|
1888
|
+
keyword. Can be NULL or empty.
|
1889
|
+
text_ptr[i].text_length - length of text string,
|
1890
|
+
after decompression, 0 for iTXt
|
1891
|
+
text_ptr[i].itxt_length - length of itxt string,
|
1892
|
+
after decompression, 0 for tEXt/zTXt
|
1893
|
+
text_ptr[i].lang - language of comment (NULL or
|
1894
|
+
empty for unknown).
|
1895
|
+
text_ptr[i].translated_keyword - keyword in UTF-8 (NULL
|
1896
|
+
or empty for unknown).
|
1897
|
+
num_text - number of comments
|
1898
|
+
|
1899
|
+
png_set_sPLT(png_ptr, info_ptr, &palette_ptr,
|
1900
|
+
num_spalettes);
|
1901
|
+
palette_ptr - array of png_sPLT_struct structures
|
1902
|
+
to be added to the list of palettes
|
1903
|
+
in the info structure.
|
1904
|
+
num_spalettes - number of palette structures to be
|
1905
|
+
added.
|
1906
|
+
|
1907
|
+
png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y,
|
1908
|
+
unit_type);
|
1909
|
+
offset_x - positive offset from the left
|
1910
|
+
edge of the screen
|
1911
|
+
offset_y - positive offset from the top
|
1912
|
+
edge of the screen
|
1913
|
+
unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
|
1914
|
+
|
1915
|
+
png_set_pHYs(png_ptr, info_ptr, res_x, res_y,
|
1916
|
+
unit_type);
|
1917
|
+
res_x - pixels/unit physical resolution
|
1918
|
+
in x direction
|
1919
|
+
res_y - pixels/unit physical resolution
|
1920
|
+
in y direction
|
1921
|
+
unit_type - PNG_RESOLUTION_UNKNOWN,
|
1922
|
+
PNG_RESOLUTION_METER
|
1923
|
+
|
1924
|
+
png_set_sCAL(png_ptr, info_ptr, unit, width, height)
|
1925
|
+
unit - physical scale units (an integer)
|
1926
|
+
width - width of a pixel in physical scale units
|
1927
|
+
height - height of a pixel in physical scale units
|
1928
|
+
(width and height are doubles)
|
1929
|
+
|
1930
|
+
png_set_sCAL_s(png_ptr, info_ptr, unit, width, height)
|
1931
|
+
unit - physical scale units (an integer)
|
1932
|
+
width - width of a pixel in physical scale units
|
1933
|
+
height - height of a pixel in physical scale units
|
1934
|
+
(width and height are strings like "2.54")
|
1935
|
+
|
1936
|
+
png_set_unknown_chunks(png_ptr, info_ptr, &unknowns,
|
1937
|
+
num_unknowns)
|
1938
|
+
unknowns - array of png_unknown_chunk
|
1939
|
+
structures holding unknown chunks
|
1940
|
+
unknowns[i].name - name of unknown chunk
|
1941
|
+
unknowns[i].data - data of unknown chunk
|
1942
|
+
unknowns[i].size - size of unknown chunk's data
|
1943
|
+
unknowns[i].location - position to write chunk in file
|
1944
|
+
0: do not write chunk
|
1945
|
+
PNG_HAVE_IHDR: before PLTE
|
1946
|
+
PNG_HAVE_PLTE: before IDAT
|
1947
|
+
PNG_AFTER_IDAT: after IDAT
|
1948
|
+
|
1949
|
+
The "location" member is set automatically according to
|
1950
|
+
what part of the output file has already been written.
|
1951
|
+
You can change its value after calling png_set_unknown_chunks()
|
1952
|
+
as demonstrated in pngtest.c. Within each of the "locations",
|
1953
|
+
the chunks are sequenced according to their position in the
|
1954
|
+
structure (that is, the value of "i", which is the order in which
|
1955
|
+
the chunk was either read from the input file or defined with
|
1956
|
+
png_set_unknown_chunks).
|
1957
|
+
|
1958
|
+
A quick word about text and num_text. text is an array of png_text
|
1959
|
+
structures. num_text is the number of valid structures in the array.
|
1960
|
+
Each png_text structure holds a language code, a keyword, a text value,
|
1961
|
+
and a compression type.
|
1962
|
+
|
1963
|
+
The compression types have the same valid numbers as the compression
|
1964
|
+
types of the image data. Currently, the only valid number is zero.
|
1965
|
+
However, you can store text either compressed or uncompressed, unlike
|
1966
|
+
images, which always have to be compressed. So if you don't want the
|
1967
|
+
text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE.
|
1968
|
+
Because tEXt and zTXt chunks don't have a language field, if you
|
1969
|
+
specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt
|
1970
|
+
any language code or translated keyword will not be written out.
|
1971
|
+
|
1972
|
+
Until text gets around 1000 bytes, it is not worth compressing it.
|
1973
|
+
After the text has been written out to the file, the compression type
|
1974
|
+
is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR,
|
1975
|
+
so that it isn't written out again at the end (in case you are calling
|
1976
|
+
png_write_end() with the same struct.
|
1977
|
+
|
1978
|
+
The keywords that are given in the PNG Specification are:
|
1979
|
+
|
1980
|
+
Title Short (one line) title or
|
1981
|
+
caption for image
|
1982
|
+
Author Name of image's creator
|
1983
|
+
Description Description of image (possibly long)
|
1984
|
+
Copyright Copyright notice
|
1985
|
+
Creation Time Time of original image creation
|
1986
|
+
(usually RFC 1123 format, see below)
|
1987
|
+
Software Software used to create the image
|
1988
|
+
Disclaimer Legal disclaimer
|
1989
|
+
Warning Warning of nature of content
|
1990
|
+
Source Device used to create the image
|
1991
|
+
Comment Miscellaneous comment; conversion
|
1992
|
+
from other image format
|
1993
|
+
|
1994
|
+
The keyword-text pairs work like this. Keywords should be short
|
1995
|
+
simple descriptions of what the comment is about. Some typical
|
1996
|
+
keywords are found in the PNG specification, as is some recommendations
|
1997
|
+
on keywords. You can repeat keywords in a file. You can even write
|
1998
|
+
some text before the image and some after. For example, you may want
|
1999
|
+
to put a description of the image before the image, but leave the
|
2000
|
+
disclaimer until after, so viewers working over modem connections
|
2001
|
+
don't have to wait for the disclaimer to go over the modem before
|
2002
|
+
they start seeing the image. Finally, keywords should be full
|
2003
|
+
words, not abbreviations. Keywords and text are in the ISO 8859-1
|
2004
|
+
(Latin-1) character set (a superset of regular ASCII) and can not
|
2005
|
+
contain NUL characters, and should not contain control or other
|
2006
|
+
unprintable characters. To make the comments widely readable, stick
|
2007
|
+
with basic ASCII, and avoid machine specific character set extensions
|
2008
|
+
like the IBM-PC character set. The keyword must be present, but
|
2009
|
+
you can leave off the text string on non-compressed pairs.
|
2010
|
+
Compressed pairs must have a text string, as only the text string
|
2011
|
+
is compressed anyway, so the compression would be meaningless.
|
2012
|
+
|
2013
|
+
PNG supports modification time via the png_time structure. Two
|
2014
|
+
conversion routines are provided, png_convert_from_time_t() for
|
2015
|
+
time_t and png_convert_from_struct_tm() for struct tm. The
|
2016
|
+
time_t routine uses gmtime(). You don't have to use either of
|
2017
|
+
these, but if you wish to fill in the png_time structure directly,
|
2018
|
+
you should provide the time in universal time (GMT) if possible
|
2019
|
+
instead of your local time. Note that the year number is the full
|
2020
|
+
year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and
|
2021
|
+
that months start with 1.
|
2022
|
+
|
2023
|
+
If you want to store the time of the original image creation, you should
|
2024
|
+
use a plain tEXt chunk with the "Creation Time" keyword. This is
|
2025
|
+
necessary because the "creation time" of a PNG image is somewhat vague,
|
2026
|
+
depending on whether you mean the PNG file, the time the image was
|
2027
|
+
created in a non-PNG format, a still photo from which the image was
|
2028
|
+
scanned, or possibly the subject matter itself. In order to facilitate
|
2029
|
+
machine-readable dates, it is recommended that the "Creation Time"
|
2030
|
+
tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"),
|
2031
|
+
although this isn't a requirement. Unlike the tIME chunk, the
|
2032
|
+
"Creation Time" tEXt chunk is not expected to be automatically changed
|
2033
|
+
by the software. To facilitate the use of RFC 1123 dates, a function
|
2034
|
+
png_convert_to_rfc1123(png_timep) is provided to convert from PNG
|
2035
|
+
time to an RFC 1123 format string.
|
2036
|
+
|
2037
|
+
Writing unknown chunks
|
2038
|
+
|
2039
|
+
You can use the png_set_unknown_chunks function to queue up chunks
|
2040
|
+
for writing. You give it a chunk name, raw data, and a size; that's
|
2041
|
+
all there is to it. The chunks will be written by the next following
|
2042
|
+
png_write_info_before_PLTE, png_write_info, or png_write_end function.
|
2043
|
+
Any chunks previously read into the info structure's unknown-chunk
|
2044
|
+
list will also be written out in a sequence that satisfies the PNG
|
2045
|
+
specification's ordering rules.
|
2046
|
+
|
2047
|
+
The high-level write interface
|
2048
|
+
|
2049
|
+
At this point there are two ways to proceed; through the high-level
|
2050
|
+
write interface, or through a sequence of low-level write operations.
|
2051
|
+
You can use the high-level interface if your image data is present
|
2052
|
+
in the info structure. All defined output
|
2053
|
+
transformations are permitted, enabled by the following masks.
|
2054
|
+
|
2055
|
+
PNG_TRANSFORM_IDENTITY No transformation
|
2056
|
+
PNG_TRANSFORM_PACKING Pack 1, 2 and 4-bit samples
|
2057
|
+
PNG_TRANSFORM_PACKSWAP Change order of packed
|
2058
|
+
pixels to LSB first
|
2059
|
+
PNG_TRANSFORM_INVERT_MONO Invert monochrome images
|
2060
|
+
PNG_TRANSFORM_SHIFT Normalize pixels to the
|
2061
|
+
sBIT depth
|
2062
|
+
PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA
|
2063
|
+
to BGRA
|
2064
|
+
PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA
|
2065
|
+
to AG
|
2066
|
+
PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity
|
2067
|
+
to transparency
|
2068
|
+
PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples
|
2069
|
+
PNG_TRANSFORM_STRIP_FILLER Strip out filler bytes.
|
2070
|
+
|
2071
|
+
If you have valid image data in the info structure (you can use
|
2072
|
+
png_set_rows() to put image data in the info structure), simply do this:
|
2073
|
+
|
2074
|
+
png_write_png(png_ptr, info_ptr, png_transforms, NULL)
|
2075
|
+
|
2076
|
+
where png_transforms is an integer containing the bitwise OR of some set of
|
2077
|
+
transformation flags. This call is equivalent to png_write_info(),
|
2078
|
+
followed the set of transformations indicated by the transform mask,
|
2079
|
+
then png_write_image(), and finally png_write_end().
|
2080
|
+
|
2081
|
+
(The final parameter of this call is not yet used. Someday it might point
|
2082
|
+
to transformation parameters required by some future output transform.)
|
2083
|
+
|
2084
|
+
You must use png_transforms and not call any png_set_transform() functions
|
2085
|
+
when you use png_write_png().
|
2086
|
+
|
2087
|
+
The low-level write interface
|
2088
|
+
|
2089
|
+
If you are going the low-level route instead, you are now ready to
|
2090
|
+
write all the file information up to the actual image data. You do
|
2091
|
+
this with a call to png_write_info().
|
2092
|
+
|
2093
|
+
png_write_info(png_ptr, info_ptr);
|
2094
|
+
|
2095
|
+
Note that there is one transformation you may need to do before
|
2096
|
+
png_write_info(). In PNG files, the alpha channel in an image is the
|
2097
|
+
level of opacity. If your data is supplied as a level of
|
2098
|
+
transparency, you can invert the alpha channel before you write it, so
|
2099
|
+
that 0 is fully transparent and 255 (in 8-bit or paletted images) or
|
2100
|
+
65535 (in 16-bit images) is fully opaque, with
|
2101
|
+
|
2102
|
+
png_set_invert_alpha(png_ptr);
|
2103
|
+
|
2104
|
+
This must appear before png_write_info() instead of later with the
|
2105
|
+
other transformations because in the case of paletted images the tRNS
|
2106
|
+
chunk data has to be inverted before the tRNS chunk is written. If
|
2107
|
+
your image is not a paletted image, the tRNS data (which in such cases
|
2108
|
+
represents a single color to be rendered as transparent) won't need to
|
2109
|
+
be changed, and you can safely do this transformation after your
|
2110
|
+
png_write_info() call.
|
2111
|
+
|
2112
|
+
If you need to write a private chunk that you want to appear before
|
2113
|
+
the PLTE chunk when PLTE is present, you can write the PNG info in
|
2114
|
+
two steps, and insert code to write your own chunk between them:
|
2115
|
+
|
2116
|
+
png_write_info_before_PLTE(png_ptr, info_ptr);
|
2117
|
+
png_set_unknown_chunks(png_ptr, info_ptr, ...);
|
2118
|
+
png_write_info(png_ptr, info_ptr);
|
2119
|
+
|
2120
|
+
After you've written the file information, you can set up the library
|
2121
|
+
to handle any special transformations of the image data. The various
|
2122
|
+
ways to transform the data will be described in the order that they
|
2123
|
+
should occur. This is important, as some of these change the color
|
2124
|
+
type and/or bit depth of the data, and some others only work on
|
2125
|
+
certain color types and bit depths. Even though each transformation
|
2126
|
+
checks to see if it has data that it can do something with, you should
|
2127
|
+
make sure to only enable a transformation if it will be valid for the
|
2128
|
+
data. For example, don't swap red and blue on grayscale data.
|
2129
|
+
|
2130
|
+
PNG files store RGB pixels packed into 3 or 6 bytes. This code tells
|
2131
|
+
the library to strip input data that has 4 or 8 bytes per pixel down
|
2132
|
+
to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2
|
2133
|
+
bytes per pixel).
|
2134
|
+
|
2135
|
+
png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
|
2136
|
+
|
2137
|
+
where the 0 is unused, and the location is either PNG_FILLER_BEFORE or
|
2138
|
+
PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel
|
2139
|
+
is stored XRGB or RGBX.
|
2140
|
+
|
2141
|
+
PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
|
2142
|
+
they can, resulting in, for example, 8 pixels per byte for 1 bit files.
|
2143
|
+
If the data is supplied at 1 pixel per byte, use this code, which will
|
2144
|
+
correctly pack the pixels into a single byte:
|
2145
|
+
|
2146
|
+
png_set_packing(png_ptr);
|
2147
|
+
|
2148
|
+
PNG files reduce possible bit depths to 1, 2, 4, 8, and 16. If your
|
2149
|
+
data is of another bit depth, you can write an sBIT chunk into the
|
2150
|
+
file so that decoders can recover the original data if desired.
|
2151
|
+
|
2152
|
+
/* Set the true bit depth of the image data */
|
2153
|
+
if (color_type & PNG_COLOR_MASK_COLOR)
|
2154
|
+
{
|
2155
|
+
sig_bit.red = true_bit_depth;
|
2156
|
+
sig_bit.green = true_bit_depth;
|
2157
|
+
sig_bit.blue = true_bit_depth;
|
2158
|
+
}
|
2159
|
+
else
|
2160
|
+
{
|
2161
|
+
sig_bit.gray = true_bit_depth;
|
2162
|
+
}
|
2163
|
+
if (color_type & PNG_COLOR_MASK_ALPHA)
|
2164
|
+
{
|
2165
|
+
sig_bit.alpha = true_bit_depth;
|
2166
|
+
}
|
2167
|
+
|
2168
|
+
png_set_sBIT(png_ptr, info_ptr, &sig_bit);
|
2169
|
+
|
2170
|
+
If the data is stored in the row buffer in a bit depth other than
|
2171
|
+
one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG),
|
2172
|
+
this will scale the values to appear to be the correct bit depth as
|
2173
|
+
is required by PNG.
|
2174
|
+
|
2175
|
+
png_set_shift(png_ptr, &sig_bit);
|
2176
|
+
|
2177
|
+
PNG files store 16 bit pixels in network byte order (big-endian,
|
2178
|
+
ie. most significant bits first). This code would be used if they are
|
2179
|
+
supplied the other way (little-endian, i.e. least significant bits
|
2180
|
+
first, the way PCs store them):
|
2181
|
+
|
2182
|
+
if (bit_depth > 8)
|
2183
|
+
png_set_swap(png_ptr);
|
2184
|
+
|
2185
|
+
If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
|
2186
|
+
need to change the order the pixels are packed into bytes, you can use:
|
2187
|
+
|
2188
|
+
if (bit_depth < 8)
|
2189
|
+
png_set_packswap(png_ptr);
|
2190
|
+
|
2191
|
+
PNG files store 3 color pixels in red, green, blue order. This code
|
2192
|
+
would be used if they are supplied as blue, green, red:
|
2193
|
+
|
2194
|
+
png_set_bgr(png_ptr);
|
2195
|
+
|
2196
|
+
PNG files describe monochrome as black being zero and white being
|
2197
|
+
one. This code would be used if the pixels are supplied with this reversed
|
2198
|
+
(black being one and white being zero):
|
2199
|
+
|
2200
|
+
png_set_invert_mono(png_ptr);
|
2201
|
+
|
2202
|
+
Finally, you can write your own transformation function if none of
|
2203
|
+
the existing ones meets your needs. This is done by setting a callback
|
2204
|
+
with
|
2205
|
+
|
2206
|
+
png_set_write_user_transform_fn(png_ptr,
|
2207
|
+
write_transform_fn);
|
2208
|
+
|
2209
|
+
You must supply the function
|
2210
|
+
|
2211
|
+
void write_transform_fn(png_ptr ptr, row_info_ptr
|
2212
|
+
row_info, png_bytep data)
|
2213
|
+
|
2214
|
+
See pngtest.c for a working example. Your function will be called
|
2215
|
+
before any of the other transformations are processed.
|
2216
|
+
|
2217
|
+
You can also set up a pointer to a user structure for use by your
|
2218
|
+
callback function.
|
2219
|
+
|
2220
|
+
png_set_user_transform_info(png_ptr, user_ptr, 0, 0);
|
2221
|
+
|
2222
|
+
The user_channels and user_depth parameters of this function are ignored
|
2223
|
+
when writing; you can set them to zero as shown.
|
2224
|
+
|
2225
|
+
You can retrieve the pointer via the function png_get_user_transform_ptr().
|
2226
|
+
For example:
|
2227
|
+
|
2228
|
+
voidp write_user_transform_ptr =
|
2229
|
+
png_get_user_transform_ptr(png_ptr);
|
2230
|
+
|
2231
|
+
It is possible to have libpng flush any pending output, either manually,
|
2232
|
+
or automatically after a certain number of lines have been written. To
|
2233
|
+
flush the output stream a single time call:
|
2234
|
+
|
2235
|
+
png_write_flush(png_ptr);
|
2236
|
+
|
2237
|
+
and to have libpng flush the output stream periodically after a certain
|
2238
|
+
number of scanlines have been written, call:
|
2239
|
+
|
2240
|
+
png_set_flush(png_ptr, nrows);
|
2241
|
+
|
2242
|
+
Note that the distance between rows is from the last time png_write_flush()
|
2243
|
+
was called, or the first row of the image if it has never been called.
|
2244
|
+
So if you write 50 lines, and then png_set_flush 25, it will flush the
|
2245
|
+
output on the next scanline, and every 25 lines thereafter, unless
|
2246
|
+
png_write_flush() is called before 25 more lines have been written.
|
2247
|
+
If nrows is too small (less than about 10 lines for a 640 pixel wide
|
2248
|
+
RGB image) the image compression may decrease noticeably (although this
|
2249
|
+
may be acceptable for real-time applications). Infrequent flushing will
|
2250
|
+
only degrade the compression performance by a few percent over images
|
2251
|
+
that do not use flushing.
|
2252
|
+
|
2253
|
+
Writing the image data
|
2254
|
+
|
2255
|
+
That's it for the transformations. Now you can write the image data.
|
2256
|
+
The simplest way to do this is in one function call. If you have the
|
2257
|
+
whole image in memory, you can just call png_write_image() and libpng
|
2258
|
+
will write the image. You will need to pass in an array of pointers to
|
2259
|
+
each row. This function automatically handles interlacing, so you don't
|
2260
|
+
need to call png_set_interlace_handling() or call this function multiple
|
2261
|
+
times, or any of that other stuff necessary with png_write_rows().
|
2262
|
+
|
2263
|
+
png_write_image(png_ptr, row_pointers);
|
2264
|
+
|
2265
|
+
where row_pointers is:
|
2266
|
+
|
2267
|
+
png_byte *row_pointers[height];
|
2268
|
+
|
2269
|
+
You can point to void or char or whatever you use for pixels.
|
2270
|
+
|
2271
|
+
If you don't want to write the whole image at once, you can
|
2272
|
+
use png_write_rows() instead. If the file is not interlaced,
|
2273
|
+
this is simple:
|
2274
|
+
|
2275
|
+
png_write_rows(png_ptr, row_pointers,
|
2276
|
+
number_of_rows);
|
2277
|
+
|
2278
|
+
row_pointers is the same as in the png_write_image() call.
|
2279
|
+
|
2280
|
+
If you are just writing one row at a time, you can do this with
|
2281
|
+
a single row_pointer instead of an array of row_pointers:
|
2282
|
+
|
2283
|
+
png_bytep row_pointer = row;
|
2284
|
+
|
2285
|
+
png_write_row(png_ptr, row_pointer);
|
2286
|
+
|
2287
|
+
When the file is interlaced, things can get a good deal more
|
2288
|
+
complicated. The only currently (as of the PNG Specification
|
2289
|
+
version 1.2, dated July 1999) defined interlacing scheme for PNG files
|
2290
|
+
is the "Adam7" interlace scheme, that breaks down an
|
2291
|
+
image into seven smaller images of varying size. libpng will build
|
2292
|
+
these images for you, or you can do them yourself. If you want to
|
2293
|
+
build them yourself, see the PNG specification for details of which
|
2294
|
+
pixels to write when.
|
2295
|
+
|
2296
|
+
If you don't want libpng to handle the interlacing details, just
|
2297
|
+
use png_set_interlace_handling() and call png_write_rows() the
|
2298
|
+
correct number of times to write all seven sub-images.
|
2299
|
+
|
2300
|
+
If you want libpng to build the sub-images, call this before you start
|
2301
|
+
writing any rows:
|
2302
|
+
|
2303
|
+
number_of_passes =
|
2304
|
+
png_set_interlace_handling(png_ptr);
|
2305
|
+
|
2306
|
+
This will return the number of passes needed. Currently, this
|
2307
|
+
is seven, but may change if another interlace type is added.
|
2308
|
+
|
2309
|
+
Then write the complete image number_of_passes times.
|
2310
|
+
|
2311
|
+
png_write_rows(png_ptr, row_pointers,
|
2312
|
+
number_of_rows);
|
2313
|
+
|
2314
|
+
As some of these rows are not used, and thus return immediately,
|
2315
|
+
you may want to read about interlacing in the PNG specification,
|
2316
|
+
and only update the rows that are actually used.
|
2317
|
+
|
2318
|
+
Finishing a sequential write
|
2319
|
+
|
2320
|
+
After you are finished writing the image, you should finish writing
|
2321
|
+
the file. If you are interested in writing comments or time, you should
|
2322
|
+
pass an appropriately filled png_info pointer. If you are not interested,
|
2323
|
+
you can pass NULL.
|
2324
|
+
|
2325
|
+
png_write_end(png_ptr, info_ptr);
|
2326
|
+
|
2327
|
+
When you are done, you can free all memory used by libpng like this:
|
2328
|
+
|
2329
|
+
png_destroy_write_struct(&png_ptr, &info_ptr);
|
2330
|
+
|
2331
|
+
It is also possible to individually free the info_ptr members that
|
2332
|
+
point to libpng-allocated storage with the following function:
|
2333
|
+
|
2334
|
+
png_free_data(png_ptr, info_ptr, mask, seq)
|
2335
|
+
mask - identifies data to be freed, a mask
|
2336
|
+
containing the bitwise OR of one or
|
2337
|
+
more of
|
2338
|
+
PNG_FREE_PLTE, PNG_FREE_TRNS,
|
2339
|
+
PNG_FREE_HIST, PNG_FREE_ICCP,
|
2340
|
+
PNG_FREE_PCAL, PNG_FREE_ROWS,
|
2341
|
+
PNG_FREE_SCAL, PNG_FREE_SPLT,
|
2342
|
+
PNG_FREE_TEXT, PNG_FREE_UNKN,
|
2343
|
+
or simply PNG_FREE_ALL
|
2344
|
+
seq - sequence number of item to be freed
|
2345
|
+
(-1 for all items)
|
2346
|
+
|
2347
|
+
This function may be safely called when the relevant storage has
|
2348
|
+
already been freed, or has not yet been allocated, or was allocated
|
2349
|
+
by the user and not by libpng, and will in those
|
2350
|
+
cases do nothing. The "seq" parameter is ignored if only one item
|
2351
|
+
of the selected data type, such as PLTE, is allowed. If "seq" is not
|
2352
|
+
-1, and multiple items are allowed for the data type identified in
|
2353
|
+
the mask, such as text or sPLT, only the n'th item in the structure
|
2354
|
+
is freed, where n is "seq".
|
2355
|
+
|
2356
|
+
If you allocated data such as a palette that you passed
|
2357
|
+
in to libpng with png_set_*, you must not free it until just before the call to
|
2358
|
+
png_destroy_write_struct().
|
2359
|
+
|
2360
|
+
The default behavior is only to free data that was allocated internally
|
2361
|
+
by libpng. This can be changed, so that libpng will not free the data,
|
2362
|
+
or so that it will free data that was allocated by the user with png_malloc()
|
2363
|
+
or png_zalloc() and passed in via a png_set_*() function, with
|
2364
|
+
|
2365
|
+
png_data_freer(png_ptr, info_ptr, freer, mask)
|
2366
|
+
mask - which data elements are affected
|
2367
|
+
same choices as in png_free_data()
|
2368
|
+
freer - one of
|
2369
|
+
PNG_DESTROY_WILL_FREE_DATA
|
2370
|
+
PNG_SET_WILL_FREE_DATA
|
2371
|
+
PNG_USER_WILL_FREE_DATA
|
2372
|
+
|
2373
|
+
For example, to transfer responsibility for some data from a read structure
|
2374
|
+
to a write structure, you could use
|
2375
|
+
|
2376
|
+
png_data_freer(read_ptr, read_info_ptr,
|
2377
|
+
PNG_USER_WILL_FREE_DATA,
|
2378
|
+
PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
|
2379
|
+
png_data_freer(write_ptr, write_info_ptr,
|
2380
|
+
PNG_DESTROY_WILL_FREE_DATA,
|
2381
|
+
PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
|
2382
|
+
|
2383
|
+
thereby briefly reassigning responsibility for freeing to the user but
|
2384
|
+
immediately afterwards reassigning it once more to the write_destroy
|
2385
|
+
function. Having done this, it would then be safe to destroy the read
|
2386
|
+
structure and continue to use the PLTE, tRNS, and hIST data in the write
|
2387
|
+
structure.
|
2388
|
+
|
2389
|
+
This function only affects data that has already been allocated.
|
2390
|
+
You can call this function before calling after the png_set_*() functions
|
2391
|
+
to control whether the user or png_destroy_*() is supposed to free the data.
|
2392
|
+
When the user assumes responsibility for libpng-allocated data, the
|
2393
|
+
application must use
|
2394
|
+
png_free() to free it, and when the user transfers responsibility to libpng
|
2395
|
+
for data that the user has allocated, the user must have used png_malloc()
|
2396
|
+
or png_zalloc() to allocate it.
|
2397
|
+
|
2398
|
+
If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
|
2399
|
+
separately, do not transfer responsibility for freeing text_ptr to libpng,
|
2400
|
+
because when libpng fills a png_text structure it combines these members with
|
2401
|
+
the key member, and png_free_data() will free only text_ptr.key. Similarly,
|
2402
|
+
if you transfer responsibility for free'ing text_ptr from libpng to your
|
2403
|
+
application, your application must not separately free those members.
|
2404
|
+
For a more compact example of writing a PNG image, see the file example.c.
|
2405
|
+
|
2406
|
+
V. Modifying/Customizing libpng:
|
2407
|
+
|
2408
|
+
There are two issues here. The first is changing how libpng does
|
2409
|
+
standard things like memory allocation, input/output, and error handling.
|
2410
|
+
The second deals with more complicated things like adding new chunks,
|
2411
|
+
adding new transformations, and generally changing how libpng works.
|
2412
|
+
Both of those are compile-time issues; that is, they are generally
|
2413
|
+
determined at the time the code is written, and there is rarely a need
|
2414
|
+
to provide the user with a means of changing them.
|
2415
|
+
|
2416
|
+
Memory allocation, input/output, and error handling
|
2417
|
+
|
2418
|
+
All of the memory allocation, input/output, and error handling in libpng
|
2419
|
+
goes through callbacks that are user-settable. The default routines are
|
2420
|
+
in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively. To change
|
2421
|
+
these functions, call the appropriate png_set_*_fn() function.
|
2422
|
+
|
2423
|
+
Memory allocation is done through the functions png_malloc()
|
2424
|
+
and png_free(). These currently just call the standard C functions. If
|
2425
|
+
your pointers can't access more then 64K at a time, you will want to set
|
2426
|
+
MAXSEG_64K in zlib.h. Since it is unlikely that the method of handling
|
2427
|
+
memory allocation on a platform will change between applications, these
|
2428
|
+
functions must be modified in the library at compile time. If you prefer
|
2429
|
+
to use a different method of allocating and freeing data, you can use
|
2430
|
+
png_create_read_struct_2() or png_create_write_struct_2() to register
|
2431
|
+
your own functions as described above.
|
2432
|
+
These functions also provide a void pointer that can be retrieved via
|
2433
|
+
|
2434
|
+
mem_ptr=png_get_mem_ptr(png_ptr);
|
2435
|
+
|
2436
|
+
Your replacement memory functions must have prototypes as follows:
|
2437
|
+
|
2438
|
+
png_voidp malloc_fn(png_structp png_ptr,
|
2439
|
+
png_size_t size);
|
2440
|
+
void free_fn(png_structp png_ptr, png_voidp ptr);
|
2441
|
+
|
2442
|
+
Your malloc_fn() must return NULL in case of failure. The png_malloc()
|
2443
|
+
function will normally call png_error() if it receives a NULL from the
|
2444
|
+
system memory allocator or from your replacement malloc_fn().
|
2445
|
+
|
2446
|
+
Your free_fn() will never be called with a NULL ptr, since libpng's
|
2447
|
+
png_free() checks for NULL before calling free_fn().
|
2448
|
+
|
2449
|
+
Input/Output in libpng is done through png_read() and png_write(),
|
2450
|
+
which currently just call fread() and fwrite(). The FILE * is stored in
|
2451
|
+
png_struct and is initialized via png_init_io(). If you wish to change
|
2452
|
+
the method of I/O, the library supplies callbacks that you can set
|
2453
|
+
through the function png_set_read_fn() and png_set_write_fn() at run
|
2454
|
+
time, instead of calling the png_init_io() function. These functions
|
2455
|
+
also provide a void pointer that can be retrieved via the function
|
2456
|
+
png_get_io_ptr(). For example:
|
2457
|
+
|
2458
|
+
png_set_read_fn(png_structp read_ptr,
|
2459
|
+
voidp read_io_ptr, png_rw_ptr read_data_fn)
|
2460
|
+
|
2461
|
+
png_set_write_fn(png_structp write_ptr,
|
2462
|
+
voidp write_io_ptr, png_rw_ptr write_data_fn,
|
2463
|
+
png_flush_ptr output_flush_fn);
|
2464
|
+
|
2465
|
+
voidp read_io_ptr = png_get_io_ptr(read_ptr);
|
2466
|
+
voidp write_io_ptr = png_get_io_ptr(write_ptr);
|
2467
|
+
|
2468
|
+
The replacement I/O functions must have prototypes as follows:
|
2469
|
+
|
2470
|
+
void user_read_data(png_structp png_ptr,
|
2471
|
+
png_bytep data, png_size_t length);
|
2472
|
+
void user_write_data(png_structp png_ptr,
|
2473
|
+
png_bytep data, png_size_t length);
|
2474
|
+
void user_flush_data(png_structp png_ptr);
|
2475
|
+
|
2476
|
+
Supplying NULL for the read, write, or flush functions sets them back
|
2477
|
+
to using the default C stream functions. It is an error to read from
|
2478
|
+
a write stream, and vice versa.
|
2479
|
+
|
2480
|
+
Error handling in libpng is done through png_error() and png_warning().
|
2481
|
+
Errors handled through png_error() are fatal, meaning that png_error()
|
2482
|
+
should never return to its caller. Currently, this is handled via
|
2483
|
+
setjmp() and longjmp() (unless you have compiled libpng with
|
2484
|
+
PNG_SETJMP_NOT_SUPPORTED, in which case it is handled via PNG_ABORT()),
|
2485
|
+
but you could change this to do things like exit() if you should wish.
|
2486
|
+
|
2487
|
+
On non-fatal errors, png_warning() is called
|
2488
|
+
to print a warning message, and then control returns to the calling code.
|
2489
|
+
By default png_error() and png_warning() print a message on stderr via
|
2490
|
+
fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined
|
2491
|
+
(because you don't want the messages) or PNG_NO_STDIO defined (because
|
2492
|
+
fprintf() isn't available). If you wish to change the behavior of the error
|
2493
|
+
functions, you will need to set up your own message callbacks. These
|
2494
|
+
functions are normally supplied at the time that the png_struct is created.
|
2495
|
+
It is also possible to redirect errors and warnings to your own replacement
|
2496
|
+
functions after png_create_*_struct() has been called by calling:
|
2497
|
+
|
2498
|
+
png_set_error_fn(png_structp png_ptr,
|
2499
|
+
png_voidp error_ptr, png_error_ptr error_fn,
|
2500
|
+
png_error_ptr warning_fn);
|
2501
|
+
|
2502
|
+
png_voidp error_ptr = png_get_error_ptr(png_ptr);
|
2503
|
+
|
2504
|
+
If NULL is supplied for either error_fn or warning_fn, then the libpng
|
2505
|
+
default function will be used, calling fprintf() and/or longjmp() if a
|
2506
|
+
problem is encountered. The replacement error functions should have
|
2507
|
+
parameters as follows:
|
2508
|
+
|
2509
|
+
void user_error_fn(png_structp png_ptr,
|
2510
|
+
png_const_charp error_msg);
|
2511
|
+
void user_warning_fn(png_structp png_ptr,
|
2512
|
+
png_const_charp warning_msg);
|
2513
|
+
|
2514
|
+
The motivation behind using setjmp() and longjmp() is the C++ throw and
|
2515
|
+
catch exception handling methods. This makes the code much easier to write,
|
2516
|
+
as there is no need to check every return code of every function call.
|
2517
|
+
However, there are some uncertainties about the status of local variables
|
2518
|
+
after a longjmp, so the user may want to be careful about doing anything after
|
2519
|
+
setjmp returns non-zero besides returning itself. Consult your compiler
|
2520
|
+
documentation for more details. For an alternative approach, you may wish
|
2521
|
+
to use the "cexcept" facility (see http://cexcept.sourceforge.net).
|
2522
|
+
|
2523
|
+
Custom chunks
|
2524
|
+
|
2525
|
+
If you need to read or write custom chunks, you may need to get deeper
|
2526
|
+
into the libpng code. The library now has mechanisms for storing
|
2527
|
+
and writing chunks of unknown type; you can even declare callbacks
|
2528
|
+
for custom chunks. However, this may not be good enough if the
|
2529
|
+
library code itself needs to know about interactions between your
|
2530
|
+
chunk and existing `intrinsic' chunks.
|
2531
|
+
|
2532
|
+
If you need to write a new intrinsic chunk, first read the PNG
|
2533
|
+
specification. Acquire a first level of
|
2534
|
+
understanding of how it works. Pay particular attention to the
|
2535
|
+
sections that describe chunk names, and look at how other chunks were
|
2536
|
+
designed, so you can do things similarly. Second, check out the
|
2537
|
+
sections of libpng that read and write chunks. Try to find a chunk
|
2538
|
+
that is similar to yours and use it as a template. More details can
|
2539
|
+
be found in the comments inside the code. It is best to handle unknown
|
2540
|
+
chunks in a generic method, via callback functions, instead of by
|
2541
|
+
modifying libpng functions.
|
2542
|
+
|
2543
|
+
If you wish to write your own transformation for the data, look through
|
2544
|
+
the part of the code that does the transformations, and check out some of
|
2545
|
+
the simpler ones to get an idea of how they work. Try to find a similar
|
2546
|
+
transformation to the one you want to add and copy off of it. More details
|
2547
|
+
can be found in the comments inside the code itself.
|
2548
|
+
|
2549
|
+
Configuring for 16 bit platforms
|
2550
|
+
|
2551
|
+
You will want to look into zconf.h to tell zlib (and thus libpng) that
|
2552
|
+
it cannot allocate more then 64K at a time. Even if you can, the memory
|
2553
|
+
won't be accessible. So limit zlib and libpng to 64K by defining MAXSEG_64K.
|
2554
|
+
|
2555
|
+
Configuring for DOS
|
2556
|
+
|
2557
|
+
For DOS users who only have access to the lower 640K, you will
|
2558
|
+
have to limit zlib's memory usage via a png_set_compression_mem_level()
|
2559
|
+
call. See zlib.h or zconf.h in the zlib library for more information.
|
2560
|
+
|
2561
|
+
Configuring for Medium Model
|
2562
|
+
|
2563
|
+
Libpng's support for medium model has been tested on most of the popular
|
2564
|
+
compilers. Make sure MAXSEG_64K gets defined, USE_FAR_KEYWORD gets
|
2565
|
+
defined, and FAR gets defined to far in pngconf.h, and you should be
|
2566
|
+
all set. Everything in the library (except for zlib's structure) is
|
2567
|
+
expecting far data. You must use the typedefs with the p or pp on
|
2568
|
+
the end for pointers (or at least look at them and be careful). Make
|
2569
|
+
note that the rows of data are defined as png_bytepp, which is an
|
2570
|
+
unsigned char far * far *.
|
2571
|
+
|
2572
|
+
Configuring for gui/windowing platforms:
|
2573
|
+
|
2574
|
+
You will need to write new error and warning functions that use the GUI
|
2575
|
+
interface, as described previously, and set them to be the error and
|
2576
|
+
warning functions at the time that png_create_*_struct() is called,
|
2577
|
+
in order to have them available during the structure initialization.
|
2578
|
+
They can be changed later via png_set_error_fn(). On some compilers,
|
2579
|
+
you may also have to change the memory allocators (png_malloc, etc.).
|
2580
|
+
|
2581
|
+
Configuring for compiler xxx:
|
2582
|
+
|
2583
|
+
All includes for libpng are in pngconf.h. If you need to add/change/delete
|
2584
|
+
an include, this is the place to do it. The includes that are not
|
2585
|
+
needed outside libpng are protected by the PNG_INTERNAL definition,
|
2586
|
+
which is only defined for those routines inside libpng itself. The
|
2587
|
+
files in libpng proper only include png.h, which includes pngconf.h.
|
2588
|
+
|
2589
|
+
Configuring zlib:
|
2590
|
+
|
2591
|
+
There are special functions to configure the compression. Perhaps the
|
2592
|
+
most useful one changes the compression level, which currently uses
|
2593
|
+
input compression values in the range 0 - 9. The library normally
|
2594
|
+
uses the default compression level (Z_DEFAULT_COMPRESSION = 6). Tests
|
2595
|
+
have shown that for a large majority of images, compression values in
|
2596
|
+
the range 3-6 compress nearly as well as higher levels, and do so much
|
2597
|
+
faster. For online applications it may be desirable to have maximum speed
|
2598
|
+
(Z_BEST_SPEED = 1). With versions of zlib after v0.99, you can also
|
2599
|
+
specify no compression (Z_NO_COMPRESSION = 0), but this would create
|
2600
|
+
files larger than just storing the raw bitmap. You can specify the
|
2601
|
+
compression level by calling:
|
2602
|
+
|
2603
|
+
png_set_compression_level(png_ptr, level);
|
2604
|
+
|
2605
|
+
Another useful one is to reduce the memory level used by the library.
|
2606
|
+
The memory level defaults to 8, but it can be lowered if you are
|
2607
|
+
short on memory (running DOS, for example, where you only have 640K).
|
2608
|
+
Note that the memory level does have an effect on compression; among
|
2609
|
+
other things, lower levels will result in sections of incompressible
|
2610
|
+
data being emitted in smaller stored blocks, with a correspondingly
|
2611
|
+
larger relative overhead of up to 15% in the worst case.
|
2612
|
+
|
2613
|
+
png_set_compression_mem_level(png_ptr, level);
|
2614
|
+
|
2615
|
+
The other functions are for configuring zlib. They are not recommended
|
2616
|
+
for normal use and may result in writing an invalid PNG file. See
|
2617
|
+
zlib.h for more information on what these mean.
|
2618
|
+
|
2619
|
+
png_set_compression_strategy(png_ptr,
|
2620
|
+
strategy);
|
2621
|
+
png_set_compression_window_bits(png_ptr,
|
2622
|
+
window_bits);
|
2623
|
+
png_set_compression_method(png_ptr, method);
|
2624
|
+
png_set_compression_buffer_size(png_ptr, size);
|
2625
|
+
|
2626
|
+
Controlling row filtering
|
2627
|
+
|
2628
|
+
If you want to control whether libpng uses filtering or not, which
|
2629
|
+
filters are used, and how it goes about picking row filters, you
|
2630
|
+
can call one of these functions. The selection and configuration
|
2631
|
+
of row filters can have a significant impact on the size and
|
2632
|
+
encoding speed and a somewhat lesser impact on the decoding speed
|
2633
|
+
of an image. Filtering is enabled by default for RGB and grayscale
|
2634
|
+
images (with and without alpha), but not for paletted images nor
|
2635
|
+
for any images with bit depths less than 8 bits/pixel.
|
2636
|
+
|
2637
|
+
The 'method' parameter sets the main filtering method, which is
|
2638
|
+
currently only '0' in the PNG 1.2 specification. The 'filters'
|
2639
|
+
parameter sets which filter(s), if any, should be used for each
|
2640
|
+
scanline. Possible values are PNG_ALL_FILTERS and PNG_NO_FILTERS
|
2641
|
+
to turn filtering on and off, respectively.
|
2642
|
+
|
2643
|
+
Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB,
|
2644
|
+
PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise
|
2645
|
+
ORed together with '|' to specify one or more filters to use.
|
2646
|
+
These filters are described in more detail in the PNG specification.
|
2647
|
+
If you intend to change the filter type during the course of writing
|
2648
|
+
the image, you should start with flags set for all of the filters
|
2649
|
+
you intend to use so that libpng can initialize its internal
|
2650
|
+
structures appropriately for all of the filter types. (Note that this
|
2651
|
+
means the first row must always be adaptively filtered, because libpng
|
2652
|
+
currently does not allocate the filter buffers until png_write_row()
|
2653
|
+
is called for the first time.)
|
2654
|
+
|
2655
|
+
filters = PNG_FILTER_NONE | PNG_FILTER_SUB
|
2656
|
+
PNG_FILTER_UP | PNG_FILTER_AVE |
|
2657
|
+
PNG_FILTER_PAETH | PNG_ALL_FILTERS;
|
2658
|
+
|
2659
|
+
png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE,
|
2660
|
+
filters);
|
2661
|
+
The second parameter can also be
|
2662
|
+
PNG_INTRAPIXEL_DIFFERENCING if you are
|
2663
|
+
writing a PNG to be embedded in a MNG
|
2664
|
+
datastream. This parameter must be the
|
2665
|
+
same as the value of filter_method used
|
2666
|
+
in png_set_IHDR().
|
2667
|
+
|
2668
|
+
It is also possible to influence how libpng chooses from among the
|
2669
|
+
available filters. This is done in one or both of two ways - by
|
2670
|
+
telling it how important it is to keep the same filter for successive
|
2671
|
+
rows, and by telling it the relative computational costs of the filters.
|
2672
|
+
|
2673
|
+
double weights[3] = {1.5, 1.3, 1.1},
|
2674
|
+
costs[PNG_FILTER_VALUE_LAST] =
|
2675
|
+
{1.0, 1.3, 1.3, 1.5, 1.7};
|
2676
|
+
|
2677
|
+
png_set_filter_heuristics(png_ptr,
|
2678
|
+
PNG_FILTER_HEURISTIC_WEIGHTED, 3,
|
2679
|
+
weights, costs);
|
2680
|
+
|
2681
|
+
The weights are multiplying factors that indicate to libpng that the
|
2682
|
+
row filter should be the same for successive rows unless another row filter
|
2683
|
+
is that many times better than the previous filter. In the above example,
|
2684
|
+
if the previous 3 filters were SUB, SUB, NONE, the SUB filter could have a
|
2685
|
+
"sum of absolute differences" 1.5 x 1.3 times higher than other filters
|
2686
|
+
and still be chosen, while the NONE filter could have a sum 1.1 times
|
2687
|
+
higher than other filters and still be chosen. Unspecified weights are
|
2688
|
+
taken to be 1.0, and the specified weights should probably be declining
|
2689
|
+
like those above in order to emphasize recent filters over older filters.
|
2690
|
+
|
2691
|
+
The filter costs specify for each filter type a relative decoding cost
|
2692
|
+
to be considered when selecting row filters. This means that filters
|
2693
|
+
with higher costs are less likely to be chosen over filters with lower
|
2694
|
+
costs, unless their "sum of absolute differences" is that much smaller.
|
2695
|
+
The costs do not necessarily reflect the exact computational speeds of
|
2696
|
+
the various filters, since this would unduly influence the final image
|
2697
|
+
size.
|
2698
|
+
|
2699
|
+
Note that the numbers above were invented purely for this example and
|
2700
|
+
are given only to help explain the function usage. Little testing has
|
2701
|
+
been done to find optimum values for either the costs or the weights.
|
2702
|
+
|
2703
|
+
Removing unwanted object code
|
2704
|
+
|
2705
|
+
There are a bunch of #define's in pngconf.h that control what parts of
|
2706
|
+
libpng are compiled. All the defines end in _SUPPORTED. If you are
|
2707
|
+
never going to use a capability, you can change the #define to #undef
|
2708
|
+
before recompiling libpng and save yourself code and data space, or
|
2709
|
+
you can turn off individual capabilities with defines that begin with
|
2710
|
+
PNG_NO_.
|
2711
|
+
|
2712
|
+
You can also turn all of the transforms and ancillary chunk capabilities
|
2713
|
+
off en masse with compiler directives that define
|
2714
|
+
PNG_NO_READ[or WRITE]_TRANSFORMS, or PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS,
|
2715
|
+
or all four,
|
2716
|
+
along with directives to turn on any of the capabilities that you do
|
2717
|
+
want. The PNG_NO_READ[or WRITE]_TRANSFORMS directives disable
|
2718
|
+
the extra transformations but still leave the library fully capable of reading
|
2719
|
+
and writing PNG files with all known public chunks
|
2720
|
+
Use of the PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS directive
|
2721
|
+
produces a library that is incapable of reading or writing ancillary chunks.
|
2722
|
+
If you are not using the progressive reading capability, you can
|
2723
|
+
turn that off with PNG_NO_PROGRESSIVE_READ (don't confuse
|
2724
|
+
this with the INTERLACING capability, which you'll still have).
|
2725
|
+
|
2726
|
+
All the reading and writing specific code are in separate files, so the
|
2727
|
+
linker should only grab the files it needs. However, if you want to
|
2728
|
+
make sure, or if you are building a stand alone library, all the
|
2729
|
+
reading files start with pngr and all the writing files start with
|
2730
|
+
pngw. The files that don't match either (like png.c, pngtrans.c, etc.)
|
2731
|
+
are used for both reading and writing, and always need to be included.
|
2732
|
+
The progressive reader is in pngpread.c
|
2733
|
+
|
2734
|
+
If you are creating or distributing a dynamically linked library (a .so
|
2735
|
+
or DLL file), you should not remove or disable any parts of the library,
|
2736
|
+
as this will cause applications linked with different versions of the
|
2737
|
+
library to fail if they call functions not available in your library.
|
2738
|
+
The size of the library itself should not be an issue, because only
|
2739
|
+
those sections that are actually used will be loaded into memory.
|
2740
|
+
|
2741
|
+
Requesting debug printout
|
2742
|
+
|
2743
|
+
The macro definition PNG_DEBUG can be used to request debugging
|
2744
|
+
printout. Set it to an integer value in the range 0 to 3. Higher
|
2745
|
+
numbers result in increasing amounts of debugging information. The
|
2746
|
+
information is printed to the "stderr" file, unless another file
|
2747
|
+
name is specified in the PNG_DEBUG_FILE macro definition.
|
2748
|
+
|
2749
|
+
When PNG_DEBUG > 0, the following functions (macros) become available:
|
2750
|
+
|
2751
|
+
png_debug(level, message)
|
2752
|
+
png_debug1(level, message, p1)
|
2753
|
+
png_debug2(level, message, p1, p2)
|
2754
|
+
|
2755
|
+
in which "level" is compared to PNG_DEBUG to decide whether to print
|
2756
|
+
the message, "message" is the formatted string to be printed,
|
2757
|
+
and p1 and p2 are parameters that are to be embedded in the string
|
2758
|
+
according to printf-style formatting directives. For example,
|
2759
|
+
|
2760
|
+
png_debug1(2, "foo=%d\n", foo);
|
2761
|
+
|
2762
|
+
is expanded to
|
2763
|
+
|
2764
|
+
if(PNG_DEBUG > 2)
|
2765
|
+
fprintf(PNG_DEBUG_FILE, "foo=%d\n", foo);
|
2766
|
+
|
2767
|
+
When PNG_DEBUG is defined but is zero, the macros aren't defined, but you
|
2768
|
+
can still use PNG_DEBUG to control your own debugging:
|
2769
|
+
|
2770
|
+
#ifdef PNG_DEBUG
|
2771
|
+
fprintf(stderr, ...
|
2772
|
+
#endif
|
2773
|
+
|
2774
|
+
When PNG_DEBUG = 1, the macros are defined, but only png_debug statements
|
2775
|
+
having level = 0 will be printed. There aren't any such statements in
|
2776
|
+
this version of libpng, but if you insert some they will be printed.
|
2777
|
+
|
2778
|
+
VII. MNG support
|
2779
|
+
|
2780
|
+
The MNG specification (available at http://www.libpng.org/pub/mng) allows
|
2781
|
+
certain extensions to PNG for PNG images that are embedded in MNG datastreams.
|
2782
|
+
Libpng can support some of these extensions. To enable them, use the
|
2783
|
+
png_permit_mng_features() function:
|
2784
|
+
|
2785
|
+
feature_set = png_permit_mng_features(png_ptr, mask)
|
2786
|
+
mask is a png_uint_32 containing the bitwise OR of the
|
2787
|
+
features you want to enable. These include
|
2788
|
+
PNG_FLAG_MNG_EMPTY_PLTE
|
2789
|
+
PNG_FLAG_MNG_FILTER_64
|
2790
|
+
PNG_ALL_MNG_FEATURES
|
2791
|
+
feature_set is a png_uint_32 that is the bitwise AND of
|
2792
|
+
your mask with the set of MNG features that is
|
2793
|
+
supported by the version of libpng that you are using.
|
2794
|
+
|
2795
|
+
It is an error to use this function when reading or writing a standalone
|
2796
|
+
PNG file with the PNG 8-byte signature. The PNG datastream must be wrapped
|
2797
|
+
in a MNG datastream. As a minimum, it must have the MNG 8-byte signature
|
2798
|
+
and the MHDR and MEND chunks. Libpng does not provide support for these
|
2799
|
+
or any other MNG chunks; your application must provide its own support for
|
2800
|
+
them. You may wish to consider using libmng (available at
|
2801
|
+
http://www.libmng.com) instead.
|
2802
|
+
|
2803
|
+
VIII. Changes to Libpng from version 0.88
|
2804
|
+
|
2805
|
+
It should be noted that versions of libpng later than 0.96 are not
|
2806
|
+
distributed by the original libpng author, Guy Schalnat, nor by
|
2807
|
+
Andreas Dilger, who had taken over from Guy during 1996 and 1997, and
|
2808
|
+
distributed versions 0.89 through 0.96, but rather by another member
|
2809
|
+
of the original PNG Group, Glenn Randers-Pehrson. Guy and Andreas are
|
2810
|
+
still alive and well, but they have moved on to other things.
|
2811
|
+
|
2812
|
+
The old libpng functions png_read_init(), png_write_init(),
|
2813
|
+
png_info_init(), png_read_destroy(), and png_write_destroy() have been
|
2814
|
+
moved to PNG_INTERNAL in version 0.95 to discourage their use. These
|
2815
|
+
functions will be removed from libpng version 2.0.0.
|
2816
|
+
|
2817
|
+
The preferred method of creating and initializing the libpng structures is
|
2818
|
+
via the png_create_read_struct(), png_create_write_struct(), and
|
2819
|
+
png_create_info_struct() because they isolate the size of the structures
|
2820
|
+
from the application, allow version error checking, and also allow the
|
2821
|
+
use of custom error handling routines during the initialization, which
|
2822
|
+
the old functions do not. The functions png_read_destroy() and
|
2823
|
+
png_write_destroy() do not actually free the memory that libpng
|
2824
|
+
allocated for these structs, but just reset the data structures, so they
|
2825
|
+
can be used instead of png_destroy_read_struct() and
|
2826
|
+
png_destroy_write_struct() if you feel there is too much system overhead
|
2827
|
+
allocating and freeing the png_struct for each image read.
|
2828
|
+
|
2829
|
+
Setting the error callbacks via png_set_message_fn() before
|
2830
|
+
png_read_init() as was suggested in libpng-0.88 is no longer supported
|
2831
|
+
because this caused applications that do not use custom error functions
|
2832
|
+
to fail if the png_ptr was not initialized to zero. It is still possible
|
2833
|
+
to set the error callbacks AFTER png_read_init(), or to change them with
|
2834
|
+
png_set_error_fn(), which is essentially the same function, but with a new
|
2835
|
+
name to force compilation errors with applications that try to use the old
|
2836
|
+
method.
|
2837
|
+
|
2838
|
+
Starting with version 1.0.7, you can find out which version of the library
|
2839
|
+
you are using at run-time:
|
2840
|
+
|
2841
|
+
png_uint_32 libpng_vn = png_access_version_number();
|
2842
|
+
|
2843
|
+
The number libpng_vn is constructed from the major version, minor
|
2844
|
+
version with leading zero, and release number with leading zero,
|
2845
|
+
(e.g., libpng_vn for version 1.0.7 is 10007).
|
2846
|
+
|
2847
|
+
You can also check which version of png.h you used when compiling your
|
2848
|
+
application:
|
2849
|
+
|
2850
|
+
png_uint_32 application_vn = PNG_LIBPNG_VER;
|
2851
|
+
|
2852
|
+
IX. Y2K Compliance in libpng
|
2853
|
+
|
2854
|
+
May 8, 2008
|
2855
|
+
|
2856
|
+
Since the PNG Development group is an ad-hoc body, we can't make
|
2857
|
+
an official declaration.
|
2858
|
+
|
2859
|
+
This is your unofficial assurance that libpng from version 0.71 and
|
2860
|
+
upward through 1.2.29 are Y2K compliant. It is my belief that earlier
|
2861
|
+
versions were also Y2K compliant.
|
2862
|
+
|
2863
|
+
Libpng only has three year fields. One is a 2-byte unsigned integer that
|
2864
|
+
will hold years up to 65535. The other two hold the date in text
|
2865
|
+
format, and will hold years up to 9999.
|
2866
|
+
|
2867
|
+
The integer is
|
2868
|
+
"png_uint_16 year" in png_time_struct.
|
2869
|
+
|
2870
|
+
The strings are
|
2871
|
+
"png_charp time_buffer" in png_struct and
|
2872
|
+
"near_time_buffer", which is a local character string in png.c.
|
2873
|
+
|
2874
|
+
There are seven time-related functions:
|
2875
|
+
|
2876
|
+
png_convert_to_rfc_1123() in png.c
|
2877
|
+
(formerly png_convert_to_rfc_1152() in error)
|
2878
|
+
png_convert_from_struct_tm() in pngwrite.c, called
|
2879
|
+
in pngwrite.c
|
2880
|
+
png_convert_from_time_t() in pngwrite.c
|
2881
|
+
png_get_tIME() in pngget.c
|
2882
|
+
png_handle_tIME() in pngrutil.c, called in pngread.c
|
2883
|
+
png_set_tIME() in pngset.c
|
2884
|
+
png_write_tIME() in pngwutil.c, called in pngwrite.c
|
2885
|
+
|
2886
|
+
All appear to handle dates properly in a Y2K environment. The
|
2887
|
+
png_convert_from_time_t() function calls gmtime() to convert from system
|
2888
|
+
clock time, which returns (year - 1900), which we properly convert to
|
2889
|
+
the full 4-digit year. There is a possibility that applications using
|
2890
|
+
libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
|
2891
|
+
function, or that they are incorrectly passing only a 2-digit year
|
2892
|
+
instead of "year - 1900" into the png_convert_from_struct_tm() function,
|
2893
|
+
but this is not under our control. The libpng documentation has always
|
2894
|
+
stated that it works with 4-digit years, and the APIs have been
|
2895
|
+
documented as such.
|
2896
|
+
|
2897
|
+
The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
|
2898
|
+
integer to hold the year, and can hold years as large as 65535.
|
2899
|
+
|
2900
|
+
zlib, upon which libpng depends, is also Y2K compliant. It contains
|
2901
|
+
no date-related code.
|
2902
|
+
|
2903
|
+
|
2904
|
+
Glenn Randers-Pehrson
|
2905
|
+
libpng maintainer
|
2906
|
+
PNG Development Group
|