home *** CD-ROM | disk | FTP | other *** search
/ AMOS PD CD / amospdcd.iso / samples / sound.doc < prev    next >
Text File  |  1990-01-06  |  6KB  |  124 lines
  1. *****************************  Sound.doc  ********************************
  2.  
  3.     Sound is copyright (c) 1988 by Richard Lee Stockton, 21305 60th Ave W.,
  4. Mountlake Terrace, Washington 98043, 206/776-1253(voice), but may be freely
  5. distributed as long as no profit is made from its distribution or sale
  6. without my written permission. I call this concept 'FreeWare', you can
  7. call it whatcha want.
  8.  
  9.     I also include the source code, (Manx 3.4/3.6), in the hope that it
  10. will be of benefit to someone in the Amiga programming community. Feel
  11. free to alter it at will, (but at your own risk!). I _would_ appreciate
  12. receiving a copy of whatever it may become, and it is always nice to be
  13. credited, (perhaps just a few lines of glowing tribute.^).
  14.  
  15.               Long Live Leo and All the Little Schwabie's!
  16.  
  17. --------------------------------------------------------------------------
  18.                    ********  DESCRIPTION  ********
  19.  
  20.     Sound will attempt to feed <SOUNDfilename>'s data to the audio device.
  21. It will 'sound' files containing ANY kind of data, (try 'Sound Sound' :-)
  22. and of ANY length. If you have expansion memory, 'Sound' will store data
  23. in FAST ram, and use only 4-5 k. of CHIP ram to actually sound the data.
  24. This is the magic of 'double-buffering'.
  25.  
  26.    If the STEREO flag is turned ON,the data will be split and played in
  27. stereo. Otherwise, identical data is sent to left and right channels.
  28. Perfect Sound (tm) samples in stereo will automatically sound in stereo.
  29. These are the only stereo samples I've seen, so I don't know if the code
  30. used is universal (in IFF) for STEREO.
  31.  
  32.     If called from workbench, (by doubleclicking on a project icon), Sound
  33. will search the 'ToolTypes' entries in the project icon for 'STEREO',
  34. 'CHANNEL', 'CYCLES', and 'SAMPLES_PER_SECOND'. If found, these values will
  35. override any IFF values read from the SOUNDfile.
  36.     Extended WorkBench selection is supported. Hold down the shift key
  37. and select a group of soundfiles. Double click the last one to hear them
  38. 'sound'ed in order.
  39.  
  40.     If called from CLI, over-riding values for STEREO, CHANNEL, CYCLES,
  41. and/or SAMPLES_PER_SECOND may be specified in the command line. (See below)
  42.  
  43.     If no settings for STEREO, CYCLES, CHANNEL, and/or SAMPLES_PER_SECOND
  44. are found, in the file itself or in the calling arguments, STEREO defaults
  45. to OFF, CYCLES to 1, left and right both on, and SAMPLES_PER_SECOND to 10000.
  46.  
  47. --------------------------------------------------------------------------
  48.                         *****   ABORT!   *****
  49.  
  50.    !!! Sound may be aborted by typing <CTRL> 'c' from the keyboard. !!!
  51.  
  52.   If <CTRL> 'c' does NOT abort the sound, click on the Sound 'Status'
  53.       line, (the top line), then <CTRL> 'c' again. 
  54.  
  55. --------------------------------------------------------------------------
  56.                    ***********  USAGE  ************
  57.  
  58. NOTE!!!  'Sound' should be in your 'c' directory, (ie, 'copy Sound c:'),
  59.            before the following USAGEs will work!
  60.  
  61.         USAGE: (from CLI)
  62.  
  63. Sound <filename> [CHANNEL] [STEREO] [CYCLES] [SAMPLES_PER_SECOND] [QUIET]
  64.  
  65.     The filename MUST be the first argument, then the other arguments
  66. may be in any order, or missing. (see below for valid values). Sound
  67. alone will display a USAGE message. Sound will 'sound' the file, then
  68. display the SAMPLES_PER_SECOND (if the file was found) and STEREO if
  69. the sample was played in stereo.
  70.  
  71.     There is one additional command when called form CLI (or a scriptfile)
  72. QUIET or just q will disable the StatusLine that usually appears on the
  73. top line.
  74.  
  75. (SAMPLES_PER_SECOND=10000 probably means it wasn't an IFF sound file.)
  76.  
  77.     Although maximum CYCLES = 65535, from CLI the maximum is 55.
  78.  
  79.  
  80.         USAGE: (from WorkBench)
  81.  
  82.    Double-'Click' on project icon whose Default Tool is set to 'c:Sound'.
  83.    Extended selection is supported. See above.
  84.  
  85.      ToolTypes:   STEREO=      CYCLES=      SAMPLES_PER_SECOND=
  86.                   CHANNEL=     SOURCE=      AUTHOR=
  87.  
  88.    Valid Values:  (these values stored in the .info file)
  89.  
  90.        STEREO                ON -   OFF   default=off. Not case sensitive.
  91.                                            File is split left/right.
  92.        CYCLES                 0 - 65535   0 = sound loops until aborted.
  93.                                            Use Abort Button to stop.
  94.        SAMPLES_PER_SECOND  1000 - 65535   greater than 30000 seems to have
  95.                                            no effect, but MAX = 64k.
  96.        CHANNEL            RIGHT or LEFT   (r or l) Useful for effects.
  97.        SOURCE                 any text    Where did this sound come from?
  98.        AUTHOR                 any text    Immortality, if ya want it...
  99.        
  100. --------------------------------------------------------------------------
  101.                  ********  ARGUMENT PRIORITIES  *******
  102.  
  103.    Arguments from CLI or in the WorkBench Icon override any IFF info.
  104.  
  105.               IFF file info overrides the default values.
  106.  
  107.     Defaults: STEREO = off, CYCLES = 1, both CHANNELS,
  108.                    SAMPLES_PER_SECOND = 10000
  109.  
  110. --------------------------------------------------------------------------
  111.                      *******  OTHER STUFF  *******
  112.  
  113.      Included in this arc file are a sample project icon and its related
  114. data file (Gunshot.info and Gunshot) as well as Sound, Sound.c and this
  115. file. The source code was compiled using Manx Aztec 3.6.
  116.  
  117.      Feel free to design your own icons, any project icon should work.
  118. Just make the Default Tool in the icon 'c:Sound' and make sure that Sound
  119. is in your 'c' directory.
  120.  
  121. updated 12-2-88                           Stay Warm & Enjoy!  - Richard
  122.  
  123. ***************************** Sound.doc **********************************
  124.