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

Comparing deliantra/server/socket/image.C (file contents):
Revision 1.41 by root, Thu Apr 12 14:18:06 2007 UTC vs.
Revision 1.77 by root, Sat Nov 17 23:40:05 2018 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 (©) 2017,2018 Marc Alexander Lehmann / the Deliantra team
		5	* Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	* Copyright (C) 2001 Mark Wedel	6	* Copyright (©) 2001 Mark Wedel
6	* Copyright (C) 1992 Frank Tore Johansen	7	* Copyright (©) 1992 Frank Tore Johansen
7	*	8	*
8	* This program is free software; you can redistribute it and/or modify	9	* 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	10	* 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	11	* Free Software Foundation, either version 3 of the License, or (at your
11	* (at your option) any later version.	12	* option) any later version.
12	*	13	*
13	* This program is distributed in the hope that it will be useful,	14	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.	17	* GNU General Public License for more details.
17	*	18	*
18	* You should have received a copy of the GNU General Public License	19	* 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	20	* and the GNU General Public License along with this program. If not, see
20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.	21	* <http://www.gnu.org/licenses/>.
21	*
22	* The author can be reached via e-mail to <crossfire@schmorp.de>
23	*/	22	*
		23	* The authors can be reached via e-mail to <support@deliantra.net>
		24	*/
