PipeWire 0.3.38
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
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
150 const char *type;
151 uint32_t version;
153};
154
168#define SPA_INTERFACE_INIT(_type,_version,_funcs,_data) \
169 (struct spa_interface){ _type, _version, SPA_CALLBACKS_INIT(_funcs,_data), }
170
175#define spa_callbacks_call(callbacks,type,method,vers,...) \
176({ \
177 const type *_f = (const type *) (callbacks)->funcs; \
178 if (SPA_LIKELY(SPA_CALLBACK_CHECK(_f,method,vers))) \
179 _f->method((callbacks)->data, ## __VA_ARGS__); \
180})
181
185#define spa_callback_version_min(callbacks,type,vers) \
186({ \
187 const type *_f = (const type *) (callbacks)->funcs; \
188 SPA_CALLBACK_VERSION_MIN(_f,vers); \
189})
190
197#define spa_callbacks_call_res(callbacks,type,res,method,vers,...) \
198({ \
199 const type *_f = (const type *) (callbacks)->funcs; \
200 if (SPA_LIKELY(SPA_CALLBACK_CHECK(_f,method,vers))) \
201 res = _f->method((callbacks)->data, ## __VA_ARGS__); \
202 res; \
203})
204
208#define spa_interface_callback_version_min(iface,method_type,vers) \
209 spa_callback_version_min(&(iface)->cb, method_type, vers)
210
216#define spa_interface_call(iface,method_type,method,vers,...) \
217 spa_callbacks_call(&(iface)->cb,method_type,method,vers,##__VA_ARGS__)
218
226#define spa_interface_call_res(iface,method_type,res,method,vers,...) \
227 spa_callbacks_call_res(&(iface)->cb,method_type,res,method,vers,##__VA_ARGS__)
228
304};
305
306
313struct spa_hook {
318 void (*removed) (struct spa_hook *hook);
319 void *priv;
320};
321
323/* static */ inline void spa_hook_list_init(struct spa_hook_list *list)
324{
325 spa_list_init(&list->list);
326}
327
328/* static */ inline bool spa_hook_list_is_empty(struct spa_hook_list *list)
329{
330 return spa_list_is_empty(&list->list);
331}
332
334/* static */ inline void spa_hook_list_append(struct spa_hook_list *list,
335 struct spa_hook *hook,
336 const void *funcs, void *data)
337{
338 spa_zero(*hook);
339 hook->cb = SPA_CALLBACKS_INIT(funcs, data);
340 spa_list_append(&list->list, &hook->link);
341}
342
344/* static */ inline void spa_hook_list_prepend(struct spa_hook_list *list,
345 struct spa_hook *hook,
346 const void *funcs, void *data)
347{
348 spa_zero(*hook);
349 hook->cb = SPA_CALLBACKS_INIT(funcs, data);
350 spa_list_prepend(&list->list, &hook->link);
351}
352
354/* static */ inline void spa_hook_remove(struct spa_hook *hook)
355{
356 spa_list_remove(&hook->link);
357 if (hook->removed)
358 hook->removed(hook);
359}
360
362/* static */ inline void spa_hook_list_clean(struct spa_hook_list *list)
363{
364 struct spa_hook *h;
365 spa_list_consume(h, &list->list, link)
367}
368
369/* static */ inline void
371 struct spa_hook_list *save,
372 struct spa_hook *hook,
373 const void *funcs, void *data)
374{
375 /* init save list and move hooks to it */
376 spa_hook_list_init(save);
377 spa_list_insert_list(&save->list, &list->list);
378 /* init hooks and add single hook */
379 spa_hook_list_init(list);
380 spa_hook_list_append(list, hook, funcs, data);
381}
382
383/* static */ inline void
385 struct spa_hook_list *save)
386{
387 spa_list_insert_list(&list->list, &save->list);
388}
389
390#define spa_hook_list_call_simple(l,type,method,vers,...) \
391({ \
392 struct spa_hook_list *_l = l; \
393 struct spa_hook *_h, *_t; \
394 spa_list_for_each_safe(_h, _t, &_l->list, link) \
395 spa_callbacks_call(&_h->cb,type,method,vers, ## __VA_ARGS__); \
396})
397
401#define spa_hook_list_do_call(l,start,type,method,vers,once,...) \
402({ \
403 struct spa_hook_list *list = l; \
404 struct spa_list *s = start ? (struct spa_list *)start : &list->list; \
405 struct spa_hook cursor = { 0 }, *ci; \
406 int count = 0; \
407 spa_list_cursor_start(cursor, s, link); \
408 spa_list_for_each_cursor(ci, cursor, &list->list, link) { \
409 const type *_f = (const type *)ci->cb.funcs; \
410 if (SPA_LIKELY(SPA_CALLBACK_CHECK(_f,method,vers))) { \
411 _f->method(ci->cb.data, ## __VA_ARGS__); \
412 count++; \
413 if (once) \
414 break; \
415 } \
416 } \
417 spa_list_cursor_end(cursor, link); \
418 count; \
419})
420
425#define spa_hook_list_call(l,t,m,v,...) spa_hook_list_do_call(l,NULL,t,m,v,false,##__VA_ARGS__)
431#define spa_hook_list_call_once(l,t,m,v,...) spa_hook_list_do_call(l,NULL,t,m,v,true,##__VA_ARGS__)
432
433#define spa_hook_list_call_start(l,s,t,m,v,...) spa_hook_list_do_call(l,s,t,m,v,false,##__VA_ARGS__)
434#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__)
435
440#ifdef __cplusplus
441}
442#endif
443
444#endif /* SPA_HOOK_H */
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:370
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:344
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:334
void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition: hook.h:323
bool spa_hook_list_is_empty(struct spa_hook_list *list)
Definition: hook.h:328
void spa_hook_remove(struct spa_hook *hook)
Remove a hook.
Definition: hook.h:354
void spa_hook_list_join(struct spa_hook_list *list, struct spa_hook_list *save)
Definition: hook.h:384
void spa_hook_list_clean(struct spa_hook_list *list)
Remove all hooks from the list.
Definition: hook.h:362
#define SPA_CALLBACKS_INIT(_funcs, _data)
Initialize the set of functions funcs as a spa_callbacks, together with _data.
Definition: hook.h:145
void spa_list_init(struct spa_list *list)
Definition: list.h:44
#define spa_zero(x)
Definition: defs.h:310
void spa_list_insert_list(struct spa_list *list, struct spa_list *other)
Definition: list.h:59
#define spa_list_consume(pos, head, member)
Definition: list.h:96
void spa_list_remove(struct spa_list *elem)
Definition: list.h:69
#define spa_list_prepend(list, item)
Definition: list.h:84
#define spa_list_is_empty(l)
Definition: list.h:49
#define spa_list_append(list, item)
Definition: list.h:81
user data to add to an object
Definition: media-session.c:113
Callbacks, contains the structure with functions and the data passed to the functions.
Definition: hook.h:130
const void * funcs
Definition: hook.h:131
void * data
Definition: hook.h:132
A list of hooks.
Definition: hook.h:302
struct spa_list list
Definition: hook.h:303
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:313
void(* removed)(struct spa_hook *hook)
callback and data for the hook list, private to the hook_list implementor
Definition: hook.h:318
struct spa_callbacks cb
Definition: hook.h:315
struct spa_list link
Definition: hook.h:314
void * priv
Definition: hook.h:319
Definition: hook.h:149
uint32_t version
Definition: hook.h:151
const char * type
Definition: hook.h:150
struct spa_callbacks cb
Definition: hook.h:152
Definition: list.h:37