rawoverexposed.c

Go to the documentation of this file.

/*
   This file is part of darktable,
   Copyright (C) 2016 Roman Lebedev.
   Copyright (C) 2016-2017 Ulrich Pegelow.
   Copyright (C) 2017, 2019 Heiko Bauke.
   Copyright (C) 2018-2021, 2023, 2025-2026 Aurélien PIERRE.
   Copyright (C) 2018 Edgardo Hoszowski.
   Copyright (C) 2019 Andreas Schneider.
   Copyright (C) 2019 Tobias Ellinghaus.
   Copyright (C) 2020 Aldric Renaudin.
   Copyright (C) 2020 Diederik Ter Rahe.
   Copyright (C) 2020 Hubert Kowalski.
   Copyright (C) 2020-2021 Pascal Obry.
   Copyright (C) 2020-2021 Ralf Brown.
   Copyright (C) 2022 Hanno Schwalm.
   Copyright (C) 2022 jandren.
   Copyright (C) 2022 Martin Bařinka.
   Copyright (C) 2022 Philipp Lutz.
   Copyright (C) 2024 Alynx Zhou.
   
   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/>.
 */
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "develop/imageop_gui.h"
 
#include "system/macros.h"
#include "system/openmp.h"
#include "system/target_clones.h"
#include "system/mem_alloc.h"
#include "common/logging.h"
#include "common/module_versioning.h"
#include "caches/pixelpipe_cache_alloc.h"
#include "common/image.h"        // for dt_image_t, ::DT_IMAGE_4BAYER
#include "common/imagebuf.h"     // for dt_iop_image_copy_by_size
#include "caches/mipmap_cache.h" // for dt_mipmap_buffer_t, dt_mipmap_cach...
#include "common/opencl.h"
#include "control/user_message.h"
#include "develop/develop.h"      // for dt_develop_t, dt_develop_t::(anony...
#include "develop/imageop.h"      // for dt_iop_module_t, dt_iop_roi_t, dt_...
#include "develop/imageop_math.h" // for FC, FCxtrans
#include "develop/pixelpipe.h"    // for dt_dev_pixelpipe_type_t::DT_DEV_PI...
#include "develop/tiling.h"
#include "iop/iop_api.h"          // for dt_iop_params_t
#include <glib/gi18n.h>           // for _
#include <gtk/gtktypes.h>         // for GtkWidget
#include <stdint.h>               // for uint16_t, uint8_t, uint32_t
#include <stdlib.h>               // for size_t, free, NULL, calloc, malloc
#include <string.h>               // for memcpy
 
DT_MODULE(1)
 
typedef struct dt_iop_rawoverexposed_t
{
  int dummy;
} dt_iop_rawoverexposed_t;
 
static const float dt_iop_rawoverexposed_colors[][4] __attribute__((aligned(64))) = {
  { 1.0f, 0.0f, 0.0f, 1.0f }, // red
  { 0.0f, 1.0f, 0.0f, 1.0f }, // green
  { 0.0f, 0.0f, 1.0f, 1.0f }, // blue
  { 0.0f, 0.0f, 0.0f, 1.0f }  // black
};
 
/* The indicator settings, sealed by commit_params() from the darkroom's GUI state and folded into
 * the pipeline cache key by runtime_data_hash(); process()/process_cl() render from them rather
 * than re-reading dev->rawoverexposed. The per-channel raw thresholds are derived from `threshold`
 * at process time, into a local, and never written back here: whatever piece->data holds at the
 * next commit is hashed as if it were a setting. */
typedef struct dt_iop_rawoverexposed_data_t
{
  dt_dev_rawoverexposed_mode_t mode;
  dt_dev_rawoverexposed_colorscheme_t colorscheme;
  float threshold;
} dt_iop_rawoverexposed_data_t;
 
typedef struct dt_iop_rawoverexposed_global_data_t
{
  int kernel_rawoverexposed_mark_cfa;
  int kernel_rawoverexposed_mark_solid;
  int kernel_rawoverexposed_falsecolor;
} dt_iop_rawoverexposed_global_data_t;
 
