xash3d-fwgs/utils/mdldec/qc.c

/*
qc.c - Quake C script writer
Copyright (C) 2020 Andrey Akhmichin

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 3 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.
*/

#include <stdlib.h>
#include <string.h>
#include "eiface.h"
#include "studio.h"
#include "crtlib.h"
#include "version.h"
#include "mdldec.h"
#include "utils.h"
#include "qc.h"

static char	**activity_names;
static int	  activity_count;

/*
============
LoadActivityList
============
*/
qboolean LoadActivityList( const char *appname )
{
	FILE		*fp;
	const char	*p;
	char		 path[MAX_SYSPATH];
	char		 buf[256];

	fp = fopen( ACTIVITIES_FILE, "r" );

	if( !fp )
	{
		p = getenv( "MDLDEC_ACT_PATH" );

		if( !p )
		{
			fprintf( stderr, "ERROR: Couldn't find file " ACTIVITIES_FILE ".\n" \
			    "Place " ACTIVITIES_FILE " beside %s or set MDLDEC_ACT_PATH environment variable.\n", appname );
			return false;
		}

		Q_strncpy( path, p, MAX_SYSPATH - 1 );

		COM_PathSlashFix( path );

		Q_strncat( path, ACTIVITIES_FILE, MAX_SYSPATH );

		fp = fopen( path, "r" );

		if( !fp )
		{
			fputs( "ERROR: Can't open file " ACTIVITIES_FILE ".\n", stderr );
			return false;
		}
	}

	while( fgets( buf, sizeof( buf ), fp ) )
	{
		activity_names = realloc( activity_names, sizeof( char* ) * ++activity_count );

		if( !activity_names )
		{
			fputs( "ERROR: Couldn't allocate memory for activities strings.\n", stderr );
			return false;
		}

		COM_RemoveLineFeed( buf );

		activity_names[activity_count - 1] = strdup( buf );

		if( !activity_names[activity_count - 1] )
		{
			fputs( "ERROR: Couldn't allocate memory for activities strings.\n", stderr );
			return false;
		}
	}

	fclose( fp );

	return true;
}

/*
============
FindActivityName
============
*/
static const char *FindActivityName( int type )
{
	if( type >= 0 && type < activity_count )
		return activity_names[type];

	return NULL;
}

/*
============
GetMotionTypeString
============
*/
static void GetMotionTypeString( int type, char *str, qboolean is_composite )
{
	const char	*p = NULL;

	str[0] = '\0';

	if( is_composite )
	{
		if( type & STUDIO_X )
			Q_strcat( str, " X" );

		if( type & STUDIO_Y )
			Q_strcat( str, " Y" );

		if( type & STUDIO_Z )
			Q_strcat( str, " Z" );

		if( type & STUDIO_XR )
			Q_strcat( str, " XR" );

		if( type & STUDIO_YR )
			Q_strcat( str, " YR" );

		if( type & STUDIO_ZR )
			Q_strcat( str, " ZR" );

		if( type & STUDIO_LX )
			Q_strcat( str, " LX" );

		if( type & STUDIO_LY )
			Q_strcat( str, " LY" );

		if( type & STUDIO_LZ )
			Q_strcat( str, " LZ" );

		if( type & STUDIO_AX )
			Q_strcat( str, " AX" );

		if( type & STUDIO_AY )
			Q_strcat( str, " AY" );

		if( type & STUDIO_AZ )
			Q_strcat( str, " AZ" );

		if( type & STUDIO_AXR )
			Q_strcat( str, " AXR" );

		if( type & STUDIO_AYR )
			Q_strcat( str, " AYR" );

		if( type & STUDIO_AZR )
			Q_strcat( str, " AZR" );

		return;
	}

	type &= STUDIO_TYPES;

	switch( type )
	{
	case STUDIO_X:   p = "X";   break;
	case STUDIO_Y:   p = "Y";   break;
	case STUDIO_Z:   p = "Z";   break;
	case STUDIO_XR:  p = "XR";  break;
	case STUDIO_YR:  p = "YR";  break;
	case STUDIO_ZR:  p = "ZR";  break;
	case STUDIO_LX:  p = "LX";  break;
	case STUDIO_LY:  p = "LY";  break;
	case STUDIO_LZ:  p = "LZ";  break;
	case STUDIO_AX:  p = "AX";  break;
	case STUDIO_AY:  p = "AY";  break;
	case STUDIO_AZ:  p = "AZ";  break;
	case STUDIO_AXR: p = "AXR"; break;
	case STUDIO_AYR: p = "AYR"; break;
	case STUDIO_AZR: p = "AZR"; break;
	default: break;
	}

	if( p )
		Q_strcpy( str, p );
}

