crop.c

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2021-2022 Aldric Renaudin.
    Copyright (C) 2021-2022 Chris Elston.
    Copyright (C) 2021-2022 Diederik Ter Rahe.
    Copyright (C) 2021-2022 Hanno Schwalm.
    Copyright (C) 2021 Hubert Kowalski.
    Copyright (C) 2021-2022 Pascal Obry.
    Copyright (C) 2021 Ralf Brown.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2022 Philipp Lutz.
    Copyright (C) 2023 Alynx Zhou.
    Copyright (C) 2023-2026 Aurélien PIERRE.
    Copyright (C) 2023 Luca Zulberti.
    Copyright (C) 2025-2026 Guillaume Stutin.
    
    darktable 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.
    
    darktable 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 darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifdef HAVE_CONFIG_H
#include "common/darktable.h"
#include "config.h"
#endif
#include "bauhaus/bauhaus.h"
#include "common/debug.h"
#include "common/imagebuf.h"
#include "common/interpolation.h"
#include "common/math.h"
#include "common/opencl.h"
#include "control/conf.h"
#include "control/control.h"
#include "develop/develop.h"
#include "develop/imageop.h"
#include "develop/imageop_gui.h"
#include "dtgtk/expander.h"
 
#include "gui/draw.h"
#include "gui/gtk.h"
#include "gui/guides.h"
#include "gui/presets.h"
#include "iop/iop_api.h"
 
#include <assert.h>
#include <gdk/gdkkeysyms.h>
#include <gtk/gtk.h>
#include <inttypes.h>
#include <stdlib.h>
#include <string.h>
 
DT_MODULE_INTROSPECTION(1, dt_iop_crop_params_t)
 
 
typedef enum dt_iop_crop_flip_t
{
  FLAG_FLIP_HORIZONTAL = 1 << 0,
  FLAG_FLIP_VERTICAL = 1 << 1
} dt_iop_crop_flip_t;
 
typedef struct dt_iop_crop_aspect_t
{
  char *name;
  int d, n;
} dt_iop_crop_aspect_t;
 
typedef struct dt_iop_crop_params_t
{
  float cx;    // $MIN: 0.0 $MAX: 1.0 $DESCRIPTION: "left"
  float cy;    // $MIN: 0.0 $MAX: 1.0 $DESCRIPTION: "top"
  float cw;    // $MIN: 0.0 $MAX: 1.0 $DESCRIPTION: "right"
  float ch;    // $MIN: 0.0 $MAX: 1.0 $DESCRIPTION: "bottom"
  int ratio_n; // $DEFAULT: -1
  int ratio_d; // $DEFAULT: -1
} dt_iop_crop_params_t;
 
typedef enum _grab_region_t
{
  GRAB_CENTER = 0,                                            // 0
  GRAB_LEFT = 1 << 0,                                         // 1
  GRAB_TOP = 1 << 1,                                          // 2
  GRAB_RIGHT = 1 << 2,                                        // 4
  GRAB_BOTTOM = 1 << 3,                                       // 8
  GRAB_TOP_LEFT = GRAB_TOP | GRAB_LEFT,                       // 3
  GRAB_TOP_RIGHT = GRAB_TOP | GRAB_RIGHT,                     // 6
  GRAB_BOTTOM_RIGHT = GRAB_BOTTOM | GRAB_RIGHT,               // 12
  GRAB_BOTTOM_LEFT = GRAB_BOTTOM | GRAB_LEFT,                 // 9
  GRAB_HORIZONTAL = GRAB_LEFT | GRAB_RIGHT,                   // 5
  GRAB_VERTICAL = GRAB_TOP | GRAB_BOTTOM,                     // 10
  GRAB_ALL = GRAB_LEFT | GRAB_TOP | GRAB_RIGHT | GRAB_BOTTOM, // 15
  GRAB_NONE = 1 << 4                                          // 16
} _grab_region_t;
 
typedef struct dt_iop_crop_gui_data_t
{
  GtkWidget *cx, *cy, *cw, *ch;
  GList *aspect_list;
  GtkWidget *aspect_presets;
  GtkWidget *edit_button;
  GtkWidget *commit_button;
 
  float button_down_x, button_down_y;
  float button_down_zoom_x, button_down_zoom_y;
 
  /* current clip box */
  float clip_x, clip_y, clip_w, clip_h, handle_x, handle_y;
  /* last box before change */
  float prev_clip_x, prev_clip_y, prev_clip_w, prev_clip_h;
  /* maximum clip box */
  float clip_max_x, clip_max_y, clip_max_w, clip_max_h;
  // uint64_t clip_max_pipe_hash;
 
  float wd;
  float ht;
 
  int cropping;
  int editing;
  gboolean shift_hold;
  gboolean ctrl_hold;
  gboolean dragging;
  dt_gui_collapsible_section_t cs;
 
  dt_iop_crop_params_t previous_params;
 
} dt_iop_crop_gui_data_t;
 
typedef struct dt_iop_crop_data_t
{
  float aspect;         // forced aspect ratio
  float cx, cy, cw, ch; // crop window
} dt_iop_crop_data_t;
 
int legacy_params(dt_iop_module_t *self, const void *const old_params, const int old_version, void *new_params,
                  const int new_version)
{
  return 0;
}
 
const char *name()
{
  return _("crop");
}
 
const char *aliases()
{
  return _("reframe|distortion");
}
 
const char **description(struct dt_iop_module_t *self)
{
  return dt_iop_set_description(self, _("change the framing"), _("corrective or creative"),
                                _("linear, RGB, scene-referred"), _("geometric, RGB"),
                                _("linear, RGB, scene-referred"));
}
 
int default_group()
{
  return IOP_GROUP_EFFECTS;
}
 
int flags()
{
  return IOP_FLAGS_ALLOW_TILING | IOP_FLAGS_TILING_FULL_ROI | IOP_FLAGS_ONE_INSTANCE
         | IOP_FLAGS_GUIDES_SPECIAL_DRAW;
}
 
int operation_tags()
{
  return IOP_TAG_DISTORT | IOP_TAG_CLIPPING;
}
 
int operation_tags_filter()
{
  // switch off watermark, it gets confused.
  return IOP_TAG_DECORATION;
}
 
int default_colorspace(dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece)
{
  return IOP_CS_RGB;
}
 
static void _params_to_gui(dt_iop_crop_params_t *p, dt_iop_crop_gui_data_t *g)
{
  g->clip_x = p->cx;
  g->clip_w = p->cw - p->cx;
  g->clip_y = p->cy;
  g->clip_h = p->ch - p->cy;
}
 
/*
* FIXME: Why do we set gui -> params bounding box going through distort_backtransform (below)
* but we set params -> gui bounding box directly without using distort_transform (above) ???
* Does that roundrip ? If so, distort_backtransform is actually a no-op ?
*/
 
static void _commit_box(dt_iop_module_t *self, dt_iop_crop_gui_data_t *g, dt_iop_crop_params_t *p)
{
  dt_dev_pixelpipe_iop_t *piece = dt_dev_distort_get_iop_pipe(darktable.develop->virtual_pipe, self);
  if(IS_NULL_PTR(piece)) return;
  // we want value in iop space
  const float wd = (float)piece->buf_out.width; //self->dev->roi.preview_width;
  const float ht = (float)piece->buf_out.height; //self->dev->roi.preview_height;
 
  const float bbox_left   = g->clip_x * wd;
  const float bbox_top    = g->clip_y * ht;
  const float bbox_right  = (g->clip_x + g->clip_w) * wd;
  const float bbox_bottom = (g->clip_y + g->clip_h) * ht;
 
  dt_boundingbox_t points = { bbox_left, bbox_top, bbox_right, bbox_bottom };
 
  if(dt_dev_distort_backtransform_plus(darktable.develop->virtual_pipe, self->iop_order,
                                       DT_DEV_TRANSFORM_DIR_FORW_EXCL, points, 2))
  {
    //dt_dev_pixelpipe_iop_t *piece = dt_dev_distort_get_iop_pipe(self->dev->virtual_pipe, self);
    //if(piece)
    //{
      //fprintf(stderr, "buf_out size: %dx%d\n", piece->buf_out.width, piece->buf_out.height);
 
      if(piece->buf_out.width < 1 || piece->buf_out.height < 1) return;
      /*p->cx = CLAMPF(points[0] / (float)piece->buf_out.width, 0.0f, 0.9f);
      p->cy = CLAMPF(points[1] / (float)piece->buf_out.height, 0.0f, 0.9f);
      p->cw = CLAMPF(points[2] / (float)piece->buf_out.width, 0.1f, 1.0f);
      p->ch = CLAMPF(points[3] / (float)piece->buf_out.height, 0.1f, 1.0f);
      */
      p->cx = CLAMPF(points[0] / wd, 0.0f, 0.9f);
      p->cy = CLAMPF(points[1] / ht, 0.0f, 0.9f);
      p->cw = CLAMPF(points[2] / wd, 0.1f, 1.0f);
      p->ch = CLAMPF(points[3] / ht, 0.1f, 1.0f);
 
      /*fprintf(stderr, "Divisions: cx=%.1f/%d=%.4f, cy=%.1f/%d=%.4f, cw=%.1f/%d=%.4f, ch=%.1f/%d=%.4f\n",
        points[0], piece->buf_out.width, p->cx,
        points[1], piece->buf_out.height, p->cy,
        points[2], piece->buf_out.width, p->cw,
        points[3], piece->buf_out.height, p->ch);
        */
    //}
  }
 
  //fprintf(stderr, "_commit_box: cx:%.4f cy:%.4f cw:%.4f ch:%.4f\n", p->cx, p->cy, p->cw, p->ch);
  //fprintf(stderr, "_commit_box:  x:%.4f  y:%.4f  w:%.4f  h:%.4f\n", g->clip_x, g->clip_y, g->clip_w, g->clip_h);
}
 
