gdk-pixbuf-loader.c 11.6 KB
Newer Older
1
2
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/* GdkPixbuf library - Main header file
 *
 * Copyright (C) 1999 The Free Software Foundation
 *
 * Authors: Mark Crichton <crichton@gimp.org>
 *          Miguel de Icaza <miguel@gnu.org>
 *          Federico Mena-Quintero <federico@gimp.org>
 *          Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

28
29
#include <config.h>
#include <gtk/gtksignal.h>
30
31
#include "gdk-pixbuf-loader.h"
#include "gdk-pixbuf-io.h"
32

33
34


35
36
37
38
39
40
enum {
	AREA_UPDATED,
	AREA_PREPARED,
	CLOSED,
	LAST_SIGNAL
};
41

42
static GtkObjectClass *parent_class;
43
44
45

static void gdk_pixbuf_loader_class_init    (GdkPixbufLoaderClass   *klass);
static void gdk_pixbuf_loader_init          (GdkPixbufLoader        *loader);
46
47
static void gdk_pixbuf_loader_destroy       (GtkObject              *loader);
static void gdk_pixbuf_loader_finalize      (GtkObject              *loader);
48

49
50
51
static guint pixbuf_loader_signals[LAST_SIGNAL] = { 0 };


52

53
/* Internal data */
54
55
56

#define LOADER_HEADER_SIZE 128

57
typedef struct {
58
	GdkPixbuf *pixbuf;
59
	GdkPixbufAnimation *animation;
60
	gboolean closed;
61
62
	gchar header_buf[LOADER_HEADER_SIZE];
	gint header_buf_offset;
63
	GdkPixbufModule *image_module;
64
	gpointer context;
65
} GdkPixbufLoaderPrivate;
66

67

68
69

/* our marshaller */
70
71
72
73
74
typedef void (* GtkSignal_NONE__INT_INT_INT_INT) (GtkObject *object,
						  gint arg1, gint arg2, gint arg3, gint arg4,
						  gpointer user_data);
static void
gtk_marshal_NONE__INT_INT_INT_INT (GtkObject *object, GtkSignalFunc func, gpointer func_data,
75
76
				   GtkArg * args)
{
77
78
79
80
81
82
83
84
85
	GtkSignal_NONE__INT_INT_INT_INT rfunc;

	rfunc = (GtkSignal_NONE__INT_INT_INT_INT) func;
	(*rfunc) (object,
		  GTK_VALUE_INT (args[0]),
		  GTK_VALUE_INT (args[1]),
		  GTK_VALUE_INT (args[2]),
		  GTK_VALUE_INT (args[3]),
		  func_data);
86
}
87

88
89
90
91
92
93


/**
 * gdk_pixbuf_loader_get_type:
 * @void: 
 * 
Arturo Espinosa's avatar
Arturo Espinosa committed
94
 * Registers the #GdkPixubfLoader class if necessary, and returns the type ID
95
96
 * associated to it.
 * 
Arturo Espinosa's avatar
Arturo Espinosa committed
97
 * Return value: The type ID of the #GdkPixbufLoader class.
98
 **/
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
GtkType
gdk_pixbuf_loader_get_type (void)
{
	static GtkType loader_type = 0;

	if (!loader_type) {
		static const GtkTypeInfo loader_info = {
			"GdkPixbufLoader",
			sizeof (GdkPixbufLoader),
			sizeof (GdkPixbufLoaderClass),
			(GtkClassInitFunc) gdk_pixbuf_loader_class_init,
			(GtkObjectInitFunc) gdk_pixbuf_loader_init,
			/* reserved_1 */ NULL,
			/* reserved_2 */ NULL,
			(GtkClassInitFunc) NULL,
		};

		loader_type = gtk_type_unique (GTK_TYPE_OBJECT, &loader_info);
	}

	return loader_type;
}

