Cleanup: comment line length (editors)
[blender.git] / source / blender / makesdna / DNA_color_types.h
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  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL/BL DUAL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_color_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_COLOR_TYPES_H__
33 #define __DNA_COLOR_TYPES_H__
34
35 #include "DNA_vec_types.h"
36
37 /* general defines for kernel functions */
38 #define CM_RESOL 32
39 #define CM_TABLE 256
40 #define CM_TABLEDIV             (1.0f/256.0f)
41
42 #define CM_TOT  4
43
44 typedef struct CurveMapPoint {
45         float x, y;
46         short flag, shorty;             /* shorty for result lookup */
47 } CurveMapPoint;
48
49 /* curvepoint->flag */
50 enum {
51         CUMA_SELECT = (1 << 0),
52         CUMA_HANDLE_VECTOR = (1 << 1),
53         CUMA_HANDLE_AUTO_ANIM = (1 << 2),
54 };
55
56 typedef struct CurveMap {
57         short totpoint, flag;
58
59         float range;                                    /* quick multiply value for reading table */
60         float mintable, maxtable;               /* the x-axis range for the table */
61         float ext_in[2], ext_out[2];    /* for extrapolated curves, the direction vector */
62         CurveMapPoint *curve;                   /* actual curve */
63         CurveMapPoint *table;                   /* display and evaluate table */
64
65         CurveMapPoint *premultable;             /* for RGB curves, premulled table */
66         float premul_ext_in[2];                 /* for RGB curves, premulled extrapolation vector */
67         float premul_ext_out[2];
68 } CurveMap;
69
70 /* cuma->flag */
71 #define CUMA_EXTEND_EXTRAPOLATE 1
72
73 typedef struct CurveMapping {
74         int flag, cur;                                  /* cur; for buttons, to show active curve */
75         int preset;
76         int changed_timestamp;
77
78         rctf curr, clipr;                               /* current rect, clip rect (is default rect too) */
79
80         CurveMap cm[4];                                 /* max 4 builtin curves per mapping struct now */
81         float black[3], white[3];               /* black/white point (black[0] abused for current frame) */
82         float bwmul[3];                                 /* black/white point multiply value, for speed */
83
84         float sample[3];                                /* sample values, if flag set it draws line and intersection */
85 } CurveMapping;
86
87 /* cumapping->flag */
88 #define CUMA_DO_CLIP            (1 << 0)
89 #define CUMA_PREMULLED          (1 << 1)
90 #define CUMA_DRAW_CFRA          (1 << 2)
91 #define CUMA_DRAW_SAMPLE        (1 << 3)
92
93 /* cumapping->preset */
94 typedef enum eCurveMappingPreset {
95         CURVE_PRESET_LINE   = 0,
96         CURVE_PRESET_SHARP  = 1,
97         CURVE_PRESET_SMOOTH = 2,
98         CURVE_PRESET_MAX    = 3,
99         CURVE_PRESET_MID9   = 4,
100         CURVE_PRESET_ROUND  = 5,
101         CURVE_PRESET_ROOT   = 6,
102 } eCurveMappingPreset;
103
104 /* histogram->mode */
105 enum {
106         HISTO_MODE_LUMA   = 0,
107         HISTO_MODE_RGB    = 1,
108         HISTO_MODE_R      = 2,
109         HISTO_MODE_G      = 3,
110         HISTO_MODE_B      = 4,
111         HISTO_MODE_ALPHA  = 5
112 };
113
114 enum {
115         HISTO_FLAG_LINE        = (1 << 0),
116         HISTO_FLAG_SAMPLELINE  = (1 << 1)
117 };
118
119 typedef struct Histogram {
120         int channels;
121         int x_resolution;
122         float data_luma[256];
123         float data_r[256];
124         float data_g[256];
125         float data_b[256];
126         float data_a[256];
127         float xmax, ymax;
128         short mode;
129         short flag;
130         int height;
131
132         /* sample line only */
133         /* image coords src -> dst */
134         float co[2][2];
135 } Histogram;
136
137
138 typedef struct Scopes {
139         int ok;
140         int sample_full;
141         int sample_lines;
142         float accuracy;
143         int wavefrm_mode;
144         float wavefrm_alpha;
145         float wavefrm_yfac;
146         int wavefrm_height;
147         float vecscope_alpha;
148         int vecscope_height;
149         float minmax[3][2];
150         struct Histogram hist;
151         float *waveform_1;
152         float *waveform_2;
153         float *waveform_3;
154         float *vecscope;
155         int waveform_tot;
156         int pad;
157 } Scopes;
158
159 /* scopes->wavefrm_mode */
160 #define SCOPES_WAVEFRM_LUMA             0
161 #define SCOPES_WAVEFRM_RGB_PARADE       1
162 #define SCOPES_WAVEFRM_YCC_601  2
163 #define SCOPES_WAVEFRM_YCC_709  3
164 #define SCOPES_WAVEFRM_YCC_JPEG 4
165 #define SCOPES_WAVEFRM_RGB              5
166
167 typedef struct ColorManagedViewSettings {
168         int flag, pad;
169         char look[64];   /* look which is being applied when displaying buffer on the screen (prior to view transform) */
170         char view_transform[64];   /* view transform which is being applied when displaying buffer on the screen */
171         float exposure;            /* fstop exposure */
172         float gamma;               /* post-display gamma transform */
173         struct CurveMapping *curve_mapping;  /* pre-display RGB curves transform */
174         void *pad2;
175 } ColorManagedViewSettings;
176
177 typedef struct ColorManagedDisplaySettings {
178         char display_device[64];
179 } ColorManagedDisplaySettings;
180
181 typedef struct ColorManagedColorspaceSettings {
182         char name[64];    /* MAX_COLORSPACE_NAME */
183 } ColorManagedColorspaceSettings;
184
185 /* ColorManagedViewSettings->flag */
186 enum {
187         COLORMANAGE_VIEW_USE_CURVES = (1 << 0)
188 };
189
190 #endif