PipeWire 1.0.1

Loading...
Searching...
No Matches
defs.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_UTILS_DEFS_H
6#define SPA_UTILS_DEFS_H
7
8#ifdef __cplusplus
9 extern "C" {
10# if __cplusplus >= 201103L
11# define SPA_STATIC_ASSERT_IMPL(expr, msg, ...) static_assert(expr, msg)
12# endif
13#else
14# include <stdbool.h>
15# if __STDC_VERSION__ >= 201112L
16# define SPA_STATIC_ASSERT_IMPL(expr, msg, ...) _Static_assert(expr, msg)
17# endif
18#endif
19#ifndef SPA_STATIC_ASSERT_IMPL
20#define SPA_STATIC_ASSERT_IMPL(expr, ...) \
21 ((void)sizeof(struct { int spa_static_assertion_failed : 2 * !!(expr) - 1; }))
22#endif
23
24#define SPA_STATIC_ASSERT(expr, ...) SPA_STATIC_ASSERT_IMPL(expr, ## __VA_ARGS__, "`" #expr "` evaluated to false")
25
26#include <inttypes.h>
27#include <signal.h>
28#include <stdlib.h>
29#include <string.h>
30#include <stddef.h>
31#include <stdio.h>
32
58#if defined(__clang__) && defined(__cplusplus) && __cplusplus >= 201103L
59 /* clang's fallthrough annotations are only available starting in C++11. */
60# define SPA_FALLTHROUGH [[clang::fallthrough]];
61#elif __GNUC__ >= 7 || __clang_major__ >= 10
62# define SPA_FALLTHROUGH __attribute__ ((fallthrough));
63#else
64# define SPA_FALLTHROUGH /* FALLTHROUGH */
65#endif
66
67#define SPA_FLAG_MASK(field,mask,flag) (((field) & (mask)) == (flag))
68#define SPA_FLAG_IS_SET(field,flag) SPA_FLAG_MASK(field, flag, flag)
69
70#define SPA_FLAG_SET(field,flag) ((field) |= (flag))
71#define SPA_FLAG_CLEAR(field, flag) \
72({ \
73 SPA_STATIC_ASSERT(__builtin_constant_p(flag) ? \
74 (__typeof__(flag))(__typeof__(field))(__typeof__(flag))(flag) == (flag) : \
75 sizeof(field) >= sizeof(flag), \
76 "truncation problem when masking " #field \
77 " with ~" #flag); \
78 ((field) &= ~(__typeof__(field))(flag)); \
79})
80#define SPA_FLAG_UPDATE(field,flag,val) ((val) ? SPA_FLAG_SET((field),(flag)) : SPA_FLAG_CLEAR((field),(flag)))
81
82 enum spa_direction {
83 SPA_DIRECTION_INPUT = 0,
84 SPA_DIRECTION_OUTPUT = 1,
85};
86
87#define SPA_DIRECTION_REVERSE(d) ((d) ^ 1)
88
89#define SPA_RECTANGLE(width,height) ((struct spa_rectangle){ (width), (height) })
90 struct spa_rectangle {
91 uint32_t width;
92 uint32_t height;
93};
94
95#define SPA_POINT(x,y) ((struct spa_point){ (x), (y) })
96 struct spa_point {
97 int32_t x;
98 int32_t y;
99};
100
101#define SPA_REGION(x,y,width,height) ((struct spa_region){ SPA_POINT(x,y), SPA_RECTANGLE(width,height) })
102 struct spa_region {
103 struct spa_point position;
104 struct spa_rectangle size;
105};
106
107#define SPA_FRACTION(num,denom) ((struct spa_fraction){ (num), (denom) })
108 struct spa_fraction {
109 uint32_t num;
110 uint32_t denom;
111};
112
113#define SPA_N_ELEMENTS(arr) (sizeof(arr) / sizeof((arr)[0]))
124#define SPA_FOR_EACH_ELEMENT(arr, ptr) \
125 for ((ptr) = arr; (void*)(ptr) < SPA_PTROFF(arr, sizeof(arr), void); (ptr)++)
126
127#define SPA_FOR_EACH_ELEMENT_VAR(arr, var) \
128 for (__typeof__((arr)[0])* var = arr; (void*)(var) < SPA_PTROFF(arr, sizeof(arr), void); (var)++)
129
130#define SPA_ABS(a) \
131({ \
132 __typeof__(a) _a = (a); \
133 SPA_LIKELY(_a >= 0) ? _a : -_a; \
134})
135#define SPA_MIN(a,b) \
136({ \
137 __typeof__(a) _min_a = (a); \
138 __typeof__(b) _min_b = (b); \
139 SPA_LIKELY(_min_a <= _min_b) ? _min_a : _min_b; \
140})
141#define SPA_MAX(a,b) \
142({ \
143 __typeof__(a) _max_a = (a); \
144 __typeof__(b) _max_b = (b); \
145 SPA_LIKELY(_max_a >= _max_b) ? _max_a : _max_b; \
146})
147#define SPA_CLAMP(v,low,high) \
148({ \
149 __typeof__(v) _v = (v); \
150 __typeof__(low) _low = (low); \
151 __typeof__(high) _high = (high); \
152 SPA_MIN(SPA_MAX(_v, _low), _high); \
153})
154
155#define SPA_CLAMPF(v,low,high) \
156({ \
157 fminf(fmaxf(v, low), high); \
158})
159
160
161#define SPA_SWAP(a,b) \
162({ \
163 __typeof__(a) _t = (a); \
164 (a) = b; (b) = _t; \
165})
166
167#define SPA_TYPECHECK(type,x) \
168({ type _dummy; \
169 typeof(x) _dummy2; \
170 (void)(&_dummy == &_dummy2); \
171 x; \
172})
173
177#define SPA_PTROFF(ptr_,offset_,type_) ((type_*)((uintptr_t)(ptr_) + (ptrdiff_t)(offset_)))
178#define SPA_PTROFF_ALIGN(ptr_,offset_,alignment_,type_) \
179 SPA_PTR_ALIGN(SPA_PTROFF(ptr_,offset_,type_),alignment_,type_)
180
181
185#define SPA_MEMBER(b,o,t) SPA_PTROFF(b,o,t)
186#define SPA_MEMBER_ALIGN(b,o,a,t) SPA_PTROFF_ALIGN(b,o,a,t)
187
188#define SPA_CONTAINER_OF(p,t,m) ((t*)((uintptr_t)(p) - offsetof(t,m)))
189
190#define SPA_PTRDIFF(p1,p2) ((intptr_t)(p1) - (intptr_t)(p2))
191
192#define SPA_PTR_TO_INT(p) ((int) ((intptr_t) (p)))
193#define SPA_INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
194
195#define SPA_PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
196#define SPA_UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
197
198#define SPA_TIME_INVALID ((int64_t)INT64_MIN)
199#define SPA_IDX_INVALID ((unsigned int)-1)
200#define SPA_ID_INVALID ((uint32_t)0xffffffff)
201
202#define SPA_NSEC_PER_SEC (1000000000LL)
203#define SPA_NSEC_PER_MSEC (1000000ll)
204#define SPA_NSEC_PER_USEC (1000ll)
205#define SPA_USEC_PER_SEC (1000000ll)
206#define SPA_USEC_PER_MSEC (1000ll)
207#define SPA_MSEC_PER_SEC (1000ll)
208
209#define SPA_TIMESPEC_TO_NSEC(ts) ((ts)->tv_sec * SPA_NSEC_PER_SEC + (ts)->tv_nsec)
210#define SPA_TIMESPEC_TO_USEC(ts) ((ts)->tv_sec * SPA_USEC_PER_SEC + (ts)->tv_nsec / SPA_NSEC_PER_USEC)
211#define SPA_TIMEVAL_TO_NSEC(tv) ((tv)->tv_sec * SPA_NSEC_PER_SEC + (tv)->tv_usec * SPA_NSEC_PER_USEC)
212#define SPA_TIMEVAL_TO_USEC(tv) ((tv)->tv_sec * SPA_USEC_PER_SEC + (tv)->tv_usec)
213
214#ifdef __GNUC__
215#define SPA_PRINTF_FUNC(fmt, arg1) __attribute__((format(printf, fmt, arg1)))
216#define SPA_FORMAT_ARG_FUNC(arg1) __attribute__((format_arg(arg1)))
217#define SPA_ALIGNED(align) __attribute__((aligned(align)))
218#define SPA_DEPRECATED __attribute__ ((deprecated))
219#define SPA_EXPORT __attribute__((visibility("default")))
220#define SPA_SENTINEL __attribute__((__sentinel__))
221#define SPA_UNUSED __attribute__ ((unused))
222#define SPA_NORETURN __attribute__ ((noreturn))
223#define SPA_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
224#else
225#define SPA_PRINTF_FUNC(fmt, arg1)
226#define SPA_FORMAT_ARG_FUNC(arg1)
227#define SPA_ALIGNED(align)
228#define SPA_DEPRECATED
229#define SPA_EXPORT
230#define SPA_SENTINEL
231#define SPA_UNUSED
232#define SPA_NORETURN
233#define SPA_WARN_UNUSED_RESULT
234#endif
235
236#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
237#define SPA_RESTRICT restrict
238#elif defined(__GNUC__) && __GNUC__ >= 4
239#define SPA_RESTRICT __restrict__
240#else
241#define SPA_RESTRICT
242#endif
243
244#define SPA_ROUND_DOWN(num,value) \
245({ \
246 __typeof__(num) _num = (num); \
247 ((_num) - ((_num) % (value))); \
248})
249#define SPA_ROUND_UP(num,value) \
250({ \
251 __typeof__(value) _v = (value); \
252 ((((num) + (_v) - 1) / (_v)) * (_v)); \
253})
254
255#define SPA_ROUND_MASK(num,mask) ((__typeof__(num))((mask)-1))
256
257#define SPA_ROUND_DOWN_N(num,align) ((num) & ~SPA_ROUND_MASK(num, align))
258#define SPA_ROUND_UP_N(num,align) ((((num)-1) | SPA_ROUND_MASK(num, align))+1)
259
260#define SPA_SCALE32_UP(val,num,denom) \
261({ \
262 uint64_t _val = (val); \
263 uint64_t _denom = (denom); \
264 (uint32_t)(((_val) * (num) + (_denom)-1) / (_denom)); \
265})
266
267
268#define SPA_PTR_ALIGNMENT(p,align) ((intptr_t)(p) & ((align)-1))
269#define SPA_IS_ALIGNED(p,align) (SPA_PTR_ALIGNMENT(p,align) == 0)
270#define SPA_PTR_ALIGN(p,align,type) ((type*)SPA_ROUND_UP_N((intptr_t)(p), (intptr_t)(align)))
271
272#ifndef SPA_LIKELY
273#ifdef __GNUC__
274#define SPA_LIKELY(x) (__builtin_expect(!!(x),1))
275#define SPA_UNLIKELY(x) (__builtin_expect(!!(x),0))
276#else
277#define SPA_LIKELY(x) (x)
278#define SPA_UNLIKELY(x) (x)
279#endif
280#endif
281
282#define SPA_STRINGIFY_1(...) #__VA_ARGS__
283#define SPA_STRINGIFY(...) SPA_STRINGIFY_1(__VA_ARGS__)
284
285#define spa_return_if_fail(expr) \
286 do { \
287 if (SPA_UNLIKELY(!(expr))) { \
288 fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
289 #expr , __FILE__, __LINE__, __func__); \
290 return; \
291 } \
292 } while(false)
293
294#define spa_return_val_if_fail(expr, val) \
295 do { \
296 if (SPA_UNLIKELY(!(expr))) { \
297 fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
298 #expr , __FILE__, __LINE__, __func__); \
299 return (val); \
300 } \
301 } while(false)
302
303/* spa_assert_se() is an assert which guarantees side effects of x,
304 * i.e. is never optimized away, regardless of NDEBUG or FASTPATH. */
305#ifndef __COVERITY__
306#define spa_assert_se(expr) \
307 do { \
308 if (SPA_UNLIKELY(!(expr))) { \
309 fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
310 #expr , __FILE__, __LINE__, __func__); \
311 abort(); \
312 } \
313 } while (false)
314#else
315#define spa_assert_se(expr) \
316 do { \
317 int _unique_var = (expr); \
318 if (!_unique_var) \
319 abort(); \
320 } while (false)
321#endif
322
323/* Does exactly nothing */
324#define spa_nop() do {} while (false)
325
326#ifdef NDEBUG
327#define spa_assert(expr) spa_nop()
328#elif defined (FASTPATH)
329#define spa_assert(expr) spa_assert_se(expr)
330#else
331#define spa_assert(expr) spa_assert_se(expr)
332#endif
333
334#ifdef NDEBUG
335#define spa_assert_not_reached() abort()
336#else
337#define spa_assert_not_reached() \
338 do { \
339 fprintf(stderr, "Code should not be reached at %s:%u %s()\n", \
340 __FILE__, __LINE__, __func__); \
341 abort(); \
342 } while (false)
343#endif
344
345#define spa_memzero(x,l) (memset((x), 0, (l)))
346#define spa_zero(x) (spa_memzero(&(x), sizeof(x)))
347
348#ifdef SPA_DEBUG_MEMCPY
349#define spa_memcpy(d,s,n) \
350({ \
351 fprintf(stderr, "%s:%u %s() memcpy(%p, %p, %zd)\n", \
352 __FILE__, __LINE__, __func__, (d), (s), (size_t)(n)); \
353 memcpy(d,s,n); \
354})
355#define spa_memmove(d,s,n) \
356({ \
357 fprintf(stderr, "%s:%u %s() memmove(%p, %p, %zd)\n", \
358 __FILE__, __LINE__, __func__, (d), (s), (size_t)(n)); \
359 memmove(d,s,n); \
360})
361#else
362#define spa_memcpy(d,s,n) memcpy(d,s,n)
363#define spa_memmove(d,s,n) memmove(d,s,n)
364#endif
365
366#define spa_aprintf(_fmt, ...) \
367({ \
368 char *_strp; \
369 if (asprintf(&(_strp), (_fmt), ## __VA_ARGS__ ) == -1) \
370 _strp = NULL; \
371 _strp; \
372})
373
378#ifdef __cplusplus
379} /* extern "C" */
380#endif
381
382#endif /* SPA_UTILS_DEFS_H */
spa_direction
spa_direction
Definition defs.h:92
SPA_DIRECTION_INPUT
@ SPA_DIRECTION_INPUT
Definition defs.h:93
SPA_DIRECTION_OUTPUT
@ SPA_DIRECTION_OUTPUT
Definition defs.h:94
string.h
spa/utils/string.h
spa_fraction
Definition defs.h:123
spa_fraction::num
uint32_t num
Definition defs.h:124
spa_fraction::denom
uint32_t denom
Definition defs.h:125
spa_point
Definition defs.h:109
spa_point::y
int32_t y
Definition defs.h:111
spa_point::x
int32_t x
Definition defs.h:110
spa_rectangle
Definition defs.h:102
spa_rectangle::width
uint32_t width
Definition defs.h:103
spa_rectangle::height
uint32_t height
Definition defs.h:104
spa_region
Definition defs.h:116
spa_region::position
struct spa_point position
Definition defs.h:117
spa_region::size
struct spa_rectangle size
Definition defs.h:118