[libcamera-devel] [PATCH] libcamera: controls: Drop reference to IPA in controls documentation

[Naushir Patuck]

Hi Laurent,

On Fri, 2 Jun 2023 at 06:43, Laurent Pinchart
<laurent.pinchart at ideasonboard.com> wrote:
>
> The controls relates to the public API, which doesn't expose IPA modules
> as they are internal to libcamera. Replace the mention of "IPA" in the
> controls documentation.
>
> While at it, fix a small text reflow issue.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

Seems reasonable to me:
Reviewed-by: Naushir Patuck <naush at raspberrypi.com>

> ---
> David, there's another mention of "IPA" in the FocusFoM control
> documentation. I'm not sure how to best address that one, as it isn't
> totally clear to me what you wanted to convey to the user. Could you
> please give it a look ?

I presume this is regarding the following text in the doc:

"
This control depends on the IPA to gather ISP statistics from the defined focus
region, and combine them in a suitable way to generate a FocusFoM value.
"

Essentially it's trying to say that we take the stats from all focus regions
and combine them in an appropriate way to return a single number to indicate
focus quality.  Perhaps replace the sentence with something like the following:

"
This singular value may be based on a combination of statistics gathered from
multiple focus regions within an image. The number of focus regions and method
of combination is platform dependent.
"

Naush

> ---
>  src/libcamera/control_ids.yaml | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/src/libcamera/control_ids.yaml b/src/libcamera/control_ids.yaml
> index f6dbfd6c0bf0..5aa656cb5032 100644
> --- a/src/libcamera/control_ids.yaml
> +++ b/src/libcamera/control_ids.yaml
> @@ -333,8 +333,8 @@ controls:
>    - FrameDurationLimits:
>        type: int64_t
>        description: |
> -        The minimum and maximum (in that order) frame duration,
> -        expressed in microseconds.
> +        The minimum and maximum (in that order) frame duration, expressed in
> +        microseconds.
>
>          When provided by applications, the control specifies the sensor frame
>          duration interval the pipeline has to use. This limits the largest
> @@ -343,7 +343,7 @@ controls:
>          the sensor will not be able to raise the exposure time above 33ms.
>          A fixed frame duration is achieved by setting the minimum and maximum
>          values to be the same. Setting both values to 0 reverts to using the
> -        IPA provided defaults.
> +        camera defaults.
>
>          The maximum frame duration provides the absolute limit to the shutter
>          speed computed by the AE algorithm and it overrides any exposure mode
> --
> Regards,
>
> Laurent Pinchart
>