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.44 by root, Sun Jul 1 05:00:20 2007 UTC vs.
Revision 1.67 by root, Tue Jan 3 11:25:37 2012 UTC

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

Diff Legend

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