libcamera  v0.2.0+85-1c5830a9
Supporting cameras in Linux since 2019
Namespaces | Macros | Enumerations | Variables
control_ids.h File Reference

Camera control identifiers. More...

#include <array>
#include <stdint.h>
#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.
 

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
}
 
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
}
 
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...
 

Variables

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 Control< int32_t > libcamera::controls::AeMeteringMode
 Specify a metering mode for the AE algorithm to use. The metering modes determine which parts of the image are used to determine the scene brightness. Metering modes may be platform specific and not all metering modes may be supported.
 
const std::array< const ControlValue, 4 > libcamera::controls::AeConstraintModeValues
 List of all AeConstraintMode supported values.
 
const Control< int32_t > libcamera::controls::AeConstraintMode
 Specify a constraint mode for the AE algorithm to use. These determine how the measured scene brightness is adjusted to reach the desired target exposure. Constraint modes may be platform specific, and not all constraint modes may be supported.
 
const std::array< const ControlValue, 4 > libcamera::controls::AeExposureModeValues
 List of all AeExposureMode supported values.
 
const Control< int32_t > libcamera::controls::AeExposureMode
 Specify an exposure mode for the AE algorithm to use. These specify how the desired total exposure is divided between the shutter time and the sensor's analogue gain. The exposure modes are platform specific, and not all exposure modes may be supported.
 
const Control< float > libcamera::controls::ExposureValue
 Specify an Exposure Value (EV) parameter. The EV parameter will only be applied if the AE algorithm is currently enabled. More...
 
const Control< int32_t > libcamera::controls::ExposureTime
 Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in micro-seconds. More...
 
const Control< float > libcamera::controls::AnalogueGain
 Analogue gain value applied in the sensor device. The value of the control specifies the gain multiplier applied to all colour channels. This value cannot be lower than 1.0. More...
 
const std::array< const ControlValue, 3 > libcamera::controls::AeFlickerModeValues
 List of all AeFlickerMode supported values.
 
const Control< int32_t > libcamera::controls::AeFlickerMode
 Set the flicker mode, which determines whether, and how, the AGC/AEC algorithm attempts to hide flicker effects caused by the duty cycle of artificial lighting. More...
 
const Control< int32_t > libcamera::controls::AeFlickerPeriod
 Manual flicker period in microseconds. This value sets the current flicker period to avoid. It is used when AeFlickerMode is set to FlickerManual. To cancel 50Hz mains flicker, this should be set to 10000 (corresponding to 100Hz), or 8333 (120Hz) for 60Hz mains. Setting the mode to FlickerManual when no AeFlickerPeriod has ever been set means that no flicker cancellation occurs (until the value of this control is updated). Switching to modes other than FlickerManual has no effect on the value of the AeFlickerPeriod control. More...
 
const Control< int32_t > libcamera::controls::AeFlickerDetected
 Flicker period detected in microseconds. The value reported here indicates the currently detected flicker period, or zero if no flicker at all is detected. When AeFlickerMode is set to FlickerAuto, there may be a period during which the value reported here remains zero. Once a non-zero value is reported, then this is the flicker period that has been detected and is now being cancelled. In the case of 50Hz mains flicker, the value would be 10000 (corresponding to 100Hz), or 8333 (120Hz) for 60Hz mains flicker. It is implementation dependent whether the system can continue to detect flicker of different periods when another frequency is already being cancelled. More...
 
const Control< float > libcamera::controls::Brightness
 Specify a fixed brightness parameter. Positive values (up to 1.0) produce brighter images; negative values (up to -1.0) produce darker images and 0.0 leaves pixels unchanged.
 
const Control< float > libcamera::controls::Contrast
 Specify a fixed contrast parameter. Normal contrast is given by the value 1.0; larger values produce images with more contrast.
 
const Control< float > libcamera::controls::Lux
 Report an estimate of the current illuminance level in lux. The Lux control can only be returned in metadata.
 
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 Control< int32_t > libcamera::controls::AwbMode
 Specify the range of illuminants to use for the AWB algorithm. The modes supported are platform specific, and not all modes may be supported.
 
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. ColourGains can only be applied in a Request when the AWB is disabled. More...
 
const Control< int32_t > libcamera::controls::ColourTemperature
 Report the current estimate of the colour temperature, in kelvin, for this frame. The ColourTemperature control can only be returned in metadata.
 
const Control< float > libcamera::controls::Saturation
 Specify a fixed saturation parameter. Normal saturation is given by the value 1.0; larger values produce more saturated colours; 0.0 produces a greyscale image.
 
const Control< Span< const int32_t, 4 > > libcamera::controls::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.
 
const Control< float > libcamera::controls::Sharpness
 A value of 0.0 means no sharpening. The minimum value means minimal sharpening, and shall be 0.0 unless the camera can't disable sharpening completely. The default value shall give a "reasonable" level of sharpening, suitable for most use cases. The maximum value may apply extremely high levels of sharpening, higher than anyone could reasonably want. Negative values are not allowed. Note also that sharpening is not applied to raw streams.
 
