control_ids.h File Reference

Camera controls identifiers. More...

#include <array>
#include <map>
#include <stdint.h>
#include <string>
#include <libcamera/controls.h>

Include dependency graph for control_ids.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	libcamera
	Top-level libcamera namespace.
	libcamera::controls
	Namespace for libcamera controls.
	libcamera::controls::draft
	Namespace for draft controls.
	libcamera::controls::debug
	Namespace for debug controls.

Enumerations
enum	{   AE_ENABLE = 1, AE_LOCKED = 2, AE_METERING_MODE = 3, AE_CONSTRAINT_MODE = 4,   AE_EXPOSURE_MODE = 5, EXPOSURE_VALUE = 6, EXPOSURE_TIME = 7, ANALOGUE_GAIN = 8,   AE_FLICKER_MODE = 9, AE_FLICKER_PERIOD = 10, AE_FLICKER_DETECTED = 11, BRIGHTNESS = 12,   CONTRAST = 13, LUX = 14, AWB_ENABLE = 15, AWB_MODE = 16,   AWB_LOCKED = 17, COLOUR_GAINS = 18, COLOUR_TEMPERATURE = 19, SATURATION = 20,   SENSOR_BLACK_LEVELS = 21, SHARPNESS = 22, FOCUS_FO_M = 23, COLOUR_CORRECTION_MATRIX = 24,   SCALER_CROP = 25, DIGITAL_GAIN = 26, FRAME_DURATION = 27, FRAME_DURATION_LIMITS = 28,   SENSOR_TEMPERATURE = 29, SENSOR_TIMESTAMP = 30, AF_MODE = 31, AF_RANGE = 32,   AF_SPEED = 33, AF_METERING = 34, AF_WINDOWS = 35, AF_TRIGGER = 36,   AF_PAUSE = 37, LENS_POSITION = 38, AF_STATE = 39, AF_PAUSE_STATE = 40,   HDR_MODE = 41, HDR_CHANNEL = 42, GAMMA = 43, DEBUG_METADATA_ENABLE = 44 }
enum	libcamera::controls::AeMeteringModeEnum { libcamera::controls::MeteringCentreWeighted = 0, libcamera::controls::MeteringSpot = 1, libcamera::controls::MeteringMatrix = 2, libcamera::controls::MeteringCustom = 3 }
	Supported AeMeteringMode values. More...
enum	libcamera::controls::AeConstraintModeEnum { libcamera::controls::ConstraintNormal = 0, libcamera::controls::ConstraintHighlight = 1, libcamera::controls::ConstraintShadows = 2, libcamera::controls::ConstraintCustom = 3 }
	Supported AeConstraintMode values. More...
enum	libcamera::controls::AeExposureModeEnum { libcamera::controls::ExposureNormal = 0, libcamera::controls::ExposureShort = 1, libcamera::controls::ExposureLong = 2, libcamera::controls::ExposureCustom = 3 }
	Supported AeExposureMode values. More...
enum	libcamera::controls::AeFlickerModeEnum { libcamera::controls::FlickerOff = 0, libcamera::controls::FlickerManual = 1, libcamera::controls::FlickerAuto = 2 }
	Supported AeFlickerMode values. More...
enum	libcamera::controls::AwbModeEnum {   libcamera::controls::AwbAuto = 0, libcamera::controls::AwbIncandescent = 1, libcamera::controls::AwbTungsten = 2, libcamera::controls::AwbFluorescent = 3,   libcamera::controls::AwbIndoor = 4, libcamera::controls::AwbDaylight = 5, libcamera::controls::AwbCloudy = 6, libcamera::controls::AwbCustom = 7 }
	Supported AwbMode values. More...
enum	libcamera::controls::AfModeEnum { libcamera::controls::AfModeManual = 0, libcamera::controls::AfModeAuto = 1, libcamera::controls::AfModeContinuous = 2 }
	Supported AfMode values. More...
enum	libcamera::controls::AfRangeEnum { libcamera::controls::AfRangeNormal = 0, libcamera::controls::AfRangeMacro = 1, libcamera::controls::AfRangeFull = 2 }
	Supported AfRange values. More...
enum	libcamera::controls::AfSpeedEnum { libcamera::controls::AfSpeedNormal = 0, libcamera::controls::AfSpeedFast = 1 }
	Supported AfSpeed values. More...
enum	libcamera::controls::AfMeteringEnum { libcamera::controls::AfMeteringAuto = 0, libcamera::controls::AfMeteringWindows = 1 }
	Supported AfMetering values. More...
