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>
49 lines
1.2 KiB
C++
49 lines
1.2 KiB
C++
/* SPDX-License-Identifier: BSD-2-Clause */
|
|
/*
|
|
* Copyright (C) 2019, Raspberry Pi Ltd
|
|
*
|
|
* AGC/AEC control algorithm status
|
|
*/
|
|
#pragma once
|
|
|
|
#include <string>
|
|
|
|
#include <libcamera/base/utils.h>
|
|
|
|
#include "hdr_status.h"
|
|
|
|
/*
|
|
* The AGC algorithm process method should post an AgcStatus into the image
|
|
* metadata under the tag "agc.status".
|
|
* The AGC algorithm prepare method should post an AgcPrepareStatus instead
|
|
* under "agc.prepare_status".
|
|
*/
|
|
|
|
/*
|
|
* Note: total_exposure_value will be reported as zero until the algorithm has
|
|
* seen statistics and calculated meaningful values. The contents should be
|
|
* ignored until then.
|
|
*/
|
|
|
|
struct AgcStatus {
|
|
libcamera::utils::Duration totalExposureValue; /* value for all exposure and gain for this image */
|
|
libcamera::utils::Duration targetExposureValue; /* (unfiltered) target total exposure AGC is aiming for */
|
|
libcamera::utils::Duration shutterTime;
|
|
double analogueGain;
|
|
std::string exposureMode;
|
|
std::string constraintMode;
|
|
std::string meteringMode;
|
|
double ev;
|
|
libcamera::utils::Duration flickerPeriod;
|
|
int floatingRegionEnable;
|
|
libcamera::utils::Duration fixedShutter;
|
|
double fixedAnalogueGain;
|
|
unsigned int channel;
|
|
HdrStatus hdr;
|
|
};
|
|
|
|
struct AgcPrepareStatus {
|
|
double digitalGain;
|
|
int locked;
|
|
};
|