PipeWire: link.h Source File

PipeWire 0.3.34

link.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_LINK_H
26 #define PIPEWIRE_LINK_H
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include <spa/utils/defs.h>
33 #include <spa/utils/hook.h>
34
35 #include <pipewire/proxy.h>
36
52 #define PW_TYPE_INTERFACE_Link PW_TYPE_INFO_INTERFACE_BASE "Link"
53
54 #define PW_VERSION_LINK 3
55 struct pw_link;
56
58 enum pw_link_state {
59 PW_LINK_STATE_ERROR = -2,
60 PW_LINK_STATE_UNLINKED = -1,
61 PW_LINK_STATE_INIT = 0,
62 PW_LINK_STATE_NEGOTIATING = 1,
63 PW_LINK_STATE_ALLOCATING = 2,
64 PW_LINK_STATE_PAUSED = 3,
65 PW_LINK_STATE_ACTIVE = 4,
66 };
67
69 const char * pw_link_state_as_string(enum pw_link_state state);
71 struct pw_link_info {
72 uint32_t id;
73 uint32_t output_node_id;
74 uint32_t output_port_id;
75 uint32_t input_node_id;
76 uint32_t input_port_id;
77 #define PW_LINK_CHANGE_MASK_STATE (1 << 0)
78 #define PW_LINK_CHANGE_MASK_FORMAT (1 << 1)
79 #define PW_LINK_CHANGE_MASK_PROPS (1 << 2)
80 #define PW_LINK_CHANGE_MASK_ALL ((1 << 3)-1)
81 uint64_t change_mask;
82 enum pw_link_state state;
83 const char *error;
84 struct spa_pod *format;
85 struct spa_dict *props;
86 };
87
88 struct pw_link_info *
89 pw_link_info_update(struct pw_link_info *info,
90 const struct pw_link_info *update);
91
92 void
93 pw_link_info_free(struct pw_link_info *info);
94
95
96 #define PW_LINK_EVENT_INFO 0
97 #define PW_LINK_EVENT_NUM 1
98
100 struct pw_link_events {
101 #define PW_VERSION_LINK_EVENTS 0
102 uint32_t version;
108 void (*info) (void *object, const struct pw_link_info *info);
109 };
110
111 #define PW_LINK_METHOD_ADD_LISTENER 0
112 #define PW_LINK_METHOD_NUM 1
113
115 struct pw_link_methods {
116 #define PW_VERSION_LINK_METHODS 0
117 uint32_t version;
118
119 int (*add_listener) (void *object,
120 struct spa_hook *listener,
121 const struct pw_link_events *events,
122 void *data);
123 };
124
125 #define pw_link_method(o,method,version,...) \
126 ({ \
127 int _res = -ENOTSUP; \
128 spa_interface_call_res((struct spa_interface*)o, \
129 struct pw_link_methods, _res, \
130 method, version, ##__VA_ARGS__); \
131 _res; \
132 })
133
134 #define pw_link_add_listener(c,...) pw_link_method(c,add_listener,0,__VA_ARGS__)
135
140 #ifdef __cplusplus
141 } /* extern "C" */
142 #endif
143
144 #endif /* PIPEWIRE_LINK_H */
defs.h
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:453
pw_link_info_free
void pw_link_info_free(struct pw_link_info *info)
Definition: introspect.c:491
pw_link_state
pw_link_state
The different link states.
Definition: link.h:58
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:64
PW_LINK_STATE_ACTIVE
@ PW_LINK_STATE_ACTIVE
the link is active
Definition: link.h:65
PW_LINK_STATE_ERROR
@ PW_LINK_STATE_ERROR
the link is in error
Definition: link.h:59
PW_LINK_STATE_UNLINKED
@ PW_LINK_STATE_UNLINKED
the link is unlinked
Definition: link.h:60
PW_LINK_STATE_PAUSED
@ PW_LINK_STATE_PAUSED
the link is paused
Definition: link.h:64
PW_LINK_STATE_NEGOTIATING
@ PW_LINK_STATE_NEGOTIATING
the link is negotiating formats
Definition: link.h:62
PW_LINK_STATE_INIT
@ PW_LINK_STATE_INIT
the link is initialized
Definition: link.h:61
PW_LINK_STATE_ALLOCATING
@ PW_LINK_STATE_ALLOCATING
the link is allocating buffers
Definition: link.h:63
hook.h
proxy.h
data
user data to add to an object
Definition: filter.c:75
pw_link_events
Link events.
Definition: link.h:100
pw_link_events::version
uint32_t version
Definition: link.h:102
pw_link_events::info
void(* info)(void *object, const struct pw_link_info *info)
Notify link info.
Definition: link.h:108
pw_link_info
The link information.
Definition: link.h:71
pw_link_info::output_port_id
uint32_t output_port_id
output port id
Definition: link.h:74
pw_link_info::id
uint32_t id
id of the global
Definition: link.h:72
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:73
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::props
struct spa_dict * props
the properties of the link
Definition: link.h:85
pw_link_info::input_node_id
uint32_t input_node_id
server side input node id
Definition: link.h:75
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:76
pw_link_methods
Link methods.
Definition: link.h:115
pw_link_methods::version
uint32_t version
Definition: link.h:117
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:119
spa_dict
Definition: utils/dict.h:48
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
spa_pod
Definition: pod/pod.h:50