gdk-pixbuf-animation.c 27.3 KB
Newer Older
Havoc Pennington's avatar
Havoc Pennington committed
1
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*- */
2 3 4 5 6 7 8 9
/* GdkPixbuf library - Simple animation support
 *
 * Copyright (C) 1999 The Free Software Foundation
 *
 * Authors: Jonathan Blandford <jrb@redhat.com>
 *          Havoc Pennington <hp@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
10
 * modify it under the terms of the GNU Lesser General Public
11 12 13 14 15 16
 * 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
17
 * Lesser General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU Lesser General Public
20 21 22 23 24 25
 * 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 <config.h>
Havoc Pennington's avatar
Havoc Pennington committed
26
#include <errno.h>
27
#include "gdk-pixbuf-alias.h"
28
#include "gdk-pixbuf-private.h"
29 30 31
#include "gdk-pixbuf-io.h"
#include "gdk-pixbuf-i18n.h"
#include "gdk-pixbuf-animation.h"
32

Havoc Pennington's avatar
Havoc Pennington committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
typedef struct _GdkPixbufNonAnim GdkPixbufNonAnim;
typedef struct _GdkPixbufNonAnimClass GdkPixbufNonAnimClass;

#define GDK_TYPE_PIXBUF_NON_ANIM              (gdk_pixbuf_non_anim_get_type ())
#define GDK_PIXBUF_NON_ANIM(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_PIXBUF_NON_ANIM, GdkPixbufNonAnim))
#define GDK_IS_PIXBUF_NON_ANIM(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_PIXBUF_NON_ANIM))

#define GDK_PIXBUF_NON_ANIM_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_PIXBUF_NON_ANIM, GdkPixbufNonAnimClass))
#define GDK_IS_PIXBUF_NON_ANIM_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_PIXBUF_NON_ANIM))
#define GDK_PIXBUF_NON_ANIM_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_PIXBUF_NON_ANIM, GdkPixbufNonAnimClass))

/* Private part of the GdkPixbufNonAnim structure */
struct _GdkPixbufNonAnim {
        GdkPixbufAnimation parent_instance;

        GdkPixbuf *pixbuf;
};

struct _GdkPixbufNonAnimClass {
        GdkPixbufAnimationClass parent_class;
        
};

static GType gdk_pixbuf_non_anim_get_type (void) G_GNUC_CONST;
57 58 59



Havoc Pennington's avatar
Havoc Pennington committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
typedef struct _GdkPixbufNonAnimIter GdkPixbufNonAnimIter;
typedef struct _GdkPixbufNonAnimIterClass GdkPixbufNonAnimIterClass;


#define GDK_TYPE_PIXBUF_NON_ANIM_ITER              (gdk_pixbuf_non_anim_iter_get_type ())
#define GDK_PIXBUF_NON_ANIM_ITER(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_PIXBUF_NON_ANIM_ITER, GdkPixbufNonAnimIter))
#define GDK_IS_PIXBUF_NON_ANIM_ITER(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_PIXBUF_NON_ANIM_ITER))

#define GDK_PIXBUF_NON_ANIM_ITER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_PIXBUF_NON_ANIM_ITER, GdkPixbufNonAnimIterClass))
#define GDK_IS_PIXBUF_NON_ANIM_ITER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_PIXBUF_NON_ANIM_ITER))
#define GDK_PIXBUF_NON_ANIM_ITER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_PIXBUF_NON_ANIM_ITER, GdkPixbufNonAnimIterClass))

struct _GdkPixbufNonAnimIter {
        GdkPixbufAnimationIter parent_instance;

        GdkPixbufNonAnim   *non_anim;
};

struct _GdkPixbufNonAnimIterClass {
        GdkPixbufAnimationIterClass parent_class;

};

static GType gdk_pixbuf_non_anim_iter_get_type (void) G_GNUC_CONST;


86 87 88 89 90 91 92 93 94 95 96