static gboolean _set_max_clip(dt_dev_pixelpipe_t *pipe, struct dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
 
  // we want to know the size of the actual buffer
  dt_dev_pixelpipe_iop_t *piece = dt_dev_distort_get_iop_pipe(pipe, self);
  if(IS_NULL_PTR(piece)) return FALSE;
 
  float wp = piece->buf_out.width;
  float hp = piece->buf_out.height;
  float points[8] = { 0.0f, 0.0f, wp, hp, p->cx * wp, p->cy * hp, p->cw * wp, p->ch * hp };
  if(!dt_dev_distort_transform_plus(pipe, self->iop_order,
                                    DT_DEV_TRANSFORM_DIR_FORW_EXCL, points, 4))
    return FALSE;
  dt_dev_coordinates_preview_abs_to_image_norm(pipe->dev, points, 4);
 
  g->clip_max_x = fmaxf(points[0], 0.0f);
  g->clip_max_y = fmaxf(points[1], 0.0f);
  g->clip_max_w = fminf(points[2] - points[0], 1.0f);
  g->clip_max_h = fminf(points[3] - points[1], 1.0f);
 
  /*// if clipping values are not null, this is undistorted values...
  g->clip_x = fmaxf(points[4], g->clip_max_x);
  g->clip_y = fmaxf(points[5], g->clip_max_y);
  g->clip_w = fminf(points[6] - points[4], g->clip_max_w);
  g->clip_h = fminf(points[7] - points[5], g->clip_max_h);
*/
  return TRUE;
}
 
int distort_transform(dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece,
                      float *const restrict points, size_t points_count)
{
  dt_iop_crop_data_t *d = (dt_iop_crop_data_t *)piece->data;
 
  const float crop_top = piece->buf_in.height * d->cy;
  const float crop_left = piece->buf_in.width * d->cx;
 
  // nothing to be done if parameters are set to neutral values (no top/left border)
  if(crop_top == 0 && crop_left == 0) return 1;
  __OMP_PARALLEL_FOR_SIMD__(if(points_count > 100) aligned(points : 64))
  for(size_t i = 0; i < points_count * 2; i += 2)
  {
    points[i] -= crop_left;
    points[i + 1] -= crop_top;
  }
 
  return 1;
}
 
int distort_backtransform(dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece,
                          float *const restrict points, size_t points_count)
{
  dt_iop_crop_data_t *d = (dt_iop_crop_data_t *)piece->data;
 
  const float crop_top = piece->buf_in.height * d->cy;
  const float crop_left = piece->buf_in.width * d->cx;
 
  // nothing to be done if parameters are set to neutral values (no top/left border)
  if(crop_top == 0 && crop_left == 0) return 1;
  __OMP_PARALLEL_FOR_SIMD__(if(points_count > 100) aligned(points : 64))
  for(size_t i = 0; i < points_count * 2; i += 2)
  {
    points[i] += crop_left;
    points[i + 1] += crop_top;
  }
 
  return 1;
}
 
void distort_mask(struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                  struct dt_dev_pixelpipe_iop_t *piece, const float *const in, float *const out,
                  const dt_iop_roi_t *const roi_in, const dt_iop_roi_t *const roi_out)
{
  (void)self;
  (void)pipe;
  (void)piece;
  dt_iop_copy_image_roi(out, in, 1, roi_in, roi_out, TRUE);
}
 
// 1st pass: how large would the output be, given this input roi?
// this is always called with the full buffer before processing.
void modify_roi_out(struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                    struct dt_dev_pixelpipe_iop_t *piece, dt_iop_roi_t *roi_out,
                    const dt_iop_roi_t *roi_in)
{
  *roi_out = *roi_in;
  dt_iop_crop_data_t *d = (dt_iop_crop_data_t *)piece->data;
 
  roi_out->width = roi_in->width * (d->cw - d->cx);
  roi_out->height = roi_in->height * (d->ch - d->cy);
  roi_out->x = roi_in->width * d->cx;
  roi_out->y = roi_in->height * d->cy;
 
  // sanity check.
  if(roi_out->x < 0) roi_out->x = 0;
  if(roi_out->y < 0) roi_out->y = 0;
  if(roi_out->width < 5) roi_out->width = 5;
  if(roi_out->height < 5) roi_out->height = 5;
}
 
// 2nd pass: which roi would this operation need as input to fill the given output region?
void modify_roi_in(struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                   struct dt_dev_pixelpipe_iop_t *piece, const dt_iop_roi_t *roi_out, dt_iop_roi_t *roi_in)
{
  dt_iop_crop_data_t *d = (dt_iop_crop_data_t *)piece->data;
  *roi_in = *roi_out;
 
  const float iw = piece->buf_in.width * roi_out->scale;
  const float ih = piece->buf_in.height * roi_out->scale;
 
  roi_in->x += iw * d->cx;
  roi_in->y += ih * d->cy;
 
  roi_in->x = CLAMP(roi_in->x, 0, (int)floorf(iw));
  roi_in->y = CLAMP(roi_in->y, 0, (int)floorf(ih));
}
 
int process(struct dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece, const void *const ivoid,
             void *const ovoid)
{
  const dt_iop_roi_t *const roi_in = &piece->roi_in;
  const dt_iop_roi_t *const roi_out = &piece->roi_out;
  dt_iop_copy_image_roi(ovoid, ivoid, 4, roi_in, roi_out, TRUE);
  return 0;
}
 
#ifdef HAVE_OPENCL
int process_cl(struct dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece, cl_mem dev_in, cl_mem dev_out)
{
  const dt_iop_roi_t *const roi_out = &piece->roi_out;
  cl_int err = -999;
 
  size_t origin[] = { 0, 0, 0 };
  size_t region[] = { roi_out->width, roi_out->height, 1 };
  err = dt_opencl_enqueue_copy_image(pipe->devid, dev_in, dev_out, origin, origin, region);
  if(err != CL_SUCCESS) goto error;
 
  return TRUE;
 
error:
  dt_print(DT_DEBUG_OPENCL, "[opencl_crop] couldn't enqueue kernel! %d\n", err);
  return FALSE;
}
#endif
 
void commit_params(struct dt_iop_module_t *self, dt_iop_params_t *p1, dt_dev_pixelpipe_t *pipe,
                   dt_dev_pixelpipe_iop_t *piece)
{
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)p1;
  dt_iop_crop_data_t *d = (dt_iop_crop_data_t *)piece->data;
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
 
  if(!IS_NULL_PTR(g) && g->editing)
  {
    // In editing mode, we need to see the full uncropped image
    // to setup the frame.
    d->cx = 0.0f;
    d->cy = 0.0f;
    d->cw = 1.0f;
    d->ch = 1.0f;
  }
  else
  {
    d->cx = CLAMPF(p->cx, 0.0f, 0.9f);
    d->cy = CLAMPF(p->cy, 0.0f, 0.9f);
    d->cw = CLAMPF(p->cw, 0.1f, 1.0f);
    d->ch = CLAMPF(p->ch, 0.1f, 1.0f);
  }
}
 
gboolean runtime_data_hash(struct dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe,
                           const dt_dev_pixelpipe_iop_t *piece)
{
  (void)self;
  (void)pipe;
  (void)piece;
  return TRUE;
}
 
void init_pipe(struct dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe, dt_dev_pixelpipe_iop_t *piece)
{
  piece->data = dt_calloc_align(sizeof(dt_iop_crop_data_t));
  piece->data_size = sizeof(dt_iop_crop_data_t);
}
 
void cleanup_pipe(struct dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe, dt_dev_pixelpipe_iop_t *piece)
{
  dt_free_align(piece->data);
  piece->data = NULL;
}
 