/*
============
WriteTextureRenderMode
============
*/
static void WriteTextureRenderMode( FILE *fp )
{
	int		  i;
	mstudiotexture_t *texture;

	for( i = 0; i < texture_hdr->numtextures; i++ )
	{
		texture = (mstudiotexture_t *)( (byte *)texture_hdr + texture_hdr->textureindex ) + i;

		if( texture->flags & STUDIO_NF_FLATSHADE )
			fprintf( fp,"$texrendermode \"%s\" \"flatshade\" \n", texture->name ); // sven-coop extension

		if( texture->flags & STUDIO_NF_CHROME )
			fprintf( fp, "$texrendermode \"%s\" \"chrome\" \n", texture->name ); // sven-coop extension/may be added in HLMV

		if( texture->flags & STUDIO_NF_FULLBRIGHT )
			fprintf( fp, "$texrendermode \"%s\" \"fullbright\" \n", texture->name ); // sven-coop extension/xash3d extension

		if( texture->flags & STUDIO_NF_NOMIPS )
			fprintf( fp, "$texrendermode \"%s\" \"nomips\" \n", texture->name ); // sven-coop extension

		if( texture->flags & STUDIO_NF_NOSMOOTH )
		{
			fprintf( fp, "$texrendermode \"%s\" \"alpha\" \n", texture->name ); // sven-coop extension
			fprintf( fp, "$texrendermode \"%s\" \"nosmooth\" \n", texture->name ); // xash3d extension
		}

		if( texture->flags & STUDIO_NF_ADDITIVE )
			fprintf( fp, "$texrendermode \"%s\" \"additive\" \n", texture->name );

		if( texture->flags & STUDIO_NF_MASKED )
			fprintf( fp, "$texrendermode \"%s\" \"masked\" \n", texture->name );

		if( texture->flags & ( STUDIO_NF_MASKED | STUDIO_NF_SOLID ) )
			fprintf( fp, "$texrendermode \"%s\" \"masked_solid\" \n", texture->name ); // xash3d extension

		if( texture->flags & STUDIO_NF_TWOSIDE )
			fprintf( fp, "$texrendermode \"%s\" \"twoside\" \n", texture->name );
	}
}

/*
============
WriteSkinFamilyInfo
============
*/
static void WriteSkinFamilyInfo( FILE *fp )
{
	int			 i, j, k;
	short			*skinref, index;
	mstudiotexture_t	*texture;

	if( texture_hdr->numskinfamilies < 2 )
		return;

	fprintf( fp, "\n// %i skin families\n", texture_hdr->numskinfamilies );

	fputs( "$texturegroup skinfamilies \n{\n", fp );

	skinref = (short *)( (byte *)texture_hdr + texture_hdr->skinindex );

	for( i = 0; i < texture_hdr->numskinfamilies; ++i )
	{
		fputs( "{", fp );

		for( j = 0; j < texture_hdr->numskinref; ++j )
		{
			index = *( skinref + i * texture_hdr->numskinref + j );

			for( k = 0; k < texture_hdr->numskinfamilies; ++k )
			{
				if( index == *( skinref + k * texture_hdr->numskinref + j ) )
					continue;

				texture = (mstudiotexture_t *)( (byte *)texture_hdr + texture_hdr->textureindex ) + index;

				fprintf( fp, " \"%s\" ", texture->name );
				break;
			}
		}

		fputs( "}\n", fp );
	}

	fputs( "}\n", fp );
}

