Commit 4a85d1cb authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

media: userspace-api/media: finalize stateless FWHT codec docs 



Document V4L2_CTRL_TYPE_FWHT_PARAMS and p_fwht_params. Also
improve the V4L2_PIX_FMT_FWHT_STATELESS description.

Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 63e799b9

Documentation/userspace-api/media/v4l/pixfmt-compressed.rst

+3 −1
Original line number Diff line number Diff line
@@ -217,4 +217,6 @@ Compressed Formats 
      - ``V4L2_PIX_FMT_FWHT_STATELESS``

      - 'SFWH'

      - Same format as V4L2_PIX_FMT_FWHT but requires stateless codec implementation.

	See the :ref:`associated Codec Control IDs <v4l2-mpeg-fwht>`.
 
        Metadata associated with the frame to decode is required to be passed

        through the ``V4L2_CID_STATELESS_FWHT_PARAMS`` control.

	See the :ref:`associated Codec Control ID <codec-stateless-fwht>`.

Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst

+4 −0
Original line number Diff line number Diff line
@@ -208,6 +208,10 @@ still cause this situation. 
      - ``p_h264_decode_params``

      - A pointer to a struct :c:type:`v4l2_ctrl_h264_decode_params`. Valid if this control is

        of type ``V4L2_CTRL_TYPE_H264_DECODE_PARAMS``.

    * - struct :c:type:`v4l2_ctrl_fwht_params` *

      - ``p_fwht_params``

      - A pointer to a struct :c:type:`v4l2_ctrl_fwht_params`. Valid if this control is

        of type ``V4L2_CTRL_TYPE_FWHT_PARAMS``.

    * - void *

      - ``ptr``

      - A pointer to a compound type which can be an N-dimensional array

Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst

+6 −0
Original line number Diff line number Diff line
@@ -462,6 +462,12 @@ See also the examples in :ref:`control`. 
      - n/a

      - A struct :c:type:`v4l2_ctrl_h264_decode_params`, containing H264

	decode parameters for stateless video decoders.

    * - ``V4L2_CTRL_TYPE_FWHT_PARAMS``

      - n/a

      - n/a

      - n/a

      - A struct :c:type:`v4l2_ctrl_fwht_params`, containing FWHT

	parameters for stateless video decoders.

    * - ``V4L2_CTRL_TYPE_HEVC_SPS``

      - n/a

      - n/a

Documentation/userspace-api/media/videodev2.h.rst.exceptions

+1 −0
Original line number Diff line number Diff line
@@ -146,6 +146,7 @@ replace symbol V4L2_CTRL_TYPE_HEVC_SPS :c:type:`v4l2_ctrl_type` 
replace symbol V4L2_CTRL_TYPE_HEVC_PPS :c:type:`v4l2_ctrl_type`

replace symbol V4L2_CTRL_TYPE_HEVC_SLICE_PARAMS :c:type:`v4l2_ctrl_type`

replace symbol V4L2_CTRL_TYPE_AREA :c:type:`v4l2_ctrl_type`

replace symbol V4L2_CTRL_TYPE_FWHT_PARAMS :c:type:`v4l2_ctrl_type`



# V4L2 capability defines

replace define V4L2_CAP_VIDEO_CAPTURE device-capabilities