games/semicongine: semiconginev2/old/resources/lodepng.h annotate

annotate semiconginev2/old/resources/lodepng.h @ 1236:176383220123

add: first font-rendering test

author	sam <sam@basx.dev>
date	Sat, 20 Jul 2024 17:45:44 +0700
parents	56781cc0fc7c
children

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

Mercurial > games > semicongine

annotate semiconginev2/old/resources/lodepng.h @ 1236:176383220123