renamed PROTOCOL_VERSION stuff to PROTOCOL_QUAKE, PROTOCOL_DARKPLACES1, and so on

[xonotic/darkplaces.git] / protocol.h

diff --git a/protocol.h b/protocol.h
index 0256ea3dd0255fc36afd92b80c8b4079f04cff02..d594b03d2b49841335402b1a735ca76b95d74a97 100644 (file)
--- a/protocol.h
+++ b/protocol.h
@@ -22,13 +22,14 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #ifndef PROTOCOL_H
 #define PROTOCOL_H
 
-#define        PROTOCOL_VERSION 15
-#define        DPPROTOCOL_VERSION1 96
-#define        DPPROTOCOL_VERSION2 97
+#define        PROTOCOL_QUAKE 15
+#define        PROTOCOL_NEHAHRAMOVIE 250
+#define        PROTOCOL_DARKPLACES1 96
+#define        PROTOCOL_DARKPLACES2 97
 // LordHavoc: I think the 96-99 range was going to run out too soon...
 // so here I jump to 3500
-#define        DPPROTOCOL_VERSION3 3500
-#define DPPROTOCOL_VERSION4 3501
+#define        PROTOCOL_DARKPLACES3 3500
+#define PROTOCOL_DARKPLACES4 3501
 
 // model effects
 #define        EF_ROCKET       1                       // leave a trail
@@ -335,7 +336,7 @@ typedef struct
 entity_state_t;
 
 /*
-DPPROTOCOL_VERSION3
+PROTOCOL_DARKPLACES3
 server updates entities according to some (unmentioned) scheme.
 
 a frame consists of all visible entities, some of which are up to date,
@@ -367,7 +368,7 @@ if server receives ack message in put packet it performs these steps:
 */
 
 /*
-DPPROTOCOL_VERSION4
+PROTOCOL_DARKPLACES4
 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).
 
 these entities are stored in a range (firstentity/endentity) of structs in the entitydata[] buffer.
@@ -483,7 +484,10 @@ entity_frame_t;
 #define E_UNUSED7              (1<<30)
 #define E_EXTEND4              (1<<31)
 
+// clears a state to baseline values
 void ClearStateToDefault(entity_state_t *s);
+// used by some of the DP protocols
+void EntityState_Write(entity_state_t *ent, sizebuf_t *msg, entity_state_t *delta);
 
 // (server) clears the database to contain no frames (thus delta compression
 // compresses against nothing)
@@ -506,5 +510,66 @@ void EntityFrame_Read(entity_database_t *d);
 // (client) returns the frame number of the most recent frame recieved
 int EntityFrame_MostRecentlyRecievedFrameNum(entity_database_t *d);
 
+typedef struct entity_database4_commit_s
+{
+       // frame number this commit represents
+       int framenum;
+       // number of entities in entity[] array
+       int numentities;
+       // maximum number of entities in entity[] array (dynamic resizing)
+       int maxentities;
+       entity_state_t *entity;
+}
+entity_database4_commit_t;
+
+typedef struct entity_database4_s
+{
+       // what mempool to use for allocations
+       mempool_t *mempool;
+       // reference frame
+       int referenceframenum;
+       // reference entities array is resized according to demand
+       int maxreferenceentities;
+       // array of states for entities, these are indexable by their entity number (yes there are gaps)
+       entity_state_t *referenceentity;
+       // commits waiting to be applied to the reference database when confirmed
+       // (commit[i]->numentities == 0 means it is empty)
+       entity_database4_commit_t commit[MAX_ENTITY_HISTORY];
+       // (server only) the current commit being worked on
+       entity_database4_commit_t *currentcommit;
+       // (server only) if a commit won't fit entirely, continue where it left
+       // off next frame
+       int currententitynumber;
+       // (client only) most recently received frame number to be sent in next
+       // input update
+       int ackframenum;
+}
+entity_database4_t;
+
+// should-be-private functions that aren't
+int EntityFrame4_SV_ChooseCommitToReplace(entity_database4_t *d);
+entity_state_t *EntityFrame4_GetReferenceEntity(entity_database4_t *d, int number);
+void EntityFrame4_AddCommitEntity(entity_database4_t *d, entity_state_t *s);
+
+// allocate a database
+entity_database4_t *EntityFrame4_AllocDatabase(mempool_t *pool);
+// free a database
+void EntityFrame4_FreeDatabase(entity_database4_t *d);
+// reset a database (resets compression but does not reallocate anything)
+void EntityFrame4_ResetDatabase(entity_database4_t *d);
+// updates database to account for a frame-received acknowledgment
+void EntityFrame4_AckFrame(entity_database4_t *d, int framenum);
+
+// begin writing a frame
+void EntityFrame4_SV_WriteFrame_Begin(entity_database4_t *d, sizebuf_t *msg, int framenum);
+// write an entity in the frame
+// returns false if full
+int EntityFrame4_SV_WriteFrame_Entity(entity_database4_t *d, sizebuf_t *msg, int maxbytes, entity_state_t *s);
+// end writing a frame
+void EntityFrame4_SV_WriteFrame_End(entity_database4_t *d, sizebuf_t *msg);
+
+// reads a frame from the network stream
+void EntityFrame4_CL_ReadFrame(entity_database4_t *d);
+
 #endif