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>
32 lines
1.3 KiB
Python
32 lines
1.3 KiB
Python
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
#
|
|
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
|
|
#
|
|
# Base class for algorithm-specific tuning modules
|
|
|
|
|
|
# @var type Type of the module. Defined in the base module.
|
|
# @var out_name The key that will be used for the algorithm in the algorithms
|
|
# dictionary in the tuning output file
|
|
# @var hr_name Human-readable module name, mostly for debugging
|
|
class Module(object):
|
|
type = 'base'
|
|
hr_name = 'Base Module'
|
|
out_name = 'GenericAlgorithm'
|
|
|
|
def __init__(self):
|
|
pass
|
|
|
|
def validate_config(self, config: dict) -> bool:
|
|
raise NotImplementedError
|
|
|
|
# @brief Do the module's processing
|
|
# @param config Full configuration from the input configuration file
|
|
# @param images List of images to process
|
|
# @param outputs The outputs of all modules that were executed before this
|
|
# module. Note that this is an input parameter, and the
|
|
# output of this module should be returned directly
|
|
# @return Result of the module's processing. It may be empty. None
|
|
# indicates failure and that the result should not be used.
|
|
def process(self, config: dict, images: list, outputs: dict) -> dict:
|
|
raise NotImplementedError
|