libpurple/image.h

   1 /* purple
   2  *
   3  * Purple is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
  20  */
  21
  22 #ifndef PURPLE_IMAGE_H
  23 #define PURPLE_IMAGE_H
  24
  25 /**
  26  * SECTION:image
  27  * @include:image.h
  28  * @section_id: libpurple-image
  29  * @short_description: implementation-independent image data container
  30  * @title: Images
  31  *
  32  * #PurpleImage object is a container for raw image data. It doesn't manipulate
  33  * image data, just stores it in its binary format - png, jpeg etc. Thus, it's
  34  * totally independent from the UI.
  35  *
  36  * This class also provides certain file-related features, like: friendly
  37  * filenames (not necessarily real filename for displaying); remote images
  38  * (which data is not yet loaded) or guessing file format from its header.
  39  */
  40
  41 #include <glib-object.h>
  42
  43 #define PURPLE_TYPE_IMAGE  purple_image_get_type()
  44
  45 struct _PurpleImageClass {
  46         GObjectClass parent_class;
  47
  48         void (*purple_reserved1)(void);
  49         void (*purple_reserved2)(void);
  50         void (*purple_reserved3)(void);
  51         void (*purple_reserved4)(void);
  52 };
  53
  54 G_BEGIN_DECLS
  55
  56 /**
  57  * purple_image_get_type:
  58  *
  59  * Returns: the #GType for an image.
  60  */
  61 G_DECLARE_DERIVABLE_TYPE(PurpleImage, purple_image, PURPLE, IMAGE, GObject)
  62
  63 /**
  64  * purple_image_new_from_bytes:
  65  * @bytes: (transfer none): A #GBytes containing the raw image data.
  66  *
  67  * Loads a raw image data as a new #PurpleImage object.
  68  *
  69  * Returns: the new #PurpleImage.
  70  */
  71 PurpleImage *purple_image_new_from_bytes(GBytes *bytes);
  72
  73 /**
  74  * purple_image_new_from_file:
  75  * @path: the path to the image file.
  76  * @error: (optional) (out): An optional return address for a #GError
  77  *
  78  * Loads an image file as a new #PurpleImage object. The @path must exists, be
  79  * readable and should point to a valid image file. If you don't set @be_eager
  80  * parameter, there will be a risk that file will be removed from disk before
  81  * you access its data.
  82  *
  83  * Returns: the new #PurpleImage.
  84  */
  85 PurpleImage *purple_image_new_from_file(const gchar *path, GError **error);
  86
  87 /**
  88  * purple_image_new_from_data:
  89  * @data: the pointer to the image data buffer.
  90  * @length: the length of @data.
  91  *
  92  * Creates a new #PurpleImage object with contents of @data buffer.
  93  *
  94  * The @data buffer is owned by #PurpleImage object, so you might want
  95  * to #g_memdup it first.
  96  *
  97  * Returns: the new #PurpleImage.
  98  */
  99 PurpleImage *purple_image_new_from_data(const guint8 *data, gsize length);
 100
 101 /**
 102  * purple_image_new_take_data:
 103  * @data: (transfer full): the pointer to the image data buffer.
 104  * @length: the length of @data.
 105  *
 106  * Creates a new #PurpleImage object with contents of @data buffer.
 107  *
 108  * The @data buffer is owned by #PurpleImage object, so you might want
 109  * to #g_memdup it first.
 110  *
 111  * Returns: the new #PurpleImage.
 112  */
 113 PurpleImage *purple_image_new_take_data(guint8 *data, gsize length);
 114
 115 /**
 116  * purple_image_save:
 117  * @image: the image.
 118  * @path: destination of a saved image file.
 119  *
 120  * Saves an @image to the disk.
 121  *
 122  * Returns: %TRUE if succeeded, %FALSE otherwise.
 123  */
 124 gboolean purple_image_save(PurpleImage *image, const gchar *path);
 125
 126 /**
 127  * purple_image_get_contents:
 128  * @image: The #PurpleImage.
 129  *
 130  * Returns a new reference to the #GBytes that contains the image data.
 131  *
 132  * Returns: (transfer full): A #GBytes containing the image data.
 133  */
 134 GBytes *purple_image_get_contents(PurpleImage *image);
 135
 136
 137 /**
 138  * purple_image_get_path:
 139  * @image: the image.
 140  *
 141  * Returns the physical path of the @image file. It is set only, if the @image is
 142  * really backed by an existing file. In the other case it returns %NULL.
 143  *
 144  * Returns: the physical path of the @image, or %NULL.
 145  */
 146 const gchar *purple_image_get_path(PurpleImage *image);
 147
 148 /**
 149  * purple_image_get_data_size:
 150  * @image: the image.
 151  *
 152  * Returns the size of @image's data.
 153  *
 154  * Returns: the size of data, or 0 in case of failure.
 155  */
 156 gsize purple_image_get_data_size(PurpleImage *image);
 157
 158 /**
 159  * purple_image_get_data:
 160  * @image: the image.
 161  *
 162  * Returns the pointer to the buffer containing image data.
 163  *
 164  * Returns: (transfer none): the @image data.
 165  */
 166 gconstpointer purple_image_get_data(PurpleImage *image);
 167
 168 /**
 169  * purple_image_get_extension:
 170  * @image: the image.
 171  *
 172  * Guesses the @image format based on its contents.
 173  *
 174  * Returns: (transfer none): the file extension suitable for @image format.
 175  */
 176 const gchar *purple_image_get_extension(PurpleImage *image);
 177
 178 /**
 179  * purple_image_get_mimetype:
 180  * @image: the image.
 181  *
 182  * Guesses the @image mime-type based on its contents.
 183  *
 184  * Returns: (transfer none): the mime-type suitable for @image format.
 185  */
 186 const gchar *purple_image_get_mimetype(PurpleImage *image);
 187
 188 /**
 189  * purple_image_generate_filename:
 190  * @image: the image.
 191  *
 192  * Calculates almost-unique filename by computing checksum from file contents
 193  * and appending a suitable extension. You should not assume the checksum
 194  * is SHA-1, because it may change in the future.
 195  *
 196  * Returns: (transfer none): the generated file name.
 197  */
 198 const gchar *purple_image_generate_filename(PurpleImage *image);
 199
 200 /**
 201  * purple_image_set_friendly_filename:
 202  * @image: the image.
 203  * @filename: the friendly filename.
 204  *
 205  * Sets the "friendly filename" for the @image. This don't have to be a real
 206  * name, because it's used for displaying or as a default file name when the
 207  * user wants to save the @image to the disk.
 208  *
 209  * The provided @filename may either be a full path, or contain
 210  * filesystem-unfriendly characters, because it will be reformatted.
 211  */
 212 void purple_image_set_friendly_filename(PurpleImage *image, const gchar *filename);
 213
 214 /**
 215  * purple_image_get_friendly_filename:
 216  * @image: the image.
 217  *
 218  * Returns the "friendly filename" for the @image, to be displayed or used as
 219  * a default name when saving a file to the disk.
 220  * See #purple_image_set_friendly_filename.
 221  *
 222  * If the friendly filename was not set, it will be generated with
 223  * #purple_image_generate_filename.
 224  *
 225  * Returns: (transfer none): the friendly filename.
 226  */
 227 const gchar *purple_image_get_friendly_filename(PurpleImage *image);
 228
 229 G_END_DECLS
 230
 231 #endif /* PURPLE_IMAGE_H */