Commit 9bef7546 authored by Ricardo Ribalda's avatar Ricardo Ribalda Committed by Mauro Carvalho Chehab
Browse files

[media] Documentation: Add HSV format 



Describe the HSV formats

Signed-off-by: default avatarRicardo Ribalda Delgado <ricardo.ribalda@gmail.com>
Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 66b2ab27

Documentation/media/uapi/v4l/hsv-formats.rst

0 → 100644
+19 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _hsv-formats:



***********

HSV Formats

***********



These formats store the color information of the image

in a geometrical representation. The colors are mapped into a

cylinder, where the angle is the HUE, the height is the VALUE

and the distance to the center is the SATURATION. This is a very

useful format for image segmentation algorithms.





.. toctree::

    :maxdepth: 1



    pixfmt-packed-hsv

Documentation/media/uapi/v4l/pixfmt-packed-hsv.rst

0 → 100644
+156 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _packed-hsv:



******************

Packed HSV formats

******************



Description

===========



The *hue* (h) is measured in degrees, one LSB represents two degrees.

The *saturation* (s) and the *value* (v) are measured in percentage of the

cylinder: 0 being the smallest value and 255 the maximum.





The values are packed in 24 or 32 bit formats.



.. raw:: latex



    \newline\begin{adjustbox}{width=\columnwidth}



.. tabularcolumns:: |p{4.2cm}|p{1.0cm}|p{0.7cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.2cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.2cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.2cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{0.4cm}|p{1.7cm}|



.. _packed-hsv-formats:



.. flat-table:: Packed HSV Image Formats

    :header-rows:  2

    :stub-columns: 0



    * - Identifier

      - Code

      -

      - :cspan:`7` Byte 0 in memory

      -

      - :cspan:`7` Byte 1

      -

      - :cspan:`7` Byte 2

      -

      - :cspan:`7` Byte 3

    * -

      -

      - Bit

      - 7

      - 6

      - 5

      - 4

      - 3

      - 2

      - 1

      - 0

      -

      - 7

      - 6

      - 5

      - 4

      - 3

      - 2

      - 1

      - 0

      -

      - 7

      - 6

      - 5

      - 4

      - 3

      - 2

      - 1

      - 0

      -

      - 7

      - 6

      - 5

      - 4

      - 3

      - 2

      - 1

      - 0

    * .. _V4L2-PIX-FMT-HSV32:



      - ``V4L2_PIX_FMT_HSV32``

      - 'HSV4'

      -

      -

      -

      -

      -

      -

      -

      -

      -

      -

      - h\ :sub:`7`

      - h\ :sub:`6`

      - h\ :sub:`5`

      - h\ :sub:`4`

      - h\ :sub:`3`

      - h\ :sub:`2`

      - h\ :sub:`1`

      - h\ :sub:`0`

      -

      - s\ :sub:`7`

      - s\ :sub:`6`

      - s\ :sub:`5`

      - s\ :sub:`4`

      - s\ :sub:`3`

      - s\ :sub:`2`

      - s\ :sub:`1`

      - s\ :sub:`0`

      -

      - v\ :sub:`7`

      - v\ :sub:`6`

      - v\ :sub:`5`

      - v\ :sub:`4`

      - v\ :sub:`3`

      - v\ :sub:`2`

      - v\ :sub:`1`

      - v\ :sub:`0`

    * .. _V4L2-PIX-FMT-HSV24:



      - ``V4L2_PIX_FMT_HSV24``

      - 'HSV3'

      -

      - h\ :sub:`7`

      - h\ :sub:`6`

      - h\ :sub:`5`

      - h\ :sub:`4`

      - h\ :sub:`3`

      - h\ :sub:`2`

      - h\ :sub:`1`

      - h\ :sub:`0`

      -

      - s\ :sub:`7`

      - s\ :sub:`6`

      - s\ :sub:`5`

      - s\ :sub:`4`

      - s\ :sub:`3`

      - s\ :sub:`2`

      - s\ :sub:`1`

      - s\ :sub:`0`

      -

      - v\ :sub:`7`

      - v\ :sub:`6`

      - v\ :sub:`5`

      - v\ :sub:`4`

      - v\ :sub:`3`

      - v\ :sub:`2`

      - v\ :sub:`1`

      - v\ :sub:`0`

      -

      -

.. raw:: latex



    \end{adjustbox}\newline\newline



Bit 7 is the most significant bit.

Documentation/media/uapi/v4l/pixfmt.rst

+1 −0
Original line number Diff line number Diff line
@@ -29,6 +29,7 @@ see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.) 
    pixfmt-indexed

    pixfmt-rgb

    yuv-formats

    hsv-formats

    depth-formats

    pixfmt-013

    sdr-formats

Documentation/media/uapi/v4l/v4l2.rst

+5 −0
Original line number Diff line number Diff line
@@ -89,6 +89,11 @@ part can be used and distributed without restrictions. 
Revision History

****************



:revision: 4.10 / 2016-07-15 (*rr*)



Introduce HSV formats.





:revision: 4.5 / 2015-10-29 (*rr*)



Extend VIDIOC_G_EXT_CTRLS;. Replace ctrl_class with a new union with