lodepng.h (82254B)
1 /* 2 LodePNG version 20161127 3 4 Copyright (c) 2005-2016 Lode Vandevenne 5 6 This software is provided 'as-is', without any express or implied 7 warranty. In no event will the authors be held liable for any damages 8 arising from the use of this software. 9 10 Permission is granted to anyone to use this software for any purpose, 11 including commercial applications, and to alter it and redistribute it 12 freely, subject to the following restrictions: 13 14 1. The origin of this software must not be misrepresented; you must not 15 claim that you wrote the original software. If you use this software 16 in a product, an acknowledgment in the product documentation would be 17 appreciated but is not required. 18 19 2. Altered source versions must be plainly marked as such, and must not be 20 misrepresented as being the original software. 21 22 3. This notice may not be removed or altered from any source 23 distribution. 24 */ 25 26 #ifndef LODEPNG_H 27 #define LODEPNG_H 28 29 #include <string.h> /*for size_t*/ 30 31 extern const char* LODEPNG_VERSION_STRING; 32 33 /* 34 The following #defines are used to create code sections. They can be disabled 35 to disable code sections, which can give faster compile time and smaller binary. 36 The "NO_COMPILE" defines are designed to be used to pass as defines to the 37 compiler command to disable them without modifying this header, e.g. 38 -DLODEPNG_NO_COMPILE_ZLIB for gcc. 39 In addition to those below, you can also define LODEPNG_NO_COMPILE_CRC to 40 allow implementing a custom lodepng_crc32. 41 */ 42 /*deflate & zlib. If disabled, you must specify alternative zlib functions in 43 the custom_zlib field of the compress and decompress settings*/ 44 #ifndef LODEPNG_NO_COMPILE_ZLIB 45 #define LODEPNG_COMPILE_ZLIB 46 #endif 47 /*png encoder and png decoder*/ 48 #ifndef LODEPNG_NO_COMPILE_PNG 49 #define LODEPNG_COMPILE_PNG 50 #endif 51 /*deflate&zlib decoder and png decoder*/ 52 #ifndef LODEPNG_NO_COMPILE_DECODER 53 #define LODEPNG_COMPILE_DECODER 54 #endif 55 /*deflate&zlib encoder and png encoder*/ 56 #ifndef LODEPNG_NO_COMPILE_ENCODER 57 #define LODEPNG_COMPILE_ENCODER 58 #endif 59 /*the optional built in harddisk file loading and saving functions*/ 60 #ifndef LODEPNG_NO_COMPILE_DISK 61 #define LODEPNG_COMPILE_DISK 62 #endif 63 /*support for chunks other than IHDR, IDAT, PLTE, tRNS, IEND: ancillary and unknown chunks*/ 64 #ifndef LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS 65 #define LODEPNG_COMPILE_ANCILLARY_CHUNKS 66 #endif 67 /*ability to convert error numerical codes to English text string*/ 68 #ifndef LODEPNG_NO_COMPILE_ERROR_TEXT 69 #define LODEPNG_COMPILE_ERROR_TEXT 70 #endif 71 /*Compile the default allocators (C's free, malloc and realloc). If you disable this, 72 you can define the functions lodepng_free, lodepng_malloc and lodepng_realloc in your 73 source files with custom allocators.*/ 74 #ifndef LODEPNG_NO_COMPILE_ALLOCATORS 75 #define LODEPNG_COMPILE_ALLOCATORS 76 #endif 77 /*compile the C++ version (you can disable the C++ wrapper here even when compiling for C++)*/ 78 #ifdef __cplusplus 79 #ifndef LODEPNG_NO_COMPILE_CPP 80 #define LODEPNG_COMPILE_CPP 81 #endif 82 #endif 83 84 #ifdef LODEPNG_COMPILE_CPP 85 #include <vector> 86 #include <string> 87 #endif /*LODEPNG_COMPILE_CPP*/ 88 89 #ifdef LODEPNG_COMPILE_PNG 90 /*The PNG color types (also used for raw).*/ 91 typedef enum LodePNGColorType 92 { 93 LCT_GREY = 0, /*greyscale: 1,2,4,8,16 bit*/ 94 LCT_RGB = 2, /*RGB: 8,16 bit*/ 95 LCT_PALETTE = 3, /*palette: 1,2,4,8 bit*/ 96 LCT_GREY_ALPHA = 4, /*greyscale with alpha: 8,16 bit*/ 97 LCT_RGBA = 6 /*RGB with alpha: 8,16 bit*/ 98 } LodePNGColorType; 99 100 #ifdef LODEPNG_COMPILE_DECODER 101 /* 102 Converts PNG data in memory to raw pixel data. 103 out: Output parameter. Pointer to buffer that will contain the raw pixel data. 104 After decoding, its size is w * h * (bytes per pixel) bytes larger than 105 initially. Bytes per pixel depends on colortype and bitdepth. 106 Must be freed after usage with free(*out). 107 Note: for 16-bit per channel colors, uses big endian format like PNG does. 108 w: Output parameter. Pointer to width of pixel data. 109 h: Output parameter. Pointer to height of pixel data. 110 in: Memory buffer with the PNG file. 111 insize: size of the in buffer. 112 colortype: the desired color type for the raw output image. See explanation on PNG color types. 113 bitdepth: the desired bit depth for the raw output image. See explanation on PNG color types. 114 Return value: LodePNG error code (0 means no error). 115 */ 116 unsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h, 117 const unsigned char* in, size_t insize, 118 LodePNGColorType colortype, unsigned bitdepth); 119 120 /*Same as lodepng_decode_memory, but always decodes to 32-bit RGBA raw image*/ 121 unsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h, 122 const unsigned char* in, size_t insize); 123 124 /*Same as lodepng_decode_memory, but always decodes to 24-bit RGB raw image*/ 125 unsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h, 126 const unsigned char* in, size_t insize); 127 128 #ifdef LODEPNG_COMPILE_DISK 129 /* 130 Load PNG from disk, from file with given name. 131 Same as the other decode functions, but instead takes a filename as input. 132 */ 133 unsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h, 134 const char* filename, 135 LodePNGColorType colortype, unsigned bitdepth); 136 137 /*Same as lodepng_decode_file, but always decodes to 32-bit RGBA raw image.*/ 138 unsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h, 139 const char* filename); 140 141 /*Same as lodepng_decode_file, but always decodes to 24-bit RGB raw image.*/ 142 unsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h, 143 const char* filename); 144 #endif /*LODEPNG_COMPILE_DISK*/ 145 #endif /*LODEPNG_COMPILE_DECODER*/ 146 147 148 #ifdef LODEPNG_COMPILE_ENCODER 149 /* 150 Converts raw pixel data into a PNG image in memory. The colortype and bitdepth 151 of the output PNG image cannot be chosen, they are automatically determined 152 by the colortype, bitdepth and content of the input pixel data. 153 Note: for 16-bit per channel colors, needs big endian format like PNG does. 154 out: Output parameter. Pointer to buffer that will contain the PNG image data. 155 Must be freed after usage with free(*out). 156 outsize: Output parameter. Pointer to the size in bytes of the out buffer. 157 image: The raw pixel data to encode. The size of this buffer should be 158 w * h * (bytes per pixel), bytes per pixel depends on colortype and bitdepth. 159 w: width of the raw pixel data in pixels. 160 h: height of the raw pixel data in pixels. 161 colortype: the color type of the raw input image. See explanation on PNG color types. 162 bitdepth: the bit depth of the raw input image. See explanation on PNG color types. 163 Return value: LodePNG error code (0 means no error). 164 */ 165 unsigned lodepng_encode_memory(unsigned char** out, size_t* outsize, 166 const unsigned char* image, unsigned w, unsigned h, 167 LodePNGColorType colortype, unsigned bitdepth); 168 169 /*Same as lodepng_encode_memory, but always encodes from 32-bit RGBA raw image.*/ 170 unsigned lodepng_encode32(unsigned char** out, size_t* outsize, 171 const unsigned char* image, unsigned w, unsigned h); 172 173 /*Same as lodepng_encode_memory, but always encodes from 24-bit RGB raw image.*/ 174 unsigned lodepng_encode24(unsigned char** out, size_t* outsize, 175 const unsigned char* image, unsigned w, unsigned h); 176 177 #ifdef LODEPNG_COMPILE_DISK 178 /* 179 Converts raw pixel data into a PNG file on disk. 180 Same as the other encode functions, but instead takes a filename as output. 181 NOTE: This overwrites existing files without warning! 182 */ 183 unsigned lodepng_encode_file(const char* filename, 184 const unsigned char* image, unsigned w, unsigned h, 185 LodePNGColorType colortype, unsigned bitdepth); 186 187 /*Same as lodepng_encode_file, but always encodes from 32-bit RGBA raw image.*/ 188 unsigned lodepng_encode32_file(const char* filename, 189 const unsigned char* image, unsigned w, unsigned h); 190 191 /*Same as lodepng_encode_file, but always encodes from 24-bit RGB raw image.*/ 192 unsigned lodepng_encode24_file(const char* filename, 193 const unsigned char* image, unsigned w, unsigned h); 194 #endif /*LODEPNG_COMPILE_DISK*/ 195 #endif /*LODEPNG_COMPILE_ENCODER*/ 196 197 198 #ifdef LODEPNG_COMPILE_CPP 199 namespace lodepng 200 { 201 #ifdef LODEPNG_COMPILE_DECODER 202 /*Same as lodepng_decode_memory, but decodes to an std::vector. The colortype 203 is the format to output the pixels to. Default is RGBA 8-bit per channel.*/ 204 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h, 205 const unsigned char* in, size_t insize, 206 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); 207 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h, 208 const std::vector<unsigned char>& in, 209 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); 210 #ifdef LODEPNG_COMPILE_DISK 211 /* 212 Converts PNG file from disk to raw pixel data in memory. 213 Same as the other decode functions, but instead takes a filename as input. 214 */ 215 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h, 216 const std::string& filename, 217 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); 218 #endif /* LODEPNG_COMPILE_DISK */ 219 #endif /* LODEPNG_COMPILE_DECODER */ 220 221 #ifdef LODEPNG_COMPILE_ENCODER 222 /*Same as lodepng_encode_memory, but encodes to an std::vector. colortype 223 is that of the raw input data. The output PNG color type will be auto chosen.*/ 224 unsigned encode(std::vector<unsigned char>& out, 225 const unsigned char* in, unsigned w, unsigned h, 226 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); 227 unsigned encode(std::vector<unsigned char>& out, 228 const std::vector<unsigned char>& in, unsigned w, unsigned h, 229 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); 230 #ifdef LODEPNG_COMPILE_DISK 231 /* 232 Converts 32-bit RGBA raw pixel data into a PNG file on disk. 233 Same as the other encode functions, but instead takes a filename as output. 234 NOTE: This overwrites existing files without warning! 235 */ 236 unsigned encode(const std::string& filename, 237 const unsigned char* in, unsigned w, unsigned h, 238 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); 239 unsigned encode(const std::string& filename, 240 const std::vector<unsigned char>& in, unsigned w, unsigned h, 241 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); 242 #endif /* LODEPNG_COMPILE_DISK */ 243 #endif /* LODEPNG_COMPILE_ENCODER */ 244 } /* namespace lodepng */ 245 #endif /*LODEPNG_COMPILE_CPP*/ 246 #endif /*LODEPNG_COMPILE_PNG*/ 247 248 #ifdef LODEPNG_COMPILE_ERROR_TEXT 249 /*Returns an English description of the numerical error code.*/ 250 const char* lodepng_error_text(unsigned code); 251 #endif /*LODEPNG_COMPILE_ERROR_TEXT*/ 252 253 #ifdef LODEPNG_COMPILE_DECODER 254 /*Settings for zlib decompression*/ 255 typedef struct LodePNGDecompressSettings LodePNGDecompressSettings; 256 struct LodePNGDecompressSettings 257 { 258 unsigned ignore_adler32; /*if 1, continue and don't give an error message if the Adler32 checksum is corrupted*/ 259 260 /*use custom zlib decoder instead of built in one (default: null)*/ 261 unsigned (*custom_zlib)(unsigned char**, size_t*, 262 const unsigned char*, size_t, 263 const LodePNGDecompressSettings*); 264 /*use custom deflate decoder instead of built in one (default: null) 265 if custom_zlib is used, custom_deflate is ignored since only the built in 266 zlib function will call custom_deflate*/ 267 unsigned (*custom_inflate)(unsigned char**, size_t*, 268 const unsigned char*, size_t, 269 const LodePNGDecompressSettings*); 270 271 const void* custom_context; /*optional custom settings for custom functions*/ 272 }; 273 274 extern const LodePNGDecompressSettings lodepng_default_decompress_settings; 275 void lodepng_decompress_settings_init(LodePNGDecompressSettings* settings); 276 #endif /*LODEPNG_COMPILE_DECODER*/ 277 278 #ifdef LODEPNG_COMPILE_ENCODER 279 /* 280 Settings for zlib compression. Tweaking these settings tweaks the balance 281 between speed and compression ratio. 282 */ 283 typedef struct LodePNGCompressSettings LodePNGCompressSettings; 284 struct LodePNGCompressSettings /*deflate = compress*/ 285 { 286 /*LZ77 related settings*/ 287 unsigned btype; /*the block type for LZ (0, 1, 2 or 3, see zlib standard). Should be 2 for proper compression.*/ 288 unsigned use_lz77; /*whether or not to use LZ77. Should be 1 for proper compression.*/ 289 unsigned windowsize; /*must be a power of two <= 32768. higher compresses more but is slower. Default value: 2048.*/ 290 unsigned minmatch; /*mininum lz77 length. 3 is normally best, 6 can be better for some PNGs. Default: 0*/ 291 unsigned nicematch; /*stop searching if >= this length found. Set to 258 for best compression. Default: 128*/ 292 unsigned lazymatching; /*use lazy matching: better compression but a bit slower. Default: true*/ 293 294 /*use custom zlib encoder instead of built in one (default: null)*/ 295 unsigned (*custom_zlib)(unsigned char**, size_t*, 296 const unsigned char*, size_t, 297 const LodePNGCompressSettings*); 298 /*use custom deflate encoder instead of built in one (default: null) 299 if custom_zlib is used, custom_deflate is ignored since only the built in 300 zlib function will call custom_deflate*/ 301 unsigned (*custom_deflate)(unsigned char**, size_t*, 302 const unsigned char*, size_t, 303 const LodePNGCompressSettings*); 304 305 const void* custom_context; /*optional custom settings for custom functions*/ 306 }; 307 308 extern const LodePNGCompressSettings lodepng_default_compress_settings; 309 void lodepng_compress_settings_init(LodePNGCompressSettings* settings); 310 #endif /*LODEPNG_COMPILE_ENCODER*/ 311 312 #ifdef LODEPNG_COMPILE_PNG 313 /* 314 Color mode of an image. Contains all information required to decode the pixel 315 bits to RGBA colors. This information is the same as used in the PNG file 316 format, and is used both for PNG and raw image data in LodePNG. 317 */ 318 typedef struct LodePNGColorMode 319 { 320 /*header (IHDR)*/ 321 LodePNGColorType colortype; /*color type, see PNG standard or documentation further in this header file*/ 322 unsigned bitdepth; /*bits per sample, see PNG standard or documentation further in this header file*/ 323 324 /* 325 palette (PLTE and tRNS) 326 327 Dynamically allocated with the colors of the palette, including alpha. 328 When encoding a PNG, to store your colors in the palette of the LodePNGColorMode, first use 329 lodepng_palette_clear, then for each color use lodepng_palette_add. 330 If you encode an image without alpha with palette, don't forget to put value 255 in each A byte of the palette. 331 332 When decoding, by default you can ignore this palette, since LodePNG already 333 fills the palette colors in the pixels of the raw RGBA output. 334 335 The palette is only supported for color type 3. 336 */ 337 unsigned char* palette; /*palette in RGBARGBA... order. When allocated, must be either 0, or have size 1024*/ 338 size_t palettesize; /*palette size in number of colors (amount of bytes is 4 * palettesize)*/ 339 340 /* 341 transparent color key (tRNS) 342 343 This color uses the same bit depth as the bitdepth value in this struct, which can be 1-bit to 16-bit. 344 For greyscale PNGs, r, g and b will all 3 be set to the same. 345 346 When decoding, by default you can ignore this information, since LodePNG sets 347 pixels with this key to transparent already in the raw RGBA output. 348 349 The color key is only supported for color types 0 and 2. 350 */ 351 unsigned key_defined; /*is a transparent color key given? 0 = false, 1 = true*/ 352 unsigned key_r; /*red/greyscale component of color key*/ 353 unsigned key_g; /*green component of color key*/ 354 unsigned key_b; /*blue component of color key*/ 355 } LodePNGColorMode; 356 357 /*init, cleanup and copy functions to use with this struct*/ 358 void lodepng_color_mode_init(LodePNGColorMode* info); 359 void lodepng_color_mode_cleanup(LodePNGColorMode* info); 360 /*return value is error code (0 means no error)*/ 361 unsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source); 362 363 void lodepng_palette_clear(LodePNGColorMode* info); 364 /*add 1 color to the palette*/ 365 unsigned lodepng_palette_add(LodePNGColorMode* info, 366 unsigned char r, unsigned char g, unsigned char b, unsigned char a); 367 368 /*get the total amount of bits per pixel, based on colortype and bitdepth in the struct*/ 369 unsigned lodepng_get_bpp(const LodePNGColorMode* info); 370 /*get the amount of color channels used, based on colortype in the struct. 371 If a palette is used, it counts as 1 channel.*/ 372 unsigned lodepng_get_channels(const LodePNGColorMode* info); 373 /*is it a greyscale type? (only colortype 0 or 4)*/ 374 unsigned lodepng_is_greyscale_type(const LodePNGColorMode* info); 375 /*has it got an alpha channel? (only colortype 2 or 6)*/ 376 unsigned lodepng_is_alpha_type(const LodePNGColorMode* info); 377 /*has it got a palette? (only colortype 3)*/ 378 unsigned lodepng_is_palette_type(const LodePNGColorMode* info); 379 /*only returns true if there is a palette and there is a value in the palette with alpha < 255. 380 Loops through the palette to check this.*/ 381 unsigned lodepng_has_palette_alpha(const LodePNGColorMode* info); 382 /* 383 Check if the given color info indicates the possibility of having non-opaque pixels in the PNG image. 384 Returns true if the image can have translucent or invisible pixels (it still be opaque if it doesn't use such pixels). 385 Returns false if the image can only have opaque pixels. 386 In detail, it returns true only if it's a color type with alpha, or has a palette with non-opaque values, 387 or if "key_defined" is true. 388 */ 389 unsigned lodepng_can_have_alpha(const LodePNGColorMode* info); 390 /*Returns the byte size of a raw image buffer with given width, height and color mode*/ 391 size_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color); 392 393 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS 394 /*The information of a Time chunk in PNG.*/ 395 typedef struct LodePNGTime 396 { 397 unsigned year; /*2 bytes used (0-65535)*/ 398 unsigned month; /*1-12*/ 399 unsigned day; /*1-31*/ 400 unsigned hour; /*0-23*/ 401 unsigned minute; /*0-59*/ 402 unsigned second; /*0-60 (to allow for leap seconds)*/ 403 } LodePNGTime; 404 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ 405 406 /*Information about the PNG image, except pixels, width and height.*/ 407 typedef struct LodePNGInfo 408 { 409 /*header (IHDR), palette (PLTE) and transparency (tRNS) chunks*/ 410 unsigned compression_method;/*compression method of the original file. Always 0.*/ 411 unsigned filter_method; /*filter method of the original file*/ 412 unsigned interlace_method; /*interlace method of the original file*/ 413 LodePNGColorMode color; /*color type and bits, palette and transparency of the PNG file*/ 414 415 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS 416 /* 417 suggested background color chunk (bKGD) 418 This color uses the same color mode as the PNG (except alpha channel), which can be 1-bit to 16-bit. 419 420 For greyscale PNGs, r, g and b will all 3 be set to the same. When encoding 421 the encoder writes the red one. For palette PNGs: When decoding, the RGB value 422 will be stored, not a palette index. But when encoding, specify the index of 423 the palette in background_r, the other two are then ignored. 424 425 The decoder does not use this background color to edit the color of pixels. 426 */ 427 unsigned background_defined; /*is a suggested background color given?*/ 428 unsigned background_r; /*red component of suggested background color*/ 429 unsigned background_g; /*green component of suggested background color*/ 430 unsigned background_b; /*blue component of suggested background color*/ 431 432 /* 433 non-international text chunks (tEXt and zTXt) 434 435 The char** arrays each contain num strings. The actual messages are in 436 text_strings, while text_keys are keywords that give a short description what 437 the actual text represents, e.g. Title, Author, Description, or anything else. 438 439 A keyword is minimum 1 character and maximum 79 characters long. It's 440 discouraged to use a single line length longer than 79 characters for texts. 441 442 Don't allocate these text buffers yourself. Use the init/cleanup functions 443 correctly and use lodepng_add_text and lodepng_clear_text. 444 */ 445 size_t text_num; /*the amount of texts in these char** buffers (there may be more texts in itext)*/ 446 char** text_keys; /*the keyword of a text chunk (e.g. "Comment")*/ 447 char** text_strings; /*the actual text*/ 448 449 /* 450 international text chunks (iTXt) 451 Similar to the non-international text chunks, but with additional strings 452 "langtags" and "transkeys". 453 */ 454 size_t itext_num; /*the amount of international texts in this PNG*/ 455 char** itext_keys; /*the English keyword of the text chunk (e.g. "Comment")*/ 456 char** itext_langtags; /*language tag for this text's language, ISO/IEC 646 string, e.g. ISO 639 language tag*/ 457 char** itext_transkeys; /*keyword translated to the international language - UTF-8 string*/ 458 char** itext_strings; /*the actual international text - UTF-8 string*/ 459 460 /*time chunk (tIME)*/ 461 unsigned time_defined; /*set to 1 to make the encoder generate a tIME chunk*/ 462 LodePNGTime time; 463 464 /*phys chunk (pHYs)*/ 465 unsigned phys_defined; /*if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one*/ 466 unsigned phys_x; /*pixels per unit in x direction*/ 467 unsigned phys_y; /*pixels per unit in y direction*/ 468 unsigned phys_unit; /*may be 0 (unknown unit) or 1 (metre)*/ 469 470 /* 471 unknown chunks 472 There are 3 buffers, one for each position in the PNG where unknown chunks can appear 473 each buffer contains all unknown chunks for that position consecutively 474 The 3 buffers are the unknown chunks between certain critical chunks: 475 0: IHDR-PLTE, 1: PLTE-IDAT, 2: IDAT-IEND 476 Do not allocate or traverse this data yourself. Use the chunk traversing functions declared 477 later, such as lodepng_chunk_next and lodepng_chunk_append, to read/write this struct. 478 */ 479 unsigned char* unknown_chunks_data[3]; 480 size_t unknown_chunks_size[3]; /*size in bytes of the unknown chunks, given for protection*/ 481 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ 482 } LodePNGInfo; 483 484 /*init, cleanup and copy functions to use with this struct*/ 485 void lodepng_info_init(LodePNGInfo* info); 486 void lodepng_info_cleanup(LodePNGInfo* info); 487 /*return value is error code (0 means no error)*/ 488 unsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source); 489 490 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS 491 void lodepng_clear_text(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/ 492 unsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str); /*push back both texts at once*/ 493 494 void lodepng_clear_itext(LodePNGInfo* info); /*use this to clear the itexts again after you filled them in*/ 495 unsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag, 496 const char* transkey, const char* str); /*push back the 4 texts of 1 chunk at once*/ 497 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ 498 499 /* 500 Converts raw buffer from one color type to another color type, based on 501 LodePNGColorMode structs to describe the input and output color type. 502 See the reference manual at the end of this header file to see which color conversions are supported. 503 return value = LodePNG error code (0 if all went ok, an error if the conversion isn't supported) 504 The out buffer must have size (w * h * bpp + 7) / 8, where bpp is the bits per pixel 505 of the output color type (lodepng_get_bpp). 506 For < 8 bpp images, there should not be padding bits at the end of scanlines. 507 For 16-bit per channel colors, uses big endian format like PNG does. 508 Return value is LodePNG error code 509 */ 510 unsigned lodepng_convert(unsigned char* out, const unsigned char* in, 511 const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in, 512 unsigned w, unsigned h); 513 514 #ifdef LODEPNG_COMPILE_DECODER 515 /* 516 Settings for the decoder. This contains settings for the PNG and the Zlib 517 decoder, but not the Info settings from the Info structs. 518 */ 519 typedef struct LodePNGDecoderSettings 520 { 521 LodePNGDecompressSettings zlibsettings; /*in here is the setting to ignore Adler32 checksums*/ 522 523 unsigned ignore_crc; /*ignore CRC checksums*/ 524 525 unsigned color_convert; /*whether to convert the PNG to the color type you want. Default: yes*/ 526 527 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS 528 unsigned read_text_chunks; /*if false but remember_unknown_chunks is true, they're stored in the unknown chunks*/ 529 /*store all bytes from unknown chunks in the LodePNGInfo (off by default, useful for a png editor)*/ 530 unsigned remember_unknown_chunks; 531 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ 532 } LodePNGDecoderSettings; 533 534 void lodepng_decoder_settings_init(LodePNGDecoderSettings* settings); 535 #endif /*LODEPNG_COMPILE_DECODER*/ 536 537 #ifdef LODEPNG_COMPILE_ENCODER 538 /*automatically use color type with less bits per pixel if losslessly possible. Default: AUTO*/ 539 typedef enum LodePNGFilterStrategy 540 { 541 /*every filter at zero*/ 542 LFS_ZERO, 543 /*Use filter that gives minimum sum, as described in the official PNG filter heuristic.*/ 544 LFS_MINSUM, 545 /*Use the filter type that gives smallest Shannon entropy for this scanline. Depending 546 on the image, this is better or worse than minsum.*/ 547 LFS_ENTROPY, 548 /* 549 Brute-force-search PNG filters by compressing each filter for each scanline. 550 Experimental, very slow, and only rarely gives better compression than MINSUM. 551 */ 552 LFS_BRUTE_FORCE, 553 /*use predefined_filters buffer: you specify the filter type for each scanline*/ 554 LFS_PREDEFINED 555 } LodePNGFilterStrategy; 556 557 /*Gives characteristics about the colors of the image, which helps decide which color model to use for encoding. 558 Used internally by default if "auto_convert" is enabled. Public because it's useful for custom algorithms.*/ 559 typedef struct LodePNGColorProfile 560 { 561 unsigned colored; /*not greyscale*/ 562 unsigned key; /*image is not opaque and color key is possible instead of full alpha*/ 563 unsigned short key_r; /*key values, always as 16-bit, in 8-bit case the byte is duplicated, e.g. 65535 means 255*/ 564 unsigned short key_g; 565 unsigned short key_b; 566 unsigned alpha; /*image is not opaque and alpha channel or alpha palette required*/ 567 unsigned numcolors; /*amount of colors, up to 257. Not valid if bits == 16.*/ 568 unsigned char palette[1024]; /*Remembers up to the first 256 RGBA colors, in no particular order*/ 569 unsigned bits; /*bits per channel (not for palette). 1,2 or 4 for greyscale only. 16 if 16-bit per channel required.*/ 570 } LodePNGColorProfile; 571 572 void lodepng_color_profile_init(LodePNGColorProfile* profile); 573 574 /*Get a LodePNGColorProfile of the image.*/ 575 unsigned lodepng_get_color_profile(LodePNGColorProfile* profile, 576 const unsigned char* image, unsigned w, unsigned h, 577 const LodePNGColorMode* mode_in); 578 /*The function LodePNG uses internally to decide the PNG color with auto_convert. 579 Chooses an optimal color model, e.g. grey if only grey pixels, palette if < 256 colors, ...*/ 580 unsigned lodepng_auto_choose_color(LodePNGColorMode* mode_out, 581 const unsigned char* image, unsigned w, unsigned h, 582 const LodePNGColorMode* mode_in); 583 584 /*Settings for the encoder.*/ 585 typedef struct LodePNGEncoderSettings 586 { 587 LodePNGCompressSettings zlibsettings; /*settings for the zlib encoder, such as window size, ...*/ 588 589 unsigned auto_convert; /*automatically choose output PNG color type. Default: true*/ 590 591 /*If true, follows the official PNG heuristic: if the PNG uses a palette or lower than 592 8 bit depth, set all filters to zero. Otherwise use the filter_strategy. Note that to 593 completely follow the official PNG heuristic, filter_palette_zero must be true and 594 filter_strategy must be LFS_MINSUM*/ 595 unsigned filter_palette_zero; 596 /*Which filter strategy to use when not using zeroes due to filter_palette_zero. 597 Set filter_palette_zero to 0 to ensure always using your chosen strategy. Default: LFS_MINSUM*/ 598 LodePNGFilterStrategy filter_strategy; 599 /*used if filter_strategy is LFS_PREDEFINED. In that case, this must point to a buffer with 600 the same length as the amount of scanlines in the image, and each value must <= 5. You 601 have to cleanup this buffer, LodePNG will never free it. Don't forget that filter_palette_zero 602 must be set to 0 to ensure this is also used on palette or low bitdepth images.*/ 603 const unsigned char* predefined_filters; 604 605 /*force creating a PLTE chunk if colortype is 2 or 6 (= a suggested palette). 606 If colortype is 3, PLTE is _always_ created.*/ 607 unsigned force_palette; 608 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS 609 /*add LodePNG identifier and version as a text chunk, for debugging*/ 610 unsigned add_id; 611 /*encode text chunks as zTXt chunks instead of tEXt chunks, and use compression in iTXt chunks*/ 612 unsigned text_compression; 613 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ 614 } LodePNGEncoderSettings; 615 616 void lodepng_encoder_settings_init(LodePNGEncoderSettings* settings); 617 #endif /*LODEPNG_COMPILE_ENCODER*/ 618 619 620 #if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) 621 /*The settings, state and information for extended encoding and decoding.*/ 622 typedef struct LodePNGState 623 { 624 #ifdef LODEPNG_COMPILE_DECODER 625 LodePNGDecoderSettings decoder; /*the decoding settings*/ 626 #endif /*LODEPNG_COMPILE_DECODER*/ 627 #ifdef LODEPNG_COMPILE_ENCODER 628 LodePNGEncoderSettings encoder; /*the encoding settings*/ 629 #endif /*LODEPNG_COMPILE_ENCODER*/ 630 LodePNGColorMode info_raw; /*specifies the format in which you would like to get the raw pixel buffer*/ 631 LodePNGInfo info_png; /*info of the PNG image obtained after decoding*/ 632 unsigned error; 633 #ifdef LODEPNG_COMPILE_CPP 634 /* For the lodepng::State subclass. */ 635 virtual ~LodePNGState(){} 636 #endif 637 } LodePNGState; 638 639 /*init, cleanup and copy functions to use with this struct*/ 640 void lodepng_state_init(LodePNGState* state); 641 void lodepng_state_cleanup(LodePNGState* state); 642 void lodepng_state_copy(LodePNGState* dest, const LodePNGState* source); 643 #endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */ 644 645 #ifdef LODEPNG_COMPILE_DECODER 646 /* 647 Same as lodepng_decode_memory, but uses a LodePNGState to allow custom settings and 648 getting much more information about the PNG image and color mode. 649 */ 650 unsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h, 651 LodePNGState* state, 652 const unsigned char* in, size_t insize); 653 654 /* 655 Read the PNG header, but not the actual data. This returns only the information 656 that is in the header chunk of the PNG, such as width, height and color type. The 657 information is placed in the info_png field of the LodePNGState. 658 */ 659 unsigned lodepng_inspect(unsigned* w, unsigned* h, 660 LodePNGState* state, 661 const unsigned char* in, size_t insize); 662 #endif /*LODEPNG_COMPILE_DECODER*/ 663 664 665 #ifdef LODEPNG_COMPILE_ENCODER 666 /*This function allocates the out buffer with standard malloc and stores the size in *outsize.*/ 667 unsigned lodepng_encode(unsigned char** out, size_t* outsize, 668 const unsigned char* image, unsigned w, unsigned h, 669 LodePNGState* state); 670 #endif /*LODEPNG_COMPILE_ENCODER*/ 671 672 /* 673 The lodepng_chunk functions are normally not needed, except to traverse the 674 unknown chunks stored in the LodePNGInfo struct, or add new ones to it. 675 It also allows traversing the chunks of an encoded PNG file yourself. 676 677 PNG standard chunk naming conventions: 678 First byte: uppercase = critical, lowercase = ancillary 679 Second byte: uppercase = public, lowercase = private 680 Third byte: must be uppercase 681 Fourth byte: uppercase = unsafe to copy, lowercase = safe to copy 682 */ 683 684 /* 685 Gets the length of the data of the chunk. Total chunk length has 12 bytes more. 686 There must be at least 4 bytes to read from. If the result value is too large, 687 it may be corrupt data. 688 */ 689 unsigned lodepng_chunk_length(const unsigned char* chunk); 690 691 /*puts the 4-byte type in null terminated string*/ 692 void lodepng_chunk_type(char type[5], const unsigned char* chunk); 693 694 /*check if the type is the given type*/ 695 unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type); 696 697 /*0: it's one of the critical chunk types, 1: it's an ancillary chunk (see PNG standard)*/ 698 unsigned char lodepng_chunk_ancillary(const unsigned char* chunk); 699 700 /*0: public, 1: private (see PNG standard)*/ 701 unsigned char lodepng_chunk_private(const unsigned char* chunk); 702 703 /*0: the chunk is unsafe to copy, 1: the chunk is safe to copy (see PNG standard)*/ 704 unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk); 705 706 /*get pointer to the data of the chunk, where the input points to the header of the chunk*/ 707 unsigned char* lodepng_chunk_data(unsigned char* chunk); 708 const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk); 709 710 /*returns 0 if the crc is correct, 1 if it's incorrect (0 for OK as usual!)*/ 711 unsigned lodepng_chunk_check_crc(const unsigned char* chunk); 712 713 /*generates the correct CRC from the data and puts it in the last 4 bytes of the chunk*/ 714 void lodepng_chunk_generate_crc(unsigned char* chunk); 715 716 /*iterate to next chunks. don't use on IEND chunk, as there is no next chunk then*/ 717 unsigned char* lodepng_chunk_next(unsigned char* chunk); 718 const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk); 719 720 /* 721 Appends chunk to the data in out. The given chunk should already have its chunk header. 722 The out variable and outlength are updated to reflect the new reallocated buffer. 723 Returns error code (0 if it went ok) 724 */ 725 unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk); 726 727 /* 728 Appends new chunk to out. The chunk to append is given by giving its length, type 729 and data separately. The type is a 4-letter string. 730 The out variable and outlength are updated to reflect the new reallocated buffer. 731 Returne error code (0 if it went ok) 732 */ 733 unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length, 734 const char* type, const unsigned char* data); 735 736 737 /*Calculate CRC32 of buffer*/ 738 unsigned lodepng_crc32(const unsigned char* buf, size_t len); 739 #endif /*LODEPNG_COMPILE_PNG*/ 740 741 742 #ifdef LODEPNG_COMPILE_ZLIB 743 /* 744 This zlib part can be used independently to zlib compress and decompress a 745 buffer. It cannot be used to create gzip files however, and it only supports the 746 part of zlib that is required for PNG, it does not support dictionaries. 747 */ 748 749 #ifdef LODEPNG_COMPILE_DECODER 750 /*Inflate a buffer. Inflate is the decompression step of deflate. Out buffer must be freed after use.*/ 751 unsigned lodepng_inflate(unsigned char** out, size_t* outsize, 752 const unsigned char* in, size_t insize, 753 const LodePNGDecompressSettings* settings); 754 755 /* 756 Decompresses Zlib data. Reallocates the out buffer and appends the data. The 757 data must be according to the zlib specification. 758 Either, *out must be NULL and *outsize must be 0, or, *out must be a valid 759 buffer and *outsize its size in bytes. out must be freed by user after usage. 760 */ 761 unsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize, 762 const unsigned char* in, size_t insize, 763 const LodePNGDecompressSettings* settings); 764 #endif /*LODEPNG_COMPILE_DECODER*/ 765 766 #ifdef LODEPNG_COMPILE_ENCODER 767 /* 768 Compresses data with Zlib. Reallocates the out buffer and appends the data. 769 Zlib adds a small header and trailer around the deflate data. 770 The data is output in the format of the zlib specification. 771 Either, *out must be NULL and *outsize must be 0, or, *out must be a valid 772 buffer and *outsize its size in bytes. out must be freed by user after usage. 773 */ 774 unsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize, 775 const unsigned char* in, size_t insize, 776 const LodePNGCompressSettings* settings); 777 778 /* 779 Find length-limited Huffman code for given frequencies. This function is in the 780 public interface only for tests, it's used internally by lodepng_deflate. 781 */ 782 unsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies, 783 size_t numcodes, unsigned maxbitlen); 784 785 /*Compress a buffer with deflate. See RFC 1951. Out buffer must be freed after use.*/ 786 unsigned lodepng_deflate(unsigned char** out, size_t* outsize, 787 const unsigned char* in, size_t insize, 788 const LodePNGCompressSettings* settings); 789 790 #endif /*LODEPNG_COMPILE_ENCODER*/ 791 #endif /*LODEPNG_COMPILE_ZLIB*/ 792 793 #ifdef LODEPNG_COMPILE_DISK 794 /* 795 Load a file from disk into buffer. The function allocates the out buffer, and 796 after usage you should free it. 797 out: output parameter, contains pointer to loaded buffer. 798 outsize: output parameter, size of the allocated out buffer 799 filename: the path to the file to load 800 return value: error code (0 means ok) 801 */ 802 unsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename); 803 804 /* 805 Save a file from buffer to disk. Warning, if it exists, this function overwrites 806 the file without warning! 807 buffer: the buffer to write 808 buffersize: size of the buffer to write 809 filename: the path to the file to save to 810 return value: error code (0 means ok) 811 */ 812 unsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename); 813 #endif /*LODEPNG_COMPILE_DISK*/ 814 815 #ifdef LODEPNG_COMPILE_CPP 816 /* The LodePNG C++ wrapper uses std::vectors instead of manually allocated memory buffers. */ 817 namespace lodepng 818 { 819 #ifdef LODEPNG_COMPILE_PNG 820 class State : public LodePNGState 821 { 822 public: 823 State(); 824 State(const State& other); 825 virtual ~State(); 826 State& operator=(const State& other); 827 }; 828 829 #ifdef LODEPNG_COMPILE_DECODER 830 /* Same as other lodepng::decode, but using a State for more settings and information. */ 831 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h, 832 State& state, 833 const unsigned char* in, size_t insize); 834 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h, 835 State& state, 836 const std::vector<unsigned char>& in); 837 #endif /*LODEPNG_COMPILE_DECODER*/ 838 839 #ifdef LODEPNG_COMPILE_ENCODER 840 /* Same as other lodepng::encode, but using a State for more settings and information. */ 841 unsigned encode(std::vector<unsigned char>& out, 842 const unsigned char* in, unsigned w, unsigned h, 843 State& state); 844 unsigned encode(std::vector<unsigned char>& out, 845 const std::vector<unsigned char>& in, unsigned w, unsigned h, 846 State& state); 847 #endif /*LODEPNG_COMPILE_ENCODER*/ 848 849 #ifdef LODEPNG_COMPILE_DISK 850 /* 851 Load a file from disk into an std::vector. 852 return value: error code (0 means ok) 853 */ 854 unsigned load_file(std::vector<unsigned char>& buffer, const std::string& filename); 855 856 /* 857 Save the binary data in an std::vector to a file on disk. The file is overwritten 858 without warning. 859 */ 860 unsigned save_file(const std::vector<unsigned char>& buffer, const std::string& filename); 861 #endif /* LODEPNG_COMPILE_DISK */ 862 #endif /* LODEPNG_COMPILE_PNG */ 863 864 #ifdef LODEPNG_COMPILE_ZLIB 865 #ifdef LODEPNG_COMPILE_DECODER 866 /* Zlib-decompress an unsigned char buffer */ 867 unsigned decompress(std::vector<unsigned char>& out, const unsigned char* in, size_t insize, 868 const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings); 869 870 /* Zlib-decompress an std::vector */ 871 unsigned decompress(std::vector<unsigned char>& out, const std::vector<unsigned char>& in, 872 const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings); 873 #endif /* LODEPNG_COMPILE_DECODER */ 874 875 #ifdef LODEPNG_COMPILE_ENCODER 876 /* Zlib-compress an unsigned char buffer */ 877 unsigned compress(std::vector<unsigned char>& out, const unsigned char* in, size_t insize, 878 const LodePNGCompressSettings& settings = lodepng_default_compress_settings); 879 880 /* Zlib-compress an std::vector */ 881 unsigned compress(std::vector<unsigned char>& out, const std::vector<unsigned char>& in, 882 const LodePNGCompressSettings& settings = lodepng_default_compress_settings); 883 #endif /* LODEPNG_COMPILE_ENCODER */ 884 #endif /* LODEPNG_COMPILE_ZLIB */ 885 } /* namespace lodepng */ 886 #endif /*LODEPNG_COMPILE_CPP*/ 887 888 /* 889 TODO: 890 [.] test if there are no memory leaks or security exploits - done a lot but needs to be checked often 891 [.] check compatibility with various compilers - done but needs to be redone for every newer version 892 [X] converting color to 16-bit per channel types 893 [ ] read all public PNG chunk types (but never let the color profile and gamma ones touch RGB values) 894 [ ] make sure encoder generates no chunks with size > (2^31)-1 895 [ ] partial decoding (stream processing) 896 [X] let the "isFullyOpaque" function check color keys and transparent palettes too 897 [X] better name for the variables "codes", "codesD", "codelengthcodes", "clcl" and "lldl" 898 [ ] don't stop decoding on errors like 69, 57, 58 (make warnings) 899 [ ] make warnings like: oob palette, checksum fail, data after iend, wrong/unknown crit chunk, no null terminator in text, ... 900 [ ] let the C++ wrapper catch exceptions coming from the standard library and return LodePNG error codes 901 [ ] allow user to provide custom color conversion functions, e.g. for premultiplied alpha, padding bits or not, ... 902 [ ] allow user to give data (void*) to custom allocator 903 */ 904 905 #endif /*LODEPNG_H inclusion guard*/ 906 907 /* 908 LodePNG Documentation 909 --------------------- 910 911 0. table of contents 912 -------------------- 913 914 1. about 915 1.1. supported features 916 1.2. features not supported 917 2. C and C++ version 918 3. security 919 4. decoding 920 5. encoding 921 6. color conversions 922 6.1. PNG color types 923 6.2. color conversions 924 6.3. padding bits 925 6.4. A note about 16-bits per channel and endianness 926 7. error values 927 8. chunks and PNG editing 928 9. compiler support 929 10. examples 930 10.1. decoder C++ example 931 10.2. decoder C example 932 11. state settings reference 933 12. changes 934 13. contact information 935 936 937 1. about 938 -------- 939 940 PNG is a file format to store raster images losslessly with good compression, 941 supporting different color types and alpha channel. 942 943 LodePNG is a PNG codec according to the Portable Network Graphics (PNG) 944 Specification (Second Edition) - W3C Recommendation 10 November 2003. 945 946 The specifications used are: 947 948 *) Portable Network Graphics (PNG) Specification (Second Edition): 949 http://www.w3.org/TR/2003/REC-PNG-20031110 950 *) RFC 1950 ZLIB Compressed Data Format version 3.3: 951 http://www.gzip.org/zlib/rfc-zlib.html 952 *) RFC 1951 DEFLATE Compressed Data Format Specification ver 1.3: 953 http://www.gzip.org/zlib/rfc-deflate.html 954 955 The most recent version of LodePNG can currently be found at 956 http://lodev.org/lodepng/ 957 958 LodePNG works both in C (ISO C90) and C++, with a C++ wrapper that adds 959 extra functionality. 960 961 LodePNG exists out of two files: 962 -lodepng.h: the header file for both C and C++ 963 -lodepng.c(pp): give it the name lodepng.c or lodepng.cpp (or .cc) depending on your usage 964 965 If you want to start using LodePNG right away without reading this doc, get the 966 examples from the LodePNG website to see how to use it in code, or check the 967 smaller examples in chapter 13 here. 968 969 LodePNG is simple but only supports the basic requirements. To achieve 970 simplicity, the following design choices were made: There are no dependencies 971 on any external library. There are functions to decode and encode a PNG with 972 a single function call, and extended versions of these functions taking a 973 LodePNGState struct allowing to specify or get more information. By default 974 the colors of the raw image are always RGB or RGBA, no matter what color type 975 the PNG file uses. To read and write files, there are simple functions to 976 convert the files to/from buffers in memory. 977 978 This all makes LodePNG suitable for loading textures in games, demos and small 979 programs, ... It's less suitable for full fledged image editors, loading PNGs 980 over network (it requires all the image data to be available before decoding can 981 begin), life-critical systems, ... 982 983 1.1. supported features 984 ----------------------- 985 986 The following features are supported by the decoder: 987 988 *) decoding of PNGs with any color type, bit depth and interlace mode, to a 24- or 32-bit color raw image, 989 or the same color type as the PNG 990 *) encoding of PNGs, from any raw image to 24- or 32-bit color, or the same color type as the raw image 991 *) Adam7 interlace and deinterlace for any color type 992 *) loading the image from harddisk or decoding it from a buffer from other sources than harddisk 993 *) support for alpha channels, including RGBA color model, translucent palettes and color keying 994 *) zlib decompression (inflate) 995 *) zlib compression (deflate) 996 *) CRC32 and ADLER32 checksums 997 *) handling of unknown chunks, allowing making a PNG editor that stores custom and unknown chunks. 998 *) the following chunks are supported (generated/interpreted) by both encoder and decoder: 999 IHDR: header information 1000 PLTE: color palette 1001 IDAT: pixel data 1002 IEND: the final chunk 1003 tRNS: transparency for palettized images 1004 tEXt: textual information 1005 zTXt: compressed textual information 1006 iTXt: international textual information 1007 bKGD: suggested background color 1008 pHYs: physical dimensions 1009 tIME: modification time 1010 1011 1.2. features not supported 1012 --------------------------- 1013 1014 The following features are _not_ supported: 1015 1016 *) some features needed to make a conformant PNG-Editor might be still missing. 1017 *) partial loading/stream processing. All data must be available and is processed in one call. 1018 *) The following public chunks are not supported but treated as unknown chunks by LodePNG 1019 cHRM, gAMA, iCCP, sRGB, sBIT, hIST, sPLT 1020 Some of these are not supported on purpose: LodePNG wants to provide the RGB values 1021 stored in the pixels, not values modified by system dependent gamma or color models. 1022 1023 1024 2. C and C++ version 1025 -------------------- 1026 1027 The C version uses buffers allocated with alloc that you need to free() 1028 yourself. You need to use init and cleanup functions for each struct whenever 1029 using a struct from the C version to avoid exploits and memory leaks. 1030 1031 The C++ version has extra functions with std::vectors in the interface and the 1032 lodepng::State class which is a LodePNGState with constructor and destructor. 1033 1034 These files work without modification for both C and C++ compilers because all 1035 the additional C++ code is in "#ifdef __cplusplus" blocks that make C-compilers 1036 ignore it, and the C code is made to compile both with strict ISO C90 and C++. 1037 1038 To use the C++ version, you need to rename the source file to lodepng.cpp 1039 (instead of lodepng.c), and compile it with a C++ compiler. 1040 1041 To use the C version, you need to rename the source file to lodepng.c (instead 1042 of lodepng.cpp), and compile it with a C compiler. 1043 1044 1045 3. Security 1046 ----------- 1047 1048 Even if carefully designed, it's always possible that LodePNG contains possible 1049 exploits. If you discover one, please let me know, and it will be fixed. 1050 1051 When using LodePNG, care has to be taken with the C version of LodePNG, as well 1052 as the C-style structs when working with C++. The following conventions are used 1053 for all C-style structs: 1054 1055 -if a struct has a corresponding init function, always call the init function when making a new one 1056 -if a struct has a corresponding cleanup function, call it before the struct disappears to avoid memory leaks 1057 -if a struct has a corresponding copy function, use the copy function instead of "=". 1058 The destination must also be inited already. 1059 1060 1061 4. Decoding 1062 ----------- 1063 1064 Decoding converts a PNG compressed image to a raw pixel buffer. 1065 1066 Most documentation on using the decoder is at its declarations in the header 1067 above. For C, simple decoding can be done with functions such as 1068 lodepng_decode32, and more advanced decoding can be done with the struct 1069 LodePNGState and lodepng_decode. For C++, all decoding can be done with the 1070 various lodepng::decode functions, and lodepng::State can be used for advanced 1071 features. 1072 1073 When using the LodePNGState, it uses the following fields for decoding: 1074 *) LodePNGInfo info_png: it stores extra information about the PNG (the input) in here 1075 *) LodePNGColorMode info_raw: here you can say what color mode of the raw image (the output) you want to get 1076 *) LodePNGDecoderSettings decoder: you can specify a few extra settings for the decoder to use 1077 1078 LodePNGInfo info_png 1079 -------------------- 1080 1081 After decoding, this contains extra information of the PNG image, except the actual 1082 pixels, width and height because these are already gotten directly from the decoder 1083 functions. 1084 1085 It contains for example the original color type of the PNG image, text comments, 1086 suggested background color, etc... More details about the LodePNGInfo struct are 1087 at its declaration documentation. 1088 1089 LodePNGColorMode info_raw 1090 ------------------------- 1091 1092 When decoding, here you can specify which color type you want 1093 the resulting raw image to be. If this is different from the colortype of the 1094 PNG, then the decoder will automatically convert the result. This conversion 1095 always works, except if you want it to convert a color PNG to greyscale or to 1096 a palette with missing colors. 1097 1098 By default, 32-bit color is used for the result. 1099 1100 LodePNGDecoderSettings decoder 1101 ------------------------------ 1102 1103 The settings can be used to ignore the errors created by invalid CRC and Adler32 1104 chunks, and to disable the decoding of tEXt chunks. 1105 1106 There's also a setting color_convert, true by default. If false, no conversion 1107 is done, the resulting data will be as it was in the PNG (after decompression) 1108 and you'll have to puzzle the colors of the pixels together yourself using the 1109 color type information in the LodePNGInfo. 1110 1111 1112 5. Encoding 1113 ----------- 1114 1115 Encoding converts a raw pixel buffer to a PNG compressed image. 1116 1117 Most documentation on using the encoder is at its declarations in the header 1118 above. For C, simple encoding can be done with functions such as 1119 lodepng_encode32, and more advanced decoding can be done with the struct 1120 LodePNGState and lodepng_encode. For C++, all encoding can be done with the 1121 various lodepng::encode functions, and lodepng::State can be used for advanced 1122 features. 1123 1124 Like the decoder, the encoder can also give errors. However it gives less errors 1125 since the encoder input is trusted, the decoder input (a PNG image that could 1126 be forged by anyone) is not trusted. 1127 1128 When using the LodePNGState, it uses the following fields for encoding: 1129 *) LodePNGInfo info_png: here you specify how you want the PNG (the output) to be. 1130 *) LodePNGColorMode info_raw: here you say what color type of the raw image (the input) has 1131 *) LodePNGEncoderSettings encoder: you can specify a few settings for the encoder to use 1132 1133 LodePNGInfo info_png 1134 -------------------- 1135 1136 When encoding, you use this the opposite way as when decoding: for encoding, 1137 you fill in the values you want the PNG to have before encoding. By default it's 1138 not needed to specify a color type for the PNG since it's automatically chosen, 1139 but it's possible to choose it yourself given the right settings. 1140 1141 The encoder will not always exactly match the LodePNGInfo struct you give, 1142 it tries as close as possible. Some things are ignored by the encoder. The 1143 encoder uses, for example, the following settings from it when applicable: 1144 colortype and bitdepth, text chunks, time chunk, the color key, the palette, the 1145 background color, the interlace method, unknown chunks, ... 1146 1147 When encoding to a PNG with colortype 3, the encoder will generate a PLTE chunk. 1148 If the palette contains any colors for which the alpha channel is not 255 (so 1149 there are translucent colors in the palette), it'll add a tRNS chunk. 1150 1151 LodePNGColorMode info_raw 1152 ------------------------- 1153 1154 You specify the color type of the raw image that you give to the input here, 1155 including a possible transparent color key and palette you happen to be using in 1156 your raw image data. 1157 1158 By default, 32-bit color is assumed, meaning your input has to be in RGBA 1159 format with 4 bytes (unsigned chars) per pixel. 1160 1161 LodePNGEncoderSettings encoder 1162 ------------------------------ 1163 1164 The following settings are supported (some are in sub-structs): 1165 *) auto_convert: when this option is enabled, the encoder will 1166 automatically choose the smallest possible color mode (including color key) that 1167 can encode the colors of all pixels without information loss. 1168 *) btype: the block type for LZ77. 0 = uncompressed, 1 = fixed huffman tree, 1169 2 = dynamic huffman tree (best compression). Should be 2 for proper 1170 compression. 1171 *) use_lz77: whether or not to use LZ77 for compressed block types. Should be 1172 true for proper compression. 1173 *) windowsize: the window size used by the LZ77 encoder (1 - 32768). Has value 1174 2048 by default, but can be set to 32768 for better, but slow, compression. 1175 *) force_palette: if colortype is 2 or 6, you can make the encoder write a PLTE 1176 chunk if force_palette is true. This can used as suggested palette to convert 1177 to by viewers that don't support more than 256 colors (if those still exist) 1178 *) add_id: add text chunk "Encoder: LodePNG <version>" to the image. 1179 *) text_compression: default 1. If 1, it'll store texts as zTXt instead of tEXt chunks. 1180 zTXt chunks use zlib compression on the text. This gives a smaller result on 1181 large texts but a larger result on small texts (such as a single program name). 1182 It's all tEXt or all zTXt though, there's no separate setting per text yet. 1183 1184 1185 6. color conversions 1186 -------------------- 1187 1188 An important thing to note about LodePNG, is that the color type of the PNG, and 1189 the color type of the raw image, are completely independent. By default, when 1190 you decode a PNG, you get the result as a raw image in the color type you want, 1191 no matter whether the PNG was encoded with a palette, greyscale or RGBA color. 1192 And if you encode an image, by default LodePNG will automatically choose the PNG 1193 color type that gives good compression based on the values of colors and amount 1194 of colors in the image. It can be configured to let you control it instead as 1195 well, though. 1196 1197 To be able to do this, LodePNG does conversions from one color mode to another. 1198 It can convert from almost any color type to any other color type, except the 1199 following conversions: RGB to greyscale is not supported, and converting to a 1200 palette when the palette doesn't have a required color is not supported. This is 1201 not supported on purpose: this is information loss which requires a color 1202 reduction algorithm that is beyong the scope of a PNG encoder (yes, RGB to grey 1203 is easy, but there are multiple ways if you want to give some channels more 1204 weight). 1205 1206 By default, when decoding, you get the raw image in 32-bit RGBA or 24-bit RGB 1207 color, no matter what color type the PNG has. And by default when encoding, 1208 LodePNG automatically picks the best color model for the output PNG, and expects 1209 the input image to be 32-bit RGBA or 24-bit RGB. So, unless you want to control 1210 the color format of the images yourself, you can skip this chapter. 1211 1212 6.1. PNG color types 1213 -------------------- 1214 1215 A PNG image can have many color types, ranging from 1-bit color to 64-bit color, 1216 as well as palettized color modes. After the zlib decompression and unfiltering 1217 in the PNG image is done, the raw pixel data will have that color type and thus 1218 a certain amount of bits per pixel. If you want the output raw image after 1219 decoding to have another color type, a conversion is done by LodePNG. 1220 1221 The PNG specification gives the following color types: 1222 1223 0: greyscale, bit depths 1, 2, 4, 8, 16 1224 2: RGB, bit depths 8 and 16 1225 3: palette, bit depths 1, 2, 4 and 8 1226 4: greyscale with alpha, bit depths 8 and 16 1227 6: RGBA, bit depths 8 and 16 1228 1229 Bit depth is the amount of bits per pixel per color channel. So the total amount 1230 of bits per pixel is: amount of channels * bitdepth. 1231 1232 6.2. color conversions 1233 ---------------------- 1234 1235 As explained in the sections about the encoder and decoder, you can specify 1236 color types and bit depths in info_png and info_raw to change the default 1237 behaviour. 1238 1239 If, when decoding, you want the raw image to be something else than the default, 1240 you need to set the color type and bit depth you want in the LodePNGColorMode, 1241 or the parameters colortype and bitdepth of the simple decoding function. 1242 1243 If, when encoding, you use another color type than the default in the raw input 1244 image, you need to specify its color type and bit depth in the LodePNGColorMode 1245 of the raw image, or use the parameters colortype and bitdepth of the simple 1246 encoding function. 1247 1248 If, when encoding, you don't want LodePNG to choose the output PNG color type 1249 but control it yourself, you need to set auto_convert in the encoder settings 1250 to false, and specify the color type you want in the LodePNGInfo of the 1251 encoder (including palette: it can generate a palette if auto_convert is true, 1252 otherwise not). 1253 1254 If the input and output color type differ (whether user chosen or auto chosen), 1255 LodePNG will do a color conversion, which follows the rules below, and may 1256 sometimes result in an error. 1257 1258 To avoid some confusion: 1259 -the decoder converts from PNG to raw image 1260 -the encoder converts from raw image to PNG 1261 -the colortype and bitdepth in LodePNGColorMode info_raw, are those of the raw image 1262 -the colortype and bitdepth in the color field of LodePNGInfo info_png, are those of the PNG 1263 -when encoding, the color type in LodePNGInfo is ignored if auto_convert 1264 is enabled, it is automatically generated instead 1265 -when decoding, the color type in LodePNGInfo is set by the decoder to that of the original 1266 PNG image, but it can be ignored since the raw image has the color type you requested instead 1267 -if the color type of the LodePNGColorMode and PNG image aren't the same, a conversion 1268 between the color types is done if the color types are supported. If it is not 1269 supported, an error is returned. If the types are the same, no conversion is done. 1270 -even though some conversions aren't supported, LodePNG supports loading PNGs from any 1271 colortype and saving PNGs to any colortype, sometimes it just requires preparing 1272 the raw image correctly before encoding. 1273 -both encoder and decoder use the same color converter. 1274 1275 Non supported color conversions: 1276 -color to greyscale: no error is thrown, but the result will look ugly because 1277 only the red channel is taken 1278 -anything to palette when that palette does not have that color in it: in this 1279 case an error is thrown 1280 1281 Supported color conversions: 1282 -anything to 8-bit RGB, 8-bit RGBA, 16-bit RGB, 16-bit RGBA 1283 -any grey or grey+alpha, to grey or grey+alpha 1284 -anything to a palette, as long as the palette has the requested colors in it 1285 -removing alpha channel 1286 -higher to smaller bitdepth, and vice versa 1287 1288 If you want no color conversion to be done (e.g. for speed or control): 1289 -In the encoder, you can make it save a PNG with any color type by giving the 1290 raw color mode and LodePNGInfo the same color mode, and setting auto_convert to 1291 false. 1292 -In the decoder, you can make it store the pixel data in the same color type 1293 as the PNG has, by setting the color_convert setting to false. Settings in 1294 info_raw are then ignored. 1295 1296 The function lodepng_convert does the color conversion. It is available in the 1297 interface but normally isn't needed since the encoder and decoder already call 1298 it. 1299 1300 6.3. padding bits 1301 ----------------- 1302 1303 In the PNG file format, if a less than 8-bit per pixel color type is used and the scanlines 1304 have a bit amount that isn't a multiple of 8, then padding bits are used so that each 1305 scanline starts at a fresh byte. But that is NOT true for the LodePNG raw input and output. 1306 The raw input image you give to the encoder, and the raw output image you get from the decoder 1307 will NOT have these padding bits, e.g. in the case of a 1-bit image with a width 1308 of 7 pixels, the first pixel of the second scanline will the the 8th bit of the first byte, 1309 not the first bit of a new byte. 1310 1311 6.4. A note about 16-bits per channel and endianness 1312 ---------------------------------------------------- 1313 1314 LodePNG uses unsigned char arrays for 16-bit per channel colors too, just like 1315 for any other color format. The 16-bit values are stored in big endian (most 1316 significant byte first) in these arrays. This is the opposite order of the 1317 little endian used by x86 CPU's. 1318 1319 LodePNG always uses big endian because the PNG file format does so internally. 1320 Conversions to other formats than PNG uses internally are not supported by 1321 LodePNG on purpose, there are myriads of formats, including endianness of 16-bit 1322 colors, the order in which you store R, G, B and A, and so on. Supporting and 1323 converting to/from all that is outside the scope of LodePNG. 1324 1325 This may mean that, depending on your use case, you may want to convert the big 1326 endian output of LodePNG to little endian with a for loop. This is certainly not 1327 always needed, many applications and libraries support big endian 16-bit colors 1328 anyway, but it means you cannot simply cast the unsigned char* buffer to an 1329 unsigned short* buffer on x86 CPUs. 1330 1331 1332 7. error values 1333 --------------- 1334 1335 All functions in LodePNG that return an error code, return 0 if everything went 1336 OK, or a non-zero code if there was an error. 1337 1338 The meaning of the LodePNG error values can be retrieved with the function 1339 lodepng_error_text: given the numerical error code, it returns a description 1340 of the error in English as a string. 1341 1342 Check the implementation of lodepng_error_text to see the meaning of each code. 1343 1344 1345 8. chunks and PNG editing 1346 ------------------------- 1347 1348 If you want to add extra chunks to a PNG you encode, or use LodePNG for a PNG 1349 editor that should follow the rules about handling of unknown chunks, or if your 1350 program is able to read other types of chunks than the ones handled by LodePNG, 1351 then that's possible with the chunk functions of LodePNG. 1352 1353 A PNG chunk has the following layout: 1354 1355 4 bytes length 1356 4 bytes type name 1357 length bytes data 1358 4 bytes CRC 1359 1360 8.1. iterating through chunks 1361 ----------------------------- 1362 1363 If you have a buffer containing the PNG image data, then the first chunk (the 1364 IHDR chunk) starts at byte number 8 of that buffer. The first 8 bytes are the 1365 signature of the PNG and are not part of a chunk. But if you start at byte 8 1366 then you have a chunk, and can check the following things of it. 1367 1368 NOTE: none of these functions check for memory buffer boundaries. To avoid 1369 exploits, always make sure the buffer contains all the data of the chunks. 1370 When using lodepng_chunk_next, make sure the returned value is within the 1371 allocated memory. 1372 1373 unsigned lodepng_chunk_length(const unsigned char* chunk): 1374 1375 Get the length of the chunk's data. The total chunk length is this length + 12. 1376 1377 void lodepng_chunk_type(char type[5], const unsigned char* chunk): 1378 unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type): 1379 1380 Get the type of the chunk or compare if it's a certain type 1381 1382 unsigned char lodepng_chunk_critical(const unsigned char* chunk): 1383 unsigned char lodepng_chunk_private(const unsigned char* chunk): 1384 unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk): 1385 1386 Check if the chunk is critical in the PNG standard (only IHDR, PLTE, IDAT and IEND are). 1387 Check if the chunk is private (public chunks are part of the standard, private ones not). 1388 Check if the chunk is safe to copy. If it's not, then, when modifying data in a critical 1389 chunk, unsafe to copy chunks of the old image may NOT be saved in the new one if your 1390 program doesn't handle that type of unknown chunk. 1391 1392 unsigned char* lodepng_chunk_data(unsigned char* chunk): 1393 const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk): 1394 1395 Get a pointer to the start of the data of the chunk. 1396 1397 unsigned lodepng_chunk_check_crc(const unsigned char* chunk): 1398 void lodepng_chunk_generate_crc(unsigned char* chunk): 1399 1400 Check if the crc is correct or generate a correct one. 1401 1402 unsigned char* lodepng_chunk_next(unsigned char* chunk): 1403 const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk): 1404 1405 Iterate to the next chunk. This works if you have a buffer with consecutive chunks. Note that these 1406 functions do no boundary checking of the allocated data whatsoever, so make sure there is enough 1407 data available in the buffer to be able to go to the next chunk. 1408 1409 unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk): 1410 unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length, 1411 const char* type, const unsigned char* data): 1412 1413 These functions are used to create new chunks that are appended to the data in *out that has 1414 length *outlength. The append function appends an existing chunk to the new data. The create 1415 function creates a new chunk with the given parameters and appends it. Type is the 4-letter 1416 name of the chunk. 1417 1418 8.2. chunks in info_png 1419 ----------------------- 1420 1421 The LodePNGInfo struct contains fields with the unknown chunk in it. It has 3 1422 buffers (each with size) to contain 3 types of unknown chunks: 1423 the ones that come before the PLTE chunk, the ones that come between the PLTE 1424 and the IDAT chunks, and the ones that come after the IDAT chunks. 1425 It's necessary to make the distionction between these 3 cases because the PNG 1426 standard forces to keep the ordering of unknown chunks compared to the critical 1427 chunks, but does not force any other ordering rules. 1428 1429 info_png.unknown_chunks_data[0] is the chunks before PLTE 1430 info_png.unknown_chunks_data[1] is the chunks after PLTE, before IDAT 1431 info_png.unknown_chunks_data[2] is the chunks after IDAT 1432 1433 The chunks in these 3 buffers can be iterated through and read by using the same 1434 way described in the previous subchapter. 1435 1436 When using the decoder to decode a PNG, you can make it store all unknown chunks 1437 if you set the option settings.remember_unknown_chunks to 1. By default, this 1438 option is off (0). 1439 1440 The encoder will always encode unknown chunks that are stored in the info_png. 1441 If you need it to add a particular chunk that isn't known by LodePNG, you can 1442 use lodepng_chunk_append or lodepng_chunk_create to the chunk data in 1443 info_png.unknown_chunks_data[x]. 1444 1445 Chunks that are known by LodePNG should not be added in that way. E.g. to make 1446 LodePNG add a bKGD chunk, set background_defined to true and add the correct 1447 parameters there instead. 1448 1449 1450 9. compiler support 1451 ------------------- 1452 1453 No libraries other than the current standard C library are needed to compile 1454 LodePNG. For the C++ version, only the standard C++ library is needed on top. 1455 Add the files lodepng.c(pp) and lodepng.h to your project, include 1456 lodepng.h where needed, and your program can read/write PNG files. 1457 1458 It is compatible with C90 and up, and C++03 and up. 1459 1460 If performance is important, use optimization when compiling! For both the 1461 encoder and decoder, this makes a large difference. 1462 1463 Make sure that LodePNG is compiled with the same compiler of the same version 1464 and with the same settings as the rest of the program, or the interfaces with 1465 std::vectors and std::strings in C++ can be incompatible. 1466 1467 CHAR_BITS must be 8 or higher, because LodePNG uses unsigned chars for octets. 1468 1469 *) gcc and g++ 1470 1471 LodePNG is developed in gcc so this compiler is natively supported. It gives no 1472 warnings with compiler options "-Wall -Wextra -pedantic -ansi", with gcc and g++ 1473 version 4.7.1 on Linux, 32-bit and 64-bit. 1474 1475 *) Clang 1476 1477 Fully supported and warning-free. 1478 1479 *) Mingw 1480 1481 The Mingw compiler (a port of gcc for Windows) should be fully supported by 1482 LodePNG. 1483 1484 *) Visual Studio and Visual C++ Express Edition 1485 1486 LodePNG should be warning-free with warning level W4. Two warnings were disabled 1487 with pragmas though: warning 4244 about implicit conversions, and warning 4996 1488 where it wants to use a non-standard function fopen_s instead of the standard C 1489 fopen. 1490 1491 Visual Studio may want "stdafx.h" files to be included in each source file and 1492 give an error "unexpected end of file while looking for precompiled header". 1493 This is not standard C++ and will not be added to the stock LodePNG. You can 1494 disable it for lodepng.cpp only by right clicking it, Properties, C/C++, 1495 Precompiled Headers, and set it to Not Using Precompiled Headers there. 1496 1497 NOTE: Modern versions of VS should be fully supported, but old versions, e.g. 1498 VS6, are not guaranteed to work. 1499 1500 *) Compilers on Macintosh 1501 1502 LodePNG has been reported to work both with gcc and LLVM for Macintosh, both for 1503 C and C++. 1504 1505 *) Other Compilers 1506 1507 If you encounter problems on any compilers, feel free to let me know and I may 1508 try to fix it if the compiler is modern and standards complient. 1509 1510 1511 10. examples 1512 ------------ 1513 1514 This decoder example shows the most basic usage of LodePNG. More complex 1515 examples can be found on the LodePNG website. 1516 1517 10.1. decoder C++ example 1518 ------------------------- 1519 1520 #include "lodepng.h" 1521 #include <iostream> 1522 1523 int main(int argc, char *argv[]) 1524 { 1525 const char* filename = argc > 1 ? argv[1] : "test.png"; 1526 1527 //load and decode 1528 std::vector<unsigned char> image; 1529 unsigned width, height; 1530 unsigned error = lodepng::decode(image, width, height, filename); 1531 1532 //if there's an error, display it 1533 if(error) std::cout << "decoder error " << error << ": " << lodepng_error_text(error) << std::endl; 1534 1535 //the pixels are now in the vector "image", 4 bytes per pixel, ordered RGBARGBA..., use it as texture, draw it, ... 1536 } 1537 1538 10.2. decoder C example 1539 ----------------------- 1540 1541 #include "lodepng.h" 1542 1543 int main(int argc, char *argv[]) 1544 { 1545 unsigned error; 1546 unsigned char* image; 1547 size_t width, height; 1548 const char* filename = argc > 1 ? argv[1] : "test.png"; 1549 1550 error = lodepng_decode32_file(&image, &width, &height, filename); 1551 1552 if(error) printf("decoder error %u: %s\n", error, lodepng_error_text(error)); 1553 1554 / * use image here * / 1555 1556 free(image); 1557 return 0; 1558 } 1559 1560 11. state settings reference 1561 ---------------------------- 1562 1563 A quick reference of some settings to set on the LodePNGState 1564 1565 For decoding: 1566 1567 state.decoder.zlibsettings.ignore_adler32: ignore ADLER32 checksums 1568 state.decoder.zlibsettings.custom_...: use custom inflate function 1569 state.decoder.ignore_crc: ignore CRC checksums 1570 state.decoder.color_convert: convert internal PNG color to chosen one 1571 state.decoder.read_text_chunks: whether to read in text metadata chunks 1572 state.decoder.remember_unknown_chunks: whether to read in unknown chunks 1573 state.info_raw.colortype: desired color type for decoded image 1574 state.info_raw.bitdepth: desired bit depth for decoded image 1575 state.info_raw....: more color settings, see struct LodePNGColorMode 1576 state.info_png....: no settings for decoder but ouput, see struct LodePNGInfo 1577 1578 For encoding: 1579 1580 state.encoder.zlibsettings.btype: disable compression by setting it to 0 1581 state.encoder.zlibsettings.use_lz77: use LZ77 in compression 1582 state.encoder.zlibsettings.windowsize: tweak LZ77 windowsize 1583 state.encoder.zlibsettings.minmatch: tweak min LZ77 length to match 1584 state.encoder.zlibsettings.nicematch: tweak LZ77 match where to stop searching 1585 state.encoder.zlibsettings.lazymatching: try one more LZ77 matching 1586 state.encoder.zlibsettings.custom_...: use custom deflate function 1587 state.encoder.auto_convert: choose optimal PNG color type, if 0 uses info_png 1588 state.encoder.filter_palette_zero: PNG filter strategy for palette 1589 state.encoder.filter_strategy: PNG filter strategy to encode with 1590 state.encoder.force_palette: add palette even if not encoding to one 1591 state.encoder.add_id: add LodePNG identifier and version as a text chunk 1592 state.encoder.text_compression: use compressed text chunks for metadata 1593 state.info_raw.colortype: color type of raw input image you provide 1594 state.info_raw.bitdepth: bit depth of raw input image you provide 1595 state.info_raw: more color settings, see struct LodePNGColorMode 1596 state.info_png.color.colortype: desired color type if auto_convert is false 1597 state.info_png.color.bitdepth: desired bit depth if auto_convert is false 1598 state.info_png.color....: more color settings, see struct LodePNGColorMode 1599 state.info_png....: more PNG related settings, see struct LodePNGInfo 1600 1601 1602 12. changes 1603 ----------- 1604 1605 The version number of LodePNG is the date of the change given in the format 1606 yyyymmdd. 1607 1608 Some changes aren't backwards compatible. Those are indicated with a (!) 1609 symbol. 1610 1611 *) 27 nov 2016: grey+alpha auto color model detection bugfix 1612 *) 18 apr 2016: Changed qsort to custom stable sort (for platforms w/o qsort). 1613 *) 09 apr 2016: Fixed colorkey usage detection, and better file loading (within 1614 the limits of pure C90). 1615 *) 08 dec 2015: Made load_file function return error if file can't be opened. 1616 *) 24 okt 2015: Bugfix with decoding to palette output. 1617 *) 18 apr 2015: Boundary PM instead of just package-merge for faster encoding. 1618 *) 23 aug 2014: Reduced needless memory usage of decoder. 1619 *) 28 jun 2014: Removed fix_png setting, always support palette OOB for 1620 simplicity. Made ColorProfile public. 1621 *) 09 jun 2014: Faster encoder by fixing hash bug and more zeros optimization. 1622 *) 22 dec 2013: Power of two windowsize required for optimization. 1623 *) 15 apr 2013: Fixed bug with LAC_ALPHA and color key. 1624 *) 25 mar 2013: Added an optional feature to ignore some PNG errors (fix_png). 1625 *) 11 mar 2013 (!): Bugfix with custom free. Changed from "my" to "lodepng_" 1626 prefix for the custom allocators and made it possible with a new #define to 1627 use custom ones in your project without needing to change lodepng's code. 1628 *) 28 jan 2013: Bugfix with color key. 1629 *) 27 okt 2012: Tweaks in text chunk keyword length error handling. 1630 *) 8 okt 2012 (!): Added new filter strategy (entropy) and new auto color mode. 1631 (no palette). Better deflate tree encoding. New compression tweak settings. 1632 Faster color conversions while decoding. Some internal cleanups. 1633 *) 23 sep 2012: Reduced warnings in Visual Studio a little bit. 1634 *) 1 sep 2012 (!): Removed #define's for giving custom (de)compression functions 1635 and made it work with function pointers instead. 1636 *) 23 jun 2012: Added more filter strategies. Made it easier to use custom alloc 1637 and free functions and toggle #defines from compiler flags. Small fixes. 1638 *) 6 may 2012 (!): Made plugging in custom zlib/deflate functions more flexible. 1639 *) 22 apr 2012 (!): Made interface more consistent, renaming a lot. Removed 1640 redundant C++ codec classes. Reduced amount of structs. Everything changed, 1641 but it is cleaner now imho and functionality remains the same. Also fixed 1642 several bugs and shrunk the implementation code. Made new samples. 1643 *) 6 nov 2011 (!): By default, the encoder now automatically chooses the best 1644 PNG color model and bit depth, based on the amount and type of colors of the 1645 raw image. For this, autoLeaveOutAlphaChannel replaced by auto_choose_color. 1646 *) 9 okt 2011: simpler hash chain implementation for the encoder. 1647 *) 8 sep 2011: lz77 encoder lazy matching instead of greedy matching. 1648 *) 23 aug 2011: tweaked the zlib compression parameters after benchmarking. 1649 A bug with the PNG filtertype heuristic was fixed, so that it chooses much 1650 better ones (it's quite significant). A setting to do an experimental, slow, 1651 brute force search for PNG filter types is added. 1652 *) 17 aug 2011 (!): changed some C zlib related function names. 1653 *) 16 aug 2011: made the code less wide (max 120 characters per line). 1654 *) 17 apr 2011: code cleanup. Bugfixes. Convert low to 16-bit per sample colors. 1655 *) 21 feb 2011: fixed compiling for C90. Fixed compiling with sections disabled. 1656 *) 11 dec 2010: encoding is made faster, based on suggestion by Peter Eastman 1657 to optimize long sequences of zeros. 1658 *) 13 nov 2010: added LodePNG_InfoColor_hasPaletteAlpha and 1659 LodePNG_InfoColor_canHaveAlpha functions for convenience. 1660 *) 7 nov 2010: added LodePNG_error_text function to get error code description. 1661 *) 30 okt 2010: made decoding slightly faster 1662 *) 26 okt 2010: (!) changed some C function and struct names (more consistent). 1663 Reorganized the documentation and the declaration order in the header. 1664 *) 08 aug 2010: only changed some comments and external samples. 1665 *) 05 jul 2010: fixed bug thanks to warnings in the new gcc version. 1666 *) 14 mar 2010: fixed bug where too much memory was allocated for char buffers. 1667 *) 02 sep 2008: fixed bug where it could create empty tree that linux apps could 1668 read by ignoring the problem but windows apps couldn't. 1669 *) 06 jun 2008: added more error checks for out of memory cases. 1670 *) 26 apr 2008: added a few more checks here and there to ensure more safety. 1671 *) 06 mar 2008: crash with encoding of strings fixed 1672 *) 02 feb 2008: support for international text chunks added (iTXt) 1673 *) 23 jan 2008: small cleanups, and #defines to divide code in sections 1674 *) 20 jan 2008: support for unknown chunks allowing using LodePNG for an editor. 1675 *) 18 jan 2008: support for tIME and pHYs chunks added to encoder and decoder. 1676 *) 17 jan 2008: ability to encode and decode compressed zTXt chunks added 1677 Also various fixes, such as in the deflate and the padding bits code. 1678 *) 13 jan 2008: Added ability to encode Adam7-interlaced images. Improved 1679 filtering code of encoder. 1680 *) 07 jan 2008: (!) changed LodePNG to use ISO C90 instead of C++. A 1681 C++ wrapper around this provides an interface almost identical to before. 1682 Having LodePNG be pure ISO C90 makes it more portable. The C and C++ code 1683 are together in these files but it works both for C and C++ compilers. 1684 *) 29 dec 2007: (!) changed most integer types to unsigned int + other tweaks 1685 *) 30 aug 2007: bug fixed which makes this Borland C++ compatible 1686 *) 09 aug 2007: some VS2005 warnings removed again 1687 *) 21 jul 2007: deflate code placed in new namespace separate from zlib code 1688 *) 08 jun 2007: fixed bug with 2- and 4-bit color, and small interlaced images 1689 *) 04 jun 2007: improved support for Visual Studio 2005: crash with accessing 1690 invalid std::vector element [0] fixed, and level 3 and 4 warnings removed 1691 *) 02 jun 2007: made the encoder add a tag with version by default 1692 *) 27 may 2007: zlib and png code separated (but still in the same file), 1693 simple encoder/decoder functions added for more simple usage cases 1694 *) 19 may 2007: minor fixes, some code cleaning, new error added (error 69), 1695 moved some examples from here to lodepng_examples.cpp 1696 *) 12 may 2007: palette decoding bug fixed 1697 *) 24 apr 2007: changed the license from BSD to the zlib license 1698 *) 11 mar 2007: very simple addition: ability to encode bKGD chunks. 1699 *) 04 mar 2007: (!) tEXt chunk related fixes, and support for encoding 1700 palettized PNG images. Plus little interface change with palette and texts. 1701 *) 03 mar 2007: Made it encode dynamic Huffman shorter with repeat codes. 1702 Fixed a bug where the end code of a block had length 0 in the Huffman tree. 1703 *) 26 feb 2007: Huffman compression with dynamic trees (BTYPE 2) now implemented 1704 and supported by the encoder, resulting in smaller PNGs at the output. 1705 *) 27 jan 2007: Made the Adler-32 test faster so that a timewaste is gone. 1706 *) 24 jan 2007: gave encoder an error interface. Added color conversion from any 1707 greyscale type to 8-bit greyscale with or without alpha. 1708 *) 21 jan 2007: (!) Totally changed the interface. It allows more color types 1709 to convert to and is more uniform. See the manual for how it works now. 1710 *) 07 jan 2007: Some cleanup & fixes, and a few changes over the last days: 1711 encode/decode custom tEXt chunks, separate classes for zlib & deflate, and 1712 at last made the decoder give errors for incorrect Adler32 or Crc. 1713 *) 01 jan 2007: Fixed bug with encoding PNGs with less than 8 bits per channel. 1714 *) 29 dec 2006: Added support for encoding images without alpha channel, and 1715 cleaned out code as well as making certain parts faster. 1716 *) 28 dec 2006: Added "Settings" to the encoder. 1717 *) 26 dec 2006: The encoder now does LZ77 encoding and produces much smaller files now. 1718 Removed some code duplication in the decoder. Fixed little bug in an example. 1719 *) 09 dec 2006: (!) Placed output parameters of public functions as first parameter. 1720 Fixed a bug of the decoder with 16-bit per color. 1721 *) 15 okt 2006: Changed documentation structure 1722 *) 09 okt 2006: Encoder class added. It encodes a valid PNG image from the 1723 given image buffer, however for now it's not compressed. 1724 *) 08 sep 2006: (!) Changed to interface with a Decoder class 1725 *) 30 jul 2006: (!) LodePNG_InfoPng , width and height are now retrieved in different 1726 way. Renamed decodePNG to decodePNGGeneric. 1727 *) 29 jul 2006: (!) Changed the interface: image info is now returned as a 1728 struct of type LodePNG::LodePNG_Info, instead of a vector, which was a bit clumsy. 1729 *) 28 jul 2006: Cleaned the code and added new error checks. 1730 Corrected terminology "deflate" into "inflate". 1731 *) 23 jun 2006: Added SDL example in the documentation in the header, this 1732 example allows easy debugging by displaying the PNG and its transparency. 1733 *) 22 jun 2006: (!) Changed way to obtain error value. Added 1734 loadFile function for convenience. Made decodePNG32 faster. 1735 *) 21 jun 2006: (!) Changed type of info vector to unsigned. 1736 Changed position of palette in info vector. Fixed an important bug that 1737 happened on PNGs with an uncompressed block. 1738 *) 16 jun 2006: Internally changed unsigned into unsigned where 1739 needed, and performed some optimizations. 1740 *) 07 jun 2006: (!) Renamed functions to decodePNG and placed them 1741 in LodePNG namespace. Changed the order of the parameters. Rewrote the 1742 documentation in the header. Renamed files to lodepng.cpp and lodepng.h 1743 *) 22 apr 2006: Optimized and improved some code 1744 *) 07 sep 2005: (!) Changed to std::vector interface 1745 *) 12 aug 2005: Initial release (C++, decoder only) 1746 1747 1748 13. contact information 1749 ----------------------- 1750 1751 Feel free to contact me with suggestions, problems, comments, ... concerning 1752 LodePNG. If you encounter a PNG image that doesn't work properly with this 1753 decoder, feel free to send it and I'll use it to find and fix the problem. 1754 1755 My email address is (puzzle the account and domain together with an @ symbol): 1756 Domain: gmail dot com. 1757 Account: lode dot vandevenne. 1758 1759 1760 Copyright (c) 2005-2016 Lode Vandevenne 1761 */