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