summaryrefslogtreecommitdiffstats
path: root/src/modules/module-protocol-pulse/modules/module-ladspa-sink.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/module-protocol-pulse/modules/module-ladspa-sink.c')
-rw-r--r--src/modules/module-protocol-pulse/modules/module-ladspa-sink.c257
1 files changed, 257 insertions, 0 deletions
diff --git a/src/modules/module-protocol-pulse/modules/module-ladspa-sink.c b/src/modules/module-protocol-pulse/modules/module-ladspa-sink.c
new file mode 100644
index 0000000..3b3b700
--- /dev/null
+++ b/src/modules/module-protocol-pulse/modules/module-ladspa-sink.c
@@ -0,0 +1,257 @@
+/* PipeWire
+ *
+ * Copyright © 2021 Wim Taymans <wim.taymans@gmail.com>
+ *
+ * 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 <spa/utils/hook.h>
+#include <spa/utils/json.h>
+#include <spa/param/audio/format-utils.h>
+
+#include <pipewire/pipewire.h>
+
+#include "../defs.h"
+#include "../module.h"
+
+#define NAME "ladspa-sink"
+
+PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
+#define PW_LOG_TOPIC_DEFAULT mod_topic
+
+struct module_ladspa_sink_data {
+ struct module *module;
+
+ struct pw_impl_module *mod;
+ struct spa_hook mod_listener;
+
+ struct pw_properties *capture_props;
+ struct pw_properties *playback_props;
+};
+
+static void module_destroy(void *data)
+{
+ struct module_ladspa_sink_data *d = data;
+ spa_hook_remove(&d->mod_listener);
+ d->mod = NULL;
+ module_schedule_unload(d->module);
+}
+
+static const struct pw_impl_module_events module_events = {
+ PW_VERSION_IMPL_MODULE_EVENTS,
+ .destroy = module_destroy
+};
+
+static int module_ladspa_sink_load(struct module *module)
+{
+ struct module_ladspa_sink_data *data = module->user_data;
+ FILE *f;
+ char *args;
+ const char *str, *plugin, *label;
+ size_t size;
+
+ if ((plugin = pw_properties_get(module->props, "plugin")) == NULL)
+ return -EINVAL;
+ if ((label = pw_properties_get(module->props, "label")) == NULL)
+ return -EINVAL;
+
+ pw_properties_setf(data->capture_props, PW_KEY_NODE_GROUP, "ladspa-sink-%u", module->index);
+ pw_properties_setf(data->playback_props, PW_KEY_NODE_GROUP, "ladspa-sink-%u", module->index);
+ pw_properties_setf(data->capture_props, "pulse.module.id", "%u", module->index);
+ pw_properties_setf(data->playback_props, "pulse.module.id", "%u", module->index);
+
+ if ((f = open_memstream(&args, &size)) == NULL)
+ return -errno;
+
+ fprintf(f, "{");
+ pw_properties_serialize_dict(f, &module->props->dict, 0);
+ fprintf(f, " filter.graph = {");
+ fprintf(f, " nodes = [ { ");
+ fprintf(f, " type = ladspa ");
+ fprintf(f, " plugin = \"%s\" ", plugin);
+ fprintf(f, " label = \"%s\" ", label);
+ if ((str = pw_properties_get(module->props, "control")) != NULL) {
+ size_t len;
+ const char *s, *state = NULL;
+ int count = 0;
+
+ fprintf(f, " control = {");
+ while ((s = pw_split_walk(str, ", ", &len, &state))) {
+ fprintf(f, " \"%d\" = %.*s", count, (int)len, s);
+ count++;
+ }
+ fprintf(f, " }");
+ }
+ fprintf(f, " } ]");
+ if ((str = pw_properties_get(module->props, "inputs")) != NULL)
+ fprintf(f, " inputs = [ %s ] ", str);
+ if ((str = pw_properties_get(module->props, "outputs")) != NULL)
+ fprintf(f, " outputs = [ %s ] ", str);
+ fprintf(f, " }");
+ fprintf(f, " capture.props = {");
+ pw_properties_serialize_dict(f, &data->capture_props->dict, 0);
+ fprintf(f, " } playback.props = {");
+ pw_properties_serialize_dict(f, &data->playback_props->dict, 0);
+ fprintf(f, " } }");
+ fclose(f);
+
+ data->mod = pw_context_load_module(module->impl->context,
+ "libpipewire-module-filter-chain",
+ args, NULL);
+ free(args);
+
+ if (data->mod == NULL)
+ return -errno;
+
+ pw_impl_module_add_listener(data->mod,
+ &data->mod_listener,
+ &module_events, data);
+
+ return 0;
+}
+
+static int module_ladspa_sink_unload(struct module *module)
+{
+ struct module_ladspa_sink_data *d = module->user_data;
+
+ if (d->mod) {
+ spa_hook_remove(&d->mod_listener);
+ pw_impl_module_destroy(d->mod);
+ d->mod = NULL;
+ }
+
+ pw_properties_free(d->capture_props);
+ pw_properties_free(d->playback_props);
+
+ return 0;
+}
+
+static const struct spa_dict_item module_ladspa_sink_info[] = {
+ { PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
+ { PW_KEY_MODULE_DESCRIPTION, "Virtual LADSPA sink" },
+ { PW_KEY_MODULE_USAGE,
+ "sink_name=<name for the sink> "
+ "sink_properties=<properties for the sink> "
+ "sink_input_properties=<properties for the sink input> "
+ "master=<name of sink to filter> "
+ "sink_master=<name of sink to filter> "
+ "format=<sample format> "
+ "rate=<sample rate> "
+ "channels=<number of channels> "
+ "channel_map=<input channel map> "
+ "plugin=<ladspa plugin name> "
+ "label=<ladspa plugin label> "
+ "control=<comma separated list of input control values> "
+ "input_ladspaport_map=<comma separated list of input LADSPA port names> "
+ "output_ladspaport_map=<comma separated list of output LADSPA port names> "},
+ { PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
+};
+
+static void position_to_props(struct spa_audio_info_raw *info, struct pw_properties *props)
+{
+ char *s, *p;
+ uint32_t i;
+
+ pw_properties_setf(props, SPA_KEY_AUDIO_CHANNELS, "%u", info->channels);
+ p = s = alloca(info->channels * 8);
+ for (i = 0; i < info->channels; i++)
+ p += spa_scnprintf(p, 8, "%s%s", i == 0 ? "" : ",",
+ channel_id2name(info->position[i]));
+ pw_properties_set(props, SPA_KEY_AUDIO_POSITION, s);
+}
+
+static int module_ladspa_sink_prepare(struct module * const module)
+{
+ struct module_ladspa_sink_data * const d = module->user_data;
+ struct pw_properties * const props = module->props;
+ struct pw_properties *playback_props = NULL, *capture_props = NULL;
+ const char *str;
+ struct spa_audio_info_raw capture_info = { 0 };
+ struct spa_audio_info_raw playback_info = { 0 };
+ int res;
+
+ PW_LOG_TOPIC_INIT(mod_topic);
+
+ capture_props = pw_properties_new(NULL, NULL);
+ playback_props = pw_properties_new(NULL, NULL);
+ if (!capture_props || !playback_props) {
+ res = -EINVAL;
+ goto out;
+ }
+
+ if ((str = pw_properties_get(props, "sink_name")) != NULL) {
+ pw_properties_set(capture_props, PW_KEY_NODE_NAME, str);
+ pw_properties_set(props, "sink_name", NULL);
+ }
+ if ((str = pw_properties_get(props, "sink_properties")) != NULL) {
+ module_args_add_props(capture_props, str);
+ pw_properties_set(props, "sink_properties", NULL);
+ }
+ if (pw_properties_get(capture_props, PW_KEY_MEDIA_CLASS) == NULL)
+ pw_properties_set(capture_props, PW_KEY_MEDIA_CLASS, "Audio/Sink");
+ if (pw_properties_get(capture_props, PW_KEY_DEVICE_CLASS) == NULL)
+ pw_properties_set(capture_props, PW_KEY_DEVICE_CLASS, "filter");
+
+ if ((str = pw_properties_get(capture_props, PW_KEY_NODE_DESCRIPTION)) == NULL) {
+ str = pw_properties_get(capture_props, PW_KEY_NODE_NAME);
+ pw_properties_setf(props, PW_KEY_NODE_DESCRIPTION,
+ "%s Sink", str);
+ } else {
+ pw_properties_set(props, PW_KEY_NODE_DESCRIPTION, str);
+ }
+
+ if ((str = pw_properties_get(props, "master")) != NULL ||
+ (str = pw_properties_get(props, "sink_master")) != NULL) {
+ pw_properties_set(playback_props, PW_KEY_TARGET_OBJECT, str);
+ pw_properties_set(props, "master", NULL);
+ }
+
+ if (module_args_to_audioinfo(module->impl, props, &capture_info) < 0) {
+ res = -EINVAL;
+ goto out;
+ }
+ playback_info = capture_info;
+
+ position_to_props(&capture_info, capture_props);
+ position_to_props(&playback_info, playback_props);
+
+ if (pw_properties_get(playback_props, PW_KEY_NODE_PASSIVE) == NULL)
+ pw_properties_set(playback_props, PW_KEY_NODE_PASSIVE, "true");
+
+ d->module = module;
+ d->capture_props = capture_props;
+ d->playback_props = playback_props;
+
+ return 0;
+out:
+ pw_properties_free(playback_props);
+ pw_properties_free(capture_props);
+
+ return res;
+}
+
+DEFINE_MODULE_INFO(module_ladspa_sink) = {
+ .name = "module-ladspa-sink",
+ .prepare = module_ladspa_sink_prepare,
+ .load = module_ladspa_sink_load,
+ .unload = module_ladspa_sink_unload,
+ .properties = &SPA_DICT_INIT_ARRAY(module_ladspa_sink_info),
+ .data_size = sizeof(struct module_ladspa_sink_data),
+};