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