Color management: refactor of cache to deal better with movie clip cache
[blender-staging.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 ColorManagedDisplaySettings;
37 struct ColorManagedViewSettings;
38 struct EnumPropertyItem;
39 struct ImBuf;
40 struct Main;
41 struct rcti;
42 struct PartialBufferUpdateContext;
43 struct wmWindow;
44
45 /* ** Initialization / De-initialization ** */
46
47 void IMB_colormanagement_init(void);
48 void IMB_colormanagement_exit(void);
49
50 /* ** Public display buffers interfaces ** */
51
52 void IMB_colormanage_cache_free(struct ImBuf *ibuf);
53
54 unsigned char *IMB_display_buffer_acquire(struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
55                                           const struct ColorManagedDisplaySettings *display_settings, void **cache_handle);
56 void IMB_display_buffer_to_imbuf_rect(struct ImBuf *ibuf, const struct ColorManagedViewSettings *view_settings,
57                                       const struct ColorManagedDisplaySettings *display_settings);
58
59 void IMB_display_buffer_release(void *cache_handle);
60
61 void IMB_display_buffer_invalidate(struct ImBuf *ibuf);
62
63 void IMB_colormanagement_check_file_config(struct Main *bmain);
64
65 const struct ColorManagedViewSettings *IMB_view_settings_get_effective(struct wmWindow *win,
66                 const struct ColorManagedViewSettings *view_settings);
67
68 /* ** Display funcrions ** */
69 int IMB_colormanagement_display_get_named_index(const char *name);
70 const char *IMB_colormanagement_display_get_indexed_name(int index);
71 const char *IMB_colormanagement_display_get_default_name(void);
72
73 /* ** View funcrions ** */
74 int IMB_colormanagement_view_get_named_index(const char *name);
75 const char *IMB_colormanagement_view_get_indexed_name(int index);
76
77 /* ** RNA helper functions ** */
78 void IMB_colormanagement_display_items_add(struct EnumPropertyItem **items, int *totitem);
79 void IMB_colormanagement_view_items_add(struct EnumPropertyItem **items, int *totitem, const char *display_name);
80
81 /* Tile-based buffer management */
82 struct PartialBufferUpdateContext *IMB_partial_buffer_update_context_new(struct ImBuf *ibuf);
83 void IMB_partial_buffer_update_rect(struct PartialBufferUpdateContext *context, const float *linear_buffer, struct rcti *rect);
84 void IMB_partial_buffer_update_free(struct PartialBufferUpdateContext *context, struct ImBuf *ibuf);
85
86 #endif // IMB_COLORMANAGEMENT_H