25#ifndef PIPEWIRE_NODE_H
26#define PIPEWIRE_NODE_H
50#define PW_TYPE_INTERFACE_Node PW_TYPE_INFO_INTERFACE_BASE "Node"
52#define PW_VERSION_NODE 3
74#define PW_NODE_CHANGE_MASK_INPUT_PORTS (1 << 0)
75#define PW_NODE_CHANGE_MASK_OUTPUT_PORTS (1 << 1)
76#define PW_NODE_CHANGE_MASK_STATE (1 << 2)
77#define PW_NODE_CHANGE_MASK_PROPS (1 << 3)
78#define PW_NODE_CHANGE_MASK_PARAMS (1 << 4)
79#define PW_NODE_CHANGE_MASK_ALL ((1 << 5)-1)
101#define PW_NODE_EVENT_INFO 0
102#define PW_NODE_EVENT_PARAM 1
103#define PW_NODE_EVENT_NUM 2
107#define PW_VERSION_NODE_EVENTS 0
126 void (*
param) (
void *object,
int seq,
127 uint32_t
id, uint32_t index, uint32_t next,
131#define PW_NODE_METHOD_ADD_LISTENER 0
132#define PW_NODE_METHOD_SUBSCRIBE_PARAMS 1
133#define PW_NODE_METHOD_ENUM_PARAMS 2
134#define PW_NODE_METHOD_SET_PARAM 3
135#define PW_NODE_METHOD_SEND_COMMAND 4
136#define PW_NODE_METHOD_NUM 5
140#define PW_VERSION_NODE_METHODS 0
171 uint32_t
start, uint32_t num,
181 int (*
set_param) (
void *object, uint32_t id, uint32_t flags,
192#define pw_node_method(o,method,version,...) \
194 int _res = -ENOTSUP; \
195 spa_interface_call_res((struct spa_interface*)o, \
196 struct pw_node_methods, _res, \
197 method, version, ##__VA_ARGS__); \
202#define pw_node_add_listener(c,...) pw_node_method(c,add_listener,0,__VA_ARGS__)
203#define pw_node_subscribe_params(c,...) pw_node_method(c,subscribe_params,0,__VA_ARGS__)
204#define pw_node_enum_params(c,...) pw_node_method(c,enum_params,0,__VA_ARGS__)
205#define pw_node_set_param(c,...) pw_node_method(c,set_param,0,__VA_ARGS__)
206#define pw_node_send_command(c,...) pw_node_method(c,send_command,0,__VA_ARGS__)
void pw_node_info_free(struct pw_node_info *info)
Definition: introspect.c:243
struct pw_node_info * pw_node_info_merge(struct pw_node_info *info, const struct pw_node_info *update, bool reset)
Definition: introspect.c:177
struct pw_node_info * pw_node_info_update(struct pw_node_info *info, const struct pw_node_info *update)
Definition: introspect.c:236
const char * pw_node_state_as_string(enum pw_node_state state)
Convert a pw_node_state to a readable string.
Definition: introspect.c:34
pw_node_state
The different node states.
Definition: src/pipewire/node.h:56
@ PW_NODE_STATE_ERROR
error state
Definition: src/pipewire/node.h:57
@ PW_NODE_STATE_SUSPENDED
the node is suspended, the device might be closed
Definition: src/pipewire/node.h:59
@ PW_NODE_STATE_IDLE
the node is running but there is no active port
Definition: src/pipewire/node.h:61
@ PW_NODE_STATE_CREATING
the node is being created
Definition: src/pipewire/node.h:58
@ PW_NODE_STATE_RUNNING
the node is running
Definition: src/pipewire/node.h:63
user data to add to an object
Definition: filter.c:75
Node events.
Definition: src/pipewire/node.h:106
void(* param)(void *object, int seq, uint32_t id, uint32_t index, uint32_t next, const struct spa_pod *param)
Notify a node param.
Definition: src/pipewire/node.h:126
uint32_t version
Definition: src/pipewire/node.h:108
void(* info)(void *object, const struct pw_node_info *info)
Notify node info.
Definition: src/pipewire/node.h:114
The node information.
Definition: src/pipewire/node.h:70
enum pw_node_state state
the current state of the node
Definition: src/pipewire/node.h:83
uint32_t max_input_ports
maximum number of inputs
Definition: src/pipewire/node.h:72
const char * error
an error reason if state is error
Definition: src/pipewire/node.h:84
uint32_t id
id of the global
Definition: src/pipewire/node.h:71
uint64_t change_mask
bitfield of changed fields since last call
Definition: src/pipewire/node.h:80
struct spa_param_info * params
parameters
Definition: src/pipewire/node.h:86
uint32_t n_output_ports
number of outputs
Definition: src/pipewire/node.h:82
struct spa_dict * props
the properties of the node
Definition: src/pipewire/node.h:85
uint32_t max_output_ports
maximum number of outputs
Definition: src/pipewire/node.h:73
uint32_t n_params
number of items in params
Definition: src/pipewire/node.h:87
uint32_t n_input_ports
number of inputs
Definition: src/pipewire/node.h:81
Node methods.
Definition: src/pipewire/node.h:139
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_node_events *events, void *data)
Definition: src/pipewire/node.h:143
int(* set_param)(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
Set a parameter on the node.
Definition: src/pipewire/node.h:181
int(* enum_params)(void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)
Enumerate node parameters.
Definition: src/pipewire/node.h:170
uint32_t version
Definition: src/pipewire/node.h:141
int(* subscribe_params)(void *object, uint32_t *ids, uint32_t n_ids)
Subscribe to parameter changes.
Definition: src/pipewire/node.h:156
int(* send_command)(void *object, const struct spa_command *command)
Send a command to the node.
Definition: src/pipewire/node.h:189
Definition: pod/command.h:44
Definition: utils/dict.h:48
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:313
information about a parameter
Definition: param.h:64