Documentation: media: improve V4L2_CID_MIN_BUFFERS_FOR_*, doc
authorHans Verkuil <hverkuil@xs4all.nl>
Thu, 31 Oct 2024 07:50:04 +0000 (08:50 +0100)
committerHans Verkuil <hverkuil@xs4all.nl>
Fri, 8 Nov 2024 12:38:06 +0000 (13:38 +0100)
Clearly state that the V4L2_CID_MIN_BUFFERS_FOR_OUTPUT and
V4L2_CID_MIN_BUFFERS_FOR_CAPTURE controls are required for
stateful codecs.

Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Documentation/userspace-api/media/v4l/control.rst

index 57893814a1e5d9382eeff7ae203ab6159a772c15..9253cc946f02af55eaaa53bc265ed8b75ba627ee 100644 (file)
@@ -290,13 +290,15 @@ Control IDs
     This is a read-only control that can be read by the application and
     used as a hint to determine the number of CAPTURE buffers to pass to
     REQBUFS. The value is the minimum number of CAPTURE buffers that is
-    necessary for hardware to work.
+    necessary for hardware to work. This control is required for stateful
+    decoders.
 
 ``V4L2_CID_MIN_BUFFERS_FOR_OUTPUT`` ``(integer)``
     This is a read-only control that can be read by the application and
     used as a hint to determine the number of OUTPUT buffers to pass to
     REQBUFS. The value is the minimum number of OUTPUT buffers that is
-    necessary for hardware to work.
+    necessary for hardware to work. This control is required for stateful
+    encoders.
 
 .. _v4l2-alpha-component: