1XMP(1) Extended Module Player XMP(1)
2
6 xmp - Extended Module Player
7
9 xmp [-a, --amplify factor] [-A, --amiga] [-b, --bits bits] [-C,
10 --show-comments] [-c, --stdout] [-D device-specific parameters] [-d,
11 --driver driver] [-e, --player-mode mode] [-F, --nofilter] [-f, --fre‐
12 quency rate] [--fix-sample-loop] [-h, --help] [-I, --instrument-path]
13 [-i, --interpolation type] [--load-only] [-L, --list-formats] [-l,
14 --loop] [--loop-all] [-M, --mute channel-list] [-m, --mono]
15 [--mixer_voices num] [-N, --null] [--nocmd] [-o, --output-file file‐
16 name] [-P, --pan num] [-p, --default-pan num] [--probe-only] [-q,
17 --quiet] [-R, --random] [-S, --solo channel-list] [-s, --start pos]
18 [-t, --time time] [-u, --unsigned] [--vblank] [-V, --version] [-v,
19 --verbose] [-Z, --all-sequences] [-z, --sequence num] modules
20
22 xmp is a tracked music module player. It plays many module formats in‐
23 cluding Fasttracker II (XM), Noise/Fast/Protracker (MOD), Scream
24 Tracker 3 (S3M) and Impulse Tracker (IT). Run xmp --list-formats for a
25 complete list of supported formats.
26
28 -a, --amplify factor
29 Amplification factor for the software mixer. Valid amplification
30 factors range from 0 to 3. Default is 1. . Warning: higher am‐
31 plification factors may cause distorted or noisy output.
32 -A, --amiga
34 Use a mixer which models the sound of an Amiga 500, with or
35 without the led filter.
36 -b, --bits bits
38 Set the software mixer resolution (8 or 16 bits). If omitted,
39 The audio device will be opened at the highest resolution avail‐
40 able.
41 -C, --show-comments
43 Display module comment text, if any.
44 -c, --stdout
46 Mix the module to stdout.
47 -D device-specific parameter
49 Pass a configuration parameter to the device driver. See the DE‐
50 VICE DRIVER PARAMETERS section below for a list of known parame‐
51 ters.
52 -d, --driver driver
54 Select the output driver. If not specified, xmp will try to
55 probe each available driver.
56 -e, --player-mode mode
58 Force play mode or emulation of a specific tracker. Valid player
59 modes are: auto (autodetection), mod (generic mod player mode),
60 noisetracker, protracker (Protracker 1/2), s3m (generic S3M
61 player mode), st3 (Scream Tracker 3), st3gus (Scream Tracker 3
62 with GUS card), xm (generic XM player mode), ft2 (Fasttracker
63 II), it (Impulse Tracker), or itsmp (Impulse Tracker in sample
64 mode). When a specific tracker is specified, xmp will try to em‐
65 ulate quirks and bugs for accurate replay. Default is autodetec‐
66 tion.
67 -F, --nofilter
69 Disable IT lowpass filter effect and envelopes.
70 -f, --frequency rate
72 Set the software mixer sampling rate in hertz.
73 --fix-sample-loop
75 Halve sample loop start values. Use it to work around bad con‐
76 versions from 15-instrument modules and to correctly play
77 NoisePacker v2 and certain UNIC files.
78 -h, --help
80 Show a short summary of command-line options.
81 -I, --instrument-path path
83 Set the pathname to the directory containing external samples.
84 -i, --interpolation type
86 Select interpolation type. Available types are nearest for near‐
87 est-neighbor interpolation, linear for linear interpolation, and
88 spline for cubic spline interpolation. Default is cubic spline.
89 --load-only
91 Load module and exit.
92 -L, --list-formats
94 List supported module formats.
95 -l, --loop
97 Enable module looping.
98 --loop-all
100 Loop over the entire module list.
101 -M, --mute channel-list
103 Mute the specified channels. channel-list is a comma-separated
104 list of decimal channel ranges. Example: 0,2-4,8-16.
105 -m, --mono
107 Force mono output (default is stereo in stereo-capable devices).
108 --mixer-voices num
110 Set the maximum number of virtual channels (default is 128).
111 -N, --null
113 Load and mix module, but discard output data (same as --de‐
114 vice=null).
115 --nocmd
117 Disable interactive commands.
118 -o, --output-file filename
120 Set the output file name when mixing to raw or WAV files. If '-'
121 is given as the file name, the output will be sent to stdout.
122 -P, --pan num
124 Set the percentual panning amplitude.
125 -P, --default-pan num
127 Set the percentual default pan setting for modules that don't
128 set their own pan values. Useful to reduce LRRL pan separation
129 on headphones. This parameter does not affect the Amiga 500
130 classic mixer.
131 --probe-only
133 Exit after probing the audio device.
134 -R, --random
136 Play modules in random order.
137 -r, --reverse
139 Reverse left/right stereo channels.
140 -S, --solo channel-list
142 Play only the specified channels. channel-list is a comma-sepa‐
143 rated list of decimal channel ranges. Example: 0,2-4,8-16.
144 -s, --start pos
146 Start playing the module from the position pos.
147 -t, --time time
149 Specifies the maximum playing time to time seconds.
150 -u, --unsigned
152 Tell the software mixer to use unsigned samples when mixing to a
153 file (default is signed).
154 --vblank
156 Force Amiga vblank-based timing (no CIA tempo setting).
157 -V, --version
159 Print version information.
160 -v, --verbose
162 Verbose mode (incremental). If specified more than once, the
163 verbosity level will be increased (no messages will be displayed
164 when the player runs in background).
165 -Z, --all-sequences
167 Play all hidden or alternative pattern sequences (subsongs) in
168 module.
169 -z, --sequence num
171 Play hidden or alternative pattern sequence num (0 is the main
172 sequence).
173
175 Use the option -D to send parameters directly to the device drivers.
176 Multiple -D options can be specified in the command line.
177 File output options:
179 -D endian=big
181 Generate big-endian 16-bit samples (default is the machine byte
182 ordering).
183 -D endian=little
185 Generate little-endian 16-bit samples (default is the machine
186 byte ordering).
187 ALSA driver options:
189 -D buffer=value
191 Set buffer size in ms. Default value is 250.
192 -D period=value
194 Set period time in ms. Default value is 50.
195 -D card=name
197 Choose the ALSA device to use. Default value is "default".
198 OSS driver options:
200 -D frag=num,size
202 Set the maximum number of fragments to num and the size of each
203 fragment to size bytes (must be a power of two). The number and
204 size of fragments set a tradeoff between the buffering latency
205 and sensibility to system load. To get better synchronization,
206 reduce the values. To avoid gaps in the sound playback, increase
207 the values.
208 -D dev=device_name
210 Set the audio device to open. Default is /dev/dsp.
211 -D nosync
213 Don't sync the OSS audio device between modules.
214 BSD driver options:
216 -D gain=value
218 Set the audio gain. Valid values range from 0 to 255. The de‐
219 fault is 128.
220 -D buffer=size
222 Set the size in bytes of the audio buffer. Default value is 32
223 Kb.
224 CoreAudio driver options:
226 -D buffer=value
228 Set buffer size in ms. Default value is 250.
229 HP-UX and Solaris driver options:
231 -D gain=value
233 Set the audio gain. Valid values range from 0 to 255. The de‐
234 fault is 128.
235 -D port={s|h|l}
237 Set the audio port. Valid arguments are s for the internal
238 speaker, h for headphones and l for line out. The default is the
239 internal speaker.
240 -D buffer=size
242 Set the size in bytes of the audio buffer. The default value is
243 32 Kb.
244
246 The following single key commands can be used when playing modules:
247 q, Esc Stop the currently playing module and quit the player.
249 f, Right
251 Jump to the next pattern.
252 b, Left
254 Jump to the previous pattern.
255 n, Up Jump to the next module.
257 p, Down
259 Jump to the previous module.
260 Space Pause or unpause module replay.
262 1, 2, 3, 4, 5, 6, 7, 8, 9, 0
264 Mute/unmute channels 1 to 10.
265 ! Unmute all channels.
267 h, ? Display available commands.
269 X Display current mixer type.
271 Z Display current sequence.
273 z Toggle subsong explorer mode.
275 l Toggle module/sequence looping.
277 m Display module information.
279 i Display combined instrument/sample list.
281 I Display instrument list.
283 S Display sample list.
285 c Display comment, if any.
287 < Change to previous sequence (subsong).
289 > Change to next sequence (subsong).
291 Interactive mode can be disabled using the --nocmd command line option.
293
295 Play module and save output in a .wav file:
296 xmp -ofilename.wav module.mod
298 Play module muting channels 0 to 3 and 6:
300 xmp --mute=0-3,6 module.mod.gz
302 Play modules in /dev/dsp using the default device settings (unsigned
304 8bit, 8 kHz mono):
305 xmp -o/dev/dsp -f8000 -m -b8 -u module.lha
307 Play all XM modules in the /mod directory and all subdirectories in
309 random order, ignoring any configuration set in the xmp.conf file:
310 xmp --norc -R `find /mod -name "*.xm" -print`
312
314 /etc/xmp/xmp.conf, $HOME/.xmp/xmp.conf, /etc/xmp/modules.conf,
315 $HOME/.xmp/modules.conf
316
318 Claudio Matsuoka and Hipolito Carraro Jr.
319Jul 2016 Version 4.1.0 XMP(1)