README 10.2 KB
Newer Older
1
README for libpng version 1.6.6 - September 16, 2013 (shared library 16.0)
2
See the note about version numbers near the top of png.h
A
Andreas Dilger 已提交
3

4
See INSTALL for instructions on how to install libpng.
5

6 7 8
Libpng comes in several distribution formats.  Get libpng-*.tar.gz or
libpng-*.tar.xz or if you want UNIX-style line endings in the text files,
or lpng*.7z or lpng*.zip if you want DOS-style line endings.
9

10 11 12 13
Version 0.89 was the first official release of libpng.  Don't let the
fact that it's the first release fool you.  The libpng library has been in
extensive use and testing since mid-1995.  By late 1997 it had
finally gotten to the stage where there hadn't been significant
14
changes to the API in some time, and people have a bad feeling about
15 16
libraries with versions < 1.0.  Version 1.0.0 was released in
March 1998.
17

A
Andreas Dilger 已提交
18 19 20 21 22
****
Note that some of the changes to the png_info structure render this
version of the library binary incompatible with libpng-0.89 or
earlier versions if you are using a shared library.  The type of the
"filler" parameter for png_set_filler() has changed from png_byte to
23
png_uint_32, which will affect shared-library applications that use
A
Andreas Dilger 已提交
24 25 26 27 28 29 30 31
this function.

To avoid problems with changes to the internals of png_info_struct,
new APIs have been made available in 0.95 to avoid direct application
access to info_ptr.  These functions are the png_set_<chunk> and
png_get_<chunk> functions.  These functions should be used when
accessing/storing the info_struct data, rather than manipulating it
directly, to avoid such problems in the future.
32 33

It is important to note that the APIs do not make current programs
34
that access the info struct directly incompatible with the new
35
library.  However, it is strongly suggested that new programs use
36 37
the new APIs (as shown in example.c and pngtest.c), and older programs
be converted to the new format, to facilitate upgrades in the future.
A
Andreas Dilger 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
****

Additions since 0.90 include the ability to compile libpng as a
Windows DLL, and new APIs for accessing data in the info struct.
Experimental functions include the ability to set weighting and cost
factors for row filter selection, direct reads of integers from buffers
on big-endian processors that support misaligned data access, faster
methods of doing alpha composition, and more accurate 16->8 bit color
conversion.

The additions since 0.89 include the ability to read from a PNG stream
which has had some (or all) of the signature bytes read by the calling
application.  This also allows the reading of embedded PNG streams that
do not have the PNG file signature.  As well, it is now possible to set
the library action on the detection of chunk CRC errors.  It is possible
to set different actions based on whether the CRC error occurred in a
critical or an ancillary chunk.
A
Andreas Dilger 已提交
55 56

The changes made to the library, and bugs fixed are based on discussions
G
Glenn Randers-Pehrson 已提交
57 58 59
on the PNG-implement mailing list and not on material submitted
privately to Guy, Andreas, or Glenn.  They will forward any good
suggestions to the list.
A
Andreas Dilger 已提交
60

61
For a detailed description on using libpng, read libpng-manual.txt.  For
A
Andreas Dilger 已提交
62 63 64 65
examples of libpng in a program, see example.c and pngtest.c.  For usage
information and restrictions (what little they are) on libpng, see
png.h.  For a description on using zlib (the compression library used by
libpng) and zlib's restrictions, see zlib.h
A
Andreas Dilger 已提交
66

A
Andreas Dilger 已提交
67 68
I have included a general makefile, as well as several machine and
compiler specific ones, but you may have to modify one for your own needs.
A
Andreas Dilger 已提交
69 70 71 72 73 74 75 76 77 78 79

You should use zlib 1.0.4 or later to run this, but it MAY work with
versions as old as zlib 0.95.  Even so, there are bugs in older zlib
versions which can cause the output of invalid compression streams for
some images.  You will definitely need zlib 1.0.4 or later if you are
taking advantage of the MS-DOS "far" structure allocation for the small
and medium memory models.  You should also note that zlib is a
compression library that is useful for more things than just PNG files.
You can use zlib as a drop-in replacement for fread() and fwrite() if
you are so inclined.

80
zlib should be available at the same place that libpng is, or at zlib.net.
A
Andreas Dilger 已提交
81 82

You may also want a copy of the PNG specification.  It is available
83 84
as an RFC, a W3C Recommendation, and an ISO/IEC Standard.  You can find
these at http://www.libpng.org/pub/png/documents/
A
Andreas Dilger 已提交
85

86
This code is currently being archived at libpng.sf.net in the
87 88
[DOWNLOAD] area, and at ftp://ftp.simplesystems.org.  If you can't find it
in any of those places, e-mail me, and I'll help you find it.
A
Andreas Dilger 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101

If you have any code changes, requests, problems, etc., please e-mail
them to me.  Also, I'd appreciate any make files or project files,
and any modifications you needed to make to get libpng to compile,
along with a #define variable to tell what compiler/system you are on.
If you needed to add transformations to libpng, or wish libpng would
provide the image in a different way, drop me a note (and code, if
possible), so I can consider supporting the transformation.
Finally, if you get any warning messages when compiling libpng
(note: not zlib), and they are easy to fix, I'd appreciate the
fix.  Please mention "libpng" somewhere in the subject line.  Thanks.

This release was created and will be supported by myself (of course
G
Glenn Randers-Pehrson 已提交
102 103
based in a large way on Guy's and Andreas' earlier work), and the PNG
development group.
A
Andreas Dilger 已提交
104

G
Glenn Randers-Pehrson 已提交
105
Send comments/corrections/commendations to png-mng-implement at
106
lists.sourceforge.net (subscription required; visit
107 108
https://lists.sourceforge.net/lists/listinfo/png-mng-implement
to subscribe) or to glennrp at users.sourceforge.net
A
Andreas Dilger 已提交
109

