data_type large_stringclasses 3
values | source large_stringclasses 29
values | code large_stringlengths 98 49.4M | filepath large_stringlengths 5 161 ⌀ | message large_stringclasses 234
values | commit large_stringclasses 234
values | subject large_stringclasses 418
values | critique large_stringlengths 101 1.26M ⌀ | metadata dict |
|---|---|---|---|---|---|---|---|---|
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.net
.. _NET_GET_IF:
****************
ioctl NET_GET_IF
****************
Name
====
NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
Synopsis
========
.. c:macro:: NET_GET_IF
``int ioctl(i... | Documentation/userspace-api/media/dvb/net-get-if.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.net
.. _NET_REMOVE_IF:
*******************
ioctl NET_REMOVE_IF
*******************
Name
====
NET_REMOVE_IF - Removes a network interface.
Synopsis
========
.. c:macro:: NET_REMOVE_IF
``int ioctl(int fd, NET_REMOVE_IF, int ifnum)``
... | Documentation/userspace-api/media/dvb/net-remove-if.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _net_types:
**************
Net Data Types
**************
.. kernel-doc:: include/uapi/linux/dvb/net.h | Documentation/userspace-api/media/dvb/net-types.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _net:
######################
Digital TV Network API
######################
The Digital TV net device controls the mapping of data packages that are part
of a transport stream to be mapped into a virtual network interface,
visible through the standard Lin... | Documentation/userspace-api/media/dvb/net.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _query-dvb-frontend-info:
*****************************
Querying frontend information
*****************************
Usually, the first thing to do when the frontend is opened is to check
the frontend capabilities. This is done using
:ref:`FE_GET_INFO`. T... | Documentation/userspace-api/media/dvb/query-dvb-frontend-info.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _media-controller-intro:
Introduction
============
Media devices increasingly handle multiple related functions. Many USB
cameras include microphones, video capture hardware can also output
video, or SoC camera interfaces also perform memory-to-memory op... | Documentation/userspace-api/media/mediactl/media-controller-intro.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _media-controller-model:
Media device model
==================
Discovering a device internal topology, and configuring it at runtime,
is one of the goals of the media controller API. To achieve this,
hardware devices and Linux Kernel interfaces are model... | Documentation/userspace-api/media/mediactl/media-controller-model.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. include:: <isonum.txt>
.. _media_controller:
##############################
Part IV - Media Controller API
##############################
.. toctree::
:caption: Table of Contents
:maxdepth: 5
:numbered:
media-controller-intro
media-c... | Documentation/userspace-api/media/mediactl/media-controller.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media-func-close:
*************
media close()
*************
Name
====
media-close - Close a media device
Synopsis
========
.. code-block:: c
#include <unistd.h>
.. c:function:: int close( int fd )
Arguments
=========
``fd`... | Documentation/userspace-api/media/mediactl/media-func-close.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media-func-ioctl:
*************
media ioctl()
*************
Name
====
media-ioctl - Control a media device
Synopsis
========
.. code-block:: c
#include <sys/ioctl.h>
``int ioctl(int fd, int request, void *argp)``
Arguments
... | Documentation/userspace-api/media/mediactl/media-func-ioctl.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media-func-open:
************
media open()
************
Name
====
media-open - Open a media device
Synopsis
========
.. code-block:: c
#include <fcntl.h>
.. c:function:: int open( const char *device_name, int flags )
Argume... | Documentation/userspace-api/media/mediactl/media-func-open.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _media-user-func:
******************
Function Reference
******************
.. toctree::
:maxdepth: 1
media-func-open
media-func-close
media-func-ioctl
media-ioc-device-info
media-ioc-g-topology
media-ioc-enum-entities
me... | Documentation/userspace-api/media/mediactl/media-funcs.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _media_header:
*****************************
Media controller uAPI symbols
*****************************
.. kernel-include:: include/uapi/linux/media.h
:generate-cross-refs:
:exception-file: media.h.rst.exceptions
:toc:
:warn-broken: | Documentation/userspace-api/media/mediactl/media-header.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_ioc_device_info:
***************************
ioctl MEDIA_IOC_DEVICE_INFO
***************************
Name
====
MEDIA_IOC_DEVICE_INFO - Query device information
Synopsis
========
.. c:macro:: MEDIA_IOC_DEVICE_INFO
``int ioct... | Documentation/userspace-api/media/mediactl/media-ioc-device-info.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_ioc_enum_entities:
*****************************
ioctl MEDIA_IOC_ENUM_ENTITIES
*****************************
Name
====
MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties
Synopsis
========
.. c:macro:: MEDIA_IO... | Documentation/userspace-api/media/mediactl/media-ioc-enum-entities.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_ioc_enum_links:
**************************
ioctl MEDIA_IOC_ENUM_LINKS
**************************
Name
====
MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity
Synopsis
========
.. c:macro:: MEDIA_IOC_ENUM_... | Documentation/userspace-api/media/mediactl/media-ioc-enum-links.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_ioc_g_topology:
**************************
ioctl MEDIA_IOC_G_TOPOLOGY
**************************
Name
====
MEDIA_IOC_G_TOPOLOGY - Enumerate the graph topology and graph element properties
Synopsis
========
.. c:macro:: MEDIA... | Documentation/userspace-api/media/mediactl/media-ioc-g-topology.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_ioc_request_alloc:
*****************************
ioctl MEDIA_IOC_REQUEST_ALLOC
*****************************
Name
====
MEDIA_IOC_REQUEST_ALLOC - Allocate a request
Synopsis
========
.. c:macro:: MEDIA_IOC_REQUEST_... | Documentation/userspace-api/media/mediactl/media-ioc-request-alloc.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_ioc_setup_link:
**************************
ioctl MEDIA_IOC_SETUP_LINK
**************************
Name
====
MEDIA_IOC_SETUP_LINK - Modify the properties of a link
Synopsis
========
.. c:macro:: MEDIA_IOC_SETUP_LINK
``int ioc... | Documentation/userspace-api/media/mediactl/media-ioc-setup-link.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_request_ioc_queue:
*****************************
ioctl MEDIA_REQUEST_IOC_QUEUE
*****************************
Name
====
MEDIA_REQUEST_IOC_QUEUE - Queue a request
Synopsis
========
.. c:macro:: MEDIA_REQUEST_IOC_QUE... | Documentation/userspace-api/media/mediactl/media-request-ioc-queue.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media_request_ioc_reinit:
******************************
ioctl MEDIA_REQUEST_IOC_REINIT
******************************
Name
====
MEDIA_REQUEST_IOC_REINIT - Re-initialize a request
Synopsis
========
.. c:macro:: MEDIA_RE... | Documentation/userspace-api/media/mediactl/media-request-ioc-reinit.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. _media-controller-types:
Types and flags used to represent the media graph elements
==========================================================
.. tabularcolumns:: |p{8.2cm}|p{9.3cm}|
.. _media-entity-functions:
.. _MEDIA-ENT-F-UNKNOWN:
.. _MEDIA-ENT-F-... | Documentation/userspace-api/media/mediactl/media-types.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _media-request-api:
Request API
===========
The Request API has been designed to allow V4L2 to deal with requirements of
modern devices (stateless codecs, complex camera pipelines, ...) and APIs
(Android Codec v2). One such... | Documentation/userspace-api/media/mediactl/request-api.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC.request
.. _request-func-close:
***************
request close()
***************
Name
====
request-close - Close a request file descriptor
Synopsis
========
.. code-block:: c
#include <unistd.h>
.. c:function:: int clo... | Documentation/userspace-api/media/mediactl/request-func-close.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _request-func-ioctl:
***************
request ioctl()
***************
Name
====
request-ioctl - Control a request file descriptor
Synopsis
========
.. code-block:: c
#include <sys/ioctl.h>
``int ioctl(int fd, int cm... | Documentation/userspace-api/media/mediactl/request-func-ioctl.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: MC
.. _request-func-poll:
**************
request poll()
**************
Name
====
request-poll - Wait for some event on a file descriptor
Synopsis
========
.. code-block:: c
#include <sys/poll.h>
.. c:function:: int poll(... | Documentation/userspace-api/media/mediactl/request-func-poll.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
file: uapi/v4l/keytable.c
=========================
.. code-block:: c
/* keytable.c - This program allows checking/replacing keys at IR
Copyright (C) 2006-2009 Mauro Carvalho Chehab <mchehab@kernel.org>
This program is free so... | Documentation/userspace-api/media/rc/keytable.c.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _lirc_dev_intro:
************
Introduction
************
LIRC stands for Linux Infrared Remote Control. The LIRC device interface is
a bi-directional interface for transporting raw IR and decoded scancodes
data between userspace and kernelspace... | Documentation/userspace-api/media/rc/lirc-dev-intro.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _lirc_dev:
LIRC Device Interface
=====================
.. toctree::
:maxdepth: 1
lirc-dev-intro
lirc-func
lirc-header | Documentation/userspace-api/media/rc/lirc-dev.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _lirc_func:
LIRC Function Reference
=======================
.. toctree::
:maxdepth: 1
lirc-read
lirc-write
lirc-get-features
lirc-get-send-mode
lirc-get-rec-mode
lirc-get-rec-resolution
lirc-set-send-duty-cycl... | Documentation/userspace-api/media/rc/lirc-func.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_features:
***********************
ioctl LIRC_GET_FEATURES
***********************
Name
====
LIRC_GET_FEATURES - Get the underlying hardware device's features
Synopsis
========
.. c:macro:: LIRC_GET_FEATURES
``... | Documentation/userspace-api/media/rc/lirc-get-features.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_rec_mode:
.. _lirc_set_rec_mode:
**********************************************
ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_MODE
**********************************************
Name
====
LIRC_GET_REC_MODE/LIRC_SET_R... | Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_rec_resolution:
*****************************
ioctl LIRC_GET_REC_RESOLUTION
*****************************
Name
====
LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds.
Synopsis
===... | Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_send_mode:
.. _lirc_set_send_mode:
************************************************
ioctls LIRC_GET_SEND_MODE and LIRC_SET_SEND_MODE
************************************************
Name
====
LIRC_GET_SEND_MODE/L... | Documentation/userspace-api/media/rc/lirc-get-send-mode.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_min_timeout:
.. _lirc_get_max_timeout:
****************************************************
ioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT
****************************************************
Name
====
LIRC... | Documentation/userspace-api/media/rc/lirc-get-timeout.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _lirc_header:
*****************
LIRC uAPI symbols
*****************
.. contents:: Table of Contents
:depth: 2
:local:
.. kernel-include:: include/uapi/linux/lirc.h
:generate-cross-refs:
:exception-file: lirc.h.rst.exceptions
... | Documentation/userspace-api/media/rc/lirc-header.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc-read:
***********
LIRC read()
***********
Name
====
lirc-read - Read from a LIRC device
Synopsis
========
.. code-block:: c
#include <unistd.h>
.. c:function:: ssize_t read( int fd, void *buf, size_t count )
... | Documentation/userspace-api/media/rc/lirc-read.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_measure_carrier_mode:
***********************************
ioctl LIRC_SET_MEASURE_CARRIER_MODE
***********************************
Name
====
LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
Synopsis... | Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_carrier_range:
********************************
ioctl LIRC_SET_REC_CARRIER_RANGE
********************************
Name
====
LIRC_SET_REC_CARRIER_RANGE - Set lower bound of the carrier used to modulate
IR rece... | Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_carrier:
**************************
ioctl LIRC_SET_REC_CARRIER
**************************
Name
====
LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
Synopsis
========
.. c:macro:: LIRC_SET_RE... | Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_timeout:
.. _lirc_get_rec_timeout:
***************************************************
ioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT
***************************************************
Name
====
LIRC_GE... | Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_send_carrier:
***************************
ioctl LIRC_SET_SEND_CARRIER
***************************
Name
====
LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
Synopsis
========
.. c:macro:: LIRC_S... | Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_send_duty_cycle:
******************************
ioctl LIRC_SET_SEND_DUTY_CYCLE
******************************
Name
====
LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle of the carrier signal for
IR transmit.
Synops... | Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_transmitter_mask:
*******************************
ioctl LIRC_SET_TRANSMITTER_MASK
*******************************
Name
====
LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
Synopsis
... | Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_wideband_receiver:
********************************
ioctl LIRC_SET_WIDEBAND_RECEIVER
********************************
Name
====
LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
Synopsis
========
.. c:mac... | Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc-write:
************
LIRC write()
************
Name
====
lirc-write - Write to a LIRC device
Synopsis
========
.. code-block:: c
#include <unistd.h>
.. c:function:: ssize_t write( int fd, void *buf, size_t cou... | Documentation/userspace-api/media/rc/lirc-write.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _Remote_controllers_Intro:
************
Introduction
************
Currently, most analog and digital devices have a Infrared input for
remote controllers. Each manufacturer has their own type of control. It
is not rare for the same manufacture... | Documentation/userspace-api/media/rc/rc-intro.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _Remote_controllers_Protocols:
*****************************************
Remote Controller Protocols and Scancodes
*****************************************
IR is encoded as a series of pulses and spaces, using a protocol. These
protocols can ... | Documentation/userspace-api/media/rc/rc-protos.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _remote_controllers_sysfs_nodes:
*******************************
Remote Controller's sysfs nodes
*******************************
As defined at Documentation/ABI/testing/sysfs-class-rc, those are
the sysfs nodes that control the Remote Controll... | Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _Remote_controllers_table_change:
*******************************************
Changing default Remote Controller mappings
*******************************************
The event interface provides two ioctls to be used against the
/dev/input/eve... | Documentation/userspace-api/media/rc/rc-table-change.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. _Remote_controllers_tables:
************************
Remote controller tables
************************
Unfortunately, for several years, there was no effort to create uniform
IR keycodes for different devices. This caused the same IR keyname t... | Documentation/userspace-api/media/rc/rc-tables.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. include:: <isonum.txt>
.. _remote_controllers:
################################
Part III - Remote Controller API
################################
.. toctree::
:caption: Table of Contents
:maxdepth: 5
:numbered:
rc-intro
rc... | Documentation/userspace-api/media/rc/remote_controllers.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _app-pri:
********************
Application Priority
********************
When multiple applications share a device it may be desirable to assign
them different priorities. Contrary to the traditional "rm -rf /" school
of thought, a v... | Documentation/userspace-api/media/v4l/app-pri.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _audio:
************************
Audio Inputs and Outputs
************************
Audio inputs and outputs are physical connectors of a device. Video
capture devices have inputs, output devices have outputs, zero or more
each. Radio... | Documentation/userspace-api/media/v4l/audio.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
**********
References
**********
.. _cea608:
CEA 608-E
=========
:title: CEA-608-E R-2014 "Line 21 Data Services"
:author: Consumer Electronics Association (http://www.ce.org)
.. _en300294:
EN 300 294
==========
:title: ... | Documentation/userspace-api/media/v4l/biblio.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _buffer:
*******
Buffers
*******
A buffer contains data exchanged by application and driver using one of
the Streaming I/O methods. In the multi-planar API, the data is held in
planes, while the buffer structure acts as a container f... | Documentation/userspace-api/media/v4l/buffer.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _capture-example:
*********************
Video Capture Example
*********************
.. toctree::
:maxdepth: 1
capture.c | Documentation/userspace-api/media/v4l/capture-example.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
file: media/v4l/capture.c
=========================
.. code-block:: c
/*
* V4L2 video capture example
*
* This program can be used and distributed without restrictions.
*
* This program is provided wi... | Documentation/userspace-api/media/v4l/capture.c.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
****************************
Defining Colorspaces in V4L2
****************************
In V4L2 colorspaces are defined by four values. The first is the
colorspace identifier (enum :c:type:`v4l2_colorspace`)
which defines the chromaticiti... | Documentation/userspace-api/media/v4l/colorspaces-defs.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
********************************
Detailed Colorspace Descriptions
********************************
.. _col-smpte-170m:
Colorspace SMPTE 170M (V4L2_COLORSPACE_SMPTE170M)
=================================================
The :ref:`smpte... | Documentation/userspace-api/media/v4l/colorspaces-details.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _colorspaces:
***********
Colorspaces
***********
'Color' is a very complex concept and depends on physics, chemistry and
biology. Just because you have three numbers that describe the 'red',
'green' and 'blue' components of the colo... | Documentation/userspace-api/media/v4l/colorspaces.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _common-defs:
******************************************************
Common definitions for V4L2 and V4L2 subdev interfaces
******************************************************
.. toctree::
:maxdepth: 1
selections-common | Documentation/userspace-api/media/v4l/common-defs.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _common:
###################
Common API Elements
###################
Programming a V4L2 device consists of these steps:
- Opening the device
- Changing device properties, selecting a video and audio input, video
standard, pictu... | Documentation/userspace-api/media/v4l/common.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _compat:
*******
Changes
*******
The following chapters document the evolution of the V4L2 API, errata or
extensions. They are also intended to help application and driver
writers to port or update their code.
.. toctree::
:max... | Documentation/userspace-api/media/v4l/compat.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _control:
*************
User Controls
*************
Devices typically have a number of user-settable controls such as
brightness, saturation and so on, which would be presented to the user
on a graphical user interface. But, differen... | Documentation/userspace-api/media/v4l/control.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _crop:
*****************************************************
Image Cropping, Insertion and Scaling -- the CROP API
*****************************************************
.. note::
The CROP API is mostly superseded by the newer :re... | Documentation/userspace-api/media/v4l/crop.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _depth-formats:
*************
Depth Formats
*************
Depth data provides distance to points, mapped onto the image plane
.. toctree::
:maxdepth: 1
pixfmt-inzi
pixfmt-z16
pixfmt-cnf4 | Documentation/userspace-api/media/v4l/depth-formats.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _capture:
***********************
Video Capture Interface
***********************
Video capture devices sample an analog video signal and store the
digitized images in memory. Today nearly all devices can capture at full
25 or 30 fra... | Documentation/userspace-api/media/v4l/dev-capture.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. c:namespace:: V4L
.. _decoder:
*************************************************
Memory-to-Memory Stateful Video Decoder Interface
*************************************************
A stateful video decoder takes complete chunks of the bytestream (e.g. Annex-B
H.264/HEVC stream,... | Documentation/userspace-api/media/v4l/dev-decoder.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _encoder:
*************************************************
Memory-to-Memory Stateful Video Encoder Interface
*************************************************
A stateful video encoder takes raw video frames in display ord... | Documentation/userspace-api/media/v4l/dev-encoder.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _event:
***************
Event Interface
***************
The V4L2 event interface provides a means for a user to get immediately
notified on certain conditions taking place on a device. This might
include start of frame or loss of sig... | Documentation/userspace-api/media/v4l/dev-event.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _mem2mem:
********************************
Video Memory-To-Memory Interface
********************************
A V4L2 memory-to-memory device can compress, decompress, transform, or
otherwise convert video data from one format into ano... | Documentation/userspace-api/media/v4l/dev-mem2mem.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _metadata:
******************
Metadata Interface
******************
Metadata refers to any non-image data that supplements video frames with
additional information. This may include statistics computed over the image,
frame capture p... | Documentation/userspace-api/media/v4l/dev-meta.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _osd:
******************************
Video Output Overlay Interface
******************************
**Also known as On-Screen Display (OSD)**
Some video output devices can overlay a framebuffer image onto the
outgoing video signal. A... | Documentation/userspace-api/media/v4l/dev-osd.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _output:
**********************
Video Output Interface
**********************
Video output devices encode stills or image sequences as analog video
signal. With this interface applications can control the encoding
process and move im... | Documentation/userspace-api/media/v4l/dev-output.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _overlay:
***********************
Video Overlay Interface
***********************
**Also known as Framebuffer Overlay or Previewing.**
Video overlay devices have the ability to genlock (TV-)video into the
(VGA-)video signal of a gra... | Documentation/userspace-api/media/v4l/dev-overlay.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _radio:
***************
Radio Interface
***************
This interface is intended for AM and FM (analog) radio receivers and
transmitters.
Conventionally V4L2 radio devices are accessed through character device
special files named ... | Documentation/userspace-api/media/v4l/dev-radio.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _raw-vbi:
**********************
Raw VBI Data Interface
**********************
VBI is an abbreviation of Vertical Blanking Interval, a gap in the
sequence of lines of an analog video signal. During VBI no picture
information is trans... | Documentation/userspace-api/media/v4l/dev-raw-vbi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _rds:
*************
RDS Interface
*************
The Radio Data System transmits supplementary information in binary
format, for example the station name or travel information, on an
inaudible audio subcarrier of a radio program. This... | Documentation/userspace-api/media/v4l/dev-rds.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _sdr:
**************************************
Software Defined Radio Interface (SDR)
**************************************
SDR is an abbreviation of Software Defined Radio, the radio device which
uses application software for modulat... | Documentation/userspace-api/media/v4l/dev-sdr.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _sliced:
*************************
Sliced VBI Data Interface
*************************
VBI stands for Vertical Blanking Interval, a gap in the sequence of
lines of an analog video signal. During VBI no picture information is
transmit... | Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. c:namespace:: V4L
.. _stateless_decoder:
**************************************************
Memory-to-memory Stateless Video Decoder Interface
**************************************************
A stateless decoder is a decoder that works without retaining any kind of state
betw... | Documentation/userspace-api/media/v4l/dev-stateless-decoder.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _subdev:
********************
Sub-device Interface
********************
The complex nature of V4L2 devices, where hardware is often made of
several integrated circuits that need to interact with each other in a
controlled way, leads ... | Documentation/userspace-api/media/v4l/dev-subdev.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _touch:
*************
Touch Devices
*************
Touch devices are accessed through character device special files named
``/dev/v4l-touch0`` to ``/dev/v4l-touch255`` with major number 81 and
dynamically allocated minor numbers 0 to ... | Documentation/userspace-api/media/v4l/dev-touch.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _devices:
**********
Interfaces
**********
.. toctree::
:maxdepth: 1
dev-capture
dev-overlay
dev-output
dev-osd
dev-mem2mem
dev-raw-vbi
dev-sliced-vbi
dev-radio
dev-rds
dev-sdr
dev-to... | Documentation/userspace-api/media/v4l/devices.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _diff-v4l:
********************************
Differences between V4L and V4L2
********************************
The Video For Linux API was first introduced in Linux 2.1 to unify and
replace various TV and radio device related interfac... | Documentation/userspace-api/media/v4l/diff-v4l.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _dmabuf:
************************************
Streaming I/O (DMA buffer importing)
************************************
The DMABUF framework provides a generic method for sharing buffers
between multiple devices. Device drivers that ... | Documentation/userspace-api/media/v4l/dmabuf.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _dv-timings:
**************************
Digital Video (DV) Timings
**************************
The video standards discussed so far have been dealing with Analog TV
and the corresponding video timings. Today there are many more differ... | Documentation/userspace-api/media/v4l/dv-timings.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _camera-controls:
************************
Camera Control Reference
************************
The Camera class includes controls for mechanical (or equivalent
digital) features of a device such as controllable lenses or sensors.
.. ... | Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _codec-stateless-controls:
*********************************
Stateless Codec Control Reference
*********************************
The Stateless Codec control class is intended to support
stateless decoder and encoders (i.e. hardware a... | Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _codec-controls:
***********************
Codec Control Reference
***********************
Below all controls within the Codec control class are described. First
the generic controls, then controls specific for certain hardware.
.. no... | Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _colorimetry-controls:
*****************************
Colorimetry Control Reference
*****************************
The Colorimetry class includes controls for High Dynamic Range
imaging for representing colors in digital images and vid... | Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _detect-controls:
************************
Detect Control Reference
************************
The Detect class includes controls for common features of various motion
or object detection capable devices.
.. _detect-control-id:
Dete... | Documentation/userspace-api/media/v4l/ext-ctrls-detect.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _dv-controls:
*******************************
Digital Video Control Reference
*******************************
The Digital Video control class is intended to control receivers and
transmitters for `VGA <http://en.wikipedia.org/wiki/Vg... | Documentation/userspace-api/media/v4l/ext-ctrls-dv.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _flash-controls:
***********************
Flash Control Reference
***********************
The V4L2 flash controls are intended to provide generic access to flash
controller devices. Flash controller devices are typically used in
digit... | Documentation/userspace-api/media/v4l/ext-ctrls-flash.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _fm-rx-controls:
*****************************
FM Receiver Control Reference
*****************************
The FM Receiver (FM_RX) class includes controls for common features of
FM Reception capable devices.
.. _fm-rx-control-id:
... | Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _fm-tx-controls:
********************************
FM Transmitter Control Reference
********************************
The FM Transmitter (FM_TX) class includes controls for common features
of FM transmissions capable devices. Currently... | Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _image-process-controls:
*******************************
Image Process Control Reference
*******************************
The Image Process control class is intended for low-level control of
image processing functions. Unlike ``V4L2_C... | Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _image-source-controls:
******************************
Image Source Control Reference
******************************
The Image Source control class is intended for low-level control of
image source devices such as image sensors. The ... | Documentation/userspace-api/media/v4l/ext-ctrls-image-source.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: V4L
.. _jpeg-controls:
**********************
JPEG Control Reference
**********************
The JPEG class includes controls for common features of JPEG encoders
and decoders. Currently it includes features for codecs implementing
progressi... | Documentation/userspace-api/media/v4l/ext-ctrls-jpeg.rst | null | null | null | null | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.