merge with trunk/2.5 at r23876
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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(bContext *C, 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(bContext *C, 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(bContext *C, 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(bContext *C, PointerRNA *ptr)
105 {
106         Image *ima= ptr->id.data;
107         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
108         printf("reload %p\n", ima);
109 }
110
111 static void rna_Image_generated_update(bContext *C, PointerRNA *ptr)
112 {
113         Image *ima= ptr->id.data;
114         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
115 }
116
117 static void rna_ImageUser_update(bContext *C, PointerRNA *ptr)
118 {
119     Scene *scene= CTX_data_scene(C);
120         ImageUser *iuser= ptr->data;
121
122         BKE_image_user_calc_imanr(iuser, scene->r.cfra, 0);
123 }
124
125 static EnumPropertyItem *rna_Image_source_itemf(bContext *C, PointerRNA *ptr, int *free)
126 {
127         Image *ima= (Image*)ptr->data;
128         EnumPropertyItem *item= NULL;
129         int totitem= 0;
130         
131         if(ima->source == IMA_SRC_VIEWER) {
132                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
133         }
134         else {
135                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
136                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
137                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
138                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
139         }
140
141         RNA_enum_item_end(&item, &totitem);
142         *free= 1;
143
144         return item;
145 }
146
147 static int rna_Image_has_data_get(PointerRNA *ptr)
148 {
149         Image *im= (Image*)ptr->data;
150
151         if (im->ibufs.first)
152                 return 1;
153
154         return 0;
155 }
156
157 static int rna_Image_depth_get(PointerRNA *ptr)
158 {
159         Image *im= (Image*)ptr->data;
160         ImBuf *ibuf;
161         void *lock;
162         int depth;
163         
164         ibuf= BKE_image_acquire_ibuf(im, NULL, &lock);
165
166         if(!ibuf)
167                 depth= 0;
168         else if(ibuf->rect_float)
169                 depth= 128;
170         else
171                 depth= ibuf->depth;
172
173         BKE_image_release_ibuf(im, lock);
174
175         return depth;
176 }
177
178 #else
179
180 static void rna_def_imageuser(BlenderRNA *brna)
181 {
182         StructRNA *srna;
183         PropertyRNA *prop;
184
185         srna= RNA_def_struct(brna, "ImageUser", NULL);
186         RNA_def_struct_ui_text(srna, "Image User", "Parameters defining how an Image datablock is used by another datablock.");
187
188         prop= RNA_def_property(srna, "auto_refresh", PROP_BOOLEAN, PROP_NONE);
189         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
190         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes.");
191         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
192
193         /* animation */
194         prop= RNA_def_property(srna, "cyclic", PROP_BOOLEAN, PROP_NONE);
195         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
196         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie.");
197         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
198
199         prop= RNA_def_property(srna, "frames", PROP_INT, PROP_NONE);
200         RNA_def_property_range(prop, 0, MAXFRAMEF);
201         RNA_def_property_ui_text(prop, "Frames", "Sets the number of images of a movie to use.");
202         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
203
204         prop= RNA_def_property(srna, "offset", PROP_INT, PROP_NONE);
205         RNA_def_property_range(prop, -MAXFRAMEF, MAXFRAMEF);
206         RNA_def_property_ui_text(prop, "Offset", "Offsets the number of the frame to use in the animation.");
207         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
208
209         prop= RNA_def_property(srna, "start_frame", PROP_INT, PROP_TIME);
210         RNA_def_property_int_sdna(prop, NULL, "sfra");
211         RNA_def_property_range(prop, 1.0f, MAXFRAMEF);
212         RNA_def_property_ui_text(prop, "Start Frame", "Sets the global starting frame of the movie.");
213         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
214
215         prop= RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
216         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
217         RNA_def_property_range(prop, -MAXFRAMEF, MAXFRAMEF);
218         RNA_def_property_ui_text(prop, "Fields per Frame", "The number of fields per rendered frame (2 fields is 1 image).");
219         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
220
221         prop= RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
222         RNA_def_property_int_sdna(prop, NULL, "layer");
223         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
224         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image.");
225
226         prop= RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
227         RNA_def_property_int_sdna(prop, NULL, "pass");
228         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
229         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image.");
230 }
231
232 static void rna_def_image(BlenderRNA *brna)
233 {
234         StructRNA *srna;
235         PropertyRNA *prop;
236         static const EnumPropertyItem prop_type_items[]= {
237                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
238                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
239                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
240                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
241                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
242                 {0, NULL, 0, NULL, NULL}};
243         static const EnumPropertyItem prop_generated_type_items[]= {
244                 {0, "BLANK", 0, "Blank", "Generate a blank image"},
245                 {1, "UVGRID", 0, "UV Grid", "Generated grid to test UV mappings"},
246                 {0, NULL, 0, NULL, NULL}};
247         static const EnumPropertyItem prop_mapping_items[]= {
248                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
249                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
250                 {0, NULL, 0, NULL, NULL}};
251         static const EnumPropertyItem prop_field_order_items[]= {
252                 {0, "EVEN", 0, "Even", "Even Fields first"},
253                 {IMA_STD_FIELD, "ODD", 0, "Odd", "Odd Fields first"},
254                 {0, NULL, 0, NULL, NULL}};
255
256         srna= RNA_def_struct(brna, "Image", "ID");
257         RNA_def_struct_ui_text(srna, "Image", "Image datablock referencing an external or packed image.");
258         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
259
260         prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
261         RNA_def_property_string_sdna(prop, NULL, "name");
262         RNA_def_property_ui_text(prop, "Filename", "Image/Movie file name.");
263         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_reload_update");
264
265         prop= RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
266         RNA_def_property_enum_items(prop, image_source_items);
267         RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_Image_source_itemf");
268         RNA_def_property_ui_text(prop, "Source", "Where the image comes from.");
269         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_source_update");
270
271         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
272         RNA_def_property_enum_items(prop, prop_type_items);
273         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
274         RNA_def_property_ui_text(prop, "Type", "How to generate the image.");
275         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
276
277         prop= RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
278         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
279         RNA_def_property_ui_text(prop, "Packed File", "");
280         
281         prop= RNA_def_property(srna, "field_order", PROP_ENUM, PROP_NONE);
282         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
283         RNA_def_property_enum_items(prop, prop_field_order_items);
284         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields. Select which lines are displayed first.");
285         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
286         
287         /* booleans */
288         prop= RNA_def_property(srna, "fields", PROP_BOOLEAN, PROP_NONE);
289         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
290         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image.");
291         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_fields_update");
292
293         prop= RNA_def_property(srna, "antialias", PROP_BOOLEAN, PROP_NONE);
294         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANTIALI);
295         RNA_def_property_ui_text(prop, "Anti-alias", "Toggles image anti-aliasing, only works with solid colors");
296         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
297
298         prop= RNA_def_property(srna, "premultiply", PROP_BOOLEAN, PROP_NONE);
299         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_DO_PREMUL);
300         RNA_def_property_ui_text(prop, "Premultiply", "Convert RGB from key alpha to premultiplied alpha.");
301         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
302
303         prop= RNA_def_property(srna, "dirty", PROP_BOOLEAN, PROP_NONE);
304         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
305         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
306         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved.");
307
308         /* generated image (image_generated_change_cb) */
309         prop= RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
310         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
311         RNA_def_property_enum_items(prop, prop_generated_type_items);
312         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type.");
313         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
314
315         prop= RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
316         RNA_def_property_int_sdna(prop, NULL, "gen_x");
317         RNA_def_property_range(prop, 1, 16384);
318         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width.");
319         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
320
321         prop= RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
322         RNA_def_property_int_sdna(prop, NULL, "gen_y");
323         RNA_def_property_range(prop, 1, 16384);
324         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height.");
325         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
326
327         /* realtime properties */
328         prop= RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
329         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
330         RNA_def_property_enum_items(prop, prop_mapping_items);
331         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine.");
332         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
333
334         prop= RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
335         RNA_def_property_float_sdna(prop, NULL, "aspx");
336         RNA_def_property_array(prop, 2);
337         RNA_def_property_range(prop, 0.1f, 5000.0f);
338         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering.");
339         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
340
341         prop= RNA_def_property(srna, "animated", PROP_BOOLEAN, PROP_NONE);
342         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
343         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine.");
344         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
345
346         prop= RNA_def_property(srna, "animation_start", PROP_INT, PROP_NONE);
347         RNA_def_property_int_sdna(prop, NULL, "twsta");
348         RNA_def_property_range(prop, 0, 128);
349         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture.");
350         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
351
352         prop= RNA_def_property(srna, "animation_end", PROP_INT, PROP_NONE);
353         RNA_def_property_int_sdna(prop, NULL, "twend");
354         RNA_def_property_range(prop, 0, 128);
355         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture.");
356         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
357
358         prop= RNA_def_property(srna, "animation_speed", PROP_INT, PROP_NONE);
359         RNA_def_property_int_sdna(prop, NULL, "animspeed");
360         RNA_def_property_range(prop, 1, 100);
361         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second.");
362         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
363
364         prop= RNA_def_property(srna, "tiles", PROP_BOOLEAN, PROP_NONE);
365         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
366         RNA_def_property_ui_text(prop, "Tiles", "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces).");
367         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
368
369         prop= RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
370         RNA_def_property_int_sdna(prop, NULL, "xrep");
371         RNA_def_property_range(prop, 1, 16);
372         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction.");
373         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
374
375         prop= RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
376         RNA_def_property_int_sdna(prop, NULL, "yrep");
377         RNA_def_property_range(prop, 1, 16);
378         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction.");
379         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
380
381         prop= RNA_def_property(srna, "clamp_x", PROP_BOOLEAN, PROP_NONE);
382         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
383         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally.");
384         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
385
386         prop= RNA_def_property(srna, "clamp_y", PROP_BOOLEAN, PROP_NONE);
387         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
388         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically.");
389         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
390
391         /*
392            Image.has_data and Image.depth are temporary,
393            Update import_obj.py when they are replaced (Arystan)
394         */
395         prop= RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
396         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
397         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
398         RNA_def_property_ui_text(prop, "Has data", "True if this image has data.");
399
400         prop= RNA_def_property(srna, "depth", PROP_INT, PROP_NONE);
401         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
402         RNA_def_property_ui_text(prop, "Depth", "Image bit depth.");
403         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
404
405         RNA_api_image(srna);
406 }
407
408 void RNA_def_image(BlenderRNA *brna)
409 {
410         rna_def_image(brna);
411         rna_def_imageuser(brna);
412 }
413
414 #endif
415