[gimp] app: add gimp:buffer-source-validate operation



commit dec2375a26f1a0b80de767d97301018e2bba65f2
Author: Ell <ell_se yahoo com>
Date:   Mon Dec 4 15:13:48 2017 -0500

    app: add gimp:buffer-source-validate operation
    
    gimp:buffer-source-validate is a drop-in replacement for
    gegl:buffer-source, however, if the attached buffer has a
    validating tile-handler, it makes sure the required region is
    validated during process().  This avoids a situation in which
    validation happens in different worker threads at the same time
    during the processing of a succeeding operation; since validation
    is protected by the buffer's tile-storage mutex, this can result in
    either a deadlock (currently), or an effective fallback to single-
    threaded processing.

 app/gegl/gimptilehandlervalidate.c                 |   13 +
 app/gegl/gimptilehandlervalidate.h                 |   17 +-
 app/operations/Makefile.am                         |    2 +
 app/operations/gimp-operations.c                   |    2 +
 app/operations/gimpoperationbuffersourcevalidate.c |  359 ++++++++++++++++++++
 app/operations/gimpoperationbuffersourcevalidate.h |   52 +++
 6 files changed, 437 insertions(+), 8 deletions(-)
---
diff --git a/app/gegl/gimptilehandlervalidate.c b/app/gegl/gimptilehandlervalidate.c
index c7feab1..f62a6ad 100644
--- a/app/gegl/gimptilehandlervalidate.c
+++ b/app/gegl/gimptilehandlervalidate.c
@@ -349,6 +349,7 @@ gimp_tile_handler_validate_assign (GimpTileHandlerValidate *validate,
 {
   g_return_if_fail (GIMP_IS_TILE_HANDLER_VALIDATE (validate));
   g_return_if_fail (GEGL_IS_BUFFER (buffer));
+  g_return_if_fail (gimp_tile_handler_validate_get_assigned (buffer) == NULL);
 
   gegl_buffer_add_handler (buffer, validate);
 
@@ -357,6 +358,18 @@ gimp_tile_handler_validate_assign (GimpTileHandlerValidate *validate,
                 "tile-width",  &validate->tile_width,
                 "tile-height", &validate->tile_height,
                 NULL);
+
+  g_object_set_data (G_OBJECT (buffer),
+                     "gimp-tile-handler-validate", validate);
+}
+
+GimpTileHandlerValidate *
+gimp_tile_handler_validate_get_assigned (GeglBuffer *buffer)
+{
+  g_return_val_if_fail (GEGL_IS_BUFFER (buffer), NULL);
+
+  return g_object_get_data (G_OBJECT (buffer),
+                            "gimp-tile-handler-validate");
 }
 
 void
diff --git a/app/gegl/gimptilehandlervalidate.h b/app/gegl/gimptilehandlervalidate.h
index 5e2bda8..fa3f00d 100644
--- a/app/gegl/gimptilehandlervalidate.h
+++ b/app/gegl/gimptilehandlervalidate.h
@@ -63,17 +63,18 @@ struct _GimpTileHandlerValidateClass
 };
 
 
-GType             gimp_tile_handler_validate_get_type   (void) G_GNUC_CONST;
+GType                     gimp_tile_handler_validate_get_type        (void) G_GNUC_CONST;
 
-GeglTileHandler * gimp_tile_handler_validate_new        (GeglNode                *graph);
+GeglTileHandler         * gimp_tile_handler_validate_new             (GeglNode                *graph);
 
-void              gimp_tile_handler_validate_assign     (GimpTileHandlerValidate *validate,
-                                                         GeglBuffer                *buffer);
+void                      gimp_tile_handler_validate_assign          (GimpTileHandlerValidate *validate,
+                                                                      GeglBuffer              *buffer);
+GimpTileHandlerValidate * gimp_tile_handler_validate_get_assigned    (GeglBuffer              *buffer);
 
-void              gimp_tile_handler_validate_invalidate (GimpTileHandlerValidate *validate,
-                                                         const GeglRectangle     *rect);
-void         gimp_tile_handler_validate_undo_invalidate (GimpTileHandlerValidate *validate,
-                                                         const GeglRectangle     *rect);
+void                      gimp_tile_handler_validate_invalidate      (GimpTileHandlerValidate *validate,
+                                                                      const GeglRectangle     *rect);
+void                      gimp_tile_handler_validate_undo_invalidate (GimpTileHandlerValidate *validate,
+                                                                      const GeglRectangle     *rect);
 
 
 G_END_DECLS
