unify include guard defines, __$FILENAME__
[blender-staging.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 hex_to_rgb(char *hexcol, float *r, float *g, float *b);
58 void yuv_to_rgb(float y, float u, float v, float *lr, float *lg, float *lb);
59 void ycc_to_rgb(float y, float cb, float cr, float *lr, float *lg, float *lb, int colorspace);
60 void xyz_to_rgb(float x, float y, float z, float *r, float *g, float *b, int colorspace);
61 void cpack_to_rgb(unsigned int col, float *r, float *g, float *b);
62
63 /***************** Conversion from RGB ********************/
64
65 void rgb_to_yuv(float r, float g, float b, float *ly, float *lu, float *lv);
66 void rgb_to_ycc(float r, float g, float b, float *ly, float *lcb, float *lcr, int colorspace);
67 void rgb_to_hsv(float r, float g, float b, float *lh, float *ls, float *lv);
68 void rgb_to_hsv_compat(float r, float g, float b, float *lh, float *ls, float *lv);
69 unsigned int rgb_to_cpack(float r, float g, float b);
70 unsigned int hsv_to_cpack(float h, float s, float v);
71
72 float rgb_to_grayscale(const float rgb[3]);
73 unsigned char rgb_to_grayscale_byte(const unsigned char rgb[3]);
74 float rgb_to_luma(const float rgb[3]);
75 unsigned char rgb_to_luma_byte(const unsigned char rgb[3]);
76
77 /**************** Profile Transformations *****************/
78
79 void gamma_correct(float *c, float gamma);
80 float rec709_to_linearrgb(float c);
81 float linearrgb_to_rec709(float c);
82 float srgb_to_linearrgb(float c);
83 float linearrgb_to_srgb(float c);
84
85 MINLINE void srgb_to_linearrgb_v3_v3(float linear[3], const float srgb[3]);
86 MINLINE void linearrgb_to_srgb_v3_v3(float srgb[3], const float linear[3]);
87
88 MINLINE void srgb_to_linearrgb_v4(float linear[4], const float srgb[4]);
89 MINLINE void linearrgb_to_srgb_v4(float srgb[4], const float linear[4]);
90
91 MINLINE void srgb_to_linearrgb_predivide_v4(float linear[4], const float srgb[4]);
92 MINLINE void linearrgb_to_srgb_predivide_v4(float srgb[4], const float linear[4]);
93
94 MINLINE void linearrgb_to_srgb_uchar3(unsigned char srgb[3], const float linear[3]);
95 MINLINE void linearrgb_to_srgb_uchar4(unsigned char srgb[4], const float linear[4]);
96
97 void BLI_init_srgb_conversion(void);
98
99 /************************** Other *************************/
100
101 int constrain_rgb(float *r, float *g, float *b);
102 void minmax_rgb(short c[3]);
103
104 void rgb_float_set_hue_float_offset(float * rgb, float hue_offset);
105 void rgb_byte_set_hue_float_offset(unsigned char * rgb, float hue_offset);
106
107 void rgb_uchar_to_float(float col_r[3], const unsigned char col_ub[3]);
108 void rgba_uchar_to_float(float col_r[4], const unsigned char col_ub[4]);
109 void rgb_float_to_uchar(unsigned char col_r[3], const float col_f[3]);
110 void rgba_float_to_uchar(unsigned char col_r[4], const float col_f[4]);
111
112 /***************** lift/gamma/gain / ASC-CDL conversion *****************/
113
114 void lift_gamma_gain_to_asc_cdl(float *lift, float *gamma, float *gain, float *offset, float *slope, float *power);
115
116 #ifdef __BLI_MATH_INLINE_H__
117 #include "intern/math_color_inline.c"
118 #endif
119
120 #ifdef __cplusplus
121 }
122 #endif
123
124 #endif /* __BLI_MATH_COLOR_H__ */
125