Laurent Pinchart
626172a16b
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>
39 lines
1.3 KiB
C++
39 lines
1.3 KiB
C++
/* SPDX-License-Identifier: BSD-2-Clause */
|
|
/*
|
|
* Copyright (C) 2019, Raspberry Pi Ltd
|
|
*
|
|
* AGC/AEC control algorithm interface
|
|
*/
|
|
#pragma once
|
|
|
|
#include <vector>
|
|
|
|
#include <libcamera/base/utils.h>
|
|
|
|
#include "algorithm.h"
|
|
|
|
namespace RPiController {
|
|
|
|
class AgcAlgorithm : public Algorithm
|
|
{
|
|
public:
|
|
AgcAlgorithm(Controller *controller) : Algorithm(controller) {}
|
|
/* An AGC algorithm must provide the following: */
|
|
virtual unsigned int getConvergenceFrames() const = 0;
|
|
virtual std::vector<double> const &getWeights() const = 0;
|
|
virtual void setEv(unsigned int channel, double ev) = 0;
|
|
virtual void setFlickerPeriod(libcamera::utils::Duration flickerPeriod) = 0;
|
|
virtual void setFixedShutter(unsigned int channel,
|
|
libcamera::utils::Duration fixedShutter) = 0;
|
|
virtual void setMaxShutter(libcamera::utils::Duration maxShutter) = 0;
|
|
virtual void setFixedAnalogueGain(unsigned int channel, double fixedAnalogueGain) = 0;
|
|
virtual void setMeteringMode(std::string const &meteringModeName) = 0;
|
|
virtual void setExposureMode(std::string const &exposureModeName) = 0;
|
|
virtual void setConstraintMode(std::string const &contraintModeName) = 0;
|
|
virtual void enableAuto() = 0;
|
|
virtual void disableAuto() = 0;
|
|
virtual void setActiveChannels(const std::vector<unsigned int> &activeChannels) = 0;
|
|
};
|
|
|
|
} /* namespace RPiController */
|