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