/*
============
WriteAttachmentInfo
============
*/
static void WriteAttachmentInfo( FILE *fp )
{
	int			 i;
	mstudioattachment_t	*attachment;
	mstudiobone_t		*bone;

	if( !model_hdr->numattachments )
		return;

	fprintf( fp, "\n// %i attachment(s)\n", model_hdr->numattachments );

	for( i = 0; i < model_hdr->numattachments; ++i )
	{
		attachment = (mstudioattachment_t *)( (byte *)model_hdr + model_hdr->attachmentindex ) + i;
		bone = (mstudiobone_t *)( (byte *)model_hdr + model_hdr->boneindex ) + attachment->bone;

		fprintf( fp, "$attachment %i \"%s\" %f %f %f\n", i, bone->name, attachment->org[0], attachment->org[1], attachment->org[2] );
	}
}

/*
============
WriteBodyGroupInfo
============
*/
static void WriteBodyGroupInfo( FILE *fp )
{
	int			 i, j;
	mstudiobodyparts_t	*bodypart;
	mstudiomodel_t		*model;
	char			 modelname[64];

	fputs( "\n// reference mesh(es)\n", fp );

	for( i = 0; i < model_hdr->numbodyparts; ++i )
	{
		bodypart = (mstudiobodyparts_t *) ( (byte *)model_hdr + model_hdr->bodypartindex ) + i;

		if( bodypart->nummodels == 1 )
		{
			model = (mstudiomodel_t *)( (byte *)model_hdr + bodypart->modelindex );

			COM_FileBase( model->name, modelname );

			fprintf( fp, "$body \"%s\" \"%s\"\n\n", bodypart->name, model->name );
			continue;
		}

		fprintf( fp, "$bodygroup \"%s\"\n", bodypart->name );

		fputs( "{\n", fp );

		for( j = 0; j < bodypart->nummodels; ++j )
		{
			model = (mstudiomodel_t *)( (byte *)model_hdr + bodypart->modelindex ) + j;

			if( !Q_strncmp( model->name, "blank", 5 ) )
			{
				fputs( "blank\n", fp );
				continue;
			}

			COM_FileBase( model->name, modelname );

			fprintf( fp, "studio \"%s\"\n", modelname );
		}

		fputs( "}\n\n" , fp );
	}
}

/*
============
WriteControllerInfo
============
*/
static void WriteControllerInfo( FILE *fp )
{
	int			 i;
	mstudiobonecontroller_t	*bonecontroller;
	mstudiobone_t		*bone;
	char			 motion_types[64];

	if( !model_hdr->numbonecontrollers )
		return;

	fprintf( fp, "\n// %i bone controller(s)\n", model_hdr->numbonecontrollers );

	for( i = 0; i < model_hdr->numbonecontrollers; ++i )
	{
		bonecontroller = (mstudiobonecontroller_t *)( (byte *)model_hdr + model_hdr->bonecontrollerindex ) + i;
		bone = (mstudiobone_t *)( (byte *)model_hdr + model_hdr->boneindex ) + bonecontroller->bone;

		GetMotionTypeString( bonecontroller->type & ~STUDIO_RLOOP, motion_types, false );

		fprintf( fp, "$controller %i \"%s\" %s %f %f\n",
		    bonecontroller->index, bone->name, motion_types,
		    bonecontroller->start, bonecontroller->end );
	}
}

/*
============
WriteHitBoxInfo
============
*/
static void WriteHitBoxInfo( FILE *fp )
{
	int		 i;
	mstudiobbox_t	*hitbox;
	mstudiobone_t	*bone;

	if( !model_hdr->numhitboxes )
		return;

	fprintf( fp, "\n// %i hit box(es)\n", model_hdr->numhitboxes );

	for( i = 0; i < model_hdr->numhitboxes; i++ )
	{
		hitbox = (mstudiobbox_t *)( (byte *)model_hdr + model_hdr->hitboxindex ) + i;
		bone = (mstudiobone_t *)( (byte *)model_hdr + model_hdr->boneindex ) + hitbox->bone;

		fprintf( fp, "$hbox %i \"%s\" %f %f %f %f %f %f\n",
		    hitbox->group, bone->name,
		    hitbox->bbmin[0], hitbox->bbmin[1], hitbox->bbmin[2],
		    hitbox->bbmax[0], hitbox->bbmax[1], hitbox->bbmax[2] );
	}
}

