Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
40f7bc9b MCC |
3 | .. include:: <isonum.txt> |
4 | ||
5377d91f MH |
5 | ############################## |
6 | LINUX MEDIA INFRASTRUCTURE API | |
7 | ############################## | |
8 | ||
40f7bc9b | 9 | **Copyright** |copy| 2009-2016 : LinuxTV Developers |
5377d91f MH |
10 | |
11 | Permission is granted to copy, distribute and/or modify this document | |
12 | under the terms of the GNU Free Documentation License, Version 1.1 or | |
13 | any later version published by the Free Software Foundation. A copy of | |
14 | the license is included in the chapter entitled "GNU Free Documentation | |
15 | License" | |
16 | ||
17 | ||
18 | ============ | |
19 | Introduction | |
20 | ============ | |
21 | ||
22 | This document covers the Linux Kernel to Userspace API's used by video | |
23 | and radio streaming devices, including video cameras, analog and digital | |
24 | TV receiver cards, AM/FM receiver cards, streaming capture and output | |
25 | devices, codec devices and remote controllers. | |
26 | ||
27 | A typical media device hardware is shown at | |
28 | :ref:`typical_media_device`. | |
29 | ||
30 | ||
31 | .. _typical_media_device: | |
32 | ||
33 | .. figure:: media_api_files/typical_media_device.* | |
34 | :alt: typical_media_device.svg | |
35 | :align: center | |
36 | ||
37 | Typical Media Device | |
38 | ||
39 | Typical Media Device Block Diagram | |
40 | ||
41 | ||
42 | ||
43 | The media infrastructure API was designed to control such devices. It is | |
44 | divided into four parts. | |
45 | ||
46 | The first part covers radio, video capture and output, cameras, analog | |
47 | TV devices and codecs. | |
48 | ||
49 | The second part covers the API used for digital TV and Internet | |
50 | reception via one of the several digital tv standards. While it is | |
51 | called as DVB API, in fact it covers several different video standards | |
52 | including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S,etc. The | |
53 | complete list of supported standards can be found at | |
54 | :ref:`fe-delivery-system-t`. | |
55 | ||
56 | The third part covers the Remote Controller API. | |
57 | ||
58 | The fourth part covers the Media Controller API. | |
59 | ||
60 | It should also be noted that a media device may also have audio | |
61 | components, like mixers, PCM capture, PCM playback, etc, which are | |
62 | controlled via ALSA API. | |
63 | ||
64 | For additional information and for the latest development code, see: | |
65 | `https://linuxtv.org <https://linuxtv.org>`__. | |
66 | ||
67 | For discussing improvements, reporting troubles, sending new drivers, | |
68 | etc, please mail to: | |
69 | `Linux Media Mailing List (LMML). <http://vger.kernel.org/vger-lists.html#linux-media>`__. | |
70 | ||
71 | ||
72 | .. toctree:: | |
73 | :maxdepth: 1 | |
74 | ||
75 | media/v4l/v4l2 | |
76 | media/dvb/dvbapi | |
77 | media/v4l/remote_controllers | |
78 | media/v4l/media-controller | |
79 | media/v4l/gen-errors | |
80 | media/v4l/fdl-appendix | |
81 | ||
82 | ||
83 | ||
84 | ||
85 | .. ------------------------------------------------------------------------------ | |
86 | .. This file was automatically converted from DocBook-XML with the dbxml | |
87 | .. library (https://github.com/return42/sphkerneldoc). The origin XML comes | |
88 | .. from the linux kernel, refer to: | |
89 | .. | |
90 | .. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook | |
91 | .. ------------------------------------------------------------------------------ | |
92 | ||
93 | ||
94 | .. only:: html | |
95 | ||
96 | Retrieval | |
97 | ========= | |
98 | ||
99 | * :ref:`genindex` | |
100 | ||
101 | .. todolist:: | |
102 |