wireplumber/lib/wp/wp.h

/* WirePlumber
 *
 * Copyright © 2019 Collabora Ltd.
 *    @author George Kiagiadakis <george.kiagiadakis@collabora.com>
 *
 * SPDX-License-Identifier: MIT
 */

#ifndef __WIREPLUMBER_WP_H__
#define __WIREPLUMBER_WP_H__

#include "client.h"
#include "component-loader.h"
#include "core.h"
#include "device.h"
#include "endpoint.h"
#include "error.h"
#include "global-proxy.h"
#include "iterator.h"
#include "link.h"
#include "log.h"
#include "metadata.h"
#include "node.h"
#include "object-interest.h"
#include "object-manager.h"
#include "object.h"
#include "plugin.h"
#include "port.h"
#include "properties.h"
#include "proxy.h"
#include "proxy-interfaces.h"
#include "session-item.h"
#include "si-factory.h"
#include "si-interfaces.h"
#include "spa-pod.h"
#include "spa-type.h"
#include "state.h"
#include "transition.h"
#include "wpenums.h"
#include "wpversion.h"

G_BEGIN_DECLS

/*!
 * @memberof Wp
 *
 * @brief
 * @arg WP_INIT_PIPEWIRE
 * @arg WP_INIT_SPA_TYPES
 * @arg WP_INIT_SET_PW_LOG
 * @arg WP_INIT_SET_GLIB_LOG
 * @arg WP_INIT_ALL
 */
typedef enum {
  WP_INIT_PIPEWIRE = (1<<0),
  WP_INIT_SPA_TYPES = (1<<1),
  WP_INIT_SET_PW_LOG = (1<<2),
  WP_INIT_SET_GLIB_LOG = (1<<3),
  WP_INIT_ALL = 0xf,
} WpInitFlags;

WP_API
void wp_init (WpInitFlags flags);

WP_API
const gchar * wp_get_module_dir (void);

WP_API
const gchar * wp_get_config_dir (void);

WP_API
const gchar * wp_get_data_dir (void);

G_END_DECLS

#endif
Initial commit 2019-04-03 18:31:05 +03:00			`/* WirePlumber`
			`*`
			`* Copyright © 2019 Collabora Ltd.`
			`* @author George Kiagiadakis <george.kiagiadakis@collabora.com>`
			`*`
Relicense to MIT 2019-05-31 12:13:01 +03:00			`* SPDX-License-Identifier: MIT`
switch all headers to use SPDX-License-Identifier 2019-04-12 12:53:54 +03:00			`*/`
Initial commit 2019-04-03 18:31:05 +03:00
lib: implement a wp_init() function 2020-05-11 15:45:09 +03:00			`#ifndef __WIREPLUMBER_WP_H__`
			`#define __WIREPLUMBER_WP_H__`

