Go to the documentation of this file.
25 #ifndef PIPEWIRE_CORE_H
26 #define PIPEWIRE_CORE_H
35 #include <spa/utils/hook.h>
37 #define PW_TYPE_INTERFACE_Core PW_TYPE_INFO_INTERFACE_BASE "Core"
38 #define PW_TYPE_INTERFACE_Registry PW_TYPE_INFO_INTERFACE_BASE "Registry"
40 #define PW_VERSION_CORE 3
42 #define PW_VERSION_REGISTRY 3
49 #define PW_ID_ANY (uint32_t)(0xffffffff)
59 #define PW_CORE_CHANGE_MASK_PROPS (1 << 0)
60 #define PW_CORE_CHANGE_MASK_ALL ((1 << 1)-1)
88 #define PW_CORE_EVENT_INFO 0
89 #define PW_CORE_EVENT_DONE 1
90 #define PW_CORE_EVENT_PING 2
91 #define PW_CORE_EVENT_ERROR 3
92 #define PW_CORE_EVENT_REMOVE_ID 4
93 #define PW_CORE_EVENT_BOUND_ID 5
94 #define PW_CORE_EVENT_ADD_MEM 6
95 #define PW_CORE_EVENT_REMOVE_MEM 7
96 #define PW_CORE_EVENT_NUM 8
103 #define PW_VERSION_CORE_EVENTS 0
173 void (*
bound_id) (
void *object, uint32_t
id, uint32_t global_id);
189 void (*
add_mem) (
void *object, uint32_t
id, uint32_t type,
int fd, uint32_t flags);
199 #define PW_CORE_METHOD_ADD_LISTENER 0
200 #define PW_CORE_METHOD_HELLO 1
201 #define PW_CORE_METHOD_SYNC 2
202 #define PW_CORE_METHOD_PONG 3
203 #define PW_CORE_METHOD_ERROR 4
204 #define PW_CORE_METHOD_GET_REGISTRY 5
205 #define PW_CORE_METHOD_CREATE_OBJECT 6
206 #define PW_CORE_METHOD_DESTROY 7
207 #define PW_CORE_METHOD_NUM 8
218 #define PW_VERSION_CORE_METHODS 0
222 struct spa_hook *listener,
276 struct pw_registry * (*get_registry) (
void *object, uint32_t
version,
277 size_t user_data_size);
288 void * (*create_object) (
void *object,
289 const char *factory_name,
292 const struct spa_dict *props,
293 size_t user_data_size);
304 #define pw_core_method(o,method,version,...) \
306 int _res = -ENOTSUP; \
307 spa_interface_call_res((struct spa_interface*)o, \
308 struct pw_core_methods, _res, \
309 method, version, ##__VA_ARGS__); \
313 #define pw_core_add_listener(c,...) pw_core_method(c,add_listener,0,__VA_ARGS__)
314 #define pw_core_hello(c,...) pw_core_method(c,hello,0,__VA_ARGS__)
315 #define pw_core_sync(c,...) pw_core_method(c,sync,0,__VA_ARGS__)
316 #define pw_core_pong(c,...) pw_core_method(c,pong,0,__VA_ARGS__)
317 #define pw_core_error(c,...) pw_core_method(c,error,0,__VA_ARGS__)
321 SPA_PRINTF_FUNC(5, 0) int
322 pw_core_errorv(struct pw_core *core, uint32_t
id,
int seq,
332 SPA_PRINTF_FUNC(5, 6) int
333 pw_core_errorf(struct pw_core *core, uint32_t
id,
int seq,
344 static inline struct pw_registry *
345 pw_core_get_registry(
struct pw_core *core, uint32_t version,
size_t user_data_size)
347 struct pw_registry *
res = NULL;
348 spa_interface_call_res((
struct spa_interface*)core,
350 get_registry, 0, version, user_data_size);
355 pw_core_create_object(
struct pw_core *core,
356 const char *factory_name,
359 const struct spa_dict *props,
360 size_t user_data_size)
363 spa_interface_call_res((
struct spa_interface*)core,
365 create_object, 0, factory_name,
366 type, version, props, user_data_size);
370 #define pw_core_destroy(c,...) pw_core_method(c,destroy,0,__VA_ARGS__)
404 #define PW_REGISTRY_EVENT_GLOBAL 0
405 #define PW_REGISTRY_EVENT_GLOBAL_REMOVE 1
406 #define PW_REGISTRY_EVENT_NUM 2
410 #define PW_VERSION_REGISTRY_EVENTS 0
425 uint32_t permissions,
const char *type, uint32_t
version,
426 const struct spa_dict *props);
439 #define PW_REGISTRY_METHOD_ADD_LISTENER 0
440 #define PW_REGISTRY_METHOD_BIND 1
441 #define PW_REGISTRY_METHOD_DESTROY 2
442 #define PW_REGISTRY_METHOD_NUM 3
446 #define PW_VERSION_REGISTRY_METHODS 0
450 struct spa_hook *listener,
465 void * (*bind) (
void *object, uint32_t
id,
const char *type, uint32_t
version,
466 size_t use_data_size);
478 #define pw_registry_method(o,method,version,...) \
480 int _res = -ENOTSUP; \
481 spa_interface_call_res((struct spa_interface*)o, \
482 struct pw_registry_methods, _res, \
483 method, version, ##__VA_ARGS__); \
488 #define pw_registry_add_listener(p,...) pw_registry_method(p,add_listener,0,__VA_ARGS__)
491 pw_registry_bind(
struct pw_registry *
registry,
492 uint32_t
id,
const char *type, uint32_t
version,
493 size_t user_data_size)
496 spa_interface_call_res((
struct spa_interface*)
registry,
498 bind, 0,
id, type,
version, user_data_size);
502 #define pw_registry_destroy(p,...) pw_registry_method(p,destroy,0,__VA_ARGS__)
512 size_t user_data_size );
523 size_t user_data_size );
531 size_t user_data_size );
572 const struct spa_dict *props,
574 size_t user_data_size );
static uint32_t int int res
Definition: core.h:323
#define PW_VERSION_CLIENT
Definition: client.h:40
struct pw_mempool * pool
owner pool
Definition: mem.h:65
void(* remove_mem)(void *object, uint32_t id)
Remove memory for a client.
Definition: core.h:196
SPA_EXPORT struct pw_client * pw_core_get_client(struct pw_core *core)
Get the client proxy of the connected core.
Definition: core.c:230
static uint32_t id
Definition: core.h:322
#define PW_KEY_REMOTE_NAME
The name of the remote to connect to, default env(PIPEWIRE_REMOTE) or pipewire-0.
Definition: keys.h:89
SPA_EXPORT struct pw_core * pw_context_connect_fd(struct pw_context *context, int fd, struct pw_properties *properties, size_t user_data_size)
Definition: core.c:394
data for registering export functions
Definition: context.h:165
static void * pw_map_lookup(struct pw_map *map, uint32_t id)
Find an item in the map.
Definition: map.h:169
const char * type
Definition: context.h:167
uint32_t version
Definition: core.h:411
uint32_t id
unique id
Definition: mem.h:66
PipeWire filter object class.
#define pw_log_error(...)
struct pw_protocol * pw_context_find_protocol(struct pw_context *context, const char *name)
Definition: protocol.c:176
The core information.
Definition: core.h:52
#define pw_protocol_new_client(p,...)
Definition: protocol.h:112
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:167
int(* destroy)(void *object, uint32_t id)
Attempt to destroy a global object.
Definition: core.h:475
void(* add_mem)(void *object, uint32_t id, uint32_t type, int fd, uint32_t flags)
Add memory for a client.
Definition: core.h:189
#define pw_client_update_properties(c,...)
Definition: client.h:163
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition: map.h:76
int(* hello)(void *object, uint32_t version)
Start a conversation with the server.
Definition: core.h:230
void(* error)(void *object, uint32_t id, int seq, int res, const char *message)
Fatal error event.
Definition: core.h:149
Manages protocols and their implementation.
struct pw_context * pw_core_get_context(struct pw_core *core)
Get the context object used to created this core.
Definition: core.c:133
uint32_t version
Definition: core.h:104
int pw_core_disconnect(struct pw_core *core)
disconnect and destroy a core
Definition: core.c:449
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition: mem.h:68
#define PW_VERSION_CORE
Definition: core.h:40
int pw_proxy_set_bound_id(struct pw_proxy *proxy, uint32_t global_id)
Set the global id this proxy is bound to.
Definition: proxy.c:160
SPA_EXPORT void pw_proxy_destroy(struct pw_proxy *proxy)
Destroy a proxy object.
Definition: proxy.c:231
struct pw_mempool * pw_core_get_mempool(struct pw_core *core)
Get the core mempool object.
Definition: core.c:443
#define pw_core_pong(c,...)
Definition: core.h:316
struct pw_core_info * pw_core_info_update(struct pw_core_info *info, const struct pw_core_info *update)
Update and existing pw_core_info with update.
Definition: introspect.c:127
const char * user_name
name of the user that started the core
Definition: core.h:55
Proxy events, use pw_proxy_add_listener.
Definition: proxy.h:106
#define pw_protocol_client_connect(c, p, cb, d)
Definition: protocol.h:60
SPA_EXPORT struct pw_proxy * pw_proxy_new(struct pw_proxy *factory, const char *type, uint32_t version, size_t user_data_size)
Create a proxy object with a given id and type.
Definition: proxy.c:91
const char * version
version of the core
Definition: core.h:57
static uint32_t int int const char int r
Definition: core.h:335
const struct pw_export_type * pw_context_find_export_type(struct pw_context *context, const char *type)
find information about registered export type
void(* bound_id)(void *object, uint32_t id, uint32_t global_id)
Notify an object binding.
Definition: core.h:173
SPA_EXPORT int pw_core_update_properties(struct pw_core *core, const struct spa_dict *dict)
Update the core properties.
Definition: core.c:145
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
SPA_EXPORT int pw_core_set_paused(struct pw_core *core, bool paused)
Pause or resume the core.
Definition: core.c:437
const char * host_name
name of the machine the core is running on
Definition: core.h:56
int pw_core_set_paused(struct pw_core *core, bool paused)
Pause or resume the core.
Definition: core.c:437
SPA_EXPORT struct pw_proxy * pw_core_find_proxy(struct pw_core *core, uint32_t id)
Get the proxy with the given id.
Definition: core.c:236
static int pw_map_for_each(struct pw_map *map, int(*func)(void *item_data, void *data), void *data)
Iterate all map items.
Definition: map.h:188
void pw_proxy_remove(struct pw_proxy *proxy)
called when cleaning up or when the server removed the resource.
Definition: proxy.c:263
Registry events.
Definition: core.h:409
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_core_events *events, void *data)
Definition: core.h:221
#define PW_VERSION_PROXY_EVENTS
Definition: proxy.h:107
int pw_core_update_properties(struct pw_core *core, const struct spa_dict *dict)
Update the core properties.
Definition: core.c:145
int(* error)(void *object, uint32_t id, int seq, int res, const char *message)
Fatal error event.
Definition: core.h:267
int(* pong)(void *object, uint32_t id, int seq)
Reply to a server ping event.
Definition: core.h:250
int(* sync)(void *object, uint32_t id, int seq)
Do server roundtrip.
Definition: core.h:242
void * pw_core_get_user_data(struct pw_core *core)
Get the user_data.
Definition: core.c:163
#define pw_core_error(c,...)
Definition: core.h:317
int fd
fd
Definition: mem.h:70
uint64_t change_mask
bitfield of changed fields since last call
Definition: core.h:61
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_registry_events *events, void *data)
Definition: core.h:449
#define pw_protocol_client_disconnect(c)
Definition: protocol.h:63
void(* info)(void *object, const struct pw_core_info *info)
Notify new core info.
Definition: core.h:114
static uint32_t int int const char * message
Definition: core.h:323
#define pw_log_debug(...)
struct spa_dict * props
extra properties
Definition: core.h:62
SPA_EXPORT struct pw_core * pw_context_connect_self(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Definition: core.c:417
Represents an object on the client side.
struct pw_memblock * pw_mempool_import(struct pw_mempool *pool, enum pw_memblock_flags flags, uint32_t type, int fd)
Import an fd into the pool.
Definition: mem.c:533
SPA_EXPORT int pw_core_steal_fd(struct pw_core *core)
Steal the fd of the core connection or < 0 on error.
Definition: core.c:431
#define PW_TYPE_INTERFACE_Core
Definition: core.h:37
int(* destroy)(void *object, void *proxy)
Destroy an resource.
Definition: core.h:301
SPA_EXPORT int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition: properties.c:258
#define pw_core_add_listener(c,...)
Definition: core.h:313
#define pw_protocol_client_set_paused(c, p)
Definition: protocol.h:65
struct pw_proxy * pw_core_export(struct pw_core *core, const char *type, const struct spa_dict *props, void *object, size_t user_data_size)
Export an object into the PipeWire instance associated with core.
Definition: core.c:242
Core methods.
Definition: core.h:217
struct pw_proxy * pw_core_find_proxy(struct pw_core *core, uint32_t id)
Get the proxy with the given id.
Definition: core.c:236
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:87
void pw_core_info_free(struct pw_core_info *info)
Free a pw_core_info.
Definition: introspect.c:156
void(* global_remove)(void *object, uint32_t id)
Notify of a global object removal.
Definition: core.h:436
int pw_core_steal_fd(struct pw_core *core)
Steal the fd of the core connection or < 0 on error.
Definition: core.c:431
int pw_proxy_errorf(struct pw_proxy *proxy, int res, const char *error,...) SPA_PRINTF_FUNC(3
#define NAME
Definition: core.c:40
SPA_EXPORT struct pw_context * pw_core_get_context(struct pw_core *core)
Get the context object used to created this core.
Definition: core.c:133
static uint32_t int int const char va_list args
Definition: core.h:324
#define PW_VERSION_CORE_EVENTS
Definition: core.h:103
uint32_t version
Definition: core.h:219
SPA_EXPORT int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:395
vsnprintf(buffer, sizeof(buffer), message, args)
#define pw_core_hello(c,...)
Definition: core.h:314
#define pw_log_trace(...)
const struct pw_properties * pw_core_get_properties(struct pw_core *core)
Get properties from the core.
Definition: core.c:139
#define pw_protocol_client_steal_fd(c)
Definition: protocol.h:62
struct pw_proxy *(* func)(struct pw_core *core, const char *type, const struct spa_dict *props, void *object, size_t user_data_size)
Definition: context.h:168
void pw_proxy_add_listener(struct pw_proxy *proxy, struct spa_hook *listener, const struct pw_proxy_events *events, void *data)
Add an event listener to proxy.
Definition: proxy.c:196
SPA_EXPORT const char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:451
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream.
Definition: stream.c:1559
int pw_proxy_init(struct pw_proxy *proxy, const char *type, uint32_t version)
Definition: proxy.c:43
const char * name
name of the core
Definition: core.h:58
#define pw_protocol_client_connect_fd(c, fd, cl)
Definition: protocol.h:61
uint32_t cookie
a random cookie for identifying this instance of PipeWire
Definition: core.h:54
Definition: pipewire.c:66
#define PW_TYPE_INTERFACE_Client
Definition: client.h:38
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:133
SPA_EXPORT int pw_properties_add(struct pw_properties *props, const struct spa_dict *dict)
Add properties.
Definition: properties.c:281
SPA_EXPORT struct pw_mempool * pw_core_get_mempool(struct pw_core *core)
Get the core mempool object.
Definition: core.c:443
int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
Remove a memblock for given id.
Definition: mem.c:626
Registry methods.
Definition: core.h:445
void(* done)(void *object, uint32_t id, int seq)
Emit a done event.
Definition: core.h:123
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1225
SPA_EXPORT void * pw_core_get_user_data(struct pw_core *core)
Get the user_data.
Definition: core.c:163
void(* remove_id)(void *object, uint32_t id)
Remove an object ID.
Definition: core.h:161
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter.
Definition: filter.c:1075
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:95
SPA_EXPORT const struct pw_properties * pw_core_get_properties(struct pw_core *core)
Get properties from the core.
Definition: core.c:139
static uint32_t int seq
Definition: core.h:322
PipeWire stream object class.
void(* global)(void *object, uint32_t id, uint32_t permissions, const char *type, uint32_t version, const struct spa_dict *props)
Notify of a new global object.
Definition: core.h:424
void(* ping)(void *object, uint32_t id, int seq)
Emit a ping event.
Definition: core.h:130
struct pw_client * pw_core_get_client(struct pw_core *core)
Get the client proxy of the connected core.
Definition: core.c:230
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter.
Definition: filter.c:1262
uint32_t id
id of the global
Definition: core.h:53
uint32_t type
type of the fd, one of enum spa_data_type
Definition: mem.h:69
#define pw_protocol_client_destroy(c)
Definition: protocol.h:64
SPA_EXPORT struct pw_core * pw_context_connect(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Definition: core.c:369
SPA_EXPORT struct pw_proxy * pw_core_export(struct pw_core *core, const char *type, const struct spa_dict *props, void *object, size_t user_data_size)
Export an object into the PipeWire instance associated with core.
Definition: core.c:242
SPA_EXPORT int pw_core_disconnect(struct pw_core *core)
disconnect and destroy a core
Definition: core.c:449
A collection of key/value pairs.
Definition: properties.h:45
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:330
#define PW_KEY_PROTOCOL
The protocol key is usually set on a pw_client and contains a string describing the protocol used by ...
Definition: keys.h:54
Core events.
Definition: core.h:102
uint32_t version
Definition: core.h:447