Workbench: API Changes
[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 #include "BLI_math_base.h"
34
35 #include "BKE_context.h"
36 #include "BKE_image.h"
37
38 #include "DEG_depsgraph.h"
39
40 #include "RNA_access.h"
41 #include "RNA_define.h"
42 #include "RNA_enum_types.h"
43
44 #include "rna_internal.h"
45
46 #include "WM_types.h"
47 #include "WM_api.h"
48
49 const EnumPropertyItem rna_enum_image_generated_type_items[] = {
50         {IMA_GENTYPE_BLANK, "BLANK", 0, "Blank", "Generate a blank image"},
51         {IMA_GENTYPE_GRID, "UV_GRID", 0, "UV Grid", "Generated grid to test UV mappings"},
52         {IMA_GENTYPE_GRID_COLOR, "COLOR_GRID", 0, "Color Grid", "Generated improved UV grid to test UV mappings"},
53         {0, NULL, 0, NULL, NULL}
54 };
55
56 static const EnumPropertyItem image_source_items[] = {
57         {IMA_SRC_FILE, "FILE", 0, "Single Image", "Single image file"},
58         {IMA_SRC_SEQUENCE, "SEQUENCE", 0, "Image Sequence", "Multiple image files, as a sequence"},
59         {IMA_SRC_MOVIE, "MOVIE", 0, "Movie", "Movie file"},
60         {IMA_SRC_GENERATED, "GENERATED", 0, "Generated", "Generated image"},
61         {IMA_SRC_VIEWER, "VIEWER", 0, "Viewer", "Compositing node viewer"},
62         {0, NULL, 0, NULL, NULL}
63 };
64
65 #ifdef RNA_RUNTIME
66
67 #include "BKE_global.h"
68
69 #include "GPU_draw.h"
70
71 #include "IMB_imbuf.h"
72 #include "IMB_imbuf_types.h"
73
74 static int rna_Image_is_stereo_3d_get(PointerRNA *ptr)
75 {
76         return BKE_image_is_stereo((Image *)ptr->data);
77 }
78
79 static int rna_Image_is_multiview_get(PointerRNA *ptr)
80 {
81         return BKE_image_is_multiview((Image *)ptr->data);
82 }
83
84 static int rna_Image_dirty_get(PointerRNA *ptr)
85 {
86         return BKE_image_is_dirty((Image *)ptr->data);
87 }
88
89 static void rna_Image_source_set(PointerRNA *ptr, int value)
90 {
91         Image *ima = ptr->id.data;
92
93         if (value != ima->source) {
94                 ima->source = value;
95                 BKE_image_signal(ima, NULL, IMA_SIGNAL_SRC_CHANGE);
96                 DEG_id_tag_update(&ima->id, 0);
97         }
98 }
99
100 static void rna_Image_fields_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
101 {
102         Image *ima = ptr->id.data;
103         ImBuf *ibuf;
104         void *lock;
105
106         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
107
108         if (ibuf) {
109                 short nr = 0;
110
111                 if (!(ima->flag & IMA_FIELDS) && (ibuf->flags & IB_fields)) nr = 1;
112                 if ((ima->flag & IMA_FIELDS) && !(ibuf->flags & IB_fields)) nr = 1;
113
114                 if (nr)
115                         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
116         }
117
118         BKE_image_release_ibuf(ima, ibuf, lock);
119 }
120
121 static void rna_Image_reload_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
122 {
123         Image *ima = ptr->id.data;
124         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
125         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
126         DEG_id_tag_update(&ima->id, 0);
127 }
128
129 static void rna_Image_generated_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
130 {
131         Image *ima = ptr->id.data;
132         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
133 }
134
135 static void rna_Image_colormanage_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
136 {
137         Image *ima = ptr->id.data;
138         BKE_image_signal(ima, NULL, IMA_SIGNAL_COLORMANAGE);
139         DEG_id_tag_update(&ima->id, 0);
140         WM_main_add_notifier(NC_IMAGE | ND_DISPLAY, &ima->id);
141         WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
142 }
143
144 static void rna_Image_views_format_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
145 {
146         Image *ima = ptr->id.data;
147         ImBuf *ibuf;
148         void *lock;
149
150         ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
151
152         if (ibuf) {
153                 ImageUser iuser = {NULL};
154                 iuser.scene = scene;
155                 BKE_image_signal(ima, &iuser, IMA_SIGNAL_FREE);
156         }
157
158         BKE_image_release_ibuf(ima, ibuf, lock);
159 }
160
161 static void rna_ImageUser_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
162 {
163         ImageUser *iuser = ptr->data;
164
165         BKE_image_user_frame_calc(iuser, scene->r.cfra, 0);
166
167         if (ptr->id.data) {
168                 /* Update material or texture for render preview. */
169                 DEG_id_tag_update(ptr->id.data, 0);
170         }
171 }
172
173
174 static char *rna_ImageUser_path(PointerRNA *ptr)
175 {
176         if (ptr->id.data) {
177                 /* ImageUser *iuser = ptr->data; */
178
179                 switch (GS(((ID *)ptr->id.data)->name)) {
180                         case ID_OB:
181                         case ID_TE:
182                         {
183                                 return BLI_strdup("image_user");
184                         }
185                         case ID_NT:
186                         {
187                                 return rna_Node_ImageUser_path(ptr);
188                         }
189                         default:
190                                 break;
191                 }
192         }
193
194         return BLI_strdup("");
195 }
196
197 static const 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] = unit_float_to_uchar_clamp(values[i]);
400                 }
401
402                 ibuf->userflags |= IB_BITMAPDIRTY | IB_DISPLAY_BUFFER_INVALID | IB_MIPMAP_INVALID;
403                 if (!G.background) {
404                         GPU_free_image(ima);
405                 }
406                 WM_main_add_notifier(NC_IMAGE | ND_DISPLAY, &ima->id);
407         }
408
409         BKE_image_release_ibuf(ima, ibuf, lock);
410 }
411
412 static int rna_Image_channels_get(PointerRNA *ptr)
413 {
414         Image *im = (Image *)ptr->data;
415         ImBuf *ibuf;
416         void *lock;
417         int channels = 0;
418
419         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
420         if (ibuf)
421                 channels = ibuf->channels;
422
423         BKE_image_release_ibuf(im, ibuf, lock);
424
425         return channels;
426 }
427
428 static int rna_Image_is_float_get(PointerRNA *ptr)
429 {
430         Image *im = (Image *)ptr->data;
431         ImBuf *ibuf;
432         void *lock;
433         bool is_float = false;
434
435         ibuf = BKE_image_acquire_ibuf(im, NULL, &lock);
436         if (ibuf)
437                 is_float = ibuf->rect_float != NULL;
438
439         BKE_image_release_ibuf(im, ibuf, lock);
440
441         return is_float;
442 }
443
444 static PointerRNA rna_Image_packed_file_get(PointerRNA *ptr)
445 {
446         Image *ima = (Image *)ptr->id.data;
447
448         if (BKE_image_has_packedfile(ima)) {
449                 ImagePackedFile *imapf = ima->packedfiles.first;
450                 return rna_pointer_inherit_refine(ptr, &RNA_PackedFile, imapf->packedfile);
451         }
452         else {
453                 return PointerRNA_NULL;
454         }
455 }
456
457 static void rna_Image_render_slots_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
458 {
459         Image *image = (Image *)ptr->id.data;
460         rna_iterator_array_begin(iter, (void *)image->render_slots, sizeof(RenderSlot), IMA_MAX_RENDER_SLOT, 0, NULL);
461 }
462
463 static PointerRNA rna_render_slots_active_get(PointerRNA *ptr)
464 {
465         Image *image = (Image *)ptr->id.data;
466         RenderSlot *render_slot = &image->render_slots[image->render_slot];
467
468         return rna_pointer_inherit_refine(ptr, &RNA_RenderSlot, render_slot);
469 }
470
471 static void rna_render_slots_active_set(PointerRNA *ptr, PointerRNA value)
472 {
473         Image *image = (Image *)ptr->id.data;
474         if (value.id.data == image) {
475                 RenderSlot *render_slot = (RenderSlot *)value.data;
476                 int index = render_slot - image->render_slots;
477                 image->render_slot = CLAMPIS(index, 0, IMA_MAX_RENDER_SLOT - 1);
478         }
479 }
480
481 static int rna_render_slots_active_index_get(PointerRNA *ptr)
482 {
483         Image *image = (Image *)ptr->id.data;
484         return image->render_slot;
485 }
486
487 static void rna_render_slots_active_index_set(PointerRNA *ptr, int value)
488 {
489         Image *image = (Image *)ptr->id.data;
490         image->render_slot = value;
491         CLAMP(image->render_slot, 0, IMA_MAX_RENDER_SLOT - 1);
492 }
493
494 #else
495
496 static void rna_def_imageuser(BlenderRNA *brna)
497 {
498         StructRNA *srna;
499         PropertyRNA *prop;
500
501         srna = RNA_def_struct(brna, "ImageUser", NULL);
502         RNA_def_struct_ui_text(srna, "Image User",
503                                "Parameters defining how an Image data-block is used by another data-block");
504         RNA_def_struct_path_func(srna, "rna_ImageUser_path");
505
506         prop = RNA_def_property(srna, "use_auto_refresh", PROP_BOOLEAN, PROP_NONE);
507         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
508         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes");
509         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
510         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
511
512         prop = RNA_def_property(srna, "frame_current", PROP_INT, PROP_TIME);
513         RNA_def_property_int_sdna(prop, NULL, "framenr");
514         RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
515         RNA_def_property_ui_text(prop, "Current Frame", "Current frame number in image sequence or movie");
516
517         /* animation */
518         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
519         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
520         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie");
521         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
522         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
523
524         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_NONE);
525         RNA_def_property_int_sdna(prop, NULL, "frames");
526         RNA_def_property_range(prop, 0, MAXFRAMEF);
527         RNA_def_property_ui_text(prop, "Frames", "Number of images of a movie to use");
528         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
529         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
530
531         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
532         RNA_def_property_int_sdna(prop, NULL, "offset");
533         RNA_def_property_ui_text(prop, "Offset", "Offset the number of the frame to use in the animation");
534         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
535
536         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
537         RNA_def_property_int_sdna(prop, NULL, "sfra");
538         RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
539         RNA_def_property_ui_text(prop, "Start Frame",
540                                  "Global starting frame of the movie/sequence, assuming first picture has a #1");
541         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
542         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
543
544         prop = RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
545         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
546         RNA_def_property_range(prop, 1, 200);
547         RNA_def_property_ui_text(prop, "Fields per Frame", "Number of fields per rendered frame (2 fields is 1 image)");
548         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
549         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
550
551         prop = RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
552         RNA_def_property_int_sdna(prop, NULL, "layer");
553         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
554         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image");
555
556         prop = RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
557         RNA_def_property_int_sdna(prop, NULL, "pass");
558         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
559         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image");
560
561         prop = RNA_def_property(srna, "multilayer_view", PROP_INT, PROP_UNSIGNED);
562         RNA_def_property_int_sdna(prop, NULL, "view");
563         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
564         RNA_def_property_ui_text(prop, "View", "View in multilayer image");
565 }
566
567 /* image.packed_files */
568 static void rna_def_image_packed_files(BlenderRNA *brna)
569 {
570         StructRNA *srna;
571         PropertyRNA *prop;
572
573         srna = RNA_def_struct(brna, "ImagePackedFile", NULL);
574         RNA_def_struct_sdna(srna, "ImagePackedFile");
575
576         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
577         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
578         RNA_def_property_ui_text(prop, "Packed File", "");
579         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
580
581         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
582         RNA_def_property_string_sdna(prop, NULL, "filepath");
583         RNA_def_struct_name_property(srna, prop);
584
585         RNA_api_image_packed_file(srna);
586 }
587
588 static void rna_def_render_slot(BlenderRNA *brna)
589 {
590         StructRNA *srna;
591         PropertyRNA *prop;
592         srna = RNA_def_struct(brna, "RenderSlot", NULL);
593         RNA_def_struct_ui_text(srna, "Render Slot", "Parameters defining the render slot");
594
595         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
596         RNA_def_property_string_sdna(prop, NULL, "name");
597         RNA_def_property_ui_text(prop, "Name", "Render slot name");
598         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
599 }
600
601 static void rna_def_render_slots(BlenderRNA *brna)
602 {
603         StructRNA *srna;
604         PropertyRNA *prop;
605
606         srna = RNA_def_struct(brna, "RenderSlots", NULL);
607         RNA_def_struct_sdna(srna, "RenderSlot");
608         RNA_def_struct_ui_text(srna, "Render Slots", "Collection of the render slots");
609
610         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
611         RNA_def_property_struct_type(prop, "RenderSlot");
612         RNA_def_property_pointer_funcs(prop, "rna_render_slots_active_get", "rna_render_slots_active_set", NULL, NULL);
613         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
614         RNA_def_property_ui_text(prop, "Active", "Active render slot of the image");
615         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
616
617         prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_NONE);
618         RNA_def_property_int_funcs(prop, "rna_render_slots_active_index_get",
619                                    "rna_render_slots_active_index_set",
620                                    NULL);
621         RNA_def_property_range(prop, 0, IMA_MAX_RENDER_SLOT);
622         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
623         RNA_def_property_ui_text(prop, "Active Index", "Index of an active render slot of the image");
624         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
625 }
626
627 static void rna_def_image(BlenderRNA *brna)
628 {
629         StructRNA *srna;
630         PropertyRNA *prop;
631         static const EnumPropertyItem prop_type_items[] = {
632                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
633                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
634                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
635                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
636                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
637                 {0, NULL, 0, NULL, NULL}
638         };
639         static const EnumPropertyItem prop_field_order_items[] = {
640                 {0, "EVEN", 0, "Upper First", "Upper field first"},
641                 {IMA_STD_FIELD, "ODD", 0, "Lower First", "Lower field first"},
642                 {0, NULL, 0, NULL, NULL}
643         };
644         static const EnumPropertyItem alpha_mode_items[] = {
645                 {IMA_ALPHA_STRAIGHT, "STRAIGHT", 0, "Straight", "Transparent RGB and alpha pixels are unmodified"},
646                 {IMA_ALPHA_PREMUL, "PREMUL", 0, "Premultiplied", "Transparent RGB pixels are multiplied by the alpha channel"},
647                 {0, NULL, 0, NULL, NULL}
648         };
649
650         srna = RNA_def_struct(brna, "Image", "ID");
651         RNA_def_struct_ui_text(srna, "Image", "Image data-block referencing an external or packed image");
652         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
653
654         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
655         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
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, rna_enum_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_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
696         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
697         RNA_def_property_enum_items(prop, prop_field_order_items);
698         RNA_def_property_ui_text(prop, "Field Order", "Order of video fields (select which lines are displayed first)");
699         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
700
701         /* booleans */
702         prop = RNA_def_property(srna, "use_fields", PROP_BOOLEAN, PROP_NONE);
703         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
704         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
705         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image");
706         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_fields_update");
707         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
708
709
710         prop = RNA_def_property(srna, "use_view_as_render", PROP_BOOLEAN, PROP_NONE);
711         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
712         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_VIEW_AS_RENDER);
713         RNA_def_property_ui_text(prop, "View as Render", "Apply render part of display transformation when displaying this image on the screen");
714         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
715
716         prop = RNA_def_property(srna, "use_alpha", PROP_BOOLEAN, PROP_NONE);
717         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
718         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", IMA_IGNORE_ALPHA);
719         RNA_def_property_ui_text(prop, "Use Alpha", "Use the alpha channel information from the image or make image fully opaque");
720         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
721
722         prop = RNA_def_property(srna, "use_deinterlace", PROP_BOOLEAN, PROP_NONE);
723         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
724         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_DEINTERLACE);
725         RNA_def_property_ui_text(prop, "Deinterlace", "Deinterlace movie file on load");
726         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_reload_update");
727
728         prop = RNA_def_property(srna, "use_multiview", PROP_BOOLEAN, PROP_NONE);
729         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
730         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_USE_VIEWS);
731         RNA_def_property_ui_text(prop, "Use Multi-View", "Use Multiple Views (when available)");
732         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_views_format_update");
733
734         prop = RNA_def_property(srna, "is_stereo_3d", PROP_BOOLEAN, PROP_NONE);
735         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
736         RNA_def_property_boolean_funcs(prop, "rna_Image_is_stereo_3d_get", NULL);
737         RNA_def_property_ui_text(prop, "Stereo 3D", "Image has left and right views");
738         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
739
740         prop = RNA_def_property(srna, "is_multiview", PROP_BOOLEAN, PROP_NONE);
741         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
742         RNA_def_property_boolean_funcs(prop, "rna_Image_is_multiview_get", NULL);
743         RNA_def_property_ui_text(prop, "Multiple Views", "Image has more than one view");
744         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
745
746         prop = RNA_def_property(srna, "is_dirty", PROP_BOOLEAN, PROP_NONE);
747         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
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         prop = RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
790         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
791         RNA_def_property_float_sdna(prop, NULL, "aspx");
792         RNA_def_property_array(prop, 2);
793         RNA_def_property_range(prop, 0.1f, FLT_MAX);
794         RNA_def_property_ui_range(prop, 0.1f, 5000.f, 1, 2);
795         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering");
796         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
797
798         prop = RNA_def_property(srna, "bindcode", PROP_INT, PROP_UNSIGNED);
799         RNA_def_property_int_sdna(prop, NULL, "bindcode");
800         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
801         RNA_def_property_ui_text(prop, "Bindcode", "OpenGL bindcode");
802         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, NULL);
803
804         prop = RNA_def_property(srna, "render_slots", PROP_COLLECTION, PROP_NONE);
805         RNA_def_property_struct_type(prop, "RenderSlot");
806         RNA_def_property_ui_text(prop, "Render Slots", "Render slots of the image");
807         RNA_def_property_collection_funcs(prop, "rna_Image_render_slots_begin", "rna_iterator_array_next",
808                                           "rna_iterator_array_end", "rna_iterator_array_get", NULL, NULL, NULL, NULL);
809         RNA_def_property_srna(prop, "RenderSlots");
810
811         /*
812          * Image.has_data and Image.depth are temporary,
813          * Update import_obj.py when they are replaced (Arystan)
814          */
815         prop = RNA_def_property(srna, "has_data", PROP_BOOLEAN, PROP_NONE);
816         RNA_def_property_boolean_funcs(prop, "rna_Image_has_data_get", NULL);
817         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
818         RNA_def_property_ui_text(prop, "Has Data", "True if the image data is loaded into memory");
819
820         prop = RNA_def_property(srna, "depth", PROP_INT, PROP_UNSIGNED);
821         RNA_def_property_int_funcs(prop, "rna_Image_depth_get", NULL, NULL);
822         RNA_def_property_ui_text(prop, "Depth", "Image bit depth");
823         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
824
825         prop = RNA_def_int_vector(srna, "size", 2, NULL, 0, 0, "Size",
826                                   "Width and height in pixels, zero when image data cant be loaded", 0, 0);
827         RNA_def_property_subtype(prop, PROP_PIXEL);
828         RNA_def_property_int_funcs(prop, "rna_Image_size_get", NULL, NULL);
829         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
830
831         prop = RNA_def_float_vector(srna, "resolution", 2, NULL, 0, 0, "Resolution", "X/Y pixels per meter", 0, 0);
832         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
833         RNA_def_property_float_funcs(prop, "rna_Image_resolution_get", "rna_Image_resolution_set", NULL);
834
835         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_UNSIGNED);
836         RNA_def_property_int_funcs(prop, "rna_Image_frame_duration_get", NULL, NULL);
837         RNA_def_property_ui_text(prop, "Duration", "Duration (in frames) of the image (1 when not a video/sequence)");
838         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
839
840         /* NOTE about pixels/channels/is_floa:
841          * this properties describes how image is stored internally (inside of ImBuf),
842          * not how it was saved to disk or how it'll be saved on disk
843          */
844         prop = RNA_def_property(srna, "pixels", PROP_FLOAT, PROP_NONE);
845         RNA_def_property_flag(prop, PROP_DYNAMIC);
846         RNA_def_property_multi_array(prop, 1, NULL);
847         RNA_def_property_ui_text(prop, "Pixels", "Image pixels in floating point values");
848         RNA_def_property_dynamic_array_funcs(prop, "rna_Image_pixels_get_length");
849         RNA_def_property_float_funcs(prop, "rna_Image_pixels_get", "rna_Image_pixels_set", NULL);
850
851         prop = RNA_def_property(srna, "channels", PROP_INT, PROP_UNSIGNED);
852         RNA_def_property_int_funcs(prop, "rna_Image_channels_get", NULL, NULL);
853         RNA_def_property_ui_text(prop, "Channels", "Number of channels in pixels buffer");
854         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
855
856         prop = RNA_def_property(srna, "is_float", PROP_BOOLEAN, PROP_NONE);
857         RNA_def_property_boolean_funcs(prop, "rna_Image_is_float_get", NULL);
858         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
859         RNA_def_property_ui_text(prop, "Is Float", "True if this image is stored in float buffer");
860
861         prop = RNA_def_property(srna, "colorspace_settings", PROP_POINTER, PROP_NONE);
862         RNA_def_property_pointer_sdna(prop, NULL, "colorspace_settings");
863         RNA_def_property_struct_type(prop, "ColorManagedInputColorspaceSettings");
864         RNA_def_property_ui_text(prop, "Color Space Settings", "Input color space settings");
865
866         prop = RNA_def_property(srna, "alpha_mode", PROP_ENUM, PROP_NONE);
867         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
868         RNA_def_property_enum_items(prop, alpha_mode_items);
869         RNA_def_property_ui_text(prop, "Alpha Mode", "Representation of alpha information in the RGBA pixels");
870         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_colormanage_update");
871
872         /* multiview */
873         prop = RNA_def_property(srna, "views_format", PROP_ENUM, PROP_NONE);
874         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
875         RNA_def_property_enum_sdna(prop, NULL, "views_format");
876         RNA_def_property_enum_items(prop, rna_enum_views_format_items);
877         RNA_def_property_ui_text(prop, "Views Format", "Mode to load image views");
878         RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_views_format_update");
879
880         prop = RNA_def_property(srna, "stereo_3d_format", PROP_POINTER, PROP_NONE);
881         RNA_def_property_pointer_sdna(prop, NULL, "stereo3d_format");
882         RNA_def_property_flag(prop, PROP_NEVER_NULL);
883         RNA_def_property_struct_type(prop, "Stereo3dFormat");
884         RNA_def_property_ui_text(prop, "Stereo 3D Format", "Settings for stereo 3d");
885
886         RNA_api_image(srna);
887 }
888
889 void RNA_def_image(BlenderRNA *brna)
890 {
891         rna_def_render_slot(brna);
892         rna_def_render_slots(brna);
893         rna_def_image(brna);
894         rna_def_imageuser(brna);
895         rna_def_image_packed_files(brna);
896 }
897
898 #endif