PipeWire: spa/support/system.h Source File

PipeWire 0.3.50

system.h
Go to the documentation of this file.
1/* Simple Plugin API
2 *
3 * Copyright © 2019 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_SYSTEM_H
26#define SPA_SYSTEM_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32struct itimerspec;
33
34#include <time.h>
35#include <sys/types.h>
36
37#include <spa/utils/defs.h>
38#include <spa/utils/hook.h>
39
52#define SPA_TYPE_INTERFACE_System SPA_TYPE_INFO_INTERFACE_BASE "System"
53#define SPA_TYPE_INTERFACE_DataSystem SPA_TYPE_INFO_INTERFACE_BASE "DataSystem"
54
55#define SPA_VERSION_SYSTEM 0
56struct spa_system { struct spa_interface iface; };
57
58/* IO events */
59#define SPA_IO_IN (1 << 0)
60#define SPA_IO_OUT (1 << 2)
61#define SPA_IO_ERR (1 << 3)
62#define SPA_IO_HUP (1 << 4)
63
64/* flags */
65#define SPA_FD_CLOEXEC (1<<0)
66#define SPA_FD_NONBLOCK (1<<1)
67#define SPA_FD_EVENT_SEMAPHORE (1<<2)
68#define SPA_FD_TIMER_ABSTIME (1<<3)
69#define SPA_FD_TIMER_CANCEL_ON_SET (1<<4)
70
71 struct spa_poll_event {
72 uint32_t events;
73 void *data;
74};
75
76struct spa_system_methods {
77#define SPA_VERSION_SYSTEM_METHODS 0
78 uint32_t version;
79
80 /* read/write/ioctl */
81 ssize_t (*read) (void *object, int fd, void *buf, size_t count);
82 ssize_t (*write) (void *object, int fd, const void *buf, size_t count);
83 int (*ioctl) (void *object, int fd, unsigned long request, ...);
84 int (*close) (void *object, int fd);
85
86 /* clock */
87 int (*clock_gettime) (void *object,
88 int clockid, struct timespec *value);
89 int (*clock_getres) (void *object,
90 int clockid, struct timespec *res);
91
92 /* poll */
93 int (*pollfd_create) (void *object, int flags);
94 int (*pollfd_add) (void *object, int pfd, int fd, uint32_t events, void *data);
95 int (*pollfd_mod) (void *object, int pfd, int fd, uint32_t events, void *data);
96 int (*pollfd_del) (void *object, int pfd, int fd);
97 int (*pollfd_wait) (void *object, int pfd,
98 struct spa_poll_event *ev, int n_ev, int timeout);
99
100 /* timers */
101 int (*timerfd_create) (void *object, int clockid, int flags);
102 int (*timerfd_settime) (void *object,
103 int fd, int flags,
104 const struct itimerspec *new_value,
105 struct itimerspec *old_value);
106 int (*timerfd_gettime) (void *object,
107 int fd, struct itimerspec *curr_value);
108 int (*timerfd_read) (void *object, int fd, uint64_t *expirations);
109
110 /* events */
111 int (*eventfd_create) (void *object, int flags);
112 int (*eventfd_write) (void *object, int fd, uint64_t count);
113 int (*eventfd_read) (void *object, int fd, uint64_t *count);
114
115 /* signals */
116 int (*signalfd_create) (void *object, int signal, int flags);
117 int (*signalfd_read) (void *object, int fd, int *signal);
118};
119
120#define spa_system_method_r(o,method,version,...) \
121({ \
122 int _res = -ENOTSUP; \
123 struct spa_system *_o = o; \
124 spa_interface_call_res(&_o->iface, \
125 struct spa_system_methods, _res, \
126 method, version, ##__VA_ARGS__); \
127 _res; \
128})
129
130
131#define spa_system_read(s,...) spa_system_method_r(s,read,0,__VA_ARGS__)
132#define spa_system_write(s,...) spa_system_method_r(s,write,0,__VA_ARGS__)
133#define spa_system_ioctl(s,...) spa_system_method_r(s,ioctl,0,__VA_ARGS__)
134#define spa_system_close(s,...) spa_system_method_r(s,close,0,__VA_ARGS__)
135
136#define spa_system_clock_gettime(s,...) spa_system_method_r(s,clock_gettime,0,__VA_ARGS__)
137#define spa_system_clock_getres(s,...) spa_system_method_r(s,clock_getres,0,__VA_ARGS__)
138
139#define spa_system_pollfd_create(s,...) spa_system_method_r(s,pollfd_create,0,__VA_ARGS__)
140#define spa_system_pollfd_add(s,...) spa_system_method_r(s,pollfd_add,0,__VA_ARGS__)
141#define spa_system_pollfd_mod(s,...) spa_system_method_r(s,pollfd_mod,0,__VA_ARGS__)
142#define spa_system_pollfd_del(s,...) spa_system_method_r(s,pollfd_del,0,__VA_ARGS__)
143#define spa_system_pollfd_wait(s,...) spa_system_method_r(s,pollfd_wait,0,__VA_ARGS__)
144
145#define spa_system_timerfd_create(s,...) spa_system_method_r(s,timerfd_create,0,__VA_ARGS__)
146#define spa_system_timerfd_settime(s,...) spa_system_method_r(s,timerfd_settime,0,__VA_ARGS__)
147#define spa_system_timerfd_gettime(s,...) spa_system_method_r(s,timerfd_gettime,0,__VA_ARGS__)
148#define spa_system_timerfd_read(s,...) spa_system_method_r(s,timerfd_read,0,__VA_ARGS__)
149
150#define spa_system_eventfd_create(s,...) spa_system_method_r(s,eventfd_create,0,__VA_ARGS__)
151#define spa_system_eventfd_write(s,...) spa_system_method_r(s,eventfd_write,0,__VA_ARGS__)
152#define spa_system_eventfd_read(s,...) spa_system_method_r(s,eventfd_read,0,__VA_ARGS__)
153
154#define spa_system_signalfd_create(s,...) spa_system_method_r(s,signalfd_create,0,__VA_ARGS__)
155#define spa_system_signalfd_read(s,...) spa_system_method_r(s,signalfd_read,0,__VA_ARGS__)
156
161#ifdef __cplusplus
162} /* extern "C" */
163#endif
164
165#endif /* SPA_SYSTEM_H */
defs.h
spa/utils/defs.h
hook.h
spa/utils/hook.h
itimerspec
spa_interface
Definition: hook.h:158
spa_poll_event
Definition: system.h:89
spa_poll_event::events
uint32_t events
Definition: system.h:90
spa_poll_event::data
void * data
Definition: system.h:91
spa_system_methods
Definition: system.h:94
spa_system_methods::pollfd_del
int(* pollfd_del)(void *object, int pfd, int fd)
Definition: system.h:115
spa_system_methods::eventfd_read
int(* eventfd_read)(void *object, int fd, uint64_t *count)
Definition: system.h:132
spa_system_methods::signalfd_read
int(* signalfd_read)(void *object, int fd, int *signal)
Definition: system.h:136
spa_system_methods::pollfd_wait
int(* pollfd_wait)(void *object, int pfd, struct spa_poll_event *ev, int n_ev, int timeout)
Definition: system.h:116
spa_system_methods::timerfd_create
int(* timerfd_create)(void *object, int clockid, int flags)
Definition: system.h:120
spa_system_methods::eventfd_write
int(* eventfd_write)(void *object, int fd, uint64_t count)
Definition: system.h:131
spa_system_methods::eventfd_create
int(* eventfd_create)(void *object, int flags)
Definition: system.h:130
spa_system_methods::read
ssize_t(* read)(void *object, int fd, void *buf, size_t count)
Definition: system.h:100
spa_system_methods::version
uint32_t version
Definition: system.h:97
spa_system_methods::clock_getres
int(* clock_getres)(void *object, int clockid, struct timespec *res)
Definition: system.h:108
spa_system_methods::timerfd_read
int(* timerfd_read)(void *object, int fd, uint64_t *expirations)
Definition: system.h:127
spa_system_methods::close
int(* close)(void *object, int fd)
Definition: system.h:103
spa_system_methods::pollfd_create
int(* pollfd_create)(void *object, int flags)
Definition: system.h:112
spa_system_methods::clock_gettime
int(* clock_gettime)(void *object, int clockid, struct timespec *value)
Definition: system.h:106
spa_system_methods::write
ssize_t(* write)(void *object, int fd, const void *buf, size_t count)
Definition: system.h:101
spa_system_methods::pollfd_add
int(* pollfd_add)(void *object, int pfd, int fd, uint32_t events, void *data)
Definition: system.h:113
spa_system_methods::timerfd_gettime
int(* timerfd_gettime)(void *object, int fd, struct itimerspec *curr_value)
Definition: system.h:125
spa_system_methods::signalfd_create
int(* signalfd_create)(void *object, int signal, int flags)
Definition: system.h:135
spa_system_methods::timerfd_settime
int(* timerfd_settime)(void *object, int fd, int flags, const struct itimerspec *new_value, struct itimerspec *old_value)
Definition: system.h:121
spa_system_methods::pollfd_mod
int(* pollfd_mod)(void *object, int pfd, int fd, uint32_t events, void *data)
Definition: system.h:114
spa_system_methods::ioctl
int(* ioctl)(void *object, int fd, unsigned long request,...)
Definition: system.h:102
spa_system
Definition: system.h:65
spa_system::iface
struct spa_interface iface
Definition: system.h:65