home *** CD-ROM | disk | FTP | other *** search
/ Computerworld 1996 April / Computerworld_1996-04_cd.bin / cw / programy / esbeekay / read.me < prev    next >
Encoding:
Text File  |  1996-09-15  |  8.7 KB  |  256 lines
  1.  
  2. This is Esbeekay v1.2
  3. Bug-reports, questions and suggestions about changes to apl@vapl.demon.co.uk
  4.  
  5. ========IMPORTANT=========
  6. You must have already installed win32s v1.2 in order to run Esbeekay.
  7. Win32s v1.1.5 may work but I haven't tried it.
  8. Alternatively run Esbeekay under Windows NT, it will work with the beta
  9. drivers.
  10. ==========================
  11.  
  12. What is Esbeekay?
  13. -----------------
  14.  
  15. Esbeekay is shareware, and it is used to edit soundfont banks, or SBKs.
  16. It can be used to create patches from waves, GUS patches, Kurzweil patches,
  17. MOD samples and also using the AWE ROM samples. It can edit any and all
  18. parameters in an SBK but not quite all parameters are known yet so some
  19. experimentation may be necessary. Samples can be multilayered, and each
  20. layer can have many samples for particular key ranges.
  21.  
  22. Changes from 1.1
  23. ----------------
  24.  
  25. Velocity split and other new parameters
  26. Macros can now be attached to windows and are generally expanded
  27. Now a 32-bit application, uses win32s v1.2 under Windows 3.x, native under NT.
  28. Improved documentation
  29. More sample macros
  30.  
  31. The files included
  32. ------------------
  33.  
  34. esbeekay.exe    The Esbeekay program
  35. esbeekay.hlp    Help file for Esbeekay
  36. esbk16.dll      Additional .dll's for Esbeekay
  37. esbk32.dll
  38. versions        List of changes and features on each version
  39. read.me         This file
  40. dllcode/        Source code for reverse.dll, a macro dll
  41. macros/         Sample macros
  42.   gus.mac       Macro which imports GUS samples
  43.   waves.mac     Macro which imports wave samples and staggers them
  44.   reverse.mac   Macro which reverses samples
  45.   reverse.dll   DLL used by reverse.mac
  46.   reverse2.mac  Another macro to reverse a sample, attaches to sample dialog
  47.   veltofc.mac   A macro to make Fc depend on velocity by velocity splitting
  48.  
  49.  
  50. How to install
  51. --------------
  52.  
  53. Make a subdirectory for all the files and copy them into that directory.
  54. It is a good idea to keep the same directory structure as outlined above
  55. but it's not compulsory. The files esbk16.dll, esbk32.dll and esbeekay.hlp
  56. have to be in the same directory as esbeekay.exe.
  57.  
  58. Make sure you have win32s v1.2 installed if you're using Windows 3.x.
  59.  
  60. To run, run esbeekay.exe under Windows 3.x or Windows NT.
  61. I don't know what happens if you run it under Windows 95, since I don't
  62. have that.
  63.  
  64. Help
  65. ----
  66.  
  67. The help file has been greatly expanded in the macro sections, thanks
  68. to Andy Robinson who has also helped with design ideas. For complete
  69. newcomers to the AWE it is recommended that you play around with
  70. Vienna first to get an idea of what's involved. Esbeekay lets you 
  71. manipulate the complete SBK structure and consequently it may not suit
  72. everyone. On the other hand if you have to manipulate parameters such
  73. as velocity split, not found in Vienna, then Esbeekay is the program
  74. for you.
  75.  
  76. Esbeekay is shareware
  77. ---------------------
  78.  
  79. However it's not crippled. After a somewhat disappointing reception in
  80. terms of actual revenue the last time round (no-one sent anything), I've
  81. lowered the suggested donation to one GB pound. Alternatively if you're
  82. going to send something and can't get hold of pounds then send the
  83. equivalent in ecu's :-).
  84.  
  85. What has happened with macros?
  86. ------------------------------
  87.  
  88. In our efforts to both improve the macro language in Esbeekay, and make 
  89. it more user friendly, new functions have been added and certain 
  90. functions have been superceded. 
  91.  
  92. Where functions have been superceded, the original function is stil 
  93. supported. We would urge you to use the new functions in future and to 
  94. update your existing macro's at you earliest convenience.
  95. The new functions add so much more control to your macro's that you 
  96. will probably want to do this anyway.
  97.  
  98. Documentation for the pre-existing functions and the new functions can 
  99. be found in the help file.
  100.  
  101. valid()
  102. -------
  103. valid() is now replaced by objectIsValid() It's functionality remains 
  104. identical. It's sole purpose is now to test the validity of objects as 
  105. other functions have been introduced to test other conditions. We felt 
  106. the new name was more appropriate. 
  107.  
  108. getObjectData() 
  109. ---------------
  110. was used to retrieve the properties for patches, instruments and sample 
  111. headers while setObjectData() was used to set properties for these 
  112. objects.
  113. We felt in this case that the names ..
  114.  
  115. getObjectProperties() 
  116. setObjectProperties() 
  117.  
  118. are more suitable. 
  119. In this version, we are trying to present the distinction between 
  120. parameters and properties which was confusing for some users. We feel 
  121. that these new names will assist in this regard. Their functionality is 
  122. identical to that of the old functions .. getObjectData() and 
  123. setObjectData()
  124.  
  125. setObjectData() and getObjectData() wrt instruments takes and returns
  126. lists always.
  127.  
  128. Field validation:
  129. ----------------
  130.  
  131. In previous versions, attempting to use windowInput() on certain 
  132. controls that had no contents, would genererate a run time error. 
  133. This inconvenience no longer exists we are pleased to say.
  134.  
  135. Some new functions were introduced specifically to address these 
  136. issues. They are outlined briefly here. The help file contains more 
  137. complete details.
  138.  
  139. Any control that accepts user input may now be tested for valid 
  140. contents. Depending on the control, valid contents means different 
  141. things but conditions that are reported are ...
  142. No selection in listboxes and comboboxes
  143. SBKLink is empty
  144. Control is empty
  145. Value is below range
  146. Value is above range
  147. Value is OK.
  148.  
  149. To report these conditions the new function getWindowInputError() has 
  150. been introduced.
  151. By using this function on a control before windowInput(), the macro can 
  152. ascertain the validity of control contents and can handle the situation 
  153. to the benefit of the macro user. 
  154.  
  155. getWindowControlRange() has been introduced to retrieve the range for a 
  156. valuein control. Used in combination with getWindowInputError(), a 
  157. macro can inform a user of the acceptable ranges for the control.
  158.  
  159. NoteIn and ValueIn controls no longer accept alphabetic input. 
  160.  
  161. Listboxes
  162. ---------
  163.  
  164. Listboxes now support multiple selection in the expected fashion by 
  165. supporting <SHIFT><CLICK> and <CTRL><CLICK>.
  166. <SHIFT><CLICK> to extend a selection
  167. <CTRL><CLICK> to individually toggle the selection status of an item.
  168.  
  169. length() 
  170. --------
  171. Supercedes listLength(). It reports the number of elements in a list or 
  172. the number of characters in a string.
  173.  
  174. subString()
  175. -----------
  176. Extracts asubstring from a string. 
  177.  
  178. displayHelp()
  179. -------------
  180. Calls a helpfile. Allows macro writers to document their macro's.
  181.  
  182. itemsInWindowControl(controlId::string)
  183. ---------------------------------------
  184. Returns the number of lines or items in a listbox or combobox.
  185.  
  186. filePrompt()
  187. ------------
  188. This function has been altered: 
  189. Unfortunately, if you make use of this function in any of your macro's 
  190. you will have to change it's parameters.
  191. It also returns an empty list where no selection has been made.
  192.  
  193. importWave()
  194. ------------
  195. Now has import filters. You can specify left or right channels of 
  196. stereo wave files and even disregard mono wave files.
  197.  
  198. windowInput()
  199. -------------
  200. now returns a list for all list boxes and also comboboxes,
  201. which contains the index of the selected item(s) or an empty list if there
  202. is no selection.
  203.  
  204. True & False
  205. ------------
  206. True and false have been introduced as langauge constants. Seeing as 
  207. many functions in the macro langauge return a number for a tested 
  208. condition, we felt that this would be helpfull.
  209. True evaluates to a 1 condition while
  210. False evaluates to a 0 condition.
  211.  
  212. getObjectSBK()
  213. --------------
  214. This is a new function.
  215. It returns the SBK which contains a given object.
  216.  
  217. setGroupCallback()
  218. ------------------
  219. Is a new function. Use it to specify which function a radio button 
  220. should call when clicked. The button control id is passed as a 
  221. parameter to the called function. You can use this function to 'group' 
  222. radio buttons together.
  223.  
  224. callMacro()
  225. -----------
  226. A new function allowing a macro to call a function in another macro.
  227. This means that macro libraries are now a possibility.
  228.  
  229. openMacroWindow()
  230. -----------------
  231. New function:
  232. Opens the macro window for another macro. You can now run other macro's 
  233. from one macro. By fixing a macro window to an sbk window, you can 
  234. create a speedbar for your favourite macro's.
  235.  
  236. closeMacroWindow()
  237. ------------------
  238. New function:
  239. Closes a macro window. You can now have exit buttons on your macro 
  240. windows. (Least that's what I'm gonna use it for)
  241. I'm sure they'll be other applications for this function.
  242.  
  243. New Parameters Supported
  244. ------------------------
  245.  
  246. The macro language now supports these additional parameters. Will they 
  247. never end? (No)
  248.  
  249. "keyToHold"
  250. "keyToDecay"
  251. "sampleStartOffset"
  252. "sampleEndOffset"
  253. "forceKey"
  254. "forceVel"
  255.  
  256.