/* * Copyright (C) 2012 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.hardware.camera2; import android.hardware.camera2.impl.CameraMetadataNative; /** *

The results of a single image capture from the image sensor.

* *

Contains the final configuration for the capture hardware (sensor, lens, * flash), the processing pipeline, the control algorithms, and the output * buffers.

* *

CaptureResults are produced by a {@link CameraDevice} after processing a * {@link CaptureRequest}. All properties listed for capture requests can also * be queried on the capture result, to determine the final values used for * capture. The result also includes additional metadata about the state of the * camera device during the capture.

* */ public final class CaptureResult extends CameraMetadata { private final CameraMetadataNative mResults; private final CaptureRequest mRequest; private final int mSequenceId; /** * Takes ownership of the passed-in properties object * @hide */ public CaptureResult(CameraMetadataNative results, CaptureRequest parent, int sequenceId) { if (results == null) { throw new IllegalArgumentException("results was null"); } if (parent == null) { throw new IllegalArgumentException("parent was null"); } mResults = results; mRequest = parent; mSequenceId = sequenceId; } @Override public T get(Key key) { return mResults.get(key); } /** * Get the request associated with this result. * *

Whenever a request is successfully captured, with * {@link CameraDevice.CaptureListener#onCaptureCompleted}, * the {@code result}'s {@code getRequest()} will return that {@code request}. *

* *

In particular, * 

cameraDevice.capture(someRequest, new CaptureListener() {
     *     {@literal @}Override
     *     void onCaptureCompleted(CaptureRequest myRequest, CaptureResult myResult) {
     *         assert(myResult.getRequest.equals(myRequest) == true);
     *     }
     * };
     *
*

* * @return The request associated with this result. Never {@code null}. */ public CaptureRequest getRequest() { return mRequest; } /** * Get the frame number associated with this result. * *

Whenever a request has been processed, regardless of failure or success, * it gets a unique frame number assigned to its future result/failure.

* *

This value monotonically increments, starting with 0, * for every new result or failure; and the scope is the lifetime of the * {@link CameraDevice}.

* * @return int frame number */ public int getFrameNumber() { return get(REQUEST_FRAME_COUNT); } /** * The sequence ID for this failure that was returned by the * {@link CameraDevice#capture} family of functions. * *

The sequence ID is a unique monotonically increasing value starting from 0, * incremented every time a new group of requests is submitted to the CameraDevice.

* * @return int The ID for the sequence of requests that this capture result is a part of * * @see CameraDevice.CaptureListener#onCaptureSequenceCompleted */ public int getSequenceId() { return mSequenceId; } /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ * The key entries below this point are generated from metadata * definitions in /system/media/camera/docs. Do not modify by hand or * modify the comment blocks at the start or end. *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ /** *

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 HAL when the request * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or * directly by the application in the request when the * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.

*

In the latter case, the HAL may round the matrix to account * for precision issues; the final rounded matrix should be * reported back in this matrix result metadata.

* * @see CaptureRequest#COLOR_CORRECTION_MODE */ public static final Key COLOR_CORRECTION_TRANSFORM = new Key("android.colorCorrection.transform", Rational[].class); /** *

Gains applying to Bayer raw color channels for * white-balance

*

The 4-channel white-balance gains are defined in * the order of [R G_even G_odd B], where G_even is the gain * for green pixels on even rows of the output, and G_odd * is the gain for green pixels on the odd rows. if a HAL * does not support a separate gain for even/odd green channels, * it should use the G_even value, and write G_odd equal to * G_even in the output result metadata.

*

This array is either set by HAL when the request * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or * directly by the application in the request when the * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.

*

The output should be the gains actually applied by the HAL to * the current frame.

* * @see CaptureRequest#COLOR_CORRECTION_MODE */ public static final Key COLOR_CORRECTION_GAINS = new Key("android.colorCorrection.gains", float[].class); /** *

The ID sent with the latest * CAMERA2_TRIGGER_PRECAPTURE_METERING call

*

Must be 0 if no * CAMERA2_TRIGGER_PRECAPTURE_METERING trigger received yet * by HAL. Always updated even if AE algorithm ignores the * trigger

* @hide */ public static final Key CONTROL_AE_PRECAPTURE_ID = new Key("android.control.aePrecaptureId", int.class); /** *

The desired mode for the camera device's * auto-exposure routine.

*

This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is * AUTO.

*

When set to any of the ON modes, the camera device's * auto-exposure routine is enabled, overriding the * application's selected exposure time, sensor sensitivity, * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes * is selected, the camera device's flash unit controls are * also overridden.

*

The FLASH modes are only available if the camera device * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is true).

*

If flash TORCH mode is desired, this field must be set to * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.

*

When set to any of the ON modes, the values chosen by the * camera device auto-exposure routine for the overridden * fields for a given capture will be available in its * CaptureResult.

* * @see CaptureRequest#CONTROL_MODE * @see CameraCharacteristics#FLASH_INFO_AVAILABLE * @see CaptureRequest#FLASH_MODE * @see CaptureRequest#SENSOR_EXPOSURE_TIME * @see CaptureRequest#SENSOR_FRAME_DURATION * @see CaptureRequest#SENSOR_SENSITIVITY * @see #CONTROL_AE_MODE_OFF * @see #CONTROL_AE_MODE_ON * @see #CONTROL_AE_MODE_ON_AUTO_FLASH * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE */ public static final Key CONTROL_AE_MODE = new Key("android.control.aeMode", int.class); /** *

List of areas to use for * metering.

*

Each area is a rectangle plus weight: xmin, ymin, * xmax, ymax, weight. The rectangle is defined to be inclusive of the * specified coordinates.

*

The coordinate system is based on the active pixel array, * with (0,0) being the top-left pixel in the active pixel array, and * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative.

*

If all regions have 0 weight, then no specific metering area * needs to be used by the HAL. If the metering region is * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL * should ignore the sections outside the region and output the * used sections in the frame metadata.

* * @see CaptureRequest#SCALER_CROP_REGION * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE */ public static final Key CONTROL_AE_REGIONS = new Key("android.control.aeRegions", int[].class); /** *

Current state of AE algorithm

*

Switching between or enabling AE modes ({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}) always * resets the AE state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if {@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE resets all * the algorithm states to INACTIVE.

*

The camera device can do several state transitions between two results, if it is * allowed by the state transition table. For example: INACTIVE may never actually be * seen in a result.

*

The state in the result is the state for this image (in sync with this image): if * AE state becomes CONVERGED, then the image data associated with this result should * be good to use.

*

Below are state transition tables for different AE modes.

* * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVEINACTIVECamera device auto exposure algorithm is disabled
*

When {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is AE_MODE_ON_*:

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVECamera device initiates AE scanSEARCHINGValues changing
INACTIVE{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ONLOCKEDValues locked
SEARCHINGCamera device finishes AE scanCONVERGEDGood values, not changing
SEARCHINGCamera device finishes AE scanFLASH_REQUIREDConverged but too dark w/o flash
SEARCHING{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ONLOCKEDValues locked
CONVERGEDCamera device initiates AE scanSEARCHINGValues changing
CONVERGED{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ONLOCKEDValues locked
FLASH_REQUIREDCamera device initiates AE scanSEARCHINGValues changing
FLASH_REQUIRED{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ONLOCKEDValues locked
LOCKED{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFFSEARCHINGValues not good after unlock
LOCKED{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFFCONVERGEDValues good after unlock
LOCKED{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFFFLASH_REQUIREDExposure good, but too dark
PRECAPTURESequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFFCONVERGEDReady for high-quality capture
PRECAPTURESequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ONLOCKEDReady for high-quality capture
Any state{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is STARTPRECAPTUREStart AE precapture metering sequence
* * @see CaptureRequest#CONTROL_AE_LOCK * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER * @see CaptureRequest#CONTROL_MODE * @see CaptureRequest#CONTROL_SCENE_MODE * @see #CONTROL_AE_STATE_INACTIVE * @see #CONTROL_AE_STATE_SEARCHING * @see #CONTROL_AE_STATE_CONVERGED * @see #CONTROL_AE_STATE_LOCKED * @see #CONTROL_AE_STATE_FLASH_REQUIRED * @see #CONTROL_AE_STATE_PRECAPTURE */ public static final Key CONTROL_AE_STATE = new Key("android.control.aeState", int.class); /** *

Whether AF is currently enabled, and what * mode it is set to

*

Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO.

*

If the lens is controlled by the camera device auto-focus algorithm, * the camera device will report the current AF status in android.control.afState * in result metadata.

* * @see CaptureRequest#CONTROL_MODE * @see #CONTROL_AF_MODE_OFF * @see #CONTROL_AF_MODE_AUTO * @see #CONTROL_AF_MODE_MACRO * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE * @see #CONTROL_AF_MODE_EDOF */ public static final Key CONTROL_AF_MODE = new Key("android.control.afMode", int.class); /** *

List of areas to use for focus * estimation.

*

Each area is a rectangle plus weight: xmin, ymin, * xmax, ymax, weight. The rectangle is defined to be inclusive of the * specified coordinates.

*

The coordinate system is based on the active pixel array, * with (0,0) being the top-left pixel in the active pixel array, and * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative.

*

If all regions have 0 weight, then no specific focus area * needs to be used by the HAL. If the focusing region is * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL * should ignore the sections outside the region and output the * used sections in the frame metadata.

* * @see CaptureRequest#SCALER_CROP_REGION * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE */ public static final Key CONTROL_AF_REGIONS = new Key("android.control.afRegions", int[].class); /** *

Current state of AF algorithm

*

Switching between or enabling AF modes ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) always * resets the AF state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if {@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE resets all * the algorithm states to INACTIVE.

*

The camera device can do several state transitions between two results, if it is * allowed by the state transition table. For example: INACTIVE may never actually be * seen in a result.

*

The state in the result is the state for this image (in sync with this image): if * AF state becomes FOCUSED, then the image data associated with this result should * be sharp.

*

Below are state transition tables for different AF modes.

*

When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_OFF or AF_MODE_EDOF:

* * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVEINACTIVENever changes
*

When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_AUTO or AF_MODE_MACRO:

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVEAF_TRIGGERACTIVE_SCANStart AF sweep, Lens now moving
ACTIVE_SCANAF sweep doneFOCUSED_LOCKEDFocused, Lens now locked
ACTIVE_SCANAF sweep doneNOT_FOCUSED_LOCKEDNot focused, Lens now locked
ACTIVE_SCANAF_CANCELINACTIVECancel/reset AF, Lens now locked
FOCUSED_LOCKEDAF_CANCELINACTIVECancel/reset AF
FOCUSED_LOCKEDAF_TRIGGERACTIVE_SCANStart new sweep, Lens now moving
NOT_FOCUSED_LOCKEDAF_CANCELINACTIVECancel/reset AF
NOT_FOCUSED_LOCKEDAF_TRIGGERACTIVE_SCANStart new sweep, Lens now moving
Any stateMode changeINACTIVE
*

When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_VIDEO:

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVECamera device initiates new scanPASSIVE_SCANStart AF scan, Lens now moving
INACTIVEAF_TRIGGERNOT_FOCUSED_LOCKEDAF state query, Lens now locked
PASSIVE_SCANCamera device completes current scanPASSIVE_FOCUSEDEnd AF scan, Lens now locked
PASSIVE_SCANCamera device fails current scanPASSIVE_UNFOCUSEDEnd AF scan, Lens now locked
PASSIVE_SCANAF_TRIGGERFOCUSED_LOCKEDImmediate trans. If focus is good, Lens now locked
PASSIVE_SCANAF_TRIGGERNOT_FOCUSED_LOCKEDImmediate trans. if focus is bad, Lens now locked
PASSIVE_SCANAF_CANCELINACTIVEReset lens position, Lens now locked
PASSIVE_FOCUSEDCamera device initiates new scanPASSIVE_SCANStart AF scan, Lens now moving
PASSIVE_UNFOCUSEDCamera device initiates new scanPASSIVE_SCANStart AF scan, Lens now moving
PASSIVE_FOCUSEDAF_TRIGGERFOCUSED_LOCKEDImmediate trans. Lens now locked
PASSIVE_UNFOCUSEDAF_TRIGGERNOT_FOCUSED_LOCKEDImmediate trans. Lens now locked
FOCUSED_LOCKEDAF_TRIGGERFOCUSED_LOCKEDNo effect
FOCUSED_LOCKEDAF_CANCELINACTIVERestart AF scan
NOT_FOCUSED_LOCKEDAF_TRIGGERNOT_FOCUSED_LOCKEDNo effect
NOT_FOCUSED_LOCKEDAF_CANCELINACTIVERestart AF scan
*

When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_PICTURE:

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVECamera device initiates new scanPASSIVE_SCANStart AF scan, Lens now moving
INACTIVEAF_TRIGGERNOT_FOCUSED_LOCKEDAF state query, Lens now locked
PASSIVE_SCANCamera device completes current scanPASSIVE_FOCUSEDEnd AF scan, Lens now locked
PASSIVE_SCANCamera device fails current scanPASSIVE_UNFOCUSEDEnd AF scan, Lens now locked
PASSIVE_SCANAF_TRIGGERFOCUSED_LOCKEDEventual trans. once focus good, Lens now locked
PASSIVE_SCANAF_TRIGGERNOT_FOCUSED_LOCKEDEventual trans. if cannot focus, Lens now locked
PASSIVE_SCANAF_CANCELINACTIVEReset lens position, Lens now locked
PASSIVE_FOCUSEDCamera device initiates new scanPASSIVE_SCANStart AF scan, Lens now moving
PASSIVE_UNFOCUSEDCamera device initiates new scanPASSIVE_SCANStart AF scan, Lens now moving
PASSIVE_FOCUSEDAF_TRIGGERFOCUSED_LOCKEDImmediate trans. Lens now locked
PASSIVE_UNFOCUSEDAF_TRIGGERNOT_FOCUSED_LOCKEDImmediate trans. Lens now locked
FOCUSED_LOCKEDAF_TRIGGERFOCUSED_LOCKEDNo effect
FOCUSED_LOCKEDAF_CANCELINACTIVERestart AF scan
NOT_FOCUSED_LOCKEDAF_TRIGGERNOT_FOCUSED_LOCKEDNo effect
NOT_FOCUSED_LOCKEDAF_CANCELINACTIVERestart AF scan
* * @see CaptureRequest#CONTROL_AF_MODE * @see CaptureRequest#CONTROL_MODE * @see CaptureRequest#CONTROL_SCENE_MODE * @see #CONTROL_AF_STATE_INACTIVE * @see #CONTROL_AF_STATE_PASSIVE_SCAN * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED * @see #CONTROL_AF_STATE_ACTIVE_SCAN * @see #CONTROL_AF_STATE_FOCUSED_LOCKED * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED */ public static final Key CONTROL_AF_STATE = new Key("android.control.afState", int.class); /** *

The ID sent with the latest * CAMERA2_TRIGGER_AUTOFOCUS call

*

Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger * received yet by HAL. Always updated even if AF algorithm * ignores the trigger

* @hide */ public static final Key CONTROL_AF_TRIGGER_ID = new Key("android.control.afTriggerId", int.class); /** *

Whether AWB is currently setting the color * transform fields, and what its illumination target * is

*

This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.

*

When set to the ON mode, the camera device's auto white balance * routine is enabled, overriding the application's selected * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.

*

When set to the OFF mode, the camera device's auto white balance * routine is disabled. The applicantion manually controls the white * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, android.colorCorrection.gains * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.

*

When set to any other modes, the camera device's auto white balance * routine is disabled. The camera device uses each particular illumination * target for white balance adjustment.

* * @see CaptureRequest#COLOR_CORRECTION_GAINS * @see CaptureRequest#COLOR_CORRECTION_MODE * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM * @see CaptureRequest#CONTROL_MODE * @see #CONTROL_AWB_MODE_OFF * @see #CONTROL_AWB_MODE_AUTO * @see #CONTROL_AWB_MODE_INCANDESCENT * @see #CONTROL_AWB_MODE_FLUORESCENT * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT * @see #CONTROL_AWB_MODE_DAYLIGHT * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT * @see #CONTROL_AWB_MODE_TWILIGHT * @see #CONTROL_AWB_MODE_SHADE */ public static final Key CONTROL_AWB_MODE = new Key("android.control.awbMode", int.class); /** *

List of areas to use for illuminant * estimation.

*

Only used in AUTO mode.

*

Each area is a rectangle plus weight: xmin, ymin, * xmax, ymax, weight. The rectangle is defined to be inclusive of the * specified coordinates.

*

The coordinate system is based on the active pixel array, * with (0,0) being the top-left pixel in the active pixel array, and * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative.

*

If all regions have 0 weight, then no specific metering area * needs to be used by the HAL. If the metering region is * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL * should ignore the sections outside the region and output the * used sections in the frame metadata.

* * @see CaptureRequest#SCALER_CROP_REGION * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE */ public static final Key CONTROL_AWB_REGIONS = new Key("android.control.awbRegions", int[].class); /** *

Current state of AWB algorithm

*

Switching between or enabling AWB modes ({@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}) always * resets the AWB state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if {@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE resets all * the algorithm states to INACTIVE.

*

The camera device can do several state transitions between two results, if it is * allowed by the state transition table. So INACTIVE may never actually be seen in * a result.

*

The state in the result is the state for this image (in sync with this image): if * AWB state becomes CONVERGED, then the image data associated with this result should * be good to use.

*

Below are state transition tables for different AWB modes.

*

When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != AWB_MODE_AUTO:

* * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVEINACTIVECamera device auto white balance algorithm is disabled
*

When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is AWB_MODE_AUTO:

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
StateTransition CauseNew StateNotes
INACTIVECamera device initiates AWB scanSEARCHINGValues changing
INACTIVE{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ONLOCKEDValues locked
SEARCHINGCamera device finishes AWB scanCONVERGEDGood values, not changing
SEARCHING{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ONLOCKEDValues locked
CONVERGEDCamera device initiates AWB scanSEARCHINGValues changing
CONVERGED{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ONLOCKEDValues locked
LOCKED{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFFSEARCHINGValues not good after unlock
LOCKED{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFFCONVERGEDValues good after unlock
* * @see CaptureRequest#CONTROL_AWB_LOCK * @see CaptureRequest#CONTROL_AWB_MODE * @see CaptureRequest#CONTROL_MODE * @see CaptureRequest#CONTROL_SCENE_MODE * @see #CONTROL_AWB_STATE_INACTIVE * @see #CONTROL_AWB_STATE_SEARCHING * @see #CONTROL_AWB_STATE_CONVERGED * @see #CONTROL_AWB_STATE_LOCKED */ public static final Key CONTROL_AWB_STATE = new Key("android.control.awbState", int.class); /** *

Overall mode of 3A control * routines

*

High-level 3A control. When set to OFF, all 3A control * by the camera device is disabled. The application must set the fields for * capture parameters itself.

*

When set to AUTO, the individual algorithm controls in * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.

*

When set to USE_SCENE_MODE, the individual controls in * android.control.* are mostly disabled, and the camera device implements * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) * as it wishes. The camera device scene mode 3A settings are provided by * android.control.sceneModeOverrides.

* * @see CaptureRequest#CONTROL_AF_MODE * @see #CONTROL_MODE_OFF * @see #CONTROL_MODE_AUTO * @see #CONTROL_MODE_USE_SCENE_MODE */ public static final Key CONTROL_MODE = new Key("android.control.mode", int.class); /** *

Operation mode for edge * enhancement

*

Edge/sharpness/detail enhancement. OFF means no * enhancement will be applied by the HAL.

*

FAST/HIGH_QUALITY both mean camera device determined enhancement * will be applied. HIGH_QUALITY mode indicates that the * camera device will use the highest-quality enhancement algorithms, * even if it slows down capture rate. FAST means the camera device will * not slow down capture rate when applying edge enhancement.

* @see #EDGE_MODE_OFF * @see #EDGE_MODE_FAST * @see #EDGE_MODE_HIGH_QUALITY */ public static final Key EDGE_MODE = new Key("android.edge.mode", int.class); /** *

The desired mode for for the camera device's flash control.

*

This control is only effective when flash unit is available * ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} != 0).

*

When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.

*

When set to OFF, the camera device will not fire flash for this capture.

*

When set to SINGLE, the camera device will fire flash regardless of the camera * device's auto-exposure routine's result. When used in still capture case, this * control should be used along with AE precapture metering sequence * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.

*

When set to TORCH, the flash will be on continuously. This mode can be used * for use cases such as preview, auto-focus assist, still capture, or video recording.

* * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER * @see CameraCharacteristics#FLASH_INFO_AVAILABLE * @see #FLASH_MODE_OFF * @see #FLASH_MODE_SINGLE * @see #FLASH_MODE_TORCH */ public static final Key FLASH_MODE = new Key("android.flash.mode", int.class); /** *

Current state of the flash * unit

* @see #FLASH_STATE_UNAVAILABLE * @see #FLASH_STATE_CHARGING * @see #FLASH_STATE_READY * @see #FLASH_STATE_FIRED */ public static final Key FLASH_STATE = new Key("android.flash.state", int.class); /** *

GPS coordinates to include in output JPEG * EXIF

*/ public static final Key JPEG_GPS_COORDINATES = new Key("android.jpeg.gpsCoordinates", double[].class); /** *

32 characters describing GPS algorithm to * include in EXIF

*/ public static final Key JPEG_GPS_PROCESSING_METHOD = new Key("android.jpeg.gpsProcessingMethod", String.class); /** *

Time GPS fix was made to include in * EXIF

*/ public static final Key JPEG_GPS_TIMESTAMP = new Key("android.jpeg.gpsTimestamp", long.class); /** *

Orientation of JPEG image to * write

*/ public static final Key JPEG_ORIENTATION = new Key("android.jpeg.orientation", int.class); /** *

Compression quality of the final JPEG * image

*

85-95 is typical usage range

*/ public static final Key JPEG_QUALITY = new Key("android.jpeg.quality", byte.class); /** *

Compression quality of JPEG * thumbnail

*/ public static final Key JPEG_THUMBNAIL_QUALITY = new Key("android.jpeg.thumbnailQuality", byte.class); /** *

Resolution of embedded JPEG thumbnail

*

When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, * but the captured JPEG will still be a valid image.

*

When a jpeg image capture is issued, the thumbnail size selected should have * the same aspect ratio as the jpeg image.

*/ public static final Key JPEG_THUMBNAIL_SIZE = new Key("android.jpeg.thumbnailSize", android.hardware.camera2.Size.class); /** *

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. The aperture value can only be * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.

*

When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and android.sensor.frameDuration * to achieve manual exposure control.

*

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 {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of * the ON modes, this will be overridden by the camera device * auto-exposure algorithm, the overridden values are then provided * back to the user in the corresponding result.

* * @see CaptureRequest#CONTROL_AE_MODE * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES * @see CaptureRequest#SENSOR_EXPOSURE_TIME * @see CaptureRequest#SENSOR_SENSITIVITY */ public static final Key LENS_APERTURE = new Key("android.lens.aperture", float.class); /** *

State of lens neutral density filter(s).

*

This will not be supported on most camera devices. On devices * where this is supported, this may only be set to one of the * values included in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}.

*

Lens filters are typically used to lower the amount of light the * sensor is exposed to (measured in steps of EV). As used here, an EV * step is the standard logarithmic representation, which are * non-negative, and inversely proportional to the amount of light * hitting the sensor. For example, setting this to 0 would result * in no reduction of the incoming light, and setting this to 2 would * mean that the filter is set to reduce incoming light by two stops * (allowing 1/4 of the prior amount of light to the sensor).

* * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES */ public static final Key LENS_FILTER_DENSITY = new Key("android.lens.filterDensity", float.class); /** *

The current lens focal length; used for optical zoom.

*

This setting controls the physical focal length of the camera * device's lens. Changing the focal length changes the field of * view of the camera device, and is usually used for optical zoom.

*

Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this * setting won't be applied instantaneously, and it may take several * frames before the lens can move to the requested focal length. * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will * be set to MOVING.

*

This is expected not to be supported on most devices.

* * @see CaptureRequest#LENS_APERTURE * @see CaptureRequest#LENS_FOCUS_DISTANCE * @see CaptureResult#LENS_STATE */ public static final Key LENS_FOCAL_LENGTH = new Key("android.lens.focalLength", float.class); /** *

Distance to plane of sharpest focus, * measured from frontmost surface of the lens

*

Should be zero for fixed-focus cameras

*/ public static final Key LENS_FOCUS_DISTANCE = new Key("android.lens.focusDistance", float.class); /** *

The range of scene distances that are in * sharp focus (depth of field)

*

If variable focus not supported, can still report * fixed depth of field range

*/ public static final Key LENS_FOCUS_RANGE = new Key("android.lens.focusRange", float[].class); /** *

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. Unlike digital image stabilization, OIS makes * use of mechanical elements to stabilize the camera sensor, and thus * allows for longer exposure times before camera shake becomes * apparent.

*

This is not expected to be supported on most devices.

* @see #LENS_OPTICAL_STABILIZATION_MODE_OFF * @see #LENS_OPTICAL_STABILIZATION_MODE_ON */ public static final Key LENS_OPTICAL_STABILIZATION_MODE = new Key("android.lens.opticalStabilizationMode", int.class); /** *

Current lens status

* @see #LENS_STATE_STATIONARY * @see #LENS_STATE_MOVING */ public static final Key LENS_STATE = new Key("android.lens.state", int.class); /** *

Mode of operation for the noise reduction * algorithm

*

Noise filtering control. OFF means no noise reduction * will be applied by the HAL.

*

FAST/HIGH_QUALITY both mean camera device determined noise filtering * will be applied. HIGH_QUALITY mode indicates that the camera device * will use the highest-quality noise filtering algorithms, * even if it slows down capture rate. FAST means the camera device should not * slow down capture rate when applying noise filtering.

* @see #NOISE_REDUCTION_MODE_OFF * @see #NOISE_REDUCTION_MODE_FAST * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY */ public static final Key NOISE_REDUCTION_MODE = new Key("android.noiseReduction.mode", int.class); /** *

Whether a result given to the framework is the * final one for the capture, or only a partial that contains a * subset of the full set of dynamic metadata * values.

*

The entries in the result metadata buffers for a * single capture may not overlap, except for this entry. The * FINAL buffers must retain FIFO ordering relative to the * requests that generate them, so the FINAL buffer for frame 3 must * always be sent to the framework after the FINAL buffer for frame 2, and * before the FINAL buffer for frame 4. PARTIAL buffers may be returned * in any order relative to other frames, but all PARTIAL buffers for a given * capture must arrive before the FINAL buffer for that capture. This entry may * only be used by the HAL if quirks.usePartialResult is set to 1.

*

Optional - This value may be {@code null} on some devices.

* @hide */ public static final Key QUIRKS_PARTIAL_RESULT = new Key("android.quirks.partialResult", boolean.class); /** *

A frame counter set by the framework. This value monotonically * increases with every new result (that is, each new result has a unique * frameCount value).

*

Reset on release()

*/ public static final Key REQUEST_FRAME_COUNT = new Key("android.request.frameCount", int.class); /** *

An application-specified ID for the current * request. Must be maintained unchanged in output * frame

* @hide */ public static final Key REQUEST_ID = new Key("android.request.id", int.class); /** *

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, and * what streams are configured, the data may undergo less processing, * and some pipeline stages skipped.

*

See {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} for more details.

* * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH */ public static final Key REQUEST_PIPELINE_DEPTH = new Key("android.request.pipelineDepth", byte.class); /** *

(x, y, width, height).

*

A rectangle with the top-level corner of (x,y) and size * (width, height). The region of the sensor that is used for * output. Each stream must use this rectangle to produce its * output, cropping to a smaller region if necessary to * maintain the stream's aspect ratio.

*

HAL2.x uses only (x, y, width)

*

Any additional per-stream cropping must be done to * maximize the final pixel area of the stream.

*

For example, if the crop region is set to a 4:3 aspect * ratio, then 4:3 streams should use the exact crop * region. 16:9 streams should further crop vertically * (letterbox).

*

Conversely, if the crop region is set to a 16:9, then 4:3 * outputs should crop horizontally (pillarbox), and 16:9 * streams should match exactly. These additional crops must * be centered within the crop region.

*

The output streams must maintain square pixels at all * times, no matter what the relative aspect ratios of the * crop region and the stream are. Negative values for * corner are allowed for raw output if full pixel array is * larger than active pixel array. Width and height may be * rounded to nearest larger supportable width, especially * for raw output, where only a few fixed scales may be * possible. The width and height of the crop region cannot * be set to be smaller than floor( activeArraySize.width / * android.scaler.maxDigitalZoom ) and floor( * activeArraySize.height / android.scaler.maxDigitalZoom), * respectively.

*/ public static final Key SCALER_CROP_REGION = new Key("android.scaler.cropRegion", android.graphics.Rect.class); /** *

Duration each pixel is exposed to * light.

*

If the sensor can't expose this exact duration, it should shorten the * duration exposed to the nearest possible value (rather than expose longer).

*

1/10000 - 30 sec range. No bulb mode

*/ public static final Key SENSOR_EXPOSURE_TIME = new Key("android.sensor.exposureTime", long.class); /** *

Duration from start of frame exposure to * start of next frame exposure.

*

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 camera abstraction tries to represent the bandwidth * restrictions with as simple a model as possible.

*

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.
    • *
  • 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.
    • *
*

The necessary information for the application, given the model above, * is provided via the android.scaler.available*MinDurations fields. * These are used to determine the maximum frame rate / minimum frame * duration that is possible for a given stream configuration.

*

Specifically, the application can use the following rules to * determine the minimum frame duration it can request from the HAL * device:

*
    *
  1. Given the application's currently configured set of output * streams, S, divide them into three sets: streams in a JPEG format * SJ, streams in a raw sensor format SR, and the rest ('processed') * SP.
    2. *
  2. For each subset of streams, find the largest resolution (by pixel * count) in the subset. This gives (at most) three resolutions RJ, * RR, and RP.
    3. *
  3. If RJ is greater than RP, set RP equal to RJ. If there is * no exact match for RP == RJ (in particular there isn't an available * processed resolution at the same size as RJ), then set RP equal * to the smallest processed resolution that is larger than RJ. If * there are no processed resolutions larger than RJ, then set RJ to * the processed resolution closest to RJ.
    4. *
  4. If RP is greater than RR, set RR equal to RP. If there is * no exact match for RR == RP (in particular there isn't an available * raw resolution at the same size as RP), then set RR equal to * or to the smallest raw resolution that is larger than RP. If * there are no raw resolutions larger than RP, then set RR to * the raw resolution closest to RP.
    5. *
  5. Look up the matching minimum frame durations in the property lists * {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_MIN_DURATIONS android.scaler.availableJpegMinDurations}, * android.scaler.availableRawMinDurations, and * {@link CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS android.scaler.availableProcessedMinDurations}. This gives three * minimum frame durations FJ, FR, and FP.
    6. *
  6. If a stream of requests do not use a JPEG stream, then the minimum * supported frame duration for each request is max(FR, FP).
    7. *
  7. If a stream of requests all use the JPEG stream, then the minimum * supported frame duration for each request is max(FR, FP, FJ).
    8. *
  8. If a mix of JPEG-using and non-JPEG-using requests is submitted by * the application, then the HAL will have to delay JPEG-using requests * whenever the JPEG encoder is still busy processing an older capture. * This will happen whenever a JPEG-using request starts capture less * than FJ ns after a previous JPEG-using request. The minimum * supported frame duration will vary between the values calculated in * #6 and #7.
    9. *
* * @see CameraCharacteristics#SCALER_AVAILABLE_JPEG_MIN_DURATIONS * @see CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS */ public static final Key SENSOR_FRAME_DURATION = new Key("android.sensor.frameDuration", long.class); /** *

Gain applied to image data. Must be * implemented through analog gain only if set to values * below 'maximum analog sensitivity'.

*

If the sensor can't apply this exact gain, it should lessen the * gain to the nearest possible value (rather than gain more).

*

ISO 12232:2006 REI method

*/ public static final Key SENSOR_SENSITIVITY = new Key("android.sensor.sensitivity", int.class); /** *

Time at start of exposure of first * row

*

Monotonic, should be synced to other timestamps in * system

*/ public static final Key SENSOR_TIMESTAMP = new Key("android.sensor.timestamp", long.class); /** *

The temperature of the sensor, sampled at the time * exposure began for this frame.

*

The thermal diode being queried should be inside the sensor PCB, or * somewhere close to it.

*

Optional - This value may be {@code null} on some devices.

*

Full capability - * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key

* * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL */ public static final Key SENSOR_TEMPERATURE = new Key("android.sensor.temperature", float.class); /** *

When enabled, the sensor sends a test pattern instead of * doing a real exposure from the camera.

*

When a test pattern is enabled, all manual sensor controls specified * by android.sensor.* should be ignored. All other controls should * work as normal.

*

For example, if manual flash is enabled, flash firing should still * occur (and that the test pattern remain unmodified, since the flash * would not actually affect it).

*

Optional - This value may be {@code null} on some devices.

* @see #SENSOR_TEST_PATTERN_MODE_OFF * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY * @see #SENSOR_TEST_PATTERN_MODE_PN9 * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 */ public static final Key SENSOR_TEST_PATTERN_MODE = new Key("android.sensor.testPatternMode", int.class); /** *

Quality of lens shading correction applied * to the image data.

*

When set to OFF mode, no lens shading correction will be applied by the * camera device, and an identity lens shading map data will be provided * if {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON. For example, for lens * shading map with size specified as {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize} = [ 4, 3 ], * the output {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} for this case will be an identity map * shown below:

* 
[ 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
     * 1.0, 1.0, 1.0, 1.0,   1.0, 1.0, 1.0, 1.0,
     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0 ]
     *
*

When set to other modes, lens shading correction will be applied by the * camera device. Applications can request lens shading map data by setting * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide * lens shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap}, with size specified * by {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize}.

* * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE * @see CaptureResult#STATISTICS_LENS_SHADING_MAP * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE * @see #SHADING_MODE_OFF * @see #SHADING_MODE_FAST * @see #SHADING_MODE_HIGH_QUALITY * @hide */ public static final Key SHADING_MODE = new Key("android.shading.mode", int.class); /** *

State of the face detector * unit

*

Whether face detection is enabled, and whether it * should output just the basic fields or the full set of * fields. Value must be one of the * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.

* * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES * @see #STATISTICS_FACE_DETECT_MODE_OFF * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE * @see #STATISTICS_FACE_DETECT_MODE_FULL */ public static final Key STATISTICS_FACE_DETECT_MODE = new Key("android.statistics.faceDetectMode", int.class); /** *

List of unique IDs for detected * faces

*

Only available if faceDetectMode == FULL

* @hide */ public static final Key STATISTICS_FACE_IDS = new Key("android.statistics.faceIds", int[].class); /** *

List of landmarks for detected * faces

*

Only available if faceDetectMode == FULL

* @hide */ public static final Key STATISTICS_FACE_LANDMARKS = new Key("android.statistics.faceLandmarks", int[].class); /** *

List of the bounding rectangles for detected * faces

*

Only available if faceDetectMode != OFF

* @hide */ public static final Key STATISTICS_FACE_RECTANGLES = new Key("android.statistics.faceRectangles", android.graphics.Rect[].class); /** *

List of the face confidence scores for * detected faces

*

Only available if faceDetectMode != OFF. The value should be * meaningful (for example, setting 100 at all times is illegal).

* @hide */ public static final Key STATISTICS_FACE_SCORES = new Key("android.statistics.faceScores", byte[].class); /** *

The shading map is a low-resolution floating-point map * that lists the coefficients used to correct for vignetting, for each * Bayer color channel.

*

The least shaded section of the image should have a gain factor * of 1; all other sections should have gains above 1.

*

When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map * must take into account the colorCorrection settings.

*

The shading map is for the entire active pixel array, and is not * affected by the crop region specified in the request. Each shading map * entry is the value of the shading compensation map over a specific * pixel on the sensor. Specifically, with a (N x M) resolution shading * map, and an active pixel array size (W x H), shading map entry * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. * The map is assumed to be bilinearly interpolated between the sample points.

*

The channel order is [R, Geven, Godd, B], where Geven is the green * channel for the even rows of a Bayer pattern, and Godd is the odd rows. * The shading map is stored in a fully interleaved format, and its size * is provided in the camera static metadata by {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize}.

*

The shading map should have on the order of 30-40 rows and columns, * and must be smaller than 64x64.

*

As an example, given a very small map defined as:

* 
{@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize} = [ 4, 3 ]
     * {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} =
     * [ 1.3, 1.2, 1.15, 1.2,  1.2, 1.2, 1.15, 1.2,
     * 1.1, 1.2, 1.2, 1.2,  1.3, 1.2, 1.3, 1.3,
     * 1.2, 1.2, 1.25, 1.1,  1.1, 1.1, 1.1, 1.0,
     * 1.0, 1.0, 1.0, 1.0,  1.2, 1.3, 1.25, 1.2,
     * 1.3, 1.2, 1.2, 1.3,   1.2, 1.15, 1.1, 1.2,
     * 1.2, 1.1, 1.0, 1.2,  1.3, 1.15, 1.2, 1.3 ]
     *
*

The low-resolution scaling map images for each channel are * (displayed using nearest-neighbor interpolation):

*

Red lens shading map * Green (even rows) lens shading map * Green (odd rows) lens shading map * Blue lens shading map

*

As a visualization only, inverting the full-color map to recover an * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:

*

Image of a uniform white wall (inverse shading map)

* * @see CaptureRequest#COLOR_CORRECTION_MODE * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE * @see CaptureResult#STATISTICS_LENS_SHADING_MAP */ public static final Key STATISTICS_LENS_SHADING_MAP = new Key("android.statistics.lensShadingMap", float[].class); /** *

The best-fit color channel gains calculated * by the HAL's statistics units for the current output frame

*

This may be different than the gains used for this frame, * since statistics processing on data from a new frame * typically completes after the transform has already been * applied to that frame.

*

The 4 channel gains are defined in Bayer domain, * see {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} for details.

*

This value should always be calculated by the AWB block, * regardless of the android.control.* current values.

*

Optional - This value may be {@code null} on some devices.

* * @see CaptureRequest#COLOR_CORRECTION_GAINS * @hide */ public static final Key STATISTICS_PREDICTED_COLOR_GAINS = new Key("android.statistics.predictedColorGains", float[].class); /** *

The best-fit color transform matrix estimate * calculated by the HAL's statistics units for the current * output frame

*

The HAL must provide the estimate from its * statistics unit on the white balance transforms to use * for the next frame. These are the values the HAL believes * are the best fit for the current output frame. This may * be different than the transform used for this frame, since * statistics processing on data from a new frame typically * completes after the transform has already been applied to * that frame.

*

These estimates must be provided for all frames, even if * capture settings and color transforms are set by the application.

*

This value should always be calculated by the AWB block, * regardless of the android.control.* current values.

*

Optional - This value may be {@code null} on some devices.

* @hide */ public static final Key STATISTICS_PREDICTED_COLOR_TRANSFORM = new Key("android.statistics.predictedColorTransform", Rational[].class); /** *

The HAL estimated scene illumination lighting * frequency

*

Report NONE if there doesn't appear to be flickering * illumination

* @see #STATISTICS_SCENE_FLICKER_NONE * @see #STATISTICS_SCENE_FLICKER_50HZ * @see #STATISTICS_SCENE_FLICKER_60HZ */ public static final Key STATISTICS_SCENE_FLICKER = new Key("android.statistics.sceneFlicker", int.class); /** *

Tonemapping / contrast / gamma curve for the blue * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is * CONTRAST_CURVE.

*

See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.

* * @see CaptureRequest#TONEMAP_CURVE_RED * @see CaptureRequest#TONEMAP_MODE */ public static final Key TONEMAP_CURVE_BLUE = new Key("android.tonemap.curveBlue", float[].class); /** *

Tonemapping / contrast / gamma curve for the green * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is * CONTRAST_CURVE.

*

See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.

* * @see CaptureRequest#TONEMAP_CURVE_RED * @see CaptureRequest#TONEMAP_MODE */ public static final Key TONEMAP_CURVE_GREEN = new Key("android.tonemap.curveGreen", float[].class); /** *

Tonemapping / contrast / gamma curve for the red * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is * CONTRAST_CURVE.

*

Each channel's curve is defined by an array of control points:

* 
{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} =
     * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]
     * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}
*

These are sorted in order of increasing Pin; it is always * guaranteed that input values 0.0 and 1.0 are included in the list to * define a complete mapping. For input values between control points, * the camera device must linearly interpolate between the control * points.

*

Each curve can have an independent number of points, and the number * of points can be less than max (that is, the request doesn't have to * always provide a curve with number of points equivalent to * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).

*

A few examples, and their corresponding graphical mappings; these * only specify the red channel and the precision is limited to 4 * digits, for conciseness.

*

Linear mapping:

* 
{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 0, 0, 1.0, 1.0 ]
     *
*

Linear mapping curve

*

Invert mapping:

* 
{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 0, 1.0, 1.0, 0 ]
     *
*

Inverting mapping curve

*

Gamma 1/2.2 mapping, with 16 control points:

* 
{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [
     * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812,
     * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072,
     * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685,
     * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ]
     *
*

Gamma = 1/2.2 tonemapping curve

*

Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:

* 
{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [
     * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845,
     * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130,
     * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721,
     * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ]
     *
*

sRGB tonemapping curve

* * @see CaptureRequest#TONEMAP_CURVE_RED * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS * @see CaptureRequest#TONEMAP_MODE */ public static final Key TONEMAP_CURVE_RED = new Key("android.tonemap.curveRed", float[].class); /** *

High-level global contrast/gamma/tonemapping control.

*

When switching to an application-defined contrast curve by setting * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined * per-channel with a set of (in, out) points that specify the * mapping from input high-bit-depth pixel value to the output * low-bit-depth value. Since the actual pixel ranges of both input * and output may change depending on the camera pipeline, the values * are specified by normalized floating-point numbers.

*

More-complex color mapping operations such as 3D color look-up * tables, selective chroma enhancement, or other non-linear color * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is * CONTRAST_CURVE.

*

When using either FAST or HIGH_QUALITY, the camera device will * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed}, * {@link CaptureRequest#TONEMAP_CURVE_GREEN android.tonemap.curveGreen}, and {@link CaptureRequest#TONEMAP_CURVE_BLUE android.tonemap.curveBlue}. * These values are always available, and as close as possible to the * actually used nonlinear/nonglobal transforms.

*

If a request is sent with TRANSFORM_MATRIX with the camera device's * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be * roughly the same.

* * @see CaptureRequest#TONEMAP_CURVE_BLUE * @see CaptureRequest#TONEMAP_CURVE_GREEN * @see CaptureRequest#TONEMAP_CURVE_RED * @see CaptureRequest#TONEMAP_MODE * @see #TONEMAP_MODE_CONTRAST_CURVE * @see #TONEMAP_MODE_FAST * @see #TONEMAP_MODE_HIGH_QUALITY */ public static final Key TONEMAP_MODE = new Key("android.tonemap.mode", int.class); /** *

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 certain rare circumstances, the OS may * disable this when video is processed locally and not transmitted to * any untrusted applications.

*

In particular, the LED must always be on when the data could be * transmitted off the device. The LED should always be on whenever * data is stored locally on the device.

*

The LED may be off if a trusted application is using the data that * doesn't violate the above rules.

* @hide */ public static final Key LED_TRANSMIT = new Key("android.led.transmit", boolean.class); /** *

Whether black-level compensation is locked * to its current values, or is free to vary.

*

Whether the black level offset was locked for this frame. Should be * ON if {@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock} was ON in the capture request, unless * a change in other capture settings forced the camera device to * perform a black level reset.

* * @see CaptureRequest#BLACK_LEVEL_LOCK */ public static final Key BLACK_LEVEL_LOCK = new Key("android.blackLevel.lock", boolean.class); /** *

The frame number corresponding to the last request * with which the output result (metadata + buffers) has been fully * synchronized.

*

When a request is submitted to the camera device, there is usually a * delay of several frames before the controls get applied. A camera * device may either choose to account for this delay by implementing a * pipeline and carefully submit well-timed atomic control updates, or * it may start streaming control changes that span over several frame * boundaries.

*

In the latter case, whenever a request's settings change relative to * the previous submitted request, the full set of changes may take * multiple frame durations to fully take effect. Some settings may * take effect sooner (in less frame durations) than others.

*

While a set of control changes are being propagated, this value * will be CONVERGING.

*

Once it is fully known that a set of control changes have been * finished propagating, and the resulting updated control settings * have been read back by the camera device, this value will be set * to a non-negative frame number (corresponding to the request to * which the results have synchronized to).

*

Older camera device implementations may not have a way to detect * when all camera controls have been applied, and will always set this * value to UNKNOWN.

*

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, results for this current request and up to * {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} prior requests may have their * android.sync.frameNumber change to CONVERGING.

* * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH * @see #SYNC_FRAME_NUMBER_CONVERGING * @see #SYNC_FRAME_NUMBER_UNKNOWN * @hide */ public static final Key SYNC_FRAME_NUMBER = new Key("android.sync.frameNumber", int.class); /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ * End generated code *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ /** *

* List of the {@link Face Faces} detected through camera face detection * in this result. *

*

* Only available if {@link #STATISTICS_FACE_DETECT_MODE} {@code !=} * {@link CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF OFF}. *

* * @see Face */ public static final Key STATISTICS_FACES = new Key("android.statistics.faces", Face[].class); }