1OPENMPT123(1)                    User Commands                   OPENMPT123(1)
2
3
4

NAME

6       openmpt123 - command line module music player based on libopenmpt
7

SYNOPSIS

9       openmpt123 [options] [--] file1 [file2] ...
10

DESCRIPTION

12       openmpt123 plays module music files.
13

OPTIONS

15       -h, --help
16              Show help
17
18       --help-keyboard
19              Show keyboard hotkeys in ui mode
20
21       -q, --quiet
22              Suppress non-error screen output
23
24       -v, --verbose
25              Show more screen output
26
27       --version
28              Show version information and exit
29
30       --short-version
31              Show version number and nothing else
32
33       --long-version
34              Show long version information and exit
35
36       --credits
37              Show elaborate contributors list
38
39       --license
40              Show license
41
42       --probe
43              Probe each file whether it is a supported file format
44
45       --info Display information about each file
46
47       --ui   Interactively play each file
48
49       --batch
50              Play each file
51
52       --render
53              Render each file to individual PCM data files
54
55       --terminal-width n
56              Assume terminal is n characters wide [default: 72]
57
58       --terminal-height n
59              Assume terminal is n characters high [default: 23]
60
61       --[no-]progress
62              Show playback progress [default: 0]
63
64       --[no-]meters
65              Show peak meters [default: 0]
66
67       --[no-]channel-meters
68              Show channel peak meters (EXPERIMENTAL) [default: 0]
69
70       --[no-]pattern
71              Show pattern (EXPERIMENTAL) [default: 0]
72
73       --[no-]details
74              Show song details [default: 1]
75
76       --[no-]message
77              Show song message [default: 0]
78
79       --update n
80              Set output update interval to n ms [default: -1]
81
82       --samplerate n
83              Set samplerate to n Hz [default: 48000]
84
85       --channels n
86              use n [1,2,4] output channels [default: 2]
87
88       --[no-]float
89              Output  32bit  floating point instead of 16bit integer [default:
90              1]
91
92       --gain n
93              Set output gain to n dB [default: 0]
94
95       --stereo n
96              Set stereo separation to n % [default: 100]
97
98       --filter n
99              Set interpolation filter taps to n [1,2,4,8] [default: 8]
100
101       --ramping n
102              Set volume ramping strength n [0..5] [default: -1]
103
104       --tempo f
105              Set tempo factor f [default: 1]
106
107       --pitch f
108              Set pitch factor f [default: 1]
109
110       --dither n
111              Dither type to use (if applicable for selected  output  format):
112              [0=off,1=auto,2=0.5bit,3=1bit] [default: 1]
113
114       --playlist file
115              Load playlist from file
116
117       --[no-]randomize
118              Randomize playlist [default: 0]
119
120       --[no-]shuffle
121              Shuffle through playlist [default: 0]
122
123       --[no-]restart
124              Restart playlist when finished [default: 0]
125
126       --subsong n
127              Select subsong n (-1 means play all subsongs consecutively) [de‐
128              fault: -1]
129
130       --repeat n
131              Repeat song n times (-1 means forever) [default: 0]
132
133       --seek n
134              Seek to n seconds on start [default: 0]
135
136       --end-time n
137              Play until position is n seconds (0 means until  the  end)  [de‐
138              fault: 0]
139
140       --ctl c=v
141              Set libopenmpt ctl c to value v
142
143       --driver n
144              Set output driver [default: default],
145
146       --device n
147              Set  output device [default: default], use --device help to show
148              available devices
149
150       --buffer n
151              Set output buffer size to n ms [default: -1]
152
153       --period n
154              Set output period size to n ms [default: -1]
155
156       --stdout
157              Write raw audio data to stdout [default: 0]
158
159       --output-type t
160              Use output format t when writing to a individual PCM files (only
161              applies to --render mode) [default: auto]
162
163       -o, --output f
164              Write  PCM output to file f instead of streaming to audio device
165              (only applies to --ui and --batch modes) [default: ]
166
167       --force
168              Force overwriting of output file [default: 0]
169
170       --     Interpret further arguments as filenames
171
172       Keyboard hotkeys (use 'openmpt123 --ui'):
173
174       [q]    quit
175
176       [ ]    pause / unpause
177
178       [N]    skip 10 files backward
179
180       [n]    prev file
181
182       [m]    next file
183
184       [M]    skip 10 files forward
185
186       [h]    seek 10 seconds backward
187
188       [j]    seek 1 seconds backward
189
190       [k]    seek 1 seconds forward
191
192       [l]    seek 10 seconds forward
193
194       [u]|[i]
195              +/- tempo
196
197       [o]|[p]
198              +/- pitch
199
200       [3]|[4]
201              +/- gain
202
203       [5]|[6]
204              +/- stereo separation
205
206       [7]|[8]
207              +/- filter taps
208
209       [9]|[0]
210              +/- volume ramping
211

COPYRIGHT

213       Copyright ©  2013-2023  OpenMPT  Project  Developers  and  Contributors
214       <https://lib.openmpt.org/>
215
216
217
218openmpt123 v0.6.12              September 2023                   OPENMPT123(1)