PipeWire  0.3.67
resource.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_RESOURCE_H
6 #define PIPEWIRE_RESOURCE_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #include <spa/utils/hook.h>
13 
35 struct pw_resource;
36 
37 #include <pipewire/impl-client.h>
38 
40 struct pw_resource_events {
41 #define PW_VERSION_RESOURCE_EVENTS 0
42  uint32_t version;
43 
45  void (*destroy) (void *data);
46 
48  void (*pong) (void *data, int seq);
49 
51  void (*error) (void *data, int seq, int res, const char *message);
52 };
53 
55 struct pw_resource *
56 pw_resource_new(struct pw_impl_client *client,
57  uint32_t id,
58  uint32_t permissions,
59  const char *type,
60  uint32_t version,
61  size_t user_data_size );
62 
64 void pw_resource_destroy(struct pw_resource *resource);
65 
68 void pw_resource_remove(struct pw_resource *resource);
69 
71 struct pw_impl_client *pw_resource_get_client(struct pw_resource *resource);
72 
74 uint32_t pw_resource_get_id(struct pw_resource *resource);
75 
77 uint32_t pw_resource_get_permissions(struct pw_resource *resource);
78 
80 const char *pw_resource_get_type(struct pw_resource *resource, uint32_t *version);
81 
83 struct pw_protocol *pw_resource_get_protocol(struct pw_resource *resource);
84 
86 void *pw_resource_get_user_data(struct pw_resource *resource);
87 
89 void pw_resource_add_listener(struct pw_resource *resource,
90  struct spa_hook *listener,
91  const struct pw_resource_events *events,
92  void *data);
93 
95 void pw_resource_add_object_listener(struct pw_resource *resource,
96  struct spa_hook *listener,
97  const void *funcs,
98  void *data);
99 
102 int pw_resource_ping(struct pw_resource *resource, int seq);
103 
105 void pw_resource_ref(struct pw_resource *resource);
106 void pw_resource_unref(struct pw_resource *resource);
107 
109 int pw_resource_set_bound_id(struct pw_resource *resource, uint32_t global_id);
110 
112 uint32_t pw_resource_get_bound_id(struct pw_resource *resource);
113 
115 void pw_resource_error(struct pw_resource *resource, int res, const char *error);
116 void pw_resource_errorf(struct pw_resource *resource, int res, const char *error, ...) SPA_PRINTF_FUNC(3, 4);
117 void pw_resource_errorf_id(struct pw_resource *resource, uint32_t id, int res, const char *error, ...) SPA_PRINTF_FUNC(4, 5);
118 
121 
124 
126 int pw_resource_install_marshal(struct pw_resource *resource, bool implementor);
127 
128 #define pw_resource_notify(r,type,event,version,...) \
129  spa_hook_list_call(pw_resource_get_object_listeners(r), \
130  type, event, version, ## __VA_ARGS__)
131 
132 #define pw_resource_call(r,type,method,version,...) \
133  spa_interface_call((struct spa_interface*)r, \
134  type, method, version, ##__VA_ARGS__)
135 
136 #define pw_resource_call_res(r,type,method,version,...) \
137 ({ \
138  int _res = -ENOTSUP; \
139  spa_interface_call_res((struct spa_interface*)r, \
140  type, _res, method, version, ##__VA_ARGS__); \
141  _res; \
142 })
143 
144 
150 #ifdef __cplusplus
151 }
152 #endif
153 
154 #endif /* PIPEWIRE_RESOURCE_H */
void pw_resource_unref(struct pw_resource *resource)
Definition: resource.c:271
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:148
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:327
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:110
uint32_t pw_resource_get_permissions(struct pw_resource *resource)
Get the permissions of this resource.
Definition: resource.c:122
int pw_resource_install_marshal(struct pw_resource *resource, bool implementor)
install a marshal function on a resource
Definition: resource.c:88
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:205
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:128
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:166
void pw_resource_error(struct pw_resource *resource, int res, const char *error)
Generate an error for a resource.
Definition: resource.c:250
int pw_resource_ping(struct pw_resource *resource, int seq)
Generate an ping event for a resource.
Definition: resource.c:178
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:157
void pw_resource_ref(struct pw_resource *resource)
ref/unref a resource, Since 0.3.52
Definition: resource.c:264
const struct pw_protocol_marshal * pw_resource_get_marshal(struct pw_resource *resource)
Get the marshal functions for the resource.
Definition: resource.c:172
void pw_resource_destroy(struct pw_resource *resource)
Destroy a resource.
Definition: resource.c:302
struct pw_protocol * pw_resource_get_protocol(struct pw_resource *resource)
Get the protocol used for this resource.
Definition: resource.c:136
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:142
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:25
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:192
uint32_t pw_resource_get_id(struct pw_resource *resource)
Get the unique id of this resource.
Definition: resource.c:116
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:273
spa/utils/hook.h
pipewire/impl-client.h
Definition: protocol.h:77
Resource events.
Definition: resource.h:45
void(* destroy)(void *data)
The resource is destroyed.
Definition: resource.h:51
void(* pong)(void *data, int seq)
a reply to a ping event completed
Definition: resource.h:54
uint32_t version
Definition: resource.h:48
void(* error)(void *data, int seq, int res, const char *message)
an error occurred on the resource
Definition: resource.h:57
Definition: impl.h:29
A list of hooks.
Definition: hook.h:320
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:331