ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenlib / BLI_math_color.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  *
19  * The Original Code is: some of this file.
20  *
21  * */
22
23 #ifndef __BLI_MATH_COLOR_H__
24 #define __BLI_MATH_COLOR_H__
25
26 /** \file
27  * \ingroup bli
28  */
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #include "BLI_math_inline.h"
35
36 /* primaries */
37 #define BLI_XYZ_SMPTE 0
38 #define BLI_XYZ_REC709_SRGB 1
39 #define BLI_XYZ_CIE 2
40
41 /* built-in profiles */
42 #define BLI_PR_NONE 0
43 #define BLI_PR_SRGB 1
44 #define BLI_PR_REC709 2
45
46 /* YCbCr */
47 #define BLI_YCC_ITU_BT601 0
48 #define BLI_YCC_ITU_BT709 1
49 #define BLI_YCC_JFIF_0_255 2
50
51 /* YUV */
52 #define BLI_YUV_ITU_BT601 0
53 #define BLI_YUV_ITU_BT709 1
54
55 /******************* Conversion to RGB ********************/
56
57 void hsv_to_rgb(float h, float s, float v, float *r, float *g, float *b);
58 void hsv_to_rgb_v(const float hsv[3], float r_rgb[3]);
59 void hsl_to_rgb(float h, float c, float l, float *r, float *g, float *b);
60 void hsl_to_rgb_v(const float hcl[3], float r_rgb[3]);
61 void hex_to_rgb(char *hexcol, float *r, float *g, float *b);
62 void yuv_to_rgb(float y, float u, float v, float *lr, float *lg, float *lb, int colorspace);
63 void ycc_to_rgb(float y, float cb, float cr, float *lr, float *lg, float *lb, int colorspace);
64 void cpack_to_rgb(unsigned int col, float *r, float *g, float *b);
65
66 /***************** Conversion from RGB ********************/
67
68 void rgb_to_yuv(float r, float g, float b, float *ly, float *lu, float *lv, int colorspace);
69 void rgb_to_ycc(float r, float g, float b, float *ly, float *lcb, float *lcr, int colorspace);
70 void rgb_to_hsv(float r, float g, float b, float *lh, float *ls, float *lv);
71 void rgb_to_hsv_v(const float rgb[3], float r_hsv[3]);
72 void rgb_to_hsl(float r, float g, float b, float *lh, float *ls, float *ll);
73 void rgb_to_hsl_v(const float rgb[3], float r_hsl[3]);
74 void rgb_to_hsl_compat(float r, float g, float b, float *lh, float *ls, float *ll);
75 void rgb_to_hsl_compat_v(const float rgb[3], float r_hsl[3]);
76 void rgb_to_hsv_compat(float r, float g, float b, float *lh, float *ls, float *lv);
77 void rgb_to_hsv_compat_v(const float rgb[3], float r_hsv[3]);
78 unsigned int rgb_to_cpack(float r, float g, float b);
79 unsigned int hsv_to_cpack(float h, float s, float v);
80
81 /**************** Profile Transformations *****************/
82
83 float srgb_to_linearrgb(float c);
84 float linearrgb_to_srgb(float c);
85
86 MINLINE void srgb_to_linearrgb_v3_v3(float linear[3], const float srgb[3]);
87 MINLINE void linearrgb_to_srgb_v3_v3(float srgb[3], const float linear[3]);
88
89 MINLINE void srgb_to_linearrgb_v4(float linear[4], const float srgb[4]);
90 MINLINE void linearrgb_to_srgb_v4(float srgb[4], const float linear[4]);
91
92 MINLINE void srgb_to_linearrgb_predivide_v4(float linear[4], const float srgb[4]);
93 MINLINE void linearrgb_to_srgb_predivide_v4(float srgb[4], const float linear[4]);
94
95 MINLINE unsigned short to_srgb_table_lookup(const float f);
96 MINLINE void linearrgb_to_srgb_ushort4(unsigned short srgb[4], const float linear[4]);
97 MINLINE void srgb_to_linearrgb_uchar4(float linear[4], const unsigned char srgb[4]);
98 MINLINE void srgb_to_linearrgb_uchar4_predivide(float linear[4], const unsigned char srgb[4]);
99
100 MINLINE void linearrgb_to_srgb_uchar3(unsigned char srgb[3], const float linear[3]);
101 MINLINE void linearrgb_to_srgb_uchar4(unsigned char srgb[4], const float linear[4]);
102
103 void BLI_init_srgb_conversion(void);
104
105 /**************** Alpha Transformations *****************/
106
107 MINLINE void premul_to_straight_v4_v4(float straight[4], const float premul[4]);
108 MINLINE void premul_to_straight_v4(float color[4]);
109 MINLINE void straight_to_premul_v4_v4(float premul[4], const float straight[4]);
110 MINLINE void straight_to_premul_v4(float color[4]);
111 MINLINE void straight_uchar_to_premul_float(float result[4], const unsigned char color[4]);
112 MINLINE void premul_float_to_straight_uchar(unsigned char *result, const float color[4]);
113
114 /************************** Other *************************/
115
116 int constrain_rgb(float *r, float *g, float *b);
117 void minmax_rgb(short c[3]);
118 void hsv_clamp_v(float hsv[3], float v_max);
119
120 void rgb_float_set_hue_float_offset(float *rgb, float hue_offset);
121 void rgb_byte_set_hue_float_offset(unsigned char *rgb, float hue_offset);
122
123 void rgb_uchar_to_float(float r_col[3], const unsigned char col_ub[3]);
124 void rgba_uchar_to_float(float r_col[4], const unsigned char col_ub[4]);
125 void rgb_float_to_uchar(unsigned char r_col[3], const float col_f[3]);
126 void rgba_float_to_uchar(unsigned char r_col[4], const float col_f[4]);
127
128 MINLINE float rgb_to_grayscale(const float rgb[3]);
129 MINLINE unsigned char rgb_to_grayscale_byte(const unsigned char rgb[3]);
130
131 MINLINE int compare_rgb_uchar(const unsigned char a[3], const unsigned char b[3], const int limit);
132
133 MINLINE float dither_random_value(float s, float t);
134 MINLINE void float_to_byte_dither_v3(
135     unsigned char b[3], const float f[3], float dither, float s, float t);
136
137 #define rgba_char_args_set_fl(col, r, g, b, a) \
138   rgba_char_args_set(col, (r)*255, (g)*255, (b)*255, (a)*255)
139
140 #define rgba_float_args_set_ch(col, r, g, b, a) \
141   rgba_float_args_set(col, (r) / 255.0f, (g) / 255.0f, (b) / 255.0f, (a) / 255.0f)
142
143 MINLINE void rgba_char_args_set(
144     char col[4], const char r, const char g, const char b, const char a);
145 MINLINE void rgba_float_args_set(
146     float col[4], const float r, const float g, const float b, const float a);
147 MINLINE void rgba_char_args_test_set(
148     char col[4], const char r, const char g, const char b, const char a);
149 MINLINE void cpack_cpy_3ub(unsigned char r_col[3], const unsigned int pack);
150
151 void blackbody_temperature_to_rgb_table(float *r_table, int width, float min, float max);
152
153 /********* lift/gamma/gain / ASC-CDL conversion ***********/
154
155 void lift_gamma_gain_to_asc_cdl(
156     float *lift, float *gamma, float *gain, float *offset, float *slope, float *power);
157
158 #if BLI_MATH_DO_INLINE
159 #  include "intern/math_color_inline.c"
160 #endif
161
162 #ifdef __cplusplus
163 }
164 #endif
165
166 #endif /* __BLI_MATH_COLOR_H__ */