Create FUNDING.yml

[wdl/wdl-ol.git] / WDL / libpng / README

README for libpng version 1.6.19 - November 12, 2015 (shared library 16.0)\r
See the note about version numbers near the top of png.h\r
\r
See INSTALL for instructions on how to install libpng.\r
\r
Libpng comes in several distribution formats.  Get libpng-*.tar.gz or\r
libpng-*.tar.xz or if you want UNIX-style line endings in the text files,\r
or lpng*.7z or lpng*.zip if you want DOS-style line endings.\r
\r
Version 0.89 was the first official release of libpng.  Don't let the\r
fact that it's the first release fool you.  The libpng library has been in\r
extensive use and testing since mid-1995.  By late 1997 it had\r
finally gotten to the stage where there hadn't been significant\r
changes to the API in some time, and people have a bad feeling about\r
libraries with versions < 1.0.  Version 1.0.0 was released in\r
March 1998.\r
\r
****\r
Note that some of the changes to the png_info structure render this\r
version of the library binary incompatible with libpng-0.89 or\r
earlier versions if you are using a shared library.  The type of the\r
"filler" parameter for png_set_filler() has changed from png_byte to\r
png_uint_32, which will affect shared-library applications that use\r
this function.\r
\r
To avoid problems with changes to the internals of png info_struct,\r
new APIs have been made available in 0.95 to avoid direct application\r
access to info_ptr.  These functions are the png_set_<chunk> and\r
png_get_<chunk> functions.  These functions should be used when\r
accessing/storing the info_struct data, rather than manipulating it\r
directly, to avoid such problems in the future.\r
\r
It is important to note that the APIs did not make current programs\r
that access the info struct directly incompatible with the new\r
library, through libpng-1.2.x.  In libpng-1.4.x, which was meant to\r
be a transitional release, members of the png_struct and the\r
info_struct can still be accessed, but the compiler will issue a\r
warning about deprecated usage.  Since libpng-1.5.0, direct access\r
to these structs is not allowed, and the definitions of the structs\r
reside in private pngstruct.h and pnginfo.h header files that are not\r
accessible to applications.  It is strongly suggested that new\r
programs use the new APIs (as shown in example.c and pngtest.c), and\r
older programs be converted to the new format, to facilitate upgrades\r
in the future.\r
****\r
\r
Additions since 0.90 include the ability to compile libpng as a\r
Windows DLL, and new APIs for accessing data in the info struct.\r
Experimental functions include the ability to set weighting and cost\r
factors for row filter selection, direct reads of integers from buffers\r
on big-endian processors that support misaligned data access, faster\r
methods of doing alpha composition, and more accurate 16->8 bit color\r
conversion.\r
\r
The additions since 0.89 include the ability to read from a PNG stream\r
which has had some (or all) of the signature bytes read by the calling\r
application.  This also allows the reading of embedded PNG streams that\r
do not have the PNG file signature.  As well, it is now possible to set\r
the library action on the detection of chunk CRC errors.  It is possible\r
to set different actions based on whether the CRC error occurred in a\r
critical or an ancillary chunk.\r
\r
The changes made to the library, and bugs fixed are based on discussions\r
on the PNG-implement mailing list and not on material submitted\r
privately to Guy, Andreas, or Glenn.  They will forward any good\r
suggestions to the list.\r
\r
For a detailed description on using libpng, read libpng-manual.txt.  For\r
examples of libpng in a program, see example.c and pngtest.c.  For usage\r
information and restrictions (what little they are) on libpng, see\r
png.h.  For a description on using zlib (the compression library used by\r
libpng) and zlib's restrictions, see zlib.h\r
\r
I have included a general makefile, as well as several machine and\r
compiler specific ones, but you may have to modify one for your own needs.\r
\r
You should use zlib 1.0.4 or later to run this, but it MAY work with\r
versions as old as zlib 0.95.  Even so, there are bugs in older zlib\r
versions which can cause the output of invalid compression streams for\r
some images.  You will definitely need zlib 1.0.4 or later if you are\r
taking advantage of the MS-DOS "far" structure allocation for the small\r
and medium memory models.  You should also note that zlib is a\r
compression library that is useful for more things than just PNG files.\r
You can use zlib as a drop-in replacement for fread() and fwrite() if\r
you are so inclined.\r
\r
zlib should be available at the same place that libpng is, or at zlib.net.\r
\r
You may also want a copy of the PNG specification.  It is available\r
as an RFC, a W3C Recommendation, and an ISO/IEC Standard.  You can find\r
these at http://www.libpng.org/pub/png/documents/\r
\r
This code is currently being archived at libpng.sf.net in the\r
[DOWNLOAD] area, and at ftp://ftp.simplesystems.org.  If you can't find it\r
in any of those places, e-mail me, and I'll help you find it.\r
\r
I am not a lawyer, but I believe that the Export Control Classification\r
Number (ECCN) for libpng is EAR99, which means not subject to export\r
controls or International Traffic in Arms Regulations (ITAR) because it\r
is open source, publicly available software, that does not contain any\r
encryption software.  See the EAR, paragraphs 734.3(b)(3) and 734.7(b).\r
\r
If you have any code changes, requests, problems, etc., please e-mail\r
them to me.  Also, I'd appreciate any make files or project files,\r
and any modifications you needed to make to get libpng to compile,\r
along with a #define variable to tell what compiler/system you are on.\r
If you needed to add transformations to libpng, or wish libpng would\r
provide the image in a different way, drop me a note (and code, if\r
possible), so I can consider supporting the transformation.\r
Finally, if you get any warning messages when compiling libpng\r
(note: not zlib), and they are easy to fix, I'd appreciate the\r
fix.  Please mention "libpng" somewhere in the subject line.  Thanks.\r
\r
This release was created and will be supported by myself (of course\r
based in a large way on Guy's and Andreas' earlier work), and the PNG\r
development group.\r
\r
Send comments/corrections/commendations to png-mng-implement at\r
lists.sourceforge.net (subscription required; visit\r
https://lists.sourceforge.net/lists/listinfo/png-mng-implement\r
to subscribe) or to glennrp at users.sourceforge.net\r
\r
You can't reach Guy, the original libpng author, at the addresses\r
given in previous versions of this document.  He and Andreas will\r
read mail addressed to the png-implement list, however.\r
\r
Please do not send general questions about PNG.  Send them to\r
png-mng-misc at lists.sf.net (subscription required; visit\r
https://lists.sourceforge.net/lists/listinfo/png-mng-misc to\r
subscribe).  If you have a question about something\r
in the PNG specification that is related to using libpng, send it\r
to me.  Send me any questions that start with "I was using libpng,\r
and ...".  If in doubt, send questions to me.  I'll bounce them\r
to others, if necessary.\r
\r
Please do not send suggestions on how to change PNG.  We have\r
been discussing PNG for twenty years now, and it is official and\r
finished.  If you have suggestions for libpng, however, I'll\r
gladly listen.  Even if your suggestion is not used immediately,\r
it may be used later.\r
\r
Files in this distribution:\r
\r
      ANNOUNCE      =>  Announcement of this version, with recent changes\r
      CHANGES       =>  Description of changes between libpng versions\r
      KNOWNBUG      =>  List of known bugs and deficiencies\r
      LICENSE       =>  License to use and redistribute libpng\r
      README        =>  This file\r
      TODO          =>  Things not implemented in the current library\r
      Y2KINFO       =>  Statement of Y2K compliance\r
      example.c     =>  Example code for using libpng functions\r
      libpng.3      =>  manual page for libpng (includes libpng-manual.txt)\r
      libpng-manual.txt  =>  Description of libpng and its functions\r
      libpngpf.3    =>  manual page for libpng's private functions\r
      png.5         =>  manual page for the PNG format\r
      png.c         =>  Basic interface functions common to library\r
      png.h         =>  Library function and interface declarations (public)\r
      pngpriv.h     =>  Library function and interface declarations (private)\r
      pngconf.h     =>  System specific library configuration (public)\r
      pngstruct.h   =>  png_struct declaration (private)\r
      pnginfo.h     =>  png_info struct declaration (private)\r
      pngdebug.h    =>  debugging macros (private)\r
      pngerror.c    =>  Error/warning message I/O functions\r
      pngget.c      =>  Functions for retrieving info from struct\r
      pngmem.c      =>  Memory handling functions\r
      pngbar.png    =>  PNG logo, 88x31\r
      pngnow.png    =>  PNG logo, 98x31\r
      pngpread.c    =>  Progressive reading functions\r
      pngread.c     =>  Read data/helper high-level functions\r
      pngrio.c      =>  Lowest-level data read I/O functions\r
      pngrtran.c    =>  Read data transformation functions\r
      pngrutil.c    =>  Read data utility functions\r
      pngset.c      =>  Functions for storing data into the info_struct\r
      pngtest.c     =>  Library test program\r
      pngtest.png   =>  Library test sample image\r
      pngtrans.c    =>  Common data transformation functions\r
      pngwio.c      =>  Lowest-level write I/O functions\r
      pngwrite.c    =>  High-level write functions\r
      pngwtran.c    =>  Write data transformations\r
      pngwutil.c    =>  Write utility functions\r
      arm           =>  Contains optimized code for the ARM platform\r
      contrib       =>  Contributions\r
       examples         =>  Example programs\r
       gregbook         =>  source code for PNG reading and writing, from\r
                            Greg Roelofs' "PNG: The Definitive Guide",\r
                            O'Reilly, 1999\r
       libtests         =>  Test programs\r
       pngminim         =>  Minimal decoder, encoder, and progressive decoder\r
                            programs demonstrating use of pngusr.dfa\r
       pngminus         =>  Simple pnm2png and png2pnm programs\r
       pngsuite         =>  Test images\r
       tools            =>  Various tools\r
       visupng          =>  Contains a MSVC workspace for VisualPng\r
      projects      =>  Contains project files and workspaces for\r
                        building a DLL\r
       owatcom          =>  Contains a WATCOM project for building libpng\r
       visualc71        =>  Contains a Microsoft Visual C++ (MSVC)\r
                            workspace for building libpng and zlib\r
       vstudio          =>  Contains a Microsoft Visual C++ (MSVC)\r
                            workspace for building libpng and zlib\r
      scripts       =>  Directory containing scripts for building libpng:\r
                            (see scripts/README.txt for the list of scripts)\r
\r
Good luck, and happy coding.\r
\r
-Glenn Randers-Pehrson (current maintainer, since 1998)\r
 Internet: glennrp at users.sourceforge.net\r
\r
-Andreas Eric Dilger (former maintainer, 1996-1997)\r
 Internet: adilger at enel.ucalgary.ca\r
 Web: http://www-mddsp.enel.ucalgary.ca/People/adilger/\r
\r
-Guy Eric Schalnat (original author and former maintainer, 1995-1996)\r
 (formerly of Group 42, Inc)\r
 Internet: gschal at infinet.com\r