summaryrefslogtreecommitdiffstats
path: root/Documentation/linux_tv/index.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2016-06-30 15:18:56 +0200
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-06-30 21:14:52 +0200
commit5377d91f3e88d5c8da46b1feba78b00d379fb7b6 (patch)
treee1b42603f4ccab1e027454cf04ebe7ea11bea30f /Documentation/linux_tv/index.rst
parentMerge branch 'docs-next' of git://git.lwn.net/linux into devel/docs-next (diff)
downloadlinux-5377d91f3e88d5c8da46b1feba78b00d379fb7b6.tar.xz
linux-5377d91f3e88d5c8da46b1feba78b00d379fb7b6.zip
doc-rst: linux_tv DocBook to reST migration (docs-next)
This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/linux_tv/index.rst')
-rw-r--r--Documentation/linux_tv/index.rst100
1 files changed, 100 insertions, 0 deletions
diff --git a/Documentation/linux_tv/index.rst b/Documentation/linux_tv/index.rst
new file mode 100644
index 000000000000..42b3d4520942
--- /dev/null
+++ b/Documentation/linux_tv/index.rst
@@ -0,0 +1,100 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+##############################
+LINUX MEDIA INFRASTRUCTURE API
+##############################
+
+**Copyright** 2009-2015 : 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, 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
+
+ Typical Media Device Block Diagram
+
+
+
+The media infrastructure API was designed to control such devices. It is
+divided into four parts.
+
+The first part covers radio, video capture and output, cameras, analog
+TV devices and codecs.
+
+The second part 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,etc. The
+complete list of supported standards can be found at
+:ref:`fe-delivery-system-t`.
+
+The third part covers the Remote Controller API.
+
+The fourth part 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
+
+ media/v4l/v4l2
+ media/dvb/dvbapi
+ media/v4l/remote_controllers
+ media/v4l/media-controller
+ media/v4l/gen-errors
+ media/v4l/fdl-appendix
+
+
+
+
+.. ------------------------------------------------------------------------------
+.. This file was automatically converted from DocBook-XML with the dbxml
+.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
+.. from the linux kernel, refer to:
+..
+.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
+.. ------------------------------------------------------------------------------
+
+
+.. only:: html
+
+ Retrieval
+ =========
+
+ * :ref:`genindex`
+
+.. todolist::
+