Go to the documentation of this file.
20 #ifndef __PIPEWIRE_LINK_H__
21 #define __PIPEWIRE_LINK_H__
37 #define PW_TYPE__Link PW_TYPE_OBJECT_BASE "Link"
38 #define PW_TYPE_LINK_BASE PW_TYPE__Link ":"
53 #define PW_VERSION_LINK_EVENTS 0
76 #define PW_LINK_PROP_PASSIVE "pipewire.link.passive"
84 struct spa_pod *format_filter,
87 size_t user_data_size );
94 struct spa_hook *listener,
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
int pw_link_deactivate(struct pw_link *this)
Definition: link.c:967
void(* port_unlinked)(void *data, struct pw_port *port)
A port is unlinked.
Definition: link.h:71
int pw_port_use_buffers(struct pw_port *port, struct spa_buffer **buffers, uint32_t n_buffers)
Definition: port.c:696
#define pw_log_level_enabled(lev)
Check if a loglevel is enabled.
Definition: log.h:62
struct spa_type_param_buffers param_buffers
Definition: type.h:77
static void pw_map_remove(struct pw_map *map, uint32_t id)
Remove an item at index.
Definition: map.h:140
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
#define PW_MEMBLOCK_FLAG_MAP_READWRITE
Definition: mem.h:39
#define MAX_BUFFERS
Definition: link.c:39
an output port direction
Definition: introspect.h:49
SPA_EXPORT void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:241
PipeWire client object class.
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
SPA_EXPORT int pw_memblock_alloc(enum pw_memblock_flags flags, size_t size, struct pw_memblock **mem)
Create a new memblock.
Definition: mem.c:154
size_t size
size of mapped memory
Definition: mem.h:48
link events added with pw_link_add_listener
Definition: link.h:52
struct spa_hook resource_listener
Definition: factory.c:27
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
the node is running but there is no active port
Definition: introspect.h:38
SPA_EXPORT struct pw_core * pw_link_get_core(struct pw_link *link)
Get the core of a link.
Definition: link.c:1394
Port events, use pw_port_add_listener.
Definition: port.h:60
Global events, use pw_global_add_listener.
Definition: global.h:59
the link is unlinked
Definition: introspect.h:58
the link is negotiating formats
Definition: introspect.h:60
uint32_t version
Definition: link.h:54
struct spa_type_map * map
the type mapper
Definition: type.h:52
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_link_state
Definition: introspect.h:56
the port is in error
Definition: port.h:51
the link is allocating buffers
Definition: introspect.h:61
struct pw_work_queue * pw_work_queue_new(struct pw_loop *loop)
Create a new pw_work_queue.
Definition: work-queue.c:88
SPA_EXPORT void * pw_link_get_user_data(struct pw_link *link)
Get the user_data of a link, the size of the memory is given when constructing the link.
Definition: link.c:1400
A global object visible to remote clients.
PipeWire type support struct.
Definition: type.h:51
SPA_EXPORT void pw_link_add_listener(struct pw_link *link, struct spa_hook *listener, const struct pw_link_events *events, void *data)
Add an event listener to link.
Definition: link.c:1372
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition: map.h:92
int pw_link_activate(struct pw_link *this)
Definition: link.c:937
struct spa_dict dict
Definition: properties.h:39
the node is running
Definition: introspect.h:40
struct pw_port * pw_link_get_output(struct pw_link *link)
Get the output port of the link.
Definition: link.c:1418
static struct spa_pod * pw_spa_pod_copy(const struct spa_pod *pod)
Copy a pod structure.
Definition: utils.h:52
void(* info_changed)(void *data, const struct pw_link_info *info)
The info changed on a link.
Definition: link.h:63
uint32_t core
Definition: type.h:54
the port is ready for buffer allocation
Definition: port.h:54
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
SPA_EXPORT int pw_node_set_state(struct pw_node *node, enum pw_node_state state)
Set th node state.
Definition: node.c:876
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:338
the link is running
Definition: introspect.h:63
void pw_log_trace(const char *format,...)
struct pw_link * pw_link_find(struct pw_port *output, struct pw_port *input)
Find the link between 2 ports.
Definition: link.c:1382
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
int fd
memfd if any
Definition: mem.h:45
void * ptr
ptr to mapped memory
Definition: mem.h:47
SPA_EXPORT int pw_link_register(struct pw_link *link, struct pw_client *owner, struct pw_global *parent, struct pw_properties *properties)
Finish link configuration and register.
Definition: link.c:1275
int pw_core_find_format(struct pw_core *core, struct pw_port *output, struct pw_port *input, struct pw_properties *props, uint32_t n_format_filters, struct spa_pod **format_filters, struct spa_pod **format, struct spa_pod_builder *builder, char **error)
Find a common format between two ports.
Definition: core.c:755
#define pw_link_resource_info(r,...)
Definition: interfaces.h:721
#define PW_VERSION_RESOURCE_EVENTS
Definition: resource.h:63
#define PW_PERM_IS_R(p)
Definition: core.h:83
int pw_port_set_param(struct pw_port *port, uint32_t id, uint32_t flags, const struct spa_pod *param)
Definition: port.c:671
void(* free)(void *data)
A link is freed.
Definition: link.h:60
SPA_EXPORT struct pw_global * pw_link_get_global(struct pw_link *link)
Get the global of the link.
Definition: link.c:1412
void pw_work_queue_destroy(struct pw_work_queue *queue)
Destroy a work queue.
Definition: work-queue.c:110
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
SPA_EXPORT struct pw_port * pw_link_get_output(struct pw_link *link)
Get the output port of the link.
Definition: link.c:1418
SPA_EXPORT struct pw_port * pw_link_get_input(struct pw_link *link)
Get the input port of the link.
Definition: link.c:1424
Node events, listen to them with pw_node_add_listener.
Definition: node.h:51
const SPA_EXPORT char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:361
SPA_EXPORT const struct pw_link_info * pw_link_get_info(struct pw_link *link)
Get the link info.
Definition: link.c:1406
struct pw_port * pw_link_get_input(struct pw_link *link)
Get the input port of the link.
Definition: link.c:1424
const struct pw_link_info * pw_link_get_info(struct pw_link *link)
Get the link info.
Definition: link.c:1406
the link is paused
Definition: introspect.h:62
struct spa_type_param_meta param_meta
Definition: type.h:78
uint32_t pw_global_get_permissions(struct pw_global *global, struct pw_client *client)
Get the permissions of the global for a given client.
Definition: global.c:37
void pw_resource_destroy(struct pw_resource *resource)
Destroy a resource.
Definition: resource.c:169
void(* destroy)(void *data)
A link is destroyed.
Definition: link.h:57
int pw_port_alloc_buffers(struct pw_port *port, struct spa_pod **params, uint32_t n_params, struct spa_buffer **buffers, uint32_t *n_buffers)
Definition: port.c:727
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:60
void(* pw_work_func_t)(void *obj, void *data, int res, uint32_t id)
Definition: work-queue.h:35
struct pw_core * pw_link_get_core(struct pw_link *link)
Get the core of a link.
Definition: link.c:1394
the port is paused
Definition: port.h:55
struct spa_type_param param
Definition: type.h:71
uint32_t link
Definition: type.h:59
#define pw_core_resource_error(r,...)
Definition: interfaces.h:338
The link information.
Definition: introspect.h:204
struct pw_control this
Definition: control.c:26
struct pw_global * pw_link_get_global(struct pw_link *link)
Get the global of the link.
Definition: link.c:1412
the port is streaming
Definition: port.h:56
struct pw_link * pw_link_new(struct pw_core *core, struct pw_port *output, struct pw_port *input, struct spa_pod *format_filter, struct pw_properties *properties, char **error, size_t user_data_size)
Make a new link between two ports.
Definition: link.c:1132
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:89
void pw_log_error(const char *format,...)
struct spa_type_data data
Definition: type.h:73
void pw_node_update_state(struct pw_node *node, enum pw_node_state state, char *error)
Update the node state.
Definition: node.c:928
int pw_link_register(struct pw_link *link, struct pw_client *owner, struct pw_global *parent, struct pw_properties *properties)
Finish link configuration and register.
Definition: link.c:1275
the link is in error
Definition: introspect.h:57
#define PW_VERSION_LINK
Definition: interfaces.h:694
#define pw_loop_invoke(l,...)
Definition: loop.h:52
#define PW_VERSION_NODE_EVENTS
Definition: node.h:52
void pw_link_destroy(struct pw_link *link)
Destroy a link.
Definition: link.c:1331
Resource events.
Definition: resource.h:62
const char * pw_link_state_as_string(enum pw_link_state state)
Convert a pw_link_state to a readable string.
Definition: introspect.c:59
#define PW_LINK_CHANGE_MASK_FORMAT
Definition: introspect.h:208
error state
Definition: introspect.h:34
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
uint32_t version
Definition: resource.h:64
#define PW_LINK_PROP_PASSIVE
Indicate that a link is passive, it does not cause the nodes to activate, set to "1" or "0".
Definition: link.h:76
void pw_log_warn(const char *format,...)
#define PW_VERSION_PORT_EVENTS
Definition: control.h:50
void pw_port_add_listener(struct pw_port *port, struct spa_hook *listener, const struct pw_port_events *events, void *data)
Add an event listener on the port.
Definition: port.c:284
void pw_log_debug(const char *format,...)
void pw_link_add_listener(struct pw_link *link, struct spa_hook *listener, const struct pw_link_events *events, void *data)
Add an event listener to link.
Definition: link.c:1372
the link is initialized
Definition: introspect.h:59
the node is suspended, the device might be closed
Definition: introspect.h:36
the port is ready for format negotiation
Definition: port.h:53
void * pw_link_get_user_data(struct pw_link *link)
Get the user_data of a link, the size of the memory is given when constructing the link.
Definition: link.c:1400
A collection of key/value pairs.
Definition: properties.h:38
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:245
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: link.h:67