libcamera v0.0.3
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#pragma once
11
12#include <array>
13#include <stdint.h>
14
15#include <libcamera/controls.h>
16
17namespace libcamera {
18
19namespace controls {
20
21enum {
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 AWB_LOCKED = 14,
36 COLOUR_GAINS = 15,
37 COLOUR_TEMPERATURE = 16,
38 SATURATION = 17,
39 SENSOR_BLACK_LEVELS = 18,
40 SHARPNESS = 19,
41 FOCUS_FO_M = 20,
42 COLOUR_CORRECTION_MATRIX = 21,
43 SCALER_CROP = 22,
44 DIGITAL_GAIN = 23,
45 FRAME_DURATION = 24,
46 FRAME_DURATION_LIMITS = 25,
47 SENSOR_TEMPERATURE = 26,
48 SENSOR_TIMESTAMP = 27,
49 AF_MODE = 28,
50 AF_RANGE = 29,
51 AF_SPEED = 30,
52 AF_METERING = 31,
53 AF_WINDOWS = 32,
54 AF_TRIGGER = 33,
55 AF_PAUSE = 34,
56 LENS_POSITION = 35,
57 AF_STATE = 36,
58 AF_PAUSE_STATE = 37,
59 AE_PRECAPTURE_TRIGGER = 38,
60 NOISE_REDUCTION_MODE = 39,
61 COLOR_CORRECTION_ABERRATION_MODE = 40,
62 AE_STATE = 41,
63 AWB_STATE = 42,
64 SENSOR_ROLLING_SHUTTER_SKEW = 43,
65 LENS_SHADING_MAP_MODE = 44,
66 SCENE_FLICKER = 45,
67 PIPELINE_DEPTH = 46,
68 MAX_LATENCY = 47,
69 TEST_PATTERN_MODE = 48,
70};
71
72extern const Control<bool> AeEnable;
73extern const Control<bool> AeLocked;
79};
80extern const std::array<const ControlValue, 4> AeMeteringModeValues;
87};
88extern const std::array<const ControlValue, 4> AeConstraintModeValues;
95};
96extern const std::array<const ControlValue, 4> AeExposureModeValues;
98extern const Control<float> ExposureValue;
100extern const Control<float> AnalogueGain;
101extern const Control<float> Brightness;
102extern const Control<float> Contrast;
103extern const Control<float> Lux;
104extern const Control<bool> AwbEnable;
114};
115extern const std::array<const ControlValue, 8> AwbModeValues;
116extern const Control<int32_t> AwbMode;
117extern const Control<bool> AwbLocked;
120extern const Control<float> Saturation;
122extern const Control<float> Sharpness;
123extern const Control<int32_t> FocusFoM;
125extern const Control<Rectangle> ScalerCrop;
126extern const Control<float> DigitalGain;
135};
136extern const std::array<const ControlValue, 3> AfModeValues;
137extern const Control<int32_t> AfMode;
142};
143extern const std::array<const ControlValue, 3> AfRangeValues;
144extern const Control<int32_t> AfRange;
148};
149extern const std::array<const ControlValue, 2> AfSpeedValues;
150extern const Control<int32_t> AfSpeed;
154};
155extern const std::array<const ControlValue, 2> AfMeteringValues;
156extern const Control<int32_t> AfMetering;
161};
162extern const std::array<const ControlValue, 2> AfTriggerValues;
163extern const Control<int32_t> AfTrigger;
168};
169extern const std::array<const ControlValue, 3> AfPauseValues;
170extern const Control<int32_t> AfPause;
171extern const Control<float> LensPosition;
177};
178extern const std::array<const ControlValue, 4> AfStateValues;
179extern const Control<int32_t> AfState;
184};
185extern const std::array<const ControlValue, 3> AfPauseStateValues;
186extern const Control<int32_t> AfPauseState;
187
188extern const ControlIdMap controls;
189
190namespace draft {
191
196};
197extern const std::array<const ControlValue, 3> AePrecaptureTriggerValues;
205};
206extern const std::array<const ControlValue, 5> NoiseReductionModeValues;
212};
213extern const std::array<const ControlValue, 3> ColorCorrectionAberrationModeValues;
222};
223extern const std::array<const ControlValue, 6> AeStateValues;
224extern const Control<int32_t> AeState;
230};
231extern const std::array<const ControlValue, 4> AwbStateValues;
232extern const Control<int32_t> AwbState;
237};
238extern const std::array<const ControlValue, 2> LensShadingMapModeValues;
244};
245extern const std::array<const ControlValue, 3> SceneFlickerValues;
246extern const Control<int32_t> SceneFlicker;
248extern const Control<int32_t> MaxLatency;
256};
257extern const std::array<const ControlValue, 6> TestPatternModeValues;
259
260} /* namespace draft */
261
262} /* namespace controls */
263
264} /* namespace libcamera */
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...
AeStateEnum
Supported AeState values.
Definition: control_ids.h:215
@ AeStateConverged
The AE algorithm has converged.
Definition: control_ids.h:218
@ AeStateLocked
The AE algorithm is locked.
Definition: control_ids.h:219
@ AeStateInactive
The AE algorithm is inactive.
Definition: control_ids.h:216
@ AeStatePrecapture
The AE algorithm has started a pre-capture metering session.
Definition: control_ids.h:221
@ AeStateSearching
The AE algorithm has not converged yet.
Definition: control_ids.h:217
@ AeStateFlashRequired
The AE algorithm would need a flash for good results.
Definition: control_ids.h:220
NoiseReductionModeEnum
Supported NoiseReductionMode values.
Definition: control_ids.h:199
@ NoiseReductionModeHighQuality
High quality noise reduction at the expense of frame rate.
Definition: control_ids.h:202
@ NoiseReductionModeMinimal
Minimal noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:203
@ NoiseReductionModeOff
No noise reduction is applied.
Definition: control_ids.h:200
@ NoiseReductionModeZSL
Noise reduction is applied at different levels to different streams.
Definition: control_ids.h:204
@ NoiseReductionModeFast
Noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:201
AwbStateEnum
Supported AwbState values.
Definition: control_ids.h:225
@ AwbLocked
The AWB algorithm is locked.
Definition: control_ids.h:229
@ AwbStateInactive
The AWB algorithm is inactive.
Definition: control_ids.h:226
@ AwbConverged
The AWB algorithm has converged.
Definition: control_ids.h:228
@ AwbStateSearching
The AWB algorithm has not converged yet.
Definition: control_ids.h:227
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:234
@ LensShadingMapModeOn
The lens shading map mode is available.
Definition: control_ids.h:236
@ LensShadingMapModeOff
No lens shading map mode is available.
Definition: control_ids.h:235
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:240
@ SceneFicker50Hz
50Hz flickering detected.
Definition: control_ids.h:242
@ SceneFickerOff
No flickering detected.
Definition: control_ids.h:241
@ SceneFicker60Hz
60Hz flickering detected.
Definition: control_ids.h:243
TestPatternModeEnum
Supported TestPatternMode values.
Definition: control_ids.h:249
@ TestPatternModeColorBarsFadeToGray
The test pattern is similar to TestPatternModeColorBars, except that each bar should start at its spe...
Definition: control_ids.h:253
@ TestPatternModeCustom1
The first custom test pattern. All custom patterns that are available only on this camera device are ...
Definition: control_ids.h:255
@ TestPatternModePn9
All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typical...
Definition: control_ids.h:254
@ TestPatternModeOff
No test pattern mode is used. The camera device returns frames from the image sensor.
Definition: control_ids.h:250
@ 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:251
@ 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:252
const std::array< const ControlValue, 2 > LensShadingMapModeValues
List of all LensShadingMapMode 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:208
@ ColorCorrectionAberrationHighQuality
High quality aberration correction which might reduce the frame rate.
Definition: control_ids.h:211
@ ColorCorrectionAberrationOff
No aberration correction is applied.
Definition: control_ids.h:209
@ ColorCorrectionAberrationFast
Aberration correction will not slow down the frame rate.
Definition: control_ids.h:210
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.
AePrecaptureTriggerEnum
Supported AePrecaptureTrigger values.
Definition: control_ids.h:192
@ AePrecaptureTriggerStart
The pre-capture AE metering is started by the camera.
Definition: control_ids.h:194
@ AePrecaptureTriggerIdle
The trigger is idle.
Definition: control_ids.h:193
@ AePrecaptureTriggerCancel
The camera will cancel any active or completed metering sequence. The AE algorithm is reset to its in...
Definition: control_ids.h:195
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, 2 > AfSpeedValues
List of all AfSpeed supported values.
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 > AfSpeed
Control that determines whether the AF algorithm is to move the lens as quickly as possible or more s...
const Control< int32_t > AwbMode
Specify the range of illuminants to use for the AWB algorithm. The modes supported are platform speci...
const std::array< const ControlValue, 3 > AfModeValues
List of all AfMode supported values.
const Control< Span< const int32_t, 4 > > SensorBlackLevels
Reports the sensor black levels used for processing a frame, in the order R, Gr, Gb,...
AfModeEnum
Supported AfMode values.
Definition: control_ids.h:131
@ AfModeManual
The AF algorithm is in manual mode. In this mode it will never perform any action nor move the lens o...
Definition: control_ids.h:132
@ AfModeContinuous
The AF algorithm is in continuous mode. This means that the lens can re-start a scan spontaneously at...
Definition: control_ids.h:134
@ AfModeAuto
The AF algorithm is in auto mode. This means that the algorithm will never move the lens or change st...
Definition: control_ids.h:133
const std::array< const ControlValue, 4 > AfStateValues
List of all AfState supported values.
const Control< int64_t > FrameDuration
The instantaneous frame duration from start of frame exposure to start of next exposure,...
AfPauseEnum
Supported AfPause values.
Definition: control_ids.h:164
@ AfPauseDeferred
This is similar to AfPauseImmediate, and if the AfState is currently reporting AfStateFocused or AfSt...
Definition: control_ids.h:166
@ AfPauseResume
Resume continuous autofocus operation. The algorithm starts again from exactly where it left off,...
Definition: control_ids.h:167
@ AfPauseImmediate
Pause the continuous autofocus algorithm immediately, whether or not any kind of scan is underway....
Definition: control_ids.h:165
const Control< bool > AwbEnable
Enable or disable the AWB.
const Control< int32_t > AfRange
Control to set the range of focus distances that is scanned. An implementation may choose not to impl...
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 std::array< const ControlValue, 2 > AfMeteringValues
List of all AfMetering supported values.
const Control< int32_t > AfPause
This control has no effect except when in continuous autofocus mode (AfModeContinuous)....
const Control< int32_t > AfMode
Control to set the mode of the AF (autofocus) algorithm.
const std::array< const ControlValue, 3 > AfPauseValues
List of all AfPause supported values.
const Control< int32_t > ExposureTime
Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in ...
AfTriggerEnum
Supported AfTrigger values.
Definition: control_ids.h:158
@ AfTriggerStart
Start an AF scan. Ignored if a scan is in progress.
Definition: control_ids.h:159
@ AfTriggerCancel
Cancel an AF scan. This does not cause the lens to move anywhere else. Ignored if no scan is in progr...
Definition: control_ids.h:160
const Control< bool > AeLocked
Report the lock status of a running AE algorithm.
const Control< Span< const int64_t, 2 > > 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.
AfStateEnum
Supported AfState values.
Definition: control_ids.h:172
@ AfStateIdle
The AF algorithm is in manual mode (AfModeManual) or in auto mode (AfModeAuto) and a scan has not yet...
Definition: control_ids.h:173
@ AfStateScanning
The AF algorithm is in auto mode (AfModeAuto), and a scan has been started using the AfTrigger contro...
Definition: control_ids.h:174
@ AfStateFailed
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition: control_ids.h:176
@ AfStateFocused
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition: control_ids.h:175
const Control< int32_t > AfPauseState
Only applicable in continuous (AfModeContinuous) mode, this reports whether the algorithm is currentl...
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.
const std::array< const ControlValue, 2 > AfTriggerValues
List of all AfTrigger supported values.
AwbModeEnum
Supported AwbMode values.
Definition: control_ids.h:105
@ AwbDaylight
Daylight AWB lighting mode.
Definition: control_ids.h:111
@ AwbTungsten
Tungsten AWB lamp mode.
Definition: control_ids.h:108
@ AwbAuto
Search over the whole colour temperature range.
Definition: control_ids.h:106
@ AwbCustom
Custom AWB mode.
Definition: control_ids.h:113
@ AwbIndoor
Indoor AWB lighting mode.
Definition: control_ids.h:110
@ AwbFluorescent
Fluorescent AWB lamp mode.
Definition: control_ids.h:109
@ AwbIncandescent
Incandescent AWB lamp mode.
Definition: control_ids.h:107
@ AwbCloudy
Cloudy AWB lighting mode.
Definition: control_ids.h:112
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:1303
const Control< float > SensorTemperature
Temperature measure from the camera sensor in Celsius. This is typically obtained by a thermal sensor...
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 ...
AfRangeEnum
Supported AfRange values.
Definition: control_ids.h:138
@ AfRangeNormal
A wide range of focus distances is scanned, all the way from infinity down to close distances,...
Definition: control_ids.h:139
@ AfRangeMacro
Only close distances are scanned.
Definition: control_ids.h:140
@ AfRangeFull
The full range of focus distances is scanned just as with AfRangeNormal but this time including the v...
Definition: control_ids.h:141
const std::array< const ControlValue, 3 > AfRangeValues
List of all AfRange supported values.
const std::array< const ControlValue, 8 > AwbModeValues
List of all AwbMode supported values.
AeMeteringModeEnum
Supported AeMeteringMode values.
Definition: control_ids.h:74
@ MeteringCentreWeighted
Centre-weighted metering mode.
Definition: control_ids.h:75
@ MeteringMatrix
Matrix metering mode.
Definition: control_ids.h:77
@ MeteringCustom
Custom metering mode.
Definition: control_ids.h:78
@ MeteringSpot
Spot metering mode.
Definition: control_ids.h:76
AeExposureModeEnum
Supported AeExposureMode values.
Definition: control_ids.h:90
@ ExposureLong
Exposure mode allowing long exposure times.
Definition: control_ids.h:93
@ ExposureNormal
Default exposure mode.
Definition: control_ids.h:91
@ ExposureShort
Exposure mode allowing only short exposure times.
Definition: control_ids.h:92
@ ExposureCustom
Custom exposure mode.
Definition: control_ids.h:94
const std::array< const ControlValue, 3 > AfPauseStateValues
List of all AfPauseState supported values.
const Control< float > AnalogueGain
Analogue gain value applied in the sensor device. The value of the control specifies the gain multipl...
AfMeteringEnum
Supported AfMetering values.
Definition: control_ids.h:151
@ AfMeteringAuto
The AF algorithm should decide for itself where it will measure focus.
Definition: control_ids.h:152
@ AfMeteringWindows
The AF algorithm should use the rectangles defined by the AfWindows control to measure focus....
Definition: control_ids.h:153
AfSpeedEnum
Supported AfSpeed values.
Definition: control_ids.h:145
@ AfSpeedNormal
Move the lens at its usual speed.
Definition: control_ids.h:146
@ AfSpeedFast
Move the lens more quickly.
Definition: control_ids.h:147
AeConstraintModeEnum
Supported AeConstraintMode values.
Definition: control_ids.h:82
@ ConstraintHighlight
Highlight constraint mode. This mode adjusts the exposure levels in order to try and avoid over-expos...
Definition: control_ids.h:84
@ ConstraintCustom
Custom constraint mode.
Definition: control_ids.h:86
@ ConstraintShadows
Shadows constraint mode. This mode adjusts the exposure levels in order to try and avoid under-exposi...
Definition: control_ids.h:85
@ ConstraintNormal
Default constraint mode. This mode aims to balance the exposure of different parts of the image so as...
Definition: control_ids.h:83
const Control< Span< const float, 2 > > ColourGains
Pair of gain values for the Red and Blue colour channels, in that order. ColourGains can only be appl...
const Control< float > LensPosition
Acts as a control to instruct the lens to move to a particular position and also reports back the pos...
const Control< int32_t > AfTrigger
This control starts an autofocus scan when AfMode is set to AfModeAuto, and can also be used to termi...
const Control< int32_t > AfMetering
Instruct the AF algorithm how it should decide which parts of the image should be used to measure foc...
const Control< Span< const float, 9 > > 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....
AfPauseStateEnum
Supported AfPauseState values.
Definition: control_ids.h:180
@ AfPauseStatePausing
Continuous AF has been sent an AfPauseDeferred control, and will pause as soon as any in-progress sca...
Definition: control_ids.h:182
@ AfPauseStateRunning
Continuous AF is running and the algorithm may restart a scan spontaneously.
Definition: control_ids.h:181
@ AfPauseStatePaused
Continuous AF is paused. No further state changes or lens movements will occur until the AfPauseResum...
Definition: control_ids.h:183
const Control< Span< const Rectangle > > AfWindows
Sets the focus windows used by the AF algorithm when AfMetering is set to AfMeteringWindows....
const Control< bool > AwbLocked
Report the lock status of a running AWB algorithm.
const Control< int32_t > AfState
Reports the current state of the AF algorithm in conjunction with the reported AfMode value and (in c...
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