GType
gdk_pixbuf_animation_get_type (void)
{
        static GType object_type = 0;

        if (!object_type) {
                static const GTypeInfo object_info = {
                        sizeof (GdkPixbufAnimationClass),
                        (GBaseInitFunc) NULL,
                        (GBaseFinalizeFunc) NULL,
Havoc Pennington's avatar
Havoc Pennington committed
97
                        (GClassInitFunc) NULL,
98 99 100 101 102 103
                        NULL,           /* class_finalize */
                        NULL,           /* class_data */
                        sizeof (GdkPixbufAnimation),
                        0,              /* n_preallocs */
                        (GInstanceInitFunc) NULL,
                };
104
                
105 106
                object_type = g_type_register_static (G_TYPE_OBJECT,
                                                      "GdkPixbufAnimation",
107
                                                      &object_info, 0);
108 109 110 111 112
        }
  
        return object_type;
}

113 114 115 116 117


/**
 * gdk_pixbuf_animation_new_from_file:
 * @filename: Name of file to load.
Havoc Pennington's avatar
Havoc Pennington committed
118
 * @error: return location for error
119 120 121
 *
 * Creates a new animation by loading it from a file.  The file format is
 * detected automatically.  If the file's format does not support multi-frame
Havoc Pennington's avatar
Havoc Pennington committed
122 123
 * images, then an animation with a single frame will be created. Possible errors
 * are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
124
 *
125
 * Return value: A newly-created animation with a reference count of 1, or %NULL
126 127 128 129 130
 * if any of several error conditions ocurred:  the file could not be opened,
 * there was no loader for the file's format, there was not enough memory to
 * allocate the image buffer, or the image file contained invalid data.
 **/
GdkPixbufAnimation *
Havoc Pennington's avatar
Havoc Pennington committed
131 132
gdk_pixbuf_animation_new_from_file (const char *filename,
                                    GError    **error)
133 134 135 136 137 138
{
	GdkPixbufAnimation *animation;
	int size;
	FILE *f;
	guchar buffer [128];
	GdkPixbufModule *image_module;
139
        gchar *display_name;
140 141

	g_return_val_if_fail (filename != NULL, NULL);
142
        g_return_val_if_fail (error == NULL || *error == NULL, NULL);
143

144
        display_name = g_filename_display_name (filename);
Tor Lillqvist's avatar
Tor Lillqvist committed
145
	f = fopen (filename, "rb");
Havoc Pennington's avatar
Havoc Pennington committed
146 147 148 149 150
	if (!f) {
                g_set_error (error,
                             G_FILE_ERROR,
                             g_file_error_from_errno (errno),
                             _("Failed to open file '%s': %s"),
151
                             display_name,
152
                             g_strerror (errno));
153
                g_free (display_name);
154
		return NULL;
Havoc Pennington's avatar
Havoc Pennington committed
155
        }
156 157 158 159

	size = fread (&buffer, 1, sizeof (buffer), f);

	if (size == 0) {
Havoc Pennington's avatar
Havoc Pennington committed
160 161 162 163
                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                             _("Image file '%s' contains no data"),
164 165
                             display_name);
                g_free (display_name);
166 167 168 169
		fclose (f);
		return NULL;
	}

170
	image_module = _gdk_pixbuf_get_module (buffer, size, filename, error);
171
	if (!image_module) {
172
                g_free (display_name);
173 174 175 176 177
		fclose (f);
		return NULL;
	}

	if (image_module->module == NULL)
178
                if (!_gdk_pixbuf_load_module (image_module, error)) {
179
                        g_free (display_name);
Havoc Pennington's avatar
Havoc Pennington committed
180 181 182
                        fclose (f);
                        return NULL;
                }
183

184 185
        _gdk_pixbuf_lock (image_module);

