Color Management, Stage 2: Switch color pipeline to use OpenColorIO
[blender.git] / source / blender / makesrna / intern / rna_image_api.c
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) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Arystanbek Dyussenov
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/makesrna/intern/rna_image_api.c
28  *  \ingroup RNA
29  */
30
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <time.h>
36
37 #include "RNA_define.h"
38 #include "RNA_enum_types.h"
39
40 #include "DNA_packedFile_types.h"
41
42 #include "BIF_gl.h"
43
44 #ifdef RNA_RUNTIME
45
46 #include "BKE_image.h"
47 #include "BKE_packedFile.h"
48 #include "BKE_main.h"
49
50 #include "BKE_global.h" /* grr: G.main->name */
51
52 #include "IMB_imbuf.h"
53 #include "IMB_colormanagement.h"
54
55 #include "BIF_gl.h"
56 #include "GPU_draw.h"
57
58 #include "DNA_image_types.h"
59 #include "DNA_scene_types.h"
60
61 #include "MEM_guardedalloc.h"
62
63 static void rna_Image_save_render(Image *image, bContext *C, ReportList *reports, const char *path, Scene *scene)
64 {
65         ImBuf *ibuf;
66
67         if (scene == NULL) {
68                 scene = CTX_data_scene(C);
69         }
70
71         if (scene) {
72                 ImageUser iuser;
73                 void *lock;
74
75                 iuser.scene = scene;
76                 iuser.ok = 1;
77
78                 ibuf = BKE_image_acquire_ibuf(image, &iuser, &lock);
79
80                 if (ibuf == NULL) {
81                         BKE_reportf(reports, RPT_ERROR, "Couldn't acquire buffer from image");
82                 }
83                 else {
84                         ImBuf *write_ibuf = IMB_dupImBuf(ibuf);
85
86                         IMB_display_buffer_to_imbuf_rect(write_ibuf, &scene->view_settings, &scene->display_settings);
87
88                         write_ibuf->planes = scene->r.im_format.planes;
89                         write_ibuf->dither = scene->r.dither_intensity;
90
91                         if (!BKE_imbuf_write(write_ibuf, path, &scene->r.im_format)) {
92                                 BKE_reportf(reports, RPT_ERROR, "Couldn't write image: %s", path);
93                         }
94                         IMB_freeImBuf(write_ibuf);
95                 }
96
97                 BKE_image_release_ibuf(image, lock);
98         }
99         else {
100                 BKE_reportf(reports, RPT_ERROR, "Scene not in context, couldn't get save parameters");
101         }
102 }
103
104 static void rna_Image_save(Image *image, ReportList *reports)
105 {
106         ImBuf *ibuf = BKE_image_get_ibuf(image, NULL);
107         if (ibuf) {
108                 char filename[FILE_MAX];
109                 BLI_strncpy(filename, image->name, sizeof(filename));
110                 BLI_path_abs(filename, G.main->name);
111
112                 if (image->packedfile) {
113                         if (writePackedFile(reports, image->name, image->packedfile, 0) != RET_OK) {
114                                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" could saved packed file to \"%s\"", image->id.name + 2, image->name);
115                         }
116                 }
117                 else if (IMB_saveiff(ibuf, filename, ibuf->flags)) {
118                         image->type = IMA_TYPE_IMAGE;
119
120                         if (image->source == IMA_SRC_GENERATED)
121                                 image->source = IMA_SRC_FILE;
122
123                         IMB_colormanagment_colorspace_from_ibuf_ftype(&image->colorspace_settings, ibuf);
124
125                         ibuf->userflags &= ~IB_BITMAPDIRTY;
126                 }
127                 else {
128                         BKE_reportf(reports, RPT_ERROR, "Image \"%s\" could not be saved to \"%s\"", image->id.name + 2, image->name);
129                 }
130         }
131         else {
132                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name + 2);
133         }
134 }
135
136 static void rna_Image_pack(Image *image, ReportList *reports, int as_png)
137 {
138         ImBuf *ibuf = BKE_image_get_ibuf(image, NULL);
139
140         if (!as_png && (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))) {
141                 BKE_reportf(reports, RPT_ERROR, "Can't pack edited image from disk, only as internal PNG");
142         }
143         else {
144                 if (as_png) {
145                         BKE_image_memorypack(image);
146                 }
147                 else {
148                         image->packedfile = newPackedFile(reports, image->name, ID_BLEND_PATH(G.main, &image->id));
149                 }
150         }
151 }
152
153 static void rna_Image_unpack(Image *image, ReportList *reports, int method)
154 {
155         if (!image->packedfile) {
156                 BKE_report(reports, RPT_ERROR, "Image not packed");
157         }
158         else if (image->source == IMA_SRC_SEQUENCE || image->source == IMA_SRC_MOVIE) {
159                 BKE_report(reports, RPT_ERROR, "Unpacking movies or image sequences not supported");
160                 return;
161         }
162         else {
163                 /* reports its own error on failure */
164                 unpackImage(reports, image, method);
165         }
166 }
167
168 static void rna_Image_reload(Image *image)
169 {
170         BKE_image_signal(image, NULL, IMA_SIGNAL_RELOAD);
171 }
172
173 static void rna_Image_update(Image *image, ReportList *reports)
174 {
175         ImBuf *ibuf = BKE_image_get_ibuf(image, NULL);
176
177         if (ibuf == NULL) {
178                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name + 2);
179                 return;
180         }
181
182         IMB_rect_from_float(ibuf);
183 }
184
185 static void rna_Image_scale(Image *image, ReportList *reports, int width, int height)
186 {
187         if (!BKE_image_scale(image, width, height)) {
188                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name + 2);
189         }
190 }
191
192 static int rna_Image_gl_load(Image *image, ReportList *reports, int filter, int mag)
193 {
194         ImBuf *ibuf;
195         unsigned int *bind = &image->bindcode;
196         int error = GL_NO_ERROR;
197
198         if (*bind)
199                 return error;
200
201         ibuf = BKE_image_get_ibuf(image, NULL);
202
203         if (ibuf == NULL || ibuf->rect == NULL) {
204                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name + 2);
205                 return (int)GL_INVALID_OPERATION;
206         }
207
208         /* could be made into a function? */
209         glGenTextures(1, (GLuint *)bind);
210         glBindTexture(GL_TEXTURE_2D, *bind);
211
212         if (filter != GL_NEAREST && filter != GL_LINEAR)
213                 error = (int)gluBuild2DMipmaps(GL_TEXTURE_2D, GL_RGBA, ibuf->x, ibuf->y, GL_RGBA, GL_UNSIGNED_BYTE, ibuf->rect);
214
215         if (!error) {
216                 /* clean glError buffer */
217                 while (glGetError() != GL_NO_ERROR) {}
218
219                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, image->tpageflag & IMA_CLAMP_U ? GL_CLAMP : GL_REPEAT);
220                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, image->tpageflag & IMA_CLAMP_V ? GL_CLAMP : GL_REPEAT);
221                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, (GLint)filter);
222                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, (GLint)mag);
223                 glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
224                 glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, ibuf->x, ibuf->y, 0, GL_RGBA, GL_UNSIGNED_BYTE, ibuf->rect);
225                 error = (int)glGetError();
226         }
227
228         if (error) {
229                 glDeleteTextures(1, (GLuint *)bind);
230                 image->bindcode = 0;
231         }
232
233         return error;
234 }
235
236 static int rna_Image_gl_touch(Image *image, ReportList *reports, int filter, int mag)
237 {
238         unsigned int *bind = &image->bindcode;
239         int error = GL_NO_ERROR;
240
241         BKE_image_tag_time(image);
242
243         if (*bind == 0)
244                 error = rna_Image_gl_load(image, reports, filter, mag);
245
246         return error;
247 }
248
249 static void rna_Image_gl_free(Image *image)
250 {
251         GPU_free_image(image);
252
253         /* remove the nocollect flag, image is available for garbage collection again */
254         image->flag &= ~IMA_NOCOLLECT;
255 }
256
257 #else
258
259 void RNA_api_image(StructRNA *srna)
260 {
261         FunctionRNA *func;
262         PropertyRNA *parm;
263
264         func = RNA_def_function(srna, "save_render", "rna_Image_save_render");
265         RNA_def_function_ui_description(func, "Save image to a specific path using a scenes render settings");
266         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
267         parm = RNA_def_string_file_path(func, "filepath", "", 0, "", "Save path");
268         RNA_def_property_flag(parm, PROP_REQUIRED);
269         RNA_def_pointer(func, "scene", "Scene", "", "Scene to take image parameters from");
270
271         func = RNA_def_function(srna, "save", "rna_Image_save");
272         RNA_def_function_ui_description(func, "Save image to its source path");
273         RNA_def_function_flag(func, FUNC_USE_REPORTS);
274
275         func = RNA_def_function(srna, "pack", "rna_Image_pack");
276         RNA_def_function_ui_description(func, "Pack an image as embedded data into the .blend file");
277         RNA_def_function_flag(func, FUNC_USE_REPORTS);
278         RNA_def_boolean(func, "as_png", 0, "as_png", "Pack the image as PNG (needed for generated/dirty images)");
279
280         func = RNA_def_function(srna, "unpack", "rna_Image_unpack");
281         RNA_def_function_ui_description(func, "Save an image packed in the .blend file to disk");
282         RNA_def_function_flag(func, FUNC_USE_REPORTS);
283         RNA_def_enum(func, "method", unpack_method_items, PF_USE_LOCAL, "method", "How to unpack");
284
285         func = RNA_def_function(srna, "reload", "rna_Image_reload");
286         RNA_def_function_ui_description(func, "Reload the image from its source path");
287
288         func = RNA_def_function(srna, "update", "rna_Image_update");
289         RNA_def_function_ui_description(func, "Update the display image from the floating point buffer");
290         RNA_def_function_flag(func, FUNC_USE_REPORTS);
291
292         func = RNA_def_function(srna, "scale", "rna_Image_scale");
293         RNA_def_function_ui_description(func, "Scale the image in pixels");
294         RNA_def_function_flag(func, FUNC_USE_REPORTS);
295         parm = RNA_def_int(func, "width", 0, 1, 10000, "", "Width", 1, 10000);
296         RNA_def_property_flag(parm, PROP_REQUIRED);
297         parm = RNA_def_int(func, "height", 0, 1, 10000, "", "Height", 1, 10000);
298         RNA_def_property_flag(parm, PROP_REQUIRED);
299
300         func = RNA_def_function(srna, "gl_touch", "rna_Image_gl_touch");
301         RNA_def_function_ui_description(func, "Delay the image from being cleaned from the cache due inactivity");
302         RNA_def_function_flag(func, FUNC_USE_REPORTS);
303         RNA_def_int(func, "filter", GL_LINEAR_MIPMAP_NEAREST, -INT_MAX, INT_MAX, "Filter",
304                     "The texture minifying function to use if the image wan't loaded", -INT_MAX, INT_MAX);
305         RNA_def_int(func, "mag", GL_LINEAR, -INT_MAX, INT_MAX, "Magnification",
306                     "The texture magnification function to use if the image wan't loaded", -INT_MAX, INT_MAX);
307         /* return value */
308         parm = RNA_def_int(func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
309         RNA_def_function_return(func, parm);
310
311         func = RNA_def_function(srna, "gl_load", "rna_Image_gl_load");
312         RNA_def_function_ui_description(func, "Load the image into OpenGL graphics memory");
313         RNA_def_function_flag(func, FUNC_USE_REPORTS);
314         RNA_def_int(func, "filter", GL_LINEAR_MIPMAP_NEAREST, -INT_MAX, INT_MAX, "Filter",
315                     "The texture minifying function", -INT_MAX, INT_MAX);
316         RNA_def_int(func, "mag", GL_LINEAR, -INT_MAX, INT_MAX, "Magnification",
317                     "The texture magnification function", -INT_MAX, INT_MAX);
318         /* return value */
319         parm = RNA_def_int(func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
320         RNA_def_function_return(func, parm);
321
322         func = RNA_def_function(srna, "gl_free", "rna_Image_gl_free");
323         RNA_def_function_ui_description(func, "Free the image from OpenGL graphics memory");
324
325         /* TODO, pack/unpack, maybe should be generic functions? */
326 }
327
328 #endif
329