Files
wireplumber/lib/wp/factory.c
George Kiagiadakis e7e5c66853 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:49:39 +02:00

140 lines
3.1 KiB
C

/* WirePlumber
*
* Copyright © 2019 Collabora Ltd.
* @author George Kiagiadakis <george.kiagiadakis@collabora.com>
*
* SPDX-License-Identifier: MIT
*/
#include "factory.h"
#include "private.h"
struct _WpFactory
{
GObject parent;
GWeakRef core;
gchar *name;
GQuark name_quark;
WpFactoryFunc create_object;
};
G_DEFINE_TYPE (WpFactory, wp_factory, G_TYPE_OBJECT)
static void
wp_factory_init (WpFactory * self)
{
}
static void
wp_factory_finalize (GObject * obj)
{
WpFactory * self = WP_FACTORY (obj);
g_debug ("WpFactory:%p destroying factory: %s", self, self->name);
g_weak_ref_clear (&self->core);
g_free (self->name);
G_OBJECT_CLASS (wp_factory_parent_class)->finalize (obj);
}
static void
wp_factory_class_init (WpFactoryClass * klass)
{
GObjectClass *object_class = (GObjectClass *) klass;
object_class->finalize = wp_factory_finalize;
}
/**
* wp_factory_new:
* @core: the core
* @name: the name of the factory
* @func: the create object callback
*
* Returns: (transfer none): the newly created factory. No reference
* is passed to the caller, since the reference is held by the core.
* The caller is free to ignore the return value
*/
WpFactory *
wp_factory_new (WpCore * core, const gchar * name, WpFactoryFunc func)
{
WpFactory *f = NULL;
g_return_val_if_fail (func, NULL);
g_return_val_if_fail (name != NULL && *name != '\0', NULL);
f = g_object_new (WP_TYPE_FACTORY, NULL);
g_weak_ref_init (&f->core, core);
f->name = g_strdup (name);
f->name_quark = g_quark_from_string (f->name);
f->create_object = func;
g_info ("WpFactory:%p new factory: %s", f, name);
wp_core_register_object (core, f);
return f;
}
const gchar *
wp_factory_get_name (WpFactory * self)
{
return self->name;
}
/**
* wp_factory_get_core:
* @self: the factory
*
* Returns: (transfer full): the core on which this factory is registered
*/
WpCore *
wp_factory_get_core (WpFactory * self)
{
return g_weak_ref_get (&self->core);
}
void
wp_factory_create_object (WpFactory * self, GType type,
GVariant * properties, GAsyncReadyCallback ready, gpointer user_data)
{
g_debug ("WpFactory:%p (%s) create object of type %s", self, self->name,
g_type_name (type));
self->create_object (self, type, properties, ready, user_data);
}
static gboolean
find_factory_func (gpointer factory, gpointer name_quark)
{
return WP_IS_FACTORY (factory) &&
WP_FACTORY (factory)->name_quark == GPOINTER_TO_UINT (name_quark);
}
/**
* wp_factory_find:
* @core: the core
* @name: the lookup name
*
* Returns: (transfer full): the factory matching the lookup name
*/
WpFactory *
wp_factory_find (WpCore * core, const gchar * name)
{
GObject *f;
GQuark q = g_quark_from_string (name);
f = wp_core_find_object (core, (GEqualFunc) find_factory_func,
GUINT_TO_POINTER (q));
return f ? WP_FACTORY (f) : NULL;
}
void
wp_factory_make (WpCore * core, const gchar * name, GType type,
GVariant * properties, GAsyncReadyCallback ready, gpointer user_data)
{
g_autoptr (WpFactory) f = wp_factory_find (core, name);
if (!f) return;
wp_factory_create_object (f, type, properties, ready, user_data);
}