diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-13 21:16:04 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-18 22:47:55 -0400 |
commit | 8e080c2e6cadada82a6b520e0c23a1cb974822d5 (patch) | |
tree | 991450ff1abba98e5313906478c33816a202ccab /Documentation/DocBook/media.xml | |
parent | f4e96deb4513d044653027d4921fd7592195503a (diff) |
V4L/DVB (12761): DocBook: add media API specs
The V4L and DVB API's are there for a long time. however, up to now,
no efforts were done to merge them to kernel DocBook.
This patch adds the current versions of the specs as an unique compendium.
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook/media.xml')
-rw-r--r-- | Documentation/DocBook/media.xml | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/Documentation/DocBook/media.xml b/Documentation/DocBook/media.xml new file mode 100644 index 000000000000..14302589d553 --- /dev/null +++ b/Documentation/DocBook/media.xml | |||
@@ -0,0 +1,112 @@ | |||
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.xml"> %media-entities; | ||
5 | <!ENTITY media-indices SYSTEM "./media-indices.sgml"> | ||
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"> | ||
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:</para>"> | ||
12 | <!ENTITY manvol "<manvolnum>2</manvolnum>"> | ||
13 | |||
14 | <!-- Table templates: structs, structs w/union, defines. --> | ||
15 | <!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' />"> | ||
16 | <!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' />"> | ||
17 | <!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' />"> | ||
18 | |||
19 | <!-- Video for Linux mailing list address. --> | ||
20 | <!ENTITY v4l-ml "<ulink url='http://www.linuxtv.org/lists.php'>http://www.linuxtv.org/lists.php</ulink>"> | ||
21 | |||
22 | <!-- LinuxTV v4l-dvb repository. --> | ||
23 | <!ENTITY v4l-dvb "<ulink url='http://linuxtv.org/repo/'>http://linuxtv.org/repo/</ulink>"> | ||
24 | ]> | ||
25 | |||
26 | <book id="media_api"> | ||
27 | <bookinfo> | ||
28 | <title>LINUX MEDIA INFRASTRUCTURE API</title> | ||
29 | |||
30 | <copyright> | ||
31 | <year>2009</year> | ||
32 | <holder>LinuxTV Developers</holder> | ||
33 | </copyright> | ||
34 | |||
35 | <legalnotice> | ||
36 | |||
37 | <para>Permission is granted to copy, distribute and/or modify | ||
38 | this document under the terms of the GNU Free Documentation License, | ||
39 | Version 1.1 or any later version published by the Free Software | ||
40 | Foundation. A copy of the license is included in the chapter entitled | ||
41 | "GNU Free Documentation License"</para> | ||
42 | </legalnotice> | ||
43 | |||
44 | </bookinfo> | ||
45 | |||
46 | <toc></toc> <!-- autogenerated --> | ||
47 | |||
48 | <preface> | ||
49 | <title>Introduction</title> | ||
50 | |||
51 | <para>This document covers the Linux Kernel to Userspace API's used by | ||
52 | video and radio straming devices, including video cameras, | ||
53 | analog and digital TV receiver cards, AM/FM receiver cards, | ||
54 | streaming capture devices.</para> | ||
55 | <para>It is divided into three parts.</para> | ||
56 | <para>The first part covers radio, capture, | ||
57 | cameras and analog TV devices.</para> | ||
58 | <para>The second part covers the | ||
59 | API used for digital TV and Internet reception via one of the | ||
60 | several digital tv standards. While it is called as DVB API, | ||
61 | in fact it covers several different video standards including | ||
62 | DVB-T, DVB-S, DVB-C and ATSC. The API is currently being updated | ||
63 | to documment support also for DVB-S2, ISDB-T and ISDB-S.</para> | ||
64 | <para>The third part covers other API's used by all media infrastructure devices</para> | ||
65 | <para>For additional information and for the latest development code, | ||
66 | see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para> | ||
67 | <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> | ||
68 | |||
69 | </preface> | ||
70 | |||
71 | <part id="v4l2spec"> | ||
72 | &sub-v4l2; | ||
73 | </part> | ||
74 | <part id="dvbapi"> | ||
75 | &sub-dvbapi; | ||
76 | </part> | ||
77 | <part id="v4ldvb_common"> | ||
78 | <partinfo> | ||
79 | <authorgroup> | ||
80 | <author> | ||
81 | <firstname>Mauro</firstname> | ||
82 | <surname>Chehab</surname> | ||
83 | <othername role="mi">Carvalho</othername> | ||
84 | <affiliation><address><email>mchehab@redhat.com</email></address></affiliation> | ||
85 | <contrib>Initial version.</contrib> | ||
86 | </author> | ||
87 | </authorgroup> | ||
88 | <copyright> | ||
89 | <year>2009</year> | ||
90 | <holder>Mauro Carvalho Chehab</holder> | ||
91 | </copyright> | ||
92 | |||
93 | <revhistory> | ||
94 | <!-- Put document revisions here, newest first. --> | ||
95 | <revision> | ||
96 | <revnumber>1.0.0</revnumber> | ||
97 | <date>2009-09-06</date> | ||
98 | <authorinitials>mcc</authorinitials> | ||
99 | <revremark>Initial revision</revremark> | ||
100 | </revision> | ||
101 | </revhistory> | ||
102 | </partinfo> | ||
103 | |||
104 | <title>Other API's used by media infrastructure drivers</title> | ||
105 | <chapter id="remote_controllers"> | ||
106 | &sub-remote_controllers; | ||
107 | </chapter> | ||
108 | </part> | ||
109 | |||
110 | &sub-fdl-appendix; | ||
111 | |||
112 | </book> | ||