libcamera: src/ipa/libipa/camera_sensor_helper.h Source File

libcamera v0.5.0 Supporting cameras in Linux since 2019 |

Loading...
Searching...
No Matches
camera_sensor_helper.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2021, Google Inc.
4 *
5 * Helper class that performs sensor-specific parameter computations
6 */
7
8#pragma once
9
10#include <memory>
11#include <optional>
12#include <stdint.h>
13#include <string>
14#include <variant>
15#include <vector>
16
17#include <libcamera/base/class.h>
18
19namespace libcamera {
20
21namespace ipa {
22
23 class CameraSensorHelper
24{
25public:
26 CameraSensorHelper() = default;
27 virtual ~CameraSensorHelper() = default;
28
29 std::optional<int16_t> blackLevel() const { return blackLevel_; }
30 virtual uint32_t gainCode(double gain) const;
31 virtual double gain(uint32_t gainCode) const;
32
33protected:
34 struct AnalogueGainLinear {
35 int16_t m0;
36 int16_t c0;
37 int16_t m1;
38 int16_t c1;
39 };
40
41 struct AnalogueGainExp {
42 double a;
43 double m;
44 };
45
46 std::optional<int16_t> blackLevel_;
47 std::variant<std::monostate, AnalogueGainLinear, AnalogueGainExp> gain_;
48
49private:
50 LIBCAMERA_DISABLE_COPY_AND_MOVE(CameraSensorHelper)
51};
52
53 class CameraSensorHelperFactoryBase
54{
55public:
56 CameraSensorHelperFactoryBase(const std::string name);
57 virtual ~CameraSensorHelperFactoryBase() = default;
58
59 static std::unique_ptr<CameraSensorHelper> create(const std::string &name);
60
61 static std::vector<CameraSensorHelperFactoryBase *> &factories();
62
63private:
64 LIBCAMERA_DISABLE_COPY_AND_MOVE(CameraSensorHelperFactoryBase)
65
66 static void registerType(CameraSensorHelperFactoryBase *factory);
67
68 virtual std::unique_ptr<CameraSensorHelper> createInstance() const = 0;
69
70 std::string name_;
71};
72
73template<typename _Helper>
74 class CameraSensorHelperFactory final : public CameraSensorHelperFactoryBase
75{
76public:
77 CameraSensorHelperFactory(const char *name)
78 : CameraSensorHelperFactoryBase(name)
79 {
80 }
81
82private:
83 std::unique_ptr<CameraSensorHelper> createInstance() const override
84 {
85 return std::make_unique<_Helper>();
86 }
87};
88
89#define REGISTER_CAMERA_SENSOR_HELPER(name, helper) \
90static CameraSensorHelperFactory<helper> global_##helper##Factory(name);
91
92} /* namespace ipa */
93
94} /* namespace libcamera */
class.h
Utilities to help constructing class interfaces.
LIBCAMERA_DISABLE_COPY_AND_MOVE
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass)
Disable copy and move construction and assignment of the klass.
Definition class.h:29
libcamera::ipa::CameraSensorHelperFactoryBase::CameraSensorHelperFactoryBase
CameraSensorHelperFactoryBase(const std::string name)
Construct a camera sensor helper factory base.
Definition camera_sensor_helper.cpp:228
libcamera::ipa::CameraSensorHelperFactoryBase::factories
static std::vector< CameraSensorHelperFactoryBase * > & factories()
Retrieve the list of all camera sensor helper factories.
Definition camera_sensor_helper.cpp:277
libcamera::ipa::CameraSensorHelperFactoryBase::create
static std::unique_ptr< CameraSensorHelper > create(const std::string &name)
Create an instance of the CameraSensorHelper corresponding to a named factory.
Definition camera_sensor_helper.cpp:243
libcamera::ipa::CameraSensorHelperFactory::CameraSensorHelperFactory
CameraSensorHelperFactory(const char *name)
Construct a camera sensor helper factory.
Definition camera_sensor_helper.h:77
libcamera::ipa::CameraSensorHelper::blackLevel
std::optional< int16_t > blackLevel() const
Fetch the black level of the sensor.
Definition camera_sensor_helper.h:29
libcamera::ipa::CameraSensorHelper::gainCode
virtual uint32_t gainCode(double gain) const
Compute gain code from the analogue gain absolute value.
Definition camera_sensor_helper.cpp:88
libcamera::ipa::CameraSensorHelper::blackLevel_
std::optional< int16_t > blackLevel_
The black level of the sensor.
Definition camera_sensor_helper.h:46
libcamera::ipa::CameraSensorHelper::gain_
std::variant< std::monostate, AnalogueGainLinear, AnalogueGainExp > gain_
The analogue gain parameters used for calculation.
Definition camera_sensor_helper.h:47
libcamera::ipa::CameraSensorHelper::gain
virtual double gain(uint32_t gainCode) const
Compute the real gain from the V4L2 subdev control gain code.
Definition camera_sensor_helper.cpp:115
libcamera::ipa::CameraSensorHelper::CameraSensorHelper
CameraSensorHelper()=default
Construct a CameraSensorHelper instance.
libcamera::ipa
The IPA (Image Processing Algorithm) namespace.
Definition af.cpp:58
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::ipa::CameraSensorHelper::AnalogueGainExp
Analogue gain constants for the exponential gain model.
Definition camera_sensor_helper.h:41
libcamera::ipa::CameraSensorHelper::AnalogueGainExp::m
double m
Constant used in the exponential gain coding/decoding.
Definition camera_sensor_helper.h:43
libcamera::ipa::CameraSensorHelper::AnalogueGainExp::a
double a
Constant used in the exponential gain coding/decoding.
Definition camera_sensor_helper.h:42
libcamera::ipa::CameraSensorHelper::AnalogueGainLinear
Analogue gain constants for the linear gain model.
Definition camera_sensor_helper.h:34
libcamera::ipa::CameraSensorHelper::AnalogueGainLinear::m1
int16_t m1
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:37
libcamera::ipa::CameraSensorHelper::AnalogueGainLinear::m0
int16_t m0
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:35
libcamera::ipa::CameraSensorHelper::AnalogueGainLinear::c0
int16_t c0
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:36
libcamera::ipa::CameraSensorHelper::AnalogueGainLinear::c1
int16_t c1
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:38