const Control< int32_t > libcamera::controls::FocusFoM
 Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. A larger FocusFoM value indicates a more in-focus frame. This singular value may be based on a combination of statistics gathered from multiple focus regions within an image. The number of focus regions and method of combination is platform dependent. In this respect, it is not necessarily aimed at providing a way to implement a focus algorithm by the application, rather an indication of how in-focus a frame is.
 
const Control< Span< const float, 9 > > libcamera::controls::ColourCorrectionMatrix
 The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline. This should describe the matrix that is used after pixels have been white-balanced, but before any gamma transformation. The 3x3 matrix is stored in conventional reading order in an array of 9 floating point values.
 
const Control< Rectangle > libcamera::controls::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. 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. This control is meant to be returned in metadata.
 
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. This is typically obtained by a thermal sensor present on-die or in the camera module. The range of reported temperatures is device dependent. 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 Control< int32_t > libcamera::controls::AfMode
 Control to set the mode of the AF (autofocus) algorithm. More...
 
const std::array< const ControlValue, 3 > libcamera::controls::AfRangeValues
 List of all AfRange supported values.
 
const Control< int32_t > libcamera::controls::AfRange
 Control to set the range of focus distances that is scanned. An implementation may choose not to implement all the options here.
 
const std::array< const ControlValue, 2 > libcamera::controls::AfSpeedValues
 List of all AfSpeed supported values.
 
const Control< int32_t > libcamera::controls::AfSpeed
 Control that determines whether the AF algorithm is to move the lens as quickly as possible or more steadily. For example, during video recording it may be desirable not to move the lens too abruptly, but when in a preview mode (waiting for a still capture) it may be helpful to move the lens as quickly as is reasonably possible.
 
const std::array< const ControlValue, 2 > libcamera::controls::AfMeteringValues
 List of all AfMetering supported values.
 
const Control< int32_t > libcamera::controls::AfMetering
 Instruct the AF algorithm how it should decide which parts of the image should be used to measure focus.
 
const Control< Span< const Rectangle > > libcamera::controls::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. More...
 
const std::array< const ControlValue, 2 > libcamera::controls::AfTriggerValues
 List of all AfTrigger supported values.
 
const Control< int32_t > libcamera::controls::AfTrigger
 This control starts an autofocus scan when AfMode is set to AfModeAuto, and can also be used to terminate a scan early. More...
 
const std::array< const ControlValue, 3 > libcamera::controls::AfPauseValues
 List of all AfPause supported values.
 
const Control< int32_t > libcamera::controls::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 Control< float > libcamera::controls::LensPosition
 Acts as a control to instruct the lens to move to a particular position and also reports back the position of the lens for each frame. More...
 
const std::array< const ControlValue, 4 > libcamera::controls::AfStateValues
 List of all AfState supported values.
 
const Control< int32_t > libcamera::controls::AfState
 Reports the current state of the AF algorithm in conjunction with the reported AfMode value and (in continuous AF mode) the AfPauseState value. The possible state changes are described below, though we note the following state transitions that occur when the AfMode is changed. More...
 
const std::array< const ControlValue, 3 > libcamera::controls::AfPauseStateValues
 List of all AfPauseState supported values.
 
const Control< int32_t > libcamera::controls::AfPauseState
 Only applicable in continuous (AfModeContinuous) mode, this reports whether the algorithm is currently running, paused or pausing (that is, will pause as soon as any in-progress scan completes). More...
 
const std::array< const ControlValue, 5 > libcamera::controls::HdrModeValues
 List of all HdrMode supported values.
 
const Control< int32_t > libcamera::controls::HdrMode
 Control to set the mode to be used for High Dynamic Range (HDR) imaging. HDR techniques typically include multiple exposure, image fusion and tone mapping techniques to improve the dynamic range of the resulting images. More...
 
const std::array< const ControlValue, 4 > libcamera::controls::HdrChannelValues
 List of all HdrChannel supported values.
 
const Control< int32_t > libcamera::controls::HdrChannel
 This value is reported back to the application so that it can discover whether this capture corresponds to the short or long exposure image (or any other image used by the HDR procedure). An application can monitor the HDR channel to discover when the differently exposed images have arrived. More...
 
const ControlIdMap libcamera::controls::controls
 List of all supported libcamera controls. More...
 
const std::array< const ControlValue, 3 > libcamera::controls::draft::AePrecaptureTriggerValues
 List of all AePrecaptureTrigger supported values.
 
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 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 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 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 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 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 Control< int32_t > libcamera::controls::draft::TestPatternMode
 Control to select the test pattern mode. Currently identical to ANDROID_SENSOR_TEST_PATTERN_MODE.
 

Detailed Description

Camera control identifiers.