spingle/source/image.c

/*
Copyright (C) 1996-2001 Id Software, Inc.
Copyright (C) 2002-2009 John Fitzgibbons and others
Copyright (C) 2010-2014 QuakeSpasm developers

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/
//image.c -- image loading

#include "q_defs.h"

#define STB_IMAGE_WRITE_IMPLEMENTATION
#define STB_IMAGE_WRITE_STATIC
#include "lib/stb_image_write.h"

#define LODEPNG_NO_COMPILE_DECODER
#define LODEPNG_NO_COMPILE_CPP
#define LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS
#define LODEPNG_NO_COMPILE_ERROR_TEXT
#include "lib/lodepng.h"
#include "lib/lodepng.c"

static char loadfilename[MAX_OSPATH]; //file scope so that error messages can use it

typedef struct stdio_buffer_s
{
	FILE *f;
	uint8_t buffer[1024];
	int32_t size;
	int32_t pos;
} stdio_buffer_t;

static stdio_buffer_t *Buf_Alloc(FILE *f)
{
	stdio_buffer_t *buf = (stdio_buffer_t *) calloc(1, sizeof(stdio_buffer_t));
	buf->f = f;
	return buf;
}

static void Buf_Free(stdio_buffer_t *buf)
{
	free(buf);
}

static inline int32_t Buf_GetC(stdio_buffer_t *buf)
{
	if(buf->pos >= buf->size)
	{
		buf->size = fread(buf->buffer, 1, sizeof(buf->buffer), buf->f);
		buf->pos = 0;

		if(buf->size == 0)
			return EOF;
	}

	return buf->buffer[buf->pos++];
}

/*
============
Image_LoadImage

returns a pointer to hunk allocated RGBA data

TODO: search order: tga png jpg pcx lmp
============
*/
byte *Image_LoadImage(const char *name, int32_t *width, int32_t *height)
{
	FILE    *f;

	q_snprintf(loadfilename, sizeof(loadfilename), "%s.tga", name);
	COM_FOpenFile(loadfilename, &f, NULL);
	if(f)
		return Image_LoadTGA(f, width, height);

	q_snprintf(loadfilename, sizeof(loadfilename), "%s.pcx", name);
	COM_FOpenFile(loadfilename, &f, NULL);
	if(f)
		return Image_LoadPCX(f, width, height);

	return NULL;
}

//==============================================================================
//
//  TGA
//
//==============================================================================

typedef struct targaheader_s
{
	uint8_t         id_length, colormap_type, image_type;
	uint16_t        colormap_index, colormap_length;
	uint8_t colormap_size;
	uint16_t        x_origin, y_origin, width, height;
	uint8_t pixel_size, attributes;
} targaheader_t;

#define TARGAHEADERSIZE 18 //size on disk

static targaheader_t targa_header;

static int32_t fgetLittleShort(FILE *f)
{
	size_t i;
	byte   b[2];

	for(i = 0; i < sizeof(b); i++)
		b[i] = fgetc(f);

	return LittleShort(BytesShort(b));
}

/*
============
Image_WriteTGA -- writes RGB or RGBA data to a TGA file

returns true if successful

TODO: support BGRA and BGR formats (since opengl can return them, and we don't have to swap)
============
*/
bool Image_WriteTGA(const char *name, byte *data, int32_t width, int32_t height, int32_t bpp, bool upsidedown)
{
	int32_t         handle, i, size, temp, bytes;
	char    pathname[MAX_OSPATH];
	byte    header[TARGAHEADERSIZE];

	Sys_mkdir(com_gamedir);  //if we've switched to a nonexistant gamedir, create it now so we don't crash
	q_snprintf(pathname, sizeof(pathname), "%s/%s", com_gamedir, name);
	handle = Sys_FileOpenWrite(pathname);
	if(handle == -1)
		return false;

	memset(header, 0, TARGAHEADERSIZE);
	header[2] = 2; // uncompressed type
	header[12] = width & 255;
	header[13] = width >> 8;
	header[14] = height & 255;
	header[15] = height >> 8;
	header[16] = bpp; // pixel size
	if(upsidedown)
		header[17] = 0x20; //upside-down attribute

	// swap red and blue bytes
	bytes = bpp / 8;
	size = width * height * bytes;
	for(i = 0; i < size; i += bytes)
	{
		temp = data[i];
		data[i] = data[i + 2];
		data[i + 2] = temp;
	}

	Sys_FileWrite(handle, header, TARGAHEADERSIZE);
	Sys_FileWrite(handle, data, size);
	Sys_FileClose(handle);

	return true;
}

