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