enum	libcamera::controls::AfTriggerEnum { libcamera::controls::AfTriggerStart = 0, libcamera::controls::AfTriggerCancel = 1 }
	Supported AfTrigger values. More...
enum	libcamera::controls::AfPauseEnum { libcamera::controls::AfPauseImmediate = 0, libcamera::controls::AfPauseDeferred = 1, libcamera::controls::AfPauseResume = 2 }
	Supported AfPause values. More...
enum	libcamera::controls::AfStateEnum { libcamera::controls::AfStateIdle = 0, libcamera::controls::AfStateScanning = 1, libcamera::controls::AfStateFocused = 2, libcamera::controls::AfStateFailed = 3 }
	Supported AfState values. More...
enum	libcamera::controls::AfPauseStateEnum { libcamera::controls::AfPauseStateRunning = 0, libcamera::controls::AfPauseStatePausing = 1, libcamera::controls::AfPauseStatePaused = 2 }
	Supported AfPauseState values. More...
enum	libcamera::controls::HdrModeEnum {   libcamera::controls::HdrModeOff = 0, libcamera::controls::HdrModeMultiExposureUnmerged = 1, libcamera::controls::HdrModeMultiExposure = 2, libcamera::controls::HdrModeSingleExposure = 3,   libcamera::controls::HdrModeNight = 4 }
	Supported HdrMode values. More...
enum	libcamera::controls::HdrChannelEnum { libcamera::controls::HdrChannelNone = 0, libcamera::controls::HdrChannelShort = 1, libcamera::controls::HdrChannelMedium = 2, libcamera::controls::HdrChannelLong = 3 }
	Supported HdrChannel values. More...
enum	{   AE_PRECAPTURE_TRIGGER = 10001, NOISE_REDUCTION_MODE = 10002, COLOR_CORRECTION_ABERRATION_MODE = 10003, AE_STATE = 10004,   AWB_STATE = 10005, SENSOR_ROLLING_SHUTTER_SKEW = 10006, LENS_SHADING_MAP_MODE = 10007, PIPELINE_DEPTH = 10008,   MAX_LATENCY = 10009, TEST_PATTERN_MODE = 10010, FACE_DETECT_MODE = 10011, FACE_DETECT_FACE_RECTANGLES = 10012,   FACE_DETECT_FACE_SCORES = 10013, FACE_DETECT_FACE_LANDMARKS = 10014, FACE_DETECT_FACE_IDS = 10015 }
enum	libcamera::controls::draft::AePrecaptureTriggerEnum { libcamera::controls::draft::AePrecaptureTriggerIdle = 0, libcamera::controls::draft::AePrecaptureTriggerStart = 1, libcamera::controls::draft::AePrecaptureTriggerCancel = 2 }
	Supported AePrecaptureTrigger values. More...
enum	libcamera::controls::draft::NoiseReductionModeEnum {   libcamera::controls::draft::NoiseReductionModeOff = 0, libcamera::controls::draft::NoiseReductionModeFast = 1, libcamera::controls::draft::NoiseReductionModeHighQuality = 2, libcamera::controls::draft::NoiseReductionModeMinimal = 3,   libcamera::controls::draft::NoiseReductionModeZSL = 4 }
	Supported NoiseReductionMode values. More...
enum	libcamera::controls::draft::ColorCorrectionAberrationModeEnum { libcamera::controls::draft::ColorCorrectionAberrationOff = 0, libcamera::controls::draft::ColorCorrectionAberrationFast = 1, libcamera::controls::draft::ColorCorrectionAberrationHighQuality = 2 }
	Supported ColorCorrectionAberrationMode values. More...
enum	libcamera::controls::draft::AeStateEnum {   libcamera::controls::draft::AeStateInactive = 0, libcamera::controls::draft::AeStateSearching = 1, libcamera::controls::draft::AeStateConverged = 2, libcamera::controls::draft::AeStateLocked = 3,   libcamera::controls::draft::AeStateFlashRequired = 4, libcamera::controls::draft::AeStatePrecapture = 5 }
	Supported AeState values. More...
enum	libcamera::controls::draft::AwbStateEnum { libcamera::controls::draft::AwbStateInactive = 0, libcamera::controls::draft::AwbStateSearching = 1, libcamera::controls::draft::AwbConverged = 2, libcamera::controls::draft::AwbLocked = 3 }
	Supported AwbState values. More...
