PIKApp/app/core/pikasymmetry.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
 *
 * pikasymmetry.c
 * Copyright (C) 2015 Jehan <jehan@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 <string.h>

#include <gegl.h>
#include <gdk-pixbuf/gdk-pixbuf.h>

#include "libpikabase/pikabase.h"
#include "libpikaconfig/pikaconfig.h"
#include "libpikamath/pikamath.h"

#include "core-types.h"

#include "gegl/pika-gegl-nodes.h"

#include "pikadrawable.h"
#include "pikaimage.h"
#include "pikaimage-symmetry.h"
#include "pikaitem.h"
#include "pikasymmetry.h"

#include "pika-intl.h"


enum
{
  STROKES_UPDATED,
  GUI_PARAM_CHANGED,
  ACTIVE_CHANGED,
  LAST_SIGNAL
};

enum
{
  PROP_0,
  PROP_IMAGE,
  PROP_ACTIVE,
  PROP_VERSION,
};


/* Local function prototypes */

static void       pika_symmetry_finalize            (GObject      *object);
static void       pika_symmetry_set_property        (GObject      *object,
                                                     guint         property_id,
                                                     const GValue *value,
                                                     GParamSpec   *pspec);
static void       pika_symmetry_get_property        (GObject      *object,
                                                     guint         property_id,
                                                     GValue       *value,
                                                     GParamSpec   *pspec);

static void       pika_symmetry_real_update_strokes (PikaSymmetry *sym,
                                                     PikaDrawable *drawable,
                                                     PikaCoords   *origin);
static void       pika_symmetry_real_get_transform  (PikaSymmetry *sym,
                                                     gint          stroke,
                                                     gdouble      *angle,
                                                     gboolean     *reflect);
static gboolean   pika_symmetry_real_update_version (PikaSymmetry *sym);


G_DEFINE_TYPE_WITH_CODE (PikaSymmetry, pika_symmetry, PIKA_TYPE_OBJECT,
                         G_IMPLEMENT_INTERFACE (PIKA_TYPE_CONFIG, NULL))

#define parent_class pika_symmetry_parent_class

static guint pika_symmetry_signals[LAST_SIGNAL] = { 0 };


static void
pika_symmetry_class_init (PikaSymmetryClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  /* This signal should likely be emitted at the end of
   * update_strokes() if stroke coordinates were changed.
   */
  pika_symmetry_signals[STROKES_UPDATED] =
    g_signal_new ("strokes-updated",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
                  NULL,
                  G_TYPE_NONE,
                  1, PIKA_TYPE_IMAGE);

  /* This signal should be emitted when you request a change in the
   * settings UI. For instance adding some settings (therefore having
   * a dynamic UI), or changing scale min/max extremes, etc.
   */
  pika_symmetry_signals[GUI_PARAM_CHANGED] =
    g_signal_new ("gui-param-changed",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
                  NULL,
                  G_TYPE_NONE,
                  1, PIKA_TYPE_IMAGE);

  pika_symmetry_signals[ACTIVE_CHANGED] =
    g_signal_new ("active-changed",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (PikaSymmetryClass, active_changed),
                  NULL, NULL,
                  NULL,
                  G_TYPE_NONE, 0);

  object_class->finalize     = pika_symmetry_finalize;
  object_class->set_property = pika_symmetry_set_property;
  object_class->get_property = pika_symmetry_get_property;

  klass->label               = _("None");
  klass->update_strokes      = pika_symmetry_real_update_strokes;
  klass->get_transform       = pika_symmetry_real_get_transform;
  klass->active_changed      = NULL;
  klass->update_version      = pika_symmetry_real_update_version;

  g_object_class_install_property (object_class, PROP_IMAGE,
                                   g_param_spec_object ("image",
                                                        NULL, NULL,
                                                        PIKA_TYPE_IMAGE,
                                                        PIKA_PARAM_READWRITE |
                                                        G_PARAM_CONSTRUCT_ONLY));
  PIKA_CONFIG_PROP_BOOLEAN (object_class, PROP_ACTIVE,
                            "active",
                            _("Active"),
                            _("Activate symmetry painting"),
                            FALSE,
                            PIKA_PARAM_STATIC_STRINGS);

  PIKA_CONFIG_PROP_INT (object_class, PROP_VERSION,
                        "version",
                        "Symmetry version",
                        "Version of the symmetry object",
                        -1, G_MAXINT, 0,
                        PIKA_PARAM_STATIC_STRINGS);
}

