1 | /* |
1 | /* |
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * Copyright (©) 2001,2007 Mark Wedel |
5 | * Copyright (©) 2001,2007 Mark Wedel |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * Crossfire TRT is free software: you can redistribute it and/or modify |
8 | * Deliantra is free software: you can redistribute it and/or modify |
9 | * it under the terms of the GNU General Public License as published by |
9 | * it under the terms of the GNU General Public License as published by |
10 | * the Free Software Foundation, either version 3 of the License, or |
10 | * the Free Software Foundation, either version 3 of the License, or |
11 | * (at your option) any later version. |
11 | * (at your option) any later version. |
12 | * |
12 | * |
13 | * This program is distributed in the hope that it will be useful, |
13 | * This program is distributed in the hope that it will be useful, |
… | |
… | |
16 | * GNU General Public License for more details. |
16 | * GNU General Public License for more details. |
17 | * |
17 | * |
18 | * You should have received a copy of the GNU General Public License |
18 | * You should have received a copy of the GNU General Public License |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 | * |
20 | * |
21 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
21 | * The authors can be reached via e-mail to <support@deliantra.net> |
22 | */ |
22 | */ |
23 | |
23 | |
24 | /** \file |
24 | /** \file |
25 | * Image related communication |
25 | * Image related communication |
26 | * |
26 | * |
… | |
… | |
35 | #include <global.h> |
35 | #include <global.h> |
36 | #include <sproto.h> |
36 | #include <sproto.h> |
37 | |
37 | |
38 | #include "crc.h" |
38 | #include "crc.h" |
39 | |
39 | |
40 | #define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ |
|
|
41 | |
|
|
42 | /** Information about one image */ |
|
|
43 | typedef struct FaceInfo |
|
|
44 | { |
|
|
45 | uint8 *data; /**< image data */ |
|
|
46 | uint16 datalen; /**< length of the xpm data */ |
|
|
47 | uint32 checksum; /**< Checksum of face data */ |
|
|
48 | } FaceInfo; |
|
|
49 | |
|
|
50 | /** Information about one face set */ |
|
|
51 | typedef struct |
|
|
52 | { |
|
|
53 | char *prefix; /**< */ |
|
|
54 | char *fullname; |
|
|
55 | |
|
|
56 | uint8 fallback; /**< faceset to use when an image is not found in this faceset */ |
|
|
57 | char *size; |
|
|
58 | char *extension; |
|
|
59 | char *comment; |
|
|
60 | |
|
|
61 | FaceInfo *faces; /**< images in this faceset */ |
|
|
62 | } FaceSets; |
|
|
63 | |
|
|
64 | static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */ |
|
|
65 | |
|
|
66 | /** |
|
|
67 | * Checks specified faceset is valid |
|
|
68 | * \param fsn faceset number |
|
|
69 | */ |
|
|
70 | int |
|
|
71 | is_valid_faceset (int fsn) |
|
|
72 | { |
|
|
73 | if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) |
|
|
74 | return TRUE; |
|
|
75 | return FALSE; |
|
|
76 | } |
|
|
77 | |
|
|
78 | /** |
|
|
79 | * Frees all faceset information |
|
|
80 | */ |
|
|
81 | void |
|
|
82 | free_socket_images (void) |
|
|
83 | { |
|
|
84 | int num, q; |
|
|
85 | |
|
|
86 | for (num = 0; num < MAX_FACE_SETS; num++) |
|
|
87 | { |
|
|
88 | if (facesets[num].prefix) |
|
|
89 | { |
|
|
90 | for (q = 0; q < faces.size (); q++) |
|
|
91 | if (facesets[num].faces[q].data) |
|
|
92 | free (facesets[num].faces[q].data); |
|
|
93 | |
|
|
94 | free (facesets[num].prefix); |
|
|
95 | free (facesets[num].fullname); |
|
|
96 | free (facesets[num].size); |
|
|
97 | free (facesets[num].extension); |
|
|
98 | free (facesets[num].comment); |
|
|
99 | free (facesets[num].faces); |
|
|
100 | } |
|
|
101 | } |
|
|
102 | } |
|
|
103 | |
|
|
104 | /** |
|
|
105 | * This returns the set we will actually use when sending |
|
|
106 | * a face. This is used because the image files may be sparse. |
|
|
107 | * This function is recursive. imageno is the face number we are |
|
|
108 | * trying to send |
|
|
109 | * |
|
|
110 | * If face is not found in specified faceset, tries with 'fallback' faceset. |
|
|
111 | * |
|
|
112 | * \param faceset faceset to check |
|
|
113 | * \param imageno image number |
|
|
114 | * |
|
|
115 | */ |
|
|
116 | static int |
|
|
117 | get_face_fallback (int faceset, int imageno) |
|
|
118 | { |
|
|
119 | /* faceset 0 is supposed to have every image, so just return. Doing |
|
|
120 | * so also prevents infinite loops in the case if it not having |
|
|
121 | * the face, but in that case, we are likely to crash when we try |
|
|
122 | * to access the data, but that is probably preferable to an infinite |
|
|
123 | * loop. |
|
|
124 | */ |
|
|
125 | if (faceset == 0) |
|
|
126 | return 0; |
|
|
127 | |
|
|
128 | if (!facesets[faceset].prefix) |
|
|
129 | { |
|
|
130 | LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset); |
|
|
131 | return 0; /* use default set */ |
|
|
132 | } |
|
|
133 | |
|
|
134 | if (facesets[faceset].faces[imageno].data) |
|
|
135 | return faceset; |
|
|
136 | |
|
|
137 | return get_face_fallback (facesets[faceset].fallback, imageno); |
|
|
138 | } |
|
|
139 | |
|
|
140 | /** |
|
|
141 | * Checks fallback are correctly defined. |
|
|
142 | * This is a simple recursive function that makes sure the fallbacks |
|
|
143 | * are all proper (eg, the fall back to defined sets, and also |
|
|
144 | * eventually fall back to 0). At the top level, togo is set to MAX_FACE_SETS, |
|
|
145 | * if togo gets to zero, it means we have a loop. |
|
|
146 | * This is only run when we first load the facesets. |
|
|
147 | */ |
|
|
148 | static void |
|
|
149 | check_faceset_fallback (int faceset, int togo) |
|
|
150 | { |
|
|
151 | int fallback = facesets[faceset].fallback; |
|
|
152 | |
|
|
153 | /* proper case - falls back to base set */ |
|
|
154 | if (fallback == 0) |
|
|
155 | return; |
|
|
156 | |
|
|
157 | if (!facesets[fallback].prefix) |
|
|
158 | { |
|
|
159 | LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback); |
|
|
160 | abort (); |
|
|
161 | } |
|
|
162 | |
|
|
163 | togo--; |
|
|
164 | if (togo == 0) |
|
|
165 | { |
|
|
166 | LOG (llevError, "Infinite loop found in facesets. aborting.\n"); |
|
|
167 | abort (); |
|
|
168 | } |
|
|
169 | |
|
|
170 | check_faceset_fallback (fallback, togo); |
|
|
171 | } |
|
|
172 | |
|
|
173 | #define MAX_IMAGE_SIZE 10000 |
40 | #define MAX_IMAGE_SIZE 10000 |
174 | |
41 | |
175 | /** |
42 | /** |
176 | * Client tells us what type of faces it wants. Also sets |
43 | * Client tells us what type of faces it wants. Also sets |
177 | * the caching attribute. |
44 | * the caching attribute. |
… | |
… | |
200 | { |
67 | { |
201 | int idx = 0, pri = 0; |
68 | int idx = 0, pri = 0; |
202 | |
69 | |
203 | sscanf (buf, "%d %d", &idx, &pri); |
70 | sscanf (buf, "%d %d", &idx, &pri); |
204 | |
71 | |
|
|
72 | //TODO: somehow fetch default priority from send_fx here |
|
|
73 | |
205 | const facedata *d = face_data (idx, ns->faceset); |
74 | const facedata *d = face_data (idx, ns->faceset); |
206 | |
75 | |
207 | if (!d) |
76 | if (!d) |
208 | return; // doh |
77 | return; // doh |
209 | |
78 | |
… | |
… | |
211 | |
80 | |
212 | ix.pri = pri; |
81 | ix.pri = pri; |
213 | ix.idx = idx; |
82 | ix.idx = idx; |
214 | ix.ofs = d->data.size (); |
83 | ix.ofs = d->data.size (); |
215 | |
84 | |
216 | // this is (hopefully) a temporary fix around older cfplus versions not |
85 | auto (pos, ns->ixface.end ()); |
|
|
86 | |
|
|
87 | if (ns->fxix < 2) |
|
|
88 | { |
|
|
89 | // gcfclient does not support prioritising, older cfplus versions |
217 | // supporting interleaved transfers |
90 | // do not support interleaved transfers. |
218 | ns->ixface.insert (ns->ixface.begin (), ix); |
91 | if (!ns->ixface.empty ()) |
|
|
92 | pos = ns->ixface.end () - 1; |
|
|
93 | } |
|
|
94 | else |
|
|
95 | { |
|
|
96 | // the by far most common case will be to insert |
|
|
97 | // near the end, so little looping. |
|
|
98 | while (pos != ns->ixface.begin ()) |
|
|
99 | { |
|
|
100 | --pos; |
|
|
101 | |
|
|
102 | // sort within 2k bins, to slightly prefer smaller images |
|
|
103 | if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11))) |
|
|
104 | { |
|
|
105 | ++pos; |
|
|
106 | break; |
|
|
107 | } |
|
|
108 | } |
|
|
109 | } |
|
|
110 | |
|
|
111 | ns->ixface.insert (pos, ix); |
219 | |
112 | |
220 | #if 0 |
113 | #if 0 |
221 | // the by far most common case will be to insert |
114 | for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i) |
222 | // right at the end, so no looping. |
115 | fprintf (stderr, "<%d,%d> ", i->pri, i->ofs); |
223 | auto (i, ns->ixface.end ()); |
116 | fprintf (stderr, "\n"); |
224 | for (; i != ns->ixface.begin (); ) |
|
|
225 | if (pri >= (--i)->pri) |
|
|
226 | break; |
|
|
227 | |
|
|
228 | ns->ixface.insert (i, ix); |
|
|
229 | #endif |
117 | #endif |
230 | } |
118 | } |
231 | |
119 | |
232 | /** |
120 | /** |
233 | * Tells client the picture it has to use |
121 | * Tells client the picture it has to use |
234 | * to smooth a picture number given as argument. |
122 | * to smooth a picture number given as argument. |
235 | */ |
123 | */ |
236 | void |
124 | void |
237 | AskSmooth (char *buf, int len, client *ns) |
125 | AskSmooth (char *buf, int len, client *ns) |
238 | { |
126 | { |
239 | ns->send_face (atoi (buf)); |
127 | ns->send_face (atoi (buf), -100); |
240 | ns->flush_fx (); |
128 | ns->flush_fx (); |
241 | } |
129 | } |
242 | |
130 | |
243 | // how lame |
131 | // how lame |
244 | static void print_facename (packet &sl, const facedata &d) |
132 | static void print_facename (packet &sl, const facedata &d) |
… | |
… | |
273 | * this is needed for the askface, in which we really do want to send the |
161 | * this is needed for the askface, in which we really do want to send the |
274 | * face (and askface is the only place that should be setting it). Otherwise, |
162 | * face (and askface is the only place that should be setting it). Otherwise, |
275 | * we look at the facecache, and if set, send the image name. |
163 | * we look at the facecache, and if set, send the image name. |
276 | */ |
164 | */ |
277 | void |
165 | void |
278 | client::send_face (faceidx facenum) |
166 | client::send_face (faceidx facenum, int pri) |
279 | { |
167 | { |
280 | // never send face 0. ever. it does not exist. |
168 | // never send face 0. ever. it does not exist. |
281 | if (!facenum) |
169 | if (!facenum) |
282 | return; |
170 | return; |
283 | |
171 | |
284 | const facedata *d = face_data (facenum, faceset); |
172 | faceinfo *f = face_info (facenum); |
285 | |
173 | |
286 | if (!d) |
174 | if (!f) |
287 | { |
175 | { |
288 | LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); |
176 | LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum); |
289 | return; |
177 | return; |
290 | } |
178 | } |
291 | |
179 | |
|
|
180 | // refuse to send non-image faces |
|
|
181 | if (!fx_want [f->type]) |
|
|
182 | return; |
|
|
183 | |
292 | if (faces_sent[facenum]) |
184 | if (faces_sent [facenum]) |
293 | return; |
185 | return; |
294 | |
186 | |
295 | faces_sent[facenum] = true; |
187 | faces_sent[facenum] = true; |
296 | |
188 | |
297 | // if for some reason we let a client without face caching connect, |
189 | // if for some reason we let a client without face caching connect, |
… | |
… | |
302 | if (fxix) |
194 | if (fxix) |
303 | { |
195 | { |
304 | fxface.push_back (facenum); |
196 | fxface.push_back (facenum); |
305 | return; |
197 | return; |
306 | } |
198 | } |
|
|
199 | |
|
|
200 | const facedata *d = f->data (faceset); |
307 | |
201 | |
308 | packet sl; |
202 | packet sl; |
309 | |
203 | |
310 | if (force_face0) |
204 | if (force_face0) |
311 | sl << "face " << uint16 (facenum); |
205 | sl << "face " << uint16 (facenum); |
… | |
… | |
318 | print_facename (sl, *d); |
212 | print_facename (sl, *d); |
319 | send_packet (sl); |
213 | send_packet (sl); |
320 | |
214 | |
321 | if (EMI_smooth) |
215 | if (EMI_smooth) |
322 | { |
216 | { |
323 | faceinfo *f = face_info (facenum); |
|
|
324 | |
|
|
325 | if (f->smooth) |
217 | if (f->smooth) |
326 | { |
218 | { |
327 | send_face (f->smooth); |
219 | send_face (f->smooth); |
328 | |
220 | |
329 | packet sl ("smooth"); |
221 | packet sl ("smooth"); |
… | |
… | |
340 | { |
232 | { |
341 | while (!fxface.empty ()) |
233 | while (!fxface.empty ()) |
342 | { |
234 | { |
343 | packet fx ("fx"); |
235 | packet fx ("fx"); |
344 | packet sx ("sx"); |
236 | packet sx ("sx"); |
|
|
237 | int type = 0; |
345 | |
238 | |
346 | do |
239 | do |
347 | { |
240 | { |
348 | faceidx facenum = fxface.back (); fxface.pop_back (); |
241 | faceidx facenum = fxface.back (); fxface.pop_back (); |
349 | |
242 | |
350 | const facedata *d = face_data (facenum, faceset); |
243 | if (const faceinfo *f = face_info (facenum)) |
351 | |
|
|
352 | if (d) |
|
|
353 | { |
244 | { |
|
|
245 | if (f->type != type) |
|
|
246 | { |
|
|
247 | type = f->type; |
|
|
248 | |
|
|
249 | fx << ber32 (0) |
|
|
250 | << uint8 (1) << uint8 (type); |
|
|
251 | } |
|
|
252 | |
|
|
253 | const facedata *d = f->data (faceset); |
|
|
254 | |
354 | fx << ber32 (facenum) |
255 | fx << ber32 (facenum) |
355 | << data8 (d->chksum, CHKSUM_SIZE); |
256 | << data8 (d->chksum, CHKSUM_SIZE); |
356 | |
257 | |
357 | if (smoothing) |
258 | if (smoothing) |
358 | { |
259 | { |
359 | faceinfo *f = face_info (facenum); |
260 | faceinfo *f = face_info (facenum); |
360 | |
261 | |
361 | if (f->smooth) |
262 | if (f->smooth) |
362 | { |
263 | { |
363 | send_face (f->smooth); |
264 | send_face (f->smooth, -110); |
|
|
265 | |
364 | sx << ber32 (facenum) |
266 | sx << ber32 (facenum) |
365 | << ber32 (f->smooth) |
267 | << ber32 (f->smooth) |
366 | << ber32 (f->smoothlevel); |
268 | << ber32 (f->smoothlevel); |
367 | } |
269 | } |
368 | } |
270 | } |
369 | } |
271 | } |
370 | } |
272 | } |
371 | while (!fxface.empty () |
273 | while (!fxface.empty () |
372 | && fx.room () > ber32::size + CHKSUM_SIZE + 1 |
274 | && fx.room () > ber32::size + CHKSUM_SIZE + 1 + 3 /* type switch */ |
373 | && sx.room () > ber32::size * 3); |
275 | && sx.room () > ber32::size * 3); |
374 | |
276 | |
375 | send_packet (fx); |
277 | send_packet (fx); |
376 | if (sx.length () > 3) send_packet (sx); |
278 | if (sx.length () > 3) send_packet (sx); |
377 | } |
279 | } |
… | |
… | |
392 | { |
294 | { |
393 | LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum); |
295 | LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum); |
394 | return; |
296 | return; |
395 | } |
297 | } |
396 | |
298 | |
397 | //TODO: check type here? |
|
|
398 | |
|
|
399 | if (force_image_newmap) |
299 | if (force_image_newmap) |
400 | force_newmap = true; |
300 | force_newmap = true; |
401 | |
301 | |
402 | packet sl; |
302 | packet sl; |
403 | |
303 | |
… | |
… | |
418 | // animations look much smoother, and every client |
318 | // animations look much smoother, and every client |
419 | // is supposed to do client-side caching anyways. |
319 | // is supposed to do client-side caching anyways. |
420 | void |
320 | void |
421 | client::send_faces (object *ob) |
321 | client::send_faces (object *ob) |
422 | { |
322 | { |
423 | send_face (ob->face); |
323 | send_face (ob->face, 10); |
424 | |
324 | |
425 | if (ob->animation_id) |
325 | if (ob->animation_id) |
426 | { |
326 | { |
427 | animation &anim = animations [ob->animation_id]; |
327 | animation &anim = animations [ob->animation_id]; |
428 | |
328 | |
429 | for (int i = 0; i < anim.num_animations; i++) |
329 | for (int i = 0; i < anim.num_animations; i++) |
430 | send_face (anim.faces [i]); |
330 | send_face (anim.faces [i], -10); |
431 | } |
331 | } |
432 | } |
332 | } |
433 | |
333 | |
434 | /** |
334 | /** |
435 | * Need to send an animation sequence to the client. |
335 | * Need to send an animation sequence to the client. |
… | |
… | |
459 | /* Build up the list of faces. Also, send any information (ie, the |
359 | /* Build up the list of faces. Also, send any information (ie, the |
460 | * the face itself) down to the client. |
360 | * the face itself) down to the client. |
461 | */ |
361 | */ |
462 | for (int i = 0; i < animations[anim_num].num_animations; i++) |
362 | for (int i = 0; i < animations[anim_num].num_animations; i++) |
463 | { |
363 | { |
464 | send_face (animations[anim_num].faces[i]); |
364 | send_face (animations[anim_num].faces[i], -20); |
465 | sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ |
365 | sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ |
466 | } |
366 | } |
467 | |
367 | |
468 | send_packet (sl); |
368 | send_packet (sl); |
469 | |
369 | |
… | |
… | |
520 | } |
420 | } |
521 | |
421 | |
522 | sl.printf ("replyinfo image_sums %d %d ", start, stop); |
422 | sl.printf ("replyinfo image_sums %d %d ", start, stop); |
523 | |
423 | |
524 | for (int i = start; i <= stop && i < faces.size (); i++) |
424 | for (int i = start; i <= stop && i < faces.size (); i++) |
525 | { |
425 | if (const faceinfo *f = face_info (i)) |
|
|
426 | if (ns->fx_want [f->type]) |
|
|
427 | { |
526 | ns->faces_sent[i] = true; |
428 | ns->faces_sent[i] = true; |
527 | |
429 | |
528 | const facedata *d = face_data (i, ns->faceset); |
430 | const facedata *d = f->data (ns->faceset); |
529 | |
431 | |
530 | if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
432 | if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
531 | break; |
433 | break; |
532 | |
434 | |
533 | sl << uint16 (i) |
435 | sl << uint16 (i) |
534 | << uint32 (0) // checksum |
436 | << uint32 (0) // checksum |
535 | << uint8 (ns->faceset); |
437 | << uint8 (ns->faceset); |
536 | |
438 | |
537 | print_facename (sl, *d); sl << uint8 (0); |
439 | print_facename (sl, *d); sl << uint8 (0); |
538 | } |
440 | } |
539 | |
441 | |
540 | /* It would make more sense to catch this pre-emptively in the code above. |
442 | /* It would make more sense to catch this pre-emptively in the code above. |
541 | * however, if this really happens, we probably just want to cut down the |
443 | * however, if this really happens, we probably just want to cut down the |
542 | * size to less than 1000, since that is what we claim the protocol would |
444 | * size to less than 1000, since that is what we claim the protocol would |
543 | * support. |
445 | * support. |
544 | */ |
446 | */ |
545 | //TODO: taken care of above, should simply abort or make sure the above code is correct |
447 | //TODO: taken care of above, should simply abort or make sure the above code is correct |
546 | if (sl.length () >= MAXSOCKBUF) |
448 | if (sl.length () > MAXSOCKBUF) |
547 | { |
449 | { |
548 | LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF); |
450 | LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF); |
549 | abort (); |
451 | abort (); |
550 | } |
452 | } |
551 | |
453 | |