aboutsummaryrefslogtreecommitdiffstats
path: root/src/types/output.h
blob: 750ec41ed9a4bf0a36ea2d7e74e01fbf4e195632 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
/**
 * coopgammad -- Cooperative gamma server
 * Copyright (C) 2016  Mattias Andrée (maandree@kth.se)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef TYPES_OUTPUT_H
#define TYPES_OUTPUT_H


#include <stddef.h>

#include <libgamma.h>

#include "ramps.h"
#include "filter.h"



#ifndef GCC_ONLY
# if defined(__GNUC__) && !defined(__clang__)
#  define GCC_ONLY(...)  __VA_ARGS__
# else
#  define GCC_ONLY(...)  /* nothing */
# endif
#endif



/**
 * Copy the ramp sizes
 * 
 * This macro supports both `struct output`
 * and `struct gamma_ramps`
 * 
 * @param  dest  The destination
 * @param  src   The source
 */
#define COPY_RAMP_SIZES(dest, src)         \
  ((dest)->red_size   = (src)->red_size,   \
   (dest)->green_size = (src)->green_size, \
   (dest)->blue_size  = (src)->blue_size)



/**
 * Colour spaces
 */
enum colourspace
{
  
  /**
   * Unknown
   */
  COLOURSPACE_UNKNOWN = 0,
  
  /**
   * sRGB with explicit gamut
   */
  COLOURSPACE_SRGB = 1,
  
  /**
   * sRGB without explicit gamut
   */
  COLOURSPACE_SRGB_SANS_GAMUT = 2,
  
  /**
   * RGB (but not sRGB) with known gamut
   */
  COLOURSPACE_RGB = 3,
  
  /**
   * RGB (but not sRGB) without known gamut
   */
  COLOURSPACE_RGB_SANS_GAMUT = 4,
  
  /**
   * Non-RGB multicolour
   */
  COLOURSPACE_NON_RGB = 5,
  
  /**
   * Greyscale or monochrome
   */
  COLOURSPACE_GREY = 6
};



/**
 * Information about an output
 */
struct output
{
  /**
   * -2: double
   * -1: float
   *  8: uint8_t
   * 16: uint16_t
   * 32: uint32_t
   * 64: uint64_t
   */
  signed depth;
  
  /**
   * Whether gamma ramps are supported
   */
  enum libgamma_decision supported;
  
  /**
   * Whether the name is the EDID
   */
  int name_is_edid;
  
  /**
   * The monitor's colour space
   */
  enum colourspace colourspace;
  
  /**
   * The x-value (CIE xyY) of the monitor's
   * red colour, multiplied by 1024
   */
  unsigned red_x;
  
  /**
   * The y-value (CIE xyY) of the monitor's
   * red colour, multiplied by 1024
   */
  unsigned red_y;
  
  /**
   * The x-value (CIE xyY) of the monitor's
   * green colour, multiplied by 1024
   */
  unsigned green_x;
  
  /**
   * The y-value (CIE xyY) of the monitor's
   * green colour, multiplied by 1024
   */
  unsigned green_y;
  
  /**
   * The x-value (CIE xyY) of the monitor's
   * blue colour, multiplied by 1024
   */
  unsigned blue_x;
  
  /**
   * The y-value (CIE xyY) of the monitor's
   * blue colour, multiplied by 1024
   */
  unsigned blue_y;
  
  /**
   * The x-value (CIE xyY) of the monitor's
   * default white point, multiplied by 1024
   */
  unsigned white_x;
  
  /**
   * The y-value (CIE xyY) of the monitor's
   * default white point, multiplied by 1024
   */
  unsigned white_y;
  
  /**
   * The number of stops in the red gamma ramp
   */
  size_t red_size;
  
  /**
   * The number of stops in the green gamma ramp
   */
  size_t green_size;
  
  /**
   * The number of stops in the blue gamma ramp
   */
  size_t blue_size;
  
  /**
   * `.red_size + .green_size + .blue_size`
   * multiplied by the byte-size of each stop
   */
  size_t ramps_size;
  
  /**
   * The name of the output, will be its EDID
   * if available, otherwise it will be the
   * index of the partition, followed by a dot
   * and the index of the CRTC within the
   * partition, or if a name for the connector
   * is available: the index of the partition
   * followed by a dot and the name of the
   * connector
   */
  char* restrict name;
  
  /**
   * The libgamma state for the output
   */
  libgamma_crtc_state_t* restrict crtc;
  
  /**
   * Saved gamma ramps
   */
  union gamma_ramps saved_ramps;
  
  /**
   * The table of all applied filters
   */
  struct filter* restrict table_filters;
  
  /**
   * `.table_sums[i]` is the resulting
   * adjustment made when all filter
   * from `.table_filters[0]` up to and
   * including `.table_filters[i]` has
   * been applied
   */
  union gamma_ramps* restrict table_sums;
  
  /**
   * The number of elements allocated
   * for `.table_filters` and for `.table_sums`
   */
  size_t table_alloc;
  
  /**
   * The number of elements stored in
   * `.table_filters` and in `.table_sums`
   */
  size_t table_size;
  
};



/**
 * Free all resources allocated to an output.
 * The allocation of `output` itself is not freed,
 * nor is its the libgamma destroyed.
 * 
 * @param  this  The output
 */
GCC_ONLY(__attribute__((nonnull)))
void output_destroy(struct output* restrict this);

/**
 * Marshal an output
 * 
 * @param   this  The output
 * @param   buf   Output buffer for the marshalled output,
 *                `NULL` just measure how large the buffers
 *                needs to be
 * @return        The number of marshalled byte
 */
GCC_ONLY(__attribute__((nonnull(1))))
size_t output_marshal(const struct output* restrict this, void* restrict buf);

/**
 * Unmarshal an output
 * 
 * @param   this  Output for the output
 * @param   buf   Buffer with the marshalled output
 * @return        The number of unmarshalled bytes, 0 on error
 */
GCC_ONLY(__attribute__((nonnull)))
size_t output_unmarshal(struct output* restrict this, const void* restrict buf);

/**
 * Compare to outputs by the names of their respective CRTC:s
 * 
 * @param   a  Return -1 if this one is lower
 * @param   b  Return +1 if this one is higher
 * @return     See description of `a` and `b`,
 *             0 if returned if they are the same
 */
GCC_ONLY(__attribute__((pure, nonnull)))
int output_cmp_by_name(const void* restrict a, const void* restrict b);

/**
 * Find an output by its name
 * 
 * @param   key   The name of the output
 * @param   base  The array of outputs
 * @param   n     The number of elements in `base`
 * @return        Output find in `base`, `NULL` if not found
 */
GCC_ONLY(__attribute__((pure, nonnull)))
struct output* output_find_by_name(const char* restrict key, struct output* restrict base, size_t n);


#endif