const char *name()
{
  return _("raw overexposed");
}
 
int default_group()
{
  return IOP_GROUP_TECHNICAL;
}
 
int flags()
{
  return IOP_FLAGS_ALLOW_TILING | IOP_FLAGS_HIDDEN | IOP_FLAGS_ONE_INSTANCE | IOP_FLAGS_NO_HISTORY_STACK;
}
 
int default_colorspace(dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece)
{
  return IOP_CS_RGB;
}
 
__DT_CLONE_TARGETS__
static void process_common_setup(const dt_iop_module_t *self, const dt_dev_pixelpipe_iop_t *piece,
                                 unsigned int threshold[4])
{
  const dt_develop_t *dev = self->dev;
  const dt_iop_rawoverexposed_data_t *const d = piece->data;
 
  // 4BAYER is not supported by this module yet anyway.
  const int ch = (dev->image_storage.flags & DT_IMAGE_4BAYER) ? 4 : 3;
 
  for(int k = 0; k < ch; k++)
  {
    // here is our threshold: the clipping is detected as (raw value > threshold)
    float chthr = d->threshold;
 
    // "undo" rawprepare iop
    chthr *= piece->dsc_in.rawprepare.raw_white_point - piece->dsc_in.rawprepare.raw_black_level;
    chthr += piece->dsc_in.rawprepare.raw_black_level;
 
    // and this is that threshold, but in raw input buffer values
    threshold[k] = (unsigned int)chthr;
  }
}
 
