This is the README for the ivtv module suite.

The primary goal of the IVTV project is to provide a "clean room" Linux 
Open Source driver implementation for video capture cards based on the 
iCompression iTVC15 or Conexant CX23415/CX23416 MPEG Codec. Examples of 
such cards are the Hauppauge PVR 150/250/350/500 series of MPEG video 
capture cards, the Hauppauge "freestyle" and the AVerMedia M179 AVerTV. 

A special note regarding the PVR-500: this card basically consists of two
PVR-150 cards on one board but with the following difference: Radio,
Composite video and S-video are only hooked up to the first PVR-150 instance.

Features:
 * Hardware mpeg2 capture of broadcast video (and sound) via the tuner or
   s-video/audio line-in
 * Hardware mpeg2 capture of FM radio where hardware support exists
 * Supports NTSC, PAL, SECAM with stereo sound
 * Provides hardware mpeg2 playback
 * Provides comprehensive OSD (On Screen Display: ie. graphics overlaying the
   video signal)
 * Provides a framebuffer (allowing X applications to appear on the video
   device)

NOTE 1: Starting with ivtv-0.4.1 kernel hotplug support is used to load the
firmware if the kernel supports this. Firmware hotplug support appeared in
kernel 2.4.23. The names for the firmware files also changed in the 0.4.1 release
to keep them compatible with the 0.5.x series which is preparing the driver for
inclusion in the linux kernel.

NOTE 2: The PVR150/500 inputs (e.g. tuner, composite 0/1 or S-Video 0/1 input)
were reordered in 0.4.1. You will have to correct the input setting of
applications such as MythTV that make use of this.

NOTE 3: If you have kernel 2.6.15 then only the ivtv modules are built if you
have enabled the supporting audio/video modules in the kernel (config options
CONFIG_VIDEO_AUDIO_DECODER and CONFIG_VIDEO_DECODER).
The supporting audio/video modules are now part of that kernel and so the
kernel modules can be used instead of the ivtv-supplied ones.

NOTE 4: VERY IMPORTANT: the ivtv-0.4 series is for the 2.6.15 and lower kernels
ONLY! For the 2.6.16 kernel use ivtv-0.6.x. For the 2.6.17 kernel use ivtv-0.7.x.
For still newer kernels please refer to www.ivtvdriver.org for more information
when available.

If you use the kernel modules, then make sure you have removed any old
ivtv-based msp3400, saa7115, cx25840, cs53l32a, wm8775, tuner,
tveeprom and tda9887 modules.

If you are using the 2.6.15 support audio/video modules, and you have one of these
newer tuners:

- Samsung TCPN 2121P30A
- Samsung TCPG 6121P30A
- TCL M2523_5N_E 
- TCL M2523_3DB_E
- Philips FM1236 MK5
- Philips FM1216ME MK5

then you must edit drivers/Kbuild:

replace this:

	ifndef NO_IVTV_TUNER
	obj-m += tuner.o tveeprom.o tda9887.o
	endif
	endif

by:

	endif
	ifndef NO_IVTV_TUNER
	obj-m += tuner.o tveeprom.o tda9887.o
	endif

The support for this is not in the 2.6.15 kernel so you need to use the ivtv
supplied tuner and tveeprom modules.

IMPORTANT: Instructions on where to obtain the firmware files and how to
	   install them can be found here:
	       http://www.ivtvdriver.org/index.php/Firmware

	   In case of problems first read this page:
	       http://www.ivtvdriver.org/index.php/Troubleshooting


doc/ - contains documentation :)
   /README.install      Installation info
   /modules.txt         Module parameters
   /README.ivtvfb       The ivtv framebuffer
   /README.devices      /dev/xxxx devices
   /README.utils        Included utilities
   /README.lirc         Infrared remote control
   /README.vbi          VBI (Teletext, widescreen, close captioning, etc.)
   /README.radio        The FM Radio
   /video-quality.txt   Some notes on video quality
   /fw-encoder-api.txt  Internals: The encoder firmware API reference
   /fw-decoder-api.txt  Internals: The decoder firmware API reference
   /fw-osd-api.txt  	Internals: The OSD firmware API reference
   /fw-calling.txt 	Internals: How the firmware API calls are made
   /fw-dma.txt 		Internals: How the DMA works
   /fw-memory.txt 	Internals: The card's memory map
   /fw-upload.txt 	Internals: How to upload the firmware
driver/ - actual driver files, Makefile, etc
utils/ - some useful (and required) tools for managing the hardware
test/ - some useful test tools for testing the hardware
misc/ - some patches, configuration for third party applications

Note: the old sourceforge ivtv project is no longer active and will
redirect to ivtvdriver.org. All development now takes place in the
subversion repository on ivtvdriver.org.

Also see:

Homepage + Wiki
http://www.ivtvdriver.org

Subversion repository:
http://ivtvdriver.org/svn/ivtv

Download area:
http://dl.ivtvdriver.org

Mail Archives
http://www.gossamer-threads.com/lists/ivtv/devel/

Forum
http://www.shspvr.com/smf/

IRC
irc://irc.freenode.net/ivtv-dev

MythTv Info
http://www.mythtv.info/moin.cgi/IvTv

Donations
http://www.ivtvdriver.org/index.php/IVTV:Site_support