Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_colortools.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL/BL DUAL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_COLORTOOLS_H__
28 #define __BKE_COLORTOOLS_H__
29
30 /** \file BKE_colortools.h
31  *  \ingroup bke
32  */
33
34 struct ColorManagedColorspaceSettings;
35 struct ColorManagedDisplaySettings;
36 struct ColorManagedViewSettings;
37 struct CurveMapping;
38 struct CurveMap;
39 struct CurveMapPoint;
40 struct Scopes;
41 struct Histogram;
42 struct ImBuf;
43 struct rctf;
44
45 void                curvemapping_set_defaults(struct CurveMapping *cumap, int tot, float minx, float miny, float maxx, float maxy);
46 struct CurveMapping *curvemapping_add(int tot, float minx, float miny, float maxx, float maxy);
47 void                curvemapping_free_data(struct CurveMapping *cumap);
48 void                curvemapping_free(struct CurveMapping *cumap);
49 void                curvemapping_copy_data(struct CurveMapping *target, const struct CurveMapping *cumap);
50 struct CurveMapping *curvemapping_copy(const struct CurveMapping *cumap);
51 void                curvemapping_set_black_white_ex(const float black[3], const float white[3], float r_bwmul[3]);
52 void                curvemapping_set_black_white(struct CurveMapping *cumap, const float black[3], const float white[3]);
53
54 enum {
55         CURVEMAP_SLOPE_NEGATIVE   = 0,
56         CURVEMAP_SLOPE_POSITIVE   = 1,
57         CURVEMAP_SLOPE_POS_NEG    = 2,
58 };
59
60 void                    curvemap_reset(struct CurveMap *cuma, const struct rctf *clipr, int preset, int slope);
61 void                    curvemap_remove(struct CurveMap *cuma, const short flag);
62 bool                    curvemap_remove_point(struct CurveMap *cuma, struct CurveMapPoint *cmp);
63 struct CurveMapPoint   *curvemap_insert(struct CurveMap *cuma, float x, float y);
64 void                    curvemap_handle_set(struct CurveMap *cuma, int type);
65
66 void                curvemapping_changed(struct CurveMapping *cumap, const bool rem_doubles);
67 void                curvemapping_changed_all(struct CurveMapping *cumap);
68
69 /* call before _all_ evaluation functions */
70 void                curvemapping_initialize(struct CurveMapping *cumap);
71
72 /* keep these (const CurveMap) - to help with thread safety */
73 /* single curve, no table check */
74 float               curvemap_evaluateF(const struct CurveMap *cuma, float value);
75 /* single curve, with table check */
76 float               curvemapping_evaluateF(const struct CurveMapping *cumap, int cur, float value);
77 void                curvemapping_evaluate3F(const struct CurveMapping *cumap, float vecout[3], const float vecin[3]);
78 void                curvemapping_evaluateRGBF(const struct CurveMapping *cumap, float vecout[3], const float vecin[3]);
79 void                curvemapping_evaluate_premulRGB(const struct CurveMapping *cumap, unsigned char vecout_byte[3], const unsigned char vecin_byte[3]);
80 void                curvemapping_evaluate_premulRGBF_ex(const struct CurveMapping *cumap, float vecout[3], const float vecin[3],
81                                                         const float black[3], const float bwmul[3]);
82 void                curvemapping_evaluate_premulRGBF(const struct CurveMapping *cumap, float vecout[3], const float vecin[3]);
83 int                 curvemapping_RGBA_does_something(const struct CurveMapping *cumap);
84 void                curvemapping_table_RGBA(const struct CurveMapping *cumap, float **array, int *size);
85
86 /* non-const, these modify the curve */
87 void                curvemapping_premultiply(struct CurveMapping *cumap, int restore);
88
89
90 void                BKE_histogram_update_sample_line(struct Histogram *hist, struct ImBuf *ibuf,
91                                                      const struct ColorManagedViewSettings *view_settings,
92                                                      const struct ColorManagedDisplaySettings *display_settings);
93 void                scopes_update(struct Scopes *scopes, struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
94                                   const struct ColorManagedDisplaySettings *display_settings);
95 void                scopes_free(struct Scopes *scopes);
96 void                scopes_new(struct Scopes *scopes);
97
98 void BKE_color_managed_display_settings_init(struct ColorManagedDisplaySettings *settings);
99 void BKE_color_managed_display_settings_copy(struct ColorManagedDisplaySettings *new_settings,
100                                              const struct ColorManagedDisplaySettings *settings);
101
102 void BKE_color_managed_view_settings_init(struct ColorManagedViewSettings *settings);
103 void BKE_color_managed_view_settings_copy(struct ColorManagedViewSettings *new_settings,
104                                           const struct ColorManagedViewSettings *settings);
105 void BKE_color_managed_view_settings_free(struct ColorManagedViewSettings *settings);
106
107 void BKE_color_managed_colorspace_settings_init(struct ColorManagedColorspaceSettings *colorspace_settings);
108 void BKE_color_managed_colorspace_settings_copy(struct ColorManagedColorspaceSettings *colorspace_settings,
109                                                 const struct ColorManagedColorspaceSettings *settings);
110 bool BKE_color_managed_colorspace_settings_equals(const struct ColorManagedColorspaceSettings *settings1,
111                                                   const struct ColorManagedColorspaceSettings *settings2);
112 #endif