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.26 by root, Mon Mar 12 23:45:10 2007 UTC vs.
Revision 1.74 by root, Sun Nov 11 18:21:21 2012 UTC

1/* 1/*
2 * CrossFire, A Multiplayer game 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (C) 2001 Mark Wedel 5 * Copyright (©) 2001 Mark Wedel
6 * Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992 Frank Tore Johansen
7 * 7 *
8 * 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
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 2 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, write to the Free Software 19 * and the GNU General Public License along with this program. If not, see
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * <http://www.gnu.org/licenses/>.
21 *
22 * The author can be reached via e-mail to <crossfire@schmorp.de>
23 */ 21 *
22 * The authors can be reached via e-mail to <support@deliantra.net>
23 */
24 24
25/** \file 25/*
26 * Image related communication 26 * Image related communication
27 *
28 * \date 2003-12-02
29 * 27 *
30 * This file deals with the image related communication to the 28 * This file deals with the image related communication to the
31 * client. I've located all the functions in this file - this 29 * client. I've located all the functions in this file - this
32 * 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
33 * things like all the structures as globals. 31 * things like all the structures as globals.
… …
36#include <global.h> 34#include <global.h>
37#include <sproto.h> 35#include <sproto.h>
38 36
39#include "crc.h" 37#include "crc.h"
40 38
41#define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ 39#define MAX_IMAGE_SIZE 10000
42
43/** Information about one image */
44typedef struct FaceInfo
45{
46 uint8 *data; /**< image data */
47 uint16 datalen; /**< length of the xpm data */
48 uint32 checksum; /**< Checksum of face data */
49} FaceInfo;
50
51/** Information about one face set */
52typedef 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} FaceSets;
64
65static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */
66 40
67/** 41/**
68 * Checks specified faceset is valid 42 * client requested an image. send it rate-limited
69 * \param fsn faceset number 43 * before flushing.
70 */ 44 */
71int 45void
72is_valid_faceset (int fsn) 46AskFaceCmd (char *buf, int len, client *ns)
73{ 47{
74 if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) 48 int idx = 0, pri = 0;
75 return TRUE; 49
76 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 ();
77} 115}
78 116
79/** 117/**
80 * Frees all faceset information 118 * Sends a face offer (fx) to a client.
81 */
82void
83free_socket_images (void)
84{
85 int num, q;
86
87 for (num = 0; num < MAX_FACE_SETS; num++)
88 {
89 if (facesets[num].prefix)
90 {
91 for (q = 0; q < faces.size (); q++)
92 if (facesets[num].faces[q].data)
93 free (facesets[num].faces[q].data);
94
95 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 }
102 }
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 */
117static int
118get_face_fallback (int faceset, int imageno)
119{
120 /* 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
135 if (facesets[faceset].faces[imageno].data)
136 return faceset;
137
138 return get_face_fallback (facesets[faceset].fallback, imageno);
139}
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 */
149static void
150check_faceset_fallback (int faceset, int togo)
151{
152 int fallback = facesets[faceset].fallback;
153
154 /* 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
164 togo--;
165 if (togo == 0)
166 {
167 LOG (llevError, "Infinite loop found in facesets. aborting.\n");
168 abort ();
169 }
170
171 check_faceset_fallback (fallback, togo);
172}
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 */
181void
182SetFaceMode (char *buf, int len, client *ns)
183{
184 int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
185
186 if (mode == CF_FACE_NONE)
187 ns->facecache = 1;
188 else if (mode != CF_FACE_PNG)
189 ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
190
191 if (mask)
192 ns->facecache = 1;
193}
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 */
200void
201SendFaceCmd (char *buf, int len, client *ns)
202{
203 uint16 facenum = atoi (buf);
204
205 if (facenum != 0)
206 esrv_send_face (ns, facenum, 1);
207}
208
209// how lame
210static void print_facename (packet &sl, const facedata &d)
211{
212 for (int i = 0; i < CHKSUM_SIZE; ++i)
213 sl.printf ("%02x", d.chksum [i]);
214}
215
216// gcfclient uses the server-provided checksum for comparison,
217// but always wrotes a broken checksum to its cache file, so we
218// have to provide gcfclient with a useless checksum just to
219// have to cache the image despite its bugs.
220static uint32 gcfclient_checksum (const facedata *d)
221{
222 uint32 csum = 0;
223
224 for (std::string::const_iterator i = d->data.begin ();
225 i != d->data.end ();
226 ++i)
227 {
228 csum = rotate_right (csum);
229 csum += *(uint8 *)&*i;
230 }
231
232 return csum;
233}
234
235/**
236 * Sends a face to a client if they are in pixmap mode
237 * nothing gets sent in bitmap mode.
238 * 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 -
239 * 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
240 * 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,
241 * 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.
242 */ 123 */
243void 124void
244esrv_send_face (client *ns, short face_num, int nocache) 125client::send_face (faceidx facenum, int pri)
245{ 126{
246 if (face_num <= 0 || face_num >= faces.size ()) 127 // never send face 0. ever. it does not exist.
128 if (!facenum)
129 return;
130
131 faceinfo *f = face_info (facenum);
132
133 if (!f)
247 { 134 {
248 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);
249 return; 136 return;
250 } 137 }
251 138
252 const facedata *d = face_data (face_num, ns->faceset); 139 // refuse to send non-image faces unless requested
140 if (!fx_want [f->type])
141 return;
253 142
254 packet sl; 143 if (faces_sent [facenum])
144 return;
255 145
256 if (ns->facecache && !nocache) 146 faces_sent [facenum] = true;
257 {
258 if (ns->force_face0)
259 sl << "face " << uint16 (face_num);
260 else if (ns->image2)
261 sl << "face2 " << uint16 (face_num) << uint8 (0) << uint32 (ns->force_bad_checksum ? gcfclient_checksum (d) : 0);
262 else
263 sl << "face1 " << uint16 (face_num) << uint32 (ns->force_bad_checksum ? gcfclient_checksum (d) : 0);
264 147
265 // how lame 148 fxface.push_back (facenum);
266 print_facename (sl, *d); 149}
267 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
268 ns->send_packet (sl); 197 send_packet (fx);
269 } 198 if (sx.length () > 3) send_packet (sx);
270 else
271 { 199 }
272 fprintf (stderr, "image %s %d\n", &faces [face_num].name, nocache);//D 200}
273 sl << (ns->image2 ? "image2 " : "image ")
274 << uint32 (face_num);
275 201
276 if (ns->image2) 202// send all faces of this object to the client
277 sl << uint8 (0); 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);
278 210
279 sl << uint32 (d->data.size ()) 211 if (ob->animation_id)
280 << data (d->data.data (), d->data.size ());
281
282 ns->send_packet (sl);
283 } 212 {
213 const animation &anim = ob->anim ();
284 214
285 ns->faces_sent[face_num] |= NS_FACESENT_FACE; 215 for (int i = 0; i < anim.num_animations; i++)
216 send_face (anim.faces [i], -10);
217 }
286} 218}
287 219
288/** 220/**
289 * Sends the number of images, checksum of the face file, 221 * Need to send an animation sequence to the client.
290 * and the image_info file information. See the doc/Developers/protocol 222 * We will send appropriate face commands to the client if we haven't
291 * if you want further detail. 223 * sent them the face yet (this can become quite costly in terms of
292 */ 224 * how much we are sending - on the other hand, this should only happen
293 225 * when the player logs in and picks stuff up.
294void
295send_image_info (client *ns, char *params)
296{
297 packet sl;
298
299 //TODO: second parameter is a checksum, but it makes no sense in this current framework
300 sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
301
302 sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
303
304 ns->send_packet (sl);
305}
306
307/**
308 * Sends requested face information.
309 * \param ns socket to send to
310 * \param params contains first and last index of face
311 * 226 */
312 * For each image in [start..stop] sends 227void
313 * - checksum 228client::send_animation (short anim_num)
314 * - name 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.
315 */ 233 */
316void 234 if (anim_num < 0 || anim_num >= animations.size ())
317send_image_sums (client *ns, char *params)
318{
319 int start, stop;
320 char *cp;
321
322 packet sl;
323
324 start = atoi (params);
325 for (cp = params; *cp != '\0'; cp++)
326 if (*cp == ' ')
327 break;
328
329 stop = atoi (cp);
330 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
331 { 235 {
332 sl.printf ("replyinfo image_sums %d %d", start, stop); 236 LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
333 ns->send_packet (sl);
334 sl.reset ();
335 return; 237 return;
336 } 238 }
337 239
338 sl.printf ("replyinfo image_sums %d %d ", start, stop); 240 packet sl ("anim");
339 241
340 for (int i = start; i <= stop && i < faces.size (); i++)
341 {
342 ns->faces_sent[i] |= NS_FACESENT_FACE;
343
344 const facedata *d = face_data (i, ns->faceset);
345
346 if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
347 break;
348
349 sl << uint16 (i) 242 sl << uint16 (anim_num)
350 << uint32 (0) // checksum 243 << uint16 (0); /* flags - not used right now */
351 << uint8 (ns->faceset);
352 244
353 print_facename (sl, *d); sl << uint8 (0); 245 /* Build up the list of faces. Also, send any information (ie, the
354 } 246 * the face itself) down to the client.
355
356 /* It would make more sense to catch this pre-emptively in the code above.
357 * however, if this really happens, we probably just want to cut down the
358 * size to less than 1000, since that is what we claim the protocol would
359 * support.
360 */ 247 */
361 //TODO: taken care of above, should simply abort or make sure the above code is correct 248 for (int i = 0; i < animations[anim_num].num_animations; i++)
362 if (sl.length () >= MAXSOCKBUF)
363 {
364 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
365 abort ();
366 } 249 {
250 send_face (animations[anim_num].faces[i], -20);
251 sl << uint16 (animations[anim_num].faces[i]);
252 }
367 253
368 ns->send_packet (sl); 254 send_packet (sl);
369}
370 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