4c70dc648dbbedbd3469a82423f91c97729133e4
[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_access.h"
39 #include "RNA_define.h"
40 #include "RNA_enum_types.h"
41
42 #include "rna_internal.h"
43
44 #include "WM_types.h"
45 #include "WM_api.h"
46
47 EnumPropertyItem image_generated_type_items[] = {
48         {IMA_GENTYPE_BLANK, "BLANK", 0, "Blank", "Generate a blank image"},
49         {IMA_GENTYPE_GRID, "UV_GRID", 0, "UV Grid", "Generated grid to test UV mappings"},
50         {IMA_GENTYPE_GRID_COLOR, "COLOR_GRID", 0, "Color Grid", "Generated improved UV grid to test UV mappings"},
51         {0, NULL, 0, NULL, NULL}
52 };
53
54 static EnumPropertyItem image_source_items[] = {
55         {IMA_SRC_FILE, "FILE", 0, "Single Image", "Single image file"},
56         {IMA_SRC_SEQUENCE, "SEQUENCE", 0, "Image Sequence", "Multiple image files, as a sequence"},
57         {IMA_SRC_MOVIE, "MOVIE", 0, "Movie", "Movie file"},
58         {IMA_SRC_GENERATED, "GENERATED", 0, "Generated", "Generated image"},
59         {IMA_SRC_VIEWER, "VIEWER", 0, "Viewer", "Compositing node viewer"},
60         {0, NULL, 0, NULL, NULL}
61 };
62
63 #ifdef RNA_RUNTIME
64
65 #include "IMB_imbuf.h"
66 #include "IMB_imbuf_types.h"
67
68 static void rna_Image_animated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
69 {
70         Image *ima = (Image *)ptr->data;
71         int nr;
72
73         if (ima->flag & IMA_TWINANIM) {
74                 nr = ima->xrep * ima->yrep;
75                 if (ima->twsta >= nr) ima->twsta = 1;
76                 if (ima->twend >= nr) ima->twend = nr - 1;
77                 if (ima->twsta > ima->twend) ima->twsta = 1;
78         }
79 }
80
81 static int rna_Image_is_stereo_3d_get(PointerRNA *ptr)
82 {
83         return BKE_image_is_stereo((Image *)ptr->data);
84 }
85
86 static int rna_Image_is_multiview_get(PointerRNA *ptr)
87 {
88         return BKE_image_is_multiview((Image *)ptr->data);
89 }
90
91 static int rna_Image_dirty_get(PointerRNA *ptr)
92 {
93         return BKE_image_is_dirty((Image *)ptr->data);
94 }
95
96 static void rna_Image_source_set(PointerRNA *ptr, int value)
97 {
98         Image *ima = ptr->id.data;
99
100         if (value != ima->source) {
101                 ima->source = value;
102                 BKE_image_signal(ima, NULL, IMA_SIGNAL_SRC_CHANGE);
103                 DAG_id_tag_update(&ima->id, 0);
104         }
105 }
106
107 static void rna_Image_fields_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
108 {
109         Image *ima = ptr->id.data;
110         ImBuf *ibuf;
111         void *lock;
112
113         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
114
115         if (ibuf) {
116                 short nr = 0;
117
118                 if (!(ima->flag & IMA_FIELDS) && (ibuf->flags & IB_fields)) nr = 1;
119                 if ((ima->flag & IMA_FIELDS) && !(ibuf->flags & IB_fields)) nr = 1;
120
121                 if (nr)
122                         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
123         }
124
125         BKE_image_release_ibuf(ima, ibuf, lock);
126 }
127
128 static void rna_Image_reload_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
129 {
130         Image *ima = ptr->id.data;
131         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
132         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
133         DAG_id_tag_update(&ima->id, 0);
134 }
135
136 static void rna_Image_generated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
137 {
138         Image *ima = ptr->id.data;
139         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
140 }
141
142 static void rna_Image_colormanage_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
143 {
144         Image *ima = ptr->id.data;
145         BKE_image_signal(ima, NULL, IMA_SIGNAL_COLORMANAGE);
146         DAG_id_tag_update(&ima->id, 0);
147         WM_main_add_notifier(NC_IMAGE | ND_DISPLAY, &ima->id);
148         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
149 }
150
151 static void rna_Image_views_format_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
152 {
153         Image *ima = ptr->id.data;
154         ImBuf *ibuf;
155         void *lock;
156
157         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
158
159         if (ibuf) {
160                 ImageUser iuser = {NULL};
161                 iuser.scene = scene;
162                 BKE_image_signal(ima, &iuser, IMA_SIGNAL_FREE);
163         }
164
165         BKE_image_release_ibuf(ima, ibuf, lock);
166 }
167
168 static void rna_ImageUser_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
169 {
170         ImageUser *iuser = ptr->data;
171
172         BKE_image_user_frame_calc(iuser, scene->r.cfra, 0);
173 }
174
175
176 static char *rna_ImageUser_path(PointerRNA *ptr)
177 {
178         if (ptr->id.data) {
179                 /* ImageUser *iuser = ptr->data; */
180                 
181                 switch (GS(((ID *)ptr->id.data)->name)) {
182                         case ID_OB:
183                         case ID_TE:
184                         {
185                                 return BLI_strdup("image_user");
186                         }
187                         case ID_NT:
188                         {
189                                 return rna_Node_ImageUser_path(ptr);
190                         }
191                 }
192         }
193         
194         return BLI_strdup("");
195 }
196
197 static EnumPropertyItem *rna_Image_source_itemf(bContext *UNUSED(C), PointerRNA *ptr,
198                                                 PropertyRNA *UNUSED(prop), bool *r_free)
199 {
200         Image *ima = (Image *)ptr->data;
201         EnumPropertyItem *item = NULL;
202         int totitem = 0;
203         
204         if (ima->source == IMA_SRC_VIEWER) {
205                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
206         }
207         else {
208                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
209                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
210                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
211                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
212         }
213
214         RNA_enum_item_end(&item, &totitem);
215         *r_free = true;
216
217         return item;
218 }
219
220 static int rna_Image_file_format_get(PointerRNA *ptr)
221 {
222         Image *image = (Image *)ptr->data;
223         ImBuf *ibuf = BKE_image_acquire_ibuf(image, NULL, NULL);
224         int imtype = BKE_image_ftype_to_imtype(ibuf ? ibuf->ftype : 0, ibuf ? &ibuf->foptions : NULL);
225
226         BKE_image_release_ibuf(image, ibuf, NULL);
227
228         return imtype;
229 }
230
231 static void rna_Image_file_format_set(PointerRNA *ptr, int value)
232 {
233         Image *image = (Image *)ptr->data;
234         if (BKE_imtype_is_movie(value) == 0) { /* should be able to throw an error here */
235                 ImbFormatOptions options;
236                 int ftype = BKE_image_imtype_to_ftype(value, &options);
237                 BKE_image_file_format_set(image, ftype, &options);
238         }
239 }
240
241 static int rna_Image_has_data_get(PointerRNA *ptr)
242 {
243         Image *image = (Image *)ptr->data;
244
245         return BKE_image_has_loaded_ibuf(image);
246 }
247
248 static void rna_Image_size_get(PointerRNA *ptr, int *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->x;
257                 values[1] = ibuf->y;
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_get(PointerRNA *ptr, 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                 values[0] = ibuf->ppm[0];
276                 values[1] = ibuf->ppm[1];
277         }
278         else {
279                 values[0] = 0;
280                 values[1] = 0;
281         }
282
283         BKE_image_release_ibuf(im, ibuf, lock);
284 }
285
286 static void rna_Image_resolution_set(PointerRNA *ptr, const float *values)
287 {
288         Image *im = (Image *)ptr->data;
289         ImBuf *ibuf;
290         void *lock;
291
292         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
293         if (ibuf) {
294                 ibuf->ppm[0] = values[0];
295                 ibuf->ppm[1] = values[1];
296         }
297
298         BKE_image_release_ibuf(im, ibuf, lock);
299 }
300
301 static int rna_Image_depth_get(PointerRNA *ptr)
302 {
303         Image *im = (Image *)ptr->data;
304         ImBuf *ibuf;
305         void *lock;
306         int planes;
307         
308         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
309
310         if (!ibuf)
311                 planes = 0;
312         else if (ibuf->rect_float)
313                 planes = ibuf->planes * 4;
314         else
315                 planes = ibuf->planes;
316
317         BKE_image_release_ibuf(im, ibuf, lock);
318
319         return planes;
320 }
321
322 static int rna_Image_frame_duration_get(PointerRNA *ptr)
323 {
324         Image *ima = ptr->id.data;
325         int duration = 1;
326
327         if (BKE_image_has_anim(ima)) {
328                 duration = IMB_anim_get_duration(((ImageAnim *)ima->anims.first)->anim, IMB_TC_RECORD_RUN);
329         }
330         else {
331                 /* acquire ensures ima->anim is set, if possible! */
332                 void *lock;
333                 ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
334                 BKE_image_release_ibuf(ima, ibuf, lock);
335         }
336
337         return duration;
338 }
339
340 static int rna_Image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
341 {
342         Image *ima = ptr->id.data;
343         ImBuf *ibuf;
344         void *lock;
345
346         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
347
348         if (ibuf)
349                 length[0] = ibuf->x * ibuf->y * ibuf->channels;
350         else
351                 length[0] = 0;
352
353         BKE_image_release_ibuf(ima, ibuf, lock);
354
355         return length[0];
356 }
357
358 static void rna_Image_pixels_get(PointerRNA *ptr, float *values)
359 {
360         Image *ima = ptr->id.data;
361         ImBuf *ibuf;
362         void *lock;
363         int i, size;
364
365         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
366
367         if (ibuf) {
368                 size = ibuf->x * ibuf->y * ibuf->channels;
369
370                 if (ibuf->rect_float) {
371                         memcpy(values, ibuf->rect_float, sizeof(float) * size);
372                 }
373                 else {
374                         for (i = 0; i < size; i++)
375                                 values[i] = ((unsigned char *)ibuf->rect)[i] * (1.0f / 255.0f);
376                 }
377         }
378
379         BKE_image_release_ibuf(ima, ibuf, lock);
380 }
381
382 static void rna_Image_pixels_set(PointerRNA *ptr, const float *values)
383 {
384         Image *ima = ptr->id.data;
385         ImBuf *ibuf;
386         void *lock;
387         int i, size;
388
389         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
390
391         if (ibuf) {
392                 size = ibuf->x * ibuf->y * ibuf->channels;
393
394                 if (ibuf->rect_float) {
395                         memcpy(ibuf->rect_float, values, sizeof(float) * size);
396                 }
397                 else {
398                         for (i = 0; i < size; i++)
399                                 ((unsigned char *)ibuf->rect)[i] = FTOCHAR(values[i]);
400                 }
401
402                 ibuf->userflags |= IB_BITMAPDIRTY | IB_DISPLAY_BUFFER_INVALID;
403         }
404
405         BKE_image_release_ibuf(ima, ibuf, lock);
406 }
407
408 static int rna_Image_channels_get(PointerRNA *ptr)
409 {
410         Image *im = (Image *)ptr->data;
411         ImBuf *ibuf;
412         void *lock;
413         int channels = 0;
414
415         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
416         if (ibuf)
417                 channels = ibuf->channels;
418
419         BKE_image_release_ibuf(im, ibuf, lock);
420
421         return channels;
422 }
423
424 static int rna_Image_is_float_get(PointerRNA *ptr)
425 {
426         Image *im = (Image *)ptr->data;
427         ImBuf *ibuf;
428         void *lock;
429         bool is_float = false;
430
431         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
432         if (ibuf)
433                 is_float = ibuf->rect_float != NULL;
434
435         BKE_image_release_ibuf(im, ibuf, lock);
436
437         return is_float;
438 }
439
440 static PointerRNA rna_Image_packed_file_get(PointerRNA *ptr)
441 {
442         Image *ima = (Image *)ptr->id.data;
443
444         if (BKE_image_has_packedfile(ima)) {
445                 ImagePackedFile *imapf = ima->packedfiles.first;
446                 return rna_pointer_inherit_refine(ptr, &RNA_PackedFile, imapf->packedfile);
447         }
448         else {
449                 return PointerRNA_NULL;
450         }
451 }
452
453 static void rna_Image_render_slots_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
454 {
455         Image *image = (Image *)ptr->id.data;
456         rna_iterator_array_begin(iter, (void *)image->render_slots, sizeof(RenderSlot), IMA_MAX_RENDER_SLOT, 0, NULL);
457 }
458
459 static PointerRNA rna_render_slots_active_get(PointerRNA *ptr)
460 {
461         Image *image = (Image *)ptr->id.data;
462         RenderSlot *render_slot = &image->render_slots[image->render_slot];
463
464         return rna_pointer_inherit_refine(ptr, &RNA_RenderSlot, render_slot);
465 }
466
467 static void rna_render_slots_active_set(PointerRNA *ptr, PointerRNA value)
468 {
469         Image *image = (Image *)ptr->id.data;
470         if (value.id.data == image) {
471                 RenderSlot *render_slot = (RenderSlot *)value.data;
472                 int index = render_slot - image->render_slots;
473                 image->render_slot = CLAMPIS(index, 0, IMA_MAX_RENDER_SLOT - 1);
474         }
475 }
476
477 static int rna_render_slots_active_index_get(PointerRNA *ptr)
478 {
479         Image *image = (Image *)ptr->id.data;
480         return image->render_slot;
481 }
482
483 static void rna_render_slots_active_index_set(PointerRNA *ptr, int value)
484 {
485         Image *image = (Image *)ptr->id.data;
486         image->render_slot = value;
487         CLAMP(image->render_slot, 0, IMA_MAX_RENDER_SLOT - 1);
488 }
489
490 #else
491
492 static void rna_def_imageuser(BlenderRNA *brna)
493 {
494         StructRNA *srna;
495         PropertyRNA *prop;
496
497         srna = RNA_def_struct(brna, "ImageUser", NULL);
498         RNA_def_struct_ui_text(srna, "Image User",
499                                "Parameters defining how an Image data-block is used by another data-block");
500         RNA_def_struct_path_func(srna, "rna_ImageUser_path");
501
502         prop = RNA_def_property(srna, "use_auto_refresh", PROP_BOOLEAN, PROP_NONE);
503         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
504         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes");
505         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
506         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
507
508         prop = RNA_def_property(srna, "frame_current", PROP_INT, PROP_TIME);
509         RNA_def_property_int_sdna(prop, NULL, "framenr");
510         RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
511         RNA_def_property_ui_text(prop, "Current Frame", "Current frame number in image sequence or movie");
512
513         /* animation */
514         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
515         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
516         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie");
517         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
518         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
519
520         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_NONE);
521         RNA_def_property_int_sdna(prop, NULL, "frames");
522         RNA_def_property_range(prop, 0, MAXFRAMEF);
523         RNA_def_property_ui_text(prop, "Frames", "Number of images of a movie to use");
524         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
525         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
526
527         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
528         RNA_def_property_int_sdna(prop, NULL, "offset");
529         RNA_def_property_ui_text(prop, "Offset", "Offset the number of the frame to use in the animation");
530         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
531
532         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
533         RNA_def_property_int_sdna(prop, NULL, "sfra");
534         RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
535         RNA_def_property_ui_text(prop, "Start Frame",
536                                  "Global starting frame of the movie/sequence, assuming first picture has a #1");
537         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
538         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
539
540         prop = RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
541         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
542         RNA_def_property_range(prop, 1, 200);
543         RNA_def_property_ui_text(prop, "Fields per Frame", "Number of fields per rendered frame (2 fields is 1 image)");
544         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
545         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
546
547         prop = RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
548         RNA_def_property_int_sdna(prop, NULL, "layer");
549         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
550         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image");
551
552         prop = RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
553         RNA_def_property_int_sdna(prop, NULL, "pass");
554         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
555         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image");
556
557         prop = RNA_def_property(srna, "multilayer_view", PROP_INT, PROP_UNSIGNED);
558         RNA_def_property_int_sdna(prop, NULL, "view");
559         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
560         RNA_def_property_ui_text(prop, "View", "View in multilayer image");
561 }
562
563 /* image.packed_files */
564 static void rna_def_image_packed_files(BlenderRNA *brna)
565 {
566         StructRNA *srna;
567         PropertyRNA *prop;
568
569         srna = RNA_def_struct(brna, "ImagePackedFile", NULL);
570         RNA_def_struct_sdna(srna, "ImagePackedFile");
571
572         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
573         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
574         RNA_def_property_ui_text(prop, "Packed File", "");
575         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
576
577         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
578         RNA_def_property_string_sdna(prop, NULL, "filepath");
579         RNA_def_struct_name_property(srna, prop);
580
581         RNA_api_image_packed_file(srna);
582 }
583
584 static void rna_def_render_slot(BlenderRNA *brna)
585 {
586         StructRNA *srna;
587         PropertyRNA *prop;
588         srna = RNA_def_struct(brna, "RenderSlot", NULL);
589         RNA_def_struct_ui_text(srna, "Render Slot", "Parameters defining the render slot");
590
591         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
592         RNA_def_property_string_sdna(prop, NULL, "name");
593         RNA_def_property_ui_text(prop, "Name", "Render slot name");
594         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
595 }
596
597 static void rna_def_render_slots(BlenderRNA *brna)
598 {
599         StructRNA *srna;
600         PropertyRNA *prop;
601
602         srna = RNA_def_struct(brna, "RenderSlots", NULL);
603         RNA_def_struct_sdna(srna, "RenderSlot");
604         RNA_def_struct_ui_text(srna, "Render Slots", "Collection of the render slots");
605
606         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
607         RNA_def_property_struct_type(prop, "RenderSlot");
608         RNA_def_property_pointer_funcs(prop, "rna_render_slots_active_get", "rna_render_slots_active_set", NULL, NULL);
609         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
610         RNA_def_property_ui_text(prop, "Active", "Active render slot of the image");
611         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
612
613         prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_NONE);
614         RNA_def_property_int_funcs(prop, "rna_render_slots_active_index_get",
615                                    "rna_render_slots_active_index_set",
616                                    NULL);
617         RNA_def_property_range(prop, 0, IMA_MAX_RENDER_SLOT);
618         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
619         RNA_def_property_ui_text(prop, "Active Index", "Index of an active render slot of the image");
620         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
621 }
622
623 static void rna_def_image(BlenderRNA *brna)
624 {
625         StructRNA *srna;
626         PropertyRNA *prop;
627         static const EnumPropertyItem prop_type_items[] = {
628                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
629                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
630                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
631                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
632                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
633                 {0, NULL, 0, NULL, NULL}
634         };
635         static const EnumPropertyItem prop_mapping_items[] = {
636                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
637                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
638                 {0, NULL, 0, NULL, NULL}
639         };
640         static const EnumPropertyItem prop_field_order_items[] = {
641                 {0, "EVEN", 0, "Upper First", "Upper field first"},
642                 {IMA_STD_FIELD, "ODD", 0, "Lower First", "Lower field first"},
643                 {0, NULL, 0, NULL, NULL}
644         };
645         static const EnumPropertyItem alpha_mode_items[] = {
646                 {IMA_ALPHA_STRAIGHT, "STRAIGHT", 0, "Straight", "Transparent RGB and alpha pixels are unmodified"},
647                 {IMA_ALPHA_PREMUL, "PREMUL", 0, "Premultiplied", "Transparent RGB pixels are multiplied by the alpha channel"},
648                 {0, NULL, 0, NULL, NULL}
649         };
650
651         srna = RNA_def_struct(brna, "Image", "ID");
652         RNA_def_struct_ui_text(srna, "Image", "Image data-block referencing an external or packed image");
653         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
654
655         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
656         RNA_def_property_string_sdna(prop, NULL, "name");
657         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name");
658         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_reload_update");
659
660         /* eek. this is horrible but needed so we can save to a new name without blanking the data :( */
661         prop = RNA_def_property(srna, "filepath_raw", PROP_STRING, PROP_FILEPATH);
662         RNA_def_property_string_sdna(prop, NULL, "name");
663         RNA_def_property_ui_text(prop, "File Name", "Image/Movie file name (without data refreshing)");
664
665         prop = RNA_def_property(srna, "file_format", PROP_ENUM, PROP_NONE);
666         RNA_def_property_enum_items(prop, image_type_items);
667         RNA_def_property_enum_funcs(prop, "rna_Image_file_format_get", "rna_Image_file_format_set", NULL);
668         RNA_def_property_ui_text(prop, "File Format", "Format used for re-saving this file");
669
670         prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
671         RNA_def_property_enum_items(prop, image_source_items);
672         RNA_def_property_enum_funcs(prop, NULL, "rna_Image_source_set", "rna_Image_source_itemf");
673         RNA_def_property_ui_text(prop, "Source", "Where the image comes from");
674         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
675
676         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
677         RNA_def_property_enum_items(prop, prop_type_items);
678         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
679         RNA_def_property_ui_text(prop, "Type", "How to generate the image");
680         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
681
682         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
683         RNA_def_property_struct_type(prop, "PackedFile");
684         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
685         RNA_def_property_pointer_funcs(prop, "rna_Image_packed_file_get", NULL, NULL, NULL);
686         RNA_def_property_ui_text(prop, "Packed File", "First packed file of the image");
687
688         prop = RNA_def_property(srna, "packed_files", PROP_COLLECTION, PROP_NONE);
689         RNA_def_property_collection_sdna(prop, NULL, "packedfiles", NULL);
690         RNA_def_property_struct_type(prop, "ImagePackedFile");
691         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
692         RNA_def_property_ui_text(prop, "Packed Files", "Collection of packed images");
693
694         prop = RNA_def_property(srna, "field_order", PROP_ENUM, PROP_NONE);
695         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
696         RNA_def_property_enum_items(prop, prop_field_order_items);
697         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields (select which lines are displayed first)");
698         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
699
700         /* booleans */
701         prop = RNA_def_property(srna, "use_fields", PROP_BOOLEAN, PROP_NONE);
702         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
703         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image");
704         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_fields_update");
705         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
706         
707
708         prop = RNA_def_property(srna, "use_view_as_render", PROP_BOOLEAN, PROP_NONE);
709         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_VIEW_AS_RENDER);
710         RNA_def_property_ui_text(prop, "View as Render", "Apply render part of display transformation when displaying this image on the screen");
711         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
712
713         prop = RNA_def_property(srna, "use_alpha", PROP_BOOLEAN, PROP_NONE);
714         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", IMA_IGNORE_ALPHA);
715         RNA_def_property_ui_text(prop, "Use Alpha", "Use the alpha channel information from the image or make image fully opaque");
716         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
717
718         prop = RNA_def_property(srna, "use_deinterlace", PROP_BOOLEAN, PROP_NONE);
719         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_DEINTERLACE);
720         RNA_def_property_ui_text(prop, "Deinterlace", "Deinterlace movie file on load");
721         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_reload_update");
722
723         prop = RNA_def_property(srna, "use_multiview", PROP_BOOLEAN, PROP_NONE);
724         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_USE_VIEWS);
725         RNA_def_property_ui_text(prop, "Use Multi-View", "Use Multiple Views (when available)");
726         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_views_format_update");
727
728         prop = RNA_def_property(srna, "is_stereo_3d", PROP_BOOLEAN, PROP_NONE);
729         RNA_def_property_boolean_funcs(prop, "rna_Image_is_stereo_3d_get", NULL);
730         RNA_def_property_ui_text(prop, "Stereo 3D", "Image has left and right views");
731         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
732
733         prop = RNA_def_property(srna, "is_multiview", PROP_BOOLEAN, PROP_NONE);
734         RNA_def_property_boolean_funcs(prop, "rna_Image_is_multiview_get", NULL);
735         RNA_def_property_ui_text(prop, "Multiple Views", "Image has more than one view");
736         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
737
738         prop = RNA_def_property(srna, "is_dirty", PROP_BOOLEAN, PROP_NONE);
739         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
740         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
741         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved");
742
743         /* generated image (image_generated_change_cb) */
744         prop = RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
745         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
746         RNA_def_property_enum_items(prop, image_generated_type_items);
747         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
748         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
749         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
750         
751         prop = RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
752         RNA_def_property_int_sdna(prop, NULL, "gen_x");
753         RNA_def_property_flag(prop, PROP_PROPORTIONAL);
754         RNA_def_property_range(prop, 1, 65536);
755         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
756         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
757         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
758         
759         prop = RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
760         RNA_def_property_int_sdna(prop, NULL, "gen_y");
761         RNA_def_property_flag(prop, PROP_PROPORTIONAL);
762         RNA_def_property_range(prop, 1, 65536);
763         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
764         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
765         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
766         
767         prop = RNA_def_property(srna, "use_generated_float", PROP_BOOLEAN, PROP_NONE);
768         RNA_def_property_boolean_sdna(prop, NULL, "gen_flag", IMA_GEN_FLOAT);
769         RNA_def_property_ui_text(prop, "Float Buffer", "Generate floating point buffer");
770         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
771         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
772
773         prop = RNA_def_property(srna, "generated_color", PROP_FLOAT, PROP_COLOR_GAMMA);
774         RNA_def_property_float_sdna(prop, NULL, "gen_color");
775         RNA_def_property_array(prop, 4);
776         RNA_def_property_ui_text(prop, "Color", "Fill color for the generated image");
777         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
778         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
779
780         /* realtime properties */
781         prop = RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
782         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
783         RNA_def_property_enum_items(prop, prop_mapping_items);
784         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine");
785         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
786
787         prop = RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
788         RNA_def_property_float_sdna(prop, NULL, "aspx");
789         RNA_def_property_array(prop, 2);
790         RNA_def_property_range(prop, 0.1f, FLT_MAX);
791         RNA_def_property_ui_range(prop, 0.1f, 5000.f, 1, 2);
792         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering");
793         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
794
795         prop = RNA_def_property(srna, "use_animation", PROP_BOOLEAN, PROP_NONE);
796         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
797         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine");
798         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
799
800         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_NONE);
801         RNA_def_property_int_sdna(prop, NULL, "twsta");
802         RNA_def_property_range(prop, 0, 255);
803         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture");
804         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
805
806         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_NONE);
807         RNA_def_property_int_sdna(prop, NULL, "twend");
808         RNA_def_property_range(prop, 0, 255);
809         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture");
810         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_animated_update");
811
812         prop = RNA_def_property(srna, "fps", PROP_INT, PROP_NONE);
813         RNA_def_property_int_sdna(prop, NULL, "animspeed");
814         RNA_def_property_range(prop, 1, 100);
815         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second");
816         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
817
818         prop = RNA_def_property(srna, "use_tiles", PROP_BOOLEAN, PROP_NONE);
819         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
820         RNA_def_property_ui_text(prop, "Tiles",
821                                  "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces)");
822         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
823
824         prop = RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
825         RNA_def_property_int_sdna(prop, NULL, "xrep");
826         RNA_def_property_range(prop, 1, 16);
827         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction");
828         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
829
830         prop = RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
831         RNA_def_property_int_sdna(prop, NULL, "yrep");
832         RNA_def_property_range(prop, 1, 16);
833         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction");
834         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
835
836         prop = RNA_def_property(srna, "use_clamp_x", PROP_BOOLEAN, PROP_NONE);
837         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
838         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally");
839         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
840
841         prop = RNA_def_property(srna, "use_clamp_y", PROP_BOOLEAN, PROP_NONE);
842         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
843         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically");
844         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
845
846         prop = RNA_def_property(srna, "bindcode", PROP_INT, PROP_UNSIGNED);
847         RNA_def_property_int_sdna(prop, NULL, "bindcode");
848         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
849         RNA_def_property_ui_text(prop, "Bindcode", "OpenGL bindcode");
850         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
851
852         prop = RNA_def_property(srna, "render_slots", PROP_COLLECTION, PROP_NONE);
853         RNA_def_property_struct_type(prop, "RenderSlot");
854         RNA_def_property_ui_text(prop, "Render Slots", "Render slots of the image");
855         RNA_def_property_collection_funcs(prop, "rna_Image_render_slots_begin", "rna_iterator_array_next",
856                                           "rna_iterator_array_end", "rna_iterator_array_get", NULL, NULL, NULL, NULL);
857         RNA_def_property_srna(prop, "RenderSlots");
858
859         /*
860          * Image.has_data and Image.depth are temporary,
861          * Update import_obj.py when they are replaced (Arystan)
862          */
863         prop = RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
864         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
865         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
866         RNA_def_property_ui_text(prop, "Has data", "True if this image has data");
867
868         prop = RNA_def_property(srna, "depth", PROP_INT, PROP_UNSIGNED);
869         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
870         RNA_def_property_ui_text(prop, "Depth", "Image bit depth");
871         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
872
873         prop = RNA_def_int_vector(srna, "size", 2, NULL, 0, 0, "Size",
874                                   "Width and height in pixels, zero when image data cant be loaded", 0, 0);
875         RNA_def_property_subtype(prop, PROP_PIXEL);
876         RNA_def_property_int_funcs(prop, "rna_Image_size_get", NULL, NULL);
877         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
878
879         prop = RNA_def_float_vector(srna, "resolution", 2, NULL, 0, 0, "Resolution", "X/Y pixels per meter", 0, 0);
880         RNA_def_property_float_funcs(prop, "rna_Image_resolution_get", "rna_Image_resolution_set", NULL);
881
882         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_UNSIGNED);
883         RNA_def_property_int_funcs(prop, "rna_Image_frame_duration_get", NULL, NULL);
884         RNA_def_property_ui_text(prop, "Duration", "Duration (in frames) of the image (1 when not a video/sequence)");
885         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
886
887         /* NOTE about pixels/channels/is_floa:
888          * this properties describes how image is stored internally (inside of ImBuf),
889          * not how it was saved to disk or how it'll be saved on disk
890          */
891         prop = RNA_def_property(srna, "pixels", PROP_FLOAT, PROP_NONE);
892         RNA_def_property_flag(prop, PROP_DYNAMIC);
893         RNA_def_property_multi_array(prop, 1, NULL);
894         RNA_def_property_ui_text(prop, "Pixels", "Image pixels in floating point values");
895         RNA_def_property_dynamic_array_funcs(prop, "rna_Image_pixels_get_length");
896         RNA_def_property_float_funcs(prop, "rna_Image_pixels_get", "rna_Image_pixels_set", NULL);
897
898         prop = RNA_def_property(srna, "channels", PROP_INT, PROP_UNSIGNED);
899         RNA_def_property_int_funcs(prop, "rna_Image_channels_get", NULL, NULL);
900         RNA_def_property_ui_text(prop, "Channels", "Number of channels in pixels buffer");
901         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
902
903         prop = RNA_def_property(srna, "is_float", PROP_BOOLEAN, PROP_NONE);
904         RNA_def_property_boolean_funcs(prop, "rna_Image_is_float_get", NULL);
905         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
906         RNA_def_property_ui_text(prop, "Is Float", "True if this image is stored in float buffer");
907
908         prop = RNA_def_property(srna, "colorspace_settings", PROP_POINTER, PROP_NONE);
909         RNA_def_property_pointer_sdna(prop, NULL, "colorspace_settings");
910         RNA_def_property_struct_type(prop, "ColorManagedInputColorspaceSettings");
911         RNA_def_property_ui_text(prop, "Color Space Settings", "Input color space settings");
912
913         prop = RNA_def_property(srna, "alpha_mode", PROP_ENUM, PROP_NONE);
914         RNA_def_property_enum_items(prop, alpha_mode_items);
915         RNA_def_property_ui_text(prop, "Alpha Mode", "Representation of alpha information in the RGBA pixels");
916         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
917
918         /* multiview */
919         prop = RNA_def_property(srna, "views_format", PROP_ENUM, PROP_NONE);
920         RNA_def_property_enum_sdna(prop, NULL, "views_format");
921         RNA_def_property_enum_items(prop, views_format_items);
922         RNA_def_property_ui_text(prop, "Views Format", "Mode to load image views");
923         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_views_format_update");
924
925         prop = RNA_def_property(srna, "stereo_3d_format", PROP_POINTER, PROP_NONE);
926         RNA_def_property_pointer_sdna(prop, NULL, "stereo3d_format");
927         RNA_def_property_flag(prop, PROP_NEVER_NULL);
928         RNA_def_property_struct_type(prop, "Stereo3dFormat");
929         RNA_def_property_ui_text(prop, "Stereo 3D Format", "Settings for stereo 3d");
930
931         RNA_api_image(srna);
932 }
933
934 void RNA_def_image(BlenderRNA *brna)
935 {
936         rna_def_render_slot(brna);
937         rna_def_render_slots(brna);
938         rna_def_image(brna);
939         rna_def_imageuser(brna);
940         rna_def_image_packed_files(brna);
941 }
942
943 #endif