2 * 2ooM: The Master of Orion II Reverse Engineering Project
3 * Simple command-line tool to convert an LBX image to other formats.
4 * Copyright © 2006-2011, 2013-2014, 2021 Nick Bowler
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.
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.
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/>.
37 #include "imgoutput.h"
39 #define MIN(a, b) ((a) < (b) ? (a) : (b))
42 static int verbose = 0;
43 static char *outname = "out";
44 static int usepalette = 1;
47 static const char sopts[] = SOPT_STRING;
48 static const struct option lopts[] = { LOPTS_INITIALIZER, {0} };
50 static void print_usage(FILE *f)
52 const char *progname = tool_invocation();
54 fprintf(f, "Usage: %s [options] [-i|-d] [frame ...]\n", progname);
56 fprintf(f, "Try %s --help for more information.\n", progname);
59 static void print_help(void)
61 const struct option *opt;
67 for (opt = lopts; opt->name; opt++) {
68 struct lopt_help help;
71 if (!lopt_get_help(opt, &help))
74 help_print_option(opt, help.arg, help.desc, 20);
78 puts("For more information, see the lbximg(1) man page.");
81 printf("Report bugs to <%s>.\n", PACKAGE_BUGREPORT);
90 static const struct img_format {
91 img_output_func *output;
96 { img_output_png, "png", 1 },
98 { img_output_pam, "pam", 1 },
99 { img_output_ppm, "ppm", 1 },
100 { img_output_pbm, "pbm", 1 },
103 static int lookup_format(const char *fmt)
105 for (size_t i = 0; i < sizeof formats / sizeof formats[0]; i++) {
106 assert(!formats[i].name[sizeof formats[i].name - 1]);
108 if (!fmt && formats[i].enabled)
111 if (strcmp(formats[i].name, fmt))
114 if (!formats[i].enabled) {
115 tool_err(-1, "%s support disabled at build time", fmt);
122 tool_err(-1, "unknown format %s", fmt);
126 bool img_is_masked(unsigned char *mask, unsigned width, unsigned height)
128 unsigned long npixels = (unsigned long) width * height;
129 unsigned long mask_sz = npixels / CHAR_BIT + (npixels % CHAR_BIT != 0);
131 for (unsigned long i = 0; i < mask_sz; i++) {
133 if (mask[i] != (unsigned char)-1)
136 unsigned char test = (1u << npixels % CHAR_BIT) - 1;
138 if ((mask[i] & test) != test)
146 int parserange(unsigned frames, char *str, unsigned char *bits)
148 unsigned long start, end;
152 start = strtoul(str, &endptr, 0);
153 if (start >= frames) {
154 tool_err(-1, "frame %lu out of range.", start);
159 tool_err(-1, "invalid frame range: %s.", str);
168 end = strtoul(endptr+1, &endptr, 0);
170 tool_err(-1, "frame %lu out of range.", end);
178 tool_err(-1, "invalid frame range: %s.", str);
183 tool_err(-1, "invalid frame range: %s.", str);
187 for (i = start; i <= end; i++) {
188 bits[i / CHAR_BIT] |= 1 << (i % CHAR_BIT);
194 static int output(unsigned int frameno, const struct img_format *fmt,
195 unsigned char *pixels, unsigned char *pixel_mask,
196 unsigned int width, unsigned int height,
197 struct lbx_colour *palette)
199 char name[strlen(outname) + sizeof ".65535.png"];
203 assert(fmt->output != NULL);
204 assert(frameno < 65536);
205 snprintf(name, sizeof name, "%s.%03d.%s", outname, frameno, fmt->name);
207 of = fopen(name, "wb");
209 tool_err(0, "failed to open %s", name);
213 rc = fmt->output(of, name, width, height, pixels, pixel_mask, palette);
219 if (fclose(of) == EOF) {
220 tool_err(0, "error writing %s", name);
225 printf("wrote %s\n", name);
230 static int loadoverride(FILE *f, struct lbx_colour *palette)
232 struct lbx_image *img;
235 img = lbx_img_open(f, &lbx_default_fops, NULL);
237 tool_err(-1, "failed to open override image: %s", lbx_errmsg());
241 rc = lbx_img_getpalette(img, palette);
243 tool_err(-1, "error reading override palette: %s", lbx_errmsg());
245 } else if (rc == 0) {
246 tool_err(-1, "override image has no palette.");
254 static int loadpalette(struct lbx_image *img, FILE *palf, FILE *override,
255 struct lbx_colour *palette)
259 /* Default the palette to a wonderful pink. */
260 for (unsigned i = 0; i < 256; i++) {
261 palette[i] = (struct lbx_colour){0x3f, 0x00, 0x3f};
264 /* Read the external palette, if any. */
266 rc = lbx_img_loadpalette(palf, &lbx_default_fops, palette);
268 tool_err(-1, "error reading external palette: %s", lbx_errmsg());
275 /* Read the embedded palette */
276 rc = lbx_img_getpalette(img, palette);
278 tool_err(-1, "error reading embedded palette: %s", lbx_errmsg());
284 /* Read the override palette, if any. */
286 rc = loadoverride(override, palette);
292 /* If we literally have no palette data at all, may as well fail. */
294 tool_err(-1, "no palette available.");
298 /* Return true iff a divides b. */
299 static bool divides(unsigned a, unsigned b)
309 /* Set n bits starting from offset in the bitmap. */
311 set_bits(unsigned char *bitmap, unsigned long offset, unsigned long n)
313 if (offset % CHAR_BIT) {
314 bitmap[offset/CHAR_BIT] |= (n >= CHAR_BIT ? -1u : (1u << n) - 1)
317 n -= MIN(n, CHAR_BIT - offset%CHAR_BIT);
318 offset += CHAR_BIT - offset%CHAR_BIT;
322 memset(&bitmap[offset/CHAR_BIT], -1, n/CHAR_BIT);
324 offset += n - n%CHAR_BIT;
329 bitmap[offset/CHAR_BIT] |= (1u << n) - 1;
333 static int decode_frame(struct lbx_image *img, unsigned n,
334 unsigned char *pixels, unsigned char *pixel_mask)
339 rc = lbx_img_seek(img, n);
341 tool_err(-1, "frame %u: invalid frame: %s\n", n, lbx_errmsg());
345 while ((rc = lbx_img_read_row_header(img, &x, &y)) != 0) {
346 unsigned long offset;
349 tool_err(-1, "frame %u: invalid row: %s", n, lbx_errmsg());
353 offset = (unsigned long) y * img->width + x;
354 rc = lbx_img_read_row_data(img, pixels+offset);
356 tool_err(-1, "frame %u: error reading row: %s\n", n, lbx_errmsg());
360 set_bits(pixel_mask, offset, rc);
367 decode(struct lbx_image *img, FILE *palf, FILE *override, int fmt, char **argv)
369 unsigned char *pixels = NULL, *pixel_mask = NULL, *framebits = NULL;
370 struct lbx_colour palette[256];
371 int rc, ret = EXIT_FAILURE;
374 size_t npixels, mask_sz;
376 assert(fmt >= 0 && fmt < sizeof formats / sizeof formats[0]);
378 npixels = img->width;
379 if (img->height && npixels >= (size_t)-1 / img->height) {
380 tool_err(-1, "image too large");
383 npixels *= img->height;
385 /* Ensure there is at least 1 byte to allocate */
389 framebits = calloc(1, img->frames / CHAR_BIT + 1);
391 tool_err(0, "failed to allocate memory");
395 pixels = calloc(img->width, img->height);
397 tool_err(0, "failed to allocate memory");
401 mask_sz = npixels / CHAR_BIT + (npixels % CHAR_BIT != 0);
402 pixel_mask = malloc(mask_sz);
404 tool_err(0, "failed to allocate memory");
408 /* Figure out what images we're extracting. */
410 /* extract all images by default. */
411 memset(framebits, -1, img->frames / CHAR_BIT + 1);
413 for (i = 0; argv[i]; i++) {
414 parserange(img->frames, argv[i], framebits);
419 if (loadpalette(img, palf, override, palette) == -1) {
425 /* Extract the images, in order. */
427 for (i = 0; i < img->frames; i++) {
428 if (divides(img->chunk, i))
429 memset(pixel_mask, 0, mask_sz);
431 rc = decode_frame(img, i, pixels, pixel_mask);
437 if (framebits[i / CHAR_BIT] & (1u << (i % CHAR_BIT))) {
438 rc = output(i, &formats[fmt], pixels, pixel_mask,
439 img->width, img->height,
440 usepalette ? palette : NULL);
449 tool_err(-1, "no frames extracted.");
459 int main(int argc, char **argv)
461 int mode = MODE_NONE, fmt, opt, rc = EXIT_FAILURE;
462 struct lbx_pipe_state stdin_handle = { .f = stdin };
463 const char *file = NULL, *fmtstring = NULL;
464 const char *ext_palette = NULL, *ovr_palette = NULL;
465 FILE *palf = NULL, *overf = NULL;
466 struct lbx_image *img;
468 tool_init("lbximg", argc, argv);
469 while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
490 ext_palette = optarg;
494 ovr_palette = optarg;
496 case LOPT_OUTPUT_PREFIX:
510 if (mode == MODE_NONE) {
511 tool_err(-1, "you must specify a mode.");
515 fmt = lookup_format(fmtstring);
520 img = lbx_img_fopen(file);
522 img = lbx_img_open(&stdin_handle, &lbx_pipe_fops, NULL);
525 tool_err(-1, "failed to open image: %s.", lbx_errmsg());
529 if (ext_palette && !(palf = fopen(ext_palette, "rb"))) {
530 tool_err(0, "failed to open %s", optarg);
534 if (ovr_palette && !(overf = fopen(ovr_palette, "rb"))) {
535 tool_err(0, "failed to open %s", optarg);
539 if (verbose || mode == MODE_IDENT) {
545 palette_count = lbx_img_getpalette(img, NULL);
546 if (palette_count < 0) {
547 tool_err(-1, "error reading image: %s", lbx_errmsg());
551 printf("%s is %hux%hu LBX image, %hhu frame(s)%s%s%s\n",
552 file, img->width, img->height, img->frames,
553 palette_count ? ", embedded palette" : "",
554 img->chunk ? ", chunked" : "",
555 img->leadin+1 < img->frames ? ", loops" : "");
563 rc = decode(img, palf, overf, fmt, &argv[optind]);