enum	libcamera::controls::draft::LensShadingMapModeEnum { libcamera::controls::draft::LensShadingMapModeOff = 0, libcamera::controls::draft::LensShadingMapModeOn = 1 }
	Supported LensShadingMapMode values. More...
enum	libcamera::controls::draft::TestPatternModeEnum {   libcamera::controls::draft::TestPatternModeOff = 0, libcamera::controls::draft::TestPatternModeSolidColor = 1, libcamera::controls::draft::TestPatternModeColorBars = 2, libcamera::controls::draft::TestPatternModeColorBarsFadeToGray = 3,   libcamera::controls::draft::TestPatternModePn9 = 4, libcamera::controls::draft::TestPatternModeCustom1 = 256 }
	Supported TestPatternMode values. More...
enum	libcamera::controls::draft::FaceDetectModeEnum { libcamera::controls::draft::FaceDetectModeOff = 0, libcamera::controls::draft::FaceDetectModeSimple = 1, libcamera::controls::draft::FaceDetectModeFull = 2 }
	Supported FaceDetectMode values. More...

Variables
const ControlIdMap	libcamera::controls::controls
	List of all supported libcamera controls. More...
const Control< bool >	libcamera::controls::AeEnable
	Enable or disable the AE. More...
const Control< bool >	libcamera::controls::AeLocked
	Report the lock status of a running AE algorithm. More...
const std::array< const ControlValue, 4 >	libcamera::controls::AeMeteringModeValues
	List of all AeMeteringMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::AeMeteringModeNameValueMap
	Map of all AeMeteringMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AeMeteringMode
	Specify a metering mode for the AE algorithm to use. More...
const std::array< const ControlValue, 4 >	libcamera::controls::AeConstraintModeValues
	List of all AeConstraintMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::AeConstraintModeNameValueMap
	Map of all AeConstraintMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AeConstraintMode
	Specify a constraint mode for the AE algorithm to use. More...
const std::array< const ControlValue, 4 >	libcamera::controls::AeExposureModeValues
	List of all AeExposureMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::AeExposureModeNameValueMap
	Map of all AeExposureMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AeExposureMode
	Specify an exposure mode for the AE algorithm to use. More...
const Control< float >	libcamera::controls::ExposureValue
	Specify an Exposure Value (EV) parameter. More...
const Control< int32_t >	libcamera::controls::ExposureTime
	Exposure time (shutter speed) for the frame applied in the sensor device. More...
const Control< float >	libcamera::controls::AnalogueGain
	Analogue gain value applied in the sensor device. More...
const std::array< const ControlValue, 3 >	libcamera::controls::AeFlickerModeValues
	List of all AeFlickerMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::AeFlickerModeNameValueMap
	Map of all AeFlickerMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AeFlickerMode
	Set the flicker avoidance mode for AGC/AEC. More...
const Control< int32_t >	libcamera::controls::AeFlickerPeriod
	Manual flicker period in microseconds. More...
const Control< int32_t >	libcamera::controls::AeFlickerDetected
	Flicker period detected in microseconds. More...
const Control< float >	libcamera::controls::Brightness
	Specify a fixed brightness parameter. More...
const Control< float >	libcamera::controls::Contrast
	Specify a fixed contrast parameter. More...
const Control< float >	libcamera::controls::Lux
	Report an estimate of the current illuminance level in lux. More...
const Control< bool >	libcamera::controls::AwbEnable
	Enable or disable the AWB. More...
const std::array< const ControlValue, 8 >	libcamera::controls::AwbModeValues
	List of all AwbMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::AwbModeNameValueMap
	Map of all AwbMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AwbMode
	Specify the range of illuminants to use for the AWB algorithm. More...
const Control< bool >	libcamera::controls::AwbLocked
	Report the lock status of a running AWB algorithm. More...
const Control< Span< const float, 2 > >	libcamera::controls::ColourGains
	Pair of gain values for the Red and Blue colour channels, in that order. More...
const Control< int32_t >	libcamera::controls::ColourTemperature
	Report the estimate of the colour temperature for the frame, in kelvin. More...
const Control< float >	libcamera::controls::Saturation
	Specify a fixed saturation parameter. More...
const Control< Span< const int32_t, 4 > >	libcamera::controls::SensorBlackLevels
	Reports the sensor black levels used for processing a frame. More...
const Control< float >	libcamera::controls::Sharpness
	Intensity of the sharpening applied to the image. More...
