[ViewVC] Diff of: cvs/deliantra/server/socket/image.C

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

Diff Legend

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

Comparing deliantra/server/socket/image.C (file contents): Revision 1.19 by root, Thu Feb 15 18:09:34 2007 UTC vs. Revision 1.75 by root, Wed Nov 28 12:39:21 2012 UTC

Diff Legend

Comparing deliantra/server/socket/image.C (file contents):
Revision 1.19 by root, Thu Feb 15 18:09:34 2007 UTC vs.
Revision 1.75 by root, Wed Nov 28 12:39:21 2012 UTC