dt_dev_pixelpipe_iop_t Struct Reference

#include <pixelpipe_hb.h>

Collaboration diagram for dt_dev_pixelpipe_iop_t:

Data Fields
struct dt_iop_module_t *void *	data
size_t	data_size
void *	blendop_data
gboolean	enabled
dt_dev_request_flags_t	request_histogram
dt_dev_histogram_collection_params_t	histogram_params
int	iwidth
int	iheight
uint64_t	hash
uint64_t	blendop_hash
uint64_t	global_hash
uint64_t	global_mask_hash
int	bpc
dt_iop_roi_t	buf_in
dt_iop_roi_t	buf_out
dt_iop_roi_t	roi_in
dt_iop_roi_t	roi_out
int	process_cl_ready
int	process_tiling_ready
dt_iop_buffer_dsc_t	dsc_in
dt_iop_buffer_dsc_t	dsc_out
dt_iop_buffer_dsc_t	dsc_mask
gboolean	bypass_cache
dt_pixel_cache_entry_t	cache_entry
gboolean	force_opencl_cache
GHashTable *	raster_masks

Detailed Description

Runtime representation of one history item instantiated inside a pixelpipe node.

A piece is the sealed processing contract for one module on one pipe. It is authored during history -> pipe synchronization and then consumed by the recursive runtime without recomputing its format contract.

Contract sealing order:

• the upstream descriptor is copied into dsc_in,
• module input_format() may overwrite the fields it requires on dsc_in,
• the resulting hard storage contract is sanitized against the actual upstream storage format; only bit depth, channel count, and RAW filter layout must match,
• dsc_out is initialized from dsc_in,
• commit_params() may update value-domain metadata that depends on module parameters, such as processed_maximum or RAW normalization coefficients,
• module output_format() may finally overwrite the output storage contract.

After synchronization:

• dsc_in and dsc_out are authoritative and immutable during process(), process_cl(), process_tiling(), and blending,
• runtime code may compare the previous piece output descriptor with dsc_in to decide whether a colorspace conversion is needed, but it must not rewrite the contract,
• ROI callbacks (modify_roi_in() / modify_roi_out()) are still allowed to mutate the piece because ROI planning happens before processing starts and some modules derive descriptor details from the planned crop,
• cache entries published by this piece inherit the descriptor of the pixels produced by this stage, namely dsc_out.

Mutable lifecycle summary:

• commit_params(), input_format(), output_format(), and ROI planning are the only places allowed to author the contract,
• processing code treats the piece as read-only,
• the cache-related fields only track output ownership/reuse hints and do not participate in the pixel format contract itself.

Field Documentation

blendop_data

void* dt_dev_pixelpipe_iop_t::blendop_data

Referenced by _commit_piece_contract(), dt_dev_pixelpipe_transform_for_blend(), dt_develop_blend_colorspace(), dt_develop_blend_process(), dt_develop_blendif_lab_blend(), dt_develop_blendif_lab_make_mask(), dt_develop_blendif_raw_blend(), dt_develop_blendif_raw_make_mask(), dt_develop_blendif_rgb_hsl_blend(), dt_develop_blendif_rgb_hsl_make_mask(), dt_develop_blendif_rgb_jzczhz_blend(), dt_develop_blendif_rgb_jzczhz_make_mask(), dt_iop_cleanup_pipe(), dt_iop_commit_params(), dt_iop_init_pipe(), rt_process_forms(), and tiling_callback_blendop().

blendop_hash

uint64_t dt_dev_pixelpipe_iop_t::blendop_hash

Referenced by _prepare_piece_input_contract(), _sync_pipe_nodes_from_history(), _sync_pipe_nodes_from_history_from_node(), dt_iop_commit_params(), and dt_pixelpipe_get_global_hash().

bpc

int dt_dev_pixelpipe_iop_t::bpc

buf_in

dt_iop_roi_t dt_dev_pixelpipe_iop_t::buf_in

Referenced by _aspect_ratio_get(), _create_background_layer_from_input(), _ratio_get_aspect(), distort_backtransform(), distort_backtransform(), distort_backtransform(), distort_mask(), distort_transform(), distort_transform(), dt_dev_pixelpipe_get_roi_out(), dt_drawlayer_cache_resolve_piece_input_origin(), dt_masks_legacy_params_v1_to_v2(), get_samples(), get_scales(), get_scales(), gui_post_expose(), modify_roi_in(), modify_roi_in(), modify_roi_in(), modify_roi_in(), modify_roi_out(), precalculate_scale(), process(), process(), process_wavelets(), and tiling_callback().