static void
123
gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class)
124
{
125
126
127
128
129
	GtkObjectClass *object_class;

	object_class = (GtkObjectClass *) class;

	parent_class = gtk_type_class (gtk_object_get_type ());
130

131
132
133
134
135
136
137
138
139
140
141
142
143
144
	pixbuf_loader_signals[AREA_PREPARED] =
		gtk_signal_new ("area_prepared",
				GTK_RUN_LAST,
				parent_class->type,
				GTK_SIGNAL_OFFSET (GdkPixbufLoaderClass, area_prepared),
				gtk_marshal_NONE__NONE,
				GTK_TYPE_NONE, 0);

	pixbuf_loader_signals[AREA_UPDATED] =
		gtk_signal_new ("area_updated",
				GTK_RUN_LAST,
				parent_class->type,
				GTK_SIGNAL_OFFSET (GdkPixbufLoaderClass, area_updated),
				gtk_marshal_NONE__INT_INT_INT_INT,
145
146
147
148
149
				GTK_TYPE_NONE, 4,
				GTK_TYPE_INT,
				GTK_TYPE_INT,
				GTK_TYPE_INT,
				GTK_TYPE_INT);
150
151
152
153
154
155
156
157
158

	pixbuf_loader_signals[CLOSED] =
		gtk_signal_new ("closed",
				GTK_RUN_LAST,
				parent_class->type,
				GTK_SIGNAL_OFFSET (GdkPixbufLoaderClass, closed),
				gtk_marshal_NONE__NONE,
				GTK_TYPE_NONE, 0);

159
	gtk_object_class_add_signals (object_class, pixbuf_loader_signals, LAST_SIGNAL);
160

161
162
	object_class->destroy = gdk_pixbuf_loader_destroy;
	object_class->finalize = gdk_pixbuf_loader_finalize;
163
164
165
166
167
}

static void
gdk_pixbuf_loader_init (GdkPixbufLoader *loader)
{
168
	GdkPixbufLoaderPrivate *priv;
169

170
	priv = g_new0 (GdkPixbufLoaderPrivate, 1);
171
	loader->private = priv;
172
173
174
}