static void
pika_symmetry_init (PikaSymmetry *sym)
{
}

static void
pika_symmetry_finalize (GObject *object)
{
  PikaSymmetry *sym = PIKA_SYMMETRY (object);

  pika_symmetry_clear_origin (sym);

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

static void
pika_symmetry_set_property (GObject      *object,
                            guint         property_id,
                            const GValue *value,
                            GParamSpec   *pspec)
{
  PikaSymmetry *sym = PIKA_SYMMETRY (object);

  switch (property_id)
    {
    case PROP_IMAGE:
      sym->image = g_value_get_object (value);
      break;
    case PROP_ACTIVE:
      sym->active = g_value_get_boolean (value);
      g_signal_emit (sym, pika_symmetry_signals[ACTIVE_CHANGED], 0,
                     sym->active);
      break;
    case PROP_VERSION:
      sym->version = g_value_get_int (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
pika_symmetry_get_property (GObject    *object,
                            guint       property_id,
                            GValue     *value,
                            GParamSpec *pspec)
{
  PikaSymmetry *sym = PIKA_SYMMETRY (object);

  switch (property_id)
    {
    case PROP_IMAGE:
      g_value_set_object (value, sym->image);
      break;
    case PROP_ACTIVE:
      g_value_set_boolean (value, sym->active);
      break;
    case PROP_VERSION:
      g_value_set_int (value, sym->version);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
pika_symmetry_real_update_strokes (PikaSymmetry *sym,
                                   PikaDrawable *drawable,
                                   PikaCoords   *origin)
{
  /* The basic symmetry just uses the origin as is. */
  sym->strokes = g_list_prepend (sym->strokes,
                                 g_memdup2 (origin, sizeof (PikaCoords)));
}

static void
pika_symmetry_real_get_transform (PikaSymmetry *sym,
                                  gint          stroke,
                                  gdouble      *angle,
                                  gboolean     *reflect)
{
  /* The basic symmetry does nothing, since no transformation of the
   * brush painting happen. */
}

static gboolean
pika_symmetry_real_update_version (PikaSymmetry *symmetry)
{
  /* Currently all symmetries are at version 0. So all this check has to
   * do is verify that we are at version 0.
   * If one of the child symmetry bumps its version, it will have to
   * override the update_version() virtual function and do any necessary
   * update there (for instance new properties, modified properties, or
   * whatnot).
   */
  gint version;

  g_object_get (symmetry,
                "version", &version,
                NULL);

  return (version == 0);
}

/***** Public Functions *****/

/**
 * pika_symmetry_set_stateful:
 * @sym:      the #PikaSymmetry
 * @stateful: whether the symmetry should be stateful or stateless.
 *
 * By default, symmetry is made stateless, which means in particular
 * that the size of points can change from one stroke to the next, and
 * in particular you cannot map the coordinates from a stroke to the
 * next. I.e. stroke N at time T+1 is not necessarily the continuation
 * of stroke N at time T.
 * To obtain corresponding strokes, stateful tools, such as MyPaint
 * brushes or the ink tool, need to run this function. They should reset
 * to stateless behavior once finished painting.
 *
 * One of the first consequence of being stateful is that the number of
 * strokes cannot be changed, so more strokes than possible on canvas
 * may be computed, and oppositely it will be possible to end up in
 * cases with missing strokes (e.g. a tiling, theoretically infinite,
 * won't be for the ink tool if one draws too far out of canvas).
 **/
void
pika_symmetry_set_stateful (PikaSymmetry *symmetry,
                            gboolean      stateful)
{
  symmetry->stateful = stateful;
}

/**
 * pika_symmetry_set_origin:
 * @sym:      the #PikaSymmetry
 * @drawable: the #PikaDrawable where painting will happen
 * @origin:   new base coordinates.
 *
 * Set the symmetry to new origin coordinates and drawable.
 **/
void
pika_symmetry_set_origin (PikaSymmetry *sym,
                          PikaDrawable *drawable,
                          PikaCoords   *origin)
{
  g_return_if_fail (PIKA_IS_SYMMETRY (sym));
  g_return_if_fail (PIKA_IS_DRAWABLE (drawable));
  g_return_if_fail (pika_item_get_image (PIKA_ITEM (drawable)) == sym->image);

  if (drawable != sym->drawable)
    {
      if (sym->drawable)
        g_object_unref (sym->drawable);
      sym->drawable = g_object_ref (drawable);
    }

  if (origin != sym->origin)
    {
      g_free (sym->origin);
      sym->origin = g_memdup2 (origin, sizeof (PikaCoords));
    }

  g_list_free_full (sym->strokes, g_free);
  sym->strokes = NULL;

  PIKA_SYMMETRY_GET_CLASS (sym)->update_strokes (sym, drawable, origin);
}

/**
 * pika_symmetry_clear_origin:
 * @sym: the #PikaSymmetry
 *
 * Clear the symmetry's origin coordinates and drawable.
 **/
void
pika_symmetry_clear_origin (PikaSymmetry *sym)
{
  g_return_if_fail (PIKA_IS_SYMMETRY (sym));

  g_clear_object (&sym->drawable);

  g_clear_pointer (&sym->origin, g_free);

  g_list_free_full (sym->strokes, g_free);
  sym->strokes = NULL;
}

/**
 * pika_symmetry_get_origin:
 * @sym: the #PikaSymmetry
 *
 * Returns: the origin stroke coordinates.
 * The returned value is owned by the #PikaSymmetry and must not be freed.
 **/
PikaCoords *
pika_symmetry_get_origin (PikaSymmetry *sym)
{
  g_return_val_if_fail (PIKA_IS_SYMMETRY (sym), NULL);

  return sym->origin;
}

/**
 * pika_symmetry_get_size:
 * @sym: the #PikaSymmetry
 *
 * Returns: the total number of strokes.
 **/
gint
pika_symmetry_get_size (PikaSymmetry *sym)
{
  g_return_val_if_fail (PIKA_IS_SYMMETRY (sym), 0);

  return g_list_length (sym->strokes);
}

/**
 * pika_symmetry_get_coords:
 * @sym:    the #PikaSymmetry
 * @stroke: the stroke number
 *
 * Returns: the coordinates of the stroke number @stroke.
 * The returned value is owned by the #PikaSymmetry and must not be freed.
 **/
PikaCoords *
pika_symmetry_get_coords (PikaSymmetry *sym,
                          gint          stroke)
{
  g_return_val_if_fail (PIKA_IS_SYMMETRY (sym), NULL);

  return g_list_nth_data (sym->strokes, stroke);
}

/**
 * pika_symmetry_get_transform:
 * @sym:     the #PikaSymmetry
 * @stroke:  the stroke number
 * @angle: (out): output pointer to the transformation rotation angle,
 *           in degrees (ccw)
 * @reflect: (out): output pointer to the transformation reflection flag
 *
 * Returns: the transformation to apply to the paint content for stroke
 * number @stroke.  The transformation is comprised of rotation, possibly
 * followed by horizontal reflection, around the stroke coordinates.
 **/
void
pika_symmetry_get_transform (PikaSymmetry *sym,
                             gint          stroke,
                             gdouble      *angle,
                             gboolean     *reflect)
{
  g_return_if_fail (PIKA_IS_SYMMETRY (sym));
  g_return_if_fail (angle != NULL);
  g_return_if_fail (reflect != NULL);

  *angle   = 0.0;
  *reflect = FALSE;

  PIKA_SYMMETRY_GET_CLASS (sym)->get_transform (sym,
                                                stroke,
                                                angle,
                                                reflect);
}

/**
 * pika_symmetry_get_matrix:
 * @sym:     the #PikaSymmetry
 * @stroke:  the stroke number
 * @matrix:  output pointer to the transformation matrix
 *
 * Returns: the transformation matrix to apply to the paint content for stroke
 * number @stroke.
 **/
void
pika_symmetry_get_matrix (PikaSymmetry *sym,
                          gint          stroke,
                          PikaMatrix3  *matrix)
{
  gdouble  angle;
  gboolean reflect;

  g_return_if_fail (PIKA_IS_SYMMETRY (sym));
  g_return_if_fail (matrix != NULL);

  pika_symmetry_get_transform (sym, stroke, &angle, &reflect);

  pika_matrix3_identity (matrix);
  pika_matrix3_rotate (matrix, -pika_deg_to_rad (angle));
  if (reflect)
    pika_matrix3_scale (matrix, -1.0, 1.0);
}

/**
 * pika_symmetry_get_operation:
 * @sym:          the #PikaSymmetry
 * @stroke:       the stroke number
 *
 * Returns: the transformation operation to apply to the paint content for
 * stroke number @stroke, or NULL for the identity transformation.
 *
 * The returned #GeglNode should be freed by the caller.
 **/
GeglNode *
pika_symmetry_get_operation (PikaSymmetry *sym,
                             gint          stroke)
{
  PikaMatrix3 matrix;

  g_return_val_if_fail (PIKA_IS_SYMMETRY (sym), NULL);

  pika_symmetry_get_matrix (sym, stroke, &matrix);

  if (pika_matrix3_is_identity (&matrix))
    return NULL;

  return pika_gegl_create_transform_node (&matrix);
}

/*
 * pika_symmetry_parasite_name:
 * @type: the #PikaSymmetry's #GType
 *
 * Returns: a newly allocated string.
 */
gchar *
pika_symmetry_parasite_name (GType type)
{
  return g_strconcat ("pika-image-symmetry:", g_type_name (type), NULL);
}

PikaParasite *
pika_symmetry_to_parasite (const PikaSymmetry *sym)
{
  PikaParasite *parasite;
  gchar        *parasite_name;

  g_return_val_if_fail (PIKA_IS_SYMMETRY (sym), NULL);

  parasite_name = pika_symmetry_parasite_name (G_TYPE_FROM_INSTANCE (sym));

  parasite = pika_config_serialize_to_parasite ((PikaConfig *) sym,
                                                parasite_name,
                                                PIKA_PARASITE_PERSISTENT,
                                                NULL);

  g_free (parasite_name);

  return parasite;
}

PikaSymmetry *
pika_symmetry_from_parasite (const PikaParasite *parasite,
                             PikaImage          *image,
                             GType               type)
{
  PikaSymmetry *symmetry;
  gchar        *parasite_name;
  gchar        *parasite_contents;
  guint32       parasite_size;
  GError       *error = NULL;

  parasite_name = pika_symmetry_parasite_name (type);

  g_return_val_if_fail (parasite != NULL, NULL);
  g_return_val_if_fail (strcmp (pika_parasite_get_name (parasite),
                                parasite_name) == 0,
                        NULL);

  parasite_contents = (gchar *) pika_parasite_get_data (parasite, &parasite_size);
  if (! parasite_contents)
    {
      g_warning ("Empty symmetry parasite \"%s\"", parasite_name);

      return NULL;
    }

  symmetry = pika_image_symmetry_new (image, type);

  g_object_set (symmetry,
                "version", -1,
                NULL);

  if (! pika_config_deserialize_parasite (PIKA_CONFIG (symmetry),
                                          parasite,
                                          NULL,
                                          &error))
    {
      g_printerr ("Failed to deserialize symmetry parasite: %s\n"
                  "\t- parasite name: %s\n\t- parasite data: %.*s\n",
                  error->message, parasite_name,
                  parasite_size, parasite_contents);
      g_error_free (error);

      g_object_unref (symmetry);
      symmetry = NULL;
    }
  g_free (parasite_name);

  if (symmetry)
    {
      gint version;

      g_object_get (symmetry,
                    "version", &version,
                    NULL);
      if (version == -1)
        {
          /* If version has not been updated, let's assume this parasite was
           * not representing symmetry settings.
           */
          g_object_unref (symmetry);
          symmetry = NULL;
        }
      else if (PIKA_SYMMETRY_GET_CLASS (symmetry)->update_version (symmetry) &&
               ! PIKA_SYMMETRY_GET_CLASS (symmetry)->update_version (symmetry))
        {
          g_object_unref (symmetry);
          symmetry = NULL;
        }
    }

  return symmetry;
}