buf_out

dt_iop_roi_t dt_dev_pixelpipe_iop_t::buf_out

Referenced by _commit_box(), _iop_clipping_set_max_clip(), _set_max_clip(), button_pressed(), commit_box(), distort_backtransform(), distort_backtransform(), distort_mask(), distort_transform(), dt_dev_pixelpipe_get_roi_out(), gui_post_expose(), modify_roi_in(), modify_roi_in(), mouse_moved(), process(), set_grad_from_points(), and set_points_from_grad().

bypass_cache

gboolean dt_dev_pixelpipe_iop_t::bypass_cache

Referenced by _bypass_cache(), and dt_pixelpipe_get_global_hash().

cache_entry

dt_pixel_cache_entry_t dt_dev_pixelpipe_iop_t::cache_entry

Referenced by _reset_piece_cache_entry().

data

struct dt_iop_module_t* void* dt_dev_pixelpipe_iop_t::data

Referenced by _build_pre_module_filter_string(), _colorin_format_cst(), _colorout_format_cst(), _compute_lut(), _distort_xtransform(), _do_get_structure_auto(), _do_get_structure_lines(), _do_get_structure_quad(), _get_first_roi(), _print_export_debug(), _process(), _process_common_setup(), _seal_opencl_cache_policy(), _sync_pipe_nodes_from_history(), _sync_pipe_nodes_from_history_from_node(), _sync_private_buffer_from_preview_cache(), _update_output_cfa_descriptor(), backtransform(), build_global_distortion_map(), cleanup_pipe(), cleanup_pipe(), cleanup_pipe(), commit_params(), commit_params(), commit_params(), commit_params(), commit_params(), commit_params_late(), compute_lut(), default_cleanup_pipe(), default_commit_params(), default_init_pipe(), distort_backtransform(), distort_backtransform(), distort_backtransform(), distort_mask(), distort_transform(), distort_transform(), distort_transform(), dt_dev_distort_detail_mask(), dt_dev_get_raster_mask(), dt_dev_pixelpipe_cleanup_nodes(), dt_dev_pixelpipe_disable_after(), dt_dev_pixelpipe_disable_before(), dt_dev_pixelpipe_get_module_piece(), dt_dev_pixelpipe_get_prev_enabled_piece(), dt_dev_pixelpipe_get_roi_in(), dt_dev_pixelpipe_get_roi_out(), dt_dev_pixelpipe_process_rec(), dt_dev_pixelpipe_synch_top(), dt_dev_refresh_preview_histograms(), dt_iop_color_picker_get_ready_data(), dt_iop_commit_params(), dt_iop_levels_compute_levels_automatic(), dt_pixelpipe_get_global_hash(), init_pipe(), init_pipe(), init_pipe(), modify_roi_in(), modify_roi_in(), modify_roi_in(), modify_roi_in(), modify_roi_out(), modify_roi_out(), modify_roi_out(), process(), process(), process(), process(), process(), process(), process(), process(), process_cmatrix(), process_cmatrix_bm(), process_cmatrix_fastpath(), process_cmatrix_fastpath_clipping(), process_cmatrix_fastpath_simple(), process_cmatrix_proper(), process_common_cleanup(), process_common_setup(), process_cpu(), process_display(), process_floyd_steinberg(), process_fusion(), process_gray(), process_hsl_v1(), process_hsl_v2(), process_internal(), process_laplacian_bayer(), process_laplacian_xtrans(), process_lcms2(), process_lcms2_bm(), process_lcms2_proper(), process_lut(), process_nlmeans_cpu(), process_random(), process_rgb(), process_v1(), process_v3(), process_variance(), process_wavelets(), process_wavelets(), rt_compute_roi_in(), rt_extend_roi_in_for_clone(), rt_extend_roi_in_from_source_clones(), rt_process_forms(), tiling_callback(), toneeq_process(), transform(), transform(), write_image(), and write_image().

data_size

size_t dt_dev_pixelpipe_iop_t::data_size

Referenced by cleanup_pipe(), default_init_pipe(), dt_iop_commit_params(), init_pipe(), init_pipe(), and init_pipe().

dsc_in

dt_iop_buffer_dsc_t dt_dev_pixelpipe_iop_t::dsc_in

