bspfile_xbsp.c

/* -------------------------------------------------------------------------------

Copyright (C) 1999-2006 Id Software, Inc. and contributors.
For a list of contributors, see the accompanying CONTRIBUTORS file.

This file is part of GtkRadiant.

GtkRadiant 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.

GtkRadiant 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 GtkRadiant; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

----------------------------------------------------------------------------------

This code has been altered significantly from its original form, to support
several games based on the Quake III Arena engine, in the form of "Q3Map2."

------------------------------------------------------------------------------- */



/* marker */
#define BSPFILE_XBSP_C



/* dependencies */
#include "kmap2.h"




/* -------------------------------------------------------------------------------

this file handles translating the bsp file format used by KingpinQ3
into the abstracted bsp file used by xmap2.

------------------------------------------------------------------------------- */

/* constants */
#define	LUMP_ENTITIES		0
#define	LUMP_SHADERS		1
#define	LUMP_PLANES			2
#define	LUMP_NODES			3
#define	LUMP_LEAFS			4
#define	LUMP_LEAFSURFACES	5
#define	LUMP_LEAFBRUSHES	6
#define	LUMP_MODELS			7
#define	LUMP_BRUSHES		8
#define	LUMP_BRUSHSIDES		9
#define	LUMP_DRAWVERTS		10
#define	LUMP_DRAWINDEXES	11
#define	LUMP_FOGS			12
#define	LUMP_SURFACES		13
#define	LUMP_LIGHTMAPS		14
#define	LUMP_LIGHTGRID		15
#define	LUMP_VISIBILITY		16
#define	HEADER_LUMPS		17


/* types */
typedef struct
{
	char            ident[4];
	int             version;

	bspLump_t       lumps[HEADER_LUMPS];
}
xbspHeader_t;



/* brush sides */
typedef struct
{
	int             planeNum;
	int             shaderNum;
}
xbspBrushSide_t;


static void CopyBrushSidesLump(xbspHeader_t * header)
{
	int             i;
	xbspBrushSide_t *in;
	bspBrushSide_t *out;


	/* get count */
	numBSPBrushSides = GetLumpElements((bspHeader_t *) header, LUMP_BRUSHSIDES, sizeof(*in));

	/* copy */
	in = GetLump((bspHeader_t *) header, LUMP_BRUSHSIDES);
	for(i = 0; i < numBSPBrushSides; i++)
	{
		AUTOEXPAND_BY_REALLOC(bspBrushSides, i, allocatedBSPBrushSides, 1024);
		out = &bspBrushSides[i];
		out->planeNum = in->planeNum;
		out->shaderNum = in->shaderNum;
		out->surfaceNum = -1;
		in++;
	}
}


static void AddBrushSidesLump(FILE * file, xbspHeader_t * header)
{
	int             i, size;
	bspBrushSide_t *in;
	xbspBrushSide_t *buffer, *out;


	/* allocate output buffer */
	size = numBSPBrushSides * sizeof(*buffer);
	buffer = safe_malloc(size);
	memset(buffer, 0, size);

	/* convert */
	in = bspBrushSides;
	out = buffer;
	for(i = 0; i < numBSPBrushSides; i++)
	{
		out->planeNum = in->planeNum;
		out->shaderNum = in->shaderNum;
		in++;
		out++;
	}

	/* write lump */
	AddLump(file, (bspHeader_t *) header, LUMP_BRUSHSIDES, buffer, size);

	/* free buffer */
	free(buffer);
}



/* drawsurfaces */
typedef struct xbspDrawSurface_s
{
	int             shaderNum;
	int             fogNum;
	int             surfaceType;

	int             firstVert;
	int             numVerts;

	int             firstIndex;
	int             numIndexes;

	int             lightmapNum;
	int             lightmapX, lightmapY;
	int             lightmapWidth, lightmapHeight;

	vec3_t          lightmapOrigin;
	vec3_t          lightmapVecs[3];

	int             patchWidth;
	int             patchHeight;
}
xbspDrawSurface_t;


