PipeWire 0.2.5

port.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_PORT_H__
21 #define __PIPEWIRE_PORT_H__
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 #define PW_TYPE__Port "PipeWire:Object:Port"
28 #define PW_TYPE_PORT_BASE PW_TYPE__Port ":"
29
30 #include <spa/utils/hook.h>
31
42 struct pw_port;
43 struct pw_link;
44 struct pw_control;
45
46 #include <pipewire/core.h>
47 #include <pipewire/introspect.h>
48 #include <pipewire/node.h>
49
50 enum pw_port_state {
51 PW_PORT_STATE_ERROR = -1,
52 PW_PORT_STATE_INIT = 0,
53 PW_PORT_STATE_CONFIGURE = 1,
54 PW_PORT_STATE_READY = 2,
55 PW_PORT_STATE_PAUSED = 3,
56 PW_PORT_STATE_STREAMING = 4,
57 };
58
60 struct pw_port_events {
61 #define PW_VERSION_PORT_EVENTS 0
62 uint32_t version;
63
65 void (*destroy) (void *data);
66
68 void (*free) (void *data);
69
71 void (*info_changed) (void *data, struct pw_port_info *info);
72
74 void (*link_added) (void *data, struct pw_link *link);
75
77 void (*link_removed) (void *data, struct pw_link *link);
78
80 void (*state_changed) (void *data, enum pw_port_state state);
81
83 void (*control_added) (void *data, struct pw_control *control);
84
86 void (*control_removed) (void *data, struct pw_control *control);
87 };
88
90 enum pw_direction pw_port_get_direction(struct pw_port *port);
91
93 const struct pw_properties *pw_port_get_properties(struct pw_port *port);
94
96 int pw_port_update_properties(struct pw_port *port, const struct spa_dict *dict);
97
99 uint32_t pw_port_get_id(struct pw_port *port);
100
102 struct pw_node *pw_port_get_node(struct pw_port *port);
103
105 void pw_port_add_listener(struct pw_port *port,
106 struct spa_hook *listener,
107 const struct pw_port_events *events,
108 void *data);
109
110 #ifdef __cplusplus
111 }
112 #endif
113
114 #endif /* __PIPEWIRE_PORT_H__ */
pw_properties
A collection of key/value pairs.
Definition: properties.h:38
node.h
pw_port_update_properties
int pw_port_update_properties(struct pw_port *port, const struct spa_dict *dict)
Update the port properties.
Definition: port.c:247
pw_port_get_id
uint32_t pw_port_get_id(struct pw_port *port)
Get the port id.
Definition: port.c:237
introspect.h
pw_port_events::link_added
void(* link_added)(void *data, struct pw_link *link)
a new link is added on this port
Definition: port.h:74
pw_link
PipeWire link object.
pw_properties::dict
struct spa_dict dict
Definition: properties.h:39
core.h
PW_PORT_STATE_CONFIGURE
the port is ready for format negotiation
Definition: port.h:53
pw_port_add_listener
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:277
pw_port_info
Definition: introspect.h:168
pw_control
The control object.
pw_port_events::version
uint32_t version
Definition: port.h:62
pw_port_get_properties
const struct pw_properties * pw_port_get_properties(struct pw_port *port)
Get the port properties.
Definition: port.c:242
pw_port_events
Port events, use pw_port_add_listener.
Definition: port.h:60
PW_PORT_STATE_ERROR
the port is in error
Definition: port.h:51
pw_port_state
pw_port_state
Definition: port.h:50
PW_PORT_STATE_STREAMING
the port is streaming
Definition: port.h:56
PW_PORT_STATE_PAUSED
the port is paused
Definition: port.h:55
pw_port_events::free
void(* free)(void *data)
The port is freed.
Definition: port.h:68
PW_PORT_STATE_READY
the port is ready for buffer allocation
Definition: port.h:54
pw_port_events::info_changed
void(* info_changed)(void *data, struct pw_port_info *info)
the port info changed
Definition: port.h:71
pw_port_events::state_changed
void(* state_changed)(void *data, enum pw_port_state state)
the state of the port changed
Definition: port.h:80
pw_port_events::destroy
void(* destroy)(void *data)
The port is destroyed.
Definition: port.h:65
pw_port_get_direction
enum pw_direction pw_port_get_direction(struct pw_port *port)
Get the port direction.
Definition: port.c:232
pw_node
PipeWire node class.
pw_port_get_node
struct pw_node * pw_port_get_node(struct pw_port *port)
Get the port parent node or NULL when not yet set.
Definition: port.c:272
PW_PORT_STATE_INIT
the port is being created
Definition: port.h:52
pw_port_events::link_removed
void(* link_removed)(void *data, struct pw_link *link)
a link is removed from this port
Definition: port.h:77
pw_port
The port object.
pw_port_events::control_added
void(* control_added)(void *data, struct pw_control *control)
a control was added to the port
Definition: port.h:83
pw_port_events::control_removed
void(* control_removed)(void *data, struct pw_control *control)
a control was removed from the port
Definition: port.h:86
pw_direction
pw_direction
The direction of a port.
Definition: introspect.h:47