home *** CD-ROM | disk | FTP | other *** search
/ Computer Club Elmshorn Atari PD / CCE_PD.iso / pc / 0400 / CCE_0442.ZIP / CCE_0442.PD / SOX / SOX.DOC < prev    next >
Text File  |  1992-09-10  |  12KB  |  295 lines
  1. SOX 1
  2.  
  3. NAME
  4.     sox - SOund eXchange - universal sound sample translator
  5.  
  6. SYNOPSIS
  7.     sox infile outfile
  8.  
  9.     sox infile outfile [ effect [ effect options ... ] ]
  10.  
  11.     sox infile -e effect [ effect options ... ]
  12.  
  13.     sox [ general options ] 
  14.         [ format options ] ifile 
  15.         [ format options  ] ofile
  16.         [ effect [ effect options ...] ]
  17.  
  18.     General options:
  19.         [ -V ]
  20.         [ -v volume ]
  21.  
  22.     Format options:
  23.         [ -t filetype ]
  24.         [ -r rate ]
  25.         [ -s/-u/-U/-A ]
  26.         [ -b/-w/-l/-f/-d/-D ]
  27.         [ -c channels ]
  28.         [ -x ]
  29.  
  30.     Effects:
  31.         copy 
  32.         rate 
  33.         avg 
  34.         stat 
  35.         echo delay volume [ delay volume ... ]
  36.         vibro speed [ depth ]
  37.         lowp center
  38.         band [ -n ] center [ width ]
  39.     
  40. DESCRIPTION
  41.     Sox translates sound files from one format to another,
  42.     possibly doing a sound effect.
  43.  
  44. OPTIONS
  45.     The option syntax is a little grotty, but in essence:
  46.  
  47.     sox file.au file.voc 
  48.  
  49.     translates a sound sample in SUN Sparc .AU format 
  50.     into a SoundBlaster .VOC file, while
  51.  
  52.     sox -v 0.5 file.au -rate 12000 file.voc rate
  53.  
  54.     does the same format translation but also 
  55.     lowers the amplitude by 1/2 and changes
  56.     the sampling rate from 8000 hertz to 12000 hertz via
  57.     the rate sound effect loop.
  58.  
  59.     File type options:
  60.  
  61.     -t filetype       Gives the type of the sound sample file.
  62.     
  63.     -r rate           Give sample rate in Hertz of file.
  64.     
  65.     -s/-u/-U/-A       The sample data is signed linear (2's complement),
  66.                       unsigned linear, U-law (logarithmic), or A-law 
  67.                       (logarithmic). U-law and A-law are the U.S. and 
  68.                       international standards for logarithmic telephone
  69.                       sound compression.
  70.                       
  71.     -b/-w/-l/-f/-d/-D The sample data is in bytes, 16-bit words, 32-bit  
  72.                       longwords, 32-bit floats, 64-bit double floats, or
  73.                       80-bit IEEE floats.
  74.                       Floats and double floats are in native machine format.
  75.  
  76.     -x                The sample data is in XINU format; that is,
  77.                       it comes from a machine with the opposite word order 
  78.                       than yours and must be swapped according to the 
  79.                       word-size given above. Only 16-bit and 32-bit integer
  80.                       data may be swapped.
  81.                       Machine-format floating-point data is not portable.
  82.                       IEEE floats are a fixed, portable format. ???
  83.  
  84.     -c channels       The number of sound channels in the data file.
  85.                       This may be 1, 2, or 4; for mono, stereo, or quad 
  86.                       sound data.
  87.  
  88.     General options:
  89.  
  90.     -e                after the input file allows you to avoid giving
  91.                       an output file and just name an effect.
  92.                       This is only useful with the stat effect.
  93.                       
  94.     -v volume         Change amplitude (floating point); 
  95.                       less than 1.0 decreases, greater than 1.0 increases.
  96.                       Note: we perceive volume logarithmically, not linearly.
  97.                       Note: see the stat effect.
  98.  
  99.     -V                Print a description of processing phases.
  100.                       Useful for figuring out exactly how sox
  101.                       is mangling your sound samples.
  102.  
  103.     The input and output files may be standard input and output.
  104.     This is specified by '-'.  The -t type option must be given in this 
  105.     case, else sox will not know the format of the given file.
  106.     
  107.     The -t, -r, -s/-u/-U/-A, -b/-w/-l/-f/-d/-D and -x 
  108.     options refer to the input data when given before the
  109.     input file name.  After, they refer to the output data.
  110.  
  111.     If you don't give an output file name, sox will just read the input file.
  112.     This is useful for validating structured file formats; the stat 
  113.     effect may also be used via the -e option.
  114.  
  115. FILE TYPES
  116.     Sox needs to know the formats of the input and output files.
  117.     File formats which have headers are checked, 
  118.     if that header doesn't seem right,
  119.     the program exits with an appropriate message.
  120.     Currently, the raw (no header), IRCAM Sound Files,
  121.     Sound Blaster, SPARC .AU (w/header), Mac HCOM,
  122.     PC/DOS .SOU, Sndtool, and Sounder, NeXT .SND,
  123.     Windows 3.1 RIFF/WAV, and Amiga/SGI AIFF and 8SVX
  124.     formats are supported.
  125.  
  126.     .aiff    AIFF files used on Amiga and SGI.
  127.  
  128.         Note: the AIFF format supports only one SSND chunk.
  129.         It does not support multiple sound chunks, 
  130.         or the 8SVX musical instrument description format.
  131.         AIFF files are multimedia archives and
  132.         and can have multiple audio and picture chunks.
  133.         You may need a separate archiver to work with them.
  134.  
  135.     .au      SUN Microsystems AU files.
  136.  
  137.         There are apparently many types of .au files;
  138.         DEC has invented its own with a different magic number
  139.         and word order.  
  140.         The .au handler can read these files but will not write them.
  141.         Some .au files have valid AU headers and some do not.
  142.         The latter are probably original SUN u-law 8000 hz samples.
  143.         These can be dealt with using the .ul format (see below).
  144.  
  145.  
  146.     .hcom    Macintosh HCOM files.
  147.  
  148.         These are (apparently) Mac FSSD files with some variant
  149.         of Huffman compression.
  150.         The Macintosh has wacky file formats and this format
  151.         handler apparently doesn't handle all the ones it should.
  152.         Mac users will need your usual arsenal of file converters
  153.         to deal with an HCOM file under Unix or DOS.
  154.  
  155.     .raw     Raw files (no header).
  156.  
  157.         The sample rate, size (byte, word, etc), 
  158.         and style (signed, unsigned, etc.)
  159.         of the sample file must be given.
  160.         The number of channels defaults to 1.
  161.  
  162.     ".ub, .sb, .uw, .sw, .ul"
  163.  
  164.         These are several suffices which serve as
  165.         a shorthand for raw files with a given size and style.
  166.         Thus, ub, sb, uw, sw and ul
  167.         correspond to "unsigned byte", "signed byte",
  168.         "unsigned word", "signed word", and "ulaw" (byte).
  169.         The sample rate defaults to 8000 hz if not explicitly set,
  170.         and the number of channels (as always) defaults to 1.
  171.         There are lots of Sparc samples floating around in u-law format
  172.         with no header and fixed at a sample rate of 8000 hz.
  173.         (Certain sound management software cheerfully ignores the headers.)
  174.         Similarly, most Mac sound files are in unsigned byte format with
  175.         a sample rate of 11025 or 22050 hz.
  176.  
  177.     .sf      IRCAM Sound Files.
  178.  
  179.         SoundFiles are used by academic music software 
  180.         such as the CSound package, and the MixView sound sample editor.
  181.  
  182.     .voc     Sound Blaster VOC files.
  183.  
  184.         VOC files are multi-part and contain silence parts, looping, and
  185.         different sample rates for different chunks.
  186.         On input, the silence parts are filled out, loops are rejected,
  187.         and sample data with a new sample rate is rejected.
  188.         Silence with a different sample rate is generated appropriately.
  189.         On output, silence is not detected, nor are impossible sample rates.
  190.  
  191.     .wav     Windows 3.1 .WAV RIFF files.
  192.  
  193.         These appear to be very similar to IFF files,
  194.         but not the same.  
  195.         They are the native sound file format of Windows 3.1.
  196.         Obviously, Windows 3.1 is of such incredible importance
  197.         to the computer industry that it just had to have its own 
  198.         sound file format.
  199. EFFECTS
  200.     Only one effect from the palette may be applied to a sound sample.
  201.     To do multiple effects you'll need to run sox in a pipeline.
  202.  
  203.     copy
  204.         Copy the input file to the output file.
  205.         This is the default effect if both files have the same 
  206.         sampling rate, or the rates are "close".
  207.  
  208.     rate
  209.         Translate input sampling rate to output sampling rate
  210.         via linear interpolation to the Least Common Multiple
  211.         of the two sampling rates.
  212.         This is the default effect if the two files have different 
  213.         sampling rates. This is fast but noisy.
  214.  
  215.     avg
  216.         Mix 4- or 2-channel sound file into 2- or 1-channel file
  217.         by averaging the samples for different speakers.
  218.         
  219.     stat
  220.         Do a statistical check on the input file,
  221.         and print results on the standard error file.
  222.         stat may copy the file untouched from input to output,
  223.         if you select an output file.  
  224.         The "Volume Adjustment:" field in the statistics
  225.         gives you the argument to the -v number
  226.         which will make the sample as loud as possible.
  227.  
  228.     echo [ delay volume ... ]
  229.         Add echoing to a sound sample.
  230.         Each delay/volume pair gives the delay in seconds
  231.         and the volume (relative to 1.0) of that echo.
  232.         If the volumes add up to more than 1.0,
  233.         the sound will melt down instead of fading away.
  234.  
  235.     vibro speed [ depth ]
  236.         Add the world-famous Fender Vibro-Champ sound
  237.         effect to a sound sample by using
  238.         a sine wave as the volume knob.
  239.         Speed gives the Hertz value of the wave.
  240.         This must be under 30.
  241.         Depth gives the amount the volume is cut into
  242.         by the sine wave, ranging 0.0 to 1.0 and defaulting 
  243.         to 0.5.
  244.  
  245.     lowp center
  246.         Apply a low-pass filter.
  247.         The frequency response drops logarithmically with 
  248.         center frequency in the middle of the drop.
  249.         The slope of the filter is quite gentle.
  250.  
  251.     band [ -n ] center [ width ]
  252.         Apply a band-pass filter.
  253.         The frequency response drops logarithmically
  254.         around the center frequency.
  255.         The width gives the slope of the drop.
  256.         The frequencies at "center + width" and
  257.         "center - width" will be half of their original 
  258.         amplitudes.
  259.         Band defaults to a mode oriented to pitched signals,
  260.         i.e. voice, singing, or instrumental music.
  261.         The -n (for noise) option uses the alternate mode
  262.         for un-pitched signals.
  263.         Band introduces noise in the shape of the filter,
  264.         i.e. peaking at the center frequency and settling 
  265.         around it.
  266.  
  267.     Sox enforces certain effects. If the two files have different 
  268.     sampling rates, the requested effect must be one of copy,
  269.     or rate.
  270.     If the two files have different numbers of channels,
  271.     the avg effect must be requested.
  272.  
  273. BUGS
  274.     The syntax is horrific.
  275.     It's very tempting to include a default system that allows
  276.     an effect name as the program name
  277.     and just pipes a sound sample from standard input 
  278.     to standard output, but the problem of inputting the
  279.     sample rates makes this unworkable.
  280.     
  281. FILES
  282.  
  283. SEE ALSO
  284.  
  285. NOTICES
  286.     The echoplex effect is:
  287.     Copyright (C) 1989 by Jef Poskanzer.
  288.     
  289.     Permission to use, copy, modify, and distribute this software and its
  290.     documentation for any purpose and without fee is hereby granted, provided
  291.     that the above copyright notice appear in all copies and that both that
  292.     copyright notice and this permission notice appear in supporting
  293.     documentation.  This software is provided "as is" without express or
  294.     implied warranty.
  295.