Color management: display color managed RGB values in color sample line
[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 bContext;
37 struct ColorManagedColorspaceSettings;
38 struct ColorManagedDisplaySettings;
39 struct ColorManagedViewSettings;
40 struct EnumPropertyItem;
41 struct ImBuf;
42 struct Main;
43 struct rcti;
44 struct PartialBufferUpdateContext;
45 struct wmWindow;
46 struct Scene;
47
48 /* ** Initialization / De-initialization ** */
49
50 void IMB_colormanagement_init(void);
51 void IMB_colormanagement_exit(void);
52
53 /* ** Color space transformation functions ** */
54 void IMB_colormanagement_colorspace_transform(float *buffer, int width, int height, int channels,
55                                               const char *from_colorspace, const char *to_colorspace);
56
57 void IMB_colormanagement_imbuf_to_role(struct ImBuf *ibuf, int role);
58 void IMB_colormanagement_imbuf_from_role(struct ImBuf *ibuf, int role);
59
60 void IMB_colormanagement_imbuf_make_scene_linear(struct ImBuf *ibuf,
61                 struct ColorManagedColorspaceSettings *colorspace_settings);
62
63 void IMB_colormanagement_imbuf_to_sequencer_space(struct ImBuf *ibuf, int make_float);
64 void IMB_colormanagement_imbuf_from_sequencer_space(struct ImBuf *ibuf);
65
66 /* ** Public display buffers interfaces ** */
67
68 void IMB_colormanage_cache_free(struct ImBuf *ibuf);
69
70 unsigned char *IMB_display_buffer_acquire(struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
71                                           const struct ColorManagedDisplaySettings *display_settings, void **cache_handle);
72 unsigned char *IMB_display_buffer_acquire_ctx(const struct bContext *C, struct ImBuf *ibuf, void **cache_handle);
73
74 void IMB_display_buffer_pixel(float result[4], const float pixel[4],  const struct ColorManagedViewSettings *view_settings,
75                               const struct ColorManagedDisplaySettings *display_settings);
76
77 void IMB_display_buffer_to_imbuf_rect(struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
78                                       const struct ColorManagedDisplaySettings *display_settings);
79
80 void IMB_display_buffer_release(void *cache_handle);
81
82 void IMB_display_buffer_invalidate(struct ImBuf *ibuf);
83
84 void IMB_colormanagement_check_file_config(struct Main *bmain);
85
86 void IMB_colormanagement_validate_settings(struct ColorManagedDisplaySettings *display_settings,
87                                            struct ColorManagedViewSettings *view_settings);
88
89 /* ** Display funcrions ** */
90 int IMB_colormanagement_display_get_named_index(const char *name);
91 const char *IMB_colormanagement_display_get_indexed_name(int index);
92 const char *IMB_colormanagement_display_get_default_name(void);
93
94 /* ** View funcrions ** */
95 int IMB_colormanagement_view_get_named_index(const char *name);
96 const char *IMB_colormanagement_view_get_indexed_name(int index);
97
98 /* ** Color space functions ** */
99 int IMB_colormanagement_colorspace_get_named_index(const char *name);
100 const char *IMB_colormanagement_colorspace_get_indexed_name(int index);
101
102 /* ** RNA helper functions ** */
103 void IMB_colormanagement_display_items_add(struct EnumPropertyItem **items, int *totitem);
104 void IMB_colormanagement_view_items_add(struct EnumPropertyItem **items, int *totitem, const char *display_name);
105 void IMB_colormanagement_colorspace_items_add(struct EnumPropertyItem **items, int *totitem);
106
107 /* Tile-based buffer management */
108 void IMB_partial_display_buffer_update(struct ImBuf *ibuf, const float *linear_buffer,
109                                        int stride, int offset_x, int offset_y,
110                                        int xmin, int ymin, int xmax, int ymax);
111
112 enum {
113         COLOR_ROLE_SCENE_LINEAR = 0,
114         COLOR_ROLE_COLOR_PICKING,
115         COLOR_ROLE_TEXTURE_PAINTING,
116         COLOR_ROLE_SEQUENCER,
117 };
118
119 #endif // IMB_COLORMANAGEMENT_H