home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 1 / GoldFishApril1994_CD2.img / d4xx / d472 / iffbeep / iffbeep.man < prev    next >
Text File  |  1991-04-17  |  12KB  |  422 lines
  1.  
  2.  
  3. IFFBeep 2.00           Amiga User's Manual           IFFBeep 2.00
  4.  
  5.  
  6.  
  7.  
  8.         Overview 
  9.  
  10.         Those  of you who have used a M*cintosh will know that it
  11.         allows  you  to  select a digitised sound to be played as
  12.         the  system's "bell". Hey if the M*c can do it the so can
  13.         the  Amiga!.  IFFBeep  is  a simple program that replaces
  14.         the  screen  flash  code  of DisplayBeep() with a program
  15.         that  will  play  any  IFF 8SVX sound file when a call is
  16.         made  to  this  function. IFFBeep can also play different
  17.         sounds when a disk is inserted/removed from a drive.  
  18.  
  19.         IFFBeep  can  run  from  the CLI or workbench. If you run
  20.         IFFBeep  from  the  CLI  it  will automatically detach so
  21.         there is no need to use RUNBACK.  
  22.  
  23.         IFFBeep  does  require  ARP library to be present in your
  24.         LIBS:  directory.   A  copy of ARP.library is supplied on
  25.         the  distribution  disk and the installation program will
  26.         install it if you do not already have it.  
  27.  
  28.  
  29.         Installation 
  30.  
  31.         If  running  from  the  CLI  you  should set your default
  32.         directory  to  the  directory  that  contains the IFFBeep
  33.         distribution  files  and then execute the INSTALL_IFFBEEP
  34.         script: 
  35.           1> EXECUTE INSTALL_IFFBEEP 
  36.  
  37.         If  running  from the Workbench environment simply double
  38.         click  on  the  INSTALL  icon.  The  install program will
  39.         install IFFBeep on the current system disk.  
  40.  
  41.         This  install program will copy the IffBeep, BCP and Beep
  42.         programs  to  the  c:  directory.  It  will  install  the
  43.         ARP.Library  in  your LIBS: directory if it isn't already
  44.         there.  It  will  copy  the following files to your DEVS:
  45.         directory: 
  46.            IFFBeep.cfg 
  47.            SystemBeep 
  48.            DiskinSound 
  49.            DiskOutSound.  These   files  are,  respectively,  the
  50.         default  configuration  file,  the  default "beep" sound,
  51.         the  default  "disk inserted" sound and the default "disk
  52.         ejected" sound.  
  53.  
  54.  
  55.         Running IFFBeep 
  56.  
  57.         Once  you  have  installed  IFFBeep  you have a choice of
  58.  
  59.  
  60.                              Page 1
  61.  
  62.  
  63. IFFBeep 2.00           Amiga User's Manual           IFFBeep 2.00
  64.  
  65.  
  66.         ways  in which to run it.  The most convenient way to run
  67.         IFFBeep  is  to  install it in your startup-sequence.  In
  68.         this  case,  you would use the CLI syntax as shown below.
  69.         If  you  do  not  place  IFFBeep in your startup-sequence
  70.         then  you  can  either  start it from the CLI or from the
  71.         Workbench.  
  72.  
  73.  
  74.                 CLI Syntax 
  75.  
  76.         The CLI syntax for IFFBeep is as follows: 
  77.  
  78.             IFFBeep CONFIG <configfile> REMOVE 
  79.  
  80.         The  CONFIG  argument  allows  you  to specify the name a
  81.         configuration  file  created  with  BCP (see "The IFFBeep
  82.         Control  Panel"  below). If this argument is omitted then
  83.         the  default  configuration  file  (DEVS:IFFBeep.cfg)  is
  84.         used.   If  this  file  cannot be found then IFFBeep uses
  85.         internal  hard-coded  defaults.  If  IFFBeep  is  already
  86.         running  then  the  configuration details will be updated
  87.         using the data in the selected configuration file.  
  88.  
  89.         The  REMOVE  option  is  only valid if IFFBeep is already
  90.         running.  It  will  send  a  message  to the IFFBeep task
  91.         which  causes  it  to exit and return system operation to
  92.         normal.  
  93.  
  94.  
  95.                 Workbench Syntax 
  96.  
  97.         To  start  IFFBeep from the Workbench simply double-click
  98.         on  it's icon. Through the Workbench Info command you can
  99.         specify    one    tooltype    for    IFFBeep.   This   is
  100.         CONFIG=<configfile>.  This argument functions in the same
  101.         manner as the CLI CONFIG option.  
  102.  
  103.  
  104.         The IffBeep Control Panel 
  105.  
  106.         IffBeep  has  an  interactive control panel program, BCP.
  107.         When  run, BCP will get the current settings from IFFBeep
  108.         and  then  bring  up  a  small  window that allows you to
  109.         change these settings.  
  110.  
  111.         There  are two menus attached to this window. The Project
  112.         menu  allows  you to load and save configuration files as
  113.         well  as  iconise  BCP  and  remove IFFBeep.  When BCP is
  114.         iconised  you can open it up again by simply clicking the
  115.         right  mouse  button  after  selecting  the  small "Amiga
  116.         Tick"  window.  The  Event  menu allows you to select for
  117.         which  event  (Beep,  Disk  insertion  and Disk ejection)
  118.  
  119.  
  120.                              Page 2
  121.  
  122.  
  123. IFFBeep 2.00           Amiga User's Manual           IFFBeep 2.00
  124.  
  125.  
  126.         settings are displayed.  
  127.  
  128.         There  is  a slider that allows you to change the volume.
  129.         When  the  volume  button  is  clicked the sample will be
  130.         played  to  demonstrate  the  new volume. If you click on
  131.         the  "gradient" beside the volume slider, then the sample
  132.         will also be played.  
  133.  
  134.         The  "New  Sample"  gadget  will  bring  up  an  ARP file
  135.         requester  that allows you to select a new sound file. It
  136.         will  open up with the directory of the last loaded sound
  137.         file.  If  you  erase  this  and  press  return,  it will
  138.         display the directory you were in when you ran BCP.  
  139.  
  140.         The  check  box  above the "New Sample" gadget is used to
  141.         select whether or not the current event is activated.  
  142.  
  143.         The  two radio buttons and the integer gadget are used to
  144.         control  the  "memory  nice"  features  of  IffBeep  (see
  145.         Memory  below). If purge is enabled (top button) then the
  146.         value  in  the  integer  gadget  selects  the  number  of
  147.         seconds  after  the beep has been used that it is removed
  148.         from  memory.  The  bottom button deselects this feature.
  149.         If  you  are  loading your sample from a floppy disk that
  150.         you  want  to  take  out of the drive, and you can afford
  151.         the  memory,  then  I  suggest that you disable the purge
  152.         feature  and  click  on the gradient to load the sound in
  153.         immediately.  This  will  stop annoying volume requesters
  154.         coming  up  later  if  the  beep  is  called  but  not in
  155.         memory.  
  156.  
  157.  
  158.         Using the new beep.  
  159.  
  160.         Any  programs  which  currently  call  DisplayBeep() will
  161.         automatically  use the new code.  You can use the code in
  162.         your  own  programs by calling DisplayBeep. If you send a
  163.         Bell  character (Ascii code 7) to the Console device then
  164.         the beep will also be invoked.  
  165.  
  166.         Another  little  program,  called  Beep is included. This
  167.         lets you test your new beep.  
  168.  
  169.  
  170.         IFFBeep  will  must  store  the sound sample data in chip
  171.         RAM.  This  means  if  you  have a 10K sample then 10K of
  172.         chip  RAM will be used to store this sample. As an aid to
  173.         memory  conservation  IFFBeep  does  not  load the sample
  174.         until  it  is first needed. This means that you can place
  175.         IFFBeep  in your startup-sequence without it ever loading
  176.         the  sample.  Also, after a time without being called the
  177.         sample  will  be released from memory. This means you may
  178.  
  179.  
  180.                              Page 3
  181.  
  182.  
  183. IFFBeep 2.00           Amiga User's Manual           IFFBeep 2.00
  184.  
  185.  
  186.         get  a volume requester the next time the beep is needed.
  187.         Do  not panic! This is not a virus wanting to infect your
  188.         boot disk! 
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                              Page 4
  241.  
  242.  
  243. IFFBeep 2.00           Amiga User's Manual           IFFBeep 2.00
  244.  
  245.  
  246.  
  247.         Conditions and Credits 
  248.  
  249.         IffBeep  Version  2.0  is  ©  1990  by Paul Wilkinson. All
  250.         Rights  Reserved.  Anything  this  program  does  to your
  251.         machine   isn't  my  problem.  Anything  you  think  this
  252.         program  should do but doesn't isn't my problem (but send
  253.         me  any suggestions at the address below). Any money lost
  254.         due  to  the  performance  or lack of performance of this
  255.         program isn't my problem... (you get the idea).  
  256.  
  257.         IffBeep  is CharityWare. Under this system I suggest that
  258.         if  you  like and use this software then you make a small
  259.         donation  to  a local charity. I don't do this for money.
  260.         Some  other  guys  pay me to work on computers. I do this
  261.         because  it  is  fun!  If  you  like,  you  can send me a
  262.         picture-postcard of your town.  
  263.  
  264.         IFFBeep  may  be  freely  redistributed  as  long  as the
  265.         following conditions are observed: 
  266.  
  267.         1)  All Files are distributed as supplied in the original
  268.         distribution (ie. "as you get it") 
  269.  
  270.         2)   Only   a   "reasonable"  fee  is  charged  for  such
  271.         distribution.  
  272.  
  273.         3)  IFFBeep  may  not be used on "disk magazines" without
  274.         prior written consent from the author.  
  275.  
  276.         Contact the Author with any comments/criticisms at: 
  277.                              Paul Wilkinson
  278.                             24 Armstrong Ave.
  279.                               Mt. Warrigal
  280.                            NSW 2528 Australia
  281.                    or via Fido NetMail to 3:712/518.5
  282.  
  283.         Thanks to Peter Nicholson for the IFF sound routines.  
  284.  
  285.         This  program  is  dedicated  to the memory of Transactor
  286.         magazine.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.                              Page 5
  301.  
  302.  
  303. IFFBeep 2.00           Amiga User's Manual           IFFBeep 2.00
  304.  
  305.  
  306.  
  307.         History of Changes 
  308.  
  309.         Version 0.4 
  310.                 First release to Andrew Zahra for Alpha Test 
  311.  
  312.         Version 0.5 
  313.                 Many  improvements. NewBeep does not require full
  314.                 path  any  more.  Sound is only loaded when first
  315.                 needed.  Sound is unloaded if not called for more
  316.                 than 5 minutes.  
  317.  
  318.         Version 0.6 
  319.  
  320.                 First   version  of  BCP  released.  IffBeep  now
  321.                 requires  Arp.library  to  operate.   Recoded IFF
  322.                 routines  so  that  IffBeep no longer needs to be
  323.                 compiled +L under Manx.  
  324.  
  325.         Version 0.7 
  326.  
  327.                 IffBeep   now   detaches  from  CLI.  Changed  to
  328.                 compile  under Aztec 5.0.  Command line for sound
  329.                 file,  volume  and  purge time added to IffBeep &
  330.                 NewBeep. Added workbench support.  
  331.  
  332.         Version 1.00 
  333.  
  334.                 Added  remove  option  to IffBeep. Enabled Remove
  335.                 option  in  BCP.  Also  added Iconise facility to
  336.                 BCP.  Changed  bcp  so that it also detaches from
  337.                 parent  CLI.  Changed IffBeep so that it performs
  338.                 the  functions  of  the old newbeep program if an
  339.                 IffBeep  task is already running. Changed command
  340.                 line  arguments  for  IffBeep.  Now  uses  GADS()
  341.                 parsing from ARP.  
  342.  
  343.         Version 1.01 
  344.  
  345.                 Fixed  GURUs  when  sound  file  could not fit in
  346.                 memory 
  347.  
  348.         Version 2.00 
  349.  
  350.                 Major  rewrite  after  Hard  Disk crash (backups?
  351.                 What Backups?) 
  352.         Plans 
  353.                 Perhaps  a  "talking moose" type of thing where a
  354.                 randomly  selected  sound  is  played at a random
  355.                 time.   Perhaps   an   hourly  chime.  Perhaps  a
  356.                 workbench clock? 
  357.  
  358.  
  359.  
  360.                              Page 6
  361.  
  362.  
  363. IFFBeep 2.00           Amiga User's Manual           IFFBeep 2.00
  364.  
  365.  
  366.  
  367.                 Overview...................................    1
  368.  
  369.                 Installation...............................    1
  370.  
  371.                 Running IFFBeep............................    1
  372.                    CLI Syntax..............................    2
  373.                    WorkBench Syntax........................    2
  374.  
  375.                 The IffBeep Control Panel..................    2
  376.  
  377.                 Using the new beep.........................    3
  378.  
  379.                 Memory.....................................    3
  380.  
  381.                 Conditions and Credits.....................    5
  382.  
  383.                 History of Changes.........................    6
  384.                    Plans...................................    6
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.                              Page 7
  421.  
  422.