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