PipeWire: utils.h Source File

PipeWire 0.3.34

build/doc/spa/node/utils.h
Go to the documentation of this file.
1 /* Simple Plugin API
2 *
3 * Copyright © 2019 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_NODE_UTILS_H
26 #define SPA_NODE_UTILS_H
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
37 #include <spa/pod/builder.h>
38
39 #include <spa/node/node.h>
40
41 struct spa_result_node_params_data {
42 struct spa_pod_builder *builder;
43 struct spa_result_node_params data;
44 };
45
46 /* static */ inline void spa_result_func_node_params(void *data,
47 int seq, int res, uint32_t type, const void *result)
48 {
49 struct spa_result_node_params_data *d =
50 (struct spa_result_node_params_data *) data;
51 const struct spa_result_node_params *r =
52 (const struct spa_result_node_params *) result;
53 uint32_t offset = d->builder->state.offset;
54 spa_pod_builder_raw_padded(d->builder, r->param, SPA_POD_SIZE(r->param));
55 d->data.next = r->next;
56 d->data.param = SPA_PTROFF(d->builder->data, offset, struct spa_pod);
57 }
58
59 /* static */ inline int spa_node_enum_params_sync(struct spa_node *node,
60 uint32_t id, uint32_t *index,
61 const struct spa_pod *filter,
62 struct spa_pod **param,
63 struct spa_pod_builder *builder)
64 {
65 struct spa_result_node_params_data data = { builder, };
66 struct spa_hook listener = {{0}};
67 static const struct spa_node_events node_events = {
68 .version = SPA_VERSION_NODE_EVENTS,
69 .info = NULL,
70 .port_info = NULL,
71 .result = spa_result_func_node_params,
72 };
73 int res;
74
75 res = spa_node_add_listener(node, &listener, &node_events, &data);
76 if (res >= 0) {
77 res = spa_node_enum_params(node, 0, id, *index, 1, filter);
78 spa_hook_remove(&listener);
79 }
80
81 if (data.data.param == NULL) {
82 if (res > 0)
83 res = 0;
84 } else {
85 *index = data.data.next;
86 *param = data.data.param;
87 res = 1;
88 }
89 return res;
90 }
91
92 /* static */ inline int spa_node_port_enum_params_sync(struct spa_node *node,
93 enum spa_direction direction, uint32_t port_id,
94 uint32_t id, uint32_t *index,
95 const struct spa_pod *filter,
96 struct spa_pod **param,
97 struct spa_pod_builder *builder)
98 {
99 struct spa_result_node_params_data data = { builder, };
100 struct spa_hook listener = {{0}};
101 static const struct spa_node_events node_events = {
102 .version = SPA_VERSION_NODE_EVENTS,
103 .info = NULL,
104 .port_info = NULL,
105 .result = spa_result_func_node_params,
106 };
107 int res;
108
109 res = spa_node_add_listener(node, &listener, &node_events, &data);
110 if (res >= 0) {
111 res = spa_node_port_enum_params(node, 0, direction, port_id,
112 id, *index, 1, filter);
113 spa_hook_remove(&listener);
114 }
115
116 if (data.data.param == NULL) {
117 if (res > 0)
118 res = 0;
119 } else {
120 *index = data.data.next;
121 *param = data.data.param;
122 res = 1;
123 }
124 return res;
125 }
126
127 #define spa_node_emit(hooks,method,version,...) \
128 spa_hook_list_call_simple(hooks, struct spa_node_events, \
129 method, version, ##__VA_ARGS__)
130
131 #define spa_node_emit_info(hooks,...) spa_node_emit(hooks,info, 0, __VA_ARGS__)
132 #define spa_node_emit_port_info(hooks,...) spa_node_emit(hooks,port_info, 0, __VA_ARGS__)
133 #define spa_node_emit_result(hooks,...) spa_node_emit(hooks,result, 0, __VA_ARGS__)
134 #define spa_node_emit_event(hooks,...) spa_node_emit(hooks,event, 0, __VA_ARGS__)
135
136
137 #define spa_node_call(callbacks,method,version,...) \
138 ({ \
139 int _res = -ENOTSUP; \
140 spa_callbacks_call_res(callbacks, struct spa_node_callbacks, \
141 _res, method, version, ##__VA_ARGS__); \
142 _res; \
143 })
144
145 #define spa_node_call_ready(hook,...) spa_node_call(hook, ready, 0, __VA_ARGS__)
146 #define spa_node_call_reuse_buffer(hook,...) spa_node_call(hook, reuse_buffer, 0, __VA_ARGS__)
147 #define spa_node_call_xrun(hook,...) spa_node_call(hook, xrun, 0, __VA_ARGS__)
148
153 #ifdef __cplusplus
154 } /* extern "C" */
155 #endif
156
157 #endif /* SPA_NODE_UTILS_H */
node.h
SPA_VERSION_NODE_EVENTS
#define SPA_VERSION_NODE_EVENTS
Definition: build/doc/spa/node/node.h:157
builder.h
spa_hook_remove
void spa_hook_remove(struct spa_hook *hook)
Remove a hook.
Definition: hook.h:336
spa_node_enum_params_sync
int spa_node_enum_params_sync(struct spa_node *node, uint32_t id, uint32_t *index, const struct spa_pod *filter, struct spa_pod **param, struct spa_pod_builder *builder)
Definition: build/doc/spa/node/utils.h:59
spa_node_port_enum_params_sync
int spa_node_port_enum_params_sync(struct spa_node *node, enum spa_direction direction, uint32_t port_id, uint32_t id, uint32_t *index, const struct spa_pod *filter, struct spa_pod **param, struct spa_pod_builder *builder)
Definition: build/doc/spa/node/utils.h:92
spa_node_add_listener
#define spa_node_add_listener(n,...)
Definition: build/doc/spa/node/node.h:648
spa_node_port_enum_params
#define spa_node_port_enum_params(n,...)
Definition: build/doc/spa/node/node.h:657
spa_result_func_node_params
void spa_result_func_node_params(void *data, int seq, int res, uint32_t type, const void *result)
Definition: build/doc/spa/node/utils.h:46
spa_node_enum_params
#define spa_node_enum_params(n,...)
Definition: build/doc/spa/node/node.h:651
spa_pod_builder_raw_padded
int spa_pod_builder_raw_padded(struct spa_pod_builder *builder, const void *data, uint32_t size)
Definition: builder.h:167
SPA_POD_SIZE
#define SPA_POD_SIZE(pod)
Definition: pod/pod.h:42
spa_direction
spa_direction
Definition: defs.h:78
SPA_PTROFF
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition: defs.h:159
data
user data to add to an object
Definition: filter.c:75
filter
Definition: filter.c:126
node
Definition: module-filter-chain.c:159
param
Definition: filter.c:80
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
spa_node_events
events from the spa_node.
Definition: build/doc/spa/node/node.h:156
spa_node_events::version
uint32_t version
version of this structure
Definition: build/doc/spa/node/node.h:158
spa_node
Definition: build/doc/spa/node/node.h:53
spa_pod_builder_state::offset
uint32_t offset
Definition: builder.h:47
spa_pod_builder
Definition: builder.h:63
spa_pod_builder::data
void * data
Definition: builder.h:64
spa_pod_builder::state
struct spa_pod_builder_state state
Definition: builder.h:67
spa_pod
Definition: pod/pod.h:50
spa_result_node_params_data
Definition: build/doc/spa/node/utils.h:41
spa_result_node_params_data::data
struct spa_result_node_params data
Definition: build/doc/spa/node/utils.h:43
spa_result_node_params_data::builder
struct spa_pod_builder * builder
Definition: build/doc/spa/node/utils.h:42
spa_result_node_params
the result of enum_params or port_enum_params.
Definition: build/doc/spa/node/node.h:137
spa_result_node_params::param
struct spa_pod * param
the result param
Definition: build/doc/spa/node/node.h:141
spa_result_node_params::next
uint32_t next
next index of iteration
Definition: build/doc/spa/node/node.h:140
spa_result_node_params::index
uint32_t index
index of parameter
Definition: build/doc/spa/node/node.h:139