PIKApp/plug-ins/common/tile.c

/* PIKA - Photo and Image Kooker Application
 * a rebranding of The GNU Image Manipulation Program (created with heckimp)
 * A derived work which may be trivial. However, any changes may be (C)2023 by Aldercone Studio
 *
 * Original copyright, applying to most contents (license remains unchanged): 
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * 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/>.
 */

/*
 * This filter tiles an image to arbitrary width and height
 */
#include "config.h"

#include <string.h>

#include <libpika/pika.h>
#include <libpika/pikaui.h>

#include "libpika/stdplugins-intl.h"


#define PLUG_IN_PROC   "plug-in-tile"
#define PLUG_IN_BINARY "tile"
#define PLUG_IN_ROLE   "pika-tile"


typedef struct _Tile      Tile;
typedef struct _TileClass TileClass;

struct _Tile
{
  PikaPlugIn parent_instance;
};

struct _TileClass
{
  PikaPlugInClass parent_class;
};


#define TILE_TYPE  (tile_get_type ())
#define TILE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TILE_TYPE, Tile))

GType                   tile_get_type         (void) G_GNUC_CONST;

static GList          * tile_query_procedures (PikaPlugIn           *plug_in);
static PikaProcedure  * tile_create_procedure (PikaPlugIn           *plug_in,
                                               const gchar          *name);

static PikaValueArray * tile_run              (PikaProcedure        *procedure,
                                               PikaRunMode           run_mode,
                                               PikaImage            *image,
                                               gint                  n_drawables,
                                               PikaDrawable        **drawables,
                                               PikaProcedureConfig  *config,
                                               gpointer              run_data);

static void             tile                  (PikaImage            *image,
                                               PikaDrawable         *drawable,
                                               gint                  new_width,
                                               gint                  new_height,
                                               gboolean              create_new_image,
                                               PikaImage           **new_image,
                                               PikaLayer           **new_layer);

static void             tile_gegl             (GeglBuffer           *src,
                                               gint                  src_width,
                                               gint                  src_height,
                                               GeglBuffer           *dst,
                                               gint                  dst_width,
                                               gint                  dst_height);

static gboolean         tile_dialog           (PikaProcedure        *procedure,
                                               PikaProcedureConfig  *config,
                                               PikaImage            *image,
                                               PikaDrawable         *drawable);


G_DEFINE_TYPE (Tile, tile, PIKA_TYPE_PLUG_IN)

PIKA_MAIN (TILE_TYPE)
DEFINE_STD_SET_I18N


static void
tile_class_init (TileClass *klass)
{
  PikaPlugInClass *plug_in_class = PIKA_PLUG_IN_CLASS (klass);

  plug_in_class->query_procedures = tile_query_procedures;
  plug_in_class->create_procedure = tile_create_procedure;
  plug_in_class->set_i18n         = STD_SET_I18N;
}

static void
tile_init (Tile *tile)
{
}

static GList *
tile_query_procedures (PikaPlugIn *plug_in)
{
  return g_list_append (NULL, g_strdup (PLUG_IN_PROC));
}

static PikaProcedure *
tile_create_procedure (PikaPlugIn  *plug_in,
                       const gchar *name)
{
  PikaProcedure *procedure = NULL;

  if (! strcmp (name, PLUG_IN_PROC))
    {
      procedure = pika_image_procedure_new (plug_in, name,
                                            PIKA_PDB_PROC_TYPE_PLUGIN,
                                            tile_run, NULL, NULL);

      pika_procedure_set_image_types (procedure, "*");
      pika_procedure_set_sensitivity_mask (procedure,
                                           PIKA_PROCEDURE_SENSITIVE_DRAWABLE);

      pika_procedure_set_menu_label (procedure, _("_Tile..."));
      pika_procedure_add_menu_path (procedure, "<Image>/Filters/Map");

      pika_procedure_set_documentation (procedure,
                                        _("Create an array of copies "
                                          "of the image"),
                                        "This function creates a new image "
                                        "with a single layer sized to the "
                                        "specified 'new_width' and "
                                        "'new_height' parameters. The "
                                        "specified drawable is tiled into "
                                        "this layer.  The new layer will have "
                                        "the same type as the specified "
                                        "drawable and the new image will "
                                        "have a corresponding base type.",
                                        name);
      pika_procedure_set_attribution (procedure,
                                      "Spencer Kimball & Peter Mattis",
                                      "Spencer Kimball & Peter Mattis",
                                      "1996-1997");

      /* XXX: we actually don't care about the default value as we always set
       * the width/height of the active image, though it would be nice to reuse
       * the previously stored value if we run tile on the same image twice.
       * TODO: a flag and/or some special handler function would be interesting
       * for such specific cases where a hardcoded default value doesn't make
       * sense or when we want stored values to only apply when run on a same
       * image.
       */
      PIKA_PROC_ARG_INT (procedure, "new-width",
                         "New _width",
                         "New (tiled) image width",
                         1, PIKA_MAX_IMAGE_SIZE, 1,
                         G_PARAM_READWRITE);

      PIKA_PROC_ARG_INT (procedure, "new-height",
                         "New _height",
                         "New (tiled) image height",
                         1, PIKA_MAX_IMAGE_SIZE, 1,
                         G_PARAM_READWRITE);

      PIKA_PROC_ARG_BOOLEAN (procedure, "new-image",
                             "New _image",
                             "Create a new image",
                             TRUE,
                             G_PARAM_READWRITE);

      PIKA_PROC_VAL_IMAGE (procedure, "new-image",
                           "New image",
                           "Output image (NULL if new-image == FALSE)",
                           TRUE,
                           G_PARAM_READWRITE);

      PIKA_PROC_VAL_LAYER (procedure, "new-layer",
                           "New layer",
                           "Output layer (NULL if new-image == FALSE)",
                           TRUE,
                           G_PARAM_READWRITE);
    }

  return procedure;
}

