Documentation/DocBook/media_api.tmpl

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY % media-entities SYSTEM "./media-entities.tmpl"> %media-entities;
   5 <!ENTITY media-indices SYSTEM "./media-indices.tmpl">
   6
   7 <!ENTITY eg                     "e.&nbsp;g.">
   8 <!ENTITY ie                     "i.&nbsp;e.">
   9 <!ENTITY fd                     "File descriptor returned by <link linkend='func-open'><function>open()</function></link>.">
  10 <!ENTITY i2c                    "I<superscript>2</superscript>C">
  11 <!ENTITY return-value           "<title>Return Value</title><para>On success <returnvalue>0</returnvalue> is returned, on error <returnvalue>-1</returnvalue> and the <varname>errno</varname> variable is set appropriately. The generic error codes are described at the <link linkend='gen-errors'>Generic Error Codes</link> chapter.</para>">
  12 <!ENTITY return-value-dvb       "<para>RETURN VALUE</para><para>On success <returnvalue>0</returnvalue> is returned, on error <returnvalue>-1</returnvalue> and the <varname>errno</varname> variable is set appropriately. The generic error codes are described at the <link linkend='gen-errors'>Generic Error Codes</link> chapter.</para>">
  13 <!ENTITY manvol                 "<manvolnum>2</manvolnum>">
  14
  15 <!-- Table templates: structs, structs w/union, defines. -->
  16 <!ENTITY cs-str                 "<colspec colname='c1' colwidth='1*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='2*' /><spanspec spanname='hspan' namest='c1' nameend='c3' />">
  17 <!ENTITY cs-ustr                "<colspec colname='c1' colwidth='1*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='1*' /><colspec colname='c4' colwidth='2*' /><spanspec spanname='hspan' namest='c1' nameend='c4' />">
  18 <!ENTITY cs-def                 "<colspec colname='c1' colwidth='3*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='4*' /><spanspec spanname='hspan' namest='c1' nameend='c3' />">
  19
  20 <!-- Video for Linux mailing list address. -->
  21 <!ENTITY v4l-ml                 "<ulink url='http://www.linuxtv.org/lists.php'>http://www.linuxtv.org/lists.php</ulink>">
  22
  23 <!-- LinuxTV v4l-dvb repository. -->
  24 <!ENTITY v4l-dvb                "<ulink url='http://linuxtv.org/repo/'>http://linuxtv.org/repo/</ulink>">
  25 <!ENTITY dash-ent-10            "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
  26 ]>
  27
  28 <book id="media_api">
  29 <bookinfo>
  30 <title>LINUX MEDIA INFRASTRUCTURE API</title>
  31
  32 <copyright>
  33         <year>2009-2012</year>
  34         <holder>LinuxTV Developers</holder>
  35 </copyright>
  36
  37 <legalnotice>
  38
  39 <para>Permission is granted to copy, distribute and/or modify
  40 this document under the terms of the GNU Free Documentation License,
  41 Version 1.1 or any later version published by the Free Software
  42 Foundation. A copy of the license is included in the chapter entitled
  43 "GNU Free Documentation License"</para>
  44 </legalnotice>
  45
  46 </bookinfo>
  47
  48 <toc></toc> <!-- autogenerated -->
  49
  50 <preface>
  51         <title>Introduction</title>
  52
  53         <para>This document covers the Linux Kernel to Userspace API's used by
  54                 video and radio straming devices, including video cameras,
  55                 analog and digital TV receiver cards, AM/FM receiver cards,
  56                 streaming capture devices.</para>
  57         <para>It is divided into four parts.</para>
  58         <para>The first part covers radio, capture,
  59                 cameras and analog TV devices.</para>
  60         <para>The second part covers the
  61                 API used for digital TV and Internet reception via one of the
  62                 several digital tv standards. While it is called as DVB API,
  63                 in fact it covers several different video standards including
  64                 DVB-T, DVB-S, DVB-C and ATSC. The API is currently being updated
  65                 to documment support also for DVB-S2, ISDB-T and ISDB-S.</para>
  66         <para>The third part covers the Remote Controller API.</para>
  67         <para>The fourth part covers the Media Controller API.</para>
  68         <para>For additional information and for the latest development code,
  69                 see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para>
  70         <para>For discussing improvements, reporting troubles, sending new drivers, etc, please mail to: <ulink url="http://vger.kernel.org/vger-lists.html#linux-media">Linux Media Mailing List (LMML).</ulink>.</para>
  71
  72 </preface>
  73
  74 <part id="v4l2spec">
  75 &sub-v4l2;
  76 </part>
  77 <part id="dvbapi">
  78 &sub-dvbapi;
  79 </part>
  80 <part id="v4ldvb_common">
  81 <partinfo>
  82 <authorgroup>
  83 <author>
  84 <firstname>Mauro</firstname>
  85 <surname>Chehab</surname>
  86 <othername role="mi">Carvalho</othername>
  87 <affiliation><address><email>mchehab@redhat.com</email></address></affiliation>
  88 <contrib>Initial version.</contrib>
  89 </author>
  90 </authorgroup>
  91 <copyright>
  92         <year>2009-2012</year>
  93         <holder>Mauro Carvalho Chehab</holder>
  94 </copyright>
  95
  96 <revhistory>
  97 <!-- Put document revisions here, newest first. -->
  98 <revision>
  99 <revnumber>1.0.0</revnumber>
 100 <date>2009-09-06</date>
 101 <authorinitials>mcc</authorinitials>
 102 <revremark>Initial revision</revremark>
 103 </revision>
 104 </revhistory>
 105 </partinfo>
 106
 107 <title>Remote Controller API</title>
 108 <chapter id="remote_controllers">
 109 &sub-remote_controllers;
 110 </chapter>
 111 </part>
 112 <part id="media_common">
 113 &sub-media-controller;
 114 </part>
 115
 116 <chapter id="gen_errors">
 117 &sub-gen-errors;
 118 </chapter>
 119
 120
 121 &sub-fdl-appendix;
 122
 123 </book>