Re: [PATCH v2 0/2] Document memory-to-memory video codec interfaces

From: Tomasz Figa
Date: Mon Oct 22 2018 - 20:54:55 EST


Hi Hans,

On Tue, Oct 23, 2018 at 12:41 AM Hans Verkuil <hverkuil@xxxxxxxxx> wrote:
>
> Hi Tomasz, Alexandre,
>
> Thank you for all your work! Much appreciated.
>
> I've applied both the stateful and stateless patches on top of the request_api branch
> and made the final result available here:
>
> https://hverkuil.home.xs4all.nl/request-api/
>
> Tomasz, I got two warnings when building the doc tree, the patch below fixes it.
>
> Regards,
>
> Hans
>
> Signed-off-by: Hans Verkuil <hans.verkuil@xxxxxxxxx>
>
> diff --git a/Documentation/media/uapi/v4l/dev-decoder.rst b/Documentation/media/uapi/v4l/dev-decoder.rst
> index 09c7a6621b8e..5522453ac39f 100644
> --- a/Documentation/media/uapi/v4l/dev-decoder.rst
> +++ b/Documentation/media/uapi/v4l/dev-decoder.rst
> @@ -972,11 +972,11 @@ sequence was started.
>
> .. warning::
>
> - The sentence can be only initiated if both ``OUTPUT`` and ``CAPTURE`` queues

This should also have been s/sentence/sequence/.

> - are streaming. For compatibility reasons, the call to
> - :c:func:`VIDIOC_DECODER_CMD` will not fail even if any of the queues is not
> - streaming, but at the same time it will not initiate the `Drain` sequence
> - and so the steps described below would not be applicable.
> + The sentence can be only initiated if both ``OUTPUT`` and ``CAPTURE`` queues
> + are streaming. For compatibility reasons, the call to
> + :c:func:`VIDIOC_DECODER_CMD` will not fail even if any of the queues is not
> + streaming, but at the same time it will not initiate the `Drain` sequence
> + and so the steps described below would not be applicable.
>
> 2. Any ``OUTPUT`` buffers queued by the client before the
> :c:func:`VIDIOC_DECODER_CMD` was issued will be processed and decoded as
> diff --git a/Documentation/media/uapi/v4l/dev-encoder.rst b/Documentation/media/uapi/v4l/dev-encoder.rst
> index 41139e5e48eb..7f49a7149067 100644
> --- a/Documentation/media/uapi/v4l/dev-encoder.rst
> +++ b/Documentation/media/uapi/v4l/dev-encoder.rst
> @@ -448,11 +448,11 @@ sequence was started.
>
> .. warning::
>
> - The sentence can be only initiated if both ``OUTPUT`` and ``CAPTURE`` queues

Ditto.

> - are streaming. For compatibility reasons, the call to
> - :c:func:`VIDIOC_ENCODER_CMD` will not fail even if any of the queues is not
> - streaming, but at the same time it will not initiate the `Drain` sequence
> - and so the steps described below would not be applicable.
> + The sentence can be only initiated if both ``OUTPUT`` and ``CAPTURE`` queues
> + are streaming. For compatibility reasons, the call to
> + :c:func:`VIDIOC_ENCODER_CMD` will not fail even if any of the queues is not
> + streaming, but at the same time it will not initiate the `Drain` sequence
> + and so the steps described below would not be applicable.

Last minute changes after proof reading...

Thanks for fixing up and uploading the html version!

Best regards,
Tomasz