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
|
/**
* 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_FILTER_H
#define TYPES_FILTER_H
#include <stddef.h>
#include <stdint.h>
#ifndef GCC_ONLY
# if defined(__GNUC__) && !defined(__clang__)
# define GCC_ONLY(...) __VA_ARGS__
# else
# define GCC_ONLY(...) /* nothing */
# endif
#endif
/**
* The lifespan of a filter
*/
enum lifespan
{
/**
* The filter should be applied
* until it is explicitly removed
*/
LIFESPAN_UNTIL_REMOVAL,
/**
* The filter should be applied
* until the client exists
*/
LIFESPAN_UNTIL_DEATH,
/**
* The filter should be removed now
*/
LIFESPAN_REMOVE
};
/**
* Information about a filter
*/
struct filter
{
/**
* The client that applied it. This need not be
* set unless `.lifespan == LIFESPAN_UNTIL_DEATH`
* and unless the process itself added this.
* This is the file descriptor of the client's
* connection.
*/
int client;
/**
* The lifespan of the filter
*/
enum lifespan lifespan;
/**
* The priority of the filter
*/
int64_t priority;
/**
* Identifier for the filter
*/
char* class;
/**
* The gamma ramp adjustments for the filter.
* This is raw binary data. `NULL` iff
* `lifespan == LIFESPAN_REMOVE`.
*/
void* ramps;
};
/**
* Free all resources allocated to a filter.
* The allocation of `filter` itself is not freed.
*
* @param this The filter
*/
GCC_ONLY(__attribute__((nonnull)))
void filter_destroy(struct filter* restrict this);
/**
* Marshal a filter
*
* @param this The filter
* @param buf Output buffer for the marshalled filter,
* `NULL` just measure how large the buffers
* needs to be
* @param ramps_size The byte-size of `filter->ramps`
* @return The number of marshalled byte
*/
GCC_ONLY(__attribute__((nonnull(1))))
size_t filter_marshal(const struct filter* restrict this, void* restrict buf, size_t ramps_size);
/**
* Unmarshal a filter
*
* @param this Output for the filter, `.red_size`, `.green_size`,
* and `.blue_size` must already be set
* @param buf Buffer with the marshalled filter
* @param ramps_size The byte-size of `filter->ramps`
* @return The number of unmarshalled bytes, 0 on error
*/
GCC_ONLY(__attribute__((nonnull)))
size_t filter_unmarshal(struct filter* restrict this, const void* restrict buf, size_t ramps_size);
#endif
|
