home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsc / computils / !CompUtils / Resources / LoadCSamp / Docs
Encoding:
Text File  |  1996-03-30  |  3.8 KB  |  95 lines
  1. ############################################################################
  2. #                                                                          #
  3. #                           LoadCSamp application                          #
  4. #                                                                          #
  5. #==========================================================================#
  6. #                                                                          #
  7. #                             by David Radford                             #
  8. #                                                                          #
  9. #==========================================================================#
  10. #                                                                          #
  11. #     These files are a part of !CompUtils and may not be distributed      #
  12. #         separately other than as laid down in the !ReadMe file.          #
  13. #                                                                          #
  14. ############################################################################
  15.  
  16. Overview
  17. ========
  18.  
  19. This directory contains a series of Absolute files that form *the* simplest
  20. way to use compressed samples. There is one Absolute file for each group of
  21. sample types supported in this release of !CompUtils, plus a Universal
  22. version which will decompress any sample type presently defined.
  23.  
  24. These absolute files are intended to be used in mono-tasking applications,
  25. games, etc. They decompress the file given in the command line into a block
  26. of RMA, then install a module for it providing a standard RISC OS voice
  27. generator.
  28.  
  29. The files are in two distinct flavours: fixed-pitch and variable-pitch.
  30. Fixed-pitch samples will always play at the correct speed *provided* the
  31. hardware's DMA period matches the sample period of the sample you're trying
  32. to play. The variable pitch versions are more flexible in that they can be
  33. played at any pitch, but this can often be a right pain if you don't want
  34. it!
  35.  
  36. If even LoadCSamp is too complicated for you, then you shouldn't even be
  37. *thinking* of writing a serious program!
  38.  
  39.  
  40. Using LoadCSamp
  41. ===============
  42.  
  43. Choose an appropriate Absolute file depending on the sample format(s) your
  44. program needs to be able to cope with and copy it into your application's
  45. directory as 'LoadCSamp'. In your application's !Run file include lines of
  46. the form:
  47.  
  48.     Run <codename> <sample> [<module name>]
  49.  
  50. where <codename> is the filename of the Absolute file, <sample> is the
  51. filename of the compressed sample to load, and <module name> is the
  52. name to give the resulting module. If omitted, the module's name is taken as
  53. the leafname of the file.
  54.  
  55. For example:
  56.  
  57.     Run <Obey$Dir>.LoadCSamp <Obey$Dir>.Samples.MySample
  58.  
  59. or:
  60.  
  61.     Run <Obey$Dir>.LoadCSamp <Obey$Dir>.Plobby WackyNoise
  62.  
  63. Remember to use a Sound_Configure SWI somewhere in your program to set the
  64. hardware's DMA period! (48us should be fine for most cases.)
  65.  
  66.  
  67. Memory
  68. ======
  69.  
  70. You should allocate the applications a small amount of memory to run in
  71. before trying to use them. For example:
  72.  
  73.     *WimpSlot -min 32K -max 32K
  74.     
  75. All applications have been squeezed to reduce the amount of memory needed to
  76. store them on disc. Unfortunately this also means that if there is
  77. insufficient memory to run them, you most likely will *not* get a proper
  78. warning but an 'Abort on data transfer'. The solution is to increase the
  79. wimp slot slightly. There is nothing I can do about this - it's the fault of
  80. Acorn's !Squeeze utility.
  81.  
  82.  
  83. Copyright
  84. =========
  85.  
  86. Remember: all versions of LoadCSamp are copyright, as are any modules they
  87. produce. Normally, use in programs (be they commercial or freeware) is
  88. totally free of charge. See the !ReadMe file in the main directory for more
  89. information on copyright details and contact addresses.
  90.  
  91.  
  92.                         (c) David Radford 1995-1996
  93.  
  94.  
  95.