PipeWire  0.3.80
core.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_CORE_H
6 #define PIPEWIRE_CORE_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #include <stdarg.h>
13 #include <errno.h>
14 
15 #include <spa/utils/hook.h>
16 
34 #define PW_TYPE_INTERFACE_Core PW_TYPE_INFO_INTERFACE_BASE "Core"
35 #define PW_TYPE_INTERFACE_Registry PW_TYPE_INFO_INTERFACE_BASE "Registry"
36 
37 #define PW_CORE_PERM_MASK PW_PERM_R|PW_PERM_X|PW_PERM_M
38 
39 #define PW_VERSION_CORE 4
40 struct pw_core;
41 #define PW_VERSION_REGISTRY 3
42 struct pw_registry;
43 
45 #define PW_DEFAULT_REMOTE "pipewire-0"
46 
48 #define PW_ID_CORE 0
49 
50 /* invalid ID that matches any object when used for permissions */
51 #define PW_ID_ANY (uint32_t)(0xffffffff)
52 
55 struct pw_core_info {
56  uint32_t id;
57  uint32_t cookie;
58  const char *user_name;
59  const char *host_name;
60  const char *version;
61  const char *name;
62 #define PW_CORE_CHANGE_MASK_PROPS (1 << 0)
63 #define PW_CORE_CHANGE_MASK_ALL ((1 << 1)-1)
64  uint64_t change_mask;
65  struct spa_dict *props;
66 };
67 
68 #include <pipewire/context.h>
69 #include <pipewire/properties.h>
70 #include <pipewire/proxy.h>
71 
73 struct pw_core_info *
75  const struct pw_core_info *update);
77 struct pw_core_info *
79  const struct pw_core_info *update, bool reset);
81 void pw_core_info_free(struct pw_core_info *info);
82 
85 #define PW_CORE_EVENT_INFO 0
86 #define PW_CORE_EVENT_DONE 1
87 #define PW_CORE_EVENT_PING 2
88 #define PW_CORE_EVENT_ERROR 3
89 #define PW_CORE_EVENT_REMOVE_ID 4
90 #define PW_CORE_EVENT_BOUND_ID 5
91 #define PW_CORE_EVENT_ADD_MEM 6
92 #define PW_CORE_EVENT_REMOVE_MEM 7
93 #define PW_CORE_EVENT_BOUND_PROPS 8
94 #define PW_CORE_EVENT_NUM 9
95 
99 struct pw_core_events {
100 #define PW_VERSION_CORE_EVENTS 1
101  uint32_t version;
102 
111  void (*info) (void *data, const struct pw_core_info *info);
120  void (*done) (void *data, uint32_t id, int seq);
121 
127  void (*ping) (void *data, uint32_t id, int seq);
128 
146  void (*error) (void *data, uint32_t id, int seq, int res, const char *message);
158  void (*remove_id) (void *data, uint32_t id);
159 
170  void (*bound_id) (void *data, uint32_t id, uint32_t global_id);
171 
186  void (*add_mem) (void *data, uint32_t id, uint32_t type, int fd, uint32_t flags);
187 
193  void (*remove_mem) (void *data, uint32_t id);
194 
195  void (*bound_props) (void *data, uint32_t id, uint32_t global_id, const struct spa_dict *props);
196 };
197 
198 #define PW_CORE_METHOD_ADD_LISTENER 0
199 #define PW_CORE_METHOD_HELLO 1
200 #define PW_CORE_METHOD_SYNC 2
201 #define PW_CORE_METHOD_PONG 3
202 #define PW_CORE_METHOD_ERROR 4
203 #define PW_CORE_METHOD_GET_REGISTRY 5
204 #define PW_CORE_METHOD_CREATE_OBJECT 6
205 #define PW_CORE_METHOD_DESTROY 7
206 #define PW_CORE_METHOD_NUM 8
207 
216 struct pw_core_methods {
217 #define PW_VERSION_CORE_METHODS 0
218  uint32_t version;
219 
220  int (*add_listener) (void *object,
221  struct spa_hook *listener,
222  const struct pw_core_events *events,
223  void *data);
231  int (*hello) (void *object, uint32_t version);
245  int (*sync) (void *object, uint32_t id, int seq);
255  int (*pong) (void *object, uint32_t id, int seq);
274  int (*error) (void *object, uint32_t id, int seq, int res, const char *message);
285  struct pw_registry * (*get_registry) (void *object, uint32_t version,
286  size_t user_data_size);
287 
299  void * (*create_object) (void *object,
300  const char *factory_name,
301  const char *type,
302  uint32_t version,
303  const struct spa_dict *props,
304  size_t user_data_size);
314  int (*destroy) (void *object, void *proxy);
315 };
316 
317 #define pw_core_method(o,method,version,...) \
318 ({ \
319  int _res = -ENOTSUP; \
320  spa_interface_call_res((struct spa_interface*)o, \
321  struct pw_core_methods, _res, \
322  method, version, ##__VA_ARGS__); \
323  _res; \
324 })
325 
326 #define pw_core_add_listener(c,...) pw_core_method(c,add_listener,0,__VA_ARGS__)
327 #define pw_core_hello(c,...) pw_core_method(c,hello,0,__VA_ARGS__)
328 #define pw_core_sync(c,...) pw_core_method(c,sync,0,__VA_ARGS__)
329 #define pw_core_pong(c,...) pw_core_method(c,pong,0,__VA_ARGS__)
330 #define pw_core_error(c,...) pw_core_method(c,error,0,__VA_ARGS__)
331 
332 
333 static inline
334 SPA_PRINTF_FUNC(5, 0) int
335 pw_core_errorv(struct pw_core *core, uint32_t id, int seq,
336  int res, const char *message, va_list args)
337 {
338  char buffer[1024];
339  vsnprintf(buffer, sizeof(buffer), message, args);
340  buffer[1023] = '\0';
341  return pw_core_error(core, id, seq, res, buffer);
342 }
343 
344 static inline
345 SPA_PRINTF_FUNC(5, 6) int
346 pw_core_errorf(struct pw_core *core, uint32_t id, int seq,
347  int res, const char *message, ...)
348 {
349  va_list args;
350  int r;
351  va_start(args, message);
352  r = pw_core_errorv(core, id, seq, res, message, args);
353  va_end(args);
354  return r;
355 }
356 
357 static inline struct pw_registry *
358 pw_core_get_registry(struct pw_core *core, uint32_t version, size_t user_data_size)
359 {
360  struct pw_registry *res = NULL;
362  struct pw_core_methods, res,
363  get_registry, 0, version, user_data_size);
364  return res;
365 }
366 
367 static inline void *
368 pw_core_create_object(struct pw_core *core,
369  const char *factory_name,
370  const char *type,
371  uint32_t version,
372  const struct spa_dict *props,
373  size_t user_data_size)
374 {
375  void *res = NULL;
377  struct pw_core_methods, res,
378  create_object, 0, factory_name,
379  type, version, props, user_data_size);
380  return res;
381 }
382 
383 #define pw_core_destroy(c,...) pw_core_method(c,destroy,0,__VA_ARGS__)
384 
424 #define PW_REGISTRY_EVENT_GLOBAL 0
425 #define PW_REGISTRY_EVENT_GLOBAL_REMOVE 1
426 #define PW_REGISTRY_EVENT_NUM 2
427 
429 struct pw_registry_events {
430 #define PW_VERSION_REGISTRY_EVENTS 0
431  uint32_t version;
444  void (*global) (void *data, uint32_t id,
445  uint32_t permissions, const char *type, uint32_t version,
446  const struct spa_dict *props);
456  void (*global_remove) (void *data, uint32_t id);
457 };
458 
459 #define PW_REGISTRY_METHOD_ADD_LISTENER 0
460 #define PW_REGISTRY_METHOD_BIND 1
461 #define PW_REGISTRY_METHOD_DESTROY 2
462 #define PW_REGISTRY_METHOD_NUM 3
463 
465 struct pw_registry_methods {
466 #define PW_VERSION_REGISTRY_METHODS 0
467  uint32_t version;
468 
469  int (*add_listener) (void *object,
470  struct spa_hook *listener,
471  const struct pw_registry_events *events,
472  void *data);
485  void * (*bind) (void *object, uint32_t id, const char *type, uint32_t version,
486  size_t use_data_size);
487 
496  int (*destroy) (void *object, uint32_t id);
497 };
498 
499 #define pw_registry_method(o,method,version,...) \
500 ({ \
501  int _res = -ENOTSUP; \
502  spa_interface_call_res((struct spa_interface*)o, \
503  struct pw_registry_methods, _res, \
504  method, version, ##__VA_ARGS__); \
505  _res; \
506 })
507 
509 #define pw_registry_add_listener(p,...) pw_registry_method(p,add_listener,0,__VA_ARGS__)
510 
511 static inline void *
512 pw_registry_bind(struct pw_registry *registry,
513  uint32_t id, const char *type, uint32_t version,
514  size_t user_data_size)
515 {
516  void *res = NULL;
517  spa_interface_call_res((struct spa_interface*)registry,
518  struct pw_registry_methods, res,
519  bind, 0, id, type, version, user_data_size);
520  return res;
521 }
522 
523 #define pw_registry_destroy(p,...) pw_registry_method(p,destroy,0,__VA_ARGS__)
524 
544 struct pw_core *
545 pw_context_connect(struct pw_context *context,
546  struct pw_properties *properties,
547  size_t user_data_size);
548 
559 struct pw_core *
560 pw_context_connect_fd(struct pw_context *context,
561  int fd,
562  struct pw_properties *properties,
563  size_t user_data_size);
564 
573 struct pw_core *
574 pw_context_connect_self(struct pw_context *context,
575  struct pw_properties *properties,
576  size_t user_data_size);
577 
580 int pw_core_steal_fd(struct pw_core *core);
581 
584 int pw_core_set_paused(struct pw_core *core, bool paused);
585 
587 int pw_core_disconnect(struct pw_core *core);
588 
591 void *pw_core_get_user_data(struct pw_core *core);
592 
595 struct pw_client * pw_core_get_client(struct pw_core *core);
596 
598 struct pw_context * pw_core_get_context(struct pw_core *core);
599 
601 const struct pw_properties *pw_core_get_properties(struct pw_core *core);
602 
606 int pw_core_update_properties(struct pw_core *core, const struct spa_dict *dict);
607 
609 struct pw_mempool * pw_core_get_mempool(struct pw_core *core);
610 
612 struct pw_proxy *pw_core_find_proxy(struct pw_core *core, uint32_t id);
613 
615 struct pw_proxy *pw_core_export(struct pw_core *core,
616  const char *type,
617  const struct spa_dict *props,
618  void *object,
619  size_t user_data_size );
620 
625 #ifdef __cplusplus
626 }
627 #endif
628 
629 #endif /* PIPEWIRE_CORE_H */
static int pw_core_errorf(struct pw_core *core, uint32_t id, int seq, int res, const char *message,...)
Definition: core.h:394
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:383
#define pw_core_error(c,...)
Fatal error event.
Definition: core.h:376
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:416
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:390
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:442
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
struct pw_client * pw_core_get_client(struct pw_core *core)
Get the client proxy of the connected core.
Definition: core.c:253
void * pw_core_get_user_data(struct pw_core *core)
Get the user_data.
Definition: core.c:152
struct pw_mempool * pw_core_get_mempool(struct pw_core *core)
Get the core mempool object.
Definition: core.c:471
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
int pw_core_update_properties(struct pw_core *core, const struct spa_dict *dict)
Update the core properties.
Definition: core.c:134
struct pw_proxy * pw_core_find_proxy(struct pw_core *core, uint32_t id)
Get the proxy with the given id.
Definition: core.c:259
int pw_core_disconnect(struct pw_core *core)
disconnect and destroy a core
Definition: core.c:477
int pw_core_steal_fd(struct pw_core *core)
Steal the fd of the core connection or < 0 on error.
Definition: core.c:456
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:417
struct pw_context * pw_core_get_context(struct pw_core *core)
Get the context object used to created this core.
Definition: core.c:122
const struct pw_properties * pw_core_get_properties(struct pw_core *core)
Get properties from the core.
Definition: core.c:128
int pw_core_set_paused(struct pw_core *core, bool paused)
Pause or resume the core.
Definition: core.c:464
void pw_core_info_free(struct pw_core_info *info)
Free a pw_core_info
Definition: introspect.c:145
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:265
static struct pw_registry * pw_core_get_registry(struct pw_core *core, uint32_t version, size_t user_data_size)
Definition: core.h:406
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:573
#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:251
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:273
spa/utils/hook.h
pipewire/properties.h
pipewire/proxy.h
pipewire/context.h
Core events.
Definition: core.h:126
void(* ping)(void *data, uint32_t id, int seq)
Emit a ping event.
Definition: core.h:155
void(* remove_mem)(void *data, uint32_t id)
Remove memory for a client.
Definition: core.h:221
void(* error)(void *data, uint32_t id, int seq, int res, const char *message)
Fatal error event.
Definition: core.h:174
void(* add_mem)(void *data, uint32_t id, uint32_t type, int fd, uint32_t flags)
Add memory for a client.
Definition: core.h:214
void(* bound_props)(void *data, uint32_t id, uint32_t global_id, const struct spa_dict *props)
Definition: core.h:223
void(* info)(void *data, const struct pw_core_info *info)
Notify new core info.
Definition: core.h:139
void(* remove_id)(void *data, uint32_t id)
Remove an object ID.
Definition: core.h:186
uint32_t version
Definition: core.h:129
void(* bound_id)(void *data, uint32_t id, uint32_t global_id)
Notify an object binding.
Definition: core.h:198
void(* done)(void *data, uint32_t id, int seq)
Emit a done event.
Definition: core.h:148
The core information.
Definition: core.h:70
uint64_t change_mask
bitfield of changed fields since last call
Definition: core.h:81
const char * version
version of the core
Definition: core.h:75
uint32_t cookie
a random cookie for identifying this instance of PipeWire
Definition: core.h:72
uint32_t id
id of the global
Definition: core.h:71
const char * user_name
name of the user that started the core
Definition: core.h:73
const char * host_name
name of the machine the core is running on
Definition: core.h:74
Core methods.
Definition: core.h:253
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_core_events *events, void *data)
Definition: core.h:258
int(* pong)(void *object, uint32_t id, int seq)
Reply to a server ping event.
Definition: core.h:293
int(* destroy)(void *object, void *proxy)
Destroy an resource.
Definition: core.h:352
int(* hello)(void *object, uint32_t version)
Start a conversation with the server.
Definition: core.h:269
int(* error)(void *object, uint32_t id, int seq, int res, const char *message)
Fatal error event.
Definition: core.h:312
int(* sync)(void *object, uint32_t id, int seq)
Do server roundtrip.
Definition: core.h:283
uint32_t version
Definition: core.h:256
A memory pool is a collection of pw_memblocks.
Definition: src/pipewire/mem.h:57
Definition: properties.h:33
struct spa_dict dict
dictionary of key/values
Definition: properties.h:34
Registry events.
Definition: core.h:482
void(* global_remove)(void *data, uint32_t id)
Notify of a global object removal.
Definition: core.h:510
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:498
uint32_t version
Definition: core.h:485
Registry methods.
Definition: core.h:523
uint32_t version
Definition: core.h:526
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_registry_events *events, void *data)
Definition: core.h:528
int(* destroy)(void *object, uint32_t id)
Attempt to destroy a global object.
Definition: core.h:555
Definition: utils/dict.h:39
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:350
Definition: hook.h:138