PipeWire  0.3.5
impl-port.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2018 Wim Taymans
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24 
25 #ifndef PIPEWIRE_IMPL_PORT_H
26 #define PIPEWIRE_IMPL_PORT_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/hook.h>
33 
44 struct pw_impl_port;
45 struct pw_impl_link;
46 struct pw_control;
47 
48 #include <pipewire/impl.h>
49 
56 };
57 
60 #define PW_VERSION_IMPL_PORT_EVENTS 0
61  uint32_t version;
62 
64  void (*destroy) (void *data);
65 
67  void (*free) (void *data);
68 
70  void (*initialized) (void *data);
71 
73  void (*info_changed) (void *data, const struct pw_port_info *info);
74 
76  void (*link_added) (void *data, struct pw_impl_link *link);
77 
79  void (*link_removed) (void *data, struct pw_impl_link *link);
80 
82  void (*state_changed) (void *data, enum pw_impl_port_state old,
83  enum pw_impl_port_state state, const char *error);
84 
86  void (*control_added) (void *data, struct pw_control *control);
87 
89  void (*control_removed) (void *data, struct pw_control *control);
90 };
91 
94 struct pw_impl_port *
95 pw_context_create_port(struct pw_context *context,
96  enum pw_direction direction,
97  uint32_t port_id,
98  const struct spa_port_info *info,
99  size_t user_data_size);
100 
103 
106 
108 int pw_impl_port_update_properties(struct pw_impl_port *port, const struct spa_dict *dict);
109 
111 const struct pw_port_info *pw_impl_port_get_info(struct pw_impl_port *port);
112 
114 uint32_t pw_impl_port_get_id(struct pw_impl_port *port);
115 
118 
121 
123 int pw_impl_port_add(struct pw_impl_port *port, struct pw_impl_node *node);
124 
127  struct spa_hook *listener,
128  const struct pw_impl_port_events *events,
129  void *data);
130 
131 #ifdef __cplusplus
132 }
133 #endif
134 
135 #endif /* PIPEWIRE_IMPL_PORT_H */
PW_IMPL_PORT_STATE_READY
@ PW_IMPL_PORT_STATE_READY
the port is ready for buffer allocation
Definition: impl-port.h:54
res
static uint32_t int int res
Definition: core.h:323
pw_impl_port_get_properties
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
port::params
struct spa_param_info params[5]
Definition: filter.c:98
id
static uint32_t id
Definition: core.h:322
resource_data::resource
struct pw_resource * resource
Definition: impl-device.c:52
pw_impl_port_state
pw_impl_port_state
Definition: impl-port.h:50
result_port_params_data::callback
int(* callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param)
Definition: impl-port.c:1006
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:169
pw_map::pw_map_remove
static void pw_map_remove(struct pw_map *map, uint32_t id)
Remove an item at index.
Definition: map.h:157
resource_data::subscribe_ids
uint32_t subscribe_ids[MAX_PARAMS]
Definition: impl-device.c:57
PW_KEY_FORMAT_DSP
#define PW_KEY_FORMAT_DSP
format related properties
Definition: keys.h:256
pw_log::pw_log_error
#define pw_log_error(...)
control
Definition: stream.c:80
pw_port_methods
Port methods.
Definition: port.h:116
NAME
#define NAME
Definition: impl-port.c:38
port::info
struct spa_port_info info
Definition: filter.c:96
port::props
struct pw_properties * props
Definition: filter.c:93
PW_KEY_PORT_DIRECTION
#define PW_KEY_PORT_DIRECTION
the port direction, one of "in" or "out" or "control" and "notify" for control ports
Definition: keys.h:149
pw_global::pw_global_destroy
SPA_EXPORT void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:367
pw_impl_port_events::control_removed
void(* control_removed)(void *data, struct pw_control *control)
a control was removed from the port
Definition: impl-port.h:89
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:76
resource_data
Definition: impl-core.c:37
PW_KEY_OBJECT_ID
#define PW_KEY_OBJECT_ID
a global object id
Definition: keys.h:70
pw_impl_port_update_properties
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
pw_impl_port_get_user_data
SPA_EXPORT void * pw_impl_port_get_user_data(struct pw_impl_port *port)
Definition: impl-port.c:615
data
Definition: filter.c:70
pw_impl_port_use_buffers
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
pw_control
pw_impl_port_update_properties
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
PW_BUFFERS_FLAG_DYNAMIC
#define PW_BUFFERS_FLAG_DYNAMIC
buffers have dynamic data
Definition: buffers.h:40
pw_impl_port_events::version
uint32_t version
Definition: impl-port.h:61
port::io
struct spa_io_buffers * io
Definition: filter.c:100
pw_impl_port_add_listener
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
pw_impl_port_events
Port events, use pw_impl_port_add_listener.
Definition: impl-port.h:59
pw_log_trace_fp
#define pw_log_trace_fp(...)
Definition: log.h:89
pw_global_events
Global events, use pw_global_add_listener.
Definition: global.h:65
pw_impl_client
PipeWire client object class.
pw_impl_port_get_direction
enum pw_direction pw_impl_port_get_direction(struct pw_impl_port *port)
Get the port direction.
Definition: impl-port.c:560
pw_control_new
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
pw_impl_port_for_each_param
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
pw_impl_port_events::control_added
void(* control_added)(void *data, struct pw_control *control)
a control was added to the port
Definition: impl-port.h:86
pw_direction
#define pw_direction
Definition: port.h:47
pw_resource_errorf
void pw_resource_errorf(struct pw_resource *resource, int res, const char *error,...) SPA_PRINTF_FUNC(3
pw_impl_port_register
int pw_impl_port_register(struct pw_impl_port *port, struct pw_properties *properties)
Definition: impl-port.c:770
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:52
PW_PORT_CHANGE_MASK_ALL
#define PW_PORT_CHANGE_MASK_ALL
Definition: port.h:66
PW_KEY_PORT_TERMINAL
#define PW_KEY_PORT_TERMINAL
if this port consumes the data
Definition: keys.h:153
impl
Definition: control.c:33
pw_buffers_negotiate
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
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:252
r
static uint32_t int int const char int r
Definition: core.h:335
pw_impl_port_for_each_filtered_param
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
port::node
struct spa_node * node
Definition: buffers.c:44
PW_TYPE_INTERFACE_Port
#define PW_TYPE_INTERFACE_Port
Definition: port.h:41
pw_context_load_spa_handle
struct spa_handle * pw_context_load_spa_handle(struct pw_context *context, const char *factory_name, const struct spa_dict *info)
handle
Definition: pipewire.c:58
PW_IMPL_PORT_STATE_INIT
@ PW_IMPL_PORT_STATE_INIT
the port is being created
Definition: impl-port.h:52
pw_global
A global object visible to remote clients.
PW_DIRECTION_INPUT
#define PW_DIRECTION_INPUT
Definition: port.h:48
pw_impl_port_get_id
uint32_t pw_impl_port_get_id(struct pw_impl_port *port)
Get the port id.
Definition: impl-port.c:566
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:105
impl.h
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
param_filter::n_params
uint32_t n_params
Definition: impl-port.c:1075
port::link
struct spa_list link
Definition: filter.c:84
port::port
struct pw_port * port
Definition: filter.c:91
pw_log
#define pw_log(lev,...)
Definition: log.h:76
pw_port_info
Definition: port.h:61
pw_map::pw_map_insert_at
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
pw_impl_node
pw_properties::pw_properties_setf
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
pw_impl_port_get_info
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
PW_KEY_OBJECT_PATH
#define PW_KEY_OBJECT_PATH
unique path to construct the object
Definition: keys.h:69
PW_PORT_CHANGE_MASK_PROPS
#define PW_PORT_CHANGE_MASK_PROPS
Definition: port.h:64
port
Definition: buffers.c:43
pw_impl_port::pw_impl_port_add
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
PW_KEY_AUDIO_CHANNEL
#define PW_KEY_AUDIO_CHANNEL
audio related properties
Definition: keys.h:259
resource_data::object_listener
struct spa_hook object_listener
Definition: impl-core.c:39
pw_port_methods::version
uint32_t version
Definition: port.h:118
pw_control_destroy
void pw_control_destroy(struct pw_control *control)
Definition: control.c:94
pw_impl_port_update_state
void pw_impl_port_update_state(struct pw_impl_port *port, enum pw_impl_port_state state, char *error)
Definition: impl-port.c:97
filter
Definition: filter.c:112
PW_NODE_CHANGE_MASK_INPUT_PORTS
#define PW_NODE_CHANGE_MASK_INPUT_PORTS
Definition: node.h:66
pw_log::pw_log_debug
#define pw_log_debug(...)
pw_log::pw_log_warn
#define pw_log_warn(...)
pw_properties::pw_properties_new_dict
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
pw_properties::pw_properties_update
SPA_EXPORT int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition: properties.c:258
param_filter::data
void * data
Definition: impl-port.c:1074
pw_impl_port_get_id
SPA_EXPORT uint32_t pw_impl_port_get_id(struct pw_impl_port *port)
Get the port id.
Definition: impl-port.c:566
buffer
Definition: filter.c:55
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:160
pw_impl_port_get_node
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
param_filter::out_param_id
uint32_t out_param_id
Definition: impl-port.c:1071
param_filter::seq
int seq
Definition: impl-port.c:1069
pw_map::pw_map_clear
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:87
pw_impl_port_add_listener
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
param_filter
Definition: impl-port.c:1066
pw_global_add_resource
int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource)
Add a resource to a global.
Definition: global.c:227
param_filter::in_param_id
uint32_t in_param_id
Definition: impl-port.c:1070
pw_impl_port_events::link_removed
void(* link_removed)(void *data, struct pw_impl_link *link)
a link is removed from this port
Definition: impl-port.h:79
param_filter::callback
int(* callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param)
Definition: impl-port.c:1072
pw_impl_port_events::destroy
void(* destroy)(void *data)
The port is destroyed.
Definition: impl-port.h:64
PW_VERSION_PORT
#define PW_VERSION_PORT
Definition: port.h:43
port::port_id
uint32_t port_id
Definition: buffers.c:46
pw_buffers_clear
void pw_buffers_clear(struct pw_buffers *buffers)
Definition: buffers.c:342
pw_context
the PipeWire context
port::flags
uint32_t flags
Definition: filter.c:90
PW_KEY_PORT_CONTROL
#define PW_KEY_PORT_CONTROL
if this port is a control port
Definition: keys.h:154
pw_impl_port_destroy
void pw_impl_port_destroy(struct pw_impl_port *port)
Definition: impl-port.c:969
pw_impl_port_set_mix
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
param
Definition: filter.c:75
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:395
param_filter::in_port
struct pw_impl_port * in_port
Definition: impl-port.c:1067
pw_resource
Client owned objects.
pw_impl_port_release_mix
SPA_EXPORT int pw_impl_port_release_mix(struct pw_impl_port *port, struct pw_impl_port_mix *mix)
Definition: impl-port.c:234
pw_resource_add_object_listener
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
port::user_data
uint8_t user_data[0]
Definition: filter.c:109
param_filter::out_port
struct pw_impl_port * out_port
Definition: impl-port.c:1068
PW_KEY_PORT_NAME
#define PW_KEY_PORT_NAME
port name
Definition: keys.h:148
resource_data::n_subscribe_ids
uint32_t n_subscribe_ids
Definition: impl-device.c:58
PW_VERSION_GLOBAL_EVENTS
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:66
PW_IMPL_PORT_STATE_ERROR
@ PW_IMPL_PORT_STATE_ERROR
the port is in error
Definition: impl-port.h:51
resource_data::data
struct result_device_params_data data
Definition: impl-device.c:63
pw_properties::pw_properties_get
SPA_EXPORT const char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:451
PW_PORT_CHANGE_MASK_PARAMS
#define PW_PORT_CHANGE_MASK_PARAMS
Definition: port.h:65
PW_NODE_CHANGE_MASK_OUTPUT_PORTS
#define PW_NODE_CHANGE_MASK_OUTPUT_PORTS
Definition: node.h:67
pw_impl_port_get_direction
SPA_EXPORT enum pw_direction pw_impl_port_get_direction(struct pw_impl_port *port)
Get the port direction.
Definition: impl-port.c:560
pw_impl_port_events::info_changed
void(* info_changed)(void *data, const struct pw_port_info *info)
the port info changed
Definition: impl-port.h:73
pw_impl_port_events::link_added
void(* link_added)(void *data, struct pw_impl_link *link)
a new link is added on this port
Definition: impl-port.h:76
pw_resource_new
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
pw_impl_port_for_each_link
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
pw_global::pw_global_new
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
result_port_params_data::data
void * data
Definition: impl-port.c:1005
impl::this
struct pw_control this
Definition: control.c:34
pw_map
A map.
Definition: map.h:50
pw_impl_port_events::initialized
void(* initialized)(void *data)
The port is initialized.
Definition: impl-port.h:70
PW_IMPL_PORT_STATE_PAUSED
@ PW_IMPL_PORT_STATE_PAUSED
the port is paused
Definition: impl-port.h:55
PW_VERSION_PORT_METHODS
#define PW_VERSION_PORT_METHODS
Definition: port.h:117
pw_impl_port_get_node
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
pw_impl_port_events::free
void(* free)(void *data)
The port is freed.
Definition: impl-port.h:67
pw_properties::pw_properties_new
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:95
pw_impl_port_get_properties
const struct pw_properties * pw_impl_port_get_properties(struct pw_impl_port *port)
Get the port properties.
Definition: impl-port.c:572
seq
static uint32_t int seq
Definition: core.h:322
pw_impl_port_init_mix
SPA_EXPORT int pw_impl_port_init_mix(struct pw_impl_port *port, struct pw_impl_port_mix *mix)
Definition: impl-port.c:189
result_port_params_data::seq
int seq
Definition: impl-port.c:1009
PW_DIRECTION_OUTPUT
#define PW_DIRECTION_OUTPUT
Definition: port.h:49
pw_global::pw_global_register
SPA_EXPORT int pw_global_register(struct pw_global *global)
register a global to the context registry
Definition: global.c:128
pw_impl_port_is_linked
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
PW_KEY_PORT_ALIAS
#define PW_KEY_PORT_ALIAS
port alias
Definition: keys.h:151
pw_loop_invoke
#define pw_loop_invoke(l,...)
Definition: loop.h:57
pw_impl_port_events::state_changed
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
pw_impl_port_unlink
void pw_impl_port_unlink(struct pw_impl_port *port)
Definition: impl-port.c:921
pw_impl_port_is_linked
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
PW_KEY_PORT_PHYSICAL
#define PW_KEY_PORT_PHYSICAL
if this is a physical port
Definition: keys.h:152
pw_impl_port_get_info
const struct pw_port_info * pw_impl_port_get_info(struct pw_impl_port *port)
Get the port info.
Definition: impl-port.c:609
pw_impl_port_update_info
void pw_impl_port_update_info(struct pw_impl_port *port, const struct spa_port_info *info)
Definition: impl-port.c:587
port::buffers
struct buffer buffers[MAX_BUFFERS]
Definition: filter.c:102
pw_pipewire::pw_direction_reverse
SPA_EXPORT enum pw_direction pw_direction_reverse(enum pw_direction direction)
Reverse the direction.
Definition: pipewire.c:512
port::direction
enum spa_direction direction
Definition: buffers.c:45
pw_impl_port_set_param
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
pw_impl_port
pw_unload_spa_handle
int pw_unload_spa_handle(struct spa_handle *handle)
Definition: pipewire.c:308
PW_KEY_NODE_ID
#define PW_KEY_NODE_ID
Node keys.
Definition: keys.h:124
port::n_buffers
uint32_t n_buffers
Definition: filter.c:103
port::id
uint32_t id
Definition: filter.c:89
pw_impl_port::pw_context_create_port
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
result_port_params_data
Definition: impl-port.c:1004
pw_properties::pw_properties_update_keys
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
pw_properties
A collection of key/value pairs.
Definition: properties.h:45
pw_properties::pw_properties_free
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:330
PW_IMPL_PORT_STATE_CONFIGURE
@ PW_IMPL_PORT_STATE_CONFIGURE
the port is ready for format negotiation
Definition: impl-port.h:53