gd_gd2.c

734 lines | 19.797 kB Blame History Raw Download
/*
* gd_gd2.c
*
* Implements the I/O and support for the GD2 format.
*
* Changing the definition of GD2_DBG (below) will cause copious messages
* to be displayed while it processes requests.
*
* Designed, Written & Copyright 1999, Philip Warner.
*
*/

#include <stdio.h>
#include <errno.h>
#include <math.h>
#include <string.h>
#include <stdlib.h>
#include <zlib.h>
#include "gd.h"

#define TRUE 1
#define FALSE 0

/* Use this for commenting out debug-print statements. */
/* Just use the first '#define' to allow all the prints... */
/*#define GD2_DBG(s) (s) */
#define GD2_DBG(s) 

typedef struct {
	int	offset;
	int	size;
	} t_chunk_info;

extern int _gdGetColors(gdIOCtx *in, gdImagePtr im);
extern void _gdPutColors(gdImagePtr im, gdIOCtx *out);

/* */
/* Read the extra info in the gd2 header. */
/* */
static 
int _gd2GetHeader(gdIOCtxPtr in, int *sx, int *sy, 
			int *cs, int *vers, int *fmt, int *ncx, int *ncy, t_chunk_info **chunkIdx)
{
        int     i;
        int     ch;
        char    id[5];
	t_chunk_info	*cidx;
	int	sidx;
	int	nc;

	GD2_DBG(printf("Reading gd2 header info\n"));

        for (i = 0; i < 4; i++) {
                ch = gdGetC(in);
                if (ch == EOF) {
                        goto fail1;
                };
                id[i] = ch;
        };
	id[4] = 0;

	GD2_DBG(printf("Got file code: %s\n", id));

	/* Equiv. of 'magick'.  */
        if (strcmp(id,GD2_ID) != 0) {
                GD2_DBG(printf("Not a valid gd2 file\n"));
                goto fail1;
        };

	/* Version */
        if (gdGetWord(vers, in) != 1) {
                goto fail1;
        };
	GD2_DBG(printf("Version: %d\n", *vers));

	if (*vers != 1) {
		GD2_DBG(printf("Bad version: %d\n", *vers));
		goto fail1;
	};

	/* Image Size */
        if (!gdGetWord(sx, in)) {
		GD2_DBG(printf("Could not get x-size\n"));
                goto fail1;
        }
	if (!gdGetWord(sy, in)) {
		GD2_DBG(printf("Could not get y-size\n"));
	        goto fail1;
	}
	GD2_DBG(printf("Image is %dx%d\n", *sx, *sy));

        /* Chunk Size */
        if (gdGetWord(cs, in) != 1) {
                goto fail1;
        };
        GD2_DBG(printf("ChunkSize: %d\n", *cs));

	if ( (*cs < GD2_CHUNKSIZE_MIN) || (*cs > GD2_CHUNKSIZE_MAX)) {
		GD2_DBG(printf("Bad chunk size: %d\n", *cs));
		goto fail1;
	};

	/* Data Format */
        if (gdGetWord(fmt, in) != 1) {
                goto fail1;
        };
	GD2_DBG(printf("Format: %d\n", *fmt));

	if ((*fmt != GD2_FMT_RAW) && (*fmt != GD2_FMT_COMPRESSED)) {
		GD2_DBG(printf("Bad data format: %d\n", *fmt));
		goto fail1;
	};


        /* # of chunks wide */
        if (gdGetWord(ncx, in) != 1) {
                goto fail1;
        };
	GD2_DBG(printf("%d Chunks Wide\n", *ncx));

        /* # of chunks high */
        if (gdGetWord(ncy, in) != 1) {
                goto fail1;
        };
	GD2_DBG(printf("%d Chunks vertically\n", *ncy));

	if ((*fmt) == GD2_FMT_COMPRESSED) {
		nc = (*ncx) * (*ncy);
                GD2_DBG(printf("Reading %d chunk index entries\n", nc));
		sidx = sizeof(t_chunk_info) * nc;
		cidx = calloc(sidx,1);
		for (i = 0; i < nc; i++) {
			if (gdGetInt(&cidx[i].offset, in) != 1) {
				goto fail1;
			};
                        if (gdGetInt(&cidx[i].size, in) != 1) {
                                goto fail1;
                        };
		};
		*chunkIdx = cidx;
	};

	GD2_DBG(printf("gd2 header complete\n"));

        return 1;

fail1:
        return 0;
}

