1 | /* |
1 | /* |
2 | * CrossFire, A Multiplayer game |
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
3 | * |
3 | * |
4 | * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
5 | * Copyright (C) 2001 Mark Wedel |
5 | * Copyright (©) 2001,2007 Mark Wedel |
6 | * Copyright (C) 1992 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * This program is free software; you can redistribute it and/or modify |
8 | * Crossfire TRT 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 2 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, |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
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, write to the Free Software |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 | * |
20 | * |
22 | * The author can be reached via e-mail to <crossfire@schmorp.de> |
21 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
23 | */ |
22 | */ |
24 | |
23 | |
25 | /** \file |
24 | /** \file |
26 | * Image related communication |
25 | * Image related communication |
27 | * |
26 | * |
… | |
… | |
36 | #include <global.h> |
35 | #include <global.h> |
37 | #include <sproto.h> |
36 | #include <sproto.h> |
38 | |
37 | |
39 | #include "crc.h" |
38 | #include "crc.h" |
40 | |
39 | |
41 | #define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ |
|
|
42 | |
|
|
43 | /** Information about one image */ |
|
|
44 | 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 | } FaceInfo; |
|
|
50 | |
|
|
51 | /** Information about one face set */ |
|
|
52 | 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 | } 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 | int |
|
|
72 | is_valid_faceset (int fsn) |
|
|
73 | { |
|
|
74 | if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) |
|
|
75 | return TRUE; |
|
|
76 | return FALSE; |
|
|
77 | } |
|
|
78 | |
|
|
79 | /** |
|
|
80 | * Frees all faceset information |
|
|
81 | */ |
|
|
82 | void |
|
|
83 | free_socket_images (void) |
|
|
84 | { |
|
|
85 | int num, q; |
|
|
86 | |
|
|
87 | for (num = 0; num < MAX_FACE_SETS; num++) |
|
|
88 | { |
|
|
89 | if (facesets[num].prefix) |
|
|
90 | { |
|
|
91 | for (q = 0; q < faces.size (); q++) |
|
|
92 | if (facesets[num].faces[q].data) |
|
|
93 | free (facesets[num].faces[q].data); |
|
|
94 | |
|
|
95 | 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 | } |
|
|
102 | } |
|
|
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 | static int |
|
|
118 | get_face_fallback (int faceset, int imageno) |
|
|
119 | { |
|
|
120 | /* 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 | |
|
|
135 | if (facesets[faceset].faces[imageno].data) |
|
|
136 | return faceset; |
|
|
137 | |
|
|
138 | return get_face_fallback (facesets[faceset].fallback, imageno); |
|
|
139 | } |
|
|
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 | static void |
|
|
150 | check_faceset_fallback (int faceset, int togo) |
|
|
151 | { |
|
|
152 | int fallback = facesets[faceset].fallback; |
|
|
153 | |
|
|
154 | /* 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 | |
|
|
164 | togo--; |
|
|
165 | if (togo == 0) |
|
|
166 | { |
|
|
167 | LOG (llevError, "Infinite loop found in facesets. aborting.\n"); |
|
|
168 | abort (); |
|
|
169 | } |
|
|
170 | |
|
|
171 | check_faceset_fallback (fallback, togo); |
|
|
172 | } |
|
|
173 | |
|
|
174 | #define MAX_IMAGE_SIZE 10000 |
40 | #define MAX_IMAGE_SIZE 10000 |
175 | |
41 | |
176 | /** |
42 | /** |
177 | * Client tells us what type of faces it wants. Also sets |
43 | * Client tells us what type of faces it wants. Also sets |
178 | * the caching attribute. |
44 | * the caching attribute. |
… | |
… | |
191 | if (mask) |
57 | if (mask) |
192 | ns->facecache = 1; |
58 | ns->facecache = 1; |
193 | } |
59 | } |
194 | |
60 | |
195 | /** |
61 | /** |
196 | * Client has requested pixmap that it somehow missed getting. |
62 | * client requested an image. send it rate-limited |
197 | * This will be called often if the client is |
63 | * before flushing. |
198 | * caching images. |
|
|
199 | */ |
64 | */ |
200 | void |
65 | void |
201 | SendFaceCmd (char *buf, int len, client *ns) |
66 | AskFaceCmd (char *buf, int len, client *ns) |
202 | { |
67 | { |
|
|
68 | int idx = 0, pri = 0; |
|
|
69 | |
|
|
70 | sscanf (buf, "%d %d", &idx, &pri); |
|
|
71 | |
|
|
72 | //TODO: somehow fetch default priority from send_fx here |
|
|
73 | |
|
|
74 | const facedata *d = face_data (idx, ns->faceset); |
|
|
75 | |
|
|
76 | if (!d) |
|
|
77 | return; // doh |
|
|
78 | |
|
|
79 | client::ixsend ix; |
|
|
80 | |
|
|
81 | ix.pri = pri; |
|
|
82 | ix.idx = idx; |
|
|
83 | ix.ofs = d->data.size (); |
|
|
84 | |
|
|
85 | auto (pos, ns->ixface.end ()); |
|
|
86 | |
|
|
87 | if (ns->fxix < 2) |
|
|
88 | { |
|
|
89 | // gcfclient does not support prioritising, older cfplus versions |
|
|
90 | // do not support interleaved transfers. |
|
|
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); |
|
|
112 | |
|
|
113 | #if 0 |
|
|
114 | for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i) |
|
|
115 | fprintf (stderr, "<%d,%d> ", i->pri, i->ofs); |
|
|
116 | fprintf (stderr, "\n"); |
|
|
117 | #endif |
|
|
118 | } |
|
|
119 | |
|
|
120 | /** |
|
|
121 | * Tells client the picture it has to use |
|
|
122 | * to smooth a picture number given as argument. |
|
|
123 | */ |
|
|
124 | void |
|
|
125 | AskSmooth (char *buf, int len, client *ns) |
|
|
126 | { |
203 | ns->send_image (atoi (buf)); |
127 | ns->send_face (atoi (buf), -100); |
|
|
128 | ns->flush_fx (); |
204 | } |
129 | } |
205 | |
130 | |
206 | // how lame |
131 | // how lame |
207 | static void print_facename (packet &sl, const facedata &d) |
132 | static void print_facename (packet &sl, const facedata &d) |
208 | { |
133 | { |
… | |
… | |
236 | * 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 |
237 | * 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, |
238 | * 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. |
239 | */ |
164 | */ |
240 | void |
165 | void |
241 | client::send_face (faceidx facenum) |
166 | client::send_face (faceidx facenum, int pri) |
242 | { |
167 | { |
243 | // never send face 0. ever. it does not exist. |
168 | // never send face 0. ever. it does not exist. |
244 | if (!facenum) |
169 | if (!facenum) |
245 | return; |
170 | return; |
246 | |
171 | |
247 | const facedata *d = face_data (facenum, faceset); |
172 | faceinfo *f = face_info (facenum); |
248 | |
173 | |
249 | if (!d) |
174 | if (!f) |
250 | { |
175 | { |
251 | LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); |
176 | LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); |
252 | return; |
177 | return; |
253 | } |
178 | } |
254 | |
179 | |
|
|
180 | // refuse to send non-image faces |
|
|
181 | if (!fx_want [f->type]) |
|
|
182 | return; |
|
|
183 | |
255 | if (faces_sent[facenum]) |
184 | if (faces_sent [facenum]) |
256 | return; |
185 | return; |
257 | |
186 | |
258 | faces_sent[facenum] = true; |
187 | faces_sent[facenum] = true; |
259 | |
188 | |
260 | // 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, |
261 | // we better support that decision here and implement it. |
190 | // we better support that decision here and implement it. |
262 | if (!facecache) |
191 | if (!facecache) |
263 | return send_image (facenum); |
192 | return send_image (facenum); |
|
|
193 | |
|
|
194 | if (fxix) |
|
|
195 | { |
|
|
196 | fxface.push_back (facenum); |
|
|
197 | return; |
|
|
198 | } |
|
|
199 | |
|
|
200 | const facedata *d = f->data (faceset); |
264 | |
201 | |
265 | packet sl; |
202 | packet sl; |
266 | |
203 | |
267 | if (force_face0) |
204 | if (force_face0) |
268 | sl << "face " << uint16 (facenum); |
205 | sl << "face " << uint16 (facenum); |
… | |
… | |
273 | |
210 | |
274 | // how lame |
211 | // how lame |
275 | print_facename (sl, *d); |
212 | print_facename (sl, *d); |
276 | send_packet (sl); |
213 | send_packet (sl); |
277 | |
214 | |
278 | faceinfo *f = face_info (facenum); |
215 | if (EMI_smooth) |
279 | if (f->smooth && EMI_smooth) |
|
|
280 | { |
216 | { |
|
|
217 | if (f->smooth) |
|
|
218 | { |
281 | send_face (f->smooth); |
219 | send_face (f->smooth); |
282 | |
220 | |
283 | packet sl ("smooth"); |
221 | packet sl ("smooth"); |
284 | |
222 | |
285 | sl << uint16 (facenum) |
223 | sl << uint16 (facenum) |
286 | << uint16 (f->smooth); |
224 | << uint16 (f->smooth); |
287 | |
225 | |
288 | send_packet (sl); |
226 | send_packet (sl); |
|
|
227 | } |
|
|
228 | } |
|
|
229 | } |
|
|
230 | |
|
|
231 | void client::flush_fx () |
|
|
232 | { |
|
|
233 | while (!fxface.empty ()) |
|
|
234 | { |
|
|
235 | packet fx ("fx"); |
|
|
236 | packet sx ("sx"); |
|
|
237 | int type = 0; |
|
|
238 | |
|
|
239 | do |
|
|
240 | { |
|
|
241 | faceidx facenum = fxface.back (); fxface.pop_back (); |
|
|
242 | |
|
|
243 | if (const faceinfo *f = face_info (facenum)) |
|
|
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 | |
|
|
255 | fx << ber32 (facenum) |
|
|
256 | << data8 (d->chksum, CHKSUM_SIZE); |
|
|
257 | |
|
|
258 | if (smoothing) |
|
|
259 | { |
|
|
260 | faceinfo *f = face_info (facenum); |
|
|
261 | |
|
|
262 | if (f->smooth) |
|
|
263 | { |
|
|
264 | send_face (f->smooth, -110); |
|
|
265 | |
|
|
266 | sx << ber32 (facenum) |
|
|
267 | << ber32 (f->smooth) |
|
|
268 | << ber32 (f->smoothlevel); |
|
|
269 | } |
|
|
270 | } |
|
|
271 | } |
|
|
272 | } |
|
|
273 | while (!fxface.empty () |
|
|
274 | && fx.room () > ber32::size + CHKSUM_SIZE + 1 + 3 /* type switch */ |
|
|
275 | && sx.room () > ber32::size * 3); |
|
|
276 | |
|
|
277 | send_packet (fx); |
|
|
278 | if (sx.length () > 3) send_packet (sx); |
289 | } |
279 | } |
290 | } |
280 | } |
291 | |
281 | |
292 | void |
282 | void |
293 | client::send_image (faceidx facenum) |
283 | client::send_image (faceidx facenum) |
… | |
… | |
296 | if (!facenum) |
286 | if (!facenum) |
297 | return; |
287 | return; |
298 | |
288 | |
299 | const facedata *d = face_data (facenum, faceset); |
289 | const facedata *d = face_data (facenum, faceset); |
300 | |
290 | |
|
|
291 | faces_sent[facenum] = true; |
|
|
292 | |
301 | if (!d) |
293 | if (!d) |
302 | { |
294 | { |
303 | LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum); |
295 | LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum); |
304 | return; |
296 | return; |
305 | } |
297 | } |
306 | |
298 | |
307 | faces_sent[facenum] = true; |
|
|
308 | |
|
|
309 | if (force_image_newmap) |
299 | if (force_image_newmap) |
310 | force_newmap = true; |
300 | force_newmap = true; |
311 | |
301 | |
312 | packet sl; |
302 | packet sl; |
313 | |
303 | |
… | |
… | |
328 | // animations look much smoother, and every client |
318 | // animations look much smoother, and every client |
329 | // is supposed to do client-side caching anyways. |
319 | // is supposed to do client-side caching anyways. |
330 | void |
320 | void |
331 | client::send_faces (object *ob) |
321 | client::send_faces (object *ob) |
332 | { |
322 | { |
333 | send_face (ob->face); |
323 | send_face (ob->face, 10); |
334 | |
324 | |
335 | if (ob->animation_id) |
325 | if (ob->animation_id) |
336 | { |
326 | { |
337 | animation &anim = animations [ob->animation_id]; |
327 | animation &anim = animations [ob->animation_id]; |
338 | |
328 | |
339 | for (int i = 0; i < anim.num_animations; i++) |
329 | for (int i = 0; i < anim.num_animations; i++) |
340 | send_face (anim.faces [i]); |
330 | send_face (anim.faces [i], -10); |
341 | } |
331 | } |
342 | } |
332 | } |
343 | |
333 | |
344 | /** |
334 | /** |
345 | * Need to send an animation sequence to the client. |
335 | * Need to send an animation sequence to the client. |
… | |
… | |
353 | { |
343 | { |
354 | /* Do some checking on the anim_num we got. Note that the animations |
344 | /* Do some checking on the anim_num we got. Note that the animations |
355 | * are added in contigous order, so if the number is in the valid |
345 | * are added in contigous order, so if the number is in the valid |
356 | * range, it must be a valid animation. |
346 | * range, it must be a valid animation. |
357 | */ |
347 | */ |
358 | if (anim_num < 0 || anim_num > num_animations) |
348 | if (anim_num < 0 || anim_num >= animations.size ()) |
359 | { |
349 | { |
360 | LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); |
350 | LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); |
361 | return; |
351 | return; |
362 | } |
352 | } |
363 | |
353 | |
… | |
… | |
369 | /* 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 |
370 | * the face itself) down to the client. |
360 | * the face itself) down to the client. |
371 | */ |
361 | */ |
372 | for (int i = 0; i < animations[anim_num].num_animations; i++) |
362 | for (int i = 0; i < animations[anim_num].num_animations; i++) |
373 | { |
363 | { |
374 | send_face (animations[anim_num].faces[i]); |
364 | send_face (animations[anim_num].faces[i], -20); |
375 | 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 */ |
376 | } |
366 | } |
377 | |
367 | |
378 | send_packet (sl); |
368 | send_packet (sl); |
379 | |
369 | |
… | |
… | |
430 | } |
420 | } |
431 | |
421 | |
432 | sl.printf ("replyinfo image_sums %d %d ", start, stop); |
422 | sl.printf ("replyinfo image_sums %d %d ", start, stop); |
433 | |
423 | |
434 | for (int i = start; i <= stop && i < faces.size (); i++) |
424 | for (int i = start; i <= stop && i < faces.size (); i++) |
435 | { |
425 | if (const faceinfo *f = face_info (i)) |
|
|
426 | if (ns->fx_want [f->type]) |
|
|
427 | { |
436 | ns->faces_sent[i] = true; |
428 | ns->faces_sent[i] = true; |
437 | |
429 | |
438 | const facedata *d = face_data (i, ns->faceset); |
430 | const facedata *d = f->data (ns->faceset); |
439 | |
431 | |
440 | if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
432 | if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
441 | break; |
433 | break; |
442 | |
434 | |
443 | sl << uint16 (i) |
435 | sl << uint16 (i) |
444 | << uint32 (0) // checksum |
436 | << uint32 (0) // checksum |
445 | << uint8 (ns->faceset); |
437 | << uint8 (ns->faceset); |
446 | |
438 | |
447 | print_facename (sl, *d); sl << uint8 (0); |
439 | print_facename (sl, *d); sl << uint8 (0); |
448 | } |
440 | } |
449 | |
441 | |
450 | /* 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. |
451 | * 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 |
452 | * 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 |
453 | * support. |
445 | * support. |
454 | */ |
446 | */ |
455 | //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 |
456 | if (sl.length () >= MAXSOCKBUF) |
448 | if (sl.length () > MAXSOCKBUF) |
457 | { |
449 | { |
458 | 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); |
459 | abort (); |
451 | abort (); |
460 | } |
452 | } |
461 | |
453 | |