110
You can't reach Guy, the original libpng author, at the addresses
G
Glenn Randers-Pehrson 已提交
111 112
given in previous versions of this document.  He and Andreas will
read mail addressed to the png-implement list, however.
A
Andreas Dilger 已提交
113 114

Please do not send general questions about PNG.  Send them to
115 116 117
png-mng-misc at lists.sf.net (subscription required; visit
https://lists.sourceforge.net/lists/listinfo/png-mng-misc to
subscribe).  If you have a question about something
A
Andreas Dilger 已提交
118 119 120 121 122 123
in the PNG specification that is related to using libpng, send it
to me.  Send me any questions that start with "I was using libpng,
and ...".  If in doubt, send questions to me.  I'll bounce them
to others, if necessary.

Please do not send suggestions on how to change PNG.  We have
124
been discussing PNG for eighteen years now, and it is official and
A
Andreas Dilger 已提交
125
finished.  If you have suggestions for libpng, however, I'll
126 127
gladly listen.  Even if your suggestion is not used immediately,
it may be used later.
A
Andreas Dilger 已提交
128 129 130

Files in this distribution:

131
      ANNOUNCE      =>  Announcement of this version, with recent changes
A
Andreas Dilger 已提交
132
      CHANGES       =>  Description of changes between libpng versions
133 134
      KNOWNBUG      =>  List of known bugs and deficiencies
      LICENSE       =>  License to use and redistribute libpng
A
Andreas Dilger 已提交
135 136
      README        =>  This file
      TODO          =>  Things not implemented in the current library
137
      Y2KINFO       =>  Statement of Y2K compliance
A
Andreas Dilger 已提交
138
      example.c     =>  Example code for using libpng functions
139 140
      libpng.3      =>  manual page for libpng (includes libpng-manual.txt)
      libpng-manual.txt  =>  Description of libpng and its functions
141 142
      libpngpf.3    =>  manual page for libpng's private functions
      png.5         =>  manual page for the PNG format
A
Andreas Dilger 已提交
143
      png.c         =>  Basic interface functions common to library
144 145 146 147 148 149
      png.h         =>  Library function and interface declarations (public)
      pngpriv.h     =>  Library function and interface declarations (private)
      pngconf.h     =>  System specific library configuration (public)
      pngstruct.h   =>  png_struct declaration (private)
      pnginfo.h     =>  png_info struct declaration (private)
      pngdebug.h    =>  debugging macros (private)
A
Andreas Dilger 已提交
150
      pngerror.c    =>  Error/warning message I/O functions
151
      pngget.c      =>  Functions for retrieving info from struct
A
Andreas Dilger 已提交
152
      pngmem.c      =>  Memory handling functions
153 154
      pngbar.png    =>  PNG logo, 88x31
      pngnow.png    =>  PNG logo, 98x31
A
Andreas Dilger 已提交
155 156 157 158 159
      pngpread.c    =>  Progressive reading functions
      pngread.c     =>  Read data/helper high-level functions
      pngrio.c      =>  Lowest-level data read I/O functions
      pngrtran.c    =>  Read data transformation functions
      pngrutil.c    =>  Read data utility functions
A
Andreas Dilger 已提交
160
      pngset.c      =>  Functions for storing data into the info_struct
A
Andreas Dilger 已提交
161 162 163 164 165 166 167
      pngtest.c     =>  Library test program
      pngtest.png   =>  Library test sample image
      pngtrans.c    =>  Common data transformation functions
      pngwio.c      =>  Lowest-level write I/O functions
      pngwrite.c    =>  High-level write functions
      pngwtran.c    =>  Write data transformations
      pngwutil.c    =>  Write utility functions
168
      arm           =>  Contains optimized code for the ARM platform
169
      contrib       =>  Contributions
170
       examples         =>  Example programs
171 172 173
       gregbook         =>  source code for PNG reading and writing, from
                            Greg Roelofs' "PNG: The Definitive Guide",
                            O'Reilly, 1999
174 175 176 177 178 179
       libtests         =>  Test programs
       pngminim         =>  Minimal decoder, encoder, and progressive decoder
                            programs demonstrating use of pngusr.dfa
       pngminus         =>  Simple pnm2png and png2pnm programs
       pngsuite         =>  Test images
       tools            =>  Various tools
180
       visupng      =>  Contains a MSVC workspace for VisualPng
G
Glenn Randers-Pehrson 已提交
181 182
      projects      =>  Contains project files and workspaces for
                        building a DLL
183
       owatcom          =>  Contains a WATCOM project for building libpng
184 185
       visualc71        =>  Contains a Microsoft Visual C++ (MSVC)
                            workspace for building libpng and zlib
186
       vstudio          =>  Contains a Microsoft Visual C++ (MSVC)
187
                            workspace for building libpng and zlib
188
      scripts       =>  Directory containing scripts for building libpng:
189
                            (see scripts/README.txt for the list of scripts)
A
Andreas Dilger 已提交
190 191 192

Good luck, and happy coding.

193
-Glenn Randers-Pehrson (current maintainer, since 1998)
194
 Internet: glennrp at users.sourceforge.net
195

196
-Andreas Eric Dilger (former maintainer, 1996-1997)
197
 Internet: adilger at enel.ucalgary.ca
A
Andreas Dilger 已提交
198
 Web: http://www-mddsp.enel.ucalgary.ca/People/adilger/
A
Andreas Dilger 已提交
199

200
-Guy Eric Schalnat (original author and former maintainer, 1995-1996)
201
 (formerly of Group 42, Inc)
202
 Internet: gschal at infinet.com