procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-03 09:23:24 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions
gimp/plug-ins/common/file-gegl.c
Jehan ddcaa99264 app, libgimp*, pdb, plug-ins: review and enhance MR !1549. 
- Fix annotations for gimp_export_options_get_image() to make it
  actually introspectable with the GimpImage being both input and
  output. Even though the logic doesn't change much (the input image may
  be overriden or not), it doesn't matter for introspection because
  images are handled centrally by libgimp and therefore must not be
  freed. Actually deleting the image from the central list of images
  though remains a manual action depending on code logic, not some
  automatic action to be handled by binding engines.
- Add G_GNUC_WARN_UNUSED_RESULT to gimp_export_options_get_image()
  because ignoring the returned value is rarely a good idea (as you
  usually want to delete the image).
- Remove gimp_export_options_new(): we don't need this constructor
  because at this point, the best is to tell plug-in developers to just
  pass NULL everywhere. This leaves us free to create a more useful
  default constructor if needed, in the future. Main description for
  GimpExportOptions has also been updated to say this.
- Add a data_destroy callback for the user data passed in
  gimp_export_procedure_set_capabilities().
- Fixing annotations of 'export_options' object from pdb/pdb.pl: input
  args would actually be (nullable) and would not transfer ownership
  (calling code must still free the object). Return value's ownership on
  the other hand is fully transfered.
- Add C and Python unit testing for GimpExportOptions and
  gimp_export_options_get_image() in particular.
- Fix or improve various details.

Note that I have also considered for a long time changing the signature
of gimp_export_options_get_image() to return a boolean indicating
whether `image` had been replaced (hence needed deletion) or not. This
also meant getting rid of the GimpExportReturn enum. Right now it would
work because there are no third case, but I was considering the future
possibility that for instance we got some impossible conversion for some
future capability. I'm not sure it would ever happen; and for sure, this
is not desirable because it implies an export failure a bit late in the
workflow. But just in case, let's keep the enum return value. It does
not even make the using code that much more complicated (well just a
value comparison instead of a simple boolean test).
2024-08-18 22:46:47 +02:00

