patch [#28684] Image pack/unpack() implementation.
[blender.git] / source / blender / makesrna / intern / rna_image_api.c
1 /*
2  * $Id$
3  * 
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Arystanbek Dyussenov
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/makesrna/intern/rna_image_api.c
30  *  \ingroup RNA
31  */
32
33
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <time.h>
38
39 #include "RNA_define.h"
40 #include "RNA_enum_types.h"
41
42 #include "DNA_packedFile_types.h"
43
44 #include "BIF_gl.h"
45
46 #ifdef RNA_RUNTIME
47
48 #include "BKE_image.h"
49 #include "BKE_packedFile.h"
50 #include "BKE_main.h"
51
52 #include "BKE_global.h" /* grr: G.main->name */
53
54 #include "IMB_imbuf.h"
55
56 #include "BIF_gl.h"
57 #include "GPU_draw.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_Image_save_render(Image *image, bContext *C, ReportList *reports, const char *path, Scene *scene)
65 {
66         ImBuf *ibuf;
67
68         if (scene == NULL) {
69                 scene = CTX_data_scene(C);
70         }
71
72         if (scene) {
73                 ImageUser iuser;
74                 void *lock;
75
76                 iuser.scene = scene;
77                 iuser.ok = 1;
78
79                 ibuf = BKE_image_acquire_ibuf(image, &iuser, &lock);
80
81                 if (ibuf == NULL) {
82                         BKE_reportf(reports, RPT_ERROR, "Couldn't acquire buffer from image");
83                 }
84                 else {
85                         /* temp swap out the color */
86                         const unsigned char imb_depth_back= ibuf->depth;
87                         const float dither_back= ibuf->dither; 
88                         ibuf->depth= scene->r.planes;
89                         ibuf->dither= scene->r.dither_intensity;
90                         if (!BKE_write_ibuf(ibuf, path, scene->r.imtype, scene->r.subimtype, scene->r.quality)) {
91                                 BKE_reportf(reports, RPT_ERROR, "Couldn't write image: %s", path);
92                         }
93                         ibuf->depth= imb_depth_back;
94                         ibuf->dither= dither_back;
95                 }
96
97                 BKE_image_release_ibuf(image, lock);
98         } else {
99                 BKE_reportf(reports, RPT_ERROR, "Scene not in context, couldn't get save parameters");
100         }
101 }
102
103 static void rna_Image_save(Image *image, ReportList *reports)
104 {
105         ImBuf *ibuf= BKE_image_get_ibuf(image, NULL);
106         if(ibuf) {
107                 char filename[FILE_MAXDIR + FILE_MAXFILE];
108                 BLI_strncpy(filename, image->name, sizeof(filename));
109                 BLI_path_abs(filename, G.main->name);
110
111                 if(image->packedfile) {
112                         if (writePackedFile(reports, image->name, image->packedfile, 0) != RET_OK) {
113                                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" could saved packed file to \"%s\"", image->id.name+2, image->name);
114                         }
115                 }
116                 else if (IMB_saveiff(ibuf, filename, ibuf->flags)) {
117                         image->type= IMA_TYPE_IMAGE;
118
119                         if(image->source==IMA_SRC_GENERATED)
120                                 image->source= IMA_SRC_FILE;
121
122                         ibuf->userflags &= ~IB_BITMAPDIRTY;
123                 }
124                 else {
125                         BKE_reportf(reports, RPT_ERROR, "Image \"%s\" could not be saved to \"%s\"", image->id.name+2, image->name);
126                 }
127         }
128         else {
129                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name+2);
130         }
131 }
132
133 static void rna_Image_pack(Image *image, ReportList *reports, int as_png)
134 {
135         ImBuf *ibuf = BKE_image_get_ibuf(image, NULL);
136
137         if (!as_png && (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))) {
138                 BKE_reportf(reports, RPT_ERROR, "Can't pack edited image from disk, only as internal PNG.");
139         }
140         else {
141                 if(as_png) {
142                         BKE_image_memorypack(image);
143                 }
144                 else {
145                         image->packedfile= newPackedFile(reports, image->name);
146                 }
147         }
148 }
149
150 static void rna_Image_unpack(Image *image, ReportList *reports, int method)
151 {
152         if (!image->packedfile) {
153                 BKE_report(reports, RPT_ERROR, "Image not packed");
154         }
155         else if (image->source==IMA_SRC_SEQUENCE || image->source==IMA_SRC_MOVIE) {
156                 BKE_report(reports, RPT_ERROR, "Unpacking movies or image sequences not supported.");
157                 return;
158         }
159         else {
160                 /* reports its own error on failier */
161                 unpackImage (reports, image, method);
162         }
163 }
164
165 static void rna_Image_reload(Image *image)
166 {
167         BKE_image_signal(image, NULL, IMA_SIGNAL_RELOAD);
168 }
169
170 static void rna_Image_update(Image *image, ReportList *reports)
171 {
172         ImBuf *ibuf= BKE_image_get_ibuf(image, NULL);
173
174         if(ibuf == NULL) {
175                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name+2);
176                 return;
177         }
178
179         IMB_rect_from_float(ibuf);
180 }
181
182 static int rna_Image_gl_load(Image *image, ReportList *reports, int filter, int mag)
183 {
184         ImBuf *ibuf;
185         unsigned int *bind = &image->bindcode;
186         int error = GL_NO_ERROR;
187
188         if(*bind)
189                 return error;
190
191         ibuf= BKE_image_get_ibuf(image, NULL);
192
193         if(ibuf == NULL || ibuf->rect == NULL ) {
194                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name+2);
195                 return (int)GL_INVALID_OPERATION;
196         }
197
198         /* could be made into a function? */
199         glGenTextures(1, (GLuint*)bind);
200         glBindTexture(GL_TEXTURE_2D, *bind);
201
202         if (filter != GL_NEAREST && filter != GL_LINEAR)
203                 error = (int)gluBuild2DMipmaps(GL_TEXTURE_2D, GL_RGBA, ibuf->x, ibuf->y, GL_RGBA, GL_UNSIGNED_INT, ibuf->rect);
204
205         if (!error) {
206                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, image->tpageflag & IMA_CLAMP_U ? GL_CLAMP : GL_REPEAT);
207                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, image->tpageflag & IMA_CLAMP_V ? GL_CLAMP : GL_REPEAT);
208                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, (GLint)filter);
209                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, (GLint)mag);
210                 glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
211                 glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, ibuf->x, ibuf->y, 0, GL_RGBA, GL_UNSIGNED_BYTE, ibuf->rect); 
212                 error = (int)glGetError();
213         }
214
215         if (error) {
216                 glDeleteTextures(1, (GLuint*)bind);
217                 image->bindcode = 0;
218         }
219
220         return error;
221 }
222
223 static void rna_Image_gl_free(Image *image)
224 {
225         GPU_free_image(image);
226
227         /* remove the nocollect flag, image is available for garbage collection again */
228         image->flag &= ~IMA_NOCOLLECT;
229 }
230
231 #else
232
233 void RNA_api_image(StructRNA *srna)
234 {
235         FunctionRNA *func;
236         PropertyRNA *parm;
237
238         func= RNA_def_function(srna, "save_render", "rna_Image_save_render");
239         RNA_def_function_ui_description(func, "Save image to a specific path using a scenes render settings");
240         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
241         parm= RNA_def_string_file_path(func, "filepath", "", 0, "", "Save path.");
242         RNA_def_property_flag(parm, PROP_REQUIRED);
243         RNA_def_pointer(func, "scene", "Scene", "", "Scene to take image parameters from");
244
245         func= RNA_def_function(srna, "save", "rna_Image_save");
246         RNA_def_function_ui_description(func, "Save image to its source path");
247         RNA_def_function_flag(func, FUNC_USE_REPORTS);
248
249         func= RNA_def_function(srna, "pack", "rna_Image_pack");
250         RNA_def_function_ui_description(func, "Pack an image as embedded data into the .blend file.");
251         RNA_def_function_flag(func, FUNC_USE_REPORTS);
252         RNA_def_boolean(func, "as_png", 0, "as_png", "Pack the image as PNG (needed for generated/dirty images)");
253
254         func= RNA_def_function(srna, "unpack", "rna_Image_unpack");
255         RNA_def_function_ui_description(func, "Save an image packed in the .blend file to disk");
256         RNA_def_function_flag(func, FUNC_USE_REPORTS);
257         RNA_def_enum(func, "method", unpack_method_items, PF_USE_LOCAL, "method", "How to unpack.");
258
259         func= RNA_def_function(srna, "reload", "rna_Image_reload");
260         RNA_def_function_ui_description(func, "Reload the image from its source path");
261
262         func= RNA_def_function(srna, "update", "rna_Image_update");
263         RNA_def_function_ui_description(func, "Update the display image from the floating point buffer");
264         RNA_def_function_flag(func, FUNC_USE_REPORTS);
265
266         func= RNA_def_function(srna, "gl_load", "rna_Image_gl_load");
267         RNA_def_function_ui_description(func, "Load the image into OpenGL graphics memory");
268         RNA_def_function_flag(func, FUNC_USE_REPORTS);
269         RNA_def_int(func, "filter", GL_LINEAR_MIPMAP_NEAREST, -INT_MAX, INT_MAX, "Filter", "The texture minifying function", -INT_MAX, INT_MAX);
270         RNA_def_int(func, "mag", GL_LINEAR, -INT_MAX, INT_MAX, "Magnification", "The texture magnification function", -INT_MAX, INT_MAX);
271         /* return value */
272         parm= RNA_def_int(func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
273         RNA_def_function_return(func, parm);
274
275         func= RNA_def_function(srna, "gl_free", "rna_Image_gl_free");
276         RNA_def_function_ui_description(func, "Free the image from OpenGL graphics memory");
277
278         /* TODO, pack/unpack, maybe should be generic functions? */
279 }
280
281 #endif
282