static void CopyDrawSurfacesLump(xbspHeader_t * header)
{
	int             i, j;
	xbspDrawSurface_t *in;
	bspDrawSurface_t *out;


	/* get count */
	numBSPDrawSurfaces = GetLumpElements((bspHeader_t *) header, LUMP_SURFACES, sizeof(*in));
	SetDrawSurfaces(numBSPDrawSurfaces);

	/* copy */
	in = GetLump((bspHeader_t *) header, LUMP_SURFACES);
	out = bspDrawSurfaces;
	for(i = 0; i < numBSPDrawSurfaces; i++)
	{
		out->shaderNum = in->shaderNum;
		out->fogNum = in->fogNum;
		out->surfaceType = in->surfaceType;
		out->firstVert = in->firstVert;
		out->numVerts = in->numVerts;
		out->firstIndex = in->firstIndex;
		out->numIndexes = in->numIndexes;

		out->lightmapStyles[0] = LS_NORMAL;
		out->vertexStyles[0] = LS_NORMAL;
		out->lightmapNum[0] = in->lightmapNum;
		out->lightmapX[0] = in->lightmapX;
		out->lightmapY[0] = in->lightmapY;

		for(j = 1; j < MAX_LIGHTMAPS; j++)
		{
			out->lightmapStyles[j] = LS_NONE;
			out->vertexStyles[j] = LS_NONE;
			out->lightmapNum[j] = -3;
			out->lightmapX[j] = 0;
			out->lightmapY[j] = 0;
		}

		out->lightmapWidth = in->lightmapWidth;
		out->lightmapHeight = in->lightmapHeight;

		VectorCopy(in->lightmapOrigin, out->lightmapOrigin);
		VectorCopy(in->lightmapVecs[0], out->lightmapVecs[0]);
		VectorCopy(in->lightmapVecs[1], out->lightmapVecs[1]);
		VectorCopy(in->lightmapVecs[2], out->lightmapVecs[2]);

		out->patchWidth = in->patchWidth;
		out->patchHeight = in->patchHeight;

		in++;
		out++;
	}
}


static void AddDrawSurfacesLump(FILE * file, xbspHeader_t * header)
{
	int             i, size;
	bspDrawSurface_t *in;
	xbspDrawSurface_t *buffer, *out;


	/* allocate output buffer */
	size = numBSPDrawSurfaces * sizeof(*buffer);
	buffer = safe_malloc(size);
	memset(buffer, 0, size);

	/* convert */
	in = bspDrawSurfaces;
	out = buffer;
	for(i = 0; i < numBSPDrawSurfaces; i++)
	{
		out->shaderNum = in->shaderNum;
		out->fogNum = in->fogNum;
		out->surfaceType = in->surfaceType;
		out->firstVert = in->firstVert;
		out->numVerts = in->numVerts;
		out->firstIndex = in->firstIndex;
		out->numIndexes = in->numIndexes;

		out->lightmapNum = in->lightmapNum[0];
		out->lightmapX = in->lightmapX[0];
		out->lightmapY = in->lightmapY[0];
		out->lightmapWidth = in->lightmapWidth;
		out->lightmapHeight = in->lightmapHeight;

		VectorCopy(in->lightmapOrigin, out->lightmapOrigin);
		VectorCopy(in->lightmapVecs[0], out->lightmapVecs[0]);
		VectorCopy(in->lightmapVecs[1], out->lightmapVecs[1]);
		VectorCopy(in->lightmapVecs[2], out->lightmapVecs[2]);

		out->patchWidth = in->patchWidth;
		out->patchHeight = in->patchHeight;

		in++;
		out++;
	}

	/* write lump */
	AddLump(file, (bspHeader_t *) header, LUMP_SURFACES, buffer, size);

	/* free buffer */
	free(buffer);
}



/* drawverts */
typedef struct
{
	vec3_t          xyz;
	float           st[2];
	float           lightmap[2];
	vec3_t          normal;
	float           paintColor[4]; //vertex lightmap color + alpha
	float           lightColor[4];
	float           lightDirection[3];
}
xbspDrawVert_t;


