path: root/pgm-interlace.c

/*
 * pgm-interlace - combine separate, partial-image PGMs into one
 * Copyright (c) 2016 David Phillips <dbphillipsnz@gmail.com>
 * All rights reserved
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>
#include <string.h>

#define PGM_MAGIC "P5"

/*
 * check header values are within sane limits and that they agree with the PGM
 * spec at: http://netpbm.sourceforge.net/doc/pgm.html
 */
int check_sanity(long width, long height, long white, long clust_total)
{
	if (width <= 0 || height <= 0)
	{
		fprintf(stderr, "check_sanity: image dimensions must be positive\n");
		return 1;
	}

	if (white <= 0)
	{
		fprintf(stderr, "check_sanity: white value must be positive\n");
		return 1;
	}

	/* FIXME only support single-byte pixels, PGM supports 16-bit according
	 * to <http://netpbm.sourceforge.net/doc/pgm.html> */
	if (white > 255)
	{
		fprintf(stderr, "check_sanity: white value must be less than 256\n");
		return 1;
	}

	if (height * clust_total != width)
	{
		fprintf(stderr, "check_sanity: %ld images of %ldx%ld cannot interlace to a square image %ldx%ld\n",
			clust_total, width, height, height, height);
		return 1;
	}
	return 0;
}


/*
 * consumes the file which are whitespace, starting at the current offset.
 * treats comments as whitespace
 */
void eat_whitespace(FILE *fd)
{
	int c = '\0';

	do
	{
		c = fgetc(fd);
		if (isspace(c))
			continue;

		switch (c)
		{
			case '#':
				/* suck up the current line of the file */
				while (c != '\n' && c != '\r' && c != EOF)
					c = fgetc(fd);
				break;
			case EOF:
				break;
			default:
				ungetc(c, fd);
				break;
		}
	} while (isspace(c) || c == '#');
}


/*
 * read token from fd into token, limiting stored size to token_size, including
 * the null terminator. Limits token's constituent bytes to those in allowable.
 * In the case allowable is a null pointer, we will treat all non-whitespace
 * characters as allowable ones.
 */
int read_token(FILE *fd, char *token, size_t token_size, const char *allowable)
{
	int c = '\0';
	size_t t = 0;

	while (!feof(fd))
	{
		c = fgetc(fd);

		if (allowable == NULL)
		{
			if (isspace(c))
				break;
		} else {
			if (strchr(allowable, c) == NULL)
				break;
		}

		/* -1 to leave room for null terminator*/
		if (t >= token_size - 1)
		{
			fprintf(stderr, "read_token: token too large for buffer\n");
			return 1;
		}

		token[t++] = c;
	}

	ungetc(c, fd);

	token[t] = '\0';

	if (strlen(token) == 0)
	{
		fprintf(stderr, "read_token: no token available\n");
		return 1;
	}

	return 0;
}


/*
 * wrapper around read_token which reads a non-negative integer token
 */
int read_non_negative_int(FILE *fd, char *token, size_t token_size)
{
	return read_token(fd, token, token_size, "0123456789");
}


/*
 * parse the file's header and read fields into variables
 */
int parse_header(FILE *fd, char *magic, size_t magic_len, long *width, long *height, int *white)
{
	char token[32];

	if (read_token(fd, magic, magic_len, NULL))
	{
		fprintf(stderr, "parse_header: failed to read magic number\n");
		return 1;
	}

	if (memcmp(magic, PGM_MAGIC, magic_len) != 0)
	{
		fprintf(stderr, "parse_header: magic number does not check out, stop\n");
		return 1;
	}

	eat_whitespace(fd);

	if (read_non_negative_int(fd, token, sizeof(token)) != 0)
	{
		fprintf(stderr, "parse_header: cannot read width\n");
		return 1;
	}
	*width = atol(token);
	eat_whitespace(fd);

	if (read_non_negative_int(fd, token, sizeof(token)))
	{
		fprintf(stderr, "parse_header: cannot read height\n");
		return 1;
	}
	*height = atol(token); /* size == height */
	eat_whitespace(fd);

	if (read_non_negative_int(fd, token, sizeof(token)))
	{
		fprintf(stderr, "parse_header: cannot read white value\n");
		return 1;
	}
	*white = atol(token);

	/* standard dictates one whitespace character. This character must be
	 * whitespace or EOF because of token parsing logic */
	if (fgetc(fd) == EOF)
	{
		fprintf(stderr, "parse_header: premature end of header\n");
		return 1;
	}
	return 0;
}