static void
Arturo Espinosa's avatar
Arturo Espinosa committed
175
gdk_pixbuf_loader_destroy (GtkObject *object)
176
{
Arturo Espinosa's avatar
Arturo Espinosa committed
177
	GdkPixbufLoader *loader;
178
	GdkPixbufLoaderPrivate *priv = NULL;
179

Arturo Espinosa's avatar
Arturo Espinosa committed
180
181
	g_return_if_fail (object != NULL);
	g_return_if_fail (GDK_IS_PIXBUF_LOADER (object));
182

Arturo Espinosa's avatar
Arturo Espinosa committed
183
184
	loader = GDK_PIXBUF_LOADER (object);
	priv = loader->private;
185

186
	if (!priv->closed)
Arturo Espinosa's avatar
Arturo Espinosa committed
187
		gdk_pixbuf_loader_close (loader);
188
189
190

	if (priv->pixbuf)
		gdk_pixbuf_unref (priv->pixbuf);
191
192

	if (GTK_OBJECT_CLASS (parent_class)->destroy)
Arturo Espinosa's avatar
Arturo Espinosa committed
193
		(* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
194
195
196
}

static void
Arturo Espinosa's avatar
Arturo Espinosa committed
197
gdk_pixbuf_loader_finalize (GtkObject *object)
198
{
Arturo Espinosa's avatar
Arturo Espinosa committed
199
	GdkPixbufLoader *loader;
200
	GdkPixbufLoaderPrivate *priv = NULL;
201

Arturo Espinosa's avatar
Arturo Espinosa committed
202
203
204
	loader = GDK_PIXBUF_LOADER (object);
	priv = loader->private;

205
	g_free (priv);
206
207

	if (GTK_OBJECT_CLASS (parent_class)->finalize)
Arturo Espinosa's avatar
Arturo Espinosa committed
208
		(* GTK_OBJECT_CLASS (parent_class)->finalize) (object);
209
210
}

211
212
213
214
215
216
217
218
219
220
static void
gdk_pixbuf_loader_prepare (GdkPixbuf *pixbuf, gpointer loader)
{
	GdkPixbufLoaderPrivate *priv = NULL;

	priv = GDK_PIXBUF_LOADER (loader)->private;
	gdk_pixbuf_ref (pixbuf);
	g_assert (priv->pixbuf == NULL);

	priv->pixbuf = pixbuf;
Jonathan Blandford's avatar
Jonathan Blandford committed
221
	gtk_signal_emit (GTK_OBJECT (loader), pixbuf_loader_signals[AREA_PREPARED]);
222
223
}

224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
static void
gdk_pixbuf_loader_update (GdkPixbuf *pixbuf, gpointer loader, guint x, guint y, guint width, guint height)
{
	GdkPixbufLoaderPrivate *priv = NULL;

	priv = GDK_PIXBUF_LOADER (loader)->private;

	gtk_signal_emit (GTK_OBJECT (loader),
			 pixbuf_loader_signals[AREA_UPDATED],
			 x, y,
			 /* sanity check in here.  Defend against an errant loader */
			 MIN (width, gdk_pixbuf_get_width (priv->pixbuf)),
			 MIN (height, gdk_pixbuf_get_height (priv->pixbuf)));
}

239
240
241
242
243
244
245
246
247
248
249


/**
 * gdk_pixbuf_loader_new:
 * @void: 
 * 
 * Creates a new pixbuf loader object.
 * 
 * Return value: A newly-created pixbuf loader.
 **/
GdkPixbufLoader *
250
251
gdk_pixbuf_loader_new (void)
{
252
	return gtk_type_new (gdk_pixbuf_loader_get_type ());
253
254
}

255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
static int
gdk_pixbuf_loader_load_module(GdkPixbufLoader *loader)
{
	GdkPixbufLoaderPrivate *priv = loader->private;

	priv->image_module = gdk_pixbuf_get_module (priv->header_buf, priv->header_buf_offset);

	if (priv->image_module == NULL)
		return 0;

	if (priv->image_module->module == NULL)
		gdk_pixbuf_load_module (priv->image_module);

	if (priv->image_module->module == NULL)
		return 0;

	if ((priv->image_module->begin_load == NULL) ||
	    (priv->image_module->stop_load == NULL) ||
	    (priv->image_module->load_increment == NULL)) {
		g_warning ("module %s does not support incremental loading.\n",
			   priv->image_module->module_name);
		return 0;
	}

279
	priv->context = (*priv->image_module->begin_load) (gdk_pixbuf_loader_prepare, gdk_pixbuf_loader_update, loader);
280
281
282
283
284
285
286
287
288
289
290
291
292

	if (priv->context == NULL) {
		g_warning("Failed to begin progressive load");
		return 0;
	}

	if( (* priv->image_module->load_increment) (priv->context, priv->header_buf, priv->header_buf_offset) )
		return priv->header_buf_offset;
 
	return 0;
}

static int
293
gdk_pixbuf_loader_eat_header_write (GdkPixbufLoader *loader, const gchar *buf, size_t count)
294
295
296
297
298
299
300
301
302
{
	int nbytes;
	GdkPixbufLoaderPrivate *priv = loader->private;

	nbytes = MIN(LOADER_HEADER_SIZE - priv->header_buf_offset, count);
	memcpy (priv->header_buf + priv->header_buf_offset, buf, nbytes);
	    
	priv->header_buf_offset += nbytes;
	    
303
304
305
306
	if(priv->header_buf_offset >= LOADER_HEADER_SIZE)
		gdk_pixbuf_loader_load_module(loader);

	return nbytes;
307
308
}

309
310
/**
 * gdk_pixbuf_loader_write:
311
 * @loader: A pixbuf loader.
Federico Mena Quintero's avatar
Federico Mena Quintero committed
312
313
 * @buf: Pointer to image data.
 * @count: Length of the @buf buffer in bytes.
314
 *
Federico Mena Quintero's avatar
Federico Mena Quintero committed
315
316
317
318
 * This will cause a pixbuf loader to parse the next @count bytes of an image.
 * It will return TRUE if the data was loaded successfully, and FALSE if an
 * error occurred.  In the latter case, the loader will be closed, and will not
 * accept further writes.
319
 *
Federico Mena Quintero's avatar
Federico Mena Quintero committed
320
321
 * Return value: #TRUE if the write was successful, or #FALSE if the loader
 * cannot parse the buffer.
322
323
 **/
gboolean
324
gdk_pixbuf_loader_write (GdkPixbufLoader *loader, const gchar *buf, size_t count)
325
326
327
328
329
{
	GdkPixbufLoaderPrivate *priv;

	g_return_val_if_fail (loader != NULL, FALSE);
	g_return_val_if_fail (GDK_IS_PIXBUF_LOADER (loader), FALSE);
330

331
332
	g_return_val_if_fail (buf != NULL, FALSE);
	g_return_val_if_fail (count >= 0, FALSE);
333
334
335
336
337
338

	priv = loader->private;

	/* we expect it's not to be closed */
	g_return_val_if_fail (priv->closed == FALSE, FALSE);

339
	if (priv->image_module == NULL) {
340
341
342
343
344
345
346
347
		int eaten;

		eaten = gdk_pixbuf_loader_eat_header_write(loader, buf, count);
		if (eaten <= 0)
			return FALSE;

		count -= eaten;
		buf += eaten;
348
	}
349

350
	if (count > 0 && priv->image_module->load_increment)
351
352
		return (* priv->image_module->load_increment) (priv->context, buf, count);

353
	return TRUE;
354
355
356
357
}

/**
 * gdk_pixbuf_loader_get_pixbuf:
358
 * @loader: A pixbuf loader.
359
 *
Federico Mena Quintero's avatar
Federico Mena Quintero committed
360
361
362
363
364
365
366
 * Queries the GdkPixbuf that a pixbuf loader is currently creating.  In general
 * it only makes sense to call this function afer the "area_prepared" signal has
 * been emitted by the loader; this means that enough data has been read to know
 * the size of the image that will be allocated.  If the loader has not received
 * enough data via gdk_pixbuf_loader_write(), then this function returns NULL.
 * The returned pixbuf will be the same in all future calls to the loader, so
 * simply calling gdk_pixbuf_ref() should be sufficient to continue using it.
367
 *
Federico Mena Quintero's avatar
Federico Mena Quintero committed
368
369
 * Return value: The GdkPixbuf that the loader is creating, or NULL if not
 * enough data has been read to determine how to create the image buffer.
370
371
372
373
374
375
376
377
 **/
GdkPixbuf *
gdk_pixbuf_loader_get_pixbuf (GdkPixbufLoader *loader)
{
	GdkPixbufLoaderPrivate *priv;

	g_return_val_if_fail (loader != NULL, NULL);
	g_return_val_if_fail (GDK_IS_PIXBUF_LOADER (loader), NULL);
378

379
380
381
382
383
	priv = loader->private;

	return priv->pixbuf;
}

384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/**
 * gdk_pixbuf_loader_get_animation:
 * @loader: A pixbuf loader
 * 
 * Queries the GdkPixbufAnimation that a pixbuf loader is currently creating.
 * In general it only makes sense to call this function afer the "area_prepared"
 * signal has been emitted by the loader.
 * 
 * Return value: The GdkPixbufAnimation that the loader is loading, or NULL if
 not enough data has been read to determine the information.
 **/
GdkPixbufAnimation *
gdk_pixbuf_loader_get_animation (GdkPixbufLoader *loader)
{
	GdkPixbufLoaderPrivate *priv;

	g_return_val_if_fail (loader != NULL, NULL);
	g_return_val_if_fail (GDK_IS_PIXBUF_LOADER (loader), NULL);

	priv = loader->private;

	return priv->animation;
}

408
409
/**
 * gdk_pixbuf_loader_close:
410
 * @loader: A pixbuf loader.
411
 *
Federico Mena Quintero's avatar
Federico Mena Quintero committed
412
413
 * Informs a pixbuf loader that no further writes with gdk_pixbuf_load_write()
 * will occur, so that it can free its internal loading structures.
414
415
416
417
418
419
420
421
422
423
424
425
426
 **/
void
gdk_pixbuf_loader_close (GdkPixbufLoader *loader)
{
	GdkPixbufLoaderPrivate *priv;

	g_return_if_fail (loader != NULL);
	g_return_if_fail (GDK_IS_PIXBUF_LOADER (loader));

	priv = loader->private;

	/* we expect it's not closed */
	g_return_if_fail (priv->closed == FALSE);
427
428

	/* We have less the 128 bytes in the image.  Flush it, and keep going. */
429
430
	if (priv->image_module == NULL)
		gdk_pixbuf_loader_load_module (loader);
431
432

	if (priv->image_module && priv->image_module->stop_load)
433
		(* priv->image_module->stop_load) (priv->context);
434

435
	priv->closed = TRUE;
Jonathan Blandford's avatar
Jonathan Blandford committed
436
437

	gtk_signal_emit (GTK_OBJECT (loader),
Jonathan Blandford's avatar
Jonathan Blandford committed
438
			 pixbuf_loader_signals[CLOSED]);
439
}