static float _aspect_ratio_get(dt_iop_module_t *self, GtkWidget *combo)
{
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
 
  // retrieve full image dimensions to calculate aspect ratio if "original image" specified
  const char *text = dt_bauhaus_combobox_get_text(combo);
  if(text && !g_strcmp0(text, _("original image")))
  {
    int proc_iwd = 0, proc_iht = 0;
    dt_dev_get_processed_size(darktable.develop, &proc_iwd, &proc_iht);
 
    if(!(proc_iwd > 0 && proc_iht > 0)) return 0.0f;
 
    if((p->ratio_d > 0 && proc_iwd > proc_iht) || (p->ratio_d < 0 && proc_iwd < proc_iht))
      return (float)proc_iwd / (float)proc_iht;
    else
      return (float)proc_iht / (float)proc_iwd;
  }
 
  // we want to know the size of the actual buffer
  dt_dev_pixelpipe_iop_t *piece = dt_dev_distort_get_iop_pipe(self->dev->virtual_pipe, self);
  if(IS_NULL_PTR(piece)) return 0.0f;
 
  const int iwd = piece->buf_in.width, iht = piece->buf_in.height;
 
  // if we do not have yet computed the aspect ratio, let's do it now
  if(p->ratio_d == -2 && p->ratio_n == -2)
  {
    if(p->cw == 1.0 && p->cx == 0.0 && p->ch == 1.0 && p->cy == 0.0)
    {
      p->ratio_d = -1;
      p->ratio_n = -1;
    }
    else
    {
      const struct dt_interpolation *interpolation = dt_interpolation_new(DT_INTERPOLATION_USERPREF_WARP);
      const float whratio = ((float)(iwd - 2 * interpolation->width) * (p->cw - p->cx))
                            / ((float)(iht - 2 * interpolation->width) * (p->ch - p->cy));
      const float ri = (float)iwd / (float)iht;
 
      const float prec = 0.0003f;
      if(fabsf(whratio - 3.0f / 2.0f) < prec)
      {
        p->ratio_d = 3;
        p->ratio_n = 2;
      }
      else if(fabsf(whratio - 2.0f / 1.0f) < prec)
      {
        p->ratio_d = 2;
        p->ratio_n = 1;
      }
      else if(fabsf(whratio - 7.0f / 5.0f) < prec)
      {
        p->ratio_d = 7;
        p->ratio_n = 5;
      }
      else if(fabsf(whratio - 4.0f / 3.0f) < prec)
      {
        p->ratio_d = 4;
        p->ratio_n = 3;
      }
      else if(fabsf(whratio - 5.0f / 4.0f) < prec)
      {
        p->ratio_d = 5;
        p->ratio_n = 4;
      }
      else if(fabsf(whratio - 1.0f / 1.0f) < prec)
      {
        p->ratio_d = 1;
        p->ratio_n = 1;
      }
      else if(fabsf(whratio - 16.0f / 9.0f) < prec)
      {
        p->ratio_d = 16;
        p->ratio_n = 9;
      }
      else if(fabsf(whratio - 16.0f / 10.0f) < prec)
      {
        p->ratio_d = 16;
        p->ratio_n = 10;
      }
      else if(fabsf(whratio - 244.5f / 203.2f) < prec)
      {
        p->ratio_d = 2445;
        p->ratio_n = 2032;
      }
      else if(fabsf(whratio - sqrtf(2.0f)) < prec)
      {
        p->ratio_d = 14142136;
        p->ratio_n = 10000000;
      }
      else if(fabsf(whratio - PHI) < prec)
      {
        p->ratio_d = 16180340;
        p->ratio_n = 10000000;
      }
      else if(fabsf(whratio - ri) < prec)
      {
        p->ratio_d = 1;
        p->ratio_n = 0;
      }
      else
      {
        p->ratio_d = 0;
        p->ratio_n = 0;
      }
    }
  }
 
  if(p->ratio_d == 0 && p->ratio_n == 0) return -1.0f;
  float d = 1.0f, n = 1.0f;
  if(p->ratio_n == 0)
  {
    d = copysignf(iwd, p->ratio_d);
    n = iht;
  }
  else
  {
    d = p->ratio_d;
    n = p->ratio_n;
  }
 
  // make aspect ratios like 3:2 and 2:3 to be the same thing
  const float dn = copysignf(MAX(fabsf(d), fabsf(n)), d);
  const float nn = copysignf(MIN(fabsf(d), fabsf(n)), n);
 
  if(dn < 0)
    return -nn / dn;
  else
    return dn / nn;
}
 
static void _aspect_apply(dt_iop_module_t *self, _grab_region_t grab)
{
  if(grab == GRAB_NONE) return;
 
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
 
  // enforce aspect ratio.
  float aspect = _aspect_ratio_get(self, g->aspect_presets);
  if(aspect <= 0) return;
 
  int iwd, iht;
  dt_dev_get_processed_size(darktable.develop, &iwd, &iht);
 
  // since one rarely changes between portrait and landscape by cropping,
  // long side of the crop box should match the long side of the image.
  if(iwd < iht) aspect = 1.0f / aspect;
 
  // if only one side changed, force aspect by two adjacent in equal parts
  // 1 2 4 8 : x y w h
  double clip_x = MAX(iwd * g->clip_x / (float)iwd, 0.0f);
  double clip_y = MAX(iht * g->clip_y / (float)iht, 0.0f);
  double clip_w = MIN(iwd * g->clip_w / (float)iwd, 1.0f);
  double clip_h = MIN(iht * g->clip_h / (float)iht, 1.0f);
 
  // if we only modified one dim, respectively, we wanted these values:
  const double target_h = (double)iwd * g->clip_w / ((double)iht * aspect);
  const double target_w = (double)iht * g->clip_h * aspect / (double)iwd;
  // i.e. target_w/h = w/target_h = aspect
  // first fix aspect ratio:
 
  // corners: move two adjacent
  if(grab == GRAB_TOP_LEFT)
  {
    // move x y
    clip_x = clip_x + clip_w - (target_w + clip_w) * .5;
    clip_y = clip_y + clip_h - (target_h + clip_h) * .5;
    clip_w = (target_w + clip_w) * .5;
    clip_h = (target_h + clip_h) * .5;
  }
  else if(grab == GRAB_TOP_RIGHT) // move y w
  {
    clip_y = clip_y + clip_h - (target_h + clip_h) * .5;
    clip_w = (target_w + clip_w) * .5;
    clip_h = (target_h + clip_h) * .5;
  }
  else if(grab == GRAB_BOTTOM_RIGHT) // move w h
  {
    clip_w = (target_w + clip_w) * .5;
    clip_h = (target_h + clip_h) * .5;
  }
  else if(grab == GRAB_BOTTOM_LEFT) // move h x
  {
    clip_h = (target_h + clip_h) * .5;
    clip_x = clip_x + clip_w - (target_w + clip_w) * .5;
    clip_w = (target_w + clip_w) * .5;
  }
  else if(grab & GRAB_HORIZONTAL) // dragged either x or w (1 4)
  {
    // change h and move y, h equally
    const double off = target_h - clip_h;
    clip_h = clip_h + off;
    clip_y = clip_y - .5 * off;
  }
  else if(grab & GRAB_VERTICAL) // dragged either y or h (2 8)
  {
    // change w and move x, w equally
    const double off = target_w - clip_w;
    clip_w = clip_w + off;
    clip_x = clip_x - .5 * off;
  }
  // now fix outside boxes:
  if(clip_x < g->clip_max_x)
  {
    const double prev_clip_h = clip_h;
    clip_h *= (clip_w + clip_x - g->clip_max_x) / clip_w;
    clip_w = clip_w + clip_x - g->clip_max_x;
    clip_x = g->clip_max_x;
    if(grab & GRAB_TOP) clip_y += prev_clip_h - clip_h;
  }
  if(clip_y < g->clip_max_y)
  {
    const double prev_clip_w = clip_w;
    clip_w *= (clip_h + clip_y - g->clip_max_y) / clip_h;
    clip_h = clip_h + clip_y - g->clip_max_y;
    clip_y = g->clip_max_y;
    if(grab & GRAB_LEFT) clip_x += prev_clip_w - clip_w;
  }
  if(clip_x + clip_w > g->clip_max_x + g->clip_max_w)
  {
    const double prev_clip_h = clip_h;
    clip_h *= (g->clip_max_x + g->clip_max_w - clip_x) / clip_w;
    clip_w = g->clip_max_x + g->clip_max_w - clip_x;
    if(grab & GRAB_TOP) clip_y += prev_clip_h - clip_h;
  }
  if(clip_y + clip_h > g->clip_max_y + g->clip_max_h)
  {
    const double prev_clip_w = clip_w;
    clip_w *= (g->clip_max_y + g->clip_max_h - clip_y) / clip_h;
    clip_h = g->clip_max_y + g->clip_max_h - clip_y;
    if(grab & GRAB_LEFT) clip_x += prev_clip_w - clip_w;
  }
  g->clip_x = fmaxf(clip_x, 0.0f);
  g->clip_y = fmaxf(clip_y, 0.0f);
  g->clip_w = fminf(clip_w, 1.0f);
  g->clip_h = fminf(clip_h, 1.0f);
}
 
