gdk-pixbuf-loader.c 10.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/* 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.
 */

#include "gdk-pixbuf-loader.h"
27
#include "gdk-pixbuf-io.h"
Jonathan Blandford's avatar
Jonathan Blandford committed
28
#include <gtk/gtksignal.h>
29

30
31


32
33
34
35
36
37
enum {
	AREA_UPDATED,
	AREA_PREPARED,
	CLOSED,
	LAST_SIGNAL
};
38

39
static GtkObjectClass *parent_class;
40
41
42

static void gdk_pixbuf_loader_class_init    (GdkPixbufLoaderClass   *klass);
static void gdk_pixbuf_loader_init          (GdkPixbufLoader        *loader);
43
44
static void gdk_pixbuf_loader_destroy       (GtkObject              *loader);
static void gdk_pixbuf_loader_finalize      (GtkObject              *loader);
45

46
47
48
static guint pixbuf_loader_signals[LAST_SIGNAL] = { 0 };


49

50
/* Internal data */
51
typedef struct {
52
53
	GdkPixbuf *pixbuf;
	gboolean closed;
54
55
	gchar buf[128];
	gint buf_offset;
56
	GdkPixbufModule *image_module;
57
	gpointer context;
58
} GdkPixbufLoaderPrivate;
59

60

61
62

/* our marshaller */
63
64
65
66
67
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,
68
69
				   GtkArg * args)
{
70
71
72
73
74
75
76
77
78
	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);
79
}
80

81
82
83
84
85
86
87
88
89
90
91


/**
 * gdk_pixbuf_loader_get_type:
 * @void: 
 * 
 * Registers the &GdkPixubfLoader class if necessary, and returns the type ID
 * associated to it.
 * 
 * Return value: The type ID of the &GdkPixbufLoader class.
 **/
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
116
gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class)
117
{
118
119
120
121
122
	GtkObjectClass *object_class;

	object_class = (GtkObjectClass *) class;

	parent_class = gtk_type_class (gtk_object_get_type ());
123

124
125
126
127
128
129
130
131
132
133
134
135
136
137
	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,
138
139
140
141
142
				GTK_TYPE_NONE, 4,
				GTK_TYPE_INT,
				GTK_TYPE_INT,
				GTK_TYPE_INT,
				GTK_TYPE_INT);
143
144
145
146
147
148
149
150
151

	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);

152
	gtk_object_class_add_signals (object_class, pixbuf_loader_signals, LAST_SIGNAL);
153

154
155
	object_class->destroy = gdk_pixbuf_loader_destroy;
	object_class->finalize = gdk_pixbuf_loader_finalize;
156
157
158
159
160
}

static void
gdk_pixbuf_loader_init (GdkPixbufLoader *loader)
{
161
	GdkPixbufLoaderPrivate *priv;
162

163
	priv = g_new0 (GdkPixbufLoaderPrivate, 1);
164
	loader->private = priv;
165
166
167
}

static void
Arturo Espinosa's avatar
Arturo Espinosa committed
168
gdk_pixbuf_loader_destroy (GtkObject *object)
169
{
Arturo Espinosa's avatar
Arturo Espinosa committed
170
	GdkPixbufLoader *loader;
171
	GdkPixbufLoaderPrivate *priv = NULL;
172

Arturo Espinosa's avatar
Arturo Espinosa committed
173
174
	g_return_if_fail (object != NULL);
	g_return_if_fail (GDK_IS_PIXBUF_LOADER (object));
175

Arturo Espinosa's avatar
Arturo Espinosa committed
176
177
	loader = GDK_PIXBUF_LOADER (object);
	priv = loader->private;
178

179
	if (!priv->closed)
Arturo Espinosa's avatar
Arturo Espinosa committed
180
		gdk_pixbuf_loader_close (loader);
181
182
183

	if (priv->pixbuf)
		gdk_pixbuf_unref (priv->pixbuf);
184
185

	if (GTK_OBJECT_CLASS (parent_class)->destroy)
Arturo Espinosa's avatar
Arturo Espinosa committed
186
		(* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
187
188
189
}

static void
Arturo Espinosa's avatar
Arturo Espinosa committed
190
gdk_pixbuf_loader_finalize (GtkObject *object)
191
{
Arturo Espinosa's avatar
Arturo Espinosa committed
192
	GdkPixbufLoader *loader;
193
	GdkPixbufLoaderPrivate *priv = NULL;
194

Arturo Espinosa's avatar
Arturo Espinosa committed
195
196
197
	loader = GDK_PIXBUF_LOADER (object);
	priv = loader->private;

198
	g_free (priv);
199
200

	if (GTK_OBJECT_CLASS (parent_class)->finalize)
Arturo Espinosa's avatar
Arturo Espinosa committed
201
		(* GTK_OBJECT_CLASS (parent_class)->finalize) (object);
202
203
}

204
205
206
207
208
209
210
211
212
213
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
214
	gtk_signal_emit (GTK_OBJECT (loader), pixbuf_loader_signals[AREA_PREPARED]);
215
216
}

217
218
219
220
221
222
223
224
225
226
227


