patch [#23144] bpy.Image.gl_load() -- fix
[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 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #include <time.h>
33
34 #include "RNA_define.h"
35
36 #include "BIF_gl.h"
37
38 #ifdef RNA_RUNTIME
39
40 #include "BKE_image.h"
41 #include "BKE_packedFile.h"
42 #include "BKE_main.h"
43 #include "BKE_utildefines.h"
44 #include "BKE_global.h" /* grr: G.sce */
45
46 #include "IMB_imbuf.h"
47
48 #include "BIF_gl.h"
49 #include "GPU_draw.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_Image_save_render(Image *image, bContext *C, ReportList *reports, char *path, Scene *scene)
57 {
58         ImBuf *ibuf;
59
60         if (scene == NULL) {
61                 scene = CTX_data_scene(C);
62         }
63
64         if (scene) {
65                 ImageUser iuser;
66                 void *lock;
67
68                 iuser.scene = scene;
69                 iuser.ok = 1;
70
71                 ibuf = BKE_image_acquire_ibuf(image, &iuser, &lock);
72
73                 if (ibuf == NULL) {
74                         BKE_reportf(reports, RPT_ERROR, "Couldn't acquire buffer from image");
75                 }
76
77                 if (!BKE_write_ibuf(NULL, ibuf, path, scene->r.imtype, scene->r.subimtype, scene->r.quality)) {
78                         BKE_reportf(reports, RPT_ERROR, "Couldn't write image: %s", path);
79                 }
80         } else {
81                 BKE_reportf(reports, RPT_ERROR, "Scene not in context, couldn't get save parameters");
82         }
83 }
84
85 static void rna_Image_save(Image *image, ReportList *reports)
86 {
87         ImBuf *ibuf= BKE_image_get_ibuf(image, NULL);
88         if(ibuf) {
89                 char filename[FILE_MAXDIR + FILE_MAXFILE];
90                 BLI_strncpy(filename, image->name, sizeof(filename));
91                 BLI_path_abs(filename, G.sce);
92
93                 if(image->packedfile) {
94                         if (writePackedFile(reports, image->name, image->packedfile, 0) != RET_OK) {
95                                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" could saved packed file to \"%s\"", image->id.name+2, image->name);
96                         }
97                 }
98                 else if (IMB_saveiff(ibuf, filename, ibuf->flags)) {
99                         image->type= IMA_TYPE_IMAGE;
100
101                         if(image->source==IMA_SRC_GENERATED)
102                                 image->source= IMA_SRC_FILE;
103
104                         ibuf->userflags &= ~IB_BITMAPDIRTY;
105                 }
106                 else {
107                         BKE_reportf(reports, RPT_ERROR, "Image \"%s\" could not be saved to \"%s\"", image->id.name+2, image->name);
108                 }
109         }
110         else {
111                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name+2);
112         }
113 }
114
115 static void rna_Image_reload(Image *image)
116 {
117         BKE_image_signal(image, NULL, IMA_SIGNAL_RELOAD);
118 }
119
120 static void rna_Image_update(Image *image, ReportList *reports)
121 {
122         ImBuf *ibuf= BKE_image_get_ibuf(image, NULL);
123
124         if(ibuf == NULL) {
125                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name+2);
126                 return;
127         }
128
129         IMB_rect_from_float(ibuf);
130 }
131
132 static int rna_Image_gl_load(Image *image, ReportList *reports, int filter, int mag)
133 {
134         ImBuf *ibuf;
135         unsigned int *bind = &image->bindcode;
136         int error = GL_NO_ERROR;
137
138         if(*bind)
139                 return error;
140
141         ibuf= BKE_image_get_ibuf(image, NULL);
142
143         if(ibuf == NULL || ibuf->rect == NULL ) {
144                 BKE_reportf(reports, RPT_ERROR, "Image \"%s\" does not have any image data", image->id.name+2);
145                 return (int)GL_INVALID_OPERATION;
146         }
147
148         /* could be made into a function? */
149         glGenTextures(1, (GLuint*)bind);
150         glBindTexture(GL_TEXTURE_2D, *bind);
151
152         if (filter != GL_NEAREST && filter != GL_LINEAR)
153                 error = (int)gluBuild2DMipmaps(GL_TEXTURE_2D, GL_RGBA, ibuf->x, ibuf->y, GL_RGBA, GL_UNSIGNED_INT, ibuf->rect);
154
155         if (!error) {
156                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, image->tpageflag & IMA_CLAMP_U ? GL_CLAMP : GL_REPEAT);
157                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, image->tpageflag & IMA_CLAMP_V ? GL_CLAMP : GL_REPEAT);
158                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, (GLint)filter);
159                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, (GLint)mag);
160                 glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
161                 glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, ibuf->x, ibuf->y, 0, GL_RGBA, GL_UNSIGNED_BYTE, ibuf->rect); 
162                 error = (int)glGetError();
163         }
164
165         if (error) {
166                 glDeleteTextures(1, (GLuint*)bind);
167                 image->bindcode = 0;
168         }
169
170         return error;
171 }
172
173 static void rna_Image_gl_free(Image *image)
174 {
175         GPU_free_image(image);
176
177         /* remove the nocollect flag, image is available for garbage collection again */
178         image->flag &= ~IMA_NOCOLLECT;
179 }
180
181 #else
182
183 void RNA_api_image(StructRNA *srna)
184 {
185         FunctionRNA *func;
186         PropertyRNA *parm;
187
188         func= RNA_def_function(srna, "save_render", "rna_Image_save_render");
189         RNA_def_function_ui_description(func, "Save image to a specific path using a scenes render settings");
190         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
191         parm= RNA_def_string(func, "filepath", "", 0, "", "Save path.");
192         RNA_def_property_flag(parm, PROP_REQUIRED);
193         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene to take image parameters from");
194
195         func= RNA_def_function(srna, "save", "rna_Image_save");
196         RNA_def_function_ui_description(func, "Save image to its source path");
197         RNA_def_function_flag(func, FUNC_USE_REPORTS);
198
199         func= RNA_def_function(srna, "reload", "rna_Image_reload");
200         RNA_def_function_ui_description(func, "Reload the image from its source path");
201
202         func= RNA_def_function(srna, "update", "rna_Image_update");
203         RNA_def_function_ui_description(func, "Update the display image from the floating point buffer");
204         RNA_def_function_flag(func, FUNC_USE_REPORTS);
205
206         func= RNA_def_function(srna, "gl_load", "rna_Image_gl_load");
207         RNA_def_function_ui_description(func, "Load the image into OpenGL graphics memory");
208         RNA_def_function_flag(func, FUNC_USE_REPORTS);
209         parm= RNA_def_int(func, "filter", GL_LINEAR_MIPMAP_NEAREST, -INT_MAX, INT_MAX, "Filter", "The texture minifying function", -INT_MAX, INT_MAX);
210         parm= RNA_def_int(func, "mag", GL_LINEAR, -INT_MAX, INT_MAX, "Magnification", "The texture magnification function", -INT_MAX, INT_MAX);
211         /* return value */
212         parm= RNA_def_int(func, "error", 0, -INT_MAX, INT_MAX, "Error", "OpenGL error value", -INT_MAX, INT_MAX);
213         RNA_def_function_return(func, parm);
214
215         func= RNA_def_function(srna, "gl_free", "rna_Image_gl_free");
216         RNA_def_function_ui_description(func, "Free the image from OpenGL graphics memory");
217
218         /* TODO, pack/unpack, maybe should be generic functions? */
219 }
220
221 #endif
222