pulse-server: add remap sink and source modules

This commit is contained in:
Wim Taymans 2021-04-22 20:44:06 +02:00
parent 1e6b7b8a83
commit ab7bc6ed27
5 changed files with 528 additions and 0 deletions

View File

@ -111,6 +111,8 @@ pipewire_module_protocol_pulse = shared_library('pipewire-module-protocol-pulse'
'module-protocol-pulse/modules/module-loopback.c',
'module-protocol-pulse/modules/module-native-protocol-tcp.c',
'module-protocol-pulse/modules/module-null-sink.c',
'module-protocol-pulse/modules/module-remap-sink.c',
'module-protocol-pulse/modules/module-remap-source.c',
'module-protocol-pulse/modules/module-simple-protocol-tcp.c',
],
c_args : pipewire_module_c_args,

View File

@ -211,6 +211,8 @@ static const struct module_info module_list[] = {
{ "module-loopback", create_module_loopback, },
{ "module-null-sink", create_module_null_sink, },
{ "module-native-protocol-tcp", create_module_native_protocol_tcp, },
{ "module-remap-sink", create_module_remap_sink, },
{ "module-remap-source", create_module_remap_source, },
{ "module-simple-protocol-tcp", create_module_simple_protocol_tcp, },
{ NULL, }
};

View File

@ -0,0 +1,261 @@
/* 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/param/audio/format-utils.h>
#include <spa/utils/hook.h>
#include <spa/utils/json.h>
#include <pipewire/pipewire.h>
#include <pipewire/private.h>
#include "../defs.h"
#include "../module.h"
#include "registry.h"
#define ERROR_RETURN(str) \
{ \
pw_log_error(str); \
res = -EINVAL; \
goto out; \
}
struct module_remap_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_remap_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 void serialize_dict(FILE *f, const struct spa_dict *dict)
{
const struct spa_dict_item *it;
fprintf(f, "{");
spa_dict_for_each(it, dict) {
size_t len = it->value ? strlen(it->value) : 0;
fprintf(f, " \"%s\" = ", it->key);
if (it->value == NULL) {
fprintf(f, "null");
} else if ( spa_json_is_null(it->value, len) ||
spa_json_is_float(it->value, len) ||
spa_json_is_object(it->value, len)) {
fprintf(f, "%s", it->value);
} else {
size_t size = (len+1) * 4;
char str[size];
spa_json_encode_string(str, size, it->value);
fprintf(f, "%s", str);
}
}
fprintf(f, " }");
}
static int module_remap_sink_load(struct client *client, struct module *module)
{
struct module_remap_sink_data *data = module->user_data;
FILE *f;
char *args;
size_t size;
pw_properties_setf(data->capture_props, PW_KEY_NODE_GROUP, "remap-sink-%u", module->idx);
pw_properties_setf(data->playback_props, PW_KEY_NODE_GROUP, "remap-sink-%u", module->idx);
f = open_memstream(&args, &size);
fprintf(f, "{");
fprintf(f, " capture.props = ");
serialize_dict(f, &data->capture_props->dict);
fprintf(f, " playback.props = ");
serialize_dict(f, &data->playback_props->dict);
fprintf(f, " }");
fclose(f);
data->mod = pw_context_load_module(module->impl->context,
"libpipewire-module-loopback",
args, NULL);
free(args);
if (data->mod == NULL)
return -errno;
pw_impl_module_add_listener(data->mod,
&data->mod_listener,
&module_events, data);
pw_log_info("loaded module %p id:%u name:%s", module, module->idx, module->name);
module_emit_loaded(module, 0);
return 0;
}
static int module_remap_sink_unload(struct client *client, struct module *module)
{
struct module_remap_sink_data *d = module->user_data;
pw_log_info("unload module %p id:%u name:%s", module, module->idx, module->name);
if (d->mod) {
spa_hook_remove(&d->mod_listener);
pw_impl_module_destroy(d->mod);
d->mod = NULL;
}
return 0;
}
static const struct module_methods module_remap_sink_methods = {
VERSION_MODULE_METHODS,
.load = module_remap_sink_load,
.unload = module_remap_sink_unload,
};
static const struct spa_dict_item module_remap_sink_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
{ PW_KEY_MODULE_DESCRIPTION, "Remap sink channels" },
{ PW_KEY_MODULE_USAGE, "sink_name=<name for the sink> "
"sink_properties=<properties for the sink> "
"master=<name of sink to remap> "
"master_channel_map=<channel map> "
"format=<sample format> "
"rate=<sample rate> "
"channels=<number of channels> "
"channel_map=<channel map> "
"resample_method=<resampler> "
"remix=<remix channels?>" },
{ 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 * 6);
for (i = 0; i < info->channels; i++)
p += snprintf(p, 6, "%s%s", i == 0 ? "" : ",",
channel_id2name(info->position[i]));
pw_properties_set(props, SPA_KEY_AUDIO_POSITION, s);
}
struct module *create_module_remap_sink(struct impl *impl, const char *argument)
{
struct module *module;
struct module_remap_sink_data *d;
struct pw_properties *props = NULL, *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;
props = pw_properties_new_dict(&SPA_DICT_INIT_ARRAY(module_remap_sink_info));
capture_props = pw_properties_new(NULL, NULL);
playback_props = pw_properties_new(NULL, NULL);
if (!props || !capture_props || !playback_props) {
res = -EINVAL;
goto out;
}
if (argument)
module_args_add_props(props, argument);
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);
} else {
pw_properties_set(props, PW_KEY_NODE_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);
}
pw_properties_set(capture_props, PW_KEY_MEDIA_CLASS, "Audio/Sink");
if ((str = pw_properties_get(props, "master")) != NULL) {
pw_properties_set(playback_props, PW_KEY_NODE_TARGET, str);
pw_properties_set(props, "master", NULL);
}
if (module_args_to_audioinfo(impl, props, &capture_info) < 0) {
res = -EINVAL;
goto out;
}
playback_info = capture_info;
if ((str = pw_properties_get(props, "master_channel_map")) != NULL) {
struct channel_map map;
channel_map_parse(str, &map);
if (map.channels == 0 || map.channels > SPA_AUDIO_MAX_CHANNELS) {
pw_log_error("invalid channel_map '%s'", str);
res = -EINVAL;
goto out;
}
channel_map_to_positions(&map, playback_info.position);
pw_properties_set(props, "master_channel_map", NULL);
}
position_to_props(&capture_info, capture_props);
position_to_props(&playback_info, playback_props);
if ((str = pw_properties_get(props, "remix")) != NULL) {
/* Note that the boolean is inverted */
pw_properties_set(playback_props, PW_KEY_STREAM_DONT_REMIX,
pw_properties_parse_bool(str) ? "false" : "true");
pw_properties_set(props, "remix", NULL);
}
module = module_new(impl, &module_remap_sink_methods, sizeof(*d));
if (module == NULL) {
res = -errno;
goto out;
}
module->props = props;
d = module->user_data;
d->module = module;
d->capture_props = capture_props;
d->playback_props = playback_props;
return module;
out:
if (props)
pw_properties_free(props);
if (playback_props)
pw_properties_free(playback_props);
if (capture_props)
pw_properties_free(capture_props);
errno = -res;
return NULL;
}