const Control< int32_t >	libcamera::controls::FocusFoM
	Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. More...
const Control< Span< const float, 9 > >	libcamera::controls::ColourCorrectionMatrix
	The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline. More...
const Control< Rectangle >	libcamera::controls::ScalerCrop
	Sets the image portion that will be scaled to form the whole of the final output image. More...
const Control< float >	libcamera::controls::DigitalGain
	Digital gain value applied during the processing steps applied to the image as captured from the sensor. More...
const Control< int64_t >	libcamera::controls::FrameDuration
	The instantaneous frame duration from start of frame exposure to start of next exposure, expressed in microseconds. More...
const Control< Span< const int64_t, 2 > >	libcamera::controls::FrameDurationLimits
	The minimum and maximum (in that order) frame duration, expressed in microseconds. More...
const Control< float >	libcamera::controls::SensorTemperature
	Temperature measure from the camera sensor in Celsius. More...
const Control< int64_t >	libcamera::controls::SensorTimestamp
	The time when the first row of the image sensor active array is exposed. More...
const std::array< const ControlValue, 3 >	libcamera::controls::AfModeValues
	List of all AfMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfModeNameValueMap
	Map of all AfMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfMode
	The mode of the AF (autofocus) algorithm. More...
const std::array< const ControlValue, 3 >	libcamera::controls::AfRangeValues
	List of all AfRange supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfRangeNameValueMap
	Map of all AfRange supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfRange
	The range of focus distances that is scanned. More...
const std::array< const ControlValue, 2 >	libcamera::controls::AfSpeedValues
	List of all AfSpeed supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfSpeedNameValueMap
	Map of all AfSpeed supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfSpeed
	Determine whether the AF is to move the lens as quickly as possible or more steadily. More...
const std::array< const ControlValue, 2 >	libcamera::controls::AfMeteringValues
	List of all AfMetering supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfMeteringNameValueMap
	Map of all AfMetering supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfMetering
	The parts of the image used by the AF algorithm to measure focus.
const Control< Span< const Rectangle > >	libcamera::controls::AfWindows
	The focus windows used by the AF algorithm when AfMetering is set to AfMeteringWindows. More...
const std::array< const ControlValue, 2 >	libcamera::controls::AfTriggerValues
	List of all AfTrigger supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfTriggerNameValueMap
	Map of all AfTrigger supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfTrigger
	Start an autofocus scan. More...
const std::array< const ControlValue, 3 >	libcamera::controls::AfPauseValues
	List of all AfPause supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfPauseNameValueMap
	Map of all AfPause supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfPause
	Pause lens movements when in continuous autofocus mode. More...
const Control< float >	libcamera::controls::LensPosition
	Set and report the focus lens position. More...
const std::array< const ControlValue, 4 >	libcamera::controls::AfStateValues
	List of all AfState supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfStateNameValueMap
	Map of all AfState supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfState
	The current state of the AF algorithm. More...
const std::array< const ControlValue, 3 >	libcamera::controls::AfPauseStateValues
	List of all AfPauseState supported values.
const std::map< std::string, int32_t >	libcamera::controls::AfPauseStateNameValueMap
	Map of all AfPauseState supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::AfPauseState
	Report whether the autofocus is currently running, paused or pausing. More...
const std::array< const ControlValue, 5 >	libcamera::controls::HdrModeValues
	List of all HdrMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::HdrModeNameValueMap
	Map of all HdrMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::HdrMode
	Set the mode to be used for High Dynamic Range (HDR) imaging. More...
const std::array< const ControlValue, 4 >	libcamera::controls::HdrChannelValues
	List of all HdrChannel supported values.
const std::map< std::string, int32_t >	libcamera::controls::HdrChannelNameValueMap
	Map of all HdrChannel supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::HdrChannel
	The HDR channel used to capture the frame. More...
const Control< float >	libcamera::controls::Gamma
	Specify a fixed gamma value. More...
const Control< bool >	libcamera::controls::DebugMetadataEnable
	Enable or disable the debug metadata.
const std::array< const ControlValue, 3 >	libcamera::controls::draft::AePrecaptureTriggerValues
	List of all AePrecaptureTrigger supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::AePrecaptureTriggerNameValueMap
	Map of all AePrecaptureTrigger supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::AePrecaptureTrigger
	Control for AE metering trigger. Currently identical to ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER. More...
