PipeWire  0.3.30
client.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_CLIENT_H
26 #define PIPEWIRE_CLIENT_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/defs.h>
33 #include <spa/param/param.h>
34 
35 #include <pipewire/proxy.h>
36 #include <pipewire/permission.h>
37 
46 #define PW_TYPE_INTERFACE_Client PW_TYPE_INFO_INTERFACE_BASE "Client"
47 
48 #define PW_VERSION_CLIENT 3
49 struct pw_client;
50 
51 /* default ID of the current client after connect */
52 #define PW_ID_CLIENT 1
53 
56  uint32_t id;
57 #define PW_CLIENT_CHANGE_MASK_PROPS (1 << 0)
58 #define PW_CLIENT_CHANGE_MASK_ALL ((1 << 1)-1)
59  uint64_t change_mask;
60  struct spa_dict *props;
61 };
62 
64 struct pw_client_info *
66  const struct pw_client_info *update);
67 
69 void pw_client_info_free(struct pw_client_info *info);
70 
71 
72 #define PW_CLIENT_EVENT_INFO 0
73 #define PW_CLIENT_EVENT_PERMISSIONS 1
74 #define PW_CLIENT_EVENT_NUM 2
75 
78 #define PW_VERSION_CLIENT_EVENTS 0
79  uint32_t version;
85  void (*info) (void *object, const struct pw_client_info *info);
96  void (*permissions) (void *object,
97  uint32_t index,
98  uint32_t n_permissions,
99  const struct pw_permission *permissions);
100 };
101 
102 
103 #define PW_CLIENT_METHOD_ADD_LISTENER 0
104 #define PW_CLIENT_METHOD_ERROR 1
105 #define PW_CLIENT_METHOD_UPDATE_PROPERTIES 2
106 #define PW_CLIENT_METHOD_GET_PERMISSIONS 3
107 #define PW_CLIENT_METHOD_UPDATE_PERMISSIONS 4
108 #define PW_CLIENT_METHOD_NUM 5
109 
112 #define PW_VERSION_CLIENT_METHODS 0
113  uint32_t version;
114 
115  int (*add_listener) (void *object,
116  struct spa_hook *listener,
117  const struct pw_client_events *events,
118  void *data);
126  int (*error) (void *object, uint32_t id, int res, const char *message);
132  int (*update_properties) (void *object, const struct spa_dict *props);
133 
142  int (*get_permissions) (void *object, uint32_t index, uint32_t num);
156  int (*update_permissions) (void *object, uint32_t n_permissions,
157  const struct pw_permission *permissions);
158 };
159 
160 #define pw_client_method(o,method,version,...) \
161 ({ \
162  int _res = -ENOTSUP; \
163  spa_interface_call_res((struct spa_interface*)o, \
164  struct pw_client_methods, _res, \
165  method, version, ##__VA_ARGS__); \
166  _res; \
167 })
168 
169 #define pw_client_add_listener(c,...) pw_client_method(c,add_listener,0,__VA_ARGS__)
170 #define pw_client_error(c,...) pw_client_method(c,error,0,__VA_ARGS__)
171 #define pw_client_update_properties(c,...) pw_client_method(c,update_properties,0,__VA_ARGS__)
172 #define pw_client_get_permissions(c,...) pw_client_method(c,get_permissions,0,__VA_ARGS__)
173 #define pw_client_update_permissions(c,...) pw_client_method(c,update_permissions,0,__VA_ARGS__)
174 
179 #ifdef __cplusplus
180 } /* extern "C" */
181 #endif
182 
183 #endif /* PIPEWIRE_CLIENT_H */
data
Definition: filter.c:75
pw_client_methods::version
uint32_t version
Definition: client.h:113
pw_permission
Definition: permission.h:64
res
static uint32_t int int res
Definition: core.h:329
pw_client_info::id
uint32_t id
id of the global
Definition: client.h:56
permission.h
pw_client_events::info
void(* info)(void *object, const struct pw_client_info *info)
Notify client info.
Definition: client.h:85
pw_client_info_update
struct pw_client_info * pw_client_info_update(struct pw_client_info *info, const struct pw_client_info *update)
Update and existing pw_client_info with update.
Definition: introspect.c:421
id
static uint32_t id
Definition: core.h:328
pw_client_events::version
uint32_t version
Definition: client.h:79
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
pw_permission::permissions
uint32_t permissions
bitmask of above permissions
Definition: permission.h:66
pw_client_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: client.h:59
pw_client_methods::error
int(* error)(void *object, uint32_t id, int res, const char *message)
Send an error to a client.
Definition: client.h:126
pw_client_info
The client information.
Definition: client.h:55
pw_client_events::permissions
void(* permissions)(void *object, uint32_t index, uint32_t n_permissions, const struct pw_permission *permissions)
Notify a client permission.
Definition: client.h:96
param.h
pw_client_info::props
struct spa_dict * props
extra properties
Definition: client.h:60
spa_dict
Definition: utils/dict.h:48
pw_client_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_client_events *events, void *data)
Definition: client.h:115
proxy.h
pw_client_info_free
void pw_client_info_free(struct pw_client_info *info)
Free a pw_client_info.
Definition: introspect.c:445
pw_client_methods
Client methods.
Definition: client.h:111
message
static uint32_t int int const char * message
Definition: core.h:329
pw_client_events
Client events.
Definition: client.h:77
defs.h
pw_client_methods::update_properties
int(* update_properties)(void *object, const struct spa_dict *props)
Update client properties.
Definition: client.h:132
pw_client_methods::get_permissions
int(* get_permissions)(void *object, uint32_t index, uint32_t num)
Get client permissions.
Definition: client.h:142
pw_client_methods::update_permissions
int(* update_permissions)(void *object, uint32_t n_permissions, const struct pw_permission *permissions)
Manage the permissions of the global objects for this client.
Definition: client.h:156