home *** CD-ROM | disk | FTP | other *** search
/ PC Format Collection 5 / PCFORMAT5.iso / MODPLAY / PLAYIT.DOC < prev    next >
Encoding:
Text File  |  1990-10-21  |  9.4 KB  |  298 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                                PLAYITPLAYIT
  15.  
  16.  
  17.  
  18.                       A MUSIC PLAYING PROGRAM
  19.                       A MUSIC PLAYING PROGRAM
  20.  
  21.                               for the
  22.  
  23.                      I.B.M PC/AT and Compatibles
  24.  
  25.  
  26.  
  27.                           by John S. Smith
  28.                            c/o 'Rosemont'
  29.                             Hawthorn Rd
  30.                               Beaufort
  31.                              Ebbw Vale
  32.                                Gwent
  33.                            United Kingdom
  34.  
  35.  
  36.  
  37.  
  38.  
  39.                 Copyright (C) 1989 by John S. Smith
  40.                 Copyright (C) 1989 by John S. Smith
  41.                         All Rights Reserved___ ______ ________
  42.  
  43.  
  44.  
  45.  
  46.  
  47.            The PLAYIT diskette containing a copy of this
  48.          document is distributed under the Shareware scheme
  49.          and may be freely copied provided that none of the
  50.            files thereon are modified in any way. Printed
  51.            copies of the documentation may not be copied
  52.         without the express written permission of the author
  53.  
  54.         PLAYIT Guide                              PLAYIT.DOC
  55.  
  56.  
  57.  
  58.         PLAYIT.DOC  -- Instructions  for  using  the  PLAYIT
  59.         program for PC Compatible Machines.
  60.  
  61.         This  document  describes  PLAYIT  version   1.0.  A
  62.         program for producing melodies  on  the  IBM  PC and
  63.         compatible computers. This documentation and program
  64.         (PLAYIT.exe)  are copyright (c) by J. Smith  October
  65.         1990.
  66.         All rights reserved.
  67.  
  68.         Synopsis
  69.         PLAYIT will play a  melody  from  data supplied in a
  70.         data file. The data specifies the  duration  of each
  71.         note  and  its  pitch.  Each   line   in   the  file
  72.         corresponds to just one note with  the  exception of
  73.         the lines which specify  triplets  or  other groups.
  74.         Triplets  and groups of up to  nine  in  number  are
  75.         allowed on a single  line.  The  program  will allow
  76.         about 1000 notes total. The duration of notes ranges
  77.         from a demisemiquaver to a triple dotted  minim. All
  78.         notes in that range may  have one, two or three dots
  79.         after it. As well  as  notes,  rests are allowed and
  80.         are specified in a  similar  way  to notes. The file
  81.         may contain comment lines  and  this  is  useful and
  82.         typically used to show bar  lines  for  easy editing
  83.         later.  The  tempo  of  the  melody  may  be changed
  84.         dynamically by indication in the data file. There is
  85.         also a 'baton' feature whereby a  symbol  appears on
  86.         the  screen  just  as  each  note  starts  to sound.
  87.         Additionally, the file may contain an instruction to
  88.         indicate (on screen) when a particular point  in the
  89.         melody has been reached.
  90.         There is also a real-time text  message  facility to
  91.         output messages while the tune plays.
  92.  
  93.         The  Shareware version of this program contains  all
  94.         the features  described  below  except  that  it  is
  95.         confined to about  2 octaves. The registered version
  96.         allows access to a full six octaves.
  97.  
  98.         Installation
  99.         Simply  copy  the file PLAYIT.EXE  and  the  example
  100.         music   datafile   called    HORNPIPE    from   your
  101.         distribution disc to your  working  disc.  Then type
  102.         PLAYIT to run it. PLAYIT  must  be  in  your current
  103.         PATH  of  course  (see  your  DOS  documents  for  a
  104.         description of PATH).
  105.  
  106.  
  107.         Getting started.
  108.         As not many people like to read all the blurb before
  109.         starting,  an  example  music  file is supplied with
  110.         PLAYIT.EXE.  TO run  it,  type  PLAYIT HORNPIPE  and
  111.  
  112.  
  113.  
  114.  
  115.         A Shareware Program       page 2       October, 1990
  116.  
  117.         PLAYIT Guide                              PLAYIT.DOC
  118.  
  119.  
  120.  
  121.         sounds should emanate from your PC.  (Make  sure the
  122.         volume control is turned up!!)
  123.  
  124.         A registered version may be obtained from:
  125.         John Smith
  126.         c/o "Rosemont"
  127.         Hawthorn Road
  128.         Beaufort
  129.         Ebbw Vale
  130.         Gwent
  131.         S. Wales
  132.         U.K.
  133.  
  134.         For a fee of 17 pounds sterling + 2  pounds  p&p  in
  135.         the U.K. and 3 pounds  for  anywhere  else.   Please
  136.         specify 3.5" or 5.25" disc.
  137.  
  138.         The program will run on virtually any compatible PC.
  139.         No special display or hardware  is  required  as all
  140.         output is ascii  text  and  the  program  drives the
  141.         system speaker.
  142.  
  143.         Language Description for PLAYIT.exe
  144.  
  145.         A input  file containing the notes to be played must
  146.         be created.
  147.         Any normal text editor or word processor may be used
  148.         to prepare the input file but the file MUST be plain
  149.         text and contain no special  word-processor embedded
  150.         control characters. Eg Wordstar must create the file
  151.         in TEXT MODE.
  152.  
  153.         PLAYIT does a reasonable  amount  of  error checking
  154.         and catches the most likely errors: it has proved to
  155.         be quite effective in practice.
  156.  
  157.  
  158.         Within the file a series of lines define the melody.
  159.         Items  on  a  line must be separated by at least one
  160.         space.
  161.  
  162.         Each line defines a note with two parameters:
  163.         1. Duration
  164.         2. Pitch
  165.         Duration
  166.         The duration  can  be  from  a  demisemiquaver  to a
  167.         triple dotted minim using the  first  letter  of the
  168.         note's name only. The letters are:
  169.         d - demisemiquaver
  170.         s - semiquaver
  171.         q - quaver
  172.         c - crotchet
  173.         m - minim
  174.  
  175.  
  176.  
  177.  
  178.         A Shareware Program       page 3       October, 1990
  179.  
  180.         PLAYIT Guide                              PLAYIT.DOC
  181.  
  182.  
  183.  
  184.         The note letter may  be  followed  by  an 'r' if the
  185.         note is a <rest>. eg
  186.         qr - quaver rest.
  187.         The note/rest name may  be  followed  by from one to
  188.         three dots. eg
  189.         qr... - triple dotted quaver rest.
  190.  
  191.         Pitch
  192.         There are six octaves: from  c2  to  c8  inclusive -
  193.         middle c is c4.
  194.         All notes within this range may be  obtained. Sharps
  195.         and  flats  are  obtained  by  using  a  +  or  a  -
  196.         respectively. eg
  197.         c4+ is c4 sharp.
  198.         Example of a note:
  199.         q. c4+
  200.         defines a dotted quaver, c sharp (d flat).
  201.  
  202.         Comments
  203.         Any line beginning with a \ is ignored
  204.  
  205.  
  206.         Blank lines are  ignored  and may be used to improve
  207.         readability
  208.  
  209.  
  210.         Screen display
  211.         Any line beginning with a '>', causes an  '|'  to be
  212.         output to the screen in real time at  that  point in
  213.         the melody plays.
  214.  
  215.         Baton
  216.         The baton is turned on  by including a line that has
  217.         just a singlr 'B' on it. If there is  such  a  line,
  218.         then a '.' is displayed  just as each note begins to
  219.         play. The baton cannot be turned off once it is on.
  220.  
  221.         Messages
  222.         A message line is any line starting with an asterisk
  223.         character (*) and followed  by  a  text  message. No
  224.         space is needed  after  the  '*'  and  the following
  225.         message. The message is displayed on  the  screen at
  226.         that point in the melody  ie in real time sync. Good
  227.         for advertising purposes?
  228.  
  229.         Tempo
  230.         The tempo can be set by a line beginning with  a 'T'
  231.         or  a  't',  then a space followed by a number. This
  232.         number denoted  the  tempo.  Smaller  numbers denote
  233.         faster tempo.  The tempo may be changed in real time
  234.         with  another  'T'  line. The tempo is set to 100 by
  235.         default.
  236.  
  237.  
  238.  
  239.  
  240.  
  241.         A Shareware Program       page 4       October, 1990
  242.  
  243.         PLAYIT Guide                              PLAYIT.DOC
  244.  
  245.  
  246.  
  247.         Triplets and groups
  248.         A line beginning with  a  single  digit  from 3 to 9
  249.         signifies the start of a group. Following  the digit
  250.         must  come a note duration code  (the  same  as  any
  251.         other duration code) eg 'c' for crotchet.
  252.         Then  comes  a  list of pitches, one for each of the
  253.         notes in the group. eg
  254.         3 c c2 d2 e2
  255.         The grouping only works for 'more  notes  than there
  256.         should be' as this is  by far the most common usage.
  257.         eg  Three  quavers  in  the  time  of   two  quavers
  258.         (crotchet)
  259.         A <rest> may form part of the group. eg
  260.         5 q c2 rest d2 e3 f2
  261.  
  262.         Note: Due  to hardware limitations, if a note has an
  263.         extremely short duration then the  computer hardware
  264.         may not be able to cope. This depends to some extent
  265.         on which computer you are using but shouldn't be too
  266.         much of a problem. The  software  used  to  test for
  267.         this when in development and gave a warning but this
  268.         has now been removed. Would  you  like  this feature
  269.         available for general use? Please let me know if so.
  270.  
  271.         Well that's  just  about  it.  Any  suggestions  for
  272.         improvements   will  be  welcomed  by  the   author.
  273.         Needless to say, all versions of the the program are
  274.         supplied 'as is' and without  any  warrantee  of any
  275.         kind,  either  expressed  or  implied,  but  I  feel
  276.         confident the  program will be of real use to anyone
  277.         interested in music.
  278.  
  279.         That's it!
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.         A Shareware Program       page 5       October, 1990
  305.