500 lines
15 KiB
C
Raw Permalink Blame History

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* file-gegl.c -- GEGL based file format plug-in
* Copyright (C) 2012 Simon Budig <simon@gimp.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <stdlib.h>
#include <errno.h>
#include <glib/gstdio.h>
#include <libgimp/gimp.h>
#include <libgimp/gimpui.h>
#include "libgimp/stdplugins-intl.h"
#define PLUG_IN_BINARY "file-gegl"
typedef struct _FileFormat FileFormat;
struct _FileFormat
{
const gchar *file_type;
const gchar *mime_type;
const gchar *extensions;
const gchar *magic;
const gchar *load_proc;
const gchar *load_blurb;
const gchar *load_help;
const gchar *load_op;
const gchar *export_proc;
const gchar *export_blurb;
const gchar *export_help;
const gchar *export_op;
};
typedef struct _Goat Goat;
typedef struct _GoatClass GoatClass;
struct _Goat
{
GimpPlugIn parent_instance;
};
struct _GoatClass
{
GimpPlugInClass parent_class;
};
#define GOAT_TYPE (goat_get_type ())
#define GOAT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GOAT_TYPE, Goat))
GType goat_get_type (void) G_GNUC_CONST;
static GList * goat_query_procedures (GimpPlugIn *plug_in);
static GimpProcedure * goat_create_procedure (GimpPlugIn *plug_in,
const gchar *name);
static GimpValueArray * goat_load (GimpProcedure *procedure,
GimpRunMode run_mode,
GFile *file,
GimpMetadata *metadata,
GimpMetadataLoadFlags *flags,
GimpProcedureConfig *config,
gpointer run_data);
static GimpValueArray * goat_export (GimpProcedure *procedure,
GimpRunMode run_mode,
GimpImage *image,
GFile *file,
GimpExportOptions *options,
GimpMetadata *metadata,
GimpProcedureConfig *config,
gpointer run_data);
static GimpImage * load_image (GFile *file,
const gchar *gegl_op,
GError **error);
static gboolean export_image (GFile *file,
const gchar *gegl_op,
GimpImage *image,
GimpDrawable *drawable,
GError **error);
G_DEFINE_TYPE (Goat, goat, GIMP_TYPE_PLUG_IN)
GIMP_MAIN (GOAT_TYPE)
DEFINE_STD_SET_I18N
static const FileFormat file_formats[] =
{
{
N_("Radiance RGBE"),
"image/vnd.radiance",
"hdr",
"0,string,#?",
"file-rgbe-load",
"Load files in the RGBE file format",
"This procedure loads images in the RGBE format, using gegl:rgbe-load",
"gegl:rgbe-load",
"file-rgbe-export",
"Saves files in the RGBE file format",
"This procedure exports images in the RGBE format, using gegl:rgbe-save",
"gegl:rgbe-save",
},
{
N_("OpenEXR image"),
"image/x-exr",
"exr",
"0,lelong,20000630",
/* no EXR loading (implemented in native GIMP plug-in) */
NULL, NULL, NULL, NULL,
"file-exr-export",
"Saves files in the OpenEXR file format",
"This procedure saves images in the OpenEXR format, using gegl:exr-save",
"gegl:exr-save"
}
};
static void
goat_class_init (GoatClass *klass)
{
GimpPlugInClass *plug_in_class = GIMP_PLUG_IN_CLASS (klass);
plug_in_class->query_procedures = goat_query_procedures;
plug_in_class->create_procedure = goat_create_procedure;
plug_in_class->set_i18n = STD_SET_I18N;
}
static void
goat_init (Goat *goat)
{
}
static GList *
goat_query_procedures (GimpPlugIn *plug_in)
{
GList *list = NULL;
gint i;
for (i = 0; i < G_N_ELEMENTS (file_formats); i++)
{
const FileFormat *format = &file_formats[i];
if (format->load_proc)
list = g_list_append (list, g_strdup (format->load_proc));
if (format->export_proc)
list = g_list_append (list, g_strdup (format->export_proc));
}
return list;
}
static GimpProcedure *
goat_create_procedure (GimpPlugIn *plug_in,
const gchar *name)
{
GimpProcedure *procedure = NULL;
gint i;
for (i = 0; i < G_N_ELEMENTS (file_formats); i++)
{
const FileFormat *format = &file_formats[i];
if (! g_strcmp0 (name, format->load_proc))
{
procedure = gimp_load_procedure_new (plug_in, name,
GIMP_PDB_PROC_TYPE_PLUGIN,
goat_load,
(gpointer) format, NULL);
gimp_procedure_set_menu_label (procedure, _(format->file_type));
gimp_procedure_set_documentation (procedure,
format->load_blurb,
format->load_help,
name);
gimp_file_procedure_set_mime_types (GIMP_FILE_PROCEDURE (procedure),
format->mime_type);
gimp_file_procedure_set_extensions (GIMP_FILE_PROCEDURE (procedure),
format->extensions);
gimp_file_procedure_set_magics (GIMP_FILE_PROCEDURE (procedure),
format->magic);
}
else if (! g_strcmp0 (name, format->export_proc))
{
procedure = gimp_export_procedure_new (plug_in, name,
GIMP_PDB_PROC_TYPE_PLUGIN,
FALSE, goat_export,
(gpointer) format, NULL);
gimp_procedure_set_image_types (procedure, "*");
gimp_procedure_set_menu_label (procedure, _(format->file_type));
gimp_procedure_set_documentation (procedure,
format->export_blurb,
format->export_help,
name);
gimp_file_procedure_set_mime_types (GIMP_FILE_PROCEDURE (procedure),
format->mime_type);
gimp_file_procedure_set_extensions (GIMP_FILE_PROCEDURE (procedure),
format->extensions);
gimp_export_procedure_set_capabilities (GIMP_EXPORT_PROCEDURE (procedure),
GIMP_EXPORT_CAN_HANDLE_RGB |
GIMP_EXPORT_CAN_HANDLE_GRAY |
GIMP_EXPORT_CAN_HANDLE_INDEXED |
GIMP_EXPORT_CAN_HANDLE_ALPHA,
NULL, NULL, NULL);
}
}
return procedure;
}
static GimpValueArray *
goat_load (GimpProcedure *procedure,
GimpRunMode run_mode,
GFile *file,
GimpMetadata *metadata,
GimpMetadataLoadFlags *flags,
GimpProcedureConfig *config,
gpointer run_data)
{
const FileFormat *format = run_data;
GimpValueArray *return_vals;
GimpImage *image;
GError *error = NULL;
gegl_init (NULL, NULL);
image = load_image (file, format->load_op, &error);
if (! image)
return gimp_procedure_new_return_values (procedure,
GIMP_PDB_EXECUTION_ERROR,
error);
return_vals = gimp_procedure_new_return_values (procedure,
GIMP_PDB_SUCCESS,
NULL);
GIMP_VALUES_SET_IMAGE (return_vals, 1, image);
return return_vals;
}
static GimpValueArray *
goat_export (GimpProcedure *procedure,
GimpRunMode run_mode,
GimpImage *image,
GFile *file,
GimpExportOptions *options,
GimpMetadata *metadata,
GimpProcedureConfig *config,
gpointer run_data)
{
const FileFormat *format = run_data;
GimpPDBStatusType status = GIMP_PDB_SUCCESS;
GimpExportReturn export = GIMP_EXPORT_IGNORE;
GList *drawables;
GError *error = NULL;
gegl_init (NULL, NULL);
export = gimp_export_options_get_image (options, &image);
drawables = gimp_image_list_layers (image);
if (! export_image (file, format->export_op, image, drawables->data,
&error))
{
status = GIMP_PDB_EXECUTION_ERROR;
}
if (export == GIMP_EXPORT_EXPORT)
gimp_image_delete (image);
g_list_free (drawables);
return gimp_procedure_new_return_values (procedure, status, error);
}
static GimpImage *
load_image (GFile *file,
const gchar *gegl_op,
GError **error)
{
GimpImage *image;
GimpLayer *layer;
GimpImageType image_type;
GimpImageBaseType base_type;
GimpPrecision precision;
gint width;
gint height;
GeglNode *graph;
GeglNode *sink;
GeglNode *source;
GeglBuffer *src_buf = NULL;
GeglBuffer *dest_buf = NULL;
const Babl *format;
gimp_progress_init_printf (_("Opening '%s'"),
gimp_file_get_utf8_name (file));
graph = gegl_node_new ();
source = gegl_node_new_child (graph,
"operation", gegl_op,
"path", g_file_peek_path (file),
NULL);
sink = gegl_node_new_child (graph,
"operation", "gegl:buffer-sink",
"buffer", &src_buf,
NULL);
gegl_node_link (source, sink);
gegl_node_process (sink);
g_object_unref (graph);
if (! src_buf)
{
g_set_error (error, G_FILE_ERROR, G_FILE_ERROR_FAILED,
_("Could not open '%s'"),
gimp_file_get_utf8_name (file));
return NULL;
}
gimp_progress_update (0.33);
width = gegl_buffer_get_width (src_buf);
height = gegl_buffer_get_height (src_buf);
format = gegl_buffer_get_format (src_buf);
if (babl_format_is_palette (format))
{
base_type = GIMP_INDEXED;
if (babl_format_has_alpha (format))
image_type = GIMP_INDEXEDA_IMAGE;
else
image_type = GIMP_INDEXED_IMAGE;
precision = GIMP_PRECISION_U8_NON_LINEAR;
}
else
{
const Babl *model = babl_format_get_model (format);
const Babl *type = babl_format_get_type (format, 0);
gboolean linear = TRUE;
if (model == babl_model ("Y") ||
model == babl_model ("Y'") ||
model == babl_model ("YA") ||
model == babl_model ("Y'A"))
{
base_type = GIMP_GRAY;
if (babl_format_has_alpha (format))
image_type = GIMP_GRAYA_IMAGE;
else
image_type = GIMP_GRAY_IMAGE;
if (model == babl_model ("Y'") ||
model == babl_model ("Y'A"))
linear = FALSE;
}
else
{
base_type = GIMP_RGB;
if (babl_format_has_alpha (format))
image_type = GIMP_RGBA_IMAGE;
else
image_type = GIMP_RGB_IMAGE;
if (model == babl_model ("R'G'B'") ||
model == babl_model ("R'G'B'A"))
linear = FALSE;
}
if (linear)
{
if (type == babl_type ("u8"))
precision = GIMP_PRECISION_U8_LINEAR;
else if (type == babl_type ("u16"))
precision = GIMP_PRECISION_U16_LINEAR;
else if (type == babl_type ("u32"))
precision = GIMP_PRECISION_U32_LINEAR;
else if (type == babl_type ("half"))
precision = GIMP_PRECISION_HALF_LINEAR;
else
precision = GIMP_PRECISION_FLOAT_LINEAR;
}
else
{
if (type == babl_type ("u8"))
precision = GIMP_PRECISION_U8_NON_LINEAR;
else if (type == babl_type ("u16"))
precision = GIMP_PRECISION_U16_NON_LINEAR;
else if (type == babl_type ("u32"))
precision = GIMP_PRECISION_U32_NON_LINEAR;
else if (type == babl_type ("half"))
precision = GIMP_PRECISION_HALF_NON_LINEAR;
else
precision = GIMP_PRECISION_FLOAT_NON_LINEAR;
}
}
image = gimp_image_new_with_precision (width, height,
base_type, precision);
layer = gimp_layer_new (image,
_("Background"),
width, height,
image_type,
100,
gimp_image_get_default_new_layer_mode (image));
gimp_image_insert_layer (image, layer, NULL, 0);
dest_buf = gimp_drawable_get_buffer (GIMP_DRAWABLE (layer));
gimp_progress_update (0.66);
gegl_buffer_copy (src_buf, NULL, GEGL_ABYSS_NONE, dest_buf, NULL);
g_object_unref (src_buf);
g_object_unref (dest_buf);
gimp_progress_update (1.0);
return image;
}
static gboolean
export_image (GFile *file,
const gchar *gegl_op,
GimpImage *image,
GimpDrawable *drawable,
GError **error)
{
GeglNode *graph;
GeglNode *source;
GeglNode *sink;
GeglBuffer *src_buf;
src_buf = gimp_drawable_get_buffer (drawable);
graph = gegl_node_new ();
source = gegl_node_new_child (graph,
"operation", "gegl:buffer-source",
"buffer", src_buf,
NULL);
sink = gegl_node_new_child (graph,
"operation", gegl_op,
"path", g_file_peek_path (file),
NULL);
gegl_node_link (source, sink);
gegl_node_process (sink);
g_object_unref (graph);
g_object_unref (src_buf);
return TRUE;
}
Reference in a new issue View git blame Copy permalink