ClangFormat: apply to source, most of intern
[blender.git] / intern / opencolorio / ocio_capi.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) 2012 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __OCIO_CAPI_H__
21 #define __OCIO_CAPI_H__
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 struct OCIO_GLSLDrawState;
28
29 #define OCIO_DECLARE_HANDLE(name) \
30   typedef struct name##__ { \
31     int unused; \
32   } * name
33
34 #define OCIO_ROLE_SCENE_LINEAR "scene_linear"
35 #define OCIO_ROLE_COLOR_PICKING "color_picking"
36 #define OCIO_ROLE_TEXTURE_PAINT "texture_paint"
37 #define OCIO_ROLE_DEFAULT_BYTE "default_byte"
38 #define OCIO_ROLE_DEFAULT_FLOAT "default_float"
39 #define OCIO_ROLE_DEFAULT_SEQUENCER "default_sequencer"
40
41 OCIO_DECLARE_HANDLE(OCIO_ConstConfigRcPtr);
42 OCIO_DECLARE_HANDLE(OCIO_ConstColorSpaceRcPtr);
43 OCIO_DECLARE_HANDLE(OCIO_ConstProcessorRcPtr);
44 OCIO_DECLARE_HANDLE(OCIO_ConstContextRcPtr);
45 OCIO_DECLARE_HANDLE(OCIO_PackedImageDesc);
46 OCIO_DECLARE_HANDLE(OCIO_DisplayTransformRcPtr);
47 OCIO_DECLARE_HANDLE(OCIO_ConstTransformRcPtr);
48 OCIO_DECLARE_HANDLE(OCIO_ExponentTransformRcPtr);
49 OCIO_DECLARE_HANDLE(OCIO_MatrixTransformRcPtr);
50 OCIO_DECLARE_HANDLE(OCIO_ConstLookRcPtr);
51
52 /* Standard XYZ to linear sRGB transform, for fallback. */
53 static const float OCIO_XYZ_TO_LINEAR_SRGB[3][3] = {{3.2404542f, -0.9692660f, 0.0556434f},
54                                                     {-1.5371385f, 1.8760108f, -0.2040259f},
55                                                     {-0.4985314f, 0.0415560f, 1.0572252f}};
56
57 /* This structure is used to pass curve mapping settings from
58  * blender's DNA structure stored in view transform settings
59  * to a generic OpenColorIO C-API.
60  */
61 typedef struct OCIO_CurveMappingSettings {
62   /* This is a LUT which contain values for all 4 curve mapping tables
63    * (combined, R, G and B).
64    *
65    * Element I for table T is stored at I * 4 + T element of this LUT.
66    *
67    * This array is usually returned by curvemapping_table_RGBA().
68    */
69   float *lut;
70
71   /* Size of single curve mapping table, 1/4 size of lut array. */
72   int lut_size;
73
74   /* Extend extrapolation flags for all the tables.
75    * if use_extend_extrapolate[T] != 0 means extrapolation for
76    * table T is needed.
77    */
78   int use_extend_extrapolate[4];
79
80   /* Minimal X value of the curve mapping tables. */
81   float mintable[4];
82
83   /* Per curve mapping table range. */
84   float range[4];
85
86   /* Lower extension value, stored as per-component arrays. */
87   float ext_in_x[4], ext_in_y[4];
88
89   /* Higher extension value, stored as per-component arrays. */
90   float ext_out_x[4], ext_out_y[4];
91
92   /* First points of the tables, both X and Y values.
93    * Needed for easier and faster access when extrapolating.
94    */
95   float first_x[4], first_y[4];
96
97   /* Last points of the tables, both X and Y values.
98    * Needed for easier and faster access when extrapolating.
99    */
100   float last_x[4], last_y[4];
101
102   /* Premultiplication settings: black level and scale to match
103    * with white level.
104    */
105   float black[3], bwmul[3];
106
107   /* Cache id of the original curve mapping, used to detect when
108    * upload of new settings to GPU is needed.
109    */
110   size_t cache_id;
111 } OCIO_CurveMappingSettings;
112
113 void OCIO_init(void);
114 void OCIO_exit(void);
115
116 OCIO_ConstConfigRcPtr *OCIO_getCurrentConfig(void);
117 void OCIO_setCurrentConfig(const OCIO_ConstConfigRcPtr *config);
118
119 OCIO_ConstConfigRcPtr *OCIO_configCreateFromEnv(void);
120 OCIO_ConstConfigRcPtr *OCIO_configCreateFromFile(const char *filename);
121 OCIO_ConstConfigRcPtr *OCIO_configCreateFallback(void);
122
123 void OCIO_configRelease(OCIO_ConstConfigRcPtr *config);
124
125 int OCIO_configGetNumColorSpaces(OCIO_ConstConfigRcPtr *config);
126 const char *OCIO_configGetColorSpaceNameByIndex(OCIO_ConstConfigRcPtr *config, int index);
127 OCIO_ConstColorSpaceRcPtr *OCIO_configGetColorSpace(OCIO_ConstConfigRcPtr *config,
128                                                     const char *name);
129 int OCIO_configGetIndexForColorSpace(OCIO_ConstConfigRcPtr *config, const char *name);
130
131 int OCIO_colorSpaceIsInvertible(OCIO_ConstColorSpaceRcPtr *cs);
132 int OCIO_colorSpaceIsData(OCIO_ConstColorSpaceRcPtr *cs);
133
134 void OCIO_colorSpaceRelease(OCIO_ConstColorSpaceRcPtr *cs);
135
136 const char *OCIO_configGetDefaultDisplay(OCIO_ConstConfigRcPtr *config);
137 int OCIO_configGetNumDisplays(OCIO_ConstConfigRcPtr *config);
138 const char *OCIO_configGetDisplay(OCIO_ConstConfigRcPtr *config, int index);
139 const char *OCIO_configGetDefaultView(OCIO_ConstConfigRcPtr *config, const char *display);
140 int OCIO_configGetNumViews(OCIO_ConstConfigRcPtr *config, const char *display);
141 const char *OCIO_configGetView(OCIO_ConstConfigRcPtr *config, const char *display, int index);
142 const char *OCIO_configGetDisplayColorSpaceName(OCIO_ConstConfigRcPtr *config,
143                                                 const char *display,
144                                                 const char *view);
145
146 void OCIO_configGetDefaultLumaCoefs(OCIO_ConstConfigRcPtr *config, float *rgb);
147 void OCIO_configGetXYZtoRGB(OCIO_ConstConfigRcPtr *config, float xyz_to_rgb[3][3]);
148
149 int OCIO_configGetNumLooks(OCIO_ConstConfigRcPtr *config);
150 const char *OCIO_configGetLookNameByIndex(OCIO_ConstConfigRcPtr *config, int index);
151 OCIO_ConstLookRcPtr *OCIO_configGetLook(OCIO_ConstConfigRcPtr *config, const char *name);
152
153 const char *OCIO_lookGetProcessSpace(OCIO_ConstLookRcPtr *look);
154 void OCIO_lookRelease(OCIO_ConstLookRcPtr *look);
155
156 OCIO_ConstProcessorRcPtr *OCIO_configGetProcessorWithNames(OCIO_ConstConfigRcPtr *config,
157                                                            const char *srcName,
158                                                            const char *dstName);
159 OCIO_ConstProcessorRcPtr *OCIO_configGetProcessor(OCIO_ConstConfigRcPtr *config,
160                                                   OCIO_ConstTransformRcPtr *transform);
161
162 void OCIO_processorApply(OCIO_ConstProcessorRcPtr *processor, OCIO_PackedImageDesc *img);
163 void OCIO_processorApply_predivide(OCIO_ConstProcessorRcPtr *processor, OCIO_PackedImageDesc *img);
164 void OCIO_processorApplyRGB(OCIO_ConstProcessorRcPtr *processor, float *pixel);
165 void OCIO_processorApplyRGBA(OCIO_ConstProcessorRcPtr *processor, float *pixel);
166 void OCIO_processorApplyRGBA_predivide(OCIO_ConstProcessorRcPtr *processor, float *pixel);
167
168 void OCIO_processorRelease(OCIO_ConstProcessorRcPtr *p);
169
170 const char *OCIO_colorSpaceGetName(OCIO_ConstColorSpaceRcPtr *cs);
171 const char *OCIO_colorSpaceGetDescription(OCIO_ConstColorSpaceRcPtr *cs);
172 const char *OCIO_colorSpaceGetFamily(OCIO_ConstColorSpaceRcPtr *cs);
173
174 OCIO_DisplayTransformRcPtr *OCIO_createDisplayTransform(void);
175 void OCIO_displayTransformSetInputColorSpaceName(OCIO_DisplayTransformRcPtr *dt, const char *name);
176 void OCIO_displayTransformSetDisplay(OCIO_DisplayTransformRcPtr *dt, const char *name);
177 void OCIO_displayTransformSetView(OCIO_DisplayTransformRcPtr *dt, const char *name);
178 void OCIO_displayTransformSetDisplayCC(OCIO_DisplayTransformRcPtr *dt,
179                                        OCIO_ConstTransformRcPtr *et);
180 void OCIO_displayTransformSetLinearCC(OCIO_DisplayTransformRcPtr *dt,
181                                       OCIO_ConstTransformRcPtr *et);
182 void OCIO_displayTransformSetLooksOverride(OCIO_DisplayTransformRcPtr *dt, const char *looks);
183 void OCIO_displayTransformSetLooksOverrideEnabled(OCIO_DisplayTransformRcPtr *dt, bool enabled);
184 void OCIO_displayTransformRelease(OCIO_DisplayTransformRcPtr *dt);
185
186 OCIO_PackedImageDesc *OCIO_createOCIO_PackedImageDesc(float *data,
187                                                       long width,
188                                                       long height,
189                                                       long numChannels,
190                                                       long chanStrideBytes,
191                                                       long xStrideBytes,
192                                                       long yStrideBytes);
193
194 void OCIO_PackedImageDescRelease(OCIO_PackedImageDesc *p);
195
196 OCIO_ExponentTransformRcPtr *OCIO_createExponentTransform(void);
197 void OCIO_exponentTransformSetValue(OCIO_ExponentTransformRcPtr *et, const float *exponent);
198 void OCIO_exponentTransformRelease(OCIO_ExponentTransformRcPtr *et);
199
200 OCIO_MatrixTransformRcPtr *OCIO_createMatrixTransform(void);
201 void OCIO_matrixTransformSetValue(OCIO_MatrixTransformRcPtr *mt,
202                                   const float *m44,
203                                   const float *offset4);
204 void OCIO_matrixTransformRelease(OCIO_MatrixTransformRcPtr *mt);
205
206 void OCIO_matrixTransformScale(float *m44, float *offset4, const float *scale4);
207
208 int OCIO_supportGLSLDraw(void);
209 int OCIO_setupGLSLDraw(struct OCIO_GLSLDrawState **state_r,
210                        OCIO_ConstProcessorRcPtr *processor,
211                        OCIO_CurveMappingSettings *curve_mapping_settings,
212                        float dither,
213                        bool predivide);
214 void OCIO_finishGLSLDraw(struct OCIO_GLSLDrawState *state);
215 void OCIO_freeOGLState(struct OCIO_GLSLDrawState *state);
216
217 const char *OCIO_getVersionString(void);
218 int OCIO_getVersionHex(void);
219
220 #ifdef __cplusplus
221 }
222 #endif
223
224 #endif /* OCIO_CAPI_H */