void reload_defaults(dt_iop_module_t *self)
{
  const dt_image_t *img = &self->dev->image_storage;
 
  dt_iop_crop_params_t *d = (dt_iop_crop_params_t *)self->default_params;
 
  d->cx = img->usercrop[1];
  d->cy = img->usercrop[0];
  d->cw = img->usercrop[3];
  d->ch = img->usercrop[2];
}
 
gboolean has_defaults(struct dt_iop_module_t *self)
{
  dt_iop_crop_params_t *d = (dt_iop_crop_params_t *)self->default_params;
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
  // p->ratio_d and p->ratio_n are inited in GUI, so they are unset in d.
  return d->cx == p->cx && d->cy == p->cy && d->cw == p->cw && d->ch && p->cw;
}
 
static void _float_to_fract(const char *num, int *n, int *d)
{
  char tnum[100];
  gboolean sep_found = FALSE;
  char *p = (char *)num;
  int k = 0;
 
  *d = 1;
 
  while(*p)
  {
    if(sep_found) *d *= 10;
 
    // look for decimal sep
    if(!sep_found && ((*p == ',') || (*p == '.')))
    {
      sep_found = TRUE;
    }
    else if(*p < '0' || *p > '9')
    {
      *n = *d = 0;
      return;
    }
    else
    {
      tnum[k++] = *p;
    }
 
    p++;
  }
 
  tnum[k] = '\0';
 
  *n = atoi(tnum);
}
 
static void _event_aspect_presets_changed(GtkWidget *combo, dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
  const int which = dt_bauhaus_combobox_get(combo);
  int d = abs(p->ratio_d), n = p->ratio_n;
  const char *text = dt_bauhaus_combobox_get_text(combo);
  if(which < 0)
  {
    if(!IS_NULL_PTR(text))
    {
      const char *c = text;
      const char *end = text + strlen(text);
      while(*c != ':' && *c != '/' && c < end) c++;
      if(c < end - 1)
      {
        // input the exact fraction
        c++;
        const int dd = atoi(text);
        const int nn = atoi(c);
        // some sanity check
        if(nn == 0 || dd == 0)
        {
          dt_control_log(_("invalid ratio format. it should be \"number:number\""));
          dt_bauhaus_combobox_set(combo, 0);
          return;
        }
        d = MAX(dd, nn);
        n = MIN(dd, nn);
      }
      else
      {
        // find the closest fraction from the input ratio
        int nn = 0, dd = 0;
        _float_to_fract(text, &nn, &dd);
 
        // some sanity check
        if(dd == 0 || nn == 0)
        {
          dt_control_log(_("invalid ratio format. it should be a positive number"));
          dt_bauhaus_combobox_set(combo, 0);
          return;
        }
 
        d = MAX(dd, nn);
        n = MIN(dd, nn);
      }
 
      // simplify the fraction with binary GCD - https://en.wikipedia.org/wiki/Greatest_common_divisor
      // search g and d such that g is odd and gcd(nn, dd) = g x 2^d
      int e = 0;
      int nn = abs(n);
      int dd = abs(d);
      while((nn % 2 == 0) && (dd % 2 == 0))
      {
        nn /= 2;
        dd /= 2;
        e++;
      }
      while(nn != dd)
      {
        if(nn % 2 == 0)
          nn /= 2;
        else if(dd % 2 == 0)
          dd /= 2;
        else if(nn > dd)
          nn = (nn - dd) / 2;
        else
          dd = (dd - nn) / 2;
      }
 
      // reduce the fraction with the GCD
      n /= (nn * 1 << e);
      d /= (nn * 1 << e);
    }
  }
  else
  {
    d = n = 0;
 
    for(const GList *iter = g->aspect_list; iter; iter = g_list_next(iter))
    {
      const dt_iop_crop_aspect_t *aspect = iter->data;
      if(g_strcmp0(aspect->name, text) == 0)
      {
        d = aspect->d;
        n = aspect->n;
        break;
      }
    }
  }
 
  // now we save all that if it has changed
  if(d != abs(p->ratio_d) || n != p->ratio_n)
  {
    if(p->ratio_d >= 0)
      p->ratio_d = d;
    else
      p->ratio_d = -d;
 
    p->ratio_n = n;
    dt_conf_set_int("plugins/darkroom/crop/ratio_d", abs(p->ratio_d));
    dt_conf_set_int("plugins/darkroom/crop/ratio_n", abs(p->ratio_n));
    if(darktable.gui->reset) return;
  }
 
  // Search if current aspect ratio matches something known
  int act = -1;
  int i = 0;
 
  for(const GList *iter = g->aspect_list; iter; iter = g_list_next(iter))
  {
    const dt_iop_crop_aspect_t *aspect = iter->data;
    if((aspect->d == d) && (aspect->n == n))
    {
      act = i;
      break;
    }
    i++;
  }
 
  // Update combobox label
  ++darktable.gui->reset;
 
  if(act == -1)
  {
    // we got a custom ratio
    char str[128];
    snprintf(str, sizeof(str), "%d:%d %2.2f", abs(p->ratio_d), abs(p->ratio_n),
             (float)abs(p->ratio_d) / (float)abs(p->ratio_n));
    dt_bauhaus_combobox_set_text(g->aspect_presets, str);
  }
  else if(dt_bauhaus_combobox_get(g->aspect_presets) != act)
    // we got a default ratio
    dt_bauhaus_combobox_set(g->aspect_presets, act);
 
  --darktable.gui->reset;
 
  if(!darktable.gui->reset) gui_changed(self, g->aspect_presets, NULL);
}
 
void gui_changed(dt_iop_module_t *self, GtkWidget *w, void *previous)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
 
  ++darktable.gui->reset;
 
  if(w == g->cx)
  {
    g->clip_w = g->clip_x + g->clip_w - p->cx;
    g->clip_x = p->cx;
    _aspect_apply(self, GRAB_LEFT);
  }
  else if(w == g->cw)
  {
    g->clip_w = p->cw - g->clip_x;
    _aspect_apply(self, GRAB_RIGHT);
  }
  else if(w == g->cy)
  {
    g->clip_h = g->clip_y + g->clip_h - p->cy;
    g->clip_y = p->cy;
    _aspect_apply(self, GRAB_TOP);
  }
  else if(w == g->ch)
  {
    g->clip_h = p->ch - g->clip_y;
    _aspect_apply(self, GRAB_BOTTOM);
  }
  else if(w == g->aspect_presets)
  {
    _aspect_apply(self, GRAB_ALL);
  }
 
  // update all sliders, as their values may have change to keep aspect ratio
  dt_bauhaus_slider_set(g->cx, g->clip_x);
  dt_bauhaus_slider_set_soft_min(g->cw, g->clip_x + 0.10);
  dt_bauhaus_slider_set(g->cy, g->clip_y);
  dt_bauhaus_slider_set_soft_min(g->ch, g->clip_y + 0.10);
  dt_bauhaus_slider_set(g->cw, g->clip_x + g->clip_w);
  dt_bauhaus_slider_set_soft_max(g->cx, g->clip_x + g->clip_w - 0.10);
  dt_bauhaus_slider_set(g->ch, g->clip_y + g->clip_h);
  dt_bauhaus_slider_set_soft_max(g->cy, g->clip_y + g->clip_h - 0.10);
 
  --darktable.gui->reset;
 
  _commit_box(self, g, p);
  dt_control_queue_redraw_center();
  dt_control_navigation_redraw();
}
 
void gui_reset(struct dt_iop_module_t *self)
{
  /* reset aspect preset to default */
  dt_conf_set_int("plugins/darkroom/crop/ratio_d", 0);
  dt_conf_set_int("plugins/darkroom/crop/ratio_n", 0);
}
 
