PipeWire  0.2.7
node.h
Go to the documentation of this file.
1 /* PipeWire
2  * Copyright (C) 2015 Wim Taymans <wim.taymans@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 
20 #ifndef __PIPEWIRE_NODE_H__
21 #define __PIPEWIRE_NODE_H__
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 #define PW_TYPE__Node PW_TYPE_OBJECT_BASE "Node"
28 #define PW_TYPE_NODE_BASE PW_TYPE__Node ":"
29 
42 struct pw_node;
43 
44 #include <pipewire/core.h>
45 #include <pipewire/global.h>
46 #include <pipewire/introspect.h>
47 #include <pipewire/port.h>
48 #include <pipewire/resource.h>
49 
52 #define PW_VERSION_NODE_EVENTS 0
53  uint32_t version;
54 
56  void (*destroy) (void *data);
58  void (*free) (void *data);
60  void (*initialized) (void *data);
61 
63  void (*port_added) (void *data, struct pw_port *port);
65  void (*port_removed) (void *data, struct pw_port *port);
66 
68  void (*info_changed) (void *data, struct pw_node_info *info);
70  void (*active_changed) (void *data, bool active);
72  void (*enabled_changed) (void *data, bool enabled);
73 
75  void (*state_request) (void *data, enum pw_node_state state);
77  void (*state_changed) (void *data, enum pw_node_state old,
78  enum pw_node_state state, const char *error);
79 
81  void (*async_complete) (void *data, uint32_t seq, int res);
82 
84  void (*event) (void *data, const struct spa_event *event);
85 
87  void (*need_input) (void *data);
89  void (*have_output) (void *data);
91  void (*reuse_buffer) (void *data, uint32_t port_id, uint32_t buffer_id);
92 };
93 
95 #define PW_NODE_PROP_MEDIA "pipewire.media"
96 
97 #define PW_NODE_PROP_CATEGORY "pipewire.category"
98 
100 #define PW_NODE_PROP_ROLE "pipewire.role"
101 
102 #define PW_NODE_PROP_EXCLUSIVE "pipewire.exclusive"
103 
104 #define PW_NODE_PROP_AUTOCONNECT "pipewire.autoconnect"
105 
106 #define PW_NODE_PROP_TARGET_NODE "pipewire.target.node"
107 
109 struct pw_node *
110 pw_node_new(struct pw_core *core,
111  const char *name,
112  struct pw_properties *properties,
113  size_t user_data_size );
114 
116 int pw_node_register(struct pw_node *node,
117  struct pw_client *owner,
118  struct pw_global *parent,
119  struct pw_properties *properties );
120 
122 void pw_node_destroy(struct pw_node *node);
123 
125 const struct pw_node_info *pw_node_get_info(struct pw_node *node);
126 
128 void * pw_node_get_user_data(struct pw_node *node);
129 
131 struct pw_core *pw_node_get_core(struct pw_node *node);
132 
134 struct pw_global *pw_node_get_global(struct pw_node *node);
135 
137 const struct pw_properties *pw_node_get_properties(struct pw_node *node);
138 
140 int pw_node_update_properties(struct pw_node *node, const struct spa_dict *dict);
141 
143 void pw_node_set_implementation(struct pw_node *node, struct spa_node *spa_node);
145 struct spa_node *pw_node_get_implementation(struct pw_node *node);
146 
148 void pw_node_add_listener(struct pw_node *node,
149  struct spa_hook *listener,
150  const struct pw_node_events *events,
151  void *data);
152 
157 int pw_node_for_each_port(struct pw_node *node,
158  enum pw_direction direction,
159  int (*callback) (void *data, struct pw_port *port),
160  void *data);
161 
162 int pw_node_for_each_param(struct pw_node *node,
163  uint32_t param_id,
164  uint32_t index, uint32_t max,
165  const struct spa_pod *filter,
166  int (*callback) (void *data,
167  uint32_t id, uint32_t index, uint32_t next,
168  struct spa_pod *param),
169  void *data);
170 
172 struct pw_port *
173 pw_node_find_port(struct pw_node *node, enum pw_direction direction, uint32_t port_id);
174 
176 uint32_t pw_node_get_free_port_id(struct pw_node *node, enum pw_direction direction);
177 
180 struct pw_port * pw_node_get_free_port(struct pw_node *node, enum pw_direction direction);
181 
184 int pw_node_set_active(struct pw_node *node, bool active);
185 
187 bool pw_node_is_active(struct pw_node *node);
188 
190 int pw_node_set_enabled(struct pw_node *node, bool enabled);
191 
193 bool pw_node_is_enabled(struct pw_node *node);
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 
199 #endif /* __PIPEWIRE_NODE_H__ */
pw_work_queue
pw_global::pw_global_register
SPA_EXPORT int pw_global_register(struct pw_global *global, struct pw_client *owner, struct pw_global *parent)
register a global to the core registry
Definition: global.c:102
global.h
PW_VERSION_NODE
#define PW_VERSION_NODE
Definition: interfaces.h:487
PW_NODE_STATE_CREATING
@ PW_NODE_STATE_CREATING
the node is being created
Definition: introspect.h:35
data-loop.h
pw_map::pw_map_lookup
static void * pw_map_lookup(struct pw_map *map, uint32_t id)
Find an item in the map.
Definition: map.h:152
port.h
pw_work_queue::pw_work_queue_complete
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:220
introspect.h
pw_node_get_properties
const struct pw_properties * pw_node_get_properties(struct pw_node *node)
Get the node properties.
Definition: node.c:481
pw_node_events::port_removed
void(* port_removed)(void *data, struct pw_port *port)
a port was removed
Definition: node.h:65
PW_DIRECTION_OUTPUT
@ PW_DIRECTION_OUTPUT
an output port direction
Definition: introspect.h:49
pw_node_get_free_port_id
uint32_t pw_node_get_free_port_id(struct pw_node *node, enum pw_direction direction)
Get a free unused port_id from the node.
Definition: node.c:742
pw_global::pw_global_destroy
SPA_EXPORT void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:241
pw_map::pw_map_init
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition: map.h:70
pw_node
resource_data
Definition: factory.c:26
pw_client
PipeWire client object class.
pw_node_add_listener
void pw_node_add_listener(struct pw_node *node, struct spa_hook *listener, const struct pw_node_events *events, void *data)
Add an event listener.
Definition: node.c:596
PW_DIRECTION_INPUT
@ PW_DIRECTION_INPUT
an input port direction
Definition: introspect.h:48
interfaces.h
resource_data::resource_listener
struct spa_hook resource_listener
Definition: factory.c:27
pw_work_queue::pw_work_queue_add
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:140
pw_node::pw_node_destroy
SPA_EXPORT void pw_node_destroy(struct pw_node *node)
Destroy a node.
Definition: node.c:626
pw_node_get_implementation
struct spa_node * pw_node_get_implementation(struct pw_node *node)
Get the node implementation.
Definition: node.c:590
pw_node_get_user_data
SPA_EXPORT void * pw_node_get_user_data(struct pw_node *node)
Get node user_data.
Definition: node.c:463
PW_NODE_STATE_IDLE
@ PW_NODE_STATE_IDLE
the node is running but there is no active port
Definition: introspect.h:38
pw_node_set_enabled
int pw_node_set_enabled(struct pw_node *node, bool enabled)
Set a node enabled.
Definition: node.c:988
PW_NODE_CHANGE_MASK_PROPS
#define PW_NODE_CHANGE_MASK_PROPS
Definition: introspect.h:148
pw_node_update_properties
SPA_EXPORT int pw_node_update_properties(struct pw_node *node, const struct spa_dict *dict)
Update the node properties.
Definition: node.c:487
pw_global_events
Global events, use pw_global_add_listener.
Definition: global.h:59
pw_resource_set_implementation
void pw_resource_set_implementation(struct pw_resource *resource, const void *implementation, void *data)
Set the resource implementation.
Definition: resource.c:128
pw_node_get_core
SPA_EXPORT struct pw_core * pw_node_get_core(struct pw_node *node)
Get the core of this node.
Definition: node.c:469
pw_introspect::pw_direction_as_string
const char * pw_direction_as_string(enum pw_direction direction)
Convert a pw_direction to a readable string.
Definition: introspect.c:45
pw_node_events::info_changed
void(* info_changed)(void *data, struct pw_node_info *info)
the node info changed
Definition: node.h:68
impl
Definition: control.c:25
pw_node_events::initialized
void(* initialized)(void *data)
the node is initialized
Definition: node.h:60
pw_map_get_size
#define pw_map_get_size(m)
Definition: map.h:51
pw_global_add_listener
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:190
pw_direction
pw_direction
Definition: introspect.h:47
work-queue.h
pw_work_queue::pw_work_queue_new
struct pw_work_queue * pw_work_queue_new(struct pw_loop *loop)
Create a new pw_work_queue.
Definition: work-queue.c:88
pw_global
A global object visible to remote clients.
pw_map::pw_map_insert_new
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition: map.h:92
pw_properties::dict
struct spa_dict dict
Definition: properties.h:39
pw_node_for_each_param
SPA_EXPORT int pw_node_for_each_param(struct pw_node *node, uint32_t param_id, uint32_t index, uint32_t max, const struct spa_pod *filter, int(*callback)(void *data, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param), void *data)
Definition: node.c:696
PW_NODE_STATE_RUNNING
@ PW_NODE_STATE_RUNNING
the node is running
Definition: introspect.h:40
pw_node_events::event
void(* event)(void *data, const struct spa_event *event)
an event is emited
Definition: node.h:84
pw_node_get_global
struct pw_global * pw_node_get_global(struct pw_node *node)
Get the global of this node.
Definition: node.c:475
pw_node_is_enabled
bool pw_node_is_enabled(struct pw_node *node)
Check if a node is enabled.
Definition: node.c:1009
pw_global::pw_global_new
SPA_EXPORT struct pw_global * pw_global_new(struct pw_core *core, uint32_t type, uint32_t version, struct pw_properties *properties, void *object)
Create a new global.
Definition: global.c:61
pw_node::pw_node_set_state
SPA_EXPORT int pw_node_set_state(struct pw_node *node, enum pw_node_state state)
Set th node state.
Definition: node.c:876
pw_port_register
int pw_port_register(struct pw_port *port, struct pw_client *owner, struct pw_global *parent, struct pw_properties *properties)
Definition: port.c:402
pw_node_set_active
int pw_node_set_active(struct pw_node *node, bool active)
Set a node active.
Definition: node.c:963
pw_node_is_active
bool pw_node_is_active(struct pw_node *node)
Check if a node is active.
Definition: node.c:982
pw_node_get_global
SPA_EXPORT struct pw_global * pw_node_get_global(struct pw_node *node)
Get the global of this node.
Definition: node.c:475
pw_log::pw_log_trace
void pw_log_trace(const char *format,...)
pw_port
pw_node::pw_node_state_as_string
const char * pw_node_state_as_string(enum pw_node_state state)
Convert a pw_node_state to a readable string.
Definition: introspect.c:27
pw_resource_new
struct pw_resource * pw_resource_new(struct pw_client *client, uint32_t id, uint32_t permissions, uint32_t type, uint32_t version, size_t user_data_size)
Make a new resource for client.
Definition: resource.c:34
pw_node_get_user_data
void * pw_node_get_user_data(struct pw_node *node)
Get node user_data.
Definition: node.c:463
node.h
pw_node_events::active_changed
void(* active_changed)(void *data, bool active)
the node active state changed
Definition: node.h:70
pw_node_get_info
const struct pw_node_info * pw_node_get_info(struct pw_node *node)
Get the node info.
Definition: node.c:457
pw_node_register
SPA_EXPORT int pw_node_register(struct pw_node *this, struct pw_client *owner, struct pw_global *parent, struct pw_properties *properties)
Complete initialization of the node and register.
Definition: node.c:329
pw_node_is_active
SPA_EXPORT bool pw_node_is_active(struct pw_node *node)
Check if a node is active.
Definition: node.c:982
PW_VERSION_RESOURCE_EVENTS
#define PW_VERSION_RESOURCE_EVENTS
Definition: resource.h:63
resource.h
pw_node_get_free_port_id
uint32_t pw_node_get_free_port_id(struct pw_node *node, enum pw_direction direction)
Get a free unused port_id from the node.
Definition: node.c:742
pw_node_for_each_port
int pw_node_for_each_port(struct pw_node *node, enum pw_direction direction, int(*callback)(void *data, struct pw_port *port), void *data)
Iterate the ports in the given direction.
Definition: node.c:675
pw_node_events::need_input
void(* need_input)(void *data)
the node wants input
Definition: node.h:87
pw_port_set_param
int pw_port_set_param(struct pw_port *port, uint32_t id, uint32_t flags, const struct spa_pod *param)
Definition: port.c:671
pw_node_is_enabled
SPA_EXPORT bool pw_node_is_enabled(struct pw_node *node)
Check if a node is enabled.
Definition: node.c:1009
pw_work_queue::pw_work_queue_destroy
void pw_work_queue_destroy(struct pw_work_queue *queue)
Destroy a work queue.
Definition: work-queue.c:110
pw_resource_get_user_data
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:113
PW_NODE_CHANGE_MASK_OUTPUT_PORTS
#define PW_NODE_CHANGE_MASK_OUTPUT_PORTS
Definition: introspect.h:146
PW_VERSION_NODE_PROXY_METHODS
#define PW_VERSION_NODE_PROXY_METHODS
Definition: interfaces.h:535
pw_node_update_properties
int pw_node_update_properties(struct pw_node *node, const struct spa_dict *dict)
Update the node properties.
Definition: node.c:487
pw_map::pw_map_clear
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:81
pw_node_events
Node events, listen to them with pw_node_add_listener.
Definition: node.h:51
pw_properties::pw_properties_get
const SPA_EXPORT char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:361
pw_node_for_each_param
int pw_node_for_each_param(struct pw_node *node, uint32_t param_id, uint32_t index, uint32_t max, const struct spa_pod *filter, int(*callback)(void *data, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param), void *data)
Definition: node.c:696
pw_port_destroy
void pw_port_destroy(struct pw_port *port)
Definition: port.c:546
pw_node_events::async_complete
void(* async_complete)(void *data, uint32_t seq, int res)
an async operation completed on the node
Definition: node.h:81
pw_node_events::have_output
void(* have_output)(void *data)
the node has output
Definition: node.h:89
pw_node_get_core
struct pw_core * pw_node_get_core(struct pw_node *node)
Get the core of this node.
Definition: node.c:469
pw_node_events::free
void(* free)(void *data)
the node is about to be freed
Definition: node.h:58
pw_properties::pw_properties_copy
SPA_EXPORT struct pw_properties * pw_properties_copy(const struct pw_properties *properties)
Copy a properties object.
Definition: properties.c:183
pw_properties::pw_properties_set
SPA_EXPORT int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:308
pw_node::pw_node_get_free_port
struct pw_port * pw_node_get_free_port(struct pw_node *node, enum pw_direction direction)
pw_node_get_free_port:
Definition: node.c:760
pw_core
the core PipeWire object
pw_resource
Client owned objects.
pw_resource_destroy
void pw_resource_destroy(struct pw_resource *resource)
Destroy a resource.
Definition: resource.c:169
pw_node_events::port_added
void(* port_added)(void *data, struct pw_port *port)
a port was added
Definition: node.h:63
pw_port_add
int pw_port_add(struct pw_port *port, struct pw_node *node)
Definition: port.c:422
PW_VERSION_GLOBAL_EVENTS
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:60
main-loop.h
pw_node_proxy_methods::version
uint32_t version
Definition: interfaces.h:536
pw_work_func_t
void(* pw_work_func_t)(void *obj, void *data, int res, uint32_t id)
Definition: work-queue.h:35
pw_port_new
struct pw_port * pw_port_new(enum pw_direction direction, uint32_t port_id, struct pw_properties *properties, size_t user_data_size)
Definition: port.c:163
pw_node_register
int pw_node_register(struct pw_node *node, struct pw_client *owner, struct pw_global *parent, struct pw_properties *properties)
Complete initialization of the node and register.
Definition: node.c:329
pw_node_events::enabled_changed
void(* enabled_changed)(void *data, bool enabled)
the node enabled state changed
Definition: node.h:72
pw_node_for_each_port
int pw_node_for_each_port(struct pw_node *node, enum pw_direction direction, int(*callback)(void *data, struct pw_port *port), void *data)
Iterate the ports in the given direction.
Definition: node.c:675
pw_node_add_listener
SPA_EXPORT void pw_node_add_listener(struct pw_node *node, struct spa_hook *listener, const struct pw_node_events *events, void *data)
Add an event listener.
Definition: node.c:596
pw_node_update_ports
int pw_node_update_ports(struct pw_node *node)
Definition: node.c:191
core.h
pw_node_info::state
enum pw_node_state state
the current state of the node
Definition: introspect.h:156
pw_node_events::version
uint32_t version
Definition: node.h:53
pw_core_resource_error
#define pw_core_resource_error(r,...)
Definition: interfaces.h:338
impl::this
struct pw_control this
Definition: control.c:26
pw_map
A map.
Definition: map.h:44
pw_node_find_port
struct pw_port * pw_node_find_port(struct pw_node *node, enum pw_direction direction, uint32_t port_id)
Find the port with direction and port_id or NULL when not found.
Definition: node.c:730
PW_NODE_CHANGE_MASK_INPUT_PORTS
#define PW_NODE_CHANGE_MASK_INPUT_PORTS
Definition: introspect.h:145
pw_properties::pw_properties_new
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:89
pw_node_get_properties
SPA_EXPORT const struct pw_properties * pw_node_get_properties(struct pw_node *node)
Get the node properties.
Definition: node.c:481
pw_log::pw_log_error
void pw_log_error(const char *format,...)
pw_node_find_port
struct pw_port * pw_node_find_port(struct pw_node *node, enum pw_direction direction, uint32_t port_id)
Find the port with direction and port_id or NULL when not found.
Definition: node.c:730
pw_node_set_implementation
SPA_EXPORT void pw_node_set_implementation(struct pw_node *node, struct spa_node *spa_node)
Set the node implementation.
Definition: node.c:578
pw_node::pw_node_update_state
void pw_node_update_state(struct pw_node *node, enum pw_node_state state, char *error)
Update the node state.
Definition: node.c:928
pipewire.h
pw_node_info::error
const char * error
an error reason if state is error
Definition: introspect.h:157
pw_port_unlink
void pw_port_unlink(struct pw_port *port)
Definition: port.c:491
pw_loop_invoke
#define pw_loop_invoke(l,...)
Definition: loop.h:52
PW_NODE_CHANGE_MASK_STATE
#define PW_NODE_CHANGE_MASK_STATE
Definition: introspect.h:147
pw_node_get_info
SPA_EXPORT const struct pw_node_info * pw_node_get_info(struct pw_node *node)
Get the node info.
Definition: node.c:457
pw_node_events::state_changed
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: node.h:77
pw_node_events::state_request
void(* state_request)(void *data, enum pw_node_state state)
a new state is requested on the node
Definition: node.h:75
pw_node_set_enabled
SPA_EXPORT int pw_node_set_enabled(struct pw_node *node, bool enabled)
Set a node enabled.
Definition: node.c:988
pw_resource_events
Resource events.
Definition: resource.h:62
pw_node_state
pw_node_state
Definition: introspect.h:33
pw_node_events::destroy
void(* destroy)(void *data)
the node is destroyed
Definition: node.h:56
PW_NODE_STATE_ERROR
@ PW_NODE_STATE_ERROR
error state
Definition: introspect.h:34
pw_node_set_implementation
void pw_node_set_implementation(struct pw_node *node, struct spa_node *spa_node)
Set the node implementation.
Definition: node.c:578
pw_node_info
The node information.
Definition: introspect.h:142
pw_resource_add_listener
void pw_resource_add_listener(struct pw_resource *resource, struct spa_hook *listener, const struct pw_resource_events *events, void *data)
Add an event listener.
Definition: resource.c:119
pw_node::pw_node_new
struct pw_node * pw_node_new(struct pw_core *core, const char *name, struct pw_properties *properties, size_t user_data_size)
Create a new node.
Definition: node.c:399
pw_node_set_active
SPA_EXPORT int pw_node_set_active(struct pw_node *node, bool active)
Set a node active.
Definition: node.c:963
pw_node_proxy_methods
Node methods.
Definition: interfaces.h:534
pw_log::pw_log_warn
void pw_log_warn(const char *format,...)
pw_log::pw_log_debug
void pw_log_debug(const char *format,...)
pw_node_resource_param
#define pw_node_resource_param(r,...)
Definition: interfaces.h:528
PW_NODE_STATE_SUSPENDED
@ PW_NODE_STATE_SUSPENDED
the node is suspended, the device might be closed
Definition: introspect.h:36
PW_PORT_STATE_CONFIGURE
@ PW_PORT_STATE_CONFIGURE
the port is ready for format negotiation
Definition: port.h:53
pw_node_events::reuse_buffer
void(* reuse_buffer)(void *data, uint32_t port_id, uint32_t buffer_id)
the node has a buffer to reuse
Definition: node.h:91
pw_node_get_implementation
SPA_EXPORT struct spa_node * pw_node_get_implementation(struct pw_node *node)
Get the node implementation.
Definition: node.c:590
pw_properties
A collection of key/value pairs.
Definition: properties.h:38
pw_properties::pw_properties_free
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:245
pw_node_resource_info
#define pw_node_resource_info(r,...)
Definition: interfaces.h:527