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