home *** CD-ROM | disk | FTP | other *** search
/ Sound Sensations! / sound_sensations.iso / convert / sbank1 / sbank.doc < prev    next >
Text File  |  1991-01-27  |  9KB  |  204 lines
  1. SBANK 1.02
  2. Copyright (c) 1991 by Jamie O'Connell.  All rights reserved.
  3.  
  4.  
  5. SBANK is a command line utility for managing SoundBlaster and Adlib
  6. instrument files and sound banks.  It will translate between .INS,
  7. .SBI, .BNK, and .IBK files. In addition, it will report instrument
  8. names stored in bank files, and display musical parameters contained
  9. in the instrument definitions. 
  10.  
  11.  
  12.      Usage: SBANK BankFile [-AUMLVXT?] [BankFile|Instrument...]
  13.  
  14.      Bankfile     is the name or path of a BNK or IBK instrument
  15.                   bankfile.  It will be created if appropriate.
  16.  
  17.      Instrument   is the name of an instrument or the name or path of
  18.                   a .INS or .SBI instrument file.  
  19.  
  20.  
  21. OPTIONS
  22.   
  23.      Option letters are case insensitive and may be preceeded by 
  24.      either - or /.  They specify the operations to perform.
  25.  
  26.      -A     append the specified instruments (INS or SBI files) to the
  27.             named bank file.  Wildcards (* and ?) may be used to select
  28.             the instrument files.  The bank file is created if it does 
  29.             not exist.  Duplicate instrument names in the bank file are
  30.             not updated unless the -U option also appears.
  31.  
  32.      -U     update the specified existing instruments in the named bank 
  33.             file.  Wildcards are allowed.  Specified instruments which
  34.             do not exist are not added unless the -A option also appears.
  35.  
  36.      -M     move the specified instruments to the named bank file.
  37.             Specifying -M implies both append and update.  After a 
  38.             sucessful insertion, the instrument file is deleted.  
  39.         Wildcards are allowed.
  40.  
  41.      -D     delete and discard the named instruments from the bank file.
  42.             This can be used with the -X option to remove an instrument
  43.             from a bank file.
  44.  
  45.      -X     extract the named instruments from the bank file.  The type
  46.             of instrument file to create is determined from the filename
  47.             suffix.  
  48.  
  49.      -L     list the names of the instruments contained in the bank file.
  50.             This option formats the names one per line.  Only instrument
  51.             names are displayed.  It is useful for creating input for
  52.             command line filters or file redirection.
  53.  
  54.      -V     list the names of the instruments contained in the bank file.
  55.             The instruments are formatted eight names to a line in the
  56.             same order they are encountered in the bank file.  For a BNK
  57.             file, they will be sorted alphabetically; for a IBK bank,
  58.             they are presented in the order they were appended.  This is
  59.             also the order of increasing MIDI program change numbers.
  60.           
  61.      -S     show the parameters for an instrument or intruments.  This
  62.             option formats and displays the parameters that comprise
  63.             the instrument sound.
  64.  
  65.      -T     translate from one file type to another.  For this option the
  66.             first named file is the source and the second is the target.
  67.             This is the only option that will operate between instrument
  68.             files as well as between bank files.
  69.  
  70.      -Q     enter query mode when translating a bank file.  Specifying
  71.             -Q implies -T (translate).
  72.  
  73.      -$     display registration information.
  74.  
  75.      -?     display brief help information.
  76.      
  77.  
  78. NOTES
  79.  
  80. When possible, file types are determined from their internal structure
  81. rather than the external file name extension.
  82.  
  83. The program can translate each of the four file types into any of the 
  84. other types including it's own type.  It should be noted that the SBI
  85. and IBK file types do not include fields for percussive mode and voice
  86. number.  This information is lost when converting between them and BNK
  87. or INS file types (the mode is always  melodic in SBI and IBK files).
  88.  
  89. When displaying parameters, the following abbreviations and ranges are
  90. used:
  91.  
  92.      Abbrev     Meaning           Range     Notes
  93.  
  94.      KSL    Level Scaling           00 - 03
  95.      FQM        Frequency Multiplier    00 - 14
  96.      FB         Feedback                00 - 07   Used by Modulator only
  97.      ATK        Attack                  00 - 15
  98.      DCY        Decay                   00 - 15
  99.      SLV        Sustain Level           00 - 15   (15 - 0) See Note Below
  100.      RLS        Release                 00 - 15
  101.      LVL        Output Level            00 - 63   (63 - 0) See Note Below
  102.      SUS        Sustaining Sound        No - Yes
  103.      AM         Amplitude Modulation    No - Yes  Tremolo
  104.      VIB        Pitch Modulation        No - Yes  Vibrato
  105.      KSR        Envelope Scaling        No - Yes
  106.      WAV        Wave Select             00 - 03   Waveform Distortion
  107.      CON        Connection              FM - AS   Only used by Modulator
  108.      MOD        Mode                    MLD-PRC   Only used by INS and BNK
  109.      V#         Voice Number            06 - 10   Only used by INS and BNK
  110.  
  111.  
  112. The actual number stored for SLV and LVL is an attenuation level:  the
  113. higher the number, the softer the sound.  What is displayed is the reverse
  114. of this number.
  115.  
  116. The actual number stored for CON is reversed between SBI - IBK and 
  117. INS - BNK formats.  What is displayed is a code: FM - Frequency 
  118. Modulation; AS - Additive Synthesis.
  119.      
  120. As noted above, the MOD and V# fields are only used in INS and BNK file
  121. formats, MOD will always be melodic (MLD) in SBI and IBK files.
  122.  
  123. When using the -V option on a BNK file, both the number of defined
  124. instruments and the current capacity is displayed.  The current capacity
  125. of a BNK file is increased when it becomes filled.  IBK bank files always
  126. have a capacity of 128 instruments.  This corresponds to one instrument
  127. for each MIDI program change number. 
  128.  
  129. Query mode is entered when translating a bank file and -Q is specified.
  130. It is also entered automatically when translating a BNK file containing
  131. more instruments than will fit in a target IBK file.  After query mode
  132. is entered, a prompt is displayed containing the name of an instrument, 
  133. and the program waits for your response.  The following are valid 
  134. responses:
  135.  
  136.      y     append or update this instrument in the target bank file.
  137.      n     skip this instrument and display the next.
  138.      p     skip this instrument and display the previous one.
  139.      r     leave query mode, and add all instruments from here on.
  140.      Esc   (Esc key) leave query mode and exit the program.
  141.  
  142. The program operates as soon as it recieves the key stroke:  it does
  143. not wait for a carriage return.  This means that you can hold down a key
  144. to provide the same response to several prompts.
  145.  
  146.  
  147. EXAMPLES
  148.  
  149. Following are a few examples to demonstrate the kinds of operations that
  150. can be performed with SBANK:
  151.  
  152.      C> sbank standard.bnk -x myins\b??.sbi
  153.   
  154.      This will extract from STANDARD.BNK, all instruments matching 
  155.      B, B? and B??, convert them to SBI files, and place them in the
  156.      MYINS subdirectory.
  157.  
  158.      C> sbank /s standard.bnk abrss1 x* 
  159.  
  160.      This will display the parameters for the ABRSS1 instrument, and all
  161.      instruments matching X*.
  162.  
  163.      C> sbank standard.bnk -l >verylong.lst
  164.  
  165.      This will display the name of each instrument stored in STANDARD.BNK
  166.      but redirect the output to the file VERYLONG.LST.  It will most likely
  167.      be a very long list!
  168.  
  169.      C> sbank -au new.bnk *.ins C:\SBI\*.sbi
  170.      
  171.      This will Append or Update to NEW.BNK, all the INS files in the 
  172.      current directory, and all the SBI files in the C:\SBI directory.
  173.        
  174.      C> sbank my.ibk abrss1.ins -m
  175.  
  176.      This will Append the ABRSS1.INS instrument to MY.IBK and then erase
  177.      the ABRSS1.INS file - if all goes well.
  178.  
  179.      C> sbank my.ibk /d abrss1
  180.  
  181.      This deletes the ABRRS1 instrument from MY.IBK
  182.  
  183.      C> sbank my.ibk ?a* -v 
  184.  
  185.      Will display all of the instrument names in my.ibk which have "A" as
  186.      the second letter.  The names will be formatted eight to a line.
  187.  
  188.      C> sbank piano1.sbi piano1.ins -t
  189.  
  190.      This will convert the PIANO1.SBI instrument file into a PIANO1.INS
  191.      file.
  192.  
  193.      C> sbank piano1.ins -s
  194.  
  195.      This will display the parameters for the PIANO1 instrument contained
  196.      in PIANO1.INS.
  197.  
  198.      C> sbank my.bnk -xd a*.ins b*.ins
  199.  
  200.      This command will extract all the instruments begining with A or B
  201.      form MY.BNK file and place them in INS files in the current directory.
  202.      It will then delete the definitions of those instruments in the MY.BNK 
  203.      file.
  204.