1 |
elmex |
1.1 |
/* |
2 |
root |
1.17 |
* CrossFire, A Multiplayer game |
3 |
|
|
* |
4 |
|
|
* Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
5 |
|
|
* Copyright (C) 2001 Mark Wedel |
6 |
|
|
* Copyright (C) 1992 Frank Tore Johansen |
7 |
|
|
* |
8 |
|
|
* This program is free software; you can redistribute it and/or modify |
9 |
|
|
* it under the terms of the GNU General Public License as published by |
10 |
|
|
* the Free Software Foundation; either version 2 of the License, or |
11 |
|
|
* (at your option) any later version. |
12 |
|
|
* |
13 |
|
|
* This program is distributed in the hope that it will be useful, |
14 |
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 |
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 |
|
|
* GNU General Public License for more details. |
17 |
|
|
* |
18 |
|
|
* You should have received a copy of the GNU General Public License |
19 |
|
|
* along with this program; if not, write to the Free Software |
20 |
|
|
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
21 |
|
|
* |
22 |
|
|
* The author can be reached via e-mail to <crossfire@schmorp.de> |
23 |
|
|
*/ |
24 |
elmex |
1.1 |
|
25 |
|
|
/** \file |
26 |
|
|
* Image related communication |
27 |
|
|
* |
28 |
|
|
* \date 2003-12-02 |
29 |
|
|
* |
30 |
|
|
* This file deals with the image related communication to the |
31 |
|
|
* client. I've located all the functions in this file - this |
32 |
|
|
* localizes it more, and means that we don't need to declare |
33 |
|
|
* things like all the structures as globals. |
34 |
|
|
*/ |
35 |
|
|
|
36 |
|
|
#include <global.h> |
37 |
|
|
#include <sproto.h> |
38 |
|
|
|
39 |
root |
1.20 |
#include "crc.h" |
40 |
|
|
|
41 |
elmex |
1.1 |
#define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ |
42 |
|
|
|
43 |
|
|
/** Information about one image */ |
44 |
root |
1.3 |
typedef struct FaceInfo |
45 |
|
|
{ |
46 |
|
|
uint8 *data; /**< image data */ |
47 |
|
|
uint16 datalen; /**< length of the xpm data */ |
48 |
|
|
uint32 checksum; /**< Checksum of face data */ |
49 |
elmex |
1.1 |
} FaceInfo; |
50 |
|
|
|
51 |
|
|
/** Information about one face set */ |
52 |
root |
1.3 |
typedef struct |
53 |
|
|
{ |
54 |
|
|
char *prefix; /**< */ |
55 |
|
|
char *fullname; |
56 |
|
|
|
57 |
|
|
uint8 fallback; /**< faceset to use when an image is not found in this faceset */ |
58 |
|
|
char *size; |
59 |
|
|
char *extension; |
60 |
|
|
char *comment; |
61 |
|
|
|
62 |
|
|
FaceInfo *faces; /**< images in this faceset */ |
63 |
elmex |
1.1 |
} FaceSets; |
64 |
|
|
|
65 |
|
|
static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */ |
66 |
|
|
|
67 |
|
|
/** |
68 |
|
|
* Checks specified faceset is valid |
69 |
|
|
* \param fsn faceset number |
70 |
|
|
*/ |
71 |
root |
1.3 |
int |
72 |
|
|
is_valid_faceset (int fsn) |
73 |
elmex |
1.1 |
{ |
74 |
root |
1.3 |
if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) |
75 |
|
|
return TRUE; |
76 |
|
|
return FALSE; |
77 |
elmex |
1.1 |
} |
78 |
|
|
|
79 |
|
|
/** |
80 |
|
|
* Frees all faceset information |
81 |
|
|
*/ |
82 |
root |
1.3 |
void |
83 |
|
|
free_socket_images (void) |
84 |
elmex |
1.1 |
{ |
85 |
root |
1.3 |
int num, q; |
86 |
elmex |
1.1 |
|
87 |
root |
1.3 |
for (num = 0; num < MAX_FACE_SETS; num++) |
88 |
|
|
{ |
89 |
|
|
if (facesets[num].prefix) |
90 |
|
|
{ |
91 |
root |
1.24 |
for (q = 0; q < faces.size (); q++) |
92 |
root |
1.3 |
if (facesets[num].faces[q].data) |
93 |
|
|
free (facesets[num].faces[q].data); |
94 |
root |
1.15 |
|
95 |
root |
1.3 |
free (facesets[num].prefix); |
96 |
|
|
free (facesets[num].fullname); |
97 |
|
|
free (facesets[num].size); |
98 |
|
|
free (facesets[num].extension); |
99 |
|
|
free (facesets[num].comment); |
100 |
|
|
free (facesets[num].faces); |
101 |
root |
1.2 |
} |
102 |
elmex |
1.1 |
} |
103 |
|
|
} |
104 |
|
|
|
105 |
|
|
/** |
106 |
|
|
* This returns the set we will actually use when sending |
107 |
|
|
* a face. This is used because the image files may be sparse. |
108 |
|
|
* This function is recursive. imageno is the face number we are |
109 |
|
|
* trying to send |
110 |
|
|
* |
111 |
|
|
* If face is not found in specified faceset, tries with 'fallback' faceset. |
112 |
|
|
* |
113 |
|
|
* \param faceset faceset to check |
114 |
|
|
* \param imageno image number |
115 |
|
|
* |
116 |
|
|
*/ |
117 |
root |
1.3 |
static int |
118 |
|
|
get_face_fallback (int faceset, int imageno) |
119 |
elmex |
1.1 |
{ |
120 |
root |
1.3 |
/* faceset 0 is supposed to have every image, so just return. Doing |
121 |
|
|
* so also prevents infinite loops in the case if it not having |
122 |
|
|
* the face, but in that case, we are likely to crash when we try |
123 |
|
|
* to access the data, but that is probably preferable to an infinite |
124 |
|
|
* loop. |
125 |
|
|
*/ |
126 |
|
|
if (faceset == 0) |
127 |
|
|
return 0; |
128 |
|
|
|
129 |
|
|
if (!facesets[faceset].prefix) |
130 |
|
|
{ |
131 |
|
|
LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset); |
132 |
|
|
return 0; /* use default set */ |
133 |
|
|
} |
134 |
root |
1.15 |
|
135 |
root |
1.3 |
if (facesets[faceset].faces[imageno].data) |
136 |
|
|
return faceset; |
137 |
root |
1.15 |
|
138 |
root |
1.3 |
return get_face_fallback (facesets[faceset].fallback, imageno); |
139 |
elmex |
1.1 |
} |
140 |
|
|
|
141 |
|
|
/** |
142 |
|
|
* Checks fallback are correctly defined. |
143 |
|
|
* This is a simple recursive function that makes sure the fallbacks |
144 |
|
|
* are all proper (eg, the fall back to defined sets, and also |
145 |
|
|
* eventually fall back to 0). At the top level, togo is set to MAX_FACE_SETS, |
146 |
|
|
* if togo gets to zero, it means we have a loop. |
147 |
|
|
* This is only run when we first load the facesets. |
148 |
|
|
*/ |
149 |
root |
1.3 |
static void |
150 |
|
|
check_faceset_fallback (int faceset, int togo) |
151 |
elmex |
1.1 |
{ |
152 |
root |
1.3 |
int fallback = facesets[faceset].fallback; |
153 |
elmex |
1.1 |
|
154 |
root |
1.3 |
/* proper case - falls back to base set */ |
155 |
|
|
if (fallback == 0) |
156 |
|
|
return; |
157 |
|
|
|
158 |
|
|
if (!facesets[fallback].prefix) |
159 |
|
|
{ |
160 |
|
|
LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback); |
161 |
|
|
abort (); |
162 |
|
|
} |
163 |
root |
1.15 |
|
164 |
root |
1.3 |
togo--; |
165 |
|
|
if (togo == 0) |
166 |
|
|
{ |
167 |
|
|
LOG (llevError, "Infinite loop found in facesets. aborting.\n"); |
168 |
|
|
abort (); |
169 |
elmex |
1.1 |
} |
170 |
root |
1.15 |
|
171 |
root |
1.3 |
check_faceset_fallback (fallback, togo); |
172 |
elmex |
1.1 |
} |
173 |
|
|
|
174 |
|
|
#define MAX_IMAGE_SIZE 10000 |
175 |
|
|
|
176 |
|
|
/** |
177 |
|
|
* Client tells us what type of faces it wants. Also sets |
178 |
|
|
* the caching attribute. |
179 |
|
|
* |
180 |
|
|
*/ |
181 |
root |
1.3 |
void |
182 |
root |
1.13 |
SetFaceMode (char *buf, int len, client *ns) |
183 |
elmex |
1.1 |
{ |
184 |
root |
1.3 |
int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE); |
185 |
elmex |
1.1 |
|
186 |
root |
1.3 |
if (mode == CF_FACE_NONE) |
187 |
root |
1.7 |
ns->facecache = 1; |
188 |
root |
1.3 |
else if (mode != CF_FACE_PNG) |
189 |
root |
1.14 |
ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png"); |
190 |
root |
1.7 |
|
191 |
root |
1.3 |
if (mask) |
192 |
root |
1.7 |
ns->facecache = 1; |
193 |
elmex |
1.1 |
} |
194 |
|
|
|
195 |
|
|
/** |
196 |
|
|
* Client has requested pixmap that it somehow missed getting. |
197 |
|
|
* This will be called often if the client is |
198 |
|
|
* caching images. |
199 |
|
|
*/ |
200 |
root |
1.3 |
void |
201 |
root |
1.15 |
SendFaceCmd (char *buf, int len, client *ns) |
202 |
elmex |
1.1 |
{ |
203 |
root |
1.28 |
ns->send_face (atoi (buf), 1); |
204 |
elmex |
1.1 |
} |
205 |
|
|
|
206 |
root |
1.24 |
// how lame |
207 |
|
|
static void print_facename (packet &sl, const facedata &d) |
208 |
|
|
{ |
209 |
root |
1.25 |
for (int i = 0; i < CHKSUM_SIZE; ++i) |
210 |
|
|
sl.printf ("%02x", d.chksum [i]); |
211 |
root |
1.24 |
} |
212 |
|
|
|
213 |
root |
1.26 |
// gcfclient uses the server-provided checksum for comparison, |
214 |
|
|
// but always wrotes a broken checksum to its cache file, so we |
215 |
|
|
// have to provide gcfclient with a useless checksum just to |
216 |
|
|
// have to cache the image despite its bugs. |
217 |
|
|
static uint32 gcfclient_checksum (const facedata *d) |
218 |
|
|
{ |
219 |
|
|
uint32 csum = 0; |
220 |
|
|
|
221 |
|
|
for (std::string::const_iterator i = d->data.begin (); |
222 |
|
|
i != d->data.end (); |
223 |
|
|
++i) |
224 |
|
|
{ |
225 |
|
|
csum = rotate_right (csum); |
226 |
|
|
csum += *(uint8 *)&*i; |
227 |
|
|
} |
228 |
|
|
|
229 |
|
|
return csum; |
230 |
|
|
} |
231 |
|
|
|
232 |
elmex |
1.1 |
/** |
233 |
|
|
* Sends a face to a client if they are in pixmap mode |
234 |
|
|
* nothing gets sent in bitmap mode. |
235 |
|
|
* If nocache is true (nonzero), ignore the cache setting from the client - |
236 |
|
|
* this is needed for the askface, in which we really do want to send the |
237 |
|
|
* face (and askface is the only place that should be setting it). Otherwise, |
238 |
|
|
* we look at the facecache, and if set, send the image name. |
239 |
|
|
*/ |
240 |
root |
1.3 |
void |
241 |
root |
1.28 |
client::send_face (faceidx facenum, bool forced) |
242 |
elmex |
1.1 |
{ |
243 |
root |
1.28 |
// never send face 0. ever. it does not exist. |
244 |
|
|
if (!facenum) |
245 |
|
|
return; |
246 |
|
|
|
247 |
|
|
const facedata *d = face_data (facenum, faceset); |
248 |
|
|
|
249 |
|
|
if (!d) |
250 |
root |
1.3 |
{ |
251 |
root |
1.28 |
LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); |
252 |
root |
1.3 |
return; |
253 |
|
|
} |
254 |
|
|
|
255 |
root |
1.8 |
packet sl; |
256 |
root |
1.3 |
|
257 |
root |
1.28 |
if (facecache && !forced) |
258 |
root |
1.3 |
{ |
259 |
root |
1.30 |
if (faces_sent[facenum]) |
260 |
root |
1.28 |
return; |
261 |
|
|
|
262 |
root |
1.30 |
faces_sent[facenum] = true; |
263 |
|
|
|
264 |
|
|
faceinfo *f = face_info (facenum); |
265 |
|
|
if (f->smooth && EMI_smooth) |
266 |
|
|
{ |
267 |
|
|
send_face (f->smooth); |
268 |
|
|
|
269 |
|
|
packet sl ("smooth"); |
270 |
|
|
|
271 |
|
|
sl << uint16 (facenum) |
272 |
|
|
<< uint16 (f->smooth); |
273 |
|
|
|
274 |
|
|
send_packet (sl); |
275 |
|
|
} |
276 |
root |
1.28 |
|
277 |
|
|
if (force_face0) |
278 |
|
|
sl << "face " << uint16 (facenum); |
279 |
|
|
else if (image2) |
280 |
|
|
sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0); |
281 |
root |
1.26 |
else |
282 |
root |
1.28 |
sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0); |
283 |
root |
1.24 |
|
284 |
|
|
// how lame |
285 |
|
|
print_facename (sl, *d); |
286 |
root |
1.3 |
} |
287 |
|
|
else |
288 |
|
|
{ |
289 |
root |
1.28 |
sl << (image2 ? "image2 " : "image ") |
290 |
|
|
<< uint32 (facenum); |
291 |
root |
1.6 |
|
292 |
root |
1.28 |
if (image2) |
293 |
root |
1.24 |
sl << uint8 (0); |
294 |
root |
1.6 |
|
295 |
root |
1.24 |
sl << uint32 (d->data.size ()) |
296 |
|
|
<< data (d->data.data (), d->data.size ()); |
297 |
root |
1.28 |
} |
298 |
|
|
|
299 |
|
|
send_packet (sl); |
300 |
|
|
} |
301 |
|
|
|
302 |
|
|
// send all faces of this object to the client |
303 |
|
|
// this uses more bandwidth initially, but makes |
304 |
|
|
// animations look much smoother, and every client |
305 |
|
|
// is supposed to do client-side caching anyways. |
306 |
|
|
void |
307 |
|
|
client::send_faces (object *ob) |
308 |
|
|
{ |
309 |
|
|
send_face (ob->face); |
310 |
|
|
|
311 |
|
|
if (ob->animation_id) |
312 |
|
|
{ |
313 |
|
|
animation &anim = animations [ob->animation_id]; |
314 |
|
|
|
315 |
|
|
for (int i = 0; i < anim.num_animations; i++) |
316 |
|
|
send_face (anim.faces [i]); |
317 |
|
|
} |
318 |
|
|
} |
319 |
|
|
|
320 |
|
|
/** |
321 |
|
|
* Need to send an animation sequence to the client. |
322 |
|
|
* We will send appropriate face commands to the client if we haven't |
323 |
|
|
* sent them the face yet (this can become quite costly in terms of |
324 |
|
|
* how much we are sending - on the other hand, this should only happen |
325 |
|
|
* when the player logs in and picks stuff up. |
326 |
|
|
*/ |
327 |
|
|
void |
328 |
|
|
client::send_animation (short anim_num) |
329 |
|
|
{ |
330 |
|
|
/* Do some checking on the anim_num we got. Note that the animations |
331 |
|
|
* are added in contigous order, so if the number is in the valid |
332 |
|
|
* range, it must be a valid animation. |
333 |
|
|
*/ |
334 |
|
|
if (anim_num < 0 || anim_num > num_animations) |
335 |
|
|
{ |
336 |
|
|
LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); |
337 |
|
|
return; |
338 |
|
|
} |
339 |
|
|
|
340 |
|
|
packet sl ("anim"); |
341 |
|
|
|
342 |
|
|
sl << uint16 (anim_num) |
343 |
|
|
<< uint16 (0); /* flags - not used right now */ |
344 |
|
|
|
345 |
|
|
/* Build up the list of faces. Also, send any information (ie, the |
346 |
|
|
* the face itself) down to the client. |
347 |
|
|
*/ |
348 |
|
|
for (int i = 0; i < animations[anim_num].num_animations; i++) |
349 |
|
|
{ |
350 |
|
|
send_face (animations[anim_num].faces[i]); |
351 |
|
|
sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ |
352 |
elmex |
1.1 |
} |
353 |
root |
1.6 |
|
354 |
root |
1.28 |
send_packet (sl); |
355 |
|
|
|
356 |
|
|
anims_sent[anim_num] = 1; |
357 |
elmex |
1.1 |
} |
358 |
|
|
|
359 |
|
|
/** |
360 |
|
|
* Sends the number of images, checksum of the face file, |
361 |
|
|
* and the image_info file information. See the doc/Developers/protocol |
362 |
|
|
* if you want further detail. |
363 |
|
|
*/ |
364 |
root |
1.3 |
void |
365 |
root |
1.15 |
send_image_info (client *ns, char *params) |
366 |
elmex |
1.1 |
{ |
367 |
root |
1.8 |
packet sl; |
368 |
elmex |
1.1 |
|
369 |
root |
1.24 |
//TODO: second parameter is a checksum, but it makes no sense in this current framework |
370 |
|
|
sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0); |
371 |
root |
1.6 |
|
372 |
root |
1.24 |
sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n"; |
373 |
elmex |
1.1 |
|
374 |
root |
1.11 |
ns->send_packet (sl); |
375 |
elmex |
1.1 |
} |
376 |
|
|
|
377 |
|
|
/** |
378 |
|
|
* Sends requested face information. |
379 |
|
|
* \param ns socket to send to |
380 |
|
|
* \param params contains first and last index of face |
381 |
|
|
* |
382 |
|
|
* For each image in [start..stop] sends |
383 |
|
|
* - checksum |
384 |
|
|
* - name |
385 |
|
|
*/ |
386 |
root |
1.3 |
void |
387 |
root |
1.15 |
send_image_sums (client *ns, char *params) |
388 |
elmex |
1.1 |
{ |
389 |
root |
1.3 |
int start, stop; |
390 |
pippijn |
1.22 |
char *cp; |
391 |
root |
1.3 |
|
392 |
root |
1.8 |
packet sl; |
393 |
root |
1.3 |
|
394 |
|
|
start = atoi (params); |
395 |
|
|
for (cp = params; *cp != '\0'; cp++) |
396 |
|
|
if (*cp == ' ') |
397 |
|
|
break; |
398 |
|
|
|
399 |
|
|
stop = atoi (cp); |
400 |
root |
1.24 |
if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES) |
401 |
root |
1.3 |
{ |
402 |
root |
1.7 |
sl.printf ("replyinfo image_sums %d %d", start, stop); |
403 |
|
|
ns->send_packet (sl); |
404 |
|
|
sl.reset (); |
405 |
root |
1.3 |
return; |
406 |
|
|
} |
407 |
|
|
|
408 |
root |
1.6 |
sl.printf ("replyinfo image_sums %d %d ", start, stop); |
409 |
root |
1.3 |
|
410 |
root |
1.24 |
for (int i = start; i <= stop && i < faces.size (); i++) |
411 |
root |
1.3 |
{ |
412 |
root |
1.30 |
ns->faces_sent[i] = true; |
413 |
root |
1.3 |
|
414 |
root |
1.24 |
const facedata *d = face_data (i, ns->faceset); |
415 |
root |
1.6 |
|
416 |
root |
1.24 |
if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
417 |
root |
1.23 |
break; |
418 |
|
|
|
419 |
root |
1.6 |
sl << uint16 (i) |
420 |
root |
1.24 |
<< uint32 (0) // checksum |
421 |
|
|
<< uint8 (ns->faceset); |
422 |
|
|
|
423 |
|
|
print_facename (sl, *d); sl << uint8 (0); |
424 |
root |
1.3 |
} |
425 |
root |
1.6 |
|
426 |
root |
1.3 |
/* It would make more sense to catch this pre-emptively in the code above. |
427 |
|
|
* however, if this really happens, we probably just want to cut down the |
428 |
|
|
* size to less than 1000, since that is what we claim the protocol would |
429 |
|
|
* support. |
430 |
|
|
*/ |
431 |
root |
1.23 |
//TODO: taken care of above, should simply abort or make sure the above code is correct |
432 |
root |
1.9 |
if (sl.length () >= MAXSOCKBUF) |
433 |
root |
1.3 |
{ |
434 |
root |
1.9 |
LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF); |
435 |
root |
1.3 |
abort (); |
436 |
elmex |
1.1 |
} |
437 |
root |
1.6 |
|
438 |
root |
1.11 |
ns->send_packet (sl); |
439 |
elmex |
1.1 |
} |
440 |
root |
1.6 |
|