OS Manuals

/usr/bin/play

sox_ng is another Swiss Army Knife of sound processing utilities

From sox-ng 14.8.1-r2 (extra-packages), captured 2026-11-07 by running play --help (exit 0). permalink

play:      SoX_ng v14.8.1

Usage summary: [gopts] [[fopts] infile]... [fopts] [effect [effopt]]...

SPECIAL FILENAMES (infile, outfile):
-                        Pipe/redirect input/output (stdin/stdout); may need -t
-d, --default-device     Use the default audio device (where available)
-n, --null               Use the `null' file handler; e.g. with synth effect
-p, --sox-pipe           Alias for `-t sox -'

SPECIAL FILENAMES (infile only):
"|program [options] ..." Pipe input from external program (where supported)
http://server/file       Use the given URL as input file (where supported)

GLOBAL OPTIONS (gopts) (can be specified at any point before the first effect):
--buffer BYTES           Set the size of all processing buffers (default 8192)
--clobber                Don't prompt to overwrite output file (default)
--no-clobber             Prompt to overwrite output file
--combine concatenate    Concatenate all input files (default for sox, rec)
--combine sequence       Sequence all input files (default for play)
--combine mix, -m        Mix multiple input files
--combine mix-power      Mix to equal power
--combine merge, -M      Merge multiple input files
-D, --no-dither          Don't dither automatically
--dft-min NUM            Minimum size (log2) for DFT processing (default 10)
--effects-file FILENAME  File containing effects and options
-G, --guard              Use temporary files to guard against clipping
-h, --help               Display version number and usage information
-h NAME                  Show info of effect or format NAME
--help-effect NAME       Show usage of effect NAME, or NAME=all for all
--help-format NAME       Show info on format NAME, or NAME=all for all
--i, --info              Behave as soxi(1)
--input-buffer BYTES     Override the input buffer size (default: as --buffer)
--interactive            Be interactive (on when playing or with --keymap)
--keymap X:effect.param(+|-|*|/|=)N
                         When key X is pressed, adjust the effect's parameter
                         linearly, logarithmically or set it to a value
--multi-threaded         Enable parallel effects channels processing
--norm                   Guard (see --guard) and normalize
--play-rate-arg ARG      Default `rate' argument for auto-resample with `play'
--plot gnuplot|octave    Generate script to plot response of filter effect
-q, --no-show-progress   Run in quiet mode, the opposite of -S
--replay-gain track|album|off  Default: off (sox, rec), track (play)
-R                       Use default random numbers (same on each run of SoX)
-S, --show-progress      Display progress while processing audio data
--multi-threaded         Enable parallel effects channels processing
--temp DIRECTORY         Specify the directory to use for temporary files
-T, --combine multiply   Multiply samples of corresponding channels from all
                         input files (instead of concatenating)
--version                Display version number of SoX and exit
-V[LEVEL]                Increment or set verbosity level (default 2); levels:
                           1: failure messages
                           2: warnings
                           3: details of processing
                           4-6: increasing levels of debug messages
FORMAT OPTIONS (fopts):
Input file format options need only be supplied for files that are headerless.
Output files will have the same format as the input file where possible and not
overridden by any of various means including providing output format options.

-v|--volume FACTOR       Input file volume adjustment factor (real number)
--ignore-length          Ignore input file length given in header; read to EOF
-t|--type FILETYPE       File type of audio
-e|--encoding ENCODING   Set encoding (ENCODING may be one of signed-integer,
                         unsigned-integer, floating-point, mu-law, a-law,
                         ima-adpcm, ms-adpcm, gsm-full-rate)
-b|--bits BITS           Encoded sample size in bits
-N|--reverse-nibbles     Encoded nibble-order
-X|--reverse-bits        Encoded bit-order
--endian little|big|swap Encoded byte-order; swap means opposite to default
-L/-B/-x                 Short options for the above
-c|--channels CHANNELS   Number of channels of audio data; e.g. 2 = stereo
-r|--rate RATE           Sample rate of audio
-C|--compression FACTOR  Compression factor for output format
--add-comment TEXT       Append output file comment
--comment TEXT           Specify comment text for the output file
--comment-file FILENAME  File containing comment text for the output file
--no-glob                Don't `glob' wildcard match the following filename

