From: Stanimir Varbanov <stanimir.varbanov@linaro.org>
To: linux-media@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
Hans Verkuil <hverkuil@xs4all.nl>,
linux-arm-msm@vger.kernel.org, linux-kernel@vger.kernel.org,
Stanimir Varbanov <stanimir.varbanov@linaro.org>
Subject: [PATCH v2] media/doc: Allow sizeimage to be set by v4l clients
Date: Fri, 12 Apr 2019 18:59:15 +0300 [thread overview]
Message-ID: <20190412155915.16849-1-stanimir.varbanov@linaro.org> (raw)
This changes v4l2_pix_format and v4l2_plane_pix_format sizeimage
field description to allow v4l clients to set bigger image size
in case of variable length compressed data.
Signed-off-by: Stanimir Varbanov <stanimir.varbanov@linaro.org>
---
Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst | 13 ++++++++++++-
Documentation/media/uapi/v4l/pixfmt-v4l2.rst | 11 ++++++++++-
2 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst b/Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst
index 5688c816e334..005428a8121e 100644
--- a/Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst
+++ b/Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst
@@ -31,7 +31,18 @@ describing all planes of that format.
* - __u32
- ``sizeimage``
- - Maximum size in bytes required for image data in this plane.
+ - Maximum size in bytes required for image data in this plane,
+ set by the driver. When the image consists of variable length
+ compressed data this is the number of bytes required by the
+ codec to support the worst-case compression scenario.
+
+ For uncompressed images the driver will set the value. For
+ variable length compressed data clients are allowed to set
+ the sizeimage field, but the driver may ignore it and set the
+ value itself, or it may modify the provided value based on
+ alignment requirements or minimum/maximum size requirements.
+ If the client wants to leave this to the driver, then it should
+ set sizeimage to 0.
* - __u32
- ``bytesperline``
- Distance in bytes between the leftmost pixels in two adjacent
diff --git a/Documentation/media/uapi/v4l/pixfmt-v4l2.rst b/Documentation/media/uapi/v4l/pixfmt-v4l2.rst
index 71eebfc6d853..0f7771151db9 100644
--- a/Documentation/media/uapi/v4l/pixfmt-v4l2.rst
+++ b/Documentation/media/uapi/v4l/pixfmt-v4l2.rst
@@ -89,7 +89,16 @@ Single-planar format structure
- Size in bytes of the buffer to hold a complete image, set by the
driver. Usually this is ``bytesperline`` times ``height``. When
the image consists of variable length compressed data this is the
- maximum number of bytes required to hold an image.
+ number of bytes required by the codec to support the worst-case
+ compression scenario.
+
+ For uncompressed images the driver will set the value. For
+ variable length compressed data clients are allowed to set
+ the sizeimage field, but the driver may ignore it and set the
+ value itself, or it may modify the provided value based on
+ alignment requirements or minimum/maximum size requirements.
+ If the client wants to leave this to the driver, then it should
+ set sizeimage to 0.
* - __u32
- ``colorspace``
- Image colorspace, from enum :c:type:`v4l2_colorspace`.
--
2.17.1
next reply other threads:[~2019-04-12 15:59 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-12 15:59 Stanimir Varbanov [this message]
2019-05-02 12:55 ` [PATCH v2] media/doc: Allow sizeimage to be set by v4l clients Mauro Carvalho Chehab
2019-05-02 13:16 ` Hans Verkuil
2019-05-02 13:29 ` Mauro Carvalho Chehab
2019-05-07 16:54 ` Stanimir Varbanov
2019-05-14 8:54 ` Hans Verkuil
2019-05-14 12:19 ` Nicolas Dufresne
2019-05-14 12:23 ` Hans Verkuil
2019-05-16 8:09 ` Stanimir Varbanov
2019-05-16 9:56 ` Tomasz Figa
2019-05-16 10:40 ` Hans Verkuil
2019-05-16 15:09 ` Stanimir Varbanov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190412155915.16849-1-stanimir.varbanov@linaro.org \
--to=stanimir.varbanov@linaro.org \
--cc=hverkuil@xs4all.nl \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).