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.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);
81
82 auto (pos, ixface.end ());
215 83
216 // the by far most common case will be to insert 84 // the by far most common case will be to insert
217 // right at the end, so no looping. 85 // near the end, so little looping.
218 auto (i, ns->ixface.end ()); 86 while (pos != ixface.begin ())
219 for (; i != ns->ixface.begin (); ) 87 {
220 if (pri >= (--i)->pri) 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;
221 break; 94 break;
95 }
96 }
222 97
223 ns->ixface.insert (i, ix); 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 ();
224} 115}
225 116
226/** 117/**
227 * Tells client the picture it has to use 118 * Sends a face offer (fx) to a client.
228 * to smooth a picture number given as argument.
229 */
230void
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}
262
263/**
264 * Sends a face to a client if they are in pixmap mode
265 * nothing gets sent in bitmap mode.
266 * 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 -
267 * 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
268 * 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,
269 * 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.
270 */ 123 */
271void 124void
272client::send_face (faceidx facenum) 125client::send_face (faceidx facenum, int pri)
273{ 126{
274 // never send face 0. ever. it does not exist. 127 // never send face 0. ever. it does not exist.
275 if (!facenum) 128 if (!facenum)
276 return; 129 return;
277 130
278 const facedata *d = face_data (facenum, faceset); 131 faceinfo *f = face_info (facenum);
279 132
280 if (!d) 133 if (!f)
281 { 134 {
282 LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); 135 LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum);
283 return; 136 return;
284 } 137 }
285 138
286 if (faces_sent[facenum]) 139 // refuse to send non-image faces unless requested
140 if (!fx_want [f->type])
287 return; 141 return;
288 142
143 if (faces_sent [facenum])
144 return;
145
289 faces_sent[facenum] = true; 146 faces_sent [facenum] = true;
290 147
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); 148 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} 149}
332 150
333void client::flush_fx () 151void client::flush_fx ()
334{ 152{
335 while (!fxface.empty ()) 153 while (!fxface.empty ())
336 { 154 {
337 packet fx ("fx"); 155 packet fx ("fx");
338 packet sx ("sx"); 156 packet sx ("sx");
157 int type = 0;
339 158
340 do 159 do
341 { 160 {
342 faceidx facenum = fxface.back (); fxface.pop_back (); 161 faceidx facenum = fxface.back (); fxface.pop_back ();
343 162
344 const facedata *d = face_data (facenum, faceset); 163 if (const faceinfo *f = face_info (facenum))
345
346 if (d)
347 { 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
348 fx << ber32 (facenum) 175 fx << ber32 (facenum)
349 << data8 (d->chksum, CHKSUM_SIZE); 176 << data8 (d->chksum, d->chksum_len);
350 177
351 if (smoothing) 178 if (smoothing)
352 { 179 {
353 faceinfo *f = face_info (facenum); 180 faceinfo *f = face_info (facenum);
354 181
355 if (f->smooth) 182 if (f->smooth)
356 { 183 {
357 send_face (f->smooth); 184 send_face (f->smooth, -110);
185
358 sx << ber32 (facenum) 186 sx << ber32 (facenum)
359 << ber32 (f->smooth) 187 << ber32 (f->smooth)
360 << ber32 (f->smoothlevel); 188 << ber32 (f->smoothlevel);
361 } 189 }
362 } 190 }
363 } 191 }
364 } 192 }
365 while (!fxface.empty () 193 while (!fxface.empty ()
366 && fx.room () > ber32::size + CHKSUM_SIZE + 1 194 && fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */
367 && sx.room () > ber32::size * 3); 195 && sx.room () > ber32::size * 3);
368 196
369 send_packet (fx); 197 send_packet (fx);
370 if (sx.length () > 3) send_packet (sx); 198 if (sx.length () > 3) send_packet (sx);
371 } 199 }
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} 200}
409 201
410// send all faces of this object to the client 202// send all faces of this object to the client
411// this uses more bandwidth initially, but makes 203// this uses more bandwidth initially, but makes
412// animations look much smoother, and every client 204// animations look much smoother, and every client
413// is supposed to do client-side caching anyways. 205// is supposed to do client-side caching anyways.
414void 206void
415client::send_faces (object *ob) 207client::send_faces (object *ob)
416{ 208{
417 send_face (ob->face); 209 send_face (ob->face, 10);
418 210
419 if (ob->animation_id) 211 if (ob->animation_id)
420 { 212 {
421 animation &anim = animations [ob->animation_id]; 213 const animation &anim = ob->anim ();
422 214
423 for (int i = 0; i < anim.num_animations; i++) 215 for (int i = 0; i < anim.num_animations; i++)
424 send_face (anim.faces [i]); 216 send_face (anim.faces [i], -10);
425 } 217 }
426} 218}
427 219
428/** 220/**
429 * Need to send an animation sequence to the client. 221 * Need to send an animation sequence to the client.
434 */ 226 */
435void 227void
436client::send_animation (short anim_num) 228client::send_animation (short anim_num)
437{ 229{
438 /* 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
439 * 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
440 * range, it must be a valid animation. 232 * range, it must be a valid animation.
441 */ 233 */
442 if (anim_num < 0 || anim_num >= animations.size ()) 234 if (anim_num < 0 || anim_num >= animations.size ())
443 { 235 {
444 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);
453 /* 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
454 * the face itself) down to the client. 246 * the face itself) down to the client.
455 */ 247 */
456 for (int i = 0; i < animations[anim_num].num_animations; i++) 248 for (int i = 0; i < animations[anim_num].num_animations; i++)
457 { 249 {
458 send_face (animations[anim_num].faces[i]); 250 send_face (animations[anim_num].faces[i], -20);
459 sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ 251 sl << uint16 (animations[anim_num].faces[i]);
460 } 252 }
461 253
462 send_packet (sl); 254 send_packet (sl);
463 255
464 anims_sent[anim_num] = 1; 256 anims_sent[anim_num] = 1;
465} 257}
466 258
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 259void
473send_image_info (client *ns, char *params) 260client::invalidate_face (faceidx idx)
474{ 261{
475 packet sl; 262 faces_sent [idx] = false;
476 263 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} 264}
484 265
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 266void
495send_image_sums (client *ns, char *params) 267client::invalidate_all_faces ()
496{ 268{
497 int start, stop; 269 faces_sent.reset ();
498 char *cp; 270 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} 271}
548 272

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines