25 AE_CONSTRAINT_MODE = 4,
37 COLOUR_TEMPERATURE = 16,
39 SENSOR_BLACK_LEVELS = 18,
42 COLOUR_CORRECTION_MATRIX = 21,
46 FRAME_DURATION_LIMITS = 25,
47 SENSOR_TEMPERATURE = 26,
48 SENSOR_TIMESTAMP = 27,
59 AE_PRECAPTURE_TRIGGER = 38,
60 NOISE_REDUCTION_MODE = 39,
61 COLOR_CORRECTION_ABERRATION_MODE = 40,
64 SENSOR_ROLLING_SHUTTER_SKEW = 43,
65 LENS_SHADING_MAP_MODE = 44,
69 TEST_PATTERN_MODE = 48,
115 extern const std::array<const ControlValue, 8>
AwbModeValues;
136 extern const std::array<const ControlValue, 3>
AfModeValues;
143 extern const std::array<const ControlValue, 3>
AfRangeValues;
149 extern const std::array<const ControlValue, 2>
AfSpeedValues;
169 extern const std::array<const ControlValue, 3>
AfPauseValues;
178 extern const std::array<const ControlValue, 4>
AfStateValues;
223 extern const std::array<const ControlValue, 6>
AeStateValues;
Custom constraint mode.
Definition: control_ids.h:86
const std::array< const ControlValue, 6 > TestPatternModeValues
List of all TestPatternMode supported values.
Highlight constraint mode. This mode adjusts the exposure levels in order to try and avoid over-expos...
Definition: control_ids.h:84
Exposure mode allowing only short exposure times.
Definition: control_ids.h:92
Default constraint mode. This mode aims to balance the exposure of different parts of the image so as...
Definition: control_ids.h:83
Noise reduction is applied at different levels to different streams.
Definition: control_ids.h:204
const Control< float > Saturation
Specify a fixed saturation parameter. Normal saturation is given by the value 1.0; larger values prod...
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition: control_ids.h:175
Incandescent AWB lamp mode.
Definition: control_ids.h:107
const Control< float > AnalogueGain
Analogue gain value applied in the sensor device. The value of the control specifies the gain multipl...
No noise reduction is applied.
Definition: control_ids.h:200
const Control< int32_t > AfMode
Control to set the mode of the AF (autofocus) algorithm.
const Control< int32_t > NoiseReductionMode
Control to select the noise reduction algorithm mode. Currently identical to ANDROID_NOISE_REDUCTION_...
const Control< Span< const int64_t > > FrameDurationLimits
The minimum and maximum (in that order) frame duration, expressed in microseconds.
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 Rectangle > > AfWindows
Sets the focus windows used by the AF algorithm when AfMetering is set to AfMeteringWindows. The units used are pixels within the rectangle returned by the ScalerCropMaximum property.
The AF algorithm is in continuous mode. This means that the lens can re-start a scan spontaneously at...
Definition: control_ids.h:134
Custom exposure mode.
Definition: control_ids.h:94
50Hz flickering detected.
Definition: control_ids.h:242
Move the lens more quickly.
Definition: control_ids.h:147
const std::array< const ControlValue, 5 > NoiseReductionModeValues
List of all NoiseReductionMode supported values.
AwbModeEnum
Supported AwbMode values.
Definition: control_ids.h:105
const Control< int32_t > AfPauseState
Only applicable in continuous (AfModeContinuous) mode, this reports whether the algorithm is currentl...
AfSpeedEnum
Supported AfSpeed values.
Definition: control_ids.h:145
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, 3 > AfModeValues
List of all AfMode supported values.
const Control< bool > AeEnable
Enable or disable the AE.
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
Continuous AF is paused. No further state changes or lens movements will occur until the AfPauseResum...
Definition: control_ids.h:183
const Control< int32_t > ColorCorrectionAberrationMode
Control to select the color correction aberration mode. Currently identical to ANDROID_COLOR_CORRECTI...
Daylight AWB lighting mode.
Definition: control_ids.h:111
const Control< int32_t > PipelineDepth
Specifies the number of pipeline stages the frame went through from when it was exposed to when the f...
Fluorescent AWB lamp mode.
Definition: control_ids.h:109
60Hz flickering detected.
Definition: control_ids.h:243
High quality noise reduction at the expense of frame rate.
Definition: control_ids.h:202
const Control< int32_t > ColourTemperature
Report the current estimate of the colour temperature, in kelvin, for this frame. The ColourTemperatu...
AePrecaptureTriggerEnum
Supported AePrecaptureTrigger values.
Definition: control_ids.h:192
Start an AF scan. Ignored if a scan is in progress.
Definition: control_ids.h:159
Top-level libcamera namespace.
Definition: backtrace.h:17
const std::array< const ControlValue, 2 > AfTriggerValues
List of all AfTrigger supported values.
The first custom test pattern. All custom patterns that are available only on this camera device are ...
Definition: control_ids.h:255
No flickering detected.
Definition: control_ids.h:241
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
The AF algorithm should decide for itself where it will measure focus.
Definition: control_ids.h:152
const Control< float > Lux
Report an estimate of the current illuminance level in lux. The Lux control can only be returned in m...
The camera will cancel any active or completed metering sequence. The AE algorithm is reset to its in...
Definition: control_ids.h:195
Default exposure mode.
Definition: control_ids.h:91
The AF algorithm is in auto mode (AfModeAuto), and a scan has been started using the AfTrigger contro...
Definition: control_ids.h:174
AwbStateEnum
Supported AwbState values.
Definition: control_ids.h:225
Centre-weighted metering mode.
Definition: control_ids.h:75
The AF algorithm should use the rectangles defined by the AfWindows control to measure focus...
Definition: control_ids.h:153
const std::array< const ControlValue, 3 > SceneFlickerValues
List of all SceneFlicker supported values.
Custom AWB mode.
Definition: control_ids.h:113
const Control< float > DigitalGain
Digital gain value applied during the processing steps applied to the image as captured from the sens...
AeMeteringModeEnum
Supported AeMeteringMode values.
Definition: control_ids.h:74
The AWB algorithm has converged.
Definition: control_ids.h:228
const Control< bool > AwbLocked
Report the lock status of a running AWB algorithm.
const Control< float > SensorTemperature
Temperature measure from the camera sensor in Celsius. This is typically obtained by a thermal sensor...
Minimal noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:203
The AE algorithm is inactive.
Definition: control_ids.h:216
const std::array< const ControlValue, 8 > AwbModeValues
List of all AwbMode supported values.
Spot metering mode.
Definition: control_ids.h:76
AeExposureModeEnum
Supported AeExposureMode values.
Definition: control_ids.h:90
Describe a control and its intrinsic properties.
Definition: controls.h:253
The AE algorithm is locked.
Definition: control_ids.h:219
const Control< int32_t > AePrecaptureTrigger
Control for AE metering trigger. Currently identical to ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER.
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< 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 > AePrecaptureTriggerValues
List of all AePrecaptureTrigger supported values.
const Control< int32_t > AwbMode
Specify the range of illuminants to use for the AWB algorithm. The modes supported are platform speci...
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 > TestPatternMode
Control to select the test pattern mode. Currently identical to ANDROID_SENSOR_TEST_PATTERN_MODE.
All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typical...
Definition: control_ids.h:254
const Control< int32_t > LensShadingMapMode
Control to report if the lens shading map is available. Currently identical to ANDROID_STATISTICS_LEN...
Move the lens at its usual speed.
Definition: control_ids.h:146
const Control< int32_t > AfTrigger
This control starts an autofocus scan when AfMode is set to AfModeAuto, and can also be used to termi...
Pause the continuous autofocus algorithm immediately, whether or not any kind of scan is underway...
Definition: control_ids.h:165
const Control< Span< const float > > ColourCorrectionMatrix
The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline. This should describe the...
const std::array< const ControlValue, 6 > AeStateValues
List of all AeState supported values.
const Control< int32_t > AeConstraintMode
Specify a constraint mode for the AE algorithm to use. These determine how the measured scene brightn...
const std::array< const ControlValue, 4 > AwbStateValues
List of all AwbState supported values.
const std::array< const ControlValue, 3 > ColorCorrectionAberrationModeValues
List of all ColorCorrectionAberrationMode supported values.
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.
Continuous AF is running and the algorithm may restart a scan spontaneously.
Definition: control_ids.h:181
Continuous AF has been sent an AfPauseDeferred control, and will pause as soon as any in-progress sca...
Definition: control_ids.h:182
Noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:201
Shadows constraint mode. This mode adjusts the exposure levels in order to try and avoid under-exposi...
Definition: control_ids.h:85
const Control< int32_t > AwbState
Control to report the current AWB algorithm state. Currently identical to ANDROID_CONTROL_AWB_STATE.
const Control< int32_t > AeState
Control to report the current AE algorithm state. Currently identical to ANDROID_CONTROL_AE_STATE.
The trigger is idle.
Definition: control_ids.h:193
This is similar to AfPauseImmediate, and if the AfState is currently reporting AfStateFocused or AfSt...
Definition: control_ids.h:166
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< float > Sharpness
A value of 0.0 means no sharpening. The minimum value means minimal sharpening, and shall be 0...
Cloudy AWB lighting mode.
Definition: control_ids.h:112
The AE algorithm has converged.
Definition: control_ids.h:218
const std::array< const ControlValue, 4 > AeMeteringModeValues
List of all AeMeteringMode supported values.
const Control< int32_t > ExposureTime
Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in ...
const std::array< const ControlValue, 4 > AeExposureModeValues
List of all AeExposureMode supported values.
The AF algorithm is in manual mode (AfModeManual) or in auto mode (AfModeAuto) and a scan has not yet...
Definition: control_ids.h:173
Indoor AWB lighting mode.
Definition: control_ids.h:110
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
The pre-capture AE metering is started by the camera.
Definition: control_ids.h:194
No test pattern mode is used. The camera device returns frames from the image sensor.
Definition: control_ids.h:250
Resume continuous autofocus operation. The algorithm starts again from exactly where it left off...
Definition: control_ids.h:167
const Control< int32_t > AfSpeed
Control that determines whether the AF algorithm is to move the lens as quickly as possible or more s...
NoiseReductionModeEnum
Supported NoiseReductionMode values.
Definition: control_ids.h:199
const Control< float > ExposureValue
Specify an Exposure Value (EV) parameter. The EV parameter will only be applied if the AE algorithm i...
const std::array< const ControlValue, 3 > AfPauseStateValues
List of all AfPauseState supported values.
const Control< int32_t > AeMeteringMode
Specify a metering mode for the AE algorithm to use. The metering modes determine which parts of the ...
AfPauseEnum
Supported AfPause values.
Definition: control_ids.h:164
The AE algorithm has started a pre-capture metering session.
Definition: control_ids.h:221
SceneFlickerEnum
Supported SceneFlicker values.
Definition: control_ids.h:240
The AWB algorithm is inactive.
Definition: control_ids.h:226
AfPauseStateEnum
Supported AfPauseState values.
Definition: control_ids.h:180
const Control< int32_t > AfPause
This control has no effect except when in continuous autofocus mode (AfModeContinuous). It can be used to pause any lens movements while (for example) images are captured. The algorithm remains inactive until it is instructed to resume.
const std::array< const ControlValue, 4 > AeConstraintModeValues
List of all AeConstraintMode supported values.
const Control< bool > AwbEnable
Enable or disable the AWB.
High quality aberration correction which might reduce the frame rate.
Definition: control_ids.h:211
TestPatternModeEnum
Supported TestPatternMode values.
Definition: control_ids.h:249
const Control< float > Brightness
Specify a fixed brightness parameter. Positive values (up to 1.0) produce brighter images; negative v...
Search over the whole colour temperature range.
Definition: control_ids.h:106
const std::array< const ControlValue, 2 > AfMeteringValues
List of all AfMetering supported values.
const std::array< const ControlValue, 3 > AfRangeValues
List of all AfRange supported values.
AeStateEnum
Supported AeState values.
Definition: control_ids.h:215
The AE algorithm would need a flash for good results.
Definition: control_ids.h:220
AfMeteringEnum
Supported AfMetering values.
Definition: control_ids.h:151
LensShadingMapModeEnum
Supported LensShadingMapMode values.
Definition: control_ids.h:234
const std::array< const ControlValue, 4 > AfStateValues
List of all AfState supported values.
AfTriggerEnum
Supported AfTrigger values.
Definition: control_ids.h:158
Matrix metering mode.
Definition: control_ids.h:77
Tungsten AWB lamp mode.
Definition: control_ids.h:108
const Control< int32_t > MaxLatency
The maximum number of frames that can occur after a request (different than the previous) has been su...
No aberration correction is applied.
Definition: control_ids.h:209
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:1301
const std::array< const ControlValue, 2 > AfSpeedValues
List of all AfSpeed supported values.
const std::array< const ControlValue, 3 > AfPauseValues
List of all AfPause supported values.
The test pattern is similar to TestPatternModeColorBars, except that each bar should start at its spe...
Definition: control_ids.h:253
AfModeEnum
Supported AfMode values.
Definition: control_ids.h:131
const Control< int32_t > AeExposureMode
Specify an exposure mode for the AE algorithm to use. These specify how the desired total exposure is...
The AWB algorithm has not converged yet.
Definition: control_ids.h:227
Framework to manage controls related to an object.
const Control< int32_t > SceneFlicker
Control to report the detected scene light frequency. Currently identical to ANDROID_STATISTICS_SCENE...
The full range of focus distances is scanned just as with AfRangeNormal but this time including the v...
Definition: control_ids.h:141
The lens shading map mode is available.
Definition: control_ids.h:236
const Control< float > Contrast
Specify a fixed contrast parameter. Normal contrast is given by the value 1.0; larger values produce ...
const Control< float > LensPosition
Acts as a control to instruct the lens to move to a particular position and also reports back the pos...
AeConstraintModeEnum
Supported AeConstraintMode values.
Definition: control_ids.h:82
const Control< int64_t > SensorTimestamp
The time when the first row of the image sensor active array is exposed.
std::unordered_map< unsigned int, const ControlId * > ControlIdMap
A map of numerical control ID to ControlId.
Definition: controls.h:302
ColorCorrectionAberrationModeEnum
Supported ColorCorrectionAberrationMode values.
Definition: control_ids.h:208
No lens shading map mode is available.
Definition: control_ids.h:235
Exposure mode allowing long exposure times.
Definition: control_ids.h:93
const Control< int32_t > FocusFoM
Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. A larger FocusFoM value indica...
A wide range of focus distances is scanned, all the way from infinity down to close distances...
Definition: control_ids.h:139
Custom metering mode.
Definition: control_ids.h:78
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
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition: control_ids.h:176
Only close distances are scanned.
Definition: control_ids.h:140
AfStateEnum
Supported AfState values.
Definition: control_ids.h:172
The AE algorithm has not converged yet.
Definition: control_ids.h:217
AfRangeEnum
Supported AfRange values.
Definition: control_ids.h:138
Aberration correction will not slow down the frame rate.
Definition: control_ids.h:210
const std::array< const ControlValue, 2 > LensShadingMapModeValues
List of all LensShadingMapMode supported values.
const Control< int64_t > FrameDuration
The instantaneous frame duration from start of frame exposure to start of next exposure, expressed in microseconds. This control is meant to be returned in metadata.
const Control< Rectangle > ScalerCrop
Sets the image portion that will be scaled to form the whole of the final output image. The (x,y) location of this rectangle is relative to the PixelArrayActiveAreas that is being used. The units remain native sensor pixels, even if the sensor is being used in a binning or skipping mode.