Go to the documentation of this file.
25 #ifndef PIPEWIRE_IMPL_LINK_H
26 #define PIPEWIRE_IMPL_LINK_H
54 #define PW_VERSION_IMPL_LINK_EVENTS 0
85 struct spa_pod *format_filter,
87 size_t user_data_size );
94 struct spa_hook *listener,
@ PW_IMPL_PORT_STATE_READY
the port is ready for buffer allocation
Definition: impl-port.h:54
static uint32_t int int res
Definition: core.h:326
#define PW_LINK_CHANGE_MASK_STATE
Definition: link.h:62
pw_impl_port_state
Definition: impl-port.h:50
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:249
#define pw_log_error(...)
SPA_EXPORT void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:377
#define PW_KEY_OBJECT_ID
a global object id
Definition: keys.h:60
#define PW_KEY_LINK_INPUT_PORT
input port id of a link
Definition: keys.h:162
#define PW_LINK_CHANGE_MASK_ALL
Definition: link.h:65
SPA_EXPORT struct pw_context * pw_impl_link_get_context(struct pw_impl_link *link)
Get the context of a link.
Definition: impl-link.c:1320
void(* initialized)(void *data)
a Link is initialized
Definition: impl-link.h:64
SPA_EXPORT int pw_impl_port_use_buffers(struct pw_impl_port *port, struct pw_impl_port_mix *mix, uint32_t flags, struct spa_buffer **buffers, uint32_t n_buffers)
Definition: impl-port.c:1271
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:164
link events added with pw_impl_link_add_listener
Definition: impl-link.h:53
void pw_impl_link_add_listener(struct pw_impl_link *link, struct spa_hook *listener, const struct pw_impl_link_events *events, void *data)
Add an event listener to link.
Definition: impl-link.c:1299
const char * error
an error reason if state is error
Definition: link.h:68
Port events, use pw_impl_port_add_listener.
Definition: impl-port.h:59
Global events, use pw_global_add_listener.
Definition: global.h:65
PipeWire client object class.
void(* free)(void *data)
A link is freed.
Definition: impl-link.h:61
const char * pw_direction_as_string(enum pw_direction direction)
Convert a pw_direction to a readable string.
Definition: introspect.c:52
#define pw_link_resource_info(r,...)
Definition: impl-link.c:44
const SPA_EXPORT char * pw_link_state_as_string(enum pw_link_state state)
Definition: introspect.c:66
int pw_buffers_negotiate(struct pw_context *context, uint32_t flags, struct spa_node *outnode, uint32_t out_port_id, struct spa_node *innode, uint32_t in_port_id, struct pw_buffers *result)
Definition: buffers.c:237
#define PW_KEY_FACTORY_ID
Factory properties.
Definition: keys.h:217
uint32_t pw_global_get_permissions(struct pw_global *global, struct pw_impl_client *client)
Get the permissions of the global for a given client.
Definition: global.c:45
#define PW_KEY_MODULE_ID
module properties
Definition: keys.h:207
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:262
int pw_impl_link_register(struct pw_impl_link *link, struct pw_properties *properties)
Finish link configuration and register.
Definition: impl-link.c:1192
void(* port_unlinked)(void *data, struct pw_impl_port *port)
A port is unlinked.
Definition: impl-link.h:75
struct pw_global * pw_impl_link_get_global(struct pw_impl_link *link)
Get the global of the link.
Definition: impl-link.c:1338
struct pw_work_queue * pw_work_queue_new(struct pw_loop *loop)
Create a new pw_work_queue.
Definition: work-queue.c:99
@ PW_IMPL_PORT_STATE_INIT
the port is being created
Definition: impl-port.h:52
A global object visible to remote clients.
SPA_EXPORT const struct pw_link_info * pw_impl_link_get_info(struct pw_impl_link *link)
Get the link info.
Definition: impl-link.c:1332
#define PW_DIRECTION_INPUT
Definition: port.h:48
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
#define PW_VERSION_IMPL_PORT_EVENTS
Definition: impl-port.h:60
#define PW_KEY_CLIENT_ID
Client properties.
Definition: keys.h:117
uint32_t version
Definition: impl-link.h:55
void pw_impl_link_destroy(struct pw_impl_link *link)
Destroy a link.
Definition: impl-link.c:1256
struct pw_port * port
Definition: filter.c:92
void pw_resource_error(struct pw_resource *resource, int res, const char *error)
Generate an error for a resource.
Definition: resource.c:255
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:1610
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:433
pw_link_state
Definition: link.h:43
#define NAME
Definition: impl-link.c:42
#define PW_KEY_OBJECT_PATH
unique path to construct the object
Definition: keys.h:59
struct pw_context * pw_impl_link_get_context(struct pw_impl_link *link)
Get the context of a link.
Definition: impl-link.c:1320
void(* destroy)(void *data)
A link is destroyed.
Definition: impl-link.h:58
enum pw_link_state state
the current state of the link
Definition: link.h:67
#define PW_VERSION_IMPL_NODE_EVENTS
Definition: impl-node.h:54
int pw_global_update_keys(struct pw_global *global, const struct spa_dict *dict, const char *keys[])
Update the global properties, must be done when unregistered.
Definition: global.c:215
#define pw_log_debug(...)
void * pw_impl_link_get_user_data(struct pw_impl_link *link)
Get the user_data of a link, the size of the memory is given when constructing the link.
Definition: impl-link.c:1326
#define PW_BUFFERS_FLAG_SHARED
buffers can be shared
Definition: buffers.h:39
Node events, listen to them with pw_impl_node_add_listener.
Definition: impl-node.h:53
@ PW_LINK_STATE_NEGOTIATING
the link is negotiating formats
Definition: link.h:47
SPA_EXPORT int pw_control_add_link(struct pw_control *control, uint32_t cmix, struct pw_control *other, uint32_t omix, struct pw_control_link *link)
Definition: control.c:166
void pw_work_queue_destroy(struct pw_work_queue *queue)
Destroy a work queue.
Definition: work-queue.c:134
void pw_impl_port_add_listener(struct pw_impl_port *port, struct spa_hook *listener, const struct pw_impl_port_events *events, void *data)
Add an event listener on the port.
Definition: impl-port.c:615
const SPA_EXPORT char * pw_node_state_as_string(enum pw_node_state state)
Definition: introspect.c:34
int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource)
Add a resource to a global.
Definition: global.c:237
#define PW_KEY_LINK_OUTPUT_PORT
output port id of a link
Definition: keys.h:164
SPA_EXPORT void pw_impl_link_add_listener(struct pw_impl_link *link, struct spa_hook *listener, const struct pw_impl_link_events *events, void *data)
Add an event listener to link.
Definition: impl-link.c:1299
#define PW_KEY_LINK_OUTPUT_NODE
output node id of a link
Definition: keys.h:163
uint32_t port_id
Definition: buffers.c:47
void pw_buffers_clear(struct pw_buffers *buffers)
Definition: buffers.c:355
const SPA_EXPORT char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:456
struct pw_impl_link * pw_impl_link_find(struct pw_impl_port *output, struct pw_impl_port *input)
Find the link between 2 ports.
Definition: impl-link.c:1308
@ PW_LINK_STATE_ALLOCATING
the link is allocating buffers
Definition: link.h:48
int pw_global_update_permissions(struct pw_global *global, struct pw_impl_client *client, uint32_t old_permissions, uint32_t new_permissions)
Definition: global.c:321
void pw_impl_port_update_state(struct pw_impl_port *port, enum pw_impl_port_state state, int res, char *error)
Definition: impl-port.c:98
SPA_EXPORT struct pw_impl_port * pw_impl_link_get_output(struct pw_impl_link *link)
Get the output port of the link.
Definition: impl-link.c:1344
SPA_EXPORT int pw_impl_port_release_mix(struct pw_impl_port *port, struct pw_impl_port_mix *mix)
Definition: impl-port.c:244
@ PW_NODE_STATE_SUSPENDED
the node is suspended, the device might be closed
Definition: node.h:51
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:66
#define pw_log_trace(...)
SPA_EXPORT int pw_impl_link_register(struct pw_impl_link *link, struct pw_properties *properties)
Finish link configuration and register.
Definition: impl-link.c:1192
@ PW_IMPL_PORT_STATE_ERROR
the port is in error
Definition: impl-port.h:51
#define PW_LINK_CHANGE_MASK_FORMAT
Definition: link.h:63
void(* pw_work_func_t)(void *obj, void *data, int res, uint32_t id)
Definition: work-queue.h:40
void(* info_changed)(void *data, const struct pw_link_info *info)
The info changed on a link.
Definition: impl-link.h:67
#define PW_TYPE_INTERFACE_Link
Definition: link.h:37
#define PW_KEY_LINK_PASSIVE
indicate that a link is passive and does not cause the graph to be runnable.
Definition: keys.h:165
@ PW_LINK_STATE_ACTIVE
the link is active
Definition: link.h:50
#define PW_BUFFERS_FLAG_NO_MEM
don't allocate buffer memory
Definition: buffers.h:38
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
The link information.
Definition: link.h:56
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
int pw_impl_link_activate(struct pw_impl_link *this)
Definition: impl-link.c:530
@ PW_LINK_STATE_INIT
the link is initialized
Definition: link.h:46
SPA_EXPORT struct pw_impl_port * pw_impl_link_get_input(struct pw_impl_link *link)
Get the input port of the link.
Definition: impl-link.c:1350
int pw_impl_link_prepare(struct pw_impl_link *this)
Definition: impl-link.c:662
@ PW_IMPL_PORT_STATE_PAUSED
the port is paused
Definition: impl-port.h:55
const struct pw_link_info * pw_impl_link_get_info(struct pw_impl_link *link)
Get the link info.
Definition: impl-link.c:1332
#define PW_KEY_LINK_INPUT_NODE
input node id of a link
Definition: keys.h:161
void(* state_changed)(void *data, enum pw_link_state old, enum pw_link_state state, const char *error)
The link state changed, error is only valid when the state is in error.
Definition: impl-link.h:71
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:98
static uint32_t int seq
Definition: core.h:325
SPA_EXPORT int pw_control_remove_link(struct pw_control_link *link)
Definition: control.c:237
SPA_EXPORT int pw_impl_port_init_mix(struct pw_impl_port *port, struct pw_impl_port_mix *mix)
Definition: impl-port.c:199
struct pw_impl_port * pw_impl_link_get_output(struct pw_impl_link *link)
Get the output port of the link.
Definition: impl-link.c:1344
#define PW_DIRECTION_OUTPUT
Definition: port.h:49
SPA_EXPORT int pw_global_register(struct pw_global *global)
register a global to the context registry
Definition: global.c:128
#define pw_loop_invoke(l,...)
Definition: loop.h:57
@ PW_NODE_STATE_ERROR
error state
Definition: node.h:49
int pw_impl_link_deactivate(struct pw_impl_link *this)
Definition: impl-link.c:705
@ PW_LINK_STATE_ERROR
the link is in error
Definition: link.h:44
@ PW_LINK_STATE_PAUSED
the link is paused
Definition: link.h:49
@ PW_NODE_STATE_IDLE
the node is running but there is no active port
Definition: node.h:53
#define PW_VERSION_LINK
Definition: link.h:39
enum spa_direction direction
Definition: buffers.c:46
SPA_EXPORT void * pw_impl_link_get_user_data(struct pw_impl_link *link)
Get the user_data of a link, the size of the memory is given when constructing the link.
Definition: impl-link.c:1326
struct pw_impl_link * pw_context_create_link(struct pw_context *context, struct pw_impl_port *output, struct pw_impl_port *input, struct spa_pod *format_filter, struct pw_properties *properties, size_t user_data_size)
Make a new link between two ports.
Definition: impl-link.c:1027
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:1164
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:1922
SPA_EXPORT struct pw_global * pw_impl_link_get_global(struct pw_impl_link *link)
Get the global of the link.
Definition: impl-link.c:1338
A collection of key/value pairs.
Definition: properties.h:45
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:335
struct pw_impl_port * pw_impl_link_get_input(struct pw_impl_link *link)
Get the input port of the link.
Definition: impl-link.c:1350
@ PW_IMPL_PORT_STATE_CONFIGURE
the port is ready for format negotiation
Definition: impl-port.h:53