iop/drawlayer/cache.h

Go to the documentation of this file.

/*
    This file is part of the Ansel project.
    Copyright (C) 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/>.
*/
 
#ifndef DT_IOP_DRAWLAYER_CACHE_H
#define DT_IOP_DRAWLAYER_CACHE_H
 
#include "develop/imageop.h"
#include "caches/pixelpipe_cache.h"
#include "iop/drawlayer/paint.h"
 
#include <glib.h>
#include <stddef.h>
#include <stdint.h>
 
typedef struct dt_drawlayer_cache_patch_t
{
  int x;                              
  int y;                              
  int width;                          
  int height;                         
  float *pixels;                      
  dt_pixel_cache_entry_t *cache_entry;
  uint64_t cache_hash;                
  gboolean external_alloc;            
} dt_drawlayer_cache_patch_t;
 
void *dt_drawlayer_cache_alloc_temp_buffer(size_t bytes, const char *name);
void dt_drawlayer_cache_free_temp_buffer(void **buffer, const char *name);
float *dt_drawlayer_cache_ensure_scratch_buffer(float **buffer, size_t *capacity_pixels, size_t needed_pixels,
                                                const char *name);
 
void dt_drawlayer_cache_clear_transparent_float(float *pixels, size_t pixel_count);
 
void dt_drawlayer_cache_patch_clear(dt_drawlayer_cache_patch_t *patch, const char *external_alloc_name);
gboolean dt_drawlayer_cache_patch_alloc_shared(dt_drawlayer_cache_patch_t *patch, uint64_t hash, size_t pixel_count,
                                               int width, int height, const char *name, int *created_out);
gboolean dt_drawlayer_cache_ensure_mask_buffer(dt_drawlayer_cache_patch_t *mask, int width, int height,
                                               const char *name);
void dt_drawlayer_cache_patch_rdlock(const dt_drawlayer_cache_patch_t *patch);
void dt_drawlayer_cache_patch_rdunlock(const dt_drawlayer_cache_patch_t *patch);
void dt_drawlayer_cache_patch_wrlock(const dt_drawlayer_cache_patch_t *patch);
void dt_drawlayer_cache_patch_wrunlock(const dt_drawlayer_cache_patch_t *patch);
 
void dt_drawlayer_cache_invalidate_process_patch_state(gboolean *process_patch_valid, gboolean *process_patch_dirty,
                                                       dt_drawlayer_damaged_rect_t *process_dirty_rect,
                                                       int *process_patch_padding,
                                                       dt_iop_roi_t *process_combined_roi);
 
gboolean dt_drawlayer_cache_ensure_process_patch_buffer(dt_drawlayer_cache_patch_t *process_patch,
                                                        dt_drawlayer_cache_patch_t *process_stroke_mask,
                                                        int width, int height,
                                                        const char *patch_buffer_name,
                                                        const char *mask_buffer_name);
 
void dt_drawlayer_cache_build_combined_process_roi(const dt_dev_pixelpipe_iop_t *piece, const dt_iop_roi_t *process_roi,
                                                   int current_full_w, int current_full_h, int src_w, int src_h,
                                                   int module_origin_x, int module_origin_y,
                                                   dt_iop_roi_t *combined_roi);
void dt_drawlayer_cache_build_combined_process_roi_for_piece(const dt_dev_pixelpipe_iop_t *piece,
                                                             const dt_iop_roi_t *process_roi,
                                                             int current_full_w, int current_full_h,
                                                             int src_w, int src_h,
                                                             dt_iop_roi_t *combined_roi);
void dt_drawlayer_cache_resolve_piece_input_origin(const dt_dev_pixelpipe_iop_t *piece,
                                                   int current_full_w, int current_full_h,
                                                   int *module_origin_x, int *module_origin_y);
 
gboolean dt_drawlayer_cache_build_process_blend_rois(const dt_drawlayer_cache_patch_t *process_patch,
                                                     int process_patch_padding, const dt_iop_roi_t *roi_out,
                                                     dt_iop_roi_t *blend_target_roi,
                                                     dt_iop_roi_t *source_process_roi,
                                                     gboolean *direct_copy);
 
gboolean dt_drawlayer_cache_resample_process_patch_to_output(const dt_drawlayer_cache_patch_t *process_patch,
                                                             int process_patch_padding,
                                                             const dt_iop_roi_t *roi_out,
                                                             float *layerbuf, int layerbuf_width);
 
gboolean dt_drawlayer_cache_populate_process_patch_from_base(const dt_drawlayer_cache_patch_t *base_patch,
                                                             const dt_drawlayer_cache_patch_t *base_stroke_mask,
                                                             dt_drawlayer_cache_patch_t *process_patch,
                                                             dt_drawlayer_cache_patch_t *process_stroke_mask,
                                                             const dt_iop_roi_t *combined_roi, int process_pad,
                                                             int patch_width, int patch_height,
                                                             gboolean *process_patch_valid,
                                                             gboolean *process_patch_dirty,
                                                             dt_drawlayer_damaged_rect_t *process_dirty_rect,
                                                             int *process_patch_padding,
                                                             dt_iop_roi_t *process_combined_roi,
                                                             const char *patch_buffer_name,
                                                             const char *mask_buffer_name);
 
gboolean dt_drawlayer_cache_flush_process_patch_to_base(dt_drawlayer_cache_patch_t *base_patch,
                                                        dt_drawlayer_cache_patch_t *base_stroke_mask,
                                                        const dt_iop_roi_t *process_combined_roi,
                                                        dt_drawlayer_cache_patch_t *process_patch,
                                                        dt_drawlayer_cache_patch_t *process_stroke_mask,
                                                        float **process_update_pixels,
                                                        size_t *process_update_capacity_pixels,
                                                        gboolean *cache_dirty, gboolean *process_patch_dirty,
                                                        dt_drawlayer_damaged_rect_t *process_dirty_rect,
                                                        const char *update_buffer_name);
#endif // DT_IOP_DRAWLAYER_CACHE_H