mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

modules: clean up USAGE arguments

Browse source 
use () to mark optional arguments to avoid confusion with arrays.
Add some more optional arguments.
This commit is contained in:
Wim Taymans 2023-03-22 16:35:55 +01:00
parent 3decaa6457
commit 07e6f44e58
24 changed files with 200 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/modules/module-access.c
View file

@ -111,10 +111,10 @@
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define PW_LOG_TOPIC_DEFAULT mod_topic
#define MODULE_USAGE "[ access.force=flatpak ] " \
"[ access.allowed=<cmd-line> ] " \
"[ access.rejected=<cmd-line> ] " \
"[ access.restricted=<cmd-line> ] " \
#define MODULE_USAGE "( access.force=flatpak ) " \
"( access.allowed= [ <cmd-line>,.. ] ) " \
"( access.rejected= [ <cmd-line>,.. ] ) " \
"( access.restricted= [ <cmd-line>,.. ] ) " \
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

2
src/modules/module-adapter.c
View file

@ -26,7 +26,7 @@ PW_LOG_TOPIC(mod_topic, "mod." NAME);
#define PW_LOG_TOPIC_DEFAULT mod_topic
#define FACTORY_USAGE SPA_KEY_FACTORY_NAME"=<factory-name> " \
"["SPA_KEY_LIBRARY_NAME"=<library-name>] " \
"("SPA_KEY_LIBRARY_NAME"=<library-name>) " \
ADAPTER_USAGE
static const struct spa_dict_item module_props[] = {

18
src/modules/module-combine-stream.c
View file

@ -198,15 +198,15 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_CHANNELS 2
#define DEFAULT_POSITION "[ FL FR ]"
#define MODULE_USAGE "[ node.latency=<latency as fraction> ] " \
"[ combine.mode=<mode of stream, playback|capture|sink|source>, default:sink ] " \
"[ node.name=<name of the stream> ] " \
"[ node.description=<description of the stream> ] " \
"[ audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS) "> ] " \
"[ audio.position=<channel map, default:"DEFAULT_POSITION"> ] " \
"[ combine.props=<properties> ] " \
"[ stream.props=<properties> ] " \
"[ stream.rules=<properties> ] "
#define MODULE_USAGE "( node.latency=<latency as fraction> ) " \
"( combine.mode=<mode of stream, playback|capture|sink|source>, default:sink ) " \
"( node.name=<name of the stream> ) " \
"( node.description=<description of the stream> ) " \
"( audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS) "> ) " \
"( audio.position=<channel map, default:"DEFAULT_POSITION"> ) " \
"( combine.props=<properties> ) " \
"( stream.props=<properties> ) " \
"( stream.rules=<properties> ) "
static const struct spa_dict_item module_props[] = {

26
src/modules/module-echo-cancel.c
View file

@ -157,19 +157,19 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
{ PW_KEY_MODULE_DESCRIPTION, "Echo Cancellation" },
{ PW_KEY_MODULE_USAGE, " [ remote.name=<remote> ] "
"[ node.latency=<latency as fraction> ] "
"[ audio.rate=<sample rate> ] "
"[ audio.channels=<number of channels> ] "
"[ audio.position=<channel map> ] "
"[ buffer.max_size=<max buffer size in ms> ] "
"[ buffer.play_delay=<delay as fraction> ] "
"[ library.name =<library name> ] "
"[ aec.args=<aec arguments> ] "
"[ capture.props=<properties> ] "
"[ source.props=<properties> ] "
"[ sink.props=<properties> ] "
"[ playback.props=<properties> ] " },
{ PW_KEY_MODULE_USAGE, " ( remote.name=<remote> ) "
"( node.latency=<latency as fraction> ) "
"( audio.rate=<sample rate> ) "
"( audio.channels=<number of channels> ) "
"( audio.position=<channel map> ) "
"( buffer.max_size=<max buffer size in ms> ) "
"( buffer.play_delay=<delay as fraction> ) "
"( library.name =<library name> ) "
"( aec.args=<aec arguments> ) "
"( capture.props=<properties> ) "
"( source.props=<properties> ) "
"( sink.props=<properties> ) "
"( playback.props=<properties> ) " },
{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
};

16
src/modules/module-example-sink.c
View file

@ -83,14 +83,14 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_CHANNELS 2
#define DEFAULT_POSITION "[ FL FR ]"
#define MODULE_USAGE "[ node.latency=<latency as fraction> ] " \
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ audio.format=<format, default:"DEFAULT_FORMAT"> ] " \
"[ audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS) "> ] " \
"[ audio.position=<channel map, default:"DEFAULT_POSITION"> ] " \
"[ stream.props=<properties> ] "
#define MODULE_USAGE "( node.latency=<latency as fraction> ) " \
"( node.name=<name of the nodes> ) " \
"( node.description=<description of the nodes> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS) "> ) " \
"( audio.position=<channel map, default:"DEFAULT_POSITION"> ] " \
"( stream.props=<properties> ) "
static const struct spa_dict_item module_props[] = {

16
src/modules/module-example-source.c
View file

@ -83,14 +83,14 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_CHANNELS 2
#define DEFAULT_POSITION "[ FL FR ]"
#define MODULE_USAGE "[ node.latency=<latency as fraction> ] " \
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ audio.format=<format, default:"DEFAULT_FORMAT"> ] " \
"[ audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS) "> ] " \
"[ audio.position=<channel map, default:"DEFAULT_POSITION"> ] " \
"[ stream.props=<properties> ] "
#define MODULE_USAGE "( node.latency=<latency as fraction> ) " \
"( node.name=<name of the nodes> ) " \
"( node.description=<description of the nodes> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS) "> ) " \
"( audio.position=<channel map, default:"DEFAULT_POSITION"> ) " \
"( stream.props=<properties> ) "
static const struct spa_dict_item module_props[] = {

4
src/modules/module-fallback-sink.c
View file

@ -33,8 +33,8 @@
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define PW_LOG_TOPIC_DEFAULT mod_topic
#define MODULE_USAGE ("[ sink.name=<str> ] " \
"[ sink.description=<str> ] ")
#define MODULE_USAGE ("( sink.name=<str> ) " \
"( sink.description=<str> ) ")
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Pauli Virtanen <pav@iki.fi>" },