static void CopyDrawVertsLump(xbspHeader_t * header)
{
	int             i;
	xbspDrawVert_t *in;
	bspDrawVert_t  *out;


	/* get count */
	numBSPDrawVerts = GetLumpElements((bspHeader_t *) header, LUMP_DRAWVERTS, sizeof(*in));
	SetDrawVerts(numBSPDrawVerts);

	/* copy */
	in = GetLump((bspHeader_t *) header, LUMP_DRAWVERTS);
	out = bspDrawVerts;
	for(i = 0; i < numBSPDrawVerts; i++)
	{
		VectorCopy(in->xyz, out->xyz);
		out->st[0] = in->st[0];
		out->st[1] = in->st[1];

		out->lightmap[0][0] = in->lightmap[0];
		out->lightmap[0][1] = in->lightmap[1];

		VectorCopy(in->normal, out->normal);

		out->paintColor[0] = in->paintColor[0];
		out->paintColor[1] = in->paintColor[1];
		out->paintColor[2] = in->paintColor[2];
		out->paintColor[3] = in->paintColor[3];

		out->lightColor[0][0] = in->lightColor[0];
		out->lightColor[0][1] = in->lightColor[1];
		out->lightColor[0][2] = in->lightColor[2];
		out->lightColor[0][3] = in->lightColor[3];

		out->lightDirection[0][0] = in->lightDirection[0];
		out->lightDirection[0][1] = in->lightDirection[1];
		out->lightDirection[0][2] = in->lightDirection[2];

		in++;
		out++;
	}
}


static void AddDrawVertsLump(FILE * file, xbspHeader_t * header)
{
	int             i, size;
	bspDrawVert_t  *in;
	xbspDrawVert_t *buffer, *out;


	/* allocate output buffer */
	size = numBSPDrawVerts * sizeof(*buffer);
	buffer = safe_malloc(size);
	memset(buffer, 0, size);

	/* convert */
	in = bspDrawVerts;
	out = buffer;
	for(i = 0; i < numBSPDrawVerts; i++)
	{
		VectorCopy(in->xyz, out->xyz);
		out->st[0] = in->st[0];
		out->st[1] = in->st[1];

		out->lightmap[0] = in->lightmap[0][0];
		out->lightmap[1] = in->lightmap[0][1];

		VectorCopy(in->normal, out->normal);

		out->paintColor[0] = in->paintColor[0];
		out->paintColor[1] = in->paintColor[1];
		out->paintColor[2] = in->paintColor[2];
		out->paintColor[3] = in->paintColor[3];

		out->lightColor[0] = in->lightColor[0][0];
		out->lightColor[1] = in->lightColor[0][1];
		out->lightColor[2] = in->lightColor[0][2];
		out->lightColor[3] = in->lightColor[0][3];

		out->lightDirection[0] = in->lightDirection[0][0];
		out->lightDirection[1] = in->lightDirection[0][1];
		out->lightDirection[2] = in->lightDirection[0][2];

		in++;
		out++;
	}

	/* write lump */
	AddLump(file, (bspHeader_t *) header, LUMP_DRAWVERTS, buffer, size);

	/* free buffer */
	free(buffer);
}



/* light grid */
typedef struct
{
	float           ambient[3];
	float           directed[3];
	byte            latLong[2];
}
xbspGridPoint_t;


static void CopyLightGridLumps(xbspHeader_t * header)
{
	int             i, j;
	xbspGridPoint_t *in;
	bspGridPoint_t *out;


	/* get count */
	numBSPGridPoints = GetLumpElements((bspHeader_t *) header, LUMP_LIGHTGRID, sizeof(*in));

	/* allocate buffer */
	bspGridPoints = safe_malloc(numBSPGridPoints * sizeof(*bspGridPoints));
	memset(bspGridPoints, 0, numBSPGridPoints * sizeof(*bspGridPoints));

	/* copy */
	in = GetLump((bspHeader_t *) header, LUMP_LIGHTGRID);
	out = bspGridPoints;
	for(i = 0; i < numBSPGridPoints; i++)
	{
		for(j = 0; j < MAX_LIGHTMAPS; j++)
		{
			VectorCopy(in->ambient, out->ambient[j]);
			VectorCopy(in->directed, out->directed[j]);
			out->styles[j] = LS_NONE;
		}

		out->styles[0] = LS_NORMAL;

		out->latLong[0] = in->latLong[0];
		out->latLong[1] = in->latLong[1];

		in++;
		out++;
	}
}


