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,
152extern const std::array<const ControlValue, 3>
AfModeValues;
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,
341#define LIBCAMERA_HAS_DEBUG_VENDOR_CONTROLS
Describe a control and its intrinsic properties.
Definition controls.h:313
Framework to manage controls related to an object.
Namespace for debug controls.
Definition control_ids.h:339
Namespace for draft controls.
Definition control_ids.h:233
const Control< int32_t > NoiseReductionMode
Control to select the noise reduction algorithm mode. Currently identical to ANDROID_NOISE_REDUCTION_...
const Control< int32_t > TestPatternMode
Control to select the test pattern mode. Currently identical to ANDROID_SENSOR_TEST_PATTERN_MODE.
const std::array< const ControlValue, 4 > AwbStateValues
List of all AwbState supported values.
const std::map< std::string, int32_t > LensShadingMapModeNameValueMap
Map of all LensShadingMapMode supported value names (in std::string format) to value.
AeStateEnum
Supported AeState values.
Definition control_ids.h:283
@ AeStateLocked
The AE algorithm is locked.
Definition control_ids.h:287
@ AeStateInactive
The AE algorithm is inactive.
Definition control_ids.h:284
@ AeStateFlashRequired
The AE algorithm would need a flash for good results.
Definition control_ids.h:288
@ AeStateSearching
The AE algorithm has not converged yet.
Definition control_ids.h:285
@ AeStatePrecapture
The AE algorithm has started a pre-capture metering session.
Definition control_ids.h:289
@ AeStateConverged
The AE algorithm has converged.
Definition control_ids.h:286
NoiseReductionModeEnum
Supported NoiseReductionMode values.
Definition control_ids.h:265
@ NoiseReductionModeHighQuality
High quality noise reduction at the expense of frame rate.
Definition control_ids.h:268
@ NoiseReductionModeMinimal
Minimal noise reduction is applied without reducing the frame rate.
Definition control_ids.h:269
@ NoiseReductionModeOff
No noise reduction is applied.
Definition control_ids.h:266
@ NoiseReductionModeZSL
Noise reduction is applied at different levels to different streams.
Definition control_ids.h:270
@ NoiseReductionModeFast
Noise reduction is applied without reducing the frame rate.
Definition control_ids.h:267
AwbStateEnum
Supported AwbState values.
Definition control_ids.h:294
@ AwbConverged
The AWB algorithm has converged.
Definition control_ids.h:297
@ AwbStateSearching
The AWB algorithm has not converged yet.
Definition control_ids.h:296
@ AwbStateInactive
The AWB algorithm is inactive.
Definition control_ids.h:295
@ AwbLocked
The AWB algorithm is locked.
Definition control_ids.h:298
const Control< Span< const Point > > FaceDetectFaceLandmarks
Array of human face landmark coordinates in format [..., left_eye_i, right_eye_i, mouth_i,...
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 > AePrecaptureTriggerValues
List of all AePrecaptureTrigger supported values.
const Control< Span< const Rectangle > > FaceDetectFaceRectangles
Boundary rectangles of the detected faces. The number of values is the number of detected faces.
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 > ColorCorrectionAberrationMode
Control to select the color correction aberration mode. Currently identical to ANDROID_COLOR_CORRECTI...
const Control< int32_t > FaceDetectMode
Control to select the face detection mode used by the pipeline.
const std::map< std::string, int32_t > AeStateNameValueMap
Map of all AeState supported value names (in std::string format) to value.
const std::array< const ControlValue, 6 > TestPatternModeValues
List of all TestPatternMode supported values.
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::array< const ControlValue, 3 > ColorCorrectionAberrationModeValues
List of all ColorCorrectionAberrationMode supported values.
const Control< int32_t > PipelineDepth
Specifies the number of pipeline stages the frame went through from when it was exposed to when the f...
LensShadingMapModeEnum
Supported LensShadingMapMode values.
Definition control_ids.h:304
@ LensShadingMapModeOn
The lens shading map mode is available.
Definition control_ids.h:306
@ LensShadingMapModeOff
No lens shading map mode is available.
Definition control_ids.h:305
const std::array< const ControlValue, 5 > NoiseReductionModeValues
List of all NoiseReductionMode supported values.
const std::array< const ControlValue, 6 > AeStateValues
List of all AeState supported values.
const std::map< std::string, int32_t > ColorCorrectionAberrationModeNameValueMap
Map of all ColorCorrectionAberrationMode supported value names (in std::string format) to value.
TestPatternModeEnum
Supported TestPatternMode values.
Definition control_ids.h:313
@ 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:315
@ TestPatternModeCustom1
The first custom test pattern. All custom patterns that are available only on this camera device are ...
Definition control_ids.h:319
@ TestPatternModeOff
No test pattern mode is used. The camera device returns frames from the image sensor.
Definition control_ids.h:314
@ TestPatternModeColorBarsFadeToGray
The test pattern is similar to TestPatternModeColorBars, except that each bar should start at its spe...
Definition control_ids.h:317
@ TestPatternModePn9
All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typical...
Definition control_ids.h:318
@ 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:316
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< 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...
FaceDetectModeEnum
Supported FaceDetectMode values.
Definition control_ids.h:324
@ FaceDetectModeSimple
Pipeline performs face detection and reports the FaceDetectFaceRectangles and FaceDetectFaceScores co...
Definition control_ids.h:326
@ FaceDetectModeFull
Pipeline performs face detection and reports all the controls related to face detection including Fac...
Definition control_ids.h:327
@ FaceDetectModeOff
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 > NoiseReductionModeNameValueMap
Map of all NoiseReductionMode supported value names (in std::string format) to value.
const std::map< std::string, int32_t > AwbStateNameValueMap
Map of all AwbState supported value names (in std::string format) to value.
const Control< int32_t > AePrecaptureTrigger
Control for AE metering trigger. Currently identical to ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER.
const std::map< std::string, int32_t > TestPatternModeNameValueMap
Map of all TestPatternMode supported value names (in std::string format) to value.
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...
ColorCorrectionAberrationModeEnum
Supported ColorCorrectionAberrationMode values.
Definition control_ids.h:275
@ ColorCorrectionAberrationOff
No aberration correction is applied.
Definition control_ids.h:276
@ ColorCorrectionAberrationFast
Aberration correction will not slow down the frame rate.
Definition control_ids.h:277
@ ColorCorrectionAberrationHighQuality
High quality aberration correction which might reduce the frame rate.
Definition control_ids.h:278
const Control< int32_t > AeState
Control to report the current AE algorithm state. Currently identical to ANDROID_CONTROL_AE_STATE.
const std::map< std::string, int32_t > AePrecaptureTriggerNameValueMap
Map of all AePrecaptureTrigger supported value names (in std::string format) to value.
const std::array< const ControlValue, 2 > LensShadingMapModeValues
List of all LensShadingMapMode supported values.
const std::array< const ControlValue, 3 > FaceDetectModeValues
List of all FaceDetectMode supported values.
AePrecaptureTriggerEnum
Supported AePrecaptureTrigger values.
Definition control_ids.h:257
@ AePrecaptureTriggerIdle
The trigger is idle.
Definition control_ids.h:258
@ AePrecaptureTriggerStart
The pre-capture AE metering is started by the camera.
Definition control_ids.h:259
@ AePrecaptureTriggerCancel
The camera will cancel any active or completed metering sequence. The AE algorithm is reset to its in...
Definition control_ids.h:260
const Control< int32_t > AfRange
The range of focus distances that is scanned.
const Control< int32_t > AfState
The current state of the AF algorithm.
const Control< float > AnalogueGain
Analogue gain value applied in the sensor device.
const std::array< const ControlValue, 3 > AfRangeValues
List of all AfRange supported values.
const Control< float > Saturation
Specify a fixed saturation parameter.
const std::array< const ControlValue, 2 > AfSpeedValues
List of all AfSpeed supported values.
const Control< int32_t > ExposureTime
Exposure time for the frame applied in the sensor device.
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 > HdrChannel
The HDR channel used to capture the frame.
AfModeEnum
Supported AfMode values.
Definition control_ids.h:147
@ AfModeAuto
The AF algorithm is in auto mode.
Definition control_ids.h:149
@ AfModeContinuous
The AF algorithm is in continuous mode.
Definition control_ids.h:150
@ AfModeManual
The AF algorithm is in manual mode.
Definition control_ids.h:148
AfPauseEnum
Supported AfPause values.
Definition control_ids.h:185
@ AfPauseImmediate
Pause the continuous autofocus algorithm immediately.
Definition control_ids.h:186
@ AfPauseResume
Resume continuous autofocus operation.
Definition control_ids.h:188
@ AfPauseDeferred
Pause the continuous autofocus algorithm at the end of the scan.
Definition control_ids.h:187
const Control< Span< const Rectangle > > AfWindows
The focus windows used by the AF algorithm when AfMetering is set to AfMeteringWindows.
const std::array< const ControlValue, 3 > AeFlickerModeValues
List of all AeFlickerMode supported values.
const std::array< const ControlValue, 2 > AfTriggerValues
List of all AfTrigger supported values.
const std::array< const ControlValue, 3 > AfModeValues
List of all AfMode supported values.
const std::array< const ControlValue, 4 > AeMeteringModeValues
List of all AeMeteringMode supported values.
const std::array< const ControlValue, 3 > AfPauseValues
List of all AfPause supported values.
const Control< bool > AwbEnable
Enable or disable the AWB.
AfTriggerEnum
Supported AfTrigger values.
Definition control_ids.h:178
@ AfTriggerCancel
Cancel an AF scan.
Definition control_ids.h:180
@ AfTriggerStart
Start an AF scan.
Definition control_ids.h:179
const std::map< std::string, int32_t > AfMeteringNameValueMap
Map of all AfMetering 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< float > ExposureValue
Specify an Exposure Value (EV) parameter.
const Control< int32_t > AfPause
Pause lens movements when in continuous autofocus mode.
const Control< float > LensPosition
Set and report the focus lens position.
AfStateEnum
Supported AfState values.
Definition control_ids.h:194
@ AfStateScanning
The AF algorithm is in auto mode (AfModeAuto), and a scan has been started using the AfTrigger contro...
Definition control_ids.h:196
@ AfStateIdle
The AF algorithm is in manual mode (AfModeManual) or in auto mode (AfModeAuto) and a scan has not yet...
Definition control_ids.h:195
@ AfStateFailed
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition control_ids.h:198
@ AfStateFocused
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition control_ids.h:197
const std::array< const ControlValue, 4 > AfStateValues
List of all AfState supported values.
const std::array< const ControlValue, 4 > AeExposureModeValues
List of all AeExposureMode supported values.
const std::array< const ControlValue, 2 > AfMeteringValues
List of all AfMetering supported values.
const std::map< std::string, int32_t > AeMeteringModeNameValueMap
Map of all AeMeteringMode supported value names (in std::string format) to value.
const Control< int32_t > AeExposureMode
Specify an exposure mode for the AE algorithm to use.
const Control< int32_t > AeFlickerPeriod
Manual flicker period in microseconds.
const Control< int32_t > AfSpeed
Determine whether the AF is to move the lens as quickly as possible or more steadily.
const Control< float > SensorTemperature
Temperature measure from the camera sensor in Celsius.
HdrModeEnum
Supported HdrMode values.
Definition control_ids.h:211
@ HdrModeNight
Multiple frames will be combined to produce "night mode" images.
Definition control_ids.h:216
@ HdrModeSingleExposure
Multiple frames all at a single exposure will be used to create HDR images.
Definition control_ids.h:215
@ HdrModeMultiExposureUnmerged
Multiple exposures will be generated in an alternating fashion.
Definition control_ids.h:213
@ HdrModeMultiExposure
Multiple exposures will be generated and merged to create HDR images.
Definition control_ids.h:214
@ HdrModeOff
HDR is disabled.
Definition control_ids.h:212
const std::map< std::string, int32_t > AeFlickerModeNameValueMap
Map of all AeFlickerMode supported value names (in std::string format) to value.
const Control< Span< const float, 2 > > ColourGains
Pair of gain values for the Red and Blue colour channels, in that order.
const Control< int32_t > AfMode
The mode of the AF (autofocus) algorithm.
const Control< int32_t > AeConstraintMode
Specify a constraint mode for the AE algorithm to use.
const Control< int32_t > FocusFoM
Reports a Figure of Merit (FoM) to indicate how in-focus the frame is.
AwbModeEnum
Supported AwbMode values.
Definition control_ids.h:120
@ AwbIncandescent
Incandescent AWB lamp mode.
Definition control_ids.h:122
@ AwbDaylight
Daylight AWB lighting mode.
Definition control_ids.h:126
@ AwbAuto
Search over the whole colour temperature range.
Definition control_ids.h:121
@ AwbTungsten
Tungsten AWB lamp mode.
Definition control_ids.h:123
@ AwbIndoor
Indoor AWB lighting mode.
Definition control_ids.h:125
@ AwbFluorescent
Fluorescent AWB lamp mode.
Definition control_ids.h:124
@ AwbCloudy
Cloudy AWB lighting mode.
Definition control_ids.h:127
@ AwbCustom
Custom AWB mode.
Definition control_ids.h:128
const std::map< std::string, int32_t > AfPauseNameValueMap
Map of all AfPause supported value names (in std::string format) to value.
const ControlIdMap controls
List of all supported libcamera controls.
Definition control_ids.cpp:1985
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 > HdrChannelNameValueMap
Map of all HdrChannel supported value names (in std::string format) to value.
const std::map< std::string, int32_t > AfSpeedNameValueMap
Map of all AfSpeed supported value names (in std::string format) to value.
AfRangeEnum
Supported AfRange values.
Definition control_ids.h:155
@ AfRangeNormal
A wide range of focus distances is scanned.
Definition control_ids.h:156
@ AfRangeMacro
Only close distances are scanned.
Definition control_ids.h:157
@ AfRangeFull
The full range of focus distances is scanned.
Definition control_ids.h:158
const std::map< std::string, int32_t > AeExposureModeNameValueMap
Map of all AeExposureMode supported value names (in std::string format) to value.
const Control< int32_t > AeFlickerDetected
Flicker period detected in microseconds.
const Control< float > Sharpness
Intensity of the sharpening applied to the image.
const std::array< const ControlValue, 3 > AfPauseStateValues
List of all AfPauseState supported values.
const Control< int32_t > AfMetering
The parts of the image used by the AF algorithm to measure focus.
AeMeteringModeEnum
Supported AeMeteringMode values.
Definition control_ids.h:76
@ MeteringSpot
Spot metering mode.
Definition control_ids.h:78
@ MeteringMatrix
Matrix metering mode.
Definition control_ids.h:79
@ MeteringCustom
Custom metering mode.
Definition control_ids.h:80
@ MeteringCentreWeighted
Centre-weighted metering mode.
Definition control_ids.h:77
const Control< int32_t > ColourTemperature
ColourTemperature of the frame, in kelvin.
AeExposureModeEnum
Supported AeExposureMode values.
Definition control_ids.h:94
@ ExposureShort
Exposure mode allowing only short exposure times.
Definition control_ids.h:96
@ ExposureNormal
Default exposure mode.
Definition control_ids.h:95
@ ExposureCustom
Custom exposure mode.
Definition control_ids.h:98
@ ExposureLong
Exposure mode allowing long exposure times.
Definition control_ids.h:97
const Control< bool > AwbLocked
Report the lock status of a running AWB algorithm.
const Control< int32_t > AeFlickerMode
Set the flicker avoidance mode for AGC/AEC.
const Control< float > Brightness
Specify a fixed brightness parameter.
const std::map< std::string, int32_t > AfPauseStateNameValueMap
Map of all AfPauseState supported value names (in std::string format) to value.
const Control< float > Lux
Report an estimate of the current illuminance level in lux.
const std::array< const ControlValue, 4 > AeConstraintModeValues
List of all AeConstraintMode supported values.
const std::map< std::string, int32_t > AfStateNameValueMap
Map of all AfState supported value names (in std::string format) to value.
const Control< float > DigitalGain
Digital gain value applied during the processing steps applied to the image as captured from the sens...
const std::map< std::string, int32_t > AfModeNameValueMap
Map of all AfMode supported value names (in std::string format) to value.
AfMeteringEnum
Supported AfMetering values.
Definition control_ids.h:170
@ AfMeteringWindows
Use the rectangles defined by the AfWindows control to measure focus.
Definition control_ids.h:172
@ AfMeteringAuto
Let the AF algorithm decide for itself where it will measure focus.
Definition control_ids.h:171
AfSpeedEnum
Supported AfSpeed values.
Definition control_ids.h:163
@ AfSpeedFast
Move the lens more quickly.
Definition control_ids.h:165
@ AfSpeedNormal
Move the lens at its usual speed.
Definition control_ids.h:164
const std::map< std::string, int32_t > AwbModeNameValueMap
Map of all AwbMode supported value names (in std::string format) to value.
const Control< bool > DebugMetadataEnable
Enable or disable the debug metadata.
const Control< int32_t > AfTrigger
Start an autofocus scan.
AeConstraintModeEnum
Supported AeConstraintMode values.
Definition control_ids.h:85
@ ConstraintHighlight
Highlight constraint mode.
Definition control_ids.h:87
@ ConstraintCustom
Custom constraint mode.
Definition control_ids.h:89
@ ConstraintNormal
Default constraint mode.
Definition control_ids.h:86
@ ConstraintShadows
Shadows constraint mode.
Definition control_ids.h:88
const Control< bool > AeLocked
Report the lock status of a running AE algorithm.
const Control< Span< const int32_t, 4 > > SensorBlackLevels
Reports the sensor black levels used for processing a frame.
const Control< int32_t > AfPauseState
Report whether the autofocus is currently running, paused or pausing.
const std::array< const ControlValue, 5 > HdrModeValues
List of all HdrMode supported values.
const Control< int32_t > HdrMode
Set the mode to be used for High Dynamic Range (HDR) imaging.
const Control< float > Gamma
Specify a fixed gamma value.
const std::map< std::string, int32_t > AeConstraintModeNameValueMap
Map of all AeConstraintMode supported value names (in std::string format) to value.
const Control< int32_t > AeMeteringMode
Specify a metering mode for the AE algorithm to use.
HdrChannelEnum
Supported HdrChannel values.
Definition control_ids.h:221
@ HdrChannelShort
This is a short exposure image.
Definition control_ids.h:223
@ HdrChannelLong
This is a long exposure image.
Definition control_ids.h:225
@ HdrChannelMedium
This is a medium exposure image.
Definition control_ids.h:224
@ HdrChannelNone
This image does not correspond to any of the captures used to create an HDR image.
Definition control_ids.h:222
const Control< int64_t > FrameDuration
The instantaneous frame duration from start of frame exposure to start of next exposure,...
const std::map< std::string, int32_t > AfRangeNameValueMap
Map of all AfRange supported value names (in std::string format) to value.
const Control< Span< const int64_t, 2 > > FrameDurationLimits
The minimum and maximum (in that order) frame duration, expressed in microseconds.
const Control< bool > AeEnable
Enable or disable the AE.
const std::map< std::string, int32_t > AfTriggerNameValueMap
Map of all AfTrigger supported value names (in std::string format) to value.
AfPauseStateEnum
Supported AfPauseState values.
Definition control_ids.h:203
@ AfPauseStatePausing
Continuous AF has been sent an AfPauseDeferred control, and will pause as soon as any in-progress sca...
Definition control_ids.h:205
@ AfPauseStatePaused
Continuous AF is paused.
Definition control_ids.h:206
@ AfPauseStateRunning
Continuous AF is running and the algorithm may restart a scan spontaneously.
Definition control_ids.h:204
const Control< float > Contrast
Specify a fixed contrast parameter.
const std::array< const ControlValue, 4 > HdrChannelValues
List of all HdrChannel supported values.
AeFlickerModeEnum
Supported AeFlickerMode values.
Definition control_ids.h:106
@ FlickerAuto
Automatic flicker period detection and avoidance.
Definition control_ids.h:109
@ FlickerOff
No flicker avoidance is performed.
Definition control_ids.h:107
@ FlickerManual
Manual flicker avoidance.
Definition control_ids.h:108
const std::array< const ControlValue, 8 > AwbModeValues
List of all AwbMode supported values.
const Control< Span< const float, 9 > > ColourCorrectionMatrix
The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline.
const Control< int64_t > SensorTimestamp
The time when the first row of the image sensor active array is exposed.
Top-level libcamera namespace.
Definition bound_method.h:15
std::unordered_map< unsigned int, const ControlId * > ControlIdMap
A map of numerical control ID to ControlId.
Definition controls.h:364