26
src/modules/module-filter-chain.c
View file

@ -62,7 +62,7 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
* filter.graph = {
* nodes = [
* {
* type = <ladspa | lv2 | builtin>
* type = <ladspa | lv2 | builtin | sofa>
* name = <name>
* plugin = <plugin>
* label = <label>
@ -102,9 +102,11 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
* - For LV2 this is unused
* - For builtin and sofa this is the name of the filter to use
*
* - `config` contains a filter specific configuration section. The convolver
* plugin needs this.
* - `config` contains a filter specific configuration section. Some plugins need
* this. (convolver, sofa, delay, ...)
* - `control` contains the initial values for the control ports of the filter.
* normally these are given with the port name but it is also possible
* to give the control index as the key.
*
* ### Links
*
@ -435,16 +437,16 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
{ PW_KEY_MODULE_DESCRIPTION, "Create filter chain streams" },
{ PW_KEY_MODULE_USAGE, " [ remote.name=<remote> ] "
"[ node.latency=<latency as fraction> ] "
"[ node.description=<description of the nodes> ] "
"[ audio.rate=<sample rate> ] "
"[ audio.channels=<number of channels> ] "
"[ audio.position=<channel map> ] "
{ PW_KEY_MODULE_USAGE, " ( remote.name=<remote> ) "
"( node.latency=<latency as fraction> ) "
"( node.description=<description of the nodes> ) "
"( audio.rate=<sample rate> ) "
"( audio.channels=<number of channels> ) "
"( audio.position=<channel map> ) "
"filter.graph = [ "
" nodes = [ "
" { "
" type = <ladspa | lv2 | builtin> "
" type = <ladspa | lv2 | builtin | sofa> "
" name = <name> "
" plugin = <plugin> "
" label = <label> "
@ -462,8 +464,8 @@ static const struct spa_dict_item module_props[] = {
" inputs = [ <portname> ... ] "
" outputs = [ <portname> ... ] "
"] "
"[ capture.props=<properties> ] "
"[ playback.props=<properties> ] " },
"( capture.props=<properties> ) "
"( playback.props=<properties> ) " },
{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
};

12
src/modules/module-link-factory.c
View file

@ -22,12 +22,12 @@
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define PW_LOG_TOPIC_DEFAULT mod_topic
#define FACTORY_USAGE PW_KEY_LINK_OUTPUT_NODE"=<output-node> " \
"["PW_KEY_LINK_OUTPUT_PORT"=<output-port>] " \
PW_KEY_LINK_INPUT_NODE"=<input-node> " \
"["PW_KEY_LINK_INPUT_PORT"=<input-port>] " \
"["PW_KEY_OBJECT_LINGER"=<bool>] " \
"["PW_KEY_LINK_PASSIVE"=<bool>]"
#define FACTORY_USAGE "("PW_KEY_LINK_OUTPUT_NODE"=<output-node>) " \
"("PW_KEY_LINK_OUTPUT_PORT"=<output-port>) " \
"("PW_KEY_LINK_INPUT_NODE"=<input-node>) " \
"("PW_KEY_LINK_INPUT_PORT"=<input-port>) " \
"("PW_KEY_OBJECT_LINGER"=<bool>) " \
"("PW_KEY_LINK_PASSIVE"=<bool>)"
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

18
src/modules/module-loopback.c
View file

@ -130,15 +130,15 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
{ PW_KEY_MODULE_DESCRIPTION, "Create loopback streams" },
{ PW_KEY_MODULE_USAGE, " [ remote.name=<remote> ] "
"[ node.latency=<latency as fraction> ] "
"[ node.description=<description of the nodes> ] "
"[ audio.rate=<sample rate> ] "
"[ audio.channels=<number of channels> ] "
"[ audio.position=<channel map> ] "
"[ target.delay.sec=<delay as seconds in float> ] "
"[ capture.props=<properties> ] "
"[ playback.props=<properties> ] " },
{ PW_KEY_MODULE_USAGE, " ( remote.name=<remote> ) "
"( node.latency=<latency as fraction> ) "
"( node.description=<description of the nodes> ) "
"( audio.rate=<sample rate> ) "
"( audio.channels=<number of channels> ) "
"( audio.position=<channel map> ) "
"( target.delay.sec=<delay as seconds in float> ) "
"( capture.props=<properties> ) "
"( playback.props=<properties> ) " },
{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
};

24
src/modules/module-pipe-tunnel.c
View file

@ -114,18 +114,18 @@
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define PW_LOG_TOPIC_DEFAULT mod_topic
#define MODULE_USAGE "[ remote.name=<remote> ] " \
"[ node.latency=<latency as fraction> ] " \
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ target.object=<remote node target name or serial> ] "\
"[ audio.format=<sample format> ] " \
"[ audio.rate=<sample rate> ] " \
"[ audio.channels=<number of channels> ] " \
"[ audio.position=<channel map> ] " \
"[ tunnel.mode=capture|playback|sink|source " \
"[ pipe.filename=<filename> ]" \
"[ stream.props=<properties> ] "
#define MODULE_USAGE "( remote.name=<remote> ) " \
"( node.latency=<latency as fraction> ) " \
"( node.name=<name of the nodes> ) " \
"( node.description=<description of the nodes> ) " \
"( target.object=<remote node target name or serial> ) "\
"( audio.format=<sample format> ) " \
"( audio.rate=<sample rate> ) " \
"( audio.channels=<number of channels> ) " \
"( audio.position=<channel map> ) " \
"( tunnel.mode=capture|playback|sink|source )" \
"( pipe.filename=<filename> )" \
"( stream.props=<properties> ) "
static const struct spa_dict_item module_props[] = {

26
src/modules/module-protocol-simple.c
View file

@ -49,7 +49,7 @@
* - `capture.node`: an optional node serial or name to use for capture.
* - `playback.node`: an optional node serial or name to use for playback.
* - `server.address = []`: an array of server addresses to listen on as
* tcp:<ip>:<port>.
* tcp:(<ip>:)<port>.
*
* ## General options
*
@ -119,18 +119,18 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define MAX_CLIENTS 10
#define MODULE_USAGE "[ capture=<bool> ] " \
"[ playback=<bool> ] " \
"[ remote.name=<remote> ] " \
"[ node.latency=<num/denom, default:"DEFAULT_LATENCY"> ] " \
"[ node.rate=<1/rate, default:1/"SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ capture.node=<source-target> [ stream.capture.sink=true ]] " \
"[ playback.node=<sink-target> ] " \
"[ audio.rate=<sample-rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ audio.format=<format, default:"DEFAULT_FORMAT"> ] " \
"[ audio.channels=<channels, default: "SPA_STRINGIFY(DEFAULT_CHANNELS)"> ] " \
"[ audio.position=<position, default:"DEFAULT_POSITION"> ] " \
"[ server.address=<[ tcp:[<ip>:]<port>[,...] ], default:"DEFAULT_SERVER">" \
#define MODULE_USAGE "( capture=<bool> ) " \
"( playback=<bool> ) " \
"( remote.name=<remote> ) " \
"( node.latency=<num/denom, default:"DEFAULT_LATENCY"> ) " \
"( node.rate=<1/rate, default:1/"SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( capture.node=<source-target> ( stream.capture.sink=true )) " \
"( playback.node=<sink-target> ) " \
"( audio.rate=<sample-rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.channels=<channels, default: "SPA_STRINGIFY(DEFAULT_CHANNELS)"> ) " \
"( audio.position=<position, default:"DEFAULT_POSITION"> ) " \
"( server.address=<[ tcp:(<ip>:)<port>(,...) ], default:"DEFAULT_SERVER"> )" \
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

24
src/modules/module-pulse-tunnel.c
View file

@ -106,19 +106,19 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_CHANNELS 2
#define DEFAULT_POSITION "[ FL FR ]"
#define MODULE_USAGE "[ remote.name=<remote> ] " \
"[ node.latency=<latency as fraction> ] " \
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ node.target=<remote node target name or serial> ] " \
"[ audio.format=<sample format> ] " \
"[ audio.rate=<sample rate> ] " \
"[ audio.channels=<number of channels> ] " \
"[ audio.position=<channel map> ] " \
#define MODULE_USAGE "( remote.name=<remote> ] " \
"( node.latency=<latency as fraction> ] " \
"( node.name=<name of the nodes> ] " \
"( node.description=<description of the nodes> ] " \
"( node.target=<remote node target name or serial> ] " \
"( audio.format=<sample format> ] " \
"( audio.rate=<sample rate> ] " \
"( audio.channels=<number of channels> ] " \
"( audio.position=<channel map> ] " \
"pulse.server.address=<address> " \
"pulse.latency=<latency in msec> " \
"[ tunnel.mode=source|sink " \
"[ stream.props=<properties> ] "
"( pulse.latency=<latency in msec, default 200> ) " \
"( tunnel.mode=source|sink, default sink ) " \
"( stream.props=<properties> ) "
static const struct spa_dict_item module_props[] = {

2
src/modules/module-raop-discover.c
View file

@ -95,7 +95,7 @@
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define PW_LOG_TOPIC_DEFAULT mod_topic
#define MODULE_USAGE "stream.rules=<rules>, use create-stream actions "
#define MODULE_USAGE "( stream.rules=<rules>, use create-stream actions )"
#define DEFAULT_CREATE_RULES \
"[ { matches = [ { raop.ip = \"~.*\" } ] actions = { create-stream = { } } } ] "

32
src/modules/module-raop-sink.c
View file

@ -145,22 +145,22 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_LATENCY 22050
#define MODULE_USAGE "[ raop.ip=<ip address of host> ] " \
"[ raop.port=<remote port> ] " \
"[ raop.name=<name of host> ] " \
"[ raop.hostname=<hostname of host> ] " \
"[ raop.transport=<transport, default:udp> ] " \
"[ raop.encryption.type=<encryption, default:none> ] " \
"[ raop.audio.codec=PCM ] " \
"[ raop.password=<password for auth> ] " \
"[ node.latency=<latency as fraction> ] " \
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ audio.format=<format, default:"DEFAULT_FORMAT"> ] " \
"[ audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> ] " \
"[ audio.position=<channel map, default:"DEFAULT_POSITION"> ] " \
"[ stream.props=<properties> ] "
#define MODULE_USAGE "( raop.ip=<ip address of host> ) " \
"( raop.port=<remote port> ) " \
"( raop.name=<name of host> ) " \
"( raop.hostname=<hostname of host> ) " \
"( raop.transport=<transport, default:udp> ) " \
"( raop.encryption.type=<encryption, default:none> ) " \
"( raop.audio.codec=PCM ) " \
"( raop.password=<password for auth> ) " \
"( node.latency=<latency as fraction> ) " \
"( node.name=<name of the nodes> ) " \
"( node.description=<description of the nodes> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> ) " \
"( audio.position=<channel map, default:"DEFAULT_POSITION"> ) " \
"( stream.props=<properties> ) "
static const struct spa_dict_item module_props[] = {

12
src/modules/module-roc-sink.c
View file

@ -54,7 +54,6 @@
* context.modules = [
* { name = libpipewire-module-roc-sink
* args = {
* local.ip = 0.0.0.0
* fec.code = disable
* remote.ip = 192.168.0.244
* remote.source.port = 10001
@ -350,13 +349,12 @@ static int roc_sink_setup(struct module_roc_sink_data *data)
static const struct spa_dict_item module_roc_sink_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Sanchayan Maity <sanchayan@asymptotic.io>" },
{ PW_KEY_MODULE_DESCRIPTION, "roc sink" },
{ PW_KEY_MODULE_USAGE, "sink.name=<name for the sink> "
"local.ip=<local sender ip> "
"fec.code=<empty>|disable|rs8m|ldpc "
{ PW_KEY_MODULE_USAGE, "( sink.name=<name for the sink> ) "
"( fec.code=<empty>|disable|rs8m|ldpc ) "
"remote.ip=<remote receiver ip> "
"remote.source.port=<remote receiver port for source packets> "
"remote.repair.port=<remote receiver port for repair packets> "
"sink.props= { key=val ... } " },
"( remote.source.port=<remote receiver port for source packets> ) "
"( remote.repair.port=<remote receiver port for repair packets> ) "
"( sink.props= { key=val ... } ) " },
{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
};

16
src/modules/module-roc-source.c
View file

@ -371,14 +371,14 @@ static int roc_source_setup(struct module_roc_source_data *data)
static const struct spa_dict_item module_roc_source_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Sanchayan Maity <sanchayan@asymptotic.io>" },
{ PW_KEY_MODULE_DESCRIPTION, "roc source" },
{ PW_KEY_MODULE_USAGE, "source.name=<name for the source> "
"resampler.profile=<empty>|disable|high|medium|low "
"fec.code=<empty>|disable|rs8m|ldpc "
"sess.latency.msec=<target network latency in milliseconds> "
"local.ip=<local receiver ip> "
"local.source.port=<local receiver port for source packets> "
"local.repair.port=<local receiver port for repair packets> "
"source.props= { key=value ... }" },
{ PW_KEY_MODULE_USAGE, "( source.name=<name for the source> ) "
"( resampler.profile=<empty>|disable|high|medium|low ) "
"( fec.code=<empty>|disable|rs8m|ldpc ) "
"( sess.latency.msec=<target network latency in milliseconds> ) "
"( local.ip=<local receiver ip> ) "
"( local.source.port=<local receiver port for source packets> ) "
"( local.repair.port=<local receiver port for repair packets> ) "
"( source.props= { key=value ... } ) " },
{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
};

8
src/modules/module-rt.c
View file

@ -119,10 +119,10 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_RT_TIME_SOFT -1
#define DEFAULT_RT_TIME_HARD -1
#define MODULE_USAGE "[nice.level=<priority: default "SPA_STRINGIFY(DEFAULT_NICE_LEVEL)"(don't change)>] " \
"[rt.prio=<priority: default "SPA_STRINGIFY(DEFAULT_RT_PRIO)">] " \
"[rt.time.soft=<in usec: default "SPA_STRINGIFY(DEFAULT_RT_TIME_SOFT)"] " \
"[rt.time.hard=<in usec: default "SPA_STRINGIFY(DEFAULT_RT_TIME_HARD)"] "
#define MODULE_USAGE "( nice.level=<priority: default "SPA_STRINGIFY(DEFAULT_NICE_LEVEL)"(don't change)> ) " \
"( rt.prio=<priority: default "SPA_STRINGIFY(DEFAULT_RT_PRIO)"> ) " \
"( rt.time.soft=<in usec: default "SPA_STRINGIFY(DEFAULT_RT_TIME_SOFT)" ) " \
"( rt.time.hard=<in usec: default "SPA_STRINGIFY(DEFAULT_RT_TIME_HARD)" ) "
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

16
src/modules/module-rtp-sap.c
View file

@ -141,14 +141,14 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_TTL 1
#define DEFAULT_LOOP false
#define USAGE "local.ifname=<local interface name to use> " \
"sap.ip=<SAP IP address to send announce, default:"DEFAULT_SAP_IP"> " \
"sap.port=<SAP port to send on, default:"SPA_STRINGIFY(DEFAULT_SAP_PORT)"> " \
"sap.cleanup.sec=<cleanup interval in seconds, default 90> " \
"source.ip=<source IP address, default:"DEFAULT_SOURCE_IP"> " \
"net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> " \
"net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> " \
"stream.rules=<rules>, use announce-stream and create-stream actions "
#define USAGE "( local.ifname=<local interface name to use> ) " \
"( sap.ip=<SAP IP address to send announce, default:"DEFAULT_SAP_IP"> ) " \
"( sap.port=<SAP port to send on, default:"SPA_STRINGIFY(DEFAULT_SAP_PORT)"> ) " \
"( sap.cleanup.sec=<cleanup interval in seconds, default 90> ) " \
"( source.ip=<source IP address, default:"DEFAULT_SOURCE_IP"> ) " \
"( net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> ) " \
"( net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> ) " \
"( stream.rules=<rules>, use announce-stream and create-stream actions )"
static const struct spa_dict_item module_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

30
src/modules/module-rtp-session.c
View file

@ -128,21 +128,21 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_TTL 1
#define DEFAULT_LOOP false
#define USAGE "control.ip=<destination IP address, default:"DEFAULT_CONTROL_IP"> " \
"control.port=<int, default:"SPA_STRINGIFY(DEFAULT_CONTROL_PORT)"> " \
"local.ifname=<local interface name to use> " \
"net.mtu=<desired MTU, default:"SPA_STRINGIFY(DEFAULT_MTU)"> " \
"net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> " \
"net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> " \
"sess.name=<a name for the session> " \
"sess.min-ptime=<minimum packet time in milliseconds, default:2> " \
"sess.max-ptime=<maximum packet time in milliseconds, default:20> " \
"sess.media=<string, the media type audio|midi|opus, default audio> " \
"audio.format=<format, default:"DEFAULT_FORMAT"> " \
"audio.rate=<sample rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> " \
"audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> "\
"audio.position=<channel map, default:"DEFAULT_POSITION"> " \
"stream.props= { key=value ... }"
#define USAGE "( control.ip=<destination IP address, default:"DEFAULT_CONTROL_IP"> ) " \
"( control.port=<int, default:"SPA_STRINGIFY(DEFAULT_CONTROL_PORT)"> ) " \
"( local.ifname=<local interface name to use> ) " \
"( net.mtu=<desired MTU, default:"SPA_STRINGIFY(DEFAULT_MTU)"> ) " \
"( net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> ) " \
"( net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> ) " \
"( sess.name=<a name for the session> ) " \
"( sess.min-ptime=<minimum packet time in milliseconds, default:2> ) " \
"( sess.max-ptime=<maximum packet time in milliseconds, default:20> ) " \
"( sess.media=<string, the media type audio|midi|opus, default audio> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.rate=<sample rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> ) "\
"( audio.position=<channel map, default:"DEFAULT_POSITION"> ) " \
"( stream.props= { key=value ... } ) "
static const struct spa_dict_item module_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

34
src/modules/module-rtp-sink.c
View file

@ -118,23 +118,23 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_TS_OFFSET -1
#define USAGE "source.ip=<source IP address, default:"DEFAULT_SOURCE_IP"> " \
"destination.ip=<destination IP address, default:"DEFAULT_DESTINATION_IP"> " \
"destination.port=<int, default random beteen 46000 and 47024> " \
"local.ifname=<local interface name to use> " \
"net.mtu=<desired MTU, default:"SPA_STRINGIFY(DEFAULT_MTU)"> " \
"net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> " \
"net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> " \
"net.dscp=<desired DSCP, default:"SPA_STRINGIFY(DEFAULT_DSCP)"> " \
"sess.name=<a name for the session> " \
"sess.min-ptime=<minimum packet time in milliseconds, default:2> " \
"sess.max-ptime=<maximum packet time in milliseconds, default:20> " \
"sess.media=<string, the media type audio|midi, default audio> " \
"audio.format=<format, default:"DEFAULT_FORMAT"> " \
"audio.rate=<sample rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> " \
"audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> "\
"audio.position=<channel map, default:"DEFAULT_POSITION"> " \
"stream.props= { key=value ... }"
#define USAGE "( source.ip=<source IP address, default:"DEFAULT_SOURCE_IP"> ) " \
"( destination.ip=<destination IP address, default:"DEFAULT_DESTINATION_IP"> ) " \
"( destination.port=<int, default random beteen 46000 and 47024> ) " \
"( local.ifname=<local interface name to use> ) " \
"( net.mtu=<desired MTU, default:"SPA_STRINGIFY(DEFAULT_MTU)"> ) " \
"( net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> ) " \
"( net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> ) " \
"( net.dscp=<desired DSCP, default:"SPA_STRINGIFY(DEFAULT_DSCP)"> ) " \
"( sess.name=<a name for the session> ) " \
"( sess.min-ptime=<minimum packet time in milliseconds, default:2> ) " \
"( sess.max-ptime=<maximum packet time in milliseconds, default:20> ) " \
"( sess.media=<string, the media type audio|midi, default audio> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.rate=<sample rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> ) " \
"( audio.position=<channel map, default:"DEFAULT_POSITION"> ) " \
"( stream.props= { key=value ... } ) "
static const struct spa_dict_item module_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

20
src/modules/module-rtp-source.c
View file

@ -101,16 +101,16 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_TS_OFFSET -1
#define USAGE "local.ifname=<local interface name to use> " \
"source.ip=<source IP address, default:"DEFAULT_SOURCE_IP"> " \
"source.port=<int, source port> " \
"sess.latency.msec=<target network latency, default "SPA_STRINGIFY(DEFAULT_SESS_LATENCY)"> " \
"sess.media=<string, the media type audio|midi, default audio> " \
"audio.format=<format, default:"DEFAULT_FORMAT"> " \
"audio.rate=<sample rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> " \
"audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> "\
"audio.position=<channel map, default:"DEFAULT_POSITION"> " \
"stream.props= { key=value ... } "
#define USAGE "( local.ifname=<local interface name to use> ) " \
"( source.ip=<source IP address, default:"DEFAULT_SOURCE_IP"> ) " \
"source.port=<int, source port> " \
"( sess.latency.msec=<target network latency, default "SPA_STRINGIFY(DEFAULT_SESS_LATENCY)"> ) " \
"( sess.media=<string, the media type audio|midi, default audio> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.rate=<sample rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> ) " \
"( audio.position=<channel map, default:"DEFAULT_POSITION"> ) " \
"( stream.props= { key=value ... } ) "
static const struct spa_dict_item module_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },

8
src/modules/module-x11-bell.c
View file

@ -230,10 +230,10 @@ static const struct pw_impl_module_events module_events = {
static const struct spa_dict_item module_x11_bell_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
{ PW_KEY_MODULE_DESCRIPTION, "X11 Bell interceptor" },
{ PW_KEY_MODULE_USAGE, "sink.name=<name for the sink> "
"sample.name=<the sample name> "
"x11.display=<the X11 display> "
"x11.xauthority=<the X11 XAuthority> " },
{ PW_KEY_MODULE_USAGE, "( sink.name=<name for the sink> ) "
"( sample.name=<the sample name> ) "
"( x11.display=<the X11 display> ) "
".x11.xauthority=<the X11 XAuthority> )" },
{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
};
SPA_EXPORT

2
src/modules/module-zeroconf-discover.c
View file

@ -55,7 +55,7 @@
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define PW_LOG_TOPIC_DEFAULT mod_topic
#define MODULE_USAGE "pulse.latency=<latency in msec> "
#define MODULE_USAGE "( pulse.latency=<latency in msec, default 200> ) "
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },