home *** CD-ROM | disk | FTP | other *** search
/ Groovy Bytes: Behind the Moon / groovybytes.iso / GROOVY / SND_TOOL / SWMP13.ZIP / PAS.DOC < prev    next >
Encoding:
Text File  |  1995-05-16  |  6.6 KB  |  147 lines
  1.  
  2.  ┌────────────────────────────────────────────────────────────────────────────┐
  3.  │ Module Player V1.3      (c) 1994,1995 by Lord Excess of Sound Wizards Int. │
  4.  └────────────────────────────────────────────────────────────────────────────┘
  5.  
  6.  
  7.  
  8.         USING THE SWMP DRIVERS WITH 'TURBO PASCAL 6.0'
  9.         ──────────────────────────────────────────────
  10.  
  11.          First of all you have to unzip the files of the included
  12.         archive PAS_SDK.ZIP to a location where the pascal compiler can
  13.         find them. This is either the directory where you keep your
  14.         source code or even better the Turbo Pascal directory itself.
  15.         The files you need in any case are:
  16.  
  17.               MODPLAY.TPU           : main unit
  18.               MODPLAY.PAS           : source code
  19.               DETECT.TPU            : fully automatic hardware detection
  20.               SB_DRV.TPU            : SoundBlaster driver
  21.               SBP_DRV.TPU           : SoundBlaster Pro driver
  22.               GUS_DRV.TPU           : Gravis UltraSound driver
  23.  
  24.          The rest are example files, which can be important to
  25.         understand things better. Now the only step to link all
  26.         mod-procedures and functions is to add the following statements
  27.         after your program heading:
  28.  
  29.               PROGRAM xxxxx;
  30.               {$M $4000,0,0}        : This sets the heap size to zero
  31.                                     : else the drivers cannot alloc memory
  32.               USES ModPlay;         : include unit ModPlay
  33.               ...
  34.               ..
  35.  
  36.          At program start you have to initialize this unit using the
  37.         following procedure:
  38.  
  39. ┌──INIT DRIVER─────────────────────────────────────────────────────────────────
  40. │       PROCEDURE Mod_Init(Driver,Port: WORD; IRQ,DMA: BYTE);
  41. │         -> Select and initialize driver for sound output
  42. │
  43. │            Driver = Detection         (0) :  Port = 0
  44. │                                              IRQ  = 0
  45. │                                              DMA  = 0
  46. │
  47. │                   = SoundBlaster      (1) :  Port = SB base address ($220..)
  48. │                                              IRQ  = SB IRQ#
  49. │                                              DMA  = 1 (always)
  50. │
  51. │                   = SoundBlaster_Pro  (2) :  Port = SBP base address
  52. │                                              IRQ  = SBP IRQ#
  53. │                                              DMA  = SBP DMA channel
  54. │
  55. │                   = Gravis_UltraSound (3) :  Port = GUS base address
  56. │                                              IRQ  = GF1 IRQ#
  57. │                                              DMA  = MIDI IRQ# !!
  58. └
  59.  
  60.          A very powerful hardware detection is able to detect any
  61.         supported soundcard with all required settings. So in general
  62.         the easiest way to init the drivers is:
  63.  
  64.                 MOD_Init(Detection,0,0,0);
  65.  
  66.  
  67.          If all fails you can override detection and select one of the
  68.         drivers by yourself, but in this case you have to know (or ask
  69.         for) the settings of an installed soundcard.
  70.  
  71.          If you want to know if initialisation was successfull, have a
  72.         look at the variable Soundcard (WORD), which will contain the
  73.         output device:
  74.  
  75.               0:        no sound available
  76.               1:        SoundBlaster            [ 22.2 kHz mono     ]
  77.               2:        SoundBlaster Pro        [ 21.7 kHz stereo   ]
  78.               3:        Gravis UltraSound       [ 44.1 kHz +stereo+ ]
  79.  
  80.          You do not have to handle this variable. You can also call the
  81.         driver's subfunctions even if no soundcard was detected,
  82.         nothing will happen in this case.
  83.  
  84.          At program end the unit selfrestores any altered interrupt
  85.         vectors etc.
  86.  
  87.          The following functions & procedures are available:
  88.         (Note: The first two procedures are enough to playback a mod !!!)
  89.  
  90. ┌──LOAD MODULE─────────────────────────────────────────────────────────────────
  91. │       PROCEDURE Mod_Load(FileName: STRING);
  92. │         -> Stops possible sound output, loads module file into memory,
  93. │            but does no start playing. If successful the variable
  94. │            Channels (WORD) will contain the number of channels, else zero.
  95. └
  96. ┌──PLAY MODULE─────────────────────────────────────────────────────────────────
  97. │       PROCEDURE Mod_Play(Looping: WORD);
  98. │         -> Starts playing previously loaded song. If looping is zero,
  99. │            song is played only once, else continuously.
  100. └
  101. ┌──STOP MODULE─────────────────────────────────────────────────────────────────
  102. │       PROCEDURE Mod_Stop;
  103. │         -> Stops sound output at once.
  104. └
  105. ┌──MAIN VOLUME─────────────────────────────────────────────────────────────────
  106. │       PROCEDURE Mod_Volume(Volume: BYTE);
  107. │         -> Changes the driver's main volume setting. Valid values are
  108. │            between 0 (lowest) and 64 (loudest).
  109. └
  110. ┌──STATUS──────────────────────────────────────────────────────────────────────
  111. │       FUNCTION Mod_Status: WORD;
  112. │         -> Returns 1 if sound is being played, else 0.
  113. └
  114. ┌──GET POSITION────────────────────────────────────────────────────────────────
  115. │       FUNCTION Mod_Position: WORD;
  116. │         -> Returns 256*PatternNumber+LineNumber. Can be useful to
  117. │            syncronize a special graphic effect to the sound.
  118. └
  119. ┌──JUMP BACK───────────────────────────────────────────────────────────────────
  120. │       PROCEDURE Mod_Rewind;
  121. │         -> Decreases current songposition. No effect in first pattern.
  122. └
  123. ┌──JUMP FORWARD────────────────────────────────────────────────────────────────
  124. │       PROCEDURE Mod_Forward;
  125. │         -> Increases current songposition. No effect in last pattern.
  126. └
  127.  
  128. ┌──PEAKS───────────────────────────────────────────────────────────────────────
  129. │       PROCEDURE Mod_Peak(VAR Peaks);
  130. │         -> Updates the array Peaks by copying the driver's volume
  131. │            setting (0..64) of each channel. The number of channels
  132. │            can be found in the variable Channels (WORD) and is either
  133. │            four, six or eight.
  134. └
  135.  
  136.  
  137.          In general it remains to be said that you can do as much error
  138.         checking as you like, but it is not necessary. In a demo or
  139.         intro for example you do not care if there is sound available
  140.         to the grafix you produce on the screen (in most cases). But in
  141.         a player it is evident that you need to have any sounddevice at
  142.         all to output the sound! The best way is to take a look at the
  143.         example programs. Have a lot of fun!
  144.  
  145.  
  146.                                                  Lord Excess in May '95
  147.