/*
This file is part of darktable,
Copyright (C) 2019-2026 darktable developers.
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 .
*/
#include "common/gdk_event_utils.h"
/** Note :
* we use finite-math-only and fast-math because divisions by zero are manually avoided in the code
* fp-contract=fast enables hardware-accelerated Fused Multiply-Add
**/
#if defined(__GNUC__)
#pragma GCC optimize("finite-math-only", "fp-contract=fast", "fast-math", "no-math-errno")
#endif
#include "bauhaus/bauhaus.h"
#include "common/colorspaces_inline_conversions.h"
#include "common/chromatic_adaptation.h"
#include "common/bspline.h"
#include "common/gamut_mapping.h"
#include "common/image.h"
#include "common/dttypes.h"
#include "common/opencl.h"
#include "control/control.h"
#include "develop/develop.h"
#include "develop/imageop.h"
#include "develop/imageop_gui.h"
#include "develop/imageop_math.h"
#include "develop/noise_generator.h"
#include "develop/tiling.h"
#include "dtgtk/button.h"
#include "dtgtk/drawingarea.h"
#include "dtgtk/expander.h"
#include "dtgtk/paint.h"
#include "gui/accelerators.h"
#include "gui/color_picker_proxy.h"
#include "gui/gtk.h"
#include "gui/presets.h"
#include "iop/gaussian_elimination.h"
#include "iop/iop_api.h"
#include "gui/draw.h"
#include
#include
#include
#define INVERSE_SQRT_3 0.5773502691896258f
#define SAFETY_MARGIN 0.01f
#define DT_GUI_CURVE_EDITOR_INSET DT_PIXEL_APPLY_DPI(1)
DT_MODULE_INTROSPECTION(6, dt_iop_filmicrgb_params_t)
/**
* DOCUMENTATION
*
* This code ports :
* 1. Troy Sobotka's filmic curves for Blender (and other softs)
* https://github.com/sobotka/OpenAgXTools/blob/master/agx_colour.py
* 2. ACES camera logarithmic encoding
* https://github.com/aces-aswf/aces-core/blob/v1.3.1/transforms/ctl/utilities/ACESutil.Lin_to_Log2_param.ctl
*
* The ACES log implementation is taken from the profile_gamma.c IOP
* where it works in camera RGB space. Here, it works on an arbitrary RGB
* space. ProPhotoRGB has been chosen for its wide gamut coverage and
* for conveniency because it's already in darktable's libs. Any other
* RGB working space could work. This chouice could (should) also be
* exposed to the user.
*
* The filmic curves are tonecurves intended to simulate the luminance
* transfer function of film with "S" curves. These could be reproduced in
* the tonecurve.c IOP, however what we offer here is a parametric
* interface useful to remap accurately and promptly the middle grey
* to any arbitrary value chosen accordingly to the destination space.
*
* The combined use of both define a modern way to deal with large
* dynamic range photographs by remapping the values with a comprehensive
* interface avoiding many of the back and forth adjustments darktable
* is prone to enforce.
*
* */
typedef enum dt_iop_filmicrgb_methods_type_t
{
DT_FILMIC_METHOD_NONE = 0, // $DESCRIPTION: "no"
DT_FILMIC_METHOD_MAX_RGB = 1, // $DESCRIPTION: "max RGB"
DT_FILMIC_METHOD_LUMINANCE = 2, // $DESCRIPTION: "luminance Y"
DT_FILMIC_METHOD_POWER_NORM = 3, // $DESCRIPTION: "RGB power norm"
DT_FILMIC_METHOD_EUCLIDEAN_NORM_V1 = 4, // $DESCRIPTION: "RGB euclidean norm (legacy)"
DT_FILMIC_METHOD_EUCLIDEAN_NORM_V2 = 5, // $DESCRIPTION: "RGB euclidean norm"
} dt_iop_filmicrgb_methods_type_t;
typedef enum dt_iop_filmicrgb_curve_type_t
{
DT_FILMIC_CURVE_POLY_4 = 0, // $DESCRIPTION: "hard"
DT_FILMIC_CURVE_POLY_3 = 1, // $DESCRIPTION: "soft"
DT_FILMIC_CURVE_RATIONAL = 2, // $DESCRIPTION: "safe"
} dt_iop_filmicrgb_curve_type_t;
typedef enum dt_iop_filmicrgb_colorscience_type_t
{
DT_FILMIC_COLORSCIENCE_V1 = 0, // $DESCRIPTION: "v3 (2019)"
DT_FILMIC_COLORSCIENCE_V2 = 1, // $DESCRIPTION: "v4 (2020)"
DT_FILMIC_COLORSCIENCE_V3 = 2, // $DESCRIPTION: "v5 (2021)"
DT_FILMIC_COLORSCIENCE_V4 = 3, // $DESCRIPTION: "v6 (2022)"
DT_FILMIC_COLORSCIENCE_V5 = 4, // $DESCRIPTION: "v7 (2023)"
} dt_iop_filmicrgb_colorscience_type_t;
typedef enum dt_iop_filmicrgb_spline_version_type_t
{
DT_FILMIC_SPLINE_VERSION_V1 = 0, // $DESCRIPTION: "v1 (2019)"
DT_FILMIC_SPLINE_VERSION_V2 = 1, // $DESCRIPTION: "v2 (2020)"
DT_FILMIC_SPLINE_VERSION_V3 = 2, // $DESCRIPTION: "v3 (2021)"
} dt_iop_filmicrgb_spline_version_type_t;
typedef enum dt_iop_filmicrgb_reconstruction_type_t
{
DT_FILMIC_RECONSTRUCT_RGB = 0,
DT_FILMIC_RECONSTRUCT_RATIOS = 1,
} dt_iop_filmicrgb_reconstruction_type_t;
typedef struct dt_iop_filmic_rgb_spline_t
{
dt_aligned_pixel_t M1, M2, M3, M4, M5; // factors for the interpolation polynom
float latitude_min, latitude_max; // bounds of the latitude == linear part by design
float y[5]; // controls nodes
float x[5]; // controls nodes
dt_iop_filmicrgb_curve_type_t type[2];
} dt_iop_filmic_rgb_spline_t;
typedef enum dt_iop_filmic_rgb_gui_mode_t
{
DT_FILMIC_GUI_LOOK = 0, // default GUI, showing only the contrast curve in a log/gamma space
DT_FILMIC_GUI_BASECURVE = 1, // basecurve-like GUI, showing the contrast and brightness curves, in lin/lin space
DT_FILMIC_GUI_BASECURVE_LOG = 2, // same as previous, but log-scaled
DT_FILMIC_GUI_RANGES = 3, // zone-system-like GUI, showing the range to range mapping
DT_FILMIC_GUI_LAST
} dt_iop_filmic_rgb_gui_mode_t;
// copy enum definition for introspection
typedef enum dt_iop_filmic_noise_distribution_t
{
DT_FILMIC_NOISE_UNIFORM = DT_NOISE_UNIFORM, // $DESCRIPTION: "uniform"
DT_FILMIC_NOISE_GAUSSIAN = DT_NOISE_GAUSSIAN, // $DESCRIPTION: "gaussian"
DT_FILMIC_NOISE_POISSONIAN = DT_NOISE_POISSONIAN // $DESCRIPTION: "poissonian"
} dt_iop_filmic_noise_distribution_t;
// clang-format off
typedef struct dt_iop_filmicrgb_params_t
{
float grey_point_source; // $MIN: 0 $MAX: 100 $DEFAULT: 18.45 $DESCRIPTION: "middle gray luminance"
float black_point_source; // $MIN: -16 $MAX: -0.1 $DEFAULT: -8.0 $DESCRIPTION: "black relative exposure"
float white_point_source; // $MIN: 0.1 $MAX: 16 $DEFAULT: 4.0 $DESCRIPTION: "white relative exposure"
float reconstruct_threshold; // $MIN: -6.0 $MAX: 6.0 $DEFAULT: 0.0 $DESCRIPTION: "threshold"
float reconstruct_feather; // $MIN: 0.25 $MAX: 6.0 $DEFAULT: 3.0 $DESCRIPTION: "transition"
float reconstruct_bloom_vs_details; // $MIN: -100.0 $MAX: 100.0 $DEFAULT: 100.0 $DESCRIPTION: "bloom ↔ reconstruct"
float reconstruct_grey_vs_color; // $MIN: -100.0 $MAX: 100.0 $DEFAULT: 100.0 $DESCRIPTION: "gray ↔ colorful details"
float reconstruct_structure_vs_texture; // $MIN: -100.0 $MAX: 100.0 $DEFAULT: 0.0 $DESCRIPTION: "structure ↔ texture"
float security_factor; // $MIN: -50 $MAX: 200 $DEFAULT: 0 $DESCRIPTION: "dynamic range scaling"
float grey_point_target; // $MIN: 1 $MAX: 50 $DEFAULT: 18.45 $DESCRIPTION: "target middle gray"
float black_point_target; // $MIN: 0.000 $MAX: 20.000 $DEFAULT: 0.01517634 $DESCRIPTION: "target black luminance"
float white_point_target; // $MIN: 0 $MAX: 1600 $DEFAULT: 100 $DESCRIPTION: "target white luminance"
float output_power; // $MIN: 1 $MAX: 10 $DEFAULT: 4.0 $DESCRIPTION: "hardness"
float latitude; // $MIN: 0.01 $MAX: 99 $DEFAULT: 0.01 $DESCRIPTION: "linear region"
float contrast; // $MIN: 0 $MAX: 5 $DEFAULT: 1.0
float saturation; // $MIN: -200 $MAX: 200 $DEFAULT: 0 $DESCRIPTION: "extreme luminance saturation"
float balance; // $MIN: -50 $MAX: 50 $DEFAULT: 0.0 $DESCRIPTION: "shadows ↔ highlights balance"
float noise_level; // $MIN: 0.0 $MAX: 6.0 $DEFAULT: 0.2f $DESCRIPTION: "add noise in highlights"
dt_iop_filmicrgb_methods_type_t preserve_color; // $DEFAULT: DT_FILMIC_METHOD_POWER_NORM $DESCRIPTION: "preserve chrominance"
dt_iop_filmicrgb_colorscience_type_t version; // $DEFAULT: DT_FILMIC_COLORSCIENCE_V5 $DESCRIPTION: "color science"
gboolean auto_hardness; // $DEFAULT: TRUE $DESCRIPTION: "auto adjust hardness"
gboolean custom_grey; // $DEFAULT: FALSE $DESCRIPTION: "use custom middle-gray values"
int high_quality_reconstruction; // $MIN: 0 $MAX: 10 $DEFAULT: 1 $DESCRIPTION: "iterations of high-quality reconstruction"
dt_iop_filmic_noise_distribution_t noise_distribution; // $DEFAULT: DT_NOISE_GAUSSIAN $DESCRIPTION: "type of noise"
dt_iop_filmicrgb_curve_type_t shadows; // $DEFAULT: DT_FILMIC_CURVE_POLY_4 $DESCRIPTION: "contrast in shadows"
dt_iop_filmicrgb_curve_type_t highlights; // $DEFAULT: DT_FILMIC_CURVE_POLY_4 $DESCRIPTION: "contrast in highlights"
gboolean compensate_icc_black; // $DEFAULT: FALSE $DESCRIPTION: "compensate output ICC profile black point"
dt_iop_filmicrgb_spline_version_type_t spline_version; // $DEFAULT: DT_FILMIC_SPLINE_VERSION_V3 $DESCRIPTION: "spline handling"
gboolean enable_highlight_reconstruction; // $DEFAULT: FALSE $DESCRIPTION: "enable highlight reconstruction"
} dt_iop_filmicrgb_params_t;
// clang-format on
// custom buttons in graph views
typedef enum dt_iop_filmicrgb_gui_button_t
{
DT_FILMIC_GUI_BUTTON_TYPE = 0,
DT_FILMIC_GUI_BUTTON_LABELS = 1,
DT_FILMIC_GUI_BUTTON_LAST
} dt_iop_filmicrgb_gui_button_t;
// custom buttons in graph views - data
typedef struct dt_iop_filmicrgb_gui_button_data_t
{
// coordinates in GUI - compute them only in the drawing function
float left;
float right;
float top;
float bottom;
float w;
float h;
// properties
gint mouse_hover; // whether it should be acted on / mouse is over it
GtkStateFlags state;
// icon drawing, function as set in dtgtk/paint.h
DTGTKCairoPaintIconFunc icon;
} dt_iop_filmicrgb_gui_button_data_t;
typedef struct dt_iop_filmicrgb_gui_data_t
{
GtkWidget *white_point_source;
GtkWidget *grey_point_source;
GtkWidget *black_point_source;
GtkWidget *reconstruct_threshold, *reconstruct_bloom_vs_details, *reconstruct_grey_vs_color,
*reconstruct_structure_vs_texture, *reconstruct_feather;
GtkWidget *show_highlight_mask;
GtkWidget *security_factor;
GtkWidget *auto_button;
GtkWidget *grey_point_target;
GtkWidget *white_point_target;
GtkWidget *black_point_target;
GtkWidget *output_power;
GtkWidget *latitude;
GtkWidget *contrast;
GtkWidget *saturation;
GtkWidget *balance;
GtkWidget *preserve_color;
GtkWidget *autoset_display_gamma;
GtkWidget *shadows, *highlights;
GtkWidget *version;
GtkWidget *auto_hardness;
GtkWidget *custom_grey;
GtkWidget *high_quality_reconstruction;
GtkWidget *noise_level, *noise_distribution;
GtkWidget *compensate_icc_black;
GtkWidget *enable_highlight_reconstruction;
GtkNotebook *notebook;
GtkDrawingArea *area;
struct dt_iop_filmic_rgb_spline_t spline DT_ALIGNED_ARRAY;
gint show_mask;
dt_iop_filmic_rgb_gui_mode_t gui_mode; // graph display mode
gint gui_show_labels;
gint gui_hover;
gint gui_sizes_inited;
dt_iop_filmicrgb_gui_button_t active_button; // ID of the button under cursor
dt_iop_filmicrgb_gui_button_data_t buttons[DT_FILMIC_GUI_BUTTON_LAST];
// Cache Pango and Cairo stuff for the equalizer drawing
float line_height;
float sign_width;
float zero_width;
float graph_width;
float graph_height;
int inset;
int inner_padding;
GtkAllocation allocation;
PangoRectangle ink;
GtkStyleContext *context;
} dt_iop_filmicrgb_gui_data_t;
typedef struct dt_iop_filmicrgb_data_t
{
float max_grad;
float white_source;
float grey_source;
float black_source;
float reconstruct_threshold;
float reconstruct_feather;
float reconstruct_bloom_vs_details;
float reconstruct_grey_vs_color;
float reconstruct_structure_vs_texture;
float normalize;
float dynamic_range;
float saturation;
float output_power;
float contrast;
float sigma_toe, sigma_shoulder;
float noise_level;
int preserve_color;
int version;
int spline_version;
int high_quality_reconstruction;
struct dt_iop_filmic_rgb_spline_t spline DT_ALIGNED_ARRAY;
dt_noise_distribution_t noise_distribution;
gboolean enable_highlight_reconstruction;
} dt_iop_filmicrgb_data_t;
typedef struct dt_iop_filmicrgb_global_data_t
{
int kernel_filmic_rgb_split;
int kernel_filmic_rgb_chroma;
int kernel_filmic_mask;
int kernel_filmic_show_mask;
int kernel_filmic_inpaint_noise;
int kernel_filmic_bspline_vertical;
int kernel_filmic_bspline_horizontal;
int kernel_filmic_init_reconstruct;
int kernel_filmic_wavelets_detail;
int kernel_filmic_wavelets_reconstruct;
int kernel_filmic_compute_ratios;
int kernel_filmic_restore_ratios;
} dt_iop_filmicrgb_global_data_t;
const char *name()
{
return _("filmic rgb");
}
const char *aliases()
{
return _("tone mapping|curve|view transform|contrast|saturation|highlights");
}
const char **description(dt_iop_module_t *self)
{
return dt_iop_set_description(self, _("apply a view transform to prepare the scene-referred pipeline\n"
"for display on SDR screens and paper prints\n"
"while preventing clipping in non-destructive ways"),
_("corrective and creative"),
_("linear or non-linear, RGB, scene-referred"),
_("non-linear, RGB"),
_("non-linear, RGB, display-referred"));
}
int default_group()
{
return IOP_GROUP_TONE | IOP_GROUP_TECHNICAL;
}
int flags()
{
return IOP_FLAGS_INCLUDE_IN_STYLES | IOP_FLAGS_SUPPORTS_BLENDING | IOP_FLAGS_ALLOW_TILING;
}
dt_iop_colorspace_type_t default_colorspace(dt_iop_module_t *self,
dt_dev_pixelpipe_t *pipe,
dt_dev_pixelpipe_iop_t *piece)
{
return IOP_CS_RGB;
}
inline static gboolean dt_iop_filmic_rgb_compute_spline(const dt_iop_filmicrgb_params_t *const p,
dt_iop_filmic_rgb_spline_t *const spline);
// BEWARE: convert_to_spline_v3 supports up to v6 of params (see legacy_params)
// convert parameters from spline v1 or v2 to spline v3
static void convert_to_spline_v3(dt_iop_filmicrgb_params_t* n)
{
if(n->spline_version == DT_FILMIC_SPLINE_VERSION_V3)
return;
dt_iop_filmic_rgb_spline_t spline;
dt_iop_filmic_rgb_compute_spline(n, &spline);
// from the spline, compute new values for contrast, balance, and latitude to update spline_version to v3
const float grey_log = spline.x[2];
float toe_log = fminf(spline.x[1], grey_log);
float shoulder_log = fmaxf(spline.x[3], grey_log);
const float black_display = spline.y[0];
const float grey_display = spline.y[2];
const float white_display = spline.y[4];
const float scaled_safety_margin = SAFETY_MARGIN * (white_display - black_display);
float toe_display = fminf(spline.y[1], grey_display);
float shoulder_display = fmaxf(spline.y[3], grey_display);
const float hardness = n->output_power;
float contrast = (shoulder_display - toe_display) / (shoulder_log - toe_log);
// sanitize toe and shoulder, for min and max values, while keeping the same contrast
const float linear_intercept = grey_display - (contrast * grey_log);
if(toe_display < black_display + scaled_safety_margin)
{
toe_display = black_display + scaled_safety_margin;
// compute toe_log to keep same slope
toe_log = (toe_display - linear_intercept) / contrast;
}
if(shoulder_display > white_display - scaled_safety_margin)
{
shoulder_display = white_display - scaled_safety_margin;
// compute shoulder_log to keep same slope
shoulder_log = (shoulder_display - linear_intercept) / contrast;
}
// revert contrast adaptation that will be performed in dt_iop_filmic_rgb_compute_spline
contrast *= 8.0f / (n->white_point_source - n->black_point_source);
contrast *= hardness * powf(grey_display, hardness-1.0f);
// latitude is the % of the segment [b+safety*(w-b),w-safety*(w-b)] which is covered, where b is black_display and w white_display
const float latitude = CLAMP((shoulder_display - toe_display) / ((white_display - black_display) - 2.0f * scaled_safety_margin), 0.0f, 0.99f);
// find balance
const float toe_display_ref = latitude * (black_display + scaled_safety_margin) + (1.0f - latitude) * grey_display;
const float shoulder_display_ref = latitude * (white_display - scaled_safety_margin) + (1.0f - latitude) * grey_display;
float balance;
if(shoulder_display < shoulder_display_ref)
balance = 0.5f * (1.0f - fmaxf(shoulder_display - grey_display, 0.0f) / fmaxf(shoulder_display_ref - grey_display, 1E-5f));
else
balance = -0.5f * (1.0f - fmaxf(grey_display - toe_display, 0.0f) / fmaxf(grey_display - toe_display_ref, 1E-5f));
if(n->spline_version == DT_FILMIC_SPLINE_VERSION_V1)
{
// black and white point need to be updated as well,
// as code path for v3 will raise them to power 1.0f / hardness,
// while code path for v1 did not.
n->black_point_target = powf(black_display, hardness) * 100.0f;
n->white_point_target = powf(white_display, hardness) * 100.0f;
}
n->latitude = latitude * 100.0f;
n->contrast = contrast;
n->balance = balance * 100.0f;
n->spline_version = DT_FILMIC_SPLINE_VERSION_V3;
}
int legacy_params(dt_iop_module_t *self,
const void *const old_params,
const int old_version,
void **new_params,
int32_t *new_params_size,
int *new_version)
{
typedef struct dt_iop_filmicrgb_params_v6_t
{
float grey_point_source;
float black_point_source;
float white_point_source;
float reconstruct_threshold;
float reconstruct_feather;
float reconstruct_bloom_vs_details;
float reconstruct_grey_vs_color;
float reconstruct_structure_vs_texture;
float security_factor;
float grey_point_target;
float black_point_target;
float white_point_target;
float output_power;
float latitude;
float contrast;
float saturation;
float balance;
float noise_level;
dt_iop_filmicrgb_methods_type_t preserve_color;
dt_iop_filmicrgb_colorscience_type_t version;
gboolean auto_hardness;
gboolean custom_grey;
int high_quality_reconstruction;
dt_iop_filmic_noise_distribution_t noise_distribution;
dt_iop_filmicrgb_curve_type_t shadows;
dt_iop_filmicrgb_curve_type_t highlights;
gboolean compensate_icc_black;
dt_iop_filmicrgb_spline_version_type_t spline_version;
gboolean enable_highlight_reconstruction;
} dt_iop_filmicrgb_params_v6_t;
if(old_version == 1)
{
typedef struct dt_iop_filmicrgb_params_v1_t
{
float grey_point_source;
float black_point_source;
float white_point_source;
float security_factor;
float grey_point_target;
float black_point_target;
float white_point_target;
float output_power;
float latitude;
float contrast;
float saturation;
float balance;
int preserve_color;
} dt_iop_filmicrgb_params_v1_t;
const dt_iop_filmicrgb_params_v1_t *o = (dt_iop_filmicrgb_params_v1_t *)old_params;
dt_iop_filmicrgb_params_v6_t *n = malloc(sizeof(dt_iop_filmicrgb_params_v6_t));
n->grey_point_source = o->grey_point_source;
n->white_point_source = o->white_point_source;
n->black_point_source = o->black_point_source;
n->security_factor = o->security_factor;
n->grey_point_target = o->grey_point_target;
n->black_point_target = o->black_point_target;
n->white_point_target = o->white_point_target;
n->output_power = o->output_power;
n->latitude = o->latitude;
n->contrast = o->contrast;
n->saturation = o->saturation;
n->balance = o->balance;
n->preserve_color = o->preserve_color;
n->shadows = DT_FILMIC_CURVE_POLY_4;
n->highlights = DT_FILMIC_CURVE_POLY_3;
n->reconstruct_threshold = 6.0f; // for old edits, this ensures
// clipping threshold >> white
// level, so it's a no-op
n->reconstruct_bloom_vs_details = 100.0f;
n->reconstruct_grey_vs_color = 100.0f;
n->reconstruct_structure_vs_texture = 0.0f;
n->reconstruct_feather = 3.0f;
n->version = DT_FILMIC_COLORSCIENCE_V1;
n->auto_hardness = TRUE;
n->custom_grey = TRUE;
n->high_quality_reconstruction = 0;
n->noise_distribution = DT_FILMIC_NOISE_GAUSSIAN;
n->noise_level = 0.f;
n->spline_version = DT_FILMIC_SPLINE_VERSION_V1;
n->compensate_icc_black = FALSE;
convert_to_spline_v3((dt_iop_filmicrgb_params_t*)n);
n->enable_highlight_reconstruction = TRUE;
*new_params = n;
*new_params_size = sizeof(dt_iop_filmicrgb_params_v6_t);
*new_version = 6;
return 0;
}
if(old_version == 2)
{
typedef struct dt_iop_filmicrgb_params_v2_t
{
float grey_point_source;
float black_point_source;
float white_point_source;
float reconstruct_threshold;
float reconstruct_feather;
float reconstruct_bloom_vs_details;
float reconstruct_grey_vs_color;
float reconstruct_structure_vs_texture;
float security_factor;
float grey_point_target;
float black_point_target;
float white_point_target;
float output_power;
float latitude;
float contrast;
float saturation;
float balance;
int preserve_color;
int version;
int auto_hardness;
int custom_grey;
int high_quality_reconstruction;
dt_iop_filmicrgb_curve_type_t shadows;
dt_iop_filmicrgb_curve_type_t highlights;
} dt_iop_filmicrgb_params_v2_t;
const dt_iop_filmicrgb_params_v2_t *o = (dt_iop_filmicrgb_params_v2_t *)old_params;
dt_iop_filmicrgb_params_v6_t *n = malloc(sizeof(dt_iop_filmicrgb_params_v6_t));
n->grey_point_source = o->grey_point_source;
n->white_point_source = o->white_point_source;
n->black_point_source = o->black_point_source;
n->security_factor = o->security_factor;
n->grey_point_target = o->grey_point_target;
n->black_point_target = o->black_point_target;
n->white_point_target = o->white_point_target;
n->output_power = o->output_power;
n->latitude = o->latitude;
n->contrast = o->contrast;
n->saturation = o->saturation;
n->balance = o->balance;
n->preserve_color = o->preserve_color;
n->shadows = o->shadows;
n->highlights = o->highlights;
n->reconstruct_threshold = o->reconstruct_threshold;
n->reconstruct_bloom_vs_details = o->reconstruct_bloom_vs_details;
n->reconstruct_grey_vs_color = o->reconstruct_grey_vs_color;
n->reconstruct_structure_vs_texture = o->reconstruct_structure_vs_texture;
n->reconstruct_feather = o->reconstruct_feather;
n->version = o->version;
n->auto_hardness = o->auto_hardness;
n->custom_grey = o->custom_grey;
n->high_quality_reconstruction = o->high_quality_reconstruction;
n->noise_level = 0.2f;
n->noise_distribution = DT_FILMIC_NOISE_GAUSSIAN;
n->noise_level = 0.f;
n->spline_version = DT_FILMIC_SPLINE_VERSION_V1;
n->compensate_icc_black = FALSE;
n->enable_highlight_reconstruction = TRUE;
convert_to_spline_v3((dt_iop_filmicrgb_params_t*)n);
*new_params = n;
*new_params_size = sizeof(dt_iop_filmicrgb_params_v6_t);
*new_version = 6;
return 0;
}
if(old_version == 3)
{
typedef struct dt_iop_filmicrgb_params_v3_t
{
float grey_point_source;
float black_point_source;
float white_point_source;
float reconstruct_threshold;
float reconstruct_feather;
float reconstruct_bloom_vs_details;
float reconstruct_grey_vs_color;
float reconstruct_structure_vs_texture;
float security_factor;
float grey_point_target;
float black_point_target;
float white_point_target;
float output_power;
float latitude;
float contrast;
float saturation;
float balance;
float noise_level;
dt_iop_filmicrgb_methods_type_t preserve_color;
dt_iop_filmicrgb_colorscience_type_t version;
gboolean auto_hardness;
gboolean custom_grey;
int high_quality_reconstruction;
int noise_distribution;
dt_iop_filmicrgb_curve_type_t shadows;
dt_iop_filmicrgb_curve_type_t highlights;
} dt_iop_filmicrgb_params_v3_t;
const dt_iop_filmicrgb_params_v3_t *o = (dt_iop_filmicrgb_params_v3_t *)old_params;
dt_iop_filmicrgb_params_v6_t *n = malloc(sizeof(dt_iop_filmicrgb_params_v6_t));
n->grey_point_source = o->grey_point_source;
n->white_point_source = o->white_point_source;
n->black_point_source = o->black_point_source;
n->security_factor = o->security_factor;
n->grey_point_target = o->grey_point_target;
n->black_point_target = o->black_point_target;
n->white_point_target = o->white_point_target;
n->output_power = o->output_power;
n->latitude = o->latitude;
n->contrast = o->contrast;
n->saturation = o->saturation;
n->balance = o->balance;
n->preserve_color = o->preserve_color;
n->shadows = o->shadows;
n->highlights = o->highlights;
n->reconstruct_threshold = o->reconstruct_threshold;
n->reconstruct_bloom_vs_details = o->reconstruct_bloom_vs_details;
n->reconstruct_grey_vs_color = o->reconstruct_grey_vs_color;
n->reconstruct_structure_vs_texture = o->reconstruct_structure_vs_texture;
n->reconstruct_feather = o->reconstruct_feather;
n->version = o->version;
n->auto_hardness = o->auto_hardness;
n->custom_grey = o->custom_grey;
n->high_quality_reconstruction = o->high_quality_reconstruction;
n->noise_level = 0.2f;
n->noise_distribution = DT_FILMIC_NOISE_GAUSSIAN;
n->spline_version = DT_FILMIC_SPLINE_VERSION_V1;
n->compensate_icc_black = FALSE;
n->enable_highlight_reconstruction = TRUE;
convert_to_spline_v3((dt_iop_filmicrgb_params_t*)n);
*new_params = n;
*new_params_size = sizeof(dt_iop_filmicrgb_params_v6_t);
*new_version = 6;
return 0;
}
if(old_version == 4)
{
typedef struct dt_iop_filmicrgb_params_v4_t
{
float grey_point_source;
float black_point_source;
float white_point_source;
float reconstruct_threshold;
float reconstruct_feather;
float reconstruct_bloom_vs_details;
float reconstruct_grey_vs_color;
float reconstruct_structure_vs_texture;
float security_factor;
float grey_point_target;
float black_point_target;
float white_point_target;
float output_power;
float latitude;
float contrast;
float saturation;
float balance;
float noise_level;
dt_iop_filmicrgb_methods_type_t preserve_color;
dt_iop_filmicrgb_colorscience_type_t version;
gboolean auto_hardness;
gboolean custom_grey;
int high_quality_reconstruction;
dt_iop_filmic_noise_distribution_t noise_distribution;
dt_iop_filmicrgb_curve_type_t shadows;
dt_iop_filmicrgb_curve_type_t highlights;
gboolean compensate_icc_black;
gint internal_version;
} dt_iop_filmicrgb_params_v4_t;
const dt_iop_filmicrgb_params_v4_t *o = (dt_iop_filmicrgb_params_v4_t *)old_params;
dt_iop_filmicrgb_params_v6_t *n = malloc(sizeof(dt_iop_filmicrgb_params_v6_t));
memcpy(n, o, sizeof(dt_iop_filmicrgb_params_v4_t));
// structure didn't change except the enum instead of gint for internal_version
// we still need to convert the internal_version (in year) to the enum
switch(o->internal_version)
{
case(2019):
n->spline_version = DT_FILMIC_SPLINE_VERSION_V1;
break;
case(2020):
n->spline_version = DT_FILMIC_SPLINE_VERSION_V2;
break;
case(2021):
n->spline_version = DT_FILMIC_SPLINE_VERSION_V3;
break;
default:
return 1;
}
n->enable_highlight_reconstruction = TRUE;
convert_to_spline_v3((dt_iop_filmicrgb_params_t*)n);
*new_params = n;
*new_params_size = sizeof(dt_iop_filmicrgb_params_v6_t);
*new_version = 6;
return 0;
}
if(old_version == 5)
{
typedef struct dt_iop_filmicrgb_params_v5_t
{
float grey_point_source;
float black_point_source;
float white_point_source;
float reconstruct_threshold;
float reconstruct_feather;
float reconstruct_bloom_vs_details;
float reconstruct_grey_vs_color;
float reconstruct_structure_vs_texture;
float security_factor;
float grey_point_target;
float black_point_target;
float white_point_target;
float output_power;
float latitude;
float contrast;
float saturation;
float balance;
float noise_level;
dt_iop_filmicrgb_methods_type_t preserve_color;
dt_iop_filmicrgb_colorscience_type_t version;
gboolean auto_hardness;
gboolean custom_grey;
int high_quality_reconstruction;
dt_iop_filmic_noise_distribution_t noise_distribution;
dt_iop_filmicrgb_curve_type_t shadows;
dt_iop_filmicrgb_curve_type_t highlights;
gboolean compensate_icc_black;
dt_iop_filmicrgb_spline_version_type_t spline_version;
} dt_iop_filmicrgb_params_v5_t;
const dt_iop_filmicrgb_params_v5_t *o = (dt_iop_filmicrgb_params_v5_t *)old_params;
dt_iop_filmicrgb_params_v6_t *n = malloc(sizeof(dt_iop_filmicrgb_params_v6_t));
// Copy over the old parameters
n->grey_point_source = o->grey_point_source;
n->black_point_source = o->black_point_source;
n->white_point_source = o->white_point_source;
n->reconstruct_threshold = o->reconstruct_threshold;
n->reconstruct_feather = o->reconstruct_feather;
n->reconstruct_bloom_vs_details = o->reconstruct_bloom_vs_details;
n->reconstruct_grey_vs_color = o->reconstruct_grey_vs_color;
n->reconstruct_structure_vs_texture = o->reconstruct_structure_vs_texture;
n->security_factor = o->security_factor;
n->grey_point_target = o->grey_point_target;
n->black_point_target = o->black_point_target;
n->white_point_target = o->white_point_target;
n->output_power = o->output_power;
n->latitude = o->latitude;
n->contrast = o->contrast;
n->saturation = o->saturation;
n->balance = o->balance;
n->noise_level = o->noise_level;
n->preserve_color = o->preserve_color;
n->version = o->version;
n->auto_hardness = o->auto_hardness;
n->custom_grey = o->custom_grey;
n->high_quality_reconstruction = o->high_quality_reconstruction;
n->noise_distribution = o->noise_distribution;
n->shadows = o->shadows;
n->highlights = o->highlights;
n->compensate_icc_black = o->compensate_icc_black;
n->spline_version = o->spline_version;
// New parameter
n->enable_highlight_reconstruction = TRUE;
*new_params = n;
*new_params_size = sizeof(dt_iop_filmicrgb_params_v6_t);
*new_version = 6;
return 0;
}
return 1;
}
DT_OMP_DECLARE_SIMD(aligned(pixel:16))
static inline float pixel_rgb_norm_power(const dt_aligned_pixel_t pixel)
{
// weird norm sort of perceptual. This is black magic really, but it looks good.
// the full norm is (R^3 + G^3 + B^3) / (R^2 + G^2 + B^2) and it should be in ]0; +infinity[
float numerator = 0.0f;
float denominator = 0.0f;
for(int c = 0; c < 3; c++)
{
const float value = fabsf(pixel[c]);
const float RGB_square = value * value;
const float RGB_cubic = RGB_square * value;
numerator += RGB_cubic;
denominator += RGB_square;
}
return numerator / fmaxf(denominator, 1e-12f); // prevent from division-by-0 (note: (1e-6)^2 = 1e-12
}
DT_OMP_DECLARE_SIMD(aligned(pixel : 16) uniform(variant, work_profile))
static inline float get_pixel_norm(const dt_aligned_pixel_t pixel, const dt_iop_filmicrgb_methods_type_t variant,
const dt_iop_order_iccprofile_info_t *const work_profile)
{
// a newly added norm should satisfy the condition that it is linear with respect to grey pixels:
// norm(R, G, B) = norm(x, x, x) = x
// the desaturation code in chroma preservation mode relies on this assumption.
// DT_FILMIC_METHOD_EUCLIDEAN_NORM_V1 is an exception to this and is marked as legacy.
// DT_FILMIC_METHOD_EUCLIDEAN_NORM_V2 takes the Euclidean norm and scales it such that
// norm(1, 1, 1) = 1.
switch(variant)
{
case(DT_FILMIC_METHOD_MAX_RGB):
return max3f(pixel);
case(DT_FILMIC_METHOD_LUMINANCE):
return (work_profile)
? dt_ioppr_get_rgb_matrix_luminance(pixel, work_profile->matrix_in, work_profile->lut_in,
work_profile->unbounded_coeffs_in, work_profile->lutsize,
work_profile->nonlinearlut)
: dt_camera_rgb_luminance(pixel);
case(DT_FILMIC_METHOD_POWER_NORM):
return pixel_rgb_norm_power(pixel);
case(DT_FILMIC_METHOD_EUCLIDEAN_NORM_V1):
return sqrtf(sqf(pixel[0]) + sqf(pixel[1]) + sqf(pixel[2]));
case(DT_FILMIC_METHOD_EUCLIDEAN_NORM_V2):
return sqrtf(sqf(pixel[0]) + sqf(pixel[1]) + sqf(pixel[2])) * INVERSE_SQRT_3;
default:
return (work_profile)
? dt_ioppr_get_rgb_matrix_luminance(pixel, work_profile->matrix_in, work_profile->lut_in,
work_profile->unbounded_coeffs_in, work_profile->lutsize,
work_profile->nonlinearlut)
: dt_camera_rgb_luminance(pixel);
}
}
DT_OMP_DECLARE_SIMD(uniform(grey, black, dynamic_range))
static inline float log_tonemapping_v1(const float x, const float grey, const float black,
const float dynamic_range)
{
const float temp = (log2f(x / grey) - black) / dynamic_range;
return CLAMP(temp, NORM_MIN, 1.0f);
}
static inline float log_tonemapping_v2_1ch(const float x,
const float grey,
const float black,
const float dynamic_range)
{
return clamp_simd((log2f(x / grey) - black) / dynamic_range);
}
DT_OMP_DECLARE_SIMD(uniform(grey, black, dynamic_range))
static inline void log_tonemapping_v2(dt_aligned_pixel_t mapped,
const dt_aligned_pixel_t x,
const float grey,
const float black,
const float dynamic_range)
{
// mapped = clamp_simd((log2f(x / grey) - black) / dynamic_range);
dt_aligned_pixel_t scaled;
for_each_channel(c, aligned(mapped, x))
scaled[c] = (x[c] / grey);
dt_aligned_pixel_t log;
// We can't use dt_vector_log here because its result is enough different to make
// some integration tests fail. Hopefully the compiler will be able to substitute
// its own vectorized version of log2f().
for_each_channel(c,aligned(scaled,log))
log[c] = log2f(scaled[c]);
for_each_channel(c)
mapped[c] = (log[c] - black) / dynamic_range;
dt_vector_clip(mapped);
}
DT_OMP_DECLARE_SIMD(uniform(grey, black, dynamic_range))
static inline float exp_tonemapping_v2(const float x, const float grey, const float black,
const float dynamic_range)
{
// inverse of log_tonemapping
return grey * exp2f(dynamic_range * x + black);
}
DT_OMP_DECLARE_SIMD(aligned(M1, M2, M3, M4 : 16) uniform(M1, M2, M3, M4, M5, latitude_min, latitude_max))
static inline float filmic_spline(const float x, const dt_aligned_pixel_t M1, const dt_aligned_pixel_t M2,
const dt_aligned_pixel_t M3, const dt_aligned_pixel_t M4,
const dt_aligned_pixel_t M5, const float latitude_min,
const float latitude_max, const dt_iop_filmicrgb_curve_type_t type[2])
{
// if type polynomial :
// y = M5 * x⁴ + M4 * x³ + M3 * x² + M2 * x¹ + M1 * x⁰
// but we rewrite it using Horner factorisation, to spare ops and enable FMA in available
// else if type rational :
// y = M1 * (M2 * (x - x_0)² + (x - x_0)) / (M2 * (x - x_0)² + (x - x_0) + M3)
float result;
if(x < latitude_min)
{
// toe
if(type[0] == DT_FILMIC_CURVE_POLY_4)
{
// polynomial toe, 4th order
result = M1[0] + x * (M2[0] + x * (M3[0] + x * (M4[0] + x * M5[0])));
}
else if(type[0] == DT_FILMIC_CURVE_POLY_3)
{
// polynomial toe, 3rd order
result = M1[0] + x * (M2[0] + x * (M3[0] + x * M4[0]));
}
else
{
// rational toe
const float xi = latitude_min - x;
const float rat = xi * (xi * M2[0] + 1.f);
result = M4[0] - M1[0] * rat / (rat + M3[0]);
}
}
else if(x > latitude_max)
{
// shoulder
if(type[1] == DT_FILMIC_CURVE_POLY_4)
{
// polynomial shoulder, 4th order
result = M1[1] + x * (M2[1] + x * (M3[1] + x * (M4[1] + x * M5[1])));
}
else if(type[1] == DT_FILMIC_CURVE_POLY_3)
{
// polynomial shoulder, 3rd order
result = M1[1] + x * (M2[1] + x * (M3[1] + x * M4[1]));
}
else
{
// rational shoulder
const float xi = x - latitude_max;
const float rat = xi * (xi * M2[1] + 1.f);
result = M4[1] + M1[1] * rat / (rat + M3[1]);
}
}
else
{
// latitude
result = M1[2] + x * M2[2];
}
return result;
}
DT_OMP_DECLARE_SIMD(uniform(sigma_toe, sigma_shoulder))
static inline float filmic_desaturate_v1(const float x, const float sigma_toe, const float sigma_shoulder,
const float saturation)
{
const float radius_toe = x;
const float radius_shoulder = 1.0f - x;
const float key_toe = expf(-0.5f * radius_toe * radius_toe / sigma_toe);
const float key_shoulder = expf(-0.5f * radius_shoulder * radius_shoulder / sigma_shoulder);
return 1.0f - clamp_simd((key_toe + key_shoulder) / saturation);
}
DT_OMP_DECLARE_SIMD(uniform(sigma_toe, sigma_shoulder))
static inline float filmic_desaturate_v2(const float x, const float sigma_toe, const float sigma_shoulder,
const float saturation)
{
const float radius_toe = x;
const float radius_shoulder = 1.0f - x;
const float sat2 = 0.5f / sqrtf(saturation);
const float key_toe = expf(-radius_toe * radius_toe / sigma_toe * sat2);
const float key_shoulder = expf(-radius_shoulder * radius_shoulder / sigma_shoulder * sat2);
return (saturation - (key_toe + key_shoulder) * (saturation));
}
DT_OMP_DECLARE_SIMD()
static inline float linear_saturation(const float x, const float luminance, const float saturation)
{
return luminance + saturation * (x - luminance);
}
#define MAX_NUM_SCALES 10
DT_OMP_DECLARE_SIMD(aligned(in, mask : 64) uniform(feathering, normalize, width, height))
static inline gint mask_clipped_pixels(const float *const restrict in, float *const restrict mask,
const float normalize, const float feathering, const size_t width,
const size_t height)
{
/* 1. Detect if pixels are clipped and count them,
* 2. assign them a weight in [0. ; 1.] depending on how close from clipping they are. The weights are defined
* by a sigmoid centered in `reconstruct_threshold` so the transition is soft and symmetrical
*/
int clipped = 0;
const unsigned int oldMode = dt_mm_enable_flush_zero();
DT_OMP_FOR(reduction(+:clipped))
for(size_t k = 0; k < 4 * height * width; k += 4)
{
const float pix_max = sqrtf(sqf(in[k]) + sqf(in[k + 1]) + sqf(in[k + 2]));
const float argument = -pix_max * normalize + feathering;
const float weight = clamp_simd(1.0f / (1.0f + exp2f(argument)));
mask[k / 4] = weight;
// at x = 4, the sigmoid produces opacity = 5.882 %.
// any x > 4 will produce negligible changes over the image,
// especially since we have reduced visual sensitivity in highlights.
// so we discard pixels for argument > 4. for they are not worth computing.
clipped += (4.f > argument) ? 1 : 0;
}
dt_mm_restore_flush_zero(oldMode);
// If clipped area is < 9 pixels, recovery is not worth the computational cost, so skip it.
return clipped > 9;
}
DT_OMP_DECLARE_SIMD(aligned(in, mask, inpainted:64) uniform(width, height, noise_level, noise_distribution, threshold))
inline static void inpaint_noise(const float *const in, const float *const mask,
float *const inpainted, const float noise_level, const float threshold,
const dt_noise_distribution_t noise_distribution,
const size_t width, const size_t height)
{
// add statistical noise in highlights to fill-in texture
// this creates "particules" in highlights, that will help the implicit partial derivative equation
// solver used in wavelets reconstruction to generate texture
const uint32_t splitmix32_1337 = splitmix32(1337);
const uint32_t splitmix32_666 = splitmix32(666);
DT_OMP_FOR(collapse(2))
for(size_t i = 0; i < height; i++)
for(size_t j = 0; j < width; j++)
{
// Init random number generator
uint32_t DT_ALIGNED_ARRAY state[4]
= { splitmix32(j + 1),
splitmix32((j + 1) * (i + 3)),
splitmix32_1337,
splitmix32_666 };
xoshiro128plus(state);
xoshiro128plus(state);
xoshiro128plus(state);
xoshiro128plus(state);
// get the mask value in [0 ; 1]
const size_t idx = i * width + j;
const size_t index = idx * 4;
const float weight = mask[idx];
const float *const restrict pix_in = DT_IS_ALIGNED_PIXEL(in + index);
dt_aligned_pixel_t noise = { 0.f };
dt_aligned_pixel_t sigma = { 0.f };
const int DT_ALIGNED_ARRAY flip[4] = { TRUE, FALSE, TRUE, FALSE };
for_each_channel(c,aligned(pix_in))
sigma[c] = pix_in[c] * noise_level / threshold;
// create statistical noise
dt_noise_generator_simd(noise_distribution, pix_in, sigma, flip, state, noise);
// add noise to input
dt_aligned_pixel_t pix_out;
for_each_channel(c,aligned(pix_in,noise,pix_out))
pix_out[c] = MAX(pix_in[c] * (1.0f - weight) + weight * noise[c], 0.0f);
copy_pixel_nontemporal(inpainted + index, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal write complete before we attempt to read the output
}
inline static void wavelets_reconstruct_RGB(const float *const restrict HF, const float *const restrict LF,
const float *const restrict texture, const float *const restrict mask,
float *const restrict reconstructed, const size_t width,
const size_t height, const float gamma,
const float gamma_comp, const float beta, const float beta_comp,
const float delta, const size_t s, const size_t scales)
{
DT_OMP_FOR_SIMD()
for(size_t k = 0; k < 4 * height * width; k += 4)
{
const float alpha = mask[k / 4];
// cache RGB wavelets scales just to be sure the compiler doesn't reload them
const float *const restrict HF_c = DT_IS_ALIGNED_PIXEL(HF + k);
const float *const restrict LF_c = DT_IS_ALIGNED_PIXEL(LF + k);
const float *const restrict TT_c = DT_IS_ALIGNED_PIXEL(texture + k);
// synthesize the max of all RGB channels texture as a flat texture term for the whole pixel
// this is useful if only 1 or 2 channels are clipped, so we transfer the valid/sharpest texture on the other
// channels
const float grey_texture = fmaxabsf(fmaxabsf(TT_c[0], TT_c[1]), TT_c[2]);
// synthesize the mean of all interpolated/inpainted RGB channels as a flat details term for the whole pixel
// this is smoother than grey_texture and will fill holes smoothly in details layers if grey_texture ~= 0.f
const float grey_details = (HF_c[0] + HF_c[1] + HF_c[2]) / 3.f;
// synthesize both terms with weighting
// when beta_comp ~= 1.0, we force the reconstruction to be achromatic, which may help with gamut issues or
// magenta highlights.
const float grey_HF = beta_comp * (gamma_comp * grey_details + gamma * grey_texture);
// synthesize the min of all low-frequency RGB channels as a flat
// structure term for the whole pixel
// when beta_comp ~= 1.0, we force the reconstruction to be
// achromatic, which may help with gamut issues or magenta
// highlights.
const float grey_residual = beta_comp * (LF_c[0] + LF_c[1] + LF_c[2]) / 3.f;
// synthesize interpolated/inpainted RGB channels color details residuals and weigh them
// this brings back some color on top of the grey_residual
dt_aligned_pixel_t details;
for_each_channel(c, aligned(details, HF_c, TT_c))
{
details[c] = (gamma_comp * HF_c[c] + gamma * TT_c[c]) * beta + grey_HF;
}
dt_aligned_pixel_t residual;
for_each_channel(c, aligned(LF_c))
residual[c] = (s == scales - 1) ? (grey_residual + LF_c[c] * beta) : 0.f;
for_each_channel(c,aligned(reconstructed))
reconstructed[k + c] += alpha * (delta * details[c] + residual[c]);
}
}
static inline void wavelets_reconstruct_ratios(const float *const restrict HF,
const float *const restrict LF,
const float *const restrict texture,
const float *const restrict mask,
float *const restrict reconstructed,
const size_t width,
const size_t height,
const float gamma,
const float gamma_comp,
const float beta,
const float beta_comp,
const float delta,
const size_t s, const size_t scales)
{
/*
* This is the adapted version of the RGB reconstruction
* RGB contain high frequencies that we try to recover, so we favor them in the reconstruction.
* The ratios represent the chromaticity in image and contain low frequencies in the absence of noise or
* aberrations, so, here, we favor them instead.
*
* Consequences :
* 1. use min of interpolated channels details instead of max, to get smoother details
* 4. use the max of low frequency channels instead of min, to favor achromatic solution.
*
* Note : ratios close to 1 mean higher spectral purity (more white). Ratios close to 0 mean lower spectral purity
* (more colorful)
*/
DT_OMP_FOR_SIMD()
for(size_t k = 0; k < 4 * height * width; k += 4)
{
const float alpha = mask[k / 4];
// cache RGB wavelets scales just to be sure the compiler doesn't reload them
const float *const restrict HF_c = DT_IS_ALIGNED_PIXEL(HF + k);
const float *const restrict LF_c = DT_IS_ALIGNED_PIXEL(LF + k);
const float *const restrict TT_c = DT_IS_ALIGNED_PIXEL(texture + k);
// synthesize the max of all RGB channels texture as a flat texture term for the whole pixel
// this is useful if only 1 or 2 channels are clipped, so we transfer the valid/sharpest texture on the other
// channels
const float grey_texture = fmaxabsf(fmaxabsf(TT_c[0], TT_c[1]), TT_c[2]);
// synthesize the mean of all interpolated/inpainted RGB channels as a flat details term for the whole pixel
// this is smoother than grey_texture and will fill holes smoothly in details layers if grey_texture ~= 0.f
const float grey_details = (HF_c[0] + HF_c[1] + HF_c[2]) / 3.f;
// synthesize both terms with weighting
// when beta_comp ~= 1.0, we force the reconstruction to be achromatic, which may help with gamut issues or
// magenta highlights.
const float grey_HF = (gamma_comp * grey_details + gamma * grey_texture);
dt_aligned_pixel_t details;
for_each_channel(c,aligned(reconstructed:64) aligned(HF_c, TT_c, LF_c:16) linear(k:4))
{
// synthesize interpolated/inpainted RGB channels color details residuals and weigh them
// this brings back some color on top of the grey_residual
details[c] = 0.5f * ((gamma_comp * HF_c[c] + gamma * TT_c[c]) + grey_HF);
}
dt_aligned_pixel_t residual;
for_each_channel(c, aligned(LF_c))
{
// reconstruction
residual[c] = (s == scales - 1) ? LF_c[c] : 0.f;
}
for_each_channel(c, aligned(reconstructed, details, residual))
reconstructed[k + c] += alpha * (delta * details[c] + residual[c]);
}
}
static inline void init_reconstruct(const float *const restrict in,
const float *const restrict mask,
float *const restrict reconstructed,
const size_t width,
const size_t height)
{
// init the reconstructed buffer with non-clipped and partially clipped pixels
// Note : it's a simple multiplied alpha blending where mask = alpha weight
DT_OMP_FOR() \
for(size_t k = 0; k < height * width; k++)
{
dt_aligned_pixel_t re;
for_each_channel(c,aligned(in,mask,reconstructed))
re[c] = MAX(in[4*k + c] * (1.f - mask[k]), 0.0f);
copy_pixel_nontemporal(reconstructed + 4*k, re);
}
dt_omploop_sfence(); // ensure that nontemporal write complete before we attempt to read the output
}
static int get_scales(const dt_iop_roi_t *roi_in, const dt_dev_pixelpipe_iop_t *const piece)
{
/* How many wavelets scales do we need to compute at current zoom level ?
* 0. To get the same preview no matter the zoom scale, the relative image coverage ratio of the filter at
* the coarsest wavelet level should always stay constant.
* 1. The image coverage of each B spline filter of size `BSPLINE_FSIZE` is `2^(level) * (BSPLINE_FSIZE - 1) / 2 + 1` pixels
* 2. The coarsest level filter at full resolution should cover `1/BSPLINE_FSIZE` of the largest image dimension.
* 3. The coarsest level filter at current zoom level should cover `scale/BSPLINE_FSIZE` of the largest image dimension.
*
* So we compute the level that solves 1. subject to 3. Of course, integer rounding doesn't make that 1:1
* accurate.
*/
const float scale = roi_in->scale / piece->iscale;
const size_t size = MAX(piece->buf_in.height * piece->iscale, piece->buf_in.width * piece->iscale);
const int scales = floorf(log2f((2.0f * size * scale / ((BSPLINE_FSIZE - 1) * BSPLINE_FSIZE)) - 1.0f));
return CLAMP(scales, 1, MAX_NUM_SCALES);
}
static inline gboolean reconstruct_highlights(const float *const restrict in,
const float *const restrict mask,
float *const restrict reconstructed,
const dt_iop_filmicrgb_reconstruction_type_t variant,
const dt_iop_filmicrgb_data_t *const data,
const dt_dev_pixelpipe_iop_t *piece,
const dt_iop_roi_t *const roi_in,
const dt_iop_roi_t *const roi_out)
{
gboolean success = TRUE;
// wavelets scales
const int scales = get_scales(roi_in, piece);
// wavelets scales buffers
float *const restrict LF_even
= dt_alloc_align_float(4 * roi_out->width * roi_out->height); // low-frequencies RGB
float *const restrict LF_odd
= dt_alloc_align_float(4 * roi_out->width * roi_out->height); // low-frequencies RGB
float *const restrict HF_RGB
= dt_alloc_align_float(4 * roi_out->width * roi_out->height); // high-frequencies RGB
// alloc a permanent reusable buffer for intermediate computations - avoid multiple alloc/free
size_t padded_size;
float *const restrict temp = dt_alloc_perthread_float(4 * roi_out->width, &padded_size);
if(!LF_even || !LF_odd || !HF_RGB || !temp)
{
dt_control_log(_("filmic highlights reconstruction failed to allocate memory, check your RAM settings"));
success = FALSE;
goto error;
}
// Init reconstructed with valid parts of image
init_reconstruct(in, mask, reconstructed, roi_out->width, roi_out->height);
// structure inpainting vs. texture duplicating weight
const float gamma = (data->reconstruct_structure_vs_texture);
const float gamma_comp = 1.0f - data->reconstruct_structure_vs_texture;
// colorful vs. grey weight
const float beta = data->reconstruct_grey_vs_color;
const float beta_comp = 1.f - data->reconstruct_grey_vs_color;
// bloom vs reconstruct weight
const float delta = data->reconstruct_bloom_vs_details;
// À trous wavelet decompose
// there is a paper from a guy we know that explains it : https://jo.dreggn.org/home/2010_atrous.pdf
// the wavelets decomposition here is the same as the equalizer/atrous module,
// but simplified because we don't need the edge-aware term, so we can separate the convolution kernel
// with a vertical and horizontal blur, which is 10 multiply-add instead of 25 by pixel.
for(int s = 0; s < scales; ++s)
{
const float *restrict detail; // buffer containing this scale's input
float *restrict LF; // output buffer for the current scale
float *restrict HF; // temp buffer for HF_RBG terms before blurring
// swap buffers so we only need 2 LF buffers : the LF at scale (s-1) and the one at current scale (s)
if(s == 0)
{
detail = in;
LF = LF_odd;
HF = LF_even;
}
else if(s % 2 != 0)
{
detail = LF_odd;
LF = LF_even;
HF = LF_odd;
}
else
{
detail = LF_even;
LF = LF_odd;
HF = LF_even;
}
const int mult = 1 << s; // fancy-pants C notation for 2^s with integer type, don't be afraid
// Compute wavelets low-frequency scales
blur_2D_Bspline(detail, LF, temp, padded_size, roi_out->width, roi_out->height, mult, TRUE); // clip negatives
// Compute wavelets high-frequency scales and save the minimum of texture over the RGB channels in HF
const size_t pts = roi_out->height * roi_out->width;
DT_OMP_FOR_SIMD(aligned(HF, LF, detail : 64))
for(size_t k = 0; k < pts; k++)
{
for_each_channel(c)
HF[4*k + c] = detail[4*k + c] - LF[4*k + c];
}
// interpolate/blur/inpaint (same thing) the RGB high-frequency to fill holes
blur_2D_Bspline(HF, HF_RGB, temp, padded_size, roi_out->width, roi_out->height, 1, TRUE); // clip negatives
// FIXME: HF have legitimate negatives, so clipping them is wrong, but compatibility…
// Reconstruct clipped parts
if(variant == DT_FILMIC_RECONSTRUCT_RGB)
wavelets_reconstruct_RGB(HF_RGB, LF, HF, mask, reconstructed, roi_out->width, roi_out->height,
gamma, gamma_comp, beta, beta_comp, delta, s, scales);
else if(variant == DT_FILMIC_RECONSTRUCT_RATIOS)
wavelets_reconstruct_ratios(HF_RGB, LF, HF, mask, reconstructed, roi_out->width, roi_out->height,
gamma, gamma_comp, beta, beta_comp, delta, s, scales);
}
error:
dt_free_align(temp);
dt_free_align(LF_even);
dt_free_align(LF_odd);
dt_free_align(HF_RGB);
return success;
}
static inline void filmic_split_v1(const float *const restrict in,
float *const restrict out,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const size_t width,
const size_t height)
{
const dt_aligned_pixel_t output_power
= { data->output_power, data->output_power, data->output_power, data->output_power };
DT_OMP_FOR()
for(size_t k = 0; k < height * width * 4; k += 4)
{
const float *const restrict pix_in = in + k;
dt_aligned_pixel_t temp;
// Log tone-mapping
for(int c = 0; c < 3; c++)
temp[c] = log_tonemapping_v1(MAX(pix_in[c], NORM_MIN), data->grey_source, data->black_source,
data->dynamic_range);
// Get the desaturation coeff based on the log value
const float lum = (work_profile)
? dt_ioppr_get_rgb_matrix_luminance(temp, work_profile->matrix_in, work_profile->lut_in,
work_profile->unbounded_coeffs_in,
work_profile->lutsize, work_profile->nonlinearlut)
: dt_camera_rgb_luminance(temp);
const float desaturation = filmic_desaturate_v1(lum, data->sigma_toe, data->sigma_shoulder, data->saturation);
// Desaturate on the non-linear parts of the curve
// Filmic S curve on the max RGB
// Apply the transfer function of the display
dt_aligned_pixel_t pix_out = { 0.0f, 0.0f, 0.0f, 0.0f };
for(int c = 0; c < 3; c++)
pix_out[c] = filmic_spline(linear_saturation(temp[c], lum, desaturation), spline.M1, spline.M2, spline.M3,
spline.M4, spline.M5, spline.latitude_min, spline.latitude_max, spline.type);
dt_vector_clip(pix_out);
dt_vector_powf(pix_out, output_power, pix_out);
copy_pixel_nontemporal(out + k, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void filmic_split_v2_v3(const float *const restrict in,
float *const restrict out,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const size_t width,
const size_t height)
{
const dt_aligned_pixel_t output_power
= { data->output_power, data->output_power, data->output_power, data->output_power };
// DO NOT REPLACE THE FOLLOWING BY "DT_OMP_FOR_SIMD" - doing so causes a small but measurable change in results
DT_OMP_FOR()
for(size_t k = 0; k < height * width * 4; k += 4)
{
const float *const restrict pix_in = in + k;
dt_aligned_pixel_t temp;
for_each_channel(c,aligned(pix_in,temp))
temp[c] = MAX(pix_in[c], NORM_MIN);
// Log tone-mapping
log_tonemapping_v2(temp, temp, data->grey_source, data->black_source, data->dynamic_range);
// Get the desaturation coeff based on the log value
const float lum = (work_profile)
? dt_ioppr_get_rgb_matrix_luminance(temp, work_profile->matrix_in, work_profile->lut_in,
work_profile->unbounded_coeffs_in,
work_profile->lutsize, work_profile->nonlinearlut)
: dt_camera_rgb_luminance(temp);
const float desaturation = filmic_desaturate_v2(lum, data->sigma_toe, data->sigma_shoulder, data->saturation);
// Desaturate on the non-linear parts of the curve
// Filmic S curve on the max RGB
// Apply the transfer function of the display
dt_aligned_pixel_t pix_out = { 0.0f, 0.0f, 0.0f, 0.0f };
for(size_t c = 0; c < 3; c++)
{
pix_out[c] = filmic_spline(linear_saturation(temp[c], lum, desaturation), spline.M1, spline.M2, spline.M3,
spline.M4, spline.M5, spline.latitude_min, spline.latitude_max, spline.type);
}
dt_vector_clip(pix_out);
dt_vector_powf(pix_out, output_power, pix_out);
copy_pixel_nontemporal(out + k, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void filmic_chroma_v1(const float *const restrict in, float *const restrict out,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline, const int variant, const size_t width,
const size_t height)
{
DT_OMP_FOR()
for(size_t k = 0; k < height * width * 4; k += 4)
{
const float *const restrict pix_in = in + k;
dt_aligned_pixel_t ratios = { 0.0f, 0.0f, 0.0f, 0.0f };
float norm = MAX(get_pixel_norm(pix_in, variant, work_profile), NORM_MIN);
// Save the ratios
for_each_channel(c,aligned(pix_in))
ratios[c] = pix_in[c] / norm;
// Sanitize the ratios
const float min_ratios = MIN(MIN(ratios[0], ratios[1]), ratios[2]);
if(min_ratios < 0.0f)
for_each_channel(c) ratios[c] -= min_ratios;
// Log tone-mapping
norm = log_tonemapping_v1(norm, data->grey_source, data->black_source, data->dynamic_range);
// Get the desaturation value based on the log value
const float desaturation = filmic_desaturate_v1(norm, data->sigma_toe, data->sigma_shoulder, data->saturation);
for_each_channel(c) ratios[c] *= norm;
const float lum = (work_profile) ? dt_ioppr_get_rgb_matrix_luminance(
ratios, work_profile->matrix_in, work_profile->lut_in, work_profile->unbounded_coeffs_in,
work_profile->lutsize, work_profile->nonlinearlut)
: dt_camera_rgb_luminance(ratios);
// Desaturate on the non-linear parts of the curve and save ratios
for_each_channel(c, aligned(ratios))
ratios[c] = linear_saturation(ratios[c], lum, desaturation) / norm;
// Filmic S curve on the max RGB
// Apply the transfer function of the display
norm = powf(clamp_simd(filmic_spline(norm, spline.M1, spline.M2, spline.M3, spline.M4, spline.M5,
spline.latitude_min, spline.latitude_max, spline.type)),
data->output_power);
// Re-apply ratios
dt_aligned_pixel_t pix_out;
for_each_channel(c,aligned(ratios,pix_out))
pix_out[c] = ratios[c] * norm;
copy_pixel_nontemporal(out + k, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void filmic_chroma_v2_v3(const float *const restrict in,
float *const restrict out,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const int variant,
const size_t width,
const size_t height,
const dt_iop_filmicrgb_colorscience_type_t colorscience_version)
{
DT_OMP_FOR()
for(size_t k = 0; k < 4 * height * width; k += 4)
{
const float *const restrict pix_in = in + k;
float norm = MAX(get_pixel_norm(pix_in, variant, work_profile), NORM_MIN);
// Save the ratios
dt_aligned_pixel_t ratios = { 0.0f };
for_each_channel(c,aligned(pix_in))
ratios[c] = pix_in[c] / norm;
// Sanitize the ratios
const float min_ratios = MIN(MIN(ratios[0], ratios[1]), ratios[2]);
const int sanitize = (min_ratios < 0.0f);
if(sanitize)
for_each_channel(c)
ratios[c] -= min_ratios;
// Log tone-mapping
norm = log_tonemapping_v2_1ch(norm, data->grey_source, data->black_source, data->dynamic_range);
// Get the desaturation value based on the log value
const float desaturation = filmic_desaturate_v2(norm, data->sigma_toe, data->sigma_shoulder, data->saturation);
// Filmic S curve on the max RGB
// Apply the transfer function of the display
norm = powf(CLIP(filmic_spline(norm, spline.M1, spline.M2, spline.M3, spline.M4, spline.M5,
spline.latitude_min, spline.latitude_max, spline.type)),
data->output_power);
// Re-apply ratios with saturation change
for_each_channel(c, aligned(ratios))
ratios[c] = MAX(ratios[c] + (1.0f - ratios[c]) * (1.0f - desaturation), 0.0f);
// color science v3: normalize again after desaturation - the norm might have changed by the desaturation
// operation.
if(colorscience_version == DT_FILMIC_COLORSCIENCE_V3)
norm /= MAX(get_pixel_norm(ratios, variant, work_profile), NORM_MIN);
dt_aligned_pixel_t pix_out;
for_each_channel(c,aligned(pix_out))
pix_out[c] = ratios[c] * norm;
// Gamut mapping
const float max_pix = max3f(pix_out);
const int penalize = (max_pix > 1.0f);
// Penalize the ratios by the amount of clipping
if(penalize)
{
for_each_channel(c,aligned(pix_out))
{
ratios[c] = fmaxf(ratios[c] + (1.0f - max_pix), 0.0f);
pix_out[c] = CLIP(ratios[c] * norm);
}
}
copy_pixel_nontemporal(out + k, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void filmic_desaturate_v4(const dt_aligned_pixel_t Ych_original,
dt_aligned_pixel_t Ych_final,
const float saturation)
{
// Note : Ych is normalized through the LMS conversion,
// meaning c is actually a saturation (saturation ~= chroma / brightness).
// So copy-pasting c and h from a different Y is equivalent to
// tonemapping with a norm, which is equivalent to doing exposure compensation :
// it's saturation-invariant, aka chroma will get increased
// if Y is increased, and the other way around.
const float chroma_original = Ych_original[1] * Ych_original[0]; // c2
float chroma_final = Ych_final[1] * Ych_final[0]; // c1
// fit a linear model `chroma = f(y)`:
// `chroma = c1 + (yc - y1) * (c2 - c1) / (y2 - y1)`
// where `(yc - y1)` is user-defined as `saturation * (y2 - y1)`
// so `chroma = c1 + saturation * (c2 - c1)`
// when saturation = 0, we stay at the saturation-invariant final chroma
// when saturation > 0, we go back towards the initial chroma before tone-mapping
// when saturation < 0, we amplify the initial -> final chroma change
const float delta_chroma = saturation * (chroma_original - chroma_final);
const int filmic_brightens = (Ych_final[0] > Ych_original[0]);
const int filmic_resat = (chroma_original < chroma_final);
const int filmic_desat = (chroma_original > chroma_final);
const int user_resat = (saturation > 0.f);
const int user_desat = (saturation < 0.f);
chroma_final = (filmic_brightens && filmic_resat)
? (chroma_original + chroma_final) / 2.f // force original lower sat if brightening
: ((user_resat && filmic_desat) || user_desat)
? chroma_final + delta_chroma // allow resaturation only if filmic desaturated, allow desat anytime
: chroma_final;
Ych_final[1] = MAX(chroma_final / Ych_final[0], 0.f);
}
static inline void gamut_check_RGB(const dt_colormatrix_t matrix_in_trans,
const dt_colormatrix_t matrix_out,
const dt_colormatrix_t matrix_out_trans,
const float display_black,
const float display_white,
const dt_aligned_pixel_t Ych_in,
dt_aligned_pixel_t RGB_out)
{
// Heuristic: if there are negatives, calculate the amount (luminance) of white light that
// would need to be mixed in to bring the pixel back in gamut.
dt_aligned_pixel_t RGB_brightened = { 0.f };
Ych_to_RGB(Ych_in, matrix_out_trans, RGB_brightened);
const float min_pix = MIN(MIN(RGB_brightened[0], RGB_brightened[1]), RGB_brightened[2]);
const float black_offset = MAX(-min_pix, 0.f);
for_each_channel(c) RGB_brightened[c] += black_offset;
dt_aligned_pixel_t Ych_brightened = { 0.f };
RGB_to_Ych(RGB_brightened, matrix_in_trans, Ych_brightened);
// Increase the input luminance a little by the value we calculated above.
// Note, however, that this doesn't actually desaturate the color like mixing
// white would do. We will next find the chroma change needed to bring the pixel
// into gamut.
const float Y = CLAMP((Ych_in[0] + Ych_brightened[0]) / 2.f,
CIE_Y_1931_to_CIE_Y_2006(display_black),
CIE_Y_1931_to_CIE_Y_2006(display_white));
const float cos_h = Ych_in[2];
const float sin_h = Ych_in[3];
const float new_chroma = MIN(Ych_in[1], Ych_max_chroma(matrix_out, display_white, Y, cos_h, sin_h));
// Go to RGB, using existing luminance and hue and the new chroma
const dt_aligned_pixel_t Ych = { Y, new_chroma, cos_h, sin_h };
Ych_to_RGB(Ych, matrix_out_trans, RGB_out);
// Clamp in target RGB as a final catch-all
for_each_channel(c, aligned(RGB_out))
RGB_out[c] = CLAMP(RGB_out[c], 0.f, display_white);
}
DT_OMP_DECLARE_SIMD(
uniform(input_matrix_trans, output_matrix, export_input_matrix_trans, export_output_matrix, use_output_profile)
aligned(Ych_final, Ych_original, pix_out:16)
aligned(input_matrix_trans, output_matrix, export_input_matrix_trans, export_output_matrix:64))
static inline void gamut_mapping(dt_aligned_pixel_t Ych_final,
dt_aligned_pixel_t Ych_original,
dt_aligned_pixel_t pix_out,
const dt_colormatrix_t input_matrix_trans,
const dt_colormatrix_t output_matrix,
const dt_colormatrix_t output_matrix_trans,
const dt_colormatrix_t export_input_matrix_trans,
const dt_colormatrix_t export_output_matrix,
const dt_colormatrix_t export_output_matrix_trans,
const float display_black,
const float display_white,
const float saturation,
const int use_output_profile)
{
// Force final hue to original
Ych_final[2] = Ych_original[2];
Ych_final[3] = Ych_original[3];
// Clip luminance
Ych_final[0] = CLAMP(Ych_final[0],
CIE_Y_1931_to_CIE_Y_2006(display_black),
CIE_Y_1931_to_CIE_Y_2006(display_white));
// Massage chroma
filmic_desaturate_v4(Ych_original, Ych_final, saturation);
gamut_check_Yrg(Ych_final);
if(!use_output_profile)
{
// Now, it is still possible that one channel > display white because of saturation.
// We have already clipped Y, so we know that any problem now is caused by c
gamut_check_RGB(input_matrix_trans, output_matrix, output_matrix_trans,
display_black, display_white, Ych_final, pix_out);
}
else
{
// Now, it is still possible that one channel > display white because of saturation.
// We have already clipped Y, so we know that any problem now is caused by c
gamut_check_RGB(export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
display_black, display_white, Ych_final, pix_out);
// Go from export RGB to CIE LMS 2006 D65
dt_aligned_pixel_t LMS = { 0.f };
dt_apply_transposed_color_matrix(pix_out, export_input_matrix_trans, LMS);
// Go from CIE LMS 2006 D65 to pipeline RGB D50
dt_apply_transposed_color_matrix(LMS, output_matrix_trans, pix_out);
}
}
static int filmic_v4_prepare_matrices(dt_colormatrix_t input_matrix_trans,
dt_colormatrix_t output_matrix,
dt_colormatrix_t output_matrix_trans,
dt_colormatrix_t export_input_matrix_trans,
dt_colormatrix_t export_output_matrix,
dt_colormatrix_t export_output_matrix_trans,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_order_iccprofile_info_t *const export_profile)
{
dt_colormatrix_t input_temp = { { 0.0f } };
prepare_RGB_Yrg_matrices(work_profile, input_temp, output_matrix);
dt_colormatrix_transpose(input_matrix_trans, input_temp);
dt_colormatrix_transpose(output_matrix_trans, output_matrix);
// If the pipeline output profile is supported (matrix profile), we gamut map against it
const int use_output_profile = (export_profile != NULL);
if(use_output_profile)
{
prepare_RGB_Yrg_matrices(export_profile, input_temp, export_output_matrix);
dt_colormatrix_transpose(export_input_matrix_trans, input_temp);
dt_colormatrix_transpose(export_output_matrix_trans, export_output_matrix);
}
return use_output_profile;
}
DT_OMP_DECLARE_SIMD(
uniform(work_profile, data, spline, norm_min, norm_max, display_black, display_white, type)
aligned(pix_in, pix_out:16))
static inline void norm_tone_mapping_v4(const dt_aligned_pixel_t pix_in,
dt_aligned_pixel_t pix_out,
const dt_iop_filmicrgb_methods_type_t type,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const float norm_min,
const float norm_max,
const float display_black,
const float display_white)
{
// Norm must be clamped early to the valid input range, otherwise it will be clamped
// later in log_tonemapping_v2 and the ratios will be then incorrect.
// This would result in colorful patches darker than their surrounding in places
// where the raw data is clipped.
float norm = CLAMPF(get_pixel_norm(pix_in, type, work_profile), norm_min, norm_max);
// Save the ratios
dt_aligned_pixel_t ratios = { 0.0f };
for_each_channel(c,aligned(pix_in))
ratios[c] = pix_in[c] / norm;
// Log tone-mapping
norm = log_tonemapping_v2_1ch(norm, data->grey_source, data->black_source, data->dynamic_range);
// Filmic S curve on the max RGB
// Apply the transfer function of the display
norm = powf(CLAMP(filmic_spline(norm, spline.M1, spline.M2, spline.M3, spline.M4, spline.M5,
spline.latitude_min, spline.latitude_max, spline.type),
display_black,
display_white),
data->output_power);
// Restore RGB
for_each_channel(c,aligned(pix_out))
pix_out[c] = ratios[c] * norm;
}
DT_OMP_DECLARE_SIMD(uniform(data, spline, display_black, display_white) aligned(pix_in, pix_out:16))
static inline void RGB_tone_mapping_v4(const dt_aligned_pixel_t pix_in,
dt_aligned_pixel_t pix_out,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const float display_black,
const float display_white)
{
dt_aligned_pixel_t mapped;
log_tonemapping_v2(mapped, pix_in, data->grey_source, data->black_source, data->dynamic_range);
// for_each_channel(c,aligned(mapped))
for(size_t c = 0; c < 3; c++)
{
mapped[c] = filmic_spline(mapped[c], spline.M1, spline.M2, spline.M3, spline.M4, spline.M5,
spline.latitude_min, spline.latitude_max, spline.type);
}
for_each_channel(c,aligned(mapped))
{
// individual components can always go to zero, luminance is clamped later
mapped[c] = CLAMP(mapped[c], 0.0f, display_white);
}
dt_vector_pow1(mapped, data->output_power, pix_out);
}
static inline void filmic_chroma_v4(const float *const restrict in,
float *const restrict out,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_order_iccprofile_info_t *const export_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const int variant,
const size_t width,
const size_t height,
const dt_iop_filmicrgb_colorscience_type_t colorscience_version,
const float display_black,
const float display_white)
{
// See colorbalancergb.c for details
dt_colormatrix_t input_matrix_trans; // pipeline RGB -> LMS 2006
dt_colormatrix_t output_matrix; // LMS 2006 -> pipeline RGB
dt_colormatrix_t output_matrix_trans; // LMS 2006 -> pipeline RGB
dt_colormatrix_t export_input_matrix_trans; // output RGB -> LMS 2006
dt_colormatrix_t export_output_matrix; // LMS 2006 -> output RGB
dt_colormatrix_t export_output_matrix_trans; // LMS 2006 -> output RGB
const int use_output_profile
= filmic_v4_prepare_matrices(input_matrix_trans, output_matrix, output_matrix_trans,
export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
work_profile, export_profile);
const float norm_min = exp_tonemapping_v2(0.f, data->grey_source, data->black_source, data->dynamic_range);
const float norm_max = exp_tonemapping_v2(1.f, data->grey_source, data->black_source, data->dynamic_range);
DT_OMP_FOR()
for(size_t k = 0; k < 4 * height * width; k += 4)
{
const float *const restrict pix_in = in + k;
dt_aligned_pixel_t pix_out;
norm_tone_mapping_v4(pix_in, pix_out, variant, work_profile, data, spline,
norm_min, norm_max, display_black, display_white);
// Save Ych in Kirk/Filmlight Yrg
dt_aligned_pixel_t Ych_original = { 0.f };
RGB_to_Ych(pix_in, input_matrix_trans, Ych_original);
// Get final Ych in Kirk/Filmlight Yrg
dt_aligned_pixel_t Ych_final = { 0.f };
RGB_to_Ych(pix_out, input_matrix_trans, Ych_final);
gamut_mapping(Ych_final, Ych_original, pix_out, input_matrix_trans, output_matrix, output_matrix_trans,
export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
display_black, display_white, data->saturation, use_output_profile);
copy_pixel_nontemporal(out + k, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void filmic_split_v4(const float *const restrict in,
float *const restrict out,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_order_iccprofile_info_t *const export_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const int variant,
const size_t width,
const size_t height,
const dt_iop_filmicrgb_colorscience_type_t colorscience_version,
const float display_black,
const float display_white)
{
// See colorbalancergb.c for details
dt_colormatrix_t input_matrix_trans; // pipeline RGB -> LMS 2006
dt_colormatrix_t output_matrix; // LMS 2006 -> pipeline RGB
dt_colormatrix_t output_matrix_trans; // LMS 2006 -> pipeline RGB
dt_colormatrix_t export_input_matrix_trans; // output RGB -> LMS 2006
dt_colormatrix_t export_output_matrix; // LMS 2006 -> output RGB
dt_colormatrix_t export_output_matrix_trans; // LMS 2006 -> output RGB
const int use_output_profile
= filmic_v4_prepare_matrices(input_matrix_trans, output_matrix, output_matrix_trans,
export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
work_profile, export_profile);
DT_OMP_FOR()
for(size_t k = 0; k < 4 * height * width; k += 4)
{
const float *const restrict pix_in = in + k;
dt_aligned_pixel_t pix_out;
RGB_tone_mapping_v4(pix_in, pix_out, data, spline, display_black, display_white);
// Save Ych in Kirk/Filmlight Yrg
dt_aligned_pixel_t Ych_original = { 0.f };
RGB_to_Ych(pix_in, input_matrix_trans, Ych_original);
// Get final Ych in Kirk/Filmlight Yrg
dt_aligned_pixel_t Ych_final = { 0.f };
RGB_to_Ych(pix_out, input_matrix_trans, Ych_final);
Ych_final[1] = MIN(Ych_original[1], Ych_final[1]);
gamut_mapping(Ych_final, Ych_original, pix_out, input_matrix_trans, output_matrix, output_matrix_trans,
export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
display_black, display_white, data->saturation, use_output_profile);
copy_pixel_nontemporal(out + k, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void filmic_v5(const float *const restrict in, float *const restrict out,
const dt_iop_order_iccprofile_info_t *const work_profile,
const dt_iop_order_iccprofile_info_t *const export_profile,
const dt_iop_filmicrgb_data_t *const data,
const dt_iop_filmic_rgb_spline_t spline,
const size_t width, const size_t height,
const float display_black, const float display_white)
{
// See colorbalancergb.c for details
dt_colormatrix_t input_matrix_trans; // pipeline RGB -> LMS 2006
dt_colormatrix_t output_matrix; // LMS 2006 -> pipeline RGB
dt_colormatrix_t output_matrix_trans; // LMS 2006 -> pipeline RGB
dt_colormatrix_t export_input_matrix_trans; // output RGB -> LMS 2006
dt_colormatrix_t export_output_matrix; // LMS 2006 -> output RGB
dt_colormatrix_t export_output_matrix_trans; // LMS 2006 -> output RGB
const int use_output_profile
= filmic_v4_prepare_matrices(input_matrix_trans, output_matrix, output_matrix_trans,
export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
work_profile, export_profile);
const float norm_min = exp_tonemapping_v2(0.f, data->grey_source, data->black_source, data->dynamic_range);
const float norm_max = exp_tonemapping_v2(1.f, data->grey_source, data->black_source, data->dynamic_range);
DT_OMP_FOR()
for(size_t k = 0; k < height * width * 4; k += 4)
{
const float *const restrict pix_in = in + k;
dt_aligned_pixel_t max_rgb = { 0.f };
dt_aligned_pixel_t naive_rgb = { 0.f };
RGB_tone_mapping_v4(pix_in, naive_rgb, data, spline, display_black, display_white);
norm_tone_mapping_v4(pix_in, max_rgb, DT_FILMIC_METHOD_MAX_RGB, work_profile, data,
spline, norm_min, norm_max, display_black, display_white);
// Mix max RGB with naive RGB
dt_aligned_pixel_t pix_out;
for_each_channel(c, aligned(pix_out, max_rgb, naive_rgb))
pix_out[c] = (0.5f - data->saturation) * naive_rgb[c] + (0.5f + data->saturation) * max_rgb[c];
// Save Ych in Kirk/Filmlight Yrg
dt_aligned_pixel_t Ych_original = { 0.f };
RGB_to_Ych(pix_in, input_matrix_trans, Ych_original);
// Get final Ych in Kirk/Filmlight Yrg
dt_aligned_pixel_t Ych_final = { 0.f };
RGB_to_Ych(pix_out, input_matrix_trans, Ych_final);
Ych_final[1] = fminf(Ych_original[1], Ych_final[1]);
gamut_mapping(Ych_final, Ych_original, pix_out, input_matrix_trans, output_matrix, output_matrix_trans,
export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
display_black, display_white, 0.0f, use_output_profile);
copy_pixel_nontemporal(out + k, pix_out);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void display_mask(const float *const restrict mask,
float *const restrict out,
const size_t width,
const size_t height)
{
DT_OMP_FOR()
for(size_t k = 0; k < height * width; k++)
{
dt_aligned_pixel_t pix;
for_each_channel(c,aligned(out))
pix[c] = mask[k];
copy_pixel_nontemporal(out + 4*k, pix);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void compute_ratios(const float *const restrict in,
float *const restrict norms,
float *const restrict ratios,
const dt_iop_order_iccprofile_info_t *const work_profile,
const int variant,
const size_t width,
const size_t height)
{
DT_OMP_FOR()
for(size_t k = 0; k < height * width * 4; k += 4)
{
const float norm = MAX(get_pixel_norm(in + k, variant, work_profile), NORM_MIN);
norms[k / 4] = norm;
dt_aligned_pixel_t ratio;
for_each_channel(c,aligned(ratios,in))
ratio[c] = in[k + c] / norm;
copy_pixel_nontemporal(ratios + k, ratio);
}
dt_omploop_sfence(); // ensure that nontemporal writes complete before we attempt to read output
}
static inline void restore_ratios(float *const restrict ratios,
const float *const restrict norms,
const size_t width,
const size_t height)
{
DT_OMP_FOR()
for(size_t k = 0; k < height * width; k++)
{
for_each_channel(c,aligned(norms,ratios))
ratios[4*k + c] = clamp_simd(ratios[4*k + c]) * norms[k];
}
}
void tiling_callback(dt_iop_module_t *self, dt_dev_pixelpipe_iop_t *piece,
const dt_iop_roi_t *roi_in, const dt_iop_roi_t *roi_out,
dt_develop_tiling_t *tiling)
{
const int scales = get_scales(roi_in, piece);
const int max_filter_radius = (1 << scales);
const dt_iop_filmicrgb_data_t *const d = piece->data;
const gboolean run_fast = !d->enable_highlight_reconstruction || dt_pipe_is_fast(piece->pipe);
// without reconstruction: in + out + 1ch_mask
// with reconstruction: in + out + reconst + inpaint + 2 * scales + temp + 1ch_mask
// with HQ reconstruction: in + out + reconst + inpaint + tmp + 2 * scales + temp + ratios + 1ch_mask + 1ch_norms
const float hq = d->high_quality_reconstruction > 0 ? 1.25f : 0.0f;
tiling->factor = run_fast ? 2.25f : (7.25f + hq);
tiling->factor_cl = run_fast ? 2.25f : 10.25 ;
tiling->maxbuf = 1.0f;
tiling->maxbuf_cl = 1.0f;
tiling->overhead = 0;
tiling->overlap = max_filter_radius;
tiling->align = 1;
return;
}
void process(dt_iop_module_t *self,
dt_dev_pixelpipe_iop_t *piece,
const void *const restrict ivoid,
void *const restrict ovoid,
const dt_iop_roi_t *const roi_in,
const dt_iop_roi_t *const roi_out)
{
if(!dt_iop_have_required_input_format(4 /*we need full-color pixels*/, self, piece->colors,
ivoid, ovoid, roi_in, roi_out))
return;
const dt_iop_filmicrgb_data_t *const data = piece->data;
const dt_iop_order_iccprofile_info_t *const work_profile = dt_ioppr_get_pipe_work_profile_info(piece->pipe);
const dt_iop_order_iccprofile_info_t *const export_profile = dt_ioppr_get_pipe_output_profile_info(piece->pipe);
/** The log2(x) -> -INF when x -> 0
* thus very low values (noise) will get even lower, resulting in noise negative amplification,
* which leads to pepper noise in shadows. To avoid that, we need to clip values that are noise for sure.
* Using 16 bits RAW data, the black value (known by rawspeed for every manufacturer) could be used as a
* threshold. However, at this point of the pixelpipe, the RAW levels have already been corrected and everything
* can happen with black levels in the exposure module. So we define the threshold as the first non-null 16 bit
* integer
*/
const float *restrict in = (float *)ivoid;
float *const restrict out = (float *)ovoid;
float *const restrict mask = dt_alloc_align_float((size_t)roi_out->width * roi_out->height);
// used to adjuste noise level depending on size. Don't amplify noise if magnified > 100%
const float scale = fmaxf(piece->iscale / roi_in->scale, 1.f);
// build a mask of clipped pixels
const gboolean recover_highlights = data->enable_highlight_reconstruction
&& mask_clipped_pixels(in, mask, data->normalize, data->reconstruct_feather, roi_out->width, roi_out->height);
// display mask and exit
if(self->dev->gui_attached && dt_pipe_is_full(piece->pipe) && mask)
{
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
dt_iop_gui_enter_critical_section(self);
const gboolean show_mask = g->show_mask;
dt_iop_gui_leave_critical_section(self);
if(show_mask)
{
display_mask(mask, out, roi_out->width, roi_out->height);
dt_free_align(mask);
return;
}
}
const gboolean run_fast = dt_pipe_is_fast(piece->pipe);
// allocate reconstruction buffer, but only if we actually want to use it
float *const restrict reconstructed
= run_fast ? NULL : dt_alloc_align_float((size_t)roi_out->width * roi_out->height * 4);
// if fast mode is not in use and we we able to allocate buffer
if(!run_fast && recover_highlights && mask && reconstructed)
{
// init the blown areas with noise to create particles
float *const restrict inpainted = dt_alloc_align_float((size_t)roi_out->width * roi_out->height * 4);
gboolean success_1 = FALSE;
gboolean success_2 = TRUE;
if(inpainted)
{
inpaint_noise(in, mask, inpainted, data->noise_level / scale, data->reconstruct_threshold,
data->noise_distribution, roi_out->width, roi_out->height);
// diffuse particles with wavelets reconstruction
// PASS 1 on RGB channels
success_1 = reconstruct_highlights(inpainted, mask, reconstructed, DT_FILMIC_RECONSTRUCT_RGB,
data, piece, roi_in, roi_out);
dt_free_align(inpainted);
}
if(data->high_quality_reconstruction > 0 && success_1)
{
float *const restrict norms = dt_alloc_align_float((size_t)roi_out->width * roi_out->height);
float *const restrict ratios = dt_alloc_align_float((size_t)roi_out->width * roi_out->height * 4);
// reconstruct highlights PASS 2 on ratios
if(norms && ratios)
{
for(int i = 0; i < data->high_quality_reconstruction; i++)
{
compute_ratios(reconstructed, norms, ratios, work_profile, DT_FILMIC_METHOD_EUCLIDEAN_NORM_V1,
roi_out->width, roi_out->height);
success_2 = success_2
&& reconstruct_highlights(ratios, mask, reconstructed, DT_FILMIC_RECONSTRUCT_RATIOS,
data, piece, roi_in, roi_out);
restore_ratios(reconstructed, norms, roi_out->width, roi_out->height);
}
}
dt_free_align(norms);
dt_free_align(ratios);
}
if(success_1 && success_2) in = reconstructed; // use reconstructed buffer as tonemapping input
}
dt_free_align(mask);
const float white_display = powf(data->spline.y[4], data->output_power);
const float black_display = powf(data->spline.y[0], data->output_power);
if(data->version == DT_FILMIC_COLORSCIENCE_V5)
{
filmic_v5(in, out, work_profile, export_profile, data, data->spline, roi_out->width,
roi_out->height, black_display, white_display);
}
else
{
if(data->preserve_color == DT_FILMIC_METHOD_NONE)
{
// no chroma preservation
if(data->version == DT_FILMIC_COLORSCIENCE_V1)
filmic_split_v1(in, out, work_profile, data, data->spline, roi_out->width, roi_in->height);
else if(data->version == DT_FILMIC_COLORSCIENCE_V2 || data->version == DT_FILMIC_COLORSCIENCE_V3)
filmic_split_v2_v3(in, out, work_profile, data, data->spline, roi_out->width, roi_in->height);
else if(data->version == DT_FILMIC_COLORSCIENCE_V4)
filmic_split_v4(in, out, work_profile, export_profile, data, data->spline,
data->preserve_color, roi_out->width, roi_out->height,
data->version, black_display, white_display);
}
else
{
// chroma preservation
if(data->version == DT_FILMIC_COLORSCIENCE_V1)
filmic_chroma_v1(in, out, work_profile, data, data->spline, data->preserve_color, roi_out->width,
roi_out->height);
else if(data->version == DT_FILMIC_COLORSCIENCE_V2 || data->version == DT_FILMIC_COLORSCIENCE_V3)
filmic_chroma_v2_v3(in, out, work_profile, data, data->spline, data->preserve_color, roi_out->width,
roi_out->height, data->version);
else if(data->version == DT_FILMIC_COLORSCIENCE_V4)
filmic_chroma_v4(in, out, work_profile, export_profile, data, data->spline,
data->preserve_color, roi_out->width, roi_out->height,
data->version, black_display, white_display);
}
}
dt_free_align(reconstructed);
}
#ifdef HAVE_OPENCL
static inline cl_int reconstruct_highlights_cl(const cl_mem in, const cl_mem mask, const cl_mem reconstructed,
const dt_iop_filmicrgb_reconstruction_type_t variant, const dt_iop_filmicrgb_global_data_t *const gd,
const dt_iop_filmicrgb_data_t *const data, const dt_dev_pixelpipe_iop_t *piece,
const dt_iop_roi_t *const roi_in)
{
cl_int err = DT_OPENCL_DEFAULT_ERROR;
const int devid = piece->pipe->devid;
const int width = roi_in->width;
const int height = roi_in->height;
const size_t sizes[2] = { width, height };
// wavelets scales
const int scales = get_scales(roi_in, piece);
// wavelets scales buffers
const cl_mem LF_even = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4); // low-frequencies RGB
const cl_mem LF_odd = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4); // low-frequencies RGB
const cl_mem HF_RGB = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4); // high-frequencies RGB
const cl_mem HF_grey = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4); // high-frequencies RGB backup
// alloc a permanent reusable buffer for intermediate computations - avoid multiple alloc/free
const cl_mem temp = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4);;
const cl_mem reconstructed_temp = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4);
if(!LF_even || !LF_odd || !HF_RGB || !HF_grey || !temp || !reconstructed_temp)
{
dt_control_log(_("filmic highlights reconstruction failed to allocate memory on GPU"));
err = CL_MEM_OBJECT_ALLOCATION_FAILURE;
goto error;
}
// Init reconstructed with valid parts of image
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_init_reconstruct, width, height,
CLARG(in), CLARG(mask),
CLARG(reconstructed), CLARG(width), CLARG(height));
if(err != CL_SUCCESS) goto error;
// structure inpainting vs. texture duplicating weight
const float gamma = (data->reconstruct_structure_vs_texture);
const float gamma_comp = 1.0f - data->reconstruct_structure_vs_texture;
// colorful vs. grey weight
const float beta = data->reconstruct_grey_vs_color;
const float beta_comp = 1.f - data->reconstruct_grey_vs_color;
// bloom vs reconstruct weight
const float delta = data->reconstruct_bloom_vs_details;
// À trous wavelet decompose
// there is a paper from a guy we know that explains it : https://jo.dreggn.org/home/2010_atrous.pdf
// the wavelets decomposition here is the same as the equalizer/atrous module,
// but simplified because we don't need the edge-aware term, so we can separate the convolution kernel
// with a vertical and horizontal blur, which is 10 multiply-add instead of 25 by pixel.
// We must ping-pong the reconstructed data for OpenCL 1.2 specs
cl_mem reconstructed_in = reconstructed;
cl_mem reconstructed_out = reconstructed_temp;
for(int s = 0; s < scales; ++s)
{
cl_mem detail;
cl_mem LF;
// swap buffers so we only need 2 LF buffers : the LF at scale (s-1) and the one at current scale (s)
if(s == 0)
{
detail = in;
LF = LF_odd;
}
else if(s % 2 != 0)
{
detail = LF_odd;
LF = LF_even;
}
else
{
detail = LF_even;
LF = LF_odd;
}
const int mult = 1 << s; // fancy-pants C notation for 2^s with integer type, don't be afraid
// Compute wavelets low-frequency scales
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_bspline_horizontal, width, height,
CLARG(detail), CLARG(temp),
CLARG(width), CLARG(height), CLARG(mult));
if(err != CL_SUCCESS) goto error;
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_bspline_vertical, width, height,
CLARG(temp), CLARG(LF),
CLARG(width), CLARG(height), CLARG(mult));
if(err != CL_SUCCESS) goto error;
// Compute wavelets high-frequency scales and backup the maximum of texture over the RGB channels
// Note : HF_RGB = detail - LF
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_wavelets_detail, width, height,
CLARG(detail), CLARG(LF),
CLARG(HF_RGB), CLARG(width), CLARG(height));
if(err != CL_SUCCESS) goto error;
// Take a backup copy of HF_RGB in HF_grey - only HF_RGB will be blurred
err = dt_opencl_enqueue_copy_image(devid, HF_RGB, HF_grey, CLIMG_ORIGIN, CLIMG_ORIGIN, sizes);
if(err != CL_SUCCESS) goto error;
// interpolate/blur/inpaint (same thing) the RGB high-frequency to fill holes
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_bspline_vertical, width, height,
CLARG(HF_RGB), CLARG(temp),
CLARG(width), CLARG(height), CLARGINT(1));
if(err != CL_SUCCESS) goto error;
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_bspline_horizontal, width, height,
CLARG(temp), CLARG(HF_RGB),
CLARG(width), CLARG(height), CLARGINT(1));
if(err != CL_SUCCESS) goto error;
// Reconstruct clipped parts
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_wavelets_reconstruct, width, height,
CLARG(HF_RGB), CLARG(LF),
CLARG(HF_grey), CLARG(mask), CLARG(reconstructed_in), CLARG(reconstructed_out), CLARG(width), CLARG(height),
CLARG(gamma), CLARG(gamma_comp), CLARG(beta), CLARG(beta_comp), CLARG(delta), CLARG(s), CLARG(scales),
CLARG(variant));
if(err != CL_SUCCESS) goto error;
cl_mem swap_tmp = reconstructed_in;
reconstructed_in = reconstructed_out;
reconstructed_out = swap_tmp;
}
if(reconstructed_in != reconstructed)
err = dt_opencl_enqueue_copy_image(devid, reconstructed_in, reconstructed, CLIMG_ORIGIN, CLIMG_ORIGIN, sizes);
error:
dt_opencl_release_mem_object(temp);
dt_opencl_release_mem_object(LF_even);
dt_opencl_release_mem_object(LF_odd);
dt_opencl_release_mem_object(HF_RGB);
dt_opencl_release_mem_object(HF_grey);
dt_opencl_release_mem_object(reconstructed_temp);
return err;
}
int process_cl(dt_iop_module_t *self,
dt_dev_pixelpipe_iop_t *piece,
cl_mem dev_in, cl_mem dev_out,
const dt_iop_roi_t *const roi_in,
const dt_iop_roi_t *const roi_out)
{
const dt_iop_filmicrgb_data_t *const d = piece->data;
const dt_iop_filmicrgb_global_data_t *const gd = self->global_data;
cl_int err = DT_OPENCL_DEFAULT_ERROR;
if(piece->colors != 4)
{
dt_control_log(_("filmic works only on RGB input"));
return err;
}
const int devid = piece->pipe->devid;
const int width = roi_in->width;
const int height = roi_in->height;
cl_mem in = dev_in;
cl_mem inpainted = NULL;
cl_mem reconstructed = NULL;
cl_mem mask = NULL;
cl_mem ratios = NULL;
cl_mem norms = NULL;
// fetch working color profile
const dt_iop_order_iccprofile_info_t *const work_profile = dt_ioppr_get_pipe_work_profile_info(piece->pipe);
const dt_iop_order_iccprofile_info_t *const export_profile = dt_ioppr_get_pipe_output_profile_info(piece->pipe);
const int use_work_profile = (work_profile == NULL) ? 0 : 1;
// See colorbalancergb.c for details
dt_colormatrix_t input_matrix_trans; // pipeline RGB -> LMS 2006
dt_colormatrix_t output_matrix; // LMS 2006 -> pipeline RGB
dt_colormatrix_t output_matrix_trans; // LMS 2006 -> pipeline RGB
dt_colormatrix_t export_input_matrix_trans; // output RGB -> LMS 2006
dt_colormatrix_t export_output_matrix; // LMS 2006 -> output RGB
dt_colormatrix_t export_output_matrix_trans; // LMS 2006 -> output RGB
const int use_output_profile
= filmic_v4_prepare_matrices(input_matrix_trans, output_matrix, output_matrix_trans,
export_input_matrix_trans, export_output_matrix, export_output_matrix_trans,
work_profile, export_profile);
dt_colormatrix_t input_matrix;
dt_colormatrix_transpose(input_matrix, input_matrix_trans);
const float norm_min = exp_tonemapping_v2(0.f, d->grey_source, d->black_source, d->dynamic_range);
const float norm_max = exp_tonemapping_v2(1.f, d->grey_source, d->black_source, d->dynamic_range);
const cl_mem input_matrix_cl = dt_opencl_copy_host_to_device_constant(devid, 12 * sizeof(float), input_matrix);
const cl_mem output_matrix_cl = dt_opencl_copy_host_to_device_constant(devid, 12 * sizeof(float), output_matrix);
cl_mem export_input_matrix_cl = NULL;
cl_mem export_output_matrix_cl = NULL;
cl_mem dev_profile_info = NULL;
cl_mem dev_profile_lut = NULL;
dt_colorspaces_iccprofile_info_cl_t *profile_info_cl;
cl_float *profile_lut_cl = NULL;
cl_mem clipped = NULL;
err = dt_ioppr_build_iccprofile_params_cl(work_profile, devid, &profile_info_cl, &profile_lut_cl,
&dev_profile_info, &dev_profile_lut);
if(err != CL_SUCCESS) goto error;
if(use_output_profile)
{
dt_colormatrix_t export_input_matrix;
dt_colormatrix_transpose(export_input_matrix, export_input_matrix_trans);
export_input_matrix_cl = dt_opencl_copy_host_to_device_constant(devid, 12 * sizeof(float), export_input_matrix);
export_output_matrix_cl = dt_opencl_copy_host_to_device_constant(devid, 12 * sizeof(float), export_output_matrix);
}
// used to adjust noise level depending on size. Don't amplify noise if magnified > 100%
const float scale = MAX(piece->iscale / roi_in->scale, 1.f);
int cnt_clipped = 0;
clipped = dt_opencl_alloc_device_buffer(devid, sizeof(cnt_clipped));
err = dt_opencl_write_buffer_to_device(devid, &cnt_clipped, clipped, 0, sizeof(cnt_clipped), TRUE);
if(err != CL_SUCCESS) goto error;
// build a mask of clipped pixels
mask = dt_opencl_alloc_device(devid, width, height, sizeof(float));
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_mask, width, height,
CLARG(in), CLARG(mask), CLARG(width),
CLARG(height), CLARG(d->normalize), CLARG(d->reconstruct_feather), CLARG(clipped));
if(err != CL_SUCCESS) goto error;
// check for clipped pixels
err = dt_opencl_read_buffer_from_device(devid, &cnt_clipped, clipped, 0, sizeof(cnt_clipped), TRUE);
if(err != CL_SUCCESS) goto error;
dt_opencl_release_mem_object(clipped);
clipped = NULL;
// display mask and exit
if(self->dev->gui_attached && dt_pipe_is_full(piece->pipe))
{
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
dt_iop_gui_enter_critical_section(self);
const gboolean show_mask = g->show_mask;
dt_iop_gui_leave_critical_section(self);
if(show_mask)
{
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_show_mask, width, height,
CLARG(mask), CLARG(dev_out), CLARG(width), CLARG(height));
goto error;
}
}
const gboolean run_fast = dt_pipe_is_fast(piece->pipe);
if(!run_fast && cnt_clipped > 9 && d->enable_highlight_reconstruction)
{
// Inpaint noise
const float noise_level = d->noise_level / scale;
inpainted = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4);
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_inpaint_noise, width, height,
CLARG(in), CLARG(mask), CLARG(inpainted),
CLARG(width), CLARG(height), CLARG(noise_level), CLARG(d->reconstruct_threshold), CLARG(d->noise_distribution));
if(err != CL_SUCCESS) goto error;
// first step of highlight reconstruction in RGB
reconstructed = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4);
err = reconstruct_highlights_cl(inpainted, mask, reconstructed, DT_FILMIC_RECONSTRUCT_RGB, gd, d, piece, roi_in);
if(err != CL_SUCCESS) goto error;
dt_opencl_release_mem_object(inpainted);
inpainted = NULL;
if(d->high_quality_reconstruction > 0)
{
ratios = dt_opencl_alloc_device(devid, width, height, sizeof(float) * 4);
norms = dt_opencl_alloc_device(devid, width, height, sizeof(float));
if(norms && ratios)
{
for(int i = 0; i < d->high_quality_reconstruction; i++)
{
// break ratios and norms
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_compute_ratios, width, height,
CLARG(reconstructed), CLARG(norms),
CLARG(ratios), CLARG(d->preserve_color), CLARG(width), CLARG(height));
if(err != CL_SUCCESS) goto error;
// second step of reconstruction over ratios
err = reconstruct_highlights_cl(ratios, mask, reconstructed, DT_FILMIC_RECONSTRUCT_RATIOS, gd, d, piece, roi_in);
if(err != CL_SUCCESS) goto error;
// restore ratios to RGB
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_restore_ratios, width, height,
CLARG(reconstructed), CLARG(norms),
CLARG(reconstructed), CLARG(width), CLARG(height));
if(err != CL_SUCCESS) goto error;
}
}
dt_opencl_release_mem_object(ratios);
dt_opencl_release_mem_object(norms);
ratios = NULL;
norms = NULL;
}
in = reconstructed;
}
dt_opencl_release_mem_object(mask); // mask is only used for highlights reconstruction.
mask = NULL;
const dt_iop_filmic_rgb_spline_t spline = (dt_iop_filmic_rgb_spline_t)d->spline;
const float white_display = powf(spline.y[4], d->output_power);
const float black_display = powf(spline.y[0], d->output_power);
if(d->preserve_color == DT_FILMIC_METHOD_NONE && d->version != DT_FILMIC_COLORSCIENCE_V5)
{
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_rgb_split, width, height,
CLARG(in), CLARG(dev_out), CLARG(width),
CLARG(height), CLARG(d->dynamic_range), CLARG(d->black_source), CLARG(d->grey_source), CLARG(dev_profile_info),
CLARG(dev_profile_lut), CLARG(use_work_profile), CLARG(d->sigma_toe), CLARG(d->sigma_shoulder),
CLARG(d->saturation), CLARG(spline.M1), CLARG(spline.M2), CLARG(spline.M3), CLARG(spline.M4), CLARG(spline.M5),
CLARG(spline.latitude_min), CLARG(spline.latitude_max), CLARG(d->output_power), CLARG(d->version),
CLARG(spline.type[0]), CLARG(spline.type[1]), CLARG(input_matrix_cl), CLARG(output_matrix_cl),
CLARG(black_display), CLARG(white_display), CLARG(use_output_profile), CLARG(export_input_matrix_cl),
CLARG(export_output_matrix_cl));
}
else
{
err = dt_opencl_enqueue_kernel_2d_args(devid, gd->kernel_filmic_rgb_chroma, width, height,
CLARG(in), CLARG(dev_out), CLARG(width),
CLARG(height), CLARG(d->dynamic_range), CLARG(d->black_source), CLARG(d->grey_source), CLARG(dev_profile_info),
CLARG(dev_profile_lut), CLARG(use_work_profile), CLARG(d->sigma_toe), CLARG(d->sigma_shoulder),
CLARG(d->saturation), CLARG(spline.M1), CLARG(spline.M2), CLARG(spline.M3), CLARG(spline.M4), CLARG(spline.M5),
CLARG(spline.latitude_min), CLARG(spline.latitude_max), CLARG(d->output_power), CLARG(d->preserve_color),
CLARG(d->version), CLARG(spline.type[0]), CLARG(spline.type[1]), CLARG(input_matrix_cl), CLARG(output_matrix_cl),
CLARG(black_display), CLARG(white_display), CLARG(use_output_profile), CLARG(export_input_matrix_cl),
CLARG(export_output_matrix_cl), CLARG(norm_min), CLARG(norm_max));
}
error:
dt_ioppr_free_iccprofile_params_cl(&profile_info_cl, &profile_lut_cl, &dev_profile_info, &dev_profile_lut);
dt_opencl_release_mem_object(reconstructed);
dt_opencl_release_mem_object(inpainted);
dt_opencl_release_mem_object(mask);
dt_opencl_release_mem_object(ratios);
dt_opencl_release_mem_object(input_matrix_cl);
dt_opencl_release_mem_object(output_matrix_cl);
dt_opencl_release_mem_object(export_input_matrix_cl);
dt_opencl_release_mem_object(export_output_matrix_cl);
dt_opencl_release_mem_object(norms);
dt_opencl_release_mem_object(clipped);
return err;
}
#endif
static inline void _compute_output_power(const dt_iop_module_t *self,
dt_iop_filmicrgb_params_t *p)
{
const float min = self->so->get_f("output_power")->Float.Min;
const float max = self->so->get_f("output_power")->Float.Max;
p->output_power =
CLAMPF(logf(p->grey_point_target / 100.0f)
/ logf(-p->black_point_source / (p->white_point_source - p->black_point_source)),
min, max);
}
static void apply_auto_grey(dt_iop_module_t *self)
{
dt_iop_filmicrgb_params_t *p = self->params;
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
const dt_iop_order_iccprofile_info_t *const work_profile
= dt_ioppr_get_iop_work_profile_info(self, self->dev->iop);
const float grey = get_pixel_norm(self->picked_color, p->preserve_color, work_profile) / 2.0f;
const float prev_grey = p->grey_point_source;
p->grey_point_source = CLAMP(100.f * grey, 0.001f, 100.0f);
const float grey_var = log2f(prev_grey / p->grey_point_source);
p->black_point_source = p->black_point_source - grey_var;
p->white_point_source = p->white_point_source + grey_var;
_compute_output_power(self, p);
DT_TRY_GUI_UPDATE();
dt_bauhaus_slider_set(g->grey_point_source, p->grey_point_source);
dt_bauhaus_slider_set(g->black_point_source, p->black_point_source);
dt_bauhaus_slider_set(g->white_point_source, p->white_point_source);
dt_bauhaus_slider_set(g->output_power, p->output_power);
DT_LEAVE_GUI_UPDATE();
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_dev_add_history_item(darktable.develop, self, TRUE);
}
static void apply_auto_black(dt_iop_module_t *self)
{
DT_GUARD_GUI_UPDATE();
dt_iop_filmicrgb_params_t *p = self->params;
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
// Black
const dt_iop_order_iccprofile_info_t *const work_profile
= dt_ioppr_get_iop_work_profile_info(self, self->dev->iop);
const float black = get_pixel_norm(self->picked_color_min, DT_FILMIC_METHOD_MAX_RGB, work_profile);
float EVmin = CLAMP(log2f(black / (p->grey_point_source / 100.0f)), -16.0f, -1.0f);
EVmin *= (1.0f + p->security_factor / 100.0f);
p->black_point_source = fmaxf(EVmin, -16.0f);
_compute_output_power(self, p);
DT_ENTER_GUI_UPDATE();
dt_bauhaus_slider_set(g->black_point_source, p->black_point_source);
dt_bauhaus_slider_set(g->output_power, p->output_power);
DT_LEAVE_GUI_UPDATE();
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_dev_add_history_item(darktable.develop, self, TRUE);
}
static void apply_auto_white_point_source(dt_iop_module_t *self)
{
DT_GUARD_GUI_UPDATE();
dt_iop_filmicrgb_params_t *p = self->params;
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
// White
const dt_iop_order_iccprofile_info_t *const work_profile
= dt_ioppr_get_iop_work_profile_info(self, self->dev->iop);
const float white = get_pixel_norm(self->picked_color_max, DT_FILMIC_METHOD_MAX_RGB, work_profile);
float EVmax = CLAMP(log2f(white / (p->grey_point_source / 100.0f)), 1.0f, 16.0f);
EVmax *= (1.0f + p->security_factor / 100.0f);
p->white_point_source = EVmax;
_compute_output_power(self, p);
DT_ENTER_GUI_UPDATE();
dt_bauhaus_slider_set(g->white_point_source, p->white_point_source);
dt_bauhaus_slider_set(g->output_power, p->output_power);
DT_LEAVE_GUI_UPDATE();
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_dev_add_history_item(darktable.develop, self, TRUE);
}
static void apply_autotune(dt_iop_module_t *self)
{
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
dt_iop_filmicrgb_params_t *p = self->params;
const dt_iop_order_iccprofile_info_t *const work_profile
= dt_ioppr_get_iop_work_profile_info(self, self->dev->iop);
// Grey
if(p->custom_grey)
{
const float grey = get_pixel_norm(self->picked_color, p->preserve_color, work_profile) / 2.0f;
p->grey_point_source = CLAMP(100.f * grey, 0.001f, 100.0f);
}
// White
const float white = get_pixel_norm(self->picked_color_max, DT_FILMIC_METHOD_MAX_RGB, work_profile);
float EVmax = CLAMP(log2f(white / (p->grey_point_source / 100.0f)), 1.0f, 16.0f);
EVmax *= (1.0f + p->security_factor / 100.0f);
// Black
const float black = get_pixel_norm(self->picked_color_min, DT_FILMIC_METHOD_MAX_RGB, work_profile);
float EVmin = CLAMP(log2f(black / (p->grey_point_source / 100.0f)), -16.0f, -1.0f);
EVmin *= (1.0f + p->security_factor / 100.0f);
p->black_point_source = fmaxf(EVmin, -16.0f);
p->white_point_source = EVmax;
_compute_output_power(self, p);
DT_ENTER_GUI_UPDATE();
dt_bauhaus_slider_set(g->grey_point_source, p->grey_point_source);
dt_bauhaus_slider_set(g->black_point_source, p->black_point_source);
dt_bauhaus_slider_set(g->white_point_source, p->white_point_source);
dt_bauhaus_slider_set(g->output_power, p->output_power);
DT_LEAVE_GUI_UPDATE();
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_dev_add_history_item(darktable.develop, self, TRUE);
}
void color_picker_apply(dt_iop_module_t *self, GtkWidget *picker,
dt_dev_pixelpipe_t *pipe)
{
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
if(picker == g->grey_point_source)
apply_auto_grey(self);
else if(picker == g->black_point_source)
apply_auto_black(self);
else if(picker == g->white_point_source)
apply_auto_white_point_source(self);
else if(picker == g->auto_button)
apply_autotune(self);
}
static void show_mask_callback(GtkGestureSingle *gesture,
int n_press,
double x,
double y,
dt_iop_module_t *self)
{
DT_TRY_GUI_UPDATE();
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
dt_iop_gui_enter_critical_section(self);
g->show_mask = !(g->show_mask);
const gboolean show_mask = g->show_mask;
dt_iop_gui_leave_critical_section(self);
gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g->show_highlight_mask), show_mask);
DT_LEAVE_GUI_UPDATE();
dt_dev_reprocess_center(self->dev, self->iop_order);
}
#define ORDER_4 5
#define ORDER_3 4
// returns true if contrast was clamped, false otherwise
// used in GUI, to show user when contrast clamping is happening
inline static gboolean dt_iop_filmic_rgb_compute_spline(const dt_iop_filmicrgb_params_t *const p,
dt_iop_filmic_rgb_spline_t *const spline)
{
float grey_display = 0.4638f;
gboolean clamping = FALSE;
if(p->custom_grey)
{
// user set a custom value
grey_display = powf(CLAMP(p->grey_point_target, p->black_point_target, p->white_point_target) / 100.0f,
1.0f / (p->output_power));
}
else
{
// use 18.45% grey and don't bother
grey_display = powf(0.1845f, 1.0f / (p->output_power));
}
const float white_source = p->white_point_source;
const float black_source = p->black_point_source;
const float dynamic_range = white_source - black_source;
// luminance after log encoding
const float black_log = 0.0f; // assumes user set log as in the autotuner
const float grey_log = fabsf(p->black_point_source) / dynamic_range;
const float white_log = 1.0f; // assumes user set log as in the autotuner
// target luminance desired after filmic curve
float black_display, white_display;
if(p->spline_version == DT_FILMIC_SPLINE_VERSION_V1)
{
// this is a buggy version that doesn't take the output power function into account
// it was silent because black and white display were set to 0 and 1 and users were advised to not touch them.
// (since 0^x = 0 and 1^x = 1). It's not silent anymore if black display > 0,
// for example if compensating ICC black level for target medium
black_display = CLAMP(p->black_point_target, 0.0f, p->grey_point_target) / 100.0f; // in %
white_display = fmaxf(p->white_point_target, p->grey_point_target) / 100.0f; // in %
}
else //(p->spline_version >= DT_FILMIC_SPLINE_VERSION_V2)
{
// this is the fixed version
black_display = powf(CLAMP(p->black_point_target, 0.0f, p->grey_point_target) / 100.0f,
1.0f / (p->output_power)); // in %
white_display
= powf(fmaxf(p->white_point_target, p->grey_point_target) / 100.0f, 1.0f / (p->output_power)); // in %
}
float toe_log, shoulder_log, toe_display, shoulder_display, contrast;
const float balance = CLAMP(p->balance, -50.0f, 50.0f) / 100.0f; // in %
if(p->spline_version < DT_FILMIC_SPLINE_VERSION_V3)
{
const float latitude = CLAMP(p->latitude, 0.0f, 100.0f) / 100.0f * dynamic_range; // in % of dynamic range
contrast = CLAMP(p->contrast, 1.00001f, 6.0f);
// nodes for mapping from log encoding to desired target luminance
// X coordinates
toe_log = grey_log - latitude / dynamic_range * fabsf(black_source / dynamic_range);
shoulder_log = grey_log + latitude / dynamic_range * fabsf(white_source / dynamic_range);
// interception
const float linear_intercept = grey_display - (contrast * grey_log);
// y coordinates
toe_display = (toe_log * contrast + linear_intercept);
shoulder_display = (shoulder_log * contrast + linear_intercept);
// Apply the highlights/shadows balance as a shift along the contrast slope
const float norm = sqrtf(contrast * contrast + 1.0f);
// negative values drag to the left and compress the shadows, on the UI negative is the inverse
const float coeff = -((2.0f * latitude) / dynamic_range) * balance;
toe_display += coeff * contrast / norm;
shoulder_display += coeff * contrast / norm;
toe_log += coeff / norm;
shoulder_log += coeff / norm;
}
else // p->spline_version >= DT_FILMIC_SPLINE_VERSION_V3. Slope dependent on contrast only, and latitude as % of display range.
{
const float hardness = p->output_power;
// latitude in %
const float latitude = CLAMP(p->latitude, 0.0f, 100.0f) / 100.0f;
const float slope = p->contrast * dynamic_range / 8.0f;
float min_contrast = 1.0f; // otherwise, white_display and black_display cannot be reached
// make sure there is enough contrast to be able to construct the top right part of the curve
min_contrast = fmaxf(min_contrast, (white_display - grey_display) / (white_log - grey_log));
// make sure there is enough contrast to be able to construct the bottom left part of the curve
min_contrast = fmaxf(min_contrast, (grey_display - black_display) / (grey_log - black_log));
min_contrast += SAFETY_MARGIN;
// we want a slope that depends only on contrast at gray point.
// let's consider f(x) = (contrast*x+linear_intercept)^hardness
// f'(x) = contrast * hardness * (contrast*x+linear_intercept)^(hardness-1)
// linear_intercept = grey_display - (contrast * grey_log);
// f'(grey_log) = contrast * hardness * (contrast * grey_log + grey_display - (contrast * grey_log))^(hardness-1)
// = contrast * hardness * grey_display^(hardness-1)
// f'(grey_log) = target_contrast <=> contrast = target_contrast / (hardness * grey_display^(hardness-1))
contrast = slope / (hardness * powf(grey_display, hardness - 1.0f));
const float clamped_contrast = CLAMP(contrast, min_contrast, 100.0f);
clamping = (clamped_contrast != contrast);
contrast = clamped_contrast;
// interception
const float linear_intercept = grey_display - (contrast * grey_log);
// consider the line of equation y = contrast * x + linear_intercept
// we want to keep y in [black_display, white_display] (with some safety margin)
// thus, we compute x values such as y=black_display and y=white_display
// latitude will influence position of toe and shoulder in the [xmin, xmax] segment
const float xmin = (black_display + SAFETY_MARGIN * (white_display - black_display) - linear_intercept) / contrast;
const float xmax = (white_display - SAFETY_MARGIN * (white_display - black_display) - linear_intercept) / contrast;
// nodes for mapping from log encoding to desired target luminance
// X coordinates
toe_log = (1.0f - latitude) * grey_log + latitude * xmin;
shoulder_log = (1.0f - latitude) * grey_log + latitude * xmax;
// Apply the highlights/shadows balance as a shift along the contrast slope
// negative values drag to the left and compress the shadows, on the UI negative is the inverse
const float balance_correction = (balance > 0.0f) ? 2.0f * balance * (shoulder_log - grey_log)
: 2.0f * balance * (grey_log - toe_log);
toe_log -= balance_correction;
shoulder_log -= balance_correction;
toe_log = fmaxf(toe_log, xmin);
shoulder_log = MIN(shoulder_log, xmax);
// y coordinates
toe_display = (toe_log * contrast + linear_intercept);
shoulder_display = (shoulder_log * contrast + linear_intercept);
}
/**
* Now we have 3 segments :
* - x = [0.0 ; toe_log], curved part
* - x = [toe_log ; grey_log ; shoulder_log], linear part
* - x = [shoulder_log ; 1.0] curved part
*
* BUT : in case some nodes overlap, we need to remove them to avoid
* degenerating of the curve
**/
// Build the curve from the nodes
spline->x[0] = black_log;
spline->x[1] = toe_log;
spline->x[2] = grey_log;
spline->x[3] = shoulder_log;
spline->x[4] = white_log;
spline->y[0] = black_display;
spline->y[1] = toe_display;
spline->y[2] = grey_display;
spline->y[3] = shoulder_display;
spline->y[4] = white_display;
spline->latitude_min = spline->x[1];
spline->latitude_max = spline->x[3];
spline->type[0] = p->shadows;
spline->type[1] = p->highlights;
/**
* For background and details, see :
* https://eng.aurelienpierre.com/2018/11/30/filmic-darktable-and-the-quest-of-the-hdr-tone-mapping/#filmic_s_curve
*
**/
const double Tl = spline->x[1];
const double Tl2 = Tl * Tl;
const double Tl3 = Tl2 * Tl;
const double Tl4 = Tl3 * Tl;
const double Sl = spline->x[3];
const double Sl2 = Sl * Sl;
const double Sl3 = Sl2 * Sl;
const double Sl4 = Sl3 * Sl;
// if type polynomial :
// y = M5 * x⁴ + M4 * x³ + M3 * x² + M2 * x¹ + M1 * x⁰
// else if type rational :
// y = M1 * (M2 * (x - x_0)² + (x - x_0)) / (M2 * (x - x_0)² + (x - x_0) + M3)
// We then compute M1 to M5 coeffs using the imposed conditions over the curve.
// M1 to M5 are 3×1 vectors, where each element belongs to a part of the curve.
// solve the linear central part - affine function
spline->M2[2] = contrast; // * x¹ (slope)
spline->M1[2] = spline->y[1] - spline->M2[2] * spline->x[1]; // * x⁰ (offset)
spline->M3[2] = 0.f; // * x²
spline->M4[2] = 0.f; // * x³
spline->M5[2] = 0.f; // * x⁴
// solve the toe part
if(p->shadows == DT_FILMIC_CURVE_POLY_4)
{
// fourth order polynom - only mode in darktable 3.0.0
double A0[ORDER_4 * ORDER_4] = { 0., 0., 0., 0., 1., // position in 0
0., 0., 0., 1., 0., // first derivative in 0
Tl4, Tl3, Tl2, Tl, 1., // position at toe node
4. * Tl3, 3. * Tl2, 2. * Tl, 1., 0., // first derivative at toe node
12. * Tl2, 6. * Tl, 2., 0., 0. }; // second derivative at toe node
double b0[ORDER_4] = { spline->y[0], 0., spline->y[1], spline->M2[2], 0. };
gauss_solve(A0, b0, ORDER_4);
spline->M5[0] = b0[0]; // * x⁴
spline->M4[0] = b0[1]; // * x³
spline->M3[0] = b0[2]; // * x²
spline->M2[0] = b0[3]; // * x¹
spline->M1[0] = b0[4]; // * x⁰
}
else if(p->shadows == DT_FILMIC_CURVE_POLY_3)
{
// third order polynom
double A0[ORDER_3 * ORDER_3] = { 0., 0., 0., 1., // position in 0
Tl3, Tl2, Tl, 1., // position at toe node
3. * Tl2, 2. * Tl, 1., 0., // first derivative at toe node
6. * Tl, 2., 0., 0. }; // second derivative at toe node
double b0[ORDER_3] = { spline->y[0], spline->y[1], spline->M2[2], 0. };
gauss_solve(A0, b0, ORDER_3);
spline->M5[0] = 0.0f; // * x⁴
spline->M4[0] = b0[0]; // * x³
spline->M3[0] = b0[1]; // * x²
spline->M2[0] = b0[2]; // * x¹
spline->M1[0] = b0[3]; // * x⁰
}
else
{
const float P1[2] = { black_log, black_display };
const float P0[2] = { toe_log, toe_display };
const float x = P0[0] - P1[0];
const float y = P0[1] - P1[1];
const float g = contrast;
const float b = g / (2.f * y) + (sqrtf(sqf(x * g / y + 1.f) - 4.f) - 1.f) / (2.f * x);
const float c = y / g * (b * sqf(x) + x) / (b * sqf(x) + x - (y / g));
const float a = c * g;
spline->M1[0] = a;
spline->M2[0] = b;
spline->M3[0] = c;
spline->M4[0] = toe_display;
}
// solve the shoulder part
if(p->highlights == DT_FILMIC_CURVE_POLY_3)
{
// 3rd order polynom - only mode in darktable 3.0.0
double A1[ORDER_3 * ORDER_3] = { 1., 1., 1., 1., // position in 1
Sl3, Sl2, Sl, 1., // position at shoulder node
3. * Sl2, 2. * Sl, 1., 0., // first derivative at shoulder node
6. * Sl, 2., 0., 0. }; // second derivative at shoulder node
double b1[ORDER_3] = { spline->y[4], spline->y[3], spline->M2[2], 0. };
gauss_solve(A1, b1, ORDER_3);
spline->M5[1] = 0.0f; // * x⁴
spline->M4[1] = b1[0]; // * x³
spline->M3[1] = b1[1]; // * x²
spline->M2[1] = b1[2]; // * x¹
spline->M1[1] = b1[3]; // * x⁰
}
else if(p->highlights == DT_FILMIC_CURVE_POLY_4)
{
// 4th order polynom
double A1[ORDER_4 * ORDER_4] = { 1., 1., 1., 1., 1., // position in 1
4., 3., 2., 1., 0., // first derivative in 1
Sl4, Sl3, Sl2, Sl, 1., // position at shoulder node
4. * Sl3, 3. * Sl2, 2. * Sl, 1., 0., // first derivative at shoulder node
12. * Sl2, 6. * Sl, 2., 0., 0. }; // second derivative at shoulder node
double b1[ORDER_4] = { spline->y[4], 0., spline->y[3], spline->M2[2], 0. };
gauss_solve(A1, b1, ORDER_4);
spline->M5[1] = b1[0]; // * x⁴
spline->M4[1] = b1[1]; // * x³
spline->M3[1] = b1[2]; // * x²
spline->M2[1] = b1[3]; // * x¹
spline->M1[1] = b1[4]; // * x⁰
}
else
{
const float P1[2] = { white_log, white_display };
const float P0[2] = { shoulder_log, shoulder_display };
const float x = P1[0] - P0[0];
const float y = P1[1] - P0[1];
const float g = contrast;
const float b = g / (2.f * y) + (sqrtf(sqf(x * g / y + 1.f) - 4.f) - 1.f) / (2.f * x);
const float c = y / g * (b * sqf(x) + x) / (b * sqf(x) + x - (y / g));
const float a = c * g;
spline->M1[1] = a;
spline->M2[1] = b;
spline->M3[1] = c;
spline->M4[1] = shoulder_display;
}
return clamping;
}
void commit_params(dt_iop_module_t *self, dt_iop_params_t *p1, dt_dev_pixelpipe_t *pipe,
dt_dev_pixelpipe_iop_t *piece)
{
const dt_iop_filmicrgb_params_t *p = (dt_iop_filmicrgb_params_t *)p1;
dt_iop_filmicrgb_data_t *d = piece->data;
// source and display greys
float grey_source = 0.1845f, grey_display = 0.4638f;
if(p->custom_grey)
{
// user set a custom value
grey_source = p->grey_point_source / 100.0f; // in %
grey_display = powf(p->grey_point_target / 100.0f, 1.0f / (p->output_power));
}
else
{
// use 18.45% grey and don't bother
grey_source = 0.1845f; // in %
grey_display = powf(0.1845f, 1.0f / (p->output_power));
}
// source luminance - Used only in the log encoding
const float white_source = p->white_point_source;
const float black_source = p->black_point_source;
const float dynamic_range = white_source - black_source;
// luminance after log encoding
const float grey_log = fabsf(p->black_point_source) / dynamic_range;
float contrast = p->contrast;
if((p->spline_version < DT_FILMIC_SPLINE_VERSION_V3) && (contrast < grey_display / grey_log))
{
// We need grey_display - (contrast * grey_log) <= 0.0
// this clamping is handled automatically for spline_version >= DT_FILMIC_SPLINE_VERSION_V3
contrast = 1.0001f * grey_display / grey_log;
}
// commit
d->dynamic_range = dynamic_range;
d->black_source = black_source;
d->grey_source = grey_source;
d->output_power = p->output_power;
d->contrast = contrast;
d->version = p->version;
d->spline_version = p->spline_version;
d->preserve_color = p->preserve_color;
d->high_quality_reconstruction = p->high_quality_reconstruction;
d->noise_level = p->noise_level;
d->noise_distribution = (dt_noise_distribution_t)p->noise_distribution;
// compute the curves and their LUT
dt_iop_filmic_rgb_compute_spline(p, &d->spline);
if(p->version >= DT_FILMIC_COLORSCIENCE_V4)
d->saturation = p->saturation / 100.0f;
else
d->saturation = (2.0f * p->saturation / 100.0f + 1.0f);
d->sigma_toe = powf(d->spline.latitude_min / 3.0f, 2.0f);
d->sigma_shoulder = powf((1.0f - d->spline.latitude_max) / 3.0f, 2.0f);
d->reconstruct_threshold = powf(2.0f, white_source + p->reconstruct_threshold) * grey_source;
d->reconstruct_feather = exp2f(12.f / p->reconstruct_feather);
// offset and rescale user param to alpha blending so 0 -> 50% and 1 -> 100%
d->normalize = d->reconstruct_feather / d->reconstruct_threshold;
d->reconstruct_structure_vs_texture = (p->reconstruct_structure_vs_texture / 100.0f + 1.f) / 2.f;
d->reconstruct_bloom_vs_details = (p->reconstruct_bloom_vs_details / 100.0f + 1.f) / 2.f;
d->reconstruct_grey_vs_color = (p->reconstruct_grey_vs_color / 100.0f + 1.f) / 2.f;
d->enable_highlight_reconstruction = p->enable_highlight_reconstruction;
}
void gui_focus(dt_iop_module_t *self, gboolean in)
{
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
if(!in)
{
// lost focus - hide the mask
dt_iop_gui_enter_critical_section(self);
const gboolean show_mask = g->show_mask;
g->show_mask = FALSE;
dt_iop_gui_leave_critical_section(self);
gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g->show_highlight_mask), FALSE);
if(show_mask) dt_dev_reprocess_center(self->dev, self->iop_order);
}
}
void init_pipe(dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe, dt_dev_pixelpipe_iop_t *piece)
{
piece->data = dt_calloc1_align_type(dt_iop_filmicrgb_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 gui_update(dt_iop_module_t *self)
{
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
const dt_iop_filmicrgb_params_t *p = self->params;
dt_iop_color_picker_reset(self, TRUE);
g->show_mask = FALSE;
g->gui_mode = dt_conf_get_int("plugins/darkroom/filmicrgb/graph_view");
g->gui_show_labels = dt_conf_get_int("plugins/darkroom/filmicrgb/graph_show_labels");
g->gui_hover = FALSE;
g->gui_sizes_inited = FALSE;
// fetch last view in dartablerc
dt_bauhaus_toggle_set(g->auto_hardness, p->auto_hardness);
dt_bauhaus_toggle_set(g->custom_grey, p->custom_grey);
dt_bauhaus_toggle_set(g->enable_highlight_reconstruction, p->enable_highlight_reconstruction);
gui_changed(self, NULL, NULL);
}
void reload_defaults(dt_iop_module_t *self)
{
dt_iop_filmicrgb_params_t *d = self->default_params;
d->black_point_source = self->so->get_f("black_point_source")->Float.Default;
d->white_point_source = self->so->get_f("white_point_source")->Float.Default;
d->output_power = self->so->get_f("output_power")->Float.Default;
self->default_enabled = FALSE;
const gboolean is_scene_referred = dt_is_scene_referred();
if(dt_image_is_matrix_correction_supported(&self->dev->image_storage)
&& is_scene_referred)
{
// For scene-referred workflow, auto-enable and adjust based on exposure
// TODO: fetch actual exposure in module, don't assume 1.
const float exposure = 0.7f - dt_image_get_exposure_bias(&self->dev->image_storage);
// As global exposure increases, white exposure increases faster than black
// this is probably because raw black/white points offsets the lower bound of the dynamic range to 0
// so exposure compensation actually increases the dynamic range too (stretches only white).
d->black_point_source += 0.5f * exposure;
d->white_point_source += 0.8f * exposure;
_compute_output_power(self, d);
}
}
void init_presets(dt_iop_module_so_t *self)
{
// auto-applied scene-referred default
self->pref_based_presets = TRUE;
const char *workflow = dt_conf_get_string_const("plugins/darkroom/workflow");
const gboolean auto_apply_filmic = strcmp(workflow, "scene-referred (filmic)") == 0;
if(auto_apply_filmic)
{
dt_gui_presets_add_generic
(_("scene-referred default"), self->op, self->version(),
NULL, 0,
TRUE, DEVELOP_BLEND_CS_RGB_SCENE);
dt_gui_presets_update_format(BUILTIN_PRESET("scene-referred default"), self->op,
self->version(), FOR_RAW | FOR_MATRIX);
dt_gui_presets_update_autoapply(BUILTIN_PRESET("scene-referred default"),
self->op, self->version(), TRUE);
}
}
void init_global(dt_iop_module_so_t *self)
{
const int program = 22; // filmic.cl, from programs.conf
dt_iop_filmicrgb_global_data_t *gd = malloc(sizeof(dt_iop_filmicrgb_global_data_t));
self->data = gd;
gd->kernel_filmic_rgb_split = dt_opencl_create_kernel(program, "filmicrgb_split");
gd->kernel_filmic_rgb_chroma = dt_opencl_create_kernel(program, "filmicrgb_chroma");
gd->kernel_filmic_mask = dt_opencl_create_kernel(program, "filmic_mask_clipped_pixels");
gd->kernel_filmic_show_mask = dt_opencl_create_kernel(program, "filmic_show_mask");
gd->kernel_filmic_inpaint_noise = dt_opencl_create_kernel(program, "filmic_inpaint_noise");
gd->kernel_filmic_init_reconstruct = dt_opencl_create_kernel(program, "init_reconstruct");
gd->kernel_filmic_wavelets_reconstruct = dt_opencl_create_kernel(program, "wavelets_reconstruct");
gd->kernel_filmic_compute_ratios = dt_opencl_create_kernel(program, "compute_ratios");
gd->kernel_filmic_restore_ratios = dt_opencl_create_kernel(program, "restore_ratios");
const int wavelets = 35; // bspline.cl, from programs.conf
gd->kernel_filmic_bspline_horizontal = dt_opencl_create_kernel(wavelets, "blur_2D_Bspline_horizontal");
gd->kernel_filmic_bspline_vertical = dt_opencl_create_kernel(wavelets, "blur_2D_Bspline_vertical");
gd->kernel_filmic_wavelets_detail = dt_opencl_create_kernel(wavelets, "wavelets_detail_level");
}
void cleanup_global(dt_iop_module_so_t *self)
{
const dt_iop_filmicrgb_global_data_t *gd = self->data;
dt_opencl_free_kernel(gd->kernel_filmic_rgb_split);
dt_opencl_free_kernel(gd->kernel_filmic_rgb_chroma);
dt_opencl_free_kernel(gd->kernel_filmic_mask);
dt_opencl_free_kernel(gd->kernel_filmic_show_mask);
dt_opencl_free_kernel(gd->kernel_filmic_inpaint_noise);
dt_opencl_free_kernel(gd->kernel_filmic_bspline_vertical);
dt_opencl_free_kernel(gd->kernel_filmic_bspline_horizontal);
dt_opencl_free_kernel(gd->kernel_filmic_init_reconstruct);
dt_opencl_free_kernel(gd->kernel_filmic_wavelets_detail);
dt_opencl_free_kernel(gd->kernel_filmic_wavelets_reconstruct);
dt_opencl_free_kernel(gd->kernel_filmic_compute_ratios);
dt_opencl_free_kernel(gd->kernel_filmic_restore_ratios);
free(self->data);
self->data = NULL;
}
void gui_reset(dt_iop_module_t *self)
{
dt_iop_color_picker_reset(self, TRUE);
}
#define LOGBASE 20.f
static inline void dt_cairo_draw_arrow(cairo_t *cr, const double origin_x, const double origin_y, const double destination_x,
const double destination_y, const gboolean show_head)
{
cairo_move_to(cr, origin_x, origin_y);
cairo_line_to(cr, destination_x, destination_y);
cairo_stroke(cr);
if(show_head)
{
// arrow head is hard set to 45° - convert to radians
const float angle_arrow = 45.f / 360.f * M_PI_F;
const float angle_trunk = atan2f((destination_y - origin_y), (destination_x - origin_x));
const float radius = DT_PIXEL_APPLY_DPI(3);
const float x_1 = destination_x + radius / sinf(angle_arrow + angle_trunk);
const float y_1 = destination_y + radius / cosf(angle_arrow + angle_trunk);
const float x_2 = destination_x - radius / sinf(-angle_arrow + angle_trunk);
const float y_2 = destination_y - radius / cosf(-angle_arrow + angle_trunk);
cairo_move_to(cr, x_1, y_1);
cairo_line_to(cr, destination_x, destination_y);
cairo_line_to(cr, x_2, y_2);
cairo_stroke(cr);
}
}
void filmic_gui_draw_icon(cairo_t *cr, const dt_iop_filmicrgb_gui_button_data_t *button,
const dt_iop_filmicrgb_gui_data_t *g)
{
if(!g->gui_sizes_inited) return;
cairo_save(cr);
if(button->mouse_hover)
set_color(cr, darktable.bauhaus->color_fg);
else
set_color(cr, darktable.bauhaus->color_fg_insensitive);
cairo_rectangle(cr, button->left, button->top, button->w - DT_PIXEL_APPLY_DPI(0.5),
button->h - DT_PIXEL_APPLY_DPI(0.5));
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(1.));
cairo_stroke(cr);
cairo_translate(cr, button->left + button->w / 2. - DT_PIXEL_APPLY_DPI(0.25),
button->top + button->h / 2. - DT_PIXEL_APPLY_DPI(0.25));
const float scale = 0.85;
cairo_scale(cr, scale, scale);
button->icon(cr, -scale * button->w / 2., -scale * button->h / 2., scale * button->w, scale * button->h, 0, NULL);
cairo_restore(cr);
}
static gboolean dt_iop_tonecurve_draw(GtkWidget *widget, cairo_t *crf, dt_iop_module_t *self)
{
dt_iop_filmicrgb_params_t *p = self->params;
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
gboolean contrast_clamped = dt_iop_filmic_rgb_compute_spline(p, &g->spline);
// Cache the graph objects to avoid recomputing all the view at each redraw
gtk_widget_get_allocation(widget, &g->allocation);
g->allocation.height -= DT_RESIZE_HANDLE_SIZE;
cairo_surface_t *cst =
dt_cairo_image_surface_create(CAIRO_FORMAT_ARGB32, g->allocation.width, g->allocation.height);
PangoFontDescription *desc = dt_gui_get_font();
cairo_t *cr = cairo_create(cst);
PangoLayout *layout = pango_cairo_create_layout(cr);
pango_layout_set_font_description(layout, desc);
pango_cairo_context_set_resolution(pango_layout_get_context(layout), darktable.gui->dpi);
g->context = gtk_widget_get_style_context(widget);
char text[256];
// reduce a bit the font size
const gint font_size = pango_font_description_get_size(desc);
pango_font_description_set_size(desc, 0.95 * font_size);
pango_layout_set_font_description(layout, desc);
// Get the text line height for spacing
g_strlcpy(text, "X", sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
g->line_height = g->ink.height;
// Get the width of a minus sign for legend labels spacing
g_strlcpy(text, "-", sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
g->sign_width = g->ink.width / 2.0;
// Get the width of a zero for legend labels spacing
g_strlcpy(text, "0", sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
g->zero_width = g->ink.width;
// Set the sizes, margins and paddings
g->inner_padding = DT_PIXEL_APPLY_DPI(4); // TODO: INNER_PADDING value as defined in bauhaus.c macros, sync them
g->inset = g->inner_padding;
float margin_left;
float margin_bottom;
if(g->gui_show_labels)
{
// leave room for labels
margin_left = 3. * g->zero_width + 2. * g->inset;
margin_bottom = 2. * g->line_height + 4. * g->inset;
}
else
{
margin_left = g->inset;
margin_bottom = g->inset;
}
const float margin_top = 2. * g->line_height + g->inset;
const float margin_right = darktable.bauhaus->quad_width + 2. * g->inset;
g->graph_width = g->allocation.width - margin_right - margin_left; // align the right border on sliders
g->graph_height = g->allocation.height - margin_bottom - margin_top; // give room to nodes
gtk_render_background(g->context, cr, 0, 0, g->allocation.width, g->allocation.height);
// Init icons bounds and cache them for mouse events
for(int i = 0; i < DT_FILMIC_GUI_BUTTON_LAST; i++)
{
// put the buttons in the right margin and increment vertical position
g->buttons[i].right = g->allocation.width;
g->buttons[i].left = g->buttons[i].right - darktable.bauhaus->quad_width;
g->buttons[i].top = margin_top + i * (g->inset + darktable.bauhaus->quad_width);
g->buttons[i].bottom = g->buttons[i].top + darktable.bauhaus->quad_width;
g->buttons[i].w = g->buttons[i].right - g->buttons[i].left;
g->buttons[i].h = g->buttons[i].bottom - g->buttons[i].top;
g->buttons[i].state = GTK_STATE_FLAG_NORMAL;
}
g->gui_sizes_inited = TRUE;
g->buttons[0].icon = dtgtk_cairo_paint_refresh;
g->buttons[1].icon = dtgtk_cairo_paint_text_label;
if(g->gui_hover)
{
for(int i = 0; i < DT_FILMIC_GUI_BUTTON_LAST; i++) filmic_gui_draw_icon(cr, &g->buttons[i], g);
}
const float grey = p->grey_point_source / 100.f;
const float DR = p->white_point_source - p->black_point_source;
// set the graph as the origin of the coordinates
cairo_translate(cr, margin_left, margin_top);
cairo_set_line_cap(cr, CAIRO_LINE_CAP_ROUND);
// write the graph legend at GUI default size
pango_font_description_set_size(desc, font_size);
pango_layout_set_font_description(layout, desc);
if(g->gui_mode == DT_FILMIC_GUI_LOOK)
g_strlcpy(text, _("look only"), sizeof(text));
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE)
g_strlcpy(text, _("look + mapping (lin)"), sizeof(text));
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
g_strlcpy(text, _("look + mapping (log)"), sizeof(text));
else if(g->gui_mode == DT_FILMIC_GUI_RANGES)
g_strlcpy(text, _("dynamic range mapping"), sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
// legend background
set_color(cr, darktable.bauhaus->graph_bg);
cairo_rectangle(cr, g->allocation.width - margin_left - g->ink.width - g->ink.x - 2. * g->inset,
-g->line_height - g->inset - 0.5 * g->ink.height - g->ink.y - g->inset,
g->ink.width + 3. * g->inset, g->ink.height + 2. * g->inset);
cairo_fill(cr);
// legend text
set_color(cr, darktable.bauhaus->graph_fg);
cairo_move_to(cr, g->allocation.width - margin_left - g->ink.width - g->ink.x - g->inset,
-g->line_height - g->inset - 0.5 * g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// reduce font size for the rest of the graph
pango_font_description_set_size(desc, 0.95 * font_size);
pango_layout_set_font_description(layout, desc);
if(g->gui_mode != DT_FILMIC_GUI_RANGES)
{
// Draw graph background then border
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(0.5));
cairo_rectangle(cr, 0, 0, g->graph_width, g->graph_height);
set_color(cr, darktable.bauhaus->graph_bg);
cairo_fill_preserve(cr);
set_color(cr, darktable.bauhaus->graph_border);
cairo_stroke(cr);
// draw grid
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(0.5));
set_color(cr, darktable.bauhaus->graph_border);
// we need to tweak the coordinates system to match dt_draw_grid expectations
cairo_save(cr);
cairo_scale(cr, 1., -1.);
cairo_translate(cr, 0., -g->graph_height);
if(g->gui_mode == DT_FILMIC_GUI_LOOK || g->gui_mode == DT_FILMIC_GUI_BASECURVE)
dt_draw_grid(cr, 4, 0, 0, g->graph_width, g->graph_height);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
dt_draw_loglog_grid(cr, 4, 0, 0, g->graph_width, g->graph_height, LOGBASE);
// reset coordinates
cairo_restore(cr);
// draw identity line
cairo_move_to(cr, 0, g->graph_height);
cairo_line_to(cr, g->graph_width, 0);
cairo_stroke(cr);
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(2.));
// Draw the saturation curve
const float saturation = (2.0f * p->saturation / 100.0f + 1.0f);
const float sigma_toe = powf(g->spline.latitude_min / 3.0f, 2.0f);
const float sigma_shoulder = powf((1.0f - g->spline.latitude_max) / 3.0f, 2.0f);
cairo_set_source_rgb(cr, .5, .5, .5);
// prevent graph overflowing
cairo_save(cr);
cairo_rectangle(cr, -DT_PIXEL_APPLY_DPI(2.), -DT_PIXEL_APPLY_DPI(2.),
g->graph_width + 2. * DT_PIXEL_APPLY_DPI(2.), g->graph_height + 2. * DT_PIXEL_APPLY_DPI(2.));
cairo_clip(cr);
if(p->version == DT_FILMIC_COLORSCIENCE_V1)
{
cairo_move_to(cr, 0,
g->graph_height * (1.0 - filmic_desaturate_v1(0.0f, sigma_toe, sigma_shoulder, saturation)));
for(int k = 1; k < 256; k++)
{
float x = k / 255.0;
const float y = filmic_desaturate_v1(x, sigma_toe, sigma_shoulder, saturation);
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE)
x = exp_tonemapping_v2(x, grey, p->black_point_source, DR);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
x = dt_log_scale_axis(exp_tonemapping_v2(x, grey, p->black_point_source, DR), LOGBASE);
cairo_line_to(cr, x * g->graph_width, g->graph_height * (1.0 - y));
}
}
else if(p->version == DT_FILMIC_COLORSCIENCE_V2 || p->version == DT_FILMIC_COLORSCIENCE_V3)
{
cairo_move_to(cr, 0,
g->graph_height * (1.0 - filmic_desaturate_v2(0.0f, sigma_toe, sigma_shoulder, saturation)));
for(int k = 1; k < 256; k++)
{
float x = k / 255.0;
const float y = filmic_desaturate_v2(x, sigma_toe, sigma_shoulder, saturation);
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE)
x = exp_tonemapping_v2(x, grey, p->black_point_source, DR);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
x = dt_log_scale_axis(exp_tonemapping_v2(x, grey, p->black_point_source, DR), LOGBASE);
cairo_line_to(cr, x * g->graph_width, g->graph_height * (1.0 - y));
}
}
cairo_stroke(cr);
// draw the tone curve
float x_start = 0.f;
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE || g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
x_start = log_tonemapping_v2_1ch(x_start, grey, p->black_point_source, DR);
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG) x_start = dt_log_scale_axis(x_start, LOGBASE);
float y_start = clamp_simd(filmic_spline(x_start, g->spline.M1, g->spline.M2, g->spline.M3, g->spline.M4,
g->spline.M5, g->spline.latitude_min, g->spline.latitude_max, g->spline.type));
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE)
y_start = powf(y_start, p->output_power);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
y_start = dt_log_scale_axis(powf(y_start, p->output_power), LOGBASE);
cairo_move_to(cr, 0, g->graph_height * (1.0 - y_start));
for(int k = 1; k < 256; k++)
{
// k / 255 step defines a linearly scaled space. This might produce large gaps in lowlights when using log
// GUI scaling so we non-linearly rescale that step to get more points in lowlights
float x = powf(k / 255.0f, 2.4f);
float value = x;
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE || g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
value = log_tonemapping_v2_1ch(x, grey, p->black_point_source, DR);
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG) x = dt_log_scale_axis(x, LOGBASE);
float y = filmic_spline(value, g->spline.M1, g->spline.M2, g->spline.M3, g->spline.M4, g->spline.M5,
g->spline.latitude_min, g->spline.latitude_max, g->spline.type);
// curve is drawn in orange when above maximum
// or below minimum.
// we use a small margin in the comparison
// to avoid drawing curve in orange when it
// is right above or right below the limit
// due to floating point errors
const float margin = 1E-5;
if(y > g->spline.y[4] + margin)
{
y = fminf(y, 1.0f);
cairo_set_source_rgb(cr, 0.75, .5, 0.);
}
else if(y < g->spline.y[0] - margin)
{
y = fmaxf(y, 0.f);
cairo_set_source_rgb(cr, 0.75, .5, 0.);
}
else
{
set_color(cr, darktable.bauhaus->graph_fg);
}
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE)
y = powf(y, p->output_power);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
y = dt_log_scale_axis(powf(y, p->output_power), LOGBASE);
cairo_line_to(cr, x * g->graph_width, g->graph_height * (1.0 - y));
cairo_stroke(cr);
cairo_move_to(cr, x * g->graph_width, g->graph_height * (1.0 - y));
}
cairo_restore(cr);
// draw nodes
// special case for the grey node
cairo_save(cr);
cairo_rectangle(cr, -DT_PIXEL_APPLY_DPI(4.), -DT_PIXEL_APPLY_DPI(4.),
g->graph_width + 2. * DT_PIXEL_APPLY_DPI(4.), g->graph_height + 2. * DT_PIXEL_APPLY_DPI(4.));
cairo_clip(cr);
float x_grey = g->spline.x[2];
float y_grey = g->spline.y[2];
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE)
{
x_grey = exp_tonemapping_v2(x_grey, grey, p->black_point_source, DR);
y_grey = powf(y_grey, p->output_power);
}
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
{
x_grey = dt_log_scale_axis(exp_tonemapping_v2(x_grey, grey, p->black_point_source, DR), LOGBASE);
y_grey = dt_log_scale_axis(powf(y_grey, p->output_power), LOGBASE);
}
cairo_set_source_rgb(cr, 0.75, 0.5, 0.0);
cairo_arc(cr, x_grey * g->graph_width, (1.0 - y_grey) * g->graph_height, DT_PIXEL_APPLY_DPI(6), 0,
2. * M_PI);
cairo_fill(cr);
cairo_stroke(cr);
// latitude nodes
float x_black = 0.f;
float y_black = 0.f;
float x_white = 1.f;
float y_white = 1.f;
const float central_slope = (g->spline.y[3] - g->spline.y[1]) * g->graph_width / ((g->spline.x[3] - g->spline.x[1]) * g->graph_height);
const float central_slope_angle = atanf(central_slope) + M_PI_2f;
set_color(cr, darktable.bauhaus->graph_fg);
for(int k = 0; k < 5; k++)
{
if(k != 2) // k == 2 : grey point, already processed above
{
float x = g->spline.x[k];
float y = g->spline.y[k];
const float ymin = g->spline.y[0];
const float ymax = g->spline.y[4];
// we multiply SAFETY_MARGIN by 1.1f to avoid possible false negatives due to float errors
const float y_margin = SAFETY_MARGIN * 1.1f * (ymax - ymin);
gboolean red = (((k == 1) && (y - ymin <= y_margin))
|| ((k == 3) && (ymax - y <= y_margin)));
float start_angle = 0.0f;
float end_angle = DT_2PI_F;
// if contrast is clamped, show it on GUI with half circles
// for points 1 and 3
if(contrast_clamped)
{
if(k == 1)
{
start_angle = central_slope_angle + M_PI_F;
end_angle = central_slope_angle;
}
if(k == 3)
{
start_angle = central_slope_angle;
end_angle = start_angle + M_PI_F;
}
}
if(g->gui_mode == DT_FILMIC_GUI_BASECURVE)
{
x = exp_tonemapping_v2(x, grey, p->black_point_source, DR);
y = powf(y, p->output_power);
}
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
{
x = dt_log_scale_axis(exp_tonemapping_v2(x, grey, p->black_point_source, DR), LOGBASE);
y = dt_log_scale_axis(powf(y, p->output_power), LOGBASE);
}
// save the bounds of the curve to mark the axis graduation
if(k == 0) // black point
{
x_black = x;
y_black = y;
}
else if(k == 4) // white point
{
x_white = x;
y_white = y;
}
if(red) cairo_set_source_rgb(cr, 0.8, 0.35, 0.35);
// draw bullet
cairo_arc(cr, x * g->graph_width, (1.0 - y) * g->graph_height, DT_PIXEL_APPLY_DPI(4), start_angle, end_angle);
cairo_fill(cr);
cairo_stroke(cr);
// reset color for next points
if(red) set_color(cr, darktable.bauhaus->graph_fg);
}
}
cairo_restore(cr);
if(g->gui_show_labels)
{
// position of the upper bound of x axis labels
const float x_legend_top = g->graph_height + 0.5 * g->line_height;
// mark the y axis graduation at grey spot
set_color(cr, darktable.bauhaus->graph_fg);
snprintf(text, sizeof(text), "%.0f", p->grey_point_target);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, -2. * g->inset - g->ink.width - g->ink.x,
(1.0 - y_grey) * g->graph_height - 0.5 * g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// mark the x axis graduation at grey spot
set_color(cr, darktable.bauhaus->graph_fg);
if(g->gui_mode == DT_FILMIC_GUI_LOOK)
snprintf(text, sizeof(text), "%+.1f", 0.f);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE || g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
snprintf(text, sizeof(text), "%.0f", p->grey_point_source);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, x_grey * g->graph_width - 0.5 * g->ink.width - g->ink.x, x_legend_top);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// mark the y axis graduation at black spot
set_color(cr, darktable.bauhaus->graph_fg);
snprintf(text, sizeof(text), "%.0f", p->black_point_target);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, -2. * g->inset - g->ink.width - g->ink.x,
(1.0 - y_black) * g->graph_height - 0.5 * g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// mark the y axis graduation at black spot
set_color(cr, darktable.bauhaus->graph_fg);
snprintf(text, sizeof(text), "%.0f", p->white_point_target);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, -2. * g->inset - g->ink.width - g->ink.x,
(1.0 - y_white) * g->graph_height - 0.5 * g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// mark the x axis graduation at black spot
set_color(cr, darktable.bauhaus->graph_fg);
if(g->gui_mode == DT_FILMIC_GUI_LOOK)
snprintf(text, sizeof(text), "%+.1f", p->black_point_source);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE || g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
snprintf(text, sizeof(text), "%.0f", exp2f(p->black_point_source) * p->grey_point_source);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, x_black * g->graph_width - 0.5 * g->ink.width - g->ink.x, x_legend_top);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// mark the x axis graduation at white spot
set_color(cr, darktable.bauhaus->graph_fg);
if(g->gui_mode == DT_FILMIC_GUI_LOOK)
snprintf(text, sizeof(text), "%+.1f", p->white_point_source);
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE || g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
{
if(x_white > 1.f)
snprintf(text, sizeof(text), "%.0f →", 100.f); // this marks the bound of the graph, not the actual white
else
snprintf(text, sizeof(text), "%.0f", exp2f(p->white_point_source) * p->grey_point_source);
}
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr,
fminf(x_white, 1.f) * g->graph_width - 0.5 * g->ink.width - g->ink.x
+ 2. * (x_white > 1.f) * g->sign_width,
x_legend_top);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// handle the case where white > 100 %, so the node is out of the graph.
// we still want to display the value to get a hint.
set_color(cr, darktable.bauhaus->graph_fg);
if((g->gui_mode == DT_FILMIC_GUI_BASECURVE || g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG) && (x_white > 1.f))
{
// set to italic font
PangoStyle backup = pango_font_description_get_style(desc);
pango_font_description_set_style(desc, PANGO_STYLE_ITALIC);
pango_layout_set_font_description(layout, desc);
snprintf(text, sizeof(text), _("(%.0f %%)"), exp2f(p->white_point_source) * p->grey_point_source);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, g->allocation.width - g->ink.width - g->ink.x - margin_left,
g->graph_height + 3. * g->inset + g->line_height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// restore font
pango_font_description_set_style(desc, backup);
pango_layout_set_font_description(layout, desc);
}
// mark the y axis legend
set_color(cr, darktable.bauhaus->graph_fg);
/* xgettext:no-c-format */
g_strlcpy(text, _("% display"), sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, -2. * g->inset - g->zero_width - g->ink.x,
-g->line_height - g->inset - 0.5 * g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// mark the x axis legend
set_color(cr, darktable.bauhaus->graph_fg);
if(g->gui_mode == DT_FILMIC_GUI_LOOK)
g_strlcpy(text, _("EV scene"), sizeof(text));
else if(g->gui_mode == DT_FILMIC_GUI_BASECURVE || g->gui_mode == DT_FILMIC_GUI_BASECURVE_LOG)
{
/* xgettext:no-c-format */
g_strlcpy(text, _("% camera"), sizeof(text));
}
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, 0.5 * g->graph_width - 0.5 * g->ink.width - g->ink.x,
g->graph_height + 3. * g->inset + g->line_height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
}
}
else
{
// mode ranges
cairo_identity_matrix(cr); // reset coordinates
// draw the dynamic range of display
// if white = 100%, assume -11.69 EV because of uint8 output + sRGB OETF.
// for uint10 output, white should be set to 400%, so anything above 100% increases DR
// FIXME : if darktable becomes HDR-10bits compatible (for output), this needs to be updated
const float display_DR = 12.f + log2f(p->white_point_target / 100.f);
const float y_display = g->allocation.height / 3.f + g->line_height;
const float y_scene = 2. * g->allocation.height / 3.f + g->line_height;
const float display_top = y_display - g->line_height / 2;
const float display_bottom = display_top + g->line_height;
const float scene_top = y_scene - g->line_height / 2;
const float scene_bottom = scene_top + g->line_height;
float column_left;
if(g->gui_show_labels)
{
// labels
set_color(cr, darktable.bauhaus->graph_fg);
g_strlcpy(text, _("display"), sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, 0., y_display - 0.5 * g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
const float display_label_width = g->ink.width;
// axis legend
g_strlcpy(text, _("(%)"), sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, 0.5 * display_label_width - 0.5 * g->ink.width - g->ink.x,
display_top - 4. * g->inset - g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
set_color(cr, darktable.bauhaus->graph_fg);
g_strlcpy(text, _("scene"), sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, 0., y_scene - 0.5 * g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
const float scene_label_width = g->ink.width;
// axis legend
g_strlcpy(text, _("(EV)"), sizeof(text));
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, 0.5 * scene_label_width - 0.5 * g->ink.width - g->ink.x,
scene_bottom + 2. * g->inset + 0. * g->ink.height + g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// arrow between labels
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(1.));
dt_cairo_draw_arrow(cr, fminf(scene_label_width, display_label_width) / 2.f, y_scene - g->line_height,
fminf(scene_label_width, display_label_width) / 2.f,
y_display + g->line_height + g->inset, TRUE);
column_left = fmaxf(display_label_width, scene_label_width) + g->inset;
}
else
column_left = darktable.bauhaus->quad_width;
const float column_right = g->allocation.width - column_left - darktable.bauhaus->quad_width;
// compute dynamic ranges left and right to middle grey
const float display_HL_EV = -log2f(p->grey_point_target / p->white_point_target); // compared to white EV
const float display_LL_EV = display_DR - display_HL_EV; // compared to black EV
const float display_real_black_EV
= -fmaxf(log2f(p->black_point_target / p->grey_point_target),
-11.685887601778058f + display_HL_EV - log2f(p->white_point_target / 100.f));
const float scene_HL_EV = p->white_point_source; // compared to white EV
const float scene_LL_EV = -p->black_point_source; // compared to black EV
// compute the max width needed to fit both dynamic ranges and derivate the unit size of a GUI EV
const float max_DR = ceilf(fmaxf(display_HL_EV, scene_HL_EV)) + ceilf(fmaxf(display_LL_EV, scene_LL_EV));
const float EV = (column_right) / max_DR;
// all greys are aligned vertically in GUI since they are the fulcrum of the transform
// so, get their coordinates
const float grey_EV = fmaxf(ceilf(display_HL_EV), ceilf(scene_HL_EV));
const float grey_x = g->allocation.width - (grey_EV)*EV - darktable.bauhaus->quad_width;
// similarly, get black/white coordinates from grey point
const float display_black_x = grey_x - display_real_black_EV * EV;
const float display_DR_start_x = grey_x - display_LL_EV * EV;
const float display_white_x = grey_x + display_HL_EV * EV;
const float scene_black_x = grey_x - scene_LL_EV * EV;
const float scene_white_x = grey_x + scene_HL_EV * EV;
const float scene_lat_bottom = grey_x + (g->spline.x[1] - g->spline.x[2]) * EV * DR;
const float scene_lat_top = grey_x + (g->spline.x[3] - g->spline.x[2]) * EV * DR;
// show EV zones for display - zones are aligned on 0% and 100%
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(1.));
// latitude bounds - show contrast expansion
// Compute usual filmic mapping
float display_lat_bottom = filmic_spline(g->spline.latitude_min, g->spline.M1, g->spline.M2, g->spline.M3, g->spline.M4,
g->spline.M5, g->spline.latitude_min, g->spline.latitude_max, g->spline.type);
display_lat_bottom = powf(fmaxf(display_lat_bottom, NORM_MIN), p->output_power); // clamp at -16 EV
// rescale output to log scale
display_lat_bottom = log2f(display_lat_bottom/ (p->grey_point_target / 100.f));
// take clamping into account
if(display_lat_bottom < 0.f) // clamp to - 8 EV (black)
display_lat_bottom = fmaxf(display_lat_bottom, -display_real_black_EV);
else if(display_lat_bottom > 0.f) // clamp to 0 EV (white)
display_lat_bottom = fminf(display_lat_bottom, display_HL_EV);
// get destination coordinate
display_lat_bottom = grey_x + display_lat_bottom * EV;
// Compute usual filmic mapping
float display_lat_top = filmic_spline(g->spline.latitude_max, g->spline.M1, g->spline.M2, g->spline.M3, g->spline.M4,
g->spline.M5, g->spline.latitude_min, g->spline.latitude_max, g->spline.type);
display_lat_top = powf(fmaxf(display_lat_top, NORM_MIN), p->output_power); // clamp at -16 EV
// rescale output to log scale
display_lat_top = log2f(display_lat_top / (p->grey_point_target / 100.f));
// take clamping into account
if(display_lat_top < 0.f) // clamp to - 8 EV (black)
display_lat_top = fmaxf(display_lat_top, -display_real_black_EV);
else if(display_lat_top > 0.f) // clamp to 0 EV (white)
display_lat_top = fminf(display_lat_top, display_HL_EV);
// get destination coordinate and draw
display_lat_top = grey_x + display_lat_top * EV;
cairo_move_to(cr, scene_lat_bottom, scene_top);
cairo_line_to(cr, scene_lat_top, scene_top);
cairo_line_to(cr, display_lat_top, display_bottom);
cairo_line_to(cr, display_lat_bottom, display_bottom);
cairo_line_to(cr, scene_lat_bottom, scene_top);
set_color(cr, darktable.bauhaus->graph_bg);
cairo_fill(cr);
for(int i = 0; i < (int)ceilf(display_DR); i++)
{
// content
const float shade = powf(exp2f(-11.f + (float)i), 1.f / 2.4f);
cairo_set_source_rgb(cr, shade, shade, shade);
cairo_rectangle(cr, display_DR_start_x + i * EV, display_top, EV, g->line_height);
cairo_fill_preserve(cr);
// borders
cairo_set_source_rgb(cr, 0.75, .5, 0.);
cairo_stroke(cr);
}
// middle grey display
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(2.));
cairo_move_to(cr, grey_x, display_bottom + 2. * g->inset);
cairo_line_to(cr, grey_x, display_top - 2. * g->inset);
cairo_stroke(cr);
// show EV zones for scene - zones are aligned on grey
for(int i = floorf(p->black_point_source); i < ceilf(p->white_point_source); i++)
{
// content
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(1.));
const float shade = powf(0.1845f * exp2f((float)i), 1.f / 2.4f);
const float x_temp = grey_x + i * EV;
cairo_set_source_rgb(cr, shade, shade, shade);
cairo_rectangle(cr, x_temp, scene_top, EV, g->line_height);
cairo_fill_preserve(cr);
// borders
cairo_set_source_rgb(cr, 0.75, .5, 0.);
cairo_stroke(cr);
// arrows
if(i == 0)
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(2.));
else
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(1.));
if((float)i > p->black_point_source && (float)i < p->white_point_source)
{
// Compute usual filmic mapping
const float normal_value = ((float)i - p->black_point_source) / DR;
float y_temp = filmic_spline(normal_value, g->spline.M1, g->spline.M2, g->spline.M3, g->spline.M4,
g->spline.M5, g->spline.latitude_min, g->spline.latitude_max, g->spline.type);
y_temp = powf(fmaxf(y_temp, NORM_MIN), p->output_power); // clamp at -16 EV
// rescale output to log scale
y_temp = log2f(y_temp / (p->grey_point_target / 100.f));
// take clamping into account
if(y_temp < 0.f) // clamp to - 8 EV (black)
y_temp = fmaxf(y_temp, -display_real_black_EV);
else if(y_temp > 0.f) // clamp to 0 EV (white)
y_temp = fminf(y_temp, display_HL_EV);
// get destination coordinate and draw
y_temp = grey_x + y_temp * EV;
dt_cairo_draw_arrow(cr, x_temp, scene_top, y_temp, display_bottom, FALSE);
}
}
cairo_set_line_width(cr, DT_PIXEL_APPLY_DPI(2.));
// arrows for black and white
float x_temp = grey_x + p->black_point_source * EV;
float y_temp = grey_x - display_real_black_EV * EV;
dt_cairo_draw_arrow(cr, x_temp, scene_top, y_temp, display_bottom, FALSE);
x_temp = grey_x + p->white_point_source * EV;
y_temp = grey_x + display_HL_EV * EV;
dt_cairo_draw_arrow(cr, x_temp, scene_top, y_temp, display_bottom, FALSE);
// draw white - grey - black ticks
// black display
cairo_move_to(cr, display_black_x, display_bottom);
cairo_line_to(cr, display_black_x, display_top - 2. * g->inset);
cairo_stroke(cr);
// middle grey display
cairo_move_to(cr, grey_x, display_bottom);
cairo_line_to(cr, grey_x, display_top - 2. * g->inset);
cairo_stroke(cr);
// white display
cairo_move_to(cr, display_white_x, display_bottom);
cairo_line_to(cr, display_white_x, display_top - 2. * g->inset);
cairo_stroke(cr);
// black scene
cairo_move_to(cr, scene_black_x, scene_bottom + 2. * g->inset);
cairo_line_to(cr, scene_black_x, scene_top);
cairo_stroke(cr);
// middle grey scene
cairo_move_to(cr, grey_x, scene_bottom + 2. * g->inset);
cairo_line_to(cr, grey_x, scene_top);
cairo_stroke(cr);
// white scene
cairo_move_to(cr, scene_white_x, scene_bottom + 2. * g->inset);
cairo_line_to(cr, scene_white_x, scene_top);
cairo_stroke(cr);
// legends
set_color(cr, darktable.bauhaus->graph_fg);
// black scene legend
snprintf(text, sizeof(text), "%+.1f", p->black_point_source);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, scene_black_x - 0.5 * g->ink.width - g->ink.x,
scene_bottom + 2. * g->inset + 0. * g->ink.height + g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// grey scene legend
snprintf(text, sizeof(text), "%+.1f", 0.f);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, grey_x - 0.5 * g->ink.width - g->ink.x,
scene_bottom + 2. * g->inset + 0. * g->ink.height + g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// white scene legend
snprintf(text, sizeof(text), "%+.1f", p->white_point_source);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, scene_white_x - 0.5 * g->ink.width - g->ink.x,
scene_bottom + 2. * g->inset + 0. * g->ink.height + g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// black scene legend
snprintf(text, sizeof(text), "%.0f", p->black_point_target);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, display_black_x - 0.5 * g->ink.width - g->ink.x,
display_top - 4. * g->inset - g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// grey scene legend
snprintf(text, sizeof(text), "%.0f", p->grey_point_target);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, grey_x - 0.5 * g->ink.width - g->ink.x,
display_top - 4. * g->inset - g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
// white scene legend
snprintf(text, sizeof(text), "%.0f", p->white_point_target);
pango_layout_set_text(layout, text, -1);
pango_layout_get_pixel_extents(layout, &g->ink, NULL);
cairo_move_to(cr, display_white_x - 0.5 * g->ink.width - g->ink.x,
display_top - 4. * g->inset - g->ink.height - g->ink.y);
pango_cairo_show_layout(cr, layout);
cairo_stroke(cr);
}
// restore font size
pango_font_description_set_size(desc, font_size);
pango_layout_set_font_description(layout, desc);
cairo_destroy(cr);
cairo_set_source_surface(crf, cst, 0, 0);
cairo_paint(crf);
cairo_surface_destroy(cst);
g_object_unref(layout);
pango_font_description_free(desc);
return FALSE;
}
static void area_button_press(GtkGestureSingle *gesture, gint n_press, gdouble x, gdouble y, dt_iop_module_t *self)
{
DT_GUARD_GUI_UPDATE();
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
dt_iop_request_focus(self);
if(g->active_button == DT_FILMIC_GUI_BUTTON_LAST)
return;
const guint button = gtk_gesture_single_get_current_button(gesture);
if(button == GDK_BUTTON_PRIMARY && n_press >= 2)
{
// double click resets view
if(g->active_button == DT_FILMIC_GUI_BUTTON_TYPE)
{
g->gui_mode = DT_FILMIC_GUI_LOOK;
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_conf_set_int("plugins/darkroom/filmicrgb/graph_view", g->gui_mode);
return;
}
return;
}
if(button == GDK_BUTTON_PRIMARY)
{
// simple left click cycles through modes in positive direction
if(g->active_button == DT_FILMIC_GUI_BUTTON_TYPE)
{
// cycle type of graph
if(g->gui_mode == DT_FILMIC_GUI_RANGES)
g->gui_mode = DT_FILMIC_GUI_LOOK;
else
g->gui_mode++;
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_conf_set_int("plugins/darkroom/filmicrgb/graph_view", g->gui_mode);
return;
}
else if(g->active_button == DT_FILMIC_GUI_BUTTON_LABELS)
{
g->gui_show_labels = !g->gui_show_labels;
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_conf_set_int("plugins/darkroom/filmicrgb/graph_show_labels", g->gui_show_labels);
return;
}
return;
}
if(button == GDK_BUTTON_SECONDARY)
{
// simple right click cycles through modes in negative direction
if(g->active_button == DT_FILMIC_GUI_BUTTON_TYPE)
{
if(g->gui_mode == DT_FILMIC_GUI_LOOK)
g->gui_mode = DT_FILMIC_GUI_RANGES;
else
g->gui_mode--;
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_conf_set_int("plugins/darkroom/filmicrgb/graph_view", g->gui_mode);
return;
}
else if(g->active_button == DT_FILMIC_GUI_BUTTON_LABELS)
{
g->gui_show_labels = !g->gui_show_labels;
gtk_widget_queue_draw(GTK_WIDGET(g->area));
dt_conf_set_int("plugins/darkroom/filmicrgb/graph_show_labels", g->gui_show_labels);
return;
}
}
}
static void area_enter_notify(GtkEventControllerMotion *controller, gdouble x, gdouble y, dt_iop_module_t *self)
{
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
g->gui_hover = TRUE;
gtk_widget_queue_draw(GTK_WIDGET(g->area));
}
static void area_leave_notify(GtkEventControllerMotion *controller, dt_iop_module_t *self)
{
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
g->gui_hover = FALSE;
gtk_widget_queue_draw(GTK_WIDGET(g->area));
}
static void area_motion_notify(GtkEventControllerMotion *controller, gdouble x, gdouble y, dt_iop_module_t *self)
{
DT_GUARD_GUI_UPDATE();
dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
if(!g->gui_sizes_inited) return;
if(x > 0. && x < g->allocation.width && y > 0. && y < g->allocation.height) g->gui_hover = TRUE;
const gint save_active_button = g->active_button;
if(g->gui_hover)
{
// find out which button is under the mouse
gint found_something = FALSE;
for(int i = 0; i < DT_FILMIC_GUI_BUTTON_LAST; i++)
{
// check if mouse in in the button's bounds
if(x > g->buttons[i].left && x < g->buttons[i].right && y > g->buttons[i].top && y < g->buttons[i].bottom)
{
// yeah, mouse is over that button
g->buttons[i].mouse_hover = TRUE;
g->active_button = i;
found_something = TRUE;
}
else
{
// no luck with this button
g->buttons[i].mouse_hover = FALSE;
}
}
if(!found_something)
g->active_button = DT_FILMIC_GUI_BUTTON_LAST; // mouse is over no known button
// update the tooltips
if(g->active_button == DT_FILMIC_GUI_BUTTON_LAST && x < g->buttons[0].left)
{
// we are over the graph area
gtk_widget_set_tooltip_text(GTK_WIDGET(g->area),
_("use the parameters below to set the nodes.\n"
"the bright curve is the filmic tone mapping curve\n"
"the dark curve is the desaturation curve."));
}
else if(g->active_button == DT_FILMIC_GUI_BUTTON_LABELS)
{
gtk_widget_set_tooltip_text(GTK_WIDGET(g->area),
_("toggle axis labels and values display"));
}
else if(g->active_button == DT_FILMIC_GUI_BUTTON_TYPE)
{
gtk_widget_set_tooltip_text(GTK_WIDGET(g->area),
_("cycle through graph views.\n"
"left-click: cycle forward.\n"
"right-click: cycle backward.\n"
"double-click: reset to look view."));
}
else
{
gtk_widget_set_tooltip_text(GTK_WIDGET(g->area), "");
}
if(save_active_button != g->active_button) gtk_widget_queue_draw(GTK_WIDGET(g->area));
return;
}
else
{
g->active_button = DT_FILMIC_GUI_BUTTON_LAST;
if(save_active_button != g->active_button) gtk_widget_queue_draw(GTK_WIDGET(g->area));
}
}
void gui_init(dt_iop_module_t *self)
{
dt_iop_filmicrgb_gui_data_t *g = IOP_GUI_ALLOC(filmicrgb);
g->show_mask = FALSE;
g->gui_mode = DT_FILMIC_GUI_LOOK;
g->gui_show_labels = TRUE;
g->gui_hover = FALSE;
g->gui_sizes_inited = FALSE;
g->area = GTK_DRAWING_AREA(dt_ui_resize_wrap(NULL,
0,
"plugins/darkroom/filmicrgb/graphheight"));
g_object_set_data(G_OBJECT(g->area), "iop-instance", self);
dt_action_define_iop(self, NULL, N_("graph"), GTK_WIDGET(g->area), NULL);
gtk_widget_set_can_focus(GTK_WIDGET(g->area), TRUE);
g_signal_connect(G_OBJECT(g->area), "draw", G_CALLBACK(dt_iop_tonecurve_draw), self);
dt_gui_connect_click_all(g->area, area_button_press, NULL, self);
dt_gui_connect_motion(g->area, area_motion_notify, area_enter_notify, area_leave_notify, self);
// Init GTK notebook
static struct dt_action_def_t notebook_def = { };
g->notebook = dt_ui_notebook_new(¬ebook_def);
dt_action_define_iop(self, NULL, N_("page"), GTK_WIDGET(g->notebook), ¬ebook_def);
// Page SCENE
self->widget = dt_ui_notebook_page(g->notebook, N_("scene"), NULL);
g->grey_point_source
= dt_color_picker_new(self, DT_COLOR_PICKER_AREA | DT_COLOR_PICKER_DENOISE,
dt_bauhaus_slider_from_params(self, "grey_point_source"));
dt_bauhaus_slider_set_soft_range(g->grey_point_source, .1, 36.0);
dt_bauhaus_slider_set_format(g->grey_point_source, "%");
gtk_widget_set_tooltip_text(g->grey_point_source,
/* xgettext:no-c-format */
_("adjust to match the average luminance of the image's subject.\n"
"the value entered here will then be remapped to 18.45%.\n"
"decrease the value to increase the overall brightness."));
// White slider
g->white_point_source
= dt_color_picker_new(self, DT_COLOR_PICKER_AREA | DT_COLOR_PICKER_DENOISE,
dt_bauhaus_slider_from_params(self, "white_point_source"));
dt_bauhaus_slider_set_soft_range(g->white_point_source, 2.0, 8.0);
dt_bauhaus_slider_set_format(g->white_point_source, _(" EV"));
gtk_widget_set_tooltip_text(g->white_point_source,
_("number of stops between middle gray and pure white.\n"
"this is a reading a lightmeter would give you on the scene.\n"
"adjust so highlights clipping is avoided"));
// Black slider
g->black_point_source
= dt_color_picker_new(self, DT_COLOR_PICKER_AREA | DT_COLOR_PICKER_DENOISE,
dt_bauhaus_slider_from_params(self, "black_point_source"));
dt_bauhaus_slider_set_soft_range(g->black_point_source, -14.0, -3);
dt_bauhaus_slider_set_format(g->black_point_source, _(" EV"));
gtk_widget_set_tooltip_text(g->black_point_source,
_("number of stops between middle gray and pure black.\n"
"this is a reading a lightmeter would give you on the scene.\n"
"increase to get more contrast.\n"
"decrease to recover more details in low-lights."));
// Dynamic range scaling
g->security_factor = dt_bauhaus_slider_from_params(self, "security_factor");
dt_bauhaus_slider_set_soft_max(g->security_factor, 50);
dt_bauhaus_slider_set_format(g->security_factor, "%");
gtk_widget_set_tooltip_text(g->security_factor,
_("symmetrically increase or decrease the computed dynamic range.\n"
"useful to give a safety margin to extreme luminances."));
// Auto tune slider
g->auto_button = dt_color_picker_new(self, DT_COLOR_PICKER_AREA | DT_COLOR_PICKER_DENOISE,
dt_bauhaus_combobox_new(self));
dt_bauhaus_widget_set_label(g->auto_button, NULL, N_("auto tune levels"));
gtk_widget_set_tooltip_text(g->auto_button,
_("try to optimize the settings with some statistical assumptions.\n"
"this will fit the luminance range inside the histogram bounds.\n"
"works better for landscapes and evenly-lit images\n"
"but fails for high-keys, low-keys and high-ISO images.\n"
"this is not an artificial intelligence, but a simple guess.\n"
"ensure you understand its assumptions before using it."));
dt_gui_box_add(self->widget, g->auto_button);
// Page RECONSTRUCT
self->widget = dt_ui_notebook_page(g->notebook, N_("reconstruct"), NULL);
dt_gui_box_add(self->widget, dt_ui_section_label_new(C_("section", "highlights clipping")));
g->enable_highlight_reconstruction = dt_bauhaus_toggle_from_params(self, "enable_highlight_reconstruction");
g->reconstruct_threshold = dt_bauhaus_slider_from_params(self, "reconstruct_threshold");
dt_bauhaus_slider_set_format(g->reconstruct_threshold, _(" EV"));
gtk_widget_set_tooltip_text(g->reconstruct_threshold,
_("set the exposure threshold upon which\n"
"clipped highlights get reconstructed.\n"
"values are relative to the scene white point.\n"
"0 EV means the threshold is the same as the scene white point.\n"
"decrease to include more areas,\n"
"increase to exclude more areas."));
g->reconstruct_feather = dt_bauhaus_slider_from_params(self, "reconstruct_feather");
dt_bauhaus_slider_set_format(g->reconstruct_feather, _(" EV"));
gtk_widget_set_tooltip_text(g->reconstruct_feather,
_("soften the transition between clipped highlights and valid pixels.\n"
"decrease to make the transition harder and sharper,\n"
"increase to make the transition softer and blurrier."));
// Highlight Reconstruction Mask
GtkWidget *hbox = dt_gui_hbox(dt_ui_label_new(_("display highlight reconstruction mask")));
g->show_highlight_mask = dt_iop_togglebutton_new(self, NULL, N_("display highlight reconstruction mask"), NULL, G_CALLBACK(show_mask_callback),
FALSE, 0, 0, dtgtk_cairo_paint_showmask, hbox);
dtgtk_togglebutton_set_paint(DTGTK_TOGGLEBUTTON(g->show_highlight_mask), dtgtk_cairo_paint_showmask, 0, NULL);
dt_gui_add_class(g->show_highlight_mask, "dt_bauhaus_alignment");
dt_gui_add_class(g->show_highlight_mask, "dt_transparent_background");
dt_gui_box_add(self->widget, hbox, dt_ui_section_label_new(C_("section", "balance")));
g->reconstruct_structure_vs_texture = dt_bauhaus_slider_from_params(self, "reconstruct_structure_vs_texture");
dt_bauhaus_slider_set_format(g->reconstruct_structure_vs_texture, "%");
gtk_widget_set_tooltip_text(g->reconstruct_structure_vs_texture,
/* xgettext:no-c-format */
_("decide which reconstruction strategy to favor,\n"
"inpainting a smooth color gradient\n"
"or trying to recover the textured details.\n"
"0% is an equal mix of both.\n"
"increase if at least one RGB channel is not clipped.\n"
"decrease if all RGB channels are clipped over large areas."));
g->reconstruct_bloom_vs_details = dt_bauhaus_slider_from_params(self, "reconstruct_bloom_vs_details");
dt_bauhaus_slider_set_format(g->reconstruct_bloom_vs_details, "%");
gtk_widget_set_tooltip_text(g->reconstruct_bloom_vs_details,
/* xgettext:no-c-format */
_("decide which reconstruction strategy to favor,\n"
"blooming highlights like film does\n"
"or trying to recover sharp details.\n"
"0% is an equal mix of both.\n"
"increase if you want more details.\n"
"decrease if you want more blur."));
// Bloom threshold
g->reconstruct_grey_vs_color = dt_bauhaus_slider_from_params(self, "reconstruct_grey_vs_color");
dt_bauhaus_slider_set_format(g->reconstruct_grey_vs_color, "%");
gtk_widget_set_tooltip_text(g->reconstruct_grey_vs_color,
/* xgettext:no-c-format */
_("decide which reconstruction strategy to favor,\n"
"recovering monochromatic highlights\n"
"or trying to recover colorful highlights.\n"
"0% is an equal mix of both.\n"
"increase if you want more color.\n"
"decrease if you see magenta or out-of-gamut highlights."));
// Page LOOK
self->widget = dt_ui_notebook_page(g->notebook, N_("look"), NULL);
g->contrast = dt_bauhaus_slider_from_params(self, N_("contrast"));
dt_bauhaus_slider_set_soft_range(g->contrast, 0.5, 3.0);
dt_bauhaus_slider_set_digits(g->contrast, 3);
gtk_widget_set_tooltip_text(g->contrast,
_("slope of the linear part of the curve\n"
"affects mostly the mid-tones"));
// brightness slider
g->output_power = dt_bauhaus_slider_from_params(self, "output_power");
gtk_widget_set_tooltip_text(g->output_power,
_("equivalent to paper grade in analog.\n"
"increase to make highlights brighter and less compressed.\n"
"decrease to mute highlights."));
g->latitude = dt_bauhaus_slider_from_params(self, "latitude");
dt_bauhaus_slider_set_soft_range(g->latitude, 0.1, 90.0);
dt_bauhaus_slider_set_format(g->latitude, "%");
gtk_widget_set_tooltip_text(g->latitude,
_("width of the linear domain in the middle of the curve,\n"
"increase to get more contrast and less desaturation at extreme luminances,\n"
"decrease otherwise. no desaturation happens in the latitude range.\n"
"this has no effect on mid-tones."));
g->balance = dt_bauhaus_slider_from_params(self, "balance");
dt_bauhaus_slider_set_format(g->balance, "%");
gtk_widget_set_tooltip_text(g->balance,
_("slides the latitude along the slope\n"
"to give more room to shadows or highlights.\n"
"use it if you need to protect the details\n"
"at one extremity of the histogram."));
g->saturation = dt_bauhaus_slider_from_params(self, "saturation");
dt_bauhaus_slider_set_soft_range(g->saturation, -50.0, 50.0);
dt_bauhaus_slider_set_format(g->saturation, "%");
gtk_widget_set_tooltip_text(g->saturation,
_("desaturates the output of the module\n"
"specifically at extreme luminances.\n"
"increase if shadows and/or highlights are under-saturated."));
// Page DISPLAY
self->widget = dt_ui_notebook_page(g->notebook, N_("display"), NULL);
// Black slider
g->black_point_target = dt_bauhaus_slider_from_params(self, "black_point_target");
dt_bauhaus_slider_set_digits(g->black_point_target, 4);
dt_bauhaus_slider_set_format(g->black_point_target, "%");
gtk_widget_set_tooltip_text(g->black_point_target,
_("luminance of output pure black, this should be 0%\n"
"except if you want a faded look"));
g->grey_point_target = dt_bauhaus_slider_from_params(self, "grey_point_target");
dt_bauhaus_slider_set_digits(g->grey_point_target, 4);
dt_bauhaus_slider_set_format(g->grey_point_target, "%");
gtk_widget_set_tooltip_text(g->grey_point_target,
_("middle gray value of the target display or color space.\n"
"you should never touch that unless you know what you are doing."));
g->white_point_target = dt_bauhaus_slider_from_params(self, "white_point_target");
dt_bauhaus_slider_set_soft_max(g->white_point_target, 100.0);
dt_bauhaus_slider_set_digits(g->white_point_target, 4);
dt_bauhaus_slider_set_format(g->white_point_target, "%");
gtk_widget_set_tooltip_text(g->white_point_target,
_("luminance of output pure white, this should be 100%\n"
"except if you want a faded look"));
// Page OPTIONS
self->widget = dt_ui_notebook_page(g->notebook, N_("options"), NULL);
// Color science
g->version = dt_bauhaus_combobox_from_params(self, "version");
gtk_widget_set_tooltip_text(g->version,
_("v3 is darktable 3.0 desaturation method, same as color balance.\n"
"v4 is a newer desaturation method, based on spectral purity of light."));
g->preserve_color = dt_bauhaus_combobox_from_params(self, "preserve_color");
gtk_widget_set_tooltip_text(g->preserve_color,
_("ensure the original colors are preserved.\n"
"may reinforce chromatic aberrations and chroma noise,\n"
"so ensure they are properly corrected elsewhere."));
// hide legacy Euclidean norm by default
const int pos = dt_bauhaus_combobox_get_from_value(g->preserve_color, DT_FILMIC_METHOD_EUCLIDEAN_NORM_V1);
dt_bauhaus_combobox_remove_at(g->preserve_color, pos);
// Curve type
g->highlights = dt_bauhaus_combobox_from_params(self, "highlights");
gtk_widget_set_tooltip_text(g->highlights,
_("choose the desired curvature of the filmic spline in highlights.\n"
"hard uses a high curvature resulting in more tonal compression.\n"
"soft uses a low curvature resulting in less tonal compression."));
g->shadows = dt_bauhaus_combobox_from_params(self, "shadows");
gtk_widget_set_tooltip_text(g->shadows,
_("choose the desired curvature of the filmic spline in shadows.\n"
"hard uses a high curvature resulting in more tonal compression.\n"
"soft uses a low curvature resulting in less tonal compression."));
g->custom_grey = dt_bauhaus_toggle_from_params(self, "custom_grey");
gtk_widget_set_tooltip_text(g->custom_grey,
/* xgettext:no-c-format */
_("enable to input custom middle-gray values.\n"
"this is not recommended in general.\n"
"fix the global exposure in the exposure module instead.\n"
"disable to use standard 18.45% middle gray."));
g->auto_hardness = dt_bauhaus_toggle_from_params(self, "auto_hardness");
gtk_widget_set_tooltip_text(
g->auto_hardness, _("enable to auto-set the look hardness depending on the scene white and black points.\n"
"this keeps the middle gray on the identity line and improves fast tuning.\n"
"disable if you want a manual control."));
g->high_quality_reconstruction = dt_bauhaus_slider_from_params(self, "high_quality_reconstruction");
gtk_widget_set_tooltip_text(g->high_quality_reconstruction,
_("run extra passes of chromaticity reconstruction.\n"
"more iterations means more color propagation from neighborhood.\n"
"this will be slower but will yield more neutral highlights.\n"
"it also helps with difficult cases of magenta highlights."));
// Highlight noise
g->noise_level = dt_bauhaus_slider_from_params(self, "noise_level");
gtk_widget_set_tooltip_text(g->noise_level,
_("add statistical noise in reconstructed highlights.\n"
"this avoids highlights to look too smooth\n"
"when the image is noisy overall,\n"
"so they blend with the rest of the image."));
// Noise distribution
g->noise_distribution = dt_bauhaus_combobox_from_params(self, "noise_distribution");
gtk_widget_set_tooltip_text(g->noise_distribution,
_("choose the statistical distribution of noise.\n"
"this is useful to match natural sensor noise pattern."));
// start building top level widget
self->widget = dt_gui_vbox(g->area, g->notebook);
}
void gui_changed(dt_iop_module_t *self, GtkWidget *w, void *previous)
{
dt_iop_filmicrgb_params_t *p = self->params;
const dt_iop_filmicrgb_gui_data_t *g = self->gui_data;
if(!w || w == g->auto_hardness || w == g->security_factor || w == g->grey_point_source
|| w == g->black_point_source || w == g->white_point_source)
{
DT_ENTER_GUI_UPDATE();
if(w == g->security_factor || w == g->grey_point_source)
{
const float prev = *(float *)previous;
if(w == g->security_factor)
{
const float ratio = (p->security_factor - prev) / (prev + 100.0f);
float EVmin = p->black_point_source;
EVmin = EVmin + ratio * EVmin;
float EVmax = p->white_point_source;
EVmax = EVmax + ratio * EVmax;
p->white_point_source = EVmax;
p->black_point_source = EVmin;
}
else
{
const float grey_var = log2f(prev / p->grey_point_source);
p->black_point_source = p->black_point_source - grey_var;
p->white_point_source = p->white_point_source + grey_var;
}
dt_bauhaus_slider_set(g->white_point_source, p->white_point_source);
dt_bauhaus_slider_set(g->black_point_source, p->black_point_source);
}
if(p->auto_hardness)
_compute_output_power(self, p);
gtk_widget_set_visible(GTK_WIDGET(g->output_power), !p->auto_hardness);
dt_bauhaus_slider_set(g->output_power, p->output_power);
DT_LEAVE_GUI_UPDATE();
}
if(!w || w == g->version)
{
if(p->version == DT_FILMIC_COLORSCIENCE_V1 || p->version == DT_FILMIC_COLORSCIENCE_V4)
{
dt_bauhaus_widget_set_label(g->saturation, NULL, N_("extreme luminance saturation"));
gtk_widget_set_tooltip_text(g->saturation,
_("desaturates the output of the module\n"
"specifically at extreme luminances.\n"
"increase if shadows and/or highlights are under-saturated."));
}
else if(p->version == DT_FILMIC_COLORSCIENCE_V2 || p->version == DT_FILMIC_COLORSCIENCE_V3)
{
dt_bauhaus_widget_set_label(g->saturation, NULL, N_("mid-tones saturation"));
gtk_widget_set_tooltip_text(g->saturation,
_("desaturates the output of the module\n"
"specifically at medium luminances.\n"
"increase if midtones are under-saturated."));
}
else if(p->version == DT_FILMIC_COLORSCIENCE_V5)
{
dt_bauhaus_widget_set_label(g->saturation, NULL, N_("highlights saturation mix"));
gtk_widget_set_tooltip_text(g->saturation,
_("positive values ensure saturation is kept unchanged over the whole range.\n"
"negative values bleach highlights at constant hue and luminance.\n"
"zero is an equal mix of both strategies."));
gtk_widget_set_visible(GTK_WIDGET(g->preserve_color), FALSE);
}
if(p->version != DT_FILMIC_COLORSCIENCE_V5)
gtk_widget_set_visible(GTK_WIDGET(g->preserve_color), TRUE);
}
if(w == g->reconstruct_threshold || w == g->reconstruct_feather)
{
// Sliding threshold or feather sliders enables the highlight reconstruction
gtk_widget_set_sensitive(g->reconstruct_bloom_vs_details, TRUE);
gtk_widget_set_sensitive(g->reconstruct_grey_vs_color, TRUE);
gtk_widget_set_sensitive(g->reconstruct_structure_vs_texture, TRUE);
DT_ENTER_GUI_UPDATE();
dt_bauhaus_toggle_set(g->enable_highlight_reconstruction, TRUE);
p->enable_highlight_reconstruction = TRUE;
DT_LEAVE_GUI_UPDATE();
}
if(!w || w == g->enable_highlight_reconstruction)
{
gtk_widget_set_sensitive(g->reconstruct_bloom_vs_details, p->enable_highlight_reconstruction);
gtk_widget_set_sensitive(g->reconstruct_grey_vs_color, p->enable_highlight_reconstruction);
gtk_widget_set_sensitive(g->reconstruct_structure_vs_texture, p->enable_highlight_reconstruction);
}
if(!w || w == g->reconstruct_bloom_vs_details)
{
if(p->reconstruct_bloom_vs_details == -100.f)
{
// user disabled the reconstruction in favor of full blooming
// so the structure vs. texture setting doesn't make any difference
// make it insensitive to not confuse users
gtk_widget_set_sensitive(g->reconstruct_structure_vs_texture, FALSE);
}
else
{
gtk_widget_set_sensitive(g->reconstruct_structure_vs_texture, p->enable_highlight_reconstruction);
}
}
if(!w || w == g->custom_grey)
{
gtk_widget_set_visible(g->grey_point_source, p->custom_grey);
gtk_widget_set_visible(g->grey_point_target, p->custom_grey);
}
gtk_widget_queue_draw(GTK_WIDGET(g->area));
}
// 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