void gui_update(struct dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
 
  //  set aspect ratio based on the current image, if not found let's default
  //  to free aspect.
 
  if(p->ratio_d == -2 && p->ratio_n == -2) _aspect_ratio_get(self, g->aspect_presets);
 
  if(p->ratio_d == -1 && p->ratio_n == -1)
  {
    p->ratio_d = dt_conf_get_int("plugins/darkroom/crop/ratio_d");
    p->ratio_n = dt_conf_get_int("plugins/darkroom/crop/ratio_n");
  }
 
  const int d = abs(p->ratio_d);
  const int n = p->ratio_n;
 
  int act = -1;
  int i = 0;
  for(const GList *iter = g->aspect_list; iter; iter = g_list_next(iter))
  {
    const dt_iop_crop_aspect_t *aspect = iter->data;
    if((aspect->d == d) && (aspect->n == n))
    {
      act = i;
      break;
    }
    i++;
  }
 
  /* special handling the combobox when current act is already selected
     callback is not called, let do it our self then..
   */
  if(act == -1)
  {
    char str[128];
    snprintf(str, sizeof(str), "%d:%d %2.2f", abs(p->ratio_d), abs(p->ratio_n),
             (float)abs(p->ratio_d) / (float)abs(p->ratio_n));
    dt_bauhaus_combobox_set_text(g->aspect_presets, str);
  }
  if(dt_bauhaus_combobox_get(g->aspect_presets) == act)
    _event_aspect_presets_changed(g->aspect_presets, self);
  else
    dt_bauhaus_combobox_set(g->aspect_presets, act);
 
  // reset gui draw box to what we have in the parameters:
  _params_to_gui(p, g);
 
  dt_gui_update_collapsible_section(&g->cs);
}
 
static void _event_key_swap(dt_iop_module_t *self)
{
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
  p->ratio_d = -p->ratio_d;
  _aspect_apply(self, GRAB_ALL);
  gui_changed(self, NULL, NULL);
}
 
static void _enter_edit_mode(GtkToggleButton *button, struct dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  dt_iop_crop_params_t *p = (dt_iop_crop_params_t *)self->params;
  if(!self->enabled) dt_dev_add_history_item(self->dev, self, TRUE, TRUE);
 
  g->editing = gtk_toggle_button_get_active(button);
  dt_control_change_cursor(GDK_LEFT_PTR);
  dt_iop_request_focus(self);
 
  if(g->editing)
  {
    dt_iop_set_cache_bypass(self, TRUE);
 
    // Take a backup of current params
    memcpy(&g->previous_params, p, sizeof(dt_iop_crop_params_t));
    g->cropping = GRAB_CENTER;
    g->dragging = FALSE;
    gtk_button_set_label(GTK_BUTTON(button), _("Cancel"));
    gtk_widget_set_sensitive(g->commit_button, TRUE);
    dt_control_queue_redraw_center();
    dt_control_navigation_redraw();
  }
  else
  {
    dt_iop_set_cache_bypass(self, FALSE);
 
    // Restore the params backup
    memcpy(p, &g->previous_params, sizeof(dt_iop_crop_params_t));
    g->cropping = GRAB_NONE;
 
    // Commit the params backup
    _params_to_gui(p, g);
    gui_changed(self, NULL, NULL);
 
    // Update GUI
    gtk_button_set_label(GTK_BUTTON(button), _("Edit"));
    gtk_widget_set_sensitive(g->commit_button, FALSE);
  }
 
  // It sucks that we need to invalidate the preview too but we need its final dimension.
  dt_dev_pixelpipe_resync_history_all(self->dev);
  dt_dev_get_thumbnail_size(self->dev);
}
 
static void _event_commit_clicked(GtkButton *button, dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
 
  // Close edit mode on commit
  g->editing = FALSE;
  gtk_widget_set_sensitive(g->commit_button, FALSE);
  dt_iop_set_cache_bypass(self, FALSE);
 
  // Commit history and refresh view
  dt_dev_add_history_item(darktable.develop, self, TRUE, TRUE);
  dt_dev_get_thumbnail_size(self->dev);
 
  // The following will de-activate the edit button and trigger the callback.
  // Prevent the callback to revert the param change.
  g_signal_handlers_block_by_func(g->edit_button, _enter_edit_mode, self);
  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g->edit_button), FALSE);
  gtk_button_set_label(GTK_BUTTON(g->edit_button), _("Edit"));
  g_signal_handlers_unblock_by_func(g->edit_button, _enter_edit_mode, self);
}
 
static void _event_aspect_flip(GtkWidget *button, dt_iop_module_t *self)
{
  _event_key_swap(self);
}
 
static gint _aspect_ratio_cmp(const dt_iop_crop_aspect_t *a, const dt_iop_crop_aspect_t *b)
{
  // want most square at the end, and the most non-square at the beginning
 
  if((a->d == 0 || a->d == 1) && a->n == 0) return -1;
 
  const float ad = MAX(a->d, a->n);
  const float an = MIN(a->d, a->n);
  const float bd = MAX(b->d, b->n);
  const float bn = MIN(b->d, b->n);
  const float aratio = ad / an;
  const float bratio = bd / bn;
 
  if(aratio < bratio) return -1;
 
  const float prec = 0.0003f;
  if(fabsf(aratio - bratio) < prec) return 0;
 
  return 1;
}
 
static gchar *_aspect_format(gchar *original, int adim, int bdim)
{
  // Special ratios:  freehand, original image
  if(bdim == 0) return g_strdup(original);
 
  return g_strdup_printf("%s  %4.2f", original, (float)adim / (float)bdim);
}
 