24		25
25	/** \file	26	/*
26	* Image related communication	27	* Image related communication
27	*
28	* \date 2003-12-02
29	*	28	*
30	* This file deals with the image related communication to the	29	* This file deals with the image related communication to the
31	* client. I've located all the functions in this file - this	30	* client. I've located all the functions in this file - this
32	* localizes it more, and means that we don't need to declare	31	* localizes it more, and means that we don't need to declare
33	* things like all the structures as globals.	32	* things like all the structures as globals.
36	#include <global.h>	35	#include <global.h>
37	#include <sproto.h>	36	#include <sproto.h>
38		37
39	#include "crc.h"	38	#include "crc.h"
40		39
41	#define MAX_FACE_SETS 20 /*< Maximum number of image sets the program will handle /	40	#define MAX_IMAGE_SIZE 10000
42
43	/** Information about one image */
44	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	} FaceInfo;
50
51	/** Information about one face set */
52	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	} FaceSets;
64
65	static FaceSets facesets[MAX_FACE_SETS]; /*< All facesets /
66		41
67	/**	42	/**
68	* Checks specified faceset is valid	43	* client requested an image. send it rate-limited
69	* \param fsn faceset number	44	* before flushing.
70	*/	45	*/
71	int	46	void
72	is_valid_faceset (int fsn)	47	AskFaceCmd (char buf, int len, client ns)
73	{	48	{
74	if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix)	49	int idx = 0, pri = 0;
75	return TRUE;	50
76	return FALSE;	51	sscanf (buf, "%d %d", &idx, &pri);
		52
		53	//TODO: somehow fetch default priority from send_fx here
		54
		55	const faceinfo *f = face_info (idx);
		56
		57	if (!f)
		58	return; // doh
		59
		60	int set = ns->tileset;
		61
		62	if (!f->face [set].chksum_len)
		63	set = 0;
		64
		65	/* cfperl_ix calls cf::face::ix which loads the data */
		66	/* and then calls cf::client::send_ix to actually queue the ix */
		67	cfperl_ix (ns, set, idx, pri);
		68	}
		69
		70	void
		71	client::ix_send (faceidx idx, sint16 pri, SV *data_sv)
		72	{
		73	STRLEN size;
		74	char *data = SvPVbyte (data_sv, size);
		75	ixsend ix;
		76
		77	ix.pri = pri;
		78	ix.idx = idx;
		79	ix.ofs = size;
		80	ix.data = (uint8 *)data;
		81	ix.data_sv = SvREFCNT_inc (data_sv);
		82
		83	auto (pos, ixface.end ());
		84
		85	// the by far most common case will be to insert
		86	// near the end, so little looping.
		87	while (pos != ixface.begin ())
		88	{
		89	--pos;
		90
		91	// sort within 2k bins, to slightly prefer smaller images
		92	if (pri > pos->pri \|\| (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11)))
		93	{
		94	++pos;
		95	break;
		96	}
		97	}
		98
		99	ixface.insert (pos, ix);
		100
		101	#if 0
		102	for (auto (i, ixface.begin ()); i != ixface.end (); ++i)
		103	fprintf (stderr, "<%d,%d> ", i->pri, i->ofs);
		104	fprintf (stderr, "\n");
		105	#endif
		106	}
		107
		108	void
		109	client::ix_pop ()
		110	{
		111	ixsend &ix = ixface.back ();
		112
		113	SvREFCNT_dec (ix.data_sv);
		114
		115	ixface.pop_back ();
77	}	116	}
78		117
79	/**	118	/**
80	* Frees all faceset information	119	* Sends a face offer (fx) to a client.
81	*/
82	void
83	free_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	*/
117	static int
118	get_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	*/
149	static void
150	check_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	*/
181	void
182	SetFaceMode (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	*/
200	void
201	SendFaceCmd (char buf, int len, client ns)
202	{
203	ns->send_image (atoi (buf));
204	}
205
206	// how lame
207	static void print_facename (packet &sl, const facedata &d)
208	{
209	for (int i = 0; i < CHKSUM_SIZE; ++i)
210	sl.printf ("%02x", d.chksum [i]);
211	}
212
213	// 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	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	/**
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 -	120	* 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	121	* 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,	122	* 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.	123	* we look at the facecache, and if set, send the image name.
239	*/	124	*/
240	void	125	void
241	client::send_face (faceidx facenum)	126	client::send_face (faceidx facenum, int pri)
242	{	127	{
243	// never send face 0. ever. it does not exist.	128	// never send face 0. ever. it does not exist.
244	if (!facenum)	129	if (!facenum)
245	return;	130	return;
246		131
247	const facedata *d = face_data (facenum, faceset);	132	faceinfo *f = face_info (facenum);
248		133
249	if (!d)	134	if (!f)
250	{	135	{
251	LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum);	136	LOG (llevError \| logBacktrace, "client::send_face (%d) out of bounds??\n", facenum);
252	return;	137	return;
253	}	138	}
254		139
		140	// refuse to send non-image faces unless requested
		141	if (!fx_want [f->type])
		142	return;
		143
255	if (faces_sent[facenum])	144	if (faces_sent [facenum])
256	return;	145	return;
257		146
258	faces_sent[facenum] = true;	147	faces_sent [facenum] = true;
259		148
260	// if for some reason we let a client without face caching connect,
261	// we better support that decision here and implement it.
262	if (!facecache)
263	return send_image (facenum);
264
265	if (fxix)
266	{
267	fxface.push_back (facenum);	149	fxface.push_back (facenum);
268	return;
269	}
270
271	packet sl;
272
273	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	if (EMI_smooth)
285	{
286	faceinfo *f = face_info (facenum);
287
288	if (f->smooth)
289	{
290	send_face (f->smooth);
291
292	packet sl ("smooth");
293
294	sl << uint16 (facenum)
295	<< uint16 (f->smooth);
296
297	send_packet (sl);
298	}
299	}
300	}	150	}
301		151
302	void client::flush_fx ()	152	void client::flush_fx ()
303	{	153	{
304	while (!fxface.empty ())	154	while (!fxface.empty ())
305	{	155	{
306	packet fx ("fx");	156	packet fx ("fx");
307	packet sx ("sx");	157	packet sx ("sx");
		158	int type = 0;
308		159
309	do	160	do
310	{	161	{
311	faceidx facenum = fxface.back (); fxface.pop_back ();	162	faceidx facenum = fxface.back (); fxface.pop_back ();
312		163
313	const facedata *d = face_data (facenum, faceset);	164	if (const faceinfo *f = face_info (facenum))
314
315	if (d)
316	{	165	{
		166	if (f->type != type)
		167	{
		168	type = f->type;
		169
		170	fx << ber32 (0)
		171	<< uint8 (1) << uint8 (type);
		172	}
		173
		174	const facedata *d = f->data (tileset);
		175
317	fx << ber32 (facenum)	176	fx << ber32 (facenum)
318	<< data8 (d->chksum, CHKSUM_SIZE);	177	<< data8 (d->chksum, d->chksum_len);
319		178
320	if (smoothing)	179	if (smoothing)
321	{	180	{
322	faceinfo *f = face_info (facenum);	181	faceinfo *f = face_info (facenum);
323		182
324	if (f->smooth)	183	if (f->smooth)
325	{	184	{
326	send_face (f->smooth);	185	send_face (f->smooth, -110);
		186
327	sx << ber32 (facenum)	187	sx << ber32 (facenum)
328	<< ber32 (f->smooth)	188	<< ber32 (f->smooth)
329	<< ber32 (f->smoothlevel);	189	<< ber32 (f->smoothlevel);
330	}	190	}
331	}	191	}
332	}	192	}
333	}	193	}
334	while (!fxface.empty ()	194	while (!fxface.empty ()
335	&& fx.room () > ber32::size + CHKSUM_SIZE + 1	195	&& fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */
336	&& sx.room () > ber32::size * 3);	196	&& sx.room () > ber32::size * 3);
337		197
338	send_packet (fx);	198	send_packet (fx);
339	if (sx.length () > 3) send_packet (sx);	199	if (sx.length () > 3) send_packet (sx);
340	}	200	}
341	}
342
343	void
344	client::send_image (faceidx facenum)
345	{
346	// never send face 0. ever. it does not exist.
347	if (!facenum)
348	return;
349
350	const facedata *d = face_data (facenum, faceset);
351
352	if (!d)
353	{
354	LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
355	return;
356	}
357
358	faces_sent[facenum] = true;
359
360	if (force_image_newmap)
361	force_newmap = true;
362
363	packet sl;
364
365	sl << (image2 ? "image2 " : "image ")
366	<< uint32 (facenum);
367
368	if (image2)
369	sl << uint8 (0);
370
371	sl << uint32 (d->data.size ())
372	<< data (d->data.data (), d->data.size ());
373
374	send_packet (sl);
375	}	201	}
376		202
377	// send all faces of this object to the client	203	// send all faces of this object to the client
378	// this uses more bandwidth initially, but makes	204	// this uses more bandwidth initially, but makes
379	// animations look much smoother, and every client	205	// animations look much smoother, and every client
380	// is supposed to do client-side caching anyways.	206	// is supposed to do client-side caching anyways.
381	void	207	void
382	client::send_faces (object *ob)	208	client::send_faces (object *ob)
383	{	209	{
384	send_face (ob->face);	210	send_face (ob->face, 10);
385		211
386	if (ob->animation_id)	212	if (ob->animation_id)
387	{	213	{
388	animation &anim = animations [ob->animation_id];	214	const animation &anim = ob->anim ();
389		215
390	for (int i = 0; i < anim.num_animations; i++)	216	for (int i = 0; i < anim.num_animations; i++)
391	send_face (anim.faces [i]);	217	send_face (anim.faces [i], -10);
392	}	218	}
393	}	219	}
394		220
395	/**	221	/**
396	* Need to send an animation sequence to the client.	222	* Need to send an animation sequence to the client.
…		…
401	*/	227	*/
402	void	228	void
403	client::send_animation (short anim_num)	229	client::send_animation (short anim_num)
404	{	230	{
405	/* Do some checking on the anim_num we got. Note that the animations	231	/* 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	232	* are added in contiguous order, so if the number is in the valid
407	* range, it must be a valid animation.	233	* range, it must be a valid animation.
408	*/	234	*/
409	if (anim_num < 0 \|\| anim_num >= animations.size ())	235	if (anim_num < 0 \|\| anim_num >= animations.size ())
410	{	236	{
411	LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);	237	LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
…		…
420	/* Build up the list of faces. Also, send any information (ie, the	246	/* Build up the list of faces. Also, send any information (ie, the
421	* the face itself) down to the client.	247	* the face itself) down to the client.
422	*/	248	*/
423	for (int i = 0; i < animations[anim_num].num_animations; i++)	249	for (int i = 0; i < animations[anim_num].num_animations; i++)
424	{	250	{
425	send_face (animations[anim_num].faces[i]);	251	send_face (animations[anim_num].faces[i], -20);
426	sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */	252	sl << uint16 (animations[anim_num].faces[i]);
427	}	253	}
428		254
429	send_packet (sl);	255	send_packet (sl);
430		256
431	anims_sent[anim_num] = 1;	257	anims_sent[anim_num] = 1;
432	}	258	}
433		259
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	void	260	void
440	send_image_info (client ns, char params)	261	client::invalidate_face (faceidx idx)
441	{	262	{
442	packet sl;	263	if (!faces_sent [idx])
443
444	//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
447	sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
448
449	ns->send_packet (sl);
450	}
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	void
462	send_image_sums (client ns, char params)
463	{
464	int start, stop;
465	char *cp;
466
467	packet sl;
468
469	start = atoi (params);
470	for (cp = params; *cp != '\0'; cp++)
471	if (*cp == ' ')
472	break;
473
474	stop = atoi (cp);
475	if (stop < start \|\| *cp == '\0' \|\| (stop - start) > 1000 \|\| stop >= MAX_FACES)
476	{
477	sl.printf ("replyinfo image_sums %d %d", start, stop);
478	ns->send_packet (sl);
479	sl.reset ();
480	return;	264	return;
481	}
482		265
483	sl.printf ("replyinfo image_sums %d %d ", start, stop);	266	faces_sent [idx] = false;
484		267	send_face (idx);
485	for (int i = start; i <= stop && i < faces.size (); i++)	268	//TODO: check for active ix and abort it.
486	{
487	ns->faces_sent[i] = true;
488
489	const facedata *d = face_data (i, ns->faceset);
490
491	if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
492	break;
493
494	sl << uint16 (i)
495	<< uint32 (0) // checksum
496	<< uint8 (ns->faceset);
497
498	print_facename (sl, *d); sl << uint8 (0);
499	}
500
501	/* 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	//TODO: taken care of above, should simply abort or make sure the above code is correct
507	if (sl.length () >= MAXSOCKBUF)
508	{
509	LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
510	abort ();
511	}
512
513	ns->send_packet (sl);
514	}	269	}
515		270
		271	void
		272	client::invalidate_all_faces ()
		273	{
		274	for (faceidx i = 0; i < faces_sent.size (); ++i)
		275	invalidate_face (i);
		276	}
		277

Diff Legend

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

Comparing deliantra/server/socket/image.C (file contents): Revision 1.41 by root, Thu Apr 12 14:18:06 2007 UTC vs. Revision 1.77 by root, Sat Nov 17 23:40:05 2018 UTC

Diff Legend

Comparing deliantra/server/socket/image.C (file contents):
Revision 1.41 by root, Thu Apr 12 14:18:06 2007 UTC vs.
Revision 1.77 by root, Sat Nov 17 23:40:05 2018 UTC