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