pixelpipe.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) 2014-2016 Roman Lebedev.
    Copyright (C) 2014, 2016, 2019 Tobias Ellinghaus.
    Copyright (C) 2019 Edgardo Hoszowski.
    Copyright (C) 2020 Pascal Obry.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2023, 2025-2026 Aurélien PIERRE.
    Copyright (C) 2026 Guillaume Stutin.
    
    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_DEVELOP_PIXELPIPE_H
#define DT_DEVELOP_PIXELPIPE_H
 
#include <stdint.h>
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
struct dt_dev_pixelpipe_t;
struct dt_dev_pixelpipe_iop_t;
 
typedef enum dt_dev_pixelpipe_type_t
{
  DT_DEV_PIXELPIPE_NONE      = 0,
  DT_DEV_PIXELPIPE_EXPORT    = 1,
  DT_DEV_PIXELPIPE_FULL      = 2,
  DT_DEV_PIXELPIPE_PREVIEW   = 3,
  DT_DEV_PIXELPIPE_THUMBNAIL = 4
} dt_dev_pixelpipe_type_t;
 
typedef enum dt_dev_request_flags_t
{
  DT_REQUEST_NONE = 0,
  DT_REQUEST_ON = 1 << 0,
  DT_REQUEST_ONLY_IN_GUI = 1 << 1
} dt_dev_request_flags_t;
 
// params to be used to collect histogram
typedef struct dt_dev_histogram_collection_params_t
{
  const struct dt_histogram_roi_t *roi;
  uint32_t bins_count;
  float mul;
} dt_dev_histogram_collection_params_t;
 
// params used to collect histogram during last histogram capture
typedef struct dt_dev_histogram_stats_t
{
  uint32_t bins_count;
  uint32_t pixels;
  uint32_t ch;
} dt_dev_histogram_stats_t;
 
#ifndef DT_IOP_PARAMS_T
#define DT_IOP_PARAMS_T
typedef void dt_iop_params_t;
#endif
 
const char *dt_pixelpipe_name(dt_dev_pixelpipe_type_t pipe);
 
/* No trailing #include of develop/pixelpipe_hb.h: that header includes
 * develop/imageop.h, which includes this one back. This file is the small shared
 * TYPE header (pipe type/request enums, histogram params); consumers that need the
 * full pipeline API include develop/pixelpipe_hb.h explicitly. */
 
uint64_t dt_dev_pixelpipe_raster_mask_hash(const struct dt_dev_pixelpipe_iop_t *piece,
                                           const int raster_mask_id);
 
uint64_t dt_dev_pixelpipe_rawdetail_mask_hash(const struct dt_dev_pixelpipe_iop_t *piece);
 
void dt_dev_clear_rawdetail_mask(struct dt_dev_pixelpipe_t *pipe);
 
#endif // DT_DEVELOP_PIXELPIPE_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