static PikaValueArray *
tile_run (PikaProcedure        *procedure,
          PikaRunMode           run_mode,
          PikaImage            *image,
          gint                  n_drawables,
          PikaDrawable        **drawables,
          PikaProcedureConfig  *config,
          gpointer              run_data)
{
  PikaValueArray *return_vals;
  PikaLayer      *new_layer;
  PikaImage      *new_image;
  PikaDrawable   *drawable;
  gint            new_width;
  gint            new_height;
  gboolean        create_new_image;

  gegl_init (NULL, NULL);

  if (n_drawables != 1)
    {
      GError *error = NULL;

      g_set_error (&error, PIKA_PLUG_IN_ERROR, 0,
                   _("Procedure '%s' only works with one drawable."),
                   pika_procedure_get_name (procedure));

      return pika_procedure_new_return_values (procedure,
                                               PIKA_PDB_CALLING_ERROR,
                                               error);
    }
  else
    {
      drawable = drawables[0];
    }

  switch (run_mode)
    {
    case PIKA_RUN_INTERACTIVE:
      if (! tile_dialog (procedure, config, image, drawable))
        {
          return pika_procedure_new_return_values (procedure,
                                                   PIKA_PDB_CANCEL,
                                                   NULL);
        }
      break;

    case PIKA_RUN_NONINTERACTIVE:
      break;

    case PIKA_RUN_WITH_LAST_VALS:
      break;
    }

  g_object_get (config,
                "new-width",  &new_width,
                "new-height", &new_height,
                "new-image",  &create_new_image,
                NULL);

  pika_progress_init (_("Tiling"));

  tile (image, drawable, new_width, new_height,
        create_new_image, &new_image, &new_layer);

  if (run_mode != PIKA_RUN_NONINTERACTIVE)
    {
      if (create_new_image)
        pika_display_new (new_image);
      else
        pika_displays_flush ();
    }

  return_vals = pika_procedure_new_return_values (procedure,
                                                  PIKA_PDB_SUCCESS,
                                                  NULL);

  PIKA_VALUES_SET_IMAGE (return_vals, 1, new_image);
  PIKA_VALUES_SET_LAYER (return_vals, 2, new_layer);

  return return_vals;
}

static void
tile_gegl (GeglBuffer  *src,
           gint         src_width,
           gint         src_height,
           GeglBuffer  *dst,
           gint         dst_width,
           gint         dst_height)
{
  GeglNode *node;
  GeglNode *buffer_src_node;
  GeglNode *tile_node;
  GeglNode *crop_src_node;
  GeglNode *crop_dst_node;
  GeglNode *buffer_dst_node;

  GeglProcessor *processor;
  gdouble        progress;

  node = gegl_node_new ();

  buffer_src_node = gegl_node_new_child (node,
                                         "operation", "gegl:buffer-source",
                                         "buffer",    src,
                                         NULL);

  crop_src_node = gegl_node_new_child (node,
                                       "operation", "gegl:crop",
                                       "width",     (gdouble) src_width,
                                       "height",    (gdouble) src_height,
                                       NULL);

  tile_node = gegl_node_new_child (node,
                                   "operation", "gegl:tile",
                                   NULL);

  crop_dst_node = gegl_node_new_child (node,
                                       "operation", "gegl:crop",
                                       "width",     (gdouble) dst_width,
                                       "height",    (gdouble) dst_height,
                                       NULL);

  buffer_dst_node = gegl_node_new_child (node,
                                         "operation", "gegl:write-buffer",
                                         "buffer",    dst,
                                         NULL);

  gegl_node_link_many (buffer_src_node,
                       crop_src_node,
                       tile_node,
                       crop_dst_node,
                       buffer_dst_node,
                       NULL);

  processor = gegl_node_new_processor (buffer_dst_node, NULL);

  while (gegl_processor_work (processor, &progress))
    if (!((gint) (progress * 100.0) % 10))
      pika_progress_update (progress);

  pika_progress_update (1.0);

  g_object_unref (processor);
  g_object_unref (node);
}

