Color management refactoiring and some extra options
[blender.git] / intern / opencolorio / ocio_capi.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) 2012 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Xavier Thomas
22  *                 Lukas Toene
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #ifndef OCIO_CAPI_H
28 #define OCIO_CAPI_H
29
30
31
32 #ifdef __cplusplus
33 using namespace OCIO_NAMESPACE;
34 extern "C" { 
35 #endif
36
37 #define OCIO_DECLARE_HANDLE(name) typedef struct name##__ { int unused; } *name
38
39
40 #ifndef OCIO_CAPI_IMPLEMENTATION
41         #define OCIO_ROLE_SCENE_LINEAR  "scene_linear"
42         #define OCIO_ROLE_COLOR_PICKING "color_picking"
43         #define OCIO_ROLE_TEXTURE_PAINT "texture_paint"
44         
45         OCIO_DECLARE_HANDLE(ConstConfigRcPtr);
46         OCIO_DECLARE_HANDLE(ConstColorSpaceRcPtr);
47         OCIO_DECLARE_HANDLE(ConstProcessorRcPtr);
48         OCIO_DECLARE_HANDLE(ConstContextRcPtr);
49         OCIO_DECLARE_HANDLE(PackedImageDesc);
50         OCIO_DECLARE_HANDLE(DisplayTransformRcPtr);
51         OCIO_DECLARE_HANDLE(ConstTransformRcPtr);
52         OCIO_DECLARE_HANDLE(ExponentTransformRcPtr);
53         OCIO_DECLARE_HANDLE(MatrixTransformRcPtr);
54 #endif
55
56
57 extern ConstConfigRcPtr* OCIO_getCurrentConfig(void);
58 extern void OCIO_setCurrentConfig(const ConstConfigRcPtr* config);
59
60 extern ConstConfigRcPtr* OCIO_configCreateFromEnv(void);
61 extern ConstConfigRcPtr* OCIO_configCreateFromFile(const char* filename);
62
63 extern void OCIO_configRelease(ConstConfigRcPtr* config);
64
65 extern int OCIO_configGetNumColorSpaces(ConstConfigRcPtr* config);
66 extern const char* OCIO_configGetColorSpaceNameByIndex(ConstConfigRcPtr* config, int index);
67 extern ConstColorSpaceRcPtr* OCIO_configGetColorSpace(ConstConfigRcPtr* config, const char* name);
68 extern int OCIO_configGetIndexForColorSpace(ConstConfigRcPtr* config, const char* name);
69
70 extern void OCIO_colorSpaceRelease(ConstColorSpaceRcPtr* cs);
71
72 extern const char* OCIO_configGetDefaultDisplay(ConstConfigRcPtr* config);
73 extern int         OCIO_configGetNumDisplays(ConstConfigRcPtr* config);
74 extern const char* OCIO_configGetDisplay(ConstConfigRcPtr* config, int index);
75 extern const char* OCIO_configGetDefaultView(ConstConfigRcPtr* config, const char* display);
76 extern int         OCIO_configGetNumViews(ConstConfigRcPtr* config, const char* display);
77 extern const char* OCIO_configGetView(ConstConfigRcPtr* config, const char* display, int index);
78 extern const char* OCIO_configGetDisplayColorSpaceName(ConstConfigRcPtr* config, const char* display, const char* view);
79
80 extern ConstProcessorRcPtr* OCIO_configGetProcessorWithNames(ConstConfigRcPtr* config, const char* srcName, const char* dstName);
81 extern ConstProcessorRcPtr* OCIO_configGetProcessor(ConstConfigRcPtr* config, ConstTransformRcPtr* transform);
82
83 extern void OCIO_processorApply(ConstProcessorRcPtr* processor, PackedImageDesc* img);
84 extern void OCIO_processorApplyRGB(ConstProcessorRcPtr* processor, float* pixel);
85 extern void OCIO_processorApplyRGBA(ConstProcessorRcPtr* processor, float* pixel);
86
87 extern void OCIO_processorRelease(ConstProcessorRcPtr* p);
88
89
90 extern const char* OCIO_colorSpaceGetName(ConstColorSpaceRcPtr* cs);
91 extern const char* OCIO_colorSpaceGetFamily(ConstColorSpaceRcPtr* cs);
92
93 extern DisplayTransformRcPtr* OCIO_createDisplayTransform(void);
94 extern void OCIO_displayTransformSetInputColorSpaceName(DisplayTransformRcPtr* dt, const char * name);
95 extern void OCIO_displayTransformSetDisplay(DisplayTransformRcPtr* dt, const char * name);
96 extern void OCIO_displayTransformSetView(DisplayTransformRcPtr* dt, const char * name);
97 extern void OCIO_displayTransformSetDisplayCC(DisplayTransformRcPtr *dt, ConstTransformRcPtr *et);
98 extern void OCIO_displayTransformSetLinearCC(DisplayTransformRcPtr *dt, ConstTransformRcPtr *et);
99 extern void OCIO_displayTransformRelease(DisplayTransformRcPtr* dt);
100
101 PackedImageDesc* OCIO_createPackedImageDesc(float * data, long width, long height, long numChannels,
102                                                                                         long chanStrideBytes, long xStrideBytes, long yStrideBytes);
103
104 extern void OCIO_packedImageDescRelease(PackedImageDesc* p);
105
106 ExponentTransformRcPtr *OCIO_createExponentTransform(void);
107 void OCIO_exponentTransformSetValue(ExponentTransformRcPtr *et, const float *exponent);
108 void OCIO_exponentTransformRelease(ExponentTransformRcPtr *et);
109
110 MatrixTransformRcPtr *OCIO_createMatrixTransform(void);
111 void OCIO_matrixTransformSetValue(MatrixTransformRcPtr *et, const float *m44, const float *offset4);
112 void OCIO_matrixTransformRelease(MatrixTransformRcPtr *mt);
113
114 void OCIO_matrixTransformScale(float * m44, float * offset4, const float * scale4);
115
116 #ifdef __cplusplus
117 }
118 #endif
119
120 #endif //OCIO_CAPI_H