src/lbximg.c

   1 /*
   2  *  2ooM: The Master of Orion II Reverse Engineering Project
   3  *  Simple command-line tool to convert an LBX image to a set of PNGs.
   4  *  Copyright (C) 2006-2008 Nick Bowler
   5  *
   6  *  This program is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19 #include <config.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <limits.h>
  24 #include <assert.h>
  25 #include <getopt.h>
  26 #include <errno.h>
  27
  28 #include <png.h>
  29
  30 #include "tools.h"
  31 #include "image.h"
  32 #include "lbx.h"
  33
  34 /* Global flags */
  35 static int verbose = 0;
  36 static char *outname = "out";
  37 static int usepalette = 1;
  38
  39 static void printusage(void)
  40 {
  41         puts("usage: lbximg [-i|-d] [-v] [-p palette_file] [-O override_file]"
  42                           " [-f path]");
  43         puts("              [frameno ...]");
  44 }
  45
  46 static void printhelp(void)
  47 {
  48         printusage();
  49         puts("For now, see the man page for detailed help.");
  50 }
  51
  52 static const char *progname;
  53 #define errmsg(fmt, ...) (\
  54         fprintf(stderr, "%s: " fmt, progname, __VA_ARGS__)\
  55 )
  56
  57 enum {
  58         MODE_NONE,
  59         MODE_DECODE,
  60         MODE_IDENT,
  61 };
  62
  63 int parserange(struct lbx_imginfo *info, char *str, unsigned char *bits)
  64 {
  65         unsigned long start, end;
  66         unsigned int i;
  67         char *endptr;
  68
  69         start = strtoul(str, &endptr, 0);
  70         if (start >= info->nframes) {
  71                 errmsg("frame %lu out of range.\n", start);
  72                 return -1;
  73         }
  74
  75         if (endptr == str) {
  76                 errmsg("invalid frame range: %s.\n", str);
  77                 return -1;
  78         }
  79
  80         switch (*endptr) {
  81         case '\0':
  82                 end = start;
  83                 break;
  84         case '-':
  85                 end = strtoul(endptr+1, &endptr, 0);
  86                 if (end >= info->nframes) {
  87                         errmsg("frame %lu out of range.\n", end);
  88                         return -1;
  89                 }
  90
  91                 if (endptr == str)
  92                         end = info->nframes - 1;
  93                 break;
  94         default:
  95                 errmsg("invalid frame range: %s.\n", str);
  96                 return -1;
  97         }
  98
  99         if (end < start) {
 100                 errmsg("invalid frame range: %s.\n", str);
 101                 return -1;
 102         }
 103
 104         for (i = start; i <= end; i++) {
 105                 bits[i / CHAR_BIT] |= 1 << (i % CHAR_BIT);
 106         }
 107
 108         return 0;
 109 }
 110
 111 static int ismasked(unsigned char **mask, unsigned width, unsigned height)
 112 {
 113         unsigned y, x;
 114         for (y = 0; y < height; y++) {
 115                 for (x = 0; x < width; x++) {
 116                         if (mask[y][x] == 0) return 1;
 117                 }
 118         }
 119
 120         return 0;
 121 }
 122
 123 int outpng(unsigned int frameno,
 124            unsigned char **framedata, unsigned char **mask,
 125            unsigned int width, unsigned int height,
 126            struct lbx_colour palette[static 256])
 127 {
 128         char name[strlen(outname) + sizeof ".65535.png"];
 129         unsigned char *row;
 130         unsigned int x, y;
 131         FILE *of;
 132
 133         png_structp png;
 134         png_infop   info;
 135
 136         assert(frameno < 65536);
 137         snprintf(name, sizeof name, "%s.%03d.png", outname, frameno);
 138
 139         row = malloc(4 * width);
 140         if (!row) {
 141                 errmsg("failed to allocate row buffer: %s\n", strerror(errno));
 142                 return -1;
 143         }
 144
 145         of = fopen(name, "wb");
 146         if (!of) {
 147                 errmsg("failed to open %s: %s.\n", name, strerror(errno));
 148                 free(row);
 149                 return -1;
 150         }
 151
 152         png = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
 153         if (!png) {
 154                 errmsg("failed to init libpng.\n", 0);
 155                 goto err;
 156         }
 157
 158         info = png_create_info_struct(png);
 159         if (!info) {
 160                 errmsg("failed to init libpng.\n", 0);
 161                 png_destroy_write_struct(&png, NULL);
 162                 goto err;
 163         }
 164
 165         if (setjmp(png_jmpbuf(png))) {
 166                 free(row);
 167                 png_destroy_write_struct(&png, &info);
 168                 goto err;
 169         }
 170
 171         png_init_io(png, of);
 172
 173         if (!ismasked(mask, width, height)) {
 174                 /*
 175                  * This case is easy; we can just feed the palette and pixel
 176                  * data to libpng and let it do its magic.
 177                  */
 178
 179                 png_color png_palette[256];
 180                 for (unsigned i = 0; i < 256; i++) {
 181                         png_palette[i].red   = palette[i].red;
 182                         png_palette[i].green = palette[i].green;
 183                         png_palette[i].blue  = palette[i].blue;
 184                 }
 185
 186                 png_set_IHDR(png, info, width, height, 8,
 187                              PNG_COLOR_TYPE_PALETTE, PNG_INTERLACE_NONE,
 188                              PNG_COMPRESSION_TYPE_DEFAULT,
 189                              PNG_FILTER_TYPE_DEFAULT);
 190
 191                 png_set_PLTE(png, info, png_palette, 256);
 192                 png_set_rows(png, info, framedata);
 193                 png_write_png(png, info, PNG_TRANSFORM_IDENTITY, NULL);
 194         } else {
 195                 /*
 196                  * Unfortunately, LBX doesn't translate nicely to PNG here.
 197                  * LBX has a 256 colour palette _plus_ transparency.
 198                  * We'll form an RGBA PNG to deal with this.
 199                  */
 200
 201                 png_set_IHDR(png, info, width, height, 8,
 202                              PNG_COLOR_TYPE_RGB_ALPHA, PNG_INTERLACE_NONE,
 203                              PNG_COMPRESSION_TYPE_DEFAULT,
 204                              PNG_FILTER_TYPE_DEFAULT);
 205
 206                 png_write_info(png, info);
 207
 208                 for (y = 0; y < height; y++) {
 209                         for (x = 0; x < width; x++) {
 210                                 row[4*x+0] = palette[framedata[y][x]].red;
 211                                 row[4*x+1] = palette[framedata[y][x]].green;
 212                                 row[4*x+2] = palette[framedata[y][x]].blue;
 213                                 row[4*x+3] = (mask[y][x]) ? -1 : 0;
 214                         }
 215
 216                         png_write_row(png, row);
 217                 }
 218
 219                 png_write_end(png, NULL);
 220         }
 221
 222         png_destroy_write_struct(&png, &info);
 223         fclose(of);
 224
 225         if (verbose)
 226                 printf("wrote %s\n", name);
 227
 228         return 0;
 229
 230 err:
 231         fclose(of);
 232         remove(name);
 233         free(row);
 234         return -1;
 235 }
 236
 237 static int loadoverride(FILE *f, struct lbx_colour palette[static 256])
 238 {
 239         LBX_IMG *overimg = lbximg_fopen(f);
 240         struct lbx_imginfo info;
 241
 242         if (!overimg) {
 243                 errmsg("failed to open override image: %s\n", lbx_strerror());
 244                 return -1;
 245         }
 246         lbximg_getinfo(overimg, &info);
 247
 248         if (!info.palettesz) {
 249                 errmsg("override image has no palette.\n", 0);
 250                 lbximg_close(overimg);
 251                 return -1;
 252         }
 253
 254         if (lbximg_getpalette(overimg, palette) == -1) {
 255                 errmsg("error reading override palette: %s\n", lbx_strerror());
 256                 lbximg_close(overimg);
 257                 return -1;
 258         }
 259
 260         lbximg_close(overimg);
 261         return 0;
 262 }
 263
 264 static int loadpalette(LBX_IMG *img, struct lbx_imginfo *info,
 265                        FILE *palf, FILE *override,
 266                        struct lbx_colour palette[static 256])
 267 {
 268         int i;
 269
 270         /* In no-palette mode, use palette indices for colour. */
 271         if (!usepalette) {
 272                 for (i = 0; i < 256; i++) {
 273                         palette[i] = (struct lbx_colour){i,i,i};
 274                 }
 275
 276                 return 0;
 277         }
 278
 279         /* For sanity. */
 280         if (!palf && !info->palettesz && !override) {
 281                 errmsg("no palette available.\n", 0);
 282                 return -1;
 283         }
 284
 285         /* Default the palette to a wonderful pink. */
 286         for (i = 0; i < 256; i++) {
 287                 palette[i] = (struct lbx_colour){0xff, 0x00, 0xff};
 288         }
 289
 290         /* Read the external palette, if any. */
 291         if (palf && lbximg_loadpalette(palf, &lbx_default_fops, palette) != 0) {
 292                 errmsg("error reading external palette: %s\n", lbx_strerror());
 293                 return -1;
 294         }
 295
 296         /* Read the embedded palette, if any. */
 297         if (info->palettesz && lbximg_getpalette(img, palette) == -1) {
 298                 errmsg("error reading embedded palette: %s\n", lbx_strerror());
 299                 return -1;
 300         }
 301
 302         /* Read the override palette, if any. */
 303         if (override && loadoverride(override, palette) == -1) {
 304                 return -1;
 305         }
 306
 307         return 0;
 308 }
 309
 310 int decode(LBX_IMG *img, FILE *palf, FILE *override, char **argv)
 311 {
 312         unsigned char *framebits;
 313         struct lbx_colour palette[256];
 314         struct lbx_imginfo info;
 315         int extracted = 0;
 316         unsigned int i;
 317
 318         lbximg_getinfo(img, &info);
 319
 320         framebits = malloc(info.nframes / CHAR_BIT + 1);
 321         if (!framebits) {
 322                 return EXIT_FAILURE;
 323         }
 324
 325         /* Figure out what images we're extracting. */
 326         if (!argv[0]) {
 327                 /* extract all images by default. */
 328                 memset(framebits, -1, info.nframes / CHAR_BIT + 1);
 329         } else {
 330                 for (i = 0; argv[i]; i++) {
 331                         parserange(&info, argv[i], framebits);
 332                 }
 333         }
 334
 335         if (loadpalette(img, &info, palf, override, palette) == -1) {
 336                 goto err;
 337         }
 338
 339         /* Extract the images, in order. */
 340         for (i = 0; i < info.nframes; i++) {
 341                 unsigned char **data;
 342                 unsigned char **mask;
 343
 344                 if (!(framebits[i / CHAR_BIT] & (1 << (i % CHAR_BIT))))
 345                         continue;
 346
 347                 data = lbximg_getframe(img, i);
 348                 if (!data) {
 349                         errmsg("error in frame %u: %s\n", i, lbx_strerror());
 350                         continue;
 351                 }
 352
 353                 mask = lbximg_getmask(img);
 354
 355                 if (!outpng(i, data, mask, info.width, info.height, palette)) {
 356                         extracted = 1;
 357                 }
 358         }
 359
 360         if (!extracted) {
 361                 errmsg("no frames extracted.\n", 0);
 362                 goto err;
 363         }
 364
 365         free(framebits);
 366         return EXIT_SUCCESS;
 367 err:
 368         free(framebits);
 369         return EXIT_FAILURE;
 370 }
 371
 372 int main(int argc, char **argv)
 373 {
 374         int mode = MODE_NONE, opt, rc = EXIT_FAILURE;
 375         struct lbx_pipe_state state = { .f = stdin };
 376         FILE *palf = NULL, *overf = NULL;
 377         const char *name = "stdin";
 378         LBX_IMG *img;
 379
 380         static const char *sopts = "idvf:p:O:V";
 381         static const struct option lopts[] = {
 382                 { "ident",    0, NULL, 'i' },
 383                 { "decode",   0, NULL, 'd' },
 384                 { "verbose",  0, NULL, 'v' },
 385                 { "file",     1, NULL, 'f' },
 386                 { "palette",  1, NULL, 'p' },
 387                 { "override", 1, NULL, 'p' },
 388
 389                 { "version",  0, NULL, 'V' },
 390                 { "usage",    0, NULL, 'U' },
 391                 { "help",     0, NULL, 'H' },
 392
 393                 { "nopalette", 0, &usepalette, 0 },
 394
 395                 { 0 }
 396         };
 397
 398         progname = "lbximg"; /* argv[0]; */
 399         while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
 400                 switch(opt) {
 401                 case 'i':
 402                         mode = MODE_IDENT;
 403                         break;
 404                 case 'd':
 405                         mode = MODE_DECODE;
 406                         break;
 407                 case 'v':
 408                         verbose = 1;
 409                         break;
 410                 case 'f':
 411                         name = strrchr(optarg, '/');
 412                         name = name ? name+1 : optarg;
 413
 414                         if (!freopen(optarg, "rb", state.f)) {
 415                                 errmsg("failed to open %s: %m\n", optarg);
 416                                 return EXIT_FAILURE;
 417                         }
 418                         break;
 419                 case 'p':
 420                         palf = fopen(optarg, "rb");
 421                         if (!palf) {
 422                                 errmsg("failed to open %s: %m\n", optarg);
 423                                 return EXIT_FAILURE;
 424                         }
 425
 426                         break;
 427                 case 'O':
 428                         overf = fopen(optarg, "rb");
 429                         if (!overf) {
 430                                 errmsg("failed to open %s: %m\n", optarg);
 431                                 return EXIT_FAILURE;
 432                         }
 433                         break;
 434                 case 'V':
 435                         puts(VERSION_BOILERPLATE("lbximg"));
 436                         return EXIT_SUCCESS;
 437                 case 'U':
 438                         printusage();
 439                         return EXIT_SUCCESS;
 440                 case 'H':
 441                         printhelp();
 442                         return EXIT_SUCCESS;
 443                 case '?':
 444                 case ':':
 445                         return EXIT_FAILURE;
 446                 }
 447         }
 448
 449         if (mode == MODE_NONE) {
 450                 errmsg("you must specify a mode.\n", 0);
 451                 return EXIT_FAILURE;
 452         }
 453
 454         if (fseek(state.f, 0, SEEK_CUR) == 0)
 455                 img = lbximg_open(state.f, &lbx_default_fops, NULL);
 456         else
 457                 img = lbximg_open(&state, &lbx_pipe_fops, NULL);
 458
 459         if (!img) {
 460                 errmsg("failed to open image: %s.\n", lbx_strerror());
 461                 return EXIT_FAILURE;
 462         }
 463
 464         if (verbose || mode == MODE_IDENT) {
 465                 struct lbx_imginfo info;
 466                 lbximg_getinfo(img, &info);
 467
 468                 printf("%s is %ux%u LBX image, %u frame(s)%s%s\n",
 469                        name, info.width, info.height, info.nframes,
 470                        info.palettesz ? ", embedded palette" : "",
 471                        info.chunk     ? ", chunked" : "",
 472                        info.looping   ? ", loops" : "");
 473         }
 474
 475         switch (mode) {
 476         case MODE_DECODE:
 477                 rc = decode(img, palf, overf, &argv[optind]);
 478                 break;
 479         }
 480
 481         lbximg_close(img);
 482         return rc;
 483 }