dev_history.h

Go to the documentation of this file.

/*
    This file is part of the Ansel project.
    Copyright (C) 2025 Alynx Zhou.
    Copyright (C) 2025-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/>.
*/
#include "system/atomic.h"
#include "history/history.h"
#include "develop/history_merge.h"
 
#include <glib.h>
 
#ifndef DT_DEVELOP_DEV_HISTORY_H
#define DT_DEVELOP_DEV_HISTORY_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef DT_IOP_PARAMS_T
#define DT_IOP_PARAMS_T
typedef void dt_iop_params_t;
#endif
 
struct dt_iop_module_t;
struct dt_develop_blend_params_t;
struct dt_develop_t;
 
typedef struct dt_dev_history_item_t
{
  struct dt_iop_module_t *module; // pointer to image operation module
  gboolean enabled;               // switched respective module on/off
  dt_iop_params_t *params;        // parameters for this operation
  int params_size;                // serialized params size
  int module_version;             // serialized module version
  struct dt_develop_blend_params_t *blend_params;
  int blendop_params_size;        // serialized blend params size
  int blendop_version;            // serialized blend version
  char op_name[32];
  int iop_order;
  int multi_priority;
  char multi_name[128];
  GList *forms; // snapshot of dt_develop_t->forms
  int num; // num of history on database
 
  uint64_t hash; // module params hash.
 
  // Refcount, mirroring dt_masks_form_t: dev->history holds one reference per element. See
  // dt_dev_history_cow_touch(): before mutating an item in place (the "reuse previous entry"
  // path), check refcount -- if shared with something else holding a reference, clone first
  // and mutate the clone instead.
  dt_atomic_int refcount;
} dt_dev_history_item_t;
 
 
void dt_dev_history_free_history(struct dt_develop_t *dev);
 
dt_dev_history_item_t *dt_dev_history_item_create(void);
 
void dt_dev_free_history_item(gpointer data);
 
dt_dev_history_item_t *dt_dev_history_item_ref(dt_dev_history_item_t *item);
 
dt_dev_history_item_t *dt_dev_history_cow_touch(struct dt_develop_t *dev, dt_dev_history_item_t *hist);
 
typedef struct dt_dev_history_snapshot_t
{
  GList *items;          // dt_dev_history_item_t*, one reference each, same order as dev->history
  int32_t history_end;   // dt_dev_get_history_end_ext() at snapshot time
  uint64_t history_hash; // dt_dev_get_history_hash() at snapshot time
} dt_dev_history_snapshot_t;
 
void dt_dev_history_snapshot_take(struct dt_develop_t *dev, dt_dev_history_snapshot_t *snapshot);
 
void dt_dev_history_snapshot_release(dt_dev_history_snapshot_t *snapshot);
 
gboolean dt_dev_history_item_update_from_params(struct dt_develop_t *dev, dt_dev_history_item_t *hist,
                                                struct dt_iop_module_t *module, gboolean enabled,
                                                const void *params, const int32_t params_size,
                                                const struct dt_develop_blend_params_t *blend_params, GList *forms);
 
int dt_dev_next_multi_priority_for_op(struct dt_develop_t *dev, const char *op);
 
struct dt_iop_module_t *dt_dev_get_module_instance(struct dt_develop_t *dev, const char *op, const char *multi_name,
                                                   const int multi_priority);
 
struct dt_iop_module_t *dt_dev_create_module_instance(struct dt_develop_t *dev, const char *op, const char *multi_name,
                                                      const int multi_priority, gboolean use_next_priority);
int dt_dev_copy_module_contents(struct dt_develop_t *dev_dest, struct dt_develop_t *dev_src,
                                struct dt_iop_module_t *mod_dest, const struct dt_iop_module_t *mod_src);
 
int dt_dev_history_item_from_source_history_item(struct dt_develop_t *dev_dest, struct dt_develop_t *dev_src,
                                                 const struct dt_dev_history_item_t *hist_src,
                                                 struct dt_iop_module_t *mod_dest,
                                                 struct dt_dev_history_item_t **out_hist);
 
int dt_dev_merge_history_into_image(struct dt_develop_t *dev_src, int32_t dest_imgid, const GList *mod_list,
                                    gboolean merge_iop_order, const dt_history_merge_strategy_t mode,
                                    const gboolean paste_instances, const char *source_label,
                                    dt_hm_batch_state_t *batch);
int dt_dev_replace_history_on_image(struct dt_develop_t *dev_src, const int32_t dest_imgid,
                                    const gboolean reload_defaults, const char *msg);
 
gboolean dt_dev_add_history_item_ext(struct dt_develop_t *dev, struct dt_iop_module_t *module, gboolean enable,
                                     gboolean force_new_item);
 
void dt_dev_add_history_item_real(struct dt_develop_t *dev, struct dt_iop_module_t *module, gboolean enable, gboolean redraw);
 
