1ADPLAY(1) User Commands ADPLAY(1)
2
6 adplay - AdPlay/UNIX console-based OPL2 audio player
7
9 adplay [OPTION]... FILE...
10
12 AdPlay/UNIX is AdPlug's UNIX console-based frontend. It tries to play
13 back all given FILEs, using one of many available output mechanisms.
14 AdPlay/UNIX plays endlessly, if only one file is given. With multiple
16 files, it plays them in a sequence and exits after the last file. The
17 same can also be accomplished with only one file, by using the -o
18 option. When using the disk writer, -o is implied.
19
21 adplay returns 0 on successful operation. 1 is returned otherwise.
22
24 AdPlay/UNIX can play back using many different output mechanisms, which
25 can be selected with the -O argument. The availability of a method
26 depends on compile-time settings. Available methods are printed out
27 after the help text, displayed with --help.
28 Next is a brief description of all output mechanisms, following their
30 abbreviations:
31 oss -- Open Sound System (OSS) driver
33 This output method is available on most Linux and other UNIX systems.
34 null -- Total silence
36 Discards anything sent to it. It can be useful for testing purposes.
37 disk -- Disk writer
39 Writes its output to a file in Microsoft RIFF WAVE format.
40 esound -- EsounD output
42 Creates a socket connection to an EsounD server and streams the audio
43 to it.
44 qsa -- QNX Sound Architecture (QSA) driver
46 Uses the QNX system's standard output method.
47 sdl -- Simple Directmedia Layer (SDL) driver
49 Uses the SDL library for sound output. The library has a broader plat‐
50 form support than any of the other output methods. Thus, it could be
51 useful on some exotic systems.
52 alsa -- Advanced Linux Sound Architecture (ALSA) driver
54 Uses the standard output method on newer Linux systems.
55 ao -- libao driver
57 Libao is a cross-platform audio library with very broad platform sup‐
58 port. Might be useful on systems, where SDL is not available, and gen‐
59 erally to do tricky things.
60
62 The order of the option commandline parameters is not important, except
63 for the -d option, which always has to be specified after an -O option.
64 Output selection:
66 -O, --output=OUTPUT
67 Specify output mechanism. Available mechanisms depend on compi‐
68 lation settings and are printed on --help output. A reasonable
69 default is automatically selected, based on the availability of
70 the output mechanisms.
71 OSS driver (oss) specific:
73 -d --device=FILE
74 Set sound output device file to FILE. This is /dev/dsp by
75 default.
76 Disk writer (disk) specific:
78 -d --device=FILE
79 Write sound data to FILE. The data is written in Microsoft RIFF
80 WAVE format (little-endian). You can specify a single '-' to
81 write to stdout instead. This option has no default and must be
82 specified when the disk writer is to be used!
83 EsounD output (esound) specific:
85 -d --device=URL
86 Connect to "hostname:port" combination in URL. Example:
87 "myhost.sound.net:1234". The default is "localhost:16001".
88 ALSA driver (alsa) specific:
90 -d --device=DEVICE
91 Set sound output device to DEVICE. This is plughw:0,0 by
92 default.
93 Playback quality:
95 -8, --8bit
96 Use only 8-bit samples for playback.
97 --16bit
99 Use only 16-bit samples for playback (default).
100 -f, --freq=FREQ
102 Set playback frequency to FREQ, in Hz. This is 44100Hz by
103 default.
104 --stereo
106 Use only stereo samples for playback. The sound stream is just
107 doubled, no further audio processing is done. This option is
108 pretty useless unless you have very obscure audio hardware that
109 only accepts stereo streams. AdPlug only generates mono streams
110 because the OPL2 only generates mono sound.
111 --mono Use only mono samples for playback (default).
113 -b --buffer=SIZE
115 Set sound buffer size to SIZE samples. If you notice sound skip‐
116 ping with the default setting, try a greater buffer size. Note
117 that this is measured in samples, not bytes! This is 2048 sam‐
118 ples by default. Only the OSS, SDL, ALSA and libao output driv‐
119 ers support this option.
120 Informative output:
122 -i --instruments
123 Display instrument names (if available).
124 -r --realtime
126 Display realtime playback information, while playing. This will
127 display a one-line status bar, containing essential playback
128 information.
129 -m --message
131 Display the song message (if available).
132 Playback:
135 -s --subsong=N Play subsong number N, instead of the first sub‐
136 song. Only useful for file formats that support multiple sub‐
137 songs.
138 -o --once
140 Play just once, don't loop. This will exit adplay after the song
141 ended. This is the default when multiple FILEs are given.
142 Miscellaneous:
144 -D, --database=FILE
145 Additionally use database file FILE. This option may be speci‐
146 fied multiple times. Each database file is additionally merged
147 with the others, creating one large database on the fly.
148 -q, --quiet
150 Be more quiet.
151 -v, --verbose
153 Be more verbose.
154 -h, --help
156 Show summary of options.
157 -V, --version
159 Show version of program.
160
162 Simon Peter <dn.tlp@gmx.net>
163AdPlay/UNIX 1.6 April 29, 2006 ADPLAY(1)