version 1.15, 2010/10/01 14:03:51
|
version 1.16, 2015/07/08 14:30:44
|
Line 3
|
Line 3
|
include "linuxtv-header.inc"; |
include "linuxtv-header.inc"; |
?> |
?> |
|
|
<h1>Documentation</h1> |
<h1>Linux Media Kernel Documentation</h1> |
<h2>Linux Media Infrastructure API (V4L2, DVB and Remote Controllers)</h2> |
<h2>Linux Media Infrastructure API (V4L2, DVB and Remote Controllers)</h2> |
<p> |
<p> |
Since Set, 15 2009, V4L and DVB API's got integrated into a compendium that |
|
presents both API's, plus the IR input event mapping. |
|
The <a href="http://linuxtv.org/downloads/v4l-dvb-apis"/>Linux Media Infrastructure API</a> |
The <a href="http://linuxtv.org/downloads/v4l-dvb-apis"/>Linux Media Infrastructure API</a> |
converges the common body of knowledge for the kernel to userspace API's |
converges the kernel to userspace APIs used on media drivers. It has 4 parts: |
used by media drivers. |
<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> |
</p> |
<p>Note: although it is possible to generate a PDF version of the specs, |
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> |
the generated PDF is not very useful, since some tables and pictures are |
|
|
<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. |
larger than the output page. So the better is to use the browable documentation. |
</p> |
</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> |
<h1>Complementary documents</h1> |
<h2>DVB</h2> |
<h2>DVB</h2> |
<p> |
<p> |
A small collection of READMEs and FAQs is included in the |
A small collection of READMEs and FAQs is included in the |
Linux kernel source tree in linux/Documentation/dvb/ |
Linux kernel source tree in linux/Documentation/dvb/ |
(<a href="http://git.linuxtv.org/media_tree.git?a=tree;f=Documentation/dvb;hb=HEAD"> |
(<a href="http://git.linuxtv.org/cgit.cgi/media_tree.git/tree/Documentation/dvb"> |
browse docs in the git repository</a>). |
browse docs in the git repository</a>). |
</p> |
</p> |
<h2>Video4linux</h2> |
<h2>Video4linux</h2> |
<p> |
<p> |
A small collection of READMEs and FAQs is included in the |
A small collection of READMEs and FAQs is included in the |
Linux kernel source tree in linux/Documentation/video4linux/ |
Linux kernel source tree in linux/Documentation/video4linux/ |
(<a href="http://git.linuxtv.org/media_tree.git?a=tree;f=Documentation/video4linux;hb=HEAD"> |
(<a href="http://git.linuxtv.org/cgit.cgi/media_tree.git/tree/Documentation/video4linux"> |
browse docs in the git repository</a>). |
browse docs in the git repository</a>). |
</p> |
</p> |
<p>For developers, <a href="http://lwn.net">LWN.net</a> wrote a |
<p>For developers, <a href="http://lwn.net">LWN.net</a> wrote a |
<a href="http://lwn.net/Articles/203924/">series of articles</a> |
<a href="http://lwn.net/Articles/203924/">series of articles</a> |
focusing at the development of a Linux V4L2 driver. |
focusing at the development of a Linux V4L2 driver. |
</p> |
</p> |
|
|
|
<hr> |
|
|
<h1>Legacy/outdated documents</h1> |
<h1>Legacy/outdated documents</h1> |
<p> |
<p> |
The pre-merge V4L and DVB API specs are still available as separate documents. |
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. |
However, they are outdated and are kept here just as historic reference. |
</p> |
</p> |
<h2>DVB</h2> |
<h2>Legacy DVB documents</h2> |
<p> |
<p> |
You can find the original PDF version of the Linux DVB API version 3 |
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>. |
in the <a href="http://linuxtv.org/downloads/legacy/linux-dvb-api-1.0.0.pdf">download area</a>. |
</p> |
</p> |
<h2>Video4Linux</h2> |
<h2>Legacy Video4Linux documents</h2> |
<p>A browsable online version of Video4Linux2 API updated up to pre-kernel 2.6.32 |
<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>. |
is at <a href="http://www.linuxtv.org/downloads/legacy/video4linux/API/V4L2_API/spec-single/v4l2.html">here</a>. |
</p> |
</p> |