home *** CD-ROM | disk | FTP | other *** search
/ Sound, Music & MIDI Collection 2 / SMMVOL2.bin / AWE / AWEMP123.ZIP / AWEMP.DOC next >
Encoding:
Text File  |  1995-07-29  |  11.6 KB  |  272 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.      /D  Doubles sampling RAM on AWE32. AWEMP will convert all 8 bit samples to
  53.          16 bit while the samplesize remains the same. With this option added
  54.          to the commandline you can load modules up to 512 kb with 512 kb. You
  55.          will however hear some loss of sample quality, especially with hi-hats
  56.          and high quality strings, but this is totally dependant on the sample
  57.          rate at which the samples are recorded.
  58.  
  59.      /F  Forces AWEMP to load as many samples as possible. When AWEMP reports
  60.          that your module is too big, and you really want to play the module,
  61.          then you should add this option to your commandline. The more samples
  62.          are loaded, the better the module will sound.
  63.  
  64.      /L  Disables module looping, useful when using in combination with option
  65.          '/R'.
  66.  
  67.      /R  Plays the specified modules in a random order. Useful when you
  68.          specify more than one module at the DOS prompt, i.e. AWEMP *.MOD /R.
  69.  
  70.      /V  Uses linear volume table, instead of the non-linear one. When you use
  71.          this option, you won't be able to hear samples with low volumes,
  72.          unless your stereo is set at full volume. :) By default, AWEMP
  73.          creates a non-linear volume table with a math-formula based on
  74.          logarithms.
  75.  
  76. A few examples:
  77.  
  78.   AWEMP D:\MODS\*.MOD                  play all MODs in directory D:\MODS.
  79.   AWEMP D:\MODS\*.MOD /R               the same but in random order.
  80.   AWEMP D:\MODS\*.MOD D:\MODS2\*.MOD   play all MODs in both directories.
  81.   AWEMP D:\MODS\B*.MOD                 play all MODs containing the B as
  82.                                        the first character in the filename.
  83.  
  84.   To play the three specified modules type this:
  85.   AWEMP D:\MODS\CORTOUCH.MOD D:\MODS2\BEYOND.MOD D:\MODS3\WATERFNK.MOD
  86.  
  87.   Or what do you think about this:
  88.   AWEMP D:\MODS\REAL????.MOD D:\MODS2\*.MOD D:\MODS3\WATERFNK.MOD
  89.  
  90. Note that all extensions may be omitted.
  91.  
  92.  
  93. What keys can you use while AWEMP is playing?
  94. ---------------------------------------------
  95.  
  96. Following keys do something useful:
  97.  
  98.     Esc  Stop playing and exit AWEMP.
  99.  
  100.       A  Display the sample names of the current module. Use the cursor keys
  101.          to scroll through the sample names.
  102.       D  Shell to DOS while music keeps playing.
  103.       E  Select reverb and chorus effects.
  104.       H  Display the helptext.
  105.       L  Enter play list, you can then select a module by moving the selector
  106.          bar over a filename and then press the Enter key.
  107.       N  Play the next module in the play list.
  108.       P  Pause the playing of the song.
  109.  
  110.       -  Decrease main volume by one.
  111.       +  Increase main volume by one.
  112.  
  113.       [  Decrease reverb depth by one.
  114.       ]  Increase reverb depth by one.
  115.  
  116.       {  Decrease chorus depth by one.
  117.       }  Increase chorus depth by one.
  118.  
  119.    Left  Decrease song position by one.
  120.   Right  Increase song position by one, at the end of the song, AWEMP jumps
  121.          to position 0 (unless option '/L' is used).
  122.  
  123.   Enter  Play current pattern again at line 0.
  124.  
  125.  
  126. Which effects are currently supported?
  127. --------------------------------------
  128.  
  129. Because of the many difficulties I encounter when implementing effects, there
  130. are only a few supported yet. In the next versions I will add more effects
  131. as soon as I know how to implement them.
  132.  
  133. Effects supported (MOD):  0xy - arpeggio
  134.                           1xx - portamento up
  135.                           2xx - portamento down
  136.                           3xx - portamento to note
  137.                           5xx - tone portamento + volume slide
  138.                           6xy - vibrato + volume slide (*)
  139.                           8xx - pan set
  140.                           Axy - volume slide up/down
  141.                           Bxx - position jump
  142.                           Cxx - volume set
  143.                           Dxx - pattern break
  144.                           E1x - fine portamento up
  145.                           E2x - fine portamento down
  146.                           E5x - set loop
  147.                           E6x - jump to loop
  148.                           E9x - retrig note
  149.                           EAx - fine volume slide up
  150.                           EBx - fine volume slide down
  151.                           ECx - note cut
  152.                           EDx - note delay
  153.                           EEx - pattern delay
  154.                           Fxx - speed/bpm set
  155.  
  156. Effects marked with an asterisk (*) are partly implemented, i.e. only the
  157. volume slide works.
  158. When the music plays, you will notice that some effects are shown in uppercase
  159. and some in lowercase. The effects shown in uppercase are implemented, the
  160. others not (yet).
  161.  
  162.  
  163. Common Questions and Answers (Q&A).
  164. -----------------------------------
  165.  
  166. Q: You said that 15-instruments MODs are supported, but AWEMP won't load my
  167.    MOD!!
  168.  
  169. A: AWEMP checks the module if it has some sort of identification (such as M.K.
  170.    or FLT8), if it hasn't, AWEMP assumes it's a 15-instruments MOD. Before
  171.    AWEMP loads the samples, a small check is processed on the module to see
  172.    whether it's a real 15-instruments MOD or not. AWEMP does this by comparing
  173.    the filesize with the total sum of <patterndata-offset + patterndatasize +
  174.    sampledatasize>. If this is not equal, the module will be discarded.
  175.  
  176. Q: I've got an AWE32 with 8 Mb onboard, but AWEMP tells me that there's only
  177.    512 kb onboard.
  178.  
  179. A: The AWE32 I use for testing AWEMP has only 512 kb onboard, so if you have
  180.    some SIMMs left... There are three reasons why AWEMP uses only 512 kb:
  181.    the first, the whole program is coded using the functions in the AWEDIP, I
  182.    know that there are some bugs in this AWEDIP, but I didn't encounter this
  183.    one. It is also possible that I've made some bug in my code, but as said
  184.    above, I have only 512 kb RAM on my AWE32 so it will be difficult to test.
  185.    The last reason could be that you've forgotten to remove jumper JP7 on the
  186.    card, which is necessary to use the SIMM banks. See also the manual which
  187.    came with your card.
  188.  
  189. Q: What about all those clicks? It sounds just like I'm listening to an old
  190.    gramophone.
  191.  
  192. A: Because of the high frequency rate (44.1 khz, 16 bit) the AWE32 is playing,
  193.    you will hear every small detail of the samples played. Because the AWE32
  194.    only accepts 16 bit samples, AWEMP must convert the 8 bit samples used in
  195.    MODs to 16 bit samples. The clicks you hear, are probably caused by badly
  196.    set looppoints. In the future I will use sample smoothing, so those clicks
  197.    will be gone.
  198.  
  199. Q: Some samples are playing at a very low volume, is this a bug?
  200.  
  201. A: Previous versions of AWEMP did use the standard linear volume table, which
  202.    contains values from 0 to 127. From version 1.11 of AWEMP, the volume table
  203.    is calculated using a math-formula based on logarithms. The result is that
  204.    the samples will now play at the right volume.
  205.  
  206. Q: My system sometimes hangs when shelling to DOS. Am I doing something wrong?
  207.  
  208. A: You're doing nothing wrong. :( This is a known problem, it has something
  209.    to do with the timer. The timer interrupts the system at a specified
  210.    frequency. When you shell to DOS and the timer interrupts the system at
  211.    the same time, the system crashes, while the music keeps playing (or not).
  212.    This error seems not to occur when using NDOS or 4DOS as the commandline
  213.    interpreter (instead of COMMAND.COM).
  214.  
  215. Q: When will AWEMP support S3Ms or XMs?
  216.  
  217. A: I'm not sure about S3M, but XM will be supported as soon as I have
  218.    implemented all the effects used in MODs.
  219.  
  220.  
  221. About the author.
  222. -----------------
  223.  
  224. I am 17 years old and I attend the fifth class of a secondary school. I live
  225. in the Netherlands, better known as Holland.
  226.  
  227. This program is my first real try to make a modplayer. I know it isn't perfect
  228. yet, but it already sounds very nice. The future of this program depends on
  229. how much reply I get and the difficulties I will encounter when implementing
  230. new effects or improving the player.
  231.  
  232. I would like to thank two persons who have already helped me very much; they
  233. are Gemini (Klaasjan Brand) and Raiden (Gerard Veldman), thanks guys.
  234.  
  235.  
  236. How can I contact the author?
  237. -----------------------------
  238.  
  239. If you experience problems when using AWEMP, or you have found bugs, or you
  240. have some very nice ideas, or you know how to avoid AWEDIP, or you know how to
  241. implement new effects, or you know something else I should know, write to me:
  242.  
  243. Mail address : Bert Boer
  244.                Schapendrift 30
  245.                8091 GW  Wezep
  246.                The Netherlands
  247.  
  248. Internet     : kjb@dds.nl    (<= This is not my address! I have currently no
  249.                              Internet access, but you can reach me via this
  250.                              address.)
  251.  
  252. Remember, AWEMP is cardware, so if you haven't sent your postcard yet, please
  253. send one now.
  254.  
  255.  
  256. A final message to all GUS users.
  257. ---------------------------------
  258.  
  259. Now you can see that the AWE32 is capable of doing the same things as the GUS,
  260. and a lot more, you all should stop those wars against Creative Labs and their
  261. Sound Blasters. I think it's rather childish to say that the GUS is better,
  262. only because *previous* Sound Blasters couldn't do what the GUS can do. Each
  263. company has it's own specialities in making soundcards.
  264. Advanced Gravis was the first to do the mixing of music channels by hardware,
  265. Creative Labs the next. Only because Advanced Gravis was the first, the GUS
  266. is very popular by the (demo)programmers. Imagine what would have happened
  267. if Creative Labs was the first . . . .
  268.  
  269.  
  270. -  -  -  - - - --------------------*-*-*-*-*-------------------- - - -  -  -  -
  271.  
  272.