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 #include "snd_main.h"
  27
  28 // flags for rtlight rendering
  29 #define LIGHTFLAG_NORMALMODE 1
  30 #define LIGHTFLAG_REALTIMEMODE 2
  31
  32 typedef struct tridecal_s
  33 {
  34         // color and initial alpha value
  35         float                   texcoord2f[3][2];
  36         float                   vertex3f[3][3];
  37         float                   color4f[3][4];
  38         float                   plane[4]; // backface culling
  39         // how long this decal has lived so far (the actual fade begins at cl_decals_time)
  40         float                   lived;
  41         // if >= 0 this indicates the decal should follow an animated triangle
  42         int                             triangleindex;
  43         // for visibility culling
  44         int                             surfaceindex;
  45         // old decals are killed to obey cl_decals_max
  46         int                             decalsequence;
  47 }
  48 tridecal_t;
  49
  50 typedef struct decalsystem_s
  51 {
  52         dp_model_t *model;
  53         double lastupdatetime;
  54         int maxdecals;
  55         int freedecal;
  56         int numdecals;
  57         tridecal_t *decals;
  58         float *vertex3f;
  59         float *texcoord2f;
  60         float *color4f;
  61         int *element3i;
  62         unsigned short *element3s;
  63 }
  64 decalsystem_t;
  65
  66 typedef struct effect_s
  67 {
  68         int active;
  69         vec3_t origin;
  70         double starttime;
  71         float framerate;
  72         int modelindex;
  73         int startframe;
  74         int endframe;
  75         // these are for interpolation
  76         int frame;
  77         double frame1time;
  78         double frame2time;
  79 }
  80 cl_effect_t;
  81
  82 typedef struct beam_s
  83 {
  84         int             entity;
  85         // draw this as lightning polygons, or a model?
  86         int             lightning;
  87         struct model_s  *model;
  88         float   endtime;
  89         vec3_t  start, end;
  90 }
  91 beam_t;
  92
  93 typedef struct rtlight_particle_s
  94 {
  95         float origin[3];
  96         float color[3];
  97 }
  98 rtlight_particle_t;
  99
 100 typedef struct rtlight_s
 101 {
 102         // shadow volumes are done entirely in model space, so there are no matrices for dealing with them...  they just use the origin
 103
 104         // note that the world to light matrices are inversely scaled (divided) by lightradius
 105
 106         // core properties
 107         /// matrix for transforming light filter coordinates to world coordinates
 108         matrix4x4_t matrix_lighttoworld;
 109         /// matrix for transforming world coordinates to light filter coordinates
 110         matrix4x4_t matrix_worldtolight;
 111         /// typically 1 1 1, can be lower (dim) or higher (overbright)
 112         vec3_t color;
 113         /// size of the light (remove?)
 114         vec_t radius;
 115         /// light filter
 116         char cubemapname[64];
 117         /// light style to monitor for brightness
 118         int style;
 119         /// whether light should render shadows
 120         int shadow;
 121         /// intensity of corona to render
 122         vec_t corona;
 123         /// radius scale of corona to render (1.0 means same as light radius)
 124         vec_t coronasizescale;
 125         /// ambient intensity to render
 126         vec_t ambientscale;
 127         /// diffuse intensity to render
 128         vec_t diffusescale;
 129         /// specular intensity to render
 130         vec_t specularscale;
 131         /// LIGHTFLAG_* flags
 132         int flags;
 133
 134         // generated properties
 135         /// used only for shadow volumes
 136         vec3_t shadoworigin;
 137         /// culling
 138         vec3_t cullmins;
 139         vec3_t cullmaxs;
 140         // culling
 141         //vec_t cullradius;
 142         // squared cullradius
 143         //vec_t cullradius2;
 144
 145         // rendering properties, updated each time a light is rendered
 146         // this is rtlight->color * d_lightstylevalue
 147         vec3_t currentcolor;
 148         /// used by corona updates, due to occlusion query
 149         float corona_visibility;
 150         unsigned int corona_queryindex_visiblepixels;
 151         unsigned int corona_queryindex_allpixels;
 152         /// this is R_GetCubemap(rtlight->cubemapname)
 153         rtexture_t *currentcubemap;
 154         /// set by R_Shadow_PrepareLight to decide whether R_Shadow_DrawLight should draw it
 155         qboolean draw;
 156         /// these fields are set by R_Shadow_PrepareLight for later drawing
 157         int cached_numlightentities;
 158         int cached_numlightentities_noselfshadow;
 159         int cached_numshadowentities;
 160         int cached_numshadowentities_noselfshadow;
 161         int cached_numsurfaces;
 162         struct entity_render_s **cached_lightentities;
 163         struct entity_render_s **cached_lightentities_noselfshadow;
 164         struct entity_render_s **cached_shadowentities;
 165         struct entity_render_s **cached_shadowentities_noselfshadow;
 166         unsigned char *cached_shadowtrispvs;
 167         unsigned char *cached_lighttrispvs;
 168         int *cached_surfacelist;
 169         // reduced light cullbox from GetLightInfo
 170         vec3_t cached_cullmins;
 171         vec3_t cached_cullmaxs;
 172         // current shadow-caster culling planes based on view
 173         // (any geometry outside these planes can not contribute to the visible
 174         //  shadows in any way, and thus can be culled safely)
 175         int cached_numfrustumplanes;
 176         mplane_t cached_frustumplanes[5]; // see R_Shadow_ComputeShadowCasterCullingPlanes
 177
 178         /// static light info
 179         /// true if this light should be compiled as a static light
 180         int isstatic;
 181         /// true if this is a compiled world light, cleared if the light changes
 182         int compiled;
 183         /// the shadowing mode used to compile this light
 184         int shadowmode;
 185         /// premade shadow volumes to render for world entity
 186         shadowmesh_t *static_meshchain_shadow_zpass;
 187         shadowmesh_t *static_meshchain_shadow_zfail;
 188         shadowmesh_t *static_meshchain_shadow_shadowmap;
 189         /// used for visibility testing (more exact than bbox)
 190         int static_numleafs;
 191         int static_numleafpvsbytes;
 192         int *static_leaflist;
 193         unsigned char *static_leafpvs;
 194         /// surfaces seen by light
 195         int static_numsurfaces;
 196         int *static_surfacelist;
 197         /// flag bits indicating which triangles of the world model should cast
 198         /// shadows, and which ones should be lit
 199         ///
 200         /// this avoids redundantly scanning the triangles in each surface twice
 201         /// for whether they should cast shadows, once in culling and once in the
 202         /// actual shadowmarklist production.
 203         int static_numshadowtrispvsbytes;
 204         unsigned char *static_shadowtrispvs;
 205         /// this allows the lighting batch code to skip backfaces andother culled
 206         /// triangles not relevant for lighting
 207         /// (important on big surfaces such as terrain)
 208         int static_numlighttrispvsbytes;
 209         unsigned char *static_lighttrispvs;
 210         /// masks of all shadowmap sides that have any potential static receivers or casters
 211         int static_shadowmap_receivers;
 212         int static_shadowmap_casters;
 213         /// particle-tracing cache for global illumination
 214         int particlecache_numparticles;
 215         int particlecache_maxparticles;
 216         int particlecache_updateparticle;
 217         rtlight_particle_t *particlecache_particles;
 218
 219         /// bouncegrid light info
 220         float photoncolor[3];
 221         float photons;
 222 }
 223 rtlight_t;
 224
 225 typedef struct dlight_s
 226 {
 227         // destroy light after this time
 228         // (dlight only)
 229         vec_t die;
 230         // the entity that owns this light (can be NULL)
 231         // (dlight only)
 232         struct entity_render_s *ent;
 233         // location
 234         // (worldlight: saved to .rtlights file)
 235         vec3_t origin;
 236         // worldlight orientation
 237         // (worldlight only)
 238         // (worldlight: saved to .rtlights file)
 239         vec3_t angles;
 240         // dlight orientation/scaling/location
 241         // (dlight only)
 242         matrix4x4_t matrix;
 243         // color of light
 244         // (worldlight: saved to .rtlights file)
 245         vec3_t color;
 246         // cubemap name to use on this light
 247         // (worldlight: saved to .rtlights file)
 248         char cubemapname[64];
 249         // make light flash while selected
 250         // (worldlight only)
 251         int selected;
 252         // brightness (not really radius anymore)
 253         // (worldlight: saved to .rtlights file)
 254         vec_t radius;
 255         // drop intensity this much each second
 256         // (dlight only)
 257         vec_t decay;
 258         // intensity value which is dropped over time
 259         // (dlight only)
 260         vec_t intensity;
 261         // initial values for intensity to modify
 262         // (dlight only)
 263         vec_t initialradius;
 264         vec3_t initialcolor;
 265         // light style which controls intensity of this light
 266         // (worldlight: saved to .rtlights file)
 267         int style;
 268         // cast shadows
 269         // (worldlight: saved to .rtlights file)
 270         int shadow;
 271         // corona intensity
 272         // (worldlight: saved to .rtlights file)
 273         vec_t corona;
 274         // radius scale of corona to render (1.0 means same as light radius)
 275         // (worldlight: saved to .rtlights file)
 276         vec_t coronasizescale;
 277         // ambient intensity to render
 278         // (worldlight: saved to .rtlights file)
 279         vec_t ambientscale;
 280         // diffuse intensity to render
 281         // (worldlight: saved to .rtlights file)
 282         vec_t diffusescale;
 283         // specular intensity to render
 284         // (worldlight: saved to .rtlights file)
 285         vec_t specularscale;
 286         // LIGHTFLAG_* flags
 287         // (worldlight: saved to .rtlights file)
 288         int flags;
 289         // linked list of world lights
 290         // (worldlight only)
 291         struct dlight_s *next;
 292         // embedded rtlight struct for renderer
 293         // (worldlight only)
 294         rtlight_t rtlight;
 295 }
 296 dlight_t;
 297
 298 // this is derived from processing of the framegroupblend array
 299 // note: technically each framegroupblend can produce two of these, but that
 300 // never happens in practice because no one blends between more than 2
 301 // framegroups at once
 302 #define MAX_FRAMEBLENDS (MAX_FRAMEGROUPBLENDS * 2)
 303 typedef struct frameblend_s
 304 {
 305         int subframe;
 306         float lerp;
 307 }
 308 frameblend_t;
 309
 310 // LordHavoc: this struct is intended for the renderer but some fields are
 311 // used by the client.
 312 //
 313 // The renderer should not rely on any changes to this struct to be persistent
 314 // across multiple frames because temp entities are wiped every frame, but it
 315 // is acceptable to cache things in this struct that are not critical.
 316 //
 317 // For example the r_cullentities_trace code does such caching.
 318 typedef struct entity_render_s
 319 {
 320         // location
 321         //vec3_t origin;
 322         // orientation
 323         //vec3_t angles;
 324         // transform matrix for model to world
 325         matrix4x4_t matrix;
 326         // transform matrix for world to model
 327         matrix4x4_t inversematrix;
 328         // opacity (alpha) of the model
 329         float alpha;
 330         // size the model is shown
 331         float scale;
 332         // transparent sorting offset
 333         float transparent_offset;
 334
 335         // NULL = no model
 336         dp_model_t *model;
 337         // number of the entity represents, or 0 for non-network entities
 338         int entitynumber;
 339         // literal colormap colors for renderer, if both are 0 0 0 it is not colormapped
 340         vec3_t colormap_pantscolor;
 341         vec3_t colormap_shirtcolor;
 342         // light, particles, etc
 343         int effects;
 344         // qw CTF flags and other internal-use-only effect bits
 345         int internaleffects;
 346         // for Alias models
 347         int skinnum;
 348         // render flags
 349         int flags;
 350
 351         // colormod tinting of models
 352         float colormod[3];
 353         float glowmod[3];
 354
 355         // interpolated animation - active framegroups and blend factors
 356         framegroupblend_t framegroupblend[MAX_FRAMEGROUPBLENDS];
 357
 358         // time of last model change (for shader animations)
 359         double shadertime;
 360
 361         // calculated by the renderer (but not persistent)
 362
 363         // calculated during R_AddModelEntities
 364         vec3_t mins, maxs;
 365         // subframe numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use subframeblend[0].subframe
 366         frameblend_t frameblend[MAX_FRAMEBLENDS];
 367         // skeletal animation data (if skeleton.relativetransforms is not NULL, it overrides frameblend)
 368         skeleton_t *skeleton;
 369
 370         // animation cache (pointers allocated using R_FrameData_Alloc)
 371         // ONLY valid during R_RenderView!  may be NULL (not cached)
 372         float *animcache_vertex3f;
 373         float *animcache_normal3f;
 374         float *animcache_svector3f;
 375         float *animcache_tvector3f;
 376         // interleaved arrays for rendering and dynamic vertex buffers for them
 377         r_meshbuffer_t *animcache_vertex3fbuffer;
 378         r_vertexmesh_t *animcache_vertexmesh;
 379         r_meshbuffer_t *animcache_vertexmeshbuffer;
 380
 381         // current lighting from map (updated ONLY by client code, not renderer)
 382         vec3_t modellight_ambient;
 383         vec3_t modellight_diffuse; // q3bsp
 384         vec3_t modellight_lightdir; // q3bsp
 385
 386         // storage of decals on this entity
 387         // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
 388         int allowdecals;
 389         decalsystem_t decalsystem;
 390
 391         // FIELDS UPDATED BY RENDERER:
 392         // last time visible during trace culling
 393         double last_trace_visibility;
 394
 395         // user wavefunc parameters (from csqc)
 396         float userwavefunc_param[Q3WAVEFUNC_USER_COUNT];
 397 }
 398 entity_render_t;
 399
 400 typedef struct entity_persistent_s
 401 {
 402         vec3_t trail_origin;
 403
 404         // particle trail
 405         float trail_time;
 406         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
 407
 408         // muzzleflash fading
 409         float muzzleflash;
 410
 411         // interpolated movement
 412
 413         // start time of move
 414         float lerpstarttime;
 415         // time difference from start to end of move
 416         float lerpdeltatime;
 417         // the move itself, start and end
 418         float oldorigin[3];
 419         float oldangles[3];
 420         float neworigin[3];
 421         float newangles[3];
 422 }
 423 entity_persistent_t;
 424
 425 typedef struct entity_s
 426 {
 427         // baseline state (default values)
 428         entity_state_t state_baseline;
 429         // previous state (interpolating from this)
 430         entity_state_t state_previous;
 431         // current state (interpolating to this)
 432         entity_state_t state_current;
 433
 434         // used for regenerating parts of render
 435         entity_persistent_t persistent;
 436
 437         // the only data the renderer should know about
 438         entity_render_t render;
 439 }
 440 entity_t;
 441
 442 typedef struct usercmd_s
 443 {
 444         vec3_t  viewangles;
 445
 446 // intended velocities
 447         float   forwardmove;
 448         float   sidemove;
 449         float   upmove;
 450
 451         vec3_t  cursor_screen;
 452         vec3_t  cursor_start;
 453         vec3_t  cursor_end;
 454         vec3_t  cursor_impact;
 455         vec3_t  cursor_normal;
 456         vec_t   cursor_fraction;
 457         int             cursor_entitynumber;
 458
 459         double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
 460         double receivetime; // time the move was received at
 461         double clienttime; // time to which server state the move corresponds to
 462         int msec; // for predicted moves
 463         int buttons;
 464         int impulse;
 465         int sequence;
 466         qboolean applied; // if false we're still accumulating a move
 467         qboolean predicted; // if true the sequence should be sent as 0
 468
 469         // derived properties
 470         double frametime;
 471         qboolean canjump;
 472         qboolean jump;
 473         qboolean crouch;
 474 } usercmd_t;
 475
 476 typedef struct lightstyle_s
 477 {
 478         int             length;
 479         char    map[MAX_STYLESTRING];
 480 } lightstyle_t;
 481
 482 typedef struct scoreboard_s
 483 {
 484         char    name[MAX_SCOREBOARDNAME];
 485         int             frags;
 486         int             colors; // two 4 bit fields
 487         // QW fields:
 488         int             qw_userid;
 489         char    qw_userinfo[MAX_USERINFO_STRING];
 490         float   qw_entertime;
 491         int             qw_ping;
 492         int             qw_packetloss;
 493         int             qw_movementloss;
 494         int             qw_spectator;
 495         char    qw_team[8];
 496         char    qw_skin[MAX_QPATH];
 497 } scoreboard_t;
 498
 499 typedef struct cshift_s
 500 {
 501         float   destcolor[3];
 502         float   percent;                // 0-255
 503         float   alphafade;      // (any speed)
 504 } cshift_t;
 505
 506 #define CSHIFT_CONTENTS 0
 507 #define CSHIFT_DAMAGE   1
 508 #define CSHIFT_BONUS    2
 509 #define CSHIFT_POWERUP  3
 510 #define CSHIFT_VCSHIFT  4
 511 #define NUM_CSHIFTS             5
 512
 513 #define NAME_LENGTH     64
 514
 515
 516 //
 517 // client_state_t should hold all pieces of the client state
 518 //
 519
 520 #define SIGNONS         4                       // signon messages to receive before connected
 521
 522 typedef enum cactive_e
 523 {
 524         ca_uninitialized,       // during early startup
 525         ca_dedicated,           // a dedicated server with no ability to start a client
 526         ca_disconnected,        // full screen console with no connection
 527         ca_connected            // valid netcon, talking to a server
 528 }
 529 cactive_t;
 530
 531 typedef enum qw_downloadtype_e
 532 {
 533         dl_none,
 534         dl_single,
 535         dl_skin,
 536         dl_model,
 537         dl_sound
 538 }
 539 qw_downloadtype_t;
 540
 541 typedef enum capturevideoformat_e
 542 {
 543         CAPTUREVIDEOFORMAT_AVI_I420,
 544         CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA
 545 }
 546 capturevideoformat_t;
 547
 548 typedef struct capturevideostate_s
 549 {
 550         double startrealtime;
 551         double framerate;
 552         int framestep;
 553         int framestepframe;
 554         qboolean active;
 555         qboolean realtime;
 556         qboolean error;
 557         int soundrate;
 558         int soundchannels;
 559         int frame;
 560         double starttime;
 561         double lastfpstime;
 562         int lastfpsframe;
 563         int soundsampleframe;
 564         unsigned char *screenbuffer;
 565         unsigned char *outbuffer;
 566         char basename[MAX_QPATH];
 567         int width, height;
 568
 569         // precomputed RGB to YUV tables
 570         // converts the RGB values to YUV (see cap_avi.c for how to use them)
 571         short rgbtoyuvscaletable[3][3][256];
 572         unsigned char yuvnormalizetable[3][256];
 573
 574         // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
 575         // note: to map from these values to RGB24, you have to multiply by 255.0/65535.0, then add 0.5, then cast to integer
 576         unsigned short vidramp[256 * 3];
 577
 578         // stuff to be filled in by the video format module
 579         capturevideoformat_t format;
 580         const char *formatextension;
 581         qfile_t *videofile;
 582                 // always use this:
 583                 //   cls.capturevideo.videofile = FS_OpenRealFile(va(vabuf, sizeof(vabuf), "%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
 584         void (*endvideo) (void);
 585         void (*videoframes) (int num);
 586         void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
 587
 588         // format specific data
 589         void *formatspecific;
 590 }
 591 capturevideostate_t;
 592
 593 #define CL_MAX_DOWNLOADACKS 4
 594
 595 typedef struct cl_downloadack_s
 596 {
 597         int start, size;
 598 }
 599 cl_downloadack_t;
 600
 601 typedef struct cl_soundstats_s
 602 {
 603         int mixedsounds;
 604         int totalsounds;
 605         int latency_milliseconds;
 606 }
 607 cl_soundstats_t;
 608
 609 //
 610 // the client_static_t structure is persistent through an arbitrary number
 611 // of server connections
 612 //
 613 typedef struct client_static_s
 614 {
 615         cactive_t state;
 616
 617         // all client memory allocations go in these pools
 618         mempool_t *levelmempool;
 619         mempool_t *permanentmempool;
 620
 621 // demo loop control
 622         // -1 = don't play demos
 623         int demonum;
 624         // list of demos in loop
 625         char demos[MAX_DEMOS][MAX_DEMONAME];
 626         // the actively playing demo (set by CL_PlayDemo_f)
 627         char demoname[MAX_QPATH];
 628
 629 // demo recording info must be here, because record is started before
 630 // entering a map (and clearing client_state_t)
 631         qboolean demorecording;
 632         fs_offset_t demo_lastcsprogssize;
 633         int demo_lastcsprogscrc;
 634         qboolean demoplayback;
 635         qboolean timedemo;
 636         // -1 = use normal cd track
 637         int forcetrack;
 638         qfile_t *demofile;
 639         // realtime at second frame of timedemo (LordHavoc: changed to double)
 640         double td_starttime;
 641         int td_frames; // total frames parsed
 642         double td_onesecondnexttime;
 643         double td_onesecondframes;
 644         double td_onesecondrealtime;
 645         double td_onesecondminfps;
 646         double td_onesecondmaxfps;
 647         double td_onesecondavgfps;
 648         int td_onesecondavgcount;
 649         // LordHavoc: pausedemo
 650         qboolean demopaused;
 651
 652         // sound mixer statistics for showsound display
 653         cl_soundstats_t soundstats;
 654
 655         qboolean connect_trying;
 656         int connect_remainingtries;
 657         double connect_nextsendtime;
 658         lhnetsocket_t *connect_mysocket;
 659         lhnetaddress_t connect_address;
 660         // protocol version of the server we're connected to
 661         // (kept outside client_state_t because it's used between levels)
 662         protocolversion_t protocol;
 663
 664 #define MAX_RCONS 16
 665         int rcon_trying;
 666         lhnetaddress_t rcon_addresses[MAX_RCONS];
 667         char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
 668         double rcon_timeout[MAX_RCONS];
 669         int rcon_ringpos;
 670
 671 // connection information
 672         // 0 to SIGNONS
 673         int signon;
 674         // network connection
 675         netconn_t *netcon;
 676
 677         // download information
 678         // (note: qw_download variables are also used)
 679         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
 680
 681         // input sequence numbers are not reset on level change, only connect
 682         int movesequence;
 683         int servermovesequence;
 684
 685         // quakeworld stuff below
 686
 687         // value of "qport" cvar at time of connection
 688         int qw_qport;
 689         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
 690         int qw_incoming_sequence;
 691         int qw_outgoing_sequence;
 692
 693         // current file download buffer (only saved when file is completed)
 694         char qw_downloadname[MAX_QPATH];
 695         unsigned char *qw_downloadmemory;
 696         int qw_downloadmemorycursize;
 697         int qw_downloadmemorymaxsize;
 698         int qw_downloadnumber;
 699         int qw_downloadpercent;
 700         qw_downloadtype_t qw_downloadtype;
 701         // transfer rate display
 702         double qw_downloadspeedtime;
 703         int qw_downloadspeedcount;
 704         int qw_downloadspeedrate;
 705         qboolean qw_download_deflate;
 706
 707         // current file upload buffer (for uploading screenshots to server)
 708         unsigned char *qw_uploaddata;
 709         int qw_uploadsize;
 710         int qw_uploadpos;
 711
 712         // user infostring
 713         // this normally contains the following keys in quakeworld:
 714         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
 715         char userinfo[MAX_USERINFO_STRING];
 716
 717         // extra user info for the "connect" command
 718         char connect_userinfo[MAX_USERINFO_STRING];
 719
 720         // video capture stuff
 721         capturevideostate_t capturevideo;
 722
 723         // crypto channel
 724         crypto_t crypto;
 725
 726         // ProQuake compatibility stuff
 727         int proquake_servermod; // 0 = not proquake, 1 = proquake
 728         int proquake_serverversion; // actual proquake server version * 10 (3.40 = 34, etc)
 729         int proquake_serverflags; // 0 (PQF_CHEATFREE not supported)
 730 }
 731 client_static_t;
 732
 733 extern client_static_t  cls;
 734
 735 typedef struct client_movementqueue_s
 736 {
 737         double time;
 738         float frametime;
 739         int sequence;
 740         float viewangles[3];
 741         float move[3];
 742         qboolean jump;
 743         qboolean crouch;
 744         qboolean canjump;
 745 }
 746 client_movementqueue_t;
 747
 748 //[515]: csqc
 749 typedef struct
 750 {
 751         qboolean drawworld;
 752         qboolean drawenginesbar;
 753         qboolean drawcrosshair;
 754 }csqc_vidvars_t;
 755
 756 typedef enum
 757 {
 758         PARTICLE_BILLBOARD = 0,
 759         PARTICLE_SPARK = 1,
 760         PARTICLE_ORIENTED_DOUBLESIDED = 2,
 761         PARTICLE_VBEAM = 3,
 762         PARTICLE_HBEAM = 4,
 763         PARTICLE_INVALID = -1
 764 }
 765 porientation_t;
 766
 767 typedef enum
 768 {
 769         PBLEND_ALPHA = 0,
 770         PBLEND_ADD = 1,
 771         PBLEND_INVMOD = 2,
 772         PBLEND_INVALID = -1
 773 }
 774 pblend_t;
 775
 776 typedef struct particletype_s
 777 {
 778         pblend_t blendmode;
 779         porientation_t orientation;
 780         qboolean lighting;
 781 }
 782 particletype_t;
 783
 784 typedef enum ptype_e
 785 {
 786         pt_dead, 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
 787 }
 788 ptype_t;
 789
 790 typedef struct decal_s
 791 {
 792         // fields used by rendering:  (44 bytes)
 793         unsigned short  typeindex;
 794         unsigned short  texnum;
 795         int                             decalsequence;
 796         vec3_t                  org;
 797         vec3_t                  normal;
 798         float                   size;
 799         float                   alpha; // 0-255
 800         unsigned char   color[3];
 801         unsigned char   unused1;
 802         int                             clusterindex; // cheap culling by pvs
 803
 804         // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
 805         float                   time2; // used for decal fade
 806         unsigned int    owner; // decal stuck to this entity
 807         dp_model_t                      *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
 808         vec3_t                  relativeorigin; // decal at this location in entity's coordinate space
 809         vec3_t                  relativenormal; // decal oriented this way relative to entity's coordinate space
 810 }
 811 decal_t;
 812
 813 typedef struct particle_s
 814 {
 815         // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
 816
 817         // fields used by rendering: (48 bytes)
 818         vec3_t          sortorigin; // sort by this group origin, not particle org
 819         vec3_t          org;
 820         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
 821         float           size;
 822         float           alpha; // 0-255
 823         float           stretch; // only for sparks
 824
 825         // fields not used by rendering:  (44 bytes)
 826         float           stainsize;
 827         float           stainalpha;
 828         float           sizeincrease; // rate of size change per second
 829         float           alphafade; // how much alpha reduces per second
 830         float           time2; // used for snow fluttering and decal fade
 831         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)
 832         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
 833         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
 834         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
 835 //      float           delayedcollisions; // time that p->bounce becomes active
 836         float           delayedspawn; // time that particle appears and begins moving
 837         float           die; // time when this particle should be removed, regardless of alpha
 838
 839         // short variables grouped to save memory (4 bytes)
 840         short                   angle; // base rotation of particle
 841         short                   spin; // geometry rotation speed around the particle center normal
 842
 843         // byte variables grouped to save memory (12 bytes)
 844         unsigned char   color[3];
 845         unsigned char   qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
 846         unsigned char   typeindex;
 847         unsigned char   blendmode;
 848         unsigned char   orientation;
 849         unsigned char   texnum;
 850         unsigned char   staincolor[3];
 851         signed char     staintexnum;
 852 }
 853 particle_t;
 854
 855 typedef enum cl_parsingtextmode_e
 856 {
 857         CL_PARSETEXTMODE_NONE,
 858         CL_PARSETEXTMODE_PING,
 859         CL_PARSETEXTMODE_STATUS,
 860         CL_PARSETEXTMODE_STATUS_PLAYERID,
 861         CL_PARSETEXTMODE_STATUS_PLAYERIP
 862 }
 863 cl_parsingtextmode_t;
 864
 865 typedef struct cl_locnode_s
 866 {
 867         struct cl_locnode_s *next;
 868         char *name;
 869         vec3_t mins, maxs;
 870 }
 871 cl_locnode_t;
 872
 873 typedef struct showlmp_s
 874 {
 875         qboolean        isactive;
 876         float           x;
 877         float           y;
 878         char            label[32];
 879         char            pic[128];
 880 }
 881 showlmp_t;
 882
 883 //
 884 // the client_state_t structure is wiped completely at every
 885 // server signon
 886 //
 887 typedef struct client_state_s
 888 {
 889         // true if playing in a local game and no one else is connected
 890         int islocalgame;
 891
 892         // send a clc_nop periodically until connected
 893         float sendnoptime;
 894
 895         // current input being accumulated by mouse/joystick/etc input
 896         usercmd_t cmd;
 897         // latest moves sent to the server that have not been confirmed yet
 898         usercmd_t movecmd[CL_MAX_USERCMDS];
 899
 900 // information for local display
 901         // health, etc
 902         int stats[MAX_CL_STATS];
 903         float *statsf; // points to stats[] array
 904         // last known inventory bit flags, for blinking
 905         int olditems;
 906         // cl.time of acquiring item, for blinking
 907         float item_gettime[32];
 908         // last known STAT_ACTIVEWEAPON
 909         int activeweapon;
 910         // cl.time of changing STAT_ACTIVEWEAPON
 911         float weapontime;
 912         // use pain anim frame if cl.time < this
 913         float faceanimtime;
 914         // for stair smoothing
 915         float stairsmoothz;
 916         double stairsmoothtime;
 917
 918         // color shifts for damage, powerups
 919         cshift_t cshifts[NUM_CSHIFTS];
 920         // and content types
 921         cshift_t prev_cshifts[NUM_CSHIFTS];
 922
 923 // the client maintains its own idea of view angles, which are
 924 // sent to the server each frame.  The server sets punchangle when
 925 // the view is temporarily offset, and an angle reset commands at the start
 926 // of each level and after teleporting.
 927
 928         // mviewangles is read from demo
 929         // viewangles is either client controlled or lerped from mviewangles
 930         vec3_t mviewangles[2], viewangles;
 931         // update by server, used by qc to do weapon recoil
 932         vec3_t mpunchangle[2], punchangle;
 933         // update by server, can be used by mods to kick view around
 934         vec3_t mpunchvector[2], punchvector;
 935         // update by server, used for lean+bob (0 is newest)
 936         vec3_t mvelocity[2], velocity;
 937         // update by server, can be used by mods for zooming
 938         vec_t mviewzoom[2], viewzoom;
 939         // if true interpolation the mviewangles and other interpolation of the
 940         // player is disabled until the next network packet
 941         // this is used primarily by teleporters, and when spectating players
 942         // special checking of the old fixangle[1] is used to differentiate
 943         // between teleporting and spectating
 944         qboolean fixangle[2];
 945
 946         // client movement simulation
 947         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
 948         // set by CL_ClientMovement_Replay functions
 949         qboolean movement_predicted;
 950         // if true the CL_ClientMovement_Replay function will update origin, etc
 951         qboolean movement_replay;
 952         // simulated data (this is valid even if cl.movement is false)
 953         vec3_t movement_origin;
 954         vec3_t movement_velocity;
 955         // whether the replay should allow a jump at the first sequence
 956         qboolean movement_replay_canjump;
 957
 958         // previous gun angles (for leaning effects)
 959         vec3_t gunangles_prev;
 960         vec3_t gunangles_highpass;
 961         vec3_t gunangles_adjustment_lowpass;
 962         vec3_t gunangles_adjustment_highpass;
 963         // previous gun angles (for leaning effects)
 964         vec3_t gunorg_prev;
 965         vec3_t gunorg_highpass;
 966         vec3_t gunorg_adjustment_lowpass;
 967         vec3_t gunorg_adjustment_highpass;
 968
 969 // pitch drifting vars
 970         float idealpitch;
 971         float pitchvel;
 972         qboolean nodrift;
 973         float driftmove;
 974         double laststop;
 975
 976 //[515]: added for csqc purposes
 977         float sensitivityscale;
 978         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
 979         qboolean csqc_wantsmousemove;
 980         qboolean csqc_paused; // vortex: int because could be flags
 981         struct model_s *csqc_model_precache[MAX_MODELS];
 982
 983         // local amount for smoothing stepups
 984         //float crouch;
 985
 986         // sent by server
 987         qboolean paused;
 988         qboolean onground;
 989         qboolean inwater;
 990
 991         // used by bob
 992         qboolean oldonground;
 993         double lastongroundtime;
 994         double hitgroundtime;
 995         float bob2_smooth;
 996         float bobfall_speed;
 997         float bobfall_swing;
 998
 999         // don't change view angle, full screen, etc
1000         int intermission;
1001         // latched at intermission start
1002         double completed_time;
1003
1004         // the timestamp of the last two messages
1005         double mtime[2];
1006
1007         // clients view of time, time should be between mtime[0] and mtime[1] to
1008         // generate a lerp point for other data, oldtime is the previous frame's
1009         // value of time, frametime is the difference between time and oldtime
1010         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
1011         // is only forcefully limited when a packet is received
1012         double time, oldtime;
1013         // how long it has been since the previous client frame in real time
1014         // (not game time, for that use cl.time - cl.oldtime)
1015         double realframetime;
1016
1017         // fade var for fading while dead
1018         float deathfade;
1019
1020         // motionblur alpha level variable
1021         float motionbluralpha;
1022
1023         // copy of realtime from last recieved message, for net trouble icon
1024         float last_received_message;
1025
1026 // information that is static for the entire time connected to a server
1027         struct model_s *model_precache[MAX_MODELS];
1028         struct sfx_s *sound_precache[MAX_SOUNDS];
1029
1030         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
1031         char model_name[MAX_MODELS][MAX_QPATH];
1032         char sound_name[MAX_SOUNDS][MAX_QPATH];
1033
1034         // for display on solo scoreboard
1035         char worldmessage[40]; // map title (not related to filename)
1036         // variants of map name
1037         char worldbasename[MAX_QPATH]; // %s
1038         char worldname[MAX_QPATH]; // maps/%s.bsp
1039         char worldnamenoextension[MAX_QPATH]; // maps/%s
1040         // cl_entitites[cl.viewentity] = player
1041         int viewentity;
1042         // the real player entity (normally same as viewentity,
1043         // different than viewentity if mod uses chasecam or other tricks)
1044         int realplayerentity;
1045         // this is updated to match cl.viewentity whenever it is in the clients
1046         // range, basically this is used in preference to cl.realplayerentity for
1047         // most purposes because when spectating another player it should show
1048         // their information rather than yours
1049         int playerentity;
1050         // max players that can be in this game
1051         int maxclients;
1052         // type of game (deathmatch, coop, singleplayer)
1053         int gametype;
1054
1055         // models and sounds used by engine code (particularly cl_parse.c)
1056         dp_model_t *model_bolt;
1057         dp_model_t *model_bolt2;
1058         dp_model_t *model_bolt3;
1059         dp_model_t *model_beam;
1060         sfx_t *sfx_wizhit;
1061         sfx_t *sfx_knighthit;
1062         sfx_t *sfx_tink1;
1063         sfx_t *sfx_ric1;
1064         sfx_t *sfx_ric2;
1065         sfx_t *sfx_ric3;
1066         sfx_t *sfx_r_exp3;
1067         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1068         qboolean foundtalk2wav;
1069
1070 // refresh related state
1071
1072         // cl_entitites[0].model
1073         struct model_s *worldmodel;
1074
1075         // the gun model
1076         entity_t viewent;
1077
1078         // cd audio
1079         int cdtrack, looptrack;
1080
1081 // frag scoreboard
1082
1083         // [cl.maxclients]
1084         scoreboard_t *scores;
1085
1086         // keep track of svc_print parsing state (analyzes ping reports and status reports)
1087         cl_parsingtextmode_t parsingtextmode;
1088         int parsingtextplayerindex;
1089         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1090         // (which could eat the wrong ping report if the player issues one
1091         //  manually, but they would still see a ping report, just a later one
1092         //  caused by the scoreboard code rather than the one they intentionally
1093         //  issued)
1094         int parsingtextexpectingpingforscores;
1095
1096         // entity database stuff
1097         // latest received entity frame numbers
1098 #define LATESTFRAMENUMS 32
1099         int latestframenumsposition;
1100         int latestframenums[LATESTFRAMENUMS];
1101         int latestsendnums[LATESTFRAMENUMS];
1102         entityframe_database_t *entitydatabase;
1103         entityframe4_database_t *entitydatabase4;
1104         entityframeqw_database_t *entitydatabaseqw;
1105
1106         // keep track of quake entities because they need to be killed if they get stale
1107         int lastquakeentity;
1108         unsigned char isquakeentity[MAX_EDICTS];
1109
1110         // bounding boxes for clientside movement
1111         vec3_t playerstandmins;
1112         vec3_t playerstandmaxs;
1113         vec3_t playercrouchmins;
1114         vec3_t playercrouchmaxs;
1115
1116         // old decals are killed based on this
1117         int decalsequence;
1118
1119         int max_entities;
1120         int max_csqcrenderentities;
1121         int max_static_entities;
1122         int max_effects;
1123         int max_beams;
1124         int max_dlights;
1125         int max_lightstyle;
1126         int max_brushmodel_entities;
1127         int max_particles;
1128         int max_decals;
1129         int max_showlmps;
1130
1131         entity_t *entities;
1132         entity_render_t *csqcrenderentities;
1133         unsigned char *entities_active;
1134         entity_t *static_entities;
1135         cl_effect_t *effects;
1136         beam_t *beams;
1137         dlight_t *dlights;
1138         lightstyle_t *lightstyle;
1139         int *brushmodel_entities;
1140         particle_t *particles;
1141         decal_t *decals;
1142         showlmp_t *showlmps;
1143
1144         int num_entities;
1145         int num_static_entities;
1146         int num_brushmodel_entities;
1147         int num_effects;
1148         int num_beams;
1149         int num_dlights;
1150         int num_particles;
1151         int num_decals;
1152         int num_showlmps;
1153
1154         double particles_updatetime;
1155         double decals_updatetime;
1156         int free_particle;
1157         int free_decal;
1158
1159         // cl_serverextension_download feature
1160         int loadmodel_current;
1161         int downloadmodel_current;
1162         int loadmodel_total;
1163         int loadsound_current;
1164         int downloadsound_current;
1165         int loadsound_total;
1166         qboolean downloadcsqc;
1167         qboolean loadcsqc;
1168         qboolean loadbegun;
1169         qboolean loadfinished;
1170
1171         // quakeworld stuff
1172
1173         // local copy of the server infostring
1174         char qw_serverinfo[MAX_SERVERINFO_STRING];
1175
1176         // time of last qw "pings" command sent to server while showing scores
1177         double last_ping_request;
1178
1179         // used during connect
1180         int qw_servercount;
1181
1182         // updated from serverinfo
1183         int qw_teamplay;
1184
1185         // unused: indicates whether the player is spectating
1186         // use cl.scores[cl.playerentity-1].qw_spectator instead
1187         //qboolean qw_spectator;
1188
1189         // last time an input packet was sent
1190         double lastpackettime;
1191
1192         // movement parameters for client prediction
1193         unsigned int moveflags;
1194         float movevars_wallfriction;
1195         float movevars_waterfriction;
1196         float movevars_friction;
1197         float movevars_timescale;
1198         float movevars_gravity;
1199         float movevars_stopspeed;
1200         float movevars_maxspeed;
1201         float movevars_spectatormaxspeed;
1202         float movevars_accelerate;
1203         float movevars_airaccelerate;
1204         float movevars_wateraccelerate;
1205         float movevars_entgravity;
1206         float movevars_jumpvelocity;
1207         float movevars_edgefriction;
1208         float movevars_maxairspeed;
1209         float movevars_stepheight;
1210         float movevars_airaccel_qw;
1211         float movevars_airaccel_qw_stretchfactor;
1212         float movevars_airaccel_sideways_friction;
1213         float movevars_airstopaccelerate;
1214         float movevars_airstrafeaccelerate;
1215         float movevars_maxairstrafespeed;
1216         float movevars_airstrafeaccel_qw;
1217         float movevars_aircontrol;
1218         float movevars_aircontrol_power;
1219         float movevars_aircontrol_penalty;
1220         float movevars_warsowbunny_airforwardaccel;
1221         float movevars_warsowbunny_accel;
1222         float movevars_warsowbunny_topspeed;
1223         float movevars_warsowbunny_turnaccel;
1224         float movevars_warsowbunny_backtosideratio;
1225         float movevars_ticrate;
1226         float movevars_airspeedlimit_nonqw;
1227
1228         // models used by qw protocol
1229         int qw_modelindex_spike;
1230         int qw_modelindex_player;
1231         int qw_modelindex_flag;
1232         int qw_modelindex_s_explod;
1233
1234         vec3_t qw_intermission_origin;
1235         vec3_t qw_intermission_angles;
1236
1237         // 255 is the most nails the QW protocol could send
1238         int qw_num_nails;
1239         vec_t qw_nails[255][6];
1240
1241         float qw_weaponkick;
1242
1243         int qw_validsequence;
1244
1245         int qw_deltasequence[QW_UPDATE_BACKUP];
1246
1247         // csqc stuff:
1248         // server entity number corresponding to a clientside entity
1249         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1250         qboolean csqc_loaded;
1251         vec3_t csqc_vieworigin;
1252         vec3_t csqc_viewangles;
1253         vec3_t csqc_vieworiginfromengine;
1254         vec3_t csqc_viewanglesfromengine;
1255         matrix4x4_t csqc_viewmodelmatrixfromengine;
1256         qboolean csqc_usecsqclistener;
1257         matrix4x4_t csqc_listenermatrix;
1258         char csqc_printtextbuf[MAX_INPUTLINE];
1259
1260         // collision culling data
1261         world_t world;
1262
1263         // loc file stuff (points and boxes describing locations in the level)
1264         cl_locnode_t *locnodes;
1265         // this is updated to cl.movement_origin whenever health is < 1
1266         // used by %d print in say/say_team messages if cl_locs_enable is on
1267         vec3_t lastdeathorigin;
1268
1269         // processing buffer used by R_BuildLightMap, reallocated as needed,
1270         // freed on each level change
1271         size_t buildlightmapmemorysize;
1272         unsigned char *buildlightmapmemory;
1273
1274         // used by EntityState5_ReadUpdate
1275         skeleton_t *engineskeletonobjects;
1276 }
1277 client_state_t;
1278
1279 //
1280 // cvars
1281 //
1282 extern cvar_t cl_name;
1283 extern cvar_t cl_color;
1284 extern cvar_t cl_rate;
1285 extern cvar_t cl_pmodel;
1286 extern cvar_t cl_playermodel;
1287 extern cvar_t cl_playerskin;
1288
1289 extern cvar_t rcon_password;
1290 extern cvar_t rcon_address;
1291
1292 extern cvar_t cl_upspeed;
1293 extern cvar_t cl_forwardspeed;
1294 extern cvar_t cl_backspeed;
1295 extern cvar_t cl_sidespeed;
1296
1297 extern cvar_t cl_movespeedkey;
1298
1299 extern cvar_t cl_yawspeed;
1300 extern cvar_t cl_pitchspeed;
1301
1302 extern cvar_t cl_anglespeedkey;
1303
1304 extern cvar_t cl_autofire;
1305
1306 extern cvar_t cl_shownet;
1307 extern cvar_t cl_nolerp;
1308 extern cvar_t cl_nettimesyncfactor;
1309 extern cvar_t cl_nettimesyncboundmode;
1310 extern cvar_t cl_nettimesyncboundtolerance;
1311
1312 extern cvar_t cl_pitchdriftspeed;
1313 extern cvar_t lookspring;
1314 extern cvar_t lookstrafe;
1315 extern cvar_t sensitivity;
1316
1317 extern cvar_t freelook;
1318
1319 extern cvar_t m_pitch;
1320 extern cvar_t m_yaw;
1321 extern cvar_t m_forward;
1322 extern cvar_t m_side;
1323
1324 extern cvar_t cl_autodemo;
1325 extern cvar_t cl_autodemo_nameformat;
1326 extern cvar_t cl_autodemo_delete;
1327
1328 extern cvar_t r_draweffects;
1329
1330 extern cvar_t cl_explosions_alpha_start;
1331 extern cvar_t cl_explosions_alpha_end;
1332 extern cvar_t cl_explosions_size_start;
1333 extern cvar_t cl_explosions_size_end;
1334 extern cvar_t cl_explosions_lifetime;
1335 extern cvar_t cl_stainmaps;
1336 extern cvar_t cl_stainmaps_clearonload;
1337
1338 extern cvar_t cl_prydoncursor;
1339 extern cvar_t cl_prydoncursor_notrace;
1340
1341 extern cvar_t cl_locs_enable;
1342
1343 extern client_state_t cl;
1344
1345 extern void CL_AllocLightFlash (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);
1346
1347 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1348 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1349
1350 //=============================================================================
1351
1352 //
1353 // cl_main
1354 //
1355
1356 void CL_Shutdown (void);
1357 void CL_Init (void);
1358
1359 void CL_EstablishConnection(const char *host, int firstarg);
1360
1361 void CL_Disconnect (void);
1362 void CL_Disconnect_f (void);
1363
1364 void CL_UpdateRenderEntity(entity_render_t *ent);
1365 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1366 void CL_UpdateViewEntities(void);
1367
1368 //
1369 // cl_input
1370 //
1371 typedef struct kbutton_s
1372 {
1373         int             down[2];                // key nums holding it down
1374         int             state;                  // low bit is down state
1375 }
1376 kbutton_t;
1377
1378 extern  kbutton_t       in_mlook, in_klook;
1379 extern  kbutton_t       in_strafe;
1380 extern  kbutton_t       in_speed;
1381
1382 void CL_InitInput (void);
1383 void CL_SendMove (void);
1384
1385 void CL_ValidateState(entity_state_t *s);
1386 void CL_MoveLerpEntityStates(entity_t *ent);
1387 void CL_LerpUpdate(entity_t *e);
1388 void CL_ParseTEnt (void);
1389 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1390 void CL_RelinkBeams (void);
1391 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1392 void CL_ClientMovement_Replay(void);
1393
1394 void CL_ClearTempEntities (void);
1395 entity_render_t *CL_NewTempEntity (double shadertime);
1396
1397 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1398
1399 void CL_ClearState (void);
1400 void CL_ExpandEntities(int num);
1401 void CL_ExpandCSQCRenderEntities(int num);
1402 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1403
1404
1405 void CL_UpdateWorld (void);
1406 void CL_WriteToServer (void);
1407 void CL_Input (void);
1408 extern int cl_ignoremousemoves;
1409
1410
1411 float CL_KeyState (kbutton_t *key);
1412 const char *Key_KeynumToString (int keynum, char *buf, size_t buflength);
1413 int Key_StringToKeynum (const char *str);
1414
1415 //
1416 // cl_demo.c
1417 //
1418 void CL_StopPlayback(void);
1419 void CL_ReadDemoMessage(void);
1420 void CL_WriteDemoMessage(sizebuf_t *mesage);
1421
1422 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1423 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1424
1425 void CL_NextDemo(void);
1426 void CL_Stop_f(void);
1427 void CL_Record_f(void);
1428 void CL_PlayDemo_f(void);
1429 void CL_TimeDemo_f(void);
1430
1431 //
1432 // cl_parse.c
1433 //
1434 void CL_Parse_Init(void);
1435 void CL_Parse_Shutdown(void);
1436 void CL_ParseServerMessage(void);
1437 void CL_Parse_DumpPacket(void);
1438 void CL_Parse_ErrorCleanUp(void);
1439 void QW_CL_StartUpload(unsigned char *data, int size);
1440 extern cvar_t qport;
1441 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1442
1443 //
1444 // view
1445 //
1446 void V_StartPitchDrift (void);
1447 void V_StopPitchDrift (void);
1448
1449 void V_Init (void);
1450 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1451 void V_UpdateBlends (void);
1452 void V_ParseDamage (void);
1453
1454 //
1455 // cl_part
1456 //
1457
1458 extern cvar_t cl_particles;
1459 extern cvar_t cl_particles_quality;
1460 extern cvar_t cl_particles_size;
1461 extern cvar_t cl_particles_quake;
1462 extern cvar_t cl_particles_blood;
1463 extern cvar_t cl_particles_blood_alpha;
1464 extern cvar_t cl_particles_blood_decal_alpha;
1465 extern cvar_t cl_particles_blood_decal_scalemin;
1466 extern cvar_t cl_particles_blood_decal_scalemax;
1467 extern cvar_t cl_particles_blood_bloodhack;
1468 extern cvar_t cl_particles_bulletimpacts;
1469 extern cvar_t cl_particles_explosions_sparks;
1470 extern cvar_t cl_particles_explosions_shell;
1471 extern cvar_t cl_particles_rain;
1472 extern cvar_t cl_particles_snow;
1473 extern cvar_t cl_particles_smoke;
1474 extern cvar_t cl_particles_smoke_alpha;
1475 extern cvar_t cl_particles_smoke_alphafade;
1476 extern cvar_t cl_particles_sparks;
1477 extern cvar_t cl_particles_bubbles;
1478 extern cvar_t cl_decals;
1479 extern cvar_t cl_decals_time;
1480 extern cvar_t cl_decals_fadetime;
1481
1482 void CL_Particles_Clear(void);
1483 void CL_Particles_Init(void);
1484 void CL_Particles_Shutdown(void);
1485 particle_t *CL_NewParticle(const vec3_t sortorigin, unsigned short ptypeindex, int pcolor1, int pcolor2, int ptex, float psize, float psizeincrease, float palpha, float palphafade, float pgravity, float pbounce, float px, float py, float pz, float pvx, float pvy, float pvz, float pairfriction, float pliquidfriction, float originjitter, float velocityjitter, qboolean pqualityreduction, float lifetime, float stretch, pblend_t blendmode, porientation_t orientation, int staincolor1, int staincolor2, int staintex, float stainalpha, float stainsize, float angle, float spin, float tint[4]);
1486
1487 typedef enum effectnameindex_s
1488 {
1489         EFFECT_NONE,
1490         EFFECT_TE_GUNSHOT,
1491         EFFECT_TE_GUNSHOTQUAD,
1492         EFFECT_TE_SPIKE,
1493         EFFECT_TE_SPIKEQUAD,
1494         EFFECT_TE_SUPERSPIKE,
1495         EFFECT_TE_SUPERSPIKEQUAD,
1496         EFFECT_TE_WIZSPIKE,
1497         EFFECT_TE_KNIGHTSPIKE,
1498         EFFECT_TE_EXPLOSION,
1499         EFFECT_TE_EXPLOSIONQUAD,
1500         EFFECT_TE_TAREXPLOSION,
1501         EFFECT_TE_TELEPORT,
1502         EFFECT_TE_LAVASPLASH,
1503         EFFECT_TE_SMALLFLASH,
1504         EFFECT_TE_FLAMEJET,
1505         EFFECT_EF_FLAME,
1506         EFFECT_TE_BLOOD,
1507         EFFECT_TE_SPARK,
1508         EFFECT_TE_PLASMABURN,
1509         EFFECT_TE_TEI_G3,
1510         EFFECT_TE_TEI_SMOKE,
1511         EFFECT_TE_TEI_BIGEXPLOSION,
1512         EFFECT_TE_TEI_PLASMAHIT,
1513         EFFECT_EF_STARDUST,
1514         EFFECT_TR_ROCKET,
1515         EFFECT_TR_GRENADE,
1516         EFFECT_TR_BLOOD,
1517         EFFECT_TR_WIZSPIKE,
1518         EFFECT_TR_SLIGHTBLOOD,
1519         EFFECT_TR_KNIGHTSPIKE,
1520         EFFECT_TR_VORESPIKE,
1521         EFFECT_TR_NEHAHRASMOKE,
1522         EFFECT_TR_NEXUIZPLASMA,
1523         EFFECT_TR_GLOWTRAIL,
1524         EFFECT_SVC_PARTICLE,
1525         EFFECT_TOTAL
1526 }
1527 effectnameindex_t;
1528
1529 int CL_ParticleEffectIndexForName(const char *name);
1530 const char *CL_ParticleEffectNameForIndex(int i);
1531 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);
1532 void CL_ParticleTrail(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, qboolean spawndlight, qboolean spawnparticles, float tintmins[4], float tintmaxs[4]);
1533 void CL_ParseParticleEffect (void);
1534 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);
1535 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1536 void CL_EntityParticles (const entity_t *ent);
1537 void CL_ParticleExplosion (const vec3_t org);
1538 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1539 void R_NewExplosion(const vec3_t org);
1540
1541 void Debug_PolygonBegin(const char *picname, int flags);
1542 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1543 void Debug_PolygonEnd(void);
1544
1545 #include "cl_screen.h"
1546
1547 extern qboolean sb_showscores;
1548
1549 float RSurf_FogVertex(const vec3_t p);
1550 float RSurf_FogPoint(const vec3_t p);
1551
1552 typedef struct r_refdef_stats_s
1553 {
1554         int renders;
1555         int entities;
1556         int entities_surfaces;
1557         int entities_triangles;
1558         int world_leafs;
1559         int world_portals;
1560         int world_surfaces;
1561         int world_triangles;
1562         int lightmapupdates;
1563         int lightmapupdatepixels;
1564         int particles;
1565         int drawndecals;
1566         int totaldecals;
1567         int draws;
1568         int draws_vertices;
1569         int draws_elements;
1570         int lights;
1571         int lights_clears;
1572         int lights_scissored;
1573         int lights_lighttriangles;
1574         int lights_shadowtriangles;
1575         int lights_dynamicshadowtriangles;
1576         int bouncegrid_lights;
1577         int bouncegrid_particles;
1578         int bouncegrid_traces;
1579         int bouncegrid_hits;
1580         int bouncegrid_splats;
1581         int bouncegrid_bounces;
1582         int collisioncache_animated;
1583         int collisioncache_cached;
1584         int collisioncache_traced;
1585         int bloom;
1586         int bloom_copypixels;
1587         int bloom_drawpixels;
1588         int indexbufferuploadcount;
1589         int indexbufferuploadsize;
1590         int vertexbufferuploadcount;
1591         int vertexbufferuploadsize;
1592         int framedatacurrent;
1593         int framedatasize;
1594 }
1595 r_refdef_stats_t;
1596
1597 typedef enum r_viewport_type_e
1598 {
1599         R_VIEWPORTTYPE_ORTHO,
1600         R_VIEWPORTTYPE_PERSPECTIVE,
1601         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1602         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1603         R_VIEWPORTTYPE_TOTAL
1604 }
1605 r_viewport_type_t;
1606
1607 typedef struct r_viewport_s
1608 {
1609         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1610         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1611         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1612         int x;
1613         int y;
1614         int z;
1615         int width;
1616         int height;
1617         int depth;
1618         r_viewport_type_t type;
1619         float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1620 }
1621 r_viewport_t;
1622
1623 typedef struct r_refdef_view_s
1624 {
1625         // view information (changes multiple times per frame)
1626         // if any of these variables change then r_refdef.viewcache must be regenerated
1627         // by calling R_View_Update
1628         // (which also updates viewport, scissor, colormask)
1629
1630         // it is safe and expected to copy this into a structure on the stack and
1631         // call the renderer recursively, then restore from the stack afterward
1632         // (as long as R_View_Update is called)
1633
1634         // eye position information
1635         matrix4x4_t matrix, inverse_matrix;
1636         vec3_t origin;
1637         vec3_t forward;
1638         vec3_t left;
1639         vec3_t right;
1640         vec3_t up;
1641         int numfrustumplanes;
1642         mplane_t frustum[6];
1643         qboolean useclipplane;
1644         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1645         mplane_t clipplane;
1646         float frustum_x, frustum_y;
1647         vec3_t frustumcorner[4];
1648         // if turned off it renders an ortho view
1649         int useperspective;
1650         float ortho_x, ortho_y;
1651
1652         // screen area to render in
1653         int x;
1654         int y;
1655         int z;
1656         int width;
1657         int height;
1658         int depth;
1659         r_viewport_t viewport; // note: if r_viewscale is used, the viewport.width and viewport.height may be less than width and height
1660
1661         // which color components to allow (for anaglyph glasses)
1662         int colormask[4];
1663
1664         // global RGB color multiplier for rendering
1665         float colorscale;
1666
1667         // whether to call R_ClearScreen before rendering stuff
1668         qboolean clear;
1669         // if true, don't clear or do any post process effects (bloom, etc)
1670         qboolean isoverlay;
1671
1672         // whether to draw r_showtris and such, this is only true for the main
1673         // view render, all secondary renders (mirrors, portals, cameras,
1674         // distortion effects, etc) omit such debugging information
1675         qboolean showdebug;
1676
1677         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1678         int cullface_front;
1679         int cullface_back;
1680
1681         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1682         float quality;
1683 }
1684 r_refdef_view_t;
1685
1686 typedef struct r_refdef_viewcache_s
1687 {
1688         // updated by gl_main_newmap()
1689         int maxentities;
1690         int world_numclusters;
1691         int world_numclusterbytes;
1692         int world_numleafs;
1693         int world_numsurfaces;
1694
1695         // these properties are generated by R_View_Update()
1696
1697         // which entities are currently visible for this viewpoint
1698         // (the used range is 0...r_refdef.scene.numentities)
1699         unsigned char *entityvisible;
1700
1701         // flag arrays used for visibility checking on world model
1702         // (all other entities have no per-surface/per-leaf visibility checks)
1703         unsigned char *world_pvsbits;
1704         unsigned char *world_leafvisible;
1705         unsigned char *world_surfacevisible;
1706         // if true, the view is currently in a leaf without pvs data
1707         qboolean world_novis;
1708 }
1709 r_refdef_viewcache_t;
1710
1711 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1712 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1713 typedef struct r_refdef_scene_s {
1714         // whether to call S_ExtraUpdate during render to reduce sound chop
1715         qboolean extraupdate;
1716
1717         // (client gameworld) time for rendering time based effects
1718         double time;
1719
1720         // the world
1721         entity_render_t *worldentity;
1722
1723         // same as worldentity->model
1724         dp_model_t *worldmodel;
1725
1726         // renderable entities (excluding world)
1727         entity_render_t **entities;
1728         int numentities;
1729         int maxentities;
1730
1731         // field of temporary entities that is reset each (client) frame
1732         entity_render_t *tempentities;
1733         int numtempentities;
1734         int maxtempentities;
1735         qboolean expandtempentities;
1736
1737         // renderable dynamic lights
1738         rtlight_t *lights[MAX_DLIGHTS];
1739         rtlight_t templights[MAX_DLIGHTS];
1740         int numlights;
1741
1742         // intensities for light styles right now, controls rtlights
1743         float rtlightstylevalue[MAX_LIGHTSTYLES];       // float fraction of base light value
1744         // 8.8bit fixed point intensities for light styles
1745         // controls intensity lightmap layers
1746         unsigned short lightstylevalue[MAX_LIGHTSTYLES];        // 8.8 fraction of base light value
1747
1748         float ambient;
1749
1750         qboolean rtworld;
1751         qboolean rtworldshadows;
1752         qboolean rtdlight;
1753         qboolean rtdlightshadows;
1754 } r_refdef_scene_t;
1755
1756 typedef struct r_refdef_s
1757 {
1758         // these fields define the basic rendering information for the world
1759         // but not the view, which could change multiple times in one rendered
1760         // frame (for example when rendering textures for certain effects)
1761
1762         // these are set for water warping before
1763         // frustum_x/frustum_y are calculated
1764         float frustumscale_x, frustumscale_y;
1765
1766         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1767         r_refdef_view_t view;
1768         r_refdef_viewcache_t viewcache;
1769
1770         // minimum visible distance (pixels closer than this disappear)
1771         double nearclip;
1772         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1773         // in 32bpp an infinite-farclip matrix is used instead)
1774         double farclip;
1775
1776         // fullscreen color blend
1777         float viewblend[4];
1778
1779         r_refdef_scene_t scene;
1780
1781         float fogplane[4];
1782         float fogplaneviewdist;
1783         qboolean fogplaneviewabove;
1784         float fogheightfade;
1785         float fogcolor[3];
1786         float fogrange;
1787         float fograngerecip;
1788         float fogmasktabledistmultiplier;
1789 #define FOGMASKTABLEWIDTH 1024
1790         float fogmasktable[FOGMASKTABLEWIDTH];
1791         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1792         float fog_density;
1793         float fog_red;
1794         float fog_green;
1795         float fog_blue;
1796         float fog_alpha;
1797         float fog_start;
1798         float fog_end;
1799         float fog_height;
1800         float fog_fadedepth;
1801         qboolean fogenabled;
1802         qboolean oldgl_fogenable;
1803
1804         // new flexible texture height fog (overrides normal fog)
1805         char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1806         unsigned char *fog_height_table1d;
1807         unsigned char *fog_height_table2d;
1808         int fog_height_tablesize; // enable
1809         float fog_height_tablescale;
1810         float fog_height_texcoordscale;
1811         char fogheighttexturename[64]; // detects changes to active fog height texture
1812
1813         int draw2dstage; // 0 = no, 1 = yes, other value = needs setting up again
1814
1815         // true during envmap command capture
1816         qboolean envmap;
1817
1818         // brightness of world lightmaps and related lighting
1819         // (often reduced when world rtlights are enabled)
1820         float lightmapintensity;
1821         // whether to draw world lights realtime, dlights realtime, and their shadows
1822         float polygonfactor;
1823         float polygonoffset;
1824         float shadowpolygonfactor;
1825         float shadowpolygonoffset;
1826
1827         // how long R_RenderView took on the previous frame
1828         double lastdrawscreentime;
1829
1830         // rendering stats for r_speeds display
1831         // (these are incremented in many places)
1832         r_refdef_stats_t stats;
1833 }
1834 r_refdef_t;
1835
1836 extern r_refdef_t r_refdef;
1837
1838 // warpzone prediction hack (CSQC builtin)
1839 void CL_RotateMoves(const matrix4x4_t *m);
1840
1841 void CL_NewFrameReceived(int num);
1842 void CL_ParseEntityLump(char *entitystring);
1843 void CL_FindNonSolidLocation(const vec3_t in, vec3_t out, vec_t radius);
1844 void CL_RelinkLightFlashes(void);
1845 void Sbar_ShowFPS(void);
1846 void Sbar_ShowFPS_Update(void);
1847 void Host_SaveConfig(void);
1848 void Host_LoadConfig_f(void);
1849 void CL_UpdateMoveVars(void);
1850 void SCR_CaptureVideo_SoundFrame(const portable_sampleframe_t *paintbuffer, size_t length);
1851 void V_DriftPitch(void);
1852 void V_FadeViewFlashs(void);
1853 void V_CalcViewBlend(void);
1854 void V_CalcRefdef(void);
1855 void CL_Locs_Reload_f(void);
1856
1857 #endif
1858