__DT_CLONE_TARGETS__
int process(dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece,
            const void *const ivoid, void *const ovoid)
{
  const dt_iop_roi_t *const roi_in = &piece->roi_in;
  const dt_iop_roi_t *const roi_out = &piece->roi_out;
  const dt_iop_rawoverexposed_data_t *const d = piece->data;
 
  unsigned int threshold[4] = { 0 };
  process_common_setup(self, piece, threshold);
 
  dt_develop_t *dev = self->dev;
  const dt_image_t *const image = &(dev->image_storage);
  dt_dev_pixelpipe_t *const runtime_pipe = (dt_dev_pixelpipe_t *)pipe;
 
  const int ch = piece->dsc_in.channels;
  const double iop_order = self->iop_order;
 
  const dt_dev_rawoverexposed_mode_t mode = d->mode;
  const int colorscheme = d->colorscheme;
  const float *const color = dt_iop_rawoverexposed_colors[colorscheme];
 
  dt_iop_image_copy_by_size(ovoid, ivoid, roi_out->width, roi_out->height, ch);
 
  dt_mipmap_buffer_t buf;
  dt_mipmap_cache_get(&buf, image->id, DT_MIPMAP_FULL, DT_MIPMAP_BLOCKING, 'r');
  if(IS_NULL_PTR(buf.buf))
  {
    dt_control_log(_("failed to get raw buffer from image `%s'"), image->filename);
    dt_mipmap_cache_release(&buf);
    return 0;
  }
 
#if 0
  const float in_scale = roi_in->scale;
  dt_boundingbox_t pts = {(float)(roi_out->x) / in_scale, (float)(roi_out->y) / in_scale,
                          (float)(roi_out->x + roi_out->width) / in_scale, (float)(roi_out->y + roi_out->height) / in_scale};
  printf("in  %f %f %f %f\n", pts[0], pts[1], pts[2], pts[3]);
  dt_dev_distort_backtransform_plus(dev->pipe, 0, priority, pts, 2);
  printf("out %f %f %f %f\n\n", pts[0], pts[1], pts[2], pts[3]);
#endif
 
  const uint16_t *const raw = (const uint16_t *const)buf.buf;
  float *const restrict out = DT_IS_ALIGNED((float *const)ovoid);
 
  // NOT FROM THE PIPE !!!
  const uint32_t filters = image->dsc.filters;
  const uint8_t(*const xtrans)[6] = (const uint8_t(*const)[6])image->dsc.xtrans;
 
  // acquire temp memory for distorted pixel coords
  size_t coordbufsize;
  float *const restrict coordbuf = dt_pixelpipe_cache_alloc_perthread_float(2*roi_out->width, &coordbufsize);
  if(IS_NULL_PTR(coordbuf))
  {
    dt_mipmap_cache_release(&buf);
    return 1;
  }
  __OMP_PARALLEL_FOR_SIMD__(firstprivate(dt_iop_rawoverexposed_colors))
  for(int j = 0; j < roi_out->height; j++)
  {
    float *const restrict bufptr = dt_get_perthread(coordbuf, coordbufsize);
 
    // here are all the pixels of this row
    for(int i = 0; i < roi_out->width; i++)
    {
      bufptr[2 * i] = (float)(roi_out->x + i) / roi_in->scale;
      bufptr[2 * i + 1] = (float)(roi_out->y + j) / roi_in->scale;
    }
 
    // where did they come from?
    dt_dev_distort_backtransform_plus(runtime_pipe, iop_order,
                                      DT_DEV_TRANSFORM_DIR_BACK_INCL, bufptr, roi_out->width);
 
    for(int i = 0; i < roi_out->width; i++)
    {
      const size_t pout = (size_t)ch * (j * roi_out->width + i);
 
      // not sure which float -> int to use here
      const int i_raw = (int)bufptr[2 * i];
      const int j_raw = (int)bufptr[2 * i + 1];
 
      if(i_raw < 0 || j_raw < 0 || i_raw >= buf.width || j_raw >= buf.height) continue;
 
      int c;
      if(filters == 9u)
      {
        c = FCxtrans(j_raw, i_raw, NULL, xtrans);
      }
      else // if(filters)
      {
        c = FC(j_raw, i_raw, filters);
      }
 
      const size_t pin = (size_t)j_raw * buf.width + i_raw;
      const float in = raw[pin];
 
      // was the raw pixel clipped?
      if(in < threshold[c]) continue;
 
      switch(mode)
      {
        case DT_DEV_RAWOVEREXPOSED_MODE_MARK_CFA:
          memcpy(out + pout, dt_iop_rawoverexposed_colors[c], sizeof(float) * 4);
          break;
        case DT_DEV_RAWOVEREXPOSED_MODE_MARK_SOLID:
          memcpy(out + pout, color, sizeof(float) * 4);
          break;
        case DT_DEV_RAWOVEREXPOSED_MODE_FALSECOLOR:
          out[pout + c] = 0.0;
          break;
      }
    }
  }
 
  dt_pixelpipe_cache_free_align(coordbuf);
 
  dt_mipmap_cache_release(&buf);
 
  if(pipe->mask_display & DT_DEV_PIXELPIPE_DISPLAY_MASK) dt_iop_alpha_copy(ivoid, ovoid, roi_out->width, roi_out->height);
  return 0;
}
 
