[libcamera-devel] [PATCH] libcamera: stream: Document stride will be 0 for compressed formats

[Kieran Bingham]

Quoting Umang Jain via libcamera-devel (2023-08-22 14:19:34)
> For compressed formats, v4l2_pix_format.bytesperline value will be zero
> and is documented similarly in the kernel. Since we set the stride to
> v4l2_pix_format.bytesperline, document the case where it is expected
> to be zero (i.e. if the format is compressed).

Sounds reasonable to me.


Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

> 
> Signed-off-by: Umang Jain <umang.jain at ideasonboard.com>
> ---
>  src/libcamera/stream.cpp | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
> index 272222b7..f3e00ead 100644
> --- a/src/libcamera/stream.cpp
> +++ b/src/libcamera/stream.cpp
> @@ -311,7 +311,8 @@ StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
>   * The stride value reports the number of bytes between the beginning of
>   * successive lines in an image buffer for this stream. The value is
>   * valid after successfully validating the configuration with a call to
> - * CameraConfiguration::validate().
> + * CameraConfiguration::validate(). For compressed formats (such as MJPEG),
> + * this value will be zero.
>   */
>  
>  /**
> -- 
> 2.40.1
>