void gui_init(struct dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = IOP_GUI_ALLOC(crop);
 
  g->aspect_list = NULL;
  g->clip_x = g->clip_y = g->handle_x = g->handle_y = 0.0;
  g->clip_w = g->clip_h = 1.0;
  g->clip_max_x = g->clip_max_y = 0.0;
  g->clip_max_w = g->clip_max_h = 1.0;
  //g->clip_max_pipe_hash = 0;
  g->cropping = GRAB_CENTER;
  g->shift_hold = FALSE;
  g->ctrl_hold = FALSE;
  g->editing = FALSE;
  g->dragging = FALSE;
 
  GtkWidget *box_enabled = gtk_box_new(GTK_ORIENTATION_VERTICAL, DT_GUI_BOX_SPACING);
 
  dt_iop_crop_aspect_t aspects[] = {
    { _("freehand"), 0, 0 },
    { _("original image"), 1, 0 },
    { _("square"), 1, 1 },
    { _("7:6, 6x7"), 7, 6 },
    { _("10:8 in print"), 2445, 2032 },
    { _("6:5, 5x6"), 6, 5 },
    { _("5:4, 4x5, 8x10"), 5, 4 },
    { _("11x14"), 14, 11 },
    { _("8.5x11, letter"), 110, 85 },
    { _("4:3, VGA, TV"), 4, 3 },
    { _("5x7"), 7, 5 },
    { _("ISO 216, DIN 476, A4"), 14142136, 10000000 },
    { _("3:2, 4x6, 35mm"), 3, 2 },
    { _("16:10, 8x5"), 16, 10 },
    { _("golden cut"), 16180340, 10000000 },
    { _("5:3, 12x20"), 5, 3 },
    { _("16:9, HDTV"), 16, 9 },
    { _("widescreen"), 185, 100 },
    { _("2:1, Univisium"), 2, 1 },
    { _("Cinemascope"), 235, 100 },
    { _("21:9"), 7, 3 },
    { _("Anamorphic"), 239, 100 },
    { _("65:24, XPan"), 65, 24 },
    { _("3:1, panorama"), 3, 1 },
    { _("4:1, Polyvision"), 4, 1 },
  };
 
  const int aspects_count = sizeof(aspects) / sizeof(dt_iop_crop_aspect_t);
 
  for(int i = 0; i < aspects_count; i++)
  {
    dt_iop_crop_aspect_t *aspect = g_malloc(sizeof(dt_iop_crop_aspect_t));
    aspect->name = _aspect_format(aspects[i].name, aspects[i].d, aspects[i].n);
    aspect->d = aspects[i].d;
    aspect->n = aspects[i].n;
    g->aspect_list = g_list_append(g->aspect_list, aspect);
  }
 
  // add custom presets from config to the list
  GSList *custom_aspects = dt_conf_all_string_entries("plugins/darkroom/clipping/extra_aspect_ratios");
  for(GSList *iter = custom_aspects; iter; iter = g_slist_next(iter))
  {
    dt_conf_string_entry_t *nv = (dt_conf_string_entry_t *)iter->data;
 
    const char *c = nv->value;
    const char *end = nv->value + strlen(nv->value);
    while(*c != ':' && *c != '/' && c < end) c++;
    if(c < end - 1)
    {
      c++;
      int d = atoi(nv->value);
      int n = atoi(c);
      // some sanity check
      if(n == 0 || d == 0)
      {
        fprintf(stderr, "invalid ratio format for `%s'. it should be \"number:number\"\n", nv->key);
        dt_control_log(_("invalid ratio format for `%s'. it should be \"number:number\""), nv->key);
        continue;
      }
      dt_iop_crop_aspect_t *aspect = g_malloc(sizeof(dt_iop_crop_aspect_t));
      aspect->name = _aspect_format(nv->key, d, n);
      aspect->d = d;
      aspect->n = n;
      g->aspect_list = g_list_append(g->aspect_list, aspect);
    }
    else
    {
      fprintf(stderr, "invalid ratio format for `%s'. it should be \"number:number\"\n", nv->key);
      dt_control_log(_("invalid ratio format for `%s'. it should be \"number:number\""), nv->key);
      continue;
    }
  }
  g_slist_free_full(custom_aspects, dt_conf_string_entry_free);
 
 
  g->aspect_list = g_list_sort(g->aspect_list, (GCompareFunc)_aspect_ratio_cmp);
 
  // remove duplicates from the aspect ratio list
  int d = ((dt_iop_crop_aspect_t *)g->aspect_list->data)->d + 1;
  int n = ((dt_iop_crop_aspect_t *)g->aspect_list->data)->n + 1;
  for(GList *iter = g->aspect_list; iter; iter = g_list_next(iter))
  {
    dt_iop_crop_aspect_t *aspect = (dt_iop_crop_aspect_t *)iter->data;
    int dd = MIN(aspect->d, aspect->n);
    int nn = MAX(aspect->d, aspect->n);
    if(dd == d && nn == n)
    {
      // same as the last one, remove this entry
      dt_free(aspect->name);
      GList *prev = g_list_previous(iter);
      g->aspect_list = g_list_delete_link(g->aspect_list, iter);
      // it should never be NULL as the 1st element can't be a duplicate, but better safe than sorry
      iter = prev ? prev : g->aspect_list;
    }
    else
    {
      d = dd;
      n = nn;
    }
  }
 
  g->aspect_presets = dt_bauhaus_combobox_new(darktable.bauhaus, DT_GUI_MODULE(self));
  dt_bauhaus_combobox_set_editable(g->aspect_presets, 1);
  dt_bauhaus_widget_set_label(g->aspect_presets, N_("aspect"));
 
  for(GList *iter = g->aspect_list; iter; iter = g_list_next(iter))
  {
    const dt_iop_crop_aspect_t *aspect = iter->data;
    dt_bauhaus_combobox_add(g->aspect_presets, aspect->name);
  }
 
  dt_bauhaus_combobox_set(g->aspect_presets, 0);
 
  g_signal_connect(G_OBJECT(g->aspect_presets), "value-changed", G_CALLBACK(_event_aspect_presets_changed), self);
  gtk_widget_set_tooltip_text(g->aspect_presets, _("set the aspect ratio\n"
                                                   "the list is sorted: from most square to least square\n"
                                                   "to enter custom aspect ratio open the combobox and type ratio in x:y or decimal format"));
  dt_bauhaus_widget_set_quad_toggle(g->aspect_presets, 1);
  dt_bauhaus_widget_set_quad_paint(g->aspect_presets, dtgtk_cairo_paint_aspectflip, 0, NULL);
  g_signal_connect(G_OBJECT(g->aspect_presets), "quad-pressed", G_CALLBACK(_event_aspect_flip), self);
  gtk_box_pack_start(GTK_BOX(box_enabled), g->aspect_presets, TRUE, TRUE, 0);
 
  GtkWidget *box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, DT_GUI_BOX_SPACING);
 
  g->edit_button = gtk_toggle_button_new_with_label(_("Edit"));
  g_signal_connect(GTK_TOGGLE_BUTTON(g->edit_button), "toggled", G_CALLBACK(_enter_edit_mode), self);
  gtk_box_pack_start(GTK_BOX(box), g->edit_button, TRUE, TRUE, 0);
 
  g->commit_button = dt_action_button_new((dt_lib_module_t *)self, N_("Apply"), _event_commit_clicked, self, _("Apply changes"), 0, 0);
  gtk_box_pack_start(GTK_BOX(box), g->commit_button, TRUE, TRUE, 0);
  gtk_widget_set_sensitive(g->commit_button, FALSE);
 
  gtk_box_pack_end(GTK_BOX(box_enabled), GTK_WIDGET(box), TRUE, TRUE, 0);
 
 
  // we put margins values under an expander
  dt_gui_new_collapsible_section
    (&g->cs,
     "plugins/darkroom/crop/expand_margins",
     _("margins"),
     GTK_BOX(box_enabled), GTK_PACK_END);
 
  self->widget = GTK_WIDGET(g->cs.container);
 
  g->cx = dt_bauhaus_slider_from_params(self, "cx");
  dt_bauhaus_slider_set_digits(g->cx, 4);
  dt_bauhaus_slider_set_format(g->cx, "%");
  gtk_widget_set_tooltip_text(g->cx, _("the left margin cannot overlap with the right margin"));
 
  g->cw = dt_bauhaus_slider_from_params(self, "cw");
  dt_bauhaus_slider_set_digits(g->cw, 4);
  dt_bauhaus_slider_set_factor(g->cw, -100.0);
  dt_bauhaus_slider_set_offset(g->cw, 100.0);
  dt_bauhaus_slider_set_format(g->cw, "%");
  gtk_widget_set_tooltip_text(g->cw, _("the right margin cannot overlap with the left margin"));
 
  g->cy = dt_bauhaus_slider_from_params(self, "cy");
  dt_bauhaus_slider_set_digits(g->cy, 4);
  dt_bauhaus_slider_set_format(g->cy, "%");
  gtk_widget_set_tooltip_text(g->cy, _("the top margin cannot overlap with the bottom margin"));
 
  g->ch = dt_bauhaus_slider_from_params(self, "ch");
  dt_bauhaus_slider_set_digits(g->ch, 4);
  dt_bauhaus_slider_set_factor(g->ch, -100.0);
  dt_bauhaus_slider_set_offset(g->ch, 100.0);
  dt_bauhaus_slider_set_format(g->ch, "%");
  gtk_widget_set_tooltip_text(g->ch, _("the bottom margin cannot overlap with the top margin"));
 
  self->widget = box_enabled;
}
 
static void _aspect_free(gpointer data)
{
  dt_iop_crop_aspect_t *aspect = (dt_iop_crop_aspect_t *)data;
  dt_free(aspect->name);
  dt_free(aspect);
}
 
void gui_cleanup(struct dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  g_list_free_full(g->aspect_list, _aspect_free);
  g->aspect_list = NULL;
 
  IOP_GUI_FREE;
}
 
static _grab_region_t _gui_get_grab(float pzx, float pzy, dt_iop_crop_gui_data_t *g, const float border,
                                    const float wd, const float ht)
{
  if(wd == 0.f || ht == 0.f) return GRAB_NONE;
 
  _grab_region_t grab = GRAB_NONE;
  if(!(pzx < g->clip_x || pzx > g->clip_x + g->clip_w || pzy < g->clip_y || pzy > g->clip_y + g->clip_h))
  {
    // we are inside the crop box
 
    const float x_border = (border == 0.f) ? 0.f : border / wd;
    const float y_border = (border == 0.f) ? 0.f : border / ht;
 
    grab = GRAB_CENTER;
 
    if((pzx >= g->clip_x) && pzx < g->clip_x + x_border)
     grab |= GRAB_LEFT; // left border
 
    if((pzy >= g->clip_y) && pzy < g->clip_y + y_border)
      grab |= GRAB_TOP; // top border
 
    if((pzx <= g->clip_x + g->clip_w) && (pzx > g->clip_w + g->clip_x - x_border))
      grab |= GRAB_RIGHT; // right border
 
    if((pzy <= g->clip_y + g->clip_h) && (pzy > g->clip_h + g->clip_y - y_border))
      grab |= GRAB_BOTTOM; // bottom border
  }
  return grab;
}
 
// draw guides and handles over the image
void gui_post_expose(struct dt_iop_module_t *self, cairo_t *cr, int32_t width, int32_t height, int32_t pointerx,
                     int32_t pointery)
{
  dt_develop_t *dev = self->dev;
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  if(IS_NULL_PTR(g)) return;
 
  _aspect_apply(self, GRAB_HORIZONTAL);
 
  g->wd = dev->roi.preview_width;
  g->ht = dev->roi.preview_height;
  if(g->wd < 1.0 || g->ht < 1.0) return;
 
  const float zoom_scale = dt_dev_get_overlay_scale(dev);
 
  dt_dev_clip_roi(dev, cr, width, height);
  dt_dev_rescale_roi(dev, cr, width, height);
 
  // draw crop area guides
  const float guide_x = g->editing ? g->clip_x * g->wd : 0;
  const float guide_y = g->editing ? g->clip_y * g->ht : 0;
  const float guide_w = g->editing ? g->clip_w * g->wd : g->wd;
  const float guide_h = g->editing ? g->clip_h * g->ht : g->ht;
  
  dt_guides_draw(cr, guide_x, guide_y, guide_w, guide_h, zoom_scale);
 
  if(!g->editing) return;
 
  double dashes = DT_PIXEL_APPLY_DPI(5.0) / zoom_scale;
  double border_width = dashes / 2.;
 
  // draw cropping window
  float pzxpy[2] = { (float)pointerx, (float)pointery };
  dt_dev_coordinates_widget_to_image_norm(dev, pzxpy, 1);
  float pzx = pzxpy[0];
  float pzy = pzxpy[1];
  cairo_set_line_width(cr, border_width);
 
  if(_set_max_clip(darktable.develop->virtual_pipe, self))
  {
    cairo_set_source_rgba(cr, .1, .1, .1, .8);
    cairo_set_fill_rule(cr, CAIRO_FILL_RULE_EVEN_ODD);
    const float max_x = g->clip_max_x * g->wd;
    const float max_y = g->clip_max_y * g->ht;
    const float max_w = g->clip_max_w * g->wd;
    const float max_h = g->clip_max_h * g->ht;
    cairo_rectangle(cr, max_x, max_y, max_w, max_h);
    
    const float clip_x = g->clip_x * g->wd - border_width / 2.;
    const float clip_y = g->clip_y * g->ht - border_width / 2.;
    const float clip_w = g->clip_w * g->wd + border_width;
    const float clip_h = g->clip_h * g->ht + border_width;
    cairo_rectangle(cr, clip_x, clip_y, clip_w, clip_h);
    cairo_fill(cr);
  }
  if(g->clip_x > .0f || g->clip_y > .0f || g->clip_w < 1.0f || g->clip_h < 1.0f)
  {
    const float rect_x = g->clip_x * g->wd - border_width / 2.;
    const float rect_y = g->clip_y * g->ht - border_width / 2.;
    const float rect_w = g->clip_w * g->wd + border_width;
    const float rect_h = g->clip_h * g->ht + border_width;
    cairo_rectangle(cr, rect_x, rect_y, rect_w, rect_h);
    dt_draw_set_color_overlay(cr, TRUE, 1.0);
    cairo_stroke(cr);
  }
 
  // draw cropping window dimensions if first mouse button is pressed
  if(darktable.control->button_down && darktable.control->button_down_which == 1)
  {
    char dimensions[16];
    dimensions[0] = '\0';
    PangoLayout *layout;
    PangoRectangle ext;
    PangoFontDescription *desc = pango_font_description_copy_static(darktable.bauhaus->pango_font_desc);
    pango_font_description_set_weight(desc, PANGO_WEIGHT_BOLD);
    pango_font_description_set_absolute_size(desc, DT_PIXEL_APPLY_DPI(16) * PANGO_SCALE / zoom_scale);
    layout = pango_cairo_create_layout(cr);
    pango_layout_set_font_description(layout, desc);
 
    int procw;
    int proch;
    dt_dev_get_processed_size(dev, &procw, &proch);
    snprintf(dimensions, sizeof(dimensions), "%.0f x %.0f", (float)procw * g->clip_w, (float)proch * g->clip_h);
 
    pango_layout_set_text(layout, dimensions, -1);
    pango_layout_get_pixel_extents(layout, NULL, &ext);
    const float text_w = ext.width;
    const float text_h = DT_PIXEL_APPLY_DPI(16 + 2) / zoom_scale;
    const float margin = DT_PIXEL_APPLY_DPI(6) / zoom_scale;
    float xp = (g->clip_x + g->clip_w * .5f) * g->wd - text_w * .5f;
    float yp = (g->clip_y + g->clip_h * .5f) * g->ht - text_h * .5f;
 
    // ensure that the rendered string remains visible within the window bounds
    double x1;
    double y1;
    double x2;
    double y2;
    cairo_clip_extents(cr, &x1, &y1, &x2, &y2);
    xp = CLAMPF(xp, x1 + 2.0 * margin, x2 - text_w - 2.0 * margin);
    yp = CLAMPF(yp, y1 + 2.0 * margin, y2 - text_h - 2.0 * margin);
 
    cairo_set_source_rgba(cr, .5, .5, .5, .9);
    dt_gui_draw_rounded_rectangle(cr, text_w + 2 * margin, text_h + 2 * margin, xp - margin, yp - margin);
    cairo_set_source_rgb(cr, .7, .7, .7);
    cairo_move_to(cr, xp, yp);
    pango_cairo_show_layout(cr, layout);
    pango_font_description_free(desc);
    g_object_unref(layout);
  }
 
  cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(2.0) / zoom_scale);
  dt_draw_set_color_overlay(cr, FALSE, 1.0);
  const int border = DT_PIXEL_APPLY_DPI(30.0) / zoom_scale;
 
  const _grab_region_t grab = g->cropping ? g->cropping : _gui_get_grab(pzx, pzy, g, border, g->wd, g->ht);
 
  // TODO: check if the variables change from the same calculation some lines above
  const float clip_x_px = g->clip_x * g->wd;
  const float clip_y_px = g->clip_y * g->ht;
  const float clip_w_px = g->clip_w * g->wd;
  const float clip_h_px = g->clip_h * g->ht;
  const float clip_right_px = clip_x_px + clip_w_px;
  const float clip_bottom_px = clip_y_px + clip_h_px;
 
  if(grab == GRAB_LEFT)         cairo_rectangle(cr, clip_x_px, clip_y_px, border, clip_h_px);
  if(grab == GRAB_TOP)          cairo_rectangle(cr, clip_x_px, clip_y_px, clip_w_px, border);
  if(grab == GRAB_TOP_LEFT)     cairo_rectangle(cr, clip_x_px, clip_y_px, border, border);
  if(grab == GRAB_RIGHT)        cairo_rectangle(cr, clip_right_px - border, clip_y_px, border, clip_h_px);
  if(grab == GRAB_BOTTOM)       cairo_rectangle(cr, clip_x_px, clip_bottom_px - border, clip_w_px, border);
  if(grab == GRAB_BOTTOM_RIGHT) cairo_rectangle(cr, clip_right_px - border, clip_bottom_px - border, border, border);
  if(grab == GRAB_TOP_RIGHT)    cairo_rectangle(cr, clip_right_px - border, clip_y_px, border, border);
  if(grab == GRAB_BOTTOM_LEFT)  cairo_rectangle(cr, clip_x_px, clip_bottom_px - border, border, border);
  cairo_stroke(cr);
}
 