Referenced by _commit_piece_contract(), _compute_correction(), _develop_mask_get_post_operations(), _prepare_piece_input_contract(), _refresh_module_histogram(), _sync_private_buffer_from_preview_cache(), _update_output_cfa_descriptor(), amaze_demosaic_RT(), commit_params(), commit_params(), compute_wb_factors(), default_colorspace(), default_input_format(), default_output_format(), default_tiling_callback(), dt_dev_pixelpipe_transform_for_blend(), dt_dev_refresh_module_histogram(), dt_dev_write_rawdetail_mask(), dt_develop_blend_process(), dt_develop_blendif_lab_blend(), dt_develop_blendif_lab_make_mask(), dt_develop_blendif_raw_blend(), dt_develop_blendif_raw_make_mask(), dt_develop_blendif_rgb_hsl_blend(), dt_develop_blendif_rgb_hsl_make_mask(), dt_develop_blendif_rgb_jzczhz_blend(), dt_develop_blendif_rgb_jzczhz_make_mask(), dt_pixelpipe_get_global_hash(), dual_demosaic(), lmmse_demosaic(), output_format(), pixelpipe_process_on_CPU(), process(), process(), process(), process(), process_clip(), process_common_cleanup(), process_common_setup(), process_display(), process_gray(), process_hsl_v1(), process_hsl_v2(), process_laplacian_bayer(), process_laplacian_xtrans(), process_lch_bayer(), process_lch_xtrans(), process_rgb(), process_v1(), process_v3(), process_visualize(), process_wavelets(), rcd_demosaic(), and tiling_callback().

dsc_mask

dt_iop_buffer_dsc_t dt_dev_pixelpipe_iop_t::dsc_mask

dsc_out

dt_iop_buffer_dsc_t dt_dev_pixelpipe_iop_t::dsc_out

Referenced by _commit_piece_contract(), _default_process_tiling_ptp(), _default_process_tiling_roi(), _prepare_piece_input_contract(), _refresh_global_histogram_backbuf(), _sample_picker_from_cache(), _sync_pipe_nodes_from_history_from_node(), commit_params(), commit_params(), commit_params(), dt_dev_refresh_module_histogram(), dt_pixelpipe_get_global_hash(), modify_roi_in(), modify_roi_out(), and pixelpipe_process_on_CPU().

enabled

gboolean dt_dev_pixelpipe_iop_t::enabled

Referenced by _build_pre_module_filter_string(), _commit_piece_contract(), _dt_dev_raster_mask_check(), _get_first_roi(), _prepare_piece_input_contract(), _print_export_debug(), _seal_opencl_cache_policy(), _sync_pipe_nodes_from_history(), _sync_pipe_nodes_from_history_from_node(), _sync_private_buffer_from_preview_cache(), commit_params(), commit_params(), commit_params(), commit_params(), dt_dev_distort_backtransform_locked(), dt_dev_distort_detail_mask(), dt_dev_distort_transform_locked(), dt_dev_pixelpipe_create_nodes(), dt_dev_pixelpipe_disable_after(), dt_dev_pixelpipe_disable_before(), dt_dev_pixelpipe_get_module_piece(), dt_dev_pixelpipe_get_prev_enabled_piece(), dt_dev_pixelpipe_get_roi_in(), dt_dev_pixelpipe_get_roi_out(), dt_dev_refresh_preview_histograms(), dt_iop_commit_params(), dt_pixelpipe_get_global_hash(), gui_focus(), init_pipe(), init_pipe(), and modify_roi_in().

force_opencl_cache

gboolean dt_dev_pixelpipe_iop_t::force_opencl_cache

Referenced by _seal_opencl_cache_policy(), commit_params(), commit_params(), and dt_iop_commit_params().

global_hash

uint64_t dt_dev_pixelpipe_iop_t::global_hash

Referenced by _do_get_structure_auto(), _do_get_structure_lines(), _do_get_structure_quad(), _iop_color_picker_data_ready_callback(), _prepare_piece_input_contract(), _refresh_global_histogram_backbuf(), _sample_picker_from_cache(), _sync_pipe_nodes_from_history(), _sync_pipe_nodes_from_history_from_node(), commit_params_late(), dt_dev_pixelpipe_node_hash(), dt_dev_pixelpipe_process_rec(), dt_dev_refresh_module_histogram(), dt_iop_color_picker_get_ready_data(), dt_iop_commit_params(), dt_pixelpipe_get_global_hash(), gui_focus(), process(), process_drago(), and toneeq_process().

global_mask_hash

uint64_t dt_dev_pixelpipe_iop_t::global_mask_hash

