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