Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.
Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment block.
The change was generated with the following script:
----------------------------------------
dirs="include/libcamera src test utils"
declare -rA patterns=(
['c']=' \* '
['cpp']=' \* '
['h']=' \* '
['py']='# '
['sh']='# '
)
for ext in ${!patterns[@]} ; do
files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
pattern=${patterns[${ext}]}
for file in $files ; do
name=$(basename ${file})
sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
done
done
----------------------------------------
This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
107 lines
2.4 KiB
C++
107 lines
2.4 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2021, Ideas On Board
|
|
*
|
|
* ISP control algorithm interface
|
|
*/
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <stdint.h>
|
|
#include <string>
|
|
|
|
#include <libcamera/controls.h>
|
|
|
|
namespace libcamera {
|
|
|
|
class YamlObject;
|
|
|
|
namespace ipa {
|
|
|
|
template<typename _Module>
|
|
class Algorithm
|
|
{
|
|
public:
|
|
using Module = _Module;
|
|
|
|
virtual ~Algorithm() {}
|
|
|
|
virtual int init([[maybe_unused]] typename Module::Context &context,
|
|
[[maybe_unused]] const YamlObject &tuningData)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
virtual int configure([[maybe_unused]] typename Module::Context &context,
|
|
[[maybe_unused]] const typename Module::Config &configInfo)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
virtual void queueRequest([[maybe_unused]] typename Module::Context &context,
|
|
[[maybe_unused]] const uint32_t frame,
|
|
[[maybe_unused]] typename Module::FrameContext &frameContext,
|
|
[[maybe_unused]] const ControlList &controls)
|
|
{
|
|
}
|
|
|
|
virtual void prepare([[maybe_unused]] typename Module::Context &context,
|
|
[[maybe_unused]] const uint32_t frame,
|
|
[[maybe_unused]] typename Module::FrameContext &frameContext,
|
|
[[maybe_unused]] typename Module::Params *params)
|
|
{
|
|
}
|
|
|
|
virtual void process([[maybe_unused]] typename Module::Context &context,
|
|
[[maybe_unused]] const uint32_t frame,
|
|
[[maybe_unused]] typename Module::FrameContext &frameContext,
|
|
[[maybe_unused]] const typename Module::Stats *stats,
|
|
[[maybe_unused]] ControlList &metadata)
|
|
{
|
|
}
|
|
};
|
|
|
|
template<typename _Module>
|
|
class AlgorithmFactoryBase
|
|
{
|
|
public:
|
|
AlgorithmFactoryBase(const char *name)
|
|
: name_(name)
|
|
{
|
|
_Module::registerAlgorithm(this);
|
|
}
|
|
|
|
virtual ~AlgorithmFactoryBase() = default;
|
|
|
|
const std::string &name() const { return name_; }
|
|
|
|
virtual std::unique_ptr<Algorithm<_Module>> create() const = 0;
|
|
|
|
private:
|
|
std::string name_;
|
|
};
|
|
|
|
template<typename _Algorithm>
|
|
class AlgorithmFactory : public AlgorithmFactoryBase<typename _Algorithm::Module>
|
|
{
|
|
public:
|
|
AlgorithmFactory(const char *name)
|
|
: AlgorithmFactoryBase<typename _Algorithm::Module>(name)
|
|
{
|
|
}
|
|
|
|
~AlgorithmFactory() = default;
|
|
|
|
std::unique_ptr<Algorithm<typename _Algorithm::Module>> create() const override
|
|
{
|
|
return std::make_unique<_Algorithm>();
|
|
}
|
|
};
|
|
|
|
#define REGISTER_IPA_ALGORITHM(algorithm, name) \
|
|
static AlgorithmFactory<algorithm> global_##algorithm##Factory(name);
|
|
|
|
} /* namespace ipa */
|
|
|
|
} /* namespace libcamera */
|