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
|
/* See LICENSE file for copyright and license details. */
#include <libcoopgamma.h>
#include <inttypes.h>
/**
* Value of `default_priority` that indicates
* that there is no default priority
*/
#define NO_DEFAULT_PRIORITY INT64_MAX
/**
* X-macro that list all gamma ramp types
*
* X will be expanded with 4 arguments:
* 1) The libcoopgamma constant that identifies the type
* 2) The member in `union libcoopgamma_ramps` that
* corresponds to the type
* 3) The max value for the ramp stops
* 4) The type of the ramp stops
*/
#define LIST_DEPTHS\
X(LIBCOOPGAMMA_UINT8, u8, UINT8_MAX, uint8_t)\
X(LIBCOOPGAMMA_UINT16, u16, UINT16_MAX, uint16_t)\
X(LIBCOOPGAMMA_UINT32, u32, UINT32_MAX, uint32_t)\
X(LIBCOOPGAMMA_UINT64, u64, UINT64_MAX, uint64_t)\
X(LIBCOOPGAMMA_FLOAT, f, ((float)1), float)\
X(LIBCOOPGAMMA_DOUBLE, d, ((double)1), double)
/**
* Information (except asynchronous call context)
* required to update the gamma ramps on a CRTC.
*/
typedef struct filter_update
{
/**
* The filter to update
*
* `.filter.crtc`, `.filter.class`, and
* `.filter.priority` (unless `default_priority`
* is `NO_DEFAULT_PRIORITY`), `.filter.depth`
* are preconfigured, and `.filter.ramps`
* is preinitialised and preset to an
* identity ramp
*/
libcoopgamma_filter_t filter;
/**
* The index of the CRTC
*/
size_t crtc;
/**
* Has the update been synchronised?
*/
int synced;
/**
* Did the update fail?
*/
int failed;
/**
* Error description if `.failed` is true
*/
libcoopgamma_error_t error;
/**
* If zero, the ramps in `.filter` shall
* neither be modified nor freed
*/
int master;
/**
* 0-terminated list of elements in
* `.crtc_updates` which shares gamma
* ramps with this instance
*
* This will only be set if `.master`
* is true
*/
size_t *slaves;
} filter_update_t;
/**
* The process's name
*/
extern const char *argv0;
/**
* The libcoopgamma context
*/
extern libcoopgamma_context_t cg;
/**
* The names of the selected CRTC:s
*/
extern char **crtcs;
/**
* Gamma ramp updates for each CRTC
*/
extern filter_update_t *crtc_updates;
/**
* CRTC and monitor information about
* each selected CRTC and connect monitor
*/
extern libcoopgamma_crtc_info_t *crtc_info;
/**
* The number of selected CRTC:s
*/
extern size_t crtcs_n;
/**
* The number of filters
*/
extern size_t filters_n;
/**
* The default filter priority for the program
*/
extern const int64_t default_priority;
/**
* The default class for the program
*/
extern char default_class[];
/**
* Class suffixes
*/
extern const char *const *class_suffixes;
/**
* Make elements in `crtc_updates` slaves where appropriate
*
* @return Zero on success, -1 on error
*/
int make_slaves(void);
/**
* Update a filter and synchronise calls
*
* @param index The index of the CRTC
* @param timeout The number of milliseconds a call to `poll` may block,
* -1 if it may block forever
* @return 1: Success, no pending synchronisations
* 0: Success, with still pending synchronisations
* -1: Error, `errno` set
* -2: Error, `cg.error` set
*
* @throws EINTR Call to `poll` was interrupted by a signal
* @throws EAGAIN Call to `poll` timed out
*/
int update_filter(size_t index, int timeout);
/**
* Synchronised calls
*
* @param timeout The number of milliseconds a call to `poll` may block,
* -1 if it may block forever
* @return 1: Success, no pending synchronisations
* 0: Success, with still pending synchronisations
* -1: Error, `errno` set
* -2: Error, `cg.error` set
*
* @throws EINTR Call to `poll` was interrupted by a signal
* @throws EAGAIN Call to `poll` timed out
*/
int synchronise(int timeout);
/**
* Print usage information and exit
*/
#if defined(__GNUC__)
__attribute__((__noreturn__))
#endif
extern void usage(void);
/**
* Handle a command line option
*
* @param opt The option, it is a NUL-terminate two-character
* string starting with either '-' or '+', if the
* argument is not recognised, call `usage`. This
* string will not be "-M", "-S", "-c", "-p", or "-R".
* @param arg The argument associated with `opt`,
* `NULL` there is no next argument, if this
* parameter is `NULL` but needed, call `usage`
* @return 0 if `arg` was not used,
* 1 if `arg` was used,
* -1 on error
*/
#if defined(__GNUC__)
__attribute__((__nonnull__(1)))
#endif
extern int handle_opt(char *opt, char *arg);
/**
* This function is called after the last
* call to `handle_opt`
*
* @param argc The number of unparsed arguments
* @param argv `NULL` terminated list of unparsed arguments
* @param prio The argument associated with the "-p" option
* @return Zero on success, -1 on error
*/
#if defined(__GNUC__)
__attribute__((__nonnull__(2)))
#endif
extern int handle_args(int argc, char *argv[], char *prio);
/**
* The main function for the program-specific code
*
* @return 0: Success
* -1: Error, `errno` set
* -2: Error, `cg.error` set
* -3: Error, message already printed
*/
extern int start(void);
|