/**/
void close_all(FILE **f, size_t f_len)
{
	size_t i = 0;

	for (i = 0; i < f_len; i++)
		fclose(f[i]);
}

/**/
int write_pgm(FILE *fout, unsigned long size, unsigned int white, FILE **fin, size_t fin_len)
{
	char *buffer = NULL;
	unsigned long y = 0;
	size_t fnum = 0;
	size_t n = 0;

	buffer = malloc(size);
	if (buffer == NULL)
	{
		perror("write_pgm: failed to allocate buffer");
		return 1;
	}

	/* Output PGM Header */
	fprintf(fout, "%s\n%ld\n%ld\n%d\n", PGM_MAGIC, size, size, white);

	for (y = 0; y < size; y++)
	{
		fnum = y % fin_len;
		n = fread(buffer, 1, size, fin[fnum]);
		if (n == 0)
		{
			fprintf(stderr, "Unexpected EOF on file %zd at row %lu; pgm input truncated? Stop.\n", fnum, y);
			free(buffer);
			return 1;
		}
		n = fwrite(buffer, n, 1, fout);
		if (n != 1)
		{
			perror("Unable to write to output stream");
			free(buffer);
			return 1;
		}
	}
	free(buffer);
	return 0;
}


int main(int argc, char **argv)
{
	int ret = 0;
	int i = 0;
	long height = 0;
	long size = 0;
	long new_height = 0;
	long new_size = 0;
	int white = 0;
	int new_white = 0;
	int clust_total = argc-1;
	FILE **f = NULL;
	char magic[3];
	char new_magic[3];

	if (argc == 1)
	{
		fprintf(stderr, "%s [image 0] [image 1] ...\n", argv[0]);
		return 1;
	}

	if ( (f = malloc(sizeof(FILE*)*(clust_total)) ) == NULL)
	{
		perror("malloc");
		return 1;
	}

	for (i = 1; i < argc; i++)
	{
		if ((f[i-1] = fopen(argv[i], "r")) == NULL)
		{
			fprintf(stderr, "failed to open '%s': ", argv[i]);
			perror("fopen");

			/* close those files already opened */
			i--;
			for ( ; i > 1; i--)
				fclose(f[i-1]);

			ret = 1;
			goto STOP_FREE_ONLY;
		}
	}

	/* read the first file's header and check that the values are sane */
	if (   parse_header(f[0], magic, sizeof(magic), &size, &height, &white) != 0
		|| check_sanity(size, height, white, clust_total) != 0) {
		ret = 1;
		goto STOP;
	}

	/* check that header values all agree */
	for (i = 1; i < clust_total; i++)
	{
		parse_header(f[i], new_magic, sizeof(new_magic), &new_size, &new_height, &new_white);
		if (strcmp(magic, new_magic) != 0
		    || height != new_height
		    || size != new_size
		    || white != new_white)
		{
			fprintf(stderr, "Error: '%s' doesn't have identical header to '%s', stop\n", argv[i+1], argv[1]);
			ret = 1;
			goto STOP;
		}
	}

	fprintf(stderr, "Full image size will be %ldx%ld, using %d images\n", size, size, clust_total);

	if (write_pgm(stdout, size, white, f, clust_total))
	{
		ret = 1;
		goto STOP;
	}

STOP:
	close_all(f, clust_total);
STOP_FREE_ONLY:
	free(f);

	return ret;
}