// Debug helper to follow calls to `dt_dev_add_history_item_real()`, but mostly to follow useless pipe recomputations.
#define dt_dev_add_history_item(dev, module, enable, redraw) DT_DEBUG_TRACE_WRAPPER(DT_DEBUG_DEV, dt_dev_add_history_item_real, (dev), (module), (enable), (redraw))
 
void dt_dev_history_flush_pending_commits(struct dt_develop_t *dev);
 
void dt_dev_history_drop_pending_commits(struct dt_develop_t *dev);
 
 
void dt_dev_write_history_ext(struct dt_develop_t *dev, const int32_t imgid);
 
void dt_dev_write_history(struct dt_develop_t *dev, gboolean async);
 
/* Implemented in dev_history_gui.c: attaches missing expanders and refreshes every module
 * widget after a backend history reload. Declared here because its callers are the ones
 * already driving the engine, and the signature carries no GTK type. */
void dt_dev_history_gui_update(struct dt_develop_t *dev);
 
void dt_dev_history_commit_item_now(struct dt_develop_t *dev, struct dt_iop_module_t *module, gboolean enable);
 
typedef void (*dt_dev_history_undo_restore_gui_handler_t)(struct dt_develop_t *dev,
                                                          int mask_edit_mode,
                                                          int request_mask_display);
void dt_dev_history_set_undo_restore_gui_handler(dt_dev_history_undo_restore_gui_handler_t handler);
 
typedef void (*dt_dev_history_commit_gui_handler_t)(struct dt_develop_t *dev, struct dt_iop_module_t *module);
void dt_dev_history_set_commit_gui_handler(dt_dev_history_commit_gui_handler_t handler);
 
void dt_dev_history_pixelpipe_update(struct dt_develop_t *dev, gboolean rebuild);
 
gboolean dt_dev_history_is_image_in_dev(GList *imgs);
 
void dt_apply_dev_history_update(struct dt_develop_t *dev);
 
void dt_dev_history_notify_change(struct dt_develop_t *dev, const int32_t imgid);
 
void dt_dev_history_undo_start_record(struct dt_develop_t *dev);
void dt_dev_history_undo_end_record(struct dt_develop_t *dev);
void dt_dev_history_undo_start_record_locked(struct dt_develop_t *dev);
void dt_dev_history_undo_end_record_locked(struct dt_develop_t *dev);
void dt_dev_history_undo_invalidate_module(struct dt_iop_module_t *module);
 
gboolean dt_dev_read_history_ext(struct dt_develop_t *dev, const int32_t imgid);
 
void dt_dev_pop_history_items_ext(struct dt_develop_t *dev);
 
void dt_dev_pop_history_items(struct dt_develop_t *dev);
 
 
gboolean dt_dev_reload_history_items(struct dt_develop_t *dev, const int32_t imgid);
 
 
void dt_dev_invalidate_history_module(GList *list, struct dt_iop_module_t *module);
 
uint64_t dt_dev_history_compute_hash(struct dt_develop_t *dev);
 
int32_t dt_dev_get_history_end_ext(struct dt_develop_t *dev);
 
void dt_dev_set_history_end_ext(struct dt_develop_t *dev, const uint32_t index);
 
gboolean dt_history_module_skip_copy(const int flags);
 
int dt_history_merge_module_into_history(struct dt_develop_t *dev_dest, struct dt_develop_t *dev_src,
                                         struct dt_iop_module_t *mod_src);
 
void dt_dev_history_compress(struct dt_develop_t *dev);
void dt_dev_history_compress_ext(struct dt_develop_t *dev, gboolean write_history);
void dt_dev_history_compress_or_truncate(struct dt_develop_t *dev);
void dt_dev_history_cleanup(void);
 
gboolean dt_dev_init_default_history(struct dt_develop_t *dev, const int32_t imgid, gboolean apply_auto_presets);
 
dt_dev_history_item_t *dt_dev_history_get_first_item_by_module(GList *history_list, struct dt_iop_module_t *module);
 
dt_dev_history_item_t *dt_dev_history_get_last_item_by_module(GList *history_list, struct dt_iop_module_t *module, int history_end);
 
int dt_dev_history_refresh_nodes_ext(struct dt_develop_t *dev, GList **iop, GList *history,
                                     GList **removed_gui_modules);
 
void dt_dev_history_truncate(struct dt_develop_t *dev, const int32_t imgid);
 
void dt_dev_transient_params_set(struct dt_iop_module_t *module, const void *params, size_t params_size,
                                 const void *blend_params, size_t blend_size);
 
void dt_dev_transient_params_clear(struct dt_iop_module_t *module);
 
gboolean dt_dev_transient_params_get(struct dt_develop_t *dev, const struct dt_iop_module_t *module,
                                     void *out_params, size_t out_params_size,
                                     void *out_blend, size_t out_blend_size, gboolean *out_has_blend);
 
gboolean dt_dev_transient_params_active(struct dt_develop_t *dev, const struct dt_iop_module_t *module);
 
GList *dt_history_duplicate(GList *hist);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_DEVELOP_DEV_HISTORY_H