guided_filter.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2009-2011 johannes hanika.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2016 Tobias Ellinghaus.
    Copyright (C) 2017-2019 Heiko Bauke.
    Copyright (C) 2017 Peter Budai.
    Copyright (C) 2020 Hubert Kowalski.
    Copyright (C) 2020-2021 Pascal Obry.
    Copyright (C) 2020-2021 Ralf Brown.
    Copyright (C) 2020 Robert Bridge.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2024 Alynx Zhou.
    Copyright (C) 2025-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_PIXEL_GUIDED_FILTER_H
#define DT_PIXEL_GUIDED_FILTER_H
 
#include "system/macros.h"
#include "common/opencl.h"
#include "caches/pixelpipe_cache_alloc.h"
 
#include <string.h>
 
struct dt_iop_roi_t;
 
// buffer to store single-channel image along with its dimensions
typedef struct gray_image
{
  float *data;
  int width, height;
} gray_image;
 
 
// allocate space for 1-component image of size width x height
// FIXME: the code consuming gray_image doesn't check if we actually allocated the buffer
static inline int new_gray_image(gray_image *img, int width, int height)
{
  img->data = dt_pixelpipe_cache_alloc_align_float_cache(width * height, 0);
  if(IS_NULL_PTR(img->data)) return 1;
  img->width = width;
  img->height = height;
  return 0;
}
 
 
// free space for 1-component image
static inline void free_gray_image(gray_image *img_p)
{
  dt_pixelpipe_cache_free_align(img_p->data);
  img_p->data = NULL;
}
 
 
// copy 1-component image img1 to img2
static inline void copy_gray_image(gray_image img1, gray_image img2)
{
  memcpy(img2.data, img1.data, sizeof(float) * img1.width * img1.height);
}
 
 
// minimum of two integers
static inline int min_i(int a, int b)
{
  return a < b ? a : b;
}
 
 
// maximum of two integers
static inline int max_i(int a, int b)
{
  return a > b ? a : b;
}
 
int guided_filter(const float *guide, const float *in, float *out, int width, int height, int ch, int w,
                  float sqrt_eps, float guide_weight, float min, float max);
 
#ifdef HAVE_OPENCL
 
typedef struct dt_guided_filter_cl_global_t
{
  int kernel_guided_filter_split_rgb;
  int kernel_guided_filter_box_mean_x;
  int kernel_guided_filter_box_mean_y;
  int kernel_guided_filter_guided_filter_covariances;
  int kernel_guided_filter_guided_filter_variances;
  int kernel_guided_filter_update_covariance;
  int kernel_guided_filter_solve;
  int kernel_guided_filter_generate_result;
} dt_guided_filter_cl_global_t;
 
 
void dt_guided_filter_init_cl_global(void);
 
void dt_guided_filter_free_cl_global(void);
 
int guided_filter_cl(int devid, cl_mem guide, cl_mem in, cl_mem out, int width, int height, int ch, int w,
                     float sqrt_eps, float guide_weight, float min, float max);
 
#endif
 
#endif // DT_PIXEL_GUIDED_FILTER_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