30 AE_CONSTRAINT_MODE = 4,
36 AE_FLICKER_PERIOD = 10,
37 AE_FLICKER_DETECTED = 11,
45 COLOUR_TEMPERATURE = 19,
47 SENSOR_BLACK_LEVELS = 21,
50 COLOUR_CORRECTION_MATRIX = 24,
54 FRAME_DURATION_LIMITS = 28,
55 SENSOR_TEMPERATURE = 29,
56 SENSOR_TIMESTAMP = 30,
70 DEBUG_METADATA_ENABLE = 44,
130 extern const std::array<const ControlValue, 8>
AwbModeValues;
152 extern const std::array<const ControlValue, 3>
AfModeValues;
160 extern const std::array<const ControlValue, 3>
AfRangeValues;
167 extern const std::array<const ControlValue, 2>
AfSpeedValues;
190 extern const std::array<const ControlValue, 3>
AfPauseValues;
200 extern const std::array<const ControlValue, 4>
AfStateValues;
218 extern const std::array<const ControlValue, 5>
HdrModeValues;
235 #define LIBCAMERA_HAS_DRAFT_VENDOR_CONTROLS 239 AE_PRECAPTURE_TRIGGER = 10001,
240 NOISE_REDUCTION_MODE = 10002,
241 COLOR_CORRECTION_ABERRATION_MODE = 10003,
244 SENSOR_ROLLING_SHUTTER_SKEW = 10006,
245 LENS_SHADING_MAP_MODE = 10007,
246 PIPELINE_DEPTH = 10008,
248 TEST_PATTERN_MODE = 10010,
249 FACE_DETECT_MODE = 10011,
250 FACE_DETECT_FACE_RECTANGLES = 10012,
251 FACE_DETECT_FACE_SCORES = 10013,
252 FACE_DETECT_FACE_LANDMARKS = 10014,
253 FACE_DETECT_FACE_IDS = 10015,
291 extern const std::array<const ControlValue, 6>
AeStateValues;
341 #define LIBCAMERA_HAS_DEBUG_VENDOR_CONTROLS Custom constraint mode.
Definition: control_ids.h:89
const std::array< const ControlValue, 6 > TestPatternModeValues
List of all TestPatternMode supported values.
Highlight constraint mode.
Definition: control_ids.h:87
Exposure mode allowing only short exposure times.
Definition: control_ids.h:96
Pipeline performs face detection and reports the FaceDetectFaceRectangles and FaceDetectFaceScores co...
Definition: control_ids.h:326
Default constraint mode.
Definition: control_ids.h:86
Multiple frames will be combined to produce "night mode" images.
Definition: control_ids.h:216
Noise reduction is applied at different levels to different streams.
Definition: control_ids.h:270
AeFlickerModeEnum
Supported AeFlickerMode values.
Definition: control_ids.h:106
const Control< float > Saturation
Specify a fixed saturation parameter.
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition: control_ids.h:197
const Control< int32_t > AeFlickerMode
Set the flicker avoidance mode for AGC/AEC.
Incandescent AWB lamp mode.
Definition: control_ids.h:122
const Control< float > AnalogueGain
Analogue gain value applied in the sensor device.
const std::map< std::string, int32_t > NoiseReductionModeNameValueMap
Map of all NoiseReductionMode supported value names (in std::string format) to value.
No noise reduction is applied.
Definition: control_ids.h:266
const Control< Span< const uint8_t > > FaceDetectFaceScores
Confidence score of each of the detected faces. The range of score is [0, 100]. The number of values ...
const Control< int32_t > AfMode
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 std::array< const ControlValue, 5 > HdrModeValues
List of all HdrMode supported values.
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 > HdrChannelValues
List of all HdrChannel supported values.
const Control< Span< const float, 2 > > ColourGains
Pair of gain values for the Red and Blue colour channels, in that order.
const Control< Span< const Rectangle > > AfWindows
The focus windows used by the AF algorithm when AfMetering is set to AfMeteringWindows.
The AF algorithm is in continuous mode.
Definition: control_ids.h:150
Multiple exposures will be generated and merged to create HDR images.
Definition: control_ids.h:214
Custom exposure mode.
Definition: control_ids.h:98
const std::map< std::string, int32_t > AeConstraintModeNameValueMap
Map of all AeConstraintMode supported value names (in std::string format) to value.
Move the lens more quickly.
Definition: control_ids.h:165
const std::array< const ControlValue, 5 > NoiseReductionModeValues
List of all NoiseReductionMode supported values.
AwbModeEnum
Supported AwbMode values.
Definition: control_ids.h:120
const Control< int32_t > AfPauseState
Report whether the autofocus is currently running, paused or pausing.
This is a long exposure image.
Definition: control_ids.h:225
AfSpeedEnum
Supported AfSpeed values.
Definition: control_ids.h:163
All pixel data is replaced with an 8-bar color pattern. The vertical bars (left-to-right) are as foll...
Definition: control_ids.h:316
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.
Definition: control_ids.h:149
const Control< int32_t > AeFlickerDetected
Flicker period detected in microseconds.
Continuous AF is paused.
Definition: control_ids.h:206
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:126
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:124
High quality noise reduction at the expense of frame rate.
Definition: control_ids.h:268
const Control< int32_t > ColourTemperature
Report the estimate of the colour temperature for the frame, in kelvin.
AePrecaptureTriggerEnum
Supported AePrecaptureTrigger values.
Definition: control_ids.h:257
Start an AF scan.
Definition: control_ids.h:179
Top-level libcamera namespace.
Definition: bound_method.h:15
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:319
Each pixel in [R, G_even, G_odd, B] is replaced by its respective color channel provided in test patt...
Definition: control_ids.h:315
Let the AF algorithm decide for itself where it will measure focus.
Definition: control_ids.h:171
const std::array< const ControlValue, 3 > FaceDetectModeValues
List of all FaceDetectMode supported values.
const Control< float > Lux
Report an estimate of the current illuminance level in lux.
The camera will cancel any active or completed metering sequence. The AE algorithm is reset to its in...
Definition: control_ids.h:260
Default exposure mode.
Definition: control_ids.h:95
The AF algorithm is in auto mode (AfModeAuto), and a scan has been started using the AfTrigger contro...
Definition: control_ids.h:196
AwbStateEnum
Supported AwbState values.
Definition: control_ids.h:294
Centre-weighted metering mode.
Definition: control_ids.h:77
Use the rectangles defined by the AfWindows control to measure focus.
Definition: control_ids.h:172
Custom AWB mode.
Definition: control_ids.h:128
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:76
The AWB algorithm has converged.
Definition: control_ids.h:297
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.
Minimal noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:269
const std::map< std::string, int32_t > AfTriggerNameValueMap
Map of all AfTrigger supported value names (in std::string format) to value.
The AE algorithm is inactive.
Definition: control_ids.h:284
const std::array< const ControlValue, 8 > AwbModeValues
List of all AwbMode supported values.
Spot metering mode.
Definition: control_ids.h:78
AeExposureModeEnum
Supported AeExposureMode values.
Definition: control_ids.h:94
Describe a control and its intrinsic properties.
Definition: controls.h:283
const Control< Span< const Point > > FaceDetectFaceLandmarks
Array of human face landmark coordinates in format [..., left_eye_i, right_eye_i, mouth_i...
HDR is disabled.
Definition: control_ids.h:212
The AE algorithm is locked.
Definition: control_ids.h:287
const Control< int32_t > AePrecaptureTrigger
Control for AE metering trigger. Currently identical to ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER.
const Control< int32_t > AfState
The current state of the AF algorithm.
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.
Pipeline doesn't perform face detection and doesn't report any control related to face detection...
Definition: control_ids.h:325
const std::map< std::string, int32_t > AePrecaptureTriggerNameValueMap
Map of all AePrecaptureTrigger supported value names (in std::string format) to value.
const Control< int32_t > AwbMode
Specify the range of illuminants to use for the AWB algorithm.
const Control< int32_t > AfRange
The range of focus distances that is scanned.
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:318
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:164
const Control< int32_t > AfTrigger
Start an autofocus scan.
Pause the continuous autofocus algorithm immediately.
Definition: control_ids.h:186
const Control< bool > DebugMetadataEnable
Enable or disable the debug metadata.
const std::map< std::string, int32_t > AwbStateNameValueMap
Map of all AwbState supported value names (in std::string format) to value.
const Control< Span< const float, 9 > > ColourCorrectionMatrix
The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline.
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.
const std::map< std::string, int32_t > ColorCorrectionAberrationModeNameValueMap
Map of all ColorCorrectionAberrationMode supported value names (in std::string format) to value...
const std::map< std::string, int32_t > AfStateNameValueMap
Map of all AfState supported value names (in std::string format) to value.
const std::array< const ControlValue, 4 > AwbStateValues
List of all AwbState supported values.
const std::map< std::string, int32_t > HdrChannelNameValueMap
Map of all HdrChannel supported value names (in std::string format) to value.
const std::array< const ControlValue, 3 > ColorCorrectionAberrationModeValues
List of all ColorCorrectionAberrationMode supported values.
const Control< Span< const int32_t, 4 > > SensorBlackLevels
Reports the sensor black levels used for processing a frame.
Continuous AF is running and the algorithm may restart a scan spontaneously.
Definition: control_ids.h:204
Continuous AF has been sent an AfPauseDeferred control, and will pause as soon as any in-progress sca...
Definition: control_ids.h:205
Noise reduction is applied without reducing the frame rate.
Definition: control_ids.h:267
Shadows constraint mode.
Definition: control_ids.h:88
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:258
Pause the continuous autofocus algorithm at the end of the scan.
Definition: control_ids.h:187
const Control< int32_t > AfMetering
The parts of the image used by the AF algorithm to measure focus.
const Control< float > Sharpness
Intensity of the sharpening applied to the image.
Cloudy AWB lighting mode.
Definition: control_ids.h:127
Pipeline performs face detection and reports all the controls related to face detection including Fac...
Definition: control_ids.h:327
The AE algorithm has converged.
Definition: control_ids.h:286
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.
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:195
Indoor AWB lighting mode.
Definition: control_ids.h:125
Cancel an AF scan.
Definition: control_ids.h:180
The pre-capture AE metering is started by the camera.
Definition: control_ids.h:259
No test pattern mode is used. The camera device returns frames from the image sensor.
Definition: control_ids.h:314
Resume continuous autofocus operation.
Definition: control_ids.h:188
const Control< int32_t > AfSpeed
Determine whether the AF is to move the lens as quickly as possible or more steadily.
NoiseReductionModeEnum
Supported NoiseReductionMode values.
Definition: control_ids.h:265
const Control< float > ExposureValue
Specify an Exposure Value (EV) parameter.
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.
AfPauseEnum
Supported AfPause values.
Definition: control_ids.h:185
The AE algorithm has started a pre-capture metering session.
Definition: control_ids.h:289
const Control< float > Gamma
Specify a fixed gamma value.
HdrChannelEnum
Supported HdrChannel values.
Definition: control_ids.h:221
const std::map< std::string, int32_t > AfModeNameValueMap
Map of all AfMode supported value names (in std::string format) to value.
const std::map< std::string, int32_t > HdrModeNameValueMap
Map of all HdrMode supported value names (in std::string format) to value.
const std::map< std::string, int32_t > AeExposureModeNameValueMap
Map of all AeExposureMode supported value names (in std::string format) to value. ...
The AWB algorithm is inactive.
Definition: control_ids.h:295
AfPauseStateEnum
Supported AfPauseState values.
Definition: control_ids.h:203
const Control< Span< const int32_t > > FaceDetectFaceIds
Each detected face is given a unique ID that is valid for as long as the face is visible to the camer...
const Control< int32_t > AfPause
Pause lens movements when in continuous autofocus mode.
const std::array< const ControlValue, 4 > AeConstraintModeValues
List of all AeConstraintMode supported values.
const std::map< std::string, int32_t > AeMeteringModeNameValueMap
Map of all AeMeteringMode supported value names (in std::string format) to value. ...
This is a medium exposure image.
Definition: control_ids.h:224
const std::map< std::string, int32_t > AfSpeedNameValueMap
Map of all AfSpeed supported value names (in std::string format) to value.
const Control< bool > AwbEnable
Enable or disable the AWB.
High quality aberration correction which might reduce the frame rate.
Definition: control_ids.h:278
TestPatternModeEnum
Supported TestPatternMode values.
Definition: control_ids.h:313
const std::map< std::string, int32_t > LensShadingMapModeNameValueMap
Map of all LensShadingMapMode supported value names (in std::string format) to value.
const Control< float > Brightness
Specify a fixed brightness parameter.
const Control< int32_t > HdrMode
Set the mode to be used for High Dynamic Range (HDR) imaging.
Search over the whole colour temperature range.
Definition: control_ids.h:121
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:283
The AE algorithm would need a flash for good results.
Definition: control_ids.h:288
const std::map< std::string, int32_t > AwbModeNameValueMap
Map of all AwbMode supported value names (in std::string format) to value.
AfMeteringEnum
Supported AfMetering values.
Definition: control_ids.h:170
const std::array< const ControlValue, 3 > AeFlickerModeValues
List of all AeFlickerMode supported values.
const Control< int32_t > HdrChannel
The HDR channel used to capture the frame.
LensShadingMapModeEnum
Supported LensShadingMapMode values.
Definition: control_ids.h:304
No flicker avoidance is performed.
Definition: control_ids.h:107
FaceDetectModeEnum
Supported FaceDetectMode values.
Definition: control_ids.h:324
const std::array< const ControlValue, 4 > AfStateValues
List of all AfState supported values.
AfTriggerEnum
Supported AfTrigger values.
Definition: control_ids.h:178
Multiple frames all at a single exposure will be used to create HDR images.
Definition: control_ids.h:215
Matrix metering mode.
Definition: control_ids.h:79
Tungsten AWB lamp mode.
Definition: control_ids.h:123
const std::map< std::string, int32_t > FaceDetectModeNameValueMap
Map of all FaceDetectMode supported value names (in std::string format) to value. ...
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::map< std::string, int32_t > AfPauseNameValueMap
Map of all AfPause supported value names (in std::string format) to value.
No aberration correction is applied.
Definition: control_ids.h:276
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:1952
const Control< Span< const Rectangle > > FaceDetectFaceRectangles
Boundary rectangles of the detected faces. The number of values is the number of detected faces...
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:317
This is a short exposure image.
Definition: control_ids.h:223
AfModeEnum
Supported AfMode values.
Definition: control_ids.h:147
const Control< int32_t > AeExposureMode
Specify an exposure mode for the AE algorithm to use.
The AWB algorithm has not converged yet.
Definition: control_ids.h:296
Framework to manage controls related to an object.
const std::map< std::string, int32_t > AeFlickerModeNameValueMap
Map of all AeFlickerMode supported value names (in std::string format) to value.
This image does not correspond to any of the captures used to create an HDR image.
Definition: control_ids.h:222
Manual flicker avoidance.
Definition: control_ids.h:108
const Control< int32_t > AeFlickerPeriod
Manual flicker period in microseconds.
The full range of focus distances is scanned.
Definition: control_ids.h:158
The lens shading map mode is available.
Definition: control_ids.h:306
const Control< float > Contrast
Specify a fixed contrast parameter.
Automatic flicker period detection and avoidance.
Definition: control_ids.h:109
const std::map< std::string, int32_t > TestPatternModeNameValueMap
Map of all TestPatternMode supported value names (in std::string format) to value.
const std::map< std::string, int32_t > AfPauseStateNameValueMap
Map of all AfPauseState supported value names (in std::string format) to value.
const std::map< std::string, int32_t > AeStateNameValueMap
Map of all AeState supported value names (in std::string format) to value.
const Control< float > LensPosition
Set and report the focus lens position.
AeConstraintModeEnum
Supported AeConstraintMode values.
Definition: control_ids.h:85
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:334
ColorCorrectionAberrationModeEnum
Supported ColorCorrectionAberrationMode values.
Definition: control_ids.h:275
No lens shading map mode is available.
Definition: control_ids.h:305
Multiple exposures will be generated in an alternating fashion.
Definition: control_ids.h:213
HdrModeEnum
Supported HdrMode values.
Definition: control_ids.h:211
Exposure mode allowing long exposure times.
Definition: control_ids.h:97
const Control< int32_t > FocusFoM
Reports a Figure of Merit (FoM) to indicate how in-focus the frame is.
A wide range of focus distances is scanned.
Definition: control_ids.h:156
Custom metering mode.
Definition: control_ids.h:80
const Control< int32_t > FaceDetectMode
Control to select the face detection mode used by the pipeline.
The AF algorithm is in manual mode.
Definition: control_ids.h:148
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition: control_ids.h:198
Only close distances are scanned.
Definition: control_ids.h:157
AfStateEnum
Supported AfState values.
Definition: control_ids.h:194
const std::map< std::string, int32_t > AfRangeNameValueMap
Map of all AfRange supported value names (in std::string format) to value.
The AE algorithm has not converged yet.
Definition: control_ids.h:285
const std::map< std::string, int32_t > AfMeteringNameValueMap
Map of all AfMetering supported value names (in std::string format) to value.
AfRangeEnum
Supported AfRange values.
Definition: control_ids.h:155
Aberration correction will not slow down the frame rate.
Definition: control_ids.h:277
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.
const Control< Rectangle > ScalerCrop
Sets the image portion that will be scaled to form the whole of the final output image.