home *** CD-ROM | disk | FTP | other *** search
/ Multimedia Classic / MultimediaClassic.mdf / app_midi / jaleo067.dos / moregus / patchis.doc < prev    next >
Encoding:
Text File  |  1993-08-10  |  6.1 KB  |  139 lines
  1. PATCHIS (C)1993 Cornel Huth.  All Rights Reserved.
  2. PATCHIS v1.01 Documentation, 11-Aug-93.
  3. This document may only be distributed with PATCHIS.EXE and
  4. PATCHIS.EXE may only be distributed with this document.
  5.  
  6.            For latest updates, call the RUCKUS support BBS:
  7.  
  8.       BBS support telephone: 1(210)684-8065. V.32bis (1200-14.4k bps)
  9.       Hours: Monday through Friday, 5pm to 9am next morning
  10.              Weekend hours are 1pm to 9am next morning.
  11.              All times USA Central Time, about UTCtime-5.
  12.  
  13.  
  14. FIXES: (and commentary)
  15.  
  16. 11-Aug-93 v1.01
  17. Archive name: PATCHIS2.ZIP
  18.  
  19. Couple things done. First, waveform modes: the SIGNED/unsigned data
  20. was reversed. Second, provided for overriding of PATDIR= if drive letter
  21. or any subdirectory name used. An interesting note. All Gravis/Forte
  22. documentation that I have seen regarding the patch file makeup has the
  23. waveform mode for the signed/unsigned bit meaning incorrect (not just
  24. inverted, either -- the Forte SDK beta says 1=signed & 0=two's-comp).
  25. Pretty much follows, though, since patch data information is seriously
  26. lacking from Gravis.
  27.  
  28. After spending many, many hours getting needed modules for the GUS,
  29. I can see why the GUS libs are referred to as the "OS". Instead of
  30. an "OS", though, perhaps one should call it the "SOS". And while
  31. one can get results from the GUS with only a little work, to reap
  32. the benefits of the GUS takes some serious work and know-how. It
  33. is, though, oh-so rewarding to work with such a fine-sounding board
  34. (plus blowing away the limitations of the current SDK feels great).
  35. And RUCKUS 2.0 has/may not been released to the shareware crowd,
  36. though you may find RUCKUS 1.0 enticing enough.
  37.  
  38.  
  39. OVERVIEW:
  40.  
  41. PATCHIS is for quickly looking at the information in a GUS patch
  42. data file. The following documentation describes its limitations,
  43. use, and features.
  44.  
  45.  
  46. LIMITATIONS:
  47.  
  48. PATCHIS.EXE v1.0 can currently handle single-instrument, single-
  49. layer patch files. Multiple-waveforms are handled.
  50.  
  51.  
  52. USE:
  53.  
  54. PATCHIS looks for the DOS environment variable called PATDIR to
  55. locate the patch files (for example, SET PATDIR=c:\snd\gus\midi).
  56. The patch filename is specified on the command-line (for example,
  57. C>patchis acpiano.pat  accesses c:\snd\gus\midi\acpiano.pat, if
  58. PATDIR is set as above). The patch file is opened for READ-ONLY.
  59.  
  60. If more information is available than can fit on one screen a
  61. prompt appears. Press ENTER to continue or Ctrl-C to abort.
  62.  
  63. PATCHIS was not designed to tell you how to use the patch data--
  64. it is simply a patch browser for informational use. For additional
  65. information see my RUCKUS v2.0 sound card toolkit. Filenames are
  66. RUKC10.ZIP for DOS C compilers, and RUKQ10.ZIP for QB45/BASIC7/VBDOS.
  67. These versions are available on SIMTEL20, PDN, and my BBS listed
  68. above.
  69.  
  70.  
  71. FEATURES:
  72.  
  73. The patch's filename starts out the information, followed on the
  74. next line by the patch header, MIDI SysEx ID#, and copyright.
  75.  
  76. Line 3 displays global information on the patch file, including
  77. number of instruments; count of GF1 voices for which the patch
  78. was designed; in-sync audio channels (GF1 OS use); waveforms in
  79. the patch, in total; master volume; and data size.
  80.  
  81. After the global data is information for each instrument in the
  82. patch (typically just 1) and information for each layer of the
  83. instrument.
  84.  
  85. Instrument information includes instrument number, (0 to header
  86. instruments-1); instrument name (or null); number of layers for
  87. this instrument; and instrument data size. Note that some versions
  88. of PATCH.EXE, the GUS patch editor, overwrites the instrument data
  89. size with a value of 1.
  90.  
  91. Layer information follows. Multiple layers allow for a multi-
  92. timbral instrument where a separate voice plays one of the layers.
  93. There can be 1 to 4 layers per instrument. Layer information
  94. includes the layer number (0-3); layer-duplicated flag; samples
  95. (or waveforms) in the layer (see next); and the layer size.
  96.  
  97. For each sample in the layer is a complete description of the
  98. waveform for use on the GUS. PATCHIS displays several lines of
  99. information for each waveform. After the wave number (1 to
  100. number of waves in the layer) is the file offset to the start
  101. of the sample; then the sample name (often NoName); the sample
  102. size; the low frequency usable by the sample, the root frequency,
  103. and the highest frequency that the sample should be used for.
  104. Multiple samples are used (in a layer) to offer a good sound
  105. across a frequency spectrum. Some instruments need many samples,
  106. say, one per octave, while some instruments may use/need only one
  107. or two samples. Generally, wider-sounding instruments need more
  108. samples to sound realistic (or good).
  109.  
  110. The next line is the sample rate of the waveform; its loop start
  111. offset; fractional start point; loop end offset; fractional end
  112. point; tuning constant (-512 to 512); and balance. You may find
  113. that the balance of one sample for a layer plays mostly left,
  114. while a higher-frequency sample plays mostly right. You may want
  115. to override this and perform yout own balance.
  116.  
  117. Next line contains the 6 envelope rates and 6 envelope volumes.
  118. Then, for AM and FM LFO (tremelo & vibrato) are the sweep, rate,
  119. and depth values. If either rate or depth=0, then LFO should be
  120. considered disabled.
  121.  
  122. The last line for each waveform is the scale frequency; scale
  123. factor; and wave mode. The wave mode is a bit-mapped value
  124. with this makeup:
  125.  
  126.  modes are: bit 0 1=16-bit data            0=8-bit data
  127.                 1 1=unsigned               0=signed data (this is correct)
  128.                 2 1=looping enabled        0=looping off
  129.                 3 1=bi-directional loop    0=uni-directional looping
  130.                 4 1=looping backward       0=looping forward
  131.                 5 1=sustaining on          0=sustaining off (3 envelope pts)
  132.                 6 1=enable envelopes       0=disable envelopes
  133.                *7 1=enable clamped release 0=disable
  134.                     (bit 7 stuff uses last env release rate)
  135.  *bit 7 is not documented in SDK 2.01 but is in the beta release SDK.
  136.  *bit 1 has been incorrectly documented (if at all) in all docs to date.
  137.  
  138. <End of document>
  139.