/*
=============
Image_LoadTGA
=============
*/
byte *Image_LoadTGA(FILE *fin, int32_t *width, int32_t *height)
{
	int32_t                         columns, rows, numPixels;
	byte                    *pixbuf;
	int32_t                         row, column;
	byte                    *targa_rgba;
	int32_t                         realrow; //johnfitz -- fix for upside-down targas
	bool            upside_down; //johnfitz -- fix for upside-down targas
	stdio_buffer_t  *buf;

	targa_header.id_length = fgetc(fin);
	targa_header.colormap_type = fgetc(fin);
	targa_header.image_type = fgetc(fin);

	targa_header.colormap_index = fgetLittleShort(fin);
	targa_header.colormap_length = fgetLittleShort(fin);
	targa_header.colormap_size = fgetc(fin);
	targa_header.x_origin = fgetLittleShort(fin);
	targa_header.y_origin = fgetLittleShort(fin);
	targa_header.width = fgetLittleShort(fin);
	targa_header.height = fgetLittleShort(fin);
	targa_header.pixel_size = fgetc(fin);
	targa_header.attributes = fgetc(fin);

	if(targa_header.image_type != 2 && targa_header.image_type != 10)
		Sys_Error("Image_LoadTGA: %s is not a type 2 or type 10 targa\n", loadfilename);

	if(targa_header.colormap_type != 0 || (targa_header.pixel_size != 32 && targa_header.pixel_size != 24))
		Sys_Error("Image_LoadTGA: %s is not a 24bit or 32bit targa\n", loadfilename);

	columns = targa_header.width;
	rows = targa_header.height;
	numPixels = columns * rows;
	upside_down = !(targa_header.attributes & 0x20); //johnfitz -- fix for upside-down targas

	targa_rgba = Hunk_AllocName(numPixels * 4, __func__);

	if(targa_header.id_length != 0)
		fseek(fin, targa_header.id_length, SEEK_CUR);  // skip TARGA image comment

	buf = Buf_Alloc(fin);

	if(targa_header.image_type == 2) // Uncompressed, RGB images
	{
		for(row = rows - 1; row >= 0; row--)
		{
			//johnfitz -- fix for upside-down targas
			realrow = upside_down ? row : rows - 1 - row;
			pixbuf = targa_rgba + realrow * columns * 4;
			//johnfitz
			for(column = 0; column < columns; column++)
			{
				uint8_t red, green, blue, alphabyte;
				switch(targa_header.pixel_size)
				{
				case 24:
					blue = Buf_GetC(buf);
					green = Buf_GetC(buf);
					red = Buf_GetC(buf);
					*pixbuf++ = red;
					*pixbuf++ = green;
					*pixbuf++ = blue;
					*pixbuf++ = 255;
					break;
				case 32:
					blue = Buf_GetC(buf);
					green = Buf_GetC(buf);
					red = Buf_GetC(buf);
					alphabyte = Buf_GetC(buf);
					*pixbuf++ = red;
					*pixbuf++ = green;
					*pixbuf++ = blue;
					*pixbuf++ = alphabyte;
					break;
				}
			}
		}
	}
	else if(targa_header.image_type == 10) // Runlength encoded RGB images
	{
		uint8_t red, green, blue, alphabyte, packetHeader, packetSize, j;
		for(row = rows - 1; row >= 0; row--)
		{
			//johnfitz -- fix for upside-down targas
			realrow = upside_down ? row : rows - 1 - row;
			pixbuf = targa_rgba + realrow * columns * 4;
			//johnfitz
			for(column = 0; column < columns;)
			{
				packetHeader = Buf_GetC(buf);
				packetSize = 1 + (packetHeader & 0x7f);
				if(packetHeader & 0x80)  // run-length packet
				{
					switch(targa_header.pixel_size)
					{
					case 24:
						blue = Buf_GetC(buf);
						green = Buf_GetC(buf);
						red = Buf_GetC(buf);
						alphabyte = 255;
						break;
					case 32:
						blue = Buf_GetC(buf);
						green = Buf_GetC(buf);
						red = Buf_GetC(buf);
						alphabyte = Buf_GetC(buf);
						break;
					default: /* avoid compiler warnings */
						blue = red = green = alphabyte = 0;
					}

					for(j = 0; j < packetSize; j++)
					{
						*pixbuf++ = red;
						*pixbuf++ = green;
						*pixbuf++ = blue;
						*pixbuf++ = alphabyte;
						column++;
						if(column == columns) // run spans across rows
						{
							column = 0;
							if(row > 0)
								row--;
							else
								goto breakout;
							//johnfitz -- fix for upside-down targas
							realrow = upside_down ? row : rows - 1 - row;
							pixbuf = targa_rgba + realrow * columns * 4;
							//johnfitz
						}
					}
				}
				else // non run-length packet
				{
					for(j = 0; j < packetSize; j++)
					{
						switch(targa_header.pixel_size)
						{
						case 24:
							blue = Buf_GetC(buf);
							green = Buf_GetC(buf);
							red = Buf_GetC(buf);
							*pixbuf++ = red;
							*pixbuf++ = green;
							*pixbuf++ = blue;
							*pixbuf++ = 255;
							break;
						case 32:
							blue = Buf_GetC(buf);
							green = Buf_GetC(buf);
							red = Buf_GetC(buf);
							alphabyte = Buf_GetC(buf);
							*pixbuf++ = red;
							*pixbuf++ = green;
							*pixbuf++ = blue;
							*pixbuf++ = alphabyte;
							break;
						default: /* avoid compiler warnings */
							blue = red = green = alphabyte = 0;
						}
						column++;
						if(column == columns) // pixel packet run spans across rows
						{
							column = 0;
							if(row > 0)
								row--;
							else
								goto breakout;
							//johnfitz -- fix for upside-down targas
							realrow = upside_down ? row : rows - 1 - row;
							pixbuf = targa_rgba + realrow * columns * 4;
							//johnfitz
						}
					}
				}
			}
breakout:
			;
		}
	}

	Buf_Free(buf);
	fclose(fin);

	*width = (int32_t)(targa_header.width);
	*height = (int32_t)(targa_header.height);
	return targa_rgba;
}

