ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/image.C
(Generate patch)

Comparing deliantra/server/socket/image.C (file contents):
Revision 1.40 by root, Tue Apr 10 09:35:24 2007 UTC vs.
Revision 1.74 by root, Sun Nov 11 18:21:21 2012 UTC

1/* 1/*
2 * CrossFire, A Multiplayer game 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (C) 2001 Mark Wedel 5 * Copyright (©) 2001 Mark Wedel
6 * Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992 Frank Tore Johansen
7 * 7 *
8 * This program is free software; you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify it under
9 * it under the terms of the GNU General Public License as published by 9 * the terms of the Affero GNU General Public License as published by the
10 * the Free Software Foundation; either version 2 of the License, or 10 * Free Software Foundation, either version 3 of the License, or (at your
11 * (at your option) any later version. 11 * 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 Affero GNU General Public License
19 * along with this program; if not, write to the Free Software 19 * and the GNU General Public License along with this program. If not, see
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * <http://www.gnu.org/licenses/>.
21 *
22 * The author can be reached via e-mail to <crossfire@schmorp.de>
23 */ 21 *
22 * The authors can be reached via e-mail to <support@deliantra.net>
23 */
24 24
25/** \file 25/*
26 * Image related communication 26 * Image related communication
27 *
28 * \date 2003-12-02
29 * 27 *
30 * This file deals with the image related communication to the 28 * This file deals with the image related communication to the
31 * client. I've located all the functions in this file - this 29 * client. I've located all the functions in this file - this
32 * localizes it more, and means that we don't need to declare 30 * localizes it more, and means that we don't need to declare
33 * things like all the structures as globals. 31 * things like all the structures as globals.
… …
36#include <global.h> 34#include <global.h>
37#include <sproto.h> 35#include <sproto.h>
38 36
39#include "crc.h" 37#include "crc.h"
40 38
41#define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ 39#define MAX_IMAGE_SIZE 10000
42
43/** Information about one image */
44typedef 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 */
52typedef 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
65static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */
66 40
67/** 41/**
68 * Checks specified faceset is valid 42 * client requested an image. send it rate-limited
69 * \param fsn faceset number 43 * before flushing.
70 */ 44 */
71int 45void
72is_valid_faceset (int fsn) 46AskFaceCmd (char *buf, int len, client *ns)
73{ 47{
74 if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) 48 int idx = 0, pri = 0;
75 return TRUE; 49
76 return FALSE; 50 sscanf (buf, "%d %d", &idx, &pri);
51
52 //TODO: somehow fetch default priority from send_fx here
53
54 const faceinfo *f = face_info (idx);
55
56 if (!f)
57 return; // doh
58
59 int set = ns->tileset;
60
61 if (!f->face [set].chksum_len)
62 set = 0;
63
64 /* cfperl_ix calls cf::face::ix which loads the data */
65 /* and then calls cf::client::send_ix to actually queue the ix */
66 cfperl_ix (ns, set, idx, pri);
67}
68
69void
70client::ix_send (faceidx idx, sint16 pri, SV *data_sv)
71{
72 STRLEN size;
73 char *data = SvPVbyte (data_sv, size);
74 ixsend ix;
75
76 ix.pri = pri;
77 ix.idx = idx;
78 ix.ofs = size;
79 ix.data = (uint8 *)data;
80 ix.data_sv = SvREFCNT_inc (data_sv);
81
82 auto (pos, ixface.end ());
83
84 // the by far most common case will be to insert
85 // near the end, so little looping.
86 while (pos != ixface.begin ())
87 {
88 --pos;
89
90 // sort within 2k bins, to slightly prefer smaller images
91 if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11)))
92 {
93 ++pos;
94 break;
95 }
96 }
97
98 ixface.insert (pos, ix);
99
100#if 0
101 for (auto (i, ixface.begin ()); i != ixface.end (); ++i)
102 fprintf (stderr, "<%d,%d> ", i->pri, i->ofs);
103 fprintf (stderr, "\n");
104#endif
105}
106
107void
108client::ix_pop ()
109{
110 ixsend &ix = ixface.back ();
111
112 SvREFCNT_dec (ix.data_sv);
113
114 ixface.pop_back ();
77} 115}
78 116
79/** 117/**
80 * Frees all faceset information 118 * Sends a face offer (fx) to a client.
81 */
82void
83free_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 */
117static int
118get_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 */
149static void
150check_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
175
176/**
177 * Client tells us what type of faces it wants. Also sets
178 * the caching attribute.
179 *
180 */
181void
182SetFaceMode (char *buf, int len, client *ns)
183{
184 int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
185
186 if (mode == CF_FACE_NONE)
187 ns->facecache = 1;
188 else if (mode != CF_FACE_PNG)
189 ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
190
191 if (mask)
192 ns->facecache = 1;
193}
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 */
200void
201SendFaceCmd (char *buf, int len, client *ns)
202{
203 ns->send_image (atoi (buf));
204}
205
206// how lame
207static void print_facename (packet &sl, const facedata &d)
208{
209 for (int i = 0; i < CHKSUM_SIZE; ++i)
210 sl.printf ("%02x", d.chksum [i]);
211}
212
213// gcfclient uses the server-provided checksum for comparison, but always
214// writes a broken checksum to its cache file, so we have to provide
215// gcfclient with the same broken (and useless) checksum just to have it
216// cache the image despite its bugs.
217static 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/**
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 - 119 * 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 120 * 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, 121 * 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. 122 * we look at the facecache, and if set, send the image name.
239 */ 123 */
240void 124void
241client::send_face (faceidx facenum) 125client::send_face (faceidx facenum, int pri)
242{ 126{
243 // never send face 0. ever. it does not exist. 127 // never send face 0. ever. it does not exist.
244 if (!facenum) 128 if (!facenum)
245 return; 129 return;
246 130
247 const facedata *d = face_data (facenum, faceset); 131 faceinfo *f = face_info (facenum);
248 132
249 if (!d) 133 if (!f)
250 { 134 {
251 LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); 135 LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum);
252 return; 136 return;
253 } 137 }
254 138
255 if (faces_sent[facenum]) 139 // refuse to send non-image faces unless requested
140 if (!fx_want [f->type])
256 return; 141 return;
257 142
143 if (faces_sent [facenum])
144 return;
145
258 faces_sent[facenum] = true; 146 faces_sent [facenum] = true;
259 147
260 // if for some reason we let a client without face caching connect,
261 // we better support that decision here and implement it.
262 if (!facecache)
263 return send_image (facenum);
264
265 if (fxix)
266 {
267 fxface.push_back (facenum); 148 fxface.push_back (facenum);
268 return;
269 }
270
271 packet sl;
272
273 if (force_face0)
274 sl << "face " << uint16 (facenum);
275 else if (image2)
276 sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
277 else
278 sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
279
280 // how lame
281 print_facename (sl, *d);
282 send_packet (sl);
283
284 if (EMI_smooth)
285 {
286 faceinfo *f = face_info (facenum);
287
288 if (f->smooth)
289 {
290 send_face (f->smooth);
291
292 packet sl ("smooth");
293
294 sl << uint16 (facenum)
295 << uint16 (f->smooth);
296
297 send_packet (sl);
298 }
299 }
300} 149}
301 150
302void client::flush_fx () 151void client::flush_fx ()
303{ 152{
304 while (!fxface.empty ()) 153 while (!fxface.empty ())
305 { 154 {
306 packet fx ("fx"); 155 packet fx ("fx");
307 packet sx ("sx"); 156 packet sx ("sx");
157 int type = 0;
308 158
309 do 159 do
310 { 160 {
311 faceidx facenum = fxface.back (); fxface.pop_back (); 161 faceidx facenum = fxface.back (); fxface.pop_back ();
312 162
313 const facedata *d = face_data (facenum, faceset); 163 if (const faceinfo *f = face_info (facenum))
314
315 if (d)
316 { 164 {
165 if (f->type != type)
166 {
167 type = f->type;
168
169 fx << ber32 (0)
170 << uint8 (1) << uint8 (type);
171 }
172
173 const facedata *d = f->data (tileset);
174
317 fx << ber32 (facenum) 175 fx << ber32 (facenum)
318 << data8 (d->chksum, CHKSUM_SIZE); 176 << data8 (d->chksum, d->chksum_len);
319 177
320 if (smoothing) 178 if (smoothing)
321 { 179 {
322 faceinfo *f = face_info (facenum); 180 faceinfo *f = face_info (facenum);
323 181
324 if (f->smooth) 182 if (f->smooth)
325 { 183 {
326 send_face (f->smooth); 184 send_face (f->smooth, -110);
185
327 sx << ber32 (facenum) 186 sx << ber32 (facenum)
328 << ber32 (f->smooth) 187 << ber32 (f->smooth)
329 << ber32 (f->smoothlevel); 188 << ber32 (f->smoothlevel);
330 } 189 }
331 } 190 }
332 } 191 }
333 } 192 }
334 while (!fxface.empty () 193 while (!fxface.empty ()
335 && fx.room () > ber32::size + CHKSUM_SIZE + 1 194 && fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */
336 && sx.room () > ber32::size * 3); 195 && sx.room () > ber32::size * 3);
337 196
338 send_packet (fx); 197 send_packet (fx);
339 if (sx.length () > 3) send_packet (sx); 198 if (sx.length () > 3) send_packet (sx);
340 } 199 }
341}
342
343void
344client::send_image (faceidx facenum)
345{
346 // never send face 0. ever. it does not exist.
347 if (!facenum)
348 return;
349
350 const facedata *d = face_data (facenum, faceset);
351
352 if (!d)
353 {
354 LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
355 return;
356 }
357
358 faces_sent[facenum] = true;
359
360 if (force_image_newmap)
361 force_newmap = true;
362
363 packet sl;
364
365 sl << (image2 ? "image2 " : "image ")
366 << uint32 (facenum);
367
368 if (image2)
369 sl << uint8 (0);
370
371 sl << uint32 (d->data.size ())
372 << data (d->data.data (), d->data.size ());
373
374 send_packet (sl);
375} 200}
376 201
377// send all faces of this object to the client 202// send all faces of this object to the client
378// this uses more bandwidth initially, but makes 203// this uses more bandwidth initially, but makes
379// animations look much smoother, and every client 204// animations look much smoother, and every client
380// is supposed to do client-side caching anyways. 205// is supposed to do client-side caching anyways.
381void 206void
382client::send_faces (object *ob) 207client::send_faces (object *ob)
383{ 208{
384 send_face (ob->face); 209 send_face (ob->face, 10);
385 210
386 if (ob->animation_id) 211 if (ob->animation_id)
387 { 212 {
388 animation &anim = animations [ob->animation_id]; 213 const animation &anim = ob->anim ();
389 214
390 for (int i = 0; i < anim.num_animations; i++) 215 for (int i = 0; i < anim.num_animations; i++)
391 send_face (anim.faces [i]); 216 send_face (anim.faces [i], -10);
392 } 217 }
393} 218}
394 219
395/** 220/**
396 * Need to send an animation sequence to the client. 221 * Need to send an animation sequence to the client.
… …
401 */ 226 */
402void 227void
403client::send_animation (short anim_num) 228client::send_animation (short anim_num)
404{ 229{
405 /* Do some checking on the anim_num we got. Note that the animations 230 /* Do some checking on the anim_num we got. Note that the animations
406 * are added in contigous order, so if the number is in the valid 231 * are added in contiguous order, so if the number is in the valid
407 * range, it must be a valid animation. 232 * range, it must be a valid animation.
408 */ 233 */
409 if (anim_num < 0 || anim_num > num_animations) 234 if (anim_num < 0 || anim_num >= animations.size ())
410 { 235 {
411 LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); 236 LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
412 return; 237 return;
413 } 238 }
414 239
… …
420 /* Build up the list of faces. Also, send any information (ie, the 245 /* Build up the list of faces. Also, send any information (ie, the
421 * the face itself) down to the client. 246 * the face itself) down to the client.
422 */ 247 */
423 for (int i = 0; i < animations[anim_num].num_animations; i++) 248 for (int i = 0; i < animations[anim_num].num_animations; i++)
424 { 249 {
425 send_face (animations[anim_num].faces[i]); 250 send_face (animations[anim_num].faces[i], -20);
426 sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ 251 sl << uint16 (animations[anim_num].faces[i]);
427 } 252 }
428 253
429 send_packet (sl); 254 send_packet (sl);
430 255
431 anims_sent[anim_num] = 1; 256 anims_sent[anim_num] = 1;
432} 257}
433 258
434/**
435 * Sends the number of images, checksum of the face file,
436 * and the image_info file information. See the doc/Developers/protocol
437 * if you want further detail.
438 */
439void 259void
440send_image_info (client *ns, char *params) 260client::invalidate_face (faceidx idx)
441{ 261{
442 packet sl; 262 faces_sent [idx] = false;
443 263 force_newmap = true;
444 //TODO: second parameter is a checksum, but it makes no sense in this current framework
445 sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
446
447 sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
448
449 ns->send_packet (sl);
450} 264}
451 265
452/**
453 * Sends requested face information.
454 * \param ns socket to send to
455 * \param params contains first and last index of face
456 *
457 * For each image in [start..stop] sends
458 * - checksum
459 * - name
460 */
461void 266void
462send_image_sums (client *ns, char *params) 267client::invalidate_all_faces ()
463{ 268{
464 int start, stop; 269 faces_sent.reset ();
465 char *cp; 270 force_newmap = true;
466
467 packet sl;
468
469 start = atoi (params);
470 for (cp = params; *cp != '\0'; cp++)
471 if (*cp == ' ')
472 break;
473
474 stop = atoi (cp);
475 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
476 {
477 sl.printf ("replyinfo image_sums %d %d", start, stop);
478 ns->send_packet (sl);
479 sl.reset ();
480 return;
481 }
482
483 sl.printf ("replyinfo image_sums %d %d ", start, stop);
484
485 for (int i = start; i <= stop && i < faces.size (); i++)
486 {
487 ns->faces_sent[i] = true;
488
489 const facedata *d = face_data (i, ns->faceset);
490
491 if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
492 break;
493
494 sl << uint16 (i)
495 << uint32 (0) // checksum
496 << uint8 (ns->faceset);
497
498 print_facename (sl, *d); sl << uint8 (0);
499 }
500
501 /* It would make more sense to catch this pre-emptively in the code above.
502 * however, if this really happens, we probably just want to cut down the
503 * size to less than 1000, since that is what we claim the protocol would
504 * support.
505 */
506 //TODO: taken care of above, should simply abort or make sure the above code is correct
507 if (sl.length () >= MAXSOCKBUF)
508 {
509 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
510 abort ();
511 }
512
513 ns->send_packet (sl);
514} 271}
515 272

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines