preset_repository.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2026 Aurélien PIERRE.
 
    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/>.
*/
 
#ifndef DT_DATABASE_PRESET_REPOSITORY_H
#define DT_DATABASE_PRESET_REPOSITORY_H
 
#include <glib.h>
#include <stdint.h>
 
G_BEGIN_DECLS
 
typedef struct dt_preset_t
{
  gchar *name;
  gchar *description;
  gchar *operation;
  int autoapply;
 
  /* the conditions under which this preset auto-applies */
  gchar *model;
  gchar *maker;
  gchar *lens;
  float iso_min, iso_max;
  float exposure_min, exposure_max;
  float aperture_min, aperture_max;
  int focal_length_min, focal_length_max;
 
  /* the module parameters themselves, as raw blobs */
  void *op_params;
  int op_params_size;
  int op_version;
  void *blendop_params;
  int blendop_params_size;
  int blendop_version;
 
  int enabled;
  int multi_priority;
  gchar *multi_name;
  int filter;
  int def;
  int format;
} dt_preset_t;
 
void dt_preset_free(dt_preset_t *preset);
 
dt_preset_t *dt_preset_repository_get_by_rowid(const int rowid);
 
gboolean dt_preset_repository_insert(const dt_preset_t *preset);
 
/* ---------------------------------------------------------------------------------------
 *  Module presets
 *
 *  The same table, seen the way a preset menu sees it: one module's presets, keyed by
 *  `(operation, op_version)`. A preset created this way is a name plus a parameter blob;
 *  every auto-apply condition is set to a wildcard, since a menu preset is applied by
 *  being picked, not by matching an image.
 * ------------------------------------------------------------------------------------- */
 
typedef struct dt_module_preset_t
{
  gchar *name;
  gchar *description; 
  void *op_params;
  int op_params_size;
  int op_version;     
  int rowid;          
  gboolean writeprotect;
 
  /* IOP presets only -- a lib module has no blending. NULL / 0 otherwise. */
  void *blendop_params;
  int blendop_params_size;
  int blendop_version;
  int enabled;
} dt_module_preset_t;
 
void dt_module_preset_free(gpointer data);
 
GList *dt_preset_repository_list_for_module(const char *operation, const int op_version,
                                            const gboolean with_description,
                                            const gboolean shipped_first);
 
GList *dt_preset_repository_list_all_versions(const char *operation);
 
GList *dt_preset_repository_list_for_version(const char *operation, const int op_version);
 
gboolean dt_preset_repository_module_preset_exists(const char *operation, const int op_version,
                                                   const char *name);
 
int dt_preset_repository_find_rowid(const char *operation, const int op_version, const char *name);
 
dt_module_preset_t *dt_preset_repository_get_module_preset(const char *operation, const int op_version,
                                                           const char *name);
 
void dt_preset_repository_add_module_preset(const char *name, const char *operation,
                                            const int op_version, const void *params,
                                            const int params_size);
 
void dt_preset_repository_add_shipped_preset(const char *name, const char *operation,
                                             const int op_version, const void *params,
                                             const int params_size, const int writeprotect);
 
void dt_preset_repository_update_module_params(const char *operation, const char *name,
                                               const int op_version, const void *params,
                                               const int params_size);
 
void dt_preset_repository_set_module_version(const char *operation, const char *name,
                                             const int op_version);
 
void dt_preset_repository_set_blend_params(const char *operation, const char *name,
                                           const int blendop_version, const void *blend_params,
                                           const int blend_params_size);
 
GList *dt_preset_repository_list_for_upgrade(const char *operation);
 
void dt_preset_repository_rename_module_preset(const char *operation, const int op_version,
                                               const char *old_name, const char *new_name,
                                               const char *description, const void *params,
                                               const int params_size);
 
void dt_preset_repository_duplicate_module_preset(const char *operation, const int op_version,
                                                  const char *name, const char *new_name);
 
void dt_preset_repository_delete_module_preset(const char *operation, const int op_version,
                                               const char *name);
 
void dt_preset_repository_delete_all_for_module(const char *operation);
 
void dt_preset_repository_update_params_by_rowid(const int rowid, const int op_version,
                                                 const void *params, const int params_size);
 
void dt_preset_repository_delete_by_rowid(const int rowid);
 
/* ---------------------------------------------------------------------------------------
 *  Auto-apply conditions
 *
 *  The preset edit dialog changes one condition at a time, so these are one statement per
 *  field rather than a whole-row write. Grouped into two families by shape: a numeric
 *  range, and a single integer. The enum picks the columns; nothing here builds SQL from a
 *  string, so every query in this file stays greppable.
 * ------------------------------------------------------------------------------------- */
 
typedef enum dt_preset_range_t
{
  DT_PRESET_RANGE_ISO = 0,
  DT_PRESET_RANGE_APERTURE,
  DT_PRESET_RANGE_EXPOSURE,
  DT_PRESET_RANGE_FOCAL_LENGTH,
  DT_PRESET_RANGE_LAST
} dt_preset_range_t;
 
typedef enum dt_preset_flag_t
{
  DT_PRESET_FLAG_FORMAT = 0, 
  DT_PRESET_FLAG_AUTOAPPLY,
  DT_PRESET_FLAG_FILTER,     
  DT_PRESET_FLAG_LAST
} dt_preset_flag_t;
 
void dt_preset_repository_update_range(const char *operation, const int op_version, const char *name,
                                       const dt_preset_range_t range,
                                       const double min, const double max);
 
void dt_preset_repository_update_flag(const char *operation, const int op_version, const char *name,
                                      const dt_preset_flag_t flag, const int value);
 
void dt_preset_repository_update_camera(const char *operation, const int op_version, const char *name,
                                        const char *maker, const char *model, const char *lens);
 
/* ---------------------------------------------------------------------------------------
 *  IOP presets
 *
 *  Same table again, seen by a pixel module's preset menu. Two things distinguish it from
 *  the lib half: the rows carry blend parameters, and the menu filters by whether a preset
 *  matches the image being edited -- so three queries share one predicate over the camera,
 *  the exposure triangle and the file format.
 * ------------------------------------------------------------------------------------- */
 
typedef struct dt_preset_match_t
{
  const char *exif_model;
  const char *exif_maker;
  const char *camera_alias;
  const char *camera_maker;
  const char *exif_lens;
  double iso;
  double exposure;
  double aperture;
  double focal_length;
  int format;   
  int excluded; 
} dt_preset_match_t;
 
void dt_preset_repository_add_iop_preset(const char *name, const char *operation, const int op_version,
                                         const void *params, const int params_size,
                                         const void *blend_params, const int blend_params_size,
                                         const int blendop_version, const int enabled);
 
GList *dt_preset_repository_list_for_iop(const char *operation, const int op_version);
 
GList *dt_preset_repository_list_for_menu(const char *operation, const dt_preset_match_t *match,
                                          const gboolean shipped_first);
 
dt_module_preset_t *dt_preset_repository_get_iop_preset(const char *operation, const int op_version,
                                                        const char *name);
 
GList *dt_preset_repository_find_autoapply(const char *operation, const int op_version,
                                           const dt_preset_match_t *match, const char *always_name);
 
/* ---------------------------------------------------------------------------------------
 *  The preset edit dialog
 *
 *  It shows and writes the whole condition set at once, so these take it as one struct
 *  rather than sixteen parameters.
 * ------------------------------------------------------------------------------------- */
 
typedef struct dt_preset_conditions_t
{
  gchar *name;
  gchar *description;
  gchar *model;
  gchar *maker;
  gchar *lens;
  double iso_min, iso_max;
  double exposure_min, exposure_max;
  double aperture_min, aperture_max;
  /* REAL columns, like the pairs above: read and bound as doubles so a fractional stored
   * bound survives an open-and-save of the edit dialog. The dialog displays whole
   * millimetres, but display rounding is the dialog's, not the store's. */
  double focal_length_min, focal_length_max;
  int autoapply;
  int filter;
  int format;
} dt_preset_conditions_t;
 
void dt_preset_conditions_free(dt_preset_conditions_t *c);
 
gboolean dt_preset_repository_get_conditions(const char *operation, const int op_version,
                                             const char *name, dt_preset_conditions_t *c, int *rowid);
 
void dt_preset_repository_update_conditions(const int rowid, const dt_preset_conditions_t *c);
 
void dt_preset_repository_insert_with_conditions(const dt_preset_conditions_t *c,
                                                 const char *operation, const int op_version,
                                                 const void *params, const int params_size,
                                                 const int enabled,
                                                 const void *blend_params, const int blend_params_size,
                                                 const int blendop_version);
 
gboolean dt_preset_repository_get_identity(const int rowid, gchar **operation, int *op_version);
 
void dt_preset_repository_update_iop_params(const char *operation, const char *name,
                                            const int op_version,
                                            const void *params, const int params_size,
                                            const int enabled,
                                            const void *blend_params, const int blend_params_size,
                                            const int blendop_version);
 
void dt_preset_repository_delete_by_rowid_unprotected(const int rowid);
 
void dt_preset_repository_delete_shipped(void);
 
/* ---------------------------------------------------------------------------------------
 *  Listing presets for the Preferences dialog
 *
 *  The preferences tree shows every preset in the database, grouped by module, with the
 *  auto-apply conditions rendered as ranges. These two return whole rows rather than a
 *  cursor, because the caller builds GTK widgets from them and must not be stepping a
 *  statement while it does.
 * ------------------------------------------------------------------------------------- */
 
typedef struct dt_preset_row_t
{
  int rowid;
  char *name;
  char *operation;
  gboolean autoapply;
  char *model;
  char *maker;
  char *lens;
  float iso_min, iso_max;
  float exposure_min, exposure_max;
  float aperture_min, aperture_max;
  int focal_length_min, focal_length_max;  
  gboolean writeprotect;
} dt_preset_row_t;
 
void dt_preset_row_free(gpointer data);
 
GList *dt_preset_repository_list_all(void);
 
typedef struct dt_preset_identity_t
{
  int rowid;
  char *name;
  char *operation;
} dt_preset_identity_t;
 
void dt_preset_identity_free(gpointer data);
 
GList *dt_preset_repository_list_editable(void);
 
void dt_preset_repository_cleanup(void);
 
G_END_DECLS
 
#endif // DT_DATABASE_PRESET_REPOSITORY_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