/**
 * gdk_pixbuf_loader_new:
 * @void: 
 * 
 * Creates a new pixbuf loader object.
 * 
 * Return value: A newly-created pixbuf loader.
 **/
GdkPixbufLoader *
228
229
gdk_pixbuf_loader_new (void)
{
230
	return gtk_type_new (gdk_pixbuf_loader_get_type ());
231
232
233
234
}

/**
 * gdk_pixbuf_loader_write:
235
 * @loader: A pixbuf loader.
236
237
 * @buf: The image data.
 * @count: The length of @buf in bytes.
238
 *
239
240
241
 * This will load the next @size bytes of the image.  It will return TRUE if the
 * data was loaded successfully, and FALSE if an error occurred. In this case,
 * the loader will be closed, and will not accept further writes.
242
 *
243
244
245
246
 * Return value: Returns TRUE if the write was successful -- FALSE if the loader
 * cannot parse the buf.
 **/
gboolean
247
gdk_pixbuf_loader_write (GdkPixbufLoader *loader, guchar *buf, size_t count)
248
249
250
251
252
{
	GdkPixbufLoaderPrivate *priv;

	g_return_val_if_fail (loader != NULL, FALSE);
	g_return_val_if_fail (GDK_IS_PIXBUF_LOADER (loader), FALSE);
253
254
	g_return_val_if_fail (buf != NULL, FALSE);
	g_return_val_if_fail (count >= 0, FALSE);
255
256
257
258
259
260

	priv = loader->private;

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

261
	if (priv->image_module == NULL) {
262
263
		gboolean retval = TRUE;

264
265
		memcpy (priv->buf + priv->buf_offset,
			buf,
266
267
268
			(priv->buf_offset + count > 128) ? (128 - priv->buf_offset) : count);

		if (priv->buf_offset + count >= 128) {
269
			/* We have enough data to start doing something with the image */
270
			priv->image_module = gdk_pixbuf_get_module (priv->buf, 128);
271
			if (priv->image_module == NULL)
272
				return FALSE;
273
274
275
276
277
			else 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);
278
279
				return FALSE;
			} else {
280
281
				priv->context = (*priv->image_module->begin_load) (
					gdk_pixbuf_loader_prepare, loader);
282
283
284
285
286
287

                                if (priv->context == NULL) {
                                        g_warning("Failed to begin progressive load");
                                        return FALSE;
                                }
                                
288
289
290
291
292
293
				retval = (* priv->image_module->load_increment) (
					priv->context, priv->buf, 128);

				/* if we had more then 128 bytes total, we want
				 * to send the rest of the buffer.
				 */
294

295
				if (retval && (priv->buf_offset + count) > 128) {
296
297
298
299
					retval = (* priv->image_module->load_increment) (
						priv->context,
						buf,
						count + priv->buf_offset - 128);
300
				}
301
			}
302
		} else
303
			priv->buf_offset += count;
304

305
		return retval;
306
	}
307
308

	if (priv->image_module->load_increment)
309
310
		return (* priv->image_module->load_increment) (priv->context, buf, count);

311
	return (FALSE);
312
313
314
315
}

/**
 * gdk_pixbuf_loader_get_pixbuf:
316
 * @loader: A pixbuf loader.
317
 *
318
319
320
321
322
323
 * Gets the GdkPixbuf that the loader is currently loading.  If the loader
 * hasn't been enough data via gdk_pixbuf_loader_write, then NULL is returned.
 * Any application using this function should check for this value when it is
 * used.  The pixbuf returned will be the same in all future calls to the
 * loader, so simply calling a gdk_pixbuf_ref() should be sufficient to continue
 * using it.
324
 *
325
326
327
328
329
330
331
332
333
 * Return value: The GdkPixbuf that the loader is loading.
 **/
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);
334

335
336
337
338
339
340
341
	priv = loader->private;

	return priv->pixbuf;
}

/**
 * gdk_pixbuf_loader_close:
342
 * @loader: A pixbuf loader.
343
 *
344
 * Tells the loader to stop accepting writes.
345
346
347
348
349
350
351
352
353
354
355
356
357
 **/
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);
358
359

	/* We have less the 128 bytes in the image.  Flush it, and keep going. */
Jonathan Blandford's avatar
Jonathan Blandford committed
360
	if (priv->image_module == NULL) {
361
362
363
		priv->image_module = gdk_pixbuf_get_module (priv->buf, priv->buf_offset);
		if (priv->image_module &&
		    ((priv->image_module->begin_load == NULL) ||
364
365
366
367
		     (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);
368
369
		} else if (priv->image_module) {
			g_print ("module loaded: name is %s\n", priv->image_module->module_name);
370
371
372
373
			priv->context = (* priv->image_module->begin_load) (
				gdk_pixbuf_loader_prepare, loader);
			(* priv->image_module->load_increment) (priv->context,
								priv->buf, priv->buf_offset);
374
375
376
377
		}
	}

	if (priv->image_module && priv->image_module->stop_load)
378
		(* priv->image_module->stop_load) (priv->context);
379

380
381
	priv->closed = TRUE;
}