#ifdef HAVE_OPENCL
int process_cl(struct dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe, const dt_dev_pixelpipe_iop_t *piece, cl_mem dev_in, cl_mem dev_out)
{
  const dt_iop_roi_t *const roi_in = &piece->roi_in;
  const dt_iop_roi_t *const roi_out = &piece->roi_out;
  const dt_iop_rawoverexposed_data_t *const d = piece->data;
  dt_develop_t *dev = self->dev;
  dt_iop_rawoverexposed_global_data_t *gd = (dt_iop_rawoverexposed_global_data_t *)self->global_data;
 
  cl_mem dev_raw = NULL;
  float *coordbuf = NULL;
  cl_mem dev_coord = NULL;
  cl_mem dev_thresholds = NULL;
  cl_mem dev_colors = NULL;
  cl_mem dev_xtrans = NULL;
 
  cl_int err = -999;
 
  const dt_image_t *const image = &(dev->image_storage);
 
  dt_mipmap_buffer_t buf;
  dt_mipmap_cache_get(&buf, image->id, DT_MIPMAP_FULL, DT_MIPMAP_BLOCKING, 'r');
  if(IS_NULL_PTR(buf.buf))
  {
    dt_control_log(_("failed to get raw buffer from image `%s'"), image->filename);
    dt_mipmap_cache_release(&buf);
    goto error;
  }
 
  const int devid = pipe->devid;
 
  const int width = roi_out->width;
  const int height = roi_out->height;
 
  size_t origin[] = { 0, 0, 0 };
  size_t region[] = { width, height, 1 };
 
  unsigned int threshold[4] = { 0 };
  process_common_setup(self, piece, threshold);
 
  err = dt_opencl_enqueue_copy_image(devid, dev_in, dev_out, origin, origin, region);
  if(err != CL_SUCCESS) goto error;
 
  const int colorscheme = d->colorscheme;
  const float *const color = dt_iop_rawoverexposed_colors[colorscheme];
 
  // NOT FROM THE PIPE !!!
  const uint32_t filters = image->dsc.filters;
 
  const int raw_width = buf.width;
  const int raw_height = buf.height;
 
  dev_raw = dt_opencl_copy_host_to_device(devid, buf.buf, raw_width, raw_height, sizeof(uint16_t));
  if(IS_NULL_PTR(dev_raw)) goto error;
 
  const size_t coordbufsize = (size_t)height * width * 2 * sizeof(float);
 
  coordbuf = dt_pixelpipe_cache_alloc_align_cache(coordbufsize, pipe->type);
  if(IS_NULL_PTR(coordbuf)) goto error;
  __OMP_PARALLEL_FOR_SIMD__()
  for(int j = 0; j < height; j++)
  {
    float *bufptr = ((float *)coordbuf) + (size_t)2 * j * width;
 
    // here are all the pixels of this row
    for(int i = 0; i < roi_out->width; i++)
    {
      bufptr[2 * i] = (float)(roi_out->x + i) / roi_in->scale;
      bufptr[2 * i + 1] = (float)(roi_out->y + j) / roi_in->scale;
    }
 
    // where did they come from?
    dt_dev_distort_backtransform_plus(pipe, self->iop_order, DT_DEV_TRANSFORM_DIR_BACK_INCL, bufptr, roi_out->width);
  }
 
  dev_coord = dt_opencl_alloc_device_buffer(devid, coordbufsize);
  if(IS_NULL_PTR(dev_coord)) goto error;
 
  /* _blocking_ memory transfer: host coordbuf buffer -> opencl dev_coordbuf */
  err = dt_opencl_write_buffer_to_device(devid, coordbuf, dev_coord, 0, coordbufsize, CL_TRUE);
  if(err != CL_SUCCESS) goto error;
 
  int kernel;
  switch(d->mode)
  {
    case DT_DEV_RAWOVEREXPOSED_MODE_MARK_CFA:
      kernel = gd->kernel_rawoverexposed_mark_cfa;
 
      dev_colors = dt_opencl_alloc_device_buffer(devid, sizeof(dt_iop_rawoverexposed_colors));
      if(IS_NULL_PTR(dev_colors)) goto error;
 
      /* _blocking_ memory transfer: host coordbuf buffer -> opencl dev_colors */
      err = dt_opencl_write_buffer_to_device(devid, (void *)dt_iop_rawoverexposed_colors, dev_colors, 0,
                                             sizeof(dt_iop_rawoverexposed_colors), CL_TRUE);
      if(err != CL_SUCCESS) goto error;
 
      break;
    case DT_DEV_RAWOVEREXPOSED_MODE_MARK_SOLID:
      kernel = gd->kernel_rawoverexposed_mark_solid;
      break;
    case DT_DEV_RAWOVEREXPOSED_MODE_FALSECOLOR:
    default:
      kernel = gd->kernel_rawoverexposed_falsecolor;
      break;
  }
 
  if(filters == 9u)
  {
    dev_xtrans
        = dt_opencl_copy_host_to_device_constant(devid, sizeof(image->dsc.xtrans), (void *)image->dsc.xtrans);
    if(IS_NULL_PTR(dev_xtrans)) goto error;
  }
 
  dev_thresholds = dt_opencl_copy_host_to_device_constant(devid, sizeof(threshold), (void *)threshold);
  if(IS_NULL_PTR(dev_thresholds)) goto error;
 
  size_t sizes[2] = { ROUNDUPDWD(width, devid), ROUNDUPDHT(height, devid) };
  dt_opencl_set_kernel_arg(devid, kernel, 0, sizeof(cl_mem), &dev_in);
  dt_opencl_set_kernel_arg(devid, kernel, 1, sizeof(cl_mem), &dev_out);
  dt_opencl_set_kernel_arg(devid, kernel, 2, sizeof(cl_mem), &dev_coord);
  dt_opencl_set_kernel_arg(devid, kernel, 3, sizeof(int), &width);
  dt_opencl_set_kernel_arg(devid, kernel, 4, sizeof(int), &height);
  dt_opencl_set_kernel_arg(devid, kernel, 5, sizeof(cl_mem), &dev_raw);
  dt_opencl_set_kernel_arg(devid, kernel, 6, sizeof(int), &raw_width);
  dt_opencl_set_kernel_arg(devid, kernel, 7, sizeof(int), &raw_height);
  dt_opencl_set_kernel_arg(devid, kernel, 8, sizeof(uint32_t), &filters);
  dt_opencl_set_kernel_arg(devid, kernel, 9, sizeof(cl_mem), &dev_xtrans);
  dt_opencl_set_kernel_arg(devid, kernel, 10, sizeof(cl_mem), &dev_thresholds);
 
  if(d->mode == DT_DEV_RAWOVEREXPOSED_MODE_MARK_CFA)
    dt_opencl_set_kernel_arg(devid, kernel, 11, sizeof(cl_mem), &dev_colors);
  else if(d->mode == DT_DEV_RAWOVEREXPOSED_MODE_MARK_SOLID)
    dt_opencl_set_kernel_arg(devid, kernel, 11, 4 * sizeof(float), color);
 
  err = dt_opencl_enqueue_kernel_2d(devid, kernel, sizes);
  if(err != CL_SUCCESS) goto error;
 
  dt_opencl_release_mem_object(dev_xtrans);
  dt_opencl_release_mem_object(dev_colors);
  dt_opencl_release_mem_object(dev_thresholds);
  dt_opencl_release_mem_object(dev_coord);
  dt_pixelpipe_cache_free_align(coordbuf);
  dt_opencl_release_mem_object(dev_raw);
  dt_mipmap_cache_release(&buf);
 
  return TRUE;
 
error:
  dt_opencl_release_mem_object(dev_xtrans);
  dt_opencl_release_mem_object(dev_colors);
  dt_opencl_release_mem_object(dev_thresholds);
  dt_opencl_release_mem_object(dev_coord);
  dt_pixelpipe_cache_free_align(coordbuf);
  dt_opencl_release_mem_object(dev_raw);
  dt_mipmap_cache_release(&buf);
  dt_print(DT_DEBUG_OPENCL, "[opencl_rawoverexposed] couldn't enqueue kernel! %d\n", err);
  return FALSE;
}
#endif
 
