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.43 by root, Sun Jul 1 04:08:14 2007 UTC vs.
Revision 1.62 by root, Sun Nov 15 18:04:00 2009 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. 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 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 it 8 * Deliantra is free software: you can redistribute it and/or modify it under
9 * under the terms of the GNU General Public License as published by the Free 9 * the terms of the Affero GNU General Public License as published by the
10 * Software Foundation; either version 2 of the License, or (at your option) 10 * Free Software Foundation, either version 3 of the License, or (at your
11 * any later version. 11 * option) any later version.
12 * 12 *
13 * This program is distributed in the hope that it will be useful, but 13 * This program is distributed in the hope that it will be useful,
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * 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 along 18 * You should have received a copy of the Affero GNU General Public License
19 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 19 * and the GNU General Public License along with this program. If not, see
20 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 20 * <http://www.gnu.org/licenses/>.
21 * 21 *
22 * 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>
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 */
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
67/**
68 * Checks specified faceset is valid
69 * \param fsn faceset number
70 */
71int
72is_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 */
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 41#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 42
195/** 43/**
196 * client requested an image. send it rate-limited 44 * client requested an image. send it rate-limited
197 * before flushing. 45 * before flushing.
198 */ 46 */
201{ 49{
202 int idx = 0, pri = 0; 50 int idx = 0, pri = 0;
203 51
204 sscanf (buf, "%d %d", &idx, &pri); 52 sscanf (buf, "%d %d", &idx, &pri);
205 53
54 //TODO: somehow fetch default priority from send_fx here
55
206 const facedata *d = face_data (idx, ns->faceset); 56 const facedata *d = face_data (idx, ns->faceset);
207 57
208 if (!d) 58 if (!d)
209 return; // doh 59 return; // doh
210 60
212 62
213 ix.pri = pri; 63 ix.pri = pri;
214 ix.idx = idx; 64 ix.idx = idx;
215 ix.ofs = d->data.size (); 65 ix.ofs = d->data.size ();
216 66
67 auto (pos, ns->ixface.end ());
68
217 // the by far most common case will be to insert 69 // the by far most common case will be to insert
218 // right at the end, so no looping. 70 // near the end, so little looping.
219 auto (i, ns->ixface.end ());
220 for (; i != ns->ixface.begin (); ) 71 while (pos != ns->ixface.begin ())
221 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;
222 break; 79 break;
80 }
81 }
223 82
224 ns->ixface.insert (i, ix); 83 ns->ixface.insert (pos, ix);
225}
226 84
227/** 85#if 0
228 * Tells client the picture it has to use 86 for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i)
229 * to smooth a picture number given as argument. 87 fprintf (stderr, "<%d,%d> ", i->pri, i->ofs);
230 */ 88 fprintf (stderr, "\n");
231void 89#endif
232AskSmooth (char *buf, int len, client *ns)
233{
234 ns->send_face (atoi (buf));
235 ns->flush_fx ();
236}
237
238// how lame
239static void print_facename (packet &sl, const facedata &d)
240{
241 for (int i = 0; i < CHKSUM_SIZE; ++i)
242 sl.printf ("%02x", d.chksum [i]);
243}
244
245// gcfclient uses the server-provided checksum for comparison, but always
246// writes a broken checksum to its cache file, so we have to provide
247// gcfclient with the same broken (and useless) checksum just to have it
248// cache the image despite its bugs.
249static uint32 gcfclient_checksum (const facedata *d)
250{
251 uint32 csum = 0;
252
253 for (std::string::const_iterator i = d->data.begin ();
254 i != d->data.end ();
255 ++i)
256 {
257 csum = rotate_right (csum);
258 csum += *(uint8 *)&*i;
259 }
260
261 return csum;
262} 90}
263 91
264/** 92/**
265 * 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
266 * nothing gets sent in bitmap mode. 94 * nothing gets sent in bitmap mode.
268 * 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
269 * 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,
270 * 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.
271 */ 99 */
272void 100void
273client::send_face (faceidx facenum) 101client::send_face (faceidx facenum, int pri)
274{ 102{
275 // never send face 0. ever. it does not exist. 103 // never send face 0. ever. it does not exist.
276 if (!facenum) 104 if (!facenum)
277 return; 105 return;
278 106
279 const facedata *d = face_data (facenum, faceset); 107 faceinfo *f = face_info (facenum);
280 108
281 if (!d) 109 if (!f)
282 { 110 {
283 LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); 111 LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum);
284 return; 112 return;
285 } 113 }
286 114
287 if (faces_sent[facenum]) 115 // refuse to send non-image faces
116 if (!fx_want [f->type])
288 return; 117 return;
289 118
119 if (faces_sent [facenum])
120 return;
121
290 faces_sent[facenum] = true; 122 faces_sent[facenum] = true;
291 123
292 // if for some reason we let a client without face caching connect,
293 // we better support that decision here and implement it.
294 if (!facecache)
295 return send_image (facenum);
296
297 if (fxix)
298 {
299 fxface.push_back (facenum); 124 fxface.push_back (facenum);
300 return;
301 }
302
303 packet sl;
304
305 if (force_face0)
306 sl << "face " << uint16 (facenum);
307 else if (image2)
308 sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
309 else
310 sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
311
312 // how lame
313 print_facename (sl, *d);
314 send_packet (sl);
315
316 if (EMI_smooth)
317 {
318 faceinfo *f = face_info (facenum);
319
320 if (f->smooth)
321 {
322 send_face (f->smooth);
323
324 packet sl ("smooth");
325
326 sl << uint16 (facenum)
327 << uint16 (f->smooth);
328
329 send_packet (sl);
330 }
331 }
332} 125}
333 126
334void client::flush_fx () 127void client::flush_fx ()
335{ 128{
336 while (!fxface.empty ()) 129 while (!fxface.empty ())
337 { 130 {
338 packet fx ("fx"); 131 packet fx ("fx");
339 packet sx ("sx"); 132 packet sx ("sx");
133 int type = 0;
340 134
341 do 135 do
342 { 136 {
343 faceidx facenum = fxface.back (); fxface.pop_back (); 137 faceidx facenum = fxface.back (); fxface.pop_back ();
344 138
345 const facedata *d = face_data (facenum, faceset); 139 if (const faceinfo *f = face_info (facenum))
346
347 if (d)
348 { 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
349 fx << ber32 (facenum) 151 fx << ber32 (facenum)
350 << data8 (d->chksum, CHKSUM_SIZE); 152 << data8 (d->chksum, d->chksum_len);
351 153
352 if (smoothing) 154 if (smoothing)
353 { 155 {
354 faceinfo *f = face_info (facenum); 156 faceinfo *f = face_info (facenum);
355 157
356 if (f->smooth) 158 if (f->smooth)
357 { 159 {
358 send_face (f->smooth); 160 send_face (f->smooth, -110);
161
359 sx << ber32 (facenum) 162 sx << ber32 (facenum)
360 << ber32 (f->smooth) 163 << ber32 (f->smooth)
361 << ber32 (f->smoothlevel); 164 << ber32 (f->smoothlevel);
362 } 165 }
363 } 166 }
364 } 167 }
365 } 168 }
366 while (!fxface.empty () 169 while (!fxface.empty ()
367 && fx.room () > ber32::size + CHKSUM_SIZE + 1 170 && fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */
368 && sx.room () > ber32::size * 3); 171 && sx.room () > ber32::size * 3);
369 172
370 send_packet (fx); 173 send_packet (fx);
371 if (sx.length () > 3) send_packet (sx); 174 if (sx.length () > 3) send_packet (sx);
372 } 175 }
373}
374
375void
376client::send_image (faceidx facenum)
377{
378 // never send face 0. ever. it does not exist.
379 if (!facenum)
380 return;
381
382 const facedata *d = face_data (facenum, faceset);
383
384 faces_sent[facenum] = true;
385
386 if (!d)
387 {
388 LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
389 return;
390 }
391
392 //TODO: check type here?
393
394 if (force_image_newmap)
395 force_newmap = true;
396
397 packet sl;
398
399 sl << (image2 ? "image2 " : "image ")
400 << uint32 (facenum);
401
402 if (image2)
403 sl << uint8 (0);
404
405 sl << uint32 (d->data.size ())
406 << data (d->data.data (), d->data.size ());
407
408 send_packet (sl);
409} 176}
410 177
411// send all faces of this object to the client 178// send all faces of this object to the client
412// this uses more bandwidth initially, but makes 179// this uses more bandwidth initially, but makes
413// animations look much smoother, and every client 180// animations look much smoother, and every client
414// is supposed to do client-side caching anyways. 181// is supposed to do client-side caching anyways.
415void 182void
416client::send_faces (object *ob) 183client::send_faces (object *ob)
417{ 184{
418 send_face (ob->face); 185 send_face (ob->face, 10);
419 186
420 if (ob->animation_id) 187 if (ob->animation_id)
421 { 188 {
422 animation &anim = animations [ob->animation_id]; 189 const animation &anim = ob->anim ();
423 190
424 for (int i = 0; i < anim.num_animations; i++) 191 for (int i = 0; i < anim.num_animations; i++)
425 send_face (anim.faces [i]); 192 send_face (anim.faces [i], -10);
426 } 193 }
427} 194}
428 195
429/** 196/**
430 * Need to send an animation sequence to the client. 197 * Need to send an animation sequence to the client.
435 */ 202 */
436void 203void
437client::send_animation (short anim_num) 204client::send_animation (short anim_num)
438{ 205{
439 /* 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
440 * 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
441 * range, it must be a valid animation. 208 * range, it must be a valid animation.
442 */ 209 */
443 if (anim_num < 0 || anim_num >= animations.size ()) 210 if (anim_num < 0 || anim_num >= animations.size ())
444 { 211 {
445 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);
454 /* 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
455 * the face itself) down to the client. 222 * the face itself) down to the client.
456 */ 223 */
457 for (int i = 0; i < animations[anim_num].num_animations; i++) 224 for (int i = 0; i < animations[anim_num].num_animations; i++)
458 { 225 {
459 send_face (animations[anim_num].faces[i]); 226 send_face (animations[anim_num].faces[i], -20);
460 sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ 227 sl << uint16 (animations[anim_num].faces[i]);
461 } 228 }
462 229
463 send_packet (sl); 230 send_packet (sl);
464 231
465 anims_sent[anim_num] = 1; 232 anims_sent[anim_num] = 1;
466} 233}
467 234
468/**
469 * Sends the number of images, checksum of the face file,
470 * and the image_info file information. See the doc/Developers/protocol
471 * if you want further detail.
472 */
473void
474send_image_info (client *ns, char *params)
475{
476 packet sl;
477
478 //TODO: second parameter is a checksum, but it makes no sense in this current framework
479 sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
480
481 sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
482
483 ns->send_packet (sl);
484}
485
486/**
487 * Sends requested face information.
488 * \param ns socket to send to
489 * \param params contains first and last index of face
490 *
491 * For each image in [start..stop] sends
492 * - checksum
493 * - name
494 */
495void
496send_image_sums (client *ns, char *params)
497{
498 int start, stop;
499 char *cp;
500
501 packet sl;
502
503 start = atoi (params);
504 for (cp = params; *cp != '\0'; cp++)
505 if (*cp == ' ')
506 break;
507
508 stop = atoi (cp);
509 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
510 {
511 sl.printf ("replyinfo image_sums %d %d", start, stop);
512 ns->send_packet (sl);
513 sl.reset ();
514 return;
515 }
516
517 sl.printf ("replyinfo image_sums %d %d ", start, stop);
518
519 for (int i = start; i <= stop && i < faces.size (); i++)
520 {
521 ns->faces_sent[i] = true;
522
523 const facedata *d = face_data (i, ns->faceset);
524
525 if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
526 break;
527
528 sl << uint16 (i)
529 << uint32 (0) // checksum
530 << uint8 (ns->faceset);
531
532 print_facename (sl, *d); sl << uint8 (0);
533 }
534
535 /* It would make more sense to catch this pre-emptively in the code above.
536 * however, if this really happens, we probably just want to cut down the
537 * size to less than 1000, since that is what we claim the protocol would
538 * support.
539 */
540 //TODO: taken care of above, should simply abort or make sure the above code is correct
541 if (sl.length () >= MAXSOCKBUF)
542 {
543 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
544 abort ();
545 }
546
547 ns->send_packet (sl);
548}
549

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines