iop_api.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2016, 2019 Tobias Ellinghaus.
    Copyright (C) 2017-2018 Edgardo Hoszowski.
    Copyright (C) 2019-2021 Aldric Renaudin.
    Copyright (C) 2019 Heiko Bauke.
    Copyright (C) 2019 Marcus Rückert.
    Copyright (C) 2020, 2025-2026 Aurélien PIERRE.
    Copyright (C) 2020-2022 Diederik Ter Rahe.
    Copyright (C) 2020-2022 Pascal Obry.
    Copyright (C) 2021 luzpaz.
    Copyright (C) 2022 Martin Bařinka.
    
    darktable is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
    
    You should have received a copy of the GNU Lesser General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#include "common/module_api.h"
 
#ifdef FULL_API_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "common/introspection.h"
 
#include <cairo/cairo.h>
#include <gtk/gtk.h>
#include <glib.h>
#include <stdint.h>
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#ifdef HAVE_OPENCL
#include <CL/cl.h>
#endif
 
struct dt_iop_module_so_t;
struct dt_iop_module_t;
struct dt_dev_pixelpipe_t;
struct dt_dev_pixelpipe_iop_t;
struct dt_iop_roi_t;
struct dt_develop_tiling_t;
struct dt_iop_buffer_dsc_t;
struct dt_gui_module_t;
struct _GtkWidget;
 
#ifndef DT_IOP_PARAMS_T
#define DT_IOP_PARAMS_T
typedef void dt_iop_params_t;
#endif
 
/* early definition of modules to do type checking */
 
#pragma GCC visibility push(default)
 
#endif // FULL_API_H
 
OPTIONAL(void, init_presets, struct dt_iop_module_so_t *self);
OPTIONAL(void, init_global, struct dt_iop_module_so_t *self);
OPTIONAL(void, cleanup_global, struct dt_iop_module_so_t *self);
 
REQUIRED(const char *, name, void);
DEFAULT(const char *, aliases, void);
DEFAULT(int, default_group, void);
DEFAULT(int, flags, void);
DEFAULT(const char *, deprecated_msg, void);
 
DEFAULT(int, iop_focus, struct dt_gui_module_t *module, gboolean toggle);
 
DEFAULT(const char **, description, struct dt_iop_module_t *self);
 
DEFAULT(int, operation_tags, void);
DEFAULT(int, operation_tags_filter, void);
 
DEFAULT(void, input_format, struct dt_iop_module_t *self, struct dt_dev_pixelpipe_t *pipe,
                             struct dt_dev_pixelpipe_iop_t *piece, struct dt_iop_buffer_dsc_t *dsc);
DEFAULT(void, output_format, struct dt_iop_module_t *self, struct dt_dev_pixelpipe_t *pipe,
                              struct dt_dev_pixelpipe_iop_t *piece, struct dt_iop_buffer_dsc_t *dsc);
 
REQUIRED(int, default_colorspace, struct dt_iop_module_t *self, struct dt_dev_pixelpipe_t *pipe,
                                  const struct dt_dev_pixelpipe_iop_t *piece);
DEFAULT(int, blend_colorspace, struct dt_iop_module_t *self, struct dt_dev_pixelpipe_t *pipe,
                                const struct dt_dev_pixelpipe_iop_t *piece);
 
DEFAULT(void, tiling_callback, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                                const struct dt_dev_pixelpipe_iop_t *piece, struct dt_develop_tiling_t *tiling);
 
OPTIONAL(void, gui_update, struct dt_iop_module_t *self);
OPTIONAL(void, gui_reset, struct dt_iop_module_t *self);
OPTIONAL(void, gui_init, struct dt_iop_module_t *self);
OPTIONAL(void, color_picker_apply, struct dt_iop_module_t *self, struct _GtkWidget *picker,
                                 struct dt_dev_pixelpipe_t *pipe, struct dt_dev_pixelpipe_iop_t *piece);
OPTIONAL(void, gui_changed, struct dt_iop_module_t *self, GtkWidget *widget, void *previous);
DEFAULT(void, gui_cleanup, struct dt_iop_module_t *self);
OPTIONAL(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);
OPTIONAL(void, gui_focus, struct dt_iop_module_t *self, gboolean in);
OPTIONAL(gboolean, module_will_remove, struct dt_iop_module_t *self);
 
OPTIONAL(void, quiesce, struct dt_iop_module_t *self);
 
OPTIONAL(int, mouse_leave, struct dt_iop_module_t *self);
OPTIONAL(int, mouse_moved, struct dt_iop_module_t *self, double x, double y, double pressure, int which);
OPTIONAL(int, button_released, struct dt_iop_module_t *self, double x, double y, int which, uint32_t state);
OPTIONAL(int, button_pressed, struct dt_iop_module_t *self, double x, double y, double pressure, int which, int type,
                              uint32_t state);