186 187 188 189 190 191
	if (image_module->load_animation == NULL) {
		GdkPixbuf *pixbuf;

		/* Keep this logic in sync with gdk_pixbuf_new_from_file() */

		fseek (f, 0, SEEK_SET);
192
		pixbuf = _gdk_pixbuf_generic_image_load (image_module, f, error);
193 194
		fclose (f);

Havoc Pennington's avatar
Havoc Pennington committed
195 196 197 198 199 200 201 202 203 204 205 206 207
                if (pixbuf == NULL && error != NULL && *error == NULL) {
                        /* I don't trust these crufty longjmp()'ing image libs
                         * to maintain proper error invariants, and I don't
                         * want user code to segfault as a result. We need to maintain
                         * the invariant that error gets set if NULL is returned.
                         */
                        
                        g_warning ("Bug! gdk-pixbuf loader '%s' didn't set an error on failure.",
                                   image_module->module_name);
                        g_set_error (error,
                                     GDK_PIXBUF_ERROR,
                                     GDK_PIXBUF_ERROR_FAILED,
                                     _("Failed to load image '%s': reason not known, probably a corrupt image file"),
208
                                     display_name);
Havoc Pennington's avatar
Havoc Pennington committed
209 210
                }
                
211 212
		if (pixbuf == NULL) {
                        g_free (display_name);
213 214
                        animation = NULL;
                        goto out_unlock;
215
                }
216

217
                animation = gdk_pixbuf_non_anim_new (pixbuf);
218

219
                g_object_unref (pixbuf);
220 221
	} else {
		fseek (f, 0, SEEK_SET);
Havoc Pennington's avatar
Havoc Pennington committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
		animation = (* image_module->load_animation) (f, error);

                if (animation == NULL && error != NULL && *error == NULL) {
                        /* I don't trust these crufty longjmp()'ing
                         * image libs to maintain proper error
                         * invariants, and I don't want user code to
                         * segfault as a result. We need to maintain
                         * the invariant that error gets set if NULL
                         * is returned.
                         */
                        
                        g_warning ("Bug! gdk-pixbuf loader '%s' didn't set an error on failure.",
                                   image_module->module_name);
                        g_set_error (error,
                                     GDK_PIXBUF_ERROR,
                                     GDK_PIXBUF_ERROR_FAILED,
                                     _("Failed to load animation '%s': reason not known, probably a corrupt animation file"),
239
                                     display_name);
Havoc Pennington's avatar
Havoc Pennington committed
240 241
                }
                
242 243 244
		fclose (f);
	}

245 246
        g_free (display_name);

247 248
 out_unlock:
        _gdk_pixbuf_unlock (image_module);
249 250 251 252 253 254 255
	return animation;
}

/**
 * gdk_pixbuf_animation_ref:
 * @animation: An animation.
 *
Matthias Clasen's avatar
Matthias Clasen committed
256
 * Adds a reference to an animation. 
257 258
 *
 * Return value: The same as the @animation argument.
Matthias Clasen's avatar
Matthias Clasen committed
259 260
 *
 * Deprecated: Use g_object_ref(). 
261
 **/
262
GdkPixbufAnimation *
263 264
gdk_pixbuf_animation_ref (GdkPixbufAnimation *animation)
{
Manish Singh's avatar
Manish Singh committed
265
        return (GdkPixbufAnimation*) g_object_ref (animation);
266 267 268 269 270 271
}

/**
 * gdk_pixbuf_animation_unref:
 * @animation: An animation.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
272 273 274
 * Removes a reference from an animation. 
 *
 * Deprecated: Use g_object_unref().
275 276 277 278
 **/
void
gdk_pixbuf_animation_unref (GdkPixbufAnimation *animation)
{
Manish Singh's avatar
Manish Singh committed
279
        g_object_unref (animation);
280
}
281

Havoc Pennington's avatar
Havoc Pennington committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
/**
 * gdk_pixbuf_animation_is_static_image:
 * @animation: a #GdkPixbufAnimation
 * 
 * If you load a file with gdk_pixbuf_animation_new_from_file() and it turns
 * out to be a plain, unanimated image, then this function will return
 * %TRUE. Use gdk_pixbuf_animation_get_static_image() to retrieve
 * the image.
 * 
 * Return value: %TRUE if the "animation" was really just an image
 **/
gboolean
gdk_pixbuf_animation_is_static_image (GdkPixbufAnimation *animation)
{
	g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION (animation), FALSE);

        return GDK_PIXBUF_ANIMATION_GET_CLASS (animation)->is_static_image (animation);
}

/**
 * gdk_pixbuf_animation_get_static_image:
 * @animation: a #GdkPixbufAnimation
 * 
 * If an animation is really just a plain image (has only one frame),
 * this function returns that image. If the animation is an animation,
 * this function returns a reasonable thing to display as a static
 * unanimated image, which might be the first frame, or something more
 * sophisticated. If an animation hasn't loaded any frames yet, this
 * function will return %NULL.
 * 
 * Return value: unanimated image representing the animation
 **/
