blob: 6a8b7158697f9ae58b33e82d2f7becd772a6c4aa [file] [log] [blame]
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001<?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 Chehabd80bd702009-09-15 15:27:57 -03004<!ENTITY % media-entities SYSTEM "./media-entities.tmpl"> %media-entities;
5<!ENTITY media-indices SYSTEM "./media-indices.tmpl">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03006
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">
Mauro Carvalho Chehab6d172492011-07-05 10:07:37 -030011<!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 Chehab3de530f2011-07-05 12:36:01 -030012<!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 Chehab8e080c22009-09-13 22:16:04 -030013<!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>">
Sylwester Nawrockib01189b2012-11-28 14:40:32 -030025<!ENTITY dash-ent-10 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
Phil Edworthy7b88fc02013-03-18 08:47:59 -030026<!ENTITY dash-ent-16 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030027]>
28
29<book id="media_api">
30<bookinfo>
31<title>LINUX MEDIA INFRASTRUCTURE API</title>
32
33<copyright>
Hans Verkuil571d19c2012-08-09 06:04:43 -030034 <year>2009-2012</year>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030035 <holder>LinuxTV Developers</holder>
36</copyright>
37
38<legalnotice>
39
40<para>Permission is granted to copy, distribute and/or modify
41this document under the terms of the GNU Free Documentation License,
42Version 1.1 or any later version published by the Free Software
43Foundation. A copy of the license is included in the chapter entitled
44"GNU Free Documentation License"</para>
45</legalnotice>
46
47</bookinfo>
48
49<toc></toc> <!-- autogenerated -->
50
51<preface>
52 <title>Introduction</title>
53
54 <para>This document covers the Linux Kernel to Userspace API's used by
55 video and radio straming devices, including video cameras,
56 analog and digital TV receiver cards, AM/FM receiver cards,
57 streaming capture devices.</para>
Hans Verkuil571d19c2012-08-09 06:04:43 -030058 <para>It is divided into four parts.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030059 <para>The first part covers radio, capture,
60 cameras and analog TV devices.</para>
61 <para>The second part covers the
62 API used for digital TV and Internet reception via one of the
63 several digital tv standards. While it is called as DVB API,
64 in fact it covers several different video standards including
65 DVB-T, DVB-S, DVB-C and ATSC. The API is currently being updated
66 to documment support also for DVB-S2, ISDB-T and ISDB-S.</para>
Hans Verkuil571d19c2012-08-09 06:04:43 -030067 <para>The third part covers the Remote Controller API.</para>
68 <para>The fourth part covers the Media Controller API.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030069 <para>For additional information and for the latest development code,
70 see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para>
71 <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>
72
73</preface>
74
75<part id="v4l2spec">
76&sub-v4l2;
77</part>
78<part id="dvbapi">
79&sub-dvbapi;
80</part>
81<part id="v4ldvb_common">
82<partinfo>
83<authorgroup>
84<author>
85<firstname>Mauro</firstname>
86<surname>Chehab</surname>
87<othername role="mi">Carvalho</othername>
88<affiliation><address><email>mchehab@redhat.com</email></address></affiliation>
89<contrib>Initial version.</contrib>
90</author>
91</authorgroup>
92<copyright>
Hans Verkuil571d19c2012-08-09 06:04:43 -030093 <year>2009-2012</year>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030094 <holder>Mauro Carvalho Chehab</holder>
95</copyright>
96
97<revhistory>
98<!-- Put document revisions here, newest first. -->
99<revision>
100<revnumber>1.0.0</revnumber>
101<date>2009-09-06</date>
102<authorinitials>mcc</authorinitials>
103<revremark>Initial revision</revremark>
104</revision>
105</revhistory>
106</partinfo>
107
Mauro Carvalho Chehabfab81252010-07-04 12:23:19 -0300108<title>Remote Controller API</title>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300109<chapter id="remote_controllers">
110&sub-remote_controllers;
111</chapter>
112</part>
Laurent Pinchart176fb0d2009-12-09 08:39:58 -0300113<part id="media_common">
114&sub-media-controller;
115</part>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300116
Mauro Carvalho Chehab6d172492011-07-05 10:07:37 -0300117<chapter id="gen_errors">
118&sub-gen-errors;
119</chapter>
120
121
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300122&sub-fdl-appendix;
123
124</book>