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.
132 lines
3.2 KiB
C
132 lines
3.2 KiB
C
/* WirePlumber
|
|
*
|
|
* Copyright © 2019 Collabora Ltd.
|
|
* @author Julian Bouzas <julian.bouzas@collabora.com>
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
#ifndef __WIREPLUMBER_NODE_H__
|
|
#define __WIREPLUMBER_NODE_H__
|
|
|
|
#include "global-proxy.h"
|
|
#include "port.h"
|
|
#include "iterator.h"
|
|
#include "object-interest.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
struct pw_impl_node;
|
|
|
|
/**
|
|
* WpNodeState:
|
|
* @WP_NODE_STATE_ERROR: error state
|
|
* @WP_NODE_STATE_CREATING: the node is being created
|
|
* @WP_NODE_STATE_SUSPENDED: the node is suspended, the device might be closed
|
|
* @WP_NODE_STATE_IDLE: the node is running but there is no active port
|
|
* @WP_NODE_STATE_RUNNING: the node is running
|
|
*/
|
|
typedef enum {
|
|
WP_NODE_STATE_ERROR = -1,
|
|
WP_NODE_STATE_CREATING = 0,
|
|
WP_NODE_STATE_SUSPENDED = 1,
|
|
WP_NODE_STATE_IDLE = 2,
|
|
WP_NODE_STATE_RUNNING = 3,
|
|
} WpNodeState;
|
|
|
|
/**
|
|
* WpNodeCommand:
|
|
* @WP_NODE_COMMAND_SUSPEND: suspends the node, the device might close
|
|
* @WP_NODE_COMMAND_PAUSE: pauses the node, the device will not close
|
|
* @WP_NODE_COMMAND_START: starts procesing data
|
|
* @WP_NODE_COMMAND_ENABLE: enables the node
|
|
* @WP_NODE_COMMAND_DISABLE: disables the node
|
|
*/
|
|
typedef enum {
|
|
WP_NODE_COMMAND_SUSPEND = 0,
|
|
WP_NODE_COMMAND_PAUSE = 1,
|
|
WP_NODE_COMMAND_START = 2,
|
|
WP_NODE_COMMAND_ENABLE = 3,
|
|
WP_NODE_COMMAND_DISABLE = 4,
|
|
} WpNodeCommand;
|
|
|
|
/**
|
|
* WpNodeFeatures:
|
|
* @WP_NODE_FEATURE_PORTS: caches information about ports, enabling
|
|
* the use of wp_node_get_n_ports(), wp_node_lookup_port(),
|
|
* wp_node_iterate_ports() and related methods
|
|
*
|
|
* An extension of #WpProxyFeatures
|
|
*/
|
|
typedef enum { /*< flags >*/
|
|
WP_NODE_FEATURE_PORTS = (WP_PROXY_FEATURE_CUSTOM_START << 0),
|
|
} WpNodeFeatures;
|
|
|
|
/**
|
|
* WP_TYPE_NODE:
|
|
*
|
|
* The #WpNode #GType
|
|
*/
|
|
#define WP_TYPE_NODE (wp_node_get_type ())
|
|
WP_API
|
|
G_DECLARE_FINAL_TYPE (WpNode, wp_node, WP, NODE, WpGlobalProxy)
|
|
|
|
WP_API
|
|
WpNode * wp_node_new_from_factory (WpCore * core,
|
|
const gchar * factory_name, WpProperties * properties);
|
|
|
|
WP_API
|
|
WpNodeState wp_node_get_state (WpNode * self, const gchar ** error);
|
|
|
|
WP_API
|
|
guint wp_node_get_n_input_ports (WpNode * self, guint * max);
|
|
|
|
WP_API
|
|
guint wp_node_get_n_output_ports (WpNode * self, guint * max);
|
|
|
|
WP_API
|
|
guint wp_node_get_n_ports (WpNode * self);
|
|
|
|
WP_API
|
|
WpIterator * wp_node_iterate_ports (WpNode * self);
|
|
|
|
WP_API
|
|
WpIterator * wp_node_iterate_ports_filtered (WpNode * self, ...)
|
|
G_GNUC_NULL_TERMINATED;
|
|
|
|
WP_API
|
|
WpIterator * wp_node_iterate_ports_filtered_full (WpNode * self,
|
|
WpObjectInterest * interest);
|
|
|
|
WP_API
|
|
WpPort * wp_node_lookup_port (WpNode * self, ...) G_GNUC_NULL_TERMINATED;
|
|
|
|
WP_API
|
|
WpPort * wp_node_lookup_port_full (WpNode * self, WpObjectInterest * interest);
|
|
|
|
WP_API
|
|
void wp_node_send_command (WpNode * self, WpNodeCommand command);
|
|
|
|
/**
|
|
* WP_TYPE_IMPL_NODE:
|
|
*
|
|
* The #WpImplNode #GType
|
|
*/
|
|
#define WP_TYPE_IMPL_NODE (wp_impl_node_get_type ())
|
|
WP_API
|
|
G_DECLARE_FINAL_TYPE (WpImplNode, wp_impl_node, WP, IMPL_NODE, GObject)
|
|
|
|
WP_API
|
|
WpImplNode * wp_impl_node_new_wrap (WpCore * core, struct pw_impl_node * node);
|
|
|
|
WP_API
|
|
WpImplNode * wp_impl_node_new_from_pw_factory (WpCore * core,
|
|
const gchar * factory_name, WpProperties * properties);
|
|
|
|
WP_API
|
|
void wp_impl_node_export (WpImplNode * self);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif
|