AUDIO FILE FORMATS: 3g2 3gp 3gp2 3gpp 3gpp2 8svx aa aac ac3 act adts adx aif aifc aiff aiffc al amb ape apm aptx aptxhd argo_asf asf ast au avi avr cda cdda cdr cvs cvsd cvu dat dff dfpwm dsf dts dvd dvms ea eac3 f32 f4 f4v f64 f8 ffmpeg flv fssd gsm gsrt gxf hcom htk ima ircam ism isma ismv kux kvag la lpc lpc10 lu m4a m4b m4v maud mj2 mkv mlp mod mov mp4 mpeg mpegts mpg mul mxf mxf_opatom nist nsp nut oga pcm prc psp ra raw rm rso s1 s16 s2 s24 s3 s32 s4 s8 sb sbc sf sl sln smjpeg smp snd sndr sndt sou sox spdif speex sph spx svcd svx sw tta txw u1 u16 u2 u24 u3 u32 u4 u8 ub ul uw vag vcd vms vob voc vox wav wavpcm webm wma wsaud wsd wtv wve xa
PLAYLIST FORMATS: m3u pls
AUDIO DEVICE DRIVERS: oss ossdsp
EFFECTS: allpass band bandpass bandreject bass bend biquad centercut channels chorus compand contrast dcshift deemph delay dither dolbyb dop downsample earwax echo echos equalizer fade fir firfit flanger gain highpass hilbert ladspa loudness lowpass mcompand noiseprof noisered norm oops overdrive pad phaser pitch rate remix repeat reverb reverse riaa saturation sdm silence sinc softvol speed splice stat stats stretch swap synth tempo treble tremolo trim upsample vad vol
EFFECT OPTIONS: effect dependent; see --help-effect
Options (34)
OptionDescriptionSource
-d, --default-deviceUse the default audio device (where available)help
-n, --nullUse the `null' file handler;help
-p, --sox-pipeAlias for `-t sox -'help
--buffer BYTESSet the size of all processing buffers (default 8192)help
--clobberDon't prompt to overwrite output file (default)help
--no-clobberPrompt to overwrite output filehelp
--combine concatenateConcatenate all input files (default for sox, rec)help
-D, --no-ditherDon't dither automaticallyhelp
--dft-min NUMMinimum size (log2) for DFT processing (default 10)help
--effects-file FILENAMEFile containing effects and optionshelp
-G, --guardUse temporary files to guard against clippinghelp
-h, --helpDisplay version number and usage informationhelp
--help-effect NAMEShow usage of effect NAME, or NAME=all for allhelp
--help-format NAMEShow info on format NAME, or NAME=all for allhelp
--i, --infoBehave as soxi(1)help
--input-buffer BYTESOverride the input buffer size (default: as --buffer)help
--interactiveBe interactive (on when playing or with --keymap)help
--keymap X:effect.param(+|-|*|/|=)NWhen key X is pressed, adjust the effect's parameter linearly, logarithmically or set it to a valuehelp
--multi-threadedEnable parallel effects channels processinghelp
--normGuard (see --guard) and normalizehelp
--play-rate-arg ARGDefault `rate' argument for auto-resample with `play'help
--plot gnuplot|octaveGenerate script to plot response of filter effecthelp
-q, --no-show-progressRun in quiet mode, the opposite of -Shelp
--replay-gain track|album|offDefault: off (sox, rec), track (play)help
-RUse default random numbers (same on each run of SoX)help
-S, --show-progressDisplay progress while processing audio datahelp
--temp DIRECTORYSpecify the directory to use for temporary fileshelp
--versionDisplay version number of SoX and exithelp
-V LEVELIncrement or set verbosity level (default 2);help
--ignore-lengthIgnore input file length given in header;help
--add-comment TEXTAppend output file commenthelp
--comment TEXTSpecify comment text for the output filehelp
--comment-file FILENAMEFile containing comment text for the output filehelp
--no-globDon't `glob' wildcard match the following filenamehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.