5 #ifndef PIPEWIRE_CORE_H 6 #define PIPEWIRE_CORE_H 34 #define PW_TYPE_INTERFACE_Core PW_TYPE_INFO_INTERFACE_BASE "Core" 35 #define PW_TYPE_INTERFACE_Registry PW_TYPE_INFO_INTERFACE_BASE "Registry" 37 #define PW_VERSION_CORE 3 39 #define PW_VERSION_REGISTRY 3 43 #define PW_DEFAULT_REMOTE "pipewire-0" 49 #define PW_ID_ANY (uint32_t)(0xffffffff) 60 #define PW_CORE_CHANGE_MASK_PROPS (1 << 0) 61 #define PW_CORE_CHANGE_MASK_ALL ((1 << 1)-1) 83 #define PW_CORE_EVENT_INFO 0 84 #define PW_CORE_EVENT_DONE 1 85 #define PW_CORE_EVENT_PING 2 86 #define PW_CORE_EVENT_ERROR 3 87 #define PW_CORE_EVENT_REMOVE_ID 4 88 #define PW_CORE_EVENT_BOUND_ID 5 89 #define PW_CORE_EVENT_ADD_MEM 6 90 #define PW_CORE_EVENT_REMOVE_MEM 7 91 #define PW_CORE_EVENT_NUM 8 97 #define PW_VERSION_CORE_EVENTS 0 117 void (*
done) (
void *data, uint32_t
id,
int seq);
124 void (*
ping) (
void *data, uint32_t
id,
int seq);
143 void (*
error) (
void *data, uint32_t
id,
int seq,
int res,
const char *message);
167 void (*
bound_id) (
void *data, uint32_t
id, uint32_t global_id);
183 void (*
add_mem) (
void *data, uint32_t
id, uint32_t type,
int fd, uint32_t flags);
193 #define PW_CORE_METHOD_ADD_LISTENER 0 194 #define PW_CORE_METHOD_HELLO 1 195 #define PW_CORE_METHOD_SYNC 2 196 #define PW_CORE_METHOD_PONG 3 197 #define PW_CORE_METHOD_ERROR 4 198 #define PW_CORE_METHOD_GET_REGISTRY 5 199 #define PW_CORE_METHOD_CREATE_OBJECT 6 200 #define PW_CORE_METHOD_DESTROY 7 201 #define PW_CORE_METHOD_NUM 8 212 #define PW_VERSION_CORE_METHODS 0 236 int (*
sync) (
void *object, uint32_t id,
int seq);
244 int (*
pong) (
void *object, uint32_t id,
int seq);
261 int (*
error) (
void *object, uint32_t id,
int seq,
int res,
const char *message);
271 size_t user_data_size);
282 void * (*create_object) (
void *object,
283 const char *factory_name,
287 size_t user_data_size);
295 int (*
destroy) (
void *object,
void *proxy);
298 #define pw_core_method(o,method,version,...) \ 300 int _res = -ENOTSUP; \ 301 spa_interface_call_res((struct spa_interface*)o, \ 302 struct pw_core_methods, _res, \ 303 method, version, ##__VA_ARGS__); \ 307 #define pw_core_add_listener(c,...) pw_core_method(c,add_listener,0,__VA_ARGS__) 308 #define pw_core_hello(c,...) pw_core_method(c,hello,0,__VA_ARGS__) 309 #define pw_core_sync(c,...) pw_core_method(c,sync,0,__VA_ARGS__) 310 #define pw_core_pong(c,...) pw_core_method(c,pong,0,__VA_ARGS__) 311 #define pw_core_error(c,...) pw_core_method(c,error,0,__VA_ARGS__) 317 int res, const
char *message, va_list args)
320 vsnprintf(buffer,
sizeof(buffer), message, args);
328 int res, const
char *message, ...)
332 va_start(args, message);
344 get_registry, 0, version, user_data_size);
350 const char *factory_name,
354 size_t user_data_size)
359 create_object, 0, factory_name,
360 type, version, props, user_data_size);
364 #define pw_core_destroy(c,...) pw_core_method(c,destroy,0,__VA_ARGS__) 405 #define PW_REGISTRY_EVENT_GLOBAL 0 406 #define PW_REGISTRY_EVENT_GLOBAL_REMOVE 1 407 #define PW_REGISTRY_EVENT_NUM 2 411 #define PW_VERSION_REGISTRY_EVENTS 0 425 void (*
global) (
void *data, uint32_t id,
426 uint32_t permissions,
const char *type, uint32_t
version,
440 #define PW_REGISTRY_METHOD_ADD_LISTENER 0 441 #define PW_REGISTRY_METHOD_BIND 1 442 #define PW_REGISTRY_METHOD_DESTROY 2 443 #define PW_REGISTRY_METHOD_NUM 3 447 #define PW_VERSION_REGISTRY_METHODS 0 466 void * (*bind) (
void *object, uint32_t id,
const char *type, uint32_t
version,
467 size_t use_data_size);
476 int (*
destroy) (
void *object, uint32_t id);
479 #define pw_registry_method(o,method,version,...) \ 481 int _res = -ENOTSUP; \ 482 spa_interface_call_res((struct spa_interface*)o, \ 483 struct pw_registry_methods, _res, \ 484 method, version, ##__VA_ARGS__); \ 489 #define pw_registry_add_listener(p,...) pw_registry_method(p,add_listener,0,__VA_ARGS__) 493 uint32_t
id,
const char *type, uint32_t
version,
494 size_t user_data_size)
499 bind, 0,
id, type,
version, user_data_size);
503 #define pw_registry_destroy(p,...) pw_registry_method(p,destroy,0,__VA_ARGS__) 527 size_t user_data_size);
543 size_t user_data_size);
556 size_t user_data_size);
599 size_t user_data_size );
#define spa_interface_call_res(iface, method_type, res, method, vers,...)
Invoke method named method in the callbacks on the given interface object.
Definition: hook.h:235
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_registry_events *events, void *data)
Definition: core.h:531
static int pw_core_errorf(struct pw_core *core, uint32_t id, int seq, int res, const char *message,...)
Definition: core.h:393
uint32_t version
Definition: core.h:488
Definition: properties.h:33
int pw_core_update_properties(struct pw_core *core, const struct spa_dict *dict)
Update the core properties.
Definition: core.c:124
uint64_t change_mask
bitfield of changed fields since last call
Definition: core.h:78
Core events.
Definition: core.h:121
struct pw_client * pw_core_get_client(struct pw_core *core)
Get the client proxy of the connected core.
Definition: core.c:243
const char * host_name
name of the machine the core is running on
Definition: core.h:71
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:331
Core methods.
Definition: core.h:246
struct spa_dict dict
dictionary of key/values
Definition: properties.h:34
int(* destroy)(void *object, void *proxy)
Destroy an resource.
Definition: core.h:331
uint32_t version
Definition: core.h:124
uint32_t cookie
a random cookie for identifying this instance of PipeWire
Definition: core.h:69
uint32_t id
id of the global
Definition: core.h:68
void(* global)(void *data, 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:501
The core information.
Definition: core.h:67
struct pw_core * pw_context_connect(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Connect to a PipeWire instance.
Definition: core.c:382
Registry events.
Definition: core.h:485
int(* error)(void *object, uint32_t id, int seq, int res, const char *message)
Fatal error event.
Definition: core.h:297
Definition: utils/dict.h:39
#define pw_core_error(c,...)
Definition: core.h:371
const char * version
version of the core
Definition: core.h:72
struct pw_mempool * pw_core_get_mempool(struct pw_core *core)
Get the core mempool object.
Definition: core.c:463
void(* add_mem)(void *data, uint32_t id, uint32_t type, int fd, uint32_t flags)
Add memory for a client.
Definition: core.h:209
int pw_core_steal_fd(struct pw_core *core)
Steal the fd of the core connection or < 0 on error.
Definition: core.c:448
struct pw_core * pw_context_connect_self(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Connect to a given PipeWire instance.
Definition: core.c:434
void(* global_remove)(void *data, uint32_t id)
Notify of a global object removal.
Definition: core.h:513
int pw_core_disconnect(struct pw_core *core)
disconnect and destroy a core
Definition: core.c:469
void(* info)(void *data, const struct pw_core_info *info)
Notify new core info.
Definition: core.h:134
int(* sync)(void *object, uint32_t id, int seq)
Do server roundtrip.
Definition: core.h:272
struct pw_context * pw_core_get_context(struct pw_core *core)
Get the context object used to created this core.
Definition: core.c:112
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:255
const char * user_name
name of the user that started the core
Definition: core.h:70
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_core_events *events, void *data)
Definition: core.h:251
uint32_t version
Definition: core.h:529
struct pw_proxy * pw_core_find_proxy(struct pw_core *core, uint32_t id)
Get the proxy with the given id.
Definition: core.c:249
int(* destroy)(void *object, uint32_t id)
Attempt to destroy a global object.
Definition: core.h:557
void pw_core_info_free(struct pw_core_info *info)
Free a pw_core_info.
Definition: introspect.c:145
int pw_core_set_paused(struct pw_core *core, bool paused)
Pause or resume the core.
Definition: core.c:456
Registry methods.
Definition: core.h:526
const struct pw_properties * pw_core_get_properties(struct pw_core *core)
Get properties from the core.
Definition: core.c:118
void(* error)(void *data, uint32_t id, int seq, int res, const char *message)
Fatal error event.
Definition: core.h:169
uint32_t version
Definition: core.h:249
static int pw_core_errorv(struct pw_core *core, uint32_t id, int seq, int res, const char *message, va_list args)
Definition: core.h:382
int(* pong)(void *object, uint32_t id, int seq)
Reply to a server ping event.
Definition: core.h:280
static void * pw_registry_bind(struct pw_registry *registry, uint32_t id, const char *type, uint32_t version, size_t user_data_size)
Definition: core.h:579
void(* bound_id)(void *data, uint32_t id, uint32_t global_id)
Notify an object binding.
Definition: core.h:193
struct pw_core_info * pw_core_info_update(struct pw_core_info *info, const struct pw_core_info *update)
Update an existing pw_core_info with update with reset.
Definition: introspect.c:138
static struct pw_registry * pw_core_get_registry(struct pw_core *core, uint32_t version, size_t user_data_size)
Definition: core.h:405
int(* hello)(void *object, uint32_t version)
Start a conversation with the server.
Definition: core.h:260
void(* remove_id)(void *data, uint32_t id)
Remove an object ID.
Definition: core.h:181
void(* done)(void *data, uint32_t id, int seq)
Emit a done event.
Definition: core.h:143
void * pw_core_get_user_data(struct pw_core *core)
Get the user_data.
Definition: core.c:142
A memory pool is a collection of pw_memblocks.
Definition: src/pipewire/mem.h:57
void(* ping)(void *data, uint32_t id, int seq)
Emit a ping event.
Definition: core.h:150
void(* remove_mem)(void *data, uint32_t id)
Remove memory for a client.
Definition: core.h:216
static void * pw_core_create_object(struct pw_core *core, const char *factory_name, const char *type, uint32_t version, const struct spa_dict *props, size_t user_data_size)
Definition: core.h:415
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:273
struct pw_core * pw_context_connect_fd(struct pw_context *context, int fd, struct pw_properties *properties, size_t user_data_size)
Connect to a PipeWire instance on the given socket.
Definition: core.c:409
struct pw_core_info * pw_core_info_merge(struct pw_core_info *info, const struct pw_core_info *update, bool reset)
Update an existing pw_core_info with update.
Definition: introspect.c:107