static void
tile (PikaImage     *image,
      PikaDrawable  *drawable,
      gint           new_width,
      gint           new_height,
      gboolean       create_new_image,
      PikaImage    **new_image,
      PikaLayer    **new_layer)
{
  PikaDrawable *dst_drawable;
  GeglBuffer   *dst_buffer;
  GeglBuffer   *src_buffer;
  gint          src_width  = pika_drawable_get_width (drawable);
  gint          src_height = pika_drawable_get_height (drawable);

  PikaImageBaseType  image_type   = PIKA_RGB;

  if (create_new_image)
    {
      /*  create  a new image  */
      gint32 precision = pika_image_get_precision (image);

      switch (pika_drawable_type (drawable))
        {
        case PIKA_RGB_IMAGE:
        case PIKA_RGBA_IMAGE:
          image_type = PIKA_RGB;
          break;

        case PIKA_GRAY_IMAGE:
        case PIKA_GRAYA_IMAGE:
          image_type = PIKA_GRAY;
          break;

        case PIKA_INDEXED_IMAGE:
        case PIKA_INDEXEDA_IMAGE:
          image_type = PIKA_INDEXED;
          break;
        }

      *new_image = pika_image_new_with_precision (new_width,
                                                  new_height,
                                                  image_type,
                                                  precision);
      pika_image_undo_disable (*new_image);

      /*  copy the colormap, if necessary  */
      if (image_type == PIKA_INDEXED)
        {
          guchar *cmap;
          gint    ncols;

          cmap = pika_image_get_colormap (image, NULL, &ncols);
          pika_image_set_colormap (*new_image, cmap, ncols);
          g_free (cmap);
        }

      *new_layer = pika_layer_new (*new_image, _("Background"),
                                   new_width, new_height,
                                   pika_drawable_type (drawable),
                                   100,
                                   pika_image_get_default_new_layer_mode (*new_image));

      if (*new_layer == NULL)
        return;

      pika_image_insert_layer (*new_image, *new_layer, NULL, 0);
      dst_drawable = PIKA_DRAWABLE (*new_layer);
    }
  else
    {
      *new_image = NULL;
      *new_layer = NULL;

      pika_image_undo_group_start (image);
      pika_image_resize (image, new_width, new_height, 0, 0);

      if (pika_item_is_layer (PIKA_ITEM (drawable)))
        {
          pika_layer_resize (PIKA_LAYER (drawable), new_width, new_height, 0, 0);
        }
      else if (pika_item_is_layer_mask (PIKA_ITEM (drawable)))
        {
          PikaLayer *layer = pika_layer_from_mask (PIKA_LAYER_MASK (drawable));

          pika_layer_resize (layer, new_width, new_height, 0, 0);
        }

      dst_drawable = drawable;
    }

  src_buffer = pika_drawable_get_buffer (drawable);
  dst_buffer = pika_drawable_get_buffer (dst_drawable);

  tile_gegl (src_buffer, src_width, src_height,
             dst_buffer, new_width, new_height);

  gegl_buffer_flush (dst_buffer);
  pika_drawable_update (dst_drawable, 0, 0, new_width, new_height);

  if (create_new_image)
    {
      pika_image_undo_enable (*new_image);
    }
  else
    {
      pika_image_undo_group_end (image);
    }

  g_object_unref (src_buffer);
  g_object_unref (dst_buffer);
}

static gboolean
tile_dialog (PikaProcedure       *procedure,
             PikaProcedureConfig *config,
             PikaImage           *image,
             PikaDrawable        *drawable)
{
  GtkWidget *dlg;
  gint       width;
  gint       height;
  gboolean   run;

  pika_ui_init (PLUG_IN_BINARY);

  width  = pika_drawable_get_width (drawable);
  height = pika_drawable_get_height (drawable);

  g_object_set (config,
                "new-width",  width,
                "new-height", height,
                NULL);

  dlg = pika_procedure_dialog_new (procedure,
                                   PIKA_PROCEDURE_CONFIG (config),
                                   _("Tile"));
  pika_procedure_dialog_get_label (PIKA_PROCEDURE_DIALOG (dlg),
                                   "new-size-label", _("Tile to New Size"),
                                   FALSE, FALSE);
  /* TODO: we should have a new PikaProcedureDialog widget which would tie 2
   * arguments for dimensions (or coordinates), and possibly more aux args for
   * the constrain boolean choice, the unit, etc.
   */
  pika_procedure_dialog_fill_box (PIKA_PROCEDURE_DIALOG (dlg),
                                  "new-size-box",
                                  "new-width", "new-height",
                                  NULL);
  pika_procedure_dialog_fill_frame (PIKA_PROCEDURE_DIALOG (dlg),
                                    "new-size-frame", "new-size-label", FALSE,
                                    "new-size-box");
  pika_procedure_dialog_fill (PIKA_PROCEDURE_DIALOG (dlg), "new-size-frame", "new-image", NULL);

  run = pika_procedure_dialog_run (PIKA_PROCEDURE_DIALOG (dlg));

  gtk_widget_destroy (dlg);

  return run;
}