diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-08 17:40:06 +0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-08 17:59:40 +0300 |
commit | 60c2820d0f6d3497975b6488e2599f8f611d8b95 (patch) | |
tree | b3b03707c6438ea9b99cc57e847ebf517f968ab1 /Documentation/media/media_uapi.rst | |
parent | a97369b5e21ea9b8b5fef7c0f4f48bbe60c07ca3 (diff) | |
download | linux-60c2820d0f6d3497975b6488e2599f8f611d8b95.tar.xz |
doc_rst: rename the media Sphinx suff to Documentation/media
The name of the subsystem is "media", and not "linux_tv". Also,
as we plan to add other stuff there in the future, let's
rename also the media uAPI book to media_uapi, to make it
clearer.
No functional changes.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/media_uapi.rst')
-rw-r--r-- | Documentation/media/media_uapi.rst | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst new file mode 100644 index 000000000000..8211cc963b56 --- /dev/null +++ b/Documentation/media/media_uapi.rst @@ -0,0 +1,83 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. include:: <isonum.txt> + +############################## +Linux Media Infrastructure API +############################## + +**Copyright** |copy| 2009-2016 : LinuxTV Developers + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 or +any later version published by the Free Software Foundation. A copy of +the license is included in the chapter entitled "GNU Free Documentation +License". + + +============ +Introduction +============ + +This document covers the Linux Kernel to Userspace API's used by video +and radio streaming devices, including video cameras, analog and digital +TV receiver cards, AM/FM receiver cards, Software Defined Radio (SDR), +streaming capture and output devices, codec devices and remote controllers. + +A typical media device hardware is shown at +:ref:`typical_media_device`. + + +.. _typical_media_device: + +.. figure:: media_api_files/typical_media_device.* + :alt: typical_media_device.svg + :align: center + + Typical Media Device + +The media infrastructure API was designed to control such devices. It is +divided into four parts. + +The :Ref:`first part <v4l2spec>` covers radio, video capture and output, +cameras, analog TV devices and codecs. + +The :Ref:`second part <dvbapi>` covers the API used for digital TV and +Internet reception via one of the several digital tv standards. While it +is called as DVB API, in fact it covers several different video +standards including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S, +DTMB, etc. The complete list of supported standards can be found at +:ref:`fe-delivery-system-t`. + +The :Ref:`third part <remote_controllers>` covers the Remote Controller API. + +The :Ref:`fourth part <media_controller>` covers the Media Controller API. + +It should also be noted that a media device may also have audio +components, like mixers, PCM capture, PCM playback, etc, which are +controlled via ALSA API. + +For additional information and for the latest development code, see: +`https://linuxtv.org <https://linuxtv.org>`__. + +For discussing improvements, reporting troubles, sending new drivers, +etc, please mail to: +`Linux Media Mailing List (LMML). <http://vger.kernel.org/vger-lists.html#linux-media>`__. + + +.. toctree:: + :maxdepth: 1 + + uapi/v4l/v4l2 + uapi/dvb/dvbapi + uapi/rc/remote_controllers + uapi/mediactl/media-controller + uapi/gen-errors + uapi/fdl-appendix + +.. only:: html + + Retrieval + ========= + + * :ref:`genindex` |