static
gdImagePtr _gd2CreateFromFile(gdIOCtxPtr in, int *sx, int *sy, 
		int *cs, int *vers, int *fmt, 
		int *ncx, int *ncy, t_chunk_info **cidx)
{
        gdImagePtr im;

        if (_gd2GetHeader(in, sx, sy, cs, vers, fmt, ncx, ncy, cidx) != 1) {
		GD2_DBG(printf("Bad GD2 header\n"));
		goto fail1;
	}

	im = gdImageCreate(*sx, *sy);
	if (im == NULL) {
		GD2_DBG(printf("Could not create gdImage\n"));
		goto fail1;
	};

	if (!_gdGetColors(in, im)) {
		GD2_DBG(printf("Could not read color palette\n"));
		goto fail2;
	}
	GD2_DBG(printf("Image palette completed: %d colours\n", im->colorsTotal));

	return im;

fail2:
	gdImageDestroy(im);
	return 0;

fail1:
	return 0;

}

static
int _gd2ReadChunk(int offset, char *compBuf, int compSize, char *chunkBuf, uLongf *chunkLen, gdIOCtx *in)
{
	int	zerr;

	if (gdTell(in) != offset) {
		GD2_DBG(printf("Positioning in file to %d\n",offset));
		gdSeek(in,offset);
	} else {
		GD2_DBG(printf("Already Positioned in file to %d\n",offset));
	};

	/* Read and uncompress an entire chunk. */
	GD2_DBG(printf("Reading file\n"));
        if (gdGetBuf(compBuf, compSize, in) != compSize) {
		return FALSE;
	};
	GD2_DBG(printf("Got %d bytes. Uncompressing into buffer of %d bytes\n", compSize, *chunkLen));
	zerr = uncompress((unsigned char *) chunkBuf, chunkLen,  
		(unsigned char *) compBuf, compSize);
        if (zerr != Z_OK) {
		GD2_DBG(printf("Error %d from uncompress\n",zerr));
                return FALSE;
        };
	GD2_DBG(printf("Got chunk\n"));
	return TRUE;
}

gdImagePtr gdImageCreateFromGd2(FILE *inFile)
{
	gdIOCtx   	*in = gdNewFileCtx(inFile);
	gdImagePtr	im;

	im = gdImageCreateFromGd2Ctx(in);

	in->free(in);

	return im;
}

