Duplicate Option Hints

[JasonLG1979]

While updating the Options section of the wiki I noticed several instances of duplicate option hints.

PATH is used twice, for both cache and system-cache.
NAME is used 3 times, for name (device name), backend and mixer-name
TIME is used twice, for both normalisation-attack and normalisation-release

I'd also like to discuss changing some of the arg and hint names so they make more sense. For example the hint for volume-range is just RANGE and for normalisation-gain-type it's just TYPE and so on. There are several that could be better.

[roderickvd]

Feel free to submit a PR and see where you can improve. I know you’re not a Rust programmer yet but this would be a great place to start.

As for the hints, I made it that way. They are not unique variables, they are hints on what the values should look like. So it’s just as much a path to the cache as it is a path to the system cache. And a name for the device, just as much as a name for the mixer. And so on.

Along these same lines, I do agree with the range and type. I thought I had already done this but I maybe I made a mistake resolving conflicts.

[JasonLG1979]

@roderickvd You can close this or whatever you do to discussions as my whole premise is flawed.

[JasonLG1979]

I hesitated renaming option names, to not stir up too much trouble with downstream distributions like moOde. But since we might as well be calling 0.3.0 "Breaking Bad" we can think about doing it.

If the hints truly mean nothing then what the hell are they even good for? I mean you could use them to reference the argument's expected type. String, Bool and so on but there's already descriptions so they seem rather redundant.

[JasonLG1979]

As far as arg changes I propose these to make the args more clear and self-explanatory:

Current	Proposed
name	device-name
device	audio-device-name
format	pcm-format
dither	dither-type
mixer	volume-type
mixer-name	volume-mixer-name
mixer-card	volume-mixer-card
mixer-index	volume-mixer-index
volume-ctrl	volume-ctrl-scale

The mixer card and index args could really be combined I'm pretty sure. Much like device is can be used to specify the output device, hw:0,0 for example.

[JasonLG1979]

As far as the hints I propose a noun type pair when possible. So device-name would be NAME_STRING, ap-port would be PORT_INT and so on.

[JasonLG1979]

Something like this as far as giving the hints some meaning and use:

Option	Hint
cache	PATH_STRING
system-cache	PATH_STRING
cache-size-limit	SIZE_STRING
name	NAME_STRING
device-type	TYPE_STRING
bitrate	BITRATE_INTEGER
onevent	PROGRAM_STRING
username	USERNAME_STRING
password	PASSWORD_STRING
proxy	URL_STRING
ap-port	PORT_INTEGER
backend	NAME_STRING
device	NAME_STRING
format	FORMAT_STRING
dither	TYPE_STRING
mixer	TYPE_STRING
mixer-name	NAME_STRING
mixer-card	CARD_STRING
mixer-index	INDEX_INTEGER
initial-volume	PERCENT_INTEGER
zeroconf-port	PORT_INTEGER
normalisation-method	METHOD_STRING
normalisation-gain-type	TYPE_STRING
normalisation-pregain	DB_FLOAT
normalisation-threshold	DBFS_FLOAT
normalisation-attack	TIME_INTEGER
normalisation-release	TIME_INTEGER
normalisation-knee	STEEPNESS_FLOAT
volume-ctrl	TYPE_STRING
volume-range	DB_FLOAT

[roderickvd]

This was continued in #784.