/* * 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; import android.hardware.camera2.params.Face; import android.util.Rational; /** *
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 publicWhenever 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);
* }
* };
*
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. *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ /** *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 {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this * control is overridden by the AWB routine. When AWB is disabled, the * application controls how the color mapping is performed.
*We define the expected processing pipeline below. For consistency * across devices, this is always the case with TRANSFORM_MATRIX.
*When either FULL or HIGH_QUALITY is used, the camera device may * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the * camera device (in the results) and be roughly correct.
*Switching to TRANSFORM_MATRIX and using the data provided from * FAST or HIGH_QUALITY will yield a picture with the same white point * as what was produced by the camera device in the earlier frame.
*The expected processing pipeline is as follows:
* *The white balance is encoded by two values, a 4-channel white-balance * gain vector (applied in the Bayer domain), and a 3x3 color transform * matrix (applied after demosaic).
*The 4-channel white-balance gains are defined as:
*{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ 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.
* These may be identical for a given camera device implementation; if
* the camera device does not support a separate gain for even/odd green
* channels, it will use the G_even
value, and write G_odd
equal to
* G_even
in the output result metadata.
The matrices for color transforms are defined as a 9-entry vector:
*{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
*
* which define a transform from input sensor colors, P_in = [ r g b ]
,
* to output linear sRGB, P_out = [ r' g' b' ]
,
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. Overflow/underflow * values are clipped to fit within the range.
* * @see CaptureRequest#COLOR_CORRECTION_GAINS * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM * @see CaptureRequest#CONTROL_AWB_MODE * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX * @see #COLOR_CORRECTION_MODE_FAST * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY */ public static final KeyA 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 * {@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 camera device may round the matrix to account
* for precision issues; the final rounded matrix should be reported back
* in this matrix result metadata. The transform should keep the magnitude
* of the output color values within [0, 1.0]
(assuming input color
* values is within the normalized range [0, 1.0]
), or clipping may occur.
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 the camera device 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 camera device to * the current frame.
* * @see CaptureRequest#COLOR_CORRECTION_MODE */ public static final KeyThe desired setting for the camera device's auto-exposure * algorithm's antibanding compensation.
*Some kinds of lighting fixtures, such as some fluorescent * lights, flicker at the rate of the power supply frequency * (60Hz or 50Hz, depending on country). While this is * typically not noticeable to a person, it can be visible to * a camera device. If a camera sets its exposure time to the * wrong value, the flicker may become visible in the * viewfinder as flicker or in a final captured image, as a * set of variable-brightness bands across the image.
*Therefore, the auto-exposure routines of camera devices * include antibanding routines that ensure that the chosen * exposure value will not cause such banding. The choice of * exposure time depends on the rate of flicker, which the * camera device can detect automatically, or the expected * rate can be selected by the application using this * control.
*A given camera device may not support all of the possible * options for the antibanding mode. The * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains * the available modes for a given camera device.
*The default mode is AUTO, which must be supported by all * camera devices.
*If manual exposure control is enabled (by setting * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), * then this setting has no effect, and the application must * ensure it selects exposure times that do not cause banding * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist * the application in this.
* * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureRequest#CONTROL_MODE * @see CaptureResult#STATISTICS_SCENE_FLICKER * @see #CONTROL_AE_ANTIBANDING_MODE_OFF * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO */ public static final KeyAdjustment to AE target image * brightness
*For example, if EV step is 0.333, '6' will mean an
* exposure compensation of +2 EV; -3 will mean an exposure
* compensation of -1 EV. Note that this control will only be effective
* if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} !=
OFF. This control will take effect even when
* {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == true
.
In the event of exposure compensation value being changed, camera device * may take several frames to reach the newly requested exposure target. * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or * FLASH_REQUIRED (if the scene is too dark for still capture).
* * @see CaptureRequest#CONTROL_AE_LOCK * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureResult#CONTROL_AE_STATE */ public static final KeyWhether AE is currently locked to its latest * calculated values.
*Note that even when AE is locked, the flash may be * fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / ON_ALWAYS_FLASH / * ON_AUTO_FLASH_REDEYE.
*When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock * is ON, the camera device will still adjust its exposure value.
*If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) * when AE is already locked, the camera device will not change the exposure time * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.
*See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.
* * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER * @see CaptureResult#CONTROL_AE_STATE * @see CaptureRequest#SENSOR_EXPOSURE_TIME * @see CaptureRequest#SENSOR_SENSITIVITY */ public static final KeyThe 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 KeyList 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 camera device. If the metering region is * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device * will 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 KeyRange over which fps can be adjusted to * maintain exposure
*Only constrains AE algorithm, not manual control * of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}
* * @see CaptureRequest#SENSOR_EXPOSURE_TIME */ public static final KeyWhether the camera device will trigger a precapture * metering sequence when it processes this request.
*This entry is normally set to IDLE, or is not * included at all in the request settings. When included and * set to START, the camera device will trigger the autoexposure * precapture metering sequence.
*The effect of AE precapture trigger depends on the current * AE mode and state; see {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture * state transition details.
* * @see CaptureResult#CONTROL_AE_STATE * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START */ public static final KeyCurrent 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.
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | ** | INACTIVE | *Camera device auto exposure algorithm is disabled | *
When {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is AE_MODE_ON_*:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *Camera device initiates AE scan | *SEARCHING | *Values changing | *
INACTIVE | *{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON | *LOCKED | *Values locked | *
SEARCHING | *Camera device finishes AE scan | *CONVERGED | *Good values, not changing | *
SEARCHING | *Camera device finishes AE scan | *FLASH_REQUIRED | *Converged but too dark w/o flash | *
SEARCHING | *{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON | *LOCKED | *Values locked | *
CONVERGED | *Camera device initiates AE scan | *SEARCHING | *Values changing | *
CONVERGED | *{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON | *LOCKED | *Values locked | *
FLASH_REQUIRED | *Camera device initiates AE scan | *SEARCHING | *Values changing | *
FLASH_REQUIRED | *{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON | *LOCKED | *Values locked | *
LOCKED | *{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF | *SEARCHING | *Values not good after unlock | *
LOCKED | *{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF | *CONVERGED | *Values good after unlock | *
LOCKED | *{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF | *FLASH_REQUIRED | *Exposure good, but too dark | *
PRECAPTURE | *Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF | *CONVERGED | *Ready for high-quality capture | *
PRECAPTURE | *Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON | *LOCKED | *Ready for high-quality capture | *
Any state | *{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START | *PRECAPTURE | *Start AE precapture metering sequence | *
For the above table, the camera device may skip reporting any state changes that happen * without application intervention (i.e. mode switch, trigger, locking). Any state that * can be skipped in that manner is called a transient state.
*For example, for above AE modes (AE_MODE_ON_*), in addition to the state transitions * listed in above table, it is also legal for the camera device to skip one or more * transient states between two results. See below table for examples:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *Camera device finished AE scan | *CONVERGED | *Values are already good, transient states are skipped by camera device. | *
Any state | *{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done | *FLASH_REQUIRED | *Converged but too dark w/o flash after a precapture sequence, transient states are skipped by camera device. | *
Any state | *{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done | *CONVERGED | *Converged after a precapture sequence, transient states are skipped by camera device. | *
CONVERGED | *Camera device finished AE scan | *FLASH_REQUIRED | *Converged but too dark w/o flash after a new scan, transient states are skipped by camera device. | *
FLASH_REQUIRED | *Camera device finished AE scan | *CONVERGED | *Converged after a new scan, transient states are skipped by camera device. | *
Whether AF is currently enabled, and what * mode it is set to
*Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus
* (i.e. {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0
).
If the lens is controlled by the camera device auto-focus algorithm, * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} * in result metadata.
* * @see CaptureResult#CONTROL_AF_STATE * @see CaptureRequest#CONTROL_MODE * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE * @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 KeyList 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 camera device. If the focusing region is * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device * will 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 KeyWhether the camera device will trigger autofocus for this request.
*This entry is normally set to IDLE, or is not * included at all in the request settings.
*When included and set to START, the camera device will trigger the * autofocus algorithm. If autofocus is disabled, this trigger has no effect.
*When set to CANCEL, the camera device will cancel any active trigger, * and return to its initial AF state.
*See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what that means for each AF mode.
* * @see CaptureResult#CONTROL_AF_STATE * @see #CONTROL_AF_TRIGGER_IDLE * @see #CONTROL_AF_TRIGGER_START * @see #CONTROL_AF_TRIGGER_CANCEL */ public static final KeyCurrent 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:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | ** | INACTIVE | *Never changes | *
When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_AUTO or AF_MODE_MACRO:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *AF_TRIGGER | *ACTIVE_SCAN | *Start AF sweep, Lens now moving | *
ACTIVE_SCAN | *AF sweep done | *FOCUSED_LOCKED | *Focused, Lens now locked | *
ACTIVE_SCAN | *AF sweep done | *NOT_FOCUSED_LOCKED | *Not focused, Lens now locked | *
ACTIVE_SCAN | *AF_CANCEL | *INACTIVE | *Cancel/reset AF, Lens now locked | *
FOCUSED_LOCKED | *AF_CANCEL | *INACTIVE | *Cancel/reset AF | *
FOCUSED_LOCKED | *AF_TRIGGER | *ACTIVE_SCAN | *Start new sweep, Lens now moving | *
NOT_FOCUSED_LOCKED | *AF_CANCEL | *INACTIVE | *Cancel/reset AF | *
NOT_FOCUSED_LOCKED | *AF_TRIGGER | *ACTIVE_SCAN | *Start new sweep, Lens now moving | *
Any state | *Mode change | *INACTIVE | ** |
For the above table, the camera device may skip reporting any state changes that happen * without application intervention (i.e. mode switch, trigger, locking). Any state that * can be skipped in that manner is called a transient state.
*For example, for these AF modes (AF_MODE_AUTO and AF_MODE_MACRO), in addition to the * state transitions listed in above table, it is also legal for the camera device to skip * one or more transient states between two results. See below table for examples:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *AF_TRIGGER | *FOCUSED_LOCKED | *Focus is already good or good after a scan, lens is now locked. | *
INACTIVE | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *Focus failed after a scan, lens is now locked. | *
FOCUSED_LOCKED | *AF_TRIGGER | *FOCUSED_LOCKED | *Focus is already good or good after a scan, lens is now locked. | *
NOT_FOCUSED_LOCKED | *AF_TRIGGER | *FOCUSED_LOCKED | *Focus is good after a scan, lens is not locked. | *
When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_VIDEO:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *Camera device initiates new scan | *PASSIVE_SCAN | *Start AF scan, Lens now moving | *
INACTIVE | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *AF state query, Lens now locked | *
PASSIVE_SCAN | *Camera device completes current scan | *PASSIVE_FOCUSED | *End AF scan, Lens now locked | *
PASSIVE_SCAN | *Camera device fails current scan | *PASSIVE_UNFOCUSED | *End AF scan, Lens now locked | *
PASSIVE_SCAN | *AF_TRIGGER | *FOCUSED_LOCKED | *Immediate trans. If focus is good, Lens now locked | *
PASSIVE_SCAN | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *Immediate trans. if focus is bad, Lens now locked | *
PASSIVE_SCAN | *AF_CANCEL | *INACTIVE | *Reset lens position, Lens now locked | *
PASSIVE_FOCUSED | *Camera device initiates new scan | *PASSIVE_SCAN | *Start AF scan, Lens now moving | *
PASSIVE_UNFOCUSED | *Camera device initiates new scan | *PASSIVE_SCAN | *Start AF scan, Lens now moving | *
PASSIVE_FOCUSED | *AF_TRIGGER | *FOCUSED_LOCKED | *Immediate trans. Lens now locked | *
PASSIVE_UNFOCUSED | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *Immediate trans. Lens now locked | *
FOCUSED_LOCKED | *AF_TRIGGER | *FOCUSED_LOCKED | *No effect | *
FOCUSED_LOCKED | *AF_CANCEL | *INACTIVE | *Restart AF scan | *
NOT_FOCUSED_LOCKED | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *No effect | *
NOT_FOCUSED_LOCKED | *AF_CANCEL | *INACTIVE | *Restart AF scan | *
When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_PICTURE:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *Camera device initiates new scan | *PASSIVE_SCAN | *Start AF scan, Lens now moving | *
INACTIVE | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *AF state query, Lens now locked | *
PASSIVE_SCAN | *Camera device completes current scan | *PASSIVE_FOCUSED | *End AF scan, Lens now locked | *
PASSIVE_SCAN | *Camera device fails current scan | *PASSIVE_UNFOCUSED | *End AF scan, Lens now locked | *
PASSIVE_SCAN | *AF_TRIGGER | *FOCUSED_LOCKED | *Eventual trans. once focus good, Lens now locked | *
PASSIVE_SCAN | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *Eventual trans. if cannot focus, Lens now locked | *
PASSIVE_SCAN | *AF_CANCEL | *INACTIVE | *Reset lens position, Lens now locked | *
PASSIVE_FOCUSED | *Camera device initiates new scan | *PASSIVE_SCAN | *Start AF scan, Lens now moving | *
PASSIVE_UNFOCUSED | *Camera device initiates new scan | *PASSIVE_SCAN | *Start AF scan, Lens now moving | *
PASSIVE_FOCUSED | *AF_TRIGGER | *FOCUSED_LOCKED | *Immediate trans. Lens now locked | *
PASSIVE_UNFOCUSED | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *Immediate trans. Lens now locked | *
FOCUSED_LOCKED | *AF_TRIGGER | *FOCUSED_LOCKED | *No effect | *
FOCUSED_LOCKED | *AF_CANCEL | *INACTIVE | *Restart AF scan | *
NOT_FOCUSED_LOCKED | *AF_TRIGGER | *NOT_FOCUSED_LOCKED | *No effect | *
NOT_FOCUSED_LOCKED | *AF_CANCEL | *INACTIVE | *Restart AF scan | *
When switch between AF_MODE_CONTINUOUS_* (CAF modes) and AF_MODE_AUTO/AF_MODE_MACRO * (AUTO modes), the initial INACTIVE or PASSIVE_SCAN states may be skipped by the * camera device. When a trigger is included in a mode switch request, the trigger * will be evaluated in the context of the new mode in the request. * See below table for examples:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
any state | *CAF-->AUTO mode switch | *INACTIVE | *Mode switch without trigger, initial state must be INACTIVE | *
any state | *CAF-->AUTO mode switch with AF_TRIGGER | *trigger-reachable states from INACTIVE | *Mode switch with trigger, INACTIVE is skipped | *
any state | *AUTO-->CAF mode switch | *passively reachable states from INACTIVE | *Mode switch without trigger, passive transient state is skipped | *
Whether AWB is currently locked to its * latest calculated values.
*Note that AWB lock is only meaningful for AUTO * mode; in other modes, AWB is already fixed to a specific * setting.
*/ public static final KeyWhether 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 application manually controls the white * balance by {@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 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 KeyList 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 auto-white balance (AWB) area * needs to be used by the camera device. If the AWB region is * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device * will 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 KeyInformation to the camera device 3A (auto-exposure, * auto-focus, auto-white balance) routines about the purpose * of this capture, to help the camera device to decide optimal 3A * strategy.
*This control (except for MANUAL) is only effective if
* {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF
and any 3A routine is active.
ZERO_SHUTTER_LAG must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} * contains ZSL. MANUAL must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} * contains MANUAL_SENSOR.
* * @see CaptureRequest#CONTROL_MODE * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES * @see #CONTROL_CAPTURE_INTENT_CUSTOM * @see #CONTROL_CAPTURE_INTENT_PREVIEW * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG * @see #CONTROL_CAPTURE_INTENT_MANUAL */ public static final KeyCurrent 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
:
State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | ** | INACTIVE | *Camera device auto white balance algorithm is disabled | *
When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is AWB_MODE_AUTO:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *Camera device initiates AWB scan | *SEARCHING | *Values changing | *
INACTIVE | *{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON | *LOCKED | *Values locked | *
SEARCHING | *Camera device finishes AWB scan | *CONVERGED | *Good values, not changing | *
SEARCHING | *{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON | *LOCKED | *Values locked | *
CONVERGED | *Camera device initiates AWB scan | *SEARCHING | *Values changing | *
CONVERGED | *{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON | *LOCKED | *Values locked | *
LOCKED | *{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF | *SEARCHING | *Values not good after unlock | *
For the above table, the camera device may skip reporting any state changes that happen * without application intervention (i.e. mode switch, trigger, locking). Any state that * can be skipped in that manner is called a transient state.
*For example, for this AWB mode (AWB_MODE_AUTO), in addition to the state transitions * listed in above table, it is also legal for the camera device to skip one or more * transient states between two results. See below table for examples:
*State | *Transition Cause | *New State | *Notes | *
---|---|---|---|
INACTIVE | *Camera device finished AWB scan | *CONVERGED | *Values are already good, transient states are skipped by camera device. | *
LOCKED | *{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF | *CONVERGED | *Values good after unlock, transient states are skipped by camera device. | *
A special color effect to apply.
*When this mode is set, a color effect will be applied * to images produced by the camera device. The interpretation * and implementation of these color effects is left to the * implementor of the camera device, and should not be * depended on to be consistent (or present) across all * devices.
*A color effect will only be applied if * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.
* * @see CaptureRequest#CONTROL_MODE * @see #CONTROL_EFFECT_MODE_OFF * @see #CONTROL_EFFECT_MODE_MONO * @see #CONTROL_EFFECT_MODE_NEGATIVE * @see #CONTROL_EFFECT_MODE_SOLARIZE * @see #CONTROL_EFFECT_MODE_SEPIA * @see #CONTROL_EFFECT_MODE_POSTERIZE * @see #CONTROL_EFFECT_MODE_WHITEBOARD * @see #CONTROL_EFFECT_MODE_BLACKBOARD * @see #CONTROL_EFFECT_MODE_AQUA */ public static final KeyOverall 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.
*When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference * is that this frame will not be used by camera device background 3A statistics * update, as if this frame is never captured. This mode can be used in the scenario * where the application doesn't want a 3A manual control capture to affect * the subsequent auto 3A capture results.
* * @see CaptureRequest#CONTROL_AF_MODE * @see #CONTROL_MODE_OFF * @see #CONTROL_MODE_AUTO * @see #CONTROL_MODE_USE_SCENE_MODE * @see #CONTROL_MODE_OFF_KEEP_STATE */ public static final KeyA camera mode optimized for conditions typical in a particular * capture setting.
*This is the mode that that is active when
* {@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE
. Aside from FACE_PRIORITY,
* these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode},
* {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.
The interpretation and implementation of these scene modes is left * to the implementor of the camera device. Their behavior will not be * consistent across all devices, and any given device may only implement * a subset of these modes.
* * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureRequest#CONTROL_AF_MODE * @see CaptureRequest#CONTROL_AWB_MODE * @see CaptureRequest#CONTROL_MODE * @see #CONTROL_SCENE_MODE_DISABLED * @see #CONTROL_SCENE_MODE_FACE_PRIORITY * @see #CONTROL_SCENE_MODE_ACTION * @see #CONTROL_SCENE_MODE_PORTRAIT * @see #CONTROL_SCENE_MODE_LANDSCAPE * @see #CONTROL_SCENE_MODE_NIGHT * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT * @see #CONTROL_SCENE_MODE_THEATRE * @see #CONTROL_SCENE_MODE_BEACH * @see #CONTROL_SCENE_MODE_SNOW * @see #CONTROL_SCENE_MODE_SUNSET * @see #CONTROL_SCENE_MODE_STEADYPHOTO * @see #CONTROL_SCENE_MODE_FIREWORKS * @see #CONTROL_SCENE_MODE_SPORTS * @see #CONTROL_SCENE_MODE_PARTY * @see #CONTROL_SCENE_MODE_CANDLELIGHT * @see #CONTROL_SCENE_MODE_BARCODE */ public static final KeyWhether video stabilization is * active
*If enabled, video stabilization can modify the * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream * stabilized
* * @see CaptureRequest#SCALER_CROP_REGION * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON */ public static final KeyOperation mode for edge * enhancement.
*Edge/sharpness/detail enhancement. OFF means no * enhancement will be applied by the camera device.
*This must be set to one of the modes listed in {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}.
*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 CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES * @see #EDGE_MODE_OFF * @see #EDGE_MODE_FAST * @see #EDGE_MODE_HIGH_QUALITY */ public static final KeyThe 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} == true
).
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.
*The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.
* * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER * @see CameraCharacteristics#FLASH_INFO_AVAILABLE * @see CaptureResult#FLASH_STATE * @see #FLASH_MODE_OFF * @see #FLASH_MODE_SINGLE * @see #FLASH_MODE_TORCH */ public static final KeyCurrent state of the flash * unit.
*When the camera device doesn't have flash unit
* (i.e. {@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == false
), this state will always be UNAVAILABLE.
* Other states indicate the current flash status.
Set operational mode for hot pixel correction.
*Valid modes for this camera device are listed in * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}.
*Hotpixel correction interpolates out, or otherwise removes, pixels * that do not accurately encode the incoming light (i.e. pixels that * are stuck at an arbitrary value).
* * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES * @see #HOT_PIXEL_MODE_OFF * @see #HOT_PIXEL_MODE_FAST * @see #HOT_PIXEL_MODE_HIGH_QUALITY */ public static final KeyGPS coordinates to include in output JPEG * EXIF
*/ public static final Key32 characters describing GPS algorithm to * include in EXIF
*/ public static final KeyTime GPS fix was made to include in * EXIF
*/ public static final KeyOrientation of JPEG image to * write
*/ public static final KeyCompression quality of the final JPEG * image
*85-95 is typical usage range
*/ public static final KeyCompression quality of JPEG * thumbnail
*/ public static final KeyResolution 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 KeyThe 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 {@link CaptureRequest#SENSOR_FRAME_DURATION 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. * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.
*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 CaptureResult#LENS_STATE * @see CaptureRequest#SENSOR_EXPOSURE_TIME * @see CaptureRequest#SENSOR_FRAME_DURATION * @see CaptureRequest#SENSOR_SENSITIVITY */ public static final KeyState 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).
*It may take several frames before the lens filter density changes * to the requested value. While the filter density is still changing, * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.
* * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES * @see CaptureResult#LENS_STATE */ public static final KeyThe 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 change 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 KeyDistance to plane of sharpest focus, * measured from frontmost surface of the lens
*Should be zero for fixed-focus cameras
*/ public static final KeyThe 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 KeySets 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 KeyCurrent lens status.
*For lens parameters {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}, * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, when changes are requested, * they may take several frames to reach the requested values. This state indicates * the current status of the lens parameters.
*When the state is STATIONARY, the lens parameters are not changing. This could be * either because the parameters are all fixed, or because the lens has had enough * time to reach the most recently-requested values. * If all these lens parameters are not changable for a camera device, as listed below:
*{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} == 0
), which means
* {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} parameter will always be 0.Then this state will always be STATIONARY.
*When the state is MOVING, it indicates that at least one of the lens parameters * is changing.
* * @see CaptureRequest#LENS_APERTURE * @see CaptureRequest#LENS_FILTER_DENSITY * @see CaptureRequest#LENS_FOCAL_LENGTH * @see CaptureRequest#LENS_FOCUS_DISTANCE * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE * @see #LENS_STATE_STATIONARY * @see #LENS_STATE_MOVING */ public static final KeyMode of operation for the noise reduction * algorithm
*Noise filtering control. OFF means no noise reduction * will be applied by the camera device.
*This must be set to a valid mode in * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}.
*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 CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES * @see #NOISE_REDUCTION_MODE_OFF * @see #NOISE_REDUCTION_MODE_FAST * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY */ public static final KeyWhether 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 camera device if quirks.usePartialResult is set to 1.
*Optional - This value may be {@code null} on some devices.
* @deprecated * @hide */ @Deprecated public static final KeyA 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 KeyAn application-specified ID for the current * request. Must be maintained unchanged in output * frame
* @hide */ public static final KeySpecifies 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(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 / * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} ) and floor( * activeArraySize.height / * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom}), respectively.
* * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM */ public static final KeyDuration 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).
*/ public static final KeyDuration 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:
*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 necessary information for the application, given the model above, * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size). * 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 camera * device:
*S
.S
, by
* looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using
* StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with
* its respective size/format). Let this set of frame durations be called
* F
.R
, the minimum frame duration allowed
* for R
is the maximum out of all values in F
. Let the streams
* used in R
be called S_r
.If none of the streams in S_r
have a stall time (listed in
* StreamConfigurationMap#getOutputStallDuration(int,Size) using its
* respective size/format), then the frame duration in
* F
determines the steady state frame rate that the application will
* get if it uses R
as a repeating request. Let this special kind
* of request be called 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, see * StreamConfigurationMap#getOutputStallDuration(int,Size).
* * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP */ public static final KeyGain 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 KeyTime at start of exposure of first * row
*Monotonic, should be synced to other timestamps in * system
*/ public static final KeyThe 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 KeyThe estimated camera neutral color in the native sensor colorspace at * the time of capture.
*This value gives the neutral color point encoded as an RGB value in the * native sensor color space. The neutral color point indicates the * currently estimated white point of the scene illumination. It can be * used to interpolate between the provided color transforms when * processing raw sensor data.
*The order of the values is R, G, B; where R is in the lowest index.
*Optional - This value may be {@code null} on some devices.
*/ public static final KeyThe worst-case divergence between Bayer green channels.
*This value is an estimate of the worst case split between the * Bayer green channels in the red and blue rows in the sensor color * filter array.
*The green split is calculated as follows:
*R = max((mean_Gr + 1)/(mean_Gb + 1), (mean_Gb + 1)/(mean_Gr + 1))
The ratio R is the green split divergence reported for this property, * which represents how much the green channels differ in the mosaic * pattern. This value is typically used to determine the treatment of * the green mosaic channels when demosaicing.
*The green split value can be roughly interpreted as follows:
*Optional - This value may be {@code null} on some devices.
*/ public static final KeyA pixel [R, G_even, G_odd, B]
that supplies the test pattern
* when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.
Each color channel is treated as an unsigned 32-bit integer. * The camera device then uses the most significant X bits * that correspond to how many bits are in its Bayer raw sensor * output.
*For example, a sensor with RAW10 Bayer output would use the * 10 most significant bits from each color channel.
*Optional - This value may be {@code null} on some devices.
* * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE */ public static final KeyWhen 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 KeyQuality 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 */ public static final KeyState 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 KeyList of unique IDs for detected * faces
*Only available if faceDetectMode == FULL
* @hide */ public static final KeyList of landmarks for detected * faces
*Only available if faceDetectMode == FULL
* @hide */ public static final KeyList of the bounding rectangles for detected * faces
*Only available if faceDetectMode != OFF
* @hide */ public static final KeyList 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 KeyList of the faces detected through camera face detection * in this result.
*Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} !=
OFF.
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):
** * *
*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:
* * * @see CaptureRequest#COLOR_CORRECTION_MODE * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE * @see CaptureResult#STATISTICS_LENS_SHADING_MAP */ public static final KeyThe best-fit color channel gains calculated * by the camera device'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 * @deprecated * @hide */ @Deprecated public static final KeyThe best-fit color transform matrix estimate * calculated by the camera device's statistics units for the current * output frame.
*The camera device will provide the estimate from its * statistics unit on the white balance transforms to use * for the next frame. These are the values the camera device 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.
* @deprecated * @hide */ @Deprecated public static final KeyThe camera device estimated scene illumination lighting * frequency.
*Many light sources, such as most fluorescent lights, flicker at a rate * that depends on the local utility power standards. This flicker must be * accounted for by auto-exposure routines to avoid artifacts in captured images. * The camera device uses this entry to tell the application what the scene * illuminant frequency is.
*When manual exposure control is enabled
* ({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} == OFF
or {@link CaptureRequest#CONTROL_MODE android.control.mode} == OFF
),
* the {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} doesn't do the antibanding, and the
* application can ensure it selects exposure times that do not cause banding
* issues by looking into this metadata field. See {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode}
* for more details.
Report NONE if there doesn't appear to be flickering illumination.
* * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE * @see CaptureRequest#CONTROL_AE_MODE * @see CaptureRequest#CONTROL_MODE * @see #STATISTICS_SCENE_FLICKER_NONE * @see #STATISTICS_SCENE_FLICKER_50HZ * @see #STATISTICS_SCENE_FLICKER_60HZ */ public static final KeyOperating mode for hotpixel map generation.
*If set to ON, a hotpixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. * If set to OFF, no hotpixel map should be returned.
*This must be set to a valid mode from {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}.
* * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES */ public static final KeyList of (x, y)
coordinates of hot/defective pixels on the sensor.
A coordinate (x, y)
must lie between (0, 0)
, and
* (width - 1, height - 1)
(inclusive), which are the top-left and
* bottom-right of the pixel array, respectively. The width and
* height dimensions are given in {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.
* This may include hot pixels that lie outside of the active array
* bounds given by {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.
Whether the camera device will output the lens * shading map in output result metadata.
*When set to ON, * {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} must be provided in * the output result metadata.
* * @see CaptureResult#STATISTICS_LENS_SHADING_MAP * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON */ public static final KeyTonemapping / 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 KeyTonemapping / 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 KeyTonemapping / 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 ]
*
*
* Invert mapping:
*{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 0, 1.0, 1.0, 0 ]
*
*
* 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 ]
*
*
* 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 ]
*
*
*
* @see CaptureRequest#TONEMAP_CURVE_RED
* @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
* @see CaptureRequest#TONEMAP_MODE
*/
public static final KeyHigh-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.
*This must be set to a valid mode in * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}.
*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 CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES * @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 KeyThis 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 KeyWhether 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 KeyThe 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:
*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