Image cache rewrite to using generic movie cache
[blender.git] / source / blender / makesrna / intern / rna_image.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Brecht Van Lommel
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_image.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28
29 #include "DNA_image_types.h"
30 #include "DNA_scene_types.h"
31
32 #include "BLI_utildefines.h"
33
34 #include "BKE_context.h"
35 #include "BKE_depsgraph.h"
36 #include "BKE_image.h"
37
38 #include "RNA_define.h"
39 #include "RNA_enum_types.h"
40
41 #include "rna_internal.h"
42
43 #include "WM_types.h"
44 #include "WM_api.h"
45
46 EnumPropertyItem image_generated_type_items[] = {
47         {IMA_GENTYPE_BLANK, "BLANK", 0, "Blank", "Generate a blank image"},
48         {IMA_GENTYPE_GRID, "UV_GRID", 0, "UV Grid", "Generated grid to test UV mappings"},
49         {IMA_GENTYPE_GRID_COLOR, "COLOR_GRID", 0, "Color Grid", "Generated improved UV grid to test UV mappings"},
50         {0, NULL, 0, NULL, NULL}
51 };
52
53 static EnumPropertyItem image_source_items[] = {
54         {IMA_SRC_FILE, "FILE", 0, "Single Image", "Single image file"},
55         {IMA_SRC_SEQUENCE, "SEQUENCE", 0, "Image Sequence", "Multiple image files, as a sequence"},
56         {IMA_SRC_MOVIE, "MOVIE", 0, "Movie", "Movie file"},
57         {IMA_SRC_GENERATED, "GENERATED", 0, "Generated", "Generated image"},
58         {IMA_SRC_VIEWER, "VIEWER", 0, "Viewer", "Compositing node viewer"},
59         {0, NULL, 0, NULL, NULL}
60 };
61
62 #ifdef RNA_RUNTIME
63
64 #include "IMB_imbuf.h"
65 #include "IMB_imbuf_types.h"
66
67 static void rna_Image_animated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
68 {
69         Image *ima = (Image *)ptr->data;
70         int nr;
71
72         if (ima->flag & IMA_TWINANIM) {
73                 nr = ima->xrep * ima->yrep;
74                 if (ima->twsta >= nr) ima->twsta = 1;
75                 if (ima->twend >= nr) ima->twend = nr - 1;
76                 if (ima->twsta > ima->twend) ima->twsta = 1;
77         }
78 }
79
80 static int rna_Image_dirty_get(PointerRNA *ptr)
81 {
82         return BKE_image_is_dirty((Image *)ptr->data);
83 }
84
85 static void rna_Image_source_set(PointerRNA *ptr, int value)
86 {
87         Image *ima = ptr->id.data;
88
89         if (value != ima->source) {
90                 ima->source = value;
91                 BKE_image_signal(ima, NULL, IMA_SIGNAL_SRC_CHANGE);
92                 DAG_id_tag_update(&ima->id, 0);
93         }
94 }
95
96 static void rna_Image_fields_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
97 {
98         Image *ima = ptr->id.data;
99         ImBuf *ibuf;
100         void *lock;
101
102         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
103
104         if (ibuf) {
105                 short nr = 0;
106
107                 if (!(ima->flag & IMA_FIELDS) && (ibuf->flags & IB_fields)) nr = 1;
108                 if ((ima->flag & IMA_FIELDS) && !(ibuf->flags & IB_fields)) nr = 1;
109
110                 if (nr)
111                         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
112         }
113
114         BKE_image_release_ibuf(ima, ibuf, lock);
115 }
116
117 static void rna_Image_reload_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
118 {
119         Image *ima = ptr->id.data;
120         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
121         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
122         DAG_id_tag_update(&ima->id, 0);
123 }
124
125 static void rna_Image_generated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
126 {
127         Image *ima = ptr->id.data;
128         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
129 }
130
131 static void rna_Image_colormanage_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
132 {
133         Image *ima = ptr->id.data;
134         BKE_image_signal(ima, NULL, IMA_SIGNAL_COLORMANAGE);
135         DAG_id_tag_update(&ima->id, 0);
136         WM_main_add_notifier(NC_IMAGE | ND_DISPLAY, &ima->id);
137         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
138 }
139
140 static void rna_ImageUser_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
141 {
142         ImageUser *iuser = ptr->data;
143
144         BKE_image_user_frame_calc(iuser, scene->r.cfra, 0);
145 }
146
147
148 static char *rna_ImageUser_path(PointerRNA *ptr)
149 {
150         if (ptr->id.data) {
151                 /* ImageUser *iuser = ptr->data; */
152                 
153                 switch (GS(((ID *)ptr->id.data)->name)) {
154                         case ID_TE:
155                         {
156                                 return BLI_strdup("image_user");
157                         }
158                         case ID_NT:
159                         {
160                                 return rna_Node_ImageUser_path(ptr);
161                         }
162                 }
163         }
164         
165         return BLI_strdup("");
166 }
167
168 static EnumPropertyItem *rna_Image_source_itemf(bContext *UNUSED(C), PointerRNA *ptr,
169                                                 PropertyRNA *UNUSED(prop), int *free)
170 {
171         Image *ima = (Image *)ptr->data;
172         EnumPropertyItem *item = NULL;
173         int totitem = 0;
174         
175         if (ima->source == IMA_SRC_VIEWER) {
176                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
177         }
178         else {
179                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
180                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
181                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
182                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
183         }
184
185         RNA_enum_item_end(&item, &totitem);
186         *free = 1;
187
188         return item;
189 }
190
191 static int rna_Image_file_format_get(PointerRNA *ptr)
192 {
193         Image *image = (Image *)ptr->data;
194         ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
195         int imtype = BKE_ftype_to_imtype(ibuf ? ibuf->ftype : 0);
196
197         BKE_image_release_ibuf(image, ibuf, NULL);
198
199         return imtype;
200 }
201
202 static void rna_Image_file_format_set(PointerRNA *ptr, int value)
203 {
204         Image *image = (Image *)ptr->data;
205         if (BKE_imtype_is_movie(value) == 0) { /* should be able to throw an error here */
206                 int ftype = BKE_imtype_to_ftype(value);
207                 BKE_image_file_format_set(image, ftype);
208         }
209 }
210
211 static int rna_Image_has_data_get(PointerRNA *ptr)
212 {
213         Image *image = (Image *)ptr->data;
214
215         return BKE_image_has_loaded_ibuf(image);
216 }
217
218 static void rna_Image_size_get(PointerRNA *ptr, int *values)
219 {
220         Image *im = (Image *)ptr->data;
221         ImBuf *ibuf;
222         void *lock;
223
224         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
225         if (ibuf) {
226                 values[0] = ibuf->x;
227                 values[1] = ibuf->y;
228         }
229         else {
230                 values[0] = 0;
231                 values[1] = 0;
232         }
233
234         BKE_image_release_ibuf(im, ibuf, lock);
235 }
236
237 static void rna_Image_resolution_get(PointerRNA *ptr, float *values)
238 {
239         Image *im = (Image *)ptr->data;
240         ImBuf *ibuf;
241         void *lock;
242
243         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
244         if (ibuf) {
245                 values[0] = ibuf->ppm[0];
246                 values[1] = ibuf->ppm[1];
247         }
248         else {
249                 values[0] = 0;
250                 values[1] = 0;
251         }
252
253         BKE_image_release_ibuf(im, ibuf, lock);
254 }
255
256 static void rna_Image_resolution_set(PointerRNA *ptr, const float *values)
257 {
258         Image *im = (Image *)ptr->data;
259         ImBuf *ibuf;
260         void *lock;
261
262         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
263         if (ibuf) {
264                 ibuf->ppm[0] = values[0];
265                 ibuf->ppm[1] = values[1];
266         }
267
268         BKE_image_release_ibuf(im, ibuf, lock);
269 }
270
271 static int rna_Image_depth_get(PointerRNA *ptr)
272 {
273         Image *im = (Image *)ptr->data;
274         ImBuf *ibuf;
275         void *lock;
276         int planes;
277         
278         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
279
280         if (!ibuf)
281                 planes = 0;
282         else if (ibuf->rect_float)
283                 planes = ibuf->planes * 4;
284         else
285                 planes = ibuf->planes;
286
287         BKE_image_release_ibuf(im, ibuf, lock);
288
289         return planes;
290 }
291
292 static int rna_Image_frame_duration_get(PointerRNA *ptr)
293 {
294         Image *im = (Image *)ptr->data;
295
296         if (im->anim)
297                 return IMB_anim_get_duration(im->anim, IMB_TC_RECORD_RUN);
298         return 1;
299 }
300
301 static int rna_Image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
302 {
303         Image *ima = ptr->id.data;
304         ImBuf *ibuf;
305         void *lock;
306
307         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
308
309         if (ibuf)
310                 length[0] = ibuf->x * ibuf->y * ibuf->channels;
311         else
312                 length[0] = 0;
313
314         BKE_image_release_ibuf(ima, ibuf, lock);
315
316         return length[0];
317 }
318
319 static void rna_Image_pixels_get(PointerRNA *ptr, float *values)
320 {
321         Image *ima = ptr->id.data;
322         ImBuf *ibuf;
323         void *lock;
324         int i, size;
325
326         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
327
328         if (ibuf) {
329                 size = ibuf->x * ibuf->y * ibuf->channels;
330
331                 if (ibuf->rect_float) {
332                         memcpy(values, ibuf->rect_float, sizeof(float) * size);
333                 }
334                 else {
335                         for (i = 0; i < size; i++)
336                                 values[i] = ((unsigned char *)ibuf->rect)[i] * (1.0f / 255.0f);
337                 }
338         }
339
340         BKE_image_release_ibuf(ima, ibuf, lock);
341 }
342
343 static void rna_Image_pixels_set(PointerRNA *ptr, const float *values)
344 {
345         Image *ima = ptr->id.data;
346         ImBuf *ibuf;
347         void *lock;
348         int i, size;
349
350         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
351
352         if (ibuf) {
353                 size = ibuf->x * ibuf->y * ibuf->channels;
354
355                 if (ibuf->rect_float) {
356                         memcpy(ibuf->rect_float, values, sizeof(float) * size);
357                 }
358                 else {
359                         for (i = 0; i < size; i++)
360                                 ((unsigned char *)ibuf->rect)[i] = FTOCHAR(values[i]);
361                 }
362
363                 ibuf->userflags |= IB_BITMAPDIRTY | IB_DISPLAY_BUFFER_INVALID;
364         }
365
366         BKE_image_release_ibuf(ima, ibuf, lock);
367 }
368
369 static int rna_Image_channels_get(PointerRNA *ptr)
370 {
371         Image *im = (Image *)ptr->data;
372         ImBuf *ibuf;
373         void *lock;
374         int channels = 0;
375
376         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
377         if (ibuf)
378                 channels = ibuf->channels;
379
380         BKE_image_release_ibuf(im, ibuf, lock);
381
382         return channels;
383 }
384
385 static int rna_Image_is_float_get(PointerRNA *ptr)
386 {
387         Image *im = (Image *)ptr->data;
388         ImBuf *ibuf;
389         void *lock;
390         int is_float = FALSE;
391
392         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
393         if (ibuf)
394                 is_float = ibuf->rect_float != NULL;
395
396         BKE_image_release_ibuf(im, ibuf, lock);
397
398         return is_float;
399 }
400
401 #else
402
403 static void rna_def_imageuser(BlenderRNA *brna)
404 {
405         StructRNA *srna;
406         PropertyRNA *prop;
407
408         srna = RNA_def_struct(brna, "ImageUser", NULL);
409         RNA_def_struct_ui_text(srna, "Image User",
410                                "Parameters defining how an Image datablock is used by another datablock");
411         RNA_def_struct_path_func(srna, "rna_ImageUser_path");
412
413         prop = RNA_def_property(srna, "use_auto_refresh", PROP_BOOLEAN, PROP_NONE);
414         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
415         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes");
416         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
417         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
418
419         prop = RNA_def_property(srna, "frame_current", PROP_INT, PROP_TIME);
420         RNA_def_property_int_sdna(prop, NULL, "framenr");
421         RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
422         RNA_def_property_ui_text(prop, "Current Frame", "Current frame number in image sequence or movie");
423
424         /* animation */
425         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
426         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
427         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie");
428         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
429         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
430
431         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_NONE);
432         RNA_def_property_int_sdna(prop, NULL, "frames");
433         RNA_def_property_range(prop, 0, MAXFRAMEF);
434         RNA_def_property_ui_text(prop, "Frames", "Number of images of a movie to use");
435         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
436         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
437
438         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
439         RNA_def_property_int_sdna(prop, NULL, "offset");
440         RNA_def_property_ui_text(prop, "Offset", "Offset the number of the frame to use in the animation");
441         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
442
443         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
444         RNA_def_property_int_sdna(prop, NULL, "sfra");
445         RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
446         RNA_def_property_ui_text(prop, "Start Frame",
447                                  "Global starting frame of the movie/sequence, assuming first picture has a #1");
448         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
449         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
450
451         prop = RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
452         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
453         RNA_def_property_range(prop, 1, 200);
454         RNA_def_property_ui_text(prop, "Fields per Frame", "Number of fields per rendered frame (2 fields is 1 image)");
455         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
456         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
457
458         prop = RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
459         RNA_def_property_int_sdna(prop, NULL, "layer");
460         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
461         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image");
462
463         prop = RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
464         RNA_def_property_int_sdna(prop, NULL, "pass");
465         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
466         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image");
467 }
468
469 static void rna_def_image(BlenderRNA *brna)
470 {
471         StructRNA *srna;
472         PropertyRNA *prop;
473         static const EnumPropertyItem prop_type_items[] = {
474                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
475                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
476                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
477                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
478                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
479                 {0, NULL, 0, NULL, NULL}
480         };
481         static const EnumPropertyItem prop_mapping_items[] = {
482                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
483                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
484                 {0, NULL, 0, NULL, NULL}
485         };
486         static const EnumPropertyItem prop_field_order_items[] = {
487                 {0, "EVEN", 0, "Upper First", "Upper field first"},
488                 {IMA_STD_FIELD, "ODD", 0, "Lower First", "Lower field first"},
489                 {0, NULL, 0, NULL, NULL}
490         };
491         static const EnumPropertyItem alpha_mode_items[] = {
492                 {IMA_ALPHA_STRAIGHT, "STRAIGHT", 0, "Straight", "Transparent RGB and alpha pixels are unmodified"},
493                 {IMA_ALPHA_PREMUL, "PREMUL", 0, "Premultiplied", "Transparent RGB pixels are multiplied by the alpha channel"},
494                 {0, NULL, 0, NULL, NULL}
495         };
496
497         srna = RNA_def_struct(brna, "Image", "ID");
498         RNA_def_struct_ui_text(srna, "Image", "Image datablock referencing an external or packed image");
499         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
500
501         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
502         RNA_def_property_string_sdna(prop, NULL, "name");
503         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name");
504         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_reload_update");
505
506         /* eek. this is horrible but needed so we can save to a new name without blanking the data :( */
507         prop = RNA_def_property(srna, "filepath_raw", PROP_STRING, PROP_FILEPATH);
508         RNA_def_property_string_sdna(prop, NULL, "name");
509         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name (without data refreshing)");
510
511         prop = RNA_def_property(srna, "file_format", PROP_ENUM, PROP_NONE);
512         RNA_def_property_enum_items(prop, image_type_items);
513         RNA_def_property_enum_funcs(prop, "rna_Image_file_format_get", "rna_Image_file_format_set", NULL);
514         RNA_def_property_ui_text(prop, "File Format", "Format used for re-saving this file");
515
516         prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
517         RNA_def_property_enum_items(prop, image_source_items);
518         RNA_def_property_enum_funcs(prop, NULL, "rna_Image_source_set", "rna_Image_source_itemf");
519         RNA_def_property_ui_text(prop, "Source", "Where the image comes from");
520         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
521
522         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
523         RNA_def_property_enum_items(prop, prop_type_items);
524         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
525         RNA_def_property_ui_text(prop, "Type", "How to generate the image");
526         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
527
528         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
529         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
530         RNA_def_property_ui_text(prop, "Packed File", "");
531         
532         prop = RNA_def_property(srna, "field_order", PROP_ENUM, PROP_NONE);
533         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
534         RNA_def_property_enum_items(prop, prop_field_order_items);
535         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields (select which lines are displayed first)");
536         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
537         
538         /* booleans */
539         prop = RNA_def_property(srna, "use_fields", PROP_BOOLEAN, PROP_NONE);
540         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
541         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image");
542         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_fields_update");
543         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
544         
545
546         prop = RNA_def_property(srna, "use_view_as_render", PROP_BOOLEAN, PROP_NONE);
547         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_VIEW_AS_RENDER);
548         RNA_def_property_ui_text(prop, "View as Render", "Apply render part of display transformation when displaying this image on the screen");
549         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
550
551         prop = RNA_def_property(srna, "use_alpha", PROP_BOOLEAN, PROP_NONE);
552         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", IMA_IGNORE_ALPHA);
553         RNA_def_property_ui_text(prop, "Use Alpha", "Use the alpha channel information from the image or make image fully opaque");
554         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
555
556         prop = RNA_def_property(srna, "is_dirty", PROP_BOOLEAN, PROP_NONE);
557         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
558         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
559         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved");
560
561         /* generated image (image_generated_change_cb) */
562         prop = RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
563         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
564         RNA_def_property_enum_items(prop, image_generated_type_items);
565         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
566         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
567         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
568         
569         prop = RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
570         RNA_def_property_int_sdna(prop, NULL, "gen_x");
571         RNA_def_property_range(prop, 1, 65536);
572         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
573         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
574         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
575         
576         prop = RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
577         RNA_def_property_int_sdna(prop, NULL, "gen_y");
578         RNA_def_property_range(prop, 1, 65536);
579         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
580         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
581         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
582         
583         prop = RNA_def_property(srna, "use_generated_float", PROP_BOOLEAN, PROP_NONE);
584         RNA_def_property_boolean_sdna(prop, NULL, "gen_flag", IMA_GEN_FLOAT);
585         RNA_def_property_ui_text(prop, "Float Buffer", "Generate floating point buffer");
586         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
587         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
588
589         /* realtime properties */
590         prop = RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
591         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
592         RNA_def_property_enum_items(prop, prop_mapping_items);
593         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine");
594         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
595
596         prop = RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
597         RNA_def_property_float_sdna(prop, NULL, "aspx");
598         RNA_def_property_array(prop, 2);
599         RNA_def_property_range(prop, 0.1f, FLT_MAX);
600         RNA_def_property_ui_range(prop, 0.1f, 5000.f, 1, 2);
601         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering");
602         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
603
604         prop = RNA_def_property(srna, "use_animation", PROP_BOOLEAN, PROP_NONE);
605         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
606         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine");
607         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
608
609         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_NONE);
610         RNA_def_property_int_sdna(prop, NULL, "twsta");
611         RNA_def_property_range(prop, 0, 128);
612         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture");
613         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
614
615         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_NONE);
616         RNA_def_property_int_sdna(prop, NULL, "twend");
617         RNA_def_property_range(prop, 0, 128);
618         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture");
619         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
620
621         prop = RNA_def_property(srna, "fps", PROP_INT, PROP_NONE);
622         RNA_def_property_int_sdna(prop, NULL, "animspeed");
623         RNA_def_property_range(prop, 1, 100);
624         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second");
625         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
626
627         prop = RNA_def_property(srna, "use_tiles", PROP_BOOLEAN, PROP_NONE);
628         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
629         RNA_def_property_ui_text(prop, "Tiles",
630                                  "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces)");
631         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
632
633         prop = RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
634         RNA_def_property_int_sdna(prop, NULL, "xrep");
635         RNA_def_property_range(prop, 1, 16);
636         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction");
637         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
638
639         prop = RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
640         RNA_def_property_int_sdna(prop, NULL, "yrep");
641         RNA_def_property_range(prop, 1, 16);
642         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction");
643         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
644
645         prop = RNA_def_property(srna, "use_clamp_x", PROP_BOOLEAN, PROP_NONE);
646         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
647         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally");
648         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
649
650         prop = RNA_def_property(srna, "use_clamp_y", PROP_BOOLEAN, PROP_NONE);
651         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
652         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically");
653         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
654
655         prop = RNA_def_property(srna, "bindcode", PROP_INT, PROP_UNSIGNED);
656         RNA_def_property_int_sdna(prop, NULL, "bindcode");
657         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
658         RNA_def_property_ui_text(prop, "Bindcode", "OpenGL bindcode");
659         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
660
661         prop = RNA_def_property(srna, "render_slot", PROP_INT, PROP_UNSIGNED);
662         RNA_def_property_range(prop, 0, IMA_MAX_RENDER_SLOT - 1);
663         RNA_def_property_ui_text(prop, "Render Slot", "The current render slot displayed, only for viewer type images");
664         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
665
666         /*
667          * Image.has_data and Image.depth are temporary,
668          * Update import_obj.py when they are replaced (Arystan)
669          */
670         prop = RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
671         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
672         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
673         RNA_def_property_ui_text(prop, "Has data", "True if this image has data");
674
675         prop = RNA_def_property(srna, "depth", PROP_INT, PROP_UNSIGNED);
676         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
677         RNA_def_property_ui_text(prop, "Depth", "Image bit depth");
678         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
679
680         prop = RNA_def_int_vector(srna, "size", 2, NULL, 0, 0, "Size",
681                                   "Width and height in pixels, zero when image data cant be loaded", 0, 0);
682         RNA_def_property_subtype(prop, PROP_PIXEL);
683         RNA_def_property_int_funcs(prop, "rna_Image_size_get", NULL, NULL);
684         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
685
686         prop = RNA_def_float_vector(srna, "resolution", 2, NULL, 0, 0, "Resolution", "X/Y pixels per meter", 0, 0);
687         RNA_def_property_float_funcs(prop, "rna_Image_resolution_get", "rna_Image_resolution_set", NULL);
688
689         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_UNSIGNED);
690         RNA_def_property_int_funcs(prop, "rna_Image_frame_duration_get", NULL, NULL);
691         RNA_def_property_ui_text(prop, "Duration", "Duration (in frames) of the image (1 when not a video/sequence)");
692         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
693
694         /* NOTE about pixels/channels/is_floa:
695          * this properties describes how image is stored internally (inside of ImBuf),
696          * not how it was saved to disk or how it'll be saved on disk
697          */
698         prop = RNA_def_property(srna, "pixels", PROP_FLOAT, PROP_NONE);
699         RNA_def_property_flag(prop, PROP_DYNAMIC);
700         RNA_def_property_multi_array(prop, 1, NULL);
701         RNA_def_property_ui_text(prop, "Pixels", "Image pixels in floating point values");
702         RNA_def_property_dynamic_array_funcs(prop, "rna_Image_pixels_get_length");
703         RNA_def_property_float_funcs(prop, "rna_Image_pixels_get", "rna_Image_pixels_set", NULL);
704
705         prop = RNA_def_property(srna, "channels", PROP_INT, PROP_UNSIGNED);
706         RNA_def_property_int_funcs(prop, "rna_Image_channels_get", NULL, NULL);
707         RNA_def_property_ui_text(prop, "Channels", "Number of channels in pixels buffer");
708         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
709
710         prop = RNA_def_property(srna, "is_float", PROP_BOOLEAN, PROP_NONE);
711         RNA_def_property_boolean_funcs(prop, "rna_Image_is_float_get", NULL);
712         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
713         RNA_def_property_ui_text(prop, "Is Float", "True if this image is stored in float buffer");
714
715         prop = RNA_def_property(srna, "colorspace_settings", PROP_POINTER, PROP_NONE);
716         RNA_def_property_pointer_sdna(prop, NULL, "colorspace_settings");
717         RNA_def_property_struct_type(prop, "ColorManagedInputColorspaceSettings");
718         RNA_def_property_ui_text(prop, "Color Space Settings", "Input color space settings");
719
720         prop = RNA_def_property(srna, "alpha_mode", PROP_ENUM, PROP_NONE);
721         RNA_def_property_enum_items(prop, alpha_mode_items);
722         RNA_def_property_ui_text(prop, "Alpha Mode", "Representation of alpha information in the RGBA pixels");
723         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
724
725         RNA_api_image(srna);
726 }
727
728 void RNA_def_image(BlenderRNA *brna)
729 {
730         rna_def_image(brna);
731         rna_def_imageuser(brna);
732 }
733
734 #endif