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