5#ifndef PIPEWIRE_EXT_CLIENT_NODE_H
6#define PIPEWIRE_EXT_CLIENT_NODE_H
23#define PW_TYPE_INTERFACE_ClientNode PW_TYPE_INFO_INTERFACE_BASE "ClientNode"
30#define PW_VERSION_CLIENT_NODE 6
33#define PW_EXTENSION_MODULE_CLIENT_NODE PIPEWIRE_MODULE_PREFIX "module-client-node"
43#define PW_CLIENT_NODE_EVENT_TRANSPORT 0
44#define PW_CLIENT_NODE_EVENT_SET_PARAM 1
45#define PW_CLIENT_NODE_EVENT_SET_IO 2
46#define PW_CLIENT_NODE_EVENT_EVENT 3
47#define PW_CLIENT_NODE_EVENT_COMMAND 4
48#define PW_CLIENT_NODE_EVENT_ADD_PORT 5
49#define PW_CLIENT_NODE_EVENT_REMOVE_PORT 6
50#define PW_CLIENT_NODE_EVENT_PORT_SET_PARAM 7
51#define PW_CLIENT_NODE_EVENT_PORT_USE_BUFFERS 8
52#define PW_CLIENT_NODE_EVENT_PORT_SET_IO 9
53#define PW_CLIENT_NODE_EVENT_SET_ACTIVATION 10
54#define PW_CLIENT_NODE_EVENT_PORT_SET_MIX_INFO 11
55#define PW_CLIENT_NODE_EVENT_NUM 12
59#define PW_VERSION_CLIENT_NODE_EVENTS 1
89 uint32_t id, uint32_t flags,
102 int (*
set_io) (
void *data,
152 uint32_t id, uint32_t flags,
226#define PW_CLIENT_NODE_METHOD_ADD_LISTENER 0
227#define PW_CLIENT_NODE_METHOD_GET_NODE 1
228#define PW_CLIENT_NODE_METHOD_UPDATE 2
229#define PW_CLIENT_NODE_METHOD_PORT_UPDATE 3
230#define PW_CLIENT_NODE_METHOD_SET_ACTIVE 4
231#define PW_CLIENT_NODE_METHOD_EVENT 5
232#define PW_CLIENT_NODE_METHOD_PORT_BUFFERS 6
233#define PW_CLIENT_NODE_METHOD_NUM 7
237#define PW_VERSION_CLIENT_NODE_METHODS 0
246 struct pw_node * (*get_node) (
void *object, uint32_t
version,
size_t user_data_size);
258#define PW_CLIENT_NODE_UPDATE_PARAMS (1 << 0)
259#define PW_CLIENT_NODE_UPDATE_INFO (1 << 1)
260 uint32_t change_mask,
279#define PW_CLIENT_NODE_PORT_UPDATE_PARAMS (1 << 0)
280#define PW_CLIENT_NODE_PORT_UPDATE_INFO (1 << 1)
281 uint32_t change_mask,
307#define pw_client_node_method(o,method,version,...) \
309 int _res = -ENOTSUP; \
310 spa_interface_call_res((struct spa_interface*)o, \
311 struct pw_client_node_methods, _res, \
312 method, version, ##__VA_ARGS__); \
316#define pw_client_node_add_listener(c,...) pw_client_node_method(c,add_listener,0,__VA_ARGS__)
324 get_node, 0, version, user_data_size);
328#define pw_client_node_update(c,...) pw_client_node_method(c,update,0,__VA_ARGS__)
329#define pw_client_node_port_update(c,...) pw_client_node_method(c,port_update,0,__VA_ARGS__)
330#define pw_client_node_set_active(c,...) pw_client_node_method(c,set_active,0,__VA_ARGS__)
331#define pw_client_node_event(c,...) pw_client_node_method(c,event,0,__VA_ARGS__)
332#define pw_client_node_port_buffers(c,...) pw_client_node_method(c,port_buffers,0,__VA_ARGS__)
static struct pw_node * pw_client_node_get_node(struct pw_client_node *p, uint32_t version, size_t user_data_size)
Definition client-node.h:356
int(* update)(void *object, #define PW_CLIENT_NODE_UPDATE_PARAMS #define PW_CLIENT_NODE_UPDATE_INFO uint32_t change_mask, uint32_t n_params, const struct spa_pod **params, const struct spa_node_info *info)
Update the node ports and properties.
Definition client-node.h:288
int(* port_update)(void *object, enum spa_direction direction, uint32_t port_id, #define PW_CLIENT_NODE_PORT_UPDATE_PARAMS #define PW_CLIENT_NODE_PORT_UPDATE_INFO uint32_t change_mask, uint32_t n_params, const struct spa_pod **params, const struct spa_port_info *info)
Update a node port.
Definition client-node.h:309
#define spa_interface_call_res(iface, method_type, res, method, vers,...)
Invoke method named method in the callbacks on the given interface object.
Definition hook.h:251
spa_direction
Definition defs.h:106
information about a buffer
Definition client-node.h:44
uint32_t size
size in memory
Definition client-node.h:47
uint32_t mem_id
the memory id for the metadata
Definition client-node.h:45
uint32_t offset
offset in memory
Definition client-node.h:46
struct spa_buffer * buffer
buffer describing metadata and buffer memory
Definition client-node.h:48
Client Node events
Definition client-node.h:79
int(* port_set_io)(void *data, enum spa_direction direction, uint32_t port_id, uint32_t mix_id, uint32_t id, uint32_t mem_id, uint32_t offset, uint32_t size)
Configure the io area with id of port_id.
Definition client-node.h:203
int(* port_use_buffers)(void *data, enum spa_direction direction, uint32_t port_id, uint32_t mix_id, uint32_t flags, uint32_t n_buffers, struct pw_client_node_buffer *buffers)
Notify the port of buffers.
Definition client-node.h:185
int(* remove_port)(void *data, enum spa_direction direction, uint32_t port_id)
A port was removed from the node.
Definition client-node.h:159
uint32_t version
Definition client-node.h:82
int(* port_set_param)(void *data, enum spa_direction direction, uint32_t port_id, uint32_t id, uint32_t flags, const struct spa_pod *param)
A parameter was configured on the port.
Definition client-node.h:171
int(* event)(void *data, const struct spa_event *event)
Receive an event from the client node.
Definition client-node.h:132
int(* set_activation)(void *data, uint32_t node_id, int signalfd, uint32_t mem_id, uint32_t offset, uint32_t size)
Notify the activation record of the next node to trigger.
Definition client-node.h:222
int(* port_set_mix_info)(void *data, enum spa_direction direction, uint32_t port_id, uint32_t mix_id, uint32_t peer_id, const struct spa_dict *props)
Notify about the peer of mix_id.
Definition client-node.h:240
int(* command)(void *data, const struct spa_command *command)
Notify of a new node command.
Definition client-node.h:138
int(* set_io)(void *data, uint32_t id, uint32_t mem_id, uint32_t offset, uint32_t size)
Configure an IO area for the client.
Definition client-node.h:124
int(* add_port)(void *data, enum spa_direction direction, uint32_t port_id, const struct spa_dict *props)
A new port was added to the node.
Definition client-node.h:149
int(* set_param)(void *data, uint32_t id, uint32_t flags, const struct spa_pod *param)
Notify of a property change.
Definition client-node.h:110
int(* transport)(void *data, int readfd, int writefd, uint32_t mem_id, uint32_t offset, uint32_t size)
Notify of a new transport area.
Definition client-node.h:94
Client Node methods
Definition client-node.h:266
int(* event)(void *object, const struct spa_event *event)
Send an event to the node.
Definition client-node.h:328
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_client_node_events *events, void *data)
Definition client-node.h:271
int(* port_buffers)(void *object, enum spa_direction direction, uint32_t port_id, uint32_t mix_id, uint32_t n_buffers, struct spa_buffer **buffers)
Send allocated buffers.
Definition client-node.h:333
uint32_t version
Definition client-node.h:269
int(* set_active)(void *object, bool active)
Activate or deactivate the node.
Definition client-node.h:323
A Buffer.
Definition buffer.h:100
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350
Node information structure.
Definition node.h:48
Port information structure.
Definition node.h:93