ADPLAY(1)

๐Ÿ“ฆ
version 1.9 ยท 2 versions
, in ubuntu resolute, ubuntu stonking

โœจ adplay โœจ

User Commands vibes, bestie ๐ŸŽ€ this is the adplay manual, and it is about to be SO good ๐Ÿ’…


๐Ÿฆ‹ NAME ๐Ÿฆ‹

adplay - AdPlay/UNIX console-based OPL2 audio player ๐ŸŽถ

๐ŸŽ€ SYNOPSIS ๐ŸŽ€

adplay [OPTION]... FILE...

๐Ÿ’– DESCRIPTION ๐Ÿ’–

Okay so AdPlay/UNIX is AdPlug's UNIX console-based frontend, and it's giving "play ALL the things" energy ๐Ÿงš It tries to play back every FILE you give it, using whichever output mechanism you pick from the many available ones.

If you only give it one file, it plays endlessly ๐Ÿ” With multiple files, it plays them in a sequence and exits after the last one. You can get the same result with just one file by using the -o option. When you use the disk writer, -o is implied ๐ŸŒธ

๐ŸŒˆ EXIT STATUS ๐ŸŒˆ

adplay returns 0 on successful operation. 1 is returned otherwise. Simple, clean, iconic ๐Ÿ’…

๐Ÿ”ฅ OUTPUT MECHANISMS ๐Ÿ”ฅ

AdPlay/UNIX can play back using lots of different output mechanisms, and you pick one with the -O argument โœจ Whether a method is available depends on compile-time settings. The available methods get printed after the help text, which you can see with --help ๐Ÿ‘€

Here's the lowdown on each one, by abbreviation:

๐ŸŽง oss โ€” Open Sound System (OSS) driver

This output method is available on most Linux and other UNIX systems.

๐ŸŽน null โ€” Total silence

Discards anything sent to it. It can be useful for testing purposes ๐Ÿ™ˆ

๐Ÿ’พ disk โ€” Disk writer

Writes its output to a file in Microsoft RIFF WAVE format ๐ŸŽ™๏ธ

๐Ÿ”Š esound โ€” EsounD output

Creates a socket connection to an EsounD server and streams the audio to it.

๐ŸŽฎ qsa โ€” QNX Sound Architecture (QSA) driver

Uses the QNX system's standard output method.

๐ŸŒŸ sdl โ€” Simple Directmedia Layer (SDL) driver

Uses the SDL library for sound output. It has broader platform support than any of the other output methods, so it could be super useful on some exotic systems ๐Ÿ›ธ

๐Ÿš alsa โ€” Advanced Linux Sound Architecture (ALSA) driver

Uses the standard output method on newer Linux systems.

๐Ÿ“ ao โ€” libao driver

Libao is a cross-platform audio library with very broad platform support. It might be useful on systems where SDL is not available, and generally for doing tricky things ๐Ÿง

๐Ÿ‘‘ OPTIONS ๐Ÿ‘‘

The order of the option commandline parameters is not important, except for -d, which always has to be specified after an -O option. Remember that one, it matters ๐Ÿซถ

๐ŸŽฏ Output selection:

  • -O, --output=OUTPUT โ€” Pick your output mechanism! The available ones depend on compilation settings and get printed in the --help output. A reasonable default is automatically selected, based on which output mechanisms are available.

๐Ÿง OSS driver (oss) specific:

  • -d, --device=FILE โ€” Set the sound output device file to FILE. It's /dev/dsp by default.

๐Ÿ’ฟ Disk writer (disk) specific:

  • -d, --device=FILE โ€” Write the sound data to FILE. The data is written in Microsoft RIFF WAVE format (little-endian). You can specify a single - to write to stdout instead.
โš ๏ธ Bestie, heads up: this option has no default and must be specified when the disk writer is to be used!

๐ŸŽถ EsounD output (esound) specific:

  • -d, --device=URL โ€” Connect to the "hostname:port" combination in URL. Example: "myhost.sound.net:1234". The default is "localhost:16001".

๐ŸŽบ ALSA driver (alsa) specific:

  • -d, --device=DEVICE โ€” Set the sound output device to DEVICE. It's plughw:0,0 by default.

โœจ Playback quality:

  • -8, --8bit โ€” Only use 8-bit samples for playback.
  • --16bit โ€” Only use 16-bit samples for playback (default).
  • -f, --freq=FREQ โ€” Set the playback frequency to FREQ, in Hz. It's 44100Hz by default.
  • --stereo โ€” Only use stereo samples for playback. The sound stream is just doubled, with no further audio processing. This option is pretty useless unless you have very obscure audio hardware that only accepts stereo streams. AdPlug only generates mono streams because the OPL2 only generates mono sound ๐Ÿคทโ€โ™€๏ธ
  • --mono โ€” Only use mono samples for playback (default if AdPlug <= 2.1.)
  • --surround โ€” Only use stereo samples for playback, but generate them from two mono OPL2 chips. One OPL2 chip is very slightly transposed to produce a pleasant harmonic/surround sound effect ๐ŸŽง (default if AdPlug >= 2.2.)
  • -b, --buffer=SIZE โ€” Set the sound buffer size to SIZE samples. If you notice sound skipping with the default setting, try a greater buffer size. Note that this is measured in samples, not bytes! The default is 2048 samples. Only the OSS, SDL, ALSA and libao output drivers support this option.

๐Ÿ“บ Informative output:

  • -i, --instruments โ€” Display instrument names (if available).
  • -r, --realtime โ€” Display realtime playback information while playing. This shows a one-line status bar with the essential playback info ๐Ÿ“Š
  • -m, --message โ€” Display the song message (if available).

โ–ถ๏ธ Playback:

  • -s, --subsong=N โ€” Play subsong number N, instead of the file's default subsong. Only useful for file formats that support multiple subsongs.
  • -o, --once โ€” Don't loop endlessly. This will exit adplay after the song ended. This is the default when multiple FILEs are given.
  • -l, --loop=N โ€” Loop N times, then stop. Due to technical limitations of the adplug library, a "loop" is considered to be the time between the start of playback and when looping first occurs. So playback may actually halt at an unexpected point, especially when combined with -s. This implies -o.

๐Ÿงธ Miscellaneous:

  • -D, --database=FILE โ€” Additionally use database file FILE. This option can be specified multiple times. Each database file gets merged with the others, creating one large database on the fly ๐Ÿ—‚๏ธ
  • -q, --quiet โ€” Be more quiet ๐Ÿคซ
  • -v, --verbose โ€” Be more verbose ๐Ÿ“ฃ
  • -h, --help โ€” Show a summary of options.
  • -V, --version โ€” Show the version of the program.

๐Ÿ’Œ AUTHOR ๐Ÿ’Œ

Simon Peter <dn.tlp@gmx.net> is the one behind it all, and honestly we owe them a big thank-you ๐Ÿซถ


Bye bestie ๐Ÿ’œ that was AdPlay/UNIX 1.9, dated December 21, 2025. Now go make some music ๐ŸŽ€โœจ

๐Ÿ“ฆ where this page comes from