This is a "plugin" for the Video Disk Recorder (VDR).

Written by:                  jlacvdr
Project's homepage:          http://vdr-karaoke.sourceforge.net/
Latest version available at: http://vdr-karaoke.sourceforge.net/

See the file COPYING for license information.

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

Description:
-----------
This is a karaoke plugin for VDR which is similar to UltraStar (or SingStar).

You sing a song and get points when you sing in tune.The better you perform,
the more points you get. A bar displays the correct tune.

karaoke files to use must be text file in UltraStar format.
The TXT file has a special format which not only contains the lyrics of the song but also its tune.
To learn more about the TXT file format see : http://ultrastarhome.xardas.lima-city.de/html/guide_file_format_en.html


Dependencies:
------------
    libmad0-dev - MPEG audio decoder development library
    libid3tag0-dev - ID3 tag reading library from the MAD project


Sources files :
---------------

It's fine to have all your songs on harddisk, but may be you have some CDROM's
with song files on them and you want to play them directly from CDROM? Then
this is what you are looking for!

You can define multiple sources from which your songs could be played. At
runtime you can select which source to use, you can mount, unmount and eject
the source at runtime, too. This is done through a config file and a simple
shell script.

First you have to create a config file named "karaokesources.conf" located in the
"plugins" subdirectory of the directory where you keep the other config files
for VDR (e.g. if your VDR configfiles are in "/video" you must create the files
as "/video/plugins/karaokesources.conf").

Every line defines a source (see the example config file which comes with the
archive). You need three information for a source: the base directory, a
description and a flag which determines if a mount/unmount/eject command is
applicable to this source. Optionally you can give a fourth information to
specify which kind of files should be used on this source. The fields must be
separated by a semicolon. The basedir must be a real directory. Using a symlink
to a directory will not work.

So a valid line could be:
  /lyrics;Local files;0
This means that the base directory is /lyrics, the description say that these are
local files and mount/unmount/eject commands can not be applied here.

If you want to ignore all files without the ".txt" extension, you could use:
  /mp3;Local files;0;*.txt
You can give multiple patterns separated with a slash:
  /mp3;Local files;0;*.txt/*.lyrics/*.song

Another useful one:
  /cdrom;CDROM;1
This means that the base directory is /cdrom, which is obviously a CDROM drive
and mount/unmount/eject commands can be applied here.

Note some important things for using mount/unmount/eject commands here:
 - You must have defined an entry in your /etc/fstab for the base directory.
 - The user running VDR must have permission to mount/unmount the device (e.g.
   add "users" to the options in /etc/fstab).
 - You must have a mount script which can be called from VDR (see below).