OPTIONAL(int, key_pressed, struct dt_iop_module_t *self, GdkEventKey *event);
 
OPTIONAL(int, scrolled, struct dt_iop_module_t *self, double x, double y, int up, uint32_t state);
OPTIONAL(void, configure, struct dt_iop_module_t *self, int width, int height);
 
OPTIONAL(void, init, struct dt_iop_module_t *self); // this MUST set params_size!
DEFAULT(void, cleanup, struct dt_iop_module_t *self);
 
DEFAULT(void, init_pipe, struct dt_iop_module_t *self, struct dt_dev_pixelpipe_t *pipe,
                          struct dt_dev_pixelpipe_iop_t *piece);
DEFAULT(void, commit_params, struct dt_iop_module_t *self, dt_iop_params_t *params, struct dt_dev_pixelpipe_t *pipe,
                              struct dt_dev_pixelpipe_iop_t *piece);
OPTIONAL(void, reload_defaults, struct dt_iop_module_t *self);
 
DEFAULT(gboolean, has_defaults, struct dt_iop_module_t *self);
 
DEFAULT(gboolean, runtime_data_hash, struct dt_iop_module_t *self, struct dt_dev_pixelpipe_t *pipe,
                                     const struct dt_dev_pixelpipe_iop_t *piece);
 
OPTIONAL(void, change_image, struct dt_iop_module_t *self);
 
DEFAULT(void, cleanup_pipe, struct dt_iop_module_t *self, struct dt_dev_pixelpipe_t *pipe,
                             struct dt_dev_pixelpipe_iop_t *piece);
OPTIONAL(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 struct dt_iop_roi_t *roi_out, struct dt_iop_roi_t *roi_in);
OPTIONAL(void, modify_roi_out, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                               struct dt_dev_pixelpipe_iop_t *piece,
                               struct dt_iop_roi_t *roi_out, const struct dt_iop_roi_t *roi_in);
OPTIONAL(int, legacy_params, struct dt_iop_module_t *self, const void *const old_params, const int old_version,
                             void *new_params, const int new_version);
// allow to select a shape inside an iop
OPTIONAL(void, masks_selection_changed, struct dt_iop_module_t *self, const int form_selected_id);
 
 
REQUIRED(int, process, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                        const struct dt_dev_pixelpipe_iop_t *piece, const void *const i, void *const o);
DEFAULT(int, process_tiling, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                               const struct dt_dev_pixelpipe_iop_t *piece, const void *const i, void *const o,
                               const int bpp);
 
#ifdef HAVE_OPENCL
 
OPTIONAL(int, process_cl, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                          const struct dt_dev_pixelpipe_iop_t *piece, cl_mem dev_in, cl_mem dev_out);
OPTIONAL(int, process_tiling_cl, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                                 const struct dt_dev_pixelpipe_iop_t *piece, const void *const i,
                                 void *const o, const int bpp);
#endif
 
DEFAULT(int, distort_transform, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                                 const struct dt_dev_pixelpipe_iop_t *piece, float *points, size_t points_count);
DEFAULT(int, distort_backtransform, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                                     const struct dt_dev_pixelpipe_iop_t *piece, float *points, size_t points_count);
 
OPTIONAL(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 struct dt_iop_roi_t *const roi_in, const struct dt_iop_roi_t *const roi_out);
 
// introspection related callbacks, will be auto-implemented if DT_MODULE_INTROSPECTION() is used,
OPTIONAL(int, introspection_init, struct dt_iop_module_so_t *self, int api_version);
DEFAULT(dt_introspection_t *, get_introspection, void);
DEFAULT(dt_introspection_field_t *, get_introspection_linear, void);
DEFAULT(void *, get_p, const void *param, const char *name);
DEFAULT(dt_introspection_field_t *, get_f, const char *name);
 
// optional preference entry to add at the bottom of the preset menu
OPTIONAL(void, set_preferences, void *menu, struct dt_iop_module_t *self);
 
// Perform checks on image type/metadata to forcefully self-enable or self-disable a module
// depending on input image. current_state will usually be self->enabled but can also be tied
// to history enabled state.
// Returns final enabled/disabled state after correction
OPTIONAL(gboolean, force_enable, struct dt_iop_module_t *self, const gboolean current_state);
 
OPTIONAL(void, post_history_commit, struct dt_iop_module_t *self);
 
OPTIONAL(int, populate_masks_context_menu, struct dt_iop_module_t *self, GtkWidget *menu, const int formid,const float pzx, const float pzy);
 
OPTIONAL(void, autoset, struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe, const struct dt_dev_pixelpipe_iop_t *piece, const void *i);
 
#ifdef FULL_API_H
 
#pragma GCC visibility pop
 
#ifdef __cplusplus
}
#endif
 
#endif // FULL_API_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