-
TRANSFORM_MATRIX
Use the android.
color Correction. transform matrix and android. color Correction. gains to do color conversion. All advanced white balance adjustments (not specified by our white balance pipeline) must be disabled.
If AWB is enabled with
android.,control. awb Mode != OFF then TRANSFORM_ MATRIX is ignored. The camera device will override this value to either FAST or HIGH_ QUALITY. -
FAST
Must not slow down capture rate relative to sensor raw output.
Advanced white balance adjustments above and beyond the specified white balance pipeline may be applied.
If AWB is enabled with
android.,control. awb Mode != OFF then the camera device uses the last frame's AWB values (or defaults if AWB has never been run). -
HIGH_QUALITY
Capture rate (relative to sensor raw output) may be reduced by high quality.
Advanced white balance adjustments above and beyond the specified white balance pipeline may be applied.
If AWB is enabled with
android.,control. awb Mode != OFF then the camera device uses the last frame's AWB values (or defaults if AWB has never been run).
The mode control selects how the image data is converted from the
sensor's native color into linear sRGB color.
When auto-white balance is enabled with android.
We define the expected processing pipeline below.
When either FULL or HIGH_
Switching to TRANSFORM_
The expected processing pipeline is as follows:
The white balance is encoded by two values,
The 4-channel white-balance gains are defined as:
android.where G_ is the gain for green pixels on even rows of the
output,G_ is the gain for green pixels on the odd rows.G_ value,G_ equal to
G_ in the output result metadata.
The matrices for color transforms are defined as a 9-entry vector:
android.which define a transform from input sensor colors,P_,P_,
with colors as follows:
r' = I0r + I1g + I2b
g' = I3r + I4g + I5b
b' = I6r + I7g + I8b
Both the input and output value ranges must match.
A color transform matrix to use to transform from sensor RGB color space to output linear sRGB color space
This matrix is either set by the camera device when the request
android.
In the latter case,[0, (assuming input color
values is within the normalized range [0,),
Gains applying to Bayer raw color channels for white-balance
The 4-channel white-balance gains are defined in
the order of [R G_,G_ is the gain
for green pixels on even rows of the output,G_
is the gain for green pixels on the odd rows.G_ value,G_ equal to
G_ in the output result metadata.
This array is either set by HAL when the request
android.
The output should be the gains actually applied by the HAL to
the current frame.
A color transform matrix to use to transform from sensor RGB color space to output linear sRGB color space
This matrix is either set by the camera device when the request
android.
In the latter case,[0, (assuming input color
values is within the normalized range [0,),
Gains applying to Bayer raw color channels for white-balance
The 4-channel white-balance gains are defined in
the order of [R G_,G_ is the gain
for green pixels on even rows of the output,G_
is the gain for green pixels on the odd rows.G_ value,G_ equal to
G_ in the output result metadata.
This array is either set by HAL when the request
android.
The output should be the gains actually applied by the HAL to
the current frame.
-
OFF
The camera device will not adjust exposure duration to avoid banding problems.
-
50HZ
The camera device will adjust exposure duration to avoid banding problems with 50Hz illumination sources.
-
60HZ
The camera device will adjust exposure duration to avoid banding problems with 60Hz illumination sources.
-
AUTO
The camera device will automatically adapt its antibanding routine to the current illumination conditions.
This is the default.
The desired setting for the camera device's auto-exposure
algorithm's antibanding compensation.
Some kinds of lighting fixtures,
Therefore,
A given camera device may not support all of the possible
options for the antibanding mode.
The default mode is AUTO,
If manual exposure control is enabled (by setting
android.
For all capture request templates,
If manual exposure control is enabled (by setting
android.
Adjustment to AE target image brightness
For example,
-
OFF
Autoexposure lock is disabled; the AE algorithm is free to update its parameters.
-
ON
Autoexposure lock is enabled; the AE algorithm must not update the exposure and sensitivity parameters while the lock is active
Whether AE is currently locked to its latest
calculated values.
Note that even when AE is locked,
If AE precapture is triggered (see android.
See android.
-
OFF
The camera device's autoexposure routine is disabled; the application-selected android.
sensor. exposure Time, android. sensor. sensitivity and android. sensor. frame Duration are used by the camera device, along with android. flash. * fields, if there's a flash unit for this camera device. -
ON
The camera device's autoexposure routine is active,
with no flash control. The application's values for android. sensor. exposure Time, android. sensor. sensitivity, and android. sensor. frame Duration are ignored. The application has control over the various android. flash. * fields. -
ON_AUTO_FLASH
Like ON,
except that the camera device also controls the camera's flash unit, firing it in low-light conditions. The flash may be fired during a precapture sequence (triggered by android. control. ae Precapture Trigger) and may be fired for captures for which the android. control. capture Intent field is set to STILL_ CAPTURE -
ON_ALWAYS_FLASH
Like ON,
except that the camera device also controls the camera's flash unit, always firing it for still captures. The flash may be fired during a precapture sequence (triggered by android. control. ae Precapture Trigger) and will always be fired for captures for which the android. control. capture Intent field is set to STILL_ CAPTURE -
ON_AUTO_FLASH_REDEYE
Like ON_
AUTO_ FLASH, but with automatic red eye reduction. If deemed necessary by the camera device, a red eye reduction flash will fire during the precapture sequence.
The desired mode for the camera device's
auto-exposure routine.
This control is only effective if android.
When set to any of the ON modes,
The FLASH modes are only available if the camera device
has a flash unit (android.true).
If flash TORCH mode is desired,
When set to any of the ON modes,
List of areas to use for
metering.
area_
Each area is a rectangle plus weight: xmin,
The coordinate system is based on the active pixel array,
If all regions have 0 weight,
Range over which fps can be adjusted to maintain exposure
Only constrains AE algorithm,
-
IDLE
The trigger is idle.
-
START
The precapture metering sequence will be started by the camera device.
The exact effect of the precapture trigger depends on the current AE mode and state.
Whether the camera device will trigger a precapture
metering sequence when it processes this request.
This entry is normally set to IDLE,
The effect of AE precapture trigger depends on the current
AE mode and state; see android.
-
OFF
The auto-focus routine does not control the lens; android.
lens. focus Distance is controlled by the application -
AUTO
If lens is not fixed focus.
Use android.
lens. info. minimum Focus Distance to determine if lens is fixed-focus. In this mode, the lens does not move unless the autofocus trigger action is called. When that trigger is activated, AF must transition to ACTIVE_ SCAN, then to the outcome of the scan (FOCUSED or NOT_ FOCUSED). Triggering AF_
CANCEL resets the lens position to default, and sets the AF state to INACTIVE. -
MACRO
In this mode,
the lens does not move unless the autofocus trigger action is called. When that trigger is activated,
AF must transition to ACTIVE_ SCAN, then to the outcome of the scan (FOCUSED or NOT_ FOCUSED). Triggering cancel AF resets the lens position to default, and sets the AF state to INACTIVE. -
CONTINUOUS_VIDEO
In this mode,
the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream. The focusing behavior should be suitable for good quality video recording; typically this means slower focus movement and no overshoots.
When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_ SCAN and PASSIVE_ FOCUSED states as appropriate. When the AF trigger is activated, the algorithm should immediately transition into AF_ FOCUSED or AF_ NOT_ FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received. Once cancel is received,
the algorithm should transition back to INACTIVE and resume passive scan. Note that this behavior is not identical to CONTINUOUS_ PICTURE, since an ongoing PASSIVE_ SCAN must immediately be canceled. -
CONTINUOUS_PICTURE
In this mode,
the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream. The focusing behavior should be suitable for still image capture; typically this means focusing as fast as possible.
When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_ SCAN and PASSIVE_ FOCUSED states as appropriate as it attempts to maintain focus. When the AF trigger is activated, the algorithm should finish its PASSIVE_ SCAN if active, and then transition into AF_ FOCUSED or AF_ NOT_ FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received. When the AF cancel trigger is activated,
the algorithm should transition back to INACTIVE and then act as if it has just been started. -
EDOF
Extended depth of field (digital focus).
AF trigger is ignored, AF state should always be INACTIVE.
Whether AF is currently enabled,
Only effective if android.
If the lens is controlled by the camera device auto-focus algorithm,
List of areas to use for focus
estimation.
area_
Each area is a rectangle plus weight: xmin,
The coordinate system is based on the active pixel array,
If all regions have 0 weight,
-
IDLE
The trigger is idle.
-
START
Autofocus will trigger now.
-
CANCEL
Autofocus will return to its initial state,
and cancel any currently active trigger.
Whether the camera device will trigger autofocus for this request.
This entry is normally set to IDLE,
When included and set to START,
When set to CANCEL,
See android.
-
OFF
Auto-whitebalance lock is disabled; the AWB algorithm is free to update its parameters if in AUTO mode.
-
ON
Auto-whitebalance lock is enabled; the AWB algorithm must not update its parameters while the lock is active.
Whether AWB is currently locked to its
latest calculated values.
Note that AWB lock is only meaningful for AUTO
mode; in other modes,
-
OFF
The camera device's auto white balance routine is disabled; the application-selected color transform matrix (android.
color Correction. transform) and gains (android. color Correction. gains) are used by the camera device for manual white balance control. -
AUTO
The camera device's auto white balance routine is active; the application's values for android.
color Correction. transform and android. color Correction. gains are ignored. -
INCANDESCENT
The camera device's auto white balance routine is disabled; the camera device uses incandescent light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant A. -
FLUORESCENT
The camera device's auto white balance routine is disabled; the camera device uses fluorescent light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F2. -
WARM_FLUORESCENT
The camera device's auto white balance routine is disabled; the camera device uses warm fluorescent light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F4. -
DAYLIGHT
The camera device's auto white balance routine is disabled; the camera device uses daylight light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant D65. -
CLOUDY_DAYLIGHT
The camera device's auto white balance routine is disabled; the camera device uses cloudy daylight light as the assumed scene illumination for white balance.
-
TWILIGHT
The camera device's auto white balance routine is disabled; the camera device uses twilight light as the assumed scene illumination for white balance.
-
SHADE
The camera device's auto white balance routine is disabled; the camera device uses shade light as the assumed scene illumination for white balance.
Whether AWB is currently setting the color
transform fields,
This control is only effective if android.
When set to the ON mode,
When set to the OFF mode,
When set to any other modes,
List of areas to use for illuminant
estimation.
area_
Only used in AUTO mode.
Each area is a rectangle plus weight: xmin,
The coordinate system is based on the active pixel array,
If all regions have 0 weight,
-
CUSTOM
This request doesn't fall into the other categories.
Default to preview-like behavior. -
PREVIEW
This request is for a preview-like usecase.
The precapture trigger may be used to start off a metering w/ flash sequence -
STILL_CAPTURE
This request is for a still capture-type usecase.
-
VIDEO_RECORD
This request is for a video recording usecase.
-
VIDEO_SNAPSHOT
This request is for a video snapshot (still image while recording video) usecase
-
ZERO_SHUTTER_LAG
This request is for a ZSL usecase; the application will stream full-resolution images and reprocess one or several later for a final capture
Information to the camera device 3A (auto-exposure,
All must be supported
This control is only effective if android.
and any 3A routine is active.
-
OFF
No color effect will be applied.
-
MONO
optional
A "monocolor" effect where the image is mapped into a single color.
This will typically be grayscale. -
NEGATIVE
optional
A "photo-negative" effect where the image's colors are inverted.
-
SOLARIZE
optional
A "solarisation" effect (Sabattier effect) where the image is wholly or partially reversed in tone.
-
SEPIA
optional
A "sepia" effect where the image is mapped into warm gray,
red, and brown tones. -
POSTERIZE
optional
A "posterization" effect where the image uses discrete regions of tone rather than a continuous gradient of tones.
-
WHITEBOARD
optional
A "whiteboard" effect where the image is typically displayed as regions of white,
with black or grey details. -
BLACKBOARD
optional
A "blackboard" effect where the image is typically displayed as regions of black,
with white or grey details. -
AQUA
optional
An "aqua" effect where a blue hue is added to the image.
A special color effect to apply.
When this mode is set,
A color effect will only be applied if
android.
-
OFF
Full application control of pipeline.
All 3A routines are disabled, no other settings in android. control. * have any effect -
AUTO
Use settings for each individual 3A routine.
Manual control of capture parameters is disabled. All controls in android. control. * besides sceneMode take effect -
USE_SCENE_MODE
Use specific scene mode.
Enabling this disables control. aeMode, control. awbMode and control. afMode controls; the HAL must ignore those settings while USE_ SCENE_ MODE is active (except for FACE_ PRIORITY scene mode). Other control entries are still active. This setting can only be used if availableSceneModes != UNSUPPORTED -
OFF_KEEP_STATE
Same as OFF mode,
except that this capture will not be used by camera device background auto-exposure, auto-white balance and auto-focus algorithms to update their statistics.
Overall mode of 3A control routines
all must be supported
High-level 3A control.
When set to AUTO,
When set to USE_
When set to OFF_
-
DISABLED
0
Indicates that no scene modes are set for a given capture request.
-
FACE_PRIORITY
If face detection support exists,
use face detection data for auto-focus, auto-white balance, and auto-exposure routines. If face detection statistics are disabled (i. e. android. statistics. face Detect Mode is set to OFF), this should still operate correctly (but will not return face detection statistics to the framework). Unlike the other scene modes,
android. control. ae Mode, android. control. awb Mode, and android. control. af Mode remain active when FACE_ PRIORITY is set. -
ACTION
optional
Optimized for photos of quickly moving objects.
Similar to SPORTS. -
PORTRAIT
optional
Optimized for still photos of people.
-
LANDSCAPE
optional
Optimized for photos of distant macroscopic objects.
-
NIGHT
optional
Optimized for low-light settings.
-
NIGHT_PORTRAIT
optional
Optimized for still photos of people in low-light settings.
-
THEATRE
optional
Optimized for dim,
indoor settings where flash must remain off. -
BEACH
optional
Optimized for bright,
outdoor beach settings. -
SNOW
optional
Optimized for bright,
outdoor settings containing snow. -
SUNSET
optional
Optimized for scenes of the setting sun.
-
STEADYPHOTO
optional
Optimized to avoid blurry photos due to small amounts of device motion (for example: due to hand shake).
-
FIREWORKS
optional
Optimized for nighttime photos of fireworks.
-
SPORTS
optional
Optimized for photos of quickly moving people.
Similar to ACTION. -
PARTY
optional
Optimized for dim,
indoor settings with multiple moving people. -
CANDLELIGHT
optional
Optimized for dim settings where the main light source is a flame.
-
BARCODE
optional
Optimized for accurately capturing a photo of barcode for use by camera applications that wish to read the barcode value.
A camera mode optimized for conditions typical in a particular
capture setting.
This is the mode that that is active when
android..
The interpretation and implementation of these scene modes is left
to the implementor of the camera device.
HAL implementations that include scene modes are expected to provide
the per-scene settings to use for android.
- OFF
- ON
Whether video stabilization is active
If enabled,
The set of auto-exposure antibanding modes that are
supported by this camera device.
Not all of the auto-exposure anti-banding modes may be
supported by a given camera device.
The set of auto-exposure modes that are supported by this
camera device.
Not all the auto-exposure modes may be supported by a
given camera device,
All camera devices support ON,
Full-capability camera devices always support OFF mode,
List of frame rate ranges supported by the
AE algorithm/
Maximum and minimum exposure compensation
setting,
At least (-2,
Smallest step by which exposure compensation can be changed
<= 1/
List of AF modes that can be
selected with android.
Not all the auto-focus modes may be supported by a
given camera device.
All camera devices will support OFF mode,android.)
will support AUTO mode.
List containing the subset of color effects
specified in android.
Any subset of enums from those specified in
android.
This list contains the color effect modes that can be applied to
images produced by the camera device.
A color effect will only be applied if
android.
List containing a subset of scene modes
specified in android.
Any subset of the enums specified in android.android.).
This list contains scene modes that can be set for the camera device.[DISABLED].
List of video stabilization modes that can be supported
OFF must be included
The set of auto-white-balance modes (android.
Not all the auto-white-balance modes may be supported by a
given camera device.
All camera devices will support ON mode.
Full-capability camera devices will always support OFF mode,
List of the maximum number of regions that can be used for metering in
auto-exposure (AE),
Value must be >= 0 for each element.(AE,.
Ordered list of auto-exposure,
For each available scene mode,(aeMode,
where aeMode has the lowest index position.
When a scene mode is enabled,
The order of this list matches that of availableSceneModes,
For example,(FACE_,(0,.
To maintain backward compatibility,
The ID sent with the latest
CAMERA2_
Deprecated.
Must be 0 if no
CAMERA2_
-
OFF
The camera device's autoexposure routine is disabled; the application-selected android.
sensor. exposure Time, android. sensor. sensitivity and android. sensor. frame Duration are used by the camera device, along with android. flash. * fields, if there's a flash unit for this camera device. -
ON
The camera device's autoexposure routine is active,
with no flash control. The application's values for android. sensor. exposure Time, android. sensor. sensitivity, and android. sensor. frame Duration are ignored. The application has control over the various android. flash. * fields. -
ON_AUTO_FLASH
Like ON,
except that the camera device also controls the camera's flash unit, firing it in low-light conditions. The flash may be fired during a precapture sequence (triggered by android. control. ae Precapture Trigger) and may be fired for captures for which the android. control. capture Intent field is set to STILL_ CAPTURE -
ON_ALWAYS_FLASH
Like ON,
except that the camera device also controls the camera's flash unit, always firing it for still captures. The flash may be fired during a precapture sequence (triggered by android. control. ae Precapture Trigger) and will always be fired for captures for which the android. control. capture Intent field is set to STILL_ CAPTURE -
ON_AUTO_FLASH_REDEYE
Like ON_
AUTO_ FLASH, but with automatic red eye reduction. If deemed necessary by the camera device, a red eye reduction flash will fire during the precapture sequence.
The desired mode for the camera device's
auto-exposure routine.
This control is only effective if android.
When set to any of the ON modes,
The FLASH modes are only available if the camera device
has a flash unit (android.true).
If flash TORCH mode is desired,
When set to any of the ON modes,
List of areas to use for
metering.
area_
Each area is a rectangle plus weight: xmin,
The coordinate system is based on the active pixel array,
If all regions have 0 weight,
-
INACTIVE
AE is off or recently reset.
When a camera device is opened, it starts in this state. -
SEARCHING
AE doesn't yet have a good set of control values for the current scene.
-
CONVERGED
AE has a good set of control values for the current scene.
-
LOCKED
AE has been locked.
-
FLASH_REQUIRED
AE has a good set of control values,
but flash needs to be fired for good quality still capture. -
PRECAPTURE
AE has been asked to do a precapture sequence (through the android.
control. ae Precapture Trigger START), and is currently executing it. Once PRECAPTURE completes, AE will transition to CONVERGED or FLASH_ REQUIRED as appropriate.
Current state of AE algorithm
Switching between or enabling AE modes (android.android. resets all
the algorithm states to INACTIVE.
The camera device can do several state transitions between two results,
The state in the result is the state for this image (in sync with this image): if
AE state becomes CONVERGED,
Below are state transition tables for different AE modes.
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | INACTIVE | Camera device auto exposure algorithm is disabled |
When android.
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | Camera device initiates AE scan | SEARCHING | Values changing |
| INACTIVE | android. |
LOCKED | Values locked |
| SEARCHING | Camera device finishes AE scan | CONVERGED | Good values, |
| SEARCHING | Camera device finishes AE scan | FLASH_ |
Converged but too dark w/ |
| SEARCHING | android. |
LOCKED | Values locked |
| CONVERGED | Camera device initiates AE scan | SEARCHING | Values changing |
| CONVERGED | android. |
LOCKED | Values locked |
| FLASH_ |
Camera device initiates AE scan | SEARCHING | Values changing |
| FLASH_ |
android. |
LOCKED | Values locked |
| LOCKED | android. |
SEARCHING | Values not good after unlock |
| LOCKED | android. |
CONVERGED | Values good after unlock |
| LOCKED | android. |
FLASH_ |
Exposure good, |
| PRECAPTURE | Sequence done. |
CONVERGED | Ready for high-quality capture |
| PRECAPTURE | Sequence done. |
LOCKED | Ready for high-quality capture |
| Any state | android. |
PRECAPTURE | Start AE precapture metering sequence |
-
OFF
The auto-focus routine does not control the lens; android.
lens. focus Distance is controlled by the application -
AUTO
If lens is not fixed focus.
Use android.
lens. info. minimum Focus Distance to determine if lens is fixed-focus. In this mode, the lens does not move unless the autofocus trigger action is called. When that trigger is activated, AF must transition to ACTIVE_ SCAN, then to the outcome of the scan (FOCUSED or NOT_ FOCUSED). Triggering AF_
CANCEL resets the lens position to default, and sets the AF state to INACTIVE. -
MACRO
In this mode,
the lens does not move unless the autofocus trigger action is called. When that trigger is activated,
AF must transition to ACTIVE_ SCAN, then to the outcome of the scan (FOCUSED or NOT_ FOCUSED). Triggering cancel AF resets the lens position to default, and sets the AF state to INACTIVE. -
CONTINUOUS_VIDEO
In this mode,
the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream. The focusing behavior should be suitable for good quality video recording; typically this means slower focus movement and no overshoots.
When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_ SCAN and PASSIVE_ FOCUSED states as appropriate. When the AF trigger is activated, the algorithm should immediately transition into AF_ FOCUSED or AF_ NOT_ FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received. Once cancel is received,
the algorithm should transition back to INACTIVE and resume passive scan. Note that this behavior is not identical to CONTINUOUS_ PICTURE, since an ongoing PASSIVE_ SCAN must immediately be canceled. -
CONTINUOUS_PICTURE
In this mode,
the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream. The focusing behavior should be suitable for still image capture; typically this means focusing as fast as possible.
When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_ SCAN and PASSIVE_ FOCUSED states as appropriate as it attempts to maintain focus. When the AF trigger is activated, the algorithm should finish its PASSIVE_ SCAN if active, and then transition into AF_ FOCUSED or AF_ NOT_ FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received. When the AF cancel trigger is activated,
the algorithm should transition back to INACTIVE and then act as if it has just been started. -
EDOF
Extended depth of field (digital focus).
AF trigger is ignored, AF state should always be INACTIVE.
Whether AF is currently enabled,
Only effective if android.
If the lens is controlled by the camera device auto-focus algorithm,
List of areas to use for focus
estimation.
area_
Each area is a rectangle plus weight: xmin,
The coordinate system is based on the active pixel array,
If all regions have 0 weight,
-
INACTIVE
AF off or has not yet tried to scan/
been asked to scan. When a camera device is opened, it starts in this state. -
PASSIVE_SCAN
if CONTINUOUS_
* modes are supported. AF is currently doing an AF scan initiated by a continuous autofocus mode -
PASSIVE_FOCUSED
if CONTINUOUS_
* modes are supported. AF currently believes it is in focus, but may restart scanning at any time. -
ACTIVE_SCAN
if AUTO or MACRO modes are supported.
AF is doing an AF scan because it was triggered by AF trigger -
FOCUSED_LOCKED
if any AF mode besides OFF is supported.
AF believes it is focused correctly and is locked -
NOT_FOCUSED_LOCKED
if any AF mode besides OFF is supported.
AF has failed to focus successfully and is locked -
PASSIVE_UNFOCUSED
if CONTINUOUS_
* modes are supported. AF finished a passive scan without finding focus, and may restart scanning at any time.
Current state of AF algorithm
Switching between or enabling AF modes (android.android. resets all
the algorithm states to INACTIVE.
The camera device can do several state transitions between two results,
The state in the result is the state for this image (in sync with this image): if
AF state becomes FOCUSED,
Below are state transition tables for different AF modes.
When android.
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | INACTIVE | Never changes |
When android.
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | AF_ |
ACTIVE_ |
Start AF sweep, |
| ACTIVE_ |
AF sweep done | FOCUSED_ |
Focused, |
| ACTIVE_ |
AF sweep done | NOT_ |
Not focused, |
| ACTIVE_ |
AF_ |
INACTIVE | Cancel/ |
| FOCUSED_ |
AF_ |
INACTIVE | Cancel/ |
| FOCUSED_ |
AF_ |
ACTIVE_ |
Start new sweep, |
| NOT_ |
AF_ |
INACTIVE | Cancel/ |
| NOT_ |
AF_ |
ACTIVE_ |
Start new sweep, |
| Any state | Mode change | INACTIVE |
When android.
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | Camera device initiates new scan | PASSIVE_ |
Start AF scan, |
| INACTIVE | AF_ |
NOT_ |
AF state query, |
| PASSIVE_ |
Camera device completes current scan | PASSIVE_ |
End AF scan, |
| PASSIVE_ |
Camera device fails current scan | PASSIVE_ |
End AF scan, |
| PASSIVE_ |
AF_ |
FOCUSED_ |
Immediate trans. |
| PASSIVE_ |
AF_ |
NOT_ |
Immediate trans. |
| PASSIVE_ |
AF_ |
INACTIVE | Reset lens position, |
| PASSIVE_ |
Camera device initiates new scan | PASSIVE_ |
Start AF scan, |
| PASSIVE_ |
Camera device initiates new scan | PASSIVE_ |
Start AF scan, |
| PASSIVE_ |
AF_ |
FOCUSED_ |
Immediate trans. |
| PASSIVE_ |
AF_ |
NOT_ |
Immediate trans. |
| FOCUSED_ |
AF_ |
FOCUSED_ |
No effect |
| FOCUSED_ |
AF_ |
INACTIVE | Restart AF scan |
| NOT_ |
AF_ |
NOT_ |
No effect |
| NOT_ |
AF_ |
INACTIVE | Restart AF scan |
When android.
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | Camera device initiates new scan | PASSIVE_ |
Start AF scan, |
| INACTIVE | AF_ |
NOT_ |
AF state query, |
| PASSIVE_ |
Camera device completes current scan | PASSIVE_ |
End AF scan, |
| PASSIVE_ |
Camera device fails current scan | PASSIVE_ |
End AF scan, |
| PASSIVE_ |
AF_ |
FOCUSED_ |
Eventual trans. |
| PASSIVE_ |
AF_ |
NOT_ |
Eventual trans. |
| PASSIVE_ |
AF_ |
INACTIVE | Reset lens position, |
| PASSIVE_ |
Camera device initiates new scan | PASSIVE_ |
Start AF scan, |
| PASSIVE_ |
Camera device initiates new scan | PASSIVE_ |
Start AF scan, |
| PASSIVE_ |
AF_ |
FOCUSED_ |
Immediate trans. |
| PASSIVE_ |
AF_ |
NOT_ |
Immediate trans. |
| FOCUSED_ |
AF_ |
FOCUSED_ |
No effect |
| FOCUSED_ |
AF_ |
INACTIVE | Restart AF scan |
| NOT_ |
AF_ |
NOT_ |
No effect |
| NOT_ |
AF_ |
INACTIVE | Restart AF scan |
The ID sent with the latest
CAMERA2_
Deprecated.
Must be 0 if no CAMERA2_
-
OFF
The camera device's auto white balance routine is disabled; the application-selected color transform matrix (android.
color Correction. transform) and gains (android. color Correction. gains) are used by the camera device for manual white balance control. -
AUTO
The camera device's auto white balance routine is active; the application's values for android.
color Correction. transform and android. color Correction. gains are ignored. -
INCANDESCENT
The camera device's auto white balance routine is disabled; the camera device uses incandescent light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant A. -
FLUORESCENT
The camera device's auto white balance routine is disabled; the camera device uses fluorescent light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F2. -
WARM_FLUORESCENT
The camera device's auto white balance routine is disabled; the camera device uses warm fluorescent light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F4. -
DAYLIGHT
The camera device's auto white balance routine is disabled; the camera device uses daylight light as the assumed scene illumination for white balance.
While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant D65. -
CLOUDY_DAYLIGHT
The camera device's auto white balance routine is disabled; the camera device uses cloudy daylight light as the assumed scene illumination for white balance.
-
TWILIGHT
The camera device's auto white balance routine is disabled; the camera device uses twilight light as the assumed scene illumination for white balance.
-
SHADE
The camera device's auto white balance routine is disabled; the camera device uses shade light as the assumed scene illumination for white balance.
Whether AWB is currently setting the color
transform fields,
This control is only effective if android.
When set to the ON mode,
When set to the OFF mode,
When set to any other modes,
List of areas to use for illuminant
estimation.
area_
Only used in AUTO mode.
Each area is a rectangle plus weight: xmin,
The coordinate system is based on the active pixel array,
If all regions have 0 weight,
-
INACTIVE
AWB is not in auto mode.
When a camera device is opened, it starts in this state. -
SEARCHING
AWB doesn't yet have a good set of control values for the current scene.
-
CONVERGED
AWB has a good set of control values for the current scene.
-
LOCKED
AWB has been locked.
Current state of AWB algorithm
Switching between or enabling AWB modes (android.android. resets all
the algorithm states to INACTIVE.
The camera device can do several state transitions between two results,
The state in the result is the state for this image (in sync with this image): if
AWB state becomes CONVERGED,
Below are state transition tables for different AWB modes.
When android.:
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | INACTIVE | Camera device auto white balance algorithm is disabled |
When android.
| State | Transition Cause | New State | Notes |
|---|---|---|---|
| INACTIVE | Camera device initiates AWB scan | SEARCHING | Values changing |
| INACTIVE | android. |
LOCKED | Values locked |
| SEARCHING | Camera device finishes AWB scan | CONVERGED | Good values, |
| SEARCHING | android. |
LOCKED | Values locked |
| CONVERGED | Camera device initiates AWB scan | SEARCHING | Values changing |
| CONVERGED | android. |
LOCKED | Values locked |
| LOCKED | android. |
SEARCHING | Values not good after unlock |
| LOCKED | android. |
CONVERGED | Values good after unlock |
-
OFF
Full application control of pipeline.
All 3A routines are disabled, no other settings in android. control. * have any effect -
AUTO
Use settings for each individual 3A routine.
Manual control of capture parameters is disabled. All controls in android. control. * besides sceneMode take effect -
USE_SCENE_MODE
Use specific scene mode.
Enabling this disables control. aeMode, control. awbMode and control. afMode controls; the HAL must ignore those settings while USE_ SCENE_ MODE is active (except for FACE_ PRIORITY scene mode). Other control entries are still active. This setting can only be used if availableSceneModes != UNSUPPORTED -
OFF_KEEP_STATE
Same as OFF mode,
except that this capture will not be used by camera device background auto-exposure, auto-white balance and auto-focus algorithms to update their statistics.
Overall mode of 3A control routines
all must be supported
High-level 3A control.
When set to AUTO,
When set to USE_
When set to OFF_
-
FAST
Minimal or no slowdown of frame rate compared to Bayer RAW output
-
HIGH_QUALITY
High-quality may reduce output frame rate
Controls the quality of the demosaicing processing
-
OFF
No edge enhancement is applied
-
FAST
Must not slow down frame rate relative to sensor output
-
HIGH_QUALITY
Frame rate may be reduced by high quality
Operation mode for edge enhancement
Edge/
FAST/
Control the amount of edge enhancement applied to the images
-
OFF
No edge enhancement is applied
-
FAST
Must not slow down frame rate relative to sensor output
-
HIGH_QUALITY
Frame rate may be reduced by high quality
Operation mode for edge enhancement
Edge/
FAST/
Power for flash firing/
0 - 10
Power for snapshot may use a different scale than
for torch mode.
Firing time of flash relative to start of exposure
0-(exposure time-flash duration)
Clamped to (0,
-
OFF
Do not fire the flash for this capture.
-
SINGLE
If the flash is available and charged,
fire flash for this capture based on android. flash. firing Power and android. flash. firing Time. -
TORCH
Transition flash to continuously on.
The desired mode for for the camera device's flash control.
This control is only effective when flash unit is available
(android.).
When this control is used,
When set to OFF,
When set to SINGLE,
When set to TORCH,
The flash status will be reported by android.
- FALSE
- TRUE
Whether this camera device has a
flash.
If no flash,
Time taken before flash can fire again
0-1e9
1 second too long/
The x,
0-1 for both
Max energy output of the flash for a full power single flash
>= 0
Power for flash firing/
0 - 10
Power for snapshot may use a different scale than
for torch mode.
Firing time of flash relative to start of exposure
0-(exposure time-flash duration)
Clamped to (0,
-
OFF
Do not fire the flash for this capture.
-
SINGLE
If the flash is available and charged,
fire flash for this capture based on android. flash. firing Power and android. flash. firing Time. -
TORCH
Transition flash to continuously on.
The desired mode for for the camera device's flash control.
This control is only effective when flash unit is available
(android.).
When this control is used,
When set to OFF,
When set to SINGLE,
When set to TORCH,
The flash status will be reported by android.
-
UNAVAILABLE
No flash on camera
-
CHARGING
if android.
flash. info. available is true Flash is charging and cannot be fired -
READY
if android.
flash. info. available is true Flash is ready to fire -
FIRED
if android.
flash. info. available is true Flash fired for this capture
Current state of the flash
unit.
When the camera device doesn't have flash unit
(i.android.),
-
OFF
The frame rate must not be reduced relative to sensor raw output for this option.
No hot pixel correction is applied.
-
FAST
The frame rate must not be reduced relative to sensor raw output for this option.
Hot pixel correction is applied.
-
HIGH_QUALITY
The frame rate may be reduced relative to sensor raw output for this option.
A high-quality hot pixel correction is applied.
Set operational mode for hot pixel correction.
Hotpixel correction interpolates out,
List of (x, coordinates of hot/(x, lies between (0,,
n <= number of pixels on the sensor.(x, coordinates must be bounded by
android.
A hotpixel map contains the coordinates of pixels on the camera
sensor that do report valid values (usually due to defects in
the camera sensor).
To avoid performance issues,
-
OFF
The frame rate must not be reduced relative to sensor raw output for this option.
No hot pixel correction is applied.
-
FAST
The frame rate must not be reduced relative to sensor raw output for this option.
Hot pixel correction is applied.
-
HIGH_QUALITY
The frame rate may be reduced relative to sensor raw output for this option.
A high-quality hot pixel correction is applied.
Set operational mode for hot pixel correction.
Hotpixel correction interpolates out,
GPS coordinates to include in output JPEG EXIF
(-180 - 180],
32 characters describing GPS algorithm to include in EXIF
Time GPS fix was made to include in EXIF
Orientation of JPEG image to write
0,
Compression quality of the final JPEG image
1-100; larger is higher quality
85-95 is typical usage range
Compression quality of JPEG thumbnail
1-100; larger is higher quality
Resolution of embedded JPEG thumbnail
Size must be one of the size from android.
When set to (0,
When a jpeg image capture is issued,
Supported resolutions for the JPEG thumbnail
Will include at least one valid resolution,
Below condiditions will be satisfied for this size list:
- The sizes will be sorted by increasing pixel area (width x height).
If several resolutions have the same area, they will be sorted by increasing width. - The aspect ratio of the largest thumbnail size will be same as the
aspect ratio of largest JPEG output size in android.
scaler. available Stream Configurations. The largest size is defined as the size that has the largest pixel area in a given size list. - Each output JPEG size in android.
scaler. available Stream Configurations will have at least one corresponding size that has the same aspect ratio in availableThumbnailSizes, and vice versa. - All non (0,
0) sizes will have non-zero widths and heights.
Maximum size in bytes for the compressed JPEG buffer
Must be large enough to fit any JPEG produced by the camera
This is used for sizing the gralloc buffers for JPEG
GPS coordinates to include in output JPEG EXIF
(-180 - 180],
32 characters describing GPS algorithm to include in EXIF
Time GPS fix was made to include in EXIF
Orientation of JPEG image to write
0,
Compression quality of the final JPEG image
1-100; larger is higher quality
85-95 is typical usage range
The size of the compressed JPEG image,
>= 0
If no JPEG output is produced for the request,
Otherwise,
Compression quality of JPEG thumbnail
1-100; larger is higher quality
Resolution of embedded JPEG thumbnail
Size must be one of the size from android.
When set to (0,
When a jpeg image capture is issued,
The ratio of lens focal length to the effective
aperture diameter.
This will only be supported on the camera devices that
have variable aperture lens.
When this is supported and android.
The requested aperture value may take several frames to reach the
requested value; the camera device will report the current (intermediate)
aperture size in capture result metadata while the aperture is changing.
When this is supported and android.
State of lens neutral density filter(s).
This will not be supported on most camera devices.
Lens filters are typically used to lower the amount of light the
sensor is exposed to (measured in steps of EV).
It may take several frames before the lens filter density changes
to the requested value.
The current lens focal length; used for optical zoom.
This setting controls the physical focal length of the camera
device's lens.
Like android.
This is expected not to be supported on most devices.
Distance to plane of sharpest focus,
>= 0
0 means infinity focus.
Like android.
-
OFF
Optical stabilization is unavailable.
-
ON
optional
Optical stabilization is enabled.
Sets whether the camera device uses optical image stabilization (OIS)
when capturing images.
OIS is used to compensate for motion blur due to small movements of
the camera during capture.
This is not expected to be supported on most devices.
List of supported aperture
values.
one entry required,
If the camera device doesn't support variable apertures,
If the camera device supports variable apertures,
List of supported neutral density filter values for
android.
At least one value is required.
If changing android.
The available focal lengths for this device for use with
android.
Each value in this list must be > 0.
If optical zoom is not supported,
List containing a subset of the optical image
stabilization (OIS) modes specified in
android.
If OIS is not implemented for a given camera device,
Optional.
>= 0
If the lens is fixed focus,
If the lens is not fixed focus,
Shortest distance from frontmost surface
of the lens that can be focused correctly.
>= 0
If the lens is fixed-focus,
Dimensions of lens shading map.
Both values >= 1
The map should be on the order of 30-40 rows and columns,
-
UNCALIBRATED
The lens focus distance is not accurate,
and the units used for android. lens. focus Distance do not correspond to any physical units. Setting the lens to the same focus distance on separate occasions may result in a different real focus distance, depending on factors such as the orientation of the device, the age of the focusing mechanism, and the device temperature. The focus distance value will still be in the range of [0,,android. lens. info. minimum Focus Distance] where 0 represents the farthest focus. -
APPROXIMATE
The lens focus distance is measured in diopters.
However, setting the lens to the same focus distance on separate occasions may result in a different real focus distance, depending on factors such as the orientation of the device, the age of the focusing mechanism, and the device temperature. -
CALIBRATED
The lens focus distance is measured in diopters.
The lens mechanism is calibrated so that setting the same focus distance is repeatable on multiple occasions with good accuracy, and the focus distance corresponds to the real physical distance to the plane of best focus.
The lens focus distance calibration quality.
The lens focus distance calibration quality determines the reliability of
focus related metadata entries,
- FRONT
- BACK
Direction the camera faces relative to device screen
Relative angle of camera optical axis to the perpendicular axis from the display
[0-90) for first angle,
Examples:
(0,
(45,
(45,
Use FACING field to determine perpendicular outgoing direction
Coordinates of camera optical axis on device
The ratio of lens focal length to the effective
aperture diameter.
This will only be supported on the camera devices that
have variable aperture lens.
When this is supported and android.
The requested aperture value may take several frames to reach the
requested value; the camera device will report the current (intermediate)
aperture size in capture result metadata while the aperture is changing.
When this is supported and android.
State of lens neutral density filter(s).
This will not be supported on most camera devices.
Lens filters are typically used to lower the amount of light the
sensor is exposed to (measured in steps of EV).
It may take several frames before the lens filter density changes
to the requested value.
The current lens focal length; used for optical zoom.
This setting controls the physical focal length of the camera
device's lens.
Like android.
This is expected not to be supported on most devices.
Distance to plane of sharpest focus,
>= 0
Should be zero for fixed-focus cameras
The range of scene distances that are in sharp focus (depth of field)
>=0
If variable focus not supported,
-
OFF
Optical stabilization is unavailable.
-
ON
optional
Optical stabilization is enabled.
Sets whether the camera device uses optical image stabilization (OIS)
when capturing images.
OIS is used to compensate for motion blur due to small movements of
the camera during capture.
This is not expected to be supported on most devices.
-
STATIONARY
The lens parameters (android.
lens. focal Length, android. lens. focus Distance android. lens. filter Density and android. lens. aperture) are not changing. -
MOVING
Any of the lens parameters (android.
lens. focal Length, android. lens. focus Distance android. lens. filter Density or android. lens. aperture) is changing.
Current lens status.
For lens parameters android.
When the state is STATIONARY,
- Fixed focus (
android.),lens. info. minimum Focus Distance == 0 which means android. lens. focus Distance parameter will always be 0. - Fixed focal length (android.
lens. info. available Focal Lengths contains single value), which means the optical zoom is not supported. - No ND filter (android.
lens. info. available Filter Densities contains only 0). - Fixed aperture (android.
lens. info. available Apertures contains single value).
Then this state will always be STATIONARY.
When the state is MOVING,
-
OFF
No noise reduction is applied
-
FAST
Must not slow down frame rate relative to sensor output
-
HIGH_QUALITY
May slow down frame rate to provide highest quality
Mode of operation for the noise reduction algorithm
android.
Noise filtering control.
FAST/
Control the amount of noise reduction applied to the images
1 - 10
-
OFF
No noise reduction is applied
-
FAST
Must not slow down frame rate relative to sensor output
-
HIGH_QUALITY
May slow down frame rate to provide highest quality
Mode of operation for the noise reduction algorithm
android.
Noise filtering control.
FAST/
If set to 1,
Deprecated.
Normalized coordinates refer to those in the
(-1000,
HAL implementations should instead always use and emit
sensor array-relative coordinates for all region data.
If set to 1,
Deprecated.
HAL implementations should implement AF trigger
modes for AUTO,
If set to 1,
Deprecated.
HAL implementations should use gralloc usage flags
to determine that a stream will be used for
zero-shutter-lag,
If set to 1,
Deprecated.
Does not need to be listed in static
metadata.
Refer to camera3_
for information on how to implement partial results.
-
FINAL
The last or only metadata result buffer for this capture.
-
PARTIAL
A partial buffer of result metadata for this capture.
More result buffers for this capture will be sent by the HAL, the last of which will be marked FINAL.
Whether a result given to the framework is the
final one for the capture,
Deprecated.
The entries in the result metadata buffers for a
single capture may not overlap,
Refer to camera3_
for information on how to implement partial results.
A frame counter set by the framework.
Deprecated.
An application-specified ID for the current
request.
Any int
List which camera reprocess stream is used
for the source of reprocessing data.
Deprecated.
Typically,
If android.
Only meaningful when android.
-
NONE
No metadata should be produced on output,
except for application-bound buffer data. If no application-bound streams exist, no frame should be placed in the output frame queue. If such streams exist, a frame should be placed on the output queue with null metadata but with the necessary output buffer information. Timestamp information should still be included with any output stream buffers -
FULL
All metadata should be produced.
Statistics will only be produced if they are separately enabled
How much metadata to produce on output
Lists which camera output streams image data from this capture must be sent to
Deprecated.
If no output streams are listed,
-
CAPTURE
Capture a new image from the imaging hardware,
and process it according to the settings -
REPROCESS
Process previously captured data; the android.
request. input Stream parameter determines the source reprocessing stream. TODO: Mark dynamic metadata needed for reprocessing with [RP]
The type of the request; either CAPTURE or
REPROCESS.
The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device.
>= 1 for JPEG-compressed format streams.
>= 0 for Raw format streams.
>= 3 for processed,
This is a 3 element tuple that contains the max number of output simultaneous
streams for raw sensor,(1,.
This lists the upper bound of the number of output streams supported by
the camera device.
- JPEG-compressed format: BLOB.
- Raw formats: RAW_
SENSOR and RAW_ OPAQUE. - processed,
uncompressed formats: YCb Cr_ 420_ 888, YCr Cb_ 420_ SP, YV12.
How many reprocessing streams of any type
can be allocated at the same time.
>= 0
Deprecated.
When set to 0,
The maximum numbers of any type of input streams
that can be configured and used simultaneously by a camera device.
>= 0 for LIMITED mode device (android.).android.).
When set to 0,
The image format for a input stream can be any supported format provided
by android.
For example,
Specifies the number of maximum pipeline stages a frame
has to go through from when it's exposed to when it's available
to the framework.
A typical minimum value for this is 2 (one stage to expose,
Depending on what settings are used (e.
A pipeline depth of X stages is equivalent to a pipeline latency of
X frame intervals.
This value will be 8 or less.
This value should be 4 or less.
Optional.
>= 1
In order to combat the pipeline latency,
A value of 1 means that partial results are not supported.
A typical use case for this might be: after requesting an AF lock the
new AF state might be available 50% of the way through the pipeline.
-
BACKWARD_COMPATIBLE
The minimal set of capabilities that every camera device (regardless of android.
info. supported Hardware Level) will support. The full set of features supported by this capability makes the camera2 api backwards compatible with the camera1 (android.
hardware. Camera) API. TODO: @hide this.
Doesn't really mean anything except act as a catch-all for all the 'base' functionality. -
OPTIONAL
This is a catch-all capability to include all other tags or functionality not encapsulated by one of the other capabilities.
A typical example is all tags marked 'optional'.
TODO: @hide.
We may not need this if we @hide all the optional tags not belonging to a capability. -
MANUAL_SENSOR
The camera device can be manually controlled (3A algorithms such as auto exposure,
and auto focus can be bypassed), this includes but is not limited to: - Manual exposure control
- Manual sensitivity control
- Manual lens control
- android.
lens. *
- android.
- Manual flash control
- android.
flash. *
- android.
- Manual black level locking
If any of the above 3A algorithms are enabled,
then the camera device will accurately report the values applied by 3A in the result. -
GCAM
optional
TODO: This should be @hide
- Manual tonemap control
- Manual white balance control
- Lens shading map information
If auto white balance is enabled,
then the camera device will accurately report the values applied by AWB in the result. The camera device will also support everything in MANUAL_
SENSOR except manual lens control and manual flash control. -
ZSL
The camera device supports the Zero Shutter Lag use case.
- At least one input stream can be used.
- RAW_
OPAQUE is supported as an output/ input format - Using RAW_
OPAQUE does not cause a frame rate drop relative to the sensor's maximum capture rate (at that resolution). - RAW_
OPAQUE will be reprocessable into both YUV_ 420_ 888 and JPEG formats. - The maximum available resolution for RAW_
OPAQUE streams (both input/ output) will match the maximum available resolution of JPEG streams.
- At least one input stream can be used.
-
DNG
optional
The camera device supports outputting RAW buffers that can be saved offline into a DNG format.
It can reprocess DNG files (produced from the same camera device) back into YUV. - At least one input stream can be used.
- RAW16 is supported as output/
input format. - RAW16 is reprocessable into both YUV_
420_ 888 and JPEG formats. - The maximum available resolution for RAW16 streams (both
input/
output) will match the value in android. sensor. info. pixel Array Size. - All DNG-related optional metadata entries are provided
by the camera device.
- At least one input stream can be used.
List of capabilities that the camera device
advertises as fully supporting.
A capability is a contract that the camera device makes in order
to be able to satisfy one or more use cases.
Listing a capability guarantees that the whole set of features
required to support a common use will all be available.
Using a subset of the functionality provided by an unsupported
capability may be possible on a specific camera device implementation;
to do this query each of android.
XX: Maybe these should go into android.
The following capabilities are guaranteed to be available on
android.== FULL devices:
- MANUAL_
SENSOR - ZSL
Other capabilities may be available on either FULL or LIMITED
devices,
Additional constraint details per-capability will be available
in the Compatibility Test Suite.
BACKWARD_
Listed controls that can be either request or result (e.
For example,
A list of all keys that the camera device has available
to use with CaptureRequest.
Attempting to set a key into a CaptureRequest that is not
listed here will result in an invalid request and will be rejected
by the camera device.
This field can be used to query the feature set of a camera device
at a more granular level than capabilities.
TODO: This should be used by #getAvailableCaptureRequestKeys.
Vendor tags must not be listed here.
Setting/
The HAL must not consume any request tags that are not listed either
here or in the vendor tag list.
The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getAvailableCaptureRequestKeys.
A list of all keys that the camera device has available
to use with CaptureResult.
Attempting to get a key from a CaptureResult that is not
listed here will always return a null value.null
value.
The following keys may return null unless they are enabled:
- android.
statistics. lens Shading Map (non-null iff android. statistics. lens Shading Map Mode == ON)
(Those sometimes-null keys should nevertheless be listed here
if they are available.
This field can be used to query the feature set of a camera device
at a more granular level than capabilities.
TODO: This should be used by #getAvailableCaptureResultKeys.
Tags listed here must always have an entry in the result metadata,
Vendor tags must not be listed here.
Setting/
The HAL must not produce any result tags that are not listed either
here or in the vendor tag list.
The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getAvailableCaptureResultKeys.
A list of all keys that the camera device has available
to use with CameraCharacteristics.
This entry follows the same rules as
android.
TODO: This should be used by CameraCharacteristics#getKeys.
Tags listed here must always have an entry in the static info metadata,
Vendor tags must not be listed here.
Setting/
The HAL must not have any tags in its static info that are not listed
either here or in the vendor tag list.
The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getKeys.
A frame counter set by the framework.
> 0
Reset on release()
An application-specified ID for the current
request.
Any int
-
NONE
No metadata should be produced on output,
except for application-bound buffer data. If no application-bound streams exist, no frame should be placed in the output frame queue. If such streams exist, a frame should be placed on the output queue with null metadata but with the necessary output buffer information. Timestamp information should still be included with any output stream buffers -
FULL
All metadata should be produced.
Statistics will only be produced if they are separately enabled
How much metadata to produce on output
Lists which camera output streams image data from this capture must be sent to
Deprecated.
If no output streams are listed,
Specifies the number of pipeline stages the frame went
through from when it was exposed to when the final completed result
was available to the framework.
Depending on what settings are used in the request,
See android.
This value must always represent the accurate count of how many
pipeline stages were actually used.
(x,
A rectangle with the top-level corner of (x,
HAL2.
Any additional per-stream cropping must be done to
maximize the final pixel area of the stream.
For example,
Conversely,
The output streams must maintain square pixels at all
times,
-
RAW16
optional
0x20
RAW16 is a standard,
cross-platform format for raw image buffers with 16-bit pixels. Buffers of this format are typically expected to have a Bayer Color Filter Array (CFA) layout, which is given in android. sensor. info. color Filter Arrangement. Sensors with CFAs that are not representable by a format in android. sensor. info. color Filter Arrangement should not use this format. Buffers of this format will also follow the constraints given for RAW_
OPAQUE buffers, but with relaxed performance constraints. See android.
scaler. available Input Formats for the full set of performance guarantees. -
RAW_OPAQUE
optional
0x24
RAW_
OPAQUE is a format for raw image buffers coming from an image sensor. The actual structure of buffers of this format is platform-specific, but must follow several constraints: - No image post-processing operations may have been applied to
buffers of this type.
These buffers contain raw image data coming directly from the image sensor. - If a buffer of this format is passed to the camera device for
reprocessing,
the resulting images will be identical to the images produced if the buffer had come directly from the sensor and was processed with the same settings.
The intended use for this format is to allow access to the native raw format buffers coming directly from the camera sensor without any additional conversions or decrease in framerate.
See android.
scaler. available Input Formats for the full set of performance guarantees. - No image post-processing operations may have been applied to
buffers of this type.
-
YV12
optional
0x32315659
YCrCb 4:2:0 Planar
-
YCrCb_420_SP
optional
0x11
NV21
-
IMPLEMENTATION_DEFINED
0x22
System internal format,
not application-accessible -
YCbCr_420_888
0x23
Flexible YUV420 Format
-
BLOB
0x21
JPEG format
The list of image formats that are supported by this
camera device for output streams.
All camera devices will support JPEG and YUV_
When set to YUV_
These format values are from HAL_
When IMPLEMENTATION_
YCb
The BLOB format must be supported by the HAL.
A RAW_
The minimum frame duration that is supported
for each resolution in android.
Deprecated.
This corresponds to the minimum steady-state frame duration when only
that JPEG stream is active and captured in a burst,
When multiple streams are configured,
The JPEG resolutions that are supported by this camera device.
Deprecated.
The resolutions are listed as (width, pairs.
The HAL must include sensor maximum resolution
(defined by android.
The maximum ratio between active area width
and crop region width,
>=1
For each available processed output size (defined in
android.
Deprecated.
This should correspond to the frame duration when only that processed
stream is active,
When multiple streams are configured,
The resolutions available for use with
processed output streams,
Deprecated.
The resolutions are listed as (width, pairs.
For a given use case,
Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.
For FULL capability devices (android.),
- 240p (320 x 240)
- 480p (640 x 480)
- 720p (1280 x 720)
- 1080p (1920 x 1080)
For LIMITED capability devices (android.),
For each available raw output size (defined in
android.
Deprecated.
Should correspond to the frame duration when only the raw stream is
active.
When multiple streams are configured,
The resolutions available for use with raw
sensor output streams,
Deprecated.
The mapping of image formats that are supported by this
camera device for input streams,
See android.
All camera devices with at least 1
android.
The camera device will support the following map of formats,
| Input Format | Output Format | Capability |
|---|---|---|
| RAW_ |
JPEG | ZSL |
| RAW_ |
YUV_ |
ZSL |
| RAW_ |
RAW16 | DNG |
| RAW16 | YUV_ |
DNG |
| RAW16 | JPEG | DNG |
For ZSL-capable camera devices,
Attempting to configure an input stream with output streams not
listed as available in this map is not valid.
TODO: Add java type mapping for this property.
This value is encoded as a variable-size array-of-arrays.[format, where
... has length elements.
A code sample to read/
//If the HAL claims to support any of the capabilities listed in the
above details,
Refer to android.
- OUTPUT
- INPUT
The available stream configurations that this
camera device supports
(i.
The configurations are listed as (format,
tuples.
All camera devices will support sensor maximum resolution (defined by
android.
For a given use case,
Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.
Not all output formats may be supported in a configuration with
an input stream of a particular format.
The following table describes the minimum required output stream
configurations based on the hardware level
(android.
| Format | Size | Hardware Level | Notes |
|---|---|---|---|
| JPEG | android. |
Any | |
| JPEG | 1920x1080 (1080p) | Any | if 1080p <= activeArraySize |
| JPEG | 1280x720 (720) | Any | if 720p <= activeArraySize |
| JPEG | 640x480 (480p) | Any | if 480p <= activeArraySize |
| JPEG | 320x240 (240p) | Any | if 240p <= activeArraySize |
| YUV_ |
all output sizes available for JPEG | FULL | |
| YUV_ |
all output sizes available for JPEG, |
LIMITED | |
| IMPLEMENTATION_ |
same as YUV_ |
Any |
Refer to android.
It is recommended (but not mandatory) to also include half/
(The following is a rewording of the above required table):
The HAL must include sensor maximum resolution (defined by
android.
For FULL capability devices (android.),
It must also include each below resolution if it is smaller than or
equal to the sensor maximum resolution (for both YUV_
- 240p (320 x 240)
- 480p (640 x 480)
- 720p (1280 x 720)
- 1080p (1920 x 1080)
For LIMITED capability devices
(android.),
Regardless of hardware level,
This supercedes the following fields,
- availableFormats
- available[Processed,
Raw, Jpeg]Sizes
This lists the minimum frame duration for each
format/
This should correspond to the frame duration when only that
stream is active,
When multiple streams are used in a request,
The minimum frame duration of a stream (of a particular format,
See android.
This lists the maximum stall duration for each
format/
A stall duration is how much extra time would get added
to the normal minimum frame duration for a repeating request
that has streams with non-zero stall.
For example,
- JPEG streams act like processed YUV streams in requests for which
they are not included; in requests in which they are directly
referenced,
they act as JPEG streams. This is because supporting a JPEG stream requires the underlying YUV data to always be ready for use by a JPEG encoder, but the encoder will only be used (and impact frame duration) on requests that actually reference a JPEG stream. - The JPEG processor can run concurrently to the rest of the camera
pipeline,
but cannot process more than 1 capture at a time.
In other words,
In general,
Submitting a repeating request with streams (call this S)
is the same as setting the minimum frame duration from
the normal minimum frame duration corresponding to S,S.
If interleaving requests with and without a stall duration,
This means that a stalling request will not have an exposure start
until the stall has completed.
This should correspond to the stall duration when only that stream is
active,
The following formats may always have a stall duration:
- JPEG
- RAW16
The following formats will never have a stall duration:
- YUV_
420_ 888 - IMPLEMENTATION_
DEFINED
All other formats may or may not have an allowed stall duration on
a per-capability basis; refer to android.
See android.
If possible,
(x,
A rectangle with the top-level corner of (x,
HAL2.
Any additional per-stream cropping must be done to
maximize the final pixel area of the stream.
For example,
Conversely,
The output streams must maintain square pixels at all
times,
Duration each pixel is exposed to
light.
If the sensor can't expose this exact duration,
1/
Duration from start of frame exposure to
start of next frame exposure.
See android.max(duration,.
The maximum frame rate that can be supported by a camera subsystem is a function of many factors:
- Requested resolutions of output image streams
- Availability of binning /
skipping modes on the imager - The bandwidth of the imager interface
- The bandwidth of the various ISP processing blocks
Since these factors can vary greatly between different ISPs and
sensors,
The model presented has the following characteristics:
- The image sensor is always configured to output the smallest
resolution possible given the application's requested output stream
sizes.
The smallest resolution is defined as being at least as large as the largest requested output stream size; the camera pipeline must never digitally upsample sensor data when the crop region covers the whole sensor. In general, this means that if only small output stream resolutions are configured, the sensor can provide a higher frame rate. - Since any request may use any or all the currently configured
output streams,
the sensor and ISP must be configured to support scaling a single capture to all the streams at the same time. This means the camera pipeline must be ready to produce the largest requested output size without any delay. Therefore, the overall frame rate of a given configured stream set is governed only by the largest requested stream resolution. - Using more than one output stream in a request does not affect the
frame duration.
- Certain format-streams may need to do additional background processing
before data is consumed/
produced by that stream. These processors can run concurrently to the rest of the camera pipeline, but cannot process more than 1 capture at a time.
The necessary information for the application,
Specifically,
- Let the set of currently configured input/
output streams be called S. - Find the minimum frame durations for each stream in
S,by looking it up in android. scaler. available Min Frame Durations (with its respective size/ format). Let this set of frame durations be called F. - For any given request
R,the minimum frame duration allowed for Ris the maximum out of all values inF.Let the streams used in Rbe calledS_.r
If none of the streams in S_ have a stall time (listed in
android.F determines the steady state frame rate that the application will
get if it uses R as a repeating request.Rsimple.
A repeating request Rsimple can be occasionally interleaved
by a single capture of a new request Rstall (which has at least
one in-use stream with a non-0 stall time) and if Rstall has the
same minimum frame duration this will not cause a frame rate loss
if all buffers from the previous Rstall have already been
delivered.
For more details about stalling,
Gain applied to image data.
If the sensor can't apply this exact gain,
ISO 12232:2006 REI method
A pixel [R, that supplies the test pattern
when android.
Optional.
Each color channel is treated as an unsigned 32-bit integer.
For example,
-
OFF
Default.
No test pattern mode is used, and the camera device returns captures from the image sensor. -
SOLID_COLOR
Each pixel in
[R,is replaced by its respective color channel provided in android.G_ even, G_ odd, B] sensor. test Pattern Data. For example:
android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0] All green pixels are 100% green.
All red/ blue pixels are black. android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0] All red pixels are 100% red.
Only the odd green pixels are 100% green. All blue pixels are 100% black. -
COLOR_BARS
All pixel data is replaced with an 8-bar color pattern.
The vertical bars (left-to-right) are as follows:
- 100% white
- yellow
- cyan
- green
- magenta
- red
- blue
- black
In general the image would look like the following:
W Y C G M R B K W Y C G M R B K W Y C G M R B K W Y C G M R B K W Y C G M R B K .. . . . . . . . . . . . . . . . . . . . . . . (B = Blue, K = Black) Each bar should take up 1/
8 of the sensor pixel array width. When this is not possible, the bar size should be rounded down to the nearest integer and the pattern can repeat on the right side. Each bar's height must always take up the full sensor pixel array height.
Each pixel in this test pattern must be set to either 0% intensity or 100% intensity.
-
COLOR_BARS_FADE_TO_GRAY
The test pattern is similar to COLOR_
BARS, except that each bar should start at its specified color at the top, and fade to gray at the bottom. Furthermore each bar is further subdivided into a left and right half.
The left half should have a smooth gradient, and the right half should have a quantized gradient. In particular,
the right half's should consist of blocks of the same color for 1/ 16th active sensor pixel array width. The least significant bits in the quantized gradient should be copied from the most significant bits of the smooth gradient.
The height of each bar should always be a multiple of 128.
When this is not the case, the pattern should repeat at the bottom of the image. -
PN9
All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typically implemented in hardware with a linear feedback shift register).
The generator should be reset at the beginning of each frame,
and thus each subsequent raw frame with this test pattern should be exactly the same as the last. -
CUSTOM1
256
The first custom test pattern.
All custom patterns that are available only on this camera device are at least this numeric value. All of the custom test patterns will be static (that is the raw image must not vary from frame to frame).
When enabled,
Optional.
When a test pattern is enabled,
For example,
All test patterns are specified in the Bayer domain.
The HAL may choose to substitute test patterns from the sensor
with test patterns from on-device memory.
Area of raw data which corresponds to only
active pixels.
This array contains (xmin,.(xmin, must be
>= (0,.(width, must be <=
android..
It is smaller or equal to
sensor full pixel array,
Range of valid sensitivities
Min <= 100,
- RGGB
- GRBG
- GBRG
- BGGR
-
RGB
Sensor is not Bayer; output has 3 16-bit values for each pixel,
instead of just 1 16-bit value per pixel.
Arrangement of color filters on sensor;
represents the colors in the top-left 2x2 section of
the sensor,
Range of valid exposure
times used by android.
Min <= 100e3 (100 us),
The maximum of the range must be at least
1 second.
Maximum possible frame duration (minimum frame
rate).
>= 30e9
The largest possible android.
Refer to
android.
This value must be at least 1 second.
android.
Available minimum frame durations for JPEG must be no greater
than that of the YUV_
Since JPEG processing is considered offline and can take longer than
a single uncompressed capture,
The physical dimensions of the full pixel array
Needed for FOV calculation for old API
Dimensions of full pixel array,
Maximum output resolution for raw format must
match this in
android.
Maximum raw value output by sensor
> 1024 (10-bit output)
Defines sensor bit depth (10-14 bits is expected)
Gain factor from electrons to raw units when ISO=100
A fixed black level offset for each of the color filter arrangement
(CFA) mosaic channels.
>= 0 for each.
This tag specifies the zero light value for each of the CFA mosaic
channels in the camera sensor.
The values are given in row-column scan order,
Maximum sensitivity that is implemented
purely through analog gain.
For android.
Clockwise angle through which the output
image needs to be rotated to be upright on the device
screen in its native orientation.
0,
The number of input samples for each dimension of
android.
Hue >= 1,
The number of input samples for the hue,
Optional.
Must include OFF.
Duration each pixel is exposed to
light.
If the sensor can't expose this exact duration,
1/
Duration from start of frame exposure to
start of next frame exposure.
See android.max(duration,.
The maximum frame rate that can be supported by a camera subsystem is a function of many factors:
- Requested resolutions of output image streams
- Availability of binning /
skipping modes on the imager - The bandwidth of the imager interface
- The bandwidth of the various ISP processing blocks
Since these factors can vary greatly between different ISPs and
sensors,
The model presented has the following characteristics:
- The image sensor is always configured to output the smallest
resolution possible given the application's requested output stream
sizes.
The smallest resolution is defined as being at least as large as the largest requested output stream size; the camera pipeline must never digitally upsample sensor data when the crop region covers the whole sensor. In general, this means that if only small output stream resolutions are configured, the sensor can provide a higher frame rate. - Since any request may use any or all the currently configured
output streams,
the sensor and ISP must be configured to support scaling a single capture to all the streams at the same time. This means the camera pipeline must be ready to produce the largest requested output size without any delay. Therefore, the overall frame rate of a given configured stream set is governed only by the largest requested stream resolution. - Using more than one output stream in a request does not affect the
frame duration.
- Certain format-streams may need to do additional background processing
before data is consumed/
produced by that stream. These processors can run concurrently to the rest of the camera pipeline, but cannot process more than 1 capture at a time.
The necessary information for the application,
Specifically,
- Let the set of currently configured input/
output streams be called S. - Find the minimum frame durations for each stream in
S,by looking it up in android. scaler. available Min Frame Durations (with its respective size/ format). Let this set of frame durations be called F. - For any given request
R,the minimum frame duration allowed for Ris the maximum out of all values inF.Let the streams used in Rbe calledS_.r
If none of the streams in S_ have a stall time (listed in
android.F determines the steady state frame rate that the application will
get if it uses R as a repeating request.Rsimple.
A repeating request Rsimple can be occasionally interleaved
by a single capture of a new request Rstall (which has at least
one in-use stream with a non-0 stall time) and if Rstall has the
same minimum frame duration this will not cause a frame rate loss
if all buffers from the previous Rstall have already been
delivered.
For more details about stalling,
Gain applied to image data.
If the sensor can't apply this exact gain,
ISO 12232:2006 REI method
Time at start of exposure of first row
> 0
Monotonic,
The temperature of the sensor,
The thermal diode being queried should be inside the sensor PCB,
Optional.
- DAYLIGHT 1
- FLUORESCENT 2
-
TUNGSTEN
3
Incandescent light
- FLASH 4
- FINE_WEATHER 9
- CLOUDY_WEATHER 10
- SHADE 11
-
DAYLIGHT_FLUORESCENT
12
D 5700 - 7100K
-
DAY_WHITE_FLUORESCENT
13
N 4600 - 5400K
-
COOL_WHITE_FLUORESCENT
14
W 3900 - 4500K
-
WHITE_FLUORESCENT
15
WW 3200 - 3700K
- STANDARD_A 17
- STANDARD_B 18
- STANDARD_C 19
- D55 20
- D65 21
- D75 22
- D50 23
- ISO_STUDIO_TUNGSTEN 24
A reference illumination source roughly matching the current scene
illumination,
The values in this tag correspond to the values defined for the
EXIF LightSource tag.
A per-device calibration transform matrix to be applied after the
color space transform when rendering the raw image buffer.
This matrix is expressed as a 3x3 matrix in row-major-order,
A matrix that transforms color values from CIE XYZ color space to
reference camera color space when rendering the raw image buffer.
This matrix is expressed as a 3x3 matrix in row-major-order,
A matrix that transforms white balanced camera colors to the CIE XYZ
colorspace with a D50 whitepoint.
This matrix is expressed as a 3x3 matrix in row-major-order,
The estimated white balance at the time of capture.
The estimated white balance encoded as the RGB values of the
perfectly neutral color point in the linear native sensor color space.
A mapping containing a hue shift,
hue_
Each entry of this map contains three floats corresponding to the
hue shift,
A list of x,
Each sample has an input range of [0, and an output range of
[0,.(0,,(1,.
This tag contains a default tone curve that can be applied while
processing the image as a starting point for user adjustments.
-
OFF
Default.
No test pattern mode is used, and the camera device returns captures from the image sensor. -
SOLID_COLOR
Each pixel in
[R,is replaced by its respective color channel provided in android.G_ even, G_ odd, B] sensor. test Pattern Data. For example:
android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0] All green pixels are 100% green.
All red/ blue pixels are black. android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0] All red pixels are 100% red.
Only the odd green pixels are 100% green. All blue pixels are 100% black. -
COLOR_BARS
All pixel data is replaced with an 8-bar color pattern.
The vertical bars (left-to-right) are as follows:
- 100% white
- yellow
- cyan
- green
- magenta
- red
- blue
- black
In general the image would look like the following:
W Y C G M R B K W Y C G M R B K W Y C G M R B K W Y C G M R B K W Y C G M R B K .. . . . . . . . . . . . . . . . . . . . . . . (B = Blue, K = Black) Each bar should take up 1/
8 of the sensor pixel array width. When this is not possible, the bar size should be rounded down to the nearest integer and the pattern can repeat on the right side. Each bar's height must always take up the full sensor pixel array height.
Each pixel in this test pattern must be set to either 0% intensity or 100% intensity.
-
COLOR_BARS_FADE_TO_GRAY
The test pattern is similar to COLOR_
BARS, except that each bar should start at its specified color at the top, and fade to gray at the bottom. Furthermore each bar is further subdivided into a left and right half.
The left half should have a smooth gradient, and the right half should have a quantized gradient. In particular,
the right half's should consist of blocks of the same color for 1/ 16th active sensor pixel array width. The least significant bits in the quantized gradient should be copied from the most significant bits of the smooth gradient.
The height of each bar should always be a multiple of 128.
When this is not the case, the pattern should repeat at the bottom of the image. -
PN9
All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typically implemented in hardware with a linear feedback shift register).
The generator should be reset at the beginning of each frame,
and thus each subsequent raw frame with this test pattern should be exactly the same as the last. -
CUSTOM1
256
The first custom test pattern.
All custom patterns that are available only on this camera device are at least this numeric value. All of the custom test patterns will be static (that is the raw image must not vary from frame to frame).
When enabled,
Optional.
When a test pattern is enabled,
For example,
All test patterns are specified in the Bayer domain.
The HAL may choose to substitute test patterns from the sensor
with test patterns from on-device memory.
-
OFF
No lens shading correction is applied
-
FAST
Must not slow down frame rate relative to sensor raw output
-
HIGH_QUALITY
Frame rate may be reduced by high quality
Quality of lens shading correction applied
to the image data.
When set to OFF mode,android..android.,
[ 1.When set to other modes,
Control the amount of shading correction applied to the images
-
OFF
No lens shading correction is applied
-
FAST
Must not slow down frame rate relative to sensor raw output
-
HIGH_QUALITY
Frame rate may be reduced by high quality
Quality of lens shading correction applied
to the image data.
When set to OFF mode,android..android.,
[ 1.When set to other modes,
- OFF
-
SIMPLE
Optional Return rectangle and confidence only
-
FULL
Optional Return all face metadata
State of the face detector unit
Whether face detection is enabled,
- OFF
- ON
Operating mode for histogram generation
- OFF
- ON
Operating mode for sharpness map generation
- OFF
- ON
Whether the HAL needs to output the lens shading map in output result metadata
When set to ON,
Which face detection modes are available,
OFF means face detection is disabled,
SIMPLE means the device supports the
android.
FULL means the device additionally supports the
android.
Number of histogram buckets supported
>= 64
Maximum number of simultaneously detectable faces
>= 4 if availableFaceDetectionModes lists
modes besides OFF,
Maximum value possible for a histogram bucket
Maximum value possible for a sharpness map
region.
Dimensions of the sharpness map
Must be at least 32 x 32
- OFF
-
SIMPLE
Optional Return rectangle and confidence only
-
FULL
Optional Return all face metadata
State of the face detector unit
Whether face detection is enabled,
List of unique IDs for detected faces
Only available if faceDetectMode == FULL
List of landmarks for detected faces
Only available if faceDetectMode == FULL
List of the bounding rectangles for detected faces
Only available if faceDetectMode != OFF
List of the face confidence scores for detected faces
1-100
Only available if faceDetectMode != OFF.
A 3-channel histogram based on the raw sensor data
The k'th bucket (0-based) covers the input range
(with w = android.
- OFF
- ON
Operating mode for histogram generation
A 3-channel sharpness map,
If only a monochrome sharpness map is supported,
- OFF
- ON
Operating mode for sharpness map generation
The shading map is a low-resolution floating-point map
that lists the coefficients used to correct for vignetting,
Each gain factor is >= 1
The least shaded section of the image should have a gain factor
of 1; all other sections should have gains above 1.
When android.
The shading map is for the entire active pixel array,
The channel order is [R,
The shading map should have on the order of 30-40 rows and columns,
As an example,
android.The low-resolution scaling map images for each channel are (displayed using nearest-neighbor interpolation):
As a visualization only,
The best-fit color channel gains calculated by the HAL's statistics units for the current output frame
Deprecated.
This may be different than the gains used for this frame,
The 4 channel gains are defined in Bayer domain,
This value should always be calculated by the AWB block,
The best-fit color transform matrix estimate calculated by the HAL's statistics units for the current output frame
Deprecated.
The HAL must provide the estimate from its
statistics unit on the white balance transforms to use
for the next frame.
These estimates must be provided for all frames,
This value should always be calculated by the AWB block,
- NONE
- 50HZ
- 60HZ
The camera device estimated scene illumination lighting
frequency.
Many light sources,
When manual exposure control is enabled
(android. or android.),
Report NONE if there doesn't appear to be flickering illumination.
Tonemapping /
same as android.
See android.
Tonemapping /
same as android.
See android.
Tonemapping /
0-1 on both input and output coordinates,
Each channel's curve is defined by an array of control points:
android.These are sorted in order of increasing Pin; it is always
guaranteed that input values 0.
Each curve can have an independent number of points,
A few examples,
Linear mapping:
android.
Invert mapping:
android.
Gamma 1/
android.
Standard sRGB gamma mapping,
android.
For good quality of mapping,
A typical use case of this would be a gamma-1/
-
CONTRAST_CURVE
Use the tone mapping curve specified in android.
tonemap. curve. All color enhancement and tonemapping must be disabled,
except for applying the tonemapping curve specified by android. tonemap. curve Red, android. tonemap. curve Blue, or android. tonemap. curve Green. Must not slow down frame rate relative to raw sensor output.
-
FAST
Advanced gamma mapping and color enhancement may be applied.
Should not slow down frame rate relative to raw sensor output.
-
HIGH_QUALITY
Advanced gamma mapping and color enhancement may be applied.
May slow down frame rate relative to raw sensor output.
High-level global contrast/
When switching to an application-defined contrast curve by setting
android.(in, points that specify the
mapping from input high-bit-depth pixel value to the output
low-bit-depth value.
More-complex color mapping operations such as 3D color look-up
tables,
When using either FAST or HIGH_
If a request is sent with TRANSFORM_
Maximum number of supported points in the
tonemap curve that can be used for android.
>= 64
If the actual number of points provided by the application (in
android.
The output curves in the result metadata may have a different number
of points than the input curves,
This value must be at least 64.
Tonemapping /
same as android.
See android.
Tonemapping /
same as android.
See android.
Tonemapping /
0-1 on both input and output coordinates,
Each channel's curve is defined by an array of control points:
android.These are sorted in order of increasing Pin; it is always
guaranteed that input values 0.
Each curve can have an independent number of points,
A few examples,
Linear mapping:
android.
Invert mapping:
android.
Gamma 1/
android.
Standard sRGB gamma mapping,
android.
For good quality of mapping,
A typical use case of this would be a gamma-1/
-
CONTRAST_CURVE
Use the tone mapping curve specified in android.
tonemap. curve. All color enhancement and tonemapping must be disabled,
except for applying the tonemapping curve specified by android. tonemap. curve Red, android. tonemap. curve Blue, or android. tonemap. curve Green. Must not slow down frame rate relative to raw sensor output.
-
FAST
Advanced gamma mapping and color enhancement may be applied.
Should not slow down frame rate relative to raw sensor output.
-
HIGH_QUALITY
Advanced gamma mapping and color enhancement may be applied.
May slow down frame rate relative to raw sensor output.
High-level global contrast/
When switching to an application-defined contrast curve by setting
android.(in, points that specify the
mapping from input high-bit-depth pixel value to the output
low-bit-depth value.
More-complex color mapping operations such as 3D color look-up
tables,
When using either FAST or HIGH_
If a request is sent with TRANSFORM_
- OFF
- ON
This LED is nominally used to indicate to the user
that the camera is powered on and may be streaming images back to the
Application Processor.
In particular,
The LED may be off if a trusted application is using the data that
doesn't violate the above rules.
- OFF
- ON
This LED is nominally used to indicate to the user
that the camera is powered on and may be streaming images back to the
Application Processor.
In particular,
The LED may be off if a trusted application is using the data that
doesn't violate the above rules.
-
TRANSMIT
android.
led. transmit control is used
A list of camera LEDs that are available on this system.
- LIMITED
- FULL
Generally classifies the overall set of the camera device functionality.
Optional.
Camera devices will come in two flavors: LIMITED and FULL.
A FULL device has the most support possible and will enable the widest range of use cases such as:
- 30 FPS at maximum resolution (== sensor resolution)
- Per frame control
- Manual sensor control
- Zero Shutter Lag (ZSL)
A LIMITED device may have some or none of the above characteristics.
The camera 3 HAL device can implement one of two possible
operational modes; limited and full.
For full details refer to "S3.
- OFF
- ON
Whether black-level compensation is locked
to its current values,
When set to ON,
Since changes to certain capture parameters (such as
exposure time) may require resetting of black level
compensation,
For example,
- Request 1: Exposure = 10ms,
Black level lock = OFF - Request 2: Exposure = 10ms,
Black level lock = ON - Request 3: Exposure = 10ms,
Black level lock = ON - Request 4: Exposure = 20ms,
Black level lock = ON - Request 5: Exposure = 20ms,
Black level lock = ON - Request 6: Exposure = 20ms,
Black level lock = ON
And the exposure change in Request 4 requires the camera
device to reset the black level offsets,
- Result 1: Exposure = 10ms,
Black level lock = OFF - Result 2: Exposure = 10ms,
Black level lock = ON - Result 3: Exposure = 10ms,
Black level lock = ON - Result 4: Exposure = 20ms,
Black level lock = OFF - Result 5: Exposure = 20ms,
Black level lock = ON - Result 6: Exposure = 20ms,
Black level lock = ON
This indicates to the application that on frame 4,
The camera device will maintain the lock to the extent
possible,
If for some reason black level locking is no longer possible
(for example,
- OFF
- ON
Whether black-level compensation is locked
to its current values,
Whether the black level offset was locked for this frame.
If for some reason black level locking is no longer possible
(for example,
-
CONVERGING
-1
The current result is not yet fully synchronized to any request.
Synchronization is in progress, and reading metadata from this result may include a mix of data that have taken effect since the last synchronization time. In some future result,
within android. sync. max Latency frames, this value will update to the actual frame number frame number the result is guaranteed to be synchronized to (as long as the request settings remain constant). -
UNKNOWN
-2
The current result's synchronization status is unknown.
The result may have already converged, or it may be in progress. Reading from this result may include some mix of settings from past requests. After a settings change,
the new settings will eventually all take effect for the output buffers and results. However, this value will not change when that happens. Altering settings rapidly may provide outcomes using mixes of settings from recent requests. This value is intended primarily for backwards compatibility with the older camera implementations (for android.
hardware. Camera).
The frame number corresponding to the last request
with which the output result (metadata + buffers) has been fully
synchronized.
Either a non-negative value corresponding to a
frame_,
When a request is submitted to the camera device,
In the latter case,
While a set of control changes are being propagated,
Once it is fully known that a set of control changes have been
finished propagating,
Older camera device implementations may not have a way to detect
when all camera controls have been applied,
FULL capability devices will always have this value set to the
frame number of the request corresponding to this result.
Further details:
- Whenever a request differs from the last request,
any future results not yet returned may have this value set to CONVERGING (this could include any in-progress captures not yet returned by the camera device, for more details see pipeline considerations below). - Submitting a series of multiple requests that differ from the
previous request (e.
g. r1, r2, r3 s. t. r1 != r2 != r3) moves the new synchronization frame to the last non-repeating request (using the smallest frame number from the contiguous list of repeating requests). - Submitting the same request repeatedly will not change this value
to CONVERGING,
if it was already a non-negative value. - When this value changes to non-negative,
that means that all of the metadata controls from the request have been applied, all of the metadata controls from the camera device have been read to the updated values (into the result), and all of the graphics buffers corresponding to this result are also synchronized to the request.
Pipeline considerations:
Submitting a request with updated controls relative to the previously
submitted requests may also invalidate the synchronization state
of all the results corresponding to currently in-flight requests.
In other words,
Using UNKNOWN here is illegal unless android.
FULL capability devices should simply set this value to the
frame_ of the request this result corresponds to.
-
PER_FRAME_CONTROL
0
Every frame has the requests immediately applied.
(and furthermore for all results, android.)sync. frame Number == android. request. frame Count Changing controls over multiple requests one after another will produce results that have those controls applied atomically each frame.
All FULL capability devices will have this as their maxLatency.
-
UNKNOWN
-1
Each new frame has some subset (potentially the entire set) of the past requests applied to the camera settings.
By submitting a series of identical requests,
the camera device will eventually have the camera settings applied, but it is unknown when that exact point will be.
The maximum number of frames that can occur after a request
(different than the previous) has been submitted,
>= -1
This defines the maximum distance (in number of metadata results),
In other words this acts as an upper boundary for how many frames
must occur before the camera device knows for a fact that the new
submitted camera settings have been applied in outgoing frames.
For example if the distance was 2,
initial request = X (repeating)
request1 = X
request2 = Y
request3 = Y
request4 = Y
where requestN has frameNumber N,Since result4 has a frameNumber == 4 and
android.,4 - 2 = 2.
Use frame_ from camera3_
LIMITED devices are strongly encouraged to use a non-negative
value.