home *** CD-ROM | disk | FTP | other *** search
/ Music Workshop 2 / Music_Workshop_Second_Edition_Walnut_Creek_January_1996.iso / extras / patches / tx81z / format.doc < prev    next >
Text File  |  1994-02-17  |  6KB  |  142 lines
  1.               Yamaha TX81Z Archive Format
  2.               ---------------------------
  3.  
  4.  
  5. Overall Structure
  6. -----------------
  7.  
  8. The archive is a single ASCII text file, containing  voice  descriptions
  9. and the ASCII encoded  binary which  implements  the voice.  If the file
  10. gets too big, it can be split into several  smaller  files (if you don't
  11. split up a  voice),  but they can still  logically  be  thought  of as a
  12. "single archive file".
  13.  
  14. Each  "voice" in the archive is  separated  from other  voices by one or
  15. more blank lines.  There are no blank lines within a voice.
  16.  
  17.  
  18. Individual Voice Structure
  19. --------------------------
  20.  
  21. A voice consists of one or more comments, followed by the voice data.
  22.  
  23. A comment begins with an asterisk  ('*') in column 1.  Forgiving  reader
  24. programs  would  treat any  characters  after an  asterisk  and before a
  25. newline as comment material.
  26.  
  27. Some comments  have special  formats, to allow  automated  querys of the
  28. archive.  These  comments  begin  with  two  asterisks  ("**"),  and are
  29. described in "Database Comments" below.  Comments which are not intended
  30. as database comments must only start with a single asterisk.
  31.  
  32. The voice  data  consists  of 128  bytes, in the order and  format  of a
  33. system bulk voice dump.  These 128 bytes have been encoded in hex ASCII,
  34. for ease in  manipulation  and  transport.  Each byte is separated  from
  35. it's neighbors by white space (space, tab, or newline).  By  convention,
  36. there  are 5 lines of 25  bytes,  and 1 line of 3 bytes,  but  forgiving
  37. reader programs should accept any layout arrangement.
  38.  
  39.  
  40. Database Comments
  41. -----------------
  42.  
  43. Certain  comments in the  database are in a particular  format, to allow
  44. automated queries of the voice database.
  45.  
  46. The format of the first part of these  comments, from the first asterisk
  47. to the  terminating  colon must be exactly  as  specified.  All have two
  48. asterisks, one space, a field name, and a following colon.
  49.  
  50. The database  comments  could occur in any order, but the order they are
  51. defined here is suggested.  In addition, experience has shown that it is
  52. very useful for the "** Name:"  comment to occur  first.  The  following
  53. of this  convention  makes writing tools to manipulate  the archive much
  54. easier.
  55.  
  56. The following are defined:
  57.  
  58. ** Name:
  59.  
  60.     This is the voice  name, as it would  appear on the  display  of the
  61.     synthesizer.  Each voice must have one of these, since it is also in
  62.     the binary data.  This comment must fit on one line.  It is strongly
  63.     recommended that this comment be the first line of a new voice.
  64.  
  65. ** Long_name:
  66.  
  67.     If a person wants a longer, more descriptive  name, this is where it
  68.     goes.  Whenever available, reader software should use this name when
  69.     interacting  with the user.  This comment is optional,  and must fit
  70.     on one line.
  71.  
  72. ** Description:
  73.  
  74.     This is a wordy  description  of the  sound of the  voice.  It might
  75.     also include  what it's good for.  This comment is optional.  It can
  76.     continue over more than one line.  (See comment continuation below.)
  77.  
  78. ** Controls:
  79.  
  80.     This lists the external controls which affect the sound of the voice.
  81.     The controls and their meanings are:
  82.  
  83.     KV                  Key  velocity  changes the gain of the  operator
  84.             envelope
  85.     MW (LFO pitch)      Modulation  wheel  changes the effect of the LFO
  86.             on the voice pitch
  87.     MW (LFO amplitude)  Modulation  wheel  changes the effect of the LFO
  88.             on the voice amplitude
  89.     BC (LFO pitch)      Breath controller  changes the effect of the LFO
  90.             on the voice pitch
  91.     BC (LFO amplitude)  Breath controller  changes the effect of the LFO
  92.             on the voice amplitude
  93.     BC (EG amplitude)   Breath  controller   changes  the  gain  of  the
  94.             operator envelope
  95.     BC (voice pitch)    Breath controller changes the pitch of the voice
  96.     FC (LFO pitch)      Foot controller changes the effect of the LFO on
  97.             the voice pitch
  98.     FC (LFO amplitude)  Foot controller changes the effect of the LFO on
  99.             the voice amplitude
  100.  
  101.     The  overall  volume and pitch wheel  settings  will also affect the
  102.     sound of the voice, but are not noted in this comment.
  103.  
  104.     This comment is optional.  It can continue  over more than one line.
  105.     (See comment continuation below.)
  106.  
  107. ** Usage:
  108.  
  109.     This is helpful  hints on how to use the voice, not so much in terms
  110.     of musical  arrangement,  but more from the  standpoint  of  "breath
  111.     controller  will make the voice sound more whatever".  It is helpful
  112.     to know how the voice reacts to the various control sources, without
  113.     having to dig into its  internals  to see how it is  wired.  Another
  114.     good thing to include here is  reasonable  voice range.  Many voices
  115.     only  sound  good over a limited  range of notes.  This  comment  is
  116.     optional.  It can  continue  over more than one line.  (See  comment
  117.     continuation below.)
  118.  
  119. ** Source:
  120.  
  121.     This is where  the voice  came  from.  It's an  opportunity  to give
  122.     credit  where  credit is due.  If this  voice is a  modification  of
  123.     another, it would also be nice to credit or at least  reference  the
  124.     original  source.  This  comment is optional.  It can continue  over
  125.     more than one line.  (See comment continuation below.)
  126.  
  127. The above  database  comments  are all that are defined at the  present.
  128. Reader programs should ignore (or do something reasonable) with database
  129. comments which they don't  understand.  Obviously,  since almost all are
  130. optional, they shouldn't depend on any voice having these fields.
  131.  
  132. Some  database  comments  can  extend  over  more  than  one  line.  The
  133. extending  lines must be successive,  must begin with two asterisks, and
  134. must  have  something  other  than a single  space  character  after the
  135. asterisks.  This  allows  reader  programs  to  distinguish   between  a
  136. continuation  (more than one space) and a new database  comment (exactly
  137. one space).  An example is:
  138.  
  139. ** Usage: This voice works only if you get the breath controller max'ed
  140. **        out, and are playing note C5.  Otherwise it causes your
  141. **      speakers to blow up.
  142.