source/Irrlicht/libpng/README

   1 README for libpng version 1.6.37 - April 14, 2019\r
   2 =================================================\r
   3 \r
   4 See the note about version numbers near the top of png.h.\r
   5 See INSTALL for instructions on how to install libpng.\r
   6 \r
   7 Libpng comes in several distribution formats.  Get libpng-*.tar.gz or\r
   8 libpng-*.tar.xz or if you want UNIX-style line endings in the text\r
   9 files, or lpng*.7z or lpng*.zip if you want DOS-style line endings.\r
  10 \r
  11 Version 0.89 was the first official release of libpng.  Don't let the\r
  12 fact that it's the first release fool you.  The libpng library has been\r
  13 in extensive use and testing since mid-1995.  By late 1997 it had\r
  14 finally gotten to the stage where there hadn't been significant\r
  15 changes to the API in some time, and people have a bad feeling about\r
  16 libraries with versions < 1.0.  Version 1.0.0 was released in\r
  17 March 1998.\r
  18 \r
  19 ****\r
  20 Note that some of the changes to the png_info structure render this\r
  21 version of the library binary incompatible with libpng-0.89 or\r
  22 earlier versions if you are using a shared library.  The type of the\r
  23 "filler" parameter for png_set_filler() has changed from png_byte to\r
  24 png_uint_32, which will affect shared-library applications that use\r
  25 this function.\r
  26 \r
  27 To avoid problems with changes to the internals of the png info_struct,\r
  28 new APIs have been made available in 0.95 to avoid direct application\r
  29 access to info_ptr.  These functions are the png_set_<chunk> and\r
  30 png_get_<chunk> functions.  These functions should be used when\r
  31 accessing/storing the info_struct data, rather than manipulating it\r
  32 directly, to avoid such problems in the future.\r
  33 \r
  34 It is important to note that the APIs did not make current programs\r
  35 that access the info struct directly incompatible with the new\r
  36 library, through libpng-1.2.x.  In libpng-1.4.x, which was meant to\r
  37 be a transitional release, members of the png_struct and the\r
  38 info_struct can still be accessed, but the compiler will issue a\r
  39 warning about deprecated usage.  Since libpng-1.5.0, direct access\r
  40 to these structs is not allowed, and the definitions of the structs\r
  41 reside in private pngstruct.h and pnginfo.h header files that are not\r
  42 accessible to applications.  It is strongly suggested that new\r
  43 programs use the new APIs (as shown in example.c and pngtest.c), and\r
  44 older programs be converted to the new format, to facilitate upgrades\r
  45 in the future.\r
  46 ****\r
  47 \r
  48 Additions since 0.90 include the ability to compile libpng as a\r
  49 Windows DLL, and new APIs for accessing data in the info struct.\r
  50 Experimental functions include the ability to set weighting and cost\r
  51 factors for row filter selection, direct reads of integers from buffers\r
  52 on big-endian processors that support misaligned data access, faster\r
  53 methods of doing alpha composition, and more accurate 16->8 bit color\r
  54 conversion.\r
  55 \r
  56 The additions since 0.89 include the ability to read from a PNG stream\r
  57 which has had some (or all) of the signature bytes read by the calling\r
  58 application.  This also allows the reading of embedded PNG streams that\r
  59 do not have the PNG file signature.  As well, it is now possible to set\r
  60 the library action on the detection of chunk CRC errors.  It is possible\r
  61 to set different actions based on whether the CRC error occurred in a\r
  62 critical or an ancillary chunk.\r
  63 \r
  64 For a detailed description on using libpng, read libpng-manual.txt.\r
  65 For examples of libpng in a program, see example.c and pngtest.c.  For\r
  66 usage information and restrictions (what little they are) on libpng,\r
  67 see png.h.  For a description on using zlib (the compression library\r
  68 used by libpng) and zlib's restrictions, see zlib.h\r
  69 \r
  70 I have included a general makefile, as well as several machine and\r
  71 compiler specific ones, but you may have to modify one for your own\r
  72 needs.\r
  73 \r
  74 You should use zlib 1.0.4 or later to run this, but it MAY work with\r
  75 versions as old as zlib 0.95.  Even so, there are bugs in older zlib\r
  76 versions which can cause the output of invalid compression streams for\r
  77 some images.\r
  78 \r
  79 You should also note that zlib is a compression library that is useful\r
  80 for more things than just PNG files.  You can use zlib as a drop-in\r
  81 replacement for fread() and fwrite(), if you are so inclined.\r
  82 \r
  83 zlib should be available at the same place that libpng is, or at\r
  84 https://zlib.net.\r
  85 \r
  86 You may also want a copy of the PNG specification.  It is available\r
  87 as an RFC, a W3C Recommendation, and an ISO/IEC Standard.  You can find\r
  88 these at http://www.libpng.org/pub/png/pngdocs.html .\r
  89 \r
  90 This code is currently being archived at libpng.sourceforge.io in the\r
  91 [DOWNLOAD] area, and at http://libpng.download/src .\r
  92 \r
  93 This release, based in a large way on Glenn's, Guy's and Andreas'\r
  94 earlier work, was created and will be supported by myself and the PNG\r
  95 development group.\r
  96 \r
  97 Send comments/corrections/commendations to png-mng-implement at\r
  98 lists.sourceforge.net (subscription required; visit\r
  99 https://lists.sourceforge.net/lists/listinfo/png-mng-implement\r
 100 to subscribe).\r
 101 \r
 102 Send general questions about the PNG specification to png-mng-misc\r
 103 at lists.sourceforge.net (subscription required; visit\r
 104 https://lists.sourceforge.net/lists/listinfo/png-mng-misc to\r
 105 subscribe).\r
 106 \r
 107 Files in this distribution:\r
 108 \r
 109       ANNOUNCE      =>  Announcement of this version, with recent changes\r
 110       AUTHORS       =>  List of contributing authors\r
 111       CHANGES       =>  Description of changes between libpng versions\r
 112       KNOWNBUG      =>  List of known bugs and deficiencies\r
 113       LICENSE       =>  License to use and redistribute libpng\r
 114       README        =>  This file\r
 115       TODO          =>  Things not implemented in the current library\r
 116       TRADEMARK     =>  Trademark information\r
 117       example.c     =>  Example code for using libpng functions\r
 118       libpng.3      =>  manual page for libpng (includes libpng-manual.txt)\r
 119       libpng-manual.txt  =>  Description of libpng and its functions\r
 120       libpngpf.3    =>  manual page for libpng's private functions\r
 121       png.5         =>  manual page for the PNG format\r
 122       png.c         =>  Basic interface functions common to library\r
 123       png.h         =>  Library function and interface declarations (public)\r
 124       pngpriv.h     =>  Library function and interface declarations (private)\r
 125       pngconf.h     =>  System specific library configuration (public)\r
 126       pngstruct.h   =>  png_struct declaration (private)\r
 127       pnginfo.h     =>  png_info struct declaration (private)\r
 128       pngdebug.h    =>  debugging macros (private)\r
 129       pngerror.c    =>  Error/warning message I/O functions\r
 130       pngget.c      =>  Functions for retrieving info from struct\r
 131       pngmem.c      =>  Memory handling functions\r
 132       pngbar.png    =>  PNG logo, 88x31\r
 133       pngnow.png    =>  PNG logo, 98x31\r
 134       pngpread.c    =>  Progressive reading functions\r
 135       pngread.c     =>  Read data/helper high-level functions\r
 136       pngrio.c      =>  Lowest-level data read I/O functions\r
 137       pngrtran.c    =>  Read data transformation functions\r
 138       pngrutil.c    =>  Read data utility functions\r
 139       pngset.c      =>  Functions for storing data into the info_struct\r
 140       pngtest.c     =>  Library test program\r
 141       pngtest.png   =>  Library test sample image\r
 142       pngtrans.c    =>  Common data transformation functions\r
 143       pngwio.c      =>  Lowest-level write I/O functions\r
 144       pngwrite.c    =>  High-level write functions\r
 145       pngwtran.c    =>  Write data transformations\r
 146       pngwutil.c    =>  Write utility functions\r
 147       arm           =>  Contains optimized code for the ARM platform\r
 148       powerpc       =>  Contains optimized code for the PowerPC platform\r
 149       contrib       =>  Contributions\r
 150        arm-neon         =>  Optimized code for ARM-NEON platform\r
 151        powerpc-vsx      =>  Optimized code for POWERPC-VSX platform\r
 152        examples         =>  Example programs\r
 153        gregbook         =>  source code for PNG reading and writing, from\r
 154                             Greg Roelofs' "PNG: The Definitive Guide",\r
 155                             O'Reilly, 1999\r
 156        libtests         =>  Test programs\r
 157        mips-msa         =>  Optimized code for MIPS-MSA platform\r
 158        pngminim         =>  Minimal decoder, encoder, and progressive decoder\r
 159                             programs demonstrating use of pngusr.dfa\r
 160        pngminus         =>  Simple pnm2png and png2pnm programs\r
 161        pngsuite         =>  Test images\r
 162        testpngs\r
 163        tools            =>  Various tools\r
 164        visupng          =>  Contains a MSVC workspace for VisualPng\r
 165       intel             =>  Optimized code for INTEL-SSE2 platform\r
 166       mips              =>  Optimized code for MIPS platform\r
 167       projects      =>  Contains project files and workspaces for\r
 168                         building a DLL\r
 169        owatcom          =>  Contains a WATCOM project for building libpng\r
 170        visualc71        =>  Contains a Microsoft Visual C++ (MSVC)\r
 171                             workspace for building libpng and zlib\r
 172        vstudio          =>  Contains a Microsoft Visual C++ (MSVC)\r
 173                             workspace for building libpng and zlib\r
 174       scripts       =>  Directory containing scripts for building libpng:\r
 175                             (see scripts/README.txt for the list of scripts)\r
 176 \r
 177 Good luck, and happy coding!\r
 178 \r
 179  * Cosmin Truta (current maintainer, since 2018)\r
 180  * Glenn Randers-Pehrson (former maintainer, 1998-2018)\r
 181  * Andreas Eric Dilger (former maintainer, 1996-1997)\r
 182  * Guy Eric Schalnat (original author and former maintainer, 1995-1996)\r
 183    (formerly of Group 42, Inc.)\r