Referenced by _prepare_piece_input_contract(), _sync_pipe_nodes_from_history(), _sync_pipe_nodes_from_history_from_node(), dt_dev_get_raster_mask(), dt_develop_blend_process(), dt_iop_commit_params(), and dt_pixelpipe_get_global_hash().

hash

uint64_t dt_dev_pixelpipe_iop_t::hash

Referenced by _prepare_piece_input_contract(), _sync_pipe_nodes_from_history(), _sync_pipe_nodes_from_history_from_node(), dt_iop_commit_params(), and dt_pixelpipe_get_global_hash().

histogram_params

dt_dev_histogram_collection_params_t dt_dev_pixelpipe_iop_t::histogram_params

Referenced by _refresh_module_histogram(), and commit_params().

iheight

int dt_dev_pixelpipe_iop_t::iheight

Referenced by _do_get_structure_lines(), _do_get_structure_quad(), _draw_retrieve_lines_from_params(), _inverse_mask(), _nm_fit_output_to_input_roi(), _nm_fitness(), modify_roi_in(), process(), and tiling_callback().

iwidth

int dt_dev_pixelpipe_iop_t::iwidth

Referenced by _do_get_structure_lines(), _do_get_structure_quad(), _draw_retrieve_lines_from_params(), _inverse_mask(), _nm_fit_output_to_input_roi(), _nm_fitness(), modify_roi_in(), process(), and tiling_callback().

process_cl_ready

int dt_dev_pixelpipe_iop_t::process_cl_ready

Referenced by _reset_processing_state(), _seal_opencl_cache_policy(), commit_params(), commit_params(), commit_params(), and dt_iop_commit_params().

process_tiling_ready

int dt_dev_pixelpipe_iop_t::process_tiling_ready

Referenced by commit_params(), commit_params(), commit_params(), dt_iop_commit_params(), and pixelpipe_process_on_CPU().

raster_masks

GHashTable* dt_dev_pixelpipe_iop_t::raster_masks

Referenced by dt_dev_get_raster_mask(), dt_dev_pixelpipe_cleanup_nodes(), dt_develop_blend_process(), process(), write_image(), and write_image().

request_histogram

dt_dev_request_flags_t dt_dev_pixelpipe_iop_t::request_histogram

Referenced by _print_perf_debug(), _seal_opencl_cache_policy(), commit_params(), commit_params(), and dt_dev_refresh_module_histogram().

roi_in

dt_iop_roi_t dt_dev_pixelpipe_iop_t::roi_in

Referenced by _default_process_tiling_ptp(), _default_process_tiling_roi(), _get_first_roi(), _refresh_module_histogram(), _sync_private_buffer_from_preview_cache(), default_process(), default_process_tiling(), default_tiling_callback(), dt_dev_pixelpipe_get_roi_in(), dt_dev_refresh_module_histogram(), dt_develop_blend_process(), dt_develop_blendif_lab_blend(), dt_develop_blendif_lab_make_mask(), dt_develop_blendif_raw_blend(), dt_develop_blendif_rgb_hsl_blend(), dt_develop_blendif_rgb_hsl_make_mask(), dt_develop_blendif_rgb_jzczhz_blend(), dt_develop_blendif_rgb_jzczhz_make_mask(), dt_drawlayer_prime_live_process_patch_before_stroke(), dt_pixelpipe_get_global_hash(), gui_focus(), pixelpipe_process_on_CPU(), process(), process(), process(), process(), process(), process(), process(), process(), process(), and tiling_callback().

roi_out

dt_iop_roi_t dt_dev_pixelpipe_iop_t::roi_out

Referenced by _refine_with_detail_mask(), _refresh_global_histogram_backbuf(), _sample_picker_from_cache(), commit_params_late(), default_process(), default_process_tiling(), default_tiling_callback(), dt_dev_pixelpipe_get_roi_in(), dt_develop_blend_process(), dt_develop_blendif_lab_blend(), dt_develop_blendif_lab_make_mask(), dt_develop_blendif_raw_blend(), dt_develop_blendif_raw_make_mask(), dt_develop_blendif_rgb_hsl_blend(), dt_develop_blendif_rgb_hsl_make_mask(), dt_develop_blendif_rgb_jzczhz_blend(), dt_develop_blendif_rgb_jzczhz_make_mask(), dt_drawlayer_prime_live_process_patch_before_stroke(), dt_pixelpipe_get_global_hash(), pixelpipe_process_on_CPU(), process(), process(), process(), process(), process(), process(), process(), process(), process(), and tiling_callback().

---

The documentation for this struct was generated from the following file:

• pixelpipe_hb.h