implemented individual file downloads on darkplaces servers
[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
30 // flags for rtlight rendering
31 #define LIGHTFLAG_NORMALMODE 1
32 #define LIGHTFLAG_REALTIMEMODE 2
33
34 typedef struct effect_s
35 {
36         int active;
37         vec3_t origin;
38         float starttime;
39         float framerate;
40         int modelindex;
41         int startframe;
42         int endframe;
43         // these are for interpolation
44         int frame;
45         double frame1time;
46         double frame2time;
47 }
48 cl_effect_t;
49
50 typedef struct beam_s
51 {
52         int             entity;
53         // draw this as lightning polygons, or a model?
54         int             lightning;
55         struct model_s  *model;
56         float   endtime;
57         vec3_t  start, end;
58 }
59 beam_t;
60
61 typedef struct rtlight_s
62 {
63         // shadow volumes are done entirely in model space, so there are no matrices for dealing with them...  they just use the origin
64
65         // note that the world to light matrices are inversely scaled (divided) by lightradius
66
67         // core properties
68         // matrix for transforming world coordinates to light filter coordinates
69         matrix4x4_t matrix_worldtolight;
70         // typically 1 1 1, can be lower (dim) or higher (overbright)
71         vec3_t color;
72         // size of the light (remove?)
73         vec_t radius;
74         // light filter
75         char cubemapname[64];
76         // light style to monitor for brightness
77         int style;
78         // whether light should render shadows
79         int shadow;
80         // intensity of corona to render
81         vec_t corona;
82         // radius scale of corona to render (1.0 means same as light radius)
83         vec_t coronasizescale;
84         // ambient intensity to render
85         vec_t ambientscale;
86         // diffuse intensity to render
87         vec_t diffusescale;
88         // specular intensity to render
89         vec_t specularscale;
90         // LIGHTFLAG_* flags
91         int flags;
92
93         // generated properties
94         // used only for shadow volumes
95         vec3_t shadoworigin;
96         // culling
97         vec3_t cullmins;
98         vec3_t cullmaxs;
99         // culling
100         //vec_t cullradius;
101         // squared cullradius
102         //vec_t cullradius2;
103
104         // rendering properties, updated each time a light is rendered
105         // this is rtlight->color * d_lightstylevalue
106         vec3_t currentcolor;
107         // this is R_Shadow_Cubemap(rtlight->cubemapname)
108         rtexture_t *currentcubemap;
109
110         // static light info
111         // true if this light should be compiled as a static light
112         int isstatic;
113         // true if this is a compiled world light, cleared if the light changes
114         int compiled;
115         // premade shadow volumes to render for world entity
116         shadowmesh_t *static_meshchain_shadow;
117         // used for visibility testing (more exact than bbox)
118         int static_numleafs;
119         int static_numleafpvsbytes;
120         int *static_leaflist;
121         unsigned char *static_leafpvs;
122         // surfaces seen by light
123         int static_numsurfaces;
124         int *static_surfacelist;
125 }
126 rtlight_t;
127
128 typedef struct dlight_s
129 {
130         // destroy light after this time
131         // (dlight only)
132         vec_t die;
133         // the entity that owns this light (can be NULL)
134         // (dlight only)
135         struct entity_render_s *ent;
136         // location
137         // (worldlight: saved to .rtlights file)
138         vec3_t origin;
139         // worldlight orientation
140         // (worldlight only)
141         // (worldlight: saved to .rtlights file)
142         vec3_t angles;
143         // dlight orientation/scaling/location
144         // (dlight only)
145         matrix4x4_t matrix;
146         // color of light
147         // (worldlight: saved to .rtlights file)
148         vec3_t color;
149         // cubemap number to use on this light
150         // (dlight only)
151         int cubemapnum;
152         // cubemap name to use on this light
153         // (worldlight only)
154         // (worldlight: saved to .rtlights file)
155         char cubemapname[64];
156         // make light flash while selected
157         // (worldlight only)
158         int selected;
159         // brightness (not really radius anymore)
160         // (worldlight: saved to .rtlights file)
161         vec_t radius;
162         // drop radius this much each second
163         // (dlight only)
164         vec_t decay;
165         // light style which controls intensity of this light
166         // (worldlight: saved to .rtlights file)
167         int style;
168         // cast shadows
169         // (worldlight: saved to .rtlights file)
170         int shadow;
171         // corona intensity
172         // (worldlight: saved to .rtlights file)
173         vec_t corona;
174         // radius scale of corona to render (1.0 means same as light radius)
175         // (worldlight: saved to .rtlights file)
176         vec_t coronasizescale;
177         // ambient intensity to render
178         // (worldlight: saved to .rtlights file)
179         vec_t ambientscale;
180         // diffuse intensity to render
181         // (worldlight: saved to .rtlights file)
182         vec_t diffusescale;
183         // specular intensity to render
184         // (worldlight: saved to .rtlights file)
185         vec_t specularscale;
186         // LIGHTFLAG_* flags
187         // (worldlight: saved to .rtlights file)
188         int flags;
189         // linked list of world lights
190         // (worldlight only)
191         struct dlight_s *next;
192         // embedded rtlight struct for renderer
193         // (renderer only)
194         rtlight_t rtlight;
195 }
196 dlight_t;
197
198 typedef struct frameblend_s
199 {
200         int frame;
201         float lerp;
202 }
203 frameblend_t;
204
205 // LordHavoc: this struct is intended for the renderer but some fields are
206 // used by the client.
207 typedef struct entity_render_s
208 {
209         // location
210         //vec3_t origin;
211         // orientation
212         //vec3_t angles;
213         // transform matrix for model to world
214         matrix4x4_t matrix;
215         // transform matrix for world to model
216         matrix4x4_t inversematrix;
217         // opacity (alpha) of the model
218         float alpha;
219         // size the model is shown
220         float scale;
221
222         // NULL = no model
223         model_t *model;
224         // current uninterpolated animation frame (for things which do not use interpolation)
225         int frame;
226         // entity shirt and pants colors (-1 if not colormapped)
227         int colormap;
228         // literal colors for renderer
229         vec3_t colormap_pantscolor;
230         vec3_t colormap_shirtcolor;
231         // light, particles, etc
232         int effects;
233         // for Alias models
234         int skinnum;
235         // render flags
236         int flags;
237
238         // colormod tinting of models
239         float colormod[3];
240
241         // interpolated animation
242
243         // frame that the model is interpolating from
244         int frame1;
245         // frame that the model is interpolating to
246         int frame2;
247         // interpolation factor, usually computed from frame2time
248         float framelerp;
249         // time frame1 began playing (for framegroup animations)
250         double frame1time;
251         // time frame2 began playing (for framegroup animations)
252         double frame2time;
253
254         // calculated by the renderer (but not persistent)
255
256         // calculated during R_AddModelEntities
257         vec3_t mins, maxs;
258         // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
259         frameblend_t frameblend[4];
260
261         // current lighting from map
262         vec3_t modellight_ambient;
263         vec3_t modellight_diffuse; // q3bsp
264         vec3_t modellight_lightdir; // q3bsp
265 }
266 entity_render_t;
267
268 typedef struct entity_persistent_s
269 {
270         int linkframe;
271
272         vec3_t trail_origin;
273
274         // particle trail
275         float trail_time;
276
277         // muzzleflash fading
278         float muzzleflash;
279
280         // interpolated movement
281
282         // start time of move
283         float lerpstarttime;
284         // time difference from start to end of move
285         float lerpdeltatime;
286         // the move itself, start and end
287         float oldorigin[3];
288         float oldangles[3];
289         float neworigin[3];
290         float newangles[3];
291 }
292 entity_persistent_t;
293
294 typedef struct entity_s
295 {
296         qboolean csqc;
297         // baseline state (default values)
298         entity_state_t state_baseline;
299         // previous state (interpolating from this)
300         entity_state_t state_previous;
301         // current state (interpolating to this)
302         entity_state_t state_current;
303
304         // used for regenerating parts of render
305         entity_persistent_t persistent;
306
307         // the only data the renderer should know about
308         entity_render_t render;
309 }
310 entity_t;
311
312 typedef struct usercmd_s
313 {
314         vec3_t  viewangles;
315
316 // intended velocities
317         float   forwardmove;
318         float   sidemove;
319         float   upmove;
320
321         vec3_t  cursor_screen;
322         vec3_t  cursor_start;
323         vec3_t  cursor_end;
324         vec3_t  cursor_impact;
325         vec3_t  cursor_normal;
326         vec_t   cursor_fraction;
327         int             cursor_entitynumber;
328
329         double time;
330         double receivetime;
331         int buttons;
332         int impulse;
333         int sequence;
334         qboolean applied; // if false we're still accumulating a move
335 } usercmd_t;
336
337 typedef struct lightstyle_s
338 {
339         int             length;
340         char    map[MAX_STYLESTRING];
341 } lightstyle_t;
342
343 typedef struct scoreboard_s
344 {
345         char    name[MAX_SCOREBOARDNAME];
346         int             frags;
347         int             colors; // two 4 bit fields
348         // QW fields:
349         int             qw_userid;
350         char    qw_userinfo[MAX_USERINFO_STRING];
351         float   qw_entertime;
352         int             qw_ping;
353         int             qw_packetloss;
354         int             qw_spectator;
355         char    qw_team[8];
356         char    qw_skin[MAX_QPATH];
357 } scoreboard_t;
358
359 typedef struct cshift_s
360 {
361         float   destcolor[3];
362         float   percent;                // 0-256
363 } cshift_t;
364
365 #define CSHIFT_CONTENTS 0
366 #define CSHIFT_DAMAGE   1
367 #define CSHIFT_BONUS    2
368 #define CSHIFT_POWERUP  3
369 #define CSHIFT_VCSHIFT  4
370 #define NUM_CSHIFTS             5
371
372 #define NAME_LENGTH     64
373
374
375 //
376 // client_state_t should hold all pieces of the client state
377 //
378
379 #define SIGNONS         4                       // signon messages to receive before connected
380
381 #define MAX_DEMOS               8
382 #define MAX_DEMONAME    16
383
384 typedef enum cactive_e
385 {
386         ca_dedicated,           // a dedicated server with no ability to start a client
387         ca_disconnected,        // full screen console with no connection
388         ca_connected            // valid netcon, talking to a server
389 }
390 cactive_t;
391
392 typedef enum qw_downloadtype_e
393 {
394         dl_none,
395         dl_single,
396         dl_skin,
397         dl_model,
398         dl_sound
399 }
400 qw_downloadtype_t;
401
402 typedef enum capturevideoformat_e
403 {
404         CAPTUREVIDEOFORMAT_AVI_I420
405 }
406 capturevideoformat_t;
407
408 typedef struct capturevideostate_s
409 {
410         double starttime;
411         double framerate;
412         // for AVI saving some values have to be written after capture ends
413         fs_offset_t videofile_totalframes_offset1;
414         fs_offset_t videofile_totalframes_offset2;
415         fs_offset_t videofile_totalsampleframes_offset;
416         qfile_t *videofile;
417         qboolean active;
418         qboolean realtime;
419         qboolean error;
420         capturevideoformat_t format;
421         int soundrate;
422         int frame;
423         int soundsampleframe; // for AVI saving
424         unsigned char *buffer;
425         sizebuf_t riffbuffer;
426         unsigned char riffbufferdata[128];
427         // note: riffindex buffer has an allocated ->data member, not static like most!
428         sizebuf_t riffindexbuffer;
429         int riffstacklevel;
430         fs_offset_t riffstackstartoffset[4];
431         short rgbtoyuvscaletable[3][3][256];
432         unsigned char yuvnormalizetable[3][256];
433         char basename[64];
434 }
435 capturevideostate_t;
436
437 #define CL_MAX_DOWNLOADACKS 4
438
439 typedef struct cl_downloadack_s
440 {
441         int start, size;
442 }
443 cl_downloadack_t;
444
445 //
446 // the client_static_t structure is persistent through an arbitrary number
447 // of server connections
448 //
449 typedef struct client_static_s
450 {
451         cactive_t state;
452
453         // all client memory allocations go in these pools
454         mempool_t *levelmempool;
455         mempool_t *permanentmempool;
456
457 // demo loop control
458         // -1 = don't play demos
459         int demonum;
460         // list of demos in loop
461         char demos[MAX_DEMOS][MAX_DEMONAME];
462         // the actively playing demo (set by CL_PlayDemo_f)
463         char demoname[64];
464
465 // demo recording info must be here, because record is started before
466 // entering a map (and clearing client_state_t)
467         qboolean demorecording;
468         qboolean demoplayback;
469         qboolean timedemo;
470         // -1 = use normal cd track
471         int forcetrack;
472         qfile_t *demofile;
473         // to meter out one message a frame
474         int td_lastframe;
475         // host_framecount at start
476         int td_startframe;
477         // realtime at second frame of timedemo (LordHavoc: changed to double)
478         double td_starttime;
479         // LordHavoc: for measuring maxfps
480         double td_minframetime;
481         // LordHavoc: for measuring minfps
482         double td_maxframetime;
483         // LordHavoc: pausedemo
484         qboolean demopaused;
485
486         qboolean connect_trying;
487         int connect_remainingtries;
488         double connect_nextsendtime;
489         lhnetsocket_t *connect_mysocket;
490         lhnetaddress_t connect_address;
491         // protocol version of the server we're connected to
492         // (kept outside client_state_t because it's used between levels)
493         protocolversion_t protocol;
494
495 // connection information
496         // 0 to SIGNONS
497         int signon;
498         // network connection
499         netconn_t *netcon;
500
501         // download information
502         // (note: qw_download variables are also used)
503         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
504
505         // quakeworld stuff below
506
507         // value of "qport" cvar at time of connection
508         int qw_qport;
509         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
510         int qw_incoming_sequence;
511         int qw_outgoing_sequence;
512
513         // current file download buffer (only saved when file is completed)
514         char qw_downloadname[MAX_QPATH];
515         unsigned char *qw_downloadmemory;
516         int qw_downloadmemorycursize;
517         int qw_downloadmemorymaxsize;
518         int qw_downloadnumber;
519         int qw_downloadpercent;
520         qw_downloadtype_t qw_downloadtype;
521         // transfer rate display
522         double qw_downloadspeedtime;
523         int qw_downloadspeedcount;
524         int qw_downloadspeedrate;
525
526         // current file upload buffer (for uploading screenshots to server)
527         unsigned char *qw_uploaddata;
528         int qw_uploadsize;
529         int qw_uploadpos;
530
531         // user infostring
532         // this normally contains the following keys in quakeworld:
533         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
534         char userinfo[MAX_USERINFO_STRING];
535
536         // video capture stuff
537         capturevideostate_t capturevideo;
538 }
539 client_static_t;
540
541 extern client_static_t  cls;
542
543 typedef struct client_movementqueue_s
544 {
545         double time;
546         float frametime;
547         int sequence;
548         float viewangles[3];
549         float move[3];
550         qboolean jump;
551         qboolean crouch;
552 }
553 client_movementqueue_t;
554
555 //[515]: csqc
556 typedef struct
557 {
558         qboolean drawworld;
559         qboolean drawenginesbar;
560         qboolean drawcrosshair;
561 }csqc_vidvars_t;
562
563 typedef struct qw_usercmd_s
564 {
565         vec3_t angles;
566         short forwardmove, sidemove, upmove;
567         unsigned char padding1[2];
568         unsigned char msec;
569         unsigned char buttons;
570         unsigned char impulse;
571         unsigned char padding2;
572 }
573 qw_usercmd_t;
574
575 typedef enum
576 {
577         PARTICLE_BILLBOARD = 0,
578         PARTICLE_SPARK = 1,
579         PARTICLE_ORIENTED_DOUBLESIDED = 2,
580         PARTICLE_BEAM = 3
581 }
582 porientation_t;
583
584 typedef enum
585 {
586         PBLEND_ALPHA = 0,
587         PBLEND_ADD = 1,
588         PBLEND_MOD = 2
589 }
590 pblend_t;
591
592 typedef struct particletype_s
593 {
594         pblend_t blendmode;
595         porientation_t orientation;
596         qboolean lighting;
597 }
598 particletype_t;
599
600 typedef enum
601 {
602         pt_alphastatic, pt_static, pt_spark, pt_beam, pt_rain, pt_raindecal, pt_snow, pt_bubble, pt_blood, pt_smoke, pt_decal, pt_entityparticle, pt_total
603 }
604 ptype_t;
605
606 typedef struct particle_s
607 {
608         particletype_t *type;
609         int                     texnum;
610         vec3_t          org;
611         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
612         float           size;
613         float           sizeincrease; // rate of size change per second
614         float           alpha; // 0-255
615         float           alphafade; // how much alpha reduces per second
616         float           time2; // used for snow fluttering and decal fade
617         float           bounce; // how much bounce-back from a surface the particle hits (0 = no physics, 1 = stop and slide, 2 = keep bouncing forever, 1.5 is typical)
618         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
619         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
620         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
621         unsigned char           color[4];
622         unsigned int            owner; // decal stuck to this entity
623         model_t         *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
624         vec3_t          relativeorigin; // decal at this location in entity's coordinate space
625         vec3_t          relativedirection; // decal oriented this way relative to entity's coordinate space
626 }
627 particle_t;
628
629 typedef enum cl_parsingtextmode_e
630 {
631         CL_PARSETEXTMODE_NONE,
632         CL_PARSETEXTMODE_PING,
633         CL_PARSETEXTMODE_STATUS,
634         CL_PARSETEXTMODE_STATUS_PLAYERID,
635         CL_PARSETEXTMODE_STATUS_PLAYERIP
636 }
637 cl_parsingtextmode_t;
638
639 //
640 // the client_state_t structure is wiped completely at every
641 // server signon
642 //
643 typedef struct client_state_s
644 {
645         // true if playing in a local game and no one else is connected
646         int islocalgame;
647
648         // when connecting to the server throw out the first couple move messages
649         // so the player doesn't accidentally do something the first frame
650         int movemessages;
651
652         // send a clc_nop periodically until connected
653         float sendnoptime;
654
655         // current input to send to the server
656         usercmd_t cmd;
657
658 // information for local display
659         // health, etc
660         int stats[MAX_CL_STATS];
661         // last known inventory bit flags, for blinking
662         int olditems;
663         // cl.time of acquiring item, for blinking
664         float item_gettime[32];
665         // last known STAT_ACTIVEWEAPON
666         int activeweapon;
667         // cl.time of changing STAT_ACTIVEWEAPON
668         float weapontime;
669         // use pain anim frame if cl.time < this
670         float faceanimtime;
671         // for stair smoothing
672         float stairoffset;
673
674         // color shifts for damage, powerups
675         cshift_t cshifts[NUM_CSHIFTS];
676         // and content types
677         cshift_t prev_cshifts[NUM_CSHIFTS];
678
679 // the client maintains its own idea of view angles, which are
680 // sent to the server each frame.  The server sets punchangle when
681 // the view is temporarily offset, and an angle reset commands at the start
682 // of each level and after teleporting.
683
684         // mviewangles is read from demo
685         // viewangles is either client controlled or lerped from mviewangles
686         vec3_t mviewangles[2], viewangles;
687         // update by server, used by qc to do weapon recoil
688         vec3_t mpunchangle[2], punchangle;
689         // update by server, can be used by mods to kick view around
690         vec3_t mpunchvector[2], punchvector;
691         // update by server, used for lean+bob (0 is newest)
692         vec3_t mvelocity[2], velocity;
693         // update by server, can be used by mods for zooming
694         vec_t mviewzoom[2], viewzoom;
695         // if true interpolation the mviewangles and other interpolation of the
696         // player is disabled until the next network packet
697         // this is used primarily by teleporters, and when spectating players
698         // special checking of the old fixangle[1] is used to differentiate
699         // between teleporting and spectating
700         qboolean fixangle[2];
701
702         // client movement simulation
703         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
704         // set by CL_ClientMovement_Replay functions
705         qboolean movement_predicted;
706         // this is set true by svc_time parsing and causes a new movement to be
707         // queued for prediction purposes
708         qboolean movement_needupdate;
709         // indicates the queue has been updated and should be replayed
710         qboolean movement_replay;
711         // timestamps of latest two predicted moves for interpolation
712         double movement_time[2];
713         // simulated data (this is valid even if cl.movement is false)
714         vec3_t movement_origin;
715         vec3_t movement_oldorigin;
716         vec3_t movement_velocity;
717         // queue of proposed moves
718         int movement_numqueue;
719         client_movementqueue_t movement_queue[256];
720         int movesequence;
721         int servermovesequence;
722         // whether the replay should allow a jump at the first sequence
723         qboolean movement_replay_canjump;
724
725 // pitch drifting vars
726         float idealpitch;
727         float pitchvel;
728         qboolean nodrift;
729         float driftmove;
730         double laststop;
731
732 //[515]: added for csqc purposes
733         float sensitivityscale;
734         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
735         qboolean csqc_wantsmousemove;
736         struct model_s *csqc_model_precache[MAX_MODELS];
737
738         // local amount for smoothing stepups
739         //float crouch;
740
741         // sent by server
742         qboolean paused;
743         qboolean onground;
744         qboolean inwater;
745
746         // used by bob
747         qboolean oldonground;
748         double lastongroundtime;
749         double hitgroundtime;
750
751         // don't change view angle, full screen, etc
752         int intermission;
753         // latched at intermission start
754         double completed_time;
755
756         // the timestamp of the last two messages
757         double mtime[2];
758
759         // clients view of time, time should be between mtime[0] and mtime[1] to
760         // generate a lerp point for other data, oldtime is the previous frame's
761         // value of time, frametime is the difference between time and oldtime
762         double time, oldtime;
763         // how long it has been since the previous client frame in real time
764         // (not game time, for that use cl.time - cl.oldtime)
765         double realframetime;
766
767         // copy of realtime from last recieved message, for net trouble icon
768         float last_received_message;
769
770 // information that is static for the entire time connected to a server
771         struct model_s *model_precache[MAX_MODELS];
772         struct sfx_s *sound_precache[MAX_SOUNDS];
773
774         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
775         char model_name[MAX_MODELS][MAX_QPATH];
776         char sound_name[MAX_SOUNDS][MAX_QPATH];
777
778         // for display on solo scoreboard
779         char levelname[40];
780         // cl_entitites[cl.viewentity] = player
781         int viewentity;
782         // the real player entity (normally same as viewentity,
783         // different than viewentity if mod uses chasecam or other tricks)
784         int playerentity;
785         // max players that can be in this game
786         int maxclients;
787         // type of game (deathmatch, coop, singleplayer)
788         int gametype;
789
790         // models and sounds used by engine code (particularly cl_parse.c)
791         model_t *model_bolt;
792         model_t *model_bolt2;
793         model_t *model_bolt3;
794         model_t *model_beam;
795         sfx_t *sfx_wizhit;
796         sfx_t *sfx_knighthit;
797         sfx_t *sfx_tink1;
798         sfx_t *sfx_ric1;
799         sfx_t *sfx_ric2;
800         sfx_t *sfx_ric3;
801         sfx_t *sfx_r_exp3;
802
803 // refresh related state
804
805         // cl_entitites[0].model
806         struct model_s *worldmodel;
807
808         // the gun model
809         entity_t viewent;
810
811         // cd audio
812         int cdtrack, looptrack;
813
814 // frag scoreboard
815
816         // [cl.maxclients]
817         scoreboard_t *scores;
818
819         // keep track of svc_print parsing state (analyzes ping reports and status reports)
820         cl_parsingtextmode_t parsingtextmode;
821         int parsingtextplayerindex;
822         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
823         // (which could eat the wrong ping report if the player issues one
824         //  manually, but they would still see a ping report, just a later one
825         //  caused by the scoreboard code rather than the one they intentionally
826         //  issued)
827         int parsingtextexpectingpingforscores;
828
829         // entity database stuff
830         // latest received entity frame numbers
831 #define LATESTFRAMENUMS 3
832         int latestframenums[LATESTFRAMENUMS];
833         entityframe_database_t *entitydatabase;
834         entityframe4_database_t *entitydatabase4;
835         entityframeqw_database_t *entitydatabaseqw;
836
837         // keep track of quake entities because they need to be killed if they get stale
838         int lastquakeentity;
839         unsigned char isquakeentity[MAX_EDICTS];
840
841         // bounding boxes for clientside movement
842         vec3_t playerstandmins;
843         vec3_t playerstandmaxs;
844         vec3_t playercrouchmins;
845         vec3_t playercrouchmaxs;
846
847         int max_entities;
848         int max_csqcentities;
849         int max_static_entities;
850         int max_temp_entities;
851         int max_effects;
852         int max_beams;
853         int max_dlights;
854         int max_lightstyle;
855         int max_brushmodel_entities;
856         int max_particles;
857
858         entity_t *entities;
859         entity_t *csqcentities; //[515]: csqc
860         unsigned char *entities_active;
861         unsigned char *csqcentities_active;     //[515]: csqc
862         entity_t *static_entities;
863         entity_t *temp_entities;
864         cl_effect_t *effects;
865         beam_t *beams;
866         dlight_t *dlights;
867         lightstyle_t *lightstyle;
868         int *brushmodel_entities;
869         particle_t *particles;
870
871         int num_entities;
872         int num_csqcentities;   //[515]: csqc
873         int num_static_entities;
874         int num_temp_entities;
875         int num_brushmodel_entities;
876         int num_effects;
877         int num_beams;
878         int num_dlights;
879         int num_particles;
880
881         int free_particle;
882
883         // cl_serverextension_download feature
884         int loadmodel_current;
885         int downloadmodel_current;
886         int loadmodel_total;
887         int loadsound_current;
888         int downloadsound_current;
889         int loadsound_total;
890         qboolean loadfinished;
891
892         // quakeworld stuff
893
894         // local copy of the server infostring
895         char qw_serverinfo[MAX_SERVERINFO_STRING];
896
897         // time of last qw "pings" command sent to server while showing scores
898         double last_ping_request;
899
900         // used during connect
901         int qw_servercount;
902
903         // updated from serverinfo
904         int qw_teamplay;
905
906         // unused: indicates whether the player is spectating
907         // use cl.scores[cl.playerentity].qw_spectator instead
908         //qboolean qw_spectator;
909
910         // movement parameters for client prediction
911         float qw_movevars_gravity;
912         float qw_movevars_stopspeed;
913         float qw_movevars_maxspeed; // can change during play
914         float qw_movevars_spectatormaxspeed;
915         float qw_movevars_accelerate;
916         float qw_movevars_airaccelerate;
917         float qw_movevars_wateraccelerate;
918         float qw_movevars_friction;
919         float qw_movevars_waterfriction;
920         float qw_movevars_entgravity; // can change during play
921
922         // models used by qw protocol
923         int qw_modelindex_spike;
924         int qw_modelindex_player;
925         int qw_modelindex_flag;
926         int qw_modelindex_s_explod;
927
928         vec3_t qw_intermission_origin;
929         vec3_t qw_intermission_angles;
930
931         // 255 is the most nails the QW protocol could send
932         int qw_num_nails;
933         vec_t qw_nails[255][6];
934
935         float qw_weaponkick;
936
937         int qw_validsequence;
938
939         qw_usercmd_t qw_moves[QW_UPDATE_BACKUP];
940
941         int qw_deltasequence[QW_UPDATE_BACKUP];
942 }
943 client_state_t;
944
945 //
946 // cvars
947 //
948 extern cvar_t cl_name;
949 extern cvar_t cl_color;
950 extern cvar_t cl_rate;
951 extern cvar_t cl_pmodel;
952 extern cvar_t cl_playermodel;
953 extern cvar_t cl_playerskin;
954
955 extern cvar_t rcon_password;
956 extern cvar_t rcon_address;
957
958 extern cvar_t cl_upspeed;
959 extern cvar_t cl_forwardspeed;
960 extern cvar_t cl_backspeed;
961 extern cvar_t cl_sidespeed;
962
963 extern cvar_t cl_movespeedkey;
964
965 extern cvar_t cl_yawspeed;
966 extern cvar_t cl_pitchspeed;
967
968 extern cvar_t cl_anglespeedkey;
969
970 extern cvar_t cl_autofire;
971
972 extern cvar_t cl_shownet;
973 extern cvar_t cl_nolerp;
974
975 extern cvar_t cl_pitchdriftspeed;
976 extern cvar_t lookspring;
977 extern cvar_t lookstrafe;
978 extern cvar_t sensitivity;
979
980 extern cvar_t freelook;
981
982 extern cvar_t m_pitch;
983 extern cvar_t m_yaw;
984 extern cvar_t m_forward;
985 extern cvar_t m_side;
986
987 extern cvar_t cl_autodemo;
988 extern cvar_t cl_autodemo_nameformat;
989
990 extern cvar_t r_draweffects;
991
992 extern cvar_t cl_explosions_alpha_start;
993 extern cvar_t cl_explosions_alpha_end;
994 extern cvar_t cl_explosions_size_start;
995 extern cvar_t cl_explosions_size_end;
996 extern cvar_t cl_explosions_lifetime;
997 extern cvar_t cl_stainmaps;
998 extern cvar_t cl_stainmaps_clearonload;
999
1000 extern cvar_t cl_prydoncursor;
1001
1002 extern client_state_t cl;
1003
1004 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, vec_t coronasizescale, vec_t ambientscale, vec_t diffusescale, vec_t specularscale, int flags);
1005
1006 //=============================================================================
1007
1008 //
1009 // cl_main
1010 //
1011
1012 void CL_Shutdown (void);
1013 void CL_Init (void);
1014
1015 void CL_EstablishConnection(const char *host);
1016
1017 void CL_Disconnect (void);
1018 void CL_Disconnect_f (void);
1019
1020 void CL_UpdateRenderEntity(entity_render_t *ent);
1021
1022 //
1023 // cl_input
1024 //
1025 typedef struct kbutton_s
1026 {
1027         int             down[2];                // key nums holding it down
1028         int             state;                  // low bit is down state
1029 }
1030 kbutton_t;
1031
1032 extern  kbutton_t       in_mlook, in_klook;
1033 extern  kbutton_t       in_strafe;
1034 extern  kbutton_t       in_speed;
1035
1036 void CL_InitInput (void);
1037 void CL_SendMove (void);
1038
1039 void CL_ValidateState(entity_state_t *s);
1040 void CL_MoveLerpEntityStates(entity_t *ent);
1041 void CL_LerpUpdate(entity_t *e);
1042 void CL_ParseTEnt (void);
1043 void CL_NewBeam (int ent, vec3_t start, vec3_t end, model_t *m, int lightning);
1044 void CL_RelinkBeams (void);
1045 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1046
1047 void CL_ClearTempEntities (void);
1048 entity_t *CL_NewTempEntity (void);
1049
1050 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1051
1052 void CL_ClearState (void);
1053 void CL_ExpandEntities(int num);
1054 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1055
1056
1057 int  CL_ReadFromServer (void);
1058 void CL_WriteToServer (void);
1059 void CL_Move (void);
1060 extern qboolean cl_ignoremousemove;
1061
1062
1063 float CL_KeyState (kbutton_t *key);
1064 const char *Key_KeynumToString (int keynum);
1065 int Key_StringToKeynum (const char *str);
1066
1067 //
1068 // cl_demo.c
1069 //
1070 void CL_StopPlayback(void);
1071 void CL_ReadDemoMessage(void);
1072 void CL_WriteDemoMessage(void);
1073
1074 void CL_NextDemo(void);
1075 void CL_Stop_f(void);
1076 void CL_Record_f(void);
1077 void CL_PlayDemo_f(void);
1078 void CL_TimeDemo_f(void);
1079
1080 //
1081 // cl_parse.c
1082 //
1083 void CL_Parse_Init(void);
1084 void CL_Parse_Shutdown(void);
1085 void CL_ParseServerMessage(void);
1086 void CL_Parse_DumpPacket(void);
1087 void CL_Parse_ErrorCleanUp(void);
1088 void QW_CL_StartUpload(unsigned char *data, int size);
1089 extern cvar_t qport;
1090
1091 //
1092 // view
1093 //
1094 void V_StartPitchDrift (void);
1095 void V_StopPitchDrift (void);
1096
1097 void V_Init (void);
1098 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1099 void V_UpdateBlends (void);
1100 void V_ParseDamage (void);
1101
1102 //
1103 // cl_part
1104 //
1105
1106 extern cvar_t cl_particles;
1107 extern cvar_t cl_particles_quality;
1108 extern cvar_t cl_particles_size;
1109 extern cvar_t cl_particles_quake;
1110 extern cvar_t cl_particles_blood;
1111 extern cvar_t cl_particles_blood_alpha;
1112 extern cvar_t cl_particles_blood_bloodhack;
1113 extern cvar_t cl_particles_bulletimpacts;
1114 extern cvar_t cl_particles_explosions_bubbles;
1115 extern cvar_t cl_particles_explosions_smoke;
1116 extern cvar_t cl_particles_explosions_sparks;
1117 extern cvar_t cl_particles_explosions_shell;
1118 extern cvar_t cl_particles_smoke;
1119 extern cvar_t cl_particles_smoke_alpha;
1120 extern cvar_t cl_particles_smoke_alphafade;
1121 extern cvar_t cl_particles_sparks;
1122 extern cvar_t cl_particles_bubbles;
1123 extern cvar_t cl_decals;
1124 extern cvar_t cl_decals_time;
1125 extern cvar_t cl_decals_fadetime;
1126
1127 void CL_Particles_Clear(void);
1128 void CL_Particles_Init(void);
1129 void CL_Particles_Shutdown(void);
1130
1131 typedef enum effectnameindex_s
1132 {
1133         EFFECT_NONE,
1134         EFFECT_TE_GUNSHOT,
1135         EFFECT_TE_GUNSHOTQUAD,
1136         EFFECT_TE_SPIKE,
1137         EFFECT_TE_SPIKEQUAD,
1138         EFFECT_TE_SUPERSPIKE,
1139         EFFECT_TE_SUPERSPIKEQUAD,
1140         EFFECT_TE_WIZSPIKE,
1141         EFFECT_TE_KNIGHTSPIKE,
1142         EFFECT_TE_EXPLOSION,
1143         EFFECT_TE_EXPLOSIONQUAD,
1144         EFFECT_TE_TAREXPLOSION,
1145         EFFECT_TE_TELEPORT,
1146         EFFECT_TE_LAVASPLASH,
1147         EFFECT_TE_SMALLFLASH,
1148         EFFECT_TE_FLAMEJET,
1149         EFFECT_EF_FLAME,
1150         EFFECT_TE_BLOOD,
1151         EFFECT_TE_SPARK,
1152         EFFECT_TE_PLASMABURN,
1153         EFFECT_TE_TEI_G3,
1154         EFFECT_TE_TEI_SMOKE,
1155         EFFECT_TE_TEI_BIGEXPLOSION,
1156         EFFECT_TE_TEI_PLASMAHIT,
1157         EFFECT_EF_STARDUST,
1158         EFFECT_TR_ROCKET,
1159         EFFECT_TR_GRENADE,
1160         EFFECT_TR_BLOOD,
1161         EFFECT_TR_WIZSPIKE,
1162         EFFECT_TR_SLIGHTBLOOD,
1163         EFFECT_TR_KNIGHTSPIKE,
1164         EFFECT_TR_VORESPIKE,
1165         EFFECT_TR_NEHAHRASMOKE,
1166         EFFECT_TR_NEXUIZPLASMA,
1167         EFFECT_TR_GLOWTRAIL,
1168         EFFECT_SVC_PARTICLE,
1169         EFFECT_TOTAL
1170 }
1171 effectnameindex_t;
1172
1173 int CL_ParticleEffectIndexForName(const char *name);
1174 const char *CL_ParticleEffectNameForIndex(int i);
1175 void CL_ParticleEffect(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor);
1176 void CL_ParseParticleEffect (void);
1177 void CL_ParticleCube (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, vec_t gravity, vec_t randomvel);
1178 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1179 void CL_EntityParticles (const entity_t *ent);
1180 void CL_ParticleExplosion (const vec3_t org);
1181 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1182 void CL_MoveParticles(void);
1183 void R_MoveExplosions(void);
1184 void R_NewExplosion(const vec3_t org);
1185
1186 #include "cl_screen.h"
1187
1188 extern qboolean sb_showscores;
1189
1190 #define NUMCROSSHAIRS 32
1191 extern cachepic_t *r_crosshairs[NUMCROSSHAIRS+1];
1192
1193 #define FOGTABLEWIDTH 1024
1194 extern int fogtableindex;
1195 #define VERTEXFOGTABLE(dist) (fogtableindex = (int)((dist) * r_refdef.fogtabledistmultiplier), r_refdef.fogtable[bound(0, fogtableindex, FOGTABLEWIDTH - 1)])
1196
1197 typedef struct r_refdef_stats_s
1198 {
1199         int entities;
1200         int entities_surfaces;
1201         int entities_triangles;
1202         int world_leafs;
1203         int world_portals;
1204         int particles;
1205         int meshes;
1206         int meshes_elements;
1207         int lights;
1208         int lights_clears;
1209         int lights_scissored;
1210         int lights_lighttriangles;
1211         int lights_shadowtriangles;
1212         int lights_dynamicshadowtriangles;
1213         int bloom;
1214         int bloom_copypixels;
1215         int bloom_drawpixels;
1216 }
1217 r_refdef_stats_t;
1218
1219 typedef struct r_refdef_s
1220 {
1221         // these fields define the basic rendering information for the world
1222         // but not the view, which could change multiple times in one rendered
1223         // frame (for example when rendering textures for certain effects)
1224
1225         // these are set for water warping before
1226         // frustum_x/frustum_y are calculated
1227         float frustumscale_x, frustumscale_y;
1228
1229         // minimum visible distance (pixels closer than this disappear)
1230         double nearclip;
1231         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1232         // in 32bpp an infinite-farclip matrix is used instead)
1233         double farclip;
1234
1235         // fullscreen color blend
1236         float viewblend[4];
1237
1238         // whether to call S_ExtraUpdate during render to reduce sound chop
1239         qboolean extraupdate;
1240
1241         // client gameworld time for rendering time based effects
1242         double time;
1243
1244         // the world
1245         entity_render_t *worldentity;
1246
1247         // same as worldentity->model
1248         model_t *worldmodel;
1249
1250         // renderable entities (excluding world)
1251         entity_render_t **entities;
1252         int numentities;
1253         int maxentities;
1254
1255         // renderable dynamic lights
1256         dlight_t *lights[MAX_DLIGHTS];
1257         int numlights;
1258
1259         // 8.8bit fixed point intensities for light styles
1260         // controls intensity of dynamic lights and lightmap layers
1261         unsigned short  lightstylevalue[256];   // 8.8 fraction of base light value
1262
1263         vec3_t fogcolor;
1264         vec_t fogrange;
1265         vec_t fograngerecip;
1266         vec_t fogtabledistmultiplier;
1267         float fogtable[FOGTABLEWIDTH];
1268         float fog_density;
1269         float fog_red;
1270         float fog_green;
1271         float fog_blue;
1272         qboolean fogenabled;
1273         qboolean oldgl_fogenable;
1274
1275         qboolean draw2dstage;
1276
1277         // true during envmap command capture
1278         qboolean envmap;
1279
1280         // brightness of world lightmaps and related lighting
1281         // (often reduced when world rtlights are enabled)
1282         float lightmapintensity;
1283         // whether to draw world lights realtime, dlights realtime, and their shadows
1284         qboolean rtworld;
1285         qboolean rtworldshadows;
1286         qboolean rtdlight;
1287         qboolean rtdlightshadows;
1288         float polygonfactor;
1289         float polygonoffset;
1290         float shadowpolygonfactor;
1291         float shadowpolygonoffset;
1292
1293         // rendering stats for r_speeds display
1294         // (these are incremented in many places)
1295         r_refdef_stats_t stats;
1296 }
1297 r_refdef_t;
1298
1299 typedef struct r_view_s
1300 {
1301         // view information (changes multiple times per frame)
1302         // if any of these variables change then r_viewcache must be regenerated
1303         // by calling R_View_Update
1304         // (which also updates viewport, scissor, colormask)
1305
1306         // it is safe and expected to copy this into a structure on the stack and
1307         // call the renderer recursively, then restore from the stack afterward
1308         // (as long as R_View_Update is called)
1309
1310         // eye position information
1311         matrix4x4_t matrix;
1312         vec3_t origin;
1313         vec3_t forward;
1314         vec3_t left;
1315         vec3_t right;
1316         vec3_t up;
1317         mplane_t frustum[5];
1318         float frustum_x, frustum_y;
1319
1320         // screen area to render in
1321         int x;
1322         int y;
1323         int z;
1324         int width;
1325         int height;
1326         int depth;
1327
1328         // which color components to allow (for anaglyph glasses)
1329         int colormask[4];
1330
1331         // global RGB color multiplier for rendering, this is required by HDR
1332         float colorscale;
1333 }
1334 r_view_t;
1335
1336 typedef struct r_viewcache_s
1337 {
1338         // these properties are generated by R_View_Update()
1339
1340         // which entities are currently visible for this viewpoint
1341         // (the used range is 0...r_refdef.numentities)
1342         unsigned char entityvisible[MAX_EDICTS];
1343         // flag arrays used for visibility checking on world model
1344         // (all other entities have no per-surface/per-leaf visibility checks)
1345         // TODO: dynamic resize according to r_refdef.worldmodel->brush.num_clusters
1346         unsigned char world_pvsbits[(32768+7)>>3];
1347         // TODO: dynamic resize according to r_refdef.worldmodel->brush.num_leafs
1348         unsigned char world_leafvisible[32768];
1349         // TODO: dynamic resize according to r_refdef.worldmodel->num_surfaces
1350         unsigned char world_surfacevisible[262144];
1351         // if true, the view is currently in a leaf without pvs data
1352         qboolean world_novis;
1353 }
1354 r_viewcache_t;
1355
1356 extern r_refdef_t r_refdef;
1357 extern r_view_t r_view;
1358 extern r_viewcache_t r_viewcache;
1359
1360 #endif
1361