PipeWire: spa/utils/hook.h Source File

PipeWire 0.3.51

hook.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_HOOK_H
26#define SPA_HOOK_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <spa/utils/defs.h>
33#include <spa/utils/list.h>
34
130struct spa_callbacks {
131 const void *funcs;
132 void *data;
133};
134
136#define SPA_CALLBACK_VERSION_MIN(c,v) ((c) && ((v) == 0 || (c)->version > (v)-1))
137
139#define SPA_CALLBACK_CHECK(c,m,v) (SPA_CALLBACK_VERSION_MIN(c,v) && (c)->m)
140
145#define SPA_CALLBACKS_INIT(_funcs,_data) (struct spa_callbacks){ _funcs, _data, }
146
149struct spa_interface {
150 const char *type;
151 uint32_t version;
152 struct spa_callbacks cb;
153};
154
168#define SPA_INTERFACE_INIT(_type,_version,_funcs,_data) \
169 (struct spa_interface){ _type, _version, SPA_CALLBACKS_INIT(_funcs,_data), }
170
176#define spa_callbacks_call(callbacks,type,method,vers,...) \
177({ \
178 const type *_f = (const type *) (callbacks)->funcs; \
179 bool _res = SPA_CALLBACK_CHECK(_f,method,vers); \
180 if (SPA_LIKELY(_res)) \
181 _f->method((callbacks)->data, ## __VA_ARGS__); \
182 _res; \
183})
184
188#define spa_callback_version_min(callbacks,type,vers) \
189({ \
190 const type *_f = (const type *) (callbacks)->funcs; \
191 SPA_CALLBACK_VERSION_MIN(_f,vers); \
192})
193
198#define spa_callback_check(callbacks,type,method,vers) \
199({ \
200 const type *_f = (const type *) (callbacks)->funcs; \
201 SPA_CALLBACK_CHECK(_f,method,vers); \
202})
203
210#define spa_callbacks_call_res(callbacks,type,res,method,vers,...) \
211({ \
212 const type *_f = (const type *) (callbacks)->funcs; \
213 if (SPA_LIKELY(SPA_CALLBACK_CHECK(_f,method,vers))) \
214 res = _f->method((callbacks)->data, ## __VA_ARGS__); \
215 res; \
216})
217
221#define spa_interface_callback_version_min(iface,method_type,vers) \
222 spa_callback_version_min(&(iface)->cb, method_type, vers)
223
228#define spa_interface_callback_check(iface,method_type,method,vers) \
229 spa_callback_check(&(iface)->cb, method_type, method, vers)
230
236#define spa_interface_call(iface,method_type,method,vers,...) \
237 spa_callbacks_call(&(iface)->cb,method_type,method,vers,##__VA_ARGS__)
238
246#define spa_interface_call_res(iface,method_type,res,method,vers,...) \
247 spa_callbacks_call_res(&(iface)->cb,method_type,res,method,vers,##__VA_ARGS__)
248
331struct spa_hook_list {
332 struct spa_list list;
333};
334
335
342struct spa_hook {
343 struct spa_list link;
344 struct spa_callbacks cb;
347 void (*removed) (struct spa_hook *hook);
348 void *priv;
349};
350
352 static inline void spa_hook_list_init(struct spa_hook_list *list)
353{
354 spa_list_init(&list->list);
355}
356
357 static inline bool spa_hook_list_is_empty(struct spa_hook_list *list)
358{
359 return spa_list_is_empty(&list->list);
360}
361
363static inline void spa_hook_list_append(struct spa_hook_list *list,
364 struct spa_hook *hook,
365 const void *funcs, void *data)
366{
367 spa_zero(*hook);
368 hook->cb = SPA_CALLBACKS_INIT(funcs, data);
369 spa_list_append(&list->list, &hook->link);
370}
371
373static inline void spa_hook_list_prepend(struct spa_hook_list *list,
374 struct spa_hook *hook,
375 const void *funcs, void *data)
376{
377 spa_zero(*hook);
378 hook->cb = SPA_CALLBACKS_INIT(funcs, data);
379 spa_list_prepend(&list->list, &hook->link);
380}
381
383static inline void spa_hook_remove(struct spa_hook *hook)
384{
385 spa_list_remove(&hook->link);
386 if (hook->removed)
387 hook->removed(hook);
388}
389
391static inline void spa_hook_list_clean(struct spa_hook_list *list)
392{
393 struct spa_hook *h;
394 spa_list_consume(h, &list->list, link)
395 spa_hook_remove(h);
396}
397
398static inline void
399 spa_hook_list_isolate(struct spa_hook_list *list,
400 struct spa_hook_list *save,
401 struct spa_hook *hook,
402 const void *funcs, void *data)
403{
404 /* init save list and move hooks to it */
405 spa_hook_list_init(save);
406 spa_list_insert_list(&save->list, &list->list);
407 /* init hooks and add single hook */
408 spa_hook_list_init(list);
409 spa_hook_list_append(list, hook, funcs, data);
410}
411
412static inline void
413 spa_hook_list_join(struct spa_hook_list *list,
414 struct spa_hook_list *save)
415{
416 spa_list_insert_list(&list->list, &save->list);
417}
418
419#define spa_hook_list_call_simple(l,type,method,vers,...) \
420({ \
421 struct spa_hook_list *_l = l; \
422 struct spa_hook *_h, *_t; \
423 spa_list_for_each_safe(_h, _t, &_l->list, link) \
424 spa_callbacks_call(&_h->cb,type,method,vers, ## __VA_ARGS__); \
425})
426
430#define spa_hook_list_do_call(l,start,type,method,vers,once,...) \
431({ \
432 struct spa_hook_list *_list = l; \
433 struct spa_list *_s = start ? (struct spa_list *)start : &_list->list; \
434 struct spa_hook _cursor = { 0 }, *_ci; \
435 int _count = 0; \
436 spa_list_cursor_start(_cursor, _s, link); \
437 spa_list_for_each_cursor(_ci, _cursor, &_list->list, link) { \
438 if (spa_callbacks_call(&_ci->cb,type,method,vers, ## __VA_ARGS__)) { \
439 _count++; \
440 if (once) \
441 break; \
442 } \
443 } \
444 spa_list_cursor_end(_cursor, link); \
445 _count; \
446})
447
452#define spa_hook_list_call(l,t,m,v,...) spa_hook_list_do_call(l,NULL,t,m,v,false,##__VA_ARGS__)
458#define spa_hook_list_call_once(l,t,m,v,...) spa_hook_list_do_call(l,NULL,t,m,v,true,##__VA_ARGS__)
459
460#define spa_hook_list_call_start(l,s,t,m,v,...) spa_hook_list_do_call(l,s,t,m,v,false,##__VA_ARGS__)
461#define spa_hook_list_call_once_start(l,s,t,m,v,...) spa_hook_list_do_call(l,s,t,m,v,true,##__VA_ARGS__)
462
467#ifdef __cplusplus
468}
469#endif
470
471#endif /* SPA_HOOK_H */
defs.h
spa/utils/defs.h
spa_hook_list_is_empty
static bool spa_hook_list_is_empty(struct spa_hook_list *list)
Definition: hook.h:366
spa_hook_list_append
static void spa_hook_list_append(struct spa_hook_list *list, struct spa_hook *hook, const void *funcs, void *data)
Append a hook.
Definition: hook.h:372
spa_hook_list_join
static void spa_hook_list_join(struct spa_hook_list *list, struct spa_hook_list *save)
Definition: hook.h:422
spa_hook_list_init
static void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition: hook.h:361
spa_hook_remove
static void spa_hook_remove(struct spa_hook *hook)
Remove a hook.
Definition: hook.h:392
spa_hook_list_clean
static void spa_hook_list_clean(struct spa_hook_list *list)
Remove all hooks from the list.
Definition: hook.h:400
spa_hook_list_prepend
static void spa_hook_list_prepend(struct spa_hook_list *list, struct spa_hook *hook, const void *funcs, void *data)
Prepend a hook.
Definition: hook.h:382
spa_hook_list_isolate
static void spa_hook_list_isolate(struct spa_hook_list *list, struct spa_hook_list *save, struct spa_hook *hook, const void *funcs, void *data)
Definition: hook.h:408
SPA_CALLBACKS_INIT
#define SPA_CALLBACKS_INIT(_funcs, _data)
Initialize the set of functions funcs as a spa_callbacks, together with _data.
Definition: hook.h:154
spa_list_consume
#define spa_list_consume(pos, head, member)
Definition: list.h:107
spa_list_init
static void spa_list_init(struct spa_list *list)
Definition: list.h:55
spa_list_remove
static void spa_list_remove(struct spa_list *elem)
Definition: list.h:80
spa_list_prepend
#define spa_list_prepend(list, item)
Definition: list.h:95
spa_list_is_empty
#define spa_list_is_empty(l)
Definition: list.h:60
spa_list_append
#define spa_list_append(list, item)
Definition: list.h:92
spa_list_insert_list
static void spa_list_insert_list(struct spa_list *list, struct spa_list *other)
Definition: list.h:70
spa_zero
#define spa_zero(x)
Definition: defs.h:385
list.h
spa/utils/list.h
spa_callbacks
Callbacks, contains the structure with functions and the data passed to the functions.
Definition: hook.h:136
spa_callbacks::funcs
const void * funcs
Definition: hook.h:137
spa_callbacks::data
void * data
Definition: hook.h:138
spa_hook_list
A list of hooks.
Definition: hook.h:340
spa_hook_list::list
struct spa_list list
Definition: hook.h:341
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
spa_hook::removed
void(* removed)(struct spa_hook *hook)
callback and data for the hook list, private to the hook_list implementor
Definition: hook.h:356
spa_hook::cb
struct spa_callbacks cb
Definition: hook.h:353
spa_hook::link
struct spa_list link
Definition: hook.h:352
spa_hook::priv
void * priv
Definition: hook.h:357
spa_interface
Definition: hook.h:158
spa_interface::version
uint32_t version
Definition: hook.h:160
spa_interface::type
const char * type
Definition: hook.h:159
spa_interface::cb
struct spa_callbacks cb
Definition: hook.h:161
spa_list
Definition: list.h:47