ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/image.C
Revision: 1.42
Committed: Mon May 28 21:22:26 2007 UTC (17 years ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.41: +21 -21 lines
Log Message:
update copyrights in socket/*.C

File Contents

# User Rev Content
1 elmex 1.1 /*
2 root 1.42 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
3     *
4     * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5     * Copyright (©) 2001,2007 Mark Wedel
6     * Copyright (©) 1992,2007 Frank Tore Johansen
7     *
8     * Crossfire TRT is free software; you can redistribute it and/or modify it
9     * under the terms of the GNU General Public License as published by the Free
10     * Software Foundation; either version 2 of the License, or (at your option)
11     * any later version.
12     *
13     * This program is distributed in the hope that it will be useful, but
14     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16     * for more details.
17     *
18     * You should have received a copy of the GNU General Public License along
19     * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
20     * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21     *
22     * The authors can be reached via e-mail to <crossfire@schmorp.de>
23 root 1.17 */
24 elmex 1.1
25     /** \file
26     * Image related communication
27     *
28     * \date 2003-12-02
29     *
30     * This file deals with the image related communication to the
31     * client. I've located all the functions in this file - this
32     * localizes it more, and means that we don't need to declare
33     * things like all the structures as globals.
34     */
35    
36     #include <global.h>
37     #include <sproto.h>
38    
39 root 1.20 #include "crc.h"
40    
41 elmex 1.1 #define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */
42    
43     /** Information about one image */
44 root 1.3 typedef struct FaceInfo
45     {
46     uint8 *data; /**< image data */
47     uint16 datalen; /**< length of the xpm data */
48     uint32 checksum; /**< Checksum of face data */
49 elmex 1.1 } FaceInfo;
50    
51     /** Information about one face set */
52 root 1.3 typedef 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 elmex 1.1 } FaceSets;
64    
65     static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */
66    
67     /**
68     * Checks specified faceset is valid
69     * \param fsn faceset number
70     */
71 root 1.3 int
72     is_valid_faceset (int fsn)
73 elmex 1.1 {
74 root 1.3 if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix)
75     return TRUE;
76     return FALSE;
77 elmex 1.1 }
78    
79     /**
80     * Frees all faceset information
81     */
82 root 1.3 void
83     free_socket_images (void)
84 elmex 1.1 {
85 root 1.3 int num, q;
86 elmex 1.1
87 root 1.3 for (num = 0; num < MAX_FACE_SETS; num++)
88     {
89     if (facesets[num].prefix)
90     {
91 root 1.24 for (q = 0; q < faces.size (); q++)
92 root 1.3 if (facesets[num].faces[q].data)
93     free (facesets[num].faces[q].data);
94 root 1.15
95 root 1.3 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 root 1.2 }
102 elmex 1.1 }
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     */
117 root 1.3 static int
118     get_face_fallback (int faceset, int imageno)
119 elmex 1.1 {
120 root 1.3 /* 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 root 1.15
135 root 1.3 if (facesets[faceset].faces[imageno].data)
136     return faceset;
137 root 1.15
138 root 1.3 return get_face_fallback (facesets[faceset].fallback, imageno);
139 elmex 1.1 }
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     */
149 root 1.3 static void
150     check_faceset_fallback (int faceset, int togo)
151 elmex 1.1 {
152 root 1.3 int fallback = facesets[faceset].fallback;
153 elmex 1.1
154 root 1.3 /* 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 root 1.15
164 root 1.3 togo--;
165     if (togo == 0)
166     {
167     LOG (llevError, "Infinite loop found in facesets. aborting.\n");
168     abort ();
169 elmex 1.1 }
170 root 1.15
171 root 1.3 check_faceset_fallback (fallback, togo);
172 elmex 1.1 }
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     */
181 root 1.3 void
182 root 1.13 SetFaceMode (char *buf, int len, client *ns)
183 elmex 1.1 {
184 root 1.3 int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
185 elmex 1.1
186 root 1.3 if (mode == CF_FACE_NONE)
187 root 1.7 ns->facecache = 1;
188 root 1.3 else if (mode != CF_FACE_PNG)
189 root 1.14 ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
190 root 1.7
191 root 1.3 if (mask)
192 root 1.7 ns->facecache = 1;
193 elmex 1.1 }
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     */
200 root 1.3 void
201 root 1.15 SendFaceCmd (char *buf, int len, client *ns)
202 elmex 1.1 {
203 root 1.32 ns->send_image (atoi (buf));
204 elmex 1.1 }
205    
206 root 1.24 // how lame
207     static void print_facename (packet &sl, const facedata &d)
208     {
209 root 1.25 for (int i = 0; i < CHKSUM_SIZE; ++i)
210     sl.printf ("%02x", d.chksum [i]);
211 root 1.24 }
212    
213 root 1.32 // 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.
217 root 1.26 static 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 elmex 1.1 /**
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 -
236     * 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,
238     * we look at the facecache, and if set, send the image name.
239     */
240 root 1.3 void
241 root 1.32 client::send_face (faceidx facenum)
242 elmex 1.1 {
243 root 1.28 // never send face 0. ever. it does not exist.
244     if (!facenum)
245     return;
246    
247     const facedata *d = face_data (facenum, faceset);
248    
249     if (!d)
250 root 1.3 {
251 root 1.28 LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum);
252 root 1.3 return;
253     }
254    
255 root 1.32 if (faces_sent[facenum])
256     return;
257    
258     faces_sent[facenum] = true;
259    
260 root 1.38 // if for some reason we let a client without face caching connect,
261     // we better support that decision here and implement it.
262 root 1.33 if (!facecache)
263 root 1.38 return send_image (facenum);
264 root 1.33
265 root 1.39 if (fxix)
266     {
267     fxface.push_back (facenum);
268     return;
269     }
270    
271 root 1.8 packet sl;
272 root 1.3
273 root 1.32 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 root 1.40 if (EMI_smooth)
285 root 1.3 {
286 root 1.40 faceinfo *f = face_info (facenum);
287 root 1.28
288 root 1.40 if (f->smooth)
289     {
290     send_face (f->smooth);
291    
292     packet sl ("smooth");
293 root 1.30
294 root 1.40 sl << uint16 (facenum)
295     << uint16 (f->smooth);
296 root 1.31
297 root 1.40 send_packet (sl);
298     }
299 root 1.32 }
300     }
301    
302 root 1.39 void client::flush_fx ()
303     {
304     while (!fxface.empty ())
305     {
306 root 1.40 packet fx ("fx");
307     packet sx ("sx");
308 root 1.39
309     do
310     {
311     faceidx facenum = fxface.back (); fxface.pop_back ();
312    
313     const facedata *d = face_data (facenum, faceset);
314    
315     if (d)
316     {
317 root 1.40 fx << ber32 (facenum)
318 root 1.39 << data8 (d->chksum, CHKSUM_SIZE);
319    
320 root 1.40 if (smoothing)
321     {
322     faceinfo *f = face_info (facenum);
323    
324     if (f->smooth)
325     {
326     send_face (f->smooth);
327     sx << ber32 (facenum)
328     << ber32 (f->smooth)
329     << ber32 (f->smoothlevel);
330     }
331     }
332 root 1.39 }
333     }
334 root 1.40 while (!fxface.empty ()
335     && fx.room () > ber32::size + CHKSUM_SIZE + 1
336     && sx.room () > ber32::size * 3);
337 root 1.39
338 root 1.40 send_packet (fx);
339     if (sx.length () > 3) send_packet (sx);
340 root 1.39 }
341     }
342    
343 root 1.32 void
344     client::send_image (faceidx facenum)
345     {
346     // never send face 0. ever. it does not exist.
347     if (!facenum)
348     return;
349 root 1.31
350 root 1.32 const facedata *d = face_data (facenum, faceset);
351 root 1.30
352 root 1.32 if (!d)
353     {
354     LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
355     return;
356     }
357 root 1.30
358 root 1.34 faces_sent[facenum] = true;
359    
360 root 1.36 if (force_image_newmap)
361     force_newmap = true;
362    
363 root 1.32 packet sl;
364 root 1.30
365 root 1.32 sl << (image2 ? "image2 " : "image ")
366     << uint32 (facenum);
367 root 1.6
368 root 1.32 if (image2)
369     sl << uint8 (0);
370 root 1.6
371 root 1.32 sl << uint32 (d->data.size ())
372     << data (d->data.data (), d->data.size ());
373 root 1.31
374 root 1.32 send_packet (sl);
375 root 1.28 }
376    
377     // send all faces of this object to the client
378     // this uses more bandwidth initially, but makes
379     // animations look much smoother, and every client
380     // is supposed to do client-side caching anyways.
381     void
382     client::send_faces (object *ob)
383     {
384     send_face (ob->face);
385    
386     if (ob->animation_id)
387     {
388     animation &anim = animations [ob->animation_id];
389    
390     for (int i = 0; i < anim.num_animations; i++)
391     send_face (anim.faces [i]);
392     }
393     }
394    
395     /**
396     * Need to send an animation sequence to the client.
397     * We will send appropriate face commands to the client if we haven't
398     * sent them the face yet (this can become quite costly in terms of
399     * how much we are sending - on the other hand, this should only happen
400     * when the player logs in and picks stuff up.
401     */
402     void
403     client::send_animation (short anim_num)
404     {
405     /* Do some checking on the anim_num we got. Note that the animations
406     * are added in contigous order, so if the number is in the valid
407     * range, it must be a valid animation.
408     */
409 root 1.41 if (anim_num < 0 || anim_num >= animations.size ())
410 root 1.28 {
411     LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
412     return;
413     }
414    
415     packet sl ("anim");
416    
417     sl << uint16 (anim_num)
418     << uint16 (0); /* flags - not used right now */
419    
420     /* Build up the list of faces. Also, send any information (ie, the
421     * the face itself) down to the client.
422     */
423     for (int i = 0; i < animations[anim_num].num_animations; i++)
424     {
425     send_face (animations[anim_num].faces[i]);
426     sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */
427 elmex 1.1 }
428 root 1.6
429 root 1.28 send_packet (sl);
430    
431     anims_sent[anim_num] = 1;
432 elmex 1.1 }
433    
434     /**
435     * Sends the number of images, checksum of the face file,
436     * and the image_info file information. See the doc/Developers/protocol
437     * if you want further detail.
438     */
439 root 1.3 void
440 root 1.15 send_image_info (client *ns, char *params)
441 elmex 1.1 {
442 root 1.8 packet sl;
443 elmex 1.1
444 root 1.24 //TODO: second parameter is a checksum, but it makes no sense in this current framework
445     sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
446 root 1.6
447 root 1.24 sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
448 elmex 1.1
449 root 1.11 ns->send_packet (sl);
450 elmex 1.1 }
451    
452     /**
453     * Sends requested face information.
454     * \param ns socket to send to
455     * \param params contains first and last index of face
456     *
457     * For each image in [start..stop] sends
458     * - checksum
459     * - name
460     */
461 root 1.3 void
462 root 1.15 send_image_sums (client *ns, char *params)
463 elmex 1.1 {
464 root 1.3 int start, stop;
465 pippijn 1.22 char *cp;
466 root 1.3
467 root 1.8 packet sl;
468 root 1.3
469     start = atoi (params);
470     for (cp = params; *cp != '\0'; cp++)
471     if (*cp == ' ')
472     break;
473    
474     stop = atoi (cp);
475 root 1.24 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
476 root 1.3 {
477 root 1.7 sl.printf ("replyinfo image_sums %d %d", start, stop);
478     ns->send_packet (sl);
479     sl.reset ();
480 root 1.3 return;
481     }
482    
483 root 1.6 sl.printf ("replyinfo image_sums %d %d ", start, stop);
484 root 1.3
485 root 1.24 for (int i = start; i <= stop && i < faces.size (); i++)
486 root 1.3 {
487 root 1.30 ns->faces_sent[i] = true;
488 root 1.3
489 root 1.24 const facedata *d = face_data (i, ns->faceset);
490 root 1.6
491 root 1.24 if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
492 root 1.23 break;
493    
494 root 1.6 sl << uint16 (i)
495 root 1.24 << uint32 (0) // checksum
496     << uint8 (ns->faceset);
497    
498     print_facename (sl, *d); sl << uint8 (0);
499 root 1.3 }
500 root 1.6
501 root 1.3 /* It would make more sense to catch this pre-emptively in the code above.
502     * however, if this really happens, we probably just want to cut down the
503     * size to less than 1000, since that is what we claim the protocol would
504     * support.
505     */
506 root 1.23 //TODO: taken care of above, should simply abort or make sure the above code is correct
507 root 1.9 if (sl.length () >= MAXSOCKBUF)
508 root 1.3 {
509 root 1.9 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
510 root 1.3 abort ();
511 elmex 1.1 }
512 root 1.6
513 root 1.11 ns->send_packet (sl);
514 elmex 1.1 }
515 root 1.6