1XMP(1) Extended Module Player XMP(1)
2
6 xmp - Extended Module Player
7
9 xmp [-8, --8bit] [-a, --amplify factor] [-b, --bits bits] [-c, --std‐
10 out] [--chorus depth] [-D device-specific parameters] [-d, --driver
11 driver] [--fix-sample-loop] [-F, --click-filter] [-f, --frequency rate]
12 [-h, --help] [-i, --interpolate] [--load-only] [-l, --loop] [-M, --mute
13 channel-list] [-m, --mono] [--nocmd] [--nofilter] [-n, --nearest]
14 [--nopan] [--norc] [-o, --output-file filename] [-P, --pan pan]
15 [--probe-only] [-R --random] [--realtime] [--reverb depth] [-r
16 --reverse] [--show-time] [-S, --solo channel-list] [-s, --start pos]
17 [--stereo] [-T, --tempo bpm] [-t, --time time] [-u, --unsigned] [-V,
18 --version] [-v, --verbose] modules
19
21 xmp is a tracked music module player. It plays many module formats
22 including Fasttracker II (XM), Noise/Fast/Protracker (MOD), Scream
23 Tracker 3 (S3M) and Impulse Tracker (IT). Use xmp --help for a complete
24 list of supported formats.
25 xmp can play through several output devices including the Open Sound
27 System sequencer, linear and ulaw PCM audio devices or mixing to a raw
28 or WAV file.
29
31 -8, --8bit
32 Convert 16 bit samples to 8 bit. You may want to use this mode
33 to save memory in the sound device (AWE cards will ignore this
34 mode and always work with 16 bit samples).
35 -a, --amplify factor
37 Amplification factor for the software mixer. Valid amplification
38 factors are 0 (normal), 1 (x2), 2 (x4) and 3 (x8). Warning:
39 amplification factors higher than 0 may cause distorted or noisy
40 output.
41 -b, --bits bits
43 Set the software mixer resolution (8 or 16 bits). If ommited,
44 The audio device will be opened at the highest resolution avail‐
45 able.
46 -c, --stdout
48 Mix the module to stdout.
49 --chorus depth
51 Set chorus depth (if available).
52 -D device-specific parameter
54 Pass a configuration parameter to the device driver. See the
55 DEVICE DRIVER PARAMETERS section below for a list of known
56 parameters.
57 -d, --driver driver
59 Select the output driver. If not specified, xmp will try to
60 probe each available driver.
61 --fix-sample-loop
63 Force sample loop start in samples instead of 16-bit words. This
64 option affects only MOD files.
65 -F, --click-filter
67 Use the LPF filter to remove clicks from the software mixer out‐
68 put.
69 -f, --frequency rate
71 Set the software mixer sampling rate in hertz.
72 -h, --help
74 Show a short summary of command-line options.
75 -i, --interpolate
77 Enable software mixer linear interpolation.
78 --load-only
80 Exit after loading the module&.
81 -l, --loop
83 Enable module looping and backward pattern jumps.
84 -M, --mute channel-list
86 Mute the specified channels. channel-list is a comma-separated
87 list of decimal channel ranges. Example: 0,2-4,8-16.
88 -m, --mono
90 Force mono output (default is stereo in stereo-capable devices).
91 --nocmd
93 Disable interactive commands.
94 --nofilter
96 Disable IT filters. When using the software mixer, IT filters
97 can significantly increase CPU usage on slow machines. In this
98 case, disable filtering with this option.
99 -n, --nearest
101 Enable software mixer nearest neighbor interpolation.
102 --nopan
104 Disable dynamic panning. This option can be used to prevent
105 clicking when playing in AWE32 cards. Module formats that rely
106 only in dynamic pan setting to produce stereo output (e.g. XM)
107 will use the MOD channel panning (LRRL).
108 --norc Don't read the configuration files.
110 -o, --output-file filename
112 Set the output file name when mixing to raw or WAV files. If ´-´
113 is given as the file name, the output will be sent to stdout.
114 -P, --pan num
116 Set the percentual panning amplitude.
117 --probe-only
119 Exit after probing the audio device.
120 -R, --random
122 Play modules in random order.
123 --realtime
125 Play modules in realtime priority (available for FreeBSD).
126 -r, --reverse
128 Reverse the left/right stereo channels.
129 --reverb depth
131 Set reverb depth (if available).
132 --show-time
134 Display elapsed and remaining time.
135 -S, --solo channel-list
137 Play only the specified channels. channel-list is a comma-sepa‐
138 rated list of decimal channel ranges. Example: 0,2-4,8-16.
139 -s, --start pos
141 Start playing the module from the position pos.
142 --stereo
144 Force stereo output.
145 -T, --tempo bpm
147 Set the initial tempo in beats per minute (default is 125).
148 -t, --time time
150 Specifies the maximum playing time to time seconds.
151 -u, --unsigned
153 Tell the software mixer to use unsigned samples when mixing to a
154 file (default is signed).
155 -V, --version
157 Print version information.
158 -v, --verbose
160 Verbose mode (incremental). If specified more than once, the
161 verbosity level will be increased (no messages will be displayed
162 when the player runs in background).
163
165 Use the option -D to send parameters directly to the device drivers.
166 Multiple -D options can be specified in the command line.
167 OSS sequencer:
169 -D awechorus=mode
171 Set the chorus mode in AWE cards. Valid modes range from 0 to 7
172 (CHORUS_1, CHORUS_2, CHORUS_3, CHORUS_4, FEEDBACK, FLANGER,
173 SHORTDELAY, SHORTDELAY2).
174 -D awereverb=mode
176 Set the reverb mode in AWE cards. Valid modes range from 0 to 7
177 (ROOM1, ROOM2, ROOM3, HALL1, HALL2, PLATE, DELAY, PANNINGDELAY).
178 -D opl2
180 Open the sequencer in OPL2 FM mode instead of sample mode. This
181 parameter is required to play modules with FM instruments (RAD,
182 AMD, S3M).
183 -D dev=device_name
185 Set the sequencer device to open. Default is /dev/sequencer.
186 OSS software mixing:
188 -D frag=num,size
190 Set the maximum number of fragments to num and the size of each
191 fragment to size bytes (must be a power of two). The number and
192 size of fragments set a tradeoff between the buffering latency
193 and sensibility to system load. To get better synchronization,
194 reduce the values. To avoid gaps in the sound playback, increase
195 the values.
196 -D dev=device_name
198 Set the audio device to open. Default is /dev/dsp.
199 -D nosync
201 Don´t sync the OSS audio device between modules.
202 HP-UX and Solaris audio:
204 -D gain=value
206 Set the audio gain. Valid value goes from 0 to 255. The default
207 is 128.
208 -D port={s|h|l}
210 Set the audio port. Valid arguments are s for the internal
211 speaker, h for headphones and l for line out. The default is the
212 internal speaker.
213 -D buffer=size
215 Set the size in bytes of the audio buffer. The default value is
216 32 Kb.
217 File output:
219 -D big-endian
221 Generate big-endian 16-bit samples (default is the machine byte
222 ordering).
223 -D little-endian
225 Generate little-endian 16-bit samples (default is the machine
226 byte ordering).
227
229 The following single key commands can be used when playing modules:
230 q Stop the currently playing module and quit the player.
232 f Jump to the next pattern.
234 b Jump to the previous pattern.
236 n Jump to the next module.
238 p Jump to the previous module.
240 SPACE Pause the module.
242 1, 2, 3, 4, 5, 6, 7, 8, 9, 0
244 Mute/unmute channels 1 to 10.
245 ! Unmute all channels.
247 Interactive mode can be disabled using the --nocmd command line option.
249
251 When using the OSS sequencer with an AWE card, xmp will wipe out any
252 soundfonts already loaded in the card.
253
255 Play module muting channels 0 to 3 and 6:
256 xmp --mute=0-3,6 module.mod.gz
258 Play modules in /dev/dsp using the default device settings (unsigned
260 8bit, 8 kHz mono):
261 xmp -o/dev/dsp -f8000 -m -b8 -u module.lha
263 Play all XM modules in the /mod directory and all subdirectories in
265 random order, ignoring any configuration set in the xmp.conf file:
266 xmp --norc -R `find /mod -name "*.xm*" -print`
268
270 /etc/xmp/xmp.conf, $HOME/.xmp/xmp.conf, /etc/xmp/modules.conf,
271 $HOME/.xmp/modules.conf
272
274 Claudio Matsuoka and Hipolito Carraro Jr. Portions of code used in xmp
275 have been contributed by several other authors, see docs/CREDITS for
276 the complete list.
277May 2010 Version 3.2.0 XMP(1)