blob: c71ebe3277b1ca8527cc81ea710ad90d643b49bf [file] [log] [blame]
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001<?xml version="1.0"?>
Andrzej Hajda8bfd4a62013-06-28 05:34:20 -03002<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.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>">
Laurent Pinchartf57fa212013-06-05 04:19:53 -030025<!ENTITY dash-ent-8 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
Sylwester Nawrockib01189b2012-11-28 14:40:32 -030026<!ENTITY dash-ent-10 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
Laurent Pinchartf57fa212013-06-05 04:19:53 -030027<!ENTITY dash-ent-12 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
28<!ENTITY dash-ent-14 "<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>">
Phil Edworthy7b88fc02013-03-18 08:47:59 -030029<!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>">
Laurent Pinchartf57fa212013-06-05 04:19:53 -030030<!ENTITY dash-ent-20 "<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><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
31<!ENTITY dash-ent-22 "<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><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
32<!ENTITY dash-ent-24 "<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><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030033]>
34
35<book id="media_api">
36<bookinfo>
Mauro Carvalho Chehab90f745c2014-02-06 10:55:28 -020037 <title>LINUX MEDIA INFRASTRUCTURE API</title>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030038
Mauro Carvalho Chehab90f745c2014-02-06 10:55:28 -020039 <copyright>
40 <year>2009-2014</year>
41 <holder>LinuxTV Developers</holder>
42 </copyright>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030043
Mauro Carvalho Chehab90f745c2014-02-06 10:55:28 -020044 <legalnotice>
45 <para>Permission is granted to copy, distribute and/or modify
46 this document under the terms of the GNU Free Documentation License,
47 Version 1.1 or any later version published by the Free Software
48 Foundation. A copy of the license is included in the chapter entitled
49 "GNU Free Documentation License"</para>
50 </legalnotice>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030051</bookinfo>
52
53<toc></toc> <!-- autogenerated -->
54
55<preface>
56 <title>Introduction</title>
57
58 <para>This document covers the Linux Kernel to Userspace API's used by
Hans Verkuil1b962082014-01-07 06:46:37 -030059 video and radio streaming devices, including video cameras,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030060 analog and digital TV receiver cards, AM/FM receiver cards,
Hans Verkuil1b962082014-01-07 06:46:37 -030061 streaming capture and output devices, codec devices and remote
62 controllers.</para>
Hans Verkuil571d19c2012-08-09 06:04:43 -030063 <para>It is divided into four parts.</para>
Hans Verkuil1b962082014-01-07 06:46:37 -030064 <para>The first part covers radio, video capture and output,
65 cameras, analog TV devices and codecs.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030066 <para>The second part covers the
67 API used for digital TV and Internet reception via one of the
68 several digital tv standards. While it is called as DVB API,
69 in fact it covers several different video standards including
Mauro Carvalho Chehab39b9ce22015-05-25 13:38:01 -030070 DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S,etc. The complete
71 list of supported standards can be found at
72 <xref linkend="fe-delivery-system-t" />.</para>
Hans Verkuil571d19c2012-08-09 06:04:43 -030073 <para>The third part covers the Remote Controller API.</para>
74 <para>The fourth part covers the Media Controller API.</para>
Mauro Carvalho Chehab9f67bc52015-05-25 13:39:48 -030075 <para>It should also be noticed that a media device may also have audio
76 components, like mixers, PCM capture, PCM playback, etc, with
77 are controlled via ALSA API.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030078 <para>For additional information and for the latest development code,
79 see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para>
80 <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>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030081</preface>
82
Mauro Carvalho Chehab90f745c2014-02-06 10:55:28 -020083<part id="v4l2spec">&sub-v4l2;</part>
84<part id="dvbapi">&sub-dvbapi;</part>
85<part id="remotes">&sub-remote_controllers;</part>
86<part id="media_common">&sub-media-controller;</part>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030087
Mauro Carvalho Chehab90f745c2014-02-06 10:55:28 -020088<chapter id="gen_errors">&sub-gen-errors;</chapter>
Mauro Carvalho Chehab6d172492011-07-05 10:07:37 -030089
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030090&sub-fdl-appendix;
91
92</book>