home *** CD-ROM | disk | FTP | other *** search
/ Sound, Music & MIDI Collection 2 / SMMVOL2.bin / WAVUTIL / KARDP163.ZIP / KARA.EN < prev    next >
Encoding:
Text File  |  1995-12-05  |  10.6 KB  |  274 lines
  1.  
  2.  
  3.  
  4. KARA(1)                KaraDos Release 1.6.3               KARA(1)
  5.  
  6.  
  7.  
  8.      kara.exe - karaoke player
  9.  
  10. SYNOPSIS
  11.      [path1]kara [path2]song
  12.        [-do={v/f}] [-po={s/m}]
  13.        [-hd={GUS/SB/MPU401/COM1/COM2/COM3/COM4}]
  14.        [-re=name@keynumber]
  15.        [-rl]
  16.        [-dc=x] [-tc=x]
  17.        [-sz=x] [-ft=x]
  18.        [-ff=x] [-nb=x] [-af=x] [-ab=x] [-pf=x] [-st=x]
  19.        [-ry=[+|-]x] [-tr=[+|-]x] [-ve=[+|-]x] [-mu=x]
  20.  
  21.         with x = numerical value (see OPTIONS)
  22.  
  23.  
  24.  
  25. AVAILABILITY
  26.      The kara command is available within the kardp163.zip package
  27.      This package contains the KaraDos product delivery.  KaraDos
  28.      is a shareware. See the readme file  in  the  product.   The
  29.      package kards02.zip and kards03.zip contains karaoke files 
  30.      collection 02 and 03
  31.  
  32.  
  33. DESCRIPTION
  34.      kara is a midi song player with  karaoke  features  for  dos
  35.      (lyrics synchronized with the music).
  36.  
  37.      Midi files with lyrics are automatically detected as Karaoke
  38.      files.
  39.  
  40.      Song may be directed to :
  41.      - the Gravis UltraSound card (GUS) internal synth with the
  42.           ultramid utility
  43.      - or directed to the midi output of the GUS
  44.      - or to the SoundBlaster FM synthetiser (with the
  45.           ameblast.exe TSR)
  46.      - or to the SoundBlaster MIDI port or Daughter board
  47.           wave card.
  48.      The hardware is automatically detected or specified with a
  49.           -hd=  option. The setup.exe program is an easy  way  to
  50.           specify the choice.
  51.      -  a MPU401 compatible card (complete or uart mode)
  52.      -  a serial port of the computer at 38400 bps.
  53.      No automatic detection is provided for these and the option
  54.           -hd= must be given.
  55.      Depending of the -hd choice,  some  environmental  variables
  56.      are used:
  57.      ULTRASND=xxx,y,z,... xxx is the base address of the GUS card
  58.           (see your documentation). Must be present if a  GUS  is
  59.           used.  (sure it is)
  60.      BLASTER=Axxx ...   xxx is the base address of a SoundBlaster
  61.           or compatible card. Mandatory.
  62.      MPU401=xxx  if the hexa base address is not equal to 330h,
  63.           the base address must be given.
  64.  
  65.      Text is directed to the screen in either  full  screen  with
  66.      full background and foreground colors capacity and choice of
  67.      characters size and style, or either in a video mode used to
  68.      become embedded in a video signal on tv set at the bottom of
  69.      the screen. In video mode the background color is black.
  70.  
  71.      Two kind of song files are understood by kara :
  72.             - midi file with .mid extension
  73.             - karaoke file with .kar extension (karasoft format)
  74.  
  75.      Midi files may have a text file associated with  each  song.
  76.      The  file  name  of these text files must be the same as the
  77.      midi file with a .txk extension. Synchronization is made  on
  78.      the  note  on and off of a midi channel. A complete descrip-
  79.      tion of the .txk format is done in the following.
  80.  
  81.      Midi files with lyrics events embedded are  also  understood
  82.      as karaoke files.
  83.  
  84.      Karaoke files (.kar) are read in accordance with  the  Midi-
  85.      Soft format.
  86.  
  87.      If no lyric, the display will show the midi channel activity
  88.      while the music play.
  89.  
  90.      KaraDos support a display from right to left with
  91.      a special font.
  92.      See the Hebrew songs from Eyal Retter.
  93.      
  94.      While playing, the music can be  stopped,  continued,  tran-
  95.      sposed.   Each channel may be muted individually.  The tempo
  96.      can be adjusted and the volume of the synchronization  chan-
  97.      nel tuned.
  98.  
  99.      Permanent options may be saved in the kara.cfk file.
  100.  
  101.   VALID KEYS
  102.      SPACE to start and stop the music (toggle),
  103.      D : DOS session, type exit to return to KaraDos,
  104.      R (rythm) T (transpose) V (volume) followed with + or -
  105.      M (mute/unmute) followed with + or -
  106.           to choose the channel and space to toggle.
  107.      ESC to quit.
  108.      For each key, an indication is briefly displayed at the left
  109.           upper corner of the screen.
  110.      Note on the volume: with a .mid & .txk set, the volume is
  111.           adjusted only for the synchro channel.
  112.      For a .kar file, the volume is adjusted for all channels at the
  113.           same time.
  114.      PAGEUP will restart song and lyrics at the previews
  115.           scrolling
  116.      PAGEDOWN will advance to the next scrolling,
  117.      HOME will restart song and lyrics from the beginning,
  118.      RIGHT ARROW  will temporary speed up while the key is
  119.           depressed.
  120.      If no lyric, PAGE UP and DOWN give +/- 10% in music.
  121.      F1 or F2 : help in English or French,
  122.      ENTER toggles the Midi channel display.
  123.  
  124.   MOUSE SUPPORT
  125.       Left button  : toggle the MIDI CHANNEL DISPLAY
  126.       Middle button: Speed up the music
  127.       Right button : Exit
  128.  
  129.   MIDI CHANNEL DISPLAY
  130.      The MIDI channel display is  a  screen  displayed  when   no
  131.      lyric  is  associated  to a .mid file or for others when the
  132.      enter key is depressed (toggle mode). This screen shows  the
  133.      channels activities while playing and the instrument associ-
  134.      ated.
  135.  
  136.   DEFAULT CONFIGURATION
  137.      Options that must remain permanent for a  configuration  may
  138.      be  given  in  a  kara.cfk  file  in the same directory than
  139.      kara.exe.  the format of this file is identical to the  text
  140.      song  file  without lyric obviously (options begin with # in
  141.      place of - in the command line).  kara.cfk options  overload
  142.      kara.exe default options.
  143.  
  144.   OPTIONS
  145.      [path2]song:if an extension is given to  song,  then  it  is
  146.      taken  into  account,  otherwise a default extension .kar is
  147.      assumed.  If song.kar does not exist, a song.mid is assumed.
  148.  
  149.      OPTION     COMMENT                                   DEFAULT
  150.      ------------------------------------------------------------
  151.   Kara options
  152.      -do={v/f}  display text in full screen or video mode    do=f
  153.      -po={s/m}  music to ultramid (synth) or midi port       po=s
  154.      -hd={GUS/SB/MPU401/COMx} Skip the automatic detection   none
  155.           this option is usefull only for the midi port output.
  156.      -re=name@keynumber for registered user. This option is
  157.           preferably put in the kara.cfk file.
  158.  
  159.   Midi options
  160.      best used in a kdir catalogue .cat for particular songs (see
  161.      kdir.en)
  162.      -dc={1.16} drum channel number                         dc=10
  163.      -tc={1.16} text synchro channel (for .mid file)         tc=1
  164.      -ry=[[+]|-]{0.127} adjust rythm (delta) from original   ry=0
  165.      -tr=[[+]|-]{0.127} adjust transpose (delta)             tr=0
  166.      -ve=[[+]|-]{0.127}adjust velocity (delta)               ve=0
  167.      -mu={1.16} mute a channel at start                      none
  168.   Screen options
  169.      -sz={0.10}  size of the text on the screen              sz=4
  170.      -ft={0.9}  type of font                                 ft=1
  171.      -rl        display text from right to left               -
  172.  
  173.   Text options
  174.      -ff={0.15} first text foreground color                 ff=15
  175.      -nb={0.15} normal background color in full screen       nb=1
  176.      -af={0.15} active text foreground color                 af=0
  177.      -ab={0.15} active text background color in full screen ab=14
  178.      -pf={0.15} post text foreground color                   pf=3
  179.      -st={0.11} fill style of the background                 st=0
  180.               See also DEFAULT CONFIGURATION
  181.       --------------------
  182.       Color        |Value|
  183.       --------------------
  184.       BLACK        |  0  |
  185.       BLUE         |  1  |
  186.       GREEN        |  2  |
  187.       CYAN         |  3  |
  188.       RED          |  4  |
  189.       MAGENTA      |  5  |
  190.       BROWN        |  6  |
  191.       LIGHTGRAY    |  7  |
  192.       DARKGRAY     |  8  |
  193.       LIGHTBLUE    |  9  |
  194.       LIGHTGREEN   | 10  |
  195.       LIGHTCYAN    | 11  |
  196.       LIGHTRED     | 12  |
  197.       LIGHTMAGENTA | 13  |
  198.       YELLOW       | 14  |
  199.       WHITE        | 15  |
  200.       ---------------------
  201.       Note  :Colors  depends  on  your  hardware,CGA,EGA  or  VGA
  202.      screen.
  203.   FONTS
  204.      9 fonts are available
  205.      Font number 4 (goth.chr) contains the hebrew extention.
  206.  
  207.   STYLES
  208.       -----------------------
  209.       Style name      |Value|
  210.       -----------------------
  211.       EMPTY FILL      |  0  |
  212.       SOLID FILL      |  1  |
  213.       LINE  FILL      |  2  |
  214.       LTSLASH FILL    |  3  |
  215.       SLASH FILL      |  4  |
  216.       BKSLASH FILL    |  5  |
  217.       LTBKSLASH FILL  |  6  |
  218.       HATCH FILL      |  7  |
  219.       XHATCH FILL     |  8  |
  220.       INTERLEAVE FILL |  9  |
  221.       WIDE DOT FILL   | 10  |
  222.       CLOSE DOT FILL  | 11  |
  223.       -----------------------
  224.  
  225.   FORMAT
  226.   Format of the .txk ascii file
  227.   -----------------------------------------------
  228.      The two first lines are reserved for the title,  author  and
  229.      copyright  if any (.TXK only).  Following lines are a mix of
  230.      text lines and attribut lines.
  231.  
  232.      Text lines are as you want to see it on the screen  apart  a
  233.      syllable  separator.  Valid separators are blank - , ; the -
  234.      separator is not displayed for example the line:  i  be-come
  235.      la-zy  is displayed as : i become lazy  but is "karaoked" as
  236.      : i be come la zy. It is more easy  to  understand  than  to
  237.      explain.
  238.  
  239.      Attribut  lines  begin  with  #  followed  with  one  option
  240.      described  in  the  OPTIONS  .  Warning: the # replace the -
  241.      character.  A new option is added : #rem for adding  a  com-
  242.      ment  line.   Kara  option #do and #po are disabled and will
  243.      not work.  Only music, screen and line options will be given
  244.      in a  .txk file.  A line option remains valid until the same
  245.      is given.  The screen options taken  into  account  are  the
  246.      last given.
  247.  
  248.      .txk options overload options given in the command  line  or
  249.      in the kara.cfk file.
  250.  
  251.      kara.cfk options are overloaded with any other options  from
  252.      the command line or the .txk file.
  253.  
  254.   Formatting the ascii text in .kar
  255.   ----------------------------------------
  256.      A text beginning with the character / or with  an  uppercase
  257.      is displayed on a new line.  A text beginning with the char-
  258.      acter  is displayed after two empty line ( note: normally it
  259.      will be a new screen. It's my choice).
  260.  
  261.  
  262. SEE ALSO
  263.      kdir.en
  264.  
  265. BUGS AND RESTRICTIONS
  266.      Some font and size  combinations  may  not  work  perfectly.
  267.      Files  *.chr  and *.bgi must reside in the same directory as
  268.      kara.exe.  Files .txk must be in  the  same  directory  than
  269.      corresponding .mid files Some karaoke files may be too large
  270.      to fit in DOS memory.  (Never seen but  ...)  Please  report
  271.      bug if you find one.
  272.  
  273. KaraDos             Last change: 06 December 1995
  274.