1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2021, Ideas On Board
*
* algorithm.cpp - IPA control algorithm interface
*/
#include "algorithm.h"
/**
* \file algorithm.h
* \brief Algorithm common interface
*/
namespace libcamera {
namespace ipa {
/**
* \class Algorithm
* \brief The base class for all IPA algorithms
* \tparam Module The IPA module type for this class of algorithms
*
* The Algorithm class defines a standard interface for IPA algorithms
* compatible with the \a Module. By abstracting algorithms, it makes possible
* the implementation of generic code to manage algorithms regardless of their
* specific type.
*
* To specialize the Algorithm class template, an IPA module shall specialize
* the Module class template with module-specific context and configuration
* types, and pass the specialized Module class as the \a Module template
* argument.
*/
/**
* \fn Algorithm::configure()
* \brief Configure the Algorithm given an IPAConfigInfo
* \param[in] context The shared IPA context
* \param[in] configInfo The IPA configuration data, received from the pipeline
* handler
*
* Algorithms may implement a configure operation to pre-calculate
* parameters prior to commencing streaming.
*
* Configuration state may be stored in the IPASessionConfiguration structure of
* the IPAContext.
*
* \return 0 if successful, an error code otherwise
*/
/**
* \fn Algorithm::prepare()
* \brief Fill the \a params buffer with ISP processing parameters for a frame
* \param[in] context The shared IPA context
* \param[out] params The ISP specific parameters.
*
* This function is called for every frame when the camera is running before it
* is processed by the ISP to prepare the ISP processing parameters for that
* frame.
*
* Algorithms shall fill in the parameter structure fields appropriately to
* configure the ISP processing blocks that they are responsible for. This
* includes setting fields and flags that enable those processing blocks.
*/
/**
* \fn Algorithm::process()
* \brief Process ISP statistics, and run algorithm operations
* \param[in] context The shared IPA context
* \param[in] frameContext The current frame's context
* \param[in] stats The IPA statistics and ISP results
*
* This function is called while camera is running for every frame processed by
* the ISP, to process statistics generated from that frame by the ISP.
* Algorithms shall use this data to run calculations and update their state
* accordingly.
*
* Processing shall not take an undue amount of time, and any extended or
* computationally expensive calculations or operations must be handled
* asynchronously in a separate thread.
*
* Algorithms can store state in their respective IPAFrameContext structures,
* and reference state from the IPAFrameContext of other algorithms.
*
* \todo Historical data may be required as part of the processing.
* Either the previous frame, or the IPAFrameContext state of the frame
* that generated the statistics for this operation may be required for
* some advanced algorithms to prevent oscillations or support control
* loops correctly. Only a single IPAFrameContext is available currently,
* and so any data stored may represent the results of the previously
* completed operations.
*
* Care shall be taken to ensure the ordering of access to the information
* such that the algorithms use up to date state as required.
*/
} /* namespace ipa */
} /* namespace libcamera */
|