const std::array< const ControlValue, 5 >	libcamera::controls::draft::NoiseReductionModeValues
	List of all NoiseReductionMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::NoiseReductionModeNameValueMap
	Map of all NoiseReductionMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::NoiseReductionMode
	Control to select the noise reduction algorithm mode. Currently identical to ANDROID_NOISE_REDUCTION_MODE. More...
const std::array< const ControlValue, 3 >	libcamera::controls::draft::ColorCorrectionAberrationModeValues
	List of all ColorCorrectionAberrationMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::ColorCorrectionAberrationModeNameValueMap
	Map of all ColorCorrectionAberrationMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::ColorCorrectionAberrationMode
	Control to select the color correction aberration mode. Currently identical to ANDROID_COLOR_CORRECTION_ABERRATION_MODE. More...
const std::array< const ControlValue, 6 >	libcamera::controls::draft::AeStateValues
	List of all AeState supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::AeStateNameValueMap
	Map of all AeState supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::AeState
	Control to report the current AE algorithm state. Currently identical to ANDROID_CONTROL_AE_STATE. More...
const std::array< const ControlValue, 4 >	libcamera::controls::draft::AwbStateValues
	List of all AwbState supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::AwbStateNameValueMap
	Map of all AwbState supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::AwbState
	Control to report the current AWB algorithm state. Currently identical to ANDROID_CONTROL_AWB_STATE. More...
const Control< int64_t >	libcamera::controls::draft::SensorRollingShutterSkew
	Control to report the time between the start of exposure of the first row and the start of exposure of the last row. Currently identical to ANDROID_SENSOR_ROLLING_SHUTTER_SKEW.
const std::array< const ControlValue, 2 >	libcamera::controls::draft::LensShadingMapModeValues
	List of all LensShadingMapMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::LensShadingMapModeNameValueMap
	Map of all LensShadingMapMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::LensShadingMapMode
	Control to report if the lens shading map is available. Currently identical to ANDROID_STATISTICS_LENS_SHADING_MAP_MODE.
const Control< int32_t >	libcamera::controls::draft::PipelineDepth
	Specifies the number of pipeline stages the frame went through from when it was exposed to when the final completed result was available to the framework. Always less than or equal to PipelineMaxDepth. Currently identical to ANDROID_REQUEST_PIPELINE_DEPTH. More...
const Control< int32_t >	libcamera::controls::draft::MaxLatency
	The maximum number of frames that can occur after a request (different than the previous) has been submitted, and before the result's state becomes synchronized. A value of -1 indicates unknown latency, and 0 indicates per-frame control. Currently identical to ANDROID_SYNC_MAX_LATENCY.
const std::array< const ControlValue, 6 >	libcamera::controls::draft::TestPatternModeValues
	List of all TestPatternMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::TestPatternModeNameValueMap
	Map of all TestPatternMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::TestPatternMode
	Control to select the test pattern mode. Currently identical to ANDROID_SENSOR_TEST_PATTERN_MODE.
const std::array< const ControlValue, 3 >	libcamera::controls::draft::FaceDetectModeValues
	List of all FaceDetectMode supported values.
const std::map< std::string, int32_t >	libcamera::controls::draft::FaceDetectModeNameValueMap
	Map of all FaceDetectMode supported value names (in std::string format) to value.
const Control< int32_t >	libcamera::controls::draft::FaceDetectMode
	Control to select the face detection mode used by the pipeline. More...
const Control< Span< const Rectangle > >	libcamera::controls::draft::FaceDetectFaceRectangles
	Boundary rectangles of the detected faces. The number of values is the number of detected faces. More...
const Control< Span< const uint8_t > >	libcamera::controls::draft::FaceDetectFaceScores
	Confidence score of each of the detected faces. The range of score is [0, 100]. The number of values should be the number of faces reported in FaceDetectFaceRectangles. More...
const Control< Span< const Point > >	libcamera::controls::draft::FaceDetectFaceLandmarks
	Array of human face landmark coordinates in format [..., left_eye_i, right_eye_i, mouth_i, left_eye_i+1, ...], with i = index of face. The number of values should be 3 * the number of faces reported in FaceDetectFaceRectangles. More...
const Control< Span< const int32_t > >	libcamera::controls::draft::FaceDetectFaceIds
	Each detected face is given a unique ID that is valid for as long as the face is visible to the camera device. A face that leaves the field of view and later returns may be assigned a new ID. The number of values should be the number of faces reported in FaceDetectFaceRectangles. More...

Detailed Description

Camera controls identifiers.