home *** CD-ROM | disk | FTP | other *** search
/ Sound Sensations! / sound_sensations.iso / miscprog / alarm410 / atc.doc < prev    next >
Encoding:
Text File  |  1988-02-15  |  8.0 KB  |  191 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                          ATC : The Alarm Tune Compiler
  7.                            Version 1.01, 15-Feb-1988
  8.                           ATP : The Alarm Tune Player
  9.                            Version 1.10, 15-Feb-1988
  10.                                   SMG Software
  11.  
  12.                            (C) Copyright 1987,1988 by
  13.                                Steven Georgiades
  14.                               All Rights Reserved
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.          ATC  is the Alarm Tune Compiler,  a  program which will allow  the
  23.     user to convert a music source file (MSF) to a binary format compatible
  24.     with  the ALARM Memory Resident Alarm Clock Program,  and the ATP Alarm
  25.     Tune Play utility.   The MSF format is described on the following page.
  26.     The ATC program is invoked as follows:
  27.  
  28.          ATC msffile [tunefile]
  29.  
  30.     where  msffile is the filename of the input MSF file,  and tunefile  is
  31.     the  name of the output binary tune file.   If the extension is omitted
  32.     from  msffile,  a  default of ".MSF"  is assumed.   For tunefile,   the
  33.     default  extension  is ".TUN".   If tunefile is omitted entirely,   the
  34.     output file will have the same base name as msffile, with the extension
  35.     ".TUN".    Both  the msffile and tunefile may optionally have  a  drive
  36.     letter  and/or path specification.   The resulting binary tune file  be
  37.     played using the ATP utility, as follows:
  38.  
  39.          ATP tunefile
  40.  
  41.     As with ATC,  if the extension is omitted from tunefile, ATP assumes an
  42.     extension of ".TUN".
  43.  
  44.     ATC, Version 1.10                                                Page 2   
  45.  
  46.  
  47.  
  48.     MUSIC SOURCE FILE FORMAT
  49.  
  50.          The  Music Source File (MSF)  is a simple ASCII file which may  be
  51.     created  with  any text editor,  or word processor with an  ASCII  save
  52.     option.  The MSF format consists of only a few commands.
  53.          Comments  may appear after any command on the same line,  or on  a
  54.     line by themselves.  A comment is defined by a leading semi-colon.  All
  55.     text following a semi-colon is assumed to be part of a comment,  and is
  56.     therefore ignored.   Note also that ATC ignores blank lines, so you may
  57.     insert blank lines for readability (to seperate measures, for example).
  58.          The  first command in an MSF file must be a Name Command,  and the
  59.     second must be a Tempo Command.   These commands are not optional,  and
  60.     must  appear only once in any MSF file.   Comment lines and blank lines
  61.     are permitted to preceed the Name Command and the Tempo Command.
  62.  
  63.  
  64.  
  65.  
  66.     Name Command
  67.     ____________
  68.  
  69.          Ntunename
  70.  
  71.          The  name  command  specifies the  tune name to  insert  in   the
  72.          tune  file,  for  use by the  ALARM program.    The text of   the
  73.          name  immediately   follows the  command  letter "N",    with   no
  74.          quotes or other delimiters necessary.    The tunename must   be
  75.          no  more   than  32   characters  in length.     If more   than   32
  76.          characters are given,  only  the first 32   are taken,  and  the
  77.          remainder are discarded.
  78.  
  79.      Tempo Command
  80.      _____________
  81.  
  82.          Tval
  83.  
  84.          The  tempo command specifies the  basic tempo or speed of   the
  85.          tune.   The "val"  may  be any number from  11 to 1200,  and  is
  86.          approximately  equal   to   the  number of   Basic   Timing   Units
  87.          (BTU's) per 10-second interval.
  88.  
  89.     ATC, Version 1.10                                                Page 3   
  90.  
  91.  
  92.  
  93.     MUSIC SOURCE FILE FORMAT (Continued)
  94.  
  95.  
  96.     Play Command
  97.     ____________
  98.  
  99.          Pdur[,[note1][,[note2][,[note3]]]]
  100.  
  101.          Where "dur" is the duration of the note in terms of the Basic
  102.          Timing Unit (BTU,  defined by the tempo).  I tend to  consider
  103.          the sixteenth note as the BTU, so that "dur"  for a 16th  note
  104.          would be 1, for a quarter note it would be 4, and for a whole
  105.          note, 16.  You may want to use the 32nd note as your BTU,   or
  106.          a  quarter note.    It  is entirely arbitrary.    Just   remember
  107.          that  the  tempo really  relies on your chosen  BTU as well   as
  108.          the tempo value selected.    The entries "note1", "note2"   and
  109.          "note3"   are the three optional  notes that make up the  chord
  110.          to be played.  Each note consists of 2 or 3 characters.    The
  111.          first  character  is  a numeral  from 0 to  7  indicating   which
  112.          octave the note is in.  The second character is a letter from
  113.          A  to  G,   defining what  note in that  octave is  to  be   used.
  114.          Note  that ATC considers the lowest note in each octave to  be
  115.          an  A,    and   the highest  is  a G.     The  third   character   is
  116.          optional,   and can  be either a  + or a  -.   A   plus means   to
  117.          increase  the note  by one  half step (sharp),   while  a   minus
  118.          means  to decrease  the note by  one half step  (flat).    If   a
  119.          note  is   omitted   or  substituted  with an  "R",    a    rest   is
  120.          assumed, and if a note is substituted with an asterisk ("*"),
  121.          the  note for that voice is assumed  to be the same as in   the
  122.          previous chord.
  123.  
  124.  
  125.     End Command
  126.     ___________
  127.  
  128.          E
  129.  
  130.          When  this command  is encountered,  ATC  stops processing   the
  131.          input file and terminates.
  132.  
  133.  
  134.     If this format is unclear,  look  at some of the ".MUS"  files  supplied.
  135.     They can be informative.
  136.  
  137.     ATC, Version 1.10                                                Page 4   
  138.  
  139.  
  140.  
  141.          The  ATC  and  ATP programs  are subsidiary utilities  of  the   ALARM
  142.     program, and are distributed as ShareWare.  "ShareWare"  means that  you
  143.     are  granted free  license to  use,  copy and  distribute  this   software,
  144.     within the following restrictions:
  145.  
  146.          1).  It must be distributed  in its original,  unmodified   form,
  147.               including program, documentation and all associated files.
  148.  
  149.          2).  No  fee may  be charged  for use,   copying  or   distribution
  150.               (With the exception of nominal "per disk" copying charges,
  151.               not to exceed $6.00 per disk).
  152.  
  153.          3).  The  program   may   not  be included   with   other   goods   or
  154.               services supplied for a fee,  unless written permission  to
  155.               do so is obtained in advance from the author.
  156.  
  157.     Although distributed as part of the ALARM program, feel free to use and
  158.     distribute  ATC   and ATP  independently of  ALARM.    For  information   on
  159.     registering  or  obtaining  source code  for ATC  and ATP,   refer  to   the
  160.     ALARM program documentation.
  161.  
  162.          This program is provided AS IS without any warranty,  expressed  or
  163.     implied,  including but not limited  to fitfulness for a particular   use
  164.     or purpose.   Neither the author  nor SMG Software assume liability   for
  165.     any damages incurred through the use of the program.
  166.  
  167.          If you have any problem,  or feel you have found a bug in these  or
  168.     any other SMG programs, please let me know.  I also welcome any and all
  169.     questions    and   comments.       Address   all   correspondence     (including
  170.     registrations) to the following address:
  171.  
  172.                    Steven Georgiades
  173.                    SMG Software
  174.                    701-H South Hayward Street
  175.                    Anaheim, CA  92804
  176.  
  177.     Or leave a message for me on the Circuit Board:
  178.  
  179.                    The Circuit Board RBBS
  180.                    SysOp: Dave Kleinschmidt
  181.                    (714) 778-0948
  182.                    1200/2400 Baud, No Fee
  183.  
  184.     All  SMG   Software   is initially  released  to  the   public   through   the
  185.     Circuit  Board.   The  latest version of any  SMG Software can always   be
  186.     found there.
  187.  
  188.     A diskette containing all of the latest SMG Software can be obtained by
  189.     sending  a check or money  order for $6.00  to  the above address.    Make
  190.     all checks payable to Steven M. Georgiades.  Thank you.
  191.