1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
|
# SPDX-License-Identifier: LGPL-2.1-or-later
#
# Copyright (C) 2019, Google Inc.
#
%YAML 1.1
---
# Unless otherwise stated, all controls are bi-directional, i.e. they can be
# set through Request::controls() and returned out through Request::metadata().
controls:
- AeEnable:
type: bool
description: |
Enable or disable the AE.
\sa ExposureTime AnalogueGain
- AeLocked:
type: bool
description: |
Report the lock status of a running AE algorithm.
If the AE algorithm is locked the value shall be set to true, if it's
converging it shall be set to false. If the AE algorithm is not
running the control shall not be present in the metadata control list.
\sa AeEnable
# AeMeteringMode needs further attention:
# - Auto-generate max enum value.
# - Better handling of custom types.
- AeMeteringMode:
type: int32_t
description: |
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.
enum:
- name: MeteringCentreWeighted
value: 0
description: Centre-weighted metering mode.
- name: MeteringSpot
value: 1
description: Spot metering mode.
- name: MeteringMatrix
value: 2
description: Matrix metering mode.
- name: MeteringCustom
value: 3
description: Custom metering mode.
# AeConstraintMode needs further attention:
# - Auto-generate max enum value.
# - Better handling of custom types.
- AeConstraintMode:
type: int32_t
description: |
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.
enum:
- name: ConstraintNormal
value: 0
description: Default constraint mode.
This mode aims to balance the exposure of different parts of the
image so as to reach a reasonable average level. However, highlights
in the image may appear over-exposed and lowlights may appear
under-exposed.
- name: ConstraintHighlight
value: 1
description: Highlight constraint mode.
This mode adjusts the exposure levels in order to try and avoid
over-exposing the brightest parts (highlights) of an image.
Other non-highlight parts of the image may appear under-exposed.
- name: ConstraintShadows
value: 2
description: Shadows constraint mode.
This mode adjusts the exposure levels in order to try and avoid
under-exposing the dark parts (shadows) of an image. Other normally
exposed parts of the image may appear over-exposed.
- name: ConstraintCustom
value: 3
description: Custom constraint mode.
# AeExposureMode needs further attention:
# - Auto-generate max enum value.
# - Better handling of custom types.
- AeExposureMode:
type: int32_t
description: |
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.
enum:
- name: ExposureNormal
value: 0
description: Default exposure mode.
- name: ExposureShort
value: 1
description: Exposure mode allowing only short exposure times.
- name: ExposureLong
value: 2
description: Exposure mode allowing long exposure times.
- name: ExposureCustom
value: 3
description: Custom exposure mode.
- ExposureValue:
type: float
description: |
Specify an Exposure Value (EV) parameter. The EV parameter will only be
applied if the AE algorithm is currently enabled.
By convention EV adjusts the exposure as log2. For example
EV = [-2, -1, 0.5, 0, 0.5, 1, 2] results in an exposure adjustment
of [1/4x, 1/2x, 1/sqrt(2)x, 1x, sqrt(2)x, 2x, 4x].
\sa AeEnable
- ExposureTime:
type: int32_t
description: |
Exposure time (shutter speed) for the frame applied in the sensor
device. This value is specified in micro-seconds.
Setting this value means that it is now fixed and the AE algorithm may
not change it. Setting it back to zero returns it to the control of the
AE algorithm.
\sa AnalogueGain AeEnable
\todo Document the interactions between AeEnable and setting a fixed
value for this control. Consider interactions with other AE features,
such as aperture and aperture/shutter priority mode, and decide if
control of which features should be automatically adjusted shouldn't
better be handled through a separate AE mode control.
- AnalogueGain:
type: float
description: |
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.
Setting this value means that it is now fixed and the AE algorithm may
not change it. Setting it back to zero returns it to the control of the
AE algorithm.
\sa ExposureTime AeEnable
\todo Document the interactions between AeEnable and setting a fixed
value for this control. Consider interactions with other AE features,
such as aperture and aperture/shutter priority mode, and decide if
control of which features should be automatically adjusted shouldn't
better be handled through a separate AE mode control.
- AeFlickerMode:
type: int32_t
description: |
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.
Although implementation dependent, many algorithms for "flicker
avoidance" work by restricting this exposure time to integer multiples
of the cycle period, wherever possible.
Implementations may not support all of the flicker modes listed below.
By default the system will start in FlickerAuto mode if this is
supported, otherwise the flicker mode will be set to FlickerOff.
enum:
- name: FlickerOff
value: 0
description: No flicker avoidance is performed.
- name: FlickerManual
value: 1
description: Manual flicker avoidance.
Suppress flicker effects caused by lighting running with a period
specified by the AeFlickerPeriod control.
\sa AeFlickerPeriod
- name: FlickerAuto
value: 2
description: Automatic flicker period detection and avoidance.
The system will automatically determine the most likely value of
flicker period, and avoid flicker of this frequency. Once flicker
is being corrected, it is implementation dependent whether the
system is still able to detect a change in the flicker period.
\sa AeFlickerDetected
- AeFlickerPeriod:
type: int32_t
description: 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.
\sa AeFlickerMode
- AeFlickerDetected:
type: int32_t
description: 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.
\sa AeFlickerMode
- Brightness:
type: float
description: |
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.
- Contrast:
type: float
description: |
Specify a fixed contrast parameter. Normal contrast is given by the
value 1.0; larger values produce images with more contrast.
- Lux:
type: float
description: |
Report an estimate of the current illuminance level in lux. The Lux
control can only be returned in metadata.
- AwbEnable:
type: bool
description: |
Enable or disable the AWB.
\sa ColourGains
# AwbMode needs further attention:
# - Auto-generate max enum value.
# - Better handling of custom types.
- AwbMode:
type: int32_t
description: |
Specify the range of illuminants to use for the AWB algorithm. The modes
supported are platform specific, and not all modes may be supported.
enum:
- name: AwbAuto
value: 0
description: Search over the whole colour temperature range.
- name: AwbIncandescent
value: 1
description: Incandescent AWB lamp mode.
- name: AwbTungsten
value: 2
description: Tungsten AWB lamp mode.
- name: AwbFluorescent
value: 3
description: Fluorescent AWB lamp mode.
- name: AwbIndoor
value: 4
description: Indoor AWB lighting mode.
- name: AwbDaylight
value: 5
description: Daylight AWB lighting mode.
- name: AwbCloudy
value: 6
description: Cloudy AWB lighting mode.
- name: AwbCustom
value: 7
description: Custom AWB mode.
- AwbLocked:
type: bool
description: |
Report the lock status of a running AWB algorithm.
If the AWB algorithm is locked the value shall be set to true, if it's
converging it shall be set to false. If the AWB algorithm is not
running the control shall not be present in the metadata control list.
\sa AwbEnable
- ColourGains:
type: float
description: |
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.
\sa AwbEnable
size: [2]
- ColourTemperature:
type: int32_t
description: Report the current estimate of the colour temperature, in
kelvin, for this frame. The ColourTemperature control can only be
returned in metadata.
- Saturation:
type: float
description: |
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.
- SensorBlackLevels:
type: int32_t
description: |
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.
size: [4]
- Sharpness:
type: float
description: |
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.
- FocusFoM:
type: int32_t
description: |
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.
- ColourCorrectionMatrix:
type: float
description: |
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.
size: [3,3]
- ScalerCrop:
type: Rectangle
description: |
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.
This control is only present when the pipeline supports scaling. Its
maximum valid value is given by the properties::ScalerCropMaximum
property, and the two can be used to implement digital zoom.
- DigitalGain:
type: float
description: |
Digital gain value applied during the processing steps applied
to the image as captured from the sensor.
The global digital gain factor is applied to all the colour channels
of the RAW image. Different pipeline models are free to
specify how the global gain factor applies to each separate
channel.
If an imaging pipeline applies digital gain in distinct
processing steps, this value indicates their total sum.
Pipelines are free to decide how to adjust each processing
step to respect the received gain factor and shall report
their total value in the request metadata.
- FrameDuration:
type: int64_t
description: |
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.
- FrameDurationLimits:
type: int64_t
description: |
The minimum and maximum (in that order) frame duration, expressed in
microseconds.
When provided by applications, the control specifies the sensor frame
duration interval the pipeline has to use. This limits the largest
exposure time the sensor can use. For example, if a maximum frame
duration of 33ms is requested (corresponding to 30 frames per second),
the sensor will not be able to raise the exposure time above 33ms.
A fixed frame duration is achieved by setting the minimum and maximum
values to be the same. Setting both values to 0 reverts to using the
camera defaults.
The maximum frame duration provides the absolute limit to the shutter
speed computed by the AE algorithm and it overrides any exposure mode
setting specified with controls::AeExposureMode. Similarly, when a
manual exposure time is set through controls::ExposureTime, it also
gets clipped to the limits set by this control. When reported in
metadata, the control expresses the minimum and maximum frame
durations used after being clipped to the sensor provided frame
duration limits.
\sa AeExposureMode
\sa ExposureTime
\todo Define how to calculate the capture frame rate by
defining controls to report additional delays introduced by
the capture pipeline or post-processing stages (ie JPEG
conversion, frame scaling).
\todo Provide an explicit definition of default control values, for
this and all other controls.
size: [2]
- SensorTemperature:
type: float
description: |
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.
The SensorTemperature control will only be returned in metadata if a
themal sensor is present.
- SensorTimestamp:
type: int64_t
description: |
The time when the first row of the image sensor active array is exposed.
The timestamp, expressed in nanoseconds, represents a monotonically
increasing counter since the system boot time, as defined by the
Linux-specific CLOCK_BOOTTIME clock id.
The SensorTimestamp control can only be returned in metadata.
\todo Define how the sensor timestamp has to be used in the reprocessing
use case.
- AfMode:
type: int32_t
description: |
Control to set the mode of the AF (autofocus) algorithm.
An implementation may choose not to implement all the modes.
enum:
- name: AfModeManual
value: 0
description: |
The AF algorithm is in manual mode. In this mode it will never
perform any action nor move the lens of its own accord, but an
application can specify the desired lens position using the
LensPosition control.
In this mode the AfState will always report AfStateIdle.
If the camera is started in AfModeManual, it will move the focus
lens to the position specified by the LensPosition control.
This mode is the recommended default value for the AfMode control.
External cameras (as reported by the Location property set to
CameraLocationExternal) may use a different default value.
- name: AfModeAuto
value: 1
description: |
The AF algorithm is in auto mode. This means that the algorithm
will never move the lens or change state unless the AfTrigger
control is used. The AfTrigger control can be used to initiate a
focus scan, the results of which will be reported by AfState.
If the autofocus algorithm is moved from AfModeAuto to another
mode while a scan is in progress, the scan is cancelled
immediately, without waiting for the scan to finish.
When first entering this mode the AfState will report
AfStateIdle. When a trigger control is sent, AfState will
report AfStateScanning for a period before spontaneously
changing to AfStateFocused or AfStateFailed, depending on
the outcome of the scan. It will remain in this state until
another scan is initiated by the AfTrigger control. If a scan is
cancelled (without changing to another mode), AfState will return
to AfStateIdle.
- name: AfModeContinuous
value: 2
description: |
The AF algorithm is in continuous mode. This means that the lens can
re-start a scan spontaneously at any moment, without any user
intervention. The AfState still reports whether the algorithm is
currently scanning or not, though the application has no ability to
initiate or cancel scans, nor to move the lens for itself.
However, applications can pause the AF algorithm from continuously
scanning by using the AfPause control. This allows video or still
images to be captured whilst guaranteeing that the focus is fixed.
When set to AfModeContinuous, the system will immediately initiate a
scan so AfState will report AfStateScanning, and will settle on one
of AfStateFocused or AfStateFailed, depending on the scan result.
- AfRange:
type: int32_t
description: |
Control to set the range of focus distances that is scanned. An
implementation may choose not to implement all the options here.
enum:
- name: AfRangeNormal
value: 0
description: |
A wide range of focus distances is scanned, all the way from
infinity down to close distances, though depending on the
implementation, possibly not including the very closest macro
positions.
- name: AfRangeMacro
value: 1
description: Only close distances are scanned.
- name: AfRangeFull
value: 2
description: |
The full range of focus distances is scanned just as with
AfRangeNormal but this time including the very closest macro
positions.
- AfSpeed:
type: int32_t
description: |
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.
enum:
- name: AfSpeedNormal
value: 0
description: Move the lens at its usual speed.
- name: AfSpeedFast
value: 1
description: Move the lens more quickly.
- AfMetering:
type: int32_t
description: |
Instruct the AF algorithm how it should decide which parts of the image
should be used to measure focus.
enum:
- name: AfMeteringAuto
value: 0
description: The AF algorithm should decide for itself where it will
measure focus.
- name: AfMeteringWindows
value: 1
description: The AF algorithm should use the rectangles defined by
the AfWindows control to measure focus. If no windows are specified
the behaviour is platform dependent.
- AfWindows:
type: Rectangle
description: |
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.
In order to be activated, a rectangle must be programmed with non-zero
width and height. Internally, these rectangles are intersected with the
ScalerCropMaximum rectangle. If the window becomes empty after this
operation, then the window is ignored. If all the windows end up being
ignored, then the behaviour is platform dependent.
On platforms that support the ScalerCrop control (for implementing
digital zoom, for example), no automatic recalculation or adjustment of
AF windows is performed internally if the ScalerCrop is changed. If any
window lies outside the output image after the scaler crop has been
applied, it is up to the application to recalculate them.
The details of how the windows are used are platform dependent. We note
that when there is more than one AF window, a typical implementation
might find the optimal focus position for each one and finally select
the window where the focal distance for the objects shown in that part
of the image are closest to the camera.
size: [n]
- AfTrigger:
type: int32_t
description: |
This control starts an autofocus scan when AfMode is set to AfModeAuto,
and can also be used to terminate a scan early.
It is ignored if AfMode is set to AfModeManual or AfModeContinuous.
enum:
- name: AfTriggerStart
value: 0
description: Start an AF scan. Ignored if a scan is in progress.
- name: AfTriggerCancel
value: 1
description: Cancel an AF scan. This does not cause the lens to move
anywhere else. Ignored if no scan is in progress.
- AfPause:
type: int32_t
description: |
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.
enum:
- name: AfPauseImmediate
value: 0
description: |
Pause the continuous autofocus algorithm immediately, whether or not
any kind of scan is underway. AfPauseState will subsequently report
AfPauseStatePaused. AfState may report any of AfStateScanning,
AfStateFocused or AfStateFailed, depending on the algorithm's state
when it received this control.
- name: AfPauseDeferred
value: 1
description: |
This is similar to AfPauseImmediate, and if the AfState is currently
reporting AfStateFocused or AfStateFailed it will remain in that
state and AfPauseState will report AfPauseStatePaused.
However, if the algorithm is scanning (AfStateScanning),
AfPauseState will report AfPauseStatePausing until the scan is
finished, at which point AfState will report one of AfStateFocused
or AfStateFailed, and AfPauseState will change to
AfPauseStatePaused.
- name: AfPauseResume
value: 2
description: |
Resume continuous autofocus operation. The algorithm starts again
from exactly where it left off, and AfPauseState will report
AfPauseStateRunning.
- LensPosition:
type: float
description: |
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.
The LensPosition control is ignored unless the AfMode is set to
AfModeManual, though the value is reported back unconditionally in all
modes.
This value, which is generally a non-integer, is the reciprocal of the
focal distance in metres, also known as dioptres. That is, to set a
focal distance D, the lens position LP is given by
\f$LP = \frac{1\mathrm{m}}{D}\f$
For example:
0 moves the lens to infinity.
0.5 moves the lens to focus on objects 2m away.
2 moves the lens to focus on objects 50cm away.
And larger values will focus the lens closer.
The default value of the control should indicate a good general position
for the lens, often corresponding to the hyperfocal distance (the
closest position for which objects at infinity are still acceptably
sharp). The minimum will often be zero (meaning infinity), and the
maximum value defines the closest focus position.
\todo Define a property to report the Hyperfocal distance of calibrated
lenses.
- AfState:
type: int32_t
description: |
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.
If the AfMode is set to AfModeManual, then the AfState will always
report AfStateIdle (even if the lens is subsequently moved). Changing to
the AfModeManual state does not initiate any lens movement.
If the AfMode is set to AfModeAuto then the AfState will report
AfStateIdle. However, if AfModeAuto and AfTriggerStart are sent together
then AfState will omit AfStateIdle and move straight to AfStateScanning
(and start a scan).
If the AfMode is set to AfModeContinuous then the AfState will initially
report AfStateScanning.
enum:
- name: AfStateIdle
value: 0
description: |
The AF algorithm is in manual mode (AfModeManual) or in auto mode
(AfModeAuto) and a scan has not yet been triggered, or an
in-progress scan was cancelled.
- name: AfStateScanning
value: 1
description: |
The AF algorithm is in auto mode (AfModeAuto), and a scan has been
started using the AfTrigger control. The scan can be cancelled by
sending AfTriggerCancel at which point the algorithm will either
move back to AfStateIdle or, if the scan actually completes before
the cancel request is processed, to one of AfStateFocused or
AfStateFailed.
Alternatively the AF algorithm could be in continuous mode
(AfModeContinuous) at which point it may enter this state
spontaneously whenever it determines that a rescan is needed.
- name: AfStateFocused
value: 2
description: |
The AF algorithm is in auto (AfModeAuto) or continuous
(AfModeContinuous) mode and a scan has completed with the result
that the algorithm believes the image is now in focus.
- name: AfStateFailed
value: 3
description: |
The AF algorithm is in auto (AfModeAuto) or continuous
(AfModeContinuous) mode and a scan has completed with the result
that the algorithm did not find a good focus position.
- AfPauseState:
type: int32_t
description: |
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).
Any change to AfMode will cause AfPauseStateRunning to be reported.
enum:
- name: AfPauseStateRunning
value: 0
description: |
Continuous AF is running and the algorithm may restart a scan
spontaneously.
- name: AfPauseStatePausing
value: 1
description: |
Continuous AF has been sent an AfPauseDeferred control, and will
pause as soon as any in-progress scan completes (and then report
AfPauseStatePaused). No new scans will be start spontaneously until
the AfPauseResume control is sent.
- name: AfPauseStatePaused
value: 2
description: |
Continuous AF is paused. No further state changes or lens movements
will occur until the AfPauseResume control is sent.
- HdrMode:
type: int32_t
description: |
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.
When using an HDR mode, images are captured with different sets of AGC
settings called HDR channels. Channels indicate in particular the type
of exposure (short, medium or long) used to capture the raw image,
before fusion. Each HDR image is tagged with the corresponding channel
using the HdrChannel control.
\sa HdrChannel
enum:
- name: HdrModeOff
value: 0
description: |
HDR is disabled. Metadata for this frame will not include the
HdrChannel control.
- name: HdrModeMultiExposureUnmerged
value: 1
description: |
Multiple exposures will be generated in an alternating fashion.
However, they will not be merged together and will be returned to
the application as they are. Each image will be tagged with the
correct HDR channel, indicating what kind of exposure it is. The
tag should be the same as in the HdrModeMultiExposure case.
The expectation is that an application using this mode would merge
the frames to create HDR images for itself if it requires them.
- name: HdrModeMultiExposure
value: 2
description: |
Multiple exposures will be generated and merged to create HDR
images. Each image will be tagged with the HDR channel (long, medium
or short) that arrived and which caused this image to be output.
Systems that use two channels for HDR will return images tagged
alternately as the short and long channel. Systems that use three
channels for HDR will cycle through the short, medium and long
channel before repeating.
- name: HdrModeSingleExposure
value: 3
description: |
Multiple frames all at a single exposure will be used to create HDR
images. These images should be reported as all corresponding to the
HDR short channel.
- name: HdrModeNight
value: 4
description: |
Multiple frames will be combined to produce "night mode" images. It
is up to the implementation exactly which HDR channels it uses, and
the images will all be tagged accordingly with the correct HDR
channel information.
- HdrChannel:
type: int32_t
description: |
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.
This metadata is only available when an HDR mode has been enabled.
\sa HdrMode
enum:
- name: HdrChannelNone
value: 0
description: |
This image does not correspond to any of the captures used to create
an HDR image.
- name: HdrChannelShort
value: 1
description: |
This is a short exposure image.
- name: HdrChannelMedium
value: 2
description: |
This is a medium exposure image.
- name: HdrChannelLong
value: 3
description: |
This is a long exposure image.
# ----------------------------------------------------------------------------
# Draft controls section
- AePrecaptureTrigger:
type: int32_t
draft: true
description: |
Control for AE metering trigger. Currently identical to
ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER.
Whether the camera device will trigger a precapture metering sequence
when it processes this request.
enum:
- name: AePrecaptureTriggerIdle
value: 0
description: The trigger is idle.
- name: AePrecaptureTriggerStart
value: 1
description: The pre-capture AE metering is started by the camera.
- name: AePrecaptureTriggerCancel
value: 2
description: |
The camera will cancel any active or completed metering sequence.
The AE algorithm is reset to its initial state.
- NoiseReductionMode:
type: int32_t
draft: true
description: |
Control to select the noise reduction algorithm mode. Currently
identical to ANDROID_NOISE_REDUCTION_MODE.
Mode of operation for the noise reduction algorithm.
enum:
- name: NoiseReductionModeOff
value: 0
description: No noise reduction is applied
- name: NoiseReductionModeFast
value: 1
description: |
Noise reduction is applied without reducing the frame rate.
- name: NoiseReductionModeHighQuality
value: 2
description: |
High quality noise reduction at the expense of frame rate.
- name: NoiseReductionModeMinimal
value: 3
description: |
Minimal noise reduction is applied without reducing the frame rate.
- name: NoiseReductionModeZSL
value: 4
description: |
Noise reduction is applied at different levels to different streams.
- ColorCorrectionAberrationMode:
type: int32_t
draft: true
description: |
Control to select the color correction aberration mode. Currently
identical to ANDROID_COLOR_CORRECTION_ABERRATION_MODE.
Mode of operation for the chromatic aberration correction algorithm.
enum:
- name: ColorCorrectionAberrationOff
value: 0
description: No aberration correction is applied.
- name: ColorCorrectionAberrationFast
value: 1
description: Aberration correction will not slow down the frame rate.
- name: ColorCorrectionAberrationHighQuality
value: 2
description: |
High quality aberration correction which might reduce the frame
rate.
- AeState:
type: int32_t
draft: true
description: |
Control to report the current AE algorithm state. Currently identical to
ANDROID_CONTROL_AE_STATE.
Current state of the AE algorithm.
enum:
- name: AeStateInactive
value: 0
description: The AE algorithm is inactive.
- name: AeStateSearching
value: 1
description: The AE algorithm has not converged yet.
- name: AeStateConverged
value: 2
description: The AE algorithm has converged.
- name: AeStateLocked
value: 3
description: The AE algorithm is locked.
- name: AeStateFlashRequired
value: 4
description: The AE algorithm would need a flash for good results
- name: AeStatePrecapture
value: 5
description: |
The AE algorithm has started a pre-capture metering session.
\sa AePrecaptureTrigger
- AwbState:
type: int32_t
draft: true
description: |
Control to report the current AWB algorithm state. Currently identical
to ANDROID_CONTROL_AWB_STATE.
Current state of the AWB algorithm.
enum:
- name: AwbStateInactive
value: 0
description: The AWB algorithm is inactive.
- name: AwbStateSearching
value: 1
description: The AWB algorithm has not converged yet.
- name: AwbConverged
value: 2
description: The AWB algorithm has converged.
- name: AwbLocked
value: 3
description: The AWB algorithm is locked.
- SensorRollingShutterSkew:
type: int64_t
draft: true
description: |
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
- LensShadingMapMode:
type: int32_t
draft: true
description: |
Control to report if the lens shading map is available. Currently
identical to ANDROID_STATISTICS_LENS_SHADING_MAP_MODE.
enum:
- name: LensShadingMapModeOff
value: 0
description: No lens shading map mode is available.
- name: LensShadingMapModeOn
value: 1
description: The lens shading map mode is available.
- PipelineDepth:
type: int32_t
draft: true
description: |
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.
The typical value for this control is 3 as a frame is first exposed,
captured and then processed in a single pass through the ISP. Any
additional processing step performed after the ISP pass (in example face
detection, additional format conversions etc) count as an additional
pipeline stage.
- MaxLatency:
type: int32_t
draft: true
description: |
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.
- TestPatternMode:
type: int32_t
draft: true
description: |
Control to select the test pattern mode. Currently identical to
ANDROID_SENSOR_TEST_PATTERN_MODE.
enum:
- name: TestPatternModeOff
value: 0
description: |
No test pattern mode is used. The camera device returns frames from
the image sensor.
- name: TestPatternModeSolidColor
value: 1
description: |
Each pixel in [R, G_even, G_odd, B] is replaced by its respective
color channel provided in test pattern data.
\todo Add control for test pattern data.
- name: TestPatternModeColorBars
value: 2
description: |
All pixel data is replaced with an 8-bar color pattern. The vertical
bars (left-to-right) are as follows; white, yellow, cyan, green,
magenta, red, blue and black. Each bar should take up 1/8 of the
sensor pixel array width. When this is not possible, the bar size
should be rounded down to the nearest integer and the pattern can
repeat on the right side. Each bar's height must always take up the
full sensor pixel array height.
- name: TestPatternModeColorBarsFadeToGray
value: 3
description: |
The test pattern is similar to TestPatternModeColorBars,
except that each bar should start at its specified color at the top
and fade to gray at the bottom. Furthermore each bar is further
subdevided into a left and right half. The left half should have a
smooth gradient, and the right half should have a quantized
gradient. In particular, the right half's should consist of blocks
of the same color for 1/16th active sensor pixel array width. The
least significant bits in the quantized gradient should be copied
from the most significant bits of the smooth gradient. The height of
each bar should always be a multiple of 128. When this is not the
case, the pattern should repeat at the bottom of the image.
- name: TestPatternModePn9
value: 4
description: |
All pixel data is replaced by a pseudo-random sequence generated
from a PN9 512-bit sequence (typically implemented in hardware with
a linear feedback shift register). The generator should be reset at
the beginning of each frame, and thus each subsequent raw frame with
this test pattern should be exactly the same as the last.
- name: TestPatternModeCustom1
value: 256
description: |
The first custom test pattern. All custom patterns that are
available only on this camera device are at least this numeric
value. All of the custom test patterns will be static (that is the
raw image must not vary from frame to frame).
...
|