conversion.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2025 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_COLORPROFILES_CONVERSION_H
#define DT_COLORPROFILES_CONVERSION_H
 
#include <glib.h>
#include <stddef.h>
#include <stdint.h>
 
#include "colorprofiles/profile_types.h"
#include "math/matrices.h"
 
#define DT_CONVERSION_LUT_SAMPLES 0x10000
 
struct dt_colorspaces_color_profile_t;
 
typedef struct dt_colorspaces_conversion_t dt_colorspaces_conversion_t;
 
typedef struct dt_colorspaces_endpoint_t
{
  dt_colorspaces_color_profile_type_t type;
  const char *filename;
  dt_colorspaces_profile_role_t role;
  const struct dt_colorspaces_color_profile_t *resolved;
} dt_colorspaces_endpoint_t;
 
typedef enum dt_colorspaces_conversion_flags_t
{
  DT_CONVERSION_NONE = 0,
  DT_CONVERSION_FORCE_LCMS2 = 1 << 0,
  DT_CONVERSION_SOURCE_CURVES = 1 << 1,
  DT_CONVERSION_TARGET_CURVES = 1 << 2,
  DT_CONVERSION_GAMUTCHECK = 1 << 3,
} dt_colorspaces_conversion_flags_t;
 
dt_colorspaces_conversion_t *dt_colorspaces_prepare_conversion(const dt_colorspaces_endpoint_t *const from,
                                                               const dt_colorspaces_endpoint_t *const to,
                                                               const dt_colorspaces_endpoint_t *const clip,
                                                               const dt_colorspaces_endpoint_t *const proof,
                                                               const dt_iop_color_intent_t intent,
                                                               const dt_colorspaces_conversion_flags_t flags);
 
void dt_colorspaces_free_conversion(dt_colorspaces_conversion_t **conversion);
 
typedef void (*dt_colorspaces_conversion_hook_t)(const float *const in, float *const out);
 
void dt_colorspaces_apply_conversion(const dt_colorspaces_conversion_t *const conversion,
                                     const float *const in, float *const out,
                                     const size_t width, const size_t height);
 
void dt_colorspaces_apply_conversion_hooked(const dt_colorspaces_conversion_t *const conversion,
                                            const float *const in, float *const out,
                                            const size_t width, const size_t height,
                                            const dt_colorspaces_conversion_hook_t hook);
 
/* --- What a device kernel needs -------------------------------------------
 *
 * A GPU kernel cannot call back into this module, so the numbers a conversion reduced to have
 * to be readable to upload them. These accessors are for that and nothing else: they are the
 * seam where the module hands a caller's own kernel its arguments, not a way to re-implement
 * apply on the host. A caller that finds itself running a matrix multiply from
 * dt_colorspaces_conversion_matrix() on the CPU has taken the wrong entry point.
 */
 
uint64_t dt_colorspaces_conversion_identity(const dt_colorspaces_conversion_t *const conversion);
 
gboolean dt_colorspaces_conversion_is_matrix(const dt_colorspaces_conversion_t *const conversion);
 
gboolean dt_colorspaces_conversion_has_clipping(const dt_colorspaces_conversion_t *const conversion);
 
gboolean dt_colorspaces_conversion_matrix(const dt_colorspaces_conversion_t *const conversion,
                                          dt_colormatrix_t matrix);
 
gboolean dt_colorspaces_conversion_source_matrix(const dt_colorspaces_conversion_t *const conversion,
                                                 dt_colormatrix_t matrix);
 
gboolean dt_colorspaces_conversion_clip_matrix(const dt_colorspaces_conversion_t *const conversion,
                                               dt_colormatrix_t matrix);
 
const float *dt_colorspaces_conversion_source_curve(const dt_colorspaces_conversion_t *const conversion,
                                                    const int channel);
 
const float *dt_colorspaces_conversion_target_curve(const dt_colorspaces_conversion_t *const conversion,
                                                    const int channel);
 
const float *dt_colorspaces_conversion_source_coeffs(const dt_colorspaces_conversion_t *const conversion);
 
const float *dt_colorspaces_conversion_target_coeffs(const dt_colorspaces_conversion_t *const conversion);
 
#endif // DT_COLORPROFILES_CONVERSION_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