[libcamera-devel] [PATCH 00/11] Document all the IPU3 IPA classes

[Jean-Michel Hautbois]

Hi everyone !

We have modified most of the AWB and AGC algorithms now, we have better
structure names and handling, it is time to make all the documentation
follow the same path.

This patch series applies on top of "Move and improve AWB structures".

The first sequence (patch 1/11 to 5/11) concerns the IPAIPU3 class, and
documents it to detail how events are handled, how the algorithms are
used, etc.

Next, a bit more documentation is added in AWB to reference the
grey-world algorithm used, and the inputs/outputs of it.

The third sequence (from 7/11 to 9/11) follows the same path with AGC,
adding the missing definitions where they lack, etc.

And tonemapping was not documented either. While at it in patch 10/11 we
will first cache the gamma value to apply in order to avoid unneeded
calculations, and eventually add the documentation in the latest 11/11.

Jean-Michel Hautbois (11):
  ipa: ipu3: Document IPAIPU3 class interface
  ipa: ipu3: Improve the documentation of BDS grid
  ipa: ipu3: Document IPAIPU3::configure
  ipa: ipu3: Document the IPAIPU3 class
  ipa: ipu3: Explicitly use the statistics parameter
  ipa: ipu3: awb: Add AWB class documentation
  ipu3: ipa: agc: Determine cell size from ipu3_uapi_awb_set_item
  ipa: ipu3: agc: Remove unused variable count
  ipa: ipu3: agc: Document AGC mean-based algorithm
  ipa: ipu3: tonemapping: Generate the LUT only on gamma change
  ipa: ipu3: tonemapping: Add the documentation for ToneMapping

 src/ipa/ipu3/algorithms/agc.cpp          | 120 ++++++++++++++---
 src/ipa/ipu3/algorithms/agc.h            |   2 +-
 src/ipa/ipu3/algorithms/awb.cpp          |  33 +++++
 src/ipa/ipu3/algorithms/tone_mapping.cpp |  40 +++++-
 src/ipa/ipu3/ipa_context.h               |   1 +
 src/ipa/ipu3/ipu3.cpp                    | 162 ++++++++++++++++++++++-
 6 files changed, 330 insertions(+), 28 deletions(-)

-- 
2.30.2