utils.h
Go to the documentation of this file.
/* Simple Plugin API
*
* Copyright © 2019 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef SPA_NODE_UTILS_H
#define SPA_NODE_UTILS_H
#ifdef __cplusplus
extern "C" {
#endif
#include <spa/pod/builder.h>
#include <spa/node/node.h>
struct spa_result_node_params_data {
struct spa_pod_builder *builder;
struct spa_result_node_params data;
};
static inline void spa_result_func_node_params(void *data,
int seq, int res, uint32_t type, const void *result)
{
struct spa_result_node_params_data *d =
(struct spa_result_node_params_data *) data;
const struct spa_result_node_params *r =
(const struct spa_result_node_params *) result;
uint32_t offset = d->builder->state.offset;
if (spa_pod_builder_raw_padded(d->builder, r->param, SPA_POD_SIZE(r->param)) < 0)
return;
d->data.next = r->next;
d->data.param = spa_pod_builder_deref(d->builder, offset);
}
static inline 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)
{
struct spa_result_node_params_data data = { builder, };
struct spa_hook listener = {{0}};
static const struct spa_node_events node_events = {
.version = SPA_VERSION_NODE_EVENTS,
.info = NULL,
.port_info = NULL,
.result = spa_result_func_node_params,
};
int res;
res = spa_node_add_listener(node, &listener, &node_events, &data);
if (res >= 0) {
res = spa_node_enum_params(node, 0, id, *index, 1, filter);
spa_hook_remove(&listener);
}
if (data.data.param == NULL) {
if (res > 0)
res = 0;
} else {
*index = data.data.next;
*param = data.data.param;
res = 1;
}
return res;
}
static inline 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)
{
struct spa_result_node_params_data data = { builder, };
struct spa_hook listener = {{0}};
static const struct spa_node_events node_events = {
.version = SPA_VERSION_NODE_EVENTS,
.info = NULL,
.port_info = NULL,
.result = spa_result_func_node_params,
};
int res;
res = spa_node_add_listener(node, &listener, &node_events, &data);
if (res >= 0) {
res = spa_node_port_enum_params(node, 0, direction, port_id,
id, *index, 1, filter);
spa_hook_remove(&listener);
}
if (data.data.param == NULL) {
if (res > 0)
res = 0;
} else {
*index = data.data.next;
*param = data.data.param;
res = 1;
}
return res;
}
#define spa_node_emit(hooks,method,version,...) \
spa_hook_list_call_simple(hooks, struct spa_node_events, \
method, version, ##__VA_ARGS__)
#define spa_node_emit_info(hooks,...) spa_node_emit(hooks,info, 0, __VA_ARGS__)
#define spa_node_emit_port_info(hooks,...) spa_node_emit(hooks,port_info, 0, __VA_ARGS__)
#define spa_node_emit_result(hooks,...) spa_node_emit(hooks,result, 0, __VA_ARGS__)
#define spa_node_emit_event(hooks,...) spa_node_emit(hooks,event, 0, __VA_ARGS__)
#define spa_node_call(callbacks,method,version,...) \
({ \
int _res = -ENOTSUP; \
spa_callbacks_call_res(callbacks, struct spa_node_callbacks, \
_res, method, version, ##__VA_ARGS__); \
_res; \
})
#define spa_node_call_ready(hook,...) spa_node_call(hook, ready, 0, __VA_ARGS__)
#define spa_node_call_reuse_buffer(hook,...) spa_node_call(hook, reuse_buffer, 0, __VA_ARGS__)
#define spa_node_call_xrun(hook,...) spa_node_call(hook, xrun, 0, __VA_ARGS__)
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* SPA_NODE_UTILS_H */
builder.h
spa/pod/builder.h
spa_hook_remove
static void spa_hook_remove(struct spa_hook *hook)
Remove a hook.
Definition: hook.h:383
spa_result_func_node_params
static void spa_result_func_node_params(void *data, int seq, int res, uint32_t type, const void *result)
Definition: utils.h:51
spa_node_enum_params_sync
static 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: utils.h:65
spa_node_add_listener
#define spa_node_add_listener(n,...)
Adds an event listener on node.
Definition: node.h:715
spa_node_port_enum_params
#define spa_node_port_enum_params(n,...)
Enumerate all possible parameters of id on port_id of node that are compatible with filter.
Definition: node.h:742
spa_node_port_enum_params_sync
static 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: utils.h:98
spa_node_enum_params
#define spa_node_enum_params(n,...)
Enumerate the parameters of a node.
Definition: node.h:724
SPA_VERSION_NODE_EVENTS
#define SPA_VERSION_NODE_EVENTS
Definition: node.h:198
spa_pod_builder_raw_padded
static int spa_pod_builder_raw_padded(struct spa_pod_builder *builder, const void *data, uint32_t size)
Definition: builder.h:178
SPA_POD_SIZE
#define SPA_POD_SIZE(pod)
Definition: pod.h:50
spa_pod_builder_deref
static struct spa_pod * spa_pod_builder_deref(struct spa_pod_builder *builder, uint32_t offset)
Definition: builder.h:113
spa_direction
spa_direction
Definition: defs.h:90
node.h
spa/node/node.h
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
spa_node_events
events from the spa_node.
Definition: node.h:196
spa_node_events::version
uint32_t version
version of this structure
Definition: node.h:199
spa_node
Definition: node.h:61
spa_pod_builder_state::offset
uint32_t offset
Definition: builder.h:53
spa_pod_builder
Definition: builder.h:73
spa_pod_builder::state
struct spa_pod_builder_state state
Definition: builder.h:77
spa_pod
Definition: pod.h:63
spa_result_node_params_data
Definition: utils.h:46
spa_result_node_params_data::data
struct spa_result_node_params data
Definition: utils.h:48
spa_result_node_params_data::builder
struct spa_pod_builder * builder
Definition: utils.h:47
spa_result_node_params
the result of enum_params or port_enum_params.
Definition: node.h:172
spa_result_node_params::param
struct spa_pod * param
the result param
Definition: node.h:176
spa_result_node_params::next
uint32_t next
next index of iteration
Definition: node.h:175
spa_result_node_params::index
uint32_t index
index of parameter
Definition: node.h:174