home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 176-200 / scopedisk190 / soundfx / sound.lzh / Sound.doc < prev    next >
Encoding:
Text File  |  1991-03-12  |  8.6 KB  |  177 lines
  1. *****************************  Sound.doc  ********************************
  2.  
  3.     Sound will attempt to feed <SOUNDfilename>'s data to the audio device.
  4. It will 'sound' files containing ANY kind of data, (try 'Sound Sound' :-)
  5. and of ANY length. If you have expansion memory, 'Sound' will store data
  6. in FAST ram, and use only 4-5 k. of CHIP ram to actually sound the data.
  7. This is the magic of 'double-buffering'. In addition, if you set the 'D'
  8. flag (for DIRECT_FROM_DISK), the sample will be played directly off the
  9. disk instead of first being loaded into FAST RAM. The advantage is that
  10. those with limited RAM can now hear those giant sized samples. The dis-
  11. advantage is that, depending on your disk speed, the sample size, stereo
  12. setting, samples/sec, how much multi-tasking is going on, and whether
  13. or not the sample is compressed, the sample may sound fragmented. This
  14. feature should be used to personal taste and necessity but will be
  15. automatically enabled if there is insufficient contiguous RAM available.
  16. When DIRECT_FROM_DISK is enabled, Sound will use most of the available
  17. CHIP RAM to help limit fragmenting.
  18.  
  19.    If the STEREO flag is turned ON,the data will be split and played in
  20. stereo. Otherwise, identical data is sent to left and right channels
  21. unless limited by the LEFT or RIGHT flags. (You MUST use a L or R flag
  22. if you only want this sound to use only 1 Amiga audio channel).
  23.  
  24.    Perfect Sound (tm) samples in stereo will automatically sound in stereo.
  25. These are the only stereo samples I've seen, so I don't know if the code
  26. used is universal (in IFF) for STEREO.
  27.  
  28.    Thanks to a lucid description of Fibonacci compression by Wesley Howe,
  29. (thanks, Wes!), Sound can now handle compressed IFF files.
  30.  
  31.     If called from workbench, (by doubleclicking on a project icon), Sound
  32. will search the 'ToolTypes' entries in the project icon for STEREO,
  33. VOLUME, END_VOLUME, CHANNEL, CYCLES, SAMPLES_PER_SECOND, EFFECT, and
  34. DIRECT_FROM_DISK. If found, these values will override any IFF values
  35. read from the SOUNDfile.
  36.  
  37.     If called from CLI, over-riding values for STEREO, CHANNEL, CYCLES,
  38. VOLUME, END_VOLUME, SAMPLES_PER_SECOND, EFFECT, and/or DIRECT_FROM_DISK
  39. may be specified in the command line.  (see below)
  40.  
  41.     If no settings for STEREO, CYCLES, CHANNEL, SAMPLES_PER_SECOND, VOLUME,
  42. FADE, and/or DIRECT_FROM_DISK are found, in the file itself or in the
  43. calling arguments, STEREO defaults to OFF, CYCLES to 1, left and right both
  44. on, SAMPLES_PER_SECOND to 10000, EFFECTS to OFF, DIRECT_FROM_DISK to OFF. In
  45. the special case where there is not enough contiguous memory to load the
  46. entire sample, DIRECT_FROM_DISK will be automatically turned on.
  47.  
  48. --------------------------------------------------------------------------
  49.                         *****   ABORT!   *****
  50.  
  51.    !!! Sound may be aborted by typing <CTRL> 'c' from the keyboard. !!!
  52.  
  53.   If <CTRL> 'c' does NOT abort the sound, click on the Sound 'Status'
  54.       line, (the top line), then <CTRL> 'c' again. 
  55.  
  56. --------------------------------------------------------------------------
  57.                    ***********  USAGE  ************
  58.  
  59. NOTE!!!  'Sound' should be in your 'c' directory, (ie, 'copy Sound c:'),
  60.            before the following USAGEs will work!
  61.  
  62.         USAGE: (from CLI)
  63.  
  64. Sound <filename> [SAMPLES_PER_SECOND] [vVOLUME] [eEND_VOLUME] [CYCLES] [FLAGS]
  65.  
  66.     The filename MUST be the first argument, then the other arguments
  67. may be in any order, or missing. (see below for valid values). Sound
  68. alone will display a USAGE message. Sound will 'sound' the file, then
  69. display the SAMPLES_PER_SECOND (if the file was found) and STEREO if
  70. the sample was played in stereo. use v (ie v48) to set volume to other
  71. than the default 64, or for effects using multiple cycles and e
  72. (end_volume). For example, 'SOUND WhosBad 6 v10 e64' will play the
  73. sample 6 times starting with the first at volume=10, and increasing
  74. with each cycle such that the last cycle is at volume=64. Fades can
  75. also be done within each cycle. See the fade and grow flags below.
  76.  
  77.         FLAGS:
  78.  
  79.    D or d = load the sample DIRECT_FROM_DISK (no FAST RAM buffer)
  80.    F or f = start volume from 64 and fade to 1 for each sample.
  81.    G or g = start volume from 1 and grow to 64 for each sample.
  82.    L or l = LEFT Channel only
  83.    R or r = RIGHT Channel only
  84.    S or s = toggles STEREO on/off <-- NOTE! changed from previous versions!
  85.    Q or q = disable the StatusLine that usually appears on the top line.
  86.    
  87. FLAGS should be separated by spaces: ie,  'Sound Sneeze 4 e20 l q'
  88.   will play 'sneeze' in the left channel four times, fading the volume
  89.   each cycle until the last cycle plays at volume=20. No status window
  90.   will be displayed. You may also use the full flag names if you wish for
  91.   any flag. So the above example could be: 'Sound Sneeze 4 E20 LEFT Quiet'
  92.  
  93.     Although maximum CYCLES = 65535, from CLI the maximum is 55.
  94.  
  95.  
  96.         USAGE: (from WorkBench)
  97.  
  98.    Double-'Click' on project icon whose Default Tool is set to 'c:Sound'.
  99.  
  100.      ToolTypes:   STEREO=      CYCLES=      SAMPLES_PER_SECOND=
  101.                   CHANNEL=     SOURCE=      DIRECT_FROM_DISK=
  102.                   VOLUME=      EFFECT=      END_VOLUME=
  103.  
  104.    Valid Values:  (these values stored in the .info file)
  105.  
  106.        CYCLES                 0 - 65535   0 = sound loops until aborted.
  107.                                            Use CONTROL-C to stop.
  108.        SAMPLES_PER_SECOND  1000 - 65535   greater than 30000 seems to have
  109.                                            no effect, but MAX = 64k.
  110.        VOLUME                  1  - 64    How loud it starts. default=64
  111.        END_VOLUME              1  - 64    How loud the last cycle starts.
  112.        CHANNEL             RIGHT or LEFT  (r or l) Useful for effects.
  113.        EFFECT                FADE - GROW  Changes volume over single cycle
  114.                                            from 1-64 (GROW) or 64-1 (FADE).
  115.        STEREO                ON -   OFF   default=off. Not case sensitive.
  116.                                            File is split left/right.
  117.        DIRECT_FROM_DISK      ON  -  OFF   Don't load into RAM first.
  118.        SOURCE                 any text    Where did this sound come from?
  119.        AUTHOR                 any text    Immortality, if ya want it...
  120.        
  121. --------------------------------------------------------------------------
  122.                  ********  ARGUMENT PRIORITIES  *******
  123.  
  124.    Arguments from CLI or in the WorkBench Icon override any IFF info.
  125.  
  126.               IFF file info overrides the default values.
  127.  
  128.     Defaults: STEREO = off, CYCLES = 1, both CHANNELS, VOLUME = 64,
  129.                    SAMPLES_PER_SECOND = 10000,   FADE = OFF
  130.  
  131. --------------------------------------------------------------------------
  132.                     *********  REVISIONS  *********
  133.  
  134. MAY 1988  -  Initial release.
  135.  
  136. DEC 1988  -  Added multiple icon select, double buffering, QUIET flag.
  137.  
  138. DEC 1989  -  Now shows soundfile name in status bar.
  139.              No longer crashes if all 4 audio channels are already in use.
  140.  
  141. JAN 1990  -  No longer gives incorrect error warnings on 2500/30's.
  142.  
  143. FEB 1990  -  Handles standard IFF de-compression.
  144.              Changed some input formats to allow adding:
  145.                VOLUME, END_VOLUME, FADE, GROW, and DIRECT_FROM_DISK.
  146.              Automatically adjusts period for PAL/NTSC clock rate diff.
  147.              Re-compiled with Aztec 5.0a
  148.  
  149. --------------------------------------------------------------------------
  150.     Sound is copyright 1988,90 by Richard Lee Stockton, 21305 60th Ave W.,
  151. Mountlake Terrace, Washington 98043, 206/776-1253(voice), but may be freely
  152. distributed as long as no profit is made from its distribution or sale
  153. without my written permission. I call this concept 'FreeWare', you can
  154. call it whatcha want.
  155.  
  156. NOTE: Sound has been compacted using PowerPacker 2.3b. (42% savings)
  157.  
  158.     I also released the source code, (Manx 5.0a), in the hope that it
  159. will be of benefit to someone in the Amiga programming community. Feel
  160. free to alter it at will, (but at your own risk!). I _would_ appreciate
  161. receiving a copy of whatever it may become, and it is always nice to be
  162. credited, (perhaps just a few lines of glowing tribute.^).
  163.  
  164.               Long Live Leo and All the Little Schwabie's!
  165.  
  166.      Included in this arc file are a sample project icon and its related
  167. data file (WhosBad.info and WhosBad) as well as Sound, & this file.
  168. WhosBad is a COMPRESSED STEREO sound sample made with Perfect Sound.
  169. Feel free to design your own icons, any project icon should work. Just
  170. make the Default Tool in the icon 'c:Sound'.
  171.  
  172.      Please try to keep all these files together when distributing as
  173.      every little bit may be of help!
  174.                                           Stay Warm & Enjoy!  - Richard
  175.  
  176. ***************************** Sound.doc **********************************
  177.