[libcamera-devel,v3,00/19] Document IPU3 IPA
mbox series

Message ID 20211022151218.111966-1-jeanmichel.hautbois@ideasonboard.com
Headers show
Series
  • Document IPU3 IPA
Related show

Message

Jean-Michel Hautbois Oct. 22, 2021, 3:11 p.m. UTC 
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.

It includes patches from both Kieran and me.

This series merges multiple patches/series already sent to ease the
follow-up.

We have four parts:
- Add documentation for the IPA IPU3 class
- Improve IPU3 algorithms documentation
  -> those two parts were mostly in "[PATCH 00/11] Document all the IPU3 IPA
     classes"
- Make it compile with Doxygen (this is new)
- Add a design document for IPU3 IPA
  -> this has been sent before as "[RFC PATCH] Documentation: IPU3 IPA Design
     guide"

As there was a mismatch, the branch used in v2 did not include Laurent's
comments (sorry :-/) so those should now be taken into account.

Enjoy :-) !

Jean-Michel Hautbois (14):
  ipa: ipu3: Document IPAIPU3 class interface
  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
  ipa: ipu3: awb: Reword accumulator documentation
  ipa: ipu3: agc: Document AGC mean-based algorithm
  ipa: ipu3: tonemapping: Generate the LUT only on gamma change
  ipa: ipu3: tonemapping: Implement configure call
  ipa: ipu3: tonemapping: Add the documentation for ToneMapping
  ipa: ipu3: Isolate ipa_context documentation
  ipa: ipu3: ipa_context: Fix doxygen references
  ipa: ipu3: Fix badly documented context variables
  ipa: ipu3: Implement an empty stop() function

Kieran Bingham (5):
  Documentation: IPU3 IPA Design guide
  ipa: ipu3: ipa_context: Fix file reference.
  ipa: ipu3: Fix the IPU3 AWB doxygen references
  ipa: ipu3: algorithms: awb: Privatize internal structures
  Documentation: Include IPU3 in Doxygen build

 Documentation/Doxyfile.in                |   1 +
 Documentation/meson.build                |   1 +
 src/ipa/ipu3/algorithms/agc.cpp          |  79 +++++-
 src/ipa/ipu3/algorithms/agc.h            |   6 +-
 src/ipa/ipu3/algorithms/awb.cpp          | 116 +++++----
 src/ipa/ipu3/algorithms/awb.h            |   1 +
 src/ipa/ipu3/algorithms/tone_mapping.cpp |  51 +++-
 src/ipa/ipu3/algorithms/tone_mapping.h   |   1 +
 src/ipa/ipu3/ipa_context.cpp             | 136 +++++++++++
 src/ipa/ipu3/ipa_context.h               |   3 +-
 src/ipa/ipu3/ipu3-ipa-design-guide.rst   | 155 ++++++++++++
 src/ipa/ipu3/ipu3.cpp                    | 294 +++++++++++++----------
 src/ipa/ipu3/meson.build                 |   1 +
 13 files changed, 655 insertions(+), 190 deletions(-)
 create mode 100644 src/ipa/ipu3/ipa_context.cpp
 create mode 100644 src/ipa/ipu3/ipu3-ipa-design-guide.rst