GdkPixbuf*
gdk_pixbuf_animation_get_static_image (GdkPixbufAnimation *animation)
{
	g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION (animation), NULL);
        
        return GDK_PIXBUF_ANIMATION_GET_CLASS (animation)->get_static_image (animation);
}

322 323 324
/**
 * gdk_pixbuf_animation_get_width:
 * @animation: An animation.
325 326
 *
 * Queries the width of the bounding box of a pixbuf animation.
327
 * 
328
 * Return value: Width of the bounding box of the animation.
329 330 331 332
 **/
int
gdk_pixbuf_animation_get_width (GdkPixbufAnimation *animation)
{
Havoc Pennington's avatar
Havoc Pennington committed
333 334 335 336 337 338 339 340
        int width;
        
	g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION (animation), 0);

        width = 0;
        GDK_PIXBUF_ANIMATION_GET_CLASS (animation)->get_size (animation,
                                                              &width, NULL);
        
341

Havoc Pennington's avatar
Havoc Pennington committed
342
	return width;
343 344 345 346 347
}

/**
 * gdk_pixbuf_animation_get_height:
 * @animation: An animation.
348 349
 *
 * Queries the height of the bounding box of a pixbuf animation.
350
 * 
351
 * Return value: Height of the bounding box of the animation.
352 353 354 355
 **/
int
gdk_pixbuf_animation_get_height (GdkPixbufAnimation *animation)
{
Havoc Pennington's avatar
Havoc Pennington committed
356 357 358
        int height;
        
	g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION (animation), 0);
359

Havoc Pennington's avatar
Havoc Pennington committed
360 361 362 363
        height = 0;
        GDK_PIXBUF_ANIMATION_GET_CLASS (animation)->get_size (animation,
                                                              NULL, &height);
        
364

Havoc Pennington's avatar
Havoc Pennington committed
365
	return height;
366 367
}

Havoc Pennington's avatar
Havoc Pennington committed
368

369
/**
Havoc Pennington's avatar
Havoc Pennington committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
 * gdk_pixbuf_animation_get_iter:
 * @animation: a #GdkPixbufAnimation
 * @start_time: time when the animation starts playing
 * 
 * Get an iterator for displaying an animation. The iterator provides
 * the frames that should be displayed at a given time.
 * It should be freed after use with g_object_unref().
 * 
 * @start_time would normally come from g_get_current_time(), and
 * marks the beginning of animation playback. After creating an
 * iterator, you should immediately display the pixbuf returned by
 * gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install a
 * timeout (with g_timeout_add()) or by some other mechanism ensure
 * that you'll update the image after
 * gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time
 * the image is updated, you should reinstall the timeout with the new,
 * possibly-changed delay time.
 *
 * As a shortcut, if @start_time is %NULL, the result of
 * g_get_current_time() will be used automatically.
390
 *
Havoc Pennington's avatar
Havoc Pennington committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
 * To update the image (i.e. possibly change the result of
 * gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation),
 * call gdk_pixbuf_animation_iter_advance().
 *
 * If you're using #GdkPixbufLoader, in addition to updating the image
 * after the delay time, you should also update it whenever you
 * receive the area_updated signal and
 * gdk_pixbuf_animation_iter_on_currently_loading_frame() returns
 * %TRUE. In this case, the frame currently being fed into the loader
 * has received new data, so needs to be refreshed. The delay time for
 * a frame may also be modified after an area_updated signal, for
 * example if the delay time for a frame is encoded in the data after
 * the frame itself. So your timeout should be reinstalled after any
 * area_updated signal.
 *
 * A delay time of -1 is possible, indicating "infinite."
407
 * 
Havoc Pennington's avatar
Havoc Pennington committed
408
 * Return value: an iterator to move over the animation
409
 **/
Havoc Pennington's avatar
Havoc Pennington committed
410 411 412
GdkPixbufAnimationIter*
gdk_pixbuf_animation_get_iter (GdkPixbufAnimation *animation,
                               const GTimeVal     *start_time)
