packages icon
/* $Id: README,v 0.1 96/01/04 09:00 taieb Exp $ */



  Copyright (c) 1995/1996 Jean Pierre Cocatrix/Laurent Taieb


	KARALIN : A MOTIF Karaoke Player


Overview
--------

This software is a porting of the KARADOS Karaoke player.

1. Files supported
------------------

It manipulates 2 types of Karaoke Files :

* <.kar> files :  Which include both lyrics ans music.

* <.mid> & <.txk> files : Which are respectively midi and lyrics files.

2. How it works ?
-----------------

Karalin is splitted into 4 processes :

	a- A Midi selector called <kdir> which has to be launched by the user

	b- A Midi Music Viewer called <kmusic> which is launched by kdir

	c- A Karaoke Lyric Viewer called <klyric> which is launched by kmusic

	d- A Midi Player called <kplay> which is launched by kmusic


The user has only to launch <kdir> to play with Karalin.

The first time the user launch <kdir>, he/she has to fill a form which indicates
the type of sound board he has, the directories, the patch files or the bank files
are present.

Then these informations are stored in a personal resource file called <.karalinrc>
which is stored in the user's home directory.


3. kdir
-------

. <kdir> allows only to select a midi/karaoke file to be played by kplay 
and shown by <klyric> and <kmusic>.

. When the user select a new karaoke file while another is playing,
the new one replaces the old one.

. A configuration panel is provided by the Setup button


Limitations : 

This is an alpha -- version of kdir, it doesn't allow multi file playing nore
random access...

The next version will cover more features

4. kmusic
---------
. <kmusic> is the process that manages the remote control and the Music Window

a. Remote Control : This window allows the user to :

	. Iconify/Restore the Selection, Lyrics, Music Windows
	. Play/Pause a song (Play by default)
	. Return to the beginning of the song (Home)
	. Go Page Up/Down of a song (Not yet implemented)
	. Play song really faster
	. Exit of karalin
	. Select Previous/Next Song
		(Not yet implemented, with A fully future kdir selector)

	. By an optionnal Toggle Button Vol/Beat/Transpose :

		. Increase/Decrease Volume
		. Increase/Decrease Beat
		. Increase/Decrease Octave

b. Music Window 

This Window is designed to show graphically all Midi Note on/off in a flat led area.

It shows also the intruments present in the midi file and provides a view of some
midi controlers.

Moreover, users can select the volume played on each canal and can decide to mute a 
channel or to select exclusively one or some channels.

The rythme of the song is updated in real time in the upper left corner of the window.

4. klyric
---------

This window is designed to show lyrics associated withs music in a karaoke file.

The text of the song is shown one received by the player.

Each time , a note on/off arrives from the player, the background color changes
and the text scroll in the scrolled Window.

No action are taken into account from operator in this window.

5. kplay
--------

This process is not associated with an X window.

Its role is to analyse the karaoke file(s) , to send commands to the Voxware driver
and to send messages to the other processes .

-------------------------------

More info available at:
- On the karaoke for computer take a look at 
http://www.teleport.com/~labrat/karaoke.shtml

This page contains all the last news for the karaoke people and all available songs.

More songs are available at
- The labrat page 
- ftp://kdr.syr.edu/karaoke

Features
--------
- Fully Midi karaoke software
- General midi compatible
- Support of the most 'graphical' controlers
- Graphical view of Music
- Easy to use 


Limitations
-----------
Only on Unix/XWindow/Motif/Pc !!!!

No way for the moment to provide a static version of karalin.
I hope it will be possible in a soon future.

Sorry for the poor sound on SoundBlaster boards .
No way with these boards to get a sound which looks like 
an instrument sound (with midi)

And many others....



Mailing lists
-------------

Questions, suggestions, may be sent to 
	Laurent.Taieb@ansf.alcatel.fr

To subscribe/unsubscribe to this mailing list send requests to 
	Laurent.Taieb@ansf.alcatel.fr

Send bugs to me, using the bug-report template file.


Authors Information

Laurent.Taieb@ansf.alcatel.fr
laurent.@fanny.frmug.fr.net