File:  [DVB] / linuxtv.org / docs.php
Revision 1.16: download - view: text, annotated - select for diffs
Wed Jul 8 14:30:44 2015 UTC (8 years, 10 months ago) by mchehab
Branches: MAIN
CVS tags: HEAD
Update files

<?php
  $title = "LinuxTV.org - Documentation";
  include "linuxtv-header.inc";
?>

<h1>Linux Media Kernel Documentation</h1>
<h2>Linux Media Infrastructure API (V4L2, DVB and Remote Controllers)</h2>
<p>
The <a href="http://linuxtv.org/downloads/v4l-dvb-apis"/>Linux Media Infrastructure API</a>
converges the kernel to userspace APIs used on media drivers. It has 4 parts:
<ul>
   <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/v4l2spec.html">Part I: The V4L2 API</a></li>
   <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/dvbapi.html">Part II: The Linux DVB API</a></li>
   <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/remotes.html">Part III: The Remote Controller API</a></li>
   <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/media_common.html">Part IV: The Media Controller API</a></li>
</ul>
</p>
Please notice that audio input/output on media devices use the <a href="http://www.alsa-project.org/main/index.php/ALSA_Driver_Documentation">ALSA API</a>.</p>

<h3>Notes:</h3>
<p>1) Since Sept, 15 2009, V4L and DVB API's got integrated into a compendium that
presents both API's, plus the IR input event mapping.</p>

<p>2) Although it is possible to generate a PDF version of the specs,
the generated PDF is not very useful, since some tables and pictures are
larger than the output page. So the better is to use the browable documentation.
</p>
<h1>Linux DVB libdvbv5 Documentation</h1>
The <a href="/docs/libdvbv5/index.html">libdvbv5 API documentation</a>, available
since Sept, 2014, documents the libdvbv5 userspace library. It is also available in
<a href="http://linuxtv.org/docs/libdvbv5/libdvbv5.pdf">pdf format</a>.

<h1>Complementary documents</h1>
<h2>DVB</h2>
<p>
  A small collection of READMEs and FAQs is included in the
  Linux kernel source tree in linux/Documentation/dvb/
  (<a href="http://git.linuxtv.org/cgit.cgi/media_tree.git/tree/Documentation/dvb">
  browse docs in the git repository</a>).
</p>
<h2>Video4linux</h2>
<p>
  A small collection of READMEs and FAQs is included in the
  Linux kernel source tree in linux/Documentation/video4linux/
  (<a href="http://git.linuxtv.org/cgit.cgi/media_tree.git/tree/Documentation/video4linux">
  browse docs in the git repository</a>).
</p>
<p>For developers, <a href="http://lwn.net">LWN.net</a> wrote a
<a href="http://lwn.net/Articles/203924/">series of articles</a>
focusing at the development of a Linux V4L2 driver. 
</p>

<hr>

<h1>Legacy/outdated documents</h1>
<p>
The pre-merge V4L and DVB API specs are still available as separate documents.
However, they are outdated and are kept here just as historic reference.
</p>
<h2>Legacy DVB documents</h2>
<p>
  You can find the original PDF version of the Linux DVB API version 3
  in the <a href="http://linuxtv.org/downloads/legacy/linux-dvb-api-1.0.0.pdf">download area</a>.
</p>
<h2>Legacy Video4Linux documents</h2>
<p>A browsable online version of Video4Linux2 API updated up to pre-kernel 2.6.32
  is at <a href="http://www.linuxtv.org/downloads/legacy/video4linux/API/V4L2_API/spec-single/v4l2.html">here</a>.
</p>
<p>
  There's a V4L Drivers guide at 
   <a href="http://www.linuxtv.org/downloads/legacy/video4linux/v4l2dwgNew.html">here</a>.
</p>
<p>
  Video4Linux API version 1 is obsolete. Driver and application 
developers are requested to migrate their work to V4L2 API.</p>
<p>There's an effort in course to fully remove its support from 
the drivers and the compatibility kernel driver mode, targeted to 
kernels 2.6.36/2.6.37.</p>
<p>Compatibility with V4L1 applications, including binary-only
applications will be provided by <a 
href="http://git.linuxtv.org/v4l-utils.git">v4l-utils libv4l</a>.
</p>
<?php include "linuxtv-footer.inc"; ?>

LinuxTV legacy CVS <linuxtv.org/cvs>