2019-07-05 10:22:28 -04:00
|
|
|
/* WirePlumber
|
|
|
|
|
*
|
|
|
|
|
* Copyright © 2019 Collabora Ltd.
|
|
|
|
|
* @author Julian Bouzas <julian.bouzas@collabora.com>
|
|
|
|
|
*
|
|
|
|
|
* SPDX-License-Identifier: MIT
|
|
|
|
|
*/
|
|
|
|
|
|
2020-01-22 18:54:45 +02:00
|
|
|
#ifndef __WIREPLUMBER_LINK_H__
|
|
|
|
|
#define __WIREPLUMBER_LINK_H__
|
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"
|
2019-07-05 10:22:28 -04:00
|
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
2022-05-26 15:42:45 +03:00
|
|
|
/*!
|
|
|
|
|
* \brief The state of the link
|
|
|
|
|
* \ingroup wplink
|
2023-08-30 11:20:06 +02:00
|
|
|
*
|
|
|
|
|
* \since 0.4.11
|
2022-05-26 15:42:45 +03:00
|
|
|
*/
|
|
|
|
|
typedef enum {
|
|
|
|
|
WP_LINK_STATE_ERROR = -2, /*!< the link is in error */
|
|
|
|
|
WP_LINK_STATE_UNLINKED = -1, /*!< the link is unlinked */
|
|
|
|
|
WP_LINK_STATE_INIT = 0, /*!< the link is initialized */
|
|
|
|
|
WP_LINK_STATE_NEGOTIATING = 1, /*!< the link is negotiating formats */
|
|
|
|
|
WP_LINK_STATE_ALLOCATING = 2, /*!< the link is allocating buffers */
|
|
|
|
|
WP_LINK_STATE_PAUSED = 3, /*!< the link is paused */
|
|
|
|
|
WP_LINK_STATE_ACTIVE = 4, /*!< the link is active */
|
|
|
|
|
} WpLinkState;
|
|
|
|
|
|
2021-05-13 17:54:58 +03:00
|
|
|
/*!
|
2021-05-21 18:40:43 +03:00
|
|
|
* \brief The WpLink GType
|
|
|
|
|
* \ingroup wplink
|
2020-02-17 15:39:19 +02:00
|
|
|
*/
|
2020-01-22 18:54:45 +02:00
|
|
|
#define WP_TYPE_LINK (wp_link_get_type ())
|
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 (WpLink, wp_link, WP, LINK, WpGlobalProxy)
|
2019-07-05 10:22:28 -04:00
|
|
|
|
2020-01-30 17:41:25 +02:00
|
|
|
WP_API
|
|
|
|
|
WpLink * wp_link_new_from_factory (WpCore * core,
|
|
|
|
|
const gchar * factory_name, WpProperties * properties);
|
|
|
|
|
|
2020-05-05 16:29:17 +03:00
|
|
|
WP_API
|
|
|
|
|
void wp_link_get_linked_object_ids (WpLink * self,
|
|
|
|
|
guint32 * output_node, guint32 * output_port,
|
|
|
|
|
guint32 * input_node, guint32 * input_port);
|
|
|
|
|
|
2022-05-26 15:42:45 +03:00
|
|
|
WP_API
|
|
|
|
|
WpLinkState wp_link_get_state (WpLink * self, const gchar ** error);
|
|
|
|
|
|
2019-07-05 10:22:28 -04:00
|
|
|
G_END_DECLS
|
|
|
|
|
|
|
|
|
|
#endif
|
