1XMP(1) Extended Module Player XMP(1)
2
6 xmp - Extended Module Player
7
9 xmp [-a, --amplify factor] [-b, --bits bits] [-C, --show-comments] [-c,
10 --stdout] [-D device-specific parameters] [-d, --driver driver] [-e,
11 --player-mode mode] [-F, --nofilter] [-f, --frequency rate] [--fix-sam‐
12 ple-loop] [-h, --help] [-I, --instrument-path] [-i, --interpolation
13 type] [--load-only] [-L, --list-formats] [-l, --loop] [--loop-all] [-M,
14 --mute channel-list] [-m, --mono] [--mixer_voices num] [-N, --null]
15 [--nocmd] [-o, --output-file filename] [-P, --pan num] [-p,
16 --default-pan num] [--probe-only] [-q, --quiet] [-R, --random] [-S,
17 --solo channel-list] [-s, --start pos] [-t, --time time] [-u,
18 --unsigned] [--vblank] [-V, --version] [-v, --verbose] [-x, --classic]
19 [-Z, --all-sequences] [-z, --sequence num] modules
20
22 xmp is a tracked music module player. It plays many module formats
23 including 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
31 amplification factors may cause distorted or noisy output.
32 -b, --bits bits
34 Set the software mixer resolution (8 or 16 bits). If ommited,
35 The audio device will be opened at the highest resolution avail‐
36 able.
37 -C, --show-comments
39 Display module comment text, if any.
40 -c, --stdout
42 Mix the module to stdout.
43 -D device-specific parameter
45 Pass a configuration parameter to the device driver. See the
46 DEVICE DRIVER PARAMETERS section below for a list of known
47 parameters.
48 -d, --driver driver
50 Select the output driver. If not specified, xmp will try to
51 probe each available driver.
52 -e, --player-mode mode
54 Force play mode or emulation of a specific tracker. Valid player
55 modes are: auto (autodetection), mod (generic mod player mode),
56 noisetracker, protracker (Protracker 1/2), s3m (generic S3M
57 player mode), st3 (Scream Tracker 3), st3gus (Scream Tracker 3
58 with GUS card), xm (generic XM player mode), ft2 (Fasttracker
59 II), it (Impulse Tracker), or itsmp (Impulse Tracker in sample
60 mode). When a specific tracker is specified, xmp will try to
61 emulate quirks and bugs for accurate replay. Default is autode‐
62 tection.
63 -F, --nofilter
65 Disable IT lowpass filter effect and envelopes.
66 -f, --frequency rate
68 Set the software mixer sampling rate in hertz.
69 --fix-sample-loop
71 Halve sample loop start values. Use it to work around bad con‐
72 versions from 15-instrument modules and to correctly play
73 NoisePacker v2 and certain UNIC files.
74 -h, --help
76 Show a short summary of command-line options.
77 -I, --instrument-path path
79 Set the pathname to the directory containing external samples.
80 -i, --interpolation type
82 Select interpolation type. Available types are nearest for near‐
83 est-neighbor interpolation, linear for linear interpolation, and
84 spline for cubic spline interpolation. Default is cubic spline.
85 --load-only
87 Load module and exit.
88 -L, --list-formats
90 List supported module formats.
91 -l, --loop
93 Enable module looping.
94 --loop-all
96 Loop over the entire module list.
97 -M, --mute channel-list
99 Mute the specified channels. channel-list is a comma-separated
100 list of decimal channel ranges. Example: 0,2-4,8-16.
101 -m, --mono
103 Force mono output (default is stereo in stereo-capable devices).
104 --mixer-voices num
106 Set the maximum number of virtual channels (default is 128).
107 -N, --null
109 Load and mix module, but discard output data (same as
110 --device=null).
111 --nocmd
113 Disable interactive commands.
114 -o, --output-file filename
116 Set the output file name when mixing to raw or WAV files. If ´-´
117 is given as the file name, the output will be sent to stdout.
118 -P, --pan num
120 Set the percentual panning amplitude.
121 -P, --default-pan num
123 Set the percentual default pan setting for modules that don´t
124 set their own pan values. Useful to reduce LRRL pan separation
125 on headphones. This parameter does not affect the Amiga 500
126 classic mixer.
127 --probe-only
129 Exit after probing the audio device.
130 -R, --random
132 Play modules in random order.
133 -r, --reverse
135 Reverse left/right stereo channels.
136 -S, --solo channel-list
138 Play only the specified channels. channel-list is a comma-sepa‐
139 rated list of decimal channel ranges. Example: 0,2-4,8-16.
140 -s, --start pos
142 Start playing the module from the position pos.
143 -t, --time time
145 Specifies the maximum playing time to time seconds.
146 -u, --unsigned
148 Tell the software mixer to use unsigned samples when mixing to a
149 file (default is signed).
150 --vblank
152 Force Amiga vblank-based timing (no CIA tempo setting).
153 -V, --version
155 Print version information.
156 -v, --verbose
158 Verbose mode (incremental). If specified more than once, the
159 verbosity level will be increased (no messages will be displayed
160 when the player runs in background).
161 -x, --classic
163 Use classic sound mixers, if available for the format being
164 played. For Amiga formats such as Protracker, the classic mode
165 mixer models the sound of an Amiga 500, with or without the led
166 filter.
167 -Z, --all-sequences
169 Play all hidden or alternative pattern sequences (subsongs) in
170 module.
171 -z, --sequence num
173 Play hidden or alternative pattern sequence num (0 is the main
174 sequence).
175
177 Use the option -D to send parameters directly to the device drivers.
178 Multiple -D options can be specified in the command line.
179 File output options:
181 -D endian=big
183 Generate big-endian 16-bit samples (default is the machine byte
184 ordering).
185 -D endian=little
187 Generate little-endian 16-bit samples (default is the machine
188 byte ordering).
189 ALSA driver options:
191 -D buffer=value
193 Set buffer size in ms. Default value is 250.
194 -D period=value
196 Set period time in ms. Default value is 50.
197 -D card=name
199 Choose the ALSA device to use. Default value is "default".
200 OSS driver options:
202 -D frag=num,size
204 Set the maximum number of fragments to num and the size of each
205 fragment to size bytes (must be a power of two). The number and
206 size of fragments set a tradeoff between the buffering latency
207 and sensibility to system load. To get better synchronization,
208 reduce the values. To avoid gaps in the sound playback, increase
209 the values.
210 -D dev=device_name
212 Set the audio device to open. Default is /dev/dsp.
213 -D nosync
215 Don´t sync the OSS audio device between modules.
216 BSD driver options:
218 -D gain=value
220 Set the audio gain. Valid values range from 0 to 255. The
221 default is 128.
222 -D buffer=size
224 Set the size in bytes of the audio buffer. Default value is 32
225 Kb.
226 CoreAudio driver options:
228 -D buffer=value
230 Set buffer size in ms. Default value is 250.
231 HP-UX and Solaris driver options:
233 -D gain=value
235 Set the audio gain. Valid values range from 0 to 255. The
236 default is 128.
237 -D port={s|h|l}
239 Set the audio port. Valid arguments are s for the internal
240 speaker, h for headphones and l for line out. The default is the
241 internal speaker.
242 -D buffer=size
244 Set the size in bytes of the audio buffer. The default value is
245 32 Kb.
246
248 The following single key commands can be used when playing modules:
249 q, Esc Stop the currently playing module and quit the player.
251 f, Right
253 Jump to the next pattern.
254 b, Left
256 Jump to the previous pattern.
257 n, Up Jump to the next module.
259 p, Down
261 Jump to the previous module.
262 Space Pause or unpause module replay.
264 1, 2, 3, 4, 5, 6, 7, 8, 9, 0
266 Mute/unmute channels 1 to 10.
267 ! Unmute all channels.
269 h, ? Display available commands.
271 X Display current mixer type.
273 x Enable classic mixers (if available).
275 Z Display current sequence.
277 z Toggle subsong explorer mode.
279 l Toggle module/sequence looping.
281 m Display module information.
283 i Display combined instrument/sample list.
285 I Display instrument list.
287 S Display sample list.
289 c Display comment, if any.
291 < Change to previous sequence (subsong).
293 > Change to next sequence (subsong).
295 Interactive mode can be disabled using the --nocmd command line option.
297
299 Play module and save output in a .wav file:
300 xmp -ofilename.wav module.mod
302 Play module muting channels 0 to 3 and 6:
304 xmp --mute=0-3,6 module.mod.gz
306 Play modules in /dev/dsp using the default device settings (unsigned
308 8bit, 8 kHz mono):
309 xmp -o/dev/dsp -f8000 -m -b8 -u module.lha
311 Play all XM modules in the /mod directory and all subdirectories in
313 random order, ignoring any configuration set in the xmp.conf file:
314 xmp --norc -R `find /mod -name "*.xm" -print`
316
318 /etc/xmp/xmp.conf, $HOME/.xmp/xmp.conf, /etc/xmp/modules.conf,
319 $HOME/.xmp/modules.conf
320
322 Claudio Matsuoka and Hipolito Carraro Jr.
323Jul 2016 Version 4.1.0 XMP(1)