413
{
Havoc Pennington's avatar
Havoc Pennington committed
414 415 416 417
        GTimeVal val;
        
        g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION (animation), NULL);

418

Havoc Pennington's avatar
Havoc Pennington committed
419 420 421 422 423 424
        if (start_time)
                val = *start_time;
        else
                g_get_current_time (&val);
        
        return GDK_PIXBUF_ANIMATION_GET_CLASS (animation)->get_iter (animation, &val);
425
}
426 427 428



Havoc Pennington's avatar
Havoc Pennington committed
429 430
GType
gdk_pixbuf_animation_iter_get_type (void)
431
{
Havoc Pennington's avatar
Havoc Pennington committed
432
        static GType object_type = 0;
433

Havoc Pennington's avatar
Havoc Pennington committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
        if (!object_type) {
                static const GTypeInfo object_info = {
                        sizeof (GdkPixbufAnimationIterClass),
                        (GBaseInitFunc) NULL,
                        (GBaseFinalizeFunc) NULL,
                        (GClassInitFunc) NULL,
                        NULL,           /* class_finalize */
                        NULL,           /* class_data */
                        sizeof (GdkPixbufAnimationIter),
                        0,              /* n_preallocs */
                        (GInstanceInitFunc) NULL,
                };
                
                object_type = g_type_register_static (G_TYPE_OBJECT,
                                                      "GdkPixbufAnimationIter",
                                                      &object_info, 0);
        }
  
        return object_type;
453 454 455
}

/**
Havoc Pennington's avatar
Havoc Pennington committed
456 457
 * gdk_pixbuf_animation_iter_get_delay_time:
 * @iter: an animation iterator
458
 * 
Havoc Pennington's avatar
Havoc Pennington committed
459 460 461 462 463 464
 * Gets the number of milliseconds the current pixbuf should be displayed,
 * or -1 if the current pixbuf should be displayed forever. g_timeout_add()
 * conveniently takes a timeout in milliseconds, so you can use a timeout
 * to schedule the next update.
 *
 * Return value: delay time in milliseconds (thousandths of a second)
465 466
 **/
int
Havoc Pennington's avatar
Havoc Pennington committed
467
gdk_pixbuf_animation_iter_get_delay_time (GdkPixbufAnimationIter *iter)
468
{
Havoc Pennington's avatar
Havoc Pennington committed
469 470 471
        g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION_ITER (iter), -1);
  
        return GDK_PIXBUF_ANIMATION_ITER_GET_CLASS (iter)->get_delay_time (iter);
472 473 474
}

/**
Havoc Pennington's avatar
Havoc Pennington committed
475 476
 * gdk_pixbuf_animation_iter_get_pixbuf:
 * @iter: an animation iterator
477
 * 
Havoc Pennington's avatar
Havoc Pennington committed
478 479 480 481 482 483 484 485 486 487 488 489 490
 * Gets the current pixbuf which should be displayed; the pixbuf will
 * be the same size as the animation itself
 * (gdk_pixbuf_animation_get_width(),
 * gdk_pixbuf_animation_get_height()). This pixbuf should be displayed
 * for gdk_pixbuf_animation_get_delay_time() milliseconds.  The caller
 * of this function does not own a reference to the returned pixbuf;
 * the returned pixbuf will become invalid when the iterator advances
 * to the next frame, which may happen anytime you call
 * gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it
 * (don't just add a reference), as it may get recycled as you advance
 * the iterator.
 *
 * Return value: the pixbuf to be displayed
491
 **/
Havoc Pennington's avatar
Havoc Pennington committed
492 493
GdkPixbuf*
gdk_pixbuf_animation_iter_get_pixbuf (GdkPixbufAnimationIter *iter)
494
{
Havoc Pennington's avatar
Havoc Pennington committed
495 496 497
        g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION_ITER (iter), NULL);
  
        return GDK_PIXBUF_ANIMATION_ITER_GET_CLASS (iter)->get_pixbuf (iter);
498 499 500
}

