PipeWire  1.0.3
defs.h
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 {
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 {
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]))
114 
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)++)
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 #define SPA_CLAMPD(v,low,high) \
160 ({ \
161  fmin(fmax(v, low), high); \
162 })
164 
165 #define SPA_SWAP(a,b) \
166 ({ \
167  __typeof__(a) _t = (a); \
168  (a) = b; (b) = _t; \
169 })
170 
171 #define SPA_TYPECHECK(type,x) \
172 ({ type _dummy; \
173  typeof(x) _dummy2; \
174  (void)(&_dummy == &_dummy2); \
175  x; \
176 })
177 
181 #define SPA_PTROFF(ptr_,offset_,type_) ((type_*)((uintptr_t)(ptr_) + (ptrdiff_t)(offset_)))
182 #define SPA_PTROFF_ALIGN(ptr_,offset_,alignment_,type_) \
183  SPA_PTR_ALIGN(SPA_PTROFF(ptr_,offset_,type_),alignment_,type_)
184 
185 
189 #define SPA_MEMBER(b,o,t) SPA_PTROFF(b,o,t)
190 #define SPA_MEMBER_ALIGN(b,o,a,t) SPA_PTROFF_ALIGN(b,o,a,t)
191 
192 #define SPA_CONTAINER_OF(p,t,m) ((t*)((uintptr_t)(p) - offsetof(t,m)))
193 
194 #define SPA_PTRDIFF(p1,p2) ((intptr_t)(p1) - (intptr_t)(p2))
195 
196 #define SPA_PTR_TO_INT(p) ((int) ((intptr_t) (p)))
197 #define SPA_INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
199 #define SPA_PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
200 #define SPA_UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
201 
202 #define SPA_TIME_INVALID ((int64_t)INT64_MIN)
203 #define SPA_IDX_INVALID ((unsigned int)-1)
204 #define SPA_ID_INVALID ((uint32_t)0xffffffff)
205 
206 #define SPA_NSEC_PER_SEC (1000000000LL)
207 #define SPA_NSEC_PER_MSEC (1000000ll)
208 #define SPA_NSEC_PER_USEC (1000ll)
209 #define SPA_USEC_PER_SEC (1000000ll)
210 #define SPA_USEC_PER_MSEC (1000ll)
211 #define SPA_MSEC_PER_SEC (1000ll)
213 #define SPA_TIMESPEC_TO_NSEC(ts) ((ts)->tv_sec * SPA_NSEC_PER_SEC + (ts)->tv_nsec)
214 #define SPA_TIMESPEC_TO_USEC(ts) ((ts)->tv_sec * SPA_USEC_PER_SEC + (ts)->tv_nsec / SPA_NSEC_PER_USEC)
215 #define SPA_TIMEVAL_TO_NSEC(tv) ((tv)->tv_sec * SPA_NSEC_PER_SEC + (tv)->tv_usec * SPA_NSEC_PER_USEC)
216 #define SPA_TIMEVAL_TO_USEC(tv) ((tv)->tv_sec * SPA_USEC_PER_SEC + (tv)->tv_usec)
217 
218 #ifdef __GNUC__
219 #define SPA_PRINTF_FUNC(fmt, arg1) __attribute__((format(printf, fmt, arg1)))
220 #define SPA_FORMAT_ARG_FUNC(arg1) __attribute__((format_arg(arg1)))
221 #define SPA_ALIGNED(align) __attribute__((aligned(align)))
222 #define SPA_DEPRECATED __attribute__ ((deprecated))
223 #define SPA_EXPORT __attribute__((visibility("default")))
224 #define SPA_SENTINEL __attribute__((__sentinel__))
225 #define SPA_UNUSED __attribute__ ((unused))
226 #define SPA_NORETURN __attribute__ ((noreturn))
227 #define SPA_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
228 #else
229 #define SPA_PRINTF_FUNC(fmt, arg1)
230 #define SPA_FORMAT_ARG_FUNC(arg1)
231 #define SPA_ALIGNED(align)
232 #define SPA_DEPRECATED
233 #define SPA_EXPORT
234 #define SPA_SENTINEL
235 #define SPA_UNUSED
236 #define SPA_NORETURN
237 #define SPA_WARN_UNUSED_RESULT
238 #endif
240 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
241 #define SPA_RESTRICT restrict
242 #elif defined(__GNUC__) && __GNUC__ >= 4
243 #define SPA_RESTRICT __restrict__
244 #else
245 #define SPA_RESTRICT
246 #endif
247 
248 #define SPA_ROUND_DOWN(num,value) \
249 ({ \
250  __typeof__(num) _num = (num); \
251  ((_num) - ((_num) % (value))); \
252 })
253 #define SPA_ROUND_UP(num,value) \
254 ({ \
255  __typeof__(value) _v = (value); \
256  ((((num) + (_v) - 1) / (_v)) * (_v)); \
257 })
258 
259 #define SPA_ROUND_MASK(num,mask) ((__typeof__(num))((mask)-1))
260 
261 #define SPA_ROUND_DOWN_N(num,align) ((num) & ~SPA_ROUND_MASK(num, align))
262 #define SPA_ROUND_UP_N(num,align) ((((num)-1) | SPA_ROUND_MASK(num, align))+1)
263 
264 #define SPA_SCALE32_UP(val,num,denom) \
265 ({ \
266  uint64_t _val = (val); \
267  uint64_t _denom = (denom); \
268  (uint32_t)(((_val) * (num) + (_denom)-1) / (_denom)); \
269 })
270 
271 
272 #define SPA_PTR_ALIGNMENT(p,align) ((intptr_t)(p) & ((align)-1))
273 #define SPA_IS_ALIGNED(p,align) (SPA_PTR_ALIGNMENT(p,align) == 0)
274 #define SPA_PTR_ALIGN(p,align,type) ((type*)SPA_ROUND_UP_N((intptr_t)(p), (intptr_t)(align)))
275 
276 #ifndef SPA_LIKELY
277 #ifdef __GNUC__
278 #define SPA_LIKELY(x) (__builtin_expect(!!(x),1))
279 #define SPA_UNLIKELY(x) (__builtin_expect(!!(x),0))
280 #else
281 #define SPA_LIKELY(x) (x)
282 #define SPA_UNLIKELY(x) (x)
283 #endif
284 #endif
286 #define SPA_STRINGIFY_1(...) #__VA_ARGS__
287 #define SPA_STRINGIFY(...) SPA_STRINGIFY_1(__VA_ARGS__)
288 
289 #define spa_return_if_fail(expr) \
290  do { \
291  if (SPA_UNLIKELY(!(expr))) { \
292  fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
293  #expr , __FILE__, __LINE__, __func__); \
294  return; \
295  } \
296  } while(false)
297 
298 #define spa_return_val_if_fail(expr, val) \
299  do { \
300  if (SPA_UNLIKELY(!(expr))) { \
301  fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
302  #expr , __FILE__, __LINE__, __func__); \
303  return (val); \
304  } \
305  } while(false)
306 
307 /* spa_assert_se() is an assert which guarantees side effects of x,
308  * i.e. is never optimized away, regardless of NDEBUG or FASTPATH. */
309 #ifndef __COVERITY__
310 #define spa_assert_se(expr) \
311  do { \
312  if (SPA_UNLIKELY(!(expr))) { \
313  fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
314  #expr , __FILE__, __LINE__, __func__); \
315  abort(); \
316  } \
317  } while (false)
318 #else
319 #define spa_assert_se(expr) \
320  do { \
321  int _unique_var = (expr); \
322  if (!_unique_var) \
323  abort(); \
324  } while (false)
325 #endif
327 /* Does exactly nothing */
328 #define spa_nop() do {} while (false)
329 
330 #ifdef NDEBUG
331 #define spa_assert(expr) spa_nop()
332 #elif defined (FASTPATH)
333 #define spa_assert(expr) spa_assert_se(expr)
334 #else
335 #define spa_assert(expr) spa_assert_se(expr)
336 #endif
338 #ifdef NDEBUG
339 #define spa_assert_not_reached() abort()
340 #else
341 #define spa_assert_not_reached() \
342  do { \
343  fprintf(stderr, "Code should not be reached at %s:%u %s()\n", \
344  __FILE__, __LINE__, __func__); \
345  abort(); \
346  } while (false)
347 #endif
348 
349 #define spa_memzero(x,l) (memset((x), 0, (l)))
350 #define spa_zero(x) (spa_memzero(&(x), sizeof(x)))
352 #ifdef SPA_DEBUG_MEMCPY
353 #define spa_memcpy(d,s,n) \
354 ({ \
355  fprintf(stderr, "%s:%u %s() memcpy(%p, %p, %zd)\n", \
356  __FILE__, __LINE__, __func__, (d), (s), (size_t)(n)); \
357  memcpy(d,s,n); \
358 })
359 #define spa_memmove(d,s,n) \
360 ({ \
361  fprintf(stderr, "%s:%u %s() memmove(%p, %p, %zd)\n", \
362  __FILE__, __LINE__, __func__, (d), (s), (size_t)(n)); \
363  memmove(d,s,n); \
364 })
365 #else
366 #define spa_memcpy(d,s,n) memcpy(d,s,n)
367 #define spa_memmove(d,s,n) memmove(d,s,n)
368 #endif
370 #define spa_aprintf(_fmt, ...) \
371 ({ \
372  char *_strp; \
373  if (asprintf(&(_strp), (_fmt), ## __VA_ARGS__ ) == -1) \
374  _strp = NULL; \
375  _strp; \
376 })
377 
382 #ifdef __cplusplus
383 } /* extern "C" */
384 #endif
385 
386 #endif /* SPA_UTILS_DEFS_H */
int32_t x
Definition: defs.h:110
Definition: defs.h:109
uint32_t num
Definition: defs.h:124
uint32_t denom
Definition: defs.h:125
Definition: defs.h:93
uint32_t height
Definition: defs.h:104
Definition: defs.h:116
Definition: defs.h:102
Definition: defs.h:123
struct spa_rectangle size
Definition: defs.h:118
uint32_t width
Definition: defs.h:103
Definition: defs.h:94
spa_direction
Definition: defs.h:92
int32_t y
Definition: defs.h:111
struct spa_point position
Definition: defs.h:117