CaptureRequest.java revision ee2ebdedccaa708cfe810c50cc047990cc2054c5
1b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/* 2b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Copyright (C) 2013 The Android Open Source Project 3b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 4b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Licensed under the Apache License, Version 2.0 (the "License"); 5b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * you may not use this file except in compliance with the License. 6b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * You may obtain a copy of the License at 7b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 8b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * http://www.apache.org/licenses/LICENSE-2.0 9b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 10b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Unless required by applicable law or agreed to in writing, software 11b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * distributed under the License is distributed on an "AS IS" BASIS, 12b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * See the License for the specific language governing permissions and 14b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * limitations under the License. 15b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 16b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 172f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvalapackage android.hardware.camera2; 18b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 198b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvalaimport android.annotation.NonNull; 208b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvalaimport android.annotation.Nullable; 2170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvalaimport android.hardware.camera2.impl.CameraMetadataNative; 226c76f58f31635c19c14ae161f96dad2082537860Igor Murashkinimport android.hardware.camera2.impl.PublicKey; 236c76f58f31635c19c14ae161f96dad2082537860Igor Murashkinimport android.hardware.camera2.impl.SyntheticKey; 245776aafc7e70c0b79c4bee2bc50f44121b37c962Ruben Brunkimport android.hardware.camera2.utils.HashCodeHelpers; 25d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinimport android.hardware.camera2.utils.TypeReference; 2670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport android.os.Parcel; 2770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport android.os.Parcelable; 28b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvalaimport android.view.Surface; 29b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 30feb50af361e4305a25758966b6b5df2738c00259Ruben Brunkimport java.util.Collection; 31feb50af361e4305a25758966b6b5df2738c00259Ruben Brunkimport java.util.Collections; 3270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport java.util.HashSet; 33d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinimport java.util.List; 346bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkinimport java.util.Objects; 35b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 36b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 37b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/** 3870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>An immutable package of settings and outputs needed to capture a single 3970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * image from the camera device.</p> 40b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 41b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>Contains the configuration for the capture hardware (sensor, lens, flash), 4270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * the processing pipeline, the control algorithms, and the output buffers. Also 4370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * contains the list of target Surfaces to send image data to for this 4470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * capture.</p> 45b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 4670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>CaptureRequests can be created by using a {@link Builder} instance, 4770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * obtained by calling {@link CameraDevice#createCaptureRequest}</p> 48b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 49b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>CaptureRequests are given to {@link CameraCaptureSession#capture} or 50b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CameraCaptureSession#setRepeatingRequest} to capture images from a camera.</p> 51b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 52b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>Each request can specify a different subset of target Surfaces for the 53b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * camera to send the captured data to. All the surfaces used in a request must 54b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * be part of the surface list given to the last call to 55b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CameraDevice#createCaptureSession}, when the request is submitted to the 56b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * session.</p> 57b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 58b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>For example, a request meant for repeating preview might only include the 59b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Surface for the preview SurfaceView or SurfaceTexture, while a 60b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * high-resolution still capture would also include a Surface from a ImageReader 61b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * configured for high-resolution JPEG images.</p> 62b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 630aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * <p>A reprocess capture request allows a previously-captured image from the camera device to be 640aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * sent back to the device for further processing. It can be created with 65bd7f34f151c4dafec90d92b9375708904a6b0732Eino-Ville Talvala * {@link CameraDevice#createReprocessCaptureRequest}, and used with a reprocessable capture session 660aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * created with {@link CameraDevice#createReprocessableCaptureSession}.</p> 670aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * 680aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * @see CameraCaptureSession#capture 690aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * @see CameraCaptureSession#setRepeatingRequest 700aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * @see CameraCaptureSession#captureBurst 710aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * @see CameraCaptureSession#setRepeatingBurst 7270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see CameraDevice#createCaptureRequest 730aa2bdeaa0c5c6f7691b73932241073fb984af15Eino-Ville Talvala * @see CameraDevice#createReprocessCaptureRequest 74b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 75d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinpublic final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>> 76d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin implements Parcelable { 77d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 78d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 79d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * A {@code Key} is used to do capture request field lookups with 80d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CaptureResult#get} or to set fields with 81d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CaptureRequest.Builder#set(Key, Object)}. 82d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 83d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>For example, to set the crop rectangle for the next capture: 84d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <code><pre> 85d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Rect cropRectangle = new Rect(0, 0, 640, 480); 86d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * captureRequestBuilder.set(SCALER_CROP_REGION, cropRectangle); 87d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * </pre></code> 88d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * </p> 89d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 90d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>To enumerate over all possible keys for {@link CaptureResult}, see 91d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p> 92d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 93d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @see CaptureResult#get 94d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @see CameraCharacteristics#getAvailableCaptureResultKeys 95d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 96d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final static class Key<T> { 97d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin private final CameraMetadataNative.Key<T> mKey; 98d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 99d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 100d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for testing and vendor extensions only. 101d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 102d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 103d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 104d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public Key(String name, Class<T> type) { 105d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = new CameraMetadataNative.Key<T>(name, type); 106d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 107d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 108d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 109d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for testing and vendor extensions only. 110d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 111d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 112d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 113d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public Key(String name, TypeReference<T> typeReference) { 114d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = new CameraMetadataNative.Key<T>(name, typeReference); 115d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 116d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 117d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 118d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Return a camelCase, period separated name formatted like: 119d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@code "root.section[.subsections].name"}. 120d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 121d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."}; 122d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * keys that are device/platform-specific are prefixed with {@code "com."}.</p> 123d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 124d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would 125d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device 126d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * specific key might look like {@code "com.google.nexus.data.private"}.</p> 127d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 128d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @return String representation of the key name 129d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 1308b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala @NonNull 131d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public String getName() { 132d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey.getName(); 133d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 134d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 135d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 136d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 137d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 138d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 139d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final int hashCode() { 140d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey.hashCode(); 141d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 142d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 143d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 144d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 145d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 146d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 147d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 148d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final boolean equals(Object o) { 149d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return o instanceof Key && ((Key<T>)o).mKey.equals(mKey); 150d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 151d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 152d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 153d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for CameraMetadataNative implementation only; do not use. 154d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 155d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * TODO: Make this private or remove it altogether. 156d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 157d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 158d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 159d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public CameraMetadataNative.Key<T> getNativeKey() { 160d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey; 161d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 162d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 163d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings({ "unchecked" }) 164d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) { 165d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = (CameraMetadataNative.Key<T>) nativeKey; 166d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 167d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 16870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 16970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private final HashSet<Surface> mSurfaceSet; 17070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private final CameraMetadataNative mSettings; 1715398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen private boolean mIsReprocess; 172a7677722304670dc07feef242156b97e6bb51bcdZhijun He // If this request is part of constrained high speed request list that was created by 173a7677722304670dc07feef242156b97e6bb51bcdZhijun He // {@link CameraDevice#createConstrainedHighSpeedRequestList}. 174a7677722304670dc07feef242156b97e6bb51bcdZhijun He private boolean mIsPartOfCHSRequestList = false; 1758062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen // Each reprocess request must be tied to a reprocessable session ID. 1767a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen // Valid only for reprocess requests (mIsReprocess == true). 1778062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen private int mReprocessableSessionId; 17870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 1794068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala private Object mUserTag; 180b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 181b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala /** 1826bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Construct empty request. 1836bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 1846bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Used by Binder to unparcel this object only. 18570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin */ 1866bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin private CaptureRequest() { 18770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings = new CameraMetadataNative(); 18870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet = new HashSet<Surface>(); 1895398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen mIsReprocess = false; 1908062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen mReprocessableSessionId = CameraCaptureSession.SESSION_ID_NONE; 191b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala } 192b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 193b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala /** 1946bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Clone from source capture request. 1956bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 1966bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Used by the Builder to create an immutable copy. 197b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 1986bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin @SuppressWarnings("unchecked") 19970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private CaptureRequest(CaptureRequest source) { 20070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings = new CameraMetadataNative(source.mSettings); 20170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet = (HashSet<Surface>) source.mSurfaceSet.clone(); 2025398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen mIsReprocess = source.mIsReprocess; 203a7677722304670dc07feef242156b97e6bb51bcdZhijun He mIsPartOfCHSRequestList = source.mIsPartOfCHSRequestList; 2048062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen mReprocessableSessionId = source.mReprocessableSessionId; 2057b01c5c4d27ebbd739d9e5e0de7eaafbffd8e084Eino-Ville Talvala mUserTag = source.mUserTag; 206b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala } 207b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 208b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala /** 2096bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Take ownership of passed-in settings. 2106bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 2116bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Used by the Builder to create a mutable CaptureRequest. 2127a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * 2137a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @param settings Settings for this capture request. 2147a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @param isReprocess Indicates whether to create a reprocess capture request. {@code true} 2157a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * to create a reprocess capture request. {@code false} to create a regular 2167a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * capture request. 2178062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen * @param reprocessableSessionId The ID of the camera capture session this capture is created 2187a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * for. This is used to validate if the application submits a 2197a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * reprocess capture request to the same session where 2207a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * the {@link TotalCaptureResult}, used to create the reprocess 2217a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * capture, came from. 2227a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * 2237a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @throws IllegalArgumentException If creating a reprocess capture request with an invalid 2248062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen * reprocessableSessionId. 2257a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * 2267a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @see CameraDevice#createReprocessCaptureRequest 227b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 2287a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen private CaptureRequest(CameraMetadataNative settings, boolean isReprocess, 2298062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen int reprocessableSessionId) { 230d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mSettings = CameraMetadataNative.move(settings); 23170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet = new HashSet<Surface>(); 2325398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen mIsReprocess = isReprocess; 2337a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen if (isReprocess) { 2348062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen if (reprocessableSessionId == CameraCaptureSession.SESSION_ID_NONE) { 2357a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen throw new IllegalArgumentException("Create a reprocess capture request with an " + 2368062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen "invalid session ID: " + reprocessableSessionId); 2377a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen } 2388062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen mReprocessableSessionId = reprocessableSessionId; 2397a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen } else { 2408062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen mReprocessableSessionId = CameraCaptureSession.SESSION_ID_NONE; 2417a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen } 24270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 24370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 244d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 245d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Get a capture request field value. 246d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 247d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>The field definitions can be found in {@link CaptureRequest}.</p> 248d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 249d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>Querying the value for the same key more than once will return a value 250d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * which is equal to the previous queried value.</p> 251d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 252d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @throws IllegalArgumentException if the key was not valid 253d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 254d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @param key The result field to read. 255d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @return The value of that key, or {@code null} if the field is not set. 256d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 2578b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala @Nullable 25870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public <T> T get(Key<T> key) { 25970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mSettings.get(key); 2604068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala } 2614068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala 2624068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala /** 263d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 264d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 265d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 266d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 267d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 268d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin protected <T> T getProtected(Key<?> key) { 269d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return (T) mSettings.get(key); 270d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 271d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 272d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 273d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 274d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 275d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 276d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 277d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 278d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin protected Class<Key<?>> getKeyClass() { 279d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin Object thisClass = Key.class; 280d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return (Class<Key<?>>)thisClass; 281d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 282d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 283d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 284d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 285d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 286d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 2878b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala @NonNull 288d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public List<Key<?>> getKeys() { 289d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin // Force the javadoc for this function to show up on the CaptureRequest page 290d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return super.getKeys(); 291d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 292d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 293d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 2944068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * Retrieve the tag for this request, if any. 2954068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * 2964068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * <p>This tag is not used for anything by the camera device, but can be 2974068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * used by an application to easily identify a CaptureRequest when it is 2984068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * returned by 299fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted} 3004068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * </p> 3014068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * 3024068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * @return the last tag Object set on this request, or {@code null} if 3034068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * no tag has been set. 30470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see Builder#setTag 3054068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala */ 3068b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala @Nullable 3074068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala public Object getTag() { 30870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mUserTag; 3094068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala } 3104068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala 3116bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin /** 3125398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * Determine if this is a reprocess capture request. 3135398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * 3145398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * <p>A reprocess capture request produces output images from an input buffer from the 3155398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * {@link CameraCaptureSession}'s input {@link Surface}. A reprocess capture request can be 3165398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * created by {@link CameraDevice#createReprocessCaptureRequest}.</p> 3175398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * 3185398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * @return {@code true} if this is a reprocess capture request. {@code false} if this is not a 3195398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * reprocess capture request. 3205398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * 3215398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * @see CameraDevice#createReprocessCaptureRequest 3225398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen */ 3235398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen public boolean isReprocess() { 3245398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen return mIsReprocess; 3255398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen } 3265398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen 3275398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen /** 328a7677722304670dc07feef242156b97e6bb51bcdZhijun He * <p>Determine if this request is part of a constrained high speed request list that was 329a7677722304670dc07feef242156b97e6bb51bcdZhijun He * created by {@link CameraDevice#createConstrainedHighSpeedRequestList}. A constrained high 330a7677722304670dc07feef242156b97e6bb51bcdZhijun He * speed request list contains some constrained high speed capture requests with certain 331a7677722304670dc07feef242156b97e6bb51bcdZhijun He * interleaved pattern that is suitable for high speed preview/video streaming. An active 332a7677722304670dc07feef242156b97e6bb51bcdZhijun He * constrained high speed capture session only accepts constrained high speed request lists. 333a7677722304670dc07feef242156b97e6bb51bcdZhijun He * This method can be used to do the sanity check when a constrained high speed capture session 334a7677722304670dc07feef242156b97e6bb51bcdZhijun He * receives a request list via {@link CameraCaptureSession#setRepeatingBurst} or 335a7677722304670dc07feef242156b97e6bb51bcdZhijun He * {@link CameraCaptureSession#captureBurst}. 336a7677722304670dc07feef242156b97e6bb51bcdZhijun He * </p> 337a7677722304670dc07feef242156b97e6bb51bcdZhijun He * 338a7677722304670dc07feef242156b97e6bb51bcdZhijun He * 339a7677722304670dc07feef242156b97e6bb51bcdZhijun He * @return {@code true} if this request is part of a constrained high speed request list, 340a7677722304670dc07feef242156b97e6bb51bcdZhijun He * {@code false} otherwise. 341a7677722304670dc07feef242156b97e6bb51bcdZhijun He * 342a7677722304670dc07feef242156b97e6bb51bcdZhijun He * @hide 343a7677722304670dc07feef242156b97e6bb51bcdZhijun He */ 344a7677722304670dc07feef242156b97e6bb51bcdZhijun He public boolean isPartOfCRequestList() { 345a7677722304670dc07feef242156b97e6bb51bcdZhijun He return mIsPartOfCHSRequestList; 346a7677722304670dc07feef242156b97e6bb51bcdZhijun He } 347a7677722304670dc07feef242156b97e6bb51bcdZhijun He 348a7677722304670dc07feef242156b97e6bb51bcdZhijun He /** 349a7677722304670dc07feef242156b97e6bb51bcdZhijun He * Returns a copy of the underlying {@link CameraMetadataNative}. 350a7677722304670dc07feef242156b97e6bb51bcdZhijun He * @hide 351a7677722304670dc07feef242156b97e6bb51bcdZhijun He */ 352a7677722304670dc07feef242156b97e6bb51bcdZhijun He public CameraMetadataNative getNativeCopy() { 353a7677722304670dc07feef242156b97e6bb51bcdZhijun He return new CameraMetadataNative(mSettings); 354a7677722304670dc07feef242156b97e6bb51bcdZhijun He } 355a7677722304670dc07feef242156b97e6bb51bcdZhijun He 356a7677722304670dc07feef242156b97e6bb51bcdZhijun He /** 3578062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen * Get the reprocessable session ID this reprocess capture request is associated with. 3587a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * 3598062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen * @return the reprocessable session ID this reprocess capture request is associated with 3607a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * 3617a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @throws IllegalStateException if this capture request is not a reprocess capture request. 3627a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @hide 3637a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen */ 3648062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen public int getReprocessableSessionId() { 3657a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen if (mIsReprocess == false || 3668062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen mReprocessableSessionId == CameraCaptureSession.SESSION_ID_NONE) { 3678062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen throw new IllegalStateException("Getting the reprocessable session ID for a "+ 3687a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen "non-reprocess capture request is illegal."); 3697a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen } 3708062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen return mReprocessableSessionId; 3717a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen } 3727a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen 3737a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen /** 3746bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Determine whether this CaptureRequest is equal to another CaptureRequest. 3756bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 3766bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * <p>A request is considered equal to another is if it's set of key/values is equal, it's 3775398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * list of output surfaces is equal, the user tag is equal, and the return values of 3785398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen * isReprocess() are equal.</p> 3796bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 3806bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * @param other Another instance of CaptureRequest. 3816bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 3826bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * @return True if the requests are the same, false otherwise. 3836bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin */ 3846bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin @Override 3856bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin public boolean equals(Object other) { 3866bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin return other instanceof CaptureRequest 3876bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin && equals((CaptureRequest)other); 3886bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 3896bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 3906bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin private boolean equals(CaptureRequest other) { 3916bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin return other != null 3926bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin && Objects.equals(mUserTag, other.mUserTag) 3936bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin && mSurfaceSet.equals(other.mSurfaceSet) 3945398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen && mSettings.equals(other.mSettings) 3957a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen && mIsReprocess == other.mIsReprocess 3968062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen && mReprocessableSessionId == other.mReprocessableSessionId; 3976bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 3986bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 3996bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin @Override 4006bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin public int hashCode() { 4015776aafc7e70c0b79c4bee2bc50f44121b37c962Ruben Brunk return HashCodeHelpers.hashCode(mSettings, mSurfaceSet, mUserTag); 4026bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 4036bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 40470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public static final Parcelable.Creator<CaptureRequest> CREATOR = 40570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin new Parcelable.Creator<CaptureRequest>() { 40670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin @Override 40770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public CaptureRequest createFromParcel(Parcel in) { 40870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin CaptureRequest request = new CaptureRequest(); 40970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin request.readFromParcel(in); 41070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 41170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin return request; 41270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 41370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 41470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin @Override 41570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public CaptureRequest[] newArray(int size) { 41670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin return new CaptureRequest[size]; 41770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 41870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin }; 41970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 42070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin /** 42170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin * Expand this object from a Parcel. 42270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Hidden since this breaks the immutability of CaptureRequest, but is 42370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * needed to receive CaptureRequests with aidl. 42470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 42570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin * @param in The parcel from which the object should be read 42670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @hide 42770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin */ 42872f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin private void readFromParcel(Parcel in) { 42970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings.readFromParcel(in); 43070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 43170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet.clear(); 43270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 43370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala Parcelable[] parcelableArray = in.readParcelableArray(Surface.class.getClassLoader()); 43470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 43570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala if (parcelableArray == null) { 43670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return; 43770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 43870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 43970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala for (Parcelable p : parcelableArray) { 44070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala Surface s = (Surface) p; 44170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet.add(s); 44270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 4435398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen 4445398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen mIsReprocess = (in.readInt() == 0) ? false : true; 4458062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen mReprocessableSessionId = CameraCaptureSession.SESSION_ID_NONE; 44670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 44770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 44870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin @Override 44970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public int describeContents() { 45070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return 0; 45170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 45270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 45370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala @Override 45470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public void writeToParcel(Parcel dest, int flags) { 45570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings.writeToParcel(dest, flags); 45670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala dest.writeParcelableArray(mSurfaceSet.toArray(new Surface[mSurfaceSet.size()]), flags); 4575398a676809faaf3c6c2875edc1907ad6b8e1c89Chien-Yu Chen dest.writeInt(mIsReprocess ? 1 : 0); 45870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 45970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 46070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 461feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk * @hide 462feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk */ 463feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk public boolean containsTarget(Surface surface) { 464feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk return mSurfaceSet.contains(surface); 465feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk } 466feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk 467feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk /** 468feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk * @hide 469feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk */ 470feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk public Collection<Surface> getTargets() { 471feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk return Collections.unmodifiableCollection(mSurfaceSet); 472feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk } 473feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk 474feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk /** 47570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * A builder for capture requests. 47670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 47770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>To obtain a builder instance, use the 47870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * {@link CameraDevice#createCaptureRequest} method, which initializes the 47970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * request fields to one of the templates defined in {@link CameraDevice}. 48070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 48170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see CameraDevice#createCaptureRequest 482b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_PREVIEW 483b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_RECORD 484b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_STILL_CAPTURE 485b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_VIDEO_SNAPSHOT 486b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_MANUAL 48770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 48870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public final static class Builder { 48970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 4907a36a0fbb0a5f14047a3680668da954beca05dcbIgor Murashkin private final CaptureRequest mRequest; 49170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 49270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 49370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Initialize the builder using the template; the request takes 49470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * ownership of the template. 49570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 4967a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @param template Template settings for this capture request. 4977a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @param reprocess Indicates whether to create a reprocess capture request. {@code true} 4987a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * to create a reprocess capture request. {@code false} to create a regular 4997a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * capture request. 5008062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen * @param reprocessableSessionId The ID of the camera capture session this capture is 5017a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * created for. This is used to validate if the application 5027a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * submits a reprocess capture request to the same session 5037a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * where the {@link TotalCaptureResult}, used to create the 5047a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * reprocess capture, came from. 5057a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * 5067a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen * @throws IllegalArgumentException If creating a reprocess capture request with an invalid 5078062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen * reprocessableSessionId. 50870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @hide 50970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 5107a316f6b1b040f0113161db87a36397aebfb80b8Chien-Yu Chen public Builder(CameraMetadataNative template, boolean reprocess, 5118062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen int reprocessableSessionId) { 5128062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen mRequest = new CaptureRequest(template, reprocess, reprocessableSessionId); 51370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 51470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 51570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 51670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Add a surface to the list of targets for this request</p> 51770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 51870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>The Surface added must be one of the surfaces included in the most 519b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * recent call to {@link CameraDevice#createCaptureSession}, when the 52070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * request is given to the camera device.</p> 52170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 52270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Adding a target more than once has no effect.</p> 52370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 52470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param outputTarget Surface to use as an output target for this request 52570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 5268b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala public void addTarget(@NonNull Surface outputTarget) { 52770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mSurfaceSet.add(outputTarget); 52870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 52970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 53070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 53170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Remove a surface from the list of targets for this request.</p> 53270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 53370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Removing a target that is not currently added has no effect.</p> 53470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 53570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param outputTarget Surface to use as an output target for this request 53670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 5378b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala public void removeTarget(@NonNull Surface outputTarget) { 53870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mSurfaceSet.remove(outputTarget); 53970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 54070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 54170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 54270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Set a capture request field to a value. The field definitions can be 54370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * found in {@link CaptureRequest}. 54470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 54570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param key The metadata field to write. 54670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param value The value to set the field to, which must be of a matching 54770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * type to the key. 54870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 5498b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala public <T> void set(@NonNull Key<T> key, T value) { 55070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mSettings.set(key, value); 55170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 55270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 55370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 55470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Get a capture request field value. The field definitions can be 55570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * found in {@link CaptureRequest}. 55670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 55770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @throws IllegalArgumentException if the key was not valid 55870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 55970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param key The metadata field to read. 56070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @return The value of that key, or {@code null} if the field is not set. 56170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 5628b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala @Nullable 56370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public <T> T get(Key<T> key) { 56470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mRequest.mSettings.get(key); 56570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 56670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 56770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 56870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Set a tag for this request. 56970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 57070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>This tag is not used for anything by the camera device, but can be 57170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * used by an application to easily identify a CaptureRequest when it is 57270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * returned by 573fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted} 57470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 57570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param tag an arbitrary Object to store with this request 57670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see CaptureRequest#getTag 57770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 5788b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala public void setTag(@Nullable Object tag) { 57970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mUserTag = tag; 58070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 58170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 58270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 583a7677722304670dc07feef242156b97e6bb51bcdZhijun He * <p>Mark this request as part of a constrained high speed request list created by 584a7677722304670dc07feef242156b97e6bb51bcdZhijun He * {@link CameraDevice#createConstrainedHighSpeedRequestList}. A constrained high speed 585a7677722304670dc07feef242156b97e6bb51bcdZhijun He * request list contains some constrained high speed capture requests with certain 586a7677722304670dc07feef242156b97e6bb51bcdZhijun He * interleaved pattern that is suitable for high speed preview/video streaming.</p> 587a7677722304670dc07feef242156b97e6bb51bcdZhijun He * 588a7677722304670dc07feef242156b97e6bb51bcdZhijun He * @hide 589a7677722304670dc07feef242156b97e6bb51bcdZhijun He */ 590a7677722304670dc07feef242156b97e6bb51bcdZhijun He public void setPartOfCHSRequestList(boolean partOfCHSList) { 591a7677722304670dc07feef242156b97e6bb51bcdZhijun He mRequest.mIsPartOfCHSRequestList = partOfCHSList; 592a7677722304670dc07feef242156b97e6bb51bcdZhijun He } 593a7677722304670dc07feef242156b97e6bb51bcdZhijun He 594a7677722304670dc07feef242156b97e6bb51bcdZhijun He /** 59570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Build a request using the current target Surfaces and settings. 596edeab40338a047655f6af60e9e950dbad262279bSol Boucher * <p>Note that, although it is possible to create a {@code CaptureRequest} with no target 597edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link Surface}s, passing such a request into {@link CameraCaptureSession#capture}, 598edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link CameraCaptureSession#captureBurst}, 599edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link CameraCaptureSession#setRepeatingBurst}, or 600edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link CameraCaptureSession#setRepeatingRequest} will cause that method to throw an 601edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link IllegalArgumentException}.</p> 60270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 60370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @return A new capture request instance, ready for submission to the 60470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * camera device. 60570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 6068b905578b54041f7d0b8dc04dd158d16d28262a1Eino-Ville Talvala @NonNull 60770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public CaptureRequest build() { 60870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return new CaptureRequest(mRequest); 60970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 61070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 61170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 61270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @hide 61370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 61470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public boolean isEmpty() { 61570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mRequest.mSettings.isEmpty(); 61670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 61770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 618b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala } 619b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 6205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 6215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * The key entries below this point are generated from metadata 6225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * definitions in /system/media/camera/docs. Do not modify by hand or 6235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * modify the comment blocks at the start or end. 6245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 6255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 6265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 6277d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The mode control selects how the image data is converted from the 6287d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * sensor's native color into linear sRGB color.</p> 629b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>When auto-white balance (AWB) is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this 6307d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * control is overridden by the AWB routine. When AWB is disabled, the 6317d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * application controls how the color mapping is performed.</p> 6327d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>We define the expected processing pipeline below. For consistency 6337d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * across devices, this is always the case with TRANSFORM_MATRIX.</p> 6347d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>When either FULL or HIGH_QUALITY is used, the camera device may 6357d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 6367d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the 6377d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * camera device (in the results) and be roughly correct.</p> 6387d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>Switching to TRANSFORM_MATRIX and using the data provided from 6397d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * FAST or HIGH_QUALITY will yield a picture with the same white point 6407d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * as what was produced by the camera device in the earlier frame.</p> 6417d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The expected processing pipeline is as follows:</p> 6427d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> 6437d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The white balance is encoded by two values, a 4-channel white-balance 6447d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * gain vector (applied in the Bayer domain), and a 3x3 color transform 6457d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * matrix (applied after demosaic).</p> 6467d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The 4-channel white-balance gains are defined as:</p> 6477d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] 6487d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * </code></pre> 6497d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>where <code>G_even</code> is the gain for green pixels on even rows of the 6507d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * output, and <code>G_odd</code> is the gain for green pixels on the odd rows. 6517d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * These may be identical for a given camera device implementation; if 6527d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * the camera device does not support a separate gain for even/odd green 6537d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to 6547d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <code>G_even</code> in the output result metadata.</p> 6557d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The matrices for color transforms are defined as a 9-entry vector:</p> 6567d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] 6577d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * </code></pre> 6587d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, 6597d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> 6607d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>with colors as follows:</p> 6617d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <pre><code>r' = I0r + I1g + I2b 6627d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * g' = I3r + I4g + I5b 6637d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * b' = I6r + I7g + I8b 6647d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * </code></pre> 6657d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>Both the input and output value ranges must match. Overflow/underflow 6667d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * values are clipped to fit within the range.</p> 667fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 668fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 669fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX TRANSFORM_MATRIX}</li> 670fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_MODE_FAST FAST}</li> 671fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 672fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 6734b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 6744b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 6754b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 6764b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 6770da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 6787d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * @see CaptureRequest#COLOR_CORRECTION_GAINS 6797d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 6800da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_AWB_MODE 6814b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 6825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX 6835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #COLOR_CORRECTION_MODE_FAST 6845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY 6855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 6866c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 6875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> COLOR_CORRECTION_MODE = 6885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.colorCorrection.mode", int.class); 6895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 6905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 691ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>A color transform matrix to use to transform 692b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * from sensor RGB color space to output linear sRGB color space.</p> 69349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>This matrix is either set by the camera device when the request 6940da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 6955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * directly by the application in the request when the 6960da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 69749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>In the latter case, the camera device may round the matrix to account 69849a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * for precision issues; the final rounded matrix should be reported back 69949a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * in this matrix result metadata. The transform should keep the magnitude 70049a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * of the output color values within <code>[0, 1.0]</code> (assuming input color 70149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 702d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * <p>The valid range of each matrix element varies on different devices, but 703d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * values within [-1.5, 3.0] are guaranteed not to be clipped.</p> 704fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Unitless scale factors</p> 7054b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 7064b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 7074b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 7084b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 7090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 7100da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_MODE 7114b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 7125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 7136c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 7142bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM = 7152bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class); 7165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 7175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 7187d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>Gains applying to Bayer raw color channels for 719cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * white-balance.</p> 7202bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * <p>These per-channel gains are either set by the camera device 7212bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not 7222bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * TRANSFORM_MATRIX, or directly by the application in the 7232bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is 7242bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * TRANSFORM_MATRIX.</p> 7252bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * <p>The gains in the result metadata are the gains actually 7262bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * applied by the camera device to the current frame.</p> 727d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * <p>The valid range of gains varies on different devices, but gains 728d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * between [1.0, 3.0] are guaranteed not to be clipped. Even if a given 729d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * device allows gains below 1.0, this is usually not recommended because 730d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * this can create color artifacts.</p> 731fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Unitless gain factors</p> 7324b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 7334b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 7344b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 7354b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 7360da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 7370da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_MODE 7384b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 7395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 7406c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 7412bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS = 7422bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class); 7435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 7445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 745a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>Mode of operation for the chromatic aberration correction algorithm.</p> 746a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light 747a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * can not focus on the same point after exiting from the lens. This metadata defines 748a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * the high level control of chromatic aberration correction algorithm, which aims to 749a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * minimize the chromatic artifacts that may occur along the object boundaries in an 750a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * image.</p> 751a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>FAST/HIGH_QUALITY both mean that camera device determined aberration 752a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * correction will be applied. HIGH_QUALITY mode indicates that the camera device will 753a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * use the highest-quality aberration correction algorithms, even if it slows down 754a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * capture rate. FAST means the camera device will not slow down capture rate when 755a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * applying aberration correction.</p> 7564b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>LEGACY devices will always be in FAST mode.</p> 757fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 758fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 759fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_OFF OFF}</li> 760fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_FAST FAST}</li> 761fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 762fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 763fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 764fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</p> 7654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 766a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * 7679e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES 7689e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_OFF 7699e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_FAST 7709e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY 771a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He */ 7726c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 7739e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE = 7749e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He new Key<Integer>("android.colorCorrection.aberrationMode", int.class); 775a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He 776a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He /** 7770da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The desired setting for the camera device's auto-exposure 7780da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * algorithm's antibanding compensation.</p> 7790da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>Some kinds of lighting fixtures, such as some fluorescent 7800da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * lights, flicker at the rate of the power supply frequency 7810da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * (60Hz or 50Hz, depending on country). While this is 7820da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * typically not noticeable to a person, it can be visible to 7830da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * a camera device. If a camera sets its exposure time to the 7840da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * wrong value, the flicker may become visible in the 7850da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * viewfinder as flicker or in a final captured image, as a 7860da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * set of variable-brightness bands across the image.</p> 7870da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>Therefore, the auto-exposure routines of camera devices 7880da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * include antibanding routines that ensure that the chosen 7890da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * exposure value will not cause such banding. The choice of 7900da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * exposure time depends on the rate of flicker, which the 7910da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * camera device can detect automatically, or the expected 7920da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * rate can be selected by the application using this 7930da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * control.</p> 7940da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>A given camera device may not support all of the possible 7950da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * options for the antibanding mode. The 7960da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains 7970da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * the available modes for a given camera device.</p> 7987b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * <p>AUTO mode is the default if it is available on given 7997b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * camera device. When AUTO mode is not available, the 8007b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * default will be either 50HZ or 60HZ, and both 50HZ 8017b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * and 60HZ will be available.</p> 8020da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>If manual exposure control is enabled (by setting 8030da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), 8040da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * then this setting has no effect, and the application must 8050da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ensure it selects exposure times that do not cause banding 8060da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist 8070da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * the application in this.</p> 808fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 809fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 810fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_OFF OFF}</li> 811fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_50HZ 50HZ}</li> 812fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_60HZ 60HZ}</li> 813fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_AUTO AUTO}</li> 814fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 815fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br></p> 816fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>{@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes}</p> 8174b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 8180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 8195f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES 820399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 821265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 822265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureResult#STATISTICS_SCENE_FLICKER 8235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_OFF 8245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ 8255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ 8265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO 8275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 8286c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 8295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE = 8305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aeAntibandingMode", int.class); 8315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 8325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 833b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Adjustment to auto-exposure (AE) target image 834b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * brightness.</p> 835b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The adjustment is measured as a count of steps, with the 836b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * step size defined by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} and the 837b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * allowed range by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}.</p> 838b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>For example, if the exposure value (EV) step is 0.333, '6' 839b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * will mean an exposure compensation of +2 EV; -3 will mean an 840b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * exposure compensation of -1 EV. One EV represents a doubling 841b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * of image brightness. Note that this control will only be 842b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control 843b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * will take effect even when {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> 844a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * <p>In the event of exposure compensation value being changed, camera device 845a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * may take several frames to reach the newly requested exposure target. 846a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING 847a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will 848a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or 849a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * FLASH_REQUIRED (if the scene is too dark for still capture).</p> 850fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Compensation steps</p> 851fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 852fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}</p> 8534b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 854a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * 855b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE 856b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP 857a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_LOCK 858a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_MODE 859a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureResult#CONTROL_AE_STATE 8605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 8616c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 8625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION = 8635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aeExposureCompensation", int.class); 8645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 8655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 866b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-exposure (AE) is currently locked to its latest 86749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * calculated values.</p> 868fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters, 869fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and will not change exposure settings until the lock is set to <code>false</code> (OFF).</p> 870fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Note that even when AE is locked, the flash may be fired if 871fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / 872fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.</p> 873a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock 874a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * is ON, the camera device will still adjust its exposure value.</p> 87549a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) 87649a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * when AE is already locked, the camera device will not change the exposure time 87749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) 878d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 87949a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the 880fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed. 881fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * Similarly, AE precapture trigger CANCEL has no effect when AE is already locked.</p> 882fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * <p>When an AE precapture sequence is triggered, AE unlock will not be able to unlock 883fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * the AE if AE is locked by the camera device internally during precapture metering 884fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * sequence In other words, submitting requests with AE unlock has no effect for an 885fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * ongoing precapture metering sequence. Otherwise, the precapture metering sequence 886fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * will never succeed in a sequence of preview requests where AE lock is always set 887fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * to <code>false</code>.</p> 888fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Since the camera device has a pipeline of in-flight requests, the settings that 889fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * get locked do not necessarily correspond to the settings that were present in the 890fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * latest capture result received from the camera device, since additional captures 891fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and AE updates may have occurred even before the result was sent out. If an 892fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * application is switching between automatic and manual control and wishes to eliminate 893fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * any flicker during the switch, the following procedure is recommended:</p> 894fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ol> 895fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Starting in auto-AE mode:</li> 896fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Lock AE</li> 897fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Wait for the first result to be output that has the AE locked</li> 898fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Copy exposure settings from that result into a request, set the request to manual AE</li> 899fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Submit the capture request, proceed to run manual AE as desired.</li> 900fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ol> 90149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> 9024b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 90349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * 904a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION 90549a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 90649a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 90749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureResult#CONTROL_AE_STATE 90849a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#SENSOR_EXPOSURE_TIME 90949a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#SENSOR_SENSITIVITY 9105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 9116c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 9125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> CONTROL_AE_LOCK = 9135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.control.aeLock", boolean.class); 9145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 9155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 9160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The desired mode for the camera device's 9170da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * auto-exposure routine.</p> 9180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 9190da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * AUTO.</p> 9200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>When set to any of the ON modes, the camera device's 9210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * auto-exposure routine is enabled, overriding the 9220da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * application's selected exposure time, sensor sensitivity, 9230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 9240da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 9250da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 9260da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * is selected, the camera device's flash unit controls are 9270da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * also overridden.</p> 9280da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The FLASH modes are only available if the camera device 9290da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 9300da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>If flash TORCH mode is desired, this field must be set to 9310da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 9320da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>When set to any of the ON modes, the values chosen by the 9330da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * camera device auto-exposure routine for the overridden 9340da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * fields for a given capture will be available in its 9350da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * CaptureResult.</p> 936fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 937fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 938fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_OFF OFF}</li> 939fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON ON}</li> 940fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH ON_AUTO_FLASH}</li> 941fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON_ALWAYS_FLASH ON_ALWAYS_FLASH}</li> 942fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE ON_AUTO_FLASH_REDEYE}</li> 943fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 944fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 945fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES android.control.aeAvailableModes}</p> 9464b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 9470da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 948fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES 9495f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#CONTROL_MODE 950265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 951265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#FLASH_MODE 952aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @see CaptureRequest#SENSOR_EXPOSURE_TIME 953aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @see CaptureRequest#SENSOR_FRAME_DURATION 954399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#SENSOR_SENSITIVITY 9555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_OFF 9565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON 9575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 9585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 9595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 9605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 9616c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 9625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_MODE = 9635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aeMode", int.class); 9645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 9655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 966fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>List of metering areas to use for auto-exposure adjustment.</p> 967fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0. 968808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 969fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The maximum number of regions supported by the device is determined by the value 970fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe}.</p> 971ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 9722629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 9730da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 9740da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 97597f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 976fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 97797f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 97897f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 97997f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 98097f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 981fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weights are relative to weights of other exposure metering regions, so if only one 982fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region is used, all non-zero weights will have the same effect. A region with 0 983fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * weight is ignored.</p> 984fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 985fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * camera device.</p> 986fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 987fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture result metadata, the camera device will ignore the sections outside the crop 988fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region and output only the intersection rectangle as the metering region in the result 989fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * metadata. If the region is entirely outside the crop region, it will be ignored and 990fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * not reported in the result metadata.</p> 991fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 992fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 993fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Coordinates must be between <code>[(0,0), (width, height))</code> of 994fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 995808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 9960da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 997808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE 9980da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 999265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 10005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10016c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1002817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS = 1003817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class); 10045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1006fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Range over which the auto-exposure routine can 1007fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * adjust the capture frame rate to maintain good 1008fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * exposure.</p> 1009b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Only constrains auto-exposure (AE) algorithm, not 1010fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} and 1011fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}.</p> 1012fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Frames per second (FPS)</p> 1013fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1014fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Any of the entries in {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges}</p> 1015fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 10160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1017fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES 10180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1019fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#SENSOR_FRAME_DURATION 10205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10216c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 102278712a8bd7275542013ba099f33536eead0167fbIgor Murashkin public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE = 102378712a8bd7275542013ba099f33536eead0167fbIgor Murashkin new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }}); 10245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1026228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Whether the camera device will trigger a precapture 1027228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * metering sequence when it processes this request.</p> 1028ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This entry is normally set to IDLE, or is not 10295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * included at all in the request settings. When included and 1030dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * set to START, the camera device will trigger the auto-exposure (AE) 1031ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * precapture metering sequence.</p> 1032fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * <p>When set to CANCEL, the camera device will cancel any active 1033fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * precapture metering trigger, and return to its initial AE state. 1034fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * If a precapture metering sequence is already completed, and the camera 1035fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * device has implicitly locked the AE for subsequent still capture, the 1036fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * CANCEL trigger will unlock the AE and return to its initial AE state.</p> 1037dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * <p>The precapture sequence should be triggered before starting a 1038e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * high-quality still capture for final metering decisions to 1039e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * be made, and for firing pre-capture flash pulses to estimate 1040e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * scene brightness and required final capture flash power, when 1041e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * the flash is enabled.</p> 1042e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Normally, this entry should be set to START for only a 1043e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * single request, and the application should wait until the 1044e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * sequence completes before starting a new one.</p> 1045dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * <p>When a precapture metering sequence is finished, the camera device 1046dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * may lock the auto-exposure routine internally to be able to accurately expose the 1047dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * subsequent still capture image (<code>{@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} == STILL_CAPTURE</code>). 1048dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * For this case, the AE may not resume normal scan if no subsequent still capture is 1049dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * submitted. To ensure that the AE routine restarts normal scan, the application should 1050dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * submit a request with <code>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == true</code>, followed by a request 1051dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * with <code>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == false</code>, if the application decides not to submit a 1052fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * still capture request after the precapture sequence completes. Alternatively, for 1053fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * API level 23 or newer devices, the CANCEL can be used to unlock the camera device 1054fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * internally locked AE if the application doesn't submit a still capture request after 1055fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * the AE precapture trigger. Note that, the CANCEL was added in API level 23, and must not 1056fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * be used in devices that have earlier API levels.</p> 1057e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>The exact effect of auto-exposure (AE) precapture trigger 1058e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * depends on the current AE mode and state; see 1059b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition 1060b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * details.</p> 1061fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>On LEGACY-level devices, the precapture trigger is not supported; 1062fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capturing a high-resolution JPEG image will automatically trigger a 1063fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * precapture sequence before the high-resolution capture, including 1064fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * potentially firing a pre-capture flash.</p> 1065fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1066fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1067fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE IDLE}</li> 1068fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_START START}</li> 1069fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL CANCEL}</li> 1070fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 10714b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 10724b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 10734b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 10744b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1075228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * 1076dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * @see CaptureRequest#CONTROL_AE_LOCK 1077228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureResult#CONTROL_AE_STATE 1078dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * @see CaptureRequest#CONTROL_CAPTURE_INTENT 10794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 10805a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE 10815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START 1082fa95b0420ce819e5f559cd97f9edb086e9eebb71Zhijun He * @see #CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL 10835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10846c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 10855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER = 10865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aePrecaptureTrigger", int.class); 10875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1089b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-focus (AF) is currently enabled, and what 1090b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * mode it is set to.</p> 1091cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus 10927144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>). Also note that 10937144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, the behavior of AF is device 10947144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * dependent. It is recommended to lock AF by using {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} before 10957144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * setting {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} to OFF, or set AF mode to OFF when AE is OFF.</p> 109678146ecb24871302a4c4dc0a7341044a06d29ee8Zhijun He * <p>If the lens is controlled by the camera device auto-focus algorithm, 1097d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} 1098fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * in result metadata.</p> 1099fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1100fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1101fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_OFF OFF}</li> 1102fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_AUTO AUTO}</li> 1103fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_MACRO MACRO}</li> 1104fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_VIDEO CONTINUOUS_VIDEO}</li> 1105fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_PICTURE CONTINUOUS_PICTURE}</li> 1106fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_EDOF EDOF}</li> 1107fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1108fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1109fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES android.control.afAvailableModes}</p> 1110fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 11110da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 11127144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AE_MODE 1113fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES 1114d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CaptureResult#CONTROL_AF_STATE 11157144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AF_TRIGGER 11160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 1117cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 11185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_OFF 11195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_AUTO 11205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_MACRO 11215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 11225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 11235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_EDOF 11245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11256c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 11265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AF_MODE = 11275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.afMode", int.class); 11285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1130fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>List of metering areas to use for auto-focus.</p> 1131fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0. 1132808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 1133fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The maximum number of focus areas supported by the device is determined by the value 1134fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf}.</p> 1135ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 11362629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 11370da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 11380da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 113997f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 1140fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 114197f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 114297f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 114397f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 114497f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 1145fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weights are relative to weights of other metering regions, so if only one region 1146fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * is used, all non-zero weights will have the same effect. A region with 0 weight is 1147fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ignored.</p> 1148fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1149fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * camera device.</p> 1150fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1151fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture result metadata, the camera device will ignore the sections outside the crop 1152fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region and output only the intersection rectangle as the metering region in the result 1153fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * metadata. If the region is entirely outside the crop region, it will be ignored and 1154fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * not reported in the result metadata.</p> 1155fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1156fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1157fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Coordinates must be between <code>[(0,0), (width, height))</code> of 1158fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1159808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 11600da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1161808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF 11620da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 1163265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 11645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11656c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1166817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS = 1167817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class); 11685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1170228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Whether the camera device will trigger autofocus for this request.</p> 1171ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This entry is normally set to IDLE, or is not 1172ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * included at all in the request settings.</p> 1173228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When included and set to START, the camera device will trigger the 1174228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> 1175228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When set to CANCEL, the camera device will cancel any active trigger, 1176228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * and return to its initial AF state.</p> 1177e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Generally, applications should set this entry to START or CANCEL for only a 1178e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * single capture, and then return it to IDLE (or not set at all). Specifying 1179e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * START for multiple captures in a row means restarting the AF operation over 1180e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * and over again.</p> 1181e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p> 1182fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1183fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1184fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_TRIGGER_IDLE IDLE}</li> 1185fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_TRIGGER_START START}</li> 1186fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_TRIGGER_CANCEL CANCEL}</li> 1187fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 11884b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1189228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * 1190228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureResult#CONTROL_AF_STATE 11915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_TRIGGER_IDLE 11925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_TRIGGER_START 11935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_TRIGGER_CANCEL 11945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11956c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 11965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AF_TRIGGER = 11975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.afTrigger", int.class); 11985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1200b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-white balance (AWB) is currently locked to its 12012d5e89778e955b4ff209a93e738761356349d48cZhijun He * latest calculated values.</p> 1202fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters, 1203fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and will not change color balance settings until the lock is set to <code>false</code> (OFF).</p> 1204fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Since the camera device has a pipeline of in-flight requests, the settings that 1205fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * get locked do not necessarily correspond to the settings that were present in the 1206fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * latest capture result received from the camera device, since additional captures 1207fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and AWB updates may have occurred even before the result was sent out. If an 1208fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * application is switching between automatic and manual control and wishes to eliminate 1209fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * any flicker during the switch, the following procedure is recommended:</p> 1210fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ol> 1211fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Starting in auto-AWB mode:</li> 1212fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Lock AWB</li> 1213fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Wait for the first result to be output that has the AWB locked</li> 1214fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Copy AWB settings from that result into a request, set the request to manual AWB</li> 1215fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Submit the capture request, proceed to run manual AWB as desired.</li> 1216fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ol> 1217e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Note that AWB lock is only meaningful when 1218e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes, 1219e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * AWB is already fixed to a specific setting.</p> 12204b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.</p> 12214b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1222e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 1223e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#CONTROL_AWB_MODE 12245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12256c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 12265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> CONTROL_AWB_LOCK = 12275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.control.awbLock", boolean.class); 12285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1230b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-white balance (AWB) is currently setting the color 12315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * transform fields, and what its illumination target 1232cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * is.</p> 1233399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 1234e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to the ON mode, the camera device's auto-white balance 1235399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * routine is enabled, overriding the application's selected 1236399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 12377144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}. Note that when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 12387144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * is OFF, the behavior of AWB is device dependent. It is recommened to 12397144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * also set AWB mode to OFF or lock AWB by using {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} before 12407144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * setting AE mode to OFF.</p> 1241e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to the OFF mode, the camera device's auto-white balance 1242cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * routine is disabled. The application manually controls the white 1243d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} 1244399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 1245e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to any other modes, the camera device's auto-white 1246e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * balance routine is disabled. The camera device uses each 1247e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * particular illumination target for white balance 1248e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * adjustment. The application's values for 1249e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, 1250e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 1251e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p> 1252fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1253fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1254fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_OFF OFF}</li> 1255fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_AUTO AUTO}</li> 1256fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_INCANDESCENT INCANDESCENT}</li> 1257fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_FLUORESCENT FLUORESCENT}</li> 1258fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_WARM_FLUORESCENT WARM_FLUORESCENT}</li> 1259fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_DAYLIGHT DAYLIGHT}</li> 1260fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT CLOUDY_DAYLIGHT}</li> 1261fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_TWILIGHT TWILIGHT}</li> 1262fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_SHADE SHADE}</li> 1263fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1264fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1265fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES android.control.awbAvailableModes}</p> 12664b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 12670da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1268265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_GAINS 12695f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#COLOR_CORRECTION_MODE 12705f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 12717144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AE_MODE 1272fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES 12737144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AWB_LOCK 1274265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 12755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_OFF 12765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_AUTO 12775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_INCANDESCENT 12785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_FLUORESCENT 12795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 12805a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_DAYLIGHT 12815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 12825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_TWILIGHT 12835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_SHADE 12845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12856c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 12865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AWB_MODE = 12875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.awbMode", int.class); 12885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1290fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>List of metering areas to use for auto-white-balance illuminant 1291f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk * estimation.</p> 1292fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0. 1293808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 1294fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The maximum number of regions supported by the device is determined by the value 1295fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb}.</p> 1296ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 12972629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 12980da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 12990da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 130097f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 130197f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * <p>The weight must range from 0 to 1000, and represents a weight 130297f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 130397f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 130497f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 130597f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 1306fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weights are relative to weights of other white balance metering regions, so if 1307fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * only one region is used, all non-zero weights will have the same effect. A region with 1308fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0 weight is ignored.</p> 1309fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1310fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * camera device.</p> 1311fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1312fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture result metadata, the camera device will ignore the sections outside the crop 1313fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region and output only the intersection rectangle as the metering region in the result 1314fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * metadata. If the region is entirely outside the crop region, it will be ignored and 1315fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * not reported in the result metadata.</p> 1316fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1317fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1318fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Coordinates must be between <code>[(0,0), (width, height))</code> of 1319fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1320808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 13210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1322808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB 13230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 1324265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 13255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 13266c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1327817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS = 1328817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class); 13295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 133166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>Information to the camera device 3A (auto-exposure, 133266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * auto-focus, auto-white balance) routines about the purpose 133366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * of this capture, to help the camera device to decide optimal 3A 133466d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * strategy.</p> 1335e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * <p>This control (except for MANUAL) is only effective if 1336e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> 1337e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>ZERO_SHUTTER_LAG will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 13388062d31d27943da4d652878b4c36aeabb8bb8b08Chien-Yu Chen * contains PRIVATE_REPROCESSING or YUV_REPROCESSING. MANUAL will be supported if 1339513f7c33eae0084ecd70062d660f2b873032d895Zhijun He * {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains MANUAL_SENSOR. Other intent values are 1340513f7c33eae0084ecd70062d660f2b873032d895Zhijun He * always supported.</p> 1341fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1342fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1343fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_CUSTOM CUSTOM}</li> 1344fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_PREVIEW PREVIEW}</li> 1345fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_STILL_CAPTURE STILL_CAPTURE}</li> 1346fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_RECORD VIDEO_RECORD}</li> 1347fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT VIDEO_SNAPSHOT}</li> 1348fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li> 1349fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_MANUAL MANUAL}</li> 1350fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1351fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 13520da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 13530da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 1354e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 13555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_CUSTOM 13565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_PREVIEW 13575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE 13585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD 13595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT 13605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG 1361e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * @see #CONTROL_CAPTURE_INTENT_MANUAL 13625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 13636c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 13645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_CAPTURE_INTENT = 13655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.captureIntent", int.class); 13665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 13685f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * <p>A special color effect to apply.</p> 13695f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * <p>When this mode is set, a color effect will be applied 13705f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * to images produced by the camera device. The interpretation 13715f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * and implementation of these color effects is left to the 13725f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * implementor of the camera device, and should not be 13735f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * depended on to be consistent (or present) across all 13745f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * devices.</p> 1375fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1376fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1377fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_OFF OFF}</li> 1378fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_MONO MONO}</li> 1379fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_NEGATIVE NEGATIVE}</li> 1380fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_SOLARIZE SOLARIZE}</li> 1381fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_SEPIA SEPIA}</li> 1382fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_POSTERIZE POSTERIZE}</li> 1383fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_WHITEBOARD WHITEBOARD}</li> 1384fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_BLACKBOARD BLACKBOARD}</li> 1385fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_AQUA AQUA}</li> 1386fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1387fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1388fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS android.control.availableEffects}</p> 13894b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 13900da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1391fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS 13925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_OFF 13935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_MONO 13945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_NEGATIVE 13955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_SOLARIZE 13965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_SEPIA 13975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_POSTERIZE 13985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_WHITEBOARD 13995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_BLACKBOARD 14005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_AQUA 14015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 14026c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 14035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_EFFECT_MODE = 14045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.effectMode", int.class); 14055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 14065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1407fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control 1408cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * routines.</p> 1409fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This is a top-level 3A control switch. When set to OFF, all 3A control 14105f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * by the camera device is disabled. The application must set the fields for 1411f353742124af698098884b4172644af0851b30caZhijun He * capture parameters itself.</p> 1412f353742124af698098884b4172644af0851b30caZhijun He * <p>When set to AUTO, the individual algorithm controls in 14130da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 1414f353742124af698098884b4172644af0851b30caZhijun He * <p>When set to USE_SCENE_MODE, the individual controls in 14155f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * android.control.* are mostly disabled, and the camera device implements 1416f353742124af698098884b4172644af0851b30caZhijun He * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 14175f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * as it wishes. The camera device scene mode 3A settings are provided by 1418527d522f349d806fa9765130269de5a759cb6b69Zhijun He * {@link android.hardware.camera2.CaptureResult capture results}.</p> 14192d5e89778e955b4ff209a93e738761356349d48cZhijun He * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 14202d5e89778e955b4ff209a93e738761356349d48cZhijun He * is that this frame will not be used by camera device background 3A statistics 14212d5e89778e955b4ff209a93e738761356349d48cZhijun He * update, as if this frame is never captured. This mode can be used in the scenario 14222d5e89778e955b4ff209a93e738761356349d48cZhijun He * where the application doesn't want a 3A manual control capture to affect 14232d5e89778e955b4ff209a93e738761356349d48cZhijun He * the subsequent auto 3A capture results.</p> 1424fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1425fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1426fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_OFF OFF}</li> 1427fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_AUTO AUTO}</li> 1428fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_USE_SCENE_MODE USE_SCENE_MODE}</li> 1429fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_OFF_KEEP_STATE OFF_KEEP_STATE}</li> 1430fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1431d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * <p><b>Available values for this device:</b><br> 1432d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * {@link CameraCharacteristics#CONTROL_AVAILABLE_MODES android.control.availableModes}</p> 14334b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 14340da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 14350da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_AF_MODE 1436d9fc67ce3c1498a911df39675b61b96ec1364f08Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_AVAILABLE_MODES 14375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_OFF 14385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_AUTO 14395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_USE_SCENE_MODE 14402d5e89778e955b4ff209a93e738761356349d48cZhijun He * @see #CONTROL_MODE_OFF_KEEP_STATE 14415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 14426c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 14435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_MODE = 14445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.mode", int.class); 14455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 14465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1447fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Control for which scene mode is currently active.</p> 1448fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Scene modes are custom camera modes optimized for a certain set of conditions and 1449fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture settings.</p> 1450e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * <p>This is the mode that that is active when 1451ee2ebdedccaa708cfe810c50cc047990cc2054c5Zhijun He * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, these modes will 1452ee2ebdedccaa708cfe810c50cc047990cc2054c5Zhijun He * 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} 1453ee2ebdedccaa708cfe810c50cc047990cc2054c5Zhijun He * while in use.</p> 1454e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * <p>The interpretation and implementation of these scene modes is left 1455e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * to the implementor of the camera device. Their behavior will not be 1456e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * consistent across all devices, and any given device may only implement 1457e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * a subset of these modes.</p> 1458fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1459fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1460fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_DISABLED DISABLED}</li> 1461fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_FACE_PRIORITY FACE_PRIORITY}</li> 1462fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_ACTION ACTION}</li> 1463fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_PORTRAIT PORTRAIT}</li> 1464fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_LANDSCAPE LANDSCAPE}</li> 1465fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_NIGHT NIGHT}</li> 1466fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_NIGHT_PORTRAIT NIGHT_PORTRAIT}</li> 1467fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_THEATRE THEATRE}</li> 1468fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_BEACH BEACH}</li> 1469fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_SNOW SNOW}</li> 1470fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_SUNSET SUNSET}</li> 1471fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_STEADYPHOTO STEADYPHOTO}</li> 1472fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_FIREWORKS FIREWORKS}</li> 1473fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_SPORTS SPORTS}</li> 1474fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_PARTY PARTY}</li> 1475fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_CANDLELIGHT CANDLELIGHT}</li> 1476fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_BARCODE BARCODE}</li> 1477fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO HIGH_SPEED_VIDEO}</li> 1478f4eac129545fd583d33d9e7ab05cc87f61079bb9Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_HDR HDR}</li> 1479fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1480fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1481fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}</p> 14824b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 14830da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1484e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see CaptureRequest#CONTROL_AE_MODE 1485e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see CaptureRequest#CONTROL_AF_MODE 1486e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES 1487e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see CaptureRequest#CONTROL_AWB_MODE 14880da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 1489e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see #CONTROL_SCENE_MODE_DISABLED 14905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_FACE_PRIORITY 14915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_ACTION 14925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_PORTRAIT 14935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_LANDSCAPE 14945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_NIGHT 14955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT 14965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_THEATRE 14975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_BEACH 14985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_SNOW 14995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_SUNSET 15005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_STEADYPHOTO 15015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_FIREWORKS 15025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_SPORTS 15035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_PARTY 15045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_CANDLELIGHT 15055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_BARCODE 1506e040418f4779c37aa9df69a3916d376af9d2e868Zhijun He * @see #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO 1507f4eac129545fd583d33d9e7ab05cc87f61079bb9Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_HDR 15085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 15096c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 15105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_SCENE_MODE = 15115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.sceneMode", int.class); 15125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 15135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1514ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether video stabilization is 1515b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * active.</p> 1516fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Video stabilization automatically translates and scales images from 1517fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the camera in order to stabilize motion between consecutive frames.</p> 1518ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>If enabled, video stabilization can modify the 151945fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p> 1520fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Switching between different video stabilization modes may take several 1521fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * frames to initialize, the camera device will report the current mode 1522fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * in capture result metadata. For example, When "ON" mode is requested, 1523fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the video stabilization modes in the first several capture results may 1524fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * still be "OFF", and it will become "ON" when the initialization is 1525fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * done.</p> 1526fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If a camera device supports both this mode and OIS 1527fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), turning both modes on may 1528fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * produce undesirable interaction, so it is recommended not to enable 1529fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * both at the same time.</p> 1530fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1531fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1532fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_OFF OFF}</li> 1533fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_ON ON}</li> 1534fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 15354b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 15360da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 153745fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE 15380da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 15394793af5e3577c51858719a8977d300c3aafdf881Zhijun He * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF 15404793af5e3577c51858719a8977d300c3aafdf881Zhijun He * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON 15415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 15426c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 15434793af5e3577c51858719a8977d300c3aafdf881Zhijun He public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE = 15444793af5e3577c51858719a8977d300c3aafdf881Zhijun He new Key<Integer>("android.control.videoStabilizationMode", int.class); 15455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 15465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1547ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Operation mode for edge 1548cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * enhancement.</p> 1549fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Edge enhancement improves sharpness and details in the captured image. OFF means 1550fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * no enhancement will be applied by the camera device.</p> 15515f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 15522807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * will be applied. HIGH_QUALITY mode indicates that the 15535f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * camera device will use the highest-quality enhancement algorithms, 15545f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * even if it slows down capture rate. FAST means the camera device will 15552807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * not slow down capture rate when applying edge enhancement.</p> 15560e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera 15570e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * device will apply FAST/HIGH_QUALITY YUV-domain edge enhancement, respectively. 15580e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * The camera device may adjust its internal noise reduction parameters for best 15590e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * image quality based on the {@link CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR android.reprocess.effectiveExposureFactor}, if it is set.</p> 1560fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1561fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1562fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #EDGE_MODE_OFF OFF}</li> 1563fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #EDGE_MODE_FAST FAST}</li> 1564fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #EDGE_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 1565fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1566fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1567fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}</p> 15684b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 15694b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 15704b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 15714b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 15726dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * 15736dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES 15744b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 15750e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * @see CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR 15765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_OFF 15775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_FAST 15785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_HIGH_QUALITY 15795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 15806c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 15815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> EDGE_MODE = 15825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.edge.mode", int.class); 15835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 15845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 158566d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>The desired mode for for the camera device's flash control.</p> 158666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>This control is only effective when flash unit is available 1587153ac102d36df66853b523ab01763dc457972517Zhijun He * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 158866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 158966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 159066d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 159166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 159266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 159366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * device's auto-exposure routine's result. When used in still capture case, this 1594b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * control should be used along with auto-exposure (AE) precapture metering sequence 159566d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 159666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to TORCH, the flash will be on continuously. This mode can be used 159766d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 1598ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 1599fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1600fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1601fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_MODE_OFF OFF}</li> 1602fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_MODE_SINGLE SINGLE}</li> 1603fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_MODE_TORCH TORCH}</li> 1604fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 16054b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 160666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * 160766d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 160866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 160966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 1610ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#FLASH_STATE 16115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_OFF 16125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_SINGLE 16135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_TORCH 16145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16156c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 16165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> FLASH_MODE = 16175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.flash.mode", int.class); 16185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1620fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Operational mode for hot pixel correction.</p> 1621eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * <p>Hotpixel correction interpolates out, or otherwise removes, pixels 1622fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * that do not accurately measure the incoming light (i.e. pixels that 1623fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * are stuck at an arbitrary value or are oversensitive).</p> 1624fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1625fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1626fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #HOT_PIXEL_MODE_OFF OFF}</li> 1627fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #HOT_PIXEL_MODE_FAST FAST}</li> 1628fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #HOT_PIXEL_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 1629fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1630fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1631fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}</p> 16324b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 16339d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * 16349d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES 1635eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_OFF 1636eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_FAST 1637eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_HIGH_QUALITY 1638eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk */ 16396c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1640eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk public static final Key<Integer> HOT_PIXEL_MODE = 1641eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk new Key<Integer>("android.hotPixel.mode", int.class); 1642eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk 1643eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk /** 1644574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>A location object to use when generating image GPS metadata.</p> 1645fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Setting a location object in a request will include the GPS coordinates of the location 1646fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * into any JPEG images captured based on the request. These coordinates can then be 1647fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * viewed by anyone who receives the JPEG image.</p> 16484b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1649574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk */ 16506c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 16516c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @SyntheticKey 1652574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk public static final Key<android.location.Location> JPEG_GPS_LOCATION = 1653574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk new Key<android.location.Location>("android.jpeg.gpsLocation", android.location.Location.class); 1654574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk 1655574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk /** 1656ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>GPS coordinates to include in output JPEG 1657fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * EXIF.</p> 1658fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1659fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (-180 - 180], [-90,90], [-inf, inf]</p> 16604b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1661574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 16625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<double[]> JPEG_GPS_COORDINATES = 16645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 16655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1667ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>32 characters describing GPS algorithm to 1668fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * include in EXIF.</p> 1669fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: UTF-8 null-terminated string</p> 16704b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1671574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 16725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 16745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 16755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1677ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Time GPS fix was made to include in 1678fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * EXIF.</p> 1679fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: UTC in seconds since January 1, 1970</p> 16804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1681574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 16825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> JPEG_GPS_TIMESTAMP = 16845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.jpeg.gpsTimestamp", long.class); 16855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1687fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The orientation for a JPEG image.</p> 1688fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The clockwise rotation angle in degrees, relative to the orientation 1689fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * to the camera, that the JPEG picture needs to be rotated by, to be viewed 1690fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * upright.</p> 1691fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Camera devices may either encode this value into the JPEG EXIF header, or 1692d49ebcc3ad3d37d9c37e638db5d308c9c22c30fbYin-Chia Yeh * rotate the image data to match this orientation. When the image data is rotated, 1693d49ebcc3ad3d37d9c37e638db5d308c9c22c30fbYin-Chia Yeh * the thumbnail data will also be rotated.</p> 1694fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Note that this orientation is relative to the orientation of the camera sensor, given 1695fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * by {@link CameraCharacteristics#SENSOR_ORIENTATION android.sensor.orientation}.</p> 1696fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>To translate from the device orientation given by the Android sensor APIs, the following 1697fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * sample code may be used:</p> 1698fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) { 1699fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0; 1700fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION); 1701fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1702fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // Round device orientation to a multiple of 90 1703fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * deviceOrientation = (deviceOrientation + 45) / 90 * 90; 1704fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1705fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // Reverse device orientation for front-facing cameras 1706fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT; 1707fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * if (facingFront) deviceOrientation = -deviceOrientation; 1708fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1709fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // Calculate desired JPEG orientation relative to camera orientation to make 1710fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // the image upright relative to the device orientation 1711fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360; 1712fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1713fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * return jpegOrientation; 1714fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * } 1715fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </code></pre> 1716fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Degrees in multiples of 90</p> 1717fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1718fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0, 90, 180, 270</p> 17194b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1720fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1721fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_ORIENTATION 17225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 17236c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 17245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> JPEG_ORIENTATION = 17255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.jpeg.orientation", int.class); 17265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 17275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1728ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Compression quality of the final JPEG 1729b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * image.</p> 1730e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>85-95 is typical usage range.</p> 1731fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1732fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1-100; larger is higher quality</p> 17334b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 17345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 17356c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 17365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Byte> JPEG_QUALITY = 17375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Byte>("android.jpeg.quality", byte.class); 17385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 17395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1740ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Compression quality of JPEG 1741e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * thumbnail.</p> 1742fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1743fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1-100; larger is higher quality</p> 17444b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 17455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 17466c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 17475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 17485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 17495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 17505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1751b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Resolution of embedded JPEG thumbnail.</p> 17525f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 17535f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * but the captured JPEG will still be a valid image.</p> 1754fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>For best results, when issuing a request for a JPEG image, the thumbnail size selected 1755fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * should have the same aspect ratio as the main JPEG output.</p> 175650f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect 175750f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * ratio, the camera device creates the thumbnail by cropping it from the primary image. 175850f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * For example, if the primary image has 4:3 aspect ratio, the thumbnail image has 175950f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to 176050f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * generate the thumbnail image. The thumbnail image will always have a smaller Field 176150f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * Of View (FOV) than the primary image when aspect ratios differ.</p> 1762fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1763fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES android.jpeg.availableThumbnailSizes}</p> 17644b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1765fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1766fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES 17675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 17686c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 176972f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE = 177072f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class); 17715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 17725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1773fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired lens aperture size, as a ratio of lens focal length to the 1774fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * effective aperture diameter.</p> 1775fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Setting this value is only supported on the camera devices that have a variable 1776fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * aperture lens.</p> 1777fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 1778fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 1779d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} 1780fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * to achieve manual exposure control.</p> 1781fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>The requested aperture value may take several frames to reach the 1782fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * requested value; the camera device will report the current (intermediate) 1783ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * aperture size in capture result metadata while the aperture is changing. 1784ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1785fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 1786fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * the ON modes, this will be overridden by the camera device 1787fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * auto-exposure algorithm, the overridden values are then provided 1788fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * back to the user in the corresponding result.</p> 1789fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: The f-number (f/N)</p> 1790fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1791fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}</p> 17924b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 17934b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 17944b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 17954b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1796fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * 1797399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 17984b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1799265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1800ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 1801265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1802d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CaptureRequest#SENSOR_FRAME_DURATION 1803265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#SENSOR_SENSITIVITY 18045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18056c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_APERTURE = 18075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.aperture", float.class); 18085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1810fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired setting for the lens neutral density filter(s).</p> 1811fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This control will not be supported on most camera devices.</p> 1812855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * <p>Lens filters are typically used to lower the amount of light the 1813855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * sensor is exposed to (measured in steps of EV). As used here, an EV 1814855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * step is the standard logarithmic representation, which are 1815855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * non-negative, and inversely proportional to the amount of light 1816855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * hitting the sensor. For example, setting this to 0 would result 1817855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * in no reduction of the incoming light, and setting this to 2 would 1818855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * mean that the filter is set to reduce incoming light by two stops 1819855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * (allowing 1/4 of the prior amount of light to the sensor).</p> 1820ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>It may take several frames before the lens filter density changes 1821ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * to the requested value. While the filter density is still changing, 1822ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1823fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Exposure Value (EV)</p> 1824fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1825fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}</p> 18264b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 18274b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 18284b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 18294b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1830855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * 18314b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1832855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1833ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 18345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18356c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FILTER_DENSITY = 18375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.filterDensity", float.class); 18385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1840fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired lens focal length; used for optical zoom.</p> 1841a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>This setting controls the physical focal length of the camera 1842a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * device's lens. Changing the focal length changes the field of 1843a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * view of the camera device, and is usually used for optical zoom.</p> 1844a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 1845a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * setting won't be applied instantaneously, and it may take several 1846ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * frames before the lens can change to the requested focal length. 1847a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 1848a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * be set to MOVING.</p> 1849fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Optical zoom will not be supported on most devices.</p> 1850fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Millimeters</p> 1851fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1852fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths}</p> 18534b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1854a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * 1855a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureRequest#LENS_APERTURE 1856a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureRequest#LENS_FOCUS_DISTANCE 1857fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 1858a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureResult#LENS_STATE 18595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18606c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FOCAL_LENGTH = 18625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.focalLength", float.class); 18635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1865fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Desired distance to plane of sharpest focus, 1866b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * measured from frontmost surface of the lens.</p> 1867fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This control can be used for setting manual focus, on devices that support 1868fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the MANUAL_SENSOR capability and have a variable-focus lens (see 1869fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}).</p> 1870fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>A value of <code>0.0f</code> means infinity focus. The value set will be clamped to 1871fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <code>[0.0f, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}]</code>.</p> 1872ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>Like {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, this setting won't be applied 1873ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * instantaneously, and it may take several frames before the lens 1874ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * can move to the requested focus distance. While the lens is still moving, 1875ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 18764b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>LEGACY devices support at most setting this to <code>0.0f</code> 18774b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * for infinity focus.</p> 1878fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p> 1879fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1880fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * >= 0</p> 18814b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 18824b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 18834b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 18844b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1885ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * 18864b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1887ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureRequest#LENS_FOCAL_LENGTH 1888fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION 1889ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1890ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 18915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18926c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FOCUS_DISTANCE = 18945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.focusDistance", float.class); 18955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 189700849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk * <p>Sets whether the camera device uses optical image stabilization (OIS) 189800849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk * when capturing images.</p> 1899e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>OIS is used to compensate for motion blur due to small 1900e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * movements of the camera during capture. Unlike digital image 1901e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * stabilization ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), OIS 1902e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * makes use of mechanical elements to stabilize the camera 1903e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * sensor, and thus allows for longer exposure times before 1904e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * camera shake becomes apparent.</p> 190545fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * <p>Switching between different optical stabilization modes may take several 190645fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * frames to initialize, the camera device will report the current mode in 190745fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * capture result metadata. For example, When "ON" mode is requested, the 190845fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * optical stabilization modes in the first several capture results may still 190945fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * be "OFF", and it will become "ON" when the initialization is done.</p> 1910fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If a camera device supports both OIS and digital image stabilization 1911fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), turning both modes on may produce undesirable 1912fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * interaction, so it is recommended not to enable both at the same time.</p> 1913e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Not all devices will support OIS; see 1914e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for 1915e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * available controls.</p> 1916fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1917fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1918fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_OFF OFF}</li> 1919fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_ON ON}</li> 1920fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1921fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1922fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization}</p> 19234b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 19244b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 19254b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 19264b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1927e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 1928e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE 19294b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1930e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION 19315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 19325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 19335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 19346c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 19355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 19365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 19375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 19385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1939e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Mode of operation for the noise reduction algorithm.</p> 1940fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The noise reduction algorithm attempts to improve image quality by removing 19410e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * excessive noise added by the capture process, especially in dark conditions.</p> 19420e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>OFF means no noise reduction will be applied by the camera device, for both raw and 19430e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * YUV domain.</p> 19440e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>MINIMAL means that only sensor raw domain basic noise reduction is enabled ,to remove 19450e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * demosaicing or other processing artifacts. For YUV_REPROCESSING, MINIMAL is same as OFF. 19460e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * This mode is optional, may not be support by all devices. The application should check 19470e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes} before using it.</p> 19485f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 19495f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * will be applied. HIGH_QUALITY mode indicates that the camera device 19505f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * will use the highest-quality noise filtering algorithms, 1951e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * even if it slows down capture rate. FAST means the camera device will not 19522807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * slow down capture rate when applying noise filtering.</p> 19530e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device 19540e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * will apply FAST/HIGH_QUALITY YUV domain noise reduction, respectively. The camera device 19550e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * may adjust the noise reduction parameters for best image quality based on the 19560e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * {@link CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR android.reprocess.effectiveExposureFactor} if it is set.</p> 1957fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1958fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1959fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #NOISE_REDUCTION_MODE_OFF OFF}</li> 1960fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #NOISE_REDUCTION_MODE_FAST FAST}</li> 1961fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #NOISE_REDUCTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 19620e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <li>{@link #NOISE_REDUCTION_MODE_MINIMAL MINIMAL}</li> 1963fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1964fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1965fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}</p> 19664b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 19674b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 19684b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 19694b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 19706dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * 19714b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 19726dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES 19730e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * @see CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR 19745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_OFF 19755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_FAST 19765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 19770e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * @see #NOISE_REDUCTION_MODE_MINIMAL 19785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 19796c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 19805a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> NOISE_REDUCTION_MODE = 19815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.noiseReduction.mode", int.class); 19825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 19835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1984ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>An application-specified ID for the current 19855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * request. Must be maintained unchanged in output 1986ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * frame</p> 1987fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: arbitrary integer assigned by application</p> 1988fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1989fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Any int</p> 19904b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 19915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @hide 19925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 19935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> REQUEST_ID = 19945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.request.id", int.class); 19955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 19965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1997fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired region of the sensor to read out for this capture.</p> 1998fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This control can be used to implement digital zoom.</p> 1999b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The crop region coordinate system is based off 2000b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the 2001b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * top-left corner of the sensor active array.</p> 2002b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Output streams use this rectangle to produce their output, 2003b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * cropping to a smaller region if necessary to maintain the 2004b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * stream's aspect ratio, then scaling the sensor input to 2005b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * match the output's configured resolution.</p> 2006b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The crop region is applied after the RAW to other color 2007b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * space (e.g. YUV) conversion. Since raw streams 2008b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * (e.g. RAW16) don't have the conversion stage, they are not 2009b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * croppable. The crop region will be ignored by raw streams.</p> 20109e6d1880c288d7d0ddcb651dda88d069f058ecedZhijun He * <p>For non-raw streams, any additional per-stream cropping will 20119e6d1880c288d7d0ddcb651dda88d069f058ecedZhijun He * be done to maximize the final pixel area of the stream.</p> 2012ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>For example, if the crop region is set to a 4:3 aspect 2013b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * ratio, then 4:3 streams will use the exact crop 2014b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * region. 16:9 streams will further crop vertically 2015ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * (letterbox).</p> 2016ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Conversely, if the crop region is set to a 16:9, then 4:3 2017b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * outputs will crop horizontally (pillarbox), and 16:9 2018b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * streams will match exactly. These additional crops will 2019ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * be centered within the crop region.</p> 2020b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The width and height of the crop region cannot 2021b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * be set to be smaller than 2022b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <code>floor( activeArraySize.width / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and 2023b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <code>floor( activeArraySize.height / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p> 2024b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The camera device may adjust the crop region to account 2025b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * for rounding and other hardware requirements; the final 2026b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * crop region used will be included in the output capture 2027b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * result.</p> 2028fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates relative to 2029fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 20304b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2031d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * 2032d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM 2033b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 20345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 20356c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 20365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 20375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 20385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 20395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2040ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Duration each pixel is exposed to 2041ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * light.</p> 2042fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the sensor can't expose this exact duration, it will shorten the 2043fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * duration exposed to the nearest possible value (rather than expose longer). 2044fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * The final exposure time used will be available in the output capture result.</p> 2045fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to 2046fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2047fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Nanoseconds</p> 2048fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2049fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</p> 20504b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 20514b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 20524b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 20534b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 20544b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * 2055fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_AE_MODE 2056fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 20574b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2058fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE 20595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 20606c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 20615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> SENSOR_EXPOSURE_TIME = 20625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.sensor.exposureTime", long.class); 20635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 20645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2065ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Duration from start of frame exposure to 2066143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * start of next frame exposure.</p> 2067143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The maximum frame rate that can be supported by a camera subsystem is 2068143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * a function of many factors:</p> 2069143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ul> 2070143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Requested resolutions of output image streams</li> 2071143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Availability of binning / skipping modes on the imager</li> 2072143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The bandwidth of the imager interface</li> 2073143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The bandwidth of the various ISP processing blocks</li> 2074143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ul> 2075143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>Since these factors can vary greatly between different ISPs and 2076143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * sensors, the camera abstraction tries to represent the bandwidth 2077143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * restrictions with as simple a model as possible.</p> 2078143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The model presented has the following characteristics:</p> 2079143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ul> 2080143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The image sensor is always configured to output the smallest 2081143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * resolution possible given the application's requested output stream 2082143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * sizes. The smallest resolution is defined as being at least as large 2083143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * as the largest requested output stream size; the camera pipeline must 2084143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * never digitally upsample sensor data when the crop region covers the 2085143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * whole sensor. In general, this means that if only small output stream 2086143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * resolutions are configured, the sensor can provide a higher frame 2087143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * rate.</li> 2088143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Since any request may use any or all the currently configured 2089143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * output streams, the sensor and ISP must be configured to support 2090143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * scaling a single capture to all the streams at the same time. This 2091143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * means the camera pipeline must be ready to produce the largest 2092143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * requested output size without any delay. Therefore, the overall 2093143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * frame rate of a given configured stream set is governed only by the 2094143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * largest requested stream resolution.</li> 2095143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Using more than one output stream in a request does not affect the 2096143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * frame duration.</li> 2097a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Certain format-streams may need to do additional background processing 2098a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * before data is consumed/produced by that stream. These processors 2099a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * can run concurrently to the rest of the camera pipeline, but 2100a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * cannot process more than 1 capture at a time.</li> 2101143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ul> 2102143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The necessary information for the application, given the model above, 2103b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field using 2104b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration }. 2105143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * These are used to determine the maximum frame rate / minimum frame 2106143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * duration that is possible for a given stream configuration.</p> 2107143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>Specifically, the application can use the following rules to 2108a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * determine the minimum frame duration it can request from the camera 2109143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * device:</p> 2110143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ol> 2111a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Let the set of currently configured input/output streams 2112a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * be called <code>S</code>.</li> 2113b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * <li>Find the minimum frame durations for each stream in <code>S</code>, by looking 2114b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration } 2115b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * (with its respective size/format). Let this set of frame durations be 2116b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * called <code>F</code>.</li> 2117a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>For any given request <code>R</code>, the minimum frame duration allowed 2118a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams 2119a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * used in <code>R</code> be called <code>S_r</code>.</li> 2120143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ol> 2121b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * <p>If none of the streams in <code>S_r</code> have a stall time (listed in {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration } 2122b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * using its respective size/format), then the frame duration in <code>F</code> 2123b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * determines the steady state frame rate that the application will get 2124b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * if it uses <code>R</code> as a repeating request. Let this special kind of 2125b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * request be called <code>Rsimple</code>.</p> 2126a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved 2127a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * by a single capture of a new request <code>Rstall</code> (which has at least 2128a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the 2129a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * same minimum frame duration this will not cause a frame rate loss 2130a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * if all buffers from the previous <code>Rstall</code> have already been 2131a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * delivered.</p> 2132a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>For more details about stalling, see 2133b6eb52ffc51cec78c3adc2e5b25c4c3214344983Eino-Ville Talvala * {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration }.</p> 2134fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to 2135fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2136fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Nanoseconds</p> 2137fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2138fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * See {@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}, 2139fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}. The duration 2140fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * is capped to <code>max(duration, exposureTime + overhead)</code>.</p> 21414b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 21424b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 21434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 21444b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2145143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * 2146fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_AE_MODE 2147fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 21484b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 21499c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP 2150fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION 21515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 21526c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 21535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> SENSOR_FRAME_DURATION = 21545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.sensor.frameDuration", long.class); 21555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 21565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2157b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The amount of gain applied to sensor data 2158b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * before processing.</p> 2159b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The sensitivity is the standard ISO sensitivity value, 2160b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * as defined in ISO 12232:2006.</p> 2161b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The sensitivity must be within {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}, and 2162b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * if if it less than {@link CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY android.sensor.maxAnalogSensitivity}, the camera device 2163b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * is guaranteed to use only analog amplification for applying the gain.</p> 2164b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>If the camera device cannot apply the exact sensitivity 2165b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * requested, it will reduce the gain to the nearest supported 2166b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * value. The final sensitivity used will be available in the 2167b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * output capture result.</p> 2168fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: ISO arithmetic units</p> 2169fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2170fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p> 21714b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 21724b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 21734b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 21744b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2175b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * 21764b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2177b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE 2178b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY 21795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 21806c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 21815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> SENSOR_SENSITIVITY = 21825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.sensor.sensitivity", int.class); 21835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 21845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2185c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern 2186c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> 2187c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>Each color channel is treated as an unsigned 32-bit integer. 2188c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * The camera device then uses the most significant X bits 2189c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * that correspond to how many bits are in its Bayer raw sensor 2190c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * output.</p> 2191c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>For example, a sensor with RAW10 Bayer output would use the 2192c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * 10 most significant bits from each color channel.</p> 2193c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2194c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * 2195c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE 2196c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin */ 21976c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2198c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin public static final Key<int[]> SENSOR_TEST_PATTERN_DATA = 2199c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin new Key<int[]>("android.sensor.testPatternData", int[].class); 2200c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin 2201c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin /** 2202c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>When enabled, the sensor sends a test pattern instead of 2203c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * doing a real exposure from the camera.</p> 2204c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>When a test pattern is enabled, all manual sensor controls specified 2205e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * by android.sensor.* will be ignored. All other controls should 2206c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * work as normal.</p> 2207c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>For example, if manual flash is enabled, flash firing should still 2208c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * occur (and that the test pattern remain unmodified, since the flash 2209c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * would not actually affect it).</p> 2210fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Defaults to OFF.</p> 2211fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2212fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2213fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_OFF OFF}</li> 2214fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR SOLID_COLOR}</li> 2215fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS COLOR_BARS}</li> 2216fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY COLOR_BARS_FADE_TO_GRAY}</li> 2217fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_PN9 PN9}</li> 2218fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_CUSTOM1 CUSTOM1}</li> 2219fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2220fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2221fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES android.sensor.availableTestPatternModes}</p> 2222c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2223fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2224fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES 2225c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_OFF 2226c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 2227c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 2228c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 2229c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_PN9 2230c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 2231c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin */ 22326c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2233c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 2234c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin new Key<Integer>("android.sensor.testPatternMode", int.class); 2235c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin 2236c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin /** 2237ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <p>Quality of lens shading correction applied 2238ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * to the image data.</p> 2239ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <p>When set to OFF mode, no lens shading correction will be applied by the 2240ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * camera device, and an identity lens shading map data will be provided 2241ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 2242fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * shading map with size of <code>[ 4, 3 ]</code>, 2243fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the output {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap} for this case will be an identity 2244fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * map shown below:</p> 2245ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2246fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2247fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2248fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2249fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2250fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 2251ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * </code></pre> 2252fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>When set to other modes, lens shading correction will be applied by the camera 2253fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * device. Applications can request lens shading map data by setting 2254fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide lens 2255fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap}; the returned shading map 2256fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * data will be the one applied by the camera device for this capture request.</p> 2257fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore 2258fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the reliability of the map data may be affected by the AE and AWB algorithms. When AE and 2259fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * AWB are in AUTO modes({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <code>!=</code> 2260fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * OFF), to get best results, it is recommended that the applications wait for the AE and AWB 2261fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * to be converged before using the returned shading map data.</p> 2262fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2263fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2264fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SHADING_MODE_OFF OFF}</li> 2265fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SHADING_MODE_FAST FAST}</li> 2266fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SHADING_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2267fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2268e4aa2831ce6a07a6454ebd61675d9ac432f8f492Yin-Chia Yeh * <p><b>Available values for this device:</b><br> 2269e4aa2831ce6a07a6454ebd61675d9ac432f8f492Yin-Chia Yeh * {@link CameraCharacteristics#SHADING_AVAILABLE_MODES android.shading.availableModes}</p> 22704b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 22714b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 22724b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 22734b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2274ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 2275fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 2276fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * @see CaptureRequest#CONTROL_AWB_MODE 22774b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2278e4aa2831ce6a07a6454ebd61675d9ac432f8f492Yin-Chia Yeh * @see CameraCharacteristics#SHADING_AVAILABLE_MODES 2279fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP 2280ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 2281ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_OFF 2282ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_FAST 2283ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_HIGH_QUALITY 2284ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He */ 22856c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2286ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He public static final Key<Integer> SHADING_MODE = 2287ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He new Key<Integer>("android.shading.mode", int.class); 2288ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He 2289ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He /** 2290fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Operating mode for the face detector 2291b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * unit.</p> 2292ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether face detection is enabled, and whether it 22935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * should output just the basic fields or the full set of 2294fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * fields.</p> 2295fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2296fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2297fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_FACE_DETECT_MODE_OFF OFF}</li> 2298fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_FACE_DETECT_MODE_SIMPLE SIMPLE}</li> 2299fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_FACE_DETECT_MODE_FULL FULL}</li> 2300fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2301fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2302fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}</p> 2303fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 23040da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 23050da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 23065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_OFF 23075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 23085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_FULL 23095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 23106c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 23115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 23125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.statistics.faceDetectMode", int.class); 23135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 23145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2315fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Operating mode for hot pixel map generation.</p> 2316fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If set to <code>true</code>, a hot pixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. 2317fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * If set to <code>false</code>, no hot pixel map will be returned.</p> 2318fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2319fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}</p> 23204b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 23219d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * 23229d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP 23239d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES 23249d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk */ 23256c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 23269d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE = 23279d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class); 23289d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk 23299d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk /** 2330cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * <p>Whether the camera device will output the lens 2331cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * shading map in output result metadata.</p> 2332ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>When set to ON, 2333e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * android.statistics.lensShadingMap will be provided in 23347a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * the output result metadata.</p> 2335fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>ON is always supported on devices with the RAW capability.</p> 2336fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2337fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2338fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_OFF OFF}</li> 2339fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_ON ON}</li> 2340fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2341e4aa2831ce6a07a6454ebd61675d9ac432f8f492Yin-Chia Yeh * <p><b>Available values for this device:</b><br> 2342e4aa2831ce6a07a6454ebd61675d9ac432f8f492Yin-Chia Yeh * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES android.statistics.info.availableLensShadingMapModes}</p> 23434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 23444b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 23454b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 23464b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 23474b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * 23484b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2349e4aa2831ce6a07a6454ebd61675d9ac432f8f492Yin-Chia Yeh * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES 2350d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF 2351d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON 2352d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala */ 23536c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2354d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE = 2355d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala new Key<Integer>("android.statistics.lensShadingMapMode", int.class); 2356d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala 2357d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala /** 2358ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the blue 2359e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2360e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 23618490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>See android.tonemap.curveRed for more details.</p> 23624b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 23634b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 23644b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 23654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 23660da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 23674b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 23685f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#TONEMAP_MODE 23698490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 23705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 23713ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He public static final Key<float[]> TONEMAP_CURVE_BLUE = 23723ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He new Key<float[]>("android.tonemap.curveBlue", float[].class); 23735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 23745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2375ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the green 2376e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2377e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 23788490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>See android.tonemap.curveRed for more details.</p> 23794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 23804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 23814b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 23824b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 23830da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 23844b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 23855f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#TONEMAP_MODE 23868490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 23875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 23883ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He public static final Key<float[]> TONEMAP_CURVE_GREEN = 23893ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He new Key<float[]>("android.tonemap.curveGreen", float[].class); 23905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 23915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2392ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the red 2393e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2394e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 2395e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Each channel's curve is defined by an array of control points:</p> 23968490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = 2397fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 2398870922be2399766078d0a4e42a0158ecb9eb1f86Zhijun He * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 2399fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>These are sorted in order of increasing <code>Pin</code>; it is 2400fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * required that input values 0.0 and 1.0 are included in the list to 2401e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * define a complete mapping. For input values between control points, 2402e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * the camera device must linearly interpolate between the control 2403e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * points.</p> 2404e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Each curve can have an independent number of points, and the number 2405e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * of points can be less than max (that is, the request doesn't have to 2406e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * always provide a curve with number of points equivalent to 2407e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 2408e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>A few examples, and their corresponding graphical mappings; these 2409e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * only specify the red channel and the precision is limited to 4 2410e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * digits, for conciseness.</p> 2411e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Linear mapping:</p> 24128490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] 2413e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 2414e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 2415e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Invert mapping:</p> 24168490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] 2417e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 2418e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 2419e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 24208490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 2421fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 2422fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 2423fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 2424fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 2425e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 2426e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 2427e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 24288490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 2429fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 2430fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 2431fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 2432fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 2433e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 2434e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 2435fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2436fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0-1 on both input and output coordinates, normalized 2437fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * as a floating-point value such that 0 == black and 1 == white.</p> 24384b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 24394b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 24404b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 24414b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 24420da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 24434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2444e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 24450da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#TONEMAP_MODE 24468490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 24475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 24485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<float[]> TONEMAP_CURVE_RED = 24495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<float[]>("android.tonemap.curveRed", float[].class); 24505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 24515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 24528490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} 24538490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * is CONTRAST_CURVE.</p> 24548490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>The tonemapCurve consist of three curves for each of red, green, and blue 24558490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * channels respectively. The following example uses the red channel as an 24568490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * example. The same logic applies to green and blue channel. 24578490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * Each channel's curve is defined by an array of control points:</p> 24588490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = 2459fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 24608490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 24618490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>These are sorted in order of increasing <code>Pin</code>; it is always 24628490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * guaranteed that input values 0.0 and 1.0 are included in the list to 24638490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * define a complete mapping. For input values between control points, 24648490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * the camera device must linearly interpolate between the control 24658490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * points.</p> 24668490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Each curve can have an independent number of points, and the number 24678490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * of points can be less than max (that is, the request doesn't have to 24688490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * always provide a curve with number of points equivalent to 24698490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 24708490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>A few examples, and their corresponding graphical mappings; these 24718490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * only specify the red channel and the precision is limited to 4 24728490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * digits, for conciseness.</p> 24738490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Linear mapping:</p> 24748490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] 24758490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 24768490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 24778490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Invert mapping:</p> 24788490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] 24798490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 24808490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 24818490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 24828490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ 2483fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), 2484fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), 2485fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), 2486fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] 24878490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 24888490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 24898490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 24908490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ 2491fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), 2492fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), 2493fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), 2494fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] 24958490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 24968490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 24974b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 24984b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 24994b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 25004b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 25018490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * 25024b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 25038490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 25048490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CaptureRequest#TONEMAP_MODE 25058490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh */ 25066c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 25076c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @SyntheticKey 25088490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE = 25098490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class); 25108490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh 25118490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh /** 2512e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>High-level global contrast/gamma/tonemapping control.</p> 2513e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>When switching to an application-defined contrast curve by setting 2514e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 2515e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * per-channel with a set of <code>(in, out)</code> points that specify the 2516e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * mapping from input high-bit-depth pixel value to the output 2517e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * low-bit-depth value. Since the actual pixel ranges of both input 2518e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * and output may change depending on the camera pipeline, the values 2519e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * are specified by normalized floating-point numbers.</p> 2520e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>More-complex color mapping operations such as 3D color look-up 2521e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * tables, selective chroma enhancement, or other non-linear color 2522e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2523e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 2524e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>When using either FAST or HIGH_QUALITY, the camera device will 25258490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. 2526e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * These values are always available, and as close as possible to the 2527e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * actually used nonlinear/nonglobal transforms.</p> 2528fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * <p>If a request is sent with CONTRAST_CURVE with the camera device's 2529e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 2530e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * roughly the same.</p> 2531fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2532fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2533fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #TONEMAP_MODE_CONTRAST_CURVE CONTRAST_CURVE}</li> 2534fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #TONEMAP_MODE_FAST FAST}</li> 2535fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #TONEMAP_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2536956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <li>{@link #TONEMAP_MODE_GAMMA_VALUE GAMMA_VALUE}</li> 2537956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <li>{@link #TONEMAP_MODE_PRESET_CURVE PRESET_CURVE}</li> 2538fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2539fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2540fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}</p> 25414b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 25424b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 25434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 25444b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 25453242f4fb19b77bcd2435cbe710188d012d08b005Igor Murashkin * 25464b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 25476dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES 25488490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CaptureRequest#TONEMAP_CURVE 2549e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * @see CaptureRequest#TONEMAP_MODE 25505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_CONTRAST_CURVE 25515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_FAST 25525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_HIGH_QUALITY 2553956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * @see #TONEMAP_MODE_GAMMA_VALUE 2554956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * @see #TONEMAP_MODE_PRESET_CURVE 25555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 25566c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 25575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> TONEMAP_MODE = 25585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.tonemap.mode", int.class); 25595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 25605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2561956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>Tonemapping curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2562956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * GAMMA_VALUE</p> 2563956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>The tonemap curve will be defined the following formula: 2564956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * * OUT = pow(IN, 1.0 / gamma) 2565956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * where IN and OUT is the input pixel value scaled to range [0.0, 1.0], 2566956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * pow is the power function and gamma is the gamma value specified by this 2567956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * key.</p> 2568956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>The same curve will be applied to all color channels. The camera device 2569956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * may clip the input gamma value to its supported range. The actual applied 2570956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * value will be returned in capture result.</p> 2571956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>The valid range of gamma value varies on different devices, but values 2572956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * within [1.0, 5.0] are guaranteed not to be clipped.</p> 2573956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2574956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * 2575956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * @see CaptureRequest#TONEMAP_MODE 2576956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh */ 2577956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh @PublicKey 2578956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh public static final Key<Float> TONEMAP_GAMMA = 2579956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh new Key<Float>("android.tonemap.gamma", float.class); 2580956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh 2581956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh /** 2582956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>Tonemapping curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2583956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * PRESET_CURVE</p> 2584956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>The tonemap curve will be defined by specified standard.</p> 2585956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>sRGB (approximated by 16 control points):</p> 2586956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 2587956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>Rec. 709 (approximated by 16 control points):</p> 2588956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p><img alt="Rec. 709 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/rec709_tonemap.png" /></p> 2589956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p>Note that above figures show a 16 control points approximation of preset 2590956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * curves. Camera devices may apply a different approximation to the curve.</p> 2591956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p><b>Possible values:</b> 2592956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <ul> 2593956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <li>{@link #TONEMAP_PRESET_CURVE_SRGB SRGB}</li> 2594956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <li>{@link #TONEMAP_PRESET_CURVE_REC709 REC709}</li> 2595956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * </ul></p> 2596956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2597956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * 2598956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * @see CaptureRequest#TONEMAP_MODE 2599956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * @see #TONEMAP_PRESET_CURVE_SRGB 2600956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh * @see #TONEMAP_PRESET_CURVE_REC709 2601956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh */ 2602956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh @PublicKey 2603956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh public static final Key<Integer> TONEMAP_PRESET_CURVE = 2604956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh new Key<Integer>("android.tonemap.presetCurve", int.class); 2605956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh 2606956c52b5a09fa6b193b162bdb3aee629323cde2bYin-Chia Yeh /** 2607ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This LED is nominally used to indicate to the user 26085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * that the camera is powered on and may be streaming images back to the 26095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * Application Processor. In certain rare circumstances, the OS may 26105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * disable this when video is processed locally and not transmitted to 2611ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * any untrusted applications.</p> 2612ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>In particular, the LED <em>must</em> always be on when the data could be 2613ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * transmitted off the device. The LED <em>should</em> always be on whenever 2614ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * data is stored locally on the device.</p> 2615ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The LED <em>may</em> be off if a trusted application is using the data that 2616ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * doesn't violate the above rules.</p> 26174b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 26185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @hide 26195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 26205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> LED_TRANSMIT = 26215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.led.transmit", boolean.class); 26225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 26235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2624ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether black-level compensation is locked 26250956af56a294397325f2695604229ab7550364caEino-Ville Talvala * to its current values, or is free to vary.</p> 2626fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>When set to <code>true</code> (ON), the values used for black-level 26270956af56a294397325f2695604229ab7550364caEino-Ville Talvala * compensation will not change until the lock is set to 2628fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <code>false</code> (OFF).</p> 2629ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Since changes to certain capture parameters (such as 26305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * exposure time) may require resetting of black level 26310956af56a294397325f2695604229ab7550364caEino-Ville Talvala * compensation, the camera device must report whether setting 26320956af56a294397325f2695604229ab7550364caEino-Ville Talvala * the black level lock was successful in the output result 2633ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * metadata.</p> 2634ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>For example, if a sequence of requests is as follows:</p> 2635ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <ul> 2636ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 1: Exposure = 10ms, Black level lock = OFF</li> 2637ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 2: Exposure = 10ms, Black level lock = ON</li> 2638ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 3: Exposure = 10ms, Black level lock = ON</li> 2639ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 4: Exposure = 20ms, Black level lock = ON</li> 2640ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 5: Exposure = 20ms, Black level lock = ON</li> 2641ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 6: Exposure = 20ms, Black level lock = ON</li> 2642ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * </ul> 26430956af56a294397325f2695604229ab7550364caEino-Ville Talvala * <p>And the exposure change in Request 4 requires the camera 26440956af56a294397325f2695604229ab7550364caEino-Ville Talvala * device to reset the black level offsets, then the output 26450956af56a294397325f2695604229ab7550364caEino-Ville Talvala * result metadata is expected to be:</p> 2646ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <ul> 2647ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 1: Exposure = 10ms, Black level lock = OFF</li> 2648ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 2: Exposure = 10ms, Black level lock = ON</li> 2649ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 3: Exposure = 10ms, Black level lock = ON</li> 2650ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 4: Exposure = 20ms, Black level lock = OFF</li> 2651ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 5: Exposure = 20ms, Black level lock = ON</li> 2652ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 6: Exposure = 20ms, Black level lock = ON</li> 2653ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * </ul> 26540956af56a294397325f2695604229ab7550364caEino-Ville Talvala * <p>This indicates to the application that on frame 4, black 26550956af56a294397325f2695604229ab7550364caEino-Ville Talvala * levels were reset due to exposure value changes, and pixel 26560956af56a294397325f2695604229ab7550364caEino-Ville Talvala * values may not be consistent across captures.</p> 26570956af56a294397325f2695604229ab7550364caEino-Ville Talvala * <p>The camera device will maintain the lock to the extent 26580956af56a294397325f2695604229ab7550364caEino-Ville Talvala * possible, only overriding the lock to OFF when changes to 26590956af56a294397325f2695604229ab7550364caEino-Ville Talvala * other request parameters require a black level recalculation 26600956af56a294397325f2695604229ab7550364caEino-Ville Talvala * or reset.</p> 26614b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 26624b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 26634b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 26644b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 26654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * 26664b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 26675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 26686c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 26695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> BLACK_LEVEL_LOCK = 26705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.blackLevel.lock", boolean.class); 26715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 26720e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He /** 26730e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>The amount of exposure time increase factor applied to the original output 26740e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * frame by the application processing before sending for reprocessing.</p> 26750e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>This is optional, and will be supported if the camera device supports YUV_REPROCESSING 26760e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * capability ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains YUV_REPROCESSING).</p> 26770e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>For some YUV reprocessing use cases, the application may choose to filter the original 26780e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * output frames to effectively reduce the noise to the same level as a frame that was 26790e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * captured with longer exposure time. To be more specific, assuming the original captured 26800e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * images were captured with a sensitivity of S and an exposure time of T, the model in 26810e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * the camera device is that the amount of noise in the image would be approximately what 26820e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * would be expected if the original capture parameters had been a sensitivity of 26830e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * S/effectiveExposureFactor and an exposure time of T*effectiveExposureFactor, rather 26840e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * than S and T respectively. If the captured images were processed by the application 26850e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * before being sent for reprocessing, then the application may have used image processing 26860e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * algorithms and/or multi-frame image fusion to reduce the noise in the 26870e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * application-processed images (input images). By using the effectiveExposureFactor 26880e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * control, the application can communicate to the camera device the actual noise level 26890e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * improvement in the application-processed image. With this information, the camera 26900e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * device can select appropriate noise reduction and edge enhancement parameters to avoid 26910e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * excessive noise reduction ({@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode}) and insufficient edge 26920e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * enhancement ({@link CaptureRequest#EDGE_MODE android.edge.mode}) being applied to the reprocessed frames.</p> 26930e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>For example, for multi-frame image fusion use case, the application may fuse 26940e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * multiple output frames together to a final frame for reprocessing. When N image are 26950e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * fused into 1 image for reprocessing, the exposure time increase factor could be up to 26960e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * square root of N (based on a simple photon shot noise model). The camera device will 26970e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * adjust the reprocessing noise reduction and edge enhancement parameters accordingly to 26980e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * produce the best quality images.</p> 26990e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>This is relative factor, 1.0 indicates the application hasn't processed the input 27000e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * buffer in a way that affects its effective exposure time.</p> 27010e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p>This control is only effective for YUV reprocessing capture request. For noise 27020e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * reduction reprocessing, it is only effective when <code>{@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode} != OFF</code>. 27030e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * Similarly, for edge enhancement reprocessing, it is only effective when 27040e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <code>{@link CaptureRequest#EDGE_MODE android.edge.mode} != OFF</code>.</p> 27050e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p><b>Units</b>: Relative exposure time increase factor.</p> 27060e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p><b>Range of valid values:</b><br> 27070e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * >= 1.0</p> 27080e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2709513f7c33eae0084ecd70062d660f2b873032d895Zhijun He * <p><b>Limited capability</b> - 2710513f7c33eae0084ecd70062d660f2b873032d895Zhijun He * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 2711513f7c33eae0084ecd70062d660f2b873032d895Zhijun He * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 27120e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * 27130e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * @see CaptureRequest#EDGE_MODE 2714513f7c33eae0084ecd70062d660f2b873032d895Zhijun He * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 27150e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * @see CaptureRequest#NOISE_REDUCTION_MODE 27160e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 27170e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He */ 27180e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He @PublicKey 27190e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He public static final Key<Float> REPROCESS_EFFECTIVE_EXPOSURE_FACTOR = 27200e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He new Key<Float>("android.reprocess.effectiveExposureFactor", float.class); 27210e99c2260d874eaeb62ddeb75c2f29f26818ad99Zhijun He 27225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 27235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * End generated code 27245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 27256c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin 27264b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin 27274b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin 27285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala} 2729