Part 2 of D1082 by Troy Sobotka, remove our functions that do luma
[blender.git] / source / blender / blenlib / BLI_math_color.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: some of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  * */
25
26 #ifndef __BLI_MATH_COLOR_H__
27 #define __BLI_MATH_COLOR_H__
28
29 /** \file BLI_math_color.h
30  *  \ingroup bli
31  */
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #include "BLI_math_inline.h"
38
39 /* primaries */
40 #define BLI_XYZ_SMPTE        0
41 #define BLI_XYZ_REC709_SRGB  1
42 #define BLI_XYZ_CIE          2
43
44 /* built-in profiles */
45 #define BLI_PR_NONE     0
46 #define BLI_PR_SRGB     1
47 #define BLI_PR_REC709   2
48
49 /* YCbCr */
50 #define BLI_YCC_ITU_BT601   0
51 #define BLI_YCC_ITU_BT709   1
52 #define BLI_YCC_JFIF_0_255  2
53
54 /******************* Conversion to RGB ********************/
55
56 void hsv_to_rgb(float h, float s, float v, float *r, float *g, float *b);
57 void hsv_to_rgb_v(const float hsv[3], float r_rgb[3]);
58 void hsl_to_rgb(float h, float c, float l, float *r, float *g, float *b);
59 void hsl_to_rgb_v(const float hcl[3], float r_rgb[3]);
60 void hex_to_rgb(char *hexcol, float *r, float *g, float *b);
61 void yuv_to_rgb(float y, float u, float v, float *lr, float *lg, float *lb);
62 void ycc_to_rgb(float y, float cb, float cr, float *lr, float *lg, float *lb, int colorspace);
63 void xyz_to_rgb(float x, float y, float z, float *r, float *g, float *b, 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);
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 void rgb_to_lab(float r, float g, float b, float *ll, float *la, float *lb);
79 void rgb_to_xyz(float r, float g, float b, float *x, float *y, float *z);
80 unsigned int rgb_to_cpack(float r, float g, float b);
81 unsigned int hsv_to_cpack(float h, float s, float v);
82
83 /**************** Profile Transformations *****************/
84
85 float srgb_to_linearrgb(float c);
86 float linearrgb_to_srgb(float c);
87
88 MINLINE void srgb_to_linearrgb_v3_v3(float linear[3], const float srgb[3]);
89 MINLINE void linearrgb_to_srgb_v3_v3(float srgb[3], const float linear[3]);
90
91 MINLINE void srgb_to_linearrgb_v4(float linear[4], const float srgb[4]);
92 MINLINE void linearrgb_to_srgb_v4(float srgb[4], const float linear[4]);
93
94 MINLINE void srgb_to_linearrgb_predivide_v4(float linear[4], const float srgb[4]);
95 MINLINE void linearrgb_to_srgb_predivide_v4(float srgb[4], const float linear[4]);
96
97 MINLINE unsigned short to_srgb_table_lookup(const float f);
98 MINLINE void linearrgb_to_srgb_ushort4(unsigned short srgb[4], const float linear[4]);
99 MINLINE void srgb_to_linearrgb_uchar4(float linear[4], const unsigned char srgb[4]);
100 MINLINE void srgb_to_linearrgb_uchar4_predivide(float linear[4], const unsigned char srgb[4]);
101
102 MINLINE void linearrgb_to_srgb_uchar3(unsigned char srgb[3], const float linear[3]);
103 MINLINE void linearrgb_to_srgb_uchar4(unsigned char srgb[4], const float linear[4]);
104
105 void BLI_init_srgb_conversion(void);
106
107 /**************** Alpha Transformations *****************/
108
109 MINLINE void premul_to_straight_v4_v4(float straight[4], const float premul[4]);
110 MINLINE void premul_to_straight_v4(float color[4]);
111 MINLINE void straight_to_premul_v4_v4(float straight[4], const float premul[4]);
112 MINLINE void straight_to_premul_v4(float color[4]);
113 MINLINE void straight_uchar_to_premul_float(float result[4], const unsigned char color[4]);
114 MINLINE void premul_float_to_straight_uchar(unsigned char *result, const float color[4]);
115
116 /************************** Other *************************/
117
118 int constrain_rgb(float *r, float *g, float *b);
119 void minmax_rgb(short c[3]);
120 void hsv_clamp_v(float hsv[3], float v_max);
121
122 void rgb_float_set_hue_float_offset(float *rgb, float hue_offset);
123 void rgb_byte_set_hue_float_offset(unsigned char *rgb, float hue_offset);
124
125 void rgb_uchar_to_float(float r_col[3], const unsigned char col_ub[3]);
126 void rgba_uchar_to_float(float r_col[4], const unsigned char col_ub[4]);
127 void rgb_float_to_uchar(unsigned char r_col[3], const float col_f[3]);
128 void rgba_float_to_uchar(unsigned char r_col[4], const float col_f[4]);
129
130 void xyz_to_lab(float x, float y, float z, float *l, float *a, float *b);
131
132 MINLINE int compare_rgb_uchar(const unsigned char a[3], const unsigned char b[3], const int limit);
133
134 MINLINE float dither_random_value(float s, float t);
135 MINLINE void float_to_byte_dither_v3(unsigned char b[3], const float f[3], float dither, float s, float t);
136
137
138 #define rgba_char_args_set_fl(col, r, g, b, a) \
139         rgba_char_args_set(col, (r) * 255, (g) * 255, (b) * 255, (a) * 255)
140
141 MINLINE void rgba_char_args_set(char col[4], const char r, const char g, const char b, const char a);
142 MINLINE void rgba_char_args_test_set(char col[4], const char r, const char g, const char b, const char a);
143 MINLINE void cpack_cpy_3ub(unsigned char r_col[3], const unsigned int pack);
144
145 /********* lift/gamma/gain / ASC-CDL conversion ***********/
146
147 void lift_gamma_gain_to_asc_cdl(float *lift, float *gamma, float *gain, float *offset, float *slope, float *power);
148
149 #if BLI_MATH_DO_INLINE
150 #include "intern/math_color_inline.c"
151 #endif
152
153 #ifdef __cplusplus
154 }
155 #endif
156
157 #endif /* __BLI_MATH_COLOR_H__ */
158