mirror of
https://gitlab.freedesktop.org/pipewire/wireplumber.git
synced 2025-12-23 23:10:03 +01:00
2f3f5f8e66
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.
121 lines
2.9 KiB
C
121 lines
2.9 KiB
C
/* WirePlumber
|
|
*
|
|
* Copyright © 2019 Collabora Ltd.
|
|
* @author George Kiagiadakis <george.kiagiadakis@collabora.com>
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
#ifndef __WIREPLUMBER_SESSION_H__
|
|
#define __WIREPLUMBER_SESSION_H__
|
|
|
|
#include "global-proxy.h"
|
|
#include "endpoint.h"
|
|
#include "endpoint-link.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* WpSessionFeatures:
|
|
* @WP_SESSION_FEATURE_ENDPOINTS: caches information about endpoints, enabling
|
|
* the use of wp_session_get_n_endpoints(), wp_session_lookup_endpoint(),
|
|
* wp_session_iterate_endpoints() and related methods
|
|
* @WP_SESSION_FEATURE_LINKS: caches information about endpoint links, enabling
|
|
* the use of wp_session_get_n_links(), wp_session_lookup_link(),
|
|
* wp_session_iterate_links() and related methods
|
|
*
|
|
* An extension of #WpProxyFeatures
|
|
*/
|
|
typedef enum { /*< flags >*/
|
|
WP_SESSION_FEATURE_ENDPOINTS = (WP_PROXY_FEATURE_CUSTOM_START << 0),
|
|
WP_SESSION_FEATURE_LINKS = (WP_PROXY_FEATURE_CUSTOM_START << 1),
|
|
} WpSessionFeatures;
|
|
|
|
/**
|
|
* WP_TYPE_SESSION:
|
|
*
|
|
* The #WpSession #GType
|
|
*/
|
|
#define WP_TYPE_SESSION (wp_session_get_type ())
|
|
WP_API
|
|
G_DECLARE_DERIVABLE_TYPE (WpSession, wp_session, WP, SESSION, WpGlobalProxy)
|
|
|
|
struct _WpSessionClass
|
|
{
|
|
WpGlobalProxyClass parent_class;
|
|
};
|
|
|
|
WP_API
|
|
const gchar * wp_session_get_name (WpSession * self);
|
|
|
|
/* endpoints */
|
|
|
|
WP_API
|
|
guint wp_session_get_n_endpoints (WpSession * self);
|
|
|
|
WP_API
|
|
WpIterator * wp_session_iterate_endpoints (WpSession * self);
|
|
|
|
WP_API
|
|
WpIterator * wp_session_iterate_endpoints_filtered (WpSession * self, ...)
|
|
G_GNUC_NULL_TERMINATED;
|
|
|
|
WP_API
|
|
WpIterator * wp_session_iterate_endpoints_filtered_full (WpSession * self,
|
|
WpObjectInterest * interest);
|
|
|
|
WP_API
|
|
WpEndpoint * wp_session_lookup_endpoint (WpSession * self, ...)
|
|
G_GNUC_NULL_TERMINATED;
|
|
|
|
WP_API
|
|
WpEndpoint * wp_session_lookup_endpoint_full (WpSession * self,
|
|
WpObjectInterest * interest);
|
|
|
|
/* links */
|
|
|
|
WP_API
|
|
guint wp_session_get_n_links (WpSession * self);
|
|
|
|
WP_API
|
|
WpIterator * wp_session_iterate_links (WpSession * self);
|
|
|
|
WP_API
|
|
WpIterator * wp_session_iterate_links_filtered (WpSession * self, ...)
|
|
G_GNUC_NULL_TERMINATED;
|
|
|
|
WP_API
|
|
WpIterator * wp_session_iterate_links_filtered_full (WpSession * self,
|
|
WpObjectInterest * interest);
|
|
|
|
WP_API
|
|
WpEndpointLink * wp_session_lookup_link (WpSession * self, ...)
|
|
G_GNUC_NULL_TERMINATED;
|
|
|
|
WP_API
|
|
WpEndpointLink * wp_session_lookup_link_full (WpSession * self,
|
|
WpObjectInterest * interest);
|
|
|
|
/**
|
|
* WP_TYPE_IMPL_SESSION:
|
|
*
|
|
* The #WpImplSession #GType
|
|
*/
|
|
#define WP_TYPE_IMPL_SESSION (wp_impl_session_get_type ())
|
|
WP_API
|
|
G_DECLARE_FINAL_TYPE (WpImplSession, wp_impl_session, WP, IMPL_SESSION, WpSession)
|
|
|
|
WP_API
|
|
WpImplSession * wp_impl_session_new (WpCore * core);
|
|
|
|
WP_API
|
|
void wp_impl_session_set_property (WpImplSession * self,
|
|
const gchar * key, const gchar * value);
|
|
|
|
WP_API
|
|
void wp_impl_session_update_properties (WpImplSession * self,
|
|
WpProperties * updates);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif
|