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.14 by root, Sat Dec 16 03:08:26 2006 UTC vs.
Revision 1.74 by root, Sun Nov 11 18:21:21 2012 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for X-windows 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
4 Copyright (C) 2001 Mark Wedel 5 * Copyright (©) 2001 Mark Wedel
5 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992 Frank Tore Johansen
6 7 *
7 This program is free software; you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify it under
8 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
9 the Free Software Foundation; either version 2 of the License, or 10 * Free Software Foundation, either version 3 of the License, or (at your
10 (at your option) any later version. 11 * option) any later version.
11 12 *
12 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,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details. 16 * GNU General Public License for more details.
16 17 *
17 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
18 along with this program; if not, write to the Free Software 19 * and the GNU General Public License along with this program. If not, see
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * <http://www.gnu.org/licenses/>.
20 21 *
21 The author 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.
33 */ 32 */
34 33
35#include <global.h> 34#include <global.h>
36#include <sproto.h> 35#include <sproto.h>
37 36
38#define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ 37#include "crc.h"
39 38
40/** Information about one image */ 39#define MAX_IMAGE_SIZE 10000
41typedef struct FaceInfo
42{
43
44 uint8 *data; /**< image data */
45 uint16 datalen; /**< length of the xpm data */
46 uint32 checksum; /**< Checksum of face data */
47} FaceInfo;
48
49/** Information about one face set */
50typedef struct
51{
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 40
66/** 41/**
67 * Checks specified faceset is valid 42 * client requested an image. send it rate-limited
68 * \param fsn faceset number 43 * before flushing.
69 */ 44 */
70int 45void
71is_valid_faceset (int fsn) 46AskFaceCmd (char *buf, int len, client *ns)
72{ 47{
73 if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) 48 int idx = 0, pri = 0;
74 return TRUE; 49
75 return FALSE; 50 sscanf (buf, "%d %d", &idx, &pri);
51
52 //TODO: somehow fetch default priority from send_fx here
53
54 const faceinfo *f = face_info (idx);
55
56 if (!f)
57 return; // doh
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);
74 ixsend ix;
75
76 ix.pri = pri;
77 ix.idx = idx;
78 ix.ofs = size;
79 ix.data = (uint8 *)data;
80 ix.data_sv = SvREFCNT_inc (data_sv);
81
82 auto (pos, ixface.end ());
83
84 // the by far most common case will be to insert
85 // near the end, so little looping.
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)))
92 {
93 ++pos;
94 break;
95 }
96 }
97
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 ();
76} 115}
77 116
78/** 117/**
79 * Frees all faceset information 118 * Sends a face offer (fx) to a client.
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 < nrofpixmaps; q++)
91 if (facesets[num].faces[q].data)
92 free (facesets[num].faces[q].data);
93 free (facesets[num].prefix);
94 free (facesets[num].fullname);
95 free (facesets[num].size);
96 free (facesets[num].extension);
97 free (facesets[num].comment);
98 free (facesets[num].faces);
99 }
100 }
101}
102
103/**
104 * This returns the set we will actually use when sending
105 * a face. This is used because the image files may be sparse.
106 * This function is recursive. imageno is the face number we are
107 * trying to send
108 *
109 * If face is not found in specified faceset, tries with 'fallback' faceset.
110 *
111 * \param faceset faceset to check
112 * \param imageno image number
113 *
114 */
115static int
116get_face_fallback (int faceset, int imageno)
117{
118 /* faceset 0 is supposed to have every image, so just return. Doing
119 * so also prevents infinite loops in the case if it not having
120 * the face, but in that case, we are likely to crash when we try
121 * to access the data, but that is probably preferable to an infinite
122 * loop.
123 */
124 if (faceset == 0)
125 return 0;
126
127 if (!facesets[faceset].prefix)
128 {
129 LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset);
130 return 0; /* use default set */
131 }
132 if (facesets[faceset].faces[imageno].data)
133 return faceset;
134 return get_face_fallback (facesets[faceset].fallback, imageno);
135}
136
137/**
138 * Checks fallback are correctly defined.
139 * This is a simple recursive function that makes sure the fallbacks
140 * are all proper (eg, the fall back to defined sets, and also
141 * eventually fall back to 0). At the top level, togo is set to MAX_FACE_SETS,
142 * if togo gets to zero, it means we have a loop.
143 * This is only run when we first load the facesets.
144 */
145static void
146check_faceset_fallback (int faceset, int togo)
147{
148 int fallback = facesets[faceset].fallback;
149
150 /* proper case - falls back to base set */
151 if (fallback == 0)
152 return;
153
154 if (!facesets[fallback].prefix)
155 {
156 LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback);
157 abort ();
158 }
159 togo--;
160 if (togo == 0)
161 {
162 LOG (llevError, "Infinite loop found in facesets. aborting.\n");
163 abort ();
164 }
165 check_faceset_fallback (fallback, togo);
166}
167
168#define MAX_IMAGE_SIZE 10000
169
170/**
171 * Loads all the image types into memory.
172 *
173 * This way, we can easily send them to the client. We should really do something
174 * better than abort on any errors - on the other hand, these are all fatal
175 * to the server (can't work around them), but the abort just seems a bit
176 * messy (exit would probably be better.)
177 *
178 * Couple of notes: We assume that the faces are in a continous block.
179 * This works fine for now, but this could perhaps change in the future
180 *
181 * Function largely rewritten May 2000 to be more general purpose.
182 * The server itself does not care what the image data is - to the server,
183 * it is just data it needs to allocate. As such, the code is written
184 * to do such.
185 */
186
187void
188read_client_images (void)
189{
190 char filename[400];
191 char buf[HUGE_BUF];
192 char *cp, *cps[7];
193 FILE *infile;
194 int num, len, compressed, fileno, i, badline;
195
196 memset (facesets, 0, sizeof (facesets));
197 sprintf (filename, "%s/image_info", settings.datadir);
198 if ((infile = open_and_uncompress (filename, 0, &compressed)) == NULL)
199 {
200 LOG (llevError, "Unable to open %s\n", filename);
201 abort ();
202 }
203 while (fgets (buf, HUGE_BUF - 1, infile) != NULL)
204 {
205 badline = 0;
206
207 if (buf[0] == '#')
208 continue;
209 if (!(cps[0] = strtok (buf, ":")))
210 badline = 1;
211 for (i = 1; i < 7; i++)
212 {
213 if (!(cps[i] = strtok (NULL, ":")))
214 badline = 1;
215 }
216 if (badline)
217 {
218 LOG (llevError, "Bad line in image_info file, ignoring line:\n %s", buf);
219 }
220 else
221 {
222 len = atoi (cps[0]);
223 if (len >= MAX_FACE_SETS)
224 {
225 LOG (llevError, "To high a setnum in image_info file: %d > %d\n", len, MAX_FACE_SETS);
226 abort ();
227 }
228 facesets[len].prefix = strdup (cps[1]);
229 facesets[len].fullname = strdup (cps[2]);
230 facesets[len].fallback = atoi (cps[3]);
231 facesets[len].size = strdup (cps[4]);
232 facesets[len].extension = strdup (cps[5]);
233 facesets[len].comment = strdup (cps[6]);
234 }
235 }
236 close_and_delete (infile, compressed);
237 for (i = 0; i < MAX_FACE_SETS; i++)
238 {
239 if (facesets[i].prefix)
240 check_faceset_fallback (i, MAX_FACE_SETS);
241 }
242 /* Loaded the faceset information - now need to load up the
243 * actual faces.
244 */
245
246 for (fileno = 0; fileno < MAX_FACE_SETS; fileno++)
247 {
248 /* if prefix is not set, this is not used */
249 if (!facesets[fileno].prefix)
250 continue;
251 facesets[fileno].faces = (FaceInfo *) calloc (nrofpixmaps, sizeof (FaceInfo));
252
253 sprintf (filename, "%s/crossfire.%d", settings.datadir, fileno);
254 LOG (llevDebug, "Loading image file %s\n", filename);
255
256 if ((infile = open_and_uncompress (filename, 0, &compressed)) == NULL)
257 {
258 LOG (llevError, "Unable to open %s\n", filename);
259 abort ();
260 }
261 while (fgets (buf, HUGE_BUF - 1, infile) != NULL)
262 {
263 if (strncmp (buf, "IMAGE ", 6) != 0)
264 {
265 LOG (llevError, "read_client_images:Bad image line - not IMAGE, instead\n%s", buf);
266 abort ();
267 }
268 num = atoi (buf + 6);
269 if (num < 0 || num >= nrofpixmaps)
270 {
271 LOG (llevError, "read_client_images: Image num %d not in 0..%d\n%s", num, nrofpixmaps, buf);
272 abort ();
273 }
274 /* Skip accross the number data */
275 for (cp = buf + 6; *cp != ' '; cp++);
276 len = atoi (cp);
277 if (len == 0 || len > MAX_IMAGE_SIZE)
278 {
279 LOG (llevError, "read_client_images: length not valid: %d > %d \n%s", len, MAX_IMAGE_SIZE, buf);
280 abort ();
281 }
282 /* We don't actualy care about the name of the image that
283 * is embedded in the image file, so just ignore it.
284 */
285 facesets[fileno].faces[num].datalen = len;
286 facesets[fileno].faces[num].data = (uint8 *) malloc (len);
287 if ((i = fread (facesets[fileno].faces[num].data, len, 1, infile)) != 1)
288 {
289 LOG (llevError, "read_client_images: Did not read desired amount of data, wanted %d, got %d\n%s", len, i, buf);
290 abort ();
291 }
292 facesets[fileno].faces[num].checksum = 0;
293 for (i = 0; i < len; i++)
294 {
295 ROTATE_RIGHT (facesets[fileno].faces[num].checksum);
296 facesets[fileno].faces[num].checksum += facesets[fileno].faces[num].data[i];
297 facesets[fileno].faces[num].checksum &= 0xffffffff;
298 }
299 }
300 close_and_delete (infile, compressed);
301 } /* For fileno < MAX_FACE_SETS */
302}
303
304/**
305 * Client tells us what type of faces it wants. Also sets
306 * the caching attribute.
307 *
308 */
309
310void
311SetFaceMode (char *buf, int len, client *ns)
312{
313 int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
314
315 if (mode == CF_FACE_NONE)
316 ns->facecache = 1;
317 else if (mode != CF_FACE_PNG)
318 ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
319
320 if (mask)
321 ns->facecache = 1;
322}
323
324/**
325 * Client has requested pixmap that it somehow missed getting.
326 * This will be called often if the client is
327 * caching images.
328 */
329
330void
331SendFaceCmd (char *buff, int len, client * ns)
332{
333 long tmpnum = atoi (buff);
334 short facenum = tmpnum & 0xffff;
335
336 if (facenum != 0)
337 esrv_send_face (ns, facenum, 1);
338}
339
340/**
341 * Sends a face to a client if they are in pixmap mode
342 * nothing gets sent in bitmap mode.
343 * 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 -
344 * 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
345 * 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,
346 * 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.
347 */ 123 */
348
349void 124void
350esrv_send_face (client *ns, short face_num, int nocache) 125client::send_face (faceidx facenum, int pri)
351{ 126{
352 char fallback; 127 // never send face 0. ever. it does not exist.
128 if (!facenum)
129 return;
353 130
354 if (face_num <= 0 || face_num >= nrofpixmaps) 131 faceinfo *f = face_info (facenum);
132
133 if (!f)
355 { 134 {
356 LOG (llevError, "esrv_send_face (%d) out of bounds??\n", face_num); 135 LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum);
357 return; 136 return;
358 } 137 }
359 138
360 packet sl; 139 // refuse to send non-image faces unless requested
361 fallback = get_face_fallback (ns->faceset, face_num); 140 if (!fx_want [f->type])
141 return;
362 142
363 if (facesets[fallback].faces[face_num].data == NULL) 143 if (faces_sent [facenum])
144 return;
145
146 faces_sent [facenum] = true;
147
148 fxface.push_back (facenum);
149}
150
151void client::flush_fx ()
152{
153 while (!fxface.empty ())
154 {
155 packet fx ("fx");
156 packet sx ("sx");
157 int type = 0;
158
159 do
160 {
161 faceidx facenum = fxface.back (); fxface.pop_back ();
162
163 if (const faceinfo *f = face_info (facenum))
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
175 fx << ber32 (facenum)
176 << data8 (d->chksum, d->chksum_len);
177
178 if (smoothing)
179 {
180 faceinfo *f = face_info (facenum);
181
182 if (f->smooth)
183 {
184 send_face (f->smooth, -110);
185
186 sx << ber32 (facenum)
187 << ber32 (f->smooth)
188 << ber32 (f->smoothlevel);
189 }
190 }
191 }
192 }
193 while (!fxface.empty ()
194 && fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */
195 && sx.room () > ber32::size * 3);
196
197 send_packet (fx);
198 if (sx.length () > 3) send_packet (sx);
364 { 199 }
365 LOG (llevError, "esrv_send_face: faces[%d].data == NULL\n", face_num); 200}
201
202// send all faces of this object to the client
203// this uses more bandwidth initially, but makes
204// animations look much smoother, and every client
205// is supposed to do client-side caching anyways.
206void
207client::send_faces (object *ob)
208{
209 send_face (ob->face, 10);
210
211 if (ob->animation_id)
212 {
213 const animation &anim = ob->anim ();
214
215 for (int i = 0; i < anim.num_animations; i++)
216 send_face (anim.faces [i], -10);
217 }
218}
219
220/**
221 * Need to send an animation sequence to the client.
222 * We will send appropriate face commands to the client if we haven't
223 * sent them the face yet (this can become quite costly in terms of
224 * how much we are sending - on the other hand, this should only happen
225 * when the player logs in and picks stuff up.
226 */
227void
228client::send_animation (short anim_num)
229{
230 /* Do some checking on the anim_num we got. Note that the animations
231 * are added in contiguous order, so if the number is in the valid
232 * range, it must be a valid animation.
233 */
234 if (anim_num < 0 || anim_num >= animations.size ())
235 {
236 LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
366 return; 237 return;
367 } 238 }
368 239
369 if (ns->facecache && !nocache) 240 packet sl ("anim");
370 {
371 sl << (ns->image2 ? "face2 " : "face1 ")
372 << uint16 (face_num);
373 241
374 if (ns->image2)
375 sl << uint8 (fallback);
376
377 sl << uint32 (facesets[fallback].faces[face_num].checksum)
378 << new_faces[face_num].name;
379
380 ns->send_packet (sl);
381 }
382 else
383 {
384 sl << (ns->image2 ? "image2 " : "image ")
385 << uint32 (face_num);
386
387 if (ns->image2)
388 sl << uint8 (fallback);
389
390 sl << uint32 (facesets[fallback].faces[face_num].datalen)
391 << data (facesets[fallback].faces[face_num].data, facesets[fallback].faces[face_num].datalen);
392
393 ns->send_packet (sl);
394 }
395
396 ns->faces_sent[face_num] |= NS_FACESENT_FACE;
397}
398
399/**
400 * Sends the number of images, checksum of the face file,
401 * and the image_info file information. See the doc/Developers/protocol
402 * if you want further detail.
403 */
404
405void
406send_image_info (client * ns, char *params)
407{
408 packet sl;
409
410 sl.printf ("replyinfo image_info\n%d\n%d\n", nrofpixmaps - 1, bmaps_checksum);
411
412 for (int i = 0; i < MAX_FACE_SETS; i++)
413 if (facesets[i].prefix)
414 sl.printf ("%d:%s:%s:%d:%s:%s:%s",
415 i, facesets[i].prefix, facesets[i].fullname, facesets[i].fallback,
416 facesets[i].size, facesets[i].extension, facesets[i].comment);
417
418 ns->send_packet (sl);
419}
420
421/**
422 * Sends requested face information.
423 * \param ns socket to send to
424 * \param params contains first and last index of face
425 *
426 * For each image in [start..stop] sends
427 * - checksum
428 * - name
429 */
430void
431send_image_sums (client * ns, char *params)
432{
433 int start, stop;
434 char *cp, buf[MAX_BUF];
435
436 packet sl;
437
438 start = atoi (params);
439 for (cp = params; *cp != '\0'; cp++)
440 if (*cp == ' ')
441 break;
442
443 stop = atoi (cp);
444 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= nrofpixmaps)
445 {
446 sl.printf ("replyinfo image_sums %d %d", start, stop);
447 ns->send_packet (sl);
448 sl.reset ();
449 return;
450 }
451
452 sl.printf ("replyinfo image_sums %d %d ", start, stop);
453
454 for (int i = start; i <= stop; i++)
455 {
456 ns->faces_sent[i] |= NS_FACESENT_FACE;
457
458 int qq = get_face_fallback (ns->faceset, i);
459
460 sl << uint16 (i) 242 sl << uint16 (anim_num)
461 << uint32 (facesets[qq].faces[i].checksum) 243 << uint16 (0); /* flags - not used right now */
462 << uint8 (qq)
463 << data8 (&new_faces[i].name, new_faces[i].name.length () + 1);
464 }
465 244
466 /* It would make more sense to catch this pre-emptively in the code above. 245 /* Build up the list of faces. Also, send any information (ie, the
467 * however, if this really happens, we probably just want to cut down the 246 * the face itself) down to the client.
468 * size to less than 1000, since that is what we claim the protocol would
469 * support.
470 */ 247 */
471 if (sl.length () >= MAXSOCKBUF) 248 for (int i = 0; i < animations[anim_num].num_animations; i++)
472 {
473 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
474 abort ();
475 } 249 {
250 send_face (animations[anim_num].faces[i], -20);
251 sl << uint16 (animations[anim_num].faces[i]);
252 }
476 253
477 ns->send_packet (sl); 254 send_packet (sl);
478}
479 255
256 anims_sent[anim_num] = 1;
257}
258
259void
260client::invalidate_face (faceidx idx)
261{
262 faces_sent [idx] = false;
263 force_newmap = true;
264}
265
266void
267client::invalidate_all_faces ()
268{
269 faces_sent.reset ();
270 force_newmap = true;
271}
272

Diff Legend

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