CaptureRequest.java revision 808150f066b53da1573e8b1fbd6b377d0fc229f8
1b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/* 2b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Copyright (C) 2013 The Android Open Source Project 3b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 4b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Licensed under the Apache License, Version 2.0 (the "License"); 5b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * you may not use this file except in compliance with the License. 6b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * You may obtain a copy of the License at 7b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 8b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * http://www.apache.org/licenses/LICENSE-2.0 9b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 10b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Unless required by applicable law or agreed to in writing, software 11b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * distributed under the License is distributed on an "AS IS" BASIS, 12b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * See the License for the specific language governing permissions and 14b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * limitations under the License. 15b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 16b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 172f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvalapackage android.hardware.camera2; 18b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 1970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvalaimport android.hardware.camera2.impl.CameraMetadataNative; 206c76f58f31635c19c14ae161f96dad2082537860Igor Murashkinimport android.hardware.camera2.impl.PublicKey; 216c76f58f31635c19c14ae161f96dad2082537860Igor Murashkinimport android.hardware.camera2.impl.SyntheticKey; 225776aafc7e70c0b79c4bee2bc50f44121b37c962Ruben Brunkimport android.hardware.camera2.utils.HashCodeHelpers; 23d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinimport android.hardware.camera2.utils.TypeReference; 2470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport android.os.Parcel; 2570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport android.os.Parcelable; 26b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvalaimport android.view.Surface; 27b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 28feb50af361e4305a25758966b6b5df2738c00259Ruben Brunkimport java.util.Collection; 29feb50af361e4305a25758966b6b5df2738c00259Ruben Brunkimport java.util.Collections; 3070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport java.util.HashSet; 31d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinimport java.util.List; 326bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkinimport java.util.Objects; 33b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 34b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 35b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/** 3670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>An immutable package of settings and outputs needed to capture a single 3770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * image from the camera device.</p> 38b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 39b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>Contains the configuration for the capture hardware (sensor, lens, flash), 4070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * the processing pipeline, the control algorithms, and the output buffers. Also 4170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * contains the list of target Surfaces to send image data to for this 4270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * capture.</p> 43b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 4470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>CaptureRequests can be created by using a {@link Builder} instance, 4570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * obtained by calling {@link CameraDevice#createCaptureRequest}</p> 46b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 47b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>CaptureRequests are given to {@link CameraCaptureSession#capture} or 48b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CameraCaptureSession#setRepeatingRequest} to capture images from a camera.</p> 49b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 50b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>Each request can specify a different subset of target Surfaces for the 51b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * camera to send the captured data to. All the surfaces used in a request must 52b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * be part of the surface list given to the last call to 53b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CameraDevice#createCaptureSession}, when the request is submitted to the 54b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * session.</p> 55b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 56b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>For example, a request meant for repeating preview might only include the 57b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Surface for the preview SurfaceView or SurfaceTexture, while a 58b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * high-resolution still capture would also include a Surface from a ImageReader 59b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * configured for high-resolution JPEG images.</p> 60b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * 61b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * @see CameraDevice#capture 62b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * @see CameraDevice#setRepeatingRequest 6370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see CameraDevice#createCaptureRequest 64b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 65d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkinpublic final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>> 66d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin implements Parcelable { 67d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 68d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 69d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * A {@code Key} is used to do capture request field lookups with 70d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CaptureResult#get} or to set fields with 71d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CaptureRequest.Builder#set(Key, Object)}. 72d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 73d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>For example, to set the crop rectangle for the next capture: 74d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <code><pre> 75d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Rect cropRectangle = new Rect(0, 0, 640, 480); 76d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * captureRequestBuilder.set(SCALER_CROP_REGION, cropRectangle); 77d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * </pre></code> 78d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * </p> 79d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 80d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>To enumerate over all possible keys for {@link CaptureResult}, see 81d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p> 82d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 83d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @see CaptureResult#get 84d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @see CameraCharacteristics#getAvailableCaptureResultKeys 85d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 86d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final static class Key<T> { 87d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin private final CameraMetadataNative.Key<T> mKey; 88d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 89d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 90d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for testing and vendor extensions only. 91d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 92d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 93d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 94d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public Key(String name, Class<T> type) { 95d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = new CameraMetadataNative.Key<T>(name, type); 96d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 97d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 98d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 99d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for testing and vendor extensions only. 100d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 101d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 102d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 103d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public Key(String name, TypeReference<T> typeReference) { 104d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = new CameraMetadataNative.Key<T>(name, typeReference); 105d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 106d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 107d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 108d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Return a camelCase, period separated name formatted like: 109d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@code "root.section[.subsections].name"}. 110d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 111d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."}; 112d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * keys that are device/platform-specific are prefixed with {@code "com."}.</p> 113d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 114d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would 115d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device 116d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * specific key might look like {@code "com.google.nexus.data.private"}.</p> 117d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 118d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @return String representation of the key name 119d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 120d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public String getName() { 121d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey.getName(); 122d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 123d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 124d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 125d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 126d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 127d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 128d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final int hashCode() { 129d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey.hashCode(); 130d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 131d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 132d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 133d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 134d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 135d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 136d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 137d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public final boolean equals(Object o) { 138d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return o instanceof Key && ((Key<T>)o).mKey.equals(mKey); 139d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 140d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 141d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 142d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Visible for CameraMetadataNative implementation only; do not use. 143d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 144d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * TODO: Make this private or remove it altogether. 145d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 146d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 147d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 148d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public CameraMetadataNative.Key<T> getNativeKey() { 149d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return mKey; 150d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 151d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 152d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings({ "unchecked" }) 153d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) { 154d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mKey = (CameraMetadataNative.Key<T>) nativeKey; 155d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 156d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 15770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 15870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private final HashSet<Surface> mSurfaceSet; 15970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private final CameraMetadataNative mSettings; 16070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 1614068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala private Object mUserTag; 162b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 163b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala /** 1646bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Construct empty request. 1656bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 1666bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Used by Binder to unparcel this object only. 16770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin */ 1686bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin private CaptureRequest() { 16970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings = new CameraMetadataNative(); 17070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet = new HashSet<Surface>(); 171b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala } 172b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 173b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala /** 1746bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Clone from source capture request. 1756bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 1766bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Used by the Builder to create an immutable copy. 177b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 1786bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin @SuppressWarnings("unchecked") 17970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private CaptureRequest(CaptureRequest source) { 18070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings = new CameraMetadataNative(source.mSettings); 18170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet = (HashSet<Surface>) source.mSurfaceSet.clone(); 1827b01c5c4d27ebbd739d9e5e0de7eaafbffd8e084Eino-Ville Talvala mUserTag = source.mUserTag; 183b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala } 184b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 185b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala /** 1866bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Take ownership of passed-in settings. 1876bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 1886bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Used by the Builder to create a mutable CaptureRequest. 189b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */ 19070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala private CaptureRequest(CameraMetadataNative settings) { 191d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin mSettings = CameraMetadataNative.move(settings); 19270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet = new HashSet<Surface>(); 19370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 19470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 195d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 196d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * Get a capture request field value. 197d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 198d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>The field definitions can be found in {@link CaptureRequest}.</p> 199d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 200d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * <p>Querying the value for the same key more than once will return a value 201d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * which is equal to the previous queried value.</p> 202d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 203d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @throws IllegalArgumentException if the key was not valid 204d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * 205d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @param key The result field to read. 206d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @return The value of that key, or {@code null} if the field is not set. 207d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 20870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public <T> T get(Key<T> key) { 20970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mSettings.get(key); 2104068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala } 2114068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala 2124068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala /** 213d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 214d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 215d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 216d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 217d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 218d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin protected <T> T getProtected(Key<?> key) { 219d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return (T) mSettings.get(key); 220d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 221d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 222d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 223d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 224d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * @hide 225d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 226d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @SuppressWarnings("unchecked") 227d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 228d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin protected Class<Key<?>> getKeyClass() { 229d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin Object thisClass = Key.class; 230d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return (Class<Key<?>>)thisClass; 231d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 232d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 233d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 234d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin * {@inheritDoc} 235d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin */ 236d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin @Override 237d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin public List<Key<?>> getKeys() { 238d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin // Force the javadoc for this function to show up on the CaptureRequest page 239d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin return super.getKeys(); 240d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin } 241d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin 242d6d65154e55612b489aae95b60f3145f3b81f3b4Igor Murashkin /** 2434068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * Retrieve the tag for this request, if any. 2444068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * 2454068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * <p>This tag is not used for anything by the camera device, but can be 2464068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * used by an application to easily identify a CaptureRequest when it is 2474068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * returned by 248fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted} 2494068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * </p> 2504068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * 2514068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * @return the last tag Object set on this request, or {@code null} if 2524068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala * no tag has been set. 25370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see Builder#setTag 2544068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala */ 2554068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala public Object getTag() { 25670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mUserTag; 2574068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala } 2584068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala 2596bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin /** 2606bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * Determine whether this CaptureRequest is equal to another CaptureRequest. 2616bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 2626bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * <p>A request is considered equal to another is if it's set of key/values is equal, it's 2636bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * list of output surfaces is equal, and the user tag is equal.</p> 2646bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 2656bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * @param other Another instance of CaptureRequest. 2666bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * 2676bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin * @return True if the requests are the same, false otherwise. 2686bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin */ 2696bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin @Override 2706bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin public boolean equals(Object other) { 2716bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin return other instanceof CaptureRequest 2726bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin && equals((CaptureRequest)other); 2736bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 2746bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 2756bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin private boolean equals(CaptureRequest other) { 2766bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin return other != null 2776bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin && Objects.equals(mUserTag, other.mUserTag) 2786bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin && mSurfaceSet.equals(other.mSurfaceSet) 2796bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin && mSettings.equals(other.mSettings); 2806bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 2816bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 2826bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin @Override 2836bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin public int hashCode() { 2845776aafc7e70c0b79c4bee2bc50f44121b37c962Ruben Brunk return HashCodeHelpers.hashCode(mSettings, mSurfaceSet, mUserTag); 2856bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin } 2866bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin 28770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public static final Parcelable.Creator<CaptureRequest> CREATOR = 28870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin new Parcelable.Creator<CaptureRequest>() { 28970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin @Override 29070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public CaptureRequest createFromParcel(Parcel in) { 29170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin CaptureRequest request = new CaptureRequest(); 29270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin request.readFromParcel(in); 29370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 29470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin return request; 29570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 29670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 29770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin @Override 29870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public CaptureRequest[] newArray(int size) { 29970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin return new CaptureRequest[size]; 30070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 30170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin }; 30270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 30370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin /** 30470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin * Expand this object from a Parcel. 30570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Hidden since this breaks the immutability of CaptureRequest, but is 30670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * needed to receive CaptureRequests with aidl. 30770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 30870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin * @param in The parcel from which the object should be read 30970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @hide 31070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin */ 31172f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin private void readFromParcel(Parcel in) { 31270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings.readFromParcel(in); 31370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 31470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet.clear(); 31570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 31670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala Parcelable[] parcelableArray = in.readParcelableArray(Surface.class.getClassLoader()); 31770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 31870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala if (parcelableArray == null) { 31970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return; 32070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 32170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 32270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala for (Parcelable p : parcelableArray) { 32370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala Surface s = (Surface) p; 32470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSurfaceSet.add(s); 32570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 32670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 32770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 32870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin @Override 32970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public int describeContents() { 33070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return 0; 33170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 33270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 33370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala @Override 33470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin public void writeToParcel(Parcel dest, int flags) { 33570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mSettings.writeToParcel(dest, flags); 33670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala dest.writeParcelableArray(mSurfaceSet.toArray(new Surface[mSurfaceSet.size()]), flags); 33770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 33870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 33970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 340feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk * @hide 341feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk */ 342feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk public boolean containsTarget(Surface surface) { 343feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk return mSurfaceSet.contains(surface); 344feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk } 345feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk 346feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk /** 347feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk * @hide 348feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk */ 349feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk public Collection<Surface> getTargets() { 350feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk return Collections.unmodifiableCollection(mSurfaceSet); 351feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk } 352feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk 353feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk /** 35470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * A builder for capture requests. 35570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 35670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>To obtain a builder instance, use the 35770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * {@link CameraDevice#createCaptureRequest} method, which initializes the 35870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * request fields to one of the templates defined in {@link CameraDevice}. 35970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 36070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see CameraDevice#createCaptureRequest 361b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_PREVIEW 362b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_RECORD 363b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_STILL_CAPTURE 364b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_VIDEO_SNAPSHOT 365b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraDevice#TEMPLATE_MANUAL 36670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 36770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public final static class Builder { 36870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 3697a36a0fbb0a5f14047a3680668da954beca05dcbIgor Murashkin private final CaptureRequest mRequest; 37070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 37170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 37270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Initialize the builder using the template; the request takes 37370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * ownership of the template. 37470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 37570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @hide 37670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 37770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public Builder(CameraMetadataNative template) { 37870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest = new CaptureRequest(template); 37970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 38070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 38170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 38270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Add a surface to the list of targets for this request</p> 38370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 38470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>The Surface added must be one of the surfaces included in the most 385b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * recent call to {@link CameraDevice#createCaptureSession}, when the 38670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * request is given to the camera device.</p> 38770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 38870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Adding a target more than once has no effect.</p> 38970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 39070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param outputTarget Surface to use as an output target for this request 39170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 39270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public void addTarget(Surface outputTarget) { 39370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mSurfaceSet.add(outputTarget); 39470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 39570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin 39670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 39770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Remove a surface from the list of targets for this request.</p> 39870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 39970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>Removing a target that is not currently added has no effect.</p> 40070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 40170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param outputTarget Surface to use as an output target for this request 40270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 40370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public void removeTarget(Surface outputTarget) { 40470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mSurfaceSet.remove(outputTarget); 40570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin } 40670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 40770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 40870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Set a capture request field to a value. The field definitions can be 40970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * found in {@link CaptureRequest}. 41070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 41170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param key The metadata field to write. 41270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param value The value to set the field to, which must be of a matching 41370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * type to the key. 41470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 41570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public <T> void set(Key<T> key, T value) { 41670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mSettings.set(key, value); 41770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 41870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 41970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 42070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Get a capture request field value. The field definitions can be 42170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * found in {@link CaptureRequest}. 42270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 42370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @throws IllegalArgumentException if the key was not valid 42470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 42570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param key The metadata field to read. 42670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @return The value of that key, or {@code null} if the field is not set. 42770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 42870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public <T> T get(Key<T> key) { 42970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mRequest.mSettings.get(key); 43070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 43170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 43270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 43370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Set a tag for this request. 43470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 43570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>This tag is not used for anything by the camera device, but can be 43670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * used by an application to easily identify a CaptureRequest when it is 43770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * returned by 438fd887436bd111e4d2c7307578a51b5070025b7f2Eino-Ville Talvala * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted} 43970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 44070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @param tag an arbitrary Object to store with this request 44170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see CaptureRequest#getTag 44270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 44370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public void setTag(Object tag) { 44470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala mRequest.mUserTag = tag; 44570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 44670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 44770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 44870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * Build a request using the current target Surfaces and settings. 449edeab40338a047655f6af60e9e950dbad262279bSol Boucher * <p>Note that, although it is possible to create a {@code CaptureRequest} with no target 450edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link Surface}s, passing such a request into {@link CameraCaptureSession#capture}, 451edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link CameraCaptureSession#captureBurst}, 452edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link CameraCaptureSession#setRepeatingBurst}, or 453edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link CameraCaptureSession#setRepeatingRequest} will cause that method to throw an 454edeab40338a047655f6af60e9e950dbad262279bSol Boucher * {@link IllegalArgumentException}.</p> 45570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * 45670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @return A new capture request instance, ready for submission to the 45770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * camera device. 45870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 45970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public CaptureRequest build() { 46070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return new CaptureRequest(mRequest); 46170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 46270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 46370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 46470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala /** 46570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @hide 46670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala */ 46770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala public boolean isEmpty() { 46870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala return mRequest.mSettings.isEmpty(); 46970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala } 47070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala 471b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala } 472b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala 4735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 4745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * The key entries below this point are generated from metadata 4755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * definitions in /system/media/camera/docs. Do not modify by hand or 4765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * modify the comment blocks at the start or end. 4775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 4785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 4790da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala 4805a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 4817d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The mode control selects how the image data is converted from the 4827d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * sensor's native color into linear sRGB color.</p> 483b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>When auto-white balance (AWB) is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this 4847d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * control is overridden by the AWB routine. When AWB is disabled, the 4857d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * application controls how the color mapping is performed.</p> 4867d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>We define the expected processing pipeline below. For consistency 4877d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * across devices, this is always the case with TRANSFORM_MATRIX.</p> 4887d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>When either FULL or HIGH_QUALITY is used, the camera device may 4897d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 4907d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the 4917d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * camera device (in the results) and be roughly correct.</p> 4927d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>Switching to TRANSFORM_MATRIX and using the data provided from 4937d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * FAST or HIGH_QUALITY will yield a picture with the same white point 4947d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * as what was produced by the camera device in the earlier frame.</p> 4957d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The expected processing pipeline is as follows:</p> 4967d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> 4977d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The white balance is encoded by two values, a 4-channel white-balance 4987d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * gain vector (applied in the Bayer domain), and a 3x3 color transform 4997d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * matrix (applied after demosaic).</p> 5007d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The 4-channel white-balance gains are defined as:</p> 5017d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] 5027d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * </code></pre> 5037d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>where <code>G_even</code> is the gain for green pixels on even rows of the 5047d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * output, and <code>G_odd</code> is the gain for green pixels on the odd rows. 5057d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * These may be identical for a given camera device implementation; if 5067d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * the camera device does not support a separate gain for even/odd green 5077d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to 5087d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <code>G_even</code> in the output result metadata.</p> 5097d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>The matrices for color transforms are defined as a 9-entry vector:</p> 5107d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] 5117d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * </code></pre> 5127d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, 5137d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> 5147d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>with colors as follows:</p> 5157d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <pre><code>r' = I0r + I1g + I2b 5167d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * g' = I3r + I4g + I5b 5177d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * b' = I6r + I7g + I8b 5187d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * </code></pre> 5197d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>Both the input and output value ranges must match. Overflow/underflow 5207d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * values are clipped to fit within the range.</p> 5210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 5227d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * @see CaptureRequest#COLOR_CORRECTION_GAINS 5237d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 5240da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_AWB_MODE 5255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX 5265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #COLOR_CORRECTION_MODE_FAST 5275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY 5285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 5296c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 5305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> COLOR_CORRECTION_MODE = 5315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.colorCorrection.mode", int.class); 5325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 5335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 534ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>A color transform matrix to use to transform 535b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * from sensor RGB color space to output linear sRGB color space.</p> 53649a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>This matrix is either set by the camera device when the request 5370da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 5385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * directly by the application in the request when the 5390da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 54049a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>In the latter case, the camera device may round the matrix to account 54149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * for precision issues; the final rounded matrix should be reported back 54249a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * in this matrix result metadata. The transform should keep the magnitude 54349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * of the output color values within <code>[0, 1.0]</code> (assuming input color 54449a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 5450da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 5460da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_MODE 5475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 5486c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 5492bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM = 5502bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class); 5515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 5525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 5537d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin * <p>Gains applying to Bayer raw color channels for 554cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * white-balance.</p> 5552bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * <p>These per-channel gains are either set by the camera device 5562bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not 5572bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * TRANSFORM_MATRIX, or directly by the application in the 5582bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is 5592bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * TRANSFORM_MATRIX.</p> 5602bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * <p>The gains in the result metadata are the gains actually 5612bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala * applied by the camera device to the current frame.</p> 5620da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 5630da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_MODE 5645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 5656c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 5662bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS = 5672bb91a7a68e32530adf730deeef2fe95bad20a96Eino-Ville Talvala new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class); 5685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 5695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 570a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>Mode of operation for the chromatic aberration correction algorithm.</p> 571a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>This must be set to a valid mode from 5729e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}.</p> 573a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light 574a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * can not focus on the same point after exiting from the lens. This metadata defines 575a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * the high level control of chromatic aberration correction algorithm, which aims to 576a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * minimize the chromatic artifacts that may occur along the object boundaries in an 577a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * image.</p> 578a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * <p>FAST/HIGH_QUALITY both mean that camera device determined aberration 579a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * correction will be applied. HIGH_QUALITY mode indicates that the camera device will 580a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * use the highest-quality aberration correction algorithms, even if it slows down 581a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * capture rate. FAST means the camera device will not slow down capture rate when 582a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * applying aberration correction.</p> 583a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He * 5849e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES 5859e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_OFF 5869e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_FAST 5879e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He * @see #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY 588a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He */ 5896c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 5909e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE = 5919e4e439a688f1859cd895f2ff7ecad75cddb116bZhijun He new Key<Integer>("android.colorCorrection.aberrationMode", int.class); 592a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He 593a05e59d12b410638e97bc2d88c64442c47907fe3Zhijun He /** 5940da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The desired setting for the camera device's auto-exposure 5950da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * algorithm's antibanding compensation.</p> 5960da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>Some kinds of lighting fixtures, such as some fluorescent 5970da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * lights, flicker at the rate of the power supply frequency 5980da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * (60Hz or 50Hz, depending on country). While this is 5990da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * typically not noticeable to a person, it can be visible to 6000da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * a camera device. If a camera sets its exposure time to the 6010da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * wrong value, the flicker may become visible in the 6020da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * viewfinder as flicker or in a final captured image, as a 6030da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * set of variable-brightness bands across the image.</p> 6040da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>Therefore, the auto-exposure routines of camera devices 6050da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * include antibanding routines that ensure that the chosen 6060da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * exposure value will not cause such banding. The choice of 6070da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * exposure time depends on the rate of flicker, which the 6080da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * camera device can detect automatically, or the expected 6090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * rate can be selected by the application using this 6100da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * control.</p> 6110da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>A given camera device may not support all of the possible 6120da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * options for the antibanding mode. The 6130da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains 6140da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * the available modes for a given camera device.</p> 6150da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The default mode is AUTO, which must be supported by all 6160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * camera devices.</p> 6170da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>If manual exposure control is enabled (by setting 6180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), 6190da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * then this setting has no effect, and the application must 6200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ensure it selects exposure times that do not cause banding 6210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist 6220da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * the application in this.</p> 6230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 6245f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES 625399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 626265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 627265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureResult#STATISTICS_SCENE_FLICKER 6285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_OFF 6295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ 6305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ 6315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO 6325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 6336c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 6345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE = 6355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aeAntibandingMode", int.class); 6365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 6375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 638b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Adjustment to auto-exposure (AE) target image 639b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * brightness.</p> 640b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The adjustment is measured as a count of steps, with the 641b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * step size defined by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} and the 642b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * allowed range by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}.</p> 643b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>For example, if the exposure value (EV) step is 0.333, '6' 644b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * will mean an exposure compensation of +2 EV; -3 will mean an 645b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * exposure compensation of -1 EV. One EV represents a doubling 646b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * of image brightness. Note that this control will only be 647b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control 648b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * will take effect even when {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> 649a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * <p>In the event of exposure compensation value being changed, camera device 650a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * may take several frames to reach the newly requested exposure target. 651a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING 652a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will 653a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or 654a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * FLASH_REQUIRED (if the scene is too dark for still capture).</p> 655a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * 656b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE 657b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP 658a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_LOCK 659a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_MODE 660a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureResult#CONTROL_AE_STATE 6615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 6626c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 6635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION = 6645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aeExposureCompensation", int.class); 6655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 6665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 667b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-exposure (AE) is currently locked to its latest 66849a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * calculated values.</p> 669ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Note that even when AE is locked, the flash may be 67049a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / ON_ALWAYS_FLASH / 671ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * ON_AUTO_FLASH_REDEYE.</p> 672a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock 673a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * is ON, the camera device will still adjust its exposure value.</p> 67449a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) 67549a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * when AE is already locked, the camera device will not change the exposure time 67649a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) 677d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 67849a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the 67949a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p> 68049a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> 68149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * 682a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION 68349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 68449a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 68549a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureResult#CONTROL_AE_STATE 68649a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#SENSOR_EXPOSURE_TIME 68749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He * @see CaptureRequest#SENSOR_SENSITIVITY 6885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 6896c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 6905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> CONTROL_AE_LOCK = 6915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.control.aeLock", boolean.class); 6925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 6935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 6940da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The desired mode for the camera device's 6950da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * auto-exposure routine.</p> 6960da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 6970da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * AUTO.</p> 6980da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>When set to any of the ON modes, the camera device's 6990da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * auto-exposure routine is enabled, overriding the 7000da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * application's selected exposure time, sensor sensitivity, 7010da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 7020da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 7030da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 7040da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * is selected, the camera device's flash unit controls are 7050da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * also overridden.</p> 7060da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>The FLASH modes are only available if the camera device 7070da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 7080da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>If flash TORCH mode is desired, this field must be set to 7090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 7100da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * <p>When set to any of the ON modes, the values chosen by the 7110da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * camera device auto-exposure routine for the overridden 7120da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * fields for a given capture will be available in its 7130da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * CaptureResult.</p> 7140da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 7155f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#CONTROL_MODE 716265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 717265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#FLASH_MODE 718aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @see CaptureRequest#SENSOR_EXPOSURE_TIME 719aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin * @see CaptureRequest#SENSOR_FRAME_DURATION 720399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#SENSOR_SENSITIVITY 7215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_OFF 7225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON 7235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 7245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 7255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 7265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 7276c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 7285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_MODE = 7295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aeMode", int.class); 7305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 7315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 732ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>List of areas to use for 733f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk * metering.</p> 734808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p>Optional. Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0. 735808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 736ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 7372629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 7380da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 7390da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 74097f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 74197f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * <p>The weight must range from 0 to 1000, and represents a weight 74297f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 74397f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 74497f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 74597f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 746ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>If all regions have 0 weight, then no specific metering area 747cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * needs to be used by the camera device. If the metering region is 7481498615d56851664c96e51d530e445ed73be7a22Zhijun He * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 7491498615d56851664c96e51d530e445ed73be7a22Zhijun He * the camera device will ignore the sections outside the region and output the 7501498615d56851664c96e51d530e445ed73be7a22Zhijun He * used sections in the result metadata.</p> 751808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 7520da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 753808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE 7540da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 755265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 7565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 7576c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 758817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS = 759817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class); 7605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 7615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 762ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Range over which fps can be adjusted to 763b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * maintain exposure.</p> 764b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Only constrains auto-exposure (AE) algorithm, not 765b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</p> 7660da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 7670da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SENSOR_EXPOSURE_TIME 7685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 7696c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 77078712a8bd7275542013ba099f33536eead0167fbIgor Murashkin public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE = 77178712a8bd7275542013ba099f33536eead0167fbIgor Murashkin new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }}); 7725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 7735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 774228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Whether the camera device will trigger a precapture 775228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * metering sequence when it processes this request.</p> 776ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This entry is normally set to IDLE, or is not 7775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * included at all in the request settings. When included and 778228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * set to START, the camera device will trigger the autoexposure 779ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * precapture metering sequence.</p> 780e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>The precapture sequence should triggered before starting a 781e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * high-quality still capture for final metering decisions to 782e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * be made, and for firing pre-capture flash pulses to estimate 783e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * scene brightness and required final capture flash power, when 784e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * the flash is enabled.</p> 785e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Normally, this entry should be set to START for only a 786e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * single request, and the application should wait until the 787e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * sequence completes before starting a new one.</p> 788e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>The exact effect of auto-exposure (AE) precapture trigger 789e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * depends on the current AE mode and state; see 790b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition 791b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * details.</p> 792228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * 793228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureResult#CONTROL_AE_STATE 7945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE 7955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START 7965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 7976c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 7985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER = 7995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.aePrecaptureTrigger", int.class); 8005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 8015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 802b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-focus (AF) is currently enabled, and what 803b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * mode it is set to.</p> 804cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus 805cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>).</p> 80678146ecb24871302a4c4dc0a7341044a06d29ee8Zhijun He * <p>If the lens is controlled by the camera device auto-focus algorithm, 807d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} 80878146ecb24871302a4c4dc0a7341044a06d29ee8Zhijun He * in result metadata.</p> 8090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 810d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CaptureResult#CONTROL_AF_STATE 8110da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 812cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 8135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_OFF 8145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_AUTO 8155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_MACRO 8165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 8175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 8185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_MODE_EDOF 8195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 8206c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 8215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AF_MODE = 8225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.afMode", int.class); 8235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 8245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 825ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>List of areas to use for focus 826f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk * estimation.</p> 827808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p>Optional. Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0. 828808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 829ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 8302629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 8310da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 8320da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 83397f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 83497f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * <p>The weight must range from 0 to 1000, and represents a weight 83597f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 83697f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 83797f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 83897f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 839817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * <p>If all regions have 0 weight, then no specific metering area 840817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * needs to be used by the camera device. If the metering region is 841817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 842817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * the camera device will ignore the sections outside the region and output the 843817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * used sections in the result metadata.</p> 844808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 8450da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 846808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF 8470da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 848265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 8495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 8506c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 851817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS = 852817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class); 8535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 8545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 855228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>Whether the camera device will trigger autofocus for this request.</p> 856ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This entry is normally set to IDLE, or is not 857ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * included at all in the request settings.</p> 858228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When included and set to START, the camera device will trigger the 859228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> 860228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * <p>When set to CANCEL, the camera device will cancel any active trigger, 861228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * and return to its initial AF state.</p> 862e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Generally, applications should set this entry to START or CANCEL for only a 863e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * single capture, and then return it to IDLE (or not set at all). Specifying 864e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * START for multiple captures in a row means restarting the AF operation over 865e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * and over again.</p> 866e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p> 867228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * 868228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He * @see CaptureResult#CONTROL_AF_STATE 8695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_TRIGGER_IDLE 8705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_TRIGGER_START 8715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AF_TRIGGER_CANCEL 8725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 8736c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 8745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AF_TRIGGER = 8755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.afTrigger", int.class); 8765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 8775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 878b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-white balance (AWB) is currently locked to its 8792d5e89778e955b4ff209a93e738761356349d48cZhijun He * latest calculated values.</p> 880e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Note that AWB lock is only meaningful when 881e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes, 882e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * AWB is already fixed to a specific setting.</p> 883e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 884e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#CONTROL_AWB_MODE 8855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 8866c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 8875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> CONTROL_AWB_LOCK = 8885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.control.awbLock", boolean.class); 8895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 8905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 891b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Whether auto-white balance (AWB) is currently setting the color 8925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * transform fields, and what its illumination target 893cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * is.</p> 894399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 895e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to the ON mode, the camera device's auto-white balance 896399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * routine is enabled, overriding the application's selected 897399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 898399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 899e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to the OFF mode, the camera device's auto-white balance 900cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * routine is disabled. The application manually controls the white 901d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} 902399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 903e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>When set to any other modes, the camera device's auto-white 904e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * balance routine is disabled. The camera device uses each 905e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * particular illumination target for white balance 906e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * adjustment. The application's values for 907e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, 908e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 909e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p> 9100da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 911265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#COLOR_CORRECTION_GAINS 9125f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#COLOR_CORRECTION_MODE 9135f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 914265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 9155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_OFF 9165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_AUTO 9175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_INCANDESCENT 9185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_FLUORESCENT 9195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 9205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_DAYLIGHT 9215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 9225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_TWILIGHT 9235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_AWB_MODE_SHADE 9245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 9256c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 9265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_AWB_MODE = 9275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.awbMode", int.class); 9285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 9295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 930ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>List of areas to use for illuminant 931f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk * estimation.</p> 932808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p>Optional. Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0. 933808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * Otherwise will always be present.</p> 934ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The coordinate system is based on the active pixel array, 9352629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight * with (0,0) being the top-left pixel in the active pixel array, and 9360da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 9370da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 93897f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * bottom-right pixel in the active pixel array.</p> 93997f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * <p>The weight must range from 0 to 1000, and represents a weight 94097f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * for every pixel in the area. This means that a large metering area 94197f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * with the same weight as a smaller area will have more effect in 94297f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * the metering result. Metering areas can partially overlap and the 94397f1c854993a65b2c700426a1e3a83b23ea65337Yin-Chia Yeh * camera device will add the weights in the overlap region.</p> 944817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * <p>If all regions have 0 weight, then no specific metering area 945817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * needs to be used by the camera device. If the metering region is 946817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 9471498615d56851664c96e51d530e445ed73be7a22Zhijun He * the camera device will ignore the sections outside the region and output the 9481498615d56851664c96e51d530e445ed73be7a22Zhijun He * used sections in the result metadata.</p> 949808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 9500da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 951808150f066b53da1573e8b1fbd6b377d0fc229f8Yin-Chia Yeh * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB 9520da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 953265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 9545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 9556c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 956817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS = 957817f8933ee1c11130ad2ca45b5ac8ce8b729f125Yin-Chia Yeh new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class); 9585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 9595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 96066d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>Information to the camera device 3A (auto-exposure, 96166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * auto-focus, auto-white balance) routines about the purpose 96266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * of this capture, to help the camera device to decide optimal 3A 96366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * strategy.</p> 964e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * <p>This control (except for MANUAL) is only effective if 965e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> 966e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>ZERO_SHUTTER_LAG will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 967e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * contains ZSL. MANUAL will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 968e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * contains MANUAL_SENSOR.</p> 9690da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 9700da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 971e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 9725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_CUSTOM 9735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_PREVIEW 9745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE 9755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD 9765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT 9775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG 978e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He * @see #CONTROL_CAPTURE_INTENT_MANUAL 9795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 9806c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 9815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_CAPTURE_INTENT = 9825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.captureIntent", int.class); 9835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 9845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 9855f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * <p>A special color effect to apply.</p> 9865f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * <p>When this mode is set, a color effect will be applied 9875f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * to images produced by the camera device. The interpretation 9885f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * and implementation of these color effects is left to the 9895f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * implementor of the camera device, and should not be 9905f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * depended on to be consistent (or present) across all 9915f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * devices.</p> 9925f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * <p>A color effect will only be applied if 9935f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.</p> 9940da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 9950da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 9965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_OFF 9975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_MONO 9985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_NEGATIVE 9995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_SOLARIZE 10005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_SEPIA 10015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_POSTERIZE 10025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_WHITEBOARD 10035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_BLACKBOARD 10045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_EFFECT_MODE_AQUA 10055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10066c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 10075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_EFFECT_MODE = 10085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.effectMode", int.class); 10095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1011ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Overall mode of 3A control 1012cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * routines.</p> 1013f353742124af698098884b4172644af0851b30caZhijun He * <p>High-level 3A control. When set to OFF, all 3A control 10145f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * by the camera device is disabled. The application must set the fields for 1015f353742124af698098884b4172644af0851b30caZhijun He * capture parameters itself.</p> 1016f353742124af698098884b4172644af0851b30caZhijun He * <p>When set to AUTO, the individual algorithm controls in 10170da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 1018f353742124af698098884b4172644af0851b30caZhijun He * <p>When set to USE_SCENE_MODE, the individual controls in 10195f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * android.control.* are mostly disabled, and the camera device implements 1020f353742124af698098884b4172644af0851b30caZhijun He * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 10215f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * as it wishes. The camera device scene mode 3A settings are provided by 1022f353742124af698098884b4172644af0851b30caZhijun He * android.control.sceneModeOverrides.</p> 10232d5e89778e955b4ff209a93e738761356349d48cZhijun He * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 10242d5e89778e955b4ff209a93e738761356349d48cZhijun He * is that this frame will not be used by camera device background 3A statistics 10252d5e89778e955b4ff209a93e738761356349d48cZhijun He * update, as if this frame is never captured. This mode can be used in the scenario 10262d5e89778e955b4ff209a93e738761356349d48cZhijun He * where the application doesn't want a 3A manual control capture to affect 10272d5e89778e955b4ff209a93e738761356349d48cZhijun He * the subsequent auto 3A capture results.</p> 10280da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 10290da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_AF_MODE 10305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_OFF 10315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_AUTO 10325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_MODE_USE_SCENE_MODE 10332d5e89778e955b4ff209a93e738761356349d48cZhijun He * @see #CONTROL_MODE_OFF_KEEP_STATE 10345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10356c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 10365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_MODE = 10375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.mode", int.class); 10385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1040e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * <p>A camera mode optimized for conditions typical in a particular 1041e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * capture setting.</p> 1042e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * <p>This is the mode that that is active when 1043e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, 1044e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, 1045e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use. 1046e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * The scene modes available for a given camera device are listed in 1047e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}.</p> 1048e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * <p>The interpretation and implementation of these scene modes is left 1049e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * to the implementor of the camera device. Their behavior will not be 1050e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * consistent across all devices, and any given device may only implement 1051e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * a subset of these modes.</p> 10520da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1053e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see CaptureRequest#CONTROL_AE_MODE 1054e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see CaptureRequest#CONTROL_AF_MODE 1055e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES 1056e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see CaptureRequest#CONTROL_AWB_MODE 10570da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#CONTROL_MODE 1058e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk * @see #CONTROL_SCENE_MODE_DISABLED 10595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_FACE_PRIORITY 10605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_ACTION 10615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_PORTRAIT 10625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_LANDSCAPE 10635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_NIGHT 10645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT 10655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_THEATRE 10665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_BEACH 10675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_SNOW 10685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_SUNSET 10695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_STEADYPHOTO 10705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_FIREWORKS 10715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_SPORTS 10725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_PARTY 10735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_CANDLELIGHT 10745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #CONTROL_SCENE_MODE_BARCODE 1075e040418f4779c37aa9df69a3916d376af9d2e868Zhijun He * @see #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO 10765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 10776c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 10785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> CONTROL_SCENE_MODE = 10795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.control.sceneMode", int.class); 10805a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 10815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1082ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether video stabilization is 1083b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * active.</p> 1084e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Video stabilization automatically translates and scales images from the camera 1085e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * in order to stabilize motion between consecutive frames.</p> 1086ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>If enabled, video stabilization can modify the 108745fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p> 108845fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * <p>Switching between different video stabilization modes may take several frames 108945fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * to initialize, the camera device will report the current mode in capture result 109045fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * metadata. For example, When "ON" mode is requested, the video stabilization modes 109145fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * in the first several capture results may still be "OFF", and it will become "ON" 109245fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * when the initialization is done.</p> 109345fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * <p>If a camera device supports both this mode and OIS ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), 109445fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * turning both modes on may produce undesirable interaction, so it is recommended not to 109545fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * enable both at the same time.</p> 10960da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 109745fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE 10980da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#SCALER_CROP_REGION 10994793af5e3577c51858719a8977d300c3aafdf881Zhijun He * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF 11004793af5e3577c51858719a8977d300c3aafdf881Zhijun He * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON 11015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11026c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 11034793af5e3577c51858719a8977d300c3aafdf881Zhijun He public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE = 11044793af5e3577c51858719a8977d300c3aafdf881Zhijun He new Key<Integer>("android.control.videoStabilizationMode", int.class); 11055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11065a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1107ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Operation mode for edge 1108cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * enhancement.</p> 11092807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * <p>Edge/sharpness/detail enhancement. OFF means no 1110cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * enhancement will be applied by the camera device.</p> 11116dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * <p>This must be set to one of the modes listed in {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}.</p> 11125f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 11132807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * will be applied. HIGH_QUALITY mode indicates that the 11145f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * camera device will use the highest-quality enhancement algorithms, 11155f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * even if it slows down capture rate. FAST means the camera device will 11162807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * not slow down capture rate when applying edge enhancement.</p> 11176dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * 11186dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES 11195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_OFF 11205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_FAST 11215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #EDGE_MODE_HIGH_QUALITY 11225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11236c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 11245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> EDGE_MODE = 11255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.edge.mode", int.class); 11265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 112866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>The desired mode for for the camera device's flash control.</p> 112966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>This control is only effective when flash unit is available 1130153ac102d36df66853b523ab01763dc457972517Zhijun He * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 113166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 113266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 113366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 113466d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 113566d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 113666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * device's auto-exposure routine's result. When used in still capture case, this 1137b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * control should be used along with auto-exposure (AE) precapture metering sequence 113866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 113966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * <p>When set to TORCH, the flash will be on continuously. This mode can be used 114066d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 1141ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 114266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * 114366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 114466d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 114566d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 1146ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#FLASH_STATE 11475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_OFF 11485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_SINGLE 11495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #FLASH_MODE_TORCH 11505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11516c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 11525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> FLASH_MODE = 11535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.flash.mode", int.class); 11545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1156eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * <p>Set operational mode for hot pixel correction.</p> 11579d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * <p>Valid modes for this camera device are listed in 11589d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}.</p> 1159eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * <p>Hotpixel correction interpolates out, or otherwise removes, pixels 1160eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * that do not accurately encode the incoming light (i.e. pixels that 1161eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * are stuck at an arbitrary value).</p> 11629d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * 11639d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES 1164eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_OFF 1165eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_FAST 1166eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk * @see #HOT_PIXEL_MODE_HIGH_QUALITY 1167eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk */ 11686c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1169eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk public static final Key<Integer> HOT_PIXEL_MODE = 1170eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk new Key<Integer>("android.hotPixel.mode", int.class); 1171eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk 1172eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk /** 1173574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * <p>A location object to use when generating image GPS metadata.</p> 1174574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk */ 11756c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 11766c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @SyntheticKey 1177574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk public static final Key<android.location.Location> JPEG_GPS_LOCATION = 1178574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk new Key<android.location.Location>("android.jpeg.gpsLocation", android.location.Location.class); 1179574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk 1180574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk /** 1181ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>GPS coordinates to include in output JPEG 1182ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * EXIF</p> 1183574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 11845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<double[]> JPEG_GPS_COORDINATES = 11865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 11875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1189ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>32 characters describing GPS algorithm to 1190ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * include in EXIF</p> 1191574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 11925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 11935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 11945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 11955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 11965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1197ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Time GPS fix was made to include in 1198ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * EXIF</p> 1199574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * @hide 12005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> JPEG_GPS_TIMESTAMP = 12025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.jpeg.gpsTimestamp", long.class); 12035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1205ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Orientation of JPEG image to 1206ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * write</p> 12075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12086c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 12095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> JPEG_ORIENTATION = 12105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.jpeg.orientation", int.class); 12115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1213ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Compression quality of the final JPEG 1214b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * image.</p> 1215e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>85-95 is typical usage range.</p> 12165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12176c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 12185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Byte> JPEG_QUALITY = 12195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Byte>("android.jpeg.quality", byte.class); 12205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1222ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Compression quality of JPEG 1223e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * thumbnail.</p> 12245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12256c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 12265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 12275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 12285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1230b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Resolution of embedded JPEG thumbnail.</p> 12315f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 12325f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * but the captured JPEG will still be a valid image.</p> 12335a9ff379233025bc85ebc41ac5979def09d3ebfaZhijun He * <p>When a jpeg image capture is issued, the thumbnail size selected should have 12345a9ff379233025bc85ebc41ac5979def09d3ebfaZhijun He * the same aspect ratio as the jpeg image.</p> 123550f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect 123650f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * ratio, the camera device creates the thumbnail by cropping it from the primary image. 123750f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * For example, if the primary image has 4:3 aspect ratio, the thumbnail image has 123850f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to 123950f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * generate the thumbnail image. The thumbnail image will always have a smaller Field 124050f7243ca068c793c8b5aca37a9e983b630c477fZhijun He * Of View (FOV) than the primary image when aspect ratios differ.</p> 12415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12426c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 124372f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE = 124472f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class); 12455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1247fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>The ratio of lens focal length to the effective 1248fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * aperture diameter.</p> 1249fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>This will only be supported on the camera devices that 1250fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * have variable aperture lens. The aperture value can only be 1251fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.</p> 1252fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 1253fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 1254d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} 1255fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * to achieve manual exposure control.</p> 1256fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>The requested aperture value may take several frames to reach the 1257fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * requested value; the camera device will report the current (intermediate) 1258ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * aperture size in capture result metadata while the aperture is changing. 1259ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1260fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 1261fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * the ON modes, this will be overridden by the camera device 1262fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * auto-exposure algorithm, the overridden values are then provided 1263fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * back to the user in the corresponding result.</p> 1264fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He * 1265399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 1266265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1267ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 1268265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1269d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CaptureRequest#SENSOR_FRAME_DURATION 1270265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala * @see CaptureRequest#SENSOR_SENSITIVITY 12715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12726c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 12735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_APERTURE = 12745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.aperture", float.class); 12755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 12765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1277855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * <p>State of lens neutral density filter(s).</p> 1278855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * <p>This will not be supported on most camera devices. On devices 1279855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * where this is supported, this may only be set to one of the 1280855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * values included in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}.</p> 1281855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * <p>Lens filters are typically used to lower the amount of light the 1282855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * sensor is exposed to (measured in steps of EV). As used here, an EV 1283855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * step is the standard logarithmic representation, which are 1284855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * non-negative, and inversely proportional to the amount of light 1285855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * hitting the sensor. For example, setting this to 0 would result 1286855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * in no reduction of the incoming light, and setting this to 2 would 1287855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * mean that the filter is set to reduce incoming light by two stops 1288855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * (allowing 1/4 of the prior amount of light to the sensor).</p> 1289ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>It may take several frames before the lens filter density changes 1290ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * to the requested value. While the filter density is still changing, 1291ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1292855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * 1293855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1294ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 12955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 12966c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 12975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FILTER_DENSITY = 12985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.filterDensity", float.class); 12995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1301a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>The current lens focal length; used for optical zoom.</p> 1302a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>This setting controls the physical focal length of the camera 1303a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * device's lens. Changing the focal length changes the field of 1304a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * view of the camera device, and is usually used for optical zoom.</p> 1305a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 1306a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * setting won't be applied instantaneously, and it may take several 1307ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * frames before the lens can change to the requested focal length. 1308a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 1309a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * be set to MOVING.</p> 1310a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * <p>This is expected not to be supported on most devices.</p> 1311a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * 1312a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureRequest#LENS_APERTURE 1313a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureRequest#LENS_FOCUS_DISTANCE 1314a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk * @see CaptureResult#LENS_STATE 13155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 13166c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 13175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FOCAL_LENGTH = 13185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.focalLength", float.class); 13195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1321ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Distance to plane of sharpest focus, 1322b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * measured from frontmost surface of the lens.</p> 1323ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>0 means infinity focus. Used value will be clamped 1324ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * to [0, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}].</p> 1325ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * <p>Like {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, this setting won't be applied 1326ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * instantaneously, and it may take several frames before the lens 1327ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * can move to the requested focus distance. While the lens is still moving, 1328ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1329ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * 1330ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureRequest#LENS_FOCAL_LENGTH 1331ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1332ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He * @see CaptureResult#LENS_STATE 13335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 13346c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 13355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Float> LENS_FOCUS_DISTANCE = 13365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Float>("android.lens.focusDistance", float.class); 13375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 133900849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk * <p>Sets whether the camera device uses optical image stabilization (OIS) 134000849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk * when capturing images.</p> 1341e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>OIS is used to compensate for motion blur due to small 1342e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * movements of the camera during capture. Unlike digital image 1343e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * stabilization ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), OIS 1344e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * makes use of mechanical elements to stabilize the camera 1345e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * sensor, and thus allows for longer exposure times before 1346e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * camera shake becomes apparent.</p> 134745fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * <p>Switching between different optical stabilization modes may take several 134845fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * frames to initialize, the camera device will report the current mode in 134945fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * capture result metadata. For example, When "ON" mode is requested, the 135045fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * optical stabilization modes in the first several capture results may still 135145fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * be "OFF", and it will become "ON" when the initialization is done.</p> 135245fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * <p>If a camera device supports both OIS and EIS ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), 135345fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * turning both modes on may produce undesirable interaction, so it is recommended not 135445fa43a1815e2d0a25ed3a126e4e732a03b7ed7fZhijun He * to enable both at the same time.</p> 1355e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Not all devices will support OIS; see 1356e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for 1357e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * available controls.</p> 1358e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * 1359e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE 1360e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION 13615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 13625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 13635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 13646c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 13655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 13665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 13675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1369e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Mode of operation for the noise reduction algorithm.</p> 13702807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * <p>Noise filtering control. OFF means no noise reduction 1371cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * will be applied by the camera device.</p> 1372e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>This must be set to a valid mode from 13736dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}.</p> 13745f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 13755f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * will be applied. HIGH_QUALITY mode indicates that the camera device 13765f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * will use the highest-quality noise filtering algorithms, 1377e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * even if it slows down capture rate. FAST means the camera device will not 13782807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He * slow down capture rate when applying noise filtering.</p> 13796dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * 13806dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES 13815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_OFF 13825a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_FAST 13835a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 13845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 13856c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 13865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> NOISE_REDUCTION_MODE = 13875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.noiseReduction.mode", int.class); 13885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1390ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>An application-specified ID for the current 13915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * request. Must be maintained unchanged in output 1392ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * frame</p> 13935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @hide 13945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 13955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> REQUEST_ID = 13965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.request.id", int.class); 13975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 13985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1399b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The region of the sensor to read out for this capture.</p> 1400b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The crop region coordinate system is based off 1401b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the 1402b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * top-left corner of the sensor active array.</p> 1403b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>Output streams use this rectangle to produce their output, 1404b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * cropping to a smaller region if necessary to maintain the 1405b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * stream's aspect ratio, then scaling the sensor input to 1406b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * match the output's configured resolution.</p> 1407b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The crop region is applied after the RAW to other color 1408b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * space (e.g. YUV) conversion. Since raw streams 1409b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * (e.g. RAW16) don't have the conversion stage, they are not 1410b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * croppable. The crop region will be ignored by raw streams.</p> 14119e6d1880c288d7d0ddcb651dda88d069f058ecedZhijun He * <p>For non-raw streams, any additional per-stream cropping will 14129e6d1880c288d7d0ddcb651dda88d069f058ecedZhijun He * be done to maximize the final pixel area of the stream.</p> 1413ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>For example, if the crop region is set to a 4:3 aspect 1414b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * ratio, then 4:3 streams will use the exact crop 1415b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * region. 16:9 streams will further crop vertically 1416ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * (letterbox).</p> 1417ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Conversely, if the crop region is set to a 16:9, then 4:3 1418b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * outputs will crop horizontally (pillarbox), and 16:9 1419b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * streams will match exactly. These additional crops will 1420ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * be centered within the crop region.</p> 1421b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The width and height of the crop region cannot 1422b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * be set to be smaller than 1423b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <code>floor( activeArraySize.width / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and 1424b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <code>floor( activeArraySize.height / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p> 1425b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The camera device may adjust the crop region to account 1426b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * for rounding and other hardware requirements; the final 1427b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * crop region used will be included in the output capture 1428b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * result.</p> 1429d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * 1430d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM 1431b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 14325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 14336c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 14345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 14355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 14365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 14375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1438ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Duration each pixel is exposed to 1439ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * light.</p> 1440ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>If the sensor can't expose this exact duration, it should shorten the 1441ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * duration exposed to the nearest possible value (rather than expose longer).</p> 14425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 14436c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 14445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> SENSOR_EXPOSURE_TIME = 14455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.sensor.exposureTime", long.class); 14465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 14475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1448ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Duration from start of frame exposure to 1449143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * start of next frame exposure.</p> 1450143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The maximum frame rate that can be supported by a camera subsystem is 1451143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * a function of many factors:</p> 1452143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ul> 1453143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Requested resolutions of output image streams</li> 1454143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Availability of binning / skipping modes on the imager</li> 1455143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The bandwidth of the imager interface</li> 1456143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The bandwidth of the various ISP processing blocks</li> 1457143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ul> 1458143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>Since these factors can vary greatly between different ISPs and 1459143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * sensors, the camera abstraction tries to represent the bandwidth 1460143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * restrictions with as simple a model as possible.</p> 1461143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The model presented has the following characteristics:</p> 1462143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ul> 1463143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>The image sensor is always configured to output the smallest 1464143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * resolution possible given the application's requested output stream 1465143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * sizes. The smallest resolution is defined as being at least as large 1466143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * as the largest requested output stream size; the camera pipeline must 1467143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * never digitally upsample sensor data when the crop region covers the 1468143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * whole sensor. In general, this means that if only small output stream 1469143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * resolutions are configured, the sensor can provide a higher frame 1470143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * rate.</li> 1471143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Since any request may use any or all the currently configured 1472143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * output streams, the sensor and ISP must be configured to support 1473143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * scaling a single capture to all the streams at the same time. This 1474143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * means the camera pipeline must be ready to produce the largest 1475143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * requested output size without any delay. Therefore, the overall 1476143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * frame rate of a given configured stream set is governed only by the 1477143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * largest requested stream resolution.</li> 1478143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <li>Using more than one output stream in a request does not affect the 1479143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * frame duration.</li> 1480a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Certain format-streams may need to do additional background processing 1481a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * before data is consumed/produced by that stream. These processors 1482a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * can run concurrently to the rest of the camera pipeline, but 1483a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * cannot process more than 1 capture at a time.</li> 1484143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ul> 1485143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>The necessary information for the application, given the model above, 14869c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field 14879c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size). 1488143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * These are used to determine the maximum frame rate / minimum frame 1489143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * duration that is possible for a given stream configuration.</p> 1490143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <p>Specifically, the application can use the following rules to 1491a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * determine the minimum frame duration it can request from the camera 1492143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * device:</p> 1493143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * <ol> 1494a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Let the set of currently configured input/output streams 1495a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * be called <code>S</code>.</li> 1496a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>Find the minimum frame durations for each stream in <code>S</code>, by 14979c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using 14989c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with 1499a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * its respective size/format). Let this set of frame durations be called 1500a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <code>F</code>.</li> 1501a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <li>For any given request <code>R</code>, the minimum frame duration allowed 1502a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams 1503a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * used in <code>R</code> be called <code>S_r</code>.</li> 1504143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * </ol> 1505a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>If none of the streams in <code>S_r</code> have a stall time (listed in 15069c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * StreamConfigurationMap#getOutputStallDuration(int,Size) using its 15079c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * respective size/format), then the frame duration in 1508a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <code>F</code> determines the steady state frame rate that the application will 1509a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * get if it uses <code>R</code> as a repeating request. Let this special kind 1510a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * of request be called <code>Rsimple</code>.</p> 1511a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved 1512a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * by a single capture of a new request <code>Rstall</code> (which has at least 1513a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the 1514a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * same minimum frame duration this will not cause a frame rate loss 1515a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * if all buffers from the previous <code>Rstall</code> have already been 1516a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * delivered.</p> 1517a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin * <p>For more details about stalling, see 15189c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * StreamConfigurationMap#getOutputStallDuration(int,Size).</p> 1519143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin * 15209c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP 15215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 15226c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 15235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Long> SENSOR_FRAME_DURATION = 15245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Long>("android.sensor.frameDuration", long.class); 15255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 15265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1527b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The amount of gain applied to sensor data 1528b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * before processing.</p> 1529b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The sensitivity is the standard ISO sensitivity value, 1530b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * as defined in ISO 12232:2006.</p> 1531b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The sensitivity must be within {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}, and 1532b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * if if it less than {@link CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY android.sensor.maxAnalogSensitivity}, the camera device 1533b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * is guaranteed to use only analog amplification for applying the gain.</p> 1534b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>If the camera device cannot apply the exact sensitivity 1535b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * requested, it will reduce the gain to the nearest supported 1536b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * value. The final sensitivity used will be available in the 1537b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * output capture result.</p> 1538b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * 1539b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE 1540b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY 15415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 15426c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 15435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> SENSOR_SENSITIVITY = 15445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.sensor.sensitivity", int.class); 15455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 15465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1547c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern 1548c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> 1549c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>Each color channel is treated as an unsigned 32-bit integer. 1550c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * The camera device then uses the most significant X bits 1551c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * that correspond to how many bits are in its Bayer raw sensor 1552c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * output.</p> 1553c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>For example, a sensor with RAW10 Bayer output would use the 1554c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * 10 most significant bits from each color channel.</p> 1555c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1556c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * 1557c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE 1558c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin */ 15596c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1560c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin public static final Key<int[]> SENSOR_TEST_PATTERN_DATA = 1561c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin new Key<int[]>("android.sensor.testPatternData", int[].class); 1562c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin 1563c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin /** 1564c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>When enabled, the sensor sends a test pattern instead of 1565c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * doing a real exposure from the camera.</p> 1566c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>When a test pattern is enabled, all manual sensor controls specified 1567e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * by android.sensor.* will be ignored. All other controls should 1568c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * work as normal.</p> 1569c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p>For example, if manual flash is enabled, flash firing should still 1570c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * occur (and that the test pattern remain unmodified, since the flash 1571c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * would not actually affect it).</p> 1572c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1573c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_OFF 1574c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 1575c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 1576c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 1577c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_PN9 1578c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 1579c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin */ 15806c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1581c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 1582c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin new Key<Integer>("android.sensor.testPatternMode", int.class); 1583c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin 1584c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin /** 1585ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <p>Quality of lens shading correction applied 1586ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * to the image data.</p> 1587ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <p>When set to OFF mode, no lens shading correction will be applied by the 1588ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * camera device, and an identity lens shading map data will be provided 1589ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 1590574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * shading map with size specified as <code>android.lens.info.shadingMapSize = [ 4, 3 ]</code>, 1591574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * the output android.statistics.lensShadingMap for this case will be an identity map 1592ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * shown below:</p> 1593ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1594ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1595ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1596ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1597ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1598ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 1599ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * </code></pre> 1600ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * <p>When set to other modes, lens shading correction will be applied by the 1601ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * camera device. Applications can request lens shading map data by setting 1602ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide 1603574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * lens shading map data in android.statistics.lensShadingMap, with size specified 1604574936894d3044445a272b39f2d925af40ece5d8Ruben Brunk * by android.lens.info.shadingMapSize; the returned shading map data will be the one 1605fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * applied by the camera device for this capture request.</p> 1606b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore the reliability 1607fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * of the map data may be affected by the AE and AWB algorithms. When AE and AWB are in 1608fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * AUTO modes({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <code>!=</code> OFF), 1609fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * to get best results, it is recommended that the applications wait for the AE and AWB to 1610fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * be converged before using the returned shading map data.</p> 1611ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * 1612fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * @see CaptureRequest#CONTROL_AE_MODE 1613fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * @see CaptureRequest#CONTROL_AWB_MODE 1614ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 1615ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_OFF 1616ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_FAST 1617ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He * @see #SHADING_MODE_HIGH_QUALITY 1618ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He */ 16196c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1620ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He public static final Key<Integer> SHADING_MODE = 1621ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He new Key<Integer>("android.shading.mode", int.class); 1622ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He 1623ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He /** 1624e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * <p>Control for the face detector 1625b67a3b36fd569e63c1b8ca6b2701c34c7a3927c1Eino-Ville Talvala * unit.</p> 1626ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether face detection is enabled, and whether it 16275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * should output just the basic fields or the full set of 16285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * fields. Value must be one of the 16290da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.</p> 16300da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 16310da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 16325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_OFF 16335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 16345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #STATISTICS_FACE_DETECT_MODE_FULL 16355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16366c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 16375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 16385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.statistics.faceDetectMode", int.class); 16395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 16419d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * <p>Operating mode for hotpixel map generation.</p> 16429d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * <p>If set to ON, a hotpixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. 1643e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * If set to OFF, no hotpixel map will be returned.</p> 16449d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * <p>This must be set to a valid mode from {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}.</p> 16459d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * 16469d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP 16479d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES 16489d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk */ 16496c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 16509d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE = 16519d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class); 16529d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk 16539d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk /** 1654cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * <p>Whether the camera device will output the lens 1655cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He * shading map in output result metadata.</p> 1656ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>When set to ON, 1657e600d6ad60373821472e6338792109fa3103f7e2Eino-Ville Talvala * android.statistics.lensShadingMap will be provided in 16587a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin * the output result metadata.</p> 1659d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF 1660d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON 1661d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala */ 16626c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 1663d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE = 1664d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala new Key<Integer>("android.statistics.lensShadingMapMode", int.class); 1665d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala 1666d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala /** 1667ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the blue 1668e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1669e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 16708490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>See android.tonemap.curveRed for more details.</p> 16710da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 16725f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#TONEMAP_MODE 16738490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 16745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16753ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He public static final Key<float[]> TONEMAP_CURVE_BLUE = 16763ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He new Key<float[]>("android.tonemap.curveBlue", float[].class); 16775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1679ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the green 1680e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1681e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 16828490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>See android.tonemap.curveRed for more details.</p> 16830da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 16845f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He * @see CaptureRequest#TONEMAP_MODE 16858490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 16865a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 16873ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He public static final Key<float[]> TONEMAP_CURVE_GREEN = 16883ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He new Key<float[]>("android.tonemap.curveGreen", float[].class); 16895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 16905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1691ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Tonemapping / contrast / gamma curve for the red 1692e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1693e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 1694e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Each channel's curve is defined by an array of control points:</p> 16958490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = 1696e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 1697870922be2399766078d0a4e42a0158ecb9eb1f86Zhijun He * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 1698e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>These are sorted in order of increasing <code>Pin</code>; it is always 1699e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * guaranteed that input values 0.0 and 1.0 are included in the list to 1700e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * define a complete mapping. For input values between control points, 1701e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * the camera device must linearly interpolate between the control 1702e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * points.</p> 1703e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Each curve can have an independent number of points, and the number 1704e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * of points can be less than max (that is, the request doesn't have to 1705e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * always provide a curve with number of points equivalent to 1706e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 1707e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>A few examples, and their corresponding graphical mappings; these 1708e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * only specify the red channel and the precision is limited to 4 1709e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * digits, for conciseness.</p> 1710e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Linear mapping:</p> 17118490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] 1712e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 1713e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 1714e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Invert mapping:</p> 17158490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] 1716e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 1717e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 1718e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 17198490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 1720e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 1721e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 1722e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 1723e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 1724e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 1725e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 1726e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 17278490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>android.tonemap.curveRed = [ 1728e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 1729e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 1730e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 1731e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 1732e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * </code></pre> 1733e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 17340da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * 1735e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 17360da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala * @see CaptureRequest#TONEMAP_MODE 17378490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @hide 17385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 17395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<float[]> TONEMAP_CURVE_RED = 17405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<float[]>("android.tonemap.curveRed", float[].class); 17415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 17425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 17438490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} 17448490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * is CONTRAST_CURVE.</p> 17458490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>The tonemapCurve consist of three curves for each of red, green, and blue 17468490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * channels respectively. The following example uses the red channel as an 17478490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * example. The same logic applies to green and blue channel. 17488490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * Each channel's curve is defined by an array of control points:</p> 17498490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = 17508490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 17518490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 17528490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>These are sorted in order of increasing <code>Pin</code>; it is always 17538490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * guaranteed that input values 0.0 and 1.0 are included in the list to 17548490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * define a complete mapping. For input values between control points, 17558490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * the camera device must linearly interpolate between the control 17568490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * points.</p> 17578490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Each curve can have an independent number of points, and the number 17588490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * of points can be less than max (that is, the request doesn't have to 17598490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * always provide a curve with number of points equivalent to 17608490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 17618490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>A few examples, and their corresponding graphical mappings; these 17628490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * only specify the red channel and the precision is limited to 4 17638490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * digits, for conciseness.</p> 17648490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Linear mapping:</p> 17658490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] 17668490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 17678490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 17688490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Invert mapping:</p> 17698490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] 17708490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 17718490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 17728490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 17738490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ 17748490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), 17758490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), 17768490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), 17778490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] 17788490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 17798490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 17808490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 17818490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <pre><code>curveRed = [ 17828490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), 17838490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), 17848490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), 17858490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] 17868490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * </code></pre> 17878490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 17888490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * 17898490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 17908490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CaptureRequest#TONEMAP_MODE 17918490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh */ 17926c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 17936c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @SyntheticKey 17948490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE = 17958490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class); 17968490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh 17978490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh /** 1798e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>High-level global contrast/gamma/tonemapping control.</p> 1799e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>When switching to an application-defined contrast curve by setting 1800e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 1801e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * per-channel with a set of <code>(in, out)</code> points that specify the 1802e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * mapping from input high-bit-depth pixel value to the output 1803e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * low-bit-depth value. Since the actual pixel ranges of both input 1804e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * and output may change depending on the camera pipeline, the values 1805e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * are specified by normalized floating-point numbers.</p> 1806e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>More-complex color mapping operations such as 3D color look-up 1807e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * tables, selective chroma enhancement, or other non-linear color 1808e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1809e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * CONTRAST_CURVE.</p> 18106dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * <p>This must be set to a valid mode in 18116dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}.</p> 1812e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * <p>When using either FAST or HIGH_QUALITY, the camera device will 18138490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. 1814e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * These values are always available, and as close as possible to the 1815e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * actually used nonlinear/nonglobal transforms.</p> 1816fa7c755a920dc0209efa15a65bfdd2881cb42141Zhijun He * <p>If a request is sent with CONTRAST_CURVE with the camera device's 1817e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 1818e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * roughly the same.</p> 18193242f4fb19b77bcd2435cbe710188d012d08b005Igor Murashkin * 18206dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES 18218490ace76fd350e53de9554c11fca715c5a37aafYin-Chia Yeh * @see CaptureRequest#TONEMAP_CURVE 1822e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin * @see CaptureRequest#TONEMAP_MODE 18235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_CONTRAST_CURVE 18245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_FAST 18255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @see #TONEMAP_MODE_HIGH_QUALITY 18265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18276c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Integer> TONEMAP_MODE = 18295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Integer>("android.tonemap.mode", int.class); 18305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1832ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>This LED is nominally used to indicate to the user 18335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * that the camera is powered on and may be streaming images back to the 18345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * Application Processor. In certain rare circumstances, the OS may 18355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * disable this when video is processed locally and not transmitted to 1836ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * any untrusted applications.</p> 1837ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>In particular, the LED <em>must</em> always be on when the data could be 1838ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * transmitted off the device. The LED <em>should</em> always be on whenever 1839ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * data is stored locally on the device.</p> 1840ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>The LED <em>may</em> be off if a trusted application is using the data that 1841ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * doesn't violate the above rules.</p> 18425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * @hide 18435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> LED_TRANSMIT = 18455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.led.transmit", boolean.class); 18465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /** 1848ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Whether black-level compensation is locked 18490956af56a294397325f2695604229ab7550364caEino-Ville Talvala * to its current values, or is free to vary.</p> 1850ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>When set to ON, the values used for black-level 18510956af56a294397325f2695604229ab7550364caEino-Ville Talvala * compensation will not change until the lock is set to 18520956af56a294397325f2695604229ab7550364caEino-Ville Talvala * OFF.</p> 1853ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>Since changes to certain capture parameters (such as 18545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * exposure time) may require resetting of black level 18550956af56a294397325f2695604229ab7550364caEino-Ville Talvala * compensation, the camera device must report whether setting 18560956af56a294397325f2695604229ab7550364caEino-Ville Talvala * the black level lock was successful in the output result 1857ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * metadata.</p> 1858ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <p>For example, if a sequence of requests is as follows:</p> 1859ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <ul> 1860ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 1: Exposure = 10ms, Black level lock = OFF</li> 1861ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 2: Exposure = 10ms, Black level lock = ON</li> 1862ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 3: Exposure = 10ms, Black level lock = ON</li> 1863ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 4: Exposure = 20ms, Black level lock = ON</li> 1864ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 5: Exposure = 20ms, Black level lock = ON</li> 1865ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Request 6: Exposure = 20ms, Black level lock = ON</li> 1866ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * </ul> 18670956af56a294397325f2695604229ab7550364caEino-Ville Talvala * <p>And the exposure change in Request 4 requires the camera 18680956af56a294397325f2695604229ab7550364caEino-Ville Talvala * device to reset the black level offsets, then the output 18690956af56a294397325f2695604229ab7550364caEino-Ville Talvala * result metadata is expected to be:</p> 1870ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <ul> 1871ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 1: Exposure = 10ms, Black level lock = OFF</li> 1872ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 2: Exposure = 10ms, Black level lock = ON</li> 1873ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 3: Exposure = 10ms, Black level lock = ON</li> 1874ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 4: Exposure = 20ms, Black level lock = OFF</li> 1875ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 5: Exposure = 20ms, Black level lock = ON</li> 1876ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * <li>Result 6: Exposure = 20ms, Black level lock = ON</li> 1877ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin * </ul> 18780956af56a294397325f2695604229ab7550364caEino-Ville Talvala * <p>This indicates to the application that on frame 4, black 18790956af56a294397325f2695604229ab7550364caEino-Ville Talvala * levels were reset due to exposure value changes, and pixel 18800956af56a294397325f2695604229ab7550364caEino-Ville Talvala * values may not be consistent across captures.</p> 18810956af56a294397325f2695604229ab7550364caEino-Ville Talvala * <p>The camera device will maintain the lock to the extent 18820956af56a294397325f2695604229ab7550364caEino-Ville Talvala * possible, only overriding the lock to OFF when changes to 18830956af56a294397325f2695604229ab7550364caEino-Ville Talvala * other request parameters require a black level recalculation 18840956af56a294397325f2695604229ab7550364caEino-Ville Talvala * or reset.</p> 18855a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala */ 18866c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin @PublicKey 18875a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala public static final Key<Boolean> BLACK_LEVEL_LOCK = 18885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala new Key<Boolean>("android.blackLevel.lock", boolean.class); 18895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala 18905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 18915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala * End generated code 18925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 18936c76f58f31635c19c14ae161f96dad2082537860Igor Murashkin 18945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala} 1895