e8fa52f498ad8f6396d7e1f71ca16316397c2267
[xonotic/darkplaces.git] / protocol.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 // protocol.h -- communications protocols
21
22 #ifndef PROTOCOL_H
23 #define PROTOCOL_H
24
25 // LordHavoc: I own protocol ranges 96, 97, 3500-3599
26
27 // quake or darkplaces extended quake entity protocol
28 // (still used by TomazQuake and others)
29 #define PROTOCOL_QUAKE 15
30
31 // neh_gl entity protocol
32 // (failed QSG protocol, used only by nehahra movie)
33 #define PROTOCOL_NEHAHRAMOVIE 250
34
35 // entityframe protocol
36 #define PROTOCOL_DARKPLACES1 96
37 #define PROTOCOL_DARKPLACES2 97
38
39 // entityframe4 protocol
40 #define PROTOCOL_DARKPLACES3 3500
41 #define PROTOCOL_DARKPLACES4 3501
42
43 // entityframe5 protocol
44 #define PROTOCOL_DARKPLACES5 3502
45
46 // model effects
47 #define EF_ROCKET       1                       // leave a trail
48 #define EF_GRENADE      2                       // leave a trail
49 #define EF_GIB          4                       // leave a trail
50 #define EF_ROTATE       8                       // rotate (bonus items)
51 #define EF_TRACER       16                      // green split trail
52 #define EF_ZOMGIB       32                      // small blood trail
53 #define EF_TRACER2      64                      // orange split trail + rotate
54 #define EF_TRACER3      128                     // purple trail
55 // entity effects
56 #define EF_BRIGHTFIELD                  1
57 #define EF_MUZZLEFLASH                  2
58 #define EF_BRIGHTLIGHT                  4
59 #define EF_DIMLIGHT                     8
60 #define EF_NODRAW                               16
61 #define EF_ADDITIVE                             32
62 #define EF_BLUE                                 64
63 #define EF_RED                                  128
64 #define EF_DELTA                                8388608 // LordHavoc: (obsolete) entity is delta compressed to save network bandwidth  (no longer used)
65 #define EF_LOWPRECISION                 4194304 // LordHavoc: entity is low precision (integer coordinates) to save network bandwidth
66 // effects/model (can be used as model flags or entity effects)
67 #define EF_REFLECTIVE                   256             // LordHavoc: shiny metal objects :)  (not currently supported)
68 #define EF_FULLBRIGHT                   512             // LordHavoc: fullbright
69 #define EF_FLAME                                1024    // LordHavoc: on fire
70 #define EF_STARDUST                             2048    // LordHavoc: showering sparks
71 #define EF_NOSHADOW                             4096    // LordHavoc: does not cast a shadow
72
73 #define EF_STEP                                 0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits)
74
75 // flags for the pflags field of entities
76 #define PFLAGS_NOSHADOW                 1
77 #define PFLAGS_CORONA                   2
78 #define PFLAGS_FULLDYNAMIC              128 // must be set or the light fields are ignored
79
80 // if the high bit of the servercmd is set, the low bits are fast update flags:
81 #define U_MOREBITS              (1<<0)
82 #define U_ORIGIN1               (1<<1)
83 #define U_ORIGIN2               (1<<2)
84 #define U_ORIGIN3               (1<<3)
85 #define U_ANGLE2                (1<<4)
86 // LordHavoc: U_NOLERP was only ever used for monsters, so I renamed it U_STEP
87 #define U_STEP                  (1<<5)
88 #define U_FRAME                 (1<<6)
89 // just differentiates from other updates
90 #define U_SIGNAL                (1<<7)
91
92 #define U_ANGLE1                (1<<8)
93 #define U_ANGLE3                (1<<9)
94 #define U_MODEL                 (1<<10)
95 #define U_COLORMAP              (1<<11)
96 #define U_SKIN                  (1<<12)
97 #define U_EFFECTS               (1<<13)
98 #define U_LONGENTITY    (1<<14)
99
100 // LordHavoc: protocol extension
101 #define U_EXTEND1               (1<<15)
102 // LordHavoc: first extend byte
103 #define U_DELTA                 (1<<16) // no data, while this is set the entity is delta compressed (uses previous frame as a baseline, meaning only things that have changed from the previous frame are sent, except for the forced full update every half second)
104 #define U_ALPHA                 (1<<17) // 1 byte, 0.0-1.0 maps to 0-255, not sent if exactly 1, and the entity is not sent if <=0 unless it has effects (model effects are checked as well)
105 #define U_SCALE                 (1<<18) // 1 byte, scale / 16 positive, not sent if 1.0
106 #define U_EFFECTS2              (1<<19) // 1 byte, this is .effects & 0xFF00 (second byte)
107 #define U_GLOWSIZE              (1<<20) // 1 byte, encoding is float/4.0, unsigned, not sent if 0
108 #define U_GLOWCOLOR             (1<<21) // 1 byte, palette index, default is 254 (white), this IS used for darklight (allowing colored darklight), however the particles from a darklight are always black, not sent if default value (even if glowsize or glowtrail is set)
109 // LordHavoc: colormod feature has been removed, because no one used it
110 #define U_COLORMOD              (1<<22) // 1 byte, 3 bit red, 3 bit green, 2 bit blue, this lets you tint an object artifically, so you could make a red rocket, or a blue fiend...
111 #define U_EXTEND2               (1<<23) // another byte to follow
112 // LordHavoc: second extend byte
113 #define U_GLOWTRAIL             (1<<24) // leaves a trail of particles (of color .glowcolor, or black if it is a negative glowsize)
114 #define U_VIEWMODEL             (1<<25) // attachs the model to the view (origin and angles become relative to it), only shown to owner, a more powerful alternative to .weaponmodel and such
115 #define U_FRAME2                (1<<26) // 1 byte, this is .frame & 0xFF00 (second byte)
116 #define U_MODEL2                (1<<27) // 1 byte, this is .modelindex & 0xFF00 (second byte)
117 #define U_EXTERIORMODEL (1<<28) // causes this model to not be drawn when using a first person view (third person will draw it, first person will not)
118 #define U_UNUSED29              (1<<29) // future expansion
119 #define U_UNUSED30              (1<<30) // future expansion
120 #define U_EXTEND3               (1<<31) // another byte to follow, future expansion
121
122 #define SU_VIEWHEIGHT   (1<<0)
123 #define SU_IDEALPITCH   (1<<1)
124 #define SU_PUNCH1               (1<<2)
125 #define SU_PUNCH2               (1<<3)
126 #define SU_PUNCH3               (1<<4)
127 #define SU_VELOCITY1    (1<<5)
128 #define SU_VELOCITY2    (1<<6)
129 #define SU_VELOCITY3    (1<<7)
130 //define        SU_AIMENT               (1<<8)  AVAILABLE BIT
131 #define SU_ITEMS                (1<<9)
132 #define SU_ONGROUND             (1<<10)         // no data follows, the bit is it
133 #define SU_INWATER              (1<<11)         // no data follows, the bit is it
134 #define SU_WEAPONFRAME  (1<<12)
135 #define SU_ARMOR                (1<<13)
136 #define SU_WEAPON               (1<<14)
137 #define SU_EXTEND1              (1<<15)
138 // first extend byte
139 #define SU_PUNCHVEC1    (1<<16)
140 #define SU_PUNCHVEC2    (1<<17)
141 #define SU_PUNCHVEC3    (1<<18)
142 #define SU_VIEWZOOM             (1<<19) // byte factor (0 = 0.0 (not valid), 255 = 1.0)
143 #define SU_UNUSED20             (1<<20)
144 #define SU_UNUSED21             (1<<21)
145 #define SU_UNUSED22             (1<<22)
146 #define SU_EXTEND2              (1<<23) // another byte to follow, future expansion
147 // second extend byte
148 #define SU_UNUSED24             (1<<24)
149 #define SU_UNUSED25             (1<<25)
150 #define SU_UNUSED26             (1<<26)
151 #define SU_UNUSED27             (1<<27)
152 #define SU_UNUSED28             (1<<28)
153 #define SU_UNUSED29             (1<<29)
154 #define SU_UNUSED30             (1<<30)
155 #define SU_EXTEND3              (1<<31) // another byte to follow, future expansion
156
157 // a sound with no channel is a local only sound
158 #define SND_VOLUME              (1<<0)          // a byte
159 #define SND_ATTENUATION (1<<1)          // a byte
160 #define SND_LOOPING             (1<<2)          // a long
161 #define SND_LARGEENTITY (1<<3)          // a short and a byte (instead of a short)
162 #define SND_LARGESOUND  (1<<4)          // a short (instead of a byte)
163
164
165 // defaults for clientinfo messages
166 #define DEFAULT_VIEWHEIGHT      22
167
168
169 // game types sent by serverinfo
170 // these determine which intermission screen plays
171 #define GAME_COOP                       0
172 #define GAME_DEATHMATCH         1
173
174 //==================
175 // note that there are some defs.qc that mirror to these numbers
176 // also related to svc_strings[] in cl_parse
177 //==================
178
179 //
180 // server to client
181 //
182 #define svc_bad                         0
183 #define svc_nop                         1
184 #define svc_disconnect          2
185 #define svc_updatestat          3       // [byte] [long]
186 #define svc_version                     4       // [long] server version
187 #define svc_setview                     5       // [short] entity number
188 #define svc_sound                       6       // <see code>
189 #define svc_time                        7       // [float] server time
190 #define svc_print                       8       // [string] null terminated string
191 #define svc_stufftext           9       // [string] stuffed into client's console buffer
192                                                                 // the string should be \n terminated
193 #define svc_setangle            10      // [angle3] set the view angle to this absolute value
194
195 #define svc_serverinfo          11      // [long] version
196                                                 // [string] signon string
197                                                 // [string]..[0]model cache
198                                                 // [string]...[0]sounds cache
199 #define svc_lightstyle          12      // [byte] [string]
200 #define svc_updatename          13      // [byte] [string]
201 #define svc_updatefrags         14      // [byte] [short]
202 #define svc_clientdata          15      // <shortbits + data>
203 #define svc_stopsound           16      // <see code>
204 #define svc_updatecolors        17      // [byte] [byte]
205 #define svc_particle            18      // [vec3] <variable>
206 #define svc_damage                      19
207
208 #define svc_spawnstatic         20
209 //      svc_spawnbinary         21
210 #define svc_spawnbaseline       22
211
212 #define svc_temp_entity         23
213
214 #define svc_setpause            24      // [byte] on / off
215 #define svc_signonnum           25      // [byte]  used for the signon sequence
216
217 #define svc_centerprint         26      // [string] to put in center of the screen
218
219 #define svc_killedmonster       27
220 #define svc_foundsecret         28
221
222 #define svc_spawnstaticsound    29      // [coord3] [byte] samp [byte] vol [byte] aten
223
224 #define svc_intermission        30              // [string] music
225 #define svc_finale                      31              // [string] music [string] text
226
227 #define svc_cdtrack                     32              // [byte] track [byte] looptrack
228 #define svc_sellscreen          33
229
230 #define svc_cutscene            34
231
232 #define svc_showlmp                     35              // [string] slotname [string] lmpfilename [short] x [short] y
233 #define svc_hidelmp                     36              // [string] slotname
234 #define svc_skybox                      37              // [string] skyname
235
236 // LordHavoc: my svc_ range, 50-59
237 #define svc_cgame                       50              // [short] length [bytes] data
238 #define svc_unusedlh1           51
239 #define svc_effect                      52              // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
240 #define svc_effect2                     53              // [vector] org [short] modelindex [short] startframe [byte] framecount [byte] framerate
241 #define svc_sound2                      54              // short soundindex instead of byte
242 #define svc_spawnbaseline2      55              // short modelindex instead of byte
243 #define svc_spawnstatic2        56              // short modelindex instead of byte
244 #define svc_entities            57              // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata
245 #define svc_unusedlh3                   58
246 #define svc_spawnstaticsound2   59      // [coord3] [short] samp [byte] vol [byte] aten
247
248 //
249 // client to server
250 //
251 #define clc_bad                 0
252 #define clc_nop                 1
253 #define clc_disconnect  2
254 #define clc_move                3                       // [usercmd_t]
255 #define clc_stringcmd   4               // [string] message
256
257 // LordHavoc: my clc_ range, 50-59
258 #define clc_ackentities 50              // [int] framenumber
259 #define clc_unusedlh1   51
260 #define clc_unusedlh2   52
261 #define clc_unusedlh3   53
262 #define clc_unusedlh4   54
263 #define clc_unusedlh5   55
264 #define clc_unusedlh6   56
265 #define clc_unusedlh7   57
266 #define clc_unusedlh8   58
267 #define clc_unusedlh9   59
268
269 //
270 // temp entity events
271 //
272 #define TE_SPIKE                        0 // [vector] origin
273 #define TE_SUPERSPIKE           1 // [vector] origin
274 #define TE_GUNSHOT                      2 // [vector] origin
275 #define TE_EXPLOSION            3 // [vector] origin
276 #define TE_TAREXPLOSION         4 // [vector] origin
277 #define TE_LIGHTNING1           5 // [entity] entity [vector] start [vector] end
278 #define TE_LIGHTNING2           6 // [entity] entity [vector] start [vector] end
279 #define TE_WIZSPIKE                     7 // [vector] origin
280 #define TE_KNIGHTSPIKE          8 // [vector] origin
281 #define TE_LIGHTNING3           9 // [entity] entity [vector] start [vector] end
282 #define TE_LAVASPLASH           10 // [vector] origin
283 #define TE_TELEPORT                     11 // [vector] origin
284 #define TE_EXPLOSION2           12 // [vector] origin [byte] startcolor [byte] colorcount
285
286 // PGM 01/21/97
287 #define TE_BEAM                         13 // [entity] entity [vector] start [vector] end
288 // PGM 01/21/97
289
290 // Nehahra effects used in the movie (TE_EXPLOSION3 also got written up in a QSG tutorial, hence it's not marked NEH)
291 #define TE_EXPLOSION3           16 // [vector] origin [coord] red [coord] green [coord] blue
292 #define TE_LIGHTNING4NEH        17 // [string] model [entity] entity [vector] start [vector] end
293
294 // LordHavoc: added some TE_ codes (block1 - 50-60)
295 #define TE_BLOOD                        50 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
296 #define TE_SPARK                        51 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
297 #define TE_BLOODSHOWER          52 // [vector] min [vector] max [coord] explosionspeed [short] count
298 #define TE_EXPLOSIONRGB         53 // [vector] origin [byte] red [byte] green [byte] blue
299 #define TE_PARTICLECUBE         54 // [vector] min [vector] max [vector] dir [short] count [byte] color [byte] gravity [coord] randomvel
300 #define TE_PARTICLERAIN         55 // [vector] min [vector] max [vector] dir [short] count [byte] color
301 #define TE_PARTICLESNOW         56 // [vector] min [vector] max [vector] dir [short] count [byte] color
302 #define TE_GUNSHOTQUAD          57 // [vector] origin
303 #define TE_SPIKEQUAD            58 // [vector] origin
304 #define TE_SUPERSPIKEQUAD       59 // [vector] origin
305 // LordHavoc: block2 - 70-80
306 #define TE_EXPLOSIONQUAD        70 // [vector] origin
307 #define TE_UNUSED1                      71 // unused
308 #define TE_SMALLFLASH           72 // [vector] origin
309 #define TE_CUSTOMFLASH          73 // [vector] origin [byte] radius / 8 - 1 [byte] lifetime / 256 - 1 [byte] red [byte] green [byte] blue
310 #define TE_FLAMEJET                     74 // [vector] origin [vector] velocity [byte] count
311 #define TE_PLASMABURN           75 // [vector] origin
312 // LordHavoc: Tei grabbed these codes
313 #define TE_TEI_G3                       76 // [vector] start [vector] end [vector] angles
314 #define TE_TEI_SMOKE            77 // [vector] origin [vector] dir [byte] count
315 #define TE_TEI_BIGEXPLOSION     78 // [vector] origin
316 #define TE_TEI_PLASMAHIT        79 // [vector} origin [vector] dir [byte] count
317
318
319 // these are bits for the 'flags' field of the entity_state_t
320 #define RENDER_STEP 1
321 #define RENDER_GLOWTRAIL 2
322 #define RENDER_VIEWMODEL 4
323 #define RENDER_EXTERIORMODEL 8
324 #define RENDER_LOWPRECISION 16 // send as low precision coordinates to save bandwidth
325 #define RENDER_COLORMAPPED 32
326 #define RENDER_SHADOW 64 // cast shadow
327 #define RENDER_LIGHT 128 // receive light
328
329 // this is 80 bytes
330 typedef struct
331 {
332         // ! means this is not sent to client
333         double time; // ! time this state was built (used on client for interpolation)
334         float origin[3];
335         float angles[3];
336         int number; // entity number this state is for
337         int effects;
338         unsigned short modelindex;
339         unsigned short frame;
340         unsigned short tagentity;
341         unsigned short specialvisibilityradius; // ! larger if it has effects/light
342         unsigned short viewmodelforclient; // !
343         unsigned short exteriormodelforclient; // ! not shown if first person viewing from this entity, shown in all other cases
344         unsigned short nodrawtoclient; // !
345         unsigned short drawonlytoclient; // !
346         unsigned short light[4]; // color*256 (0.00 to 255.996), and radius*1
347         unsigned char active; // true if a valid state
348         unsigned char lightstyle;
349         unsigned char lightpflags;
350         unsigned char colormap;
351         unsigned char skin; // also chooses cubemap for rtlights if lightpflags & LIGHTPFLAGS_FULLDYNAMIC
352         unsigned char alpha;
353         unsigned char scale;
354         unsigned char glowsize;
355         unsigned char glowcolor;
356         unsigned char flags;
357         unsigned char tagindex;
358         unsigned char colormod;
359         // padding to a multiple of 8 bytes (to align the double time)
360         unsigned char unused[4];
361 }
362 entity_state_t;
363
364 // baseline state values
365 entity_state_t defaultstate;
366 // reads a quake entity from the network stream
367 void EntityFrameQuake_ReadEntity(int bits);
368 // writes a list of quake entities to the network stream
369 // (or as many will fit)
370 void EntityFrameQuake_WriteFrame(sizebuf_t *msg, int numstates, const entity_state_t *states);
371 // cleans up dead entities each frame after ReadEntity (which doesn't clear unused entities)
372 void EntityFrameQuake_ISeeDeadEntities(void);
373
374 /*
375 PROTOCOL_DARKPLACES3
376 server updates entities according to some (unmentioned) scheme.
377
378 a frame consists of all visible entities, some of which are up to date,
379 often some are not up to date.
380
381 these entities are stored in a range (firstentity/endentity) of structs in the
382 entitydata[] buffer.
383
384 to make a commit the server performs these steps:
385 1. duplicate oldest frame in database (this is the baseline) as new frame, and
386    write frame numbers (oldest frame's number, new frame's number) and eye
387    location to network packet (eye location is obsolete and will be removed in
388    future revisions)
389 2. write an entity change to packet and modify new frame accordingly
390    (this repeats until packet is sufficiently full or new frame is complete)
391 3. write terminator (0xFFFF) to network packet
392    (FIXME: this terminator value conflicts with MAX_EDICTS 32768...)
393
394 to read a commit the client performs these steps:
395 1. reads frame numbers from packet and duplicates baseline frame as new frame,
396    also reads eye location but does nothing with it (obsolete).
397 2. delete frames older than the baseline which was used
398 3. read entity changes from packet until terminator (0xFFFF) is encountered,
399    each change is applied to entity frame.
400 4. sends ack framenumber to server as part of input packet
401
402 if server receives ack message in put packet it performs these steps:
403 1. remove all older frames from database.
404 */
405
406 /*
407 PROTOCOL_DARKPLACES4
408 a frame consists of some visible entities in a range (this is stored as start and end, note that end may be less than start if it wrapped).
409
410 these entities are stored in a range (firstentity/endentity) of structs in the entitydata[] buffer.
411
412 to make a commit the server performs these steps:
413 1. build an entity_frame_t using appropriate functions, containing (some of) the visible entities, this is passed to the Write function to send it.
414
415 This documention is unfinished!
416 the Write function performs these steps:
417 1. check if entity frame is larger than MAX_ENTITYFRAME or is larger than available space in database, if so the baseline is defaults, otherwise it is the current baseline of the database.
418 2. write differences of an entity compared to selected baseline.
419 3. add entity to entity update in database.
420 4. if there are more entities to write and packet is not full, go back to step 2.
421 5. write terminator (0xFFFF) as entity number.
422 6. return.
423
424
425
426
427
428 server updates entities in looping ranges, a frame consists of a range of visible entities (not always all visible entities),
429 */
430
431 typedef struct
432 {
433         double time;
434         int framenum;
435         int firstentity; // index into entitydata, modulo MAX_ENTITY_DATABASE
436         int endentity; // index into entitydata, firstentity + numentities
437 }
438 entity_frameinfo_t;
439
440 #define MAX_ENTITY_HISTORY 64
441 #define MAX_ENTITY_DATABASE (MAX_EDICTS * 2)
442
443 typedef struct
444 {
445         // note: these can be far out of range, modulo with MAX_ENTITY_DATABASE to get a valid range (which may wrap)
446         // start and end of used area, when adding a new update to database, store at endpos, and increment endpos
447         // when removing updates from database, nudge down frames array to only contain useful frames
448         // this logic should explain better:
449         // if (numframes >= MAX_ENTITY_HISTORY || (frames[numframes - 1].endentity - frames[0].firstentity) + entitiestoadd > MAX_ENTITY_DATABASE)
450         //     flushdatabase();
451         // note: if numframes == 0, insert at start (0 in entitydata)
452         // the only reason this system is used is to avoid copying memory when frames are removed
453         int numframes;
454         // server only: last sent frame
455         int latestframenum;
456         // server only: last acknowledged frame
457         int ackframenum;
458         // the current state in the database
459         vec3_t eye;
460         // table of entities in the entityhistorydata
461         entity_frameinfo_t frames[MAX_ENTITY_HISTORY];
462         // entities
463         entity_state_t entitydata[MAX_ENTITY_DATABASE];
464 }
465 entityframe_database_t;
466
467 // build entity data in this, to pass to entity read/write functions
468 typedef struct
469 {
470         double time;
471         int framenum;
472         int numentities;
473         int firstentitynum;
474         int lastentitynum;
475         vec3_t eye;
476         entity_state_t entitydata[MAX_ENTITY_DATABASE];
477 }
478 entity_frame_t;
479
480 // LordHavoc: these are in approximately sorted order, according to cost and
481 // likelyhood of being used for numerous objects in a frame
482
483 // note that the bytes are not written/read in this order, this is only the
484 // order of the bits to minimize overhead from extend bytes
485
486 // enough to describe a nail, gib, shell casing, bullet hole, or rocket
487 #define E_ORIGIN1               (1<<0)
488 #define E_ORIGIN2               (1<<1)
489 #define E_ORIGIN3               (1<<2)
490 #define E_ANGLE1                (1<<3)
491 #define E_ANGLE2                (1<<4)
492 #define E_ANGLE3                (1<<5)
493 #define E_MODEL1                (1<<6)
494 #define E_EXTEND1               (1<<7)
495
496 // enough to describe almost anything
497 #define E_FRAME1                (1<<8)
498 #define E_EFFECTS1              (1<<9)
499 #define E_ALPHA                 (1<<10)
500 #define E_SCALE                 (1<<11)
501 #define E_COLORMAP              (1<<12)
502 #define E_SKIN                  (1<<13)
503 #define E_FLAGS                 (1<<14)
504 #define E_EXTEND2               (1<<15)
505
506 // players, custom color glows, high model numbers
507 #define E_FRAME2                (1<<16)
508 #define E_MODEL2                (1<<17)
509 #define E_EFFECTS2              (1<<18)
510 #define E_GLOWSIZE              (1<<19)
511 #define E_GLOWCOLOR             (1<<20)
512 #define E_LIGHT                 (1<<21)
513 #define E_LIGHTPFLAGS   (1<<22)
514 #define E_EXTEND3               (1<<23)
515
516 #define E_SOUND1                (1<<24)
517 #define E_SOUNDVOL              (1<<25)
518 #define E_SOUNDATTEN    (1<<26)
519 #define E_TAGATTACHMENT (1<<27)
520 #define E_LIGHTSTYLE    (1<<28)
521 #define E_UNUSED6               (1<<29)
522 #define E_UNUSED7               (1<<30)
523 #define E_EXTEND4               (1<<31)
524
525 // returns difference between two states as E_ flags
526 int EntityState_DeltaBits(const entity_state_t *o, const entity_state_t *n);
527 // write E_ flags to a msg
528 void EntityState_WriteExtendBits(sizebuf_t *msg, unsigned int bits);
529 // write values for the E_ flagged fields to a msg
530 void EntityState_WriteFields(const entity_state_t *ent, sizebuf_t *msg, unsigned int bits);
531 // write entity number and E_ flags and their values, or a remove number, describing the change from delta to ent
532 void EntityState_WriteUpdate(const entity_state_t *ent, sizebuf_t *msg, const entity_state_t *delta);
533 // read E_ flags
534 int EntityState_ReadExtendBits(void);
535 // read values for E_ flagged fields and apply them to a state
536 void EntityState_ReadFields(entity_state_t *e, unsigned int bits);
537
538 // (client and server) allocates a new empty database
539 entityframe_database_t *EntityFrame_AllocDatabase(mempool_t *mempool);
540 // (client and server) frees the database
541 void EntityFrame_FreeDatabase(entityframe_database_t *d);
542 // (server) clears the database to contain no frames (thus delta compression
543 // compresses against nothing)
544 void EntityFrame_ClearDatabase(entityframe_database_t *d);
545 // (server and client) removes frames older than 'frame' from database
546 void EntityFrame_AckFrame(entityframe_database_t *d, int frame);
547 // (server) clears frame, to prepare for adding entities
548 void EntityFrame_Clear(entity_frame_t *f, vec3_t eye, int framenum);
549 // (server and client) reads a frame from the database
550 void EntityFrame_FetchFrame(entityframe_database_t *d, int framenum, entity_frame_t *f);
551 // (server and client) adds a entity_frame to the database, for future
552 // reference
553 void EntityFrame_AddFrame(entityframe_database_t *d, vec3_t eye, int framenum, int numentities, const entity_state_t *entitydata);
554 // (server) writes a frame to network stream
555 void EntityFrame_WriteFrame(sizebuf_t *msg, entityframe_database_t *d, int numstates, const entity_state_t *states, int viewentnum);
556 // (client) reads a frame from network stream
557 void EntityFrame_CL_ReadFrame(void);
558 // (client) returns the frame number of the most recent frame recieved
559 int EntityFrame_MostRecentlyRecievedFrameNum(entityframe_database_t *d);
560
561 typedef struct entity_database4_commit_s
562 {
563         // frame number this commit represents
564         int framenum;
565         // number of entities in entity[] array
566         int numentities;
567         // maximum number of entities in entity[] array (dynamic resizing)
568         int maxentities;
569         entity_state_t *entity;
570 }
571 entity_database4_commit_t;
572
573 typedef struct entity_database4_s
574 {
575         // what mempool to use for allocations
576         mempool_t *mempool;
577         // reference frame
578         int referenceframenum;
579         // reference entities array is resized according to demand
580         int maxreferenceentities;
581         // array of states for entities, these are indexable by their entity number (yes there are gaps)
582         entity_state_t *referenceentity;
583         // commits waiting to be applied to the reference database when confirmed
584         // (commit[i]->numentities == 0 means it is empty)
585         entity_database4_commit_t commit[MAX_ENTITY_HISTORY];
586         // (server only) the current commit being worked on
587         entity_database4_commit_t *currentcommit;
588         // (server only) if a commit won't fit entirely, continue where it left
589         // off next frame
590         int currententitynumber;
591         // (server only)
592         int latestframenumber;
593         // (client only) most recently received frame number to be sent in next
594         // input update
595         int ackframenum;
596 }
597 entityframe4_database_t;
598
599 // should-be-private functions that aren't
600 entity_state_t *EntityFrame4_GetReferenceEntity(entityframe4_database_t *d, int number);
601 void EntityFrame4_AddCommitEntity(entityframe4_database_t *d, const entity_state_t *s);
602
603 // allocate a database
604 entityframe4_database_t *EntityFrame4_AllocDatabase(mempool_t *pool);
605 // free a database
606 void EntityFrame4_FreeDatabase(entityframe4_database_t *d);
607 // reset a database (resets compression but does not reallocate anything)
608 void EntityFrame4_ResetDatabase(entityframe4_database_t *d);
609 // updates database to account for a frame-received acknowledgment
610 int EntityFrame4_AckFrame(entityframe4_database_t *d, int framenum);
611 // writes a frame to the network stream
612 void EntityFrame4_WriteFrame(sizebuf_t *msg, entityframe4_database_t *d, int numstates, const entity_state_t *states);
613 // reads a frame from the network stream
614 void EntityFrame4_CL_ReadFrame(void);
615
616 // reset all entity fields (typically used if status changed)
617 #define E5_FULLUPDATE (1<<0)
618 // E5_ORIGIN32=0: short[3] = s->origin[0] * 8, s->origin[1] * 8, s->origin[2] * 8
619 // E5_ORIGIN32=1: float[3] = s->origin[0], s->origin[1], s->origin[2]
620 #define E5_ORIGIN (1<<1)
621 // E5_ANGLES16=0: byte[3] = s->angle[0] * 256 / 360, s->angle[1] * 256 / 360, s->angle[2] * 256 / 360
622 // E5_ANGLES16=1: short[3] = s->angle[0] * 65536 / 360, s->angle[1] * 65536 / 360, s->angle[2] * 65536 / 360
623 #define E5_ANGLES (1<<2)
624 // E5_MODEL16=0: byte = s->modelindex
625 // E5_MODEL16=1: short = s->modelindex
626 #define E5_MODEL (1<<3)
627 // E5_FRAME16=0: byte = s->frame
628 // E5_FRAME16=1: short = s->frame
629 #define E5_FRAME (1<<4)
630 // byte = s->skin
631 #define E5_SKIN (1<<5)
632 // E5_EFFECTS16=0 && E5_EFFECTS32=0: byte = s->effects
633 // E5_EFFECTS16=1 && E5_EFFECTS32=0: short = s->effects
634 // E5_EFFECTS16=0 && E5_EFFECTS32=1: int = s->effects
635 // E5_EFFECTS16=1 && E5_EFFECTS32=1: int = s->effects
636 #define E5_EFFECTS (1<<6)
637 // bits >= (1<<8)
638 #define E5_EXTEND1 (1<<7)
639
640 // byte = s->renderflags
641 #define E5_FLAGS (1<<8)
642 // byte = bound(0, s->alpha * 255, 255)
643 #define E5_ALPHA (1<<9)
644 // byte = bound(0, s->scale * 16, 255)
645 #define E5_SCALE (1<<10)
646 // flag
647 #define E5_ORIGIN32 (1<<11) 
648 // flag
649 #define E5_ANGLES16 (1<<12)
650 // flag
651 #define E5_MODEL16 (1<<13)
652 // byte = s->colormap
653 #define E5_COLORMAP (1<<14)
654 // bits >= (1<<16)
655 #define E5_EXTEND2 (1<<15)
656
657 // short = s->tagentity
658 // byte = s->tagindex
659 #define E5_ATTACHMENT (1<<16)
660 // short[4] = s->light[0], s->light[1], s->light[2], s->light[3]
661 // byte = s->lightstyle
662 // byte = s->lightpflags
663 #define E5_LIGHT (1<<17)
664 // byte = s->glowsize
665 // byte = s->glowcolor
666 #define E5_GLOW (1<<18)
667 // short = s->effects
668 #define E5_EFFECTS16 (1<<19)
669 // int = s->effects
670 #define E5_EFFECTS32 (1<<20)
671 // flag
672 #define E5_FRAME16 (1<<21)
673 // unused
674 #define E5_UNUSED22 (1<<22)
675 // bits >= (1<<24)
676 #define E5_EXTEND3 (1<<23)
677
678 // unused
679 #define E5_UNUSED24 (1<<24)
680 // unused
681 #define E5_UNUSED25 (1<<25)
682 // unused
683 #define E5_UNUSED26 (1<<26)
684 // unused
685 #define E5_UNUSED27 (1<<27)
686 // unused
687 #define E5_UNUSED28 (1<<28)
688 // unused
689 #define E5_UNUSED29 (1<<29)
690 // unused
691 #define E5_UNUSED30 (1<<30)
692 // bits2 > 0
693 #define E5_EXTEND4 (1<<31)
694
695 #define ENTITYFRAME5_MAXPACKETLOGS 64
696 #define ENTITYFRAME5_MAXSTATES 1024
697
698 typedef struct entityframe5_changestate_s
699 {
700         unsigned int number;
701         unsigned int bits;
702 }
703 entityframe5_changestate_t;
704
705 typedef struct entityframe5_packetlog_s
706 {
707         int packetnumber;
708         int numstates;
709         entityframe5_changestate_t states[ENTITYFRAME5_MAXSTATES];
710 }
711 entityframe5_packetlog_t;
712
713 typedef struct entityframe5_database_s
714 {
715         // number of the latest message sent to client
716         int latestframenum;
717         // number of the latest message acknowledged by client
718         int ackframenum;
719
720         // logs of all recently sent messages (between acked and latest)
721         entityframe5_packetlog_t packetlog[ENTITYFRAME5_MAXPACKETLOGS];
722
723         // which properties of each entity have changed since last send
724         int deltabits[MAX_EDICTS];
725         // priorities of entities (updated whenever deltabits change)
726         // (derived from deltabits)
727         qbyte priorities[MAX_EDICTS];
728         // last frame this entity was sent on, for prioritzation
729         int updateframenum[MAX_EDICTS];
730
731         // database of current status of all entities
732         // (FIXME: this is 2.5mb per client even if most is unused!)
733         entity_state_t states[MAX_EDICTS];
734         // which entities are currently active
735         // (duplicate of the active bit of every state in states[])
736         // (derived from states)
737         qbyte visiblebits[(MAX_EDICTS+7)/8];
738
739         // old notes
740
741         // this is used to decide which changestates to set each frame
742         //int numvisiblestates;
743         //entity_state_t visiblestates[MAX_EDICTS];
744
745         // sorted changing states that need to be sent to the client
746         // kept sorted in lowest to highest priority order, because this allows
747         // the numchangestates to simply be decremented whenever an state is sent,
748         // rather than a memmove to remove them from the start.
749         //int numchangestates;
750         //entityframe5_changestate_t changestates[MAX_EDICTS];
751 }
752 entityframe5_database_t;
753
754 entityframe5_database_t *EntityFrame5_AllocDatabase(mempool_t *pool);
755 void EntityFrame5_FreeDatabase(entityframe5_database_t *d);
756 void EntityFrame5_ResetDatabase(entityframe5_database_t *d);
757 int EntityState5_Priority(entityframe5_database_t *d, entity_state_t *view, entity_state_t *s, int changedbits, int age);
758 void EntityState5_WriteUpdate(int number, const entity_state_t *s, int changedbits, sizebuf_t *msg);
759 int EntityState5_DeltaBitsForState(entity_state_t *o, entity_state_t *n);
760 void EntityFrame5_CL_ReadFrame(void);
761 void EntityFrame5_AckFrame(entityframe5_database_t *d, int framenum, int viewentnum);
762 void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int numstates, const entity_state_t *states, int viewentnum);
763
764 extern cvar_t developer_networkentities;
765
766 #endif
767