diff --git a/app/operations/Makefile.am b/app/operations/Makefile.am
index 5c4ed02..643ecf9 100644
--- a/app/operations/Makefile.am
+++ b/app/operations/Makefile.am
@@ -44,6 +44,8 @@ libappoperations_a_sources = \
        gimpoperationblend.h                    \
        gimpoperationborder.c                   \
        gimpoperationborder.h                   \
+       gimpoperationbuffersourcevalidate.c     \
+       gimpoperationbuffersourcevalidate.h     \
        gimpoperationcagecoefcalc.c             \
        gimpoperationcagecoefcalc.h             \
        gimpoperationcagetransform.c            \
diff --git a/app/operations/gimp-operations.c b/app/operations/gimp-operations.c
index 962978f..e0e702d 100644
--- a/app/operations/gimp-operations.c
+++ b/app/operations/gimp-operations.c
@@ -32,6 +32,7 @@
 
 #include "gimpoperationblend.h"
 #include "gimpoperationborder.h"
+#include "gimpoperationbuffersourcevalidate.h"
 #include "gimpoperationcagecoefcalc.h"
 #include "gimpoperationcagetransform.h"
 #include "gimpoperationcomposecrop.h"
@@ -125,6 +126,7 @@ gimp_operations_init (Gimp *gimp)
 
   g_type_class_ref (GIMP_TYPE_OPERATION_BLEND);
   g_type_class_ref (GIMP_TYPE_OPERATION_BORDER);
+  g_type_class_ref (GIMP_TYPE_OPERATION_BUFFER_SOURCE_VALIDATE);
   g_type_class_ref (GIMP_TYPE_OPERATION_CAGE_COEF_CALC);
   g_type_class_ref (GIMP_TYPE_OPERATION_CAGE_TRANSFORM);
   g_type_class_ref (GIMP_TYPE_OPERATION_COMPOSE_CROP);
