libcamera v0.0.0+1-ab0bf965
Supporting cameras in Linux since 2019
Namespaces | 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

namespace  libcamera
 Top-level libcamera namespace.
 
namespace  libcamera::controls
 Namespace for libcamera controls.
 
namespace  libcamera::controls::draft
 Namespace for libcamera 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 ,
  BRIGHTNESS = 9 , CONTRAST = 10 , LUX = 11 , AWB_ENABLE = 12 ,
  AWB_MODE = 13 , AWB_LOCKED = 14 , COLOUR_GAINS = 15 , COLOUR_TEMPERATURE = 16 ,
  SATURATION = 17 , SENSOR_BLACK_LEVELS = 18 , SHARPNESS = 19 , FOCUS_FO_M = 20 ,
  COLOUR_CORRECTION_MATRIX = 21 , SCALER_CROP = 22 , DIGITAL_GAIN = 23 , FRAME_DURATION = 24 ,
  FRAME_DURATION_LIMITS = 25 , SENSOR_TIMESTAMP = 26 , AE_PRECAPTURE_TRIGGER = 27 , AF_TRIGGER = 28 ,
  NOISE_REDUCTION_MODE = 29 , COLOR_CORRECTION_ABERRATION_MODE = 30 , AE_STATE = 31 , AF_STATE = 32 ,
  AWB_STATE = 33 , SENSOR_ROLLING_SHUTTER_SKEW = 34 , LENS_SHADING_MAP_MODE = 35 , SCENE_FLICKER = 36 ,
  PIPELINE_DEPTH = 37 , MAX_LATENCY = 38 , TEST_PATTERN_MODE = 39
}
 
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::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::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::AfTriggerEnum { libcamera::controls::draft::AfTriggerIdle = 0 , libcamera::controls::draft::AfTriggerStart = 1 , libcamera::controls::draft::AfTriggerCancel = 2 }
 Supported AfTrigger 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::AfStateEnum {
  libcamera::controls::draft::AfStateInactive = 0 , libcamera::controls::draft::AfStatePassiveScan = 1 , libcamera::controls::draft::AfStatePassiveFocused = 2 , libcamera::controls::draft::AfStateActiveScan = 3 ,
  libcamera::controls::draft::AfStateFocusedLock = 4 , libcamera::controls::draft::AfStateNotFocusedLock = 5 , libcamera::controls::draft::AfStatePassiveUnfocused = 6
}
 Supported AfState 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::SceneFlickerEnum { libcamera::controls::draft::SceneFickerOff = 0 , libcamera::controls::draft::SceneFicker50Hz = 1 , libcamera::controls::draft::SceneFicker60Hz = 2 }
 Supported SceneFlicker 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 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 > > 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 > > 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 control depends on the IPA to gather ISP statistics from the defined focus region, and combine them in a suitable way to generate a FocusFoM value. 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 > > 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 > > libcamera::controls::FrameDurationLimits
 The minimum and maximum (in that order) frame duration, expressed in microseconds. More...
 
const Control< int64_t > libcamera::controls::SensorTimestamp
 The time when the first row of the image sensor active array is exposed. 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, 3 > libcamera::controls::draft::AfTriggerValues
 List of all AfTrigger supported values.
 
const Control< int32_t > libcamera::controls::draft::AfTrigger
 Control for AF trigger. Currently identical to ANDROID_CONTROL_AF_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, 7 > libcamera::controls::draft::AfStateValues
 List of all AfState supported values.
 
const Control< int32_t > libcamera::controls::draft::AfState
 Control to report the current AF algorithm state. Currently identical to ANDROID_CONTROL_AF_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 std::array< const ControlValue, 3 > libcamera::controls::draft::SceneFlickerValues
 List of all SceneFlicker supported values.
 
const Control< int32_t > libcamera::controls::draft::SceneFlicker
 Control to report the detected scene light frequency. Currently identical to ANDROID_STATISTICS_SCENE_FLICKER.
 
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.