/* GdkPixbuf library - Main loading interface. * * Copyright (C) 1999 The Free Software Foundation * * Authors: Miguel de Icaza * Federico Mena-Quintero * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser 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 * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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 #include #include #include #include "gdk-pixbuf-private.h" #include "gdk-pixbuf-io.h" #ifdef G_OS_WIN32 #define STRICT #include #endif static gboolean pixbuf_check_png (guchar *buffer, int size) { if (size < 28) return FALSE; if (buffer [0] != 0x89 || buffer [1] != 'P' || buffer [2] != 'N' || buffer [3] != 'G' || buffer [4] != 0x0d || buffer [5] != 0x0a || buffer [6] != 0x1a || buffer [7] != 0x0a) return FALSE; return TRUE; } static gboolean pixbuf_check_jpeg (guchar *buffer, int size) { if (size < 10) return FALSE; if (buffer [0] != 0xff || buffer [1] != 0xd8) return FALSE; return TRUE; } static gboolean pixbuf_check_tiff (guchar *buffer, int size) { if (size < 10) return FALSE; if (buffer [0] == 'M' && buffer [1] == 'M' && buffer [2] == 0 && buffer [3] == 0x2a) return TRUE; if (buffer [0] == 'I' && buffer [1] == 'I' && buffer [2] == 0x2a && buffer [3] == 0) return TRUE; return FALSE; } static gboolean pixbuf_check_gif (guchar *buffer, int size) { if (size < 20) return FALSE; if (strncmp (buffer, "GIF8", 4) == 0) return TRUE; return FALSE; } static gboolean pixbuf_check_xpm (guchar *buffer, int size) { if (size < 20) return FALSE; if (strncmp (buffer, "/* XPM */", 9) == 0) return TRUE; return FALSE; } static gboolean pixbuf_check_pnm (guchar *buffer, int size) { if (size < 20) return FALSE; if (buffer [0] == 'P') { if (buffer [1] == '1' || buffer [1] == '2' || buffer [1] == '3' || buffer [1] == '4' || buffer [1] == '5' || buffer [1] == '6') return TRUE; } return FALSE; } static gboolean pixbuf_check_sunras (guchar *buffer, int size) { if (size < 32) return FALSE; if (buffer [0] != 0x59 || buffer [1] != 0xA6 || buffer [2] != 0x6A || buffer [3] != 0x95) return FALSE; return TRUE; } static gboolean pixbuf_check_ico (guchar *buffer, int size) { /* Note that this may cause false positives, but .ico's don't have a magic number.*/ if (size < 6) return FALSE; if (buffer [0] != 0x0 || buffer [1] != 0x0 || ((buffer [2] != 0x1)&&(buffer[2]!=0x2)) || buffer [3] != 0x0 || buffer [5] != 0x0 ) return FALSE; return TRUE; } static gboolean pixbuf_check_bmp (guchar *buffer, int size) { if (size < 20) return FALSE; if (buffer [0] != 'B' || buffer [1] != 'M') return FALSE; return TRUE; } static gboolean pixbuf_check_wbmp (guchar *buffer, int size) { if(size < 10) /* at least */ return FALSE; if(buffer[0] == '\0' /* We only handle type 0 wbmp's for now */) return TRUE; return FALSE; } static GdkPixbufModule file_formats [] = { { "png", pixbuf_check_png, NULL, NULL, NULL, NULL, NULL, NULL, NULL, }, { "jpeg", pixbuf_check_jpeg, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { "tiff", pixbuf_check_tiff, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { "gif", pixbuf_check_gif, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, #define XPM_FILE_FORMAT_INDEX 4 { "xpm", pixbuf_check_xpm, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { "pnm", pixbuf_check_pnm, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { "ras", pixbuf_check_sunras, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { "ico", pixbuf_check_ico, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { "bmp", pixbuf_check_bmp, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { "wbmp", pixbuf_check_wbmp, NULL, NULL, NULL, NULL, NULL, NULL, NULL }, { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL } }; #ifdef USE_GMODULE static gboolean pixbuf_module_symbol (GModule *module, const char *module_name, const char *symbol_name, gpointer *symbol) { char *full_symbol_name = g_strconcat ("gdk_pixbuf__", module_name, "_", symbol_name, NULL); gboolean return_value; return_value = g_module_symbol (module, full_symbol_name, symbol); g_free (full_symbol_name); return return_value; } #ifdef G_OS_WIN32 /* What would be the right place for this function? Also * gtk needs this function (to find the gtkrc and themes). * But it seems stupid for the gdk-pixbuf DLL to depend * on the gtk DLL. Should it be in the gdk DLL? Or should we * have a small static library at the top gtk+ level? */ static gchar * gtk_win32_get_installation_directory (void) { static gboolean been_here = FALSE; static gchar gtk_installation_dir[200]; gchar win_dir[100]; HKEY reg_key = NULL; DWORD type; DWORD nbytes = sizeof (gtk_installation_dir); if (been_here) return gtk_installation_dir; been_here = TRUE; if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, "Software\\GNU\\GTk+", 0, KEY_QUERY_VALUE, ®_key) != ERROR_SUCCESS || RegQueryValueEx (reg_key, "InstallationDirectory", 0, &type, gtk_installation_dir, &nbytes) != ERROR_SUCCESS || type != REG_SZ) { /* Uh oh. Use hard-coded %WinDir%\gtk+ value */ GetWindowsDirectory (win_dir, sizeof (win_dir)); sprintf (gtk_installation_dir, "%s\\gtk+", win_dir); } if (reg_key != NULL) RegCloseKey (reg_key); return gtk_installation_dir; } static char * get_libdir (void) { static char *libdir = NULL; if (libdir == NULL) libdir = g_strdup_printf (gtk_win32_get_installation_directory (), G_DIR_SEPARATOR_S, "loaders", NULL); return libdir; } #define PIXBUF_LIBDIR get_libdir () #endif /* actually load the image handler - gdk_pixbuf_get_module only get a */ /* reference to the module to load, it doesn't actually load it */ /* perhaps these actions should be combined in one function */ gboolean gdk_pixbuf_load_module (GdkPixbufModule *image_module, GError **error) { char *module_name; char *path; GModule *module; gpointer load_sym; gpointer save_sym; char *name; g_return_val_if_fail (image_module->module == NULL, FALSE); name = image_module->module_name; module_name = g_strconcat ("pixbufloader-", name, NULL); path = g_module_build_path (PIXBUF_LIBDIR, module_name); module = g_module_open (path, G_MODULE_BIND_LAZY); if (!module) { /* Debug feature, check in GDK_PIXBUF_MODULEDIR, or working directory */ char *dir = g_getenv ("GDK_PIXBUF_MODULEDIR"); if (!dir) dir = ""; g_free (path); path = g_module_build_path (dir, module_name); module = g_module_open (path, G_MODULE_BIND_LAZY); if (!module) { g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_FAILED, _("Unable to load image-loading module: %s: %s"), path, g_module_error ()); g_free (module_name); g_free (path); return FALSE; } g_free (path); } else { g_free (path); } g_free (module_name); image_module->module = module; if (pixbuf_module_symbol (module, name, "image_load", &load_sym)) image_module->load = load_sym; if (pixbuf_module_symbol (module, name, "image_load_xpm_data", &load_sym)) image_module->load_xpm_data = load_sym; if (pixbuf_module_symbol (module, name, "image_begin_load", &load_sym)) image_module->begin_load = load_sym; if (pixbuf_module_symbol (module, name, "image_stop_load", &load_sym)) image_module->stop_load = load_sym; if (pixbuf_module_symbol (module, name, "image_load_increment", &load_sym)) image_module->load_increment = load_sym; if (pixbuf_module_symbol (module, name, "image_load_animation", &load_sym)) image_module->load_animation = load_sym; if (pixbuf_module_symbol (module, name, "image_save", &save_sym)) image_module->save = save_sym; return TRUE; } #else #define mname(type,fn) gdk_pixbuf__ ## type ## _image_ ##fn #define m_load(type) extern GdkPixbuf * mname(type,load) (FILE *f, GError **error); #define m_load_xpm_data(type) extern GdkPixbuf * mname(type,load_xpm_data) (const char **data); #define m_begin_load(type) \ extern gpointer mname(type,begin_load) (ModulePreparedNotifyFunc prepare_func, \ ModuleUpdatedNotifyFunc update_func, \ ModuleFrameDoneNotifyFunc frame_done_func,\ ModuleAnimationDoneNotifyFunc anim_done_func,\ gpointer user_data,\ GError **error); #define m_stop_load(type) extern void mname(type,stop_load) (gpointer context); #define m_load_increment(type) extern gboolean mname(type,load_increment) (gpointer context, const guchar *buf, guint size, GError **error); #define m_load_animation(type) extern GdkPixbufAnimation * mname(type,load_animation) (FILE *f, GError **error); #define m_save(type) \ extern gboolean mname(type,save) (FILE *f, \ GdkPixbuf *pixbuf, \ gchar **keys, \ gchar **values, \ GError **error); /* PNG */ m_load (png); m_begin_load (png); m_load_increment (png); m_stop_load (png); m_save (png); /* BMP */ m_load (bmp); m_begin_load (bmp); m_load_increment (bmp); m_stop_load (bmp); /* WBMP */ m_load (wbmp); m_begin_load (wbmp); m_load_increment (wbmp); m_stop_load (wbmp); /* GIF */ m_load (gif); m_begin_load (gif); m_load_increment (gif); m_stop_load (gif); m_load_animation (gif); /* ICO */ m_load (ico); m_begin_load (ico); m_load_increment (ico); m_stop_load (ico); /* JPEG */ m_load (jpeg); m_begin_load (jpeg); m_load_increment (jpeg); m_stop_load (jpeg); m_save (jpeg); /* PNM */ m_load (pnm); m_begin_load (pnm); m_load_increment (pnm); m_stop_load (pnm); /* RAS */ m_load (ras); m_begin_load (ras); m_load_increment (ras); m_stop_load (ras); /* TIFF */ m_load (tiff); m_begin_load (tiff); m_load_increment (tiff); m_stop_load (tiff); /* XPM */ m_load (xpm); m_load_xpm_data (xpm); gboolean gdk_pixbuf_load_module (GdkPixbufModule *image_module, GError **error) { image_module->module = (void *) 1; #ifdef INCLUDE_png if (strcmp (image_module->module_name, "png") == 0){ image_module->load = mname (png,load); image_module->begin_load = mname (png,begin_load); image_module->load_increment = mname (png,load_increment); image_module->stop_load = mname (png,stop_load); image_module->save = mname (png,save); return TRUE; } #endif #ifdef INCLUDE_bmp if (strcmp (image_module->module_name, "bmp") == 0){ image_module->load = mname (bmp,load); image_module->begin_load = mname (bmp,begin_load); image_module->load_increment = mname (bmp,load_increment); image_module->stop_load = mname (bmp,stop_load); return TRUE; } #endif #ifdef INCLUDE_wbmp if (strcmp (image_module->module_name, "wbmp") == 0){ image_module->load = mname (wbmp,load); image_module->begin_load = mname (wbmp,begin_load); image_module->load_increment = mname (wbmp,load_increment); image_module->stop_load = mname (wbmp,stop_load); return TRUE; } #endif #ifdef INCLUDE_gif if (strcmp (image_module->module_name, "gif") == 0){ image_module->load = mname (gif,load); image_module->begin_load = mname (gif,begin_load); image_module->load_increment = mname (gif,load_increment); image_module->stop_load = mname (gif,stop_load); image_module->load_animation = mname (gif,load_animation); return TRUE; } #endif #ifdef INCLUDE_ico if (strcmp (image_module->module_name, "ico") == 0){ image_module->load = mname (ico,load); image_module->begin_load = mname (ico,begin_load); image_module->load_increment = mname (ico,load_increment); image_module->stop_load = mname (ico,stop_load); return TRUE; } #endif #ifdef INCLUDE_jpeg if (strcmp (image_module->module_name, "jpeg") == 0){ image_module->load = mname (jpeg,load); image_module->begin_load = mname (jpeg,begin_load); image_module->load_increment = mname (jpeg,load_increment); image_module->stop_load = mname (jpeg,stop_load); image_module->save = mname (jpeg,save); return TRUE; } #endif #ifdef INCLUDE_pnm if (strcmp (image_module->module_name, "pnm") == 0){ image_module->load = mname (pnm,load); image_module->begin_load = mname (pnm,begin_load); image_module->load_increment = mname (pnm,load_increment); image_module->stop_load = mname (pnm,stop_load); return TRUE; } #endif #ifdef INCLUDE_ras if (strcmp (image_module->module_name, "ras") == 0){ image_module->load = mname (ras,load); image_module->begin_load = mname (ras,begin_load); image_module->load_increment = mname (ras,load_increment); image_module->stop_load = mname (ras,stop_load); return TRUE; } #endif #ifdef INCLUDE_tiff if (strcmp (image_module->module_name, "tiff") == 0){ image_module->load = mname (tiff,load); image_module->begin_load = mname (tiff,begin_load); image_module->load_increment = mname (tiff,load_increment); image_module->stop_load = mname (tiff,stop_load); return TRUE; } #endif #ifdef INCLUDE_xpm if (strcmp (image_module->module_name, "xpm") == 0){ image_module->load = mname (xpm,load); image_module->load_xpm_data = mname (xpm,load_xpm_data); return TRUE; } #endif g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_UNKNOWN_TYPE, _("Image type '%s' is not supported"), image_module->module_name); return FALSE; } #endif GdkPixbufModule * gdk_pixbuf_get_named_module (const char *name, GError **error) { int i; for (i = 0; file_formats [i].module_name; i++) { if (!strcmp(name, file_formats[i].module_name)) return &(file_formats[i]); } g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_UNKNOWN_TYPE, _("Image type '%s' is not supported"), name); return NULL; } GdkPixbufModule * gdk_pixbuf_get_module (guchar *buffer, guint size, const gchar *filename, GError **error) { int i; for (i = 0; file_formats [i].module_name; i++) { if ((* file_formats [i].format_check) (buffer, size)) return &(file_formats[i]); } if (filename) g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_UNKNOWN_TYPE, _("Couldn't recognize the image file format for file '%s'"), filename); else g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_UNKNOWN_TYPE, _("Unrecognized image file format")); return NULL; } /** * gdk_pixbuf_new_from_file: * @filename: Name of file to load. * @error: Return location for an error * * Creates a new pixbuf by loading an image from a file. The file format is * detected automatically. If NULL is returned, then @error will be set. * Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains. * * Return value: A newly-created pixbuf with a reference count of 1, or NULL if * any of several error conditions occurred: 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. **/ GdkPixbuf * gdk_pixbuf_new_from_file (const char *filename, GError **error) { GdkPixbuf *pixbuf; int size; FILE *f; guchar buffer [128]; GdkPixbufModule *image_module; g_return_val_if_fail (filename != NULL, NULL); f = fopen (filename, "rb"); if (!f) { g_set_error (error, G_FILE_ERROR, g_file_error_from_errno (errno), _("Failed to open file '%s': %s"), filename, g_strerror (errno)); return NULL; } size = fread (&buffer, 1, sizeof (buffer), f); if (size == 0) { g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_CORRUPT_IMAGE, _("Image file '%s' contains no data"), filename); fclose (f); return NULL; } image_module = gdk_pixbuf_get_module (buffer, size, filename, error); if (image_module == NULL) { fclose (f); return NULL; } if (image_module->module == NULL) if (!gdk_pixbuf_load_module (image_module, error)) { fclose (f); return NULL; } if (image_module->load == NULL) { g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION, _("Don't know how to load the image in file '%s'"), filename); fclose (f); return NULL; } fseek (f, 0, SEEK_SET); pixbuf = (* image_module->load) (f, error); fclose (f); 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"), filename); } else if (error != NULL && *error != NULL) { /* Add the filename to the error message */ GError *e = *error; gchar *old; old = e->message; e->message = g_strdup_printf (_("Failed to load image '%s': %s"), filename, old); g_free (old); } return pixbuf; } /** * gdk_pixbuf_new_from_xpm_data: * @data: Pointer to inline XPM data. * * Creates a new pixbuf by parsing XPM data in memory. This data is commonly * the result of including an XPM file into a program's C source. * * Return value: A newly-created pixbuf with a reference count of 1. **/ GdkPixbuf * gdk_pixbuf_new_from_xpm_data (const char **data) { GdkPixbuf *(* load_xpm_data) (const char **data); GdkPixbuf *pixbuf; if (file_formats[XPM_FILE_FORMAT_INDEX].module == NULL) gdk_pixbuf_load_module (&file_formats[XPM_FILE_FORMAT_INDEX], NULL); if (file_formats[XPM_FILE_FORMAT_INDEX].module == NULL) { g_warning ("Can't find gdk-pixbuf module for parsing inline XPM data"); return NULL; } else if (file_formats[XPM_FILE_FORMAT_INDEX].load_xpm_data == NULL) { g_warning ("gdk-pixbuf XPM module lacks XPM data capability"); return NULL; } else load_xpm_data = file_formats[XPM_FILE_FORMAT_INDEX].load_xpm_data; pixbuf = (* load_xpm_data) (data); return pixbuf; } static void collect_save_options (va_list opts, gchar ***keys, gchar ***vals) { gchar *key; gchar *val; gchar *next; gint count; count = 0; *keys = NULL; *vals = NULL; next = va_arg (opts, gchar*); while (next) { key = next; val = va_arg (opts, gchar*); ++count; /* woo, slow */ *keys = g_realloc (*keys, sizeof(gchar*) * (count + 1)); *vals = g_realloc (*vals, sizeof(gchar*) * (count + 1)); (*keys)[count-1] = g_strdup (key); (*vals)[count-1] = g_strdup (val); (*keys)[count] = NULL; (*vals)[count] = NULL; next = va_arg (opts, gchar*); } } static gboolean gdk_pixbuf_real_save (GdkPixbuf *pixbuf, FILE *filehandle, const char *type, gchar **keys, gchar **values, GError **error) { GdkPixbufModule *image_module = NULL; image_module = gdk_pixbuf_get_named_module (type, error); if (image_module == NULL) return FALSE; if (image_module->module == NULL) if (!gdk_pixbuf_load_module (image_module, error)) return FALSE; if (image_module->save == NULL) { g_set_error (error, GDK_PIXBUF_ERROR, GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION, _("This build of gdk-pixbuf does not support saving the image format: %s"), type); return FALSE; } return (* image_module->save) (filehandle, pixbuf, keys, values, error); } /** * gdk_pixbuf_save: * @pixbuf: pointer to GdkPixbuf. * @filename: Name of file to save. * @type: name of file format. * @error: return location for error, or NULL * @Varargs: list of key-value save options * * Saves pixbuf to a file in @type, which is currently "jpeg" or * "png". If @error is set, FALSE will be returned. Possible errors include those * in the #GDK_PIXBUF_ERROR domain and those in the #G_FILE_ERROR domain. * * The variable argument list should be NULL-terminated; if not empty, * it should contain pairs of strings that modify the save * parameters. For example: * * * gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, * "quality", "100", NULL); * * * The only save parameter that currently exists is the "quality" field * for JPEG images; its value should be in the range [0,100]. * * Return value: whether an error was set **/ gboolean gdk_pixbuf_save (GdkPixbuf *pixbuf, const char *filename, const char *type, GError **error, ...) { gchar **keys = NULL; gchar **values = NULL; va_list args; gboolean result; va_start (args, error); collect_save_options (args, &keys, &values); va_end (args); result = gdk_pixbuf_savev (pixbuf, filename, type, keys, values, error); g_strfreev (keys); g_strfreev (values); return result; } /** * gdk_pixbuf_savev: * @pixbuf: pointer to GdkPixbuf. * @filename: Name of file to save. * @type: name of file format. * @option_keys: name of options to set, NULL-terminated * @option_values: values for named options * @error: return location for error, or NULL * * Saves pixbuf to a file in @type, which is currently "jpeg" or "png". * If @error is set, FALSE will be returned. See gdk_pixbuf_save () for more * details. * * Return value: whether an error was set **/ gboolean gdk_pixbuf_savev (GdkPixbuf *pixbuf, const char *filename, const char *type, char **option_keys, char **option_values, GError **error) { FILE *f = NULL; gboolean result; g_return_val_if_fail (filename != NULL, FALSE); g_return_val_if_fail (type != NULL, FALSE); f = fopen (filename, "wb"); if (f == NULL) { g_set_error (error, G_FILE_ERROR, g_file_error_from_errno (errno), _("Failed to open '%s' for writing: %s"), filename, g_strerror (errno)); return FALSE; } result = gdk_pixbuf_real_save (pixbuf, f, type, option_keys, option_values, error); if (!result) { g_return_val_if_fail (error == NULL || *error != NULL, FALSE); fclose (f); return FALSE; } if (fclose (f) < 0) { g_set_error (error, G_FILE_ERROR, g_file_error_from_errno (errno), _("Failed to close '%s' while writing image, all data may not have been saved: %s"), filename, g_strerror (errno)); return FALSE; } return TRUE; }