Merging r50049 through r50076 from trunk into soc-2011-tomato
[blender.git] / source / blender / imbuf / IMB_colormanagement.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 by Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Xavier Thomas,
24  *                 Lukas Toenne,
25  *                 Sergey Sharybin
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 #ifndef IMB_COLORMANAGEMENT_H
32 #define IMB_COLORMANAGEMENT_H
33
34 #define BCM_CONFIG_FILE "config.ocio"
35
36 struct ColorManagedColorspaceSettings;
37 struct ColorManagedDisplaySettings;
38 struct ColorManagedViewSettings;
39 struct EnumPropertyItem;
40 struct ImBuf;
41 struct Main;
42 struct rcti;
43 struct PartialBufferUpdateContext;
44 struct wmWindow;
45
46 /* ** Initialization / De-initialization ** */
47
48 void IMB_colormanagement_init(void);
49 void IMB_colormanagement_exit(void);
50
51 /* ** Color space transformation functions ** */
52 void IMB_colormanagement_colorspace_transform(float *buffer, int width, int height, int channels,
53                                               const char *from_colorspace, const char *to_colorspace);
54
55 void IMB_colormanagement_imbuf_make_scene_linear(struct ImBuf *ibuf,
56                 struct ColorManagedColorspaceSettings *colorspace_settings);
57
58 /* ** Public display buffers interfaces ** */
59
60 void IMB_colormanage_cache_free(struct ImBuf *ibuf);
61
62 unsigned char *IMB_display_buffer_acquire(struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
63                                           const struct ColorManagedDisplaySettings *display_settings, void **cache_handle);
64 void IMB_display_buffer_to_imbuf_rect(struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
65                                       const struct ColorManagedDisplaySettings *display_settings);
66
67 void IMB_display_buffer_release(void *cache_handle);
68
69 void IMB_display_buffer_invalidate(struct ImBuf *ibuf);
70
71 void IMB_colormanagement_check_file_config(struct Main *bmain);
72
73 const struct ColorManagedViewSettings *IMB_view_settings_get_effective(struct wmWindow *win,
74                 const struct ColorManagedViewSettings *view_settings);
75
76 /* ** Display funcrions ** */
77 int IMB_colormanagement_display_get_named_index(const char *name);
78 const char *IMB_colormanagement_display_get_indexed_name(int index);
79 const char *IMB_colormanagement_display_get_default_name(void);
80
81 /* ** View funcrions ** */
82 int IMB_colormanagement_view_get_named_index(const char *name);
83 const char *IMB_colormanagement_view_get_indexed_name(int index);
84
85 /* ** Color space functions ** */
86 int IMB_colormanagement_colorspace_get_named_index(const char *name);
87 const char *IMB_colormanagement_colorspace_get_indexed_name(int index);
88
89 /* ** RNA helper functions ** */
90 void IMB_colormanagement_display_items_add(struct EnumPropertyItem **items, int *totitem);
91 void IMB_colormanagement_view_items_add(struct EnumPropertyItem **items, int *totitem, const char *display_name);
92 void IMB_colormanagement_colorspace_items_add(struct EnumPropertyItem **items, int *totitem);
93
94 /* Tile-based buffer management */
95 void IMB_partial_display_buffer_update(struct ImBuf *ibuf, const float *linear_buffer,
96                                        int stride, int offset_x, int offset_y,
97                                        int xmin, int ymin, int xmax, int ymax);
98
99 #endif // IMB_COLORMANAGEMENT_H