/usr/bin/sox: SoX v14.4.2
Usage summary: [gopts] [[fopts] infile]... [fopts] outfile [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)
--combine concatenate Concatenate all input files (default for sox, rec)
--combine sequence Sequence all input files (default for play)
-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
--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)
--no-clobber Prompt to overwrite output file
-m, --combine mix Mix multiple input files (instead of concatenating)
--combine mix-power Mix to equal power (instead of concatenating)
-M, --combine merge Merge multiple input files (instead of concatenating)
--multi-threaded Enable parallel effects channels processing
--norm Guard (see --guard) & normalise
--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; 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
--single-threaded Disable 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: 8svx aif aifc aiff aiffc al amb au avr cdda cdr cvs cvsd cvu dat dvms f32 f4 f64 f8 flac fssd gsm gsrt hcom htk ima ircam la lpc lpc10 lu maud mp2 mp3 nist ogg prc raw s1 s16 s2 s24 s3 s32 s4 s8 sb sf sl sln smp snd sndr sndt sou sox sph sw txw u1 u16 u2 u24 u3 u32 u4 u8 ub ul uw vms voc vorbis vox wav wavpcm wve xa
PLAYLIST FORMATS: m3u pls
AUDIO DEVICE DRIVERS: oss ossdsp
EFFECTS: allpass band bandpass bandreject bass bend biquad chorus channels compand contrast dcshift deemph delay dither divide+ downsample earwax echo echos equalizer fade fir firfit+ flanger gain highpass hilbert input# ladspa loudness lowpass mcompand noiseprof noisered norm oops output# overdrive pad phaser pitch rate remix repeat reverb reverse riaa silence sinc speed splice stat stats stretch swap synth tempo treble tremolo trim upsample vad vol
* Deprecated effect + Experimental effect # LibSoX-only effect
EFFECT OPTIONS (effopts): effect dependent; see --help-effect
Options (43)
| Option | Description | Source |
|---|---|---|
-d, --default-device | Use the default audio device (where available) | help |
-n, --null | Use the `null' file handler; | help |
-p, --sox-pipe | Alias for `-t sox -' | help |
--buffer BYTES | Set the size in bytes of the buffers used for processing audio (default 8192). | help + man |
--clobber | Don't prompt before overwriting an existing file with the same name as that given for the output file. | help + man |
--combine concatenate | Concatenate all input files (default for sox, rec) | help + man |
-D, --no-dither | Disable automatic dither - see Dithering' above. | help + man |
--dft-min NUM | Minimum size (log2) for DFT processing (default 10) | help |
--effects-file FILENAME | Use FILENAME to obtain all effects and their arguments. | help + man |
-G, --guard | Automatically invoke the gain effect to guard against clipping. | help + man |
-h, --help | Display version number and usage information | help + man |
--help-effect NAME | Show usage information on the specified effect. | help + man |
--help-format NAME | Show information about the specified file format. | help + man |
--i, --info | Only if given as the first parameter to sox, behave as soxi(1). | help + man |
--input-buffer BYTES | Override the input buffer size (default: as --buffer) | help |
--no-clobber | Prompt before overwriting an existing file with the same name as that given for the output file. | help + man |
--multi-threaded | Enable parallel effects channels processing | help + man |
--norm | Guard (see --guard) & normalise | help |
--play-rate-arg ARG | Selects a quality option to be used when the rate' effect is automatically invoked whilst playing audio. | help + man |
--plot gnuplot|octave | If not set to off (the default if --plot is not given), run in a mode that can be used, in conjunction with the gnuplot program or the GNU Octave program, to assist with the selection and… | help + man |
-q, --no-show-progress | Run in quiet mode when SoX wouldn't otherwise do so. | help + man |
--replay-gain track|album|off | Select whether or not to apply replay-gain adjustment to input files. | help + man |
-R | Use default random numbers (same on each run of SoX) | help + man |
-S, --show-progress | Display input file format/header information, and processing progress as input file(s) percentage complete, elapsed time, and remaining time (if known; | help + man |
--single-threaded | Disable parallel effects channels processing | help |
--temp DIRECTORY | Specify that any temporary files should be created in the given DIRECTORY. | help + man |
--version | Display version number of SoX and exit | help + man |
-V LEVEL | Increment or set verbosity level (default 2); | help |
--ignore-length | Override an (incorrect) audio length given in an audio file's header. | help + man |
--add-comment TEXT | Append a comment in the output file header (where applicable). | help + man |
--comment TEXT | Specify the comment text to store in the output file header (where applicable). | help + man |
--comment-file FILENAME | Specify a file containing the comment text to store in the output file header (where applicable). | help + man |
--no-glob | Specifies that filename globbing' (wild-card matching) should not be performed by SoX on the following filename. | help + man |
--magic | If SoX has been built with the optional libmagic' library then this option can be given to enable its use in helping to detect audio file types. (in the manual page but not in --help) | man |
-T | Equivalent to --combine multiply. (in the manual page but not in --help) | man |
-v, --volume FACTOR | Intended for use when combining multiple input files, this option adjusts the volume of the file that follows it on the command line by a factor of FACTOR. (in the manual page but not in --help) | man |
-b, --bits BITS | The number of bits (a.k.a. (in the manual page but not in --help) | man |
-c, --channels CHANNELS | The number of audio channels in the audio file. (in the manual page but not in --help) | man |
-e, --encoding ENCODING | The audio encoding type. (in the manual page but not in --help) | man |
-t, --type FILE-TYPE | Gives the type of the audio file. (in the manual page but not in --help) | man |
-N, --reverse-nibbles | Specifies that the nibble ordering (i.e. the 2 halves of a byte) of the samples should be reversed; (in the manual page but not in --help) | man |
-X, --reverse-bits | Specifies that the bit ordering of the samples should be reversed; (in the manual page but not in --help) | man |
-C, --compression FACTOR | The compression factor for variably compressing output file formats. (in the manual page but not in --help) | man |
Exit status (2) from the manual page
1 | there is a problem with the command-line parameters |
2 | an error occurs during file processing |