PipeWire: pipewire/link.h Source File

PipeWire 1.4.9

Loading...
Searching...
No Matches
link.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_LINK_H
6#define PIPEWIRE_LINK_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
12#include <spa/utils/defs.h>
13#include <spa/utils/hook.h>
14
15#include <pipewire/proxy.h>
16
26
31
32#define PW_TYPE_INTERFACE_Link PW_TYPE_INFO_INTERFACE_BASE "Link"
33
34#define PW_LINK_PERM_MASK PW_PERM_R | PW_PERM_X
35
36#define PW_VERSION_LINK 3
37 struct pw_link;
38
39#ifndef PW_API_LINK_IMPL
40#define PW_API_LINK_IMPL static inline
41#endif
42
43
45enum pw_link_state {
46 PW_LINK_STATE_ERROR = -2,
47 PW_LINK_STATE_UNLINKED = -1,
48 PW_LINK_STATE_INIT = 0,
49 PW_LINK_STATE_NEGOTIATING = 1,
50 PW_LINK_STATE_ALLOCATING = 2,
51 PW_LINK_STATE_PAUSED = 3,
52 PW_LINK_STATE_ACTIVE = 4,
53};
54
56 const char * pw_link_state_as_string(enum pw_link_state state);
58 struct pw_link_info {
59 uint32_t id;
60 uint32_t output_node_id;
61 uint32_t output_port_id;
62 uint32_t input_node_id;
63 uint32_t input_port_id;
64#define PW_LINK_CHANGE_MASK_STATE (1 << 0)
65#define PW_LINK_CHANGE_MASK_FORMAT (1 << 1)
66#define PW_LINK_CHANGE_MASK_PROPS (1 << 2)
67#define PW_LINK_CHANGE_MASK_ALL ((1 << 3)-1)
68 uint64_t change_mask;
69 enum pw_link_state state;
70 const char *error;
71 struct spa_pod *format;
72 struct spa_dict *props;
73};
74
75struct pw_link_info *
76 pw_link_info_update(struct pw_link_info *info,
77 const struct pw_link_info *update);
78
79struct pw_link_info *
80 pw_link_info_merge(struct pw_link_info *info,
81 const struct pw_link_info *update, bool reset);
82
83 void
84 pw_link_info_free(struct pw_link_info *info);
85
86
87#define PW_LINK_EVENT_INFO 0
88#define PW_LINK_EVENT_NUM 1
89
91struct pw_link_events {
92#define PW_VERSION_LINK_EVENTS 0
93 uint32_t version;
99 void (*info) (void *data, const struct pw_link_info *info);
100};
101
102#define PW_LINK_METHOD_ADD_LISTENER 0
103#define PW_LINK_METHOD_NUM 1
104
106 struct pw_link_methods {
107#define PW_VERSION_LINK_METHODS 0
108 uint32_t version;
109
110 int (*add_listener) (void *object,
111 struct spa_hook *listener,
112 const struct pw_link_events *events,
113 void *data);
114};
115
117
118 PW_API_LINK_IMPL int pw_link_add_listener(struct pw_link *object,
119 struct spa_hook *listener,
120 const struct pw_link_events *events,
121 void *data)
122{
123 return spa_api_method_r(int, -ENOTSUP,
124 pw_link, (struct spa_interface*)object, add_listener, 0,
125 listener, events, data);
126}
127
131
132#ifdef __cplusplus
133} /* extern "C" */
134#endif
135
136#endif /* PIPEWIRE_LINK_H */
defs.h
spa/utils/defs.h
id
uint32_t id
Definition core.h:432
pw_link_state_as_string
const char * pw_link_state_as_string(enum pw_link_state state)
Convert a pw_link_state to a readable string.
Definition introspect.c:45
pw_link_info_merge
struct pw_link_info * pw_link_info_merge(struct pw_link_info *info, const struct pw_link_info *update, bool reset)
Definition introspect.c:521
pw_link_info_free
void pw_link_info_free(struct pw_link_info *info)
Definition introspect.c:567
pw_link_info_update
struct pw_link_info * pw_link_info_update(struct pw_link_info *info, const struct pw_link_info *update)
Definition introspect.c:560
pw_link_state
pw_link_state
The different link states.
Definition link.h:54
PW_API_LINK_IMPL
#define PW_API_LINK_IMPL
Definition link.h:49
pw_link_add_listener
PW_API_LINK_IMPL int pw_link_add_listener(struct pw_link *object, struct spa_hook *listener, const struct pw_link_events *events, void *data)
Definition link.h:137
PW_LINK_STATE_ACTIVE
@ PW_LINK_STATE_ACTIVE
the link is active
Definition link.h:61
PW_LINK_STATE_ERROR
@ PW_LINK_STATE_ERROR
the link is in error
Definition link.h:55
PW_LINK_STATE_UNLINKED
@ PW_LINK_STATE_UNLINKED
the link is unlinked
Definition link.h:56
PW_LINK_STATE_PAUSED
@ PW_LINK_STATE_PAUSED
the link is paused
Definition link.h:60
PW_LINK_STATE_NEGOTIATING
@ PW_LINK_STATE_NEGOTIATING
the link is negotiating formats
Definition link.h:58
PW_LINK_STATE_INIT
@ PW_LINK_STATE_INIT
the link is initialized
Definition link.h:57
PW_LINK_STATE_ALLOCATING
@ PW_LINK_STATE_ALLOCATING
the link is allocating buffers
Definition link.h:59
spa_api_method_r
#define spa_api_method_r(rtype, def, type, o, method, version,...)
Definition hook.h:291
hook.h
spa/utils/hook.h
proxy.h
pipewire/proxy.h
pw_link_events
Link events.
Definition link.h:106
pw_link_events::version
uint32_t version
Definition link.h:109
pw_link_info
The link information.
Definition link.h:67
pw_link_info::output_port_id
uint32_t output_port_id
output port id
Definition link.h:70
pw_link_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition link.h:81
pw_link_info::output_node_id
uint32_t output_node_id
server side output node id
Definition link.h:69
pw_link_info::state
enum pw_link_state state
the current state of the link
Definition link.h:82
pw_link_info::error
const char * error
an error reason if state is error
Definition link.h:83
pw_link_info::input_node_id
uint32_t input_node_id
server side input node id
Definition link.h:71
pw_link_info::format
struct spa_pod * format
format over link
Definition link.h:84
pw_link_info::input_port_id
uint32_t input_port_id
input port id
Definition link.h:72
pw_link_methods
Link methods.
Definition link.h:124
pw_link_methods::version
uint32_t version
Definition link.h:127
pw_link_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_link_events *events, void *data)
Definition link.h:129
pw_link
spa_dict
Definition dict.h:51
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427
spa_interface
Definition hook.h:148
spa_pod
Definition pod.h:43