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.49 by root, Thu Jul 12 18:48:54 2007 UTC vs.
Revision 1.74 by root, Sun Nov 11 18:21:21 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/*
25 * Image related communication 26 * Image related communication
26 *
27 * \date 2003-12-02
28 * 27 *
29 * This file deals with the image related communication to the 28 * This file deals with the image related communication to the
30 * client. I've located all the functions in this file - this 29 * client. I've located all the functions in this file - this
31 * 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
32 * things like all the structures as globals. 31 * things like all the structures as globals.
35#include <global.h> 34#include <global.h>
36#include <sproto.h> 35#include <sproto.h>
37 36
38#include "crc.h" 37#include "crc.h"
39 38
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 39#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 40
194/** 41/**
195 * client requested an image. send it rate-limited 42 * client requested an image. send it rate-limited
196 * before flushing. 43 * before flushing.
197 */ 44 */
200{ 47{
201 int idx = 0, pri = 0; 48 int idx = 0, pri = 0;
202 49
203 sscanf (buf, "%d %d", &idx, &pri); 50 sscanf (buf, "%d %d", &idx, &pri);
204 51
205 const facedata *d = face_data (idx, ns->faceset); 52 //TODO: somehow fetch default priority from send_fx here
206 53
54 const faceinfo *f = face_info (idx);
55
207 if (!d) 56 if (!f)
208 return; // doh 57 return; // doh
209 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);
210 client::ixsend ix; 74 ixsend ix;
211 75
212 ix.pri = pri; 76 ix.pri = pri;
213 ix.idx = idx; 77 ix.idx = idx;
214 ix.ofs = d->data.size (); 78 ix.ofs = size;
79 ix.data = (uint8 *)data;
80 ix.data_sv = SvREFCNT_inc (data_sv);
215 81
216 auto (pos, ns->ixface.end ()); 82 auto (pos, ixface.end ());
217 83
218 if (ns->fxix < 2)
219 {
220 // gcfclient does not support prioritising, older cfplus versions
221 // do not support interleaved transfers.
222 if (!ns->ixface.empty ())
223 pos = ns->ixface.end () - 1;
224 }
225 else
226 {
227 // the by far most common case will be to insert 84 // the by far most common case will be to insert
228 // near the end, so little looping. 85 // near the end, so little looping.
229 while (pos != ns->ixface.begin ()) 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)))
230 { 92 {
231 --pos;
232
233 // sort within 2k bins, to slightly prefer smaller images
234 if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11)))
235 {
236 ++pos; 93 ++pos;
237 break; 94 break;
238 }
239 } 95 }
240 } 96 }
241 97
242 ns->ixface.insert (pos, ix); 98 ixface.insert (pos, ix);
243 99
244#if 0 100#if 0
245 for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i) 101 for (auto (i, ixface.begin ()); i != ixface.end (); ++i)
246 fprintf (stderr, "<%d,%d> ", i->pri, i->ofs); 102 fprintf (stderr, "<%d,%d> ", i->pri, i->ofs);
247 fprintf (stderr, "\n"); 103 fprintf (stderr, "\n");
248#endif 104#endif
249} 105}
250 106
107void
108client::ix_pop ()
109{
110 ixsend &ix = ixface.back ();
111
112 SvREFCNT_dec (ix.data_sv);
113
114 ixface.pop_back ();
115}
116
251/** 117/**
252 * Tells client the picture it has to use 118 * Sends a face offer (fx) to a client.
253 * to smooth a picture number given as argument.
254 */
255void
256AskSmooth (char *buf, int len, client *ns)
257{
258 ns->send_face (atoi (buf));
259 ns->flush_fx ();
260}
261
262// how lame
263static void print_facename (packet &sl, const facedata &d)
264{
265 for (int i = 0; i < CHKSUM_SIZE; ++i)
266 sl.printf ("%02x", d.chksum [i]);
267}
268
269// gcfclient uses the server-provided checksum for comparison, but always
270// writes a broken checksum to its cache file, so we have to provide
271// gcfclient with the same broken (and useless) checksum just to have it
272// cache the image despite its bugs.
273static uint32 gcfclient_checksum (const facedata *d)
274{
275 uint32 csum = 0;
276
277 for (std::string::const_iterator i = d->data.begin ();
278 i != d->data.end ();
279 ++i)
280 {
281 csum = rotate_right (csum);
282 csum += *(uint8 *)&*i;
283 }
284
285 return csum;
286}
287
288/**
289 * Sends a face to a client if they are in pixmap mode
290 * nothing gets sent in bitmap mode.
291 * 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 -
292 * 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
293 * 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,
294 * 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.
295 */ 123 */
296void 124void
297client::send_face (faceidx facenum) 125client::send_face (faceidx facenum, int pri)
298{ 126{
299 // never send face 0. ever. it does not exist. 127 // never send face 0. ever. it does not exist.
300 if (!facenum) 128 if (!facenum)
301 return; 129 return;
302 130
303 const facedata *d = face_data (facenum, faceset); 131 faceinfo *f = face_info (facenum);
304 132
305 if (!d) 133 if (!f)
306 { 134 {
307 LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); 135 LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum);
308 return; 136 return;
309 } 137 }
310 138
311 faceinfo *f = face_info (facenum);
312
313 // refuse tos end non-image faces 139 // refuse to send non-image faces unless requested
314 if (f->type) 140 if (!fx_want [f->type])
315 return; 141 return;
316 142
317 if (!must_send_face (facenum)) 143 if (faces_sent [facenum])
318 return; 144 return;
319 145
320 // if for some reason we let a client without face caching connect, 146 faces_sent [facenum] = true;
321 // we better support that decision here and implement it.
322 if (!facecache)
323 return send_image (facenum);
324 147
325 if (fxix)
326 {
327 fxface.push_back (facenum); 148 fxface.push_back (facenum);
328 return;
329 }
330
331 packet sl;
332
333 if (force_face0)
334 sl << "face " << uint16 (facenum);
335 else if (image2)
336 sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
337 else
338 sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
339
340 // how lame
341 print_facename (sl, *d);
342 send_packet (sl);
343
344 if (EMI_smooth)
345 {
346 if (f->smooth)
347 {
348 send_face (f->smooth);
349
350 packet sl ("smooth");
351
352 sl << uint16 (facenum)
353 << uint16 (f->smooth);
354
355 send_packet (sl);
356 }
357 }
358} 149}
359 150
360void client::flush_fx () 151void client::flush_fx ()
361{ 152{
362 while (!fxface.empty ()) 153 while (!fxface.empty ())
363 { 154 {
364 packet fx ("fx"); 155 packet fx ("fx");
365 packet sx ("sx"); 156 packet sx ("sx");
157 int type = 0;
366 158
367 do 159 do
368 { 160 {
369 faceidx facenum = fxface.back (); fxface.pop_back (); 161 faceidx facenum = fxface.back (); fxface.pop_back ();
370 162
371 const facedata *d = face_data (facenum, faceset); 163 if (const faceinfo *f = face_info (facenum))
372
373 if (d)
374 { 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
375 fx << ber32 (facenum) 175 fx << ber32 (facenum)
376 << data8 (d->chksum, CHKSUM_SIZE); 176 << data8 (d->chksum, d->chksum_len);
377 177
378 if (smoothing) 178 if (smoothing)
379 { 179 {
380 faceinfo *f = face_info (facenum); 180 faceinfo *f = face_info (facenum);
381 181
382 if (f->smooth) 182 if (f->smooth)
383 { 183 {
384 send_face (f->smooth); 184 send_face (f->smooth, -110);
185
385 sx << ber32 (facenum) 186 sx << ber32 (facenum)
386 << ber32 (f->smooth) 187 << ber32 (f->smooth)
387 << ber32 (f->smoothlevel); 188 << ber32 (f->smoothlevel);
388 } 189 }
389 } 190 }
390 } 191 }
391 } 192 }
392 while (!fxface.empty () 193 while (!fxface.empty ()
393 && fx.room () > ber32::size + CHKSUM_SIZE + 1 194 && fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */
394 && sx.room () > ber32::size * 3); 195 && sx.room () > ber32::size * 3);
395 196
396 send_packet (fx); 197 send_packet (fx);
397 if (sx.length () > 3) send_packet (sx); 198 if (sx.length () > 3) send_packet (sx);
398 } 199 }
399}
400
401void
402client::send_image (faceidx facenum)
403{
404 // never send face 0. ever. it does not exist.
405 if (!facenum)
406 return;
407
408 const facedata *d = face_data (facenum, faceset);
409
410 faces_sent[facenum] = true;
411
412 if (!d)
413 {
414 LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
415 return;
416 }
417
418 //TODO: check type here?
419
420 if (force_image_newmap)
421 force_newmap = true;
422
423 packet sl;
424
425 sl << (image2 ? "image2 " : "image ")
426 << uint32 (facenum);
427
428 if (image2)
429 sl << uint8 (0);
430
431 sl << uint32 (d->data.size ())
432 << data (d->data.data (), d->data.size ());
433
434 send_packet (sl);
435} 200}
436 201
437// send all faces of this object to the client 202// send all faces of this object to the client
438// this uses more bandwidth initially, but makes 203// this uses more bandwidth initially, but makes
439// animations look much smoother, and every client 204// animations look much smoother, and every client
440// is supposed to do client-side caching anyways. 205// is supposed to do client-side caching anyways.
441void 206void
442client::send_faces (object *ob) 207client::send_faces (object *ob)
443{ 208{
444 send_face (ob->face); 209 send_face (ob->face, 10);
445 210
446 if (ob->animation_id) 211 if (ob->animation_id)
447 { 212 {
448 animation &anim = animations [ob->animation_id]; 213 const animation &anim = ob->anim ();
449 214
450 for (int i = 0; i < anim.num_animations; i++) 215 for (int i = 0; i < anim.num_animations; i++)
451 send_face (anim.faces [i]); 216 send_face (anim.faces [i], -10);
452 } 217 }
453} 218}
454 219
455/** 220/**
456 * Need to send an animation sequence to the client. 221 * Need to send an animation sequence to the client.
461 */ 226 */
462void 227void
463client::send_animation (short anim_num) 228client::send_animation (short anim_num)
464{ 229{
465 /* 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
466 * 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
467 * range, it must be a valid animation. 232 * range, it must be a valid animation.
468 */ 233 */
469 if (anim_num < 0 || anim_num >= animations.size ()) 234 if (anim_num < 0 || anim_num >= animations.size ())
470 { 235 {
471 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);
480 /* 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
481 * the face itself) down to the client. 246 * the face itself) down to the client.
482 */ 247 */
483 for (int i = 0; i < animations[anim_num].num_animations; i++) 248 for (int i = 0; i < animations[anim_num].num_animations; i++)
484 { 249 {
485 send_face (animations[anim_num].faces[i]); 250 send_face (animations[anim_num].faces[i], -20);
486 sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ 251 sl << uint16 (animations[anim_num].faces[i]);
487 } 252 }
488 253
489 send_packet (sl); 254 send_packet (sl);
490 255
491 anims_sent[anim_num] = 1; 256 anims_sent[anim_num] = 1;
492} 257}
493 258
494/**
495 * Sends the number of images, checksum of the face file,
496 * and the image_info file information. See the doc/Developers/protocol
497 * if you want further detail.
498 */
499void 259void
500send_image_info (client *ns, char *params) 260client::invalidate_face (faceidx idx)
501{ 261{
502 packet sl; 262 faces_sent [idx] = false;
503 263 force_newmap = true;
504 //TODO: second parameter is a checksum, but it makes no sense in this current framework
505 sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
506
507 sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
508
509 ns->send_packet (sl);
510} 264}
511 265
512/**
513 * Sends requested face information.
514 * \param ns socket to send to
515 * \param params contains first and last index of face
516 *
517 * For each image in [start..stop] sends
518 * - checksum
519 * - name
520 */
521void 266void
522send_image_sums (client *ns, char *params) 267client::invalidate_all_faces ()
523{ 268{
524 int start, stop; 269 faces_sent.reset ();
525 char *cp; 270 force_newmap = true;
526
527 packet sl;
528
529 start = atoi (params);
530 for (cp = params; *cp != '\0'; cp++)
531 if (*cp == ' ')
532 break;
533
534 stop = atoi (cp);
535 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
536 {
537 sl.printf ("replyinfo image_sums %d %d", start, stop);
538 ns->send_packet (sl);
539 sl.reset ();
540 return;
541 }
542
543 sl.printf ("replyinfo image_sums %d %d ", start, stop);
544
545 for (int i = start; i <= stop && i < faces.size (); i++)
546 {
547 ns->faces_sent[i] = true;
548
549 const facedata *d = face_data (i, ns->faceset);
550
551 if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
552 break;
553
554 sl << uint16 (i)
555 << uint32 (0) // checksum
556 << uint8 (ns->faceset);
557
558 print_facename (sl, *d); sl << uint8 (0);
559 }
560
561 /* It would make more sense to catch this pre-emptively in the code above.
562 * however, if this really happens, we probably just want to cut down the
563 * size to less than 1000, since that is what we claim the protocol would
564 * support.
565 */
566 //TODO: taken care of above, should simply abort or make sure the above code is correct
567 if (sl.length () >= MAXSOCKBUF)
568 {
569 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
570 abort ();
571 }
572
573 ns->send_packet (sl);
574} 271}
575 272

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines