timedemo now also prints min/avg/max fps
[divverent/darkplaces.git] / client.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // client.h
21
22 #ifndef CLIENT_H
23 #define CLIENT_H
24
25 #include "matrixlib.h"
26
27 // LordHavoc: 256 dynamic lights
28 #define MAX_DLIGHTS 256
29 // LordHavoc: this affects the lighting scale of the whole game
30 #define LIGHTOFFSET 1024.0f
31 // max lights shining on one entity
32 #define MAXENTLIGHTS 128
33
34 extern int cl_max_entities;
35 extern int cl_max_static_entities;
36 extern int cl_max_temp_entities;
37 extern int cl_max_effects;
38 extern int cl_max_beams;
39
40 typedef struct effect_s
41 {
42         int active;
43         vec3_t origin;
44         float starttime;
45         float framerate;
46         int modelindex;
47         int startframe;
48         int endframe;
49         // these are for interpolation
50         int frame;
51         double frame1time;
52         double frame2time;
53 }
54 cl_effect_t;
55
56 typedef struct
57 {
58         int             entity;
59         // draw this as lightning polygons, or a model?
60         int             lightning;
61         struct model_s  *model;
62         float   endtime;
63         vec3_t  start, end;
64         // if this beam is owned by an entity, this is the beam start relative to
65         // that entity's matrix for per frame start updates
66         vec3_t  relativestart;
67         vec3_t  relativeend;
68         // indicates whether relativestart is valid
69         int     relativestartvalid;
70 }
71 beam_t;
72
73 typedef struct
74 {
75         // location
76         vec3_t  origin;
77         // stop lighting after this time
78         vec_t   die;
79         // color of light
80         vec3_t  color;
81         // brightness (not really radius anymore)
82         vec_t   radius;
83         // drop this each second
84         vec_t   decay;
85         // the entity that owns this light (can be NULL)
86         struct entity_render_s *ent;
87         // orientation/scaling/location
88         matrix4x4_t matrix;
89         // cubemap number to use on this light
90         int cubemapnum;
91         // light style which controls intensity of this light
92         int style;
93         // cast shadows
94         int shadow;
95         // corona intensity
96         vec_t corona;
97 }
98 dlight_t;
99
100 typedef struct frameblend_s
101 {
102         int frame;
103         float lerp;
104 }
105 frameblend_t;
106
107 // LordHavoc: this struct is intended for the renderer but some fields are
108 // used by the client.
109 typedef struct entity_render_s
110 {
111         // location
112         vec3_t origin;
113         // orientation
114         vec3_t angles;
115         // transform matrix for model to world
116         matrix4x4_t matrix;
117         // transform matrix for world to model
118         matrix4x4_t inversematrix;
119         // opacity (alpha) of the model
120         float alpha;
121         // size the model is shown
122         float scale;
123
124         // NULL = no model
125         model_t *model;
126         // current uninterpolated animation frame (for things which do not use interpolation)
127         int frame;
128         // entity shirt and pants colors
129         int colormap;
130         // light, particles, etc
131         int effects;
132         // for Alias models
133         int skinnum;
134         // render flags
135         int flags;
136
137         // interpolated animation
138
139         // frame that the model is interpolating from
140         int frame1;
141         // frame that the model is interpolating to
142         int frame2;
143         // interpolation factor, usually computed from frame2time
144         float framelerp;
145         // time frame1 began playing (for framegroup animations)
146         double frame1time;
147         // time frame2 began playing (for framegroup animations)
148         double frame2time;
149
150         // calculated by the renderer (but not persistent)
151
152         // if visframe == r_framecount, it is visible
153         int visframe;
154         // calculated during R_AddModelEntities
155         vec3_t mins, maxs;
156         // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
157         frameblend_t frameblend[4];
158
159         // caching results of static light traces (this is semi-persistent)
160         double entlightstime;
161         vec3_t entlightsorigin;
162         int entlightsframe;
163         int numentlights;
164         unsigned short entlights[MAXENTLIGHTS];
165 }
166 entity_render_t;
167
168 typedef struct entity_persistent_s
169 {
170         int linkframe;
171
172         vec3_t trail_origin;
173
174         // particle trail
175         float trail_time;
176
177         // muzzleflash fading
178         float muzzleflash;
179
180         // interpolated movement
181
182         // start time of move
183         float lerpstarttime;
184         // time difference from start to end of move
185         float lerpdeltatime;
186         // the move itself, start and end
187         float oldorigin[3];
188         float oldangles[3];
189         float neworigin[3];
190         float newangles[3];
191 }
192 entity_persistent_t;
193
194 typedef struct entity_s
195 {
196         // baseline state (default values)
197         entity_state_t state_baseline;
198         // previous state (interpolating from this)
199         entity_state_t state_previous;
200         // current state (interpolating to this)
201         entity_state_t state_current;
202
203         // used for regenerating parts of render
204         entity_persistent_t persistent;
205
206         // the only data the renderer should know about
207         entity_render_t render;
208 }
209 entity_t;
210
211 typedef struct
212 {
213         vec3_t  viewangles;
214
215 // intended velocities
216         float   forwardmove;
217         float   sidemove;
218         float   upmove;
219 } usercmd_t;
220
221 typedef struct
222 {
223         int             length;
224         char    map[MAX_STYLESTRING];
225 } lightstyle_t;
226
227 typedef struct
228 {
229         char    name[MAX_SCOREBOARDNAME];
230         int             frags;
231         int             colors; // two 4 bit fields
232 } scoreboard_t;
233
234 typedef struct
235 {
236         int             destcolor[3];
237         int             percent;                // 0-256
238 } cshift_t;
239
240 #define CSHIFT_CONTENTS 0
241 #define CSHIFT_DAMAGE   1
242 #define CSHIFT_BONUS    2
243 #define CSHIFT_POWERUP  3
244 #define CSHIFT_VCSHIFT  4
245 #define NUM_CSHIFTS             5
246
247 #define NAME_LENGTH     64
248
249
250 //
251 // client_state_t should hold all pieces of the client state
252 //
253
254 #define SIGNONS         4                       // signon messages to receive before connected
255
256 #define MAX_DEMOS               8
257 #define MAX_DEMONAME    16
258
259 typedef enum
260 {
261         ca_dedicated,           // a dedicated server with no ability to start a client
262         ca_disconnected,        // full screen console with no connection
263         ca_connected            // valid netcon, talking to a server
264 }
265 cactive_t;
266
267 //
268 // the client_static_t structure is persistent through an arbitrary number
269 // of server connections
270 //
271 typedef struct
272 {
273         cactive_t state;
274
275 // demo loop control
276         // -1 = don't play demos
277         int demonum;
278         // list of demos in loop
279         char demos[MAX_DEMOS][MAX_DEMONAME];
280
281 // demo recording info must be here, because record is started before
282 // entering a map (and clearing client_state_t)
283         qboolean demorecording;
284         qboolean demoplayback;
285         qboolean timedemo;
286         // -1 = use normal cd track
287         int forcetrack;
288         qfile_t *demofile;
289         // to meter out one message a frame
290         int td_lastframe;
291         // host_framecount at start
292         int td_startframe;
293         // realtime at second frame of timedemo (LordHavoc: changed to double)
294         double td_starttime;
295         // LordHavoc: for measuring maxfps
296         double td_minframetime;
297         // LordHavoc: for measuring minfps
298         double td_maxframetime;
299         // LordHavoc: pausedemo
300         qboolean demopaused;
301
302         qboolean connect_trying;
303         int connect_remainingtries;
304         double connect_nextsendtime;
305         lhnetsocket_t *connect_mysocket;
306         lhnetaddress_t connect_address;
307
308 // connection information
309         // 0 to SIGNONS
310         int signon;
311         // network connection
312         netconn_t *netcon;
313         // writing buffer to send to server
314         sizebuf_t message;
315 }
316 client_static_t;
317
318 extern client_static_t  cls;
319
320 //
321 // the client_state_t structure is wiped completely at every
322 // server signon
323 //
324 typedef struct
325 {
326         // true if playing in a local game and no one else is connected
327         int islocalgame;
328
329         // when connecting to the server throw out the first couple move messages
330         // so the player doesn't accidentally do something the first frame
331         int movemessages;
332
333         // send a clc_nop periodically until connected
334         float sendnoptime;
335
336         // last command sent to the server
337         usercmd_t cmd;
338
339 // information for local display
340         // health, etc
341         int stats[MAX_CL_STATS];
342         // inventory bit flags
343         int items;
344         // cl.time of acquiring item, for blinking
345         float item_gettime[32];
346         // cl.time of changing STAT_ACTIVEWEAPON
347         float weapontime;
348         // use pain anim frame if cl.time < this
349         float faceanimtime;
350
351         // color shifts for damage, powerups
352         cshift_t cshifts[NUM_CSHIFTS];
353         // and content types
354         cshift_t prev_cshifts[NUM_CSHIFTS];
355
356 // the client maintains its own idea of view angles, which are
357 // sent to the server each frame.  The server sets punchangle when
358 // the view is temporarily offset, and an angle reset commands at the start
359 // of each level and after teleporting.
360
361         // during demo playback viewangles is lerped between these
362         vec3_t mviewangles[2];
363         // either client controlled, or lerped from demo mviewangles
364         vec3_t viewangles;
365
366         // update by server, used for lean+bob (0 is newest)
367         vec3_t mvelocity[2];
368         // lerped between mvelocity[0] and [1]
369         vec3_t velocity;
370
371         // temporary offset
372         vec3_t punchangle;
373         // LordHavoc: origin view kick
374         vec3_t punchvector;
375
376 // pitch drifting vars
377         float idealpitch;
378         float pitchvel;
379         qboolean nodrift;
380         float driftmove;
381         double laststop;
382
383         float viewheight;
384         // local amount for smoothing stepups
385         //float crouch;
386
387         // sent by server
388         qboolean paused;
389         qboolean onground;
390         qboolean inwater;
391
392         // don't change view angle, full screen, etc
393         int intermission;
394         // latched at intermission start
395         int completed_time;
396
397         // the timestamp of the last two messages
398         double mtime[2];
399
400         // clients view of time, time should be between mtime[0] and mtime[1] to
401         // generate a lerp point for other data, oldtime is the previous frame's
402         // value of time, frametime is the difference between time and oldtime
403         double time, oldtime, frametime;
404
405         // copy of realtime from last recieved message, for net trouble icon
406         float last_received_message;
407
408 // information that is static for the entire time connected to a server
409         struct model_s *model_precache[MAX_MODELS];
410         struct sfx_s *sound_precache[MAX_SOUNDS];
411
412         // for display on solo scoreboard
413         char levelname[40];
414         // cl_entitites[cl.viewentity] = player
415         int viewentity;
416         // the real player entity (normally same as viewentity,
417         // different than viewentity if mod uses chasecam or other tricks)
418         int playerentity;
419         // max players that can be in this game
420         int maxclients;
421         // type of game (deathmatch, coop, singleplayer)
422         int gametype;
423
424 // refresh related state
425
426         // cl_entitites[0].model
427         struct model_s *worldmodel;
428
429         // the gun model
430         entity_t viewent;
431
432         // cd audio
433         int cdtrack, looptrack;
434
435 // frag scoreboard
436
437         // [cl.maxclients]
438         scoreboard_t *scores;
439
440         // LordHavoc: sniping zoom, QC controlled
441         float viewzoom;
442         // for interpolation
443         float viewzoomold, viewzoomnew;
444
445         // protocol version of the server we're connected to
446         int protocol;
447
448         // entity database stuff
449         entity_database_t entitydatabase;
450         entity_database4_t *entitydatabase4;
451 }
452 client_state_t;
453
454 extern mempool_t *cl_scores_mempool;
455
456 //
457 // cvars
458 //
459 extern cvar_t cl_name;
460 extern cvar_t cl_color;
461 extern cvar_t cl_rate;
462 extern cvar_t cl_pmodel;
463
464 extern cvar_t cl_upspeed;
465 extern cvar_t cl_forwardspeed;
466 extern cvar_t cl_backspeed;
467 extern cvar_t cl_sidespeed;
468
469 extern cvar_t cl_movespeedkey;
470
471 extern cvar_t cl_yawspeed;
472 extern cvar_t cl_pitchspeed;
473
474 extern cvar_t cl_anglespeedkey;
475
476 extern cvar_t cl_autofire;
477
478 extern cvar_t cl_shownet;
479 extern cvar_t cl_nolerp;
480
481 extern cvar_t cl_pitchdriftspeed;
482 extern cvar_t lookspring;
483 extern cvar_t lookstrafe;
484 extern cvar_t sensitivity;
485
486 extern cvar_t freelook;
487
488 extern cvar_t m_pitch;
489 extern cvar_t m_yaw;
490 extern cvar_t m_forward;
491 extern cvar_t m_side;
492
493 extern cvar_t r_draweffects;
494
495 extern cvar_t cl_explosions;
496 extern cvar_t cl_stainmaps;
497
498 // these are updated by CL_ClearState
499 extern int cl_num_entities;
500 extern int cl_num_static_entities;
501 extern int cl_num_temp_entities;
502 extern int cl_num_brushmodel_entities;
503
504 extern entity_t *cl_entities;
505 extern qbyte *cl_entities_active;
506 extern entity_t *cl_static_entities;
507 extern entity_t *cl_temp_entities;
508 extern entity_render_t **cl_brushmodel_entities;
509 extern cl_effect_t *cl_effects;
510 extern beam_t *cl_beams;
511 extern dlight_t *cl_dlights;
512 extern lightstyle_t *cl_lightstyle;
513
514
515 extern client_state_t cl;
516
517 extern void CL_AllocDlight (entity_render_t *ent, matrix4x4_t *matrix, float radius, float red, float green, float blue, float decay, float lifetime, int cubemapnum, int style, int shadowenable, vec_t corona);
518 extern void CL_DecayLights (void);
519
520 //=============================================================================
521
522 //
523 // cl_main
524 //
525
526 void CL_Init (void);
527
528 void CL_EstablishConnection(const char *host);
529
530 void CL_Disconnect (void);
531 void CL_Disconnect_f (void);
532
533 void CL_BoundingBoxForEntity(entity_render_t *ent);
534
535 extern cvar_t cl_beams_polygons;
536 extern cvar_t cl_beams_relative;
537 extern cvar_t cl_beams_lightatend;
538
539 //
540 // cl_input
541 //
542 typedef struct
543 {
544         int             down[2];                // key nums holding it down
545         int             state;                  // low bit is down state
546 }
547 kbutton_t;
548
549 extern  kbutton_t       in_mlook, in_klook;
550 extern  kbutton_t       in_strafe;
551 extern  kbutton_t       in_speed;
552
553 void CL_InitInput (void);
554 void CL_SendCmd (usercmd_t *cmd);
555 void CL_SendMove (usercmd_t *cmd);
556
557 void CL_LerpUpdate(entity_t *e);
558 void CL_ParseTEnt (void);
559 void CL_RelinkBeams (void);
560
561 void CL_ClearTempEntities (void);
562 entity_t *CL_NewTempEntity (void);
563
564 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
565
566 void CL_ClearState (void);
567
568
569 int  CL_ReadFromServer (void);
570 void CL_WriteToServer (usercmd_t *cmd);
571 void CL_BaseMove (usercmd_t *cmd);
572
573
574 float CL_KeyState (kbutton_t *key);
575 const char *Key_KeynumToString (int keynum);
576
577 //
578 // cl_demo.c
579 //
580 void CL_StopPlayback(void);
581 void CL_ReadDemoMessage(void);
582 void CL_WriteDemoMessage(void);
583
584 void CL_NextDemo(void);
585 void CL_Stop_f(void);
586 void CL_Record_f(void);
587 void CL_PlayDemo_f(void);
588 void CL_TimeDemo_f(void);
589
590 //
591 // cl_parse.c
592 //
593 void CL_Parse_Init(void);
594 void CL_ParseServerMessage(void);
595 void CL_Parse_DumpPacket(void);
596
597 //
598 // view
599 //
600 void V_StartPitchDrift (void);
601 void V_StopPitchDrift (void);
602
603 void V_Init (void);
604 float V_CalcRoll (vec3_t angles, vec3_t velocity);
605 void V_UpdateBlends (void);
606 void V_ParseDamage (void);
607
608
609 //
610 // cl_tent
611 //
612 void CL_InitTEnts (void);
613
614 //
615 // cl_part
616 //
617
618 void CL_Particles_Clear(void);
619 void CL_Particles_Init(void);
620
621 void CL_ParseParticleEffect (void);
622 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
623 void CL_RocketTrail (vec3_t start, vec3_t end, int type, entity_t *ent);
624 void CL_RocketTrail2 (vec3_t start, vec3_t end, int color, entity_t *ent);
625 void CL_SparkShower (vec3_t org, vec3_t dir, int count);
626 void CL_PlasmaBurn (vec3_t org);
627 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
628 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
629 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
630 void CL_Flames (vec3_t org, vec3_t vel, int count);
631 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
632 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
633 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
634 void CL_EntityParticles (entity_t *ent);
635 void CL_BlobExplosion (vec3_t org);
636 void CL_ParticleExplosion (vec3_t org);
637 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
638 void CL_LavaSplash (vec3_t org);
639 void CL_TeleportSplash (vec3_t org);
640 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
641 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
642 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
643 void CL_MoveParticles(void);
644 void R_MoveExplosions(void);
645 void R_NewExplosion(vec3_t org);
646
647 #include "cl_screen.h"
648
649 typedef struct
650 {
651         // area to render in
652         int x, y, width, height;
653         float fov_x, fov_y;
654
655         // view transform
656         matrix4x4_t viewentitymatrix;
657
658         // fullscreen color blend
659         float viewblend[4];
660
661         entity_render_t **entities;
662         int numentities;
663         int maxentities;
664
665         qbyte *drawqueue;
666         int drawqueuesize;
667         int maxdrawqueuesize;
668 }
669 refdef_t;
670
671 refdef_t r_refdef;
672
673 extern mempool_t *cl_refdef_mempool;
674
675 #include "cgamevm.h"
676
677 #endif
678