void tiling_callback(struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe, const struct dt_dev_pixelpipe_iop_t *piece, struct dt_develop_tiling_t *tiling)
{
  dt_develop_t *dev = self->dev;
  const dt_image_t *const image = &(dev->image_storage);
 
  // the module needs access to the full raw image which adds to the memory footprint
  // on OpenCL devices. We take account in tiling->overhead.
 
  dt_mipmap_buffer_t buf;
  int raw_width = 0;
  int raw_height = 0;
 
  dt_mipmap_cache_get(&buf, image->id, DT_MIPMAP_FULL, DT_MIPMAP_BLOCKING, 'r');
 
  if(buf.buf)
  {
    raw_width = buf.width;
    raw_height = buf.height;
  }
 
  dt_mipmap_cache_release(&buf);
 
  tiling->factor = 2.5f;  // in + out + coordinates
  tiling->maxbuf = 1.0f;
  tiling->overhead = (size_t)raw_width * raw_height * sizeof(uint16_t);
  tiling->overlap = 0;
  tiling->xalign = 1;
  tiling->yalign = 1;
  return;
}
 
void commit_params(dt_iop_module_t *self, dt_iop_params_t *p1, dt_dev_pixelpipe_t *pipe,
                   dt_dev_pixelpipe_iop_t *piece)
{
  dt_develop_t *dev = self->dev;
  dt_iop_rawoverexposed_data_t *d = piece->data;
  d->mode = dev->rawoverexposed.mode;
  d->colorscheme = dev->rawoverexposed.colorscheme;
  d->threshold = dev->rawoverexposed.threshold;
 
  if(pipe->type != DT_DEV_PIXELPIPE_FULL || !dev->rawoverexposed.enabled || !dev->gui_attached) piece->enabled = 0;
 
  const dt_image_t *const image = &(dev->image_storage);
 
  if(image->flags & DT_IMAGE_4BAYER) piece->enabled = 0;
 
  if(image->dsc.datatype != TYPE_UINT16 || !image->dsc.filters) piece->enabled = 0;
}
 