gdImagePtr gdImageCreateFromGd2Ctx(gdIOCtxPtr in)
{
        int sx, sy;
        int i;
        int ncx, ncy, nc, cs, cx, cy;
        int x, y, ylo, yhi, xlo, xhi;
	int ch, vers, fmt;
	t_chunk_info *chunkIdx = NULL; /* So we can free it with impunity. */
	char	*chunkBuf = NULL; /* So we can free it with impunity. */
	int	chunkNum = 0;
	int	chunkMax;
	uLongf 	chunkLen;
	int	chunkPos;
	int 	compMax;
	char	*compBuf = NULL; /* So we can free it with impunity. */

        gdImagePtr im;

	/* Get the header */
        im = _gd2CreateFromFile(in, &sx, &sy, &cs, &vers, &fmt, &ncx, &ncy, &chunkIdx);

        if (im == NULL) {
                return 0;
        };

	nc = ncx * ncy;

	if (fmt == GD2_FMT_COMPRESSED) {
		/* Find the maximum compressed chunk size. */
	        compMax = 0;
	        for (i=0; (i < nc) ; i++) {
			if ( chunkIdx[i].size > compMax) {
				compMax = chunkIdx[i].size;
			};
		};
		compMax++;

		/* Allocate buffers */
		chunkMax = cs * cs;
		chunkBuf = calloc(chunkMax,1);
		compBuf = calloc(compMax,1);
		GD2_DBG(printf("Largest compressed chunk is %d bytes\n",compMax));
	};

/*	if ( (ncx != sx / cs) || (ncy != sy / cs)) { */
/*		goto fail2; */
/*	}; */

	/* Read the data... */
        for (cy=0; (cy < ncy); cy++) {
                for (cx=0; (cx < ncx); cx++) {

                        ylo = cy * cs;
                        yhi = ylo + cs;
                        if (yhi > im->sy) {
                                yhi = im->sy;
                        };

                        GD2_DBG(printf("Processing Chunk %d (%d, %d), y from %d to %d\n",chunkNum, cx, cy, ylo, yhi));

			if (fmt == GD2_FMT_COMPRESSED) {

				chunkLen = chunkMax;

				if (!_gd2ReadChunk(	chunkIdx[chunkNum].offset,
							compBuf, 
							chunkIdx[chunkNum].size, 
							chunkBuf, &chunkLen, in))
				{
                                        GD2_DBG(printf("Error reading comproessed chunk\n"));
                                        goto fail2;
                                };

				chunkPos = 0;
			};

                        for (y= ylo ; (y < yhi); y++) {

                                xlo = cx * cs;
                                xhi = xlo + cs;
                                if (xhi > im->sx) {
                                        xhi = im->sx;
                                };
				/*GD2_DBG(printf("y=%d: ",y)); */
				if (fmt == GD2_FMT_RAW) {
                                	for (x= xlo ; x < xhi; x++) {

						ch = gdGetC(in);
						if (ch == EOF) {
							ch = 0;
							/*printf("EOF while reading\n"); */
							/*gdImageDestroy(im); */
							/*return 0; */
						}
						/*GD2_DBG(printf(" (%d, %d)", x, y)); */
						im->pixels[y][x] = ch;
					}
				} else {
					for (x= xlo ; x < xhi; x++) {
                                                im->pixels[y][x] = chunkBuf[chunkPos++];
                                        };
                                };
				/*GD2_DBG(printf("\n")); */
                        };
			chunkNum++;
                };
        };

	GD2_DBG(printf("Freeing memory\n"));

	free(chunkBuf);
	free(compBuf);
	free(chunkIdx);

	GD2_DBG(printf("Done\n"));

        return im;

fail2:
        gdImageDestroy(im);
        free(chunkBuf);
        free(compBuf);
	free(chunkIdx);
        return 0;

}

gdImagePtr gdImageCreateFromGd2Part(FILE *inFile, int srcx, int srcy, int w, int h)
{
	gdImagePtr	im;
        gdIOCtx   	*in = gdNewFileCtx(inFile);

	im = gdImageCreateFromGd2PartCtx(in, srcx, srcy, w, h);

	in->free(in);

	return im;
}

