home *** CD-ROM | disk | FTP | other *** search
/ Da Capo / da_capo_vol1.bin / programs / amiga / edit / amisox3.3 / doc / sox.doc < prev    next >
Text File  |  1994-02-20  |  19KB  |  463 lines
  1.  
  2.  
  3.  
  4. SOX(1)                   USER COMMANDS                     SOX(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      sox - SOund eXchange - universal sound sample translator
  10.  
  11. SYNOPSIS
  12.      sox _i_n_f_i_l_e _o_u_t_f_i_l_e
  13.      sox _i_n_f_i_l_e _o_u_t_f_i_l_e [ _e_f_f_e_c_t [ _e_f_f_e_c_t _o_p_t_i_o_n_s ... ] ]
  14.      sox _i_n_f_i_l_e -e _e_f_f_e_c_t [ _e_f_f_e_c_t _o_p_t_i_o_n_s ... ]
  15.      sox [ _g_e_n_e_r_a_l _o_p_t_i_o_n_s  ] [ _f_o_r_m_a_t _o_p_t_i_o_n_s  ] _i_f_i_l_e [  _f_o_r_m_a_t
  16.      _o_p_t_i_o_n_s  ] _o_f_i_l_e [ _e_f_f_e_c_t [ _e_f_f_e_c_t _o_p_t_i_o_n_s ... ] ]
  17.      _G_e_n_e_r_a_l _o_p_t_i_o_n_s: [ -V ] [ -v _v_o_l_u_m_e ]
  18.      _F_o_r_m_a_t _o_p_t_i_o_n_s: [ -t _f_i_l_e_t_y_p_e ] [ -r _r_a_t_e ] [ -s/-u/-U/-A  ]
  19.      [ -b/-w/-l/-f/-d/-D ] [ -c _c_h_a_n_n_e_l_s ] [ -x ]
  20.      _E_f_f_e_c_t_s:
  21.           copy
  22.           rate
  23.           avg
  24.           stat
  25.           echo _d_e_l_a_y _v_o_l_u_m_e [ _d_e_l_a_y _v_o_l_u_m_e ... ]
  26.           vibro _s_p_e_e_d [ _d_e_p_t_h ]
  27.           lowp _c_e_n_t_e_r
  28.           highp _c_e_n_t_e_r
  29.           band [ -_n ] _c_e_n_t_e_r [ _w_i_d_t_h ]
  30.  
  31. DESCRIPTION
  32.      _S_o_x translates sound files from one format to another,  pos-
  33.      sibly doing a sound effect.
  34.  
  35. OPTIONS
  36.      The option syntax is a little grotty, but in essence:
  37.           sox file.au file.voc
  38.      translates a sound sample in SUN Sparc  .AU  format  into  a
  39.      SoundBlaster .VOC file, while
  40.           sox -v 0.5 file.au -rate 12000 file.voc rate
  41.      does the same format translation but also lowers the  ampli-
  42.      tude by 1/2 and changes the sampling rate from 8000 hertz to
  43.      12000 hertz via the rate _s_o_u_n_d _e_f_f_e_c_t loop.
  44.  
  45.      File type options:
  46.  
  47.      -t _f_i_l_e_t_y_p_e
  48.                gives the type of the sound sample file.
  49.  
  50.      -r _r_a_t_e   Give sample rate in Hertz of file.
  51.  
  52.      -s/-u/-U/-A
  53.                The sample data is signed linear (2's complement),
  54.                unsigned  linear,  U-law  (logarithmic),  or A-law
  55.                (logarithmic).  U-law and A-law are the  U.S.  and
  56.                international  standards for logarithmic telephone
  57.                sound compression.
  58.  
  59.      -b/-w/-l/-f/-d/-D
  60.  
  61.  
  62.  
  63. Sun Release 4.1           Last change:                          1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SOX(1)                   USER COMMANDS                     SOX(1)
  71.  
  72.  
  73.  
  74.                The sample data is in bytes, 16-bit words,  32-bit
  75.                longwords, 32-bit floats, 64-bit double floats, or
  76.                80-bit IEEE floats.  Floats and double floats  are
  77.                in native machine format.
  78.  
  79.      -x        The sample data is in XINU  format;  that  is,  it
  80.                comes  from a machine with the opposite word order
  81.                than yours and must be swapped  according  to  the
  82.                word-size  given  above.   Only  16-bit and 32-bit
  83.                integer  data  may  be  swapped.    Machine-format
  84.                floating-point  data is not portable.  IEEE floats
  85.                are a fixed, portable format. ???
  86.  
  87.      -c _c_h_a_n_n_e_l_s
  88.                The number of sound channels  in  the  data  file.
  89.                This  may be 1, 2, or 4; for mono, stereo, or quad
  90.                sound data.
  91.  
  92.      General options:
  93.  
  94.      -e        after the input file allows you to avoid giving an
  95.                output file and just name an effect.  This is only
  96.                useful with the stat effect.
  97.  
  98.      -v _v_o_l_u_m_e Change amplitude (floating point); less  than  1.0
  99.                decreases,  greater  than 1.0 increases.  Note: we
  100.                perceive  volume  logarithmically,  not  linearly.
  101.                Note: see the stat effect.
  102.  
  103.      -V        Print a description of processing phases.   Useful
  104.                for  figuring out exactly how _s_o_x is mangling your
  105.                sound samples.
  106.  
  107.      The input and output files may be standard input and output.
  108.      This  is specified by '-'.  The -t _t_y_p_e option must be given
  109.      in this case, else _s_o_x will not know the format of the given
  110.      file.   The  -t,  -r,  -s/-u/-U/-A, -b/-w/-l/-f/-d/-D and -x
  111.      options refer to the input data when given before the  input
  112.      file name.  After, they refer to the output data.
  113.  
  114.      If you don't give an output file name, _s_o_x  will  just  read
  115.      the  input  file.   This is useful for validating structured
  116.      file formats; the stat effect may also be used  via  the  -e
  117.      option.
  118.  
  119. FILE TYPES
  120.      _S_o_x needs to know the formats of the input and output files.
  121.      File  formats which have headers are checked, if that header
  122.      doesn't seem right, the program exits  with  an  appropriate
  123.      message.   Currently,  raw  (no  header)  binary and textual
  124.      data,  IRCAM  Sound  Files,   Sound   Blaster,   SPARC   .AU
  125.      (w/header),  Mac  HCOM,  PC/DOS  .SOU, Sndtool, and Sounder,
  126.  
  127.  
  128.  
  129. Sun Release 4.1           Last change:                          2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SOX(1)                   USER COMMANDS                     SOX(1)
  137.  
  138.  
  139.  
  140.      NeXT .SND, Windows 3.1 RIFF/WAV, Turtle  Beach  .SMP,  CD-R,
  141.      and Apple/SGI AIFF and 8SVX formats are supported.
  142.  
  143.      .aiff     AIFF files used on Apple IIc/IIgs and SGI.   Note:
  144.                the  AIFF format supports only one SSND chunk.  It
  145.                does not support multiple  sound  chunks,  or  the
  146.                8SVX  musical instrument description format.  AIFF
  147.                files are multimedia archives  and  and  can  have
  148.                multiple audio and picture chunks.  You may need a
  149.                separate archiver to work with them.
  150.  
  151.      .au       SUN Microsystems AU files.  There  are  apparently
  152.                many  types of .au files; DEC has invented its own
  153.                with a different magic number and word order.  The
  154.                .au  handler  can  read  these  files but will not
  155.                write them.  Some .au files have valid AU  headers
  156.                and some do not.  The latter are probably original
  157.                SUN u-law 8000 hz samples.   These  can  be  dealt
  158.                with using the .ul format (see below).
  159.  
  160.      .hcom     Macintosh HCOM files.  These are (apparently)  Mac
  161.                FSSD  files  with some variant of Huffman compres-
  162.                sion.  The Macintosh has wacky  file  formats  and
  163.                this  format handler apparently doesn't handle all
  164.                the ones it should.   Mac  users  will  need  your
  165.                usual  arsenal  of file converters to deal with an
  166.                HCOM file under Unix or DOS.
  167.  
  168.      .raw      Raw files (no header).
  169.                The sample rate, size (byte, word, etc), and style
  170.                (signed,  unsigned,  etc.) of the sample file must
  171.                be given.  The number of channels defaults to 1.
  172.  
  173.      .ub, .sb, .uw, .sw, .ul
  174.                These are several suffices which serve as a short-
  175.                hand  for  raw  files with a given size and style.
  176.                Thus,  ub,  sb,  uw,  sw,  and  ul  correspond  to
  177.                "unsigned  byte",  "signed byte", "unsigned word",
  178.                "signed word", and "ulaw" (byte).  The sample rate
  179.                defaults to 8000 hz if not explicitly set, and the
  180.                number of channels  (as  always)  defaults  to  1.
  181.                There are lots of Sparc samples floating around in
  182.                u-law format with no header and fixed at a  sample
  183.                rate   of  8000  hz.   (Certain  sound  management
  184.                software cheerfully ignores  the  headers.)  Simi-
  185.                larly,  most  Mac sound files are in unsigned byte
  186.                format with a sample rate of 11025 or 22050 hz.
  187.  
  188.      .sf       IRCAM Sound Files.
  189.                SoundFiles are used  by  academic  music  software
  190.                such  as the CSound package, and the MixView sound
  191.                sample editor.
  192.  
  193.  
  194.  
  195. Sun Release 4.1           Last change:                          3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SOX(1)                   USER COMMANDS