PipeWire  0.3.59
resource.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_RESOURCE_H
26 #define PIPEWIRE_RESOURCE_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/hook.h>
33 
55 struct pw_resource;
56 
57 #include <pipewire/impl-client.h>
58 
60 struct pw_resource_events {
61 #define PW_VERSION_RESOURCE_EVENTS 0
62  uint32_t version;
63 
65  void (*destroy) (void *data);
66 
68  void (*pong) (void *data, int seq);
69 
71  void (*error) (void *data, int seq, int res, const char *message);
72 };
73 
75 struct pw_resource *
76 pw_resource_new(struct pw_impl_client *client,
77  uint32_t id,
78  uint32_t permissions,
79  const char *type,
80  uint32_t version,
81  size_t user_data_size );
82 
84 void pw_resource_destroy(struct pw_resource *resource);
85 
88 void pw_resource_remove(struct pw_resource *resource);
89 
91 struct pw_impl_client *pw_resource_get_client(struct pw_resource *resource);
92 
94 uint32_t pw_resource_get_id(struct pw_resource *resource);
95 
97 uint32_t pw_resource_get_permissions(struct pw_resource *resource);
98 
100 const char *pw_resource_get_type(struct pw_resource *resource, uint32_t *version);
101 
103 struct pw_protocol *pw_resource_get_protocol(struct pw_resource *resource);
104 
106 void *pw_resource_get_user_data(struct pw_resource *resource);
107 
109 void pw_resource_add_listener(struct pw_resource *resource,
110  struct spa_hook *listener,
111  const struct pw_resource_events *events,
112  void *data);
113 
115 void pw_resource_add_object_listener(struct pw_resource *resource,
116  struct spa_hook *listener,
117  const void *funcs,
118  void *data);
119 
122 int pw_resource_ping(struct pw_resource *resource, int seq);
123 
125 void pw_resource_ref(struct pw_resource *resource);
126 void pw_resource_unref(struct pw_resource *resource);
127 
129 int pw_resource_set_bound_id(struct pw_resource *resource, uint32_t global_id);
130 
132 uint32_t pw_resource_get_bound_id(struct pw_resource *resource);
133 
135 void pw_resource_error(struct pw_resource *resource, int res, const char *error);
136 void pw_resource_errorf(struct pw_resource *resource, int res, const char *error, ...) SPA_PRINTF_FUNC(3, 4);
137 void pw_resource_errorf_id(struct pw_resource *resource, uint32_t id, int res, const char *error, ...) SPA_PRINTF_FUNC(4, 5);
138 
141 
144 
146 int pw_resource_install_marshal(struct pw_resource *resource, bool implementor);
147 
148 #define pw_resource_notify(r,type,event,version,...) \
149  spa_hook_list_call(pw_resource_get_object_listeners(r), \
150  type, event, version, ## __VA_ARGS__)
151 
152 #define pw_resource_call(r,type,method,version,...) \
153  spa_interface_call((struct spa_interface*)r, \
154  type, method, version, ##__VA_ARGS__)
155 
156 #define pw_resource_call_res(r,type,method,version,...) \
157 ({ \
158  int _res = -ENOTSUP; \
159  spa_interface_call_res((struct spa_interface*)r, \
160  type, _res, method, version, ##__VA_ARGS__); \
161  _res; \
162 })
163 
164 
170 #ifdef __cplusplus
171 }
172 #endif
173 
174 #endif /* PIPEWIRE_RESOURCE_H */
void pw_resource_unref(struct pw_resource *resource)
Definition: resource.c:291
void pw_resource_add_listener(struct pw_resource *resource, struct spa_hook *listener, const struct pw_resource_events *events, void *data)
Add an event listener.
Definition: resource.c:168
void pw_resource_remove(struct pw_resource *resource)
Remove a resource, like pw_resource_destroy but without sending a remove_id message to the client.
Definition: resource.c:347
void void pw_resource_errorf_id(struct pw_resource *resource, uint32_t id, int res, const char *error,...) 1(4
struct pw_impl_client * pw_resource_get_client(struct pw_resource *resource)
Get the client owning this resource.
Definition: resource.c:130
uint32_t pw_resource_get_permissions(struct pw_resource *resource)
Get the permissions of this resource.
Definition: resource.c:142
int pw_resource_install_marshal(struct pw_resource *resource, bool implementor)
install a marshal function on a resource
Definition: resource.c:108
uint32_t pw_resource_get_bound_id(struct pw_resource *resource)
Get the global id this resource is bound to or SPA_ID_INVALID when not bound.
Definition: resource.c:225
void pw_resource_errorf(struct pw_resource *resource, int res, const char *error,...) 1(3
const char * pw_resource_get_type(struct pw_resource *resource, uint32_t *version)
Get the type and optionally the version of this resource.
Definition: resource.c:148
void void struct spa_hook_list * pw_resource_get_object_listeners(struct pw_resource *resource)
Get the list of object listeners from a resource.
Definition: resource.c:186
void pw_resource_error(struct pw_resource *resource, int res, const char *error)
Generate an error for a resource.
Definition: resource.c:270
int pw_resource_ping(struct pw_resource *resource, int seq)
Generate an ping event for a resource.
Definition: resource.c:198
void pw_resource_add_object_listener(struct pw_resource *resource, struct spa_hook *listener, const void *funcs, void *data)
Set the resource implementation.
Definition: resource.c:177
void pw_resource_ref(struct pw_resource *resource)
ref/unref a resource, Since 0.3.52
Definition: resource.c:284
const struct pw_protocol_marshal * pw_resource_get_marshal(struct pw_resource *resource)
Get the marshal functions for the resource.
Definition: resource.c:192
void pw_resource_destroy(struct pw_resource *resource)
Destroy a resource.
Definition: resource.c:322
struct pw_protocol * pw_resource_get_protocol(struct pw_resource *resource)
Get the protocol used for this resource.
Definition: resource.c:156
void * pw_resource_get_user_data(struct pw_resource *resource)
Get the user data for the resource, the size was given in pw_resource_new.
Definition: resource.c:162
struct pw_resource * pw_resource_new(struct pw_impl_client *client, uint32_t id, uint32_t permissions, const char *type, uint32_t version, size_t user_data_size)
Make a new resource for client.
Definition: resource.c:45
int pw_resource_set_bound_id(struct pw_resource *resource, uint32_t global_id)
Notify global id this resource is bound to.
Definition: resource.c:212
uint32_t pw_resource_get_id(struct pw_resource *resource)
Get the unique id of this resource.
Definition: resource.c:136
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:289
spa/utils/hook.h
pipewire/impl-client.h
Definition: protocol.h:97
Resource events.
Definition: resource.h:65
void(* destroy)(void *data)
The resource is destroyed.
Definition: resource.h:71
void(* pong)(void *data, int seq)
a reply to a ping event completed
Definition: resource.h:74
uint32_t version
Definition: resource.h:68
void(* error)(void *data, int seq, int res, const char *message)
an error occurred on the resource
Definition: resource.h:77
Definition: impl.h:49
A list of hooks.
Definition: hook.h:340
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351