leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[media] v4l: doc: Remove row numbers from tables

Browse Source 
Shorten the tables by removing row numbers in comments, allowing for
later insertion of rows with minimal diffs.

All changes have been generated by the following script.

import io
import re
import sys

def process_table(fname, data):
	if fname.endswith('hist-v4l2.rst'):
		data = re.sub(u'\n{1,2}\t( ?)  -( ?) ?', u'\n\t\\1 -\\2', data, flags = re.MULTILINE)
		data = re.sub(u'\n(\t|       )-  \.\. row [0-9]+\n\t  ?-( ?) ?', u'\\1* -\\2', data, flags = re.MULTILINE)
	else:
		data = re.sub(u'\n{1,2}       -( ?) ?', u'\n      -\\1', data, flags = re.MULTILINE)
		data = re.sub(u'(\n?)(\n\n    -  \.\. row 1\n)', u'\n\\2', data, flags = re.MULTILINE)
		data = re.sub(u'\n    -  \.\. row [0-9]+\n      -( ?) ?', u'    * -\\1', data, flags = re.MULTILINE)
		data = re.sub(u'\n    -  \.\. row [0-9]+\n       \.\. (_[A-Z0-9_`-]*:)', u'\n    -  .. \\1', data, flags = re.MULTILINE)
		data = re.sub(u'\n    -  \.\. (_[A-Z0-9_`-]*:)\n      -', u'    * .. \\1\n\n      -', data, flags = re.MULTILINE)
		data = re.sub(u'^       - ', u'      -', data, flags = re.MULTILINE)
		data = re.sub(u'^(\t{1,2})  ', u'\\1', data, flags = re.MULTILINE)

	return data

def process_file(fname, data):
	buf = io.StringIO(data)
	output = ''
	in_table = False
	table_separator = 0

	for line in buf.readlines():
		if line.find('.. flat-table::') != -1:
			in_table = True
			table = ''
		elif in_table and not re.match('^[\t\n]|(    )', line):
			in_table = False
			output += process_table(fname, table)

		if in_table:
			table += line
		else:
			output += line

	if in_table:
		in_table = False
		output += process_table(fname, table)

	return output

fname = sys.argv[1]

data = file(fname, 'rb').read().decode('utf-8')
data = process_file(fname, data)
file(fname, 'wb').write(data.encode('utf-8'))

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2016-09-05 08:44:34 -03:00 committed by Mauro Carvalho Chehab
parent c19584882a
commit c2b66cafdf
112 changed files with 15269 additions and 30896 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1329
Documentation/media/uapi/v4l/buffer.rst
View File

File diff suppressed because it is too large Load Diff

133
Documentation/media/uapi/v4l/control.rst
View File

@ -198,104 +198,41 @@ Control IDs
:stub-columns: 0 :stub-columns: 0
:widths: 11 24 :widths: 11 24
- .. row 1 * - ``V4L2_COLORFX_NONE``
- Color effect is disabled.
- ``V4L2_COLORFX_NONE`` * - ``V4L2_COLORFX_ANTIQUE``
- An aging (old photo) effect.
- Color effect is disabled. * - ``V4L2_COLORFX_ART_FREEZE``
- Frost color effect.
- .. row 2 * - ``V4L2_COLORFX_AQUA``
- Water color, cool tone.
- ``V4L2_COLORFX_ANTIQUE`` * - ``V4L2_COLORFX_BW``
- Black and white.
- An aging (old photo) effect. * - ``V4L2_COLORFX_EMBOSS``
- Emboss, the highlights and shadows replace light/dark boundaries
- .. row 3 and low contrast areas are set to a gray background.
* - ``V4L2_COLORFX_GRASS_GREEN``
- ``V4L2_COLORFX_ART_FREEZE`` - Grass green.
* - ``V4L2_COLORFX_NEGATIVE``
- Frost color effect. - Negative.
* - ``V4L2_COLORFX_SEPIA``
- .. row 4 - Sepia tone.
* - ``V4L2_COLORFX_SKETCH``
- ``V4L2_COLORFX_AQUA`` - Sketch.
* - ``V4L2_COLORFX_SKIN_WHITEN``
- Water color, cool tone. - Skin whiten.
* - ``V4L2_COLORFX_SKY_BLUE``
- .. row 5 - Sky blue.
* - ``V4L2_COLORFX_SOLARIZATION``
- ``V4L2_COLORFX_BW`` - Solarization, the image is partially reversed in tone, only color
values above or below a certain threshold are inverted.
- Black and white. * - ``V4L2_COLORFX_SILHOUETTE``
- Silhouette (outline).
- .. row 6 * - ``V4L2_COLORFX_VIVID``
- Vivid colors.
- ``V4L2_COLORFX_EMBOSS`` * - ``V4L2_COLORFX_SET_CBCR``
- The Cb and Cr chroma components are replaced by fixed coefficients
- Emboss, the highlights and shadows replace light/dark boundaries determined by ``V4L2_CID_COLORFX_CBCR`` control.
and low contrast areas are set to a gray background.
- .. row 7
- ``V4L2_COLORFX_GRASS_GREEN``
- Grass green.
- .. row 8
- ``V4L2_COLORFX_NEGATIVE``
- Negative.
- .. row 9
- ``V4L2_COLORFX_SEPIA``
- Sepia tone.
- .. row 10
- ``V4L2_COLORFX_SKETCH``
- Sketch.
- .. row 11
- ``V4L2_COLORFX_SKIN_WHITEN``
- Skin whiten.
- .. row 12
- ``V4L2_COLORFX_SKY_BLUE``
- Sky blue.
- .. row 13
- ``V4L2_COLORFX_SOLARIZATION``
- Solarization, the image is partially reversed in tone, only color
values above or below a certain threshold are inverted.
- .. row 14
- ``V4L2_COLORFX_SILHOUETTE``
- Silhouette (outline).
- .. row 15
- ``V4L2_COLORFX_VIVID``
- Vivid colors.
- .. row 16
- ``V4L2_COLORFX_SET_CBCR``
- The Cb and Cr chroma components are replaced by fixed coefficients
determined by ``V4L2_CID_COLORFX_CBCR`` control.

235
Documentation/media/uapi/v4l/dev-raw-vbi.rst
View File

@ -110,120 +110,77 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- ``sampling_rate``
- Samples per second, i. e. unit 1 Hz.
* - __u32
- ``offset``
- Horizontal offset of the VBI image, relative to the leading edge
of the line synchronization pulse and counted in samples: The
first sample in the VBI image will be located ``offset`` /
``sampling_rate`` seconds following the leading edge. See also
:ref:`vbi-hsync`.
* - __u32
- ``samples_per_line``
-
* - __u32
- ``sample_format``
- Defines the sample format as in :ref:`pixfmt`, a
four-character-code. [#f2]_ Usually this is ``V4L2_PIX_FMT_GREY``,
i. e. each sample consists of 8 bits with lower values oriented
towards the black level. Do not assume any other correlation of
values with the signal level. For example, the MSB does not
necessarily indicate if the signal is 'high' or 'low' because 128
may not be the mean value of the signal. Drivers shall not convert
the sample format by software.
* - __u32
- ``start``\ [#f2]_
- This is the scanning system line number associated with the first
line of the VBI image, of the first and the second field
respectively. See :ref:`vbi-525` and :ref:`vbi-625` for valid
values. The ``V4L2_VBI_ITU_525_F1_START``,
``V4L2_VBI_ITU_525_F2_START``, ``V4L2_VBI_ITU_625_F1_START`` and
``V4L2_VBI_ITU_625_F2_START`` defines give the start line numbers
for each field for each 525 or 625 line format as a convenience.
Don't forget that ITU line numbering starts at 1, not 0. VBI input
drivers can return start values 0 if the hardware cannot reliable
identify scanning lines, VBI acquisition may not require this
information.
* - __u32
- ``count``\ [#f2]_
- The number of lines in the first and second field image,
respectively.
* - :cspan:`2`
- .. row 1 Drivers should be as flexibility as possible. For example, it may
be possible to extend or move the VBI capture window down to the
picture area, implementing a 'full field mode' to capture data
service transmissions embedded in the picture.
- __u32 An application can set the first or second ``count`` value to zero
if no data is required from the respective field; ``count``\ [1]
if the scanning system is progressive, i. e. not interlaced. The
corresponding start value shall be ignored by the application and
driver. Anyway, drivers may not support single field capturing and
return both count values non-zero.
- ``sampling_rate`` Both ``count`` values set to zero, or line numbers are outside the
bounds depicted\ [#f4]_, or a field image covering lines of two
fields, are invalid and shall not be returned by the driver.
- Samples per second, i. e. unit 1 Hz. To initialize the ``start`` and ``count`` fields, applications
must first determine the current video standard selection. The
- .. row 2 :ref:`v4l2_std_id <v4l2-std-id>` or the ``framelines`` field
of struct :c:type:`v4l2_standard` can be evaluated
- __u32 for this purpose.
* - __u32
- ``offset`` - ``flags``
- See :ref:`vbifmt-flags` below. Currently only drivers set flags,
- Horizontal offset of the VBI image, relative to the leading edge applications must set this field to zero.
of the line synchronization pulse and counted in samples: The * - __u32
first sample in the VBI image will be located ``offset`` / - ``reserved``\ [#f2]_
``sampling_rate`` seconds following the leading edge. See also - This array is reserved for future extensions. Drivers and
:ref:`vbi-hsync`. applications must set it to zero.
- .. row 3
- __u32
- ``samples_per_line``
-
- .. row 4
- __u32
- ``sample_format``
- Defines the sample format as in :ref:`pixfmt`, a
four-character-code. [#f2]_ Usually this is ``V4L2_PIX_FMT_GREY``,
i. e. each sample consists of 8 bits with lower values oriented
towards the black level. Do not assume any other correlation of
values with the signal level. For example, the MSB does not
necessarily indicate if the signal is 'high' or 'low' because 128
may not be the mean value of the signal. Drivers shall not convert
the sample format by software.
- .. row 5
- __u32
- ``start``\ [#f2]_
- This is the scanning system line number associated with the first
line of the VBI image, of the first and the second field
respectively. See :ref:`vbi-525` and :ref:`vbi-625` for valid
values. The ``V4L2_VBI_ITU_525_F1_START``,
``V4L2_VBI_ITU_525_F2_START``, ``V4L2_VBI_ITU_625_F1_START`` and
``V4L2_VBI_ITU_625_F2_START`` defines give the start line numbers
for each field for each 525 or 625 line format as a convenience.
Don't forget that ITU line numbering starts at 1, not 0. VBI input
drivers can return start values 0 if the hardware cannot reliable
identify scanning lines, VBI acquisition may not require this
information.
- .. row 6
- __u32
- ``count``\ [#f2]_
- The number of lines in the first and second field image,
respectively.
- .. row 7
- :cspan:`2`
Drivers should be as flexibility as possible. For example, it may
be possible to extend or move the VBI capture window down to the
picture area, implementing a 'full field mode' to capture data
service transmissions embedded in the picture.
An application can set the first or second ``count`` value to zero
if no data is required from the respective field; ``count``\ [1]
if the scanning system is progressive, i. e. not interlaced. The
corresponding start value shall be ignored by the application and
driver. Anyway, drivers may not support single field capturing and
return both count values non-zero.
Both ``count`` values set to zero, or line numbers are outside the
bounds depicted\ [#f4]_, or a field image covering lines of two
fields, are invalid and shall not be returned by the driver.
To initialize the ``start`` and ``count`` fields, applications
must first determine the current video standard selection. The
:ref:`v4l2_std_id <v4l2-std-id>` or the ``framelines`` field
of struct :c:type:`v4l2_standard` can be evaluated
for this purpose.
- .. row 8
- __u32
- ``flags``
- See :ref:`vbifmt-flags` below. Currently only drivers set flags,
applications must set this field to zero.
- .. row 9
- __u32
- ``reserved``\ [#f2]_
- This array is reserved for future extensions. Drivers and
applications must set it to zero.
.. tabularcolumns:: |p{4.0cm}|p{1.5cm}|p{12.0cm}| .. tabularcolumns:: |p{4.0cm}|p{1.5cm}|p{12.0cm}|
@ -235,40 +192,30 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_VBI_UNSYNC``
- .. row 1 - 0x0001
- This flag indicates hardware which does not properly distinguish
- ``V4L2_VBI_UNSYNC`` between fields. Normally the VBI image stores the first field
(lower scanning line numbers) first in memory. This may be a top
- 0x0001 or bottom field depending on the video standard. When this flag is
set the first or second field may be stored first, however the
- This flag indicates hardware which does not properly distinguish fields are still in correct temporal order with the older field
between fields. Normally the VBI image stores the first field first in memory. [#f3]_
(lower scanning line numbers) first in memory. This may be a top * - ``V4L2_VBI_INTERLACED``
or bottom field depending on the video standard. When this flag is - 0x0002
set the first or second field may be stored first, however the - By default the two field images will be passed sequentially; all
fields are still in correct temporal order with the older field lines of the first field followed by all lines of the second field
first in memory. [#f3]_ (compare :ref:`field-order` ``V4L2_FIELD_SEQ_TB`` and
``V4L2_FIELD_SEQ_BT``, whether the top or bottom field is first in
- .. row 2 memory depends on the video standard). When this flag is set, the
two fields are interlaced (cf. ``V4L2_FIELD_INTERLACED``). The
- ``V4L2_VBI_INTERLACED`` first line of the first field followed by the first line of the
second field, then the two second lines, and so on. Such a layout
- 0x0002 may be necessary when the hardware has been programmed to capture
or output interlaced video images and is unable to separate the
- By default the two field images will be passed sequentially; all fields for VBI capturing at the same time. For simplicity setting
lines of the first field followed by all lines of the second field this flag implies that both ``count`` values are equal and
(compare :ref:`field-order` ``V4L2_FIELD_SEQ_TB`` and non-zero.
``V4L2_FIELD_SEQ_BT``, whether the top or bottom field is first in
memory depends on the video standard). When this flag is set, the
two fields are interlaced (cf. ``V4L2_FIELD_INTERLACED``). The
first line of the first field followed by the first line of the
second field, then the two second lines, and so on. Such a layout
may be necessary when the hardware has been programmed to capture
or output interlaced video images and is unable to separate the
fields for VBI capturing at the same time. For simplicity setting
this flag implies that both ``count`` values are equal and
non-zero.

191
Documentation/media/uapi/v4l/dev-rds.rst
View File

@ -102,30 +102,15 @@ RDS datastructures
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 5 :widths: 1 1 5
* - __u8
- .. row 1 - ``lsb``
- Least Significant Byte of RDS Block
- __u8 * - __u8
- ``msb``
- ``lsb`` - Most Significant Byte of RDS Block
* - __u8
- Least Significant Byte of RDS Block - ``block``
- Block description
- .. row 2
- __u8
- ``msb``
- Most Significant Byte of RDS Block
- .. row 3
- __u8
- ``block``
- Block description
@ -138,33 +123,17 @@ RDS datastructures
:stub-columns: 0 :stub-columns: 0
:widths: 1 5 :widths: 1 5
* - Bits 0-2
- .. row 1 - Block (aka offset) of the received data.
* - Bits 3-5
- Bits 0-2 - Deprecated. Currently identical to bits 0-2. Do not use these
bits.
- Block (aka offset) of the received data. * - Bit 6
- Corrected bit. Indicates that an error was corrected for this data
- .. row 2 block.
* - Bit 7
- Bits 3-5 - Error bit. Indicates that an uncorrectable error occurred during
reception of this block.
- Deprecated. Currently identical to bits 0-2. Do not use these
bits.
- .. row 3
- Bit 6
- Corrected bit. Indicates that an error was corrected for this data
block.
- .. row 4
- Bit 7
- Error bit. Indicates that an uncorrectable error occurred during
reception of this block.
@ -177,87 +146,39 @@ RDS datastructures
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 5 :widths: 1 1 1 5
* - V4L2_RDS_BLOCK_MSK
- .. row 1 -
- 7
- V4L2_RDS_BLOCK_MSK - Mask for bits 0-2 to get the block ID.
* - V4L2_RDS_BLOCK_A
- -
- 7 - 0
- Block A.
- Mask for bits 0-2 to get the block ID. * - V4L2_RDS_BLOCK_B
-
- .. row 2 - 1
- Block B.
- V4L2_RDS_BLOCK_A * - V4L2_RDS_BLOCK_C
-
- - 2
- 0 - Block C.
* - V4L2_RDS_BLOCK_D
- Block A. -
- 3
- .. row 3 - Block D.
* - V4L2_RDS_BLOCK_C_ALT
- V4L2_RDS_BLOCK_B -
- 4
- - Block C'.
- 1 * - V4L2_RDS_BLOCK_INVALID
- read-only
- Block B. - 7
- An invalid block.
- .. row 4 * - V4L2_RDS_BLOCK_CORRECTED
- read-only
- V4L2_RDS_BLOCK_C - 0x40
- A bit error was detected but corrected.
- * - V4L2_RDS_BLOCK_ERROR
- 2 - read-only
- 0x80
- Block C. - An uncorrectable error occurred.
- .. row 5
- V4L2_RDS_BLOCK_D
-
- 3
- Block D.
- .. row 6
- V4L2_RDS_BLOCK_C_ALT
-
- 4
- Block C'.
- .. row 7
- V4L2_RDS_BLOCK_INVALID
- read-only
- 7
- An invalid block.
- .. row 8
- V4L2_RDS_BLOCK_CORRECTED
- read-only
- 0x40
- A bit error was detected but corrected.
- .. row 9
- V4L2_RDS_BLOCK_ERROR
- read-only
- 0x80
- An uncorrectable error occurred.

43
Documentation/media/uapi/v4l/dev-sdr.rst
View File

@ -87,35 +87,20 @@ data transfer, set by the driver in order to inform application.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``pixelformat``
- The data format or type of compression, set by the application.
- __u32 This is a little endian
:ref:`four character code <v4l2-fourcc>`. V4L2 defines SDR
- ``pixelformat`` formats in :ref:`sdr-formats`.
* - __u32
- The data format or type of compression, set by the application. - ``buffersize``
This is a little endian - Maximum size in bytes required for data. Value is set by the
:ref:`four character code <v4l2-fourcc>`. V4L2 defines SDR driver.
formats in :ref:`sdr-formats`. * - __u8
- ``reserved[24]``
- .. row 2 - This array is reserved for future extensions. Drivers and
applications must set it to zero.
- __u32
- ``buffersize``
- Maximum size in bytes required for data. Value is set by the
driver.
- .. row 3
- __u8
- ``reserved[24]``
- This array is reserved for future extensions. Drivers and
applications must set it to zero.
An SDR device may support :ref:`read/write <rw>` and/or streaming An SDR device may support :ref:`read/write <rw>` and/or streaming

704
Documentation/media/uapi/v4l/dev-sliced-vbi.rst
View File

@ -114,138 +114,90 @@ struct v4l2_sliced_vbi_format
:stub-columns: 0 :stub-columns: 0
:widths: 3 3 2 2 2 :widths: 3 3 2 2 2
* - __u32
- ``service_set``
- :cspan:`2`
- .. row 1 If ``service_set`` is non-zero when passed with
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`, the ``service_lines``
array will be filled by the driver according to the services
specified in this field. For example, if ``service_set`` is
initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``,
a driver for the cx25840 video decoder sets lines 7-22 of both
fields [#f1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first
field to ``V4L2_SLICED_WSS_625``. If ``service_set`` is set to
zero, then the values of ``service_lines`` will be used instead.
- __u32 On return the driver sets this field to the union of all elements
of the returned ``service_lines`` array. It may contain less
services than requested, perhaps just one, if the hardware cannot
handle more services simultaneously. It may be empty (zero) if
none of the requested services are supported by the hardware.
* - __u16
- ``service_lines``\ [2][24]
- :cspan:`2`
- ``service_set`` Applications initialize this array with sets of data services the
driver shall look for or insert on the respective scan line.
Subject to hardware capabilities drivers return the requested set,
a subset, which may be just a single service, or an empty set.
When the hardware cannot handle multiple services on the same line
the driver shall choose one. No assumptions can be made on which
service the driver chooses.
- :cspan:`2` Data services are defined in :ref:`vbi-services2`. Array indices
map to ITU-R line numbers\ [#f2]_ as follows:
* -
-
- Element
- 525 line systems
- 625 line systems
* -
-
- ``service_lines``\ [0][1]
- 1
- 1
* -
-
- ``service_lines``\ [0][23]
- 23
- 23
* -
-
- ``service_lines``\ [1][1]
- 264
- 314
* -
-
- ``service_lines``\ [1][23]
- 286
- 336
* -
-
- :cspan:`2` Drivers must set ``service_lines`` [0][0] and
``service_lines``\ [1][0] to zero. The
``V4L2_VBI_ITU_525_F1_START``, ``V4L2_VBI_ITU_525_F2_START``,
``V4L2_VBI_ITU_625_F1_START`` and ``V4L2_VBI_ITU_625_F2_START``
defines give the start line numbers for each field for each 525 or
625 line format as a convenience. Don't forget that ITU line
numbering starts at 1, not 0.
* - __u32
- ``io_size``
- :cspan:`2` Maximum number of bytes passed by one
:ref:`read() <func-read>` or :ref:`write() <func-write>` call,
and the buffer size in bytes for the
:ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. Drivers set this field
to the size of struct
:c:type:`v4l2_sliced_vbi_data` times the
number of non-zero elements in the returned ``service_lines``
array (that is the number of lines potentially carrying data).
* - __u32
- ``reserved``\ [2]
- :cspan:`2` This array is reserved for future extensions.
If ``service_set`` is non-zero when passed with Applications and drivers must set it to zero.
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`, the ``service_lines``
array will be filled by the driver according to the services
specified in this field. For example, if ``service_set`` is
initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``,
a driver for the cx25840 video decoder sets lines 7-22 of both
fields [#f1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first
field to ``V4L2_SLICED_WSS_625``. If ``service_set`` is set to
zero, then the values of ``service_lines`` will be used instead.
On return the driver sets this field to the union of all elements
of the returned ``service_lines`` array. It may contain less
services than requested, perhaps just one, if the hardware cannot
handle more services simultaneously. It may be empty (zero) if
none of the requested services are supported by the hardware.
- .. row 2
- __u16
- ``service_lines``\ [2][24]
- :cspan:`2`
Applications initialize this array with sets of data services the
driver shall look for or insert on the respective scan line.
Subject to hardware capabilities drivers return the requested set,
a subset, which may be just a single service, or an empty set.
When the hardware cannot handle multiple services on the same line
the driver shall choose one. No assumptions can be made on which
service the driver chooses.
Data services are defined in :ref:`vbi-services2`. Array indices
map to ITU-R line numbers\ [#f2]_ as follows:
- .. row 3
-
-
- Element
- 525 line systems
- 625 line systems
- .. row 4
-
-
- ``service_lines``\ [0][1]
- 1
- 1
- .. row 5
-
-
- ``service_lines``\ [0][23]
- 23
- 23
- .. row 6
-
-
- ``service_lines``\ [1][1]
- 264
- 314
- .. row 7
-
-
- ``service_lines``\ [1][23]
- 286
- 336
- .. row 8
-
-
- :cspan:`2` Drivers must set ``service_lines`` [0][0] and
``service_lines``\ [1][0] to zero. The
``V4L2_VBI_ITU_525_F1_START``, ``V4L2_VBI_ITU_525_F2_START``,
``V4L2_VBI_ITU_625_F1_START`` and ``V4L2_VBI_ITU_625_F2_START``
defines give the start line numbers for each field for each 525 or
625 line format as a convenience. Don't forget that ITU line
numbering starts at 1, not 0.
- .. row 9
- __u32
- ``io_size``
- :cspan:`2` Maximum number of bytes passed by one
:ref:`read() <func-read>` or :ref:`write() <func-write>` call,
and the buffer size in bytes for the
:ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. Drivers set this field
to the size of struct
:c:type:`v4l2_sliced_vbi_data` times the
number of non-zero elements in the returned ``service_lines``
array (that is the number of lines potentially carrying data).
- .. row 10
- __u32
- ``reserved``\ [2]
- :cspan:`2` This array is reserved for future extensions.
Applications and drivers must set it to zero.
.. _vbi-services2: .. _vbi-services2:
@ -264,95 +216,50 @@ Sliced VBI services
:stub-columns: 0 :stub-columns: 0
:widths: 2 1 1 2 2 :widths: 2 1 1 2 2
* - Symbol
- Value
- Reference
- Lines, usually
- Payload
* - ``V4L2_SLICED_TELETEXT_B`` (Teletext System B)
- 0x0001
- :ref:`ets300706`,
- .. row 1 :ref:`itu653`
- PAL/SECAM line 7-22, 320-335 (second field 7-22)
- Last 42 of the 45 byte Teletext packet, that is without clock
run-in and framing code, lsb first transmitted.
* - ``V4L2_SLICED_VPS``
- 0x0400
- :ref:`ets300231`
- PAL line 16
- Byte number 3 to 15 according to Figure 9 of ETS 300 231, lsb
first transmitted.
* - ``V4L2_SLICED_CAPTION_525``
- 0x1000
- :ref:`cea608`
- NTSC line 21, 284 (second field 21)
- Two bytes in transmission order, including parity bit, lsb first
transmitted.
* - ``V4L2_SLICED_WSS_625``
- 0x4000
- :ref:`itu1119`,
- Symbol :ref:`en300294`
- PAL/SECAM line 23
-
- Value ::
- Reference Byte 0 1
msb lsb msb lsb
- Lines, usually Bit 7 6 5 4 3 2 1 0 x x 13 12 11 10 9
* - ``V4L2_SLICED_VBI_525``
- Payload - 0x1000
- :cspan:`2` Set of services applicable to 525 line systems.
- .. row 2 * - ``V4L2_SLICED_VBI_625``
- 0x4401
- ``V4L2_SLICED_TELETEXT_B`` (Teletext System B) - :cspan:`2` Set of services applicable to 625 line systems.
- 0x0001
- :ref:`ets300706`,
:ref:`itu653`
- PAL/SECAM line 7-22, 320-335 (second field 7-22)
- Last 42 of the 45 byte Teletext packet, that is without clock
run-in and framing code, lsb first transmitted.
- .. row 3
- ``V4L2_SLICED_VPS``
- 0x0400
- :ref:`ets300231`
- PAL line 16
- Byte number 3 to 15 according to Figure 9 of ETS 300 231, lsb
first transmitted.
- .. row 4
- ``V4L2_SLICED_CAPTION_525``
- 0x1000
- :ref:`cea608`
- NTSC line 21, 284 (second field 21)
- Two bytes in transmission order, including parity bit, lsb first
transmitted.
- .. row 5
- ``V4L2_SLICED_WSS_625``
- 0x4000
- :ref:`itu1119`,
:ref:`en300294`
- PAL/SECAM line 23
-
::
Byte 0 1
msb lsb msb lsb
Bit 7 6 5 4 3 2 1 0 x x 13 12 11 10 9
- .. row 6
- ``V4L2_SLICED_VBI_525``
- 0x1000
- :cspan:`2` Set of services applicable to 525 line systems.
- .. row 7
- ``V4L2_SLICED_VBI_625``
- 0x4401
- :cspan:`2` Set of services applicable to 625 line systems.
.. raw:: latex .. raw:: latex
@ -395,63 +302,38 @@ struct v4l2_sliced_vbi_data
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - __u32
- .. row 1 - ``id``
- A flag from :ref:`vbi-services` identifying the type of data in
- __u32 this packet. Only a single bit must be set. When the ``id`` of a
captured packet is zero, the packet is empty and the contents of
- ``id`` other fields are undefined. Applications shall ignore empty
packets. When the ``id`` of a packet for output is zero the
- A flag from :ref:`vbi-services` identifying the type of data in contents of the ``data`` field are undefined and the driver must
this packet. Only a single bit must be set. When the ``id`` of a no longer insert data on the requested ``field`` and ``line``.
captured packet is zero, the packet is empty and the contents of * - __u32
other fields are undefined. Applications shall ignore empty - ``field``
packets. When the ``id`` of a packet for output is zero the - The video field number this data has been captured from, or shall
contents of the ``data`` field are undefined and the driver must be inserted at. ``0`` for the first field, ``1`` for the second
no longer insert data on the requested ``field`` and ``line``. field.
* - __u32
- .. row 2 - ``line``
- The field (as opposed to frame) line number this data has been
- __u32 captured from, or shall be inserted at. See :ref:`vbi-525` and
:ref:`vbi-625` for valid values. Sliced VBI capture devices can
- ``field`` set the line number of all packets to ``0`` if the hardware cannot
reliably identify scan lines. The field number must always be
- The video field number this data has been captured from, or shall valid.
be inserted at. ``0`` for the first field, ``1`` for the second * - __u32
field. - ``reserved``
- This field is reserved for future extensions. Applications and
- .. row 3 drivers must set it to zero.
* - __u8
- __u32 - ``data``\ [48]
- The packet payload. See :ref:`vbi-services` for the contents and
- ``line`` number of bytes passed for each data type. The contents of padding
bytes at the end of this array are undefined, drivers and
- The field (as opposed to frame) line number this data has been applications shall ignore them.
captured from, or shall be inserted at. See :ref:`vbi-525` and
:ref:`vbi-625` for valid values. Sliced VBI capture devices can
set the line number of all packets to ``0`` if the hardware cannot
reliably identify scan lines. The field number must always be
valid.
- .. row 4
- __u32
- ``reserved``
- This field is reserved for future extensions. Applications and
drivers must set it to zero.
- .. row 5
- __u8
- ``data``\ [48]
- The packet payload. See :ref:`vbi-services` for the contents and
number of bytes passed for each data type. The contents of padding
bytes at the end of this array are undefined, drivers and
applications shall ignore them.
Packets are always passed in ascending line number order, without Packets are always passed in ascending line number order, without
@ -582,48 +464,29 @@ struct v4l2_mpeg_vbi_fmt_ivtv
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 2 :widths: 1 1 1 2
* - __u8
- .. row 1 - ``magic``\ [4]
-
- __u8 - A "magic" constant from :ref:`v4l2-mpeg-vbi-fmt-ivtv-magic` that
indicates this is a valid sliced VBI data payload and also
- ``magic``\ [4] indicates which member of the anonymous union, ``itv0`` or
``ITV0``, to use for the payload data.
- * - union
- A "magic" constant from :ref:`v4l2-mpeg-vbi-fmt-ivtv-magic` that - (anonymous)
indicates this is a valid sliced VBI data payload and also * -
indicates which member of the anonymous union, ``itv0`` or - struct :c:type:`v4l2_mpeg_vbi_itv0`
``ITV0``, to use for the payload data. - ``itv0``
- The primary form of the sliced VBI data payload that contains
- .. row 2 anywhere from 1 to 35 lines of sliced VBI data. Line masks are
provided in this form of the payload indicating which VBI lines
- union are provided.
* -
- (anonymous) - struct :ref:`v4l2_mpeg_vbi_ITV0 <v4l2-mpeg-vbi-itv0-1>`
- ``ITV0``
- .. row 3 - An alternate form of the sliced VBI data payload used when 36
lines of sliced VBI data are present. No line masks are provided
- in this form of the payload; all valid line mask bits are
- struct :c:type:`v4l2_mpeg_vbi_itv0` implcitly set.
- ``itv0``
- The primary form of the sliced VBI data payload that contains
anywhere from 1 to 35 lines of sliced VBI data. Line masks are
provided in this form of the payload indicating which VBI lines
are provided.
- .. row 4
-
- struct :ref:`v4l2_mpeg_vbi_ITV0 <v4l2-mpeg-vbi-itv0-1>`
- ``ITV0``
- An alternate form of the sliced VBI data payload used when 36
lines of sliced VBI data are present. No line masks are provided
in this form of the payload; all valid line mask bits are
implcitly set.
@ -639,34 +502,19 @@ Magic Constants for struct v4l2_mpeg_vbi_fmt_ivtv magic field
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - Defined Symbol
- .. row 1 - Value
- Description
- Defined Symbol * - ``V4L2_MPEG_VBI_IVTV_MAGIC0``
- "itv0"
- Value - Indicates the ``itv0`` member of the union in struct
:c:type:`v4l2_mpeg_vbi_fmt_ivtv` is
- Description valid.
* - ``V4L2_MPEG_VBI_IVTV_MAGIC1``
- .. row 2 - "ITV0"
- Indicates the ``ITV0`` member of the union in struct
- ``V4L2_MPEG_VBI_IVTV_MAGIC0`` :c:type:`v4l2_mpeg_vbi_fmt_ivtv` is
valid and that 36 lines of sliced VBI data are present.
- "itv0"
- Indicates the ``itv0`` member of the union in struct
:c:type:`v4l2_mpeg_vbi_fmt_ivtv` is
valid.
- .. row 3
- ``V4L2_MPEG_VBI_IVTV_MAGIC1``
- "ITV0"
- Indicates the ``ITV0`` member of the union in struct
:c:type:`v4l2_mpeg_vbi_fmt_ivtv` is
valid and that 36 lines of sliced VBI data are present.
@ -684,50 +532,40 @@ structs v4l2_mpeg_vbi_itv0 and v4l2_mpeg_vbi_ITV0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __le32
- .. row 1 - ``linemask``\ [2]
- Bitmasks indicating the VBI service lines present. These
- __le32 ``linemask`` values are stored in little endian byte order in the
MPEG stream. Some reference ``linemask`` bit positions with their
- ``linemask``\ [2] corresponding VBI line number and video field are given below.
b\ :sub:`0` indicates the least significant bit of a ``linemask``
- Bitmasks indicating the VBI service lines present. These value:
``linemask`` values are stored in little endian byte order in the
MPEG stream. Some reference ``linemask`` bit positions with their
corresponding VBI line number and video field are given below.
b\ :sub:`0` indicates the least significant bit of a ``linemask``
value:
:: ::
linemask[0] b0: line 6 first field linemask[0] b0: line 6 first field
linemask[0] b17: line 23 first field linemask[0] b17: line 23 first field
linemask[0] b18: line 6 second field linemask[0] b18: line 6 second field
linemask[0] b31: line 19 second field linemask[0] b31: line 19 second field
linemask[1] b0: line 20 second field linemask[1] b0: line 20 second field
linemask[1] b3: line 23 second field linemask[1] b3: line 23 second field
linemask[1] b4-b31: unused and set to 0 linemask[1] b4-b31: unused and set to 0
* - struct
- .. row 2 :c:type:`v4l2_mpeg_vbi_itv0_line`
- ``line``\ [35]
- struct - This is a variable length array that holds from 1 to 35 lines of
:c:type:`v4l2_mpeg_vbi_itv0_line` sliced VBI data. The sliced VBI data lines present correspond to
the bits set in the ``linemask`` array, starting from b\ :sub:`0`
- ``line``\ [35] of ``linemask``\ [0] up through b\ :sub:`31` of ``linemask``\ [0],
and from b\ :sub:`0` of ``linemask``\ [1] up through b\ :sub:`3` of
- This is a variable length array that holds from 1 to 35 lines of ``linemask``\ [1]. ``line``\ [0] corresponds to the first bit
sliced VBI data. The sliced VBI data lines present correspond to found set in the ``linemask`` array, ``line``\ [1] corresponds to
the bits set in the ``linemask`` array, starting from b\ :sub:`0` the second bit found set in the ``linemask`` array, etc. If no
of ``linemask``\ [0] up through b\ :sub:`31` of ``linemask``\ [0], ``linemask`` array bits are set, then ``line``\ [0] may contain
and from b\ :sub:`0` of ``linemask``\ [1] up through b\ :sub:`3` of one line of unspecified data that should be ignored by
``linemask``\ [1]. ``line``\ [0] corresponds to the first bit applications.
found set in the ``linemask`` array, ``line``\ [1] corresponds to
the second bit found set in the ``linemask`` array, etc. If no
``linemask`` array bits are set, then ``line``\ [0] may contain
one line of unspecified data that should be ignored by
applications.
@ -743,18 +581,13 @@ struct v4l2_mpeg_vbi_ITV0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - struct
- .. row 1 :c:type:`v4l2_mpeg_vbi_itv0_line`
- ``line``\ [36]
- struct - A fixed length array of 36 lines of sliced VBI data. ``line``\ [0]
:c:type:`v4l2_mpeg_vbi_itv0_line` through ``line``\ [17] correspond to lines 6 through 23 of the
first field. ``line``\ [18] through ``line``\ [35] corresponds to
- ``line``\ [36] lines 6 through 23 of the second field.
- A fixed length array of 36 lines of sliced VBI data. ``line``\ [0]
through ``line``\ [17] correspond to lines 6 through 23 of the
first field. ``line``\ [18] through ``line``\ [35] corresponds to
lines 6 through 23 of the second field.
@ -770,24 +603,14 @@ struct v4l2_mpeg_vbi_itv0_line
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u8
- .. row 1 - ``id``
- A line identifier value from
- __u8 :ref:`ITV0-Line-Identifier-Constants` that indicates the type of
sliced VBI data stored on this line.
- ``id`` * - __u8
- ``data``\ [42]
- A line identifier value from - The sliced VBI data for the line.
:ref:`ITV0-Line-Identifier-Constants` that indicates the type of
sliced VBI data stored on this line.
- .. row 2
- __u8
- ``data``\ [42]
- The sliced VBI data for the line.
@ -803,50 +626,25 @@ Line Identifiers for struct v4l2_mpeg_vbi_itv0_line id field
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - Defined Symbol
- .. row 1 - Value
- Description
- Defined Symbol * - ``V4L2_MPEG_VBI_IVTV_TELETEXT_B``
- 1
- Value - Refer to :ref:`Sliced VBI services <vbi-services2>` for a
description of the line payload.
- Description * - ``V4L2_MPEG_VBI_IVTV_CAPTION_525``
- 4
- .. row 2 - Refer to :ref:`Sliced VBI services <vbi-services2>` for a
description of the line payload.
- ``V4L2_MPEG_VBI_IVTV_TELETEXT_B`` * - ``V4L2_MPEG_VBI_IVTV_WSS_625``
- 5
- 1 - Refer to :ref:`Sliced VBI services <vbi-services2>` for a
description of the line payload.
- Refer to :ref:`Sliced VBI services <vbi-services2>` for a * - ``V4L2_MPEG_VBI_IVTV_VPS``
description of the line payload. - 7
- Refer to :ref:`Sliced VBI services <vbi-services2>` for a
- .. row 3 description of the line payload.
- ``V4L2_MPEG_VBI_IVTV_CAPTION_525``
- 4
- Refer to :ref:`Sliced VBI services <vbi-services2>` for a
description of the line payload.
- .. row 4
- ``V4L2_MPEG_VBI_IVTV_WSS_625``
- 5
- Refer to :ref:`Sliced VBI services <vbi-services2>` for a
description of the line payload.
- .. row 5
- ``V4L2_MPEG_VBI_IVTV_VPS``
- 7
- Refer to :ref:`Sliced VBI services <vbi-services2>` for a
description of the line payload.

114
Documentation/media/uapi/v4l/dev-subdev.rst
View File

@ -215,85 +215,41 @@ list entity names and pad numbers).
:stub-columns: 0 :stub-columns: 0
:widths: 5 5 5 5 5 5 5 :widths: 5 5 5 5 5 5 5
* -
- .. row 1 - Sensor/0 format
- Frontend/0 format
- - Frontend/1 format
- Sensor/0 format - Scaler/0 format
- Scaler/0 compose selection rectangle
- Frontend/0 format - Scaler/1 format
* - Initial state
- Frontend/1 format - 2048x1536/SGRBG8_1X8
- (default)
- Scaler/0 format - (default)
- (default)
- Scaler/0 compose selection rectangle - (default)
- (default)
- Scaler/1 format * - Configure frontend sink format
- 2048x1536/SGRBG8_1X8
- .. row 2 - *2048x1536/SGRBG8_1X8*
- *2046x1534/SGRBG8_1X8*
- Initial state - (default)
- (default)
- 2048x1536/SGRBG8_1X8 - (default)
* - Configure scaler sink format
- (default) - 2048x1536/SGRBG8_1X8
- 2048x1536/SGRBG8_1X8
- (default) - 2046x1534/SGRBG8_1X8
- *2046x1534/SGRBG8_1X8*
- (default) - *0,0/2046x1534*
- *2046x1534/SGRBG8_1X8*
- (default) * - Configure scaler sink compose selection
- 2048x1536/SGRBG8_1X8
- (default) - 2048x1536/SGRBG8_1X8
- 2046x1534/SGRBG8_1X8
- .. row 3 - 2046x1534/SGRBG8_1X8
- *0,0/1280x960*
- Configure frontend sink format - *1280x960/SGRBG8_1X8*
- 2048x1536/SGRBG8_1X8
- *2048x1536/SGRBG8_1X8*
- *2046x1534/SGRBG8_1X8*
- (default)
- (default)
- (default)
- .. row 4
- Configure scaler sink format
- 2048x1536/SGRBG8_1X8
- 2048x1536/SGRBG8_1X8
- 2046x1534/SGRBG8_1X8
- *2046x1534/SGRBG8_1X8*
- *0,0/2046x1534*
- *2046x1534/SGRBG8_1X8*
- .. row 5
- Configure scaler sink compose selection
- 2048x1536/SGRBG8_1X8
- 2048x1536/SGRBG8_1X8
- 2046x1534/SGRBG8_1X8
- 2046x1534/SGRBG8_1X8
- *0,0/1280x960*
- *1280x960/SGRBG8_1X8*
.. raw:: latex .. raw:: latex

674
Documentation/media/uapi/v4l/diff-v4l.rst
View File

@ -39,39 +39,19 @@ using driver module options. The major device number remains 81.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Device Type
- .. row 1 - File Name
- Minor Numbers
- Device Type * - Video capture and overlay
- ``/dev/video`` and ``/dev/bttv0``\ [#f1]_, ``/dev/video0`` to
- File Name ``/dev/video63``
- 0-63
- Minor Numbers * - Radio receiver
- ``/dev/radio``\ [#f2]_, ``/dev/radio0`` to ``/dev/radio63``
- .. row 2 - 64-127
* - Raw VBI capture
- Video capture and overlay - ``/dev/vbi``, ``/dev/vbi0`` to ``/dev/vbi31``
- 224-255
- ``/dev/video`` and ``/dev/bttv0``\ [#f1]_, ``/dev/video0`` to
``/dev/video63``
- 0-63
- .. row 3
- Radio receiver
- ``/dev/radio``\ [#f2]_, ``/dev/radio0`` to ``/dev/radio63``
- 64-127
- .. row 4
- Raw VBI capture
- ``/dev/vbi``, ``/dev/vbi0`` to ``/dev/vbi31``
- 224-255
V4L prohibits (or used to prohibit) multiple opens of a device file. V4L prohibits (or used to prohibit) multiple opens of a device file.
@ -103,148 +83,73 @@ introduction.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - ``struct video_capability`` ``type``
- .. row 1 - struct :c:type:`v4l2_capability`
``capabilities`` flags
- ``struct video_capability`` ``type`` - Purpose
* - ``VID_TYPE_CAPTURE``
- struct :c:type:`v4l2_capability` - ``V4L2_CAP_VIDEO_CAPTURE``
``capabilities`` flags - The :ref:`video capture <capture>` interface is supported.
* - ``VID_TYPE_TUNER``
- Purpose - ``V4L2_CAP_TUNER``
- The device has a :ref:`tuner or modulator <tuner>`.
- .. row 2 * - ``VID_TYPE_TELETEXT``
- ``V4L2_CAP_VBI_CAPTURE``
- ``VID_TYPE_CAPTURE`` - The :ref:`raw VBI capture <raw-vbi>` interface is supported.
* - ``VID_TYPE_OVERLAY``
- ``V4L2_CAP_VIDEO_CAPTURE`` - ``V4L2_CAP_VIDEO_OVERLAY``
- The :ref:`video overlay <overlay>` interface is supported.
- The :ref:`video capture <capture>` interface is supported. * - ``VID_TYPE_CHROMAKEY``
- ``V4L2_FBUF_CAP_CHROMAKEY`` in field ``capability`` of struct
- .. row 3 :c:type:`v4l2_framebuffer`
- Whether chromakey overlay is supported. For more information on
- ``VID_TYPE_TUNER`` overlay see :ref:`overlay`.
* - ``VID_TYPE_CLIPPING``
- ``V4L2_CAP_TUNER`` - ``V4L2_FBUF_CAP_LIST_CLIPPING`` and
``V4L2_FBUF_CAP_BITMAP_CLIPPING`` in field ``capability`` of
- The device has a :ref:`tuner or modulator <tuner>`. struct :c:type:`v4l2_framebuffer`
- Whether clipping the overlaid image is supported, see
- .. row 4 :ref:`overlay`.
* - ``VID_TYPE_FRAMERAM``
- ``VID_TYPE_TELETEXT`` - ``V4L2_FBUF_CAP_EXTERNOVERLAY`` *not set* in field ``capability``
of struct :c:type:`v4l2_framebuffer`
- ``V4L2_CAP_VBI_CAPTURE`` - Whether overlay overwrites frame buffer memory, see
:ref:`overlay`.
- The :ref:`raw VBI capture <raw-vbi>` interface is supported. * - ``VID_TYPE_SCALES``
- ``-``
- .. row 5 - This flag indicates if the hardware can scale images. The V4L2 API
implies the scale factor by setting the cropping dimensions and
- ``VID_TYPE_OVERLAY`` image size with the :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, respectively. The
- ``V4L2_CAP_VIDEO_OVERLAY`` driver returns the closest sizes possible. For more information on
cropping and scaling see :ref:`crop`.
- The :ref:`video overlay <overlay>` interface is supported. * - ``VID_TYPE_MONOCHROME``
- ``-``
- .. row 6 - Applications can enumerate the supported image formats with the
:ref:`VIDIOC_ENUM_FMT` ioctl to determine if
- ``VID_TYPE_CHROMAKEY`` the device supports grey scale capturing only. For more
information on image formats see :ref:`pixfmt`.
- ``V4L2_FBUF_CAP_CHROMAKEY`` in field ``capability`` of struct * - ``VID_TYPE_SUBCAPTURE``
:c:type:`v4l2_framebuffer` - ``-``
- Applications can call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>`
- Whether chromakey overlay is supported. For more information on ioctl to determine if the device supports capturing a subsection
overlay see :ref:`overlay`. of the full picture ("cropping" in V4L2). If not, the ioctl
returns the ``EINVAL`` error code. For more information on cropping
- .. row 7 and scaling see :ref:`crop`.
* - ``VID_TYPE_MPEG_DECODER``
- ``VID_TYPE_CLIPPING`` - ``-``
- Applications can enumerate the supported image formats with the
- ``V4L2_FBUF_CAP_LIST_CLIPPING`` and :ref:`VIDIOC_ENUM_FMT` ioctl to determine if
``V4L2_FBUF_CAP_BITMAP_CLIPPING`` in field ``capability`` of the device supports MPEG streams.
struct :c:type:`v4l2_framebuffer` * - ``VID_TYPE_MPEG_ENCODER``
- ``-``
- Whether clipping the overlaid image is supported, see - See above.
:ref:`overlay`. * - ``VID_TYPE_MJPEG_DECODER``
- ``-``
- .. row 8 - See above.
* - ``VID_TYPE_MJPEG_ENCODER``
- ``VID_TYPE_FRAMERAM`` - ``-``
- See above.
- ``V4L2_FBUF_CAP_EXTERNOVERLAY`` *not set* in field ``capability``
of struct :c:type:`v4l2_framebuffer`
- Whether overlay overwrites frame buffer memory, see
:ref:`overlay`.
- .. row 9
- ``VID_TYPE_SCALES``
- ``-``
- This flag indicates if the hardware can scale images. The V4L2 API
implies the scale factor by setting the cropping dimensions and
image size with the :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, respectively. The
driver returns the closest sizes possible. For more information on
cropping and scaling see :ref:`crop`.
- .. row 10
- ``VID_TYPE_MONOCHROME``
- ``-``
- Applications can enumerate the supported image formats with the
:ref:`VIDIOC_ENUM_FMT` ioctl to determine if
the device supports grey scale capturing only. For more
information on image formats see :ref:`pixfmt`.
- .. row 11
- ``VID_TYPE_SUBCAPTURE``
- ``-``
- Applications can call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>`
ioctl to determine if the device supports capturing a subsection
of the full picture ("cropping" in V4L2). If not, the ioctl
returns the ``EINVAL`` error code. For more information on cropping
and scaling see :ref:`crop`.
- .. row 12
- ``VID_TYPE_MPEG_DECODER``
- ``-``
- Applications can enumerate the supported image formats with the
:ref:`VIDIOC_ENUM_FMT` ioctl to determine if
the device supports MPEG streams.
- .. row 13
- ``VID_TYPE_MPEG_ENCODER``
- ``-``
- See above.
- .. row 14
- ``VID_TYPE_MJPEG_DECODER``
- ``-``
- See above.
- .. row 15
- ``VID_TYPE_MJPEG_ENCODER``
- ``-``
- See above.
The ``audios`` field was replaced by ``capabilities`` flag The ``audios`` field was replaced by ``capabilities`` flag
@ -280,24 +185,12 @@ video input types were renamed as follows:
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - struct ``video_channel`` ``type``
- .. row 1 - struct :c:type:`v4l2_input` ``type``
* - ``VIDEO_TYPE_TV``
- struct ``video_channel`` ``type`` - ``V4L2_INPUT_TYPE_TUNER``
* - ``VIDEO_TYPE_CAMERA``
- struct :c:type:`v4l2_input` ``type`` - ``V4L2_INPUT_TYPE_CAMERA``
- .. row 2
- ``VIDEO_TYPE_TV``
- ``V4L2_INPUT_TYPE_TUNER``
- .. row 3
- ``VIDEO_TYPE_CAMERA``
- ``V4L2_INPUT_TYPE_CAMERA``
Unlike the ``tuners`` field expressing the number of tuners of this Unlike the ``tuners`` field expressing the number of tuners of this
@ -386,42 +279,18 @@ replaced by V4L2 controls accessible with the
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - struct ``video_picture``
- .. row 1 - V4L2 Control ID
* - ``brightness``
- struct ``video_picture`` - ``V4L2_CID_BRIGHTNESS``
* - ``hue``
- V4L2 Control ID - ``V4L2_CID_HUE``
* - ``colour``
- .. row 2 - ``V4L2_CID_SATURATION``
* - ``contrast``
- ``brightness`` - ``V4L2_CID_CONTRAST``
* - ``whiteness``
- ``V4L2_CID_BRIGHTNESS`` - ``V4L2_CID_WHITENESS``
- .. row 3
- ``hue``
- ``V4L2_CID_HUE``
- .. row 4
- ``colour``
- ``V4L2_CID_SATURATION``
- .. row 5
- ``contrast``
- ``V4L2_CID_CONTRAST``
- .. row 6
- ``whiteness``
- ``V4L2_CID_WHITENESS``
The V4L picture controls are assumed to range from 0 to 65535 with no The V4L picture controls are assumed to range from 0 to 65535 with no
@ -442,108 +311,40 @@ into the struct :c:type:`v4l2_pix_format`:
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - struct ``video_picture`` ``palette``
- .. row 1 - struct :c:type:`v4l2_pix_format` ``pixfmt``
* - ``VIDEO_PALETTE_GREY``
- struct ``video_picture`` ``palette`` - :ref:`V4L2_PIX_FMT_GREY <V4L2-PIX-FMT-GREY>`
* - ``VIDEO_PALETTE_HI240``
- struct :c:type:`v4l2_pix_format` ``pixfmt`` - :ref:`V4L2_PIX_FMT_HI240 <pixfmt-reserved>` [#f3]_
* - ``VIDEO_PALETTE_RGB565``
- .. row 2 - :ref:`V4L2_PIX_FMT_RGB565 <pixfmt-rgb>`
* - ``VIDEO_PALETTE_RGB555``
- ``VIDEO_PALETTE_GREY`` - :ref:`V4L2_PIX_FMT_RGB555 <pixfmt-rgb>`
* - ``VIDEO_PALETTE_RGB24``
- :ref:`V4L2_PIX_FMT_GREY <V4L2-PIX-FMT-GREY>` - :ref:`V4L2_PIX_FMT_BGR24 <pixfmt-rgb>`
* - ``VIDEO_PALETTE_RGB32``
- .. row 3 - :ref:`V4L2_PIX_FMT_BGR32 <pixfmt-rgb>` [#f4]_
* - ``VIDEO_PALETTE_YUV422``
- ``VIDEO_PALETTE_HI240`` - :ref:`V4L2_PIX_FMT_YUYV <V4L2-PIX-FMT-YUYV>`
* - ``VIDEO_PALETTE_YUYV``\ [#f5]_
- :ref:`V4L2_PIX_FMT_HI240 <pixfmt-reserved>` [#f3]_ - :ref:`V4L2_PIX_FMT_YUYV <V4L2-PIX-FMT-YUYV>`
* - ``VIDEO_PALETTE_UYVY``
- .. row 4 - :ref:`V4L2_PIX_FMT_UYVY <V4L2-PIX-FMT-UYVY>`
* - ``VIDEO_PALETTE_YUV420``
- ``VIDEO_PALETTE_RGB565`` - None
* - ``VIDEO_PALETTE_YUV411``
- :ref:`V4L2_PIX_FMT_RGB565 <pixfmt-rgb>` - :ref:`V4L2_PIX_FMT_Y41P <V4L2-PIX-FMT-Y41P>` [#f6]_
* - ``VIDEO_PALETTE_RAW``
- .. row 5 - None [#f7]_
* - ``VIDEO_PALETTE_YUV422P``
- ``VIDEO_PALETTE_RGB555`` - :ref:`V4L2_PIX_FMT_YUV422P <V4L2-PIX-FMT-YUV422P>`
* - ``VIDEO_PALETTE_YUV411P``
- :ref:`V4L2_PIX_FMT_RGB555 <pixfmt-rgb>` - :ref:`V4L2_PIX_FMT_YUV411P <V4L2-PIX-FMT-YUV411P>` [#f8]_
* - ``VIDEO_PALETTE_YUV420P``
- .. row 6 - :ref:`V4L2_PIX_FMT_YVU420 <V4L2-PIX-FMT-YVU420>`
* - ``VIDEO_PALETTE_YUV410P``
- ``VIDEO_PALETTE_RGB24`` - :ref:`V4L2_PIX_FMT_YVU410 <V4L2-PIX-FMT-YVU410>`
- :ref:`V4L2_PIX_FMT_BGR24 <pixfmt-rgb>`
- .. row 7
- ``VIDEO_PALETTE_RGB32``
- :ref:`V4L2_PIX_FMT_BGR32 <pixfmt-rgb>` [#f4]_
- .. row 8
- ``VIDEO_PALETTE_YUV422``
- :ref:`V4L2_PIX_FMT_YUYV <V4L2-PIX-FMT-YUYV>`
- .. row 9
- ``VIDEO_PALETTE_YUYV``\ [#f5]_
- :ref:`V4L2_PIX_FMT_YUYV <V4L2-PIX-FMT-YUYV>`
- .. row 10
- ``VIDEO_PALETTE_UYVY``
- :ref:`V4L2_PIX_FMT_UYVY <V4L2-PIX-FMT-UYVY>`
- .. row 11
- ``VIDEO_PALETTE_YUV420``
- None
- .. row 12
- ``VIDEO_PALETTE_YUV411``
- :ref:`V4L2_PIX_FMT_Y41P <V4L2-PIX-FMT-Y41P>` [#f6]_
- .. row 13
- ``VIDEO_PALETTE_RAW``
- None [#f7]_
- .. row 14
- ``VIDEO_PALETTE_YUV422P``
- :ref:`V4L2_PIX_FMT_YUV422P <V4L2-PIX-FMT-YUV422P>`
- .. row 15
- ``VIDEO_PALETTE_YUV411P``
- :ref:`V4L2_PIX_FMT_YUV411P <V4L2-PIX-FMT-YUV411P>` [#f8]_
- .. row 16
- ``VIDEO_PALETTE_YUV420P``
- :ref:`V4L2_PIX_FMT_YVU420 <V4L2-PIX-FMT-YVU420>`
- .. row 17
- ``VIDEO_PALETTE_YUV410P``
- :ref:`V4L2_PIX_FMT_YVU410 <V4L2-PIX-FMT-YVU410>`
V4L2 image formats are defined in :ref:`pixfmt`. The image format can V4L2 image formats are defined in :ref:`pixfmt`. The image format can
@ -588,36 +389,16 @@ The following fields where replaced by V4L2 controls accessible with the
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - struct ``video_audio``
- .. row 1 - V4L2 Control ID
* - ``volume``
- struct ``video_audio`` - ``V4L2_CID_AUDIO_VOLUME``
* - ``bass``
- V4L2 Control ID - ``V4L2_CID_AUDIO_BASS``
* - ``treble``
- .. row 2 - ``V4L2_CID_AUDIO_TREBLE``
* - ``balance``
- ``volume`` - ``V4L2_CID_AUDIO_BALANCE``
- ``V4L2_CID_AUDIO_VOLUME``
- .. row 3
- ``bass``
- ``V4L2_CID_AUDIO_BASS``
- .. row 4
- ``treble``
- ``V4L2_CID_AUDIO_TREBLE``
- .. row 5
- ``balance``
- ``V4L2_CID_AUDIO_BALANCE``
To determine which of these controls are supported by a driver V4L To determine which of these controls are supported by a driver V4L
@ -752,68 +533,49 @@ differences.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - V4L
- V4L2
* -
- The image format must be selected before buffers are allocated,
with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. When no
format is selected the driver may use the last, possibly by
another application requested format.
* - Applications cannot change the number of buffers. The it is built
into the driver, unless it has a module option to change the
number when the driver module is loaded.
- The :ref:`VIDIOC_REQBUFS` ioctl allocates the
desired number of buffers, this is a required step in the
initialization sequence.
* - Drivers map all buffers as one contiguous range of memory. The
``VIDIOCGMBUF`` ioctl is available to query the number of buffers,
the offset of each buffer from the start of the virtual file, and
the overall amount of memory used, which can be used as arguments
for the :ref:`mmap() <func-mmap>` function.
- Buffers are individually mapped. The offset and size of each
buffer can be determined with the
:ref:`VIDIOC_QUERYBUF` ioctl.
* - The ``VIDIOCMCAPTURE`` ioctl prepares a buffer for capturing. It
also determines the image format for this buffer. The ioctl
returns immediately, eventually with an ``EAGAIN`` error code if no
video signal had been detected. When the driver supports more than
one buffer applications can call the ioctl multiple times and thus
have multiple outstanding capture requests.
- .. row 1 The ``VIDIOCSYNC`` ioctl suspends execution until a particular
buffer has been filled.
- V4L - Drivers maintain an incoming and outgoing queue.
:ref:`VIDIOC_QBUF` enqueues any empty buffer into
- V4L2 the incoming queue. Filled buffers are dequeued from the outgoing
queue with the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. To wait
- .. row 2 until filled buffers become available this function,
:ref:`select() <func-select>` or :ref:`poll() <func-poll>` can
- be used. The :ref:`VIDIOC_STREAMON` ioctl
- The image format must be selected before buffers are allocated, must be called once after enqueuing one or more buffers to start
with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. When no capturing. Its counterpart
format is selected the driver may use the last, possibly by :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` stops capturing and
another application requested format. dequeues all buffers from both queues. Applications can query the
signal status, if known, with the
- .. row 3 :ref:`VIDIOC_ENUMINPUT` ioctl.
- Applications cannot change the number of buffers. The it is built
into the driver, unless it has a module option to change the
number when the driver module is loaded.
- The :ref:`VIDIOC_REQBUFS` ioctl allocates the
desired number of buffers, this is a required step in the
initialization sequence.
- .. row 4
- Drivers map all buffers as one contiguous range of memory. The
``VIDIOCGMBUF`` ioctl is available to query the number of buffers,
the offset of each buffer from the start of the virtual file, and
the overall amount of memory used, which can be used as arguments
for the :ref:`mmap() <func-mmap>` function.
- Buffers are individually mapped. The offset and size of each
buffer can be determined with the
:ref:`VIDIOC_QUERYBUF` ioctl.
- .. row 5
- The ``VIDIOCMCAPTURE`` ioctl prepares a buffer for capturing. It
also determines the image format for this buffer. The ioctl
returns immediately, eventually with an ``EAGAIN`` error code if no
video signal had been detected. When the driver supports more than
one buffer applications can call the ioctl multiple times and thus
have multiple outstanding capture requests.
The ``VIDIOCSYNC`` ioctl suspends execution until a particular
buffer has been filled.
- Drivers maintain an incoming and outgoing queue.
:ref:`VIDIOC_QBUF` enqueues any empty buffer into
the incoming queue. Filled buffers are dequeued from the outgoing
queue with the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. To wait
until filled buffers become available this function,
:ref:`select() <func-select>` or :ref:`poll() <func-poll>` can
be used. The :ref:`VIDIOC_STREAMON` ioctl
must be called once after enqueuing one or more buffers to start
capturing. Its counterpart
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` stops capturing and
dequeues all buffers from both queues. Applications can query the
signal status, if known, with the
:ref:`VIDIOC_ENUMINPUT` ioctl.
For a more in-depth discussion of memory mapping and examples, see For a more in-depth discussion of memory mapping and examples, see
@ -835,56 +597,24 @@ with the following parameters:
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - struct :c:type:`v4l2_vbi_format`
- .. row 1 - V4L, BTTV driver
* - sampling_rate
- struct :c:type:`v4l2_vbi_format` - 28636363 Hz NTSC (or any other 525-line standard); 35468950 Hz PAL
and SECAM (625-line standards)
- V4L, BTTV driver * - offset
- ?
- .. row 2 * - samples_per_line
- 2048
- sampling_rate * - sample_format
- V4L2_PIX_FMT_GREY. The last four bytes (a machine endianness
- 28636363 Hz NTSC (or any other 525-line standard); 35468950 Hz PAL integer) contain a frame counter.
and SECAM (625-line standards) * - start[]
- 10, 273 NTSC; 22, 335 PAL and SECAM
- .. row 3 * - count[]
- 16, 16 [#f9]_
- offset * - flags
- 0
- ?
- .. row 4
- samples_per_line
- 2048
- .. row 5
- sample_format
- V4L2_PIX_FMT_GREY. The last four bytes (a machine endianness
integer) contain a frame counter.
- .. row 6
- start[]
- 10, 273 NTSC; 22, 335 PAL and SECAM
- .. row 7
- count[]
- 16, 16 [#f9]_
- .. row 8
- flags
- 0
Undocumented in the V4L specification, in Linux 2.3 the Undocumented in the V4L specification, in Linux 2.3 the

2753
Documentation/media/uapi/v4l/extended-controls.rst
View File

File diff suppressed because it is too large Load Diff

188
Documentation/media/uapi/v4l/field-order.rst
View File

@ -64,125 +64,75 @@ enum v4l2_field
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_FIELD_ANY``
- .. row 1 - 0
- Applications request this field order when any one of the
- ``V4L2_FIELD_ANY`` ``V4L2_FIELD_NONE``, ``V4L2_FIELD_TOP``, ``V4L2_FIELD_BOTTOM``, or
``V4L2_FIELD_INTERLACED`` formats is acceptable. Drivers choose
- 0 depending on hardware capabilities or e. g. the requested image
size, and return the actual field order. Drivers must never return
- Applications request this field order when any one of the ``V4L2_FIELD_ANY``. If multiple field orders are possible the
``V4L2_FIELD_NONE``, ``V4L2_FIELD_TOP``, ``V4L2_FIELD_BOTTOM``, or driver must choose one of the possible field orders during
``V4L2_FIELD_INTERLACED`` formats is acceptable. Drivers choose :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
depending on hardware capabilities or e. g. the requested image :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`. struct
size, and return the actual field order. Drivers must never return :c:type:`v4l2_buffer` ``field`` can never be
``V4L2_FIELD_ANY``. If multiple field orders are possible the ``V4L2_FIELD_ANY``.
driver must choose one of the possible field orders during * - ``V4L2_FIELD_NONE``
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or - 1
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`. struct - Images are in progressive format, not interlaced. The driver may
:c:type:`v4l2_buffer` ``field`` can never be also indicate this order when it cannot distinguish between
``V4L2_FIELD_ANY``. ``V4L2_FIELD_TOP`` and ``V4L2_FIELD_BOTTOM``.
* - ``V4L2_FIELD_TOP``
- .. row 2 - 2
- Images consist of the top (aka odd) field only.
- ``V4L2_FIELD_NONE`` * - ``V4L2_FIELD_BOTTOM``
- 3
- 1 - Images consist of the bottom (aka even) field only. Applications
may wish to prevent a device from capturing interlaced images
- Images are in progressive format, not interlaced. The driver may because they will have "comb" or "feathering" artefacts around
also indicate this order when it cannot distinguish between moving objects.
``V4L2_FIELD_TOP`` and ``V4L2_FIELD_BOTTOM``. * - ``V4L2_FIELD_INTERLACED``
- 4
- .. row 3 - Images contain both fields, interleaved line by line. The temporal
order of the fields (whether the top or bottom field is first
- ``V4L2_FIELD_TOP`` transmitted) depends on the current video standard. M/NTSC
transmits the bottom field first, all other standards the top
- 2 field first.
* - ``V4L2_FIELD_SEQ_TB``
- Images consist of the top (aka odd) field only. - 5
- Images contain both fields, the top field lines are stored first
- .. row 4 in memory, immediately followed by the bottom field lines. Fields
are always stored in temporal order, the older one first in
- ``V4L2_FIELD_BOTTOM`` memory. Image sizes refer to the frame, not fields.
* - ``V4L2_FIELD_SEQ_BT``
- 3 - 6
- Images contain both fields, the bottom field lines are stored
- Images consist of the bottom (aka even) field only. Applications first in memory, immediately followed by the top field lines.
may wish to prevent a device from capturing interlaced images Fields are always stored in temporal order, the older one first in
because they will have "comb" or "feathering" artefacts around memory. Image sizes refer to the frame, not fields.
moving objects. * - ``V4L2_FIELD_ALTERNATE``
- 7
- .. row 5 - The two fields of a frame are passed in separate buffers, in
temporal order, i. e. the older one first. To indicate the field
- ``V4L2_FIELD_INTERLACED`` parity (whether the current field is a top or bottom field) the
driver or application, depending on data direction, must set
- 4 struct :c:type:`v4l2_buffer` ``field`` to
``V4L2_FIELD_TOP`` or ``V4L2_FIELD_BOTTOM``. Any two successive
- Images contain both fields, interleaved line by line. The temporal fields pair to build a frame. If fields are successive, without
order of the fields (whether the top or bottom field is first any dropped fields between them (fields can drop individually),
transmitted) depends on the current video standard. M/NTSC can be determined from the struct
transmits the bottom field first, all other standards the top :c:type:`v4l2_buffer` ``sequence`` field. This
field first. format cannot be selected when using the read/write I/O method
since there is no way to communicate if a field was a top or
- .. row 6 bottom field.
* - ``V4L2_FIELD_INTERLACED_TB``
- ``V4L2_FIELD_SEQ_TB`` - 8
- Images contain both fields, interleaved line by line, top field
- 5 first. The top field is transmitted first.
* - ``V4L2_FIELD_INTERLACED_BT``
- Images contain both fields, the top field lines are stored first - 9
in memory, immediately followed by the bottom field lines. Fields - Images contain both fields, interleaved line by line, top field
are always stored in temporal order, the older one first in first. The bottom field is transmitted first.
memory. Image sizes refer to the frame, not fields.
- .. row 7
- ``V4L2_FIELD_SEQ_BT``
- 6
- Images contain both fields, the bottom field lines are stored
first in memory, immediately followed by the top field lines.
Fields are always stored in temporal order, the older one first in
memory. Image sizes refer to the frame, not fields.
- .. row 8
- ``V4L2_FIELD_ALTERNATE``
- 7
- The two fields of a frame are passed in separate buffers, in
temporal order, i. e. the older one first. To indicate the field
parity (whether the current field is a top or bottom field) the
driver or application, depending on data direction, must set
struct :c:type:`v4l2_buffer` ``field`` to
``V4L2_FIELD_TOP`` or ``V4L2_FIELD_BOTTOM``. Any two successive
fields pair to build a frame. If fields are successive, without
any dropped fields between them (fields can drop individually),
can be determined from the struct
:c:type:`v4l2_buffer` ``sequence`` field. This
format cannot be selected when using the read/write I/O method
since there is no way to communicate if a field was a top or
bottom field.
- .. row 9
- ``V4L2_FIELD_INTERLACED_TB``
- 8
- Images contain both fields, interleaved line by line, top field
first. The top field is transmitted first.
- .. row 10
- ``V4L2_FIELD_INTERLACED_BT``
- 9
- Images contain both fields, interleaved line by line, top field
first. The bottom field is transmitted first.

231
Documentation/media/uapi/v4l/hist-v4l2.rst
View File

@ -447,90 +447,34 @@ This unnamed version was finally merged into Linux 2.5.46.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Old defines
- .. row 1 - enum :c:type:`v4l2_buf_type`
* - ``V4L2_BUF_TYPE_CAPTURE``
- Old defines - ``V4L2_BUF_TYPE_VIDEO_CAPTURE``
* - ``V4L2_BUF_TYPE_CODECIN``
- enum :c:type:`v4l2_buf_type` - Omitted for now
* - ``V4L2_BUF_TYPE_CODECOUT``
- .. row 2 - Omitted for now
* - ``V4L2_BUF_TYPE_EFFECTSIN``
- ``V4L2_BUF_TYPE_CAPTURE`` - Omitted for now
* - ``V4L2_BUF_TYPE_EFFECTSIN2``
- ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` - Omitted for now
* - ``V4L2_BUF_TYPE_EFFECTSOUT``
- .. row 3 - Omitted for now
* - ``V4L2_BUF_TYPE_VIDEOOUT``
- ``V4L2_BUF_TYPE_CODECIN`` - ``V4L2_BUF_TYPE_VIDEO_OUTPUT``
* - ``-``
- Omitted for now - ``V4L2_BUF_TYPE_VIDEO_OVERLAY``
* - ``-``
- .. row 4 - ``V4L2_BUF_TYPE_VBI_CAPTURE``
* - ``-``
- ``V4L2_BUF_TYPE_CODECOUT`` - ``V4L2_BUF_TYPE_VBI_OUTPUT``
* - ``-``
- Omitted for now - ``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE``
* - ``-``
- .. row 5 - ``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``
* - ``V4L2_BUF_TYPE_PRIVATE_BASE``
- ``V4L2_BUF_TYPE_EFFECTSIN`` - ``V4L2_BUF_TYPE_PRIVATE`` (but this is deprecated)
- Omitted for now
- .. row 6
- ``V4L2_BUF_TYPE_EFFECTSIN2``
- Omitted for now
- .. row 7
- ``V4L2_BUF_TYPE_EFFECTSOUT``
- Omitted for now
- .. row 8
- ``V4L2_BUF_TYPE_VIDEOOUT``
- ``V4L2_BUF_TYPE_VIDEO_OUTPUT``
- .. row 9
- ``-``
- ``V4L2_BUF_TYPE_VIDEO_OVERLAY``
- .. row 10
- ``-``
- ``V4L2_BUF_TYPE_VBI_CAPTURE``
- .. row 11
- ``-``
- ``V4L2_BUF_TYPE_VBI_OUTPUT``
- .. row 12
- ``-``
- ``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE``
- .. row 13
- ``-``
- ``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``
- .. row 14
- ``V4L2_BUF_TYPE_PRIVATE_BASE``
- ``V4L2_BUF_TYPE_PRIVATE`` (but this is deprecated)
10. In struct :c:type:`v4l2_fmtdesc` a enum 10. In struct :c:type:`v4l2_fmtdesc` a enum
@ -564,54 +508,22 @@ This unnamed version was finally merged into Linux 2.5.46.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Old flag
- .. row 1 - enum :c:type:`v4l2_field`
* - ``V4L2_FMT_FLAG_NOT_INTERLACED``
- Old flag - ?
* - ``V4L2_FMT_FLAG_INTERLACED`` = ``V4L2_FMT_FLAG_COMBINED``
- enum :c:type:`v4l2_field` - ``V4L2_FIELD_INTERLACED``
* - ``V4L2_FMT_FLAG_TOPFIELD`` = ``V4L2_FMT_FLAG_ODDFIELD``
- .. row 2 - ``V4L2_FIELD_TOP``
* - ``V4L2_FMT_FLAG_BOTFIELD`` = ``V4L2_FMT_FLAG_EVENFIELD``
- ``V4L2_FMT_FLAG_NOT_INTERLACED`` - ``V4L2_FIELD_BOTTOM``
* - ``-``
- ? - ``V4L2_FIELD_SEQ_TB``
* - ``-``
- .. row 3 - ``V4L2_FIELD_SEQ_BT``
* - ``-``
- ``V4L2_FMT_FLAG_INTERLACED`` = ``V4L2_FMT_FLAG_COMBINED`` - ``V4L2_FIELD_ALTERNATE``
- ``V4L2_FIELD_INTERLACED``
- .. row 4
- ``V4L2_FMT_FLAG_TOPFIELD`` = ``V4L2_FMT_FLAG_ODDFIELD``
- ``V4L2_FIELD_TOP``
- .. row 5
- ``V4L2_FMT_FLAG_BOTFIELD`` = ``V4L2_FMT_FLAG_EVENFIELD``
- ``V4L2_FIELD_BOTTOM``
- .. row 6
- ``-``
- ``V4L2_FIELD_SEQ_TB``
- .. row 7
- ``-``
- ``V4L2_FIELD_SEQ_BT``
- .. row 8
- ``-``
- ``V4L2_FIELD_ALTERNATE``
The color space flags were replaced by a enum The color space flags were replaced by a enum
@ -768,46 +680,21 @@ V4L2 2003-11-05
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Symbol
- .. row 1 - In this document prior to revision 0.5
- Corrected
- Symbol * - ``V4L2_PIX_FMT_RGB24``
- B, G, R
- In this document prior to revision 0.5 - R, G, B
* - ``V4L2_PIX_FMT_BGR24``
- Corrected - R, G, B
- B, G, R
- .. row 2 * - ``V4L2_PIX_FMT_RGB32``
- B, G, R, X
- ``V4L2_PIX_FMT_RGB24`` - R, G, B, X
* - ``V4L2_PIX_FMT_BGR32``
- B, G, R - R, G, B, X
- B, G, R, X
- R, G, B
- .. row 3
- ``V4L2_PIX_FMT_BGR24``
- R, G, B
- B, G, R
- .. row 4
- ``V4L2_PIX_FMT_RGB32``
- B, G, R, X
- R, G, B, X
- .. row 5
- ``V4L2_PIX_FMT_BGR32``
- R, G, B, X
- B, G, R, X
The ``V4L2_PIX_FMT_BGR24`` example was always correct. The ``V4L2_PIX_FMT_BGR24`` example was always correct.

284
Documentation/media/uapi/v4l/pixfmt-002.rst
View File

@ -15,185 +15,119 @@ Single-planar format structure
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- ``width``
- Image width in pixels.
* - __u32
- ``height``
- Image height in pixels. If ``field`` is one of ``V4L2_FIELD_TOP``,
``V4L2_FIELD_BOTTOM`` or ``V4L2_FIELD_ALTERNATE`` then height
refers to the number of lines in the field, otherwise it refers to
the number of lines in the frame (which is twice the field height
for interlaced formats).
* - :cspan:`2` Applications set these fields to request an image
size, drivers return the closest possible values. In case of
planar formats the ``width`` and ``height`` applies to the largest
plane. To avoid ambiguities drivers must return values rounded up
to a multiple of the scale factor of any smaller planes. For
example when the image format is YUV 4:2:0, ``width`` and
``height`` must be multiples of two.
* - __u32
- ``pixelformat``
- The pixel format or type of compression, set by the application.
This is a little endian
:ref:`four character code <v4l2-fourcc>`. V4L2 defines standard
RGB formats in :ref:`rgb-formats`, YUV formats in
:ref:`yuv-formats`, and reserved codes in
:ref:`reserved-formats`
* - enum :c:type::`v4l2_field`
- ``field``
- Video images are typically interlaced. Applications can request to
capture or output only the top or bottom field, or both fields
interlaced or sequentially stored in one buffer or alternating in
separate buffers. Drivers return the actual field order selected.
For more details on fields see :ref:`field-order`.
* - __u32
- ``bytesperline``
- Distance in bytes between the leftmost pixels in two adjacent
lines.
* - :cspan:`2`
- .. row 1 Both applications and drivers can set this field to request
padding bytes at the end of each line. Drivers however may ignore
the value requested by the application, returning ``width`` times
bytes per pixel or a larger value required by the hardware. That
implies applications can just set this field to zero to get a
reasonable default.
- __u32 Video hardware may access padding bytes, therefore they must
reside in accessible memory. Consider cases where padding bytes
after the last line of an image cross a system page boundary.
Input devices may write padding bytes, the value is undefined.
Output devices ignore the contents of padding bytes.
- ``width`` When the image format is planar the ``bytesperline`` value applies
to the first plane and is divided by the same factor as the
``width`` field for the other planes. For example the Cb and Cr
planes of a YUV 4:2:0 image have half as many padding bytes
following each line as the Y plane. To avoid ambiguities drivers
must return a ``bytesperline`` value rounded up to a multiple of
the scale factor.
- Image width in pixels. For compressed formats the ``bytesperline`` value makes no sense.
Applications and drivers must set this to 0 in that case.
* - __u32
- ``sizeimage``
- Size in bytes of the buffer to hold a complete image, set by the
driver. Usually this is ``bytesperline`` times ``height``. When
the image consists of variable length compressed data this is the
maximum number of bytes required to hold an image.
* - enum :c:type:`v4l2_colorspace`
- ``colorspace``
- This information supplements the ``pixelformat`` and must be set
by the driver for capture streams and by the application for
output streams, see :ref:`colorspaces`.
* - __u32
- ``priv``
- This field indicates whether the remaining fields of the
struct :c:type:`v4l2_pix_format`, also called the
extended fields, are valid. When set to
``V4L2_PIX_FMT_PRIV_MAGIC``, it indicates that the extended fields
have been correctly initialized. When set to any other value it
indicates that the extended fields contain undefined values.
- .. row 2 Applications that wish to use the pixel format extended fields
must first ensure that the feature is supported by querying the
device for the :ref:`V4L2_CAP_EXT_PIX_FORMAT <querycap>`
capability. If the capability isn't set the pixel format extended
fields are not supported and using the extended fields will lead
to undefined results.
- __u32 To use the extended fields, applications must set the ``priv``
field to ``V4L2_PIX_FMT_PRIV_MAGIC``, initialize all the extended
fields and zero the unused bytes of the
struct :c:type:`v4l2_format` ``raw_data`` field.
- ``height`` When the ``priv`` field isn't set to ``V4L2_PIX_FMT_PRIV_MAGIC``
drivers must act as if all the extended fields were set to zero.
- Image height in pixels. If ``field`` is one of ``V4L2_FIELD_TOP``, On return drivers must set the ``priv`` field to
``V4L2_FIELD_BOTTOM`` or ``V4L2_FIELD_ALTERNATE`` then height ``V4L2_PIX_FMT_PRIV_MAGIC`` and all the extended fields to
refers to the number of lines in the field, otherwise it refers to applicable values.
the number of lines in the frame (which is twice the field height * - __u32
for interlaced formats). - ``flags``
- Flags set by the application or driver, see :ref:`format-flags`.
- .. row 3 * - enum :c:type:`v4l2_ycbcr_encoding`
- ``ycbcr_enc``
- :cspan:`2` Applications set these fields to request an image - This information supplements the ``colorspace`` and must be set by
size, drivers return the closest possible values. In case of the driver for capture streams and by the application for output
planar formats the ``width`` and ``height`` applies to the largest streams, see :ref:`colorspaces`.
plane. To avoid ambiguities drivers must return values rounded up * - enum :c:type:`v4l2_quantization`
to a multiple of the scale factor of any smaller planes. For - ``quantization``
example when the image format is YUV 4:2:0, ``width`` and - This information supplements the ``colorspace`` and must be set by
``height`` must be multiples of two. the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
- .. row 4 * - enum :c:type:`v4l2_xfer_func`
- ``xfer_func``
- __u32 - This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
- ``pixelformat`` streams, see :ref:`colorspaces`.
- The pixel format or type of compression, set by the application.
This is a little endian
:ref:`four character code <v4l2-fourcc>`. V4L2 defines standard
RGB formats in :ref:`rgb-formats`, YUV formats in
:ref:`yuv-formats`, and reserved codes in
:ref:`reserved-formats`
- .. row 5
- enum :c:type::`v4l2_field`
- ``field``
- Video images are typically interlaced. Applications can request to
capture or output only the top or bottom field, or both fields
interlaced or sequentially stored in one buffer or alternating in
separate buffers. Drivers return the actual field order selected.
For more details on fields see :ref:`field-order`.
- .. row 6
- __u32
- ``bytesperline``
- Distance in bytes between the leftmost pixels in two adjacent
lines.
- .. row 7
- :cspan:`2`
Both applications and drivers can set this field to request
padding bytes at the end of each line. Drivers however may ignore
the value requested by the application, returning ``width`` times
bytes per pixel or a larger value required by the hardware. That
implies applications can just set this field to zero to get a
reasonable default.
Video hardware may access padding bytes, therefore they must
reside in accessible memory. Consider cases where padding bytes
after the last line of an image cross a system page boundary.
Input devices may write padding bytes, the value is undefined.
Output devices ignore the contents of padding bytes.
When the image format is planar the ``bytesperline`` value applies
to the first plane and is divided by the same factor as the
``width`` field for the other planes. For example the Cb and Cr
planes of a YUV 4:2:0 image have half as many padding bytes
following each line as the Y plane. To avoid ambiguities drivers
must return a ``bytesperline`` value rounded up to a multiple of
the scale factor.
For compressed formats the ``bytesperline`` value makes no sense.
Applications and drivers must set this to 0 in that case.
- .. row 8
- __u32
- ``sizeimage``
- Size in bytes of the buffer to hold a complete image, set by the
driver. Usually this is ``bytesperline`` times ``height``. When
the image consists of variable length compressed data this is the
maximum number of bytes required to hold an image.
- .. row 9
- enum :c:type:`v4l2_colorspace`
- ``colorspace``
- This information supplements the ``pixelformat`` and must be set
by the driver for capture streams and by the application for
output streams, see :ref:`colorspaces`.
- .. row 10
- __u32
- ``priv``
- This field indicates whether the remaining fields of the
struct :c:type:`v4l2_pix_format`, also called the
extended fields, are valid. When set to
``V4L2_PIX_FMT_PRIV_MAGIC``, it indicates that the extended fields
have been correctly initialized. When set to any other value it
indicates that the extended fields contain undefined values.
Applications that wish to use the pixel format extended fields
must first ensure that the feature is supported by querying the
device for the :ref:`V4L2_CAP_EXT_PIX_FORMAT <querycap>`
capability. If the capability isn't set the pixel format extended
fields are not supported and using the extended fields will lead
to undefined results.
To use the extended fields, applications must set the ``priv``
field to ``V4L2_PIX_FMT_PRIV_MAGIC``, initialize all the extended
fields and zero the unused bytes of the
struct :c:type:`v4l2_format` ``raw_data`` field.
When the ``priv`` field isn't set to ``V4L2_PIX_FMT_PRIV_MAGIC``
drivers must act as if all the extended fields were set to zero.
On return drivers must set the ``priv`` field to
``V4L2_PIX_FMT_PRIV_MAGIC`` and all the extended fields to
applicable values.
- .. row 11
- __u32
- ``flags``
- Flags set by the application or driver, see :ref:`format-flags`.
- .. row 12
- enum :c:type:`v4l2_ycbcr_encoding`
- ``ycbcr_enc``
- This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
- .. row 13
- enum :c:type:`v4l2_quantization`
- ``quantization``
- This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
- .. row 14
- enum :c:type:`v4l2_xfer_func`
- ``xfer_func``
- This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.

195
Documentation/media/uapi/v4l/pixfmt-003.rst
View File

@ -21,32 +21,17 @@ describing all planes of that format.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``sizeimage``
- Maximum size in bytes required for image data in this plane.
- __u32 * - __u32
- ``bytesperline``
- ``sizeimage`` - Distance in bytes between the leftmost pixels in two adjacent
lines. See struct :c:type:`v4l2_pix_format`.
- Maximum size in bytes required for image data in this plane. * - __u16
- ``reserved[6]``
- .. row 2 - Reserved for future extensions. Should be zeroed by drivers and
applications.
- __u32
- ``bytesperline``
- Distance in bytes between the leftmost pixels in two adjacent
lines. See struct :c:type:`v4l2_pix_format`.
- .. row 3
- __u16
- ``reserved[6]``
- Reserved for future extensions. Should be zeroed by drivers and
applications.
.. tabularcolumns:: |p{4.4cm}|p{5.6cm}|p{7.5cm}| .. tabularcolumns:: |p{4.4cm}|p{5.6cm}|p{7.5cm}|
@ -58,112 +43,52 @@ describing all planes of that format.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``width``
- Image width in pixels. See struct
- __u32 :c:type:`v4l2_pix_format`.
* - __u32
- ``width`` - ``height``
- Image height in pixels. See struct
- Image width in pixels. See struct :c:type:`v4l2_pix_format`.
:c:type:`v4l2_pix_format`. * - __u32
- ``pixelformat``
- .. row 2 - The pixel format. Both single- and multi-planar four character
codes can be used.
- __u32 * - enum :c:type:`v4l2_field`
- ``field``
- ``height`` - See struct :c:type:`v4l2_pix_format`.
* - enum :c:type:`v4l2_colorspace`
- Image height in pixels. See struct - ``colorspace``
:c:type:`v4l2_pix_format`. - See struct :c:type:`v4l2_pix_format`.
* - struct :c:type:`v4l2_plane_pix_format`
- .. row 3 - ``plane_fmt[VIDEO_MAX_PLANES]``
- An array of structures describing format of each plane this pixel
- __u32 format consists of. The number of valid entries in this array has
to be put in the ``num_planes`` field.
- ``pixelformat`` * - __u8
- ``num_planes``
- The pixel format. Both single- and multi-planar four character - Number of planes (i.e. separate memory buffers) for this format
codes can be used. and the number of valid entries in the ``plane_fmt`` array.
* - __u8
- .. row 4 - ``flags``
- Flags set by the application or driver, see :ref:`format-flags`.
- enum :c:type:`v4l2_field` * - enum :c:type:`v4l2_ycbcr_encoding`
- ``ycbcr_enc``
- ``field`` - This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
- See struct :c:type:`v4l2_pix_format`. streams, see :ref:`colorspaces`.
* - enum :c:type:`v4l2_quantization`
- .. row 5 - ``quantization``
- This information supplements the ``colorspace`` and must be set by
- enum :c:type:`v4l2_colorspace` the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
- ``colorspace`` * - enum :c:type:`v4l2_xfer_func`
- ``xfer_func``
- See struct :c:type:`v4l2_pix_format`. - This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
- .. row 6 streams, see :ref:`colorspaces`.
* - __u8
- struct :c:type:`v4l2_plane_pix_format` - ``reserved[7]``
- Reserved for future extensions. Should be zeroed by drivers and
- ``plane_fmt[VIDEO_MAX_PLANES]`` applications.
- An array of structures describing format of each plane this pixel
format consists of. The number of valid entries in this array has
to be put in the ``num_planes`` field.
- .. row 7
- __u8
- ``num_planes``
- Number of planes (i.e. separate memory buffers) for this format
and the number of valid entries in the ``plane_fmt`` array.
- .. row 8
- __u8
- ``flags``
- Flags set by the application or driver, see :ref:`format-flags`.
- .. row 9
- enum :c:type:`v4l2_ycbcr_encoding`
- ``ycbcr_enc``
- This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
- .. row 10
- enum :c:type:`v4l2_quantization`
- ``quantization``
- This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
- .. row 11
- enum :c:type:`v4l2_xfer_func`
- ``xfer_func``
- This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
- .. row 12
- __u8
- ``reserved[7]``
- Reserved for future extensions. Should be zeroed by drivers and
applications.

306
Documentation/media/uapi/v4l/pixfmt-006.rst
View File

@ -33,89 +33,37 @@ needs to be filled in.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Identifier
- .. row 1 - Details
* - ``V4L2_COLORSPACE_DEFAULT``
- Identifier - The default colorspace. This can be used by applications to let
the driver fill in the colorspace.
- Details * - ``V4L2_COLORSPACE_SMPTE170M``
- See :ref:`col-smpte-170m`.
- .. row 2 * - ``V4L2_COLORSPACE_REC709``
- See :ref:`col-rec709`.
- ``V4L2_COLORSPACE_DEFAULT`` * - ``V4L2_COLORSPACE_SRGB``
- See :ref:`col-srgb`.
- The default colorspace. This can be used by applications to let * - ``V4L2_COLORSPACE_ADOBERGB``
the driver fill in the colorspace. - See :ref:`col-adobergb`.
* - ``V4L2_COLORSPACE_BT2020``
- .. row 3 - See :ref:`col-bt2020`.
* - ``V4L2_COLORSPACE_DCI_P3``
- ``V4L2_COLORSPACE_SMPTE170M`` - See :ref:`col-dcip3`.
* - ``V4L2_COLORSPACE_SMPTE240M``
- See :ref:`col-smpte-170m`. - See :ref:`col-smpte-240m`.
* - ``V4L2_COLORSPACE_470_SYSTEM_M``
- .. row 4 - See :ref:`col-sysm`.
* - ``V4L2_COLORSPACE_470_SYSTEM_BG``
- ``V4L2_COLORSPACE_REC709`` - See :ref:`col-sysbg`.
* - ``V4L2_COLORSPACE_JPEG``
- See :ref:`col-rec709`. - See :ref:`col-jpeg`.
* - ``V4L2_COLORSPACE_RAW``
- .. row 5 - The raw colorspace. This is used for raw image capture where the
image is minimally processed and is using the internal colorspace
- ``V4L2_COLORSPACE_SRGB`` of the device. The software that processes an image using this
'colorspace' will have to know the internals of the capture
- See :ref:`col-srgb`. device.
- .. row 6
- ``V4L2_COLORSPACE_ADOBERGB``
- See :ref:`col-adobergb`.
- .. row 7
- ``V4L2_COLORSPACE_BT2020``
- See :ref:`col-bt2020`.
- .. row 8
- ``V4L2_COLORSPACE_DCI_P3``
- See :ref:`col-dcip3`.
- .. row 9
- ``V4L2_COLORSPACE_SMPTE240M``
- See :ref:`col-smpte-240m`.
- .. row 10
- ``V4L2_COLORSPACE_470_SYSTEM_M``
- See :ref:`col-sysm`.
- .. row 11
- ``V4L2_COLORSPACE_470_SYSTEM_BG``
- See :ref:`col-sysbg`.
- .. row 12
- ``V4L2_COLORSPACE_JPEG``
- See :ref:`col-jpeg`.
- .. row 13
- ``V4L2_COLORSPACE_RAW``
- The raw colorspace. This is used for raw image capture where the
image is minimally processed and is using the internal colorspace
of the device. The software that processes an image using this
'colorspace' will have to know the internals of the capture
device.
@ -125,60 +73,24 @@ needs to be filled in.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Identifier
- .. row 1 - Details
* - ``V4L2_XFER_FUNC_DEFAULT``
- Identifier - Use the default transfer function as defined by the colorspace.
* - ``V4L2_XFER_FUNC_709``
- Details - Use the Rec. 709 transfer function.
* - ``V4L2_XFER_FUNC_SRGB``
- .. row 2 - Use the sRGB transfer function.
* - ``V4L2_XFER_FUNC_ADOBERGB``
- ``V4L2_XFER_FUNC_DEFAULT`` - Use the AdobeRGB transfer function.
* - ``V4L2_XFER_FUNC_SMPTE240M``
- Use the default transfer function as defined by the colorspace. - Use the SMPTE 240M transfer function.
* - ``V4L2_XFER_FUNC_NONE``
- .. row 3 - Do not use a transfer function (i.e. use linear RGB values).
* - ``V4L2_XFER_FUNC_DCI_P3``
- ``V4L2_XFER_FUNC_709`` - Use the DCI-P3 transfer function.
* - ``V4L2_XFER_FUNC_SMPTE2084``
- Use the Rec. 709 transfer function. - Use the SMPTE 2084 transfer function.
- .. row 4
- ``V4L2_XFER_FUNC_SRGB``
- Use the sRGB transfer function.
- .. row 5
- ``V4L2_XFER_FUNC_ADOBERGB``
- Use the AdobeRGB transfer function.
- .. row 6
- ``V4L2_XFER_FUNC_SMPTE240M``
- Use the SMPTE 240M transfer function.
- .. row 7
- ``V4L2_XFER_FUNC_NONE``
- Do not use a transfer function (i.e. use linear RGB values).
- .. row 8
- ``V4L2_XFER_FUNC_DCI_P3``
- Use the DCI-P3 transfer function.
- .. row 9
- ``V4L2_XFER_FUNC_SMPTE2084``
- Use the SMPTE 2084 transfer function.
@ -190,60 +102,24 @@ needs to be filled in.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Identifier
- .. row 1 - Details
* - ``V4L2_YCBCR_ENC_DEFAULT``
- Identifier - Use the default Y'CbCr encoding as defined by the colorspace.
* - ``V4L2_YCBCR_ENC_601``
- Details - Use the BT.601 Y'CbCr encoding.
* - ``V4L2_YCBCR_ENC_709``
- .. row 2 - Use the Rec. 709 Y'CbCr encoding.
* - ``V4L2_YCBCR_ENC_XV601``
- ``V4L2_YCBCR_ENC_DEFAULT`` - Use the extended gamut xvYCC BT.601 encoding.
* - ``V4L2_YCBCR_ENC_XV709``
- Use the default Y'CbCr encoding as defined by the colorspace. - Use the extended gamut xvYCC Rec. 709 encoding.
* - ``V4L2_YCBCR_ENC_BT2020``
- .. row 3 - Use the default non-constant luminance BT.2020 Y'CbCr encoding.
* - ``V4L2_YCBCR_ENC_BT2020_CONST_LUM``
- ``V4L2_YCBCR_ENC_601`` - Use the constant luminance BT.2020 Yc'CbcCrc encoding.
* - ``V4L2_YCBCR_ENC_SMPTE_240M``
- Use the BT.601 Y'CbCr encoding. - Use the SMPTE 240M Y'CbCr encoding.
- .. row 4
- ``V4L2_YCBCR_ENC_709``
- Use the Rec. 709 Y'CbCr encoding.
- .. row 5
- ``V4L2_YCBCR_ENC_XV601``
- Use the extended gamut xvYCC BT.601 encoding.
- .. row 6
- ``V4L2_YCBCR_ENC_XV709``
- Use the extended gamut xvYCC Rec. 709 encoding.
- .. row 7
- ``V4L2_YCBCR_ENC_BT2020``
- Use the default non-constant luminance BT.2020 Y'CbCr encoding.
- .. row 8
- ``V4L2_YCBCR_ENC_BT2020_CONST_LUM``
- Use the constant luminance BT.2020 Yc'CbcCrc encoding.
- .. row 9
- ``V4L2_YCBCR_ENC_SMPTE_240M``
- Use the SMPTE 240M Y'CbCr encoding.
@ -255,35 +131,19 @@ needs to be filled in.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Identifier
- .. row 1 - Details
* - ``V4L2_QUANTIZATION_DEFAULT``
- Identifier - Use the default quantization encoding as defined by the
colorspace. This is always full range for R'G'B' (except for the
- Details BT.2020 colorspace) and usually limited range for Y'CbCr.
* - ``V4L2_QUANTIZATION_FULL_RANGE``
- .. row 2 - Use the full range quantization encoding. I.e. the range [0…1] is
mapped to [0…255] (with possible clipping to [1…254] to avoid the
- ``V4L2_QUANTIZATION_DEFAULT`` 0x00 and 0xff values). Cb and Cr are mapped from [-0.5…0.5] to
[0…255] (with possible clipping to [1…254] to avoid the 0x00 and
- Use the default quantization encoding as defined by the 0xff values).
colorspace. This is always full range for R'G'B' (except for the * - ``V4L2_QUANTIZATION_LIM_RANGE``
BT.2020 colorspace) and usually limited range for Y'CbCr. - Use the limited range quantization encoding. I.e. the range [0…1]
is mapped to [16…235]. Cb and Cr are mapped from [-0.5…0.5] to
- .. row 3 [16…240].
- ``V4L2_QUANTIZATION_FULL_RANGE``
- Use the full range quantization encoding. I.e. the range [0…1] is
mapped to [0…255] (with possible clipping to [1…254] to avoid the
0x00 and 0xff values). Cb and Cr are mapped from [-0.5…0.5] to
[0…255] (with possible clipping to [1…254] to avoid the 0x00 and
0xff values).
- .. row 4
- ``V4L2_QUANTIZATION_LIM_RANGE``
- Use the limited range quantization encoding. I.e. the range [0…1]
is mapped to [16…235]. Cb and Cr are mapped from [-0.5…0.5] to
[16…240].

495
Documentation/media/uapi/v4l/pixfmt-007.rst
View File

@ -26,46 +26,21 @@ are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.630
- x - 0.340
* - Green
- y - 0.310
- 0.595
- .. row 2 * - Blue
- 0.155
- Red - 0.070
* - White Reference (D65)
- 0.630 - 0.3127
- 0.3290
- 0.340
- .. row 3
- Green
- 0.310
- 0.595
- .. row 4
- Blue
- 0.155
- 0.070
- .. row 5
- White Reference (D65)
- 0.3127
- 0.3290
The red, green and blue chromaticities are also often referred to as the The red, green and blue chromaticities are also often referred to as the
@ -132,46 +107,21 @@ and the white reference are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.640
- x - 0.330
* - Green
- y - 0.300
- 0.600
- .. row 2 * - Blue
- 0.150
- Red - 0.060
* - White Reference (D65)
- 0.640 - 0.3127
- 0.3290
- 0.330
- .. row 3
- Green
- 0.300
- 0.600
- .. row 4
- Blue
- 0.150
- 0.060
- .. row 5
- White Reference (D65)
- 0.3127
- 0.3290
The full name of this standard is Rec. ITU-R BT.709-5. The full name of this standard is Rec. ITU-R BT.709-5.
@ -273,46 +223,21 @@ The chromaticities of the primary colors and the white reference are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.640
- x - 0.330
* - Green
- y - 0.300
- 0.600
- .. row 2 * - Blue
- 0.150
- Red - 0.060
* - White Reference (D65)
- 0.640 - 0.3127
- 0.3290
- 0.330
- .. row 3
- Green
- 0.300
- 0.600
- .. row 4
- Blue
- 0.150
- 0.060
- .. row 5
- White Reference (D65)
- 0.3127
- 0.3290
These chromaticities are identical to the Rec. 709 colorspace. These chromaticities are identical to the Rec. 709 colorspace.
@ -376,46 +301,21 @@ are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.6400
- x - 0.3300
* - Green
- y - 0.2100
- 0.7100
- .. row 2 * - Blue
- 0.1500
- Red - 0.0600
* - White Reference (D65)
- 0.6400 - 0.3127
- 0.3290
- 0.3300
- .. row 3
- Green
- 0.2100
- 0.7100
- .. row 4
- Blue
- 0.1500
- 0.0600
- .. row 5
- White Reference (D65)
- 0.3127
- 0.3290
@ -468,46 +368,21 @@ of the primary colors and the white reference are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.708
- x - 0.292
* - Green
- y - 0.170
- 0.797
- .. row 2 * - Blue
- 0.131
- Red - 0.046
* - White Reference (D65)
- 0.708 - 0.3127
- 0.3290
- 0.292
- .. row 3
- Green
- 0.170
- 0.797
- .. row 4
- Blue
- 0.131
- 0.046
- .. row 5
- White Reference (D65)
- 0.3127
- 0.3290
@ -592,46 +467,21 @@ The chromaticities of the primary colors and the white reference are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.6800
- x - 0.3200
* - Green
- y - 0.2650
- 0.6900
- .. row 2 * - Blue
- 0.1500
- Red - 0.0600
* - White Reference
- 0.6800 - 0.3140
- 0.3510
- 0.3200
- .. row 3
- Green
- 0.2650
- 0.6900
- .. row 4
- Blue
- 0.1500
- 0.0600
- .. row 5
- White Reference
- 0.3140
- 0.3510
@ -671,46 +521,21 @@ and the white reference are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.630
- x - 0.340
* - Green
- y - 0.310
- 0.595
- .. row 2 * - Blue
- 0.155
- Red - 0.070
* - White Reference (D65)
- 0.630 - 0.3127
- 0.3290
- 0.340
- .. row 3
- Green
- 0.310
- 0.595
- .. row 4
- Blue
- 0.155
- 0.070
- .. row 5
- White Reference (D65)
- 0.3127
- 0.3290
These chromaticities are identical to the SMPTE 170M colorspace. These chromaticities are identical to the SMPTE 170M colorspace.
@ -767,46 +592,21 @@ reference are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.67
- x - 0.33
* - Green
- y - 0.21
- 0.71
- .. row 2 * - Blue
- 0.14
- Red - 0.08
* - White Reference (C)
- 0.67 - 0.310
- 0.316
- 0.33
- .. row 3
- Green
- 0.21
- 0.71
- .. row 4
- Blue
- 0.14
- 0.08
- .. row 5
- White Reference (C)
- 0.310
- 0.316
.. note:: .. note::
@ -871,46 +671,21 @@ are:
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Color
- .. row 1 - x
- y
- Color * - Red
- 0.64
- x - 0.33
* - Green
- y - 0.29
- 0.60
- .. row 2 * - Blue
- 0.15
- Red - 0.06
* - White Reference (D65)
- 0.64 - 0.3127
- 0.3290
- 0.33
- .. row 3
- Green
- 0.29
- 0.60
- .. row 4
- Blue
- 0.15
- 0.06
- .. row 5
- White Reference (D65)
- 0.3127
- 0.3290

160
Documentation/media/uapi/v4l/pixfmt-013.rst
View File

@ -14,118 +14,74 @@ Compressed Formats
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - Identifier
- Code
- Details
* .. _V4L2-PIX-FMT-JPEG:
- .. row 1 - ``V4L2_PIX_FMT_JPEG``
- 'JPEG'
- TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`,
:ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`.
* .. _V4L2-PIX-FMT-MPEG:
- Identifier - ``V4L2_PIX_FMT_MPEG``
- 'MPEG'
- MPEG multiplexed stream. The actual format is determined by
extended control ``V4L2_CID_MPEG_STREAM_TYPE``, see
:ref:`mpeg-control-id`.
* .. _V4L2-PIX-FMT-H264:
- Code - ``V4L2_PIX_FMT_H264``
- 'H264'
- H264 video elementary stream with start codes.
* .. _V4L2-PIX-FMT-H264-NO-SC:
- Details - ``V4L2_PIX_FMT_H264_NO_SC``
- 'AVC1'
- H264 video elementary stream without start codes.
* .. _V4L2-PIX-FMT-H264-MVC:
- .. _V4L2-PIX-FMT-JPEG: - ``V4L2_PIX_FMT_H264_MVC``
- 'M264'
- H264 MVC video elementary stream.
* .. _V4L2-PIX-FMT-H263:
- ``V4L2_PIX_FMT_JPEG`` - ``V4L2_PIX_FMT_H263``
- 'H263'
- H263 video elementary stream.
* .. _V4L2-PIX-FMT-MPEG1:
- 'JPEG' - ``V4L2_PIX_FMT_MPEG1``
- 'MPG1'
- MPEG1 video elementary stream.
* .. _V4L2-PIX-FMT-MPEG2:
- TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`, - ``V4L2_PIX_FMT_MPEG2``
:ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`. - 'MPG2'
- MPEG2 video elementary stream.
* .. _V4L2-PIX-FMT-MPEG4:
- .. _V4L2-PIX-FMT-MPEG: - ``V4L2_PIX_FMT_MPEG4``
- 'MPG4'
- MPEG4 video elementary stream.
* .. _V4L2-PIX-FMT-XVID:
- ``V4L2_PIX_FMT_MPEG`` - ``V4L2_PIX_FMT_XVID``
- 'XVID'
- Xvid video elementary stream.
* .. _V4L2-PIX-FMT-VC1-ANNEX-G:
- 'MPEG' - ``V4L2_PIX_FMT_VC1_ANNEX_G``
- 'VC1G'
- VC1, SMPTE 421M Annex G compliant stream.
* .. _V4L2-PIX-FMT-VC1-ANNEX-L:
- MPEG multiplexed stream. The actual format is determined by - ``V4L2_PIX_FMT_VC1_ANNEX_L``
extended control ``V4L2_CID_MPEG_STREAM_TYPE``, see - 'VC1L'
:ref:`mpeg-control-id`. - VC1, SMPTE 421M Annex L compliant stream.
* .. _V4L2-PIX-FMT-VP8:
- .. _V4L2-PIX-FMT-H264: - ``V4L2_PIX_FMT_VP8``
- 'VP80'
- ``V4L2_PIX_FMT_H264`` - VP8 video elementary stream.
- 'H264'
- H264 video elementary stream with start codes.
- .. _V4L2-PIX-FMT-H264-NO-SC:
- ``V4L2_PIX_FMT_H264_NO_SC``
- 'AVC1'
- H264 video elementary stream without start codes.
- .. _V4L2-PIX-FMT-H264-MVC:
- ``V4L2_PIX_FMT_H264_MVC``
- 'M264'
- H264 MVC video elementary stream.
- .. _V4L2-PIX-FMT-H263:
- ``V4L2_PIX_FMT_H263``
- 'H263'
- H263 video elementary stream.
- .. _V4L2-PIX-FMT-MPEG1:
- ``V4L2_PIX_FMT_MPEG1``
- 'MPG1'
- MPEG1 video elementary stream.
- .. _V4L2-PIX-FMT-MPEG2:
- ``V4L2_PIX_FMT_MPEG2``
- 'MPG2'
- MPEG2 video elementary stream.
- .. _V4L2-PIX-FMT-MPEG4:
- ``V4L2_PIX_FMT_MPEG4``
- 'MPG4'
- MPEG4 video elementary stream.
- .. _V4L2-PIX-FMT-XVID:
- ``V4L2_PIX_FMT_XVID``
- 'XVID'
- Xvid video elementary stream.
- .. _V4L2-PIX-FMT-VC1-ANNEX-G:
- ``V4L2_PIX_FMT_VC1_ANNEX_G``
- 'VC1G'
- VC1, SMPTE 421M Annex G compliant stream.
- .. _V4L2-PIX-FMT-VC1-ANNEX-L:
- ``V4L2_PIX_FMT_VC1_ANNEX_L``
- 'VC1L'
- VC1, SMPTE 421M Annex L compliant stream.
- .. _V4L2-PIX-FMT-VP8:
- ``V4L2_PIX_FMT_VP8``
- 'VP80'
- VP8 video elementary stream.

68
Documentation/media/uapi/v4l/pixfmt-grey.rst
View File

@ -22,51 +22,23 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start + 4: * - start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
- Y'\ :sub:`12`
- Y'\ :sub:`13`
- .. row 3
- start + 8:
- Y'\ :sub:`20`
- Y'\ :sub:`21`
- Y'\ :sub:`22`
- Y'\ :sub:`23`
- .. row 4
- start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`

80
Documentation/media/uapi/v4l/pixfmt-indexed.rst
View File

@ -17,57 +17,31 @@ the palette, this must be done with ioctls of the Linux framebuffer API.
:header-rows: 2 :header-rows: 2
:stub-columns: 0 :stub-columns: 0
* - Identifier
- Code
-
- :cspan:`7` Byte 0
* -
-
- Bit
- 7
- 6
- 5
- 4
- 3
- 2
- 1
- 0
* .. _V4L2-PIX-FMT-PAL8:
- .. row 1 - ``V4L2_PIX_FMT_PAL8``
- 'PAL8'
- Identifier -
- i\ :sub:`7`
- Code - i\ :sub:`6`
- i\ :sub:`5`
- - i\ :sub:`4`
- :cspan:`7` Byte 0 - i\ :sub:`3`
- i\ :sub:`2`
- .. row 2 - i\ :sub:`1`
- i\ :sub:`0`
-
-
- Bit
- 7
- 6
- 5
- 4
- 3
- 2
- 1
- 0
- .. _V4L2-PIX-FMT-PAL8:
- ``V4L2_PIX_FMT_PAL8``
- 'PAL8'
-
- i\ :sub:`7`
- i\ :sub:`6`
- i\ :sub:`5`
- i\ :sub:`4`
- i\ :sub:`3`
- i\ :sub:`2`
- i\ :sub:`1`
- i\ :sub:`0`

249
Documentation/media/uapi/v4l/pixfmt-m420.rst
View File

@ -34,78 +34,36 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start + 8:
- Y'\ :sub:`03` - Cb\ :sub:`00`
- Cr\ :sub:`00`
- .. row 2 - Cb\ :sub:`01`
- Cr\ :sub:`01`
- start + 4: * - start + 16:
- Y'\ :sub:`20`
- Y'\ :sub:`10` - Y'\ :sub:`21`
- Y'\ :sub:`22`
- Y'\ :sub:`11` - Y'\ :sub:`23`
* - start + 20:
- Y'\ :sub:`12` - Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`13` - Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 3 * - start + 24:
- Cb\ :sub:`10`
- start + 8: - Cr\ :sub:`10`
- Cb\ :sub:`11`
- Cb\ :sub:`00` - Cr\ :sub:`11`
- Cr\ :sub:`00`
- Cb\ :sub:`01`
- Cr\ :sub:`01`
- .. row 4
- start + 16:
- Y'\ :sub:`20`
- Y'\ :sub:`21`
- Y'\ :sub:`22`
- Y'\ :sub:`23`
- .. row 5
- start + 20:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 6
- start + 24:
- Cb\ :sub:`10`
- Cr\ :sub:`10`
- Cb\ :sub:`11`
- Cr\ :sub:`11`
**Color Sample Location..** **Color Sample Location..**
@ -116,100 +74,53 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 -
- Y
- - Y
- 3 -
- Y
- .. row 2 * -
-
- 0 - C
-
- Y -
- C
- -
- Y * - 1
- Y
- Y -
- Y
- - Y
- Y -
- Y
- .. row 3 * -
* - 2
- - Y
- -
- C - Y
- Y
- -
- - Y
- C * -
-
- - C
-
- .. row 4 -
- C
- 1 -
* - 3
- Y - Y
-
- - Y
- Y - Y
-
- Y - Y
-
- Y
- .. row 5
-
- .. row 6
- 2
- Y
-
- Y
- Y
-
- Y
- .. row 7
-
-
- C
-
-
- C
-
- .. row 8
- 3
- Y
-
- Y
- Y
-
- Y

248
Documentation/media/uapi/v4l/pixfmt-nv12.rst
View File

@ -39,77 +39,36 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start + 0:
- Y'\ :sub:`00`
- start + 0: - Y'\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Y'\ :sub:`03`
* - start + 4:
- Y'\ :sub:`01` - Y'\ :sub:`10`
- Y'\ :sub:`11`
- Y'\ :sub:`02` - Y'\ :sub:`12`
- Y'\ :sub:`13`
- Y'\ :sub:`03` * - start + 8:
- Y'\ :sub:`20`
- .. row 2 - Y'\ :sub:`21`
- Y'\ :sub:`22`
- start + 4: - Y'\ :sub:`23`
* - start + 12:
- Y'\ :sub:`10` - Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`11` - Y'\ :sub:`32`
- Y'\ :sub:`33`
- Y'\ :sub:`12` * - start + 16:
- Cb\ :sub:`00`
- Y'\ :sub:`13` - Cr\ :sub:`00`
- Cb\ :sub:`01`
- .. row 3 - Cr\ :sub:`01`
* - start + 20:
- start + 8: - Cb\ :sub:`10`
- Cr\ :sub:`10`
- Y'\ :sub:`20` - Cb\ :sub:`11`
- Cr\ :sub:`11`
- Y'\ :sub:`21`
- Y'\ :sub:`22`
- Y'\ :sub:`23`
- .. row 4
- start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
- start + 16:
- Cb\ :sub:`00`
- Cr\ :sub:`00`
- Cb\ :sub:`01`
- Cr\ :sub:`01`
- .. row 6
- start + 20:
- Cb\ :sub:`10`
- Cr\ :sub:`10`
- Cb\ :sub:`11`
- Cr\ :sub:`11`
**Color Sample Location..** **Color Sample Location..**
@ -118,100 +77,53 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 -
- Y
- - Y
- 3 -
- Y
- .. row 2 * -
-
- 0 - C
-
- Y -
- C
- -
- Y * - 1
- Y
- Y -
- Y
- - Y
- Y -
- Y
- .. row 3 * -
* - 2
- - Y
- -
- C - Y
- Y
- -
- - Y
- C * -
-
- - C
-
- .. row 4 -
- C
- 1 -
* - 3
- Y - Y
- -
- Y
- Y - Y
-
- Y - Y
-
- Y
- .. row 5
-
- .. row 6
- 2
- Y
-
- Y
- Y
-
- Y
- .. row 7
-
-
- C
-
-
- C
-
- .. row 8
- 3
- Y
-
- Y
- Y
-
- Y

255
Documentation/media/uapi/v4l/pixfmt-nv12m.rst
View File

@ -50,81 +50,37 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start0 + 0:
- Y'\ :sub:`00`
- start0 + 0: - Y'\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Y'\ :sub:`03`
* - start0 + 4:
- Y'\ :sub:`01` - Y'\ :sub:`10`
- Y'\ :sub:`11`
- Y'\ :sub:`02` - Y'\ :sub:`12`
- Y'\ :sub:`13`
- Y'\ :sub:`03` * - start0 + 8:
- Y'\ :sub:`20`
- .. row 2 - Y'\ :sub:`21`
- Y'\ :sub:`22`
- start0 + 4: - Y'\ :sub:`23`
* - start0 + 12:
- Y'\ :sub:`10` - Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`11` - Y'\ :sub:`32`
- Y'\ :sub:`33`
- Y'\ :sub:`12` * -
* - start1 + 0:
- Y'\ :sub:`13` - Cb\ :sub:`00`
- Cr\ :sub:`00`
- .. row 3 - Cb\ :sub:`01`
- Cr\ :sub:`01`
- start0 + 8: * - start1 + 4:
- Cb\ :sub:`10`
- Y'\ :sub:`20` - Cr\ :sub:`10`
- Cb\ :sub:`11`
- Y'\ :sub:`21` - Cr\ :sub:`11`
- Y'\ :sub:`22`
- Y'\ :sub:`23`
- .. row 4
- start0 + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
-
- .. row 6
- start1 + 0:
- Cb\ :sub:`00`
- Cr\ :sub:`00`
- Cb\ :sub:`01`
- Cr\ :sub:`01`
- .. row 7
- start1 + 4:
- Cb\ :sub:`10`
- Cr\ :sub:`10`
- Cb\ :sub:`11`
- Cr\ :sub:`11`
**Color Sample Location..** **Color Sample Location..**
@ -135,101 +91,54 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 -
- Y
- - Y
- 3 -
- Y
- .. row 2 * -
-
- 0 - C
-
- Y -
- C
- -
- Y * - 1
- Y
- Y -
- Y
- - Y
- Y -
- Y
- .. row 3 * -
* - 2
- - Y
- -
- C - Y
- Y
- -
- - Y
- C * -
-
- - C
-
- .. row 4 -
-
- 1 - C
-
- Y * - 3
- Y
- -
- Y - Y
- Y
- Y -
- Y
-
- Y
- .. row 5
-
- .. row 6
- 2
- Y
-
- Y
- Y
-
- Y
- .. row 7
-
-
- C
-
-
-
- C
-
- .. row 8
- 3
- Y
-
- Y
- Y
-
- Y

320
Documentation/media/uapi/v4l/pixfmt-nv16.rst
View File

@ -37,101 +37,46 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start + 0:
- Y'\ :sub:`00`
- start + 0: - Y'\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Y'\ :sub:`03`
* - start + 4:
- Y'\ :sub:`01` - Y'\ :sub:`10`
- Y'\ :sub:`11`
- Y'\ :sub:`02` - Y'\ :sub:`12`
- Y'\ :sub:`13`
- Y'\ :sub:`03` * - start + 8:
- Y'\ :sub:`20`
- .. row 2 - Y'\ :sub:`21`
- Y'\ :sub:`22`
- start + 4: - Y'\ :sub:`23`
* - start + 12:
- Y'\ :sub:`10` - Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`11` - Y'\ :sub:`32`
- Y'\ :sub:`33`
- Y'\ :sub:`12` * - start + 16:
- Cb\ :sub:`00`
- Y'\ :sub:`13` - Cr\ :sub:`00`
- Cb\ :sub:`01`
- .. row 3 - Cr\ :sub:`01`
* - start + 20:
- start + 8: - Cb\ :sub:`10`
- Cr\ :sub:`10`
- Y'\ :sub:`20` - Cb\ :sub:`11`
- Cr\ :sub:`11`
- Y'\ :sub:`21` * - start + 24:
- Cb\ :sub:`20`
- Y'\ :sub:`22` - Cr\ :sub:`20`
- Cb\ :sub:`21`
- Y'\ :sub:`23` - Cr\ :sub:`21`
* - start + 28:
- .. row 4 - Cb\ :sub:`30`
- Cr\ :sub:`30`
- start + 12: - Cb\ :sub:`31`
- Cr\ :sub:`31`
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
- start + 16:
- Cb\ :sub:`00`
- Cr\ :sub:`00`
- Cb\ :sub:`01`
- Cr\ :sub:`01`
- .. row 6
- start + 20:
- Cb\ :sub:`10`
- Cr\ :sub:`10`
- Cb\ :sub:`11`
- Cr\ :sub:`11`
- .. row 7
- start + 24:
- Cb\ :sub:`20`
- Cr\ :sub:`20`
- Cb\ :sub:`21`
- Cr\ :sub:`21`
- .. row 8
- start + 28:
- Cb\ :sub:`30`
- Cr\ :sub:`30`
- Cb\ :sub:`31`
- Cr\ :sub:`31`
**Color Sample Location..** **Color Sample Location..**
@ -142,124 +87,67 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 -
- Y
- - Y
- 3 -
- Y
- .. row 2 * -
-
- 0 - C
-
- Y -
- C
- -
- Y * - 1
- Y
- Y -
- Y
- - Y
- Y -
- Y
- .. row 3 * -
-
- - C
- -
- C -
- C
- -
- * -
- C * - 2
- Y
- -
- Y
- .. row 4 - Y
-
- 1 - Y
* -
- Y -
- C
- -
- Y -
- C
- Y -
* - 3
- - Y
- Y -
- Y
- .. row 5 - Y
-
- - Y
- * -
- C -
- C
- -
- -
- C - C
-
-
- .. row 6
-
- .. row 7
- 2
- Y
-
- Y
- Y
-
- Y
- .. row 8
-
-
- C
-
-
- C
-
- .. row 9
- 3
- Y
-
- Y
- Y
-
- Y
- .. row 10
-
-
- C
-
-
- C
-

325
Documentation/media/uapi/v4l/pixfmt-nv16m.rst
View File

@ -40,105 +40,47 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start0 + 0:
- Y'\ :sub:`00`
- start0 + 0: - Y'\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Y'\ :sub:`03`
* - start0 + 4:
- Y'\ :sub:`01` - Y'\ :sub:`10`
- Y'\ :sub:`11`
- Y'\ :sub:`02` - Y'\ :sub:`12`
- Y'\ :sub:`13`
- Y'\ :sub:`03` * - start0 + 8:
- Y'\ :sub:`20`
- .. row 2 - Y'\ :sub:`21`
- Y'\ :sub:`22`
- start0 + 4: - Y'\ :sub:`23`
* - start0 + 12:
- Y'\ :sub:`10` - Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`11` - Y'\ :sub:`32`
- Y'\ :sub:`33`
- Y'\ :sub:`12` * -
* - start1 + 0:
- Y'\ :sub:`13` - Cb\ :sub:`00`
- Cr\ :sub:`00`
- .. row 3 - Cb\ :sub:`02`
- Cr\ :sub:`02`
- start0 + 8: * - start1 + 4:
- Cb\ :sub:`10`
- Y'\ :sub:`20` - Cr\ :sub:`10`
- Cb\ :sub:`12`
- Y'\ :sub:`21` - Cr\ :sub:`12`
* - start1 + 8:
- Y'\ :sub:`22` - Cb\ :sub:`20`
- Cr\ :sub:`20`
- Y'\ :sub:`23` - Cb\ :sub:`22`
- Cr\ :sub:`22`
- .. row 4 * - start1 + 12:
- Cb\ :sub:`30`
- start0 + 12: - Cr\ :sub:`30`
- Cb\ :sub:`32`
- Y'\ :sub:`30` - Cr\ :sub:`32`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
-
- .. row 6
- start1 + 0:
- Cb\ :sub:`00`
- Cr\ :sub:`00`
- Cb\ :sub:`02`
- Cr\ :sub:`02`
- .. row 7
- start1 + 4:
- Cb\ :sub:`10`
- Cr\ :sub:`10`
- Cb\ :sub:`12`
- Cr\ :sub:`12`
- .. row 8
- start1 + 8:
- Cb\ :sub:`20`
- Cr\ :sub:`20`
- Cb\ :sub:`22`
- Cr\ :sub:`22`
- .. row 9
- start1 + 12:
- Cb\ :sub:`30`
- Cr\ :sub:`30`
- Cb\ :sub:`32`
- Cr\ :sub:`32`
**Color Sample Location..** **Color Sample Location..**
@ -149,124 +91,67 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 -
- Y
- - Y
- 3 -
- Y
- .. row 2 * -
-
- 0 - C
-
- Y -
- C
- -
- Y * - 1
- Y
- Y -
- Y
- - Y
- Y -
- Y
- .. row 3 * -
-
- - C
- -
- C -
- C
- -
- * -
- C * - 2
- Y
- -
- Y
- .. row 4 - Y
-
- 1 - Y
* -
- Y -
- C
- -
- Y -
- C
- Y -
* - 3
- - Y
- Y -
- Y
- .. row 5 - Y
-
- - Y
- * -
- C -
- C
- -
- -
- C - C
-
-
- .. row 6
-
- .. row 7
- 2
- Y
-
- Y
- Y
-
- Y
- .. row 8
-
-
- C
-
-
- C
-
- .. row 9
- 3
- Y
-
- Y
- Y
-
- Y
- .. row 10
-
-
- C
-
-
- C
-

183
Documentation/media/uapi/v4l/pixfmt-nv24.rst
View File

@ -37,130 +37,59 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start + 0:
- Y'\ :sub:`00`
- start + 0: - Y'\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Y'\ :sub:`03`
* - start + 4:
- Y'\ :sub:`01` - Y'\ :sub:`10`
- Y'\ :sub:`11`
- Y'\ :sub:`02` - Y'\ :sub:`12`
- Y'\ :sub:`13`
- Y'\ :sub:`03` * - start + 8:
- Y'\ :sub:`20`
- .. row 2 - Y'\ :sub:`21`
- Y'\ :sub:`22`
- start + 4: - Y'\ :sub:`23`
* - start + 12:
- Y'\ :sub:`10` - Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`11` - Y'\ :sub:`32`
- Y'\ :sub:`33`
- Y'\ :sub:`12` * - start + 16:
- Cb\ :sub:`00`
- Y'\ :sub:`13` - Cr\ :sub:`00`
- Cb\ :sub:`01`
- .. row 3 - Cr\ :sub:`01`
- Cb\ :sub:`02`
- start + 8: - Cr\ :sub:`02`
- Cb\ :sub:`03`
- Y'\ :sub:`20` - Cr\ :sub:`03`
* - start + 24:
- Y'\ :sub:`21` - Cb\ :sub:`10`
- Cr\ :sub:`10`
- Y'\ :sub:`22` - Cb\ :sub:`11`
- Cr\ :sub:`11`
- Y'\ :sub:`23` - Cb\ :sub:`12`
- Cr\ :sub:`12`
- .. row 4 - Cb\ :sub:`13`
- Cr\ :sub:`13`
- start + 12: * - start + 32:
- Cb\ :sub:`20`
- Y'\ :sub:`30` - Cr\ :sub:`20`
- Cb\ :sub:`21`
- Y'\ :sub:`31` - Cr\ :sub:`21`
- Cb\ :sub:`22`
- Y'\ :sub:`32` - Cr\ :sub:`22`
- Cb\ :sub:`23`
- Y'\ :sub:`33` - Cr\ :sub:`23`
* - start + 40:
- .. row 5 - Cb\ :sub:`30`
- Cr\ :sub:`30`
- start + 16: - Cb\ :sub:`31`
- Cr\ :sub:`31`
- Cb\ :sub:`00` - Cb\ :sub:`32`
- Cr\ :sub:`32`
- Cr\ :sub:`00` - Cb\ :sub:`33`
- Cr\ :sub:`33`
- Cb\ :sub:`01`
- Cr\ :sub:`01`
- Cb\ :sub:`02`
- Cr\ :sub:`02`
- Cb\ :sub:`03`
- Cr\ :sub:`03`
- .. row 6
- start + 24:
- Cb\ :sub:`10`
- Cr\ :sub:`10`
- Cb\ :sub:`11`
- Cr\ :sub:`11`
- Cb\ :sub:`12`
- Cr\ :sub:`12`
- Cb\ :sub:`13`
- Cr\ :sub:`13`
- .. row 7
- start + 32:
- Cb\ :sub:`20`
- Cr\ :sub:`20`
- Cb\ :sub:`21`
- Cr\ :sub:`21`
- Cb\ :sub:`22`
- Cr\ :sub:`22`
- Cb\ :sub:`23`
- Cr\ :sub:`23`
- .. row 8
- start + 40:
- Cb\ :sub:`30`
- Cr\ :sub:`30`
- Cb\ :sub:`31`
- Cr\ :sub:`31`
- Cb\ :sub:`32`
- Cr\ :sub:`32`
- Cb\ :sub:`33`
- Cr\ :sub:`33`

2134
Documentation/media/uapi/v4l/pixfmt-packed-rgb.rst
View File

File diff suppressed because it is too large Load Diff

439
Documentation/media/uapi/v4l/pixfmt-packed-yuv.rst
View File

@ -24,291 +24,160 @@ component of each pixel in one 16 or 32 bit word.
:header-rows: 2 :header-rows: 2
:stub-columns: 0 :stub-columns: 0
* - Identifier
- .. row 1 - Code
-
- Identifier - :cspan:`7` Byte 0 in memory
-
- Code - :cspan:`7` Byte 1
-
- - :cspan:`7` Byte 2
- :cspan:`7` Byte 0 in memory -
- :cspan:`7` Byte 3
- * -
- :cspan:`7` Byte 1 -
- Bit
- - 7
- :cspan:`7` Byte 2 - 6
- 5
- - 4
- :cspan:`7` Byte 3 - 3
- 2
- .. row 2 - 1
- 0
- -
- - 7
- Bit - 6
- 5
- 7 - 4
- 3
- 6 - 2
- 1
- 5 - 0
-
- 4 - 7
- 6
- 3 - 5
- 4
- 2 - 3
- 2
- 1 - 1
- 0
- 0 -
- 7
- - 6
- 7 - 5
- 4
- 6 - 3
- 2
- 5 - 1
- 0
- 4 * .. _V4L2-PIX-FMT-YUV444:
- 3 - ``V4L2_PIX_FMT_YUV444``
- 'Y444'
- 2 -
- Cb\ :sub:`3`
- 1 - Cb\ :sub:`2`
- Cb\ :sub:`1`
- 0 - Cb\ :sub:`0`
- Cr\ :sub:`3`
- - Cr\ :sub:`2`
- 7 - Cr\ :sub:`1`
- Cr\ :sub:`0`
- 6 -
- a\ :sub:`3`
- 5 - a\ :sub:`2`
- a\ :sub:`1`
- 4 - a\ :sub:`0`
- Y'\ :sub:`3`
- 3 - Y'\ :sub:`2`
- Y'\ :sub:`1`
- 2 - Y'\ :sub:`0`
* .. _V4L2-PIX-FMT-YUV555:
- 1
- ``V4L2_PIX_FMT_YUV555``
- 0 - 'YUVO'
-
- - Cb\ :sub:`2`
- 7 - Cb\ :sub:`1`
- Cb\ :sub:`0`
- 6 - Cr\ :sub:`4`
- Cr\ :sub:`3`
- 5 - Cr\ :sub:`2`
- Cr\ :sub:`1`
- 4 - Cr\ :sub:`0`
-
- 3 - a
- Y'\ :sub:`4`
- 2 - Y'\ :sub:`3`
- Y'\ :sub:`2`
- 1 - Y'\ :sub:`1`
- Y'\ :sub:`0`
- 0 - Cb\ :sub:`4`
- Cb\ :sub:`3`
- .. _V4L2-PIX-FMT-YUV444: * .. _V4L2-PIX-FMT-YUV565:
- ``V4L2_PIX_FMT_YUV444`` - ``V4L2_PIX_FMT_YUV565``
- 'YUVP'
- 'Y444' -
- Cb\ :sub:`2`
- - Cb\ :sub:`1`
- Cb\ :sub:`3` - Cb\ :sub:`0`
- Cr\ :sub:`4`
- Cb\ :sub:`2` - Cr\ :sub:`3`
- Cr\ :sub:`2`
- Cb\ :sub:`1` - Cr\ :sub:`1`
- Cr\ :sub:`0`
- Cb\ :sub:`0` -
- Y'\ :sub:`4`
- Cr\ :sub:`3` - Y'\ :sub:`3`
- Y'\ :sub:`2`
- Cr\ :sub:`2` - Y'\ :sub:`1`
- Y'\ :sub:`0`
- Cr\ :sub:`1` - Cb\ :sub:`5`
- Cb\ :sub:`4`
- Cr\ :sub:`0` - Cb\ :sub:`3`
* .. _V4L2-PIX-FMT-YUV32:
-
- a\ :sub:`3` - ``V4L2_PIX_FMT_YUV32``
- 'YUV4'
- a\ :sub:`2` -
- a\ :sub:`7`
- a\ :sub:`1` - a\ :sub:`6`
- a\ :sub:`5`
- a\ :sub:`0` - a\ :sub:`4`
- a\ :sub:`3`
- Y'\ :sub:`3` - a\ :sub:`2`
- a\ :sub:`1`
- Y'\ :sub:`2` - a\ :sub:`0`
-
- Y'\ :sub:`1` - Y'\ :sub:`7`
- Y'\ :sub:`6`
- Y'\ :sub:`0` - Y'\ :sub:`5`
- Y'\ :sub:`4`
- .. _V4L2-PIX-FMT-YUV555: - Y'\ :sub:`3`
- Y'\ :sub:`2`
- ``V4L2_PIX_FMT_YUV555`` - Y'\ :sub:`1`
- Y'\ :sub:`0`
- 'YUVO' -
- Cb\ :sub:`7`
- - Cb\ :sub:`6`
- Cb\ :sub:`2` - Cb\ :sub:`5`
- Cb\ :sub:`4`
- Cb\ :sub:`1` - Cb\ :sub:`3`
- Cb\ :sub:`2`
- Cb\ :sub:`0` - Cb\ :sub:`1`
- Cb\ :sub:`0`
- Cr\ :sub:`4` -
- Cr\ :sub:`7`
- Cr\ :sub:`3` - Cr\ :sub:`6`
- Cr\ :sub:`5`
- Cr\ :sub:`2` - Cr\ :sub:`4`
- Cr\ :sub:`3`
- Cr\ :sub:`1` - Cr\ :sub:`2`
- Cr\ :sub:`1`
- Cr\ :sub:`0` - Cr\ :sub:`0`
-
- a
- Y'\ :sub:`4`
- Y'\ :sub:`3`
- Y'\ :sub:`2`
- Y'\ :sub:`1`
- Y'\ :sub:`0`
- Cb\ :sub:`4`
- Cb\ :sub:`3`
- .. _V4L2-PIX-FMT-YUV565:
- ``V4L2_PIX_FMT_YUV565``
- 'YUVP'
-
- Cb\ :sub:`2`
- Cb\ :sub:`1`
- Cb\ :sub:`0`
- Cr\ :sub:`4`
- Cr\ :sub:`3`
- Cr\ :sub:`2`
- Cr\ :sub:`1`
- Cr\ :sub:`0`
-
- Y'\ :sub:`4`
- Y'\ :sub:`3`
- Y'\ :sub:`2`
- Y'\ :sub:`1`
- Y'\ :sub:`0`
- Cb\ :sub:`5`
- Cb\ :sub:`4`
- Cb\ :sub:`3`
- .. _V4L2-PIX-FMT-YUV32:
- ``V4L2_PIX_FMT_YUV32``
- 'YUV4'
-
- a\ :sub:`7`
- a\ :sub:`6`
- a\ :sub:`5`
- a\ :sub:`4`
- a\ :sub:`3`
- a\ :sub:`2`
- a\ :sub:`1`
- a\ :sub:`0`
-
- Y'\ :sub:`7`
- Y'\ :sub:`6`
- Y'\ :sub:`5`
- Y'\ :sub:`4`
- Y'\ :sub:`3`
- Y'\ :sub:`2`
- Y'\ :sub:`1`
- Y'\ :sub:`0`
-
- Cb\ :sub:`7`
- Cb\ :sub:`6`
- Cb\ :sub:`5`
- Cb\ :sub:`4`
- Cb\ :sub:`3`
- Cb\ :sub:`2`
- Cb\ :sub:`1`
- Cb\ :sub:`0`
-
- Cr\ :sub:`7`
- Cr\ :sub:`6`
- Cr\ :sub:`5`
- Cr\ :sub:`4`
- Cr\ :sub:`3`
- Cr\ :sub:`2`
- Cr\ :sub:`1`
- Cr\ :sub:`0`
.. raw:: latex .. raw:: latex

539
Documentation/media/uapi/v4l/pixfmt-reserved.rst
View File

@ -26,318 +26,214 @@ please make a proposal on the linux-media mailing list.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - Identifier
- .. row 1 - Code
- Details
- Identifier * .. _V4L2-PIX-FMT-DV:
- Code - ``V4L2_PIX_FMT_DV``
- 'dvsd'
- Details - unknown
* .. _V4L2-PIX-FMT-ET61X251:
- .. _V4L2-PIX-FMT-DV:
- ``V4L2_PIX_FMT_ET61X251``
- ``V4L2_PIX_FMT_DV`` - 'E625'
- Compressed format of the ET61X251 driver.
- 'dvsd' * .. _V4L2-PIX-FMT-HI240:
- unknown - ``V4L2_PIX_FMT_HI240``
- 'HI24'
- .. _V4L2-PIX-FMT-ET61X251: - 8 bit RGB format used by the BTTV driver.
* .. _V4L2-PIX-FMT-HM12:
- ``V4L2_PIX_FMT_ET61X251``
- ``V4L2_PIX_FMT_HM12``
- 'E625' - 'HM12'
- YUV 4:2:0 format used by the IVTV driver,
- Compressed format of the ET61X251 driver. `http://www.ivtvdriver.org/ <http://www.ivtvdriver.org/>`__
- .. _V4L2-PIX-FMT-HI240: The format is documented in the kernel sources in the file
``Documentation/video4linux/cx2341x/README.hm12``
- ``V4L2_PIX_FMT_HI240`` * .. _V4L2-PIX-FMT-CPIA1:
- 'HI24' - ``V4L2_PIX_FMT_CPIA1``
- 'CPIA'
- 8 bit RGB format used by the BTTV driver. - YUV format used by the gspca cpia1 driver.
* .. _V4L2-PIX-FMT-JPGL:
- .. _V4L2-PIX-FMT-HM12:
- ``V4L2_PIX_FMT_JPGL``
- ``V4L2_PIX_FMT_HM12`` - 'JPGL'
- JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
- 'HM12' 80x.
* .. _V4L2-PIX-FMT-SPCA501:
- YUV 4:2:0 format used by the IVTV driver,
`http://www.ivtvdriver.org/ <http://www.ivtvdriver.org/>`__ - ``V4L2_PIX_FMT_SPCA501``
- 'S501'
The format is documented in the kernel sources in the file - YUYV per line used by the gspca driver.
``Documentation/video4linux/cx2341x/README.hm12`` * .. _V4L2-PIX-FMT-SPCA505:
- .. _V4L2-PIX-FMT-CPIA1: - ``V4L2_PIX_FMT_SPCA505``
- 'S505'
- ``V4L2_PIX_FMT_CPIA1`` - YYUV per line used by the gspca driver.
* .. _V4L2-PIX-FMT-SPCA508:
- 'CPIA'
- ``V4L2_PIX_FMT_SPCA508``
- YUV format used by the gspca cpia1 driver. - 'S508'
- YUVY per line used by the gspca driver.
- .. _V4L2-PIX-FMT-JPGL: * .. _V4L2-PIX-FMT-SPCA561:
- ``V4L2_PIX_FMT_JPGL`` - ``V4L2_PIX_FMT_SPCA561``
- 'S561'
- 'JPGL' - Compressed GBRG Bayer format used by the gspca driver.
* .. _V4L2-PIX-FMT-PAC207:
- JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
80x. - ``V4L2_PIX_FMT_PAC207``
- 'P207'
- .. _V4L2-PIX-FMT-SPCA501: - Compressed BGGR Bayer format used by the gspca driver.
* .. _V4L2-PIX-FMT-MR97310A:
- ``V4L2_PIX_FMT_SPCA501``
- ``V4L2_PIX_FMT_MR97310A``
- 'S501' - 'M310'
- Compressed BGGR Bayer format used by the gspca driver.
- YUYV per line used by the gspca driver. * .. _V4L2-PIX-FMT-JL2005BCD:
- .. _V4L2-PIX-FMT-SPCA505: - ``V4L2_PIX_FMT_JL2005BCD``
- 'JL20'
- ``V4L2_PIX_FMT_SPCA505`` - JPEG compressed RGGB Bayer format used by the gspca driver.
* .. _V4L2-PIX-FMT-OV511:
- 'S505'
- ``V4L2_PIX_FMT_OV511``
- YYUV per line used by the gspca driver. - 'O511'
- OV511 JPEG format used by the gspca driver.
- .. _V4L2-PIX-FMT-SPCA508: * .. _V4L2-PIX-FMT-OV518:
- ``V4L2_PIX_FMT_SPCA508`` - ``V4L2_PIX_FMT_OV518``
- 'O518'
- 'S508' - OV518 JPEG format used by the gspca driver.
* .. _V4L2-PIX-FMT-PJPG:
- YUVY per line used by the gspca driver.
- ``V4L2_PIX_FMT_PJPG``
- .. _V4L2-PIX-FMT-SPCA561: - 'PJPG'
- Pixart 73xx JPEG format used by the gspca driver.
- ``V4L2_PIX_FMT_SPCA561`` * .. _V4L2-PIX-FMT-SE401:
- 'S561' - ``V4L2_PIX_FMT_SE401``
- 'S401'
- Compressed GBRG Bayer format used by the gspca driver. - Compressed RGB format used by the gspca se401 driver
* .. _V4L2-PIX-FMT-SQ905C:
- .. _V4L2-PIX-FMT-PAC207:
- ``V4L2_PIX_FMT_SQ905C``
- ``V4L2_PIX_FMT_PAC207`` - '905C'
- Compressed RGGB bayer format used by the gspca driver.
- 'P207' * .. _V4L2-PIX-FMT-MJPEG:
- Compressed BGGR Bayer format used by the gspca driver. - ``V4L2_PIX_FMT_MJPEG``
- 'MJPG'
- .. _V4L2-PIX-FMT-MR97310A: - Compressed format used by the Zoran driver
* .. _V4L2-PIX-FMT-PWC1:
- ``V4L2_PIX_FMT_MR97310A``
- ``V4L2_PIX_FMT_PWC1``
- 'M310' - 'PWC1'
- Compressed format of the PWC driver.
- Compressed BGGR Bayer format used by the gspca driver. * .. _V4L2-PIX-FMT-PWC2:
- .. _V4L2-PIX-FMT-JL2005BCD: - ``V4L2_PIX_FMT_PWC2``
- 'PWC2'
- ``V4L2_PIX_FMT_JL2005BCD`` - Compressed format of the PWC driver.
* .. _V4L2-PIX-FMT-SN9C10X:
- 'JL20'
- ``V4L2_PIX_FMT_SN9C10X``
- JPEG compressed RGGB Bayer format used by the gspca driver. - 'S910'
- Compressed format of the SN9C102 driver.
- .. _V4L2-PIX-FMT-OV511: * .. _V4L2-PIX-FMT-SN9C20X-I420:
- ``V4L2_PIX_FMT_OV511`` - ``V4L2_PIX_FMT_SN9C20X_I420``
- 'S920'
- 'O511' - YUV 4:2:0 format of the gspca sn9c20x driver.
* .. _V4L2-PIX-FMT-SN9C2028:
- OV511 JPEG format used by the gspca driver.
- ``V4L2_PIX_FMT_SN9C2028``
- .. _V4L2-PIX-FMT-OV518: - 'SONX'
- Compressed GBRG bayer format of the gspca sn9c2028 driver.
- ``V4L2_PIX_FMT_OV518`` * .. _V4L2-PIX-FMT-STV0680:
- 'O518' - ``V4L2_PIX_FMT_STV0680``
- 'S680'
- OV518 JPEG format used by the gspca driver. - Bayer format of the gspca stv0680 driver.
* .. _V4L2-PIX-FMT-WNVA:
- .. _V4L2-PIX-FMT-PJPG:
- ``V4L2_PIX_FMT_WNVA``
- ``V4L2_PIX_FMT_PJPG`` - 'WNVA'
- Used by the Winnov Videum driver,
- 'PJPG' `http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
* .. _V4L2-PIX-FMT-TM6000:
- Pixart 73xx JPEG format used by the gspca driver.
- ``V4L2_PIX_FMT_TM6000``
- .. _V4L2-PIX-FMT-SE401: - 'TM60'
- Used by Trident tm6000
- ``V4L2_PIX_FMT_SE401`` * .. _V4L2-PIX-FMT-CIT-YYVYUY:
- 'S401' - ``V4L2_PIX_FMT_CIT_YYVYUY``
- 'CITV'
- Compressed RGB format used by the gspca se401 driver - Used by xirlink CIT, found at IBM webcams.
- .. _V4L2-PIX-FMT-SQ905C: Uses one line of Y then 1 line of VYUY
* .. _V4L2-PIX-FMT-KONICA420:
- ``V4L2_PIX_FMT_SQ905C``
- ``V4L2_PIX_FMT_KONICA420``
- '905C' - 'KONI'
- Used by Konica webcams.
- Compressed RGGB bayer format used by the gspca driver.
YUV420 planar in blocks of 256 pixels.
- .. _V4L2-PIX-FMT-MJPEG: * .. _V4L2-PIX-FMT-YYUV:
- ``V4L2_PIX_FMT_MJPEG`` - ``V4L2_PIX_FMT_YYUV``
- 'YYUV'
- 'MJPG' - unknown
* .. _V4L2-PIX-FMT-Y4:
- Compressed format used by the Zoran driver
- ``V4L2_PIX_FMT_Y4``
- .. _V4L2-PIX-FMT-PWC1: - 'Y04 '
- Old 4-bit greyscale format. Only the most significant 4 bits of
- ``V4L2_PIX_FMT_PWC1`` each byte are used, the other bits are set to 0.
* .. _V4L2-PIX-FMT-Y6:
- 'PWC1'
- ``V4L2_PIX_FMT_Y6``
- Compressed format of the PWC driver. - 'Y06 '
- Old 6-bit greyscale format. Only the most significant 6 bits of
- .. _V4L2-PIX-FMT-PWC2: each byte are used, the other bits are set to 0.
* .. _V4L2-PIX-FMT-S5C-UYVY-JPG:
- ``V4L2_PIX_FMT_PWC2``
- ``V4L2_PIX_FMT_S5C_UYVY_JPG``
- 'PWC2' - 'S5CI'
- Two-planar format used by Samsung S5C73MX cameras. The first plane
- Compressed format of the PWC driver. contains interleaved JPEG and UYVY image data, followed by meta
data in form of an array of offsets to the UYVY data blocks. The
- .. _V4L2-PIX-FMT-SN9C10X: actual pointer array follows immediately the interleaved JPEG/UYVY
data, the number of entries in this array equals the height of the
- ``V4L2_PIX_FMT_SN9C10X`` UYVY image. Each entry is a 4-byte unsigned integer in big endian
order and it's an offset to a single pixel line of the UYVY image.
- 'S910' The first plane can start either with JPEG or UYVY data chunk. The
size of a single UYVY block equals the UYVY image's width
- Compressed format of the SN9C102 driver. multiplied by 2. The size of a JPEG chunk depends on the image and
can vary with each line.
- .. _V4L2-PIX-FMT-SN9C20X-I420:
The second plane, at an offset of 4084 bytes, contains a 4-byte
- ``V4L2_PIX_FMT_SN9C20X_I420`` offset to the pointer array in the first plane. This offset is
followed by a 4-byte value indicating size of the pointer array.
- 'S920' All numbers in the second plane are also in big endian order.
Remaining data in the second plane is undefined. The information
- YUV 4:2:0 format of the gspca sn9c20x driver. in the second plane allows to easily find location of the pointer
array, which can be different for each frame. The size of the
- .. _V4L2-PIX-FMT-SN9C2028: pointer array is constant for given UYVY image height.
- ``V4L2_PIX_FMT_SN9C2028`` In order to extract UYVY and JPEG frames an application can
initially set a data pointer to the start of first plane and then
- 'SONX' add an offset from the first entry of the pointers table. Such a
pointer indicates start of an UYVY image pixel line. Whole UYVY
- Compressed GBRG bayer format of the gspca sn9c2028 driver. line can be copied to a separate buffer. These steps should be
repeated for each line, i.e. the number of entries in the pointer
- .. _V4L2-PIX-FMT-STV0680: array. Anything what's in between the UYVY lines is JPEG data and
should be concatenated to form the JPEG stream.
- ``V4L2_PIX_FMT_STV0680``
- 'S680'
- Bayer format of the gspca stv0680 driver.
- .. _V4L2-PIX-FMT-WNVA:
- ``V4L2_PIX_FMT_WNVA``
- 'WNVA'
- Used by the Winnov Videum driver,
`http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
- .. _V4L2-PIX-FMT-TM6000:
- ``V4L2_PIX_FMT_TM6000``
- 'TM60'
- Used by Trident tm6000
- .. _V4L2-PIX-FMT-CIT-YYVYUY:
- ``V4L2_PIX_FMT_CIT_YYVYUY``
- 'CITV'
- Used by xirlink CIT, found at IBM webcams.
Uses one line of Y then 1 line of VYUY
- .. _V4L2-PIX-FMT-KONICA420:
- ``V4L2_PIX_FMT_KONICA420``
- 'KONI'
- Used by Konica webcams.
YUV420 planar in blocks of 256 pixels.
- .. _V4L2-PIX-FMT-YYUV:
- ``V4L2_PIX_FMT_YYUV``
- 'YYUV'
- unknown
- .. _V4L2-PIX-FMT-Y4:
- ``V4L2_PIX_FMT_Y4``
- 'Y04 '
- Old 4-bit greyscale format. Only the most significant 4 bits of
each byte are used, the other bits are set to 0.
- .. _V4L2-PIX-FMT-Y6:
- ``V4L2_PIX_FMT_Y6``
- 'Y06 '
- Old 6-bit greyscale format. Only the most significant 6 bits of
each byte are used, the other bits are set to 0.
- .. _V4L2-PIX-FMT-S5C-UYVY-JPG:
- ``V4L2_PIX_FMT_S5C_UYVY_JPG``
- 'S5CI'
- Two-planar format used by Samsung S5C73MX cameras. The first plane
contains interleaved JPEG and UYVY image data, followed by meta
data in form of an array of offsets to the UYVY data blocks. The
actual pointer array follows immediately the interleaved JPEG/UYVY
data, the number of entries in this array equals the height of the
UYVY image. Each entry is a 4-byte unsigned integer in big endian
order and it's an offset to a single pixel line of the UYVY image.
The first plane can start either with JPEG or UYVY data chunk. The
size of a single UYVY block equals the UYVY image's width
multiplied by 2. The size of a JPEG chunk depends on the image and
can vary with each line.
The second plane, at an offset of 4084 bytes, contains a 4-byte
offset to the pointer array in the first plane. This offset is
followed by a 4-byte value indicating size of the pointer array.
All numbers in the second plane are also in big endian order.
Remaining data in the second plane is undefined. The information
in the second plane allows to easily find location of the pointer
array, which can be different for each frame. The size of the
pointer array is constant for given UYVY image height.
In order to extract UYVY and JPEG frames an application can
initially set a data pointer to the start of first plane and then
add an offset from the first entry of the pointers table. Such a
pointer indicates start of an UYVY image pixel line. Whole UYVY
line can be copied to a separate buffer. These steps should be
repeated for each line, i.e. the number of entries in the pointer
array. Anything what's in between the UYVY lines is JPEG data and
should be concatenated to form the JPEG stream.
@ -350,15 +246,10 @@ please make a proposal on the linux-media mailing list.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA``
- .. row 1 - 0x00000001
- The color values are premultiplied by the alpha channel value. For
- ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA`` example, if a light blue pixel with 50% transparency was described
by RGBA values (128, 192, 255, 128), the same pixel described with
- 0x00000001 premultiplied colors would be described by RGBA values (64, 96,
128, 128)
- The color values are premultiplied by the alpha channel value. For
example, if a light blue pixel with 50% transparency was described
by RGBA values (128, 192, 255, 128), the same pixel described with
premultiplied colors would be described by RGBA values (64, 96,
128, 128)

115
Documentation/media/uapi/v4l/pixfmt-sbggr16.rst
View File

@ -24,82 +24,39 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start + 0:
- B\ :sub:`00low`
- start + 0: - B\ :sub:`00high`
- G\ :sub:`01low`
- B\ :sub:`00low` - G\ :sub:`01high`
- B\ :sub:`02low`
- B\ :sub:`00high` - B\ :sub:`02high`
- G\ :sub:`03low`
- G\ :sub:`01low` - G\ :sub:`03high`
* - start + 8:
- G\ :sub:`01high` - G\ :sub:`10low`
- G\ :sub:`10high`
- B\ :sub:`02low` - R\ :sub:`11low`
- R\ :sub:`11high`
- B\ :sub:`02high` - G\ :sub:`12low`
- G\ :sub:`12high`
- G\ :sub:`03low` - R\ :sub:`13low`
- R\ :sub:`13high`
- G\ :sub:`03high` * - start + 16:
- B\ :sub:`20low`
- .. row 2 - B\ :sub:`20high`
- G\ :sub:`21low`
- start + 8: - G\ :sub:`21high`
- B\ :sub:`22low`
- G\ :sub:`10low` - B\ :sub:`22high`
- G\ :sub:`23low`
- G\ :sub:`10high` - G\ :sub:`23high`
* - start + 24:
- R\ :sub:`11low` - G\ :sub:`30low`
- G\ :sub:`30high`
- R\ :sub:`11high` - R\ :sub:`31low`
- R\ :sub:`31high`
- G\ :sub:`12low` - G\ :sub:`32low`
- G\ :sub:`32high`
- G\ :sub:`12high` - R\ :sub:`33low`
- R\ :sub:`33high`
- R\ :sub:`13low`
- R\ :sub:`13high`
- .. row 3
- start + 16:
- B\ :sub:`20low`
- B\ :sub:`20high`
- G\ :sub:`21low`
- G\ :sub:`21high`
- B\ :sub:`22low`
- B\ :sub:`22high`
- G\ :sub:`23low`
- G\ :sub:`23high`
- .. row 4
- start + 24:
- G\ :sub:`30low`
- G\ :sub:`30high`
- R\ :sub:`31low`
- R\ :sub:`31high`
- G\ :sub:`32low`
- G\ :sub:`32high`
- R\ :sub:`33low`
- R\ :sub:`33high`

16
Documentation/media/uapi/v4l/pixfmt-sdr-cs08.rst
View File

@ -24,15 +24,7 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - I'\ :sub:`0`
* - start + 1:
- start + 0: - Q'\ :sub:`0`
- I'\ :sub:`0`
- .. row 2
- start + 1:
- Q'\ :sub:`0`

21
Documentation/media/uapi/v4l/pixfmt-sdr-cs14le.rst
View File

@ -26,18 +26,9 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start + 0:
- I'\ :sub:`0[7:0]`
- start + 0: - I'\ :sub:`0[13:8]`
* - start + 2:
- I'\ :sub:`0[7:0]` - Q'\ :sub:`0[7:0]`
- Q'\ :sub:`0[13:8]`
- I'\ :sub:`0[13:8]`
- .. row 2
- start + 2:
- Q'\ :sub:`0[7:0]`
- Q'\ :sub:`0[13:8]`

15
Documentation/media/uapi/v4l/pixfmt-sdr-cu08.rst
View File

@ -24,14 +24,7 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start + 0:
- I'\ :sub:`0`
- start + 0: * - start + 1:
- Q'\ :sub:`0`
- I'\ :sub:`0`
- .. row 2
- start + 1:
- Q'\ :sub:`0`

21
Documentation/media/uapi/v4l/pixfmt-sdr-cu16le.rst
View File

@ -26,18 +26,9 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - start + 0:
- I'\ :sub:`0[7:0]`
- start + 0: - I'\ :sub:`0[15:8]`
* - start + 2:
- I'\ :sub:`0[7:0]` - Q'\ :sub:`0[7:0]`
- Q'\ :sub:`0[15:8]`
- I'\ :sub:`0[15:8]`
- .. row 2
- start + 2:
- Q'\ :sub:`0[7:0]`
- Q'\ :sub:`0[15:8]`

11
Documentation/media/uapi/v4l/pixfmt-sdr-ru12le.rst
View File

@ -27,11 +27,6 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - I'\ :sub:`0[7:0]`
- I'\ :sub:`0[11:8]`
- start + 0:
- I'\ :sub:`0[7:0]`
- I'\ :sub:`0[11:8]`

116
Documentation/media/uapi/v4l/pixfmt-srggb10.rst
View File

@ -38,83 +38,39 @@ are 0.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - B\ :sub:`00low`
- B\ :sub:`00high`
- start + 0: - G\ :sub:`01low`
- G\ :sub:`01high`
- B\ :sub:`00low` - B\ :sub:`02low`
- B\ :sub:`02high`
- B\ :sub:`00high` - G\ :sub:`03low`
- G\ :sub:`03high`
- G\ :sub:`01low` * - start + 8:
- G\ :sub:`10low`
- G\ :sub:`01high` - G\ :sub:`10high`
- R\ :sub:`11low`
- B\ :sub:`02low` - R\ :sub:`11high`
- G\ :sub:`12low`
- B\ :sub:`02high` - G\ :sub:`12high`
- R\ :sub:`13low`
- G\ :sub:`03low` - R\ :sub:`13high`
* - start + 16:
- G\ :sub:`03high` - B\ :sub:`20low`
- B\ :sub:`20high`
- .. row 2 - G\ :sub:`21low`
- G\ :sub:`21high`
- start + 8: - B\ :sub:`22low`
- B\ :sub:`22high`
- G\ :sub:`10low` - G\ :sub:`23low`
- G\ :sub:`23high`
- G\ :sub:`10high` * - start + 24:
- G\ :sub:`30low`
- R\ :sub:`11low` - G\ :sub:`30high`
- R\ :sub:`31low`
- R\ :sub:`11high` - R\ :sub:`31high`
- G\ :sub:`32low`
- G\ :sub:`12low` - G\ :sub:`32high`
- R\ :sub:`33low`
- G\ :sub:`12high` - R\ :sub:`33high`
- R\ :sub:`13low`
- R\ :sub:`13high`
- .. row 3
- start + 16:
- B\ :sub:`20low`
- B\ :sub:`20high`
- G\ :sub:`21low`
- G\ :sub:`21high`
- B\ :sub:`22low`
- B\ :sub:`22high`
- G\ :sub:`23low`
- G\ :sub:`23high`
- .. row 4
- start + 24:
- G\ :sub:`30low`
- G\ :sub:`30high`
- R\ :sub:`31low`
- R\ :sub:`31high`
- G\ :sub:`32low`
- G\ :sub:`32high`
- R\ :sub:`33low`
- R\ :sub:`33high`

87
Documentation/media/uapi/v4l/pixfmt-srggb10p.rst
View File

@ -44,65 +44,34 @@ Each cell is one byte.
:stub-columns: 0 :stub-columns: 0
:widths: 12 8 8 8 8 68 :widths: 12 8 8 8 8 68
- .. row 1 * - start + 0:
- B\ :sub:`00high`
- start + 0: - G\ :sub:`01high`
- B\ :sub:`02high`
- B\ :sub:`00high` - G\ :sub:`03high`
- G\ :sub:`03low`\ (bits 7--6) B\ :sub:`02low`\ (bits 5--4)
- G\ :sub:`01high` G\ :sub:`01low`\ (bits 3--2) B\ :sub:`00low`\ (bits 1--0)
* - start + 5:
- B\ :sub:`02high` - G\ :sub:`10high`
- R\ :sub:`11high`
- G\ :sub:`03high` - G\ :sub:`12high`
- R\ :sub:`13high`
- G\ :sub:`03low`\ (bits 7--6) B\ :sub:`02low`\ (bits 5--4) - R\ :sub:`13low`\ (bits 7--6) G\ :sub:`12low`\ (bits 5--4)
G\ :sub:`01low`\ (bits 3--2) B\ :sub:`00low`\ (bits 1--0) R\ :sub:`11low`\ (bits 3--2) G\ :sub:`10low`\ (bits 1--0)
* - start + 10:
- .. row 2 - B\ :sub:`20high`
- G\ :sub:`21high`
- start + 5: - B\ :sub:`22high`
- G\ :sub:`23high`
- G\ :sub:`10high` - G\ :sub:`23low`\ (bits 7--6) B\ :sub:`22low`\ (bits 5--4)
G\ :sub:`21low`\ (bits 3--2) B\ :sub:`20low`\ (bits 1--0)
- R\ :sub:`11high` * - start + 15:
- G\ :sub:`30high`
- G\ :sub:`12high` - R\ :sub:`31high`
- G\ :sub:`32high`
- R\ :sub:`13high` - R\ :sub:`33high`
- R\ :sub:`33low`\ (bits 7--6) G\ :sub:`32low`\ (bits 5--4)
- R\ :sub:`13low`\ (bits 7--6) G\ :sub:`12low`\ (bits 5--4) R\ :sub:`31low`\ (bits 3--2) G\ :sub:`30low`\ (bits 1--0)
R\ :sub:`11low`\ (bits 3--2) G\ :sub:`10low`\ (bits 1--0)
- .. row 3
- start + 10:
- B\ :sub:`20high`
- G\ :sub:`21high`
- B\ :sub:`22high`
- G\ :sub:`23high`
- G\ :sub:`23low`\ (bits 7--6) B\ :sub:`22low`\ (bits 5--4)
G\ :sub:`21low`\ (bits 3--2) B\ :sub:`20low`\ (bits 1--0)
- .. row 4
- start + 15:
- G\ :sub:`30high`
- R\ :sub:`31high`
- G\ :sub:`32high`
- R\ :sub:`33high`
- R\ :sub:`33low`\ (bits 7--6) G\ :sub:`32low`\ (bits 5--4)
R\ :sub:`31low`\ (bits 3--2) G\ :sub:`30low`\ (bits 1--0)
.. raw:: latex .. raw:: latex

116
Documentation/media/uapi/v4l/pixfmt-srggb12.rst
View File

@ -39,83 +39,39 @@ Each cell is one byte, the 4 most significant bits in the high bytes are
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - B\ :sub:`00low`
- B\ :sub:`00high`
- start + 0: - G\ :sub:`01low`
- G\ :sub:`01high`
- B\ :sub:`00low` - B\ :sub:`02low`
- B\ :sub:`02high`
- B\ :sub:`00high` - G\ :sub:`03low`
- G\ :sub:`03high`
- G\ :sub:`01low` * - start + 8:
- G\ :sub:`10low`
- G\ :sub:`01high` - G\ :sub:`10high`
- R\ :sub:`11low`
- B\ :sub:`02low` - R\ :sub:`11high`
- G\ :sub:`12low`
- B\ :sub:`02high` - G\ :sub:`12high`
- R\ :sub:`13low`
- G\ :sub:`03low` - R\ :sub:`13high`
* - start + 16:
- G\ :sub:`03high` - B\ :sub:`20low`
- B\ :sub:`20high`
- .. row 2 - G\ :sub:`21low`
- G\ :sub:`21high`
- start + 8: - B\ :sub:`22low`
- B\ :sub:`22high`
- G\ :sub:`10low` - G\ :sub:`23low`
- G\ :sub:`23high`
- G\ :sub:`10high` * - start + 24:
- G\ :sub:`30low`
- R\ :sub:`11low` - G\ :sub:`30high`
- R\ :sub:`31low`
- R\ :sub:`11high` - R\ :sub:`31high`
- G\ :sub:`32low`
- G\ :sub:`12low` - G\ :sub:`32high`
- R\ :sub:`33low`
- G\ :sub:`12high` - R\ :sub:`33high`
- R\ :sub:`13low`
- R\ :sub:`13high`
- .. row 3
- start + 16:
- B\ :sub:`20low`
- B\ :sub:`20high`
- G\ :sub:`21low`
- G\ :sub:`21high`
- B\ :sub:`22low`
- B\ :sub:`22high`
- G\ :sub:`23low`
- G\ :sub:`23high`
- .. row 4
- start + 24:
- G\ :sub:`30low`
- G\ :sub:`30high`
- R\ :sub:`31low`
- R\ :sub:`31high`
- G\ :sub:`32low`
- G\ :sub:`32high`
- R\ :sub:`33low`
- R\ :sub:`33high`

68
Documentation/media/uapi/v4l/pixfmt-srggb8.rst
View File

@ -32,51 +32,23 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - B\ :sub:`00`
- G\ :sub:`01`
- start + 0: - B\ :sub:`02`
- G\ :sub:`03`
- B\ :sub:`00` * - start + 4:
- G\ :sub:`10`
- G\ :sub:`01` - R\ :sub:`11`
- G\ :sub:`12`
- B\ :sub:`02` - R\ :sub:`13`
* - start + 8:
- G\ :sub:`03` - B\ :sub:`20`
- G\ :sub:`21`
- .. row 2 - B\ :sub:`22`
- G\ :sub:`23`
- start + 4: * - start + 12:
- G\ :sub:`30`
- G\ :sub:`10` - R\ :sub:`31`
- G\ :sub:`32`
- R\ :sub:`11` - R\ :sub:`33`
- G\ :sub:`12`
- R\ :sub:`13`
- .. row 3
- start + 8:
- B\ :sub:`20`
- G\ :sub:`21`
- B\ :sub:`22`
- G\ :sub:`23`
- .. row 4
- start + 12:
- G\ :sub:`30`
- R\ :sub:`31`
- G\ :sub:`32`
- R\ :sub:`33`

68
Documentation/media/uapi/v4l/pixfmt-tch-td08.rst
View File

@ -30,51 +30,23 @@ Each cell is one byte.
:stub-columns: 0 :stub-columns: 0
:widths: 2 1 1 1 1 :widths: 2 1 1 1 1
* - start + 0:
- .. row 1 - D'\ :sub:`00`
- D'\ :sub:`01`
- start + 0: - D'\ :sub:`02`
- D'\ :sub:`03`
- D'\ :sub:`00` * - start + 4:
- D'\ :sub:`10`
- D'\ :sub:`01` - D'\ :sub:`11`
- D'\ :sub:`12`
- D'\ :sub:`02` - D'\ :sub:`13`
* - start + 8:
- D'\ :sub:`03` - D'\ :sub:`20`
- D'\ :sub:`21`
- .. row 2 - D'\ :sub:`22`
- D'\ :sub:`23`
- start + 4: * - start + 12:
- D'\ :sub:`30`
- D'\ :sub:`10` - D'\ :sub:`31`
- D'\ :sub:`32`
- D'\ :sub:`11` - D'\ :sub:`33`
- D'\ :sub:`12`
- D'\ :sub:`13`
- .. row 3
- start + 8:
- D'\ :sub:`20`
- D'\ :sub:`21`
- D'\ :sub:`22`
- D'\ :sub:`23`
- .. row 4
- start + 12:
- D'\ :sub:`30`
- D'\ :sub:`31`
- D'\ :sub:`32`
- D'\ :sub:`33`

116
Documentation/media/uapi/v4l/pixfmt-tch-td16.rst
View File

@ -29,83 +29,39 @@ Each cell is one byte.
:stub-columns: 0 :stub-columns: 0
:widths: 2 1 1 1 1 1 1 1 1 :widths: 2 1 1 1 1 1 1 1 1
* - start + 0:
- .. row 1 - D'\ :sub:`00high`
- D'\ :sub:`00low`
- start + 0: - D'\ :sub:`01high`
- D'\ :sub:`01low`
- D'\ :sub:`00high` - D'\ :sub:`02high`
- D'\ :sub:`02low`
- D'\ :sub:`00low` - D'\ :sub:`03high`
- D'\ :sub:`03low`
- D'\ :sub:`01high` * - start + 8:
- D'\ :sub:`10high`
- D'\ :sub:`01low` - D'\ :sub:`10low`
- D'\ :sub:`11high`
- D'\ :sub:`02high` - D'\ :sub:`11low`
- D'\ :sub:`12high`
- D'\ :sub:`02low` - D'\ :sub:`12low`
- D'\ :sub:`13high`
- D'\ :sub:`03high` - D'\ :sub:`13low`
* - start + 16:
- D'\ :sub:`03low` - D'\ :sub:`20high`
- D'\ :sub:`20low`
- .. row 2 - D'\ :sub:`21high`
- D'\ :sub:`21low`
- start + 8: - D'\ :sub:`22high`
- D'\ :sub:`22low`
- D'\ :sub:`10high` - D'\ :sub:`23high`
- D'\ :sub:`23low`
- D'\ :sub:`10low` * - start + 24:
- D'\ :sub:`30high`
- D'\ :sub:`11high` - D'\ :sub:`30low`
- D'\ :sub:`31high`
- D'\ :sub:`11low` - D'\ :sub:`31low`
- D'\ :sub:`32high`
- D'\ :sub:`12high` - D'\ :sub:`32low`
- D'\ :sub:`33high`
- D'\ :sub:`12low` - D'\ :sub:`33low`
- D'\ :sub:`13high`
- D'\ :sub:`13low`
- .. row 3
- start + 16:
- D'\ :sub:`20high`
- D'\ :sub:`20low`
- D'\ :sub:`21high`
- D'\ :sub:`21low`
- D'\ :sub:`22high`
- D'\ :sub:`22low`
- D'\ :sub:`23high`
- D'\ :sub:`23low`
- .. row 4
- start + 24:
- D'\ :sub:`30high`
- D'\ :sub:`30low`
- D'\ :sub:`31high`
- D'\ :sub:`31low`
- D'\ :sub:`32high`
- D'\ :sub:`32low`
- D'\ :sub:`33high`
- D'\ :sub:`33low`

68
Documentation/media/uapi/v4l/pixfmt-tch-tu08.rst
View File

@ -28,51 +28,23 @@ Each cell is one byte.
:stub-columns: 0 :stub-columns: 0
:widths: 2 1 1 1 1 :widths: 2 1 1 1 1
* - start + 0:
- .. row 1 - R'\ :sub:`00`
- R'\ :sub:`01`
- start + 0: - R'\ :sub:`02`
- R'\ :sub:`03`
- R'\ :sub:`00` * - start + 4:
- R'\ :sub:`10`
- R'\ :sub:`01` - R'\ :sub:`11`
- R'\ :sub:`12`
- R'\ :sub:`02` - R'\ :sub:`13`
* - start + 8:
- R'\ :sub:`03` - R'\ :sub:`20`
- R'\ :sub:`21`
- .. row 2 - R'\ :sub:`22`
- R'\ :sub:`23`
- start + 4: * - start + 12:
- R'\ :sub:`30`
- R'\ :sub:`10` - R'\ :sub:`31`
- R'\ :sub:`32`
- R'\ :sub:`11` - R'\ :sub:`33`
- R'\ :sub:`12`
- R'\ :sub:`13`
- .. row 3
- start + 8:
- R'\ :sub:`20`
- R'\ :sub:`21`
- R'\ :sub:`22`
- R'\ :sub:`23`
- .. row 4
- start + 12:
- R'\ :sub:`30`
- R'\ :sub:`31`
- R'\ :sub:`32`
- R'\ :sub:`33`

116
Documentation/media/uapi/v4l/pixfmt-tch-tu16.rst
View File

@ -28,83 +28,39 @@ Each cell is one byte.
:stub-columns: 0 :stub-columns: 0
:widths: 2 1 1 1 1 1 1 1 1 :widths: 2 1 1 1 1 1 1 1 1
* - start + 0:
- .. row 1 - R'\ :sub:`00high`
- R'\ :sub:`00low`
- start + 0: - R'\ :sub:`01high`
- R'\ :sub:`01low`
- R'\ :sub:`00high` - R'\ :sub:`02high`
- R'\ :sub:`02low`
- R'\ :sub:`00low` - R'\ :sub:`03high`
- R'\ :sub:`03low`
- R'\ :sub:`01high` * - start + 8:
- R'\ :sub:`10high`
- R'\ :sub:`01low` - R'\ :sub:`10low`
- R'\ :sub:`11high`
- R'\ :sub:`02high` - R'\ :sub:`11low`
- R'\ :sub:`12high`
- R'\ :sub:`02low` - R'\ :sub:`12low`
- R'\ :sub:`13high`
- R'\ :sub:`03high` - R'\ :sub:`13low`
* - start + 16:
- R'\ :sub:`03low` - R'\ :sub:`20high`
- R'\ :sub:`20low`
- .. row 2 - R'\ :sub:`21high`
- R'\ :sub:`21low`
- start + 8: - R'\ :sub:`22high`
- R'\ :sub:`22low`
- R'\ :sub:`10high` - R'\ :sub:`23high`
- R'\ :sub:`23low`
- R'\ :sub:`10low` * - start + 24:
- R'\ :sub:`30high`
- R'\ :sub:`11high` - R'\ :sub:`30low`
- R'\ :sub:`31high`
- R'\ :sub:`11low` - R'\ :sub:`31low`
- R'\ :sub:`32high`
- R'\ :sub:`12high` - R'\ :sub:`32low`
- R'\ :sub:`33high`
- R'\ :sub:`12low` - R'\ :sub:`33low`
- R'\ :sub:`13high`
- R'\ :sub:`13low`
- .. row 3
- start + 16:
- R'\ :sub:`20high`
- R'\ :sub:`20low`
- R'\ :sub:`21high`
- R'\ :sub:`21low`
- R'\ :sub:`22high`
- R'\ :sub:`22low`
- R'\ :sub:`23high`
- R'\ :sub:`23low`
- .. row 4
- start + 24:
- R'\ :sub:`30high`
- R'\ :sub:`30low`
- R'\ :sub:`31high`
- R'\ :sub:`31low`
- R'\ :sub:`32high`
- R'\ :sub:`32low`
- R'\ :sub:`33high`
- R'\ :sub:`33low`

68
Documentation/media/uapi/v4l/pixfmt-uv8.rst
View File

@ -25,51 +25,23 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Cb\ :sub:`00`
- Cr\ :sub:`00`
- start + 0: - Cb\ :sub:`01`
- Cr\ :sub:`01`
- Cb\ :sub:`00` * - start + 4:
- Cb\ :sub:`10`
- Cr\ :sub:`00` - Cr\ :sub:`10`
- Cb\ :sub:`11`
- Cb\ :sub:`01` - Cr\ :sub:`11`
* - start + 8:
- Cr\ :sub:`01` - Cb\ :sub:`20`
- Cr\ :sub:`20`
- .. row 2 - Cb\ :sub:`21`
- Cr\ :sub:`21`
- start + 4: * - start + 12:
- Cb\ :sub:`30`
- Cb\ :sub:`10` - Cr\ :sub:`30`
- Cb\ :sub:`31`
- Cr\ :sub:`10` - Cr\ :sub:`31`
- Cb\ :sub:`11`
- Cr\ :sub:`11`
- .. row 3
- start + 8:
- Cb\ :sub:`20`
- Cr\ :sub:`20`
- Cb\ :sub:`21`
- Cr\ :sub:`21`
- .. row 4
- start + 12:
- Cb\ :sub:`30`
- Cr\ :sub:`30`
- Cb\ :sub:`31`
- Cr\ :sub:`31`

228
Documentation/media/uapi/v4l/pixfmt-uyvy.rst
View File

@ -27,86 +27,42 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Cb\ :sub:`00`
- Y'\ :sub:`00`
- start + 0: - Cr\ :sub:`00`
- Y'\ :sub:`01`
- Cb\ :sub:`00` - Cb\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Cr\ :sub:`01`
- Y'\ :sub:`03`
- Cr\ :sub:`00` * - start + 8:
- Cb\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`10`
- Cr\ :sub:`10`
- Cb\ :sub:`01` - Y'\ :sub:`11`
- Cb\ :sub:`11`
- Y'\ :sub:`02` - Y'\ :sub:`12`
- Cr\ :sub:`11`
- Cr\ :sub:`01` - Y'\ :sub:`13`
* - start + 16:
- Y'\ :sub:`03` - Cb\ :sub:`20`
- Y'\ :sub:`20`
- .. row 2 - Cr\ :sub:`20`
- Y'\ :sub:`21`
- start + 8: - Cb\ :sub:`21`
- Y'\ :sub:`22`
- Cb\ :sub:`10` - Cr\ :sub:`21`
- Y'\ :sub:`23`
- Y'\ :sub:`10` * - start + 24:
- Cb\ :sub:`30`
- Cr\ :sub:`10` - Y'\ :sub:`30`
- Cr\ :sub:`30`
- Y'\ :sub:`11` - Y'\ :sub:`31`
- Cb\ :sub:`31`
- Cb\ :sub:`11` - Y'\ :sub:`32`
- Cr\ :sub:`31`
- Y'\ :sub:`12` - Y'\ :sub:`33`
- Cr\ :sub:`11`
- Y'\ :sub:`13`
- .. row 3
- start + 16:
- Cb\ :sub:`20`
- Y'\ :sub:`20`
- Cr\ :sub:`20`
- Y'\ :sub:`21`
- Cb\ :sub:`21`
- Y'\ :sub:`22`
- Cr\ :sub:`21`
- Y'\ :sub:`23`
- .. row 4
- start + 24:
- Cb\ :sub:`30`
- Y'\ :sub:`30`
- Cr\ :sub:`30`
- Y'\ :sub:`31`
- Cb\ :sub:`31`
- Y'\ :sub:`32`
- Cr\ :sub:`31`
- Y'\ :sub:`33`
**Color Sample Location..** **Color Sample Location..**
@ -117,80 +73,38 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 - C
- Y
- - Y
- 3 - C
- Y
- .. row 2 * - 1
- Y
- 0 - C
- Y
- Y - Y
- C
- C - Y
* - 2
- Y - Y
- C
- Y - Y
- Y
- C - C
- Y
- Y * - 3
- Y
- .. row 3 - C
- Y
- 1 - Y
- C
- Y - Y
- C
- Y
- Y
- C
- Y
- .. row 4
- 2
- Y
- C
- Y
- Y
- C
- Y
- .. row 5
- 3
- Y
- C
- Y
- Y
- C
- Y

228
Documentation/media/uapi/v4l/pixfmt-vyuy.rst
View File

@ -27,86 +27,42 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Cr\ :sub:`00`
- Y'\ :sub:`00`
- start + 0: - Cb\ :sub:`00`
- Y'\ :sub:`01`
- Cr\ :sub:`00` - Cr\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Cb\ :sub:`01`
- Y'\ :sub:`03`
- Cb\ :sub:`00` * - start + 8:
- Cr\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`10`
- Cb\ :sub:`10`
- Cr\ :sub:`01` - Y'\ :sub:`11`
- Cr\ :sub:`11`
- Y'\ :sub:`02` - Y'\ :sub:`12`
- Cb\ :sub:`11`
- Cb\ :sub:`01` - Y'\ :sub:`13`
* - start + 16:
- Y'\ :sub:`03` - Cr\ :sub:`20`
- Y'\ :sub:`20`
- .. row 2 - Cb\ :sub:`20`
- Y'\ :sub:`21`
- start + 8: - Cr\ :sub:`21`
- Y'\ :sub:`22`
- Cr\ :sub:`10` - Cb\ :sub:`21`
- Y'\ :sub:`23`
- Y'\ :sub:`10` * - start + 24:
- Cr\ :sub:`30`
- Cb\ :sub:`10` - Y'\ :sub:`30`
- Cb\ :sub:`30`
- Y'\ :sub:`11` - Y'\ :sub:`31`
- Cr\ :sub:`31`
- Cr\ :sub:`11` - Y'\ :sub:`32`
- Cb\ :sub:`31`
- Y'\ :sub:`12` - Y'\ :sub:`33`
- Cb\ :sub:`11`
- Y'\ :sub:`13`
- .. row 3
- start + 16:
- Cr\ :sub:`20`
- Y'\ :sub:`20`
- Cb\ :sub:`20`
- Y'\ :sub:`21`
- Cr\ :sub:`21`
- Y'\ :sub:`22`
- Cb\ :sub:`21`
- Y'\ :sub:`23`
- .. row 4
- start + 24:
- Cr\ :sub:`30`
- Y'\ :sub:`30`
- Cb\ :sub:`30`
- Y'\ :sub:`31`
- Cr\ :sub:`31`
- Y'\ :sub:`32`
- Cb\ :sub:`31`
- Y'\ :sub:`33`
**Color Sample Location..** **Color Sample Location..**
@ -115,80 +71,38 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 -
- 2
- - 3
- 1 * - 0
- Y
- - C
- 2 - Y
- Y
- 3 - C
- Y
- .. row 2 * - 1
- Y
- 0 - C
- Y
- Y - Y
- C
- C - Y
* - 2
- Y - Y
- C
- Y - Y
- Y
- C - C
- Y
- Y * - 3
- Y
- .. row 3 - C
- Y
- 1 - Y
- C
- Y - Y
- C
- Y
- Y
- C
- Y
- .. row 4
- 2
- Y
- C
- Y
- Y
- C
- Y
- .. row 5
- 3
- Y
- C
- Y
- Y
- C
- Y

116
Documentation/media/uapi/v4l/pixfmt-y10.rst
View File

@ -27,83 +27,39 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00low`
- Y'\ :sub:`00high`
- start + 0: - Y'\ :sub:`01low`
- Y'\ :sub:`01high`
- Y'\ :sub:`00low` - Y'\ :sub:`02low`
- Y'\ :sub:`02high`
- Y'\ :sub:`00high` - Y'\ :sub:`03low`
- Y'\ :sub:`03high`
- Y'\ :sub:`01low` * - start + 8:
- Y'\ :sub:`10low`
- Y'\ :sub:`01high` - Y'\ :sub:`10high`
- Y'\ :sub:`11low`
- Y'\ :sub:`02low` - Y'\ :sub:`11high`
- Y'\ :sub:`12low`
- Y'\ :sub:`02high` - Y'\ :sub:`12high`
- Y'\ :sub:`13low`
- Y'\ :sub:`03low` - Y'\ :sub:`13high`
* - start + 16:
- Y'\ :sub:`03high` - Y'\ :sub:`20low`
- Y'\ :sub:`20high`
- .. row 2 - Y'\ :sub:`21low`
- Y'\ :sub:`21high`
- start + 8: - Y'\ :sub:`22low`
- Y'\ :sub:`22high`
- Y'\ :sub:`10low` - Y'\ :sub:`23low`
- Y'\ :sub:`23high`
- Y'\ :sub:`10high` * - start + 24:
- Y'\ :sub:`30low`
- Y'\ :sub:`11low` - Y'\ :sub:`30high`
- Y'\ :sub:`31low`
- Y'\ :sub:`11high` - Y'\ :sub:`31high`
- Y'\ :sub:`32low`
- Y'\ :sub:`12low` - Y'\ :sub:`32high`
- Y'\ :sub:`33low`
- Y'\ :sub:`12high` - Y'\ :sub:`33high`
- Y'\ :sub:`13low`
- Y'\ :sub:`13high`
- .. row 3
- start + 16:
- Y'\ :sub:`20low`
- Y'\ :sub:`20high`
- Y'\ :sub:`21low`
- Y'\ :sub:`21high`
- Y'\ :sub:`22low`
- Y'\ :sub:`22high`
- Y'\ :sub:`23low`
- Y'\ :sub:`23high`
- .. row 4
- start + 24:
- Y'\ :sub:`30low`
- Y'\ :sub:`30high`
- Y'\ :sub:`31low`
- Y'\ :sub:`31high`
- Y'\ :sub:`32low`
- Y'\ :sub:`32high`
- Y'\ :sub:`33low`
- Y'\ :sub:`33high`

16
Documentation/media/uapi/v4l/pixfmt-y10b.rst
View File

@ -26,14 +26,8 @@ pixels.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 * - Y'\ :sub:`00[9:2]`
- Y'\ :sub:`00[1:0]`\ Y'\ :sub:`01[9:4]`
- Y'\ :sub:`00[9:2]` - Y'\ :sub:`01[3:0]`\ Y'\ :sub:`02[9:6]`
- Y'\ :sub:`02[5:0]`\ Y'\ :sub:`03[9:8]`
- Y'\ :sub:`00[1:0]`\ Y'\ :sub:`01[9:4]` - Y'\ :sub:`03[7:0]`
- Y'\ :sub:`01[3:0]`\ Y'\ :sub:`02[9:6]`
- Y'\ :sub:`02[5:0]`\ Y'\ :sub:`03[9:8]`
- Y'\ :sub:`03[7:0]`

116
Documentation/media/uapi/v4l/pixfmt-y12.rst
View File

@ -27,83 +27,39 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00low`
- Y'\ :sub:`00high`
- start + 0: - Y'\ :sub:`01low`
- Y'\ :sub:`01high`
- Y'\ :sub:`00low` - Y'\ :sub:`02low`
- Y'\ :sub:`02high`
- Y'\ :sub:`00high` - Y'\ :sub:`03low`
- Y'\ :sub:`03high`
- Y'\ :sub:`01low` * - start + 8:
- Y'\ :sub:`10low`
- Y'\ :sub:`01high` - Y'\ :sub:`10high`
- Y'\ :sub:`11low`
- Y'\ :sub:`02low` - Y'\ :sub:`11high`
- Y'\ :sub:`12low`
- Y'\ :sub:`02high` - Y'\ :sub:`12high`
- Y'\ :sub:`13low`
- Y'\ :sub:`03low` - Y'\ :sub:`13high`
* - start + 16:
- Y'\ :sub:`03high` - Y'\ :sub:`20low`
- Y'\ :sub:`20high`
- .. row 2 - Y'\ :sub:`21low`
- Y'\ :sub:`21high`
- start + 8: - Y'\ :sub:`22low`
- Y'\ :sub:`22high`
- Y'\ :sub:`10low` - Y'\ :sub:`23low`
- Y'\ :sub:`23high`
- Y'\ :sub:`10high` * - start + 24:
- Y'\ :sub:`30low`
- Y'\ :sub:`11low` - Y'\ :sub:`30high`
- Y'\ :sub:`31low`
- Y'\ :sub:`11high` - Y'\ :sub:`31high`
- Y'\ :sub:`32low`
- Y'\ :sub:`12low` - Y'\ :sub:`32high`
- Y'\ :sub:`33low`
- Y'\ :sub:`12high` - Y'\ :sub:`33high`
- Y'\ :sub:`13low`
- Y'\ :sub:`13high`
- .. row 3
- start + 16:
- Y'\ :sub:`20low`
- Y'\ :sub:`20high`
- Y'\ :sub:`21low`
- Y'\ :sub:`21high`
- Y'\ :sub:`22low`
- Y'\ :sub:`22high`
- Y'\ :sub:`23low`
- Y'\ :sub:`23high`
- .. row 4
- start + 24:
- Y'\ :sub:`30low`
- Y'\ :sub:`30high`
- Y'\ :sub:`31low`
- Y'\ :sub:`31high`
- Y'\ :sub:`32low`
- Y'\ :sub:`32high`
- Y'\ :sub:`33low`
- Y'\ :sub:`33high`

11
Documentation/media/uapi/v4l/pixfmt-y12i.rst
View File

@ -31,11 +31,6 @@ interleaved pixel.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - Y'\ :sub:`0left[7:0]`
- .. row 1 - Y'\ :sub:`0right[3:0]`\ Y'\ :sub:`0left[11:8]`
- Y'\ :sub:`0right[11:4]`
- Y'\ :sub:`0left[7:0]`
- Y'\ :sub:`0right[3:0]`\ Y'\ :sub:`0left[11:8]`
- Y'\ :sub:`0right[11:4]`

116
Documentation/media/uapi/v4l/pixfmt-y16-be.rst
View File

@ -31,83 +31,39 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00high`
- Y'\ :sub:`00low`
- start + 0: - Y'\ :sub:`01high`
- Y'\ :sub:`01low`
- Y'\ :sub:`00high` - Y'\ :sub:`02high`
- Y'\ :sub:`02low`
- Y'\ :sub:`00low` - Y'\ :sub:`03high`
- Y'\ :sub:`03low`
- Y'\ :sub:`01high` * - start + 8:
- Y'\ :sub:`10high`
- Y'\ :sub:`01low` - Y'\ :sub:`10low`
- Y'\ :sub:`11high`
- Y'\ :sub:`02high` - Y'\ :sub:`11low`
- Y'\ :sub:`12high`
- Y'\ :sub:`02low` - Y'\ :sub:`12low`
- Y'\ :sub:`13high`
- Y'\ :sub:`03high` - Y'\ :sub:`13low`
* - start + 16:
- Y'\ :sub:`03low` - Y'\ :sub:`20high`
- Y'\ :sub:`20low`
- .. row 2 - Y'\ :sub:`21high`
- Y'\ :sub:`21low`
- start + 8: - Y'\ :sub:`22high`
- Y'\ :sub:`22low`
- Y'\ :sub:`10high` - Y'\ :sub:`23high`
- Y'\ :sub:`23low`
- Y'\ :sub:`10low` * - start + 24:
- Y'\ :sub:`30high`
- Y'\ :sub:`11high` - Y'\ :sub:`30low`
- Y'\ :sub:`31high`
- Y'\ :sub:`11low` - Y'\ :sub:`31low`
- Y'\ :sub:`32high`
- Y'\ :sub:`12high` - Y'\ :sub:`32low`
- Y'\ :sub:`33high`
- Y'\ :sub:`12low` - Y'\ :sub:`33low`
- Y'\ :sub:`13high`
- Y'\ :sub:`13low`
- .. row 3
- start + 16:
- Y'\ :sub:`20high`
- Y'\ :sub:`20low`
- Y'\ :sub:`21high`
- Y'\ :sub:`21low`
- Y'\ :sub:`22high`
- Y'\ :sub:`22low`
- Y'\ :sub:`23high`
- Y'\ :sub:`23low`
- .. row 4
- start + 24:
- Y'\ :sub:`30high`
- Y'\ :sub:`30low`
- Y'\ :sub:`31high`
- Y'\ :sub:`31low`
- Y'\ :sub:`32high`
- Y'\ :sub:`32low`
- Y'\ :sub:`33high`
- Y'\ :sub:`33low`

116
Documentation/media/uapi/v4l/pixfmt-y16.rst
View File

@ -31,83 +31,39 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00low`
- Y'\ :sub:`00high`
- start + 0: - Y'\ :sub:`01low`
- Y'\ :sub:`01high`
- Y'\ :sub:`00low` - Y'\ :sub:`02low`
- Y'\ :sub:`02high`
- Y'\ :sub:`00high` - Y'\ :sub:`03low`
- Y'\ :sub:`03high`
- Y'\ :sub:`01low` * - start + 8:
- Y'\ :sub:`10low`
- Y'\ :sub:`01high` - Y'\ :sub:`10high`
- Y'\ :sub:`11low`
- Y'\ :sub:`02low` - Y'\ :sub:`11high`
- Y'\ :sub:`12low`
- Y'\ :sub:`02high` - Y'\ :sub:`12high`
- Y'\ :sub:`13low`
- Y'\ :sub:`03low` - Y'\ :sub:`13high`
* - start + 16:
- Y'\ :sub:`03high` - Y'\ :sub:`20low`
- Y'\ :sub:`20high`
- .. row 2 - Y'\ :sub:`21low`
- Y'\ :sub:`21high`
- start + 8: - Y'\ :sub:`22low`
- Y'\ :sub:`22high`
- Y'\ :sub:`10low` - Y'\ :sub:`23low`
- Y'\ :sub:`23high`
- Y'\ :sub:`10high` * - start + 24:
- Y'\ :sub:`30low`
- Y'\ :sub:`11low` - Y'\ :sub:`30high`
- Y'\ :sub:`31low`
- Y'\ :sub:`11high` - Y'\ :sub:`31high`
- Y'\ :sub:`32low`
- Y'\ :sub:`12low` - Y'\ :sub:`32high`
- Y'\ :sub:`33low`
- Y'\ :sub:`12high` - Y'\ :sub:`33high`
- Y'\ :sub:`13low`
- Y'\ :sub:`13high`
- .. row 3
- start + 16:
- Y'\ :sub:`20low`
- Y'\ :sub:`20high`
- Y'\ :sub:`21low`
- Y'\ :sub:`21high`
- Y'\ :sub:`22low`
- Y'\ :sub:`22high`
- Y'\ :sub:`23low`
- Y'\ :sub:`23high`
- .. row 4
- start + 24:
- Y'\ :sub:`30low`
- Y'\ :sub:`30high`
- Y'\ :sub:`31low`
- Y'\ :sub:`31high`
- Y'\ :sub:`32low`
- Y'\ :sub:`32high`
- Y'\ :sub:`33low`
- Y'\ :sub:`33high`

336
Documentation/media/uapi/v4l/pixfmt-y41p.rst
View File

@ -34,118 +34,58 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Cb\ :sub:`00`
- Y'\ :sub:`00`
- start + 0: - Cr\ :sub:`00`
- Y'\ :sub:`01`
- Cb\ :sub:`00` - Cb\ :sub:`01`
- Y'\ :sub:`02`
- Y'\ :sub:`00` - Cr\ :sub:`01`
- Y'\ :sub:`03`
- Cr\ :sub:`00` - Y'\ :sub:`04`
- Y'\ :sub:`05`
- Y'\ :sub:`01` - Y'\ :sub:`06`
- Y'\ :sub:`07`
- Cb\ :sub:`01` * - start + 12:
- Cb\ :sub:`10`
- Y'\ :sub:`02` - Y'\ :sub:`10`
- Cr\ :sub:`10`
- Cr\ :sub:`01` - Y'\ :sub:`11`
- Cb\ :sub:`11`
- Y'\ :sub:`03` - Y'\ :sub:`12`
- Cr\ :sub:`11`
- Y'\ :sub:`04` - Y'\ :sub:`13`
- Y'\ :sub:`14`
- Y'\ :sub:`05` - Y'\ :sub:`15`
- Y'\ :sub:`16`
- Y'\ :sub:`06` - Y'\ :sub:`17`
* - start + 24:
- Y'\ :sub:`07` - Cb\ :sub:`20`
- Y'\ :sub:`20`
- .. row 2 - Cr\ :sub:`20`
- Y'\ :sub:`21`
- start + 12: - Cb\ :sub:`21`
- Y'\ :sub:`22`
- Cb\ :sub:`10` - Cr\ :sub:`21`
- Y'\ :sub:`23`
- Y'\ :sub:`10` - Y'\ :sub:`24`
- Y'\ :sub:`25`
- Cr\ :sub:`10` - Y'\ :sub:`26`
- Y'\ :sub:`27`
- Y'\ :sub:`11` * - start + 36:
- Cb\ :sub:`30`
- Cb\ :sub:`11` - Y'\ :sub:`30`
- Cr\ :sub:`30`
- Y'\ :sub:`12` - Y'\ :sub:`31`
- Cb\ :sub:`31`
- Cr\ :sub:`11` - Y'\ :sub:`32`
- Cr\ :sub:`31`
- Y'\ :sub:`13` - Y'\ :sub:`33`
- Y'\ :sub:`34`
- Y'\ :sub:`14` - Y'\ :sub:`35`
- Y'\ :sub:`36`
- Y'\ :sub:`15` - Y'\ :sub:`37`
- Y'\ :sub:`16`
- Y'\ :sub:`17`
- .. row 3
- start + 24:
- Cb\ :sub:`20`
- Y'\ :sub:`20`
- Cr\ :sub:`20`
- Y'\ :sub:`21`
- Cb\ :sub:`21`
- Y'\ :sub:`22`
- Cr\ :sub:`21`
- Y'\ :sub:`23`
- Y'\ :sub:`24`
- Y'\ :sub:`25`
- Y'\ :sub:`26`
- Y'\ :sub:`27`
- .. row 4
- start + 36:
- Cb\ :sub:`30`
- Y'\ :sub:`30`
- Cr\ :sub:`30`
- Y'\ :sub:`31`
- Cb\ :sub:`31`
- Y'\ :sub:`32`
- Cr\ :sub:`31`
- Y'\ :sub:`33`
- Y'\ :sub:`34`
- Y'\ :sub:`35`
- Y'\ :sub:`36`
- Y'\ :sub:`37`
**Color Sample Location..** **Color Sample Location..**
@ -154,120 +94,58 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
- 1
- -
- 0 - 2
- 3
- 1 - 4
- 5
- -
- 2 - 6
- 7
- 3 * - 0
- Y
- 4 - Y
- C
- 5 - Y
- Y
- - Y
- 6 - Y
- C
- 7 - Y
- Y
- .. row 2 * - 1
- Y
- 0 - Y
- C
- Y - Y
- Y
- Y - Y
- Y
- C - C
- Y
- Y - Y
* - 2
- Y - Y
- Y
- Y - C
- Y
- Y - Y
- Y
- C - Y
- C
- Y - Y
- Y
- Y * - 3
- Y
- .. row 3 - Y
- C
- 1 - Y
- Y
- Y - Y
- Y
- Y - C
- Y
- C - Y
- Y
- Y
- Y
- Y
- C
- Y
- Y
- .. row 4
- 2
- Y
- Y
- C
- Y
- Y
- Y
- Y
- C
- Y
- Y
- .. row 5
- 3
- Y
- Y
- C
- Y
- Y
- Y
- Y
- C
- Y
- Y

116
Documentation/media/uapi/v4l/pixfmt-y8i.rst
View File

@ -28,83 +28,39 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00left`
- Y'\ :sub:`00right`
- start + 0: - Y'\ :sub:`01left`
- Y'\ :sub:`01right`
- Y'\ :sub:`00left` - Y'\ :sub:`02left`
- Y'\ :sub:`02right`
- Y'\ :sub:`00right` - Y'\ :sub:`03left`
- Y'\ :sub:`03right`
- Y'\ :sub:`01left` * - start + 8:
- Y'\ :sub:`10left`
- Y'\ :sub:`01right` - Y'\ :sub:`10right`
- Y'\ :sub:`11left`
- Y'\ :sub:`02left` - Y'\ :sub:`11right`
- Y'\ :sub:`12left`
- Y'\ :sub:`02right` - Y'\ :sub:`12right`
- Y'\ :sub:`13left`
- Y'\ :sub:`03left` - Y'\ :sub:`13right`
* - start + 16:
- Y'\ :sub:`03right` - Y'\ :sub:`20left`
- Y'\ :sub:`20right`
- .. row 2 - Y'\ :sub:`21left`
- Y'\ :sub:`21right`
- start + 8: - Y'\ :sub:`22left`
- Y'\ :sub:`22right`
- Y'\ :sub:`10left` - Y'\ :sub:`23left`
- Y'\ :sub:`23right`
- Y'\ :sub:`10right` * - start + 24:
- Y'\ :sub:`30left`
- Y'\ :sub:`11left` - Y'\ :sub:`30right`
- Y'\ :sub:`31left`
- Y'\ :sub:`11right` - Y'\ :sub:`31right`
- Y'\ :sub:`32left`
- Y'\ :sub:`12left` - Y'\ :sub:`32right`
- Y'\ :sub:`33left`
- Y'\ :sub:`12right` - Y'\ :sub:`33right`
- Y'\ :sub:`13left`
- Y'\ :sub:`13right`
- .. row 3
- start + 16:
- Y'\ :sub:`20left`
- Y'\ :sub:`20right`
- Y'\ :sub:`21left`
- Y'\ :sub:`21right`
- Y'\ :sub:`22left`
- Y'\ :sub:`22right`
- Y'\ :sub:`23left`
- Y'\ :sub:`23right`
- .. row 4
- start + 24:
- Y'\ :sub:`30left`
- Y'\ :sub:`30right`
- Y'\ :sub:`31left`
- Y'\ :sub:`31right`
- Y'\ :sub:`32left`
- Y'\ :sub:`32right`
- Y'\ :sub:`33left`
- Y'\ :sub:`33right`

228
Documentation/media/uapi/v4l/pixfmt-yuv410.rst
View File

@ -41,66 +41,30 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start + 4: * - start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
* - start + 16:
- Y'\ :sub:`12` - Cr\ :sub:`00`
* - start + 17:
- Y'\ :sub:`13` - Cb\ :sub:`00`
- .. row 3
- start + 8:
- Y'\ :sub:`20`
- Y'\ :sub:`21`
- Y'\ :sub:`22`
- Y'\ :sub:`23`
- .. row 4
- start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
- start + 16:
- Cr\ :sub:`00`
- .. row 6
- start + 17:
- Cb\ :sub:`00`
**Color Sample Location..** **Color Sample Location..**
@ -111,97 +75,53 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 -
- 2
- -
- 1 - 3
* - 0
- - Y
- 2 -
- Y
- -
- 3 - Y
-
- .. row 2 - Y
* -
- 0 * - 1
- Y
- Y -
- Y
- -
- Y - Y
-
- - Y
- Y * -
-
- -
- Y -
- C
- .. row 3 -
-
- -
* - 2
- .. row 4 - Y
-
- 1 - Y
-
- Y - Y
-
- - Y
- Y * -
* - 3
- - Y
- Y -
- Y
- -
- Y - Y
-
- .. row 5 - Y
-
-
-
-
- C
-
-
-
- .. row 6
- 2
- Y
-
- Y
-
- Y
-
- Y
- .. row 7
-
- .. row 8
- 3
- Y
-
- Y
-
- Y
-
- Y

230
Documentation/media/uapi/v4l/pixfmt-yuv411p.rst
View File

@ -37,102 +37,42 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start + 4: * - start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
* - start + 16:
- Y'\ :sub:`12` - Cb\ :sub:`00`
* - start + 17:
- Y'\ :sub:`13` - Cb\ :sub:`10`
* - start + 18:
- .. row 3 - Cb\ :sub:`20`
* - start + 19:
- start + 8: - Cb\ :sub:`30`
* - start + 20:
- Y'\ :sub:`20` - Cr\ :sub:`00`
* - start + 21:
- Y'\ :sub:`21` - Cr\ :sub:`10`
* - start + 22:
- Y'\ :sub:`22` - Cr\ :sub:`20`
* - start + 23:
- Y'\ :sub:`23` - Cr\ :sub:`30`
- .. row 4
- start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
- start + 16:
- Cb\ :sub:`00`
- .. row 6
- start + 17:
- Cb\ :sub:`10`
- .. row 7
- start + 18:
- Cb\ :sub:`20`
- .. row 8
- start + 19:
- Cb\ :sub:`30`
- .. row 9
- start + 20:
- Cr\ :sub:`00`
- .. row 10
- start + 21:
- Cr\ :sub:`10`
- .. row 11
- start + 22:
- Cr\ :sub:`20`
- .. row 12
- start + 23:
- Cr\ :sub:`30`
**Color Sample Location..** **Color Sample Location..**
@ -143,71 +83,33 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
- 1
- -
- 0 - 2
- 3
- 1 * - 0
- Y
- - Y
- 2 - C
- Y
- 3 - Y
* - 1
- .. row 2 - Y
- Y
- 0 - C
- Y
- Y - Y
* - 2
- Y - Y
- Y
- C - C
- Y
- Y - Y
* - 3
- Y - Y
- Y
- .. row 3 - C
- Y
- 1 - Y
- Y
- Y
- C
- Y
- Y
- .. row 4
- 2
- Y
- Y
- C
- Y
- Y
- .. row 5
- 3
- Y
- Y
- C
- Y
- Y

273
Documentation/media/uapi/v4l/pixfmt-yuv420.rst
View File

@ -42,86 +42,38 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start + 4: * - start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
* - start + 16:
- Y'\ :sub:`12` - Cr\ :sub:`00`
- Cr\ :sub:`01`
- Y'\ :sub:`13` * - start + 18:
- Cr\ :sub:`10`
- .. row 3 - Cr\ :sub:`11`
* - start + 20:
- start + 8: - Cb\ :sub:`00`
- Cb\ :sub:`01`
- Y'\ :sub:`20` * - start + 22:
- Cb\ :sub:`10`
- Y'\ :sub:`21` - Cb\ :sub:`11`
- Y'\ :sub:`22`
- Y'\ :sub:`23`
- .. row 4
- start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
- start + 16:
- Cr\ :sub:`00`
- Cr\ :sub:`01`
- .. row 6
- start + 18:
- Cr\ :sub:`10`
- Cr\ :sub:`11`
- .. row 7
- start + 20:
- Cb\ :sub:`00`
- Cb\ :sub:`01`
- .. row 8
- start + 22:
- Cb\ :sub:`10`
- Cb\ :sub:`11`
**Color Sample Location..** **Color Sample Location..**
@ -132,107 +84,60 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 -
- 2
- -
- 1 - 3
* - 0
- - Y
- 2 -
- Y
- -
- 3 - Y
-
- .. row 2 - Y
* -
- 0 -
- C
- Y -
-
- -
- Y - C
-
- * - 1
- Y - Y
-
- - Y
- Y -
- Y
- .. row 3 -
- Y
- * -
- * - 2
- C - Y
-
- - Y
- -
- - Y
- C -
- Y
- * -
-
- .. row 4 - C
-
- 1 -
-
- Y - C
-
- * - 3
- Y - Y
-
- - Y
- Y -
- Y
- -
- Y - Y
- .. row 5
-
- .. row 6
- 2
- Y
-
- Y
-
- Y
-
- Y
- .. row 7
-
-
- C
-
-
-
- C
-
- .. row 8
- 3
- Y
-
- Y
-
- Y
-
- Y

283
Documentation/media/uapi/v4l/pixfmt-yuv420m.rst
View File

@ -49,94 +49,40 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start0 + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start0 + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start0 + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start0 + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start0 + 4: * - start0 + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
* -
- Y'\ :sub:`12` * - start1 + 0:
- Cb\ :sub:`00`
- Y'\ :sub:`13` - Cb\ :sub:`01`
* - start1 + 2:
- .. row 3 - Cb\ :sub:`10`
- Cb\ :sub:`11`
- start0 + 8: * -
* - start2 + 0:
- Y'\ :sub:`20` - Cr\ :sub:`00`
- Cr\ :sub:`01`
- Y'\ :sub:`21` * - start2 + 2:
- Cr\ :sub:`10`
- Y'\ :sub:`22` - Cr\ :sub:`11`
- Y'\ :sub:`23`
- .. row 4
- start0 + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
-
- .. row 6
- start1 + 0:
- Cb\ :sub:`00`
- Cb\ :sub:`01`
- .. row 7
- start1 + 2:
- Cb\ :sub:`10`
- Cb\ :sub:`11`
- .. row 8
-
- .. row 9
- start2 + 0:
- Cr\ :sub:`00`
- Cr\ :sub:`01`
- .. row 10
- start2 + 2:
- Cr\ :sub:`10`
- Cr\ :sub:`11`
**Color Sample Location..** **Color Sample Location..**
@ -147,107 +93,60 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 -
- 2
- -
- 1 - 3
* - 0
- - Y
- 2 -
- Y
- -
- 3 - Y
-
- .. row 2 - Y
* -
- 0 -
- C
- Y -
-
- -
- Y - C
-
- * - 1
- Y - Y
-
- - Y
- Y -
- Y
- .. row 3 -
- Y
- * -
- * - 2
- C - Y
-
- - Y
- -
- - Y
- C -
- Y
- * -
-
- .. row 4 - C
-
- 1 -
-
- Y - C
-
- * - 3
- Y - Y
-
- - Y
- Y -
- Y
- -
- Y - Y
- .. row 5
-
- .. row 6
- 2
- Y
-
- Y
-
- Y
-
- Y
- .. row 7
-
-
- C
-
-
-
- C
-
- .. row 8
- 3
- Y
-
- Y
-
- Y
-
- Y

278
Documentation/media/uapi/v4l/pixfmt-yuv422m.rst
View File

@ -48,126 +48,52 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start0 + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start0 + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start0 + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start0 + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start0 + 4: * - start0 + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
* -
- Y'\ :sub:`12` * - start1 + 0:
- Cb\ :sub:`00`
- Y'\ :sub:`13` - Cb\ :sub:`01`
* - start1 + 2:
- .. row 3 - Cb\ :sub:`10`
- Cb\ :sub:`11`
- start0 + 8: * - start1 + 4:
- Cb\ :sub:`20`
- Y'\ :sub:`20` - Cb\ :sub:`21`
* - start1 + 6:
- Y'\ :sub:`21` - Cb\ :sub:`30`
- Cb\ :sub:`31`
- Y'\ :sub:`22` * -
* - start2 + 0:
- Y'\ :sub:`23` - Cr\ :sub:`00`
- Cr\ :sub:`01`
- .. row 4 * - start2 + 2:
- Cr\ :sub:`10`
- start0 + 12: - Cr\ :sub:`11`
* - start2 + 4:
- Y'\ :sub:`30` - Cr\ :sub:`20`
- Cr\ :sub:`21`
- Y'\ :sub:`31` * - start2 + 6:
- Cr\ :sub:`30`
- Y'\ :sub:`32` - Cr\ :sub:`31`
- Y'\ :sub:`33`
- .. row 5
-
- .. row 6
- start1 + 0:
- Cb\ :sub:`00`
- Cb\ :sub:`01`
- .. row 7
- start1 + 2:
- Cb\ :sub:`10`
- Cb\ :sub:`11`
- .. row 8
- start1 + 4:
- Cb\ :sub:`20`
- Cb\ :sub:`21`
- .. row 9
- start1 + 6:
- Cb\ :sub:`30`
- Cb\ :sub:`31`
- .. row 10
-
- .. row 11
- start2 + 0:
- Cr\ :sub:`00`
- Cr\ :sub:`01`
- .. row 12
- start2 + 2:
- Cr\ :sub:`10`
- Cr\ :sub:`11`
- .. row 13
- start2 + 4:
- Cr\ :sub:`20`
- Cr\ :sub:`21`
- .. row 14
- start2 + 6:
- Cr\ :sub:`30`
- Cr\ :sub:`31`
**Color Sample Location..** **Color Sample Location..**
@ -178,80 +104,38 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 - C
- Y
- - Y
- 3 - C
- Y
- .. row 2 * - 1
- Y
- 0 - C
- Y
- Y - Y
- C
- C - Y
* - 2
- Y - Y
- C
- Y - Y
- Y
- C - C
- Y
- Y * - 3
- Y
- .. row 3 - C
- Y
- 1 - Y
- C
- Y - Y
- C
- Y
- Y
- C
- Y
- .. row 4
- 2
- Y
- C
- Y
- Y
- C
- Y
- .. row 5
- 3
- Y
- C
- Y
- Y
- C
- Y

268
Documentation/media/uapi/v4l/pixfmt-yuv422p.rst
View File

@ -38,118 +38,50 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start + 4: * - start + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
* - start + 16:
- Y'\ :sub:`12` - Cb\ :sub:`00`
- Cb\ :sub:`01`
- Y'\ :sub:`13` * - start + 18:
- Cb\ :sub:`10`
- .. row 3 - Cb\ :sub:`11`
* - start + 20:
- start + 8: - Cb\ :sub:`20`
- Cb\ :sub:`21`
- Y'\ :sub:`20` * - start + 22:
- Cb\ :sub:`30`
- Y'\ :sub:`21` - Cb\ :sub:`31`
* - start + 24:
- Y'\ :sub:`22` - Cr\ :sub:`00`
- Cr\ :sub:`01`
- Y'\ :sub:`23` * - start + 26:
- Cr\ :sub:`10`
- .. row 4 - Cr\ :sub:`11`
* - start + 28:
- start + 12: - Cr\ :sub:`20`
- Cr\ :sub:`21`
- Y'\ :sub:`30` * - start + 30:
- Cr\ :sub:`30`
- Y'\ :sub:`31` - Cr\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`33`
- .. row 5
- start + 16:
- Cb\ :sub:`00`
- Cb\ :sub:`01`
- .. row 6
- start + 18:
- Cb\ :sub:`10`
- Cb\ :sub:`11`
- .. row 7
- start + 20:
- Cb\ :sub:`20`
- Cb\ :sub:`21`
- .. row 8
- start + 22:
- Cb\ :sub:`30`
- Cb\ :sub:`31`
- .. row 9
- start + 24:
- Cr\ :sub:`00`
- Cr\ :sub:`01`
- .. row 10
- start + 26:
- Cr\ :sub:`10`
- Cr\ :sub:`11`
- .. row 11
- start + 28:
- Cr\ :sub:`20`
- Cr\ :sub:`21`
- .. row 12
- start + 30:
- Cr\ :sub:`30`
- Cr\ :sub:`31`
**Color Sample Location..** **Color Sample Location..**
@ -160,80 +92,38 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 - C
- Y
- - Y
- 3 - C
- Y
- .. row 2 * - 1
- Y
- 0 - C
- Y
- Y - Y
- C
- C - Y
* - 2
- Y - Y
- C
- Y - Y
- Y
- C - C
- Y
- Y * - 3
- Y
- .. row 3 - C
- Y
- 1 - Y
- C
- Y - Y
- C
- Y
- Y
- C
- Y
- .. row 4
- 2
- Y
- C
- Y
- Y
- C
- Y
- .. row 5
- 3
- Y
- C
- Y
- Y
- C
- Y

298
Documentation/media/uapi/v4l/pixfmt-yuv444m.rst
View File

@ -42,158 +42,68 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start0 + 0:
- .. row 1 - Y'\ :sub:`00`
- Y'\ :sub:`01`
- start0 + 0: - Y'\ :sub:`02`
- Y'\ :sub:`03`
- Y'\ :sub:`00` * - start0 + 4:
- Y'\ :sub:`10`
- Y'\ :sub:`01` - Y'\ :sub:`11`
- Y'\ :sub:`12`
- Y'\ :sub:`02` - Y'\ :sub:`13`
* - start0 + 8:
- Y'\ :sub:`03` - Y'\ :sub:`20`
- Y'\ :sub:`21`
- .. row 2 - Y'\ :sub:`22`
- Y'\ :sub:`23`
- start0 + 4: * - start0 + 12:
- Y'\ :sub:`30`
- Y'\ :sub:`10` - Y'\ :sub:`31`
- Y'\ :sub:`32`
- Y'\ :sub:`11` - Y'\ :sub:`33`
* -
- Y'\ :sub:`12` * - start1 + 0:
- Cb\ :sub:`00`
- Y'\ :sub:`13` - Cb\ :sub:`01`
- Cb\ :sub:`02`
- .. row 3 - Cb\ :sub:`03`
* - start1 + 4:
- start0 + 8: - Cb\ :sub:`10`
- Cb\ :sub:`11`
- Y'\ :sub:`20` - Cb\ :sub:`12`
- Cb\ :sub:`13`
- Y'\ :sub:`21` * - start1 + 8:
- Cb\ :sub:`20`
- Y'\ :sub:`22` - Cb\ :sub:`21`
- Cb\ :sub:`22`
- Y'\ :sub:`23` - Cb\ :sub:`23`
* - start1 + 12:
- .. row 4 - Cb\ :sub:`20`
- Cb\ :sub:`21`
- start0 + 12: - Cb\ :sub:`32`
- Cb\ :sub:`33`
- Y'\ :sub:`30` * -
* - start2 + 0:
- Y'\ :sub:`31` - Cr\ :sub:`00`
- Cr\ :sub:`01`
- Y'\ :sub:`32` - Cr\ :sub:`02`
- Cr\ :sub:`03`
- Y'\ :sub:`33` * - start2 + 4:
- Cr\ :sub:`10`
- .. row 5 - Cr\ :sub:`11`
- Cr\ :sub:`12`
- - Cr\ :sub:`13`
* - start2 + 8:
- .. row 6 - Cr\ :sub:`20`
- Cr\ :sub:`21`
- start1 + 0: - Cr\ :sub:`22`
- Cr\ :sub:`23`
- Cb\ :sub:`00` * - start2 + 12:
- Cr\ :sub:`30`
- Cb\ :sub:`01` - Cr\ :sub:`31`
- Cr\ :sub:`32`
- Cb\ :sub:`02` - Cr\ :sub:`33`
- Cb\ :sub:`03`
- .. row 7
- start1 + 4:
- Cb\ :sub:`10`
- Cb\ :sub:`11`
- Cb\ :sub:`12`
- Cb\ :sub:`13`
- .. row 8
- start1 + 8:
- Cb\ :sub:`20`
- Cb\ :sub:`21`
- Cb\ :sub:`22`
- Cb\ :sub:`23`
- .. row 9
- start1 + 12:
- Cb\ :sub:`20`
- Cb\ :sub:`21`
- Cb\ :sub:`32`
- Cb\ :sub:`33`
- .. row 10
-
- .. row 11
- start2 + 0:
- Cr\ :sub:`00`
- Cr\ :sub:`01`
- Cr\ :sub:`02`
- Cr\ :sub:`03`
- .. row 12
- start2 + 4:
- Cr\ :sub:`10`
- Cr\ :sub:`11`
- Cr\ :sub:`12`
- Cr\ :sub:`13`
- .. row 13
- start2 + 8:
- Cr\ :sub:`20`
- Cr\ :sub:`21`
- Cr\ :sub:`22`
- Cr\ :sub:`23`
- .. row 14
- start2 + 12:
- Cr\ :sub:`30`
- Cr\ :sub:`31`
- Cr\ :sub:`32`
- Cr\ :sub:`33`
**Color Sample Location..** **Color Sample Location..**
@ -204,62 +114,28 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
- 1
- - 2
- 0 - 3
* - 0
- 1 - YC
- YC
- 2 - YC
- YC
- 3 * - 1
- YC
- .. row 2 - YC
- YC
- 0 - YC
* - 2
- YC - YC
- YC
- YC - YC
- YC
- YC * - 3
- YC
- YC - YC
- YC
- .. row 3 - YC
- 1
- YC
- YC
- YC
- YC
- .. row 4
- 2
- YC
- YC
- YC
- YC
- .. row 5
- 3
- YC
- YC
- YC
- YC

238
Documentation/media/uapi/v4l/pixfmt-yuyv.rst
View File

@ -30,86 +30,42 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Cb\ :sub:`00`
- start + 0: - Y'\ :sub:`01`
- Cr\ :sub:`00`
- Y'\ :sub:`00` - Y'\ :sub:`02`
- Cb\ :sub:`01`
- Cb\ :sub:`00` - Y'\ :sub:`03`
- Cr\ :sub:`01`
- Y'\ :sub:`01` * - start + 8:
- Y'\ :sub:`10`
- Cr\ :sub:`00` - Cb\ :sub:`10`
- Y'\ :sub:`11`
- Y'\ :sub:`02` - Cr\ :sub:`10`
- Y'\ :sub:`12`
- Cb\ :sub:`01` - Cb\ :sub:`11`
- Y'\ :sub:`13`
- Y'\ :sub:`03` - Cr\ :sub:`11`
* - start + 16:
- Cr\ :sub:`01` - Y'\ :sub:`20`
- Cb\ :sub:`20`
- .. row 2 - Y'\ :sub:`21`
- Cr\ :sub:`20`
- start + 8: - Y'\ :sub:`22`
- Cb\ :sub:`21`
- Y'\ :sub:`10` - Y'\ :sub:`23`
- Cr\ :sub:`21`
- Cb\ :sub:`10` * - start + 24:
- Y'\ :sub:`30`
- Y'\ :sub:`11` - Cb\ :sub:`30`
- Y'\ :sub:`31`
- Cr\ :sub:`10` - Cr\ :sub:`30`
- Y'\ :sub:`32`
- Y'\ :sub:`12` - Cb\ :sub:`31`
- Y'\ :sub:`33`
- Cb\ :sub:`11` - Cr\ :sub:`31`
- Y'\ :sub:`13`
- Cr\ :sub:`11`
- .. row 3
- start + 16:
- Y'\ :sub:`20`
- Cb\ :sub:`20`
- Y'\ :sub:`21`
- Cr\ :sub:`20`
- Y'\ :sub:`22`
- Cb\ :sub:`21`
- Y'\ :sub:`23`
- Cr\ :sub:`21`
- .. row 4
- start + 24:
- Y'\ :sub:`30`
- Cb\ :sub:`30`
- Y'\ :sub:`31`
- Cr\ :sub:`30`
- Y'\ :sub:`32`
- Cb\ :sub:`31`
- Y'\ :sub:`33`
- Cr\ :sub:`31`
**Color Sample Location..** **Color Sample Location..**
@ -120,85 +76,43 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 -
- 2
- -
- 1 - 3
* - 0
- - Y
- 2 - C
- Y
- -
- 3 - Y
- C
- .. row 2 - Y
* - 1
- 0 - Y
- C
- Y - Y
-
- C - Y
- C
- Y - Y
* - 2
- - Y
- Y - C
- Y
- C -
- Y
- Y - C
- Y
- .. row 3 * - 3
- Y
- 1 - C
- Y
- Y -
- Y
- C - C
- Y
- Y
-
- Y
- C
- Y
- .. row 4
- 2
- Y
- C
- Y
-
- Y
- C
- Y
- .. row 5
- 3
- Y
- C
- Y
-
- Y
- C
- Y

228
Documentation/media/uapi/v4l/pixfmt-yvyu.rst
View File

@ -27,86 +27,42 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Y'\ :sub:`00`
- Cr\ :sub:`00`
- start + 0: - Y'\ :sub:`01`
- Cb\ :sub:`00`
- Y'\ :sub:`00` - Y'\ :sub:`02`
- Cr\ :sub:`01`
- Cr\ :sub:`00` - Y'\ :sub:`03`
- Cb\ :sub:`01`
- Y'\ :sub:`01` * - start + 8:
- Y'\ :sub:`10`
- Cb\ :sub:`00` - Cr\ :sub:`10`
- Y'\ :sub:`11`
- Y'\ :sub:`02` - Cb\ :sub:`10`
- Y'\ :sub:`12`
- Cr\ :sub:`01` - Cr\ :sub:`11`
- Y'\ :sub:`13`
- Y'\ :sub:`03` - Cb\ :sub:`11`
* - start + 16:
- Cb\ :sub:`01` - Y'\ :sub:`20`
- Cr\ :sub:`20`
- .. row 2 - Y'\ :sub:`21`
- Cb\ :sub:`20`
- start + 8: - Y'\ :sub:`22`
- Cr\ :sub:`21`
- Y'\ :sub:`10` - Y'\ :sub:`23`
- Cb\ :sub:`21`
- Cr\ :sub:`10` * - start + 24:
- Y'\ :sub:`30`
- Y'\ :sub:`11` - Cr\ :sub:`30`
- Y'\ :sub:`31`
- Cb\ :sub:`10` - Cb\ :sub:`30`
- Y'\ :sub:`32`
- Y'\ :sub:`12` - Cr\ :sub:`31`
- Y'\ :sub:`33`
- Cr\ :sub:`11` - Cb\ :sub:`31`
- Y'\ :sub:`13`
- Cb\ :sub:`11`
- .. row 3
- start + 16:
- Y'\ :sub:`20`
- Cr\ :sub:`20`
- Y'\ :sub:`21`
- Cb\ :sub:`20`
- Y'\ :sub:`22`
- Cr\ :sub:`21`
- Y'\ :sub:`23`
- Cb\ :sub:`21`
- .. row 4
- start + 24:
- Y'\ :sub:`30`
- Cr\ :sub:`30`
- Y'\ :sub:`31`
- Cb\ :sub:`30`
- Y'\ :sub:`32`
- Cr\ :sub:`31`
- Y'\ :sub:`33`
- Cb\ :sub:`31`
**Color Sample Location..** **Color Sample Location..**
@ -115,80 +71,38 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - 0
-
- - 1
- 0 - 2
-
- - 3
- 1 * - 0
- Y
- 2 - C
- Y
- - Y
- 3 - C
- Y
- .. row 2 * - 1
- Y
- 0 - C
- Y
- Y - Y
- C
- C - Y
* - 2
- Y - Y
- C
- Y - Y
- Y
- C - C
- Y
- Y * - 3
- Y
- .. row 3 - C
- Y
- 1 - Y
- C
- Y - Y
- C
- Y
- Y
- C
- Y
- .. row 4
- 2
- Y
- C
- Y
- Y
- C
- Y
- .. row 5
- 3
- Y
- C
- Y
- Y
- C
- Y

116
Documentation/media/uapi/v4l/pixfmt-z16.rst
View File

@ -28,83 +28,39 @@ Each cell is one byte.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - start + 0:
- .. row 1 - Z\ :sub:`00low`
- Z\ :sub:`00high`
- start + 0: - Z\ :sub:`01low`
- Z\ :sub:`01high`
- Z\ :sub:`00low` - Z\ :sub:`02low`
- Z\ :sub:`02high`
- Z\ :sub:`00high` - Z\ :sub:`03low`
- Z\ :sub:`03high`
- Z\ :sub:`01low` * - start + 8:
- Z\ :sub:`10low`
- Z\ :sub:`01high` - Z\ :sub:`10high`
- Z\ :sub:`11low`
- Z\ :sub:`02low` - Z\ :sub:`11high`
- Z\ :sub:`12low`
- Z\ :sub:`02high` - Z\ :sub:`12high`
- Z\ :sub:`13low`
- Z\ :sub:`03low` - Z\ :sub:`13high`
* - start + 16:
- Z\ :sub:`03high` - Z\ :sub:`20low`
- Z\ :sub:`20high`
- .. row 2 - Z\ :sub:`21low`
- Z\ :sub:`21high`
- start + 8: - Z\ :sub:`22low`
- Z\ :sub:`22high`
- Z\ :sub:`10low` - Z\ :sub:`23low`
- Z\ :sub:`23high`
- Z\ :sub:`10high` * - start + 24:
- Z\ :sub:`30low`
- Z\ :sub:`11low` - Z\ :sub:`30high`
- Z\ :sub:`31low`
- Z\ :sub:`11high` - Z\ :sub:`31high`
- Z\ :sub:`32low`
- Z\ :sub:`12low` - Z\ :sub:`32high`
- Z\ :sub:`33low`
- Z\ :sub:`12high` - Z\ :sub:`33high`
- Z\ :sub:`13low`
- Z\ :sub:`13high`
- .. row 3
- start + 16:
- Z\ :sub:`20low`
- Z\ :sub:`20high`
- Z\ :sub:`21low`
- Z\ :sub:`21high`
- Z\ :sub:`22low`
- Z\ :sub:`22high`
- Z\ :sub:`23low`
- Z\ :sub:`23high`
- .. row 4
- start + 24:
- Z\ :sub:`30low`
- Z\ :sub:`30high`
- Z\ :sub:`31low`
- Z\ :sub:`31high`
- Z\ :sub:`32low`
- Z\ :sub:`32high`
- Z\ :sub:`33low`
- Z\ :sub:`33high`

18062
Documentation/media/uapi/v4l/subdev-formats.rst
View File

File diff suppressed because it is too large Load Diff

84
Documentation/media/uapi/v4l/v4l2-selection-flags.rst
View File

@ -14,59 +14,31 @@ Selection flags
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Flag name
- .. row 1 - id
- Definition
- Flag name - Valid for V4L2
- Valid for V4L2 subdev
- id * - ``V4L2_SEL_FLAG_GE``
- (1 << 0)
- Definition - Suggest the driver it should choose greater or equal rectangle (in
size) than was requested. Albeit the driver may choose a lesser
- Valid for V4L2 size, it will only do so due to hardware limitations. Without this
flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
- Valid for V4L2 subdev closest possible rectangle.
- Yes
- .. row 2 - Yes
* - ``V4L2_SEL_FLAG_LE``
- ``V4L2_SEL_FLAG_GE`` - (1 << 1)
- Suggest the driver it should choose lesser or equal rectangle (in
- (1 << 0) size) than was requested. Albeit the driver may choose a greater
size, it will only do so due to hardware limitations.
- Suggest the driver it should choose greater or equal rectangle (in - Yes
size) than was requested. Albeit the driver may choose a lesser - Yes
size, it will only do so due to hardware limitations. Without this * - ``V4L2_SEL_FLAG_KEEP_CONFIG``
flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the - (1 << 2)
closest possible rectangle. - The configuration must not be propagated to any further processing
steps. If this flag is not given, the configuration is propagated
- Yes inside the subdevice to all further processing steps.
- No
- Yes - Yes
- .. row 3
- ``V4L2_SEL_FLAG_LE``
- (1 << 1)
- Suggest the driver it should choose lesser or equal rectangle (in
size) than was requested. Albeit the driver may choose a greater
size, it will only do so due to hardware limitations.
- Yes
- Yes
- .. row 4
- ``V4L2_SEL_FLAG_KEEP_CONFIG``
- (1 << 2)
- The configuration must not be propagated to any further processing
steps. If this flag is not given, the configuration is propagated
inside the subdevice to all further processing steps.
- No
- Yes

171
Documentation/media/uapi/v4l/v4l2-selection-targets.rst
View File

@ -18,120 +18,57 @@ of the two interfaces they are used.
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Target name
- .. row 1 - id
- Definition
- Target name - Valid for V4L2
- Valid for V4L2 subdev
- id * - ``V4L2_SEL_TGT_CROP``
- 0x0000
- Definition - Crop rectangle. Defines the cropped area.
- Yes
- Valid for V4L2 - Yes
* - ``V4L2_SEL_TGT_CROP_DEFAULT``
- Valid for V4L2 subdev - 0x0001
- Suggested cropping rectangle that covers the "whole picture".
- .. row 2 - Yes
- No
- ``V4L2_SEL_TGT_CROP`` * - ``V4L2_SEL_TGT_CROP_BOUNDS``
- 0x0002
- 0x0000 - Bounds of the crop rectangle. All valid crop rectangles fit inside
the crop bounds rectangle.
- Crop rectangle. Defines the cropped area. - Yes
- Yes
- Yes * - ``V4L2_SEL_TGT_NATIVE_SIZE``
- 0x0003
- Yes - The native size of the device, e.g. a sensor's pixel array.
``left`` and ``top`` fields are zero for this target. Setting the
- .. row 3 native size will generally only make sense for memory to memory
devices where the software can create a canvas of a given size in
- ``V4L2_SEL_TGT_CROP_DEFAULT`` which for example a video frame can be composed. In that case
V4L2_SEL_TGT_NATIVE_SIZE can be used to configure the size of
- 0x0001 that canvas.
- Yes
- Suggested cropping rectangle that covers the "whole picture". - Yes
* - ``V4L2_SEL_TGT_COMPOSE``
- Yes - 0x0100
- Compose rectangle. Used to configure scaling and composition.
- No - Yes
- Yes
- .. row 4 * - ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
- 0x0101
- ``V4L2_SEL_TGT_CROP_BOUNDS`` - Suggested composition rectangle that covers the "whole picture".
- Yes
- 0x0002 - No
* - ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
- Bounds of the crop rectangle. All valid crop rectangles fit inside - 0x0102
the crop bounds rectangle. - Bounds of the compose rectangle. All valid compose rectangles fit
inside the compose bounds rectangle.
- Yes - Yes
- Yes
- Yes * - ``V4L2_SEL_TGT_COMPOSE_PADDED``
- 0x0103
- .. row 5 - The active area and all padding pixels that are inserted or
modified by hardware.
- ``V4L2_SEL_TGT_NATIVE_SIZE`` - Yes
- No
- 0x0003
- The native size of the device, e.g. a sensor's pixel array.
``left`` and ``top`` fields are zero for this target. Setting the
native size will generally only make sense for memory to memory
devices where the software can create a canvas of a given size in
which for example a video frame can be composed. In that case
V4L2_SEL_TGT_NATIVE_SIZE can be used to configure the size of
that canvas.
- Yes
- Yes
- .. row 6
- ``V4L2_SEL_TGT_COMPOSE``
- 0x0100
- Compose rectangle. Used to configure scaling and composition.
- Yes
- Yes
- .. row 7
- ``V4L2_SEL_TGT_COMPOSE_DEFAULT``
- 0x0101
- Suggested composition rectangle that covers the "whole picture".
- Yes
- No
- .. row 8
- ``V4L2_SEL_TGT_COMPOSE_BOUNDS``
- 0x0102
- Bounds of the compose rectangle. All valid compose rectangles fit
inside the compose bounds rectangle.
- Yes
- Yes
- .. row 9
- ``V4L2_SEL_TGT_COMPOSE_PADDED``
- 0x0103
- The active area and all padding pixels that are inserted or
modified by hardware.
- Yes
- No

73
Documentation/media/uapi/v4l/vidioc-create-bufs.rst
View File

@ -80,55 +80,30 @@ than the number requested.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``index``
- The starting buffer index, returned by the driver.
- __u32 * - __u32
- ``count``
- ``index`` - The number of buffers requested or granted. If count == 0, then
:ref:`VIDIOC_CREATE_BUFS` will set ``index`` to the current number of
- The starting buffer index, returned by the driver. created buffers, and it will check the validity of ``memory`` and
``format.type``. If those are invalid -1 is returned and errno is
- .. row 2 set to ``EINVAL`` error code, otherwise :ref:`VIDIOC_CREATE_BUFS` returns
0. It will never set errno to ``EBUSY`` error code in this particular
- __u32 case.
* - __u32
- ``count`` - ``memory``
- Applications set this field to ``V4L2_MEMORY_MMAP``,
- The number of buffers requested or granted. If count == 0, then ``V4L2_MEMORY_DMABUF`` or ``V4L2_MEMORY_USERPTR``. See
:ref:`VIDIOC_CREATE_BUFS` will set ``index`` to the current number of :c:type:`v4l2_memory`
created buffers, and it will check the validity of ``memory`` and * - struct :c:type:`v4l2_format`
``format.type``. If those are invalid -1 is returned and errno is - ``format``
set to ``EINVAL`` error code, otherwise :ref:`VIDIOC_CREATE_BUFS` returns - Filled in by the application, preserved by the driver.
0. It will never set errno to ``EBUSY`` error code in this particular * - __u32
case. - ``reserved``\ [8]
- A place holder for future extensions. Drivers and applications
- .. row 3 must set the array to zero.
- __u32
- ``memory``
- Applications set this field to ``V4L2_MEMORY_MMAP``,
``V4L2_MEMORY_DMABUF`` or ``V4L2_MEMORY_USERPTR``. See
:c:type:`v4l2_memory`
- .. row 4
- struct :c:type:`v4l2_format`
- ``format``
- Filled in by the application, preserved by the driver.
- .. row 5
- __u32
- ``reserved``\ [8]
- A place holder for future extensions. Drivers and applications
must set the array to zero.
Return Value Return Value

126
Documentation/media/uapi/v4l/vidioc-cropcap.rst
View File

@ -59,56 +59,36 @@ overlay devices.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- ``type``
- Type of the data stream, set by the application. Only these types
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` and
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
* - struct :ref:`v4l2_rect <v4l2-rect-crop>`
- ``bounds``
- Defines the window within capturing or output is possible, this
may exclude for example the horizontal and vertical blanking
areas. The cropping rectangle cannot exceed these limits. Width
and height are defined in pixels, the driver writer is free to
choose origin and units of the coordinate system in the analog
domain.
* - struct :ref:`v4l2_rect <v4l2-rect-crop>`
- ``defrect``
- Default cropping rectangle, it shall cover the "whole picture".
Assuming pixel aspect 1/1 this could be for example a 640 × 480
rectangle for NTSC, a 768 × 576 rectangle for PAL and SECAM
centered over the active picture area. The same co-ordinate system
as for ``bounds`` is used.
* - struct :c:type:`v4l2_fract`
- ``pixelaspect``
- This is the pixel aspect (y / x) when no scaling is applied, the
ratio of the actual sampling frequency and the frequency required
to get square pixels.
- .. row 1 When cropping coordinates refer to square pixels, the driver sets
``pixelaspect`` to 1/1. Other common values are 54/59 for PAL and
- __u32 SECAM, 11/10 for NTSC sampled according to [:ref:`itu601`].
- ``type``
- Type of the data stream, set by the application. Only these types
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` and
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
- .. row 2
- struct :ref:`v4l2_rect <v4l2-rect-crop>`
- ``bounds``
- Defines the window within capturing or output is possible, this
may exclude for example the horizontal and vertical blanking
areas. The cropping rectangle cannot exceed these limits. Width
and height are defined in pixels, the driver writer is free to
choose origin and units of the coordinate system in the analog
domain.
- .. row 3
- struct :ref:`v4l2_rect <v4l2-rect-crop>`
- ``defrect``
- Default cropping rectangle, it shall cover the "whole picture".
Assuming pixel aspect 1/1 this could be for example a 640 × 480
rectangle for NTSC, a 768 × 576 rectangle for PAL and SECAM
centered over the active picture area. The same co-ordinate system
as for ``bounds`` is used.
- .. row 4
- struct :c:type:`v4l2_fract`
- ``pixelaspect``
- This is the pixel aspect (y / x) when no scaling is applied, the
ratio of the actual sampling frequency and the frequency required
to get square pixels.
When cropping coordinates refer to square pixels, the driver sets
``pixelaspect`` to 1/1. Other common values are 54/59 for PAL and
SECAM, 11/10 for NTSC sampled according to [:ref:`itu601`].
@ -121,40 +101,20 @@ overlay devices.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __s32
- .. row 1 - ``left``
- Horizontal offset of the top, left corner of the rectangle, in
- __s32 pixels.
* - __s32
- ``left`` - ``top``
- Vertical offset of the top, left corner of the rectangle, in
- Horizontal offset of the top, left corner of the rectangle, in pixels.
pixels. * - __u32
- ``width``
- .. row 2 - Width of the rectangle, in pixels.
* - __u32
- __s32 - ``height``
- Height of the rectangle, in pixels.
- ``top``
- Vertical offset of the top, left corner of the rectangle, in
pixels.
- .. row 3
- __u32
- ``width``
- Width of the rectangle, in pixels.
- .. row 4
- __u32
- ``height``
- Height of the rectangle, in pixels.
Return Value Return Value

123
Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst
View File

@ -85,40 +85,21 @@ instructions.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 2 :widths: 1 1 1 2
* - __u32
- .. row 1 - ``type``
- See :ref:`name-chip-match-types` for a list of possible types.
- __u32 * - union
- (anonymous)
- ``type`` * -
- __u32
- See :ref:`name-chip-match-types` for a list of possible types. - ``addr``
- Match a chip by this number, interpreted according to the ``type``
- .. row 2 field.
* -
- union - char
- ``name[32]``
- (anonymous) - Match a chip by this name, interpreted according to the ``type``
field. Currently unused.
- .. row 3
-
- __u32
- ``addr``
- Match a chip by this number, interpreted according to the ``type``
field.
- .. row 4
-
- char
- ``name[32]``
- Match a chip by this name, interpreted according to the ``type``
field. Currently unused.
@ -131,41 +112,21 @@ instructions.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - struct v4l2_dbg_match
- .. row 1 - ``match``
- How to match the chip, see :ref:`name-v4l2-dbg-match`.
- struct v4l2_dbg_match * - char
- ``name[32]``
- ``match`` - The name of the chip.
* - __u32
- How to match the chip, see :ref:`name-v4l2-dbg-match`. - ``flags``
- Set by the driver. If ``V4L2_CHIP_FL_READABLE`` is set, then the
- .. row 2 driver supports reading registers from the device. If
``V4L2_CHIP_FL_WRITABLE`` is set, then it supports writing
- char registers.
* - __u32
- ``name[32]`` - ``reserved[8]``
- Reserved fields, both application and driver must set these to 0.
- The name of the chip.
- .. row 3
- __u32
- ``flags``
- Set by the driver. If ``V4L2_CHIP_FL_READABLE`` is set, then the
driver supports reading registers from the device. If
``V4L2_CHIP_FL_WRITABLE`` is set, then it supports writing
registers.
- .. row 4
- __u32
- ``reserved[8]``
- Reserved fields, both application and driver must set these to 0.
@ -178,23 +139,13 @@ instructions.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_CHIP_MATCH_BRIDGE``
- .. row 1 - 0
- Match the nth chip on the card, zero for the bridge chip. Does not
- ``V4L2_CHIP_MATCH_BRIDGE`` match sub-devices.
* - ``V4L2_CHIP_MATCH_SUBDEV``
- 0 - 4
- Match the nth sub-device.
- Match the nth chip on the card, zero for the bridge chip. Does not
match sub-devices.
- .. row 2
- ``V4L2_CHIP_MATCH_SUBDEV``
- 4
- Match the nth sub-device.
Return Value Return Value

117
Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst
View File

@ -94,40 +94,21 @@ instructions.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 2 :widths: 1 1 1 2
* - __u32
- .. row 1 - ``type``
- See :ref:`chip-match-types` for a list of possible types.
- __u32 * - union
- (anonymous)
- ``type`` * -
- __u32
- See :ref:`chip-match-types` for a list of possible types. - ``addr``
- Match a chip by this number, interpreted according to the ``type``
- .. row 2 field.
* -
- union - char
- ``name[32]``
- (anonymous) - Match a chip by this name, interpreted according to the ``type``
field. Currently unused.
- .. row 3
-
- __u32
- ``addr``
- Match a chip by this number, interpreted according to the ``type``
field.
- .. row 4
-
- char
- ``name[32]``
- Match a chip by this name, interpreted according to the ``type``
field. Currently unused.
@ -137,38 +118,18 @@ instructions.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - struct v4l2_dbg_match
- .. row 1 - ``match``
- How to match the chip, see :c:type:`v4l2_dbg_match`.
- struct v4l2_dbg_match * - __u32
- ``size``
- ``match`` - The register size in bytes.
* - __u64
- How to match the chip, see :c:type:`v4l2_dbg_match`. - ``reg``
- A register number.
- .. row 2 * - __u64
- ``val``
- __u32 - The value read from, or to be written into the register.
- ``size``
- The register size in bytes.
- .. row 3
- __u64
- ``reg``
- A register number.
- .. row 4
- __u64
- ``val``
- The value read from, or to be written into the register.
@ -181,23 +142,13 @@ instructions.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_CHIP_MATCH_BRIDGE``
- .. row 1 - 0
- Match the nth chip on the card, zero for the bridge chip. Does not
- ``V4L2_CHIP_MATCH_BRIDGE`` match sub-devices.
* - ``V4L2_CHIP_MATCH_SUBDEV``
- 0 - 4
- Match the nth sub-device.
- Match the nth chip on the card, zero for the bridge chip. Does not
match sub-devices.
- .. row 2
- ``V4L2_CHIP_MATCH_SUBDEV``
- 4
- Match the nth sub-device.
Return Value Return Value

292
Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst
View File

@ -70,125 +70,75 @@ introduced in Linux 3.3.
:stub-columns: 0 :stub-columns: 0
:widths: 11 24 12 16 106 :widths: 11 24 12 16 106
* - __u32
- .. row 1 - ``cmd``
-
- __u32 -
- The decoder command, see :ref:`decoder-cmds`.
- ``cmd`` * - __u32
- ``flags``
- -
- -
- The decoder command, see :ref:`decoder-cmds`. - Flags to go with the command. If no flags are defined for this
command, drivers and applications must set this field to zero.
- .. row 2 * - union
- (anonymous)
- __u32 -
-
- ``flags`` -
* -
- - struct
- - ``start``
- Flags to go with the command. If no flags are defined for this -
command, drivers and applications must set this field to zero. - Structure containing additional data for the
``V4L2_DEC_CMD_START`` command.
- .. row 3 * -
-
- union - __s32
- ``speed``
- (anonymous) - Playback speed and direction. The playback speed is defined as
``speed``/1000 of the normal speed. So 1000 is normal playback.
- Negative numbers denote reverse playback, so -1000 does reverse
- playback at normal speed. Speeds -1, 0 and 1 have special
- meanings: speed 0 is shorthand for 1000 (normal playback). A speed
of 1 steps just one frame forward, a speed of -1 steps just one
- .. row 4 frame back.
* -
- -
- struct - __u32
- ``format``
- ``start`` - Format restrictions. This field is set by the driver, not the
application. Possible values are ``V4L2_DEC_START_FMT_NONE`` if
- there are no format restrictions or ``V4L2_DEC_START_FMT_GOP`` if
- Structure containing additional data for the the decoder operates on full GOPs (*Group Of Pictures*). This is
``V4L2_DEC_CMD_START`` command. usually the case for reverse playback: the decoder needs full
GOPs, which it can then play in reverse order. So to implement
- .. row 5 reverse playback the application must feed the decoder the last
GOP in the video file, then the GOP before that, etc. etc.
- * -
- - struct
- __s32 - ``stop``
-
- ``speed`` - Structure containing additional data for the ``V4L2_DEC_CMD_STOP``
command.
- Playback speed and direction. The playback speed is defined as * -
``speed``/1000 of the normal speed. So 1000 is normal playback. -
Negative numbers denote reverse playback, so -1000 does reverse - __u64
playback at normal speed. Speeds -1, 0 and 1 have special - ``pts``
meanings: speed 0 is shorthand for 1000 (normal playback). A speed - Stop playback at this ``pts`` or immediately if the playback is
of 1 steps just one frame forward, a speed of -1 steps just one already past that timestamp. Leave to 0 if you want to stop after
frame back. the last frame was decoded.
* -
- .. row 6 - struct
- ``raw``
- -
- -
- __u32 * -
-
- ``format`` - __u32
- ``data``\ [16]
- Format restrictions. This field is set by the driver, not the - Reserved for future extensions. Drivers and applications must set
application. Possible values are ``V4L2_DEC_START_FMT_NONE`` if the array to zero.
there are no format restrictions or ``V4L2_DEC_START_FMT_GOP`` if
the decoder operates on full GOPs (*Group Of Pictures*). This is
usually the case for reverse playback: the decoder needs full
GOPs, which it can then play in reverse order. So to implement
reverse playback the application must feed the decoder the last
GOP in the video file, then the GOP before that, etc. etc.
- .. row 7
-
- struct
- ``stop``
-
- Structure containing additional data for the ``V4L2_DEC_CMD_STOP``
command.
- .. row 8
-
-
- __u64
- ``pts``
- Stop playback at this ``pts`` or immediately if the playback is
already past that timestamp. Leave to 0 if you want to stop after
the last frame was decoded.
- .. row 9
-
- struct
- ``raw``
-
-
- .. row 10
-
-
- __u32
- ``data``\ [16]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
@ -201,68 +151,48 @@ introduced in Linux 3.3.
:stub-columns: 0 :stub-columns: 0
:widths: 56 6 113 :widths: 56 6 113
* - ``V4L2_DEC_CMD_START``
- .. row 1 - 0
- Start the decoder. When the decoder is already running or paused,
- ``V4L2_DEC_CMD_START`` this command will just change the playback speed. That means that
calling ``V4L2_DEC_CMD_START`` when the decoder was paused will
- 0 *not* resume the decoder. You have to explicitly call
``V4L2_DEC_CMD_RESUME`` for that. This command has one flag:
- Start the decoder. When the decoder is already running or paused, ``V4L2_DEC_CMD_START_MUTE_AUDIO``. If set, then audio will be
this command will just change the playback speed. That means that muted when playing back at a non-standard speed.
calling ``V4L2_DEC_CMD_START`` when the decoder was paused will * - ``V4L2_DEC_CMD_STOP``
*not* resume the decoder. You have to explicitly call - 1
``V4L2_DEC_CMD_RESUME`` for that. This command has one flag: - Stop the decoder. When the decoder is already stopped, this
``V4L2_DEC_CMD_START_MUTE_AUDIO``. If set, then audio will be command does nothing. This command has two flags: if
muted when playing back at a non-standard speed. ``V4L2_DEC_CMD_STOP_TO_BLACK`` is set, then the decoder will set
the picture to black after it stopped decoding. Otherwise the last
- .. row 2 image will repeat. mem2mem decoders will stop producing new frames
altogether. They will send a ``V4L2_EVENT_EOS`` event when the
- ``V4L2_DEC_CMD_STOP`` last frame has been decoded and all frames are ready to be
dequeued and will set the ``V4L2_BUF_FLAG_LAST`` buffer flag on
- 1 the last buffer of the capture queue to indicate there will be no
new buffers produced to dequeue. This buffer may be empty,
- Stop the decoder. When the decoder is already stopped, this indicated by the driver setting the ``bytesused`` field to 0. Once
command does nothing. This command has two flags: if the ``V4L2_BUF_FLAG_LAST`` flag was set, the
``V4L2_DEC_CMD_STOP_TO_BLACK`` is set, then the decoder will set :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
the picture to black after it stopped decoding. Otherwise the last but return an ``EPIPE`` error code. If
image will repeat. mem2mem decoders will stop producing new frames ``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops
altogether. They will send a ``V4L2_EVENT_EOS`` event when the immediately (ignoring the ``pts`` value), otherwise it will keep
last frame has been decoded and all frames are ready to be decoding until timestamp >= pts or until the last of the pending
dequeued and will set the ``V4L2_BUF_FLAG_LAST`` buffer flag on data from its internal buffers was decoded.
the last buffer of the capture queue to indicate there will be no * - ``V4L2_DEC_CMD_PAUSE``
new buffers produced to dequeue. This buffer may be empty, - 2
indicated by the driver setting the ``bytesused`` field to 0. Once - Pause the decoder. When the decoder has not been started yet, the
the ``V4L2_BUF_FLAG_LAST`` flag was set, the driver will return an ``EPERM`` error code. When the decoder is
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore, already paused, this command does nothing. This command has one
but return an ``EPIPE`` error code. If flag: if ``V4L2_DEC_CMD_PAUSE_TO_BLACK`` is set, then set the
``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops decoder output to black when paused.
immediately (ignoring the ``pts`` value), otherwise it will keep * - ``V4L2_DEC_CMD_RESUME``
decoding until timestamp >= pts or until the last of the pending - 3
data from its internal buffers was decoded. - Resume decoding after a PAUSE command. When the decoder has not
been started yet, the driver will return an ``EPERM`` error code. When
- .. row 3 the decoder is already running, this command does nothing. No
flags are defined for this command.
- ``V4L2_DEC_CMD_PAUSE``
- 2
- Pause the decoder. When the decoder has not been started yet, the
driver will return an ``EPERM`` error code. When the decoder is
already paused, this command does nothing. This command has one
flag: if ``V4L2_DEC_CMD_PAUSE_TO_BLACK`` is set, then set the
decoder output to black when paused.
- .. row 4
- ``V4L2_DEC_CMD_RESUME``
- 3
- Resume decoding after a PAUSE command. When the decoder has not
been started yet, the driver will return an ``EPERM`` error code. When
the decoder is already running, this command does nothing. No
flags are defined for this command.
Return Value Return Value

660
Documentation/media/uapi/v4l/vidioc-dqevent.rst
View File

@ -49,131 +49,66 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 :widths: 1 1 2 1
* - __u32
- .. row 1 - ``type``
-
- __u32 - Type of the event, see :ref:`event-type`.
* - union
- ``type`` - ``u``
-
- -
- Type of the event, see :ref:`event-type`. * -
- struct :c:type:`v4l2_event_vsync`
- .. row 2 - ``vsync``
- Event data for event ``V4L2_EVENT_VSYNC``.
- union * -
- struct :c:type:`v4l2_event_ctrl`
- ``u`` - ``ctrl``
- Event data for event ``V4L2_EVENT_CTRL``.
- * -
- - struct :c:type:`v4l2_event_frame_sync`
- ``frame_sync``
- .. row 3 - Event data for event ``V4L2_EVENT_FRAME_SYNC``.
* -
- - struct :c:type:`v4l2_event_motion_det`
- struct :c:type:`v4l2_event_vsync` - ``motion_det``
- Event data for event V4L2_EVENT_MOTION_DET.
- ``vsync`` * -
- struct :c:type:`v4l2_event_src_change`
- Event data for event ``V4L2_EVENT_VSYNC``. - ``src_change``
- Event data for event V4L2_EVENT_SOURCE_CHANGE.
- .. row 4 * -
- __u8
- - ``data``\ [64]
- struct :c:type:`v4l2_event_ctrl` - Event data. Defined by the event type. The union should be used to
define easily accessible type for events.
- ``ctrl`` * - __u32
- ``pending``
- Event data for event ``V4L2_EVENT_CTRL``. -
- Number of pending events excluding this one.
- .. row 5 * - __u32
- ``sequence``
- -
- struct :c:type:`v4l2_event_frame_sync` - Event sequence number. The sequence number is incremented for
every subscribed event that takes place. If sequence numbers are
- ``frame_sync`` not contiguous it means that events have been lost.
* - struct timespec
- Event data for event ``V4L2_EVENT_FRAME_SYNC``. - ``timestamp``
-
- .. row 6 - Event timestamp. The timestamp has been taken from the
``CLOCK_MONOTONIC`` clock. To access the same clock outside V4L2,
- use :c:func:`clock_gettime`.
- struct :c:type:`v4l2_event_motion_det` * - u32
- ``id``
- ``motion_det`` -
- The ID associated with the event source. If the event does not
- Event data for event V4L2_EVENT_MOTION_DET. have an associated ID (this depends on the event type), then this
is 0.
- .. row 7 * - __u32
- ``reserved``\ [8]
- -
- struct :c:type:`v4l2_event_src_change` - Reserved for future extensions. Drivers must set the array to
zero.
- ``src_change``
- Event data for event V4L2_EVENT_SOURCE_CHANGE.
- .. row 8
-
- __u8
- ``data``\ [64]
- Event data. Defined by the event type. The union should be used to
define easily accessible type for events.
- .. row 9
- __u32
- ``pending``
-
- Number of pending events excluding this one.
- .. row 10
- __u32
- ``sequence``
-
- Event sequence number. The sequence number is incremented for
every subscribed event that takes place. If sequence numbers are
not contiguous it means that events have been lost.
- .. row 11
- struct timespec
- ``timestamp``
-
- Event timestamp. The timestamp has been taken from the
``CLOCK_MONOTONIC`` clock. To access the same clock outside V4L2,
use :c:func:`clock_gettime`.
- .. row 12
- u32
- ``id``
-
- The ID associated with the event source. If the event does not
have an associated ID (this depends on the event type), then this
is 0.
- .. row 13
- __u32
- ``reserved``\ [8]
-
- Reserved for future extensions. Drivers must set the array to
zero.
@ -188,123 +123,83 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_EVENT_ALL``
- 0
- All events. V4L2_EVENT_ALL is valid only for
VIDIOC_UNSUBSCRIBE_EVENT for unsubscribing all events at once.
* - ``V4L2_EVENT_VSYNC``
- 1
- This event is triggered on the vertical sync. This event has a
struct :c:type:`v4l2_event_vsync` associated
with it.
* - ``V4L2_EVENT_EOS``
- 2
- This event is triggered when the end of a stream is reached. This
is typically used with MPEG decoders to report to the application
when the last of the MPEG stream has been decoded.
* - ``V4L2_EVENT_CTRL``
- 3
- This event requires that the ``id`` matches the control ID from
which you want to receive events. This event is triggered if the
control's value changes, if a button control is pressed or if the
control's flags change. This event has a struct
:c:type:`v4l2_event_ctrl` associated with it.
This struct contains much of the same information as struct
:ref:`v4l2_queryctrl <v4l2-queryctrl>` and struct
:c:type:`v4l2_control`.
- .. row 1 If the event is generated due to a call to
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` or
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`, then the
event will *not* be sent to the file handle that called the ioctl
function. This prevents nasty feedback loops. If you *do* want to
get the event, then set the ``V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK``
flag.
- ``V4L2_EVENT_ALL`` This event type will ensure that no information is lost when more
events are raised than there is room internally. In that case the
struct :c:type:`v4l2_event_ctrl` of the
second-oldest event is kept, but the ``changes`` field of the
second-oldest event is ORed with the ``changes`` field of the
oldest event.
* - ``V4L2_EVENT_FRAME_SYNC``
- 4
- Triggered immediately when the reception of a frame has begun.
This event has a struct
:c:type:`v4l2_event_frame_sync`
associated with it.
- 0 If the hardware needs to be stopped in the case of a buffer
underrun it might not be able to generate this event. In such
cases the ``frame_sequence`` field in struct
:c:type:`v4l2_event_frame_sync` will not
be incremented. This causes two consecutive frame sequence numbers
to have n times frame interval in between them.
* - ``V4L2_EVENT_SOURCE_CHANGE``
- 5
- This event is triggered when a source parameter change is detected
during runtime by the video device. It can be a runtime resolution
change triggered by a video decoder or the format change happening
on an input connector. This event requires that the ``id`` matches
the input index (when used with a video device node) or the pad
index (when used with a subdevice node) from which you want to
receive events.
- All events. V4L2_EVENT_ALL is valid only for This event has a struct
VIDIOC_UNSUBSCRIBE_EVENT for unsubscribing all events at once. :c:type:`v4l2_event_src_change`
associated with it. The ``changes`` bitfield denotes what has
- .. row 2 changed for the subscribed pad. If multiple events occurred before
application could dequeue them, then the changes will have the
- ``V4L2_EVENT_VSYNC`` ORed value of all the events generated.
* - ``V4L2_EVENT_MOTION_DET``
- 1 - 6
- Triggered whenever the motion detection state for one or more of
- This event is triggered on the vertical sync. This event has a the regions changes. This event has a struct
struct :c:type:`v4l2_event_vsync` associated :c:type:`v4l2_event_motion_det`
with it. associated with it.
* - ``V4L2_EVENT_PRIVATE_START``
- .. row 3 - 0x08000000
- Base event number for driver-private events.
- ``V4L2_EVENT_EOS``
- 2
- This event is triggered when the end of a stream is reached. This
is typically used with MPEG decoders to report to the application
when the last of the MPEG stream has been decoded.
- .. row 4
- ``V4L2_EVENT_CTRL``
- 3
- This event requires that the ``id`` matches the control ID from
which you want to receive events. This event is triggered if the
control's value changes, if a button control is pressed or if the
control's flags change. This event has a struct
:c:type:`v4l2_event_ctrl` associated with it.
This struct contains much of the same information as struct
:ref:`v4l2_queryctrl <v4l2-queryctrl>` and struct
:c:type:`v4l2_control`.
If the event is generated due to a call to
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` or
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`, then the
event will *not* be sent to the file handle that called the ioctl
function. This prevents nasty feedback loops. If you *do* want to
get the event, then set the ``V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK``
flag.
This event type will ensure that no information is lost when more
events are raised than there is room internally. In that case the
struct :c:type:`v4l2_event_ctrl` of the
second-oldest event is kept, but the ``changes`` field of the
second-oldest event is ORed with the ``changes`` field of the
oldest event.
- .. row 5
- ``V4L2_EVENT_FRAME_SYNC``
- 4
- Triggered immediately when the reception of a frame has begun.
This event has a struct
:c:type:`v4l2_event_frame_sync`
associated with it.
If the hardware needs to be stopped in the case of a buffer
underrun it might not be able to generate this event. In such
cases the ``frame_sequence`` field in struct
:c:type:`v4l2_event_frame_sync` will not
be incremented. This causes two consecutive frame sequence numbers
to have n times frame interval in between them.
- .. row 6
- ``V4L2_EVENT_SOURCE_CHANGE``
- 5
- This event is triggered when a source parameter change is detected
during runtime by the video device. It can be a runtime resolution
change triggered by a video decoder or the format change happening
on an input connector. This event requires that the ``id`` matches
the input index (when used with a video device node) or the pad
index (when used with a subdevice node) from which you want to
receive events.
This event has a struct
:c:type:`v4l2_event_src_change`
associated with it. The ``changes`` bitfield denotes what has
changed for the subscribed pad. If multiple events occurred before
application could dequeue them, then the changes will have the
ORed value of all the events generated.
- .. row 7
- ``V4L2_EVENT_MOTION_DET``
- 6
- Triggered whenever the motion detection state for one or more of
the regions changes. This event has a struct
:c:type:`v4l2_event_motion_det`
associated with it.
- .. row 8
- ``V4L2_EVENT_PRIVATE_START``
- 0x08000000
- Base event number for driver-private events.
@ -317,14 +212,9 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u8
- .. row 1 - ``field``
- The upcoming field. See enum :c:type:`v4l2_field`.
- __u8
- ``field``
- The upcoming field. See enum :c:type:`v4l2_field`.
@ -337,103 +227,54 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 :widths: 1 1 2 1
* - __u32
- .. row 1 - ``changes``
-
- __u32 - A bitmask that tells what has changed. See
:ref:`ctrl-changes-flags`.
- ``changes`` * - __u32
- ``type``
- -
- A bitmask that tells what has changed. See - The type of the control. See enum
:ref:`ctrl-changes-flags`. :c:type:`v4l2_ctrl_type`.
* - union (anonymous)
- .. row 2 -
-
- __u32 -
* -
- ``type`` - __s32
- ``value``
- - The 32-bit value of the control for 32-bit control types. This is
- The type of the control. See enum 0 for string controls since the value of a string cannot be passed
:c:type:`v4l2_ctrl_type`. using :ref:`VIDIOC_DQEVENT`.
* -
- .. row 3 - __s64
- ``value64``
- union (anonymous) - The 64-bit value of the control for 64-bit control types.
* - __u32
- - ``flags``
- -
- - The control flags. See :ref:`control-flags`.
* - __s32
- .. row 4 - ``minimum``
-
- - The minimum value of the control. See struct
- __s32 :ref:`v4l2_queryctrl <v4l2-queryctrl>`.
* - __s32
- ``value`` - ``maximum``
-
- The 32-bit value of the control for 32-bit control types. This is - The maximum value of the control. See struct
0 for string controls since the value of a string cannot be passed :ref:`v4l2_queryctrl <v4l2-queryctrl>`.
using :ref:`VIDIOC_DQEVENT`. * - __s32
- ``step``
- .. row 5 -
- The step value of the control. See struct
- :ref:`v4l2_queryctrl <v4l2-queryctrl>`.
- __s64 * - __s32
- ``default_value``
- ``value64`` -
- The default value value of the control. See struct
- The 64-bit value of the control for 64-bit control types. :ref:`v4l2_queryctrl <v4l2-queryctrl>`.
- .. row 6
- __u32
- ``flags``
-
- The control flags. See :ref:`control-flags`.
- .. row 7
- __s32
- ``minimum``
-
- The minimum value of the control. See struct
:ref:`v4l2_queryctrl <v4l2-queryctrl>`.
- .. row 8
- __s32
- ``maximum``
-
- The maximum value of the control. See struct
:ref:`v4l2_queryctrl <v4l2-queryctrl>`.
- .. row 9
- __s32
- ``step``
-
- The step value of the control. See struct
:ref:`v4l2_queryctrl <v4l2-queryctrl>`.
- .. row 10
- __s32
- ``default_value``
-
- The default value value of the control. See struct
:ref:`v4l2_queryctrl <v4l2-queryctrl>`.
@ -446,14 +287,9 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``frame_sequence``
- The sequence number of the frame being received.
- __u32
- ``frame_sequence``
- The sequence number of the frame being received.
@ -466,15 +302,10 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``changes``
- A bitmask that tells what has changed. See
- __u32 :ref:`src-changes-flags`.
- ``changes``
- A bitmask that tells what has changed. See
:ref:`src-changes-flags`.
@ -487,39 +318,24 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``flags``
- Currently only one flag is available: if
- __u32 ``V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ`` is set, then the
``frame_sequence`` field is valid, otherwise that field should be
- ``flags`` ignored.
* - __u32
- Currently only one flag is available: if - ``frame_sequence``
``V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ`` is set, then the - The sequence number of the frame being received. Only valid if the
``frame_sequence`` field is valid, otherwise that field should be ``V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ`` flag was set.
ignored. * - __u32
- ``region_mask``
- .. row 2 - The bitmask of the regions that reported motion. There is at least
one region. If this field is 0, then no motion was detected at
- __u32 all. If there is no ``V4L2_CID_DETECT_MD_REGION_GRID`` control
(see :ref:`detect-controls`) to assign a different region to
- ``frame_sequence`` each cell in the motion detection grid, then that all cells are
automatically assigned to the default region 0.
- The sequence number of the frame being received. Only valid if the
``V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ`` flag was set.
- .. row 3
- __u32
- ``region_mask``
- The bitmask of the regions that reported motion. There is at least
one region. If this field is 0, then no motion was detected at
all. If there is no ``V4L2_CID_DETECT_MD_REGION_GRID`` control
(see :ref:`detect-controls`) to assign a different region to
each cell in the motion detection grid, then that all cells are
automatically assigned to the default region 0.
@ -532,35 +348,20 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_EVENT_CTRL_CH_VALUE``
- .. row 1 - 0x0001
- This control event was triggered because the value of the control
- ``V4L2_EVENT_CTRL_CH_VALUE`` changed. Special cases: Volatile controls do no generate this
event; If a control has the ``V4L2_CTRL_FLAG_EXECUTE_ON_WRITE``
- 0x0001 flag set, then this event is sent as well, regardless its value.
* - ``V4L2_EVENT_CTRL_CH_FLAGS``
- This control event was triggered because the value of the control - 0x0002
changed. Special cases: Volatile controls do no generate this - This control event was triggered because the control flags
event; If a control has the ``V4L2_CTRL_FLAG_EXECUTE_ON_WRITE`` changed.
flag set, then this event is sent as well, regardless its value. * - ``V4L2_EVENT_CTRL_CH_RANGE``
- 0x0004
- .. row 2 - This control event was triggered because the minimum, maximum,
step or the default value of the control changed.
- ``V4L2_EVENT_CTRL_CH_FLAGS``
- 0x0002
- This control event was triggered because the control flags
changed.
- .. row 3
- ``V4L2_EVENT_CTRL_CH_RANGE``
- 0x0004
- This control event was triggered because the minimum, maximum,
step or the default value of the control changed.
@ -573,16 +374,11 @@ call.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_EVENT_SRC_CH_RESOLUTION``
- .. row 1 - 0x0001
- This event gets triggered when a resolution change is detected at
- ``V4L2_EVENT_SRC_CH_RESOLUTION`` an input. This can come from an input connector or from a video
decoder.
- 0x0001
- This event gets triggered when a resolution change is detected at
an input. This can come from an input connector or from a video
decoder.
Return Value Return Value

231
Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst
View File

@ -64,81 +64,36 @@ that doesn't support them will return an ``EINVAL`` error code.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``min_width``
- Minimum width of the active video in pixels.
- __u32 * - __u32
- ``max_width``
- ``min_width`` - Maximum width of the active video in pixels.
* - __u32
- Minimum width of the active video in pixels. - ``min_height``
- Minimum height of the active video in lines.
- .. row 2 * - __u32
- ``max_height``
- __u32 - Maximum height of the active video in lines.
* - __u64
- ``max_width`` - ``min_pixelclock``
- Minimum pixelclock frequency in Hz.
- Maximum width of the active video in pixels. * - __u64
- ``max_pixelclock``
- .. row 3 - Maximum pixelclock frequency in Hz.
* - __u32
- __u32 - ``standards``
- The video standard(s) supported by the hardware. See
- ``min_height`` :ref:`dv-bt-standards` for a list of standards.
* - __u32
- Minimum height of the active video in lines. - ``capabilities``
- Several flags giving more information about the capabilities. See
- .. row 4 :ref:`dv-bt-cap-capabilities` for a description of the flags.
* - __u32
- __u32 - ``reserved``\ [16]
- Reserved for future extensions.
- ``max_height`` Drivers must set the array to zero.
- Maximum height of the active video in lines.
- .. row 5
- __u64
- ``min_pixelclock``
- Minimum pixelclock frequency in Hz.
- .. row 6
- __u64
- ``max_pixelclock``
- Maximum pixelclock frequency in Hz.
- .. row 7
- __u32
- ``standards``
- The video standard(s) supported by the hardware. See
:ref:`dv-bt-standards` for a list of standards.
- .. row 8
- __u32
- ``capabilities``
- Several flags giving more information about the capabilities. See
:ref:`dv-bt-cap-capabilities` for a description of the flags.
- .. row 9
- __u32
- ``reserved``\ [16]
- Reserved for future extensions.
Drivers must set the array to zero.
@ -151,59 +106,30 @@ that doesn't support them will return an ``EINVAL`` error code.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 :widths: 1 1 2 1
* - __u32
- ``type``
- Type of DV timings as listed in :ref:`dv-timing-types`.
* - __u32
- ``pad``
- Pad number as reported by the media controller API. This field is
only used when operating on a subdevice node. When operating on a
video node applications must set this field to zero.
* - __u32
- ``reserved``\ [2]
- Reserved for future extensions.
- .. row 1 Drivers and applications must set the array to zero.
* - union
- __u32 -
-
- ``type`` * -
- struct :c:type:`v4l2_bt_timings_cap`
- Type of DV timings as listed in :ref:`dv-timing-types`. - ``bt``
- BT.656/1120 timings capabilities of the hardware.
- .. row 2 * -
- __u32
- __u32 - ``raw_data``\ [32]
-
- ``pad``
- Pad number as reported by the media controller API. This field is
only used when operating on a subdevice node. When operating on a
video node applications must set this field to zero.
- .. row 3
- __u32
- ``reserved``\ [2]
- Reserved for future extensions.
Drivers and applications must set the array to zero.
- .. row 4
- union
-
-
- .. row 5
-
- struct :c:type:`v4l2_bt_timings_cap`
- ``bt``
- BT.656/1120 timings capabilities of the hardware.
- .. row 6
-
- __u32
- ``raw_data``\ [32]
-
.. tabularcolumns:: |p{7.0cm}|p{10.5cm}| .. tabularcolumns:: |p{7.0cm}|p{10.5cm}|
@ -213,43 +139,20 @@ that doesn't support them will return an ``EINVAL`` error code.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - Flag
- .. row 1 - Description
* -
- Flag -
* - ``V4L2_DV_BT_CAP_INTERLACED``
- Description - Interlaced formats are supported.
* - ``V4L2_DV_BT_CAP_PROGRESSIVE``
- .. row 2 - Progressive formats are supported.
* - ``V4L2_DV_BT_CAP_REDUCED_BLANKING``
- - CVT/GTF specific: the timings can make use of reduced blanking
- (CVT) or the 'Secondary GTF' curve (GTF).
* - ``V4L2_DV_BT_CAP_CUSTOM``
- .. row 3 - Can support non-standard timings, i.e. timings not belonging to
the standards set in the ``standards`` field.
- ``V4L2_DV_BT_CAP_INTERLACED``
- Interlaced formats are supported.
- .. row 4
- ``V4L2_DV_BT_CAP_PROGRESSIVE``
- Progressive formats are supported.
- .. row 5
- ``V4L2_DV_BT_CAP_REDUCED_BLANKING``
- CVT/GTF specific: the timings can make use of reduced blanking
(CVT) or the 'Secondary GTF' curve (GTF).
- .. row 6
- ``V4L2_DV_BT_CAP_CUSTOM``
- Can support non-standard timings, i.e. timings not belonging to
the standards set in the ``standards`` field.
Return Value Return Value

134
Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst
View File

@ -74,33 +74,18 @@ introduced in Linux 2.6.21.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``cmd``
- The encoder command, see :ref:`encoder-cmds`.
- __u32 * - __u32
- ``flags``
- ``cmd`` - Flags to go with the command, see :ref:`encoder-flags`. If no
flags are defined for this command, drivers and applications must
- The encoder command, see :ref:`encoder-cmds`. set this field to zero.
* - __u32
- .. row 2 - ``data``\ [8]
- Reserved for future extensions. Drivers and applications must set
- __u32 the array to zero.
- ``flags``
- Flags to go with the command, see :ref:`encoder-flags`. If no
flags are defined for this command, drivers and applications must
set this field to zero.
- .. row 3
- __u32
- ``data``\ [8]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
@ -113,57 +98,37 @@ introduced in Linux 2.6.21.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_ENC_CMD_START``
- .. row 1 - 0
- Start the encoder. When the encoder is already running or paused,
- ``V4L2_ENC_CMD_START`` this command does nothing. No flags are defined for this command.
* - ``V4L2_ENC_CMD_STOP``
- 0 - 1
- Stop the encoder. When the ``V4L2_ENC_CMD_STOP_AT_GOP_END`` flag
- Start the encoder. When the encoder is already running or paused, is set, encoding will continue until the end of the current *Group
this command does nothing. No flags are defined for this command. Of Pictures*, otherwise encoding will stop immediately. When the
encoder is already stopped, this command does nothing. mem2mem
- .. row 2 encoders will send a ``V4L2_EVENT_EOS`` event when the last frame
has been encoded and all frames are ready to be dequeued and will
- ``V4L2_ENC_CMD_STOP`` set the ``V4L2_BUF_FLAG_LAST`` buffer flag on the last buffer of
the capture queue to indicate there will be no new buffers
- 1 produced to dequeue. This buffer may be empty, indicated by the
driver setting the ``bytesused`` field to 0. Once the
- Stop the encoder. When the ``V4L2_ENC_CMD_STOP_AT_GOP_END`` flag ``V4L2_BUF_FLAG_LAST`` flag was set, the
is set, encoding will continue until the end of the current *Group :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
Of Pictures*, otherwise encoding will stop immediately. When the but return an ``EPIPE`` error code.
encoder is already stopped, this command does nothing. mem2mem * - ``V4L2_ENC_CMD_PAUSE``
encoders will send a ``V4L2_EVENT_EOS`` event when the last frame - 2
has been encoded and all frames are ready to be dequeued and will - Pause the encoder. When the encoder has not been started yet, the
set the ``V4L2_BUF_FLAG_LAST`` buffer flag on the last buffer of driver will return an ``EPERM`` error code. When the encoder is
the capture queue to indicate there will be no new buffers already paused, this command does nothing. No flags are defined
produced to dequeue. This buffer may be empty, indicated by the for this command.
driver setting the ``bytesused`` field to 0. Once the * - ``V4L2_ENC_CMD_RESUME``
``V4L2_BUF_FLAG_LAST`` flag was set, the - 3
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore, - Resume encoding after a PAUSE command. When the encoder has not
but return an ``EPIPE`` error code. been started yet, the driver will return an ``EPERM`` error code. When
the encoder is already running, this command does nothing. No
- .. row 3 flags are defined for this command.
- ``V4L2_ENC_CMD_PAUSE``
- 2
- Pause the encoder. When the encoder has not been started yet, the
driver will return an ``EPERM`` error code. When the encoder is
already paused, this command does nothing. No flags are defined
for this command.
- .. row 4
- ``V4L2_ENC_CMD_RESUME``
- 3
- Resume encoding after a PAUSE command. When the encoder has not
been started yet, the driver will return an ``EPERM`` error code. When
the encoder is already running, this command does nothing. No
flags are defined for this command.
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
@ -175,15 +140,10 @@ introduced in Linux 2.6.21.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_ENC_CMD_STOP_AT_GOP_END``
- .. row 1 - 0x0001
- Stop encoding at the end of the current *Group Of Pictures*,
- ``V4L2_ENC_CMD_STOP_AT_GOP_END`` rather than immediately.
- 0x0001
- Stop encoding at the end of the current *Group Of Pictures*,
rather than immediately.
Return Value Return Value

50
Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst
View File

@ -74,41 +74,21 @@ return an ``EINVAL`` error code.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``index``
- Number of the DV timings, set by the application.
- __u32 * - __u32
- ``pad``
- ``index`` - Pad number as reported by the media controller API. This field is
only used when operating on a subdevice node. When operating on a
- Number of the DV timings, set by the application. video node applications must set this field to zero.
* - __u32
- .. row 2 - ``reserved``\ [2]
- Reserved for future extensions. Drivers and applications must set
- __u32 the array to zero.
* - struct :c:type:`v4l2_dv_timings`
- ``pad`` - ``timings``
- The timings.
- Pad number as reported by the media controller API. This field is
only used when operating on a subdevice node. When operating on a
video node applications must set this field to zero.
- .. row 3
- __u32
- ``reserved``\ [2]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
- .. row 4
- struct :c:type:`v4l2_dv_timings`
- ``timings``
- The timings.
Return Value Return Value

130
Documentation/media/uapi/v4l/vidioc-enum-fmt.rst
View File

@ -53,80 +53,48 @@ one until ``EINVAL`` is returned.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
- .. row 1 * - __u32
- ``index``
- Number of the format in the enumeration, set by the application.
This is in no way related to the ``pixelformat`` field.
* - __u32
- ``type``
- Type of the data stream, set by the application. Only these types
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE`` and
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
* - __u32
- ``flags``
- See :ref:`fmtdesc-flags`
* - __u8
- ``description``\ [32]
- Description of the format, a NUL-terminated ASCII string. This
information is intended for the user, for example: "YUV 4:2:2".
* - __u32
- ``pixelformat``
- The image format identifier. This is a four character code as
computed by the v4l2_fourcc() macro:
* - :cspan:`2`
- __u32 .. _v4l2-fourcc:
- ``index`` ``#define v4l2_fourcc(a,b,c,d)``
- Number of the format in the enumeration, set by the application. ``(((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))``
This is in no way related to the ``pixelformat`` field.
- .. row 2 Several image formats are already defined by this specification in
:ref:`pixfmt`.
- __u32 .. attention::
- ``type`` These codes are not the same as those used
in the Windows world.
- Type of the data stream, set by the application. Only these types * - __u32
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``, - ``reserved``\ [4]
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``, - Reserved for future extensions. Drivers must set the array to
``V4L2_BUF_TYPE_VIDEO_OUTPUT``, zero.
``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE`` and
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
- .. row 3
- __u32
- ``flags``
- See :ref:`fmtdesc-flags`
- .. row 4
- __u8
- ``description``\ [32]
- Description of the format, a NUL-terminated ASCII string. This
information is intended for the user, for example: "YUV 4:2:2".
- .. row 5
- __u32
- ``pixelformat``
- The image format identifier. This is a four character code as
computed by the v4l2_fourcc() macro:
- .. row 6
- :cspan:`2`
.. _v4l2-fourcc:
``#define v4l2_fourcc(a,b,c,d)``
``(((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))``
Several image formats are already defined by this specification in
:ref:`pixfmt`.
.. attention::
These codes are not the same as those used
in the Windows world.
- .. row 7
- __u32
- ``reserved``\ [4]
- Reserved for future extensions. Drivers must set the array to
zero.
@ -139,24 +107,14 @@ one until ``EINVAL`` is returned.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_FMT_FLAG_COMPRESSED``
- .. row 1 - 0x0001
- This is a compressed format.
- ``V4L2_FMT_FLAG_COMPRESSED`` * - ``V4L2_FMT_FLAG_EMULATED``
- 0x0002
- 0x0001 - This format is not native to the device but emulated through
software (usually libv4l2), where possible try to use a native
- This is a compressed format. format instead for better performance.
- .. row 2
- ``V4L2_FMT_FLAG_EMULATED``
- 0x0002
- This format is not native to the device but emulated through
software (usually libv4l2), where possible try to use a native
format instead for better performance.
Return Value Return Value

184
Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst
View File

@ -110,30 +110,15 @@ application should zero out all members except for the *IN* fields.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - struct :c:type:`v4l2_fract`
- .. row 1 - ``min``
- Minimum frame interval [s].
- struct :c:type:`v4l2_fract` * - struct :c:type:`v4l2_fract`
- ``max``
- ``min`` - Maximum frame interval [s].
* - struct :c:type:`v4l2_fract`
- Minimum frame interval [s]. - ``step``
- Frame interval step size [s].
- .. row 2
- struct :c:type:`v4l2_fract`
- ``max``
- Maximum frame interval [s].
- .. row 3
- struct :c:type:`v4l2_fract`
- ``step``
- Frame interval step size [s].
@ -143,87 +128,43 @@ application should zero out all members except for the *IN* fields.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - __u32
- .. row 1 - ``index``
-
- __u32 - IN: Index of the given frame interval in the enumeration.
* - __u32
- ``index`` - ``pixel_format``
-
- - IN: Pixel format for which the frame intervals are enumerated.
- IN: Index of the given frame interval in the enumeration. * - __u32
- ``width``
- .. row 2 -
- IN: Frame width for which the frame intervals are enumerated.
- __u32 * - __u32
- ``height``
- ``pixel_format`` -
- IN: Frame height for which the frame intervals are enumerated.
- * - __u32
- IN: Pixel format for which the frame intervals are enumerated. - ``type``
-
- .. row 3 - OUT: Frame interval type the device supports.
* - union
- __u32 -
-
- ``width`` - OUT: Frame interval with the given index.
* -
- - struct :c:type:`v4l2_fract`
- IN: Frame width for which the frame intervals are enumerated. - ``discrete``
- Frame interval [s].
- .. row 4 * -
- struct :c:type:`v4l2_frmival_stepwise`
- __u32 - ``stepwise``
-
- ``height`` * - __u32
- ``reserved[2]``
- -
- IN: Frame height for which the frame intervals are enumerated. - Reserved space for future use. Must be zeroed by drivers and
applications.
- .. row 5
- __u32
- ``type``
-
- OUT: Frame interval type the device supports.
- .. row 6
- union
-
-
- OUT: Frame interval with the given index.
- .. row 7
-
- struct :c:type:`v4l2_fract`
- ``discrete``
- Frame interval [s].
- .. row 8
-
- struct :c:type:`v4l2_frmival_stepwise`
- ``stepwise``
-
- .. row 9
- __u32
- ``reserved[2]``
-
- Reserved space for future use. Must be zeroed by drivers and
applications.
@ -240,30 +181,15 @@ Enums
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_FRMIVAL_TYPE_DISCRETE``
- .. row 1 - 1
- Discrete frame interval.
- ``V4L2_FRMIVAL_TYPE_DISCRETE`` * - ``V4L2_FRMIVAL_TYPE_CONTINUOUS``
- 2
- 1 - Continuous frame interval.
* - ``V4L2_FRMIVAL_TYPE_STEPWISE``
- Discrete frame interval. - 3
- Step-wise defined frame interval.
- .. row 2
- ``V4L2_FRMIVAL_TYPE_CONTINUOUS``
- 2
- Continuous frame interval.
- .. row 3
- ``V4L2_FRMIVAL_TYPE_STEPWISE``
- 3
- Step-wise defined frame interval.
Return Value Return Value

213
Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst
View File

@ -99,22 +99,12 @@ application should zero out all members except for the *IN* fields.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``width``
- Width of the frame [pixel].
- __u32 * - __u32
- ``height``
- ``width`` - Height of the frame [pixel].
- Width of the frame [pixel].
- .. row 2
- __u32
- ``height``
- Height of the frame [pixel].
@ -127,54 +117,24 @@ application should zero out all members except for the *IN* fields.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``min_width``
- Minimum frame width [pixel].
- __u32 * - __u32
- ``max_width``
- ``min_width`` - Maximum frame width [pixel].
* - __u32
- Minimum frame width [pixel]. - ``step_width``
- Frame width step size [pixel].
- .. row 2 * - __u32
- ``min_height``
- __u32 - Minimum frame height [pixel].
* - __u32
- ``max_width`` - ``max_height``
- Maximum frame height [pixel].
- Maximum frame width [pixel]. * - __u32
- ``step_height``
- .. row 3 - Frame height step size [pixel].
- __u32
- ``step_width``
- Frame width step size [pixel].
- .. row 4
- __u32
- ``min_height``
- Minimum frame height [pixel].
- .. row 5
- __u32
- ``max_height``
- Maximum frame height [pixel].
- .. row 6
- __u32
- ``step_height``
- Frame height step size [pixel].
@ -184,69 +144,35 @@ application should zero out all members except for the *IN* fields.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - __u32
- .. row 1 - ``index``
-
- __u32 - IN: Index of the given frame size in the enumeration.
* - __u32
- ``index`` - ``pixel_format``
-
- - IN: Pixel format for which the frame sizes are enumerated.
- IN: Index of the given frame size in the enumeration. * - __u32
- ``type``
- .. row 2 -
- OUT: Frame size type the device supports.
- __u32 * - union
-
- ``pixel_format`` -
- OUT: Frame size with the given index.
- * -
- IN: Pixel format for which the frame sizes are enumerated. - struct :c:type:`v4l2_frmsize_discrete`
- ``discrete``
- .. row 3 -
* -
- __u32 - struct :c:type:`v4l2_frmsize_stepwise`
- ``stepwise``
- ``type`` -
* - __u32
- - ``reserved[2]``
- OUT: Frame size type the device supports. -
- Reserved space for future use. Must be zeroed by drivers and
- .. row 4 applications.
- union
-
-
- OUT: Frame size with the given index.
- .. row 5
-
- struct :c:type:`v4l2_frmsize_discrete`
- ``discrete``
-
- .. row 6
-
- struct :c:type:`v4l2_frmsize_stepwise`
- ``stepwise``
-
- .. row 7
- __u32
- ``reserved[2]``
-
- Reserved space for future use. Must be zeroed by drivers and
applications.
@ -263,30 +189,15 @@ Enums
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_FRMSIZE_TYPE_DISCRETE``
- .. row 1 - 1
- Discrete frame size.
- ``V4L2_FRMSIZE_TYPE_DISCRETE`` * - ``V4L2_FRMSIZE_TYPE_CONTINUOUS``
- 2
- 1 - Continuous frame size.
* - ``V4L2_FRMSIZE_TYPE_STEPWISE``
- Discrete frame size. - 3
- Step-wise defined frame size.
- .. row 2
- ``V4L2_FRMSIZE_TYPE_CONTINUOUS``
- 2
- Continuous frame size.
- .. row 3
- ``V4L2_FRMSIZE_TYPE_STEPWISE``
- 3
- Step-wise defined frame size.
Return Value Return Value

181
Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst
View File

@ -50,103 +50,63 @@ of the corresponding tuner/modulator is set.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 1 :widths: 1 1 2 1 1
* - __u32
- ``tuner``
- The tuner or modulator index number. This is the same value as in
the struct :c:type:`v4l2_input` ``tuner`` field and
the struct :c:type:`v4l2_tuner` ``index`` field, or
the struct :c:type:`v4l2_output` ``modulator`` field
and the struct :c:type:`v4l2_modulator` ``index``
field.
* - __u32
- ``type``
- The tuner type. This is the same value as in the struct
:c:type:`v4l2_tuner` ``type`` field. The type must be
set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and
to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to
``V4L2_TUNER_RADIO`` for modulators (currently only radio
modulators are supported). See :c:type:`v4l2_tuner_type`
* - __u32
- ``index``
- Identifies the frequency band, set by the application.
* - __u32
- ``capability``
- :cspan:`2` The tuner/modulator capability flags for this
frequency band, see :ref:`tuner-capability`. The
``V4L2_TUNER_CAP_LOW`` or ``V4L2_TUNER_CAP_1HZ`` capability must
be the same for all frequency bands of the selected
tuner/modulator. So either all bands have that capability set, or
none of them have that capability.
* - __u32
- ``rangelow``
- :cspan:`2` The lowest tunable frequency in units of 62.5 kHz, or
if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units
of 62.5 Hz, for this frequency band. A 1 Hz unit is used when the
``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
* - __u32
- ``rangehigh``
- :cspan:`2` The highest tunable frequency in units of 62.5 kHz,
or if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in
units of 62.5 Hz, for this frequency band. A 1 Hz unit is used
when the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
* - __u32
- ``modulation``
- :cspan:`2` The supported modulation systems of this frequency
band. See :ref:`band-modulation`.
- .. row 1 .. note::
- __u32 Currently only one modulation system per frequency band
is supported. More work will need to be done if multiple
modulation systems are possible. Contact the linux-media
mailing list
(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__)
if you need such functionality.
* - __u32
- ``reserved``\ [9]
- Reserved for future extensions.
- ``tuner`` Applications and drivers must set the array to zero.
- The tuner or modulator index number. This is the same value as in
the struct :c:type:`v4l2_input` ``tuner`` field and
the struct :c:type:`v4l2_tuner` ``index`` field, or
the struct :c:type:`v4l2_output` ``modulator`` field
and the struct :c:type:`v4l2_modulator` ``index``
field.
- .. row 2
- __u32
- ``type``
- The tuner type. This is the same value as in the struct
:c:type:`v4l2_tuner` ``type`` field. The type must be
set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and
to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to
``V4L2_TUNER_RADIO`` for modulators (currently only radio
modulators are supported). See :c:type:`v4l2_tuner_type`
- .. row 3
- __u32
- ``index``
- Identifies the frequency band, set by the application.
- .. row 4
- __u32
- ``capability``
- :cspan:`2` The tuner/modulator capability flags for this
frequency band, see :ref:`tuner-capability`. The
``V4L2_TUNER_CAP_LOW`` or ``V4L2_TUNER_CAP_1HZ`` capability must
be the same for all frequency bands of the selected
tuner/modulator. So either all bands have that capability set, or
none of them have that capability.
- .. row 5
- __u32
- ``rangelow``
- :cspan:`2` The lowest tunable frequency in units of 62.5 kHz, or
if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units
of 62.5 Hz, for this frequency band. A 1 Hz unit is used when the
``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
- .. row 6
- __u32
- ``rangehigh``
- :cspan:`2` The highest tunable frequency in units of 62.5 kHz,
or if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in
units of 62.5 Hz, for this frequency band. A 1 Hz unit is used
when the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
- .. row 7
- __u32
- ``modulation``
- :cspan:`2` The supported modulation systems of this frequency
band. See :ref:`band-modulation`.
.. note::
Currently only one modulation system per frequency band
is supported. More work will need to be done if multiple
modulation systems are possible. Contact the linux-media
mailing list
(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__)
if you need such functionality.
- .. row 8
- __u32
- ``reserved``\ [9]
- Reserved for future extensions.
Applications and drivers must set the array to zero.
@ -159,30 +119,15 @@ of the corresponding tuner/modulator is set.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_BAND_MODULATION_VSB``
- .. row 1 - 0x02
- Vestigial Sideband modulation, used for analog TV.
- ``V4L2_BAND_MODULATION_VSB`` * - ``V4L2_BAND_MODULATION_FM``
- 0x04
- 0x02 - Frequency Modulation, commonly used for analog radio.
* - ``V4L2_BAND_MODULATION_AM``
- Vestigial Sideband modulation, used for analog TV. - 0x08
- Amplitude Modulation, commonly used for analog radio.
- .. row 2
- ``V4L2_BAND_MODULATION_FM``
- 0x04
- Frequency Modulation, commonly used for analog radio.
- .. row 3
- ``V4L2_BAND_MODULATION_AM``
- 0x08
- Amplitude Modulation, commonly used for analog radio.
Return Value Return Value

433
Documentation/media/uapi/v4l/vidioc-enuminput.rst
View File

@ -48,103 +48,58 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- ``index``
- Identifies the input, set by the application.
* - __u8
- ``name``\ [32]
- Name of the video input, a NUL-terminated ASCII string, for
example: "Vin (Composite 2)". This information is intended for the
user, preferably the connector label on the device itself.
* - __u32
- ``type``
- Type of the input, see :ref:`input-type`.
* - __u32
- ``audioset``
- Drivers can enumerate up to 32 video and audio inputs. This field
shows which audio inputs were selectable as audio source if this
was the currently selected video input. It is a bit mask. The LSB
corresponds to audio input 0, the MSB to input 31. Any number of
bits can be set, or none.
- .. row 1 When the driver does not enumerate audio inputs no bits must be
set. Applications shall not interpret this as lack of audio
support. Some drivers automatically select audio sources and do
not enumerate them since there is no choice anyway.
- __u32 For details on audio inputs and how to select the current input
see :ref:`audio`.
- ``index`` * - __u32
- ``tuner``
- Identifies the input, set by the application. - Capture devices can have zero or more tuners (RF demodulators).
When the ``type`` is set to ``V4L2_INPUT_TYPE_TUNER`` this is an
- .. row 2 RF connector and this field identifies the tuner. It corresponds
to struct :c:type:`v4l2_tuner` field ``index``. For
- __u8 details on tuners see :ref:`tuner`.
* - :ref:`v4l2_std_id <v4l2-std-id>`
- ``name``\ [32] - ``std``
- Every video input supports one or more different video standards.
- Name of the video input, a NUL-terminated ASCII string, for This field is a set of all supported standards. For details on
example: "Vin (Composite 2)". This information is intended for the video standards and how to switch see :ref:`standard`.
user, preferably the connector label on the device itself. * - __u32
- ``status``
- .. row 3 - This field provides status information about the input. See
:ref:`input-status` for flags. With the exception of the sensor
- __u32 orientation bits ``status`` is only valid when this is the current
input.
- ``type`` * - __u32
- ``capabilities``
- Type of the input, see :ref:`input-type`. - This field provides capabilities for the input. See
:ref:`input-capabilities` for flags.
- .. row 4 * - __u32
- ``reserved``\ [3]
- __u32 - Reserved for future extensions. Drivers must set the array to
zero.
- ``audioset``
- Drivers can enumerate up to 32 video and audio inputs. This field
shows which audio inputs were selectable as audio source if this
was the currently selected video input. It is a bit mask. The LSB
corresponds to audio input 0, the MSB to input 31. Any number of
bits can be set, or none.
When the driver does not enumerate audio inputs no bits must be
set. Applications shall not interpret this as lack of audio
support. Some drivers automatically select audio sources and do
not enumerate them since there is no choice anyway.
For details on audio inputs and how to select the current input
see :ref:`audio`.
- .. row 5
- __u32
- ``tuner``
- Capture devices can have zero or more tuners (RF demodulators).
When the ``type`` is set to ``V4L2_INPUT_TYPE_TUNER`` this is an
RF connector and this field identifies the tuner. It corresponds
to struct :c:type:`v4l2_tuner` field ``index``. For
details on tuners see :ref:`tuner`.
- .. row 6
- :ref:`v4l2_std_id <v4l2-std-id>`
- ``std``
- Every video input supports one or more different video standards.
This field is a set of all supported standards. For details on
video standards and how to switch see :ref:`standard`.
- .. row 7
- __u32
- ``status``
- This field provides status information about the input. See
:ref:`input-status` for flags. With the exception of the sensor
orientation bits ``status`` is only valid when this is the current
input.
- .. row 8
- __u32
- ``capabilities``
- This field provides capabilities for the input. See
:ref:`input-capabilities` for flags.
- .. row 9
- __u32
- ``reserved``\ [3]
- Reserved for future extensions. Drivers must set the array to
zero.
@ -157,31 +112,16 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_INPUT_TYPE_TUNER``
- .. row 1 - 1
- This input uses a tuner (RF demodulator).
- ``V4L2_INPUT_TYPE_TUNER`` * - ``V4L2_INPUT_TYPE_CAMERA``
- 2
- 1 - Analog baseband input, for example CVBS / Composite Video,
S-Video, RGB.
- This input uses a tuner (RF demodulator). * - ``V4L2_INPUT_TYPE_TOUCH``
- 3
- .. row 2 - This input is a touch device for capturing raw touch data.
- ``V4L2_INPUT_TYPE_CAMERA``
- 2
- Analog baseband input, for example CVBS / Composite Video,
S-Video, RGB.
- .. row 3
- ``V4L2_INPUT_TYPE_TOUCH``
- 3
- This input is a touch device for capturing raw touch data.
@ -193,157 +133,67 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - :cspan:`2` General
- .. row 1 * - ``V4L2_IN_ST_NO_POWER``
- 0x00000001
- :cspan:`2` General - Attached device is off.
* - ``V4L2_IN_ST_NO_SIGNAL``
- .. row 2 - 0x00000002
-
- ``V4L2_IN_ST_NO_POWER`` * - ``V4L2_IN_ST_NO_COLOR``
- 0x00000004
- 0x00000001 - The hardware supports color decoding, but does not detect color
modulation in the signal.
- Attached device is off. * - :cspan:`2` Sensor Orientation
* - ``V4L2_IN_ST_HFLIP``
- .. row 3 - 0x00000010
- The input is connected to a device that produces a signal that is
- ``V4L2_IN_ST_NO_SIGNAL`` flipped horizontally and does not correct this before passing the
signal to userspace.
- 0x00000002 * - ``V4L2_IN_ST_VFLIP``
- 0x00000020
- - The input is connected to a device that produces a signal that is
flipped vertically and does not correct this before passing the
- .. row 4 signal to userspace.
.. note:: A 180 degree rotation is the same as HFLIP | VFLIP
- ``V4L2_IN_ST_NO_COLOR`` * - :cspan:`2` Analog Video
* - ``V4L2_IN_ST_NO_H_LOCK``
- 0x00000004 - 0x00000100
- No horizontal sync lock.
- The hardware supports color decoding, but does not detect color * - ``V4L2_IN_ST_COLOR_KILL``
modulation in the signal. - 0x00000200
- A color killer circuit automatically disables color decoding when
- .. row 5 it detects no color modulation. When this flag is set the color
killer is enabled *and* has shut off color decoding.
- :cspan:`2` Sensor Orientation * - ``V4L2_IN_ST_NO_V_LOCK``
- 0x00000400
- .. row 6 - No vertical sync lock.
* - ``V4L2_IN_ST_NO_STD_LOCK``
- ``V4L2_IN_ST_HFLIP`` - 0x00000800
- No standard format lock in case of auto-detection format
- 0x00000010 by the component.
* - :cspan:`2` Digital Video
- The input is connected to a device that produces a signal that is * - ``V4L2_IN_ST_NO_SYNC``
flipped horizontally and does not correct this before passing the - 0x00010000
signal to userspace. - No synchronization lock.
* - ``V4L2_IN_ST_NO_EQU``
- .. row 7 - 0x00020000
- No equalizer lock.
- ``V4L2_IN_ST_VFLIP`` * - ``V4L2_IN_ST_NO_CARRIER``
- 0x00040000
- 0x00000020 - Carrier recovery failed.
* - :cspan:`2` VCR and Set-Top Box
- The input is connected to a device that produces a signal that is * - ``V4L2_IN_ST_MACROVISION``
flipped vertically and does not correct this before passing the - 0x01000000
signal to userspace. - Macrovision is an analog copy prevention system mangling the video
.. note:: A 180 degree rotation is the same as HFLIP | VFLIP signal to confuse video recorders. When this flag is set
Macrovision has been detected.
- .. row 8 * - ``V4L2_IN_ST_NO_ACCESS``
- 0x02000000
- :cspan:`2` Analog Video - Conditional access denied.
* - ``V4L2_IN_ST_VTR``
- .. row 9 - 0x04000000
- VTR time constant. [?]
- ``V4L2_IN_ST_NO_H_LOCK``
- 0x00000100
- No horizontal sync lock.
- .. row 10
- ``V4L2_IN_ST_COLOR_KILL``
- 0x00000200
- A color killer circuit automatically disables color decoding when
it detects no color modulation. When this flag is set the color
killer is enabled *and* has shut off color decoding.
- .. row 11
- ``V4L2_IN_ST_NO_V_LOCK``
- 0x00000400
- No vertical sync lock.
- .. row 12
- ``V4L2_IN_ST_NO_STD_LOCK``
- 0x00000800
- No standard format lock in case of auto-detection format
by the component.
- .. row 13
- :cspan:`2` Digital Video
- .. row 14
- ``V4L2_IN_ST_NO_SYNC``
- 0x00010000
- No synchronization lock.
- .. row 15
- ``V4L2_IN_ST_NO_EQU``
- 0x00020000
- No equalizer lock.
- .. row 16
- ``V4L2_IN_ST_NO_CARRIER``
- 0x00040000
- Carrier recovery failed.
- .. row 17
- :cspan:`2` VCR and Set-Top Box
- .. row 18
- ``V4L2_IN_ST_MACROVISION``
- 0x01000000
- Macrovision is an analog copy prevention system mangling the video
signal to confuse video recorders. When this flag is set
Macrovision has been detected.
- .. row 19
- ``V4L2_IN_ST_NO_ACCESS``
- 0x02000000
- Conditional access denied.
- .. row 20
- ``V4L2_IN_ST_VTR``
- 0x04000000
- VTR time constant. [?]
@ -356,34 +206,19 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_IN_CAP_DV_TIMINGS``
- .. row 1 - 0x00000002
- This input supports setting video timings by using
- ``V4L2_IN_CAP_DV_TIMINGS`` VIDIOC_S_DV_TIMINGS.
* - ``V4L2_IN_CAP_STD``
- 0x00000002 - 0x00000004
- This input supports setting the TV standard by using
- This input supports setting video timings by using VIDIOC_S_STD.
VIDIOC_S_DV_TIMINGS. * - ``V4L2_IN_CAP_NATIVE_SIZE``
- 0x00000008
- .. row 2 - This input supports setting the native size using the
``V4L2_SEL_TGT_NATIVE_SIZE`` selection target, see
- ``V4L2_IN_CAP_STD`` :ref:`v4l2-selections-common`.
- 0x00000004
- This input supports setting the TV standard by using
VIDIOC_S_STD.
- .. row 3
- ``V4L2_IN_CAP_NATIVE_SIZE``
- 0x00000008
- This input supports setting the native size using the
``V4L2_SEL_TGT_NATIVE_SIZE`` selection target, see
:ref:`v4l2-selections-common`.
Return Value Return Value

204
Documentation/media/uapi/v4l/vidioc-enumoutput.rst
View File

@ -49,92 +49,52 @@ EINVAL.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- ``index``
- Identifies the output, set by the application.
* - __u8
- ``name``\ [32]
- Name of the video output, a NUL-terminated ASCII string, for
example: "Vout". This information is intended for the user,
preferably the connector label on the device itself.
* - __u32
- ``type``
- Type of the output, see :ref:`output-type`.
* - __u32
- ``audioset``
- Drivers can enumerate up to 32 video and audio outputs. This field
shows which audio outputs were selectable as the current output if
this was the currently selected video output. It is a bit mask.
The LSB corresponds to audio output 0, the MSB to output 31. Any
number of bits can be set, or none.
- .. row 1 When the driver does not enumerate audio outputs no bits must be
set. Applications shall not interpret this as lack of audio
support. Drivers may automatically select audio outputs without
enumerating them.
- __u32 For details on audio outputs and how to select the current output
see :ref:`audio`.
- ``index`` * - __u32
- ``modulator``
- Identifies the output, set by the application. - Output devices can have zero or more RF modulators. When the
``type`` is ``V4L2_OUTPUT_TYPE_MODULATOR`` this is an RF connector
- .. row 2 and this field identifies the modulator. It corresponds to struct
:c:type:`v4l2_modulator` field ``index``. For
- __u8 details on modulators see :ref:`tuner`.
* - :ref:`v4l2_std_id <v4l2-std-id>`
- ``name``\ [32] - ``std``
- Every video output supports one or more different video standards.
- Name of the video output, a NUL-terminated ASCII string, for This field is a set of all supported standards. For details on
example: "Vout". This information is intended for the user, video standards and how to switch see :ref:`standard`.
preferably the connector label on the device itself. * - __u32
- ``capabilities``
- .. row 3 - This field provides capabilities for the output. See
:ref:`output-capabilities` for flags.
- __u32 * - __u32
- ``reserved``\ [3]
- ``type`` - Reserved for future extensions. Drivers must set the array to
zero.
- Type of the output, see :ref:`output-type`.
- .. row 4
- __u32
- ``audioset``
- Drivers can enumerate up to 32 video and audio outputs. This field
shows which audio outputs were selectable as the current output if
this was the currently selected video output. It is a bit mask.
The LSB corresponds to audio output 0, the MSB to output 31. Any
number of bits can be set, or none.
When the driver does not enumerate audio outputs no bits must be
set. Applications shall not interpret this as lack of audio
support. Drivers may automatically select audio outputs without
enumerating them.
For details on audio outputs and how to select the current output
see :ref:`audio`.
- .. row 5
- __u32
- ``modulator``
- Output devices can have zero or more RF modulators. When the
``type`` is ``V4L2_OUTPUT_TYPE_MODULATOR`` this is an RF connector
and this field identifies the modulator. It corresponds to struct
:c:type:`v4l2_modulator` field ``index``. For
details on modulators see :ref:`tuner`.
- .. row 6
- :ref:`v4l2_std_id <v4l2-std-id>`
- ``std``
- Every video output supports one or more different video standards.
This field is a set of all supported standards. For details on
video standards and how to switch see :ref:`standard`.
- .. row 7
- __u32
- ``capabilities``
- This field provides capabilities for the output. See
:ref:`output-capabilities` for flags.
- .. row 8
- __u32
- ``reserved``\ [3]
- Reserved for future extensions. Drivers must set the array to
zero.
@ -147,31 +107,16 @@ EINVAL.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_OUTPUT_TYPE_MODULATOR``
- .. row 1 - 1
- This output is an analog TV modulator.
- ``V4L2_OUTPUT_TYPE_MODULATOR`` * - ``V4L2_OUTPUT_TYPE_ANALOG``
- 2
- 1 - Analog baseband output, for example Composite / CVBS, S-Video,
RGB.
- This output is an analog TV modulator. * - ``V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY``
- 3
- .. row 2 - [?]
- ``V4L2_OUTPUT_TYPE_ANALOG``
- 2
- Analog baseband output, for example Composite / CVBS, S-Video,
RGB.
- .. row 3
- ``V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY``
- 3
- [?]
@ -184,34 +129,19 @@ EINVAL.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_OUT_CAP_DV_TIMINGS``
- .. row 1 - 0x00000002
- This output supports setting video timings by using
- ``V4L2_OUT_CAP_DV_TIMINGS`` VIDIOC_S_DV_TIMINGS.
* - ``V4L2_OUT_CAP_STD``
- 0x00000002 - 0x00000004
- This output supports setting the TV standard by using
- This output supports setting video timings by using VIDIOC_S_STD.
VIDIOC_S_DV_TIMINGS. * - ``V4L2_OUT_CAP_NATIVE_SIZE``
- 0x00000008
- .. row 2 - This output supports setting the native size using the
``V4L2_SEL_TGT_NATIVE_SIZE`` selection target, see
- ``V4L2_OUT_CAP_STD`` :ref:`v4l2-selections-common`.
- 0x00000004
- This output supports setting the TV standard by using
VIDIOC_S_STD.
- .. row 3
- ``V4L2_OUT_CAP_NATIVE_SIZE``
- 0x00000008
- This output supports setting the native size using the
``V4L2_SEL_TGT_NATIVE_SIZE`` selection target, see
:ref:`v4l2-selections-common`.
Return Value Return Value

288
Documentation/media/uapi/v4l/vidioc-enumstd.rst
View File

@ -51,64 +51,34 @@ or output. [#f1]_
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``index``
- Number of the video standard, set by the application.
- __u32 * - :ref:`v4l2_std_id <v4l2-std-id>`
- ``id``
- ``index`` - The bits in this field identify the standard as one of the common
standards listed in :ref:`v4l2-std-id`, or if bits 32 to 63 are
- Number of the video standard, set by the application. set as custom standards. Multiple bits can be set if the hardware
does not distinguish between these standards, however separate
- .. row 2 indices do not indicate the opposite. The ``id`` must be unique.
No other enumerated struct :c:type:`v4l2_standard` structure,
- :ref:`v4l2_std_id <v4l2-std-id>` for this input or output anyway, can contain the same set of bits.
* - __u8
- ``id`` - ``name``\ [24]
- Name of the standard, a NUL-terminated ASCII string, for example:
- The bits in this field identify the standard as one of the common "PAL-B/G", "NTSC Japan". This information is intended for the
standards listed in :ref:`v4l2-std-id`, or if bits 32 to 63 are user.
set as custom standards. Multiple bits can be set if the hardware * - struct :c:type:`v4l2_fract`
does not distinguish between these standards, however separate - ``frameperiod``
indices do not indicate the opposite. The ``id`` must be unique. - The frame period (not field period) is numerator / denominator.
No other enumerated struct :c:type:`v4l2_standard` structure, For example M/NTSC has a frame period of 1001 / 30000 seconds.
for this input or output anyway, can contain the same set of bits. * - __u32
- ``framelines``
- .. row 3 - Total lines per frame including blanking, e. g. 625 for B/PAL.
* - __u32
- __u8 - ``reserved``\ [4]
- Reserved for future extensions. Drivers must set the array to
- ``name``\ [24] zero.
- Name of the standard, a NUL-terminated ASCII string, for example:
"PAL-B/G", "NTSC Japan". This information is intended for the
user.
- .. row 4
- struct :c:type:`v4l2_fract`
- ``frameperiod``
- The frame period (not field period) is numerator / denominator.
For example M/NTSC has a frame period of 1001 / 30000 seconds.
- .. row 5
- __u32
- ``framelines``
- Total lines per frame including blanking, e. g. 625 for B/PAL.
- .. row 6
- __u32
- ``reserved``\ [4]
- Reserved for future extensions. Drivers must set the array to
zero.
@ -121,22 +91,12 @@ or output. [#f1]_
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``numerator``
-
- __u32 * - __u32
- ``denominator``
- ``numerator`` -
-
- .. row 2
- __u32
- ``denominator``
-
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
@ -148,17 +108,12 @@ or output. [#f1]_
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u64
- .. row 1 - ``v4l2_std_id``
- This type is a set, each bit representing another video standard
- __u64 as listed below and in :ref:`video-standards`. The 32 most
significant bits are reserved for custom (driver defined) video
- ``v4l2_std_id`` standards.
- This type is a set, each bit representing another video standard
as listed below and in :ref:`video-standards`. The 32 most
significant bits are reserved for custom (driver defined) video
standards.
@ -282,120 +237,59 @@ support digital TV. See also the Linux DVB API at
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
* - Characteristics
- M/NTSC [#f2]_
- M/PAL
- N/PAL [#f3]_
- B, B1, G/PAL
- D, D1, K/PAL
- H/PAL
- I/PAL
- B, G/SECAM
- D, K/SECAM
- K1/SECAM
- L/SECAM
* - Frame lines
- :cspan:`1` 525
- :cspan:`8` 625
* - Frame period (s)
- :cspan:`1` 1001/30000
- :cspan:`8` 1/25
* - Chrominance sub-carrier frequency (Hz)
- 3579545 ± 10
- 3579611.49 ± 10
- 4433618.75 ± 5
- .. row 1 (3582056.25 ± 5)
- :cspan:`3` 4433618.75 ± 5
- 4433618.75 ± 1
- :cspan:`2` f\ :sub:`OR` = 4406250 ± 2000,
- Characteristics f\ :sub:`OB` = 4250000 ± 2000
* - Nominal radio-frequency channel bandwidth (MHz)
- M/NTSC [#f2]_ - 6
- 6
- M/PAL - 6
- B: 7; B1, G: 8
- N/PAL [#f3]_ - 8
- 8
- B, B1, G/PAL - 8
- 8
- D, D1, K/PAL - 8
- 8
- H/PAL - 8
* - Sound carrier relative to vision carrier (MHz)
- I/PAL - 4.5
- 4.5
- B, G/SECAM - 4.5
- 5.5 ± 0.001 [#f4]_ [#f5]_ [#f6]_ [#f7]_
- D, K/SECAM - 6.5 ± 0.001
- 5.5
- K1/SECAM - 5.9996 ± 0.0005
- 5.5 ± 0.001
- L/SECAM - 6.5 ± 0.001
- 6.5
- .. row 2 - 6.5 [#f8]_
- Frame lines
- :cspan:`1` 525
- :cspan:`8` 625
- .. row 3
- Frame period (s)
- :cspan:`1` 1001/30000
- :cspan:`8` 1/25
- .. row 4
- Chrominance sub-carrier frequency (Hz)
- 3579545 ± 10
- 3579611.49 ± 10
- 4433618.75 ± 5
(3582056.25 ± 5)
- :cspan:`3` 4433618.75 ± 5
- 4433618.75 ± 1
- :cspan:`2` f\ :sub:`OR` = 4406250 ± 2000,
f\ :sub:`OB` = 4250000 ± 2000
- .. row 5
- Nominal radio-frequency channel bandwidth (MHz)
- 6
- 6
- 6
- B: 7; B1, G: 8
- 8
- 8
- 8
- 8
- 8
- 8
- 8
- .. row 6
- Sound carrier relative to vision carrier (MHz)
- 4.5
- 4.5
- 4.5
- 5.5 ± 0.001 [#f4]_ [#f5]_ [#f6]_ [#f7]_
- 6.5 ± 0.001
- 5.5
- 5.9996 ± 0.0005
- 5.5 ± 0.001
- 6.5 ± 0.001
- 6.5
- 6.5 [#f8]_
.. raw:: latex .. raw:: latex

90
Documentation/media/uapi/v4l/vidioc-expbuf.rst
View File

@ -123,66 +123,36 @@ Examples
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``type``
- Type of the buffer, same as struct
- __u32 :c:type:`v4l2_format` ``type`` or struct
:c:type:`v4l2_requestbuffers` ``type``, set
- ``type`` by the application. See :c:type:`v4l2_buf_type`
* - __u32
- Type of the buffer, same as struct - ``index``
:c:type:`v4l2_format` ``type`` or struct - Number of the buffer, set by the application. This field is only
:c:type:`v4l2_requestbuffers` ``type``, set used for :ref:`memory mapping <mmap>` I/O and can range from
by the application. See :c:type:`v4l2_buf_type` zero to the number of buffers allocated with the
:ref:`VIDIOC_REQBUFS` and/or
- .. row 2 :ref:`VIDIOC_CREATE_BUFS` ioctls.
* - __u32
- __u32 - ``plane``
- Index of the plane to be exported when using the multi-planar API.
- ``index`` Otherwise this value must be set to zero.
* - __u32
- Number of the buffer, set by the application. This field is only - ``flags``
used for :ref:`memory mapping <mmap>` I/O and can range from - Flags for the newly created file, currently only ``O_CLOEXEC``,
zero to the number of buffers allocated with the ``O_RDONLY``, ``O_WRONLY``, and ``O_RDWR`` are supported, refer to
:ref:`VIDIOC_REQBUFS` and/or the manual of open() for more details.
:ref:`VIDIOC_CREATE_BUFS` ioctls. * - __s32
- ``fd``
- .. row 3 - The DMABUF file descriptor associated with a buffer. Set by the
driver.
- __u32 * - __u32
- ``reserved[11]``
- ``plane`` - Reserved field for future use. Drivers and applications must set
the array to zero.
- Index of the plane to be exported when using the multi-planar API.
Otherwise this value must be set to zero.
- .. row 4
- __u32
- ``flags``
- Flags for the newly created file, currently only ``O_CLOEXEC``,
``O_RDONLY``, ``O_WRONLY``, and ``O_RDWR`` are supported, refer to
the manual of open() for more details.
- .. row 5
- __s32
- ``fd``
- The DMABUF file descriptor associated with a buffer. Set by the
driver.
- .. row 6
- __u32
- ``reserved[11]``
- Reserved field for future use. Drivers and applications must set
the array to zero.
Return Value Return Value

102
Documentation/media/uapi/v4l/vidioc-g-audio.rst
View File

@ -58,50 +58,25 @@ return the actual new audio mode.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``index``
- Identifies the audio input, set by the driver or application.
- __u32 * - __u8
- ``name``\ [32]
- ``index`` - Name of the audio input, a NUL-terminated ASCII string, for
example: "Line In". This information is intended for the user,
- Identifies the audio input, set by the driver or application. preferably the connector label on the device itself.
* - __u32
- .. row 2 - ``capability``
- Audio capability flags, see :ref:`audio-capability`.
- __u8 * - __u32
- ``mode``
- ``name``\ [32] - Audio mode flags set by drivers and applications (on
:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl), see :ref:`audio-mode`.
- Name of the audio input, a NUL-terminated ASCII string, for * - __u32
example: "Line In". This information is intended for the user, - ``reserved``\ [2]
preferably the connector label on the device itself. - Reserved for future extensions. Drivers and applications must set
the array to zero.
- .. row 3
- __u32
- ``capability``
- Audio capability flags, see :ref:`audio-capability`.
- .. row 4
- __u32
- ``mode``
- Audio mode flags set by drivers and applications (on
:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl), see :ref:`audio-mode`.
- .. row 5
- __u32
- ``reserved``\ [2]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
@ -114,25 +89,15 @@ return the actual new audio mode.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_AUDCAP_STEREO``
- .. row 1 - 0x00001
- This is a stereo input. The flag is intended to automatically
- ``V4L2_AUDCAP_STEREO`` disable stereo recording etc. when the signal is always monaural.
The API provides no means to detect if stereo is *received*,
- 0x00001 unless the audio input belongs to a tuner.
* - ``V4L2_AUDCAP_AVL``
- This is a stereo input. The flag is intended to automatically - 0x00002
disable stereo recording etc. when the signal is always monaural. - Automatic Volume Level mode is supported.
The API provides no means to detect if stereo is *received*,
unless the audio input belongs to a tuner.
- .. row 2
- ``V4L2_AUDCAP_AVL``
- 0x00002
- Automatic Volume Level mode is supported.
@ -145,14 +110,9 @@ return the actual new audio mode.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_AUDMODE_AVL``
- .. row 1 - 0x00001
- AVL mode is on.
- ``V4L2_AUDMODE_AVL``
- 0x00001
- AVL mode is on.
Return Value Return Value

65
Documentation/media/uapi/v4l/vidioc-g-audioout.rst
View File

@ -65,51 +65,26 @@ as ``VIDIOC_G_AUDOUT`` does.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``index``
- Identifies the audio output, set by the driver or application.
- __u32 * - __u8
- ``name``\ [32]
- ``index`` - Name of the audio output, a NUL-terminated ASCII string, for
example: "Line Out". This information is intended for the user,
- Identifies the audio output, set by the driver or application. preferably the connector label on the device itself.
* - __u32
- .. row 2 - ``capability``
- Audio capability flags, none defined yet. Drivers must set this
- __u8 field to zero.
* - __u32
- ``name``\ [32] - ``mode``
- Audio mode, none defined yet. Drivers and applications (on
- Name of the audio output, a NUL-terminated ASCII string, for ``VIDIOC_S_AUDOUT``) must set this field to zero.
example: "Line Out". This information is intended for the user, * - __u32
preferably the connector label on the device itself. - ``reserved``\ [2]
- Reserved for future extensions. Drivers and applications must set
- .. row 3 the array to zero.
- __u32
- ``capability``
- Audio capability flags, none defined yet. Drivers must set this
field to zero.
- .. row 4
- __u32
- ``mode``
- Audio mode, none defined yet. Drivers and applications (on
``VIDIOC_S_AUDOUT``) must set this field to zero.
- .. row 5
- __u32
- ``reserved``\ [2]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
Return Value Return Value

30
Documentation/media/uapi/v4l/vidioc-g-crop.rst
View File

@ -84,26 +84,16 @@ When cropping is not supported then no parameters are changed and
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``type``
- Type of the data stream, set by the application. Only these types
- __u32 are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` and
- ``type`` ``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
* - struct :c:type:`v4l2_rect`
- Type of the data stream, set by the application. Only these types - ``c``
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``, - Cropping rectangle. The same co-ordinate system as for struct
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` and :c:type:`v4l2_cropcap` ``bounds`` is used.
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
- .. row 2
- struct :c:type:`v4l2_rect`
- ``c``
- Cropping rectangle. The same co-ordinate system as for struct
:c:type:`v4l2_cropcap` ``bounds`` is used.
Return Value Return Value

22
Documentation/media/uapi/v4l/vidioc-g-ctrl.rst
View File

@ -64,22 +64,12 @@ These ioctls work only with user controls. For other control classes the
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``id``
- Identifies the control, set by the application.
- __u32 * - __s32
- ``value``
- ``id`` - New value or current value.
- Identifies the control, set by the application.
- .. row 2
- __s32
- ``value``
- New value or current value.
Return Value Return Value

465
Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst
View File

@ -83,158 +83,73 @@ EBUSY
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``width``
- Width of the active video in pixels.
- __u32 * - __u32
- ``height``
- ``width`` - Height of the active video frame in lines. So for interlaced
formats the height of the active video in each field is
- Width of the active video in pixels. ``height``/2.
* - __u32
- .. row 2 - ``interlaced``
- Progressive (``V4L2_DV_PROGRESSIVE``) or interlaced (``V4L2_DV_INTERLACED``).
- __u32 * - __u32
- ``polarities``
- ``height`` - This is a bit mask that defines polarities of sync signals. bit 0
(``V4L2_DV_VSYNC_POS_POL``) is for vertical sync polarity and bit
- Height of the active video frame in lines. So for interlaced 1 (``V4L2_DV_HSYNC_POS_POL``) is for horizontal sync polarity. If
formats the height of the active video in each field is the bit is set (1) it is positive polarity and if is cleared (0),
``height``/2. it is negative polarity.
* - __u64
- .. row 3 - ``pixelclock``
- Pixel clock in Hz. Ex. 74.25MHz->74250000
- __u32 * - __u32
- ``hfrontporch``
- ``interlaced`` - Horizontal front porch in pixels
* - __u32
- Progressive (``V4L2_DV_PROGRESSIVE``) or interlaced (``V4L2_DV_INTERLACED``). - ``hsync``
- Horizontal sync length in pixels
- .. row 4 * - __u32
- ``hbackporch``
- __u32 - Horizontal back porch in pixels
* - __u32
- ``polarities`` - ``vfrontporch``
- Vertical front porch in lines. For interlaced formats this refers
- This is a bit mask that defines polarities of sync signals. bit 0 to the odd field (aka field 1).
(``V4L2_DV_VSYNC_POS_POL``) is for vertical sync polarity and bit * - __u32
1 (``V4L2_DV_HSYNC_POS_POL``) is for horizontal sync polarity. If - ``vsync``
the bit is set (1) it is positive polarity and if is cleared (0), - Vertical sync length in lines. For interlaced formats this refers
it is negative polarity. to the odd field (aka field 1).
* - __u32
- .. row 5 - ``vbackporch``
- Vertical back porch in lines. For interlaced formats this refers
- __u64 to the odd field (aka field 1).
* - __u32
- ``pixelclock`` - ``il_vfrontporch``
- Vertical front porch in lines for the even field (aka field 2) of
- Pixel clock in Hz. Ex. 74.25MHz->74250000 interlaced field formats. Must be 0 for progressive formats.
* - __u32
- .. row 6 - ``il_vsync``
- Vertical sync length in lines for the even field (aka field 2) of
- __u32 interlaced field formats. Must be 0 for progressive formats.
* - __u32
- ``hfrontporch`` - ``il_vbackporch``
- Vertical back porch in lines for the even field (aka field 2) of
- Horizontal front porch in pixels interlaced field formats. Must be 0 for progressive formats.
* - __u32
- .. row 7 - ``standards``
- The video standard(s) this format belongs to. This will be filled
- __u32 in by the driver. Applications must set this to 0. See
:ref:`dv-bt-standards` for a list of standards.
- ``hsync`` * - __u32
- ``flags``
- Horizontal sync length in pixels - Several flags giving more information about the format. See
:ref:`dv-bt-flags` for a description of the flags.
- .. row 8 * - __u32
- ``reserved[14]``
- __u32 - Reserved for future extensions. Drivers and applications must set
the array to zero.
- ``hbackporch``
- Horizontal back porch in pixels
- .. row 9
- __u32
- ``vfrontporch``
- Vertical front porch in lines. For interlaced formats this refers
to the odd field (aka field 1).
- .. row 10
- __u32
- ``vsync``
- Vertical sync length in lines. For interlaced formats this refers
to the odd field (aka field 1).
- .. row 11
- __u32
- ``vbackporch``
- Vertical back porch in lines. For interlaced formats this refers
to the odd field (aka field 1).
- .. row 12
- __u32
- ``il_vfrontporch``
- Vertical front porch in lines for the even field (aka field 2) of
interlaced field formats. Must be 0 for progressive formats.
- .. row 13
- __u32
- ``il_vsync``
- Vertical sync length in lines for the even field (aka field 2) of
interlaced field formats. Must be 0 for progressive formats.
- .. row 14
- __u32
- ``il_vbackporch``
- Vertical back porch in lines for the even field (aka field 2) of
interlaced field formats. Must be 0 for progressive formats.
- .. row 15
- __u32
- ``standards``
- The video standard(s) this format belongs to. This will be filled
in by the driver. Applications must set this to 0. See
:ref:`dv-bt-standards` for a list of standards.
- .. row 16
- __u32
- ``flags``
- Several flags giving more information about the format. See
:ref:`dv-bt-flags` for a description of the flags.
- .. row 17
- __u32
- ``reserved[14]``
- Reserved for future extensions. Drivers and applications must set
the array to zero.
.. tabularcolumns:: |p{3.5cm}|p{3.5cm}|p{7.0cm}|p{3.5cm}| .. tabularcolumns:: |p{3.5cm}|p{3.5cm}|p{7.0cm}|p{3.5cm}|
@ -246,40 +161,21 @@ EBUSY
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 :widths: 1 1 2 1
* - __u32
- .. row 1 - ``type``
-
- __u32 - Type of DV timings as listed in :ref:`dv-timing-types`.
* - union
- ``type`` -
-
- * -
- Type of DV timings as listed in :ref:`dv-timing-types`. - struct :c:type:`v4l2_bt_timings`
- ``bt``
- .. row 2 - Timings defined by BT.656/1120 specifications
* -
- union - __u32
- ``reserved``\ [32]
- -
-
- .. row 3
-
- struct :c:type:`v4l2_bt_timings`
- ``bt``
- Timings defined by BT.656/1120 specifications
- .. row 4
-
- __u32
- ``reserved``\ [32]
-
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
@ -290,28 +186,15 @@ EBUSY
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - Timing type
- .. row 1 - value
- Description
- Timing type * -
-
- value -
* - ``V4L2_DV_BT_656_1120``
- Description - 0
- BT.656/1120 timings
- .. row 2
-
-
-
- .. row 3
- ``V4L2_DV_BT_656_1120``
- 0
- BT.656/1120 timings
@ -321,44 +204,20 @@ EBUSY
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - Timing standard
- .. row 1 - Description
* - ``V4L2_DV_BT_STD_CEA861``
- Timing standard - The timings follow the CEA-861 Digital TV Profile standard
* - ``V4L2_DV_BT_STD_DMT``
- Description - The timings follow the VESA Discrete Monitor Timings standard
* - ``V4L2_DV_BT_STD_CVT``
- .. row 3 - The timings follow the VESA Coordinated Video Timings standard
* - ``V4L2_DV_BT_STD_GTF``
- ``V4L2_DV_BT_STD_CEA861`` - The timings follow the VESA Generalized Timings Formula standard
* - ``V4L2_DV_BT_STD_SDI``
- The timings follow the CEA-861 Digital TV Profile standard - The timings follow the SDI Timings standard.
There are no horizontal syncs/porches at all in this format.
- .. row 4 Total blanking timings must be set in hsync or vsync fields only.
- ``V4L2_DV_BT_STD_DMT``
- The timings follow the VESA Discrete Monitor Timings standard
- .. row 5
- ``V4L2_DV_BT_STD_CVT``
- The timings follow the VESA Coordinated Video Timings standard
- .. row 6
- ``V4L2_DV_BT_STD_GTF``
- The timings follow the VESA Generalized Timings Formula standard
- .. row 7
- ``V4L2_DV_BT_STD_SDI``
- The timings follow the SDI Timings standard.
There are no horizontal syncs/porches at all in this format.
Total blanking timings must be set in hsync or vsync fields only.
.. tabularcolumns:: |p{6.0cm}|p{11.5cm}| .. tabularcolumns:: |p{6.0cm}|p{11.5cm}|
@ -368,74 +227,46 @@ EBUSY
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - Flag
- .. row 1 - Description
* - ``V4L2_DV_FL_REDUCED_BLANKING``
- Flag - CVT/GTF specific: the timings use reduced blanking (CVT) or the
'Secondary GTF' curve (GTF). In both cases the horizontal and/or
- Description vertical blanking intervals are reduced, allowing a higher
resolution over the same bandwidth. This is a read-only flag,
- .. row 3 applications must not set this.
* - ``V4L2_DV_FL_CAN_REDUCE_FPS``
- ``V4L2_DV_FL_REDUCED_BLANKING`` - CEA-861 specific: set for CEA-861 formats with a framerate that is
a multiple of six. These formats can be optionally played at 1 /
- CVT/GTF specific: the timings use reduced blanking (CVT) or the 1.001 speed to be compatible with 60 Hz based standards such as
'Secondary GTF' curve (GTF). In both cases the horizontal and/or NTSC and PAL-M that use a framerate of 29.97 frames per second. If
vertical blanking intervals are reduced, allowing a higher the transmitter can't generate such frequencies, then the flag
resolution over the same bandwidth. This is a read-only flag, will also be cleared. This is a read-only flag, applications must
applications must not set this. not set this.
* - ``V4L2_DV_FL_REDUCED_FPS``
- .. row 4 - CEA-861 specific: only valid for video transmitters, the flag is
cleared by receivers. It is also only valid for formats with the
- ``V4L2_DV_FL_CAN_REDUCE_FPS`` ``V4L2_DV_FL_CAN_REDUCE_FPS`` flag set, for other formats the
flag will be cleared by the driver. If the application sets this
- CEA-861 specific: set for CEA-861 formats with a framerate that is flag, then the pixelclock used to set up the transmitter is
a multiple of six. These formats can be optionally played at 1 / divided by 1.001 to make it compatible with NTSC framerates. If
1.001 speed to be compatible with 60 Hz based standards such as the transmitter can't generate such frequencies, then the flag
NTSC and PAL-M that use a framerate of 29.97 frames per second. If will also be cleared.
the transmitter can't generate such frequencies, then the flag * - ``V4L2_DV_FL_HALF_LINE``
will also be cleared. This is a read-only flag, applications must - Specific to interlaced formats: if set, then the vertical
not set this. frontporch of field 1 (aka the odd field) is really one half-line
longer and the vertical backporch of field 2 (aka the even field)
- .. row 5 is really one half-line shorter, so each field has exactly the
same number of half-lines. Whether half-lines can be detected or
- ``V4L2_DV_FL_REDUCED_FPS`` used depends on the hardware.
* - ``V4L2_DV_FL_IS_CE_VIDEO``
- CEA-861 specific: only valid for video transmitters, the flag is - If set, then this is a Consumer Electronics (CE) video format.
cleared by receivers. It is also only valid for formats with the Such formats differ from other formats (commonly called IT
``V4L2_DV_FL_CAN_REDUCE_FPS`` flag set, for other formats the formats) in that if R'G'B' encoding is used then by default the
flag will be cleared by the driver. If the application sets this R'G'B' values use limited range (i.e. 16-235) as opposed to full
flag, then the pixelclock used to set up the transmitter is range (i.e. 0-255). All formats defined in CEA-861 except for the
divided by 1.001 to make it compatible with NTSC framerates. If 640x480p59.94 format are CE formats.
the transmitter can't generate such frequencies, then the flag * - ``V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE``
will also be cleared. - Some formats like SMPTE-125M have an interlaced signal with a odd
total height. For these formats, if this flag is set, the first
- .. row 6 field has the extra line. Else, it is the second field.
- ``V4L2_DV_FL_HALF_LINE``
- Specific to interlaced formats: if set, then the vertical
frontporch of field 1 (aka the odd field) is really one half-line
longer and the vertical backporch of field 2 (aka the even field)
is really one half-line shorter, so each field has exactly the
same number of half-lines. Whether half-lines can be detected or
used depends on the hardware.
- .. row 7
- ``V4L2_DV_FL_IS_CE_VIDEO``
- If set, then this is a Consumer Electronics (CE) video format.
Such formats differ from other formats (commonly called IT
formats) in that if R'G'B' encoding is used then by default the
R'G'B' values use limited range (i.e. 16-235) as opposed to full
range (i.e. 0-255). All formats defined in CEA-861 except for the
640x480p59.94 format are CE formats.
- .. row 8
- ``V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE``
- Some formats like SMPTE-125M have an interlaced signal with a odd
total height. For these formats, if this flag is set, the first
field has the extra line. Else, it is the second field.

73
Documentation/media/uapi/v4l/vidioc-g-edid.rst
View File

@ -106,55 +106,30 @@ EDID is no longer available.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``pad``
- Pad for which to get/set the EDID blocks. When used with a video
- __u32 device node the pad represents the input or output index as
returned by :ref:`VIDIOC_ENUMINPUT` and
- ``pad`` :ref:`VIDIOC_ENUMOUTPUT` respectively.
* - __u32
- Pad for which to get/set the EDID blocks. When used with a video - ``start_block``
device node the pad represents the input or output index as - Read the EDID from starting with this block. Must be 0 when
returned by :ref:`VIDIOC_ENUMINPUT` and setting the EDID.
:ref:`VIDIOC_ENUMOUTPUT` respectively. * - __u32
- ``blocks``
- .. row 2 - The number of blocks to get or set. Must be less or equal to 256
(the maximum number of blocks as defined by the standard). When
- __u32 you set the EDID and ``blocks`` is 0, then the EDID is disabled or
erased.
- ``start_block`` * - __u32
- ``reserved``\ [5]
- Read the EDID from starting with this block. Must be 0 when - Reserved for future extensions. Applications and drivers must set
setting the EDID. the array to zero.
* - __u8 *
- .. row 3 - ``edid``
- Pointer to memory that contains the EDID. The minimum size is
- __u32 ``blocks`` * 128.
- ``blocks``
- The number of blocks to get or set. Must be less or equal to 256
(the maximum number of blocks as defined by the standard). When
you set the EDID and ``blocks`` is 0, then the EDID is disabled or
erased.
- .. row 4
- __u32
- ``reserved``\ [5]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
- .. row 5
- __u8 *
- ``edid``
- Pointer to memory that contains the EDID. The minimum size is
``blocks`` * 128.
Return Value Return Value

167
Documentation/media/uapi/v4l/vidioc-g-enc-index.rst
View File

@ -64,42 +64,22 @@ video elementary streams.
:stub-columns: 0 :stub-columns: 0
:widths: 1 3 8 :widths: 1 3 8
* - __u32
- .. row 1 - ``entries``
- The number of entries the driver stored in the ``entry`` array.
- __u32 * - __u32
- ``entries_cap``
- ``entries`` - The number of entries the driver can buffer. Must be greater than
zero.
- The number of entries the driver stored in the ``entry`` array. * - __u32
- ``reserved``\ [4]
- .. row 2 - Reserved for future extensions. Drivers must set the
array to zero.
- __u32 * - struct :c:type:`v4l2_enc_idx_entry`
- ``entry``\ [``V4L2_ENC_IDX_ENTRIES``]
- ``entries_cap`` - Meta data about a compressed video stream. Each element of the
array corresponds to one picture, sorted in ascending order by
- The number of entries the driver can buffer. Must be greater than their ``offset``.
zero.
- .. row 3
- __u32
- ``reserved``\ [4]
- Reserved for future extensions. Drivers must set the
array to zero.
- .. row 4
- struct :c:type:`v4l2_enc_idx_entry`
- ``entry``\ [``V4L2_ENC_IDX_ENTRIES``]
- Meta data about a compressed video stream. Each element of the
array corresponds to one picture, sorted in ascending order by
their ``offset``.
@ -112,53 +92,28 @@ video elementary streams.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u64
- .. row 1 - ``offset``
- The offset in bytes from the beginning of the compressed video
- __u64 stream to the beginning of this picture, that is a *PES packet
header* as defined in :ref:`mpeg2part1` or a *picture header* as
- ``offset`` defined in :ref:`mpeg2part2`. When the encoder is stopped, the
driver resets the offset to zero.
- The offset in bytes from the beginning of the compressed video * - __u64
stream to the beginning of this picture, that is a *PES packet - ``pts``
header* as defined in :ref:`mpeg2part1` or a *picture header* as - The 33 bit *Presentation Time Stamp* of this picture as defined in
defined in :ref:`mpeg2part2`. When the encoder is stopped, the :ref:`mpeg2part1`.
driver resets the offset to zero. * - __u32
- ``length``
- .. row 2 - The length of this picture in bytes.
* - __u32
- __u64 - ``flags``
- Flags containing the coding type of this picture, see
- ``pts`` :ref:`enc-idx-flags`.
* - __u32
- The 33 bit *Presentation Time Stamp* of this picture as defined in - ``reserved``\ [2]
:ref:`mpeg2part1`. - Reserved for future extensions. Drivers must set the array to
zero.
- .. row 3
- __u32
- ``length``
- The length of this picture in bytes.
- .. row 4
- __u32
- ``flags``
- Flags containing the coding type of this picture, see
:ref:`enc-idx-flags`.
- .. row 5
- __u32
- ``reserved``\ [2]
- Reserved for future extensions. Drivers must set the array to
zero.
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
@ -170,39 +125,19 @@ video elementary streams.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_ENC_IDX_FRAME_I``
- .. row 1 - 0x00
- This is an Intra-coded picture.
- ``V4L2_ENC_IDX_FRAME_I`` * - ``V4L2_ENC_IDX_FRAME_P``
- 0x01
- 0x00 - This is a Predictive-coded picture.
* - ``V4L2_ENC_IDX_FRAME_B``
- This is an Intra-coded picture. - 0x02
- This is a Bidirectionally predictive-coded picture.
- .. row 2 * - ``V4L2_ENC_IDX_FRAME_MASK``
- 0x0F
- ``V4L2_ENC_IDX_FRAME_P`` - *AND* the flags field with this mask to obtain the picture coding
type.
- 0x01
- This is a Predictive-coded picture.
- .. row 3
- ``V4L2_ENC_IDX_FRAME_B``
- 0x02
- This is a Bidirectionally predictive-coded picture.
- .. row 4
- ``V4L2_ENC_IDX_FRAME_MASK``
- 0x0F
- *AND* the flags field with this mask to obtain the picture coding
type.
Return Value Return Value

516
Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst
View File

@ -111,127 +111,73 @@ still cause this situation.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 2 :widths: 1 1 1 2
* - __u32
- ``id``
-
- Identifies the control, set by the application.
* - __u32
- ``size``
-
- The total size in bytes of the payload of this control. This is
normally 0, but for pointer controls this should be set to the
size of the memory containing the payload, or that will receive
the payload. If :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` finds that this value is
less than is required to store the payload result, then it is set
to a value large enough to store the payload result and ``ENOSPC`` is
returned.
- .. row 1 .. note::
- __u32 For string controls, this ``size`` field should
not be confused with the length of the string. This field refers
- ``id`` to the size of the memory that contains the string. The actual
*length* of the string may well be much smaller.
- * - __u32
- Identifies the control, set by the application. - ``reserved2``\ [1]
-
- .. row 2 - Reserved for future extensions. Drivers and applications must set
the array to zero.
- __u32 * - union
- (anonymous)
- ``size`` * -
- __s32
- - ``value``
- The total size in bytes of the payload of this control. This is - New value or current value. Valid if this control is not of type
normally 0, but for pointer controls this should be set to the ``V4L2_CTRL_TYPE_INTEGER64`` and ``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is
size of the memory containing the payload, or that will receive not set.
the payload. If :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` finds that this value is * -
less than is required to store the payload result, then it is set - __s64
to a value large enough to store the payload result and ``ENOSPC`` is - ``value64``
returned. - New value or current value. Valid if this control is of type
``V4L2_CTRL_TYPE_INTEGER64`` and ``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is
.. note:: not set.
* -
For string controls, this ``size`` field should - char *
not be confused with the length of the string. This field refers - ``string``
to the size of the memory that contains the string. The actual - A pointer to a string. Valid if this control is of type
*length* of the string may well be much smaller. ``V4L2_CTRL_TYPE_STRING``.
* -
- .. row 3 - __u8 *
- ``p_u8``
- __u32 - A pointer to a matrix control of unsigned 8-bit values. Valid if
this control is of type ``V4L2_CTRL_TYPE_U8``.
- ``reserved2``\ [1] * -
- __u16 *
- - ``p_u16``
- Reserved for future extensions. Drivers and applications must set - A pointer to a matrix control of unsigned 16-bit values. Valid if
the array to zero. this control is of type ``V4L2_CTRL_TYPE_U16``.
* -
- .. row 4 - __u32 *
- ``p_u32``
- union - A pointer to a matrix control of unsigned 32-bit values. Valid if
this control is of type ``V4L2_CTRL_TYPE_U32``.
- (anonymous) * -
- void *
- .. row 5 - ``ptr``
- A pointer to a compound type which can be an N-dimensional array
- and/or a compound type (the control's type is >=
- __s32 ``V4L2_CTRL_COMPOUND_TYPES``). Valid if
``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is set for this control.
- ``value``
- New value or current value. Valid if this control is not of type
``V4L2_CTRL_TYPE_INTEGER64`` and ``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is
not set.
- .. row 6
-
- __s64
- ``value64``
- New value or current value. Valid if this control is of type
``V4L2_CTRL_TYPE_INTEGER64`` and ``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is
not set.
- .. row 7
-
- char *
- ``string``
- A pointer to a string. Valid if this control is of type
``V4L2_CTRL_TYPE_STRING``.
- .. row 8
-
- __u8 *
- ``p_u8``
- A pointer to a matrix control of unsigned 8-bit values. Valid if
this control is of type ``V4L2_CTRL_TYPE_U8``.
- .. row 9
-
- __u16 *
- ``p_u16``
- A pointer to a matrix control of unsigned 16-bit values. Valid if
this control is of type ``V4L2_CTRL_TYPE_U16``.
- .. row 10
-
- __u32 *
- ``p_u32``
- A pointer to a matrix control of unsigned 32-bit values. Valid if
this control is of type ``V4L2_CTRL_TYPE_U32``.
- .. row 11
-
- void *
- ``ptr``
- A pointer to a compound type which can be an N-dimensional array
and/or a compound type (the control's type is >=
``V4L2_CTRL_COMPOUND_TYPES``). Valid if
``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is set for this control.
.. tabularcolumns:: |p{4.0cm}|p{2.0cm}|p{2.0cm}|p{8.5cm}| .. tabularcolumns:: |p{4.0cm}|p{2.0cm}|p{2.0cm}|p{8.5cm}|
@ -245,130 +191,96 @@ still cause this situation.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 :widths: 1 1 2 1
* - union
- (anonymous)
* -
- __u32
- ``ctrl_class``
- The control class to which all controls belong, see
:ref:`ctrl-class`. Drivers that use a kernel framework for
handling controls will also accept a value of 0 here, meaning that
the controls can belong to any control class. Whether drivers
support this can be tested by setting ``ctrl_class`` to 0 and
calling :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` with a ``count`` of 0. If that
succeeds, then the driver supports this feature.
* -
- __u32
- ``which``
- Which value of the control to get/set/try.
``V4L2_CTRL_WHICH_CUR_VAL`` will return the current value of the
control and ``V4L2_CTRL_WHICH_DEF_VAL`` will return the default
value of the control.
- .. row 1 .. note::
- union You can only get the default value of the control,
you cannot set or try it.
- (anonymous) For backwards compatibility you can also use a control class here
(see :ref:`ctrl-class`). In that case all controls have to
belong to that control class. This usage is deprecated, instead
just use ``V4L2_CTRL_WHICH_CUR_VAL``. There are some very old
drivers that do not yet support ``V4L2_CTRL_WHICH_CUR_VAL`` and
that require a control class here. You can test for such drivers
by setting ctrl_class to ``V4L2_CTRL_WHICH_CUR_VAL`` and calling
VIDIOC_TRY_EXT_CTRLS with a count of 0. If that fails, then the
driver does not support ``V4L2_CTRL_WHICH_CUR_VAL``.
* - __u32
- ``count``
- The number of controls in the controls array. May also be zero.
* - __u32
- ``error_idx``
- Set by the driver in case of an error. If the error is associated
with a particular control, then ``error_idx`` is set to the index
of that control. If the error is not related to a specific
control, or the validation step failed (see below), then
``error_idx`` is set to ``count``. The value is undefined if the
ioctl returned 0 (success).
- .. row 2 Before controls are read from/written to hardware a validation
step takes place: this checks if all controls in the list are
valid controls, if no attempt is made to write to a read-only
control or read from a write-only control, and any other up-front
checks that can be done without accessing the hardware. The exact
validations done during this step are driver dependent since some
checks might require hardware access for some devices, thus making
it impossible to do those checks up-front. However, drivers should
make a best-effort to do as many up-front checks as possible.
- This check is done to avoid leaving the hardware in an
- __u32 inconsistent state due to easy-to-avoid problems. But it leads to
another problem: the application needs to know whether an error
came from the validation step (meaning that the hardware was not
touched) or from an error during the actual reading from/writing
to hardware.
- ``ctrl_class`` The, in hindsight quite poor, solution for that is to set
``error_idx`` to ``count`` if the validation failed. This has the
unfortunate side-effect that it is not possible to see which
control failed the validation. If the validation was successful
and the error happened while accessing the hardware, then
``error_idx`` is less than ``count`` and only the controls up to
``error_idx-1`` were read or written correctly, and the state of
the remaining controls is undefined.
- The control class to which all controls belong, see Since :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` does not access hardware there is
:ref:`ctrl-class`. Drivers that use a kernel framework for also no need to handle the validation step in this special way, so
handling controls will also accept a value of 0 here, meaning that ``error_idx`` will just be set to the control that failed the
the controls can belong to any control class. Whether drivers validation step instead of to ``count``. This means that if
support this can be tested by setting ``ctrl_class`` to 0 and :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` fails with ``error_idx`` set to ``count``,
calling :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` with a ``count`` of 0. If that then you can call :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` to try to discover the
succeeds, then the driver supports this feature. actual control that failed the validation step. Unfortunately,
there is no ``TRY`` equivalent for :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`.
* - __u32
- ``reserved``\ [2]
- Reserved for future extensions.
- .. row 3 Drivers and applications must set the array to zero.
* - struct :c:type:`v4l2_ext_control` *
- ``controls``
- Pointer to an array of ``count`` v4l2_ext_control structures.
- Ignored if ``count`` equals zero.
- __u32
- ``which``
- Which value of the control to get/set/try.
``V4L2_CTRL_WHICH_CUR_VAL`` will return the current value of the
control and ``V4L2_CTRL_WHICH_DEF_VAL`` will return the default
value of the control.
.. note::
You can only get the default value of the control,
you cannot set or try it.
For backwards compatibility you can also use a control class here
(see :ref:`ctrl-class`). In that case all controls have to
belong to that control class. This usage is deprecated, instead
just use ``V4L2_CTRL_WHICH_CUR_VAL``. There are some very old
drivers that do not yet support ``V4L2_CTRL_WHICH_CUR_VAL`` and
that require a control class here. You can test for such drivers
by setting ctrl_class to ``V4L2_CTRL_WHICH_CUR_VAL`` and calling
VIDIOC_TRY_EXT_CTRLS with a count of 0. If that fails, then the
driver does not support ``V4L2_CTRL_WHICH_CUR_VAL``.
- .. row 4
- __u32
- ``count``
- The number of controls in the controls array. May also be zero.
- .. row 5
- __u32
- ``error_idx``
- Set by the driver in case of an error. If the error is associated
with a particular control, then ``error_idx`` is set to the index
of that control. If the error is not related to a specific
control, or the validation step failed (see below), then
``error_idx`` is set to ``count``. The value is undefined if the
ioctl returned 0 (success).
Before controls are read from/written to hardware a validation
step takes place: this checks if all controls in the list are
valid controls, if no attempt is made to write to a read-only
control or read from a write-only control, and any other up-front
checks that can be done without accessing the hardware. The exact
validations done during this step are driver dependent since some
checks might require hardware access for some devices, thus making
it impossible to do those checks up-front. However, drivers should
make a best-effort to do as many up-front checks as possible.
This check is done to avoid leaving the hardware in an
inconsistent state due to easy-to-avoid problems. But it leads to
another problem: the application needs to know whether an error
came from the validation step (meaning that the hardware was not
touched) or from an error during the actual reading from/writing
to hardware.
The, in hindsight quite poor, solution for that is to set
``error_idx`` to ``count`` if the validation failed. This has the
unfortunate side-effect that it is not possible to see which
control failed the validation. If the validation was successful
and the error happened while accessing the hardware, then
``error_idx`` is less than ``count`` and only the controls up to
``error_idx-1`` were read or written correctly, and the state of
the remaining controls is undefined.
Since :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` does not access hardware there is
also no need to handle the validation step in this special way, so
``error_idx`` will just be set to the control that failed the
validation step instead of to ``count``. This means that if
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` fails with ``error_idx`` set to ``count``,
then you can call :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` to try to discover the
actual control that failed the validation step. Unfortunately,
there is no ``TRY`` equivalent for :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`.
- .. row 6
- __u32
- ``reserved``\ [2]
- Reserved for future extensions.
Drivers and applications must set the array to zero.
- .. row 7
- struct :c:type:`v4l2_ext_control` *
- ``controls``
- Pointer to an array of ``count`` v4l2_ext_control structures.
Ignored if ``count`` equals zero.
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
@ -380,99 +292,49 @@ still cause this situation.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_CTRL_CLASS_USER``
- .. row 1 - 0x980000
- The class containing user controls. These controls are described
- ``V4L2_CTRL_CLASS_USER`` in :ref:`control`. All controls that can be set using the
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and
- 0x980000 :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this
class.
- The class containing user controls. These controls are described * - ``V4L2_CTRL_CLASS_MPEG``
in :ref:`control`. All controls that can be set using the - 0x990000
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and - The class containing MPEG compression controls. These controls are
:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this described in :ref:`mpeg-controls`.
class. * - ``V4L2_CTRL_CLASS_CAMERA``
- 0x9a0000
- .. row 2 - The class containing camera controls. These controls are described
in :ref:`camera-controls`.
- ``V4L2_CTRL_CLASS_MPEG`` * - ``V4L2_CTRL_CLASS_FM_TX``
- 0x9b0000
- 0x990000 - The class containing FM Transmitter (FM TX) controls. These
controls are described in :ref:`fm-tx-controls`.
- The class containing MPEG compression controls. These controls are * - ``V4L2_CTRL_CLASS_FLASH``
described in :ref:`mpeg-controls`. - 0x9c0000
- The class containing flash device controls. These controls are
- .. row 3 described in :ref:`flash-controls`.
* - ``V4L2_CTRL_CLASS_JPEG``
- ``V4L2_CTRL_CLASS_CAMERA`` - 0x9d0000
- The class containing JPEG compression controls. These controls are
- 0x9a0000 described in :ref:`jpeg-controls`.
* - ``V4L2_CTRL_CLASS_IMAGE_SOURCE``
- The class containing camera controls. These controls are described - 0x9e0000
in :ref:`camera-controls`. - The class containing image source controls. These controls are
described in :ref:`image-source-controls`.
- .. row 4 * - ``V4L2_CTRL_CLASS_IMAGE_PROC``
- 0x9f0000
- ``V4L2_CTRL_CLASS_FM_TX`` - The class containing image processing controls. These controls are
described in :ref:`image-process-controls`.
- 0x9b0000 * - ``V4L2_CTRL_CLASS_FM_RX``
- 0xa10000
- The class containing FM Transmitter (FM TX) controls. These - The class containing FM Receiver (FM RX) controls. These controls
controls are described in :ref:`fm-tx-controls`. are described in :ref:`fm-rx-controls`.
* - ``V4L2_CTRL_CLASS_RF_TUNER``
- .. row 5 - 0xa20000
- The class containing RF tuner controls. These controls are
- ``V4L2_CTRL_CLASS_FLASH`` described in :ref:`rf-tuner-controls`.
- 0x9c0000
- The class containing flash device controls. These controls are
described in :ref:`flash-controls`.
- .. row 6
- ``V4L2_CTRL_CLASS_JPEG``
- 0x9d0000
- The class containing JPEG compression controls. These controls are
described in :ref:`jpeg-controls`.
- .. row 7
- ``V4L2_CTRL_CLASS_IMAGE_SOURCE``
- 0x9e0000
- The class containing image source controls. These controls are
described in :ref:`image-source-controls`.
- .. row 8
- ``V4L2_CTRL_CLASS_IMAGE_PROC``
- 0x9f0000
- The class containing image processing controls. These controls are
described in :ref:`image-process-controls`.
- .. row 9
- ``V4L2_CTRL_CLASS_FM_RX``
- 0xa10000
- The class containing FM Receiver (FM RX) controls. These controls
are described in :ref:`fm-rx-controls`.
- .. row 10
- ``V4L2_CTRL_CLASS_RF_TUNER``
- 0xa20000
- The class containing RF tuner controls. These controls are
described in :ref:`rf-tuner-controls`.
Return Value Return Value

581
Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
View File

@ -86,201 +86,126 @@ destructive video overlay.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 2 :widths: 1 1 1 2
* - __u32
- ``capability``
-
- Overlay capability flags set by the driver, see
:ref:`framebuffer-cap`.
* - __u32
- ``flags``
-
- Overlay control flags set by application and driver, see
:ref:`framebuffer-flags`
* - void *
- ``base``
-
- Physical base address of the framebuffer, that is the address of
the pixel in the top left corner of the framebuffer. [#f1]_
* -
-
-
- This field is irrelevant to *non-destructive Video Overlays*. For
*destructive Video Overlays* applications must provide a base
address. The driver may accept only base addresses which are a
multiple of two, four or eight bytes. For *Video Output Overlays*
the driver must return a valid base address, so applications can
find the corresponding Linux framebuffer device (see
:ref:`osd`).
* - struct
- ``fmt``
-
- Layout of the frame buffer.
* -
- __u32
- ``width``
- Width of the frame buffer in pixels.
* -
- __u32
- ``height``
- Height of the frame buffer in pixels.
* -
- __u32
- ``pixelformat``
- The pixel format of the framebuffer.
* -
-
-
- For *non-destructive Video Overlays* this field only defines a
format for the struct :c:type:`v4l2_window`
``chromakey`` field.
* -
-
-
- For *destructive Video Overlays* applications must initialize this
field. For *Video Output Overlays* the driver must return a valid
format.
* -
-
-
- Usually this is an RGB format (for example
:ref:`V4L2_PIX_FMT_RGB565 <V4L2-PIX-FMT-RGB565>`) but YUV
formats (only packed YUV formats when chroma keying is used, not
including ``V4L2_PIX_FMT_YUYV`` and ``V4L2_PIX_FMT_UYVY``) and the
``V4L2_PIX_FMT_PAL8`` format are also permitted. The behavior of
the driver when an application requests a compressed format is
undefined. See :ref:`pixfmt` for information on pixel formats.
* -
- enum :c:type:`v4l2_field`
- ``field``
- Drivers and applications shall ignore this field. If applicable,
the field order is selected with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, using the ``field``
field of struct :c:type:`v4l2_window`.
* -
- __u32
- ``bytesperline``
- Distance in bytes between the leftmost pixels in two adjacent
lines.
* - :cspan:`3`
- .. row 1 This field is irrelevant to *non-destructive Video Overlays*.
- __u32 For *destructive Video Overlays* both applications and drivers can
set this field to request padding bytes at the end of each line.
Drivers however may ignore the requested value, returning
``width`` times bytes-per-pixel or a larger value required by the
hardware. That implies applications can just set this field to
zero to get a reasonable default.
- ``capability`` For *Video Output Overlays* the driver must return a valid value.
- Video hardware may access padding bytes, therefore they must
- Overlay capability flags set by the driver, see reside in accessible memory. Consider for example the case where
:ref:`framebuffer-cap`. padding bytes after the last line of an image cross a system page
boundary. Capture devices may write padding bytes, the value is
undefined. Output devices ignore the contents of padding bytes.
- .. row 2 When the image format is planar the ``bytesperline`` value applies
to the first plane and is divided by the same factor as the
``width`` field for the other planes. For example the Cb and Cr
planes of a YUV 4:2:0 image have half as many padding bytes
following each line as the Y plane. To avoid ambiguities drivers
must return a ``bytesperline`` value rounded up to a multiple of
the scale factor.
* -
- __u32
- ``sizeimage``
- This field is irrelevant to *non-destructive Video Overlays*. For
*destructive Video Overlays* applications must initialize this
field. For *Video Output Overlays* the driver must return a valid
format.
- __u32 Together with ``base`` it defines the framebuffer memory
accessible by the driver.
- ``flags`` * -
- enum :c:type:`v4l2_colorspace`
- - ``colorspace``
- Overlay control flags set by application and driver, see - This information supplements the ``pixelformat`` and must be set
:ref:`framebuffer-flags` by the driver, see :ref:`colorspaces`.
* -
- .. row 3 - __u32
- ``priv``
- void * - Reserved. Drivers and applications must set this field to zero.
- ``base``
-
- Physical base address of the framebuffer, that is the address of
the pixel in the top left corner of the framebuffer. [#f1]_
- .. row 4
-
-
-
- This field is irrelevant to *non-destructive Video Overlays*. For
*destructive Video Overlays* applications must provide a base
address. The driver may accept only base addresses which are a
multiple of two, four or eight bytes. For *Video Output Overlays*
the driver must return a valid base address, so applications can
find the corresponding Linux framebuffer device (see
:ref:`osd`).
- .. row 5
- struct
- ``fmt``
-
- Layout of the frame buffer.
- .. row 6
-
- __u32
- ``width``
- Width of the frame buffer in pixels.
- .. row 7
-
- __u32
- ``height``
- Height of the frame buffer in pixels.
- .. row 8
-
- __u32
- ``pixelformat``
- The pixel format of the framebuffer.
- .. row 9
-
-
-
- For *non-destructive Video Overlays* this field only defines a
format for the struct :c:type:`v4l2_window`
``chromakey`` field.
- .. row 10
-
-
-
- For *destructive Video Overlays* applications must initialize this
field. For *Video Output Overlays* the driver must return a valid
format.
- .. row 11
-
-
-
- Usually this is an RGB format (for example
:ref:`V4L2_PIX_FMT_RGB565 <V4L2-PIX-FMT-RGB565>`) but YUV
formats (only packed YUV formats when chroma keying is used, not
including ``V4L2_PIX_FMT_YUYV`` and ``V4L2_PIX_FMT_UYVY``) and the
``V4L2_PIX_FMT_PAL8`` format are also permitted. The behavior of
the driver when an application requests a compressed format is
undefined. See :ref:`pixfmt` for information on pixel formats.
- .. row 12
-
- enum :c:type:`v4l2_field`
- ``field``
- Drivers and applications shall ignore this field. If applicable,
the field order is selected with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, using the ``field``
field of struct :c:type:`v4l2_window`.
- .. row 13
-
- __u32
- ``bytesperline``
- Distance in bytes between the leftmost pixels in two adjacent
lines.
- .. row 14
- :cspan:`3`
This field is irrelevant to *non-destructive Video Overlays*.
For *destructive Video Overlays* both applications and drivers can
set this field to request padding bytes at the end of each line.
Drivers however may ignore the requested value, returning
``width`` times bytes-per-pixel or a larger value required by the
hardware. That implies applications can just set this field to
zero to get a reasonable default.
For *Video Output Overlays* the driver must return a valid value.
Video hardware may access padding bytes, therefore they must
reside in accessible memory. Consider for example the case where
padding bytes after the last line of an image cross a system page
boundary. Capture devices may write padding bytes, the value is
undefined. Output devices ignore the contents of padding bytes.
When the image format is planar the ``bytesperline`` value applies
to the first plane and is divided by the same factor as the
``width`` field for the other planes. For example the Cb and Cr
planes of a YUV 4:2:0 image have half as many padding bytes
following each line as the Y plane. To avoid ambiguities drivers
must return a ``bytesperline`` value rounded up to a multiple of
the scale factor.
- .. row 15
-
- __u32
- ``sizeimage``
- This field is irrelevant to *non-destructive Video Overlays*. For
*destructive Video Overlays* applications must initialize this
field. For *Video Output Overlays* the driver must return a valid
format.
Together with ``base`` it defines the framebuffer memory
accessible by the driver.
- .. row 16
-
- enum :c:type:`v4l2_colorspace`
- ``colorspace``
- This information supplements the ``pixelformat`` and must be set
by the driver, see :ref:`colorspaces`.
- .. row 17
-
- __u32
- ``priv``
- Reserved. Drivers and applications must set this field to zero.
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
@ -292,84 +217,44 @@ destructive video overlay.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_FBUF_CAP_EXTERNOVERLAY``
- .. row 1 - 0x0001
- The device is capable of non-destructive overlays. When the driver
- ``V4L2_FBUF_CAP_EXTERNOVERLAY`` clears this flag, only destructive overlays are supported. There
are no drivers yet which support both destructive and
- 0x0001 non-destructive overlays. Video Output Overlays are in practice
always non-destructive.
- The device is capable of non-destructive overlays. When the driver * - ``V4L2_FBUF_CAP_CHROMAKEY``
clears this flag, only destructive overlays are supported. There - 0x0002
are no drivers yet which support both destructive and - The device supports clipping by chroma-keying the images. That is,
non-destructive overlays. Video Output Overlays are in practice image pixels replace pixels in the VGA or video signal only where
always non-destructive. the latter assume a certain color. Chroma-keying makes no sense
for destructive overlays.
- .. row 2 * - ``V4L2_FBUF_CAP_LIST_CLIPPING``
- 0x0004
- ``V4L2_FBUF_CAP_CHROMAKEY`` - The device supports clipping using a list of clip rectangles.
* - ``V4L2_FBUF_CAP_BITMAP_CLIPPING``
- 0x0002 - 0x0008
- The device supports clipping using a bit mask.
- The device supports clipping by chroma-keying the images. That is, * - ``V4L2_FBUF_CAP_LOCAL_ALPHA``
image pixels replace pixels in the VGA or video signal only where - 0x0010
the latter assume a certain color. Chroma-keying makes no sense - The device supports clipping/blending using the alpha channel of
for destructive overlays. the framebuffer or VGA signal. Alpha blending makes no sense for
destructive overlays.
- .. row 3 * - ``V4L2_FBUF_CAP_GLOBAL_ALPHA``
- 0x0020
- ``V4L2_FBUF_CAP_LIST_CLIPPING`` - The device supports alpha blending using a global alpha value.
Alpha blending makes no sense for destructive overlays.
- 0x0004 * - ``V4L2_FBUF_CAP_LOCAL_INV_ALPHA``
- 0x0040
- The device supports clipping using a list of clip rectangles. - The device supports clipping/blending using the inverted alpha
channel of the framebuffer or VGA signal. Alpha blending makes no
- .. row 4 sense for destructive overlays.
* - ``V4L2_FBUF_CAP_SRC_CHROMAKEY``
- ``V4L2_FBUF_CAP_BITMAP_CLIPPING`` - 0x0080
- The device supports Source Chroma-keying. Video pixels with the
- 0x0008 chroma-key colors are replaced by framebuffer pixels, which is
exactly opposite of ``V4L2_FBUF_CAP_CHROMAKEY``
- The device supports clipping using a bit mask.
- .. row 5
- ``V4L2_FBUF_CAP_LOCAL_ALPHA``
- 0x0010
- The device supports clipping/blending using the alpha channel of
the framebuffer or VGA signal. Alpha blending makes no sense for
destructive overlays.
- .. row 6
- ``V4L2_FBUF_CAP_GLOBAL_ALPHA``
- 0x0020
- The device supports alpha blending using a global alpha value.
Alpha blending makes no sense for destructive overlays.
- .. row 7
- ``V4L2_FBUF_CAP_LOCAL_INV_ALPHA``
- 0x0040
- The device supports clipping/blending using the inverted alpha
channel of the framebuffer or VGA signal. Alpha blending makes no
sense for destructive overlays.
- .. row 8
- ``V4L2_FBUF_CAP_SRC_CHROMAKEY``
- 0x0080
- The device supports Source Chroma-keying. Video pixels with the
chroma-key colors are replaced by framebuffer pixels, which is
exactly opposite of ``V4L2_FBUF_CAP_CHROMAKEY``
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
@ -383,106 +268,68 @@ destructive video overlay.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_FBUF_FLAG_PRIMARY``
- .. row 1 - 0x0001
- The framebuffer is the primary graphics surface. In other words,
- ``V4L2_FBUF_FLAG_PRIMARY`` the overlay is destructive. This flag is typically set by any
driver that doesn't have the ``V4L2_FBUF_CAP_EXTERNOVERLAY``
- 0x0001 capability and it is cleared otherwise.
* - ``V4L2_FBUF_FLAG_OVERLAY``
- The framebuffer is the primary graphics surface. In other words, - 0x0002
the overlay is destructive. This flag is typically set by any - If this flag is set for a video capture device, then the driver
driver that doesn't have the ``V4L2_FBUF_CAP_EXTERNOVERLAY`` will set the initial overlay size to cover the full framebuffer
capability and it is cleared otherwise. size, otherwise the existing overlay size (as set by
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) will be used. Only one
- .. row 2 video capture driver (bttv) supports this flag. The use of this
flag for capture devices is deprecated. There is no way to detect
- ``V4L2_FBUF_FLAG_OVERLAY`` which drivers support this flag, so the only reliable method of
setting the overlay size is through
- 0x0002 :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. If this flag is set for a
video output device, then the video output overlay window is
- If this flag is set for a video capture device, then the driver relative to the top-left corner of the framebuffer and restricted
will set the initial overlay size to cover the full framebuffer to the size of the framebuffer. If it is cleared, then the video
size, otherwise the existing overlay size (as set by output overlay window is relative to the video output display.
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) will be used. Only one * - ``V4L2_FBUF_FLAG_CHROMAKEY``
video capture driver (bttv) supports this flag. The use of this - 0x0004
flag for capture devices is deprecated. There is no way to detect - Use chroma-keying. The chroma-key color is determined by the
which drivers support this flag, so the only reliable method of ``chromakey`` field of struct :c:type:`v4l2_window`
setting the overlay size is through and negotiated with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. If this flag is set for a ioctl, see :ref:`overlay` and :ref:`osd`.
video output device, then the video output overlay window is * - :cspan:`2` There are no flags to enable clipping using a list of
relative to the top-left corner of the framebuffer and restricted clip rectangles or a bitmap. These methods are negotiated with the
to the size of the framebuffer. If it is cleared, then the video :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
output overlay window is relative to the video output display. and :ref:`osd`.
* - ``V4L2_FBUF_FLAG_LOCAL_ALPHA``
- .. row 3 - 0x0008
- Use the alpha channel of the framebuffer to clip or blend
- ``V4L2_FBUF_FLAG_CHROMAKEY`` framebuffer pixels with video images. The blend function is:
output = framebuffer pixel * alpha + video pixel * (1 - alpha).
- 0x0004 The actual alpha depth depends on the framebuffer pixel format.
* - ``V4L2_FBUF_FLAG_GLOBAL_ALPHA``
- Use chroma-keying. The chroma-key color is determined by the - 0x0010
``chromakey`` field of struct :c:type:`v4l2_window` - Use a global alpha value to blend the framebuffer with video
and negotiated with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` images. The blend function is: output = (framebuffer pixel * alpha
ioctl, see :ref:`overlay` and :ref:`osd`. + video pixel * (255 - alpha)) / 255. The alpha value is
determined by the ``global_alpha`` field of struct
- .. row 4 :c:type:`v4l2_window` and negotiated with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
- :cspan:`2` There are no flags to enable clipping using a list of and :ref:`osd`.
clip rectangles or a bitmap. These methods are negotiated with the * - ``V4L2_FBUF_FLAG_LOCAL_INV_ALPHA``
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay` - 0x0020
and :ref:`osd`. - Like ``V4L2_FBUF_FLAG_LOCAL_ALPHA``, use the alpha channel of the
framebuffer to clip or blend framebuffer pixels with video images,
- .. row 5 but with an inverted alpha value. The blend function is: output =
framebuffer pixel * (1 - alpha) + video pixel * alpha. The actual
- ``V4L2_FBUF_FLAG_LOCAL_ALPHA`` alpha depth depends on the framebuffer pixel format.
* - ``V4L2_FBUF_FLAG_SRC_CHROMAKEY``
- 0x0008 - 0x0040
- Use source chroma-keying. The source chroma-key color is
- Use the alpha channel of the framebuffer to clip or blend determined by the ``chromakey`` field of struct
framebuffer pixels with video images. The blend function is: :c:type:`v4l2_window` and negotiated with the
output = framebuffer pixel * alpha + video pixel * (1 - alpha). :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
The actual alpha depth depends on the framebuffer pixel format. and :ref:`osd`. Both chroma-keying are mutual exclusive to each
other, so same ``chromakey`` field of struct
- .. row 6 :c:type:`v4l2_window` is being used.
- ``V4L2_FBUF_FLAG_GLOBAL_ALPHA``
- 0x0010
- Use a global alpha value to blend the framebuffer with video
images. The blend function is: output = (framebuffer pixel * alpha
+ video pixel * (255 - alpha)) / 255. The alpha value is
determined by the ``global_alpha`` field of struct
:c:type:`v4l2_window` and negotiated with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`.
- .. row 7
- ``V4L2_FBUF_FLAG_LOCAL_INV_ALPHA``
- 0x0020
- Like ``V4L2_FBUF_FLAG_LOCAL_ALPHA``, use the alpha channel of the
framebuffer to clip or blend framebuffer pixels with video images,
but with an inverted alpha value. The blend function is: output =
framebuffer pixel * (1 - alpha) + video pixel * alpha. The actual
alpha depth depends on the framebuffer pixel format.
- .. row 8
- ``V4L2_FBUF_FLAG_SRC_CHROMAKEY``
- 0x0040
- Use source chroma-keying. The source chroma-key color is
determined by the ``chromakey`` field of struct
:c:type:`v4l2_window` and negotiated with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`. Both chroma-keying are mutual exclusive to each
other, so same ``chromakey`` field of struct
:c:type:`v4l2_window` is being used.
Return Value Return Value

128
Documentation/media/uapi/v4l/vidioc-g-fmt.rst
View File

@ -93,92 +93,48 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - __u32
- .. row 1 - ``type``
-
- __u32 - Type of the data stream, see :c:type:`v4l2_buf_type`.
* - union
- ``type`` - ``fmt``
* -
- - struct :c:type:`v4l2_pix_format`
- Type of the data stream, see :c:type:`v4l2_buf_type`. - ``pix``
- Definition of an image format, see :ref:`pixfmt`, used by video
- .. row 2 capture and output devices.
* -
- union - struct :c:type:`v4l2_pix_format_mplane`
- ``pix_mp``
- ``fmt`` - Definition of an image format, see :ref:`pixfmt`, used by video
capture and output devices that support the
- .. row 3 :ref:`multi-planar version of the API <planar-apis>`.
* -
- - struct :c:type:`v4l2_window`
- struct :c:type:`v4l2_pix_format` - ``win``
- Definition of an overlaid image, see :ref:`overlay`, used by
- ``pix`` video overlay devices.
* -
- Definition of an image format, see :ref:`pixfmt`, used by video - struct :c:type:`v4l2_vbi_format`
capture and output devices. - ``vbi``
- Raw VBI capture or output parameters. This is discussed in more
- .. row 4 detail in :ref:`raw-vbi`. Used by raw VBI capture and output
devices.
- * -
- struct :c:type:`v4l2_pix_format_mplane` - struct :c:type:`v4l2_sliced_vbi_format`
- ``sliced``
- ``pix_mp`` - Sliced VBI capture or output parameters. See :ref:`sliced` for
details. Used by sliced VBI capture and output devices.
- Definition of an image format, see :ref:`pixfmt`, used by video * -
capture and output devices that support the - struct :c:type:`v4l2_sdr_format`
:ref:`multi-planar version of the API <planar-apis>`. - ``sdr``
- Definition of a data format, see :ref:`pixfmt`, used by SDR
- .. row 5 capture and output devices.
* -
- - __u8
- struct :c:type:`v4l2_window` - ``raw_data``\ [200]
- Place holder for future extensions.
- ``win``
- Definition of an overlaid image, see :ref:`overlay`, used by
video overlay devices.
- .. row 6
-
- struct :c:type:`v4l2_vbi_format`
- ``vbi``
- Raw VBI capture or output parameters. This is discussed in more
detail in :ref:`raw-vbi`. Used by raw VBI capture and output
devices.
- .. row 7
-
- struct :c:type:`v4l2_sliced_vbi_format`
- ``sliced``
- Sliced VBI capture or output parameters. See :ref:`sliced` for
details. Used by sliced VBI capture and output devices.
- .. row 8
-
- struct :c:type:`v4l2_sdr_format`
- ``sdr``
- Definition of a data format, see :ref:`pixfmt`, used by SDR
capture and output devices.
- .. row 9
-
- __u8
- ``raw_data``\ [200]
- Place holder for future extensions.
Return Value Return Value

74
Documentation/media/uapi/v4l/vidioc-g-frequency.rst
View File

@ -60,53 +60,33 @@ write-only ioctl, it does not return the actual new frequency.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``tuner``
- The tuner or modulator index number. This is the same value as in
- __u32 the struct :c:type:`v4l2_input` ``tuner`` field and
the struct :c:type:`v4l2_tuner` ``index`` field, or
- ``tuner`` the struct :c:type:`v4l2_output` ``modulator`` field
and the struct :c:type:`v4l2_modulator` ``index``
- The tuner or modulator index number. This is the same value as in field.
the struct :c:type:`v4l2_input` ``tuner`` field and * - __u32
the struct :c:type:`v4l2_tuner` ``index`` field, or - ``type``
the struct :c:type:`v4l2_output` ``modulator`` field - The tuner type. This is the same value as in the struct
and the struct :c:type:`v4l2_modulator` ``index`` :c:type:`v4l2_tuner` ``type`` field. The type must be
field. set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and
to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to
- .. row 2 ``V4L2_TUNER_RADIO`` for modulators (currently only radio
modulators are supported). See :c:type:`v4l2_tuner_type`
- __u32 * - __u32
- ``frequency``
- ``type`` - Tuning frequency in units of 62.5 kHz, or if the struct
:c:type:`v4l2_tuner` or struct
- The tuner type. This is the same value as in the struct :c:type:`v4l2_modulator` ``capability`` flag
:c:type:`v4l2_tuner` ``type`` field. The type must be ``V4L2_TUNER_CAP_LOW`` is set, in units of 62.5 Hz. A 1 Hz unit is
set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and used when the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to * - __u32
``V4L2_TUNER_RADIO`` for modulators (currently only radio - ``reserved``\ [8]
modulators are supported). See :c:type:`v4l2_tuner_type` - Reserved for future extensions. Drivers and applications must set
the array to zero.
- .. row 3
- __u32
- ``frequency``
- Tuning frequency in units of 62.5 kHz, or if the struct
:c:type:`v4l2_tuner` or struct
:c:type:`v4l2_modulator` ``capability`` flag
``V4L2_TUNER_CAP_LOW`` is set, in units of 62.5 Hz. A 1 Hz unit is
used when the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
- .. row 4
- __u32
- ``reserved``\ [8]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
Return Value Return Value

144
Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst
View File

@ -63,68 +63,33 @@ encoding. You usually do want to add them.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - int
- .. row 1 - ``quality``
- Deprecated. If
- int :ref:`V4L2_CID_JPEG_COMPRESSION_QUALITY <jpeg-quality-control>`
control is exposed by a driver applications should use it instead
- ``quality`` and ignore this field.
* - int
- Deprecated. If - ``APPn``
:ref:`V4L2_CID_JPEG_COMPRESSION_QUALITY <jpeg-quality-control>` -
control is exposed by a driver applications should use it instead * - int
and ignore this field. - ``APP_len``
-
- .. row 2 * - char
- ``APP_data``\ [60]
- int -
* - int
- ``APPn`` - ``COM_len``
-
- * - char
- ``COM_data``\ [60]
- .. row 3 -
* - __u32
- int - ``jpeg_markers``
- See :ref:`jpeg-markers`. Deprecated. If
- ``APP_len`` :ref:`V4L2_CID_JPEG_ACTIVE_MARKER <jpeg-active-marker-control>`
control is exposed by a driver applications should use it instead
- and ignore this field.
- .. row 4
- char
- ``APP_data``\ [60]
-
- .. row 5
- int
- ``COM_len``
-
- .. row 6
- char
- ``COM_data``\ [60]
-
- .. row 7
- __u32
- ``jpeg_markers``
- See :ref:`jpeg-markers`. Deprecated. If
:ref:`V4L2_CID_JPEG_ACTIVE_MARKER <jpeg-active-marker-control>`
control is exposed by a driver applications should use it instead
and ignore this field.
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
@ -136,46 +101,21 @@ encoding. You usually do want to add them.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_JPEG_MARKER_DHT``
- .. row 1 - (1<<3)
- Define Huffman Tables
- ``V4L2_JPEG_MARKER_DHT`` * - ``V4L2_JPEG_MARKER_DQT``
- (1<<4)
- (1<<3) - Define Quantization Tables
* - ``V4L2_JPEG_MARKER_DRI``
- Define Huffman Tables - (1<<5)
- Define Restart Interval
- .. row 2 * - ``V4L2_JPEG_MARKER_COM``
- (1<<6)
- ``V4L2_JPEG_MARKER_DQT`` - Comment segment
* - ``V4L2_JPEG_MARKER_APP``
- (1<<4) - (1<<7)
- App segment, driver will always use APP0
- Define Quantization Tables
- .. row 3
- ``V4L2_JPEG_MARKER_DRI``
- (1<<5)
- Define Restart Interval
- .. row 4
- ``V4L2_JPEG_MARKER_COM``
- (1<<6)
- Comment segment
- .. row 5
- ``V4L2_JPEG_MARKER_APP``
- (1<<7)
- App segment, driver will always use APP0
Return Value Return Value

260
Documentation/media/uapi/v4l/vidioc-g-modulator.rst
View File

@ -69,95 +69,55 @@ To change the radio frequency the
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 1 :widths: 1 1 2 1 1
* - __u32
- ``index``
- Identifies the modulator, set by the application.
* - __u8
- ``name``\ [32]
- Name of the modulator, a NUL-terminated ASCII string.
- .. row 1 This information is intended for the user.
* - __u32
- ``capability``
- Modulator capability flags. No flags are defined for this field,
the tuner flags in struct :c:type:`v4l2_tuner` are
used accordingly. The audio flags indicate the ability to encode
audio subprograms. They will *not* change for example with the
current video standard.
* - __u32
- ``rangelow``
- The lowest tunable frequency in units of 62.5 KHz, or if the
``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units of
62.5 Hz, or if the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is
set, in units of 1 Hz.
* - __u32
- ``rangehigh``
- The highest tunable frequency in units of 62.5 KHz, or if the
``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units of
62.5 Hz, or if the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is
set, in units of 1 Hz.
* - __u32
- ``txsubchans``
- With this field applications can determine how audio sub-carriers
shall be modulated. It contains a set of flags as defined in
:ref:`modulator-txsubchans`.
- __u32 .. note::
- ``index`` The tuner ``rxsubchans`` flags are reused, but the
semantics are different. Video output devices
are assumed to have an analog or PCM audio input with 1-3
channels. The ``txsubchans`` flags select one or more channels
for modulation, together with some audio subprogram indicator,
for example, a stereo pilot tone.
* - __u32
- ``type``
- :cspan:`2` Type of the modulator, see :c:type:`v4l2_tuner_type`.
* - __u32
- ``reserved``\ [3]
- Reserved for future extensions.
- Identifies the modulator, set by the application. Drivers and applications must set the array to zero.
- .. row 2
- __u8
- ``name``\ [32]
- Name of the modulator, a NUL-terminated ASCII string.
This information is intended for the user.
- .. row 3
- __u32
- ``capability``
- Modulator capability flags. No flags are defined for this field,
the tuner flags in struct :c:type:`v4l2_tuner` are
used accordingly. The audio flags indicate the ability to encode
audio subprograms. They will *not* change for example with the
current video standard.
- .. row 4
- __u32
- ``rangelow``
- The lowest tunable frequency in units of 62.5 KHz, or if the
``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units of
62.5 Hz, or if the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is
set, in units of 1 Hz.
- .. row 5
- __u32
- ``rangehigh``
- The highest tunable frequency in units of 62.5 KHz, or if the
``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units of
62.5 Hz, or if the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is
set, in units of 1 Hz.
- .. row 6
- __u32
- ``txsubchans``
- With this field applications can determine how audio sub-carriers
shall be modulated. It contains a set of flags as defined in
:ref:`modulator-txsubchans`.
.. note::
The tuner ``rxsubchans`` flags are reused, but the
semantics are different. Video output devices
are assumed to have an analog or PCM audio input with 1-3
channels. The ``txsubchans`` flags select one or more channels
for modulation, together with some audio subprogram indicator,
for example, a stereo pilot tone.
- .. row 7
- __u32
- ``type``
- :cspan:`2` Type of the modulator, see :c:type:`v4l2_tuner_type`.
- .. row 8
- __u32
- ``reserved``\ [3]
- Reserved for future extensions.
Drivers and applications must set the array to zero.
@ -170,86 +130,56 @@ To change the radio frequency the
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_TUNER_SUB_MONO``
- .. row 1 - 0x0001
- Modulate channel 1 as mono audio, when the input has more
- ``V4L2_TUNER_SUB_MONO`` channels, a down-mix of channel 1 and 2. This flag does not
combine with ``V4L2_TUNER_SUB_STEREO`` or
- 0x0001 ``V4L2_TUNER_SUB_LANG1``.
* - ``V4L2_TUNER_SUB_STEREO``
- Modulate channel 1 as mono audio, when the input has more - 0x0002
channels, a down-mix of channel 1 and 2. This flag does not - Modulate channel 1 and 2 as left and right channel of a stereo
combine with ``V4L2_TUNER_SUB_STEREO`` or audio signal. When the input has only one channel or two channels
``V4L2_TUNER_SUB_LANG1``. and ``V4L2_TUNER_SUB_SAP`` is also set, channel 1 is encoded as
left and right channel. This flag does not combine with
- .. row 2 ``V4L2_TUNER_SUB_MONO`` or ``V4L2_TUNER_SUB_LANG1``. When the
driver does not support stereo audio it shall fall back to mono.
- ``V4L2_TUNER_SUB_STEREO`` * - ``V4L2_TUNER_SUB_LANG1``
- 0x0008
- 0x0002 - Modulate channel 1 and 2 as primary and secondary language of a
bilingual audio signal. When the input has only one channel it is
- Modulate channel 1 and 2 as left and right channel of a stereo used for both languages. It is not possible to encode the primary
audio signal. When the input has only one channel or two channels or secondary language only. This flag does not combine with
and ``V4L2_TUNER_SUB_SAP`` is also set, channel 1 is encoded as ``V4L2_TUNER_SUB_MONO``, ``V4L2_TUNER_SUB_STEREO`` or
left and right channel. This flag does not combine with ``V4L2_TUNER_SUB_SAP``. If the hardware does not support the
``V4L2_TUNER_SUB_MONO`` or ``V4L2_TUNER_SUB_LANG1``. When the respective audio matrix, or the current video standard does not
driver does not support stereo audio it shall fall back to mono. permit bilingual audio the :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall
return an ``EINVAL`` error code and the driver shall fall back to mono
- .. row 3 or stereo mode.
* - ``V4L2_TUNER_SUB_LANG2``
- ``V4L2_TUNER_SUB_LANG1`` - 0x0004
- Same effect as ``V4L2_TUNER_SUB_SAP``.
- 0x0008 * - ``V4L2_TUNER_SUB_SAP``
- 0x0004
- Modulate channel 1 and 2 as primary and secondary language of a - When combined with ``V4L2_TUNER_SUB_MONO`` the first channel is
bilingual audio signal. When the input has only one channel it is encoded as mono audio, the last channel as Second Audio Program.
used for both languages. It is not possible to encode the primary When the input has only one channel it is used for both audio
or secondary language only. This flag does not combine with tracks. When the input has three channels the mono track is a
``V4L2_TUNER_SUB_MONO``, ``V4L2_TUNER_SUB_STEREO`` or down-mix of channel 1 and 2. When combined with
``V4L2_TUNER_SUB_SAP``. If the hardware does not support the ``V4L2_TUNER_SUB_STEREO`` channel 1 and 2 are encoded as left and
respective audio matrix, or the current video standard does not right stereo audio, channel 3 as Second Audio Program. When the
permit bilingual audio the :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall input has only two channels, the first is encoded as left and
return an ``EINVAL`` error code and the driver shall fall back to mono right channel and the second as SAP. When the input has only one
or stereo mode. channel it is used for all audio tracks. It is not possible to
encode a Second Audio Program only. This flag must combine with
- .. row 4 ``V4L2_TUNER_SUB_MONO`` or ``V4L2_TUNER_SUB_STEREO``. If the
hardware does not support the respective audio matrix, or the
- ``V4L2_TUNER_SUB_LANG2`` current video standard does not permit SAP the
:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall return an ``EINVAL`` error code and
- 0x0004 driver shall fall back to mono or stereo mode.
* - ``V4L2_TUNER_SUB_RDS``
- Same effect as ``V4L2_TUNER_SUB_SAP``. - 0x0010
- Enable the RDS encoder for a radio FM transmitter.
- .. row 5
- ``V4L2_TUNER_SUB_SAP``
- 0x0004
- When combined with ``V4L2_TUNER_SUB_MONO`` the first channel is
encoded as mono audio, the last channel as Second Audio Program.
When the input has only one channel it is used for both audio
tracks. When the input has three channels the mono track is a
down-mix of channel 1 and 2. When combined with
``V4L2_TUNER_SUB_STEREO`` channel 1 and 2 are encoded as left and
right stereo audio, channel 3 as Second Audio Program. When the
input has only two channels, the first is encoded as left and
right channel and the second as SAP. When the input has only one
channel it is used for all audio tracks. It is not possible to
encode a Second Audio Program only. This flag must combine with
``V4L2_TUNER_SUB_MONO`` or ``V4L2_TUNER_SUB_STEREO``. If the
hardware does not support the respective audio matrix, or the
current video standard does not permit SAP the
:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall return an ``EINVAL`` error code and
driver shall fall back to mono or stereo mode.
- .. row 6
- ``V4L2_TUNER_SUB_RDS``
- 0x0010
- Enable the RDS encoder for a radio FM transmitter.
Return Value Return Value

362
Documentation/media/uapi/v4l/vidioc-g-parm.rst
View File

@ -60,55 +60,30 @@ union holding separate parameters for input and output devices.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 2 :widths: 1 1 1 2
* - __u32
- .. row 1 - ``type``
-
- __u32 - The buffer (stream) type, same as struct
:c:type:`v4l2_format` ``type``, set by the
- ``type`` application. See :c:type:`v4l2_buf_type`
* - union
- - ``parm``
- The buffer (stream) type, same as struct -
:c:type:`v4l2_format` ``type``, set by the -
application. See :c:type:`v4l2_buf_type` * -
- struct :c:type:`v4l2_captureparm`
- .. row 2 - ``capture``
- Parameters for capture devices, used when ``type`` is
- union ``V4L2_BUF_TYPE_VIDEO_CAPTURE``.
* -
- ``parm`` - struct :c:type:`v4l2_outputparm`
- ``output``
- - Parameters for output devices, used when ``type`` is
- ``V4L2_BUF_TYPE_VIDEO_OUTPUT``.
* -
- .. row 3 - __u8
- ``raw_data``\ [200]
- - A place holder for future extensions.
- struct :c:type:`v4l2_captureparm`
- ``capture``
- Parameters for capture devices, used when ``type`` is
``V4L2_BUF_TYPE_VIDEO_CAPTURE``.
- .. row 4
-
- struct :c:type:`v4l2_outputparm`
- ``output``
- Parameters for output devices, used when ``type`` is
``V4L2_BUF_TYPE_VIDEO_OUTPUT``.
- .. row 5
-
- __u8
- ``raw_data``\ [200]
- A place holder for future extensions.
@ -121,77 +96,47 @@ union holding separate parameters for input and output devices.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- ``capability``
- See :ref:`parm-caps`.
* - __u32
- ``capturemode``
- Set by drivers and applications, see :ref:`parm-flags`.
* - struct :c:type:`v4l2_fract`
- ``timeperframe``
- This is the desired period between successive frames captured by
the driver, in seconds. The field is intended to skip frames on
the driver side, saving I/O bandwidth.
- .. row 1 Applications store here the desired frame period, drivers return
the actual frame period, which must be greater or equal to the
nominal frame period determined by the current video standard
(struct :c:type:`v4l2_standard` ``frameperiod``
field). Changing the video standard (also implicitly by switching
the video input) may reset this parameter to the nominal frame
period. To reset manually applications can just set this field to
zero.
- __u32 Drivers support this function only when they set the
``V4L2_CAP_TIMEPERFRAME`` flag in the ``capability`` field.
- ``capability`` * - __u32
- ``extendedmode``
- See :ref:`parm-caps`. - Custom (driver specific) streaming parameters. When unused,
applications and drivers must set this field to zero. Applications
- .. row 2 using this field should check the driver name and version, see
:ref:`querycap`.
- __u32 * - __u32
- ``readbuffers``
- ``capturemode`` - Applications set this field to the desired number of buffers used
internally by the driver in :ref:`read() <func-read>` mode.
- Set by drivers and applications, see :ref:`parm-flags`. Drivers return the actual number of buffers. When an application
requests zero buffers, drivers should just return the current
- .. row 3 setting rather than the minimum or an error code. For details see
:ref:`rw`.
- struct :c:type:`v4l2_fract` * - __u32
- ``reserved``\ [4]
- ``timeperframe`` - Reserved for future extensions. Drivers and applications must set
the array to zero.
- This is the desired period between successive frames captured by
the driver, in seconds. The field is intended to skip frames on
the driver side, saving I/O bandwidth.
Applications store here the desired frame period, drivers return
the actual frame period, which must be greater or equal to the
nominal frame period determined by the current video standard
(struct :c:type:`v4l2_standard` ``frameperiod``
field). Changing the video standard (also implicitly by switching
the video input) may reset this parameter to the nominal frame
period. To reset manually applications can just set this field to
zero.
Drivers support this function only when they set the
``V4L2_CAP_TIMEPERFRAME`` flag in the ``capability`` field.
- .. row 4
- __u32
- ``extendedmode``
- Custom (driver specific) streaming parameters. When unused,
applications and drivers must set this field to zero. Applications
using this field should check the driver name and version, see
:ref:`querycap`.
- .. row 5
- __u32
- ``readbuffers``
- Applications set this field to the desired number of buffers used
internally by the driver in :ref:`read() <func-read>` mode.
Drivers return the actual number of buffers. When an application
requests zero buffers, drivers should just return the current
setting rather than the minimum or an error code. For details see
:ref:`rw`.
- .. row 6
- __u32
- ``reserved``\ [4]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
@ -204,84 +149,51 @@ union holding separate parameters for input and output devices.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- ``capability``
- See :ref:`parm-caps`.
* - __u32
- ``outputmode``
- Set by drivers and applications, see :ref:`parm-flags`.
* - struct :c:type:`v4l2_fract`
- ``timeperframe``
- This is the desired period between successive frames output by the
driver, in seconds.
* - :cspan:`2`
- .. row 1 The field is intended to repeat frames on the driver side in
:ref:`write() <func-write>` mode (in streaming mode timestamps
can be used to throttle the output), saving I/O bandwidth.
- __u32 Applications store here the desired frame period, drivers return
the actual frame period, which must be greater or equal to the
nominal frame period determined by the current video standard
(struct :c:type:`v4l2_standard` ``frameperiod``
field). Changing the video standard (also implicitly by switching
the video output) may reset this parameter to the nominal frame
period. To reset manually applications can just set this field to
zero.
- ``capability`` Drivers support this function only when they set the
``V4L2_CAP_TIMEPERFRAME`` flag in the ``capability`` field.
- See :ref:`parm-caps`. * - __u32
- ``extendedmode``
- .. row 2 - Custom (driver specific) streaming parameters. When unused,
applications and drivers must set this field to zero. Applications
- __u32 using this field should check the driver name and version, see
:ref:`querycap`.
- ``outputmode`` * - __u32
- ``writebuffers``
- Set by drivers and applications, see :ref:`parm-flags`. - Applications set this field to the desired number of buffers used
internally by the driver in :ref:`write() <func-write>` mode. Drivers
- .. row 3 return the actual number of buffers. When an application requests
zero buffers, drivers should just return the current setting
- struct :c:type:`v4l2_fract` rather than the minimum or an error code. For details see
:ref:`rw`.
- ``timeperframe`` * - __u32
- ``reserved``\ [4]
- This is the desired period between successive frames output by the - Reserved for future extensions. Drivers and applications must set
driver, in seconds. the array to zero.
- .. row 4
- :cspan:`2`
The field is intended to repeat frames on the driver side in
:ref:`write() <func-write>` mode (in streaming mode timestamps
can be used to throttle the output), saving I/O bandwidth.
Applications store here the desired frame period, drivers return
the actual frame period, which must be greater or equal to the
nominal frame period determined by the current video standard
(struct :c:type:`v4l2_standard` ``frameperiod``
field). Changing the video standard (also implicitly by switching
the video output) may reset this parameter to the nominal frame
period. To reset manually applications can just set this field to
zero.
Drivers support this function only when they set the
``V4L2_CAP_TIMEPERFRAME`` flag in the ``capability`` field.
- .. row 5
- __u32
- ``extendedmode``
- Custom (driver specific) streaming parameters. When unused,
applications and drivers must set this field to zero. Applications
using this field should check the driver name and version, see
:ref:`querycap`.
- .. row 6
- __u32
- ``writebuffers``
- Applications set this field to the desired number of buffers used
internally by the driver in :ref:`write() <func-write>` mode. Drivers
return the actual number of buffers. When an application requests
zero buffers, drivers should just return the current setting
rather than the minimum or an error code. For details see
:ref:`rw`.
- .. row 7
- __u32
- ``reserved``\ [4]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
@ -294,15 +206,10 @@ union holding separate parameters for input and output devices.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_CAP_TIMEPERFRAME``
- .. row 1 - 0x1000
- The frame skipping/repeating controlled by the ``timeperframe``
- ``V4L2_CAP_TIMEPERFRAME`` field is supported.
- 0x1000
- The frame skipping/repeating controlled by the ``timeperframe``
field is supported.
@ -315,41 +222,36 @@ union holding separate parameters for input and output devices.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_MODE_HIGHQUALITY``
- 0x0001
- High quality imaging mode. High quality mode is intended for still
imaging applications. The idea is to get the best possible image
quality that the hardware can deliver. It is not defined how the
driver writer may achieve that; it will depend on the hardware and
the ingenuity of the driver writer. High quality mode is a
different mode from the regular motion video capture modes. In
high quality mode:
- .. row 1 - The driver may be able to capture higher resolutions than for
motion capture.
- ``V4L2_MODE_HIGHQUALITY`` - The driver may support fewer pixel formats than motion capture
(eg; true color).
- 0x0001 - The driver may capture and arithmetically combine multiple
successive fields or frames to remove color edge artifacts and
reduce the noise in the video data.
- High quality imaging mode. High quality mode is intended for still - The driver may capture images in slices like a scanner in order
imaging applications. The idea is to get the best possible image to handle larger format images than would otherwise be
quality that the hardware can deliver. It is not defined how the possible.
driver writer may achieve that; it will depend on the hardware and
the ingenuity of the driver writer. High quality mode is a
different mode from the regular motion video capture modes. In
high quality mode:
- The driver may be able to capture higher resolutions than for - An image capture operation may be significantly slower than
motion capture. motion capture.
- The driver may support fewer pixel formats than motion capture - Moving objects in the image might have excessive motion blur.
(eg; true color).
- The driver may capture and arithmetically combine multiple - Capture might only work through the :ref:`read() <func-read>` call.
successive fields or frames to remove color edge artifacts and
reduce the noise in the video data.
- The driver may capture images in slices like a scanner in order
to handle larger format images than would otherwise be
possible.
- An image capture operation may be significantly slower than
motion capture.
- Moving objects in the image might have excessive motion blur.
- Capture might only work through the :ref:`read() <func-read>` call.
Return Value Return Value

73
Documentation/media/uapi/v4l/vidioc-g-priority.rst
View File

@ -53,55 +53,30 @@ with a pointer to this variable.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_PRIORITY_UNSET``
- .. row 1 - 0
-
- ``V4L2_PRIORITY_UNSET`` * - ``V4L2_PRIORITY_BACKGROUND``
- 1
- 0 - Lowest priority, usually applications running in background, for
example monitoring VBI transmissions. A proxy application running
- in user space will be necessary if multiple applications want to
read from a device at this priority.
- .. row 2 * - ``V4L2_PRIORITY_INTERACTIVE``
- 2
- ``V4L2_PRIORITY_BACKGROUND`` -
* - ``V4L2_PRIORITY_DEFAULT``
- 1 - 2
- Medium priority, usually applications started and interactively
- Lowest priority, usually applications running in background, for controlled by the user. For example TV viewers, Teletext browsers,
example monitoring VBI transmissions. A proxy application running or just "panel" applications to change the channel or video
in user space will be necessary if multiple applications want to controls. This is the default priority unless an application
read from a device at this priority. requests another.
* - ``V4L2_PRIORITY_RECORD``
- .. row 3 - 3
- Highest priority. Only one file descriptor can have this priority,
- ``V4L2_PRIORITY_INTERACTIVE`` it blocks any other fd from changing device properties. Usually
applications which must not be interrupted, like video recording.
- 2
-
- .. row 4
- ``V4L2_PRIORITY_DEFAULT``
- 2
- Medium priority, usually applications started and interactively
controlled by the user. For example TV viewers, Teletext browsers,
or just "panel" applications to change the channel or video
controls. This is the default priority unless an application
requests another.
- .. row 5
- ``V4L2_PRIORITY_RECORD``
- 3
- Highest priority. Only one file descriptor can have this priority,
it blocks any other fd from changing device properties. Usually
applications which must not be interrupted, like video recording.
Return Value Return Value

63
Documentation/media/uapi/v4l/vidioc-g-selection.rst
View File

@ -149,50 +149,25 @@ Selection targets and flags are documented in
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1 - ``type``
- Type of the buffer (from enum
- __u32 :c:type:`v4l2_buf_type`).
* - __u32
- ``type`` - ``target``
- Used to select between
- Type of the buffer (from enum :ref:`cropping and composing rectangles <v4l2-selections-common>`.
:c:type:`v4l2_buf_type`). * - __u32
- ``flags``
- .. row 2 - Flags controlling the selection rectangle adjustments, refer to
:ref:`selection flags <v4l2-selection-flags>`.
- __u32 * - struct :c:type:`v4l2_rect`
- ``r``
- ``target`` - The selection rectangle.
* - __u32
- Used to select between - ``reserved[9]``
:ref:`cropping and composing rectangles <v4l2-selections-common>`. - Reserved fields for future use. Drivers and applications must zero
this array.
- .. row 3
- __u32
- ``flags``
- Flags controlling the selection rectangle adjustments, refer to
:ref:`selection flags <v4l2-selection-flags>`.
- .. row 4
- struct :c:type:`v4l2_rect`
- ``r``
- The selection rectangle.
- .. row 5
- __u32
- ``reserved[9]``
- Reserved fields for future use. Drivers and applications must zero
this array.
Return Value Return Value

300
Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst
View File

@ -53,124 +53,67 @@ the sliced VBI API is unsupported or ``type`` is invalid.
:stub-columns: 0 :stub-columns: 0
:widths: 3 3 2 2 2 :widths: 3 3 2 2 2
* - __u16
- ``service_set``
- :cspan:`2` A set of all data services supported by the driver.
- .. row 1 Equal to the union of all elements of the ``service_lines`` array.
* - __u16
- ``service_lines``\ [2][24]
- :cspan:`2` Each element of this array contains a set of data
services the hardware can look for or insert into a particular
scan line. Data services are defined in :ref:`vbi-services`.
Array indices map to ITU-R line numbers\ [#f1]_ as follows:
* -
-
- Element
- 525 line systems
- 625 line systems
* -
-
- ``service_lines``\ [0][1]
- 1
- 1
* -
-
- ``service_lines``\ [0][23]
- 23
- 23
* -
-
- ``service_lines``\ [1][1]
- 264
- 314
* -
-
- ``service_lines``\ [1][23]
- 286
- 336
* -
* -
-
- :cspan:`2` The number of VBI lines the hardware can capture or
output per frame, or the number of services it can identify on a
given line may be limited. For example on PAL line 16 the hardware
may be able to look for a VPS or Teletext signal, but not both at
the same time. Applications can learn about these limits using the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl as described in
:ref:`sliced`.
* -
* -
-
- :cspan:`2` Drivers must set ``service_lines`` [0][0] and
``service_lines``\ [1][0] to zero.
* - __u32
- ``type``
- Type of the data stream, see :c:type:`v4l2_buf_type`. Should be
``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``.
* - __u32
- ``reserved``\ [3]
- :cspan:`2` This array is reserved for future extensions.
- __u16 Applications and drivers must set it to zero.
- ``service_set``
- :cspan:`2` A set of all data services supported by the driver.
Equal to the union of all elements of the ``service_lines`` array.
- .. row 2
- __u16
- ``service_lines``\ [2][24]
- :cspan:`2` Each element of this array contains a set of data
services the hardware can look for or insert into a particular
scan line. Data services are defined in :ref:`vbi-services`.
Array indices map to ITU-R line numbers\ [#f1]_ as follows:
- .. row 3
-
-
- Element
- 525 line systems
- 625 line systems
- .. row 4
-
-
- ``service_lines``\ [0][1]
- 1
- 1
- .. row 5
-
-
- ``service_lines``\ [0][23]
- 23
- 23
- .. row 6
-
-
- ``service_lines``\ [1][1]
- 264
- 314
- .. row 7
-
-
- ``service_lines``\ [1][23]
- 286
- 336
- .. row 8
-
- .. row 9
-
-
- :cspan:`2` The number of VBI lines the hardware can capture or
output per frame, or the number of services it can identify on a
given line may be limited. For example on PAL line 16 the hardware
may be able to look for a VPS or Teletext signal, but not both at
the same time. Applications can learn about these limits using the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl as described in
:ref:`sliced`.
- .. row 10
-
- .. row 11
-
-
- :cspan:`2` Drivers must set ``service_lines`` [0][0] and
``service_lines``\ [1][0] to zero.
- .. row 12
- __u32
- ``type``
- Type of the data stream, see :c:type:`v4l2_buf_type`. Should be
``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``.
- .. row 13
- __u32
- ``reserved``\ [3]
- :cspan:`2` This array is reserved for future extensions.
Applications and drivers must set it to zero.
.. [#f1] .. [#f1]
@ -190,95 +133,50 @@ the sliced VBI API is unsupported or ``type`` is invalid.
:stub-columns: 0 :stub-columns: 0
:widths: 2 1 1 2 2 :widths: 2 1 1 2 2
* - Symbol
- Value
- Reference
- Lines, usually
- Payload
* - ``V4L2_SLICED_TELETEXT_B`` (Teletext System B)
- 0x0001
- :ref:`ets300706`,
- .. row 1 :ref:`itu653`
- PAL/SECAM line 7-22, 320-335 (second field 7-22)
- Last 42 of the 45 byte Teletext packet, that is without clock
run-in and framing code, lsb first transmitted.
* - ``V4L2_SLICED_VPS``
- 0x0400
- :ref:`ets300231`
- PAL line 16
- Byte number 3 to 15 according to Figure 9 of ETS 300 231, lsb
first transmitted.
* - ``V4L2_SLICED_CAPTION_525``
- 0x1000
- :ref:`cea608`
- NTSC line 21, 284 (second field 21)
- Two bytes in transmission order, including parity bit, lsb first
transmitted.
* - ``V4L2_SLICED_WSS_625``
- 0x4000
- :ref:`en300294`,
- Symbol :ref:`itu1119`
- PAL/SECAM line 23
-
- Value ::
- Reference Byte 0 1
msb lsb msb lsb
- Lines, usually Bit 7 6 5 4 3 2 1 0 x x 13 12 11 10 9
* - ``V4L2_SLICED_VBI_525``
- Payload - 0x1000
- :cspan:`2` Set of services applicable to 525 line systems.
- .. row 2 * - ``V4L2_SLICED_VBI_625``
- 0x4401
- ``V4L2_SLICED_TELETEXT_B`` (Teletext System B) - :cspan:`2` Set of services applicable to 625 line systems.
- 0x0001
- :ref:`ets300706`,
:ref:`itu653`
- PAL/SECAM line 7-22, 320-335 (second field 7-22)
- Last 42 of the 45 byte Teletext packet, that is without clock
run-in and framing code, lsb first transmitted.
- .. row 3
- ``V4L2_SLICED_VPS``
- 0x0400
- :ref:`ets300231`
- PAL line 16
- Byte number 3 to 15 according to Figure 9 of ETS 300 231, lsb
first transmitted.
- .. row 4
- ``V4L2_SLICED_CAPTION_525``
- 0x1000
- :ref:`cea608`
- NTSC line 21, 284 (second field 21)
- Two bytes in transmission order, including parity bit, lsb first
transmitted.
- .. row 5
- ``V4L2_SLICED_WSS_625``
- 0x4000
- :ref:`en300294`,
:ref:`itu1119`
- PAL/SECAM line 23
-
::
Byte 0 1
msb lsb msb lsb
Bit 7 6 5 4 3 2 1 0 x x 13 12 11 10 9
- .. row 6
- ``V4L2_SLICED_VBI_525``
- 0x1000
- :cspan:`2` Set of services applicable to 525 line systems.
- .. row 7
- ``V4L2_SLICED_VBI_625``
- 0x4401
- :cspan:`2` Set of services applicable to 625 line systems.
.. raw:: latex .. raw:: latex

883
Documentation/media/uapi/v4l/vidioc-g-tuner.rst
View File

@ -69,195 +69,117 @@ To change the radio frequency the
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
* - __u32
- .. row 1 - ``index``
- :cspan:`1` Identifies the tuner, set by the application.
- __u32 * - __u8
- ``name``\ [32]
- ``index`` - :cspan:`1`
- :cspan:`1` Identifies the tuner, set by the application. Name of the tuner, a NUL-terminated ASCII string.
- .. row 2 This information is intended for the user.
* - __u32
- __u8 - ``type``
- :cspan:`1` Type of the tuner, see :c:type:`v4l2_tuner_type`.
- ``name``\ [32] * - __u32
- ``capability``
- :cspan:`1` - :cspan:`1`
Name of the tuner, a NUL-terminated ASCII string. Tuner capability flags, see :ref:`tuner-capability`. Audio flags
indicate the ability to decode audio subprograms. They will *not*
This information is intended for the user. change, for example with the current video standard.
- .. row 3 When the structure refers to a radio tuner the
``V4L2_TUNER_CAP_LANG1``, ``V4L2_TUNER_CAP_LANG2`` and
- __u32 ``V4L2_TUNER_CAP_NORM`` flags can't be used.
- ``type`` If multiple frequency bands are supported, then ``capability`` is
the union of all ``capability`` fields of each struct
- :cspan:`1` Type of the tuner, see :c:type:`v4l2_tuner_type`. :c:type:`v4l2_frequency_band`.
* - __u32
- .. row 4 - ``rangelow``
- :cspan:`1` The lowest tunable frequency in units of 62.5 kHz, or
- __u32 if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units
of 62.5 Hz, or if the ``capability`` flag ``V4L2_TUNER_CAP_1HZ``
- ``capability`` is set, in units of 1 Hz. If multiple frequency bands are
supported, then ``rangelow`` is the lowest frequency of all the
- :cspan:`1` frequency bands.
* - __u32
Tuner capability flags, see :ref:`tuner-capability`. Audio flags - ``rangehigh``
indicate the ability to decode audio subprograms. They will *not* - :cspan:`1` The highest tunable frequency in units of 62.5 kHz,
change, for example with the current video standard. or if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in
units of 62.5 Hz, or if the ``capability`` flag
When the structure refers to a radio tuner the ``V4L2_TUNER_CAP_1HZ`` is set, in units of 1 Hz. If multiple
``V4L2_TUNER_CAP_LANG1``, ``V4L2_TUNER_CAP_LANG2`` and frequency bands are supported, then ``rangehigh`` is the highest
``V4L2_TUNER_CAP_NORM`` flags can't be used. frequency of all the frequency bands.
* - __u32
If multiple frequency bands are supported, then ``capability`` is - ``rxsubchans``
the union of all ``capability`` fields of each struct - :cspan:`1`
:c:type:`v4l2_frequency_band`.
Some tuners or audio decoders can determine the received audio
- .. row 5 subprograms by analyzing audio carriers, pilot tones or other
indicators. To pass this information drivers set flags defined in
- __u32 :ref:`tuner-rxsubchans` in this field. For example:
* -
- ``rangelow`` -
- ``V4L2_TUNER_SUB_MONO``
- :cspan:`1` The lowest tunable frequency in units of 62.5 kHz, or - receiving mono audio
if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units * -
of 62.5 Hz, or if the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` -
is set, in units of 1 Hz. If multiple frequency bands are - ``STEREO | SAP``
supported, then ``rangelow`` is the lowest frequency of all the - receiving stereo audio and a secondary audio program
frequency bands. * -
-
- .. row 6 - ``MONO | STEREO``
- receiving mono or stereo audio, the hardware cannot distinguish
- __u32 * -
-
- ``rangehigh`` - ``LANG1 | LANG2``
- receiving bilingual audio
- :cspan:`1` The highest tunable frequency in units of 62.5 kHz, * -
or if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in -
units of 62.5 Hz, or if the ``capability`` flag - ``MONO | STEREO | LANG1 | LANG2``
``V4L2_TUNER_CAP_1HZ`` is set, in units of 1 Hz. If multiple - receiving mono, stereo or bilingual audio
frequency bands are supported, then ``rangehigh`` is the highest * -
frequency of all the frequency bands. -
- :cspan:`1`
- .. row 7
When the ``V4L2_TUNER_CAP_STEREO``, ``_LANG1``, ``_LANG2`` or
- __u32 ``_SAP`` flag is cleared in the ``capability`` field, the
corresponding ``V4L2_TUNER_SUB_`` flag must not be set here.
- ``rxsubchans``
This field is valid only if this is the tuner of the current video
- :cspan:`1` input, or when the structure refers to a radio tuner.
* - __u32
Some tuners or audio decoders can determine the received audio - ``audmode``
subprograms by analyzing audio carriers, pilot tones or other - :cspan:`1`
indicators. To pass this information drivers set flags defined in
:ref:`tuner-rxsubchans` in this field. For example: The selected audio mode, see :ref:`tuner-audmode` for valid
values. The audio mode does not affect audio subprogram detection,
- .. row 8 and like a :ref:`control` it does not automatically
change unless the requested mode is invalid or unsupported. See
- :ref:`tuner-matrix` for possible results when the selected and
- received audio programs do not match.
- ``V4L2_TUNER_SUB_MONO``
Currently this is the only field of struct
- receiving mono audio struct :c:type:`v4l2_tuner` applications can change.
* - __u32
- .. row 9 - ``signal``
- :cspan:`1` The signal strength if known.
-
- Ranging from 0 to 65535. Higher values indicate a better signal.
- ``STEREO | SAP`` * - __s32
- ``afc``
- receiving stereo audio and a secondary audio program - :cspan:`1` Automatic frequency control.
- .. row 10 When the ``afc`` value is negative, the frequency is too
low, when positive too high.
- * - __u32
- - ``reserved``\ [4]
- ``MONO | STEREO`` - :cspan:`1` Reserved for future extensions.
- receiving mono or stereo audio, the hardware cannot distinguish Drivers and applications must set the array to zero.
- .. row 11
-
-
- ``LANG1 | LANG2``
- receiving bilingual audio
- .. row 12
-
-
- ``MONO | STEREO | LANG1 | LANG2``
- receiving mono, stereo or bilingual audio
- .. row 13
-
-
- :cspan:`1`
When the ``V4L2_TUNER_CAP_STEREO``, ``_LANG1``, ``_LANG2`` or
``_SAP`` flag is cleared in the ``capability`` field, the
corresponding ``V4L2_TUNER_SUB_`` flag must not be set here.
This field is valid only if this is the tuner of the current video
input, or when the structure refers to a radio tuner.
- .. row 14
- __u32
- ``audmode``
- :cspan:`1`
The selected audio mode, see :ref:`tuner-audmode` for valid
values. The audio mode does not affect audio subprogram detection,
and like a :ref:`control` it does not automatically
change unless the requested mode is invalid or unsupported. See
:ref:`tuner-matrix` for possible results when the selected and
received audio programs do not match.
Currently this is the only field of struct
struct :c:type:`v4l2_tuner` applications can change.
- .. row 15
- __u32
- ``signal``
- :cspan:`1` The signal strength if known.
Ranging from 0 to 65535. Higher values indicate a better signal.
- .. row 16
- __s32
- ``afc``
- :cspan:`1` Automatic frequency control.
When the ``afc`` value is negative, the frequency is too
low, when positive too high.
- .. row 17
- __u32
- ``reserved``\ [4]
- :cspan:`1` Reserved for future extensions.
Drivers and applications must set the array to zero.
@ -270,39 +192,19 @@ To change the radio frequency the
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 6 :widths: 3 1 6
* - ``V4L2_TUNER_RADIO``
- .. row 1 - 1
- Tuner supports radio
- ``V4L2_TUNER_RADIO`` * - ``V4L2_TUNER_ANALOG_TV``
- 2
- 1 - Tuner supports analog TV
* - ``V4L2_TUNER_SDR``
- Tuner supports radio - 4
- Tuner controls the A/D and/or D/A block of a
- .. row 2 Sofware Digital Radio (SDR)
* - ``V4L2_TUNER_RF``
- ``V4L2_TUNER_ANALOG_TV`` - 5
- Tuner controls the RF part of a Sofware Digital Radio (SDR)
- 2
- Tuner supports analog TV
- .. row 3
- ``V4L2_TUNER_SDR``
- 4
- Tuner controls the A/D and/or D/A block of a
Sofware Digital Radio (SDR)
- .. row 4
- ``V4L2_TUNER_RF``
- 5
- Tuner controls the RF part of a Sofware Digital Radio (SDR)
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
@ -316,154 +218,84 @@ To change the radio frequency the
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_TUNER_CAP_LOW``
- 0x0001
- When set, tuning frequencies are expressed in units of 62.5 Hz
instead of 62.5 kHz.
* - ``V4L2_TUNER_CAP_NORM``
- 0x0002
- This is a multi-standard tuner; the video standard can or must be
switched. (B/G PAL tuners for example are typically not considered
multi-standard because the video standard is automatically
determined from the frequency band.) The set of supported video
standards is available from the struct
:c:type:`v4l2_input` pointing to this tuner, see the
description of ioctl :ref:`VIDIOC_ENUMINPUT`
for details. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this
capability.
* - ``V4L2_TUNER_CAP_HWSEEK_BOUNDED``
- 0x0004
- If set, then this tuner supports the hardware seek functionality
where the seek stops when it reaches the end of the frequency
range.
* - ``V4L2_TUNER_CAP_HWSEEK_WRAP``
- 0x0008
- If set, then this tuner supports the hardware seek functionality
where the seek wraps around when it reaches the end of the
frequency range.
* - ``V4L2_TUNER_CAP_STEREO``
- 0x0010
- Stereo audio reception is supported.
* - ``V4L2_TUNER_CAP_LANG1``
- 0x0040
- Reception of the primary language of a bilingual audio program is
supported. Bilingual audio is a feature of two-channel systems,
transmitting the primary language monaural on the main audio
carrier and a secondary language monaural on a second carrier.
Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this capability.
* - ``V4L2_TUNER_CAP_LANG2``
- 0x0020
- Reception of the secondary language of a bilingual audio program
is supported. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this
capability.
* - ``V4L2_TUNER_CAP_SAP``
- 0x0020
- Reception of a secondary audio program is supported. This is a
feature of the BTSC system which accompanies the NTSC video
standard. Two audio carriers are available for mono or stereo
transmissions of a primary language, and an independent third
carrier for a monaural secondary language. Only
``V4L2_TUNER_ANALOG_TV`` tuners can have this capability.
- .. row 1 .. note::
- ``V4L2_TUNER_CAP_LOW`` The ``V4L2_TUNER_CAP_LANG2`` and ``V4L2_TUNER_CAP_SAP``
flags are synonyms. ``V4L2_TUNER_CAP_SAP`` applies when the tuner
- 0x0001 supports the ``V4L2_STD_NTSC_M`` video standard.
* - ``V4L2_TUNER_CAP_RDS``
- When set, tuning frequencies are expressed in units of 62.5 Hz - 0x0080
instead of 62.5 kHz. - RDS capture is supported. This capability is only valid for radio
tuners.
- .. row 2 * - ``V4L2_TUNER_CAP_RDS_BLOCK_IO``
- 0x0100
- ``V4L2_TUNER_CAP_NORM`` - The RDS data is passed as unparsed RDS blocks.
* - ``V4L2_TUNER_CAP_RDS_CONTROLS``
- 0x0002 - 0x0200
- The RDS data is parsed by the hardware and set via controls.
- This is a multi-standard tuner; the video standard can or must be * - ``V4L2_TUNER_CAP_FREQ_BANDS``
switched. (B/G PAL tuners for example are typically not considered - 0x0400
multi-standard because the video standard is automatically - The :ref:`VIDIOC_ENUM_FREQ_BANDS`
determined from the frequency band.) The set of supported video ioctl can be used to enumerate the available frequency bands.
standards is available from the struct * - ``V4L2_TUNER_CAP_HWSEEK_PROG_LIM``
:c:type:`v4l2_input` pointing to this tuner, see the - 0x0800
description of ioctl :ref:`VIDIOC_ENUMINPUT` - The range to search when using the hardware seek functionality is
for details. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this programmable, see
capability. :ref:`VIDIOC_S_HW_FREQ_SEEK` for
details.
- .. row 3 * - ``V4L2_TUNER_CAP_1HZ``
- 0x1000
- ``V4L2_TUNER_CAP_HWSEEK_BOUNDED`` - When set, tuning frequencies are expressed in units of 1 Hz
instead of 62.5 kHz.
- 0x0004
- If set, then this tuner supports the hardware seek functionality
where the seek stops when it reaches the end of the frequency
range.
- .. row 4
- ``V4L2_TUNER_CAP_HWSEEK_WRAP``
- 0x0008
- If set, then this tuner supports the hardware seek functionality
where the seek wraps around when it reaches the end of the
frequency range.
- .. row 5
- ``V4L2_TUNER_CAP_STEREO``
- 0x0010
- Stereo audio reception is supported.
- .. row 6
- ``V4L2_TUNER_CAP_LANG1``
- 0x0040
- Reception of the primary language of a bilingual audio program is
supported. Bilingual audio is a feature of two-channel systems,
transmitting the primary language monaural on the main audio
carrier and a secondary language monaural on a second carrier.
Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this capability.
- .. row 7
- ``V4L2_TUNER_CAP_LANG2``
- 0x0020
- Reception of the secondary language of a bilingual audio program
is supported. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this
capability.
- .. row 8
- ``V4L2_TUNER_CAP_SAP``
- 0x0020
- Reception of a secondary audio program is supported. This is a
feature of the BTSC system which accompanies the NTSC video
standard. Two audio carriers are available for mono or stereo
transmissions of a primary language, and an independent third
carrier for a monaural secondary language. Only
``V4L2_TUNER_ANALOG_TV`` tuners can have this capability.
.. note::
The ``V4L2_TUNER_CAP_LANG2`` and ``V4L2_TUNER_CAP_SAP``
flags are synonyms. ``V4L2_TUNER_CAP_SAP`` applies when the tuner
supports the ``V4L2_STD_NTSC_M`` video standard.
- .. row 9
- ``V4L2_TUNER_CAP_RDS``
- 0x0080
- RDS capture is supported. This capability is only valid for radio
tuners.
- .. row 10
- ``V4L2_TUNER_CAP_RDS_BLOCK_IO``
- 0x0100
- The RDS data is passed as unparsed RDS blocks.
- .. row 11
- ``V4L2_TUNER_CAP_RDS_CONTROLS``
- 0x0200
- The RDS data is parsed by the hardware and set via controls.
- .. row 12
- ``V4L2_TUNER_CAP_FREQ_BANDS``
- 0x0400
- The :ref:`VIDIOC_ENUM_FREQ_BANDS`
ioctl can be used to enumerate the available frequency bands.
- .. row 13
- ``V4L2_TUNER_CAP_HWSEEK_PROG_LIM``
- 0x0800
- The range to search when using the hardware seek functionality is
programmable, see
:ref:`VIDIOC_S_HW_FREQ_SEEK` for
details.
- .. row 14
- ``V4L2_TUNER_CAP_1HZ``
- 0x1000
- When set, tuning frequencies are expressed in units of 1 Hz
instead of 62.5 kHz.
@ -476,63 +308,33 @@ To change the radio frequency the
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_TUNER_SUB_MONO``
- 0x0001
- The tuner receives a mono audio signal.
* - ``V4L2_TUNER_SUB_STEREO``
- 0x0002
- The tuner receives a stereo audio signal.
* - ``V4L2_TUNER_SUB_LANG1``
- 0x0008
- The tuner receives the primary language of a bilingual audio
signal. Drivers must clear this flag when the current video
standard is ``V4L2_STD_NTSC_M``.
* - ``V4L2_TUNER_SUB_LANG2``
- 0x0004
- The tuner receives the secondary language of a bilingual audio
signal (or a second audio program).
* - ``V4L2_TUNER_SUB_SAP``
- 0x0004
- The tuner receives a Second Audio Program.
- .. row 1 .. note::
- ``V4L2_TUNER_SUB_MONO`` The ``V4L2_TUNER_SUB_LANG2`` and ``V4L2_TUNER_SUB_SAP``
flags are synonyms. The ``V4L2_TUNER_SUB_SAP`` flag applies
- 0x0001 when the current video standard is ``V4L2_STD_NTSC_M``.
* - ``V4L2_TUNER_SUB_RDS``
- The tuner receives a mono audio signal. - 0x0010
- The tuner receives an RDS channel.
- .. row 2
- ``V4L2_TUNER_SUB_STEREO``
- 0x0002
- The tuner receives a stereo audio signal.
- .. row 3
- ``V4L2_TUNER_SUB_LANG1``
- 0x0008
- The tuner receives the primary language of a bilingual audio
signal. Drivers must clear this flag when the current video
standard is ``V4L2_STD_NTSC_M``.
- .. row 4
- ``V4L2_TUNER_SUB_LANG2``
- 0x0004
- The tuner receives the secondary language of a bilingual audio
signal (or a second audio program).
- .. row 5
- ``V4L2_TUNER_SUB_SAP``
- 0x0004
- The tuner receives a Second Audio Program.
.. note::
The ``V4L2_TUNER_SUB_LANG2`` and ``V4L2_TUNER_SUB_SAP``
flags are synonyms. The ``V4L2_TUNER_SUB_SAP`` flag applies
when the current video standard is ``V4L2_STD_NTSC_M``.
- .. row 6
- ``V4L2_TUNER_SUB_RDS``
- 0x0010
- The tuner receives an RDS channel.
@ -545,78 +347,48 @@ To change the radio frequency the
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 4
* - ``V4L2_TUNER_MODE_MONO``
- 0
- Play mono audio. When the tuner receives a stereo signal this a
down-mix of the left and right channel. When the tuner receives a
bilingual or SAP signal this mode selects the primary language.
* - ``V4L2_TUNER_MODE_STEREO``
- 1
- Play stereo audio. When the tuner receives bilingual audio it may
play different languages on the left and right channel or the
primary language is played on both channels.
- .. row 1 Playing different languages in this mode is deprecated. New
drivers should do this only in ``MODE_LANG1_LANG2``.
- ``V4L2_TUNER_MODE_MONO`` When the tuner receives no stereo signal or does not support
stereo reception the driver shall fall back to ``MODE_MONO``.
* - ``V4L2_TUNER_MODE_LANG1``
- 3
- Play the primary language, mono or stereo. Only
``V4L2_TUNER_ANALOG_TV`` tuners support this mode.
* - ``V4L2_TUNER_MODE_LANG2``
- 2
- Play the secondary language, mono. When the tuner receives no
bilingual audio or SAP, or their reception is not supported the
driver shall fall back to mono or stereo mode. Only
``V4L2_TUNER_ANALOG_TV`` tuners support this mode.
* - ``V4L2_TUNER_MODE_SAP``
- 2
- Play the Second Audio Program. When the tuner receives no
bilingual audio or SAP, or their reception is not supported the
driver shall fall back to mono or stereo mode. Only
``V4L2_TUNER_ANALOG_TV`` tuners support this mode.
- 0 .. note:: The ``V4L2_TUNER_MODE_LANG2`` and ``V4L2_TUNER_MODE_SAP``
are synonyms.
- Play mono audio. When the tuner receives a stereo signal this a * - ``V4L2_TUNER_MODE_LANG1_LANG2``
down-mix of the left and right channel. When the tuner receives a - 4
bilingual or SAP signal this mode selects the primary language. - Play the primary language on the left channel, the secondary
language on the right channel. When the tuner receives no
- .. row 2 bilingual audio or SAP, it shall fall back to ``MODE_LANG1`` or
``MODE_MONO``. Only ``V4L2_TUNER_ANALOG_TV`` tuners support this
- ``V4L2_TUNER_MODE_STEREO`` mode.
- 1
- Play stereo audio. When the tuner receives bilingual audio it may
play different languages on the left and right channel or the
primary language is played on both channels.
Playing different languages in this mode is deprecated. New
drivers should do this only in ``MODE_LANG1_LANG2``.
When the tuner receives no stereo signal or does not support
stereo reception the driver shall fall back to ``MODE_MONO``.
- .. row 3
- ``V4L2_TUNER_MODE_LANG1``
- 3
- Play the primary language, mono or stereo. Only
``V4L2_TUNER_ANALOG_TV`` tuners support this mode.
- .. row 4
- ``V4L2_TUNER_MODE_LANG2``
- 2
- Play the secondary language, mono. When the tuner receives no
bilingual audio or SAP, or their reception is not supported the
driver shall fall back to mono or stereo mode. Only
``V4L2_TUNER_ANALOG_TV`` tuners support this mode.
- .. row 5
- ``V4L2_TUNER_MODE_SAP``
- 2
- Play the Second Audio Program. When the tuner receives no
bilingual audio or SAP, or their reception is not supported the
driver shall fall back to mono or stereo mode. Only
``V4L2_TUNER_ANALOG_TV`` tuners support this mode.
.. note:: The ``V4L2_TUNER_MODE_LANG2`` and ``V4L2_TUNER_MODE_SAP``
are synonyms.
- .. row 6
- ``V4L2_TUNER_MODE_LANG1_LANG2``
- 4
- Play the primary language on the left channel, the secondary
language on the right channel. When the tuner receives no
bilingual audio or SAP, it shall fall back to ``MODE_LANG1`` or
``MODE_MONO``. Only ``V4L2_TUNER_ANALOG_TV`` tuners support this
mode.
.. raw:: latex .. raw:: latex
@ -628,95 +400,44 @@ To change the radio frequency the
:header-rows: 2 :header-rows: 2
:stub-columns: 0 :stub-columns: 0
* -
- .. row 1 - :cspan:`5` Selected ``V4L2_TUNER_MODE_``
* - Received ``V4L2_TUNER_SUB_``
- - ``MONO``
- :cspan:`5` Selected ``V4L2_TUNER_MODE_`` - ``STEREO``
- ``LANG1``
- .. row 2 - ``LANG2 = SAP``
- ``LANG1_LANG2``\ [#f1]_
- Received ``V4L2_TUNER_SUB_`` * - ``MONO``
- Mono
- ``MONO`` - Mono/Mono
- Mono
- ``STEREO`` - Mono
- Mono/Mono
- ``LANG1`` * - ``MONO | SAP``
- Mono
- ``LANG2 = SAP`` - Mono/Mono
- Mono
- ``LANG1_LANG2``\ [#f1]_ - SAP
- Mono/SAP (preferred) or Mono/Mono
- .. row 3 * - ``STEREO``
- L+R
- ``MONO`` - L/R
- Stereo L/R (preferred) or Mono L+R
- Mono - Stereo L/R (preferred) or Mono L+R
- L/R (preferred) or L+R/L+R
- Mono/Mono * - ``STEREO | SAP``
- L+R
- Mono - L/R
- Stereo L/R (preferred) or Mono L+R
- Mono - SAP
- L+R/SAP (preferred) or L/R or L+R/L+R
- Mono/Mono * - ``LANG1 | LANG2``
- Language 1
- .. row 4 - Lang1/Lang2 (deprecated [#f2]_) or Lang1/Lang1
- Language 1
- ``MONO | SAP`` - Language 2
- Lang1/Lang2 (preferred) or Lang1/Lang1
- Mono
- Mono/Mono
- Mono
- SAP
- Mono/SAP (preferred) or Mono/Mono
- .. row 5
- ``STEREO``
- L+R
- L/R
- Stereo L/R (preferred) or Mono L+R
- Stereo L/R (preferred) or Mono L+R
- L/R (preferred) or L+R/L+R
- .. row 6
- ``STEREO | SAP``
- L+R
- L/R
- Stereo L/R (preferred) or Mono L+R
- SAP
- L+R/SAP (preferred) or L/R or L+R/L+R
- .. row 7
- ``LANG1 | LANG2``
- Language 1
- Lang1/Lang2 (deprecated [#f2]_) or Lang1/Lang1
- Language 1
- Language 2
- Lang1/Lang2 (preferred) or Lang1/Lang1
.. raw:: latex .. raw:: latex

Some files were not shown because too many files have changed in this diff Show More