libcamera v0.0.0+3240-f2a18172-dirty (2022-05-13T20:32:10+00:00)
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 <array>
14#include <stdint.h>
15
16#include <libcamera/controls.h>
17
18namespace libcamera {
19
20namespace controls {
21
22enum {
23 AE_ENABLE = 1,
24 AE_LOCKED = 2,
25 AE_METERING_MODE = 3,
26 AE_CONSTRAINT_MODE = 4,
27 AE_EXPOSURE_MODE = 5,
28 EXPOSURE_VALUE = 6,
29 EXPOSURE_TIME = 7,
30 ANALOGUE_GAIN = 8,
31 BRIGHTNESS = 9,
32 CONTRAST = 10,
33 LUX = 11,
34 AWB_ENABLE = 12,
35 AWB_MODE = 13,
36 AWB_LOCKED = 14,
37 COLOUR_GAINS = 15,
38 COLOUR_TEMPERATURE = 16,
39 SATURATION = 17,
40 SENSOR_BLACK_LEVELS = 18,
41 SHARPNESS = 19,
42 FOCUS_FO_M = 20,
43 COLOUR_CORRECTION_MATRIX = 21,
44 SCALER_CROP = 22,
45 DIGITAL_GAIN = 23,
46 FRAME_DURATION = 24,
47 FRAME_DURATION_LIMITS = 25,
48 SENSOR_TIMESTAMP = 26,
49 AE_PRECAPTURE_TRIGGER = 27,
50 AF_TRIGGER = 28,
51 NOISE_REDUCTION_MODE = 29,
52 COLOR_CORRECTION_ABERRATION_MODE = 30,
53 AE_STATE = 31,
54 AF_STATE = 32,
55 AWB_STATE = 33,
56 SENSOR_ROLLING_SHUTTER_SKEW = 34,
57 LENS_SHADING_MAP_MODE = 35,
58 SCENE_FLICKER = 36,
59 PIPELINE_DEPTH = 37,
60 MAX_LATENCY = 38,
61 TEST_PATTERN_MODE = 39,
62};
63
64extern const Control<bool> AeEnable;
65extern const Control<bool> AeLocked;
71};
72extern const std::array<const ControlValue, 4> AeMeteringModeValues;
79};
80extern const std::array<const ControlValue, 4> AeConstraintModeValues;
87};
88extern const std::array<const ControlValue, 4> AeExposureModeValues;
90extern const Control<float> ExposureValue;
92extern const Control<float> AnalogueGain;
93extern const Control<float> Brightness;
94extern const Control<float> Contrast;
95extern const Control<float> Lux;
96extern const Control<bool> AwbEnable;
106};
107extern const std::array<const ControlValue, 8> AwbModeValues;
108extern const Control<int32_t> AwbMode;
109extern const Control<bool> AwbLocked;
112extern const Control<float> Saturation;
114extern const Control<float> Sharpness;
115extern const Control<int32_t> FocusFoM;
117extern const Control<Rectangle> ScalerCrop;
118extern const Control<float> DigitalGain;
122
123extern const ControlIdMap controls;
124
125namespace draft {
126
131};
132extern const std::array<const ControlValue, 3> AePrecaptureTriggerValues;
138};
139extern const std::array<const ControlValue, 3> AfTriggerValues;
140extern const Control<int32_t> AfTrigger;
147};
148extern const std::array<const ControlValue, 5> NoiseReductionModeValues;
154};
155extern const std::array<const ControlValue, 3> ColorCorrectionAberrationModeValues;
164};
165extern const std::array<const ControlValue, 6> AeStateValues;
166extern const Control<int32_t> AeState;
175};
176extern const std::array<const ControlValue, 7> AfStateValues;
177extern const Control<int32_t> AfState;
183};
184extern const std::array<const ControlValue, 4> AwbStateValues;
185extern const Control<int32_t> AwbState;
190};
191extern const std::array<const ControlValue, 2> LensShadingMapModeValues;
197};
198extern const std::array<const ControlValue, 3> SceneFlickerValues;
199extern const Control<int32_t> SceneFlicker;
201extern const Control<int32_t> MaxLatency;
209};
210extern const std::array<const ControlValue, 6> TestPatternModeValues;
212
213} /* namespace draft */
214
215} /* namespace controls */
216
217} /* namespace libcamera */
218
219#endif /* __LIBCAMERA_CONTROL_IDS_H__ */
Describe a control and its intrinsic properties.
Definition: controls.h:255
Framework to manage controls related to an object.
const Control< int32_t > LensShadingMapMode
Control to report if the lens shading map is available. Currently identical to ANDROID_STATISTICS_LEN...
const Control< int32_t > SceneFlicker
Control to report the detected scene light frequency. Currently identical to ANDROID_STATISTICS_SCENE...
const Control< int32_t > PipelineDepth
Specifies the number of pipeline stages the frame went through from when it was exposed to when the f...
const std::array< const ControlValue, 3 > AfTriggerValues
List of all AfTrigger supported values.
AeStateEnum
Supported AeState values.
Definition: control_ids.h:157
@ AeStateConverged
The AE algorithm has converged.
Definition: control_ids.h:160
@ AeStateLocked
The AE algorithm is locked.
Definition: control_ids.h:161
@ AeStateInactive
The AE algorithm is inactive.
Definition: control_ids.h:158
@ AeStatePrecapture
The AE algorithm has started a pre-capture metering session.
Definition: control_ids.h:163
@ AeStateSearching
The AE algorithm has not converged yet.
Definition: control_ids.h:159
@ AeStateFlashRequired
The AE algorithm would need a flash for good results.
Definition: control_ids.h:162
NoiseReductionModeEnum
Supported NoiseReductionMode values.
Definition: control_ids.h:141
@ NoiseReductionModeHighQuality
High quality noise reduction at the expense of frame rate.
Definition: control_ids.h:144
@ NoiseReductionModeMinimal
Minimal noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:145
@ NoiseReductionModeOff
No noise reduction is applied.
Definition: control_ids.h:142
@ NoiseReductionModeZSL
Noise reduction is applied at different levels to different streams.
Definition: control_ids.h:146
@ NoiseReductionModeFast
Noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:143
AfTriggerEnum
Supported AfTrigger values.
Definition: control_ids.h:134
@ AfTriggerCancel
The camera will cancel any active trigger and the AF routine is reset to its initial state.
Definition: control_ids.h:137
@ AfTriggerStart
The AF routine is started by the camera.
Definition: control_ids.h:136
@ AfTriggerIdle
The trigger is idle.
Definition: control_ids.h:135
AwbStateEnum
Supported AwbState values.
Definition: control_ids.h:178
@ AwbLocked
The AWB algorithm is locked.
Definition: control_ids.h:182
@ AwbStateInactive
The AWB algorithm is inactive.
Definition: control_ids.h:179
@ AwbConverged
The AWB algorithm has converged.
Definition: control_ids.h:181
@ AwbStateSearching
The AWB algorithm has not converged yet.
Definition: control_ids.h:180
const Control< int32_t > AeState
Control to report the current AE algorithm state. Currently identical to ANDROID_CONTROL_AE_STATE.
const Control< int32_t > AwbState
Control to report the current AWB algorithm state. Currently identical to ANDROID_CONTROL_AWB_STATE.
const std::array< const ControlValue, 3 > SceneFlickerValues
List of all SceneFlicker supported values.
const std::array< const ControlValue, 6 > AeStateValues
List of all AeState supported values.
const std::array< const ControlValue, 5 > NoiseReductionModeValues
List of all NoiseReductionMode supported values.
const Control< int32_t > NoiseReductionMode
Control to select the noise reduction algorithm mode. Currently identical to ANDROID_NOISE_REDUCTION_...
const std::array< const ControlValue, 3 > AePrecaptureTriggerValues
List of all AePrecaptureTrigger supported values.
const Control< int32_t > TestPatternMode
Control to select the test pattern mode. Currently identical to ANDROID_SENSOR_TEST_PATTERN_MODE.
const Control< int32_t > AePrecaptureTrigger
Control for AE metering trigger. Currently identical to ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER.
LensShadingMapModeEnum
Supported LensShadingMapMode values.
Definition: control_ids.h:187
@ LensShadingMapModeOn
The lens shading map mode is available.
Definition: control_ids.h:189
@ LensShadingMapModeOff
No lens shading map mode is available.
Definition: control_ids.h:188
const Control< int32_t > ColorCorrectionAberrationMode
Control to select the color correction aberration mode. Currently identical to ANDROID_COLOR_CORRECTI...
const std::array< const ControlValue, 4 > AwbStateValues
List of all AwbState supported values.
SceneFlickerEnum
Supported SceneFlicker values.
Definition: control_ids.h:193
@ SceneFicker50Hz
50Hz flickering detected.
Definition: control_ids.h:195
@ SceneFickerOff
No flickering detected.
Definition: control_ids.h:194
@ SceneFicker60Hz
60Hz flickering detected.
Definition: control_ids.h:196
TestPatternModeEnum
Supported TestPatternMode values.
Definition: control_ids.h:202
@ TestPatternModeColorBarsFadeToGray
The test pattern is similar to TestPatternModeColorBars, except that each bar should start at its spe...
Definition: control_ids.h:206
@ TestPatternModeCustom1
The first custom test pattern. All custom patterns that are available only on this camera device are ...
Definition: control_ids.h:208
@ TestPatternModePn9
All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typical...
Definition: control_ids.h:207
@ TestPatternModeOff
No test pattern mode is used. The camera device returns frames from the image sensor.
Definition: control_ids.h:203
@ TestPatternModeSolidColor
Each pixel in [R, G_even, G_odd, B] is replaced by its respective color channel provided in test patt...
Definition: control_ids.h:204
@ TestPatternModeColorBars
All pixel data is replaced with an 8-bar color pattern. The vertical bars (left-to-right) are as foll...
Definition: control_ids.h:205
const std::array< const ControlValue, 2 > LensShadingMapModeValues
List of all LensShadingMapMode supported values.
AfStateEnum
Supported AfState values.
Definition: control_ids.h:167
@ AfStatePassiveUnfocused
AF has completed a passive scan without finding focus.
Definition: control_ids.h:174
@ AfStatePassiveFocused
AF believes the scene is in focus, but might restart scanning.
Definition: control_ids.h:170
@ AfStateFocusedLock
AF believes has focused correctly and has locked focus.
Definition: control_ids.h:172
@ AfStateActiveScan
AF is performing a scan triggered by an AF trigger request.
Definition: control_ids.h:171
@ AfStateNotFocusedLock
AF has not been able to focus and has locked.
Definition: control_ids.h:173
@ AfStatePassiveScan
AF is performing a passive scan of the scene in continuous auto-focus mode.
Definition: control_ids.h:169
@ AfStateInactive
The AF algorithm is inactive.
Definition: control_ids.h:168
const Control< int32_t > AfState
Control to report the current AF algorithm state. Currently identical to ANDROID_CONTROL_AF_STATE.
const std::array< const ControlValue, 7 > AfStateValues
List of all AfState supported values.
const Control< int32_t > MaxLatency
The maximum number of frames that can occur after a request (different than the previous) has been su...
const std::array< const ControlValue, 6 > TestPatternModeValues
List of all TestPatternMode supported values.
ColorCorrectionAberrationModeEnum
Supported ColorCorrectionAberrationMode values.
Definition: control_ids.h:150
@ ColorCorrectionAberrationHighQuality
High quality aberration correction which might reduce the frame rate.
Definition: control_ids.h:153
@ ColorCorrectionAberrationOff
No aberration correction is applied.
Definition: control_ids.h:151
@ ColorCorrectionAberrationFast
Aberration correction will not slow down the frame rate.
Definition: control_ids.h:152
const Control< int64_t > SensorRollingShutterSkew
Control to report the time between the start of exposure of the first row and the start of exposure o...
const std::array< const ControlValue, 3 > ColorCorrectionAberrationModeValues
List of all ColorCorrectionAberrationMode supported values.
const Control< int32_t > AfTrigger
Control for AF trigger. Currently identical to ANDROID_CONTROL_AF_TRIGGER.
AePrecaptureTriggerEnum
Supported AePrecaptureTrigger values.
Definition: control_ids.h:127
@ AePrecaptureTriggerStart
The pre-capture AE metering is started by the camera.
Definition: control_ids.h:129
@ AePrecaptureTriggerIdle
The trigger is idle.
Definition: control_ids.h:128
@ AePrecaptureTriggerCancel
The camera will cancel any active or completed metering sequence. The AE algorithm is reset to its in...
Definition: control_ids.h:130
const Control< int64_t > SensorTimestamp
The time when the first row of the image sensor active array is exposed.
const Control< float > Brightness
Specify a fixed brightness parameter. Positive values (up to 1.0) produce brighter images; negative v...
const std::array< const ControlValue, 4 > AeConstraintModeValues
List of all AeConstraintMode supported values.
const Control< int32_t > AeExposureMode
Specify an exposure mode for the AE algorithm to use. These specify how the desired total exposure is...
const Control< int32_t > AwbMode
Specify the range of illuminants to use for the AWB algorithm. The modes supported are platform speci...
const Control< Span< const int32_t > > SensorBlackLevels
Reports the sensor black levels used for processing a frame, in the order R, Gr, Gb,...
const Control< int64_t > FrameDuration
The instantaneous frame duration from start of frame exposure to start of next exposure,...
const Control< bool > AwbEnable
Enable or disable the AWB.
const Control< int32_t > FocusFoM
Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. A larger FocusFoM value indica...
const Control< int32_t > ExposureTime
Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in ...
const Control< bool > AeLocked
Report the lock status of a running AE algorithm.
const Control< Span< const int64_t > > FrameDurationLimits
The minimum and maximum (in that order) frame duration, expressed in microseconds.
const std::array< const ControlValue, 4 > AeMeteringModeValues
List of all AeMeteringMode supported values.
const std::array< const ControlValue, 4 > AeExposureModeValues
List of all AeExposureMode supported values.
const Control< float > Contrast
Specify a fixed contrast parameter. Normal contrast is given by the value 1.0; larger values produce ...
const Control< float > ExposureValue
Specify an Exposure Value (EV) parameter. The EV parameter will only be applied if the AE algorithm i...
const Control< bool > AeEnable
Enable or disable the AE.
AwbModeEnum
Supported AwbMode values.
Definition: control_ids.h:97
@ AwbDaylight
Daylight AWB lighting mode.
Definition: control_ids.h:103
@ AwbTungsten
Tungsten AWB lamp mode.
Definition: control_ids.h:100
@ AwbAuto
Search over the whole colour temperature range.
Definition: control_ids.h:98
@ AwbCustom
Custom AWB mode.
Definition: control_ids.h:105
@ AwbIndoor
Indoor AWB lighting mode.
Definition: control_ids.h:102
@ AwbFluorescent
Fluorescent AWB lamp mode.
Definition: control_ids.h:101
@ AwbIncandescent
Incandescent AWB lamp mode.
Definition: control_ids.h:99
@ AwbCloudy
Cloudy AWB lighting mode.
Definition: control_ids.h:104
const Control< float > DigitalGain
Digital gain value applied during the processing steps applied to the image as captured from the sens...
const Control< Rectangle > ScalerCrop
Sets the image portion that will be scaled to form the whole of the final output image....
const Control< int32_t > ColourTemperature
Report the current estimate of the colour temperature, in kelvin, for this frame. The ColourTemperatu...
const ControlIdMap controls
List of all supported libcamera controls.
Definition: control_ids.cpp:997
const Control< float > Saturation
Specify a fixed saturation parameter. Normal saturation is given by the value 1.0; larger values prod...
const Control< float > Lux
Report an estimate of the current illuminance level in lux. The Lux control can only be returned in m...
const Control< int32_t > AeMeteringMode
Specify a metering mode for the AE algorithm to use. The metering modes determine which parts of the ...
const std::array< const ControlValue, 8 > AwbModeValues
List of all AwbMode supported values.
AeMeteringModeEnum
Supported AeMeteringMode values.
Definition: control_ids.h:66
@ MeteringCentreWeighted
Centre-weighted metering mode.
Definition: control_ids.h:67
@ MeteringMatrix
Matrix metering mode.
Definition: control_ids.h:69
@ MeteringCustom
Custom metering mode.
Definition: control_ids.h:70
@ MeteringSpot
Spot metering mode.
Definition: control_ids.h:68
AeExposureModeEnum
Supported AeExposureMode values.
Definition: control_ids.h:82
@ ExposureLong
Exposure mode allowing long exposure times.
Definition: control_ids.h:85
@ ExposureNormal
Default exposure mode.
Definition: control_ids.h:83
@ ExposureShort
Exposure mode allowing only short exposure times.
Definition: control_ids.h:84
@ ExposureCustom
Custom exposure mode.
Definition: control_ids.h:86
const Control< float > AnalogueGain
Analogue gain value applied in the sensor device. The value of the control specifies the gain multipl...
AeConstraintModeEnum
Supported AeConstraintMode values.
Definition: control_ids.h:74
@ ConstraintHighlight
Highlight constraint mode. This mode adjusts the exposure levels in order to try and avoid over-expos...
Definition: control_ids.h:76
@ ConstraintCustom
Custom constraint mode.
Definition: control_ids.h:78
@ ConstraintShadows
Shadows constraint mode. This mode adjusts the exposure levels in order to try and avoid under-exposi...
Definition: control_ids.h:77
@ ConstraintNormal
Default constraint mode. This mode aims to balance the exposure of different parts of the image so as...
Definition: control_ids.h:75
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...
const Control< Span< const float > > ColourCorrectionMatrix
The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline. This should describe the...
const Control< float > Sharpness
A value of 0.0 means no sharpening. The minimum value means minimal sharpening, and shall be 0....
const Control< bool > AwbLocked
Report the lock status of a running AWB algorithm.
const Control< int32_t > AeConstraintMode
Specify a constraint mode for the AE algorithm to use. These determine how the measured scene brightn...
Top-level libcamera namespace.
Definition: backtrace.h:17
std::unordered_map< unsigned int, const ControlId * > ControlIdMap
A map of numerical control ID to ControlId.
Definition: controls.h:303