Go to the documentation of this file.
25 #ifndef PIPEWIRE_IMPL_NODE_H
26 #define PIPEWIRE_IMPL_NODE_H
47 #include <spa/node/node.h>
48 #include <spa/node/event.h>
54 #define PW_VERSION_IMPL_NODE_EVENTS 0
104 size_t user_data_size );
139 struct spa_hook *listener,
153 int seq, uint32_t param_id,
154 uint32_t index, uint32_t max,
155 const struct spa_pod *
filter,
156 int (*callback) (
void *
data,
int seq,
157 uint32_t
id, uint32_t index, uint32_t next,
158 struct spa_pod *
param),
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: mem.h:43
static uint32_t int int res
Definition: core.h:323
static uint32_t id
Definition: core.h:322
struct pw_resource * resource
Definition: impl-device.c:52
#define PW_KEY_PRIORITY_MASTER
priority to be a master
Definition: keys.h:86
int pw_impl_node_for_each_port(struct pw_impl_node *node, enum pw_direction direction, int(*callback)(void *data, struct pw_impl_port *port), void *data)
Iterate the ports in the given direction.
Definition: impl-node.c:1607
static void * pw_map_lookup(struct pw_map *map, uint32_t id)
Find an item in the map.
Definition: map.h:169
uint32_t subscribe_ids[MAX_PARAMS]
Definition: impl-device.c:57
Definition: impl-node.c:1627
void(* destroy)(void *data)
the node is destroyed
Definition: impl-node.h:58
int pw_work_queue_complete(struct pw_work_queue *queue, void *obj, uint32_t seq, int res)
Complete a work item.
Definition: work-queue.c:243
SPA_EXPORT int pw_impl_node_register(struct pw_impl_node *this, struct pw_properties *properties)
Complete initialization of the node and register.
Definition: impl-node.c:548
#define pw_log_error(...)
SPA_EXPORT int pw_impl_node_set_implementation(struct pw_impl_node *node, struct spa_node *spa_node)
Set the node implementation.
Definition: impl-node.c:1471
#define PW_KEY_MEDIA_ROLE
Role: Movie, Music, Camera, Screen, Communication, Game, Notification, DSP, Production,...
Definition: keys.h:238
SPA_EXPORT void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:367
#define PW_KEY_NODE_PAUSE_ON_IDLE
pause the node when idle
Definition: keys.h:142
#define PW_TYPE_INTERFACE_Node
Definition: node.h:42
#define PW_NODE_CHANGE_MASK_ALL
Definition: node.h:71
@ PW_MEMBLOCK_FLAG_MAP
Definition: mem.h:40
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition: map.h:76
#define PW_NODE_CHANGE_MASK_PROPS
Definition: node.h:69
Definition: impl-core.c:37
int seq
Definition: impl-device.c:61
#define PW_KEY_OBJECT_ID
a global object id
Definition: keys.h:70
#define SYNC_CHECK
Definition: impl-node.c:1258
SPA_EXPORT int pw_impl_node_set_param(struct pw_impl_node *node, uint32_t id, uint32_t flags, const struct spa_pod *param)
Definition: impl-node.c:1687
uint32_t pw_work_queue_add(struct pw_work_queue *queue, void *obj, int res, pw_work_func_t func, void *data)
Add an item to the work queue.
Definition: work-queue.c:163
SPA_EXPORT struct pw_impl_port * pw_impl_node_find_port(struct pw_impl_node *node, enum pw_direction direction, uint32_t port_id)
Find the port with direction and port_id or NULL when not found.
Definition: impl-node.c:1697
#define pw_log_trace_fp(...)
Definition: log.h:89
Global events, use pw_global_add_listener.
Definition: global.h:65
PipeWire client object class.
SPA_EXPORT void pw_impl_node_destroy(struct pw_impl_node *node)
Destroy a node.
Definition: impl-node.c:1530
#define pw_direction
Definition: port.h:47
SPA_EXPORT struct spa_node * pw_impl_node_get_implementation(struct pw_impl_node *node)
Get the node implementation.
Definition: impl-node.c:1507
void pw_resource_errorf(struct pw_resource *resource, int res, const char *error,...) SPA_PRINTF_FUNC(3
SPA_EXPORT struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool, enum pw_memblock_flags flags, uint32_t type, size_t size)
Create a new memblock.
Definition: mem.c:440
int pw_impl_port_register(struct pw_impl_port *port, struct pw_properties *properties)
Definition: impl-port.c:770
const char * pw_direction_as_string(enum pw_direction direction)
Convert a pw_direction to a readable string.
Definition: introspect.c:52
#define PW_KEY_FACTORY_ID
Factory properties.
Definition: keys.h:215
void * data
Definition: impl-node.c:1628
#define PW_KEY_MODULE_ID
module properties
Definition: keys.h:205
void pw_global_add_listener(struct pw_global *global, struct spa_hook *listener, const struct pw_global_events *events, void *data)
Add an event listener on the global.
Definition: global.c:252
static uint32_t int int const char int r
Definition: core.h:335
void(* peer_added)(void *data, struct pw_impl_node *peer)
a peer was added
Definition: impl-node.h:95
struct pw_work_queue * pw_work_queue_new(struct pw_loop *loop)
Create a new pw_work_queue.
Definition: work-queue.c:98
SPA_EXPORT const struct pw_node_info * pw_impl_node_get_info(struct pw_impl_node *node)
Get the node info.
Definition: impl-node.c:1085
A global object visible to remote clients.
int pw_impl_node_set_active(struct pw_impl_node *node, bool active)
Set a node active.
Definition: impl-node.c:1867
#define PW_VERSION_NODE_METHODS
Definition: node.h:128
uint32_t version
Definition: impl-node.h:55
#define PW_DIRECTION_INPUT
Definition: port.h:48
int pw_impl_node_set_implementation(struct pw_impl_node *node, struct spa_node *spa_node)
Set the node implementation.
Definition: impl-node.c:1471
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition: map.h:105
struct pw_impl_node * pw_context_create_node(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Create a new node.
Definition: impl-node.c:969
#define PW_KEY_PRIORITY_SESSION
priority in session manager
Definition: keys.h:85
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
#define PW_KEY_NODE_LATENCY
the requested latency of the node as a fraction.
Definition: keys.h:138
#define PW_KEY_CLIENT_ID
Client properties.
Definition: keys.h:118
@ PW_MEMBLOCK_FLAG_SEAL
Definition: mem.h:39
SPA_EXPORT const struct pw_properties * pw_impl_node_get_properties(struct pw_impl_node *node)
Get the node properties.
Definition: impl-node.c:1109
#define SYNC_START
Definition: impl-node.c:1259
#define PW_KEY_MEDIA_CATEGORY
Media Category: Playback, Capture, Duplex, Monitor.
Definition: keys.h:236
void pw_impl_node_add_listener(struct pw_impl_node *node, struct spa_hook *listener, const struct pw_impl_node_events *events, void *data)
Add an event listener.
Definition: impl-node.c:1513
SPA_EXPORT int pw_properties_setf(struct pw_properties *properties, const char *key, const char *format,...)
Set a property value by format.
Definition: properties.c:428
int pw_impl_node_register(struct pw_impl_node *node, struct pw_properties *properties)
Complete initialization of the node and register.
Definition: impl-node.c:548
void(* port_added)(void *data, struct pw_impl_port *port)
a port was added
Definition: impl-node.h:67
void(* state_request)(void *data, enum pw_node_state state)
a new state is requested on the node
Definition: impl-node.h:80
#define PW_KEY_OBJECT_PATH
unique path to construct the object
Definition: keys.h:69
@ PW_NODE_STATE_RUNNING
the node is running
Definition: node.h:55
int pw_impl_port_add(struct pw_impl_port *port, struct pw_impl_node *node)
Add a port to a node.
Definition: impl-port.c:819
#define PW_KEY_MEDIA_CLASS
class Ex: "Video/Source"
Definition: keys.h:242
SPA_EXPORT int pw_impl_node_update_properties(struct pw_impl_node *node, const struct spa_dict *dict)
Update the node properties.
Definition: impl-node.c:1131
struct spa_hook object_listener
Definition: impl-core.c:39
SPA_EXPORT void * pw_impl_node_get_user_data(struct pw_impl_node *node)
Get node user_data.
Definition: impl-node.c:1091
void(* port_info_changed)(void *data, struct pw_impl_port *port, const struct pw_port_info *info)
a port on the node changed info
Definition: impl-node.h:74
#define PW_KEY_DEVICE_ID
device properties
Definition: keys.h:167
#define pw_log_debug(...)
int(* callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param)
Definition: impl-node.c:1629
SPA_EXPORT int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition: properties.c:258
Node events, listen to them with pw_impl_node_add_listener.
Definition: impl-node.h:53
void(* info_changed)(void *data, const struct pw_node_info *info)
the node info changed
Definition: impl-node.h:72
SPA_EXPORT bool pw_impl_node_is_active(struct pw_impl_node *node)
Check if a node is active.
Definition: impl-node.c:1885
void pw_work_queue_destroy(struct pw_work_queue *queue)
Destroy a work queue.
Definition: work-queue.c:133
Node methods.
Definition: node.h:127
void * pw_resource_get_user_data(struct pw_resource *resource)
Get the user data for the resource, the size was given in pw_resource_new.
Definition: resource.c:160
@ PW_NODE_STATE_CREATING
the node is being created
Definition: node.h:50
const struct pw_node_info * pw_impl_node_get_info(struct pw_impl_node *node)
Get the node info.
Definition: impl-node.c:1085
void(* state_changed)(void *data, enum pw_node_state old, enum pw_node_state state, const char *error)
the state of the node changed
Definition: impl-node.h:82
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:87
#define PW_NODE_CHANGE_MASK_PARAMS
Definition: node.h:70
int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource)
Add a resource to a global.
Definition: global.c:227
#define PW_KEY_NODE_NAME
node name
Definition: keys.h:125
#define PW_KEY_NODE_DESCRIPTION
localized human readable node one-line description.
Definition: keys.h:127
#define SYNC_STOP
Definition: impl-node.c:1260
struct pw_context * pw_impl_node_get_context(struct pw_impl_node *node)
Get the context of this node.
Definition: impl-node.c:1097
void pw_impl_port_destroy(struct pw_impl_port *port)
Definition: impl-port.c:969
bool pw_impl_node_is_active(struct pw_impl_node *node)
Check if a node is active.
Definition: impl-node.c:1885
int end
Definition: impl-device.c:62
SPA_EXPORT int pw_impl_node_for_each_param(struct pw_impl_node *node, int seq, uint32_t param_id, uint32_t index, uint32_t max, const struct spa_pod *filter, int(*callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param), void *data)
Definition: impl-node.c:1652
#define DEFAULT_SYNC_TIMEOUT
Definition: impl-node.c:42
void pw_resource_add_object_listener(struct pw_resource *resource, struct spa_hook *listener, const void *funcs, void *data)
Set the resource implementation.
Definition: resource.c:175
@ PW_NODE_STATE_SUSPENDED
the node is suspended, the device might be closed
Definition: node.h:51
void(* active_changed)(void *data, bool active)
the node active state changed
Definition: impl-node.h:77
#define PW_KEY_MEDIA_TYPE
Media.
Definition: keys.h:234
uint32_t n_subscribe_ids
Definition: impl-device.c:58
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:66
#define pw_log_trace(...)
void(* result)(void *data, int seq, int res, uint32_t type, const void *result)
a result was received
Definition: impl-node.h:86
struct result_device_params_data data
Definition: impl-device.c:63
void(* driver_changed)(void *data, struct pw_impl_node *old, struct pw_impl_node *driver)
the driver of the node changed
Definition: impl-node.h:92
#define PW_KEY_NODE_SESSION
the session id this node is part of
Definition: keys.h:132
SPA_EXPORT const char * pw_node_state_as_string(enum pw_node_state state)
Definition: introspect.c:34
SPA_EXPORT const char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:451
int pw_impl_node_initialized(struct pw_impl_node *node)
Definition: impl-node.c:626
SPA_EXPORT int pw_impl_node_set_driver(struct pw_impl_node *node, struct pw_impl_node *driver)
Definition: impl-node.c:659
int pw_impl_node_update_properties(struct pw_impl_node *node, const struct spa_dict *dict)
Update the node properties.
Definition: impl-node.c:1131
SPA_EXPORT int pw_impl_node_initialized(struct pw_impl_node *this)
Definition: impl-node.c:626
#define PW_NODE_CHANGE_MASK_STATE
Definition: node.h:68
SPA_EXPORT struct pw_context * pw_impl_node_get_context(struct pw_impl_node *node)
Get the context of this node.
Definition: impl-node.c:1097
struct pw_resource * pw_resource_new(struct pw_impl_client *client, uint32_t id, uint32_t permissions, const char *type, uint32_t version, size_t user_data_size)
Make a new resource for client.
Definition: resource.c:43
#define PW_KEY_NODE_DRIVER
node can drive the graph
Definition: keys.h:143
SPA_EXPORT struct pw_global * pw_global_new(struct pw_context *context, const char *type, uint32_t version, struct pw_properties *properties, pw_global_bind_func_t func, void *object)
Create a new global.
Definition: global.c:67
struct pw_control this
Definition: control.c:34
A map.
Definition: map.h:50
int pw_impl_node_for_each_param(struct pw_impl_node *node, int seq, uint32_t param_id, uint32_t index, uint32_t max, const struct spa_pod *filter, int(*callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param), void *data)
Definition: impl-node.c:1652
int pw_impl_link_activate(struct pw_impl_link *this)
Definition: impl-link.c:518
struct pw_impl_port * pw_impl_node_find_port(struct pw_impl_node *node, enum pw_direction direction, uint32_t port_id)
Find the port with direction and port_id or NULL when not found.
Definition: impl-node.c:1697
#define NAME
Definition: impl-node.c:40
void(* free)(void *data)
the node is about to be freed
Definition: impl-node.h:60
int seq
Definition: impl-node.c:1632
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:95
SPA_EXPORT uint32_t pw_impl_node_get_free_port_id(struct pw_impl_node *node, enum pw_direction direction)
Get a free unused port_id from the node.
Definition: impl-node.c:1732
static uint32_t int seq
Definition: core.h:322
void(* initialized)(void *data)
the node is initialized
Definition: impl-node.h:62
#define PW_ID_ANY
Definition: core.h:49
uint32_t version
Definition: node.h:129
const struct pw_properties * pw_impl_node_get_properties(struct pw_impl_node *node)
Get the node properties.
Definition: impl-node.c:1109
SPA_EXPORT int pw_impl_node_set_active(struct pw_impl_node *node, bool active)
Set a node active.
Definition: impl-node.c:1867
SPA_EXPORT int pw_global_register(struct pw_global *global)
register a global to the context registry
Definition: global.c:128
SPA_EXPORT void pw_impl_node_add_listener(struct pw_impl_node *node, struct spa_hook *listener, const struct pw_impl_node_events *events, void *data)
Add an event listener.
Definition: impl-node.c:1513
#define pw_loop_invoke(l,...)
Definition: loop.h:57
struct pw_global * pw_impl_node_get_global(struct pw_impl_node *node)
Get the global of this node.
Definition: impl-node.c:1103
@ PW_NODE_STATE_ERROR
error state
Definition: node.h:49
void(* port_removed)(void *data, struct pw_impl_port *port)
a port was removed
Definition: impl-node.h:69
int pw_impl_link_deactivate(struct pw_impl_link *this)
Definition: impl-link.c:721
pw_node_state
Definition: node.h:48
struct spa_hook listener
Definition: impl-device.c:64
void pw_impl_port_unlink(struct pw_impl_port *port)
Definition: impl-port.c:921
void(* peer_removed)(void *data, struct pw_impl_node *peer)
a peer was removed
Definition: impl-node.h:97
@ PW_NODE_STATE_IDLE
the node is running but there is no active port
Definition: node.h:53
void pw_impl_port_update_info(struct pw_impl_port *port, const struct spa_port_info *info)
Definition: impl-port.c:587
SPA_EXPORT struct pw_global * pw_impl_node_get_global(struct pw_impl_node *node)
Get the global of this node.
Definition: impl-node.c:1103
SPA_EXPORT int pw_impl_node_for_each_port(struct pw_impl_node *node, enum pw_direction direction, int(*callback)(void *data, struct pw_impl_port *port), void *data)
Iterate the ports in the given direction.
Definition: impl-node.c:1607
#define PW_KEY_NODE_NICK
short node name
Definition: keys.h:126
uint32_t pw_impl_node_get_free_port_id(struct pw_impl_node *node, enum pw_direction direction)
Get a free unused port_id from the node.
Definition: impl-node.c:1732
The node information.
Definition: node.h:62
SPA_EXPORT int pw_impl_port_set_param(struct pw_impl_port *port, uint32_t id, uint32_t flags, const struct spa_pod *param)
Definition: impl-port.c:1134
void pw_impl_client_set_busy(struct pw_impl_client *client, bool busy)
Mark the client busy.
Definition: impl-client.c:636
#define PW_KEY_NODE_ALWAYS_PROCESS
process even when unlinked
Definition: keys.h:141
SPA_EXPORT int pw_impl_node_set_state(struct pw_impl_node *node, enum pw_node_state state)
Set the node state.
Definition: impl-node.c:1816
struct spa_node * pw_impl_node_get_implementation(struct pw_impl_node *node)
Get the node implementation.
Definition: impl-node.c:1507
void(* event)(void *data, const struct spa_event *event)
an event is emited
Definition: impl-node.h:89
struct pw_impl_port * pw_context_create_port(struct pw_context *context, enum pw_direction direction, uint32_t port_id, const struct spa_port_info *info, size_t user_data_size)
Create a new port.
Definition: impl-port.c:358
#define PW_VERSION_NODE
Definition: node.h:44
SPA_EXPORT int pw_properties_update_keys(struct pw_properties *props, const struct spa_dict *dict, const char *keys[])
Copy multiple keys from one property to another.
Definition: properties.c:215
A collection of key/value pairs.
Definition: properties.h:45
void * pw_impl_node_get_user_data(struct pw_impl_node *node)
Get node user_data.
Definition: impl-node.c:1091
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:330
void(* port_init)(void *data, struct pw_impl_port *port)
a port is being initialized on the node
Definition: impl-node.h:65
@ PW_IMPL_PORT_STATE_CONFIGURE
the port is ready for format negotiation
Definition: impl-port.h:53