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