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