lib: drop the proxy- prefix from client, device, link, port & node 2020-01-22 18:54:45 +02:00			`#include "client.h"`
lib: introduce WpComponentLoader and remove WpModule The component loader is a more generic and extensible mechanism of loading components; modules are one type of component... The idea is to make scripts and config files also be components, loaded by plugins that inherit WpComponentLoader 2021-01-31 23:29:55 +02:00			`#include "component-loader.h"`
Refactor everything! After discussing things at the AGL May 2019 F2F meeting and reflecting on the initial design of WirePlumber, it became clear that it needed a fresh start. 2019-05-17 13:08:45 +03:00			`#include "core.h"`
lib: drop the proxy- prefix from client, device, link, port & node 2020-01-22 18:54:45 +02:00			`#include "device.h"`
lib: implement WpEndpoint (interface + Proxy + Exported + unit test) heavily based on the WpSession implementation 2019-12-09 16:35:15 +02:00			`#include "endpoint.h"`
Refactor everything! After discussing things at the AGL May 2019 F2F meeting and reflecting on the initial design of WirePlumber, it became clear that it needed a fresh start. 2019-05-17 13:08:45 +03:00			`#include "error.h"`
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"`
lib: add iterator base class API 2020-04-02 14:15:49 -04:00			`#include "iterator.h"`
lib: drop the proxy- prefix from client, device, link, port & node 2020-01-22 18:54:45 +02:00			`#include "link.h"`
wp: rename debug.{h,c} to log.{h,c} Also rename the intermediate lua api table WpDebug -> WpLog Keeps things more consistent with the function names (wp_log), with the lua api (Log.) and with pipewire using log.{h,c} as well. After all, these functions are for logging... 2021-05-06 15:45:13 +03:00			`#include "log.h"`
Implement PW_TYPE_INTERFACE_Metadata 2020-07-29 19:27:40 +05:30			`#include "metadata.h"`
lib: drop the proxy- prefix from client, device, link, port & node 2020-01-22 18:54:45 +02:00			`#include "node.h"`
lib: implement WpObjectInterest 2020-05-01 17:51:12 +03:00			`#include "object-interest.h"`
lib: introduce WpObjectManager * rework how global objects are stored in the core * rework how users get notified about global objects and proxies of remote global objects The purpose of this change is to have a class that can manage objects that are registered in the core or signalled through the registry. This object can declare interest on certain types of global objects and only keep & signal those objects that it is interested in. Additionally, it can prepare proxy features and asynchronously deliver an 'objects-changed' signal, which is basically telling us that the list of objects has changed. This is useful to simplify port proxies management in WpAudioStream. Now the stream object can declare that it is interested in ports that have "node.id" == X and the object manager will only maintain a list of those. Additionally, it will emit the 'objects-changed' signal when the list of ports is complete, so there is no reason to do complex operations and core syncs in the WpAudioStream class in order to figure out when the list of ports is ready. As a side effect, this also reduces resource management. Now we don't construct a WpProxy for every global that pipewire reports; we only construct proxies when there is interest in them! Another interesting side effect is that we can now register an object manager at any point in time and get immediately notified about remote globals that already exist. i.e. when you register an object manager that is interested in nodes, it will be immediately notified about all the existing nodes in the graph. This is useful to avoid race conditions between connecting the signal and objects beting created in pipewire 2019-11-13 15:44:23 +02:00			`#include "object-manager.h"`
lib: add new WpObject base class A base class for objects that can have optional features enabled and disabled. The intention is to make this the superclass of WpProxy. Instead of following the augment() pattern of WpProxy, this one follows the more advanced transition pattern that has been previously implemented in WpSessionItem. 2020-10-22 14:37:54 +03:00			`#include "object.h"`
lib: add a WpPlugin class This serves as a base class for daemon plugins, which are implemented inside modules 2020-05-12 17:36:06 +03:00			`#include "plugin.h"`
lib: drop the proxy- prefix from client, device, link, port & node 2020-01-22 18:54:45 +02:00			`#include "port.h"`
lib: add new WpProperties object to wrap pw_properties & spa_dict 2019-08-21 15:16:13 +03:00			`#include "properties.h"`
proxy: add API 2019-06-10 15:07:54 -04:00			`#include "proxy.h"`
lib: add new proxy-interfaces: interfaces for the refactored WpProxy class 2020-10-23 18:22:33 +03:00			`#include "proxy-interfaces.h"`
lib: implement WpSessionItem base class 2020-03-12 18:00:01 +02:00			`#include "session-item.h"`
lib: implement WpSiFactory, a factory for session items 2020-03-18 17:13:52 +02:00			`#include "si-factory.h"`
Merge branch 'master' into next 2020-04-14 15:17:01 +03:00			`#include "si-interfaces.h"`
lib: add spa pod API 2020-04-02 14:19:59 -04:00			`#include "spa-pod.h"`
Merge branch 'master' into next 2020-04-14 15:17:01 +03:00			`#include "spa-type.h"`
lib: add new WpState API to save and load data from files 2020-10-14 14:36:12 -04:00			`#include "state.h"`
lib: implement a new WpTransition class This is an asynchronous operation class, like GTask, but it is made to execute several operations underneath, using a state machine, instead of just a single operation. 2020-03-10 13:41:34 +02:00			`#include "transition.h"`
lib: expose and install wpenums.h 2019-09-12 16:56:35 +03:00			`#include "wpenums.h"`
lib: add a version header 2020-06-02 18:26:40 +03:00			`#include "wpversion.h"`
lib: implement a wp_init() function 2020-05-11 15:45:09 +03:00
			`G_BEGIN_DECLS`

docs: api: Replace hotdoc specific commands with Doxygen specific commands 2021-05-13 17:54:58 +03:00			`/*!`
			`* @memberof Wp`
			`*`
			`* @brief`
			`* @arg WP_INIT_PIPEWIRE`
			`* @arg WP_INIT_SPA_TYPES`
			`* @arg WP_INIT_SET_PW_LOG`
			`* @arg WP_INIT_SET_GLIB_LOG`
			`* @arg WP_INIT_ALL`
			`*/`
lib: implement a wp_init() function 2020-05-11 15:45:09 +03:00			`typedef enum {`
			`WP_INIT_PIPEWIRE = (1<<0),`
			`WP_INIT_SPA_TYPES = (1<<1),`
			`WP_INIT_SET_PW_LOG = (1<<2),`
			`WP_INIT_SET_GLIB_LOG = (1<<3),`
			`WP_INIT_ALL = 0xf,`
			`} WpInitFlags;`

			`WP_API`
			`void wp_init (WpInitFlags flags);`

wp: export functions to get the module & config dirs 2021-02-01 12:07:39 +02:00			`WP_API`
			`const gchar * wp_get_module_dir (void);`

			`WP_API`
			`const gchar * wp_get_config_dir (void);`

wp: add wp_get_data_dir() 2021-02-02 17:56:04 +02:00			`WP_API`
			`const gchar * wp_get_data_dir (void);`

lib: implement a wp_init() function 2020-05-11 15:45:09 +03:00			`G_END_DECLS`

			`#endif`