libcamera  v0.0.0
Supporting cameras in Linux since 2019
control_ids.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 /*
3  * Copyright (C) 2019, Google Inc.
4  *
5  * control_ids.h - Control ID list
6  *
7  * This file is auto-generated. Do not edit.
8  */
9 
10 #ifndef __LIBCAMERA_CONTROL_IDS_H__
11 #define __LIBCAMERA_CONTROL_IDS_H__
12 
13 #include <stdint.h>
14 
15 #include <libcamera/controls.h>
16 
17 namespace libcamera {
18 
19 namespace controls {
20 
21 enum {
22  AE_ENABLE = 1,
23  AE_LOCKED = 2,
24  AE_METERING_MODE = 3,
25  AE_CONSTRAINT_MODE = 4,
26  AE_EXPOSURE_MODE = 5,
27  EXPOSURE_VALUE = 6,
28  EXPOSURE_TIME = 7,
29  ANALOGUE_GAIN = 8,
30  BRIGHTNESS = 9,
31  CONTRAST = 10,
32  LUX = 11,
33  AWB_ENABLE = 12,
34  AWB_MODE = 13,
35  COLOUR_GAINS = 14,
36  COLOUR_TEMPERATURE = 15,
37  SATURATION = 16,
38  SENSOR_BLACK_LEVELS = 17,
39  SHARPNESS = 18,
40 };
41 
42 extern const Control<bool> AeEnable;
43 extern const Control<bool> AeLocked;
50 };
51 extern const Control<int32_t> AeMeteringMode;
58 };
66 };
67 extern const Control<int32_t> AeExposureMode;
68 extern const Control<float> ExposureValue;
69 extern const Control<int32_t> ExposureTime;
70 extern const Control<float> AnalogueGain;
71 extern const Control<float> Brightness;
72 extern const Control<float> Contrast;
73 extern const Control<float> Lux;
74 extern const Control<bool> AwbEnable;
76  AwbAuto = 0,
80  AwbIndoor = 4,
82  AwbCloudy = 6,
83  AwbCustom = 7,
85 };
86 extern const Control<int32_t> AwbMode;
89 extern const Control<float> Saturation;
91 extern const Control<float> Sharpness;
92 
93 extern const ControlIdMap controls;
94 
95 } /* namespace controls */
96 
97 } /* namespace libcamera */
98 
99 #endif /* __LIBCAMERA_CONTROL_IDS_H__ */
Cloudy AWB lighting mode.
Definition: control_ids.h:82
Incandescent AWB lamp mode.
Definition: control_ids.h:77
const Control< float > Saturation
Specify a fixed saturation parameter. Normal saturation is given by the value 1.0; larger values prod...
Custom metering mode.
Definition: control_ids.h:48
Default exposure mode.
Definition: control_ids.h:61
Exposure mode allowing only short exposure times.
Definition: control_ids.h:62
const Control< float > AnalogueGain
Analogue gain value applied in the sensor device. The value of the control specifies the gain multipl...
const Control< Span< const float > > ColourGains
Pair of gain values for the Red and Blue colour channels, in that order. ColourGains can only be appl...
Maximum allowed value (place any new values above here).
Definition: control_ids.h:65
const Control< bool > AeEnable
Enable or disable the AE.
const Control< int32_t > ColourTemperature
Report the current estimate of the colour temperature, in kelvin, for this frame. The ColourTemperatu...
Indoor AWB lighting mode.
Definition: control_ids.h:80
Definition: bound_method.h:15
const Control< float > Lux
Report an estimate of the current illuminance level in lux. The Lux control can only be returned in m...
Tungsten AWB lamp mode.
Definition: control_ids.h:78
Exposure mode allowing long exposure times.
Definition: control_ids.h:63
AwbModeValues
Supported AwbMode values.
Definition: control_ids.h:75
Describe a control and its intrinsic properties.
Definition: controls.h:250
const Control< int32_t > AwbMode
Specify the range of illuminants to use for the AWB algorithm. The modes supported are platform speci...
Daylight AWB lighting mode.
Definition: control_ids.h:81
const Control< int32_t > AeConstraintMode
Specify a constraint mode for the AE algorithm to use. These determine how the measured scene brightn...
std::unordered_map< unsigned int, const ControlId * > ControlIdMap
A map of numerical control ID to ControlId.
Definition: controls.h:294
const Control< Span< const int32_t > > SensorBlackLevels
Reports the sensor black levels used for processing a frame, in the order R, Gr, Gb, B. These values are returned as numbers out of a 16-bit pixel range (as if pixels ranged from 0 to 65535). The SensorBlackLevels control can only be returned in metadata.
const Control< float > Sharpness
A value of 0.0 means no sharpening. The minimum value means minimal sharpening, and shall be 0...
Highlight constraint mode. This mode adjusts the exposure levels in order to try and avoid over-expos...
Definition: control_ids.h:54
Spot metering mode.
Definition: control_ids.h:46
AeMeteringModeValues
Supported AeMeteringMode values.
Definition: control_ids.h:44
const Control< int32_t > ExposureTime
Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in ...
Default constraint mode. This mode aims to balance the exposure of different parts of the image so as...
Definition: control_ids.h:53
AeExposureModeValues
Supported AeExposureMode values.
Definition: control_ids.h:60
Shadows constraint mode. This mode adjusts the exposure levels in order to try and avoid under-exposi...
Definition: control_ids.h:55
const Control< float > ExposureValue
Specify an Exposure Value (EV) parameter. The EV parameter will only be applied if the AE algorithm i...
const Control< int32_t > AeMeteringMode
Specify a metering mode for the AE algorithm to use. The metering modes determine which parts of the ...
AeConstraintModeValues
Supported AeConstraintMode values.
Definition: control_ids.h:52
Search over the whole colour temperature range.
Definition: control_ids.h:76
Fluorescent AWB lamp mode.
Definition: control_ids.h:79
const Control< bool > AwbEnable
Enable or disable the AWB.
const Control< float > Brightness
Specify a fixed brightness parameter. Positive values (up to 1.0) produce brighter images; negative v...
Matrix metering mode.
Definition: control_ids.h:47
const Control< bool > AeLocked
Report the lock status of a running AE algorithm.
const ControlIdMap controls
List of all supported libcamera controls.
Definition: control_ids.cpp:291
Maximum allowed value (place any new values above here).
Definition: control_ids.h:49
Custom exposure mode.
Definition: control_ids.h:64
Maximum allowed value (place any new values above here).
Definition: control_ids.h:84
const Control< int32_t > AeExposureMode
Specify an exposure mode for the AE algorithm to use. These specify how the desired total exposure is...
Framework to manage controls related to an object.
Custom constraint mode.
Definition: control_ids.h:56
const Control< float > Contrast
Specify a fixed contrast parameter. Normal contrast is given by the value 1.0; larger values produce ...
Maximum allowed value (place any new values above here).
Definition: control_ids.h:57
Centre-weighted metering mode.
Definition: control_ids.h:45
Custom AWB mode.
Definition: control_ids.h:83