libcamera v0.3.1 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
control_ids.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2019, Google Inc.
4 *
5 * Control ID list
6 *
7 * This file is auto-generated. Do not edit.
8 */
9
10#pragma once
11
12#include <array>
13#include <map>
14#include <stdint.h>
15#include <string>
16
17#include <libcamera/controls.h>
18
19 namespace libcamera {
20
21 namespace controls {
22
23 enum {
24 AE_ENABLE = 1,
25 AE_LOCKED = 2,
26 AE_METERING_MODE = 3,
27 AE_CONSTRAINT_MODE = 4,
28 AE_EXPOSURE_MODE = 5,
29 EXPOSURE_VALUE = 6,
30 EXPOSURE_TIME = 7,
31 ANALOGUE_GAIN = 8,
32 AE_FLICKER_MODE = 9,
33 AE_FLICKER_PERIOD = 10,
34 AE_FLICKER_DETECTED = 11,
35 BRIGHTNESS = 12,
36 CONTRAST = 13,
37 LUX = 14,
38 AWB_ENABLE = 15,
39 AWB_MODE = 16,
40 AWB_LOCKED = 17,
41 COLOUR_GAINS = 18,
42 COLOUR_TEMPERATURE = 19,
43 SATURATION = 20,
44 SENSOR_BLACK_LEVELS = 21,
45 SHARPNESS = 22,
46 FOCUS_FO_M = 23,
47 COLOUR_CORRECTION_MATRIX = 24,
48 SCALER_CROP = 25,
49 DIGITAL_GAIN = 26,
50 FRAME_DURATION = 27,
51 FRAME_DURATION_LIMITS = 28,
52 SENSOR_TEMPERATURE = 29,
53 SENSOR_TIMESTAMP = 30,
54 AF_MODE = 31,
55 AF_RANGE = 32,
56 AF_SPEED = 33,
57 AF_METERING = 34,
58 AF_WINDOWS = 35,
59 AF_TRIGGER = 36,
60 AF_PAUSE = 37,
61 LENS_POSITION = 38,
62 AF_STATE = 39,
63 AF_PAUSE_STATE = 40,
64 HDR_MODE = 41,
65 HDR_CHANNEL = 42,
66 GAMMA = 43,
67};
68
69 extern const Control<bool> AeEnable;
70 extern const Control<bool> AeLocked;
71 enum AeMeteringModeEnum {
72 MeteringCentreWeighted = 0,
73 MeteringSpot = 1,
74 MeteringMatrix = 2,
75 MeteringCustom = 3,
76};
77 extern const std::array<const ControlValue, 4> AeMeteringModeValues;
78 extern const std::map<std::string, int32_t> AeMeteringModeNameValueMap;
79 extern const Control<int32_t> AeMeteringMode;
80 enum AeConstraintModeEnum {
81 ConstraintNormal = 0,
82 ConstraintHighlight = 1,
83 ConstraintShadows = 2,
84 ConstraintCustom = 3,
85};
86 extern const std::array<const ControlValue, 4> AeConstraintModeValues;
87 extern const std::map<std::string, int32_t> AeConstraintModeNameValueMap;
88 extern const Control<int32_t> AeConstraintMode;
89 enum AeExposureModeEnum {
90 ExposureNormal = 0,
91 ExposureShort = 1,
92 ExposureLong = 2,
93 ExposureCustom = 3,
94};
95 extern const std::array<const ControlValue, 4> AeExposureModeValues;
96 extern const std::map<std::string, int32_t> AeExposureModeNameValueMap;
97 extern const Control<int32_t> AeExposureMode;
98 extern const Control<float> ExposureValue;
99 extern const Control<int32_t> ExposureTime;
100 extern const Control<float> AnalogueGain;
101 enum AeFlickerModeEnum {
102 FlickerOff = 0,
103 FlickerManual = 1,
104 FlickerAuto = 2,
105};
106 extern const std::array<const ControlValue, 3> AeFlickerModeValues;
107 extern const std::map<std::string, int32_t> AeFlickerModeNameValueMap;
108 extern const Control<int32_t> AeFlickerMode;
109 extern const Control<int32_t> AeFlickerPeriod;
110 extern const Control<int32_t> AeFlickerDetected;
111 extern const Control<float> Brightness;
112 extern const Control<float> Contrast;
113 extern const Control<float> Lux;
114 extern const Control<bool> AwbEnable;
115 enum AwbModeEnum {
116 AwbAuto = 0,
117 AwbIncandescent = 1,
118 AwbTungsten = 2,
119 AwbFluorescent = 3,
120 AwbIndoor = 4,
121 AwbDaylight = 5,
122 AwbCloudy = 6,
123 AwbCustom = 7,
124};
125 extern const std::array<const ControlValue, 8> AwbModeValues;
126 extern const std::map<std::string, int32_t> AwbModeNameValueMap;
127 extern const Control<int32_t> AwbMode;
128 extern const Control<bool> AwbLocked;
129 extern const Control<Span<const float, 2>> ColourGains;
130 extern const Control<int32_t> ColourTemperature;
131 extern const Control<float> Saturation;
132 extern const Control<Span<const int32_t, 4>> SensorBlackLevels;
133 extern const Control<float> Sharpness;
134 extern const Control<int32_t> FocusFoM;
135 extern const Control<Span<const float, 9>> ColourCorrectionMatrix;
136 extern const Control<Rectangle> ScalerCrop;
137 extern const Control<float> DigitalGain;
138 extern const Control<int64_t> FrameDuration;
139 extern const Control<Span<const int64_t, 2>> FrameDurationLimits;
140 extern const Control<float> SensorTemperature;
141 extern const Control<int64_t> SensorTimestamp;
142 enum AfModeEnum {
143 AfModeManual = 0,
144 AfModeAuto = 1,
145 AfModeContinuous = 2,
146};
147 extern const std::array<const ControlValue, 3> AfModeValues;
148 extern const std::map<std::string, int32_t> AfModeNameValueMap;
149 extern const Control<int32_t> AfMode;
150 enum AfRangeEnum {
151 AfRangeNormal = 0,
152 AfRangeMacro = 1,
153 AfRangeFull = 2,
154};
155 extern const std::array<const ControlValue, 3> AfRangeValues;
156 extern const std::map<std::string, int32_t> AfRangeNameValueMap;
157 extern const Control<int32_t> AfRange;
158 enum AfSpeedEnum {
159 AfSpeedNormal = 0,
160 AfSpeedFast = 1,
161};
162 extern const std::array<const ControlValue, 2> AfSpeedValues;
163 extern const std::map<std::string, int32_t> AfSpeedNameValueMap;
164 extern const Control<int32_t> AfSpeed;
165 enum AfMeteringEnum {
166 AfMeteringAuto = 0,
167 AfMeteringWindows = 1,
168};
169 extern const std::array<const ControlValue, 2> AfMeteringValues;
170 extern const std::map<std::string, int32_t> AfMeteringNameValueMap;
171 extern const Control<int32_t> AfMetering;
172 extern const Control<Span<const Rectangle>> AfWindows;
173 enum AfTriggerEnum {
174 AfTriggerStart = 0,
175 AfTriggerCancel = 1,
176};
177 extern const std::array<const ControlValue, 2> AfTriggerValues;
178 extern const std::map<std::string, int32_t> AfTriggerNameValueMap;
179 extern const Control<int32_t> AfTrigger;
180 enum AfPauseEnum {
181 AfPauseImmediate = 0,
182 AfPauseDeferred = 1,
183 AfPauseResume = 2,
184};
185 extern const std::array<const ControlValue, 3> AfPauseValues;
186 extern const std::map<std::string, int32_t> AfPauseNameValueMap;
187 extern const Control<int32_t> AfPause;
188 extern const Control<float> LensPosition;
189 enum AfStateEnum {
190 AfStateIdle = 0,
191 AfStateScanning = 1,
192 AfStateFocused = 2,
193 AfStateFailed = 3,
194};
195 extern const std::array<const ControlValue, 4> AfStateValues;
196 extern const std::map<std::string, int32_t> AfStateNameValueMap;
197 extern const Control<int32_t> AfState;
198 enum AfPauseStateEnum {
199 AfPauseStateRunning = 0,
200 AfPauseStatePausing = 1,
201 AfPauseStatePaused = 2,
202};
203 extern const std::array<const ControlValue, 3> AfPauseStateValues;
204 extern const std::map<std::string, int32_t> AfPauseStateNameValueMap;
205 extern const Control<int32_t> AfPauseState;
206 enum HdrModeEnum {
207 HdrModeOff = 0,
208 HdrModeMultiExposureUnmerged = 1,
209 HdrModeMultiExposure = 2,
210 HdrModeSingleExposure = 3,
211 HdrModeNight = 4,
212};
213 extern const std::array<const ControlValue, 5> HdrModeValues;
214 extern const std::map<std::string, int32_t> HdrModeNameValueMap;
215 extern const Control<int32_t> HdrMode;
216 enum HdrChannelEnum {
217 HdrChannelNone = 0,
218 HdrChannelShort = 1,
219 HdrChannelMedium = 2,
220 HdrChannelLong = 3,
221};
222 extern const std::array<const ControlValue, 4> HdrChannelValues;
223 extern const std::map<std::string, int32_t> HdrChannelNameValueMap;
224 extern const Control<int32_t> HdrChannel;
225 extern const Control<float> Gamma;
226
227 extern const ControlIdMap controls;
228
229
230 namespace draft {
231
232#define LIBCAMERA_HAS_DRAFT_VENDOR_CONTROLS
233
234 enum {
235 AE_PRECAPTURE_TRIGGER = 10001,
236 NOISE_REDUCTION_MODE = 10002,
237 COLOR_CORRECTION_ABERRATION_MODE = 10003,
238 AE_STATE = 10004,
239 AWB_STATE = 10005,
240 SENSOR_ROLLING_SHUTTER_SKEW = 10006,
241 LENS_SHADING_MAP_MODE = 10007,
242 PIPELINE_DEPTH = 10008,
243 MAX_LATENCY = 10009,
244 TEST_PATTERN_MODE = 10010,
245};
246
247 enum AePrecaptureTriggerEnum {
248 AePrecaptureTriggerIdle = 0,
249 AePrecaptureTriggerStart = 1,
250 AePrecaptureTriggerCancel = 2,
251};
252 extern const std::array<const ControlValue, 3> AePrecaptureTriggerValues;
253 extern const std::map<std::string, int32_t> AePrecaptureTriggerNameValueMap;
254 extern const Control<int32_t> AePrecaptureTrigger;
255 enum NoiseReductionModeEnum {
256 NoiseReductionModeOff = 0,
257 NoiseReductionModeFast = 1,
258 NoiseReductionModeHighQuality = 2,
259 NoiseReductionModeMinimal = 3,
260 NoiseReductionModeZSL = 4,
261};
262 extern const std::array<const ControlValue, 5> NoiseReductionModeValues;
263 extern const std::map<std::string, int32_t> NoiseReductionModeNameValueMap;
264 extern const Control<int32_t> NoiseReductionMode;
265 enum ColorCorrectionAberrationModeEnum {
266 ColorCorrectionAberrationOff = 0,
267 ColorCorrectionAberrationFast = 1,
268 ColorCorrectionAberrationHighQuality = 2,
269};
270 extern const std::array<const ControlValue, 3> ColorCorrectionAberrationModeValues;
271 extern const std::map<std::string, int32_t> ColorCorrectionAberrationModeNameValueMap;
272 extern const Control<int32_t> ColorCorrectionAberrationMode;
273 enum AeStateEnum {
274 AeStateInactive = 0,
275 AeStateSearching = 1,
276 AeStateConverged = 2,
277 AeStateLocked = 3,
278 AeStateFlashRequired = 4,
279 AeStatePrecapture = 5,
280};
281 extern const std::array<const ControlValue, 6> AeStateValues;
282 extern const std::map<std::string, int32_t> AeStateNameValueMap;
283 extern const Control<int32_t> AeState;
284 enum AwbStateEnum {
285 AwbStateInactive = 0,
286 AwbStateSearching = 1,
287 AwbConverged = 2,
288 AwbLocked = 3,
289};
290 extern const std::array<const ControlValue, 4> AwbStateValues;
291 extern const std::map<std::string, int32_t> AwbStateNameValueMap;
292 extern const Control<int32_t> AwbState;
293 extern const Control<int64_t> SensorRollingShutterSkew;
294 enum LensShadingMapModeEnum {
295 LensShadingMapModeOff = 0,
296 LensShadingMapModeOn = 1,
297};
298 extern const std::array<const ControlValue, 2> LensShadingMapModeValues;
299 extern const std::map<std::string, int32_t> LensShadingMapModeNameValueMap;
300 extern const Control<int32_t> LensShadingMapMode;
301 extern const Control<int32_t> PipelineDepth;
302 extern const Control<int32_t> MaxLatency;
303 enum TestPatternModeEnum {
304 TestPatternModeOff = 0,
305 TestPatternModeSolidColor = 1,
306 TestPatternModeColorBars = 2,
307 TestPatternModeColorBarsFadeToGray = 3,
308 TestPatternModePn9 = 4,
309 TestPatternModeCustom1 = 256,
310};
311 extern const std::array<const ControlValue, 6> TestPatternModeValues;
312 extern const std::map<std::string, int32_t> TestPatternModeNameValueMap;
313 extern const Control<int32_t> TestPatternMode;
314
315} /* namespace draft */
316
317
318 namespace rpi {
319
320#define LIBCAMERA_HAS_RPI_VENDOR_CONTROLS
321
322 enum {
323 STATS_OUTPUT_ENABLE = 20001,
324 BCM2835_STATS_OUTPUT = 20002,
325};
326
327 extern const Control<bool> StatsOutputEnable;
328 extern const Control<Span<const uint8_t>> Bcm2835StatsOutput;
329
330} /* namespace rpi */
331
332
333} /* namespace controls */
334
335} /* namespace libcamera */
libcamera::Control
Describe a control and its intrinsic properties.
Definition controls.h:255
controls.h
Framework to manage controls related to an object.
libcamera::controls::draft::NoiseReductionMode
const Control< int32_t > NoiseReductionMode
Control to select the noise reduction algorithm mode. Currently identical to ANDROID_NOISE_REDUCTION_...
libcamera::controls::draft::TestPatternMode
const Control< int32_t > TestPatternMode
Control to select the test pattern mode. Currently identical to ANDROID_SENSOR_TEST_PATTERN_MODE.
libcamera::controls::draft::AwbStateValues
const std::array< const ControlValue, 4 > AwbStateValues
List of all AwbState supported values.
libcamera::controls::draft::LensShadingMapModeNameValueMap
const std::map< std::string, int32_t > LensShadingMapModeNameValueMap
Map of all LensShadingMapMode supported value names (in std::string format) to value.
libcamera::controls::draft::AeStateEnum
AeStateEnum
Supported AeState values.
Definition control_ids.h:273
libcamera::controls::draft::AeStateLocked
@ AeStateLocked
The AE algorithm is locked.
Definition control_ids.h:277
libcamera::controls::draft::AeStateInactive
@ AeStateInactive
The AE algorithm is inactive.
Definition control_ids.h:274
libcamera::controls::draft::AeStateFlashRequired
@ AeStateFlashRequired
The AE algorithm would need a flash for good results.
Definition control_ids.h:278
libcamera::controls::draft::AeStateSearching
@ AeStateSearching
The AE algorithm has not converged yet.
Definition control_ids.h:275
libcamera::controls::draft::AeStatePrecapture
@ AeStatePrecapture
The AE algorithm has started a pre-capture metering session.
Definition control_ids.h:279
libcamera::controls::draft::AeStateConverged
@ AeStateConverged
The AE algorithm has converged.
Definition control_ids.h:276
libcamera::controls::draft::NoiseReductionModeEnum
NoiseReductionModeEnum
Supported NoiseReductionMode values.
Definition control_ids.h:255
libcamera::controls::draft::NoiseReductionModeHighQuality
@ NoiseReductionModeHighQuality
High quality noise reduction at the expense of frame rate.
Definition control_ids.h:258
libcamera::controls::draft::NoiseReductionModeMinimal
@ NoiseReductionModeMinimal
Minimal noise reduction is applied without reducing the frame rate.
Definition control_ids.h:259
libcamera::controls::draft::NoiseReductionModeOff
@ NoiseReductionModeOff
No noise reduction is applied.
Definition control_ids.h:256
libcamera::controls::draft::NoiseReductionModeZSL
@ NoiseReductionModeZSL
Noise reduction is applied at different levels to different streams.
Definition control_ids.h:260
libcamera::controls::draft::NoiseReductionModeFast
@ NoiseReductionModeFast
Noise reduction is applied without reducing the frame rate.
Definition control_ids.h:257
libcamera::controls::draft::AwbStateEnum
AwbStateEnum
Supported AwbState values.
Definition control_ids.h:284
libcamera::controls::draft::AwbConverged
@ AwbConverged
The AWB algorithm has converged.
Definition control_ids.h:287
libcamera::controls::draft::AwbStateSearching
@ AwbStateSearching
The AWB algorithm has not converged yet.
Definition control_ids.h:286
libcamera::controls::draft::AwbStateInactive
@ AwbStateInactive
The AWB algorithm is inactive.
Definition control_ids.h:285
libcamera::controls::draft::AwbLocked
@ AwbLocked
The AWB algorithm is locked.
Definition control_ids.h:288
libcamera::controls::draft::AwbState
const Control< int32_t > AwbState
Control to report the current AWB algorithm state. Currently identical to ANDROID_CONTROL_AWB_STATE.
libcamera::controls::draft::AePrecaptureTriggerValues
const std::array< const ControlValue, 3 > AePrecaptureTriggerValues
List of all AePrecaptureTrigger supported values.
libcamera::controls::draft::LensShadingMapMode
const Control< int32_t > LensShadingMapMode
Control to report if the lens shading map is available. Currently identical to ANDROID_STATISTICS_LEN...
libcamera::controls::draft::ColorCorrectionAberrationMode
const Control< int32_t > ColorCorrectionAberrationMode
Control to select the color correction aberration mode. Currently identical to ANDROID_COLOR_CORRECTI...
libcamera::controls::draft::AeStateNameValueMap
const std::map< std::string, int32_t > AeStateNameValueMap
Map of all AeState supported value names (in std::string format) to value.
libcamera::controls::draft::TestPatternModeValues
const std::array< const ControlValue, 6 > TestPatternModeValues
List of all TestPatternMode supported values.
libcamera::controls::draft::MaxLatency
const Control< int32_t > MaxLatency
The maximum number of frames that can occur after a request (different than the previous) has been su...
libcamera::controls::draft::ColorCorrectionAberrationModeValues
const std::array< const ControlValue, 3 > ColorCorrectionAberrationModeValues
List of all ColorCorrectionAberrationMode supported values.
libcamera::controls::draft::PipelineDepth
const Control< int32_t > PipelineDepth
Specifies the number of pipeline stages the frame went through from when it was exposed to when the f...
libcamera::controls::draft::LensShadingMapModeEnum
LensShadingMapModeEnum
Supported LensShadingMapMode values.
Definition control_ids.h:294
libcamera::controls::draft::LensShadingMapModeOn
@ LensShadingMapModeOn
The lens shading map mode is available.
Definition control_ids.h:296
libcamera::controls::draft::LensShadingMapModeOff
@ LensShadingMapModeOff
No lens shading map mode is available.
Definition control_ids.h:295
libcamera::controls::draft::NoiseReductionModeValues
const std::array< const ControlValue, 5 > NoiseReductionModeValues
List of all NoiseReductionMode supported values.
libcamera::controls::draft::AeStateValues
const std::array< const ControlValue, 6 > AeStateValues
List of all AeState supported values.
libcamera::controls::draft::ColorCorrectionAberrationModeNameValueMap
const std::map< std::string, int32_t > ColorCorrectionAberrationModeNameValueMap
Map of all ColorCorrectionAberrationMode supported value names (in std::string format) to value.
libcamera::controls::draft::TestPatternModeEnum
TestPatternModeEnum
Supported TestPatternMode values.
Definition control_ids.h:303
libcamera::controls::draft::TestPatternModeSolidColor
@ 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:305
libcamera::controls::draft::TestPatternModeCustom1
@ TestPatternModeCustom1
The first custom test pattern. All custom patterns that are available only on this camera device are ...
Definition control_ids.h:309
libcamera::controls::draft::TestPatternModeOff
@ TestPatternModeOff
No test pattern mode is used. The camera device returns frames from the image sensor.
Definition control_ids.h:304
libcamera::controls::draft::TestPatternModeColorBarsFadeToGray
@ TestPatternModeColorBarsFadeToGray
The test pattern is similar to TestPatternModeColorBars, except that each bar should start at its spe...
Definition control_ids.h:307
libcamera::controls::draft::TestPatternModePn9
@ TestPatternModePn9
All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typical...
Definition control_ids.h:308
libcamera::controls::draft::TestPatternModeColorBars
@ 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:306
libcamera::controls::draft::NoiseReductionModeNameValueMap
const std::map< std::string, int32_t > NoiseReductionModeNameValueMap
Map of all NoiseReductionMode supported value names (in std::string format) to value.
libcamera::controls::draft::AwbStateNameValueMap
const std::map< std::string, int32_t > AwbStateNameValueMap
Map of all AwbState supported value names (in std::string format) to value.
libcamera::controls::draft::AePrecaptureTrigger
const Control< int32_t > AePrecaptureTrigger
Control for AE metering trigger. Currently identical to ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER.
libcamera::controls::draft::TestPatternModeNameValueMap
const std::map< std::string, int32_t > TestPatternModeNameValueMap
Map of all TestPatternMode supported value names (in std::string format) to value.
libcamera::controls::draft::SensorRollingShutterSkew
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...
libcamera::controls::draft::ColorCorrectionAberrationModeEnum
ColorCorrectionAberrationModeEnum
Supported ColorCorrectionAberrationMode values.
Definition control_ids.h:265
libcamera::controls::draft::ColorCorrectionAberrationOff
@ ColorCorrectionAberrationOff
No aberration correction is applied.
Definition control_ids.h:266
libcamera::controls::draft::ColorCorrectionAberrationFast
@ ColorCorrectionAberrationFast
Aberration correction will not slow down the frame rate.
Definition control_ids.h:267
libcamera::controls::draft::ColorCorrectionAberrationHighQuality
@ ColorCorrectionAberrationHighQuality
High quality aberration correction which might reduce the frame rate.
Definition control_ids.h:268
libcamera::controls::draft::AeState
const Control< int32_t > AeState
Control to report the current AE algorithm state. Currently identical to ANDROID_CONTROL_AE_STATE.
libcamera::controls::draft::AePrecaptureTriggerNameValueMap
const std::map< std::string, int32_t > AePrecaptureTriggerNameValueMap
Map of all AePrecaptureTrigger supported value names (in std::string format) to value.
libcamera::controls::draft::LensShadingMapModeValues
const std::array< const ControlValue, 2 > LensShadingMapModeValues
List of all LensShadingMapMode supported values.
libcamera::controls::draft::AePrecaptureTriggerEnum
AePrecaptureTriggerEnum
Supported AePrecaptureTrigger values.
Definition control_ids.h:247
libcamera::controls::draft::AePrecaptureTriggerIdle
@ AePrecaptureTriggerIdle
The trigger is idle.
Definition control_ids.h:248
libcamera::controls::draft::AePrecaptureTriggerStart
@ AePrecaptureTriggerStart
The pre-capture AE metering is started by the camera.
Definition control_ids.h:249
libcamera::controls::draft::AePrecaptureTriggerCancel
@ AePrecaptureTriggerCancel
The camera will cancel any active or completed metering sequence. The AE algorithm is reset to its in...
Definition control_ids.h:250
libcamera::controls::rpi::Bcm2835StatsOutput
const Control< Span< const uint8_t > > Bcm2835StatsOutput
Span of the BCM2835 ISP generated statistics for the current frame. This is sent in the Request metad...
libcamera::controls::rpi::StatsOutputEnable
const Control< bool > StatsOutputEnable
Toggles the Raspberry Pi IPA to output a binary dump of the hardware generated statistics through the...
libcamera::controls::AfRange
const Control< int32_t > AfRange
Control to set the range of focus distances that is scanned. An implementation may choose not to impl...
libcamera::controls::AfState
const Control< int32_t > AfState
Reports the current state of the AF algorithm in conjunction with the reported AfMode value and (in c...
libcamera::controls::AnalogueGain
const Control< float > AnalogueGain
Analogue gain value applied in the sensor device. The value of the control specifies the gain multipl...
libcamera::controls::AfRangeValues
const std::array< const ControlValue, 3 > AfRangeValues
List of all AfRange supported values.
libcamera::controls::Saturation
const Control< float > Saturation
Specify a fixed saturation parameter. Normal saturation is given by the value 1.0; larger values prod...
libcamera::controls::AfSpeedValues
const std::array< const ControlValue, 2 > AfSpeedValues
List of all AfSpeed supported values.
libcamera::controls::ExposureTime
const Control< int32_t > ExposureTime
Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in ...
libcamera::controls::ScalerCrop
const Control< Rectangle > ScalerCrop
Sets the image portion that will be scaled to form the whole of the final output image....
libcamera::controls::HdrChannel
const Control< int32_t > HdrChannel
This value is reported back to the application so that it can discover whether this capture correspon...
libcamera::controls::AfModeEnum
AfModeEnum
Supported AfMode values.
Definition control_ids.h:142
libcamera::controls::AfModeAuto
@ AfModeAuto
The AF algorithm is in auto mode. This means that the algorithm will never move the lens or change st...
Definition control_ids.h:144
libcamera::controls::AfModeContinuous
@ AfModeContinuous
The AF algorithm is in continuous mode. This means that the lens can re-start a scan spontaneously at...
Definition control_ids.h:145
libcamera::controls::AfModeManual
@ AfModeManual
The AF algorithm is in manual mode. In this mode it will never perform any action nor move the lens o...
Definition control_ids.h:143
libcamera::controls::AfPauseEnum
AfPauseEnum
Supported AfPause values.
Definition control_ids.h:180
libcamera::controls::AfPauseImmediate
@ AfPauseImmediate
Pause the continuous autofocus algorithm immediately, whether or not any kind of scan is underway....
Definition control_ids.h:181
libcamera::controls::AfPauseResume
@ AfPauseResume
Resume continuous autofocus operation. The algorithm starts again from exactly where it left off,...
Definition control_ids.h:183
libcamera::controls::AfPauseDeferred
@ AfPauseDeferred
This is similar to AfPauseImmediate, and if the AfState is currently reporting AfStateFocused or AfSt...
Definition control_ids.h:182
libcamera::controls::AfWindows
const Control< Span< const Rectangle > > AfWindows
Sets the focus windows used by the AF algorithm when AfMetering is set to AfMeteringWindows....
libcamera::controls::AeFlickerModeValues
const std::array< const ControlValue, 3 > AeFlickerModeValues
List of all AeFlickerMode supported values.
libcamera::controls::AfTriggerValues
const std::array< const ControlValue, 2 > AfTriggerValues
List of all AfTrigger supported values.
libcamera::controls::AfModeValues
const std::array< const ControlValue, 3 > AfModeValues
List of all AfMode supported values.
libcamera::controls::AeMeteringModeValues
const std::array< const ControlValue, 4 > AeMeteringModeValues
List of all AeMeteringMode supported values.
libcamera::controls::AfPauseValues
const std::array< const ControlValue, 3 > AfPauseValues
List of all AfPause supported values.
libcamera::controls::AwbEnable
const Control< bool > AwbEnable
Enable or disable the AWB.
libcamera::controls::AfTriggerEnum
AfTriggerEnum
Supported AfTrigger values.
Definition control_ids.h:173
libcamera::controls::AfTriggerCancel
@ AfTriggerCancel
Cancel an AF scan. This does not cause the lens to move anywhere else. Ignored if no scan is in progr...
Definition control_ids.h:175
libcamera::controls::AfTriggerStart
@ AfTriggerStart
Start an AF scan. Ignored if a scan is in progress.
Definition control_ids.h:174
libcamera::controls::AfMeteringNameValueMap
const std::map< std::string, int32_t > AfMeteringNameValueMap
Map of all AfMetering supported value names (in std::string format) to value.
libcamera::controls::AwbMode
const Control< int32_t > AwbMode
Specify the range of illuminants to use for the AWB algorithm. The modes supported are platform speci...
libcamera::controls::ExposureValue
const Control< float > ExposureValue
Specify an Exposure Value (EV) parameter. The EV parameter will only be applied if the AE algorithm i...
libcamera::controls::AfPause
const Control< int32_t > AfPause
This control has no effect except when in continuous autofocus mode (AfModeContinuous)....
libcamera::controls::LensPosition
const Control< float > LensPosition
Acts as a control to instruct the lens to move to a particular position and also reports back the pos...
libcamera::controls::AfStateEnum
AfStateEnum
Supported AfState values.
Definition control_ids.h:189
libcamera::controls::AfStateScanning
@ AfStateScanning
The AF algorithm is in auto mode (AfModeAuto), and a scan has been started using the AfTrigger contro...
Definition control_ids.h:191
libcamera::controls::AfStateIdle
@ AfStateIdle
The AF algorithm is in manual mode (AfModeManual) or in auto mode (AfModeAuto) and a scan has not yet...
Definition control_ids.h:190
libcamera::controls::AfStateFailed
@ AfStateFailed
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition control_ids.h:193
libcamera::controls::AfStateFocused
@ AfStateFocused
The AF algorithm is in auto (AfModeAuto) or continuous (AfModeContinuous) mode and a scan has complet...
Definition control_ids.h:192
libcamera::controls::AfStateValues
const std::array< const ControlValue, 4 > AfStateValues
List of all AfState supported values.
libcamera::controls::AeExposureModeValues
const std::array< const ControlValue, 4 > AeExposureModeValues
List of all AeExposureMode supported values.
libcamera::controls::AfMeteringValues
const std::array< const ControlValue, 2 > AfMeteringValues
List of all AfMetering supported values.
libcamera::controls::AeMeteringModeNameValueMap
const std::map< std::string, int32_t > AeMeteringModeNameValueMap
Map of all AeMeteringMode supported value names (in std::string format) to value.
libcamera::controls::AeExposureMode
const Control< int32_t > AeExposureMode
Specify an exposure mode for the AE algorithm to use. These specify how the desired total exposure is...
libcamera::controls::AeFlickerPeriod
const Control< int32_t > AeFlickerPeriod
Manual flicker period in microseconds. This value sets the current flicker period to avoid....
libcamera::controls::AfSpeed
const Control< int32_t > AfSpeed
Control that determines whether the AF algorithm is to move the lens as quickly as possible or more s...
libcamera::controls::SensorTemperature
const Control< float > SensorTemperature
Temperature measure from the camera sensor in Celsius. This is typically obtained by a thermal sensor...
libcamera::controls::HdrModeEnum
HdrModeEnum
Supported HdrMode values.
Definition control_ids.h:206
libcamera::controls::HdrModeNight
@ HdrModeNight
Multiple frames will be combined to produce "night mode" images. It is up to the implementation exact...
Definition control_ids.h:211
libcamera::controls::HdrModeSingleExposure
@ HdrModeSingleExposure
Multiple frames all at a single exposure will be used to create HDR images. These images should be re...
Definition control_ids.h:210
libcamera::controls::HdrModeMultiExposureUnmerged
@ HdrModeMultiExposureUnmerged
Multiple exposures will be generated in an alternating fashion. However, they will not be merged toge...
Definition control_ids.h:208
libcamera::controls::HdrModeMultiExposure
@ HdrModeMultiExposure
Multiple exposures will be generated and merged to create HDR images. Each image will be tagged with ...
Definition control_ids.h:209
libcamera::controls::HdrModeOff
@ HdrModeOff
HDR is disabled. Metadata for this frame will not include the HdrChannel control.
Definition control_ids.h:207
libcamera::controls::AeFlickerModeNameValueMap
const std::map< std::string, int32_t > AeFlickerModeNameValueMap
Map of all AeFlickerMode supported value names (in std::string format) to value.
libcamera::controls::ColourGains
const Control< Span< const float, 2 > > ColourGains
Pair of gain values for the Red and Blue colour channels, in that order. ColourGains can only be appl...
libcamera::controls::AfMode
const Control< int32_t > AfMode
Control to set the mode of the AF (autofocus) algorithm.
libcamera::controls::AeConstraintMode
const Control< int32_t > AeConstraintMode
Specify a constraint mode for the AE algorithm to use. These determine how the measured scene brightn...
libcamera::controls::FocusFoM
const Control< int32_t > FocusFoM
Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. A larger FocusFoM value indica...
libcamera::controls::AwbModeEnum
AwbModeEnum
Supported AwbMode values.
Definition control_ids.h:115
libcamera::controls::AwbIncandescent
@ AwbIncandescent
Incandescent AWB lamp mode.
Definition control_ids.h:117
libcamera::controls::AwbDaylight
@ AwbDaylight
Daylight AWB lighting mode.
Definition control_ids.h:121
libcamera::controls::AwbAuto
@ AwbAuto
Search over the whole colour temperature range.
Definition control_ids.h:116
libcamera::controls::AwbTungsten
@ AwbTungsten
Tungsten AWB lamp mode.
Definition control_ids.h:118
libcamera::controls::AwbIndoor
@ AwbIndoor
Indoor AWB lighting mode.
Definition control_ids.h:120
libcamera::controls::AwbFluorescent
@ AwbFluorescent
Fluorescent AWB lamp mode.
Definition control_ids.h:119
libcamera::controls::AwbCloudy
@ AwbCloudy
Cloudy AWB lighting mode.
Definition control_ids.h:122
libcamera::controls::AwbCustom
@ AwbCustom
Custom AWB mode.
Definition control_ids.h:123
libcamera::controls::AfPauseNameValueMap
const std::map< std::string, int32_t > AfPauseNameValueMap
Map of all AfPause supported value names (in std::string format) to value.
libcamera::controls::controls
const ControlIdMap controls
List of all supported libcamera controls.
Definition controls_ids.cpp:1680
libcamera::controls::HdrModeNameValueMap
const std::map< std::string, int32_t > HdrModeNameValueMap
Map of all HdrMode supported value names (in std::string format) to value.
libcamera::controls::HdrChannelNameValueMap
const std::map< std::string, int32_t > HdrChannelNameValueMap
Map of all HdrChannel supported value names (in std::string format) to value.
libcamera::controls::AfSpeedNameValueMap
const std::map< std::string, int32_t > AfSpeedNameValueMap
Map of all AfSpeed supported value names (in std::string format) to value.
libcamera::controls::AfRangeEnum
AfRangeEnum
Supported AfRange values.
Definition control_ids.h:150
libcamera::controls::AfRangeNormal
@ AfRangeNormal
A wide range of focus distances is scanned, all the way from infinity down to close distances,...
Definition control_ids.h:151
libcamera::controls::AfRangeMacro
@ AfRangeMacro
Only close distances are scanned.
Definition control_ids.h:152
libcamera::controls::AfRangeFull
@ AfRangeFull
The full range of focus distances is scanned just as with AfRangeNormal but this time including the v...
Definition control_ids.h:153
libcamera::controls::AeExposureModeNameValueMap
const std::map< std::string, int32_t > AeExposureModeNameValueMap
Map of all AeExposureMode supported value names (in std::string format) to value.
libcamera::controls::AeFlickerDetected
const Control< int32_t > AeFlickerDetected
Flicker period detected in microseconds. The value reported here indicates the currently detected fli...
libcamera::controls::Sharpness
const Control< float > Sharpness
A value of 0.0 means no sharpening. The minimum value means minimal sharpening, and shall be 0....
libcamera::controls::AfPauseStateValues
const std::array< const ControlValue, 3 > AfPauseStateValues
List of all AfPauseState supported values.
libcamera::controls::AfMetering
const Control< int32_t > AfMetering
Instruct the AF algorithm how it should decide which parts of the image should be used to measure foc...
libcamera::controls::AeMeteringModeEnum
AeMeteringModeEnum
Supported AeMeteringMode values.
Definition control_ids.h:71
libcamera::controls::MeteringSpot
@ MeteringSpot
Spot metering mode.
Definition control_ids.h:73
libcamera::controls::MeteringMatrix
@ MeteringMatrix
Matrix metering mode.
Definition control_ids.h:74
libcamera::controls::MeteringCustom
@ MeteringCustom
Custom metering mode.
Definition control_ids.h:75
libcamera::controls::MeteringCentreWeighted
@ MeteringCentreWeighted
Centre-weighted metering mode.
Definition control_ids.h:72
libcamera::controls::ColourTemperature
const Control< int32_t > ColourTemperature
Report the current estimate of the colour temperature, in kelvin, for this frame. The ColourTemperatu...
libcamera::controls::AeExposureModeEnum
AeExposureModeEnum
Supported AeExposureMode values.
Definition control_ids.h:89
libcamera::controls::ExposureShort
@ ExposureShort
Exposure mode allowing only short exposure times.
Definition control_ids.h:91
libcamera::controls::ExposureNormal
@ ExposureNormal
Default exposure mode.
Definition control_ids.h:90
libcamera::controls::ExposureCustom
@ ExposureCustom
Custom exposure mode.
Definition control_ids.h:93
libcamera::controls::ExposureLong
@ ExposureLong
Exposure mode allowing long exposure times.
Definition control_ids.h:92
libcamera::controls::AwbLocked
const Control< bool > AwbLocked
Report the lock status of a running AWB algorithm.
libcamera::controls::AeFlickerMode
const Control< int32_t > AeFlickerMode
Set the flicker mode, which determines whether, and how, the AGC/AEC algorithm attempts to hide flick...
libcamera::controls::Brightness
const Control< float > Brightness
Specify a fixed brightness parameter. Positive values (up to 1.0) produce brighter images; negative v...
libcamera::controls::AfPauseStateNameValueMap
const std::map< std::string, int32_t > AfPauseStateNameValueMap
Map of all AfPauseState supported value names (in std::string format) to value.
libcamera::controls::Lux
const Control< float > Lux
Report an estimate of the current illuminance level in lux. The Lux control can only be returned in m...
libcamera::controls::AeConstraintModeValues
const std::array< const ControlValue, 4 > AeConstraintModeValues
List of all AeConstraintMode supported values.
libcamera::controls::AfStateNameValueMap
const std::map< std::string, int32_t > AfStateNameValueMap
Map of all AfState supported value names (in std::string format) to value.
libcamera::controls::DigitalGain
const Control< float > DigitalGain
Digital gain value applied during the processing steps applied to the image as captured from the sens...
libcamera::controls::AfModeNameValueMap
const std::map< std::string, int32_t > AfModeNameValueMap
Map of all AfMode supported value names (in std::string format) to value.
libcamera::controls::AfMeteringEnum
AfMeteringEnum
Supported AfMetering values.
Definition control_ids.h:165
libcamera::controls::AfMeteringWindows
@ AfMeteringWindows
The AF algorithm should use the rectangles defined by the AfWindows control to measure focus....
Definition control_ids.h:167
libcamera::controls::AfMeteringAuto
@ AfMeteringAuto
The AF algorithm should decide for itself where it will measure focus.
Definition control_ids.h:166
libcamera::controls::AfSpeedEnum
AfSpeedEnum
Supported AfSpeed values.
Definition control_ids.h:158
libcamera::controls::AfSpeedFast
@ AfSpeedFast
Move the lens more quickly.
Definition control_ids.h:160
libcamera::controls::AfSpeedNormal
@ AfSpeedNormal
Move the lens at its usual speed.
Definition control_ids.h:159
libcamera::controls::AwbModeNameValueMap
const std::map< std::string, int32_t > AwbModeNameValueMap
Map of all AwbMode supported value names (in std::string format) to value.
libcamera::controls::AfTrigger
const Control< int32_t > AfTrigger
This control starts an autofocus scan when AfMode is set to AfModeAuto, and can also be used to termi...
libcamera::controls::AeConstraintModeEnum
AeConstraintModeEnum
Supported AeConstraintMode values.
Definition control_ids.h:80
libcamera::controls::ConstraintHighlight
@ ConstraintHighlight
Highlight constraint mode. This mode adjusts the exposure levels in order to try and avoid over-expos...
Definition control_ids.h:82
libcamera::controls::ConstraintCustom
@ ConstraintCustom
Custom constraint mode.
Definition control_ids.h:84
libcamera::controls::ConstraintNormal
@ ConstraintNormal
Default constraint mode. This mode aims to balance the exposure of different parts of the image so as...
Definition control_ids.h:81
libcamera::controls::ConstraintShadows
@ ConstraintShadows
Shadows constraint mode. This mode adjusts the exposure levels in order to try and avoid under-exposi...
Definition control_ids.h:83
libcamera::controls::AeLocked
const Control< bool > AeLocked
Report the lock status of a running AE algorithm.
libcamera::controls::SensorBlackLevels
const Control< Span< const int32_t, 4 > > SensorBlackLevels
Reports the sensor black levels used for processing a frame, in the order R, Gr, Gb,...
libcamera::controls::AfPauseState
const Control< int32_t > AfPauseState
Only applicable in continuous (AfModeContinuous) mode, this reports whether the algorithm is currentl...
libcamera::controls::HdrModeValues
const std::array< const ControlValue, 5 > HdrModeValues
List of all HdrMode supported values.
libcamera::controls::HdrMode
const Control< int32_t > HdrMode
Control to set the mode to be used for High Dynamic Range (HDR) imaging. HDR techniques typically inc...
libcamera::controls::Gamma
const Control< float > Gamma
Specify a fixed gamma value. Default must be 2.2 which closely mimics sRGB gamma. Note that this is c...
libcamera::controls::AeConstraintModeNameValueMap
const std::map< std::string, int32_t > AeConstraintModeNameValueMap
Map of all AeConstraintMode supported value names (in std::string format) to value.
libcamera::controls::AeMeteringMode
const Control< int32_t > AeMeteringMode
Specify a metering mode for the AE algorithm to use. The metering modes determine which parts of the ...
libcamera::controls::HdrChannelEnum
HdrChannelEnum
Supported HdrChannel values.
Definition control_ids.h:216
libcamera::controls::HdrChannelShort
@ HdrChannelShort
This is a short exposure image.
Definition control_ids.h:218
libcamera::controls::HdrChannelLong
@ HdrChannelLong
This is a long exposure image.
Definition control_ids.h:220
libcamera::controls::HdrChannelMedium
@ HdrChannelMedium
This is a medium exposure image.
Definition control_ids.h:219
libcamera::controls::HdrChannelNone
@ HdrChannelNone
This image does not correspond to any of the captures used to create an HDR image.
Definition control_ids.h:217
libcamera::controls::FrameDuration
const Control< int64_t > FrameDuration
The instantaneous frame duration from start of frame exposure to start of next exposure,...
libcamera::controls::AfRangeNameValueMap
const std::map< std::string, int32_t > AfRangeNameValueMap
Map of all AfRange supported value names (in std::string format) to value.
libcamera::controls::FrameDurationLimits
const Control< Span< const int64_t, 2 > > FrameDurationLimits
The minimum and maximum (in that order) frame duration, expressed in microseconds.
libcamera::controls::AeEnable
const Control< bool > AeEnable
Enable or disable the AE.
libcamera::controls::AfTriggerNameValueMap
const std::map< std::string, int32_t > AfTriggerNameValueMap
Map of all AfTrigger supported value names (in std::string format) to value.
libcamera::controls::AfPauseStateEnum
AfPauseStateEnum
Supported AfPauseState values.
Definition control_ids.h:198
libcamera::controls::AfPauseStatePausing
@ AfPauseStatePausing
Continuous AF has been sent an AfPauseDeferred control, and will pause as soon as any in-progress sca...
Definition control_ids.h:200
libcamera::controls::AfPauseStatePaused
@ AfPauseStatePaused
Continuous AF is paused. No further state changes or lens movements will occur until the AfPauseResum...
Definition control_ids.h:201
libcamera::controls::AfPauseStateRunning
@ AfPauseStateRunning
Continuous AF is running and the algorithm may restart a scan spontaneously.
Definition control_ids.h:199
libcamera::controls::Contrast
const Control< float > Contrast
Specify a fixed contrast parameter. Normal contrast is given by the value 1.0; larger values produce ...
libcamera::controls::HdrChannelValues
const std::array< const ControlValue, 4 > HdrChannelValues
List of all HdrChannel supported values.
libcamera::controls::AeFlickerModeEnum
AeFlickerModeEnum
Supported AeFlickerMode values.
Definition control_ids.h:101
libcamera::controls::FlickerAuto
@ FlickerAuto
Automatic flicker period detection and avoidance. The system will automatically determine the most li...
Definition control_ids.h:104
libcamera::controls::FlickerOff
@ FlickerOff
No flicker avoidance is performed.
Definition control_ids.h:102
libcamera::controls::FlickerManual
@ FlickerManual
Manual flicker avoidance. Suppress flicker effects caused by lighting running with a period specified...
Definition control_ids.h:103
libcamera::controls::AwbModeValues
const std::array< const ControlValue, 8 > AwbModeValues
List of all AwbMode supported values.
libcamera::controls::ColourCorrectionMatrix
const Control< Span< const float, 9 > > ColourCorrectionMatrix
The 3x3 matrix that converts camera RGB to sRGB within the imaging pipeline. This should describe the...
libcamera::controls::SensorTimestamp
const Control< int64_t > SensorTimestamp
The time when the first row of the image sensor active array is exposed.
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::ControlIdMap
std::unordered_map< unsigned int, const ControlId * > ControlIdMap
A map of numerical control ID to ControlId.
Definition controls.h:303