PipeWire: spa/utils/defs.h Source File

PipeWire 0.3.59

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