Glenn Randers-Pehrson | 08a3343 | 1998-03-07 06:06:55 -0600 | [diff] [blame] | 1 | |
Glenn Randers-Pehrson | 860ab2b | 1999-10-14 07:43:10 -0500 | [diff] [blame] | 2 | #if 0 /* in case someone actually tries to compile this */ |
| 3 | |
Glenn Randers-Pehrson | b7f9593 | 2006-03-05 20:15:20 -0600 | [diff] [blame] | 4 | /* example.c - an example of using libpng |
Glenn Randers-Pehrson | 13831bc | 2011-12-21 08:28:28 -0600 | [diff] [blame] | 5 | * Last changed in libpng 1.6.0 [(PENDING RELEASE)] |
Glenn Randers-Pehrson | 1531bd6 | 2012-01-01 14:45:04 -0600 | [diff] [blame] | 6 | * Maintained 1998-2012 Glenn Randers-Pehrson |
Glenn Randers-Pehrson | b7f9593 | 2006-03-05 20:15:20 -0600 | [diff] [blame] | 7 | * Maintained 1996, 1997 Andreas Dilger) |
| 8 | * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.) |
Glenn Randers-Pehrson | 2ddb252 | 2011-11-25 07:27:51 -0600 | [diff] [blame] | 9 | * To the extent possible under law, the authors have waived |
| 10 | * all copyright and related or neighboring rights to this file. |
| 11 | * This work is published from: United States. |
Glenn Randers-Pehrson | b7f9593 | 2006-03-05 20:15:20 -0600 | [diff] [blame] | 12 | */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 13 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 14 | /* This is an example of how to use libpng to read and write PNG files. |
Glenn Randers-Pehrson | f3abb2c | 2010-10-17 12:51:53 -0500 | [diff] [blame] | 15 | * The file libpng-manual.txt is much more verbose then this. If you have not |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 16 | * read it, do so first. This was designed to be a starting point of an |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 17 | * implementation. This is not officially part of libpng, is hereby placed |
| 18 | * in the public domain, and therefore does not require a copyright notice. |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 19 | * |
| 20 | * This file does not currently compile, because it is missing certain |
| 21 | * parts, like allocating memory to hold an image. You will have to |
| 22 | * supply these parts to get it to compile. For an example of a minimal |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 23 | * working PNG reader/writer, see pngtest.c, included in this distribution; |
| 24 | * see also the programs in the contrib directory. |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 25 | */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 26 | |
Glenn Randers-Pehrson | 7455cbf | 2011-11-24 14:40:36 -0600 | [diff] [blame] | 27 | /* The simple, but restricted, approach to reading a PNG file or data stream |
| 28 | * just requires two function calls, as in the following complete program. |
| 29 | * Writing a file just needs one function call, so long as the data has an |
| 30 | * appropriate layout. |
| 31 | * |
| 32 | * The following code reads PNG image data from a file and writes it, in a |
| 33 | * potentially new format, to a new file. While this code will compile there is |
| 34 | * minimal (insufficient) error checking; for a more realistic version look at |
| 35 | * contrib/examples/pngtopng.c |
| 36 | */ |
| 37 | #include <stddef.h> |
| 38 | #include <stdlib.h> |
| 39 | #include <string.h> |
| 40 | #include <stdio.h> |
| 41 | #include <png.h> |
John Bowler | 5d56786 | 2011-12-24 09:12:00 -0600 | [diff] [blame] | 42 | #include <zlib.h> |
Glenn Randers-Pehrson | e1018a5 | 2011-05-05 21:03:07 -0500 | [diff] [blame] | 43 | |
Glenn Randers-Pehrson | 7455cbf | 2011-11-24 14:40:36 -0600 | [diff] [blame] | 44 | int main(int argc, const char **argv) |
| 45 | { |
| 46 | if (argc == 3) |
| 47 | { |
| 48 | png_image image; /* The control structure used by libpng */ |
| 49 | |
| 50 | /* Initialize the 'png_image' structure. */ |
| 51 | memset(&image, 0, sizeof image); |
| 52 | |
| 53 | /* The first argument is the file to read: */ |
| 54 | if (png_image_begin_read_from_file(&image, argv[1])) |
| 55 | { |
| 56 | png_bytep buffer; |
| 57 | |
| 58 | /* Set the format in which to read the PNG file; this code chooses a |
| 59 | * simple sRGB format with a non-associated alpha channel, adequate to |
| 60 | * store most images. |
| 61 | */ |
| 62 | image.format = PNG_FORMAT_RGBA; |
| 63 | |
| 64 | /* Now allocate enough memory to hold the image in this format; the |
| 65 | * PNG_IMAGE_SIZE macro uses the information about the image (width, |
| 66 | * height and format) stored in 'image'. |
| 67 | */ |
| 68 | buffer = malloc(PNG_IMAGE_SIZE(image)); |
| 69 | |
| 70 | /* If enough memory was available read the image in the desired format |
| 71 | * then write the result out to the new file. 'background' is not |
| 72 | * necessary when reading the image because the alpha channel is |
| 73 | * preserved; if it were to be removed, for example if we requested |
| 74 | * PNG_FORMAT_RGB, then either a solid background color would have to |
| 75 | * be supplied or the output buffer would have to be initialized to the |
| 76 | * actual background of the image. |
| 77 | * |
| 78 | * The final argument to png_image_finish_read is the 'row_stride' - |
| 79 | * this is the number of components allocated for the image in each |
| 80 | * row. It has to be at least as big as the value returned by |
| 81 | * PNG_IMAGE_ROW_STRIDE, but if you just allocate space for the |
| 82 | * default, minimum, size using PNG_IMAGE_SIZE as above you can pass |
| 83 | * zero. |
| 84 | */ |
| 85 | if (buffer != NULL && |
| 86 | png_image_finish_read(&image, NULL/*background*/, buffer, |
| 87 | 0/*row_stride*/)) |
| 88 | { |
| 89 | /* Now write the image out to the second argument. In the write |
| 90 | * call 'convert_to_8bit' allows 16-bit data to be squashed down to |
| 91 | * 8 bits; this isn't necessary here because the original read was |
| 92 | * to the 8-bit format. |
| 93 | */ |
| 94 | if (png_image_write_to_file(&image, argv[2], 0/*convert_to_8bit*/, |
| 95 | buffer, 0/*row_stride*/)) |
| 96 | { |
| 97 | /* The image has been written successfully. */ |
| 98 | exit(0); |
| 99 | } |
| 100 | } |
John Bowler | 414769b | 2011-11-27 21:39:13 -0600 | [diff] [blame] | 101 | |
| 102 | else |
| 103 | { |
| 104 | /* Calling png_free_image is optional unless the simplified API was |
| 105 | * not run to completion. In this case if there wasn't enough |
| 106 | * memory for 'buffer' we didn't complete the read, so we must free |
| 107 | * the image: |
| 108 | */ |
| 109 | if (buffer == NULL) |
| 110 | png_free_image(&image); |
| 111 | |
| 112 | else |
| 113 | free(buffer); |
Glenn Randers-Pehrson | 7455cbf | 2011-11-24 14:40:36 -0600 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | /* Something went wrong reading or writing the image. libpng stores a |
| 117 | * textual message in the 'png_image' structure: |
| 118 | */ |
| 119 | fprintf(stderr, "pngtopng: error: %s\n", image.message); |
| 120 | exit (1); |
| 121 | } |
| 122 | |
| 123 | fprintf(stderr, "pngtopng: usage: pngtopng input-file output-file\n"); |
| 124 | exit(1); |
| 125 | } |
| 126 | |
| 127 | /* That's it ;-) Of course you probably want to do more with PNG files than |
| 128 | * just converting them all to 32-bit RGBA PNG files; you can do that between |
| 129 | * the call to png_image_finish_read and png_image_write_to_file. You can also |
| 130 | * ask for the image data to be presented in a number of different formats. You |
| 131 | * do this by simply changing the 'format' parameter set before allocating the |
| 132 | * buffer. |
| 133 | * |
| 134 | * The format parameter consists of five flags that define various aspects of |
| 135 | * the image, you can simply add these together to get the format or you can use |
| 136 | * one of the predefined macros from png.h (as above): |
| 137 | * |
| 138 | * PNG_FORMAT_FLAG_COLOR: if set the image will have three color components per |
| 139 | * pixel (red, green and blue), if not set the image will just have one |
| 140 | * luminance (grayscale) component. |
| 141 | * |
| 142 | * PNG_FORMAT_FLAG_ALPHA: if set each pixel in the image will have an additional |
| 143 | * alpha value; a linear value that describes the degree the image pixel |
| 144 | * covers (overwrites) the contents of the existing pixel on the display. |
| 145 | * |
| 146 | * PNG_FORMAT_FLAG_LINEAR: if set the components of each pixel will be returned |
| 147 | * as a series of 16-bit linear values, if not set the components will be |
| 148 | * returned as a series of 8-bit values encoded according to the 'sRGB' |
| 149 | * standard. The 8-bit format is the normal format for images intended for |
| 150 | * direct display, because almost all display devices do the inverse of the |
| 151 | * sRGB transformation to the data they receive. The 16-bit format is more |
| 152 | * common for scientific data and image data that must be further processed; |
| 153 | * because it is linear simple math can be done on the component values. |
| 154 | * Regardless of the setting of this flag the alpha channel is always linear, |
| 155 | * although it will be 8 bits or 16 bits wide as specified by the flag. |
| 156 | * |
| 157 | * PNG_FORMAT_FLAG_BGR: if set the components of a color pixel will be returned |
| 158 | * in the order blue, then green, then red. If not set the pixel components |
| 159 | * are in the order red, then green, then blue. |
| 160 | * |
| 161 | * PNG_FORMAT_FLAG_AFIRST: if set the alpha channel (if present) precedes the |
| 162 | * color or grayscale components. If not set the alpha channel follows the |
| 163 | * components. |
| 164 | * |
| 165 | * You do not have to read directly from a file. You can read from memory or, |
| 166 | * on systems that support it, from a <stdio.h> FILE*. This is controlled by |
| 167 | * the particular png_image_read_from_ function you call at the start. Likewise |
| 168 | * on write you can write to a FILE* if your system supports it. Check the |
| 169 | * macro PNG_STDIO_SUPPORTED to see if stdio support has been included in your |
| 170 | * libpng build. |
| 171 | * |
| 172 | * If you read 16-bit (PNG_FORMAT_FLAG_LINEAR) data you may need to write it in |
| 173 | * the 8-bit format for display. You do this by setting the convert_to_8bit |
| 174 | * flag to 'true'. |
| 175 | * |
| 176 | * Don't repeatedly convert between the 8-bit and 16-bit forms. There is |
| 177 | * significant data loss when 16-bit data is converted to the 8-bit encoding and |
| 178 | * the current libpng implementation of convertion to 16-bit is also |
| 179 | * significantly lossy. The latter will be fixed in the future, but the former |
| 180 | * is unavoidable - the 8-bit format just doesn't have enough resolution. |
| 181 | */ |
| 182 | |
| 183 | /* If your program needs more information from the PNG data it reads, or if you |
| 184 | * need to do more complex transformations, or minimise transformations, on the |
| 185 | * data you read, then you must use one of the several lower level libpng |
| 186 | * interfaces. |
| 187 | * |
| 188 | * All these interfaces require that you do your own error handling - your |
| 189 | * program must be able to arrange for control to return to your own code any |
| 190 | * time libpng encounters a problem. There are several ways to do this, but the |
| 191 | * standard way is to use the ANSI-C (C90) <setjmp.h> interface to establish a |
| 192 | * return point within your own code. You must do this if you do not use the |
| 193 | * simplified interface (above). |
| 194 | * |
| 195 | * The first step is to include the header files you need, including the libpng |
| 196 | * header file. Include any standard headers and feature test macros your |
| 197 | * program requires before including png.h: |
| 198 | */ |
| 199 | #include <png.h> |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 200 | |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 201 | /* The png_jmpbuf() macro, used in error handling, became available in |
| 202 | * libpng version 1.0.6. If you want to be able to run your code with older |
| 203 | * versions of libpng, you must define the macro yourself (but only if it |
| 204 | * is not already defined by libpng!). |
| 205 | */ |
| 206 | |
| 207 | #ifndef png_jmpbuf |
Glenn Randers-Pehrson | 95ca51b | 2010-02-19 14:09:09 -0600 | [diff] [blame] | 208 | # define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf) |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 209 | #endif |
| 210 | |
Glenn Randers-Pehrson | c944229 | 1999-01-06 21:50:16 -0600 | [diff] [blame] | 211 | /* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp() |
| 212 | * returns zero if the image is a PNG and nonzero if it isn't a PNG. |
| 213 | * |
| 214 | * The function check_if_png() shown here, but not used, returns nonzero (true) |
| 215 | * if the file can be opened and is a PNG, 0 (false) otherwise. |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 216 | * |
| 217 | * If this call is successful, and you are going to keep the file open, |
| 218 | * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once |
| 219 | * you have created the png_ptr, so that libpng knows your application |
| 220 | * has read that many bytes from the start of the file. Make sure you |
| 221 | * don't call png_set_sig_bytes() with more than 8 bytes read or give it |
| 222 | * an incorrect number of bytes read, or you will either have read too |
| 223 | * many bytes (your fault), or you are telling libpng to read the wrong |
| 224 | * number of magic bytes (also your fault). |
| 225 | * |
| 226 | * Many applications already read the first 2 or 4 bytes from the start |
| 227 | * of the image to determine the file type, so it would be easiest just |
Glenn Randers-Pehrson | 0f7202f | 1998-03-08 18:52:15 -0600 | [diff] [blame] | 228 | * to pass the bytes to png_sig_cmp() or even skip that if you know |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 229 | * you have a PNG file, and call png_set_sig_bytes(). |
| 230 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 231 | #define PNG_BYTES_TO_CHECK 4 |
| 232 | int check_if_png(char *file_name, FILE **fp) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 233 | { |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 234 | char buf[PNG_BYTES_TO_CHECK]; |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 235 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 236 | /* Open the prospective PNG file. */ |
Glenn Randers-Pehrson | 68ea243 | 2000-04-01 21:10:05 -0600 | [diff] [blame] | 237 | if ((*fp = fopen(file_name, "rb")) == NULL) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 238 | return 0; |
| 239 | |
Glenn Randers-Pehrson | c944229 | 1999-01-06 21:50:16 -0600 | [diff] [blame] | 240 | /* Read in some of the signature bytes */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 241 | if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK) |
| 242 | return 0; |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 243 | |
Glenn Randers-Pehrson | c944229 | 1999-01-06 21:50:16 -0600 | [diff] [blame] | 244 | /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature. |
| 245 | Return nonzero (true) if they match */ |
| 246 | |
Glenn Randers-Pehrson | 145f5c8 | 2008-07-10 09:13:13 -0500 | [diff] [blame] | 247 | return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK)); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 248 | } |
| 249 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 250 | /* Read a PNG file. You may want to return an error code if the read |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 251 | * fails (depending upon the failure). There are two "prototypes" given |
| 252 | * here - one where we are given the filename, and we need to open the |
| 253 | * file, and the other where we are given an open file (possibly with |
| 254 | * some or all of the magic bytes read - see comments above). |
| 255 | */ |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 256 | #ifdef open_file /* prototype 1 */ |
Andreas Dilger | 02ad0ef | 1997-01-17 01:34:35 -0600 | [diff] [blame] | 257 | void read_png(char *file_name) /* We need to open the file */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 258 | { |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 259 | png_structp png_ptr; |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 260 | png_infop info_ptr; |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 261 | unsigned int sig_read = 0; |
| 262 | png_uint_32 width, height; |
| 263 | int bit_depth, color_type, interlace_type; |
Andreas Dilger | 02ad0ef | 1997-01-17 01:34:35 -0600 | [diff] [blame] | 264 | FILE *fp; |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 265 | |
Andreas Dilger | 02ad0ef | 1997-01-17 01:34:35 -0600 | [diff] [blame] | 266 | if ((fp = fopen(file_name, "rb")) == NULL) |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 267 | return (ERROR); |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 268 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 269 | #else no_open_file /* prototype 2 */ |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 270 | void read_png(FILE *fp, unsigned int sig_read) /* File is already open */ |
Andreas Dilger | 02ad0ef | 1997-01-17 01:34:35 -0600 | [diff] [blame] | 271 | { |
| 272 | png_structp png_ptr; |
| 273 | png_infop info_ptr; |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 274 | png_uint_32 width, height; |
| 275 | int bit_depth, color_type, interlace_type; |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 276 | #endif no_open_file /* Only use one prototype! */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 277 | |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 278 | /* Create and initialize the png_struct with the desired error handler |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 279 | * functions. If you want to use the default stderr and longjump method, |
| 280 | * you can supply NULL for the last three parameters. We also supply the |
| 281 | * the compiler header file version, so that we know if the application |
| 282 | * was compiled with a compatible version of the library. REQUIRED |
| 283 | */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 284 | png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, |
Glenn Randers-Pehrson | d0dce40 | 1998-05-09 10:02:29 -0500 | [diff] [blame] | 285 | png_voidp user_error_ptr, user_error_fn, user_warning_fn); |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 286 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 287 | if (png_ptr == NULL) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 288 | { |
| 289 | fclose(fp); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 290 | return (ERROR); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 291 | } |
| 292 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 293 | /* Allocate/initialize the memory for image information. REQUIRED. */ |
Glenn Randers-Pehrson | 0f7202f | 1998-03-08 18:52:15 -0600 | [diff] [blame] | 294 | info_ptr = png_create_info_struct(png_ptr); |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 295 | if (info_ptr == NULL) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 296 | { |
| 297 | fclose(fp); |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 298 | png_destroy_read_struct(&png_ptr, NULL, NULL); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 299 | return (ERROR); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 300 | } |
| 301 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 302 | /* Set error handling if you are using the setjmp/longjmp method (this is |
| 303 | * the normal method of doing things with libpng). REQUIRED unless you |
| 304 | * set up your own error handlers in the png_create_read_struct() earlier. |
| 305 | */ |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 306 | |
| 307 | if (setjmp(png_jmpbuf(png_ptr))) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 308 | { |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 309 | /* Free all of the memory associated with the png_ptr and info_ptr */ |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 310 | png_destroy_read_struct(&png_ptr, &info_ptr, NULL); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 311 | fclose(fp); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 312 | /* If we get here, we had a problem reading the file */ |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 313 | return (ERROR); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 314 | } |
| 315 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 316 | /* One of the following I/O initialization methods is REQUIRED */ |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 317 | #ifdef streams /* PNG file I/O method 1 */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 318 | /* Set up the input control if you are using standard C streams */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 319 | png_init_io(png_ptr, fp); |
| 320 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 321 | #else no_streams /* PNG file I/O method 2 */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 322 | /* If you are using replacement read functions, instead of calling |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 323 | * png_init_io() here you would call: |
| 324 | */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 325 | png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn); |
| 326 | /* where user_io_ptr is a structure you want available to the callbacks */ |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 327 | #endif no_streams /* Use only one I/O method! */ |
Guy Schalnat | 69b1448 | 1996-01-10 02:56:49 -0600 | [diff] [blame] | 328 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 329 | /* If we have already read some of the signature */ |
Glenn Randers-Pehrson | 0f7202f | 1998-03-08 18:52:15 -0600 | [diff] [blame] | 330 | png_set_sig_bytes(png_ptr, sig_read); |
Andreas Dilger | 02ad0ef | 1997-01-17 01:34:35 -0600 | [diff] [blame] | 331 | |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 332 | #ifdef hilevel |
| 333 | /* |
| 334 | * If you have enough memory to read in the entire image at once, |
| 335 | * and you need to specify only transforms that can be controlled |
| 336 | * with one of the PNG_TRANSFORM_* bits (this presently excludes |
Glenn Randers-Pehrson | 3cd7cff | 2010-04-16 19:27:08 -0500 | [diff] [blame] | 337 | * quantizing, filling, setting background, and doing gamma |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 338 | * adjustment), then you can read the entire image (including |
| 339 | * pixels) into the info structure with this call: |
| 340 | */ |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 341 | png_read_png(png_ptr, info_ptr, png_transforms, NULL); |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 342 | |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 343 | #else |
| 344 | /* OK, you're doing it the hard way, with the lower-level functions */ |
| 345 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 346 | /* The call to png_read_info() gives us all of the information from the |
| 347 | * PNG file before the first IDAT (image data chunk). REQUIRED |
| 348 | */ |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 349 | png_read_info(png_ptr, info_ptr); |
Guy Schalnat | 69b1448 | 1996-01-10 02:56:49 -0600 | [diff] [blame] | 350 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 351 | png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type, |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 352 | &interlace_type, NULL, NULL); |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 353 | |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 354 | /* Set up the data transformations you want. Note that these are all |
| 355 | * optional. Only call them if you want/need them. Many of the |
| 356 | * transformations only work on specific types of images, and many |
| 357 | * are mutually exclusive. |
| 358 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 359 | |
Glenn Randers-Pehrson | 857dbbe | 2011-06-16 09:39:40 -0500 | [diff] [blame] | 360 | /* Tell libpng to strip 16 bit/color files down to 8 bits/color. |
| 361 | * Use accurate scaling if it's available, otherwise just chop off the |
| 362 | * low byte. |
| 363 | */ |
John Bowler | 8d26126 | 2011-06-18 13:37:11 -0500 | [diff] [blame] | 364 | #ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED |
Glenn Randers-Pehrson | ab63dd0 | 2011-06-17 20:04:17 -0500 | [diff] [blame] | 365 | png_set_scale_16(png_ptr); |
Glenn Randers-Pehrson | 857dbbe | 2011-06-16 09:39:40 -0500 | [diff] [blame] | 366 | #else |
Glenn Randers-Pehrson | ab63dd0 | 2011-06-17 20:04:17 -0500 | [diff] [blame] | 367 | png_set_strip_16(png_ptr); |
Glenn Randers-Pehrson | 857dbbe | 2011-06-16 09:39:40 -0500 | [diff] [blame] | 368 | #endif |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 369 | |
Glenn Randers-Pehrson | 4393a9a | 1999-09-17 12:27:26 -0500 | [diff] [blame] | 370 | /* Strip alpha bytes from the input data without combining with the |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 371 | * background (not recommended). |
| 372 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 373 | png_set_strip_alpha(png_ptr); |
| 374 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 375 | /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 376 | * byte into separate bytes (useful for paletted and grayscale images). |
| 377 | */ |
| 378 | png_set_packing(png_ptr); |
| 379 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 380 | /* Change the order of packed pixels to least significant bit first |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 381 | * (not useful if you are using png_set_packing). */ |
| 382 | png_set_packswap(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 383 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 384 | /* Expand paletted colors into true RGB triplets */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 385 | if (color_type == PNG_COLOR_TYPE_PALETTE) |
Glenn Randers-Pehrson | f46918d | 2006-06-02 05:31:20 -0500 | [diff] [blame] | 386 | png_set_palette_to_rgb(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 387 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 388 | /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 389 | if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8) |
Glenn Randers-Pehrson | 56f6396 | 2008-10-06 10:16:17 -0500 | [diff] [blame] | 390 | png_set_expand_gray_1_2_4_to_8(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 391 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 392 | /* Expand paletted or RGB images with transparency to full alpha channels |
| 393 | * so the data will be available as RGBA quartets. |
| 394 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 395 | if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS)) |
Glenn Randers-Pehrson | b182893 | 2001-06-23 08:03:17 -0500 | [diff] [blame] | 396 | png_set_tRNS_to_alpha(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 397 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 398 | /* Set the background color to draw transparent and alpha images over. |
| 399 | * It is possible to set the red, green, and blue components directly |
| 400 | * for paletted images instead of supplying a palette index. Note that |
| 401 | * even if the PNG file supplies a background, you are not required to |
| 402 | * use it - you should use the (solid) application background if it has one. |
| 403 | */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 404 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 405 | png_color_16 my_background, *image_background; |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 406 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 407 | if (png_get_bKGD(png_ptr, info_ptr, &image_background)) |
| 408 | png_set_background(png_ptr, image_background, |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 409 | PNG_BACKGROUND_GAMMA_FILE, 1, 1.0); |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 410 | else |
| 411 | png_set_background(png_ptr, &my_background, |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 412 | PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 413 | |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 414 | /* Some suggestions as to how to get a screen gamma value |
| 415 | * |
| 416 | * Note that screen gamma is the display_exponent, which includes |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 417 | * the CRT_exponent and any correction for viewing conditions |
| 418 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 419 | if (/* We have a user-defined screen gamma value */) |
| 420 | { |
| 421 | screen_gamma = user-defined screen_gamma; |
| 422 | } |
| 423 | /* This is one way that applications share the same screen gamma value */ |
Glenn Randers-Pehrson | c4a2ae6 | 1998-01-16 22:06:18 -0600 | [diff] [blame] | 424 | else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL) |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 425 | { |
| 426 | screen_gamma = atof(gamma_str); |
| 427 | } |
| 428 | /* If we don't have another value */ |
| 429 | else |
| 430 | { |
Glenn Randers-Pehrson | f0a8fe0 | 2009-04-14 08:28:15 -0500 | [diff] [blame] | 431 | screen_gamma = 2.2; /* A good guess for a PC monitor in a dimly |
Glenn Randers-Pehrson | c4a2ae6 | 1998-01-16 22:06:18 -0600 | [diff] [blame] | 432 | lit room */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 433 | screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */ |
| 434 | } |
| 435 | |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 436 | /* Tell libpng to handle the gamma conversion for you. The final call |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 437 | * is a good guess for PC generated images, but it should be configurable |
| 438 | * by the user at run time by the user. It is strongly suggested that |
| 439 | * your application support gamma correction. |
| 440 | */ |
Glenn Randers-Pehrson | c4a2ae6 | 1998-01-16 22:06:18 -0600 | [diff] [blame] | 441 | |
| 442 | int intent; |
| 443 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 444 | if (png_get_sRGB(png_ptr, info_ptr, &intent)) |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 445 | png_set_gamma(png_ptr, screen_gamma, 0.45455); |
Glenn Randers-Pehrson | 5c6aeb2 | 1998-12-29 11:47:59 -0600 | [diff] [blame] | 446 | else |
| 447 | { |
| 448 | double image_gamma; |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 449 | if (png_get_gAMA(png_ptr, info_ptr, &image_gamma)) |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 450 | png_set_gamma(png_ptr, screen_gamma, image_gamma); |
| 451 | else |
Glenn Randers-Pehrson | 5c6aeb2 | 1998-12-29 11:47:59 -0600 | [diff] [blame] | 452 | png_set_gamma(png_ptr, screen_gamma, 0.45455); |
| 453 | } |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 454 | |
Glenn Randers-Pehrson | 3cd7cff | 2010-04-16 19:27:08 -0500 | [diff] [blame] | 455 | #ifdef PNG_READ_QUANTIZE_SUPPORTED |
| 456 | /* Quantize RGB files down to 8 bit palette or reduce palettes |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 457 | * to the number of colors available on your screen. |
| 458 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 459 | if (color_type & PNG_COLOR_MASK_COLOR) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 460 | { |
Glenn Randers-Pehrson | f05f803 | 2000-12-23 14:27:39 -0600 | [diff] [blame] | 461 | int num_palette; |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 462 | png_colorp palette; |
| 463 | |
| 464 | /* This reduces the image to the application supplied palette */ |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 465 | if (/* We have our own palette */) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 466 | { |
Glenn Randers-Pehrson | 3cd7cff | 2010-04-16 19:27:08 -0500 | [diff] [blame] | 467 | /* An array of colors to which the image should be quantized */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 468 | png_color std_color_cube[MAX_SCREEN_COLORS]; |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 469 | |
Glenn Randers-Pehrson | 3cd7cff | 2010-04-16 19:27:08 -0500 | [diff] [blame] | 470 | png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS, |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 471 | MAX_SCREEN_COLORS, NULL, 0); |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 472 | } |
| 473 | /* This reduces the image to the palette supplied in the file */ |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 474 | else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette)) |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 475 | { |
Glenn Randers-Pehrson | 865f4f0 | 2002-09-15 20:30:38 -0500 | [diff] [blame] | 476 | png_uint_16p histogram = NULL; |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 477 | |
| 478 | png_get_hIST(png_ptr, info_ptr, &histogram); |
| 479 | |
Glenn Randers-Pehrson | 3cd7cff | 2010-04-16 19:27:08 -0500 | [diff] [blame] | 480 | png_set_quantize(png_ptr, palette, num_palette, |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 481 | max_screen_colors, histogram, 0); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 482 | } |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 483 | } |
Glenn Randers-Pehrson | 3cd7cff | 2010-04-16 19:27:08 -0500 | [diff] [blame] | 484 | #endif /* PNG_READ_QUANTIZE_SUPPORTED */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 485 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 486 | /* Invert monochrome files to have 0 as white and 1 as black */ |
Glenn Randers-Pehrson | 46f61e2 | 1998-01-30 21:45:12 -0600 | [diff] [blame] | 487 | png_set_invert_mono(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 488 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 489 | /* If you want to shift the pixel values from the range [0,255] or |
| 490 | * [0,65535] to the original [0,7] or [0,31], or whatever range the |
| 491 | * colors were originally in: |
| 492 | */ |
| 493 | if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT)) |
| 494 | { |
Glenn Randers-Pehrson | 640b7d5 | 2009-05-13 07:33:22 -0500 | [diff] [blame] | 495 | png_color_8p sig_bit_p; |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 496 | |
Glenn Randers-Pehrson | 640b7d5 | 2009-05-13 07:33:22 -0500 | [diff] [blame] | 497 | png_get_sBIT(png_ptr, info_ptr, &sig_bit_p); |
| 498 | png_set_shift(png_ptr, sig_bit_p); |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 499 | } |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 500 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 501 | /* Flip the RGB pixels to BGR (or RGBA to BGRA) */ |
Glenn Randers-Pehrson | 6942d53 | 2000-05-01 09:31:54 -0500 | [diff] [blame] | 502 | if (color_type & PNG_COLOR_MASK_COLOR) |
| 503 | png_set_bgr(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 504 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 505 | /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 506 | png_set_swap_alpha(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 507 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 508 | /* Swap bytes of 16 bit files to least significant byte first */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 509 | png_set_swap(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 510 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 511 | /* Add filler (or alpha) byte (before/after each RGB triplet) */ |
| 512 | png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER); |
| 513 | |
Glenn Randers-Pehrson | 4daae30 | 2011-10-06 21:37:47 -0500 | [diff] [blame] | 514 | #ifdef PNG_READ_INTERLACING_SUPPORTED |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 515 | /* Turn on interlace handling. REQUIRED if you are not using |
| 516 | * png_read_image(). To see how to handle interlacing passes, |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 517 | * see the png_read_row() method below: |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 518 | */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 519 | number_passes = png_set_interlace_handling(png_ptr); |
Glenn Randers-Pehrson | 4daae30 | 2011-10-06 21:37:47 -0500 | [diff] [blame] | 520 | #else |
| 521 | number_passes = 1; |
| 522 | #endif /* PNG_READ_INTERLACING_SUPPORTED */ |
| 523 | |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 524 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 525 | /* Optional call to gamma correct and add the background to the palette |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 526 | * and update info structure. REQUIRED if you are expecting libpng to |
| 527 | * update the palette for you (ie you selected such a transform above). |
| 528 | */ |
Guy Schalnat | 51f0eb4 | 1995-09-26 05:22:39 -0500 | [diff] [blame] | 529 | png_read_update_info(png_ptr, info_ptr); |
| 530 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 531 | /* Allocate the memory to hold the image using the fields of info_ptr. */ |
Guy Schalnat | 51f0eb4 | 1995-09-26 05:22:39 -0500 | [diff] [blame] | 532 | |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 533 | /* The easiest way to read the image: */ |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 534 | png_bytep row_pointers[height]; |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 535 | |
Glenn Randers-Pehrson | 8fb550c | 2009-03-21 08:15:32 -0500 | [diff] [blame] | 536 | /* Clear the pointer array */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 537 | for (row = 0; row < height; row++) |
Glenn Randers-Pehrson | 8fb550c | 2009-03-21 08:15:32 -0500 | [diff] [blame] | 538 | row_pointers[row] = NULL; |
| 539 | |
| 540 | for (row = 0; row < height; row++) |
Glenn Randers-Pehrson | 3097f61 | 2001-05-07 14:52:45 -0500 | [diff] [blame] | 541 | row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr, |
| 542 | info_ptr)); |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 543 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 544 | /* Now it's time to read the image. One of these methods is REQUIRED */ |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 545 | #ifdef entire /* Read the entire image in one go */ |
Guy Schalnat | 51f0eb4 | 1995-09-26 05:22:39 -0500 | [diff] [blame] | 546 | png_read_image(png_ptr, row_pointers); |
| 547 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 548 | #else no_entire /* Read the image one or more scanlines at a time */ |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 549 | /* The other way to read images - deal with interlacing: */ |
Guy Schalnat | 51f0eb4 | 1995-09-26 05:22:39 -0500 | [diff] [blame] | 550 | |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 551 | for (pass = 0; pass < number_passes; pass++) |
| 552 | { |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 553 | #ifdef single /* Read the image a single row at a time */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 554 | for (y = 0; y < height; y++) |
| 555 | { |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 556 | png_read_rows(png_ptr, &row_pointers[y], NULL, 1); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 557 | } |
| 558 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 559 | #else no_single /* Read the image several rows at a time */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 560 | for (y = 0; y < height; y += number_of_rows) |
| 561 | { |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 562 | #ifdef sparkle /* Read the image using the "sparkle" effect. */ |
Glenn Randers-Pehrson | 145f5c8 | 2008-07-10 09:13:13 -0500 | [diff] [blame] | 563 | png_read_rows(png_ptr, &row_pointers[y], NULL, |
| 564 | number_of_rows); |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 565 | #else no_sparkle /* Read the image using the "rectangle" effect */ |
Glenn Randers-Pehrson | 145f5c8 | 2008-07-10 09:13:13 -0500 | [diff] [blame] | 566 | png_read_rows(png_ptr, NULL, &row_pointers[y], |
| 567 | number_of_rows); |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 568 | #endif no_sparkle /* Use only one of these two methods */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 569 | } |
Glenn Randers-Pehrson | 5c6aeb2 | 1998-12-29 11:47:59 -0600 | [diff] [blame] | 570 | |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 571 | /* If you want to display the image after every pass, do so here */ |
| 572 | #endif no_single /* Use only one of these two methods */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 573 | } |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 574 | #endif no_entire /* Use only one of these two methods */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 575 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 576 | /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */ |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 577 | png_read_end(png_ptr, info_ptr); |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 578 | #endif hilevel |
| 579 | |
| 580 | /* At this point you have read the entire image */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 581 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 582 | /* Clean up after the read, and free any memory allocated - REQUIRED */ |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 583 | png_destroy_read_struct(&png_ptr, &info_ptr, NULL); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 584 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 585 | /* Close the file */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 586 | fclose(fp); |
| 587 | |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 588 | /* That's it */ |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 589 | return (OK); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 590 | } |
| 591 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 592 | /* Progressively read a file */ |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 593 | |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 594 | int |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 595 | initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr) |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 596 | { |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 597 | /* Create and initialize the png_struct with the desired error handler |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 598 | * functions. If you want to use the default stderr and longjump method, |
| 599 | * you can supply NULL for the last three parameters. We also check that |
| 600 | * the library version is compatible in case we are using dynamically |
| 601 | * linked libraries. |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 602 | */ |
| 603 | *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, |
Glenn Randers-Pehrson | d0dce40 | 1998-05-09 10:02:29 -0500 | [diff] [blame] | 604 | png_voidp user_error_ptr, user_error_fn, user_warning_fn); |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 605 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 606 | if (*png_ptr == NULL) |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 607 | { |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 608 | *info_ptr = NULL; |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 609 | return (ERROR); |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 610 | } |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 611 | |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 612 | *info_ptr = png_create_info_struct(png_ptr); |
| 613 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 614 | if (*info_ptr == NULL) |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 615 | { |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 616 | png_destroy_read_struct(png_ptr, info_ptr, NULL); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 617 | return (ERROR); |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 618 | } |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 619 | |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 620 | if (setjmp(png_jmpbuf((*png_ptr)))) |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 621 | { |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 622 | png_destroy_read_struct(png_ptr, info_ptr, NULL); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 623 | return (ERROR); |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 624 | } |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 625 | |
Glenn Randers-Pehrson | 5c6aeb2 | 1998-12-29 11:47:59 -0600 | [diff] [blame] | 626 | /* This one's new. You will need to provide all three |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 627 | * function callbacks, even if you aren't using them all. |
Glenn Randers-Pehrson | 5c6aeb2 | 1998-12-29 11:47:59 -0600 | [diff] [blame] | 628 | * If you aren't using all functions, you can specify NULL |
| 629 | * parameters. Even when all three functions are NULL, |
| 630 | * you need to call png_set_progressive_read_fn(). |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 631 | * These functions shouldn't be dependent on global or |
| 632 | * static variables if you are decoding several images |
| 633 | * simultaneously. You should store stream specific data |
| 634 | * in a separate struct, given as the second parameter, |
| 635 | * and retrieve the pointer from inside the callbacks using |
| 636 | * the function png_get_progressive_ptr(png_ptr). |
| 637 | */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 638 | png_set_progressive_read_fn(*png_ptr, (void *)stream_data, |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 639 | info_callback, row_callback, end_callback); |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 640 | |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 641 | return (OK); |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 642 | } |
| 643 | |
| 644 | int |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 645 | process_data(png_structp *png_ptr, png_infop *info_ptr, |
| 646 | png_bytep buffer, png_uint_32 length) |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 647 | { |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 648 | if (setjmp(png_jmpbuf((*png_ptr)))) |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 649 | { |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 650 | /* Free the png_ptr and info_ptr memory on error */ |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 651 | png_destroy_read_struct(png_ptr, info_ptr, NULL); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 652 | return (ERROR); |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 653 | } |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 654 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 655 | /* This one's new also. Simply give it chunks of data as |
| 656 | * they arrive from the data stream (in order, of course). |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 657 | * On segmented machines, don't give it any more than 64K. |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 658 | * The library seems to run fine with sizes of 4K, although |
| 659 | * you can give it much less if necessary (I assume you can |
| 660 | * give it chunks of 1 byte, but I haven't tried with less |
| 661 | * than 256 bytes yet). When this function returns, you may |
| 662 | * want to display any rows that were generated in the row |
| 663 | * callback, if you aren't already displaying them there. |
| 664 | */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 665 | png_process_data(*png_ptr, *info_ptr, buffer, length); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 666 | return (OK); |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 667 | } |
| 668 | |
| 669 | info_callback(png_structp png_ptr, png_infop info) |
| 670 | { |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 671 | /* Do any setup here, including setting any of the transformations |
| 672 | * mentioned in the Reading PNG files section. For now, you _must_ |
| 673 | * call either png_start_read_image() or png_read_update_info() |
| 674 | * after all the transformations are set (even if you don't set |
| 675 | * any). You may start getting rows before png_process_data() |
| 676 | * returns, so this is your last chance to prepare for that. |
| 677 | */ |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 678 | } |
| 679 | |
| 680 | row_callback(png_structp png_ptr, png_bytep new_row, |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 681 | png_uint_32 row_num, int pass) |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 682 | { |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 683 | /* |
| 684 | * This function is called for every row in the image. If the |
| 685 | * image is interlaced, and you turned on the interlace handler, |
| 686 | * this function will be called for every row in every pass. |
| 687 | * |
| 688 | * In this function you will receive a pointer to new row data from |
| 689 | * libpng called new_row that is to replace a corresponding row (of |
| 690 | * the same data format) in a buffer allocated by your application. |
| 691 | * |
| 692 | * The new row data pointer "new_row" may be NULL, indicating there is |
| 693 | * no new data to be replaced (in cases of interlace loading). |
| 694 | * |
| 695 | * If new_row is not NULL then you need to call |
| 696 | * png_progressive_combine_row() to replace the corresponding row as |
| 697 | * shown below: |
| 698 | */ |
| 699 | |
Glenn Randers-Pehrson | 53c07f5 | 2010-06-18 18:55:55 -0500 | [diff] [blame] | 700 | /* Get pointer to corresponding row in our |
| 701 | * PNG read buffer. |
| 702 | */ |
| 703 | png_bytep old_row = ((png_bytep *)our_data)[row_num]; |
Glenn Randers-Pehrson | 5a0be34 | 2001-10-18 20:55:13 -0500 | [diff] [blame] | 704 | |
Glenn Randers-Pehrson | 4daae30 | 2011-10-06 21:37:47 -0500 | [diff] [blame] | 705 | #ifdef PNG_READ_INTERLACING_SUPPORTED |
Glenn Randers-Pehrson | 53c07f5 | 2010-06-18 18:55:55 -0500 | [diff] [blame] | 706 | /* If both rows are allocated then copy the new row |
| 707 | * data to the corresponding row data. |
| 708 | */ |
| 709 | if ((old_row != NULL) && (new_row != NULL)) |
| 710 | png_progressive_combine_row(png_ptr, old_row, new_row); |
| 711 | |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 712 | /* |
| 713 | * The rows and passes are called in order, so you don't really |
| 714 | * need the row_num and pass, but I'm supplying them because it |
| 715 | * may make your life easier. |
| 716 | * |
| 717 | * For the non-NULL rows of interlaced images, you must call |
| 718 | * png_progressive_combine_row() passing in the new row and the |
| 719 | * old row, as demonstrated above. You can call this function for |
| 720 | * NULL rows (it will just return) and for non-interlaced images |
John Bowler | fcd301d | 2011-12-28 21:34:27 -0600 | [diff] [blame] | 721 | * (it just does the memcpy for you) if it will make the code |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 722 | * easier. Thus, you can just do this for all cases: |
| 723 | */ |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 724 | |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 725 | png_progressive_combine_row(png_ptr, old_row, new_row); |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 726 | |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 727 | /* where old_row is what was displayed for previous rows. Note |
| 728 | * that the first pass (pass == 0 really) will completely cover |
| 729 | * the old row, so the rows do not have to be initialized. After |
| 730 | * the first pass (and only for interlaced images), you will have |
| 731 | * to pass the current row as new_row, and the function will combine |
| 732 | * the old row and the new row. |
| 733 | */ |
Glenn Randers-Pehrson | 4daae30 | 2011-10-06 21:37:47 -0500 | [diff] [blame] | 734 | #endif /* PNG_READ_INTERLACING_SUPPORTED */ |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 735 | } |
| 736 | |
| 737 | end_callback(png_structp png_ptr, png_infop info) |
| 738 | { |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 739 | /* This function is called when the whole image has been read, |
| 740 | * including any chunks after the image (up to and including |
| 741 | * the IEND). You will usually have the same info chunk as you |
| 742 | * had in the header, although some data may have been added |
| 743 | * to the comments and time fields. |
| 744 | * |
| 745 | * Most people won't do much here, perhaps setting a flag that |
| 746 | * marks the image as finished. |
| 747 | */ |
Guy Schalnat | 6d76471 | 1995-12-19 03:22:19 -0600 | [diff] [blame] | 748 | } |
| 749 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 750 | /* Write a png file */ |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 751 | void write_png(char *file_name /* , ... other image information ... */) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 752 | { |
| 753 | FILE *fp; |
Guy Schalnat | b2e01bd | 1996-01-26 01:38:47 -0600 | [diff] [blame] | 754 | png_structp png_ptr; |
| 755 | png_infop info_ptr; |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 756 | png_colorp palette; |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 757 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 758 | /* Open the file */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 759 | fp = fopen(file_name, "wb"); |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 760 | if (fp == NULL) |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 761 | return (ERROR); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 762 | |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 763 | /* Create and initialize the png_struct with the desired error handler |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 764 | * functions. If you want to use the default stderr and longjump method, |
| 765 | * you can supply NULL for the last three parameters. We also check that |
| 766 | * the library version is compatible with the one used at compile time, |
| 767 | * in case we are using dynamically linked libraries. REQUIRED. |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 768 | */ |
| 769 | png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, |
Glenn Randers-Pehrson | d0dce40 | 1998-05-09 10:02:29 -0500 | [diff] [blame] | 770 | png_voidp user_error_ptr, user_error_fn, user_warning_fn); |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 771 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 772 | if (png_ptr == NULL) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 773 | { |
| 774 | fclose(fp); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 775 | return (ERROR); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 776 | } |
| 777 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 778 | /* Allocate/initialize the image information data. REQUIRED */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 779 | info_ptr = png_create_info_struct(png_ptr); |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 780 | if (info_ptr == NULL) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 781 | { |
| 782 | fclose(fp); |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 783 | png_destroy_write_struct(&png_ptr, NULL); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 784 | return (ERROR); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 785 | } |
| 786 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 787 | /* Set error handling. REQUIRED if you aren't supplying your own |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 788 | * error handling functions in the png_create_write_struct() call. |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 789 | */ |
Glenn Randers-Pehrson | 520a764 | 2000-03-21 05:13:06 -0600 | [diff] [blame] | 790 | if (setjmp(png_jmpbuf(png_ptr))) |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 791 | { |
Glenn Randers-Pehrson | 8fb550c | 2009-03-21 08:15:32 -0500 | [diff] [blame] | 792 | /* If we get here, we had a problem writing the file */ |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 793 | fclose(fp); |
Glenn Randers-Pehrson | fc4a143 | 2000-05-17 17:39:34 -0500 | [diff] [blame] | 794 | png_destroy_write_struct(&png_ptr, &info_ptr); |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 795 | return (ERROR); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 796 | } |
| 797 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 798 | /* One of the following I/O initialization functions is REQUIRED */ |
Glenn Randers-Pehrson glennrp@comcast.net | b1c0d33 | 2009-05-15 20:39:34 -0500 | [diff] [blame] | 799 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 800 | #ifdef streams /* I/O initialization method 1 */ |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 801 | /* Set up the output control if you are using standard C streams */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 802 | png_init_io(png_ptr, fp); |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 803 | |
Glenn Randers-Pehrson | cbe52d8 | 1998-02-28 07:00:24 -0600 | [diff] [blame] | 804 | #else no_streams /* I/O initialization method 2 */ |
Glenn Randers-Pehrson | a5fa5c9 | 2008-09-06 07:06:22 -0500 | [diff] [blame] | 805 | /* If you are using replacement write functions, instead of calling |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 806 | * png_init_io() here you would call |
| 807 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 808 | png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn, |
| 809 | user_IO_flush_function); |
| 810 | /* where user_io_ptr is a structure you want available to the callbacks */ |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 811 | #endif no_streams /* Only use one initialization method */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 812 | |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 813 | #ifdef hilevel |
| 814 | /* This is the easy way. Use it if you already have all the |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 815 | * image info living in the structure. You could "|" many |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 816 | * PNG_TRANSFORM flags into the png_transforms integer here. |
| 817 | */ |
Glenn Randers-Pehrson | beb572e | 2006-08-19 13:59:24 -0500 | [diff] [blame] | 818 | png_write_png(png_ptr, info_ptr, png_transforms, NULL); |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 819 | |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 820 | #else |
| 821 | /* This is the hard way */ |
| 822 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 823 | /* Set the image information here. Width and height are up to 2^31, |
| 824 | * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on |
| 825 | * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY, |
| 826 | * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB, |
| 827 | * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or |
| 828 | * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST |
| 829 | * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED |
| 830 | */ |
| 831 | png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???, |
| 832 | PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 833 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 834 | /* Set the palette if there is one. REQUIRED for indexed-color images */ |
Glenn Randers-Pehrson | 3097f61 | 2001-05-07 14:52:45 -0500 | [diff] [blame] | 835 | palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH |
Glenn Randers-Pehrson | 145f5c8 | 2008-07-10 09:13:13 -0500 | [diff] [blame] | 836 | * png_sizeof(png_color)); |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 837 | /* ... Set palette colors ... */ |
Glenn Randers-Pehrson | 76e5fd6 | 2000-12-28 07:50:05 -0600 | [diff] [blame] | 838 | png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH); |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 839 | /* You must not free palette here, because png_set_PLTE only makes a link to |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 840 | * the palette that you malloced. Wait until you are about to destroy |
| 841 | * the png structure. |
| 842 | */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 843 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 844 | /* Optional significant bit (sBIT) chunk */ |
Glenn Randers-Pehrson | 640b7d5 | 2009-05-13 07:33:22 -0500 | [diff] [blame] | 845 | png_color_8 sig_bit; |
Glenn Randers-Pehrson | f24daf2 | 2010-05-06 09:44:04 -0500 | [diff] [blame] | 846 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 847 | /* If we are dealing with a grayscale image then */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 848 | sig_bit.gray = true_bit_depth; |
Glenn Randers-Pehrson | f24daf2 | 2010-05-06 09:44:04 -0500 | [diff] [blame] | 849 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 850 | /* Otherwise, if we are dealing with a color image then */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 851 | sig_bit.red = true_red_bit_depth; |
| 852 | sig_bit.green = true_green_bit_depth; |
| 853 | sig_bit.blue = true_blue_bit_depth; |
Glenn Randers-Pehrson | f24daf2 | 2010-05-06 09:44:04 -0500 | [diff] [blame] | 854 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 855 | /* If the image has an alpha channel then */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 856 | sig_bit.alpha = true_alpha_bit_depth; |
Glenn Randers-Pehrson | f24daf2 | 2010-05-06 09:44:04 -0500 | [diff] [blame] | 857 | |
Glenn Randers-Pehrson | 640b7d5 | 2009-05-13 07:33:22 -0500 | [diff] [blame] | 858 | png_set_sBIT(png_ptr, info_ptr, &sig_bit); |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 859 | |
Glenn Randers-Pehrson | 5c6aeb2 | 1998-12-29 11:47:59 -0600 | [diff] [blame] | 860 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 861 | /* Optional gamma chunk is strongly suggested if you have any guess |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 862 | * as to the correct gamma of the image. |
| 863 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 864 | png_set_gAMA(png_ptr, info_ptr, gamma); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 865 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 866 | /* Optionally write comments into the image */ |
| 867 | text_ptr[0].key = "Title"; |
| 868 | text_ptr[0].text = "Mona Lisa"; |
| 869 | text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE; |
Glenn Randers-Pehrson | dd78d52 | 2010-03-30 08:34:02 -0500 | [diff] [blame] | 870 | text_ptr[0].itxt_length = 0; |
| 871 | text_ptr[0].lang = NULL; |
| 872 | text_ptr[0].lang_key = NULL; |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 873 | text_ptr[1].key = "Author"; |
| 874 | text_ptr[1].text = "Leonardo DaVinci"; |
| 875 | text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE; |
Glenn Randers-Pehrson | dd78d52 | 2010-03-30 08:34:02 -0500 | [diff] [blame] | 876 | text_ptr[1].itxt_length = 0; |
| 877 | text_ptr[1].lang = NULL; |
| 878 | text_ptr[1].lang_key = NULL; |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 879 | text_ptr[2].key = "Description"; |
| 880 | text_ptr[2].text = "<long text>"; |
| 881 | text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt; |
Glenn Randers-Pehrson | dd78d52 | 2010-03-30 08:34:02 -0500 | [diff] [blame] | 882 | text_ptr[2].itxt_length = 0; |
Glenn Randers-Pehrson | 166c5a3 | 1999-12-10 09:43:02 -0600 | [diff] [blame] | 883 | text_ptr[2].lang = NULL; |
Glenn Randers-Pehrson | dd78d52 | 2010-03-30 08:34:02 -0500 | [diff] [blame] | 884 | text_ptr[2].lang_key = NULL; |
Glenn Randers-Pehrson | 8686fff | 1998-05-21 09:27:50 -0500 | [diff] [blame] | 885 | png_set_text(png_ptr, info_ptr, text_ptr, 3); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 886 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 887 | /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */ |
Glenn Randers-Pehrson | 640b7d5 | 2009-05-13 07:33:22 -0500 | [diff] [blame] | 888 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 889 | /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored |
Glenn Randers-Pehrson | 640b7d5 | 2009-05-13 07:33:22 -0500 | [diff] [blame] | 890 | * on read and, if your application chooses to write them, they must |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 891 | * be written in accordance with the sRGB profile |
| 892 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 893 | |
| 894 | /* Write the file header information. REQUIRED */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 895 | png_write_info(png_ptr, info_ptr); |
| 896 | |
Glenn Randers-Pehrson | 5379b24 | 1999-11-27 10:22:33 -0600 | [diff] [blame] | 897 | /* If you want, you can write the info in two steps, in case you need to |
| 898 | * write your private chunk ahead of PLTE: |
| 899 | * |
| 900 | * png_write_info_before_PLTE(write_ptr, write_info_ptr); |
| 901 | * write_my_chunk(); |
| 902 | * png_write_info(png_ptr, info_ptr); |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 903 | * |
Glenn Randers-Pehrson | 8fb550c | 2009-03-21 08:15:32 -0500 | [diff] [blame] | 904 | * However, given the level of known- and unknown-chunk support in 1.2.0 |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 905 | * and up, this should no longer be necessary. |
Glenn Randers-Pehrson | 5379b24 | 1999-11-27 10:22:33 -0600 | [diff] [blame] | 906 | */ |
| 907 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 908 | /* Once we write out the header, the compression type on the text |
| 909 | * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or |
| 910 | * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again |
| 911 | * at the end. |
| 912 | */ |
| 913 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 914 | /* Set up the transformations you want. Note that these are |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 915 | * all optional. Only call them if you want them. |
| 916 | */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 917 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 918 | /* Invert monochrome pixels */ |
Glenn Randers-Pehrson | 46f61e2 | 1998-01-30 21:45:12 -0600 | [diff] [blame] | 919 | png_set_invert_mono(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 920 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 921 | /* Shift the pixels up to a legal bit depth and fill in |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 922 | * as appropriate to correctly scale the image. |
| 923 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 924 | png_set_shift(png_ptr, &sig_bit); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 925 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 926 | /* Pack pixels into bytes */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 927 | png_set_packing(png_ptr); |
| 928 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 929 | /* Swap location of alpha bytes from ARGB to RGBA */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 930 | png_set_swap_alpha(png_ptr); |
| 931 | |
| 932 | /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into |
Glenn Randers-Pehrson | b6ce43d | 1998-01-01 07:13:13 -0600 | [diff] [blame] | 933 | * RGB (4 channels -> 3 channels). The second parameter is not used. |
| 934 | */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 935 | png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE); |
| 936 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 937 | /* Flip BGR pixels to RGB */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 938 | png_set_bgr(png_ptr); |
| 939 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 940 | /* Swap bytes of 16-bit files to most significant byte first */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 941 | png_set_swap(png_ptr); |
| 942 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 943 | /* Swap bits of 1, 2, 4 bit packed pixel formats */ |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 944 | png_set_packswap(png_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 945 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 946 | /* Turn on interlace handling if you are not using png_write_image() */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 947 | if (interlacing) |
| 948 | number_passes = png_set_interlace_handling(png_ptr); |
Glenn Randers-Pehrson | f24daf2 | 2010-05-06 09:44:04 -0500 | [diff] [blame] | 949 | |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 950 | else |
| 951 | number_passes = 1; |
| 952 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 953 | /* The easiest way to write the image (you may have a different memory |
| 954 | * layout, however, so choose what fits your needs best). You need to |
| 955 | * use the first method if you aren't handling interlacing yourself. |
| 956 | */ |
Glenn Randers-Pehrson | 8686fff | 1998-05-21 09:27:50 -0500 | [diff] [blame] | 957 | png_uint_32 k, height, width; |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 958 | png_byte image[height][width*bytes_per_pixel]; |
Glenn Randers-Pehrson | 8686fff | 1998-05-21 09:27:50 -0500 | [diff] [blame] | 959 | png_bytep row_pointers[height]; |
Glenn Randers-Pehrson | 5fea36f | 2004-07-28 08:20:44 -0500 | [diff] [blame] | 960 | |
Glenn Randers-Pehrson | 145f5c8 | 2008-07-10 09:13:13 -0500 | [diff] [blame] | 961 | if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep)) |
Glenn Randers-Pehrson | 67864af | 2004-08-28 23:30:07 -0500 | [diff] [blame] | 962 | png_error (png_ptr, "Image is too tall to process in memory"); |
| 963 | |
Glenn Randers-Pehrson | 8686fff | 1998-05-21 09:27:50 -0500 | [diff] [blame] | 964 | for (k = 0; k < height; k++) |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 965 | row_pointers[k] = image + k*width*bytes_per_pixel; |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 966 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 967 | /* One of the following output methods is REQUIRED */ |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 968 | |
| 969 | #ifdef entire /* Write out the entire image data in one call */ |
Guy Schalnat | 51f0eb4 | 1995-09-26 05:22:39 -0500 | [diff] [blame] | 970 | png_write_image(png_ptr, row_pointers); |
| 971 | |
Glenn Randers-Pehrson | 4bb4d01 | 2009-05-20 12:45:29 -0500 | [diff] [blame] | 972 | /* The other way to write the image - deal with interlacing */ |
Guy Schalnat | 51f0eb4 | 1995-09-26 05:22:39 -0500 | [diff] [blame] | 973 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 974 | #else no_entire /* Write out the image data by one or more scanlines */ |
| 975 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 976 | /* The number of passes is either 1 for non-interlaced images, |
| 977 | * or 7 for interlaced images. |
| 978 | */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 979 | for (pass = 0; pass < number_passes; pass++) |
| 980 | { |
| 981 | /* Write a few rows at a time. */ |
Glenn Randers-Pehrson | 8686fff | 1998-05-21 09:27:50 -0500 | [diff] [blame] | 982 | png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 983 | |
| 984 | /* If you are only writing one row at a time, this works */ |
| 985 | for (y = 0; y < height; y++) |
Glenn Randers-Pehrson | 8686fff | 1998-05-21 09:27:50 -0500 | [diff] [blame] | 986 | png_write_rows(png_ptr, &row_pointers[y], 1); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 987 | } |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 988 | #endif no_entire /* Use only one output method */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 989 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 990 | /* You can write optional chunks like tEXt, zTXt, and tIME at the end |
Glenn Randers-Pehrson | f0a8fe0 | 2009-04-14 08:28:15 -0500 | [diff] [blame] | 991 | * as well. Shouldn't be necessary in 1.2.0 and up as all the public |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 992 | * chunks are supported and you can use png_set_unknown_chunks() to |
| 993 | * register unknown chunks into the info structure to be written out. |
Guy Schalnat | e5a3779 | 1996-06-05 15:50:50 -0500 | [diff] [blame] | 994 | */ |
| 995 | |
Andreas Dilger | 47a0c42 | 1997-05-16 02:46:07 -0500 | [diff] [blame] | 996 | /* It is REQUIRED to call this to finish writing the rest of the file */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 997 | png_write_end(png_ptr, info_ptr); |
Glenn Randers-Pehrson | 61c32d9 | 2000-02-04 23:40:16 -0600 | [diff] [blame] | 998 | #endif hilevel |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 999 | |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 1000 | /* If you png_malloced a palette, free it here (don't free info_ptr->palette, |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 1001 | * as recommended in versions 1.0.5m and earlier of this example; if |
| 1002 | * libpng mallocs info_ptr->palette, libpng will free it). If you |
| 1003 | * allocated it with malloc() instead of png_malloc(), use free() instead |
| 1004 | * of png_free(). |
| 1005 | */ |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 1006 | png_free(png_ptr, palette); |
Glenn Randers-Pehrson | 895a9c9 | 2008-07-25 08:51:18 -0500 | [diff] [blame] | 1007 | palette = NULL; |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 1008 | |
| 1009 | /* Similarly, if you png_malloced any data that you passed in with |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 1010 | * png_set_something(), such as a hist or trans array, free it here, |
| 1011 | * when you can be sure that libpng is through with it. |
| 1012 | */ |
Glenn Randers-Pehrson | a77ef62 | 2000-02-18 13:48:52 -0600 | [diff] [blame] | 1013 | png_free(png_ptr, trans); |
Glenn Randers-Pehrson | 895a9c9 | 2008-07-25 08:51:18 -0500 | [diff] [blame] | 1014 | trans = NULL; |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 1015 | /* Whenever you use png_free() it is a good idea to set the pointer to |
| 1016 | * NULL in case your application inadvertently tries to png_free() it |
| 1017 | * again. When png_free() sees a NULL it returns without action, thus |
| 1018 | * avoiding the double-free security problem. |
| 1019 | */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 1020 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 1021 | /* Clean up after the write, and free any memory allocated */ |
Glenn Randers-Pehrson | fc4a143 | 2000-05-17 17:39:34 -0500 | [diff] [blame] | 1022 | png_destroy_write_struct(&png_ptr, &info_ptr); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 1023 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 1024 | /* Close the file */ |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 1025 | fclose(fp); |
| 1026 | |
Glenn Randers-Pehrson | 64548de | 2009-05-13 15:23:03 -0500 | [diff] [blame] | 1027 | /* That's it */ |
Glenn Randers-Pehrson | 104622b | 2000-05-29 08:58:03 -0500 | [diff] [blame] | 1028 | return (OK); |
Guy Schalnat | 0d58058 | 1995-07-20 02:43:20 -0500 | [diff] [blame] | 1029 | } |
| 1030 | |
Glenn Randers-Pehrson | 860ab2b | 1999-10-14 07:43:10 -0500 | [diff] [blame] | 1031 | #endif /* if 0 */ |