#include "common/history.h"
#include "common/history_merge.h"
#include <glib.h>

Include dependency graph for dev_history.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	dt_dev_history_item_t

Macros
#define	DT_IOP_PARAMS_T

#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))

Typedefs
typedef void	dt_iop_params_t

typedef struct dt_dev_history_item_t	dt_dev_history_item_t

Functions
void	dt_dev_history_free_history (struct dt_develop_t *dev)
	Free the whole history list attached to dev->history.

void	dt_dev_free_history_item (gpointer data)
	Free a single history item (used as GList free callback).

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)
	Fill/refresh a history item from explicit params and apply them to the module.

int	dt_dev_next_multi_priority_for_op (struct dt_develop_t dev, const char op)
	Return the next available multi_priority for an operation.

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)
	Find a module instance by op name and instance metadata.

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)
	Create a new module instance from an existing base .so.

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)
	Copy params/blend params from one module instance to another.

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)
	Create a history item from another history item, using a destination module.

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)
	Merge a list of modules into a destination image history via dt_history_merge().

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)
	Replace an image history with the content of `dev_src`.

gboolean	dt_dev_add_history_item_ext (struct dt_develop_t dev, struct dt_iop_module_t module, gboolean enable, gboolean force_new_item)
	Append or update a history item for a module.

void	dt_dev_add_history_item_real (struct dt_develop_t dev, struct dt_iop_module_t module, gboolean enable, gboolean redraw)
	Thread-safe wrapper around dt_dev_add_history_item_ext().

void	dt_dev_write_history_ext (struct dt_develop_t *dev, const int32_t imgid)
	Write dev->history to DB and XMP for a given image id.

void	dt_dev_write_history (struct dt_develop_t *dev, gboolean async)
	Thread-safe wrapper around dt_dev_write_history_ext() for dev->image_storage.id.

void	dt_dev_history_gui_update (struct dt_develop_t *dev)
	Apply history-loaded params to module GUIs.

void	dt_dev_history_pixelpipe_update (struct dt_develop_t *dev, gboolean rebuild)
	Rebuild or resync pixelpipes after backend history changes.

void	dt_dev_history_notify_change (struct dt_develop_t *dev, const int32_t imgid)
	Notify the rest of the app that history changes were written.

void	dt_dev_history_undo_start_record (struct dt_develop_t *dev)
	Start an undo record for history changes.

void	dt_dev_history_undo_end_record (struct dt_develop_t *dev)
	Finish an undo record for history changes.

void	dt_dev_history_undo_start_record_locked (struct dt_develop_t *dev)
	Start an undo record with history_mutex already locked.

void	dt_dev_history_undo_end_record_locked (struct dt_develop_t *dev)
	Finish an undo record with history_mutex already locked.

void	dt_dev_history_undo_invalidate_module (struct dt_iop_module_t *module)
	Invalidate a module pointer inside undo snapshots.

gboolean	dt_dev_read_history_ext (struct dt_develop_t *dev, const int32_t imgid)
	Read history and masks from DB and populate dev->history.

void	dt_dev_pop_history_items_ext (struct dt_develop_t *dev)
	Apply history items to module params up to dev->history_end.

void	dt_dev_pop_history_items (struct dt_develop_t *dev)
	Thread-safe wrapper around dt_dev_pop_history_items_ext(), then update GUI.

gboolean	dt_dev_reload_history_items (struct dt_develop_t *dev, const int32_t imgid)
	Reload history from DB and rebuild pipelines/GUI state.

void	dt_dev_invalidate_history_module (GList list, struct dt_iop_module_t module)
	Remove a module pointer from a history list.

uint64_t	dt_dev_history_compute_hash (struct dt_develop_t *dev)
	Get the integrity checksum of the whole history stack. This should be done ONLY when history is changed, read or written.

int32_t	dt_dev_get_history_end_ext (struct dt_develop_t *dev)
	Get the current history end index (GUI perspective).

void	dt_dev_set_history_end_ext (struct dt_develop_t *dev, const uint32_t index)
	Set the history end index (GUI perspective).

gboolean	dt_history_module_skip_copy (const int flags)
	Determine whether a module should be skipped during history copy.

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)
	Merge a single module instance into a destination history.

void	dt_dev_history_compress (struct dt_develop_t *dev)
	Compress an history from a loaded pipeline, aka simply take a snapshot of all modules parameters. This assumes the history end is properly set, which always happens after calling _pop_history_item.

void	dt_dev_history_compress_ext (struct dt_develop_t *dev, gboolean write_history)
	Variant of history compression that optionally skips DB writeback.

void	dt_dev_history_compress_or_truncate (struct dt_develop_t *dev)
	Compress history if history_end is at top, otherwise truncate.

void	dt_dev_history_cleanup (void)
	Cleanup cached statements or state used by history I/O.

gboolean	dt_dev_init_default_history (struct dt_develop_t *dev, const int32_t imgid, gboolean apply_auto_presets)
	Initialize module defaults and insert required default modules.

dt_dev_history_item_t *	dt_dev_history_get_first_item_by_module (GList history_list, struct dt_iop_module_t module)
	Find the first history item referencing a 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)
	Find the last history item referencing a module up to history_end.

int	dt_dev_history_refresh_nodes_ext (struct dt_develop_t dev, GList iop, GList history)
	Refresh GUI module nodes to match history state.

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)
	Out-of-history transient param channel.