/**
Havoc Pennington's avatar
Havoc Pennington committed
501 502 503 504 505 506 507 508
 * gdk_pixbuf_animation_iter_on_currently_loading_frame:
 * @iter: a #GdkPixbufAnimationIter
 *
 * Used to determine how to respond to the area_updated signal on
 * #GdkPixbufLoader when loading an animation. area_updated is emitted
 * for an area of the frame currently streaming in to the loader. So if
 * you're on the currently loading frame, you need to redraw the screen for
 * the updated area.
509
 * 
Havoc Pennington's avatar
Havoc Pennington committed
510
 * Return value: %TRUE if the frame we're on is partially loaded, or the last frame
511
 **/
Havoc Pennington's avatar
Havoc Pennington committed
512 513
gboolean
gdk_pixbuf_animation_iter_on_currently_loading_frame (GdkPixbufAnimationIter *iter)
514
{
Havoc Pennington's avatar
Havoc Pennington committed
515 516 517
        g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION_ITER (iter), FALSE);
        
        return GDK_PIXBUF_ANIMATION_ITER_GET_CLASS (iter)->on_currently_loading_frame (iter);
518 519 520
}

/**
Havoc Pennington's avatar
Havoc Pennington committed
521 522 523 524 525 526
 * gdk_pixbuf_animation_iter_advance:
 * @iter: a #GdkPixbufAnimationIter
 * @current_time: current time
 *
 * Possibly advances an animation to a new frame. Chooses the frame based
 * on the start time passed to gdk_pixbuf_animation_get_iter().
527
 * 
Havoc Pennington's avatar
Havoc Pennington committed
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
 * @current_time would normally come from g_get_current_time(), and
 * must be greater than or equal to the time passed to
 * gdk_pixbuf_animation_get_iter(), and must increase or remain
 * unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is
 * called. That is, you can't go backward in time; animations only
 * play forward.
 *
 * As a shortcut, pass %NULL for the current time and g_get_current_time()
 * will be invoked on your behalf. So you only need to explicitly pass
 * @current_time if you're doing something odd like playing the animation
 * at double speed.
 *
 * If this function returns %FALSE, there's no need to update the animation
 * display, assuming the display had been rendered prior to advancing;
 * if %TRUE, you need to call gdk_animation_iter_get_pixbuf() and update the
 * display with the new pixbuf.
 *
 * Returns: %TRUE if the image may need updating
546 547
 * 
 **/
Havoc Pennington's avatar
Havoc Pennington committed
548 549 550
gboolean
gdk_pixbuf_animation_iter_advance (GdkPixbufAnimationIter *iter,
                                   const GTimeVal         *current_time)
551
{
Havoc Pennington's avatar
Havoc Pennington committed
552 553 554
        GTimeVal val;
        
        g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION_ITER (iter), FALSE);
555

Havoc Pennington's avatar
Havoc Pennington committed
556 557 558 559 560 561
        if (current_time)
                val = *current_time;
        else
                g_get_current_time (&val);
        
        return GDK_PIXBUF_ANIMATION_ITER_GET_CLASS (iter)->advance (iter, &val);
562
}
563

Havoc Pennington's avatar
Havoc Pennington committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582


static void gdk_pixbuf_non_anim_class_init (GdkPixbufNonAnimClass *klass);
static void gdk_pixbuf_non_anim_finalize   (GObject        *object);

static gboolean                gdk_pixbuf_non_anim_is_static_image  (GdkPixbufAnimation *animation);
static GdkPixbuf*              gdk_pixbuf_non_anim_get_static_image (GdkPixbufAnimation *animation);
static void                    gdk_pixbuf_non_anim_get_size         (GdkPixbufAnimation *anim,
                                                                     int                *width,
                                                                     int                *height);
static GdkPixbufAnimationIter* gdk_pixbuf_non_anim_get_iter         (GdkPixbufAnimation *anim,
                                                                     const GTimeVal     *start_time);





static gpointer non_parent_class;

