lodepng.h 91 KB

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