gboolean runtime_data_hash(dt_iop_module_t *self __attribute__((unused)),
                           dt_dev_pixelpipe_t *pipe __attribute__((unused)),
                           const dt_dev_pixelpipe_iop_t *piece __attribute__((unused)))
{
  return TRUE;
}
 
void init_global(dt_iop_module_so_t *module)
{
  const int program = 2; // basic.cl from programs.conf
  module->data = malloc(sizeof(dt_iop_rawoverexposed_global_data_t));
  dt_iop_rawoverexposed_global_data_t *gd = module->data;
  gd->kernel_rawoverexposed_mark_cfa = dt_opencl_create_kernel(program, "rawoverexposed_mark_cfa");
  gd->kernel_rawoverexposed_mark_solid = dt_opencl_create_kernel(program, "rawoverexposed_mark_solid");
  gd->kernel_rawoverexposed_falsecolor = dt_opencl_create_kernel(program, "rawoverexposed_falsecolor");
}
 
 
void cleanup_global(dt_iop_module_so_t *module)
{
  dt_iop_rawoverexposed_global_data_t *gd = (dt_iop_rawoverexposed_global_data_t *)module->data;
  dt_opencl_free_kernel(gd->kernel_rawoverexposed_falsecolor);
  dt_opencl_free_kernel(gd->kernel_rawoverexposed_mark_solid);
  dt_opencl_free_kernel(gd->kernel_rawoverexposed_mark_cfa);
  dt_free(module->data);
}
 
void init_pipe(dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe, dt_dev_pixelpipe_iop_t *piece)
{
  piece->data = dt_calloc_align(sizeof(dt_iop_rawoverexposed_data_t));
  piece->data_size = sizeof(dt_iop_rawoverexposed_data_t);
}
 
void cleanup_pipe(dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe, dt_dev_pixelpipe_iop_t *piece)
{
  dt_free_align(piece->data);
  piece->data = NULL;
}
 
void init(dt_iop_module_t *module)
{
  module->params = calloc(1, sizeof(dt_iop_rawoverexposed_t));
  module->default_params = calloc(1, sizeof(dt_iop_rawoverexposed_t));
  module->hide_enable_button = 1;
  module->default_enabled = 1;
  module->params_size = sizeof(dt_iop_rawoverexposed_t);
 
  // Bypasses the cache from here down while the indicator is shown. What keeps a changed setting
  // from being served the previous frame is runtime_data_hash(), not this: a bypass leaves the
  // hash unchanged, so the last module found the displayed cacheline under it and reused it.
  dt_iop_set_cache_bypass(module, TRUE);
}
 
// 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