static void AddLightGridLumps(FILE * file, xbspHeader_t * header)
{
	int             i;
	bspGridPoint_t *in;
	xbspGridPoint_t *buffer, *out;


	/* dummy check */
	if(bspGridPoints == NULL)
		return;

	/* allocate temporary buffer */
	buffer = safe_malloc(numBSPGridPoints * sizeof(*out));

	/* convert */
	in = bspGridPoints;
	out = buffer;
	for(i = 0; i < numBSPGridPoints; i++)
	{
		VectorCopy(in->ambient[0], out->ambient);
		VectorCopy(in->directed[0], out->directed);

		out->latLong[0] = in->latLong[0];
		out->latLong[1] = in->latLong[1];

		in++;
		out++;
	}

	/* write lumps */
	AddLump(file, (bspHeader_t *) header, LUMP_LIGHTGRID, buffer, (numBSPGridPoints * sizeof(*out)));

	/* free buffer (ydnar 2002-10-22: [bug 641] thanks Rap70r! */
	free(buffer);
}



/*
LoadXBSPFile()
loads a quake 3 bsp file into memory
*/

void LoadXBSPFile(const char *filename)
{
	xbspHeader_t   *header;


	/* load the file header */
	LoadFile(filename, (void **)&header);

	/* swap the header (except the first 4 bytes) */
	SwapBlock((int *)((byte *) header + sizeof(int)), sizeof(*header) - sizeof(int));

#ifdef KMAP2_NO_TYPE_PUNNING
  if(force == qfalse && !Vec4_Comp(header->ident, game->bspIdent))
    Error("%s is not a %s file", filename, game->bspIdent);
#else
  /* make sure it matches the format we're trying to load */
  if(force == qfalse && *((int *)header->ident) != *((int *)game->bspIdent))
    Error("%s is not a %s file", filename, game->bspIdent);
#endif

	if(force == qfalse && header->version != game->bspVersion)
		Error("%s is version %d, not %d", filename, header->version, game->bspVersion);

	/* load/convert lumps */
	numBSPShaders =
		CopyLump_Allocate((bspHeader_t *) header, LUMP_SHADERS, (void **)&bspShaders, sizeof(bspShader_t), &allocatedBSPShaders);

	numBSPModels =
		CopyLump_Allocate((bspHeader_t *) header, LUMP_MODELS, (void **)&bspModels, sizeof(bspModel_t), &allocatedBSPModels);

	numBSPPlanes =
		CopyLump_Allocate((bspHeader_t *) header, LUMP_PLANES, (void **)&bspPlanes, sizeof(bspPlane_t), &allocatedBSPPlanes);

	numBSPLeafs = CopyLump((bspHeader_t *) header, LUMP_LEAFS, bspLeafs, sizeof(bspLeaf_t));

	numBSPNodes =
		CopyLump_Allocate((bspHeader_t *) header, LUMP_NODES, (void **)&bspNodes, sizeof(bspNode_t), &allocatedBSPNodes);

	numBSPLeafSurfaces =
		CopyLump_Allocate((bspHeader_t *) header, LUMP_LEAFSURFACES, (void **)&bspLeafSurfaces, sizeof(bspLeafSurfaces[0]),
						  &allocatedBSPLeafSurfaces);

	numBSPLeafBrushes =
		CopyLump_Allocate((bspHeader_t *) header, LUMP_LEAFBRUSHES, (void **)&bspLeafBrushes, sizeof(bspLeafBrushes[0]),
						  &allocatedBSPLeafBrushes);

	numBSPBrushes =
		CopyLump_Allocate((bspHeader_t *) header, LUMP_BRUSHES, (void **)&bspBrushes, sizeof(bspBrush_t),
						  &allocatedBSPLeafBrushes);

	CopyBrushSidesLump(header);

	CopyDrawVertsLump(header);

	CopyDrawSurfacesLump(header);

	numBSPFogs = CopyLump((bspHeader_t *) header, LUMP_FOGS, bspFogs, sizeof(bspFog_t));

	numBSPDrawIndexes = CopyLump((bspHeader_t *) header, LUMP_DRAWINDEXES, bspDrawIndexes, sizeof(bspDrawIndexes[0]));

	numBSPVisBytes = CopyLump((bspHeader_t *) header, LUMP_VISIBILITY, bspVisBytes, 1);

	numBSPLightBytes = GetLumpElements((bspHeader_t *) header, LUMP_LIGHTMAPS, 1);
	bspLightBytes = safe_malloc(numBSPLightBytes);
	CopyLump((bspHeader_t *) header, LUMP_LIGHTMAPS, bspLightBytes, 1);

	bspEntDataSize = CopyLump_Allocate((bspHeader_t *) header, LUMP_ENTITIES, (void **)&bspEntData, 1, &allocatedBSPEntData);

	CopyLightGridLumps(header);

	/* free the file buffer */
	free(header);
}