//==============================================================================
//
//  PCX
//
//==============================================================================

typedef struct
{
	int8_t                  signature;
	int8_t                  version;
	int8_t                  encoding;
	int8_t                  bits_per_pixel;
	uint16_t        xmin, ymin, xmax, ymax;
	uint16_t        hdpi, vdpi;
	uint8_t                 colortable[48];
	int8_t                  reserved;
	int8_t                  color_planes;
	uint16_t        bytes_per_line;
	uint16_t        palette_type;
	uint8_t                 filler[58];
} pcxheader_t;

/*
============
Image_LoadPCX
============
*/
byte *Image_LoadPCX(FILE *f, int32_t *width, int32_t *height)
{
	pcxheader_t     pcx;
	int32_t                 x, y, w, h, readbyte, runlength, start;
	byte            *p, *data;
	byte            palette[768];
	stdio_buffer_t  *buf;

	start = ftell(f);  //save start of file (since we might be inside a pak file, SEEK_SET might not be the start of the pcx)

	fread(&pcx, sizeof(pcx), 1, f);
	pcx.xmin = (uint16_t)LittleShort(pcx.xmin);
	pcx.ymin = (uint16_t)LittleShort(pcx.ymin);
	pcx.xmax = (uint16_t)LittleShort(pcx.xmax);
	pcx.ymax = (uint16_t)LittleShort(pcx.ymax);
	pcx.bytes_per_line = (uint16_t)LittleShort(pcx.bytes_per_line);

	if(pcx.signature != 0x0A)
		Sys_Error("'%s' is not a valid PCX file", loadfilename);

	if(pcx.version != 5)
		Sys_Error("'%s' is version %" PRIi32 ", should be 5", loadfilename, pcx.version);

	if(pcx.encoding != 1 || pcx.bits_per_pixel != 8 || pcx.color_planes != 1)
		Sys_Error("'%s' has wrong encoding or bit depth", loadfilename);

	w = pcx.xmax - pcx.xmin + 1;
	h = pcx.ymax - pcx.ymin + 1;

	data = Hunk_AllocName((w * h + 1) * 4, __func__); //+1 to allow reading padding byte on last line

	//load palette
	fseek(f, start + com_filesize - 768, SEEK_SET);
	fread(palette, 1, 768, f);

	//back to start of image data
	fseek(f, start + sizeof(pcx), SEEK_SET);

	buf = Buf_Alloc(f);

	for(y = 0; y < h; y++)
	{
		p = data + y * w * 4;

		for(x = 0; x < (pcx.bytes_per_line);) //read the extra padding byte if necessary
		{
			readbyte = Buf_GetC(buf);

			if(readbyte >= 0xC0)
			{
				runlength = readbyte & 0x3F;
				readbyte = Buf_GetC(buf);
			}
			else
				runlength = 1;

			while(runlength--)
			{
				p[0] = palette[readbyte * 3];
				p[1] = palette[readbyte * 3 + 1];
				p[2] = palette[readbyte * 3 + 2];
				p[3] = 255;
				p += 4;
				x++;
			}
		}
	}

	Buf_Free(buf);
	fclose(f);

	*width = w;
	*height = h;
	return data;
}