/*
============
WriteSequenceInfo
============
*/
static void WriteSequenceInfo( FILE *fp )
{
	int			 i, j;
	const char		*activity;
	char			 motion_types[256];
	mstudioevent_t		*event;
	mstudioseqdesc_t	*seqdesc;

	if( model_hdr->numseqgroups > 1 )
		fputs( "\n$sequencegroupsize 64\n", fp );

	if( model_hdr->numseq > 0 )
		fprintf( fp, "\n// %i animation sequence(s)\n", model_hdr->numseq );

	for( i = 0; i < model_hdr->numseq; ++i )
	{
		seqdesc = (mstudioseqdesc_t *)( (byte *)model_hdr + model_hdr->seqindex ) + i;

		fprintf( fp, "$sequence \"%s\" ", seqdesc->label );

		if( seqdesc->numblends > 1 )
		{
			if( seqdesc->numblends > 2 )
			{
				fputs( "{\n", fp );

				for( j = 0; j < seqdesc->numblends; j++ )
				{
					fputs( "          ", fp );

					fprintf( fp, "\"%s_blend%i\" ", seqdesc->label, j + 1 );

					fputs( "\n", fp );
				}

				fputs( "          ", fp );
			}
			else
			{
				fprintf( fp, "\"%s_blend1\" ", seqdesc->label );
				fprintf( fp, "\"%s_blend2\" ", seqdesc->label );
			}

			GetMotionTypeString( seqdesc->blendtype[0], motion_types, false );

			fprintf( fp, "blend %s %.0f %.0f",
			    motion_types, seqdesc->blendstart[0], seqdesc->blendend[0] );
		}
		else
		{
			fprintf( fp, "\"%s\"", seqdesc->label );
		}

		if( seqdesc->motiontype )
		{
			GetMotionTypeString( seqdesc->motiontype, motion_types, true );

			fprintf( fp, "%s", motion_types );
		}

		fprintf( fp, " fps %.0f ", seqdesc->fps );

		if( seqdesc->flags == 1 )
			fputs( "loop ", fp );

		if( seqdesc->activity )
		{
			activity = FindActivityName( seqdesc->activity );

			if( activity )
			{
				fprintf( fp, "%s %i ", activity, seqdesc->actweight );
			}
			else
			{
				printf( "WARNING: Sequence %s has a custom activity flag (ACT_%i %i).\n",
				    seqdesc->label, seqdesc->activity, seqdesc->actweight );

				fprintf( fp, "ACT_%i %i ", seqdesc->activity, seqdesc->actweight );
			}
		}

		if( seqdesc->entrynode && seqdesc->exitnode )
		{
			if( seqdesc->entrynode == seqdesc->exitnode )
				fprintf( fp, "node %i ", seqdesc->entrynode );
			else if( seqdesc->nodeflags )
				fprintf( fp, "rtransition %i %i ", seqdesc->entrynode, seqdesc->exitnode );
			else
				fprintf( fp, "transition %i %i ", seqdesc->entrynode, seqdesc->exitnode );
		}

		if( seqdesc->numevents > 2 )
		{
			fputs( "{\n ", fp );

			for( j = 0; j < seqdesc->numevents; j++ )
			{
				if( seqdesc->numblends <= 2 )
					fputs( " ", fp );
				else
					fputs( "          ", fp );

				event = (mstudioevent_t *)( (byte *)model_hdr + seqdesc->eventindex ) + j;

				fprintf( fp, "{ event %i %i", event->event, event->frame );

				if( event->options[0] != '\0' )
					fprintf( fp, " \"%s\"", event->options );

				fputs( " }\n ", fp );
			}

			fputs( "}", fp );
		}
		else
		{
			for( j = 0; j < seqdesc->numevents; j++ )
			{
				event = (mstudioevent_t *)( (byte *)model_hdr + seqdesc->eventindex ) + j;

				fprintf( fp, "{ event %i %i", event->event, event->frame );

				if( event->options[0] != '\0')
					fprintf( fp, " \"%s\"", event->options );

				fputs( " } ", fp );
			}
		}

		fputs( "\n", fp );

		if( seqdesc->numblends > 2 )
			fputs( "}\n", fp );

		if( seqdesc->numpivots )
			printf( "WARNING: Sequence %s uses %i foot pivots, feature not supported.\n",
			    seqdesc->label, seqdesc->numpivots );
	}
}

