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.39 by root, Tue Apr 3 00:21:38 2007 UTC vs.
Revision 1.72 by root, Sun Nov 11 04:29:11 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 * 21 *
22 * The author can be reached via e-mail to <crossfire@schmorp.de> 22 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 23 */
24 24
25/** \file 25/** \file
26 * Image related communication 26 * Image related communication
27 * 27 *
36#include <global.h> 36#include <global.h>
37#include <sproto.h> 37#include <sproto.h>
38 38
39#include "crc.h" 39#include "crc.h"
40 40
41#define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ 41#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 42
67/** 43/**
68 * Checks specified faceset is valid 44 * client requested an image. send it rate-limited
69 * \param fsn faceset number 45 * before flushing.
70 */ 46 */
71int 47void
72is_valid_faceset (int fsn) 48AskFaceCmd (char *buf, int len, client *ns)
73{ 49{
74 if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) 50 int idx = 0, pri = 0;
75 return TRUE; 51
76 return FALSE; 52 sscanf (buf, "%d %d", &idx, &pri);
53
54 //TODO: somehow fetch default priority from send_fx here
55
56 const facedata *d = face_data (idx, ns->faceset);
57
58 if (!d)
59 return; // doh
60
61 /* cfperl_ix calls cf::face::ix which loads the data */
62 /* and then calls cf::client::send_ix to actually queue the ix */
63 cfperl_ix (ns, idx, pri, d->size, d->fofs);
64}
65
66void
67client::ix_send (faceidx idx, sint16 pri, SV *data_sv)
68{
69 STRLEN size;
70 char *data = SvPVbyte (data_sv, size);
71 ixsend ix;
72
73 ix.pri = pri;
74 ix.idx = idx;
75 ix.ofs = size;
76 ix.data = (uint8 *)data;
77 ix.data_sv = SvREFCNT_inc (data_sv);
78
79 auto (pos, ixface.end ());
80
81 // the by far most common case will be to insert
82 // near the end, so little looping.
83 while (pos != ixface.begin ())
84 {
85 --pos;
86
87 // sort within 2k bins, to slightly prefer smaller images
88 if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11)))
89 {
90 ++pos;
91 break;
92 }
93 }
94
95 ixface.insert (pos, ix);
96
97#if 0
98 for (auto (i, ixface.begin ()); i != ixface.end (); ++i)
99 fprintf (stderr, "<%d,%d> ", i->pri, i->ofs);
100 fprintf (stderr, "\n");
101#endif
102}
103
104void
105client::ix_pop ()
106{
107 ixsend &ix = ixface.back ();
108
109 SvREFCNT_dec (ix.data_sv);
110
111 ixface.pop_back ();
77} 112}
78 113
79/** 114/**
80 * Frees all faceset information 115 * 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 - 116 * 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 117 * 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, 118 * 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. 119 * we look at the facecache, and if set, send the image name.
239 */ 120 */
240void 121void
241client::send_face (faceidx facenum) 122client::send_face (faceidx facenum, int pri)
242{ 123{
243 // never send face 0. ever. it does not exist. 124 // never send face 0. ever. it does not exist.
244 if (!facenum) 125 if (!facenum)
245 return; 126 return;
246 127
247 const facedata *d = face_data (facenum, faceset); 128 faceinfo *f = face_info (facenum);
248 129
249 if (!d) 130 if (!f)
250 { 131 {
251 LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); 132 LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum);
252 return; 133 return;
253 } 134 }
254 135
255 if (faces_sent[facenum]) 136 // refuse to send non-image faces unless requested
137 if (!fx_want [f->type])
256 return; 138 return;
257 139
140 if (faces_sent [facenum])
141 return;
142
258 faces_sent[facenum] = true; 143 faces_sent [facenum] = true;
259 144
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); 145 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 faceinfo *f = face_info (facenum);
285 if (f->smooth && EMI_smooth)
286 {
287 send_face (f->smooth);
288
289 packet sl ("smooth");
290
291 sl << uint16 (facenum)
292 << uint16 (f->smooth);
293
294 send_packet (sl);
295 }
296} 146}
297 147
298void client::flush_fx () 148void client::flush_fx ()
299{ 149{
300 while (!fxface.empty ()) 150 while (!fxface.empty ())
301 { 151 {
302 packet sl ("fx"); 152 packet fx ("fx");
153 packet sx ("sx");
154 int type = 0;
303 155
304 do 156 do
305 { 157 {
306 faceidx facenum = fxface.back (); fxface.pop_back (); 158 faceidx facenum = fxface.back (); fxface.pop_back ();
307 159
308 const facedata *d = face_data (facenum, faceset); 160 if (const faceinfo *f = face_info (facenum))
309
310 if (d)
311 { 161 {
162 if (f->type != type)
163 {
164 type = f->type;
165
166 fx << ber32 (0)
167 << uint8 (1) << uint8 (type);
168 }
169
170 const facedata *d = f->data (faceset);
171
312 sl << ber32 (facenum) 172 fx << ber32 (facenum)
313 << data8 (d->chksum, CHKSUM_SIZE); 173 << data8 (d->chksum, d->chksum_len);
314 174
175 if (smoothing)
176 {
315 faceinfo *f = face_info (facenum); 177 faceinfo *f = face_info (facenum);
178
316 if (f->smooth && EMI_smooth) 179 if (f->smooth)
180 {
181 send_face (f->smooth, -110);
182
183 sx << ber32 (facenum)
317 sl << ber32 (f->smooth); 184 << ber32 (f->smooth)
185 << ber32 (f->smoothlevel);
186 }
187 }
318 } 188 }
319 } 189 }
320 while (!fxface.empty () && sl.room () > CHKSUM_SIZE + 8 + 8); 190 while (!fxface.empty ()
191 && fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */
192 && sx.room () > ber32::size * 3);
321 193
322 send_packet (sl); 194 send_packet (fx);
323 } 195 if (sx.length () > 3) send_packet (sx);
324}
325
326void
327client::send_image (faceidx facenum)
328{
329 // never send face 0. ever. it does not exist.
330 if (!facenum)
331 return;
332
333 const facedata *d = face_data (facenum, faceset);
334
335 if (!d)
336 { 196 }
337 LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
338 return;
339 }
340
341 faces_sent[facenum] = true;
342
343 if (force_image_newmap)
344 force_newmap = true;
345
346 packet sl;
347
348 sl << (image2 ? "image2 " : "image ")
349 << uint32 (facenum);
350
351 if (image2)
352 sl << uint8 (0);
353
354 sl << uint32 (d->data.size ())
355 << data (d->data.data (), d->data.size ());
356
357 send_packet (sl);
358} 197}
359 198
360// send all faces of this object to the client 199// send all faces of this object to the client
361// this uses more bandwidth initially, but makes 200// this uses more bandwidth initially, but makes
362// animations look much smoother, and every client 201// animations look much smoother, and every client
363// is supposed to do client-side caching anyways. 202// is supposed to do client-side caching anyways.
364void 203void
365client::send_faces (object *ob) 204client::send_faces (object *ob)
366{ 205{
367 send_face (ob->face); 206 send_face (ob->face, 10);
368 207
369 if (ob->animation_id) 208 if (ob->animation_id)
370 { 209 {
371 animation &anim = animations [ob->animation_id]; 210 const animation &anim = ob->anim ();
372 211
373 for (int i = 0; i < anim.num_animations; i++) 212 for (int i = 0; i < anim.num_animations; i++)
374 send_face (anim.faces [i]); 213 send_face (anim.faces [i], -10);
375 } 214 }
376} 215}
377 216
378/** 217/**
379 * Need to send an animation sequence to the client. 218 * Need to send an animation sequence to the client.
384 */ 223 */
385void 224void
386client::send_animation (short anim_num) 225client::send_animation (short anim_num)
387{ 226{
388 /* Do some checking on the anim_num we got. Note that the animations 227 /* Do some checking on the anim_num we got. Note that the animations
389 * are added in contigous order, so if the number is in the valid 228 * are added in contiguous order, so if the number is in the valid
390 * range, it must be a valid animation. 229 * range, it must be a valid animation.
391 */ 230 */
392 if (anim_num < 0 || anim_num > num_animations) 231 if (anim_num < 0 || anim_num >= animations.size ())
393 { 232 {
394 LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); 233 LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
395 return; 234 return;
396 } 235 }
397 236
403 /* Build up the list of faces. Also, send any information (ie, the 242 /* Build up the list of faces. Also, send any information (ie, the
404 * the face itself) down to the client. 243 * the face itself) down to the client.
405 */ 244 */
406 for (int i = 0; i < animations[anim_num].num_animations; i++) 245 for (int i = 0; i < animations[anim_num].num_animations; i++)
407 { 246 {
408 send_face (animations[anim_num].faces[i]); 247 send_face (animations[anim_num].faces[i], -20);
409 sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ 248 sl << uint16 (animations[anim_num].faces[i]);
410 } 249 }
411 250
412 send_packet (sl); 251 send_packet (sl);
413 252
414 anims_sent[anim_num] = 1; 253 anims_sent[anim_num] = 1;
415} 254}
416 255
417/**
418 * Sends the number of images, checksum of the face file,
419 * and the image_info file information. See the doc/Developers/protocol
420 * if you want further detail.
421 */
422void 256void
423send_image_info (client *ns, char *params) 257client::invalidate_face (faceidx idx)
424{ 258{
425 packet sl; 259 faces_sent [idx] = false;
426 260 force_newmap = true;
427 //TODO: second parameter is a checksum, but it makes no sense in this current framework
428 sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
429
430 sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
431
432 ns->send_packet (sl);
433} 261}
434 262
435/**
436 * Sends requested face information.
437 * \param ns socket to send to
438 * \param params contains first and last index of face
439 *
440 * For each image in [start..stop] sends
441 * - checksum
442 * - name
443 */
444void 263void
445send_image_sums (client *ns, char *params) 264client::invalidate_all_faces ()
446{ 265{
447 int start, stop; 266 faces_sent.reset ();
448 char *cp; 267 force_newmap = true;
449
450 packet sl;
451
452 start = atoi (params);
453 for (cp = params; *cp != '\0'; cp++)
454 if (*cp == ' ')
455 break;
456
457 stop = atoi (cp);
458 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
459 {
460 sl.printf ("replyinfo image_sums %d %d", start, stop);
461 ns->send_packet (sl);
462 sl.reset ();
463 return;
464 }
465
466 sl.printf ("replyinfo image_sums %d %d ", start, stop);
467
468 for (int i = start; i <= stop && i < faces.size (); i++)
469 {
470 ns->faces_sent[i] = true;
471
472 const facedata *d = face_data (i, ns->faceset);
473
474 if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
475 break;
476
477 sl << uint16 (i)
478 << uint32 (0) // checksum
479 << uint8 (ns->faceset);
480
481 print_facename (sl, *d); sl << uint8 (0);
482 }
483
484 /* It would make more sense to catch this pre-emptively in the code above.
485 * however, if this really happens, we probably just want to cut down the
486 * size to less than 1000, since that is what we claim the protocol would
487 * support.
488 */
489 //TODO: taken care of above, should simply abort or make sure the above code is correct
490 if (sl.length () >= MAXSOCKBUF)
491 {
492 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
493 abort ();
494 }
495
496 ns->send_packet (sl);
497} 268}
498 269

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines