geometry.h

Go to the documentation of this file.

/*
    This file is part of Ansel.
    Copyright (C) 2026 Aurélien Pierre.
 
    Ansel 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.
 
    Ansel 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 Ansel.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_DEVELOP_GEOMETRY_GEOMETRY_H
#define DT_DEVELOP_GEOMETRY_GEOMETRY_H
 
#include <glib.h>
#include <stdint.h>
 
#include "develop/pixelpipe_hb.h"   // dt_iop_roi_t
 
/* C linkage: geometry.c is a C translation unit and iop/lens.cc -- the first module to publish
 * a record -- is a C++ one. Without this its calls and its vtable would name mangled symbols
 * nothing defines. Linux would still link the plugin (a shared object may carry undefined
 * symbols and resolve them at dlopen time) and fail at runtime; macOS and Windows fail the
 * build. Same reason control/user_message.h carries these guards. */
#ifdef __cplusplus
extern "C" {
#endif
 
struct dt_develop_t;
struct dt_iop_module_t;
struct dt_geometry_record_t;
struct dt_geometry_chain_t;
 
typedef struct dt_geometry_vtable_t
{
  void (*map_size)(const void *data, const dt_iop_roi_t *const in, dt_iop_roi_t *out);
 
  int (*transform)(const void *data, const struct dt_geometry_record_t *const record,
                   struct dt_geometry_chain_t *chain, float *points, size_t points_count);
 
  int (*backtransform)(const void *data, const struct dt_geometry_record_t *const record,
                       struct dt_geometry_chain_t *chain, float *points, size_t points_count);
} dt_geometry_vtable_t;
 
typedef struct dt_geometry_record_t
{
  char op[32];             
  int instance;            
  double iop_order;        
  gboolean enabled;
 
  /* The candidate half of the query-time GUI exception: the FOCUSED module's tag filter is
   * tested against this. The focused module's own filter is not stored per record -- it is one
   * value for the whole query, and it lives on the chain. See dt_geometry_set_focus(). */
  int operation_tags;
 
  const dt_geometry_vtable_t *vtable;   
  void *data;                           
  void (*free_data)(void *data);        
  /* Filled by the chain's own size fold, at full resolution and scale 1 -- the same numbers
   * dt_dev_pixelpipe_get_roi_out() writes into a piece's buf_in/buf_out, which is what GUI
   * consumers used to resolve a piece in order to read. */
  dt_iop_roi_t in;
  dt_iop_roi_t out;
} dt_geometry_record_t;
 
typedef struct dt_geometry_chain_t dt_geometry_chain_t;
 
dt_geometry_chain_t *dt_geometry_chain_new(void);
void dt_geometry_chain_free(dt_geometry_chain_t *chain);
 
void dt_geometry_chain_rebuild(struct dt_develop_t *dev);
 
gboolean dt_geometry_chain_authoritative(const dt_geometry_chain_t *chain);
 
uint64_t dt_geometry_chain_generation(const dt_geometry_chain_t *chain);
 
gboolean dt_geometry_chain_processed_size(const dt_geometry_chain_t *chain, int *width, int *height);
 
const dt_geometry_record_t *dt_geometry_chain_find(const dt_geometry_chain_t *chain, const char *op,
                                                   int instance);
 
/* Direction modes, matching dt_dev_distort_transform_plus()'s DT_DEV_TRANSFORM_DIR_* exactly:
 * the walkers this replaces are bounded folds, and every existing caller's bound has to keep
 * meaning what it meant. */
 
int dt_geometry_transform(struct dt_develop_t *dev, double iop_order, int direction, float *points,
                          size_t points_count);
 
int dt_geometry_backtransform(struct dt_develop_t *dev, double iop_order, int direction, float *points,
                              size_t points_count);
 
int dt_geometry_module_transform(struct dt_develop_t *dev, const struct dt_iop_module_t *module,
                                 float *points, size_t points_count);
 
int dt_geometry_chain_compose(dt_geometry_chain_t *chain, double iop_order, int direction, float *points,
                              size_t points_count);
 
/* THE FOCUS EXCEPTION is not an entry point, deliberately. It used to be one -- a setter the GUI
 * was supposed to call when the focused module or its editing state changed -- and nothing ever
 * called it, so the chain composed every module while the pipe was skipping the ones the focused
 * module's tag filter disables. The visible result was ashift's detected-lines overlay drawn
 * against a different module stack than the image under it.
 *
 * A published copy of view state has to be refreshed to stay true and is wrong in between; that
 * is the same lesson control/input.h records about the stored mouse-button state. So the chain
 * now reads it where the pipe reads it -- dev->gui_module, its operation_tags_filter() and its
 * live cache-bypass flag, at query time -- and the two cannot drift because there is nothing to
 * keep in step. Do not reintroduce a setter for this.
 */
 
void dt_geometry_self_check(struct dt_develop_t *dev, double chain_ms);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_DEVELOP_GEOMETRY_GEOMETRY_H
 
// 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