/*
============
WriteQCScript
============
*/
void WriteQCScript( void )
{
	FILE	*fp;
	char	 filename[MAX_SYSPATH];
	size_t	 len;

	len = Q_snprintf( filename, MAX_SYSPATH, "%s%s.qc", destdir, modelfile );

	if( len >= MAX_SYSPATH )
	{
		fprintf( stderr, "ERROR: Destination path is too long. Can't write %s.qc\n", modelfile );
		return;
	}

	fp = fopen( filename, "w" );

	if( !fp )
	{
		fprintf( stderr, "ERROR: Can't write %s\n", filename );
		return;
	}

	fputs( "/*\n", fp );
	fputs( "==============================================================================\n\n", fp );
	fputs( "QC script generated by Half-Life Studio Model Decompiler " APP_VERSION "\n", fp );

	fprintf( fp, "Copyright Flying With Gauss %s (c) \n\n", Q_timestamp( TIME_YEAR_ONLY ) );
	fprintf( fp, "%s.mdl\n\n", modelfile );

	fputs( "Original internal name:\n", fp );

	fprintf( fp, "\"%s\"\n\n", model_hdr->name );

	fputs( "==============================================================================\n", fp );
	fputs( "*/\n\n", fp );

	fprintf( fp, "$modelname \"%s.mdl\"\n", modelfile );

	fputs( "$cd \".\\\"\n", fp );
	fputs( "$cdtexture \".\\\"\n", fp );
	fputs( "$scale 1.0\n", fp );
	fputs( "$cliptotextures\n", fp );
	fputs( "\n", fp );

	if( !model_hdr->numtextures )
		fputs( "$externaltextures\n", fp );

	if( model_hdr->flags != 0 )
	{
		fprintf( fp, "$flags %i\n", model_hdr->flags );

		printf( "WARNING: This model uses the $flags keyword set to %i\n", model_hdr->flags );
	}

	fputs( "\n", fp );

	fprintf( fp, "$bbox %f %f %f", model_hdr->min[0], model_hdr->min[1], model_hdr->min[2] );
	fprintf( fp, " %f %f %f\n", model_hdr->max[0], model_hdr->max[1], model_hdr->max[2] );
	fprintf( fp, "$cbox %f %f %f", model_hdr->bbmin[0], model_hdr->bbmin[1], model_hdr->bbmin[2] );
	fprintf( fp, " %f %f %f\n", model_hdr->bbmax[0], model_hdr->bbmax[1], model_hdr->bbmax[2] );
	fprintf( fp, "$eyeposition %f %f %f\n", model_hdr->eyeposition[0], model_hdr->eyeposition[1], model_hdr->eyeposition[2] );

	fputs( "\n", fp );

	WriteBodyGroupInfo( fp );
	WriteTextureRenderMode( fp );
	WriteSkinFamilyInfo( fp );
	WriteAttachmentInfo( fp );
	WriteControllerInfo( fp );
	WriteHitBoxInfo( fp );
	WriteSequenceInfo( fp );

	fputs( "\n// End of QC script.\n", fp );
	fclose( fp );

	printf( "QC Script: %s\n", filename );
}