PipeWire: defs.h Source File

PipeWire 0.3.37

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