fdo-mirrors/wireplumber
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/wireplumber.git synced 2025-12-20 17:00:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
wireplumber/lib/wp/device.h

76 lines
1.7 KiB
C
Raw Normal View History

proxy-link: add new API
2019-07-05 10:22:28 -04:00
/* WirePlumber
*
* Copyright © 2019 Collabora Ltd.
* @author Julian Bouzas <julian.bouzas@collabora.com>
*
* SPDX-License-Identifier: MIT
*/
lib: drop the proxy- prefix from client, device, link, port & node
2020-01-22 18:54:45 +02:00
#ifndef __WIREPLUMBER_DEVICE_H__
#define __WIREPLUMBER_DEVICE_H__
proxy-link: add new API
2019-07-05 10:22:28 -04:00
lib: refactor WpProxy This is an attempt to unclutter the API of WpProxy and split functionality into smaller pieces, making it easier to work with. In this new class layout, we have the following classes: - WpObject: base class for everything; handles activating | and deactivating "features" |- WpProxy: base class for anything that wraps a pw_proxy; | handles events from pw_proxy and nothing more |- WpGlobalProxy: handles integration with the registry All the other classes derive from WpGlobalProxy. The reason for separating WpGlobalProxy from WpProxy, though, is that classes such as WpImplNode / WpSpaDevice can also derive from WpProxy now, without interfacing with the registry. All objects that come with an "info" structure and have properties and/or params also implement the WpPipewireObject interface. This provides the API to query properties and get/set params. Essentially, this is implemented by all classes except WpMetadata (pw_metadata does not have info) This interface is implemented on each object separately, using a private "mixin", which is a set of vfunc implementations and helper functions (and macros) to facilitate the implementation of this interface. A notable difference to the old WpProxy is that now features can be deactivated, so it is possible to enable something and later disable it again. This commit disables modules, tests, tools, etc, to avoid growing the patch more, while ensuring that the project compiles.
2020-11-10 19:17:02 +02:00
#include "global-proxy.h"
proxy-link: add new API
2019-07-05 10:22:28 -04:00
G_BEGIN_DECLS
proxy/core: refactor object creation * core no longer exposes create_remote/local_object * node, device & link have constructor methods to enable the create_remote_object functionality * added WpImplNode to wrap pw_impl_node and allow creating "local" node instances * added WpSpaDevice to wrap spa_device and allow creating "local" device instances * exporting objects in all cases now happens by requesting FEATURE_BOUND from the proxy, eliminating the need for WpExported * replaced WpMonitor by new, simpler code directly in module-monitor * the proxy type lookup table in WpProxy is gone, we now use a field on the class structure of every WpProxy subclass and iterate through all the class structures instead; this is more flexible and extensible
2020-01-30 17:41:25 +02:00
/* WpDevice */
docs: api: Replace hotdoc specific commands with Doxygen specific commands
2021-05-13 17:54:58 +03:00
/*!
docs: fix C API documentation to work nicely with doxygen & sphinx
2021-05-21 18:40:43 +03:00
* \brief The WpDevice GType
* \ingroup wpdevice
lib: add extensive API documentation
2020-02-17 15:39:19 +02:00
*/
lib: drop the proxy- prefix from client, device, link, port & node
2020-01-22 18:54:45 +02:00
#define WP_TYPE_DEVICE (wp_device_get_type ())
lib: introduce export macros and hide all private symbols
2020-01-16 18:50:07 +02:00
WP_API
lib: refactor WpProxy This is an attempt to unclutter the API of WpProxy and split functionality into smaller pieces, making it easier to work with. In this new class layout, we have the following classes: - WpObject: base class for everything; handles activating | and deactivating "features" |- WpProxy: base class for anything that wraps a pw_proxy; | handles events from pw_proxy and nothing more |- WpGlobalProxy: handles integration with the registry All the other classes derive from WpGlobalProxy. The reason for separating WpGlobalProxy from WpProxy, though, is that classes such as WpImplNode / WpSpaDevice can also derive from WpProxy now, without interfacing with the registry. All objects that come with an "info" structure and have properties and/or params also implement the WpPipewireObject interface. This provides the API to query properties and get/set params. Essentially, this is implemented by all classes except WpMetadata (pw_metadata does not have info) This interface is implemented on each object separately, using a private "mixin", which is a set of vfunc implementations and helper functions (and macros) to facilitate the implementation of this interface. A notable difference to the old WpProxy is that now features can be deactivated, so it is possible to enable something and later disable it again. This commit disables modules, tests, tools, etc, to avoid growing the patch more, while ensuring that the project compiles.
2020-11-10 19:17:02 +02:00
G_DECLARE_FINAL_TYPE (WpDevice, wp_device, WP, DEVICE, WpGlobalProxy)
proxy-link: add new API
2019-07-05 10:22:28 -04:00
proxy/core: refactor object creation * core no longer exposes create_remote/local_object * node, device & link have constructor methods to enable the create_remote_object functionality * added WpImplNode to wrap pw_impl_node and allow creating "local" node instances * added WpSpaDevice to wrap spa_device and allow creating "local" device instances * exporting objects in all cases now happens by requesting FEATURE_BOUND from the proxy, eliminating the need for WpExported * replaced WpMonitor by new, simpler code directly in module-monitor * the proxy type lookup table in WpProxy is gone, we now use a field on the class structure of every WpProxy subclass and iterate through all the class structures instead; this is more flexible and extensible
2020-01-30 17:41:25 +02:00
WP_API
WpDevice * wp_device_new_from_factory (WpCore * core,
const gchar * factory_name, WpProperties * properties);
/* WpSpaDevice */
docs: api: Replace hotdoc specific commands with Doxygen specific commands
2021-05-13 17:54:58 +03:00
/*!
docs: fix C API documentation to work nicely with doxygen & sphinx
2021-05-21 18:40:43 +03:00
* \brief Flags to be used as WpObjectFeatures for WpSpaDevice
* \ingroup wpspadevice
spa-device: derive from WpProxy and manage child objects internally port module-monitor to follow the changes
2021-01-18 17:13:15 +02:00
*/
typedef enum { /*< flags >*/
docs: fix C API documentation to work nicely with doxygen & sphinx
2021-05-21 18:40:43 +03:00
/*! enables a spa device */
spa-device: derive from WpProxy and manage child objects internally port module-monitor to follow the changes
2021-01-18 17:13:15 +02:00
WP_SPA_DEVICE_FEATURE_ENABLED = (WP_PROXY_FEATURE_CUSTOM_START << 0),
} WpSpaDeviceFeatures;
docs: api: Replace hotdoc specific commands with Doxygen specific commands
2021-05-13 17:54:58 +03:00
/*!
docs: fix C API documentation to work nicely with doxygen & sphinx
2021-05-21 18:40:43 +03:00
* \brief The WpSpaDevice GType
* \ingroup wpspadevice
lib: add extensive API documentation
2020-02-17 15:39:19 +02:00
*/
proxy/core: refactor object creation * core no longer exposes create_remote/local_object * node, device & link have constructor methods to enable the create_remote_object functionality * added WpImplNode to wrap pw_impl_node and allow creating "local" node instances * added WpSpaDevice to wrap spa_device and allow creating "local" device instances * exporting objects in all cases now happens by requesting FEATURE_BOUND from the proxy, eliminating the need for WpExported * replaced WpMonitor by new, simpler code directly in module-monitor * the proxy type lookup table in WpProxy is gone, we now use a field on the class structure of every WpProxy subclass and iterate through all the class structures instead; this is more flexible and extensible
2020-01-30 17:41:25 +02:00
#define WP_TYPE_SPA_DEVICE (wp_spa_device_get_type ())
WP_API
spa-device: derive from WpProxy and manage child objects internally port module-monitor to follow the changes
2021-01-18 17:13:15 +02:00
G_DECLARE_FINAL_TYPE (WpSpaDevice, wp_spa_device, WP, SPA_DEVICE, WpProxy)
spa-device: subclass from GObject
2020-06-10 15:34:34 -04:00
WP_API
WpSpaDevice * wp_spa_device_new_wrap (WpCore * core,
spa-device: store the constructor properties and use them for export + object-info the spa object undereath doesn't do that and we lose a bunch of properties otherwise
2020-06-15 11:10:39 +03:00
gpointer spa_device_handle, WpProperties * properties);
proxy/core: refactor object creation * core no longer exposes create_remote/local_object * node, device & link have constructor methods to enable the create_remote_object functionality * added WpImplNode to wrap pw_impl_node and allow creating "local" node instances * added WpSpaDevice to wrap spa_device and allow creating "local" device instances * exporting objects in all cases now happens by requesting FEATURE_BOUND from the proxy, eliminating the need for WpExported * replaced WpMonitor by new, simpler code directly in module-monitor * the proxy type lookup table in WpProxy is gone, we now use a field on the class structure of every WpProxy subclass and iterate through all the class structures instead; this is more flexible and extensible
2020-01-30 17:41:25 +02:00
WP_API
WpSpaDevice * wp_spa_device_new_from_spa_factory (WpCore * core,
const gchar * factory_name, WpProperties * properties);
spa-device: subclass from GObject
2020-06-10 15:34:34 -04:00
WP_API
spa-device: derive from WpProxy and manage child objects internally port module-monitor to follow the changes
2021-01-18 17:13:15 +02:00
WpProperties * wp_spa_device_get_properties (WpSpaDevice * self);
spa-device: subclass from GObject
2020-06-10 15:34:34 -04:00
device: add new wp_spa_device_managed_object_new_iterator API
2022-06-16 15:27:31 -04:00
WP_API
WpIterator * wp_spa_device_new_managed_object_iterator (WpSpaDevice * self);
spa-device: subclass from GObject
2020-06-10 15:34:34 -04:00
WP_API
spa-device: derive from WpProxy and manage child objects internally port module-monitor to follow the changes
2021-01-18 17:13:15 +02:00
GObject * wp_spa_device_get_managed_object (WpSpaDevice * self, guint id);
spa-device: subclass from GObject
2020-06-10 15:34:34 -04:00
WP_API
spa-device: derive from WpProxy and manage child objects internally port module-monitor to follow the changes
2021-01-18 17:13:15 +02:00
void wp_spa_device_store_managed_object (WpSpaDevice * self, guint id,
GObject * object);
spa-device: subclass from GObject
2020-06-10 15:34:34 -04:00
lib: spa-device: add wp_spa_device_set_managed_pending() Allow marking WpSpaDevice object ids "pending", which means Props from any ObjectConfig events received for the ids are saved, if there is no associated object set yet. When wp_spa_device_store_managed_object() is called, any pending Props are set on the managed object. This is useful when nodes cannot be immediately created in the "create-object" signal handler. For example, in cases where the nodes are created asynchronously, e.g. by "module-loopback". In this case, although the nodes can be later associated with the WpSpaDevice, any ObjectConfig events received in the meantime are lost, so for example restoring saved Routes will race against async node creation. Using wp_spa_device_set_managed_pending() solves this race condition.
2024-12-15 15:48:53 +02:00
WP_API
void wp_spa_device_set_managed_pending (WpSpaDevice * self, guint id);
proxy-link: add new API
2019-07-05 10:22:28 -04:00
G_END_DECLS
#endif
Reference in a new issue Copy permalink