libcamera v0.4.0+5314-fc77c53d-nvm
Supporting cameras in Linux since 2019
|
Camera controls identifiers. More...
#include <array>
#include <map>
#include <stdint.h>
#include <string>
#include <libcamera/controls.h>
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 draft controls. | |
namespace | libcamera::controls::rpi |
Namespace for rpi controls. | |
namespace | libcamera::controls::debug |
Namespace for debug controls. | |
Variables | |
const ControlIdMap | libcamera::controls::controls |
List of all supported libcamera controls. | |
const Control< bool > | libcamera::controls::AeEnable |
Enable or disable the AE. | |
const Control< bool > | libcamera::controls::AeLocked |
Report the lock status of a running AE algorithm. | |
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. | |
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. | |
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. | |
const Control< float > | libcamera::controls::ExposureValue |
Specify an Exposure Value (EV) parameter. | |
const Control< int32_t > | libcamera::controls::ExposureTime |
Exposure time for the frame applied in the sensor device. | |
const Control< float > | libcamera::controls::AnalogueGain |
Analogue gain value applied in the sensor device. | |
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. | |
const Control< int32_t > | libcamera::controls::AeFlickerPeriod |
Manual flicker period in microseconds. | |
const Control< int32_t > | libcamera::controls::AeFlickerDetected |
Flicker period detected in microseconds. | |
const Control< float > | libcamera::controls::Brightness |
Specify a fixed brightness parameter. | |
const Control< float > | libcamera::controls::Contrast |
Specify a fixed contrast parameter. | |
const Control< float > | libcamera::controls::Lux |
Report an estimate of the current illuminance level in lux. | |
const Control< bool > | libcamera::controls::AwbEnable |
Enable or disable the AWB. | |
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. | |
const Control< bool > | libcamera::controls::AwbLocked |
Report the lock status of a running AWB algorithm. | |
const Control< Span< const float, 2 > > | libcamera::controls::ColourGains |
Pair of gain values for the Red and Blue colour channels, in that order. | |
const Control< int32_t > | libcamera::controls::ColourTemperature |
ColourTemperature of the frame, in kelvin. | |
const Control< float > | libcamera::controls::Saturation |
Specify a fixed saturation parameter. | |
const Control< Span< const int32_t, 4 > > | libcamera::controls::SensorBlackLevels |
Reports the sensor black levels used for processing a frame. | |
const Control< float > | libcamera::controls::Sharpness |
Intensity of the sharpening applied to the image. | |
const Control< int32_t > | libcamera::controls::FocusFoM |
Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. | |
const Control< Span< const float, 9 > > | libcamera::controls::ColourCorrectionMatrix |
The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline. | |
const Control< Rectangle > | libcamera::controls::ScalerCrop |
Sets the image portion that will be scaled to form the whole of the final output image. | |
const Control< float > | libcamera::controls::DigitalGain |
Digital gain value applied during the processing steps applied to the image as captured from the sensor. | |
const Control< int64_t > | libcamera::controls::FrameDuration |
The instantaneous frame duration from start of frame exposure to start of next exposure, expressed in microseconds. | |
const Control< Span< const int64_t, 2 > > | libcamera::controls::FrameDurationLimits |
The minimum and maximum (in that order) frame duration, expressed in microseconds. | |
const Control< float > | libcamera::controls::SensorTemperature |
Temperature measure from the camera sensor in Celsius. | |
const Control< int64_t > | libcamera::controls::SensorTimestamp |
The time when the first row of the image sensor active array is exposed. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
const Control< float > | libcamera::controls::LensPosition |
Set and report the focus lens position. | |
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. | |
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. | |
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. | |
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. | |
const Control< float > | libcamera::controls::Gamma |
Specify a fixed gamma value. | |
const Control< bool > | libcamera::controls::DebugMetadataEnable |
Enable or disable the debug metadata. | |
const Control< int64_t > | libcamera::controls::FrameWallClock |
This timestamp corresponds to the same moment in time as the SensorTimestamp, but is represented as a wall clock time as measured by the CLOCK_REALTIME clock. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
const Control< bool > | libcamera::controls::rpi::StatsOutputEnable |
Toggles the Raspberry Pi IPA to output the hardware generated statistics. | |
const Control< Span< const uint8_t > > | libcamera::controls::rpi::Bcm2835StatsOutput |
Span of the BCM2835 ISP generated statistics for the current frame. | |
const Control< Span< const Rectangle > > | libcamera::controls::rpi::ScalerCrops |
An array of rectangles, where each singular value has identical functionality to the ScalerCrop control. This control allows the Raspberry Pi pipeline handler to control individual scaler crops per output stream. | |
const Control< Span< const uint8_t > > | libcamera::controls::rpi::PispStatsOutput |
Span of the PiSP Frontend ISP generated statistics for the current frame. This is sent in the Request metadata if the StatsOutputEnable is set to true. The statistics struct definition can be found in https://github.com/raspberrypi/libpisp/blob/main/src/libpisp/frontend/pisp_statistics.h. | |
const Control< Span< const float > > | libcamera::controls::rpi::CnnOutputTensor |
This control returns a span of floating point values that represent the output tensors from a Convolutional Neural Network (CNN). The size and format of this array of values is entirely dependent on the neural network used, and further post-processing may need to be performed at the application level to generate the final desired output. This control is agnostic of the hardware or software used to generate the output tensors. | |
const Control< Span< const uint8_t > > | libcamera::controls::rpi::CnnOutputTensorInfo |
This control returns the structure of the CnnOutputTensor. This structure takes the following form: | |
const Control< bool > | libcamera::controls::rpi::CnnEnableInputTensor |
Boolean to control if the IPA returns the input tensor used by the CNN to generate the output tensors via the CnnInputTensor control. Because the input tensor may be relatively large, for efficiency reason avoid enabling input tensor output unless required for debugging purposes. | |
const Control< Span< const uint8_t > > | libcamera::controls::rpi::CnnInputTensor |
This control returns a span of uint8_t pixel values that represent the input tensor for a Convolutional Neural Network (CNN). The size and format of this array of values is entirely dependent on the neural network used, and further post-processing (e.g. pixel normalisations) may need to be performed at the application level to generate the final input image. | |
const Control< Span< const uint8_t > > | libcamera::controls::rpi::CnnInputTensorInfo |
This control returns the structure of the CnnInputTensor. This structure takes the following form: | |
const Control< Span< const int32_t, 2 > > | libcamera::controls::rpi::CnnKpiInfo |
This control returns performance metrics for the CNN processing stage. Two values are returned in this span, the runtime of the CNN/DNN stage and the DSP stage in milliseconds. | |
const std::array< const ControlValue, 3 > | libcamera::controls::rpi::SyncModeValues |
List of all SyncMode supported values. | |
const std::map< std::string, int32_t > | libcamera::controls::rpi::SyncModeNameValueMap |
Map of all SyncMode supported value names (in std::string format) to value. | |
const Control< int32_t > | libcamera::controls::rpi::SyncMode |
Enable or disable camera synchronisation ("sync") mode. | |
const Control< bool > | libcamera::controls::rpi::SyncReady |
When using the camera synchronisation algorithm, the server broadcasts timing information to the clients. This also includes the time (some number of frames in the future, called the "ready time") at which the server will signal its controlling application, using this control, to start using the image frames. | |
const Control< int64_t > | libcamera::controls::rpi::SyncTimer |
This reports the amount of time, in microseconds, until the "ready
time", at which the server and client will signal their controlling applications that the frames are now synchronised and should be used. The value may be refined slightly over time, becoming more precise as the "ready time" approaches. | |
const Control< int32_t > | libcamera::controls::rpi::SyncFrames |
The number of frames the server should wait, after enabling SyncModeServer, before signalling (via the SyncReady control) that frames should be used. This therefore determines the "ready time" for all synchronised cameras. | |
Camera controls identifiers.