Re: [PATCH v5 3/4] media: pixfmt: Document the HEVC slice pixel format

[Hans Verkuil]

On 5/24/19 11:36 AM, Paul Kocialkowski wrote:
> Document the current state of the HEVC slice pixel format.
> The format will need to evolve in the future, which is why it is
> not part of the public API.
> 
> Signed-off-by: Paul Kocialkowski <paul.kocialkowski@xxxxxxxxxxx>
> ---
>  .../media/uapi/v4l/pixfmt-compressed.rst      | 21 +++++++++++++++++++
>  1 file changed, 21 insertions(+)
> 
> diff --git a/Documentation/media/uapi/v4l/pixfmt-compressed.rst b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
> index 4b701fc7653e..9d4195723c3e 100644
> --- a/Documentation/media/uapi/v4l/pixfmt-compressed.rst
> +++ b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
> @@ -143,6 +143,27 @@ Compressed Formats
>        - ``V4L2_PIX_FMT_HEVC``
>        - 'HEVC'
>        - HEVC/H.265 video elementary stream.
> +    * .. _V4L2-PIX-FMT-HEVC-SLICE:
> +
> +      - ``V4L2_PIX_FMT_HEVC_SLICE``
> +      - 'S265'
> +      - HEVC parsed slice data, as extracted from the HEVC bitstream.
> +	This format is adapted for stateless video decoders that implement a
> +	HEVC pipeline (using the :ref:`codec` and :ref:`media-request-api`).

Should be :ref:`mem2mem`.

Regards,

	Hans

> +	Metadata associated with the frame to decode is required to be passed
> +	through the following controls :
> +        * ``V4L2_CID_MPEG_VIDEO_HEVC_SPS``
> +        * ``V4L2_CID_MPEG_VIDEO_HEVC_PPS``
> +        * ``V4L2_CID_MPEG_VIDEO_HEVC_SLICE_PARAMS``
> +	See the :ref:`associated Codec Control IDs <v4l2-mpeg-hevc>`.
> +	Buffers associated with this pixel format must contain the appropriate
> +	number of macroblocks to decode a full corresponding frame.
> +
> +	.. note::
> +
> +	   This format is not yet part of the public kernel API and it
> +	   is expected to change.
> +
>      * .. _V4L2-PIX-FMT-FWHT:
>  
>        - ``V4L2_PIX_FMT_FWHT``
>