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