Merged changes in the trunk up to revision 52815.
[blender-staging.git] / source / blender / makesrna / intern / rna_color.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): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_color.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29 #include <stdio.h>
30
31 #include "RNA_define.h"
32 #include "rna_internal.h"
33
34 #include "DNA_color_types.h"
35 #include "DNA_texture_types.h"
36
37 #include "WM_api.h"
38 #include "WM_types.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "RNA_access.h"
43
44 #include "DNA_image_types.h"
45 #include "DNA_material_types.h"
46 #include "DNA_movieclip_types.h"
47 #include "DNA_node_types.h"
48 #include "DNA_sequence_types.h"
49
50 #include "MEM_guardedalloc.h"
51
52 #include "BKE_colortools.h"
53 #include "BKE_depsgraph.h"
54 #include "BKE_image.h"
55 #include "BKE_movieclip.h"
56 #include "BKE_node.h"
57 #include "BKE_sequencer.h"
58 #include "BKE_texture.h"
59 #include "BKE_linestyle.h"
60
61 #include "ED_node.h"
62
63 #include "IMB_colormanagement.h"
64
65 static int rna_CurveMapping_curves_length(PointerRNA *ptr)
66 {
67         CurveMapping *cumap = (CurveMapping *)ptr->data;
68         int len;
69
70         for (len = 0; len < CM_TOT; len++)
71                 if (!cumap->cm[len].curve)
72                         break;
73         
74         return len;
75 }
76
77 static void rna_CurveMapping_curves_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
78 {
79         CurveMapping *cumap = (CurveMapping *)ptr->data;
80
81         rna_iterator_array_begin(iter, cumap->cm, sizeof(CurveMap), rna_CurveMapping_curves_length(ptr), 0, NULL);
82 }
83
84 static void rna_CurveMapping_clip_set(PointerRNA *ptr, int value)
85 {
86         CurveMapping *cumap = (CurveMapping *)ptr->data;
87
88         if (value) cumap->flag |= CUMA_DO_CLIP;
89         else cumap->flag &= ~CUMA_DO_CLIP;
90
91         curvemapping_changed(cumap, FALSE);
92 }
93
94 static void rna_CurveMapping_black_level_set(PointerRNA *ptr, const float *values)
95 {
96         CurveMapping *cumap = (CurveMapping *)ptr->data;
97         cumap->black[0] = values[0];
98         cumap->black[1] = values[1];
99         cumap->black[2] = values[2];
100         curvemapping_set_black_white(cumap, NULL, NULL);
101 }
102
103 static void rna_CurveMapping_white_level_set(PointerRNA *ptr, const float *values)
104 {
105         CurveMapping *cumap = (CurveMapping *)ptr->data;
106         cumap->white[0] = values[0];
107         cumap->white[1] = values[1];
108         cumap->white[2] = values[2];
109         curvemapping_set_black_white(cumap, NULL, NULL);
110 }
111
112 static void rna_CurveMapping_clipminx_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
113 {
114         CurveMapping *cumap = (CurveMapping *)ptr->data;
115
116         *min = -100.0f;
117         *max = cumap->clipr.xmax;
118 }
119
120 static void rna_CurveMapping_clipminy_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
121 {
122         CurveMapping *cumap = (CurveMapping *)ptr->data;
123
124         *min = -100.0f;
125         *max = cumap->clipr.ymax;
126 }
127
128 static void rna_CurveMapping_clipmaxx_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
129 {
130         CurveMapping *cumap = (CurveMapping *)ptr->data;
131
132         *min = cumap->clipr.xmin;
133         *max = 100.0f;
134 }
135
136 static void rna_CurveMapping_clipmaxy_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
137 {
138         CurveMapping *cumap = (CurveMapping *)ptr->data;
139
140         *min = cumap->clipr.ymin;
141         *max = 100.0f;
142 }
143
144
145 static char *rna_ColorRamp_path(PointerRNA *ptr)
146 {
147         char *path = NULL;
148         
149         /* handle the cases where a single datablock may have 2 ramp types */
150         if (ptr->id.data) {
151                 ID *id = ptr->id.data;
152                 
153                 switch (GS(id->name)) {
154                         case ID_MA: /* material has 2 cases - diffuse and specular */
155                         {
156                                 Material *ma = (Material *)id;
157                                 
158                                 if (ptr->data == ma->ramp_col)
159                                         path = BLI_strdup("diffuse_ramp");
160                                 else if (ptr->data == ma->ramp_spec)
161                                         path = BLI_strdup("specular_ramp");
162                                 break;
163                         }
164                         
165                         case ID_NT:
166                         {
167                                 bNodeTree *ntree = (bNodeTree *)id;
168                                 bNode *node;
169                                 PointerRNA node_ptr;
170                                 char *node_path;
171                                 
172                                 for (node = ntree->nodes.first; node; node = node->next) {
173                                         if (ELEM3(node->type, SH_NODE_VALTORGB, CMP_NODE_VALTORGB, TEX_NODE_VALTORGB)) {
174                                                 if (node->storage == ptr->data) {
175                                                         /* all node color ramp properties called 'color_ramp'
176                                                          * prepend path from ID to the node
177                                                          */
178                                                         RNA_pointer_create(id, &RNA_Node, node, &node_ptr);
179                                                         node_path = RNA_path_from_ID_to_struct(&node_ptr);
180                                                         path = BLI_sprintfN("%s.color_ramp", node_path);
181                                                         MEM_freeN(node_path);
182                                                 }
183                                         }
184                                 }
185                                 break;
186                         }
187                         
188                         default:
189                                 /* everything else just uses 'color_ramp' */
190                                 path = BLI_strdup("color_ramp");
191                                 break;
192
193                         case ID_LS:
194                         {
195                                 char *path = FRS_path_from_ID_to_color_ramp((FreestyleLineStyle *)id, (ColorBand *)ptr->data);
196                                 if (path)
197                                         return path;
198                         }
199                                 break;
200                 }
201         }
202         else {
203                 /* everything else just uses 'color_ramp' */
204                 path = BLI_strdup("color_ramp");
205         }
206         
207         return path;
208 }
209
210 static char *rna_ColorRampElement_path(PointerRNA *ptr)
211 {
212         PointerRNA ramp_ptr;
213         PropertyRNA *prop;
214         char *path = NULL;
215         int index;
216         
217         /* helper macro for use here to try and get the path
218          *      - this calls the standard code for getting a path to a texture...
219          */
220
221 #define COLRAMP_GETPATH                                                       \
222 {                                                                             \
223         prop = RNA_struct_find_property(&ramp_ptr, "elements");                   \
224         if (prop) {                                                               \
225                 index = RNA_property_collection_lookup_index(&ramp_ptr, prop, ptr);   \
226                 if (index >= 0) {                                                     \
227                         char *texture_path = rna_ColorRamp_path(&ramp_ptr);               \
228                         path = BLI_sprintfN("%s.elements[%d]", texture_path, index);      \
229                         MEM_freeN(texture_path);                                          \
230                 }                                                                     \
231         }                                                                         \
232 } (void)0
233
234         /* determine the path from the ID-block to the ramp */
235         /* FIXME: this is a very slow way to do it, but it will have to suffice... */
236         if (ptr->id.data) {
237                 ID *id = ptr->id.data;
238                 
239                 switch (GS(id->name)) {
240                         case ID_MA: /* 2 cases for material - diffuse and spec */
241                         {
242                                 Material *ma = (Material *)id;
243                                 
244                                 /* try diffuse first */
245                                 if (ma->ramp_col) {
246                                         RNA_pointer_create(id, &RNA_ColorRamp, ma->ramp_col, &ramp_ptr);
247                                         COLRAMP_GETPATH;
248                                 }
249                                 /* try specular if not diffuse */
250                                 if (!path && ma->ramp_spec) {
251                                         RNA_pointer_create(id, &RNA_ColorRamp, ma->ramp_spec, &ramp_ptr);
252                                         COLRAMP_GETPATH;
253                                 }
254                         }
255                         break;
256                                 
257                         case ID_NT:
258                         {
259                                 bNodeTree *ntree = (bNodeTree *)id;
260                                 bNode *node;
261                                 
262                                 for (node = ntree->nodes.first; node; node = node->next) {
263                                         if (ELEM3(node->type, SH_NODE_VALTORGB, CMP_NODE_VALTORGB, TEX_NODE_VALTORGB)) {
264                                                 RNA_pointer_create(id, &RNA_ColorRamp, node->storage, &ramp_ptr);
265                                                 COLRAMP_GETPATH;
266                                         }
267                                 }
268                         }
269                         break;
270                                 
271                         case ID_LS:
272                         {
273                                 ListBase listbase;
274                                 LinkData *link;
275
276                                 FRS_list_modifier_color_ramps((FreestyleLineStyle *)id, &listbase);
277                                 for (link = (LinkData *)listbase.first; link; link = link->next) {
278                                         RNA_pointer_create(id, &RNA_ColorRamp, link->data, &ramp_ptr);
279                                         COLRAMP_GETPATH;
280                                 }
281                                 BLI_freelistN(&listbase);
282                         }
283                                 break;
284
285                         default: /* everything else should have a "color_ramp" property */
286                         {
287                                 /* create pointer to the ID block, and try to resolve "color_ramp" pointer */
288                                 RNA_id_pointer_create(id, &ramp_ptr);
289                                 if (RNA_path_resolve(&ramp_ptr, "color_ramp", &ramp_ptr, &prop)) {
290                                         COLRAMP_GETPATH;
291                                 }
292                         }
293                 }
294         }
295         
296         /* cleanup the macro we defined */
297 #undef COLRAMP_GETPATH
298         
299         return path;
300 }
301
302 static void rna_ColorRamp_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
303 {
304         if (ptr->id.data) {
305                 ID *id = ptr->id.data;
306                 
307                 switch (GS(id->name)) {
308                         case ID_MA:
309                         {
310                                 Material *ma = ptr->id.data;
311                                 
312                                 DAG_id_tag_update(&ma->id, 0);
313                                 WM_main_add_notifier(NC_MATERIAL | ND_SHADING_DRAW, ma);
314                         }
315                         break;
316                         case ID_NT:
317                         {
318                                 bNodeTree *ntree = (bNodeTree *)id;
319                                 bNode *node;
320
321                                 for (node = ntree->nodes.first; node; node = node->next) {
322                                         if (ELEM3(node->type, SH_NODE_VALTORGB, CMP_NODE_VALTORGB, TEX_NODE_VALTORGB)) {
323                                                 ED_node_generic_update(bmain, ntree, node);
324                                         }
325                                 }
326                         }
327                         break;
328                         case ID_TE:
329                         {
330                                 Tex *tex = ptr->id.data;
331
332                                 DAG_id_tag_update(&tex->id, 0);
333                                 WM_main_add_notifier(NC_TEXTURE, tex);
334                         }
335                         break;
336                         case ID_LS:
337                         {
338                                 FreestyleLineStyle *linestyle= ptr->id.data;
339
340                                 WM_main_add_notifier(NC_LINESTYLE, linestyle);
341                         }
342                                 break;
343                         default:
344                                 break;
345                 }
346         }
347 }
348
349 static void rna_ColorRamp_eval(struct ColorBand *coba, float position, float color[4])
350 {
351         do_colorband(coba, position, color);
352 }
353
354 static CBData *rna_ColorRampElement_new(struct ColorBand *coba, ReportList *reports, float position)
355 {
356         CBData *element = colorband_element_add(coba, position);
357
358         if (element == NULL)
359                 BKE_reportf(reports, RPT_ERROR, "Unable to add element to colorband (limit %d)", MAXCOLORBAND);
360
361         return element;
362 }
363
364 static void rna_ColorRampElement_remove(struct ColorBand *coba, ReportList *reports, PointerRNA *element_ptr)
365 {
366         CBData *element = element_ptr->data;
367         int index = (int)(element - coba->data);
368         if (colorband_element_remove(coba, index) == FALSE) {
369                 BKE_report(reports, RPT_ERROR, "Element not found in element collection or last element");
370                 return;
371         }
372
373         RNA_POINTER_INVALIDATE(element_ptr);
374 }
375
376 void rna_CurveMap_remove_point(CurveMap *cuma, ReportList *reports, PointerRNA *point_ptr)
377 {
378         CurveMapPoint *point = point_ptr->data;
379         if (curvemap_remove_point(cuma, point) == FALSE) {
380                 BKE_report(reports, RPT_ERROR, "Unable to remove curve point");
381                 return;
382         }
383
384         RNA_POINTER_INVALIDATE(point_ptr);
385 }
386
387 static void rna_Scopes_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
388 {
389         Scopes *s = (Scopes *)ptr->data;
390         s->ok = 0;
391 }
392
393 static int rna_ColorManagedDisplaySettings_display_device_get(struct PointerRNA *ptr)
394 {
395         ColorManagedDisplaySettings *display = (ColorManagedDisplaySettings *) ptr->data;
396
397         return IMB_colormanagement_display_get_named_index(display->display_device);
398 }
399
400 static void rna_ColorManagedDisplaySettings_display_device_set(struct PointerRNA *ptr, int value)
401 {
402         ColorManagedDisplaySettings *display = (ColorManagedDisplaySettings *) ptr->data;
403         const char *name = IMB_colormanagement_display_get_indexed_name(value);
404
405         if (name) {
406                 BLI_strncpy(display->display_device, name, sizeof(display->display_device));
407         }
408 }
409
410 static EnumPropertyItem *rna_ColorManagedDisplaySettings_display_device_itemf(bContext *C, PointerRNA *ptr, PropertyRNA *UNUSED(prop), int *free)
411 {
412         EnumPropertyItem *items = NULL;
413         int totitem = 0;
414
415         IMB_colormanagement_display_items_add(&items, &totitem);
416         RNA_enum_item_end(&items, &totitem);
417
418         *free = TRUE;
419
420         return items;
421 }
422
423 static void rna_ColorManagedDisplaySettings_display_device_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
424 {
425         ID *id = ptr->id.data;
426
427         if (!id)
428                 return;
429
430         if (GS(id->name) == ID_SCE) {
431                 Scene *scene = (Scene *) id;
432
433                 IMB_colormanagement_validate_settings(&scene->display_settings, &scene->view_settings);
434
435                 WM_main_add_notifier(NC_SCENE | ND_SEQUENCER, NULL);
436         }
437 }
438
439 static int rna_ColorManagedViewSettings_view_transform_get(PointerRNA *ptr)
440 {
441         ColorManagedViewSettings *view = (ColorManagedViewSettings *) ptr->data;
442
443         return IMB_colormanagement_view_get_named_index(view->view_transform);
444 }
445
446 static void rna_ColorManagedViewSettings_view_transform_set(PointerRNA *ptr, int value)
447 {
448         ColorManagedViewSettings *view = (ColorManagedViewSettings *) ptr->data;
449
450         const char *name = IMB_colormanagement_view_get_indexed_name(value);
451
452         if (name) {
453                 BLI_strncpy(view->view_transform, name, sizeof(view->view_transform));
454         }
455 }
456
457 static EnumPropertyItem* rna_ColorManagedViewSettings_view_transform_itemf(bContext *C, PointerRNA *ptr, PropertyRNA *UNUSED(prop), int *free)
458 {
459         Scene *scene = CTX_data_scene(C);
460         EnumPropertyItem *items = NULL;
461         ColorManagedDisplaySettings *display_settings = &scene->display_settings;
462         int totitem = 0;
463
464         IMB_colormanagement_view_items_add(&items, &totitem, display_settings->display_device);
465         RNA_enum_item_end(&items, &totitem);
466
467         *free = TRUE;
468         return items;
469 }
470
471 static void rna_ColorManagedViewSettings_use_curves_set(PointerRNA *ptr, int value)
472 {
473         ColorManagedViewSettings *view_settings = (ColorManagedViewSettings *) ptr->data;
474
475         if (value) {
476                 view_settings->flag |= COLORMANAGE_VIEW_USE_CURVES;
477
478                 if (view_settings->curve_mapping == NULL) {
479                         view_settings->curve_mapping = curvemapping_add(4, 0.0f, 0.0f, 1.0f, 1.0f);
480                 }
481         }
482         else {
483                 view_settings->flag &= ~COLORMANAGE_VIEW_USE_CURVES;
484         }
485 }
486
487 static int rna_ColorManagedColorspaceSettings_colorspace_get(struct PointerRNA *ptr)
488 {
489         ColorManagedColorspaceSettings *colorspace = (ColorManagedColorspaceSettings *) ptr->data;
490
491         return IMB_colormanagement_colorspace_get_named_index(colorspace->name);
492 }
493
494 static void rna_ColorManagedColorspaceSettings_colorspace_set(struct PointerRNA *ptr, int value)
495 {
496         ColorManagedColorspaceSettings *colorspace = (ColorManagedColorspaceSettings *) ptr->data;
497         const char *name = IMB_colormanagement_colorspace_get_indexed_name(value);
498
499         if (name) {
500                 BLI_strncpy(colorspace->name, name, sizeof(colorspace->name));
501         }
502 }
503
504 static EnumPropertyItem *rna_ColorManagedColorspaceSettings_colorspace_itemf(bContext *C, PointerRNA *ptr, PropertyRNA *UNUSED(prop), int *free)
505 {
506         EnumPropertyItem *items = NULL;
507         int totitem = 0;
508
509         IMB_colormanagement_colorspace_items_add(&items, &totitem);
510         RNA_enum_item_end(&items, &totitem);
511
512         *free = TRUE;
513
514         return items;
515 }
516
517 static void rna_ColorManagedColorspaceSettings_reload_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
518 {
519         ID *id = ptr->id.data;
520
521         if (GS(id->name) == ID_IM) {
522                 Image *ima = (Image *) id;
523
524                 DAG_id_tag_update(&ima->id, 0);
525
526                 BKE_image_signal(ima, NULL, IMA_SIGNAL_COLORMANAGE);
527
528                 WM_main_add_notifier(NC_IMAGE | ND_DISPLAY, &ima->id);
529                 WM_main_add_notifier(NC_IMAGE | NA_EDITED, &ima->id);
530         }
531         else if (GS(id->name) == ID_MC) {
532                 MovieClip *clip = (MovieClip *) id;
533
534                 BKE_movieclip_reload(clip);
535
536                 /* all sequencers for now, we don't know which scenes are using this clip as a strip */
537                 BKE_sequencer_cache_cleanup();
538                 BKE_sequencer_preprocessed_cache_cleanup();
539
540                 WM_main_add_notifier(NC_MOVIECLIP | ND_DISPLAY, &clip->id);
541                 WM_main_add_notifier(NC_MOVIECLIP | NA_EDITED, &clip->id);
542         }
543         else if (GS(id->name) == ID_SCE) {
544                 Scene *scene = (Scene *) id;
545
546                 if (scene->ed) {
547                         ColorManagedColorspaceSettings *colorspace_settings = (ColorManagedColorspaceSettings *) ptr->data;
548                         Sequence *seq;
549                         int seq_found = FALSE;
550
551                         if (&scene->sequencer_colorspace_settings != colorspace_settings) {
552                                 SEQ_BEGIN(scene->ed, seq);
553                                 {
554                                         if (seq->strip && &seq->strip->colorspace_settings == colorspace_settings) {
555                                                 seq_found = TRUE;
556                                                 break;
557                                         }
558                                 }
559                                 SEQ_END;
560                         }
561
562                         if (seq_found) {
563                                 BKE_sequence_invalidate_cache(scene, seq);
564                                 BKE_sequencer_preprocessed_cache_cleanup_sequence(seq);
565                         }
566                         else {
567                                 BKE_sequencer_cache_cleanup();
568                                 BKE_sequencer_preprocessed_cache_cleanup();
569                         }
570
571                         WM_main_add_notifier(NC_SCENE | ND_SEQUENCER, NULL);
572                 }
573         }
574 }
575
576 static void rna_ColorManagement_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
577 {
578         ID *id = ptr->id.data;
579
580         if (!id)
581                 return;
582
583         if (GS(id->name) == ID_SCE) {
584                 WM_main_add_notifier(NC_SCENE | ND_SEQUENCER, NULL);
585         }
586 }
587
588 /* this function only exists because #curvemap_evaluateF uses a 'const' qualifier */
589 static float rna_CurveMap_evaluateF(struct CurveMap *cuma, float value)
590 {
591         return curvemap_evaluateF(cuma, value);
592 }
593
594 #else
595
596 static void rna_def_curvemappoint(BlenderRNA *brna)
597 {
598         StructRNA *srna;
599         PropertyRNA *prop;
600         static EnumPropertyItem prop_handle_type_items[] = {
601                 {0, "AUTO", 0, "Auto Handle", ""},
602                 {CUMA_VECTOR, "VECTOR", 0, "Vector Handle", ""},
603                 {0, NULL, 0, NULL, NULL}
604         };
605
606         srna = RNA_def_struct(brna, "CurveMapPoint", NULL);
607         RNA_def_struct_ui_text(srna, "CurveMapPoint", "Point of a curve used for a curve mapping");
608
609         prop = RNA_def_property(srna, "location", PROP_FLOAT, PROP_XYZ);
610         RNA_def_property_float_sdna(prop, NULL, "x");
611         RNA_def_property_array(prop, 2);
612         RNA_def_property_ui_text(prop, "Location", "X/Y coordinates of the curve point");
613
614         prop = RNA_def_property(srna, "handle_type", PROP_ENUM, PROP_NONE);
615         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
616         RNA_def_property_enum_items(prop, prop_handle_type_items);
617         RNA_def_property_ui_text(prop, "Handle Type", "Curve interpolation at this point: Bezier or vector");
618
619         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
620         RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_SELECT);
621         RNA_def_property_ui_text(prop, "Select", "Selection state of the curve point");
622 }
623
624 static void rna_def_curvemap_points_api(BlenderRNA *brna, PropertyRNA *cprop)
625 {
626         StructRNA *srna;
627         PropertyRNA *parm;
628         FunctionRNA *func;
629
630         RNA_def_property_srna(cprop, "CurveMapPoints");
631         srna = RNA_def_struct(brna, "CurveMapPoints", NULL);
632         RNA_def_struct_sdna(srna, "CurveMap");
633         RNA_def_struct_ui_text(srna, "Curve Map Point", "Collection of Curve Map Points");
634
635         func = RNA_def_function(srna, "new", "curvemap_insert");
636         RNA_def_function_ui_description(func, "Add point to CurveMap");
637         parm = RNA_def_float(func, "position", 0.0f, -FLT_MAX, FLT_MAX, "Position", "Position to add point", -FLT_MAX, FLT_MAX);
638         RNA_def_property_flag(parm, PROP_REQUIRED);
639         parm = RNA_def_float(func, "value", 0.0f, -FLT_MAX, FLT_MAX, "Value", "Value of point", -FLT_MAX, FLT_MAX);
640         RNA_def_property_flag(parm, PROP_REQUIRED);
641         parm = RNA_def_pointer(func, "point", "CurveMapPoint", "", "New point");
642         RNA_def_function_return(func, parm);
643
644         func = RNA_def_function(srna, "remove", "rna_CurveMap_remove_point");
645         RNA_def_function_flag(func, FUNC_USE_REPORTS);
646         RNA_def_function_ui_description(func, "Delete point from CurveMap");
647         parm = RNA_def_pointer(func, "point", "CurveMapPoint", "", "PointElement to remove");
648         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
649         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
650 }
651
652 static void rna_def_curvemap(BlenderRNA *brna)
653 {
654         StructRNA *srna;
655         PropertyRNA *prop, *parm;
656         FunctionRNA *func;
657
658         static EnumPropertyItem prop_extend_items[] = {
659                 {0, "HORIZONTAL", 0, "Horizontal", ""},
660                 {CUMA_EXTEND_EXTRAPOLATE, "EXTRAPOLATED", 0, "Extrapolated", ""},
661                 {0, NULL, 0, NULL, NULL}
662         };
663
664         srna = RNA_def_struct(brna, "CurveMap", NULL);
665         RNA_def_struct_ui_text(srna, "CurveMap", "Curve in a curve mapping");
666
667         prop = RNA_def_property(srna, "extend", PROP_ENUM, PROP_NONE);
668         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
669         RNA_def_property_enum_items(prop, prop_extend_items);
670         RNA_def_property_ui_text(prop, "Extend", "Extrapolate the curve or extend it horizontally");
671
672         prop = RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
673         RNA_def_property_collection_sdna(prop, NULL, "curve", "totpoint");
674         RNA_def_property_struct_type(prop, "CurveMapPoint");
675         RNA_def_property_ui_text(prop, "Points", "");
676         rna_def_curvemap_points_api(brna, prop);
677
678         func = RNA_def_function(srna, "evaluate", "rna_CurveMap_evaluateF");
679         RNA_def_function_ui_description(func, "Evaluate curve at given location");
680         parm = RNA_def_float(func, "position", 0.0f, -FLT_MAX, FLT_MAX, "Position", "Position to evaluate curve at", -FLT_MAX, FLT_MAX);
681         RNA_def_property_flag(parm, PROP_REQUIRED);
682         parm = RNA_def_float(func, "value", 0.0f, -FLT_MAX, FLT_MAX, "Value", "Value of curve at given location", -FLT_MAX, FLT_MAX);
683         RNA_def_function_return(func, parm);
684 }
685
686 static void rna_def_curvemapping(BlenderRNA *brna)
687 {
688         StructRNA *srna;
689         PropertyRNA *prop;
690         FunctionRNA *func;
691
692         srna = RNA_def_struct(brna, "CurveMapping", NULL);
693         RNA_def_struct_ui_text(srna, "CurveMapping",
694                                "Curve mapping to map color, vector and scalar values to other values using "
695                                "a user defined curve");
696         
697         prop = RNA_def_property(srna, "use_clip", PROP_BOOLEAN, PROP_NONE);
698         RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_DO_CLIP);
699         RNA_def_property_ui_text(prop, "Clip", "Force the curve view to fit a defined boundary");
700         RNA_def_property_boolean_funcs(prop, NULL, "rna_CurveMapping_clip_set");
701
702         prop = RNA_def_property(srna, "clip_min_x", PROP_FLOAT, PROP_NONE);
703         RNA_def_property_float_sdna(prop, NULL, "clipr.xmin");
704         RNA_def_property_range(prop, -100.0f, 100.0f);
705         RNA_def_property_ui_text(prop, "Clip Min X", "");
706         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipminx_range");
707
708         prop = RNA_def_property(srna, "clip_min_y", PROP_FLOAT, PROP_NONE);
709         RNA_def_property_float_sdna(prop, NULL, "clipr.ymin");
710         RNA_def_property_range(prop, -100.0f, 100.0f);
711         RNA_def_property_ui_text(prop, "Clip Min Y", "");
712         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipminy_range");
713
714         prop = RNA_def_property(srna, "clip_max_x", PROP_FLOAT, PROP_NONE);
715         RNA_def_property_float_sdna(prop, NULL, "clipr.xmax");
716         RNA_def_property_range(prop, -100.0f, 100.0f);
717         RNA_def_property_ui_text(prop, "Clip Max X", "");
718         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipmaxx_range");
719
720         prop = RNA_def_property(srna, "clip_max_y", PROP_FLOAT, PROP_NONE);
721         RNA_def_property_float_sdna(prop, NULL, "clipr.ymax");
722         RNA_def_property_range(prop, -100.0f, 100.0f);
723         RNA_def_property_ui_text(prop, "Clip Max Y", "");
724         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipmaxy_range");
725
726         prop = RNA_def_property(srna, "curves", PROP_COLLECTION, PROP_NONE);
727         RNA_def_property_collection_funcs(prop, "rna_CurveMapping_curves_begin", "rna_iterator_array_next",
728                                           "rna_iterator_array_end", "rna_iterator_array_get",
729                                           "rna_CurveMapping_curves_length", NULL, NULL, NULL);
730         RNA_def_property_struct_type(prop, "CurveMap");
731         RNA_def_property_ui_text(prop, "Curves", "");
732
733         prop = RNA_def_property(srna, "black_level", PROP_FLOAT, PROP_COLOR);
734         RNA_def_property_float_sdna(prop, NULL, "black");
735         RNA_def_property_range(prop, -1000.0f, 1000.0f);
736         RNA_def_property_ui_text(prop, "Black Level", "For RGB curves, the color that black is mapped to");
737         RNA_def_property_float_funcs(prop, NULL, "rna_CurveMapping_black_level_set", NULL);
738
739         prop = RNA_def_property(srna, "white_level", PROP_FLOAT, PROP_COLOR);
740         RNA_def_property_float_sdna(prop, NULL, "white");
741         RNA_def_property_range(prop, -1000.0f, 1000.0f);
742         RNA_def_property_ui_text(prop, "White Level", "For RGB curves, the color that white is mapped to");
743         RNA_def_property_float_funcs(prop, NULL, "rna_CurveMapping_white_level_set", NULL);
744
745         func = RNA_def_function(srna, "update", "curvemapping_changed_all");
746         RNA_def_function_ui_description(func, "Update curve mapping after making changes");
747 }
748
749 static void rna_def_color_ramp_element(BlenderRNA *brna)
750 {
751         StructRNA *srna;
752         PropertyRNA *prop;
753
754         srna = RNA_def_struct(brna, "ColorRampElement", NULL);
755         RNA_def_struct_sdna(srna, "CBData");
756         RNA_def_struct_path_func(srna, "rna_ColorRampElement_path");
757         RNA_def_struct_ui_text(srna, "Color Ramp Element", "Element defining a color at a position in the color ramp");
758         
759         prop = RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
760         RNA_def_property_float_sdna(prop, NULL, "r");
761         RNA_def_property_array(prop, 4);
762         RNA_def_property_ui_text(prop, "Color", "Set color of selected color stop");
763         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
764         
765         prop = RNA_def_property(srna, "position", PROP_FLOAT, PROP_NONE);
766         RNA_def_property_float_sdna(prop, NULL, "pos");
767         RNA_def_property_range(prop, 0, 1);
768         RNA_def_property_ui_text(prop, "Position", "Set position of selected color stop");
769         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
770 }
771
772 static void rna_def_color_ramp_element_api(BlenderRNA *brna, PropertyRNA *cprop)
773 {
774         StructRNA *srna;
775         PropertyRNA *parm;
776         FunctionRNA *func;
777
778         RNA_def_property_srna(cprop, "ColorRampElements");
779         srna = RNA_def_struct(brna, "ColorRampElements", NULL);
780         RNA_def_struct_sdna(srna, "ColorBand");
781         RNA_def_struct_path_func(srna, "rna_ColorRampElement_path");
782         RNA_def_struct_ui_text(srna, "Color Ramp Elements", "Collection of Color Ramp Elements");
783
784         /* TODO, make these functions generic in texture.c */
785         func = RNA_def_function(srna, "new", "rna_ColorRampElement_new");
786         RNA_def_function_ui_description(func, "Add element to ColorRamp");
787         RNA_def_function_flag(func, FUNC_USE_REPORTS);
788         parm = RNA_def_float(func, "position", 0.0f, 0.0f, 1.0f, "Position", "Position to add element", 0.0f, 1.0f);
789         RNA_def_property_flag(parm, PROP_REQUIRED);
790         /* return type */
791         parm = RNA_def_pointer(func, "element", "ColorRampElement", "", "New element");
792         RNA_def_function_return(func, parm);
793
794         func = RNA_def_function(srna, "remove", "rna_ColorRampElement_remove");
795         RNA_def_function_ui_description(func, "Delete element from ColorRamp");
796         RNA_def_function_flag(func, FUNC_USE_REPORTS);
797         parm = RNA_def_pointer(func, "element", "ColorRampElement", "", "Element to remove");
798         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
799         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
800 }
801
802 static void rna_def_color_ramp(BlenderRNA *brna)
803 {
804         StructRNA *srna;
805         PropertyRNA *prop;
806         FunctionRNA *func;
807
808         static EnumPropertyItem prop_interpolation_items[] = {
809                 {1, "EASE", 0, "Ease", ""},
810                 {3, "CARDINAL", 0, "Cardinal", ""},
811                 {0, "LINEAR", 0, "Linear", ""},
812                 {2, "B_SPLINE", 0, "B-Spline", ""},
813                 {4, "CONSTANT", 0, "Constant", ""},
814                 {0, NULL, 0, NULL, NULL}
815         };
816         
817         srna = RNA_def_struct(brna, "ColorRamp", NULL);
818         RNA_def_struct_sdna(srna, "ColorBand");
819         RNA_def_struct_path_func(srna, "rna_ColorRamp_path");
820         RNA_def_struct_ui_text(srna, "Color Ramp", "Color ramp mapping a scalar value to a color");
821         
822         prop = RNA_def_property(srna, "elements", PROP_COLLECTION, PROP_COLOR);
823         RNA_def_property_collection_sdna(prop, NULL, "data", "tot");
824         RNA_def_property_struct_type(prop, "ColorRampElement");
825         RNA_def_property_ui_text(prop, "Elements", "");
826         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
827         rna_def_color_ramp_element_api(brna, prop);
828
829         prop = RNA_def_property(srna, "interpolation", PROP_ENUM, PROP_NONE);
830         RNA_def_property_enum_sdna(prop, NULL, "ipotype");
831         RNA_def_property_enum_items(prop, prop_interpolation_items);
832         RNA_def_property_ui_text(prop, "Interpolation", "");
833         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
834
835 #if 0 /* use len(elements) */
836         prop = RNA_def_property(srna, "total", PROP_INT, PROP_NONE);
837         RNA_def_property_int_sdna(prop, NULL, "tot");
838         /* needs a function to do the right thing when adding elements like colorband_add_cb() */
839         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
840         RNA_def_property_range(prop, 0, 31); /* MAXCOLORBAND = 32 */
841         RNA_def_property_ui_text(prop, "Total", "Total number of elements");
842         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
843 #endif
844         
845         func = RNA_def_function(srna, "evaluate", "rna_ColorRamp_eval");
846         RNA_def_function_ui_description(func, "Evaluate ColorRamp");
847         prop = RNA_def_float(func, "position", 1.0f, 0.0f, 1.0f, "Position", "Evaluate ColorRamp at position", 0.0f, 1.0f);
848         RNA_def_property_flag(prop, PROP_REQUIRED);
849         /* return */
850         prop = RNA_def_float_color(func, "color", 4, NULL, -FLT_MAX, FLT_MAX, "Color", "Color at given position",
851                                    -FLT_MAX, FLT_MAX);
852         RNA_def_property_flag(prop, PROP_THICK_WRAP);
853         RNA_def_function_output(func, prop);
854 }
855
856 static void rna_def_histogram(BlenderRNA *brna)
857 {
858         StructRNA *srna;
859         PropertyRNA *prop;
860         
861         static EnumPropertyItem prop_mode_items[] = {
862                 {HISTO_MODE_LUMA, "LUMA", 0, "Luma", "Luma"},
863                 {HISTO_MODE_RGB, "RGB", 0, "RGB", "Red Green Blue"},
864                 {HISTO_MODE_R, "R", 0, "R", "Red"},
865                 {HISTO_MODE_G, "G", 0, "G", "Green"},
866                 {HISTO_MODE_B, "B", 0, "B", "Blue"},
867                 {HISTO_MODE_ALPHA, "A", 0, "A", "Alpha"},
868                 {0, NULL, 0, NULL, NULL}
869         };
870
871         srna = RNA_def_struct(brna, "Histogram", NULL);
872         RNA_def_struct_ui_text(srna, "Histogram", "Statistical view of the levels of color in an image");
873         
874         prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
875         RNA_def_property_enum_sdna(prop, NULL, "mode");
876         RNA_def_property_enum_items(prop, prop_mode_items);
877         RNA_def_property_ui_text(prop, "Mode", "Channels to display when drawing the histogram");
878
879         prop = RNA_def_property(srna, "show_line", PROP_BOOLEAN, PROP_NONE);
880         RNA_def_property_boolean_sdna(prop, NULL, "flag", HISTO_FLAG_LINE);
881         RNA_def_property_ui_text(prop, "Show Line", "Display lines rather then filled shapes");
882         RNA_def_property_ui_icon(prop, ICON_IPO, 0);
883 }
884
885 static void rna_def_scopes(BlenderRNA *brna)
886 {
887         StructRNA *srna;
888         PropertyRNA *prop;
889
890         static EnumPropertyItem prop_wavefrm_mode_items[] = {
891                 {SCOPES_WAVEFRM_LUMA, "LUMA", ICON_COLOR, "Luma", ""},
892                 {SCOPES_WAVEFRM_RGB, "RGB", ICON_COLOR, "Red Green Blue", ""},
893                 {SCOPES_WAVEFRM_YCC_601, "YCBCR601", ICON_COLOR, "YCbCr (ITU 601)", ""},
894                 {SCOPES_WAVEFRM_YCC_709, "YCBCR709", ICON_COLOR, "YCbCr (ITU 709)", ""},
895                 {SCOPES_WAVEFRM_YCC_JPEG, "YCBCRJPG", ICON_COLOR, "YCbCr (Jpeg)", ""},
896                 {0, NULL, 0, NULL, NULL}
897         };
898
899         srna = RNA_def_struct(brna, "Scopes", NULL);
900         RNA_def_struct_ui_text(srna, "Scopes", "Scopes for statistical view of an image");
901         
902         prop = RNA_def_property(srna, "use_full_resolution", PROP_BOOLEAN, PROP_NONE);
903         RNA_def_property_boolean_sdna(prop, "Scopes", "sample_full", 1);
904         RNA_def_property_ui_text(prop, "Full Sample", "Sample every pixel of the image");
905         RNA_def_property_update(prop, 0, "rna_Scopes_update");
906         
907         prop = RNA_def_property(srna, "accuracy", PROP_FLOAT, PROP_PERCENTAGE);
908         RNA_def_property_float_sdna(prop, "Scopes", "accuracy");
909         RNA_def_property_range(prop, 0.0, 100.0);
910         RNA_def_property_ui_range(prop, 0.0, 100.0, 10, 1);
911         RNA_def_property_ui_text(prop, "Accuracy", "Proportion of original image source pixel lines to sample");
912         RNA_def_property_update(prop, 0, "rna_Scopes_update");
913
914         prop = RNA_def_property(srna, "histogram", PROP_POINTER, PROP_NONE);
915         RNA_def_property_pointer_sdna(prop, "Scopes", "hist");
916         RNA_def_property_struct_type(prop, "Histogram");
917         RNA_def_property_ui_text(prop, "Histogram", "Histogram for viewing image statistics");
918
919         prop = RNA_def_property(srna, "waveform_mode", PROP_ENUM, PROP_NONE);
920         RNA_def_property_enum_sdna(prop, "Scopes", "wavefrm_mode");
921         RNA_def_property_enum_items(prop, prop_wavefrm_mode_items);
922         RNA_def_property_ui_text(prop, "Waveform Mode", "");
923         RNA_def_property_update(prop, 0, "rna_Scopes_update");
924
925         prop = RNA_def_property(srna, "waveform_alpha", PROP_FLOAT, PROP_FACTOR);
926         RNA_def_property_float_sdna(prop, "Scopes", "wavefrm_alpha");
927         RNA_def_property_range(prop, 0, 1);
928         RNA_def_property_ui_text(prop, "Waveform Opacity", "Opacity of the points");
929
930         prop = RNA_def_property(srna, "vectorscope_alpha", PROP_FLOAT, PROP_FACTOR);
931         RNA_def_property_float_sdna(prop, "Scopes", "vecscope_alpha");
932         RNA_def_property_range(prop, 0, 1);
933         RNA_def_property_ui_text(prop, "Vectorscope Opacity", "Opacity of the points");
934 }
935
936 static void rna_def_colormanage(BlenderRNA *brna)
937 {
938         StructRNA *srna;
939         PropertyRNA *prop;
940
941         static EnumPropertyItem display_device_items[] = {
942                 {0, "DEFAULT", 0, "Default", ""},
943                 {0, NULL, 0, NULL, NULL}
944         };
945
946         static EnumPropertyItem view_transform_items[] = {
947                 {0, "NONE", 0, "None", "Do not perform any color transform on display, use old non-color managed technique for display"},
948                 {0, NULL, 0, NULL, NULL}
949         };
950
951         static EnumPropertyItem color_space_items[] = {
952                 {0, "NONE", 0, "None", "Do not perform any color transform on load, treat colors as in scene linear space already"},
953                 {0, NULL, 0, NULL, NULL}
954         };
955
956         /* ** Display Settings  **  */
957         srna = RNA_def_struct(brna, "ColorManagedDisplaySettings", NULL);
958         RNA_def_struct_ui_text(srna, "ColorManagedDisplaySettings", "Color management specific to display device");
959
960         prop = RNA_def_property(srna, "display_device", PROP_ENUM, PROP_NONE);
961         RNA_def_property_enum_items(prop, display_device_items);
962         RNA_def_property_enum_funcs(prop, "rna_ColorManagedDisplaySettings_display_device_get",
963                                           "rna_ColorManagedDisplaySettings_display_device_set",
964                                           "rna_ColorManagedDisplaySettings_display_device_itemf");
965         RNA_def_property_ui_text(prop, "Display Device", "Display device name");
966         RNA_def_property_update(prop, NC_WINDOW, "rna_ColorManagedDisplaySettings_display_device_update");
967
968         /* ** View Settings  **  */
969         srna = RNA_def_struct(brna, "ColorManagedViewSettings", NULL);
970         RNA_def_struct_ui_text(srna, "ColorManagedViewSettings", "Color management settings used for displaying images on the display");
971
972         prop = RNA_def_property(srna, "view_transform", PROP_ENUM, PROP_NONE);
973         RNA_def_property_enum_items(prop, view_transform_items);
974         RNA_def_property_enum_funcs(prop, "rna_ColorManagedViewSettings_view_transform_get",
975                                           "rna_ColorManagedViewSettings_view_transform_set",
976                                           "rna_ColorManagedViewSettings_view_transform_itemf");
977         RNA_def_property_ui_text(prop, "View Transform", "View used ");
978         RNA_def_property_update(prop, NC_WINDOW, "rna_ColorManagement_update");
979
980         prop = RNA_def_property(srna, "exposure", PROP_FLOAT, PROP_FACTOR);
981         RNA_def_property_float_sdna(prop, NULL, "exposure");
982         RNA_def_property_range(prop, -10.0f, 10.0f);
983         RNA_def_property_float_default(prop, 0.0f);
984         RNA_def_property_ui_text(prop, "Exposure", "Exposure (stops) applied before display transform");
985         RNA_def_property_update(prop, NC_WINDOW, "rna_ColorManagement_update");
986
987         prop = RNA_def_property(srna, "gamma", PROP_FLOAT, PROP_FACTOR);
988         RNA_def_property_float_sdna(prop, NULL, "gamma");
989         RNA_def_property_float_default(prop, 1.0f);
990         RNA_def_property_range(prop, 0.0f, 5.0f);
991         RNA_def_property_ui_text(prop, "Gamma", "Amount of gamma modification applied after display transform");
992         RNA_def_property_update(prop, NC_WINDOW, "rna_ColorManagement_update");
993
994         prop = RNA_def_property(srna, "curve_mapping", PROP_POINTER, PROP_NONE);
995         RNA_def_property_pointer_sdna(prop, NULL, "curve_mapping");
996         RNA_def_property_ui_text(prop, "Curve", "Color curve mapping applied before display transform");
997         RNA_def_property_update(prop, NC_WINDOW, "rna_ColorManagement_update");
998
999         prop = RNA_def_property(srna, "use_curve_mapping", PROP_BOOLEAN, PROP_NONE);
1000         RNA_def_property_boolean_sdna(prop, NULL, "flag", COLORMANAGE_VIEW_USE_CURVES);
1001         RNA_def_property_boolean_funcs(prop, NULL, "rna_ColorManagedViewSettings_use_curves_set");
1002         RNA_def_property_ui_text(prop, "Use Curves", "Use RGB curved for pre-display transformation");
1003         RNA_def_property_update(prop, NC_WINDOW, "rna_ColorManagement_update");
1004
1005         /* ** Colorspace **  */
1006         srna = RNA_def_struct(brna, "ColorManagedColorspaceSettings", NULL);
1007         RNA_def_struct_ui_text(srna, "ColorManagedColorspaceSettings", "Input color space settings");
1008
1009         prop = RNA_def_property(srna, "name", PROP_ENUM, PROP_NONE);
1010         RNA_def_property_enum_items(prop, color_space_items);
1011         RNA_def_property_enum_funcs(prop, "rna_ColorManagedColorspaceSettings_colorspace_get",
1012                                           "rna_ColorManagedColorspaceSettings_colorspace_set",
1013                                           "rna_ColorManagedColorspaceSettings_colorspace_itemf");
1014         RNA_def_property_ui_text(prop, "Color Space", "Input color space name");
1015         RNA_def_property_update(prop, NC_WINDOW, "rna_ColorManagedColorspaceSettings_reload_update");
1016 }
1017
1018 void RNA_def_color(BlenderRNA *brna)
1019 {
1020         rna_def_curvemappoint(brna);
1021         rna_def_curvemap(brna);
1022         rna_def_curvemapping(brna);
1023         rna_def_color_ramp_element(brna);
1024         rna_def_color_ramp(brna);
1025         rna_def_histogram(brna);
1026         rna_def_scopes(brna);
1027         rna_def_colormanage(brna);
1028 }
1029
1030 #endif