client-device: add client device

Make it possible to implement a device out-of-process

src/modules/spa/module-device-factory.c

@@ -0,0 +1,212 @@
+/* PipeWire
+ *
+ * Copyright © 2018 Wim Taymans
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+#include <string.h>
+#include <stdio.h>
+#include <errno.h>
+#include <dlfcn.h>
+
+#include "config.h"
+
+#include "pipewire/pipewire.h"
+
+#include "spa-device.h"
+
+static const struct spa_dict_item module_props[] = {
+	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
+	{ PW_KEY_MODULE_DESCRIPTION, "Provide a factory to make SPA devices" },
+	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
+};
+
+struct factory_data {
+	struct pw_core *core;
+	struct pw_factory *this;
+	struct pw_properties *properties;
+
+	struct spa_hook factory_listener;
+	struct spa_hook module_listener;
+
+	struct spa_list device_list;
+};
+
+struct device_data {
+	struct spa_list link;
+	struct pw_device *device;
+	struct spa_hook device_listener;
+};
+
+static void device_destroy(void *data)
+{
+	struct device_data *nd = data;
+	spa_list_remove(&nd->link);
+	spa_hook_remove(&nd->device_listener);
+}
+
+static const struct pw_device_events device_events = {
+	PW_VERSION_DEVICE_EVENTS,
+	.destroy = device_destroy,
+};
+
+static void *create_object(void *_data,
+			   struct pw_resource *resource,
+			   uint32_t type,
+			   uint32_t version,
+			   struct pw_properties *properties,
+			   uint32_t new_id)
+{
+	struct factory_data *data = _data;
+	struct pw_device *device;
+	const char *lib, *factory_name, *name;
+	struct device_data *nd;
+
+	if (properties == NULL)
+		goto no_properties;
+
+	lib = pw_properties_get(properties, "spa.library.name");
+	factory_name = pw_properties_get(properties, "spa.factory.name");
+	name = pw_properties_get(properties, "name");
+
+	if (lib == NULL || factory_name == NULL)
+		goto no_properties;
+
+	if (name == NULL)
+		name = "spa-device";
+
+	device = pw_spa_device_load(data->core,
+				NULL,
+				pw_factory_get_global(data->this),
+				lib,
+				factory_name,
+				name,
+				0,
+				properties,
+				sizeof(struct device_data));
+	if (device == NULL)
+		goto no_mem;
+
+	nd = pw_spa_device_get_user_data(device);
+	nd->device = device;
+	spa_list_append(&data->device_list, &nd->link);
+
+	pw_device_add_listener(device, &nd->device_listener, &device_events, nd);
+
+	if (resource)
+		pw_global_bind(pw_device_get_global(device),
+			       pw_resource_get_client(resource),
+			       PW_PERM_RWX,
+			       version, new_id);
+
+	return device;
+
+      no_properties:
+	pw_log_error("needed properties: spa.library.name=<library-name> spa.factory.name=<factory-name>");
+	if (resource) {
+		pw_resource_error(resource, -EINVAL,
+					"needed properties: "
+						"spa.library.name=<library-name> "
+						"spa.factory.name=<factory-name>");
+	}
+	return NULL;
+      no_mem:
+	pw_log_error("can't create device: no memory");
+	if (resource) {
+		pw_resource_error(resource, -ENOMEM, "no memory");
+	}
+	return NULL;
+}
+
+static const struct pw_factory_implementation factory_impl = {
+	PW_VERSION_FACTORY_IMPLEMENTATION,
+	.create_object = create_object,
+};
+
+static void factory_destroy(void *_data)
+{
+	struct factory_data *data = _data;
+	struct device_data *nd;
+
+	spa_hook_remove(&data->module_listener);
+
+	spa_list_consume(nd, &data->device_list, link)
+		pw_device_destroy(nd->device);
+
+	if (data->properties)
+		pw_properties_free(data->properties);
+}
+
+static const struct pw_factory_events factory_events = {
+	PW_VERSION_FACTORY_IMPLEMENTATION,
+	.destroy = factory_destroy,
+};
+
+static void module_destroy(void *_data)
+{
+	struct factory_data *data = _data;
+	pw_factory_destroy(data->this);
+}
+
+static const struct pw_module_events module_events = {
+	PW_VERSION_MODULE_EVENTS,
+	.destroy = module_destroy,
+};
+
+static int module_init(struct pw_module *module, struct pw_properties *properties)
+{
+	struct pw_core *core = pw_module_get_core(module);
+	struct pw_factory *factory;
+	struct factory_data *data;
+
+	factory = pw_factory_new(core,
+				 "spa-device-factory",
+				 PW_TYPE_INTERFACE_Device,
+				 PW_VERSION_DEVICE_PROXY,
+				 NULL,
+				 sizeof(*data));
+	if (factory == NULL)
+		return -ENOMEM;
+
+	data = pw_factory_get_user_data(factory);
+	data->this = factory;
+	data->core = core;
+	data->properties = properties;
+	spa_list_init(&data->device_list);
+
+	pw_factory_add_listener(factory, &data->factory_listener, &factory_events, data);
+	pw_factory_set_implementation(factory, &factory_impl, data);
+
+	pw_log_debug("module %p: new", module);
+	pw_module_add_listener(module, &data->module_listener, &module_events, data);
+
+	pw_module_update_properties(module, &SPA_DICT_INIT_ARRAY(module_props));
+
+	pw_factory_register(factory, NULL, pw_module_get_global(module), NULL);
+
+	return 0;
+}
+
+SPA_EXPORT
+int pipewire__module_init(struct pw_module *module, const char *args)
+{
+	return module_init(module, NULL);
+}