Go to the documentation of this file.
25 #ifndef PIPEWIRE_IMPL_PORT_H
26 #define PIPEWIRE_IMPL_PORT_H
32 #include <spa/utils/hook.h>
60 #define PW_VERSION_IMPL_PORT_EVENTS 0
98 const struct spa_port_info *info,
99 size_t user_data_size);
127 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:323
SPA_EXPORT const struct pw_properties * pw_impl_port_get_properties(struct pw_impl_port *port)
Get the port properties.
Definition: impl-port.c:572
struct spa_param_info params[5]
Definition: filter.c:98
static uint32_t id
Definition: core.h:322
struct pw_resource * resource
Definition: impl-device.c:52
pw_impl_port_state
Definition: impl-port.h:50
int(* callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param)
Definition: impl-port.c:1006
static void * pw_map_lookup(struct pw_map *map, uint32_t id)
Find an item in the map.
Definition: map.h:169
static void pw_map_remove(struct pw_map *map, uint32_t id)
Remove an item at index.
Definition: map.h:157
uint32_t subscribe_ids[MAX_PARAMS]
Definition: impl-device.c:57
#define PW_KEY_FORMAT_DSP
format related properties
Definition: keys.h:256
#define pw_log_error(...)
Port methods.
Definition: port.h:116
#define NAME
Definition: impl-port.c:38
struct spa_port_info info
Definition: filter.c:96
struct pw_properties * props
Definition: filter.c:93
#define PW_KEY_PORT_DIRECTION
the port direction, one of "in" or "out" or "control" and "notify" for control ports
Definition: keys.h:149
SPA_EXPORT void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:367
void(* control_removed)(void *data, struct pw_control *control)
a control was removed from the port
Definition: impl-port.h:89
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition: map.h:76
Definition: impl-core.c:37
#define PW_KEY_OBJECT_ID
a global object id
Definition: keys.h:70
SPA_EXPORT int pw_impl_port_update_properties(struct pw_impl_port *port, const struct spa_dict *dict)
Update the port properties.
Definition: impl-port.c:578
SPA_EXPORT void * pw_impl_port_get_user_data(struct pw_impl_port *port)
Definition: impl-port.c:615
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:1241
int pw_impl_port_update_properties(struct pw_impl_port *port, const struct spa_dict *dict)
Update the port properties.
Definition: impl-port.c:578
#define PW_BUFFERS_FLAG_DYNAMIC
buffers have dynamic data
Definition: buffers.h:40
uint32_t version
Definition: impl-port.h:61
struct spa_io_buffers * io
Definition: filter.c:100
SPA_EXPORT 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:600
Port events, use pw_impl_port_add_listener.
Definition: impl-port.h:59
#define pw_log_trace_fp(...)
Definition: log.h:89
Global events, use pw_global_add_listener.
Definition: global.h:65
PipeWire client object class.
enum pw_direction pw_impl_port_get_direction(struct pw_impl_port *port)
Get the port direction.
Definition: impl-port.c:560
struct pw_control * pw_control_new(struct pw_context *context, struct pw_impl_port *port, uint32_t id, uint32_t size, size_t user_data_size)
Definition: control.c:40
int pw_impl_port_for_each_param(struct pw_impl_port *port, 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-port.c:1028
void(* control_added)(void *data, struct pw_control *control)
a control was added to the port
Definition: impl-port.h:86
#define pw_direction
Definition: port.h:47
void pw_resource_errorf(struct pw_resource *resource, int res, const char *error,...) SPA_PRINTF_FUNC(3
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_PORT_CHANGE_MASK_ALL
Definition: port.h:66
#define PW_KEY_PORT_TERMINAL
if this port consumes the data
Definition: keys.h:153
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:234
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
int pw_impl_port_for_each_filtered_param(struct pw_impl_port *in_port, struct pw_impl_port *out_port, int seq, uint32_t in_param_id, uint32_t out_param_id, 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-port.c:1085
struct spa_node * node
Definition: buffers.c:44
#define PW_TYPE_INTERFACE_Port
Definition: port.h:41
struct spa_handle * pw_context_load_spa_handle(struct pw_context *context, const char *factory_name, const struct spa_dict *info)
Definition: pipewire.c:58
@ PW_IMPL_PORT_STATE_INIT
the port is being created
Definition: impl-port.h:52
A global object visible to remote clients.
#define PW_DIRECTION_INPUT
Definition: port.h:48
uint32_t pw_impl_port_get_id(struct pw_impl_port *port)
Get the port id.
Definition: impl-port.c:566
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition: map.h:105
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
uint32_t n_params
Definition: impl-port.c:1075
struct spa_list link
Definition: filter.c:84
void pw_impl_link_destroy(struct pw_impl_link *link)
Destroy a link.
Definition: impl-link.c:1215
struct pw_port * port
Definition: filter.c:91
#define pw_log(lev,...)
Definition: log.h:76
static int pw_map_insert_at(struct pw_map *map, uint32_t id, void *data)
Insert data in the map at an index.
Definition: map.h:133
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
SPA_EXPORT const struct pw_port_info * pw_impl_port_get_info(struct pw_impl_port *port)
Get the port info.
Definition: impl-port.c:609
#define PW_KEY_OBJECT_PATH
unique path to construct the object
Definition: keys.h:69
#define PW_PORT_CHANGE_MASK_PROPS
Definition: port.h:64
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_AUDIO_CHANNEL
audio related properties
Definition: keys.h:259
struct spa_hook object_listener
Definition: impl-core.c:39
uint32_t version
Definition: port.h:118
void pw_control_destroy(struct pw_control *control)
Definition: control.c:94
void pw_impl_port_update_state(struct pw_impl_port *port, enum pw_impl_port_state state, char *error)
Definition: impl-port.c:97
#define PW_NODE_CHANGE_MASK_INPUT_PORTS
Definition: node.h:66
#define pw_log_debug(...)
SPA_EXPORT struct pw_properties * pw_properties_new_dict(const struct spa_dict *dict)
Make a new properties object from the given dictionary.
Definition: properties.c:125
SPA_EXPORT int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition: properties.c:258
void * data
Definition: impl-port.c:1074
SPA_EXPORT uint32_t pw_impl_port_get_id(struct pw_impl_port *port)
Get the port id.
Definition: impl-port.c:566
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
struct pw_impl_node * pw_impl_port_get_node(struct pw_impl_port *port)
Get the port parent node or NULL when not yet set.
Definition: impl-port.c:594
uint32_t out_param_id
Definition: impl-port.c:1071
int seq
Definition: impl-port.c:1069
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:87
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:600
Definition: impl-port.c:1066
int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource)
Add a resource to a global.
Definition: global.c:227
uint32_t in_param_id
Definition: impl-port.c:1070
void(* link_removed)(void *data, struct pw_impl_link *link)
a link is removed from this port
Definition: impl-port.h:79
int(* callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param)
Definition: impl-port.c:1072
void(* destroy)(void *data)
The port is destroyed.
Definition: impl-port.h:64
#define PW_VERSION_PORT
Definition: port.h:43
uint32_t port_id
Definition: buffers.c:46
void pw_buffers_clear(struct pw_buffers *buffers)
Definition: buffers.c:342
uint32_t flags
Definition: filter.c:90
#define PW_KEY_PORT_CONTROL
if this port is a control port
Definition: keys.h:154
void pw_impl_port_destroy(struct pw_impl_port *port)
Definition: impl-port.c:969
SPA_EXPORT int pw_impl_port_set_mix(struct pw_impl_port *port, struct spa_node *node, uint32_t flags)
Definition: impl-port.c:446
SPA_EXPORT int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:395
struct pw_impl_port * in_port
Definition: impl-port.c:1067
SPA_EXPORT int pw_impl_port_release_mix(struct pw_impl_port *port, struct pw_impl_port_mix *mix)
Definition: impl-port.c:234
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
uint8_t user_data[0]
Definition: filter.c:109
struct pw_impl_port * out_port
Definition: impl-port.c:1068
#define PW_KEY_PORT_NAME
port name
Definition: keys.h:148
uint32_t n_subscribe_ids
Definition: impl-device.c:58
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:66
@ PW_IMPL_PORT_STATE_ERROR
the port is in error
Definition: impl-port.h:51
struct result_device_params_data data
Definition: impl-device.c:63
SPA_EXPORT const char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:451
#define PW_PORT_CHANGE_MASK_PARAMS
Definition: port.h:65
#define PW_NODE_CHANGE_MASK_OUTPUT_PORTS
Definition: node.h:67
SPA_EXPORT enum pw_direction pw_impl_port_get_direction(struct pw_impl_port *port)
Get the port direction.
Definition: impl-port.c:560
void(* info_changed)(void *data, const struct pw_port_info *info)
the port info changed
Definition: impl-port.h:73
void(* link_added)(void *data, struct pw_impl_link *link)
a new link is added on this port
Definition: impl-port.h:76
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
int pw_impl_port_for_each_link(struct pw_impl_port *port, int(*callback)(void *data, struct pw_impl_link *link), void *data)
Definition: impl-port.c:1108
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
void * data
Definition: impl-port.c:1005
struct pw_control this
Definition: control.c:34
A map.
Definition: map.h:50
void(* initialized)(void *data)
The port is initialized.
Definition: impl-port.h:70
@ PW_IMPL_PORT_STATE_PAUSED
the port is paused
Definition: impl-port.h:55
#define PW_VERSION_PORT_METHODS
Definition: port.h:117
SPA_EXPORT struct pw_impl_node * pw_impl_port_get_node(struct pw_impl_port *port)
Get the port parent node or NULL when not yet set.
Definition: impl-port.c:594
void(* free)(void *data)
The port is freed.
Definition: impl-port.h:67
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:95
const struct pw_properties * pw_impl_port_get_properties(struct pw_impl_port *port)
Get the port properties.
Definition: impl-port.c:572
static uint32_t int seq
Definition: core.h:322
SPA_EXPORT int pw_impl_port_init_mix(struct pw_impl_port *port, struct pw_impl_port_mix *mix)
Definition: impl-port.c:189
int seq
Definition: impl-port.c:1009
#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
SPA_EXPORT int pw_impl_port_is_linked(struct pw_impl_port *port)
check is a port has links, return 0 if not, 1 if it is linked
Definition: impl-port.c:1128
#define PW_KEY_PORT_ALIAS
port alias
Definition: keys.h:151
#define pw_loop_invoke(l,...)
Definition: loop.h:57
void(* state_changed)(void *data, enum pw_impl_port_state old, enum pw_impl_port_state state, const char *error)
the state of the port changed
Definition: impl-port.h:82
void pw_impl_port_unlink(struct pw_impl_port *port)
Definition: impl-port.c:921
int pw_impl_port_is_linked(struct pw_impl_port *port)
check is a port has links, return 0 if not, 1 if it is linked
Definition: impl-port.c:1128
#define PW_KEY_PORT_PHYSICAL
if this is a physical port
Definition: keys.h:152
const struct pw_port_info * pw_impl_port_get_info(struct pw_impl_port *port)
Get the port info.
Definition: impl-port.c:609
void pw_impl_port_update_info(struct pw_impl_port *port, const struct spa_port_info *info)
Definition: impl-port.c:587
struct buffer buffers[MAX_BUFFERS]
Definition: filter.c:102
SPA_EXPORT enum pw_direction pw_direction_reverse(enum pw_direction direction)
Reverse the direction.
Definition: pipewire.c:512
enum spa_direction direction
Definition: buffers.c:45
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
int pw_unload_spa_handle(struct spa_handle *handle)
Definition: pipewire.c:308
#define PW_KEY_NODE_ID
Node keys.
Definition: keys.h:124
uint32_t n_buffers
Definition: filter.c:103
uint32_t id
Definition: filter.c: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
Definition: impl-port.c:1004
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
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:330
@ PW_IMPL_PORT_STATE_CONFIGURE
the port is ready for format negotiation
Definition: impl-port.h:53