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