1 <?xml version="1.0" encoding="utf-8"?>
2 <!-- Copyright (C) 2012 The Android Open Source Project
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
8 http://www.apache.org/licenses/LICENSE-2.0
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
16 <metadata xmlns="http://schemas.android.com/service/camera/metadata/"
17 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
18 xsi:schemaLocation="http://schemas.android.com/service/camera/metadata/ metadata_properties.xsd">
22 Needed for backwards compatibility with old Java API
25 New features for first camera 2 release (API1)
28 Needed for useful RAW image processing and DNG file support
31 Entry is only used by camera device legacy HAL 2.x
34 Entry is required for full hardware level devices, and optional for other hardware levels
37 Entry is required for the depth capability.
40 Entry is required for the YUV or PRIVATE reprocessing capability.
42 <tag id="LOGICALCAMERA">
43 Entry is required for logical multi-camera capability.
46 Entry is under-specified and is not required for now. This is for book-keeping purpose,
47 do not implement or use it, it may be revised for future.
52 <typedef name="pairFloatFloat">
53 <language name="java">android.util.Pair<Float,Float></language>
55 <typedef name="pairDoubleDouble">
56 <language name="java">android.util.Pair<Double,Double></language>
58 <typedef name="rectangle">
59 <language name="java">android.graphics.Rect</language>
62 <language name="java">android.util.Size</language>
64 <typedef name="string">
65 <language name="java">String</language>
67 <typedef name="boolean">
68 <language name="java">boolean</language>
70 <typedef name="imageFormat">
71 <language name="java">int</language>
73 <typedef name="streamConfigurationMap">
74 <language name="java">android.hardware.camera2.params.StreamConfigurationMap</language>
76 <typedef name="streamConfiguration">
77 <language name="java">android.hardware.camera2.params.StreamConfiguration</language>
79 <typedef name="streamConfigurationDuration">
80 <language name="java">android.hardware.camera2.params.StreamConfigurationDuration</language>
83 <language name="java">android.hardware.camera2.params.Face</language>
85 <typedef name="meteringRectangle">
86 <language name="java">android.hardware.camera2.params.MeteringRectangle</language>
88 <typedef name="rangeFloat">
89 <language name="java">android.util.Range<Float></language>
91 <typedef name="rangeInt">
92 <language name="java">android.util.Range<Integer></language>
94 <typedef name="rangeLong">
95 <language name="java">android.util.Range<Long></language>
97 <typedef name="colorSpaceTransform">
98 <language name="java">android.hardware.camera2.params.ColorSpaceTransform</language>
100 <typedef name="rggbChannelVector">
101 <language name="java">android.hardware.camera2.params.RggbChannelVector</language>
103 <typedef name="blackLevelPattern">
104 <language name="java">android.hardware.camera2.params.BlackLevelPattern</language>
106 <typedef name="enumList">
107 <language name="java">int</language>
109 <typedef name="sizeF">
110 <language name="java">android.util.SizeF</language>
112 <typedef name="point">
113 <language name="java">android.graphics.Point</language>
115 <typedef name="tonemapCurve">
116 <language name="java">android.hardware.camera2.params.TonemapCurve</language>
118 <typedef name="lensShadingMap">
119 <language name="java">android.hardware.camera2.params.LensShadingMap</language>
121 <typedef name="location">
122 <language name="java">android.location.Location</language>
124 <typedef name="highSpeedVideoConfiguration">
125 <language name="java">android.hardware.camera2.params.HighSpeedVideoConfiguration</language>
127 <typedef name="reprocessFormatsMap">
128 <language name="java">android.hardware.camera2.params.ReprocessFormatsMap</language>
130 <typedef name="oisSample">
131 <language name="java">android.hardware.camera2.params.OisSample</language>
135 <namespace name="android">
136 <section name="colorCorrection">
138 <entry name="mode" type="byte" visibility="public" enum="true" hwlevel="full">
140 <value>TRANSFORM_MATRIX
141 <notes>Use the android.colorCorrection.transform matrix
142 and android.colorCorrection.gains to do color conversion.
144 All advanced white balance adjustments (not specified
145 by our white balance pipeline) must be disabled.
147 If AWB is enabled with `android.control.awbMode != OFF`, then
148 TRANSFORM_MATRIX is ignored. The camera device will override
149 this value to either FAST or HIGH_QUALITY.
153 <notes>Color correction processing must not slow down
154 capture rate relative to sensor raw output.
156 Advanced white balance adjustments above and beyond
157 the specified white balance pipeline may be applied.
159 If AWB is enabled with `android.control.awbMode != OFF`, then
160 the camera device uses the last frame's AWB values
161 (or defaults if AWB has never been run).
165 <notes>Color correction processing operates at improved
166 quality but the capture rate might be reduced (relative to sensor
169 Advanced white balance adjustments above and beyond
170 the specified white balance pipeline may be applied.
172 If AWB is enabled with `android.control.awbMode != OFF`, then
173 the camera device uses the last frame's AWB values
174 (or defaults if AWB has never been run).
180 The mode control selects how the image data is converted from the
181 sensor's native color into linear sRGB color.
184 When auto-white balance (AWB) is enabled with android.control.awbMode, this
185 control is overridden by the AWB routine. When AWB is disabled, the
186 application controls how the color mapping is performed.
188 We define the expected processing pipeline below. For consistency
189 across devices, this is always the case with TRANSFORM_MATRIX.
191 When either FULL or HIGH_QUALITY is used, the camera device may
192 do additional processing but android.colorCorrection.gains and
193 android.colorCorrection.transform will still be provided by the
194 camera device (in the results) and be roughly correct.
196 Switching to TRANSFORM_MATRIX and using the data provided from
197 FAST or HIGH_QUALITY will yield a picture with the same white point
198 as what was produced by the camera device in the earlier frame.
200 The expected processing pipeline is as follows:
202 
204 The white balance is encoded by two values, a 4-channel white-balance
205 gain vector (applied in the Bayer domain), and a 3x3 color transform
206 matrix (applied after demosaic).
208 The 4-channel white-balance gains are defined as:
210 android.colorCorrection.gains = [ R G_even G_odd B ]
212 where `G_even` is the gain for green pixels on even rows of the
213 output, and `G_odd` is the gain for green pixels on the odd rows.
214 These may be identical for a given camera device implementation; if
215 the camera device does not support a separate gain for even/odd green
216 channels, it will use the `G_even` value, and write `G_odd` equal to
217 `G_even` in the output result metadata.
219 The matrices for color transforms are defined as a 9-entry vector:
221 android.colorCorrection.transform = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
223 which define a transform from input sensor colors, `P_in = [ r g b ]`,
224 to output linear sRGB, `P_out = [ r' g' b' ]`,
226 with colors as follows:
232 Both the input and output value ranges must match. Overflow/underflow
233 values are clipped to fit within the range.
236 HAL must support both FAST and HIGH_QUALITY if color correction control is available
237 on the camera device, but the underlying implementation can be the same for both modes.
238 That is, if the highest quality implementation on the camera device does not slow down
239 capture rate, then FAST and HIGH_QUALITY should generate the same output.
242 <entry name="transform" type="rational" visibility="public"
243 type_notes="3x3 rational matrix in row-major order"
244 container="array" typedef="colorSpaceTransform" hwlevel="full">
249 <description>A color transform matrix to use to transform
250 from sensor RGB color space to output linear sRGB color space.
252 <units>Unitless scale factors</units>
253 <details>This matrix is either set by the camera device when the request
254 android.colorCorrection.mode is not TRANSFORM_MATRIX, or
255 directly by the application in the request when the
256 android.colorCorrection.mode is TRANSFORM_MATRIX.
258 In the latter case, the camera device may round the matrix to account
259 for precision issues; the final rounded matrix should be reported back
260 in this matrix result metadata. The transform should keep the magnitude
261 of the output color values within `[0, 1.0]` (assuming input color
262 values is within the normalized range `[0, 1.0]`), or clipping may occur.
264 The valid range of each matrix element varies on different devices, but
265 values within [-1.5, 3.0] are guaranteed not to be clipped.
268 <entry name="gains" type="float" visibility="public"
269 type_notes="A 1D array of floats for 4 color channel gains"
270 container="array" typedef="rggbChannelVector" hwlevel="full">
274 <description>Gains applying to Bayer raw color channels for
275 white-balance.</description>
276 <units>Unitless gain factors</units>
278 These per-channel gains are either set by the camera device
279 when the request android.colorCorrection.mode is not
280 TRANSFORM_MATRIX, or directly by the application in the
281 request when the android.colorCorrection.mode is
284 The gains in the result metadata are the gains actually
285 applied by the camera device to the current frame.
287 The valid range of gains varies on different devices, but gains
288 between [1.0, 3.0] are guaranteed not to be clipped. Even if a given
289 device allows gains below 1.0, this is usually not recommended because
290 this can create color artifacts.
293 The 4-channel white-balance gains are defined in
294 the order of `[R G_even G_odd B]`, where `G_even` is the gain
295 for green pixels on even rows of the output, and `G_odd`
296 is the gain for green pixels on the odd rows.
298 If a HAL does not support a separate gain for even/odd green
299 channels, it must use the `G_even` value, and write
300 `G_odd` equal to `G_even` in the output result metadata.
303 <entry name="aberrationMode" type="byte" visibility="public" enum="true" hwlevel="legacy">
307 No aberration correction is applied.
312 Aberration correction will not slow down capture rate
313 relative to sensor raw output.
318 Aberration correction operates at improved quality but the capture rate might be
319 reduced (relative to sensor raw output rate)
324 Mode of operation for the chromatic aberration correction algorithm.
326 <range>android.colorCorrection.availableAberrationModes</range>
328 Chromatic (color) aberration is caused by the fact that different wavelengths of light
329 can not focus on the same point after exiting from the lens. This metadata defines
330 the high level control of chromatic aberration correction algorithm, which aims to
331 minimize the chromatic artifacts that may occur along the object boundaries in an
334 FAST/HIGH_QUALITY both mean that camera device determined aberration
335 correction will be applied. HIGH_QUALITY mode indicates that the camera device will
336 use the highest-quality aberration correction algorithms, even if it slows down
337 capture rate. FAST means the camera device will not slow down capture rate when
338 applying aberration correction.
340 LEGACY devices will always be in FAST mode.
345 <clone entry="android.colorCorrection.mode" kind="controls">
347 <clone entry="android.colorCorrection.transform" kind="controls">
349 <clone entry="android.colorCorrection.gains" kind="controls">
351 <clone entry="android.colorCorrection.aberrationMode" kind="controls">
355 <entry name="availableAberrationModes" type="byte" visibility="public"
356 type_notes="list of enums" container="array" typedef="enumList" hwlevel="legacy">
361 List of aberration correction modes for android.colorCorrection.aberrationMode that are
362 supported by this camera device.
364 <range>Any value listed in android.colorCorrection.aberrationMode</range>
366 This key lists the valid modes for android.colorCorrection.aberrationMode. If no
367 aberration correction modes are available for a device, this list will solely include
368 OFF mode. All camera devices will support either OFF or FAST mode.
370 Camera devices that support the MANUAL_POST_PROCESSING capability will always list
371 OFF mode. This includes all FULL level devices.
373 LEGACY devices will always only support FAST mode.
376 HAL must support both FAST and HIGH_QUALITY if chromatic aberration control is available
377 on the camera device, but the underlying implementation can be the same for both modes.
378 That is, if the highest quality implementation on the camera device does not slow down
379 capture rate, then FAST and HIGH_QUALITY will generate the same output.
385 <section name="control">
387 <entry name="aeAntibandingMode" type="byte" visibility="public"
388 enum="true" hwlevel="legacy">
392 The camera device will not adjust exposure duration to
393 avoid banding problems.
398 The camera device will adjust exposure duration to
399 avoid banding problems with 50Hz illumination sources.
404 The camera device will adjust exposure duration to
405 avoid banding problems with 60Hz illumination
411 The camera device will automatically adapt its
412 antibanding routine to the current illumination
413 condition. This is the default mode if AUTO is
414 available on given camera device.
419 The desired setting for the camera device's auto-exposure
420 algorithm's antibanding compensation.
423 android.control.aeAvailableAntibandingModes
426 Some kinds of lighting fixtures, such as some fluorescent
427 lights, flicker at the rate of the power supply frequency
428 (60Hz or 50Hz, depending on country). While this is
429 typically not noticeable to a person, it can be visible to
430 a camera device. If a camera sets its exposure time to the
431 wrong value, the flicker may become visible in the
432 viewfinder as flicker or in a final captured image, as a
433 set of variable-brightness bands across the image.
435 Therefore, the auto-exposure routines of camera devices
436 include antibanding routines that ensure that the chosen
437 exposure value will not cause such banding. The choice of
438 exposure time depends on the rate of flicker, which the
439 camera device can detect automatically, or the expected
440 rate can be selected by the application using this
443 A given camera device may not support all of the possible
444 options for the antibanding mode. The
445 android.control.aeAvailableAntibandingModes key contains
446 the available modes for a given camera device.
448 AUTO mode is the default if it is available on given
449 camera device. When AUTO mode is not available, the
450 default will be either 50HZ or 60HZ, and both 50HZ
451 and 60HZ will be available.
453 If manual exposure control is enabled (by setting
454 android.control.aeMode or android.control.mode to OFF),
455 then this setting has no effect, and the application must
456 ensure it selects exposure times that do not cause banding
457 issues. The android.statistics.sceneFlicker key can assist
458 the application in this.
461 For all capture request templates, this field must be set
462 to AUTO if AUTO mode is available. If AUTO is not available,
463 the default must be either 50HZ or 60HZ, and both 50HZ and
464 60HZ must be available.
466 If manual exposure control is enabled (by setting
467 android.control.aeMode or android.control.mode to OFF),
468 then the exposure values provided by the application must not be
469 adjusted for antibanding.
473 <entry name="aeExposureCompensation" type="int32" visibility="public" hwlevel="legacy">
474 <description>Adjustment to auto-exposure (AE) target image
475 brightness.</description>
476 <units>Compensation steps</units>
477 <range>android.control.aeCompensationRange</range>
479 The adjustment is measured as a count of steps, with the
480 step size defined by android.control.aeCompensationStep and the
481 allowed range by android.control.aeCompensationRange.
483 For example, if the exposure value (EV) step is 0.333, '6'
484 will mean an exposure compensation of +2 EV; -3 will mean an
485 exposure compensation of -1 EV. One EV represents a doubling
486 of image brightness. Note that this control will only be
487 effective if android.control.aeMode `!=` OFF. This control
488 will take effect even when android.control.aeLock `== true`.
490 In the event of exposure compensation value being changed, camera device
491 may take several frames to reach the newly requested exposure target.
492 During that time, android.control.aeState field will be in the SEARCHING
493 state. Once the new exposure target is reached, android.control.aeState will
494 change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or
495 FLASH_REQUIRED (if the scene is too dark for still capture).
499 <entry name="aeLock" type="byte" visibility="public" enum="true"
500 typedef="boolean" hwlevel="legacy">
503 <notes>Auto-exposure lock is disabled; the AE algorithm
504 is free to update its parameters.</notes></value>
506 <notes>Auto-exposure lock is enabled; the AE algorithm
507 must not update the exposure and sensitivity parameters
508 while the lock is active.
510 android.control.aeExposureCompensation setting changes
511 will still take effect while auto-exposure is locked.
513 Some rare LEGACY devices may not support
514 this, in which case the value will always be overridden to OFF.
517 <description>Whether auto-exposure (AE) is currently locked to its latest
518 calculated values.</description>
520 When set to `true` (ON), the AE algorithm is locked to its latest parameters,
521 and will not change exposure settings until the lock is set to `false` (OFF).
523 Note that even when AE is locked, the flash may be fired if
524 the android.control.aeMode is ON_AUTO_FLASH /
525 ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.
527 When android.control.aeExposureCompensation is changed, even if the AE lock
528 is ON, the camera device will still adjust its exposure value.
530 If AE precapture is triggered (see android.control.aePrecaptureTrigger)
531 when AE is already locked, the camera device will not change the exposure time
532 (android.sensor.exposureTime) and sensitivity (android.sensor.sensitivity)
533 parameters. The flash may be fired if the android.control.aeMode
534 is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the
535 android.control.aeMode is ON_ALWAYS_FLASH, the scene may become overexposed.
536 Similarly, AE precapture trigger CANCEL has no effect when AE is already locked.
538 When an AE precapture sequence is triggered, AE unlock will not be able to unlock
539 the AE if AE is locked by the camera device internally during precapture metering
540 sequence In other words, submitting requests with AE unlock has no effect for an
541 ongoing precapture metering sequence. Otherwise, the precapture metering sequence
542 will never succeed in a sequence of preview requests where AE lock is always set
545 Since the camera device has a pipeline of in-flight requests, the settings that
546 get locked do not necessarily correspond to the settings that were present in the
547 latest capture result received from the camera device, since additional captures
548 and AE updates may have occurred even before the result was sent out. If an
549 application is switching between automatic and manual control and wishes to eliminate
550 any flicker during the switch, the following procedure is recommended:
552 1. Starting in auto-AE mode:
554 3. Wait for the first result to be output that has the AE locked
555 4. Copy exposure settings from that result into a request, set the request to manual AE
556 5. Submit the capture request, proceed to run manual AE as desired.
558 See android.control.aeState for AE lock related state transition details.
562 <entry name="aeMode" type="byte" visibility="public" enum="true" hwlevel="legacy">
566 The camera device's autoexposure routine is disabled.
568 The application-selected android.sensor.exposureTime,
569 android.sensor.sensitivity and
570 android.sensor.frameDuration are used by the camera
571 device, along with android.flash.* fields, if there's
572 a flash unit for this camera device.
574 Note that auto-white balance (AWB) and auto-focus (AF)
575 behavior is device dependent when AE is in OFF mode.
576 To have consistent behavior across different devices,
577 it is recommended to either set AWB and AF to OFF mode
578 or lock AWB and AF before setting AE to OFF.
579 See android.control.awbMode, android.control.afMode,
580 android.control.awbLock, and android.control.afTrigger
583 LEGACY devices do not support the OFF mode and will
584 override attempts to use this value to ON.
589 The camera device's autoexposure routine is active,
590 with no flash control.
592 The application's values for
593 android.sensor.exposureTime,
594 android.sensor.sensitivity, and
595 android.sensor.frameDuration are ignored. The
596 application has control over the various
597 android.flash.* fields.
602 Like ON, except that the camera device also controls
603 the camera's flash unit, firing it in low-light
606 The flash may be fired during a precapture sequence
607 (triggered by android.control.aePrecaptureTrigger) and
608 may be fired for captures for which the
609 android.control.captureIntent field is set to
613 <value>ON_ALWAYS_FLASH
615 Like ON, except that the camera device also controls
616 the camera's flash unit, always firing it for still
619 The flash may be fired during a precapture sequence
620 (triggered by android.control.aePrecaptureTrigger) and
621 will always be fired for captures for which the
622 android.control.captureIntent field is set to
626 <value>ON_AUTO_FLASH_REDEYE
628 Like ON_AUTO_FLASH, but with automatic red eye
631 If deemed necessary by the camera device, a red eye
632 reduction flash will fire during the precapture
636 <value hal_version="3.3">ON_EXTERNAL_FLASH
638 An external flash has been turned on.
640 It informs the camera device that an external flash has been turned on, and that
641 metering (and continuous focus if active) should be quickly recaculated to account
642 for the external flash. Otherwise, this mode acts like ON.
644 When the external flash is turned off, AE mode should be changed to one of the
645 other available AE modes.
647 If the camera device supports AE external flash mode, aeState must be
648 FLASH_REQUIRED after the camera device finishes AE scan and it's too dark without
653 <description>The desired mode for the camera device's
654 auto-exposure routine.</description>
655 <range>android.control.aeAvailableModes</range>
657 This control is only effective if android.control.mode is
660 When set to any of the ON modes, the camera device's
661 auto-exposure routine is enabled, overriding the
662 application's selected exposure time, sensor sensitivity,
663 and frame duration (android.sensor.exposureTime,
664 android.sensor.sensitivity, and
665 android.sensor.frameDuration). If one of the FLASH modes
666 is selected, the camera device's flash unit controls are
669 The FLASH modes are only available if the camera device
670 has a flash unit (android.flash.info.available is `true`).
672 If flash TORCH mode is desired, this field must be set to
673 ON or OFF, and android.flash.mode set to TORCH.
675 When set to any of the ON modes, the values chosen by the
676 camera device auto-exposure routine for the overridden
677 fields for a given capture will be available in its
682 <entry name="aeRegions" type="int32" visibility="public"
683 optional="true" container="array" typedef="meteringRectangle">
686 <size>area_count</size>
688 <description>List of metering areas to use for auto-exposure adjustment.</description>
689 <units>Pixel coordinates within android.sensor.info.activeArraySize</units>
690 <range>Coordinates must be between `[(0,0), (width, height))` of
691 android.sensor.info.activeArraySize</range>
693 Not available if android.control.maxRegionsAe is 0.
694 Otherwise will always be present.
696 The maximum number of regions supported by the device is determined by the value
697 of android.control.maxRegionsAe.
699 The coordinate system is based on the active pixel array,
700 with (0,0) being the top-left pixel in the active pixel array, and
701 (android.sensor.info.activeArraySize.width - 1,
702 android.sensor.info.activeArraySize.height - 1) being the
703 bottom-right pixel in the active pixel array.
705 The weight must be within `[0, 1000]`, and represents a weight
706 for every pixel in the area. This means that a large metering area
707 with the same weight as a smaller area will have more effect in
708 the metering result. Metering areas can partially overlap and the
709 camera device will add the weights in the overlap region.
711 The weights are relative to weights of other exposure metering regions, so if only one
712 region is used, all non-zero weights will have the same effect. A region with 0
715 If all regions have 0 weight, then no specific metering area needs to be used by the
718 If the metering region is outside the used android.scaler.cropRegion returned in
719 capture result metadata, the camera device will ignore the sections outside the crop
720 region and output only the intersection rectangle as the metering region in the result
721 metadata. If the region is entirely outside the crop region, it will be ignored and
722 not reported in the result metadata.
725 The data representation is `int[5 * area_count]`.
726 Every five elements represent a metering region of `(xmin, ymin, xmax, ymax, weight)`.
727 The rectangle is defined to be inclusive on xmin and ymin, but exclusive on xmax and
731 The HAL level representation of MeteringRectangle[] is a
733 Every five elements represent a metering region of
734 (xmin, ymin, xmax, ymax, weight).
735 The rectangle is defined to be inclusive on xmin and ymin, but
736 exclusive on xmax and ymax.
740 <entry name="aeTargetFpsRange" type="int32" visibility="public"
741 container="array" typedef="rangeInt" hwlevel="legacy">
745 <description>Range over which the auto-exposure routine can
746 adjust the capture frame rate to maintain good
747 exposure.</description>
748 <units>Frames per second (FPS)</units>
749 <range>Any of the entries in android.control.aeAvailableTargetFpsRanges</range>
750 <details>Only constrains auto-exposure (AE) algorithm, not
751 manual control of android.sensor.exposureTime and
752 android.sensor.frameDuration.</details>
755 <entry name="aePrecaptureTrigger" type="byte" visibility="public"
756 enum="true" hwlevel="limited">
759 <notes>The trigger is idle.</notes>
762 <notes>The precapture metering sequence will be started
763 by the camera device.
765 The exact effect of the precapture trigger depends on
766 the current AE mode and state.</notes>
769 <notes>The camera device will cancel any currently active or completed
770 precapture metering sequence, the auto-exposure routine will return to its
771 initial state.</notes>
774 <description>Whether the camera device will trigger a precapture
775 metering sequence when it processes this request.</description>
776 <details>This entry is normally set to IDLE, or is not
777 included at all in the request settings. When included and
778 set to START, the camera device will trigger the auto-exposure (AE)
779 precapture metering sequence.
781 When set to CANCEL, the camera device will cancel any active
782 precapture metering trigger, and return to its initial AE state.
783 If a precapture metering sequence is already completed, and the camera
784 device has implicitly locked the AE for subsequent still capture, the
785 CANCEL trigger will unlock the AE and return to its initial AE state.
787 The precapture sequence should be triggered before starting a
788 high-quality still capture for final metering decisions to
789 be made, and for firing pre-capture flash pulses to estimate
790 scene brightness and required final capture flash power, when
791 the flash is enabled.
793 Normally, this entry should be set to START for only a
794 single request, and the application should wait until the
795 sequence completes before starting a new one.
797 When a precapture metering sequence is finished, the camera device
798 may lock the auto-exposure routine internally to be able to accurately expose the
799 subsequent still capture image (`android.control.captureIntent == STILL_CAPTURE`).
800 For this case, the AE may not resume normal scan if no subsequent still capture is
801 submitted. To ensure that the AE routine restarts normal scan, the application should
802 submit a request with `android.control.aeLock == true`, followed by a request
803 with `android.control.aeLock == false`, if the application decides not to submit a
804 still capture request after the precapture sequence completes. Alternatively, for
805 API level 23 or newer devices, the CANCEL can be used to unlock the camera device
806 internally locked AE if the application doesn't submit a still capture request after
807 the AE precapture trigger. Note that, the CANCEL was added in API level 23, and must not
808 be used in devices that have earlier API levels.
810 The exact effect of auto-exposure (AE) precapture trigger
811 depends on the current AE mode and state; see
812 android.control.aeState for AE precapture state transition
815 On LEGACY-level devices, the precapture trigger is not supported;
816 capturing a high-resolution JPEG image will automatically trigger a
817 precapture sequence before the high-resolution capture, including
818 potentially firing a pre-capture flash.
820 Using the precapture trigger and the auto-focus trigger android.control.afTrigger
821 simultaneously is allowed. However, since these triggers often require cooperation between
822 the auto-focus and auto-exposure routines (for example, the may need to be enabled for a
823 focus sweep), the camera device may delay acting on a later trigger until the previous
824 trigger has been fully handled. This may lead to longer intervals between the trigger and
825 changes to android.control.aeState indicating the start of the precapture sequence, for
828 If both the precapture and the auto-focus trigger are activated on the same request, then
829 the camera device will complete them in the optimal order for that device.
832 The HAL must support triggering the AE precapture trigger while an AF trigger is active
833 (and vice versa), or at the same time as the AF trigger. It is acceptable for the HAL to
834 treat these as two consecutive triggers, for example handling the AF trigger and then the
835 AE trigger. Or the HAL may choose to optimize the case with both triggers fired at once,
836 to minimize the latency for converging both focus and exposure/flash usage.
840 <entry name="afMode" type="byte" visibility="public" enum="true"
844 <notes>The auto-focus routine does not control the lens;
845 android.lens.focusDistance is controlled by the
846 application.</notes></value>
848 <notes>Basic automatic focus mode.
850 In this mode, the lens does not move unless
851 the autofocus trigger action is called. When that trigger
852 is activated, AF will transition to ACTIVE_SCAN, then to
853 the outcome of the scan (FOCUSED or NOT_FOCUSED).
855 Always supported if lens is not fixed focus.
857 Use android.lens.info.minimumFocusDistance to determine if lens
860 Triggering AF_CANCEL resets the lens position to default,
861 and sets the AF state to INACTIVE.</notes></value>
863 <notes>Close-up focusing mode.
865 In this mode, the lens does not move unless the
866 autofocus trigger action is called. When that trigger is
867 activated, AF will transition to ACTIVE_SCAN, then to
868 the outcome of the scan (FOCUSED or NOT_FOCUSED). This
869 mode is optimized for focusing on objects very close to
872 When that trigger is activated, AF will transition to
873 ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or
874 NOT_FOCUSED). Triggering cancel AF resets the lens
875 position to default, and sets the AF state to
876 INACTIVE.</notes></value>
877 <value>CONTINUOUS_VIDEO
878 <notes>In this mode, the AF algorithm modifies the lens
879 position continually to attempt to provide a
880 constantly-in-focus image stream.
882 The focusing behavior should be suitable for good quality
883 video recording; typically this means slower focus
884 movement and no overshoots. When the AF trigger is not
885 involved, the AF algorithm should start in INACTIVE state,
886 and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED
887 states as appropriate. When the AF trigger is activated,
888 the algorithm should immediately transition into
889 AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
890 lens position until a cancel AF trigger is received.
892 Once cancel is received, the algorithm should transition
893 back to INACTIVE and resume passive scan. Note that this
894 behavior is not identical to CONTINUOUS_PICTURE, since an
895 ongoing PASSIVE_SCAN must immediately be
896 canceled.</notes></value>
897 <value>CONTINUOUS_PICTURE
898 <notes>In this mode, the AF algorithm modifies the lens
899 position continually to attempt to provide a
900 constantly-in-focus image stream.
902 The focusing behavior should be suitable for still image
903 capture; typically this means focusing as fast as
904 possible. When the AF trigger is not involved, the AF
905 algorithm should start in INACTIVE state, and then
906 transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as
907 appropriate as it attempts to maintain focus. When the AF
908 trigger is activated, the algorithm should finish its
909 PASSIVE_SCAN if active, and then transition into
910 AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
911 lens position until a cancel AF trigger is received.
913 When the AF cancel trigger is activated, the algorithm
914 should transition back to INACTIVE and then act as if it
915 has just been started.</notes></value>
917 <notes>Extended depth of field (digital focus) mode.
919 The camera device will produce images with an extended
920 depth of field automatically; no special focusing
921 operations need to be done before taking a picture.
923 AF triggers are ignored, and the AF state will always be
924 INACTIVE.</notes></value>
926 <description>Whether auto-focus (AF) is currently enabled, and what
927 mode it is set to.</description>
928 <range>android.control.afAvailableModes</range>
929 <details>Only effective if android.control.mode = AUTO and the lens is not fixed focus
930 (i.e. `android.lens.info.minimumFocusDistance > 0`). Also note that
931 when android.control.aeMode is OFF, the behavior of AF is device
932 dependent. It is recommended to lock AF by using android.control.afTrigger before
933 setting android.control.aeMode to OFF, or set AF mode to OFF when AE is OFF.
935 If the lens is controlled by the camera device auto-focus algorithm,
936 the camera device will report the current AF status in android.control.afState
937 in result metadata.</details>
939 When afMode is AUTO or MACRO, the lens must not move until an AF trigger is sent in a
940 request (android.control.afTrigger `==` START). After an AF trigger, the afState will end
941 up with either FOCUSED_LOCKED or NOT_FOCUSED_LOCKED state (see
942 android.control.afState for detailed state transitions), which indicates that the lens is
943 locked and will not move. If camera movement (e.g. tilting camera) causes the lens to move
944 after the lens is locked, the HAL must compensate this movement appropriately such that
945 the same focal plane remains in focus.
947 When afMode is one of the continuous auto focus modes, the HAL is free to start a AF
948 scan whenever it's not locked. When the lens is locked after an AF trigger
949 (see android.control.afState for detailed state transitions), the HAL should maintain the
950 same lock behavior as above.
952 When afMode is OFF, the application controls focus manually. The accuracy of the
953 focus distance control depends on the android.lens.info.focusDistanceCalibration.
954 However, the lens must not move regardless of the camera movement for any focus distance
957 To put this in concrete terms, if the camera has lens elements which may move based on
958 camera orientation or motion (e.g. due to gravity), then the HAL must drive the lens to
959 remain in a fixed position invariant to the camera's orientation or motion, for example,
960 by using accelerometer measurements in the lens control logic. This is a typical issue
961 that will arise on camera modules with open-loop VCMs.
965 <entry name="afRegions" type="int32" visibility="public"
966 optional="true" container="array" typedef="meteringRectangle">
969 <size>area_count</size>
971 <description>List of metering areas to use for auto-focus.</description>
972 <units>Pixel coordinates within android.sensor.info.activeArraySize</units>
973 <range>Coordinates must be between `[(0,0), (width, height))` of
974 android.sensor.info.activeArraySize</range>
976 Not available if android.control.maxRegionsAf is 0.
977 Otherwise will always be present.
979 The maximum number of focus areas supported by the device is determined by the value
980 of android.control.maxRegionsAf.
982 The coordinate system is based on the active pixel array,
983 with (0,0) being the top-left pixel in the active pixel array, and
984 (android.sensor.info.activeArraySize.width - 1,
985 android.sensor.info.activeArraySize.height - 1) being the
986 bottom-right pixel in the active pixel array.
988 The weight must be within `[0, 1000]`, and represents a weight
989 for every pixel in the area. This means that a large metering area
990 with the same weight as a smaller area will have more effect in
991 the metering result. Metering areas can partially overlap and the
992 camera device will add the weights in the overlap region.
994 The weights are relative to weights of other metering regions, so if only one region
995 is used, all non-zero weights will have the same effect. A region with 0 weight is
998 If all regions have 0 weight, then no specific metering area needs to be used by the
999 camera device. The capture result will either be a zero weight region as well, or
1000 the region selected by the camera device as the focus area of interest.
1002 If the metering region is outside the used android.scaler.cropRegion returned in
1003 capture result metadata, the camera device will ignore the sections outside the crop
1004 region and output only the intersection rectangle as the metering region in the result
1005 metadata. If the region is entirely outside the crop region, it will be ignored and
1006 not reported in the result metadata.
1009 The data representation is `int[5 * area_count]`.
1010 Every five elements represent a metering region of `(xmin, ymin, xmax, ymax, weight)`.
1011 The rectangle is defined to be inclusive on xmin and ymin, but exclusive on xmax and
1015 The HAL level representation of MeteringRectangle[] is a
1016 int[5 * area_count].
1017 Every five elements represent a metering region of
1018 (xmin, ymin, xmax, ymax, weight).
1019 The rectangle is defined to be inclusive on xmin and ymin, but
1020 exclusive on xmax and ymax.
1024 <entry name="afTrigger" type="byte" visibility="public" enum="true"
1028 <notes>The trigger is idle.</notes>
1031 <notes>Autofocus will trigger now.</notes>
1034 <notes>Autofocus will return to its initial
1035 state, and cancel any currently active trigger.</notes>
1039 Whether the camera device will trigger autofocus for this request.
1041 <details>This entry is normally set to IDLE, or is not
1042 included at all in the request settings.
1044 When included and set to START, the camera device will trigger the
1045 autofocus algorithm. If autofocus is disabled, this trigger has no effect.
1047 When set to CANCEL, the camera device will cancel any active trigger,
1048 and return to its initial AF state.
1050 Generally, applications should set this entry to START or CANCEL for only a
1051 single capture, and then return it to IDLE (or not set at all). Specifying
1052 START for multiple captures in a row means restarting the AF operation over
1055 See android.control.afState for what the trigger means for each AF mode.
1057 Using the autofocus trigger and the precapture trigger android.control.aePrecaptureTrigger
1058 simultaneously is allowed. However, since these triggers often require cooperation between
1059 the auto-focus and auto-exposure routines (for example, the may need to be enabled for a
1060 focus sweep), the camera device may delay acting on a later trigger until the previous
1061 trigger has been fully handled. This may lead to longer intervals between the trigger and
1062 changes to android.control.afState, for example.
1065 The HAL must support triggering the AF trigger while an AE precapture trigger is active
1066 (and vice versa), or at the same time as the AE trigger. It is acceptable for the HAL to
1067 treat these as two consecutive triggers, for example handling the AF trigger and then the
1068 AE trigger. Or the HAL may choose to optimize the case with both triggers fired at once,
1069 to minimize the latency for converging both focus and exposure/flash usage.
1073 <entry name="awbLock" type="byte" visibility="public" enum="true"
1074 typedef="boolean" hwlevel="legacy">
1077 <notes>Auto-white balance lock is disabled; the AWB
1078 algorithm is free to update its parameters if in AUTO
1079 mode.</notes></value>
1081 <notes>Auto-white balance lock is enabled; the AWB
1082 algorithm will not update its parameters while the lock
1083 is active.</notes></value>
1085 <description>Whether auto-white balance (AWB) is currently locked to its
1086 latest calculated values.</description>
1088 When set to `true` (ON), the AWB algorithm is locked to its latest parameters,
1089 and will not change color balance settings until the lock is set to `false` (OFF).
1091 Since the camera device has a pipeline of in-flight requests, the settings that
1092 get locked do not necessarily correspond to the settings that were present in the
1093 latest capture result received from the camera device, since additional captures
1094 and AWB updates may have occurred even before the result was sent out. If an
1095 application is switching between automatic and manual control and wishes to eliminate
1096 any flicker during the switch, the following procedure is recommended:
1098 1. Starting in auto-AWB mode:
1100 3. Wait for the first result to be output that has the AWB locked
1101 4. Copy AWB settings from that result into a request, set the request to manual AWB
1102 5. Submit the capture request, proceed to run manual AWB as desired.
1104 Note that AWB lock is only meaningful when
1105 android.control.awbMode is in the AUTO mode; in other modes,
1106 AWB is already fixed to a specific setting.
1108 Some LEGACY devices may not support ON; the value is then overridden to OFF.
1112 <entry name="awbMode" type="byte" visibility="public" enum="true"
1117 The camera device's auto-white balance routine is disabled.
1119 The application-selected color transform matrix
1120 (android.colorCorrection.transform) and gains
1121 (android.colorCorrection.gains) are used by the camera
1122 device for manual white balance control.
1127 The camera device's auto-white balance routine is active.
1129 The application's values for android.colorCorrection.transform
1130 and android.colorCorrection.gains are ignored.
1131 For devices that support the MANUAL_POST_PROCESSING capability, the
1132 values used by the camera device for the transform and gains
1133 will be available in the capture result for this request.
1138 The camera device's auto-white balance routine is disabled;
1139 the camera device uses incandescent light as the assumed scene
1140 illumination for white balance.
1142 While the exact white balance transforms are up to the
1143 camera device, they will approximately match the CIE
1144 standard illuminant A.
1146 The application's values for android.colorCorrection.transform
1147 and android.colorCorrection.gains are ignored.
1148 For devices that support the MANUAL_POST_PROCESSING capability, the
1149 values used by the camera device for the transform and gains
1150 will be available in the capture result for this request.
1155 The camera device's auto-white balance routine is disabled;
1156 the camera device uses fluorescent light as the assumed scene
1157 illumination for white balance.
1159 While the exact white balance transforms are up to the
1160 camera device, they will approximately match the CIE
1161 standard illuminant F2.
1163 The application's values for android.colorCorrection.transform
1164 and android.colorCorrection.gains are ignored.
1165 For devices that support the MANUAL_POST_PROCESSING capability, the
1166 values used by the camera device for the transform and gains
1167 will be available in the capture result for this request.
1170 <value>WARM_FLUORESCENT
1172 The camera device's auto-white balance routine is disabled;
1173 the camera device uses warm fluorescent light as the assumed scene
1174 illumination for white balance.
1176 While the exact white balance transforms are up to the
1177 camera device, they will approximately match the CIE
1178 standard illuminant F4.
1180 The application's values for android.colorCorrection.transform
1181 and android.colorCorrection.gains are ignored.
1182 For devices that support the MANUAL_POST_PROCESSING capability, the
1183 values used by the camera device for the transform and gains
1184 will be available in the capture result for this request.
1189 The camera device's auto-white balance routine is disabled;
1190 the camera device uses daylight light as the assumed scene
1191 illumination for white balance.
1193 While the exact white balance transforms are up to the
1194 camera device, they will approximately match the CIE
1195 standard illuminant D65.
1197 The application's values for android.colorCorrection.transform
1198 and android.colorCorrection.gains are ignored.
1199 For devices that support the MANUAL_POST_PROCESSING capability, the
1200 values used by the camera device for the transform and gains
1201 will be available in the capture result for this request.
1204 <value>CLOUDY_DAYLIGHT
1206 The camera device's auto-white balance routine is disabled;
1207 the camera device uses cloudy daylight light as the assumed scene
1208 illumination for white balance.
1210 The application's values for android.colorCorrection.transform
1211 and android.colorCorrection.gains are ignored.
1212 For devices that support the MANUAL_POST_PROCESSING capability, the
1213 values used by the camera device for the transform and gains
1214 will be available in the capture result for this request.
1219 The camera device's auto-white balance routine is disabled;
1220 the camera device uses twilight light as the assumed scene
1221 illumination for white balance.
1223 The application's values for android.colorCorrection.transform
1224 and android.colorCorrection.gains are ignored.
1225 For devices that support the MANUAL_POST_PROCESSING capability, the
1226 values used by the camera device for the transform and gains
1227 will be available in the capture result for this request.
1232 The camera device's auto-white balance routine is disabled;
1233 the camera device uses shade light as the assumed scene
1234 illumination for white balance.
1236 The application's values for android.colorCorrection.transform
1237 and android.colorCorrection.gains are ignored.
1238 For devices that support the MANUAL_POST_PROCESSING capability, the
1239 values used by the camera device for the transform and gains
1240 will be available in the capture result for this request.
1244 <description>Whether auto-white balance (AWB) is currently setting the color
1245 transform fields, and what its illumination target
1247 <range>android.control.awbAvailableModes</range>
1249 This control is only effective if android.control.mode is AUTO.
1251 When set to the ON mode, the camera device's auto-white balance
1252 routine is enabled, overriding the application's selected
1253 android.colorCorrection.transform, android.colorCorrection.gains and
1254 android.colorCorrection.mode. Note that when android.control.aeMode
1255 is OFF, the behavior of AWB is device dependent. It is recommened to
1256 also set AWB mode to OFF or lock AWB by using android.control.awbLock before
1257 setting AE mode to OFF.
1259 When set to the OFF mode, the camera device's auto-white balance
1260 routine is disabled. The application manually controls the white
1261 balance by android.colorCorrection.transform, android.colorCorrection.gains
1262 and android.colorCorrection.mode.
1264 When set to any other modes, the camera device's auto-white
1265 balance routine is disabled. The camera device uses each
1266 particular illumination target for white balance
1267 adjustment. The application's values for
1268 android.colorCorrection.transform,
1269 android.colorCorrection.gains and
1270 android.colorCorrection.mode are ignored.
1274 <entry name="awbRegions" type="int32" visibility="public"
1275 optional="true" container="array" typedef="meteringRectangle">
1278 <size>area_count</size>
1280 <description>List of metering areas to use for auto-white-balance illuminant
1281 estimation.</description>
1282 <units>Pixel coordinates within android.sensor.info.activeArraySize</units>
1283 <range>Coordinates must be between `[(0,0), (width, height))` of
1284 android.sensor.info.activeArraySize</range>
1286 Not available if android.control.maxRegionsAwb is 0.
1287 Otherwise will always be present.
1289 The maximum number of regions supported by the device is determined by the value
1290 of android.control.maxRegionsAwb.
1292 The coordinate system is based on the active pixel array,
1293 with (0,0) being the top-left pixel in the active pixel array, and
1294 (android.sensor.info.activeArraySize.width - 1,
1295 android.sensor.info.activeArraySize.height - 1) being the
1296 bottom-right pixel in the active pixel array.
1298 The weight must range from 0 to 1000, and represents a weight
1299 for every pixel in the area. This means that a large metering area
1300 with the same weight as a smaller area will have more effect in
1301 the metering result. Metering areas can partially overlap and the
1302 camera device will add the weights in the overlap region.
1304 The weights are relative to weights of other white balance metering regions, so if
1305 only one region is used, all non-zero weights will have the same effect. A region with
1306 0 weight is ignored.
1308 If all regions have 0 weight, then no specific metering area needs to be used by the
1311 If the metering region is outside the used android.scaler.cropRegion returned in
1312 capture result metadata, the camera device will ignore the sections outside the crop
1313 region and output only the intersection rectangle as the metering region in the result
1314 metadata. If the region is entirely outside the crop region, it will be ignored and
1315 not reported in the result metadata.
1318 The data representation is `int[5 * area_count]`.
1319 Every five elements represent a metering region of `(xmin, ymin, xmax, ymax, weight)`.
1320 The rectangle is defined to be inclusive on xmin and ymin, but exclusive on xmax and
1324 The HAL level representation of MeteringRectangle[] is a
1325 int[5 * area_count].
1326 Every five elements represent a metering region of
1327 (xmin, ymin, xmax, ymax, weight).
1328 The rectangle is defined to be inclusive on xmin and ymin, but
1329 exclusive on xmax and ymax.
1333 <entry name="captureIntent" type="byte" visibility="public" enum="true"
1337 <notes>The goal of this request doesn't fall into the other
1338 categories. The camera device will default to preview-like
1339 behavior.</notes></value>
1341 <notes>This request is for a preview-like use case.
1343 The precapture trigger may be used to start off a metering
1346 <value>STILL_CAPTURE
1347 <notes>This request is for a still capture-type
1350 If the flash unit is under automatic control, it may fire as needed.
1353 <notes>This request is for a video recording
1354 use case.</notes></value>
1355 <value>VIDEO_SNAPSHOT
1356 <notes>This request is for a video snapshot (still
1357 image while recording video) use case.
1359 The camera device should take the highest-quality image
1360 possible (given the other settings) without disrupting the
1361 frame rate of video recording. </notes></value>
1362 <value>ZERO_SHUTTER_LAG
1363 <notes>This request is for a ZSL usecase; the
1364 application will stream full-resolution images and
1365 reprocess one or several later for a final
1369 <notes>This request is for manual capture use case where
1370 the applications want to directly control the capture parameters.
1372 For example, the application may wish to manually control
1373 android.sensor.exposureTime, android.sensor.sensitivity, etc.
1375 <value hal_version="3.3">MOTION_TRACKING
1376 <notes>This request is for a motion tracking use case, where
1377 the application will use camera and inertial sensor data to
1378 locate and track objects in the world.
1380 The camera device auto-exposure routine will limit the exposure time
1381 of the camera to no more than 20 milliseconds, to minimize motion blur.
1384 <description>Information to the camera device 3A (auto-exposure,
1385 auto-focus, auto-white balance) routines about the purpose
1386 of this capture, to help the camera device to decide optimal 3A
1387 strategy.</description>
1388 <details>This control (except for MANUAL) is only effective if
1389 `android.control.mode != OFF` and any 3A routine is active.
1391 All intents are supported by all devices, except that:
1392 * ZERO_SHUTTER_LAG will be supported if android.request.availableCapabilities contains
1393 PRIVATE_REPROCESSING or YUV_REPROCESSING.
1394 * MANUAL will be supported if android.request.availableCapabilities contains
1396 * MOTION_TRACKING will be supported if android.request.availableCapabilities contains
1401 <entry name="effectMode" type="byte" visibility="public" enum="true"
1406 No color effect will be applied.
1409 <value optional="true">MONO
1411 A "monocolor" effect where the image is mapped into
1414 This will typically be grayscale.
1417 <value optional="true">NEGATIVE
1419 A "photo-negative" effect where the image's colors
1423 <value optional="true">SOLARIZE
1425 A "solarisation" effect (Sabattier effect) where the
1426 image is wholly or partially reversed in
1430 <value optional="true">SEPIA
1432 A "sepia" effect where the image is mapped into warm
1433 gray, red, and brown tones.
1436 <value optional="true">POSTERIZE
1438 A "posterization" effect where the image uses
1439 discrete regions of tone rather than a continuous
1443 <value optional="true">WHITEBOARD
1445 A "whiteboard" effect where the image is typically displayed
1446 as regions of white, with black or grey details.
1449 <value optional="true">BLACKBOARD
1451 A "blackboard" effect where the image is typically displayed
1452 as regions of black, with white or grey details.
1455 <value optional="true">AQUA
1457 An "aqua" effect where a blue hue is added to the image.
1461 <description>A special color effect to apply.</description>
1462 <range>android.control.availableEffects</range>
1464 When this mode is set, a color effect will be applied
1465 to images produced by the camera device. The interpretation
1466 and implementation of these color effects is left to the
1467 implementor of the camera device, and should not be
1468 depended on to be consistent (or present) across all
1473 <entry name="mode" type="byte" visibility="public" enum="true"
1477 <notes>Full application control of pipeline.
1479 All control by the device's metering and focusing (3A)
1480 routines is disabled, and no other settings in
1481 android.control.* have any effect, except that
1482 android.control.captureIntent may be used by the camera
1483 device to select post-processing values for processing
1484 blocks that do not allow for manual control, or are not
1485 exposed by the camera API.
1487 However, the camera device's 3A routines may continue to
1488 collect statistics and update their internal state so that
1489 when control is switched to AUTO mode, good control values
1490 can be immediately applied.
1493 <notes>Use settings for each individual 3A routine.
1495 Manual control of capture parameters is disabled. All
1496 controls in android.control.* besides sceneMode take
1497 effect.</notes></value>
1498 <value optional="true">USE_SCENE_MODE
1499 <notes>Use a specific scene mode.
1501 Enabling this disables control.aeMode, control.awbMode and
1502 control.afMode controls; the camera device will ignore
1503 those settings while USE_SCENE_MODE is active (except for
1504 FACE_PRIORITY scene mode). Other control entries are still active.
1505 This setting can only be used if scene mode is supported (i.e.
1506 android.control.availableSceneModes
1507 contain some modes other than DISABLED).</notes></value>
1508 <value optional="true">OFF_KEEP_STATE
1509 <notes>Same as OFF mode, except that this capture will not be
1510 used by camera device background auto-exposure, auto-white balance and
1511 auto-focus algorithms (3A) to update their statistics.
1513 Specifically, the 3A routines are locked to the last
1514 values set from a request with AUTO, OFF, or
1515 USE_SCENE_MODE, and any statistics or state updates
1516 collected from manual captures with OFF_KEEP_STATE will be
1517 discarded by the camera device.
1520 <description>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control
1521 routines.</description>
1522 <range>android.control.availableModes</range>
1524 This is a top-level 3A control switch. When set to OFF, all 3A control
1525 by the camera device is disabled. The application must set the fields for
1526 capture parameters itself.
1528 When set to AUTO, the individual algorithm controls in
1529 android.control.* are in effect, such as android.control.afMode.
1531 When set to USE_SCENE_MODE, the individual controls in
1532 android.control.* are mostly disabled, and the camera device
1533 implements one of the scene mode settings (such as ACTION,
1534 SUNSET, or PARTY) as it wishes. The camera device scene mode
1535 3A settings are provided by {@link
1536 android.hardware.camera2.CaptureResult|ACameraCaptureSession_captureCallback_result
1539 When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference
1540 is that this frame will not be used by camera device background 3A statistics
1541 update, as if this frame is never captured. This mode can be used in the scenario
1542 where the application doesn't want a 3A manual control capture to affect
1543 the subsequent auto 3A capture results.
1547 <entry name="sceneMode" type="byte" visibility="public" enum="true"
1550 <value id="0">DISABLED
1552 Indicates that no scene modes are set for a given capture request.
1555 <value>FACE_PRIORITY
1556 <notes>If face detection support exists, use face
1557 detection data for auto-focus, auto-white balance, and
1558 auto-exposure routines.
1560 If face detection statistics are disabled
1561 (i.e. android.statistics.faceDetectMode is set to OFF),
1562 this should still operate correctly (but will not return
1563 face detection statistics to the framework).
1565 Unlike the other scene modes, android.control.aeMode,
1566 android.control.awbMode, and android.control.afMode
1567 remain active when FACE_PRIORITY is set.
1570 <value optional="true">ACTION
1572 Optimized for photos of quickly moving objects.
1577 <value optional="true">PORTRAIT
1579 Optimized for still photos of people.
1582 <value optional="true">LANDSCAPE
1584 Optimized for photos of distant macroscopic objects.
1587 <value optional="true">NIGHT
1589 Optimized for low-light settings.
1592 <value optional="true">NIGHT_PORTRAIT
1594 Optimized for still photos of people in low-light
1598 <value optional="true">THEATRE
1600 Optimized for dim, indoor settings where flash must
1604 <value optional="true">BEACH
1606 Optimized for bright, outdoor beach settings.
1609 <value optional="true">SNOW
1611 Optimized for bright, outdoor settings containing snow.
1614 <value optional="true">SUNSET
1616 Optimized for scenes of the setting sun.
1619 <value optional="true">STEADYPHOTO
1621 Optimized to avoid blurry photos due to small amounts of
1622 device motion (for example: due to hand shake).
1625 <value optional="true">FIREWORKS
1627 Optimized for nighttime photos of fireworks.
1630 <value optional="true">SPORTS
1632 Optimized for photos of quickly moving people.
1637 <value optional="true">PARTY
1639 Optimized for dim, indoor settings with multiple moving
1643 <value optional="true">CANDLELIGHT
1645 Optimized for dim settings where the main light source
1649 <value optional="true">BARCODE
1651 Optimized for accurately capturing a photo of barcode
1652 for use by camera applications that wish to read the
1656 <value deprecated="true" optional="true" ndk_hidden="true">HIGH_SPEED_VIDEO
1658 This is deprecated, please use {@link
1659 android.hardware.camera2.CameraDevice#createConstrainedHighSpeedCaptureSession}
1661 android.hardware.camera2.CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList}
1662 for high speed video recording.
1664 Optimized for high speed video recording (frame rate >=60fps) use case.
1666 The supported high speed video sizes and fps ranges are specified in
1667 android.control.availableHighSpeedVideoConfigurations. To get desired
1668 output frame rates, the application is only allowed to select video size
1669 and fps range combinations listed in this static metadata. The fps range
1670 can be control via android.control.aeTargetFpsRange.
1672 In this mode, the camera device will override aeMode, awbMode, and afMode to
1673 ON, ON, and CONTINUOUS_VIDEO, respectively. All post-processing block mode
1674 controls will be overridden to be FAST. Therefore, no manual control of capture
1675 and post-processing parameters is possible. All other controls operate the
1676 same as when android.control.mode == AUTO. This means that all other
1677 android.control.* fields continue to work, such as
1679 * android.control.aeTargetFpsRange
1680 * android.control.aeExposureCompensation
1681 * android.control.aeLock
1682 * android.control.awbLock
1683 * android.control.effectMode
1684 * android.control.aeRegions
1685 * android.control.afRegions
1686 * android.control.awbRegions
1687 * android.control.afTrigger
1688 * android.control.aePrecaptureTrigger
1690 Outside of android.control.*, the following controls will work:
1692 * android.flash.mode (automatic flash for still capture will not work since aeMode is ON)
1693 * android.lens.opticalStabilizationMode (if it is supported)
1694 * android.scaler.cropRegion
1695 * android.statistics.faceDetectMode
1697 For high speed recording use case, the actual maximum supported frame rate may
1698 be lower than what camera can output, depending on the destination Surfaces for
1699 the image data. For example, if the destination surface is from video encoder,
1700 the application need check if the video encoder is capable of supporting the
1701 high frame rate for a given video size, or it will end up with lower recording
1702 frame rate. If the destination surface is from preview window, the preview frame
1703 rate will be bounded by the screen refresh rate.
1705 The camera device will only support up to 2 output high speed streams
1706 (processed non-stalling format defined in android.request.maxNumOutputStreams)
1707 in this mode. This control will be effective only if all of below conditions are true:
1709 * The application created no more than maxNumHighSpeedStreams processed non-stalling
1710 format output streams, where maxNumHighSpeedStreams is calculated as
1711 min(2, android.request.maxNumOutputStreams[Processed (but not-stalling)]).
1712 * The stream sizes are selected from the sizes reported by
1713 android.control.availableHighSpeedVideoConfigurations.
1714 * No processed non-stalling or raw streams are configured.
1716 When above conditions are NOT satistied, the controls of this mode and
1717 android.control.aeTargetFpsRange will be ignored by the camera device,
1718 the camera device will fall back to android.control.mode `==` AUTO,
1719 and the returned capture result metadata will give the fps range choosen
1720 by the camera device.
1722 Switching into or out of this mode may trigger some camera ISP/sensor
1723 reconfigurations, which may introduce extra latency. It is recommended that
1724 the application avoids unnecessary scene mode switch as much as possible.
1727 <value optional="true">HDR
1729 Turn on a device-specific high dynamic range (HDR) mode.
1731 In this scene mode, the camera device captures images
1732 that keep a larger range of scene illumination levels
1733 visible in the final image. For example, when taking a
1734 picture of a object in front of a bright window, both
1735 the object and the scene through the window may be
1736 visible when using HDR mode, while in normal AUTO mode,
1737 one or the other may be poorly exposed. As a tradeoff,
1738 HDR mode generally takes much longer to capture a single
1739 image, has no user control, and may have other artifacts
1740 depending on the HDR method used.
1742 Therefore, HDR captures operate at a much slower rate
1743 than regular captures.
1745 In this mode, on LIMITED or FULL devices, when a request
1746 is made with a android.control.captureIntent of
1747 STILL_CAPTURE, the camera device will capture an image
1748 using a high dynamic range capture technique. On LEGACY
1749 devices, captures that target a JPEG-format output will
1750 be captured with HDR, and the capture intent is not
1753 The HDR capture may involve the device capturing a burst
1754 of images internally and combining them into one, or it
1755 may involve the device using specialized high dynamic
1756 range capture hardware. In all cases, a single image is
1757 produced in response to a capture request submitted
1760 Since substantial post-processing is generally needed to
1761 produce an HDR image, only YUV, PRIVATE, and JPEG
1762 outputs are supported for LIMITED/FULL device HDR
1763 captures, and only JPEG outputs are supported for LEGACY
1764 HDR captures. Using a RAW output for HDR capture is not
1767 Some devices may also support always-on HDR, which
1768 applies HDR processing at full frame rate. For these
1769 devices, intents other than STILL_CAPTURE will also
1770 produce an HDR output with no frame rate impact compared
1771 to normal operation, though the quality may be lower
1772 than for STILL_CAPTURE intents.
1774 If SCENE_MODE_HDR is used with unsupported output types
1775 or capture intents, the images captured will be as if
1776 the SCENE_MODE was not enabled at all.
1779 <value optional="true" hidden="true">FACE_PRIORITY_LOW_LIGHT
1780 <notes>Same as FACE_PRIORITY scene mode, except that the camera
1781 device will choose higher sensitivity values (android.sensor.sensitivity)
1782 under low light conditions.
1784 The camera device may be tuned to expose the images in a reduced
1785 sensitivity range to produce the best quality images. For example,
1786 if the android.sensor.info.sensitivityRange gives range of [100, 1600],
1787 the camera device auto-exposure routine tuning process may limit the actual
1788 exposure sensitivity range to [100, 1200] to ensure that the noise level isn't
1789 exessive in order to preserve the image quality. Under this situation, the image under
1790 low light may be under-exposed when the sensor max exposure time (bounded by the
1791 android.control.aeTargetFpsRange when android.control.aeMode is one of the
1792 ON_* modes) and effective max sensitivity are reached. This scene mode allows the
1793 camera device auto-exposure routine to increase the sensitivity up to the max
1794 sensitivity specified by android.sensor.info.sensitivityRange when the scene is too
1795 dark and the max exposure time is reached. The captured images may be noisier
1796 compared with the images captured in normal FACE_PRIORITY mode; therefore, it is
1797 recommended that the application only use this scene mode when it is capable of
1798 reducing the noise level of the captured images.
1800 Unlike the other scene modes, android.control.aeMode,
1801 android.control.awbMode, and android.control.afMode
1802 remain active when FACE_PRIORITY_LOW_LIGHT is set.
1805 <value optional="true" hidden="true" id="100">DEVICE_CUSTOM_START
1807 Scene mode values within the range of
1808 `[DEVICE_CUSTOM_START, DEVICE_CUSTOM_END]` are reserved for device specific
1809 customized scene modes.
1812 <value optional="true" hidden="true" id="127">DEVICE_CUSTOM_END
1814 Scene mode values within the range of
1815 `[DEVICE_CUSTOM_START, DEVICE_CUSTOM_END]` are reserved for device specific
1816 customized scene modes.
1821 Control for which scene mode is currently active.
1823 <range>android.control.availableSceneModes</range>
1825 Scene modes are custom camera modes optimized for a certain set of conditions and
1828 This is the mode that that is active when
1829 `android.control.mode == USE_SCENE_MODE`. Aside from FACE_PRIORITY, these modes will
1830 disable android.control.aeMode, android.control.awbMode, and android.control.afMode
1833 The interpretation and implementation of these scene modes is left
1834 to the implementor of the camera device. Their behavior will not be
1835 consistent across all devices, and any given device may only implement
1836 a subset of these modes.
1839 HAL implementations that include scene modes are expected to provide
1840 the per-scene settings to use for android.control.aeMode,
1841 android.control.awbMode, and android.control.afMode in
1842 android.control.sceneModeOverrides.
1844 For HIGH_SPEED_VIDEO mode, if it is included in android.control.availableSceneModes, the
1845 HAL must list supported video size and fps range in
1846 android.control.availableHighSpeedVideoConfigurations. For a given size, e.g. 1280x720,
1847 if the HAL has two different sensor configurations for normal streaming mode and high
1848 speed streaming, when this scene mode is set/reset in a sequence of capture requests, the
1849 HAL may have to switch between different sensor modes. This mode is deprecated in legacy
1850 HAL3.3, to support high speed video recording, please implement
1851 android.control.availableHighSpeedVideoConfigurations and CONSTRAINED_HIGH_SPEED_VIDEO
1852 capbility defined in android.request.availableCapabilities.
1856 <entry name="videoStabilizationMode" type="byte" visibility="public"
1857 enum="true" hwlevel="legacy">
1861 Video stabilization is disabled.
1865 Video stabilization is enabled.
1868 <description>Whether video stabilization is
1869 active.</description>
1871 Video stabilization automatically warps images from
1872 the camera in order to stabilize motion between consecutive frames.
1874 If enabled, video stabilization can modify the
1875 android.scaler.cropRegion to keep the video stream stabilized.
1877 Switching between different video stabilization modes may take several
1878 frames to initialize, the camera device will report the current mode
1879 in capture result metadata. For example, When "ON" mode is requested,
1880 the video stabilization modes in the first several capture results may
1881 still be "OFF", and it will become "ON" when the initialization is
1884 In addition, not all recording sizes or frame rates may be supported for
1885 stabilization by a device that reports stabilization support. It is guaranteed
1886 that an output targeting a MediaRecorder or MediaCodec will be stabilized if
1887 the recording resolution is less than or equal to 1920 x 1080 (width less than
1888 or equal to 1920, height less than or equal to 1080), and the recording
1889 frame rate is less than or equal to 30fps. At other sizes, the CaptureResult
1890 android.control.videoStabilizationMode field will return
1891 OFF if the recording output is not stabilized, or if there are no output
1892 Surface types that can be stabilized.
1894 If a camera device supports both this mode and OIS
1895 (android.lens.opticalStabilizationMode), turning both modes on may
1896 produce undesirable interaction, so it is recommended not to enable
1897 both at the same time.
1903 <entry name="aeAvailableAntibandingModes" type="byte" visibility="public"
1904 type_notes="list of enums" container="array" typedef="enumList"
1910 List of auto-exposure antibanding modes for android.control.aeAntibandingMode that are
1911 supported by this camera device.
1913 <range>Any value listed in android.control.aeAntibandingMode</range>
1915 Not all of the auto-exposure anti-banding modes may be
1916 supported by a given camera device. This field lists the
1917 valid anti-banding modes that the application may request
1918 for this camera device with the
1919 android.control.aeAntibandingMode control.
1923 <entry name="aeAvailableModes" type="byte" visibility="public"
1924 type_notes="list of enums" container="array" typedef="enumList"
1930 List of auto-exposure modes for android.control.aeMode that are supported by this camera
1933 <range>Any value listed in android.control.aeMode</range>
1935 Not all the auto-exposure modes may be supported by a
1936 given camera device, especially if no flash unit is
1937 available. This entry lists the valid modes for
1938 android.control.aeMode for this camera device.
1940 All camera devices support ON, and all camera devices with flash
1941 units support ON_AUTO_FLASH and ON_ALWAYS_FLASH.
1943 FULL mode camera devices always support OFF mode,
1944 which enables application control of camera exposure time,
1945 sensitivity, and frame duration.
1947 LEGACY mode camera devices never support OFF mode.
1948 LIMITED mode devices support OFF if they support the MANUAL_SENSOR
1953 <entry name="aeAvailableTargetFpsRanges" type="int32" visibility="public"
1954 type_notes="list of pairs of frame rates"
1955 container="array" typedef="rangeInt"
1961 <description>List of frame rate ranges for android.control.aeTargetFpsRange supported by
1962 this camera device.</description>
1963 <units>Frames per second (FPS)</units>
1965 For devices at the LEGACY level or above:
1967 * For constant-framerate recording, for each normal
1968 {@link android.media.CamcorderProfile CamcorderProfile}, that is, a
1969 {@link android.media.CamcorderProfile CamcorderProfile} that has
1970 {@link android.media.CamcorderProfile#quality quality} in
1971 the range [{@link android.media.CamcorderProfile#QUALITY_LOW QUALITY_LOW},
1972 {@link android.media.CamcorderProfile#QUALITY_2160P QUALITY_2160P}], if the profile is
1973 supported by the device and has
1974 {@link android.media.CamcorderProfile#videoFrameRate videoFrameRate} `x`, this list will
1975 always include (`x`,`x`).
1977 * Also, a camera device must either not support any
1978 {@link android.media.CamcorderProfile CamcorderProfile},
1979 or support at least one
1980 normal {@link android.media.CamcorderProfile CamcorderProfile} that has
1981 {@link android.media.CamcorderProfile#videoFrameRate videoFrameRate} `x` >= 24.
1983 For devices at the LIMITED level or above:
1985 * For YUV_420_888 burst capture use case, this list will always include (`min`, `max`)
1986 and (`max`, `max`) where `min` <= 15 and `max` = the maximum output frame rate of the
1987 maximum YUV_420_888 output size.
1991 <entry name="aeCompensationRange" type="int32" visibility="public"
1992 container="array" typedef="rangeInt"
1997 <description>Maximum and minimum exposure compensation values for
1998 android.control.aeExposureCompensation, in counts of android.control.aeCompensationStep,
1999 that are supported by this camera device.</description>
2001 Range [0,0] indicates that exposure compensation is not supported.
2003 For LIMITED and FULL devices, range must follow below requirements if exposure
2004 compensation is supported (`range != [0, 0]`):
2006 `Min.exposure compensation * android.control.aeCompensationStep <= -2 EV`
2008 `Max.exposure compensation * android.control.aeCompensationStep >= 2 EV`
2010 LEGACY devices may support a smaller range than this.
2014 <entry name="aeCompensationStep" type="rational" visibility="public"
2016 <description>Smallest step by which the exposure compensation
2017 can be changed.</description>
2018 <units>Exposure Value (EV)</units>
2020 This is the unit for android.control.aeExposureCompensation. For example, if this key has
2021 a value of `1/2`, then a setting of `-2` for android.control.aeExposureCompensation means
2022 that the target EV offset for the auto-exposure routine is -1 EV.
2024 One unit of EV compensation changes the brightness of the captured image by a factor
2025 of two. +1 EV doubles the image brightness, while -1 EV halves the image brightness.
2028 This must be less than or equal to 1/2.
2032 <entry name="afAvailableModes" type="byte" visibility="public"
2033 type_notes="List of enums" container="array" typedef="enumList"
2039 List of auto-focus (AF) modes for android.control.afMode that are
2040 supported by this camera device.
2042 <range>Any value listed in android.control.afMode</range>
2044 Not all the auto-focus modes may be supported by a
2045 given camera device. This entry lists the valid modes for
2046 android.control.afMode for this camera device.
2048 All LIMITED and FULL mode camera devices will support OFF mode, and all
2049 camera devices with adjustable focuser units
2050 (`android.lens.info.minimumFocusDistance > 0`) will support AUTO mode.
2052 LEGACY devices will support OFF mode only if they support
2053 focusing to infinity (by also setting android.lens.focusDistance to
2058 <entry name="availableEffects" type="byte" visibility="public"
2059 type_notes="List of enums (android.control.effectMode)." container="array"
2060 typedef="enumList" hwlevel="legacy">
2065 List of color effects for android.control.effectMode that are supported by this camera
2068 <range>Any value listed in android.control.effectMode</range>
2070 This list contains the color effect modes that can be applied to
2071 images produced by the camera device.
2072 Implementations are not expected to be consistent across all devices.
2073 If no color effect modes are available for a device, this will only list
2076 A color effect will only be applied if
2077 android.control.mode != OFF. OFF is always included in this list.
2079 This control has no effect on the operation of other control routines such
2080 as auto-exposure, white balance, or focus.
2084 <entry name="availableSceneModes" type="byte" visibility="public"
2085 type_notes="List of enums (android.control.sceneMode)."
2086 container="array" typedef="enumList" hwlevel="legacy">
2091 List of scene modes for android.control.sceneMode that are supported by this camera
2094 <range>Any value listed in android.control.sceneMode</range>
2096 This list contains scene modes that can be set for the camera device.
2097 Only scene modes that have been fully implemented for the
2098 camera device may be included here. Implementations are not expected
2099 to be consistent across all devices.
2101 If no scene modes are supported by the camera device, this
2102 will be set to DISABLED. Otherwise DISABLED will not be listed.
2104 FACE_PRIORITY is always listed if face detection is
2105 supported (i.e.`android.statistics.info.maxFaceCount >
2110 <entry name="availableVideoStabilizationModes" type="byte"
2111 visibility="public" type_notes="List of enums." container="array"
2112 typedef="enumList" hwlevel="legacy">
2117 List of video stabilization modes for android.control.videoStabilizationMode
2118 that are supported by this camera device.
2120 <range>Any value listed in android.control.videoStabilizationMode</range>
2122 OFF will always be listed.
2126 <entry name="awbAvailableModes" type="byte" visibility="public"
2127 type_notes="List of enums"
2128 container="array" typedef="enumList" hwlevel="legacy">
2133 List of auto-white-balance modes for android.control.awbMode that are supported by this
2136 <range>Any value listed in android.control.awbMode</range>
2138 Not all the auto-white-balance modes may be supported by a
2139 given camera device. This entry lists the valid modes for
2140 android.control.awbMode for this camera device.
2142 All camera devices will support ON mode.
2144 Camera devices that support the MANUAL_POST_PROCESSING capability will always support OFF
2145 mode, which enables application control of white balance, by using
2146 android.colorCorrection.transform and android.colorCorrection.gains
2147 (android.colorCorrection.mode must be set to TRANSFORM_MATRIX). This includes all FULL
2148 mode camera devices.
2152 <entry name="maxRegions" type="int32" visibility="ndk_public"
2153 container="array" hwlevel="legacy">
2158 List of the maximum number of regions that can be used for metering in
2159 auto-exposure (AE), auto-white balance (AWB), and auto-focus (AF);
2160 this corresponds to the the maximum number of elements in
2161 android.control.aeRegions, android.control.awbRegions,
2162 and android.control.afRegions.
2165 Value must be &gt;= 0 for each element. For full-capability devices
2166 this value must be &gt;= 1 for AE and AF. The order of the elements is:
2167 `(AE, AWB, AF)`.</range>
2170 <entry name="maxRegionsAe" type="int32" visibility="java_public"
2171 synthetic="true" hwlevel="legacy">
2173 The maximum number of metering regions that can be used by the auto-exposure (AE)
2176 <range>Value will be &gt;= 0. For FULL-capability devices, this
2177 value will be &gt;= 1.
2180 This corresponds to the the maximum allowed number of elements in
2181 android.control.aeRegions.
2183 <hal_details>This entry is private to the framework. Fill in
2184 maxRegions to have this entry be automatically populated.
2187 <entry name="maxRegionsAwb" type="int32" visibility="java_public"
2188 synthetic="true" hwlevel="legacy">
2190 The maximum number of metering regions that can be used by the auto-white balance (AWB)
2193 <range>Value will be &gt;= 0.
2196 This corresponds to the the maximum allowed number of elements in
2197 android.control.awbRegions.
2199 <hal_details>This entry is private to the framework. Fill in
2200 maxRegions to have this entry be automatically populated.
2203 <entry name="maxRegionsAf" type="int32" visibility="java_public"
2204 synthetic="true" hwlevel="legacy">
2206 The maximum number of metering regions that can be used by the auto-focus (AF) routine.
2208 <range>Value will be &gt;= 0. For FULL-capability devices, this
2209 value will be &gt;= 1.
2212 This corresponds to the the maximum allowed number of elements in
2213 android.control.afRegions.
2215 <hal_details>This entry is private to the framework. Fill in
2216 maxRegions to have this entry be automatically populated.
2219 <entry name="sceneModeOverrides" type="byte" visibility="system"
2220 container="array" hwlevel="limited">
2223 <size>length(availableSceneModes)</size>
2226 Ordered list of auto-exposure, auto-white balance, and auto-focus
2227 settings to use with each available scene mode.
2230 For each available scene mode, the list must contain three
2231 entries containing the android.control.aeMode,
2232 android.control.awbMode, and android.control.afMode values used
2233 by the camera device. The entry order is `(aeMode, awbMode, afMode)`
2234 where aeMode has the lowest index position.
2237 When a scene mode is enabled, the camera device is expected
2238 to override android.control.aeMode, android.control.awbMode,
2239 and android.control.afMode with its preferred settings for
2242 The order of this list matches that of availableSceneModes,
2243 with 3 entries for each mode. The overrides listed
2244 for FACE_PRIORITY and FACE_PRIORITY_LOW_LIGHT (if supported) are ignored,
2245 since for that mode the application-set android.control.aeMode,
2246 android.control.awbMode, and android.control.afMode values are
2247 used instead, matching the behavior when android.control.mode
2248 is set to AUTO. It is recommended that the FACE_PRIORITY and
2249 FACE_PRIORITY_LOW_LIGHT (if supported) overrides should be set to 0.
2251 For example, if availableSceneModes contains
2252 `(FACE_PRIORITY, ACTION, NIGHT)`, then the camera framework
2253 expects sceneModeOverrides to have 9 entries formatted like:
2254 `(0, 0, 0, ON_AUTO_FLASH, AUTO, CONTINUOUS_PICTURE,
2255 ON_AUTO_FLASH, INCANDESCENT, AUTO)`.
2258 To maintain backward compatibility, this list will be made available
2259 in the static metadata of the camera service. The camera service will
2260 use these values to set android.control.aeMode,
2261 android.control.awbMode, and android.control.afMode when using a scene
2262 mode other than FACE_PRIORITY and FACE_PRIORITY_LOW_LIGHT (if supported).
2268 <entry name="aePrecaptureId" type="int32" visibility="system" deprecated="true">
2269 <description>The ID sent with the latest
2270 CAMERA2_TRIGGER_PRECAPTURE_METERING call</description>
2271 <details>Must be 0 if no
2272 CAMERA2_TRIGGER_PRECAPTURE_METERING trigger received yet
2273 by HAL. Always updated even if AE algorithm ignores the
2276 <clone entry="android.control.aeAntibandingMode" kind="controls">
2278 <clone entry="android.control.aeExposureCompensation" kind="controls">
2280 <clone entry="android.control.aeLock" kind="controls">
2282 <clone entry="android.control.aeMode" kind="controls">
2284 <clone entry="android.control.aeRegions" kind="controls">
2286 <clone entry="android.control.aeTargetFpsRange" kind="controls">
2288 <clone entry="android.control.aePrecaptureTrigger" kind="controls">
2290 <entry name="aeState" type="byte" visibility="public" enum="true"
2294 <notes>AE is off or recently reset.
2296 When a camera device is opened, it starts in
2297 this state. This is a transient state, the camera device may skip reporting
2298 this state in capture result.</notes></value>
2300 <notes>AE doesn't yet have a good set of control values
2301 for the current scene.
2303 This is a transient state, the camera device may skip
2304 reporting this state in capture result.</notes></value>
2306 <notes>AE has a good set of control values for the
2307 current scene.</notes></value>
2309 <notes>AE has been locked.</notes></value>
2310 <value>FLASH_REQUIRED
2311 <notes>AE has a good set of control values, but flash
2312 needs to be fired for good quality still
2313 capture.</notes></value>
2315 <notes>AE has been asked to do a precapture sequence
2316 and is currently executing it.
2318 Precapture can be triggered through setting
2319 android.control.aePrecaptureTrigger to START. Currently
2320 active and completed (if it causes camera device internal AE lock) precapture
2321 metering sequence can be canceled through setting
2322 android.control.aePrecaptureTrigger to CANCEL.
2324 Once PRECAPTURE completes, AE will transition to CONVERGED
2325 or FLASH_REQUIRED as appropriate. This is a transient
2326 state, the camera device may skip reporting this state in
2327 capture result.</notes></value>
2329 <description>Current state of the auto-exposure (AE) algorithm.</description>
2330 <details>Switching between or enabling AE modes (android.control.aeMode) always
2331 resets the AE state to INACTIVE. Similarly, switching between android.control.mode,
2332 or android.control.sceneMode if `android.control.mode == USE_SCENE_MODE` resets all
2333 the algorithm states to INACTIVE.
2335 The camera device can do several state transitions between two results, if it is
2336 allowed by the state transition table. For example: INACTIVE may never actually be
2339 The state in the result is the state for this image (in sync with this image): if
2340 AE state becomes CONVERGED, then the image data associated with this result should
2343 Below are state transition tables for different AE modes.
2345 State | Transition Cause | New State | Notes
2346 :------------:|:----------------:|:---------:|:-----------------------:
2347 INACTIVE | | INACTIVE | Camera device auto exposure algorithm is disabled
2349 When android.control.aeMode is AE_MODE_ON*:
2351 State | Transition Cause | New State | Notes
2352 :-------------:|:--------------------------------------------:|:--------------:|:-----------------:
2353 INACTIVE | Camera device initiates AE scan | SEARCHING | Values changing
2354 INACTIVE | android.control.aeLock is ON | LOCKED | Values locked
2355 SEARCHING | Camera device finishes AE scan | CONVERGED | Good values, not changing
2356 SEARCHING | Camera device finishes AE scan | FLASH_REQUIRED | Converged but too dark w/o flash
2357 SEARCHING | android.control.aeLock is ON | LOCKED | Values locked
2358 CONVERGED | Camera device initiates AE scan | SEARCHING | Values changing
2359 CONVERGED | android.control.aeLock is ON | LOCKED | Values locked
2360 FLASH_REQUIRED | Camera device initiates AE scan | SEARCHING | Values changing
2361 FLASH_REQUIRED | android.control.aeLock is ON | LOCKED | Values locked
2362 LOCKED | android.control.aeLock is OFF | SEARCHING | Values not good after unlock
2363 LOCKED | android.control.aeLock is OFF | CONVERGED | Values good after unlock
2364 LOCKED | android.control.aeLock is OFF | FLASH_REQUIRED | Exposure good, but too dark
2365 PRECAPTURE | Sequence done. android.control.aeLock is OFF | CONVERGED | Ready for high-quality capture
2366 PRECAPTURE | Sequence done. android.control.aeLock is ON | LOCKED | Ready for high-quality capture
2367 LOCKED | aeLock is ON and aePrecaptureTrigger is START | LOCKED | Precapture trigger is ignored when AE is already locked
2368 LOCKED | aeLock is ON and aePrecaptureTrigger is CANCEL| LOCKED | Precapture trigger is ignored when AE is already locked
2369 Any state (excluding LOCKED) | android.control.aePrecaptureTrigger is START | PRECAPTURE | Start AE precapture metering sequence
2370 Any state (excluding LOCKED) | android.control.aePrecaptureTrigger is CANCEL| INACTIVE | Currently active precapture metering sequence is canceled
2372 If the camera device supports AE external flash mode (ON_EXTERNAL_FLASH is included in
2373 android.control.aeAvailableModes), aeState must be FLASH_REQUIRED after the camera device
2374 finishes AE scan and it's too dark without flash.
2376 For the above table, the camera device may skip reporting any state changes that happen
2377 without application intervention (i.e. mode switch, trigger, locking). Any state that
2378 can be skipped in that manner is called a transient state.
2380 For example, for above AE modes (AE_MODE_ON*), in addition to the state transitions
2381 listed in above table, it is also legal for the camera device to skip one or more
2382 transient states between two results. See below table for examples:
2384 State | Transition Cause | New State | Notes
2385 :-------------:|:-----------------------------------------------------------:|:--------------:|:-----------------:
2386 INACTIVE | Camera device finished AE scan | CONVERGED | Values are already good, transient states are skipped by camera device.
2387 Any state (excluding LOCKED) | android.control.aePrecaptureTrigger is START, sequence done | FLASH_REQUIRED | Converged but too dark w/o flash after a precapture sequence, transient states are skipped by camera device.
2388 Any state (excluding LOCKED) | android.control.aePrecaptureTrigger is START, sequence done | CONVERGED | Converged after a precapture sequence, transient states are skipped by camera device.
2389 Any state (excluding LOCKED) | android.control.aePrecaptureTrigger is CANCEL, converged | FLASH_REQUIRED | Converged but too dark w/o flash after a precapture sequence is canceled, transient states are skipped by camera device.
2390 Any state (excluding LOCKED) | android.control.aePrecaptureTrigger is CANCEL, converged | CONVERGED | Converged after a precapture sequenceis canceled, transient states are skipped by camera device.
2391 CONVERGED | Camera device finished AE scan | FLASH_REQUIRED | Converged but too dark w/o flash after a new scan, transient states are skipped by camera device.
2392 FLASH_REQUIRED | Camera device finished AE scan | CONVERGED | Converged after a new scan, transient states are skipped by camera device.
2395 <clone entry="android.control.afMode" kind="controls">
2397 <clone entry="android.control.afRegions" kind="controls">
2399 <clone entry="android.control.afTrigger" kind="controls">
2401 <entry name="afState" type="byte" visibility="public" enum="true"
2405 <notes>AF is off or has not yet tried to scan/been asked
2408 When a camera device is opened, it starts in this
2409 state. This is a transient state, the camera device may
2410 skip reporting this state in capture
2411 result.</notes></value>
2413 <notes>AF is currently performing an AF scan initiated the
2414 camera device in a continuous autofocus mode.
2416 Only used by CONTINUOUS_* AF modes. This is a transient
2417 state, the camera device may skip reporting this state in
2418 capture result.</notes></value>
2419 <value>PASSIVE_FOCUSED
2420 <notes>AF currently believes it is in focus, but may
2421 restart scanning at any time.
2423 Only used by CONTINUOUS_* AF modes. This is a transient
2424 state, the camera device may skip reporting this state in
2425 capture result.</notes></value>
2427 <notes>AF is performing an AF scan because it was
2428 triggered by AF trigger.
2430 Only used by AUTO or MACRO AF modes. This is a transient
2431 state, the camera device may skip reporting this state in
2432 capture result.</notes></value>
2433 <value>FOCUSED_LOCKED
2434 <notes>AF believes it is focused correctly and has locked
2437 This state is reached only after an explicit START AF trigger has been
2438 sent (android.control.afTrigger), when good focus has been obtained.
2440 The lens will remain stationary until the AF mode (android.control.afMode) is changed or
2441 a new AF trigger is sent to the camera device (android.control.afTrigger).
2443 <value>NOT_FOCUSED_LOCKED
2444 <notes>AF has failed to focus successfully and has locked
2447 This state is reached only after an explicit START AF trigger has been
2448 sent (android.control.afTrigger), when good focus cannot be obtained.
2450 The lens will remain stationary until the AF mode (android.control.afMode) is changed or
2451 a new AF trigger is sent to the camera device (android.control.afTrigger).
2453 <value>PASSIVE_UNFOCUSED
2454 <notes>AF finished a passive scan without finding focus,
2455 and may restart scanning at any time.
2457 Only used by CONTINUOUS_* AF modes. This is a transient state, the camera
2458 device may skip reporting this state in capture result.
2460 LEGACY camera devices do not support this state. When a passive
2461 scan has finished, it will always go to PASSIVE_FOCUSED.
2464 <description>Current state of auto-focus (AF) algorithm.</description>
2466 Switching between or enabling AF modes (android.control.afMode) always
2467 resets the AF state to INACTIVE. Similarly, switching between android.control.mode,
2468 or android.control.sceneMode if `android.control.mode == USE_SCENE_MODE` resets all
2469 the algorithm states to INACTIVE.
2471 The camera device can do several state transitions between two results, if it is
2472 allowed by the state transition table. For example: INACTIVE may never actually be
2475 The state in the result is the state for this image (in sync with this image): if
2476 AF state becomes FOCUSED, then the image data associated with this result should
2479 Below are state transition tables for different AF modes.
2481 When android.control.afMode is AF_MODE_OFF or AF_MODE_EDOF:
2483 State | Transition Cause | New State | Notes
2484 :------------:|:----------------:|:---------:|:-----------:
2485 INACTIVE | | INACTIVE | Never changes
2487 When android.control.afMode is AF_MODE_AUTO or AF_MODE_MACRO:
2489 State | Transition Cause | New State | Notes
2490 :-----------------:|:----------------:|:------------------:|:--------------:
2491 INACTIVE | AF_TRIGGER | ACTIVE_SCAN | Start AF sweep, Lens now moving
2492 ACTIVE_SCAN | AF sweep done | FOCUSED_LOCKED | Focused, Lens now locked
2493 ACTIVE_SCAN | AF sweep done | NOT_FOCUSED_LOCKED | Not focused, Lens now locked
2494 ACTIVE_SCAN | AF_CANCEL | INACTIVE | Cancel/reset AF, Lens now locked
2495 FOCUSED_LOCKED | AF_CANCEL | INACTIVE | Cancel/reset AF
2496 FOCUSED_LOCKED | AF_TRIGGER | ACTIVE_SCAN | Start new sweep, Lens now moving
2497 NOT_FOCUSED_LOCKED | AF_CANCEL | INACTIVE | Cancel/reset AF
2498 NOT_FOCUSED_LOCKED | AF_TRIGGER | ACTIVE_SCAN | Start new sweep, Lens now moving
2499 Any state | Mode change | INACTIVE |
2501 For the above table, the camera device may skip reporting any state changes that happen
2502 without application intervention (i.e. mode switch, trigger, locking). Any state that
2503 can be skipped in that manner is called a transient state.
2505 For example, for these AF modes (AF_MODE_AUTO and AF_MODE_MACRO), in addition to the
2506 state transitions listed in above table, it is also legal for the camera device to skip
2507 one or more transient states between two results. See below table for examples:
2509 State | Transition Cause | New State | Notes
2510 :-----------------:|:----------------:|:------------------:|:--------------:
2511 INACTIVE | AF_TRIGGER | FOCUSED_LOCKED | Focus is already good or good after a scan, lens is now locked.
2512 INACTIVE | AF_TRIGGER | NOT_FOCUSED_LOCKED | Focus failed after a scan, lens is now locked.
2513 FOCUSED_LOCKED | AF_TRIGGER | FOCUSED_LOCKED | Focus is already good or good after a scan, lens is now locked.
2514 NOT_FOCUSED_LOCKED | AF_TRIGGER | FOCUSED_LOCKED | Focus is good after a scan, lens is not locked.
2517 When android.control.afMode is AF_MODE_CONTINUOUS_VIDEO:
2519 State | Transition Cause | New State | Notes
2520 :-----------------:|:-----------------------------------:|:------------------:|:--------------:
2521 INACTIVE | Camera device initiates new scan | PASSIVE_SCAN | Start AF scan, Lens now moving
2522 INACTIVE | AF_TRIGGER | NOT_FOCUSED_LOCKED | AF state query, Lens now locked
2523 PASSIVE_SCAN | Camera device completes current scan| PASSIVE_FOCUSED | End AF scan, Lens now locked
2524 PASSIVE_SCAN | Camera device fails current scan | PASSIVE_UNFOCUSED | End AF scan, Lens now locked
2525 PASSIVE_SCAN | AF_TRIGGER | FOCUSED_LOCKED | Immediate transition, if focus is good. Lens now locked
2526 PASSIVE_SCAN | AF_TRIGGER | NOT_FOCUSED_LOCKED | Immediate transition, if focus is bad. Lens now locked
2527 PASSIVE_SCAN | AF_CANCEL | INACTIVE | Reset lens position, Lens now locked
2528 PASSIVE_FOCUSED | Camera device initiates new scan | PASSIVE_SCAN | Start AF scan, Lens now moving
2529 PASSIVE_UNFOCUSED | Camera device initiates new scan | PASSIVE_SCAN | Start AF scan, Lens now moving
2530 PASSIVE_FOCUSED | AF_TRIGGER | FOCUSED_LOCKED | Immediate transition, lens now locked
2531 PASSIVE_UNFOCUSED | AF_TRIGGER | NOT_FOCUSED_LOCKED | Immediate transition, lens now locked
2532 FOCUSED_LOCKED | AF_TRIGGER | FOCUSED_LOCKED | No effect
2533 FOCUSED_LOCKED | AF_CANCEL | INACTIVE | Restart AF scan
2534 NOT_FOCUSED_LOCKED | AF_TRIGGER | NOT_FOCUSED_LOCKED | No effect
2535 NOT_FOCUSED_LOCKED | AF_CANCEL | INACTIVE | Restart AF scan
2537 When android.control.afMode is AF_MODE_CONTINUOUS_PICTURE:
2539 State | Transition Cause | New State | Notes
2540 :-----------------:|:------------------------------------:|:------------------:|:--------------:
2541 INACTIVE | Camera device initiates new scan | PASSIVE_SCAN | Start AF scan, Lens now moving
2542 INACTIVE | AF_TRIGGER | NOT_FOCUSED_LOCKED | AF state query, Lens now locked
2543 PASSIVE_SCAN | Camera device completes current scan | PASSIVE_FOCUSED | End AF scan, Lens now locked
2544 PASSIVE_SCAN | Camera device fails current scan | PASSIVE_UNFOCUSED | End AF scan, Lens now locked
2545 PASSIVE_SCAN | AF_TRIGGER | FOCUSED_LOCKED | Eventual transition once the focus is good. Lens now locked
2546 PASSIVE_SCAN | AF_TRIGGER | NOT_FOCUSED_LOCKED | Eventual transition if cannot find focus. Lens now locked
2547 PASSIVE_SCAN | AF_CANCEL | INACTIVE | Reset lens position, Lens now locked
2548 PASSIVE_FOCUSED | Camera device initiates new scan | PASSIVE_SCAN | Start AF scan, Lens now moving
2549 PASSIVE_UNFOCUSED | Camera device initiates new scan | PASSIVE_SCAN | Start AF scan, Lens now moving
2550 PASSIVE_FOCUSED | AF_TRIGGER | FOCUSED_LOCKED | Immediate trans. Lens now locked
2551 PASSIVE_UNFOCUSED | AF_TRIGGER | NOT_FOCUSED_LOCKED | Immediate trans. Lens now locked
2552 FOCUSED_LOCKED | AF_TRIGGER | FOCUSED_LOCKED | No effect
2553 FOCUSED_LOCKED | AF_CANCEL | INACTIVE | Restart AF scan
2554 NOT_FOCUSED_LOCKED | AF_TRIGGER | NOT_FOCUSED_LOCKED | No effect
2555 NOT_FOCUSED_LOCKED | AF_CANCEL | INACTIVE | Restart AF scan
2557 When switch between AF_MODE_CONTINUOUS_* (CAF modes) and AF_MODE_AUTO/AF_MODE_MACRO
2558 (AUTO modes), the initial INACTIVE or PASSIVE_SCAN states may be skipped by the
2559 camera device. When a trigger is included in a mode switch request, the trigger
2560 will be evaluated in the context of the new mode in the request.
2561 See below table for examples:
2563 State | Transition Cause | New State | Notes
2564 :-----------:|:--------------------------------------:|:----------------------------------------:|:--------------:
2565 any state | CAF-->AUTO mode switch | INACTIVE | Mode switch without trigger, initial state must be INACTIVE
2566 any state | CAF-->AUTO mode switch with AF_TRIGGER | trigger-reachable states from INACTIVE | Mode switch with trigger, INACTIVE is skipped
2567 any state | AUTO-->CAF mode switch | passively reachable states from INACTIVE | Mode switch without trigger, passive transient state is skipped
2570 <entry name="afTriggerId" type="int32" visibility="system" deprecated="true">
2571 <description>The ID sent with the latest
2572 CAMERA2_TRIGGER_AUTOFOCUS call</description>
2573 <details>Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger
2574 received yet by HAL. Always updated even if AF algorithm
2575 ignores the trigger</details>
2577 <clone entry="android.control.awbLock" kind="controls">
2579 <clone entry="android.control.awbMode" kind="controls">
2581 <clone entry="android.control.awbRegions" kind="controls">
2583 <clone entry="android.control.captureIntent" kind="controls">
2585 <entry name="awbState" type="byte" visibility="public" enum="true"
2589 <notes>AWB is not in auto mode, or has not yet started metering.
2591 When a camera device is opened, it starts in this
2592 state. This is a transient state, the camera device may
2593 skip reporting this state in capture
2594 result.</notes></value>
2596 <notes>AWB doesn't yet have a good set of control
2597 values for the current scene.
2599 This is a transient state, the camera device
2600 may skip reporting this state in capture result.</notes></value>
2602 <notes>AWB has a good set of control values for the
2603 current scene.</notes></value>
2605 <notes>AWB has been locked.
2608 <description>Current state of auto-white balance (AWB) algorithm.</description>
2609 <details>Switching between or enabling AWB modes (android.control.awbMode) always
2610 resets the AWB state to INACTIVE. Similarly, switching between android.control.mode,
2611 or android.control.sceneMode if `android.control.mode == USE_SCENE_MODE` resets all
2612 the algorithm states to INACTIVE.
2614 The camera device can do several state transitions between two results, if it is
2615 allowed by the state transition table. So INACTIVE may never actually be seen in
2618 The state in the result is the state for this image (in sync with this image): if
2619 AWB state becomes CONVERGED, then the image data associated with this result should
2622 Below are state transition tables for different AWB modes.
2624 When `android.control.awbMode != AWB_MODE_AUTO`:
2626 State | Transition Cause | New State | Notes
2627 :------------:|:----------------:|:---------:|:-----------------------:
2628 INACTIVE | |INACTIVE |Camera device auto white balance algorithm is disabled
2630 When android.control.awbMode is AWB_MODE_AUTO:
2632 State | Transition Cause | New State | Notes
2633 :-------------:|:--------------------------------:|:-------------:|:-----------------:
2634 INACTIVE | Camera device initiates AWB scan | SEARCHING | Values changing
2635 INACTIVE | android.control.awbLock is ON | LOCKED | Values locked
2636 SEARCHING | Camera device finishes AWB scan | CONVERGED | Good values, not changing
2637 SEARCHING | android.control.awbLock is ON | LOCKED | Values locked
2638 CONVERGED | Camera device initiates AWB scan | SEARCHING | Values changing
2639 CONVERGED | android.control.awbLock is ON | LOCKED | Values locked
2640 LOCKED | android.control.awbLock is OFF | SEARCHING | Values not good after unlock
2642 For the above table, the camera device may skip reporting any state changes that happen
2643 without application intervention (i.e. mode switch, trigger, locking). Any state that
2644 can be skipped in that manner is called a transient state.
2646 For example, for this AWB mode (AWB_MODE_AUTO), in addition to the state transitions
2647 listed in above table, it is also legal for the camera device to skip one or more
2648 transient states between two results. See below table for examples:
2650 State | Transition Cause | New State | Notes
2651 :-------------:|:--------------------------------:|:-------------:|:-----------------:
2652 INACTIVE | Camera device finished AWB scan | CONVERGED | Values are already good, transient states are skipped by camera device.
2653 LOCKED | android.control.awbLock is OFF | CONVERGED | Values good after unlock, transient states are skipped by camera device.
2656 <clone entry="android.control.effectMode" kind="controls">
2658 <clone entry="android.control.mode" kind="controls">
2660 <clone entry="android.control.sceneMode" kind="controls">
2662 <clone entry="android.control.videoStabilizationMode" kind="controls">
2666 <entry name="availableHighSpeedVideoConfigurations" type="int32" visibility="hidden"
2667 container="array" typedef="highSpeedVideoConfiguration" hwlevel="limited">
2673 List of available high speed video size, fps range and max batch size configurations
2674 supported by the camera device, in the format of (width, height, fps_min, fps_max, batch_size_max).
2677 For each configuration, the fps_max &gt;= 120fps.
2680 When CONSTRAINED_HIGH_SPEED_VIDEO is supported in android.request.availableCapabilities,
2681 this metadata will list the supported high speed video size, fps range and max batch size
2682 configurations. All the sizes listed in this configuration will be a subset of the sizes
2683 reported by {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes}
2684 for processed non-stalling formats.
2686 For the high speed video use case, the application must
2687 select the video size and fps range from this metadata to configure the recording and
2688 preview streams and setup the recording requests. For example, if the application intends
2689 to do high speed recording, it can select the maximum size reported by this metadata to
2690 configure output streams. Once the size is selected, application can filter this metadata
2691 by selected size and get the supported fps ranges, and use these fps ranges to setup the
2692 recording requests. Note that for the use case of multiple output streams, application
2693 must select one unique size from this metadata to use (e.g., preview and recording streams
2694 must have the same size). Otherwise, the high speed capture session creation will fail.
2696 The min and max fps will be multiple times of 30fps.
2698 High speed video streaming extends significant performance pressue to camera hardware,
2699 to achieve efficient high speed streaming, the camera device may have to aggregate
2700 multiple frames together and send to camera device for processing where the request
2701 controls are same for all the frames in this batch. Max batch size indicates
2702 the max possible number of frames the camera device will group together for this high
2703 speed stream configuration. This max batch size will be used to generate a high speed
2704 recording request list by
2705 {@link android.hardware.camera2.CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList}.
2706 The max batch size for each configuration will satisfy below conditions:
2708 * Each max batch size will be a divisor of its corresponding fps_max / 30. For example,
2709 if max_fps is 300, max batch size will only be 1, 2, 5, or 10.
2710 * The camera device may choose smaller internal batch size for each configuration, but
2711 the actual batch size will be a divisor of max batch size. For example, if the max batch
2712 size is 8, the actual batch size used by camera device will only be 1, 2, 4, or 8.
2713 * The max batch size in each configuration entry must be no larger than 32.
2715 The camera device doesn't have to support batch mode to achieve high speed video recording,
2716 in such case, batch_size_max will be reported as 1 in each configuration entry.
2718 This fps ranges in this configuration list can only be used to create requests
2719 that are submitted to a high speed camera capture session created by
2720 {@link android.hardware.camera2.CameraDevice#createConstrainedHighSpeedCaptureSession}.
2721 The fps ranges reported in this metadata must not be used to setup capture requests for
2722 normal capture session, or it will cause request error.
2725 All the sizes listed in this configuration will be a subset of the sizes reported by
2726 android.scaler.availableStreamConfigurations for processed non-stalling output formats.
2727 Note that for all high speed video configurations, HAL must be able to support a minimum
2728 of two streams, though the application might choose to configure just one stream.
2730 The HAL may support multiple sensor modes for high speed outputs, for example, 120fps
2731 sensor mode and 120fps recording, 240fps sensor mode for 240fps recording. The application
2732 usually starts preview first, then starts recording. To avoid sensor mode switch caused
2733 stutter when starting recording as much as possible, the application may want to ensure
2734 the same sensor mode is used for preview and recording. Therefore, The HAL must advertise
2735 the variable fps range [30, fps_max] for each fixed fps range in this configuration list.
2736 For example, if the HAL advertises [120, 120] and [240, 240], the HAL must also advertise
2737 [30, 120] and [30, 240] for each configuration. In doing so, if the application intends to
2738 do 120fps recording, it can select [30, 120] to start preview, and [120, 120] to start
2739 recording. For these variable fps ranges, it's up to the HAL to decide the actual fps
2740 values that are suitable for smooth preview streaming. If the HAL sees different max_fps
2741 values that fall into different sensor modes in a sequence of requests, the HAL must
2742 switch the sensor mode as quick as possible to minimize the mode switch caused stutter.
2746 <entry name="aeLockAvailable" type="byte" visibility="public" enum="true"
2747 typedef="boolean" hwlevel="legacy">
2749 <value>FALSE</value>
2752 <description>Whether the camera device supports android.control.aeLock</description>
2754 Devices with MANUAL_SENSOR capability or BURST_CAPTURE capability will always
2755 list `true`. This includes FULL devices.
2759 <entry name="awbLockAvailable" type="byte" visibility="public" enum="true"
2760 typedef="boolean" hwlevel="legacy">
2762 <value>FALSE</value>
2765 <description>Whether the camera device supports android.control.awbLock</description>
2767 Devices with MANUAL_POST_PROCESSING capability or BURST_CAPTURE capability will
2768 always list `true`. This includes FULL devices.
2772 <entry name="availableModes" type="byte" visibility="public"
2773 type_notes="List of enums (android.control.mode)." container="array"
2774 typedef="enumList" hwlevel="legacy">
2779 List of control modes for android.control.mode that are supported by this camera
2782 <range>Any value listed in android.control.mode</range>
2784 This list contains control modes that can be set for the camera device.
2785 LEGACY mode devices will always support AUTO mode. LIMITED and FULL
2786 devices will always support OFF, AUTO modes.
2789 <entry name="postRawSensitivityBoostRange" type="int32" visibility="public"
2790 type_notes="Range of supported post RAW sensitivitiy boosts"
2791 container="array" typedef="rangeInt">
2795 <description>Range of boosts for android.control.postRawSensitivityBoost supported
2796 by this camera device.
2798 <units>ISO arithmetic units, the same as android.sensor.sensitivity</units>
2800 Devices support post RAW sensitivity boost will advertise
2801 android.control.postRawSensitivityBoost key for controling
2802 post RAW sensitivity boost.
2804 This key will be `null` for devices that do not support any RAW format
2805 outputs. For devices that do support RAW format outputs, this key will always
2806 present, and if a device does not support post RAW sensitivity boost, it will
2807 list `(100, 100)` in this key.
2810 This key is added in legacy HAL3.4. For legacy HAL3.3 or earlier devices, camera
2811 framework will generate this key as `(100, 100)` if device supports any of RAW output
2812 formats. All legacy HAL3.4 and above devices should list this key if device supports
2813 any of RAW output formats.
2818 <entry name="postRawSensitivityBoost" type="int32" visibility="public">
2819 <description>The amount of additional sensitivity boost applied to output images
2820 after RAW sensor data is captured.
2822 <units>ISO arithmetic units, the same as android.sensor.sensitivity</units>
2823 <range>android.control.postRawSensitivityBoostRange</range>
2825 Some camera devices support additional digital sensitivity boosting in the
2826 camera processing pipeline after sensor RAW image is captured.
2827 Such a boost will be applied to YUV/JPEG format output images but will not
2828 have effect on RAW output formats like RAW_SENSOR, RAW10, RAW12 or RAW_OPAQUE.
2830 This key will be `null` for devices that do not support any RAW format
2831 outputs. For devices that do support RAW format outputs, this key will always
2832 present, and if a device does not support post RAW sensitivity boost, it will
2833 list `100` in this key.
2835 If the camera device cannot apply the exact boost requested, it will reduce the
2836 boost to the nearest supported value.
2837 The final boost value used will be available in the output capture result.
2839 For devices that support post RAW sensitivity boost, the YUV/JPEG output images
2840 of such device will have the total sensitivity of
2841 `android.sensor.sensitivity * android.control.postRawSensitivityBoost / 100`
2842 The sensitivity of RAW format images will always be `android.sensor.sensitivity`
2844 This control is only effective if android.control.aeMode or android.control.mode is set to
2845 OFF; otherwise the auto-exposure algorithm will override this value.
2850 <clone entry="android.control.postRawSensitivityBoost" kind="controls">
2854 <entry name="enableZsl" type="byte" visibility="public" enum="true" typedef="boolean">
2857 <notes>Requests with android.control.captureIntent == STILL_CAPTURE must be captured
2858 after previous requests.</notes></value>
2860 <notes>Requests with android.control.captureIntent == STILL_CAPTURE may or may not be
2861 captured before previous requests.</notes></value>
2863 <description>Allow camera device to enable zero-shutter-lag mode for requests with
2864 android.control.captureIntent == STILL_CAPTURE.
2867 If enableZsl is `true`, the camera device may enable zero-shutter-lag mode for requests with
2868 STILL_CAPTURE capture intent. The camera device may use images captured in the past to
2869 produce output images for a zero-shutter-lag request. The result metadata including the
2870 android.sensor.timestamp reflects the source frames used to produce output images.
2871 Therefore, the contents of the output images and the result metadata may be out of order
2872 compared to previous regular requests. enableZsl does not affect requests with other
2875 For example, when requests are submitted in the following order:
2876 Request A: enableZsl is ON, android.control.captureIntent is PREVIEW
2877 Request B: enableZsl is ON, android.control.captureIntent is STILL_CAPTURE
2879 The output images for request B may have contents captured before the output images for
2880 request A, and the result metadata for request B may be older than the result metadata for
2883 Note that when enableZsl is `true`, it is not guaranteed to get output images captured in
2884 the past for requests with STILL_CAPTURE capture intent.
2886 For applications targeting SDK versions O and newer, the value of enableZsl in
2887 TEMPLATE_STILL_CAPTURE template may be `true`. The value in other templates is always
2890 For applications targeting SDK versions older than O, the value of enableZsl in all
2891 capture templates is always `false` if present.
2893 For application-operated ZSL, use CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.
2896 It is valid for HAL to produce regular output images for requests with STILL_CAPTURE
2902 <clone entry="android.control.enableZsl" kind="controls">
2904 <entry name="afSceneChange" type="byte" visibility="public" enum="true" hal_version="3.3">
2907 <notes>Scene change is not detected within the AF region(s).</notes></value>
2909 <notes>Scene change is detected within the AF region(s).</notes></value>
2911 <description>Whether a significant scene change is detected within the currently-set AF
2912 region(s).</description>
2913 <details>When the camera focus routine detects a change in the scene it is looking at,
2914 such as a large shift in camera viewpoint, significant motion in the scene, or a
2915 significant illumination change, this value will be set to DETECTED for a single capture
2916 result. Otherwise the value will be NOT_DETECTED. The threshold for detection is similar
2917 to what would trigger a new passive focus scan to begin in CONTINUOUS autofocus modes.
2919 This key will be available if the camera device advertises this key via {@link
2920 android.hardware.camera2.CameraCharacteristics#getAvailableCaptureResultKeys|ACAMERA_REQUEST_AVAILABLE_RESULT_KEYS}.
2925 <section name="demosaic">
2927 <entry name="mode" type="byte" enum="true">
2930 <notes>Minimal or no slowdown of frame rate compared to
2931 Bayer RAW output.</notes></value>
2933 <notes>Improved processing quality but the frame rate might be slowed down
2934 relative to raw output.</notes></value>
2936 <description>Controls the quality of the demosaicing
2937 processing.</description>
2942 <section name="edge">
2944 <entry name="mode" type="byte" visibility="public" enum="true" hwlevel="full">
2947 <notes>No edge enhancement is applied.</notes></value>
2949 <notes>Apply edge enhancement at a quality level that does not slow down frame rate
2950 relative to sensor output. It may be the same as OFF if edge enhancement will
2951 slow down frame rate relative to sensor.</notes></value>
2953 <notes>Apply high-quality edge enhancement, at a cost of possibly reduced output frame rate.
2955 <value optional="true">ZERO_SHUTTER_LAG <notes>Edge enhancement is applied at different
2956 levels for different output streams, based on resolution. Streams at maximum recording
2957 resolution (see {@link
2958 android.hardware.camera2.CameraDevice#createCaptureSession|ACameraDevice_createCaptureSession})
2959 or below have edge enhancement applied, while higher-resolution streams have no edge
2960 enhancement applied. The level of edge enhancement for low-resolution streams is tuned
2961 so that frame rate is not impacted, and the quality is equal to or better than FAST
2962 (since it is only applied to lower-resolution outputs, quality may improve from FAST).
2964 This mode is intended to be used by applications operating in a zero-shutter-lag mode
2965 with YUV or PRIVATE reprocessing, where the application continuously captures
2966 high-resolution intermediate buffers into a circular buffer, from which a final image is
2967 produced via reprocessing when a user takes a picture. For such a use case, the
2968 high-resolution buffers must not have edge enhancement applied to maximize efficiency of
2969 preview and to avoid double-applying enhancement when reprocessed, while low-resolution
2970 buffers (used for recording or preview, generally) need edge enhancement applied for
2971 reasonable preview quality.
2973 This mode is guaranteed to be supported by devices that support either the
2974 YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities
2975 (android.request.availableCapabilities lists either of those capabilities) and it will
2976 be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.
2979 <description>Operation mode for edge
2980 enhancement.</description>
2981 <range>android.edge.availableEdgeModes</range>
2982 <details>Edge enhancement improves sharpness and details in the captured image. OFF means
2983 no enhancement will be applied by the camera device.
2985 FAST/HIGH_QUALITY both mean camera device determined enhancement
2986 will be applied. HIGH_QUALITY mode indicates that the
2987 camera device will use the highest-quality enhancement algorithms,
2988 even if it slows down capture rate. FAST means the camera device will
2989 not slow down capture rate when applying edge enhancement. FAST may be the same as OFF if
2990 edge enhancement will slow down capture rate. Every output stream will have a similar
2991 amount of enhancement applied.
2993 ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular
2994 buffer of high-resolution images during preview and reprocess image(s) from that buffer
2995 into a final capture when triggered by the user. In this mode, the camera device applies
2996 edge enhancement to low-resolution streams (below maximum recording resolution) to
2997 maximize preview quality, but does not apply edge enhancement to high-resolution streams,
2998 since those will be reprocessed later if necessary.
3000 For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera
3001 device will apply FAST/HIGH_QUALITY YUV-domain edge enhancement, respectively.
3002 The camera device may adjust its internal edge enhancement parameters for best
3003 image quality based on the android.reprocess.effectiveExposureFactor, if it is set.
3006 For YUV_REPROCESSING The HAL can use android.reprocess.effectiveExposureFactor to
3007 adjust the internal edge enhancement reduction parameters appropriately to get the best
3013 <entry name="strength" type="byte">
3014 <description>Control the amount of edge enhancement
3015 applied to the images</description>
3016 <units>1-10; 10 is maximum sharpening</units>
3021 <entry name="availableEdgeModes" type="byte" visibility="public"
3022 type_notes="list of enums" container="array" typedef="enumList"
3028 List of edge enhancement modes for android.edge.mode that are supported by this camera
3031 <range>Any value listed in android.edge.mode</range>
3033 Full-capability camera devices must always support OFF; camera devices that support
3034 YUV_REPROCESSING or PRIVATE_REPROCESSING will list ZERO_SHUTTER_LAG; all devices will
3038 HAL must support both FAST and HIGH_QUALITY if edge enhancement control is available
3039 on the camera device, but the underlying implementation can be the same for both modes.
3040 That is, if the highest quality implementation on the camera device does not slow down
3041 capture rate, then FAST and HIGH_QUALITY will generate the same output.
3048 <clone entry="android.edge.mode" kind="controls">
3054 <section name="flash">
3056 <entry name="firingPower" type="byte">
3057 <description>Power for flash firing/torch</description>
3058 <units>10 is max power; 0 is no flash. Linear</units>
3059 <range>0 - 10</range>
3060 <details>Power for snapshot may use a different scale than
3061 for torch mode. Only one entry for torch mode will be
3065 <entry name="firingTime" type="int64">
3066 <description>Firing time of flash relative to start of
3067 exposure</description>
3068 <units>nanoseconds</units>
3069 <range>0-(exposure time-flash duration)</range>
3070 <details>Clamped to (0, exposure time - flash
3071 duration).</details>
3074 <entry name="mode" type="byte" visibility="public" enum="true" hwlevel="legacy">
3078 Do not fire the flash for this capture.
3083 If the flash is available and charged, fire flash
3089 Transition flash to continuously on.
3093 <description>The desired mode for for the camera device's flash control.</description>
3095 This control is only effective when flash unit is available
3096 (`android.flash.info.available == true`).
3098 When this control is used, the android.control.aeMode must be set to ON or OFF.
3099 Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH,
3100 ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.
3102 When set to OFF, the camera device will not fire flash for this capture.
3104 When set to SINGLE, the camera device will fire flash regardless of the camera
3105 device's auto-exposure routine's result. When used in still capture case, this
3106 control should be used along with auto-exposure (AE) precapture metering sequence
3107 (android.control.aePrecaptureTrigger), otherwise, the image may be incorrectly exposed.
3109 When set to TORCH, the flash will be on continuously. This mode can be used
3110 for use cases such as preview, auto-focus assist, still capture, or video recording.
3112 The flash status will be reported by android.flash.state in the capture result metadata.
3118 <namespace name="info">
3119 <entry name="available" type="byte" visibility="public" enum="true"
3120 typedef="boolean" hwlevel="legacy">
3122 <value>FALSE</value>
3125 <description>Whether this camera device has a
3126 flash unit.</description>
3128 Will be `false` if no flash is available.
3130 If there is no flash unit, none of the flash controls do
3134 <entry name="chargeDuration" type="int64">
3135 <description>Time taken before flash can fire
3137 <units>nanoseconds</units>
3138 <range>0-1e9</range>
3139 <details>1 second too long/too short for recharge? Should
3140 this be power-dependent?</details>
3144 <entry name="colorTemperature" type="byte">
3145 <description>The x,y whitepoint of the
3147 <units>pair of floats</units>
3148 <range>0-1 for both</range>
3151 <entry name="maxEnergy" type="byte">
3152 <description>Max energy output of the flash for a full
3153 power single flash</description>
3154 <units>lumen-seconds</units>
3155 <range>&gt;= 0</range>
3160 <clone entry="android.flash.firingPower" kind="controls">
3162 <clone entry="android.flash.firingTime" kind="controls">
3164 <clone entry="android.flash.mode" kind="controls"></clone>
3165 <entry name="state" type="byte" visibility="public" enum="true"
3169 <notes>No flash on camera.</notes></value>
3171 <notes>Flash is charging and cannot be fired.</notes></value>
3173 <notes>Flash is ready to fire.</notes></value>
3175 <notes>Flash fired for this capture.</notes></value>
3177 <notes>Flash partially illuminated this frame.
3179 This is usually due to the next or previous frame having
3180 the flash fire, and the flash spilling into this capture
3181 due to hardware limitations.</notes></value>
3183 <description>Current state of the flash
3186 When the camera device doesn't have flash unit
3187 (i.e. `android.flash.info.available == false`), this state will always be UNAVAILABLE.
3188 Other states indicate the current flash status.
3190 In certain conditions, this will be available on LEGACY devices:
3192 * Flash-less cameras always return UNAVAILABLE.
3193 * Using android.control.aeMode `==` ON_ALWAYS_FLASH
3194 will always return FIRED.
3195 * Using android.flash.mode `==` TORCH
3196 will always return FIRED.
3198 In all other conditions the state will not be available on
3199 LEGACY devices (i.e. it will be `null`).
3204 <section name="hotPixel">
3206 <entry name="mode" type="byte" visibility="public" enum="true">
3210 No hot pixel correction is applied.
3212 The frame rate must not be reduced relative to sensor raw output
3215 The hotpixel map may be returned in android.statistics.hotPixelMap.
3220 Hot pixel correction is applied, without reducing frame
3221 rate relative to sensor raw output.
3223 The hotpixel map may be returned in android.statistics.hotPixelMap.
3228 High-quality hot pixel correction is applied, at a cost
3229 of possibly reduced frame rate relative to sensor raw output.
3231 The hotpixel map may be returned in android.statistics.hotPixelMap.
3236 Operational mode for hot pixel correction.
3238 <range>android.hotPixel.availableHotPixelModes</range>
3240 Hotpixel correction interpolates out, or otherwise removes, pixels
3241 that do not accurately measure the incoming light (i.e. pixels that
3242 are stuck at an arbitrary value or are oversensitive).
3249 <entry name="availableHotPixelModes" type="byte" visibility="public"
3250 type_notes="list of enums" container="array" typedef="enumList">
3255 List of hot pixel correction modes for android.hotPixel.mode that are supported by this
3258 <range>Any value listed in android.hotPixel.mode</range>
3260 FULL mode camera devices will always support FAST.
3263 To avoid performance issues, there will be significantly fewer hot
3264 pixels than actual pixels on the camera sensor.
3265 HAL must support both FAST and HIGH_QUALITY if hot pixel correction control is available
3266 on the camera device, but the underlying implementation can be the same for both modes.
3267 That is, if the highest quality implementation on the camera device does not slow down
3268 capture rate, then FAST and HIGH_QUALITY will generate the same output.
3275 <clone entry="android.hotPixel.mode" kind="controls">
3281 <section name="jpeg">
3283 <entry name="gpsLocation" type="byte" visibility="java_public" synthetic="true"
3284 typedef="location" hwlevel="legacy">
3286 A location object to use when generating image GPS metadata.
3289 Setting a location object in a request will include the GPS coordinates of the location
3290 into any JPEG images captured based on the request. These coordinates can then be
3291 viewed by anyone who receives the JPEG image.
3294 <entry name="gpsCoordinates" type="double" visibility="ndk_public"
3295 type_notes="latitude, longitude, altitude. First two in degrees, the third in meters"
3296 container="array" hwlevel="legacy">
3300 <description>GPS coordinates to include in output JPEG
3302 <range>(-180 - 180], [-90,90], [-inf, inf]</range>
3305 <entry name="gpsProcessingMethod" type="byte" visibility="ndk_public"
3306 typedef="string" hwlevel="legacy">
3307 <description>32 characters describing GPS algorithm to
3308 include in EXIF.</description>
3309 <units>UTF-8 null-terminated string</units>
3312 <entry name="gpsTimestamp" type="int64" visibility="ndk_public" hwlevel="legacy">
3313 <description>Time GPS fix was made to include in
3315 <units>UTC in seconds since January 1, 1970</units>
3318 <entry name="orientation" type="int32" visibility="public" hwlevel="legacy">
3319 <description>The orientation for a JPEG image.</description>
3320 <units>Degrees in multiples of 90</units>
3321 <range>0, 90, 180, 270</range>
3323 The clockwise rotation angle in degrees, relative to the orientation
3324 to the camera, that the JPEG picture needs to be rotated by, to be viewed
3327 Camera devices may either encode this value into the JPEG EXIF header, or
3328 rotate the image data to match this orientation. When the image data is rotated,
3329 the thumbnail data will also be rotated.
3331 Note that this orientation is relative to the orientation of the camera sensor, given
3332 by android.sensor.orientation.
3334 To translate from the device orientation given by the Android sensor APIs, the following
3335 sample code may be used:
3337 private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) {
3338 if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0;
3339 int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION);
3341 // Round device orientation to a multiple of 90
3342 deviceOrientation = (deviceOrientation + 45) / 90 * 90;
3344 // Reverse device orientation for front-facing cameras
3345 boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT;
3346 if (facingFront) deviceOrientation = -deviceOrientation;
3348 // Calculate desired JPEG orientation relative to camera orientation to make
3349 // the image upright relative to the device orientation
3350 int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;
3352 return jpegOrientation;
3357 <entry name="quality" type="byte" visibility="public" hwlevel="legacy">
3358 <description>Compression quality of the final JPEG
3359 image.</description>
3360 <range>1-100; larger is higher quality</range>
3361 <details>85-95 is typical usage range.</details>
3364 <entry name="thumbnailQuality" type="byte" visibility="public" hwlevel="legacy">
3365 <description>Compression quality of JPEG
3366 thumbnail.</description>
3367 <range>1-100; larger is higher quality</range>
3370 <entry name="thumbnailSize" type="int32" visibility="public"
3371 container="array" typedef="size" hwlevel="legacy">
3375 <description>Resolution of embedded JPEG thumbnail.</description>
3376 <range>android.jpeg.availableThumbnailSizes</range>
3377 <details>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,
3378 but the captured JPEG will still be a valid image.
3380 For best results, when issuing a request for a JPEG image, the thumbnail size selected
3381 should have the same aspect ratio as the main JPEG output.
3383 If the thumbnail image aspect ratio differs from the JPEG primary image aspect
3384 ratio, the camera device creates the thumbnail by cropping it from the primary image.
3385 For example, if the primary image has 4:3 aspect ratio, the thumbnail image has
3386 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to
3387 generate the thumbnail image. The thumbnail image will always have a smaller Field
3388 Of View (FOV) than the primary image when aspect ratios differ.
3390 When an android.jpeg.orientation of non-zero degree is requested,
3391 the camera device will handle thumbnail rotation in one of the following ways:
3393 * Set the {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag}
3394 and keep jpeg and thumbnail image data unrotated.
3395 * Rotate the jpeg and thumbnail image data and not set
3396 {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag}. In this
3397 case, LIMITED or FULL hardware level devices will report rotated thumnail size in
3398 capture result, so the width and height will be interchanged if 90 or 270 degree
3399 orientation is requested. LEGACY device will always report unrotated thumbnail
3403 The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.
3404 The cropping must be done on the primary jpeg image rather than the sensor active array.
3405 The stream cropping rule specified by "S5. Cropping" in camera3.h doesn't apply to the
3406 thumbnail image cropping.
3412 <entry name="availableThumbnailSizes" type="int32" visibility="public"
3413 container="array" typedef="size" hwlevel="legacy">
3418 <description>List of JPEG thumbnail sizes for android.jpeg.thumbnailSize supported by this
3419 camera device.</description>
3421 This list will include at least one non-zero resolution, plus `(0,0)` for indicating no
3422 thumbnail should be generated.
3424 Below condiditions will be satisfied for this size list:
3426 * The sizes will be sorted by increasing pixel area (width x height).
3427 If several resolutions have the same area, they will be sorted by increasing width.
3428 * The aspect ratio of the largest thumbnail size will be same as the
3429 aspect ratio of largest JPEG output size in android.scaler.availableStreamConfigurations.
3430 The largest size is defined as the size that has the largest pixel area
3431 in a given size list.
3432 * Each output JPEG size in android.scaler.availableStreamConfigurations will have at least
3433 one corresponding size that has the same aspect ratio in availableThumbnailSizes,
3435 * All non-`(0, 0)` sizes will have non-zero widths and heights.</details>
3438 <entry name="maxSize" type="int32" visibility="system">
3439 <description>Maximum size in bytes for the compressed
3440 JPEG buffer</description>
3441 <range>Must be large enough to fit any JPEG produced by
3443 <details>This is used for sizing the gralloc buffers for
3448 <clone entry="android.jpeg.gpsLocation" kind="controls">
3450 <clone entry="android.jpeg.gpsCoordinates" kind="controls">
3452 <clone entry="android.jpeg.gpsProcessingMethod"
3453 kind="controls"></clone>
3454 <clone entry="android.jpeg.gpsTimestamp" kind="controls">
3456 <clone entry="android.jpeg.orientation" kind="controls">
3458 <clone entry="android.jpeg.quality" kind="controls">
3460 <entry name="size" type="int32">
3461 <description>The size of the compressed JPEG image, in
3463 <range>&gt;= 0</range>
3464 <details>If no JPEG output is produced for the request,
3467 Otherwise, this describes the real size of the compressed
3468 JPEG image placed in the output stream. More specifically,
3469 if android.jpeg.maxSize = 1000000, and a specific capture
3470 has android.jpeg.size = 500000, then the output buffer from
3471 the JPEG stream will be 1000000 bytes, of which the first
3472 500000 make up the real data.</details>
3475 <clone entry="android.jpeg.thumbnailQuality"
3476 kind="controls"></clone>
3477 <clone entry="android.jpeg.thumbnailSize" kind="controls">
3481 <section name="lens">
3483 <entry name="aperture" type="float" visibility="public" hwlevel="full">
3484 <description>The desired lens aperture size, as a ratio of lens focal length to the
3485 effective aperture diameter.</description>
3486 <units>The f-number (f/N)</units>
3487 <range>android.lens.info.availableApertures</range>
3488 <details>Setting this value is only supported on the camera devices that have a variable
3491 When this is supported and android.control.aeMode is OFF,
3492 this can be set along with android.sensor.exposureTime,
3493 android.sensor.sensitivity, and android.sensor.frameDuration
3494 to achieve manual exposure control.
3496 The requested aperture value may take several frames to reach the
3497 requested value; the camera device will report the current (intermediate)
3498 aperture size in capture result metadata while the aperture is changing.
3499 While the aperture is still changing, android.lens.state will be set to MOVING.
3501 When this is supported and android.control.aeMode is one of
3502 the ON modes, this will be overridden by the camera device
3503 auto-exposure algorithm, the overridden values are then provided
3504 back to the user in the corresponding result.</details>
3507 <entry name="filterDensity" type="float" visibility="public" hwlevel="full">
3509 The desired setting for the lens neutral density filter(s).
3511 <units>Exposure Value (EV)</units>
3512 <range>android.lens.info.availableFilterDensities</range>
3514 This control will not be supported on most camera devices.
3516 Lens filters are typically used to lower the amount of light the
3517 sensor is exposed to (measured in steps of EV). As used here, an EV
3518 step is the standard logarithmic representation, which are
3519 non-negative, and inversely proportional to the amount of light
3520 hitting the sensor. For example, setting this to 0 would result
3521 in no reduction of the incoming light, and setting this to 2 would
3522 mean that the filter is set to reduce incoming light by two stops
3523 (allowing 1/4 of the prior amount of light to the sensor).
3525 It may take several frames before the lens filter density changes
3526 to the requested value. While the filter density is still changing,
3527 android.lens.state will be set to MOVING.
3531 <entry name="focalLength" type="float" visibility="public" hwlevel="legacy">
3533 The desired lens focal length; used for optical zoom.
3535 <units>Millimeters</units>
3536 <range>android.lens.info.availableFocalLengths</range>
3538 This setting controls the physical focal length of the camera
3539 device's lens. Changing the focal length changes the field of
3540 view of the camera device, and is usually used for optical zoom.
3542 Like android.lens.focusDistance and android.lens.aperture, this
3543 setting won't be applied instantaneously, and it may take several
3544 frames before the lens can change to the requested focal length.
3545 While the focal length is still changing, android.lens.state will
3548 Optical zoom will not be supported on most devices.
3552 <entry name="focusDistance" type="float" visibility="public" hwlevel="full">
3553 <description>Desired distance to plane of sharpest focus,
3554 measured from frontmost surface of the lens.</description>
3555 <units>See android.lens.info.focusDistanceCalibration for details</units>
3556 <range>&gt;= 0</range>
3558 This control can be used for setting manual focus, on devices that support
3559 the MANUAL_SENSOR capability and have a variable-focus lens (see
3560 android.lens.info.minimumFocusDistance).
3562 A value of `0.0f` means infinity focus. The value set will be clamped to
3563 `[0.0f, android.lens.info.minimumFocusDistance]`.
3565 Like android.lens.focalLength, this setting won't be applied
3566 instantaneously, and it may take several frames before the lens
3567 can move to the requested focus distance. While the lens is still moving,
3568 android.lens.state will be set to MOVING.
3570 LEGACY devices support at most setting this to `0.0f`
3576 <entry name="opticalStabilizationMode" type="byte" visibility="public"
3577 enum="true" hwlevel="limited">
3580 <notes>Optical stabilization is unavailable.</notes>
3582 <value optional="true">ON
3583 <notes>Optical stabilization is enabled.</notes>
3587 Sets whether the camera device uses optical image stabilization (OIS)
3588 when capturing images.
3590 <range>android.lens.info.availableOpticalStabilization</range>
3592 OIS is used to compensate for motion blur due to small
3593 movements of the camera during capture. Unlike digital image
3594 stabilization (android.control.videoStabilizationMode), OIS
3595 makes use of mechanical elements to stabilize the camera
3596 sensor, and thus allows for longer exposure times before
3597 camera shake becomes apparent.
3599 Switching between different optical stabilization modes may take several
3600 frames to initialize, the camera device will report the current mode in
3601 capture result metadata. For example, When "ON" mode is requested, the
3602 optical stabilization modes in the first several capture results may still
3603 be "OFF", and it will become "ON" when the initialization is done.
3605 If a camera device supports both OIS and digital image stabilization
3606 (android.control.videoStabilizationMode), turning both modes on may produce undesirable
3607 interaction, so it is recommended not to enable both at the same time.
3609 Not all devices will support OIS; see
3610 android.lens.info.availableOpticalStabilization for
3617 <namespace name="info">
3618 <entry name="availableApertures" type="float" visibility="public"
3619 container="array" hwlevel="full">
3623 <description>List of aperture size values for android.lens.aperture that are
3624 supported by this camera device.</description>
3625 <units>The aperture f-number</units>
3626 <details>If the camera device doesn't support a variable lens aperture,
3627 this list will contain only one value, which is the fixed aperture size.
3629 If the camera device supports a variable aperture, the aperture values
3630 in this list will be sorted in ascending order.</details>
3633 <entry name="availableFilterDensities" type="float" visibility="public"
3634 container="array" hwlevel="full">
3639 List of neutral density filter values for
3640 android.lens.filterDensity that are supported by this camera device.
3642 <units>Exposure value (EV)</units>
3644 Values are &gt;= 0
3647 If a neutral density filter is not supported by this camera device,
3648 this list will contain only 0. Otherwise, this list will include every
3649 filter density supported by the camera device, in ascending order.
3653 <entry name="availableFocalLengths" type="float" visibility="public"
3654 type_notes="The list of available focal lengths"
3655 container="array" hwlevel="legacy">
3660 List of focal lengths for android.lens.focalLength that are supported by this camera
3663 <units>Millimeters</units>
3665 Values are &gt; 0
3668 If optical zoom is not supported, this list will only contain
3669 a single value corresponding to the fixed focal length of the
3670 device. Otherwise, this list will include every focal length supported
3671 by the camera device, in ascending order.
3676 <entry name="availableOpticalStabilization" type="byte"
3677 visibility="public" type_notes="list of enums" container="array"
3678 typedef="enumList" hwlevel="limited">
3683 List of optical image stabilization (OIS) modes for
3684 android.lens.opticalStabilizationMode that are supported by this camera device.
3686 <range>Any value listed in android.lens.opticalStabilizationMode</range>
3688 If OIS is not supported by a given camera device, this list will
3693 <entry name="hyperfocalDistance" type="float" visibility="public" optional="true"
3695 <description>Hyperfocal distance for this lens.</description>
3696 <units>See android.lens.info.focusDistanceCalibration for details</units>
3697 <range>If lens is fixed focus, &gt;= 0. If lens has focuser unit, the value is
3698 within `(0.0f, android.lens.info.minimumFocusDistance]`</range>
3700 If the lens is not fixed focus, the camera device will report this
3701 field when android.lens.info.focusDistanceCalibration is APPROXIMATE or CALIBRATED.
3704 <entry name="minimumFocusDistance" type="float" visibility="public" optional="true"
3706 <description>Shortest distance from frontmost surface
3707 of the lens that can be brought into sharp focus.</description>
3708 <units>See android.lens.info.focusDistanceCalibration for details</units>
3709 <range>&gt;= 0</range>
3710 <details>If the lens is fixed-focus, this will be
3712 <hal_details>Mandatory for FULL devices; LIMITED devices
3713 must always set this value to 0 for fixed-focus; and may omit
3714 the minimum focus distance otherwise.
3716 This field is also mandatory for all devices advertising
3717 the MANUAL_SENSOR capability.</hal_details>
3720 <entry name="shadingMapSize" type="int32" visibility="ndk_public"
3721 type_notes="width and height (N, M) of lens shading map provided by the camera device."
3722 container="array" typedef="size" hwlevel="full">
3726 <description>Dimensions of lens shading map.</description>
3727 <range>Both values &gt;= 1</range>
3729 The map should be on the order of 30-40 rows and columns, and
3730 must be smaller than 64x64.
3734 <entry name="focusDistanceCalibration" type="byte" visibility="public"
3735 enum="true" hwlevel="limited">
3739 The lens focus distance is not accurate, and the units used for
3740 android.lens.focusDistance do not correspond to any physical units.
3742 Setting the lens to the same focus distance on separate occasions may
3743 result in a different real focus distance, depending on factors such
3744 as the orientation of the device, the age of the focusing mechanism,
3745 and the device temperature. The focus distance value will still be
3746 in the range of `[0, android.lens.info.minimumFocusDistance]`, where 0
3747 represents the farthest focus.
3752 The lens focus distance is measured in diopters.
3754 However, setting the lens to the same focus distance
3755 on separate occasions may result in a different real
3756 focus distance, depending on factors such as the
3757 orientation of the device, the age of the focusing
3758 mechanism, and the device temperature.
3763 The lens focus distance is measured in diopters, and
3766 The lens mechanism is calibrated so that setting the
3767 same focus distance is repeatable on multiple
3768 occasions with good accuracy, and the focus distance
3769 corresponds to the real physical distance to the plane
3774 <description>The lens focus distance calibration quality.</description>
3776 The lens focus distance calibration quality determines the reliability of
3777 focus related metadata entries, i.e. android.lens.focusDistance,
3778 android.lens.focusRange, android.lens.info.hyperfocalDistance, and
3779 android.lens.info.minimumFocusDistance.
3781 APPROXIMATE and CALIBRATED devices report the focus metadata in
3782 units of diopters (1/meter), so `0.0f` represents focusing at infinity,
3783 and increasing positive numbers represent focusing closer and closer
3784 to the camera device. The focus distance control also uses diopters
3787 UNCALIBRATED devices do not use units that are directly comparable
3788 to any real physical measurement, but `0.0f` still represents farthest
3789 focus, and android.lens.info.minimumFocusDistance represents the
3790 nearest focus the device can achieve.
3793 For devices advertise APPROXIMATE quality or higher, diopters 0 (infinity
3794 focus) must work. When autofocus is disabled (android.control.afMode == OFF)
3795 and the lens focus distance is set to 0 diopters
3796 (android.lens.focusDistance == 0), the lens will move to focus at infinity
3797 and is stably focused at infinity even if the device tilts. It may take the
3798 lens some time to move; during the move the lens state should be MOVING and
3799 the output diopter value should be changing toward 0.
3804 <entry name="facing" type="byte" visibility="public" enum="true" hwlevel="legacy">
3808 The camera device faces the same direction as the device's screen.
3812 The camera device faces the opposite direction as the device's screen.
3816 The camera device is an external camera, and has no fixed facing relative to the
3820 <description>Direction the camera faces relative to
3821 device screen.</description>
3823 <entry name="poseRotation" type="float" visibility="public"
3829 The orientation of the camera relative to the sensor
3833 Quaternion coefficients
3836 The four coefficients that describe the quaternion
3837 rotation from the Android sensor coordinate system to a
3838 camera-aligned coordinate system where the X-axis is
3839 aligned with the long side of the image sensor, the Y-axis
3840 is aligned with the short side of the image sensor, and
3841 the Z-axis is aligned with the optical axis of the sensor.
3843 To convert from the quaternion coefficients `(x,y,z,w)`
3844 to the axis of rotation `(a_x, a_y, a_z)` and rotation
3845 amount `theta`, the following formulas can be used:
3848 a_x = x / sin(theta/2)
3849 a_y = y / sin(theta/2)
3850 a_z = z / sin(theta/2)
3852 To create a 3x3 rotation matrix that applies the rotation
3853 defined by this quaternion, the following matrix can be
3856 R = [ 1 - 2y^2 - 2z^2, 2xy - 2zw, 2xz + 2yw,
3857 2xy + 2zw, 1 - 2x^2 - 2z^2, 2yz - 2xw,
3858 2xz - 2yw, 2yz + 2xw, 1 - 2x^2 - 2y^2 ]
3860 This matrix can then be used to apply the rotation to a
3861 column vector point with
3865 where `p` is in the device sensor coordinate system, and
3866 `p'` is in the camera-oriented coordinate system.
3870 <entry name="poseTranslation" type="float" visibility="public"
3875 <description>Position of the camera optical center.</description>
3876 <units>Meters</units>
3878 The position of the camera device's lens optical center,
3879 as a three-dimensional vector `(x,y,z)`.
3881 Prior to Android P, or when android.lens.poseReference is PRIMARY_CAMERA, this position
3882 is relative to the optical center of the largest camera device facing in the same
3883 direction as this camera, in the {@link android.hardware.SensorEvent Android sensor
3884 coordinate axes}. Note that only the axis definitions are shared with the sensor
3885 coordinate system, but not the origin.
3887 If this device is the largest or only camera device with a given facing, then this
3888 position will be `(0, 0, 0)`; a camera device with a lens optical center located 3 cm
3889 from the main sensor along the +X axis (to the right from the user's perspective) will
3890 report `(0.03, 0, 0)`.
3892 To transform a pixel coordinates between two cameras facing the same direction, first
3893 the source camera android.lens.radialDistortion must be corrected for. Then the source
3894 camera android.lens.intrinsicCalibration needs to be applied, followed by the
3895 android.lens.poseRotation of the source camera, the translation of the source camera
3896 relative to the destination camera, the android.lens.poseRotation of the destination
3897 camera, and finally the inverse of android.lens.intrinsicCalibration of the destination
3898 camera. This obtains a radial-distortion-free coordinate in the destination camera pixel
3901 To compare this against a real image from the destination camera, the destination camera
3902 image then needs to be corrected for radial distortion before comparison or sampling.
3904 When android.lens.poseReference is GYROSCOPE, then this position is relative to
3905 the center of the primary gyroscope on the device.
3911 <clone entry="android.lens.aperture" kind="controls">
3914 <clone entry="android.lens.filterDensity" kind="controls">
3917 <clone entry="android.lens.focalLength" kind="controls">
3920 <clone entry="android.lens.focusDistance" kind="controls">
3921 <details>Should be zero for fixed-focus cameras</details>
3924 <entry name="focusRange" type="float" visibility="public"
3925 type_notes="Range of scene distances that are in focus"
3926 container="array" typedef="pairFloatFloat" hwlevel="limited">
3930 <description>The range of scene distances that are in
3931 sharp focus (depth of field).</description>
3932 <units>A pair of focus distances in diopters: (near,
3933 far); see android.lens.info.focusDistanceCalibration for details.</units>
3934 <range>&gt;=0</range>
3935 <details>If variable focus not supported, can still report
3936 fixed depth of field range</details>
3939 <clone entry="android.lens.opticalStabilizationMode"
3943 <entry name="state" type="byte" visibility="public" enum="true" hwlevel="limited">
3947 The lens parameters (android.lens.focalLength, android.lens.focusDistance,
3948 android.lens.filterDensity and android.lens.aperture) are not changing.
3953 One or several of the lens parameters
3954 (android.lens.focalLength, android.lens.focusDistance,
3955 android.lens.filterDensity or android.lens.aperture) is
3960 <description>Current lens status.</description>
3962 For lens parameters android.lens.focalLength, android.lens.focusDistance,
3963 android.lens.filterDensity and android.lens.aperture, when changes are requested,
3964 they may take several frames to reach the requested values. This state indicates
3965 the current status of the lens parameters.
3967 When the state is STATIONARY, the lens parameters are not changing. This could be
3968 either because the parameters are all fixed, or because the lens has had enough
3969 time to reach the most recently-requested values.
3970 If all these lens parameters are not changable for a camera device, as listed below:
3972 * Fixed focus (`android.lens.info.minimumFocusDistance == 0`), which means
3973 android.lens.focusDistance parameter will always be 0.
3974 * Fixed focal length (android.lens.info.availableFocalLengths contains single value),
3975 which means the optical zoom is not supported.
3976 * No ND filter (android.lens.info.availableFilterDensities contains only 0).
3977 * Fixed aperture (android.lens.info.availableApertures contains single value).
3979 Then this state will always be STATIONARY.
3981 When the state is MOVING, it indicates that at least one of the lens parameters
3986 <clone entry="android.lens.poseRotation" kind="static">
3988 <clone entry="android.lens.poseTranslation" kind="static">
3992 <entry name="intrinsicCalibration" type="float" visibility="public"
3998 The parameters for this camera device's intrinsic
4003 android.sensor.info.preCorrectionActiveArraySize
4007 The five calibration parameters that describe the
4008 transform from camera-centric 3D coordinates to sensor
4011 [f_x, f_y, c_x, c_y, s]
4013 Where `f_x` and `f_y` are the horizontal and vertical
4014 focal lengths, `[c_x, c_y]` is the position of the optical
4015 axis, and `s` is a skew parameter for the sensor plane not
4016 being aligned with the lens plane.
4018 These are typically used within a transformation matrix K:
4024 which can then be combined with the camera pose rotation
4025 `R` and translation `t` (android.lens.poseRotation and
4026 android.lens.poseTranslation, respective) to calculate the
4027 complete transform from world coordinates to pixel
4033 and with `p_w` being a point in the world coordinate system
4034 and `p_s` being a point in the camera active pixel array
4035 coordinate system, and with the mapping including the
4036 homogeneous division by z:
4038 p_h = (x_h, y_h, z_h) = P p_w
4041 so `[x_s, y_s]` is the pixel coordinates of the world
4042 point, `z_s = 1`, and `w_s` is a measurement of disparity
4043 (depth) in pixel coordinates.
4045 Note that the coordinate system for this transform is the
4046 android.sensor.info.preCorrectionActiveArraySize system,
4047 where `(0,0)` is the top-left of the
4048 preCorrectionActiveArraySize rectangle. Once the pose and
4049 intrinsic calibration transforms have been applied to a
4050 world point, then the android.lens.radialDistortion
4051 transform needs to be applied, and the result adjusted to
4052 be in the android.sensor.info.activeArraySize coordinate
4053 system (where `(0, 0)` is the top-left of the
4054 activeArraySize rectangle), to determine the final pixel
4055 coordinate of the world point for processed (non-RAW)
4060 <entry name="radialDistortion" type="float" visibility="public"
4066 The correction coefficients to correct for this camera device's
4067 radial and tangential lens distortion.
4070 Unitless coefficients.
4073 Four radial distortion coefficients `[kappa_0, kappa_1, kappa_2,
4074 kappa_3]` and two tangential distortion coefficients
4075 `[kappa_4, kappa_5]` that can be used to correct the
4076 lens's geometric distortion with the mapping equations:
4078 x_c = x_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +
4079 kappa_4 * (2 * x_i * y_i) + kappa_5 * ( r^2 + 2 * x_i^2 )
4080 y_c = y_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +
4081 kappa_5 * (2 * x_i * y_i) + kappa_4 * ( r^2 + 2 * y_i^2 )
4083 Here, `[x_c, y_c]` are the coordinates to sample in the
4084 input image that correspond to the pixel values in the
4085 corrected image at the coordinate `[x_i, y_i]`:
4087 correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)
4089 The pixel coordinates are defined in a normalized
4090 coordinate system related to the
4091 android.lens.intrinsicCalibration calibration fields.
4092 Both `[x_i, y_i]` and `[x_c, y_c]` have `(0,0)` at the
4093 lens optical center `[c_x, c_y]`. The maximum magnitudes
4094 of both x and y coordinates are normalized to be 1 at the
4095 edge further from the optical center, so the range
4096 for both dimensions is `-1 <= x <= 1`.
4098 Finally, `r` represents the radial distance from the
4099 optical center, `r^2 = x_i^2 + y_i^2`, and its magnitude
4100 is therefore no larger than `|r| <= sqrt(2)`.
4102 The distortion model used is the Brown-Conrady model.
4108 <clone entry="android.lens.intrinsicCalibration" kind="static">
4110 <clone entry="android.lens.radialDistortion" kind="static">
4114 <entry name="poseReference" type="byte" visibility="public" enum="true" hal_version="3.3">
4116 <value>PRIMARY_CAMERA
4117 <notes>The value of android.lens.poseTranslation is relative to the optical center of
4118 the largest camera device facing the same direction as this camera.
4120 This is the default value for API levels before Android P.
4124 <notes>The value of android.lens.poseTranslation is relative to the position of the
4125 primary gyroscope of this Android device.
4130 The origin for android.lens.poseTranslation.
4133 Different calibration methods and use cases can produce better or worse results
4134 depending on the selected coordinate origin.
4139 <section name="noiseReduction">
4141 <entry name="mode" type="byte" visibility="public" enum="true" hwlevel="full">
4144 <notes>No noise reduction is applied.</notes></value>
4146 <notes>Noise reduction is applied without reducing frame rate relative to sensor
4147 output. It may be the same as OFF if noise reduction will reduce frame rate
4148 relative to sensor.</notes></value>
4150 <notes>High-quality noise reduction is applied, at the cost of possibly reduced frame
4151 rate relative to sensor output.</notes></value>
4152 <value optional="true">MINIMAL
4153 <notes>MINIMAL noise reduction is applied without reducing frame rate relative to
4154 sensor output. </notes></value>
4155 <value optional="true">ZERO_SHUTTER_LAG
4157 <notes>Noise reduction is applied at different levels for different output streams,
4158 based on resolution. Streams at maximum recording resolution (see {@link
4159 android.hardware.camera2.CameraDevice#createCaptureSession|ACameraDevice_createCaptureSession})
4160 or below have noise reduction applied, while higher-resolution streams have MINIMAL (if
4161 supported) or no noise reduction applied (if MINIMAL is not supported.) The degree of
4162 noise reduction for low-resolution streams is tuned so that frame rate is not impacted,
4163 and the quality is equal to or better than FAST (since it is only applied to
4164 lower-resolution outputs, quality may improve from FAST).
4166 This mode is intended to be used by applications operating in a zero-shutter-lag mode
4167 with YUV or PRIVATE reprocessing, where the application continuously captures
4168 high-resolution intermediate buffers into a circular buffer, from which a final image is
4169 produced via reprocessing when a user takes a picture. For such a use case, the
4170 high-resolution buffers must not have noise reduction applied to maximize efficiency of
4171 preview and to avoid over-applying noise filtering when reprocessing, while
4172 low-resolution buffers (used for recording or preview, generally) need noise reduction
4173 applied for reasonable preview quality.
4175 This mode is guaranteed to be supported by devices that support either the
4176 YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities
4177 (android.request.availableCapabilities lists either of those capabilities) and it will
4178 be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.
4181 <description>Mode of operation for the noise reduction algorithm.</description>
4182 <range>android.noiseReduction.availableNoiseReductionModes</range>
4183 <details>The noise reduction algorithm attempts to improve image quality by removing
4184 excessive noise added by the capture process, especially in dark conditions.
4186 OFF means no noise reduction will be applied by the camera device, for both raw and
4189 MINIMAL means that only sensor raw domain basic noise reduction is enabled ,to remove
4190 demosaicing or other processing artifacts. For YUV_REPROCESSING, MINIMAL is same as OFF.
4191 This mode is optional, may not be support by all devices. The application should check
4192 android.noiseReduction.availableNoiseReductionModes before using it.
4194 FAST/HIGH_QUALITY both mean camera device determined noise filtering
4195 will be applied. HIGH_QUALITY mode indicates that the camera device
4196 will use the highest-quality noise filtering algorithms,
4197 even if it slows down capture rate. FAST means the camera device will not
4198 slow down capture rate when applying noise filtering. FAST may be the same as MINIMAL if
4199 MINIMAL is listed, or the same as OFF if any noise filtering will slow down capture rate.
4200 Every output stream will have a similar amount of enhancement applied.
4202 ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular
4203 buffer of high-resolution images during preview and reprocess image(s) from that buffer
4204 into a final capture when triggered by the user. In this mode, the camera device applies
4205 noise reduction to low-resolution streams (below maximum recording resolution) to maximize
4206 preview quality, but does not apply noise reduction to high-resolution streams, since
4207 those will be reprocessed later if necessary.
4209 For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device
4210 will apply FAST/HIGH_QUALITY YUV domain noise reduction, respectively. The camera device
4211 may adjust the noise reduction parameters for best image quality based on the
4212 android.reprocess.effectiveExposureFactor if it is set.
4215 For YUV_REPROCESSING The HAL can use android.reprocess.effectiveExposureFactor to
4216 adjust the internal noise reduction parameters appropriately to get the best quality
4222 <entry name="strength" type="byte">
4223 <description>Control the amount of noise reduction
4224 applied to the images</description>
4225 <units>1-10; 10 is max noise reduction</units>
4226 <range>1 - 10</range>
4231 <entry name="availableNoiseReductionModes" type="byte" visibility="public"
4232 type_notes="list of enums" container="array" typedef="enumList" hwlevel="limited">
4237 List of noise reduction modes for android.noiseReduction.mode that are supported
4238 by this camera device.
4240 <range>Any value listed in android.noiseReduction.mode</range>
4242 Full-capability camera devices will always support OFF and FAST.
4244 Camera devices that support YUV_REPROCESSING or PRIVATE_REPROCESSING will support
4247 Legacy-capability camera devices will only support FAST mode.
4250 HAL must support both FAST and HIGH_QUALITY if noise reduction control is available
4251 on the camera device, but the underlying implementation can be the same for both modes.
4252 That is, if the highest quality implementation on the camera device does not slow down
4253 capture rate, then FAST and HIGH_QUALITY will generate the same output.
4260 <clone entry="android.noiseReduction.mode" kind="controls">
4266 <section name="quirks">
4268 <entry name="meteringCropRegion" type="byte" visibility="system" deprecated="true" optional="true">
4269 <description>If set to 1, the camera service does not
4270 scale 'normalized' coordinates with respect to the crop
4271 region. This applies to metering input (a{e,f,wb}Region
4272 and output (face rectangles).</description>
4273 <details>Normalized coordinates refer to those in the
4274 (-1000,1000) range mentioned in the
4275 android.hardware.Camera API.
4277 HAL implementations should instead always use and emit
4278 sensor array-relative coordinates for all region data. Does
4279 not need to be listed in static metadata. Support will be
4280 removed in future versions of camera service.</details>
4282 <entry name="triggerAfWithAuto" type="byte" visibility="system" deprecated="true" optional="true">
4283 <description>If set to 1, then the camera service always
4284 switches to FOCUS_MODE_AUTO before issuing a AF
4285 trigger.</description>
4286 <details>HAL implementations should implement AF trigger
4287 modes for AUTO, MACRO, CONTINUOUS_FOCUS, and
4288 CONTINUOUS_PICTURE modes instead of using this flag. Does
4289 not need to be listed in static metadata. Support will be
4290 removed in future versions of camera service</details>
4292 <entry name="useZslFormat" type="byte" visibility="system" deprecated="true" optional="true">
4293 <description>If set to 1, the camera service uses
4294 CAMERA2_PIXEL_FORMAT_ZSL instead of
4295 HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED for the zero
4296 shutter lag stream</description>
4297 <details>HAL implementations should use gralloc usage flags
4298 to determine that a stream will be used for
4299 zero-shutter-lag, instead of relying on an explicit
4300 format setting. Does not need to be listed in static
4301 metadata. Support will be removed in future versions of
4302 camera service.</details>
4304 <entry name="usePartialResult" type="byte" visibility="hidden" deprecated="true" optional="true">
4306 If set to 1, the HAL will always split result
4307 metadata for a single capture into multiple buffers,
4308 returned using multiple process_capture_result calls.
4311 Does not need to be listed in static
4312 metadata. Support for partial results will be reworked in
4313 future versions of camera service. This quirk will stop
4314 working at that point; DO NOT USE without careful
4315 consideration of future support.
4318 Refer to `camera3_capture_result::partial_result`
4319 for information on how to implement partial results.
4324 <entry name="partialResult" type="byte" visibility="hidden" deprecated="true" optional="true" enum="true" typedef="boolean">
4327 <notes>The last or only metadata result buffer
4328 for this capture.</notes>
4331 <notes>A partial buffer of result metadata for this
4332 capture. More result buffers for this capture will be sent
4333 by the camera device, the last of which will be marked
4338 Whether a result given to the framework is the
4339 final one for the capture, or only a partial that contains a
4340 subset of the full set of dynamic metadata
4341 values.</description>
4342 <range>Optional. Default value is FINAL.</range>
4344 The entries in the result metadata buffers for a
4345 single capture may not overlap, except for this entry. The
4346 FINAL buffers must retain FIFO ordering relative to the
4347 requests that generate them, so the FINAL buffer for frame 3 must
4348 always be sent to the framework after the FINAL buffer for frame 2, and
4349 before the FINAL buffer for frame 4. PARTIAL buffers may be returned
4350 in any order relative to other frames, but all PARTIAL buffers for a given
4351 capture must arrive before the FINAL buffer for that capture. This entry may
4352 only be used by the camera device if quirks.usePartialResult is set to 1.
4355 Refer to `camera3_capture_result::partial_result`
4356 for information on how to implement partial results.
4361 <section name="request">
4363 <entry name="frameCount" type="int32" visibility="system" deprecated="true">
4364 <description>A frame counter set by the framework. Must
4365 be maintained unchanged in output frame. This value monotonically
4366 increases with every new result (that is, each new result has a unique
4369 <units>incrementing integer</units>
4370 <range>Any int.</range>
4372 <entry name="id" type="int32" visibility="hidden">
4373 <description>An application-specified ID for the current
4374 request. Must be maintained unchanged in output
4376 <units>arbitrary integer assigned by application</units>
4377 <range>Any int</range>
4380 <entry name="inputStreams" type="int32" visibility="system" deprecated="true"
4385 <description>List which camera reprocess stream is used
4386 for the source of reprocessing data.</description>
4387 <units>List of camera reprocess stream IDs</units>
4389 Typically, only one entry allowed, must be a valid reprocess stream ID.
4391 <details>Only meaningful when android.request.type ==
4392 REPROCESS. Ignored otherwise</details>
4395 <entry name="metadataMode" type="byte" visibility="system"
4399 <notes>No metadata should be produced on output, except
4400 for application-bound buffer data. If no
4401 application-bound streams exist, no frame should be
4402 placed in the output frame queue. If such streams
4403 exist, a frame should be placed on the output queue
4404 with null metadata but with the necessary output buffer
4405 information. Timestamp information should still be
4406 included with any output stream buffers</notes></value>
4408 <notes>All metadata should be produced. Statistics will
4409 only be produced if they are separately
4410 enabled</notes></value>
4412 <description>How much metadata to produce on
4413 output</description>
4416 <entry name="outputStreams" type="int32" visibility="system" deprecated="true"
4421 <description>Lists which camera output streams image data
4422 from this capture must be sent to</description>
4423 <units>List of camera stream IDs</units>
4424 <range>List must only include streams that have been
4426 <details>If no output streams are listed, then the image
4427 data should simply be discarded. The image data must
4428 still be captured for metadata and statistics production,
4429 and the lens and flash must operate as requested.</details>
4432 <entry name="type" type="byte" visibility="system" deprecated="true" enum="true">
4435 <notes>Capture a new image from the imaging hardware,
4436 and process it according to the
4437 settings</notes></value>
4439 <notes>Process previously captured data; the
4440 android.request.inputStreams parameter determines the
4441 source reprocessing stream. TODO: Mark dynamic metadata
4442 needed for reprocessing with [RP]</notes></value>
4444 <description>The type of the request; either CAPTURE or
4445 REPROCESS. For legacy HAL3, this tag is redundant.
4451 <entry name="maxNumOutputStreams" type="int32" visibility="ndk_public"
4452 container="array" hwlevel="legacy">
4456 <description>The maximum numbers of different types of output streams
4457 that can be configured and used simultaneously by a camera device.
4460 For processed (and stalling) format streams, &gt;= 1.
4462 For Raw format (either stalling or non-stalling) streams, &gt;= 0.
4464 For processed (but not stalling) format streams, &gt;= 3
4465 for FULL mode devices (`android.info.supportedHardwareLevel == FULL`);
4466 &gt;= 2 for LIMITED mode devices (`android.info.supportedHardwareLevel == LIMITED`).
4469 This is a 3 element tuple that contains the max number of output simultaneous
4470 streams for raw sensor, processed (but not stalling), and processed (and stalling)
4471 formats respectively. For example, assuming that JPEG is typically a processed and
4472 stalling stream, if max raw sensor format output stream number is 1, max YUV streams
4473 number is 3, and max JPEG stream number is 2, then this tuple should be `(1, 3, 2)`.
4475 This lists the upper bound of the number of output streams supported by
4476 the camera device. Using more streams simultaneously may require more hardware and
4477 CPU resources that will consume more power. The image format for an output stream can
4478 be any supported format provided by android.scaler.availableStreamConfigurations.
4479 The formats defined in android.scaler.availableStreamConfigurations can be catergorized
4480 into the 3 stream types as below:
4482 * Processed (but stalling): any non-RAW format with a stallDurations &gt; 0.
4483 Typically {@link android.graphics.ImageFormat#JPEG|AIMAGE_FORMAT_JPEG JPEG format}.
4484 * Raw formats: {@link android.graphics.ImageFormat#RAW_SENSOR|AIMAGE_FORMAT_RAW16
4485 RAW_SENSOR}, {@link android.graphics.ImageFormat#RAW10|AIMAGE_FORMAT_RAW10 RAW10}, or
4486 {@link android.graphics.ImageFormat#RAW12|AIMAGE_FORMAT_RAW12 RAW12}.
4487 * Processed (but not-stalling): any non-RAW format without a stall duration. Typically
4488 {@link android.graphics.ImageFormat#YUV_420_888|AIMAGE_FORMAT_YUV_420_888 YUV_420_888},
4489 {@link android.graphics.ImageFormat#NV21 NV21}, or {@link
4490 android.graphics.ImageFormat#YV12 YV12}.
4494 <entry name="maxNumOutputRaw" type="int32" visibility="java_public" synthetic="true"
4496 <description>The maximum numbers of different types of output streams
4497 that can be configured and used simultaneously by a camera device
4498 for any `RAW` formats.
4504 This value contains the max number of output simultaneous
4505 streams from the raw sensor.
4507 This lists the upper bound of the number of output streams supported by
4508 the camera device. Using more streams simultaneously may require more hardware and
4509 CPU resources that will consume more power. The image format for this kind of an output stream can
4510 be any `RAW` and supported format provided by android.scaler.streamConfigurationMap.
4512 In particular, a `RAW` format is typically one of:
4514 * {@link android.graphics.ImageFormat#RAW_SENSOR|AIMAGE_FORMAT_RAW16 RAW_SENSOR}
4515 * {@link android.graphics.ImageFormat#RAW10|AIMAGE_FORMAT_RAW10 RAW10}
4516 * {@link android.graphics.ImageFormat#RAW12|AIMAGE_FORMAT_RAW12 RAW12}
4518 LEGACY mode devices (android.info.supportedHardwareLevel `==` LEGACY)
4519 never support raw streams.
4522 <entry name="maxNumOutputProc" type="int32" visibility="java_public" synthetic="true"
4524 <description>The maximum numbers of different types of output streams
4525 that can be configured and used simultaneously by a camera device
4526 for any processed (but not-stalling) formats.
4530 for FULL mode devices (`android.info.supportedHardwareLevel == FULL`);
4531 &gt;= 2 for LIMITED mode devices (`android.info.supportedHardwareLevel == LIMITED`).
4534 This value contains the max number of output simultaneous
4535 streams for any processed (but not-stalling) formats.
4537 This lists the upper bound of the number of output streams supported by
4538 the camera device. Using more streams simultaneously may require more hardware and
4539 CPU resources that will consume more power. The image format for this kind of an output stream can
4540 be any non-`RAW` and supported format provided by android.scaler.streamConfigurationMap.
4542 Processed (but not-stalling) is defined as any non-RAW format without a stall duration.
4545 * {@link android.graphics.ImageFormat#YUV_420_888|AIMAGE_FORMAT_YUV_420_888 YUV_420_888}
4546 * {@link android.graphics.ImageFormat#NV21 NV21}
4547 * {@link android.graphics.ImageFormat#YV12 YV12}
4548 * Implementation-defined formats, i.e. {@link
4549 android.hardware.camera2.params.StreamConfigurationMap#isOutputSupportedFor(Class)}
4551 For full guarantees, query {@link
4552 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration} with a
4553 processed format -- it will return 0 for a non-stalling stream.
4555 LEGACY devices will support at least 2 processing/non-stalling streams.
4558 <entry name="maxNumOutputProcStalling" type="int32" visibility="java_public" synthetic="true"
4560 <description>The maximum numbers of different types of output streams
4561 that can be configured and used simultaneously by a camera device
4562 for any processed (and stalling) formats.
4568 This value contains the max number of output simultaneous
4569 streams for any processed (but not-stalling) formats.
4571 This lists the upper bound of the number of output streams supported by
4572 the camera device. Using more streams simultaneously may require more hardware and
4573 CPU resources that will consume more power. The image format for this kind of an output stream can
4574 be any non-`RAW` and supported format provided by android.scaler.streamConfigurationMap.
4576 A processed and stalling format is defined as any non-RAW format with a stallDurations
4577 &gt; 0. Typically only the {@link
4578 android.graphics.ImageFormat#JPEG|AIMAGE_FORMAT_JPEG JPEG format} is a stalling format.
4580 For full guarantees, query {@link
4581 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration} with a
4582 processed format -- it will return a non-0 value for a stalling stream.
4584 LEGACY devices will support up to 1 processing/stalling stream.
4587 <entry name="maxNumReprocessStreams" type="int32" visibility="system"
4588 deprecated="true" container="array">
4592 <description>How many reprocessing streams of any type
4593 can be allocated at the same time.</description>
4594 <range>&gt;= 0</range>
4596 Only used by HAL2.x.
4598 When set to 0, it means no reprocess stream is supported.
4602 <entry name="maxNumInputStreams" type="int32" visibility="java_public" hwlevel="full">
4604 The maximum numbers of any type of input streams
4605 that can be configured and used simultaneously by a camera device.
4610 <details>When set to 0, it means no input stream is supported.
4612 The image format for a input stream can be any supported format returned by {@link
4613 android.hardware.camera2.params.StreamConfigurationMap#getInputFormats}. When using an
4614 input stream, there must be at least one output stream configured to to receive the
4617 When an input stream and some output streams are used in a reprocessing request,
4618 only the input buffer will be used to produce these output stream buffers, and a
4619 new sensor image will not be captured.
4621 For example, for Zero Shutter Lag (ZSL) still capture use case, the input
4622 stream image format will be PRIVATE, the associated output stream image format
4626 For the reprocessing flow and controls, see
4627 hardware/libhardware/include/hardware/camera3.h Section 10 for more details.
4633 <entry name="frameCount" type="int32" visibility="hidden" deprecated="true">
4634 <description>A frame counter set by the framework. This value monotonically
4635 increases with every new result (that is, each new result has a unique
4636 frameCount value).</description>
4637 <units>count of frames</units>
4638 <range>&gt; 0</range>
4639 <details>Reset on release()</details>
4641 <clone entry="android.request.id" kind="controls"></clone>
4642 <clone entry="android.request.metadataMode"
4643 kind="controls"></clone>
4644 <clone entry="android.request.outputStreams"
4645 kind="controls"></clone>
4646 <entry name="pipelineDepth" type="byte" visibility="public" hwlevel="legacy">
4647 <description>Specifies the number of pipeline stages the frame went
4648 through from when it was exposed to when the final completed result
4649 was available to the framework.</description>
4650 <range>&lt;= android.request.pipelineMaxDepth</range>
4651 <details>Depending on what settings are used in the request, and
4652 what streams are configured, the data may undergo less processing,
4653 and some pipeline stages skipped.
4655 See android.request.pipelineMaxDepth for more details.
4658 This value must always represent the accurate count of how many
4659 pipeline stages were actually used.
4664 <entry name="pipelineMaxDepth" type="byte" visibility="public" hwlevel="legacy">
4665 <description>Specifies the number of maximum pipeline stages a frame
4666 has to go through from when it's exposed to when it's available
4667 to the framework.</description>
4668 <details>A typical minimum value for this is 2 (one stage to expose,
4669 one stage to readout) from the sensor. The ISP then usually adds
4670 its own stages to do custom HW processing. Further stages may be
4671 added by SW processing.
4673 Depending on what settings are used (e.g. YUV, JPEG) and what
4674 processing is enabled (e.g. face detection), the actual pipeline
4675 depth (specified by android.request.pipelineDepth) may be less than
4676 the max pipeline depth.
4678 A pipeline depth of X stages is equivalent to a pipeline latency of
4681 This value will normally be 8 or less, however, for high speed capture session,
4682 the max pipeline depth will be up to 8 x size of high speed capture request list.
4685 This value should be 4 or less, expect for the high speed recording session, where the
4686 max batch sizes may be larger than 1.
4689 <entry name="partialResultCount" type="int32" visibility="public" optional="true">
4690 <description>Defines how many sub-components
4691 a result will be composed of.
4693 <range>&gt;= 1</range>
4694 <details>In order to combat the pipeline latency, partial results
4695 may be delivered to the application layer from the camera device as
4696 soon as they are available.
4698 Optional; defaults to 1. A value of 1 means that partial
4699 results are not supported, and only the final TotalCaptureResult will
4700 be produced by the camera device.
4702 A typical use case for this might be: after requesting an
4703 auto-focus (AF) lock the new AF state might be available 50%
4704 of the way through the pipeline. The camera device could
4705 then immediately dispatch this state via a partial result to
4706 the application, and the rest of the metadata via later
4710 <entry name="availableCapabilities" type="byte" visibility="public"
4711 enum="true" container="array" hwlevel="legacy">
4716 <value>BACKWARD_COMPATIBLE
4717 <notes>The minimal set of capabilities that every camera
4718 device (regardless of android.info.supportedHardwareLevel)
4721 This capability is listed by all normal devices, and
4722 indicates that the camera device has a feature set
4723 that's comparable to the baseline requirements for the
4724 older android.hardware.Camera API.
4726 Devices with the DEPTH_OUTPUT capability might not list this
4727 capability, indicating that they support only depth measurement,
4728 not standard color output.
4731 <value optional="true">MANUAL_SENSOR
4733 The camera device can be manually controlled (3A algorithms such
4734 as auto-exposure, and auto-focus can be bypassed).
4735 The camera device supports basic manual control of the sensor image
4736 acquisition related stages. This means the following controls are
4737 guaranteed to be supported:
4739 * Manual frame duration control
4740 * android.sensor.frameDuration
4741 * android.sensor.info.maxFrameDuration
4742 * Manual exposure control
4743 * android.sensor.exposureTime
4744 * android.sensor.info.exposureTimeRange
4745 * Manual sensitivity control
4746 * android.sensor.sensitivity
4747 * android.sensor.info.sensitivityRange
4748 * Manual lens control (if the lens is adjustable)
4750 * Manual flash control (if a flash unit is present)
4752 * Manual black level locking
4753 * android.blackLevel.lock
4754 * Auto exposure lock
4755 * android.control.aeLock
4757 If any of the above 3A algorithms are enabled, then the camera
4758 device will accurately report the values applied by 3A in the
4761 A given camera device may also support additional manual sensor controls,
4762 but this capability only covers the above list of controls.
4764 If this is supported, android.scaler.streamConfigurationMap will
4765 additionally return a min frame duration that is greater than
4766 zero for each supported size-format combination.
4769 <value optional="true">MANUAL_POST_PROCESSING
4771 The camera device post-processing stages can be manually controlled.
4772 The camera device supports basic manual control of the image post-processing
4773 stages. This means the following controls are guaranteed to be supported:
4775 * Manual tonemap control
4776 * android.tonemap.curve
4777 * android.tonemap.mode
4778 * android.tonemap.maxCurvePoints
4779 * android.tonemap.gamma
4780 * android.tonemap.presetCurve
4782 * Manual white balance control
4783 * android.colorCorrection.transform
4784 * android.colorCorrection.gains
4785 * Manual lens shading map control
4786 * android.shading.mode
4787 * android.statistics.lensShadingMapMode
4788 * android.statistics.lensShadingMap
4789 * android.lens.info.shadingMapSize
4790 * Manual aberration correction control (if aberration correction is supported)
4791 * android.colorCorrection.aberrationMode
4792 * android.colorCorrection.availableAberrationModes
4793 * Auto white balance lock
4794 * android.control.awbLock
4796 If auto white balance is enabled, then the camera device
4797 will accurately report the values applied by AWB in the result.
4799 A given camera device may also support additional post-processing
4800 controls, but this capability only covers the above list of controls.
4803 <value optional="true">RAW
4805 The camera device supports outputting RAW buffers and
4806 metadata for interpreting them.
4808 Devices supporting the RAW capability allow both for
4809 saving DNG files, and for direct application processing of
4812 * RAW_SENSOR is supported as an output format.
4813 * The maximum available resolution for RAW_SENSOR streams
4814 will match either the value in
4815 android.sensor.info.pixelArraySize or
4816 android.sensor.info.preCorrectionActiveArraySize.
4817 * All DNG-related optional metadata entries are provided
4818 by the camera device.
4821 <value optional="true" ndk_hidden="true">PRIVATE_REPROCESSING
4823 The camera device supports the Zero Shutter Lag reprocessing use case.
4825 * One input stream is supported, that is, `android.request.maxNumInputStreams == 1`.
4826 * {@link android.graphics.ImageFormat#PRIVATE} is supported as an output/input format,
4827 that is, {@link android.graphics.ImageFormat#PRIVATE} is included in the lists of
4828 formats returned by {@link
4829 android.hardware.camera2.params.StreamConfigurationMap#getInputFormats} and {@link
4830 android.hardware.camera2.params.StreamConfigurationMap#getOutputFormats}.
4831 * {@link android.hardware.camera2.params.StreamConfigurationMap#getValidOutputFormatsForInput}
4832 returns non empty int[] for each supported input format returned by {@link
4833 android.hardware.camera2.params.StreamConfigurationMap#getInputFormats}.
4834 * Each size returned by {@link
4835 android.hardware.camera2.params.StreamConfigurationMap#getInputSizes
4836 getInputSizes(ImageFormat.PRIVATE)} is also included in {@link
4837 android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes
4838 getOutputSizes(ImageFormat.PRIVATE)}
4839 * Using {@link android.graphics.ImageFormat#PRIVATE} does not cause a frame rate drop
4840 relative to the sensor's maximum capture rate (at that resolution).
4841 * {@link android.graphics.ImageFormat#PRIVATE} will be reprocessable into both
4842 {@link android.graphics.ImageFormat#YUV_420_888} and
4843 {@link android.graphics.ImageFormat#JPEG} formats.
4844 * The maximum available resolution for PRIVATE streams
4845 (both input/output) will match the maximum available
4846 resolution of JPEG streams.
4847 * Static metadata android.reprocess.maxCaptureStall.
4848 * Only below controls are effective for reprocessing requests and
4849 will be present in capture results, other controls in reprocess
4850 requests will be ignored by the camera device.
4852 * android.noiseReduction.mode
4854 * android.noiseReduction.availableNoiseReductionModes and
4855 android.edge.availableEdgeModes will both list ZERO_SHUTTER_LAG as a supported mode.
4858 <value optional="true">READ_SENSOR_SETTINGS
4860 The camera device supports accurately reporting the sensor settings for many of
4861 the sensor controls while the built-in 3A algorithm is running. This allows
4862 reporting of sensor settings even when these settings cannot be manually changed.
4864 The values reported for the following controls are guaranteed to be available
4865 in the CaptureResult, including when 3A is enabled:
4868 * android.sensor.exposureTime
4869 * Sensitivity control
4870 * android.sensor.sensitivity
4871 * Lens controls (if the lens is adjustable)
4872 * android.lens.focusDistance
4873 * android.lens.aperture
4875 This capability is a subset of the MANUAL_SENSOR control capability, and will
4876 always be included if the MANUAL_SENSOR capability is available.
4879 <value optional="true">BURST_CAPTURE
4881 The camera device supports capturing high-resolution images at >= 20 frames per
4882 second, in at least the uncompressed YUV format, when post-processing settings are set
4883 to FAST. Additionally, maximum-resolution images can be captured at >= 10 frames
4884 per second. Here, 'high resolution' means at least 8 megapixels, or the maximum
4885 resolution of the device, whichever is smaller.
4888 More specifically, this means that a size matching the camera device's active array
4889 size is listed as a supported size for the {@link
4890 android.graphics.ImageFormat#YUV_420_888} format in either {@link
4891 android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes} or {@link
4892 android.hardware.camera2.params.StreamConfigurationMap#getHighResolutionOutputSizes},
4893 with a minimum frame duration for that format and size of either <= 1/20 s, or
4894 <= 1/10 s, respectively; and the android.control.aeAvailableTargetFpsRanges entry
4895 lists at least one FPS range where the minimum FPS is >= 1 / minimumFrameDuration
4896 for the maximum-size YUV_420_888 format. If that maximum size is listed in {@link
4897 android.hardware.camera2.params.StreamConfigurationMap#getHighResolutionOutputSizes},
4898 then the list of resolutions for YUV_420_888 from {@link
4899 android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes} contains at
4900 least one resolution >= 8 megapixels, with a minimum frame duration of <= 1/20
4903 If the device supports the {@link
4904 android.graphics.ImageFormat#RAW10|AIMAGE_FORMAT_RAW10}, {@link
4905 android.graphics.ImageFormat#RAW12|AIMAGE_FORMAT_RAW12}, then those can also be
4906 captured at the same rate as the maximum-size YUV_420_888 resolution is.
4908 If the device supports the PRIVATE_REPROCESSING capability, then the same guarantees
4909 as for the YUV_420_888 format also apply to the {@link
4910 android.graphics.ImageFormat#PRIVATE} format.
4912 In addition, the android.sync.maxLatency field is guaranted to have a value between 0
4913 and 4, inclusive. android.control.aeLockAvailable and android.control.awbLockAvailable
4914 are also guaranteed to be `true` so burst capture with these two locks ON yields
4915 consistent image output.
4918 More specifically, this means that at least one output {@link
4919 android.graphics.ImageFormat#YUV_420_888|AIMAGE_FORMAT_YUV_420_888} size listed in
4921 android.hardware.camera2.params.StreamConfigurationMap|ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}
4922 is larger or equal to the 'high resolution' defined above, and can be captured at at
4923 least 20 fps. For the largest {@link
4924 android.graphics.ImageFormat#YUV_420_888|AIMAGE_FORMAT_YUV_420_888} size listed in
4926 android.hardware.camera2.params.StreamConfigurationMap|ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS},
4927 camera device can capture this size for at least 10 frames per second. Also the
4928 android.control.aeAvailableTargetFpsRanges entry lists at least one FPS range where
4929 the minimum FPS is >= 1 / minimumFrameDuration for the largest YUV_420_888 size.
4931 If the device supports the {@link
4932 android.graphics.ImageFormat#RAW10|AIMAGE_FORMAT_RAW10}, {@link
4933 android.graphics.ImageFormat#RAW12|AIMAGE_FORMAT_RAW12}, then those can also be
4934 captured at the same rate as the maximum-size YUV_420_888 resolution is.
4936 In addition, the android.sync.maxLatency field is guaranted to have a value between 0
4937 and 4, inclusive. android.control.aeLockAvailable and android.control.awbLockAvailable
4938 are also guaranteed to be `true` so burst capture with these two locks ON yields
4939 consistent image output.
4942 <value optional="true" ndk_hidden="true">YUV_REPROCESSING
4944 The camera device supports the YUV_420_888 reprocessing use case, similar as
4945 PRIVATE_REPROCESSING, This capability requires the camera device to support the
4948 * One input stream is supported, that is, `android.request.maxNumInputStreams == 1`.
4949 * {@link android.graphics.ImageFormat#YUV_420_888} is supported as an output/input
4950 format, that is, YUV_420_888 is included in the lists of formats returned by {@link
4951 android.hardware.camera2.params.StreamConfigurationMap#getInputFormats} and {@link
4952 android.hardware.camera2.params.StreamConfigurationMap#getOutputFormats}.
4954 android.hardware.camera2.params.StreamConfigurationMap#getValidOutputFormatsForInput}
4955 returns non-empty int[] for each supported input format returned by {@link
4956 android.hardware.camera2.params.StreamConfigurationMap#getInputFormats}.
4957 * Each size returned by {@link
4958 android.hardware.camera2.params.StreamConfigurationMap#getInputSizes
4959 getInputSizes(YUV_420_888)} is also included in {@link
4960 android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes
4961 getOutputSizes(YUV_420_888)}
4962 * Using {@link android.graphics.ImageFormat#YUV_420_888} does not cause a frame rate
4963 drop relative to the sensor's maximum capture rate (at that resolution).
4964 * {@link android.graphics.ImageFormat#YUV_420_888} will be reprocessable into both
4965 {@link android.graphics.ImageFormat#YUV_420_888} and {@link
4966 android.graphics.ImageFormat#JPEG} formats.
4967 * The maximum available resolution for {@link
4968 android.graphics.ImageFormat#YUV_420_888} streams (both input/output) will match the
4969 maximum available resolution of {@link android.graphics.ImageFormat#JPEG} streams.
4970 * Static metadata android.reprocess.maxCaptureStall.
4971 * Only the below controls are effective for reprocessing requests and will be present
4972 in capture results. The reprocess requests are from the original capture results
4973 that are associated with the intermediate {@link
4974 android.graphics.ImageFormat#YUV_420_888} output buffers. All other controls in the
4975 reprocess requests will be ignored by the camera device.
4977 * android.noiseReduction.mode
4979 * android.reprocess.effectiveExposureFactor
4980 * android.noiseReduction.availableNoiseReductionModes and
4981 android.edge.availableEdgeModes will both list ZERO_SHUTTER_LAG as a supported mode.
4984 <value optional="true">DEPTH_OUTPUT
4986 The camera device can produce depth measurements from its field of view.
4988 This capability requires the camera device to support the following:
4990 * {@link android.graphics.ImageFormat#DEPTH16|AIMAGE_FORMAT_DEPTH16} is supported as
4993 android.graphics.ImageFormat#DEPTH_POINT_CLOUD|AIMAGE_FORMAT_DEPTH_POINT_CLOUD} is
4994 optionally supported as an output format.
4995 * This camera device, and all camera devices with the same android.lens.facing, will
4996 list the following calibration metadata entries in both {@link
4997 android.hardware.camera2.CameraCharacteristics|ACameraManager_getCameraCharacteristics}
4999 android.hardware.camera2.CaptureResult|ACameraCaptureSession_captureCallback_result}:
5000 - android.lens.poseTranslation
5001 - android.lens.poseRotation
5002 - android.lens.intrinsicCalibration
5003 - android.lens.radialDistortion
5004 * The android.depth.depthIsExclusive entry is listed by this device.
5005 * As of Android P, the android.lens.poseReference entry is listed by this device.
5006 * A LIMITED camera with only the DEPTH_OUTPUT capability does not have to support
5007 normal YUV_420_888, JPEG, and PRIV-format outputs. It only has to support the DEPTH16
5010 Generally, depth output operates at a slower frame rate than standard color capture,
5011 so the DEPTH16 and DEPTH_POINT_CLOUD formats will commonly have a stall duration that
5012 should be accounted for (see {@link
5013 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration|ACAMERA_DEPTH_AVAILABLE_DEPTH_STALL_DURATIONS}).
5014 On a device that supports both depth and color-based output, to enable smooth preview,
5015 using a repeating burst is recommended, where a depth-output target is only included
5016 once every N frames, where N is the ratio between preview output rate and depth output
5017 rate, including depth stall time.
5020 <value optional="true" ndk_hidden="true">CONSTRAINED_HIGH_SPEED_VIDEO
5022 The device supports constrained high speed video recording (frame rate >=120fps) use
5023 case. The camera device will support high speed capture session created by {@link
5024 android.hardware.camera2.CameraDevice#createConstrainedHighSpeedCaptureSession}, which
5025 only accepts high speed request lists created by {@link
5026 android.hardware.camera2.CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList}.
5028 A camera device can still support high speed video streaming by advertising the high
5029 speed FPS ranges in android.control.aeAvailableTargetFpsRanges. For this case, all
5030 normal capture request per frame control and synchronization requirements will apply
5031 to the high speed fps ranges, the same as all other fps ranges. This capability
5032 describes the capability of a specialized operating mode with many limitations (see
5033 below), which is only targeted at high speed video recording.
5035 The supported high speed video sizes and fps ranges are specified in {@link
5036 android.hardware.camera2.params.StreamConfigurationMap#getHighSpeedVideoFpsRanges}.
5037 To get desired output frame rates, the application is only allowed to select video
5038 size and FPS range combinations provided by {@link
5039 android.hardware.camera2.params.StreamConfigurationMap#getHighSpeedVideoSizes}. The
5040 fps range can be controlled via android.control.aeTargetFpsRange.
5042 In this capability, the camera device will override aeMode, awbMode, and afMode to
5043 ON, AUTO, and CONTINUOUS_VIDEO, respectively. All post-processing block mode
5044 controls will be overridden to be FAST. Therefore, no manual control of capture
5045 and post-processing parameters is possible. All other controls operate the
5046 same as when android.control.mode == AUTO. This means that all other
5047 android.control.* fields continue to work, such as
5049 * android.control.aeTargetFpsRange
5050 * android.control.aeExposureCompensation
5051 * android.control.aeLock
5052 * android.control.awbLock
5053 * android.control.effectMode
5054 * android.control.aeRegions
5055 * android.control.afRegions
5056 * android.control.awbRegions
5057 * android.control.afTrigger
5058 * android.control.aePrecaptureTrigger
5060 Outside of android.control.*, the following controls will work:
5062 * android.flash.mode (TORCH mode only, automatic flash for still capture will not
5063 work since aeMode is ON)
5064 * android.lens.opticalStabilizationMode (if it is supported)
5065 * android.scaler.cropRegion
5066 * android.statistics.faceDetectMode (if it is supported)
5068 For high speed recording use case, the actual maximum supported frame rate may
5069 be lower than what camera can output, depending on the destination Surfaces for
5070 the image data. For example, if the destination surface is from video encoder,
5071 the application need check if the video encoder is capable of supporting the
5072 high frame rate for a given video size, or it will end up with lower recording
5073 frame rate. If the destination surface is from preview window, the actual preview frame
5074 rate will be bounded by the screen refresh rate.
5076 The camera device will only support up to 2 high speed simultaneous output surfaces
5077 (preview and recording surfaces) in this mode. Above controls will be effective only
5078 if all of below conditions are true:
5080 * The application creates a camera capture session with no more than 2 surfaces via
5082 android.hardware.camera2.CameraDevice#createConstrainedHighSpeedCaptureSession}. The
5083 targeted surfaces must be preview surface (either from {@link
5084 android.view.SurfaceView} or {@link android.graphics.SurfaceTexture}) or recording
5085 surface(either from {@link android.media.MediaRecorder#getSurface} or {@link
5086 android.media.MediaCodec#createInputSurface}).
5087 * The stream sizes are selected from the sizes reported by
5088 {@link android.hardware.camera2.params.StreamConfigurationMap#getHighSpeedVideoSizes}.
5089 * The FPS ranges are selected from {@link
5090 android.hardware.camera2.params.StreamConfigurationMap#getHighSpeedVideoFpsRanges}.
5092 When above conditions are NOT satistied,
5093 {@link android.hardware.camera2.CameraDevice#createConstrainedHighSpeedCaptureSession}
5096 Switching to a FPS range that has different maximum FPS may trigger some camera device
5097 reconfigurations, which may introduce extra latency. It is recommended that
5098 the application avoids unnecessary maximum target FPS changes as much as possible
5099 during high speed streaming.
5102 <value optional="true" hal_version="3.3" >MOTION_TRACKING
5104 The camera device supports the MOTION_TRACKING value for
5105 android.control.captureIntent, which limits maximum exposure time to 20 ms.
5107 This limits the motion blur of capture images, resulting in better image tracking
5108 results for use cases such as image stabilization or augmented reality.
5111 <value optional="true" hal_version="3.3">LOGICAL_MULTI_CAMERA
5113 The camera device is a logical camera backed by two or more physical cameras that are
5114 also exposed to the application.
5116 This capability requires the camera device to support the following:
5118 * This camera device must list the following static metadata entries in {@link
5119 android.hardware.camera2.CameraCharacteristics}:
5120 - android.logicalMultiCamera.physicalIds
5121 - android.logicalMultiCamera.sensorSyncType
5122 * The underlying physical cameras' static metadata must list the following entries,
5123 so that the application can correlate pixels from the physical streams:
5124 - android.lens.poseReference
5125 - android.lens.poseRotation
5126 - android.lens.poseTranslation
5127 - android.lens.intrinsicCalibration
5128 - android.lens.radialDistortion
5129 * The SENSOR_INFO_TIMESTAMP_SOURCE of the logical device and physical devices must be
5131 * The logical camera device must be LIMITED or higher device.
5133 Both the logical camera device and its underlying physical devices support the
5134 mandatory stream combinations required for their device levels.
5136 Additionally, for each guaranteed stream combination, the logical camera supports:
5138 * For each guaranteed stream combination, the logical camera supports replacing one
5139 logical {@link android.graphics.ImageFormat#YUV_420_888|AIMAGE_FORMAT_YUV_420_888 YUV_420_888}
5140 or raw stream with two physical streams of the same size and format, each from a
5141 separate physical camera, given that the size and format are supported by both
5143 * If the logical camera doesn't advertise RAW capability, but the underlying physical
5144 cameras do, the logical camera will support guaranteed stream combinations for RAW
5145 capability, except that the RAW streams will be physical streams, each from a separate
5146 physical camera. This is usually the case when the physical cameras have different
5149 Using physical streams in place of a logical stream of the same size and format will
5150 not slow down the frame rate of the capture, as long as the minimum frame duration
5151 of the physical and logical streams are the same.
5156 <description>List of capabilities that this camera device
5157 advertises as fully supporting.</description>
5159 A capability is a contract that the camera device makes in order
5160 to be able to satisfy one or more use cases.
5162 Listing a capability guarantees that the whole set of features
5163 required to support a common use will all be available.
5165 Using a subset of the functionality provided by an unsupported
5166 capability may be possible on a specific camera device implementation;
5167 to do this query each of android.request.availableRequestKeys,
5168 android.request.availableResultKeys,
5169 android.request.availableCharacteristicsKeys.
5171 The following capabilities are guaranteed to be available on
5172 android.info.supportedHardwareLevel `==` FULL devices:
5175 * MANUAL_POST_PROCESSING
5177 Other capabilities may be available on either FULL or LIMITED
5178 devices, but the application should query this key to be sure.
5181 Additional constraint details per-capability will be available
5182 in the Compatibility Test Suite.
5184 Minimum baseline requirements required for the
5185 BACKWARD_COMPATIBLE capability are not explicitly listed.
5186 Instead refer to "BC" tags and the camera CTS tests in the
5187 android.hardware.camera2.cts package.
5189 Listed controls that can be either request or result (e.g.
5190 android.sensor.exposureTime) must be available both in the
5191 request and the result in order to be considered to be
5192 capability-compliant.
5194 For example, if the HAL claims to support MANUAL control,
5195 then exposure time must be configurable via the request _and_
5196 the actual exposure applied must be available via
5199 If MANUAL_SENSOR is omitted, the HAL may choose to omit the
5200 android.scaler.availableMinFrameDurations static property entirely.
5202 For PRIVATE_REPROCESSING and YUV_REPROCESSING capabilities, see
5203 hardware/libhardware/include/hardware/camera3.h Section 10 for more information.
5205 Devices that support the MANUAL_SENSOR capability must support the
5206 CAMERA3_TEMPLATE_MANUAL template defined in camera3.h.
5208 Devices that support the PRIVATE_REPROCESSING capability or the
5209 YUV_REPROCESSING capability must support the
5210 CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template defined in camera3.h.
5212 For DEPTH_OUTPUT, the depth-format keys
5213 android.depth.availableDepthStreamConfigurations,
5214 android.depth.availableDepthMinFrameDurations,
5215 android.depth.availableDepthStallDurations must be available, in
5216 addition to the other keys explicitly mentioned in the DEPTH_OUTPUT
5217 enum notes. The entry android.depth.maxDepthSamples must be available
5218 if the DEPTH_POINT_CLOUD format is supported (HAL pixel format BLOB, dataspace
5221 For a camera device with LOGICAL_MULTI_CAMERA capability, it should operate in the
5222 same way as a physical camera device based on its hardware level and capabilities.
5223 It's recommended that its feature set is superset of that of individual physical cameras.
5226 <entry name="availableRequestKeys" type="int32" visibility="ndk_public"
5227 container="array" hwlevel="legacy">
5231 <description>A list of all keys that the camera device has available
5232 to use with {@link android.hardware.camera2.CaptureRequest|ACaptureRequest}.</description>
5234 <details>Attempting to set a key into a CaptureRequest that is not
5235 listed here will result in an invalid request and will be rejected
5236 by the camera device.
5238 This field can be used to query the feature set of a camera device
5239 at a more granular level than capabilities. This is especially
5240 important for optional keys that are not listed under any capability
5241 in android.request.availableCapabilities.
5244 Vendor tags can be listed here. Vendor tag metadata should also
5245 use the extensions C api (refer to camera3.h for more details).
5247 Setting/getting vendor tags will be checked against the metadata
5248 vendor extensions API and not against this field.
5250 The HAL must not consume any request tags that are not listed either
5251 here or in the vendor tag list.
5253 The public camera2 API will always make the vendor tags visible
5255 {@link android.hardware.camera2.CameraCharacteristics#getAvailableCaptureRequestKeys}.
5258 <entry name="availableResultKeys" type="int32" visibility="ndk_public"
5259 container="array" hwlevel="legacy">
5263 <description>A list of all keys that the camera device has available to use with {@link
5264 android.hardware.camera2.CaptureResult|ACameraCaptureSession_captureCallback_result}.
5267 <details>Attempting to get a key from a CaptureResult that is not
5268 listed here will always return a `null` value. Getting a key from
5269 a CaptureResult that is listed here will generally never return a `null`
5272 The following keys may return `null` unless they are enabled:
5274 * android.statistics.lensShadingMap (non-null iff android.statistics.lensShadingMapMode == ON)
5276 (Those sometimes-null keys will nevertheless be listed here
5277 if they are available.)
5279 This field can be used to query the feature set of a camera device
5280 at a more granular level than capabilities. This is especially
5281 important for optional keys that are not listed under any capability
5282 in android.request.availableCapabilities.
5285 Tags listed here must always have an entry in the result metadata,
5286 even if that size is 0 elements. Only array-type tags (e.g. lists,
5287 matrices, strings) are allowed to have 0 elements.
5289 Vendor tags can be listed here. Vendor tag metadata should also
5290 use the extensions C api (refer to camera3.h for more details).
5292 Setting/getting vendor tags will be checked against the metadata
5293 vendor extensions API and not against this field.
5295 The HAL must not produce any result tags that are not listed either
5296 here or in the vendor tag list.
5298 The public camera2 API will always make the vendor tags visible via {@link
5299 android.hardware.camera2.CameraCharacteristics#getAvailableCaptureResultKeys}.
5302 <entry name="availableCharacteristicsKeys" type="int32" visibility="ndk_public"
5303 container="array" hwlevel="legacy">
5307 <description>A list of all keys that the camera device has available to use with {@link
5308 android.hardware.camera2.CameraCharacteristics|ACameraManager_getCameraCharacteristics}.
5310 <details>This entry follows the same rules as
5311 android.request.availableResultKeys (except that it applies for
5312 CameraCharacteristics instead of CaptureResult). See above for more
5316 Keys listed here must always have an entry in the static info metadata,
5317 even if that size is 0 elements. Only array-type tags (e.g. lists,
5318 matrices, strings) are allowed to have 0 elements.
5320 Vendor tags can listed here. Vendor tag metadata should also use
5321 the extensions C api (refer to camera3.h for more details).
5323 Setting/getting vendor tags will be checked against the metadata
5324 vendor extensions API and not against this field.
5326 The HAL must not have any tags in its static info that are not listed
5327 either here or in the vendor tag list.
5329 The public camera2 API will always make the vendor tags visible
5330 via {@link android.hardware.camera2.CameraCharacteristics#getKeys}.
5333 <entry name="availableSessionKeys" type="int32" visibility="ndk_public"
5334 container="array" hwlevel="legacy" hal_version="3.3">
5338 <description>A subset of the available request keys that the camera device
5339 can pass as part of the capture session initialization.</description>
5341 <details> This is a subset of android.request.availableRequestKeys which
5342 contains a list of keys that are difficult to apply per-frame and
5343 can result in unexpected delays when modified during the capture session
5344 lifetime. Typical examples include parameters that require a
5345 time-consuming hardware re-configuration or internal camera pipeline
5346 change. For performance reasons we advise clients to pass their initial
5348 {@link SessionConfiguration#setSessionParameters|ACameraDevice_createCaptureSessionWithSessionParameters}.
5349 Once the camera capture session is enabled it is also recommended to avoid
5350 changing them from their initial values set in
5351 {@link SessionConfiguration#setSessionParameters|ACameraDevice_createCaptureSessionWithSessionParameters}.
5352 Control over session parameters can still be exerted in capture requests
5353 but clients should be aware and expect delays during their application.
5354 An example usage scenario could look like this:
5356 * The camera client starts by quering the session parameter key list via
5357 {@link android.hardware.camera2.CameraCharacteristics#getAvailableSessionKeys|ACameraManager_getCameraCharacteristics}.
5358 * Before triggering the capture session create sequence, a capture request
5360 {@link CameraDevice#createCaptureRequest|ACameraDevice_createCaptureRequest}
5361 using an appropriate template matching the particular use case.
5362 * The client should go over the list of session parameters and check
5363 whether some of the keys listed matches with the parameters that
5364 they intend to modify as part of the first capture request.
5365 * If there is no such match, the capture request can be passed
5367 {@link SessionConfiguration#setSessionParameters|ACameraDevice_createCaptureSessionWithSessionParameters}.
5368 * If matches do exist, the client should update the respective values
5369 and pass the request to
5370 {@link SessionConfiguration#setSessionParameters|ACameraDevice_createCaptureSessionWithSessionParameters}.
5371 * After the capture session initialization completes the session parameter
5372 key list can continue to serve as reference when posting or updating
5373 further requests. As mentioned above further changes to session
5374 parameters should ideally be avoided, if updates are necessary
5375 however clients could expect a delay/glitch during the
5380 Vendor tags can be listed here. Vendor tag metadata should also
5381 use the extensions C api (refer to
5382 android.hardware.camera.device.V3_4.StreamConfiguration.sessionParams for more details).
5384 Setting/getting vendor tags will be checked against the metadata
5385 vendor extensions API and not against this field.
5387 The HAL must not consume any request tags in the session parameters that
5388 are not listed either here or in the vendor tag list.
5390 The public camera2 API will always make the vendor tags visible
5392 {@link android.hardware.camera2.CameraCharacteristics#getAvailableSessionKeys}.
5395 <entry name="availablePhysicalCameraRequestKeys" type="int32" visibility="hidden"
5396 container="array" hwlevel="limited" hal_version="3.3">
5400 <description>A subset of the available request keys that can be overriden for
5401 physical devices backing a logical multi-camera.</description>
5403 This is a subset of android.request.availableRequestKeys which contains a list
5404 of keys that can be overriden using {@link CaptureRequest.Builder#setPhysicalCameraKey}.
5405 The respective value of such request key can be obtained by calling
5406 {@link CaptureRequest.Builder#getPhysicalCameraKey}. Capture requests that contain
5407 individual physical device requests must be built via
5408 {@link android.hardware.camera2.CameraDevice#createCaptureRequest(int, Set)}.
5411 Vendor tags can be listed here. Vendor tag metadata should also
5412 use the extensions C api (refer to
5413 android.hardware.camera.device.V3_4.CaptureRequest.physicalCameraSettings for more
5416 Setting/getting vendor tags will be checked against the metadata
5417 vendor extensions API and not against this field.
5419 The HAL must not consume any request tags in the session parameters that
5420 are not listed either here or in the vendor tag list.
5422 There should be no overlap between this set of keys and the available session keys
5423 {@link android.hardware.camera2.CameraCharacteristics#getAvailableSessionKeys} along
5424 with any other controls that can have impact on the dual-camera sync.
5426 The public camera2 API will always make the vendor tags visible
5428 {@link android.hardware.camera2.CameraCharacteristics#getAvailablePhysicalCameraRequestKeys}.
5433 <section name="scaler">
5435 <entry name="cropRegion" type="int32" visibility="public"
5436 container="array" typedef="rectangle" hwlevel="legacy">
5440 <description>The desired region of the sensor to read out for this capture.</description>
5441 <units>Pixel coordinates relative to
5442 android.sensor.info.activeArraySize</units>
5444 This control can be used to implement digital zoom.
5446 The crop region coordinate system is based off
5447 android.sensor.info.activeArraySize, with `(0, 0)` being the
5448 top-left corner of the sensor active array.
5450 Output streams use this rectangle to produce their output,
5451 cropping to a smaller region if necessary to maintain the
5452 stream's aspect ratio, then scaling the sensor input to
5453 match the output's configured resolution.
5455 The crop region is applied after the RAW to other color
5456 space (e.g. YUV) conversion. Since raw streams
5457 (e.g. RAW16) don't have the conversion stage, they are not
5458 croppable. The crop region will be ignored by raw streams.
5460 For non-raw streams, any additional per-stream cropping will
5461 be done to maximize the final pixel area of the stream.
5463 For example, if the crop region is set to a 4:3 aspect
5464 ratio, then 4:3 streams will use the exact crop
5465 region. 16:9 streams will further crop vertically
5468 Conversely, if the crop region is set to a 16:9, then 4:3
5469 outputs will crop horizontally (pillarbox), and 16:9
5470 streams will match exactly. These additional crops will
5471 be centered within the crop region.
5473 The width and height of the crop region cannot
5474 be set to be smaller than
5475 `floor( activeArraySize.width / android.scaler.availableMaxDigitalZoom )` and
5476 `floor( activeArraySize.height / android.scaler.availableMaxDigitalZoom )`, respectively.
5478 The camera device may adjust the crop region to account
5479 for rounding and other hardware requirements; the final
5480 crop region used will be included in the output capture
5484 The data representation is int[4], which maps to (left, top, width, height).
5487 The output streams must maintain square pixels at all
5488 times, no matter what the relative aspect ratios of the
5489 crop region and the stream are. Negative values for
5490 corner are allowed for raw output if full pixel array is
5491 larger than active pixel array. Width and height may be
5492 rounded to nearest larger supportable width, especially
5493 for raw output, where only a few fixed scales may be
5496 For a set of output streams configured, if the sensor output is cropped to a smaller
5497 size than active array size, the HAL need follow below cropping rules:
5499 * The HAL need handle the cropRegion as if the sensor crop size is the effective active
5500 array size.More specifically, the HAL must transform the request cropRegion from
5501 android.sensor.info.activeArraySize to the sensor cropped pixel area size in this way:
5502 1. Translate the requested cropRegion w.r.t., the left top corner of the sensor
5503 cropped pixel area by (tx, ty),
5504 where `tx = sensorCrop.top * (sensorCrop.height / activeArraySize.height)`
5505 and `tx = sensorCrop.left * (sensorCrop.width / activeArraySize.width)`. The
5506 (sensorCrop.top, sensorCrop.left) is the coordinate based off the
5507 android.sensor.info.activeArraySize.
5508 2. Scale the width and height of requested cropRegion with scaling factor of
5509 sensorCrop.width/activeArraySize.width and sensorCrop.height/activeArraySize.height
5511 Once this new cropRegion is calculated, the HAL must use this region to crop the image
5512 with regard to the sensor crop size (effective active array size). The HAL still need
5513 follow the general cropping rule for this new cropRegion and effective active
5516 * The HAL must report the cropRegion with regard to android.sensor.info.activeArraySize.
5517 The HAL need convert the new cropRegion generated above w.r.t., full active array size.
5518 The reported cropRegion may be slightly different with the requested cropRegion since
5519 the HAL may adjust the crop region to account for rounding, conversion error, or other
5520 hardware limitations.
5522 HAL2.x uses only (x, y, width)
5528 <entry name="availableFormats" type="int32"
5529 visibility="hidden" deprecated="true" enum="true"
5530 container="array" typedef="imageFormat">
5535 <value optional="true" id="0x20">RAW16
5537 RAW16 is a standard, cross-platform format for raw image
5538 buffers with 16-bit pixels.
5540 Buffers of this format are typically expected to have a
5541 Bayer Color Filter Array (CFA) layout, which is given in
5542 android.sensor.info.colorFilterArrangement. Sensors with
5543 CFAs that are not representable by a format in
5544 android.sensor.info.colorFilterArrangement should not
5547 Buffers of this format will also follow the constraints given for
5548 RAW_OPAQUE buffers, but with relaxed performance constraints.
5550 This format is intended to give users access to the full contents
5551 of the buffers coming directly from the image sensor prior to any
5552 cropping or scaling operations, and all coordinate systems for
5553 metadata used for this format are relative to the size of the
5554 active region of the image sensor before any geometric distortion
5555 correction has been applied (i.e.
5556 android.sensor.info.preCorrectionActiveArraySize). Supported
5557 dimensions for this format are limited to the full dimensions of
5558 the sensor (e.g. either android.sensor.info.pixelArraySize or
5559 android.sensor.info.preCorrectionActiveArraySize will be the
5560 only supported output size).
5562 See android.scaler.availableInputOutputFormatsMap for
5563 the full set of performance guarantees.
5566 <value optional="true" id="0x24">RAW_OPAQUE
5569 {@link android.graphics.ImageFormat#RAW_PRIVATE RAW_PRIVATE}
5570 as referred in public API) is a format for raw image buffers
5571 coming from an image sensor.
5573 The actual structure of buffers of this format is
5574 platform-specific, but must follow several constraints:
5576 1. No image post-processing operations may have been applied to
5577 buffers of this type. These buffers contain raw image data coming
5578 directly from the image sensor.
5579 1. If a buffer of this format is passed to the camera device for
5580 reprocessing, the resulting images will be identical to the images
5581 produced if the buffer had come directly from the sensor and was
5582 processed with the same settings.
5584 The intended use for this format is to allow access to the native
5585 raw format buffers coming directly from the camera sensor without
5586 any additional conversions or decrease in framerate.
5588 See android.scaler.availableInputOutputFormatsMap for the full set of
5589 performance guarantees.
5592 <value optional="true" id="0x32315659">YV12
5593 <notes>YCrCb 4:2:0 Planar</notes>
5595 <value optional="true" id="0x11">YCrCb_420_SP
5598 <value id="0x22">IMPLEMENTATION_DEFINED
5599 <notes>System internal format, not application-accessible</notes>
5601 <value id="0x23">YCbCr_420_888
5602 <notes>Flexible YUV420 Format</notes>
5604 <value id="0x21">BLOB
5605 <notes>JPEG format</notes>
5608 <description>The list of image formats that are supported by this
5609 camera device for output streams.</description>
5611 All camera devices will support JPEG and YUV_420_888 formats.
5613 When set to YUV_420_888, application can access the YUV420 data directly.
5616 These format values are from HAL_PIXEL_FORMAT_* in
5617 system/core/include/system/graphics.h.
5619 When IMPLEMENTATION_DEFINED is used, the platform
5620 gralloc module will select a format based on the usage flags provided
5621 by the camera HAL device and the other endpoint of the stream. It is
5622 usually used by preview and recording streams, where the application doesn't
5623 need access the image data.
5625 YCbCr_420_888 format must be supported by the HAL. When an image stream
5626 needs CPU/application direct access, this format will be used.
5628 The BLOB format must be supported by the HAL. This is used for the JPEG stream.
5630 A RAW_OPAQUE buffer should contain only pixel data. It is strongly
5631 recommended that any information used by the camera device when
5632 processing images is fully expressed by the result metadata
5633 for that image buffer.
5637 <entry name="availableJpegMinDurations" type="int64" visibility="hidden" deprecated="true"
5642 <description>The minimum frame duration that is supported
5643 for each resolution in android.scaler.availableJpegSizes.
5645 <units>Nanoseconds</units>
5646 <range>TODO: Remove property.</range>
5648 This corresponds to the minimum steady-state frame duration when only
5649 that JPEG stream is active and captured in a burst, with all
5650 processing (typically in android.*.mode) set to FAST.
5652 When multiple streams are configured, the minimum
5653 frame duration will be &gt;= max(individual stream min
5654 durations)</details>
5657 <entry name="availableJpegSizes" type="int32" visibility="hidden"
5658 deprecated="true" container="array" typedef="size">
5663 <description>The JPEG resolutions that are supported by this camera device.</description>
5664 <range>TODO: Remove property.</range>
5666 The resolutions are listed as `(width, height)` pairs. All camera devices will support
5667 sensor maximum resolution (defined by android.sensor.info.activeArraySize).
5670 The HAL must include sensor maximum resolution
5671 (defined by android.sensor.info.activeArraySize),
5672 and should include half/quarter of sensor maximum resolution.
5676 <entry name="availableMaxDigitalZoom" type="float" visibility="public"
5678 <description>The maximum ratio between both active area width
5679 and crop region width, and active area height and
5680 crop region height, for android.scaler.cropRegion.
5682 <units>Zoom scale factor</units>
5683 <range>&gt;=1</range>
5685 This represents the maximum amount of zooming possible by
5686 the camera device, or equivalently, the minimum cropping
5689 Crop regions that have a width or height that is smaller
5690 than this ratio allows will be rounded up to the minimum
5691 allowed size by the camera device.
5695 <entry name="availableProcessedMinDurations" type="int64" visibility="hidden" deprecated="true"
5700 <description>For each available processed output size (defined in
5701 android.scaler.availableProcessedSizes), this property lists the
5702 minimum supportable frame duration for that size.
5704 <units>Nanoseconds</units>
5706 This should correspond to the frame duration when only that processed
5707 stream is active, with all processing (typically in android.*.mode)
5710 When multiple streams are configured, the minimum frame duration will
5711 be &gt;= max(individual stream min durations).
5715 <entry name="availableProcessedSizes" type="int32" visibility="hidden"
5716 deprecated="true" container="array" typedef="size">
5721 <description>The resolutions available for use with
5722 processed output streams, such as YV12, NV12, and
5723 platform opaque YUV/RGB streams to the GPU or video
5724 encoders.</description>
5726 The resolutions are listed as `(width, height)` pairs.
5728 For a given use case, the actual maximum supported resolution
5729 may be lower than what is listed here, depending on the destination
5730 Surface for the image data. For example, for recording video,
5731 the video encoder chosen may have a maximum size limit (e.g. 1080p)
5732 smaller than what the camera (e.g. maximum resolution is 3264x2448)
5735 Please reference the documentation for the image data destination to
5736 check if it limits the maximum size for image data.
5739 For FULL capability devices (`android.info.supportedHardwareLevel == FULL`),
5740 the HAL must include all JPEG sizes listed in android.scaler.availableJpegSizes
5741 and each below resolution if it is smaller than or equal to the sensor
5742 maximum resolution (if they are not listed in JPEG sizes already):
5747 * 1080p (1920 x 1080)
5749 For LIMITED capability devices (`android.info.supportedHardwareLevel == LIMITED`),
5750 the HAL only has to list up to the maximum video size supported by the devices.
5754 <entry name="availableRawMinDurations" type="int64" deprecated="true"
5760 For each available raw output size (defined in
5761 android.scaler.availableRawSizes), this property lists the minimum
5762 supportable frame duration for that size.
5764 <units>Nanoseconds</units>
5766 Should correspond to the frame duration when only the raw stream is
5769 When multiple streams are configured, the minimum
5770 frame duration will be &gt;= max(individual stream min
5771 durations)</details>
5774 <entry name="availableRawSizes" type="int32" deprecated="true"
5775 container="array" typedef="size">
5780 <description>The resolutions available for use with raw
5781 sensor output streams, listed as width,
5782 height</description>
5786 <clone entry="android.scaler.cropRegion" kind="controls">
5790 <entry name="availableInputOutputFormatsMap" type="int32" visibility="hidden"
5791 typedef="reprocessFormatsMap">
5792 <description>The mapping of image formats that are supported by this
5793 camera device for input streams, to their corresponding output formats.
5796 All camera devices with at least 1
5797 android.request.maxNumInputStreams will have at least one
5798 available input format.
5800 The camera device will support the following map of formats,
5801 if its dependent capability (android.request.availableCapabilities) is supported:
5803 Input Format | Output Format | Capability
5804 :-------------------------------------------------|:--------------------------------------------------|:----------
5805 {@link android.graphics.ImageFormat#PRIVATE} | {@link android.graphics.ImageFormat#JPEG} | PRIVATE_REPROCESSING
5806 {@link android.graphics.ImageFormat#PRIVATE} | {@link android.graphics.ImageFormat#YUV_420_888} | PRIVATE_REPROCESSING
5807 {@link android.graphics.ImageFormat#YUV_420_888} | {@link android.graphics.ImageFormat#JPEG} | YUV_REPROCESSING
5808 {@link android.graphics.ImageFormat#YUV_420_888} | {@link android.graphics.ImageFormat#YUV_420_888} | YUV_REPROCESSING
5810 PRIVATE refers to a device-internal format that is not directly application-visible. A
5811 PRIVATE input surface can be acquired by {@link android.media.ImageReader#newInstance}
5812 with {@link android.graphics.ImageFormat#PRIVATE} as the format.
5814 For a PRIVATE_REPROCESSING-capable camera device, using the PRIVATE format as either input
5815 or output will never hurt maximum frame rate (i.e. {@link
5816 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration
5817 getOutputStallDuration(ImageFormat.PRIVATE, size)} is always 0),
5819 Attempting to configure an input stream with output streams not
5820 listed as available in this map is not valid.
5823 For the formats, see `system/core/include/system/graphics.h` for a definition
5824 of the image format enumerations. The PRIVATE format refers to the
5825 HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED format. The HAL could determine
5826 the actual format by using the gralloc usage flags.
5827 For ZSL use case in particular, the HAL could choose appropriate format (partially
5828 processed YUV or RAW based format) by checking the format and GRALLOC_USAGE_HW_CAMERA_ZSL.
5829 See camera3.h for more details.
5831 This value is encoded as a variable-size array-of-arrays.
5832 The inner array always contains `[format, length, ...]` where
5833 `...` has `length` elements. An inner array is followed by another
5834 inner array if the total metadata entry size hasn't yet been exceeded.
5836 A code sample to read/write this encoding (with a device that
5837 supports reprocessing IMPLEMENTATION_DEFINED to YUV_420_888, and JPEG,
5838 and reprocessing YUV_420_888 to YUV_420_888 and JPEG):
5841 int32_t* contents = &entry.i32[0];
5842 for (size_t i = 0; i < entry.count; ) {
5843 int32_t format = contents[i++];
5844 int32_t length = contents[i++];
5845 int32_t output_formats[length];
5846 memcpy(&output_formats[0], &contents[i],
5847 length * sizeof(int32_t));
5851 // writing (static example, PRIVATE_REPROCESSING + YUV_REPROCESSING)
5852 int32_t[] contents = {
5853 IMPLEMENTATION_DEFINED, 2, YUV_420_888, BLOB,
5854 YUV_420_888, 2, YUV_420_888, BLOB,
5856 update_camera_metadata_entry(metadata, index, &contents[0],
5857 sizeof(contents)/sizeof(contents[0]), &updated_entry);
5859 If the HAL claims to support any of the capabilities listed in the
5860 above details, then it must also support all the input-output
5861 combinations listed for that capability. It can optionally support
5862 additional formats if it so chooses.
5866 <entry name="availableStreamConfigurations" type="int32" visibility="ndk_public"
5867 enum="true" container="array" typedef="streamConfiguration" hwlevel="legacy">
5873 <value>OUTPUT</value>
5874 <value>INPUT</value>
5876 <description>The available stream configurations that this
5877 camera device supports
5878 (i.e. format, width, height, output/input stream).
5881 The configurations are listed as `(format, width, height, input?)`
5884 For a given use case, the actual maximum supported resolution
5885 may be lower than what is listed here, depending on the destination
5886 Surface for the image data. For example, for recording video,
5887 the video encoder chosen may have a maximum size limit (e.g. 1080p)
5888 smaller than what the camera (e.g. maximum resolution is 3264x2448)
5891 Please reference the documentation for the image data destination to
5892 check if it limits the maximum size for image data.
5894 Not all output formats may be supported in a configuration with
5895 an input stream of a particular format. For more details, see
5896 android.scaler.availableInputOutputFormatsMap.
5898 The following table describes the minimum required output stream
5899 configurations based on the hardware level
5900 (android.info.supportedHardwareLevel):
5902 Format | Size | Hardware Level | Notes
5903 :-------------:|:--------------------------------------------:|:--------------:|:--------------:
5904 JPEG | android.sensor.info.activeArraySize | Any |
5905 JPEG | 1920x1080 (1080p) | Any | if 1080p <= activeArraySize
5906 JPEG | 1280x720 (720) | Any | if 720p <= activeArraySize
5907 JPEG | 640x480 (480p) | Any | if 480p <= activeArraySize
5908 JPEG | 320x240 (240p) | Any | if 240p <= activeArraySize
5909 YUV_420_888 | all output sizes available for JPEG | FULL |
5910 YUV_420_888 | all output sizes available for JPEG, up to the maximum video size | LIMITED |
5911 IMPLEMENTATION_DEFINED | same as YUV_420_888 | Any |
5913 Refer to android.request.availableCapabilities for additional
5914 mandatory stream configurations on a per-capability basis.
5917 It is recommended (but not mandatory) to also include half/quarter
5918 of sensor maximum resolution for JPEG formats (regardless of hardware
5921 (The following is a rewording of the above required table):
5923 For JPEG format, the sizes may be restricted by below conditions:
5925 * The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones
5926 (e.g. 4:3, 16:9, 3:2 etc.). If the sensor maximum resolution
5927 (defined by android.sensor.info.activeArraySize) has an aspect ratio other than these,
5928 it does not have to be included in the supported JPEG sizes.
5929 * Some hardware JPEG encoders may have pixel boundary alignment requirements, such as
5930 the dimensions being a multiple of 16.
5932 Therefore, the maximum JPEG size may be smaller than sensor maximum resolution.
5933 However, the largest JPEG size must be as close as possible to the sensor maximum
5934 resolution given above constraints. It is required that after aspect ratio adjustments,
5935 additional size reduction due to other issues must be less than 3% in area. For example,
5936 if the sensor maximum resolution is 3280x2464, if the maximum JPEG size has aspect
5937 ratio 4:3, the JPEG encoder alignment requirement is 16, the maximum JPEG size will be
5940 For FULL capability devices (`android.info.supportedHardwareLevel == FULL`),
5941 the HAL must include all YUV_420_888 sizes that have JPEG sizes listed
5942 here as output streams.
5944 It must also include each below resolution if it is smaller than or
5945 equal to the sensor maximum resolution (for both YUV_420_888 and JPEG
5946 formats), as output streams:
5951 * 1080p (1920 x 1080)
5953 For LIMITED capability devices
5954 (`android.info.supportedHardwareLevel == LIMITED`),
5955 the HAL only has to list up to the maximum video size
5956 supported by the device.
5958 Regardless of hardware level, every output resolution available for
5959 YUV_420_888 must also be available for IMPLEMENTATION_DEFINED.
5961 This supercedes the following fields, which are now deprecated:
5964 * available[Processed,Raw,Jpeg]Sizes
5967 <entry name="availableMinFrameDurations" type="int64" visibility="ndk_public"
5968 container="array" typedef="streamConfigurationDuration" hwlevel="legacy">
5973 <description>This lists the minimum frame duration for each
5974 format/size combination.
5976 <units>(format, width, height, ns) x n</units>
5978 This should correspond to the frame duration when only that
5979 stream is active, with all processing (typically in android.*.mode)
5980 set to either OFF or FAST.
5982 When multiple streams are used in a request, the minimum frame
5983 duration will be max(individual stream min durations).
5985 The minimum frame duration of a stream (of a particular format, size)
5986 is the same regardless of whether the stream is input or output.
5988 See android.sensor.frameDuration and
5989 android.scaler.availableStallDurations for more details about
5990 calculating the max frame rate.
5994 <entry name="availableStallDurations" type="int64" visibility="ndk_public"
5995 container="array" typedef="streamConfigurationDuration" hwlevel="legacy">
6000 <description>This lists the maximum stall duration for each
6001 output format/size combination.
6003 <units>(format, width, height, ns) x n</units>
6005 A stall duration is how much extra time would get added
6006 to the normal minimum frame duration for a repeating request
6007 that has streams with non-zero stall.
6009 For example, consider JPEG captures which have the following
6012 * JPEG streams act like processed YUV streams in requests for which
6013 they are not included; in requests in which they are directly
6014 referenced, they act as JPEG streams. This is because supporting a
6015 JPEG stream requires the underlying YUV data to always be ready for
6016 use by a JPEG encoder, but the encoder will only be used (and impact
6017 frame duration) on requests that actually reference a JPEG stream.
6018 * The JPEG processor can run concurrently to the rest of the camera
6019 pipeline, but cannot process more than 1 capture at a time.
6021 In other words, using a repeating YUV request would result
6022 in a steady frame rate (let's say it's 30 FPS). If a single
6023 JPEG request is submitted periodically, the frame rate will stay
6024 at 30 FPS (as long as we wait for the previous JPEG to return each
6025 time). If we try to submit a repeating YUV + JPEG request, then
6026 the frame rate will drop from 30 FPS.
6028 In general, submitting a new request with a non-0 stall time
6029 stream will _not_ cause a frame rate drop unless there are still
6030 outstanding buffers for that stream from previous requests.
6032 Submitting a repeating request with streams (call this `S`)
6033 is the same as setting the minimum frame duration from
6034 the normal minimum frame duration corresponding to `S`, added with
6035 the maximum stall duration for `S`.
6037 If interleaving requests with and without a stall duration,
6038 a request will stall by the maximum of the remaining times
6039 for each can-stall stream with outstanding buffers.
6041 This means that a stalling request will not have an exposure start
6042 until the stall has completed.
6044 This should correspond to the stall duration when only that stream is
6045 active, with all processing (typically in android.*.mode) set to FAST
6046 or OFF. Setting any of the processing modes to HIGH_QUALITY
6047 effectively results in an indeterminate stall duration for all
6048 streams in a request (the regular stall calculation rules are
6051 The following formats may always have a stall duration:
6053 * {@link android.graphics.ImageFormat#JPEG|AIMAGE_FORMAT_JPEG}
6054 * {@link android.graphics.ImageFormat#RAW_SENSOR|AIMAGE_FORMAT_RAW16}
6056 The following formats will never have a stall duration:
6058 * {@link android.graphics.ImageFormat#YUV_420_888|AIMAGE_FORMAT_YUV_420_888}
6059 * {@link android.graphics.ImageFormat#RAW10|AIMAGE_FORMAT_RAW10}
6060 * {@link android.graphics.ImageFormat#RAW12|AIMAGE_FORMAT_RAW12}
6062 All other formats may or may not have an allowed stall duration on
6063 a per-capability basis; refer to android.request.availableCapabilities
6066 See android.sensor.frameDuration for more information about
6067 calculating the max frame rate (absent stalls).
6070 If possible, it is recommended that all non-JPEG formats
6071 (such as RAW16) should not have a stall duration. RAW10, RAW12, RAW_OPAQUE
6072 and IMPLEMENTATION_DEFINED must not have stall durations.
6076 <entry name="streamConfigurationMap" type="int32" visibility="java_public"
6077 synthetic="true" typedef="streamConfigurationMap"
6079 <description>The available stream configurations that this
6080 camera device supports; also includes the minimum frame durations
6081 and the stall durations for each format/size combination.
6084 All camera devices will support sensor maximum resolution (defined by
6085 android.sensor.info.activeArraySize) for the JPEG format.
6087 For a given use case, the actual maximum supported resolution
6088 may be lower than what is listed here, depending on the destination
6089 Surface for the image data. For example, for recording video,
6090 the video encoder chosen may have a maximum size limit (e.g. 1080p)
6091 smaller than what the camera (e.g. maximum resolution is 3264x2448)
6094 Please reference the documentation for the image data destination to
6095 check if it limits the maximum size for image data.
6097 The following table describes the minimum required output stream
6098 configurations based on the hardware level
6099 (android.info.supportedHardwareLevel):
6101 Format | Size | Hardware Level | Notes
6102 :-------------------------------------------------:|:--------------------------------------------:|:--------------:|:--------------:
6103 {@link android.graphics.ImageFormat#JPEG} | android.sensor.info.activeArraySize (*1) | Any |
6104 {@link android.graphics.ImageFormat#JPEG} | 1920x1080 (1080p) | Any | if 1080p <= activeArraySize
6105 {@link android.graphics.ImageFormat#JPEG} | 1280x720 (720p) | Any | if 720p <= activeArraySize
6106 {@link android.graphics.ImageFormat#JPEG} | 640x480 (480p) | Any | if 480p <= activeArraySize
6107 {@link android.graphics.ImageFormat#JPEG} | 320x240 (240p) | Any | if 240p <= activeArraySize
6108 {@link android.graphics.ImageFormat#YUV_420_888} | all output sizes available for JPEG | FULL |
6109 {@link android.graphics.ImageFormat#YUV_420_888} | all output sizes available for JPEG, up to the maximum video size | LIMITED |
6110 {@link android.graphics.ImageFormat#PRIVATE} | same as YUV_420_888 | Any |
6112 Refer to android.request.availableCapabilities and {@link
6113 android.hardware.camera2.CameraDevice#createCaptureSession} for additional mandatory
6114 stream configurations on a per-capability basis.
6116 *1: For JPEG format, the sizes may be restricted by below conditions:
6118 * The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones
6119 (e.g. 4:3, 16:9, 3:2 etc.). If the sensor maximum resolution
6120 (defined by android.sensor.info.activeArraySize) has an aspect ratio other than these,
6121 it does not have to be included in the supported JPEG sizes.
6122 * Some hardware JPEG encoders may have pixel boundary alignment requirements, such as
6123 the dimensions being a multiple of 16.
6124 Therefore, the maximum JPEG size may be smaller than sensor maximum resolution.
6125 However, the largest JPEG size will be as close as possible to the sensor maximum
6126 resolution given above constraints. It is required that after aspect ratio adjustments,
6127 additional size reduction due to other issues must be less than 3% in area. For example,
6128 if the sensor maximum resolution is 3280x2464, if the maximum JPEG size has aspect
6129 ratio 4:3, and the JPEG encoder alignment requirement is 16, the maximum JPEG size will be
6133 Do not set this property directly
6134 (it is synthetic and will not be available at the HAL layer);
6135 set the android.scaler.availableStreamConfigurations instead.
6137 Not all output formats may be supported in a configuration with
6138 an input stream of a particular format. For more details, see
6139 android.scaler.availableInputOutputFormatsMap.
6141 It is recommended (but not mandatory) to also include half/quarter
6142 of sensor maximum resolution for JPEG formats (regardless of hardware
6145 (The following is a rewording of the above required table):
6147 The HAL must include sensor maximum resolution (defined by
6148 android.sensor.info.activeArraySize).
6150 For FULL capability devices (`android.info.supportedHardwareLevel == FULL`),
6151 the HAL must include all YUV_420_888 sizes that have JPEG sizes listed
6152 here as output streams.
6154 It must also include each below resolution if it is smaller than or
6155 equal to the sensor maximum resolution (for both YUV_420_888 and JPEG
6156 formats), as output streams:
6161 * 1080p (1920 x 1080)
6163 For LIMITED capability devices
6164 (`android.info.supportedHardwareLevel == LIMITED`),
6165 the HAL only has to list up to the maximum video size
6166 supported by the device.
6168 Regardless of hardware level, every output resolution available for
6169 YUV_420_888 must also be available for IMPLEMENTATION_DEFINED.
6171 This supercedes the following fields, which are now deprecated:
6174 * available[Processed,Raw,Jpeg]Sizes
6177 <entry name="croppingType" type="byte" visibility="public" enum="true"
6182 The camera device only supports centered crop regions.
6187 The camera device supports arbitrarily chosen crop regions.
6191 <description>The crop type that this camera device supports.</description>
6193 When passing a non-centered crop region (android.scaler.cropRegion) to a camera
6194 device that only supports CENTER_ONLY cropping, the camera device will move the
6195 crop region to the center of the sensor active array (android.sensor.info.activeArraySize)
6196 and keep the crop region width and height unchanged. The camera device will return the
6197 final used crop region in metadata result android.scaler.cropRegion.
6199 Camera devices that support FREEFORM cropping will support any crop region that
6200 is inside of the active array. The camera device will apply the same crop region and
6201 return the final used crop region in capture result metadata android.scaler.cropRegion.
6203 LEGACY capability devices will only support CENTER_ONLY cropping.
6208 <section name="sensor">
6210 <entry name="exposureTime" type="int64" visibility="public" hwlevel="full">
6211 <description>Duration each pixel is exposed to
6212 light.</description>
6213 <units>Nanoseconds</units>
6214 <range>android.sensor.info.exposureTimeRange</range>
6215 <details>If the sensor can't expose this exact duration, it will shorten the
6216 duration exposed to the nearest possible value (rather than expose longer).
6217 The final exposure time used will be available in the output capture result.
6219 This control is only effective if android.control.aeMode or android.control.mode is set to
6220 OFF; otherwise the auto-exposure algorithm will override this value.
6224 <entry name="frameDuration" type="int64" visibility="public" hwlevel="full">
6225 <description>Duration from start of frame exposure to
6226 start of next frame exposure.</description>
6227 <units>Nanoseconds</units>
6228 <range>See android.sensor.info.maxFrameDuration, {@link
6229 android.hardware.camera2.params.StreamConfigurationMap|ACAMERA_SCALER_AVAILABLE_MIN_FRAME_DURATIONS}.
6230 The duration is capped to `max(duration, exposureTime + overhead)`.</range>
6232 The maximum frame rate that can be supported by a camera subsystem is
6233 a function of many factors:
6235 * Requested resolutions of output image streams
6236 * Availability of binning / skipping modes on the imager
6237 * The bandwidth of the imager interface
6238 * The bandwidth of the various ISP processing blocks
6240 Since these factors can vary greatly between different ISPs and
6241 sensors, the camera abstraction tries to represent the bandwidth
6242 restrictions with as simple a model as possible.
6244 The model presented has the following characteristics:
6246 * The image sensor is always configured to output the smallest
6247 resolution possible given the application's requested output stream
6248 sizes. The smallest resolution is defined as being at least as large
6249 as the largest requested output stream size; the camera pipeline must
6250 never digitally upsample sensor data when the crop region covers the
6251 whole sensor. In general, this means that if only small output stream
6252 resolutions are configured, the sensor can provide a higher frame
6254 * Since any request may use any or all the currently configured
6255 output streams, the sensor and ISP must be configured to support
6256 scaling a single capture to all the streams at the same time. This
6257 means the camera pipeline must be ready to produce the largest
6258 requested output size without any delay. Therefore, the overall
6259 frame rate of a given configured stream set is governed only by the
6260 largest requested stream resolution.
6261 * Using more than one output stream in a request does not affect the
6263 * Certain format-streams may need to do additional background processing
6264 before data is consumed/produced by that stream. These processors
6265 can run concurrently to the rest of the camera pipeline, but
6266 cannot process more than 1 capture at a time.
6268 The necessary information for the application, given the model above, is provided via
6270 android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration|ACAMERA_SCALER_AVAILABLE_MIN_FRAME_DURATIONS}.
6271 These are used to determine the maximum frame rate / minimum frame duration that is
6272 possible for a given stream configuration.
6274 Specifically, the application can use the following rules to
6275 determine the minimum frame duration it can request from the camera
6278 1. Let the set of currently configured input/output streams be called `S`.
6279 1. Find the minimum frame durations for each stream in `S`, by looking it up in {@link
6280 android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration|ACAMERA_SCALER_AVAILABLE_MIN_FRAME_DURATIONS}
6281 (with its respective size/format). Let this set of frame durations be called `F`.
6282 1. For any given request `R`, the minimum frame duration allowed for `R` is the maximum
6283 out of all values in `F`. Let the streams used in `R` be called `S_r`.
6285 If none of the streams in `S_r` have a stall time (listed in {@link
6286 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration|ACAMERA_SCALER_AVAILABLE_STALL_DURATIONS}
6287 using its respective size/format), then the frame duration in `F` determines the steady
6288 state frame rate that the application will get if it uses `R` as a repeating request. Let
6289 this special kind of request be called `Rsimple`.
6291 A repeating request `Rsimple` can be _occasionally_ interleaved by a single capture of a
6292 new request `Rstall` (which has at least one in-use stream with a non-0 stall time) and if
6293 `Rstall` has the same minimum frame duration this will not cause a frame rate loss if all
6294 buffers from the previous `Rstall` have already been delivered.
6296 For more details about stalling, see {@link
6297 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration|ACAMERA_SCALER_AVAILABLE_STALL_DURATIONS}.
6299 This control is only effective if android.control.aeMode or android.control.mode is set to
6300 OFF; otherwise the auto-exposure algorithm will override this value.
6303 For more details about stalling, see
6304 android.scaler.availableStallDurations.
6308 <entry name="sensitivity" type="int32" visibility="public" hwlevel="full">
6309 <description>The amount of gain applied to sensor data
6310 before processing.</description>
6311 <units>ISO arithmetic units</units>
6312 <range>android.sensor.info.sensitivityRange</range>
6314 The sensitivity is the standard ISO sensitivity value,
6315 as defined in ISO 12232:2006.
6317 The sensitivity must be within android.sensor.info.sensitivityRange, and
6318 if if it less than android.sensor.maxAnalogSensitivity, the camera device
6319 is guaranteed to use only analog amplification for applying the gain.
6321 If the camera device cannot apply the exact sensitivity
6322 requested, it will reduce the gain to the nearest supported
6323 value. The final sensitivity used will be available in the
6324 output capture result.
6326 This control is only effective if android.control.aeMode or android.control.mode is set to
6327 OFF; otherwise the auto-exposure algorithm will override this value.
6329 <hal_details>ISO 12232:2006 REI method is acceptable.</hal_details>
6334 <namespace name="info">
6335 <entry name="activeArraySize" type="int32" visibility="public"
6336 type_notes="Four ints defining the active pixel rectangle"
6337 container="array" typedef="rectangle" hwlevel="legacy">
6342 The area of the image sensor which corresponds to active pixels after any geometric
6343 distortion correction has been applied.
6345 <units>Pixel coordinates on the image sensor</units>
6347 This is the rectangle representing the size of the active region of the sensor (i.e.
6348 the region that actually receives light from the scene) after any geometric correction
6349 has been applied, and should be treated as the maximum size in pixels of any of the
6350 image output formats aside from the raw formats.
6352 This rectangle is defined relative to the full pixel array; (0,0) is the top-left of
6353 the full pixel array, and the size of the full pixel array is given by
6354 android.sensor.info.pixelArraySize.
6356 The coordinate system for most other keys that list pixel coordinates, including
6357 android.scaler.cropRegion, is defined relative to the active array rectangle given in
6358 this field, with `(0, 0)` being the top-left of this rectangle.
6360 The active array may be smaller than the full pixel array, since the full array may
6361 include black calibration pixels or other inactive regions, and geometric correction
6362 resulting in scaling or cropping may have been applied.
6365 The data representation is `int[4]`, which maps to `(left, top, width, height)`.
6368 This array contains `(xmin, ymin, width, height)`. The `(xmin, ymin)` must be
6370 The `(width, height)` must be &lt;= `android.sensor.info.pixelArraySize`.
6374 <entry name="sensitivityRange" type="int32" visibility="public"
6375 type_notes="Range of supported sensitivities"
6376 container="array" typedef="rangeInt"
6381 <description>Range of sensitivities for android.sensor.sensitivity supported by this
6382 camera device.</description>
6383 <range>Min <= 100, Max &gt;= 800</range>
6385 The values are the standard ISO sensitivity values,
6386 as defined in ISO 12232:2006.
6392 <entry name="colorFilterArrangement" type="byte" visibility="public" enum="true"
6400 <notes>Sensor is not Bayer; output has 3 16-bit
6401 values for each pixel, instead of just 1 16-bit value
6402 per pixel.</notes></value>
6404 <description>The arrangement of color filters on sensor;
6405 represents the colors in the top-left 2x2 section of
6406 the sensor, in reading order.</description>
6409 <entry name="exposureTimeRange" type="int64" visibility="public"
6410 type_notes="nanoseconds" container="array" typedef="rangeLong"
6415 <description>The range of image exposure times for android.sensor.exposureTime supported
6416 by this camera device.
6418 <units>Nanoseconds</units>
6419 <range>The minimum exposure time will be less than 100 us. For FULL
6420 capability devices (android.info.supportedHardwareLevel == FULL),
6421 the maximum exposure time will be greater than 100ms.</range>
6422 <hal_details>For FULL capability devices (android.info.supportedHardwareLevel == FULL),
6423 The maximum of the range SHOULD be at least 1 second (1e9), MUST be at least
6428 <entry name="maxFrameDuration" type="int64" visibility="public"
6430 <description>The maximum possible frame duration (minimum frame rate) for
6431 android.sensor.frameDuration that is supported this camera device.</description>
6432 <units>Nanoseconds</units>
6433 <range>For FULL capability devices
6434 (android.info.supportedHardwareLevel == FULL), at least 100ms.
6436 <details>Attempting to use frame durations beyond the maximum will result in the frame
6437 duration being clipped to the maximum. See that control for a full definition of frame
6441 android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration|ACAMERA_SCALER_AVAILABLE_MIN_FRAME_DURATIONS}
6442 for the minimum frame duration values.
6445 For FULL capability devices (android.info.supportedHardwareLevel == FULL),
6446 The maximum of the range SHOULD be at least
6447 1 second (1e9), MUST be at least 100ms (100e6).
6449 android.sensor.info.maxFrameDuration must be greater or
6450 equal to the android.sensor.info.exposureTimeRange max
6451 value (since exposure time overrides frame duration).
6453 Available minimum frame durations for JPEG must be no greater
6454 than that of the YUV_420_888/IMPLEMENTATION_DEFINED
6455 minimum frame durations (for that respective size).
6457 Since JPEG processing is considered offline and can take longer than
6458 a single uncompressed capture, refer to
6459 android.scaler.availableStallDurations
6460 for details about encoding this scenario.
6464 <entry name="physicalSize" type="float" visibility="public"
6465 type_notes="width x height"
6466 container="array" typedef="sizeF" hwlevel="legacy">
6470 <description>The physical dimensions of the full pixel
6471 array.</description>
6472 <units>Millimeters</units>
6473 <details>This is the physical size of the sensor pixel
6474 array defined by android.sensor.info.pixelArraySize.
6476 <hal_details>Needed for FOV calculation for old API</hal_details>
6480 <entry name="pixelArraySize" type="int32" visibility="public"
6481 container="array" typedef="size" hwlevel="legacy">
6485 <description>Dimensions of the full pixel array, possibly
6486 including black calibration pixels.</description>
6487 <units>Pixels</units>
6488 <details>The pixel count of the full pixel array of the image sensor, which covers
6489 android.sensor.info.physicalSize area. This represents the full pixel dimensions of
6490 the raw buffers produced by this sensor.
6492 If a camera device supports raw sensor formats, either this or
6493 android.sensor.info.preCorrectionActiveArraySize is the maximum dimensions for the raw
6494 output formats listed in {@link
6495 android.hardware.camera2.params.StreamConfigurationMap|ACAMERA_SCALER_AVAILABLE_STREAM_CONFIGURATIONS}
6496 (this depends on whether or not the image sensor returns buffers containing pixels that
6497 are not part of the active array region for blacklevel calibration or other purposes).
6499 Some parts of the full pixel array may not receive light from the scene,
6500 or be otherwise inactive. The android.sensor.info.preCorrectionActiveArraySize key
6501 defines the rectangle of active pixels that will be included in processed image
6507 <entry name="whiteLevel" type="int32" visibility="public">
6509 Maximum raw value output by sensor.
6511 <range>&gt; 255 (8-bit output)</range>
6513 This specifies the fully-saturated encoding level for the raw
6514 sample values from the sensor. This is typically caused by the
6515 sensor becoming highly non-linear or clipping. The minimum for
6516 each channel is specified by the offset in the
6517 android.sensor.blackLevelPattern key.
6519 The white level is typically determined either by sensor bit depth
6520 (8-14 bits is expected), or by the point where the sensor response
6521 becomes too non-linear to be useful. The default value for this is
6522 maximum representable value for a 16-bit raw sample (2^16 - 1).
6524 The white level values of captured images may vary for different
6525 capture settings (e.g., android.sensor.sensitivity). This key
6526 represents a coarse approximation for such case. It is recommended
6527 to use android.sensor.dynamicWhiteLevel for captures when supported
6528 by the camera device, which provides more accurate white level values.
6531 The full bit depth of the sensor must be available in the raw data,
6532 so the value for linear sensors should not be significantly lower
6533 than maximum raw value supported, i.e. 2^(sensor bits per pixel).
6537 <entry name="timestampSource" type="byte" visibility="public"
6538 enum="true" hwlevel="legacy">
6542 Timestamps from android.sensor.timestamp are in nanoseconds and monotonic,
6543 but can not be compared to timestamps from other subsystems
6544 (e.g. accelerometer, gyro etc.), or other instances of the same or different
6545 camera devices in the same system. Timestamps between streams and results for
6546 a single camera instance are comparable, and the timestamps for all buffers
6547 and the result metadata generated by a single capture are identical.
6552 Timestamps from android.sensor.timestamp are in the same timebase as
6553 {@link android.os.SystemClock#elapsedRealtimeNanos},
6554 and they can be compared to other timestamps using that base.
6558 <description>The time base source for sensor capture start timestamps.</description>
6560 The timestamps provided for captures are always in nanoseconds and monotonic, but
6561 may not based on a time source that can be compared to other system time sources.
6563 This characteristic defines the source for the timestamps, and therefore whether they
6564 can be compared against other system time sources/timestamps.
6567 For camera devices implement UNKNOWN, the camera framework expects that the timestamp
6568 source to be SYSTEM_TIME_MONOTONIC. For camera devices implement REALTIME, the camera
6569 framework expects that the timestamp source to be SYSTEM_TIME_BOOTTIME. See
6570 system/core/include/utils/Timers.h for the definition of SYSTEM_TIME_MONOTONIC and
6571 SYSTEM_TIME_BOOTTIME. Note that HAL must follow above expectation; otherwise video
6572 recording might suffer unexpected behavior.
6574 Also, camera devices which implement REALTIME must pass the ITS sensor fusion test which
6575 tests the alignment between camera timestamps and gyro sensor timestamps.
6579 <entry name="lensShadingApplied" type="byte" visibility="public" enum="true"
6582 <value>FALSE</value>
6585 <description>Whether the RAW images output from this camera device are subject to
6586 lens shading correction.</description>
6588 If TRUE, all images produced by the camera device in the RAW image formats will
6589 have lens shading correction already applied to it. If FALSE, the images will
6590 not be adjusted for lens shading correction.
6591 See android.request.maxNumOutputRaw for a list of RAW image formats.
6593 This key will be `null` for all devices do not report this information.
6594 Devices with RAW capability will always report this information in this key.
6597 <entry name="preCorrectionActiveArraySize" type="int32" visibility="public"
6598 type_notes="Four ints defining the active pixel rectangle" container="array"
6599 typedef="rectangle" hwlevel="legacy">
6604 The area of the image sensor which corresponds to active pixels prior to the
6605 application of any geometric distortion correction.
6607 <units>Pixel coordinates on the image sensor</units>
6609 This is the rectangle representing the size of the active region of the sensor (i.e.
6610 the region that actually receives light from the scene) before any geometric correction
6611 has been applied, and should be treated as the active region rectangle for any of the
6612 raw formats. All metadata associated with raw processing (e.g. the lens shading
6613 correction map, and radial distortion fields) treats the top, left of this rectangle as
6616 The size of this region determines the maximum field of view and the maximum number of
6617 pixels that an image from this sensor can contain, prior to the application of
6618 geometric distortion correction. The effective maximum pixel dimensions of a
6619 post-distortion-corrected image is given by the android.sensor.info.activeArraySize
6620 field, and the effective maximum field of view for a post-distortion-corrected image
6621 can be calculated by applying the geometric distortion correction fields to this
6622 rectangle, and cropping to the rectangle given in android.sensor.info.activeArraySize.
6624 E.g. to calculate position of a pixel, (x,y), in a processed YUV output image with the
6625 dimensions in android.sensor.info.activeArraySize given the position of a pixel,
6626 (x', y'), in the raw pixel array with dimensions give in
6627 android.sensor.info.pixelArraySize:
6629 1. Choose a pixel (x', y') within the active array region of the raw buffer given in
6630 android.sensor.info.preCorrectionActiveArraySize, otherwise this pixel is considered
6631 to be outside of the FOV, and will not be shown in the processed output image.
6632 1. Apply geometric distortion correction to get the post-distortion pixel coordinate,
6633 (x_i, y_i). When applying geometric correction metadata, note that metadata for raw
6634 buffers is defined relative to the top, left of the
6635 android.sensor.info.preCorrectionActiveArraySize rectangle.
6636 1. If the resulting corrected pixel coordinate is within the region given in
6637 android.sensor.info.activeArraySize, then the position of this pixel in the
6638 processed output image buffer is `(x_i - activeArray.left, y_i - activeArray.top)`,
6639 when the top, left coordinate of that buffer is treated as (0, 0).
6641 Thus, for pixel x',y' = (25, 25) on a sensor where android.sensor.info.pixelArraySize
6642 is (100,100), android.sensor.info.preCorrectionActiveArraySize is (10, 10, 100, 100),
6643 android.sensor.info.activeArraySize is (20, 20, 80, 80), and the geometric distortion
6644 correction doesn't change the pixel coordinate, the resulting pixel selected in
6645 pixel coordinates would be x,y = (25, 25) relative to the top,left of the raw buffer
6646 with dimensions given in android.sensor.info.pixelArraySize, and would be (5, 5)
6647 relative to the top,left of post-processed YUV output buffer with dimensions given in
6648 android.sensor.info.activeArraySize.
6650 The currently supported fields that correct for geometric distortion are:
6652 1. android.lens.radialDistortion.
6654 If all of the geometric distortion fields are no-ops, this rectangle will be the same
6655 as the post-distortion-corrected rectangle given in
6656 android.sensor.info.activeArraySize.
6658 This rectangle is defined relative to the full pixel array; (0,0) is the top-left of
6659 the full pixel array, and the size of the full pixel array is given by
6660 android.sensor.info.pixelArraySize.
6662 The pre-correction active array may be smaller than the full pixel array, since the
6663 full array may include black calibration pixels or other inactive regions.
6666 The data representation is `int[4]`, which maps to `(left, top, width, height)`.
6669 This array contains `(xmin, ymin, width, height)`. The `(xmin, ymin)` must be
6671 The `(width, height)` must be &lt;= `android.sensor.info.pixelArraySize`.
6673 If omitted by the HAL implementation, the camera framework will assume that this is
6674 the same as the post-correction active array region given in
6675 android.sensor.info.activeArraySize.
6680 <entry name="referenceIlluminant1" type="byte" visibility="public"
6683 <value id="1">DAYLIGHT</value>
6684 <value id="2">FLUORESCENT</value>
6685 <value id="3">TUNGSTEN
6686 <notes>Incandescent light</notes>
6688 <value id="4">FLASH</value>
6689 <value id="9">FINE_WEATHER</value>
6690 <value id="10">CLOUDY_WEATHER</value>
6691 <value id="11">SHADE</value>
6692 <value id="12">DAYLIGHT_FLUORESCENT
6693 <notes>D 5700 - 7100K</notes>
6695 <value id="13">DAY_WHITE_FLUORESCENT
6696 <notes>N 4600 - 5400K</notes>
6698 <value id="14">COOL_WHITE_FLUORESCENT
6699 <notes>W 3900 - 4500K</notes>
6701 <value id="15">WHITE_FLUORESCENT
6702 <notes>WW 3200 - 3700K</notes>
6704 <value id="17">STANDARD_A</value>
6705 <value id="18">STANDARD_B</value>
6706 <value id="19">STANDARD_C</value>
6707 <value id="20">D55</value>
6708 <value id="21">D65</value>
6709 <value id="22">D75</value>
6710 <value id="23">D50</value>
6711 <value id="24">ISO_STUDIO_TUNGSTEN</value>
6714 The standard reference illuminant used as the scene light source when
6715 calculating the android.sensor.colorTransform1,
6716 android.sensor.calibrationTransform1, and
6717 android.sensor.forwardMatrix1 matrices.
6720 The values in this key correspond to the values defined for the
6721 EXIF LightSource tag. These illuminants are standard light sources
6722 that are often used calibrating camera devices.
6724 If this key is present, then android.sensor.colorTransform1,
6725 android.sensor.calibrationTransform1, and
6726 android.sensor.forwardMatrix1 will also be present.
6728 Some devices may choose to provide a second set of calibration
6729 information for improved quality, including
6730 android.sensor.referenceIlluminant2 and its corresponding matrices.
6733 The first reference illuminant (android.sensor.referenceIlluminant1)
6734 and corresponding matrices must be present to support the RAW capability
6737 When producing raw images with a color profile that has only been
6738 calibrated against a single light source, it is valid to omit
6739 android.sensor.referenceIlluminant2 along with the
6740 android.sensor.colorTransform2, android.sensor.calibrationTransform2,
6741 and android.sensor.forwardMatrix2 matrices.
6743 If only android.sensor.referenceIlluminant1 is included, it should be
6744 chosen so that it is representative of typical scene lighting. In
6745 general, D50 or DAYLIGHT will be chosen for this case.
6747 If both android.sensor.referenceIlluminant1 and
6748 android.sensor.referenceIlluminant2 are included, they should be
6749 chosen to represent the typical range of scene lighting conditions.
6750 In general, low color temperature illuminant such as Standard-A will
6751 be chosen for the first reference illuminant and a higher color
6752 temperature illuminant such as D65 will be chosen for the second
6753 reference illuminant.
6757 <entry name="referenceIlluminant2" type="byte" visibility="public">
6759 The standard reference illuminant used as the scene light source when
6760 calculating the android.sensor.colorTransform2,
6761 android.sensor.calibrationTransform2, and
6762 android.sensor.forwardMatrix2 matrices.
6764 <range>Any value listed in android.sensor.referenceIlluminant1</range>
6766 See android.sensor.referenceIlluminant1 for more details.
6768 If this key is present, then android.sensor.colorTransform2,
6769 android.sensor.calibrationTransform2, and
6770 android.sensor.forwardMatrix2 will also be present.
6774 <entry name="calibrationTransform1" type="rational"
6775 visibility="public" optional="true"
6776 type_notes="3x3 matrix in row-major-order" container="array"
6777 typedef="colorSpaceTransform">
6783 A per-device calibration transform matrix that maps from the
6784 reference sensor colorspace to the actual device sensor colorspace.
6787 This matrix is used to correct for per-device variations in the
6788 sensor colorspace, and is used for processing raw buffer data.
6790 The matrix is expressed as a 3x3 matrix in row-major-order, and
6791 contains a per-device calibration transform that maps colors
6792 from reference sensor color space (i.e. the "golden module"
6793 colorspace) into this camera device's native sensor color
6794 space under the first reference illuminant
6795 (android.sensor.referenceIlluminant1).
6799 <entry name="calibrationTransform2" type="rational"
6800 visibility="public" optional="true"
6801 type_notes="3x3 matrix in row-major-order" container="array"
6802 typedef="colorSpaceTransform">
6808 A per-device calibration transform matrix that maps from the
6809 reference sensor colorspace to the actual device sensor colorspace
6810 (this is the colorspace of the raw buffer data).
6813 This matrix is used to correct for per-device variations in the
6814 sensor colorspace, and is used for processing raw buffer data.
6816 The matrix is expressed as a 3x3 matrix in row-major-order, and
6817 contains a per-device calibration transform that maps colors
6818 from reference sensor color space (i.e. the "golden module"
6819 colorspace) into this camera device's native sensor color
6820 space under the second reference illuminant
6821 (android.sensor.referenceIlluminant2).
6823 This matrix will only be present if the second reference
6824 illuminant is present.
6828 <entry name="colorTransform1" type="rational"
6829 visibility="public" optional="true"
6830 type_notes="3x3 matrix in row-major-order" container="array"
6831 typedef="colorSpaceTransform">
6837 A matrix that transforms color values from CIE XYZ color space to
6838 reference sensor color space.
6841 This matrix is used to convert from the standard CIE XYZ color
6842 space to the reference sensor colorspace, and is used when processing
6845 The matrix is expressed as a 3x3 matrix in row-major-order, and
6846 contains a color transform matrix that maps colors from the CIE
6847 XYZ color space to the reference sensor color space (i.e. the
6848 "golden module" colorspace) under the first reference illuminant
6849 (android.sensor.referenceIlluminant1).
6851 The white points chosen in both the reference sensor color space
6852 and the CIE XYZ colorspace when calculating this transform will
6853 match the standard white point for the first reference illuminant
6854 (i.e. no chromatic adaptation will be applied by this transform).
6858 <entry name="colorTransform2" type="rational"
6859 visibility="public" optional="true"
6860 type_notes="3x3 matrix in row-major-order" container="array"
6861 typedef="colorSpaceTransform">
6867 A matrix that transforms color values from CIE XYZ color space to
6868 reference sensor color space.
6871 This matrix is used to convert from the standard CIE XYZ color
6872 space to the reference sensor colorspace, and is used when processing
6875 The matrix is expressed as a 3x3 matrix in row-major-order, and
6876 contains a color transform matrix that maps colors from the CIE
6877 XYZ color space to the reference sensor color space (i.e. the
6878 "golden module" colorspace) under the second reference illuminant
6879 (android.sensor.referenceIlluminant2).
6881 The white points chosen in both the reference sensor color space
6882 and the CIE XYZ colorspace when calculating this transform will
6883 match the standard white point for the second reference illuminant
6884 (i.e. no chromatic adaptation will be applied by this transform).
6886 This matrix will only be present if the second reference
6887 illuminant is present.
6891 <entry name="forwardMatrix1" type="rational"
6892 visibility="public" optional="true"
6893 type_notes="3x3 matrix in row-major-order" container="array"
6894 typedef="colorSpaceTransform">
6900 A matrix that transforms white balanced camera colors from the reference
6901 sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.
6904 This matrix is used to convert to the standard CIE XYZ colorspace, and
6905 is used when processing raw buffer data.
6907 This matrix is expressed as a 3x3 matrix in row-major-order, and contains
6908 a color transform matrix that maps white balanced colors from the
6909 reference sensor color space to the CIE XYZ color space with a D50 white
6912 Under the first reference illuminant (android.sensor.referenceIlluminant1)
6913 this matrix is chosen so that the standard white point for this reference
6914 illuminant in the reference sensor colorspace is mapped to D50 in the
6919 <entry name="forwardMatrix2" type="rational"
6920 visibility="public" optional="true"
6921 type_notes="3x3 matrix in row-major-order" container="array"
6922 typedef="colorSpaceTransform">
6928 A matrix that transforms white balanced camera colors from the reference
6929 sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.
6932 This matrix is used to convert to the standard CIE XYZ colorspace, and
6933 is used when processing raw buffer data.
6935 This matrix is expressed as a 3x3 matrix in row-major-order, and contains
6936 a color transform matrix that maps white balanced colors from the
6937 reference sensor color space to the CIE XYZ color space with a D50 white
6940 Under the second reference illuminant (android.sensor.referenceIlluminant2)
6941 this matrix is chosen so that the standard white point for this reference
6942 illuminant in the reference sensor colorspace is mapped to D50 in the
6945 This matrix will only be present if the second reference
6946 illuminant is present.
6950 <entry name="baseGainFactor" type="rational"
6952 <description>Gain factor from electrons to raw units when
6953 ISO=100</description>
6956 <entry name="blackLevelPattern" type="int32" visibility="public"
6957 optional="true" type_notes="2x2 raw count block" container="array"
6958 typedef="blackLevelPattern">
6963 A fixed black level offset for each of the color filter arrangement
6964 (CFA) mosaic channels.
6966 <range>&gt;= 0 for each.</range>
6968 This key specifies the zero light value for each of the CFA mosaic
6969 channels in the camera sensor. The maximal value output by the
6970 sensor is represented by the value in android.sensor.info.whiteLevel.
6972 The values are given in the same order as channels listed for the CFA
6973 layout key (see android.sensor.info.colorFilterArrangement), i.e. the
6974 nth value given corresponds to the black level offset for the nth
6975 color channel listed in the CFA.
6977 The black level values of captured images may vary for different
6978 capture settings (e.g., android.sensor.sensitivity). This key
6979 represents a coarse approximation for such case. It is recommended to
6980 use android.sensor.dynamicBlackLevel or use pixels from
6981 android.sensor.opticalBlackRegions directly for captures when
6982 supported by the camera device, which provides more accurate black
6983 level values. For raw capture in particular, it is recommended to use
6984 pixels from android.sensor.opticalBlackRegions to calculate black
6985 level values for each frame.
6988 The values are given in row-column scan order, with the first value
6989 corresponding to the element of the CFA in row=0, column=0.
6993 <entry name="maxAnalogSensitivity" type="int32" visibility="public"
6994 optional="true" hwlevel="full">
6995 <description>Maximum sensitivity that is implemented
6996 purely through analog gain.</description>
6997 <details>For android.sensor.sensitivity values less than or
6998 equal to this, all applied gain must be analog. For
6999 values above this, the gain applied can be a mix of analog and
7004 <entry name="orientation" type="int32" visibility="public"
7006 <description>Clockwise angle through which the output image needs to be rotated to be
7007 upright on the device screen in its native orientation.
7009 <units>Degrees of clockwise rotation; always a multiple of
7011 <range>0, 90, 180, 270</range>
7013 Also defines the direction of rolling shutter readout, which is from top to bottom in
7014 the sensor's coordinate system.
7018 <entry name="profileHueSatMapDimensions" type="int32"
7019 visibility="system" optional="true"
7020 type_notes="Number of samples for hue, saturation, and value"
7026 The number of input samples for each dimension of
7027 android.sensor.profileHueSatMap.
7031 Saturation &gt;= 2,
7035 The number of input samples for the hue, saturation, and value
7036 dimension of android.sensor.profileHueSatMap. The order of the
7037 dimensions given is hue, saturation, value; where hue is the 0th
7044 <clone entry="android.sensor.exposureTime" kind="controls">
7046 <clone entry="android.sensor.frameDuration"
7047 kind="controls"></clone>
7048 <clone entry="android.sensor.sensitivity" kind="controls">
7050 <entry name="timestamp" type="int64" visibility="public"
7052 <description>Time at start of exposure of first
7053 row of the image sensor active array, in nanoseconds.</description>
7054 <units>Nanoseconds</units>
7055 <range>&gt; 0</range>
7056 <details>The timestamps are also included in all image
7057 buffers produced for the same capture, and will be identical
7060 When android.sensor.info.timestampSource `==` UNKNOWN,
7061 the timestamps measure time since an unspecified starting point,
7062 and are monotonically increasing. They can be compared with the
7063 timestamps for other captures from the same camera device, but are
7064 not guaranteed to be comparable to any other time source.
7066 When android.sensor.info.timestampSource `==` REALTIME, the
7067 timestamps measure time in the same timebase as {@link
7068 android.os.SystemClock#elapsedRealtimeNanos}, and they can
7069 be compared to other timestamps from other subsystems that
7070 are using that base.
7072 For reprocessing, the timestamp will match the start of exposure of
7073 the input image, i.e. {@link CaptureResult#SENSOR_TIMESTAMP the
7074 timestamp} in the TotalCaptureResult that was used to create the
7075 reprocess capture request.
7078 All timestamps must be in reference to the kernel's
7079 CLOCK_BOOTTIME monotonic clock, which properly accounts for
7080 time spent asleep. This allows for synchronization with
7081 sensors that continue to operate while the system is
7084 If android.sensor.info.timestampSource `==` REALTIME,
7085 The timestamp must be synchronized with the timestamps from other
7086 sensor subsystems that are using the same timebase.
7088 For reprocessing, the input image's start of exposure can be looked up
7089 with android.sensor.timestamp from the metadata included in the
7094 <entry name="temperature" type="float"
7096 <description>The temperature of the sensor, sampled at the time
7097 exposure began for this frame.
7099 The thermal diode being queried should be inside the sensor PCB, or
7100 somewhere close to it.
7103 <units>Celsius</units>
7104 <range>Optional. This value is missing if no temperature is available.</range>
7107 <entry name="neutralColorPoint" type="rational" visibility="public"
7108 optional="true" container="array">
7113 The estimated camera neutral color in the native sensor colorspace at
7114 the time of capture.
7117 This value gives the neutral color point encoded as an RGB value in the
7118 native sensor color space. The neutral color point indicates the
7119 currently estimated white point of the scene illumination. It can be
7120 used to interpolate between the provided color transforms when
7121 processing raw sensor data.
7123 The order of the values is R, G, B; where R is in the lowest index.
7127 <entry name="noiseProfile" type="double" visibility="public"
7128 optional="true" type_notes="Pairs of noise model coefficients"
7129 container="array" typedef="pairDoubleDouble">
7132 <size>CFA Channels</size>
7135 Noise model coefficients for each CFA mosaic channel.
7138 This key contains two noise model coefficients for each CFA channel
7139 corresponding to the sensor amplification (S) and sensor readout
7140 noise (O). These are given as pairs of coefficients for each channel
7141 in the same order as channels listed for the CFA layout key
7142 (see android.sensor.info.colorFilterArrangement). This is
7143 represented as an array of Pair&lt;Double, Double&gt;, where
7144 the first member of the Pair at index n is the S coefficient and the
7145 second member is the O coefficient for the nth color channel in the CFA.
7147 These coefficients are used in a two parameter noise model to describe
7148 the amount of noise present in the image for each CFA channel. The
7149 noise model used here is:
7153 Where x represents the recorded signal of a CFA channel normalized to
7154 the range [0, 1], and S and O are the noise model coeffiecients for
7157 A more detailed description of the noise model can be found in the
7158 Adobe DNG specification for the NoiseProfile tag.
7161 For a CFA layout of RGGB, the list of coefficients would be given as
7162 an array of doubles S0,O0,S1,O1,..., where S0 and O0 are the coefficients
7163 for the red channel, S1 and O1 are the coefficients for the first green
7168 <entry name="profileHueSatMap" type="float"
7169 visibility="system" optional="true"
7170 type_notes="Mapping for hue, saturation, and value"
7173 <size>hue_samples</size>
7174 <size>saturation_samples</size>
7175 <size>value_samples</size>
7179 A mapping containing a hue shift, saturation scale, and value scale
7183 The hue shift is given in degrees; saturation and value scale factors are
7184 unitless and are between 0 and 1 inclusive
7187 hue_samples, saturation_samples, and value_samples are given in
7188 android.sensor.profileHueSatMapDimensions.
7190 Each entry of this map contains three floats corresponding to the
7191 hue shift, saturation scale, and value scale, respectively; where the
7192 hue shift has the lowest index. The map entries are stored in the key
7193 in nested loop order, with the value divisions in the outer loop, the
7194 hue divisions in the middle loop, and the saturation divisions in the
7195 inner loop. All zero input saturation entries are required to have a
7196 value scale factor of 1.0.
7200 <entry name="profileToneCurve" type="float"
7201 visibility="system" optional="true"
7202 type_notes="Samples defining a spline for a tone-mapping curve"
7205 <size>samples</size>
7209 A list of x,y samples defining a tone-mapping curve for gamma adjustment.
7212 Each sample has an input range of `[0, 1]` and an output range of
7213 `[0, 1]`. The first sample is required to be `(0, 0)`, and the last
7214 sample is required to be `(1, 1)`.
7217 This key contains a default tone curve that can be applied while
7218 processing the image as a starting point for user adjustments.
7219 The curve is specified as a list of value pairs in linear gamma.
7220 The curve is interpolated using a cubic spline.
7224 <entry name="greenSplit" type="float" visibility="public" optional="true">
7226 The worst-case divergence between Bayer green channels.
7232 This value is an estimate of the worst case split between the
7233 Bayer green channels in the red and blue rows in the sensor color
7236 The green split is calculated as follows:
7238 1. A 5x5 pixel (or larger) window W within the active sensor array is
7239 chosen. The term 'pixel' here is taken to mean a group of 4 Bayer
7240 mosaic channels (R, Gr, Gb, B). The location and size of the window
7241 chosen is implementation defined, and should be chosen to provide a
7242 green split estimate that is both representative of the entire image
7243 for this camera sensor, and can be calculated quickly.
7244 1. The arithmetic mean of the green channels from the red
7245 rows (mean_Gr) within W is computed.
7246 1. The arithmetic mean of the green channels from the blue
7247 rows (mean_Gb) within W is computed.
7248 1. The maximum ratio R of the two means is computed as follows:
7249 `R = max((mean_Gr + 1)/(mean_Gb + 1), (mean_Gb + 1)/(mean_Gr + 1))`
7251 The ratio R is the green split divergence reported for this property,
7252 which represents how much the green channels differ in the mosaic
7253 pattern. This value is typically used to determine the treatment of
7254 the green mosaic channels when demosaicing.
7256 The green split value can be roughly interpreted as follows:
7258 * R &lt; 1.03 is a negligible split (&lt;3% divergence).
7259 * 1.20 &lt;= R &gt;= 1.03 will require some software
7260 correction to avoid demosaic errors (3-20% divergence).
7261 * R &gt; 1.20 will require strong software correction to produce
7262 a usuable image (&gt;20% divergence).
7265 The green split given may be a static value based on prior
7266 characterization of the camera sensor using the green split
7267 calculation method given here over a large, representative, sample
7268 set of images. Other methods of calculation that produce equivalent
7269 results, and can be interpreted in the same manner, may be used.
7275 <entry name="testPatternData" type="int32" visibility="public" optional="true" container="array">
7280 A pixel `[R, G_even, G_odd, B]` that supplies the test pattern
7281 when android.sensor.testPatternMode is SOLID_COLOR.
7284 Each color channel is treated as an unsigned 32-bit integer.
7285 The camera device then uses the most significant X bits
7286 that correspond to how many bits are in its Bayer raw sensor
7289 For example, a sensor with RAW10 Bayer output would use the
7290 10 most significant bits from each color channel.
7295 <entry name="testPatternMode" type="int32" visibility="public" optional="true"
7299 <notes>No test pattern mode is used, and the camera
7300 device returns captures from the image sensor.
7302 This is the default if the key is not set.</notes>
7306 Each pixel in `[R, G_even, G_odd, B]` is replaced by its
7307 respective color channel provided in
7308 android.sensor.testPatternData.
7312 android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]
7314 All green pixels are 100% green. All red/blue pixels are black.
7316 android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]
7318 All red pixels are 100% red. Only the odd green pixels
7319 are 100% green. All blue pixels are 100% black.
7324 All pixel data is replaced with an 8-bar color pattern.
7326 The vertical bars (left-to-right) are as follows:
7337 In general the image would look like the following:
7348 (B = Blue, K = Black)
7350 Each bar should take up 1/8 of the sensor pixel array width.
7351 When this is not possible, the bar size should be rounded
7352 down to the nearest integer and the pattern can repeat
7355 Each bar's height must always take up the full sensor
7358 Each pixel in this test pattern must be set to either
7359 0% intensity or 100% intensity.
7362 <value>COLOR_BARS_FADE_TO_GRAY
7364 The test pattern is similar to COLOR_BARS, except that
7365 each bar should start at its specified color at the top,
7366 and fade to gray at the bottom.
7368 Furthermore each bar is further subdivided into a left and
7369 right half. The left half should have a smooth gradient,
7370 and the right half should have a quantized gradient.
7372 In particular, the right half's should consist of blocks of the
7373 same color for 1/16th active sensor pixel array width.
7375 The least significant bits in the quantized gradient should
7376 be copied from the most significant bits of the smooth gradient.
7378 The height of each bar should always be a multiple of 128.
7379 When this is not the case, the pattern should repeat at the bottom
7385 All pixel data is replaced by a pseudo-random sequence
7386 generated from a PN9 512-bit sequence (typically implemented
7387 in hardware with a linear feedback shift register).
7389 The generator should be reset at the beginning of each frame,
7390 and thus each subsequent raw frame with this test pattern should
7391 be exactly the same as the last.
7394 <value id="256">CUSTOM1
7395 <notes>The first custom test pattern. All custom patterns that are
7396 available only on this camera device are at least this numeric
7399 All of the custom test patterns will be static
7400 (that is the raw image must not vary from frame to frame).
7404 <description>When enabled, the sensor sends a test pattern instead of
7405 doing a real exposure from the camera.
7407 <range>android.sensor.availableTestPatternModes</range>
7409 When a test pattern is enabled, all manual sensor controls specified
7410 by android.sensor.* will be ignored. All other controls should
7413 For example, if manual flash is enabled, flash firing should still
7414 occur (and that the test pattern remain unmodified, since the flash
7415 would not actually affect it).
7420 All test patterns are specified in the Bayer domain.
7422 The HAL may choose to substitute test patterns from the sensor
7423 with test patterns from on-device memory. In that case, it should be
7424 indistinguishable to the ISP whether the data came from the
7425 sensor interconnect bus (such as CSI2) or memory.
7430 <clone entry="android.sensor.testPatternData" kind="controls">
7432 <clone entry="android.sensor.testPatternMode" kind="controls">
7436 <entry name="availableTestPatternModes" type="int32" visibility="public" optional="true"
7437 type_notes="list of enums" container="array">
7441 <description>List of sensor test pattern modes for android.sensor.testPatternMode
7442 supported by this camera device.
7444 <range>Any value listed in android.sensor.testPatternMode</range>
7446 Defaults to OFF, and always includes OFF if defined.
7449 All custom modes must be >= CUSTOM1.
7454 <entry name="rollingShutterSkew" type="int64" visibility="public" hwlevel="limited">
7455 <description>Duration between the start of first row exposure
7456 and the start of last row exposure.</description>
7457 <units>Nanoseconds</units>
7458 <range> &gt;= 0 and &lt;
7459 {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration}.</range>
7461 This is the exposure time skew between the first and last
7462 row exposure start times. The first row and the last row are
7463 the first and last rows inside of the
7464 android.sensor.info.activeArraySize.
7466 For typical camera sensors that use rolling shutters, this is also equivalent
7467 to the frame readout time.
7470 The HAL must report `0` if the sensor is using global shutter, where all pixels begin
7471 exposure at the same time.
7477 <entry name="opticalBlackRegions" type="int32" visibility="public" optional="true"
7478 container="array" typedef="rectangle">
7481 <size>num_regions</size>
7483 <description>List of disjoint rectangles indicating the sensor
7484 optically shielded black pixel regions.
7487 In most camera sensors, the active array is surrounded by some
7488 optically shielded pixel areas. By blocking light, these pixels
7489 provides a reliable black reference for black level compensation
7490 in active array region.
7492 This key provides a list of disjoint rectangles specifying the
7493 regions of optically shielded (with metal shield) black pixel
7494 regions if the camera device is capable of reading out these black
7495 pixels in the output raw images. In comparison to the fixed black
7496 level values reported by android.sensor.blackLevelPattern, this key
7497 may provide a more accurate way for the application to calculate
7498 black level of each captured raw images.
7500 When this key is reported, the android.sensor.dynamicBlackLevel and
7501 android.sensor.dynamicWhiteLevel will also be reported.
7504 The data representation is `int[4]`, which maps to `(left, top, width, height)`.
7507 This array contains (xmin, ymin, width, height). The (xmin, ymin)
7508 must be &gt;= (0,0) and &lt;=
7509 android.sensor.info.pixelArraySize. The (width, height) must be
7510 &lt;= android.sensor.info.pixelArraySize. Each region must be
7511 outside the region reported by
7512 android.sensor.info.preCorrectionActiveArraySize.
7514 The HAL must report minimal number of disjoint regions for the
7515 optically shielded back pixel regions. For example, if a region can
7516 be covered by one rectangle, the HAL must not split this region into
7517 multiple rectangles.
7522 <entry name="dynamicBlackLevel" type="float" visibility="public"
7523 optional="true" type_notes="2x2 raw count block" container="array">
7528 A per-frame dynamic black level offset for each of the color filter
7529 arrangement (CFA) mosaic channels.
7531 <range>&gt;= 0 for each.</range>
7533 Camera sensor black levels may vary dramatically for different
7534 capture settings (e.g. android.sensor.sensitivity). The fixed black
7535 level reported by android.sensor.blackLevelPattern may be too
7536 inaccurate to represent the actual value on a per-frame basis. The
7537 camera device internal pipeline relies on reliable black level values
7538 to process the raw images appropriately. To get the best image
7539 quality, the camera device may choose to estimate the per frame black
7540 level values either based on optically shielded black regions
7541 (android.sensor.opticalBlackRegions) or its internal model.
7543 This key reports the camera device estimated per-frame zero light
7544 value for each of the CFA mosaic channels in the camera sensor. The
7545 android.sensor.blackLevelPattern may only represent a coarse
7546 approximation of the actual black level values. This value is the
7547 black level used in camera device internal image processing pipeline
7548 and generally more accurate than the fixed black level values.
7549 However, since they are estimated values by the camera device, they
7550 may not be as accurate as the black level values calculated from the
7551 optical black pixels reported by android.sensor.opticalBlackRegions.
7553 The values are given in the same order as channels listed for the CFA
7554 layout key (see android.sensor.info.colorFilterArrangement), i.e. the
7555 nth value given corresponds to the black level offset for the nth
7556 color channel listed in the CFA.
7558 This key will be available if android.sensor.opticalBlackRegions is available or the
7559 camera device advertises this key via {@link
7560 android.hardware.camera2.CameraCharacteristics#getAvailableCaptureResultKeys|ACAMERA_REQUEST_AVAILABLE_RESULT_KEYS}.
7563 The values are given in row-column scan order, with the first value
7564 corresponding to the element of the CFA in row=0, column=0.
7568 <entry name="dynamicWhiteLevel" type="int32" visibility="public"
7571 Maximum raw value output by sensor for this frame.
7573 <range> &gt;= 0</range>
7575 Since the android.sensor.blackLevelPattern may change for different
7576 capture settings (e.g., android.sensor.sensitivity), the white
7577 level will change accordingly. This key is similar to
7578 android.sensor.info.whiteLevel, but specifies the camera device
7579 estimated white level for each frame.
7581 This key will be available if android.sensor.opticalBlackRegions is
7582 available or the camera device advertises this key via
7583 {@link android.hardware.camera2.CameraCharacteristics#getAvailableCaptureRequestKeys|ACAMERA_REQUEST_AVAILABLE_RESULT_KEYS}.
7586 The full bit depth of the sensor must be available in the raw data,
7587 so the value for linear sensors should not be significantly lower
7588 than maximum raw value supported, i.e. 2^(sensor bits per pixel).
7594 <entry name="opaqueRawSize" type="int32" visibility="system" container="array">
7599 <description>Size in bytes for all the listed opaque RAW buffer sizes</description>
7600 <range>Must be large enough to fit the opaque RAW of corresponding size produced by
7603 This configurations are listed as `(width, height, size_in_bytes)` tuples.
7604 This is used for sizing the gralloc buffers for opaque RAW buffers.
7605 All RAW_OPAQUE output stream configuration listed in
7606 android.scaler.availableStreamConfigurations will have a corresponding tuple in
7610 This key is added in legacy HAL3.4.
7612 For legacy HAL3.4 or above: devices advertising RAW_OPAQUE format output must list this
7613 key. For legacy HAL3.3 or earlier devices: if RAW_OPAQUE ouput is advertised, camera
7614 framework will derive this key by assuming each pixel takes two bytes and no padding bytes
7620 <section name="shading">
7622 <entry name="mode" type="byte" visibility="public" enum="true" hwlevel="full">
7625 <notes>No lens shading correction is applied.</notes></value>
7627 <notes>Apply lens shading corrections, without slowing
7628 frame rate relative to sensor raw output</notes></value>
7630 <notes>Apply high-quality lens shading correction, at the
7631 cost of possibly reduced frame rate.</notes></value>
7633 <description>Quality of lens shading correction applied
7634 to the image data.</description>
7635 <range>android.shading.availableModes</range>
7637 When set to OFF mode, no lens shading correction will be applied by the
7638 camera device, and an identity lens shading map data will be provided
7639 if `android.statistics.lensShadingMapMode == ON`. For example, for lens
7640 shading map with size of `[ 4, 3 ]`,
7641 the output android.statistics.lensShadingCorrectionMap for this case will be an identity
7644 [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
7645 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
7646 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
7647 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
7648 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
7649 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]
7651 When set to other modes, lens shading correction will be applied by the camera
7652 device. Applications can request lens shading map data by setting
7653 android.statistics.lensShadingMapMode to ON, and then the camera device will provide lens
7654 shading map data in android.statistics.lensShadingCorrectionMap; the returned shading map
7655 data will be the one applied by the camera device for this capture request.
7657 The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore
7658 the reliability of the map data may be affected by the AE and AWB algorithms. When AE and
7659 AWB are in AUTO modes(android.control.aeMode `!=` OFF and android.control.awbMode `!=`
7660 OFF), to get best results, it is recommended that the applications wait for the AE and AWB
7661 to be converged before using the returned shading map data.
7664 <entry name="strength" type="byte">
7665 <description>Control the amount of shading correction
7666 applied to the images</description>
7667 <units>unitless: 1-10; 10 is full shading
7668 compensation</units>
7673 <clone entry="android.shading.mode" kind="controls">
7677 <entry name="availableModes" type="byte" visibility="public"
7678 type_notes="List of enums (android.shading.mode)." container="array"
7679 typedef="enumList" hwlevel="legacy">
7684 List of lens shading modes for android.shading.mode that are supported by this camera device.
7686 <range>Any value listed in android.shading.mode</range>
7688 This list contains lens shading modes that can be set for the camera device.
7689 Camera devices that support the MANUAL_POST_PROCESSING capability will always
7690 list OFF and FAST mode. This includes all FULL level devices.
7691 LEGACY devices will always only support FAST mode.
7694 HAL must support both FAST and HIGH_QUALITY if lens shading correction control is
7695 available on the camera device, but the underlying implementation can be the same for
7696 both modes. That is, if the highest quality implementation on the camera device does not
7697 slow down capture rate, then FAST and HIGH_QUALITY will generate the same output.
7702 <section name="statistics">
7704 <entry name="faceDetectMode" type="byte" visibility="public" enum="true"
7708 <notes>Do not include face detection statistics in capture
7709 results.</notes></value>
7710 <value optional="true">SIMPLE
7711 <notes>Return face rectangle and confidence values only.
7713 <value optional="true">FULL
7714 <notes>Return all face
7717 In this mode, face rectangles, scores, landmarks, and face IDs are all valid.
7720 <description>Operating mode for the face detector
7722 <range>android.statistics.info.availableFaceDetectModes</range>
7723 <details>Whether face detection is enabled, and whether it
7724 should output just the basic fields or the full set of
7727 SIMPLE mode must fill in android.statistics.faceRectangles and
7728 android.statistics.faceScores.
7729 FULL mode must also fill in android.statistics.faceIds, and
7730 android.statistics.faceLandmarks.
7734 <entry name="histogramMode" type="byte" enum="true" typedef="boolean">
7739 <description>Operating mode for histogram
7740 generation</description>
7743 <entry name="sharpnessMapMode" type="byte" enum="true" typedef="boolean">
7748 <description>Operating mode for sharpness map
7749 generation</description>
7752 <entry name="hotPixelMapMode" type="byte" visibility="public" enum="true"
7756 <notes>Hot pixel map production is disabled.
7759 <notes>Hot pixel map production is enabled.
7763 Operating mode for hot pixel map generation.
7765 <range>android.statistics.info.availableHotPixelMapModes</range>
7767 If set to `true`, a hot pixel map is returned in android.statistics.hotPixelMap.
7768 If set to `false`, no hot pixel map will be returned.
7775 <namespace name="info">
7776 <entry name="availableFaceDetectModes" type="byte"
7778 type_notes="List of enums from android.statistics.faceDetectMode"
7785 <description>List of face detection modes for android.statistics.faceDetectMode that are
7786 supported by this camera device.
7788 <range>Any value listed in android.statistics.faceDetectMode</range>
7789 <details>OFF is always supported.
7792 <entry name="histogramBucketCount" type="int32">
7793 <description>Number of histogram buckets
7794 supported</description>
7795 <range>&gt;= 64</range>
7798 <entry name="maxFaceCount" type="int32" visibility="public" hwlevel="legacy">
7799 <description>The maximum number of simultaneously detectable
7800 faces.</description>
7801 <range>0 for cameras without available face detection; otherwise:
7802 `>=4` for LIMITED or FULL hwlevel devices or
7803 `>0` for LEGACY devices.</range>
7806 <entry name="maxHistogramCount" type="int32">
7807 <description>Maximum value possible for a histogram
7808 bucket</description>
7811 <entry name="maxSharpnessMapValue" type="int32">
7812 <description>Maximum value possible for a sharpness map
7813 region.</description>
7816 <entry name="sharpnessMapSize" type="int32"
7817 type_notes="width x height" container="array" typedef="size">
7821 <description>Dimensions of the sharpness
7823 <range>Must be at least 32 x 32</range>
7826 <entry name="availableHotPixelMapModes" type="byte" visibility="public"
7827 type_notes="list of enums" container="array" typedef="boolean">
7832 List of hot pixel map output modes for android.statistics.hotPixelMapMode that are
7833 supported by this camera device.
7835 <range>Any value listed in android.statistics.hotPixelMapMode</range>
7837 If no hotpixel map output is available for this camera device, this will contain only
7840 ON is always supported on devices with the RAW capability.
7845 <entry name="availableLensShadingMapModes" type="byte" visibility="public"
7846 type_notes="list of enums" container="array" typedef="enumList">
7851 List of lens shading map output modes for android.statistics.lensShadingMapMode that
7852 are supported by this camera device.
7854 <range>Any value listed in android.statistics.lensShadingMapMode</range>
7856 If no lens shading map output is available for this camera device, this key will
7859 ON is always supported on devices with the RAW capability.
7860 LEGACY mode devices will always only support OFF.
7863 <entry name="availableOisDataModes" type="byte" visibility="public"
7864 type_notes="list of enums" container="array" typedef="enumList" hal_version="3.3">
7869 List of OIS data output modes for android.statistics.oisDataMode that
7870 are supported by this camera device.
7872 <range>Any value listed in android.statistics.oisDataMode</range>
7874 If no OIS data output is available for this camera device, this key will
7881 <clone entry="android.statistics.faceDetectMode"
7882 kind="controls"></clone>
7883 <entry name="faceIds" type="int32" visibility="ndk_public"
7884 container="array" hwlevel="legacy">
7888 <description>List of unique IDs for detected faces.</description>
7890 Each detected face is given a unique ID that is valid for as long as the face is visible
7891 to the camera device. A face that leaves the field of view and later returns may be
7894 Only available if android.statistics.faceDetectMode == FULL</details>
7897 <entry name="faceLandmarks" type="int32" visibility="ndk_public"
7898 type_notes="(leftEyeX, leftEyeY, rightEyeX, rightEyeY, mouthX, mouthY)"
7899 container="array" hwlevel="legacy">
7904 <description>List of landmarks for detected
7905 faces.</description>
7907 The coordinate system is that of android.sensor.info.activeArraySize, with
7908 `(0, 0)` being the top-left pixel of the active array.
7910 Only available if android.statistics.faceDetectMode == FULL</details>
7913 <entry name="faceRectangles" type="int32" visibility="ndk_public"
7914 type_notes="(xmin, ymin, xmax, ymax). (0,0) is top-left of active pixel area"
7915 container="array" typedef="rectangle" hwlevel="legacy">
7920 <description>List of the bounding rectangles for detected
7921 faces.</description>
7923 The coordinate system is that of android.sensor.info.activeArraySize, with
7924 `(0, 0)` being the top-left pixel of the active array.
7926 Only available if android.statistics.faceDetectMode != OFF</details>
7928 The data representation is `int[4]`, which maps to `(left, top, width, height)`.
7932 <entry name="faceScores" type="byte" visibility="ndk_public"
7933 container="array" hwlevel="legacy">
7937 <description>List of the face confidence scores for
7938 detected faces</description>
7939 <range>1-100</range>
7940 <details>Only available if android.statistics.faceDetectMode != OFF.
7943 The value should be meaningful (for example, setting 100 at
7944 all times is illegal).</hal_details>
7947 <entry name="faces" type="int32" visibility="java_public" synthetic="true"
7948 container="array" typedef="face" hwlevel="legacy">
7952 <description>List of the faces detected through camera face detection
7953 in this capture.</description>
7955 Only available if android.statistics.faceDetectMode `!=` OFF.
7958 <entry name="histogram" type="int32"
7959 type_notes="count of pixels for each color channel that fall into each histogram bucket, scaled to be between 0 and maxHistogramCount"
7965 <description>A 3-channel histogram based on the raw
7966 sensor data</description>
7967 <details>The k'th bucket (0-based) covers the input range
7968 (with w = android.sensor.info.whiteLevel) of [ k * w/N,
7969 (k + 1) * w / N ). If only a monochrome sharpness map is
7970 supported, all channels should have the same data</details>
7973 <clone entry="android.statistics.histogramMode"
7974 kind="controls"></clone>
7975 <entry name="sharpnessMap" type="int32"
7976 type_notes="estimated sharpness for each region of the input image. Normalized to be between 0 and maxSharpnessMapValue. Higher values mean sharper (better focused)"
7983 <description>A 3-channel sharpness map, based on the raw
7984 sensor data</description>
7985 <details>If only a monochrome sharpness map is supported,
7986 all channels should have the same data</details>
7989 <clone entry="android.statistics.sharpnessMapMode"
7990 kind="controls"></clone>
7991 <entry name="lensShadingCorrectionMap" type="byte" visibility="java_public"
7992 typedef="lensShadingMap" hwlevel="full">
7993 <description>The shading map is a low-resolution floating-point map
7994 that lists the coefficients used to correct for vignetting, for each
7995 Bayer color channel.</description>
7996 <range>Each gain factor is &gt;= 1</range>
7998 The map provided here is the same map that is used by the camera device to
7999 correct both color shading and vignetting for output non-RAW images.
8001 When there is no lens shading correction applied to RAW
8002 output images (android.sensor.info.lensShadingApplied `==`
8003 false), this map is the complete lens shading correction
8004 map; when there is some lens shading correction applied to
8005 the RAW output image (android.sensor.info.lensShadingApplied
8006 `==` true), this map reports the remaining lens shading
8007 correction map that needs to be applied to get shading
8008 corrected images that match the camera device's output for
8011 For a complete shading correction map, the least shaded
8012 section of the image will have a gain factor of 1; all
8013 other sections will have gains above 1.
8015 When android.colorCorrection.mode = TRANSFORM_MATRIX, the map
8016 will take into account the colorCorrection settings.
8018 The shading map is for the entire active pixel array, and is not
8019 affected by the crop region specified in the request. Each shading map
8020 entry is the value of the shading compensation map over a specific
8021 pixel on the sensor. Specifically, with a (N x M) resolution shading
8022 map, and an active pixel array size (W x H), shading map entry
8023 (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at
8024 pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels.
8025 The map is assumed to be bilinearly interpolated between the sample points.
8027 The channel order is [R, Geven, Godd, B], where Geven is the green
8028 channel for the even rows of a Bayer pattern, and Godd is the odd rows.
8029 The shading map is stored in a fully interleaved format.
8031 The shading map will generally have on the order of 30-40 rows and columns,
8032 and will be smaller than 64x64.
8034 As an example, given a very small map defined as:
8036 width,height = [ 4, 3 ]
8038 [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2,
8039 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3,
8040 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0,
8041 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2,
8042 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2,
8043 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ]
8045 The low-resolution scaling map images for each channel are
8046 (displayed using nearest-neighbor interpolation):
8048 
8049 
8050 
8051 
8053 As a visualization only, inverting the full-color map to recover an
8054 image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:
8056 
8059 <entry name="lensShadingMap" type="float" visibility="ndk_public"
8060 type_notes="2D array of float gain factors per channel to correct lens shading"
8061 container="array" hwlevel="full">
8067 <description>The shading map is a low-resolution floating-point map
8068 that lists the coefficients used to correct for vignetting and color shading,
8069 for each Bayer color channel of RAW image data.</description>
8070 <range>Each gain factor is &gt;= 1</range>
8072 The map provided here is the same map that is used by the camera device to
8073 correct both color shading and vignetting for output non-RAW images.
8075 When there is no lens shading correction applied to RAW
8076 output images (android.sensor.info.lensShadingApplied `==`
8077 false), this map is the complete lens shading correction
8078 map; when there is some lens shading correction applied to
8079 the RAW output image (android.sensor.info.lensShadingApplied
8080 `==` true), this map reports the remaining lens shading
8081 correction map that needs to be applied to get shading
8082 corrected images that match the camera device's output for
8085 For a complete shading correction map, the least shaded
8086 section of the image will have a gain factor of 1; all
8087 other sections will have gains above 1.
8089 When android.colorCorrection.mode = TRANSFORM_MATRIX, the map
8090 will take into account the colorCorrection settings.
8092 The shading map is for the entire active pixel array, and is not
8093 affected by the crop region specified in the request. Each shading map
8094 entry is the value of the shading compensation map over a specific
8095 pixel on the sensor. Specifically, with a (N x M) resolution shading
8096 map, and an active pixel array size (W x H), shading map entry
8097 (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at
8098 pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels.
8099 The map is assumed to be bilinearly interpolated between the sample points.
8101 The channel order is [R, Geven, Godd, B], where Geven is the green
8102 channel for the even rows of a Bayer pattern, and Godd is the odd rows.
8103 The shading map is stored in a fully interleaved format, and its size
8104 is provided in the camera static metadata by android.lens.info.shadingMapSize.
8106 The shading map will generally have on the order of 30-40 rows and columns,
8107 and will be smaller than 64x64.
8109 As an example, given a very small map defined as:
8111 android.lens.info.shadingMapSize = [ 4, 3 ]
8112 android.statistics.lensShadingMap =
8113 [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2,
8114 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3,
8115 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0,
8116 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2,
8117 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2,
8118 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ]
8120 The low-resolution scaling map images for each channel are
8121 (displayed using nearest-neighbor interpolation):
8123 
8124 
8125 
8126 
8128 As a visualization only, inverting the full-color map to recover an
8129 image of a gray wall (using bicubic interpolation for visual quality)
8130 as captured by the sensor gives:
8132 
8134 Note that the RAW image data might be subject to lens shading
8135 correction not reported on this map. Query
8136 android.sensor.info.lensShadingApplied to see if RAW image data has subject
8137 to lens shading correction. If android.sensor.info.lensShadingApplied
8138 is TRUE, the RAW image data is subject to partial or full lens shading
8139 correction. In the case full lens shading correction is applied to RAW
8140 images, the gain factor map reported in this key will contain all 1.0 gains.
8141 In other words, the map reported in this key is the remaining lens shading
8142 that needs to be applied on the RAW image to get images without lens shading
8143 artifacts. See android.request.maxNumOutputRaw for a list of RAW image
8147 The lens shading map calculation may depend on exposure and white balance statistics.
8148 When AE and AWB are in AUTO modes
8149 (android.control.aeMode `!=` OFF and android.control.awbMode `!=` OFF), the HAL
8150 may have all the information it need to generate most accurate lens shading map. When
8151 AE or AWB are in manual mode
8152 (android.control.aeMode `==` OFF or android.control.awbMode `==` OFF), the shading map
8153 may be adversely impacted by manual exposure or white balance parameters. To avoid
8154 generating unreliable shading map data, the HAL may choose to lock the shading map with
8155 the latest known good map generated when the AE and AWB are in AUTO modes.
8158 <entry name="predictedColorGains" type="float"
8162 type_notes="A 1D array of floats for 4 color channel gains"
8167 <description>The best-fit color channel gains calculated
8168 by the camera device's statistics units for the current output frame.
8171 This may be different than the gains used for this frame,
8172 since statistics processing on data from a new frame
8173 typically completes after the transform has already been
8174 applied to that frame.
8176 The 4 channel gains are defined in Bayer domain,
8177 see android.colorCorrection.gains for details.
8179 This value should always be calculated by the auto-white balance (AWB) block,
8180 regardless of the android.control.* current values.
8183 <entry name="predictedColorTransform" type="rational"
8187 type_notes="3x3 rational matrix in row-major order"
8193 <description>The best-fit color transform matrix estimate
8194 calculated by the camera device's statistics units for the current
8195 output frame.</description>
8196 <details>The camera device will provide the estimate from its
8197 statistics unit on the white balance transforms to use
8198 for the next frame. These are the values the camera device believes
8199 are the best fit for the current output frame. This may
8200 be different than the transform used for this frame, since
8201 statistics processing on data from a new frame typically
8202 completes after the transform has already been applied to
8205 These estimates must be provided for all frames, even if
8206 capture settings and color transforms are set by the application.
8208 This value should always be calculated by the auto-white balance (AWB) block,
8209 regardless of the android.control.* current values.
8212 <entry name="sceneFlicker" type="byte" visibility="public" enum="true"
8216 <notes>The camera device does not detect any flickering illumination
8217 in the current scene.</notes></value>
8219 <notes>The camera device detects illumination flickering at 50Hz
8220 in the current scene.</notes></value>
8222 <notes>The camera device detects illumination flickering at 60Hz
8223 in the current scene.</notes></value>
8225 <description>The camera device estimated scene illumination lighting
8226 frequency.</description>
8228 Many light sources, such as most fluorescent lights, flicker at a rate
8229 that depends on the local utility power standards. This flicker must be
8230 accounted for by auto-exposure routines to avoid artifacts in captured images.
8231 The camera device uses this entry to tell the application what the scene
8232 illuminant frequency is.
8234 When manual exposure control is enabled
8235 (`android.control.aeMode == OFF` or `android.control.mode ==
8236 OFF`), the android.control.aeAntibandingMode doesn't perform
8237 antibanding, and the application can ensure it selects
8238 exposure times that do not cause banding issues by looking
8239 into this metadata field. See
8240 android.control.aeAntibandingMode for more details.
8242 Reports NONE if there doesn't appear to be flickering illumination.
8245 <clone entry="android.statistics.hotPixelMapMode" kind="controls">
8247 <entry name="hotPixelMap" type="int32" visibility="public"
8248 type_notes="list of coordinates based on android.sensor.pixelArraySize"
8249 container="array" typedef="point">
8255 List of `(x, y)` coordinates of hot/defective pixels on the sensor.
8258 n <= number of pixels on the sensor.
8259 The `(x, y)` coordinates must be bounded by
8260 android.sensor.info.pixelArraySize.
8263 A coordinate `(x, y)` must lie between `(0, 0)`, and
8264 `(width - 1, height - 1)` (inclusive), which are the top-left and
8265 bottom-right of the pixel array, respectively. The width and
8266 height dimensions are given in android.sensor.info.pixelArraySize.
8267 This may include hot pixels that lie outside of the active array
8268 bounds given by android.sensor.info.activeArraySize.
8271 A hotpixel map contains the coordinates of pixels on the camera
8272 sensor that do report valid values (usually due to defects in
8273 the camera sensor). This includes pixels that are stuck at certain
8274 values, or have a response that does not accuractly encode the
8275 incoming light from the scene.
8277 To avoid performance issues, there should be significantly fewer hot
8278 pixels than actual pixels on the camera sensor.
8285 <entry name="lensShadingMapMode" type="byte" visibility="public" enum="true" hwlevel="full">
8288 <notes>Do not include a lens shading map in the capture result.</notes></value>
8290 <notes>Include a lens shading map in the capture result.</notes></value>
8292 <description>Whether the camera device will output the lens
8293 shading map in output result metadata.</description>
8294 <range>android.statistics.info.availableLensShadingMapModes</range>
8295 <details>When set to ON,
8296 android.statistics.lensShadingMap will be provided in
8297 the output result metadata.
8299 ON is always supported on devices with the RAW capability.
8305 <clone entry="android.statistics.lensShadingMapMode" kind="controls">
8309 <entry name="oisDataMode" type="byte" visibility="public" enum="true" hal_version="3.3">
8312 <notes>Do not include OIS data in the capture result.</notes></value>
8314 <notes>Include OIS data in the capture result.</notes>
8315 <sdk_notes>android.statistics.oisSamples provides OIS sample data in the
8316 output result metadata.
8318 <ndk_notes>android.statistics.oisTimestamps, android.statistics.oisXShifts,
8319 and android.statistics.oisYShifts provide OIS data in the output result metadata.
8323 <description>A control for selecting whether OIS position information is included in output
8324 result metadata.</description>
8325 <range>android.Statistics.info.availableOisDataModes</range>
8329 <clone entry="android.statistics.oisDataMode" kind="controls">
8331 <entry name="oisTimestamps" type="int64" visibility="ndk_public" container="array" hal_version="3.3">
8336 An array of timestamps of OIS samples, in nanoseconds.
8338 <units>nanoseconds</units>
8340 The array contains the timestamps of OIS samples. The timestamps are in the same
8341 timebase as and comparable to android.sensor.timestamp.
8344 <entry name="oisXShifts" type="float" visibility="ndk_public" container="array" hal_version="3.3">
8349 An array of shifts of OIS samples, in x direction.
8351 <units>Pixels in active array.</units>
8353 The array contains the amount of shifts in x direction, in pixels, based on OIS samples.
8354 A positive value is a shift from left to right in active array coordinate system. For
8355 example, if the optical center is (1000, 500) in active array coordinates, a shift of
8356 (3, 0) puts the new optical center at (1003, 500).
8358 The number of shifts must match the number of timestamps in
8359 android.statistics.oisTimestamps.
8362 <entry name="oisYShifts" type="float" visibility="ndk_public" container="array" hal_version="3.3">
8367 An array of shifts of OIS samples, in y direction.
8369 <units>Pixels in active array.</units>
8371 The array contains the amount of shifts in y direction, in pixels, based on OIS samples.
8372 A positive value is a shift from top to bottom in active array coordinate system. For
8373 example, if the optical center is (1000, 500) in active array coordinates, a shift of
8374 (0, 5) puts the new optical center at (1000, 505).
8376 The number of shifts must match the number of timestamps in
8377 android.statistics.oisTimestamps.
8380 <entry name="oisSamples" type="float" visibility="java_public" synthetic="true"
8381 container="array" typedef="oisSample" hal_version="3.3">
8386 An array of OIS samples.
8389 Each OIS sample contains the timestamp and the amount of shifts in x and y direction,
8390 in pixels, of the OIS sample.
8392 A positive value for a shift in x direction is a shift from left to right in active array
8393 coordinate system. For example, if the optical center is (1000, 500) in active array
8394 coordinates, a shift of (3, 0) puts the new optical center at (1003, 500).
8396 A positive value for a shift in y direction is a shift from top to bottom in active array
8397 coordinate system. For example, if the optical center is (1000, 500) in active array
8398 coordinates, a shift of (0, 5) puts the new optical center at (1000, 505).
8403 <section name="tonemap">
8405 <entry name="curveBlue" type="float" visibility="ndk_public"
8406 type_notes="1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints."
8407 container="array" hwlevel="full">
8412 <description>Tonemapping / contrast / gamma curve for the blue
8413 channel, to use when android.tonemap.mode is
8414 CONTRAST_CURVE.</description>
8415 <details>See android.tonemap.curveRed for more details.</details>
8417 <entry name="curveGreen" type="float" visibility="ndk_public"
8418 type_notes="1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints."
8419 container="array" hwlevel="full">
8424 <description>Tonemapping / contrast / gamma curve for the green
8425 channel, to use when android.tonemap.mode is
8426 CONTRAST_CURVE.</description>
8427 <details>See android.tonemap.curveRed for more details.</details>
8429 <entry name="curveRed" type="float" visibility="ndk_public"
8430 type_notes="1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints."
8431 container="array" hwlevel="full">
8436 <description>Tonemapping / contrast / gamma curve for the red
8437 channel, to use when android.tonemap.mode is
8438 CONTRAST_CURVE.</description>
8439 <range>0-1 on both input and output coordinates, normalized
8440 as a floating-point value such that 0 == black and 1 == white.
8443 Each channel's curve is defined by an array of control points:
8445 android.tonemap.curveRed =
8446 [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]
8447 2 <= N <= android.tonemap.maxCurvePoints
8449 These are sorted in order of increasing `Pin`; it is
8450 required that input values 0.0 and 1.0 are included in the list to
8451 define a complete mapping. For input values between control points,
8452 the camera device must linearly interpolate between the control
8455 Each curve can have an independent number of points, and the number
8456 of points can be less than max (that is, the request doesn't have to
8457 always provide a curve with number of points equivalent to
8458 android.tonemap.maxCurvePoints).
8460 A few examples, and their corresponding graphical mappings; these
8461 only specify the red channel and the precision is limited to 4
8462 digits, for conciseness.
8466 android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ]
8468 
8472 android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ]
8474 
8476 Gamma 1/2.2 mapping, with 16 control points:
8478 android.tonemap.curveRed = [
8479 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812,
8480 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072,
8481 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685,
8482 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ]
8484 
8486 Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:
8488 android.tonemap.curveRed = [
8489 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845,
8490 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130,
8491 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721,
8492 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ]
8494 
8497 For good quality of mapping, at least 128 control points are
8500 A typical use case of this would be a gamma-1/2.2 curve, with as many
8501 control points used as are available.
8504 <entry name="curve" type="float" visibility="java_public" synthetic="true"
8505 typedef="tonemapCurve"
8507 <description>Tonemapping / contrast / gamma curve to use when android.tonemap.mode
8508 is CONTRAST_CURVE.</description>
8510 The tonemapCurve consist of three curves for each of red, green, and blue
8511 channels respectively. The following example uses the red channel as an
8512 example. The same logic applies to green and blue channel.
8513 Each channel's curve is defined by an array of control points:
8516 [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]
8517 2 <= N <= android.tonemap.maxCurvePoints
8519 These are sorted in order of increasing `Pin`; it is always
8520 guaranteed that input values 0.0 and 1.0 are included in the list to
8521 define a complete mapping. For input values between control points,
8522 the camera device must linearly interpolate between the control
8525 Each curve can have an independent number of points, and the number
8526 of points can be less than max (that is, the request doesn't have to
8527 always provide a curve with number of points equivalent to
8528 android.tonemap.maxCurvePoints).
8530 A few examples, and their corresponding graphical mappings; these
8531 only specify the red channel and the precision is limited to 4
8532 digits, for conciseness.
8536 curveRed = [ (0, 0), (1.0, 1.0) ]
8538 
8542 curveRed = [ (0, 1.0), (1.0, 0) ]
8544 
8546 Gamma 1/2.2 mapping, with 16 control points:
8549 (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812),
8550 (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072),
8551 (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685),
8552 (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ]
8554 
8556 Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:
8559 (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845),
8560 (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130),
8561 (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721),
8562 (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ]
8564 
8567 This entry is created by the framework from the curveRed, curveGreen and
8571 <entry name="mode" type="byte" visibility="public" enum="true"
8574 <value>CONTRAST_CURVE
8575 <notes>Use the tone mapping curve specified in
8576 the android.tonemap.curve* entries.
8578 All color enhancement and tonemapping must be disabled, except
8579 for applying the tonemapping curve specified by
8580 android.tonemap.curve.
8582 Must not slow down frame rate relative to raw
8588 Advanced gamma mapping and color enhancement may be applied, without
8589 reducing frame rate compared to raw sensor output.
8594 High-quality gamma mapping and color enhancement will be applied, at
8595 the cost of possibly reduced frame rate compared to raw sensor output.
8600 Use the gamma value specified in android.tonemap.gamma to peform
8603 All color enhancement and tonemapping must be disabled, except
8604 for applying the tonemapping curve specified by android.tonemap.gamma.
8606 Must not slow down frame rate relative to raw sensor output.
8611 Use the preset tonemapping curve specified in
8612 android.tonemap.presetCurve to peform tonemapping.
8614 All color enhancement and tonemapping must be disabled, except
8615 for applying the tonemapping curve specified by
8616 android.tonemap.presetCurve.
8618 Must not slow down frame rate relative to raw sensor output.
8622 <description>High-level global contrast/gamma/tonemapping control.
8624 <range>android.tonemap.availableToneMapModes</range>
8626 When switching to an application-defined contrast curve by setting
8627 android.tonemap.mode to CONTRAST_CURVE, the curve is defined
8628 per-channel with a set of `(in, out)` points that specify the
8629 mapping from input high-bit-depth pixel value to the output
8630 low-bit-depth value. Since the actual pixel ranges of both input
8631 and output may change depending on the camera pipeline, the values
8632 are specified by normalized floating-point numbers.
8634 More-complex color mapping operations such as 3D color look-up
8635 tables, selective chroma enhancement, or other non-linear color
8636 transforms will be disabled when android.tonemap.mode is
8639 When using either FAST or HIGH_QUALITY, the camera device will
8640 emit its own tonemap curve in android.tonemap.curve.
8641 These values are always available, and as close as possible to the
8642 actually used nonlinear/nonglobal transforms.
8644 If a request is sent with CONTRAST_CURVE with the camera device's
8645 provided curve in FAST or HIGH_QUALITY, the image's tonemap will be
8646 roughly the same.</details>
8650 <entry name="maxCurvePoints" type="int32" visibility="public"
8652 <description>Maximum number of supported points in the
8653 tonemap curve that can be used for android.tonemap.curve.
8656 If the actual number of points provided by the application (in android.tonemap.curve*) is
8657 less than this maximum, the camera device will resample the curve to its internal
8658 representation, using linear interpolation.
8660 The output curves in the result metadata may have a different number
8661 of points than the input curves, and will represent the actual
8662 hardware curves used as closely as possible when linearly interpolated.
8665 This value must be at least 64. This should be at least 128.
8668 <entry name="availableToneMapModes" type="byte" visibility="public"
8669 type_notes="list of enums" container="array" typedef="enumList" hwlevel="full">
8674 List of tonemapping modes for android.tonemap.mode that are supported by this camera
8677 <range>Any value listed in android.tonemap.mode</range>
8679 Camera devices that support the MANUAL_POST_PROCESSING capability will always contain
8680 at least one of below mode combinations:
8682 * CONTRAST_CURVE, FAST and HIGH_QUALITY
8683 * GAMMA_VALUE, PRESET_CURVE, FAST and HIGH_QUALITY
8685 This includes all FULL level devices.
8688 HAL must support both FAST and HIGH_QUALITY if automatic tonemap control is available
8689 on the camera device, but the underlying implementation can be the same for both modes.
8690 That is, if the highest quality implementation on the camera device does not slow down
8691 capture rate, then FAST and HIGH_QUALITY will generate the same output.
8696 <clone entry="android.tonemap.curveBlue" kind="controls">
8698 <clone entry="android.tonemap.curveGreen" kind="controls">
8700 <clone entry="android.tonemap.curveRed" kind="controls">
8702 <clone entry="android.tonemap.curve" kind="controls">
8704 <clone entry="android.tonemap.mode" kind="controls">
8708 <entry name="gamma" type="float" visibility="public">
8709 <description> Tonemapping curve to use when android.tonemap.mode is
8713 The tonemap curve will be defined the following formula:
8714 * OUT = pow(IN, 1.0 / gamma)
8715 where IN and OUT is the input pixel value scaled to range [0.0, 1.0],
8716 pow is the power function and gamma is the gamma value specified by this
8719 The same curve will be applied to all color channels. The camera device
8720 may clip the input gamma value to its supported range. The actual applied
8721 value will be returned in capture result.
8723 The valid range of gamma value varies on different devices, but values
8724 within [1.0, 5.0] are guaranteed not to be clipped.
8727 <entry name="presetCurve" type="byte" visibility="public" enum="true">
8730 <notes>Tonemapping curve is defined by sRGB</notes>
8733 <notes>Tonemapping curve is defined by ITU-R BT.709</notes>
8736 <description> Tonemapping curve to use when android.tonemap.mode is
8740 The tonemap curve will be defined by specified standard.
8742 sRGB (approximated by 16 control points):
8744 
8746 Rec. 709 (approximated by 16 control points):
8748 
8750 Note that above figures show a 16 control points approximation of preset
8751 curves. Camera devices may apply a different approximation to the curve.
8756 <clone entry="android.tonemap.gamma" kind="controls">
8758 <clone entry="android.tonemap.presetCurve" kind="controls">
8762 <section name="led">
8764 <entry name="transmit" type="byte" visibility="hidden" optional="true"
8765 enum="true" typedef="boolean">
8770 <description>This LED is nominally used to indicate to the user
8771 that the camera is powered on and may be streaming images back to the
8772 Application Processor. In certain rare circumstances, the OS may
8773 disable this when video is processed locally and not transmitted to
8774 any untrusted applications.
8776 In particular, the LED *must* always be on when the data could be
8777 transmitted off the device. The LED *should* always be on whenever
8778 data is stored locally on the device.
8780 The LED *may* be off if a trusted application is using the data that
8781 doesn't violate the above rules.
8786 <clone entry="android.led.transmit" kind="controls"></clone>
8789 <entry name="availableLeds" type="byte" visibility="hidden" optional="true"
8797 <notes>android.led.transmit control is used.</notes>
8800 <description>A list of camera LEDs that are available on this system.
8805 <section name="info">
8807 <entry name="supportedHardwareLevel" type="byte" visibility="public"
8808 enum="true" hwlevel="legacy">
8813 This camera device does not have enough capabilities to qualify as a `FULL` device or
8816 Only the stream configurations listed in the `LEGACY` and `LIMITED` tables in the
8817 {@link android.hardware.camera2.CameraDevice#createCaptureSession|ACameraDevice_createCaptureSession
8818 createCaptureSession} documentation are guaranteed to be supported.
8820 All `LIMITED` devices support the `BACKWARDS_COMPATIBLE` capability, indicating basic
8821 support for color image capture. The only exception is that the device may
8822 alternatively support only the `DEPTH_OUTPUT` capability, if it can only output depth
8823 measurements and not color images.
8825 `LIMITED` devices and above require the use of android.control.aePrecaptureTrigger
8826 to lock exposure metering (and calculate flash power, for cameras with flash) before
8827 capturing a high-quality still image.
8829 A `LIMITED` device that only lists the `BACKWARDS_COMPATIBLE` capability is only
8830 required to support full-automatic operation and post-processing (`OFF` is not
8831 supported for android.control.aeMode, android.control.afMode, or
8832 android.control.awbMode)
8834 Additional capabilities may optionally be supported by a `LIMITED`-level device, and
8835 can be checked for in android.request.availableCapabilities.
8841 This camera device is capable of supporting advanced imaging applications.
8843 The stream configurations listed in the `FULL`, `LEGACY` and `LIMITED` tables in the
8844 {@link android.hardware.camera2.CameraDevice#createCaptureSession|ACameraDevice_createCaptureSession
8845 createCaptureSession} documentation are guaranteed to be supported.
8847 A `FULL` device will support below capabilities:
8849 * `BURST_CAPTURE` capability (android.request.availableCapabilities contains
8851 * Per frame control (android.sync.maxLatency `==` PER_FRAME_CONTROL)
8852 * Manual sensor control (android.request.availableCapabilities contains `MANUAL_SENSOR`)
8853 * Manual post-processing control (android.request.availableCapabilities contains
8854 `MANUAL_POST_PROCESSING`)
8855 * The required exposure time range defined in android.sensor.info.exposureTimeRange
8856 * The required maxFrameDuration defined in android.sensor.info.maxFrameDuration
8859 Pre-API level 23, FULL devices also supported arbitrary cropping region
8860 (android.scaler.croppingType `== FREEFORM`); this requirement was relaxed in API level
8861 23, and `FULL` devices may only support `CENTERED` cropping.
8867 This camera device is running in backward compatibility mode.
8869 Only the stream configurations listed in the `LEGACY` table in the {@link
8870 android.hardware.camera2.CameraDevice#createCaptureSession|ACameraDevice_createCaptureSession
8871 createCaptureSession} documentation are supported.
8873 A `LEGACY` device does not support per-frame control, manual sensor control, manual
8874 post-processing, arbitrary cropping regions, and has relaxed performance constraints.
8875 No additional capabilities beyond `BACKWARD_COMPATIBLE` will ever be listed by a
8876 `LEGACY` device in android.request.availableCapabilities.
8878 In addition, the android.control.aePrecaptureTrigger is not functional on `LEGACY`
8879 devices. Instead, every request that includes a JPEG-format output target is treated
8880 as triggering a still capture, internally executing a precapture trigger. This may
8881 fire the flash for flash power metering during precapture, and then fire the flash
8882 for the final capture, if a flash is available on the device and the AE mode is set to
8889 This camera device is capable of YUV reprocessing and RAW data capture, in addition to
8890 FULL-level capabilities.
8892 The stream configurations listed in the `LEVEL_3`, `RAW`, `FULL`, `LEGACY` and
8893 `LIMITED` tables in the {@link
8894 android.hardware.camera2.CameraDevice#createCaptureSession|ACameraDevice_createCaptureSession
8895 createCaptureSession} documentation are guaranteed to be supported.
8897 The following additional capabilities are guaranteed to be supported:
8899 * `YUV_REPROCESSING` capability (android.request.availableCapabilities contains
8901 * `RAW` capability (android.request.availableCapabilities contains
8905 <value hal_version="3.3">
8908 This camera device is backed by an external camera connected to this Android device.
8910 The device has capability identical to a LIMITED level device, with the following
8913 * The device may not report lens/sensor related information such as
8914 - android.lens.focalLength
8915 - android.lens.info.hyperfocalDistance
8916 - android.sensor.info.physicalSize
8917 - android.sensor.info.whiteLevel
8918 - android.sensor.blackLevelPattern
8919 - android.sensor.info.colorFilterArrangement
8920 - android.sensor.rollingShutterSkew
8921 * The device will report 0 for android.sensor.orientation
8922 * The device has less guarantee on stable framerate, as the framerate partly depends
8923 on the external camera being used.
8928 Generally classifies the overall set of the camera device functionality.
8931 The supported hardware level is a high-level description of the camera device's
8932 capabilities, summarizing several capabilities into one field. Each level adds additional
8933 features to the previous one, and is always a strict superset of the previous level.
8934 The ordering is `LEGACY < LIMITED < FULL < LEVEL_3`.
8936 Starting from `LEVEL_3`, the level enumerations are guaranteed to be in increasing
8937 numerical value as well. To check if a given device is at least at a given hardware level,
8938 the following code snippet can be used:
8940 // Returns true if the device supports the required hardware level, or better.
8941 boolean isHardwareLevelSupported(CameraCharacteristics c, int requiredLevel) {
8942 int deviceLevel = c.get(CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL);
8943 if (deviceLevel == CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY) {
8944 return requiredLevel == deviceLevel;
8946 // deviceLevel is not LEGACY, can use numerical sort
8947 return requiredLevel <= deviceLevel;
8950 At a high level, the levels are:
8952 * `LEGACY` devices operate in a backwards-compatibility mode for older
8953 Android devices, and have very limited capabilities.
8954 * `LIMITED` devices represent the
8955 baseline feature set, and may also include additional capabilities that are
8957 * `FULL` devices additionally support per-frame manual control of sensor, flash, lens and
8958 post-processing settings, and image capture at a high rate.
8959 * `LEVEL_3` devices additionally support YUV reprocessing and RAW image capture, along
8960 with additional output stream configurations.
8962 See the individual level enums for full descriptions of the supported capabilities. The
8963 android.request.availableCapabilities entry describes the device's capabilities at a
8964 finer-grain level, if needed. In addition, many controls have their available settings or
8965 ranges defined in individual entries from {@link
8966 android.hardware.camera2.CameraCharacteristics|ACameraManager_getCameraCharacteristics}.
8968 Some features are not part of any particular hardware level or capability and must be
8969 queried separately. These include:
8971 * Calibrated timestamps (android.sensor.info.timestampSource `==` REALTIME)
8972 * Precision lens control (android.lens.info.focusDistanceCalibration `==` CALIBRATED)
8973 * Face detection (android.statistics.info.availableFaceDetectModes)
8974 * Optical or electrical image stabilization
8975 (android.lens.info.availableOpticalStabilization,
8976 android.control.availableVideoStabilizationModes)
8980 A camera HALv3 device can implement one of three possible operational modes; LIMITED,
8983 FULL support or better is expected from new higher-end devices. Limited
8984 mode has hardware requirements roughly in line with those for a camera HAL device v1
8985 implementation, and is expected from older or inexpensive devices. Each level is a strict
8986 superset of the previous level, and they share the same essential operational flow.
8988 For full details refer to "S3. Operational Modes" in camera3.h
8990 Camera HAL3+ must not implement LEGACY mode. It is there for backwards compatibility in
8991 the `android.hardware.camera2` user-facing API only on legacy HALv1 devices, and is
8992 implemented by the camera framework code.
8994 EXTERNAL level devices have lower peformance bar in CTS since the peformance might depend
8995 on the external camera being used and is not fully controlled by the device manufacturer.
8996 The ITS test suite is exempted for the same reason.
8999 <entry name="version" type="byte" visibility="public" typedef="string" hal_version="3.3">
9001 A short string for manufacturer version information about the camera device, such as
9002 ISP hardware, sensors, etc.
9005 This can be used in {@link android.media.ExifInterface#TAG_IMAGE_DESCRIPTION TAG_IMAGE_DESCRIPTION}
9006 in jpeg EXIF. This key may be absent if no version information is available on the
9010 The string must consist of only alphanumeric characters, punctuation, and
9011 whitespace, i.e. it must match regular expression "[\p{Alnum}\p{Punct}\p{Space}]*".
9012 It must not exceed 256 characters.
9017 <section name="blackLevel">
9019 <entry name="lock" type="byte" visibility="public" enum="true"
9020 typedef="boolean" hwlevel="full">
9025 <description> Whether black-level compensation is locked
9026 to its current values, or is free to vary.</description>
9027 <details>When set to `true` (ON), the values used for black-level
9028 compensation will not change until the lock is set to
9031 Since changes to certain capture parameters (such as
9032 exposure time) may require resetting of black level
9033 compensation, the camera device must report whether setting
9034 the black level lock was successful in the output result
9037 For example, if a sequence of requests is as follows:
9039 * Request 1: Exposure = 10ms, Black level lock = OFF
9040 * Request 2: Exposure = 10ms, Black level lock = ON
9041 * Request 3: Exposure = 10ms, Black level lock = ON
9042 * Request 4: Exposure = 20ms, Black level lock = ON
9043 * Request 5: Exposure = 20ms, Black level lock = ON
9044 * Request 6: Exposure = 20ms, Black level lock = ON
9046 And the exposure change in Request 4 requires the camera
9047 device to reset the black level offsets, then the output
9048 result metadata is expected to be:
9050 * Result 1: Exposure = 10ms, Black level lock = OFF
9051 * Result 2: Exposure = 10ms, Black level lock = ON
9052 * Result 3: Exposure = 10ms, Black level lock = ON
9053 * Result 4: Exposure = 20ms, Black level lock = OFF
9054 * Result 5: Exposure = 20ms, Black level lock = ON
9055 * Result 6: Exposure = 20ms, Black level lock = ON
9057 This indicates to the application that on frame 4, black
9058 levels were reset due to exposure value changes, and pixel
9059 values may not be consistent across captures.
9061 The camera device will maintain the lock to the extent
9062 possible, only overriding the lock to OFF when changes to
9063 other request parameters require a black level recalculation
9067 If for some reason black level locking is no longer possible
9068 (for example, the analog gain has changed, which forces
9069 black level offsets to be recalculated), then the HAL must
9070 override this request (and it must report 'OFF' when this
9071 does happen) until the next capture for which locking is
9072 possible again.</hal_details>
9077 <clone entry="android.blackLevel.lock"
9080 Whether the black level offset was locked for this frame. Should be
9081 ON if android.blackLevel.lock was ON in the capture request, unless
9082 a change in other capture settings forced the camera device to
9083 perform a black level reset.
9088 <section name="sync">
9090 <entry name="frameNumber" type="int64" visibility="ndk_public"
9091 enum="true" hwlevel="legacy">
9093 <value id="-1">CONVERGING
9095 The current result is not yet fully synchronized to any request.
9097 Synchronization is in progress, and reading metadata from this
9098 result may include a mix of data that have taken effect since the
9099 last synchronization time.
9101 In some future result, within android.sync.maxLatency frames,
9102 this value will update to the actual frame number frame number
9103 the result is guaranteed to be synchronized to (as long as the
9104 request settings remain constant).
9107 <value id="-2">UNKNOWN
9109 The current result's synchronization status is unknown.
9111 The result may have already converged, or it may be in
9112 progress. Reading from this result may include some mix
9113 of settings from past requests.
9115 After a settings change, the new settings will eventually all
9116 take effect for the output buffers and results. However, this
9117 value will not change when that happens. Altering settings
9118 rapidly may provide outcomes using mixes of settings from recent
9121 This value is intended primarily for backwards compatibility with
9122 the older camera implementations (for android.hardware.Camera).
9126 <description>The frame number corresponding to the last request
9127 with which the output result (metadata + buffers) has been fully
9128 synchronized.</description>
9129 <range>Either a non-negative value corresponding to a
9130 `frame_number`, or one of the two enums (CONVERGING / UNKNOWN).
9133 When a request is submitted to the camera device, there is usually a
9134 delay of several frames before the controls get applied. A camera
9135 device may either choose to account for this delay by implementing a
9136 pipeline and carefully submit well-timed atomic control updates, or
9137 it may start streaming control changes that span over several frame
9140 In the latter case, whenever a request's settings change relative to
9141 the previous submitted request, the full set of changes may take
9142 multiple frame durations to fully take effect. Some settings may
9143 take effect sooner (in less frame durations) than others.
9145 While a set of control changes are being propagated, this value
9148 Once it is fully known that a set of control changes have been
9149 finished propagating, and the resulting updated control settings
9150 have been read back by the camera device, this value will be set
9151 to a non-negative frame number (corresponding to the request to
9152 which the results have synchronized to).
9154 Older camera device implementations may not have a way to detect
9155 when all camera controls have been applied, and will always set this
9158 FULL capability devices will always have this value set to the
9159 frame number of the request corresponding to this result.
9163 * Whenever a request differs from the last request, any future
9164 results not yet returned may have this value set to CONVERGING (this
9165 could include any in-progress captures not yet returned by the camera
9166 device, for more details see pipeline considerations below).
9167 * Submitting a series of multiple requests that differ from the
9168 previous request (e.g. r1, r2, r3 s.t. r1 != r2 != r3)
9169 moves the new synchronization frame to the last non-repeating
9170 request (using the smallest frame number from the contiguous list of
9171 repeating requests).
9172 * Submitting the same request repeatedly will not change this value
9173 to CONVERGING, if it was already a non-negative value.
9174 * When this value changes to non-negative, that means that all of the
9175 metadata controls from the request have been applied, all of the
9176 metadata controls from the camera device have been read to the
9177 updated values (into the result), and all of the graphics buffers
9178 corresponding to this result are also synchronized to the request.
9180 _Pipeline considerations_:
9182 Submitting a request with updated controls relative to the previously
9183 submitted requests may also invalidate the synchronization state
9184 of all the results corresponding to currently in-flight requests.
9186 In other words, results for this current request and up to
9187 android.request.pipelineMaxDepth prior requests may have their
9188 android.sync.frameNumber change to CONVERGING.
9191 Using UNKNOWN here is illegal unless android.sync.maxLatency
9194 FULL capability devices should simply set this value to the
9195 `frame_number` of the request this result corresponds to.
9201 <entry name="maxLatency" type="int32" visibility="public" enum="true"
9204 <value id="0">PER_FRAME_CONTROL
9206 Every frame has the requests immediately applied.
9208 Changing controls over multiple requests one after another will
9209 produce results that have those controls applied atomically
9212 All FULL capability devices will have this as their maxLatency.
9215 <value id="-1">UNKNOWN
9217 Each new frame has some subset (potentially the entire set)
9218 of the past requests applied to the camera settings.
9220 By submitting a series of identical requests, the camera device
9221 will eventually have the camera settings applied, but it is
9222 unknown when that exact point will be.
9224 All LEGACY capability devices will have this as their maxLatency.
9229 The maximum number of frames that can occur after a request
9230 (different than the previous) has been submitted, and before the
9231 result's state becomes synchronized.
9233 <units>Frame counts</units>
9234 <range>A positive value, PER_FRAME_CONTROL, or UNKNOWN.</range>
9236 This defines the maximum distance (in number of metadata results),
9237 between the frame number of the request that has new controls to apply
9238 and the frame number of the result that has all the controls applied.
9240 In other words this acts as an upper boundary for how many frames
9241 must occur before the camera device knows for a fact that the new
9242 submitted camera settings have been applied in outgoing frames.
9245 For example if maxLatency was 2,
9247 initial request = X (repeating)
9253 where requestN has frameNumber N, and the first of the repeating
9254 initial request's has frameNumber F (and F < 1).
9256 initial result = X' + { android.sync.frameNumber == F }
9257 result1 = X' + { android.sync.frameNumber == F }
9258 result2 = X' + { android.sync.frameNumber == CONVERGING }
9259 result3 = X' + { android.sync.frameNumber == CONVERGING }
9260 result4 = X' + { android.sync.frameNumber == 2 }
9262 where resultN has frameNumber N.
9264 Since `result4` has a `frameNumber == 4` and
9265 `android.sync.frameNumber == 2`, the distance is clearly
9268 Use `frame_count` from camera3_request_t instead of
9269 android.request.frameCount or
9270 `{@link android.hardware.camera2.CaptureResult#getFrameNumber}`.
9272 LIMITED devices are strongly encouraged to use a non-negative
9273 value. If UNKNOWN is used here then app developers do not have a way
9274 to know when sensor settings have been applied.
9280 <section name="reprocess">
9282 <entry name="effectiveExposureFactor" type="float" visibility="java_public" hwlevel="limited">
9284 The amount of exposure time increase factor applied to the original output
9285 frame by the application processing before sending for reprocessing.
9287 <units>Relative exposure time increase factor.</units>
9288 <range> &gt;= 1.0</range>
9290 This is optional, and will be supported if the camera device supports YUV_REPROCESSING
9291 capability (android.request.availableCapabilities contains YUV_REPROCESSING).
9293 For some YUV reprocessing use cases, the application may choose to filter the original
9294 output frames to effectively reduce the noise to the same level as a frame that was
9295 captured with longer exposure time. To be more specific, assuming the original captured
9296 images were captured with a sensitivity of S and an exposure time of T, the model in
9297 the camera device is that the amount of noise in the image would be approximately what
9298 would be expected if the original capture parameters had been a sensitivity of
9299 S/effectiveExposureFactor and an exposure time of T*effectiveExposureFactor, rather
9300 than S and T respectively. If the captured images were processed by the application
9301 before being sent for reprocessing, then the application may have used image processing
9302 algorithms and/or multi-frame image fusion to reduce the noise in the
9303 application-processed images (input images). By using the effectiveExposureFactor
9304 control, the application can communicate to the camera device the actual noise level
9305 improvement in the application-processed image. With this information, the camera
9306 device can select appropriate noise reduction and edge enhancement parameters to avoid
9307 excessive noise reduction (android.noiseReduction.mode) and insufficient edge
9308 enhancement (android.edge.mode) being applied to the reprocessed frames.
9310 For example, for multi-frame image fusion use case, the application may fuse
9311 multiple output frames together to a final frame for reprocessing. When N image are
9312 fused into 1 image for reprocessing, the exposure time increase factor could be up to
9313 square root of N (based on a simple photon shot noise model). The camera device will
9314 adjust the reprocessing noise reduction and edge enhancement parameters accordingly to
9315 produce the best quality images.
9317 This is relative factor, 1.0 indicates the application hasn't processed the input
9318 buffer in a way that affects its effective exposure time.
9320 This control is only effective for YUV reprocessing capture request. For noise
9321 reduction reprocessing, it is only effective when `android.noiseReduction.mode != OFF`.
9322 Similarly, for edge enhancement reprocessing, it is only effective when
9323 `android.edge.mode != OFF`.
9329 <clone entry="android.reprocess.effectiveExposureFactor" kind="controls">
9333 <entry name="maxCaptureStall" type="int32" visibility="java_public" hwlevel="limited">
9335 The maximal camera capture pipeline stall (in unit of frame count) introduced by a
9336 reprocess capture request.
9338 <units>Number of frames.</units>
9339 <range> &lt;= 4</range>
9341 The key describes the maximal interference that one reprocess (input) request
9342 can introduce to the camera simultaneous streaming of regular (output) capture
9343 requests, including repeating requests.
9345 When a reprocessing capture request is submitted while a camera output repeating request
9346 (e.g. preview) is being served by the camera device, it may preempt the camera capture
9347 pipeline for at least one frame duration so that the camera device is unable to process
9348 the following capture request in time for the next sensor start of exposure boundary.
9349 When this happens, the application may observe a capture time gap (longer than one frame
9350 duration) between adjacent capture output frames, which usually exhibits as preview
9351 glitch if the repeating request output targets include a preview surface. This key gives
9352 the worst-case number of frame stall introduced by one reprocess request with any kind of
9353 formats/sizes combination.
9355 If this key reports 0, it means a reprocess request doesn't introduce any glitch to the
9356 ongoing camera repeating request outputs, as if this reprocess request is never issued.
9358 This key is supported if the camera device supports PRIVATE or YUV reprocessing (
9359 i.e. android.request.availableCapabilities contains PRIVATE_REPROCESSING or
9366 <section name="depth">
9368 <entry name="maxDepthSamples" type="int32" visibility="system" hwlevel="limited">
9369 <description>Maximum number of points that a depth point cloud may contain.
9372 If a camera device supports outputting depth range data in the form of a depth point
9373 cloud ({@link android.graphics.ImageFormat#DEPTH_POINT_CLOUD}), this is the maximum
9374 number of points an output buffer may contain.
9376 Any given buffer may contain between 0 and maxDepthSamples points, inclusive.
9377 If output in the depth point cloud format is not supported, this entry will
9382 <entry name="availableDepthStreamConfigurations" type="int32" visibility="ndk_public"
9383 enum="true" container="array" typedef="streamConfiguration" hwlevel="limited">
9389 <value>OUTPUT</value>
9390 <value>INPUT</value>
9392 <description>The available depth dataspace stream
9393 configurations that this camera device supports
9394 (i.e. format, width, height, output/input stream).
9397 These are output stream configurations for use with
9398 dataSpace HAL_DATASPACE_DEPTH. The configurations are
9399 listed as `(format, width, height, input?)` tuples.
9401 Only devices that support depth output for at least
9402 the HAL_PIXEL_FORMAT_Y16 dense depth map may include
9405 A device that also supports the HAL_PIXEL_FORMAT_BLOB
9406 sparse depth point cloud must report a single entry for
9407 the format in this list as `(HAL_PIXEL_FORMAT_BLOB,
9408 android.depth.maxDepthSamples, 1, OUTPUT)` in addition to
9409 the entries for HAL_PIXEL_FORMAT_Y16.
9413 <entry name="availableDepthMinFrameDurations" type="int64" visibility="ndk_public"
9414 container="array" typedef="streamConfigurationDuration" hwlevel="limited">
9419 <description>This lists the minimum frame duration for each
9420 format/size combination for depth output formats.
9422 <units>(format, width, height, ns) x n</units>
9424 This should correspond to the frame duration when only that
9425 stream is active, with all processing (typically in android.*.mode)
9426 set to either OFF or FAST.
9428 When multiple streams are used in a request, the minimum frame
9429 duration will be max(individual stream min durations).
9431 The minimum frame duration of a stream (of a particular format, size)
9432 is the same regardless of whether the stream is input or output.
9434 See android.sensor.frameDuration and
9435 android.scaler.availableStallDurations for more details about
9436 calculating the max frame rate.
9440 <entry name="availableDepthStallDurations" type="int64" visibility="ndk_public"
9441 container="array" typedef="streamConfigurationDuration" hwlevel="limited">
9446 <description>This lists the maximum stall duration for each
9447 output format/size combination for depth streams.
9449 <units>(format, width, height, ns) x n</units>
9451 A stall duration is how much extra time would get added
9452 to the normal minimum frame duration for a repeating request
9453 that has streams with non-zero stall.
9455 This functions similarly to
9456 android.scaler.availableStallDurations for depth
9459 All depth output stream formats may have a nonzero stall
9464 <entry name="depthIsExclusive" type="byte" visibility="public"
9465 enum="true" typedef="boolean" hwlevel="limited">
9467 <value>FALSE</value>
9470 <description>Indicates whether a capture request may target both a
9471 DEPTH16 / DEPTH_POINT_CLOUD output, and normal color outputs (such as
9472 YUV_420_888, JPEG, or RAW) simultaneously.
9475 If TRUE, including both depth and color outputs in a single
9476 capture request is not supported. An application must interleave color
9477 and depth requests. If FALSE, a single request can target both types
9480 Typically, this restriction exists on camera devices that
9481 need to emit a specific pattern or wavelength of light to
9482 measure depth values, which causes the color image to be
9483 corrupted during depth measurement.
9488 <section name="logicalMultiCamera">
9490 <entry name="physicalIds" type="byte" visibility="hidden"
9491 container="array" hwlevel="limited" hal_version="3.3">
9495 <description>String containing the ids of the underlying physical cameras.
9497 <units>UTF-8 null-terminated string</units>
9499 For a logical camera, this is concatenation of all underlying physical camera ids.
9500 The null terminator for physical camera id must be preserved so that the whole string
9501 can be tokenized using '\0' to generate list of physical camera ids.
9503 For example, if the physical camera ids of the logical camera are "2" and "3", the
9504 value of this tag will be ['2', '\0', '3', '\0'].
9506 The number of physical camera ids must be no less than 2.
9508 <tag id="LOGICALCAMERA" />
9510 <entry name="sensorSyncType" type="byte" visibility="public"
9511 enum="true" hwlevel="limited" hal_version="3.3">
9515 A software mechanism is used to synchronize between the physical cameras. As a result,
9516 the timestamp of an image from a physical stream is only an approximation of the
9517 image sensor start-of-exposure time.
9522 The camera device supports frame timestamp synchronization at the hardware level,
9523 and the timestamp of a physical stream image accurately reflects its
9524 start-of-exposure time.
9528 <description>The accuracy of frame timestamp synchronization between physical cameras</description>
9530 The accuracy of the frame timestamp synchronization determines the physical cameras'
9531 ability to start exposure at the same time. If the sensorSyncType is CALIBRATED,
9532 the physical camera sensors usually run in master-slave mode so that their shutter
9533 time is synchronized. For APPROXIMATE sensorSyncType, the camera sensors usually run in
9534 master-master mode, and there could be offset between their start of exposure.
9536 In both cases, all images generated for a particular capture request still carry the same
9537 timestamps, so that they can be used to look up the matching frame number and
9538 onCaptureStarted callback.
9540 <tag id="LOGICALCAMERA" />
OSDN Git Service
