libcamera/include/libcamera/internal/delayed_controls.h
Laurent Pinchart 626172a16b libcamera: Drop file name from header comment blocks
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>
2024-05-08 22:39:50 +03:00

81 lines
1.7 KiB
C++

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2020, Raspberry Pi Ltd
*
* Helper to deal with controls that take effect with a delay
*/
#pragma once
#include <stdint.h>
#include <unordered_map>
#include <libcamera/controls.h>
namespace libcamera {
class V4L2Device;
class DelayedControls
{
public:
struct ControlParams {
unsigned int delay;
bool priorityWrite;
};
DelayedControls(V4L2Device *device,
const std::unordered_map<uint32_t, ControlParams> &controlParams);
void reset();
bool push(const ControlList &controls);
ControlList get(uint32_t sequence);
void applyControls(uint32_t sequence);
private:
class Info : public ControlValue
{
public:
Info()
: updated(false)
{
}
Info(const ControlValue &v, bool updated_ = true)
: ControlValue(v), updated(updated_)
{
}
bool updated;
};
/* \todo Make the listSize configurable at instance creation time. */
static constexpr int listSize = 16;
class ControlRingBuffer : public std::array<Info, listSize>
{
public:
Info &operator[](unsigned int index)
{
return std::array<Info, listSize>::operator[](index % listSize);
}
const Info &operator[](unsigned int index) const
{
return std::array<Info, listSize>::operator[](index % listSize);
}
};
V4L2Device *device_;
/* \todo Evaluate if we should index on ControlId * or unsigned int */
std::unordered_map<const ControlId *, ControlParams> controlParams_;
unsigned int maxDelay_;
uint32_t queueCount_;
uint32_t writeCount_;
/* \todo Evaluate if we should index on ControlId * or unsigned int */
std::unordered_map<const ControlId *, ControlRingBuffer> values_;
};
} /* namespace libcamera */