diff --git a/app/operations/gimpoperationbuffersourcevalidate.c 
b/app/operations/gimpoperationbuffersourcevalidate.c
new file mode 100644
index 0000000..2721247
--- /dev/null
+++ b/app/operations/gimpoperationbuffersourcevalidate.c
@@ -0,0 +1,359 @@
+/* GIMP - The GNU Image Manipulation Program
+ * Copyright (C) 1995 Spencer Kimball and Peter Mattis
+ *
+ * gimpoperationbuffersourcevalidate.c
+ * Copyright (C) 2017 Ell
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#include "config.h"
+
+#include <cairo.h>
+#include <gegl-plugin.h>
+#include <gdk-pixbuf/gdk-pixbuf.h>
+
+#include "libgimpcolor/gimpcolor.h"
+#include "libgimpconfig/gimpconfig.h"
+#include "libgimpmath/gimpmath.h"
+
+#include "operations-types.h"
+
+#include "gegl/gimptilehandlervalidate.h"
+
+#include "gimpoperationbuffersourcevalidate.h"
+
+
+enum
+{
+  PROP_0,
+  PROP_BUFFER
+};
+
+
+static void           gimp_operation_buffer_source_validate_dispose          (GObject                        
   *object);
+static void           gimp_operation_buffer_source_validate_get_property     (GObject                        
   *object,
+                                                                              guint                          
    property_id,
+                                                                              GValue                         
   *value,
+                                                                              GParamSpec                     
   *pspec);
+static void           gimp_operation_buffer_source_validate_set_property     (GObject                        
   *object,
+                                                                              guint                          
    property_id,
+                                                                              const GValue                   
   *value,
+                                                                              GParamSpec                     
   *pspec);
+
+static GeglRectangle  gimp_operation_buffer_source_validate_get_bounding_box (GeglOperation                  
   *operation);
+static void           gimp_operation_buffer_source_validate_prepare          (GeglOperation                  
   *operation);
+static gboolean       gimp_operation_buffer_source_validate_process          (GeglOperation                  
   *operation,
+                                                                              GeglOperationContext           
   *context,
+                                                                              const gchar                    
   *output_pad,
+                                                                              const GeglRectangle            
   *result,
+                                                                              gint                           
    level);
+
+static void           gimp_operation_buffer_source_validate_buffer_changed   (GeglBuffer                     
   *buffer,
+                                                                              const GeglRectangle            
   *rect,
+                                                                              gpointer                       
    data);
+
+static void           gimp_operation_buffer_source_validate_buffer_validate  
(GimpOperationBufferSourceValidate *buffer_source_validate,
+                                                                              const cairo_rectangle_int_t    
   *rect,
+                                                                              gint                           
    level);
+
+
+G_DEFINE_TYPE (GimpOperationBufferSourceValidate, gimp_operation_buffer_source_validate,
+               GEGL_TYPE_OPERATION_SOURCE)
+
+#define parent_class gimp_operation_buffer_source_validate_parent_class
+
+
+static void
+gimp_operation_buffer_source_validate_class_init (GimpOperationBufferSourceValidateClass *klass)
+{
+  GObjectClass       *object_class    = G_OBJECT_CLASS (klass);
+  GeglOperationClass *operation_class = GEGL_OPERATION_CLASS (klass);
+
+  object_class->dispose             = gimp_operation_buffer_source_validate_dispose;
+  object_class->set_property        = gimp_operation_buffer_source_validate_set_property;
+  object_class->get_property        = gimp_operation_buffer_source_validate_get_property;
+
+  operation_class->get_bounding_box = gimp_operation_buffer_source_validate_get_bounding_box;
+  operation_class->prepare          = gimp_operation_buffer_source_validate_prepare;
+  operation_class->process          = gimp_operation_buffer_source_validate_process;
+
+  operation_class->threaded         = FALSE;
+  operation_class->no_cache         = TRUE;
+
+  gegl_operation_class_set_keys (operation_class,
+                                 "name",        "gimp:buffer-source-validate",
+                                 "categories",  "gimp",
+                                 "description", "GIMP Buffer-Source Validate operation",
+                                 NULL);
+
+  g_object_class_install_property (object_class, PROP_BUFFER,
+                                   g_param_spec_object ("buffer",
+                                                        "Buffer",
+                                                        "Input buffer",
+                                                        GEGL_TYPE_BUFFER,
+                                                        G_PARAM_READWRITE));
+}
+
+static void
+gimp_operation_buffer_source_validate_init (GimpOperationBufferSourceValidate *self)
+{
+}
+
+static void
+gimp_operation_buffer_source_validate_dispose (GObject *object)
+{
+  GimpOperationBufferSourceValidate *buffer_source_validate = GIMP_OPERATION_BUFFER_SOURCE_VALIDATE (object);
+
+  if (buffer_source_validate->buffer)
+    {
+      g_signal_handlers_disconnect_by_func (
+        buffer_source_validate->buffer,
+        gimp_operation_buffer_source_validate_buffer_changed,
+        buffer_source_validate);
+
+      g_clear_object (&buffer_source_validate->buffer);
+    }
+
+  G_OBJECT_CLASS (parent_class)->dispose (object);
+}
+
+static void
+gimp_operation_buffer_source_validate_get_property (GObject    *object,
+                                                    guint       property_id,
+                                                    GValue     *value,
+                                                    GParamSpec *pspec)
+{
+  GimpOperationBufferSourceValidate *buffer_source_validate = GIMP_OPERATION_BUFFER_SOURCE_VALIDATE (object);
+
+  switch (property_id)
+    {
+    case PROP_BUFFER:
+      g_value_set_object (value, buffer_source_validate->buffer);
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+      break;
+    }
+}
+
+static void
+gimp_operation_buffer_source_validate_set_property (GObject      *object,
+                                                    guint         property_id,
+                                                    const GValue *value,
+                                                    GParamSpec   *pspec)
+{
+  GimpOperationBufferSourceValidate *buffer_source_validate = GIMP_OPERATION_BUFFER_SOURCE_VALIDATE (object);
+
+  switch (property_id)
+    {
+    case PROP_BUFFER:
+      {
+        if (buffer_source_validate->buffer)
+          {
+            gimp_operation_buffer_source_validate_buffer_changed (
+              buffer_source_validate->buffer,
+              gegl_buffer_get_extent (buffer_source_validate->buffer),
+              buffer_source_validate);
+
+            g_signal_handlers_disconnect_by_func (
+              buffer_source_validate->buffer,
+              G_CALLBACK (gimp_operation_buffer_source_validate_buffer_changed),
+              buffer_source_validate);
+
+            g_clear_object (&buffer_source_validate->buffer);
+          }
+
+        buffer_source_validate->buffer = g_value_dup_object (value);
+
+        if (buffer_source_validate->buffer)
+          {
+            g_signal_connect (
+              buffer_source_validate->buffer,
+              "changed",
+              G_CALLBACK (gimp_operation_buffer_source_validate_buffer_changed),
+              buffer_source_validate);
+
+            gimp_operation_buffer_source_validate_buffer_changed (
+              buffer_source_validate->buffer,
+              gegl_buffer_get_extent (buffer_source_validate->buffer),
+              buffer_source_validate);
+          }
+      }
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+      break;
+    }
+}
+
+static GeglRectangle
+gimp_operation_buffer_source_validate_get_bounding_box (GeglOperation *operation)
+{
+  GimpOperationBufferSourceValidate *buffer_source_validate = GIMP_OPERATION_BUFFER_SOURCE_VALIDATE 
(operation);
+
+  GeglRectangle result = {};
+
+  if (buffer_source_validate->buffer)
+    result = *gegl_buffer_get_extent (buffer_source_validate->buffer);
+
+  return result;
+}
+
+static void
+gimp_operation_buffer_source_validate_prepare (GeglOperation *operation)
+{
+  GimpOperationBufferSourceValidate *buffer_source_validate = GIMP_OPERATION_BUFFER_SOURCE_VALIDATE 
(operation);
+  const Babl                        *format                 = NULL;
+
+  if (buffer_source_validate->buffer)
+    format = gegl_buffer_get_format (buffer_source_validate->buffer);
+
+  gegl_operation_set_format (operation, "output", format);
+}
+
+static gboolean
+gimp_operation_buffer_source_validate_process (GeglOperation        *operation,
+                                               GeglOperationContext *context,
+                                               const gchar          *output_pad,
+                                               const GeglRectangle  *result,
+                                               gint                  level)
+{
+  GimpOperationBufferSourceValidate *buffer_source_validate = GIMP_OPERATION_BUFFER_SOURCE_VALIDATE 
(operation);
+  GeglBuffer                        *buffer                 = buffer_source_validate->buffer;
+
+  if (buffer)
+    {
+      GimpTileHandlerValidate *validate_handler;
+
+      validate_handler = gimp_tile_handler_validate_get_assigned (buffer);
+
+      if (validate_handler)
+        {
+          gint n_threads;
+
+          g_object_get (gegl_config (),
+                        "threads", &n_threads,
+                        NULL);
+
+          /* the main reason to validate the buffer during processing is to
+           * avoid threading issues.  skip validation if not using
+           * multithreading.
+           */
+          if (n_threads > 1)
+            {
+              cairo_rectangle_int_t  rect;
+              cairo_region_overlap_t overlap;
+
+              rect.x      = result->x;
+              rect.y      = result->y;
+              rect.width  = result->width;
+              rect.height = result->height;
+
+              overlap = cairo_region_contains_rectangle (validate_handler->dirty_region,
+                                                         &rect);
+
+              if (overlap == CAIRO_REGION_OVERLAP_IN)
+                {
+                  gimp_operation_buffer_source_validate_buffer_validate (
+                    buffer_source_validate, &rect, level);
+                }
+              else if (overlap == CAIRO_REGION_OVERLAP_PART)
+                {
+                  cairo_region_t *region;
+                  gint            n_rectangles;
+                  gint            i;
+
+                  region = cairo_region_copy (validate_handler->dirty_region);
+
+                  cairo_region_intersect_rectangle (region, &rect);
+
+                  n_rectangles = cairo_region_num_rectangles (region);
+
+                  for (i = 0; i < n_rectangles; i++)
+                    {
+                      cairo_region_get_rectangle (region, i, &rect);
+
+                      gimp_operation_buffer_source_validate_buffer_validate (
+                        buffer_source_validate, &rect, level);
+                    }
+
+                  cairo_region_destroy (region);
+                }
+            }
+        }
+
+      gegl_operation_context_set_object (context, "output", G_OBJECT (buffer));
+
+      gegl_object_set_has_forked (G_OBJECT (buffer));
+    }
+
+  return TRUE;
+}
+
+static void
+gimp_operation_buffer_source_validate_buffer_changed (GeglBuffer          *buffer,
+                                                      const GeglRectangle *rect,
+                                                      gpointer             data)
+{
+  GimpOperationBufferSourceValidate *buffer_source_validate = GIMP_OPERATION_BUFFER_SOURCE_VALIDATE (data);
+
+  gegl_operation_invalidate (GEGL_OPERATION (buffer_source_validate),
+                             rect, FALSE);
+}
+
+static void
+gimp_operation_buffer_source_validate_buffer_validate (GimpOperationBufferSourceValidate 
*buffer_source_validate,
+                                                       const cairo_rectangle_int_t       *rect,
+                                                       gint                               level)
+{
+  gint                shift_x;
+  gint                shift_y;
+  gint                tile_width;
+  gint                tile_height;
+  GeglRectangle       roi;
+  GeglBufferIterator *iter;
+
+  g_object_get (buffer_source_validate->buffer,
+                "shift-x",     &shift_x,
+                "shift-y",     &shift_y,
+                "tile-width",  &tile_width,
+                "tile-height", &tile_height,
+                NULL);
+
+  /* align rectangle to tile grid */
+
+  roi.x      = (gint) floor ((gdouble) (rect->x                + shift_x) / tile_width)  * tile_width;
+  roi.y      = (gint) floor ((gdouble) (rect->y                + shift_y) / tile_height) * tile_height;
+  roi.width  = (gint) ceil  ((gdouble) (rect->x + rect->width  + shift_x) / tile_width)  * tile_width  - 
roi.x;
+  roi.height = (gint) ceil  ((gdouble) (rect->y + rect->height + shift_y) / tile_height) * tile_height - 
roi.y;
+
+  roi.x -= shift_x;
+  roi.y -= shift_y;
+
+  /* intersect rectangle with abyss */
+
+  gegl_rectangle_intersect (&roi, &roi,
+                            gegl_buffer_get_abyss (buffer_source_validate->buffer));
+
+  /* iterate over rectangle -- this implicitly causes validation */
+
+  iter = gegl_buffer_iterator_new (buffer_source_validate->buffer,
+                                   &roi, level, NULL,
+                                   GEGL_BUFFER_READ, GEGL_ABYSS_NONE);
+
+  while (gegl_buffer_iterator_next (iter));
+}
diff --git a/app/operations/gimpoperationbuffersourcevalidate.h 
b/app/operations/gimpoperationbuffersourcevalidate.h
new file mode 100644
index 0000000..5ca4446
--- /dev/null
+++ b/app/operations/gimpoperationbuffersourcevalidate.h
@@ -0,0 +1,52 @@
+/* GIMP - The GNU Image Manipulation Program
+ * Copyright (C) 1995 Spencer Kimball and Peter Mattis
+ *
+ * gimpoperationbuffersourcevalidate.h
+ * Copyright (C) 2017 Ell
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __GIMP_OPERATION_BUFFER_SOURCE_VALIDATE_H__
+#define __GIMP_OPERATION_BUFFER_SOURCE_VALIDATE_H__
+
+
+#define GIMP_TYPE_OPERATION_BUFFER_SOURCE_VALIDATE            
(gimp_operation_buffer_source_validate_get_type ())
+#define GIMP_OPERATION_BUFFER_SOURCE_VALIDATE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), 
GIMP_TYPE_OPERATION_BUFFER_SOURCE_VALIDATE, GimpOperationBufferSourceValidate))
+#define GIMP_OPERATION_BUFFER_SOURCE_VALIDATE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  
GIMP_TYPE_OPERATION_BUFFER_SOURCE_VALIDATE, GimpOperationBufferSourceValidateClass))
+#define GIMP_IS_OPERATION_BUFFER_SOURCE_VALIDATE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), 
GIMP_TYPE_OPERATION_BUFFER_SOURCE_VALIDATE))
+#define GIMP_IS_OPERATION_BUFFER_SOURCE_VALIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  
GIMP_TYPE_OPERATION_BUFFER_SOURCE_VALIDATE))
+#define GIMP_OPERATION_BUFFER_SOURCE_VALIDATE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  
GIMP_TYPE_OPERATION_BUFFER_SOURCE_VALIDATE, GimpOperationBufferSourceValidateClass))
+
+
+typedef struct _GimpOperationBufferSourceValidate      GimpOperationBufferSourceValidate;
+typedef struct _GimpOperationBufferSourceValidateClass GimpOperationBufferSourceValidateClass;
+
+struct _GimpOperationBufferSourceValidate
+{
+  GeglOperationSource  parent_instance;
+
+  GeglBuffer          *buffer;
+};
+
+struct _GimpOperationBufferSourceValidateClass
+{
+  GeglOperationSourceClass  parent_class;
+};
+
+
+GType   gimp_operation_buffer_source_validate_get_type (void) G_GNUC_CONST;
+
+
+#endif /* __GIMP_OPERATION_BUFFER_SOURCE_VALIDATE_H__ */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]