Merge branch 'master' into blender2.8
[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 #include "BLI_path_util.h"
41
42 #include "BIF_gl.h"
43
44 #include "RNA_define.h"
45 #include "RNA_enum_types.h"
46
47 #include "rna_internal.h"  /* own include */
48
49 #ifdef RNA_RUNTIME
50
51 #include <errno.h>
52 #include "BKE_image.h"
53 #include "BKE_packedFile.h"
54 #include "BKE_main.h"
55
56 #include "IMB_imbuf.h"
57 #include "IMB_colormanagement.h"
58
59 #include "DNA_image_types.h"
60 #include "DNA_scene_types.h"
61
62 #include "MEM_guardedalloc.h"
63
64 static void rna_ImagePackedFile_save(ImagePackedFile *imapf, Main *bmain, ReportList *reports)
65 {
66         if (writePackedFile(reports, BKE_main_blendfile_path(bmain), imapf->filepath, imapf->packedfile, 0) != RET_OK) {
67                 BKE_reportf(reports, RPT_ERROR, "Could not save packed file to disk as '%s'",
68                             imapf->filepath);
69         }
70 }
71
72 static void rna_Image_save_render(Image *image, bContext *C, ReportList *reports, const char *path, Scene *scene)
73 {
74         ImBuf *ibuf;
75
76         if (scene == NULL) {
77                 scene = CTX_data_scene(C);
78         }
79
80         if (scene) {
81                 ImageUser iuser = {NULL};
82                 void *lock;
83
84                 iuser.scene = scene;
85                 iuser.ok = 1;
86
87                 ibuf = BKE_image_acquire_ibuf(image, &iuser, &lock);
88
89                 if (ibuf == NULL) {
90                         BKE_report(reports, RPT_ERROR, "Could not acquire buffer from image");
91                 }
92                 else {
93                         ImBuf *write_ibuf;
94
95                         write_ibuf = IMB_colormanagement_imbuf_for_write(ibuf, true, true, &scene->view_settings,
96                                                                          &scene->display_settings, &scene->r.im_format);
97
98                         write_ibuf->planes = scene->r.im_format.planes;
99                         write_ibuf->dither = scene->r.dither_intensity;
100
101                         if (!BKE_imbuf_write(write_ibuf, path, &scene->r.im_format)) {
102                                 BKE_reportf(reports, RPT_ERROR, "Could not write image: %s, '%s'", strerror(errno), path);
103                         }
104
105                         if (write_ibuf != ibuf)
106                                 IMB_freeImBuf(write_ibuf);
107                 }
108
109                 BKE_image_release_ibuf(image, ibuf, lock);
110         }
111         else {
112                 BKE_report(reports, RPT_ERROR, "Scene not in context, could not get save parameters");
113         }
114 }
115
116 static void rna_Image_save(Image *image, Main *bmain, bContext *C, ReportList *reports)
117 {
118         ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
119         if (ibuf) {
120                 char filename[FILE_MAX];
121                 BLI_strncpy(filename, image->name, sizeof(filename));
122                 BLI_path_abs(filename, ID_BLEND_PATH(bmain, &image->id));
123
124                 /* note, we purposefully ignore packed files here,
125                  * developers need to explicitly write them via 'packed_files' */
126
127                 if (IMB_saveiff(ibuf, filename, ibuf->flags)) {
128                         image->type = IMA_TYPE_IMAGE;
129
130                         if (image->source == IMA_SRC_GENERATED)
131                                 image->source = IMA_SRC_FILE;
132
133                         IMB_colormanagment_colorspace_from_ibuf_ftype(&image->colorspace_settings, ibuf);
134
135                         ibuf->userflags &= ~IB_BITMAPDIRTY;
136                 }
137                 else {
138                         BKE_reportf(reports, RPT_ERROR, "Image '%s' could not be saved to '%s'", image->id.name + 2, image->name);
139                 }
140         }
141         else {
142                 BKE_reportf(reports, RPT_ERROR, "Image '%s' does not have any image data", image->id.name + 2);
143         }
144
145         BKE_image_release_ibuf(image, ibuf, NULL);
146         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, image);
147 }
148
149 static void rna_Image_pack(
150         Image *image, Main *bmain, bContext *C, ReportList *reports,
151         int as_png, const char *data, int data_len)
152 {
153         ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
154
155         if (!as_png && (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))) {
156                 BKE_report(reports, RPT_ERROR, "Cannot pack edited image from disk, only as internal PNG");
157         }
158         else {
159                 BKE_image_free_packedfiles(image);
160                 if (as_png) {
161                         BKE_image_memorypack(image);
162                 }
163                 else if (data) {
164                         char *data_dup = MEM_mallocN(sizeof(*data_dup) * (size_t)data_len, __func__);
165                         memcpy(data_dup, data, (size_t)data_len);
166                         BKE_image_packfiles_from_mem(reports, image, data_dup, (size_t)data_len);
167                 }
168                 else {
169                         BKE_image_packfiles(reports, image, ID_BLEND_PATH(bmain, &image->id));
170                 }
171         }
172
173         BKE_image_release_ibuf(image, ibuf, NULL);
174         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, image);
175 }
176
177 static void rna_Image_unpack(Image *image, Main *bmain, ReportList *reports, int method)
178 {
179         if (!BKE_image_has_packedfile(image)) {
180                 BKE_report(reports, RPT_ERROR, "Image not packed");
181         }
182         else if (BKE_image_is_animated(image)) {
183                 BKE_report(reports, RPT_ERROR, "Unpacking movies or image sequences not supported");
184                 return;
185         }
186         else {
187                 /* reports its own error on failure */
188                 unpackImage(bmain, reports, image, method);
189         }
190 }
191
192 static void rna_Image_reload(Image *image, Main *bmain)
193 {
194         BKE_image_signal(bmain, image, NULL, IMA_SIGNAL_RELOAD);
195 }
196
197 static void rna_Image_update(Image *image, ReportList *reports)
198 {
199         ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
200
201         if (ibuf == NULL) {
202                 BKE_reportf(reports, RPT_ERROR, "Image '%s' does not have any image data", image->id.name + 2);
203                 return;
204         }
205
206         if (ibuf->rect)
207                 IMB_rect_from_float(ibuf);
208
209         ibuf->userflags |= IB_DISPLAY_BUFFER_INVALID;
210
211         BKE_image_release_ibuf(image, ibuf, NULL);
212 }
213
214 static void rna_Image_scale(Image *image, ReportList *reports, int width, int height)
215 {
216         if (!BKE_image_scale(image, width, height)) {
217                 BKE_reportf(reports, RPT_ERROR, "Image '%s' does not have any image data", image->id.name + 2);
218         }
219 }
220
221 static int rna_Image_gl_load(Image *image, ReportList *reports, int frame, int filter, int mag)
222 {
223         ImBuf *ibuf;
224         unsigned int *bind = &image->bindcode[TEXTARGET_TEXTURE_2D];
225         int error = GL_NO_ERROR;
226         ImageUser iuser = {NULL};
227         void *lock;
228
229         if (*bind)
230                 return error;
231         iuser.framenr = frame;
232         iuser.ok = true;
233
234         ibuf = BKE_image_acquire_ibuf(image, &iuser, &lock);
235
236         /* clean glError buffer */
237         while (glGetError() != GL_NO_ERROR) {}
238
239         if (ibuf == NULL || ibuf->rect == NULL) {
240                 BKE_reportf(reports, RPT_ERROR, "Image '%s' does not have any image data", image->id.name + 2);
241                 BKE_image_release_ibuf(image, ibuf, NULL);
242                 return (int)GL_INVALID_OPERATION;
243         }
244
245         GPU_create_gl_tex(bind, ibuf->rect, ibuf->rect_float, ibuf->x, ibuf->y, GL_TEXTURE_2D,
246                           (filter != GL_NEAREST && filter != GL_LINEAR), false, image);
247
248         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, (GLint)filter);
249         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, (GLint)mag);
250
251         /* TODO(merwin): validate input (dimensions, filter, mag) before calling OpenGL
252          *               instead of trusting input & testing for error after */
253         error = glGetError();
254
255         if (error) {
256                 glDeleteTextures(1, (GLuint *)bind);
257                 image->bindcode[TEXTARGET_TEXTURE_2D] = 0;
258         }
259
260         BKE_image_release_ibuf(image, ibuf, NULL);
261
262         return error;
263 }
264
265 static int rna_Image_gl_touch(Image *image, ReportList *reports, int frame, int filter, int mag)
266 {
267         unsigned int *bind = &image->bindcode[TEXTARGET_TEXTURE_2D];
268         int error = GL_NO_ERROR;
269
270         BKE_image_tag_time(image);
271
272         if (*bind == 0)
273                 error = rna_Image_gl_load(image, reports, frame, filter, mag);
274
275         return error;
276 }
277
278 static void rna_Image_gl_free(Image *image)
279 {
280         GPU_free_image(image);
281
282         /* remove the nocollect flag, image is available for garbage collection again */
283         image->flag &= ~IMA_NOCOLLECT;
284 }
285
286 static void rna_Image_filepath_from_user(Image *image, ImageUser *image_user, char *filepath)
287 {
288         BKE_image_user_file_path(image_user, image, filepath);
289 }
290
291 static void rna_Image_buffers_free(Image *image)
292 {
293         BKE_image_free_buffers_ex(image, true);
294 }
295
296 #else
297
298 void RNA_api_image_packed_file(StructRNA *srna)
299 {
300         FunctionRNA *func;
301
302         func = RNA_def_function(srna, "save", "rna_ImagePackedFile_save");
303         RNA_def_function_ui_description(func, "Save the packed file to its filepath");
304         RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_REPORTS);
305 }
306
307 void RNA_api_image(StructRNA *srna)
308 {
309         FunctionRNA *func;
310         PropertyRNA *parm;
311
312         func = RNA_def_function(srna, "save_render", "rna_Image_save_render");
313         RNA_def_function_ui_description(func, "Save image to a specific path using a scenes render settings");
314         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
315         parm = RNA_def_string_file_path(func, "filepath", NULL, 0, "", "Save path");
316         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
317         RNA_def_pointer(func, "scene", "Scene", "", "Scene to take image parameters from");
318
319         func = RNA_def_function(srna, "save", "rna_Image_save");
320         RNA_def_function_ui_description(func, "Save image to its source path");
321         RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
322
323         func = RNA_def_function(srna, "pack", "rna_Image_pack");
324         RNA_def_function_ui_description(func, "Pack an image as embedded data into the .blend file");
325         RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
326         RNA_def_boolean(func, "as_png", 0, "as_png", "Pack the image as PNG (needed for generated/dirty images)");
327         parm = RNA_def_property(func, "data", PROP_STRING, PROP_BYTESTRING);
328         RNA_def_property_ui_text(parm, "data", "Raw data (bytes, exact content of the embedded file)");
329         RNA_def_int(func, "data_len", 0, 0, INT_MAX,
330                     "data_len", "length of given data (mandatory if data is provided)", 0, INT_MAX);
331
332         func = RNA_def_function(srna, "unpack", "rna_Image_unpack");
333         RNA_def_function_ui_description(func, "Save an image packed in the .blend file to disk");
334         RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_REPORTS);
335         RNA_def_enum(func, "method", rna_enum_unpack_method_items, PF_USE_LOCAL, "method", "How to unpack");
336
337         func = RNA_def_function(srna, "reload", "rna_Image_reload");
338         RNA_def_function_flag(func, FUNC_USE_MAIN);
339         RNA_def_function_ui_description(func, "Reload the image from its source path");
340
341         func = RNA_def_function(srna, "update", "rna_Image_update");
342         RNA_def_function_ui_description(func, "Update the display image from the floating point buffer");
343         RNA_def_function_flag(func, FUNC_USE_REPORTS);
344
345         func = RNA_def_function(srna, "scale", "rna_Image_scale");
346         RNA_def_function_ui_description(func, "Scale the image in pixels");
347         RNA_def_function_flag(func, FUNC_USE_REPORTS);
348         parm = RNA_def_int(func, "width", 1, 1, 10000, "", "Width", 1, 10000);
349         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
350         parm = RNA_def_int(func, "height", 1, 1, 10000, "", "Height", 1, 10000);
351         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
352
353         func = RNA_def_function(srna, "gl_touch", "rna_Image_gl_touch");
354         RNA_def_function_ui_description(func, "Delay the image from being cleaned from the cache due inactivity");
355         RNA_def_function_flag(func, FUNC_USE_REPORTS);
356         RNA_def_int(func, "frame", 0, 0, INT_MAX, "Frame",
357                     "Frame of image sequence or movie", 0, INT_MAX);
358         RNA_def_int(func, "filter", GL_LINEAR_MIPMAP_NEAREST, -INT_MAX, INT_MAX, "Filter",
359                     "The texture minifying function to use if the image wasn't loaded", -INT_MAX, INT_MAX);
360         RNA_def_int(func, "mag", GL_LINEAR, -INT_MAX, INT_MAX, "Magnification",
361                     "The texture magnification function to use if the image wasn't loaded", -INT_MAX, INT_MAX);
362         /* return value */
363         parm = RNA_def_int(func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
364         RNA_def_function_return(func, parm);
365
366         func = RNA_def_function(srna, "gl_load", "rna_Image_gl_load");
367         RNA_def_function_ui_description(func, "Load the image into OpenGL graphics memory");
368         RNA_def_function_flag(func, FUNC_USE_REPORTS);
369         RNA_def_int(func, "frame", 0, 0, INT_MAX, "Frame",
370                     "Frame of image sequence or movie", 0, INT_MAX);
371         RNA_def_int(func, "filter", GL_LINEAR_MIPMAP_NEAREST, -INT_MAX, INT_MAX, "Filter",
372                     "The texture minifying function", -INT_MAX, INT_MAX);
373         RNA_def_int(func, "mag", GL_LINEAR, -INT_MAX, INT_MAX, "Magnification",
374                     "The texture magnification function", -INT_MAX, INT_MAX);
375         /* return value */
376         parm = RNA_def_int(func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
377         RNA_def_function_return(func, parm);
378
379         func = RNA_def_function(srna, "gl_free", "rna_Image_gl_free");
380         RNA_def_function_ui_description(func, "Free the image from OpenGL graphics memory");
381
382         /* path to an frame specified by image user */
383         func = RNA_def_function(srna, "filepath_from_user", "rna_Image_filepath_from_user");
384         RNA_def_function_ui_description(func, "Return the absolute path to the filepath of an image frame specified by the image user");
385         RNA_def_pointer(func, "image_user", "ImageUser", "", "Image user of the image to get filepath for");
386         parm = RNA_def_string_file_path(func, "filepath", NULL, FILE_MAX, "File Path",
387                                         "The resulting filepath from the image and it's user");
388         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);  /* needed for string return value */
389         RNA_def_function_output(func, parm);
390
391         func = RNA_def_function(srna, "buffers_free", "rna_Image_buffers_free");
392         RNA_def_function_ui_description(func, "Free the image buffers from memory");
393
394         /* TODO, pack/unpack, maybe should be generic functions? */
395 }
396
397 #endif
398