aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/libgamma-facade.h
blob: a24c0e0b57718c1c3ab9b1f2735e2eede9991967 (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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
/**
 * libgamma -- Display server abstraction layer for gamma ramp adjustments
 * Copyright (C) 2014, 2015  Mattias Andrée (maandree@member.fsf.org)
 * 
 * This library 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 library 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 library.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef LIBGAMMA_FACADE_H
#define LIBGAMMA_FACADE_H

#if !defined(LIBGAMMA_CONFIG_H) && !defined(DEBUG)
# error libgamma-facade.h should not be included directly, include libgamma.h instead
#endif


#include "libgamma-method.h"

#include <stddef.h>
#include <stdint.h>

#ifndef __GCC__
# define __attribute__(x)
#endif



/**
 * Mapping function from [0, 1] float encoding value to [0, 2⁸ − 1] integer output value.
 * 
 * @param   encoding  [0, 1] float encoding value.
 * @return            [0, 2⁸ − 1] integer output value.
 */
typedef uint8_t libgamma_gamma_ramps8_fun(float encoding);

/**
 * Mapping function from [0, 1] float encoding value to [0, 2¹⁶ − 1] integer output value.
 * 
 * @param   encoding  [0, 1] float encoding value.
 * @return            [0, 2¹⁶ − 1] integer output value.
 */
typedef uint16_t libgamma_gamma_ramps16_fun(float encoding);

/**
 * Mapping function from [0, 1] float encoding value to [0, 2³² − 1] integer output value.
 * 
 * @param   encoding  [0, 1] float encoding value.
 * @return            [0, 2³² − 1] integer output value.
 */
typedef uint32_t libgamma_gamma_ramps32_fun(float encoding);

/**
 * Mapping function from [0, 1] float encoding value to [0, 2⁶⁴ − 1] integer output value.
 * 
 * @param   encoding  [0, 1] float encoding value.
 * @return            [0, 2⁶⁴ − 1] integer output value.
 */
typedef uint64_t libgamma_gamma_ramps64_fun(float encoding);

/**
 * Mapping function from [0, 1] float encoding value to [0, 1] float output value.
 * 
 * @param   encoding  [0, 1] float encoding value.
 * @return            [0, 1] float output value.
 */
typedef float libgamma_gamma_rampsf_fun(float encoding);

/**
 * Mapping function from [0, 1] double precision float encoding
 * value to [0, 1] double precision float output value.
 * 
 * @param   encoding  [0, 1] float encoding value.
 * @return            [0, 1] float output value.
 */
typedef double libgamma_gamma_rampsd_fun(double encoding);



/**
 * List available adjustment methods by their order of preference based on the environment.
 * 
 * @param  methods    Output array of methods, should be able to hold `LIBGAMMA_METHOD_COUNT` elements.
 * @param  buf_size   The number of elements that fits in `methods`, it should be `LIBGAMMA_METHOD_COUNT`,
 *                    This is used to avoid writing outside the output buffer if this library adds new
 *                    adjustment methods without the users of the library recompiling.
 * @param  operation  Allowed values:
 *                      0: Methods that the environment suggests will work, excluding fake.
 *                      1: Methods that the environment suggests will work, including fake.
 *                      2: All real non-fake methods.
 *                      3: All real methods.
 *                      4: All methods.
 *                    Other values invoke undefined behaviour.
 * @return            The number of element that have been stored in `methods`, or should
 *                    have been stored if the buffer was large enough.
 */
size_t libgamma_list_methods(int* restrict methods, size_t buf_size, int operation);

/**
 * Check whether an adjustment method is available, non-existing (invalid) methods will be
 * identified as not available under the rationale that the library may be out of date.
 * 
 * @param   method  The adjustment method.
 * @return          Whether the adjustment method is available.
 */
int libgamma_is_method_available(int method) __attribute__((const));

/**
 * Return the capabilities of an adjustment method.
 * 
 * @param  this    The data structure to fill with the method's capabilities
 * @param  method  The adjustment method (display server and protocol).
 */
void libgamma_method_capabilities(libgamma_method_capabilities_t* restrict this, int method);

/**
 * Return the default site for an adjustment method.
 * 
 * @param   method  The adjustment method (display server and protocol.)
 * @return          The default site, `NULL` if it cannot be determined or
 *                  if multiple sites are not supported by the adjustment
 *                  method. This value should not be `free`:d.
 */
char* libgamma_method_default_site(int method);

/**
 * Return the default variable that determines
 * the default site for an adjustment method.
 * 
 * @param   method  The adjustment method (display server and protocol.)
 * @return          The environ variables that is used to determine the
 *                  default site. `NULL` if there is none, that is, if
 *                  the method does not support multiple sites.
 *                  This value should not be `free`:d.
 */
const char* libgamma_method_default_site_variable(int method) __attribute__((const));


/**
 * Initialise an allocated site state.
 * 
 * @param   this    The site state to initialise.
 * @param   method  The adjustment method (display server and protocol.)
 * @param   site    The site identifier, unless it is `NULL` it must a
 *                  `free`:able. Once the state is destroyed the library
 *                  will attempt to free it. There you should not free
 *                  it yourself, and it must not be a string constant
 *                  or allocate on the stack. Note however that it will
 *                  not be `free`:d if this function fails.
 * @return          Zero on success, otherwise (negative) the value of an
 *                  error identifier provided by this library.
 */
int libgamma_site_initialise(libgamma_site_state_t* restrict this,
			     int method, char* restrict site);

/**
 * Release all resources held by a site state.
 * 
 * @param  this  The site state.
 */
void libgamma_site_destroy(libgamma_site_state_t* restrict this);

/**
 * Release all resources held by a site state
 * and free the site state pointer.
 * 
 * @param  this  The site state.
 */
void libgamma_site_free(libgamma_site_state_t* restrict this);

/**
 * Restore the gamma ramps all CRTC:s within a site to the system settings.
 * 
 * @param   this  The site state.
 * @return        Zero on success, otherwise (negative) the value of an
 *                error identifier provided by this library.
 */
int libgamma_site_restore(libgamma_site_state_t* restrict this);


/**
 * Initialise an allocated partition state.
 * 
 * @param   this       The partition state to initialise.
 * @param   site       The site state for the site that the partition belongs to.
 * @param   partition  The index of the partition within the site.
 * @return             Zero on success, otherwise (negative) the value of an
 *                     error identifier provided by this library.
 */
int libgamma_partition_initialise(libgamma_partition_state_t* restrict this,
				  libgamma_site_state_t* restrict site, size_t partition);

/**
 * Release all resources held by a partition state.
 * 
 * @param  this  The partition state.
 */
void libgamma_partition_destroy(libgamma_partition_state_t* restrict this);

/**
 * Release all resources held by a partition state
 * and free the partition state pointer.
 * 
 * @param  this  The partition state.
 */
void libgamma_partition_free(libgamma_partition_state_t* restrict this);

/**
 * Restore the gamma ramps all CRTC:s within a partition to the system settings.
 * 
 * @param   this  The partition state.
 * @return        Zero on success, otherwise (negative) the value of an
 *                error identifier provided by this library.
 */
int libgamma_partition_restore(libgamma_partition_state_t* restrict this);


/**
 * Initialise an allocated CRTC state.
 * 
 * @param   this       The CRTC state to initialise.
 * @param   partition  The partition state for the partition that the CRTC belongs to.
 * @param   crtc       The index of the CRTC within the partition.
 * @return             Zero on success, otherwise (negative) the value of an
 *                     error identifier provided by this library.
 */
int libgamma_crtc_initialise(libgamma_crtc_state_t* restrict this,
			     libgamma_partition_state_t* restrict partition, size_t crtc);

/**
 * Release all resources held by a CRTC state.
 * 
 * @param  this  The CRTC state.
 */
void libgamma_crtc_destroy(libgamma_crtc_state_t* restrict this);

/**
 * Release all resources held by a CRTC state
 * and free the CRTC state pointer.
 * 
 * @param  this  The CRTC state.
 */
void libgamma_crtc_free(libgamma_crtc_state_t* restrict this);

/**
 * Restore the gamma ramps for a CRTC to the system settings for that CRTC.
 * 
 * @param   this  The CRTC state.
 * @return        Zero on success, otherwise (negative) the value of an
 *                error identifier provided by this library.
 */
int libgamma_crtc_restore(libgamma_crtc_state_t* restrict this);


/**
 * Read information about a CRTC.
 * 
 * @param   this    Instance of a data structure to fill with the information about the CRTC.
 * @param   crtc    The state of the CRTC whose information should be read.
 * @param   fields  OR:ed identifiers for the information about the CRTC that should be read.
 * @return          Zero on success, -1 on error. On error refer to the error reports in `this`.
 */
int libgamma_get_crtc_information(libgamma_crtc_information_t* restrict this,
				  libgamma_crtc_state_t* restrict crtc, int32_t fields);

/**
 * Release all resources in an information data structure for a CRTC.
 * 
 * @param  this  The CRTC information.
 */
void libgamma_crtc_information_destroy(libgamma_crtc_information_t* restrict this);

/**
 * Release all resources in an information data structure for a CRTC
 * and free the data structure pointer.
 * 
 * @param  this  The CRTC information.
 */
void libgamma_crtc_information_free(libgamma_crtc_information_t* restrict this);

/**
 * Convert a raw representation of an EDID to a lowercase hexadecimal representation.
 * 
 * @param   edid:const unsigned char*  The EDID in raw representation.
 * @param   length:size_t              The length of `edid`.
 * @return  :char*                     The EDID in lowercase hexadecimal representation,
 *                                     `NULL` on allocation error, `errno` will be set accordingly.
 */
#define libgamma_behex_edid(edid, length)  \
  libgamma_behex_edid_lowercase(edid, length)

/**
 * Convert a raw representation of an EDID to a lowercase hexadecimal representation.
 * 
 * @param   edid    The EDID in raw representation.
 * @param   length  The length of `edid`.
 * @return          The EDID in lowercase hexadecimal representation,
 *                  `NULL` on allocation error, `errno` will be set accordingly.
 */
char* libgamma_behex_edid_lowercase(const unsigned char* restrict edid, size_t length);

/**
 * Convert a raw representation of an EDID to an uppercase hexadecimal representation.
 * 
 * @param   edid    The EDID in raw representation.
 * @param   length  The length of `edid`.
 * @return          The EDID in uppercase hexadecimal representation,
 *                  NULL` on allocation error, `errno` will be set accordingly.
 */
char* libgamma_behex_edid_uppercase(const unsigned char* restrict edid, size_t length);

/**
 * Convert an hexadecimal representation of an EDID to a raw representation.
 * 
 * @param   edid  The EDID in hexadecimal representation.
 * @return        The EDID in raw representation, it will be half the length
 *                of `edid` (the input value). `NULL` on allocation error or
 *                if the EDID is malformated, `errno` will be set accordingly.
 */
unsigned char* libgamma_unhex_edid(const char* restrict edid);


/**
 * Get the current gamma ramps for a CRTC, 8-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to fill with the current values
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_get_gamma_ramps8(libgamma_crtc_state_t* restrict this,
				   libgamma_gamma_ramps8_t* restrict ramps);

/**
 * Set the gamma ramps for a CRTC, 8-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to apply.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps8(libgamma_crtc_state_t* restrict this,
				   libgamma_gamma_ramps8_t ramps);


/**
 * Get the current gamma ramps for a CRTC, 16-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to fill with the current values
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_get_gamma_ramps16(libgamma_crtc_state_t* restrict this,
				    libgamma_gamma_ramps16_t* restrict ramps);

/**
 * Set the gamma ramps for a CRTC, 16-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to apply.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps16(libgamma_crtc_state_t* restrict this,
				    libgamma_gamma_ramps16_t ramps) __attribute__((hot));


/**
 * Get the current gamma ramps for a CRTC, 32-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to fill with the current values.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_get_gamma_ramps32(libgamma_crtc_state_t* restrict this,
				    libgamma_gamma_ramps32_t* restrict ramps);

/**
 * Set the gamma ramps for a CRTC, 32-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to apply.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps32(libgamma_crtc_state_t* restrict this,
				    libgamma_gamma_ramps32_t ramps);


/**
 * Get the current gamma ramps for a CRTC, 64-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to fill with the current values.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_get_gamma_ramps64(libgamma_crtc_state_t* restrict this,
				    libgamma_gamma_ramps64_t* restrict ramps);

/**
 * Set the gamma ramps for a CRTC, 64-bit gamma-depth version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to apply.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps64(libgamma_crtc_state_t* restrict this,
				    libgamma_gamma_ramps64_t ramps);


/**
 * Set the gamma ramps for a CRTC, `float` version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to apply.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this,
				   libgamma_gamma_rampsf_t ramps);

/**
 * Get the current gamma ramps for a CRTC, `float` version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to fill with the current values.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this,
				   libgamma_gamma_rampsf_t* restrict ramps);


/**
 * Get the current gamma ramps for a CRTC, `double` version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to fill with the current values.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_get_gamma_rampsd(libgamma_crtc_state_t* restrict this,
				   libgamma_gamma_rampsd_t* restrict ramps);

/**
 * Set the gamma ramps for a CRTC, `double` version.
 * 
 * @param   this   The CRTC state.
 * @param   ramps  The gamma ramps to apply.
 * @return         Zero on success, otherwise (negative) the value of an
 *                 error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_rampsd(libgamma_crtc_state_t* restrict this,
				   libgamma_gamma_rampsd_t ramps);


/**
 * Set the gamma ramps for a CRTC, 8-bit gamma-depth function version.
 * 
 * Note that this will probably involve the library allocating temporary data.
 * 
 * @param   this            The CRTC state.
 * @param   red_function    The function that generates the gamma ramp for the red channel.
 * @param   green_function  The function that generates the gamma ramp for the green channel.
 * @param   blue_function   The function that generates the gamma ramp for the blue channel.
 * @return                  Zero on success, otherwise (negative) the value of an
 *                          error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps8_f(libgamma_crtc_state_t* restrict this,
				     libgamma_gamma_ramps8_fun* red_function,
				     libgamma_gamma_ramps8_fun* green_function,
				     libgamma_gamma_ramps8_fun* blue_function) __attribute__((cold));

/**
 * Set the gamma ramps for a CRTC, 16-bit gamma-depth function version.
 * 
 * Note that this will probably involve the library allocating temporary data.
 * 
 * @param   this            The CRTC state.
 * @param   red_function    The function that generates the gamma ramp for the red channel.
 * @param   green_function  The function that generates the gamma ramp for the green channel.
 * @param   blue_function   The function that generates the gamma ramp for the blue channel.
 * @return                  Zero on success, otherwise (negative) the value of an
 *                          error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps16_f(libgamma_crtc_state_t* restrict this,
				      libgamma_gamma_ramps16_fun* red_function,
				      libgamma_gamma_ramps16_fun* green_function,
				      libgamma_gamma_ramps16_fun* blue_function) __attribute__((cold));

/**
 * Set the gamma ramps for a CRTC, 32-bit gamma-depth function version.
 * 
 * Note that this will probably involve the library allocating temporary data.
 * 
 * @param   this            The CRTC state.
 * @param   red_function    The function that generates the gamma ramp for the red channel.
 * @param   green_function  The function that generates the gamma ramp for the green channel.
 * @param   blue_function   The function that generates the gamma ramp for the blue channel.
 * @return                  Zero on success, otherwise (negative) the value of an
 *                          error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps32_f(libgamma_crtc_state_t* restrict this,
				      libgamma_gamma_ramps32_fun* red_function,
				      libgamma_gamma_ramps32_fun* green_function,
				      libgamma_gamma_ramps32_fun* blue_function) __attribute__((cold));

/**
 * Set the gamma ramps for a CRTC, 64-bit gamma-depth function version.
 * 
 * Note that this will probably involve the library allocating temporary data.
 * 
 * @param   this            The CRTC state.
 * @param   red_function    The function that generates the gamma ramp for the red channel.
 * @param   green_function  The function that generates the gamma ramp for the green channel.
 * @param   blue_function   The function that generates the gamma ramp for the blue channel.
 * @return                  Zero on success, otherwise (negative) the value of an
 *                          error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_ramps64_f(libgamma_crtc_state_t* restrict this,
				      libgamma_gamma_ramps64_fun* red_function,
				      libgamma_gamma_ramps64_fun* green_function,
				      libgamma_gamma_ramps64_fun* blue_function) __attribute__((cold));

/**
 * Set the gamma ramps for a CRTC, `float` function version.
 * 
 * Note that this will probably involve the library allocating temporary data.
 * 
 * @param   this            The CRTC state.
 * @param   red_function    The function that generates the gamma ramp for the red channel.
 * @param   green_function  The function that generates the gamma ramp for the green channel.
 * @param   blue_function   The function that generates the gamma ramp for the blue channel.
 * @return                  Zero on success, otherwise (negative) the value of an
 *                          error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_rampsf_f(libgamma_crtc_state_t* restrict this,
				     libgamma_gamma_rampsf_fun* red_function,
				     libgamma_gamma_rampsf_fun* green_function,
				     libgamma_gamma_rampsf_fun* blue_function) __attribute__((cold));

/**
 * Set the gamma ramps for a CRTC, `double` function version.
 * 
 * Note that this will probably involve the library allocating temporary data.
 * 
 * @param   this            The CRTC state.
 * @param   red_function    The function that generates the gamma ramp for the red channel.
 * @param   green_function  The function that generates the gamma ramp for the green channel.
 * @param   blue_function   The function that generates the gamma ramp for the blue channel.
 * @return                  Zero on success, otherwise (negative) the value of an
 *                          error identifier provided by this library.
 */
int libgamma_crtc_set_gamma_rampsd_f(libgamma_crtc_state_t* restrict this,
				     libgamma_gamma_rampsd_fun* red_function,
				     libgamma_gamma_rampsd_fun* green_function,
				     libgamma_gamma_rampsd_fun* blue_function) __attribute__((cold));


#ifndef __GCC__
# undef __attribute__
#endif

#endif