Skip to content

Commit

Permalink
media: v4l: Documentation: Raw Bayer formats are not RGB formats
Browse files Browse the repository at this point in the history
The raw Bayer formats have been listed under the label of RGB formats but
in fact they're quite different. The latter are readily usable as such
whereas the former require quite bit of image processing before useful.

Split them into RGB and raw Bayer formats.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Acked-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  • Loading branch information
Sakari Ailus authored and mchehab committed Aug 15, 2019
1 parent 50435d8 commit 24a90c9
Show file tree
Hide file tree
Showing 7 changed files with 1,330 additions and 1,323 deletions.
2 changes: 1 addition & 1 deletion Documentation/media/uapi/v4l/control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Control IDs
Sets the alpha color component. When a capture device (or capture
queue of a mem-to-mem device) produces a frame format that includes
an alpha component (e.g.
:ref:`packed RGB image formats <rgb-formats>`) and the alpha value
:ref:`packed RGB image formats <pixfmt-rgb>`) and the alpha value
is not defined by the device or the mem-to-mem input data this
control lets you select the alpha component value of all pixels.
When an output device (or output queue of a mem-to-mem device)
Expand Down
2 changes: 1 addition & 1 deletion Documentation/media/uapi/v4l/hist-v4l2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -900,7 +900,7 @@ V4L2 in Linux 2.6.19
:ref:`VIDIOC_ENUM_FRAMEINTERVALS`
were added.

3. A new pixel format ``V4L2_PIX_FMT_RGB444`` (:ref:`rgb-formats`) was
3. A new pixel format ``V4L2_PIX_FMT_RGB444`` (:ref:`pixfmt-rgb`) was
added.


Expand Down
38 changes: 38 additions & 0 deletions Documentation/media/uapi/v4l/pixfmt-bayer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.. Permission is granted to copy, distribute and/or modify this
.. document under the terms of the GNU Free Documentation License,
.. Version 1.1 or any later version published by the Free Software
.. Foundation, with no Invariant Sections, no Front-Cover Texts
.. and no Back-Cover Texts. A copy of the license is included at
.. Documentation/media/uapi/fdl-appendix.rst.
..
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
.. _pixfmt-bayer:

*****************
Raw Bayer Formats
*****************

Description
===========

The raw Bayer formats are used by image sensors before much if any processing is
performed on the image. The formats contain green, red and blue components, with
alternating lines of red and green, and blue and green pixels in different
orders. See also `the Wikipedia article on Bayer filter
<https://en.wikipedia.org/wiki/Bayer_filter>`__.


.. toctree::
:maxdepth: 1

pixfmt-srggb8
pixfmt-srggb10
pixfmt-srggb10p
pixfmt-srggb10alaw8
pixfmt-srggb10dpcm8
pixfmt-srggb10-ipu3
pixfmt-srggb12
pixfmt-srggb12p
pixfmt-srggb14p
pixfmt-srggb16
Loading

0 comments on commit 24a90c9

Please sign in to comment.