summaryrefslogtreecommitdiff
path: root/src/qcam/assets/feathericons/book-open.svg
diff options
context:
space:
mode:
Diffstat (limited to 'src/qcam/assets/feathericons/book-open.svg')
0 files changed, 0 insertions, 0 deletions
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
/* 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.
 */

/**
 * \typedef Algorithm::Module
 * \brief The IPA module type for this class of algorithms
 */

/**
 * \fn Algorithm::init()
 * \brief Initialize the Algorithm with tuning data
 * \param[in] context The shared IPA context
 * \param[in] tuningData The tuning data for the algorithm
 *
 * This function is called once, when the IPA module is initialized, to
 * initialize the algorithm. The \a tuningData YamlObject contains the tuning
 * data for algorithm.
 *
 * \return 0 if successful, an error code otherwise
 */

/**
 * \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