PipeWire: spa/support/loop.h Source File

PipeWire 1.0.3

Loading...
Searching...
No Matches
loop.h
Go to the documentation of this file.
1/* Simple Plugin API */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef SPA_LOOP_H
6#define SPA_LOOP_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
12#include <spa/utils/defs.h>
13#include <spa/utils/hook.h>
14#include <spa/support/system.h>
15
25#define SPA_TYPE_INTERFACE_Loop SPA_TYPE_INFO_INTERFACE_BASE "Loop"
26#define SPA_TYPE_INTERFACE_DataLoop SPA_TYPE_INFO_INTERFACE_BASE "DataLoop"
27#define SPA_VERSION_LOOP 0
28struct spa_loop { struct spa_interface iface; };
29
30#define SPA_TYPE_INTERFACE_LoopControl SPA_TYPE_INFO_INTERFACE_BASE "LoopControl"
31#define SPA_VERSION_LOOP_CONTROL 1
32struct spa_loop_control { struct spa_interface iface; };
33
34#define SPA_TYPE_INTERFACE_LoopUtils SPA_TYPE_INFO_INTERFACE_BASE "LoopUtils"
35#define SPA_VERSION_LOOP_UTILS 0
36 struct spa_loop_utils { struct spa_interface iface; };
37
38struct spa_source;
39
40typedef void (*spa_source_func_t) (struct spa_source *source);
41
42 struct spa_source {
43 struct spa_loop *loop;
44 spa_source_func_t func;
45 void *data;
46 int fd;
47 uint32_t mask;
48 uint32_t rmask;
49 /* private data for the loop implementer */
50 void *priv;
51};
52
53 typedef int (*spa_invoke_func_t) (struct spa_loop *loop,
54 bool async,
55 uint32_t seq,
56 const void *data,
57 size_t size,
58 void *user_data);
59
63 struct spa_loop_methods {
64 /* the version of this structure. This can be used to expand this
65 * structure in the future */
66#define SPA_VERSION_LOOP_METHODS 0
67 uint32_t version;
68
70 int (*add_source) (void *object,
71 struct spa_source *source);
72
74 int (*update_source) (void *object,
75 struct spa_source *source);
76
78 int (*remove_source) (void *object,
79 struct spa_source *source);
80
82 int (*invoke) (void *object,
83 spa_invoke_func_t func,
84 uint32_t seq,
85 const void *data,
86 size_t size,
87 bool block,
88 void *user_data);
89};
90
91#define spa_loop_method(o,method,version,...) \
92({ \
93 int _res = -ENOTSUP; \
94 struct spa_loop *_o = o; \
95 spa_interface_call_res(&_o->iface, \
96 struct spa_loop_methods, _res, \
97 method, version, ##__VA_ARGS__); \
98 _res; \
99})
100
101#define spa_loop_add_source(l,...) spa_loop_method(l,add_source,0,##__VA_ARGS__)
102#define spa_loop_update_source(l,...) spa_loop_method(l,update_source,0,##__VA_ARGS__)
103#define spa_loop_remove_source(l,...) spa_loop_method(l,remove_source,0,##__VA_ARGS__)
104#define spa_loop_invoke(l,...) spa_loop_method(l,invoke,0,##__VA_ARGS__)
105
106
110struct spa_loop_control_hooks {
111#define SPA_VERSION_LOOP_CONTROL_HOOKS 0
112 uint32_t version;
115 void (*before) (void *data);
118 void (*after) (void *data);
119};
120
121#define spa_loop_control_hook_before(l) \
122({ \
123 struct spa_hook_list *_l = l; \
124 struct spa_hook *_h; \
125 spa_list_for_each_reverse(_h, &_l->list, link) \
126 spa_callbacks_call_fast(&_h->cb, struct spa_loop_control_hooks, before, 0); \
127})
128
129#define spa_loop_control_hook_after(l) \
130({ \
131 struct spa_hook_list *_l = l; \
132 struct spa_hook *_h; \
133 spa_list_for_each(_h, &_l->list, link) \
134 spa_callbacks_call_fast(&_h->cb, struct spa_loop_control_hooks, after, 0); \
135})
136
140struct spa_loop_control_methods {
141 /* the version of this structure. This can be used to expand this
142 * structure in the future */
143#define SPA_VERSION_LOOP_CONTROL_METHODS 1
144 uint32_t version;
145
146 int (*get_fd) (void *object);
147
154 void (*add_hook) (void *object,
155 struct spa_hook *hook,
156 const struct spa_loop_control_hooks *hooks,
157 void *data);
158
166 void (*enter) (void *object);
173 void (*leave) (void *object);
174
184 int (*iterate) (void *object, int timeout);
185
194 int (*check) (void *object);
195};
196
197#define spa_loop_control_method_v(o,method,version,...) \
198({ \
199 struct spa_loop_control *_o = o; \
200 spa_interface_call(&_o->iface, \
201 struct spa_loop_control_methods, \
202 method, version, ##__VA_ARGS__); \
203})
204
205#define spa_loop_control_method_r(o,method,version,...) \
206({ \
207 int _res = -ENOTSUP; \
208 struct spa_loop_control *_o = o; \
209 spa_interface_call_res(&_o->iface, \
210 struct spa_loop_control_methods, _res, \
211 method, version, ##__VA_ARGS__); \
212 _res; \
213})
214
215#define spa_loop_control_method_fast_r(o,method,version,...) \
216({ \
217 int _res; \
218 struct spa_loop_control *_o = o; \
219 spa_interface_call_fast_res(&_o->iface, \
220 struct spa_loop_control_methods, _res, \
221 method, version, ##__VA_ARGS__); \
222 _res; \
223})
224
225#define spa_loop_control_get_fd(l) spa_loop_control_method_r(l,get_fd,0)
226#define spa_loop_control_add_hook(l,...) spa_loop_control_method_v(l,add_hook,0,__VA_ARGS__)
227#define spa_loop_control_enter(l) spa_loop_control_method_v(l,enter,0)
228#define spa_loop_control_leave(l) spa_loop_control_method_v(l,leave,0)
229#define spa_loop_control_iterate(l,...) spa_loop_control_method_r(l,iterate,0,__VA_ARGS__)
230#define spa_loop_control_check(l) spa_loop_control_method_r(l,check,1)
231
232#define spa_loop_control_iterate_fast(l,...) spa_loop_control_method_fast_r(l,iterate,0,__VA_ARGS__)
233
234typedef void (*spa_source_io_func_t) (void *data, int fd, uint32_t mask);
235typedef void (*spa_source_idle_func_t) (void *data);
236typedef void (*spa_source_event_func_t) (void *data, uint64_t count);
237typedef void (*spa_source_timer_func_t) (void *data, uint64_t expirations);
238typedef void (*spa_source_signal_func_t) (void *data, int signal_number);
239
243struct spa_loop_utils_methods {
244 /* the version of this structure. This can be used to expand this
245 * structure in the future */
246#define SPA_VERSION_LOOP_UTILS_METHODS 0
247 uint32_t version;
248
249 struct spa_source *(*add_io) (void *object,
250 int fd,
251 uint32_t mask,
252 bool close,
253 spa_source_io_func_t func, void *data);
254
255 int (*update_io) (void *object, struct spa_source *source, uint32_t mask);
256
257 struct spa_source *(*add_idle) (void *object,
258 bool enabled,
259 spa_source_idle_func_t func, void *data);
260 int (*enable_idle) (void *object, struct spa_source *source, bool enabled);
261
262 struct spa_source *(*add_event) (void *object,
263 spa_source_event_func_t func, void *data);
264 int (*signal_event) (void *object, struct spa_source *source);
265
266 struct spa_source *(*add_timer) (void *object,
267 spa_source_timer_func_t func, void *data);
268 int (*update_timer) (void *object,
269 struct spa_source *source,
270 struct timespec *value,
271 struct timespec *interval,
272 bool absolute);
273 struct spa_source *(*add_signal) (void *object,
274 int signal_number,
275 spa_source_signal_func_t func, void *data);
276
280 void (*destroy_source) (void *object, struct spa_source *source);
281};
282
283#define spa_loop_utils_method_v(o,method,version,...) \
284({ \
285 struct spa_loop_utils *_o = o; \
286 spa_interface_call(&_o->iface, \
287 struct spa_loop_utils_methods, \
288 method, version, ##__VA_ARGS__); \
289})
290
291#define spa_loop_utils_method_r(o,method,version,...) \
292({ \
293 int _res = -ENOTSUP; \
294 struct spa_loop_utils *_o = o; \
295 spa_interface_call_res(&_o->iface, \
296 struct spa_loop_utils_methods, _res, \
297 method, version, ##__VA_ARGS__); \
298 _res; \
299})
300#define spa_loop_utils_method_s(o,method,version,...) \
301({ \
302 struct spa_source *_res = NULL; \
303 struct spa_loop_utils *_o = o; \
304 spa_interface_call_res(&_o->iface, \
305 struct spa_loop_utils_methods, _res, \
306 method, version, ##__VA_ARGS__); \
307 _res; \
308})
309
310
311#define spa_loop_utils_add_io(l,...) spa_loop_utils_method_s(l,add_io,0,__VA_ARGS__)
312#define spa_loop_utils_update_io(l,...) spa_loop_utils_method_r(l,update_io,0,__VA_ARGS__)
313#define spa_loop_utils_add_idle(l,...) spa_loop_utils_method_s(l,add_idle,0,__VA_ARGS__)
314#define spa_loop_utils_enable_idle(l,...) spa_loop_utils_method_r(l,enable_idle,0,__VA_ARGS__)
315#define spa_loop_utils_add_event(l,...) spa_loop_utils_method_s(l,add_event,0,__VA_ARGS__)
316#define spa_loop_utils_signal_event(l,...) spa_loop_utils_method_r(l,signal_event,0,__VA_ARGS__)
317#define spa_loop_utils_add_timer(l,...) spa_loop_utils_method_s(l,add_timer,0,__VA_ARGS__)
318#define spa_loop_utils_update_timer(l,...) spa_loop_utils_method_r(l,update_timer,0,__VA_ARGS__)
319#define spa_loop_utils_add_signal(l,...) spa_loop_utils_method_s(l,add_signal,0,__VA_ARGS__)
320#define spa_loop_utils_destroy_source(l,...) spa_loop_utils_method_v(l,destroy_source,0,__VA_ARGS__)
321
326#ifdef __cplusplus
327} /* extern "C" */
328#endif
329
330#endif /* SPA_LOOP_H */
defs.h
spa/utils/defs.h
spa_source_timer_func_t
void(* spa_source_timer_func_t)(void *data, uint64_t expirations)
Definition loop.h:273
spa_source_event_func_t
void(* spa_source_event_func_t)(void *data, uint64_t count)
Definition loop.h:272
spa_source_signal_func_t
void(* spa_source_signal_func_t)(void *data, int signal_number)
Definition loop.h:274
spa_source_idle_func_t
void(* spa_source_idle_func_t)(void *data)
Definition loop.h:271
spa_source_func_t
void(* spa_source_func_t)(struct spa_source *source)
Definition loop.h:53
spa_invoke_func_t
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:66
spa_source_io_func_t
void(* spa_source_io_func_t)(void *data, int fd, uint32_t mask)
Definition loop.h:270
hook.h
spa/utils/hook.h
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350
spa_interface
Definition hook.h:138
spa_loop_control_hooks
Control hooks.
Definition loop.h:132
spa_loop_control_hooks::before
void(* before)(void *data)
Executed right before waiting for events.
Definition loop.h:138
spa_loop_control_hooks::version
uint32_t version
Definition loop.h:135
spa_loop_control_hooks::after
void(* after)(void *data)
Executed right after waiting for events.
Definition loop.h:141
spa_loop_control_methods
Control an event loop.
Definition loop.h:163
spa_loop_control_methods::get_fd
int(* get_fd)(void *object)
Definition loop.h:170
spa_loop_control_methods::iterate
int(* iterate)(void *object, int timeout)
Perform one iteration of the loop.
Definition loop.h:208
spa_loop_control_methods::enter
void(* enter)(void *object)
Enter a loop.
Definition loop.h:190
spa_loop_control_methods::add_hook
void(* add_hook)(void *object, struct spa_hook *hook, const struct spa_loop_control_hooks *hooks, void *data)
Add a hook.
Definition loop.h:178
spa_loop_control_methods::check
int(* check)(void *object)
Check context of the loop.
Definition loop.h:218
spa_loop_control_methods::leave
void(* leave)(void *object)
Leave a loop.
Definition loop.h:197
spa_loop_control_methods::version
uint32_t version
Definition loop.h:168
spa_loop_control
Definition loop.h:42
spa_loop_control::iface
struct spa_interface iface
Definition loop.h:42
spa_loop_methods
Register sources and work items to an event loop.
Definition loop.h:76
spa_loop_methods::add_source
int(* add_source)(void *object, struct spa_source *source)
add a source to the loop
Definition loop.h:84
spa_loop_methods::remove_source
int(* remove_source)(void *object, struct spa_source *source)
remove a source from the loop
Definition loop.h:92
spa_loop_methods::invoke
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:96
spa_loop_methods::update_source
int(* update_source)(void *object, struct spa_source *source)
update the source io mask
Definition loop.h:88
spa_loop_methods::version
uint32_t version
Definition loop.h:81
spa_loop_utils_methods
Create sources for an event loop.
Definition loop.h:279
spa_loop_utils_methods::update_io
int(* update_io)(void *object, struct spa_source *source, uint32_t mask)
Definition loop.h:292
spa_loop_utils_methods::enable_idle
int(* enable_idle)(void *object, struct spa_source *source, bool enabled)
Definition loop.h:297
spa_loop_utils_methods::signal_event
int(* signal_event)(void *object, struct spa_source *source)
Definition loop.h:301
spa_loop_utils_methods::update_timer
int(* update_timer)(void *object, struct spa_source *source, struct timespec *value, struct timespec *interval, bool absolute)
Definition loop.h:305
spa_loop_utils_methods::destroy_source
void(* destroy_source)(void *object, struct spa_source *source)
destroy a source allocated with this interface.
Definition loop.h:317
spa_loop_utils_methods::version
uint32_t version
Definition loop.h:284
spa_loop_utils
Definition loop.h:48
spa_loop_utils::iface
struct spa_interface iface
Definition loop.h:48
spa_loop
Definition loop.h:36
spa_loop::iface
struct spa_interface iface
Definition loop.h:36
spa_source
Definition loop.h:55
spa_source::rmask
uint32_t rmask
Definition loop.h:61
spa_source::data
void * data
Definition loop.h:58
spa_source::priv
void * priv
Definition loop.h:63
spa_source::mask
uint32_t mask
Definition loop.h:60
spa_source::func
spa_source_func_t func
Definition loop.h:57
spa_source::fd
int fd
Definition loop.h:59
spa_source::loop
struct spa_loop * loop
Definition loop.h:56
system.h
spa/support/system.h