[xmp] Adjust options and manpage

Adjust options to preserve compatibility with xmp 3.5.0 when possible
(e.g. -n for nearest neighbor), document them in manpage.

Signed-off-by: Claudio Matsuoka <cmatsuoka@gmail.com>

src/options.c

@@ -36,11 +36,9 @@ extern struct list_head sound_driver_list;
 #define OPT_REALTIME	0x10c
 #define OPT_FIXLOOP	0x10d
 #define OPT_CRUNCH	0x10e
-#define OPT_NOFILTER	0x10f
-#define OPT_VBLANK	0x110
-#define OPT_SHOWTIME	0x111
-#define OPT_DUMP	0x112
-#define OPT_NEAREST	0x113
+#define OPT_VBLANK	0x10f
+#define OPT_SHOWTIME	0x110
+#define OPT_DUMP	0x111
 
 static void usage(char *s)
 {
@@ -81,8 +79,9 @@ static void usage(char *s)
 "   -c --stdout            Mix the module to stdout\n"
 "   -f --frequency rate    Sampling rate in hertz (default 44100)\n"
 "   -m --mono              Mono output\n"
-"   --nearest              Use nearest neighbor interpolation (no filter)\n"
-"   --nofilter             Disable IT lowpass filters\n"
+"   -N --null              Use null output driver (same as --driver=null)\n"
+"   -n --nearest           Use nearest neighbor interpolation (no filter)\n"
+"   -F --nofilter          Disable IT lowpass filters\n"
 "   -o --output-file name  Mix the module to file ('-' for stdout)\n"
 "   -P --pan pan           Percentual pan separation\n"
 "   -u --unsigned          Set the mixer to use unsigned samples\n"
@@ -110,9 +109,10 @@ static struct option lopt[] = {
 	{ "loop",		0, 0, 'l' },
 	{ "mono",		0, 0, 'm' },
 	{ "mute",		1, 0, 'M' },
-	{ "nearest",		0, 0, OPT_NEAREST },
+	{ "null",		0, 0, 'N' },
+	{ "nearest",		0, 0, 'n' },
 	{ "nocmd",		0, 0, OPT_NOCMD },
-	{ "nofilter",		0, 0, OPT_NOFILTER },
+	{ "nofilter",		0, 0, 'F' },
 	{ "output-file",	1, 0, 'o' },
 	{ "pan",		1, 0, 'P' },
 	{ "probe-only",		0, 0, OPT_PROBEONLY },
@@ -135,7 +135,7 @@ void get_options(int argc, char **argv, struct options *options)
 	int dparm = 0;
 	int o;
 
-#define OPTIONS "a:b:cD:d:f:hI:iLlM:mno:P:qRS:s:T:t:uVv"
+#define OPTIONS "a:b:cD:d:Ff:hI:iLlM:mNno:P:qRS:s:T:t:uVv"
 	while ((o = getopt_long(argc, argv, OPTIONS, lopt, &optidx)) != -1) {
 		switch (o) {
 		case 'a':
@@ -156,11 +156,9 @@ void get_options(int argc, char **argv, struct options *options)
 		case 'd':
 			options->driver_id = optarg;
 			break;
-#if 0
-		case OPT_FX9BUG:
-			options->quirk |= XMP_QRK_FX9BUG;
+		case 'F':
+			options->format |= XMP_FORMAT_NOFILTER;
 			break;
-#endif
 		case 'f':
 			options->rate = strtoul(optarg, NULL, 0);
 			break;
@@ -186,18 +184,15 @@ void get_options(int argc, char **argv, struct options *options)
 		case 'm':
 			options->format |= XMP_FORMAT_MONO;
 			break;
-		case 'n':
+		case 'N':
 			options->silent = 1;
 			break;
-		case OPT_NEAREST:
+		case 'n':
 			options->format |= XMP_FORMAT_NEAREST;
 			break;
 		case OPT_NOCMD:
 			options->nocmd = 1;
 			break;
-		case OPT_NOFILTER:
-			options->format |= XMP_FORMAT_NOFILTER;
-			break;
 		case 'o':
 			options->out_file = optarg;
 			if (strlen(optarg) >= 4 &&

src/xmp.1

@@ -1,4 +1,4 @@
-.TH "XMP" "1" "Version 3\&.9\&.0" "Apr 2012" "Extended Module Player" 
+.TH "XMP" "1" "Version 3\&.9\&.1" "Ago 2012" "Extended Module Player" 
 .PP 
 .SH "NAME" 
 xmp - Extended Module Player
@@ -18,6 +18,8 @@ xmp - Extended Module Player
 [\fB-l, --loop\fP]
 [\fB-M, --mute\fP \fIchannel-list\fP]
 [\fB-m, --mono\fP]
+[\fB-N, --null\fP]
+[\fB-n, --nearest\fP]
 [\fB--nocmd\fP]
 [\fB-o, --output-file\fP \fIfilename\fP]
 [\fB-P, --pan\fP \fIpan\fP]
@@ -58,9 +60,6 @@ list of known parameters\&.
 .IP "\fB-d, --driver\fP \fIdriver\fP" 
 Select the output driver\&. If not specified, \fBxmp\fP will try to
 probe each available driver\&.
-.IP "\fB--fix-sample-loop\fP" 
-Force sample loop start in samples instead of 16-bit words\&. This
-option affects only MOD files\&.
 .IP "\fB-f, --frequency\fP \fIrate\fP" 
 Set the software mixer sampling rate in hertz\&.
 .IP "\fB-h, --help\fP" 
@@ -76,6 +75,11 @@ Mute the specified channels\&. \fIchannel-list\fP is a comma-separated
 list of decimal channel ranges\&. Example: 0,2-4,8-16\&.
 .IP "\fB-m, --mono\fP" 
 Force mono output (default is stereo in stereo-capable devices)\&.
+.IP "\fB-N, --null\fP" 
+Load and mix module, but discard output data (same as --device=null)\&.
+.IP "\fB-n, --nearest\fP" 
+Use nearest-neighbor interpolation\&. This option also disables lowpass
+filtering\&.
 .IP "\fB--nocmd\fP" 
 Disable interactive commands\&.
 .IP "\fB-o, --output-file\fP \fIfilename\fP" 
@@ -108,7 +112,21 @@ when the player runs in background)\&.
 Use the option \fB-D\fP to send parameters directly to the device
 drivers\&. Multiple \fB-D\fP options can be specified in the command line\&.
 .PP 
-OSS software mixing:
+File output options:
+.IP "\fB-D\fP \fIendian=big\fP" 
+Generate big-endian 16-bit samples (default is the machine byte ordering)\&.
+.IP "\fB-D\fP \fIendian=little\fP" 
+Generate little-endian 16-bit samples (default is the machine byte ordering)\&.
+.PP 
+ALSA driver options:
+.IP "\fB-D\fP \fIbuffer=value\fP" 
+Set buffer size in ms\&. Default value is 250.
+.IP "\fB-D\fP \fIperiod=value\fP" 
+Set period time in ms\&. Default value is 50.
+.IP "\fB-D\fP \fIcard=name\fP" 
+Choose the ALSA device to use\&. Default value is "default"\&.
+.PP 
+OSS driver options:
 .IP "\fB-D\fP \fIfrag=num,size\fP" 
 Set the maximum number of fragments to \fInum\fP and the size of
 each fragment to \fIsize\fP bytes (must be a power of two)\&.
@@ -121,7 +139,14 @@ Set the audio device to open\&. Default is /dev/dsp\&.
 .IP "\fB-D\fP \fInosync\fP" 
 Don\'t sync the OSS audio device between modules\&.
 .PP 
-HP-UX and Solaris audio:
+BSD driver options:
+.IP "\fB-D\fP \fIgain=value\fP" 
+Set the audio gain\&. Valid \fIvalue\fP goes from 0 to 255\&.
+The default is 128\&.
+.IP "\fB-D\fP \fIbuffer=size\fP" 
+Set the size in bytes of the audio buffer\&. Default value is 32 Kb\&.
+.PP
+HP-UX and Solaris driver options:
 .IP "\fB-D\fP \fIgain=value\fP" 
 Set the audio gain\&. Valid \fIvalue\fP goes from 0 to 255\&.
 The default is 128\&.
@@ -131,12 +156,6 @@ speaker, \fIh\fP for headphones and \fIl\fP for line out\&. The default
 is the internal speaker\&.
 .IP "\fB-D\fP \fIbuffer=size\fP" 
 Set the size in bytes of the audio buffer\&. The default value is 32 Kb\&.
-.PP 
-File output:
-.IP "\fB-D\fP \fIendian=big\fP" 
-Generate big-endian 16-bit samples (default is the machine byte ordering)\&.
-.IP "\fB-D\fP \fIendian=little\fP" 
-Generate little-endian 16-bit samples (default is the machine byte ordering)\&.
 .PP
 .SH "INTERACTIVE COMMANDS" 
 The following single key commands can be used when playing modules:
@@ -158,6 +177,8 @@ Mute/unmute channels 1 to 10\&.
 Unmute all channels\&.
 .IP "\fB?\fP" 
 Display available commands\&.
+.IP "\fBl\fP" 
+Toggle module looping\&.
 .IP "\fBm\fP" 
 Display module information\&.
 .IP "\fBi\fP" 
@@ -170,11 +191,11 @@ Display sample list\&.
 Interactive mode can be disabled using the \fB--nocmd\fP command
 line option\&.
 .PP 
-.SH "NOTES" 
-When using the OSS sequencer with an AWE card, xmp will wipe out any
-soundfonts already loaded in the card\&.
-.PP
 .SH "EXAMPLES" 
+Play module and save output in a .wav file\&:
+.IP "" 
+\f(CWxmp -ofilename.wav module\&.mod\fP
+.PP 
 Play module muting channels 0 to 3 and 6\&:
 .IP "" 
 \f(CWxmp --mute=0-3,6 module\&.mod\&.gz\fP
@@ -189,9 +210,6 @@ random order\&:
 .IP "" 
 \f(CWxmp -R `find /mod -name "*\&.xm*" -print`\fP
 .PP 
-.SH "FILES" 
-\f(CW/etc/xmp/xmp\&.conf\&, $HOME/\&.xmp/xmp\&.conf\&, /etc/xmp/modules\&.conf\&, $HOME/\&.xmp/modules\&.conf\fP
-.PP 
 .SH "AUTHOR" 
 Claudio Matsuoka and Hipolito Carraro Jr\&.
 .PP