Linux-Media Archive on lore.kernel.org
 help / color / Atom feed
From: Hans Verkuil <hverkuil@xs4all.nl>
To: Mauro Carvalho Chehab <mchehab@kernel.org>,
	Stanimir Varbanov <stanimir.varbanov@linaro.org>
Cc: linux-media@vger.kernel.org, linux-arm-msm@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] media/doc: Allow sizeimage to be set by v4l clients
Date: Thu, 2 May 2019 15:16:54 +0200
Message-ID: <ee78effa-f678-5d15-3802-bb787e7057e2@xs4all.nl> (raw)
In-Reply-To: <20190502095550.31282c0d@coco.lan>

On 5/2/19 2:55 PM, Mauro Carvalho Chehab wrote:
> Em Fri, 12 Apr 2019 18:59:15 +0300
> Stanimir Varbanov <stanimir.varbanov@linaro.org> escreveu:
> 
>> 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.
> 
> It is very confusing to understand what you meant by the above paragraph,
> as you inverted the sentence order and forgot a comma.
> 
> I would, instead, write the phrases using the direct order, and break
> into two paragraphs, e. g., changing the above to:
> 
> 	"The driver will set the value for uncompressed images.
> 
> 	Clients are allowed to set the sizeimage field for variable length
> 	compressed data, 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."
> 
> That makes it a lot easier to read, hopefully preventing mistakes from
> app and driver developers when reading about sizeimage.
> 
> Yet, I'm not too comfortable on letting this too generic. I mean,
> how an app writer would know what formats are "variable length
> compressed data", specially since libv4l may actually change that.

It's actually quite clearly defined: compressed formats set the
V4L2_FMT_FLAG_COMPRESSED flag in VIDIOC_ENUMFMT.

Also bytesperline will be 0 for compressed formats.

Regards,

	Hans

> 
> Thanks,
> Mauro
> 


  reply index

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-12 15:59 Stanimir Varbanov
2019-05-02 12:55 ` Mauro Carvalho Chehab
2019-05-02 13:16   ` Hans Verkuil [this message]
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 publically 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=ee78effa-f678-5d15-3802-bb787e7057e2@xs4all.nl \
    --to=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 \
    --cc=stanimir.varbanov@linaro.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

Linux-Media Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-media/0 linux-media/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-media linux-media/ https://lore.kernel.org/linux-media \
		linux-media@vger.kernel.org linux-media@archiver.kernel.org
	public-inbox-index linux-media


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-media


AGPL code for this site: git clone https://public-inbox.org/ public-inbox