home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 24 / CD_ASCQ_24_0995.iso / vrac / awemp122.zip / AWEMP.DOC next >
Text File  |  1995-07-11  |  11KB  |  251 lines
  1. -  -  -  - - - --------------------*-*-*-*-*-------------------- - - -  -  -  -
  2.                        Sound Blaster AWE32 Module Player
  3.                          Copyright (C) 1995 by B.Boer
  4.                              All rights reserved
  5.                                  Documentation
  6. -  -  -  - - - --------------------*-*-*-*-*-------------------- - - -  -  -  -
  7.  
  8.  
  9. What is AWEMP?
  10. --------------
  11.  
  12. AWEMP is a module player programmed for Creative Labs' Sound Blaster AWE32.
  13. The Sound Blaster AWE32 (for short AWE32) is capable of mixing the different
  14. sound samples on different channels by hardware, in contrast with many other
  15. soundcards that have only one (stereo) channel, so the computer has to mix the
  16. different channels onto one channel by software at the cost of much processor
  17. power. The AWE32 has 512 kb onboard RAM memory onto which you can load your
  18. soundsamples, and let the AWE32 do the mixing.
  19.  
  20. Important note: AWEMP is programmed by using Creative Labs' Developer's
  21.                 Information Package (AWEDIP). In the future I want to program
  22.                 the AWE32 directly.
  23.  
  24.  
  25. Is AWEMP freeware?
  26. ------------------
  27.  
  28. AWEMP is *cardware*, which means that if you like the program, you must send me
  29. a nice postcard, so I can see how much it is used around the world. See the
  30. section about how to contact the author for the mail address.
  31.  
  32.  
  33. How do I use AWEMP?
  34. -------------------
  35.  
  36. Well, this is plain and simple; just type AWEMP [module.ext]. AWEMP will give
  37. error messages (if necessary) in case your module is not supported, or it
  38. wouldn't fit into your AWE32's memory (see below), or simply because it couln't
  39. find your module. If there are no error messages, AWEMP will load the samples
  40. into the AWE32 and play the module.
  41.  
  42. For commandline options, type at the DOS prompt: AWEMP /?
  43. While AWEMP is playing, press 'H' to display the helptext.
  44.  
  45.  
  46. What about the many options there are?
  47. --------------------------------------
  48.  
  49. Actually, there are only four options, so it isn't that difficult.
  50. Here they are:
  51.  
  52.      /F  Forces AWEMP to load as many samples as possible. When AWEMP reports
  53.          that your module is too big, and you really want to play the module,
  54.          then you should add this option to your commandline. The more samples
  55.          are loaded, the better the module will sound.
  56.  
  57.      /L  Disables module looping, useful when using in combination with option
  58.          '/R'.
  59.  
  60.      /R  Plays the specified modules in a random order. Useful when you
  61.          specify more than one module at the DOS prompt, i.e. AWEMP *.MOD /R.
  62.  
  63.      /V  Uses linear volume table, instead of the non-linear one. When you use
  64.          this option, you won't be able to hear samples with low volumes,
  65.          unless your stereo is set at full volume. :) By default, AWEMP
  66.          creates a non-linear volume table with a math-formula based on
  67.          logarithms.
  68.  
  69. A few examples:
  70.  
  71.   AWEMP D:\MODS\*.MOD                  play all MODs in directory D:\MODS.
  72.   AWEMP D:\MODS\*.MOD /R               the same but in random order.
  73.   AWEMP D:\MODS\*.MOD D:\MODS2\*.MOD   play all MODs in both directories.
  74.   AWEMP D:\MODS\B*.MOD                 play all MODs containing the B as
  75.                                        the first character in the filename.
  76.  
  77.   To play the three specified modules type this:
  78.   AWEMP D:\MODS\CORTOUCH.MOD D:\MODS2\BEYOND.MOD D:\MODS3\WATERFNK.MOD
  79.  
  80.   Or what do you think about this:
  81.   AWEMP D:\MODS\REAL????.MOD D:\MODS2\*.MOD D:\MODS3\WATERFNK.MOD
  82.  
  83. Note that all extensions may be omitted.
  84.  
  85.  
  86. What keys can you use while AWEMP is playing?
  87. ---------------------------------------------
  88.  
  89. Following keys do something useful:
  90.  
  91.     Esc  Stop playing and exit AWEMP.
  92.  
  93.       A  Display the sample names of the current module. Use the cursor keys
  94.          to scroll through the sample names.
  95.       D  Shell to DOS while music keeps playing.
  96.       H  Display the helptext.
  97.       L  Enter play list, you can then select a module by moving the selector
  98.          bar over a filename and then press the Enter key.
  99.       N  Play the next module in the play list.
  100.       P  Pause the playing of the song.
  101.  
  102.       -  Decrease main volume by one.
  103.       +  Increase main volume by one.
  104.  
  105.       [  Decrease reverb depth by one.
  106.       ]  Increase reverb depth by one.
  107.  
  108.       {  Decrease chorus depth by one.
  109.       }  Increase chorus depth by one.
  110.  
  111.    Left  Decrease song position by one.
  112.   Right  Increase song position by one, at the end of the song, AWEMP jumps
  113.          to position 0 (unless option '/L' is used).
  114.  
  115.   Enter  Play current pattern again at line 0.
  116.  
  117.  
  118. Which effects are currently supported?
  119. --------------------------------------
  120.  
  121. Because of the many difficulties I encounter when implementing effects, there
  122. are only a few supported yet. In the next versions I will add more effects
  123. as soon as I know how to implement them.
  124.  
  125. Effects supported (MOD):  0xy - arpeggio
  126.                           1xx - portamento up
  127.                           2xx - portamento down
  128.                           3xx - portamento to note
  129.                           5xx - tone portamento + volume slide
  130.                           6xy - vibrato + volume slide (*)
  131.                           8xx - pan set
  132.                           Axy - volume slide up/down
  133.                           Bxx - position jump
  134.                           Cxx - volume set
  135.                           Dxx - pattern break
  136.                           E1x - fine portamento up
  137.                           E2x - fine portamento down
  138.                           E5x - set loop
  139.                           E6x - jump to loop
  140.                           E9x - retrig note
  141.                           EAx - fine volume slide up
  142.                           EBx - fine volume slide down
  143.                           ECx - note cut
  144.                           EDx - note delay
  145.                           EEx - pattern delay
  146.                           Fxx - speed/bpm set
  147.  
  148. Effects marked with an asterisk (*) are partly implemented, i.e. only the
  149. volume slide works.
  150. When the music plays, you will notice that some effects are shown in uppercase
  151. and some in lowercase. The effects shown in uppercase are implemented, the
  152. others not (yet).
  153.  
  154.  
  155. Common Questions and Answers (Q&A).
  156. -----------------------------------
  157.  
  158. Q: You said that 15-instruments MODs are supported, but AWEMP won't load my
  159.    MOD!!
  160.  
  161. A: AWEMP checks the module if it has some sort of identification (such as M.K.
  162.    or FLT8), if it hasn't, AWEMP assumes it's a 15-instruments MOD. Before
  163.    AWEMP loads the samples, a small check is processed on the module to see
  164.    whether it's a real 15-instruments MOD or not. AWEMP does this by comparing
  165.    the filesize with the total sum of <patterndata-offset + patterndatasize +
  166.    sampledatasize>. If this is not equal, the module will be discarded.
  167.  
  168. Q: What about all those clicks? It sounds just like I'm listening to an old
  169.    gramophone.
  170.  
  171. A: Because of the high frequency rate (44.1 khz, 16 bit) the AWE32 is playing,
  172.    you will hear every small detail of the samples played. Because the AWE32
  173.    only accepts 16 bit samples, AWEMP must convert the 8 bit samples used in
  174.    MODs to 16 bit samples. The clicks you hear, are probably caused by badly
  175.    set looppoints. In the future I will use sample smoothing, so those clicks
  176.    will be gone.
  177.  
  178. Q: Some samples are playing at a very low volume, is this a bug?
  179.  
  180. A: Previous versions of AWEMP did use the standard linear volume table, which
  181.    contains values from 0 to 127. From version 1.11 of AWEMP, the volume table
  182.    is calculated using a math-formula based on logarithms. The result is that
  183.    the samples will now play at the right volume.
  184.  
  185. Q: My system sometimes hangs when shelling to DOS. Am I doing something wrong?
  186.  
  187. A: You're doing nothing wrong. :( This is a known problem, it has something
  188.    to do with the timer. The timer interrupts the system at a specified
  189.    frequency. When you shell to DOS and the timer interrupts the system at
  190.    the same time, the system crashes, while the music keeps playing (or not).
  191.    This error seems not to occur when using NDOS or 4DOS as the commandline
  192.    interpreter (instead of COMMAND.COM).
  193.  
  194. Q: When will AWEMP support S3Ms or XMs?
  195.  
  196. A: I'm not sure about S3M, but XM will be supported as soon as I have
  197.    implemented all the effects used in MODs.
  198.  
  199.  
  200. About the author.
  201. -----------------
  202.  
  203. I am 17 years old and I attend the fifth class of a secondary school. I live
  204. in the Netherlands, better known as Holland.
  205.  
  206. This program is my first real try to make a modplayer. I know it isn't perfect
  207. yet, but it already sounds very nice. The future of this program depends on
  208. how much reply I get and the difficulties I will encounter when implementing
  209. new effects or improving the player.
  210.  
  211. I would like to thank two persons who have already helped me very much; they
  212. are Gemini (Klaasjan Brand) and Raiden (Gerard Veldman), thanks guys.
  213.  
  214.  
  215. How can I contact the author?
  216. -----------------------------
  217.  
  218. If you experience problems when using AWEMP, or you have found bugs, or you
  219. have some very nice ideas, or you know how to avoid AWEDIP, or you know how to
  220. implement new effects, or you know something else I should know, write to me:
  221.  
  222. Mail address : Bert Boer
  223.                Schapendrift 30
  224.                8091 GW  Wezep
  225.                The Netherlands
  226.  
  227. Internet     : kjb@dds.nl    (<= This is not my address! I have currently no
  228.                              Internet access, but you can reach me via this
  229.                              address.)
  230.  
  231. Remember, AWEMP is cardware, so if you haven't sent your postcard yet, please
  232. send one now.
  233.  
  234.  
  235. A final message to all GUS users.
  236. ---------------------------------
  237.  
  238. Now you can see that the AWE32 is capable of doing the same things as the GUS,
  239. and a lot more, you all should stop those wars against Creative Labs and their
  240. Sound Blasters. I think it's rather childish to say that the GUS is better,
  241. only because *previous* Sound Blasters couldn't do what the GUS can do. Each
  242. company has it's own specialities in making soundcards.
  243. Advanced Gravis was the first to do the mixing of music channels by hardware,
  244. Creative Labs the next. Only because Advanced Gravis was the first, the GUS
  245. is very popular by the (demo)programmers. Imagine what would have happened
  246. if Creative Labs was the first . . . .
  247.  
  248.  
  249. -  -  -  - - - --------------------*-*-*-*-*-------------------- - - -  -  -  -
  250.  
  251.