/*
WriteXBSPFile()
writes an id bsp file
*/

void WriteXBSPFile(const char *filename)
{
	xbspHeader_t    outheader, *header;
	FILE           *file;
	time_t          t;
	char            marker[1024];
	int             size;


	/* set header */
	header = &outheader;
	memset(header, 0, sizeof(*header));

	//% Swapfile();
#ifdef KMAP2_NO_TYPE_PUNNING
  /* set up header */
  Vec4_Copy(game->bspIdent, header->ident);
#else
	/* set up header */
	*((int *)(bspHeader_t *) header->ident) = *((int *)game->bspIdent);
#endif
	header->version = LittleLong(game->bspVersion);

	/* write initial header */
	file = SafeOpenWrite(filename);
	SafeWrite(file, (bspHeader_t *) header, sizeof(*header));	/* overwritten later */

	/* add marker lump */
	time(&t);
	sprintf(marker, "I LOVE MY KMAP2 %s on %s)", KMAP_VERSION, asctime(localtime(&t)));
	AddLump(file, (bspHeader_t *) header, 0, marker, strlen(marker) + 1);

	/* add lumps */
	AddLump(file, (bspHeader_t *) header, LUMP_SHADERS, bspShaders, numBSPShaders * sizeof(bspShader_t));
	AddLump(file, (bspHeader_t *) header, LUMP_PLANES, bspPlanes, numBSPPlanes * sizeof(bspPlane_t));
	AddLump(file, (bspHeader_t *) header, LUMP_LEAFS, bspLeafs, numBSPLeafs * sizeof(bspLeaf_t));
	AddLump(file, (bspHeader_t *) header, LUMP_NODES, bspNodes, numBSPNodes * sizeof(bspNode_t));
	AddLump(file, (bspHeader_t *) header, LUMP_BRUSHES, bspBrushes, numBSPBrushes * sizeof(bspBrush_t));
	AddBrushSidesLump(file, header);
	AddLump(file, (bspHeader_t *) header, LUMP_LEAFSURFACES, bspLeafSurfaces, numBSPLeafSurfaces * sizeof(bspLeafSurfaces[0]));
	AddLump(file, (bspHeader_t *) header, LUMP_LEAFBRUSHES, bspLeafBrushes, numBSPLeafBrushes * sizeof(bspLeafBrushes[0]));
	AddLump(file, (bspHeader_t *) header, LUMP_MODELS, bspModels, numBSPModels * sizeof(bspModel_t));
	AddDrawVertsLump(file, header);
	AddDrawSurfacesLump(file, header);
	AddLump(file, (bspHeader_t *) header, LUMP_VISIBILITY, bspVisBytes, numBSPVisBytes);
	AddLump(file, (bspHeader_t *) header, LUMP_LIGHTMAPS, bspLightBytes, numBSPLightBytes);
	AddLightGridLumps(file, header);
	AddLump(file, (bspHeader_t *) header, LUMP_ENTITIES, bspEntData, bspEntDataSize);
	AddLump(file, (bspHeader_t *) header, LUMP_FOGS, bspFogs, numBSPFogs * sizeof(bspFog_t));
	AddLump(file, (bspHeader_t *) header, LUMP_DRAWINDEXES, bspDrawIndexes, numBSPDrawIndexes * sizeof(bspDrawIndexes[0]));

	/* emit bsp size */
	size = ftell(file);
	Sys_Printf("%-23s (%d bytes)\n", va("Wrote %.1f MB", (float)size / (1024 * 1024)), size);

	/* write the completed header */
	fseek(file, 0, SEEK_SET);
	SafeWrite(file, header, sizeof(*header));

	/* close the file */
	fclose(file);
}