int mouse_moved(struct dt_iop_module_t *self, double x, double y, double pressure, int which)
{
  dt_develop_t *dev = self->dev;
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  if(!g->editing) return 0;
 
  float pzxpy[2] = { (float)x, (float)y };
  dt_dev_coordinates_widget_to_image_norm(self->dev, pzxpy, 1);
  float pzx = pzxpy[0];
  float pzy = pzxpy[1];
  const float zoom_scale = dt_dev_get_overlay_scale(dev);
  const int border = DT_PIXEL_APPLY_DPI(30.0) / zoom_scale;
 
  const _grab_region_t grab = _gui_get_grab(pzx, pzy, g, border, g->wd, g->ht);
 
  _set_max_clip(darktable.develop->virtual_pipe, self);
 
  if(g->dragging)
  {
    // draw a light gray frame, to show it's not stored yet:
    // first mouse button, adjust cropping frame, but what do we do?
    const float bzx = g->button_down_zoom_x;
    const float bzy = g->button_down_zoom_y;
 
    if(g->cropping == GRAB_ALL)
    {
      /* moving the crop window */
      if(!g->shift_hold)
        g->clip_x
          = fminf(g->clip_max_w + g->clip_max_x - g->clip_w,
                  fmaxf(g->clip_max_x, g->handle_x + pzx - bzx));
 
      if(!g->ctrl_hold)
        g->clip_y
          = fminf(g->clip_max_h + g->clip_max_y - g->clip_h,
                  fmaxf(g->clip_max_y, g->handle_y + pzy - bzy));
    }
    else
    {
      /* changing the crop window */
      if(g->shift_hold)
      {
        /* the center is locked, scale crop radial with locked ratio */
        float xx = 0.0f;
        float yy = 0.0f;
 
        if(g->cropping & GRAB_LEFT || g->cropping & GRAB_RIGHT)
          xx = (g->cropping & GRAB_LEFT) ? (pzx - bzx) : (bzx - pzx);
        if(g->cropping & GRAB_TOP || g->cropping & GRAB_BOTTOM)
          yy = (g->cropping & GRAB_TOP) ? (pzy - bzy) : (bzy - pzy);
 
        float ratio = fmaxf((g->prev_clip_w - 2.0f * xx) / g->prev_clip_w,
                            (g->prev_clip_h - 2.0f * yy) / g->prev_clip_h);
 
        // ensure we don't get too small crop size
        if(g->prev_clip_w * ratio < 0.1f) ratio = 0.1f / g->prev_clip_w;
        if(g->prev_clip_h * ratio < 0.1f) ratio = 0.1f / g->prev_clip_h;
 
        // ensure we don't have too big crop size
        if(g->prev_clip_w * ratio > g->clip_max_w) ratio = g->clip_max_w / g->prev_clip_w;
        if(g->prev_clip_h * ratio > g->clip_max_h) ratio = g->clip_max_h / g->prev_clip_h;
 
        // now that we are sure that the crop size is correct, we have to adjust top & left
        float nx = g->prev_clip_x - (g->prev_clip_w * ratio - g->prev_clip_w) / 2.0f;
        float ny = g->prev_clip_y - (g->prev_clip_h * ratio - g->prev_clip_h) / 2.0f;
        float nw = g->prev_clip_w * ratio;
        float nh = g->prev_clip_h * ratio;
 
        // move crop area to the right if needed
        nx = fmaxf(nx, g->clip_max_x);
        // move crop area to the left if needed
        nx = fminf(nx, g->clip_max_w + g->clip_max_x - nw);
        // move crop area to the bottom if needed
        ny = fmaxf(ny, g->clip_max_y);
        // move crop area to the top if needed
        ny = fminf(ny, g->clip_max_h + g->clip_max_y - nh);
 
        g->clip_x = nx;
        g->clip_y = ny;
        g->clip_w = nw;
        g->clip_h = nh;
      }
      else
      {
        if(g->cropping & GRAB_LEFT)
        {
          const float old_clip_x = g->clip_x;
          g->clip_x = fminf(fmaxf(g->clip_max_x, pzx - g->handle_x), g->clip_x + g->clip_w - 0.1f);
          g->clip_w = old_clip_x + g->clip_w - g->clip_x;
        }
        if(g->cropping & GRAB_TOP)
        {
          const float old_clip_y = g->clip_y;
          g->clip_y = fminf(fmaxf(g->clip_max_y, pzy - g->handle_y), g->clip_y + g->clip_h - 0.1f);
          g->clip_h = old_clip_y + g->clip_h - g->clip_y;
        }
        if(g->cropping & GRAB_RIGHT)
          g->clip_w = fmaxf(0.1f, fminf(g->clip_max_w + g->clip_max_x, pzx - g->clip_x - g->handle_x));
        if(g->cropping & GRAB_BOTTOM)
          g->clip_h = fmaxf(0.1f, fminf(g->clip_max_h + g->clip_max_y, pzy - g->clip_y - g->handle_y));
      }
 
      if(g->clip_x + g->clip_w > g->clip_max_w + g->clip_max_x)
        g->clip_w = g->clip_max_w + g->clip_max_x - g->clip_x;
      if(g->clip_y + g->clip_h > g->clip_max_h + g->clip_max_y)
        g->clip_h = g->clip_max_h + g->clip_max_y - g->clip_y;
    }
 
    _aspect_apply(self, g->cropping);
    gui_changed(self, NULL, NULL);
    dt_control_queue_redraw_center();
    return 1;
  }
  else if(grab)
  {
    // hover over active borders, no button pressed
    // change mouse pointer
    if(grab == GRAB_LEFT)
      dt_control_queue_cursor(GDK_LEFT_SIDE);
    else if(grab == GRAB_TOP)
      dt_control_queue_cursor(GDK_TOP_SIDE);
    else if(grab == GRAB_RIGHT)
      dt_control_queue_cursor(GDK_RIGHT_SIDE);
    else if(grab == GRAB_BOTTOM)
      dt_control_queue_cursor(GDK_BOTTOM_SIDE);
    else if(grab == GRAB_TOP_LEFT)
      dt_control_queue_cursor(GDK_TOP_LEFT_CORNER);
    else if(grab == GRAB_TOP_RIGHT)
      dt_control_queue_cursor(GDK_TOP_RIGHT_CORNER);
    else if(grab == GRAB_BOTTOM_RIGHT)
      dt_control_queue_cursor(GDK_BOTTOM_RIGHT_CORNER);
    else if(grab == GRAB_BOTTOM_LEFT)
      dt_control_queue_cursor(GDK_BOTTOM_LEFT_CORNER);
    else if(grab == GRAB_NONE)
    {
      dt_control_hinter_message(darktable.control, "");
      dt_control_queue_cursor(GDK_LEFT_PTR);
    }
    if(grab != GRAB_NONE)
      dt_control_hinter_message(darktable.control, _("<b>resize</b>: drag, <b>keep aspect ratio</b>: shift+drag"));
    dt_control_queue_redraw_center();
  }
  else
  {
    dt_control_queue_cursor(GDK_FLEUR);
    g->cropping = GRAB_CENTER;
    dt_control_hinter_message(darktable.control, _("<b>move</b>: drag, <b>move vertically</b>: shift+drag, <b>move horizontally</b>: ctrl+drag"));
    dt_control_queue_redraw_center();
  }
  return 0;
}
 
int button_released(struct dt_iop_module_t *self, double x, double y, int which, uint32_t state)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  if(!g->editing) return 0;
 
  /* reset internal ui states*/
  g->shift_hold = FALSE;
  g->ctrl_hold = FALSE;
  g->cropping = GRAB_CENTER;
  g->dragging = FALSE;
 
  // FIXME: is this the right cursor? there should be a "restore_cursor" function
  dt_control_change_cursor(GDK_LEFT_PTR);
 
  // we save the crop into the params now so params are kept in synch with gui settings
  gui_changed(self, NULL, NULL);
  return 1;
}
 
int button_pressed(struct dt_iop_module_t *self, double x, double y, double pressure, int which, int type,
                   uint32_t state)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  if(!g->editing) return 0;
 
  // avoid unexpected back to lt mode:
  if(type == GDK_2BUTTON_PRESS && which == 1)
    return 1;
 
  if(which == 1)
  {
    dt_develop_t *dev = self->dev;
    float pzxpy[2] = { (float)x, (float)y };
    dt_dev_coordinates_widget_to_image_norm(self->dev, pzxpy, 1);
    float pzx = pzxpy[0];
    float pzy = pzxpy[1];
    const float zoom_scale = dt_dev_get_overlay_scale(dev);
 
    g->button_down_x = x;
    g->button_down_y = y;
 
    g->button_down_zoom_x = pzx;
    g->button_down_zoom_y = pzy;
 
    /* update prev clip box with current */
    g->prev_clip_x = g->clip_x;
    g->prev_clip_y = g->clip_y;
    g->prev_clip_w = g->clip_w;
    g->prev_clip_h = g->clip_h;
 
    /* if shift is pressed, then lock crop on center */
    if(dt_modifiers_include(state, GDK_SHIFT_MASK)) g->shift_hold = TRUE;
    if(dt_modifiers_include(state, GDK_CONTROL_MASK)) g->ctrl_hold = TRUE;
 
    /* store grabbed area */
    
    const float border = DT_PIXEL_APPLY_DPI(30.0) / zoom_scale;
 
    g->cropping = _gui_get_grab(pzx, pzy, g, border, g->wd, g->ht);
 
    if(g->cropping != GRAB_NONE)
    {
      g->dragging = TRUE;
    
      if(g->cropping == GRAB_CENTER)
      {
        g->cropping = GRAB_ALL;
        g->handle_x = g->clip_x;
        g->handle_y = g->clip_y;
      }
      else
      {
        if(g->cropping & GRAB_LEFT)   g->handle_x = pzx - g->clip_x;
        if(g->cropping & GRAB_TOP)    g->handle_y = pzy - g->clip_y;
        if(g->cropping & GRAB_RIGHT)  g->handle_x = pzx - (g->clip_w + g->clip_x);
        if(g->cropping & GRAB_BOTTOM) g->handle_y = pzy - (g->clip_h + g->clip_y);
      }
    }
    return 1;
  }
  else if(which == 3)
  {
    // we reset cropping
    g->clip_x = 0.0f;
    g->clip_y = 0.0f;
    g->clip_w = 1.0f;
    g->clip_h = 1.0f;
    _aspect_apply(self, GRAB_BOTTOM_RIGHT);
    return 1;
  }
  else
    return 0;
}
 
int mouse_leave(struct dt_iop_module_t *self)
{
  dt_iop_crop_gui_data_t *g = (dt_iop_crop_gui_data_t *)self->gui_data;
  if(!g->editing) return 0;
 
  g->shift_hold = FALSE;
  g->ctrl_hold = FALSE;
  g->cropping = GRAB_NONE;
  g->dragging = FALSE;
 
  dt_control_change_cursor(GDK_LEFT_PTR);
 
  return 1;
}
 
// #undef PHI
// #undef INVPHI
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on