1b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/* 2b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Copyright (C) 2012 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 1970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvalaimport android.hardware.camera2.impl.CameraMetadataNative; 20bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkinimport android.hardware.camera2.impl.CaptureResultExtras; 216c76f58f31635c19c14ae161f96dad2082537860Igor Murashkinimport android.hardware.camera2.impl.PublicKey; 226c76f58f31635c19c14ae161f96dad2082537860Igor Murashkinimport android.hardware.camera2.impl.SyntheticKey; 23d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinimport android.hardware.camera2.utils.TypeReference; 24d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinimport android.util.Log; 2572f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkinimport android.util.Rational; 26b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 27d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinimport java.util.List; 28d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 29b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/** 30db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * <p>The subset of the results of a single image capture from the image sensor.</p> 31b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 32db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * <p>Contains a subset of the final configuration for the capture hardware (sensor, lens, 33b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * flash), the processing pipeline, the control algorithms, and the output 34b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * buffers.</p> 35b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 36b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>CaptureResults are produced by a {@link CameraDevice} after processing a 37b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * {@link CaptureRequest}. All properties listed for capture requests can also 38b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * be queried on the capture result, to determine the final values used for 39b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * capture. The result also includes additional metadata about the state of the 40b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * camera device during the capture.</p> 41b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 42db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * <p>Not all properties returned by {@link CameraCharacteristics#getAvailableCaptureResultKeys()} 43db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * are necessarily available. Some results are {@link CaptureResult partial} and will 44db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * not have every key set. Only {@link TotalCaptureResult total} results are guaranteed to have 45db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * every key available that was enabled by the request.</p> 46db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * 47db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * <p>{@link CaptureResult} objects are immutable.</p> 48f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk * 49b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 50db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkinpublic class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> { 51d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 52d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin private static final String TAG = "CaptureResult"; 53d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin private static final boolean VERBOSE = false; 54d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 55d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 56d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * A {@code Key} is used to do capture result field lookups with 57d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CaptureResult#get}. 58d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 59d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>For example, to get the timestamp corresponding to the exposure of the first row: 60d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <code><pre> 61d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * long timestamp = captureResult.get(CaptureResult.SENSOR_TIMESTAMP); 62d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * </pre></code> 63d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * </p> 64d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 65d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>To enumerate over all possible keys for {@link CaptureResult}, see 66d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p> 67d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 68d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @see CaptureResult#get 69d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @see CameraCharacteristics#getAvailableCaptureResultKeys 70d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 71d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final static class Key<T> { 72d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin private final CameraMetadataNative.Key<T> mKey; 73d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 74d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 75d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for testing and vendor extensions only. 76d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 77d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 78d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 79d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public Key(String name, Class<T> type) { 80d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = new CameraMetadataNative.Key<T>(name, type); 81d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 82d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 83d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 84d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for testing and vendor extensions only. 85d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 86d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 87d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 88d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public Key(String name, TypeReference<T> typeReference) { 89d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = new CameraMetadataNative.Key<T>(name, typeReference); 90d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 91d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 92d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 93d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Return a camelCase, period separated name formatted like: 94d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@code "root.section[.subsections].name"}. 95d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 96d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."}; 97d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * keys that are device/platform-specific are prefixed with {@code "com."}.</p> 98d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 99d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would 100d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device 101d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * specific key might look like {@code "com.google.nexus.data.private"}.</p> 102d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 103d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @return String representation of the key name 104d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 105d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public String getName() { 106d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey.getName(); 107d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 108d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 109d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 110d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 111d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 112d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 113d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final int hashCode() { 114d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey.hashCode(); 115d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 116d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 117d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 118d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 119d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 120d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 121d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 122d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final boolean equals(Object o) { 123d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return o instanceof Key && ((Key<T>)o).mKey.equals(mKey); 124d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 125d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 126d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 127d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for CameraMetadataNative implementation only; do not use. 128d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 129d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * TODO: Make this private or remove it altogether. 130d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 131d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 132d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 133d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public CameraMetadataNative.Key<T> getNativeKey() { 134d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey; 135d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 136d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 137d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings({ "unchecked" }) 138d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) { 139d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = (CameraMetadataNative.Key<T>) nativeKey; 140d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 141d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 14270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 14370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private final CameraMetadataNative mResults; 1446bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin private final CaptureRequest mRequest; 1456bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin private final int mSequenceId; 146bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin private final long mFrameNumber; 14770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 14870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin /** 14970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Takes ownership of the passed-in properties object 150bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin * 151bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin * <p>For internal use only</p> 15270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin * @hide 15370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin */ 154bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin public CaptureResult(CameraMetadataNative results, CaptureRequest parent, 155bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin CaptureResultExtras extras) { 1566bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin if (results == null) { 1576bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin throw new IllegalArgumentException("results was null"); 1586bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 1596bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 1606bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin if (parent == null) { 1616bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin throw new IllegalArgumentException("parent was null"); 1626bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 1636bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 164bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin if (extras == null) { 165bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin throw new IllegalArgumentException("extras was null"); 166bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin } 167bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin 168d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mResults = CameraMetadataNative.move(results); 169d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin if (mResults.isEmpty()) { 170d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin throw new AssertionError("Results must not be empty"); 171d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 1726bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin mRequest = parent; 173bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin mSequenceId = extras.getRequestId(); 174bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin mFrameNumber = extras.getFrameNumber(); 17570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 17670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 177f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk /** 178f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk * Returns a copy of the underlying {@link CameraMetadataNative}. 179f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk * @hide 180f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk */ 181f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk public CameraMetadataNative getNativeCopy() { 182f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk return new CameraMetadataNative(mResults); 183f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk } 184f967a5486a78db244624fde4c105aa5e6fa914b9Ruben Brunk 185d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 186d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Creates a request-less result. 187d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 188d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p><strong>For testing only.</strong></p> 189d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 190d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 191d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public CaptureResult(CameraMetadataNative results, int sequenceId) { 192d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin if (results == null) { 193d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin throw new IllegalArgumentException("results was null"); 194d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 195d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 196d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mResults = CameraMetadataNative.move(results); 197d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin if (mResults.isEmpty()) { 198d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin throw new AssertionError("Results must not be empty"); 199d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 200d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 201d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mRequest = null; 202d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mSequenceId = sequenceId; 203bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin mFrameNumber = -1; 204d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 205d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 206d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 207d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Get a capture result field value. 208d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 209d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>The field definitions can be found in {@link CaptureResult}.</p> 210d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 211d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>Querying the value for the same key more than once will return a value 212d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * which is equal to the previous queried value.</p> 213d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 214d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @throws IllegalArgumentException if the key was not valid 215d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 216d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @param key The result field to read. 217d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @return The value of that key, or {@code null} if the field is not set. 218d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 21970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public <T> T get(Key<T> key) { 220d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin T value = mResults.get(key); 221d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin if (VERBOSE) Log.v(TAG, "#get for Key = " + key.getName() + ", returned value = " + value); 222d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return value; 223d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 224d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 225d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 226d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 227d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 228d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 229d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 230d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 231d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin protected <T> T getProtected(Key<?> key) { 232d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return (T) mResults.get(key); 233d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 234d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 235d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 236d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 237d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 238d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 239d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 240d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 241d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin protected Class<Key<?>> getKeyClass() { 242d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin Object thisClass = Key.class; 243d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return (Class<Key<?>>)thisClass; 244d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 245d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 246d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 247d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Dumps the native metadata contents to logcat. 248d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 249d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>Visibility for testing/debugging only. The results will not 250d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * include any synthesized keys, as they are invisible to the native layer.</p> 251d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 252d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 253d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 254d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public void dumpToLog() { 255d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mResults.dumpToLog(); 256d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 257d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 258d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 259d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 260d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 261d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 262d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public List<Key<?>> getKeys() { 263d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin // Force the javadoc for this function to show up on the CaptureResult page 264d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return super.getKeys(); 265b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala } 266b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 2676bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin /** 2686bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Get the request associated with this result. 2696bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 270db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * <p>Whenever a request has been fully or partially captured, with 271fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted} or 272fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * {@link CameraCaptureSession.CaptureCallback#onCaptureProgressed}, the {@code result}'s 273db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * {@code getRequest()} will return that {@code request}. 2746bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * </p> 2756bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 276db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * <p>For example, 277fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * <code><pre>cameraDevice.capture(someRequest, new CaptureCallback() { 2786bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * {@literal @}Override 2796bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * void onCaptureCompleted(CaptureRequest myRequest, CaptureResult myResult) { 2806bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * assert(myResult.getRequest.equals(myRequest) == true); 2816bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * } 282db075afc85b6b50a5d3a988a17ed0d4e09ef0823Igor Murashkin * }, null); 2836bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * </code></pre> 2846bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * </p> 2856bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 2866bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * @return The request associated with this result. Never {@code null}. 2876bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin */ 2886bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin public CaptureRequest getRequest() { 2896bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin return mRequest; 2906bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 2916bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 2926bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin /** 2936bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Get the frame number associated with this result. 2946bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 2956bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * <p>Whenever a request has been processed, regardless of failure or success, 2966bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * it gets a unique frame number assigned to its future result/failure.</p> 2976bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 2986bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * <p>This value monotonically increments, starting with 0, 2996bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * for every new result or failure; and the scope is the lifetime of the 3006bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * {@link CameraDevice}.</p> 3016bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 302bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin * @return The frame number 3036bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin */ 304bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin public long getFrameNumber() { 305bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin return mFrameNumber; 3066bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 3076bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 3086bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin /** 3096bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * The sequence ID for this failure that was returned by the 3100a160acf297b583e12a9710c929c4ba9a38f7353Eino-Ville Talvala * {@link CameraCaptureSession#capture} family of functions. 3116bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 3126bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * <p>The sequence ID is a unique monotonically increasing value starting from 0, 3136bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * incremented every time a new group of requests is submitted to the CameraDevice.</p> 3146bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 3156bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * @return int The ID for the sequence of requests that this capture result is a part of 3166bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 317fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * @see CameraDevice.CaptureCallback#onCaptureSequenceCompleted 318fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * @see CameraDevice.CaptureCallback#onCaptureSequenceAborted 3196bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin */ 3206bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin public int getSequenceId() { 3216bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin return mSequenceId; 3226bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 3236bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 3245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 3255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * The key entries below this point are generated from metadata 3265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * definitions in /system/media/camera/docs. Do not modify by hand or 3275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * modify the comment blocks at the start or end. 3285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 3295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 3305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 331379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>The mode control selects how the image data is converted from the 332379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * sensor's native color into linear sRGB color.</p> 333b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>When auto-white balance (AWB) is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this 334379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * control is overridden by the AWB routine. When AWB is disabled, the 335379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * application controls how the color mapping is performed.</p> 336379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>We define the expected processing pipeline below. For consistency 337379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * across devices, this is always the case with TRANSFORM_MATRIX.</p> 338379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>When either FULL or HIGH_QUALITY is used, the camera device may 339379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 340379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the 341379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * camera device (in the results) and be roughly correct.</p> 342379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Switching to TRANSFORM_MATRIX and using the data provided from 343379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * FAST or HIGH_QUALITY will yield a picture with the same white point 344379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * as what was produced by the camera device in the earlier frame.</p> 345379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>The expected processing pipeline is as follows:</p> 346379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> 347379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>The white balance is encoded by two values, a 4-channel white-balance 348379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * gain vector (applied in the Bayer domain), and a 3x3 color transform 349379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * matrix (applied after demosaic).</p> 350379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>The 4-channel white-balance gains are defined as:</p> 351379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] 352379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * </code></pre> 353379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>where <code>G_even</code> is the gain for green pixels on even rows of the 354379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * output, and <code>G_odd</code> is the gain for green pixels on the odd rows. 355379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * These may be identical for a given camera device implementation; if 356379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * the camera device does not support a separate gain for even/odd green 357379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to 358379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <code>G_even</code> in the output result metadata.</p> 359379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>The matrices for color transforms are defined as a 9-entry vector:</p> 360379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] 361379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * </code></pre> 362379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, 363379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> 364379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>with colors as follows:</p> 365379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <pre><code>r' = I0r + I1g + I2b 366379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * g' = I3r + I4g + I5b 367379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * b' = I6r + I7g + I8b 368379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * </code></pre> 369379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Both the input and output value ranges must match. Overflow/underflow 370379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * values are clipped to fit within the range.</p> 371fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 372fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 373fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX TRANSFORM_MATRIX}</li> 374fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_MODE_FAST FAST}</li> 375fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 376fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 3774b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3784b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 3794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 381379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 382379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#COLOR_CORRECTION_GAINS 383379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 384379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_AWB_MODE 3854b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 386379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX 387379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #COLOR_CORRECTION_MODE_FAST 388379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY 389379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 3906c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 391379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> COLOR_CORRECTION_MODE = 392379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.colorCorrection.mode", int.class); 393379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 394379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 395ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>A color transform matrix to use to transform 396b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * from sensor RGB color space to output linear sRGB color space.</p> 39749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>This matrix is either set by the camera device when the request 3980da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 3995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * directly by the application in the request when the 4000da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 40149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>In the latter case, the camera device may round the matrix to account 40249a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * for precision issues; the final rounded matrix should be reported back 40349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * in this matrix result metadata. The transform should keep the magnitude 40449a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * of the output color values within <code>[0, 1.0]</code> (assuming input color 40549a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 406fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Unitless scale factors</p> 4074b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 4084b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 4094b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 4104b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 4110da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 4120da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_MODE 4134b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 4145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 4156c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 4162bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM = 4172bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class); 4185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 4195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 4207d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>Gains applying to Bayer raw color channels for 421cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * white-balance.</p> 4222bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * <p>These per-channel gains are either set by the camera device 4232bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not 4242bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * TRANSFORM_MATRIX, or directly by the application in the 4252bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is 4262bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * TRANSFORM_MATRIX.</p> 4272bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * <p>The gains in the result metadata are the gains actually 4282bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * applied by the camera device to the current frame.</p> 429fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Unitless gain factors</p> 4304b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 4314b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 4324b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 4334b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 4340da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 4350da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_MODE 4364b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 4375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 4386c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 4392bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS = 4402bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class); 4415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 4425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 443a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>Mode of operation for the chromatic aberration correction algorithm.</p> 444a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light 445a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * can not focus on the same point after exiting from the lens. This metadata defines 446a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * the high level control of chromatic aberration correction algorithm, which aims to 447a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * minimize the chromatic artifacts that may occur along the object boundaries in an 448a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * image.</p> 449a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>FAST/HIGH_QUALITY both mean that camera device determined aberration 450a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * correction will be applied. HIGH_QUALITY mode indicates that the camera device will 451a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * use the highest-quality aberration correction algorithms, even if it slows down 452a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * capture rate. FAST means the camera device will not slow down capture rate when 453a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * applying aberration correction.</p> 4544b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>LEGACY devices will always be in FAST mode.</p> 455fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 456fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 457fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_OFF OFF}</li> 458fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_FAST FAST}</li> 459fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 460fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 461fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 462fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</p> 4634b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 464a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * 4659e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES 4669e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_OFF 4679e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_FAST 4689e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY 469a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He */ 4706c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 4719e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE = 4729e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He new Key<Integer>("android.colorCorrection.aberrationMode", int.class); 473a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He 474a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He /** 475379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>The desired setting for the camera device's auto-exposure 476379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * algorithm's antibanding compensation.</p> 477379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Some kinds of lighting fixtures, such as some fluorescent 478379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * lights, flicker at the rate of the power supply frequency 479379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * (60Hz or 50Hz, depending on country). While this is 480379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * typically not noticeable to a person, it can be visible to 481379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * a camera device. If a camera sets its exposure time to the 482379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * wrong value, the flicker may become visible in the 483379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * viewfinder as flicker or in a final captured image, as a 484379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * set of variable-brightness bands across the image.</p> 485379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Therefore, the auto-exposure routines of camera devices 486379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * include antibanding routines that ensure that the chosen 487379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * exposure value will not cause such banding. The choice of 488379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * exposure time depends on the rate of flicker, which the 489379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * camera device can detect automatically, or the expected 490379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * rate can be selected by the application using this 491379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * control.</p> 492379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>A given camera device may not support all of the possible 493379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * options for the antibanding mode. The 494379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains 495379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * the available modes for a given camera device.</p> 4967b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * <p>AUTO mode is the default if it is available on given 4977b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * camera device. When AUTO mode is not available, the 4987b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * default will be either 50HZ or 60HZ, and both 50HZ 4997b2cae6ceca680f6034a9fe43df2446cbae2f090Yin-Chia Yeh * and 60HZ will be available.</p> 500379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>If manual exposure control is enabled (by setting 501379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), 502379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * then this setting has no effect, and the application must 503379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * ensure it selects exposure times that do not cause banding 504379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist 505379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * the application in this.</p> 506fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 507fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 508fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_OFF OFF}</li> 509fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_50HZ 50HZ}</li> 510fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_60HZ 60HZ}</li> 511fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_AUTO AUTO}</li> 512fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 513fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br></p> 514fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>{@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes}</p> 5154b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 516379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 517379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES 518379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 519379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_MODE 520379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureResult#STATISTICS_SCENE_FLICKER 521379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AE_ANTIBANDING_MODE_OFF 522379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ 523379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ 524379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO 525379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 5266c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 527379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE = 528379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.aeAntibandingMode", int.class); 529379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 530379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 531b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Adjustment to auto-exposure (AE) target image 532b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * brightness.</p> 533b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The adjustment is measured as a count of steps, with the 534b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * step size defined by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} and the 535b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * allowed range by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}.</p> 536b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>For example, if the exposure value (EV) step is 0.333, '6' 537b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * will mean an exposure compensation of +2 EV; -3 will mean an 538b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * exposure compensation of -1 EV. One EV represents a doubling 539b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * of image brightness. Note that this control will only be 540b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control 541b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * will take effect even when {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> 542a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * <p>In the event of exposure compensation value being changed, camera device 543a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * may take several frames to reach the newly requested exposure target. 544a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING 545a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will 546a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or 547a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * FLASH_REQUIRED (if the scene is too dark for still capture).</p> 548fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Compensation steps</p> 549fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 550fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}</p> 5514b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 552a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * 553b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE 554b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP 555a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_LOCK 556a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_MODE 557a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureResult#CONTROL_AE_STATE 558379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 5596c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 560379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION = 561379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.aeExposureCompensation", int.class); 562379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 563379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 564b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-exposure (AE) is currently locked to its latest 565379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * calculated values.</p> 566fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters, 567fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and will not change exposure settings until the lock is set to <code>false</code> (OFF).</p> 568fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Note that even when AE is locked, the flash may be fired if 569fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / 570fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.</p> 571a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock 572a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * is ON, the camera device will still adjust its exposure value.</p> 573379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) 574379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * when AE is already locked, the camera device will not change the exposure time 575379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) 576379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 577379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the 578379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p> 579fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Since the camera device has a pipeline of in-flight requests, the settings that 580fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * get locked do not necessarily correspond to the settings that were present in the 581fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * latest capture result received from the camera device, since additional captures 582fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and AE updates may have occurred even before the result was sent out. If an 583fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * application is switching between automatic and manual control and wishes to eliminate 584fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * any flicker during the switch, the following procedure is recommended:</p> 585fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ol> 586fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Starting in auto-AE mode:</li> 587fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Lock AE</li> 588fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Wait for the first result to be output that has the AE locked</li> 589fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Copy exposure settings from that result into a request, set the request to manual AE</li> 590fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Submit the capture request, proceed to run manual AE as desired.</li> 591fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ol> 592379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> 5934b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 594379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 595a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION 596379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 597379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 598379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureResult#CONTROL_AE_STATE 599379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#SENSOR_EXPOSURE_TIME 600379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#SENSOR_SENSITIVITY 601379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 6026c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 603379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Boolean> CONTROL_AE_LOCK = 604379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Boolean>("android.control.aeLock", boolean.class); 605379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 606379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 6070da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The desired mode for the camera device's 6080da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * auto-exposure routine.</p> 6090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 6100da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * AUTO.</p> 6110da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>When set to any of the ON modes, the camera device's 6120da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * auto-exposure routine is enabled, overriding the 6130da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * application's selected exposure time, sensor sensitivity, 6140da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 6150da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 6160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 6170da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * is selected, the camera device's flash unit controls are 6180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * also overridden.</p> 6190da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The FLASH modes are only available if the camera device 6200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 6210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>If flash TORCH mode is desired, this field must be set to 6220da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 6230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>When set to any of the ON modes, the values chosen by the 6240da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * camera device auto-exposure routine for the overridden 6250da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * fields for a given capture will be available in its 6260da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * CaptureResult.</p> 627fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 628fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 629fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_OFF OFF}</li> 630fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON ON}</li> 631fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH ON_AUTO_FLASH}</li> 632fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON_ALWAYS_FLASH ON_ALWAYS_FLASH}</li> 633fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE ON_AUTO_FLASH_REDEYE}</li> 634fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 635fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 636fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES android.control.aeAvailableModes}</p> 6374b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 6380da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 639fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES 6405f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#CONTROL_MODE 641265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 642265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#FLASH_MODE 643aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @see CaptureRequest#SENSOR_EXPOSURE_TIME 644aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @see CaptureRequest#SENSOR_FRAME_DURATION 645399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#SENSOR_SENSITIVITY 6460da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see #CONTROL_AE_MODE_OFF 6470da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON 6480da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 6490da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 6500da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 6510da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala */ 6526c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 6530da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_MODE = 6540da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala new Key<Integer>("android.control.aeMode", int.class); 6550da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala 6560da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala /** 657fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>List of metering areas to use for auto-exposure adjustment.</p> 658fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0. 659808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 660fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The maximum number of regions supported by the device is determined by the value 661fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe}.</p> 662ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 6632629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 6640da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 6650da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 66697f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 667fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 66897f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 66997f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 67097f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 67197f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 672fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weights are relative to weights of other exposure metering regions, so if only one 673fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region is used, all non-zero weights will have the same effect. A region with 0 674fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * weight is ignored.</p> 675fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 676fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * camera device.</p> 677fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 678fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture result metadata, the camera device will ignore the sections outside the crop 679fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region and output only the intersection rectangle as the metering region in the result 680fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * metadata. If the region is entirely outside the crop region, it will be ignored and 681fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * not reported in the result metadata.</p> 682fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 683fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 684fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Coordinates must be between <code>[(0,0), (width, height))</code> of 685fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 686808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 6870da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 688808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE 6890da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 690265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 6915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 6926c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 693817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS = 694817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class); 6955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 6965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 697fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Range over which the auto-exposure routine can 698fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * adjust the capture frame rate to maintain good 699fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * exposure.</p> 700b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Only constrains auto-exposure (AE) algorithm, not 701fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} and 702fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}.</p> 703fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Frames per second (FPS)</p> 704fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 705fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Any of the entries in {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges}</p> 706fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 707379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 708fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES 709379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#SENSOR_EXPOSURE_TIME 710fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#SENSOR_FRAME_DURATION 711379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 7126c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 71378712a8bd7275542013ba099f33536eead0167fbIgor Murashkin public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE = 71478712a8bd7275542013ba099f33536eead0167fbIgor Murashkin new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }}); 715379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 716379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 717379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Whether the camera device will trigger a precapture 718379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * metering sequence when it processes this request.</p> 719379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>This entry is normally set to IDLE, or is not 720379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * included at all in the request settings. When included and 721dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * set to START, the camera device will trigger the auto-exposure (AE) 722379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * precapture metering sequence.</p> 723dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * <p>The precapture sequence should be triggered before starting a 724e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * high-quality still capture for final metering decisions to 725e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * be made, and for firing pre-capture flash pulses to estimate 726e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * scene brightness and required final capture flash power, when 727e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * the flash is enabled.</p> 728e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Normally, this entry should be set to START for only a 729e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * single request, and the application should wait until the 730e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * sequence completes before starting a new one.</p> 731dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * <p>When a precapture metering sequence is finished, the camera device 732dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * may lock the auto-exposure routine internally to be able to accurately expose the 733dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * subsequent still capture image (<code>{@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} == STILL_CAPTURE</code>). 734dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * For this case, the AE may not resume normal scan if no subsequent still capture is 735dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * submitted. To ensure that the AE routine restarts normal scan, the application should 736dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * submit a request with <code>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == true</code>, followed by a request 737dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * with <code>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == false</code>, if the application decides not to submit a 738dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * still capture request after the precapture sequence completes.</p> 739e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>The exact effect of auto-exposure (AE) precapture trigger 740e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * depends on the current AE mode and state; see 741b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition 742b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * details.</p> 743fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>On LEGACY-level devices, the precapture trigger is not supported; 744fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capturing a high-resolution JPEG image will automatically trigger a 745fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * precapture sequence before the high-resolution capture, including 746fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * potentially firing a pre-capture flash.</p> 747fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 748fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 749fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE IDLE}</li> 750fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_START START}</li> 751fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 7524b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 7534b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 7544b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 7554b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 756379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 757dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * @see CaptureRequest#CONTROL_AE_LOCK 758379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureResult#CONTROL_AE_STATE 759dd72be5971039f6f61af47c956287dc28b33f34cZhijun He * @see CaptureRequest#CONTROL_CAPTURE_INTENT 7604b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 761379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE 762379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START 763379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 7646c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 765379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER = 766379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.aePrecaptureTrigger", int.class); 767379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 768379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 769e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Current state of the auto-exposure (AE) algorithm.</p> 770228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Switching between or enabling AE modes ({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}) always 771228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * resets the AE state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 772228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 773228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * the algorithm states to INACTIVE.</p> 774228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>The camera device can do several state transitions between two results, if it is 775228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * allowed by the state transition table. For example: INACTIVE may never actually be 776228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * seen in a result.</p> 777228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>The state in the result is the state for this image (in sync with this image): if 778228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * AE state becomes CONVERGED, then the image data associated with this result should 779228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * be good to use.</p> 780228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Below are state transition tables for different AE modes.</p> 781228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 782228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 783228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 784228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 785228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 786228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 787228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 788228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 789228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 790228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 791228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 792228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 793228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center"></td> 794228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 795228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device auto exposure algorithm is disabled</td> 796228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 797228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 798228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 799228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is AE_MODE_ON_*:</p> 800228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 801228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 802228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 803228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 804228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 805228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 806228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 807228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 808228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 809228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 810228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 811228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 812228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates AE scan</td> 813228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 814228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values changing</td> 815228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 816228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 817228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 818228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 819228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 820228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values locked</td> 821228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 822228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 823228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 824228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device finishes AE scan</td> 825228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 826228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Good values, not changing</td> 827228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 828228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 829228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 830228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device finishes AE scan</td> 831228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FLASH_REQUIRED</td> 832228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Converged but too dark w/o flash</td> 833228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 834228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 835228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 836228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 837228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 838228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values locked</td> 839228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 840228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 841228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 842228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates AE scan</td> 843228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 844228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values changing</td> 845228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 846228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 847228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 848228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 849228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 850228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values locked</td> 851228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 852228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 853228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FLASH_REQUIRED</td> 854228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates AE scan</td> 855228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 856228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values changing</td> 857228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 858228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 859228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FLASH_REQUIRED</td> 860228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 861228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 862228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values locked</td> 863228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 864228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 865228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 866228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 867228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 868228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values not good after unlock</td> 869228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 870228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 871228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 872228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 873228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 874228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values good after unlock</td> 875228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 876228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 877228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 878228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 879228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FLASH_REQUIRED</td> 880228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Exposure good, but too dark</td> 881228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 882228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 883228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PRECAPTURE</td> 884228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 885228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 886228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Ready for high-quality capture</td> 887228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 888228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 889228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PRECAPTURE</td> 890228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 891228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 892228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Ready for high-quality capture</td> 893228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 894228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 895228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Any state</td> 896228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START</td> 897228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PRECAPTURE</td> 898228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AE precapture metering sequence</td> 899228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 900228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 901228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 90260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <p>For the above table, the camera device may skip reporting any state changes that happen 90360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * without application intervention (i.e. mode switch, trigger, locking). Any state that 90460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * can be skipped in that manner is called a transient state.</p> 90560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <p>For example, for above AE modes (AE_MODE_ON_*), in addition to the state transitions 90660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * listed in above table, it is also legal for the camera device to skip one or more 90760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * transient states between two results. See below table for examples:</p> 90860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <table> 90960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <thead> 91060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 91160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">State</th> 91260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Transition Cause</th> 91360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">New State</th> 91460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Notes</th> 91560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 91660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </thead> 91760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tbody> 91860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 91960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">INACTIVE</td> 92060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Camera device finished AE scan</td> 92160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">CONVERGED</td> 92260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Values are already good, transient states are skipped by camera device.</td> 92360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 92460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 92560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Any state</td> 92660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done</td> 92760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">FLASH_REQUIRED</td> 92860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Converged but too dark w/o flash after a precapture sequence, transient states are skipped by camera device.</td> 92960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 93060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 93160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Any state</td> 93260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done</td> 93360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">CONVERGED</td> 93460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Converged after a precapture sequence, transient states are skipped by camera device.</td> 93560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 93660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 93760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">CONVERGED</td> 93860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Camera device finished AE scan</td> 93960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">FLASH_REQUIRED</td> 94060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Converged but too dark w/o flash after a new scan, transient states are skipped by camera device.</td> 94160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 94260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 94360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">FLASH_REQUIRED</td> 94460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Camera device finished AE scan</td> 94560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">CONVERGED</td> 94660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Converged after a new scan, transient states are skipped by camera device.</td> 94760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 94860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tbody> 94960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </table> 950fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 951fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 952fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_STATE_INACTIVE INACTIVE}</li> 953fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_STATE_SEARCHING SEARCHING}</li> 954fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_STATE_CONVERGED CONVERGED}</li> 955fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_STATE_LOCKED LOCKED}</li> 956fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_STATE_FLASH_REQUIRED FLASH_REQUIRED}</li> 957fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AE_STATE_PRECAPTURE PRECAPTURE}</li> 958fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 9594b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 9604b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 9614b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 9624b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 963228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * 964228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_AE_LOCK 965228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_AE_MODE 966228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 967228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_MODE 968228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_SCENE_MODE 9694b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 9705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_STATE_INACTIVE 9715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_STATE_SEARCHING 9725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_STATE_CONVERGED 9735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_STATE_LOCKED 9745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_STATE_FLASH_REQUIRED 9755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_STATE_PRECAPTURE 9765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 9776c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 9785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_STATE = 9795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aeState", int.class); 9805a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 9815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 982b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-focus (AF) is currently enabled, and what 983b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * mode it is set to.</p> 984cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus 9857144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>). Also note that 9867144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, the behavior of AF is device 9877144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * dependent. It is recommended to lock AF by using {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} before 9887144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * setting {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} to OFF, or set AF mode to OFF when AE is OFF.</p> 98978146ecb24871302a4c4dc0a7341044a06d29ee8Zhijun He * <p>If the lens is controlled by the camera device auto-focus algorithm, 990d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} 991fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * in result metadata.</p> 992fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 993fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 994fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_OFF OFF}</li> 995fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_AUTO AUTO}</li> 996fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_MACRO MACRO}</li> 997fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_VIDEO CONTINUOUS_VIDEO}</li> 998fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_PICTURE CONTINUOUS_PICTURE}</li> 999fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_MODE_EDOF EDOF}</li> 1000fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1001fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1002fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES android.control.afAvailableModes}</p> 1003fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 10040da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 10057144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AE_MODE 1006fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES 1007d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CaptureResult#CONTROL_AF_STATE 10087144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AF_TRIGGER 10090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 1010cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 10115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_OFF 10125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_AUTO 10135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_MACRO 10145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 10155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 10165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_EDOF 10175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10186c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 10195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AF_MODE = 10205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.afMode", int.class); 10215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1023fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>List of metering areas to use for auto-focus.</p> 1024fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0. 1025808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 1026fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The maximum number of focus areas supported by the device is determined by the value 1027fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf}.</p> 1028ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 10292629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 10300da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 10310da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 103297f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 1033fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 103497f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 103597f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 103697f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 103797f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 1038fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weights are relative to weights of other metering regions, so if only one region 1039fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * is used, all non-zero weights will have the same effect. A region with 0 weight is 1040fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ignored.</p> 1041fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1042fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * camera device.</p> 1043fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1044fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture result metadata, the camera device will ignore the sections outside the crop 1045fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region and output only the intersection rectangle as the metering region in the result 1046fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * metadata. If the region is entirely outside the crop region, it will be ignored and 1047fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * not reported in the result metadata.</p> 1048fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1049fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1050fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Coordinates must be between <code>[(0,0), (width, height))</code> of 1051fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1052808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 10530da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1054808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF 10550da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 1056265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 10575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10586c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1059817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS = 1060817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class); 10615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1063379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Whether the camera device will trigger autofocus for this request.</p> 1064379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>This entry is normally set to IDLE, or is not 1065379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * included at all in the request settings.</p> 1066379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>When included and set to START, the camera device will trigger the 1067379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> 1068379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>When set to CANCEL, the camera device will cancel any active trigger, 1069379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * and return to its initial AF state.</p> 1070e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Generally, applications should set this entry to START or CANCEL for only a 1071e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * single capture, and then return it to IDLE (or not set at all). Specifying 1072e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * START for multiple captures in a row means restarting the AF operation over 1073e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * and over again.</p> 1074e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p> 1075fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1076fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1077fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_TRIGGER_IDLE IDLE}</li> 1078fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_TRIGGER_START START}</li> 1079fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_TRIGGER_CANCEL CANCEL}</li> 1080fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 10814b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1082379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 1083379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureResult#CONTROL_AF_STATE 1084379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AF_TRIGGER_IDLE 1085379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AF_TRIGGER_START 1086379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_AF_TRIGGER_CANCEL 1087379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 10886c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1089379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_AF_TRIGGER = 1090379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.afTrigger", int.class); 1091379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 1092379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 1093b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Current state of auto-focus (AF) algorithm.</p> 1094228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Switching between or enabling AF modes ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) always 1095228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * resets the AF state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 1096228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 1097228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * the algorithm states to INACTIVE.</p> 1098228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>The camera device can do several state transitions between two results, if it is 1099228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * allowed by the state transition table. For example: INACTIVE may never actually be 1100228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * seen in a result.</p> 1101228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>The state in the result is the state for this image (in sync with this image): if 1102228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * AF state becomes FOCUSED, then the image data associated with this result should 1103228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * be sharp.</p> 1104228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Below are state transition tables for different AF modes.</p> 1105228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_OFF or AF_MODE_EDOF:</p> 1106228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 1107228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 1108228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1109228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 1110228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 1111228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 1112228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 1113228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1114228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 1115228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 1116228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1117228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1118228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center"></td> 1119228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1120228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Never changes</td> 1121228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1122228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 1123228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 1124228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_AUTO or AF_MODE_MACRO:</p> 1125228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 1126228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 1127228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1128228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 1129228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 1130228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 1131228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 1132228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1133228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 1134228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 1135228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1136228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1137228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1138228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">ACTIVE_SCAN</td> 1139228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AF sweep, Lens now moving</td> 1140228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1141228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1142228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">ACTIVE_SCAN</td> 1143228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF sweep done</td> 1144228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1145228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Focused, Lens now locked</td> 1146228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1147228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1148228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">ACTIVE_SCAN</td> 1149228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF sweep done</td> 1150228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1151228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Not focused, Lens now locked</td> 1152228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1153228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1154228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">ACTIVE_SCAN</td> 1155228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1156228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1157228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Cancel/reset AF, Lens now locked</td> 1158228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1159228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1160228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1161228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1162228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1163228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Cancel/reset AF</td> 1164228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1165228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1166228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1167228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1168228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">ACTIVE_SCAN</td> 1169228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start new sweep, Lens now moving</td> 1170228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1171228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1172228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1173228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1174228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1175228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Cancel/reset AF</td> 1176228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1177228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1178228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1179228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1180228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">ACTIVE_SCAN</td> 1181228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start new sweep, Lens now moving</td> 1182228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1183228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1184228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Any state</td> 1185228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Mode change</td> 1186228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1187228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center"></td> 1188228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1189228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 1190228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 119160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <p>For the above table, the camera device may skip reporting any state changes that happen 119260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * without application intervention (i.e. mode switch, trigger, locking). Any state that 119360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * can be skipped in that manner is called a transient state.</p> 119460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <p>For example, for these AF modes (AF_MODE_AUTO and AF_MODE_MACRO), in addition to the 119560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * state transitions listed in above table, it is also legal for the camera device to skip 119660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * one or more transient states between two results. See below table for examples:</p> 119760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <table> 119860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <thead> 119960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 120060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">State</th> 120160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Transition Cause</th> 120260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">New State</th> 120360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Notes</th> 120460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 120560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </thead> 120660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tbody> 120760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 120860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">INACTIVE</td> 120960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">AF_TRIGGER</td> 121060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">FOCUSED_LOCKED</td> 121160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Focus is already good or good after a scan, lens is now locked.</td> 121260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 121360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 121460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">INACTIVE</td> 121560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">AF_TRIGGER</td> 121660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 121760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Focus failed after a scan, lens is now locked.</td> 121860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 121960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 122060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">FOCUSED_LOCKED</td> 122160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">AF_TRIGGER</td> 122260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">FOCUSED_LOCKED</td> 122360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Focus is already good or good after a scan, lens is now locked.</td> 122460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 122560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 122660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 122760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">AF_TRIGGER</td> 122860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">FOCUSED_LOCKED</td> 122960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Focus is good after a scan, lens is not locked.</td> 123060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 123160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tbody> 123260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </table> 1233228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_VIDEO:</p> 1234228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 1235228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 1236228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1237228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 1238228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 1239228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 1240228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 1241228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1242228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 1243228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 1244228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1245228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1246228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates new scan</td> 1247228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1248228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AF scan, Lens now moving</td> 1249228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1250228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1251228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1252228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1253228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1254228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF state query, Lens now locked</td> 1255228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1256228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1257228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1258228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device completes current scan</td> 1259228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_FOCUSED</td> 1260228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">End AF scan, Lens now locked</td> 1261228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1262228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1263228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1264228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device fails current scan</td> 1265228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_UNFOCUSED</td> 1266228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">End AF scan, Lens now locked</td> 1267228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1268228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1269228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1270228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1271228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1272e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <td align="center">Immediate transition, if focus is good. Lens now locked</td> 1273228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1274228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1275228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1276228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1277228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1278e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <td align="center">Immediate transition, if focus is bad. Lens now locked</td> 1279228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1280228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1281228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1282228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1283228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1284228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Reset lens position, Lens now locked</td> 1285228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1286228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1287228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_FOCUSED</td> 1288228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates new scan</td> 1289228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1290228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AF scan, Lens now moving</td> 1291228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1292228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1293228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_UNFOCUSED</td> 1294228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates new scan</td> 1295228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1296228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AF scan, Lens now moving</td> 1297228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1298228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1299228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_FOCUSED</td> 1300228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1301228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1302e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <td align="center">Immediate transition, lens now locked</td> 1303228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1304228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1305228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_UNFOCUSED</td> 1306228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1307228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1308e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <td align="center">Immediate transition, lens now locked</td> 1309228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1310228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1311228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1312228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1313228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1314228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">No effect</td> 1315228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1316228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1317228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1318228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1319228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1320228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Restart AF scan</td> 1321228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1322228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1323228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1324228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1325228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1326228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">No effect</td> 1327228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1328228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1329228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1330228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1331228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1332228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Restart AF scan</td> 1333228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1334228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 1335228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 1336228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_PICTURE:</p> 1337228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 1338228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 1339228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1340228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 1341228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 1342228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 1343228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 1344228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1345228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 1346228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 1347228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1348228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1349228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates new scan</td> 1350228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1351228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AF scan, Lens now moving</td> 1352228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1353228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1354228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1355228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1356228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1357228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF state query, Lens now locked</td> 1358228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1359228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1360228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1361228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device completes current scan</td> 1362228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_FOCUSED</td> 1363228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">End AF scan, Lens now locked</td> 1364228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1365228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1366228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1367228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device fails current scan</td> 1368228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_UNFOCUSED</td> 1369228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">End AF scan, Lens now locked</td> 1370228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1371228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1372228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1373228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1374228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1375e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <td align="center">Eventual transition once the focus is good. Lens now locked</td> 1376228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1377228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1378228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1379228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1380228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1381e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <td align="center">Eventual transition if cannot find focus. Lens now locked</td> 1382228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1383228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1384228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1385228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1386228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1387228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Reset lens position, Lens now locked</td> 1388228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1389228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1390228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_FOCUSED</td> 1391228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates new scan</td> 1392228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1393228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AF scan, Lens now moving</td> 1394228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1395228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1396228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_UNFOCUSED</td> 1397228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates new scan</td> 1398228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_SCAN</td> 1399228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Start AF scan, Lens now moving</td> 1400228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1401228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1402228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_FOCUSED</td> 1403228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1404228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1405228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Immediate trans. Lens now locked</td> 1406228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1407228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1408228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">PASSIVE_UNFOCUSED</td> 1409228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1410228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1411228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Immediate trans. Lens now locked</td> 1412228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1413228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1414228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1415228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1416228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1417228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">No effect</td> 1418228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1419228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1420228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">FOCUSED_LOCKED</td> 1421228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1422228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1423228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Restart AF scan</td> 1424228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1425228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1426228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1427228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_TRIGGER</td> 1428228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1429228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">No effect</td> 1430228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1431228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1432228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">NOT_FOCUSED_LOCKED</td> 1433228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">AF_CANCEL</td> 1434228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1435228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Restart AF scan</td> 1436228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1437228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 1438228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 143960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <p>When switch between AF_MODE_CONTINUOUS_* (CAF modes) and AF_MODE_AUTO/AF_MODE_MACRO 144060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * (AUTO modes), the initial INACTIVE or PASSIVE_SCAN states may be skipped by the 144160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * camera device. When a trigger is included in a mode switch request, the trigger 144260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * will be evaluated in the context of the new mode in the request. 144360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * See below table for examples:</p> 144460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <table> 144560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <thead> 144660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 144760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">State</th> 144860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Transition Cause</th> 144960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">New State</th> 145060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Notes</th> 145160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 145260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </thead> 145360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tbody> 145460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 145560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">any state</td> 145660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">CAF-->AUTO mode switch</td> 145760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">INACTIVE</td> 145860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Mode switch without trigger, initial state must be INACTIVE</td> 145960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 146060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 146160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">any state</td> 146260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">CAF-->AUTO mode switch with AF_TRIGGER</td> 146360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">trigger-reachable states from INACTIVE</td> 146460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Mode switch with trigger, INACTIVE is skipped</td> 146560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 146660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 146760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">any state</td> 146860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">AUTO-->CAF mode switch</td> 146960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">passively reachable states from INACTIVE</td> 147060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Mode switch without trigger, passive transient state is skipped</td> 147160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 147260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tbody> 147360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </table> 1474fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1475fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1476fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_STATE_INACTIVE INACTIVE}</li> 1477fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_STATE_PASSIVE_SCAN PASSIVE_SCAN}</li> 1478fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_STATE_PASSIVE_FOCUSED PASSIVE_FOCUSED}</li> 1479fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_STATE_ACTIVE_SCAN ACTIVE_SCAN}</li> 1480fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_STATE_FOCUSED_LOCKED FOCUSED_LOCKED}</li> 1481fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED NOT_FOCUSED_LOCKED}</li> 1482fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AF_STATE_PASSIVE_UNFOCUSED PASSIVE_UNFOCUSED}</li> 1483fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 14844b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1485228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * 1486228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_AF_MODE 1487228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_MODE 1488228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_SCENE_MODE 14895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_STATE_INACTIVE 14905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_STATE_PASSIVE_SCAN 14915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED 14925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_STATE_ACTIVE_SCAN 14935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_STATE_FOCUSED_LOCKED 14945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED 14959f880f79a3f179443c8b37c3434717432b2ec8d9Eino-Ville Talvala * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED 14965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 14976c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 14985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AF_STATE = 14995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.afState", int.class); 15005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 15015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1502b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-white balance (AWB) is currently locked to its 1503379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * latest calculated values.</p> 1504fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters, 1505fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and will not change color balance settings until the lock is set to <code>false</code> (OFF).</p> 1506fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Since the camera device has a pipeline of in-flight requests, the settings that 1507fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * get locked do not necessarily correspond to the settings that were present in the 1508fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * latest capture result received from the camera device, since additional captures 1509fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * and AWB updates may have occurred even before the result was sent out. If an 1510fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * application is switching between automatic and manual control and wishes to eliminate 1511fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * any flicker during the switch, the following procedure is recommended:</p> 1512fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ol> 1513fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Starting in auto-AWB mode:</li> 1514fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Lock AWB</li> 1515fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Wait for the first result to be output that has the AWB locked</li> 1516fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Copy AWB settings from that result into a request, set the request to manual AWB</li> 1517fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>Submit the capture request, proceed to run manual AWB as desired.</li> 1518fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ol> 1519e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Note that AWB lock is only meaningful when 1520e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes, 1521e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * AWB is already fixed to a specific setting.</p> 15224b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.</p> 15234b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1524e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 1525e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#CONTROL_AWB_MODE 1526379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 15276c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1528379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Boolean> CONTROL_AWB_LOCK = 1529379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Boolean>("android.control.awbLock", boolean.class); 1530379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 1531379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 1532b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-white balance (AWB) is currently setting the color 15335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * transform fields, and what its illumination target 1534cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * is.</p> 1535399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 1536e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to the ON mode, the camera device's auto-white balance 1537399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * routine is enabled, overriding the application's selected 1538399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 15397144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}. Note that when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 15407144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * is OFF, the behavior of AWB is device dependent. It is recommened to 15417144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * also set AWB mode to OFF or lock AWB by using {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} before 15427144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * setting AE mode to OFF.</p> 1543e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to the OFF mode, the camera device's auto-white balance 1544cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * routine is disabled. The application manually controls the white 1545d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} 1546399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 1547e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to any other modes, the camera device's auto-white 1548e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * balance routine is disabled. The camera device uses each 1549e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * particular illumination target for white balance 1550e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * adjustment. The application's values for 1551e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, 1552e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 1553e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p> 1554fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1555fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1556fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_OFF OFF}</li> 1557fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_AUTO AUTO}</li> 1558fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_INCANDESCENT INCANDESCENT}</li> 1559fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_FLUORESCENT FLUORESCENT}</li> 1560fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_WARM_FLUORESCENT WARM_FLUORESCENT}</li> 1561fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_DAYLIGHT DAYLIGHT}</li> 1562fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT CLOUDY_DAYLIGHT}</li> 1563fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_TWILIGHT TWILIGHT}</li> 1564fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_MODE_SHADE SHADE}</li> 1565fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1566fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1567fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES android.control.awbAvailableModes}</p> 15684b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 15690da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1570265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_GAINS 15715f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#COLOR_CORRECTION_MODE 15725f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 15737144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AE_MODE 1574fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES 15757144b5d2cf445ed245cfd9b09c7897966d01b5ffYin-Chia Yeh * @see CaptureRequest#CONTROL_AWB_LOCK 1576265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 15775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_OFF 15785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_AUTO 15795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_INCANDESCENT 15805a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_FLUORESCENT 15815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 15825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_DAYLIGHT 15835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 15845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_TWILIGHT 15855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_SHADE 15865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 15876c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 15885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AWB_MODE = 15895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.awbMode", int.class); 15905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 15915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1592fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>List of metering areas to use for auto-white-balance illuminant 1593f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk * estimation.</p> 1594fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0. 1595808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 1596fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The maximum number of regions supported by the device is determined by the value 1597fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb}.</p> 1598ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 15992629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 16000da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 16010da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 160297f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 160397f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * <p>The weight must range from 0 to 1000, and represents a weight 160497f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 160597f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 160697f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 160797f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 1608fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The weights are relative to weights of other white balance metering regions, so if 1609fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * only one region is used, all non-zero weights will have the same effect. A region with 1610fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0 weight is ignored.</p> 1611fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1612fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * camera device.</p> 1613fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1614fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture result metadata, the camera device will ignore the sections outside the crop 1615fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * region and output only the intersection rectangle as the metering region in the result 1616fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * metadata. If the region is entirely outside the crop region, it will be ignored and 1617fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * not reported in the result metadata.</p> 1618fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1619fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 1620fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Coordinates must be between <code>[(0,0), (width, height))</code> of 1621fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1622808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 16230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1624808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB 16250da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 1626265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 16275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16286c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1629817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS = 1630817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class); 16315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1633379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Information to the camera device 3A (auto-exposure, 1634379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * auto-focus, auto-white balance) routines about the purpose 1635379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * of this capture, to help the camera device to decide optimal 3A 1636379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * strategy.</p> 1637379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>This control (except for MANUAL) is only effective if 1638379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> 1639e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>ZERO_SHUTTER_LAG will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 1640e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * contains ZSL. MANUAL will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 1641fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * contains MANUAL_SENSOR. Other intent values are always supported.</p> 1642fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1643fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1644fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_CUSTOM CUSTOM}</li> 1645fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_PREVIEW PREVIEW}</li> 1646fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_STILL_CAPTURE STILL_CAPTURE}</li> 1647fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_RECORD VIDEO_RECORD}</li> 1648fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT VIDEO_SNAPSHOT}</li> 1649fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li> 1650fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_CAPTURE_INTENT_MANUAL MANUAL}</li> 1651fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1652fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 1653379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 1654379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_MODE 1655379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 1656379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_CAPTURE_INTENT_CUSTOM 1657379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_CAPTURE_INTENT_PREVIEW 1658379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE 1659379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD 1660379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT 1661379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG 1662379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_CAPTURE_INTENT_MANUAL 1663379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 16646c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1665379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_CAPTURE_INTENT = 1666379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.captureIntent", int.class); 1667379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 1668379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 1669b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Current state of auto-white balance (AWB) algorithm.</p> 1670228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Switching between or enabling AWB modes ({@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}) always 1671228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * resets the AWB state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 1672228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 1673228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * the algorithm states to INACTIVE.</p> 1674228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>The camera device can do several state transitions between two results, if it is 1675228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * allowed by the state transition table. So INACTIVE may never actually be seen in 1676228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * a result.</p> 1677228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>The state in the result is the state for this image (in sync with this image): if 1678228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * AWB state becomes CONVERGED, then the image data associated with this result should 1679228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * be good to use.</p> 1680228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Below are state transition tables for different AWB modes.</p> 1681228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != AWB_MODE_AUTO</code>:</p> 1682228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 1683228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 1684228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1685228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 1686228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 1687228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 1688228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 1689228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1690228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 1691228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 1692228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1693228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1694228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center"></td> 1695228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1696228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device auto white balance algorithm is disabled</td> 1697228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1698228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 1699228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 1700228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is AWB_MODE_AUTO:</p> 1701228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <table> 1702228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <thead> 1703228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1704228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">State</th> 1705228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Transition Cause</th> 1706228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">New State</th> 1707228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <th align="center">Notes</th> 1708228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1709228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </thead> 1710228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tbody> 1711228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1712228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1713228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates AWB scan</td> 1714228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 1715228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values changing</td> 1716228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1717228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1718228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">INACTIVE</td> 1719228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1720228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 1721228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values locked</td> 1722228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1723228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1724228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 1725228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device finishes AWB scan</td> 1726228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 1727228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Good values, not changing</td> 1728228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1729228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1730228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 1731228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1732228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 1733228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values locked</td> 1734228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1735228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1736228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 1737228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Camera device initiates AWB scan</td> 1738228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 1739228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values changing</td> 1740228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1741228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1742228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 1743228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1744228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 1745228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values locked</td> 1746228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1747228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1748228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 1749228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 1750228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">SEARCHING</td> 1751228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">Values not good after unlock</td> 1752228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 175360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tbody> 175460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </table> 175560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <p>For the above table, the camera device may skip reporting any state changes that happen 175660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * without application intervention (i.e. mode switch, trigger, locking). Any state that 175760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * can be skipped in that manner is called a transient state.</p> 175860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <p>For example, for this AWB mode (AWB_MODE_AUTO), in addition to the state transitions 175960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * listed in above table, it is also legal for the camera device to skip one or more 176060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * transient states between two results. See below table for examples:</p> 176160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <table> 176260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <thead> 176360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 176460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">State</th> 176560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Transition Cause</th> 176660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">New State</th> 176760b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <th align="center">Notes</th> 176860b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 176960b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </thead> 177060b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tbody> 177160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <tr> 177260b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">INACTIVE</td> 177360b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Camera device finished AWB scan</td> 177460b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">CONVERGED</td> 177560b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Values are already good, transient states are skipped by camera device.</td> 177660b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * </tr> 1777228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <tr> 1778228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">LOCKED</td> 1779228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 1780228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <td align="center">CONVERGED</td> 178160b19dc2df1afef1caf151b9df4cc60af3c395e8Zhijun He * <td align="center">Values good after unlock, transient states are skipped by camera device.</td> 1782228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tr> 1783228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </tbody> 1784228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * </table> 1785fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1786fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1787fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_STATE_INACTIVE INACTIVE}</li> 1788fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_STATE_SEARCHING SEARCHING}</li> 1789fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_STATE_CONVERGED CONVERGED}</li> 1790fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_AWB_STATE_LOCKED LOCKED}</li> 1791fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 17924b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 17934b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 17944b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 17954b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1796228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * 1797228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_AWB_LOCK 1798228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_AWB_MODE 1799228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_MODE 1800228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureRequest#CONTROL_SCENE_MODE 18014b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 18025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_STATE_INACTIVE 18035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_STATE_SEARCHING 18045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_STATE_CONVERGED 18055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_STATE_LOCKED 18065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18076c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AWB_STATE = 18095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.awbState", int.class); 18105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1812379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>A special color effect to apply.</p> 1813379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>When this mode is set, a color effect will be applied 1814379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * to images produced by the camera device. The interpretation 1815379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * and implementation of these color effects is left to the 1816379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * implementor of the camera device, and should not be 1817379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * depended on to be consistent (or present) across all 1818379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * devices.</p> 1819fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1820fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1821fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_OFF OFF}</li> 1822fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_MONO MONO}</li> 1823fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_NEGATIVE NEGATIVE}</li> 1824fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_SOLARIZE SOLARIZE}</li> 1825fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_SEPIA SEPIA}</li> 1826fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_POSTERIZE POSTERIZE}</li> 1827fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_WHITEBOARD WHITEBOARD}</li> 1828fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_BLACKBOARD BLACKBOARD}</li> 1829fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_EFFECT_MODE_AQUA AQUA}</li> 1830fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1831fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1832fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS android.control.availableEffects}</p> 18334b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1834379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 1835fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS 1836379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_OFF 1837379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_MONO 1838379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_NEGATIVE 1839379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_SOLARIZE 1840379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_SEPIA 1841379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_POSTERIZE 1842379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_WHITEBOARD 1843379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_BLACKBOARD 1844379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_EFFECT_MODE_AQUA 1845379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 18466c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1847379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_EFFECT_MODE = 1848379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.effectMode", int.class); 1849379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 1850379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 1851fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control 1852cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * routines.</p> 1853fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This is a top-level 3A control switch. When set to OFF, all 3A control 18545f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * by the camera device is disabled. The application must set the fields for 1855f353742124af698098884b4172644af0851b30caZhijun He * capture parameters itself.</p> 1856f353742124af698098884b4172644af0851b30caZhijun He * <p>When set to AUTO, the individual algorithm controls in 18570da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 1858f353742124af698098884b4172644af0851b30caZhijun He * <p>When set to USE_SCENE_MODE, the individual controls in 18595f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * android.control.* are mostly disabled, and the camera device implements 1860f353742124af698098884b4172644af0851b30caZhijun He * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 18615f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * as it wishes. The camera device scene mode 3A settings are provided by 1862f353742124af698098884b4172644af0851b30caZhijun He * android.control.sceneModeOverrides.</p> 18632d5e89778e955b4ff209a93e738761356349d48cZhijun He * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 18642d5e89778e955b4ff209a93e738761356349d48cZhijun He * is that this frame will not be used by camera device background 3A statistics 18652d5e89778e955b4ff209a93e738761356349d48cZhijun He * update, as if this frame is never captured. This mode can be used in the scenario 18662d5e89778e955b4ff209a93e738761356349d48cZhijun He * where the application doesn't want a 3A manual control capture to affect 18672d5e89778e955b4ff209a93e738761356349d48cZhijun He * the subsequent auto 3A capture results.</p> 18684b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>LEGACY mode devices will only support AUTO and USE_SCENE_MODE modes. 18694b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * LIMITED mode devices will only support OFF and OFF_KEEP_STATE if they 1870fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * support the MANUAL_SENSOR and MANUAL_POST_PROCSESING capabilities. 1871fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * FULL mode devices will always support OFF and OFF_KEEP_STATE.</p> 1872fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1873fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1874fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_OFF OFF}</li> 1875fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_AUTO AUTO}</li> 1876fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_USE_SCENE_MODE USE_SCENE_MODE}</li> 1877fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_MODE_OFF_KEEP_STATE OFF_KEEP_STATE}</li> 1878fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 18794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 18800da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 18810da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_AF_MODE 18825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_OFF 18835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_AUTO 18845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_USE_SCENE_MODE 18852d5e89778e955b4ff209a93e738761356349d48cZhijun He * @see #CONTROL_MODE_OFF_KEEP_STATE 18865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18876c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_MODE = 18895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.mode", int.class); 18905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1892fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Control for which scene mode is currently active.</p> 1893fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Scene modes are custom camera modes optimized for a certain set of conditions and 1894fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * capture settings.</p> 1895379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>This is the mode that that is active when 1896379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, 1897379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, 1898fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p> 1899379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>The interpretation and implementation of these scene modes is left 1900379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * to the implementor of the camera device. Their behavior will not be 1901379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * consistent across all devices, and any given device may only implement 1902379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * a subset of these modes.</p> 1903fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1904fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1905fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_DISABLED DISABLED}</li> 1906fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_FACE_PRIORITY FACE_PRIORITY}</li> 1907fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_ACTION ACTION}</li> 1908fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_PORTRAIT PORTRAIT}</li> 1909fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_LANDSCAPE LANDSCAPE}</li> 1910fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_NIGHT NIGHT}</li> 1911fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_NIGHT_PORTRAIT NIGHT_PORTRAIT}</li> 1912fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_THEATRE THEATRE}</li> 1913fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_BEACH BEACH}</li> 1914fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_SNOW SNOW}</li> 1915fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_SUNSET SUNSET}</li> 1916fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_STEADYPHOTO STEADYPHOTO}</li> 1917fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_FIREWORKS FIREWORKS}</li> 1918fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_SPORTS SPORTS}</li> 1919fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_PARTY PARTY}</li> 1920fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_CANDLELIGHT CANDLELIGHT}</li> 1921fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_BARCODE BARCODE}</li> 1922fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO HIGH_SPEED_VIDEO}</li> 1923f4eac129545fd583d33d9e7ab05cc87f61079bb9Eino-Ville Talvala * <li>{@link #CONTROL_SCENE_MODE_HDR HDR}</li> 1924fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 1925fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 1926fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}</p> 19274b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1928379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 1929379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 1930379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_AF_MODE 1931e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES 1932379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_AWB_MODE 1933379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#CONTROL_MODE 1934379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_DISABLED 1935379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_FACE_PRIORITY 1936379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_ACTION 1937379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_PORTRAIT 1938379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_LANDSCAPE 1939379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_NIGHT 1940379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT 1941379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_THEATRE 1942379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_BEACH 1943379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_SNOW 1944379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_SUNSET 1945379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_STEADYPHOTO 1946379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_FIREWORKS 1947379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_SPORTS 1948379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_PARTY 1949379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_CANDLELIGHT 1950379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_SCENE_MODE_BARCODE 1951e040418f4779c37aa9df69a3916d376af9d2e868Zhijun He * @see #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO 1952f4eac129545fd583d33d9e7ab05cc87f61079bb9Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_HDR 1953379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 19546c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1955379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_SCENE_MODE = 1956379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.sceneMode", int.class); 1957379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 1958379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 1959379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Whether video stabilization is 1960b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * active.</p> 1961fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Video stabilization automatically translates and scales images from 1962fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the camera in order to stabilize motion between consecutive frames.</p> 1963379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>If enabled, video stabilization can modify the 196445fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p> 1965fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Switching between different video stabilization modes may take several 1966fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * frames to initialize, the camera device will report the current mode 1967fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * in capture result metadata. For example, When "ON" mode is requested, 1968fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the video stabilization modes in the first several capture results may 1969fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * still be "OFF", and it will become "ON" when the initialization is 1970fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * done.</p> 1971fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If a camera device supports both this mode and OIS 1972fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), turning both modes on may 1973fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * produce undesirable interaction, so it is recommended not to enable 1974fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * both at the same time.</p> 1975fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 1976fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 1977fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_OFF OFF}</li> 1978fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_ON ON}</li> 1979fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 19804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 1981379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 198245fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE 1983379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#SCALER_CROP_REGION 1984379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF 1985379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON 1986379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 19876c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1988379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE = 1989379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.control.videoStabilizationMode", int.class); 1990379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 1991379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 1992ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Operation mode for edge 1993cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * enhancement.</p> 1994fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Edge enhancement improves sharpness and details in the captured image. OFF means 1995fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * no enhancement will be applied by the camera device.</p> 19965f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 19972807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * will be applied. HIGH_QUALITY mode indicates that the 19985f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * camera device will use the highest-quality enhancement algorithms, 19995f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * even if it slows down capture rate. FAST means the camera device will 20002807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * not slow down capture rate when applying edge enhancement.</p> 2001fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2002fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2003fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #EDGE_MODE_OFF OFF}</li> 2004fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #EDGE_MODE_FAST FAST}</li> 2005fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #EDGE_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2006fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2007fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2008fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}</p> 20094b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 20104b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 20114b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 20124b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 20136dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * 20146dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES 20154b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 20165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_OFF 20175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_FAST 20185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_HIGH_QUALITY 20195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 20206c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 20215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> EDGE_MODE = 20225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.edge.mode", int.class); 20235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 20245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 202566d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>The desired mode for for the camera device's flash control.</p> 202666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>This control is only effective when flash unit is available 2027153ac102d36df66853b523ab01763dc457972517Zhijun He * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 202866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 202966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 203066d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 203166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 203266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 203366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * device's auto-exposure routine's result. When used in still capture case, this 2034b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * control should be used along with auto-exposure (AE) precapture metering sequence 203566d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 203666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to TORCH, the flash will be on continuously. This mode can be used 203766d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 2038ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 2039fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2040fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2041fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_MODE_OFF OFF}</li> 2042fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_MODE_SINGLE SINGLE}</li> 2043fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_MODE_TORCH TORCH}</li> 2044fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 20454b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 204666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * 204766d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 204866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 204966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 2050ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#FLASH_STATE 20515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_OFF 20525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_SINGLE 20535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_TORCH 20545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 20556c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 20565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> FLASH_MODE = 20575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.flash.mode", int.class); 20585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 20595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2060ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Current state of the flash 2061ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * unit.</p> 2062ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>When the camera device doesn't have flash unit 2063ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * (i.e. <code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == false</code>), this state will always be UNAVAILABLE. 2064ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * Other states indicate the current flash status.</p> 20654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>In certain conditions, this will be available on LEGACY devices:</p> 20664b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <ul> 20674b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <li>Flash-less cameras always return UNAVAILABLE.</li> 20684b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <li>Using {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>==</code> ON_ALWAYS_FLASH 2069fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * will always return FIRED.</li> 20704b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <li>Using {@link CaptureRequest#FLASH_MODE android.flash.mode} <code>==</code> TORCH 2071fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * will always return FIRED.</li> 20724b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * </ul> 20734b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>In all other conditions the state will not be available on 20744b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * LEGACY devices (i.e. it will be <code>null</code>).</p> 2075fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2076fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2077fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_STATE_UNAVAILABLE UNAVAILABLE}</li> 2078fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_STATE_CHARGING CHARGING}</li> 2079fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_STATE_READY READY}</li> 2080fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_STATE_FIRED FIRED}</li> 2081fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #FLASH_STATE_PARTIAL PARTIAL}</li> 2082fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 20834b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 20844b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 20854b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 20864b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2087ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * 20884b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CaptureRequest#CONTROL_AE_MODE 2089ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 20904b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CaptureRequest#FLASH_MODE 20914b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 20925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_STATE_UNAVAILABLE 20935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_STATE_CHARGING 20945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_STATE_READY 20955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_STATE_FIRED 20968dda7273dbb4ff6eeffe7d4c3831e9b31b8e5ac1Zhijun He * @see #FLASH_STATE_PARTIAL 20975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 20986c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 20995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> FLASH_STATE = 21005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.flash.state", int.class); 21015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 21025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2103fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Operational mode for hot pixel correction.</p> 2104eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * <p>Hotpixel correction interpolates out, or otherwise removes, pixels 2105fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * that do not accurately measure the incoming light (i.e. pixels that 2106fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * are stuck at an arbitrary value or are oversensitive).</p> 2107fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2108fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2109fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #HOT_PIXEL_MODE_OFF OFF}</li> 2110fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #HOT_PIXEL_MODE_FAST FAST}</li> 2111fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #HOT_PIXEL_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2112fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2113fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2114fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}</p> 21154b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 21169d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * 21179d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES 2118eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_OFF 2119eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_FAST 2120eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_HIGH_QUALITY 2121eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk */ 21226c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2123eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk public static final Key<Integer> HOT_PIXEL_MODE = 2124eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk new Key<Integer>("android.hotPixel.mode", int.class); 2125eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk 2126eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk /** 2127574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>A location object to use when generating image GPS metadata.</p> 2128fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Setting a location object in a request will include the GPS coordinates of the location 2129fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * into any JPEG images captured based on the request. These coordinates can then be 2130fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * viewed by anyone who receives the JPEG image.</p> 21314b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2132574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk */ 21336c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 21346c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @SyntheticKey 2135574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk public static final Key<android.location.Location> JPEG_GPS_LOCATION = 2136574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk new Key<android.location.Location>("android.jpeg.gpsLocation", android.location.Location.class); 2137574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk 2138574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk /** 2139ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>GPS coordinates to include in output JPEG 2140fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * EXIF.</p> 2141fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2142fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (-180 - 180], [-90,90], [-inf, inf]</p> 21434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2144574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 21455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 21465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<double[]> JPEG_GPS_COORDINATES = 21475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 21485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 21495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2150ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>32 characters describing GPS algorithm to 2151fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * include in EXIF.</p> 2152fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: UTF-8 null-terminated string</p> 21534b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2154574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 21555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 21565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 21575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 21585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 21595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2160ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Time GPS fix was made to include in 2161fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * EXIF.</p> 2162fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: UTC in seconds since January 1, 1970</p> 21634b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2164574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 21655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 21665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> JPEG_GPS_TIMESTAMP = 21675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.jpeg.gpsTimestamp", long.class); 21685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 21695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2170fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The orientation for a JPEG image.</p> 2171fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The clockwise rotation angle in degrees, relative to the orientation 2172fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * to the camera, that the JPEG picture needs to be rotated by, to be viewed 2173fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * upright.</p> 2174fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Camera devices may either encode this value into the JPEG EXIF header, or 2175fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * rotate the image data to match this orientation.</p> 2176fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Note that this orientation is relative to the orientation of the camera sensor, given 2177fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * by {@link CameraCharacteristics#SENSOR_ORIENTATION android.sensor.orientation}.</p> 2178fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>To translate from the device orientation given by the Android sensor APIs, the following 2179fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * sample code may be used:</p> 2180fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) { 2181fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0; 2182fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION); 2183fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2184fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // Round device orientation to a multiple of 90 2185fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * deviceOrientation = (deviceOrientation + 45) / 90 * 90; 2186fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2187fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // Reverse device orientation for front-facing cameras 2188fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT; 2189fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * if (facingFront) deviceOrientation = -deviceOrientation; 2190fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2191fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // Calculate desired JPEG orientation relative to camera orientation to make 2192fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * // the image upright relative to the device orientation 2193fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360; 2194fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2195fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * return jpegOrientation; 2196fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * } 2197fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </code></pre> 2198fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Degrees in multiples of 90</p> 2199fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2200fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0, 90, 180, 270</p> 22014b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2202fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2203fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_ORIENTATION 22045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 22056c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 22065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> JPEG_ORIENTATION = 22075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.jpeg.orientation", int.class); 22085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 22095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2210ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Compression quality of the final JPEG 2211b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * image.</p> 2212e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>85-95 is typical usage range.</p> 2213fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2214fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1-100; larger is higher quality</p> 22154b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 22165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 22176c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 22185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Byte> JPEG_QUALITY = 22195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Byte>("android.jpeg.quality", byte.class); 22205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 22215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2222ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Compression quality of JPEG 2223e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * thumbnail.</p> 2224fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2225fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1-100; larger is higher quality</p> 22264b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 22275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 22286c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 22295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 22305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 22315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 22325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2233b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Resolution of embedded JPEG thumbnail.</p> 22345f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 22355f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * but the captured JPEG will still be a valid image.</p> 2236fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>For best results, when issuing a request for a JPEG image, the thumbnail size selected 2237fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * should have the same aspect ratio as the main JPEG output.</p> 223850f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect 223950f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * ratio, the camera device creates the thumbnail by cropping it from the primary image. 224050f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * For example, if the primary image has 4:3 aspect ratio, the thumbnail image has 224150f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to 224250f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * generate the thumbnail image. The thumbnail image will always have a smaller Field 224350f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * Of View (FOV) than the primary image when aspect ratios differ.</p> 2244fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2245fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES android.jpeg.availableThumbnailSizes}</p> 22464b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2247fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2248fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES 22495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 22506c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 225172f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE = 225272f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class); 22535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 22545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2255fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired lens aperture size, as a ratio of lens focal length to the 2256fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * effective aperture diameter.</p> 2257fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Setting this value is only supported on the camera devices that have a variable 2258fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * aperture lens.</p> 2259fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 2260fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 2261d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} 2262fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * to achieve manual exposure control.</p> 2263fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>The requested aperture value may take several frames to reach the 2264fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * requested value; the camera device will report the current (intermediate) 2265ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * aperture size in capture result metadata while the aperture is changing. 2266ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 2267fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 2268fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * the ON modes, this will be overridden by the camera device 2269fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * auto-exposure algorithm, the overridden values are then provided 2270fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * back to the user in the corresponding result.</p> 2271fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: The f-number (f/N)</p> 2272fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2273fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}</p> 22744b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 22754b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 22764b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 22774b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2278fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * 2279399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 22804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2281265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 2282ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 2283265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#SENSOR_EXPOSURE_TIME 2284d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CaptureRequest#SENSOR_FRAME_DURATION 2285265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#SENSOR_SENSITIVITY 22865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 22876c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 22885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_APERTURE = 22895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.aperture", float.class); 22905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 22915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2292fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired setting for the lens neutral density filter(s).</p> 2293fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This control will not be supported on most camera devices.</p> 2294855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * <p>Lens filters are typically used to lower the amount of light the 2295855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * sensor is exposed to (measured in steps of EV). As used here, an EV 2296855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * step is the standard logarithmic representation, which are 2297855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * non-negative, and inversely proportional to the amount of light 2298855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * hitting the sensor. For example, setting this to 0 would result 2299855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * in no reduction of the incoming light, and setting this to 2 would 2300855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * mean that the filter is set to reduce incoming light by two stops 2301855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * (allowing 1/4 of the prior amount of light to the sensor).</p> 2302ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>It may take several frames before the lens filter density changes 2303ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * to the requested value. While the filter density is still changing, 2304ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 2305fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Exposure Value (EV)</p> 2306fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2307fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}</p> 23084b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 23094b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 23104b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 23114b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2312855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * 23134b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2314855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 2315ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 23165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 23176c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 23185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FILTER_DENSITY = 23195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.filterDensity", float.class); 23205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 23215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2322fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired lens focal length; used for optical zoom.</p> 2323a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>This setting controls the physical focal length of the camera 2324a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * device's lens. Changing the focal length changes the field of 2325a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * view of the camera device, and is usually used for optical zoom.</p> 2326a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 2327a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * setting won't be applied instantaneously, and it may take several 2328ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * frames before the lens can change to the requested focal length. 2329a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 2330a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * be set to MOVING.</p> 2331fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Optical zoom will not be supported on most devices.</p> 2332fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Millimeters</p> 2333fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2334fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths}</p> 23354b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2336a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * 2337a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureRequest#LENS_APERTURE 2338a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureRequest#LENS_FOCUS_DISTANCE 2339fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 2340a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureResult#LENS_STATE 23415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 23426c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 23435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FOCAL_LENGTH = 23445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.focalLength", float.class); 23455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 23465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2347fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Desired distance to plane of sharpest focus, 2348b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * measured from frontmost surface of the lens.</p> 2349ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Should be zero for fixed-focus cameras</p> 2350fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p> 2351fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2352fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * >= 0</p> 23534b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 23544b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 23554b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 23564b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 23574b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * 23584b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2359fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION 23605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 23616c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 23625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FOCUS_DISTANCE = 23635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.focusDistance", float.class); 23645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 23655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2366ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The range of scene distances that are in 2367b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * sharp focus (depth of field).</p> 2368ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>If variable focus not supported, can still report 2369ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * fixed depth of field range</p> 2370fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: A pair of focus distances in diopters: (near, 2371fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * far); see {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details.</p> 2372fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2373fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * >=0</p> 23744b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 23754b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 23764b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 23774b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 23784b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * 23794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2380fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION 23815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 23826c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 23835743868e15c88d2886915163652a1571a218bf39Igor Murashkin public static final Key<android.util.Pair<Float,Float>> LENS_FOCUS_RANGE = 23845743868e15c88d2886915163652a1571a218bf39Igor Murashkin new Key<android.util.Pair<Float,Float>>("android.lens.focusRange", new TypeReference<android.util.Pair<Float,Float>>() {{ }}); 23855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 23865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 238700849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk * <p>Sets whether the camera device uses optical image stabilization (OIS) 238800849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk * when capturing images.</p> 2389e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>OIS is used to compensate for motion blur due to small 2390e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * movements of the camera during capture. Unlike digital image 2391e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * stabilization ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), OIS 2392e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * makes use of mechanical elements to stabilize the camera 2393e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * sensor, and thus allows for longer exposure times before 2394e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * camera shake becomes apparent.</p> 239545fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * <p>Switching between different optical stabilization modes may take several 239645fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * frames to initialize, the camera device will report the current mode in 239745fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * capture result metadata. For example, When "ON" mode is requested, the 239845fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * optical stabilization modes in the first several capture results may still 239945fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * be "OFF", and it will become "ON" when the initialization is done.</p> 2400fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If a camera device supports both OIS and digital image stabilization 2401fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), turning both modes on may produce undesirable 2402fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * interaction, so it is recommended not to enable both at the same time.</p> 2403e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Not all devices will support OIS; see 2404e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for 2405e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * available controls.</p> 2406fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2407fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2408fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_OFF OFF}</li> 2409fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_ON ON}</li> 2410fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2411fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2412fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization}</p> 24134b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 24144b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 24154b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 24164b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2417e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 2418e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE 24194b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2420e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION 24215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 24225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 24235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 24246c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 24255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 24265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 24275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 24285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2429ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>Current lens status.</p> 2430ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>For lens parameters {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}, 2431ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, when changes are requested, 2432ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * they may take several frames to reach the requested values. This state indicates 2433ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * the current status of the lens parameters.</p> 2434ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>When the state is STATIONARY, the lens parameters are not changing. This could be 2435ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * either because the parameters are all fixed, or because the lens has had enough 2436ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * time to reach the most recently-requested values. 2437ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * If all these lens parameters are not changable for a camera device, as listed below:</p> 2438ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <ul> 2439ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <li>Fixed focus (<code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} == 0</code>), which means 2440ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} parameter will always be 0.</li> 2441ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <li>Fixed focal length ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths} contains single value), 2442ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * which means the optical zoom is not supported.</li> 2443ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <li>No ND filter ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities} contains only 0).</li> 2444ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <li>Fixed aperture ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures} contains single value).</li> 2445ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * </ul> 2446ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>Then this state will always be STATIONARY.</p> 2447ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>When the state is MOVING, it indicates that at least one of the lens parameters 2448ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * is changing.</p> 2449fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2450fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2451fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #LENS_STATE_STATIONARY STATIONARY}</li> 2452fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #LENS_STATE_MOVING MOVING}</li> 2453fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 24544b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 24554b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 24564b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 24574b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2458ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * 24594b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2460ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureRequest#LENS_APERTURE 2461ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureRequest#LENS_FILTER_DENSITY 2462ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureRequest#LENS_FOCAL_LENGTH 2463ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureRequest#LENS_FOCUS_DISTANCE 2464ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 2465ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 2466ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 2467ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 24685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #LENS_STATE_STATIONARY 24699ea4ae67fb10a10c464db8372b58bfe574cac03dIgor Murashkin * @see #LENS_STATE_MOVING 24705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 24716c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 24725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> LENS_STATE = 24735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.lens.state", int.class); 24745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 24755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2476e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Mode of operation for the noise reduction algorithm.</p> 2477fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The noise reduction algorithm attempts to improve image quality by removing 2478fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * excessive noise added by the capture process, especially in dark conditions. 2479fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * OFF means no noise reduction will be applied by the camera device.</p> 24805f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 24815f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * will be applied. HIGH_QUALITY mode indicates that the camera device 24825f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * will use the highest-quality noise filtering algorithms, 2483e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * even if it slows down capture rate. FAST means the camera device will not 24842807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * slow down capture rate when applying noise filtering.</p> 2485fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2486fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2487fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #NOISE_REDUCTION_MODE_OFF OFF}</li> 2488fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #NOISE_REDUCTION_MODE_FAST FAST}</li> 2489fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #NOISE_REDUCTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2490fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2491fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2492fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}</p> 24934b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 24944b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 24954b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 24964b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 24976dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * 24984b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 24996dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES 25005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_OFF 25015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_FAST 25025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 25035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 25046c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 25055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> NOISE_REDUCTION_MODE = 25065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.noiseReduction.mode", int.class); 25075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 25085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2509ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether a result given to the framework is the 25107a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * final one for the capture, or only a partial that contains a 25117a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * subset of the full set of dynamic metadata 2512ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * values.</p> 2513ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The entries in the result metadata buffers for a 25147a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * single capture may not overlap, except for this entry. The 25157a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * FINAL buffers must retain FIFO ordering relative to the 25167a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * requests that generate them, so the FINAL buffer for frame 3 must 25177a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * always be sent to the framework after the FINAL buffer for frame 2, and 25187a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * before the FINAL buffer for frame 4. PARTIAL buffers may be returned 25197a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * in any order relative to other frames, but all PARTIAL buffers for a given 25207a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * capture must arrive before the FINAL buffer for that capture. This entry may 2521cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * only be used by the camera device if quirks.usePartialResult is set to 1.</p> 2522fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2523fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Optional. Default value is FINAL.</p> 25243242f4fb19b77bcd2435cbe710188d012d08b005Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 25259c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * @deprecated 25267a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala * @hide 25277a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala */ 25289c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin @Deprecated 25297a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala public static final Key<Boolean> QUIRKS_PARTIAL_RESULT = 25307a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala new Key<Boolean>("android.quirks.partialResult", boolean.class); 25317a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala 25327a31310439b8ac6a9dca9e81dd3366221bbb1057Eino-Ville Talvala /** 2533ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>A frame counter set by the framework. This value monotonically 25346bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * increases with every new result (that is, each new result has a unique 2535ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * frameCount value).</p> 2536ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Reset on release()</p> 2537fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: count of frames</p> 2538fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2539fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * > 0</p> 25404b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2541bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin * @deprecated 2542bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin * @hide 25435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 2544bdf366cc70639b0e16b8f84eebe612a48a8b8b06Igor Murashkin @Deprecated 25455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> REQUEST_FRAME_COUNT = 25465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.request.frameCount", int.class); 25475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 25485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2549ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>An application-specified ID for the current 25505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * request. Must be maintained unchanged in output 2551ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * frame</p> 2552fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: arbitrary integer assigned by application</p> 2553fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2554fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Any int</p> 25554b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 25565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @hide 25575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 25585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> REQUEST_ID = 25595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.request.id", int.class); 25605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 25615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2562c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>Specifies the number of pipeline stages the frame went 2563c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * through from when it was exposed to when the final completed result 2564c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * was available to the framework.</p> 2565c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>Depending on what settings are used in the request, and 2566c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * what streams are configured, the data may undergo less processing, 2567c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * and some pipeline stages skipped.</p> 2568c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>See {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} for more details.</p> 2569fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2570fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <= {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth}</p> 25714b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2572c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * 2573c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 2574c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin */ 25756c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2576c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin public static final Key<Byte> REQUEST_PIPELINE_DEPTH = 2577c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin new Key<Byte>("android.request.pipelineDepth", byte.class); 2578c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin 2579c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin /** 2580fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The desired region of the sensor to read out for this capture.</p> 2581fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This control can be used to implement digital zoom.</p> 2582b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The crop region coordinate system is based off 2583b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the 2584b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * top-left corner of the sensor active array.</p> 2585b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Output streams use this rectangle to produce their output, 2586b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * cropping to a smaller region if necessary to maintain the 2587b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * stream's aspect ratio, then scaling the sensor input to 2588b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * match the output's configured resolution.</p> 2589b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The crop region is applied after the RAW to other color 2590b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * space (e.g. YUV) conversion. Since raw streams 2591b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * (e.g. RAW16) don't have the conversion stage, they are not 2592b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * croppable. The crop region will be ignored by raw streams.</p> 25939e6d1880c288d7d0ddcb651dda88d069f058ecedZhijun He * <p>For non-raw streams, any additional per-stream cropping will 25949e6d1880c288d7d0ddcb651dda88d069f058ecedZhijun He * be done to maximize the final pixel area of the stream.</p> 2595ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>For example, if the crop region is set to a 4:3 aspect 2596b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * ratio, then 4:3 streams will use the exact crop 2597b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * region. 16:9 streams will further crop vertically 2598ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * (letterbox).</p> 2599ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Conversely, if the crop region is set to a 16:9, then 4:3 2600b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * outputs will crop horizontally (pillarbox), and 16:9 2601b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * streams will match exactly. These additional crops will 2602ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * be centered within the crop region.</p> 2603b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The width and height of the crop region cannot 2604b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * be set to be smaller than 2605b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <code>floor( activeArraySize.width / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and 2606b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <code>floor( activeArraySize.height / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p> 2607b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The camera device may adjust the crop region to account 2608b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * for rounding and other hardware requirements; the final 2609b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * crop region used will be included in the output capture 2610b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * result.</p> 2611fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Pixel coordinates relative to 2612fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 26134b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 2614d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * 2615d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM 2616b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 26175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 26186c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 26195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 26205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 26215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 26225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2623ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Duration each pixel is exposed to 2624ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * light.</p> 2625fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>If the sensor can't expose this exact duration, it will shorten the 2626fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * duration exposed to the nearest possible value (rather than expose longer). 2627fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * The final exposure time used will be available in the output capture result.</p> 2628fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-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 2629fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2630fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Nanoseconds</p> 2631fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2632fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</p> 26334b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 26344b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 26354b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 26364b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 26374b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * 2638fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_AE_MODE 2639fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 26404b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2641fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE 26425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 26436c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 26445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> SENSOR_EXPOSURE_TIME = 26455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.sensor.exposureTime", long.class); 26465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 26475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2648ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Duration from start of frame exposure to 2649143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * start of next frame exposure.</p> 2650143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The maximum frame rate that can be supported by a camera subsystem is 2651143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * a function of many factors:</p> 2652143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ul> 2653143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Requested resolutions of output image streams</li> 2654143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Availability of binning / skipping modes on the imager</li> 2655143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The bandwidth of the imager interface</li> 2656143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The bandwidth of the various ISP processing blocks</li> 2657143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ul> 2658143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>Since these factors can vary greatly between different ISPs and 2659143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * sensors, the camera abstraction tries to represent the bandwidth 2660143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * restrictions with as simple a model as possible.</p> 2661143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The model presented has the following characteristics:</p> 2662143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ul> 2663143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The image sensor is always configured to output the smallest 2664143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * resolution possible given the application's requested output stream 2665143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * sizes. The smallest resolution is defined as being at least as large 2666143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * as the largest requested output stream size; the camera pipeline must 2667143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * never digitally upsample sensor data when the crop region covers the 2668143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * whole sensor. In general, this means that if only small output stream 2669143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * resolutions are configured, the sensor can provide a higher frame 2670143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * rate.</li> 2671143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Since any request may use any or all the currently configured 2672143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * output streams, the sensor and ISP must be configured to support 2673143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * scaling a single capture to all the streams at the same time. This 2674143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * means the camera pipeline must be ready to produce the largest 2675143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * requested output size without any delay. Therefore, the overall 2676143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * frame rate of a given configured stream set is governed only by the 2677143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * largest requested stream resolution.</li> 2678143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Using more than one output stream in a request does not affect the 2679143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * frame duration.</li> 2680a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Certain format-streams may need to do additional background processing 2681a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * before data is consumed/produced by that stream. These processors 2682a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * can run concurrently to the rest of the camera pipeline, but 2683a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * cannot process more than 1 capture at a time.</li> 2684143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ul> 2685143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The necessary information for the application, given the model above, 26869c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field 26879c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size). 2688143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * These are used to determine the maximum frame rate / minimum frame 2689143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * duration that is possible for a given stream configuration.</p> 2690143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>Specifically, the application can use the following rules to 2691a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * determine the minimum frame duration it can request from the camera 2692143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * device:</p> 2693143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ol> 2694a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Let the set of currently configured input/output streams 2695a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * be called <code>S</code>.</li> 2696a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Find the minimum frame durations for each stream in <code>S</code>, by 26979c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using 26989c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with 2699a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * its respective size/format). Let this set of frame durations be called 2700a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <code>F</code>.</li> 2701a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>For any given request <code>R</code>, the minimum frame duration allowed 2702a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams 2703a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * used in <code>R</code> be called <code>S_r</code>.</li> 2704143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ol> 2705a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>If none of the streams in <code>S_r</code> have a stall time (listed in 27069c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * StreamConfigurationMap#getOutputStallDuration(int,Size) using its 27079c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * respective size/format), then the frame duration in 2708a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <code>F</code> determines the steady state frame rate that the application will 2709a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * get if it uses <code>R</code> as a repeating request. Let this special kind 2710a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * of request be called <code>Rsimple</code>.</p> 2711a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved 2712a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * by a single capture of a new request <code>Rstall</code> (which has at least 2713a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the 2714a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * same minimum frame duration this will not cause a frame rate loss 2715a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * if all buffers from the previous <code>Rstall</code> have already been 2716a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * delivered.</p> 2717a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>For more details about stalling, see 27189c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * StreamConfigurationMap#getOutputStallDuration(int,Size).</p> 2719fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-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 2720fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2721fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Nanoseconds</p> 2722fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2723fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * See {@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}, 2724fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}. The duration 2725fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * is capped to <code>max(duration, exposureTime + overhead)</code>.</p> 27264b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 27274b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 27284b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 27294b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2730143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * 2731fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_AE_MODE 2732fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 27334b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 27349c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP 2735fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION 27365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 27376c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 27385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> SENSOR_FRAME_DURATION = 27395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.sensor.frameDuration", long.class); 27405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 27415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2742b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The amount of gain applied to sensor data 2743b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * before processing.</p> 2744b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The sensitivity is the standard ISO sensitivity value, 2745b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * as defined in ISO 12232:2006.</p> 2746b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The sensitivity must be within {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}, and 2747b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * if if it less than {@link CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY android.sensor.maxAnalogSensitivity}, the camera device 2748b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * is guaranteed to use only analog amplification for applying the gain.</p> 2749b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>If the camera device cannot apply the exact sensitivity 2750b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * requested, it will reduce the gain to the nearest supported 2751b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * value. The final sensitivity used will be available in the 2752b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * output capture result.</p> 2753fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: ISO arithmetic units</p> 2754fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2755fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p> 27564b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 27574b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 27584b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 27594b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2760b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * 27614b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2762b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE 2763b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY 27645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 27656c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 27665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> SENSOR_SENSITIVITY = 27675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.sensor.sensitivity", int.class); 27685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 27695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 2770ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Time at start of exposure of first 27710bda31afe06a05144a31ce47adbc54694ec24228Zhijun He * row of the image sensor active array, in nanoseconds.</p> 2772b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The timestamps are also included in all image 2773b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * buffers produced for the same capture, and will be identical 277445fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * on all the outputs.</p> 2775abd9d3c5c7100c45812ee80975ac59f5b1902a71Eino-Ville Talvala * <p>When {@link CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE android.sensor.info.timestampSource} <code>==</code> UNKNOWN, 277645fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * the timestamps measure time since an unspecified starting point, 277745fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * and are monotonically increasing. They can be compared with the 277845fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * timestamps for other captures from the same camera device, but are 277945fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * not guaranteed to be comparable to any other time source.</p> 2780abd9d3c5c7100c45812ee80975ac59f5b1902a71Eino-Ville Talvala * <p>When {@link CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE android.sensor.info.timestampSource} <code>==</code> REALTIME, 278145fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * the timestamps measure time in the same timebase as 278245fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * android.os.SystemClock#elapsedRealtimeNanos(), and they can be 278345fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * compared to other timestamps from other subsystems that are using 278445fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * that base.</p> 2785fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Nanoseconds</p> 2786fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2787fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * > 0</p> 27884b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 278945fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * 2790abd9d3c5c7100c45812ee80975ac59f5b1902a71Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE 27915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 27926c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 27935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> SENSOR_TIMESTAMP = 27945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.sensor.timestamp", long.class); 27955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 27965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 27977c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * <p>The estimated camera neutral color in the native sensor colorspace at 27987c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * the time of capture.</p> 27997c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * <p>This value gives the neutral color point encoded as an RGB value in the 28007c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * native sensor color space. The neutral color point indicates the 28017c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * currently estimated white point of the scene illumination. It can be 28027c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * used to interpolate between the provided color transforms when 28037c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * processing raw sensor data.</p> 28047c062369d55ad6f6f0c9c3bd8439c50cbfb88f42Ruben Brunk * <p>The order of the values is R, G, B; where R is in the lowest index.</p> 280520c76f67585172684729d701586a4a294d67f0a1Ruben Brunk * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 280620c76f67585172684729d701586a4a294d67f0a1Ruben Brunk */ 28076c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 280820c76f67585172684729d701586a4a294d67f0a1Ruben Brunk public static final Key<Rational[]> SENSOR_NEUTRAL_COLOR_POINT = 280920c76f67585172684729d701586a4a294d67f0a1Ruben Brunk new Key<Rational[]>("android.sensor.neutralColorPoint", Rational[].class); 281020c76f67585172684729d701586a4a294d67f0a1Ruben Brunk 281120c76f67585172684729d701586a4a294d67f0a1Ruben Brunk /** 28121b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * <p>Noise model coefficients for each CFA mosaic channel.</p> 2813fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key contains two noise model coefficients for each CFA channel 28141b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * corresponding to the sensor amplification (S) and sensor readout 28151b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * noise (O). These are given as pairs of coefficients for each channel 2816fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * in the same order as channels listed for the CFA layout key 28171b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * (see {@link CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT android.sensor.info.colorFilterArrangement}). This is 28181b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * represented as an array of Pair<Double, Double>, where 28191b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * the first member of the Pair at index n is the S coefficient and the 28201b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * second member is the O coefficient for the nth color channel in the CFA.</p> 28211b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * <p>These coefficients are used in a two parameter noise model to describe 28221b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * the amount of noise present in the image for each CFA channel. The 28231b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * noise model used here is:</p> 28241b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * <p>N(x) = sqrt(Sx + O)</p> 28251b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * <p>Where x represents the recorded signal of a CFA channel normalized to 28261b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * the range [0, 1], and S and O are the noise model coeffiecients for 28271b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * that channel.</p> 28281b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * <p>A more detailed description of the noise model can be found in the 28291b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * Adobe DNG specification for the NoiseProfile tag.</p> 28301b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 28311b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * 28321b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT 28331b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk */ 28341b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk @PublicKey 28351b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk public static final Key<android.util.Pair<Double,Double>[]> SENSOR_NOISE_PROFILE = 28361b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk new Key<android.util.Pair<Double,Double>[]>("android.sensor.noiseProfile", new TypeReference<android.util.Pair<Double,Double>[]>() {{ }}); 28371b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk 28381b1f1b611c8e648b9737e7930e6982cf117134ceRuben Brunk /** 2839987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <p>The worst-case divergence between Bayer green channels.</p> 2840987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <p>This value is an estimate of the worst case split between the 2841987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * Bayer green channels in the red and blue rows in the sensor color 2842987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * filter array.</p> 2843987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <p>The green split is calculated as follows:</p> 2844987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <ol> 2845e89b120eae1206dfff9abbb43d0075c23a5672ccRuben Brunk * <li>A 5x5 pixel (or larger) window W within the active sensor array is 2846e89b120eae1206dfff9abbb43d0075c23a5672ccRuben Brunk * chosen. The term 'pixel' here is taken to mean a group of 4 Bayer 2847e89b120eae1206dfff9abbb43d0075c23a5672ccRuben Brunk * mosaic channels (R, Gr, Gb, B). The location and size of the window 2848e89b120eae1206dfff9abbb43d0075c23a5672ccRuben Brunk * chosen is implementation defined, and should be chosen to provide a 2849e89b120eae1206dfff9abbb43d0075c23a5672ccRuben Brunk * green split estimate that is both representative of the entire image 2850e89b120eae1206dfff9abbb43d0075c23a5672ccRuben Brunk * for this camera sensor, and can be calculated quickly.</li> 2851987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <li>The arithmetic mean of the green channels from the red 2852987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * rows (mean_Gr) within W is computed.</li> 2853987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <li>The arithmetic mean of the green channels from the blue 2854987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * rows (mean_Gb) within W is computed.</li> 2855987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <li>The maximum ratio R of the two means is computed as follows: 2856987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <code>R = max((mean_Gr + 1)/(mean_Gb + 1), (mean_Gb + 1)/(mean_Gr + 1))</code></li> 2857987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * </ol> 2858987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <p>The ratio R is the green split divergence reported for this property, 2859987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * which represents how much the green channels differ in the mosaic 2860987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * pattern. This value is typically used to determine the treatment of 2861987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * the green mosaic channels when demosaicing.</p> 2862987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <p>The green split value can be roughly interpreted as follows:</p> 2863987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <ul> 2864987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <li>R < 1.03 is a negligible split (<3% divergence).</li> 2865987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <li>1.20 <= R >= 1.03 will require some software 2866987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * correction to avoid demosaic errors (3-20% divergence).</li> 2867987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <li>R > 1.20 will require strong software correction to produce 2868987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * a usuable image (>20% divergence).</li> 2869987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * </ul> 2870fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br></p> 2871fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>>= 0</p> 2872987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2873987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk */ 28746c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2875987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk public static final Key<Float> SENSOR_GREEN_SPLIT = 2876987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk new Key<Float>("android.sensor.greenSplit", float.class); 2877987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk 2878987d9f7a6b077f1f548897a6d658f61bac6860e4Ruben Brunk /** 2879379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern 2880379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> 2881379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Each color channel is treated as an unsigned 32-bit integer. 2882379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * The camera device then uses the most significant X bits 2883379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * that correspond to how many bits are in its Bayer raw sensor 2884379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * output.</p> 2885379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>For example, a sensor with RAW10 Bayer output would use the 2886379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 10 most significant bits from each color channel.</p> 2887379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2888379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * 2889379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE 2890379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 28916c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2892379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<int[]> SENSOR_TEST_PATTERN_DATA = 2893379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<int[]>("android.sensor.testPatternData", int[].class); 2894379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 2895379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 2896c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>When enabled, the sensor sends a test pattern instead of 2897c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * doing a real exposure from the camera.</p> 2898c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>When a test pattern is enabled, all manual sensor controls specified 2899e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * by android.sensor.* will be ignored. All other controls should 2900c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * work as normal.</p> 2901c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>For example, if manual flash is enabled, flash firing should still 2902c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * occur (and that the test pattern remain unmodified, since the flash 2903c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * would not actually affect it).</p> 2904fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Defaults to OFF.</p> 2905fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2906fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2907fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_OFF OFF}</li> 2908fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR SOLID_COLOR}</li> 2909fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS COLOR_BARS}</li> 2910fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY COLOR_BARS_FADE_TO_GRAY}</li> 2911fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_PN9 PN9}</li> 2912fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SENSOR_TEST_PATTERN_MODE_CUSTOM1 CUSTOM1}</li> 2913fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 2914fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 2915fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES android.sensor.availableTestPatternModes}</p> 2916c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2917fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 2918fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES 2919c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_OFF 2920c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 2921c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 2922c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 2923c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_PN9 2924c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 2925c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin */ 29266c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 2927c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 2928c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin new Key<Integer>("android.sensor.testPatternMode", int.class); 2929c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin 2930c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin /** 29310bda31afe06a05144a31ce47adbc54694ec24228Zhijun He * <p>Duration between the start of first row exposure 29320bda31afe06a05144a31ce47adbc54694ec24228Zhijun He * and the start of last row exposure.</p> 2933fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This is the exposure time skew between the first and last 2934fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * row exposure start times. The first row and the last row are 2935fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the first and last rows inside of the 2936fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p> 29370bda31afe06a05144a31ce47adbc54694ec24228Zhijun He * <p>For typical camera sensors that use rolling shutters, this is also equivalent 29380bda31afe06a05144a31ce47adbc54694ec24228Zhijun He * to the frame readout time.</p> 2939fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Units</b>: Nanoseconds</p> 2940fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 2941fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * >= 0 and < 2942fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * StreamConfigurationMap#getOutputMinFrameDuration(int, Size).</p> 29434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 29444b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Limited capability</b> - 29454b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 29464b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 29470bda31afe06a05144a31ce47adbc54694ec24228Zhijun He * 29484b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 29490bda31afe06a05144a31ce47adbc54694ec24228Zhijun He * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 29500bda31afe06a05144a31ce47adbc54694ec24228Zhijun He */ 29516c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 29520bda31afe06a05144a31ce47adbc54694ec24228Zhijun He public static final Key<Long> SENSOR_ROLLING_SHUTTER_SKEW = 29530bda31afe06a05144a31ce47adbc54694ec24228Zhijun He new Key<Long>("android.sensor.rollingShutterSkew", long.class); 29540bda31afe06a05144a31ce47adbc54694ec24228Zhijun He 29550bda31afe06a05144a31ce47adbc54694ec24228Zhijun He /** 2956ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <p>Quality of lens shading correction applied 2957ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * to the image data.</p> 2958ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <p>When set to OFF mode, no lens shading correction will be applied by the 2959ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * camera device, and an identity lens shading map data will be provided 2960ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 2961fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * shading map with size of <code>[ 4, 3 ]</code>, 2962fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the output {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap} for this case will be an identity 2963fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * map shown below:</p> 2964ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2965fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2966fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2967fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2968fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2969fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 2970ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * </code></pre> 2971fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>When set to other modes, lens shading correction will be applied by the camera 2972fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * device. Applications can request lens shading map data by setting 2973fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide lens 2974fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap}; the returned shading map 2975fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * data will be the one applied by the camera device for this capture request.</p> 2976fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore 2977fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * the reliability of the map data may be affected by the AE and AWB algorithms. When AE and 2978fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-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> 2979fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * OFF), to get best results, it is recommended that the applications wait for the AE and AWB 2980fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * to be converged before using the returned shading map data.</p> 2981fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 2982fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 2983fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SHADING_MODE_OFF OFF}</li> 2984fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SHADING_MODE_FAST FAST}</li> 2985fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SHADING_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2986fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 29874b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 29884b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 29894b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 29904b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2991ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 2992fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 2993fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * @see CaptureRequest#CONTROL_AWB_MODE 29944b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2995fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP 2996ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 2997ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_OFF 2998ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_FAST 2999ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_HIGH_QUALITY 3000ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He */ 30016c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 3002ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He public static final Key<Integer> SHADING_MODE = 3003ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He new Key<Integer>("android.shading.mode", int.class); 3004ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He 3005ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He /** 3006fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Operating mode for the face detector 3007b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * unit.</p> 3008ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether face detection is enabled, and whether it 30095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * should output just the basic fields or the full set of 3010fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * fields.</p> 3011fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 3012fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 3013fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_FACE_DETECT_MODE_OFF OFF}</li> 3014fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_FACE_DETECT_MODE_SIMPLE SIMPLE}</li> 3015fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_FACE_DETECT_MODE_FULL FULL}</li> 3016fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 3017fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 3018fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}</p> 3019fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>This key is available on all devices.</p> 30200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 30210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 30225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_OFF 30235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 30245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_FULL 30255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 30266c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 30275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 30285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.statistics.faceDetectMode", int.class); 30295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 30305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3031e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>List of unique IDs for detected faces.</p> 3032e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Each detected face is given a unique ID that is valid for as long as the face is visible 3033e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * to the camera device. A face that leaves the field of view and later returns may be 3034e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * assigned a new ID.</p> 30354b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} == FULL 30364b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * This key is available on all devices.</p> 3037e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 3038e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 30397f80d6f74125b25a23622719d27cb1cf0c6194f6Zhijun He * @hide 30405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 30415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<int[]> STATISTICS_FACE_IDS = 30425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<int[]>("android.statistics.faceIds", int[].class); 30435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 30445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3045ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>List of landmarks for detected 3046e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * faces.</p> 3047e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>The coordinate system is that of {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with 3048e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <code>(0, 0)</code> being the top-left pixel of the active array.</p> 30494b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} == FULL 30504b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * This key is available on all devices.</p> 3051e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 3052e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 3053e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 30547f80d6f74125b25a23622719d27cb1cf0c6194f6Zhijun He * @hide 30555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 30565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<int[]> STATISTICS_FACE_LANDMARKS = 30575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<int[]>("android.statistics.faceLandmarks", int[].class); 30585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 30595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3060ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>List of the bounding rectangles for detected 3061e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * faces.</p> 3062e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>The coordinate system is that of {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with 3063e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <code>(0, 0)</code> being the top-left pixel of the active array.</p> 30644b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} != OFF 30654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * This key is available on all devices.</p> 3066e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 3067e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 3068e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 30697f80d6f74125b25a23622719d27cb1cf0c6194f6Zhijun He * @hide 30705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 30715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<android.graphics.Rect[]> STATISTICS_FACE_RECTANGLES = 30725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<android.graphics.Rect[]>("android.statistics.faceRectangles", android.graphics.Rect[].class); 30735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 30745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3075ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>List of the face confidence scores for 3076ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * detected faces</p> 3077e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} != OFF.</p> 3078fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 3079fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1-100</p> 30804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 3081e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 3082e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 30837f80d6f74125b25a23622719d27cb1cf0c6194f6Zhijun He * @hide 30845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 30855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<byte[]> STATISTICS_FACE_SCORES = 30865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<byte[]>("android.statistics.faceScores", byte[].class); 30875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 30885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 308972f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin * <p>List of the faces detected through camera face detection 3090fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * in this capture.</p> 309172f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} <code>!=</code> OFF.</p> 30924b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 309372f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin * 309472f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 309572f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin */ 30966c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 30976c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @SyntheticKey 309872f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin public static final Key<android.hardware.camera2.params.Face[]> STATISTICS_FACES = 309972f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin new Key<android.hardware.camera2.params.Face[]>("android.statistics.faces", android.hardware.camera2.params.Face[].class); 310072f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin 310172f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin /** 31027a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>The shading map is a low-resolution floating-point map 31037a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * that lists the coefficients used to correct for vignetting, for each 31047a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * Bayer color channel.</p> 31057a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>The least shaded section of the image should have a gain factor 31067a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * of 1; all other sections should have gains above 1.</p> 31070da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 3108ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * must take into account the colorCorrection settings.</p> 31097a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>The shading map is for the entire active pixel array, and is not 31107a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * affected by the crop region specified in the request. Each shading map 31117a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * entry is the value of the shading compensation map over a specific 31127a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * pixel on the sensor. Specifically, with a (N x M) resolution shading 31137a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * map, and an active pixel array size (W x H), shading map entry 31147a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 31157a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 31167a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * The map is assumed to be bilinearly interpolated between the sample points.</p> 31177a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 31187a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 3119574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * The shading map is stored in a fully interleaved format.</p> 3120574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>The shading map should have on the order of 30-40 rows and columns, 3121574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * and must be smaller than 64x64.</p> 3122574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>As an example, given a very small map defined as:</p> 3123574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <pre><code>width,height = [ 4, 3 ] 3124574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * values = 3125574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 3126fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 3127fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 3128fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 3129fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 3130fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 3131574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * </code></pre> 3132574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>The low-resolution scaling map images for each channel are 3133574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * (displayed using nearest-neighbor interpolation):</p> 3134574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 3135574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 3136574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 3137574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 3138574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>As a visualization only, inverting the full-color map to recover an 3139574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 3140574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 3141fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 3142fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Each gain factor is >= 1</p> 31434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 31444b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 31454b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 31464b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3147574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * 3148574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @see CaptureRequest#COLOR_CORRECTION_MODE 31494b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3150574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk */ 31516c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 3152574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk public static final Key<android.hardware.camera2.params.LensShadingMap> STATISTICS_LENS_SHADING_CORRECTION_MAP = 3153574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk new Key<android.hardware.camera2.params.LensShadingMap>("android.statistics.lensShadingCorrectionMap", android.hardware.camera2.params.LensShadingMap.class); 3154574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk 3155574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk /** 3156574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>The shading map is a low-resolution floating-point map 3157574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * that lists the coefficients used to correct for vignetting, for each 3158574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * Bayer color channel.</p> 3159574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>The least shaded section of the image should have a gain factor 3160574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * of 1; all other sections should have gains above 1.</p> 3161574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 3162574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * must take into account the colorCorrection settings.</p> 3163574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>The shading map is for the entire active pixel array, and is not 3164574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * affected by the crop region specified in the request. Each shading map 3165574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * entry is the value of the shading compensation map over a specific 3166574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * pixel on the sensor. Specifically, with a (N x M) resolution shading 3167574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * map, and an active pixel array size (W x H), shading map entry 3168574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 3169574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 3170574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * The map is assumed to be bilinearly interpolated between the sample points.</p> 3171574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 3172574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 31737a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * The shading map is stored in a fully interleaved format, and its size 3174574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * is provided in the camera static metadata by android.lens.info.shadingMapSize.</p> 31757a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>The shading map should have on the order of 30-40 rows and columns, 31767a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * and must be smaller than 64x64.</p> 31777a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>As an example, given a very small map defined as:</p> 3178574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <pre><code>android.lens.info.shadingMapSize = [ 4, 3 ] 3179574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * android.statistics.lensShadingMap = 31807a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 3181fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 3182fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 3183fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 3184fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 3185fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 31867a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * </code></pre> 31877a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>The low-resolution scaling map images for each channel are 31887a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * (displayed using nearest-neighbor interpolation):</p> 31897a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 31907a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 31917a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 31927a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 31937a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p>As a visualization only, inverting the full-color map to recover an 31947a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 31957a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 3196fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 3197fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Each gain factor is >= 1</p> 31984b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 31994b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 32004b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 32014b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 32020da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 32035f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#COLOR_CORRECTION_MODE 32044b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3205574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 32065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 32075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<float[]> STATISTICS_LENS_SHADING_MAP = 32085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<float[]>("android.statistics.lensShadingMap", float[].class); 32095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 32105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3211ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The best-fit color channel gains calculated 3212cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * by the camera device's statistics units for the current output frame.</p> 3213ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This may be different than the gains used for this frame, 32145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * since statistics processing on data from a new frame 32155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * typically completes after the transform has already been 3216ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * applied to that frame.</p> 3217ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The 4 channel gains are defined in Bayer domain, 32180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * see {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} for details.</p> 3219b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>This value should always be calculated by the auto-white balance (AWB) block, 3220ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * regardless of the android.control.* current values.</p> 3221aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 32220da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 32230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_GAINS 32249c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * @deprecated 3225aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @hide 32265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 32279c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin @Deprecated 32285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<float[]> STATISTICS_PREDICTED_COLOR_GAINS = 32295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<float[]>("android.statistics.predictedColorGains", float[].class); 32305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 32315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3232ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The best-fit color transform matrix estimate 3233cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * calculated by the camera device's statistics units for the current 3234cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * output frame.</p> 3235cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * <p>The camera device will provide the estimate from its 32365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * statistics unit on the white balance transforms to use 3237cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * for the next frame. These are the values the camera device believes 32385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * are the best fit for the current output frame. This may 32395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * be different than the transform used for this frame, since 32405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * statistics processing on data from a new frame typically 32415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * completes after the transform has already been applied to 3242ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * that frame.</p> 3243ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>These estimates must be provided for all frames, even if 3244ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * capture settings and color transforms are set by the application.</p> 3245b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>This value should always be calculated by the auto-white balance (AWB) block, 3246ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * regardless of the android.control.* current values.</p> 3247aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 32489c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * @deprecated 3249aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @hide 32505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 32519c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin @Deprecated 32525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Rational[]> STATISTICS_PREDICTED_COLOR_TRANSFORM = 32535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Rational[]>("android.statistics.predictedColorTransform", Rational[].class); 32545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 32555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3256208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * <p>The camera device estimated scene illumination lighting 3257208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * frequency.</p> 3258208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * <p>Many light sources, such as most fluorescent lights, flicker at a rate 3259208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * that depends on the local utility power standards. This flicker must be 3260208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * accounted for by auto-exposure routines to avoid artifacts in captured images. 3261208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * The camera device uses this entry to tell the application what the scene 3262208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * illuminant frequency is.</p> 3263208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * <p>When manual exposure control is enabled 3264e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * (<code>{@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} == OFF</code> or <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == 3265e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * OFF</code>), the {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} doesn't perform 3266e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * antibanding, and the application can ensure it selects 3267e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * exposure times that do not cause banding issues by looking 3268e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * into this metadata field. See 3269e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} for more details.</p> 3270e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Reports NONE if there doesn't appear to be flickering illumination.</p> 3271fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 3272fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 3273fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_SCENE_FLICKER_NONE NONE}</li> 3274fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_SCENE_FLICKER_50HZ 50HZ}</li> 3275fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_SCENE_FLICKER_60HZ 60HZ}</li> 3276fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 32774b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 32784b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 32794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 32804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3281208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * 3282208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE 3283208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 3284208fb6c321acb7bcc3b666633e1ada03d2799cb0Zhijun He * @see CaptureRequest#CONTROL_MODE 32854b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 32865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_SCENE_FLICKER_NONE 32875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_SCENE_FLICKER_50HZ 32885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_SCENE_FLICKER_60HZ 32895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 32906c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 32915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> STATISTICS_SCENE_FLICKER = 32925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.statistics.sceneFlicker", int.class); 32935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 32945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3295fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>Operating mode for hot pixel map generation.</p> 3296fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-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}. 3297fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * If set to <code>false</code>, no hot pixel map will be returned.</p> 3298fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 3299fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}</p> 33004b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 33019d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * 33029d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP 33039d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES 33049d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk */ 33056c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 33069d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE = 33079d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class); 33089d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk 33099d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk /** 33109d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * <p>List of <code>(x, y)</code> coordinates of hot/defective pixels on the sensor.</p> 33119d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * <p>A coordinate <code>(x, y)</code> must lie between <code>(0, 0)</code>, and 33129d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * <code>(width - 1, height - 1)</code> (inclusive), which are the top-left and 33139d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * bottom-right of the pixel array, respectively. The width and 33149d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * height dimensions are given in {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}. 33159d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * This may include hot pixels that lie outside of the active array 33169d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * bounds given by {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p> 3317fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br></p> 3318fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>n <= number of pixels on the sensor. 3319fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * The <code>(x, y)</code> coordinates must be bounded by 3320fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.</p> 33214b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 33229d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * 33239d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 33249d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE 33259d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk */ 33266c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 33278490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh public static final Key<android.graphics.Point[]> STATISTICS_HOT_PIXEL_MAP = 33288490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh new Key<android.graphics.Point[]>("android.statistics.hotPixelMap", android.graphics.Point[].class); 33299d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk 33309d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk /** 3331379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>Whether the camera device will output the lens 3332379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * shading map in output result metadata.</p> 3333379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * <p>When set to ON, 3334e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * android.statistics.lensShadingMap will be provided in 3335379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * the output result metadata.</p> 3336fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>ON is always supported on devices with the RAW capability.</p> 3337fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 3338fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 3339fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_OFF OFF}</li> 3340fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_ON ON}</li> 3341fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 33424b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 33434b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 33444b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 33454b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 33464b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * 33474b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3348379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF 3349379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON 3350379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He */ 33516c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 3352379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE = 3353379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He new Key<Integer>("android.statistics.lensShadingMapMode", int.class); 3354379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He 3355379af01292ecf4a46a465c48a7da55a68c0a9f49Zhijun He /** 3356ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the blue 3357e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3358e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 33598490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>See android.tonemap.curveRed for more details.</p> 33604b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 33614b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 33624b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 33634b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 33640da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 33654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 33665f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#TONEMAP_MODE 33678490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 33685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 33693ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He public static final Key<float[]> TONEMAP_CURVE_BLUE = 33703ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He new Key<float[]>("android.tonemap.curveBlue", float[].class); 33715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 33725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3373ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the green 3374e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3375e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 33768490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>See android.tonemap.curveRed for more details.</p> 33774b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 33784b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 33794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 33804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 33810da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 33824b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 33835f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#TONEMAP_MODE 33848490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 33855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 33863ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He public static final Key<float[]> TONEMAP_CURVE_GREEN = 33873ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He new Key<float[]>("android.tonemap.curveGreen", float[].class); 33885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 33895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3390ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the red 3391e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3392e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 3393e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Each channel's curve is defined by an array of control points:</p> 33948490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = 3395fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 3396870922be2399766078d0a4e42a0158ecb9eb1f86Zhijun He * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 3397fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p>These are sorted in order of increasing <code>Pin</code>; it is 3398fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * required that input values 0.0 and 1.0 are included in the list to 3399e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * define a complete mapping. For input values between control points, 3400e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * the camera device must linearly interpolate between the control 3401e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * points.</p> 3402e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Each curve can have an independent number of points, and the number 3403e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * of points can be less than max (that is, the request doesn't have to 3404e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * always provide a curve with number of points equivalent to 3405e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 3406e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>A few examples, and their corresponding graphical mappings; these 3407e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * only specify the red channel and the precision is limited to 4 3408e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * digits, for conciseness.</p> 3409e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Linear mapping:</p> 34108490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] 3411e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 3412e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 3413e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Invert mapping:</p> 34148490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] 3415e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 3416e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 3417e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 34188490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 3419fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 3420fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 3421fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 3422fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 3423e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 3424e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 3425e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 34268490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 3427fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 3428fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 3429fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 3430fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 3431e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 3432e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 3433fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Range of valid values:</b><br> 3434fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * 0-1 on both input and output coordinates, normalized 3435fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * as a floating-point value such that 0 == black and 1 == white.</p> 34364b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 34374b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 34384b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 34394b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 34400da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 34414b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3442e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 34430da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#TONEMAP_MODE 34448490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 34455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 34465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<float[]> TONEMAP_CURVE_RED = 34475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<float[]>("android.tonemap.curveRed", float[].class); 34485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 34495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 34508490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} 34518490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * is CONTRAST_CURVE.</p> 34528490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>The tonemapCurve consist of three curves for each of red, green, and blue 34538490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * channels respectively. The following example uses the red channel as an 34548490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * example. The same logic applies to green and blue channel. 34558490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * Each channel's curve is defined by an array of control points:</p> 34568490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = 3457fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 34588490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 34598490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>These are sorted in order of increasing <code>Pin</code>; it is always 34608490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * guaranteed that input values 0.0 and 1.0 are included in the list to 34618490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * define a complete mapping. For input values between control points, 34628490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * the camera device must linearly interpolate between the control 34638490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * points.</p> 34648490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Each curve can have an independent number of points, and the number 34658490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * of points can be less than max (that is, the request doesn't have to 34668490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * always provide a curve with number of points equivalent to 34678490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 34688490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>A few examples, and their corresponding graphical mappings; these 34698490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * only specify the red channel and the precision is limited to 4 34708490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * digits, for conciseness.</p> 34718490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Linear mapping:</p> 34728490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] 34738490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 34748490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 34758490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Invert mapping:</p> 34768490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] 34778490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 34788490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 34798490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 34808490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ 3481fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), 3482fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), 3483fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), 3484fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] 34858490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 34868490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 34878490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 34888490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ 3489fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), 3490fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), 3491fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), 3492fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] 34938490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 34948490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 34954b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 34964b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 34974b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 34984b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 34998490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * 35004b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 35018490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 35028490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CaptureRequest#TONEMAP_MODE 35038490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh */ 35046c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 35056c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @SyntheticKey 35068490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE = 35078490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class); 35088490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh 35098490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh /** 3510e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>High-level global contrast/gamma/tonemapping control.</p> 3511e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>When switching to an application-defined contrast curve by setting 3512e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 3513e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * per-channel with a set of <code>(in, out)</code> points that specify the 3514e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * mapping from input high-bit-depth pixel value to the output 3515e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * low-bit-depth value. Since the actual pixel ranges of both input 3516e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * and output may change depending on the camera pipeline, the values 3517e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * are specified by normalized floating-point numbers.</p> 3518e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>More-complex color mapping operations such as 3D color look-up 3519e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * tables, selective chroma enhancement, or other non-linear color 3520e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3521e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 3522e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>When using either FAST or HIGH_QUALITY, the camera device will 35238490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. 3524e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * These values are always available, and as close as possible to the 3525e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * actually used nonlinear/nonglobal transforms.</p> 3526fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * <p>If a request is sent with CONTRAST_CURVE with the camera device's 3527e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 3528e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * roughly the same.</p> 3529fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 3530fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 3531fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #TONEMAP_MODE_CONTRAST_CURVE CONTRAST_CURVE}</li> 3532fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #TONEMAP_MODE_FAST FAST}</li> 3533fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #TONEMAP_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 3534fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 3535fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 3536fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}</p> 35374b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 35384b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 35394b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 35404b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 35413242f4fb19b77bcd2435cbe710188d012d08b005Igor Murashkin * 35424b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 35436dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES 35448490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CaptureRequest#TONEMAP_CURVE 3545e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * @see CaptureRequest#TONEMAP_MODE 35465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_CONTRAST_CURVE 35475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_FAST 35485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_HIGH_QUALITY 35495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 35506c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 35515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> TONEMAP_MODE = 35525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.tonemap.mode", int.class); 35535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 35545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3555ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This LED is nominally used to indicate to the user 35565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * that the camera is powered on and may be streaming images back to the 35575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * Application Processor. In certain rare circumstances, the OS may 35585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * disable this when video is processed locally and not transmitted to 3559ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * any untrusted applications.</p> 3560ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>In particular, the LED <em>must</em> always be on when the data could be 3561ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * transmitted off the device. The LED <em>should</em> always be on whenever 3562ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * data is stored locally on the device.</p> 3563ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The LED <em>may</em> be off if a trusted application is using the data that 3564ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * doesn't violate the above rules.</p> 35654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 35665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @hide 35675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 35685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> LED_TRANSMIT = 35695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.led.transmit", boolean.class); 35705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 35715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 3572ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether black-level compensation is locked 35730956af56a294397325f2695604229ab7550364caEino-Ville Talvala * to its current values, or is free to vary.</p> 35740956af56a294397325f2695604229ab7550364caEino-Ville Talvala * <p>Whether the black level offset was locked for this frame. Should be 35750da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ON if {@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock} was ON in the capture request, unless 35760956af56a294397325f2695604229ab7550364caEino-Ville Talvala * a change in other capture settings forced the camera device to 35770956af56a294397325f2695604229ab7550364caEino-Ville Talvala * perform a black level reset.</p> 35784b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 35794b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p><b>Full capability</b> - 35804b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 35814b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 35820da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 35830da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#BLACK_LEVEL_LOCK 35844b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 35855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 35866c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 35875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> BLACK_LEVEL_LOCK = 35885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.blackLevel.lock", boolean.class); 35895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 35903865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin /** 35913865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>The frame number corresponding to the last request 35923865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * with which the output result (metadata + buffers) has been fully 35933865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * synchronized.</p> 35943865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>When a request is submitted to the camera device, there is usually a 35953865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * delay of several frames before the controls get applied. A camera 35963865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * device may either choose to account for this delay by implementing a 35973865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * pipeline and carefully submit well-timed atomic control updates, or 35983865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * it may start streaming control changes that span over several frame 35993865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * boundaries.</p> 36003865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>In the latter case, whenever a request's settings change relative to 36013865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * the previous submitted request, the full set of changes may take 36023865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * multiple frame durations to fully take effect. Some settings may 36033865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * take effect sooner (in less frame durations) than others.</p> 36043865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>While a set of control changes are being propagated, this value 36053865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * will be CONVERGING.</p> 36063865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>Once it is fully known that a set of control changes have been 36073865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * finished propagating, and the resulting updated control settings 36083865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * have been read back by the camera device, this value will be set 36093865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * to a non-negative frame number (corresponding to the request to 36103865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * which the results have synchronized to).</p> 36113865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>Older camera device implementations may not have a way to detect 36123865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * when all camera controls have been applied, and will always set this 36133865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * value to UNKNOWN.</p> 36143865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>FULL capability devices will always have this value set to the 36153865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * frame number of the request corresponding to this result.</p> 36163865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p><em>Further details</em>:</p> 36173865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <ul> 36183865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <li>Whenever a request differs from the last request, any future 36193865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * results not yet returned may have this value set to CONVERGING (this 36203865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * could include any in-progress captures not yet returned by the camera 36213865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * device, for more details see pipeline considerations below).</li> 36223865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <li>Submitting a series of multiple requests that differ from the 36233865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * previous request (e.g. r1, r2, r3 s.t. r1 != r2 != r3) 36243865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * moves the new synchronization frame to the last non-repeating 36253865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * request (using the smallest frame number from the contiguous list of 36263865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * repeating requests).</li> 36273865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <li>Submitting the same request repeatedly will not change this value 36283865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * to CONVERGING, if it was already a non-negative value.</li> 36293865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <li>When this value changes to non-negative, that means that all of the 36303865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * metadata controls from the request have been applied, all of the 36313865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * metadata controls from the camera device have been read to the 36323865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * updated values (into the result), and all of the graphics buffers 36333865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * corresponding to this result are also synchronized to the request.</li> 36343865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * </ul> 36353865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p><em>Pipeline considerations</em>:</p> 36363865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>Submitting a request with updated controls relative to the previously 36373865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * submitted requests may also invalidate the synchronization state 36383865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * of all the results corresponding to currently in-flight requests.</p> 36393865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * <p>In other words, results for this current request and up to 36403865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} prior requests may have their 36413865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * android.sync.frameNumber change to CONVERGING.</p> 3642fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Possible values:</b> 3643fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <ul> 3644fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SYNC_FRAME_NUMBER_CONVERGING CONVERGING}</li> 3645fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <li>{@link #SYNC_FRAME_NUMBER_UNKNOWN UNKNOWN}</li> 3646fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * </ul></p> 3647fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <p><b>Available values for this device:</b><br> 3648fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * Either a non-negative value corresponding to a 3649fd3e2892f29ded5a25a0a064275b282ce93ed258Eino-Ville Talvala * <code>frame_number</code>, or one of the two enums (CONVERGING / UNKNOWN).</p> 36504b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin * <p>This key is available on all devices.</p> 36513865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * 36523865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 36533865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * @see #SYNC_FRAME_NUMBER_CONVERGING 36543865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * @see #SYNC_FRAME_NUMBER_UNKNOWN 36553865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin * @hide 36563865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin */ 36574f91e2a45990b9bfb9e05fb3e7600c44450d4be5Zhijun He public static final Key<Long> SYNC_FRAME_NUMBER = 36584f91e2a45990b9bfb9e05fb3e7600c44450d4be5Zhijun He new Key<Long>("android.sync.frameNumber", long.class); 36593865a84255a4e65a5d9790083a1e519b05f40d50Igor Murashkin 36605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 36615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * End generated code 36625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 36636c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin 36644b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin 36654b8cd6b44cf800cf5dd88e5afbcff4968398779dIgor Murashkin 3666b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala} 3667