diff options
author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2020-04-27 02:36:18 +0300 |
---|---|---|
committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2020-04-28 01:54:49 +0300 |
commit | a6de9030893753e5428ee912fe7c52fbf93febd1 (patch) | |
tree | e82996e2e87c464919808663c443a3dcb99ea887 /src/libcamera/ipa_interface.cpp | |
parent | 26a4b03ed85e0cc39939028964ae4a8961c05d02 (diff) |
ipa: Pass IPA initialization settings to IPAInterface::init()
Add a new IPASettings class to pass IPA initialization settings through
the IPAInterface::init() method. The settings currently only contain the
name of a configuration file, and are expected to be extended later.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Diffstat (limited to 'src/libcamera/ipa_interface.cpp')
-rw-r--r-- | src/libcamera/ipa_interface.cpp | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/libcamera/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp index 890d4340..616f20fb 100644 --- a/src/libcamera/ipa_interface.cpp +++ b/src/libcamera/ipa_interface.cpp @@ -93,6 +93,16 @@ */ /** + * \struct ipa_settings + * \brief IPA initialization settings for the IPA context operations + * \sa IPASettings + * + * \var ipa_settings::configuration_file + * \brief The name of the IPA configuration file (may be null or point to an + * empty string) + */ + +/** * \struct ipa_stream * \brief Stream information for the IPA context operations * @@ -231,6 +241,7 @@ * \var ipa_context_ops::init * \brief Initialise the IPA context * \param[in] ctx The IPA context + * \param[in] settings The IPA initialization settings * * \sa libcamera::IPAInterface::init() */ @@ -311,6 +322,24 @@ namespace libcamera { /** + * \struct IPASettings + * \brief IPA interface initialization settings + * + * The IPASettings structure stores data passed to the IPAInterface::init() + * function. The data contains settings that don't depend on a particular camera + * or pipeline configuration and are valid for the whole life time of the IPA + * interface. + */ + +/** + * \var IPASettings::configurationFile + * \brief The name of the IPA configuration file + * + * This field may be an empty string if the IPA doesn't require a configuration + * file. + */ + +/** * \struct IPAStream * \brief Stream configuration for the IPA interface * @@ -424,6 +453,11 @@ namespace libcamera { /** * \fn IPAInterface::init() * \brief Initialise the IPAInterface + * \param[in] settings The IPA initialization settings + * + * This function initializes the IPA interface. It shall be called before any + * other function of the IPAInterface. The \a settings carry initialization + * parameters that are valid for the whole life time of the IPA interface. */ /** |