quakeforge/nq/source/cl_demo.c

579 lines
13 KiB
C
Raw Normal View History

/*
cl_demo.c
demo playback support
Copyright (C) 1996-1997 Id Software, Inc.
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:
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
2010-12-13 23:58:38 +00:00
static __attribute__ ((used)) const char rcsid[] = "$Id$";
#ifdef HAVE_STRING_H
# include <string.h>
#endif
#ifdef HAVE_STRINGS_H
# include <strings.h>
#endif
#include "QF/cmd.h"
#include "QF/cvar.h"
2010-08-24 07:20:07 +00:00
#include "QF/dstring.h"
#include "QF/keys.h"
#include "QF/msg.h"
#include "QF/qendian.h"
#include "QF/sys.h"
#include "QF/va.h"
#include "client.h"
#include "compat.h"
#include "host.h"
2010-12-13 23:58:38 +00:00
typedef struct {
int frames;
double time;
double fps;
} td_stats_t;
int demo_timeframes_isactive;
int demo_timeframes_index;
2001-10-10 23:16:18 +00:00
char demoname[1024];
double *demo_timeframes_array;
#define CL_TIMEFRAMES_ARRAYBLOCK 4096
2010-12-13 23:58:38 +00:00
2001-10-10 23:16:18 +00:00
int timedemo_count;
2010-12-13 23:58:38 +00:00
int timedemo_runs;
td_stats_t *timedemo_data;
2001-10-10 23:16:18 +00:00
static void CL_FinishTimeDemo (void);
static void CL_TimeFrames_DumpLog (void);
static void CL_TimeFrames_AddTimestamp (void);
static void CL_TimeFrames_Reset (void);
cvar_t *demo_gzip;
cvar_t *demo_speed;
2010-12-13 23:58:38 +00:00
cvar_t *demo_quit;
cvar_t *demo_timeframes;
#define MAX_DEMMSG (MAX_MSGLEN)
/*
DEMO CODE
When a demo is playing back, all NET_SendMessages are skipped, and
NET_GetMessages are read from the demo file.
Whenever cl.time gets past the last received message, another message is
read from the demo file.
*/
2001-05-14 03:08:24 +00:00
/*
CL_WriteDemoMessage
Dumps the current net message, prefixed by the length and view angles
*/
static void
CL_WriteDemoMessage (sizebuf_t *msg)
{
float f;
int len;
int i;
len = LittleLong (msg->cursize);
Qwrite (cls.demofile, &len, 4);
for (i = 0; i < 3; i++) {
f = LittleFloat (cl.viewangles[i]);
Qwrite (cls.demofile, &f, 4);
}
Qwrite (cls.demofile, msg->data, msg->cursize);
Qflush (cls.demofile);
}
/*
2001-05-14 03:08:24 +00:00
CL_StopPlayback
2001-05-14 03:08:24 +00:00
Called when a demo file runs out, or the user starts a game
*/
void
CL_StopPlayback (void)
{
if (!cls.demoplayback)
return;
Qclose (cls.demofile);
cls.demofile = NULL;
2001-08-20 17:48:16 +00:00
CL_SetState (ca_disconnected);
cls.demoplayback = 0;
key_game_target = IMT_0;
Key_SetKeyDest (key_game);
if (cls.timedemo)
CL_FinishTimeDemo ();
}
void
CL_StopRecording (void)
{
// write a disconnect message to the demo file
SZ_Clear (net_message->message);
MSG_WriteByte (net_message->message, svc_disconnect);
CL_WriteDemoMessage (net_message->message);
// finish up
Qclose (cls.demofile);
cls.demofile = NULL;
cls.demorecording = false;
Sys_Printf ("Completed demo\n");
}
static int
CL_GetDemoMessage (void)
{
int i, r;
float f;
// decide if it is time to grab the next message
if (cls.signon == SIGNONS) { // always grab until fully connected
if (cls.timedemo) {
if (host_framecount == cls.td_lastframe)
return 0; // already read this frame's message
cls.td_lastframe = host_framecount;
// if this is the second frame, grab the real td_starttime
// so the bogus time on the first frame doesn't count
if (host_framecount == cls.td_startframe + 1)
cls.td_starttime = realtime;
} else if ( /* cl.time > 0 && */ cl.time <= cl.mtime[0]) {
return 0; // don't need another message yet
}
}
// get the next message
Qread (cls.demofile, &net_message->message->cursize, 4);
net_message->message->cursize =
LittleLong (net_message->message->cursize);
if (net_message->message->cursize > MAX_DEMMSG)
Host_Error ("Demo message > MAX_DEMMSG: %d/%d",
net_message->message->cursize, MAX_DEMMSG);
VectorCopy (cl.mviewangles[0], cl.mviewangles[1]);
for (i = 0; i < 3; i++) {
r = Qread (cls.demofile, &f, 4);
cl.mviewangles[0][i] = LittleFloat (f);
}
r = Qread (cls.demofile, net_message->message->data,
net_message->message->cursize);
if (r != net_message->message->cursize) {
CL_StopPlayback ();
return 0;
}
return 1;
}
static int
CL_GetPacket (void)
{
int r;
while (1) {
r = NET_GetMessage (cls.netcon);
if (r != 1 && r != 2)
return r;
// discard nop keepalive message
if (net_message->message->cursize == 1
&& net_message->message->data[0] == svc_nop)
Sys_Printf ("<-- server to client keepalive\n");
else
break;
}
return r;
}
/*
CL_GetMessage
Handles recording and playback of demos, on top of NET_ code
*/
int
CL_GetMessage (void)
{
if (cls.demoplayback) {
int ret = CL_GetDemoMessage ();
if (!ret && demo_timeframes_isactive && cls.td_starttime) {
CL_TimeFrames_AddTimestamp ();
}
return ret;
}
if (!CL_GetPacket ())
return 0;
if (cls.demorecording)
CL_WriteDemoMessage (net_message->message);
return 1;
}
/*
2001-05-14 03:08:24 +00:00
CL_Stop_f
2001-05-14 03:08:24 +00:00
stop recording a demo
*/
static void
CL_Stop_f (void)
{
if (cmd_source != src_command)
return;
if (!cls.demorecording) {
Sys_Printf ("Not recording a demo.\n");
return;
}
CL_StopRecording ();
}
/*
2001-05-14 03:08:24 +00:00
CL_Record_f
2001-05-14 03:08:24 +00:00
record <demoname> <map> [cd track]
*/
static void
CL_Record_f (void)
{
int c;
int track;
if (cmd_source != src_command)
return;
c = Cmd_Argc ();
if (c != 2 && c != 3 && c != 4) {
Sys_Printf ("record <demoname> [<map> [cd track]]\n");
return;
}
if (strstr (Cmd_Argv (1), "..")) {
Sys_Printf ("Relative pathnames are not allowed.\n");
return;
}
if (c == 2 && cls.state == ca_connected) {
Sys_Printf
("Can not record - already connected to server\nClient demo recording must be started before connecting\n");
return;
}
// write the forced cd track number, or -1
if (c == 4) {
track = atoi (Cmd_Argv (3));
Sys_Printf ("Forcing CD track to %i\n", cls.forcetrack);
} else
track = -1;
// start the map up
//
if (c > 2)
Cmd_ExecuteString (va ("map %s", Cmd_Argv (2)), src_command);
CL_Record (Cmd_Argv (1), track);
}
void
CL_Record (const char *argv1, int track)
{
dstring_t *name;
name = dstring_new ();
dsprintf (name, "%s/%s", qfs_gamedir->dir.def, argv1);
// open the demo file
#ifdef HAVE_ZLIB
if (demo_gzip->int_val) {
QFS_DefaultExtension (name, ".dem.gz");
2010-08-24 07:20:07 +00:00
cls.demofile = QFS_WOpen (name->str, demo_gzip->int_val);
} else
#endif
{
QFS_DefaultExtension (name, ".dem");
2010-08-24 07:20:07 +00:00
cls.demofile = QFS_WOpen (name->str, 0);
}
if (!cls.demofile) {
Sys_Printf ("ERROR: couldn't open.\n");
2010-08-24 07:20:07 +00:00
} else {
Sys_Printf ("recording to %s.\n", name->str);
cls.demorecording = true;
2010-08-24 07:20:07 +00:00
cls.forcetrack = track;
Qprintf (cls.demofile, "%i\n", cls.forcetrack);
}
dstring_delete (name);
}
static void
2001-10-10 23:16:18 +00:00
CL_StartDemo (void)
{
2010-08-24 07:20:07 +00:00
dstring_t *name;
int c;
qboolean neg = false;
// disconnect from server
CL_Disconnect ();
// open the demo file
2010-08-24 07:20:07 +00:00
name = dstring_strdup (demoname);
QFS_DefaultExtension (name, ".dem");
2010-08-24 07:20:07 +00:00
Sys_Printf ("Playing demo from %s.\n", name->str);
QFS_FOpenFile (name->str, &cls.demofile);
if (!cls.demofile) {
Sys_Printf ("ERROR: couldn't open.\n");
cls.demonum = -1; // stop demo loop
dstring_delete (name);
return;
}
cls.demoplayback = true;
2001-08-20 17:48:16 +00:00
CL_SetState (ca_connected);
cls.forcetrack = 0;
key_game_target = IMT_DEMO;
Key_SetKeyDest (key_game);
while ((c = Qgetc (cls.demofile)) != '\n')
if (c == '-')
neg = true;
else
cls.forcetrack = cls.forcetrack * 10 + (c - '0');
if (neg)
cls.forcetrack = -cls.forcetrack;
dstring_delete (name);
}
2010-08-24 07:20:07 +00:00
2001-10-10 23:16:18 +00:00
/*
CL_PlayDemo_f
2001-10-10 23:16:18 +00:00
play [demoname]
*/
static void
2001-10-10 23:16:18 +00:00
CL_PlayDemo_f (void)
{
if (cmd_source != src_command)
return;
if (Cmd_Argc () != 2) {
Sys_Printf ("play <demoname> : plays a demo\n");
2001-10-10 23:16:18 +00:00
return;
}
timedemo_runs = timedemo_count = 1; // make sure looped timedemos stop
2001-10-10 23:16:18 +00:00
strncpy (demoname, Cmd_Argv (1), sizeof (demoname));
CL_StartDemo ();
}
static void
2001-10-10 23:16:18 +00:00
CL_StartTimeDemo (void)
{
CL_StartDemo ();
// cls.td_starttime will be grabbed at the second frame of the demo, so
// all the loading time doesn't get counted
cls.timedemo = true;
2010-12-13 23:58:38 +00:00
cls.td_starttime = 0;
2001-10-10 23:16:18 +00:00
cls.td_startframe = host_framecount;
cls.td_lastframe = -1; // get a new message this frame
CL_TimeFrames_Reset ();
if (demo_timeframes->int_val)
demo_timeframes_isactive = 1;
2001-10-10 23:16:18 +00:00
}
2010-12-13 23:58:38 +00:00
static inline double
sqr (double x)
{
return x * x;
}
static void
CL_FinishTimeDemo (void)
{
int frames;
float time;
cls.timedemo = false;
2001-05-14 03:08:24 +00:00
// the first frame didn't count
frames = (host_framecount - cls.td_startframe) - 1;
time = realtime - cls.td_starttime;
if (!time)
time = 1;
Sys_Printf ("%i frame%s %.4g seconds %.4g fps\n", frames,
frames == 1 ? "" : "s", time, frames / time);
2010-12-13 23:58:38 +00:00
CL_TimeFrames_DumpLog ();
demo_timeframes_isactive = 0;
2010-12-13 23:58:38 +00:00
timedemo_count--;
if (timedemo_data) {
timedemo_data[timedemo_count].frames = frames;
timedemo_data[timedemo_count].time = time;
timedemo_data[timedemo_count].fps = frames / time;
}
2010-12-13 23:58:38 +00:00
if (timedemo_count > 0) {
2001-10-10 23:16:18 +00:00
CL_StartTimeDemo ();
2010-12-13 23:58:38 +00:00
} else {
if (--timedemo_runs > 0 && timedemo_data) {
2010-12-13 23:58:38 +00:00
double average = 0;
double variance = 0;
double min, max;
int i;
min = max = timedemo_data[0].fps;
for (i = 0; i < timedemo_runs; i++) {
average += timedemo_data[i].fps;
min = min (min, timedemo_data[i].fps);
max = max (max, timedemo_data[i].fps);
}
average /= timedemo_runs;
for (i = 0; i < timedemo_runs; i++)
variance += sqr (timedemo_data[i].fps - average);
variance /= timedemo_runs;
Sys_Printf ("timedemo stats for %d runs:\n", timedemo_runs);
Sys_Printf (" average fps: %.3f\n", average);
Sys_Printf (" min/max fps: %.3f/%.3f\n", min, max);
Sys_Printf ("std deviation: %.3f fps\n", sqrt (variance));
}
if (demo_quit->int_val)
Cbuf_InsertText (host_cbuf, "quit\n");
}
}
/*
2001-05-14 03:08:24 +00:00
CL_TimeDemo_f
2001-05-14 03:08:24 +00:00
timedemo [demoname]
*/
static void
CL_TimeDemo_f (void)
{
int count = 1;
if (cmd_source != src_command)
return;
2001-10-10 23:16:18 +00:00
if (Cmd_Argc () < 2 || Cmd_Argc () > 3) {
Sys_Printf ("timedemo <demoname> [count]: gets demo speeds\n");
return;
}
timedemo_runs = timedemo_count = 1; // make sure looped timedemos stop
2010-12-13 23:58:38 +00:00
if (Cmd_Argc () == 3)
count = atoi (Cmd_Argv (2));
if (timedemo_data) {
2010-12-13 23:58:38 +00:00
free (timedemo_data);
timedemo_data = 0;
}
timedemo_data = calloc (timedemo_runs, sizeof (td_stats_t));
2001-10-10 23:16:18 +00:00
strncpy (demoname, Cmd_Argv (1), sizeof (demoname));
CL_StartTimeDemo ();
timedemo_runs = timedemo_count = max (count, 1);
timedemo_data = calloc (timedemo_runs, sizeof (td_stats_t));
}
void
CL_Demo_Init (void)
{
demo_timeframes_isactive = 0;
demo_timeframes_index = 0;
demo_timeframes_array = NULL;
demo_gzip = Cvar_Get ("demo_gzip", "0", CVAR_ARCHIVE, NULL,
"Compress demos using gzip. 0 = none, 1 = least "
"compression, 9 = most compression. Compressed "
" demos (1-9) will have .gz appended to the name");
demo_speed = Cvar_Get ("demo_speed", "1.0", CVAR_NONE, NULL,
"adjust demo playback speed. 1.0 = normal, "
"< 1 slow-mo, > 1 timelapse");
2010-12-13 23:58:38 +00:00
demo_quit = Cvar_Get ("demo_quit", "0", CVAR_NONE, NULL,
"automaticly quit after a timedemo has finished");
demo_timeframes = Cvar_Get ("demo_timeframes", "0", CVAR_NONE, NULL,
"write timestamps for every frame");
Cmd_AddCommand ("record", CL_Record_f, "Record a demo, if no filename "
"argument is given\n"
"the demo will be called Year-Month-Day-Hour-Minute-"
"Mapname");
Cmd_AddCommand ("stop", CL_Stop_f, "Stop recording a demo");
Cmd_AddCommand ("playdemo", CL_PlayDemo_f, "Play a recorded demo");
Cmd_AddCommand ("timedemo", CL_TimeDemo_f, "Play a demo as fast as your "
"hardware can. Useful for benchmarking.");
}
static void
CL_TimeFrames_Reset (void)
{
demo_timeframes_index = 0;
free (demo_timeframes_array);
demo_timeframes_array = NULL;
}
static void
CL_TimeFrames_AddTimestamp (void)
{
if (!(demo_timeframes_index % CL_TIMEFRAMES_ARRAYBLOCK))
demo_timeframes_array = realloc
(demo_timeframes_array, sizeof (demo_timeframes_array[0]) *
((demo_timeframes_index / CL_TIMEFRAMES_ARRAYBLOCK) + 1) *
CL_TIMEFRAMES_ARRAYBLOCK);
if (demo_timeframes_array == NULL)
Sys_Error ("Unable to allocate timeframes buffer");
demo_timeframes_array[demo_timeframes_index] = Sys_DoubleTime ();
demo_timeframes_index++;
}
static void
CL_TimeFrames_DumpLog (void)
{
const char *filename = "timeframes.txt";
int i;
long frame;
QFile *outputfile;
if (demo_timeframes_isactive == 0)
return;
Sys_Printf ("Dumping Timed Frames log: %s\n", filename);
outputfile = QFS_Open (filename, "w");
if (!outputfile) {
Sys_Printf ("Could not open: %s\n", filename);
return;
}
for (i = 1; i < demo_timeframes_index; i++) {
frame = (demo_timeframes_array[i] - demo_timeframes_array[i - 1]) * 1e6;
Qprintf (outputfile, "%09ld\n", frame);
}
Qclose (outputfile);
}