Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 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" [ |
Mauro Carvalho Chehab | d80bd70 | 2009-09-15 15:27:57 -0300 | [diff] [blame] | 4 | <!ENTITY % media-entities SYSTEM "./media-entities.tmpl"> %media-entities; |
| 5 | <!ENTITY media-indices SYSTEM "./media-indices.tmpl"> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 6 | |
| 7 | <!ENTITY eg "e. g."> |
| 8 | <!ENTITY ie "i. e."> |
| 9 | <!ENTITY fd "File descriptor returned by <link linkend='func-open'><function>open()</function></link>."> |
| 10 | <!ENTITY i2c "I<superscript>2</superscript>C"> |
Mauro Carvalho Chehab | 6d17249 | 2011-07-05 10:07:37 -0300 | [diff] [blame] | 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>"> |
Mauro Carvalho Chehab | 3de530f | 2011-07-05 12:36:01 -0300 | [diff] [blame] | 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>"> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 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 | ]> |
| 26 | |
| 27 | <book id="media_api"> |
| 28 | <bookinfo> |
| 29 | <title>LINUX MEDIA INFRASTRUCTURE API</title> |
| 30 | |
| 31 | <copyright> |
Hans Verkuil | 571d19c | 2012-08-09 06:04:43 -0300 | [diff] [blame^] | 32 | <year>2009-2012</year> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 33 | <holder>LinuxTV Developers</holder> |
| 34 | </copyright> |
| 35 | |
| 36 | <legalnotice> |
| 37 | |
| 38 | <para>Permission is granted to copy, distribute and/or modify |
| 39 | this document under the terms of the GNU Free Documentation License, |
| 40 | Version 1.1 or any later version published by the Free Software |
| 41 | Foundation. A copy of the license is included in the chapter entitled |
| 42 | "GNU Free Documentation License"</para> |
| 43 | </legalnotice> |
| 44 | |
| 45 | </bookinfo> |
| 46 | |
| 47 | <toc></toc> <!-- autogenerated --> |
| 48 | |
| 49 | <preface> |
| 50 | <title>Introduction</title> |
| 51 | |
| 52 | <para>This document covers the Linux Kernel to Userspace API's used by |
| 53 | video and radio straming devices, including video cameras, |
| 54 | analog and digital TV receiver cards, AM/FM receiver cards, |
| 55 | streaming capture devices.</para> |
Hans Verkuil | 571d19c | 2012-08-09 06:04:43 -0300 | [diff] [blame^] | 56 | <para>It is divided into four parts.</para> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 57 | <para>The first part covers radio, capture, |
| 58 | cameras and analog TV devices.</para> |
| 59 | <para>The second part covers the |
| 60 | API used for digital TV and Internet reception via one of the |
| 61 | several digital tv standards. While it is called as DVB API, |
| 62 | in fact it covers several different video standards including |
| 63 | DVB-T, DVB-S, DVB-C and ATSC. The API is currently being updated |
| 64 | to documment support also for DVB-S2, ISDB-T and ISDB-S.</para> |
Hans Verkuil | 571d19c | 2012-08-09 06:04:43 -0300 | [diff] [blame^] | 65 | <para>The third part covers the Remote Controller API.</para> |
| 66 | <para>The fourth part covers the Media Controller API.</para> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 67 | <para>For additional information and for the latest development code, |
| 68 | see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para> |
| 69 | <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> |
| 70 | |
| 71 | </preface> |
| 72 | |
| 73 | <part id="v4l2spec"> |
| 74 | &sub-v4l2; |
| 75 | </part> |
| 76 | <part id="dvbapi"> |
| 77 | &sub-dvbapi; |
| 78 | </part> |
| 79 | <part id="v4ldvb_common"> |
| 80 | <partinfo> |
| 81 | <authorgroup> |
| 82 | <author> |
| 83 | <firstname>Mauro</firstname> |
| 84 | <surname>Chehab</surname> |
| 85 | <othername role="mi">Carvalho</othername> |
| 86 | <affiliation><address><email>mchehab@redhat.com</email></address></affiliation> |
| 87 | <contrib>Initial version.</contrib> |
| 88 | </author> |
| 89 | </authorgroup> |
| 90 | <copyright> |
Hans Verkuil | 571d19c | 2012-08-09 06:04:43 -0300 | [diff] [blame^] | 91 | <year>2009-2012</year> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 92 | <holder>Mauro Carvalho Chehab</holder> |
| 93 | </copyright> |
| 94 | |
| 95 | <revhistory> |
| 96 | <!-- Put document revisions here, newest first. --> |
| 97 | <revision> |
| 98 | <revnumber>1.0.0</revnumber> |
| 99 | <date>2009-09-06</date> |
| 100 | <authorinitials>mcc</authorinitials> |
| 101 | <revremark>Initial revision</revremark> |
| 102 | </revision> |
| 103 | </revhistory> |
| 104 | </partinfo> |
| 105 | |
Mauro Carvalho Chehab | fab8125 | 2010-07-04 12:23:19 -0300 | [diff] [blame] | 106 | <title>Remote Controller API</title> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 107 | <chapter id="remote_controllers"> |
| 108 | &sub-remote_controllers; |
| 109 | </chapter> |
| 110 | </part> |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 111 | <part id="media_common"> |
| 112 | &sub-media-controller; |
| 113 | </part> |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 114 | |
Mauro Carvalho Chehab | 6d17249 | 2011-07-05 10:07:37 -0300 | [diff] [blame] | 115 | <chapter id="gen_errors"> |
| 116 | &sub-gen-errors; |
| 117 | </chapter> |
| 118 | |
| 119 | |
Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 120 | &sub-fdl-appendix; |
| 121 | |
| 122 | </book> |