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