PipeWire 1.5.0
Loading...
Searching...
No Matches
loop.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_LOOP_H
6#define PIPEWIRE_LOOP_H
7
8#include <spa/support/loop.h>
9#include <spa/utils/dict.h>
10
11#ifdef __cplusplus
12extern "C" {
13#endif
14
29struct pw_loop {
30 struct spa_system *system;
31 struct spa_loop *loop;
33 struct spa_loop_utils *utils;
34 const char *name;
35};
37#ifndef PW_API_LOOP_IMPL
38#define PW_API_LOOP_IMPL static inline
39#endif
40
41struct pw_loop *
42pw_loop_new(const struct spa_dict *props);
44void
46
47int pw_loop_set_name(struct pw_loop *loop, const char *name);
48
49PW_API_LOOP_IMPL int pw_loop_add_source(struct pw_loop *object, struct spa_source *source)
50{
51 return spa_loop_add_source(object->loop, source);
52}
53PW_API_LOOP_IMPL int pw_loop_update_source(struct pw_loop *object, struct spa_source *source)
55 return spa_loop_update_source(object->loop, source);
56}
57PW_API_LOOP_IMPL int pw_loop_remove_source(struct pw_loop *object, struct spa_source *source)
59 return spa_loop_remove_source(object->loop, source);
60}
61PW_API_LOOP_IMPL int pw_loop_invoke(struct pw_loop *object,
62 spa_invoke_func_t func, uint32_t seq, const void *data,
63 size_t size, bool block, void *user_data)
64{
65 return spa_loop_invoke(object->loop, func, seq, data, size, block, user_data);
67PW_API_LOOP_IMPL int pw_loop_locked(struct pw_loop *object,
68 spa_invoke_func_t func, uint32_t seq, const void *data,
69 size_t size, void *user_data)
70{
71 return spa_loop_locked(object->loop, func, seq, data, size, user_data);
73
74PW_API_LOOP_IMPL int pw_loop_get_fd(struct pw_loop *object)
75{
76 return spa_loop_control_get_fd(object->control);
77}
78PW_API_LOOP_IMPL void pw_loop_add_hook(struct pw_loop *object,
79 struct spa_hook *hook, const struct spa_loop_control_hooks *hooks,
80 void *data)
81{
82 spa_loop_control_add_hook(object->control, hook, hooks, data);
84PW_API_LOOP_IMPL void pw_loop_enter(struct pw_loop *object)
85{
86 spa_loop_control_enter(object->control);
87}
88PW_API_LOOP_IMPL void pw_loop_leave(struct pw_loop *object)
90 spa_loop_control_leave(object->control);
91}
93 int timeout)
94{
95 return spa_loop_control_iterate_fast(object->control, timeout);
96}
98{
99 return spa_loop_control_check(object->control);
100}
101PW_API_LOOP_IMPL int pw_loop_lock(struct pw_loop *object)
103 return spa_loop_control_lock(object->control);
104}
105PW_API_LOOP_IMPL int pw_loop_unlock(struct pw_loop *object)
107 return spa_loop_control_unlock(object->control);
108}
109PW_API_LOOP_IMPL int pw_loop_get_time(struct pw_loop *object, struct timespec *abstime, int64_t timeout)
111 return spa_loop_control_get_time(object->control, abstime, timeout);
112}
113PW_API_LOOP_IMPL int pw_loop_wait(struct pw_loop *object, const struct timespec *abstime)
115 return spa_loop_control_wait(object->control, abstime);
116}
117PW_API_LOOP_IMPL int pw_loop_signal(struct pw_loop *object, bool wait_for_accept)
119 return spa_loop_control_signal(object->control, wait_for_accept);
120}
121PW_API_LOOP_IMPL int pw_loop_accept(struct pw_loop *object)
123 return spa_loop_control_accept(object->control);
124}
125
127
129pw_loop_add_io(struct pw_loop *object, int fd, uint32_t mask,
130 bool close, spa_source_io_func_t func, void *data)
131{
132 return spa_loop_utils_add_io(object->utils, fd, mask, close, func, data);
133}
135 struct spa_source *source, uint32_t mask)
136{
137 return spa_loop_utils_update_io(object->utils, source, mask);
138}
140pw_loop_add_idle(struct pw_loop *object, bool enabled,
141 spa_source_idle_func_t func, void *data)
142{
143 return spa_loop_utils_add_idle(object->utils, enabled, func, data);
144}
146 struct spa_source *source, bool enabled)
147{
148 return spa_loop_utils_enable_idle(object->utils, source, enabled);
149}
151pw_loop_add_event(struct pw_loop *object, spa_source_event_func_t func, void *data)
152{
153 return spa_loop_utils_add_event(object->utils, func, data);
154}
156 struct spa_source *source)
157{
158 return spa_loop_utils_signal_event(object->utils, source);
159}
161pw_loop_add_timer(struct pw_loop *object, spa_source_timer_func_t func, void *data)
162{
163 return spa_loop_utils_add_timer(object->utils, func, data);
164}
166 struct spa_source *source, struct timespec *value,
167 struct timespec *interval, bool absolute)
168{
169 return spa_loop_utils_update_timer(object->utils, source, value, interval, absolute);
172pw_loop_add_signal(struct pw_loop *object, int signal_number,
173 spa_source_signal_func_t func, void *data)
174{
175 return spa_loop_utils_add_signal(object->utils, signal_number, func, data);
176}
178 struct spa_source *source)
179{
180 spa_loop_utils_destroy_source(object->utils, source);
181}
187#ifdef __cplusplus
188}
189#endif
190
191#endif /* PIPEWIRE_LOOP_H */
uint32_t int seq
Definition core.h:432
PW_API_LOOP_IMPL int pw_loop_signal_event(struct pw_loop *object, struct spa_source *source)
Definition loop.h:160
PW_API_LOOP_IMPL void pw_loop_enter(struct pw_loop *object)
Definition loop.h:89
PW_API_LOOP_IMPL int pw_loop_invoke(struct pw_loop *object, spa_invoke_func_t func, uint32_t seq, const void *data, size_t size, bool block, void *user_data)
Definition loop.h:66
PW_API_LOOP_IMPL int pw_loop_get_time(struct pw_loop *object, struct timespec *abstime, int64_t timeout)
Definition loop.h:114
PW_API_LOOP_IMPL void pw_loop_destroy_source(struct pw_loop *object, struct spa_source *source)
Definition loop.h:182
PW_API_LOOP_IMPL struct spa_source * pw_loop_add_io(struct pw_loop *object, int fd, uint32_t mask, bool close, spa_source_io_func_t func, void *data)
Definition loop.h:134
PW_API_LOOP_IMPL int pw_loop_lock(struct pw_loop *object)
Definition loop.h:106
PW_API_LOOP_IMPL int pw_loop_signal(struct pw_loop *object, bool wait_for_accept)
Definition loop.h:122
PW_API_LOOP_IMPL int pw_loop_enable_idle(struct pw_loop *object, struct spa_source *source, bool enabled)
Definition loop.h:150
PW_API_LOOP_IMPL int pw_loop_add_source(struct pw_loop *object, struct spa_source *source)
Definition loop.h:54
PW_API_LOOP_IMPL int pw_loop_accept(struct pw_loop *object)
Definition loop.h:126
PW_API_LOOP_IMPL int pw_loop_update_timer(struct pw_loop *object, struct spa_source *source, struct timespec *value, struct timespec *interval, bool absolute)
Definition loop.h:170
PW_API_LOOP_IMPL int pw_loop_unlock(struct pw_loop *object)
Definition loop.h:110
PW_API_LOOP_IMPL struct spa_source * pw_loop_add_signal(struct pw_loop *object, int signal_number, spa_source_signal_func_t func, void *data)
Definition loop.h:177
PW_API_LOOP_IMPL struct spa_source * pw_loop_add_idle(struct pw_loop *object, bool enabled, spa_source_idle_func_t func, void *data)
Definition loop.h:145
PW_API_LOOP_IMPL int pw_loop_remove_source(struct pw_loop *object, struct spa_source *source)
Definition loop.h:62
PW_API_LOOP_IMPL struct spa_source * pw_loop_add_timer(struct pw_loop *object, spa_source_timer_func_t func, void *data)
Definition loop.h:166
int pw_loop_set_name(struct pw_loop *loop, const char *name)
Definition loop.c:176
#define PW_API_LOOP_IMPL
Definition loop.h:43
PW_API_LOOP_IMPL int pw_loop_wait(struct pw_loop *object, const struct timespec *abstime)
Definition loop.h:118
PW_API_LOOP_IMPL void pw_loop_leave(struct pw_loop *object)
Definition loop.h:93
PW_API_LOOP_IMPL int pw_loop_locked(struct pw_loop *object, spa_invoke_func_t func, uint32_t seq, const void *data, size_t size, void *user_data)
Definition loop.h:72
PW_API_LOOP_IMPL void pw_loop_add_hook(struct pw_loop *object, struct spa_hook *hook, const struct spa_loop_control_hooks *hooks, void *data)
Definition loop.h:83
struct pw_loop * pw_loop_new(const struct spa_dict *props)
Create a new loop.
Definition loop.c:41
PW_API_LOOP_IMPL int pw_loop_get_fd(struct pw_loop *object)
Definition loop.h:79
PW_API_LOOP_IMPL int pw_loop_check(struct pw_loop *object)
Definition loop.h:102
PW_API_LOOP_IMPL int pw_loop_iterate(struct pw_loop *object, int timeout)
Definition loop.h:97
void pw_loop_destroy(struct pw_loop *loop)
Destroy a loop.
Definition loop.c:157
PW_API_LOOP_IMPL int pw_loop_update_source(struct pw_loop *object, struct spa_source *source)
Definition loop.h:58
PW_API_LOOP_IMPL struct spa_source * pw_loop_add_event(struct pw_loop *object, spa_source_event_func_t func, void *data)
Definition loop.h:156
PW_API_LOOP_IMPL int pw_loop_update_io(struct pw_loop *object, struct spa_source *source, uint32_t mask)
Definition loop.h:139
SPA_API_LOOP int spa_loop_invoke(struct spa_loop *object, spa_invoke_func_t func, uint32_t seq, const void *data, size_t size, bool block, void *user_data)
Definition loop.h:191
SPA_API_LOOP struct spa_source * spa_loop_utils_add_idle(struct spa_loop_utils *object, bool enabled, spa_source_idle_func_t func, void *data)
Definition loop.h:531
SPA_API_LOOP struct spa_source * spa_loop_utils_add_signal(struct spa_loop_utils *object, int signal_number, spa_source_signal_func_t func, void *data)
Definition loop.h:570
SPA_API_LOOP int spa_loop_control_accept(struct spa_loop_control *object)
Definition loop.h:461
SPA_API_LOOP int spa_loop_add_source(struct spa_loop *object, struct spa_source *source)
Definition loop.h:176
void(* spa_source_timer_func_t)(void *data, uint64_t expirations)
Definition loop.h:470
SPA_API_LOOP struct spa_source * spa_loop_utils_add_timer(struct spa_loop_utils *object, spa_source_timer_func_t func, void *data)
Definition loop.h:556
SPA_API_LOOP int spa_loop_control_get_fd(struct spa_loop_control *object)
Definition loop.h:397
SPA_API_LOOP void spa_loop_control_enter(struct spa_loop_control *object)
Definition loop.h:409
SPA_API_LOOP int spa_loop_control_signal(struct spa_loop_control *object, bool wait_for_accept)
Definition loop.h:456
SPA_API_LOOP int spa_loop_remove_source(struct spa_loop *object, struct spa_source *source)
Definition loop.h:186
SPA_API_LOOP int spa_loop_utils_update_timer(struct spa_loop_utils *object, struct spa_source *source, struct timespec *value, struct timespec *interval, bool absolute)
Definition loop.h:561
SPA_API_LOOP int spa_loop_utils_enable_idle(struct spa_loop_utils *object, struct spa_source *source, bool enabled)
Definition loop.h:537
void(* spa_source_event_func_t)(void *data, uint64_t count)
Definition loop.h:469
void(* spa_source_signal_func_t)(void *data, int signal_number)
Definition loop.h:471
SPA_API_LOOP int spa_loop_control_iterate_fast(struct spa_loop_control *object, int timeout)
Definition loop.h:423
SPA_API_LOOP void spa_loop_control_add_hook(struct spa_loop_control *object, struct spa_hook *hook, const struct spa_loop_control_hooks *hooks, void *data)
Definition loop.h:402
SPA_API_LOOP int spa_loop_control_wait(struct spa_loop_control *object, const struct timespec *abstime)
Definition loop.h:450
void(* spa_source_idle_func_t)(void *data)
Definition loop.h:468
SPA_API_LOOP int spa_loop_control_unlock(struct spa_loop_control *object)
Definition loop.h:439
SPA_API_LOOP void spa_loop_utils_destroy_source(struct spa_loop_utils *object, struct spa_source *source)
Definition loop.h:577
SPA_API_LOOP int spa_loop_control_check(struct spa_loop_control *object)
Definition loop.h:429
SPA_API_LOOP struct spa_source * spa_loop_utils_add_event(struct spa_loop_utils *object, spa_source_event_func_t func, void *data)
Definition loop.h:544
SPA_API_LOOP int spa_loop_control_get_time(struct spa_loop_control *object, struct timespec *abstime, int64_t timeout)
Definition loop.h:444
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:78
void(* spa_source_io_func_t)(void *data, int fd, uint32_t mask)
Definition loop.h:467
SPA_API_LOOP int spa_loop_control_lock(struct spa_loop_control *object)
Definition loop.h:434
SPA_API_LOOP int spa_loop_utils_signal_event(struct spa_loop_utils *object, struct spa_source *source)
Definition loop.h:549
SPA_API_LOOP int spa_loop_utils_update_io(struct spa_loop_utils *object, struct spa_source *source, uint32_t mask)
Definition loop.h:524
SPA_API_LOOP void spa_loop_control_leave(struct spa_loop_control *object)
Definition loop.h:413
SPA_API_LOOP int spa_loop_locked(struct spa_loop *object, spa_invoke_func_t func, uint32_t seq, const void *data, size_t size, void *user_data)
Definition loop.h:199
SPA_API_LOOP int spa_loop_update_source(struct spa_loop *object, struct spa_source *source)
Definition loop.h:181
SPA_API_LOOP struct spa_source * spa_loop_utils_add_io(struct spa_loop_utils *object, int fd, uint32_t mask, bool close, spa_source_io_func_t func, void *data)
Definition loop.h:518
spa/support/loop.h
Definition loop.h:33
struct spa_loop * loop
wrapped loop
Definition loop.h:35
struct spa_loop_control * control
loop control
Definition loop.h:36
struct spa_system * system
system utils
Definition loop.h:34
Definition dict.h:51
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427
Control hooks.
Definition loop.h:212
Definition loop.h:54
Definition loop.h:60
Definition loop.h:48
Definition loop.h:67
uint32_t mask
Definition loop.h:72
spa_source_func_t func
Definition loop.h:69
int fd
Definition loop.h:71
Definition system.h:56
spa/utils/dict.h