Files
wireplumber/lib/wp/core.h
George Kiagiadakis 60382df63f conf: refactor configuration loading
Changes:

- Configuration files are no longer located by libpipewire,
  which allows us to control the paths that are being looked up.
  This is a requirement for installations where pipewire and
  wireplumber are built using different prefixes, in which case
  the configuration files of wireplumber end up being installed in
  a place that libpipewire doesn't look into...

- The location of conf files is now again $prefix/share/wireplumber,
  /etc/wireplumber and $XDG_CONFIG_HOME/wireplumber, instead of using
  the pipewire directories. Also, since the previous commits, we now
  also support $XDG_CONFIG_DIRS/wireplumber (typically /etc/xdg/wireplumber)
  and $XDG_DATA_DIRS/wireplumber for system-wide configuration.

- Since libpipewire doesn't expose the parser, we now also do the
  parsing of sections ourselves. This has the advantage that we can
  optimize it a bit for our use case.

- The WpConf API has changed to not be a singleton and it is a
  property of WpCore instead. The configuration is now expected
  to be opened before the core is created, which allows the caller
  to identify configuration errors in advance. By not being a singleton,
  we can also reuse the WpConf API to open other SPA-JSON files.

- WpConf also now has a lazy loading mechanism. The configuration
  files are mmap'ed and the various sections are located in advance,
  but not parsed until they are actually requested. Also, the sections
  are not copied in memory, unlike what happens in libpipewire. They
  are only copied when merging is needed.

- WpCore now disables loading of a configuration file in pw_context,
  if a WpConf is provided. This is to have complete control here.
  The 'context.spa-libs' and 'context.modules' sections are still
  loaded, but we load them in WpConf and pass them down to pw_context
  for parsing. If a WpConf is not provided, pw_context is left to load
  the default configuration file (client.conf normally).
2024-03-04 07:07:56 +00:00

164 lines
3.4 KiB
C

/* WirePlumber
*
* Copyright © 2019 Collabora Ltd.
* @author George Kiagiadakis <george.kiagiadakis@collabora.com>
*
* SPDX-License-Identifier: MIT
*/
#ifndef __WIREPLUMBER_CORE_H__
#define __WIREPLUMBER_CORE_H__
#include "object.h"
#include "properties.h"
#include "spa-json.h"
#include "conf.h"
G_BEGIN_DECLS
struct pw_context;
struct pw_core;
typedef struct _WpObjectManager WpObjectManager;
/*!
* \brief Flags to be used as WpObjectFeatures on WpCore
* \ingroup wpcore
*/
typedef enum { /*< flags >*/
/*! connects to pipewire */
WP_CORE_FEATURE_CONNECTED = (1 << 0),
/*! loads components defined in the configuration */
WP_CORE_FEATURE_COMPONENTS = (1 << 1),
} WpCoreFeatures;
/*!
* \brief The WpCore GType
* \ingroup wpcore
*/
#define WP_TYPE_CORE (wp_core_get_type ())
WP_API
G_DECLARE_FINAL_TYPE (WpCore, wp_core, WP, CORE, WpObject)
/* Basic */
WP_API
WpCore * wp_core_new (GMainContext * context, WpConf * conf,
WpProperties * properties);
WP_API
WpCore * wp_core_clone (WpCore * self);
WP_API
WpCore * wp_core_get_export_core (WpCore * self);
WP_API
WpConf * wp_core_get_conf (WpCore * self);
WP_API
GMainContext * wp_core_get_g_main_context (WpCore * self);
WP_API
struct pw_context * wp_core_get_pw_context (WpCore * self);
WP_API
struct pw_core * wp_core_get_pw_core (WpCore * self);
WP_API
gchar *wp_core_get_vm_type (WpCore *self);
/* Connection */
WP_API
gboolean wp_core_connect (WpCore *self);
WP_API
void wp_core_disconnect (WpCore *self);
WP_API
gboolean wp_core_is_connected (WpCore * self);
/* Properties */
WP_API
guint32 wp_core_get_own_bound_id (WpCore * self);
WP_API
guint32 wp_core_get_remote_cookie (WpCore * self);
WP_API
const gchar * wp_core_get_remote_name (WpCore * self);
WP_API
const gchar * wp_core_get_remote_user_name (WpCore * self);
WP_API
const gchar * wp_core_get_remote_host_name (WpCore * self);
WP_API
const gchar * wp_core_get_remote_version (WpCore * self);
WP_API
WpProperties * wp_core_get_remote_properties (WpCore * self);
WP_API
WpProperties * wp_core_get_properties (WpCore * self);
WP_API
void wp_core_update_properties (WpCore * self, WpProperties * updates);
/* Callback */
WP_API
void wp_core_idle_add (WpCore * self, GSource **source, GSourceFunc function,
gpointer data, GDestroyNotify destroy);
WP_API
void wp_core_idle_add_closure (WpCore * self, GSource **source,
GClosure * closure);
WP_API
void wp_core_timeout_add (WpCore * self, GSource **source, guint timeout_ms,
GSourceFunc function, gpointer data, GDestroyNotify destroy);
WP_API
void wp_core_timeout_add_closure (WpCore * self, GSource **source,
guint timeout_ms, GClosure * closure);
WP_API
gboolean wp_core_sync (WpCore * self, GCancellable * cancellable,
GAsyncReadyCallback callback, gpointer user_data);
WP_API
gboolean wp_core_sync_closure (WpCore * self, GCancellable * cancellable,
GClosure * closure);
WP_API
gboolean wp_core_sync_finish (WpCore * self, GAsyncResult * res,
GError ** error);
/* Object Registry */
WP_API
gpointer wp_core_find_object (WpCore * self, GEqualFunc func,
gconstpointer data);
WP_API
void wp_core_register_object (WpCore * self, gpointer obj);
WP_API
void wp_core_remove_object (WpCore * self, gpointer obj);
/* Object Manager */
WP_API
void wp_core_install_object_manager (WpCore * self, WpObjectManager * om);
/* Global Features */
WP_API
gboolean wp_core_test_feature (WpCore * self, const gchar * feature);
G_END_DECLS
#endif