0db099e3e1d0434455342a0e54ab73af486731e8
[blender.git] / source / blender / makesrna / intern / rna_image_api.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup RNA
22  */
23
24 #include <stdlib.h>
25 #include <stdio.h>
26 #include <string.h>
27 #include <time.h>
28
29 #include "DNA_packedFile_types.h"
30
31 #include "BLI_utildefines.h"
32 #include "BLI_path_util.h"
33
34 #include "BIF_gl.h"
35
36 #include "RNA_define.h"
37 #include "RNA_enum_types.h"
38
39 #include "rna_internal.h" /* own include */
40
41 #ifdef RNA_RUNTIME
42
43 #  include <errno.h>
44 #  include "BKE_image.h"
45 #  include "BKE_packedFile.h"
46 #  include "BKE_main.h"
47
48 #  include "IMB_imbuf.h"
49 #  include "IMB_colormanagement.h"
50
51 #  include "DNA_image_types.h"
52 #  include "DNA_scene_types.h"
53
54 #  include "MEM_guardedalloc.h"
55
56 static void rna_ImagePackedFile_save(ImagePackedFile *imapf, Main *bmain, ReportList *reports)
57 {
58   if (BKE_packedfile_write_to_file(
59           reports, BKE_main_blendfile_path(bmain), imapf->filepath, imapf->packedfile, 0) !=
60       RET_OK) {
61     BKE_reportf(reports, RPT_ERROR, "Could not save packed file to disk as '%s'", imapf->filepath);
62   }
63 }
64
65 static void rna_Image_save_render(
66     Image *image, bContext *C, ReportList *reports, const char *path, Scene *scene)
67 {
68   ImBuf *ibuf;
69
70   if (scene == NULL) {
71     scene = CTX_data_scene(C);
72   }
73
74   if (scene) {
75     ImageUser iuser = {NULL};
76     void *lock;
77
78     iuser.scene = scene;
79     iuser.ok = 1;
80
81     ibuf = BKE_image_acquire_ibuf(image, &iuser, &lock);
82
83     if (ibuf == NULL) {
84       BKE_report(reports, RPT_ERROR, "Could not acquire buffer from image");
85     }
86     else {
87       ImBuf *write_ibuf;
88
89       write_ibuf = IMB_colormanagement_imbuf_for_write(
90           ibuf, true, true, &scene->view_settings, &scene->display_settings, &scene->r.im_format);
91
92       write_ibuf->planes = scene->r.im_format.planes;
93       write_ibuf->dither = scene->r.dither_intensity;
94
95       if (!BKE_imbuf_write(write_ibuf, path, &scene->r.im_format)) {
96         BKE_reportf(reports, RPT_ERROR, "Could not write image: %s, '%s'", strerror(errno), path);
97       }
98
99       if (write_ibuf != ibuf) {
100         IMB_freeImBuf(write_ibuf);
101       }
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, Main *bmain, bContext *C, ReportList *reports)
112 {
113   void *lock;
114
115   ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, &lock);
116   if (ibuf) {
117     char filename[FILE_MAX];
118     BLI_strncpy(filename, image->name, sizeof(filename));
119     BLI_path_abs(filename, ID_BLEND_PATH(bmain, &image->id));
120
121     /* note, we purposefully ignore packed files here,
122      * developers need to explicitly write them via 'packed_files' */
123
124     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
131       IMB_colormanagement_colorspace_from_ibuf_ftype(&image->colorspace_settings, ibuf);
132
133       ibuf->userflags &= ~IB_BITMAPDIRTY;
134     }
135     else {
136       BKE_reportf(reports,
137                   RPT_ERROR,
138                   "Image '%s' could not be saved to '%s'",
139                   image->id.name + 2,
140                   image->name);
141     }
142   }
143   else {
144     BKE_reportf(reports, RPT_ERROR, "Image '%s' does not have any image data", image->id.name + 2);
145   }
146
147   BKE_image_release_ibuf(image, ibuf, lock);
148   WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, image);
149 }
150
151 static void rna_Image_pack(
152     Image *image, Main *bmain, bContext *C, ReportList *reports, const char *data, int data_len)
153 {
154   BKE_image_free_packedfiles(image);
155
156   if (data) {
157     char *data_dup = MEM_mallocN(sizeof(*data_dup) * (size_t)data_len, __func__);
158     memcpy(data_dup, data, (size_t)data_len);
159     BKE_image_packfiles_from_mem(reports, image, data_dup, (size_t)data_len);
160   }
161   else if (BKE_image_is_dirty(image)) {
162     BKE_image_memorypack(image);
163   }
164   else {
165     BKE_image_packfiles(reports, image, ID_BLEND_PATH(bmain, &image->id));
166   }
167
168   WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, image);
169 }
170
171 static void rna_Image_unpack(Image *image, Main *bmain, ReportList *reports, int method)
172 {
173   if (!BKE_image_has_packedfile(image)) {
174     BKE_report(reports, RPT_ERROR, "Image not packed");
175   }
176   else if (BKE_image_is_animated(image)) {
177     BKE_report(reports, RPT_ERROR, "Unpacking movies or image sequences not supported");
178     return;
179   }
180   else {
181     /* reports its own error on failure */
182     BKE_packedfile_unpack_image(bmain, reports, image, method);
183   }
184 }
185
186 static void rna_Image_reload(Image *image, Main *bmain)
187 {
188   BKE_image_signal(bmain, image, NULL, IMA_SIGNAL_RELOAD);
189   WM_main_add_notifier(NC_IMAGE | NA_EDITED, image);
190 }
191
192 static void rna_Image_update(Image *image, ReportList *reports)
193 {
194   ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
195
196   if (ibuf == NULL) {
197     BKE_reportf(reports, RPT_ERROR, "Image '%s' does not have any image data", image->id.name + 2);
198     return;
199   }
200
201   if (ibuf->rect) {
202     IMB_rect_from_float(ibuf);
203   }
204
205   ibuf->userflags |= IB_DISPLAY_BUFFER_INVALID;
206
207   BKE_image_release_ibuf(image, ibuf, NULL);
208 }
209
210 static void rna_Image_scale(Image *image, ReportList *reports, int width, int height)
211 {
212   if (!BKE_image_scale(image, width, height)) {
213     BKE_reportf(reports, RPT_ERROR, "Image '%s' does not have any image data", image->id.name + 2);
214   }
215 }
216
217 static int rna_Image_gl_load(Image *image, ReportList *reports, int frame)
218 {
219   ImageUser iuser = {NULL};
220   iuser.framenr = frame;
221   iuser.ok = true;
222
223   GPUTexture *tex = GPU_texture_from_blender(image, &iuser, GL_TEXTURE_2D);
224
225   if (tex == NULL) {
226     BKE_reportf(reports, RPT_ERROR, "Failed to load image texture '%s'", image->id.name + 2);
227     return (int)GL_INVALID_OPERATION;
228   }
229
230   return GL_NO_ERROR;
231 }
232
233 static int rna_Image_gl_touch(Image *image, ReportList *reports, int frame)
234 {
235   int error = GL_NO_ERROR;
236
237   BKE_image_tag_time(image);
238
239   if (image->gputexture[TEXTARGET_TEXTURE_2D] == NULL) {
240     error = rna_Image_gl_load(image, reports, frame);
241   }
242
243   return error;
244 }
245
246 static void rna_Image_gl_free(Image *image)
247 {
248   GPU_free_image(image);
249
250   /* remove the nocollect flag, image is available for garbage collection again */
251   image->flag &= ~IMA_NOCOLLECT;
252 }
253
254 static void rna_Image_filepath_from_user(Image *image, ImageUser *image_user, char *filepath)
255 {
256   BKE_image_user_file_path(image_user, image, filepath);
257 }
258
259 static void rna_Image_buffers_free(Image *image)
260 {
261   BKE_image_free_buffers_ex(image, true);
262 }
263
264 #else
265
266 void RNA_api_image_packed_file(StructRNA *srna)
267 {
268   FunctionRNA *func;
269
270   func = RNA_def_function(srna, "save", "rna_ImagePackedFile_save");
271   RNA_def_function_ui_description(func, "Save the packed file to its filepath");
272   RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_REPORTS);
273 }
274
275 void RNA_api_image(StructRNA *srna)
276 {
277   FunctionRNA *func;
278   PropertyRNA *parm;
279
280   func = RNA_def_function(srna, "save_render", "rna_Image_save_render");
281   RNA_def_function_ui_description(func,
282                                   "Save image to a specific path using a scenes render settings");
283   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
284   parm = RNA_def_string_file_path(func, "filepath", NULL, 0, "", "Save path");
285   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
286   RNA_def_pointer(func, "scene", "Scene", "", "Scene to take image parameters from");
287
288   func = RNA_def_function(srna, "save", "rna_Image_save");
289   RNA_def_function_ui_description(func, "Save image to its source path");
290   RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
291
292   func = RNA_def_function(srna, "pack", "rna_Image_pack");
293   RNA_def_function_ui_description(func, "Pack an image as embedded data into the .blend file");
294   RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
295   parm = RNA_def_property(func, "data", PROP_STRING, PROP_BYTESTRING);
296   RNA_def_property_ui_text(parm, "data", "Raw data (bytes, exact content of the embedded file)");
297   RNA_def_int(func,
298               "data_len",
299               0,
300               0,
301               INT_MAX,
302               "data_len",
303               "length of given data (mandatory if data is provided)",
304               0,
305               INT_MAX);
306
307   func = RNA_def_function(srna, "unpack", "rna_Image_unpack");
308   RNA_def_function_ui_description(func, "Save an image packed in the .blend file to disk");
309   RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_REPORTS);
310   RNA_def_enum(
311       func, "method", rna_enum_unpack_method_items, PF_USE_LOCAL, "method", "How to unpack");
312
313   func = RNA_def_function(srna, "reload", "rna_Image_reload");
314   RNA_def_function_flag(func, FUNC_USE_MAIN);
315   RNA_def_function_ui_description(func, "Reload the image from its source path");
316
317   func = RNA_def_function(srna, "update", "rna_Image_update");
318   RNA_def_function_ui_description(func, "Update the display image from the floating point buffer");
319   RNA_def_function_flag(func, FUNC_USE_REPORTS);
320
321   func = RNA_def_function(srna, "scale", "rna_Image_scale");
322   RNA_def_function_ui_description(func, "Scale the image in pixels");
323   RNA_def_function_flag(func, FUNC_USE_REPORTS);
324   parm = RNA_def_int(func, "width", 1, 1, 10000, "", "Width", 1, 10000);
325   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
326   parm = RNA_def_int(func, "height", 1, 1, 10000, "", "Height", 1, 10000);
327   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
328
329   func = RNA_def_function(srna, "gl_touch", "rna_Image_gl_touch");
330   RNA_def_function_ui_description(
331       func, "Delay the image from being cleaned from the cache due inactivity");
332   RNA_def_function_flag(func, FUNC_USE_REPORTS);
333   RNA_def_int(
334       func, "frame", 0, 0, INT_MAX, "Frame", "Frame of image sequence or movie", 0, INT_MAX);
335   /* return value */
336   parm = RNA_def_int(
337       func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
338   RNA_def_function_return(func, parm);
339
340   func = RNA_def_function(srna, "gl_load", "rna_Image_gl_load");
341   RNA_def_function_ui_description(
342       func,
343       "Load the image into an OpenGL texture. On success, image.bindcode will contain the "
344       "OpenGL texture bindcode. Colors read from the texture will be in scene linear color space "
345       "and have premultiplied or straight alpha matching the image alpha mode");
346   RNA_def_function_flag(func, FUNC_USE_REPORTS);
347   RNA_def_int(
348       func, "frame", 0, 0, INT_MAX, "Frame", "Frame of image sequence or movie", 0, INT_MAX);
349   /* return value */
350   parm = RNA_def_int(
351       func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
352   RNA_def_function_return(func, parm);
353
354   func = RNA_def_function(srna, "gl_free", "rna_Image_gl_free");
355   RNA_def_function_ui_description(func, "Free the image from OpenGL graphics memory");
356
357   /* path to an frame specified by image user */
358   func = RNA_def_function(srna, "filepath_from_user", "rna_Image_filepath_from_user");
359   RNA_def_function_ui_description(
360       func,
361       "Return the absolute path to the filepath of an image frame specified by the image user");
362   RNA_def_pointer(
363       func, "image_user", "ImageUser", "", "Image user of the image to get filepath for");
364   parm = RNA_def_string_file_path(func,
365                                   "filepath",
366                                   NULL,
367                                   FILE_MAX,
368                                   "File Path",
369                                   "The resulting filepath from the image and it's user");
370   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
371   RNA_def_function_output(func, parm);
372
373   func = RNA_def_function(srna, "buffers_free", "rna_Image_buffers_free");
374   RNA_def_function_ui_description(func, "Free the image buffers from memory");
375
376   /* TODO, pack/unpack, maybe should be generic functions? */
377 }
378
379 #endif