gdImagePtr gdImageCreateFromGd2PartCtx(gdIOCtx *in, int srcx, int srcy, int w, int h)
{
        int scx, scy, ecx, ecy, fsx, fsy;
        int nc, ncx, ncy, cs, cx, cy;
        int x, y, ylo, yhi, xlo, xhi;
	int dstart, dpos;
	int i;
        int ch, vers, fmt;
        t_chunk_info *chunkIdx = NULL;
        char    *chunkBuf = NULL;
        int     chunkNum;
        int     chunkMax;
        uLongf  chunkLen;
        int     chunkPos;
        int     compMax;
        char    *compBuf = NULL;

        gdImagePtr im;

	/* */
	/* The next few lines are basically copied from gd2CreateFromFile */
	/* - we change the file size, so don't want to use the code directly. */
	/*   but we do need to know the file size. */
	/* */
	if (_gd2GetHeader(in, &fsx, &fsy, &cs, &vers, &fmt, &ncx, &ncy, &chunkIdx) != 1) {
		goto fail1;
	}

	GD2_DBG(printf("File size is %dx%d\n", fsx, fsy));

	/* This is the difference - make a file based on size of chunks. */
        im = gdImageCreate(w, h);
        if (im == NULL) {
                goto fail1;
        };

	if (!_gdGetColors(in, im)) {
		goto fail2;
	}
        GD2_DBG(printf("Image palette completed: %d colours\n", im->colorsTotal));

	/* Process the header info */
        nc = ncx * ncy;

        if (fmt == GD2_FMT_COMPRESSED) {
                /* Find the maximum compressed chunk size. */
                compMax = 0;
                for (i=0; (i < nc) ; i++) {
                        if ( chunkIdx[i].size > compMax) {
                                compMax = chunkIdx[i].size;
                        };
                };
                compMax++;

                chunkMax = cs * cs;
                chunkBuf = calloc(chunkMax,1);
                compBuf = calloc(compMax,1);
        };

/*	Don't bother with this... */
/*      if ( (ncx != sx / cs) || (ncy != sy / cs)) { */
/*              goto fail2; */
/*      }; */


        /* Work out start/end chunks */
        scx = srcx / cs;
        scy = srcy / cs;
	if (scx < 0) { scx = 0;};
        if (scy < 0) { scy = 0;};

        ecx = (srcx + w) / cs;
        ecy = (srcy + h) / cs;
	if (ecx >= ncx) { ecx = ncx - 1;};
        if (ecy >= ncy) { ecy = ncy - 1;};

	/* Remember file position of image data. */
	dstart = gdTell(in);
	GD2_DBG(printf("Data starts at %d\n",dstart));

	/* Loop through the chunks. */
        for (cy=scy ; (cy <= ecy); cy++) {

                ylo = cy * cs;
                yhi = ylo + cs;
                if (yhi > fsy) {
                        yhi = fsy;
                };

                for (cx=scx; (cx <= ecx); cx++) {

                        xlo = cx * cs;
                        xhi = xlo + cs;
                        if (xhi > fsx) {
                                xhi = fsx;
                        };

                        GD2_DBG(printf("Processing Chunk (%d, %d), from %d to %d\n",cx, cy, ylo, yhi));

			if (fmt == GD2_FMT_RAW) {
				GD2_DBG(printf("Using raw format data\n"));
				dpos = cy * (cs * fsx) + cx * cs * (yhi-ylo)  + dstart;

				if (gdSeek(in, dpos) != 0) {
					printf("Error from seek: %d\n",errno);
					goto fail2;
				};
				GD2_DBG(printf("Reading (%d, %d) from position %d\n",cx,cy,dpos-dstart));
			} else {
				chunkNum = cx + cy * ncx;

				chunkLen = chunkMax;
                                if (!_gd2ReadChunk(     chunkIdx[chunkNum].offset,
                                                        compBuf,
                                                        chunkIdx[chunkNum].size,
                                                        chunkBuf, &chunkLen, in))
                                {
                                        printf("Error reading comproessed chunk\n");
                                        goto fail2;
                                };
				chunkPos= 0;
				GD2_DBG(printf("Reading (%d, %d) from chunk %d\n",cx,cy,chunkNum));
			};

			GD2_DBG(printf("   into (%d, %d) - (%d, %d)\n", xlo, ylo, xhi, yhi));
                        for (y=ylo ; (y < yhi); y++) {

                                for (x= xlo ; x < xhi; x++) {


                        		if (fmt == GD2_FMT_RAW) {
                                        	ch = gdGetC(in);
                                        	if (ch == EOF) {
                                                	ch = 0;
                                                	/*printf("EOF while reading file\n"); */
                                                	/*goto fail2; */
                                        	};
					} else {
						ch = chunkBuf[chunkPos++];
					};

					/* Only use a point that is in the image. */
					if ( (x >= srcx) && (x < (srcx + w)) && (x < fsx) && (x >= 0) 
					     && (y >= srcy)  && (y < (srcy + h)) && (y < fsy) && (y >= 0)
					   )
					{
                                        	im->pixels[y-srcy][x-srcx] = ch;
					} 	
                                };
                        };
                };
        };

        free(chunkBuf);
        free(compBuf);
	free(chunkIdx);

        return im;

fail2:
        gdImageDestroy(im);
fail1:
        free(chunkBuf);
        free(compBuf);
	free(chunkIdx);

        return 0;

}

