1UMODPLAYER
2
3September, 2006
4
5%!target: man
6
7= NAME =
8
9umodplayer - play and convert module files
10
11= SYNOPSIS =
12
13**umodplayer** [ //module// ] [-N,-R,-B,-S] [+N,+R,+B,+S] [-o //output// ] [ //options// ]
14
15= DESCRIPTION =
16
17**umodplayer** is a module file player and converter. It uses the LibModPlug
18library to render the module files. It can export the raw audio to an external
19file such as WAV or AIFF, or play it directly using LibAo.
20
21**umodplayer** has two modes of operation: the //interactive mode// and the
22//command line mode//. In the interactive mode, UModPlayer is operated by
23commands and arguments. In the command line mode, UModPlayer is given a list
24of command options and a operation to do. After doing this operation, UModPlayer
25will exit.
26
27**umodplayer** allows the configuration of various options, including audio-related
28ModPlug settings such as reverb, noise reduction, etc.
29
30Such configuration can be saved to a file in the home directory. The first time
31**umodplayer** is started, it's recommended to use the **config**, **setadvanced** and
32**saveconfig** commands to configure **umodplayer** and save such configuration.
33
34In interactive mode, **umodplayer** supports //playlists//. Playlists are a list
35of modules collected by the user (or imported from a directory) which will be played
36in order without requiring user intervention to move to the next module. Of course,
37the playlist can be stopped or paused at any moment. Also, there is a 2-second gap
38between modules in which a key can be pressed to immediately stop the playlist.
39
40If **umodplayer** is started without giving a module file, it will default to //interactive mode//. If a module file is given in the command line, it will enter //command line mode// and play the file with the specified options unless the **-i** option is given. If the **-i** option is given, **umodplayer** will load the file but enter //interactive mode// instead.
41
42
43= OPTIONS =
44
45:  **-h** or **--help**
46display a brief option summary and exit.
47
48:  **-V**
49print the UModPlayer version and build date, and exit immediately.
50
51:  **-q**
52quiet. disable notices and information messages. do not print the status bar while playing.
53
54:  **-i**
55interactive mode. This will force interactive mode even if a module file is given in the command line.
56
57:  **-o** //file//
58output file name to export the module. UModPlayer will try to guess the export export format using its extension, such as **.wav** or **.aiff**. If a format is not recognized, you must specify it with the **-f** option.
59
60:  **-f** //format//
61format to export the module. This option must be given **after** the **-o** option. Available formats are: **wav** (WAVE Audio File), **aiff16** (16-bit AIFF), **aiff24** (24-bit AIFF), **s16se** (raw 16-bit PCM), **s16le** (little-endian PCM), **s16be** (big-endian PCM) and **it** (Impulse Tracker, only if ModPlug has been compiled with save support).
62
63:  **-a** //order//
64start the exporting in the order //order//, not in the beginning.
65
66:  **-z** //order//
67finish the exporting when the order //order// is reached.
68
69:  **-d**
70load the default options, overriding any saved configuration.
71
72:  **-m** //file//
73save the module built-in message to the given file.
74
75:  **-s** //file//
76save the list of sample names present in the module to the given file. Many authors use the sample names to store aditional information, such as date, copyright, etc.
77
78:  **-I** //file//
79same as above, but save instruments instead of samples. These options are not exclusive.
80
81:  **-v** //volume//
82volume to play or export. Must be an integer between 1 and 768. The default value is 128.
83
84:  **-c** //channels//
85channels for playing or exporting. Must be **1** for mono, or **2** for stereo.
86
87:  **-r** //rate//
88sampling rate for playing or exporting. The default value is 44100 Hz. **NOTE**: This option is currently broken.
89
90:  **-M** //resampling//
91resampling mode for the module rendering in LibModPlug. Possible values, ordered by quality from low to high: **NO_INTERPOLATE**, **LINEAR**, **SPLINE** and **FIR_FILTER**. Note that some modules might sound better with the **LINEAR** resampling. The default value is **SPLINE**.
92
93:  **+N**
94enable noise reduction. If it's already enabled in the configuration, keep it enabled.
95
96:  **-N**
97disable noise reduction. If it's already disabled, keep it disabled.
98
99:  **+S**
100enable surround.
101
102:  **-S**
103disable surround.
104
105:  **+B**
106enable megabass.
107
108:  **-B**
109disable megabass.
110
111:  **+R**
112enable reverb.
113
114:  **-R**
115disable reverb.
116
117:  **-d**
118use the default configuration values, overriding any saved settings.
119
120:  **-w**
121save the configuration options specified in the command line.
122
123:  **-O** //driver//
124driver for use with LibAo. In example **alsa09**, **alsa**, **oss**, **sun**, **macosx**, **arts**, **esd**, **irix**, **null** and possibly others in your LibAo version. Note that a default driver may be specified in the **libao.conf(5)** file.
125
126
127= EXAMPLES =
128
129: **Entering interactive mode**
130``$ umodplayer``
131
132: **Playing a module directly from command line**
133``$ umodplayer MyModule.xm``
134
135: **Playling a module with surround and without reverb**
136``$ umodplayer +S -R MyModule.xm``
137
138: **Playing a module quietly, without status bar**
139``$ umodplayer -q MyModule.xm``
140
141: **Exporting a module using volume 224 to a 24-bit AIFF file**
142``$ umodplayer -v 224 MyModule.xm -o test.aiff -f aiff24``
143
144: **Exporting a module to raw little-endian 16-bit PCM**
145``$ umodplayer MyModule.xm -o audio.raw -f s16le``
146
147
148= FILES =
149
150: **~/.umodplayerb**
151``The umodplayer configuration file``
152
153
154= BUGS =
155
156: The **-r** command line option may not work due to some oddness in the option management between UModPlayer and LibModPlug.
157
158
159= SEE ALSO =
160: **libao.conf(5)**
161
162
163