void	dt_dev_transient_params_clear (struct dt_iop_module_t *module)
	Drop the transient slot if it belongs to `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)
	Copy the active transient params for `module` into caller buffers (pipeline thread).

gboolean	dt_dev_transient_params_active (struct dt_develop_t dev, const struct dt_iop_module_t module)
	Whether a transient slot is currently active for `module` (cheap, locked read).

Detailed Description

The common/history.h defines methods to handle histories from/to database. They work out of any GUI or development stack, so they don't care about modules .so. This file defines binders between that and the GUI/dev objects.

Definition in file dev_history.h.

Macro Definition Documentation

◆ dt_dev_add_history_item

#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))

Definition at line 259 of file dev_history.h.

◆ DT_IOP_PARAMS_T

#define DT_IOP_PARAMS_T

Definition at line 40 of file dev_history.h.

Typedef Documentation

◆ dt_dev_history_item_t

typedef struct dt_dev_history_item_t dt_dev_history_item_t

◆ dt_iop_params_t

typedef void dt_iop_params_t

Definition at line 41 of file dev_history.h.

Function Documentation

◆ dt_dev_add_history_item_ext()

gboolean dt_dev_add_history_item_ext	(	struct dt_develop_t *	dev,
		struct dt_iop_module_t *	module,
		gboolean	enable,
		gboolean	force_new_item
	)

Append or update a history item for a module.

If the last history item matches the module and force_new_item is FALSE, the existing item is reused. Otherwise a new entry is appended. If history items exist after dev->history_end, they may be removed depending on module rules (see dev_history.c).

Parameters

dev
module
enable
force_new_item

Returns: TRUE if the pipeline topology may need to be updated (new module node).

Todo:: : this copies ALL drawn masks AND masks groups used by all modules to any module history using masks.

Definition at line 795 of file dev_history.c.

References _remove_history_leaks(), dt_iop_module_t::blend_params, DT_DEBUG_HISTORY, dt_dev_history_get_last_item_by_module(), dt_dev_history_item_update_from_params(), dt_dev_set_history_end_ext(), dt_iop_check_modules_equal(), dt_iop_module_needs_mask_history(), dt_masks_snapshot_current_forms(), dt_print(), enable(), dt_dev_history_item_t::enabled, dt_iop_module_t::enabled, FALSE, dt_dev_history_item_t::forms, dt_develop_t::history, IS_NULL_PTR, dt_dev_history_item_t::num, dt_iop_module_t::params, dt_iop_module_t::params_size, and TRUE.

Referenced by _dev_history_add_filtered(), _insert_default_modules(), dt_dev_add_history_item_real(), dt_drawlayer_commit_dabs(), dt_history_merge_module_into_history(), and gui_focus().

◆ dt_dev_add_history_item_real()

void dt_dev_add_history_item_real	(	struct dt_develop_t *	dev,
		struct dt_iop_module_t *	module,
		gboolean	enable,
		gboolean	redraw
	)

Thread-safe wrapper around dt_dev_add_history_item_ext().

Locks history mutex, invalidates pipelines, triggers recomputation and saves history. This is the typical entry point for GUI actions.

Parameters

dev	Develop context.
module	Module instance.
enable	Enable state.
redraw	Whether to force a GUI redraw.

Definition at line 917 of file dev_history.c.

References darktable, dt_atomic_set_int(), dt_dev_add_history_item_ext(), dt_dev_get_history_end_ext(), dt_dev_get_history_hash(), dt_dev_get_thumbnail_size(), dt_dev_history_compute_hash(), dt_dev_masks_list_update(), dt_dev_pixelpipe_resync_history_all, dt_dev_pixelpipe_update_history_all, dt_dev_set_history_hash(), dt_dev_undo_end_record(), dt_dev_undo_start_record(), dt_dev_write_history(), dt_image_cache_get(), DT_IMAGE_CACHE_RELAXED, dt_image_cache_write_release(), dt_iop_gui_set_enable_button(), dt_pthread_rwlock_unlock, dt_pthread_rwlock_wrlock, enable(), FALSE, dt_dev_history_item_t::forms, darktable_t::gui, dt_develop_t::gui_attached, dt_develop_t::history, dt_image_t::history_hash, dt_develop_t::history_mutex, dt_image_t::id, darktable_t::image_cache, dt_develop_t::image_storage, IS_NULL_PTR, dt_develop_t::pipe, dt_develop_t::preview_pipe, dt_gui_gtk_t::reset, dt_dev_pixelpipe_t::shutdown, and TRUE.

◆ dt_dev_copy_module_contents()

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
	)

Copy params/blend params from one module instance to another.

Optionally copies the drawn masks used by mod_src from dev_src into dev_dest (if dev_src is non-NULL).

Parameters

dev_dest	Destination develop context.
dev_src	Source develop context (may be NULL to skip mask copy).
mod_dest	Destination module instance.
mod_src	Source module instance.

Returns: 0 on success, non-zero on allocation failure.

◆ dt_dev_create_module_instance()

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
	)

Create a new module instance from an existing base .so.

Parameters

dev	Develop context.
op	Operation name.
multi_name	Instance name (may be NULL/empty).
multi_priority	Instance priority.
use_next_priority	If TRUE, auto-pick the next priority for this op.

Returns: New module instance or NULL on failure.

Definition at line 242 of file dev_history.c.

References dt_free, dt_iop_get_module_by_op_priority(), dt_iop_load_module(), dt_develop_t::iop, IOP_FLAGS_ONE_INSTANCE, IS_NULL_PTR, and dt_iop_module_t::so.

Referenced by _hm_topo_apply_solution(), and _lib_snapshot_capture_state().

◆ dt_dev_free_history_item()

void dt_dev_free_history_item ( gpointer data )

Free a single history item (used as GList free callback).

Parameters

data	Pointer to dt_dev_history_item_t.

Definition at line 1004 of file dev_history.c.

References dt_dev_history_item_t::blend_params, dt_free, dt_masks_free_form(), dt_dev_history_item_t::forms, IS_NULL_PTR, dt_dev_history_item_t::params, and void().

Referenced by _history_undo_data_free(), _hm_backup_cleanup(), _hm_truncate_dest_redo_tail(), _remove_history_leaks(), dt_dev_cleanup(), dt_dev_history_free_history(), dt_dev_history_item_from_source_history_item(), dt_dev_history_truncate(), dt_dev_history_undo_start_record_locked(), and dt_dev_module_remove().

◆ dt_dev_get_history_end_ext()

int32_t dt_dev_get_history_end_ext ( struct dt_develop_t * dev )

Get the current history end index (GUI perspective).

The index is 1-based with 0 representing the raw input image. The value is sanitized against the actual history length.

Parameters

dev	Develop context.

Returns: History end index.

Definition at line 1659 of file develop.c.

References dt_develop_t::history, and dt_develop_t::history_end.

Referenced by _hm_backup_dest(), _hm_build_last_history_by_id(), _hm_build_override_map(), _hm_truncate_dest_redo_tail(), _lib_history_change_callback(), _lib_history_view_selection_changed(), _lib_snapshot_capture_state(), _lib_snapshots_add_button_clicked_callback(), _remove_history_leaks(), _sync_focused_in_place(), _update_iop_visibility(), dt_dev_add_history_item_real(), dt_dev_history_compress_or_truncate(), dt_dev_history_compute_hash(), dt_dev_history_truncate(), dt_dev_history_undo_end_record_locked(), dt_dev_history_undo_start_record_locked(), dt_dev_module_remove(), dt_dev_modules_update_multishow(), dt_dev_pixelpipe_synch_all_real(), dt_dev_pixelpipe_synch_top(), dt_dev_pop_history_items_ext(), dt_dev_write_history_ext(), dt_history_merge(), dt_masks_cleanup_unused(), dt_masks_read_masks_history(), and dt_styles_apply_to_image_merge().

◆ dt_dev_get_module_instance()

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
	)

Find a module instance by op name and instance metadata.

Tries multi_name first, then falls back to matching multi_priority.

Parameters

dev	Develop context.
op	Operation name.
multi_name	Instance name (may be NULL/empty).
multi_priority	Instance priority.

Returns: Matching module instance or NULL.

Definition at line 230 of file dev_history.c.

References IS_NULL_PTR, and name.

Referenced by _hm_topo_apply_solution(), _lib_snapshot_capture_state(), and dt_history_merge().

◆ dt_dev_history_cleanup()

void dt_dev_history_cleanup ( void )

Cleanup cached statements or state used by history I/O.

Definition at line 1282 of file dev_history.c.

Referenced by dt_cleanup().

◆ dt_dev_history_compress()

void dt_dev_history_compress ( struct dt_develop_t * dev )

Compress an history from a loaded pipeline, aka simply take a snapshot of all modules parameters. This assumes the history end is properly set, which always happens after calling _pop_history_item.

Parameters

dev

Definition at line 2144 of file dev_history.c.

References _dt_dev_history_compress_internal(), and TRUE.

Referenced by dt_dev_history_compress_or_truncate().

◆ dt_dev_history_compress_ext()

void dt_dev_history_compress_ext	(	struct dt_develop_t *	dev,
		gboolean	write_history
	)

Variant of history compression that optionally skips DB writeback.

Parameters

dev	Develop context.
write_history	If TRUE, write history to DB/XMP after compression.

Definition at line 2139 of file dev_history.c.

References _dt_dev_history_compress_internal().

Referenced by _styles_rebuild_history_from_items().

◆ dt_dev_history_compress_or_truncate()

void dt_dev_history_compress_or_truncate ( struct dt_develop_t * dev )

Compress history if history_end is at top, otherwise truncate.

Parameters

dev	Develop context.

Definition at line 2180 of file dev_history.c.

References dt_dev_get_history_end_ext(), dt_dev_history_compress(), dt_dev_history_truncate(), dt_develop_t::history, dt_image_t::id, and dt_develop_t::image_storage.

Referenced by _history_compress_apply().

◆ dt_dev_history_compute_hash()

uint64_t dt_dev_history_compute_hash ( struct dt_develop_t * dev )

Get the integrity checksum of the whole history stack. This should be done ONLY when history is changed, read or written.

Parameters

dev

Returns: uint64_t

Definition at line 898 of file dev_history.c.

References DT_DEBUG_HISTORY, dt_dev_get_history_end_ext(), dt_hash(), dt_print(), dt_dev_history_item_t::hash, and dt_develop_t::history.

Referenced by _lib_snapshot_capture_state(), dt_dev_add_history_item_real(), dt_dev_pop_history_items_ext(), dt_dev_set_history_end_ext(), dt_dev_write_history_ext(), dt_drawlayer_commit_dabs(), and gui_focus().

◆ dt_dev_history_free_history()

void dt_dev_history_free_history ( struct dt_develop_t * dev )

Free the whole history list attached to dev->history.

Frees each history item and clears the list pointer.

Parameters

dev	Develop context.

Definition at line 1016 of file dev_history.c.

References dt_dev_free_history_item(), dt_develop_t::history, and IS_NULL_PTR.

Referenced by _dt_dev_history_compress_internal(), _hm_restore_dest_from_backup(), _lib_snapshot_capture_state(), _pop_undo(), _styles_rebuild_history_from_items(), dt_dev_read_history_ext(), and leave().

◆ dt_dev_history_get_first_item_by_module()

dt_dev_history_item_t * dt_dev_history_get_first_item_by_module	(	GList *	history_list,
		struct dt_iop_module_t *	module
	)

Find the first history item referencing a module.

Parameters

history_list	History list.
module	Module instance.

Returns: First matching history item or NULL.

Definition at line 130 of file dev_history.c.

Referenced by _check_deleted_instances(), and _get_user_mod_list().

◆ dt_dev_history_get_last_item_by_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
	)

Find the last history item referencing a module up to history_end.

Parameters

history_list	History list.
module	Module instance.
history_end	Upper bound index (GUI perspective).

Returns: Last matching history item or NULL.

Definition at line 146 of file dev_history.c.

Referenced by _hm_build_last_history_by_id(), _hm_build_override_map(), _sync_focused_in_place(), _update_iop_visibility(), dt_dev_add_history_item_ext(), and dt_history_merge().

◆ dt_dev_history_gui_update()

void dt_dev_history_gui_update ( struct dt_develop_t * dev )

Apply history-loaded params to module GUIs.

Ensures module instances shown in the GUI match the history state.

Parameters

dev	Develop context.

Definition at line 1157 of file dev_history.c.

References darktable, dt_dev_history_refresh_nodes_ext(), dt_iop_gui_init(), dt_iop_gui_set_expander(), dt_iop_gui_update(), dt_iop_is_hidden(), dt_pthread_rwlock_unlock, dt_pthread_rwlock_wrlock, darktable_t::gui, dt_develop_t::gui_attached, dt_develop_t::history, dt_develop_t::history_mutex, dt_develop_t::iop, IS_NULL_PTR, and dt_gui_gtk_t::reset.

Referenced by _darkroom_image_loaded_callback(), _history_apply_history_end(), _pop_undo(), dt_ioppr_migrate_iop_order(), dt_lightroom_import(), and dt_menu_apply_dev_history_update().

◆ dt_dev_history_item_from_source_history_item()

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
	)

Create a history item from another history item, using a destination module.

Copies params/blend params, updates module ordering metadata, and snapshots masks if needed by the source module.

Parameters

dev_dest	Destination develop context (receives masks).
dev_src	Source develop context (provides masks).
hist_src	Source history item.
mod_dest	Destination module instance.
out_hist	Output history item (allocated on success).

Returns: 0 on success, non-zero on allocation failure.

◆ dt_dev_history_item_update_from_params()

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
	)

Fill/refresh a history item from explicit params and apply them to the module.

This helper exists to share code between regular history edits and history merge logic. It will:

allocate hist->params and hist->blend_params if needed,
free and replace hist->forms with forms (ownership transferred),
sync history metadata from module (op_name, multi_name, iop_order, multi_priority),
copy params/blend_params into the history buffers (params size is clamped),
apply params/blend_params to the module and recompute the hash.

Parameters

dev	develop context (currently unused, reserved for future).
hist	history item to update (must be non-NULL).
module	destination module instance (must be non-NULL).
enabled	enabled state to store/apply.
params	params buffer (if NULL, uses `module->params`).
params_size	size of `params` in bytes (ignored if params is NULL).
blend_params	blend params buffer (if NULL, uses `module->blend_params`).
forms	mask forms snapshot for this history item (ownership transferred; may be NULL).

Returns: TRUE on success, FALSE on allocation failure/invalid args.

Populate a history item from module parameters and recompute hashes.

This allocates the history buffers if needed, copies params/blend params, assigns module metadata (op name, instance data), applies the values back to the module to keep hashes in sync, and computes the history hash using the provided mask snapshot.

Parameters

dev	Develop context (currently unused, reserved for future use).
hist	History item to update.
module	Destination module instance.
enabled	Enabled state to store.
params	Optional params buffer (NULL uses module->params).
params_size	Size of `params` in bytes (ignored if params is NULL).
blend_params	Optional blend params buffer (NULL uses module->blend_params).
forms	Mask snapshot to attach (ownership transferred, may be NULL).

Returns: TRUE on success, FALSE on allocation/argument failure.

◆ dt_dev_history_notify_change()

void dt_dev_history_notify_change	(	struct dt_develop_t *	dev,
		const int32_t	imgid
	)

Notify the rest of the app that history changes were written.

Updates thumbnails and emits user-visible notices when needed.

Parameters

dev	Develop context.
imgid	Image id.

Definition at line 1228 of file dev_history.c.

References darktable, dt_dev_mask_history_overload(), dt_image_history_changed(), dt_toast_log(), FALSE, darktable_t::gui, dt_develop_t::gui_attached, dt_develop_t::history, and IS_NULL_PTR.

Referenced by _dt_dev_write_history_job_run(), dt_dev_load_image(), dt_dev_write_history(), dt_drawlayer_commit_dabs(), dt_ioppr_migrate_iop_order(), dt_lightroom_import(), and gui_focus().

◆ dt_dev_history_pixelpipe_update()

void dt_dev_history_pixelpipe_update	(	struct dt_develop_t *	dev,
		gboolean	rebuild
	)

Rebuild or resync pixelpipes after backend history changes.

Parameters

dev	Develop context.
rebuild	TRUE to rebuild pipeline topology, FALSE to resync only.

Definition at line 1194 of file dev_history.c.

References dt_dev_pixelpipe_rebuild_all, dt_dev_pixelpipe_resync_history_all, and dt_develop_t::gui_attached.

Referenced by _history_apply_history_end(), _pop_undo(), dt_ioppr_migrate_iop_order(), dt_lightroom_import(), and dt_menu_apply_dev_history_update().

◆ dt_dev_history_refresh_nodes_ext()

int dt_dev_history_refresh_nodes_ext	(	struct dt_develop_t *	dev,
		GList **	iop,
		GList *	history
	)

Refresh GUI module nodes to match history state.

Removes modules without history, creates missing instances, and reorders the GUI list according to history/pipeline ordering.

Parameters

dev	Develop context.
iop	Module list pointer.
history	History list.

Returns: 0 on success, non-zero on error.

Definition at line 2444 of file dev_history.c.

References _check_deleted_instances(), _create_deleted_modules(), _rebuild_multi_priority(), dt_dev_signal_modules_moved(), and dt_sort_iop_by_order().

Referenced by dt_dev_history_gui_update().

◆ dt_dev_history_truncate()

void dt_dev_history_truncate	(	struct dt_develop_t *	dev,
		const int32_t	imgid
	)

truncate history stack

Definition at line 2149 of file dev_history.c.

References darktable, dt_dev_free_history_item(), dt_dev_get_history_end_ext(), dt_dev_get_thumbnail_size(), dt_dev_pop_history_items_ext(), dt_dev_write_history_ext(), dt_pthread_rwlock_rdlock, dt_pthread_rwlock_unlock, dt_pthread_rwlock_wrlock, darktable_t::gui, dt_develop_t::gui_attached, dt_develop_t::history, dt_develop_t::history_mutex, and dt_gui_gtk_t::reset.

Referenced by dt_dev_history_compress_or_truncate().

◆ dt_dev_history_undo_end_record()

void dt_dev_history_undo_end_record ( struct dt_develop_t * dev )

Finish an undo record for history changes.

Parameters

dev	Develop context.

Definition at line 684 of file dev_history.c.

References dt_dev_history_undo_end_record_locked(), dt_pthread_rwlock_rdlock, dt_pthread_rwlock_unlock, dt_develop_t::history_mutex, and IS_NULL_PTR.

Referenced by dt_dev_undo_end_record().

◆ dt_dev_history_undo_end_record_locked()

void dt_dev_history_undo_end_record_locked ( struct dt_develop_t * dev )

Finish an undo record with history_mutex already locked.

Caller must hold dev->history_mutex (read or write).

Parameters

dev	Develop context.

Definition at line 692 of file dev_history.c.

Referenced by dt_dev_history_undo_end_record(), and dt_dev_module_remove().

◆ dt_dev_history_undo_invalidate_module()

void dt_dev_history_undo_invalidate_module ( struct dt_iop_module_t * module )

Invalidate a module pointer inside undo snapshots.

Used when module instances are destroyed or replaced.

Parameters

module Module to invalidate.

Definition at line 572 of file dev_history.c.

References _history_invalidate_cb(), darktable, DT_UNDO_HISTORY, dt_undo_iterate_internal(), IS_NULL_PTR, and darktable_t::undo.

Referenced by dt_dev_module_remove().

◆ dt_dev_history_undo_start_record()

void dt_dev_history_undo_start_record ( struct dt_develop_t * dev )

Start an undo record for history changes.

Called by the develop undo framework.

Parameters

dev	Develop context.

Definition at line 656 of file dev_history.c.

References dt_dev_history_undo_start_record_locked(), dt_pthread_rwlock_rdlock, dt_pthread_rwlock_unlock, dt_develop_t::history_mutex, and IS_NULL_PTR.

Referenced by dt_dev_undo_start_record().

◆ dt_dev_history_undo_start_record_locked()

void dt_dev_history_undo_start_record_locked ( struct dt_develop_t * dev )

Start an undo record with history_mutex already locked.

Caller must hold dev->history_mutex (read or write).

Parameters

dev	Develop context.

Definition at line 664 of file dev_history.c.

References dt_dev_free_history_item(), dt_dev_get_history_end_ext(), dt_free_gpointer(), dt_history_duplicate(), dt_ioppr_iop_order_copy_deep(), dt_develop_t::history, dt_develop_t::iop_order_list, IS_NULL_PTR, dt_develop_t::undo_history_before_end, dt_develop_t::undo_history_before_iop_order_list, dt_develop_t::undo_history_before_snapshot, and dt_develop_t::undo_history_depth.

Referenced by dt_dev_history_undo_start_record(), and dt_dev_module_remove().

◆ dt_dev_init_default_history()

gboolean dt_dev_init_default_history	(	struct dt_develop_t *	dev,
		const int32_t	imgid,
		gboolean	apply_auto_presets
	)

Initialize module defaults and insert required default modules.

This does not read the database history. It only loads defaults and optionally applies auto-presets, mirroring the internal init path used by dt_dev_read_history_ext().

Parameters

dev	Develop context.
imgid	Image id.
apply_auto_presets	Whether to apply auto-presets.

Returns: TRUE if this was the first initialization for the image.

Definition at line 1497 of file dev_history.c.

References _dev_auto_apply_presets(), _insert_default_modules(), dt_conf_set_string(), DT_DEBUG_HISTORY, DT_IMAGE_AUTO_PRESETS_APPLIED, dt_iop_reload_defaults(), dt_print(), dt_image_t::flags, dt_develop_t::image_storage, and dt_develop_t::iop.

Referenced by _styles_init_source_dev(), dt_dev_read_history_ext(), and dt_dev_replace_history_on_image().

◆ dt_dev_invalidate_history_module()

void dt_dev_invalidate_history_module	(	GList *	list,
		struct dt_iop_module_t *	module
	)

Remove a module pointer from a history list.

Used when modules are deleted or re-instantiated.

Parameters

list	History list.
module	Module to invalidate.

Definition at line 1957 of file dev_history.c.

Referenced by _history_invalidate_cb().

◆ dt_dev_merge_history_into_image()

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
	)

Merge a list of modules into a destination image history via dt_history_merge().

Parameters

dev_src	Source develop context (provides module params).
dest_imgid	Destination image id.
mod_list	List of module instances to merge.
merge_iop_order	Whether to merge pipeline order (TRUE) or preserve destination (FALSE).
mode	Merge strategy for history entries.
paste_instances	Whether to paste module instances.
source_label	Optional source label for the merge report header.

Returns: 0 on success, non-zero on failure.

Definition at line 354 of file dev_history.c.

References darktable, dt_dev_cleanup(), dt_dev_init(), dt_dev_pop_history_items_ext(), dt_dev_reload_history_items(), dt_dev_write_history(), dt_dev_write_history_ext(), dt_history_merge(), dt_image_cache_get(), DT_IMAGE_CACHE_SAFE, dt_image_cache_write_release(), FALSE, darktable_t::image_cache, dt_develop_t::image_storage, and IS_NULL_PTR.

Referenced by _history_copy_and_paste_on_image_merge(), and dt_styles_apply_to_image_merge().

◆ dt_dev_next_multi_priority_for_op()

int dt_dev_next_multi_priority_for_op	(	struct dt_develop_t *	dev,
		const char *	op
	)

Return the next available multi_priority for an operation.

Parameters

dev	Develop context.
op	Operation name.

Returns: Next available instance priority (>= 1).

Definition at line 218 of file dev_history.c.

References dt_develop_t::iop, m, and MAX.

◆ dt_dev_pop_history_items()

void dt_dev_pop_history_items ( struct dt_develop_t * dev )

Thread-safe wrapper around dt_dev_pop_history_items_ext(), then update GUI.

Parameters

dev	Develop context.

Definition at line 1146 of file dev_history.c.

References darktable, dt_dev_get_thumbnail_size(), dt_dev_pop_history_items_ext(), dt_pthread_rwlock_unlock, dt_pthread_rwlock_wrlock, darktable_t::gui, dt_develop_t::gui_attached, dt_develop_t::history_mutex, and dt_gui_gtk_t::reset.

Referenced by _apply_style_before_export(), and _darkroom_image_loaded_callback().

◆ dt_dev_pop_history_items_ext()

void dt_dev_pop_history_items_ext ( struct dt_develop_t * dev )

Apply history items to module params up to dev->history_end.

Does not update the GUI; see dt_dev_pop_history_items() for GUI-aware calls.

Parameters

dev	Develop context.

Definition at line 1098 of file dev_history.c.

References _dt_dev_modules_reload_defaults(), _history_to_module(), DT_DEBUG_HISTORY, dt_dev_ensure_image_storage(), dt_dev_get_history_end_ext(), dt_dev_history_compute_hash(), dt_dev_set_history_hash(), dt_ioppr_resync_pipeline(), dt_masks_replace_current_forms(), dt_print(), dt_dev_history_item_t::forms, dt_develop_t::history, i, dt_image_t::id, dt_develop_t::image_storage, and TRUE.

Referenced by _dt_dev_history_compress_internal(), _history_apply_history_end(), _hm_restore_dest_from_backup(), _pop_undo(), _styles_rebuild_history_from_items(), dt_dev_history_truncate(), dt_dev_merge_history_into_image(), dt_dev_pop_history_items(), dt_dev_reload_history_items(), dt_dev_replace_history_on_image(), and dt_styles_apply_style_item().

◆ dt_dev_read_history_ext()

gboolean dt_dev_read_history_ext	(	struct dt_develop_t *	dev,
		const int32_t	imgid
	)

Read history and masks from DB and populate dev->history.

Also loads default modules and auto-presets when needed. This initializes module internals with the full history and does not honor history_end. Call dt_dev_pop_history_items_ext() afterwards to apply history_end.

Parameters

dev	Develop context.
imgid	Image id.

Returns: TRUE if this is a newly-initialized history, FALSE otherwise.

Definition at line 1851 of file dev_history.c.

References _dev_history_db_row_cb(), _history_to_module(), darktable, dt_dev_history_db_ctx_t::dev, DT_DEBUG_HISTORY, dt_dev_ensure_image_storage(), dt_dev_history_free_history(), dt_dev_init_default_history(), dt_dev_load_modules(), dt_dev_masks_list_change(), dt_dev_masks_update_hash(), dt_dev_set_history_end_ext(), dt_history_db_foreach_history_row(), dt_history_db_get_next_history_num(), dt_history_get_end(), dt_image_cache_get(), dt_image_cache_read_release(), dt_ioppr_resync_pipeline(), dt_ioppr_set_default_iop_order(), dt_masks_read_masks_history(), dt_print(), dt_dev_history_item_t::enabled, FALSE, dt_dev_history_item_t::hash, dt_develop_t::history, darktable_t::image_cache, dt_develop_t::iop, IS_NULL_PTR, legacy_params(), dt_dev_history_item_t::multi_name, dt_dev_history_item_t::op_name, and UNKNOWN_IMAGE.

Referenced by dt_dev_load_image(), and dt_dev_reload_history_items().

◆ dt_dev_reload_history_items()

gboolean dt_dev_reload_history_items	(	struct dt_develop_t *	dev,
		const int32_t	imgid
	)

Reload history from DB and rebuild pipelines/GUI state.

Frees existing history, re-reads from DB, applies to modules, and updates GUI and pipelines. Locks history mutex.

Parameters

dev	Develop context.
imgid	Image id.

Returns: TRUE if this reload initialized a first-run history.

Definition at line 1023 of file dev_history.c.

References darktable, dt_dev_pop_history_items_ext(), dt_dev_read_history_ext(), dt_pthread_rwlock_unlock, dt_pthread_rwlock_wrlock, darktable_t::gui, dt_develop_t::gui_attached, dt_develop_t::history_mutex, and dt_gui_gtk_t::reset.

Referenced by _history_compress_apply(), _history_copy_and_paste_on_image_merge(), dt_dev_merge_history_into_image(), dt_ioppr_migrate_iop_order(), dt_lightroom_import(), and dt_menu_apply_dev_history_update().

◆ dt_dev_replace_history_on_image()

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
	)

Replace an image history with the content of dev_src.

Optionally reloads default modules before writing to DB. This is used by history replace and style replace paths.

Parameters

dev_src	Source develop context.
dest_imgid	Destination image id.
reload_defaults	Whether to reload default modules before writing.
msg	Optional debug message.

Returns: 0 on success, non-zero on failure.

Definition at line 1519 of file dev_history.c.

References dt_dev_ensure_image_storage(), dt_dev_init_default_history(), dt_dev_pop_history_items_ext(), dt_dev_write_history(), dt_ioppr_resync_pipeline(), FALSE, and reload_defaults().

Referenced by _history_copy_and_paste_on_image_merge(), and dt_styles_apply_to_image_merge().

◆ dt_dev_set_history_end_ext()

void dt_dev_set_history_end_ext	(	struct dt_develop_t *	dev,
		const uint32_t	index
	)

Set the history end index (GUI perspective).

The index is 1-based with 0 representing the raw input image. The value is sanitized against the actual history length.

Parameters

dev	Develop context.
index	New history end index.

Definition at line 1665 of file develop.c.

References dt_dev_history_compute_hash(), dt_dev_set_history_hash(), dt_develop_t::history, and dt_develop_t::history_end.

Referenced by _dt_dev_history_compress_internal(), _history_apply_history_end(), _hm_restore_dest_from_backup(), _lib_snapshot_capture_state(), _pop_undo(), _styles_rebuild_history_from_items(), dt_dev_add_history_item_ext(), dt_dev_module_remove(), dt_dev_read_history_ext(), and dt_history_merge().

◆ dt_dev_transient_params_active()

gboolean dt_dev_transient_params_active	(	struct dt_develop_t *	dev,
		const struct dt_iop_module_t *	module
	)

Whether a transient slot is currently active for module (cheap, locked read).

◆ dt_dev_transient_params_clear()

void dt_dev_transient_params_clear ( struct dt_iop_module_t * module )

Drop the transient slot if it belongs to module.

GUI/worker thread only. Call on commit/cancel/edit-exit/focus-loss. Does NOT trigger a recompute (see _set); the caller re-triggers the pipe so it renders the committed history state.

Definition at line 2532 of file dev_history.c.

References dt_develop_t::blend_params, dt_develop_t::blend_size, dt_iop_module_t::dev, dt_free, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), IS_NULL_PTR, dt_develop_t::params, dt_develop_t::params_size, dt_develop_t::serial, dt_develop_t::transient_params, and dt_develop_t::transient_params_mutex.

Referenced by dt_drawlayer_set_pipeline_realtime_mode().

◆ dt_dev_transient_params_get()

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
	)

Copy the active transient params for module into caller buffers (pipeline thread).

Returns FALSE (and leaves buffers untouched) when no transient slot is active for module or the buffer sizes do not match the published snapshot. When it returns TRUE, out_params holds a private copy safe to pass to commit_params(). out_blend/out_blend_size may be NULL/0 if the caller does not want the transient blend; *out_has_blend (optional) reports whether a transient blend snapshot was present and copied.

◆ dt_dev_transient_params_set()

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
	)

Out-of-history transient param channel.

Lets a focused module (drawlayer realtime stroke, ashift/crop edit mode) push a thread-safe snapshot of its in-progress parameters to the pipeline for rendering, WITHOUT writing permanent history. module->params belongs to the GUI thread and must never be read from the pipeline; instead the module copies its transient params into this dev-owned slot under a mutex. The pipeline reads them (also under the mutex) and commits them through the normal commit_params() path, so the transient state reaches the cache through the usual piece->global_hash mechanism. Only one module — the focused gui_module — is active at a time. History is touched only at the real commit, so undo/redo is not polluted and the database is not written per frame.

Publish (copy) module's transient params for the pipeline.

GUI/worker thread only. Replaces any previously published slot. blend_params may be NULL to keep using the history blend params. Does NOT trigger a recompute: the caller flags the pipe the way that fits its case — a realtime module raises DT_DEV_PIPE_TOP_CHANGED on the main pipe for a fast focused-piece resync, while a geometry-changing edit (crop/ashift) calls dt_dev_pixelpipe_resync_history_all() so every pipe replans ROI/formats.

Definition at line 2485 of file dev_history.c.

References dt_develop_t::blend_params, dt_develop_t::blend_size, dt_iop_module_t::dev, dt_free, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), IS_NULL_PTR, dt_develop_t::params, dt_develop_t::params_size, params_size(), dt_develop_t::serial, dt_develop_t::transient_params, and dt_develop_t::transient_params_mutex.

Referenced by _publish_backend_progress().

◆ dt_dev_write_history()

void dt_dev_write_history	(	struct dt_develop_t *	dev,
		gboolean	async
	)

Thread-safe wrapper around dt_dev_write_history_ext() for dev->image_storage.id.

Parameters

dev	Develop context.
async	When TRUE, schedule the write in a background job. When FALSE, write immediately before returning.

Definition at line 1333 of file dev_history.c.

References _dt_dev_write_history_job_run(), darktable_t::control, darktable, dt_control_add_job(), dt_control_job_create(), dt_control_job_dispose(), dt_control_job_set_params(), dt_dev_history_notify_change(), dt_dev_write_history(), dt_dev_write_history_ext(), DT_JOB_QUEUE_USER_BG, dt_pthread_rwlock_rdlock, dt_pthread_rwlock_unlock, FALSE, dt_develop_t::history_mutex, dt_image_t::id, and dt_develop_t::image_storage.

Referenced by _gui_delete_callback(), _history_apply_history_end(), copy_callback(), copy_parts_callback(), dt_dev_add_history_item_real(), dt_dev_merge_history_into_image(), dt_dev_replace_history_on_image(), dt_dev_write_history(), dt_drawlayer_commit_dabs(), dt_ioppr_change_iop_order(), dt_lightroom_import(), duplicate_callback(), gui_focus(), and new_history_callback().

◆ dt_dev_write_history_ext()

void dt_dev_write_history_ext	(	struct dt_develop_t *	dev,
		const int32_t	imgid
	)

Write dev->history to DB and XMP for a given image id.

This acquires the database lock in write mode.

Parameters

dev	Develop context.
imgid	Image id.

Definition at line 1289 of file dev_history.c.

References _cleanup_history(), darktable, DT_DEBUG_HISTORY, dt_dev_get_history_end_ext(), dt_dev_get_history_hash(), dt_dev_history_compute_hash(), dt_dev_set_history_hash(), dt_dev_write_history_item(), dt_history_set_end(), dt_image_cache_get(), DT_IMAGE_CACHE_SAFE, dt_image_cache_write_release(), dt_ioppr_write_iop_order_list(), dt_print(), dt_develop_t::history, dt_image_t::history_hash, i, darktable_t::image_cache, dt_develop_t::iop_order_list, and IS_NULL_PTR.

Referenced by _dt_dev_history_compress_internal(), _dt_dev_write_history_job_run(), _history_compress_apply(), _hm_restore_dest_from_backup(), _pop_undo(), dt_dev_history_truncate(), dt_dev_load_image(), dt_dev_merge_history_into_image(), and dt_dev_write_history().

◆ dt_history_merge_module_into_history()

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
	)

Merge a single module instance into a destination history.

Creates or reuses a destination module instance and copies its parameters. This does not resync the pipeline or pop history; callers should batch multiple merges and resync once.

Parameters

dev_dest	Destination develop context.
dev_src	Source develop context (may be NULL to skip mask copy).
mod_src	Source module instance.

Returns: 1 on success, 0 on failure.

Definition at line 468 of file dev_history.c.

References DT_DEBUG_HISTORY, dt_dev_add_history_item_ext(), dt_dev_copy_module_contents(), dt_print(), FALSE, IOP_FLAGS_ONE_INSTANCE, IS_NULL_PTR, and dt_iop_module_t::multi_name.

Referenced by dt_styles_apply_style_item().

◆ dt_history_module_skip_copy()

gboolean dt_history_module_skip_copy ( const int flags )

Determine whether a module should be skipped during history copy.

Evaluates module flags such as deprecated/unsafe/hidden.

Parameters

flags Module flags.

Returns: TRUE if module should be skipped, FALSE otherwise.

Definition at line 1969 of file dev_history.c.

References flags, IOP_FLAGS_DEPRECATED, IOP_FLAGS_HIDDEN, and IOP_FLAGS_UNSAFE_COPY.

Referenced by _get_user_mod_list(), and dt_gui_hist_dialog_new().

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ dt_dev_add_history_item

◆ DT_IOP_PARAMS_T

Typedef Documentation

◆ dt_dev_history_item_t

◆ dt_iop_params_t

Function Documentation

◆ dt_dev_add_history_item_ext()

◆ dt_dev_add_history_item_real()

◆ dt_dev_copy_module_contents()

◆ dt_dev_create_module_instance()

◆ dt_dev_free_history_item()

◆ dt_dev_get_history_end_ext()

◆ dt_dev_get_module_instance()

◆ dt_dev_history_cleanup()

◆ dt_dev_history_compress()

◆ dt_dev_history_compress_ext()

◆ dt_dev_history_compress_or_truncate()

◆ dt_dev_history_compute_hash()

◆ dt_dev_history_free_history()

◆ dt_dev_history_get_first_item_by_module()

◆ dt_dev_history_get_last_item_by_module()

◆ dt_dev_history_gui_update()

◆ dt_dev_history_item_from_source_history_item()

◆ dt_dev_history_item_update_from_params()

◆ dt_dev_history_notify_change()

◆ dt_dev_history_pixelpipe_update()

◆ dt_dev_history_refresh_nodes_ext()

◆ dt_dev_history_truncate()

◆ dt_dev_history_undo_end_record()

◆ dt_dev_history_undo_end_record_locked()

◆ dt_dev_history_undo_invalidate_module()

◆ dt_dev_history_undo_start_record()

◆ dt_dev_history_undo_start_record_locked()

◆ dt_dev_init_default_history()

◆ dt_dev_invalidate_history_module()

◆ dt_dev_merge_history_into_image()

◆ dt_dev_next_multi_priority_for_op()

◆ dt_dev_pop_history_items()

◆ dt_dev_pop_history_items_ext()

◆ dt_dev_read_history_ext()

◆ dt_dev_reload_history_items()

◆ dt_dev_replace_history_on_image()

◆ dt_dev_set_history_end_ext()

◆ dt_dev_transient_params_active()

◆ dt_dev_transient_params_clear()

◆ dt_dev_transient_params_get()

◆ dt_dev_transient_params_set()

◆ dt_dev_write_history()

◆ dt_dev_write_history_ext()

◆ dt_history_merge_module_into_history()

◆ dt_history_module_skip_copy()