//==============================================================================
//
//  STB_IMAGE_WRITE
//
//==============================================================================

static byte *CopyFlipped(const byte *data, int32_t width, int32_t height, int32_t bpp)
{
	int32_t y, rowsize;
	byte    *flipped;

	rowsize = width * (bpp / 8);
	flipped = (byte *) malloc(height * rowsize);
	if(!flipped)
		return NULL;

	for(y = 0; y < height; y++)
	{
		memcpy(&flipped[y * rowsize], &data[(height - 1 - y) * rowsize], rowsize);
	}
	return flipped;
}

/*
============
Image_WriteJPG -- writes using stb_image_write

returns true if successful
============
*/
bool Image_WriteJPG(const char *name, byte *data, int32_t width, int32_t height, int32_t bpp, int32_t quality, bool upsidedown)
{
	unsigned error;
	char    pathname[MAX_OSPATH];
	byte    *flipped;
	int32_t bytes_per_pixel;

	if(!(bpp == 32 || bpp == 24))
		Sys_Error("bpp not 24 or 32");

	bytes_per_pixel = bpp / 8;

	Sys_mkdir(com_gamedir);  //if we've switched to a nonexistant gamedir, create it now so we don't crash
	q_snprintf(pathname, sizeof(pathname), "%s/%s", com_gamedir, name);

	if(!upsidedown)
	{
		flipped = CopyFlipped(data, width, height, bpp);
		if(!flipped)
			return false;
	}
	else
		flipped = data;

	error = stbi_write_jpg(pathname, width, height, bytes_per_pixel, flipped, quality);
	if(!upsidedown)
		free(flipped);

	return (error != 0);
}

bool Image_WritePNG(const char *name, byte *data, int32_t width, int32_t height, int32_t bpp, bool upsidedown)
{
	unsigned error;
	char    pathname[MAX_OSPATH];
	byte    *flipped;
	uint8_t *filters;
	uint8_t *png;
	size_t          pngsize;
	LodePNGState    state;

	if(!(bpp == 32 || bpp == 24))
		Sys_Error("bpp not 24 or 32");

	Sys_mkdir(com_gamedir);  //if we've switched to a nonexistant gamedir, create it now so we don't crash
	q_snprintf(pathname, sizeof(pathname), "%s/%s", com_gamedir, name);

	flipped = (!upsidedown) ? CopyFlipped(data, width, height, bpp) : data;
	filters = (uint8_t *) malloc(height);
	if(!filters || !flipped)
	{
		if(!upsidedown)
			free(flipped);
		free(filters);
		return false;
	}

// set some options for faster compression
	lodepng_state_init(&state);
	state.encoder.zlibsettings.use_lz77 = 0;
	state.encoder.auto_convert = 0;
	state.encoder.filter_strategy = LFS_PREDEFINED;
	memset(filters, 1, height); //use filter 1; see https://www.w3.org/TR/PNG-Filters.html
	state.encoder.predefined_filters = filters;

	if(bpp == 24)
	{
		state.info_raw.colortype = LCT_RGB;
		state.info_png.color.colortype = LCT_RGB;
	}
	else
	{
		state.info_raw.colortype = LCT_RGBA;
		state.info_png.color.colortype = LCT_RGBA;
	}

	error = lodepng_encode(&png, &pngsize, flipped, width, height, &state);
	if(error == 0) lodepng_save_file(png, pngsize, pathname);
#if defined(LODEPNG_COMPILE_ERROR_TEXT)
	else Con_Printf("WritePNG: %s\n", lodepng_error_text());
#endif

	lodepng_state_cleanup(&state);
	free(png);
	free(filters);
	if(!upsidedown)
		free(flipped);

	return (error == 0);
}