formats: clarify setting of reverse_bytes
[sox.git] / soxformat.7
blob532fd2db6fde91391be3ccece837bad9a681db20
1 '\" t
2 '\" The line above instructs most `man' programs to invoke tbl
3 '\"
4 '\" Separate paragraphs; not the same as PP which resets indent level.
5 .de SP
6 .if t .sp .5
7 .if n .sp
8 ..
9 '\"
10 '\" Replacement em-dash for nroff (default is too short).
11 .ie n .ds m " - 
12 .el .ds m \(em
13 '\"
14 '\" Placeholder macro for if longer nroff arrow is needed.
15 .ds RA \(->
16 '\"
17 '\" Decimal point set slightly raised
18 .if t .ds d \v'-.15m'.\v'+.15m'
19 .if n .ds d .
20 '\"
21 '\" Enclosure macro for examples
22 .de EX
23 .SP
24 .nf
25 .ft CW
27 .de EE
28 .ft R
29 .SP
30 .fi
32 .TH SoX 7 "December 31, 2014" "soxformat" "Sound eXchange"
33 .SH NAME
34 SoX \- Sound eXchange, the Swiss Army knife of audio manipulation
35 .SH DESCRIPTION
36 This manual describes SoX supported file formats and audio device types;
37 the SoX manual set starts with
38 .BR sox (1).
39 .SP
40 Format types that can SoX can determine by a filename
41 extension are listed with their names preceded by a dot.
42 Format types that are optionally built into SoX
43 are marked `(optional)'.
44 .SP
45 Format types that can be handled by an
46 external library via an optional pseudo file type (currently
47 .BR sndfile )
48 are marked e.g. `(also with \fB\-t sndfile\fR)'.  This might be
49 useful if you have a file that doesn't work with SoX's default format
50 readers and writers, and there's an external reader or writer for that
51 format.
52 .SP
53 To see if SoX has support for an optional format or device, enter
54 .B sox \-h
55 and look for its name under the list:
56 `AUDIO FILE FORMATS' or `AUDIO DEVICE DRIVERS'.
57 .SS SOX FORMATS & DEVICE DRIVERS
58 \&\fB.raw\fR (also with \fB\-t sndfile\fR),
59 \&\fB.f32\fR, \fB.f64\fR,
60 \&\fB.s8\fR, \fB.s16\fR, \fB.s24\fR, \fB.s32\fR,
61 .br
62 \&\fB.u8\fR, \fB.u16\fR, \fB.u24\fR, \fB.u32\fR,
63 \&\fB.ul\fR, \fB.al\fR, \fB.lu\fR, \fB.la\fR
64 .if t .sp -.5
65 .if n .sp -1
66 .TP
67
68 Raw (headerless) audio files.  For
69 .BR raw ,
70 the sample rate and the data encoding must be given using command-line
71 format options; for the other listed types, the sample rate defaults to
72 8kHz (but may be overridden), and the data encoding is defined by the
73 given suffix.  Thus \fBf32\fR and \fBf64\fR indicate files encoded as 32
74 and 64-bit (IEEE single and double precision) floating point PCM
75 respectively; \fBs8\fR, \fBs16\fR, \fBs24\fR, and \fBs32\fR indicate 8,
76 16, 24, and 32-bit signed integer PCM respectively; \fBu8\fR, \fBu16\fR,
77 \fBu24\fR, and \fBu32\fR indicate 8, 16, 24, and 32-bit unsigned integer
78 PCM respectively; \fBul\fR indicates `\(*m-law' (8-bit), \fBal\fR
79 indicates `A-law' (8-bit), and \fBlu\fR and \fBla\fR are inverse bit
80 order `\(*m-law' and inverse bit order `A-law' respectively.  For all raw
81 formats, the number of channels defaults to 1 (but may be overridden).
82 .SP
83 Headerless audio files on a SPARC computer are likely to be of format
84 \fBul\fR;  on a Mac, they're likely to be \fBu8\fR but with a
85 sample rate of 11025 or 22050\ Hz.
86 .SP
87 See
88 .B .ima
89 and
90 .B .vox
91 for raw ADPCM formats, and
92 .B .cdda
93 for raw CD digital audio.
94 .PP
95 \&\fB.f4\fR, \fB.f8\fR,
96 \&\fB.s1\fR, \fB.s2\fR, \fB.s3\fR, \fB.s4\fR,
97 .br
98 \&\fB.u1\fR, \fB.u2\fR, \fB.u3\fR, \fB.u4\fR,
99 \&\fB.sb\fR, \fB.sw\fR, \fB.sl\fR, \fB.ub\fR, \fB.uw\fR
100 .if t .sp -.5
101 .if n .sp -1
104 Deprecated aliases for
105 \fBf32\fR, \fBf64\fR, \fBs8\fR, \fBs16\fR, \fBs24\fR, \fBs32\fR,
107 \fBu8\fR, \fBu16\fR, \fBu24\fR, \fBu32\fR,
108 \fBs8\fR, \fBs16\fR, \fBs32\fR, \fBu8\fR, and \fBu16\fR
109 respectively.
111 \&\fB.8svx\fR (also with \fB\-t sndfile\fR)
112 Amiga 8SVX musical instrument description format.
114 \&\fB.aiff\fR, \fB.aif\fR (also with \fB\-t sndfile\fR)
115 AIFF files as used on old Apple Macs, Apple IIc/IIgs and SGI.
116 SoX's AIFF support does not include multiple audio chunks,
117 or the 8SVX musical instrument description format.
118 AIFF files are multimedia archives and
119 can have multiple audio and picture chunks\*m
120 you may need a separate archiver to work with them.
121 With Mac OS X, AIFF has been superseded by CAF.
123 \&\fB.aiffc\fR, \fB.aifc\fR (also with \fB\-t sndfile\fR)
124 AIFF-C is a format based on AIFF that was created to allow
125 handling compressed audio.  It can also handle little
126 endian uncompressed linear data that is often referred to
128 .B sowt 
129 encoding.  This encoding has also become the defacto format produced by modern 
130 Macs as well as iTunes on any platform.  AIFF-C files produced 
131 by other applications typically have the file extension .aif and
132 require looking at its header to detect the true format.
133 The 
134 .B sowt
135 encoding is the only encoding that SoX can handle with this format.
137 AIFF-C is defined in DAVIC 1.4 Part 9 Annex B.
138 This format is referred from ARIB STD-B24, which is specified for
139 Japanese data broadcasting.  Any private chunks are not supported.
141 \fBalsa\fR (optional)
142 Advanced Linux Sound Architecture device driver; supports both playing and
143 recording audio.  ALSA is only used in Linux-based operating systems, though
144 these often support OSS (see below) as well.  Examples:
146         sox infile \-t alsa
147         sox infile \-t alsa default
148         sox infile \-t alsa plughw:0,0
149         sox \-b 16 \-t alsa hw:1 outfile
151 See also
152 .BR play (1),
153 .BR rec (1),
155 .BR sox (1)
156 .BR \-d .
158 .B .amb
159 Ambisonic B-Format: a specialisation of
160 .B .wav
161 with between 3 and 16 channels of audio for use with an Ambisonic decoder.
162 See http://www.ambisonia.com/Members/mleese/file-format-for-b-format for
163 details.  It is up to the user to get the channels together in the right
164 order and at the correct amplitude.
166 \&\fB.amr\-nb\fR (optional)
167 Adaptive Multi Rate\*mNarrow Band speech codec; a lossy format used in 3rd
168 generation mobile telephony and defined in 3GPP TS 26.071 et al.
170 AMR-NB audio has a fixed sampling rate of 8 kHz and supports encoding
171 to the following bit-rates (as selected by the
172 .B \-C
173 option): 0 = 4\*d75 kbit/s, 1 = 5\*d15 kbit/s, 2 = 5\*d9 kbit/s, 3 =
174 6\*d7 kbit/s, 4 = 7\*d4 kbit/s 5 = 7\*d95 kbit/s, 6 = 10\*d2
175 kbit/s, 7 = 12\*d2 kbit/s.
177 \&\fB.amr\-wb\fR (optional)
178 Adaptive Multi Rate\*mWide Band speech codec; a lossy format used in 3rd
179 generation mobile telephony and defined in 3GPP TS 26.171 et al.
181 AMR-WB audio has a fixed sampling rate of 16 kHz and supports encoding
182 to the following bit-rates (as selected by the
183 .B \-C
184 option): 0 = 6\*d6 kbit/s, 1 = 8\*d85 kbit/s, 2 = 12\*d65 kbit/s, 3 =
185 14\*d25 kbit/s, 4 = 15\*d85 kbit/s 5 = 18\*d25 kbit/s, 6 = 19\*d85
186 kbit/s, 7 = 23\*d05 kbit/s, 8 = 23\*d85 kbit/s.
188 \fBao\fR (optional)
189 Xiph.org's Audio Output device driver; works only for playing audio.  It
190 supports a wide range of devices and sound systems\*msee its documentation
191 for the full range.  For the most part, SoX's use of libao cannot be
192 configured directly; instead, libao configuration files must be used.
194 The filename specified is used to determine which libao plugin to
195 use.  Normally, you should specify `default' as the filename.  If that
196 doesn't give the desired behavior then you can specify the short name
197 for a given plugin (such as \fBpulse\fR for pulse audio plugin).
198 Examples:
200         sox infile \-t ao
201         sox infile \-t ao default
202         sox infile \-t ao pulse
204 See also
205 .BR play (1)
207 .BR sox (1)
208 .BR \-d .
210 \&\fB.au\fR, \fB.snd\fR (also with \fB\-t sndfile\fR)
211 Sun Microsystems AU files.
212 There are many types of AU file;
213 DEC has invented its own with a different magic number
214 and byte order.  To write a DEC file, use the
215 .B \-L
216 option with the output file options.
218 Some .au files are known to have invalid AU headers; these
219 are probably original Sun \(*m-law 8000\ Hz files and
220 can be dealt with using the
221 .B .ul
222 format (see below).
224 It is possible to override AU file header information
225 with the
226 .B \-r
228 .B \-c
229 options, in which case SoX will issue a warning to that effect.
231 .B .avr
232 Audio Visual Research format;
233 used by a number of commercial packages
234 on the Mac.
236 \&\fB.caf\fR (optional)
237 Apple's Core Audio File format.
239 \&\fB.cdda\fR, \fB.cdr\fR
240 `Red Book' Compact Disc Digital Audio (raw audio).  CDDA has two audio
241 channels formatted as 16-bit signed integers (big endian)at a sample
242 rate of 44\*d1\ kHz.  The number of (stereo) samples in each CDDA
243 track is always a multiple of 588.
245 \fBcoreaudio\fR (optional)
246 Mac OSX CoreAudio device driver: supports both playing and recording
247 audio.  If a filename is not specific or if the name is "default" then
248 the default audio device is selected.  Any other name will be used
249 to select a specific device.  The valid names can be seen in the
250 System Preferences->Sound menu and then under the Output and Input tabs.
252 Examples:
254         sox infile \-t coreaudio
255         sox infile \-t coreaudio default
256         sox infile \-t coreaudio "Internal Speakers"
258 See also
259 .BR play (1),
260 .BR rec (1),
262 .BR sox (1)
263 .BR \-d .
265 \&\fB.cvsd\fR, \fB.cvs\fR
266 Continuously Variable Slope Delta modulation.
267 A headerless format used to compress speech audio for applications such as voice mail.
268 This format is sometimes used with bit-reversed samples\*mthe
269 .B \-X
270 format option can be used to set the bit-order.
272 \&\fB.cvu\fR
273 Continuously Variable Slope Delta modulation (unfiltered).
274 This is an alternative handler for CVSD that is unfiltered but can
275 be used with any bit-rate.  E.g.
277         sox infile outfile.cvu rate 28k
278         play \-r 28k outfile.cvu sinc \-3.4k
281 .B .dat
282 Text Data files.
283 These files contain a textual representation of the
284 sample data.  There is one line at the beginning
285 that contains the sample rate, and one line that
286 contains the number of channels.
287 Subsequent lines contain two or more numeric data intems:
288 the time since the beginning of the first sample and the sample value
289 for each channel.
291 Values are normalized so that the maximum and minimum
292 are 1 and \-1.  This file format can be used to
293 create data files for external programs such as
294 FFT analysers or graph routines.  SoX can also convert
295 a file in this format back into one of the other file
296 formats.
298 Example containing only 2 stereo samples of silence:
301     ; Sample Rate 8012
302     ; Channels 2
303                 0       0       0
304     0.00012481278       0       0
307 \&\fB.dvms\fR, \fB.vms\fR
308 Used in Germany to compress speech audio for voice mail.
309 A self-describing variant of
310 .BR cvsd .
312 \&\fB.fap\fR (optional)
314 .BR .paf .
316 \&\fB.flac\fR (optional; also with \fB\-t sndfile\fR)
317 Xiph.org's Free Lossless Audio CODEC compressed audio.
318 FLAC is an open, patent-free CODEC designed for compressing
319 music.  It is similar to MP3 and Ogg Vorbis, but lossless,
320 meaning that audio is compressed in FLAC without any loss in
321 quality.
323 SoX can read native FLAC files (.flac) but not Ogg FLAC files (.ogg).
324 [But see
325 .B .ogg
326 below for information relating to support for Ogg
327 Vorbis files.]
329 SoX can write native FLAC files according to a given or default
330 compression level.  8 is the default compression level and gives the
331 best (but slowest) compression; 0 gives the least (but fastest)
332 compression.  The compression level is selected using the
333 .B \-C
334 option [see
335 .BR sox (1)]
336 with a whole number from 0 to 8.
338 .B .fssd
339 An alias for the
340 .B .u8
341 format.
343 .B .gsrt
344 Grandstream ring-tone files.
345 Whilst this file format can contain A-Law, \(*m-law, GSM, G.722,
346 G.723, G.726, G.728, or iLBC encoded audio, SoX supports reading and
347 writing only A-Law and \(*m-law.  E.g.
349    sox music.wav \-t gsrt ring.bin
350    play ring.bin
353 \&\fB.gsm\fR (optional; also with \fB\-t sndfile\fR)
354 GSM 06.10 Lossy Speech Compression.
355 A lossy format for compressing speech which is used in the
356 Global Standard for Mobile telecommunications (GSM).  It's good
357 for its purpose, shrinking audio data size, but it will introduce
358 lots of noise when a given audio signal is encoded and decoded
359 multiple times.  This format is used by some voice mail applications.
360 It is rather CPU intensive.
362 .B .hcom
363 Macintosh HCOM files.
364 These are Mac FSSD files with Huffman compression.
366 .B .htk
367 Single channel 16-bit PCM format used by HTK,
368 a toolkit for building Hidden Markov Model speech processing tools.
370 \&\fB.ircam\fR (also with \fB\-t sndfile\fR)
371 Another name for
372 .BR .sf .
374 \&\fB.ima\fR (also with \fB\-t sndfile\fR)
375 A headerless file of IMA ADPCM audio data. IMA ADPCM claims 16-bit precision
376 packed into only 4 bits, but in fact sounds no better than
377 .BR .vox .
379 \&\fB.lpc\fR, \fB.lpc10\fR
380 LPC-10 is a compression scheme for speech developed in the United
381 States. See https://web.archive.org/web/20090226065646/https://www.arl.wustl.edu/~jaf/lpc/ for details. There is
382 no associated file format, so SoX's implementation is headerless.
384 \&\fB.mat\fR, \fB.mat4\fR, \fB.mat5\fR (optional)
385 Matlab 4.2/5.0 (respectively GNU Octave 2.0/2.1) format (.mat is the same as .mat4).
387 .B .m3u
389 .I playlist
390 format; contains a list of audio files.
391 SoX can read, but not write this file format.
392 See [1] for details of this format.
394 .B .maud
395 An IFF-conforming audio file type, registered by
396 MS MacroSystem Computer GmbH, published along
397 with the `Toccata' sound-card on the Amiga.
398 Allows 8bit linear, 16bit linear, A-Law, \(*m-law
399 in mono and stereo.
401 \&\fB.mp3\fR, \fB.mp2\fR (optional read, optional write)
402 MP3 compressed audio; MP3 (MPEG Layer 3) is a part of the patent-encumbered
403 MPEG standards for audio and video compression.  It is a lossy
404 compression format that achieves good compression rates with little
405 quality loss.
407 Because MP3 is patented, SoX cannot be distributed with MP3 support without
408 incurring the patent holder's fees.  Users who require SoX with MP3 support
409 must currently compile and build SoX with the MP3 libraries (LAME & MAD)
410 from source code, or, in some cases, obtain pre-built dynamically loadable
411 libraries.
413 When reading MP3 files, up to 28 bits of precision is stored although
414 only 16 bits is reported to user.  This is to allow default behavior
415 of writing 16 bit output files.  A user can specify a higher precision
416 for the output file to prevent lossing this extra information.  MP3
417 output files will use up to 24 bits of precision while encoding.
419 MP3 compression parameters can be selected using SoX's \fB\-C\fR option
420 as follows
421 (note that the current syntax is subject to change):
423 The primary parameter to the LAME encoder is the bit rate. If the
424 value of the \fB\-C\fR value is a positive integer, it's taken as
425 the bitrate in kbps (e.g. if you specify 128, it uses 128 kbps).
427 The second most important parameter is probably "quality" (really
428 performance), which allows balancing encoding speed vs. quality.
429 In LAME, 0 specifies highest quality but is very slow, while
430 9 selects poor quality, but is fast. (5 is the default and 2 is
431 recommended as a good trade-off for high quality encodes.)
433 Because the \fB\-C\fR value is a float, the fractional part is used
434 to select quality. 128.2 selects 128 kbps encoding with a quality
435 of 2. There is one problem with this approach. We need 128 to specify
436 128 kbps encoding with default quality, so 0 means use default. Instead
437 of 0 you have to use .01 (or .99) to specify the highest quality
438 (128.01 or 128.99).
440 LAME uses bitrate to specify a constant bitrate, but higher quality
441 can be achieved using Variable Bit Rate (VBR). VBR quality (really
442 size) is selected using a number from 0 to 9. Use a value of 0 for high
443 quality, larger files, and 9 for smaller files of lower quality. 4 is
444 the default.
446 In order to squeeze the selection of VBR into the the \fB\-C\fR value
447 float we use negative numbers to select VRR. -4.2 would select default
448 VBR encoding (size) with high quality (speed). One special case is 0,
449 which is a valid VBR encoding parameter but not a valid bitrate.
450 Compression value of 0 is always treated as a high quality vbr, as a
451 result both -0.2 and 0.2 are treated as highest quality VBR (size) and
452 high quality (speed).
454 See also
455 .B Ogg Vorbis
456 for a similar format.
458 \&\fB.nist\fR (also with \fB\-t sndfile\fR)
459 See \fB.sph\fR.
461 \&\fB.ogg\fR, \fB.vorbis\fR (optional)
462 Xiph.org's Ogg Vorbis compressed audio; an open, patent-free CODEC designed
463 for music and streaming audio.  It is a lossy compression format (similar to
464 MP3, VQF & AAC) that achieves good compression rates with a minimum amount
465 of quality loss.
467 SoX can decode all types of Ogg Vorbis files, and can encode at different
468 compression levels/qualities given as a number from \-1 (highest
469 compression/lowest quality) to 10 (lowest compression, highest quality).
470 By default the encoding quality level is 3 (which gives an encoded rate
471 of approx. 112kbps), but this can be changed using the
472 .B \-C
473 option (see above) with a number from \-1 to 10; fractional numbers (e.g.
474 3\*d6) are also allowed.
475 Decoding is somewhat CPU intensive and encoding is very CPU intensive.
477 See also
478 .B .mp3
479 for a similar format.
481 \&\fB.opus\fR (optional)
482 Xiph.org's Opus compressed audio; an open, lossy, low-latency codec
483 offering a wide range of compression rates. It uses the Ogg container.
485 SoX can only read Opus files, not write them.
487 \fBoss\fR (optional)
488 Open Sound System /dev/dsp device driver; supports both playing and
489 recording audio.  OSS support is available in Unix-like operating systems,
490 sometimes together with alternative sound systems (such as ALSA).  Examples:
492         sox infile \-t oss
493         sox infile \-t oss /dev/dsp
494         sox \-b 16 \-t oss /dev/dsp outfile
496 See also
497 .BR play (1),
498 .BR rec (1),
500 .BR sox (1)
501 .BR \-d .
503 \&\fB.paf\fR, \fB.fap\fR (optional)
504 Ensoniq PARIS file format (big and little-endian respectively).
506 .B .pls
508 .I playlist
509 format; contains a list of audio files.
510 SoX can read, but not write this file format.
511 See [2] for details of this format.
513 Note: SoX support for SHOUTcast PLS relies on
514 .BR wget (1)
515 and is only partially supported: it's necessary to
516 specify the audio type manually, e.g.
518         play \-t mp3 \(dqhttp://a.server/pls?rn=265&file=filename.pls\(dq
520 and SoX does not know about alternative servers\*mhit Ctrl-C twice in
521 quick succession to quit.
523 .B .prc
524 Psion Record. Used in Psion EPOC PDAs (Series 5, Revo and similar) for
525 System alarms and recordings made by the built-in Record application.
526 When writing, SoX defaults to A-law, which is recommended; if you must
527 use ADPCM, then use the \fB\-e ima-adpcm\fR switch. The sound quality is poor
528 because Psion Record seems to insist on frames of 800 samples or
529 fewer, so that the ADPCM CODEC has to be reset at every 800 frames,
530 which causes the sound to glitch every tenth of a second.
532 \fBpulseaudio\fR (optional)
533 PulseAudio driver; supports both playing and recording of audio.
534 PulseAudio is a cross platform networked sound server.  
535 If a file name is specified with this driver, it is ignored.  Examples:
537         sox infile \-t pulseaudio
538         sox infile \-t pulseaudio default
540 See also
541 .BR play (1),
542 .BR rec (1),
544 .BR sox (1)
545 .BR \-d .
547 \&\fB.pvf\fR (optional)
548 Portable Voice Format.
550 \&\fB.sd2\fR (optional)
551 Sound Designer 2 format.
553 \&\fB.sds\fR (optional)
554 MIDI Sample Dump Standard.
556 \&\fB.sf\fR (also with \fB\-t sndfile\fR)
557 IRCAM SDIF (Institut de Recherche et Coordination Acoustique/Musique
558 Sound Description Interchange Format). Used by academic music software
559 such as the CSound package, and the MixView sound sample editor.
561 \&\fB.sln\fR
562 Asterisk PBX `signed linear' 8khz, 16-bit signed integer, little-endian
563 raw format.
565 \&\fB.sph\fR, \fB.nist\fR (also with \fB\-t sndfile\fR)
566 SPHERE (SPeech HEader Resources) is a file format defined by NIST
567 (National Institute of Standards and Technology) and is used with
568 speech audio.  SoX can read these files when they contain
569 \(*m-law and PCM data.  It will ignore any header information that
570 says the data is compressed using \fIshorten\fR compression and
571 will treat the data as either \(*m-law or PCM.  This will allow SoX
572 and the command line \fIshorten\fR program to be run together using
573 pipes to encompasses the data and then pass the result to SoX for processing.
575 .B .smp
576 Turtle Beach SampleVision files.
577 SMP files are for use with the PC-DOS package SampleVision by Turtle Beach
578 Softworks.  This package is for communication to several MIDI samplers.  All
579 sample rates are supported by the package, although not all are supported by
580 the samplers themselves.  Currently loop points are ignored.
582 .B .snd
584 .BR .au ,
585 .B .sndr
587 .BR .sndt .
589 \fBsndfile\fR (optional)
590 This is a pseudo-type that forces libsndfile to be used. For writing files, the
591 actual file type is then taken from the output file name; for reading
592 them, it is deduced from the file.
594 \fBsndio\fR (optional)
595 OpenBSD audio device driver; supports both playing and recording audio.
597         sox infile \-t sndio
599 See also
600 .BR play (1),
601 .BR rec (1),
603 .BR sox (1)
604 .BR \-d .
606 .B .sndr
607 Sounder files.
608 An MS-DOS/Windows format from the early '90s.
609 Sounder files usually have the extension `.SND'.
611 .B .sndt
612 SoundTool files.
613 An MS-DOS/Windows format from the early '90s.
614 SoundTool files usually have the extension `.SND'.
616 .B .sou
617 An alias for the
618 .B .u8
619 raw format.
621 .B .sox
622 SoX's native uncompressed PCM format, intended for storing (or piping)
623 audio at intermediate processing points (i.e. between SoX invocations).
624 It has much in common with the popular WAV, AIFF, and AU uncompressed PCM
625 formats, but has the following specific characteristics: the PCM samples
626 are always stored as 32 bit signed integers, the samples are stored (by
627 default) as `native endian', and the number of samples in the file is
628 recorded as a 64-bit integer.  Comments are also supported.
630 See `Special Filenames' in
631 .BR sox (1)
632 for examples of using the
633 .B .sox
634 format with `pipes'.
636 \fBsunau\fR (optional)
637 Sun /dev/audio device driver; supports both playing and
638 recording audio.  For example:
640         sox infile \-t sunau /dev/audio
644         sox infile \-t sunau \-e mu-law \-c 1 /dev/audio
646 for older sun equipment.
648 See also
649 .BR play (1),
650 .BR rec (1),
652 .BR sox (1)
653 .BR \-d .
655 .B .txw
656 Yamaha TX-16W sampler.
657 A file format from a Yamaha sampling keyboard which wrote IBM-PC
658 format 3\*d5\(dq floppies.  Handles reading of files which do not have
659 the sample rate field set to one of the expected by looking at some
660 other bytes in the attack/loop length fields, and defaulting to
661 33\ kHz if the sample rate is still unknown.
663 .B .vms
665 .BR .dvms .
667 \&\fB.voc\fR (also with \fB\-t sndfile\fR)
668 Sound Blaster VOC files.
669 VOC files are multi-part and contain silence parts, looping, and
670 different sample rates for different chunks.
671 On input, the silence parts are filled out, loops are rejected,
672 and sample data with a new sample rate is rejected.
673 Silence with a different sample rate is generated appropriately.
674 On output, silence is not detected, nor are impossible sample rates.
675 SoX supports reading (but not writing) VOC files with multiple
676 blocks, and files containing \(*m-law, A-law, and 2/3/4-bit ADPCM samples.
678 .B .vorbis
680 .BR .ogg .
682 \&\fB.vox\fR (also with \fB\-t sndfile\fR)
683 A headerless file of Dialogic/OKI ADPCM audio data commonly comes with the
684 extension .vox.  This ADPCM data has 12-bit precision packed into only 4-bits.
686 Note: some early Dialogic hardware does not always reset the ADPCM
687 encoder at the start of each vox file.  This can result in clipping
688 and/or DC offset problems when it comes to decoding the audio.  Whilst
689 little can be done about the clipping, a DC offset can be removed by
690 passing the decoded audio through a high-pass filter, e.g.:
692         sox input.vox output.wav highpass 10
695 \&\fB.w64\fR (optional)
696 Sonic Foundry's 64-bit RIFF/WAV format.
698 \&\fB.wav\fR (also with \fB\-t sndfile\fR)
699 Microsoft .WAV RIFF files.
700 This is the native audio file format of Windows, and widely used for uncompressed audio.
702 Normally \fB.wav\fR files have all formatting information
703 in their headers, and so do not need any format options
704 specified for an input file.  If any are, they will
705 override the file header, and you will be warned to this effect.
706 You had better know what you are doing! Output format
707 options will cause a format conversion, and the \fB.wav\fR
708 will written appropriately.
710 SoX can read and write linear PCM, floating point, \(*m-law, A-law, MS ADPCM, and IMA (or DVI) ADPCM encoded samples.
711 WAV files can also contain audio encoded in many other ways (not currently
712 supported with SoX) e.g. MP3; in some cases such a file can still be
713 read by SoX by overriding the file type, e.g.
715    play \-t mp3 mp3\-encoded.wav
717 Big endian versions of RIFF files, called RIFX, are also supported.
718 To write a RIFX file, use the
719 .B \-B
720 option with the output file options.
722 \fBwaveaudio\fR (optional)
723 MS-Windows native audio device driver.  Examples:
725         sox infile \-t waveaudio
726         sox infile \-t waveaudio default
727         sox infile \-t waveaudio 1
728         sox infile \-t waveaudio "High Definition Audio Device ("
730 If the device name is omitted, \fB-1\fR, or \fBdefault\fR, then you
731 get the `Microsoft Wave Mapper' device.  Wave Mapper means `use the
732 system default audio devices'.  You can control what `default' means
733 via the OS Control Panel.
735 If the device name given is some other number, you get that audio
736 device by index; so recording with device name \fB0\fR would get the
737 first input device (perhaps the microphone), \fB1\fR would get the
738 second (perhaps line in), etc.  Playback using \fB0\fR will get the
739 first output device (usually the only audio device).
741 If the device name given is something other than a number, SoX tries
742 to match it (maximum 31 characters) against the names of the available
743 devices.
745 See also
746 .BR play (1),
747 .BR rec (1),
749 .BR sox (1)
750 .BR \-d .
752 .B .wavpcm
753 A non-standard, but widely used, variant of
754 .BR .wav .
755 Some applications cannot read a standard WAV file header for PCM-encoded
756 data with sample-size greater than 16-bits or with more than two
757 channels, but can read a non-standard
758 WAV header.  It is likely that such applications will eventually be
759 updated to support the standard header, but in the mean time, this SoX
760 format can be used to create files with the non-standard header that
761 should work with these applications.  (Note that SoX will automatically
762 detect and read WAV files with the non-standard header.)
764 The most common use of this file-type is likely to be along the following
765 lines:
767         sox infile.any \-t wavpcm \-e signed-integer outfile.wav
770 \&\fB.wv\fR (optional)
771 WavPack lossless audio compression.  Note that, when converting
772 .B .wav
773 to this format and back again,
774 the RIFF header is not necessarily preserved losslessly (though the audio is).
776 \&\fB.wve\fR (also with \fB\-t sndfile\fR)
777 Psion 8-bit A-law.  Used on Psion SIBO PDAs (Series 3 and similar).
778 This format is deprecated in SoX, but will continue to be used in
779 libsndfile.
781 .B .xa
782 Maxis XA files.
783 These are 16-bit ADPCM audio files used by Maxis games.  Writing .xa files is
784 currently not supported, although adding write support should not be very
785 difficult.
787 \&\fB.xi\fR (optional)
788 Fasttracker 2 Extended Instrument format.
789 .SH SEE ALSO
790 .BR sox (1),
791 .BR soxi (1),
792 .BR libsox (3),
793 .BR octave (1),
794 .BR wget (1)
796 The SoX web page at http://sox.sourceforge.net
798 SoX scripting examples at http://sox.sourceforge.net/Docs/Scripts
799 .SS References
802 Wikipedia,
803 .IR "M3U" ,
804 http://en.wikipedia.org/wiki/M3U
807 Wikipedia,
808 .IR "PLS" ,
809 http://en.wikipedia.org/wiki/PLS_(file_format)
810 .SH LICENSE
811 Copyright 1998\-2013 Chris Bagwell and SoX Contributors.
813 Copyright 1991 Lance Norskog and Sundry Contributors.
814 .SH AUTHORS
815 Chris Bagwell (cbagwell@users.sourceforge.net).
816 Other authors and contributors are listed in the ChangeLog file that
817 is distributed with the source code.