/* * Copyright (C) 2013 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.os.Parcel; import android.os.Parcelable; import android.view.Surface; import java.util.HashSet; import java.util.Objects; /** *

An immutable package of settings and outputs needed to capture a single * image from the camera device.

* *

Contains the configuration for the capture hardware (sensor, lens, flash), * the processing pipeline, the control algorithms, and the output buffers. Also * contains the list of target Surfaces to send image data to for this * capture.

* *

CaptureRequests can be created by using a {@link Builder} instance, * obtained by calling {@link CameraDevice#createCaptureRequest}

* *

CaptureRequests are given to {@link CameraDevice#capture} or * {@link CameraDevice#setRepeatingRequest} to capture images from a camera.

* *

Each request can specify a different subset of target Surfaces for the * camera to send the captured data to. All the surfaces used in a request must * be part of the surface list given to the last call to * {@link CameraDevice#configureOutputs}, when the request is submitted to the * camera device.

* *

For example, a request meant for repeating preview might only include the * Surface for the preview SurfaceView or SurfaceTexture, while a * high-resolution still capture would also include a Surface from a ImageReader * configured for high-resolution JPEG images.

* * @see CameraDevice#capture * @see CameraDevice#setRepeatingRequest * @see CameraDevice#createCaptureRequest */ public final class CaptureRequest extends CameraMetadata implements Parcelable { private final HashSet mSurfaceSet; private final CameraMetadataNative mSettings; private Object mUserTag; /** * Construct empty request. * * Used by Binder to unparcel this object only. */ private CaptureRequest() { mSettings = new CameraMetadataNative(); mSurfaceSet = new HashSet(); } /** * Clone from source capture request. * * Used by the Builder to create an immutable copy. */ @SuppressWarnings("unchecked") private CaptureRequest(CaptureRequest source) { mSettings = new CameraMetadataNative(source.mSettings); mSurfaceSet = (HashSet) source.mSurfaceSet.clone(); mUserTag = source.mUserTag; } /** * Take ownership of passed-in settings. * * Used by the Builder to create a mutable CaptureRequest. */ private CaptureRequest(CameraMetadataNative settings) { mSettings = settings; mSurfaceSet = new HashSet(); } @SuppressWarnings("unchecked") @Override public T get(Key key) { return mSettings.get(key); } /** * Retrieve the tag for this request, if any. * *

This tag is not used for anything by the camera device, but can be * used by an application to easily identify a CaptureRequest when it is * returned by * {@link CameraDevice.CaptureListener#onCaptureCompleted CaptureListener.onCaptureCompleted} *

* * @return the last tag Object set on this request, or {@code null} if * no tag has been set. * @see Builder#setTag */ public Object getTag() { return mUserTag; } /** * Determine whether this CaptureRequest is equal to another CaptureRequest. * *

A request is considered equal to another is if it's set of key/values is equal, it's * list of output surfaces is equal, and the user tag is equal.

* * @param other Another instance of CaptureRequest. * * @return True if the requests are the same, false otherwise. */ @Override public boolean equals(Object other) { return other instanceof CaptureRequest && equals((CaptureRequest)other); } private boolean equals(CaptureRequest other) { return other != null && Objects.equals(mUserTag, other.mUserTag) && mSurfaceSet.equals(other.mSurfaceSet) && mSettings.equals(other.mSettings); } @Override public int hashCode() { return mSettings.hashCode(); } public static final Parcelable.Creator CREATOR = new Parcelable.Creator() { @Override public CaptureRequest createFromParcel(Parcel in) { CaptureRequest request = new CaptureRequest(); request.readFromParcel(in); return request; } @Override public CaptureRequest[] newArray(int size) { return new CaptureRequest[size]; } }; /** * Expand this object from a Parcel. * Hidden since this breaks the immutability of CaptureRequest, but is * needed to receive CaptureRequests with aidl. * * @param in The parcel from which the object should be read * @hide */ public void readFromParcel(Parcel in) { mSettings.readFromParcel(in); mSurfaceSet.clear(); Parcelable[] parcelableArray = in.readParcelableArray(Surface.class.getClassLoader()); if (parcelableArray == null) { return; } for (Parcelable p : parcelableArray) { Surface s = (Surface) p; mSurfaceSet.add(s); } } @Override public int describeContents() { return 0; } @Override public void writeToParcel(Parcel dest, int flags) { mSettings.writeToParcel(dest, flags); dest.writeParcelableArray(mSurfaceSet.toArray(new Surface[mSurfaceSet.size()]), flags); } /** * A builder for capture requests. * *

To obtain a builder instance, use the * {@link CameraDevice#createCaptureRequest} method, which initializes the * request fields to one of the templates defined in {@link CameraDevice}. * * @see CameraDevice#createCaptureRequest * @see #TEMPLATE_PREVIEW * @see #TEMPLATE_RECORD * @see #TEMPLATE_STILL_CAPTURE * @see #TEMPLATE_VIDEO_SNAPSHOT * @see #TEMPLATE_MANUAL */ public final static class Builder { private final CaptureRequest mRequest; /** * Initialize the builder using the template; the request takes * ownership of the template. * * @hide */ public Builder(CameraMetadataNative template) { mRequest = new CaptureRequest(template); } /** *

Add a surface to the list of targets for this request

* *

The Surface added must be one of the surfaces included in the most * recent call to {@link CameraDevice#configureOutputs}, when the * request is given to the camera device.

* *

Adding a target more than once has no effect.

* * @param outputTarget Surface to use as an output target for this request */ public void addTarget(Surface outputTarget) { mRequest.mSurfaceSet.add(outputTarget); } /** *

Remove a surface from the list of targets for this request.

* *

Removing a target that is not currently added has no effect.

* * @param outputTarget Surface to use as an output target for this request */ public void removeTarget(Surface outputTarget) { mRequest.mSurfaceSet.remove(outputTarget); } /** * Set a capture request field to a value. The field definitions can be * found in {@link CaptureRequest}. * * @param key The metadata field to write. * @param value The value to set the field to, which must be of a matching * type to the key. */ public void set(Key key, T value) { mRequest.mSettings.set(key, value); } /** * Get a capture request field value. The field definitions can be * found in {@link CaptureRequest}. * * @throws IllegalArgumentException if the key was not valid * * @param key The metadata field to read. * @return The value of that key, or {@code null} if the field is not set. */ public T get(Key key) { return mRequest.mSettings.get(key); } /** * Set a tag for this request. * *

This tag is not used for anything by the camera device, but can be * used by an application to easily identify a CaptureRequest when it is * returned by * {@link CameraDevice.CaptureListener#onCaptureCompleted CaptureListener.onCaptureCompleted} * * @param tag an arbitrary Object to store with this request * @see CaptureRequest#getTag */ public void setTag(Object tag) { mRequest.mUserTag = tag; } /** * Build a request using the current target Surfaces and settings. * * @return A new capture request instance, ready for submission to the * camera device. */ public CaptureRequest build() { return new CaptureRequest(mRequest); } /** * @hide */ public boolean isEmpty() { return mRequest.mSettings.isEmpty(); } } /*@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. *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ /** *

When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is not OFF, TRANSFORM_MATRIX * should be ignored.

* * @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 Key COLOR_CORRECTION_MODE = new Key("android.colorCorrection.mode", int.class); /** *

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 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 greenpixels 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 ouput 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 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 CaptureResult#STATISTICS_SCENE_FLICKER * @see CaptureRequest#CONTROL_MODE * @see CaptureRequest#CONTROL_AE_MODE * @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 Key CONTROL_AE_ANTIBANDING_MODE = new Key("android.control.aeAntibandingMode", int.class); /** *

Adjustment 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

*/ public static final Key CONTROL_AE_EXPOSURE_COMPENSATION = new Key("android.control.aeExposureCompensation", int.class); /** *

Whether AE is currently locked to its latest * calculated values

*

Note that even when AE is locked, the flash may be * fired if the AE mode is ON_AUTO_FLASH / ON_ALWAYS_FLASH / * ON_AUTO_FLASH_REDEYE.

*/ public static final Key CONTROL_AE_LOCK = new Key("android.control.aeLock", boolean.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#SENSOR_EXPOSURE_TIME * @see CaptureRequest#SENSOR_FRAME_DURATION * @see CaptureRequest#SENSOR_SENSITIVITY * @see CaptureRequest#FLASH_MODE * @see CameraCharacteristics#FLASH_INFO_AVAILABLE * @see CaptureRequest#CONTROL_MODE * @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 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 CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE * @see CaptureRequest#SCALER_CROP_REGION */ public static final Key CONTROL_AE_REGIONS = new Key("android.control.aeRegions", int[].class); /** *

Range 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 Key CONTROL_AE_TARGET_FPS_RANGE = new Key("android.control.aeTargetFpsRange", int[].class); /** *

Whether the HAL must trigger precapture * metering.

*

This entry is normally set to IDLE, or is not * included at all in the request settings. When included and * set to START, the HAL must trigger the autoexposure * precapture metering sequence.

*

The effect of AE precapture trigger depends on the current * AE mode and state; see the camera HAL device v3 header for * details.

* @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START */ public static final Key CONTROL_AE_PRECAPTURE_TRIGGER = new Key("android.control.aePrecaptureTrigger", 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 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 CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE * @see CaptureRequest#SCALER_CROP_REGION */ public static final Key CONTROL_AF_REGIONS = new Key("android.control.afRegions", int[].class); /** *

Whether the HAL must trigger autofocus.

*

This entry is normally set to IDLE, or is not * included at all in the request settings.

*

When included and set to START, the HAL must trigger the * autofocus algorithm. The effect of AF trigger depends on the * current AF mode and state; see the camera HAL device v3 * header for details. When set to CANCEL, the HAL must cancel * any active trigger, and return to initial AF state.

* @see #CONTROL_AF_TRIGGER_IDLE * @see #CONTROL_AF_TRIGGER_START * @see #CONTROL_AF_TRIGGER_CANCEL */ public static final Key CONTROL_AF_TRIGGER = new Key("android.control.afTrigger", int.class); /** *

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 Key CONTROL_AWB_LOCK = new Key("android.control.awbLock", boolean.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_TRANSFORM * @see CaptureRequest#COLOR_CORRECTION_MODE * @see CaptureRequest#CONTROL_MODE * @see CaptureRequest#COLOR_CORRECTION_GAINS * @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 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 CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE * @see CaptureRequest#SCALER_CROP_REGION */ public static final Key CONTROL_AWB_REGIONS = new Key("android.control.awbRegions", int[].class); /** *

Information to 3A routines about the purpose * of this capture, to help decide optimal 3A * strategy

*

Only used if {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.

* * @see CaptureRequest#CONTROL_MODE * @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 */ public static final Key CONTROL_CAPTURE_INTENT = new Key("android.control.captureIntent", int.class); /** *

Whether any special color effect is in use. * Only used 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 Key CONTROL_EFFECT_MODE = new Key("android.control.effectMode", int.class); /** *

Overall mode of 3A control * routines

*

High-level 3A control. When set to OFF, all 3A control * by the HAL 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 HAL implements * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) * as it wishes. The HAL 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); /** *

Which scene mode is active when * {@link CaptureRequest#CONTROL_MODE android.control.mode} = SCENE_MODE

* * @see CaptureRequest#CONTROL_MODE * @see #CONTROL_SCENE_MODE_UNSUPPORTED * @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 Key CONTROL_SCENE_MODE = new Key("android.control.sceneMode", int.class); /** *

Whether 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 */ public static final Key CONTROL_VIDEO_STABILIZATION_MODE = new Key("android.control.videoStabilizationMode", boolean.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 HAL-determined enhancement * will be applied. HIGH_QUALITY mode indicates that the * HAL should use the highest-quality enhancement algorithms, * even if it slows down capture rate. FAST means the HAL should * 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); /** *

Select flash operation mode

* @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); /** *

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 must not contain thumbnail, * but the captured JPEG must 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 CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES * @see CaptureRequest#SENSOR_EXPOSURE_TIME * @see CaptureRequest#SENSOR_SENSITIVITY * @see CaptureRequest#CONTROL_AE_MODE */ public static final Key LENS_APERTURE = new Key("android.lens.aperture", float.class); /** *

State of lens neutral density * filter(s)

*

Will not be supported on most devices. Can only * pick from supported list

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

Lens optical zoom setting

*

Will not be supported on most devices.

*/ 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

*

0 = infinity focus. Used value should be clamped * to (0,minimum focus distance)

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

Whether optical image stabilization is * enabled.

*

Will not 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); /** *

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 HAL-determined noise filtering * will be applied. HIGH_QUALITY mode indicates that the HAL * should use the highest-quality noise filtering algorithms, * even if it slows down capture rate. FAST means the HAL 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); /** *

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); /** *

(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

*

Exposure time has priority, so duration is set to * max(duration, exposure time + overhead)

*/ 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); /** *

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); /** *

Whether the HAL needs to 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 Key STATISTICS_LENS_SHADING_MAP_MODE = new Key("android.statistics.lensShadingMapMode", int.class); /** *

Table mapping blue input values to output * values

*

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_MODE * @see CaptureRequest#TONEMAP_CURVE_RED */ public static final Key TONEMAP_CURVE_BLUE = new Key("android.tonemap.curveBlue", float[].class); /** *

Table mapping green input values to output * values

*

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_MODE * @see CaptureRequest#TONEMAP_CURVE_RED */ public static final Key TONEMAP_CURVE_GREEN = new Key("android.tonemap.curveGreen", float[].class); /** *

Table mapping red input values to output * values

*

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

*

Since the input and output ranges may vary depending on * the camera pipeline, the input and output pixel values * are represented by normalized floating-point values * between 0 and 1, with 0 == black and 1 == white.

*

The curve should be linearly interpolated between the * defined points. The points will be listed in increasing * order of P_IN. For example, if the array is: [0.0, 0.0, * 0.3, 0.5, 1.0, 1.0], then the input->output mapping * for a few sample points would be: 0 -> 0, 0.15 -> * 0.25, 0.3 -> 0.5, 0.5 -> 0.64

* * @see CaptureRequest#TONEMAP_MODE */ public static final Key TONEMAP_CURVE_RED = new Key("android.tonemap.curveRed", float[].class); /** * * @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.

*

When set to ON, the values used for black-level * compensation will not change until the lock is set to * OFF.

*

Since changes to certain capture parameters (such as * exposure time) may require resetting of black level * compensation, the camera device must report whether setting * the black level lock was successful in the output result * metadata.

*

For example, if a sequence of requests is as follows:

*
    *
  • Request 1: Exposure = 10ms, Black level lock = OFF
    • *
  • Request 2: Exposure = 10ms, Black level lock = ON
    • *
  • Request 3: Exposure = 10ms, Black level lock = ON
    • *
  • Request 4: Exposure = 20ms, Black level lock = ON
    • *
  • Request 5: Exposure = 20ms, Black level lock = ON
    • *
  • Request 6: Exposure = 20ms, Black level lock = ON
    • *
*

And the exposure change in Request 4 requires the camera * device to reset the black level offsets, then the output * result metadata is expected to be:

*
    *
  • Result 1: Exposure = 10ms, Black level lock = OFF
    • *
  • Result 2: Exposure = 10ms, Black level lock = ON
    • *
  • Result 3: Exposure = 10ms, Black level lock = ON
    • *
  • Result 4: Exposure = 20ms, Black level lock = OFF
    • *
  • Result 5: Exposure = 20ms, Black level lock = ON
    • *
  • Result 6: Exposure = 20ms, Black level lock = ON
    • *
*

This indicates to the application that on frame 4, black * levels were reset due to exposure value changes, and pixel * values may not be consistent across captures.

*

The camera device will maintain the lock to the extent * possible, only overriding the lock to OFF when changes to * other request parameters require a black level recalculation * or reset.

*/ public static final Key BLACK_LEVEL_LOCK = new Key("android.blackLevel.lock", boolean.class); /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ * End generated code *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ }