Fix #21073: toggling image premultiply did not reload image.
[blender.git] / source / blender / makesrna / intern / rna_image.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  * Contributor(s): Brecht Van Lommel
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_image_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "BKE_context.h"
36 #include "BKE_image.h"
37
38 #include "WM_types.h"
39
40 static EnumPropertyItem image_source_items[]= {
41         {IMA_SRC_FILE, "FILE", 0, "File", "Single image file"},
42         {IMA_SRC_SEQUENCE, "SEQUENCE", 0, "Sequence", "Multiple image files, as a sequence"},
43         {IMA_SRC_MOVIE, "MOVIE", 0, "Movie", "Movie file"},
44         {IMA_SRC_GENERATED, "GENERATED", 0, "Generated", "Generated image"},
45         {IMA_SRC_VIEWER, "VIEWER", 0, "Viewer", "Compositing node viewer"},
46         {0, NULL, 0, NULL, NULL}};
47
48 #ifdef RNA_RUNTIME
49
50 #include "IMB_imbuf_types.h"
51
52 static void rna_Image_animated_update(Main *bmain, Scene *scene, PointerRNA *ptr)
53 {
54         Image *ima= (Image*)ptr->data;
55         int  nr;
56
57         if(ima->flag & IMA_TWINANIM) {
58                 nr= ima->xrep*ima->yrep;
59                 if(ima->twsta>=nr) ima->twsta= 1;
60                 if(ima->twend>=nr) ima->twend= nr-1;
61                 if(ima->twsta>ima->twend) ima->twsta= 1;
62         }
63 }
64
65 static int rna_Image_dirty_get(PointerRNA *ptr)
66 {
67         Image *ima= (Image*)ptr->data;
68         ImBuf *ibuf;
69
70         for(ibuf=ima->ibufs.first; ibuf; ibuf=ibuf->next)
71                 if(ibuf->userflags & IB_BITMAPDIRTY)
72                         return 1;
73         
74         return 0;
75 }
76
77 static void rna_Image_source_update(Main *bmain, Scene *scene, PointerRNA *ptr)
78 {
79         Image *ima= ptr->id.data;
80         BKE_image_signal(ima, NULL, IMA_SIGNAL_SRC_CHANGE);
81 }
82
83 static void rna_Image_fields_update(Main *bmain, Scene *scene, PointerRNA *ptr)
84 {
85         Image *ima= ptr->id.data;
86         ImBuf *ibuf;
87         void *lock;
88
89         ibuf= BKE_image_acquire_ibuf(ima, NULL, &lock);
90
91         if(ibuf) {
92                 short nr= 0;
93
94                 if(!(ima->flag & IMA_FIELDS) && (ibuf->flags & IB_fields)) nr= 1;
95                 if((ima->flag & IMA_FIELDS) && !(ibuf->flags & IB_fields)) nr= 1;
96
97                 if(nr)
98                         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
99         }
100
101         BKE_image_release_ibuf(ima, lock);
102 }
103
104 static void rna_Image_reload_update(Main *bmain, Scene *scene, PointerRNA *ptr)
105 {
106         Image *ima= ptr->id.data;
107         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
108 }
109
110 static void rna_Image_generated_update(Main *bmain, Scene *scene, PointerRNA *ptr)
111 {
112         Image *ima= ptr->id.data;
113         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
114 }
115
116 static void rna_ImageUser_update(Main *bmain, Scene *scene, PointerRNA *ptr)
117 {
118         ImageUser *iuser= ptr->data;
119
120         BKE_image_user_calc_frame(iuser, scene->r.cfra, 0);
121 }
122
123 static EnumPropertyItem *rna_Image_source_itemf(bContext *C, PointerRNA *ptr, int *free)
124 {
125         Image *ima= (Image*)ptr->data;
126         EnumPropertyItem *item= NULL;
127         int totitem= 0;
128         
129         if(ima->source == IMA_SRC_VIEWER) {
130                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
131         }
132         else {
133                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
134                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
135                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
136                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
137         }
138
139         RNA_enum_item_end(&item, &totitem);
140         *free= 1;
141
142         return item;
143 }
144
145 static int rna_Image_has_data_get(PointerRNA *ptr)
146 {
147         Image *im= (Image*)ptr->data;
148
149         if (im->ibufs.first)
150                 return 1;
151
152         return 0;
153 }
154
155 static void rna_Image_size_get(PointerRNA *ptr,int *values)
156 {
157         Image *im= (Image*)ptr->data;
158         ImBuf *ibuf;
159         void *lock;
160
161         ibuf = BKE_image_acquire_ibuf(im, NULL , &lock);
162         if (ibuf) {
163                 values[0]= ibuf->x;
164                 values[1]= ibuf->y;
165         }
166     else {
167                 values[0]= 0;
168                 values[1]= 0;
169         }
170
171         BKE_image_release_ibuf(im, lock);
172 }
173
174
175 static int rna_Image_depth_get(PointerRNA *ptr)
176 {
177         Image *im= (Image*)ptr->data;
178         ImBuf *ibuf;
179         void *lock;
180         int depth;
181         
182         ibuf= BKE_image_acquire_ibuf(im, NULL, &lock);
183
184         if(!ibuf)
185                 depth= 0;
186         else if(ibuf->rect_float)
187                 depth= 128;
188         else
189                 depth= ibuf->depth;
190
191         BKE_image_release_ibuf(im, lock);
192
193         return depth;
194 }
195
196 #else
197
198 static void rna_def_imageuser(BlenderRNA *brna)
199 {
200         StructRNA *srna;
201         PropertyRNA *prop;
202
203         srna= RNA_def_struct(brna, "ImageUser", NULL);
204         RNA_def_struct_ui_text(srna, "Image User", "Parameters defining how an Image datablock is used by another datablock");
205
206         prop= RNA_def_property(srna, "auto_refresh", PROP_BOOLEAN, PROP_NONE);
207         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
208         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes");
209         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
210
211         /* animation */
212         prop= RNA_def_property(srna, "cyclic", PROP_BOOLEAN, PROP_NONE);
213         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
214         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie");
215         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
216
217         prop= RNA_def_property(srna, "frames", PROP_INT, PROP_NONE);
218         RNA_def_property_range(prop, 0, MAXFRAMEF);
219         RNA_def_property_ui_text(prop, "Frames", "Sets the number of images of a movie to use");
220         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
221
222         prop= RNA_def_property(srna, "offset", PROP_INT, PROP_NONE);
223         RNA_def_property_range(prop, -MAXFRAMEF, MAXFRAMEF);
224         RNA_def_property_ui_text(prop, "Offset", "Offsets the number of the frame to use in the animation");
225         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
226
227         prop= RNA_def_property(srna, "start_frame", PROP_INT, PROP_TIME);
228         RNA_def_property_int_sdna(prop, NULL, "sfra");
229         RNA_def_property_range(prop, 1.0f, MAXFRAMEF);
230         RNA_def_property_ui_text(prop, "Start Frame", "Sets the global starting frame of the movie");
231         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
232
233         prop= RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
234         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
235         RNA_def_property_range(prop, -MAXFRAMEF, MAXFRAMEF);
236         RNA_def_property_ui_text(prop, "Fields per Frame", "The number of fields per rendered frame (2 fields is 1 image)");
237         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
238
239         prop= RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
240         RNA_def_property_int_sdna(prop, NULL, "layer");
241         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
242         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image");
243
244         prop= RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
245         RNA_def_property_int_sdna(prop, NULL, "pass");
246         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
247         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image");
248 }
249
250 static void rna_def_image(BlenderRNA *brna)
251 {
252         StructRNA *srna;
253         PropertyRNA *prop;
254         static const EnumPropertyItem prop_type_items[]= {
255                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
256                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
257                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
258                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
259                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
260                 {0, NULL, 0, NULL, NULL}};
261         static const EnumPropertyItem prop_generated_type_items[]= {
262                 {0, "BLANK", 0, "Blank", "Generate a blank image"},
263                 {1, "UVGRID", 0, "UV Grid", "Generated grid to test UV mappings"},
264                 {0, NULL, 0, NULL, NULL}};
265         static const EnumPropertyItem prop_mapping_items[]= {
266                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
267                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
268                 {0, NULL, 0, NULL, NULL}};
269         static const EnumPropertyItem prop_field_order_items[]= {
270                 {0, "EVEN", 0, "Upper First", "Upper field first"},
271                 {IMA_STD_FIELD, "ODD", 0, "Lower First", "Lower field first"},
272                 {0, NULL, 0, NULL, NULL}};
273
274         srna= RNA_def_struct(brna, "Image", "ID");
275         RNA_def_struct_ui_text(srna, "Image", "Image datablock referencing an external or packed image");
276         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
277
278         prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
279         RNA_def_property_string_sdna(prop, NULL, "name");
280         RNA_def_property_ui_text(prop, "Filename", "Image/Movie file name");
281         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_reload_update");
282
283         prop= RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
284         RNA_def_property_enum_items(prop, image_source_items);
285         RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_Image_source_itemf");
286         RNA_def_property_ui_text(prop, "Source", "Where the image comes from");
287         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_source_update");
288
289         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
290         RNA_def_property_enum_items(prop, prop_type_items);
291         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
292         RNA_def_property_ui_text(prop, "Type", "How to generate the image");
293         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
294
295         prop= RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
296         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
297         RNA_def_property_ui_text(prop, "Packed File", "");
298         
299         prop= RNA_def_property(srna, "field_order", PROP_ENUM, PROP_NONE);
300         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
301         RNA_def_property_enum_items(prop, prop_field_order_items);
302         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields. Select which lines are displayed first");
303         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
304         
305         /* booleans */
306         prop= RNA_def_property(srna, "fields", PROP_BOOLEAN, PROP_NONE);
307         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
308         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image");
309         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_fields_update");
310
311         prop= RNA_def_property(srna, "antialias", PROP_BOOLEAN, PROP_NONE);
312         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANTIALI);
313         RNA_def_property_ui_text(prop, "Anti-alias", "Toggles image anti-aliasing, only works with solid colors");
314         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
315
316         prop= RNA_def_property(srna, "premultiply", PROP_BOOLEAN, PROP_NONE);
317         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_DO_PREMUL);
318         RNA_def_property_ui_text(prop, "Premultiply", "Convert RGB from key alpha to premultiplied alpha");
319         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_reload_update");
320
321         prop= RNA_def_property(srna, "dirty", PROP_BOOLEAN, PROP_NONE);
322         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
323         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
324         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved");
325
326         /* generated image (image_generated_change_cb) */
327         prop= RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
328         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
329         RNA_def_property_enum_items(prop, prop_generated_type_items);
330         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
331         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
332
333         prop= RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
334         RNA_def_property_int_sdna(prop, NULL, "gen_x");
335         RNA_def_property_range(prop, 1, 16384);
336         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
337         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
338
339         prop= RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
340         RNA_def_property_int_sdna(prop, NULL, "gen_y");
341         RNA_def_property_range(prop, 1, 16384);
342         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
343         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
344
345         /* realtime properties */
346         prop= RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
347         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
348         RNA_def_property_enum_items(prop, prop_mapping_items);
349         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine");
350         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
351
352         prop= RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
353         RNA_def_property_float_sdna(prop, NULL, "aspx");
354         RNA_def_property_array(prop, 2);
355         RNA_def_property_range(prop, 0.1f, 5000.0f);
356         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering");
357         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
358
359         prop= RNA_def_property(srna, "animated", PROP_BOOLEAN, PROP_NONE);
360         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
361         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine");
362         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
363
364         prop= RNA_def_property(srna, "animation_start", PROP_INT, PROP_NONE);
365         RNA_def_property_int_sdna(prop, NULL, "twsta");
366         RNA_def_property_range(prop, 0, 128);
367         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture");
368         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
369
370         prop= RNA_def_property(srna, "animation_end", PROP_INT, PROP_NONE);
371         RNA_def_property_int_sdna(prop, NULL, "twend");
372         RNA_def_property_range(prop, 0, 128);
373         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture");
374         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
375
376         prop= RNA_def_property(srna, "animation_speed", PROP_INT, PROP_NONE);
377         RNA_def_property_int_sdna(prop, NULL, "animspeed");
378         RNA_def_property_range(prop, 1, 100);
379         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second");
380         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
381
382         prop= RNA_def_property(srna, "tiles", PROP_BOOLEAN, PROP_NONE);
383         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
384         RNA_def_property_ui_text(prop, "Tiles", "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces)");
385         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
386
387         prop= RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
388         RNA_def_property_int_sdna(prop, NULL, "xrep");
389         RNA_def_property_range(prop, 1, 16);
390         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction");
391         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
392
393         prop= RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
394         RNA_def_property_int_sdna(prop, NULL, "yrep");
395         RNA_def_property_range(prop, 1, 16);
396         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction");
397         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
398
399         prop= RNA_def_property(srna, "clamp_x", PROP_BOOLEAN, PROP_NONE);
400         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
401         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally");
402         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
403
404         prop= RNA_def_property(srna, "clamp_y", PROP_BOOLEAN, PROP_NONE);
405         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
406         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically");
407         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
408
409         /*
410            Image.has_data and Image.depth are temporary,
411            Update import_obj.py when they are replaced (Arystan)
412         */
413         prop= RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
414         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
415         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
416         RNA_def_property_ui_text(prop, "Has data", "True if this image has data");
417
418         prop= RNA_def_property(srna, "depth", PROP_INT, PROP_NONE);
419         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
420         RNA_def_property_ui_text(prop, "Depth", "Image bit depth");
421         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
422
423         prop= RNA_def_int_vector(srna, "size" , 2 , NULL , 0, 0, "Size" , "Width and height in pixels, zero when image data cant be loaded" , 0 , 0);
424         RNA_def_property_int_funcs(prop, "rna_Image_size_get" , NULL, NULL);
425         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
426
427         RNA_api_image(srna);
428 }
429
430 void RNA_def_image(BlenderRNA *brna)
431 {
432         rna_def_image(brna);
433         rna_def_imageuser(brna);
434 }
435
436 #endif
437