|
1 libpng-manual.txt - A description on how to use and modify libpng |
|
2 |
|
3 libpng version 1.6.9 - February 6, 2014 |
|
4 Updated and distributed by Glenn Randers-Pehrson |
|
5 <glennrp at users.sourceforge.net> |
|
6 Copyright (c) 1998-2014 Glenn Randers-Pehrson |
|
7 |
|
8 This document is released under the libpng license. |
|
9 For conditions of distribution and use, see the disclaimer |
|
10 and license in png.h |
|
11 |
|
12 Based on: |
|
13 |
|
14 libpng versions 0.97, January 1998, through 1.6.9 - February 6, 2014 |
|
15 Updated and distributed by Glenn Randers-Pehrson |
|
16 Copyright (c) 1998-2014 Glenn Randers-Pehrson |
|
17 |
|
18 libpng 1.0 beta 6 version 0.96 May 28, 1997 |
|
19 Updated and distributed by Andreas Dilger |
|
20 Copyright (c) 1996, 1997 Andreas Dilger |
|
21 |
|
22 libpng 1.0 beta 2 - version 0.88 January 26, 1996 |
|
23 For conditions of distribution and use, see copyright |
|
24 notice in png.h. Copyright (c) 1995, 1996 Guy Eric |
|
25 Schalnat, Group 42, Inc. |
|
26 |
|
27 Updated/rewritten per request in the libpng FAQ |
|
28 Copyright (c) 1995, 1996 Frank J. T. Wojcik |
|
29 December 18, 1995 & January 20, 1996 |
|
30 |
|
31 TABLE OF CONTENTS |
|
32 |
|
33 I. Introduction |
|
34 II. Structures |
|
35 III. Reading |
|
36 IV. Writing |
|
37 V. Simplified API |
|
38 VI. Modifying/Customizing libpng |
|
39 VII. MNG support |
|
40 VIII. Changes to Libpng from version 0.88 |
|
41 IX. Changes to Libpng from version 1.0.x to 1.2.x |
|
42 X. Changes to Libpng from version 1.0.x/1.2.x to 1.4.x |
|
43 XI. Changes to Libpng from version 1.4.x to 1.5.x |
|
44 XII. Changes to Libpng from version 1.5.x to 1.6.x |
|
45 XIII. Detecting libpng |
|
46 XIV. Source code repository |
|
47 XV. Coding style |
|
48 XVI. Y2K Compliance in libpng |
|
49 |
|
50 I. Introduction |
|
51 |
|
52 This file describes how to use and modify the PNG reference library |
|
53 (known as libpng) for your own use. In addition to this |
|
54 file, example.c is a good starting point for using the library, as |
|
55 it is heavily commented and should include everything most people |
|
56 will need. We assume that libpng is already installed; see the |
|
57 INSTALL file for instructions on how to install libpng. |
|
58 |
|
59 For examples of libpng usage, see the files "example.c", "pngtest.c", |
|
60 and the files in the "contrib" directory, all of which are included in |
|
61 the libpng distribution. |
|
62 |
|
63 Libpng was written as a companion to the PNG specification, as a way |
|
64 of reducing the amount of time and effort it takes to support the PNG |
|
65 file format in application programs. |
|
66 |
|
67 The PNG specification (second edition), November 2003, is available as |
|
68 a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2004 (E)) at |
|
69 <http://www.w3.org/TR/2003/REC-PNG-20031110/ |
|
70 The W3C and ISO documents have identical technical content. |
|
71 |
|
72 The PNG-1.2 specification is available at |
|
73 <http://www.libpng.org/pub/png/documents/>. It is technically equivalent |
|
74 to the PNG specification (second edition) but has some additional material. |
|
75 |
|
76 The PNG-1.0 specification is available |
|
77 as RFC 2083 <http://www.libpng.org/pub/png/documents/> and as a |
|
78 W3C Recommendation <http://www.w3.org/TR/REC.png.html>. |
|
79 |
|
80 Some additional chunks are described in the special-purpose public chunks |
|
81 documents at <http://www.libpng.org/pub/png/documents/>. |
|
82 |
|
83 Other information |
|
84 about PNG, and the latest version of libpng, can be found at the PNG home |
|
85 page, <http://www.libpng.org/pub/png/>. |
|
86 |
|
87 Most users will not have to modify the library significantly; advanced |
|
88 users may want to modify it more. All attempts were made to make it as |
|
89 complete as possible, while keeping the code easy to understand. |
|
90 Currently, this library only supports C. Support for other languages |
|
91 is being considered. |
|
92 |
|
93 Libpng has been designed to handle multiple sessions at one time, |
|
94 to be easily modifiable, to be portable to the vast majority of |
|
95 machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy |
|
96 to use. The ultimate goal of libpng is to promote the acceptance of |
|
97 the PNG file format in whatever way possible. While there is still |
|
98 work to be done (see the TODO file), libpng should cover the |
|
99 majority of the needs of its users. |
|
100 |
|
101 Libpng uses zlib for its compression and decompression of PNG files. |
|
102 Further information about zlib, and the latest version of zlib, can |
|
103 be found at the zlib home page, <http://www.info-zip.org/pub/infozip/zlib/>. |
|
104 The zlib compression utility is a general purpose utility that is |
|
105 useful for more than PNG files, and can be used without libpng. |
|
106 See the documentation delivered with zlib for more details. |
|
107 You can usually find the source files for the zlib utility wherever you |
|
108 find the libpng source files. |
|
109 |
|
110 Libpng is thread safe, provided the threads are using different |
|
111 instances of the structures. Each thread should have its own |
|
112 png_struct and png_info instances, and thus its own image. |
|
113 Libpng does not protect itself against two threads using the |
|
114 same instance of a structure. |
|
115 |
|
116 II. Structures |
|
117 |
|
118 There are two main structures that are important to libpng, png_struct |
|
119 and png_info. Both are internal structures that are no longer exposed |
|
120 in the libpng interface (as of libpng 1.5.0). |
|
121 |
|
122 The png_info structure is designed to provide information about the |
|
123 PNG file. At one time, the fields of png_info were intended to be |
|
124 directly accessible to the user. However, this tended to cause problems |
|
125 with applications using dynamically loaded libraries, and as a result |
|
126 a set of interface functions for png_info (the png_get_*() and png_set_*() |
|
127 functions) was developed, and direct access to the png_info fields was |
|
128 deprecated.. |
|
129 |
|
130 The png_struct structure is the object used by the library to decode a |
|
131 single image. As of 1.5.0 this structure is also not exposed. |
|
132 |
|
133 Almost all libpng APIs require a pointer to a png_struct as the first argument. |
|
134 Many (in particular the png_set and png_get APIs) also require a pointer |
|
135 to png_info as the second argument. Some application visible macros |
|
136 defined in png.h designed for basic data access (reading and writing |
|
137 integers in the PNG format) don't take a png_info pointer, but it's almost |
|
138 always safe to assume that a (png_struct*) has to be passed to call an API |
|
139 function. |
|
140 |
|
141 You can have more than one png_info structure associated with an image, |
|
142 as illustrated in pngtest.c, one for information valid prior to the |
|
143 IDAT chunks and another (called "end_info" below) for things after them. |
|
144 |
|
145 The png.h header file is an invaluable reference for programming with libpng. |
|
146 And while I'm on the topic, make sure you include the libpng header file: |
|
147 |
|
148 #include <png.h> |
|
149 |
|
150 and also (as of libpng-1.5.0) the zlib header file, if you need it: |
|
151 |
|
152 #include <zlib.h> |
|
153 |
|
154 Types |
|
155 |
|
156 The png.h header file defines a number of integral types used by the |
|
157 APIs. Most of these are fairly obvious; for example types corresponding |
|
158 to integers of particular sizes and types for passing color values. |
|
159 |
|
160 One exception is how non-integral numbers are handled. For application |
|
161 convenience most APIs that take such numbers have C (double) arguments; |
|
162 however, internally PNG, and libpng, use 32 bit signed integers and encode |
|
163 the value by multiplying by 100,000. As of libpng 1.5.0 a convenience |
|
164 macro PNG_FP_1 is defined in png.h along with a type (png_fixed_point) |
|
165 which is simply (png_int_32). |
|
166 |
|
167 All APIs that take (double) arguments also have a matching API that |
|
168 takes the corresponding fixed point integer arguments. The fixed point |
|
169 API has the same name as the floating point one with "_fixed" appended. |
|
170 The actual range of values permitted in the APIs is frequently less than |
|
171 the full range of (png_fixed_point) (-21474 to +21474). When APIs require |
|
172 a non-negative argument the type is recorded as png_uint_32 above. Consult |
|
173 the header file and the text below for more information. |
|
174 |
|
175 Special care must be take with sCAL chunk handling because the chunk itself |
|
176 uses non-integral values encoded as strings containing decimal floating point |
|
177 numbers. See the comments in the header file. |
|
178 |
|
179 Configuration |
|
180 |
|
181 The main header file function declarations are frequently protected by C |
|
182 preprocessing directives of the form: |
|
183 |
|
184 #ifdef PNG_feature_SUPPORTED |
|
185 declare-function |
|
186 #endif |
|
187 ... |
|
188 #ifdef PNG_feature_SUPPORTED |
|
189 use-function |
|
190 #endif |
|
191 |
|
192 The library can be built without support for these APIs, although a |
|
193 standard build will have all implemented APIs. Application programs |
|
194 should check the feature macros before using an API for maximum |
|
195 portability. From libpng 1.5.0 the feature macros set during the build |
|
196 of libpng are recorded in the header file "pnglibconf.h" and this file |
|
197 is always included by png.h. |
|
198 |
|
199 If you don't need to change the library configuration from the default, skip to |
|
200 the next section ("Reading"). |
|
201 |
|
202 Notice that some of the makefiles in the 'scripts' directory and (in 1.5.0) all |
|
203 of the build project files in the 'projects' directory simply copy |
|
204 scripts/pnglibconf.h.prebuilt to pnglibconf.h. This means that these build |
|
205 systems do not permit easy auto-configuration of the library - they only |
|
206 support the default configuration. |
|
207 |
|
208 The easiest way to make minor changes to the libpng configuration when |
|
209 auto-configuration is supported is to add definitions to the command line |
|
210 using (typically) CPPFLAGS. For example: |
|
211 |
|
212 CPPFLAGS=-DPNG_NO_FLOATING_ARITHMETIC |
|
213 |
|
214 will change the internal libpng math implementation for gamma correction and |
|
215 other arithmetic calculations to fixed point, avoiding the need for fast |
|
216 floating point support. The result can be seen in the generated pnglibconf.h - |
|
217 make sure it contains the changed feature macro setting. |
|
218 |
|
219 If you need to make more extensive configuration changes - more than one or two |
|
220 feature macro settings - you can either add -DPNG_USER_CONFIG to the build |
|
221 command line and put a list of feature macro settings in pngusr.h or you can set |
|
222 DFA_XTRA (a makefile variable) to a file containing the same information in the |
|
223 form of 'option' settings. |
|
224 |
|
225 A. Changing pnglibconf.h |
|
226 |
|
227 A variety of methods exist to build libpng. Not all of these support |
|
228 reconfiguration of pnglibconf.h. To reconfigure pnglibconf.h it must either be |
|
229 rebuilt from scripts/pnglibconf.dfa using awk or it must be edited by hand. |
|
230 |
|
231 Hand editing is achieved by copying scripts/pnglibconf.h.prebuilt to |
|
232 pnglibconf.h and changing the lines defining the supported features, paying |
|
233 very close attention to the 'option' information in scripts/pnglibconf.dfa |
|
234 that describes those features and their requirements. This is easy to get |
|
235 wrong. |
|
236 |
|
237 B. Configuration using DFA_XTRA |
|
238 |
|
239 Rebuilding from pnglibconf.dfa is easy if a functioning 'awk', or a later |
|
240 variant such as 'nawk' or 'gawk', is available. The configure build will |
|
241 automatically find an appropriate awk and build pnglibconf.h. |
|
242 The scripts/pnglibconf.mak file contains a set of make rules for doing the |
|
243 same thing if configure is not used, and many of the makefiles in the scripts |
|
244 directory use this approach. |
|
245 |
|
246 When rebuilding simply write a new file containing changed options and set |
|
247 DFA_XTRA to the name of this file. This causes the build to append the new file |
|
248 to the end of scripts/pnglibconf.dfa. The pngusr.dfa file should contain lines |
|
249 of the following forms: |
|
250 |
|
251 everything = off |
|
252 |
|
253 This turns all optional features off. Include it at the start of pngusr.dfa to |
|
254 make it easier to build a minimal configuration. You will need to turn at least |
|
255 some features on afterward to enable either reading or writing code, or both. |
|
256 |
|
257 option feature on |
|
258 option feature off |
|
259 |
|
260 Enable or disable a single feature. This will automatically enable other |
|
261 features required by a feature that is turned on or disable other features that |
|
262 require a feature which is turned off. Conflicting settings will cause an error |
|
263 message to be emitted by awk. |
|
264 |
|
265 setting feature default value |
|
266 |
|
267 Changes the default value of setting 'feature' to 'value'. There are a small |
|
268 number of settings listed at the top of pnglibconf.h, they are documented in the |
|
269 source code. Most of these values have performance implications for the library |
|
270 but most of them have no visible effect on the API. Some can also be overridden |
|
271 from the API. |
|
272 |
|
273 This method of building a customized pnglibconf.h is illustrated in |
|
274 contrib/pngminim/*. See the "$(PNGCONF):" target in the makefile and |
|
275 pngusr.dfa in these directories. |
|
276 |
|
277 C. Configuration using PNG_USR_CONFIG |
|
278 |
|
279 If -DPNG_USR_CONFIG is added to the CFLAGS when pnglibconf.h is built the file |
|
280 pngusr.h will automatically be included before the options in |
|
281 scripts/pnglibconf.dfa are processed. Your pngusr.h file should contain only |
|
282 macro definitions turning features on or off or setting settings. |
|
283 |
|
284 Apart from the global setting "everything = off" all the options listed above |
|
285 can be set using macros in pngusr.h: |
|
286 |
|
287 #define PNG_feature_SUPPORTED |
|
288 |
|
289 is equivalent to: |
|
290 |
|
291 option feature on |
|
292 |
|
293 #define PNG_NO_feature |
|
294 |
|
295 is equivalent to: |
|
296 |
|
297 option feature off |
|
298 |
|
299 #define PNG_feature value |
|
300 |
|
301 is equivalent to: |
|
302 |
|
303 setting feature default value |
|
304 |
|
305 Notice that in both cases, pngusr.dfa and pngusr.h, the contents of the |
|
306 pngusr file you supply override the contents of scripts/pnglibconf.dfa |
|
307 |
|
308 If confusing or incomprehensible behavior results it is possible to |
|
309 examine the intermediate file pnglibconf.dfn to find the full set of |
|
310 dependency information for each setting and option. Simply locate the |
|
311 feature in the file and read the C comments that precede it. |
|
312 |
|
313 This method is also illustrated in the contrib/pngminim/* makefiles and |
|
314 pngusr.h. |
|
315 |
|
316 III. Reading |
|
317 |
|
318 We'll now walk you through the possible functions to call when reading |
|
319 in a PNG file sequentially, briefly explaining the syntax and purpose |
|
320 of each one. See example.c and png.h for more detail. While |
|
321 progressive reading is covered in the next section, you will still |
|
322 need some of the functions discussed in this section to read a PNG |
|
323 file. |
|
324 |
|
325 Setup |
|
326 |
|
327 You will want to do the I/O initialization(*) before you get into libpng, |
|
328 so if it doesn't work, you don't have much to undo. Of course, you |
|
329 will also want to insure that you are, in fact, dealing with a PNG |
|
330 file. Libpng provides a simple check to see if a file is a PNG file. |
|
331 To use it, pass in the first 1 to 8 bytes of the file to the function |
|
332 png_sig_cmp(), and it will return 0 (false) if the bytes match the |
|
333 corresponding bytes of the PNG signature, or nonzero (true) otherwise. |
|
334 Of course, the more bytes you pass in, the greater the accuracy of the |
|
335 prediction. |
|
336 |
|
337 If you are intending to keep the file pointer open for use in libpng, |
|
338 you must ensure you don't read more than 8 bytes from the beginning |
|
339 of the file, and you also have to make a call to png_set_sig_bytes_read() |
|
340 with the number of bytes you read from the beginning. Libpng will |
|
341 then only check the bytes (if any) that your program didn't read. |
|
342 |
|
343 (*): If you are not using the standard I/O functions, you will need |
|
344 to replace them with custom functions. See the discussion under |
|
345 Customizing libpng. |
|
346 |
|
347 |
|
348 FILE *fp = fopen(file_name, "rb"); |
|
349 if (!fp) |
|
350 { |
|
351 return (ERROR); |
|
352 } |
|
353 |
|
354 fread(header, 1, number, fp); |
|
355 is_png = !png_sig_cmp(header, 0, number); |
|
356 |
|
357 if (!is_png) |
|
358 { |
|
359 return (NOT_PNG); |
|
360 } |
|
361 |
|
362 |
|
363 Next, png_struct and png_info need to be allocated and initialized. In |
|
364 order to ensure that the size of these structures is correct even with a |
|
365 dynamically linked libpng, there are functions to initialize and |
|
366 allocate the structures. We also pass the library version, optional |
|
367 pointers to error handling functions, and a pointer to a data struct for |
|
368 use by the error functions, if necessary (the pointer and functions can |
|
369 be NULL if the default error handlers are to be used). See the section |
|
370 on Changes to Libpng below regarding the old initialization functions. |
|
371 The structure allocation functions quietly return NULL if they fail to |
|
372 create the structure, so your application should check for that. |
|
373 |
|
374 png_structp png_ptr = png_create_read_struct |
|
375 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr, |
|
376 user_error_fn, user_warning_fn); |
|
377 |
|
378 if (!png_ptr) |
|
379 return (ERROR); |
|
380 |
|
381 png_infop info_ptr = png_create_info_struct(png_ptr); |
|
382 |
|
383 if (!info_ptr) |
|
384 { |
|
385 png_destroy_read_struct(&png_ptr, |
|
386 (png_infopp)NULL, (png_infopp)NULL); |
|
387 return (ERROR); |
|
388 } |
|
389 |
|
390 If you want to use your own memory allocation routines, |
|
391 use a libpng that was built with PNG_USER_MEM_SUPPORTED defined, and use |
|
392 png_create_read_struct_2() instead of png_create_read_struct(): |
|
393 |
|
394 png_structp png_ptr = png_create_read_struct_2 |
|
395 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr, |
|
396 user_error_fn, user_warning_fn, (png_voidp) |
|
397 user_mem_ptr, user_malloc_fn, user_free_fn); |
|
398 |
|
399 The error handling routines passed to png_create_read_struct() |
|
400 and the memory alloc/free routines passed to png_create_struct_2() |
|
401 are only necessary if you are not using the libpng supplied error |
|
402 handling and memory alloc/free functions. |
|
403 |
|
404 When libpng encounters an error, it expects to longjmp back |
|
405 to your routine. Therefore, you will need to call setjmp and pass |
|
406 your png_jmpbuf(png_ptr). If you read the file from different |
|
407 routines, you will need to update the longjmp buffer every time you enter |
|
408 a new routine that will call a png_*() function. |
|
409 |
|
410 See your documentation of setjmp/longjmp for your compiler for more |
|
411 information on setjmp/longjmp. See the discussion on libpng error |
|
412 handling in the Customizing Libpng section below for more information |
|
413 on the libpng error handling. If an error occurs, and libpng longjmp's |
|
414 back to your setjmp, you will want to call png_destroy_read_struct() to |
|
415 free any memory. |
|
416 |
|
417 if (setjmp(png_jmpbuf(png_ptr))) |
|
418 { |
|
419 png_destroy_read_struct(&png_ptr, &info_ptr, |
|
420 &end_info); |
|
421 fclose(fp); |
|
422 return (ERROR); |
|
423 } |
|
424 |
|
425 Pass (png_infopp)NULL instead of &end_info if you didn't create |
|
426 an end_info structure. |
|
427 |
|
428 If you would rather avoid the complexity of setjmp/longjmp issues, |
|
429 you can compile libpng with PNG_NO_SETJMP, in which case |
|
430 errors will result in a call to PNG_ABORT() which defaults to abort(). |
|
431 |
|
432 You can #define PNG_ABORT() to a function that does something |
|
433 more useful than abort(), as long as your function does not |
|
434 return. |
|
435 |
|
436 Now you need to set up the input code. The default for libpng is to |
|
437 use the C function fread(). If you use this, you will need to pass a |
|
438 valid FILE * in the function png_init_io(). Be sure that the file is |
|
439 opened in binary mode. If you wish to handle reading data in another |
|
440 way, you need not call the png_init_io() function, but you must then |
|
441 implement the libpng I/O methods discussed in the Customizing Libpng |
|
442 section below. |
|
443 |
|
444 png_init_io(png_ptr, fp); |
|
445 |
|
446 If you had previously opened the file and read any of the signature from |
|
447 the beginning in order to see if this was a PNG file, you need to let |
|
448 libpng know that there are some bytes missing from the start of the file. |
|
449 |
|
450 png_set_sig_bytes(png_ptr, number); |
|
451 |
|
452 You can change the zlib compression buffer size to be used while |
|
453 reading compressed data with |
|
454 |
|
455 png_set_compression_buffer_size(png_ptr, buffer_size); |
|
456 |
|
457 where the default size is 8192 bytes. Note that the buffer size |
|
458 is changed immediately and the buffer is reallocated immediately, |
|
459 instead of setting a flag to be acted upon later. |
|
460 |
|
461 If you want CRC errors to be handled in a different manner than |
|
462 the default, use |
|
463 |
|
464 png_set_crc_action(png_ptr, crit_action, ancil_action); |
|
465 |
|
466 The values for png_set_crc_action() say how libpng is to handle CRC errors in |
|
467 ancillary and critical chunks, and whether to use the data contained |
|
468 therein. Note that it is impossible to "discard" data in a critical |
|
469 chunk. |
|
470 |
|
471 Choices for (int) crit_action are |
|
472 PNG_CRC_DEFAULT 0 error/quit |
|
473 PNG_CRC_ERROR_QUIT 1 error/quit |
|
474 PNG_CRC_WARN_USE 3 warn/use data |
|
475 PNG_CRC_QUIET_USE 4 quiet/use data |
|
476 PNG_CRC_NO_CHANGE 5 use the current value |
|
477 |
|
478 Choices for (int) ancil_action are |
|
479 PNG_CRC_DEFAULT 0 error/quit |
|
480 PNG_CRC_ERROR_QUIT 1 error/quit |
|
481 PNG_CRC_WARN_DISCARD 2 warn/discard data |
|
482 PNG_CRC_WARN_USE 3 warn/use data |
|
483 PNG_CRC_QUIET_USE 4 quiet/use data |
|
484 PNG_CRC_NO_CHANGE 5 use the current value |
|
485 |
|
486 Setting up callback code |
|
487 |
|
488 You can set up a callback function to handle any unknown chunks in the |
|
489 input stream. You must supply the function |
|
490 |
|
491 read_chunk_callback(png_structp png_ptr, |
|
492 png_unknown_chunkp chunk); |
|
493 { |
|
494 /* The unknown chunk structure contains your |
|
495 chunk data, along with similar data for any other |
|
496 unknown chunks: */ |
|
497 |
|
498 png_byte name[5]; |
|
499 png_byte *data; |
|
500 png_size_t size; |
|
501 |
|
502 /* Note that libpng has already taken care of |
|
503 the CRC handling */ |
|
504 |
|
505 /* put your code here. Search for your chunk in the |
|
506 unknown chunk structure, process it, and return one |
|
507 of the following: */ |
|
508 |
|
509 return (-n); /* chunk had an error */ |
|
510 return (0); /* did not recognize */ |
|
511 return (n); /* success */ |
|
512 } |
|
513 |
|
514 (You can give your function another name that you like instead of |
|
515 "read_chunk_callback") |
|
516 |
|
517 To inform libpng about your function, use |
|
518 |
|
519 png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr, |
|
520 read_chunk_callback); |
|
521 |
|
522 This names not only the callback function, but also a user pointer that |
|
523 you can retrieve with |
|
524 |
|
525 png_get_user_chunk_ptr(png_ptr); |
|
526 |
|
527 If you call the png_set_read_user_chunk_fn() function, then all unknown |
|
528 chunks which the callback does not handle will be saved when read. You can |
|
529 cause them to be discarded by returning '1' ("handled") instead of '0'. This |
|
530 behavior will change in libpng 1.7 and the default handling set by the |
|
531 png_set_keep_unknown_chunks() function, described below, will be used when the |
|
532 callback returns 0. If you want the existing behavior you should set the global |
|
533 default to PNG_HANDLE_CHUNK_IF_SAFE now; this is compatible with all current |
|
534 versions of libpng and with 1.7. Libpng 1.6 issues a warning if you keep the |
|
535 default, or PNG_HANDLE_CHUNK_NEVER, and the callback returns 0. |
|
536 |
|
537 At this point, you can set up a callback function that will be |
|
538 called after each row has been read, which you can use to control |
|
539 a progress meter or the like. It's demonstrated in pngtest.c. |
|
540 You must supply a function |
|
541 |
|
542 void read_row_callback(png_structp png_ptr, |
|
543 png_uint_32 row, int pass); |
|
544 { |
|
545 /* put your code here */ |
|
546 } |
|
547 |
|
548 (You can give it another name that you like instead of "read_row_callback") |
|
549 |
|
550 To inform libpng about your function, use |
|
551 |
|
552 png_set_read_status_fn(png_ptr, read_row_callback); |
|
553 |
|
554 When this function is called the row has already been completely processed and |
|
555 the 'row' and 'pass' refer to the next row to be handled. For the |
|
556 non-interlaced case the row that was just handled is simply one less than the |
|
557 passed in row number, and pass will always be 0. For the interlaced case the |
|
558 same applies unless the row value is 0, in which case the row just handled was |
|
559 the last one from one of the preceding passes. Because interlacing may skip a |
|
560 pass you cannot be sure that the preceding pass is just 'pass-1', if you really |
|
561 need to know what the last pass is record (row,pass) from the callback and use |
|
562 the last recorded value each time. |
|
563 |
|
564 As with the user transform you can find the output row using the |
|
565 PNG_ROW_FROM_PASS_ROW macro. |
|
566 |
|
567 Unknown-chunk handling |
|
568 |
|
569 Now you get to set the way the library processes unknown chunks in the |
|
570 input PNG stream. Both known and unknown chunks will be read. Normal |
|
571 behavior is that known chunks will be parsed into information in |
|
572 various info_ptr members while unknown chunks will be discarded. This |
|
573 behavior can be wasteful if your application will never use some known |
|
574 chunk types. To change this, you can call: |
|
575 |
|
576 png_set_keep_unknown_chunks(png_ptr, keep, |
|
577 chunk_list, num_chunks); |
|
578 |
|
579 keep - 0: default unknown chunk handling |
|
580 1: ignore; do not keep |
|
581 2: keep only if safe-to-copy |
|
582 3: keep even if unsafe-to-copy |
|
583 |
|
584 You can use these definitions: |
|
585 PNG_HANDLE_CHUNK_AS_DEFAULT 0 |
|
586 PNG_HANDLE_CHUNK_NEVER 1 |
|
587 PNG_HANDLE_CHUNK_IF_SAFE 2 |
|
588 PNG_HANDLE_CHUNK_ALWAYS 3 |
|
589 |
|
590 chunk_list - list of chunks affected (a byte string, |
|
591 five bytes per chunk, NULL or '\0' if |
|
592 num_chunks is positive; ignored if |
|
593 numchunks <= 0). |
|
594 |
|
595 num_chunks - number of chunks affected; if 0, all |
|
596 unknown chunks are affected. If positive, |
|
597 only the chunks in the list are affected, |
|
598 and if negative all unknown chunks and |
|
599 all known chunks except for the IHDR, |
|
600 PLTE, tRNS, IDAT, and IEND chunks are |
|
601 affected. |
|
602 |
|
603 Unknown chunks declared in this way will be saved as raw data onto a |
|
604 list of png_unknown_chunk structures. If a chunk that is normally |
|
605 known to libpng is named in the list, it will be handled as unknown, |
|
606 according to the "keep" directive. If a chunk is named in successive |
|
607 instances of png_set_keep_unknown_chunks(), the final instance will |
|
608 take precedence. The IHDR and IEND chunks should not be named in |
|
609 chunk_list; if they are, libpng will process them normally anyway. |
|
610 If you know that your application will never make use of some particular |
|
611 chunks, use PNG_HANDLE_CHUNK_NEVER (or 1) as demonstrated below. |
|
612 |
|
613 Here is an example of the usage of png_set_keep_unknown_chunks(), |
|
614 where the private "vpAg" chunk will later be processed by a user chunk |
|
615 callback function: |
|
616 |
|
617 png_byte vpAg[5]={118, 112, 65, 103, (png_byte) '\0'}; |
|
618 |
|
619 #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) |
|
620 png_byte unused_chunks[]= |
|
621 { |
|
622 104, 73, 83, 84, (png_byte) '\0', /* hIST */ |
|
623 105, 84, 88, 116, (png_byte) '\0', /* iTXt */ |
|
624 112, 67, 65, 76, (png_byte) '\0', /* pCAL */ |
|
625 115, 67, 65, 76, (png_byte) '\0', /* sCAL */ |
|
626 115, 80, 76, 84, (png_byte) '\0', /* sPLT */ |
|
627 116, 73, 77, 69, (png_byte) '\0', /* tIME */ |
|
628 }; |
|
629 #endif |
|
630 |
|
631 ... |
|
632 |
|
633 #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) |
|
634 /* ignore all unknown chunks |
|
635 * (use global setting "2" for libpng16 and earlier): |
|
636 */ |
|
637 png_set_keep_unknown_chunks(read_ptr, 2, NULL, 0); |
|
638 |
|
639 /* except for vpAg: */ |
|
640 png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1); |
|
641 |
|
642 /* also ignore unused known chunks: */ |
|
643 png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks, |
|
644 (int)(sizeof unused_chunks)/5); |
|
645 #endif |
|
646 |
|
647 User limits |
|
648 |
|
649 The PNG specification allows the width and height of an image to be as |
|
650 large as 2^31-1 (0x7fffffff), or about 2.147 billion rows and columns. |
|
651 Since very few applications really need to process such large images, |
|
652 we have imposed an arbitrary 1-million limit on rows and columns. |
|
653 Larger images will be rejected immediately with a png_error() call. If |
|
654 you wish to change this limit, you can use |
|
655 |
|
656 png_set_user_limits(png_ptr, width_max, height_max); |
|
657 |
|
658 to set your own limits, or use width_max = height_max = 0x7fffffffL |
|
659 to allow all valid dimensions (libpng may reject some very large images |
|
660 anyway because of potential buffer overflow conditions). |
|
661 |
|
662 You should put this statement after you create the PNG structure and |
|
663 before calling png_read_info(), png_read_png(), or png_process_data(). |
|
664 |
|
665 When writing a PNG datastream, put this statement before calling |
|
666 png_write_info() or png_write_png(). |
|
667 |
|
668 If you need to retrieve the limits that are being applied, use |
|
669 |
|
670 width_max = png_get_user_width_max(png_ptr); |
|
671 height_max = png_get_user_height_max(png_ptr); |
|
672 |
|
673 The PNG specification sets no limit on the number of ancillary chunks |
|
674 allowed in a PNG datastream. You can impose a limit on the total number |
|
675 of sPLT, tEXt, iTXt, zTXt, and unknown chunks that will be stored, with |
|
676 |
|
677 png_set_chunk_cache_max(png_ptr, user_chunk_cache_max); |
|
678 |
|
679 where 0x7fffffffL means unlimited. You can retrieve this limit with |
|
680 |
|
681 chunk_cache_max = png_get_chunk_cache_max(png_ptr); |
|
682 |
|
683 You can also set a limit on the amount of memory that a compressed chunk |
|
684 other than IDAT can occupy, with |
|
685 |
|
686 png_set_chunk_malloc_max(png_ptr, user_chunk_malloc_max); |
|
687 |
|
688 and you can retrieve the limit with |
|
689 |
|
690 chunk_malloc_max = png_get_chunk_malloc_max(png_ptr); |
|
691 |
|
692 Any chunks that would cause either of these limits to be exceeded will |
|
693 be ignored. |
|
694 |
|
695 Information about your system |
|
696 |
|
697 If you intend to display the PNG or to incorporate it in other image data you |
|
698 need to tell libpng information about your display or drawing surface so that |
|
699 libpng can convert the values in the image to match the display. |
|
700 |
|
701 From libpng-1.5.4 this information can be set before reading the PNG file |
|
702 header. In earlier versions png_set_gamma() existed but behaved incorrectly if |
|
703 called before the PNG file header had been read and png_set_alpha_mode() did not |
|
704 exist. |
|
705 |
|
706 If you need to support versions prior to libpng-1.5.4 test the version number |
|
707 as illustrated below using "PNG_LIBPNG_VER >= 10504" and follow the procedures |
|
708 described in the appropriate manual page. |
|
709 |
|
710 You give libpng the encoding expected by your system expressed as a 'gamma' |
|
711 value. You can also specify a default encoding for the PNG file in |
|
712 case the required information is missing from the file. By default libpng |
|
713 assumes that the PNG data matches your system, to keep this default call: |
|
714 |
|
715 png_set_gamma(png_ptr, screen_gamma, 1/screen_gamma/*file gamma*/); |
|
716 |
|
717 or you can use the fixed point equivalent: |
|
718 |
|
719 png_set_gamma_fixed(png_ptr, PNG_FP_1*screen_gamma, |
|
720 PNG_FP_1/screen_gamma); |
|
721 |
|
722 If you don't know the gamma for your system it is probably 2.2 - a good |
|
723 approximation to the IEC standard for display systems (sRGB). If images are |
|
724 too contrasty or washed out you got the value wrong - check your system |
|
725 documentation! |
|
726 |
|
727 Many systems permit the system gamma to be changed via a lookup table in the |
|
728 display driver, a few systems, including older Macs, change the response by |
|
729 default. As of 1.5.4 three special values are available to handle common |
|
730 situations: |
|
731 |
|
732 PNG_DEFAULT_sRGB: Indicates that the system conforms to the |
|
733 IEC 61966-2-1 standard. This matches almost |
|
734 all systems. |
|
735 PNG_GAMMA_MAC_18: Indicates that the system is an older |
|
736 (pre Mac OS 10.6) Apple Macintosh system with |
|
737 the default settings. |
|
738 PNG_GAMMA_LINEAR: Just the fixed point value for 1.0 - indicates |
|
739 that the system expects data with no gamma |
|
740 encoding. |
|
741 |
|
742 You would use the linear (unencoded) value if you need to process the pixel |
|
743 values further because this avoids the need to decode and re-encode each |
|
744 component value whenever arithmetic is performed. A lot of graphics software |
|
745 uses linear values for this reason, often with higher precision component values |
|
746 to preserve overall accuracy. |
|
747 |
|
748 The second thing you may need to tell libpng about is how your system handles |
|
749 alpha channel information. Some, but not all, PNG files contain an alpha |
|
750 channel. To display these files correctly you need to compose the data onto a |
|
751 suitable background, as described in the PNG specification. |
|
752 |
|
753 Libpng only supports composing onto a single color (using png_set_background; |
|
754 see below). Otherwise you must do the composition yourself and, in this case, |
|
755 you may need to call png_set_alpha_mode: |
|
756 |
|
757 #if PNG_LIBPNG_VER >= 10504 |
|
758 png_set_alpha_mode(png_ptr, mode, screen_gamma); |
|
759 #else |
|
760 png_set_gamma(png_ptr, screen_gamma, 1.0/screen_gamma); |
|
761 #endif |
|
762 |
|
763 The screen_gamma value is the same as the argument to png_set_gamma; however, |
|
764 how it affects the output depends on the mode. png_set_alpha_mode() sets the |
|
765 file gamma default to 1/screen_gamma, so normally you don't need to call |
|
766 png_set_gamma. If you need different defaults call png_set_gamma() before |
|
767 png_set_alpha_mode() - if you call it after it will override the settings made |
|
768 by png_set_alpha_mode(). |
|
769 |
|
770 The mode is as follows: |
|
771 |
|
772 PNG_ALPHA_PNG: The data is encoded according to the PNG specification. Red, |
|
773 green and blue, or gray, components are gamma encoded color |
|
774 values and are not premultiplied by the alpha value. The |
|
775 alpha value is a linear measure of the contribution of the |
|
776 pixel to the corresponding final output pixel. |
|
777 |
|
778 You should normally use this format if you intend to perform |
|
779 color correction on the color values; most, maybe all, color |
|
780 correction software has no handling for the alpha channel and, |
|
781 anyway, the math to handle pre-multiplied component values is |
|
782 unnecessarily complex. |
|
783 |
|
784 Before you do any arithmetic on the component values you need |
|
785 to remove the gamma encoding and multiply out the alpha |
|
786 channel. See the PNG specification for more detail. It is |
|
787 important to note that when an image with an alpha channel is |
|
788 scaled, linear encoded, pre-multiplied component values must |
|
789 be used! |
|
790 |
|
791 The remaining modes assume you don't need to do any further color correction or |
|
792 that if you do, your color correction software knows all about alpha (it |
|
793 probably doesn't!) |
|
794 |
|
795 PNG_ALPHA_STANDARD: The data libpng produces |
|
796 is encoded in the standard way |
|
797 assumed by most correctly written graphics software. |
|
798 The gamma encoding will be removed by libpng and the |
|
799 linear component values will be pre-multiplied by the |
|
800 alpha channel. |
|
801 |
|
802 With this format the final image must be re-encoded to |
|
803 match the display gamma before the image is displayed. |
|
804 If your system doesn't do that, yet still seems to |
|
805 perform arithmetic on the pixels without decoding them, |
|
806 it is broken - check out the modes below. |
|
807 |
|
808 With PNG_ALPHA_STANDARD libpng always produces linear |
|
809 component values, whatever screen_gamma you supply. The |
|
810 screen_gamma value is, however, used as a default for |
|
811 the file gamma if the PNG file has no gamma information. |
|
812 |
|
813 If you call png_set_gamma() after png_set_alpha_mode() you |
|
814 will override the linear encoding. Instead the |
|
815 pre-multiplied pixel values will be gamma encoded but |
|
816 the alpha channel will still be linear. This may |
|
817 actually match the requirements of some broken software, |
|
818 but it is unlikely. |
|
819 |
|
820 While linear 8-bit data is often used it has |
|
821 insufficient precision for any image with a reasonable |
|
822 dynamic range. To avoid problems, and if your software |
|
823 supports it, use png_set_expand_16() to force all |
|
824 components to 16 bits. |
|
825 |
|
826 PNG_ALPHA_OPTIMIZED: This mode is the same |
|
827 as PNG_ALPHA_STANDARD except that |
|
828 completely opaque pixels are gamma encoded according to |
|
829 the screen_gamma value. Pixels with alpha less than 1.0 |
|
830 will still have linear components. |
|
831 |
|
832 Use this format if you have control over your |
|
833 compositing software and so don't do other arithmetic |
|
834 (such as scaling) on the data you get from libpng. Your |
|
835 compositing software can simply copy opaque pixels to |
|
836 the output but still has linear values for the |
|
837 non-opaque pixels. |
|
838 |
|
839 In normal compositing, where the alpha channel encodes |
|
840 partial pixel coverage (as opposed to broad area |
|
841 translucency), the inaccuracies of the 8-bit |
|
842 representation of non-opaque pixels are irrelevant. |
|
843 |
|
844 You can also try this format if your software is broken; |
|
845 it might look better. |
|
846 |
|
847 PNG_ALPHA_BROKEN: This is PNG_ALPHA_STANDARD; |
|
848 however, all component values, |
|
849 including the alpha channel are gamma encoded. This is |
|
850 an appropriate format to try if your software, or more |
|
851 likely hardware, is totally broken, i.e., if it performs |
|
852 linear arithmetic directly on gamma encoded values. |
|
853 |
|
854 In most cases of broken software or hardware the bug in the final display |
|
855 manifests as a subtle halo around composited parts of the image. You may not |
|
856 even perceive this as a halo; the composited part of the image may simply appear |
|
857 separate from the background, as though it had been cut out of paper and pasted |
|
858 on afterward. |
|
859 |
|
860 If you don't have to deal with bugs in software or hardware, or if you can fix |
|
861 them, there are three recommended ways of using png_set_alpha_mode(): |
|
862 |
|
863 png_set_alpha_mode(png_ptr, PNG_ALPHA_PNG, |
|
864 screen_gamma); |
|
865 |
|
866 You can do color correction on the result (libpng does not currently |
|
867 support color correction internally). When you handle the alpha channel |
|
868 you need to undo the gamma encoding and multiply out the alpha. |
|
869 |
|
870 png_set_alpha_mode(png_ptr, PNG_ALPHA_STANDARD, |
|
871 screen_gamma); |
|
872 png_set_expand_16(png_ptr); |
|
873 |
|
874 If you are using the high level interface, don't call png_set_expand_16(); |
|
875 instead pass PNG_TRANSFORM_EXPAND_16 to the interface. |
|
876 |
|
877 With this mode you can't do color correction, but you can do arithmetic, |
|
878 including composition and scaling, on the data without further processing. |
|
879 |
|
880 png_set_alpha_mode(png_ptr, PNG_ALPHA_OPTIMIZED, |
|
881 screen_gamma); |
|
882 |
|
883 You can avoid the expansion to 16-bit components with this mode, but you |
|
884 lose the ability to scale the image or perform other linear arithmetic. |
|
885 All you can do is compose the result onto a matching output. Since this |
|
886 mode is libpng-specific you also need to write your own composition |
|
887 software. |
|
888 |
|
889 If you don't need, or can't handle, the alpha channel you can call |
|
890 png_set_background() to remove it by compositing against a fixed color. Don't |
|
891 call png_set_strip_alpha() to do this - it will leave spurious pixel values in |
|
892 transparent parts of this image. |
|
893 |
|
894 png_set_background(png_ptr, &background_color, |
|
895 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1); |
|
896 |
|
897 The background_color is an RGB or grayscale value according to the data format |
|
898 libpng will produce for you. Because you don't yet know the format of the PNG |
|
899 file, if you call png_set_background at this point you must arrange for the |
|
900 format produced by libpng to always have 8-bit or 16-bit components and then |
|
901 store the color as an 8-bit or 16-bit color as appropriate. The color contains |
|
902 separate gray and RGB component values, so you can let libpng produce gray or |
|
903 RGB output according to the input format, but low bit depth grayscale images |
|
904 must always be converted to at least 8-bit format. (Even though low bit depth |
|
905 grayscale images can't have an alpha channel they can have a transparent |
|
906 color!) |
|
907 |
|
908 You set the transforms you need later, either as flags to the high level |
|
909 interface or libpng API calls for the low level interface. For reference the |
|
910 settings and API calls required are: |
|
911 |
|
912 8-bit values: |
|
913 PNG_TRANSFORM_SCALE_16 | PNG_EXPAND |
|
914 png_set_expand(png_ptr); png_set_scale_16(png_ptr); |
|
915 |
|
916 If you must get exactly the same inaccurate results |
|
917 produced by default in versions prior to libpng-1.5.4, |
|
918 use PNG_TRANSFORM_STRIP_16 and png_set_strip_16(png_ptr) |
|
919 instead. |
|
920 |
|
921 16-bit values: |
|
922 PNG_TRANSFORM_EXPAND_16 |
|
923 png_set_expand_16(png_ptr); |
|
924 |
|
925 In either case palette image data will be expanded to RGB. If you just want |
|
926 color data you can add PNG_TRANSFORM_GRAY_TO_RGB or png_set_gray_to_rgb(png_ptr) |
|
927 to the list. |
|
928 |
|
929 Calling png_set_background before the PNG file header is read will not work |
|
930 prior to libpng-1.5.4. Because the failure may result in unexpected warnings or |
|
931 errors it is therefore much safer to call png_set_background after the head has |
|
932 been read. Unfortunately this means that prior to libpng-1.5.4 it cannot be |
|
933 used with the high level interface. |
|
934 |
|
935 The high-level read interface |
|
936 |
|
937 At this point there are two ways to proceed; through the high-level |
|
938 read interface, or through a sequence of low-level read operations. |
|
939 You can use the high-level interface if (a) you are willing to read |
|
940 the entire image into memory, and (b) the input transformations |
|
941 you want to do are limited to the following set: |
|
942 |
|
943 PNG_TRANSFORM_IDENTITY No transformation |
|
944 PNG_TRANSFORM_SCALE_16 Strip 16-bit samples to |
|
945 8-bit accurately |
|
946 PNG_TRANSFORM_STRIP_16 Chop 16-bit samples to |
|
947 8-bit less accurately |
|
948 PNG_TRANSFORM_STRIP_ALPHA Discard the alpha channel |
|
949 PNG_TRANSFORM_PACKING Expand 1, 2 and 4-bit |
|
950 samples to bytes |
|
951 PNG_TRANSFORM_PACKSWAP Change order of packed |
|
952 pixels to LSB first |
|
953 PNG_TRANSFORM_EXPAND Perform set_expand() |
|
954 PNG_TRANSFORM_INVERT_MONO Invert monochrome images |
|
955 PNG_TRANSFORM_SHIFT Normalize pixels to the |
|
956 sBIT depth |
|
957 PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA |
|
958 to BGRA |
|
959 PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA |
|
960 to AG |
|
961 PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity |
|
962 to transparency |
|
963 PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples |
|
964 PNG_TRANSFORM_GRAY_TO_RGB Expand grayscale samples |
|
965 to RGB (or GA to RGBA) |
|
966 PNG_TRANSFORM_EXPAND_16 Expand samples to 16 bits |
|
967 |
|
968 (This excludes setting a background color, doing gamma transformation, |
|
969 quantizing, and setting filler.) If this is the case, simply do this: |
|
970 |
|
971 png_read_png(png_ptr, info_ptr, png_transforms, NULL) |
|
972 |
|
973 where png_transforms is an integer containing the bitwise OR of some |
|
974 set of transformation flags. This call is equivalent to png_read_info(), |
|
975 followed the set of transformations indicated by the transform mask, |
|
976 then png_read_image(), and finally png_read_end(). |
|
977 |
|
978 (The final parameter of this call is not yet used. Someday it might point |
|
979 to transformation parameters required by some future input transform.) |
|
980 |
|
981 You must use png_transforms and not call any png_set_transform() functions |
|
982 when you use png_read_png(). |
|
983 |
|
984 After you have called png_read_png(), you can retrieve the image data |
|
985 with |
|
986 |
|
987 row_pointers = png_get_rows(png_ptr, info_ptr); |
|
988 |
|
989 where row_pointers is an array of pointers to the pixel data for each row: |
|
990 |
|
991 png_bytep row_pointers[height]; |
|
992 |
|
993 If you know your image size and pixel size ahead of time, you can allocate |
|
994 row_pointers prior to calling png_read_png() with |
|
995 |
|
996 if (height > PNG_UINT_32_MAX/(sizeof (png_byte))) |
|
997 png_error (png_ptr, |
|
998 "Image is too tall to process in memory"); |
|
999 |
|
1000 if (width > PNG_UINT_32_MAX/pixel_size) |
|
1001 png_error (png_ptr, |
|
1002 "Image is too wide to process in memory"); |
|
1003 |
|
1004 row_pointers = png_malloc(png_ptr, |
|
1005 height*(sizeof (png_bytep))); |
|
1006 |
|
1007 for (int i=0; i<height, i++) |
|
1008 row_pointers[i]=NULL; /* security precaution */ |
|
1009 |
|
1010 for (int i=0; i<height, i++) |
|
1011 row_pointers[i]=png_malloc(png_ptr, |
|
1012 width*pixel_size); |
|
1013 |
|
1014 png_set_rows(png_ptr, info_ptr, &row_pointers); |
|
1015 |
|
1016 Alternatively you could allocate your image in one big block and define |
|
1017 row_pointers[i] to point into the proper places in your block. |
|
1018 |
|
1019 If you use png_set_rows(), the application is responsible for freeing |
|
1020 row_pointers (and row_pointers[i], if they were separately allocated). |
|
1021 |
|
1022 If you don't allocate row_pointers ahead of time, png_read_png() will |
|
1023 do it, and it'll be free'ed by libpng when you call png_destroy_*(). |
|
1024 |
|
1025 The low-level read interface |
|
1026 |
|
1027 If you are going the low-level route, you are now ready to read all |
|
1028 the file information up to the actual image data. You do this with a |
|
1029 call to png_read_info(). |
|
1030 |
|
1031 png_read_info(png_ptr, info_ptr); |
|
1032 |
|
1033 This will process all chunks up to but not including the image data. |
|
1034 |
|
1035 This also copies some of the data from the PNG file into the decode structure |
|
1036 for use in later transformations. Important information copied in is: |
|
1037 |
|
1038 1) The PNG file gamma from the gAMA chunk. This overwrites the default value |
|
1039 provided by an earlier call to png_set_gamma or png_set_alpha_mode. |
|
1040 |
|
1041 2) Prior to libpng-1.5.4 the background color from a bKGd chunk. This |
|
1042 damages the information provided by an earlier call to png_set_background |
|
1043 resulting in unexpected behavior. Libpng-1.5.4 no longer does this. |
|
1044 |
|
1045 3) The number of significant bits in each component value. Libpng uses this to |
|
1046 optimize gamma handling by reducing the internal lookup table sizes. |
|
1047 |
|
1048 4) The transparent color information from a tRNS chunk. This can be modified by |
|
1049 a later call to png_set_tRNS. |
|
1050 |
|
1051 Querying the info structure |
|
1052 |
|
1053 Functions are used to get the information from the info_ptr once it |
|
1054 has been read. Note that these fields may not be completely filled |
|
1055 in until png_read_end() has read the chunk data following the image. |
|
1056 |
|
1057 png_get_IHDR(png_ptr, info_ptr, &width, &height, |
|
1058 &bit_depth, &color_type, &interlace_type, |
|
1059 &compression_type, &filter_method); |
|
1060 |
|
1061 width - holds the width of the image |
|
1062 in pixels (up to 2^31). |
|
1063 |
|
1064 height - holds the height of the image |
|
1065 in pixels (up to 2^31). |
|
1066 |
|
1067 bit_depth - holds the bit depth of one of the |
|
1068 image channels. (valid values are |
|
1069 1, 2, 4, 8, 16 and depend also on |
|
1070 the color_type. See also |
|
1071 significant bits (sBIT) below). |
|
1072 |
|
1073 color_type - describes which color/alpha channels |
|
1074 are present. |
|
1075 PNG_COLOR_TYPE_GRAY |
|
1076 (bit depths 1, 2, 4, 8, 16) |
|
1077 PNG_COLOR_TYPE_GRAY_ALPHA |
|
1078 (bit depths 8, 16) |
|
1079 PNG_COLOR_TYPE_PALETTE |
|
1080 (bit depths 1, 2, 4, 8) |
|
1081 PNG_COLOR_TYPE_RGB |
|
1082 (bit_depths 8, 16) |
|
1083 PNG_COLOR_TYPE_RGB_ALPHA |
|
1084 (bit_depths 8, 16) |
|
1085 |
|
1086 PNG_COLOR_MASK_PALETTE |
|
1087 PNG_COLOR_MASK_COLOR |
|
1088 PNG_COLOR_MASK_ALPHA |
|
1089 |
|
1090 interlace_type - (PNG_INTERLACE_NONE or |
|
1091 PNG_INTERLACE_ADAM7) |
|
1092 |
|
1093 compression_type - (must be PNG_COMPRESSION_TYPE_BASE |
|
1094 for PNG 1.0) |
|
1095 |
|
1096 filter_method - (must be PNG_FILTER_TYPE_BASE |
|
1097 for PNG 1.0, and can also be |
|
1098 PNG_INTRAPIXEL_DIFFERENCING if |
|
1099 the PNG datastream is embedded in |
|
1100 a MNG-1.0 datastream) |
|
1101 |
|
1102 Any or all of interlace_type, compression_type, or |
|
1103 filter_method can be NULL if you are |
|
1104 not interested in their values. |
|
1105 |
|
1106 Note that png_get_IHDR() returns 32-bit data into |
|
1107 the application's width and height variables. |
|
1108 This is an unsafe situation if these are 16-bit |
|
1109 variables. In such situations, the |
|
1110 png_get_image_width() and png_get_image_height() |
|
1111 functions described below are safer. |
|
1112 |
|
1113 width = png_get_image_width(png_ptr, |
|
1114 info_ptr); |
|
1115 |
|
1116 height = png_get_image_height(png_ptr, |
|
1117 info_ptr); |
|
1118 |
|
1119 bit_depth = png_get_bit_depth(png_ptr, |
|
1120 info_ptr); |
|
1121 |
|
1122 color_type = png_get_color_type(png_ptr, |
|
1123 info_ptr); |
|
1124 |
|
1125 interlace_type = png_get_interlace_type(png_ptr, |
|
1126 info_ptr); |
|
1127 |
|
1128 compression_type = png_get_compression_type(png_ptr, |
|
1129 info_ptr); |
|
1130 |
|
1131 filter_method = png_get_filter_type(png_ptr, |
|
1132 info_ptr); |
|
1133 |
|
1134 channels = png_get_channels(png_ptr, info_ptr); |
|
1135 |
|
1136 channels - number of channels of info for the |
|
1137 color type (valid values are 1 (GRAY, |
|
1138 PALETTE), 2 (GRAY_ALPHA), 3 (RGB), |
|
1139 4 (RGB_ALPHA or RGB + filler byte)) |
|
1140 |
|
1141 rowbytes = png_get_rowbytes(png_ptr, info_ptr); |
|
1142 |
|
1143 rowbytes - number of bytes needed to hold a row |
|
1144 |
|
1145 signature = png_get_signature(png_ptr, info_ptr); |
|
1146 |
|
1147 signature - holds the signature read from the |
|
1148 file (if any). The data is kept in |
|
1149 the same offset it would be if the |
|
1150 whole signature were read (i.e. if an |
|
1151 application had already read in 4 |
|
1152 bytes of signature before starting |
|
1153 libpng, the remaining 4 bytes would |
|
1154 be in signature[4] through signature[7] |
|
1155 (see png_set_sig_bytes())). |
|
1156 |
|
1157 These are also important, but their validity depends on whether the chunk |
|
1158 has been read. The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and |
|
1159 png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the |
|
1160 data has been read, or zero if it is missing. The parameters to the |
|
1161 png_get_<chunk> are set directly if they are simple data types, or a |
|
1162 pointer into the info_ptr is returned for any complex types. |
|
1163 |
|
1164 The colorspace data from gAMA, cHRM, sRGB, iCCP, and sBIT chunks |
|
1165 is simply returned to give the application information about how the |
|
1166 image was encoded. Libpng itself only does transformations using the file |
|
1167 gamma when combining semitransparent pixels with the background color, and, |
|
1168 since libpng-1.6.0, when converting between 8-bit sRGB and 16-bit linear pixels |
|
1169 within the simplified API. Libpng also uses the file gamma when converting |
|
1170 RGB to gray, beginning with libpng-1.0.5, if the application calls |
|
1171 png_set_rgb_to_gray()). |
|
1172 |
|
1173 png_get_PLTE(png_ptr, info_ptr, &palette, |
|
1174 &num_palette); |
|
1175 |
|
1176 palette - the palette for the file |
|
1177 (array of png_color) |
|
1178 |
|
1179 num_palette - number of entries in the palette |
|
1180 |
|
1181 png_get_gAMA(png_ptr, info_ptr, &file_gamma); |
|
1182 png_get_gAMA_fixed(png_ptr, info_ptr, &int_file_gamma); |
|
1183 |
|
1184 file_gamma - the gamma at which the file is |
|
1185 written (PNG_INFO_gAMA) |
|
1186 |
|
1187 int_file_gamma - 100,000 times the gamma at which the |
|
1188 file is written |
|
1189 |
|
1190 png_get_cHRM(png_ptr, info_ptr, &white_x, &white_y, &red_x, |
|
1191 &red_y, &green_x, &green_y, &blue_x, &blue_y) |
|
1192 png_get_cHRM_XYZ(png_ptr, info_ptr, &red_X, &red_Y, &red_Z, |
|
1193 &green_X, &green_Y, &green_Z, &blue_X, &blue_Y, |
|
1194 &blue_Z) |
|
1195 png_get_cHRM_fixed(png_ptr, info_ptr, &int_white_x, |
|
1196 &int_white_y, &int_red_x, &int_red_y, |
|
1197 &int_green_x, &int_green_y, &int_blue_x, |
|
1198 &int_blue_y) |
|
1199 png_get_cHRM_XYZ_fixed(png_ptr, info_ptr, &int_red_X, &int_red_Y, |
|
1200 &int_red_Z, &int_green_X, &int_green_Y, |
|
1201 &int_green_Z, &int_blue_X, &int_blue_Y, |
|
1202 &int_blue_Z) |
|
1203 |
|
1204 {white,red,green,blue}_{x,y} |
|
1205 A color space encoding specified using the |
|
1206 chromaticities of the end points and the |
|
1207 white point. (PNG_INFO_cHRM) |
|
1208 |
|
1209 {red,green,blue}_{X,Y,Z} |
|
1210 A color space encoding specified using the |
|
1211 encoding end points - the CIE tristimulus |
|
1212 specification of the intended color of the red, |
|
1213 green and blue channels in the PNG RGB data. |
|
1214 The white point is simply the sum of the three |
|
1215 end points. (PNG_INFO_cHRM) |
|
1216 |
|
1217 png_get_sRGB(png_ptr, info_ptr, &srgb_intent); |
|
1218 |
|
1219 file_srgb_intent - the rendering intent (PNG_INFO_sRGB) |
|
1220 The presence of the sRGB chunk |
|
1221 means that the pixel data is in the |
|
1222 sRGB color space. This chunk also |
|
1223 implies specific values of gAMA and |
|
1224 cHRM. |
|
1225 |
|
1226 png_get_iCCP(png_ptr, info_ptr, &name, |
|
1227 &compression_type, &profile, &proflen); |
|
1228 |
|
1229 name - The profile name. |
|
1230 |
|
1231 compression_type - The compression type; always |
|
1232 PNG_COMPRESSION_TYPE_BASE for PNG 1.0. |
|
1233 You may give NULL to this argument to |
|
1234 ignore it. |
|
1235 |
|
1236 profile - International Color Consortium color |
|
1237 profile data. May contain NULs. |
|
1238 |
|
1239 proflen - length of profile data in bytes. |
|
1240 |
|
1241 png_get_sBIT(png_ptr, info_ptr, &sig_bit); |
|
1242 |
|
1243 sig_bit - the number of significant bits for |
|
1244 (PNG_INFO_sBIT) each of the gray, |
|
1245 red, green, and blue channels, |
|
1246 whichever are appropriate for the |
|
1247 given color type (png_color_16) |
|
1248 |
|
1249 png_get_tRNS(png_ptr, info_ptr, &trans_alpha, |
|
1250 &num_trans, &trans_color); |
|
1251 |
|
1252 trans_alpha - array of alpha (transparency) |
|
1253 entries for palette (PNG_INFO_tRNS) |
|
1254 |
|
1255 num_trans - number of transparent entries |
|
1256 (PNG_INFO_tRNS) |
|
1257 |
|
1258 trans_color - graylevel or color sample values of |
|
1259 the single transparent color for |
|
1260 non-paletted images (PNG_INFO_tRNS) |
|
1261 |
|
1262 png_get_hIST(png_ptr, info_ptr, &hist); |
|
1263 (PNG_INFO_hIST) |
|
1264 |
|
1265 hist - histogram of palette (array of |
|
1266 png_uint_16) |
|
1267 |
|
1268 png_get_tIME(png_ptr, info_ptr, &mod_time); |
|
1269 |
|
1270 mod_time - time image was last modified |
|
1271 (PNG_VALID_tIME) |
|
1272 |
|
1273 png_get_bKGD(png_ptr, info_ptr, &background); |
|
1274 |
|
1275 background - background color (of type |
|
1276 png_color_16p) (PNG_VALID_bKGD) |
|
1277 valid 16-bit red, green and blue |
|
1278 values, regardless of color_type |
|
1279 |
|
1280 num_comments = png_get_text(png_ptr, info_ptr, |
|
1281 &text_ptr, &num_text); |
|
1282 |
|
1283 num_comments - number of comments |
|
1284 |
|
1285 text_ptr - array of png_text holding image |
|
1286 comments |
|
1287 |
|
1288 text_ptr[i].compression - type of compression used |
|
1289 on "text" PNG_TEXT_COMPRESSION_NONE |
|
1290 PNG_TEXT_COMPRESSION_zTXt |
|
1291 PNG_ITXT_COMPRESSION_NONE |
|
1292 PNG_ITXT_COMPRESSION_zTXt |
|
1293 |
|
1294 text_ptr[i].key - keyword for comment. Must contain |
|
1295 1-79 characters. |
|
1296 |
|
1297 text_ptr[i].text - text comments for current |
|
1298 keyword. Can be empty. |
|
1299 |
|
1300 text_ptr[i].text_length - length of text string, |
|
1301 after decompression, 0 for iTXt |
|
1302 |
|
1303 text_ptr[i].itxt_length - length of itxt string, |
|
1304 after decompression, 0 for tEXt/zTXt |
|
1305 |
|
1306 text_ptr[i].lang - language of comment (empty |
|
1307 string for unknown). |
|
1308 |
|
1309 text_ptr[i].lang_key - keyword in UTF-8 |
|
1310 (empty string for unknown). |
|
1311 |
|
1312 Note that the itxt_length, lang, and lang_key |
|
1313 members of the text_ptr structure only exist when the |
|
1314 library is built with iTXt chunk support. Prior to |
|
1315 libpng-1.4.0 the library was built by default without |
|
1316 iTXt support. Also note that when iTXt is supported, |
|
1317 they contain NULL pointers when the "compression" |
|
1318 field contains PNG_TEXT_COMPRESSION_NONE or |
|
1319 PNG_TEXT_COMPRESSION_zTXt. |
|
1320 |
|
1321 num_text - number of comments (same as |
|
1322 num_comments; you can put NULL here |
|
1323 to avoid the duplication) |
|
1324 |
|
1325 Note while png_set_text() will accept text, language, |
|
1326 and translated keywords that can be NULL pointers, the |
|
1327 structure returned by png_get_text will always contain |
|
1328 regular zero-terminated C strings. They might be |
|
1329 empty strings but they will never be NULL pointers. |
|
1330 |
|
1331 num_spalettes = png_get_sPLT(png_ptr, info_ptr, |
|
1332 &palette_ptr); |
|
1333 |
|
1334 num_spalettes - number of sPLT chunks read. |
|
1335 |
|
1336 palette_ptr - array of palette structures holding |
|
1337 contents of one or more sPLT chunks |
|
1338 read. |
|
1339 |
|
1340 png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y, |
|
1341 &unit_type); |
|
1342 |
|
1343 offset_x - positive offset from the left edge |
|
1344 of the screen (can be negative) |
|
1345 |
|
1346 offset_y - positive offset from the top edge |
|
1347 of the screen (can be negative) |
|
1348 |
|
1349 unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER |
|
1350 |
|
1351 png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y, |
|
1352 &unit_type); |
|
1353 |
|
1354 res_x - pixels/unit physical resolution in |
|
1355 x direction |
|
1356 |
|
1357 res_y - pixels/unit physical resolution in |
|
1358 x direction |
|
1359 |
|
1360 unit_type - PNG_RESOLUTION_UNKNOWN, |
|
1361 PNG_RESOLUTION_METER |
|
1362 |
|
1363 png_get_sCAL(png_ptr, info_ptr, &unit, &width, |
|
1364 &height) |
|
1365 |
|
1366 unit - physical scale units (an integer) |
|
1367 |
|
1368 width - width of a pixel in physical scale units |
|
1369 |
|
1370 height - height of a pixel in physical scale units |
|
1371 (width and height are doubles) |
|
1372 |
|
1373 png_get_sCAL_s(png_ptr, info_ptr, &unit, &width, |
|
1374 &height) |
|
1375 |
|
1376 unit - physical scale units (an integer) |
|
1377 |
|
1378 width - width of a pixel in physical scale units |
|
1379 (expressed as a string) |
|
1380 |
|
1381 height - height of a pixel in physical scale units |
|
1382 (width and height are strings like "2.54") |
|
1383 |
|
1384 num_unknown_chunks = png_get_unknown_chunks(png_ptr, |
|
1385 info_ptr, &unknowns) |
|
1386 |
|
1387 unknowns - array of png_unknown_chunk |
|
1388 structures holding unknown chunks |
|
1389 |
|
1390 unknowns[i].name - name of unknown chunk |
|
1391 |
|
1392 unknowns[i].data - data of unknown chunk |
|
1393 |
|
1394 unknowns[i].size - size of unknown chunk's data |
|
1395 |
|
1396 unknowns[i].location - position of chunk in file |
|
1397 |
|
1398 The value of "i" corresponds to the order in which the |
|
1399 chunks were read from the PNG file or inserted with the |
|
1400 png_set_unknown_chunks() function. |
|
1401 |
|
1402 The value of "location" is a bitwise "or" of |
|
1403 |
|
1404 PNG_HAVE_IHDR (0x01) |
|
1405 PNG_HAVE_PLTE (0x02) |
|
1406 PNG_AFTER_IDAT (0x08) |
|
1407 |
|
1408 The data from the pHYs chunk can be retrieved in several convenient |
|
1409 forms: |
|
1410 |
|
1411 res_x = png_get_x_pixels_per_meter(png_ptr, |
|
1412 info_ptr) |
|
1413 |
|
1414 res_y = png_get_y_pixels_per_meter(png_ptr, |
|
1415 info_ptr) |
|
1416 |
|
1417 res_x_and_y = png_get_pixels_per_meter(png_ptr, |
|
1418 info_ptr) |
|
1419 |
|
1420 res_x = png_get_x_pixels_per_inch(png_ptr, |
|
1421 info_ptr) |
|
1422 |
|
1423 res_y = png_get_y_pixels_per_inch(png_ptr, |
|
1424 info_ptr) |
|
1425 |
|
1426 res_x_and_y = png_get_pixels_per_inch(png_ptr, |
|
1427 info_ptr) |
|
1428 |
|
1429 aspect_ratio = png_get_pixel_aspect_ratio(png_ptr, |
|
1430 info_ptr) |
|
1431 |
|
1432 Each of these returns 0 [signifying "unknown"] if |
|
1433 the data is not present or if res_x is 0; |
|
1434 res_x_and_y is 0 if res_x != res_y |
|
1435 |
|
1436 Note that because of the way the resolutions are |
|
1437 stored internally, the inch conversions won't |
|
1438 come out to exactly even number. For example, |
|
1439 72 dpi is stored as 0.28346 pixels/meter, and |
|
1440 when this is retrieved it is 71.9988 dpi, so |
|
1441 be sure to round the returned value appropriately |
|
1442 if you want to display a reasonable-looking result. |
|
1443 |
|
1444 The data from the oFFs chunk can be retrieved in several convenient |
|
1445 forms: |
|
1446 |
|
1447 x_offset = png_get_x_offset_microns(png_ptr, info_ptr); |
|
1448 |
|
1449 y_offset = png_get_y_offset_microns(png_ptr, info_ptr); |
|
1450 |
|
1451 x_offset = png_get_x_offset_inches(png_ptr, info_ptr); |
|
1452 |
|
1453 y_offset = png_get_y_offset_inches(png_ptr, info_ptr); |
|
1454 |
|
1455 Each of these returns 0 [signifying "unknown" if both |
|
1456 x and y are 0] if the data is not present or if the |
|
1457 chunk is present but the unit is the pixel. The |
|
1458 remark about inexact inch conversions applies here |
|
1459 as well, because a value in inches can't always be |
|
1460 converted to microns and back without some loss |
|
1461 of precision. |
|
1462 |
|
1463 For more information, see the |
|
1464 PNG specification for chunk contents. Be careful with trusting |
|
1465 rowbytes, as some of the transformations could increase the space |
|
1466 needed to hold a row (expand, filler, gray_to_rgb, etc.). |
|
1467 See png_read_update_info(), below. |
|
1468 |
|
1469 A quick word about text_ptr and num_text. PNG stores comments in |
|
1470 keyword/text pairs, one pair per chunk, with no limit on the number |
|
1471 of text chunks, and a 2^31 byte limit on their size. While there are |
|
1472 suggested keywords, there is no requirement to restrict the use to these |
|
1473 strings. It is strongly suggested that keywords and text be sensible |
|
1474 to humans (that's the point), so don't use abbreviations. Non-printing |
|
1475 symbols are not allowed. See the PNG specification for more details. |
|
1476 There is also no requirement to have text after the keyword. |
|
1477 |
|
1478 Keywords should be limited to 79 Latin-1 characters without leading or |
|
1479 trailing spaces, but non-consecutive spaces are allowed within the |
|
1480 keyword. It is possible to have the same keyword any number of times. |
|
1481 The text_ptr is an array of png_text structures, each holding a |
|
1482 pointer to a language string, a pointer to a keyword and a pointer to |
|
1483 a text string. The text string, language code, and translated |
|
1484 keyword may be empty or NULL pointers. The keyword/text |
|
1485 pairs are put into the array in the order that they are received. |
|
1486 However, some or all of the text chunks may be after the image, so, to |
|
1487 make sure you have read all the text chunks, don't mess with these |
|
1488 until after you read the stuff after the image. This will be |
|
1489 mentioned again below in the discussion that goes with png_read_end(). |
|
1490 |
|
1491 Input transformations |
|
1492 |
|
1493 After you've read the header information, you can set up the library |
|
1494 to handle any special transformations of the image data. The various |
|
1495 ways to transform the data will be described in the order that they |
|
1496 should occur. This is important, as some of these change the color |
|
1497 type and/or bit depth of the data, and some others only work on |
|
1498 certain color types and bit depths. |
|
1499 |
|
1500 Transformations you request are ignored if they don't have any meaning for a |
|
1501 particular input data format. However some transformations can have an effect |
|
1502 as a result of a previous transformation. If you specify a contradictory set of |
|
1503 transformations, for example both adding and removing the alpha channel, you |
|
1504 cannot predict the final result. |
|
1505 |
|
1506 The color used for the transparency values should be supplied in the same |
|
1507 format/depth as the current image data. It is stored in the same format/depth |
|
1508 as the image data in a tRNS chunk, so this is what libpng expects for this data. |
|
1509 |
|
1510 The color used for the background value depends on the need_expand argument as |
|
1511 described below. |
|
1512 |
|
1513 Data will be decoded into the supplied row buffers packed into bytes |
|
1514 unless the library has been told to transform it into another format. |
|
1515 For example, 4 bit/pixel paletted or grayscale data will be returned |
|
1516 2 pixels/byte with the leftmost pixel in the high-order bits of the |
|
1517 byte, unless png_set_packing() is called. 8-bit RGB data will be stored |
|
1518 in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha() |
|
1519 is called to insert filler bytes, either before or after each RGB triplet. |
|
1520 16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant |
|
1521 byte of the color value first, unless png_set_scale_16() is called to |
|
1522 transform it to regular RGB RGB triplets, or png_set_filler() or |
|
1523 png_set_add alpha() is called to insert filler bytes, either before or |
|
1524 after each RRGGBB triplet. Similarly, 8-bit or 16-bit grayscale data can |
|
1525 be modified with png_set_filler(), png_set_add_alpha(), png_set_strip_16(), |
|
1526 or png_set_scale_16(). |
|
1527 |
|
1528 The following code transforms grayscale images of less than 8 to 8 bits, |
|
1529 changes paletted images to RGB, and adds a full alpha channel if there is |
|
1530 transparency information in a tRNS chunk. This is most useful on |
|
1531 grayscale images with bit depths of 2 or 4 or if there is a multiple-image |
|
1532 viewing application that wishes to treat all images in the same way. |
|
1533 |
|
1534 if (color_type == PNG_COLOR_TYPE_PALETTE) |
|
1535 png_set_palette_to_rgb(png_ptr); |
|
1536 |
|
1537 if (png_get_valid(png_ptr, info_ptr, |
|
1538 PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr); |
|
1539 |
|
1540 if (color_type == PNG_COLOR_TYPE_GRAY && |
|
1541 bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr); |
|
1542 |
|
1543 The first two functions are actually aliases for png_set_expand(), added |
|
1544 in libpng version 1.0.4, with the function names expanded to improve code |
|
1545 readability. In some future version they may actually do different |
|
1546 things. |
|
1547 |
|
1548 As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was |
|
1549 added. It expands the sample depth without changing tRNS to alpha. |
|
1550 |
|
1551 As of libpng version 1.5.2, png_set_expand_16() was added. It behaves as |
|
1552 png_set_expand(); however, the resultant channels have 16 bits rather than 8. |
|
1553 Use this when the output color or gray channels are made linear to avoid fairly |
|
1554 severe accuracy loss. |
|
1555 |
|
1556 if (bit_depth < 16) |
|
1557 png_set_expand_16(png_ptr); |
|
1558 |
|
1559 PNG can have files with 16 bits per channel. If you only can handle |
|
1560 8 bits per channel, this will strip the pixels down to 8-bit. |
|
1561 |
|
1562 if (bit_depth == 16) |
|
1563 #if PNG_LIBPNG_VER >= 10504 |
|
1564 png_set_scale_16(png_ptr); |
|
1565 #else |
|
1566 png_set_strip_16(png_ptr); |
|
1567 #endif |
|
1568 |
|
1569 (The more accurate "png_set_scale_16()" API became available in libpng version |
|
1570 1.5.4). |
|
1571 |
|
1572 If you need to process the alpha channel on the image separately from the image |
|
1573 data (for example if you convert it to a bitmap mask) it is possible to have |
|
1574 libpng strip the channel leaving just RGB or gray data: |
|
1575 |
|
1576 if (color_type & PNG_COLOR_MASK_ALPHA) |
|
1577 png_set_strip_alpha(png_ptr); |
|
1578 |
|
1579 If you strip the alpha channel you need to find some other way of dealing with |
|
1580 the information. If, instead, you want to convert the image to an opaque |
|
1581 version with no alpha channel use png_set_background; see below. |
|
1582 |
|
1583 As of libpng version 1.5.2, almost all useful expansions are supported, the |
|
1584 major ommissions are conversion of grayscale to indexed images (which can be |
|
1585 done trivially in the application) and conversion of indexed to grayscale (which |
|
1586 can be done by a trivial manipulation of the palette.) |
|
1587 |
|
1588 In the following table, the 01 means grayscale with depth<8, 31 means |
|
1589 indexed with depth<8, other numerals represent the color type, "T" means |
|
1590 the tRNS chunk is present, A means an alpha channel is present, and O |
|
1591 means tRNS or alpha is present but all pixels in the image are opaque. |
|
1592 |
|
1593 FROM 01 31 0 0T 0O 2 2T 2O 3 3T 3O 4A 4O 6A 6O |
|
1594 TO |
|
1595 01 - [G] - - - - - - - - - - - - - |
|
1596 31 [Q] Q [Q] [Q] [Q] Q Q Q Q Q Q [Q] [Q] Q Q |
|
1597 0 1 G + . . G G G G G G B B GB GB |
|
1598 0T lt Gt t + . Gt G G Gt G G Bt Bt GBt GBt |
|
1599 0O lt Gt t . + Gt Gt G Gt Gt G Bt Bt GBt GBt |
|
1600 2 C P C C C + . . C - - CB CB B B |
|
1601 2T Ct - Ct C C t + t - - - CBt CBt Bt Bt |
|
1602 2O Ct - Ct C C t t + - - - CBt CBt Bt Bt |
|
1603 3 [Q] p [Q] [Q] [Q] Q Q Q + . . [Q] [Q] Q Q |
|
1604 3T [Qt] p [Qt][Q] [Q] Qt Qt Qt t + t [Qt][Qt] Qt Qt |
|
1605 3O [Qt] p [Qt][Q] [Q] Qt Qt Qt t t + [Qt][Qt] Qt Qt |
|
1606 4A lA G A T T GA GT GT GA GT GT + BA G GBA |
|
1607 4O lA GBA A T T GA GT GT GA GT GT BA + GBA G |
|
1608 6A CA PA CA C C A T tT PA P P C CBA + BA |
|
1609 6O CA PBA CA C C A tT T PA P P CBA C BA + |
|
1610 |
|
1611 Within the matrix, |
|
1612 "+" identifies entries where 'from' and 'to' are the same. |
|
1613 "-" means the transformation is not supported. |
|
1614 "." means nothing is necessary (a tRNS chunk can just be ignored). |
|
1615 "t" means the transformation is obtained by png_set_tRNS. |
|
1616 "A" means the transformation is obtained by png_set_add_alpha(). |
|
1617 "X" means the transformation is obtained by png_set_expand(). |
|
1618 "1" means the transformation is obtained by |
|
1619 png_set_expand_gray_1_2_4_to_8() (and by png_set_expand() |
|
1620 if there is no transparency in the original or the final |
|
1621 format). |
|
1622 "C" means the transformation is obtained by png_set_gray_to_rgb(). |
|
1623 "G" means the transformation is obtained by png_set_rgb_to_gray(). |
|
1624 "P" means the transformation is obtained by |
|
1625 png_set_expand_palette_to_rgb(). |
|
1626 "p" means the transformation is obtained by png_set_packing(). |
|
1627 "Q" means the transformation is obtained by png_set_quantize(). |
|
1628 "T" means the transformation is obtained by |
|
1629 png_set_tRNS_to_alpha(). |
|
1630 "B" means the transformation is obtained by |
|
1631 png_set_background(), or png_strip_alpha(). |
|
1632 |
|
1633 When an entry has multiple transforms listed all are required to cause the |
|
1634 right overall transformation. When two transforms are separated by a comma |
|
1635 either will do the job. When transforms are enclosed in [] the transform should |
|
1636 do the job but this is currently unimplemented - a different format will result |
|
1637 if the suggested transformations are used. |
|
1638 |
|
1639 In PNG files, the alpha channel in an image |
|
1640 is the level of opacity. If you need the alpha channel in an image to |
|
1641 be the level of transparency instead of opacity, you can invert the |
|
1642 alpha channel (or the tRNS chunk data) after it's read, so that 0 is |
|
1643 fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit |
|
1644 images) is fully transparent, with |
|
1645 |
|
1646 png_set_invert_alpha(png_ptr); |
|
1647 |
|
1648 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as |
|
1649 they can, resulting in, for example, 8 pixels per byte for 1 bit |
|
1650 files. This code expands to 1 pixel per byte without changing the |
|
1651 values of the pixels: |
|
1652 |
|
1653 if (bit_depth < 8) |
|
1654 png_set_packing(png_ptr); |
|
1655 |
|
1656 PNG files have possible bit depths of 1, 2, 4, 8, and 16. All pixels |
|
1657 stored in a PNG image have been "scaled" or "shifted" up to the next |
|
1658 higher possible bit depth (e.g. from 5 bits/sample in the range [0,31] |
|
1659 to 8 bits/sample in the range [0, 255]). However, it is also possible |
|
1660 to convert the PNG pixel data back to the original bit depth of the |
|
1661 image. This call reduces the pixels back down to the original bit depth: |
|
1662 |
|
1663 png_color_8p sig_bit; |
|
1664 |
|
1665 if (png_get_sBIT(png_ptr, info_ptr, &sig_bit)) |
|
1666 png_set_shift(png_ptr, sig_bit); |
|
1667 |
|
1668 PNG files store 3-color pixels in red, green, blue order. This code |
|
1669 changes the storage of the pixels to blue, green, red: |
|
1670 |
|
1671 if (color_type == PNG_COLOR_TYPE_RGB || |
|
1672 color_type == PNG_COLOR_TYPE_RGB_ALPHA) |
|
1673 png_set_bgr(png_ptr); |
|
1674 |
|
1675 PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them |
|
1676 into 4 or 8 bytes for windowing systems that need them in this format: |
|
1677 |
|
1678 if (color_type == PNG_COLOR_TYPE_RGB) |
|
1679 png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE); |
|
1680 |
|
1681 where "filler" is the 8 or 16-bit number to fill with, and the location is |
|
1682 either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether |
|
1683 you want the filler before the RGB or after. This transformation |
|
1684 does not affect images that already have full alpha channels. To add an |
|
1685 opaque alpha channel, use filler=0xff or 0xffff and PNG_FILLER_AFTER which |
|
1686 will generate RGBA pixels. |
|
1687 |
|
1688 Note that png_set_filler() does not change the color type. If you want |
|
1689 to do that, you can add a true alpha channel with |
|
1690 |
|
1691 if (color_type == PNG_COLOR_TYPE_RGB || |
|
1692 color_type == PNG_COLOR_TYPE_GRAY) |
|
1693 png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER); |
|
1694 |
|
1695 where "filler" contains the alpha value to assign to each pixel. |
|
1696 This function was added in libpng-1.2.7. |
|
1697 |
|
1698 If you are reading an image with an alpha channel, and you need the |
|
1699 data as ARGB instead of the normal PNG format RGBA: |
|
1700 |
|
1701 if (color_type == PNG_COLOR_TYPE_RGB_ALPHA) |
|
1702 png_set_swap_alpha(png_ptr); |
|
1703 |
|
1704 For some uses, you may want a grayscale image to be represented as |
|
1705 RGB. This code will do that conversion: |
|
1706 |
|
1707 if (color_type == PNG_COLOR_TYPE_GRAY || |
|
1708 color_type == PNG_COLOR_TYPE_GRAY_ALPHA) |
|
1709 png_set_gray_to_rgb(png_ptr); |
|
1710 |
|
1711 Conversely, you can convert an RGB or RGBA image to grayscale or grayscale |
|
1712 with alpha. |
|
1713 |
|
1714 if (color_type == PNG_COLOR_TYPE_RGB || |
|
1715 color_type == PNG_COLOR_TYPE_RGB_ALPHA) |
|
1716 png_set_rgb_to_gray(png_ptr, error_action, |
|
1717 double red_weight, double green_weight); |
|
1718 |
|
1719 error_action = 1: silently do the conversion |
|
1720 |
|
1721 error_action = 2: issue a warning if the original |
|
1722 image has any pixel where |
|
1723 red != green or red != blue |
|
1724 |
|
1725 error_action = 3: issue an error and abort the |
|
1726 conversion if the original |
|
1727 image has any pixel where |
|
1728 red != green or red != blue |
|
1729 |
|
1730 red_weight: weight of red component |
|
1731 |
|
1732 green_weight: weight of green component |
|
1733 If either weight is negative, default |
|
1734 weights are used. |
|
1735 |
|
1736 In the corresponding fixed point API the red_weight and green_weight values are |
|
1737 simply scaled by 100,000: |
|
1738 |
|
1739 png_set_rgb_to_gray(png_ptr, error_action, |
|
1740 png_fixed_point red_weight, |
|
1741 png_fixed_point green_weight); |
|
1742 |
|
1743 If you have set error_action = 1 or 2, you can |
|
1744 later check whether the image really was gray, after processing |
|
1745 the image rows, with the png_get_rgb_to_gray_status(png_ptr) function. |
|
1746 It will return a png_byte that is zero if the image was gray or |
|
1747 1 if there were any non-gray pixels. Background and sBIT data |
|
1748 will be silently converted to grayscale, using the green channel |
|
1749 data for sBIT, regardless of the error_action setting. |
|
1750 |
|
1751 The default values come from the PNG file cHRM chunk if present; otherwise, the |
|
1752 defaults correspond to the ITU-R recommendation 709, and also the sRGB color |
|
1753 space, as recommended in the Charles Poynton's Colour FAQ, |
|
1754 <http://www.poynton.com/>, in section 9: |
|
1755 |
|
1756 <http://www.poynton.com/notes/colour_and_gamma/ColorFAQ.html#RTFToC9> |
|
1757 |
|
1758 Y = 0.2126 * R + 0.7152 * G + 0.0722 * B |
|
1759 |
|
1760 Previous versions of this document, 1998 through 2002, recommended a slightly |
|
1761 different formula: |
|
1762 |
|
1763 Y = 0.212671 * R + 0.715160 * G + 0.072169 * B |
|
1764 |
|
1765 Libpng uses an integer approximation: |
|
1766 |
|
1767 Y = (6968 * R + 23434 * G + 2366 * B)/32768 |
|
1768 |
|
1769 The calculation is done in a linear colorspace, if the image gamma |
|
1770 can be determined. |
|
1771 |
|
1772 The png_set_background() function has been described already; it tells libpng to |
|
1773 composite images with alpha or simple transparency against the supplied |
|
1774 background color. For compatibility with versions of libpng earlier than |
|
1775 libpng-1.5.4 it is recommended that you call the function after reading the file |
|
1776 header, even if you don't want to use the color in a bKGD chunk, if one exists. |
|
1777 |
|
1778 If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid), |
|
1779 you may use this color, or supply another color more suitable for |
|
1780 the current display (e.g., the background color from a web page). You |
|
1781 need to tell libpng how the color is represented, both the format of the |
|
1782 component values in the color (the number of bits) and the gamma encoding of the |
|
1783 color. The function takes two arguments, background_gamma_mode and need_expand |
|
1784 to convey this information; however, only two combinations are likely to be |
|
1785 useful: |
|
1786 |
|
1787 png_color_16 my_background; |
|
1788 png_color_16p image_background; |
|
1789 |
|
1790 if (png_get_bKGD(png_ptr, info_ptr, &image_background)) |
|
1791 png_set_background(png_ptr, image_background, |
|
1792 PNG_BACKGROUND_GAMMA_FILE, 1/*needs to be expanded*/, 1); |
|
1793 else |
|
1794 png_set_background(png_ptr, &my_background, |
|
1795 PNG_BACKGROUND_GAMMA_SCREEN, 0/*do not expand*/, 1); |
|
1796 |
|
1797 The second call was described above - my_background is in the format of the |
|
1798 final, display, output produced by libpng. Because you now know the format of |
|
1799 the PNG it is possible to avoid the need to choose either 8-bit or 16-bit |
|
1800 output and to retain palette images (the palette colors will be modified |
|
1801 appropriately and the tRNS chunk removed.) However, if you are doing this, |
|
1802 take great care not to ask for transformations without checking first that |
|
1803 they apply! |
|
1804 |
|
1805 In the first call the background color has the original bit depth and color type |
|
1806 of the PNG file. So, for palette images the color is supplied as a palette |
|
1807 index and for low bit greyscale images the color is a reduced bit value in |
|
1808 image_background->gray. |
|
1809 |
|
1810 If you didn't call png_set_gamma() before reading the file header, for example |
|
1811 if you need your code to remain compatible with older versions of libpng prior |
|
1812 to libpng-1.5.4, this is the place to call it. |
|
1813 |
|
1814 Do not call it if you called png_set_alpha_mode(); doing so will damage the |
|
1815 settings put in place by png_set_alpha_mode(). (If png_set_alpha_mode() is |
|
1816 supported then you can certainly do png_set_gamma() before reading the PNG |
|
1817 header.) |
|
1818 |
|
1819 This API unconditionally sets the screen and file gamma values, so it will |
|
1820 override the value in the PNG file unless it is called before the PNG file |
|
1821 reading starts. For this reason you must always call it with the PNG file |
|
1822 value when you call it in this position: |
|
1823 |
|
1824 if (png_get_gAMA(png_ptr, info_ptr, &file_gamma)) |
|
1825 png_set_gamma(png_ptr, screen_gamma, file_gamma); |
|
1826 |
|
1827 else |
|
1828 png_set_gamma(png_ptr, screen_gamma, 0.45455); |
|
1829 |
|
1830 If you need to reduce an RGB file to a paletted file, or if a paletted |
|
1831 file has more entries then will fit on your screen, png_set_quantize() |
|
1832 will do that. Note that this is a simple match quantization that merely |
|
1833 finds the closest color available. This should work fairly well with |
|
1834 optimized palettes, but fairly badly with linear color cubes. If you |
|
1835 pass a palette that is larger than maximum_colors, the file will |
|
1836 reduce the number of colors in the palette so it will fit into |
|
1837 maximum_colors. If there is a histogram, libpng will use it to make |
|
1838 more intelligent choices when reducing the palette. If there is no |
|
1839 histogram, it may not do as good a job. |
|
1840 |
|
1841 if (color_type & PNG_COLOR_MASK_COLOR) |
|
1842 { |
|
1843 if (png_get_valid(png_ptr, info_ptr, |
|
1844 PNG_INFO_PLTE)) |
|
1845 { |
|
1846 png_uint_16p histogram = NULL; |
|
1847 |
|
1848 png_get_hIST(png_ptr, info_ptr, |
|
1849 &histogram); |
|
1850 png_set_quantize(png_ptr, palette, num_palette, |
|
1851 max_screen_colors, histogram, 1); |
|
1852 } |
|
1853 |
|
1854 else |
|
1855 { |
|
1856 png_color std_color_cube[MAX_SCREEN_COLORS] = |
|
1857 { ... colors ... }; |
|
1858 |
|
1859 png_set_quantize(png_ptr, std_color_cube, |
|
1860 MAX_SCREEN_COLORS, MAX_SCREEN_COLORS, |
|
1861 NULL,0); |
|
1862 } |
|
1863 } |
|
1864 |
|
1865 PNG files describe monochrome as black being zero and white being one. |
|
1866 The following code will reverse this (make black be one and white be |
|
1867 zero): |
|
1868 |
|
1869 if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY) |
|
1870 png_set_invert_mono(png_ptr); |
|
1871 |
|
1872 This function can also be used to invert grayscale and gray-alpha images: |
|
1873 |
|
1874 if (color_type == PNG_COLOR_TYPE_GRAY || |
|
1875 color_type == PNG_COLOR_TYPE_GRAY_ALPHA) |
|
1876 png_set_invert_mono(png_ptr); |
|
1877 |
|
1878 PNG files store 16-bit pixels in network byte order (big-endian, |
|
1879 ie. most significant bits first). This code changes the storage to the |
|
1880 other way (little-endian, i.e. least significant bits first, the |
|
1881 way PCs store them): |
|
1882 |
|
1883 if (bit_depth == 16) |
|
1884 png_set_swap(png_ptr); |
|
1885 |
|
1886 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you |
|
1887 need to change the order the pixels are packed into bytes, you can use: |
|
1888 |
|
1889 if (bit_depth < 8) |
|
1890 png_set_packswap(png_ptr); |
|
1891 |
|
1892 Finally, you can write your own transformation function if none of |
|
1893 the existing ones meets your needs. This is done by setting a callback |
|
1894 with |
|
1895 |
|
1896 png_set_read_user_transform_fn(png_ptr, |
|
1897 read_transform_fn); |
|
1898 |
|
1899 You must supply the function |
|
1900 |
|
1901 void read_transform_fn(png_structp png_ptr, png_row_infop |
|
1902 row_info, png_bytep data) |
|
1903 |
|
1904 See pngtest.c for a working example. Your function will be called |
|
1905 after all of the other transformations have been processed. Take care with |
|
1906 interlaced images if you do the interlace yourself - the width of the row is the |
|
1907 width in 'row_info', not the overall image width. |
|
1908 |
|
1909 If supported, libpng provides two information routines that you can use to find |
|
1910 where you are in processing the image: |
|
1911 |
|
1912 png_get_current_pass_number(png_structp png_ptr); |
|
1913 png_get_current_row_number(png_structp png_ptr); |
|
1914 |
|
1915 Don't try using these outside a transform callback - firstly they are only |
|
1916 supported if user transforms are supported, secondly they may well return |
|
1917 unexpected results unless the row is actually being processed at the moment they |
|
1918 are called. |
|
1919 |
|
1920 With interlaced |
|
1921 images the value returned is the row in the input sub-image image. Use |
|
1922 PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to |
|
1923 find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass). |
|
1924 |
|
1925 The discussion of interlace handling above contains more information on how to |
|
1926 use these values. |
|
1927 |
|
1928 You can also set up a pointer to a user structure for use by your |
|
1929 callback function, and you can inform libpng that your transform |
|
1930 function will change the number of channels or bit depth with the |
|
1931 function |
|
1932 |
|
1933 png_set_user_transform_info(png_ptr, user_ptr, |
|
1934 user_depth, user_channels); |
|
1935 |
|
1936 The user's application, not libpng, is responsible for allocating and |
|
1937 freeing any memory required for the user structure. |
|
1938 |
|
1939 You can retrieve the pointer via the function |
|
1940 png_get_user_transform_ptr(). For example: |
|
1941 |
|
1942 voidp read_user_transform_ptr = |
|
1943 png_get_user_transform_ptr(png_ptr); |
|
1944 |
|
1945 The last thing to handle is interlacing; this is covered in detail below, |
|
1946 but you must call the function here if you want libpng to handle expansion |
|
1947 of the interlaced image. |
|
1948 |
|
1949 number_of_passes = png_set_interlace_handling(png_ptr); |
|
1950 |
|
1951 After setting the transformations, libpng can update your png_info |
|
1952 structure to reflect any transformations you've requested with this |
|
1953 call. |
|
1954 |
|
1955 png_read_update_info(png_ptr, info_ptr); |
|
1956 |
|
1957 This is most useful to update the info structure's rowbytes |
|
1958 field so you can use it to allocate your image memory. This function |
|
1959 will also update your palette with the correct screen_gamma and |
|
1960 background if these have been given with the calls above. You may |
|
1961 only call png_read_update_info() once with a particular info_ptr. |
|
1962 |
|
1963 After you call png_read_update_info(), you can allocate any |
|
1964 memory you need to hold the image. The row data is simply |
|
1965 raw byte data for all forms of images. As the actual allocation |
|
1966 varies among applications, no example will be given. If you |
|
1967 are allocating one large chunk, you will need to build an |
|
1968 array of pointers to each row, as it will be needed for some |
|
1969 of the functions below. |
|
1970 |
|
1971 Remember: Before you call png_read_update_info(), the png_get_*() |
|
1972 functions return the values corresponding to the original PNG image. |
|
1973 After you call png_read_update_info the values refer to the image |
|
1974 that libpng will output. Consequently you must call all the png_set_ |
|
1975 functions before you call png_read_update_info(). This is particularly |
|
1976 important for png_set_interlace_handling() - if you are going to call |
|
1977 png_read_update_info() you must call png_set_interlace_handling() before |
|
1978 it unless you want to receive interlaced output. |
|
1979 |
|
1980 Reading image data |
|
1981 |
|
1982 After you've allocated memory, you can read the image data. |
|
1983 The simplest way to do this is in one function call. If you are |
|
1984 allocating enough memory to hold the whole image, you can just |
|
1985 call png_read_image() and libpng will read in all the image data |
|
1986 and put it in the memory area supplied. You will need to pass in |
|
1987 an array of pointers to each row. |
|
1988 |
|
1989 This function automatically handles interlacing, so you don't |
|
1990 need to call png_set_interlace_handling() (unless you call |
|
1991 png_read_update_info()) or call this function multiple times, or any |
|
1992 of that other stuff necessary with png_read_rows(). |
|
1993 |
|
1994 png_read_image(png_ptr, row_pointers); |
|
1995 |
|
1996 where row_pointers is: |
|
1997 |
|
1998 png_bytep row_pointers[height]; |
|
1999 |
|
2000 You can point to void or char or whatever you use for pixels. |
|
2001 |
|
2002 If you don't want to read in the whole image at once, you can |
|
2003 use png_read_rows() instead. If there is no interlacing (check |
|
2004 interlace_type == PNG_INTERLACE_NONE), this is simple: |
|
2005 |
|
2006 png_read_rows(png_ptr, row_pointers, NULL, |
|
2007 number_of_rows); |
|
2008 |
|
2009 where row_pointers is the same as in the png_read_image() call. |
|
2010 |
|
2011 If you are doing this just one row at a time, you can do this with |
|
2012 a single row_pointer instead of an array of row_pointers: |
|
2013 |
|
2014 png_bytep row_pointer = row; |
|
2015 png_read_row(png_ptr, row_pointer, NULL); |
|
2016 |
|
2017 If the file is interlaced (interlace_type != 0 in the IHDR chunk), things |
|
2018 get somewhat harder. The only current (PNG Specification version 1.2) |
|
2019 interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7); |
|
2020 a somewhat complicated 2D interlace scheme, known as Adam7, that |
|
2021 breaks down an image into seven smaller images of varying size, based |
|
2022 on an 8x8 grid. This number is defined (from libpng 1.5) as |
|
2023 PNG_INTERLACE_ADAM7_PASSES in png.h |
|
2024 |
|
2025 libpng can fill out those images or it can give them to you "as is". |
|
2026 It is almost always better to have libpng handle the interlacing for you. |
|
2027 If you want the images filled out, there are two ways to do that. The one |
|
2028 mentioned in the PNG specification is to expand each pixel to cover |
|
2029 those pixels that have not been read yet (the "rectangle" method). |
|
2030 This results in a blocky image for the first pass, which gradually |
|
2031 smooths out as more pixels are read. The other method is the "sparkle" |
|
2032 method, where pixels are drawn only in their final locations, with the |
|
2033 rest of the image remaining whatever colors they were initialized to |
|
2034 before the start of the read. The first method usually looks better, |
|
2035 but tends to be slower, as there are more pixels to put in the rows. |
|
2036 |
|
2037 If, as is likely, you want libpng to expand the images, call this before |
|
2038 calling png_start_read_image() or png_read_update_info(): |
|
2039 |
|
2040 if (interlace_type == PNG_INTERLACE_ADAM7) |
|
2041 number_of_passes |
|
2042 = png_set_interlace_handling(png_ptr); |
|
2043 |
|
2044 This will return the number of passes needed. Currently, this is seven, |
|
2045 but may change if another interlace type is added. This function can be |
|
2046 called even if the file is not interlaced, where it will return one pass. |
|
2047 You then need to read the whole image 'number_of_passes' times. Each time |
|
2048 will distribute the pixels from the current pass to the correct place in |
|
2049 the output image, so you need to supply the same rows to png_read_rows in |
|
2050 each pass. |
|
2051 |
|
2052 If you are not going to display the image after each pass, but are |
|
2053 going to wait until the entire image is read in, use the sparkle |
|
2054 effect. This effect is faster and the end result of either method |
|
2055 is exactly the same. If you are planning on displaying the image |
|
2056 after each pass, the "rectangle" effect is generally considered the |
|
2057 better looking one. |
|
2058 |
|
2059 If you only want the "sparkle" effect, just call png_read_rows() as |
|
2060 normal, with the third parameter NULL. Make sure you make pass over |
|
2061 the image number_of_passes times, and you don't change the data in the |
|
2062 rows between calls. You can change the locations of the data, just |
|
2063 not the data. Each pass only writes the pixels appropriate for that |
|
2064 pass, and assumes the data from previous passes is still valid. |
|
2065 |
|
2066 png_read_rows(png_ptr, row_pointers, NULL, |
|
2067 number_of_rows); |
|
2068 |
|
2069 If you only want the first effect (the rectangles), do the same as |
|
2070 before except pass the row buffer in the third parameter, and leave |
|
2071 the second parameter NULL. |
|
2072 |
|
2073 png_read_rows(png_ptr, NULL, row_pointers, |
|
2074 number_of_rows); |
|
2075 |
|
2076 If you don't want libpng to handle the interlacing details, just call |
|
2077 png_read_rows() PNG_INTERLACE_ADAM7_PASSES times to read in all the images. |
|
2078 Each of the images is a valid image by itself; however, you will almost |
|
2079 certainly need to distribute the pixels from each sub-image to the |
|
2080 correct place. This is where everything gets very tricky. |
|
2081 |
|
2082 If you want to retrieve the separate images you must pass the correct |
|
2083 number of rows to each successive call of png_read_rows(). The calculation |
|
2084 gets pretty complicated for small images, where some sub-images may |
|
2085 not even exist because either their width or height ends up zero. |
|
2086 libpng provides two macros to help you in 1.5 and later versions: |
|
2087 |
|
2088 png_uint_32 width = PNG_PASS_COLS(image_width, pass_number); |
|
2089 png_uint_32 height = PNG_PASS_ROWS(image_height, pass_number); |
|
2090 |
|
2091 Respectively these tell you the width and height of the sub-image |
|
2092 corresponding to the numbered pass. 'pass' is in in the range 0 to 6 - |
|
2093 this can be confusing because the specification refers to the same passes |
|
2094 as 1 to 7! Be careful, you must check both the width and height before |
|
2095 calling png_read_rows() and not call it for that pass if either is zero. |
|
2096 |
|
2097 You can, of course, read each sub-image row by row. If you want to |
|
2098 produce optimal code to make a pixel-by-pixel transformation of an |
|
2099 interlaced image this is the best approach; read each row of each pass, |
|
2100 transform it, and write it out to a new interlaced image. |
|
2101 |
|
2102 If you want to de-interlace the image yourself libpng provides further |
|
2103 macros to help that tell you where to place the pixels in the output image. |
|
2104 Because the interlacing scheme is rectangular - sub-image pixels are always |
|
2105 arranged on a rectangular grid - all you need to know for each pass is the |
|
2106 starting column and row in the output image of the first pixel plus the |
|
2107 spacing between each pixel. As of libpng 1.5 there are four macros to |
|
2108 retrieve this information: |
|
2109 |
|
2110 png_uint_32 x = PNG_PASS_START_COL(pass); |
|
2111 png_uint_32 y = PNG_PASS_START_ROW(pass); |
|
2112 png_uint_32 xStep = 1U << PNG_PASS_COL_SHIFT(pass); |
|
2113 png_uint_32 yStep = 1U << PNG_PASS_ROW_SHIFT(pass); |
|
2114 |
|
2115 These allow you to write the obvious loop: |
|
2116 |
|
2117 png_uint_32 input_y = 0; |
|
2118 png_uint_32 output_y = PNG_PASS_START_ROW(pass); |
|
2119 |
|
2120 while (output_y < output_image_height) |
|
2121 { |
|
2122 png_uint_32 input_x = 0; |
|
2123 png_uint_32 output_x = PNG_PASS_START_COL(pass); |
|
2124 |
|
2125 while (output_x < output_image_width) |
|
2126 { |
|
2127 image[output_y][output_x] = |
|
2128 subimage[pass][input_y][input_x++]; |
|
2129 |
|
2130 output_x += xStep; |
|
2131 } |
|
2132 |
|
2133 ++input_y; |
|
2134 output_y += yStep; |
|
2135 } |
|
2136 |
|
2137 Notice that the steps between successive output rows and columns are |
|
2138 returned as shifts. This is possible because the pixels in the subimages |
|
2139 are always a power of 2 apart - 1, 2, 4 or 8 pixels - in the original |
|
2140 image. In practice you may need to directly calculate the output coordinate |
|
2141 given an input coordinate. libpng provides two further macros for this |
|
2142 purpose: |
|
2143 |
|
2144 png_uint_32 output_x = PNG_COL_FROM_PASS_COL(input_x, pass); |
|
2145 png_uint_32 output_y = PNG_ROW_FROM_PASS_ROW(input_y, pass); |
|
2146 |
|
2147 Finally a pair of macros are provided to tell you if a particular image |
|
2148 row or column appears in a given pass: |
|
2149 |
|
2150 int col_in_pass = PNG_COL_IN_INTERLACE_PASS(output_x, pass); |
|
2151 int row_in_pass = PNG_ROW_IN_INTERLACE_PASS(output_y, pass); |
|
2152 |
|
2153 Bear in mind that you will probably also need to check the width and height |
|
2154 of the pass in addition to the above to be sure the pass even exists! |
|
2155 |
|
2156 With any luck you are convinced by now that you don't want to do your own |
|
2157 interlace handling. In reality normally the only good reason for doing this |
|
2158 is if you are processing PNG files on a pixel-by-pixel basis and don't want |
|
2159 to load the whole file into memory when it is interlaced. |
|
2160 |
|
2161 libpng includes a test program, pngvalid, that illustrates reading and |
|
2162 writing of interlaced images. If you can't get interlacing to work in your |
|
2163 code and don't want to leave it to libpng (the recommended approach), see |
|
2164 how pngvalid.c does it. |
|
2165 |
|
2166 Finishing a sequential read |
|
2167 |
|
2168 After you are finished reading the image through the |
|
2169 low-level interface, you can finish reading the file. If you are |
|
2170 interested in comments or time, which may be stored either before or |
|
2171 after the image data, you should pass the separate png_info struct if |
|
2172 you want to keep the comments from before and after the image |
|
2173 separate. |
|
2174 |
|
2175 png_infop end_info = png_create_info_struct(png_ptr); |
|
2176 |
|
2177 if (!end_info) |
|
2178 { |
|
2179 png_destroy_read_struct(&png_ptr, &info_ptr, |
|
2180 (png_infopp)NULL); |
|
2181 return (ERROR); |
|
2182 } |
|
2183 |
|
2184 png_read_end(png_ptr, end_info); |
|
2185 |
|
2186 If you are not interested, you should still call png_read_end() |
|
2187 but you can pass NULL, avoiding the need to create an end_info structure. |
|
2188 |
|
2189 png_read_end(png_ptr, (png_infop)NULL); |
|
2190 |
|
2191 If you don't call png_read_end(), then your file pointer will be |
|
2192 left pointing to the first chunk after the last IDAT, which is probably |
|
2193 not what you want if you expect to read something beyond the end of |
|
2194 the PNG datastream. |
|
2195 |
|
2196 When you are done, you can free all memory allocated by libpng like this: |
|
2197 |
|
2198 png_destroy_read_struct(&png_ptr, &info_ptr, |
|
2199 &end_info); |
|
2200 |
|
2201 or, if you didn't create an end_info structure, |
|
2202 |
|
2203 png_destroy_read_struct(&png_ptr, &info_ptr, |
|
2204 (png_infopp)NULL); |
|
2205 |
|
2206 It is also possible to individually free the info_ptr members that |
|
2207 point to libpng-allocated storage with the following function: |
|
2208 |
|
2209 png_free_data(png_ptr, info_ptr, mask, seq) |
|
2210 |
|
2211 mask - identifies data to be freed, a mask |
|
2212 containing the bitwise OR of one or |
|
2213 more of |
|
2214 PNG_FREE_PLTE, PNG_FREE_TRNS, |
|
2215 PNG_FREE_HIST, PNG_FREE_ICCP, |
|
2216 PNG_FREE_PCAL, PNG_FREE_ROWS, |
|
2217 PNG_FREE_SCAL, PNG_FREE_SPLT, |
|
2218 PNG_FREE_TEXT, PNG_FREE_UNKN, |
|
2219 or simply PNG_FREE_ALL |
|
2220 |
|
2221 seq - sequence number of item to be freed |
|
2222 (-1 for all items) |
|
2223 |
|
2224 This function may be safely called when the relevant storage has |
|
2225 already been freed, or has not yet been allocated, or was allocated |
|
2226 by the user and not by libpng, and will in those cases do nothing. |
|
2227 The "seq" parameter is ignored if only one item of the selected data |
|
2228 type, such as PLTE, is allowed. If "seq" is not -1, and multiple items |
|
2229 are allowed for the data type identified in the mask, such as text or |
|
2230 sPLT, only the n'th item in the structure is freed, where n is "seq". |
|
2231 |
|
2232 The default behavior is only to free data that was allocated internally |
|
2233 by libpng. This can be changed, so that libpng will not free the data, |
|
2234 or so that it will free data that was allocated by the user with png_malloc() |
|
2235 or png_calloc() and passed in via a png_set_*() function, with |
|
2236 |
|
2237 png_data_freer(png_ptr, info_ptr, freer, mask) |
|
2238 |
|
2239 freer - one of |
|
2240 PNG_DESTROY_WILL_FREE_DATA |
|
2241 PNG_SET_WILL_FREE_DATA |
|
2242 PNG_USER_WILL_FREE_DATA |
|
2243 |
|
2244 mask - which data elements are affected |
|
2245 same choices as in png_free_data() |
|
2246 |
|
2247 This function only affects data that has already been allocated. |
|
2248 You can call this function after reading the PNG data but before calling |
|
2249 any png_set_*() functions, to control whether the user or the png_set_*() |
|
2250 function is responsible for freeing any existing data that might be present, |
|
2251 and again after the png_set_*() functions to control whether the user |
|
2252 or png_destroy_*() is supposed to free the data. When the user assumes |
|
2253 responsibility for libpng-allocated data, the application must use |
|
2254 png_free() to free it, and when the user transfers responsibility to libpng |
|
2255 for data that the user has allocated, the user must have used png_malloc() |
|
2256 or png_calloc() to allocate it. |
|
2257 |
|
2258 If you allocated your row_pointers in a single block, as suggested above in |
|
2259 the description of the high level read interface, you must not transfer |
|
2260 responsibility for freeing it to the png_set_rows or png_read_destroy function, |
|
2261 because they would also try to free the individual row_pointers[i]. |
|
2262 |
|
2263 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword |
|
2264 separately, do not transfer responsibility for freeing text_ptr to libpng, |
|
2265 because when libpng fills a png_text structure it combines these members with |
|
2266 the key member, and png_free_data() will free only text_ptr.key. Similarly, |
|
2267 if you transfer responsibility for free'ing text_ptr from libpng to your |
|
2268 application, your application must not separately free those members. |
|
2269 |
|
2270 The png_free_data() function will turn off the "valid" flag for anything |
|
2271 it frees. If you need to turn the flag off for a chunk that was freed by |
|
2272 your application instead of by libpng, you can use |
|
2273 |
|
2274 png_set_invalid(png_ptr, info_ptr, mask); |
|
2275 |
|
2276 mask - identifies the chunks to be made invalid, |
|
2277 containing the bitwise OR of one or |
|
2278 more of |
|
2279 PNG_INFO_gAMA, PNG_INFO_sBIT, |
|
2280 PNG_INFO_cHRM, PNG_INFO_PLTE, |
|
2281 PNG_INFO_tRNS, PNG_INFO_bKGD, |
|
2282 PNG_INFO_hIST, PNG_INFO_pHYs, |
|
2283 PNG_INFO_oFFs, PNG_INFO_tIME, |
|
2284 PNG_INFO_pCAL, PNG_INFO_sRGB, |
|
2285 PNG_INFO_iCCP, PNG_INFO_sPLT, |
|
2286 PNG_INFO_sCAL, PNG_INFO_IDAT |
|
2287 |
|
2288 For a more compact example of reading a PNG image, see the file example.c. |
|
2289 |
|
2290 Reading PNG files progressively |
|
2291 |
|
2292 The progressive reader is slightly different from the non-progressive |
|
2293 reader. Instead of calling png_read_info(), png_read_rows(), and |
|
2294 png_read_end(), you make one call to png_process_data(), which calls |
|
2295 callbacks when it has the info, a row, or the end of the image. You |
|
2296 set up these callbacks with png_set_progressive_read_fn(). You don't |
|
2297 have to worry about the input/output functions of libpng, as you are |
|
2298 giving the library the data directly in png_process_data(). I will |
|
2299 assume that you have read the section on reading PNG files above, |
|
2300 so I will only highlight the differences (although I will show |
|
2301 all of the code). |
|
2302 |
|
2303 png_structp png_ptr; |
|
2304 png_infop info_ptr; |
|
2305 |
|
2306 /* An example code fragment of how you would |
|
2307 initialize the progressive reader in your |
|
2308 application. */ |
|
2309 int |
|
2310 initialize_png_reader() |
|
2311 { |
|
2312 png_ptr = png_create_read_struct |
|
2313 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr, |
|
2314 user_error_fn, user_warning_fn); |
|
2315 |
|
2316 if (!png_ptr) |
|
2317 return (ERROR); |
|
2318 |
|
2319 info_ptr = png_create_info_struct(png_ptr); |
|
2320 |
|
2321 if (!info_ptr) |
|
2322 { |
|
2323 png_destroy_read_struct(&png_ptr, |
|
2324 (png_infopp)NULL, (png_infopp)NULL); |
|
2325 return (ERROR); |
|
2326 } |
|
2327 |
|
2328 if (setjmp(png_jmpbuf(png_ptr))) |
|
2329 { |
|
2330 png_destroy_read_struct(&png_ptr, &info_ptr, |
|
2331 (png_infopp)NULL); |
|
2332 return (ERROR); |
|
2333 } |
|
2334 |
|
2335 /* This one's new. You can provide functions |
|
2336 to be called when the header info is valid, |
|
2337 when each row is completed, and when the image |
|
2338 is finished. If you aren't using all functions, |
|
2339 you can specify NULL parameters. Even when all |
|
2340 three functions are NULL, you need to call |
|
2341 png_set_progressive_read_fn(). You can use |
|
2342 any struct as the user_ptr (cast to a void pointer |
|
2343 for the function call), and retrieve the pointer |
|
2344 from inside the callbacks using the function |
|
2345 |
|
2346 png_get_progressive_ptr(png_ptr); |
|
2347 |
|
2348 which will return a void pointer, which you have |
|
2349 to cast appropriately. |
|
2350 */ |
|
2351 png_set_progressive_read_fn(png_ptr, (void *)user_ptr, |
|
2352 info_callback, row_callback, end_callback); |
|
2353 |
|
2354 return 0; |
|
2355 } |
|
2356 |
|
2357 /* A code fragment that you call as you receive blocks |
|
2358 of data */ |
|
2359 int |
|
2360 process_data(png_bytep buffer, png_uint_32 length) |
|
2361 { |
|
2362 if (setjmp(png_jmpbuf(png_ptr))) |
|
2363 { |
|
2364 png_destroy_read_struct(&png_ptr, &info_ptr, |
|
2365 (png_infopp)NULL); |
|
2366 return (ERROR); |
|
2367 } |
|
2368 |
|
2369 /* This one's new also. Simply give it a chunk |
|
2370 of data from the file stream (in order, of |
|
2371 course). On machines with segmented memory |
|
2372 models machines, don't give it any more than |
|
2373 64K. The library seems to run fine with sizes |
|
2374 of 4K. Although you can give it much less if |
|
2375 necessary (I assume you can give it chunks of |
|
2376 1 byte, I haven't tried less then 256 bytes |
|
2377 yet). When this function returns, you may |
|
2378 want to display any rows that were generated |
|
2379 in the row callback if you don't already do |
|
2380 so there. |
|
2381 */ |
|
2382 png_process_data(png_ptr, info_ptr, buffer, length); |
|
2383 |
|
2384 /* At this point you can call png_process_data_skip if |
|
2385 you want to handle data the library will skip yourself; |
|
2386 it simply returns the number of bytes to skip (and stops |
|
2387 libpng skipping that number of bytes on the next |
|
2388 png_process_data call). |
|
2389 return 0; |
|
2390 } |
|
2391 |
|
2392 /* This function is called (as set by |
|
2393 png_set_progressive_read_fn() above) when enough data |
|
2394 has been supplied so all of the header has been |
|
2395 read. |
|
2396 */ |
|
2397 void |
|
2398 info_callback(png_structp png_ptr, png_infop info) |
|
2399 { |
|
2400 /* Do any setup here, including setting any of |
|
2401 the transformations mentioned in the Reading |
|
2402 PNG files section. For now, you _must_ call |
|
2403 either png_start_read_image() or |
|
2404 png_read_update_info() after all the |
|
2405 transformations are set (even if you don't set |
|
2406 any). You may start getting rows before |
|
2407 png_process_data() returns, so this is your |
|
2408 last chance to prepare for that. |
|
2409 |
|
2410 This is where you turn on interlace handling, |
|
2411 assuming you don't want to do it yourself. |
|
2412 |
|
2413 If you need to you can stop the processing of |
|
2414 your original input data at this point by calling |
|
2415 png_process_data_pause. This returns the number |
|
2416 of unprocessed bytes from the last png_process_data |
|
2417 call - it is up to you to ensure that the next call |
|
2418 sees these bytes again. If you don't want to bother |
|
2419 with this you can get libpng to cache the unread |
|
2420 bytes by setting the 'save' parameter (see png.h) but |
|
2421 then libpng will have to copy the data internally. |
|
2422 */ |
|
2423 } |
|
2424 |
|
2425 /* This function is called when each row of image |
|
2426 data is complete */ |
|
2427 void |
|
2428 row_callback(png_structp png_ptr, png_bytep new_row, |
|
2429 png_uint_32 row_num, int pass) |
|
2430 { |
|
2431 /* If the image is interlaced, and you turned |
|
2432 on the interlace handler, this function will |
|
2433 be called for every row in every pass. Some |
|
2434 of these rows will not be changed from the |
|
2435 previous pass. When the row is not changed, |
|
2436 the new_row variable will be NULL. The rows |
|
2437 and passes are called in order, so you don't |
|
2438 really need the row_num and pass, but I'm |
|
2439 supplying them because it may make your life |
|
2440 easier. |
|
2441 |
|
2442 If you did not turn on interlace handling then |
|
2443 the callback is called for each row of each |
|
2444 sub-image when the image is interlaced. In this |
|
2445 case 'row_num' is the row in the sub-image, not |
|
2446 the row in the output image as it is in all other |
|
2447 cases. |
|
2448 |
|
2449 For the non-NULL rows of interlaced images when |
|
2450 you have switched on libpng interlace handling, |
|
2451 you must call png_progressive_combine_row() |
|
2452 passing in the row and the old row. You can |
|
2453 call this function for NULL rows (it will just |
|
2454 return) and for non-interlaced images (it just |
|
2455 does the memcpy for you) if it will make the |
|
2456 code easier. Thus, you can just do this for |
|
2457 all cases if you switch on interlace handling; |
|
2458 */ |
|
2459 |
|
2460 png_progressive_combine_row(png_ptr, old_row, |
|
2461 new_row); |
|
2462 |
|
2463 /* where old_row is what was displayed for |
|
2464 previously for the row. Note that the first |
|
2465 pass (pass == 0, really) will completely cover |
|
2466 the old row, so the rows do not have to be |
|
2467 initialized. After the first pass (and only |
|
2468 for interlaced images), you will have to pass |
|
2469 the current row, and the function will combine |
|
2470 the old row and the new row. |
|
2471 |
|
2472 You can also call png_process_data_pause in this |
|
2473 callback - see above. |
|
2474 */ |
|
2475 } |
|
2476 |
|
2477 void |
|
2478 end_callback(png_structp png_ptr, png_infop info) |
|
2479 { |
|
2480 /* This function is called after the whole image |
|
2481 has been read, including any chunks after the |
|
2482 image (up to and including the IEND). You |
|
2483 will usually have the same info chunk as you |
|
2484 had in the header, although some data may have |
|
2485 been added to the comments and time fields. |
|
2486 |
|
2487 Most people won't do much here, perhaps setting |
|
2488 a flag that marks the image as finished. |
|
2489 */ |
|
2490 } |
|
2491 |
|
2492 |
|
2493 |
|
2494 IV. Writing |
|
2495 |
|
2496 Much of this is very similar to reading. However, everything of |
|
2497 importance is repeated here, so you won't have to constantly look |
|
2498 back up in the reading section to understand writing. |
|
2499 |
|
2500 Setup |
|
2501 |
|
2502 You will want to do the I/O initialization before you get into libpng, |
|
2503 so if it doesn't work, you don't have anything to undo. If you are not |
|
2504 using the standard I/O functions, you will need to replace them with |
|
2505 custom writing functions. See the discussion under Customizing libpng. |
|
2506 |
|
2507 FILE *fp = fopen(file_name, "wb"); |
|
2508 |
|
2509 if (!fp) |
|
2510 return (ERROR); |
|
2511 |
|
2512 Next, png_struct and png_info need to be allocated and initialized. |
|
2513 As these can be both relatively large, you may not want to store these |
|
2514 on the stack, unless you have stack space to spare. Of course, you |
|
2515 will want to check if they return NULL. If you are also reading, |
|
2516 you won't want to name your read structure and your write structure |
|
2517 both "png_ptr"; you can call them anything you like, such as |
|
2518 "read_ptr" and "write_ptr". Look at pngtest.c, for example. |
|
2519 |
|
2520 png_structp png_ptr = png_create_write_struct |
|
2521 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr, |
|
2522 user_error_fn, user_warning_fn); |
|
2523 |
|
2524 if (!png_ptr) |
|
2525 return (ERROR); |
|
2526 |
|
2527 png_infop info_ptr = png_create_info_struct(png_ptr); |
|
2528 if (!info_ptr) |
|
2529 { |
|
2530 png_destroy_write_struct(&png_ptr, |
|
2531 (png_infopp)NULL); |
|
2532 return (ERROR); |
|
2533 } |
|
2534 |
|
2535 If you want to use your own memory allocation routines, |
|
2536 define PNG_USER_MEM_SUPPORTED and use |
|
2537 png_create_write_struct_2() instead of png_create_write_struct(): |
|
2538 |
|
2539 png_structp png_ptr = png_create_write_struct_2 |
|
2540 (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr, |
|
2541 user_error_fn, user_warning_fn, (png_voidp) |
|
2542 user_mem_ptr, user_malloc_fn, user_free_fn); |
|
2543 |
|
2544 After you have these structures, you will need to set up the |
|
2545 error handling. When libpng encounters an error, it expects to |
|
2546 longjmp() back to your routine. Therefore, you will need to call |
|
2547 setjmp() and pass the png_jmpbuf(png_ptr). If you |
|
2548 write the file from different routines, you will need to update |
|
2549 the png_jmpbuf(png_ptr) every time you enter a new routine that will |
|
2550 call a png_*() function. See your documentation of setjmp/longjmp |
|
2551 for your compiler for more information on setjmp/longjmp. See |
|
2552 the discussion on libpng error handling in the Customizing Libpng |
|
2553 section below for more information on the libpng error handling. |
|
2554 |
|
2555 if (setjmp(png_jmpbuf(png_ptr))) |
|
2556 { |
|
2557 png_destroy_write_struct(&png_ptr, &info_ptr); |
|
2558 fclose(fp); |
|
2559 return (ERROR); |
|
2560 } |
|
2561 ... |
|
2562 return; |
|
2563 |
|
2564 If you would rather avoid the complexity of setjmp/longjmp issues, |
|
2565 you can compile libpng with PNG_NO_SETJMP, in which case |
|
2566 errors will result in a call to PNG_ABORT() which defaults to abort(). |
|
2567 |
|
2568 You can #define PNG_ABORT() to a function that does something |
|
2569 more useful than abort(), as long as your function does not |
|
2570 return. |
|
2571 |
|
2572 Checking for invalid palette index on write was added at libpng |
|
2573 1.5.10. If a pixel contains an invalid (out-of-range) index libpng issues |
|
2574 a benign error. This is enabled by default because this condition is an |
|
2575 error according to the PNG specification, Clause 11.3.2, but the error can |
|
2576 be ignored in each png_ptr with |
|
2577 |
|
2578 png_set_check_for_invalid_index(png_ptr, 0); |
|
2579 |
|
2580 If the error is ignored, or if png_benign_error() treats it as a warning, |
|
2581 any invalid pixels are written as-is by the encoder, resulting in an |
|
2582 invalid PNG datastream as output. In this case the application is |
|
2583 responsible for ensuring that the pixel indexes are in range when it writes |
|
2584 a PLTE chunk with fewer entries than the bit depth would allow. |
|
2585 |
|
2586 Now you need to set up the output code. The default for libpng is to |
|
2587 use the C function fwrite(). If you use this, you will need to pass a |
|
2588 valid FILE * in the function png_init_io(). Be sure that the file is |
|
2589 opened in binary mode. Again, if you wish to handle writing data in |
|
2590 another way, see the discussion on libpng I/O handling in the Customizing |
|
2591 Libpng section below. |
|
2592 |
|
2593 png_init_io(png_ptr, fp); |
|
2594 |
|
2595 If you are embedding your PNG into a datastream such as MNG, and don't |
|
2596 want libpng to write the 8-byte signature, or if you have already |
|
2597 written the signature in your application, use |
|
2598 |
|
2599 png_set_sig_bytes(png_ptr, 8); |
|
2600 |
|
2601 to inform libpng that it should not write a signature. |
|
2602 |
|
2603 Write callbacks |
|
2604 |
|
2605 At this point, you can set up a callback function that will be |
|
2606 called after each row has been written, which you can use to control |
|
2607 a progress meter or the like. It's demonstrated in pngtest.c. |
|
2608 You must supply a function |
|
2609 |
|
2610 void write_row_callback(png_structp png_ptr, png_uint_32 row, |
|
2611 int pass); |
|
2612 { |
|
2613 /* put your code here */ |
|
2614 } |
|
2615 |
|
2616 (You can give it another name that you like instead of "write_row_callback") |
|
2617 |
|
2618 To inform libpng about your function, use |
|
2619 |
|
2620 png_set_write_status_fn(png_ptr, write_row_callback); |
|
2621 |
|
2622 When this function is called the row has already been completely processed and |
|
2623 it has also been written out. The 'row' and 'pass' refer to the next row to be |
|
2624 handled. For the |
|
2625 non-interlaced case the row that was just handled is simply one less than the |
|
2626 passed in row number, and pass will always be 0. For the interlaced case the |
|
2627 same applies unless the row value is 0, in which case the row just handled was |
|
2628 the last one from one of the preceding passes. Because interlacing may skip a |
|
2629 pass you cannot be sure that the preceding pass is just 'pass-1', if you really |
|
2630 need to know what the last pass is record (row,pass) from the callback and use |
|
2631 the last recorded value each time. |
|
2632 |
|
2633 As with the user transform you can find the output row using the |
|
2634 PNG_ROW_FROM_PASS_ROW macro. |
|
2635 |
|
2636 You now have the option of modifying how the compression library will |
|
2637 run. The following functions are mainly for testing, but may be useful |
|
2638 in some cases, like if you need to write PNG files extremely fast and |
|
2639 are willing to give up some compression, or if you want to get the |
|
2640 maximum possible compression at the expense of slower writing. If you |
|
2641 have no special needs in this area, let the library do what it wants by |
|
2642 not calling this function at all, as it has been tuned to deliver a good |
|
2643 speed/compression ratio. The second parameter to png_set_filter() is |
|
2644 the filter method, for which the only valid values are 0 (as of the |
|
2645 July 1999 PNG specification, version 1.2) or 64 (if you are writing |
|
2646 a PNG datastream that is to be embedded in a MNG datastream). The third |
|
2647 parameter is a flag that indicates which filter type(s) are to be tested |
|
2648 for each scanline. See the PNG specification for details on the specific |
|
2649 filter types. |
|
2650 |
|
2651 |
|
2652 /* turn on or off filtering, and/or choose |
|
2653 specific filters. You can use either a single |
|
2654 PNG_FILTER_VALUE_NAME or the bitwise OR of one |
|
2655 or more PNG_FILTER_NAME masks. |
|
2656 */ |
|
2657 png_set_filter(png_ptr, 0, |
|
2658 PNG_FILTER_NONE | PNG_FILTER_VALUE_NONE | |
|
2659 PNG_FILTER_SUB | PNG_FILTER_VALUE_SUB | |
|
2660 PNG_FILTER_UP | PNG_FILTER_VALUE_UP | |
|
2661 PNG_FILTER_AVG | PNG_FILTER_VALUE_AVG | |
|
2662 PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH| |
|
2663 PNG_ALL_FILTERS); |
|
2664 |
|
2665 If an application wants to start and stop using particular filters during |
|
2666 compression, it should start out with all of the filters (to ensure that |
|
2667 the previous row of pixels will be stored in case it's needed later), |
|
2668 and then add and remove them after the start of compression. |
|
2669 |
|
2670 If you are writing a PNG datastream that is to be embedded in a MNG |
|
2671 datastream, the second parameter can be either 0 or 64. |
|
2672 |
|
2673 The png_set_compression_*() functions interface to the zlib compression |
|
2674 library, and should mostly be ignored unless you really know what you are |
|
2675 doing. The only generally useful call is png_set_compression_level() |
|
2676 which changes how much time zlib spends on trying to compress the image |
|
2677 data. See the Compression Library (zlib.h and algorithm.txt, distributed |
|
2678 with zlib) for details on the compression levels. |
|
2679 |
|
2680 #include zlib.h |
|
2681 |
|
2682 /* Set the zlib compression level */ |
|
2683 png_set_compression_level(png_ptr, |
|
2684 Z_BEST_COMPRESSION); |
|
2685 |
|
2686 /* Set other zlib parameters for compressing IDAT */ |
|
2687 png_set_compression_mem_level(png_ptr, 8); |
|
2688 png_set_compression_strategy(png_ptr, |
|
2689 Z_DEFAULT_STRATEGY); |
|
2690 png_set_compression_window_bits(png_ptr, 15); |
|
2691 png_set_compression_method(png_ptr, 8); |
|
2692 png_set_compression_buffer_size(png_ptr, 8192) |
|
2693 |
|
2694 /* Set zlib parameters for text compression |
|
2695 * If you don't call these, the parameters |
|
2696 * fall back on those defined for IDAT chunks |
|
2697 */ |
|
2698 png_set_text_compression_mem_level(png_ptr, 8); |
|
2699 png_set_text_compression_strategy(png_ptr, |
|
2700 Z_DEFAULT_STRATEGY); |
|
2701 png_set_text_compression_window_bits(png_ptr, 15); |
|
2702 png_set_text_compression_method(png_ptr, 8); |
|
2703 |
|
2704 Setting the contents of info for output |
|
2705 |
|
2706 You now need to fill in the png_info structure with all the data you |
|
2707 wish to write before the actual image. Note that the only thing you |
|
2708 are allowed to write after the image is the text chunks and the time |
|
2709 chunk (as of PNG Specification 1.2, anyway). See png_write_end() and |
|
2710 the latest PNG specification for more information on that. If you |
|
2711 wish to write them before the image, fill them in now, and flag that |
|
2712 data as being valid. If you want to wait until after the data, don't |
|
2713 fill them until png_write_end(). For all the fields in png_info and |
|
2714 their data types, see png.h. For explanations of what the fields |
|
2715 contain, see the PNG specification. |
|
2716 |
|
2717 Some of the more important parts of the png_info are: |
|
2718 |
|
2719 png_set_IHDR(png_ptr, info_ptr, width, height, |
|
2720 bit_depth, color_type, interlace_type, |
|
2721 compression_type, filter_method) |
|
2722 |
|
2723 width - holds the width of the image |
|
2724 in pixels (up to 2^31). |
|
2725 |
|
2726 height - holds the height of the image |
|
2727 in pixels (up to 2^31). |
|
2728 |
|
2729 bit_depth - holds the bit depth of one of the |
|
2730 image channels. |
|
2731 (valid values are 1, 2, 4, 8, 16 |
|
2732 and depend also on the |
|
2733 color_type. See also significant |
|
2734 bits (sBIT) below). |
|
2735 |
|
2736 color_type - describes which color/alpha |
|
2737 channels are present. |
|
2738 PNG_COLOR_TYPE_GRAY |
|
2739 (bit depths 1, 2, 4, 8, 16) |
|
2740 PNG_COLOR_TYPE_GRAY_ALPHA |
|
2741 (bit depths 8, 16) |
|
2742 PNG_COLOR_TYPE_PALETTE |
|
2743 (bit depths 1, 2, 4, 8) |
|
2744 PNG_COLOR_TYPE_RGB |
|
2745 (bit_depths 8, 16) |
|
2746 PNG_COLOR_TYPE_RGB_ALPHA |
|
2747 (bit_depths 8, 16) |
|
2748 |
|
2749 PNG_COLOR_MASK_PALETTE |
|
2750 PNG_COLOR_MASK_COLOR |
|
2751 PNG_COLOR_MASK_ALPHA |
|
2752 |
|
2753 interlace_type - PNG_INTERLACE_NONE or |
|
2754 PNG_INTERLACE_ADAM7 |
|
2755 |
|
2756 compression_type - (must be |
|
2757 PNG_COMPRESSION_TYPE_DEFAULT) |
|
2758 |
|
2759 filter_method - (must be PNG_FILTER_TYPE_DEFAULT |
|
2760 or, if you are writing a PNG to |
|
2761 be embedded in a MNG datastream, |
|
2762 can also be |
|
2763 PNG_INTRAPIXEL_DIFFERENCING) |
|
2764 |
|
2765 If you call png_set_IHDR(), the call must appear before any of the |
|
2766 other png_set_*() functions, because they might require access to some of |
|
2767 the IHDR settings. The remaining png_set_*() functions can be called |
|
2768 in any order. |
|
2769 |
|
2770 If you wish, you can reset the compression_type, interlace_type, or |
|
2771 filter_method later by calling png_set_IHDR() again; if you do this, the |
|
2772 width, height, bit_depth, and color_type must be the same in each call. |
|
2773 |
|
2774 png_set_PLTE(png_ptr, info_ptr, palette, |
|
2775 num_palette); |
|
2776 |
|
2777 palette - the palette for the file |
|
2778 (array of png_color) |
|
2779 num_palette - number of entries in the palette |
|
2780 |
|
2781 png_set_gAMA(png_ptr, info_ptr, file_gamma); |
|
2782 png_set_gAMA_fixed(png_ptr, info_ptr, int_file_gamma); |
|
2783 |
|
2784 file_gamma - the gamma at which the image was |
|
2785 created (PNG_INFO_gAMA) |
|
2786 |
|
2787 int_file_gamma - 100,000 times the gamma at which |
|
2788 the image was created |
|
2789 |
|
2790 png_set_cHRM(png_ptr, info_ptr, white_x, white_y, red_x, red_y, |
|
2791 green_x, green_y, blue_x, blue_y) |
|
2792 png_set_cHRM_XYZ(png_ptr, info_ptr, red_X, red_Y, red_Z, green_X, |
|
2793 green_Y, green_Z, blue_X, blue_Y, blue_Z) |
|
2794 png_set_cHRM_fixed(png_ptr, info_ptr, int_white_x, int_white_y, |
|
2795 int_red_x, int_red_y, int_green_x, int_green_y, |
|
2796 int_blue_x, int_blue_y) |
|
2797 png_set_cHRM_XYZ_fixed(png_ptr, info_ptr, int_red_X, int_red_Y, |
|
2798 int_red_Z, int_green_X, int_green_Y, int_green_Z, |
|
2799 int_blue_X, int_blue_Y, int_blue_Z) |
|
2800 |
|
2801 {white,red,green,blue}_{x,y} |
|
2802 A color space encoding specified using the chromaticities |
|
2803 of the end points and the white point. |
|
2804 |
|
2805 {red,green,blue}_{X,Y,Z} |
|
2806 A color space encoding specified using the encoding end |
|
2807 points - the CIE tristimulus specification of the intended |
|
2808 color of the red, green and blue channels in the PNG RGB |
|
2809 data. The white point is simply the sum of the three end |
|
2810 points. |
|
2811 |
|
2812 png_set_sRGB(png_ptr, info_ptr, srgb_intent); |
|
2813 |
|
2814 srgb_intent - the rendering intent |
|
2815 (PNG_INFO_sRGB) The presence of |
|
2816 the sRGB chunk means that the pixel |
|
2817 data is in the sRGB color space. |
|
2818 This chunk also implies specific |
|
2819 values of gAMA and cHRM. Rendering |
|
2820 intent is the CSS-1 property that |
|
2821 has been defined by the International |
|
2822 Color Consortium |
|
2823 (http://www.color.org). |
|
2824 It can be one of |
|
2825 PNG_sRGB_INTENT_SATURATION, |
|
2826 PNG_sRGB_INTENT_PERCEPTUAL, |
|
2827 PNG_sRGB_INTENT_ABSOLUTE, or |
|
2828 PNG_sRGB_INTENT_RELATIVE. |
|
2829 |
|
2830 |
|
2831 png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr, |
|
2832 srgb_intent); |
|
2833 |
|
2834 srgb_intent - the rendering intent |
|
2835 (PNG_INFO_sRGB) The presence of the |
|
2836 sRGB chunk means that the pixel |
|
2837 data is in the sRGB color space. |
|
2838 This function also causes gAMA and |
|
2839 cHRM chunks with the specific values |
|
2840 that are consistent with sRGB to be |
|
2841 written. |
|
2842 |
|
2843 png_set_iCCP(png_ptr, info_ptr, name, compression_type, |
|
2844 profile, proflen); |
|
2845 |
|
2846 name - The profile name. |
|
2847 |
|
2848 compression_type - The compression type; always |
|
2849 PNG_COMPRESSION_TYPE_BASE for PNG 1.0. |
|
2850 You may give NULL to this argument to |
|
2851 ignore it. |
|
2852 |
|
2853 profile - International Color Consortium color |
|
2854 profile data. May contain NULs. |
|
2855 |
|
2856 proflen - length of profile data in bytes. |
|
2857 |
|
2858 png_set_sBIT(png_ptr, info_ptr, sig_bit); |
|
2859 |
|
2860 sig_bit - the number of significant bits for |
|
2861 (PNG_INFO_sBIT) each of the gray, red, |
|
2862 green, and blue channels, whichever are |
|
2863 appropriate for the given color type |
|
2864 (png_color_16) |
|
2865 |
|
2866 png_set_tRNS(png_ptr, info_ptr, trans_alpha, |
|
2867 num_trans, trans_color); |
|
2868 |
|
2869 trans_alpha - array of alpha (transparency) |
|
2870 entries for palette (PNG_INFO_tRNS) |
|
2871 |
|
2872 num_trans - number of transparent entries |
|
2873 (PNG_INFO_tRNS) |
|
2874 |
|
2875 trans_color - graylevel or color sample values |
|
2876 (in order red, green, blue) of the |
|
2877 single transparent color for |
|
2878 non-paletted images (PNG_INFO_tRNS) |
|
2879 |
|
2880 png_set_hIST(png_ptr, info_ptr, hist); |
|
2881 |
|
2882 hist - histogram of palette (array of |
|
2883 png_uint_16) (PNG_INFO_hIST) |
|
2884 |
|
2885 png_set_tIME(png_ptr, info_ptr, mod_time); |
|
2886 |
|
2887 mod_time - time image was last modified |
|
2888 (PNG_VALID_tIME) |
|
2889 |
|
2890 png_set_bKGD(png_ptr, info_ptr, background); |
|
2891 |
|
2892 background - background color (of type |
|
2893 png_color_16p) (PNG_VALID_bKGD) |
|
2894 |
|
2895 png_set_text(png_ptr, info_ptr, text_ptr, num_text); |
|
2896 |
|
2897 text_ptr - array of png_text holding image |
|
2898 comments |
|
2899 |
|
2900 text_ptr[i].compression - type of compression used |
|
2901 on "text" PNG_TEXT_COMPRESSION_NONE |
|
2902 PNG_TEXT_COMPRESSION_zTXt |
|
2903 PNG_ITXT_COMPRESSION_NONE |
|
2904 PNG_ITXT_COMPRESSION_zTXt |
|
2905 text_ptr[i].key - keyword for comment. Must contain |
|
2906 1-79 characters. |
|
2907 text_ptr[i].text - text comments for current |
|
2908 keyword. Can be NULL or empty. |
|
2909 text_ptr[i].text_length - length of text string, |
|
2910 after decompression, 0 for iTXt |
|
2911 text_ptr[i].itxt_length - length of itxt string, |
|
2912 after decompression, 0 for tEXt/zTXt |
|
2913 text_ptr[i].lang - language of comment (NULL or |
|
2914 empty for unknown). |
|
2915 text_ptr[i].translated_keyword - keyword in UTF-8 (NULL |
|
2916 or empty for unknown). |
|
2917 |
|
2918 Note that the itxt_length, lang, and lang_key |
|
2919 members of the text_ptr structure only exist when the |
|
2920 library is built with iTXt chunk support. Prior to |
|
2921 libpng-1.4.0 the library was built by default without |
|
2922 iTXt support. Also note that when iTXt is supported, |
|
2923 they contain NULL pointers when the "compression" |
|
2924 field contains PNG_TEXT_COMPRESSION_NONE or |
|
2925 PNG_TEXT_COMPRESSION_zTXt. |
|
2926 |
|
2927 num_text - number of comments |
|
2928 |
|
2929 png_set_sPLT(png_ptr, info_ptr, &palette_ptr, |
|
2930 num_spalettes); |
|
2931 |
|
2932 palette_ptr - array of png_sPLT_struct structures |
|
2933 to be added to the list of palettes |
|
2934 in the info structure. |
|
2935 num_spalettes - number of palette structures to be |
|
2936 added. |
|
2937 |
|
2938 png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y, |
|
2939 unit_type); |
|
2940 |
|
2941 offset_x - positive offset from the left |
|
2942 edge of the screen |
|
2943 |
|
2944 offset_y - positive offset from the top |
|
2945 edge of the screen |
|
2946 |
|
2947 unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER |
|
2948 |
|
2949 png_set_pHYs(png_ptr, info_ptr, res_x, res_y, |
|
2950 unit_type); |
|
2951 |
|
2952 res_x - pixels/unit physical resolution |
|
2953 in x direction |
|
2954 |
|
2955 res_y - pixels/unit physical resolution |
|
2956 in y direction |
|
2957 |
|
2958 unit_type - PNG_RESOLUTION_UNKNOWN, |
|
2959 PNG_RESOLUTION_METER |
|
2960 |
|
2961 png_set_sCAL(png_ptr, info_ptr, unit, width, height) |
|
2962 |
|
2963 unit - physical scale units (an integer) |
|
2964 |
|
2965 width - width of a pixel in physical scale units |
|
2966 |
|
2967 height - height of a pixel in physical scale units |
|
2968 (width and height are doubles) |
|
2969 |
|
2970 png_set_sCAL_s(png_ptr, info_ptr, unit, width, height) |
|
2971 |
|
2972 unit - physical scale units (an integer) |
|
2973 |
|
2974 width - width of a pixel in physical scale units |
|
2975 expressed as a string |
|
2976 |
|
2977 height - height of a pixel in physical scale units |
|
2978 (width and height are strings like "2.54") |
|
2979 |
|
2980 png_set_unknown_chunks(png_ptr, info_ptr, &unknowns, |
|
2981 num_unknowns) |
|
2982 |
|
2983 unknowns - array of png_unknown_chunk |
|
2984 structures holding unknown chunks |
|
2985 unknowns[i].name - name of unknown chunk |
|
2986 unknowns[i].data - data of unknown chunk |
|
2987 unknowns[i].size - size of unknown chunk's data |
|
2988 unknowns[i].location - position to write chunk in file |
|
2989 0: do not write chunk |
|
2990 PNG_HAVE_IHDR: before PLTE |
|
2991 PNG_HAVE_PLTE: before IDAT |
|
2992 PNG_AFTER_IDAT: after IDAT |
|
2993 |
|
2994 The "location" member is set automatically according to |
|
2995 what part of the output file has already been written. |
|
2996 You can change its value after calling png_set_unknown_chunks() |
|
2997 as demonstrated in pngtest.c. Within each of the "locations", |
|
2998 the chunks are sequenced according to their position in the |
|
2999 structure (that is, the value of "i", which is the order in which |
|
3000 the chunk was either read from the input file or defined with |
|
3001 png_set_unknown_chunks). |
|
3002 |
|
3003 A quick word about text and num_text. text is an array of png_text |
|
3004 structures. num_text is the number of valid structures in the array. |
|
3005 Each png_text structure holds a language code, a keyword, a text value, |
|
3006 and a compression type. |
|
3007 |
|
3008 The compression types have the same valid numbers as the compression |
|
3009 types of the image data. Currently, the only valid number is zero. |
|
3010 However, you can store text either compressed or uncompressed, unlike |
|
3011 images, which always have to be compressed. So if you don't want the |
|
3012 text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE. |
|
3013 Because tEXt and zTXt chunks don't have a language field, if you |
|
3014 specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt |
|
3015 any language code or translated keyword will not be written out. |
|
3016 |
|
3017 Until text gets around a few hundred bytes, it is not worth compressing it. |
|
3018 After the text has been written out to the file, the compression type |
|
3019 is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR, |
|
3020 so that it isn't written out again at the end (in case you are calling |
|
3021 png_write_end() with the same struct). |
|
3022 |
|
3023 The keywords that are given in the PNG Specification are: |
|
3024 |
|
3025 Title Short (one line) title or |
|
3026 caption for image |
|
3027 |
|
3028 Author Name of image's creator |
|
3029 |
|
3030 Description Description of image (possibly long) |
|
3031 |
|
3032 Copyright Copyright notice |
|
3033 |
|
3034 Creation Time Time of original image creation |
|
3035 (usually RFC 1123 format, see below) |
|
3036 |
|
3037 Software Software used to create the image |
|
3038 |
|
3039 Disclaimer Legal disclaimer |
|
3040 |
|
3041 Warning Warning of nature of content |
|
3042 |
|
3043 Source Device used to create the image |
|
3044 |
|
3045 Comment Miscellaneous comment; conversion |
|
3046 from other image format |
|
3047 |
|
3048 The keyword-text pairs work like this. Keywords should be short |
|
3049 simple descriptions of what the comment is about. Some typical |
|
3050 keywords are found in the PNG specification, as is some recommendations |
|
3051 on keywords. You can repeat keywords in a file. You can even write |
|
3052 some text before the image and some after. For example, you may want |
|
3053 to put a description of the image before the image, but leave the |
|
3054 disclaimer until after, so viewers working over modem connections |
|
3055 don't have to wait for the disclaimer to go over the modem before |
|
3056 they start seeing the image. Finally, keywords should be full |
|
3057 words, not abbreviations. Keywords and text are in the ISO 8859-1 |
|
3058 (Latin-1) character set (a superset of regular ASCII) and can not |
|
3059 contain NUL characters, and should not contain control or other |
|
3060 unprintable characters. To make the comments widely readable, stick |
|
3061 with basic ASCII, and avoid machine specific character set extensions |
|
3062 like the IBM-PC character set. The keyword must be present, but |
|
3063 you can leave off the text string on non-compressed pairs. |
|
3064 Compressed pairs must have a text string, as only the text string |
|
3065 is compressed anyway, so the compression would be meaningless. |
|
3066 |
|
3067 PNG supports modification time via the png_time structure. Two |
|
3068 conversion routines are provided, png_convert_from_time_t() for |
|
3069 time_t and png_convert_from_struct_tm() for struct tm. The |
|
3070 time_t routine uses gmtime(). You don't have to use either of |
|
3071 these, but if you wish to fill in the png_time structure directly, |
|
3072 you should provide the time in universal time (GMT) if possible |
|
3073 instead of your local time. Note that the year number is the full |
|
3074 year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and |
|
3075 that months start with 1. |
|
3076 |
|
3077 If you want to store the time of the original image creation, you should |
|
3078 use a plain tEXt chunk with the "Creation Time" keyword. This is |
|
3079 necessary because the "creation time" of a PNG image is somewhat vague, |
|
3080 depending on whether you mean the PNG file, the time the image was |
|
3081 created in a non-PNG format, a still photo from which the image was |
|
3082 scanned, or possibly the subject matter itself. In order to facilitate |
|
3083 machine-readable dates, it is recommended that the "Creation Time" |
|
3084 tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"), |
|
3085 although this isn't a requirement. Unlike the tIME chunk, the |
|
3086 "Creation Time" tEXt chunk is not expected to be automatically changed |
|
3087 by the software. To facilitate the use of RFC 1123 dates, a function |
|
3088 png_convert_to_rfc1123_buffer(png_ptr, buffer, png_timep) is provided to |
|
3089 convert from PNG time to an RFC 1123 format string. The caller must provide |
|
3090 a writeable buffer of at least 29 bytes. |
|
3091 |
|
3092 Writing unknown chunks |
|
3093 |
|
3094 You can use the png_set_unknown_chunks function to queue up private chunks |
|
3095 for writing. You give it a chunk name, location, raw data, and a size. You |
|
3096 also must use png_set_keep_unknown_chunks() to ensure that libpng will |
|
3097 handle them. That's all there is to it. The chunks will be written by the |
|
3098 next following png_write_info_before_PLTE, png_write_info, or png_write_end |
|
3099 function, depending upon the specified location. Any chunks previously |
|
3100 read into the info structure's unknown-chunk list will also be written out |
|
3101 in a sequence that satisfies the PNG specification's ordering rules. |
|
3102 |
|
3103 Here is an example of writing two private chunks, prVt and miNE: |
|
3104 |
|
3105 #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED |
|
3106 /* Set unknown chunk data */ |
|
3107 png_unknown_chunk unk_chunk[2]; |
|
3108 strcpy((char *) unk_chunk[0].name, "prVt"; |
|
3109 unk_chunk[0].data = (unsigned char *) "PRIVATE DATA"; |
|
3110 unk_chunk[0].size = strlen(unk_chunk[0].data)+1; |
|
3111 unk_chunk[0].location = PNG_HAVE_IHDR; |
|
3112 strcpy((char *) unk_chunk[1].name, "miNE"; |
|
3113 unk_chunk[1].data = (unsigned char *) "MY CHUNK DATA"; |
|
3114 unk_chunk[1].size = strlen(unk_chunk[0].data)+1; |
|
3115 unk_chunk[1].location = PNG_AFTER_IDAT; |
|
3116 png_set_unknown_chunks(write_ptr, write_info_ptr, |
|
3117 unk_chunk, 2); |
|
3118 /* Needed because miNE is not safe-to-copy */ |
|
3119 png_set_keep_unknown_chunks(png, PNG_HANDLE_CHUNK_ALWAYS, |
|
3120 (png_bytep) "miNE", 1); |
|
3121 # if PNG_LIBPNG_VER < 10600 |
|
3122 /* Deal with unknown chunk location bug in 1.5.x and earlier */ |
|
3123 png_set_unknown_chunk_location(png, info, 0, PNG_HAVE_IHDR); |
|
3124 png_set_unknown_chunk_location(png, info, 1, PNG_AFTER_IDAT); |
|
3125 # endif |
|
3126 # if PNG_LIBPNG_VER < 10500 |
|
3127 /* PNG_AFTER_IDAT writes two copies of the chunk prior to libpng-1.5.0, |
|
3128 * one before IDAT and another after IDAT, so don't use it; only use |
|
3129 * PNG_HAVE_IHDR location. This call resets the location previously |
|
3130 * set by assignment and png_set_unknown_chunk_location() for chunk 1. |
|
3131 */ |
|
3132 png_set_unknown_chunk_location(png, info, 1, PNG_HAVE_IHDR); |
|
3133 # endif |
|
3134 #endif |
|
3135 |
|
3136 The high-level write interface |
|
3137 |
|
3138 At this point there are two ways to proceed; through the high-level |
|
3139 write interface, or through a sequence of low-level write operations. |
|
3140 You can use the high-level interface if your image data is present |
|
3141 in the info structure. All defined output |
|
3142 transformations are permitted, enabled by the following masks. |
|
3143 |
|
3144 PNG_TRANSFORM_IDENTITY No transformation |
|
3145 PNG_TRANSFORM_PACKING Pack 1, 2 and 4-bit samples |
|
3146 PNG_TRANSFORM_PACKSWAP Change order of packed |
|
3147 pixels to LSB first |
|
3148 PNG_TRANSFORM_INVERT_MONO Invert monochrome images |
|
3149 PNG_TRANSFORM_SHIFT Normalize pixels to the |
|
3150 sBIT depth |
|
3151 PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA |
|
3152 to BGRA |
|
3153 PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA |
|
3154 to AG |
|
3155 PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity |
|
3156 to transparency |
|
3157 PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples |
|
3158 PNG_TRANSFORM_STRIP_FILLER Strip out filler |
|
3159 bytes (deprecated). |
|
3160 PNG_TRANSFORM_STRIP_FILLER_BEFORE Strip out leading |
|
3161 filler bytes |
|
3162 PNG_TRANSFORM_STRIP_FILLER_AFTER Strip out trailing |
|
3163 filler bytes |
|
3164 |
|
3165 If you have valid image data in the info structure (you can use |
|
3166 png_set_rows() to put image data in the info structure), simply do this: |
|
3167 |
|
3168 png_write_png(png_ptr, info_ptr, png_transforms, NULL) |
|
3169 |
|
3170 where png_transforms is an integer containing the bitwise OR of some set of |
|
3171 transformation flags. This call is equivalent to png_write_info(), |
|
3172 followed the set of transformations indicated by the transform mask, |
|
3173 then png_write_image(), and finally png_write_end(). |
|
3174 |
|
3175 (The final parameter of this call is not yet used. Someday it might point |
|
3176 to transformation parameters required by some future output transform.) |
|
3177 |
|
3178 You must use png_transforms and not call any png_set_transform() functions |
|
3179 when you use png_write_png(). |
|
3180 |
|
3181 The low-level write interface |
|
3182 |
|
3183 If you are going the low-level route instead, you are now ready to |
|
3184 write all the file information up to the actual image data. You do |
|
3185 this with a call to png_write_info(). |
|
3186 |
|
3187 png_write_info(png_ptr, info_ptr); |
|
3188 |
|
3189 Note that there is one transformation you may need to do before |
|
3190 png_write_info(). In PNG files, the alpha channel in an image is the |
|
3191 level of opacity. If your data is supplied as a level of transparency, |
|
3192 you can invert the alpha channel before you write it, so that 0 is |
|
3193 fully transparent and 255 (in 8-bit or paletted images) or 65535 |
|
3194 (in 16-bit images) is fully opaque, with |
|
3195 |
|
3196 png_set_invert_alpha(png_ptr); |
|
3197 |
|
3198 This must appear before png_write_info() instead of later with the |
|
3199 other transformations because in the case of paletted images the tRNS |
|
3200 chunk data has to be inverted before the tRNS chunk is written. If |
|
3201 your image is not a paletted image, the tRNS data (which in such cases |
|
3202 represents a single color to be rendered as transparent) won't need to |
|
3203 be changed, and you can safely do this transformation after your |
|
3204 png_write_info() call. |
|
3205 |
|
3206 If you need to write a private chunk that you want to appear before |
|
3207 the PLTE chunk when PLTE is present, you can write the PNG info in |
|
3208 two steps, and insert code to write your own chunk between them: |
|
3209 |
|
3210 png_write_info_before_PLTE(png_ptr, info_ptr); |
|
3211 png_set_unknown_chunks(png_ptr, info_ptr, ...); |
|
3212 png_write_info(png_ptr, info_ptr); |
|
3213 |
|
3214 After you've written the file information, you can set up the library |
|
3215 to handle any special transformations of the image data. The various |
|
3216 ways to transform the data will be described in the order that they |
|
3217 should occur. This is important, as some of these change the color |
|
3218 type and/or bit depth of the data, and some others only work on |
|
3219 certain color types and bit depths. Even though each transformation |
|
3220 checks to see if it has data that it can do something with, you should |
|
3221 make sure to only enable a transformation if it will be valid for the |
|
3222 data. For example, don't swap red and blue on grayscale data. |
|
3223 |
|
3224 PNG files store RGB pixels packed into 3 or 6 bytes. This code tells |
|
3225 the library to strip input data that has 4 or 8 bytes per pixel down |
|
3226 to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2 |
|
3227 bytes per pixel). |
|
3228 |
|
3229 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE); |
|
3230 |
|
3231 where the 0 is unused, and the location is either PNG_FILLER_BEFORE or |
|
3232 PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel |
|
3233 is stored XRGB or RGBX. |
|
3234 |
|
3235 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as |
|
3236 they can, resulting in, for example, 8 pixels per byte for 1 bit files. |
|
3237 If the data is supplied at 1 pixel per byte, use this code, which will |
|
3238 correctly pack the pixels into a single byte: |
|
3239 |
|
3240 png_set_packing(png_ptr); |
|
3241 |
|
3242 PNG files reduce possible bit depths to 1, 2, 4, 8, and 16. If your |
|
3243 data is of another bit depth, you can write an sBIT chunk into the |
|
3244 file so that decoders can recover the original data if desired. |
|
3245 |
|
3246 /* Set the true bit depth of the image data */ |
|
3247 if (color_type & PNG_COLOR_MASK_COLOR) |
|
3248 { |
|
3249 sig_bit.red = true_bit_depth; |
|
3250 sig_bit.green = true_bit_depth; |
|
3251 sig_bit.blue = true_bit_depth; |
|
3252 } |
|
3253 |
|
3254 else |
|
3255 { |
|
3256 sig_bit.gray = true_bit_depth; |
|
3257 } |
|
3258 |
|
3259 if (color_type & PNG_COLOR_MASK_ALPHA) |
|
3260 { |
|
3261 sig_bit.alpha = true_bit_depth; |
|
3262 } |
|
3263 |
|
3264 png_set_sBIT(png_ptr, info_ptr, &sig_bit); |
|
3265 |
|
3266 If the data is stored in the row buffer in a bit depth other than |
|
3267 one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG), |
|
3268 this will scale the values to appear to be the correct bit depth as |
|
3269 is required by PNG. |
|
3270 |
|
3271 png_set_shift(png_ptr, &sig_bit); |
|
3272 |
|
3273 PNG files store 16-bit pixels in network byte order (big-endian, |
|
3274 ie. most significant bits first). This code would be used if they are |
|
3275 supplied the other way (little-endian, i.e. least significant bits |
|
3276 first, the way PCs store them): |
|
3277 |
|
3278 if (bit_depth > 8) |
|
3279 png_set_swap(png_ptr); |
|
3280 |
|
3281 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you |
|
3282 need to change the order the pixels are packed into bytes, you can use: |
|
3283 |
|
3284 if (bit_depth < 8) |
|
3285 png_set_packswap(png_ptr); |
|
3286 |
|
3287 PNG files store 3 color pixels in red, green, blue order. This code |
|
3288 would be used if they are supplied as blue, green, red: |
|
3289 |
|
3290 png_set_bgr(png_ptr); |
|
3291 |
|
3292 PNG files describe monochrome as black being zero and white being |
|
3293 one. This code would be used if the pixels are supplied with this reversed |
|
3294 (black being one and white being zero): |
|
3295 |
|
3296 png_set_invert_mono(png_ptr); |
|
3297 |
|
3298 Finally, you can write your own transformation function if none of |
|
3299 the existing ones meets your needs. This is done by setting a callback |
|
3300 with |
|
3301 |
|
3302 png_set_write_user_transform_fn(png_ptr, |
|
3303 write_transform_fn); |
|
3304 |
|
3305 You must supply the function |
|
3306 |
|
3307 void write_transform_fn(png_structp png_ptr, png_row_infop |
|
3308 row_info, png_bytep data) |
|
3309 |
|
3310 See pngtest.c for a working example. Your function will be called |
|
3311 before any of the other transformations are processed. If supported |
|
3312 libpng also supplies an information routine that may be called from |
|
3313 your callback: |
|
3314 |
|
3315 png_get_current_row_number(png_ptr); |
|
3316 png_get_current_pass_number(png_ptr); |
|
3317 |
|
3318 This returns the current row passed to the transform. With interlaced |
|
3319 images the value returned is the row in the input sub-image image. Use |
|
3320 PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to |
|
3321 find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass). |
|
3322 |
|
3323 The discussion of interlace handling above contains more information on how to |
|
3324 use these values. |
|
3325 |
|
3326 You can also set up a pointer to a user structure for use by your |
|
3327 callback function. |
|
3328 |
|
3329 png_set_user_transform_info(png_ptr, user_ptr, 0, 0); |
|
3330 |
|
3331 The user_channels and user_depth parameters of this function are ignored |
|
3332 when writing; you can set them to zero as shown. |
|
3333 |
|
3334 You can retrieve the pointer via the function png_get_user_transform_ptr(). |
|
3335 For example: |
|
3336 |
|
3337 voidp write_user_transform_ptr = |
|
3338 png_get_user_transform_ptr(png_ptr); |
|
3339 |
|
3340 It is possible to have libpng flush any pending output, either manually, |
|
3341 or automatically after a certain number of lines have been written. To |
|
3342 flush the output stream a single time call: |
|
3343 |
|
3344 png_write_flush(png_ptr); |
|
3345 |
|
3346 and to have libpng flush the output stream periodically after a certain |
|
3347 number of scanlines have been written, call: |
|
3348 |
|
3349 png_set_flush(png_ptr, nrows); |
|
3350 |
|
3351 Note that the distance between rows is from the last time png_write_flush() |
|
3352 was called, or the first row of the image if it has never been called. |
|
3353 So if you write 50 lines, and then png_set_flush 25, it will flush the |
|
3354 output on the next scanline, and every 25 lines thereafter, unless |
|
3355 png_write_flush() is called before 25 more lines have been written. |
|
3356 If nrows is too small (less than about 10 lines for a 640 pixel wide |
|
3357 RGB image) the image compression may decrease noticeably (although this |
|
3358 may be acceptable for real-time applications). Infrequent flushing will |
|
3359 only degrade the compression performance by a few percent over images |
|
3360 that do not use flushing. |
|
3361 |
|
3362 Writing the image data |
|
3363 |
|
3364 That's it for the transformations. Now you can write the image data. |
|
3365 The simplest way to do this is in one function call. If you have the |
|
3366 whole image in memory, you can just call png_write_image() and libpng |
|
3367 will write the image. You will need to pass in an array of pointers to |
|
3368 each row. This function automatically handles interlacing, so you don't |
|
3369 need to call png_set_interlace_handling() or call this function multiple |
|
3370 times, or any of that other stuff necessary with png_write_rows(). |
|
3371 |
|
3372 png_write_image(png_ptr, row_pointers); |
|
3373 |
|
3374 where row_pointers is: |
|
3375 |
|
3376 png_byte *row_pointers[height]; |
|
3377 |
|
3378 You can point to void or char or whatever you use for pixels. |
|
3379 |
|
3380 If you don't want to write the whole image at once, you can |
|
3381 use png_write_rows() instead. If the file is not interlaced, |
|
3382 this is simple: |
|
3383 |
|
3384 png_write_rows(png_ptr, row_pointers, |
|
3385 number_of_rows); |
|
3386 |
|
3387 row_pointers is the same as in the png_write_image() call. |
|
3388 |
|
3389 If you are just writing one row at a time, you can do this with |
|
3390 a single row_pointer instead of an array of row_pointers: |
|
3391 |
|
3392 png_bytep row_pointer = row; |
|
3393 |
|
3394 png_write_row(png_ptr, row_pointer); |
|
3395 |
|
3396 When the file is interlaced, things can get a good deal more complicated. |
|
3397 The only currently (as of the PNG Specification version 1.2, dated July |
|
3398 1999) defined interlacing scheme for PNG files is the "Adam7" interlace |
|
3399 scheme, that breaks down an image into seven smaller images of varying |
|
3400 size. libpng will build these images for you, or you can do them |
|
3401 yourself. If you want to build them yourself, see the PNG specification |
|
3402 for details of which pixels to write when. |
|
3403 |
|
3404 If you don't want libpng to handle the interlacing details, just |
|
3405 use png_set_interlace_handling() and call png_write_rows() the |
|
3406 correct number of times to write all the sub-images |
|
3407 (png_set_interlace_handling() returns the number of sub-images.) |
|
3408 |
|
3409 If you want libpng to build the sub-images, call this before you start |
|
3410 writing any rows: |
|
3411 |
|
3412 number_of_passes = png_set_interlace_handling(png_ptr); |
|
3413 |
|
3414 This will return the number of passes needed. Currently, this is seven, |
|
3415 but may change if another interlace type is added. |
|
3416 |
|
3417 Then write the complete image number_of_passes times. |
|
3418 |
|
3419 png_write_rows(png_ptr, row_pointers, number_of_rows); |
|
3420 |
|
3421 Think carefully before you write an interlaced image. Typically code that |
|
3422 reads such images reads all the image data into memory, uncompressed, before |
|
3423 doing any processing. Only code that can display an image on the fly can |
|
3424 take advantage of the interlacing and even then the image has to be exactly |
|
3425 the correct size for the output device, because scaling an image requires |
|
3426 adjacent pixels and these are not available until all the passes have been |
|
3427 read. |
|
3428 |
|
3429 If you do write an interlaced image you will hardly ever need to handle |
|
3430 the interlacing yourself. Call png_set_interlace_handling() and use the |
|
3431 approach described above. |
|
3432 |
|
3433 The only time it is conceivable that you will really need to write an |
|
3434 interlaced image pass-by-pass is when you have read one pass by pass and |
|
3435 made some pixel-by-pixel transformation to it, as described in the read |
|
3436 code above. In this case use the PNG_PASS_ROWS and PNG_PASS_COLS macros |
|
3437 to determine the size of each sub-image in turn and simply write the rows |
|
3438 you obtained from the read code. |
|
3439 |
|
3440 Finishing a sequential write |
|
3441 |
|
3442 After you are finished writing the image, you should finish writing |
|
3443 the file. If you are interested in writing comments or time, you should |
|
3444 pass an appropriately filled png_info pointer. If you are not interested, |
|
3445 you can pass NULL. |
|
3446 |
|
3447 png_write_end(png_ptr, info_ptr); |
|
3448 |
|
3449 When you are done, you can free all memory used by libpng like this: |
|
3450 |
|
3451 png_destroy_write_struct(&png_ptr, &info_ptr); |
|
3452 |
|
3453 It is also possible to individually free the info_ptr members that |
|
3454 point to libpng-allocated storage with the following function: |
|
3455 |
|
3456 png_free_data(png_ptr, info_ptr, mask, seq) |
|
3457 |
|
3458 mask - identifies data to be freed, a mask |
|
3459 containing the bitwise OR of one or |
|
3460 more of |
|
3461 PNG_FREE_PLTE, PNG_FREE_TRNS, |
|
3462 PNG_FREE_HIST, PNG_FREE_ICCP, |
|
3463 PNG_FREE_PCAL, PNG_FREE_ROWS, |
|
3464 PNG_FREE_SCAL, PNG_FREE_SPLT, |
|
3465 PNG_FREE_TEXT, PNG_FREE_UNKN, |
|
3466 or simply PNG_FREE_ALL |
|
3467 |
|
3468 seq - sequence number of item to be freed |
|
3469 (-1 for all items) |
|
3470 |
|
3471 This function may be safely called when the relevant storage has |
|
3472 already been freed, or has not yet been allocated, or was allocated |
|
3473 by the user and not by libpng, and will in those cases do nothing. |
|
3474 The "seq" parameter is ignored if only one item of the selected data |
|
3475 type, such as PLTE, is allowed. If "seq" is not -1, and multiple items |
|
3476 are allowed for the data type identified in the mask, such as text or |
|
3477 sPLT, only the n'th item in the structure is freed, where n is "seq". |
|
3478 |
|
3479 If you allocated data such as a palette that you passed in to libpng |
|
3480 with png_set_*, you must not free it until just before the call to |
|
3481 png_destroy_write_struct(). |
|
3482 |
|
3483 The default behavior is only to free data that was allocated internally |
|
3484 by libpng. This can be changed, so that libpng will not free the data, |
|
3485 or so that it will free data that was allocated by the user with png_malloc() |
|
3486 or png_calloc() and passed in via a png_set_*() function, with |
|
3487 |
|
3488 png_data_freer(png_ptr, info_ptr, freer, mask) |
|
3489 |
|
3490 freer - one of |
|
3491 PNG_DESTROY_WILL_FREE_DATA |
|
3492 PNG_SET_WILL_FREE_DATA |
|
3493 PNG_USER_WILL_FREE_DATA |
|
3494 |
|
3495 mask - which data elements are affected |
|
3496 same choices as in png_free_data() |
|
3497 |
|
3498 For example, to transfer responsibility for some data from a read structure |
|
3499 to a write structure, you could use |
|
3500 |
|
3501 png_data_freer(read_ptr, read_info_ptr, |
|
3502 PNG_USER_WILL_FREE_DATA, |
|
3503 PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST) |
|
3504 |
|
3505 png_data_freer(write_ptr, write_info_ptr, |
|
3506 PNG_DESTROY_WILL_FREE_DATA, |
|
3507 PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST) |
|
3508 |
|
3509 thereby briefly reassigning responsibility for freeing to the user but |
|
3510 immediately afterwards reassigning it once more to the write_destroy |
|
3511 function. Having done this, it would then be safe to destroy the read |
|
3512 structure and continue to use the PLTE, tRNS, and hIST data in the write |
|
3513 structure. |
|
3514 |
|
3515 This function only affects data that has already been allocated. |
|
3516 You can call this function before calling after the png_set_*() functions |
|
3517 to control whether the user or png_destroy_*() is supposed to free the data. |
|
3518 When the user assumes responsibility for libpng-allocated data, the |
|
3519 application must use |
|
3520 png_free() to free it, and when the user transfers responsibility to libpng |
|
3521 for data that the user has allocated, the user must have used png_malloc() |
|
3522 or png_calloc() to allocate it. |
|
3523 |
|
3524 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword |
|
3525 separately, do not transfer responsibility for freeing text_ptr to libpng, |
|
3526 because when libpng fills a png_text structure it combines these members with |
|
3527 the key member, and png_free_data() will free only text_ptr.key. Similarly, |
|
3528 if you transfer responsibility for free'ing text_ptr from libpng to your |
|
3529 application, your application must not separately free those members. |
|
3530 For a more compact example of writing a PNG image, see the file example.c. |
|
3531 |
|
3532 V. Simplified API |
|
3533 |
|
3534 The simplified API, which became available in libpng-1.6.0, hides the details |
|
3535 of both libpng and the PNG file format itself. |
|
3536 It allows PNG files to be read into a very limited number of |
|
3537 in-memory bitmap formats or to be written from the same formats. If these |
|
3538 formats do not accommodate your needs then you can, and should, use the more |
|
3539 sophisticated APIs above - these support a wide variety of in-memory formats |
|
3540 and a wide variety of sophisticated transformations to those formats as well |
|
3541 as a wide variety of APIs to manipulate ancilliary information. |
|
3542 |
|
3543 To read a PNG file using the simplified API: |
|
3544 |
|
3545 1) Declare a 'png_image' structure (see below) on the |
|
3546 stack and memset() it to all zero. |
|
3547 |
|
3548 2) Call the appropriate png_image_begin_read... function. |
|
3549 |
|
3550 3) Set the png_image 'format' member to the required |
|
3551 format and allocate a buffer for the image. |
|
3552 |
|
3553 4) Call png_image_finish_read to read the image into |
|
3554 your buffer. |
|
3555 |
|
3556 There are no restrictions on the format of the PNG input itself; all valid |
|
3557 color types, bit depths, and interlace methods are acceptable, and the |
|
3558 input image is transformed as necessary to the requested in-memory format |
|
3559 during the png_image_finish_read() step. |
|
3560 |
|
3561 To write a PNG file using the simplified API: |
|
3562 |
|
3563 1) Declare a 'png_image' structure on the stack and memset() |
|
3564 it to all zero. |
|
3565 |
|
3566 2) Initialize the members of the structure that describe the |
|
3567 image, setting the 'format' member to the format of the |
|
3568 image in memory. |
|
3569 |
|
3570 3) Call the appropriate png_image_write... function with a |
|
3571 pointer to the image to write the PNG data. |
|
3572 |
|
3573 png_image is a structure that describes the in-memory format of an image |
|
3574 when it is being read or define the in-memory format of an image that you |
|
3575 need to write. The "png_image" structure contains the following members: |
|
3576 |
|
3577 png_uint_32 version Set to PNG_IMAGE_VERSION |
|
3578 png_uint_32 width Image width in pixels (columns) |
|
3579 png_uint_32 height Image height in pixels (rows) |
|
3580 png_uint_32 format Image format as defined below |
|
3581 png_uint_32 flags A bit mask containing informational flags |
|
3582 png_controlp opaque Initialize to NULL, free with png_image_free |
|
3583 png_uint_32 colormap_entries; Number of entries in the color-map |
|
3584 png_uint_32 warning_or_error; |
|
3585 char message[64]; |
|
3586 |
|
3587 In the event of an error or warning the following field warning_or_error |
|
3588 field will be set to a non-zero value and the 'message' field will contain |
|
3589 a '\0' terminated string with the libpng error or warning message. If both |
|
3590 warnings and an error were encountered, only the error is recorded. If there |
|
3591 are multiple warnings, only the first one is recorded. |
|
3592 |
|
3593 The upper 30 bits of this value are reserved; the low two bits contain |
|
3594 a two bit code such that a value more than 1 indicates a failure in the API |
|
3595 just called: |
|
3596 |
|
3597 0 - no warning or error |
|
3598 1 - warning |
|
3599 2 - error |
|
3600 3 - error preceded by warning |
|
3601 |
|
3602 The pixels (samples) of the image have one to four channels whose components |
|
3603 have original values in the range 0 to 1.0: |
|
3604 |
|
3605 1: A single gray or luminance channel (G). |
|
3606 2: A gray/luminance channel and an alpha channel (GA). |
|
3607 3: Three red, green, blue color channels (RGB). |
|
3608 4: Three color channels and an alpha channel (RGBA). |
|
3609 |
|
3610 The channels are encoded in one of two ways: |
|
3611 |
|
3612 a) As a small integer, value 0..255, contained in a single byte. For the |
|
3613 alpha channel the original value is simply value/255. For the color or |
|
3614 luminance channels the value is encoded according to the sRGB specification |
|
3615 and matches the 8-bit format expected by typical display devices. |
|
3616 |
|
3617 The color/gray channels are not scaled (pre-multiplied) by the alpha |
|
3618 channel and are suitable for passing to color management software. |
|
3619 |
|
3620 b) As a value in the range 0..65535, contained in a 2-byte integer. All |
|
3621 channels can be converted to the original value by dividing by 65535; all |
|
3622 channels are linear. Color channels use the RGB encoding (RGB end-points) of |
|
3623 the sRGB specification. This encoding is identified by the |
|
3624 PNG_FORMAT_FLAG_LINEAR flag below. |
|
3625 |
|
3626 When an alpha channel is present it is expected to denote pixel coverage |
|
3627 of the color or luminance channels and is returned as an associated alpha |
|
3628 channel: the color/gray channels are scaled (pre-multiplied) by the alpha |
|
3629 value. |
|
3630 |
|
3631 When a color-mapped image is used as a result of calling |
|
3632 png_image_read_colormap or png_image_write_colormap the channels are encoded |
|
3633 in the color-map and the descriptions above apply to the color-map entries. |
|
3634 The image data is encoded as small integers, value 0..255, that index the |
|
3635 entries in the color-map. One integer (one byte) is stored for each pixel. |
|
3636 |
|
3637 PNG_FORMAT_* |
|
3638 |
|
3639 The #defines to be used in png_image::format. Each #define identifies a |
|
3640 particular layout of channel data and, if present, alpha values. There are |
|
3641 separate defines for each of the two channel encodings. |
|
3642 |
|
3643 A format is built up using single bit flag values. Not all combinations are |
|
3644 valid: use the bit flag values below for testing a format returned by the |
|
3645 read APIs, but set formats from the derived values. |
|
3646 |
|
3647 When reading or writing color-mapped images the format should be set to the |
|
3648 format of the entries in the color-map then png_image_{read,write}_colormap |
|
3649 called to read or write the color-map and set the format correctly for the |
|
3650 image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly! |
|
3651 |
|
3652 NOTE: libpng can be built with particular features disabled, if you see |
|
3653 compiler errors because the definition of one of the following flags has been |
|
3654 compiled out it is because libpng does not have the required support. It is |
|
3655 possible, however, for the libpng configuration to enable the format on just |
|
3656 read or just write; in that case you may see an error at run time. You can |
|
3657 guard against this by checking for the definition of: |
|
3658 |
|
3659 PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED |
|
3660 |
|
3661 PNG_FORMAT_FLAG_ALPHA 0x01 format with an alpha channel |
|
3662 PNG_FORMAT_FLAG_COLOR 0x02 color format: otherwise grayscale |
|
3663 PNG_FORMAT_FLAG_LINEAR 0x04 png_uint_16 channels else png_byte |
|
3664 PNG_FORMAT_FLAG_COLORMAP 0x08 libpng use only |
|
3665 PNG_FORMAT_FLAG_BGR 0x10 BGR colors, else order is RGB |
|
3666 PNG_FORMAT_FLAG_AFIRST 0x20 alpha channel comes first |
|
3667 |
|
3668 Supported formats are as follows. Future versions of libpng may support more |
|
3669 formats; for compatibility with older versions simply check if the format |
|
3670 macro is defined using #ifdef. These defines describe the in-memory layout |
|
3671 of the components of the pixels of the image. |
|
3672 |
|
3673 First the single byte formats: |
|
3674 |
|
3675 PNG_FORMAT_GRAY 0 |
|
3676 PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA |
|
3677 PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST) |
|
3678 PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR |
|
3679 PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR) |
|
3680 PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA) |
|
3681 PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST) |
|
3682 PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA) |
|
3683 PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST) |
|
3684 |
|
3685 Then the linear 2-byte formats. When naming these "Y" is used to |
|
3686 indicate a luminance (gray) channel. The component order within the pixel |
|
3687 is always the same - there is no provision for swapping the order of the |
|
3688 components in the linear format. |
|
3689 |
|
3690 PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR |
|
3691 PNG_FORMAT_LINEAR_Y_ALPHA |
|
3692 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA) |
|
3693 PNG_FORMAT_LINEAR_RGB |
|
3694 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR) |
|
3695 PNG_FORMAT_LINEAR_RGB_ALPHA |
|
3696 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR| |
|
3697 PNG_FORMAT_FLAG_ALPHA) |
|
3698 |
|
3699 Color-mapped formats are obtained by calling png_image_{read,write}_colormap, |
|
3700 as appropriate after setting png_image::format to the format of the color-map |
|
3701 to be read or written. Applications may check the value of |
|
3702 PNG_FORMAT_FLAG_COLORMAP to see if they have called the colormap API. The |
|
3703 format of the color-map may be extracted using the following macro. |
|
3704 |
|
3705 PNG_FORMAT_OF_COLORMAP(fmt) ((fmt) & ~PNG_FORMAT_FLAG_COLORMAP) |
|
3706 |
|
3707 PNG_IMAGE macros |
|
3708 |
|
3709 These are convenience macros to derive information from a png_image |
|
3710 structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the |
|
3711 actual image sample values - either the entries in the color-map or the |
|
3712 pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values |
|
3713 for the pixels and will always return 1 after a call to |
|
3714 png_image_{read,write}_colormap. The remaining macros return information |
|
3715 about the rows in the image and the complete image. |
|
3716 |
|
3717 NOTE: All the macros that take a png_image::format parameter are compile time |
|
3718 constants if the format parameter is, itself, a constant. Therefore these |
|
3719 macros can be used in array declarations and case labels where required. |
|
3720 Similarly the macros are also pre-processor constants (sizeof is not used) so |
|
3721 they can be used in #if tests. |
|
3722 |
|
3723 First the information about the samples. |
|
3724 |
|
3725 PNG_IMAGE_SAMPLE_CHANNELS(fmt) |
|
3726 Returns the total number of channels in a given format: 1..4 |
|
3727 |
|
3728 PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt) |
|
3729 Returns the size in bytes of a single component of a pixel or color-map |
|
3730 entry (as appropriate) in the image. |
|
3731 |
|
3732 PNG_IMAGE_SAMPLE_SIZE(fmt) |
|
3733 This is the size of the sample data for one sample. If the image is |
|
3734 color-mapped it is the size of one color-map entry (and image pixels are |
|
3735 one byte in size), otherwise it is the size of one image pixel. |
|
3736 |
|
3737 PNG_IMAGE_COLORMAP_SIZE(fmt) |
|
3738 The size of the color-map required by the format; this is the size of the |
|
3739 color-map buffer passed to the png_image_{read,write}_colormap APIs, it is |
|
3740 a fixed number determined by the format so can easily be allocated on the |
|
3741 stack if necessary. |
|
3742 |
|
3743 #define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\ |
|
3744 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256) |
|
3745 /* The maximum size of the color-map required by the format expressed in a |
|
3746 * count of components. This can be used to compile-time allocate a |
|
3747 * color-map: |
|
3748 * |
|
3749 * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)]; |
|
3750 * |
|
3751 * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)]; |
|
3752 * |
|
3753 * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the |
|
3754 * information from one of the png_image_begin_read_ APIs and dynamically |
|
3755 * allocate the required memory. |
|
3756 */ |
|
3757 |
|
3758 |
|
3759 Corresponding information about the pixels |
|
3760 |
|
3761 PNG_IMAGE_PIXEL_(test,fmt) |
|
3762 |
|
3763 PNG_IMAGE_PIXEL_CHANNELS(fmt) |
|
3764 The number of separate channels (components) in a pixel; 1 for a |
|
3765 color-mapped image. |
|
3766 |
|
3767 PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\ |
|
3768 The size, in bytes, of each component in a pixel; 1 for a color-mapped |
|
3769 image. |
|
3770 |
|
3771 PNG_IMAGE_PIXEL_SIZE(fmt) |
|
3772 The size, in bytes, of a complete pixel; 1 for a color-mapped image. |
|
3773 |
|
3774 Information about the whole row, or whole image |
|
3775 |
|
3776 PNG_IMAGE_ROW_STRIDE(image) |
|
3777 Returns the total number of components in a single row of the image; this |
|
3778 is the minimum 'row stride', the minimum count of components between each |
|
3779 row. For a color-mapped image this is the minimum number of bytes in a |
|
3780 row. |
|
3781 |
|
3782 PNG_IMAGE_BUFFER_SIZE(image, row_stride) |
|
3783 Returns the size, in bytes, of an image buffer given a png_image and a row |
|
3784 stride - the number of components to leave space for in each row. |
|
3785 |
|
3786 PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB == 0x01 |
|
3787 This indicates the the RGB values of the in-memory bitmap do not |
|
3788 correspond to the red, green and blue end-points defined by sRGB. |
|
3789 |
|
3790 PNG_IMAGE_FLAG_COLORMAP == 0x02 |
|
3791 The PNG is color-mapped. If this flag is set png_image_read_colormap |
|
3792 can be used without further loss of image information. If it is not set |
|
3793 png_image_read_colormap will cause significant loss if the image has any |
|
3794 |
|
3795 READ APIs |
|
3796 |
|
3797 The png_image passed to the read APIs must have been initialized by setting |
|
3798 the png_controlp field 'opaque' to NULL (or, better, memset the whole thing.) |
|
3799 |
|
3800 int png_image_begin_read_from_file( png_imagep image, |
|
3801 const char *file_name) |
|
3802 |
|
3803 The named file is opened for read and the image header |
|
3804 is filled in from the PNG header in the file. |
|
3805 |
|
3806 int png_image_begin_read_from_stdio (png_imagep image, |
|
3807 FILE* file) |
|
3808 |
|
3809 The PNG header is read from the stdio FILE object. |
|
3810 |
|
3811 int png_image_begin_read_from_memory(png_imagep image, |
|
3812 png_const_voidp memory, png_size_t size) |
|
3813 |
|
3814 The PNG header is read from the given memory buffer. |
|
3815 |
|
3816 int png_image_finish_read(png_imagep image, |
|
3817 png_colorp background, void *buffer, |
|
3818 png_int_32 row_stride, void *colormap)); |
|
3819 |
|
3820 Finish reading the image into the supplied buffer and |
|
3821 clean up the png_image structure. |
|
3822 |
|
3823 row_stride is the step, in png_byte or png_uint_16 units |
|
3824 as appropriate, between adjacent rows. A positive stride |
|
3825 indicates that the top-most row is first in the buffer - |
|
3826 the normal top-down arrangement. A negative stride |
|
3827 indicates that the bottom-most row is first in the buffer. |
|
3828 |
|
3829 background need only be supplied if an alpha channel must |
|
3830 be removed from a png_byte format and the removal is to be |
|
3831 done by compositing on a solid color; otherwise it may be |
|
3832 NULL and any composition will be done directly onto the |
|
3833 buffer. The value is an sRGB color to use for the |
|
3834 background, for grayscale output the green channel is used. |
|
3835 |
|
3836 For linear output removing the alpha channel is always done |
|
3837 by compositing on black. |
|
3838 |
|
3839 void png_image_free(png_imagep image) |
|
3840 |
|
3841 Free any data allocated by libpng in image->opaque, |
|
3842 setting the pointer to NULL. May be called at any time |
|
3843 after the structure is initialized. |
|
3844 |
|
3845 When the simplified API needs to convert between sRGB and linear colorspaces, |
|
3846 the actual sRGB transfer curve defined in the sRGB specification (see the |
|
3847 article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2 |
|
3848 approximation used elsewhere in libpng. |
|
3849 |
|
3850 WRITE APIS |
|
3851 |
|
3852 For write you must initialize a png_image structure to describe the image to |
|
3853 be written: |
|
3854 |
|
3855 version: must be set to PNG_IMAGE_VERSION |
|
3856 opaque: must be initialized to NULL |
|
3857 width: image width in pixels |
|
3858 height: image height in rows |
|
3859 format: the format of the data you wish to write |
|
3860 flags: set to 0 unless one of the defined flags applies; set |
|
3861 PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images |
|
3862 where the RGB values do not correspond to the colors in sRGB. |
|
3863 colormap_entries: set to the number of entries in the color-map (0 to 256) |
|
3864 |
|
3865 int png_image_write_to_file, (png_imagep image, |
|
3866 const char *file, int convert_to_8bit, const void *buffer, |
|
3867 png_int_32 row_stride, const void *colormap)); |
|
3868 |
|
3869 Write the image to the named file. |
|
3870 |
|
3871 int png_image_write_to_stdio(png_imagep image, FILE *file, |
|
3872 int convert_to_8_bit, const void *buffer, |
|
3873 png_int_32 row_stride, const void *colormap) |
|
3874 |
|
3875 Write the image to the given (FILE*). |
|
3876 |
|
3877 With all write APIs if image is in one of the linear formats with |
|
3878 (png_uint_16) data then setting convert_to_8_bit will cause the output to be |
|
3879 a (png_byte) PNG gamma encoded according to the sRGB specification, otherwise |
|
3880 a 16-bit linear encoded PNG file is written. |
|
3881 |
|
3882 With all APIs row_stride is handled as in the read APIs - it is the spacing |
|
3883 from one row to the next in component sized units (float) and if negative |
|
3884 indicates a bottom-up row layout in the buffer. |
|
3885 |
|
3886 Note that the write API does not support interlacing, sub-8-bit pixels, |
|
3887 and indexed (paletted) images. |
|
3888 |
|
3889 VI. Modifying/Customizing libpng |
|
3890 |
|
3891 There are two issues here. The first is changing how libpng does |
|
3892 standard things like memory allocation, input/output, and error handling. |
|
3893 The second deals with more complicated things like adding new chunks, |
|
3894 adding new transformations, and generally changing how libpng works. |
|
3895 Both of those are compile-time issues; that is, they are generally |
|
3896 determined at the time the code is written, and there is rarely a need |
|
3897 to provide the user with a means of changing them. |
|
3898 |
|
3899 Memory allocation, input/output, and error handling |
|
3900 |
|
3901 All of the memory allocation, input/output, and error handling in libpng |
|
3902 goes through callbacks that are user-settable. The default routines are |
|
3903 in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively. To change |
|
3904 these functions, call the appropriate png_set_*_fn() function. |
|
3905 |
|
3906 Memory allocation is done through the functions png_malloc(), png_calloc(), |
|
3907 and png_free(). The png_malloc() and png_free() functions currently just |
|
3908 call the standard C functions and png_calloc() calls png_malloc() and then |
|
3909 clears the newly allocated memory to zero; note that png_calloc(png_ptr, size) |
|
3910 is not the same as the calloc(number, size) function provided by stdlib.h. |
|
3911 There is limited support for certain systems with segmented memory |
|
3912 architectures and the types of pointers declared by png.h match this; you |
|
3913 will have to use appropriate pointers in your application. Since it is |
|
3914 unlikely that the method of handling memory allocation on a platform |
|
3915 will change between applications, these functions must be modified in |
|
3916 the library at compile time. If you prefer to use a different method |
|
3917 of allocating and freeing data, you can use png_create_read_struct_2() or |
|
3918 png_create_write_struct_2() to register your own functions as described |
|
3919 above. These functions also provide a void pointer that can be retrieved |
|
3920 via |
|
3921 |
|
3922 mem_ptr=png_get_mem_ptr(png_ptr); |
|
3923 |
|
3924 Your replacement memory functions must have prototypes as follows: |
|
3925 |
|
3926 png_voidp malloc_fn(png_structp png_ptr, |
|
3927 png_alloc_size_t size); |
|
3928 |
|
3929 void free_fn(png_structp png_ptr, png_voidp ptr); |
|
3930 |
|
3931 Your malloc_fn() must return NULL in case of failure. The png_malloc() |
|
3932 function will normally call png_error() if it receives a NULL from the |
|
3933 system memory allocator or from your replacement malloc_fn(). |
|
3934 |
|
3935 Your free_fn() will never be called with a NULL ptr, since libpng's |
|
3936 png_free() checks for NULL before calling free_fn(). |
|
3937 |
|
3938 Input/Output in libpng is done through png_read() and png_write(), |
|
3939 which currently just call fread() and fwrite(). The FILE * is stored in |
|
3940 png_struct and is initialized via png_init_io(). If you wish to change |
|
3941 the method of I/O, the library supplies callbacks that you can set |
|
3942 through the function png_set_read_fn() and png_set_write_fn() at run |
|
3943 time, instead of calling the png_init_io() function. These functions |
|
3944 also provide a void pointer that can be retrieved via the function |
|
3945 png_get_io_ptr(). For example: |
|
3946 |
|
3947 png_set_read_fn(png_structp read_ptr, |
|
3948 voidp read_io_ptr, png_rw_ptr read_data_fn) |
|
3949 |
|
3950 png_set_write_fn(png_structp write_ptr, |
|
3951 voidp write_io_ptr, png_rw_ptr write_data_fn, |
|
3952 png_flush_ptr output_flush_fn); |
|
3953 |
|
3954 voidp read_io_ptr = png_get_io_ptr(read_ptr); |
|
3955 voidp write_io_ptr = png_get_io_ptr(write_ptr); |
|
3956 |
|
3957 The replacement I/O functions must have prototypes as follows: |
|
3958 |
|
3959 void user_read_data(png_structp png_ptr, |
|
3960 png_bytep data, png_size_t length); |
|
3961 |
|
3962 void user_write_data(png_structp png_ptr, |
|
3963 png_bytep data, png_size_t length); |
|
3964 |
|
3965 void user_flush_data(png_structp png_ptr); |
|
3966 |
|
3967 The user_read_data() function is responsible for detecting and |
|
3968 handling end-of-data errors. |
|
3969 |
|
3970 Supplying NULL for the read, write, or flush functions sets them back |
|
3971 to using the default C stream functions, which expect the io_ptr to |
|
3972 point to a standard *FILE structure. It is probably a mistake |
|
3973 to use NULL for one of write_data_fn and output_flush_fn but not both |
|
3974 of them, unless you have built libpng with PNG_NO_WRITE_FLUSH defined. |
|
3975 It is an error to read from a write stream, and vice versa. |
|
3976 |
|
3977 Error handling in libpng is done through png_error() and png_warning(). |
|
3978 Errors handled through png_error() are fatal, meaning that png_error() |
|
3979 should never return to its caller. Currently, this is handled via |
|
3980 setjmp() and longjmp() (unless you have compiled libpng with |
|
3981 PNG_NO_SETJMP, in which case it is handled via PNG_ABORT()), |
|
3982 but you could change this to do things like exit() if you should wish, |
|
3983 as long as your function does not return. |
|
3984 |
|
3985 On non-fatal errors, png_warning() is called |
|
3986 to print a warning message, and then control returns to the calling code. |
|
3987 By default png_error() and png_warning() print a message on stderr via |
|
3988 fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined |
|
3989 (because you don't want the messages) or PNG_NO_STDIO defined (because |
|
3990 fprintf() isn't available). If you wish to change the behavior of the error |
|
3991 functions, you will need to set up your own message callbacks. These |
|
3992 functions are normally supplied at the time that the png_struct is created. |
|
3993 It is also possible to redirect errors and warnings to your own replacement |
|
3994 functions after png_create_*_struct() has been called by calling: |
|
3995 |
|
3996 png_set_error_fn(png_structp png_ptr, |
|
3997 png_voidp error_ptr, png_error_ptr error_fn, |
|
3998 png_error_ptr warning_fn); |
|
3999 |
|
4000 png_voidp error_ptr = png_get_error_ptr(png_ptr); |
|
4001 |
|
4002 If NULL is supplied for either error_fn or warning_fn, then the libpng |
|
4003 default function will be used, calling fprintf() and/or longjmp() if a |
|
4004 problem is encountered. The replacement error functions should have |
|
4005 parameters as follows: |
|
4006 |
|
4007 void user_error_fn(png_structp png_ptr, |
|
4008 png_const_charp error_msg); |
|
4009 |
|
4010 void user_warning_fn(png_structp png_ptr, |
|
4011 png_const_charp warning_msg); |
|
4012 |
|
4013 The motivation behind using setjmp() and longjmp() is the C++ throw and |
|
4014 catch exception handling methods. This makes the code much easier to write, |
|
4015 as there is no need to check every return code of every function call. |
|
4016 However, there are some uncertainties about the status of local variables |
|
4017 after a longjmp, so the user may want to be careful about doing anything |
|
4018 after setjmp returns non-zero besides returning itself. Consult your |
|
4019 compiler documentation for more details. For an alternative approach, you |
|
4020 may wish to use the "cexcept" facility (see http://cexcept.sourceforge.net), |
|
4021 which is illustrated in pngvalid.c and in contrib/visupng. |
|
4022 |
|
4023 Beginning in libpng-1.4.0, the png_set_benign_errors() API became available. |
|
4024 You can use this to handle certain errors (normally handled as errors) |
|
4025 as warnings. |
|
4026 |
|
4027 png_set_benign_errors (png_ptr, int allowed); |
|
4028 |
|
4029 allowed: 0: treat png_benign_error() as an error. |
|
4030 1: treat png_benign_error() as a warning. |
|
4031 |
|
4032 As of libpng-1.6.0, the default condition is to treat benign errors as |
|
4033 warnings while reading and as errors while writing. |
|
4034 |
|
4035 Custom chunks |
|
4036 |
|
4037 If you need to read or write custom chunks, you may need to get deeper |
|
4038 into the libpng code. The library now has mechanisms for storing |
|
4039 and writing chunks of unknown type; you can even declare callbacks |
|
4040 for custom chunks. However, this may not be good enough if the |
|
4041 library code itself needs to know about interactions between your |
|
4042 chunk and existing `intrinsic' chunks. |
|
4043 |
|
4044 If you need to write a new intrinsic chunk, first read the PNG |
|
4045 specification. Acquire a first level of understanding of how it works. |
|
4046 Pay particular attention to the sections that describe chunk names, |
|
4047 and look at how other chunks were designed, so you can do things |
|
4048 similarly. Second, check out the sections of libpng that read and |
|
4049 write chunks. Try to find a chunk that is similar to yours and use |
|
4050 it as a template. More details can be found in the comments inside |
|
4051 the code. It is best to handle private or unknown chunks in a generic method, |
|
4052 via callback functions, instead of by modifying libpng functions. This |
|
4053 is illustrated in pngtest.c, which uses a callback function to handle a |
|
4054 private "vpAg" chunk and the new "sTER" chunk, which are both unknown to |
|
4055 libpng. |
|
4056 |
|
4057 If you wish to write your own transformation for the data, look through |
|
4058 the part of the code that does the transformations, and check out some of |
|
4059 the simpler ones to get an idea of how they work. Try to find a similar |
|
4060 transformation to the one you want to add and copy off of it. More details |
|
4061 can be found in the comments inside the code itself. |
|
4062 |
|
4063 Configuring for 16-bit platforms |
|
4064 |
|
4065 You will want to look into zconf.h to tell zlib (and thus libpng) that |
|
4066 it cannot allocate more then 64K at a time. Even if you can, the memory |
|
4067 won't be accessible. So limit zlib and libpng to 64K by defining MAXSEG_64K. |
|
4068 |
|
4069 Configuring for DOS |
|
4070 |
|
4071 For DOS users who only have access to the lower 640K, you will |
|
4072 have to limit zlib's memory usage via a png_set_compression_mem_level() |
|
4073 call. See zlib.h or zconf.h in the zlib library for more information. |
|
4074 |
|
4075 Configuring for Medium Model |
|
4076 |
|
4077 Libpng's support for medium model has been tested on most of the popular |
|
4078 compilers. Make sure MAXSEG_64K gets defined, USE_FAR_KEYWORD gets |
|
4079 defined, and FAR gets defined to far in pngconf.h, and you should be |
|
4080 all set. Everything in the library (except for zlib's structure) is |
|
4081 expecting far data. You must use the typedefs with the p or pp on |
|
4082 the end for pointers (or at least look at them and be careful). Make |
|
4083 note that the rows of data are defined as png_bytepp, which is |
|
4084 an "unsigned char far * far *". |
|
4085 |
|
4086 Configuring for gui/windowing platforms: |
|
4087 |
|
4088 You will need to write new error and warning functions that use the GUI |
|
4089 interface, as described previously, and set them to be the error and |
|
4090 warning functions at the time that png_create_*_struct() is called, |
|
4091 in order to have them available during the structure initialization. |
|
4092 They can be changed later via png_set_error_fn(). On some compilers, |
|
4093 you may also have to change the memory allocators (png_malloc, etc.). |
|
4094 |
|
4095 Configuring for compiler xxx: |
|
4096 |
|
4097 All includes for libpng are in pngconf.h. If you need to add, change |
|
4098 or delete an include, this is the place to do it. |
|
4099 The includes that are not needed outside libpng are placed in pngpriv.h, |
|
4100 which is only used by the routines inside libpng itself. |
|
4101 The files in libpng proper only include pngpriv.h and png.h, which |
|
4102 in turn includes pngconf.h and, as of libpng-1.5.0, pnglibconf.h. |
|
4103 As of libpng-1.5.0, pngpriv.h also includes three other private header |
|
4104 files, pngstruct.h, pnginfo.h, and pngdebug.h, which contain material |
|
4105 that previously appeared in the public headers. |
|
4106 |
|
4107 Configuring zlib: |
|
4108 |
|
4109 There are special functions to configure the compression. Perhaps the |
|
4110 most useful one changes the compression level, which currently uses |
|
4111 input compression values in the range 0 - 9. The library normally |
|
4112 uses the default compression level (Z_DEFAULT_COMPRESSION = 6). Tests |
|
4113 have shown that for a large majority of images, compression values in |
|
4114 the range 3-6 compress nearly as well as higher levels, and do so much |
|
4115 faster. For online applications it may be desirable to have maximum speed |
|
4116 (Z_BEST_SPEED = 1). With versions of zlib after v0.99, you can also |
|
4117 specify no compression (Z_NO_COMPRESSION = 0), but this would create |
|
4118 files larger than just storing the raw bitmap. You can specify the |
|
4119 compression level by calling: |
|
4120 |
|
4121 #include zlib.h |
|
4122 png_set_compression_level(png_ptr, level); |
|
4123 |
|
4124 Another useful one is to reduce the memory level used by the library. |
|
4125 The memory level defaults to 8, but it can be lowered if you are |
|
4126 short on memory (running DOS, for example, where you only have 640K). |
|
4127 Note that the memory level does have an effect on compression; among |
|
4128 other things, lower levels will result in sections of incompressible |
|
4129 data being emitted in smaller stored blocks, with a correspondingly |
|
4130 larger relative overhead of up to 15% in the worst case. |
|
4131 |
|
4132 #include zlib.h |
|
4133 png_set_compression_mem_level(png_ptr, level); |
|
4134 |
|
4135 The other functions are for configuring zlib. They are not recommended |
|
4136 for normal use and may result in writing an invalid PNG file. See |
|
4137 zlib.h for more information on what these mean. |
|
4138 |
|
4139 #include zlib.h |
|
4140 png_set_compression_strategy(png_ptr, |
|
4141 strategy); |
|
4142 |
|
4143 png_set_compression_window_bits(png_ptr, |
|
4144 window_bits); |
|
4145 |
|
4146 png_set_compression_method(png_ptr, method); |
|
4147 |
|
4148 png_set_compression_buffer_size(png_ptr, size); |
|
4149 |
|
4150 As of libpng version 1.5.4, additional APIs became |
|
4151 available to set these separately for non-IDAT |
|
4152 compressed chunks such as zTXt, iTXt, and iCCP: |
|
4153 |
|
4154 #include zlib.h |
|
4155 #if PNG_LIBPNG_VER >= 10504 |
|
4156 png_set_text_compression_level(png_ptr, level); |
|
4157 |
|
4158 png_set_text_compression_mem_level(png_ptr, level); |
|
4159 |
|
4160 png_set_text_compression_strategy(png_ptr, |
|
4161 strategy); |
|
4162 |
|
4163 png_set_text_compression_window_bits(png_ptr, |
|
4164 window_bits); |
|
4165 |
|
4166 png_set_text_compression_method(png_ptr, method); |
|
4167 #endif |
|
4168 |
|
4169 Controlling row filtering |
|
4170 |
|
4171 If you want to control whether libpng uses filtering or not, which |
|
4172 filters are used, and how it goes about picking row filters, you |
|
4173 can call one of these functions. The selection and configuration |
|
4174 of row filters can have a significant impact on the size and |
|
4175 encoding speed and a somewhat lesser impact on the decoding speed |
|
4176 of an image. Filtering is enabled by default for RGB and grayscale |
|
4177 images (with and without alpha), but not for paletted images nor |
|
4178 for any images with bit depths less than 8 bits/pixel. |
|
4179 |
|
4180 The 'method' parameter sets the main filtering method, which is |
|
4181 currently only '0' in the PNG 1.2 specification. The 'filters' |
|
4182 parameter sets which filter(s), if any, should be used for each |
|
4183 scanline. Possible values are PNG_ALL_FILTERS and PNG_NO_FILTERS |
|
4184 to turn filtering on and off, respectively. |
|
4185 |
|
4186 Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB, |
|
4187 PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise |
|
4188 ORed together with '|' to specify one or more filters to use. |
|
4189 These filters are described in more detail in the PNG specification. |
|
4190 If you intend to change the filter type during the course of writing |
|
4191 the image, you should start with flags set for all of the filters |
|
4192 you intend to use so that libpng can initialize its internal |
|
4193 structures appropriately for all of the filter types. (Note that this |
|
4194 means the first row must always be adaptively filtered, because libpng |
|
4195 currently does not allocate the filter buffers until png_write_row() |
|
4196 is called for the first time.) |
|
4197 |
|
4198 filters = PNG_FILTER_NONE | PNG_FILTER_SUB |
|
4199 PNG_FILTER_UP | PNG_FILTER_AVG | |
|
4200 PNG_FILTER_PAETH | PNG_ALL_FILTERS; |
|
4201 |
|
4202 png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE, |
|
4203 filters); |
|
4204 The second parameter can also be |
|
4205 PNG_INTRAPIXEL_DIFFERENCING if you are |
|
4206 writing a PNG to be embedded in a MNG |
|
4207 datastream. This parameter must be the |
|
4208 same as the value of filter_method used |
|
4209 in png_set_IHDR(). |
|
4210 |
|
4211 It is also possible to influence how libpng chooses from among the |
|
4212 available filters. This is done in one or both of two ways - by |
|
4213 telling it how important it is to keep the same filter for successive |
|
4214 rows, and by telling it the relative computational costs of the filters. |
|
4215 |
|
4216 double weights[3] = {1.5, 1.3, 1.1}, |
|
4217 costs[PNG_FILTER_VALUE_LAST] = |
|
4218 {1.0, 1.3, 1.3, 1.5, 1.7}; |
|
4219 |
|
4220 png_set_filter_heuristics(png_ptr, |
|
4221 PNG_FILTER_HEURISTIC_WEIGHTED, 3, |
|
4222 weights, costs); |
|
4223 |
|
4224 The weights are multiplying factors that indicate to libpng that the |
|
4225 row filter should be the same for successive rows unless another row filter |
|
4226 is that many times better than the previous filter. In the above example, |
|
4227 if the previous 3 filters were SUB, SUB, NONE, the SUB filter could have a |
|
4228 "sum of absolute differences" 1.5 x 1.3 times higher than other filters |
|
4229 and still be chosen, while the NONE filter could have a sum 1.1 times |
|
4230 higher than other filters and still be chosen. Unspecified weights are |
|
4231 taken to be 1.0, and the specified weights should probably be declining |
|
4232 like those above in order to emphasize recent filters over older filters. |
|
4233 |
|
4234 The filter costs specify for each filter type a relative decoding cost |
|
4235 to be considered when selecting row filters. This means that filters |
|
4236 with higher costs are less likely to be chosen over filters with lower |
|
4237 costs, unless their "sum of absolute differences" is that much smaller. |
|
4238 The costs do not necessarily reflect the exact computational speeds of |
|
4239 the various filters, since this would unduly influence the final image |
|
4240 size. |
|
4241 |
|
4242 Note that the numbers above were invented purely for this example and |
|
4243 are given only to help explain the function usage. Little testing has |
|
4244 been done to find optimum values for either the costs or the weights. |
|
4245 |
|
4246 Removing unwanted object code |
|
4247 |
|
4248 There are a bunch of #define's in pngconf.h that control what parts of |
|
4249 libpng are compiled. All the defines end in _SUPPORTED. If you are |
|
4250 never going to use a capability, you can change the #define to #undef |
|
4251 before recompiling libpng and save yourself code and data space, or |
|
4252 you can turn off individual capabilities with defines that begin with |
|
4253 PNG_NO_. |
|
4254 |
|
4255 In libpng-1.5.0 and later, the #define's are in pnglibconf.h instead. |
|
4256 |
|
4257 You can also turn all of the transforms and ancillary chunk capabilities |
|
4258 off en masse with compiler directives that define |
|
4259 PNG_NO_READ[or WRITE]_TRANSFORMS, or PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS, |
|
4260 or all four, |
|
4261 along with directives to turn on any of the capabilities that you do |
|
4262 want. The PNG_NO_READ[or WRITE]_TRANSFORMS directives disable the extra |
|
4263 transformations but still leave the library fully capable of reading |
|
4264 and writing PNG files with all known public chunks. Use of the |
|
4265 PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS directive produces a library |
|
4266 that is incapable of reading or writing ancillary chunks. If you are |
|
4267 not using the progressive reading capability, you can turn that off |
|
4268 with PNG_NO_PROGRESSIVE_READ (don't confuse this with the INTERLACING |
|
4269 capability, which you'll still have). |
|
4270 |
|
4271 All the reading and writing specific code are in separate files, so the |
|
4272 linker should only grab the files it needs. However, if you want to |
|
4273 make sure, or if you are building a stand alone library, all the |
|
4274 reading files start with "pngr" and all the writing files start with "pngw". |
|
4275 The files that don't match either (like png.c, pngtrans.c, etc.) |
|
4276 are used for both reading and writing, and always need to be included. |
|
4277 The progressive reader is in pngpread.c |
|
4278 |
|
4279 If you are creating or distributing a dynamically linked library (a .so |
|
4280 or DLL file), you should not remove or disable any parts of the library, |
|
4281 as this will cause applications linked with different versions of the |
|
4282 library to fail if they call functions not available in your library. |
|
4283 The size of the library itself should not be an issue, because only |
|
4284 those sections that are actually used will be loaded into memory. |
|
4285 |
|
4286 Requesting debug printout |
|
4287 |
|
4288 The macro definition PNG_DEBUG can be used to request debugging |
|
4289 printout. Set it to an integer value in the range 0 to 3. Higher |
|
4290 numbers result in increasing amounts of debugging information. The |
|
4291 information is printed to the "stderr" file, unless another file |
|
4292 name is specified in the PNG_DEBUG_FILE macro definition. |
|
4293 |
|
4294 When PNG_DEBUG > 0, the following functions (macros) become available: |
|
4295 |
|
4296 png_debug(level, message) |
|
4297 png_debug1(level, message, p1) |
|
4298 png_debug2(level, message, p1, p2) |
|
4299 |
|
4300 in which "level" is compared to PNG_DEBUG to decide whether to print |
|
4301 the message, "message" is the formatted string to be printed, |
|
4302 and p1 and p2 are parameters that are to be embedded in the string |
|
4303 according to printf-style formatting directives. For example, |
|
4304 |
|
4305 png_debug1(2, "foo=%d", foo); |
|
4306 |
|
4307 is expanded to |
|
4308 |
|
4309 if (PNG_DEBUG > 2) |
|
4310 fprintf(PNG_DEBUG_FILE, "foo=%d\n", foo); |
|
4311 |
|
4312 When PNG_DEBUG is defined but is zero, the macros aren't defined, but you |
|
4313 can still use PNG_DEBUG to control your own debugging: |
|
4314 |
|
4315 #ifdef PNG_DEBUG |
|
4316 fprintf(stderr, ... |
|
4317 #endif |
|
4318 |
|
4319 When PNG_DEBUG = 1, the macros are defined, but only png_debug statements |
|
4320 having level = 0 will be printed. There aren't any such statements in |
|
4321 this version of libpng, but if you insert some they will be printed. |
|
4322 |
|
4323 Prepending a prefix to exported symbols |
|
4324 |
|
4325 Starting with libpng-1.6.0, you can configure libpng (when using the |
|
4326 "configure" script) to prefix all exported symbols by means of the |
|
4327 configuration option "--with-libpng-prefix=FOO_", where FOO_ can be any |
|
4328 string beginning with a letter and containing only uppercase |
|
4329 and lowercase letters, digits, and the underscore (i.e., a C language |
|
4330 identifier). This creates a set of macros in pnglibconf.h, so this is |
|
4331 transparent to applications; their function calls get transformed by |
|
4332 the macros to use the modified names. |
|
4333 |
|
4334 VII. MNG support |
|
4335 |
|
4336 The MNG specification (available at http://www.libpng.org/pub/mng) allows |
|
4337 certain extensions to PNG for PNG images that are embedded in MNG datastreams. |
|
4338 Libpng can support some of these extensions. To enable them, use the |
|
4339 png_permit_mng_features() function: |
|
4340 |
|
4341 feature_set = png_permit_mng_features(png_ptr, mask) |
|
4342 |
|
4343 mask is a png_uint_32 containing the bitwise OR of the |
|
4344 features you want to enable. These include |
|
4345 PNG_FLAG_MNG_EMPTY_PLTE |
|
4346 PNG_FLAG_MNG_FILTER_64 |
|
4347 PNG_ALL_MNG_FEATURES |
|
4348 |
|
4349 feature_set is a png_uint_32 that is the bitwise AND of |
|
4350 your mask with the set of MNG features that is |
|
4351 supported by the version of libpng that you are using. |
|
4352 |
|
4353 It is an error to use this function when reading or writing a standalone |
|
4354 PNG file with the PNG 8-byte signature. The PNG datastream must be wrapped |
|
4355 in a MNG datastream. As a minimum, it must have the MNG 8-byte signature |
|
4356 and the MHDR and MEND chunks. Libpng does not provide support for these |
|
4357 or any other MNG chunks; your application must provide its own support for |
|
4358 them. You may wish to consider using libmng (available at |
|
4359 http://www.libmng.com) instead. |
|
4360 |
|
4361 VIII. Changes to Libpng from version 0.88 |
|
4362 |
|
4363 It should be noted that versions of libpng later than 0.96 are not |
|
4364 distributed by the original libpng author, Guy Schalnat, nor by |
|
4365 Andreas Dilger, who had taken over from Guy during 1996 and 1997, and |
|
4366 distributed versions 0.89 through 0.96, but rather by another member |
|
4367 of the original PNG Group, Glenn Randers-Pehrson. Guy and Andreas are |
|
4368 still alive and well, but they have moved on to other things. |
|
4369 |
|
4370 The old libpng functions png_read_init(), png_write_init(), |
|
4371 png_info_init(), png_read_destroy(), and png_write_destroy() have been |
|
4372 moved to PNG_INTERNAL in version 0.95 to discourage their use. These |
|
4373 functions will be removed from libpng version 1.4.0. |
|
4374 |
|
4375 The preferred method of creating and initializing the libpng structures is |
|
4376 via the png_create_read_struct(), png_create_write_struct(), and |
|
4377 png_create_info_struct() because they isolate the size of the structures |
|
4378 from the application, allow version error checking, and also allow the |
|
4379 use of custom error handling routines during the initialization, which |
|
4380 the old functions do not. The functions png_read_destroy() and |
|
4381 png_write_destroy() do not actually free the memory that libpng |
|
4382 allocated for these structs, but just reset the data structures, so they |
|
4383 can be used instead of png_destroy_read_struct() and |
|
4384 png_destroy_write_struct() if you feel there is too much system overhead |
|
4385 allocating and freeing the png_struct for each image read. |
|
4386 |
|
4387 Setting the error callbacks via png_set_message_fn() before |
|
4388 png_read_init() as was suggested in libpng-0.88 is no longer supported |
|
4389 because this caused applications that do not use custom error functions |
|
4390 to fail if the png_ptr was not initialized to zero. It is still possible |
|
4391 to set the error callbacks AFTER png_read_init(), or to change them with |
|
4392 png_set_error_fn(), which is essentially the same function, but with a new |
|
4393 name to force compilation errors with applications that try to use the old |
|
4394 method. |
|
4395 |
|
4396 Support for the sCAL, iCCP, iTXt, and sPLT chunks was added at libpng-1.0.6; |
|
4397 however, iTXt support was not enabled by default. |
|
4398 |
|
4399 Starting with version 1.0.7, you can find out which version of the library |
|
4400 you are using at run-time: |
|
4401 |
|
4402 png_uint_32 libpng_vn = png_access_version_number(); |
|
4403 |
|
4404 The number libpng_vn is constructed from the major version, minor |
|
4405 version with leading zero, and release number with leading zero, |
|
4406 (e.g., libpng_vn for version 1.0.7 is 10007). |
|
4407 |
|
4408 Note that this function does not take a png_ptr, so you can call it |
|
4409 before you've created one. |
|
4410 |
|
4411 You can also check which version of png.h you used when compiling your |
|
4412 application: |
|
4413 |
|
4414 png_uint_32 application_vn = PNG_LIBPNG_VER; |
|
4415 |
|
4416 IX. Changes to Libpng from version 1.0.x to 1.2.x |
|
4417 |
|
4418 Support for user memory management was enabled by default. To |
|
4419 accomplish this, the functions png_create_read_struct_2(), |
|
4420 png_create_write_struct_2(), png_set_mem_fn(), png_get_mem_ptr(), |
|
4421 png_malloc_default(), and png_free_default() were added. |
|
4422 |
|
4423 Support for the iTXt chunk has been enabled by default as of |
|
4424 version 1.2.41. |
|
4425 |
|
4426 Support for certain MNG features was enabled. |
|
4427 |
|
4428 Support for numbered error messages was added. However, we never got |
|
4429 around to actually numbering the error messages. The function |
|
4430 png_set_strip_error_numbers() was added (Note: the prototype for this |
|
4431 function was inadvertently removed from png.h in PNG_NO_ASSEMBLER_CODE |
|
4432 builds of libpng-1.2.15. It was restored in libpng-1.2.36). |
|
4433 |
|
4434 The png_malloc_warn() function was added at libpng-1.2.3. This issues |
|
4435 a png_warning and returns NULL instead of aborting when it fails to |
|
4436 acquire the requested memory allocation. |
|
4437 |
|
4438 Support for setting user limits on image width and height was enabled |
|
4439 by default. The functions png_set_user_limits(), png_get_user_width_max(), |
|
4440 and png_get_user_height_max() were added at libpng-1.2.6. |
|
4441 |
|
4442 The png_set_add_alpha() function was added at libpng-1.2.7. |
|
4443 |
|
4444 The function png_set_expand_gray_1_2_4_to_8() was added at libpng-1.2.9. |
|
4445 Unlike png_set_gray_1_2_4_to_8(), the new function does not expand the |
|
4446 tRNS chunk to alpha. The png_set_gray_1_2_4_to_8() function is |
|
4447 deprecated. |
|
4448 |
|
4449 A number of macro definitions in support of runtime selection of |
|
4450 assembler code features (especially Intel MMX code support) were |
|
4451 added at libpng-1.2.0: |
|
4452 |
|
4453 PNG_ASM_FLAG_MMX_SUPPORT_COMPILED |
|
4454 PNG_ASM_FLAG_MMX_SUPPORT_IN_CPU |
|
4455 PNG_ASM_FLAG_MMX_READ_COMBINE_ROW |
|
4456 PNG_ASM_FLAG_MMX_READ_INTERLACE |
|
4457 PNG_ASM_FLAG_MMX_READ_FILTER_SUB |
|
4458 PNG_ASM_FLAG_MMX_READ_FILTER_UP |
|
4459 PNG_ASM_FLAG_MMX_READ_FILTER_AVG |
|
4460 PNG_ASM_FLAG_MMX_READ_FILTER_PAETH |
|
4461 PNG_ASM_FLAGS_INITIALIZED |
|
4462 PNG_MMX_READ_FLAGS |
|
4463 PNG_MMX_FLAGS |
|
4464 PNG_MMX_WRITE_FLAGS |
|
4465 PNG_MMX_FLAGS |
|
4466 |
|
4467 We added the following functions in support of runtime |
|
4468 selection of assembler code features: |
|
4469 |
|
4470 png_get_mmx_flagmask() |
|
4471 png_set_mmx_thresholds() |
|
4472 png_get_asm_flags() |
|
4473 png_get_mmx_bitdepth_threshold() |
|
4474 png_get_mmx_rowbytes_threshold() |
|
4475 png_set_asm_flags() |
|
4476 |
|
4477 We replaced all of these functions with simple stubs in libpng-1.2.20, |
|
4478 when the Intel assembler code was removed due to a licensing issue. |
|
4479 |
|
4480 These macros are deprecated: |
|
4481 |
|
4482 PNG_READ_TRANSFORMS_NOT_SUPPORTED |
|
4483 PNG_PROGRESSIVE_READ_NOT_SUPPORTED |
|
4484 PNG_NO_SEQUENTIAL_READ_SUPPORTED |
|
4485 PNG_WRITE_TRANSFORMS_NOT_SUPPORTED |
|
4486 PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED |
|
4487 PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED |
|
4488 |
|
4489 They have been replaced, respectively, by: |
|
4490 |
|
4491 PNG_NO_READ_TRANSFORMS |
|
4492 PNG_NO_PROGRESSIVE_READ |
|
4493 PNG_NO_SEQUENTIAL_READ |
|
4494 PNG_NO_WRITE_TRANSFORMS |
|
4495 PNG_NO_READ_ANCILLARY_CHUNKS |
|
4496 PNG_NO_WRITE_ANCILLARY_CHUNKS |
|
4497 |
|
4498 PNG_MAX_UINT was replaced with PNG_UINT_31_MAX. It has been |
|
4499 deprecated since libpng-1.0.16 and libpng-1.2.6. |
|
4500 |
|
4501 The function |
|
4502 png_check_sig(sig, num) |
|
4503 was replaced with |
|
4504 !png_sig_cmp(sig, 0, num) |
|
4505 It has been deprecated since libpng-0.90. |
|
4506 |
|
4507 The function |
|
4508 png_set_gray_1_2_4_to_8() |
|
4509 which also expands tRNS to alpha was replaced with |
|
4510 png_set_expand_gray_1_2_4_to_8() |
|
4511 which does not. It has been deprecated since libpng-1.0.18 and 1.2.9. |
|
4512 |
|
4513 X. Changes to Libpng from version 1.0.x/1.2.x to 1.4.x |
|
4514 |
|
4515 Private libpng prototypes and macro definitions were moved from |
|
4516 png.h and pngconf.h into a new pngpriv.h header file. |
|
4517 |
|
4518 Functions png_set_benign_errors(), png_benign_error(), and |
|
4519 png_chunk_benign_error() were added. |
|
4520 |
|
4521 Support for setting the maximum amount of memory that the application |
|
4522 will allocate for reading chunks was added, as a security measure. |
|
4523 The functions png_set_chunk_cache_max() and png_get_chunk_cache_max() |
|
4524 were added to the library. |
|
4525 |
|
4526 We implemented support for I/O states by adding png_ptr member io_state |
|
4527 and functions png_get_io_chunk_name() and png_get_io_state() in pngget.c |
|
4528 |
|
4529 We added PNG_TRANSFORM_GRAY_TO_RGB to the available high-level |
|
4530 input transforms. |
|
4531 |
|
4532 Checking for and reporting of errors in the IHDR chunk is more thorough. |
|
4533 |
|
4534 Support for global arrays was removed, to improve thread safety. |
|
4535 |
|
4536 Some obsolete/deprecated macros and functions have been removed. |
|
4537 |
|
4538 Typecasted NULL definitions such as |
|
4539 #define png_voidp_NULL (png_voidp)NULL |
|
4540 were eliminated. If you used these in your application, just use |
|
4541 NULL instead. |
|
4542 |
|
4543 The png_struct and info_struct members "trans" and "trans_values" were |
|
4544 changed to "trans_alpha" and "trans_color", respectively. |
|
4545 |
|
4546 The obsolete, unused pnggccrd.c and pngvcrd.c files and related makefiles |
|
4547 were removed. |
|
4548 |
|
4549 The PNG_1_0_X and PNG_1_2_X macros were eliminated. |
|
4550 |
|
4551 The PNG_LEGACY_SUPPORTED macro was eliminated. |
|
4552 |
|
4553 Many WIN32_WCE #ifdefs were removed. |
|
4554 |
|
4555 The functions png_read_init(info_ptr), png_write_init(info_ptr), |
|
4556 png_info_init(info_ptr), png_read_destroy(), and png_write_destroy() |
|
4557 have been removed. They have been deprecated since libpng-0.95. |
|
4558 |
|
4559 The png_permit_empty_plte() was removed. It has been deprecated |
|
4560 since libpng-1.0.9. Use png_permit_mng_features() instead. |
|
4561 |
|
4562 We removed the obsolete stub functions png_get_mmx_flagmask(), |
|
4563 png_set_mmx_thresholds(), png_get_asm_flags(), |
|
4564 png_get_mmx_bitdepth_threshold(), png_get_mmx_rowbytes_threshold(), |
|
4565 png_set_asm_flags(), and png_mmx_supported() |
|
4566 |
|
4567 We removed the obsolete png_check_sig(), png_memcpy_check(), and |
|
4568 png_memset_check() functions. Instead use !png_sig_cmp(), memcpy(), |
|
4569 and memset(), respectively. |
|
4570 |
|
4571 The function png_set_gray_1_2_4_to_8() was removed. It has been |
|
4572 deprecated since libpng-1.0.18 and 1.2.9, when it was replaced with |
|
4573 png_set_expand_gray_1_2_4_to_8() because the former function also |
|
4574 expanded any tRNS chunk to an alpha channel. |
|
4575 |
|
4576 Macros for png_get_uint_16, png_get_uint_32, and png_get_int_32 |
|
4577 were added and are used by default instead of the corresponding |
|
4578 functions. Unfortunately, |
|
4579 from libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the |
|
4580 function) incorrectly returned a value of type png_uint_32. |
|
4581 |
|
4582 We changed the prototype for png_malloc() from |
|
4583 png_malloc(png_structp png_ptr, png_uint_32 size) |
|
4584 to |
|
4585 png_malloc(png_structp png_ptr, png_alloc_size_t size) |
|
4586 |
|
4587 This also applies to the prototype for the user replacement malloc_fn(). |
|
4588 |
|
4589 The png_calloc() function was added and is used in place of |
|
4590 of "png_malloc(); memset();" except in the case in png_read_png() |
|
4591 where the array consists of pointers; in this case a "for" loop is used |
|
4592 after the png_malloc() to set the pointers to NULL, to give robust. |
|
4593 behavior in case the application runs out of memory part-way through |
|
4594 the process. |
|
4595 |
|
4596 We changed the prototypes of png_get_compression_buffer_size() and |
|
4597 png_set_compression_buffer_size() to work with png_size_t instead of |
|
4598 png_uint_32. |
|
4599 |
|
4600 Support for numbered error messages was removed by default, since we |
|
4601 never got around to actually numbering the error messages. The function |
|
4602 png_set_strip_error_numbers() was removed from the library by default. |
|
4603 |
|
4604 The png_zalloc() and png_zfree() functions are no longer exported. |
|
4605 The png_zalloc() function no longer zeroes out the memory that it |
|
4606 allocates. Applications that called png_zalloc(png_ptr, number, size) |
|
4607 can call png_calloc(png_ptr, number*size) instead, and can call |
|
4608 png_free() instead of png_zfree(). |
|
4609 |
|
4610 Support for dithering was disabled by default in libpng-1.4.0, because |
|
4611 it has not been well tested and doesn't actually "dither". |
|
4612 The code was not |
|
4613 removed, however, and could be enabled by building libpng with |
|
4614 PNG_READ_DITHER_SUPPORTED defined. In libpng-1.4.2, this support |
|
4615 was re-enabled, but the function was renamed png_set_quantize() to |
|
4616 reflect more accurately what it actually does. At the same time, |
|
4617 the PNG_DITHER_[RED,GREEN_BLUE]_BITS macros were also renamed to |
|
4618 PNG_QUANTIZE_[RED,GREEN,BLUE]_BITS, and PNG_READ_DITHER_SUPPORTED |
|
4619 was renamed to PNG_READ_QUANTIZE_SUPPORTED. |
|
4620 |
|
4621 We removed the trailing '.' from the warning and error messages. |
|
4622 |
|
4623 XI. Changes to Libpng from version 1.4.x to 1.5.x |
|
4624 |
|
4625 From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the |
|
4626 function) incorrectly returned a value of type png_uint_32. |
|
4627 The incorrect macro was removed from libpng-1.4.5. |
|
4628 |
|
4629 Checking for invalid palette index on write was added at libpng |
|
4630 1.5.10. If a pixel contains an invalid (out-of-range) index libpng issues |
|
4631 a benign error. This is enabled by default because this condition is an |
|
4632 error according to the PNG specification, Clause 11.3.2, but the error can |
|
4633 be ignored in each png_ptr with |
|
4634 |
|
4635 png_set_check_for_invalid_index(png_ptr, allowed); |
|
4636 |
|
4637 allowed - one of |
|
4638 0: disable benign error (accept the |
|
4639 invalid data without warning). |
|
4640 1: enable benign error (treat the |
|
4641 invalid data as an error or a |
|
4642 warning). |
|
4643 |
|
4644 If the error is ignored, or if png_benign_error() treats it as a warning, |
|
4645 any invalid pixels are decoded as opaque black by the decoder and written |
|
4646 as-is by the encoder. |
|
4647 |
|
4648 Retrieving the maximum palette index found was added at libpng-1.5.15. |
|
4649 This statement must appear after png_read_png() or png_read_image() while |
|
4650 reading, and after png_write_png() or png_write_image() while writing. |
|
4651 |
|
4652 int max_palette = png_get_palette_max(png_ptr, info_ptr); |
|
4653 |
|
4654 This will return the maximum palette index found in the image, or "-1" if |
|
4655 the palette was not checked, or "0" if no palette was found. Note that this |
|
4656 does not account for any palette index used by ancillary chunks such as the |
|
4657 bKGD chunk; you must check those separately to determine the maximum |
|
4658 palette index actually used. |
|
4659 |
|
4660 A. Changes that affect users of libpng |
|
4661 |
|
4662 There are no substantial API changes between the non-deprecated parts of |
|
4663 the 1.4.5 API and the 1.5.0 API; however, the ability to directly access |
|
4664 members of the main libpng control structures, png_struct and png_info, |
|
4665 deprecated in earlier versions of libpng, has been completely removed from |
|
4666 libpng 1.5. |
|
4667 |
|
4668 We no longer include zlib.h in png.h. The include statement has been moved |
|
4669 to pngstruct.h, where it is not accessible by applications. Applications that |
|
4670 need access to information in zlib.h will need to add the '#include "zlib.h"' |
|
4671 directive. It does not matter whether this is placed prior to or after |
|
4672 the '"#include png.h"' directive. |
|
4673 |
|
4674 The png_sprintf(), png_strcpy(), and png_strncpy() macros are no longer used |
|
4675 and were removed. |
|
4676 |
|
4677 We moved the png_strlen(), png_memcpy(), png_memset(), and png_memcmp() |
|
4678 macros into a private header file (pngpriv.h) that is not accessible to |
|
4679 applications. |
|
4680 |
|
4681 In png_get_iCCP, the type of "profile" was changed from png_charpp |
|
4682 to png_bytepp, and in png_set_iCCP, from png_charp to png_const_bytep. |
|
4683 |
|
4684 There are changes of form in png.h, including new and changed macros to |
|
4685 declare parts of the API. Some API functions with arguments that are |
|
4686 pointers to data not modified within the function have been corrected to |
|
4687 declare these arguments with PNG_CONST. |
|
4688 |
|
4689 Much of the internal use of C macros to control the library build has also |
|
4690 changed and some of this is visible in the exported header files, in |
|
4691 particular the use of macros to control data and API elements visible |
|
4692 during application compilation may require significant revision to |
|
4693 application code. (It is extremely rare for an application to do this.) |
|
4694 |
|
4695 Any program that compiled against libpng 1.4 and did not use deprecated |
|
4696 features or access internal library structures should compile and work |
|
4697 against libpng 1.5, except for the change in the prototype for |
|
4698 png_get_iCCP() and png_set_iCCP() API functions mentioned above. |
|
4699 |
|
4700 libpng 1.5.0 adds PNG_ PASS macros to help in the reading and writing of |
|
4701 interlaced images. The macros return the number of rows and columns in |
|
4702 each pass and information that can be used to de-interlace and (if |
|
4703 absolutely necessary) interlace an image. |
|
4704 |
|
4705 libpng 1.5.0 adds an API png_longjmp(png_ptr, value). This API calls |
|
4706 the application-provided png_longjmp_ptr on the internal, but application |
|
4707 initialized, longjmp buffer. It is provided as a convenience to avoid |
|
4708 the need to use the png_jmpbuf macro, which had the unnecessary side |
|
4709 effect of resetting the internal png_longjmp_ptr value. |
|
4710 |
|
4711 libpng 1.5.0 includes a complete fixed point API. By default this is |
|
4712 present along with the corresponding floating point API. In general the |
|
4713 fixed point API is faster and smaller than the floating point one because |
|
4714 the PNG file format used fixed point, not floating point. This applies |
|
4715 even if the library uses floating point in internal calculations. A new |
|
4716 macro, PNG_FLOATING_ARITHMETIC_SUPPORTED, reveals whether the library |
|
4717 uses floating point arithmetic (the default) or fixed point arithmetic |
|
4718 internally for performance critical calculations such as gamma correction. |
|
4719 In some cases, the gamma calculations may produce slightly different |
|
4720 results. This has changed the results in png_rgb_to_gray and in alpha |
|
4721 composition (png_set_background for example). This applies even if the |
|
4722 original image was already linear (gamma == 1.0) and, therefore, it is |
|
4723 not necessary to linearize the image. This is because libpng has *not* |
|
4724 been changed to optimize that case correctly, yet. |
|
4725 |
|
4726 Fixed point support for the sCAL chunk comes with an important caveat; |
|
4727 the sCAL specification uses a decimal encoding of floating point values |
|
4728 and the accuracy of PNG fixed point values is insufficient for |
|
4729 representation of these values. Consequently a "string" API |
|
4730 (png_get_sCAL_s and png_set_sCAL_s) is the only reliable way of reading |
|
4731 arbitrary sCAL chunks in the absence of either the floating point API or |
|
4732 internal floating point calculations. Starting with libpng-1.5.0, both |
|
4733 of these functions are present when PNG_sCAL_SUPPORTED is defined. Prior |
|
4734 to libpng-1.5.0, their presence also depended upon PNG_FIXED_POINT_SUPPORTED |
|
4735 being defined and PNG_FLOATING_POINT_SUPPORTED not being defined. |
|
4736 |
|
4737 Applications no longer need to include the optional distribution header |
|
4738 file pngusr.h or define the corresponding macros during application |
|
4739 build in order to see the correct variant of the libpng API. From 1.5.0 |
|
4740 application code can check for the corresponding _SUPPORTED macro: |
|
4741 |
|
4742 #ifdef PNG_INCH_CONVERSIONS_SUPPORTED |
|
4743 /* code that uses the inch conversion APIs. */ |
|
4744 #endif |
|
4745 |
|
4746 This macro will only be defined if the inch conversion functions have been |
|
4747 compiled into libpng. The full set of macros, and whether or not support |
|
4748 has been compiled in, are available in the header file pnglibconf.h. |
|
4749 This header file is specific to the libpng build. Notice that prior to |
|
4750 1.5.0 the _SUPPORTED macros would always have the default definition unless |
|
4751 reset by pngusr.h or by explicit settings on the compiler command line. |
|
4752 These settings may produce compiler warnings or errors in 1.5.0 because |
|
4753 of macro redefinition. |
|
4754 |
|
4755 Applications can now choose whether to use these macros or to call the |
|
4756 corresponding function by defining PNG_USE_READ_MACROS or |
|
4757 PNG_NO_USE_READ_MACROS before including png.h. Notice that this is |
|
4758 only supported from 1.5.0; defining PNG_NO_USE_READ_MACROS prior to 1.5.0 |
|
4759 will lead to a link failure. |
|
4760 |
|
4761 Prior to libpng-1.5.4, the zlib compressor used the same set of parameters |
|
4762 when compressing the IDAT data and textual data such as zTXt and iCCP. |
|
4763 In libpng-1.5.4 we reinitialized the zlib stream for each type of data. |
|
4764 We added five png_set_text_*() functions for setting the parameters to |
|
4765 use with textual data. |
|
4766 |
|
4767 Prior to libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED |
|
4768 option was off by default, and slightly inaccurate scaling occurred. |
|
4769 This option can no longer be turned off, and the choice of accurate |
|
4770 or inaccurate 16-to-8 scaling is by using the new png_set_scale_16_to_8() |
|
4771 API for accurate scaling or the old png_set_strip_16_to_8() API for simple |
|
4772 chopping. In libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED |
|
4773 macro became PNG_READ_SCALE_16_TO_8_SUPPORTED, and the PNG_READ_16_TO_8 |
|
4774 macro became PNG_READ_STRIP_16_TO_8_SUPPORTED, to enable the two |
|
4775 png_set_*_16_to_8() functions separately. |
|
4776 |
|
4777 Prior to libpng-1.5.4, the png_set_user_limits() function could only be |
|
4778 used to reduce the width and height limits from the value of |
|
4779 PNG_USER_WIDTH_MAX and PNG_USER_HEIGHT_MAX, although this document said |
|
4780 that it could be used to override them. Now this function will reduce or |
|
4781 increase the limits. |
|
4782 |
|
4783 Starting in libpng-1.5.10, the user limits can be set en masse with the |
|
4784 configuration option PNG_SAFE_LIMITS_SUPPORTED. If this option is enabled, |
|
4785 a set of "safe" limits is applied in pngpriv.h. These can be overridden by |
|
4786 application calls to png_set_user_limits(), png_set_user_chunk_cache_max(), |
|
4787 and/or png_set_user_malloc_max() that increase or decrease the limits. Also, |
|
4788 in libpng-1.5.10 the default width and height limits were increased |
|
4789 from 1,000,000 to 0x7ffffff (i.e., made unlimited). Therefore, the |
|
4790 limits are now |
|
4791 default safe |
|
4792 png_user_width_max 0x7fffffff 1,000,000 |
|
4793 png_user_height_max 0x7fffffff 1,000,000 |
|
4794 png_user_chunk_cache_max 0 (unlimited) 128 |
|
4795 png_user_chunk_malloc_max 0 (unlimited) 8,000,000 |
|
4796 |
|
4797 The png_set_option() function (and the "options" member of the png struct) was |
|
4798 added to libpng-1.5.15. |
|
4799 |
|
4800 B. Changes to the build and configuration of libpng |
|
4801 |
|
4802 Details of internal changes to the library code can be found in the CHANGES |
|
4803 file and in the GIT repository logs. These will be of no concern to the vast |
|
4804 majority of library users or builders; however, the few who configure libpng |
|
4805 to a non-default feature set may need to change how this is done. |
|
4806 |
|
4807 There should be no need for library builders to alter build scripts if |
|
4808 these use the distributed build support - configure or the makefiles - |
|
4809 however, users of the makefiles may care to update their build scripts |
|
4810 to build pnglibconf.h where the corresponding makefile does not do so. |
|
4811 |
|
4812 Building libpng with a non-default configuration has changed completely. |
|
4813 The old method using pngusr.h should still work correctly even though the |
|
4814 way pngusr.h is used in the build has been changed; however, library |
|
4815 builders will probably want to examine the changes to take advantage of |
|
4816 new capabilities and to simplify their build system. |
|
4817 |
|
4818 B.1 Specific changes to library configuration capabilities |
|
4819 |
|
4820 The library now supports a complete fixed point implementation and can |
|
4821 thus be used on systems that have no floating point support or very |
|
4822 limited or slow support. Previously gamma correction, an essential part |
|
4823 of complete PNG support, required reasonably fast floating point. |
|
4824 |
|
4825 As part of this the choice of internal implementation has been made |
|
4826 independent of the choice of fixed versus floating point APIs and all the |
|
4827 missing fixed point APIs have been implemented. |
|
4828 |
|
4829 The exact mechanism used to control attributes of API functions has |
|
4830 changed. A single set of operating system independent macro definitions |
|
4831 is used and operating system specific directives are defined in |
|
4832 pnglibconf.h |
|
4833 |
|
4834 As part of this the mechanism used to choose procedure call standards on |
|
4835 those systems that allow a choice has been changed. At present this only |
|
4836 affects certain Microsoft (DOS, Windows) and IBM (OS/2) operating systems |
|
4837 running on Intel processors. As before, PNGAPI is defined where required |
|
4838 to control the exported API functions; however, two new macros, PNGCBAPI |
|
4839 and PNGCAPI, are used instead for callback functions (PNGCBAPI) and |
|
4840 (PNGCAPI) for functions that must match a C library prototype (currently |
|
4841 only png_longjmp_ptr, which must match the C longjmp function.) The new |
|
4842 approach is documented in pngconf.h |
|
4843 |
|
4844 Despite these changes, libpng 1.5.0 only supports the native C function |
|
4845 calling standard on those platforms tested so far (__cdecl on Microsoft |
|
4846 Windows). This is because the support requirements for alternative |
|
4847 calling conventions seem to no longer exist. Developers who find it |
|
4848 necessary to set PNG_API_RULE to 1 should advise the mailing list |
|
4849 (png-mng-implement) of this and library builders who use Openwatcom and |
|
4850 therefore set PNG_API_RULE to 2 should also contact the mailing list. |
|
4851 |
|
4852 A new test program, pngvalid, is provided in addition to pngtest. |
|
4853 pngvalid validates the arithmetic accuracy of the gamma correction |
|
4854 calculations and includes a number of validations of the file format. |
|
4855 A subset of the full range of tests is run when "make check" is done |
|
4856 (in the 'configure' build.) pngvalid also allows total allocated memory |
|
4857 usage to be evaluated and performs additional memory overwrite validation. |
|
4858 |
|
4859 Many changes to individual feature macros have been made. The following |
|
4860 are the changes most likely to be noticed by library builders who |
|
4861 configure libpng: |
|
4862 |
|
4863 1) All feature macros now have consistent naming: |
|
4864 |
|
4865 #define PNG_NO_feature turns the feature off |
|
4866 #define PNG_feature_SUPPORTED turns the feature on |
|
4867 |
|
4868 pnglibconf.h contains one line for each feature macro which is either: |
|
4869 |
|
4870 #define PNG_feature_SUPPORTED |
|
4871 |
|
4872 if the feature is supported or: |
|
4873 |
|
4874 /*#undef PNG_feature_SUPPORTED*/ |
|
4875 |
|
4876 if it is not. Library code consistently checks for the 'SUPPORTED' macro. |
|
4877 It does not, and libpng applications should not, check for the 'NO' macro |
|
4878 which will not normally be defined even if the feature is not supported. |
|
4879 The 'NO' macros are only used internally for setting or not setting the |
|
4880 corresponding 'SUPPORTED' macros. |
|
4881 |
|
4882 Compatibility with the old names is provided as follows: |
|
4883 |
|
4884 PNG_INCH_CONVERSIONS turns on PNG_INCH_CONVERSIONS_SUPPORTED |
|
4885 |
|
4886 And the following definitions disable the corresponding feature: |
|
4887 |
|
4888 PNG_SETJMP_NOT_SUPPORTED disables SETJMP |
|
4889 PNG_READ_TRANSFORMS_NOT_SUPPORTED disables READ_TRANSFORMS |
|
4890 PNG_NO_READ_COMPOSITED_NODIV disables READ_COMPOSITE_NODIV |
|
4891 PNG_WRITE_TRANSFORMS_NOT_SUPPORTED disables WRITE_TRANSFORMS |
|
4892 PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED disables READ_ANCILLARY_CHUNKS |
|
4893 PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED disables WRITE_ANCILLARY_CHUNKS |
|
4894 |
|
4895 Library builders should remove use of the above, inconsistent, names. |
|
4896 |
|
4897 2) Warning and error message formatting was previously conditional on |
|
4898 the STDIO feature. The library has been changed to use the |
|
4899 CONSOLE_IO feature instead. This means that if CONSOLE_IO is disabled |
|
4900 the library no longer uses the printf(3) functions, even though the |
|
4901 default read/write implementations use (FILE) style stdio.h functions. |
|
4902 |
|
4903 3) Three feature macros now control the fixed/floating point decisions: |
|
4904 |
|
4905 PNG_FLOATING_POINT_SUPPORTED enables the floating point APIs |
|
4906 |
|
4907 PNG_FIXED_POINT_SUPPORTED enables the fixed point APIs; however, in |
|
4908 practice these are normally required internally anyway (because the PNG |
|
4909 file format is fixed point), therefore in most cases PNG_NO_FIXED_POINT |
|
4910 merely stops the function from being exported. |
|
4911 |
|
4912 PNG_FLOATING_ARITHMETIC_SUPPORTED chooses between the internal floating |
|
4913 point implementation or the fixed point one. Typically the fixed point |
|
4914 implementation is larger and slower than the floating point implementation |
|
4915 on a system that supports floating point; however, it may be faster on a |
|
4916 system which lacks floating point hardware and therefore uses a software |
|
4917 emulation. |
|
4918 |
|
4919 4) Added PNG_{READ,WRITE}_INT_FUNCTIONS_SUPPORTED. This allows the |
|
4920 functions to read and write ints to be disabled independently of |
|
4921 PNG_USE_READ_MACROS, which allows libpng to be built with the functions |
|
4922 even though the default is to use the macros - this allows applications |
|
4923 to choose at app buildtime whether or not to use macros (previously |
|
4924 impossible because the functions weren't in the default build.) |
|
4925 |
|
4926 B.2 Changes to the configuration mechanism |
|
4927 |
|
4928 Prior to libpng-1.5.0 library builders who needed to configure libpng |
|
4929 had either to modify the exported pngconf.h header file to add system |
|
4930 specific configuration or had to write feature selection macros into |
|
4931 pngusr.h and cause this to be included into pngconf.h by defining |
|
4932 PNG_USER_CONFIG. The latter mechanism had the disadvantage that an |
|
4933 application built without PNG_USER_CONFIG defined would see the |
|
4934 unmodified, default, libpng API and thus would probably fail to link. |
|
4935 |
|
4936 These mechanisms still work in the configure build and in any makefile |
|
4937 build that builds pnglibconf.h, although the feature selection macros |
|
4938 have changed somewhat as described above. In 1.5.0, however, pngusr.h is |
|
4939 processed only once, when the exported header file pnglibconf.h is built. |
|
4940 pngconf.h no longer includes pngusr.h, therefore pngusr.h is ignored after the |
|
4941 build of pnglibconf.h and it is never included in an application build. |
|
4942 |
|
4943 The rarely used alternative of adding a list of feature macros to the |
|
4944 CFLAGS setting in the build also still works; however, the macros will be |
|
4945 copied to pnglibconf.h and this may produce macro redefinition warnings |
|
4946 when the individual C files are compiled. |
|
4947 |
|
4948 All configuration now only works if pnglibconf.h is built from |
|
4949 scripts/pnglibconf.dfa. This requires the program awk. Brian Kernighan |
|
4950 (the original author of awk) maintains C source code of that awk and this |
|
4951 and all known later implementations (often called by subtly different |
|
4952 names - nawk and gawk for example) are adequate to build pnglibconf.h. |
|
4953 The Sun Microsystems (now Oracle) program 'awk' is an earlier version |
|
4954 and does not work; this may also apply to other systems that have a |
|
4955 functioning awk called 'nawk'. |
|
4956 |
|
4957 Configuration options are now documented in scripts/pnglibconf.dfa. This |
|
4958 file also includes dependency information that ensures a configuration is |
|
4959 consistent; that is, if a feature is switched off dependent features are |
|
4960 also removed. As a recommended alternative to using feature macros in |
|
4961 pngusr.h a system builder may also define equivalent options in pngusr.dfa |
|
4962 (or, indeed, any file) and add that to the configuration by setting |
|
4963 DFA_XTRA to the file name. The makefiles in contrib/pngminim illustrate |
|
4964 how to do this, and a case where pngusr.h is still required. |
|
4965 |
|
4966 XII. Changes to Libpng from version 1.5.x to 1.6.x |
|
4967 |
|
4968 A "simplified API" has been added (see documentation in png.h and a simple |
|
4969 example in contrib/examples/pngtopng.c). The new publicly visible API |
|
4970 includes the following: |
|
4971 |
|
4972 macros: |
|
4973 PNG_FORMAT_* |
|
4974 PNG_IMAGE_* |
|
4975 structures: |
|
4976 png_control |
|
4977 png_image |
|
4978 read functions |
|
4979 png_image_begin_read_from_file() |
|
4980 png_image_begin_read_from_stdio() |
|
4981 png_image_begin_read_from_memory() |
|
4982 png_image_finish_read() |
|
4983 png_image_free() |
|
4984 write functions |
|
4985 png_image_write_to_file() |
|
4986 png_image_write_to_stdio() |
|
4987 |
|
4988 Starting with libpng-1.6.0, you can configure libpng to prefix all exported |
|
4989 symbols, using the PNG_PREFIX macro. |
|
4990 |
|
4991 We no longer include string.h in png.h. The include statement has been moved |
|
4992 to pngpriv.h, where it is not accessible by applications. Applications that |
|
4993 need access to information in string.h must add an '#include <string.h>' |
|
4994 directive. It does not matter whether this is placed prior to or after |
|
4995 the '#include "png.h"' directive. |
|
4996 |
|
4997 The following API are now DEPRECATED: |
|
4998 png_info_init_3() |
|
4999 png_convert_to_rfc1123() which has been replaced |
|
5000 with png_convert_to_rfc1123_buffer() |
|
5001 png_data_freer() |
|
5002 png_malloc_default() |
|
5003 png_free_default() |
|
5004 png_reset_zstream() |
|
5005 |
|
5006 The following have been removed: |
|
5007 png_get_io_chunk_name(), which has been replaced |
|
5008 with png_get_io_chunk_type(). The new |
|
5009 function returns a 32-bit integer instead of |
|
5010 a string. |
|
5011 The png_sizeof(), png_strlen(), png_memcpy(), png_memcmp(), and |
|
5012 png_memset() macros are no longer used in the libpng sources and |
|
5013 have been removed. These had already been made invisible to applications |
|
5014 (i.e., defined in the private pngpriv.h header file) since libpng-1.5.0. |
|
5015 |
|
5016 The signatures of many exported functions were changed, such that |
|
5017 png_structp became png_structrp or png_const_structrp |
|
5018 png_infop became png_inforp or png_const_inforp |
|
5019 where "rp" indicates a "restricted pointer". |
|
5020 |
|
5021 Error detection in some chunks has improved; in particular the iCCP chunk |
|
5022 reader now does pretty complete validation of the basic format. Some bad |
|
5023 profiles that were previously accepted are now accepted with a warning or |
|
5024 rejected, depending upon the png_set_benign_errors() setting, in particular the |
|
5025 very old broken Microsoft/HP 3144-byte sRGB profile. The PNG spec requirement |
|
5026 that only grayscale profiles may appear in images with color type 0 or 4 and |
|
5027 that even if the image only contains gray pixels, only RGB profiles may appear |
|
5028 in images with color type 2, 3, or 6, is now enforced. The sRGB chunk |
|
5029 is allowed to appear in images with any color type. |
|
5030 |
|
5031 Prior to libpng-1.6.0 a warning would be issued if the iTXt chunk contained |
|
5032 an empty language field or an empty translated keyword. Both of these |
|
5033 are allowed by the PNG specification, so these warnings are no longer issued. |
|
5034 |
|
5035 The library now issues an error if the application attempts to set a |
|
5036 transform after it calls png_read_update_info() or if it attempts to call |
|
5037 both png_read_update_info() and png_start_read_image() or to call either |
|
5038 of them more than once. |
|
5039 |
|
5040 The default condition for benign_errors is now to treat benign errors as |
|
5041 warnings while reading and as errors while writing. |
|
5042 |
|
5043 The library now issues a warning if both background processing and RGB to |
|
5044 gray are used when gamma correction happens. As with previous versions of |
|
5045 the library the results are numerically very incorrect in this case. |
|
5046 |
|
5047 There are some minor arithmetic changes in some transforms such as |
|
5048 png_set_background(), that might be detected by certain regression tests. |
|
5049 |
|
5050 Unknown chunk handling has been improved internally, without any API change. |
|
5051 This adds more correct option control of the unknown handling, corrects |
|
5052 a pre-existing bug where the per-chunk 'keep' setting is ignored, and makes |
|
5053 it possible to skip IDAT chunks in the sequential reader. |
|
5054 |
|
5055 The machine-generated configure files are no longer included in branches |
|
5056 libpng16 and later of the GIT repository. They continue to be included |
|
5057 in the tarball releases, however. |
|
5058 |
|
5059 Libpng-1.6.0 through 1.6.2 used the CMF bytes at the beginning of the IDAT |
|
5060 stream to set the size of the sliding window for reading instead of using the |
|
5061 default 32-kbyte sliding window size. It was discovered that there are |
|
5062 hundreds of PNG files in the wild that have incorrect CMF bytes that caused |
|
5063 libpng to issue a "too far back" error and reject the file. Libpng-1.6.3 and |
|
5064 later calculate their own safe CMF from the image dimensions, provide a way |
|
5065 to revert to the libpng-1.5.x behavior (ignoring the CMF bytes and using a |
|
5066 32-kbyte sliding window), by using |
|
5067 |
|
5068 png_set_option(png_ptr, PNG_MAXIMUM_INFLATE_WINDOW, |
|
5069 PNG_OPTION_ON); |
|
5070 |
|
5071 and provide a tool (contrib/tools/pngfix) for optimizing the CMF bytes |
|
5072 correctly. |
|
5073 |
|
5074 Libpng-1.6.0 and libpng-1.6.1 wrote uncompressed iTXt chunks with the wrong |
|
5075 length, which resulted in PNG files that cannot be read beyond the bad iTXt |
|
5076 chunk. This error was fixed in libpng-1.6.3, and a tool (called |
|
5077 contrib/tools/png-fix-itxt) has been added to the libpng distribution. |
|
5078 |
|
5079 XIII. Detecting libpng |
|
5080 |
|
5081 The png_get_io_ptr() function has been present since libpng-0.88, has never |
|
5082 changed, and is unaffected by conditional compilation macros. It is the |
|
5083 best choice for use in configure scripts for detecting the presence of any |
|
5084 libpng version since 0.88. In an autoconf "configure.in" you could use |
|
5085 |
|
5086 AC_CHECK_LIB(png, png_get_io_ptr, ... |
|
5087 |
|
5088 XV. Source code repository |
|
5089 |
|
5090 Since about February 2009, version 1.2.34, libpng has been under "git" source |
|
5091 control. The git repository was built from old libpng-x.y.z.tar.gz files |
|
5092 going back to version 0.70. You can access the git repository (read only) |
|
5093 at |
|
5094 |
|
5095 git://git.code.sf.net/p/libpng/code |
|
5096 |
|
5097 or you can browse it with a web browser by selecting the "code" button at |
|
5098 |
|
5099 https://sourceforge.net/projects/libpng |
|
5100 |
|
5101 Patches can be sent to glennrp at users.sourceforge.net or to |
|
5102 png-mng-implement at lists.sourceforge.net or you can upload them to |
|
5103 the libpng bug tracker at |
|
5104 |
|
5105 http://libpng.sourceforge.net |
|
5106 |
|
5107 We also accept patches built from the tar or zip distributions, and |
|
5108 simple verbal discriptions of bug fixes, reported either to the |
|
5109 SourceForge bug tracker, to the png-mng-implement at lists.sf.net |
|
5110 mailing list, or directly to glennrp. |
|
5111 |
|
5112 XV. Coding style |
|
5113 |
|
5114 Our coding style is similar to the "Allman" style, with curly |
|
5115 braces on separate lines: |
|
5116 |
|
5117 if (condition) |
|
5118 { |
|
5119 action; |
|
5120 } |
|
5121 |
|
5122 else if (another condition) |
|
5123 { |
|
5124 another action; |
|
5125 } |
|
5126 |
|
5127 The braces can be omitted from simple one-line actions: |
|
5128 |
|
5129 if (condition) |
|
5130 return (0); |
|
5131 |
|
5132 We use 3-space indentation, except for continued statements which |
|
5133 are usually indented the same as the first line of the statement |
|
5134 plus four more spaces. |
|
5135 |
|
5136 For macro definitions we use 2-space indentation, always leaving the "#" |
|
5137 in the first column. |
|
5138 |
|
5139 #ifndef PNG_NO_FEATURE |
|
5140 # ifndef PNG_FEATURE_SUPPORTED |
|
5141 # define PNG_FEATURE_SUPPORTED |
|
5142 # endif |
|
5143 #endif |
|
5144 |
|
5145 Comments appear with the leading "/*" at the same indentation as |
|
5146 the statement that follows the comment: |
|
5147 |
|
5148 /* Single-line comment */ |
|
5149 statement; |
|
5150 |
|
5151 /* This is a multiple-line |
|
5152 * comment. |
|
5153 */ |
|
5154 statement; |
|
5155 |
|
5156 Very short comments can be placed after the end of the statement |
|
5157 to which they pertain: |
|
5158 |
|
5159 statement; /* comment */ |
|
5160 |
|
5161 We don't use C++ style ("//") comments. We have, however, |
|
5162 used them in the past in some now-abandoned MMX assembler |
|
5163 code. |
|
5164 |
|
5165 Functions and their curly braces are not indented, and |
|
5166 exported functions are marked with PNGAPI: |
|
5167 |
|
5168 /* This is a public function that is visible to |
|
5169 * application programmers. It does thus-and-so. |
|
5170 */ |
|
5171 void PNGAPI |
|
5172 png_exported_function(png_ptr, png_info, foo) |
|
5173 { |
|
5174 body; |
|
5175 } |
|
5176 |
|
5177 The prototypes for all exported functions appear in png.h, |
|
5178 above the comment that says |
|
5179 |
|
5180 /* Maintainer: Put new public prototypes here ... */ |
|
5181 |
|
5182 We mark all non-exported functions with "/* PRIVATE */"": |
|
5183 |
|
5184 void /* PRIVATE */ |
|
5185 png_non_exported_function(png_ptr, png_info, foo) |
|
5186 { |
|
5187 body; |
|
5188 } |
|
5189 |
|
5190 The prototypes for non-exported functions (except for those in |
|
5191 pngtest) appear in |
|
5192 pngpriv.h |
|
5193 above the comment that says |
|
5194 |
|
5195 /* Maintainer: Put new private prototypes here ^ */ |
|
5196 |
|
5197 We put a space after the "sizeof" operator and we omit the |
|
5198 optional parentheses around its argument when the argument |
|
5199 is an expression, not a type name, and we always enclose the |
|
5200 sizeof operator, with its argument, in parentheses: |
|
5201 |
|
5202 (sizeof (png_uint_32)) |
|
5203 (sizeof array) |
|
5204 |
|
5205 Prior to libpng-1.6.0 we used a "png_sizeof()" macro, formatted as |
|
5206 though it were a function. |
|
5207 |
|
5208 To avoid polluting the global namespace, the names of all exported |
|
5209 functions and variables begin with "png_", and all publicly visible C |
|
5210 preprocessor macros begin with "PNG". We request that applications that |
|
5211 use libpng *not* begin any of their own symbols with either of these strings. |
|
5212 |
|
5213 We put a space after each comma and after each semicolon |
|
5214 in "for" statements, and we put spaces before and after each |
|
5215 C binary operator and after "for" or "while", and before |
|
5216 "?". We don't put a space between a typecast and the expression |
|
5217 being cast, nor do we put one between a function name and the |
|
5218 left parenthesis that follows it: |
|
5219 |
|
5220 for (i = 2; i > 0; --i) |
|
5221 y[i] = a(x) + (int)b; |
|
5222 |
|
5223 We prefer #ifdef and #ifndef to #if defined() and #if !defined() |
|
5224 when there is only one macro being tested. We always use parentheses |
|
5225 with "defined". |
|
5226 |
|
5227 We prefer to express integers that are used as bit masks in hex format, |
|
5228 with an even number of lower-case hex digits (e.g., 0x00, 0xff, 0x0100). |
|
5229 |
|
5230 We prefer to use underscores in variable names rather than camelCase, except |
|
5231 for a few type names that we inherit from zlib.h. |
|
5232 |
|
5233 We do not use the TAB character for indentation in the C sources. |
|
5234 |
|
5235 Lines do not exceed 80 characters. |
|
5236 |
|
5237 Other rules can be inferred by inspecting the libpng source. |
|
5238 |
|
5239 XVI. Y2K Compliance in libpng |
|
5240 |
|
5241 February 6, 2014 |
|
5242 |
|
5243 Since the PNG Development group is an ad-hoc body, we can't make |
|
5244 an official declaration. |
|
5245 |
|
5246 This is your unofficial assurance that libpng from version 0.71 and |
|
5247 upward through 1.6.9 are Y2K compliant. It is my belief that earlier |
|
5248 versions were also Y2K compliant. |
|
5249 |
|
5250 Libpng only has two year fields. One is a 2-byte unsigned integer |
|
5251 that will hold years up to 65535. The other, which is deprecated, |
|
5252 holds the date in text format, and will hold years up to 9999. |
|
5253 |
|
5254 The integer is |
|
5255 "png_uint_16 year" in png_time_struct. |
|
5256 |
|
5257 The string is |
|
5258 "char time_buffer[29]" in png_struct. This is no longer used |
|
5259 in libpng-1.6.x and will be removed from libpng-1.7.0. |
|
5260 |
|
5261 There are seven time-related functions: |
|
5262 |
|
5263 png_convert_to_rfc_1123() in png.c |
|
5264 (formerly png_convert_to_rfc_1152() in error) |
|
5265 png_convert_from_struct_tm() in pngwrite.c, called |
|
5266 in pngwrite.c |
|
5267 png_convert_from_time_t() in pngwrite.c |
|
5268 png_get_tIME() in pngget.c |
|
5269 png_handle_tIME() in pngrutil.c, called in pngread.c |
|
5270 png_set_tIME() in pngset.c |
|
5271 png_write_tIME() in pngwutil.c, called in pngwrite.c |
|
5272 |
|
5273 All appear to handle dates properly in a Y2K environment. The |
|
5274 png_convert_from_time_t() function calls gmtime() to convert from system |
|
5275 clock time, which returns (year - 1900), which we properly convert to |
|
5276 the full 4-digit year. There is a possibility that applications using |
|
5277 libpng are not passing 4-digit years into the png_convert_to_rfc_1123() |
|
5278 function, or that they are incorrectly passing only a 2-digit year |
|
5279 instead of "year - 1900" into the png_convert_from_struct_tm() function, |
|
5280 but this is not under our control. The libpng documentation has always |
|
5281 stated that it works with 4-digit years, and the APIs have been |
|
5282 documented as such. |
|
5283 |
|
5284 The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned |
|
5285 integer to hold the year, and can hold years as large as 65535. |
|
5286 |
|
5287 zlib, upon which libpng depends, is also Y2K compliant. It contains |
|
5288 no date-related code. |
|
5289 |
|
5290 |
|
5291 Glenn Randers-Pehrson |
|
5292 libpng maintainer |
|
5293 PNG Development Group |