home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 19 / CD_ASCQ_19_010295.iso / dos / prg / midas / midp.doc < prev    next >
Text File  |  1994-08-06  |  11KB  |  277 lines
  1.         MIDAS Module Player v0.42 documentation
  2.         ---------------------------------------
  3.    Copyright 1994 Petteri Kangaslampi and Jarno Paananen
  4.  
  5. MIDAS MODULE PLAYER IS PROVIDED "AS IS" WITHOUT WARRANTY OF
  6. ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  7. LIMITED TO, WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  8. PARTICULAR PURPOSE. IN NO EVENT WILL ANY OF THE AUTHORS OR
  9. COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES CAUSED BY THE USE,
  10. OR INABILITY TO USE, OF MIDAS MODULE PLAYER.
  11.  
  12. MIDAS Module Player may freely be distributed as long as no money is
  13. charged for it, and no attempt is made to restrict further copying,
  14. distribution and using of MIDAS Module Player. If you have problems
  15. with this, or do not understand this, contact us.
  16.  
  17.  
  18. MIDAS Module Player is a program for playing Protracker and Scream
  19. Tracker 3 modules. It uses MIDAS Sound System, also by us, which is
  20. now available for the public for free of charge. All source code is
  21. included. Read MIDAS.TXT for more information about MIDAS Sound System.
  22.  
  23.  
  24.  
  25.         Foreword
  26.         --------
  27.  
  28. As the version number suggests, this is not a final version of MIDP.
  29. The most important reason for releasing MIDP as a separate executable
  30. is to get MIDAS Sound System properly tested. In the future MIDP will
  31. include loads of nice features, like proper archiver support,
  32. customizable outlook etc, but for now you must live with what you have
  33. got. The MIDAS Sound System archive includes full source code for MIDP
  34. too, so if you know C you can tailor MIDP to suit for your needs.
  35.  
  36. What we now want from you is feedback. Run MIDP on your own computer,
  37. experiment with it, bang it with strange modules and try to crash it.
  38. After you know what works and what doesn't, please tell us. The
  39. preferred method is of course via e-mail, because it is fast and
  40. convenient for us and probably free for you. We are most interested in
  41. hearing whether the Sound Devices work on your sound card. So if you
  42. don't have time to experiment with MIDP for a long time, we would
  43. appreciate if you could at least run it once or twice with different
  44. output modes, and tell us whether it worked or not.
  45.  
  46. When giving us feedback, especially bug reports, please remember to
  47. include information about your computer system, especially the type of
  48. your sound card. Please also include, if possible, the MIDAS error list
  49. given by MIDP on an error situation. It gives us invaluable information
  50. about the error and, even more importantly, where that error occurred.
  51. This way we have better chances of finding the bugs.
  52.  
  53. Unlike most other module players, MIDP is not commercial, shareware, or
  54. even cardware. But, if you like MIDP, nothing naturally stops you from
  55. sending us something, money, a postcard or whatever. We would hope to
  56. get at least a "Hey, MIDP works with my xxx sound card" e-mail message.
  57.  
  58.  
  59.  
  60.         Sound Devices
  61.         -------------
  62.  
  63. MIDAS uses all sound cards through modules called Sound Devices.
  64. Currently there are Sound Devices for the following sound cards:
  65.  
  66.         1. Gravis UltraSound
  67.                 * Should work with all GUS versions. Some problems have
  68.                   been reported on GUS v3.x, but as we only have a v2
  69.                   GUS we have not been able to test them ourselves.
  70.                   Most v3 specific bugs should be fixed for this
  71.                   version, however.
  72.  
  73.         2. Media Vision Pro Audio Spectrum family
  74.                 * This includes PAS, PAS+ and PAS 16
  75.                 * Note that the PAS Sound Device always attempts to use
  76.                   16-bit output unless otherwise told, so with PAS or
  77.                   PAS+ sound cards, you must use the command-line option
  78.                   -o8. In addition to this, with normal PAS you should
  79.                   also set the mixing rate to 22kHz or less, using
  80.                   -m22000. This will be fixed in the near future.
  81.  
  82.         3. Microsoft Windows Sound System
  83.                 * Should also work with other WSS compatible cards,
  84.                   such as Compaq Business Audio, and is tested to work
  85.                   with Audiotrix Pro.
  86.                 * Note that there is no autodetection for WSS, so you
  87.                   must force the correct settings using the command
  88.                   line options (ie. -s3 -p530 -i9 -d3)
  89.  
  90.         4. Creative Labs Sound Blaster series
  91.                 * Fully supports SB 1.0, 1.5, 2.0, SB Pro and SB 16.
  92.                 * Attempts to always use DMA channel 1, so with SB 16
  93.                   you have to force the correct "High-DMA" channel (ie.
  94.                   -d5)
  95.  
  96.         5. No Sound
  97.                 * Plays nothing, is always used when nothing else is
  98.                   detected.
  99.                 * Just to allow sound synchronization even with no
  100.                   sound card.
  101.  
  102. Note that both the GUS and SB Sound Device use direct hardware
  103. detection routines, and might therefore cause problems on some
  104. computers. In that case, simply force the settings from the command
  105. line. This will be fixed in the future, as all detection will be done
  106. using the environment variables.
  107.  
  108.  
  109.  
  110.         MIDP Usage:
  111.         -----------
  112.  
  113. The command line syntax for MIDP is:
  114.  
  115.         MIDP [options] <filenames> [options]
  116.  
  117.         At least one module file name must be included. MIDP also
  118.         supports multiple modules and wildcards.
  119.  
  120. Options:
  121.         -sx     Force Sound Device x (1 = GUS, 2 = PAS, 3 = WSS, 4 = SB,
  122.                 5 = No Sound)
  123.         -pxxx   Force I/O port xxx (hex) for Sound Device
  124.         -ix     Force IRQ x for Sound Device
  125.         -dx     Force DMA channel x for Sound Device
  126.         -mxxxx  Set mixing rate to xxxx Hz
  127.         -oxxx   Force output mode (8 = 8-bit, 1 = 16-bit, s = stereo,
  128.                 m = mono)
  129.         -e      Disable EMS usage
  130.         -t      Disable ProTracker BPM tempos
  131.         -u      Enable Surround sound (affects only GUS)
  132.         -v      Disable real VU-meters
  133.         -------
  134.         -S      Jump immediately to DOS shell
  135.         -c      Disable timer screen synchronization
  136.         -C      Enable timer screen synchronization also in DOS shell
  137.         -Lx     Number of song loops before next song
  138.         -O      Scramble module playing order
  139.  
  140. Also '/' is recognized as option delimiter.
  141. Note that the options are CASE SENSITIVE.
  142.  
  143.  
  144.  
  145.         MIDAS environment variable
  146.         --------------------------
  147.  
  148. MIDAS Sound System specific options (above the line in the command
  149. line option list above) can also be set to environment variable MIDAS,
  150. so that they do not have to be entered every time. The syntax is
  151. exactly the same as with the command line options. Also other programs
  152. that use MIDAS Sound System will probably recognize the environment
  153. variable.
  154.  
  155. Example:
  156.         SET MIDAS=-s3 -p530 -i9 -d3 -om -m32000
  157.  
  158.  
  159.  
  160.         MIDP keys
  161.         ---------
  162.  
  163. When playing a module, MIDP can be controlled using the following keys:
  164. (most of these are same as in DMP, so learning them should not be very
  165. difficult...)
  166.  
  167.         Alt-X           Quick exit
  168.         Left/Right      Next / Previous position
  169.         Up/Down         Select active channel
  170.         Esc             Exit with fade out
  171.         +/-             Increase / Decrease master volume
  172.         D               Jump to DOS shell
  173.         1-9, 0          Toggle channels on/off
  174.         ,/.             Adjust active channel panning left / right
  175.         M               Set active channel panning to middle
  176.         L               Set active channel panning to left
  177.         R               Set active channel panning to right
  178.         U               Set active channel panning to surround
  179.         T               Toggle active channel on/off
  180.         P               Pause module. Press P to continue
  181.         Space           Mute playing. Press Space again to un-mute
  182.         N               Next module
  183.  
  184. Plus some internal debugging keys (someone would try these anyway):
  185.         F               Lists all free blocks in heap
  186.         H               Lists all memory blocks in heap
  187.  
  188.  
  189.  
  190.         Archive support
  191.         ---------------
  192.  
  193. MIDP also includes a primitive archive support, built as we ourselves
  194. needed it. When playing a file with extension .ZIP, .MDZ or .S3Z, MIDP
  195. first decompresses the file using PKUNZIP to the directory set by
  196. environment variable "TEMP", or to C:\ if none is set. Then the first
  197. file from that directory with same name as the archive (but with any
  198. extension) will be played and deleted immediately after playing starts.
  199. When multiple archives are being played, the decompression of the next
  200. start immediately after starting to play the previous one, to give
  201. almost uninterrupted background music.
  202.  
  203. Archive support will be enhanced in the future, after we implement some
  204. kind of configuration file, to include any archivers and extensions.
  205. But for now on this must do.
  206.  
  207.  
  208.  
  209.         The future
  210.         ----------
  211.  
  212. Future versions of MIDP will include:
  213.  
  214.         1. Configuration file, with ability to change archivers,
  215.            extensions, colors, palette and probably redefine some
  216.            characters from the display.
  217.  
  218.         2. Less bugs (depending on your bug reports).
  219.  
  220.         3. No debug code (if 2 ever comes true)
  221.  
  222.  
  223.  
  224.         Contact us
  225.         ----------
  226.  
  227. For bug reports, comments, questions etc., contact us:
  228.  
  229. e-mail:
  230.         pekanga@freeport.uwasa.fi (Petteri Kangaslampi)
  231.         Jarno_Paananen@sonata.fipnet.fi (Jarno Paananen)
  232.         gurus2@freeport.uwasa.fi (Jarno Paananen, use if the fipnet
  233.                 address fails)
  234.  
  235. FidoNet: (SLOW!)
  236.     Petteri Kangaslampi, 2:221/319 (Maximus Filecenter)
  237.  
  238. voice:
  239.         +358-31-646764 (Petteri Kangaslampi)
  240.         +358-31-3422147 (Jarno Paananen)
  241.         Please restrict your calls to 10.00 - 21.30, Finnish
  242.         time.
  243.  
  244. normal mail:
  245.         Petteri Kangaslampi
  246.         Simeoninkuja 4
  247.         FIN-36240 Kangasala 4
  248.         Finland
  249.  
  250.         Jarno Paananen
  251.         Puskalantie 6
  252.         FIN-37120 Nokia
  253.         Finland
  254.  
  255.  
  256.  
  257.         Distribution sites
  258.         ------------------
  259.  
  260. The latest MIDAS Sound System and MIDAS Module Player should be always
  261. available on these fine BBSes:
  262.  
  263. WarmBoot BBS            +55-194-265112
  264.         Sysop: Carlos Henrique Cantu (WarmBooter)
  265.  
  266. Moir Brandts Honk       #1: +31-(0)70-3461215 USR/DS         (14K4)
  267.                         #2: +31-(0)70-3457929 ZyXEL U-1496E+ (19K2)
  268.                         #3: +31-(0)70-3452981 LineLink 144e  (14K4)
  269.         Sysop: Hugo Voerman
  270.  
  271. The Pantheon            703-378-3553 (changing soon?)
  272.         Sysops: Farmicus [CiA], Lord Soth [iCE], and Shaggy [iCE Senior
  273.         Staff]
  274.  
  275. The Solarium            +358-31-3170851
  276.         Sysop: Jussi Holtta (Peak / Anarchy)
  277.