Return to docs.php CVS log

Up to [DVB] / linuxtv.org

Annotation of linuxtv.org/docs.php, revision 1.16

1.1       js          1: <?php
                      2:   $title = "LinuxTV.org - Documentation";
                      3:   include "linuxtv-header.inc";
                      4: ?>
                      5: 
1.16    ! mchehab     6: <h1>Linux Media Kernel Documentation</h1>
1.13      mchehab     7: <h2>Linux Media Infrastructure API (V4L2, DVB and Remote Controllers)</h2>
1.9       mchehab     8: <p>
1.13      mchehab     9: The <a href="http://linuxtv.org/downloads/v4l-dvb-apis"/>Linux Media Infrastructure API</a>
1.16    ! mchehab    10: converges the kernel to userspace APIs used on media drivers. It has 4 parts:
        !            11: <ul>
        !            12:    <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/v4l2spec.html">Part I: The V4L2 API</a></li>
        !            13:    <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/dvbapi.html">Part II: The Linux DVB API</a></li>
        !            14:    <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/remotes.html">Part III: The Remote Controller API</a></li>
        !            15:    <li><a href="http://linuxtv.org/downloads/v4l-dvb-apis/media_common.html">Part IV: The Media Controller API</a></li>
        !            16: </ul>
        !            17: </p>
        !            18: 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>
        !            19: 
        !            20: <h3>Notes:</h3>
        !            21: <p>1) Since Sept, 15 2009, V4L and DVB API's got integrated into a compendium that
        !            22: presents both API's, plus the IR input event mapping.</p>
        !            23: 
        !            24: <p>2) Although it is possible to generate a PDF version of the specs,
        !            25: the generated PDF is not very useful, since some tables and pictures are
1.13      mchehab    26: larger than the output page. So the better is to use the browable documentation.
1.9       mchehab    27: </p>
1.16    ! mchehab    28: <h1>Linux DVB libdvbv5 Documentation</h1>
        !            29: The <a href="/docs/libdvbv5/index.html">libdvbv5 API documentation</a>, available
        !            30: since Sept, 2014, documents the libdvbv5 userspace library. It is also available in
        !            31: <a href="http://linuxtv.org/docs/libdvbv5/libdvbv5.pdf">pdf format</a>.
        !            32: 
1.13      mchehab    33: <h1>Complementary documents</h1>
1.4       mchehab    34: <h2>DVB</h2>
1.1       js         35: <p>
1.3       js         36:   A small collection of READMEs and FAQs is included in the
                     37:   Linux kernel source tree in linux/Documentation/dvb/
1.16    ! mchehab    38:   (<a href="http://git.linuxtv.org/cgit.cgi/media_tree.git/tree/Documentation/dvb">
1.15      mchehab    39:   browse docs in the git repository</a>).
1.3       js         40: </p>
1.13      mchehab    41: <h2>Video4linux</h2>
1.4       mchehab    42: <p>
1.13      mchehab    43:   A small collection of READMEs and FAQs is included in the
                     44:   Linux kernel source tree in linux/Documentation/video4linux/
1.16    ! mchehab    45:   (<a href="http://git.linuxtv.org/cgit.cgi/media_tree.git/tree/Documentation/video4linux">
1.15      mchehab    46:   browse docs in the git repository</a>).
1.4       mchehab    47: </p>
1.16    ! mchehab    48: <p>For developers, <a href="http://lwn.net">LWN.net</a> wrote a
1.13      mchehab    49: <a href="http://lwn.net/Articles/203924/">series of articles</a>
                     50: focusing at the development of a Linux V4L2 driver. 
                     51: </p>
1.16    ! mchehab    52: 
        !            53: <hr>
        !            54: 
1.13      mchehab    55: <h1>Legacy/outdated documents</h1>
1.4       mchehab    56: <p>
1.13      mchehab    57: The pre-merge V4L and DVB API specs are still available as separate documents.
                     58: However, they are outdated and are kept here just as historic reference.
1.4       mchehab    59: </p>
1.16    ! mchehab    60: <h2>Legacy DVB documents</h2>
1.4       mchehab    61: <p>
1.13      mchehab    62:   You can find the original PDF version of the Linux DVB API version 3
                     63:   in the <a href="http://linuxtv.org/downloads/legacy/linux-dvb-api-1.0.0.pdf">download area</a>.
                     64: </p>
1.16    ! mchehab    65: <h2>Legacy Video4Linux documents</h2>
1.13      mchehab    66: <p>A browsable online version of Video4Linux2 API updated up to pre-kernel 2.6.32
                     67:   is at <a href="http://www.linuxtv.org/downloads/legacy/video4linux/API/V4L2_API/spec-single/v4l2.html">here</a>.
1.4       mchehab    68: </p>
                     69: <p>
1.13      mchehab    70:   There's a V4L Drivers guide at 
                     71:    <a href="http://www.linuxtv.org/downloads/legacy/video4linux/v4l2dwgNew.html">here</a>.
1.4       mchehab    72: </p>
                     73: <p>
1.6       mchehab    74:   Video4Linux API version 1 is obsolete. Driver and application 
1.14      mchehab    75: developers are requested to migrate their work to V4L2 API.</p>
                     76: <p>There's an effort in course to fully remove its support from 
                     77: the drivers and the compatibility kernel driver mode, targeted to 
                     78: kernels 2.6.36/2.6.37.</p>
                     79: <p>Compatibility with V4L1 applications, including binary-only
                     80: applications will be provided by <a 
                     81: href="http://git.linuxtv.org/v4l-utils.git">v4l-utils libv4l</a>.
1.13      mchehab    82: </p>
1.1       js         83: <?php include "linuxtv-footer.inc"; ?>