View File

@ -0,0 +1,261 @@
/* 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/param/audio/format-utils.h>
#include <spa/utils/hook.h>
#include <spa/utils/json.h>
#include <pipewire/pipewire.h>
#include <pipewire/private.h>
#include "../defs.h"
#include "../module.h"
#include "registry.h"
#define ERROR_RETURN(str) \
{ \
pw_log_error(str); \
res = -EINVAL; \
goto out; \
}
struct module_remap_source_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_remap_source_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 void serialize_dict(FILE *f, const struct spa_dict *dict)
{
const struct spa_dict_item *it;
fprintf(f, "{");
spa_dict_for_each(it, dict) {
size_t len = it->value ? strlen(it->value) : 0;
fprintf(f, " \"%s\" = ", it->key);
if (it->value == NULL) {
fprintf(f, "null");
} else if ( spa_json_is_null(it->value, len) ||
spa_json_is_float(it->value, len) ||
spa_json_is_object(it->value, len)) {
fprintf(f, "%s", it->value);
} else {
size_t size = (len+1) * 4;
char str[size];
spa_json_encode_string(str, size, it->value);
fprintf(f, "%s", str);
}
}
fprintf(f, " }");
}
static int module_remap_source_load(struct client *client, struct module *module)
{
struct module_remap_source_data *data = module->user_data;
FILE *f;
char *args;
size_t size;
pw_properties_setf(data->capture_props, PW_KEY_NODE_GROUP, "remap-source-%u", module->idx);
pw_properties_setf(data->playback_props, PW_KEY_NODE_GROUP, "remap-source-%u", module->idx);
f = open_memstream(&args, &size);
fprintf(f, "{");
fprintf(f, " capture.props = ");
serialize_dict(f, &data->capture_props->dict);
fprintf(f, " playback.props = ");
serialize_dict(f, &data->playback_props->dict);
fprintf(f, " }");
fclose(f);
data->mod = pw_context_load_module(module->impl->context,
"libpipewire-module-loopback",
args, NULL);
free(args);
if (data->mod == NULL)
return -errno;
pw_impl_module_add_listener(data->mod,
&data->mod_listener,
&module_events, data);
pw_log_info("loaded module %p id:%u name:%s", module, module->idx, module->name);
module_emit_loaded(module, 0);
return 0;
}
static int module_remap_source_unload(struct client *client, struct module *module)
{
struct module_remap_source_data *d = module->user_data;
pw_log_info("unload module %p id:%u name:%s", module, module->idx, module->name);
if (d->mod) {
spa_hook_remove(&d->mod_listener);
pw_impl_module_destroy(d->mod);
d->mod = NULL;
}
return 0;
}
static const struct module_methods module_remap_source_methods = {
VERSION_MODULE_METHODS,
.load = module_remap_source_load,
.unload = module_remap_source_unload,
};
static const struct spa_dict_item module_remap_source_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
{ PW_KEY_MODULE_DESCRIPTION, "Remap source channels" },
{ PW_KEY_MODULE_USAGE, "source_name=<name for the source> "
"source_properties=<properties for the source> "
"master=<name of source to filter> "
"master_channel_map=<channel map> "
"format=<sample format> "
"rate=<sample rate> "
"channels=<number of channels> "
"channel_map=<channel map> "
"resample_method=<resampler> "
"remix=<remix channels?>" },
{ 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 * 6);
for (i = 0; i < info->channels; i++)
p += snprintf(p, 6, "%s%s", i == 0 ? "" : ",",
channel_id2name(info->position[i]));
pw_properties_set(props, SPA_KEY_AUDIO_POSITION, s);
}
struct module *create_module_remap_source(struct impl *impl, const char *argument)
{
struct module *module;
struct module_remap_source_data *d;
struct pw_properties *props = NULL, *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;
props = pw_properties_new_dict(&SPA_DICT_INIT_ARRAY(module_remap_source_info));
capture_props = pw_properties_new(NULL, NULL);
playback_props = pw_properties_new(NULL, NULL);
if (!props || !capture_props || !playback_props) {
res = -EINVAL;
goto out;
}
if (argument)
module_args_add_props(props, argument);
if ((str = pw_properties_get(props, "source_name")) != NULL) {
pw_properties_set(playback_props, PW_KEY_NODE_NAME, str);
pw_properties_set(props, "source_name", NULL);
} else {
pw_properties_set(props, PW_KEY_NODE_NAME, "null");
}
if ((str = pw_properties_get(props, "source_properties")) != NULL) {
module_args_add_props(playback_props, str);
pw_properties_set(props, "source_properties", NULL);
}
pw_properties_set(playback_props, PW_KEY_MEDIA_CLASS, "Audio/Source");
if ((str = pw_properties_get(props, "master")) != NULL) {
pw_properties_set(capture_props, PW_KEY_NODE_TARGET, str);
pw_properties_set(props, "master", NULL);
}
if (module_args_to_audioinfo(impl, props, &playback_info) < 0) {
res = -EINVAL;
goto out;
}
capture_info = playback_info;
if ((str = pw_properties_get(props, "master_channel_map")) != NULL) {
struct channel_map map;
channel_map_parse(str, &map);
if (map.channels == 0 || map.channels > SPA_AUDIO_MAX_CHANNELS) {
pw_log_error("invalid channel_map '%s'", str);
res = -EINVAL;
goto out;
}
channel_map_to_positions(&map, capture_info.position);
pw_properties_set(props, "master_channel_map", NULL);
}
position_to_props(&playback_info, playback_props);
position_to_props(&capture_info, capture_props);
if ((str = pw_properties_get(props, "remix")) != NULL) {
/* Note that the boolean is inverted */
pw_properties_set(capture_props, PW_KEY_STREAM_DONT_REMIX,
pw_properties_parse_bool(str) ? "false" : "true");
pw_properties_set(props, "remix", NULL);
}
module = module_new(impl, &module_remap_source_methods, sizeof(*d));
if (module == NULL) {
res = -errno;
goto out;
}
module->props = props;
d = module->user_data;
d->module = module;
d->capture_props = capture_props;
d->playback_props = playback_props;
return module;
out:
if (props)
pw_properties_free(props);
if (playback_props)
pw_properties_free(playback_props);
if (capture_props)
pw_properties_free(capture_props);
errno = -res;
return NULL;
}

View File

@ -31,6 +31,8 @@
struct module *create_module_loopback(struct impl *impl, const char *argument);
struct module *create_module_native_protocol_tcp(struct impl *impl, const char *argument);
struct module *create_module_null_sink(struct impl *impl, const char *argument);
struct module *create_module_remap_sink(struct impl *impl, const char *argument);
struct module *create_module_remap_source(struct impl *impl, const char *argument);
struct module *create_module_simple_protocol_tcp(struct impl *impl, const char *argument);
#endif