PipeWire 0.3.39
loop.h
Go to the documentation of this file.
1/* Simple Plugin API
2 *
3 * Copyright © 2018 Wim Taymans
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#ifndef SPA_LOOP_H
26#define SPA_LOOP_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <spa/utils/defs.h>
33#include <spa/utils/hook.h>
34#include <spa/support/system.h>
35
45#define SPA_TYPE_INTERFACE_Loop SPA_TYPE_INFO_INTERFACE_BASE "Loop"
46#define SPA_TYPE_INTERFACE_DataLoop SPA_TYPE_INFO_INTERFACE_BASE "DataLoop"
47#define SPA_VERSION_LOOP 0
48struct spa_loop { struct spa_interface iface; };
49
50#define SPA_TYPE_INTERFACE_LoopControl SPA_TYPE_INFO_INTERFACE_BASE "LoopControl"
51#define SPA_VERSION_LOOP_CONTROL 0
52struct spa_loop_control { struct spa_interface iface; };
54#define SPA_TYPE_INTERFACE_LoopUtils SPA_TYPE_INFO_INTERFACE_BASE "LoopUtils"
55#define SPA_VERSION_LOOP_UTILS 0
57
58struct spa_source;
60typedef void (*spa_source_func_t) (struct spa_source *source);
62struct spa_source {
63 struct spa_loop *loop;
65 void *data;
66 int fd;
67 uint32_t mask;
68 uint32_t rmask;
69};
70
71typedef int (*spa_invoke_func_t) (struct spa_loop *loop,
72 bool async,
73 uint32_t seq,
74 const void *data,
75 size_t size,
76 void *user_data);
82 /* the version of this structure. This can be used to expand this
83 * structure in the future */
84#define SPA_VERSION_LOOP_METHODS 0
85 uint32_t version;
86
88 int (*add_source) (void *object,
89 struct spa_source *source);
90
92 int (*update_source) (void *object,
93 struct spa_source *source);
96 int (*remove_source) (void *object,
97 struct spa_source *source);
100 int (*invoke) (void *object,
102 uint32_t seq,
103 const void *data,
104 size_t size,
105 bool block,
106 void *user_data);
107};
108
109#define spa_loop_method(o,method,version,...) \
110({ \
111 int _res = -ENOTSUP; \
112 struct spa_loop *_o = o; \
113 spa_interface_call_res(&_o->iface, \
114 struct spa_loop_methods, _res, \
115 method, version, ##__VA_ARGS__); \
116 _res; \
117})
118
119#define spa_loop_add_source(l,...) spa_loop_method(l,add_source,0,##__VA_ARGS__)
120#define spa_loop_update_source(l,...) spa_loop_method(l,update_source,0,##__VA_ARGS__)
121#define spa_loop_remove_source(l,...) spa_loop_method(l,remove_source,0,##__VA_ARGS__)
122#define spa_loop_invoke(l,...) spa_loop_method(l,invoke,0,##__VA_ARGS__)
124
129#define SPA_VERSION_LOOP_CONTROL_HOOKS 0
130 uint32_t version;
133 void (*before) (void *data);
136 void (*after) (void *data);
137};
139#define spa_loop_control_hook_before(l) \
140({ \
141 struct spa_hook_list *_l = l; \
142 struct spa_hook *_h; \
143 spa_list_for_each_reverse(_h, &_l->list, link) \
144 spa_callbacks_call(&_h->cb, struct spa_loop_control_hooks, before, 0); \
145})
146
147#define spa_loop_control_hook_after(l) \
148({ \
149 struct spa_hook_list *_l = l; \
150 struct spa_hook *_h; \
151 spa_list_for_each(_h, &_l->list, link) \
152 spa_callbacks_call(&_h->cb, struct spa_loop_control_hooks, after, 0); \
154
159 /* the version of this structure. This can be used to expand this
160 * structure in the future */
161#define SPA_VERSION_LOOP_CONTROL_METHODS 0
162 uint32_t version;
163
164 int (*get_fd) (void *object);
165
172 void (*add_hook) (void *object,
173 struct spa_hook *hook,
174 const struct spa_loop_control_hooks *hooks,
175 void *data);
176
184 void (*enter) (void *object);
191 void (*leave) (void *object);
192
202 int (*iterate) (void *object, int timeout);
203};
204
205#define spa_loop_control_method_v(o,method,version,...) \
206({ \
207 struct spa_loop_control *_o = o; \
208 spa_interface_call(&_o->iface, \
209 struct spa_loop_control_methods, \
210 method, version, ##__VA_ARGS__); \
211})
212
213#define spa_loop_control_method_r(o,method,version,...) \
214({ \
215 int _res = -ENOTSUP; \
216 struct spa_loop_control *_o = o; \
217 spa_interface_call_res(&_o->iface, \
218 struct spa_loop_control_methods, _res, \
219 method, version, ##__VA_ARGS__); \
220 _res; \
221})
222
223#define spa_loop_control_get_fd(l) spa_loop_control_method_r(l,get_fd,0)
224#define spa_loop_control_add_hook(l,...) spa_loop_control_method_v(l,add_hook,0,__VA_ARGS__)
225#define spa_loop_control_enter(l) spa_loop_control_method_v(l,enter,0)
226#define spa_loop_control_leave(l) spa_loop_control_method_v(l,leave,0)
227#define spa_loop_control_iterate(l,...) spa_loop_control_method_r(l,iterate,0,__VA_ARGS__)
228
229typedef void (*spa_source_io_func_t) (void *data, int fd, uint32_t mask);
230typedef void (*spa_source_idle_func_t) (void *data);
231typedef void (*spa_source_event_func_t) (void *data, uint64_t count);
232typedef void (*spa_source_timer_func_t) (void *data, uint64_t expirations);
233typedef void (*spa_source_signal_func_t) (void *data, int signal_number);
234
239 /* the version of this structure. This can be used to expand this
240 * structure in the future */
241#define SPA_VERSION_LOOP_UTILS_METHODS 0
242 uint32_t version;
243
244 struct spa_source *(*add_io) (void *object,
245 int fd,
246 uint32_t mask,
247 bool close,
250 int (*update_io) (void *object, struct spa_source *source, uint32_t mask);
251
252 struct spa_source *(*add_idle) (void *object,
253 bool enabled,
255 int (*enable_idle) (void *object, struct spa_source *source, bool enabled);
256
257 struct spa_source *(*add_event) (void *object,
259 int (*signal_event) (void *object, struct spa_source *source);
260
261 struct spa_source *(*add_timer) (void *object,
263 int (*update_timer) (void *object,
264 struct spa_source *source,
265 struct timespec *value,
266 struct timespec *interval,
267 bool absolute);
268 struct spa_source *(*add_signal) (void *object,
269 int signal_number,
271
275 void (*destroy_source) (void *object, struct spa_source *source);
278#define spa_loop_utils_method_v(o,method,version,...) \
279({ \
280 struct spa_loop_utils *_o = o; \
281 spa_interface_call(&_o->iface, \
282 struct spa_loop_utils_methods, \
283 method, version, ##__VA_ARGS__); \
284})
286#define spa_loop_utils_method_r(o,method,version,...) \
287({ \
288 int _res = -ENOTSUP; \
289 struct spa_loop_utils *_o = o; \
290 spa_interface_call_res(&_o->iface, \
291 struct spa_loop_utils_methods, _res, \
292 method, version, ##__VA_ARGS__); \
293 _res; \
295#define spa_loop_utils_method_s(o,method,version,...) \
296({ \
297 struct spa_source *_res = NULL; \
298 struct spa_loop_utils *_o = o; \
299 spa_interface_call_res(&_o->iface, \
300 struct spa_loop_utils_methods, _res, \
301 method, version, ##__VA_ARGS__); \
302 _res; \
303})
304
305
306#define spa_loop_utils_add_io(l,...) spa_loop_utils_method_s(l,add_io,0,__VA_ARGS__)
307#define spa_loop_utils_update_io(l,...) spa_loop_utils_method_r(l,update_io,0,__VA_ARGS__)
308#define spa_loop_utils_add_idle(l,...) spa_loop_utils_method_s(l,add_idle,0,__VA_ARGS__)
309#define spa_loop_utils_enable_idle(l,...) spa_loop_utils_method_r(l,enable_idle,0,__VA_ARGS__)
310#define spa_loop_utils_add_event(l,...) spa_loop_utils_method_s(l,add_event,0,__VA_ARGS__)
311#define spa_loop_utils_signal_event(l,...) spa_loop_utils_method_r(l,signal_event,0,__VA_ARGS__)
312#define spa_loop_utils_add_timer(l,...) spa_loop_utils_method_s(l,add_timer,0,__VA_ARGS__)
313#define spa_loop_utils_update_timer(l,...) spa_loop_utils_method_r(l,update_timer,0,__VA_ARGS__)
314#define spa_loop_utils_add_signal(l,...) spa_loop_utils_method_s(l,add_signal,0,__VA_ARGS__)
315#define spa_loop_utils_destroy_source(l,...) spa_loop_utils_method_v(l,destroy_source,0,__VA_ARGS__)
316
321#ifdef __cplusplus
322} /* extern "C" */
323#endif
324
325#endif /* SPA_LOOP_H */
spa/utils/defs.h
void(* spa_source_timer_func_t)(void *data, uint64_t expirations)
Definition: loop.h:266
void(* spa_source_event_func_t)(void *data, uint64_t count)
Definition: loop.h:265
void(* spa_source_signal_func_t)(void *data, int signal_number)
Definition: loop.h:267
void(* spa_source_idle_func_t)(void *data)
Definition: loop.h:264
void(* spa_source_func_t)(struct spa_source *source)
Definition: loop.h:73
int(* spa_invoke_func_t)(struct spa_loop *loop, bool async, uint32_t seq, const void *data, size_t size, void *user_data)
Definition: loop.h:84
void(* spa_source_io_func_t)(void *data, int fd, uint32_t mask)
Definition: loop.h:263
spa/utils/hook.h
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
Definition: hook.h:158
Control hooks.
Definition: loop.h:150
void(* before)(void *data)
Executed right before waiting for events.
Definition: loop.h:156
uint32_t version
Definition: loop.h:153
void(* after)(void *data)
Executed right after waiting for events.
Definition: loop.h:159
Control an event loop.
Definition: loop.h:181
int(* get_fd)(void *object)
Definition: loop.h:188
int(* iterate)(void *object, int timeout)
Perform one iteration of the loop.
Definition: loop.h:226
void(* enter)(void *object)
Enter a loop.
Definition: loop.h:208
void(* add_hook)(void *object, struct spa_hook *hook, const struct spa_loop_control_hooks *hooks, void *data)
Add a hook.
Definition: loop.h:196
void(* leave)(void *object)
Leave a loop.
Definition: loop.h:215
uint32_t version
Definition: loop.h:186
Definition: loop.h:62
struct spa_interface iface
Definition: loop.h:62
Register sources and work items to an event loop.
Definition: loop.h:94
int(* add_source)(void *object, struct spa_source *source)
add a source to the loop
Definition: loop.h:102
int(* remove_source)(void *object, struct spa_source *source)
remove a source from the loop
Definition: loop.h:110
int(* invoke)(void *object, spa_invoke_func_t func, uint32_t seq, const void *data, size_t size, bool block, void *user_data)
invoke a function in the context of this loop
Definition: loop.h:114
int(* update_source)(void *object, struct spa_source *source)
update the source io mask
Definition: loop.h:106
uint32_t version
Definition: loop.h:99
Create sources for an event loop.
Definition: loop.h:272
int(* update_io)(void *object, struct spa_source *source, uint32_t mask)
Definition: loop.h:285
int(* enable_idle)(void *object, struct spa_source *source, bool enabled)
Definition: loop.h:290
int(* signal_event)(void *object, struct spa_source *source)
Definition: loop.h:294
int(* update_timer)(void *object, struct spa_source *source, struct timespec *value, struct timespec *interval, bool absolute)
Definition: loop.h:298
void(* destroy_source)(void *object, struct spa_source *source)
destroy a source allocated with this interface.
Definition: loop.h:310
uint32_t version
Definition: loop.h:277
Definition: loop.h:68
struct spa_interface iface
Definition: loop.h:68
Definition: loop.h:56
struct spa_interface iface
Definition: loop.h:56
Definition: loop.h:75
uint32_t rmask
Definition: loop.h:81
void * data
Definition: loop.h:78
uint32_t mask
Definition: loop.h:80
spa_source_func_t func
Definition: loop.h:77
int fd
Definition: loop.h:79
struct spa_loop * loop
Definition: loop.h:76
spa/support/system.h