PipeWire  0.3.59
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,
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;
83  const char *error;
84  struct spa_pod *format;
85  struct spa_dict *props;
86 };
87 
88 struct pw_link_info *
90  const struct pw_link_info *update);
91 
92 struct pw_link_info *
93 pw_link_info_merge(struct pw_link_info *info,
94  const struct pw_link_info *update, bool reset);
95 
96 void
97 pw_link_info_free(struct pw_link_info *info);
98 
99 
100 #define PW_LINK_EVENT_INFO 0
101 #define PW_LINK_EVENT_NUM 1
102 
104 struct pw_link_events {
105 #define PW_VERSION_LINK_EVENTS 0
106  uint32_t version;
112  void (*info) (void *data, const struct pw_link_info *info);
113 };
114 
115 #define PW_LINK_METHOD_ADD_LISTENER 0
116 #define PW_LINK_METHOD_NUM 1
117 
120 #define PW_VERSION_LINK_METHODS 0
121  uint32_t version;
122 
123  int (*add_listener) (void *object,
124  struct spa_hook *listener,
125  const struct pw_link_events *events,
126  void *data);
127 };
128 
129 #define pw_link_method(o,method,version,...) \
130 ({ \
131  int _res = -ENOTSUP; \
132  spa_interface_call_res((struct spa_interface*)o, \
133  struct pw_link_methods, _res, \
134  method, version, ##__VA_ARGS__); \
135  _res; \
136 })
137 
138 #define pw_link_add_listener(c,...) pw_link_method(c,add_listener,0,__VA_ARGS__)
139 
144 #ifdef __cplusplus
145 } /* extern "C" */
146 #endif
147 
148 #endif /* PIPEWIRE_LINK_H */
spa/utils/defs.h
spa/utils/hook.h
pipewire/proxy.h
Definition: dict.h:59
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
Definition: pod.h:63