c5b7acf6914ae6b89fb6ab34513769b8d2cf5568
[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 #endif
53
54
55 extern ConstConfigRcPtr* OCIO_getCurrentConfig(void);
56 extern void OCIO_setCurrentConfig(const ConstConfigRcPtr* config);
57
58 extern ConstConfigRcPtr* OCIO_configCreateFromEnv(void);
59 extern ConstConfigRcPtr* OCIO_configCreateFromFile(const char* filename);
60
61 extern void OCIO_configRelease(ConstConfigRcPtr* config);
62
63 extern int OCIO_configGetNumColorSpaces(ConstConfigRcPtr* config);
64 extern const char* OCIO_configGetColorSpaceNameByIndex(ConstConfigRcPtr* config, int index);
65 extern ConstColorSpaceRcPtr* OCIO_configGetColorSpace(ConstConfigRcPtr* config, const char* name);
66 extern int OCIO_configGetIndexForColorSpace(ConstConfigRcPtr* config, const char* name);
67
68 extern void OCIO_colorSpaceRelease(ConstColorSpaceRcPtr* cs);
69
70 extern const char* OCIO_configGetDefaultDisplay(ConstConfigRcPtr* config);
71 extern int         OCIO_configGetNumDisplays(ConstConfigRcPtr* config);
72 extern const char* OCIO_configGetDisplay(ConstConfigRcPtr* config, int index);
73 extern const char* OCIO_configGetDefaultView(ConstConfigRcPtr* config, const char* display);
74 extern int         OCIO_configGetNumViews(ConstConfigRcPtr* config, const char* display);
75 extern const char* OCIO_configGetView(ConstConfigRcPtr* config, const char* display, int index);
76 extern const char* OCIO_configGetDisplayColorSpaceName(ConstConfigRcPtr* config, const char* display, const char* view);
77
78 extern ConstProcessorRcPtr* OCIO_configGetProcessorWithNames(ConstConfigRcPtr* config, const char* srcName, const char* dstName);
79 extern ConstProcessorRcPtr* OCIO_configGetProcessor(ConstConfigRcPtr* config, ConstTransformRcPtr* transform);
80
81 extern void OCIO_processorApply(ConstProcessorRcPtr* processor, PackedImageDesc* img);
82 extern void OCIO_processorApplyRGB(ConstProcessorRcPtr* processor, float* pixel);
83 extern void OCIO_processorApplyRGBA(ConstProcessorRcPtr* processor, float* pixel);
84
85 extern void OCIO_processorRelease(ConstProcessorRcPtr* p);
86
87
88 extern const char* OCIO_colorSpaceGetName(ConstColorSpaceRcPtr* cs);
89 extern const char* OCIO_colorSpaceGetFamily(ConstColorSpaceRcPtr* cs);
90
91 extern DisplayTransformRcPtr* OCIO_createDisplayTransform(void);
92 extern void OCIO_displayTransformSetInputColorSpaceName(DisplayTransformRcPtr* dt, const char * name);
93 extern void OCIO_displayTransformSetDisplay(DisplayTransformRcPtr* dt, const char * name);
94 extern void OCIO_displayTransformSetView(DisplayTransformRcPtr* dt, const char * name);
95 extern void OCIO_displayTransformRelease(DisplayTransformRcPtr* dt);
96
97 PackedImageDesc* OCIO_createPackedImageDesc(float * data, long width, long height, long numChannels,
98                                                                                         long chanStrideBytes, long xStrideBytes, long yStrideBytes);
99
100 extern void OCIO_packedImageDescRelease(PackedImageDesc* p);
101
102 #ifdef __cplusplus
103 }
104 #endif
105
106 #endif //OCIO_CAPI_H