583
static GType
Havoc Pennington's avatar
Havoc Pennington committed
584
gdk_pixbuf_non_anim_get_type (void)
585
{
Havoc Pennington's avatar
Havoc Pennington committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
        static GType object_type = 0;

        if (!object_type) {
                static const GTypeInfo object_info = {
                        sizeof (GdkPixbufNonAnimClass),
                        (GBaseInitFunc) NULL,
                        (GBaseFinalizeFunc) NULL,
                        (GClassInitFunc) gdk_pixbuf_non_anim_class_init,
                        NULL,           /* class_finalize */
                        NULL,           /* class_data */
                        sizeof (GdkPixbufNonAnim),
                        0,              /* n_preallocs */
                        (GInstanceInitFunc) NULL,
                };
                
                object_type = g_type_register_static (GDK_TYPE_PIXBUF_ANIMATION,
                                                      "GdkPixbufNonAnim",
                                                      &object_info, 0);
        }
        
        return object_type;
607 608
}

Havoc Pennington's avatar
Havoc Pennington committed
609 610
static void
gdk_pixbuf_non_anim_class_init (GdkPixbufNonAnimClass *klass)
611
{
Havoc Pennington's avatar
Havoc Pennington committed
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
        GObjectClass *object_class = G_OBJECT_CLASS (klass);
        GdkPixbufAnimationClass *anim_class = GDK_PIXBUF_ANIMATION_CLASS (klass);
        
        non_parent_class = g_type_class_peek_parent (klass);
        
        object_class->finalize = gdk_pixbuf_non_anim_finalize;

        anim_class->is_static_image = gdk_pixbuf_non_anim_is_static_image;
        anim_class->get_static_image = gdk_pixbuf_non_anim_get_static_image;
        anim_class->get_size = gdk_pixbuf_non_anim_get_size;
        anim_class->get_iter = gdk_pixbuf_non_anim_get_iter;
}

static void
gdk_pixbuf_non_anim_finalize (GObject *object)
{
        GdkPixbufNonAnim *non_anim = GDK_PIXBUF_NON_ANIM (object);

        if (non_anim->pixbuf)
631
                g_object_unref (non_anim->pixbuf);
Havoc Pennington's avatar
Havoc Pennington committed
632 633 634 635 636
        
        G_OBJECT_CLASS (non_parent_class)->finalize (object);
}

GdkPixbufAnimation*
637
gdk_pixbuf_non_anim_new (GdkPixbuf *pixbuf)
Havoc Pennington's avatar
Havoc Pennington committed
638 639 640 641 642 643 644 645
{
        GdkPixbufNonAnim *non_anim;

        non_anim = g_object_new (GDK_TYPE_PIXBUF_NON_ANIM, NULL);

        non_anim->pixbuf = pixbuf;

        if (pixbuf)
646
                g_object_ref (pixbuf);
647

Havoc Pennington's avatar
Havoc Pennington committed
648
        return GDK_PIXBUF_ANIMATION (non_anim);
649 650
}

Havoc Pennington's avatar
Havoc Pennington committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
static gboolean
gdk_pixbuf_non_anim_is_static_image  (GdkPixbufAnimation *animation)
{

        return TRUE;
}

static GdkPixbuf*
gdk_pixbuf_non_anim_get_static_image (GdkPixbufAnimation *animation)
{
        GdkPixbufNonAnim *non_anim;

        non_anim = GDK_PIXBUF_NON_ANIM (animation);

        return non_anim->pixbuf;
}

static void
gdk_pixbuf_non_anim_get_size (GdkPixbufAnimation *anim,
                              int                *width,
                              int                *height)
{
        GdkPixbufNonAnim *non_anim;

        non_anim = GDK_PIXBUF_NON_ANIM (anim);

        if (width)
                *width = gdk_pixbuf_get_width (non_anim->pixbuf);

        if (height)
                *height = gdk_pixbuf_get_height (non_anim->pixbuf);
}


static GdkPixbufAnimationIter*
gdk_pixbuf_non_anim_get_iter (GdkPixbufAnimation *anim,
                              const GTimeVal     *start_time)
{
        GdkPixbufNonAnimIter *iter;

        iter = g_object_new (GDK_TYPE_PIXBUF_NON_ANIM_ITER, NULL);

        iter->non_anim = GDK_PIXBUF_NON_ANIM (anim);

695
        g_object_ref (iter->non_anim);
Havoc Pennington's avatar
Havoc Pennington committed
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
        
        return GDK_PIXBUF_ANIMATION_ITER (iter);
}



