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.9 by root, Thu Dec 14 01:59:10 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#include <newclient.h> 37#include "crc.h"
39#include <newserver.h>
40#include <loader.h>
41 38
42#define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ 39#define MAX_IMAGE_SIZE 10000
43
44/** Information about one image */
45typedef struct FaceInfo
46{
47
48 uint8 *data; /**< image data */
49
50 uint16 datalen; /**< length of the xpm data */
51
52 uint32 checksum; /**< Checksum of face data */
53} FaceInfo;
54
55/** Information about one face set */
56typedef struct
57{
58
59 char *prefix; /**< */
60 char *fullname;
61
62 uint8 fallback; /**< faceset to use when an image is not found in this faceset */
63 char *size;
64 char *extension;
65 char *comment;
66
67 FaceInfo *faces; /**< images in this faceset */
68} FaceSets;
69
70static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */
71 40
72/** 41/**
73 * Checks specified faceset is valid 42 * client requested an image. send it rate-limited
74 * \param fsn faceset number 43 * before flushing.
75 */ 44 */
76int 45void
77is_valid_faceset (int fsn) 46AskFaceCmd (char *buf, int len, client *ns)
78{ 47{
79 if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) 48 int idx = 0, pri = 0;
80 return TRUE; 49
81 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 ();
82} 115}
83 116
84/** 117/**
85 * Frees all faceset information 118 * Sends a face offer (fx) to a client.
86 */
87void
88free_socket_images (void)
89{
90 int num, q;
91
92 for (num = 0; num < MAX_FACE_SETS; num++)
93 {
94 if (facesets[num].prefix)
95 {
96 for (q = 0; q < nrofpixmaps; q++)
97 if (facesets[num].faces[q].data)
98 free (facesets[num].faces[q].data);
99 free (facesets[num].prefix);
100 free (facesets[num].fullname);
101 free (facesets[num].size);
102 free (facesets[num].extension);
103 free (facesets[num].comment);
104 free (facesets[num].faces);
105 }
106 }
107}
108
109/**
110 * This returns the set we will actually use when sending
111 * a face. This is used because the image files may be sparse.
112 * This function is recursive. imageno is the face number we are
113 * trying to send
114 *
115 * If face is not found in specified faceset, tries with 'fallback' faceset.
116 *
117 * \param faceset faceset to check
118 * \param imageno image number
119 *
120 */
121static int
122get_face_fallback (int faceset, int imageno)
123{
124 /* faceset 0 is supposed to have every image, so just return. Doing
125 * so also prevents infinite loops in the case if it not having
126 * the face, but in that case, we are likely to crash when we try
127 * to access the data, but that is probably preferable to an infinite
128 * loop.
129 */
130 if (faceset == 0)
131 return 0;
132
133 if (!facesets[faceset].prefix)
134 {
135 LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset);
136 return 0; /* use default set */
137 }
138 if (facesets[faceset].faces[imageno].data)
139 return faceset;
140 return get_face_fallback (facesets[faceset].fallback, imageno);
141}
142
143/**
144 * Checks fallback are correctly defined.
145 * This is a simple recursive function that makes sure the fallbacks
146 * are all proper (eg, the fall back to defined sets, and also
147 * eventually fall back to 0). At the top level, togo is set to MAX_FACE_SETS,
148 * if togo gets to zero, it means we have a loop.
149 * This is only run when we first load the facesets.
150 */
151static void
152check_faceset_fallback (int faceset, int togo)
153{
154 int fallback = facesets[faceset].fallback;
155
156 /* proper case - falls back to base set */
157 if (fallback == 0)
158 return;
159
160 if (!facesets[fallback].prefix)
161 {
162 LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback);
163 abort ();
164 }
165 togo--;
166 if (togo == 0)
167 {
168 LOG (llevError, "Infinite loop found in facesets. aborting.\n");
169 abort ();
170 }
171 check_faceset_fallback (fallback, togo);
172}
173
174#define MAX_IMAGE_SIZE 10000
175
176/**
177 * Loads all the image types into memory.
178 *
179 * This way, we can easily send them to the client. We should really do something
180 * better than abort on any errors - on the other hand, these are all fatal
181 * to the server (can't work around them), but the abort just seems a bit
182 * messy (exit would probably be better.)
183 *
184 * Couple of notes: We assume that the faces are in a continous block.
185 * This works fine for now, but this could perhaps change in the future
186 *
187 * Function largely rewritten May 2000 to be more general purpose.
188 * The server itself does not care what the image data is - to the server,
189 * it is just data it needs to allocate. As such, the code is written
190 * to do such.
191 */
192
193void
194read_client_images (void)
195{
196 char filename[400];
197 char buf[HUGE_BUF];
198 char *cp, *cps[7];
199 FILE *infile;
200 int num, len, compressed, fileno, i, badline;
201
202 memset (facesets, 0, sizeof (facesets));
203 sprintf (filename, "%s/image_info", settings.datadir);
204 if ((infile = open_and_uncompress (filename, 0, &compressed)) == NULL)
205 {
206 LOG (llevError, "Unable to open %s\n", filename);
207 abort ();
208 }
209 while (fgets (buf, HUGE_BUF - 1, infile) != NULL)
210 {
211 badline = 0;
212
213 if (buf[0] == '#')
214 continue;
215 if (!(cps[0] = strtok (buf, ":")))
216 badline = 1;
217 for (i = 1; i < 7; i++)
218 {
219 if (!(cps[i] = strtok (NULL, ":")))
220 badline = 1;
221 }
222 if (badline)
223 {
224 LOG (llevError, "Bad line in image_info file, ignoring line:\n %s", buf);
225 }
226 else
227 {
228 len = atoi (cps[0]);
229 if (len >= MAX_FACE_SETS)
230 {
231 LOG (llevError, "To high a setnum in image_info file: %d > %d\n", len, MAX_FACE_SETS);
232 abort ();
233 }
234 facesets[len].prefix = strdup_local (cps[1]);
235 facesets[len].fullname = strdup_local (cps[2]);
236 facesets[len].fallback = atoi (cps[3]);
237 facesets[len].size = strdup_local (cps[4]);
238 facesets[len].extension = strdup_local (cps[5]);
239 facesets[len].comment = strdup_local (cps[6]);
240 }
241 }
242 close_and_delete (infile, compressed);
243 for (i = 0; i < MAX_FACE_SETS; i++)
244 {
245 if (facesets[i].prefix)
246 check_faceset_fallback (i, MAX_FACE_SETS);
247 }
248 /* Loaded the faceset information - now need to load up the
249 * actual faces.
250 */
251
252 for (fileno = 0; fileno < MAX_FACE_SETS; fileno++)
253 {
254 /* if prefix is not set, this is not used */
255 if (!facesets[fileno].prefix)
256 continue;
257 facesets[fileno].faces = (FaceInfo *) calloc (nrofpixmaps, sizeof (FaceInfo));
258
259 sprintf (filename, "%s/crossfire.%d", settings.datadir, fileno);
260 LOG (llevDebug, "Loading image file %s\n", filename);
261
262 if ((infile = open_and_uncompress (filename, 0, &compressed)) == NULL)
263 {
264 LOG (llevError, "Unable to open %s\n", filename);
265 abort ();
266 }
267 while (fgets (buf, HUGE_BUF - 1, infile) != NULL)
268 {
269 if (strncmp (buf, "IMAGE ", 6) != 0)
270 {
271 LOG (llevError, "read_client_images:Bad image line - not IMAGE, instead\n%s", buf);
272 abort ();
273 }
274 num = atoi (buf + 6);
275 if (num < 0 || num >= nrofpixmaps)
276 {
277 LOG (llevError, "read_client_images: Image num %d not in 0..%d\n%s", num, nrofpixmaps, buf);
278 abort ();
279 }
280 /* Skip accross the number data */
281 for (cp = buf + 6; *cp != ' '; cp++);
282 len = atoi (cp);
283 if (len == 0 || len > MAX_IMAGE_SIZE)
284 {
285 LOG (llevError, "read_client_images: length not valid: %d > %d \n%s", len, MAX_IMAGE_SIZE, buf);
286 abort ();
287 }
288 /* We don't actualy care about the name of the image that
289 * is embedded in the image file, so just ignore it.
290 */
291 facesets[fileno].faces[num].datalen = len;
292 facesets[fileno].faces[num].data = (uint8 *) malloc (len);
293 if ((i = fread (facesets[fileno].faces[num].data, len, 1, infile)) != 1)
294 {
295 LOG (llevError, "read_client_images: Did not read desired amount of data, wanted %d, got %d\n%s", len, i, buf);
296 abort ();
297 }
298 facesets[fileno].faces[num].checksum = 0;
299 for (i = 0; i < len; i++)
300 {
301 ROTATE_RIGHT (facesets[fileno].faces[num].checksum);
302 facesets[fileno].faces[num].checksum += facesets[fileno].faces[num].data[i];
303 facesets[fileno].faces[num].checksum &= 0xffffffff;
304 }
305 }
306 close_and_delete (infile, compressed);
307 } /* For fileno < MAX_FACE_SETS */
308}
309
310/**
311 * Client tells us what type of faces it wants. Also sets
312 * the caching attribute.
313 *
314 */
315
316void
317SetFaceMode (char *buf, int len, NewSocket *ns)
318{
319 int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
320
321 if (mode == CF_FACE_NONE)
322 ns->facecache = 1;
323 else if (mode != CF_FACE_PNG)
324 {
325 packet sl;
326 sl.printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
327 ns->send_packet (sl);
328 }
329
330 if (mask)
331 ns->facecache = 1;
332}
333
334/**
335 * Client has requested pixmap that it somehow missed getting.
336 * This will be called often if the client is
337 * caching images.
338 */
339
340void
341SendFaceCmd (char *buff, int len, NewSocket * ns)
342{
343 long tmpnum = atoi (buff);
344 short facenum = tmpnum & 0xffff;
345
346 if (facenum != 0)
347 esrv_send_face (ns, facenum, 1);
348}
349
350/**
351 * Sends a face to a client if they are in pixmap mode
352 * nothing gets sent in bitmap mode.
353 * 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 -
354 * 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
355 * 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,
356 * 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.
357 */ 123 */
358
359void 124void
360esrv_send_face (NewSocket *ns, short face_num, int nocache) 125client::send_face (faceidx facenum, int pri)
361{ 126{
362 char fallback; 127 // never send face 0. ever. it does not exist.
128 if (!facenum)
129 return;
363 130
364 if (face_num <= 0 || face_num >= nrofpixmaps) 131 faceinfo *f = face_info (facenum);
132
133 if (!f)
365 { 134 {
366 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);
367 return; 136 return;
368 } 137 }
369 138
370 packet sl; 139 // refuse to send non-image faces unless requested
371 fallback = get_face_fallback (ns->faceset, face_num); 140 if (!fx_want [f->type])
141 return;
372 142
373 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);
374 { 199 }
375 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);
376 return; 237 return;
377 } 238 }
378 239
379 if (ns->facecache && !nocache) 240 packet sl ("anim");
380 {
381 sl << (ns->image2 ? "face2 " : "face1 ")
382 << uint16 (face_num);
383 241
384 if (ns->image2)
385 sl << uint8 (fallback);
386
387 sl << uint32 (facesets[fallback].faces[face_num].checksum)
388 << new_faces[face_num].name;
389
390 Send_With_Handling (ns, &sl);
391 }
392 else
393 {
394 sl << (ns->image2 ? "image2 " : "image ")
395 << uint32 (face_num);
396
397 if (ns->image2)
398 sl << uint8 (fallback);
399
400 sl << uint32 (facesets[fallback].faces[face_num].datalen)
401 << data (facesets[fallback].faces[face_num].data, facesets[fallback].faces[face_num].datalen);
402
403 Send_With_Handling (ns, &sl);
404 }
405
406 ns->faces_sent[face_num] |= NS_FACESENT_FACE;
407}
408
409/**
410 * Sends the number of images, checksum of the face file,
411 * and the image_info file information. See the doc/Developers/protocol
412 * if you want further detail.
413 */
414
415void
416send_image_info (NewSocket * ns, char *params)
417{
418 packet sl;
419
420 sl.printf ("replyinfo image_info\n%d\n%d\n", nrofpixmaps - 1, bmaps_checksum);
421
422 for (int i = 0; i < MAX_FACE_SETS; i++)
423 if (facesets[i].prefix)
424 sl.printf ("%d:%s:%s:%d:%s:%s:%s",
425 i, facesets[i].prefix, facesets[i].fullname, facesets[i].fallback,
426 facesets[i].size, facesets[i].extension, facesets[i].comment);
427
428 Send_With_Handling (ns, &sl);
429}
430
431/**
432 * Sends requested face information.
433 * \param ns socket to send to
434 * \param params contains first and last index of face
435 *
436 * For each image in [start..stop] sends
437 * - checksum
438 * - name
439 */
440void
441send_image_sums (NewSocket * ns, char *params)
442{
443 int start, stop;
444 char *cp, buf[MAX_BUF];
445
446 packet sl;
447
448 start = atoi (params);
449 for (cp = params; *cp != '\0'; cp++)
450 if (*cp == ' ')
451 break;
452
453 stop = atoi (cp);
454 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= nrofpixmaps)
455 {
456 sl.printf ("replyinfo image_sums %d %d", start, stop);
457 ns->send_packet (sl);
458 sl.reset ();
459 return;
460 }
461
462 sl.printf ("replyinfo image_sums %d %d ", start, stop);
463
464 for (int i = start; i <= stop; i++)
465 {
466 ns->faces_sent[i] |= NS_FACESENT_FACE;
467
468 int qq = get_face_fallback (ns->faceset, i);
469
470 sl << uint16 (i) 242 sl << uint16 (anim_num)
471 << uint32 (facesets[qq].faces[i].checksum) 243 << uint16 (0); /* flags - not used right now */
472 << uint8 (qq)
473 << data8 (&new_faces[i].name, new_faces[i].name.length () + 1);
474 }
475 244
476 /* 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
477 * however, if this really happens, we probably just want to cut down the 246 * the face itself) down to the client.
478 * size to less than 1000, since that is what we claim the protocol would
479 * support.
480 */ 247 */
481 if (sl.length () >= MAXSOCKBUF) 248 for (int i = 0; i < animations[anim_num].num_animations; i++)
482 {
483 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
484 abort ();
485 } 249 {
250 send_face (animations[anim_num].faces[i], -20);
251 sl << uint16 (animations[anim_num].faces[i]);
252 }
486 253
487 Send_With_Handling (ns, &sl); 254 send_packet (sl);
488}
489 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