static
void _gd2PutHeader(gdImagePtr im, gdIOCtx *out, int cs, int fmt, int cx, int cy)
{
	int i;

        /* Send the gd2 id, to verify file format. */
        for (i = 0; i < 4; i++) {
                gdPutC((unsigned char)(GD2_ID[i]), out);
        };

	/* */
	/* We put the version info first, so future versions can easily change header info. */
	/* */
	gdPutWord(GD2_VERS, out);
	gdPutWord(im->sx, out);
	gdPutWord(im->sy, out);
        gdPutWord(cs, out);
        gdPutWord(fmt, out);
        gdPutWord(cx, out);
        gdPutWord(cy, out);

}

static void _gdImageGd2(gdImagePtr im, gdIOCtx *out, int cs, int fmt)
{
        int ncx, ncy, cx, cy;
        int x, y, ylo, yhi, xlo, xhi;
        int     chunkLen;
        int     chunkNum = 0;
        char    *chunkData = NULL; /* So we can free it with impunity. */
        char    *compData = NULL; /* So we can free it with impunity. */
        uLongf  compLen;
        int     idxPos;
        int     idxSize;
        t_chunk_info     *chunkIdx = NULL;
        int     posSave;
	int	compMax;

        /*printf("Trying to write GD2 file\n"); */

	/* */
	/* Force fmt to a valid value since we don't return anything. */
	/* */
	if ( (fmt == 0) || ( (fmt != GD2_FMT_RAW) && (fmt != GD2_FMT_COMPRESSED) ) ) {
		fmt = GD2_FMT_COMPRESSED;
	};

	/* */
	/* Make sure chunk size is valid. These are arbitrary values; 64 because it seems */
	/* a little silly to expect performance improvements on a 64x64 bit scale, and  */
	/* 4096 because we buffer one chunk, and a 16MB buffer seems a little largei - it may be */
	/* OK for one user, but for another to read it, they require the buffer. */
	/* */
	if (cs == 0) {
		cs = GD2_CHUNKSIZE;
	} else if (cs < GD2_CHUNKSIZE_MIN) {
		cs = GD2_CHUNKSIZE_MIN;
	} else if (cs > GD2_CHUNKSIZE_MAX) {
		cs = GD2_CHUNKSIZE_MAX;
	};

	/* Work out number of chunks. */
        ncx = im->sx / cs + 1;
        ncy = im->sy / cs + 1;

        /* Write the standard header. */
        _gd2PutHeader(im, out, cs, fmt, ncx, ncy);

	if (fmt == GD2_FMT_COMPRESSED) {
        	/* */
        	/* Work out size of buffer for compressed data, If CHUNKSIZE is large, */
        	/* then these will be large! */
		/* */
		/* The zlib notes say output buffer size should be (input size) * 1.01 * 12 */
		/* - we'll use 1.02 to be paranoid. */
		/* */
        	compMax = cs * cs * 1.02 + 12;

		/* */
		/* Allocate the buffers.  */
		/* */
		chunkData = calloc(cs*cs,1);
		compData = calloc(compMax,1);

		/* */
        	/* Save the file position of chunk index, and allocate enough space for */
        	/* each chunk_info block . */
        	/* */
		idxPos = gdTell(out);
        	idxSize = ncx * ncy * sizeof(t_chunk_info);
		GD2_DBG(printf("Index size is %d\n", idxSize));
        	gdSeek(out,idxPos+idxSize);

        	chunkIdx = calloc(idxSize * sizeof(t_chunk_info),1);
	};

	_gdPutColors(im, out);

        GD2_DBG(printf("Size: %dx%d\n", im->sx, im->sy));
        GD2_DBG(printf("Chunks: %dx%d\n", ncx, ncy));

        for (cy=0; (cy < ncy); cy++) {
                for (cx=0; (cx < ncx); cx++) {

                        ylo = cy * cs;
                        yhi = ylo + cs;
                        if (yhi > im->sy) {
                                yhi = im->sy;
                        };

                        GD2_DBG(printf("Processing Chunk (%dx%d), y from %d to %d\n",cx, cy, ylo, yhi));
                        chunkLen = 0;
                        for (y= ylo ; (y < yhi); y++) {

                                /*GD2_DBG(printf("y=%d: ",y)); */

                                xlo = cx * cs;
                                xhi = xlo + cs;
                                if (xhi > im->sx) {
                                        xhi = im->sx;
                                };

				if (fmt == GD2_FMT_COMPRESSED) {
	                                for (x= xlo ; x < xhi; x++) {
                                         	/*GD2_DBG(printf("%d...",x)); */
                                        	chunkData[chunkLen++] = im->pixels[y][x];
					};
				} else {
                                	for (x= xlo ; x < xhi; x++) {
                                                /*GD2_DBG(printf("%d, ",x)); */
						gdPutC((unsigned char)im->pixels[y][x], out);
					};
				};
				/*GD2_DBG(printf("y=%d done.\n",y)); */
                        };
			if (fmt == GD2_FMT_COMPRESSED) {
                        	compLen = compMax;
                        	if (compress((unsigned char *) 
					&compData[0], &compLen, 
					(unsigned char *) &chunkData[0], 
					chunkLen) != Z_OK) {
                                	printf("Error from compressing\n");
                        	} else {
                                	chunkIdx[chunkNum].offset = gdTell(out);
                                	chunkIdx[chunkNum++].size = compLen;
                                	GD2_DBG(printf("Chunk %d size %d offset %d\n",chunkNum, chunkIdx[chunkNum-1].size, chunkIdx[chunkNum-1].offset));

					if (gdPutBuf(compData, compLen, out) <= 0) {
						/* Any alternate suggestions for handling this? */
                                        	printf("Error %d on write\n", errno);
                                	};
				};
                        };
                };
        };
	if (fmt == GD2_FMT_COMPRESSED) {
		/* Save the position, write the index, restore position (paranoia). */
		GD2_DBG(printf("Seeking %d to write index\n",idxPos));
        	posSave = gdTell(out);
        	gdSeek(out,idxPos);
		GD2_DBG(printf("Writing index\n"));
		for (x = 0; x < chunkNum; x++) {
                        GD2_DBG(printf("Chunk %d size %d offset %d\n", x, chunkIdx[x].size, chunkIdx[x].offset));
			gdPutInt(chunkIdx[x].offset, out);
                        gdPutInt(chunkIdx[x].size, out);
		};
		/* We don't use fwrite for *endian reasons. */
        	/*fwrite(chunkIdx, sizeof(int)*2, chunkNum, out); */
        	gdSeek(out, posSave);
	};

        GD2_DBG(printf("Freeing memory\n"));
	free(chunkData);
	free(compData);
	free(chunkIdx);
        GD2_DBG(printf("Done\n"));

	/*printf("Memory block size is %d\n",gdTell(out)); */

}

void gdImageGd2(gdImagePtr im, FILE *outFile, int cs, int fmt)
{
        gdIOCtx   *out = gdNewFileCtx(outFile);
	_gdImageGd2(im, out, cs, fmt);
	out->free(out);
}

void* gdImageGd2Ptr(gdImagePtr im, int cs, int fmt, int *size)
{
	void	*rv;
        gdIOCtx   *out = gdNewDynamicCtx(2048, NULL);
        _gdImageGd2(im, out, cs, fmt);
	rv = gdDPExtractData(out, size);
	out->free(out);
	return rv;
}