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