kdetv
-----

What is kdetv?
--------------

It is a complete rewrite of KWinTV from scratch.
The application was codenamed as QtVision or KWinTV3 during development.

If you want remote control support use KDELIRC, it's in kdeutils of KDE 3.2.
kdetv provides a profile for KDELIRC.


Getting kdetv
-------------

Look at the "Downloads" section of http://www.kdetv.org for source and
binary distributions.

kdetv sources can be found in the "Multimedia" section of "extragear"
subversion repository.

You can browse the source online here:
http://websvn.kde.org/trunk/extragear/multimedia/kdetv


Required Software and Hardware
------------------------------
- X11R6 or above
- KDE 3.2 or above
- TV tuner with V4L/V4L2 or Xv-input support
- libzvbi from zapping.sourceforge.net if you want closed captioning or teletext support
- OSS or ALSA compatible mixer device
- Fast CPU for deinterlacing
- g++ >= 3.1 to compile


Known issues
------------

- High CPU usage when using v4l plugin and overlay is disabled
- Performance problems when deinterlacing and using full frame rate
- Teletext performance is very slow on Linux 2.4.X kernels, 2.6.X is much better
- No documentation available
- No DVB support
- Also, you may want to have a look at the FAQ at www.kdetv.org.


How to enable the Xv "v4l" module
---------------------------------

Make sure you're using XFree86 4 or better.  Edit your XF86Config file and
find the Section "Module".  Within this module, add an entry:

Load "v4l"

Restart your X server.  Note that you must have the V4L module for your
tuner card loaded _before_ you start X if you want the v4l Module in the X
server to find your card.


How to help
-----------

We can really use some help in developing this code. If you would like to
contribute, please send patches or email to the mailing list. In particular,
we could use some help writing plugins, commenting on the architecture and API,
and porting to other platforms (hopefully Solaris and FreeBSD to start).
We could also really use help with documentation and graphics.


Reporting bugs/wishes
----------------------

Please report bugs with the bug tracking system, use Help/Report Bug form
kdetv's menu bar.

Before reporting wishes, read the TODO file from the sources.

_Before_ reporting a bug, PLEASE check:
- the kdetv website (www.kdetv.org), especially the FAQ
- the bugtracking system for duplicates

A useful bugreport includes:
- a detailed description how to reproduce the bug

If possible, provide as much as you can of the following:
- FULL and COMPLETE debug output from the command line
- xvinfo output
- xdpyinfo output
- OS & Distribution, relevant drivers/kernel modules loaded, hardware architecture
- configure and make flags
- values of environment variables: $KDEDIRS $QTDIR $KDEHOME
- location that you installed to (/usr, /opt/kde3, etc)
- where KDE is installed


PLEASE DO NOT EMAIL THE AUTHORS DIRECTLY
use the mailinglist instead: kwintv@mail.kde.org


Authors
-------

see AUTHORS file in the program source package



We hope you enjoy kdetv!

Yours,
The kdetv developers