static void gdk_pixbuf_non_anim_iter_class_init (GdkPixbufNonAnimIterClass *klass);
static void gdk_pixbuf_non_anim_iter_finalize   (GObject                   *object);
static int        gdk_pixbuf_non_anim_iter_get_delay_time             (GdkPixbufAnimationIter *iter);
static GdkPixbuf* gdk_pixbuf_non_anim_iter_get_pixbuf                 (GdkPixbufAnimationIter *iter);
static gboolean   gdk_pixbuf_non_anim_iter_on_currently_loading_frame (GdkPixbufAnimationIter *iter);
static gboolean   gdk_pixbuf_non_anim_iter_advance                    (GdkPixbufAnimationIter *iter,
                                                                       const GTimeVal         *current_time);





static gpointer non_iter_parent_class;

716
GType
Havoc Pennington's avatar
Havoc Pennington committed
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
gdk_pixbuf_non_anim_iter_get_type (void)
{
        static GType object_type = 0;

        if (!object_type) {
                static const GTypeInfo object_info = {
                        sizeof (GdkPixbufNonAnimIterClass),
                        (GBaseInitFunc) NULL,
                        (GBaseFinalizeFunc) NULL,
                        (GClassInitFunc) gdk_pixbuf_non_anim_iter_class_init,
                        NULL,           /* class_finalize */
                        NULL,           /* class_data */
                        sizeof (GdkPixbufNonAnimIter),
                        0,              /* n_preallocs */
                        (GInstanceInitFunc) NULL,
                };
                
                object_type = g_type_register_static (GDK_TYPE_PIXBUF_ANIMATION_ITER,
                                                      "GdkPixbufNonAnimIter",
                                                      &object_info, 0);
        }
        
        return object_type;
}

static void
gdk_pixbuf_non_anim_iter_class_init (GdkPixbufNonAnimIterClass *klass)
{
        GObjectClass *object_class = G_OBJECT_CLASS (klass);
        GdkPixbufAnimationIterClass *anim_iter_class =
                GDK_PIXBUF_ANIMATION_ITER_CLASS (klass);
        
        non_iter_parent_class = g_type_class_peek_parent (klass);
        
        object_class->finalize = gdk_pixbuf_non_anim_iter_finalize;

        anim_iter_class->get_delay_time = gdk_pixbuf_non_anim_iter_get_delay_time;
        anim_iter_class->get_pixbuf = gdk_pixbuf_non_anim_iter_get_pixbuf;
        anim_iter_class->on_currently_loading_frame = gdk_pixbuf_non_anim_iter_on_currently_loading_frame;
        anim_iter_class->advance = gdk_pixbuf_non_anim_iter_advance;
}

static void
gdk_pixbuf_non_anim_iter_finalize (GObject *object)
761
{
Havoc Pennington's avatar
Havoc Pennington committed
762
        GdkPixbufNonAnimIter *iter = GDK_PIXBUF_NON_ANIM_ITER (object);
763

764
        g_object_unref (iter->non_anim);
Havoc Pennington's avatar
Havoc Pennington committed
765 766 767 768 769 770 771 772 773
        
        G_OBJECT_CLASS (non_iter_parent_class)->finalize (object);
}

static int
gdk_pixbuf_non_anim_iter_get_delay_time (GdkPixbufAnimationIter *iter)
{
        return -1; /* show only frame forever */
}
774

Havoc Pennington's avatar
Havoc Pennington committed
775 776 777 778
static GdkPixbuf*
gdk_pixbuf_non_anim_iter_get_pixbuf (GdkPixbufAnimationIter *iter)
{
        return GDK_PIXBUF_NON_ANIM_ITER (iter)->non_anim->pixbuf;
779
}
Havoc Pennington's avatar
Havoc Pennington committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796


static gboolean
gdk_pixbuf_non_anim_iter_on_currently_loading_frame (GdkPixbufAnimationIter *iter)
{
        return TRUE;
}
        
static gboolean
gdk_pixbuf_non_anim_iter_advance (GdkPixbufAnimationIter *iter,
                                  const GTimeVal         *current_time)
{

        /* Advancing never requires a refresh */
        return FALSE;
}