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