Merged changes in the trunk up to revision 42116.
[blender.git] / source / blender / makesrna / intern / rna_image_api.c
1 /*
2  * 
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. 
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2009 Blender Foundation.
20  * All rights reserved.
21  *
22  * 
23  * Contributor(s): Arystanbek Dyussenov
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/makesrna/intern/rna_image_api.c
29  *  \ingroup RNA
30  */
31
32
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include <string.h>
36 #include <time.h>
37
38 #include "RNA_define.h"
39 #include "RNA_enum_types.h"
40
41 #include "DNA_packedFile_types.h"
42
43 #include "BIF_gl.h"
44
45 #ifdef RNA_RUNTIME
46
47 #include "BKE_image.h"
48 #include "BKE_packedFile.h"
49 #include "BKE_main.h"
50
51 #include "BKE_global.h" /* grr: G.main->name */
52
53 #include "IMB_imbuf.h"
54
55 #include "BIF_gl.h"
56 #include "GPU_draw.h"
57
58 #include "DNA_image_types.h"
59 #include "DNA_scene_types.h"
60
61 #include "MEM_guardedalloc.h"
62
63 static void rna_Image_save_render(Image *image, bContext *C, ReportList *reports, const char *path, Scene *scene)
64 {
65         ImBuf *ibuf;
66
67         if (scene == NULL) {
68                 scene = CTX_data_scene(C);
69         }
70
71         if (scene) {
72                 ImageUser iuser;
73                 void *lock;
74
75                 iuser.scene = scene;
76                 iuser.ok = 1;
77
78                 ibuf = BKE_image_acquire_ibuf(image, &iuser, &lock);
79
80                 if (ibuf == NULL) {
81                         BKE_reportf(reports, RPT_ERROR, "Couldn't acquire buffer from image");
82                 }
83                 else {
84                         /* temp swap out the color */
85                         const unsigned char imb_planes_back= ibuf->planes;
86                         const float dither_back= ibuf->dither; 
87                         ibuf->planes= scene->r.im_format.planes;
88                         ibuf->dither= scene->r.dither_intensity;
89                         if (!BKE_write_ibuf(ibuf, path, &scene->r.im_format)) {
90                                 BKE_reportf(reports, RPT_ERROR, "Couldn't write image: %s", path);
91                         }
92                         ibuf->planes= imb_planes_back;
93                         ibuf->dither= dither_back;
94                 }
95
96                 BKE_image_release_ibuf(image, lock);
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 int rna_Image_gl_load(Image *image, ReportList *reports, int filter, int mag)
182 {
183         ImBuf *ibuf;
184         unsigned int *bind = &image->bindcode;
185         int error = GL_NO_ERROR;
186
187         if(*bind)
188                 return error;
189
190         ibuf= BKE_image_get_ibuf(image, NULL);
191
192         if(ibuf == NULL || ibuf->rect == NULL ) {
193                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name+2);
194                 return (int)GL_INVALID_OPERATION;
195         }
196
197         /* could be made into a function? */
198         glGenTextures(1, (GLuint*)bind);
199         glBindTexture(GL_TEXTURE_2D, *bind);
200
201         if (filter != GL_NEAREST && filter != GL_LINEAR)
202                 error = (int)gluBuild2DMipmaps(GL_TEXTURE_2D, GL_RGBA, ibuf->x, ibuf->y, GL_RGBA, GL_UNSIGNED_INT, ibuf->rect);
203
204         if (!error) {
205                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, image->tpageflag & IMA_CLAMP_U ? GL_CLAMP : GL_REPEAT);
206                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, image->tpageflag & IMA_CLAMP_V ? GL_CLAMP : GL_REPEAT);
207                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, (GLint)filter);
208                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, (GLint)mag);
209                 glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
210                 glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, ibuf->x, ibuf->y, 0, GL_RGBA, GL_UNSIGNED_BYTE, ibuf->rect); 
211                 error = (int)glGetError();
212         }
213
214         if (error) {
215                 glDeleteTextures(1, (GLuint*)bind);
216                 image->bindcode = 0;
217         }
218
219         return error;
220 }
221
222 static void rna_Image_gl_free(Image *image)
223 {
224         GPU_free_image(image);
225
226         /* remove the nocollect flag, image is available for garbage collection again */
227         image->flag &= ~IMA_NOCOLLECT;
228 }
229
230 #else
231
232 void RNA_api_image(StructRNA *srna)
233 {
234         FunctionRNA *func;
235         PropertyRNA *parm;
236
237         func= RNA_def_function(srna, "save_render", "rna_Image_save_render");
238         RNA_def_function_ui_description(func, "Save image to a specific path using a scenes render settings");
239         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
240         parm= RNA_def_string_file_path(func, "filepath", "", 0, "", "Save path");
241         RNA_def_property_flag(parm, PROP_REQUIRED);
242         RNA_def_pointer(func, "scene", "Scene", "", "Scene to take image parameters from");
243
244         func= RNA_def_function(srna, "save", "rna_Image_save");
245         RNA_def_function_ui_description(func, "Save image to its source path");
246         RNA_def_function_flag(func, FUNC_USE_REPORTS);
247
248         func= RNA_def_function(srna, "pack", "rna_Image_pack");
249         RNA_def_function_ui_description(func, "Pack an image as embedded data into the .blend file");
250         RNA_def_function_flag(func, FUNC_USE_REPORTS);
251         RNA_def_boolean(func, "as_png", 0, "as_png", "Pack the image as PNG (needed for generated/dirty images)");
252
253         func= RNA_def_function(srna, "unpack", "rna_Image_unpack");
254         RNA_def_function_ui_description(func, "Save an image packed in the .blend file to disk");
255         RNA_def_function_flag(func, FUNC_USE_REPORTS);
256         RNA_def_enum(func, "method", unpack_method_items, PF_USE_LOCAL, "method", "How to unpack");
257
258         func= RNA_def_function(srna, "reload", "rna_Image_reload");
259         RNA_def_function_ui_description(func, "Reload the image from its source path");
260
261         func= RNA_def_function(srna, "update", "rna_Image_update");
262         RNA_def_function_ui_description(func, "Update the display image from the floating point buffer");
263         RNA_def_function_flag(func, FUNC_USE_REPORTS);
264
265         func= RNA_def_function(srna, "gl_load", "rna_Image_gl_load");
266         RNA_def_function_ui_description(func, "Load the image into OpenGL graphics memory");
267         RNA_def_function_flag(func, FUNC_USE_REPORTS);
268         RNA_def_int(func, "filter", GL_LINEAR_MIPMAP_NEAREST, -INT_MAX, INT_MAX, "Filter",
269                     "The texture minifying function", -INT_MAX, INT_MAX);
270         RNA_def_int(func, "mag", GL_LINEAR, -INT_MAX, INT_MAX, "Magnification",
271                     "The texture magnification function", -INT_MAX, INT_MAX);
272         /* return value */
273         parm= RNA_def_int(func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
274         RNA_def_function_return(func, parm);
275
276         func= RNA_def_function(srna, "gl_free", "rna_Image_gl_free");
277         RNA_def_function_ui_description(func, "Free the image from OpenGL graphics memory");
278
279         /* TODO, pack/unpack, maybe should be generic functions? */
280 }
281
282 #endif
283