home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / coders / sources / custplay / readme.doc < prev   
Text File  |  1997-08-13  |  3KB  |  100 lines
  1.  
  2.             ASSEMBLER CUSTOM PLAYER V1.1
  3.         MIKAEL LUND, JANUARY 1997 - CODED IN ASMONE
  4.  
  5. Introduction:
  6.  
  7. This is an assembler source for using delitracker custom-modules in your own
  8. code. It works almost like any other player where you need to call Init, Play
  9. and End routines.
  10.  
  11.  
  12. Usage:
  13.  
  14. In the top of your source you should include "custplay.i". Then you must set
  15. the variables and call the subroutines explained below.
  16. The custom-module you wish to use must NOT contain any hunks - which they
  17. normally do. Therefore you must use a resource program that can convert these
  18. hunks into source sections. Then place the source-version of the module in your
  19. own source and label it CP_DATA.
  20. Also you could load the custum-module as an object (RO in asm-one) and then
  21. point CP_DATA to the first loaded address.
  22.  
  23.  
  24. Variables:
  25.  
  26. CP_DATA        This is the address where you must place your 'dehunked' custum
  27.         module.
  28.  
  29. CP_SPEED    <byte>
  30.         This address controls the play-speed. 1 is fastest.
  31.  
  32. CP_SUBSONG    <word>
  33.         Here the subsong is set (if any).
  34.  
  35.  
  36. Subroutines:
  37.  
  38. CP_GETDATA    Reads some important data from the custom-module. You should
  39.         call this subroutine before anything else.
  40.  
  41. CP_INIT        Initializes soundroutine - Must be called before starting any
  42.         interrupts. Also it must be called when changing subsong.
  43.         Before calling this you should set the variables.
  44.  
  45. CP_PLAY        Playing sound - Call from your interrupt.
  46.  
  47. CP_STARTI    Some modules have their own interrupt-routine. If this is the
  48.         case you should not use the CP_PLAY call but simply call
  49.         CP_STARTI once.
  50.  
  51. CP_STOPI    Stops the custom-interrupt routine. Call this when you want
  52.         to end the interrupt started with CP_STARTI
  53.  
  54. CP_END        End-(stop)routine. Call this when you are finished playing.
  55.  
  56.  
  57. Otherdata:
  58.  
  59. CP_MINSONG    <byte>
  60.         Minimum sub-song number
  61.  
  62. CP_MAXSONG    <byte>
  63.         Maximun sub-song number
  64.  
  65. CP_INTERRUPT    <longword>
  66.         The address for the playroutine. = 0 if the module have it's own
  67.         interrupt.
  68.  
  69. CP_STARTINT    <longword>
  70.         The address for the custom-interrupt. = 0 if the module must be
  71.         played using CP_PLAY
  72.  
  73.         In rare cases the module contains both CP_INTERRUPT and
  74.         CP_STARTINT addresses. Here you must try which one works best.
  75.         An example is "cust.the_plague"
  76.  
  77.  
  78. History:
  79.  
  80. 1.1        · Examples now in pure ASCII-format
  81.         · Example 1 made shorter (different module)
  82. 1.0        · First release on Aminet
  83.  
  84. If you can make any additions to ACustplay, then feel free to do so - spread
  85. it as much as you like. Just remember to send me a copy too.
  86. Mail me if you're using ACustPlay in your productions - It would be nice to
  87. know if someone is actually using this package:)
  88.  
  89.  
  90. Author:
  91.  
  92. adr:    Mikael Lund
  93.     Mannerupvej 5
  94.     4000 Roskilde
  95.     Denmark
  96.  
  97. e-mail:    ki9656@unidhp.uni-c.dk
  98.  
  99. phn:    +45 46496115
  100.