25 #ifndef PIPEWIRE_EXT_CLIENT_NODE_H 26 #define PIPEWIRE_EXT_CLIENT_NODE_H 43 #define PW_TYPE_INTERFACE_ClientNode PW_TYPE_INFO_INTERFACE_BASE "ClientNode" 45 #define PW_VERSION_CLIENT_NODE 4 48 #define PW_EXTENSION_MODULE_CLIENT_NODE PIPEWIRE_MODULE_PREFIX "module-client-node" 58 #define PW_CLIENT_NODE_EVENT_TRANSPORT 0 59 #define PW_CLIENT_NODE_EVENT_SET_PARAM 1 60 #define PW_CLIENT_NODE_EVENT_SET_IO 2 61 #define PW_CLIENT_NODE_EVENT_EVENT 3 62 #define PW_CLIENT_NODE_EVENT_COMMAND 4 63 #define PW_CLIENT_NODE_EVENT_ADD_PORT 5 64 #define PW_CLIENT_NODE_EVENT_REMOVE_PORT 6 65 #define PW_CLIENT_NODE_EVENT_PORT_SET_PARAM 7 66 #define PW_CLIENT_NODE_EVENT_PORT_USE_BUFFERS 8 67 #define PW_CLIENT_NODE_EVENT_PORT_SET_IO 9 68 #define PW_CLIENT_NODE_EVENT_SET_ACTIVATION 10 69 #define PW_CLIENT_NODE_EVENT_PORT_SET_MIX_INFO 11 70 #define PW_CLIENT_NODE_EVENT_NUM 12 74 #define PW_VERSION_CLIENT_NODE_EVENTS 1 104 uint32_t id, uint32_t flags,
117 int (*
set_io) (
void *object,
167 uint32_t id, uint32_t
flags,
241 #define PW_CLIENT_NODE_METHOD_ADD_LISTENER 0 242 #define PW_CLIENT_NODE_METHOD_GET_NODE 1 243 #define PW_CLIENT_NODE_METHOD_UPDATE 2 244 #define PW_CLIENT_NODE_METHOD_PORT_UPDATE 3 245 #define PW_CLIENT_NODE_METHOD_SET_ACTIVE 4 246 #define PW_CLIENT_NODE_METHOD_EVENT 5 247 #define PW_CLIENT_NODE_METHOD_PORT_BUFFERS 6 248 #define PW_CLIENT_NODE_METHOD_NUM 7 252 #define PW_VERSION_CLIENT_NODE_METHODS 0 261 struct pw_node * (*get_node) (
void *object, uint32_t
version,
size_t user_data_size);
273 #define PW_CLIENT_NODE_UPDATE_PARAMS (1 << 0) 274 #define PW_CLIENT_NODE_UPDATE_INFO (1 << 1) 275 uint32_t change_mask,
294 #define PW_CLIENT_NODE_PORT_UPDATE_PARAMS (1 << 0) 295 #define PW_CLIENT_NODE_PORT_UPDATE_INFO (1 << 1) 322 #define pw_client_node_method(o,method,version,...) \ 324 int _res = -ENOTSUP; \ 325 spa_interface_call_res((struct spa_interface*)o, \ 326 struct pw_client_node_methods, _res, \ 327 method, version, ##__VA_ARGS__); \ 331 #define pw_client_node_add_listener(c,...) pw_client_node_method(c,add_listener,0,__VA_ARGS__) 339 get_node, 0, version, user_data_size);
343 #define pw_client_node_update(c,...) pw_client_node_method(c,update,0,__VA_ARGS__) 344 #define pw_client_node_port_update(c,...) pw_client_node_method(c,port_update,0,__VA_ARGS__) 345 #define pw_client_node_set_active(c,...) pw_client_node_method(c,set_active,0,__VA_ARGS__) 346 #define pw_client_node_event(c,...) pw_client_node_method(c,event,0,__VA_ARGS__) 347 #define pw_client_node_port_buffers(c,...) pw_client_node_method(c,port_buffers,0,__VA_ARGS__) #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:255
int(* set_io)(void *object, uint32_t id, uint32_t mem_id, uint32_t offset, uint32_t size)
Configure an IO area for the client.
Definition: client-node.h:139
int(* set_active)(void *object, bool active)
Activate or deactivate the node.
Definition: client-node.h:338
int(* transport)(void *object, int readfd, int writefd, uint32_t mem_id, uint32_t offset, uint32_t size)
Notify of a new transport area.
Definition: client-node.h:109
Node information structure.
Definition: node.h:68
int(* remove_port)(void *object, enum spa_direction direction, uint32_t port_id)
A port was removed from the node.
Definition: client-node.h:174
uint32_t n_params
number of items in params
Definition: node.h:108
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
uint32_t flags
Definition: dict.h:62
uint32_t version
Definition: client-node.h:284
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:348
Client Node events
Definition: client-node.h:94
int(* port_set_param)(void *object, 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:186
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:375
int(* event)(void *object, const struct spa_event *event)
Receive an event from the client node.
Definition: client-node.h:147
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:324
Port information structure.
Definition: node.h:119
int(* set_activation)(void *object, 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:237
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:303
A Buffer.
Definition: buffer.h:105
uint64_t change_mask
Definition: node.h:77
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_client_node_events *events, void *data)
Definition: client-node.h:286
information about a buffer
Definition: client-node.h:59
uint32_t offset
offset in memory
Definition: client-node.h:61
int(* command)(void *object, const struct spa_command *command)
Notify of a new node command.
Definition: client-node.h:153
int(* port_set_io)(void *object, 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:218
int(* port_set_mix_info)(void *object, 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:255
int(* set_param)(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
Notify of a property change.
Definition: client-node.h:125
uint32_t size
Definition: pod.h:64
int(* port_use_buffers)(void *object, 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:200
uint32_t version
Definition: client-node.h:97
spa_direction
Definition: defs.h:90
int(* event)(void *object, const struct spa_event *event)
Send an event to the node.
Definition: client-node.h:343
struct spa_buffer * buffer
buffer describing metadata and buffer memory
Definition: client-node.h:63
uint32_t size
size in memory
Definition: client-node.h:62
int(* add_port)(void *object, 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:164
Client Node methods
Definition: client-node.h:281
uint32_t mem_id
the memory id for the metadata
Definition: client-node.h:60