libcamera v0.3.1 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 <stdint.h>
11
12#include <memory>
13#include <optional>
14#include <string>
15#include <vector>
16
17#include <libcamera/base/class.h>
18
19 namespace libcamera {
20
21 namespace ipa {
22
23 class CameraSensorHelper
24{
25 public:
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
33 protected:
34 enum AnalogueGainType {
35 AnalogueGainLinear,
36 AnalogueGainExponential,
37 };
38
39 struct AnalogueGainLinearConstants {
40 int16_t m0;
41 int16_t c0;
42 int16_t m1;
43 int16_t c1;
44 };
45
46 struct AnalogueGainExpConstants {
47 double a;
48 double m;
49 };
50
51 union AnalogueGainConstants {
52 AnalogueGainLinearConstants linear;
53 AnalogueGainExpConstants exp;
54 };
55
56 std::optional<int16_t> blackLevel_;
57 AnalogueGainType gainType_;
58 AnalogueGainConstants gainConstants_;
59
60 private:
61 LIBCAMERA_DISABLE_COPY_AND_MOVE(CameraSensorHelper)
62};
63
64 class CameraSensorHelperFactoryBase
65{
66 public:
67 CameraSensorHelperFactoryBase(const std::string name);
68 virtual ~CameraSensorHelperFactoryBase() = default;
69
70 static std::unique_ptr<CameraSensorHelper> create(const std::string &name);
71
72 static std::vector<CameraSensorHelperFactoryBase *> &factories();
73
74 private:
75 LIBCAMERA_DISABLE_COPY_AND_MOVE(CameraSensorHelperFactoryBase)
76
77 static void registerType(CameraSensorHelperFactoryBase *factory);
78
79 virtual std::unique_ptr<CameraSensorHelper> createInstance() const = 0;
80
81 std::string name_;
82};
83
84 template<typename _Helper>
85 class CameraSensorHelperFactory final : public CameraSensorHelperFactoryBase
86{
87 public:
88 CameraSensorHelperFactory(const char *name)
89 : CameraSensorHelperFactoryBase(name)
90 {
91 }
92
93 private:
94 std::unique_ptr<CameraSensorHelper> createInstance() const override
95 {
96 return std::make_unique<_Helper>();
97 }
98};
99
100#define REGISTER_CAMERA_SENSOR_HELPER(name, helper) \
101 static CameraSensorHelperFactory<helper> global_##helper##Factory(name);
102
103} /* namespace ipa */
104
105} /* 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
Base class for camera sensor helper factories.
Definition camera_sensor_helper.h:65
libcamera::ipa::CameraSensorHelperFactoryBase::CameraSensorHelperFactoryBase
CameraSensorHelperFactoryBase(const std::string name)
Construct a camera sensor helper factory base.
Definition camera_sensor_helper.cpp:272
libcamera::ipa::CameraSensorHelperFactoryBase::factories
static std::vector< CameraSensorHelperFactoryBase * > & factories()
Retrieve the list of all camera sensor helper factories.
Definition camera_sensor_helper.cpp:321
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:287
libcamera::ipa::CameraSensorHelperFactory
Registration of CameraSensorHelperFactory classes and creation of instances.
Definition camera_sensor_helper.h:86
libcamera::ipa::CameraSensorHelperFactory::CameraSensorHelperFactory
CameraSensorHelperFactory(const char *name)
Construct a camera sensor helper factory.
Definition camera_sensor_helper.h:88
libcamera::ipa::CameraSensorHelper
Base class for computing sensor tuning parameters using sensor-specific constants.
Definition camera_sensor_helper.h:24
libcamera::ipa::CameraSensorHelper::gainType_
AnalogueGainType gainType_
The analogue gain model type.
Definition camera_sensor_helper.h:57
libcamera::ipa::CameraSensorHelper::blackLevel
std::optional< int16_t > blackLevel() const
Construct a CameraSensorHelper instance.
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:87
libcamera::ipa::CameraSensorHelper::AnalogueGainType
AnalogueGainType
The gain calculation modes as defined by the MIPI CCS.
Definition camera_sensor_helper.h:34
libcamera::ipa::CameraSensorHelper::AnalogueGainExponential
@ AnalogueGainExponential
Gain is expressed using an exponential model.
Definition camera_sensor_helper.h:36
libcamera::ipa::CameraSensorHelper::AnalogueGainLinear
@ AnalogueGainLinear
Gain is computed using linear gain estimation.
Definition camera_sensor_helper.h:35
libcamera::ipa::CameraSensorHelper::blackLevel_
std::optional< int16_t > blackLevel_
The black level of the sensor.
Definition camera_sensor_helper.h:56
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:119
libcamera::ipa::CameraSensorHelper::gainConstants_
AnalogueGainConstants gainConstants_
The analogue gain parameters used for calculation.
Definition camera_sensor_helper.h:58
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::ipa::CameraSensorHelper::AnalogueGainExpConstants
Analogue gain constants for the exponential gain model.
Definition camera_sensor_helper.h:46
libcamera::ipa::CameraSensorHelper::AnalogueGainExpConstants::a
double a
Constant used in the exponential gain coding/decoding.
Definition camera_sensor_helper.h:47
libcamera::ipa::CameraSensorHelper::AnalogueGainExpConstants::m
double m
Constant used in the exponential gain coding/decoding.
Definition camera_sensor_helper.h:48
libcamera::ipa::CameraSensorHelper::AnalogueGainLinearConstants
Analogue gain constants for the linear gain model.
Definition camera_sensor_helper.h:39
libcamera::ipa::CameraSensorHelper::AnalogueGainLinearConstants::m1
int16_t m1
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:42
libcamera::ipa::CameraSensorHelper::AnalogueGainLinearConstants::m0
int16_t m0
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:40
libcamera::ipa::CameraSensorHelper::AnalogueGainLinearConstants::c0
int16_t c0
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:41
libcamera::ipa::CameraSensorHelper::AnalogueGainLinearConstants::c1
int16_t c1
Constant used in the linear gain coding/decoding.
Definition camera_sensor_helper.h:43
libcamera::ipa::CameraSensorHelper::AnalogueGainConstants
Analogue gain model constants.
Definition camera_sensor_helper.h:51
libcamera::ipa::CameraSensorHelper::AnalogueGainConstants::linear
AnalogueGainLinearConstants linear
Constants for the linear gain model.
Definition camera_sensor_helper.h:52
libcamera::ipa::CameraSensorHelper::AnalogueGainConstants::exp
AnalogueGainExpConstants exp
Constants for the exponential gain model.
Definition camera_sensor_helper.h:53